r3-netstatus/r3xmppbot/r3xmppbot.go

   1 package r3xmppbot
   2
   3 import (
   4         xmpp "code.google.com/p/goexmpp"
   5     "log"
   6     "crypto/tls"
   7     "os"
   8     "time"
   9     "encoding/json"
  10     "path"
  11 )
  12
  13 //~ type StdLogger struct {
  14 //~ }
  15
  16 //~ func (s *StdLogger) Log(v ...interface{}) {
  17         //~ log.Println(v...)
  18 //~ }
  19
  20 //~ func (s *StdLogger) Logf(fmt string, v ...interface{}) {
  21         //~ log.Printf(fmt, v...)
  22 //~ }
  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     R3NeverInfo R3JIDDesire = iota // ignore first value by assigning to blank identifier
  76     R3OnlineOnlyInfo
  77     R3OnlineOnlyWithRecapInfo
  78     R3AlwaysInfo
  79     R3DebugInfo
  80 )
  81
  82 type JidData struct {
  83         Online  bool
  84     Wants   R3JIDDesire
  85 }
  86
  87 type JabberEvent struct {
  88     JID      string
  89     Online   bool
  90     Wants    R3JIDDesire
  91     StatusNow bool
  92 }
  93
  94 type XMPPMsgEvent struct {
  95     Msg string
  96     DistributeLevel R3JIDDesire
  97     RememberAsStatus bool
  98 }
  99
 100 type RealraumXmppNotifierConfig map[string]JidData
 101
 102 type XmppBot struct {
 103     jid_lastauthtime_ map[string]int64
 104     realraum_jids_ RealraumXmppNotifierConfig
 105     password_ string
 106     auth_cmd_ string
 107     auth_cmd2_ string
 108     my_jid_ string
 109     auth_timeout_ int64
 110     config_file_ string
 111     my_login_password_ string
 112     xmppclient_ *xmpp.Client
 113     presence_events_ *chan interface{}
 114 }
 115
 116
 117 func (data RealraumXmppNotifierConfig) saveTo(filepath string) () {
 118     fh, err := os.Create(filepath)
 119     if err != nil {
 120         log.Println(err)
 121         return
 122     }
 123     defer fh.Close()
 124     enc := json.NewEncoder(fh)
 125     if err = enc.Encode(&data); err != nil {
 126         log.Println(err)
 127         return
 128     }
 129 }
 130
 131 func (data RealraumXmppNotifierConfig) loadFrom(filepath string) () {
 132     fh, err := os.Open(filepath)
 133     if err != nil {
 134         log.Println(err)
 135         return
 136     }
 137     defer fh.Close()
 138     dec := json.NewDecoder(fh)
 139     if err = dec.Decode(&data); err != nil {
 140         log.Println(err)
 141         return
 142     }
 143     for to, jiddata := range data  {
 144         jiddata.Online = false
 145         data[to]=jiddata
 146     }
 147 }
 148
 149
 150 func init() {
 151         //~ logger := &StdLogger{}
 152         //~ xmpp.Debug = logger
 153         //~ xmpp.Info = logger
 154         //~ xmpp.Warn = logger
 155 }
 156
 157 func (botdata *XmppBot) handleEventsforXMPP(xmppout chan <- xmpp.Stanza, presence_events <- chan interface{}, jabber_events <- chan JabberEvent) {
 158     var last_status_msg *string
 159
 160         for {
 161                 select {
 162                 case pe := <-presence_events:
 163             switch pec := pe.(type) {
 164                 case xmpp.Stanza:
 165                     xmppout <- pec
 166                     continue
 167                 case string:
 168                     for to, jiddata := range botdata.realraum_jids_  {
 169                         if  jiddata.Wants >= R3DebugInfo {
 170                             xmppout <-  botdata.makeXMPPMessage(to, pec, nil)
 171                         }
 172                     }
 173
 174                 case XMPPMsgEvent:
 175                     if pec.RememberAsStatus {
 176                         last_status_msg = &pec.Msg
 177                     }
 178                     for to, jiddata := range botdata.realraum_jids_  {
 179                         if  jiddata.Wants >= pec.DistributeLevel && ((jiddata.Wants >= R3OnlineOnlyInfo && jiddata.Online) || jiddata.Wants >= R3AlwaysInfo) {
 180                             xmppout <-  botdata.makeXMPPMessage(to, pec.Msg, nil)
 181                         }
 182                     }
 183                 default:
 184                     break
 185                 }
 186
 187                 case je := <-jabber_events:
 188             simple_jid := removeJIDResource(je.JID)
 189             jid_data, jid_in_map := botdata.realraum_jids_[simple_jid]
 190             if jid_in_map {
 191                 if last_status_msg != nil && (je.StatusNow || (! jid_data.Online && je.Online && jid_data.Wants == R3OnlineOnlyWithRecapInfo) ) {
 192                     xmppout <-  botdata.makeXMPPMessage(je.JID, last_status_msg, nil)
 193                 }
 194                 jid_data.Online = je.Online
 195                 if je.Wants > R3NoChange {
 196                     jid_data.Wants = je.Wants
 197                 }
 198                 botdata.realraum_jids_[simple_jid] = jid_data
 199                 botdata.realraum_jids_.saveTo(botdata.config_file_)
 200             } else if je.Wants > R3NoChange {
 201                 botdata.realraum_jids_[simple_jid] = JidData{je.Online, je.Wants}
 202                 botdata.realraum_jids_.saveTo(botdata.config_file_)
 203             }
 204                 }
 205         }
 206 }
 207
 208 func removeJIDResource(jid string) string {
 209     var jidjid xmpp.JID
 210     jidjid.Set(jid)
 211     jidjid.Resource = ""
 212     return jidjid.String()
 213 }
 214
 215 func (botdata *XmppBot) isAuthenticated(jid string) bool {
 216     authtime, in_map := botdata.jid_lastauthtime_[jid]
 217     //~ log.Println("isAuthenticated", in_map, authtime, time.Now().Unix(), auth_timeout_, time.Now().Unix() - authtime > auth_timeout_)
 218     return in_map && time.Now().Unix() - authtime < botdata.auth_timeout_
 219 }
 220
 221 const help_text_ string = "\n*auth*<password>* ...Enables you to use more commands.\n*time* ...Returns bot time."
 222 const help_text_auth string = "You are authorized to use the following commands:\n*off* ...You will no longer receive notifications.\n*on* ...You will be notified of r3 status changes.\n*on_with_recap* ...Like *on* but additionally you will receive the current r3 status when you come online.\n*on_while_offline* ...You will receive all r3 status changes, wether your are online or offline.\n*status* ...Use it to query the current status.\n*time* ...Returns bot time.\n*bye* ...Logout."
 223
 224 //~ var re_msg_auth_    *regexp.Regexp     = regexp.MustCompile("auth\s+(\S+)")
 225
 226 func (botdata *XmppBot) handleIncomingMessageDialog(inmsg xmpp.Message, xmppout chan<- xmpp.Stanza, jabber_events chan JabberEvent) {
 227     if inmsg.Body == nil || inmsg.GetHeader() == nil {
 228         return
 229     }
 230     bodytext :=inmsg.Body.Chardata
 231     //~ log.Println("Message Body:", bodytext)
 232     if botdata.isAuthenticated(inmsg.GetHeader().From) {
 233         switch bodytext {
 234             case "on", "*on*":
 235                 jabber_events <- JabberEvent{inmsg.GetHeader().From, true, R3OnlineOnlyInfo, false}
 236                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Receive r3 status updates while online." , "Your New Status")
 237             case "off", "*off*":
 238                 jabber_events <- JabberEvent{inmsg.GetHeader().From, true, R3NeverInfo, false}
 239                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Do not receive anything." , "Your New Status")
 240             case "on_with_recap", "*on_with_recap*":
 241                 jabber_events <- JabberEvent{inmsg.GetHeader().From, true, R3OnlineOnlyWithRecapInfo, false}
 242                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Receive r3 status updates while and current status on coming, online." , "Your New Status")
 243             case "on_while_offline", "*on_while_offline*":
 244                 jabber_events <- JabberEvent{inmsg.GetHeader().From, true, R3AlwaysInfo, false}
 245                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Receive all r3 status updates, even if you are offline." , "Your New Status")
 246             case "debug":
 247                 jabber_events <- JabberEvent{inmsg.GetHeader().From, true, R3DebugInfo, false}
 248                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Debug mode enabled" , "Your New Status")
 249             case "bye", "Bye", "quit", "logout", "*bye*":
 250                 botdata.jid_lastauthtime_[inmsg.GetHeader().From] = 0
 251                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Bye Bye !" ,nil)
 252             case "open","close":
 253                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Sorry, I can't operate the door for you." ,nil)
 254             case "status", "*status*":
 255                 jabber_events <- JabberEvent{inmsg.GetHeader().From, true, R3NoChange, true}
 256             case "time", "*time*":
 257                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, time.Now().String() , nil)
 258             default:
 259                 //~ auth_match = re_msg_auth_.FindStringSubmatch(inmsg.Body.Chardata)
 260                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, help_text_auth, nil)
 261         }
 262     } else {
 263         switch bodytext {
 264             case "Hilfe","hilfe","help","Help","?","hallo","Hallo","Yes","yes","ja","ja bitte","bitte","sowieso":
 265                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, help_text_, "Available Commands")
 266             case botdata.auth_cmd_, botdata.auth_cmd2_:
 267                 botdata.jid_lastauthtime_[inmsg.GetHeader().From] = time.Now().Unix()
 268                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, help_text_auth, nil)
 269             case "status", "*status*", "off", "*off*", "on", "*on*", "on_while_offline", "*on_while_offline*", "on_with_recap", "*on_with_recap*":
 270                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Sorry, you need to be authorized to do that." , nil)
 271             case "time", "*time*":
 272                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, time.Now().String() , nil)
 273             default:
 274                 //~ auth_match = re_msg_auth_.FindStringSubmatch(inmsg.Body.Chardata)
 275                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "A nice day to you too !\nDo you need \"help\" ?", nil)
 276         }
 277     }
 278 }
 279
 280 func (botdata *XmppBot) handleIncomingXMPPStanzas(xmppin <- chan xmpp.Stanza, xmppout chan<- xmpp.Stanza, jabber_events chan JabberEvent) {
 281     var incoming_stanza interface{}
 282     for incoming_stanza = range xmppin {
 283         switch stanza := incoming_stanza.(type) {
 284             case *xmpp.Message:
 285                 botdata.handleIncomingMessageDialog(*stanza, xmppout, jabber_events)
 286             case *xmpp.Presence:
 287                 if stanza.GetHeader() == nil {
 288                     continue
 289                 }
 290                 switch stanza.GetHeader().Type {
 291                     case "subscribe":
 292                         xmppout <- botdata.makeXMPPPresence(stanza.GetHeader().From, "subscribed")
 293                         jabber_events <- JabberEvent{stanza.GetHeader().From, true, R3NoChange, false}
 294                         xmppout <- botdata.makeXMPPPresence(stanza.GetHeader().From, "subscribe")
 295                     case "unsubscribe", "unsubscribed":
 296                         jabber_events <- JabberEvent{stanza.GetHeader().From, false, R3NeverInfo, false}
 297                         botdata.jid_lastauthtime_[stanza.GetHeader().From] = 0 //logout
 298                         xmppout <- botdata.makeXMPPPresence(stanza.GetHeader().From, "unsubscribe")
 299                     case "unavailable":
 300                         jabber_events <- JabberEvent{stanza.GetHeader().From, false, R3NoChange, false}
 301                         botdata.jid_lastauthtime_[stanza.GetHeader().From] = 0 //logout
 302                     default:
 303                         jabber_events <- JabberEvent{stanza.GetHeader().From, true, R3NoChange, false}
 304                 }
 305             case *xmpp.Iq:
 306                 if stanza.GetHeader() == nil {
 307                     continue
 308                 }
 309         }
 310     }
 311 }
 312
 313 func NewStartedBot(loginjid, loginpwd, password, state_save_dir string, insecuretls bool) (*XmppBot, chan interface{}, error) {
 314     var err error
 315     botdata := new(XmppBot)
 316
 317     botdata.realraum_jids_ = make(map[string]JidData, 1)
 318     botdata.jid_lastauthtime_ = make(map[string]int64,1)
 319     botdata.auth_cmd_ = "auth " + password
 320     botdata.auth_cmd2_ = "*auth*" + password+"*"
 321     botdata.my_jid_ = loginjid
 322     botdata.my_login_password_ = loginpwd
 323     botdata.auth_timeout_ = 3600*2
 324
 325     botdata.config_file_ = path.Join(state_save_dir, "r3xmpp."+removeJIDResource(loginjid)+".json")
 326
 327     //~ log.Println(botdata.config_file_)
 328
 329     //~ logger := &StdLogger{}
 330     //~ xmpp.Debug = logger
 331     //~ xmpp.Info = logger
 332     //~ xmpp.Warn = logger
 333
 334     xmpp.TlsConfig = tls.Config{InsecureSkipVerify: insecuretls}
 335     botdata.realraum_jids_.loadFrom(botdata.config_file_)
 336
 337     client_jid := new(xmpp.JID)
 338     client_jid.Set(botdata.my_jid_)
 339     botdata.xmppclient_, err = xmpp.NewClient(client_jid, botdata.my_login_password_, nil)
 340     if err != nil {
 341         log.Println("Error connecting to xmpp server", err)
 342         return nil, nil, err
 343     }
 344
 345     err = botdata.xmppclient_.StartSession(true, &xmpp.Presence{})
 346     if err != nil {
 347         log.Println("'Error StartSession:", err)
 348         return nil, nil, err
 349     }
 350
 351     roster := xmpp.Roster(botdata.xmppclient_)
 352     for _, entry := range roster {
 353         if entry.Subscription == "from" {
 354             botdata.xmppclient_.Out <- botdata.makeXMPPPresence(entry.Jid, "subscribe")
 355         }
 356         if entry.Subscription == "none" {
 357             delete(botdata.realraum_jids_, entry.Jid)
 358         }
 359     }
 360
 361     presence_events := make(chan interface{},1)
 362     jabber_events := make(chan JabberEvent,1)
 363
 364     go botdata.handleEventsforXMPP(botdata.xmppclient_.Out, presence_events, jabber_events)
 365     go botdata.handleIncomingXMPPStanzas(botdata.xmppclient_.In, botdata.xmppclient_.Out, jabber_events)
 366
 367     botdata.presence_events_ = &presence_events
 368
 369     return botdata, presence_events, nil
 370 }
 371
 372 func (botdata *XmppBot) StopBot() {
 373     if botdata.xmppclient_ != nil {
 374         close(botdata.xmppclient_.Out)
 375     }
 376     if botdata.presence_events_ != nil {
 377         *botdata.presence_events_ <- false
 378         close(*botdata.presence_events_)
 379     }
 380 }