r3-netstatus/r3xmppbot/r3xmppbot.go

   1 package r3xmppbot
   2
   3 import (
   4         xmpp "code.google.com/p/goexmpp"
   5         "fmt"
   6     "log"
   7     "crypto/tls"
   8     "os"
   9     "time"
  10     "encoding/json"
  11     "path"
  12 )
  13
  14 //~ type StdLogger struct {
  15 //~ }
  16
  17 //~ func (s *StdLogger) Log(v ...interface{}) {
  18         //~ log.Println(v...)
  19 //~ }
  20
  21 //~ func (s *StdLogger) Logf(fmt string, v ...interface{}) {
  22         //~ log.Printf(fmt, v...)
  23 //~ }
  24
  25 func (botdata *XmppBot) makeXMPPMessage(to, message string, subject interface{}) *xmpp.Message {
  26     xmppmsgheader := xmpp.Header{To: to,
  27                                                             From: botdata.my_jid_,
  28                                                             Id: <-xmpp.Id,
  29                                                             Type: "chat",
  30                                                             Lang: "",
  31                                                             Innerxml: "",
  32                                                             Error: nil,
  33                                                             Nested: make([]interface{},0)}
  34     msgsubject := xmpp.Generic{}
  35     if subject != nil {
  36         msgsubject.Chardata = subject.(string)
  37     }
  38     return &xmpp.Message{Header: xmppmsgheader , Subject: &msgsubject, Body: &xmpp.Generic{Chardata:message}, Thread: &xmpp.Generic{}}
  39 }
  40
  41 func (botdata *XmppBot) makeXMPPPresence(to, ptype string) *xmpp.Presence {
  42     xmppmsgheader := xmpp.Header{To: to,
  43                                                             From: botdata.my_jid_,
  44                                                             Id: <-xmpp.Id,
  45                                                             Type: ptype,
  46                                                             Lang: "",
  47                                                             Innerxml: "",
  48                                                             Error: nil,
  49                                                             Nested: make([]interface{},0)}
  50     return &xmpp.Presence{Header: xmppmsgheader}
  51 }
  52
  53 type R3JIDDesire int
  54
  55 const (
  56     R3NoChange R3JIDDesire = -1
  57     R3NoInfo R3JIDDesire = iota // ignore first value by assigning to blank identifier
  58     R3NoOfflineInfo
  59     R3AllInfo
  60     R3DebugInfo
  61 )
  62
  63 type JidData struct {
  64         Online  bool
  65     Wants   R3JIDDesire
  66 }
  67
  68 type JabberEvent struct {
  69     JID      string
  70     Online   bool
  71     Wants    R3JIDDesire
  72 }
  73
  74 type XMPPPresenceEvent struct {
  75     Present bool
  76     Who string
  77     DoorLock bool
  78     DoorShut bool
  79     Button bool
  80 }
  81
  82 type RealraumXmppNotifierConfig map[string]JidData
  83
  84 type XmppBot struct {
  85     jid_lastauthtime_ map[string]int64
  86     realraum_jids_ RealraumXmppNotifierConfig
  87     password_ string
  88     auth_cmd_ string
  89     my_jid_ string
  90     auth_timeout_ int64
  91     config_file_ string
  92     my_login_password_ string
  93     xmppclient_ *xmpp.Client
  94     presence_events_ *chan interface{}
  95 }
  96
  97
  98 func (data RealraumXmppNotifierConfig) saveTo(filepath string) () {
  99     fh, err := os.Create(filepath)
 100     if err != nil {
 101         log.Println(err)
 102         return
 103     }
 104     defer fh.Close()
 105     enc := json.NewEncoder(fh)
 106     if err = enc.Encode(&data); err != nil {
 107         log.Println(err)
 108         return
 109     }
 110 }
 111
 112 func (data RealraumXmppNotifierConfig) loadFrom(filepath string) () {
 113     fh, err := os.Open(filepath)
 114     if err != nil {
 115         log.Println(err)
 116         return
 117     }
 118     defer fh.Close()
 119     dec := json.NewDecoder(fh)
 120     if err = dec.Decode(&data); err != nil {
 121         log.Println(err)
 122         return
 123     }
 124     for to, jiddata := range data  {
 125         jiddata.Online = false
 126         data[to]=jiddata
 127     }
 128 }
 129
 130
 131 func init() {
 132         //~ logger := &StdLogger{}
 133         //~ xmpp.Debug = logger
 134         //~ xmpp.Info = logger
 135         //~ xmpp.Warn = logger
 136 }
 137
 138 func (botdata *XmppBot) handleEventsforXMPP(xmppout chan <- xmpp.Stanza, presence_events <- chan interface{}, jabber_events <- chan JabberEvent) {
 139     var msg, presence_str, lock_str, ajar_str string
 140     var debug_msg bool
 141
 142         for {
 143         debug_msg = false
 144                 select {
 145                 case pe := <-presence_events:
 146             switch pec := pe.(type) {
 147                 case xmpp.Stanza:
 148                     xmppout <- pec
 149                     continue
 150                 case string:
 151                     msg = pec
 152                     debug_msg = true
 153                 case XMPPPresenceEvent:
 154                     if pec.Present {
 155                         presence_str = "Somebody is present !"
 156                     } else {
 157                         presence_str = "Everybody left."
 158                     }
 159                     if pec.DoorLock {
 160                         lock_str = "locked"
 161                     } else {
 162                         lock_str = "unlocked"
 163                     }
 164                     if pec.DoorShut {
 165                         ajar_str = "shut"
 166                     } else {
 167                         ajar_str = "ajar"
 168                     }
 169                     if pec.Button {
 170                         msg = "The button has been pressed ! Propably someone is bored and need company ! ;-)"
 171                     } else {
 172                         msg = fmt.Sprintf("%s (Door is %s and %s and was last used by %s)", presence_str, lock_str, ajar_str, pec.Who)
 173                     }
 174                 default:
 175                     break
 176                 }
 177
 178                 for to, jiddata := range botdata.realraum_jids_  {
 179                     if debug_msg && jiddata.Wants < R3DebugInfo {
 180                         continue
 181                     }
 182                     if (jiddata.Wants == R3NoOfflineInfo && jiddata.Online) || jiddata.Wants > R3NoOfflineInfo {
 183                         xmppout <-  botdata.makeXMPPMessage(to, msg, nil)
 184                     }
 185                 }
 186
 187                 case je := <-jabber_events:
 188             jid_data, jid_in_map := botdata.realraum_jids_[je.JID]
 189             if jid_in_map {
 190                 jid_data.Online = je.Online
 191                 if je.Wants > R3NoChange {
 192                     jid_data.Wants = je.Wants
 193                 }
 194                 botdata.realraum_jids_[je.JID] = jid_data
 195                 botdata.realraum_jids_.saveTo(botdata.config_file_)
 196             } else if je.Wants > R3NoChange {
 197                 botdata.realraum_jids_[je.JID] = JidData{je.Online, je.Wants}
 198                 botdata.realraum_jids_.saveTo(botdata.config_file_)
 199             }
 200                 }
 201         }
 202 }
 203
 204 func removeJIDResource(jid string) string {
 205     var jidjid xmpp.JID
 206     jidjid.Set(jid)
 207     jidjid.Resource = ""
 208     return jidjid.String()
 209 }
 210
 211 func (botdata *XmppBot) isAuthenticated(jid string) bool {
 212     authtime, in_map := botdata.jid_lastauthtime_[jid]
 213     //~ log.Println("isAuthenticated", in_map, authtime, time.Now().Unix(), auth_timeout_, time.Now().Unix() - authtime > auth_timeout_)
 214     return in_map && time.Now().Unix() - authtime < botdata.auth_timeout_
 215 }
 216
 217 const help_text_ string = "\nauth <password>\n  .... enables you to use the other commands\non\n  .... you will be notified of r3 status changes\noff\n  .... you will no longer recieve notifications\non_while_offline\n  .... you will be notified of r3 status changes even if you are offline"
 218
 219 //~ var re_msg_auth_    *regexp.Regexp     = regexp.MustCompile("auth\s+(\S+)")
 220
 221 func (botdata *XmppBot) handleIncomingMessageDialog(inmsg xmpp.Message, xmppout chan<- xmpp.Stanza, jabber_events chan JabberEvent) {
 222     if inmsg.Body == nil || inmsg.GetHeader() == nil {
 223         return
 224     }
 225     bodytext :=inmsg.Body.Chardata
 226     //~ log.Println("Message Body:", bodytext)
 227     if botdata.isAuthenticated(inmsg.GetHeader().From) {
 228         switch bodytext {
 229             case "on":
 230                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3NoOfflineInfo}
 231                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Receive r3 information while online" , "Your New Status")
 232             case "off":
 233                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3NoInfo}
 234                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Do not receive r3 information" , "Your New Status")
 235             case "on_while_offline":
 236                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3AllInfo}
 237                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Receive r3 information even while offline" , "Your New Status")
 238             case "debug":
 239                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3DebugInfo}
 240                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Debug mode enabled" , "Your New Status")
 241             case "bye", "Bye", "quit", "logout":
 242                 botdata.jid_lastauthtime_[inmsg.GetHeader().From] = 0
 243                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Bye Bye !" ,nil)
 244             case "open","close":
 245                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Sorry, I can't operate the door for you." ,nil)
 246             default:
 247                 //~ auth_match = re_msg_auth_.FindStringSubmatch(inmsg.Body.Chardata)
 248                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, help_text_, "Available Commands")
 249         }
 250     } else {
 251         switch bodytext {
 252             case "Hilfe","hilfe","help","Help","?","hallo","Hallo","Yes","yes","ja","ja bitte","bitte","sowieso":
 253                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, help_text_, "Available Commands")
 254             case botdata.auth_cmd_:
 255                 botdata.jid_lastauthtime_[inmsg.GetHeader().From] = time.Now().Unix()
 256                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "You are now authorized to use commands" , "Authorized")
 257             default:
 258                 //~ auth_match = re_msg_auth_.FindStringSubmatch(inmsg.Body.Chardata)
 259                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "A nice day to you too !\nDo you need \"help\" ?", nil)
 260         }
 261     }
 262 }
 263
 264 func (botdata *XmppBot) handleIncomingXMPPStanzas(xmppin <- chan xmpp.Stanza, xmppout chan<- xmpp.Stanza, jabber_events chan JabberEvent) {
 265     var incoming_stanza interface{}
 266     for incoming_stanza = range xmppin {
 267         switch stanza := incoming_stanza.(type) {
 268             case *xmpp.Message:
 269                 botdata.handleIncomingMessageDialog(*stanza, xmppout, jabber_events)
 270             case *xmpp.Presence:
 271                 if stanza.GetHeader() == nil {
 272                     continue
 273                 }
 274                 if stanza.GetHeader().Type == "subscribe" {
 275                     xmppout <- botdata.makeXMPPPresence(stanza.GetHeader().From, "subscribed")
 276                 }
 277                 jabber_events <- JabberEvent{stanza.GetHeader().From, stanza.GetHeader().Type != "unavailable", R3NoChange}
 278             case *xmpp.Iq:
 279                 if stanza.GetHeader() == nil {
 280                     continue
 281                 }
 282         }
 283     }
 284 }
 285
 286 func NewStartedBot(loginjid, loginpwd, password, state_save_dir string, insecuretls bool) (*XmppBot, chan interface{}, error) {
 287     var err error
 288     botdata := new(XmppBot)
 289
 290     botdata.realraum_jids_ = make(map[string]JidData, 1)
 291     botdata.jid_lastauthtime_ = make(map[string]int64,1)
 292     botdata.auth_cmd_ = "auth " + password
 293     botdata.my_jid_ = loginjid
 294     botdata.my_login_password_ = loginpwd
 295     botdata.auth_timeout_ = 1200
 296
 297     botdata.config_file_ = path.Join(state_save_dir, "r3xmpp."+removeJIDResource(loginjid)+".json")
 298
 299     //~ log.Println(botdata.config_file_)
 300
 301     //~ logger := &StdLogger{}
 302     //~ xmpp.Debug = logger
 303     //~ xmpp.Info = logger
 304     //~ xmpp.Warn = logger
 305
 306     xmpp.TlsConfig = tls.Config{InsecureSkipVerify: insecuretls}
 307     botdata.realraum_jids_.loadFrom(botdata.config_file_)
 308
 309     client_jid := new(xmpp.JID)
 310     client_jid.Set(botdata.my_jid_)
 311     botdata.xmppclient_, err = xmpp.NewClient(client_jid, botdata.my_login_password_, nil)
 312     if err != nil {
 313         log.Println("Error connecting to xmpp server", err)
 314         return nil, nil, err
 315     }
 316
 317     err = botdata.xmppclient_.StartSession(false, &xmpp.Presence{})
 318     if err != nil {
 319         log.Println("'Error StartSession:", err)
 320         return nil, nil, err
 321     }
 322
 323     presence_events := make(chan interface{},1)
 324     jabber_events := make(chan JabberEvent,1)
 325
 326     go botdata.handleEventsforXMPP(botdata.xmppclient_.Out, presence_events, jabber_events)
 327     go botdata.handleIncomingXMPPStanzas(botdata.xmppclient_.In, botdata.xmppclient_.Out, jabber_events)
 328
 329     botdata.presence_events_ = &presence_events
 330
 331     return botdata, presence_events, nil
 332 }
 333
 334 func (botdata *XmppBot) StopBot() {
 335     if botdata.xmppclient_ != nil {
 336         close(botdata.xmppclient_.Out)
 337     }
 338     if botdata.presence_events_ != nil {
 339         *botdata.presence_events_ <- false
 340         close(*botdata.presence_events_)
 341     }
 342 }