Implement pass field for connecting password-protected servers

(fixes #60)

Author: osa1

CHANGELOG.md

@@ -13,6 +13,8 @@
 - `TOPIC` messages are now handled (#58).
 - `RPL_AWAY` is now handled (#55). Away message is shown in user tab.
 - `/ignore` command added to ignore `join/quit` messages in channels.
+- New server config field `pass` added for connecting to password-protected
+  servers (e.g. znc).
 
 # 2017/11/12: 0.3.0
 

README.md

@@ -65,6 +65,8 @@ servers:
       port: 6697
       # optional field, defaults to false:
       tls: true
+      # optional field for server password:
+      # pass: 'server_pass'
       hostname: yourhost
       realname: yourname
       nicks: [tiny_user]

src/cmd.rs

@@ -215,7 +215,9 @@ fn connect<'a, 'b>(args: &str, poll: &'b Poll, tiny: &'a mut Tiny<'b>, src: MsgS
         0 =>
             reconnect(tiny, src),
         1 =>
-            connect_(words[0], poll, tiny),
+            connect_(words[0], None, poll, tiny),
+        2 =>
+            connect_(words[0], Some(words[1]), poll, tiny),
         _ =>
             // wat
             tiny.tui.add_client_err_msg(
@@ -255,7 +257,7 @@ fn reconnect(tiny: &mut Tiny, src: MsgSource) {
     }
 }
 
-fn connect_<'a, 'b>(serv_addr: &str, poll: &'b Poll, tiny: &'a mut Tiny<'b>) {
+fn connect_<'a, 'b>(serv_addr: &str, pass: Option<&str>, poll: &'b Poll, tiny: &'a mut Tiny<'b>) {
     fn split_port(s: &str) -> Option<(&str, &str)> {
         s.find(':').map(|split| (&s[0..split], &s[split + 1..]))
     }
@@ -322,6 +324,7 @@ fn connect_<'a, 'b>(serv_addr: &str, poll: &'b Poll, tiny: &'a mut Tiny<'b>) {
             tls: tiny.defaults.tls,
             hostname: tiny.defaults.hostname.clone(),
             realname: tiny.defaults.realname.clone(),
+            pass: pass.map(str::to_owned),
             nicks: tiny.defaults.nicks.clone(),
             auto_cmds: tiny.defaults.auto_cmds.clone(),
             join: tiny.defaults.join.clone(),

src/config.rs

@@ -21,6 +21,10 @@ pub struct Server {
     #[serde(default)]
     pub tls: bool,
 
+    /// Server password (optional)
+    #[serde(default)]
+    pub pass: Option<String>,
+
     /// Hostname to be used in connection registration
     pub hostname: String,
 

src/conn.rs

@@ -1,5 +1,6 @@
 use mio::Poll;
 use mio::Token;
+use std::io::Write;
 use std::result;
 use std::str;
 
@@ -17,6 +18,10 @@ pub struct Conn<'poll> {
     tls: bool,
     hostname: String,
     realname: String,
+
+    /// Server password
+    pass: Option<String>,
+
     nicks: Vec<String>,
 
     /// Always in range of `nicks`
@@ -128,20 +133,34 @@ pub enum ConnEv {
     NickChange(String),
 }
 
+fn introduce<W: Write>(stream: &mut W, pass: Option<&str>, hostname: &str, realname: &str, nick: &str) {
+    if let Some(pass) = pass {
+        wire::pass(stream, pass).unwrap();
+    }
+    wire::nick(stream, nick).unwrap();
+    wire::user(stream, hostname, realname).unwrap();
+}
+
 impl<'poll> Conn<'poll> {
     pub fn new(server: config::Server, poll: &'poll Poll) -> Result<Conn<'poll>> {
         let mut stream =
             Stream::new(poll, &server.addr, server.port, server.tls).map_err(StreamErr::from)?;
 
-        wire::user(&mut stream, &server.hostname, &server.realname).unwrap();
-        wire::nick(&mut stream, &server.nicks[0]).unwrap();
+        introduce(
+            &mut stream,
+            server.pass.as_ref().map(String::as_str),
+            &server.hostname,
+            &server.realname,
+            &server.nicks[0],
+        );
 
         Ok(Conn {
             serv_addr: server.addr,
             serv_port: server.port,
             tls: server.tls,
             hostname: server.hostname,
             realname: server.realname,
+            pass: server.pass,
             nicks: server.nicks,
             current_nick_idx: 0,
             auto_join: server.join,
@@ -173,8 +192,13 @@ impl<'poll> Conn<'poll> {
             Err(err) =>
                 Err(StreamErr::from(err)),
             Ok(mut stream) => {
-                wire::user(&mut stream, &self.hostname, &self.realname).unwrap();
-                wire::nick(&mut stream, &self.nicks[self.current_nick_idx]).unwrap();
+                introduce(
+                    &mut stream,
+                    self.pass.as_ref().map(String::as_str),
+                    &self.hostname,
+                    &self.realname,
+                    self.get_nick()
+                );
                 self.status = ConnStatus::PingPong {
                     ticks_passed: 0,
                     stream: stream,

src/wire.rs

@@ -6,6 +6,10 @@ use std;
 
 use logger::LogFile;
 
+pub fn pass<W: Write>(sink: &mut W, pass: &str) -> std::io::Result<()> {
+    write!(sink, "PASS {}\r\n", pass)
+}
+
 pub fn user<W: Write>(sink: &mut W, hostname: &str, realname: &str) -> std::io::Result<()> {
     write!(sink, "USER {} 8 * :{}\r\n", hostname, realname)
 }