r3-webstatus-spaceapi/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 PresenceEvent struct {
  75     Present bool
  76     DoorLock bool
  77     DoorAjar bool
  78 }
  79
  80 type RealraumXmppNotifierConfig map[string]JidData
  81
  82 type XmppBot struct {
  83     jid_lastauthtime_ map[string]int64
  84     realraum_jids_ RealraumXmppNotifierConfig
  85     password_ string
  86     auth_cmd_ string
  87     my_jid_ string
  88     auth_timeout_ int64
  89     config_file_ string
  90     my_login_password_ string
  91     xmppclient_ *xmpp.Client
  92     presence_events_ *chan interface{}
  93 }
  94
  95
  96 func (data RealraumXmppNotifierConfig) saveTo(filepath string) () {
  97     fh, err := os.Create(filepath)
  98     if err != nil {
  99         log.Println(err)
 100         return
 101     }
 102     defer fh.Close()
 103     enc := json.NewEncoder(fh)
 104     if err = enc.Encode(&data); err != nil {
 105         log.Println(err)
 106         return
 107     }
 108 }
 109
 110 func (data RealraumXmppNotifierConfig) loadFrom(filepath string) () {
 111     fh, err := os.Open(filepath)
 112     if err != nil {
 113         log.Println(err)
 114         return
 115     }
 116     defer fh.Close()
 117     dec := json.NewDecoder(fh)
 118     if err = dec.Decode(&data); err != nil {
 119         log.Println(err)
 120         return
 121     }
 122     for to, jiddata := range data  {
 123         jiddata.Online = false
 124         data[to]=jiddata
 125     }
 126 }
 127
 128
 129 func init() {
 130         //~ logger := &StdLogger{}
 131         //~ xmpp.Debug = logger
 132         //~ xmpp.Info = logger
 133         //~ xmpp.Warn = logger
 134 }
 135
 136 func (botdata *XmppBot) handleEventsforXMPP(xmppout chan <- xmpp.Stanza, presence_events <- chan interface{}, jabber_events <- chan JabberEvent) {
 137     var msg, presence_str, lock_str, ajar_str string
 138     last_presence := false
 139     var debug_msg bool
 140
 141         for {
 142         debug_msg = false
 143                 select {
 144                 case pe := <-presence_events:
 145             switch pec := pe.(type) {
 146                 case xmpp.Stanza:
 147                     xmppout <- pec
 148                     continue
 149                 case string:
 150                     msg = pec
 151                 case PresenceEvent:
 152                     if pec.Present {
 153                         presence_str = "Somebody is present !"
 154                     } else {
 155                         presence_str = "Everybody left."
 156                     }
 157                     if pec.DoorLock {
 158                         lock_str = "locked"
 159                     } else {
 160                         lock_str = "unlocked"
 161                     }
 162                     if pec.DoorAjar {
 163                         ajar_str = "ajar"
 164                     } else {
 165                         ajar_str = "shut"
 166                     }
 167                     msg = fmt.Sprintf("%s (Door is %s and %s)", presence_str, lock_str, ajar_str)
 168                     if last_presence == pec.Present {
 169                         debug_msg = true
 170                     } else {
 171                         last_presence = pec.Present
 172                     }
 173                 default:
 174                     break
 175                 }
 176
 177                 for to, jiddata := range botdata.realraum_jids_  {
 178                     if debug_msg && jiddata.Wants < R3DebugInfo {
 179                         continue
 180                     }
 181                     if (jiddata.Wants == R3NoOfflineInfo && jiddata.Online) || jiddata.Wants > R3NoOfflineInfo {
 182                         xmppout <-  botdata.makeXMPPMessage(to, msg, nil)
 183                     }  //else  {
 184                         //~ fmt.Println("Not sending to ", to, jiddata)
 185                     //~ }
 186                 }
 187
 188                 case je := <-jabber_events:
 189             jid_data, jid_in_map := botdata.realraum_jids_[je.JID]
 190             if jid_in_map {
 191                 jid_data.Online = je.Online
 192                 if je.Wants > R3NoChange {
 193                     jid_data.Wants = je.Wants
 194                 }
 195                 botdata.realraum_jids_[je.JID] = jid_data
 196                 botdata.realraum_jids_.saveTo(botdata.config_file_)
 197             } else if je.Wants > R3NoChange {
 198                 botdata.realraum_jids_[je.JID] = JidData{je.Online, je.Wants}
 199                 botdata.realraum_jids_.saveTo(botdata.config_file_)
 200             }
 201                 }
 202         }
 203 }
 204
 205 func removeJIDResource(jid string) string {
 206     var jidjid xmpp.JID
 207     jidjid.Set(jid)
 208     jidjid.Resource = ""
 209     return jidjid.String()
 210 }
 211
 212 func (botdata *XmppBot) isAuthenticated(jid string) bool {
 213     authtime, in_map := botdata.jid_lastauthtime_[jid]
 214     //~ log.Println("isAuthenticated", in_map, authtime, time.Now().Unix(), auth_timeout_, time.Now().Unix() - authtime > auth_timeout_)
 215     return in_map && time.Now().Unix() - authtime < botdata.auth_timeout_
 216 }
 217
 218 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"
 219
 220 //~ var re_msg_auth_    *regexp.Regexp     = regexp.MustCompile("auth\s+(\S+)")
 221
 222 func (botdata *XmppBot) handleIncomingMessageDialog(inmsg xmpp.Message, xmppout chan<- xmpp.Stanza, jabber_events chan JabberEvent) {
 223     if inmsg.Body == nil || inmsg.GetHeader() == nil {
 224         return
 225     }
 226     bodytext :=inmsg.Body.Chardata
 227     //~ log.Println("Message Body:", bodytext)
 228     if botdata.isAuthenticated(inmsg.GetHeader().From) {
 229         switch bodytext {
 230             case "on":
 231                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3NoOfflineInfo}
 232                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Receive r3 information while online" , "Your New Status")
 233             case "off":
 234                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3NoInfo}
 235                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Do not receive r3 information" , "Your New Status")
 236             case "on_while_offline":
 237                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3AllInfo}
 238                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Receive r3 information even while offline" , "Your New Status")
 239             case "debug":
 240                 jabber_events <- JabberEvent{removeJIDResource(inmsg.GetHeader().From), true, R3DebugInfo}
 241                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Debug mode enabled" , "Your New Status")
 242             case "bye", "Bye", "quit", "logout":
 243                 botdata.jid_lastauthtime_[inmsg.GetHeader().From] = 0
 244                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "Bye Bye !" ,nil)
 245             default:
 246                 //~ auth_match = re_msg_auth_.FindStringSubmatch(inmsg.Body.Chardata)
 247                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, help_text_, "Available Commands")
 248         }
 249     } else {
 250         switch bodytext {
 251             case "Hilfe","hilfe","help","Help","?","hallo","Hallo","Yes","yes","ja","ja bitte","bitte","sowieso":
 252                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, help_text_, "Available Commands")
 253             case botdata.auth_cmd_:
 254                 botdata.jid_lastauthtime_[inmsg.GetHeader().From] = time.Now().Unix()
 255                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "You are now authorized to use commands" , "Authorized")
 256             default:
 257                 //~ auth_match = re_msg_auth_.FindStringSubmatch(inmsg.Body.Chardata)
 258                 xmppout <- botdata.makeXMPPMessage(inmsg.GetHeader().From, "A nice day to you too !\nDo you need \"help\" ?", nil)
 259         }
 260     }
 261 }
 262
 263 func (botdata *XmppBot) handleIncomingXMPPStanzas(xmppin <- chan xmpp.Stanza, xmppout chan<- xmpp.Stanza, jabber_events chan JabberEvent) {
 264     var incoming_stanza interface{}
 265     for incoming_stanza = range xmppin {
 266         switch stanza := incoming_stanza.(type) {
 267             case *xmpp.Message:
 268                 botdata.handleIncomingMessageDialog(*stanza, xmppout, jabber_events)
 269             case *xmpp.Presence:
 270                 if stanza.GetHeader() == nil {
 271                     continue
 272                 }
 273                 if stanza.GetHeader().Type == "subscribe" {
 274                     xmppout <- botdata.makeXMPPPresence(stanza.GetHeader().From, "subscribed")
 275                 }
 276                 jabber_events <- JabberEvent{stanza.GetHeader().From, stanza.GetHeader().Type != "unavailable", R3NoChange}
 277             case *xmpp.Iq:
 278                 if stanza.GetHeader() == nil {
 279                     continue
 280                 }
 281         }
 282     }
 283 }
 284
 285 var default_state_save_dir_ string = "/flash/var/lib/r3netstatus/"
 286
 287 func NewStartedBot(loginjid, loginpwd, password string, insecuretls bool) (*XmppBot, chan interface{}, error) {
 288     var err error
 289     botdata := new(XmppBot)
 290
 291     botdata.realraum_jids_ = make(map[string]JidData, 1)
 292     botdata.jid_lastauthtime_ = make(map[string]int64,1)
 293     botdata.auth_cmd_ = "auth " + password
 294     botdata.my_jid_ = loginjid
 295     botdata.my_login_password_ = loginpwd
 296     botdata.auth_timeout_ = 1200
 297
 298     botdata.config_file_ = path.Join(default_state_save_dir_, "r3xmpp."+removeJIDResource(loginjid)+".json")
 299
 300     //~ log.Println(botdata.config_file_)
 301
 302     //~ logger := &StdLogger{}
 303     //~ xmpp.Debug = logger
 304     //~ xmpp.Info = logger
 305     //~ xmpp.Warn = logger
 306
 307     xmpp.TlsConfig = tls.Config{InsecureSkipVerify: insecuretls}
 308     botdata.realraum_jids_.loadFrom(botdata.config_file_)
 309
 310     client_jid := new(xmpp.JID)
 311     client_jid.Set(botdata.my_jid_)
 312     botdata.xmppclient_, err = xmpp.NewClient(client_jid, botdata.my_login_password_, nil)
 313     if err != nil {
 314         log.Println("Error connecting to xmpp server", err)
 315         return nil, nil, err
 316     }
 317
 318     err = botdata.xmppclient_.StartSession(false, &xmpp.Presence{})
 319     if err != nil {
 320         log.Println("'Error StartSession:", err)
 321         return nil, nil, err
 322     }
 323
 324     presence_events := make(chan interface{},1)
 325     jabber_events := make(chan JabberEvent,1)
 326
 327     go botdata.handleEventsforXMPP(botdata.xmppclient_.Out, presence_events, jabber_events)
 328     go botdata.handleIncomingXMPPStanzas(botdata.xmppclient_.In, botdata.xmppclient_.Out, jabber_events)
 329
 330     botdata.presence_events_ = &presence_events
 331
 332     return botdata, presence_events, nil
 333 }
 334
 335 func (botdata *XmppBot) StopBot() {
 336     if botdata.xmppclient_ != nil {
 337         close(botdata.xmppclient_.Out)
 338     }
 339     if botdata.presence_events_ != nil {
 340         *botdata.presence_events_ <- false
 341         close(*botdata.presence_events_)
 342     }
 343 }
 344
 345 //~ func main() {
 346     //~ bot, presence_events, err := NewStartedBot("realrauminfo@realraum.at/Tuer", "d7ynC6Dg", "r3alraumOLGAXMPPInfos", true)
 347
 348     //~ if err != nil {
 349         //~ log.Println(err)
 350         //~ os.Exit(1)
 351     //~ }
 352
 353     //~ presence_events <- PresenceEvent{true, true, true}
 354     //~ presence_events <- PresenceEvent{true, true, false}
 355     //~ presence_events <- PresenceEvent{true, false, false}
 356
 357     //~ p := make([]byte, 1024)
 358     //~ for
 359     //~ {
 360         //~ nr, _ := os.Stdin.Read(p)
 361         //~ if nr == 0 {
 362             //~ break
 363         //~ }
 364     //~ }
 365
 366     //~ bot.StopBot()
 367 //~ }