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