#!/usr/bin/env python

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

import logging

from os import path, access, makedirs, sep, getcwd, W_OK

from platform import system

def debug(sig, frame):

"""Interrupt running process, and provide a python prompt for

interactive debugging."""

d={'_frame':frame} # Allow access to frame object.

d.update(frame.f_globals) # Unless shadowed by global

d.update(frame.f_locals)

i = code.InteractiveConsole(d)

message = "Signal received : entering python shell.\nTraceback:\n"

message += ''.join(traceback.format_stack(frame))

i.interact(message)

ON_WINDOWS = system() == 'Windows'

import sys

import argparse

if not ON_WINDOWS:

import daemon

from pwd import getpwnam

from grp import getgrnam

import code, traceback, signal

signal.signal(signal.SIGUSR1, debug) # Register handler for debugging

logging.basicConfig(format='%(levelname)s:%(message)s')

logger = logging.getLogger('')

logger.setLevel(logging.INFO)

def check_config(config_path, mode):

__import__('errbot.config-template') # - is on purpose, it should not be imported normally ;)

template = sys.modules['errbot.config-template']

config_fullpath = config_path + sep + 'config.py'

if not path.exists(config_fullpath):

logging.error('I cannot find the file config.py in the directory %s \n(You can change this directory with the -c parameter see --help)' % config_path)

logging.info('You can use the template %s as a base and copy it to %s. \nYou can then customize it.' % (path.dirname(template.__file__) + sep + 'config-template.py', config_path + sep))

exit(-1)

try:

try:

# gives the opportunity to have one config per mode to simplify the debugging

config = __import__('config_'+mode)

sys.modules['config'] = config

except ImportError as ie:

if not ie.message.startswith('No module named'):

logging.exception('Error while trying to load %s' % 'config_'+mode)

import config

diffs = [item for item in set(dir(template)) - set(dir(config)) if not item.startswith('_')]

if diffs:

logging.error('You are missing configs defined from the template :')

for diff in diffs:

logging.error('Missing config : %s' % diff)

exit(-1)

except Exception, e:

logging.exception('I could not import your config from %s, please check the error below...' % config_fullpath)

exit(-1)

logging.info('Config check passed...')

def main(bot_class):

# from here the environment is supposed to be set (daemon / non daemon,

# config.py in the python path )

from errbot.utils import PLUGINS_SUBDIR

from errbot import holder

from config import BOT_IDENTITY, BOT_LOG_LEVEL, BOT_DATA_DIR, BOT_LOG_FILE, BOT_LOG_SENTRY

if BOT_LOG_FILE:

hdlr = logging.FileHandler(BOT_LOG_FILE)

hdlr.setFormatter(logging.Formatter('%(asctime)s %(levelname)s %(message)s'))

logger.addHandler(hdlr)

logger.setLevel(BOT_LOG_LEVEL)

if BOT_LOG_SENTRY:

try:

from raven.handlers.logging import SentryHandler

except ImportError, e:

logging.exception("You have BOT_LOG_SENTRY enabled, but I couldn't import modules needed for Sentry integration.\nDid you install raven? (See http://raven.readthedocs.org/en/latest/install/index.html for installation instructions)\n\n")

exit(-1)

from config import SENTRY_DSN, SENTRY_LOGLEVEL

sentryhandler = SentryHandler(SENTRY_DSN, level=SENTRY_LOGLEVEL)

logger.addHandler(sentryhandler)

d = path.dirname(BOT_DATA_DIR)

if not path.exists(d):

raise Exception('The data directory %s for the bot does not exist' % BOT_DATA_DIR)

if not access(BOT_DATA_DIR, W_OK):

raise Exception('The data directory %s should be writable for the bot' % BOT_DATA_DIR)

# make the plugins subdir to store the plugin shelves

d = BOT_DATA_DIR + sep + PLUGINS_SUBDIR

if not path.exists(d):

makedirs(d, mode=0755)

holder.bot = bot_class(**BOT_IDENTITY)

errors = holder.bot.update_dynamic_plugins()

if errors:

logging.error('Some plugins failed to load:\n' + '\n'.join(errors))

logging.debug('serve from %s' % holder.bot)

holder.bot.serve_forever()

if __name__ == "__main__":

parser = argparse.ArgumentParser(description='The main entry point of the XMPP bot err.')

parser.add_argument('-c', '--config', default=getcwd(), help='Specify the directory where your config.py is (default: current working directory)')

backend_group = parser.add_mutually_exclusive_group()

backend_group.add_argument('-X', '--xmpp', action='store_true', help='XMPP backend [DEFAULT]')

backend_group.add_argument('-H', '--hipchat', action='store_true', help='Hipchat backend')

backend_group.add_argument('-C', '--campfire', action='store_true', help='campfire backend')

backend_group.add_argument('-I', '--irc', action='store_true', help='IRC backend')

backend_group.add_argument('-T', '--text', action='store_true', help='locale text debug backend')

backend_group.add_argument('-G', '--graphic', action='store_true', help='local graphical debug mode backend')

backend_group.add_argument('-N', '--null', action='store_true', help='no backend')

if not ON_WINDOWS:

option_group = parser.add_argument_group('arguments to run it as a Daemon')

option_group.add_argument('-d', '--daemon', action='store_true', help='Detach the process from the console')

option_group.add_argument('-p', '--pidfile', default=None, help='Specify the pid file for the daemon (default: current bot data directory)')

option_group.add_argument('-u', '--user', default=None, help='Specify the user id you want the daemon to run under')

option_group.add_argument('-g', '--group', default=None, help='Specify the group id you want the daemon to run under')

args = vars(parser.parse_args()) # create a dictionary of args

config_path = args['config']

# setup the environment to be able to import the config.py

sys.path.insert(0, config_path) # appends the current directory in order to find config.py

filtered_mode = filter(lambda mname: args[mname], ('text', 'graphic', 'campfire', 'hipchat', 'irc', 'xmpp', 'null'))

mode = filtered_mode[0] if filtered_mode else 'xmpp' # default value

check_config(config_path, mode) # check if everything is ok before attempting to start

def text():

from errbot.backends.text import TextBackend

return TextBackend

def graphic():

from errbot.backends.graphic import GraphicBackend

return GraphicBackend

def campfire():

from errbot.backends.campfire import CampfireBackend

return CampfireBackend

def hipchat():

from errbot.backends.hipchat import HipchatBot

return HipchatBot

def irc():

from errbot.backends.irc import IRCBackend

return IRCBackend

def xmpp():

from errbot.backends.jabber import JabberBot

return JabberBot

def null():

from errbot.backends.null import NullBackend

return NullBackend

bot_class = locals()[mode]()

if (not ON_WINDOWS) and args['daemon']:

if args['text']:

raise Exception('You cannot run in text and daemon mode at the same time')

if args['pidfile']:

pid = args['pidfile']

else:

from config import BOT_DATA_DIR

pid = BOT_DATA_DIR + sep + 'err.pid'

from errbot.pid import PidFile

pidfile = PidFile(pid)

uid = getpwnam(args['user']).pw_uid if args['user'] else None

gid = getgrnam(args['group']).gr_gid if args['group'] else None

try:

with daemon.DaemonContext(detach_process=True, working_directory=getcwd(), pidfile=pidfile, uid=uid,

gid=gid): # put the initial working directory to be sure not to lost it after daemonization

main(bot_class)

except:

logging.exception('Failed to daemonize the process')

main(bot_class)

logging.info('Process exiting')