def __init__(self):
PBDaemon.__init__(self, keeproot=True)
ZCmdBase.__init__(self)
self.log.info('Starting...')
wants_ssl = self.options.ssl
if wants_ssl and not HAVE_SSL:
self.log.error('SSL was requested for Jabber connection, but pyopenssl is not installed. Please install it and start the xmppBot again.')
sys.exit(2)
if not self.options.jabber_pass:
self.log.error('--jabber_pass is required')
sys.exit(2)
if not self.options.jabber_user:
self.log.error('--jabber_user is required')
sys.exit(2)
if self.options.first_user:
try:
zenUser, jabberId = self.options.first_user.split(',')
except ValueError:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
if zenUser and jabberId:
self.setFirstUser(zenUser, jabberId)
else:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
# taken from zenactions.py
self.schedule = Schedule(self.options, self.dmd)
self.actions = []
self.loadActionRules()
self.updateCheck = UpdateCheck()
self.sendEvent(Event.Event(device=self.options.monitor,
eventClass=App_Start, summary='Jabber Bot started', severity=0, component='xmppbot'))
self.adapter = JabberAdapter(True)
password = self.options.jabber_pass
chatroom = self.options.chatroom
username = self.options.jabber_user
host = self.options.jabber_host
port = self.options.jabber_port
groupServer = self.options.group_server
realHost = self.options.im_host
server = '%s:%s' % (host, port)
client = TwistedJabberClient(dialogHandler = self.adapter,
server = server,
userId = username, userPassword = password,
firstRoom = chatroom, debug = True,
groupServer = groupServer, realHost = realHost, wants_ssl = wants_ssl)
self.adapter.client = client
path = os.path.realpath(sys.argv[0])
pluginPath = os.path.dirname(path) + '/Jabber/plugins'
self.log.info("xmppBot plugins will be loaded from %s" % pluginPath)
plugins = [pluginFile.split('/')[-1].split('.py')[0] for pluginFile in glob.glob( os.path.join(pluginPath, '*.py') )]
initPluginSystem({'pluginPath': pluginPath, 'plugins': plugins})
self.log.info('started')
# connect to the jabber server
jabber_reactor = client.connect()
# begin looking for zenevents
self.schedule.start()
self.runCycle()
# start event loop which will process jabber messages and zenevents
jabber_reactor.run()
def __init__(self):
PBDaemon.__init__(self, keeproot=True)
ZCmdBase.__init__(self)
wants_ssl = self.options.ssl
if wants_ssl and not HAVE_SSL:
self.log.error('SSL was requested for Jabber connection, but pyopenssl is not installed. Please install it and start the xmppBot again.')
sys.exit(2)
if not self.options.jabber_pass:
self.log.error('--jabber_pass is required')
sys.exit(2)
if not self.options.jabber_user:
self.log.error('--jabber_user is required')
sys.exit(2)
if self.options.first_user:
try:
zenUser, jabberId = self.options.first_user.split(',')
except ValueError:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
if zenUser and jabberId:
self.setFirstUser(zenUser, jabberId)
else:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
# taken from zenactions.py
self.schedule = Schedule(self.options, self.dmd)
self.actions = []
self.loadActionRules()
self.updateCheck = UpdateCheck()
self.sendEvent(Event.Event(device=self.options.monitor,
eventClass=App_Start, summary='Jabber Bot started', severity=0, component='xmppbot'))
self.adapter = JabberAdapter(True)
password = self.options.jabber_pass
chatroom = self.options.chatroom
username = self.options.jabber_user
host = self.options.jabber_host
port = self.options.jabber_port
groupServer = self.options.group_server
realHost = self.options.im_host
server = '%s:%s' % (host, port)
client = TwistedJabberClient(dialogHandler = self.adapter,
server = server,
userId = username, userPassword = password,
firstRoom = chatroom, debug = True,
groupServer = groupServer, realHost = realHost, wants_ssl = wants_ssl)
self.adapter.client = client
path = os.path.realpath(sys.argv[0])
pluginPath = os.path.dirname(path) + '/Jabber/plugins'
self.log.info("xmppBot plugins will be loaded from %s" % pluginPath)
plugins = [pluginFile.split('/')[-1].split('.py')[0] for pluginFile in glob.glob( os.path.join(pluginPath, '*.py') )]
initPluginSystem({'pluginPath': pluginPath, 'plugins': plugins})
self.log.info('started')
# connect to the jabber server
jabber_reactor = client.connect()
# begin looking for zenevents
self.schedule.start()
self.runCycle()
# start event loop which will process jabber messages and zenevents
jabber_reactor.run()
class xmppBot(ZenActions,ZCmdBase, PBDaemon):
def buildOptions(self):
ZCmdBase.buildOptions(self)
self.parser.add_option( '--jabber_pass', dest='jabber_pass', help='Password used to connect to the XMPP server')
self.parser.add_option( '--jabber_user', dest='jabber_user', help='Username used to connect to the XMPP server')
self.parser.add_option( '--jabber_host', dest='jabber_host', default='localhost', help='XMPP server to connect')
self.parser.add_option( '--jabber_port', dest='jabber_port', default='5222', help='Port used to connect to the XMPP server')
self.parser.add_option( '--first_user', dest='first_user', help='User mapping to bootstrap the bot with at least on authorized user. Example specification myzenossname,[email protected]')
self.parser.add_option( '--im_host', dest='im_host', help='Optional option for addressing IM users when the server is not known. If this is ommitted, jabber_host will be used.')
self.parser.add_option( '--ssl', dest='ssl', action='store_true', help='Use ssl.')
self.parser.add_option( '--group_server', dest='group_server', help='Conference/groupchat server. If the name has no dots, it will use group_server.jabber_host')
self.parser.add_option( '--chatroom', dest='chatroom', help='First chatroom joined to when connecting')
self.parser.add_option('--cycletime', dest='cycletime', default=60, type='int', help='check events every cycletime seconds')
self.parser.add_option( '--zopeurl', dest='zopeurl', default='http://%s:%d' % (socket.getfqdn(), 8080), help='http path to the root of the zope server')
self.parser.add_option('--monitor', dest='monitor', default=DEFAULT_MONITOR, help='Name of monitor instance to use for heartbeat events. Default is %s.' % DEFAULT_MONITOR)
def __init__(self):
PBDaemon.__init__(self, keeproot=True)
ZCmdBase.__init__(self)
self.log.info('Starting...')
wants_ssl = self.options.ssl
if wants_ssl and not HAVE_SSL:
self.log.error('SSL was requested for Jabber connection, but pyopenssl is not installed. Please install it and start the xmppBot again.')
sys.exit(2)
if not self.options.jabber_pass:
self.log.error('--jabber_pass is required')
sys.exit(2)
if not self.options.jabber_user:
self.log.error('--jabber_user is required')
sys.exit(2)
if self.options.first_user:
try:
zenUser, jabberId = self.options.first_user.split(',')
except ValueError:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
if zenUser and jabberId:
self.setFirstUser(zenUser, jabberId)
else:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
# taken from zenactions.py
self.schedule = Schedule(self.options, self.dmd)
self.actions = []
self.loadActionRules()
self.updateCheck = UpdateCheck()
self.sendEvent(Event.Event(device=self.options.monitor,
eventClass=App_Start, summary='Jabber Bot started', severity=0, component='xmppbot'))
self.adapter = JabberAdapter(True)
password = self.options.jabber_pass
chatroom = self.options.chatroom
username = self.options.jabber_user
host = self.options.jabber_host
port = self.options.jabber_port
groupServer = self.options.group_server
realHost = self.options.im_host
server = '%s:%s' % (host, port)
client = TwistedJabberClient(dialogHandler = self.adapter,
server = server,
userId = username, userPassword = password,
firstRoom = chatroom, debug = True,
groupServer = groupServer, realHost = realHost, wants_ssl = wants_ssl)
self.adapter.client = client
path = os.path.realpath(sys.argv[0])
pluginPath = os.path.dirname(path) + '/Jabber/plugins'
self.log.info("xmppBot plugins will be loaded from %s" % pluginPath)
plugins = [pluginFile.split('/')[-1].split('.py')[0] for pluginFile in glob.glob( os.path.join(pluginPath, '*.py') )]
initPluginSystem({'pluginPath': pluginPath, 'plugins': plugins})
self.log.info('started')
# connect to the jabber server
jabber_reactor = client.connect()
# begin looking for zenevents
self.schedule.start()
self.runCycle()
# start event loop which will process jabber messages and zenevents
jabber_reactor.run()
def setFirstUser(self, zenUser, jabberId):
zenUser = zenUser.lower()
haveUser = False
for user in self.dmd.ZenUsers.getAllUserSettings():
if user.id.lower() == zenUser:
haveUser = True
user._updateProperty('JabberId', jabberId)
transaction.commit()
break
return haveUser
# ripped from zenactions.py
def mainbody(self):
"""main loop to run actions.
"""
from twisted.internet.process import reapAllProcesses
reapAllProcesses()
zem = self.dmd.ZenEventManager
self.loadActionRules()
self.processRules(zem)
# ripped from zenactions.py
def runCycle(self):
try:
start = time.time()
self.syncdb()
self.mainbody()
self.log.info('processed %s rules in %.2f secs', len(self.actions), time.time()-start)
except:
self.log.exception('unexpected exception')
reactor.callLater(60, self.runCycle)
# ripped from zenactions.py
def loadActionRules(self):
self.actions = []
for ar in self.dmd.ZenUsers.getAllActionRules():
if not ar.enabled: continue
if not ar.action.title() == 'Xmpp': continue
userid = ar.getUser().id
self.actions.append(ar)
self.log.debug('action:%s for:%s loaded', ar.getId(), userid)
# ripped from zenactions.py
def sendHeartbeat(self):
"""Send a heartbeat event for this monitor.
"""
timeout = self.options.cycletime*3
evt = Event.EventHeartbeat(self.options.monitor, 'xmppbot', timeout)
self.sendEvent(evt)
self.niceDoggie(self.options.cycletime)
# zenactions will call sendXmpp when an event comes in that the user wants
# to see.
def sendXmpp(self, action, data, clear = None):
message, body = self.format(action, data, clear)
recipients = self.getAddress(action)
if not recipients:
self.log.warning('failed to send message %s on rule %s: %s', action.getUser().id, action.id, 'Unspecified recipient.')
return True
for recipient in recipients:
self.log.debug('Sending message to %s: %s', recipient, message)
if recipient.lower().endswith('/groupchat'):
messageType = 'groupchat'
else:
messageType = 'chat'
self.adapter.sendMessage(message, recipient, messageType)
return True
def getAddress(self, action):
if action.targetAddr:
return [action.targetAddr]
else:
results = []
zenUser = action.getUser()
# attempt to detect a group and resolve its users, otherwise see if it is a user
if 'getMemberUserIds' in dir(zenUser):
for username in zenUser.getMemberUserIds():
try:
results.append(zenUser.getUserSettings(username).getProperty('JabberId').strip())
except None:
self.log.error('Unable to send xmpp alert message to %s. This might happen if they are missing the jabberId property. Try the bot command "setjid"' % username)
# getEmailAddresses should at least identify an entity that would have a jabberId on it, unless it was a group (above)
elif 'getEmailAddresses' in dir(zenUser):
try:
results.append(zenUser.getProperty('JabberId').lower())
except None:
self.log.error('Unable to send xmpp alert message to %s. This might happen if they are missing the jabberId property. Try the bot command "setjid"' % zenUser)
else:
self.log.error('Unable to send xmpp alert message to %s. Please report this error to the author of this plugin' % zenUser)
return results
class XmppBot(ZenActions,ZCmdBase, PBDaemon):
def buildOptions(self):
ZCmdBase.buildOptions(self)
self.parser.add_option( '--jabber_pass', dest='jabber_pass', help='Password used to connect to the XMPP server')
self.parser.add_option( '--jabber_user', dest='jabber_user', help='Username used to connect to the XMPP server')
self.parser.add_option( '--jabber_host', dest='jabber_host', default='localhost', help='XMPP server to connect')
self.parser.add_option( '--jabber_port', dest='jabber_port', default='5222', help='Port used to connect to the XMPP server')
self.parser.add_option( '--first_user', dest='first_user', help='User mapping to bootstrap the bot with at least on authorized user. Example specification myzenossname,[email protected]')
self.parser.add_option( '--im_host', dest='im_host', help='Optional option for addressing IM users when the server is not known. If this is ommitted, jabber_host will be used.')
self.parser.add_option( '--ssl', dest='ssl', action='store_true', help='Use ssl.')
self.parser.add_option( '--group_server', dest='group_server', help='Conference/groupchat server. If the name has no dots, it will use group_server.jabber_host')
self.parser.add_option( '--chatroom', dest='chatroom', help='First chatroom joined to when connecting')
self.parser.add_option('--cycletime', dest='cycletime', default=60, type='int', help='check events every cycletime seconds')
self.parser.add_option( '--zopeurl', dest='zopeurl', default='http://%s:%d' % (socket.getfqdn(), 8080), help='http path to the root of the zope server')
self.parser.add_option('--monitor', dest='monitor', default=DEFAULT_MONITOR, help='Name of monitor instance to use for heartbeat events. Default is %s.' % DEFAULT_MONITOR)
def __init__(self):
PBDaemon.__init__(self, keeproot=True)
ZCmdBase.__init__(self)
wants_ssl = self.options.ssl
if wants_ssl and not HAVE_SSL:
self.log.error('SSL was requested for Jabber connection, but pyopenssl is not installed. Please install it and start the xmppBot again.')
sys.exit(2)
if not self.options.jabber_pass:
self.log.error('--jabber_pass is required')
sys.exit(2)
if not self.options.jabber_user:
self.log.error('--jabber_user is required')
sys.exit(2)
if self.options.first_user:
try:
zenUser, jabberId = self.options.first_user.split(',')
except ValueError:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
if zenUser and jabberId:
self.setFirstUser(zenUser, jabberId)
else:
self.log.error('--first_user option must contain both zenuser and jabberid separated by a comma. Example: chudler,[email protected]')
sys.exit(2)
# taken from zenactions.py
self.schedule = Schedule(self.options, self.dmd)
self.actions = []
self.loadActionRules()
self.updateCheck = UpdateCheck()
self.sendEvent(Event.Event(device=self.options.monitor,
eventClass=App_Start, summary='Jabber Bot started', severity=0, component='xmppbot'))
self.adapter = JabberAdapter(True)
password = self.options.jabber_pass
chatroom = self.options.chatroom
username = self.options.jabber_user
host = self.options.jabber_host
port = self.options.jabber_port
groupServer = self.options.group_server
realHost = self.options.im_host
server = '%s:%s' % (host, port)
client = TwistedJabberClient(dialogHandler = self.adapter,
server = server,
userId = username, userPassword = password,
firstRoom = chatroom, debug = True,
groupServer = groupServer, realHost = realHost, wants_ssl = wants_ssl)
self.adapter.client = client
path = os.path.realpath(sys.argv[0])
pluginPath = os.path.dirname(path) + '/Jabber/plugins'
self.log.info("xmppBot plugins will be loaded from %s" % pluginPath)
plugins = [pluginFile.split('/')[-1].split('.py')[0] for pluginFile in glob.glob( os.path.join(pluginPath, '*.py') )]
initPluginSystem({'pluginPath': pluginPath, 'plugins': plugins})
self.log.info('started')
# connect to the jabber server
jabber_reactor = client.connect()
# begin looking for zenevents
self.schedule.start()
self.runCycle()
# start event loop which will process jabber messages and zenevents
jabber_reactor.run()
def setFirstUser(self, zenUser, jabberId):
zenUser = zenUser.lower()
haveUser = False
for user in self.dmd.ZenUsers.getAllUserSettings():
if user.id.lower() == zenUser:
haveUser = True
user._updateProperty('JabberId', jabberId)
transaction.commit()
break
return haveUser
# ripped from zenactions.py
def mainbody(self):
"""main loop to run actions.
"""
from twisted.internet.process import reapAllProcesses
reapAllProcesses()
zem = self.dmd.ZenEventManager
self.loadActionRules()
self.processRules(zem)
# ripped from zenactions.py
def runCycle(self):
try:
start = time.time()
self.syncdb()
self.mainbody()
self.log.info('processed %s rules in %.2f secs', len(self.actions), time.time()-start)
except:
self.log.exception('unexpected exception')
reactor.callLater(60, self.runCycle)
# ripped from zenactions.py
def loadActionRules(self):
self.actions = []
for ar in self.dmd.ZenUsers.getAllActionRules():
if not ar.enabled: continue
if not ar.action.title() == 'Xmpp': continue
userid = ar.getUser().id
self.actions.append(ar)
self.log.debug('action:%s for:%s loaded', ar.getId(), userid)
# ripped from zenactions.py
def sendHeartbeat(self):
"""Send a heartbeat event for this monitor.
"""
timeout = self.options.cycletime*3
evt = Event.EventHeartbeat(self.options.monitor, 'xmppbot', timeout)
self.sendEvent(evt)
self.niceDoggie(self.options.cycletime)
# zenactions will call sendXmpp when an event comes in that the user wants
# to see.
def sendXmpp(self, action, data, clear = None):
message, body = self.format(action, data, clear)
recipients = self.getAddress(action)
if not recipients:
self.log.warning('failed to send message %s on rule %s: %s', action.getUser().id, action.id, 'Unspecified recipient.')
return True
for recipient in recipients:
self.log.debug('Sending message to %s: %s', recipient, message)
if recipient.lower().endswith('/groupchat'):
messageType = 'groupchat'
else:
messageType = 'chat'
self.adapter.sendMessage(message, recipient, messageType)
return True
def getAddress(self, action):
if action.targetAddr:
return [action.targetAddr]
else:
results = []
zenUser = action.getUser()
# attempt to detect a group and resolve its users, otherwise see if it is a user
if 'getMemberUserIds' in dir(zenUser):
for username in zenUser.getMemberUserIds():
try:
results.append(zenUser.getUserSettings(username).getProperty('JabberId').strip())
except None:
self.log.error('Unable to send xmpp alert message to %s. This might happen if they are missing the jabberId property. Try the bot command "setjid"' % username)
# getEmailAddresses should at least identify an entity that would have a jabberId on it, unless it was a group (above)
elif 'getEmailAddresses' in dir(zenUser):
try:
results.append(zenUser.getProperty('JabberId').lower())
except None:
self.log.error('Unable to send xmpp alert message to %s. This might happen if they are missing the jabberId property. Try the bot command "setjid"' % zenUser)
else:
self.log.error('Unable to send xmpp alert message to %s. Please report this error to the author of this plugin' % zenUser)
return results
