code-4efa50393b2d/roundup/scripts/.cvsignore0000644000000000000000000000002410525056216017110 0ustar 00000000000000*.pyc *.pyo *.cover code-4efa50393b2d/roundup/scripts/__init__.py0000644000000000000000000000222110525056216017222 0ustar 00000000000000# # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # This module is free software, and you may redistribute it and/or modify # under the same terms as Python, so long as this copyright message and # disclaimer are retained in their original form. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # # $Id: __init__.py,v 1.3 2004-02-11 23:55:10 richard Exp $ '''Subpackage containing the modules that implement the command line tools. Note that these are imported by script stubs generated by "setup.py". ''' __docformat__ = 'restructuredtext' # vim: set filetype=python ts=4 sw=4 et si code-4efa50393b2d/roundup/scripts/roundup_admin.py0000644000000000000000000000274710525056216020344 0ustar 00000000000000# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # This module is free software, and you may redistribute it and/or modify # under the same terms as Python, so long as this copyright message and # disclaimer are retained in their original form. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # # $Id: roundup_admin.py,v 1.6 2004-02-11 23:55:10 richard Exp $ """Command-line script stub that calls the roundup.admin functions. """ __docformat__ = 'restructuredtext' # python version check from roundup import version_check # import the admin tool guts and make it go from roundup.admin import AdminTool from roundup.i18n import _ import sys def run(): # time out after a minute if we can import socket if hasattr(socket, 'setdefaulttimeout'): socket.setdefaulttimeout(60) tool = AdminTool() sys.exit(tool.main()) if __name__ == '__main__': run() # vim: set filetype=python ts=4 sw=4 et si code-4efa50393b2d/roundup/scripts/roundup_demo.py0000644000000000000000000000230310525056216020164 0ustar 00000000000000#! /usr/bin/env python # # Copyright 2004 Richard Jones (richard@mechanicalcat.net) # # $Id: roundup_demo.py,v 1.1 2004-10-18 07:56:09 a1s Exp $ import sys from roundup import admin, configuration, demo, instance from roundup.i18n import _ DEFAULT_HOME = './demo' def run(): home = DEFAULT_HOME nuke = sys.argv[-1] == 'nuke' # if there is no tracker in home, force nuke try: instance.open(home) except configuration.NoConfigError: nuke = 1 # if we are to create the tracker, prompt for home if nuke: if len(sys.argv) > 2: backend = sys.argv[-2] else: backend = 'anydbm' # FIXME: i'd like to have an option to abort the tracker creation # say, by entering a single dot. but i cannot think of # appropriate prompt for that. home = raw_input( _('Enter directory path to create demo tracker [%s]: ') % home) if not home: home = DEFAULT_HOME # install demo.install_demo(home, backend, admin.AdminTool().listTemplates()['classic']['path']) # run demo.run_demo(home) if __name__ == '__main__': run() # vim: set et sts=4 sw=4 : code-4efa50393b2d/roundup/scripts/roundup_gettext.py0000644000000000000000000000346510525056216020736 0ustar 00000000000000#! /usr/bin/env python # # Copyright 2004 Richard Jones (richard@mechanicalcat.net) # # $Id: roundup_gettext.py,v 1.1 2004-10-20 10:25:23 a1s Exp $ """Extract translatable strings from tracker templates""" import os import sys from roundup.i18n import _ from roundup.cgi.TAL import talgettext # name of message template file. # i don't think this will ever need to be changed, but still... TEMPLATE_FILE = "messages.pot" def run(): # return unless command line arguments contain single directory path if (len(sys.argv) != 2) or (sys.argv[1] in ("-h", "--help")): print _("Usage: %(program)s ") % {"program": sys.argv[0]} return # collect file paths of html templates home = os.path.abspath(sys.argv[1]) htmldir = os.path.join(home, "html") if os.path.isdir(htmldir): # glob is not used because i want to match file names # without case sensitivity, and that is easier done this way. htmlfiles = [filename for filename in os.listdir(htmldir) if os.path.isfile(os.path.join(htmldir, filename)) and filename.lower().endswith(".html")] else: htmlfiles = [] # return if no html files found if not htmlfiles: print _("No tracker templates found in directory %s") % home return # change to locale dir to have relative source references locale = os.path.join(home, "locale") if not os.path.isdir(locale): os.mkdir(locale) os.chdir(locale) # tweak sys.argv as this is the only way to tell talgettext what to do # Note: unix-style paths used instead of os.path.join deliberately sys.argv[1:] = ["-o", TEMPLATE_FILE] \ + ["../html/" + filename for filename in htmlfiles] # run talgettext.main() if __name__ == "__main__": run() # vim: set et sts=4 sw=4 : code-4efa50393b2d/roundup/scripts/roundup_mailgw.py0000644000000000000000000001572110525056216020530 0ustar 00000000000000# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # This module is free software, and you may redistribute it and/or modify # under the same terms as Python, so long as this copyright message and # disclaimer are retained in their original form. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # # $Id: roundup_mailgw.py,v 1.22 2006-07-15 10:08:01 schlatterbeck Exp $ """Command-line script stub that calls the roundup.mailgw. """ __docformat__ = 'restructuredtext' # python version check from roundup import version_check from roundup import __version__ as roundup_version import sys, os, re, cStringIO, getopt, socket from roundup import mailgw from roundup.i18n import _ def usage(args, message=None): if message is not None: print message print _( """Usage: %(program)s [-v] [-c class] [[-C class] -S field=value]* [method] Options: -v: print version and exit -c: default class of item to create (else the tracker's MAIL_DEFAULT_CLASS) -C / -S: see below The roundup mail gateway may be called in one of four ways: . with an instance home as the only argument, . with both an instance home and a mail spool file, . with both an instance home and a POP/APOP server account, or . with both an instance home and a IMAP/IMAPS server account. It also supports optional -C and -S arguments that allows you to set a fields for a class created by the roundup-mailgw. The default class if not specified is msg, but the other classes: issue, file, user can also be used. The -S or --set options uses the same property=value[;property=value] notation accepted by the command line roundup command or the commands that can be given on the Subject line of an email message. It can let you set the type of the message on a per email address basis. PIPE: In the first case, the mail gateway reads a single message from the standard input and submits the message to the roundup.mailgw module. UNIX mailbox: In the second case, the gateway reads all messages from the mail spool file and submits each in turn to the roundup.mailgw module. The file is emptied once all messages have been successfully handled. The file is specified as: mailbox /path/to/mailbox POP: In the third case, the gateway reads all messages from the POP server specified and submits each in turn to the roundup.mailgw module. The server is specified as: pop username:password@server The username and password may be omitted: pop username@server pop server are both valid. The username and/or password will be prompted for if not supplied on the command-line. APOP: Same as POP, but using Authenticated POP: apop username:password@server IMAP: Connect to an IMAP server. This supports the same notation as that of POP mail. imap username:password@server It also allows you to specify a specific mailbox other than INBOX using this format: imap username:password@server mailbox IMAPS: Connect to an IMAP server over ssl. This supports the same notation as IMAP. imaps username:password@server [mailbox] """)%{'program': args[0]} return 1 def main(argv): '''Handle the arguments to the program and initialise environment. ''' # take the argv array and parse it leaving the non-option # arguments in the args array. try: optionsList, args = getopt.getopt(argv[1:], 'vc:C:S:', ['set=', 'class=']) except getopt.GetoptError: # print help information and exit: usage(argv) sys.exit(2) for (opt, arg) in optionsList: if opt == '-v': print '%s (python %s)'%(roundup_version, sys.version.split()[0]) return # figure the instance home if len(args) > 0: instance_home = args[0] else: instance_home = os.environ.get('ROUNDUP_INSTANCE', '') if not (instance_home and os.path.isdir(instance_home)): return usage(argv) # get the instance import roundup.instance instance = roundup.instance.open(instance_home) # get a mail handler db = instance.open('admin') # now wrap in try/finally so we always close the database try: if hasattr(instance, 'MailGW'): handler = instance.MailGW(instance, db, optionsList) else: handler = mailgw.MailGW(instance, db, optionsList) # if there's no more arguments, read a single message from stdin if len(args) == 1: return handler.do_pipe() # otherwise, figure what sort of mail source to handle if len(args) < 3: return usage(argv, _('Error: not enough source specification information')) source, specification = args[1:3] # time out net connections after a minute if we can if source not in ('mailbox', 'imaps'): if hasattr(socket, 'setdefaulttimeout'): socket.setdefaulttimeout(60) if source == 'mailbox': return handler.do_mailbox(specification) elif source == 'pop': m = re.match(r'((?P[^:]+)(:(?P.+))?@)?(?P.+)', specification) if m: return handler.do_pop(m.group('server'), m.group('user'), m.group('pass')) return usage(argv, _('Error: pop specification not valid')) elif source == 'apop': m = re.match(r'((?P[^:]+)(:(?P.+))?@)?(?P.+)', specification) if m: return handler.do_apop(m.group('server'), m.group('user'), m.group('pass')) return usage(argv, _('Error: apop specification not valid')) elif source == 'imap' or source == 'imaps': m = re.match(r'((?P[^:]+)(:(?P.+))?@)?(?P.+)', specification) if m: ssl = 0 if source == 'imaps': ssl = 1 mailbox = '' if len(args) > 3: mailbox = args[3] return handler.do_imap(m.group('server'), m.group('user'), m.group('pass'), mailbox, ssl) return usage(argv, _('Error: The source must be either "mailbox",' ' "pop", "apop", "imap" or "imaps"')) finally: # handler might have closed the initial db and opened a new one handler.db.close() def run(): sys.exit(main(sys.argv)) # call main if __name__ == '__main__': run() # vim: set filetype=python ts=4 sw=4 et si code-4efa50393b2d/roundup/scripts/roundup_server.py0000644000000000000000000007026410525056216020561 0ustar 00000000000000# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/) # This module is free software, and you may redistribute it and/or modify # under the same terms as Python, so long as this copyright message and # disclaimer are retained in their original form. # # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # """Command-line script that runs a server over roundup.cgi.client. $Id: roundup_server.py,v 1.85 2006-11-09 00:36:21 richard Exp $ """ __docformat__ = 'restructuredtext' import errno, cgi, getopt, os, socket, sys, traceback, urllib, time import ConfigParser, BaseHTTPServer, SocketServer, StringIO # python version check from roundup import configuration, version_check from roundup import __version__ as roundup_version # Roundup modules of use here from roundup.cgi import cgitb, client import roundup.instance from roundup.i18n import _ # "default" favicon.ico # generate by using "icotool" and tools/base64 import zlib, base64 favico = zlib.decompress(base64.decodestring(''' eJztjr1PmlEUh59XgVoshdYPWorFIhaRFq0t9pNq37b60lYSTRzcTFw6GAfj5gDYaF0dTB0MxMSE gQQd3FzKJiEC0UCIUUN1M41pV2JCXySg/0ITn5tfzvmdc+85FwT56HSc81UJjXJsk1UsNcsSqCk1 BS64lK+vr7OyssLJyQl2ux2j0cjU1BQajYZIJEIwGMRms+H3+zEYDExOTjI2Nsbm5iZWqxWv18vW 1hZDQ0Ok02kmJiY4Ojpienqa3d1dxsfHUSqVeDwe5ufnyeVyrK6u4nK5ODs7Y3FxEYfDwdzcHCaT icPDQ5LJJIIgMDIyQj6fZ39/n+3tbdbW1pAkiYWFBWZmZtjb2yMejzM8PEwgEMDn85HNZonFYqjV asLhMMvLy2QyGfR6PaOjowwODmKxWDg+PkalUhEKhSgUCiwtLWE2m9nZ2UGhULCxscHp6SmpVIpo NMrs7CwHBwdotVoSiQRXXPG/IzY7RHtt922xjFRb01H1XhKfPBNbi/7my7rrLXJ88eppvxwEfV3f NY3Y6exofVdsV3+2wnPFDdPjB83n7xuVpcFvygPbGwxF31LZIKrQDfR2Xvh7lmrX654L/7bvlnng bn3Zuj8M9Hepux6VfZtW1yA6K7cfGqVu8TL325u+fHTb71QKbk+7TZQ+lTc6RcnpqW8qmVQBoj/g 23eo0sr/NIGvB37K+lOWXMvJ+uWFeKGU/03Cb7n3D4M3wxI= '''.strip())) DEFAULT_PORT = 8080 # See what types of multiprocess server are available # Note: the order is important. Preferred multiprocess type # is the last element of this list. # "debug" means "none" + no tracker/template cache MULTIPROCESS_TYPES = ["debug", "none"] try: import thread except ImportError: pass else: MULTIPROCESS_TYPES.append("thread") if hasattr(os, 'fork'): MULTIPROCESS_TYPES.append("fork") DEFAULT_MULTIPROCESS = MULTIPROCESS_TYPES[-1] class RoundupRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler): TRACKER_HOMES = {} TRACKERS = None LOG_IPADDRESS = 1 DEBUG_MODE = False CONFIG = None def get_tracker(self, name): """Return a tracker instance for given tracker name""" # Note: try/except KeyError works faster that has_key() check # if the key is usually found in the dictionary # # Return cached tracker instance if we have a tracker cache if self.TRACKERS: try: return self.TRACKERS[name] except KeyError: pass # No cached tracker. Look for home path. try: tracker_home = self.TRACKER_HOMES[name] except KeyError: raise client.NotFound # open the instance tracker = roundup.instance.open(tracker_home) # and cache it if we have a tracker cache if self.TRACKERS: self.TRACKERS[name] = tracker return tracker def run_cgi(self): """ Execute the CGI command. Wrap an innner call in an error handler so all errors can be caught. """ save_stdin = sys.stdin sys.stdin = self.rfile try: self.inner_run_cgi() except client.NotFound: self.send_error(404, self.path) except client.Unauthorised, message: self.send_error(403, '%s (%s)'%(self.path, message)) except: exc, val, tb = sys.exc_info() if hasattr(socket, 'timeout') and isinstance(val, socket.timeout): self.log_error('timeout') else: # it'd be nice to be able to detect if these are going to have # any effect... self.send_response(400) self.send_header('Content-Type', 'text/html') self.end_headers() if self.DEBUG_MODE: try: reload(cgitb) self.wfile.write(cgitb.breaker()) self.wfile.write(cgitb.html()) except: s = StringIO.StringIO() traceback.print_exc(None, s) self.wfile.write("
")
                        self.wfile.write(cgi.escape(s.getvalue()))
                        self.wfile.write("
\n") else: # user feedback self.wfile.write(cgitb.breaker()) ts = time.ctime() self.wfile.write('''

%s: An error occurred. Please check the server log for more infomation.

'''%ts) # out to the logfile print 'EXCEPTION AT', ts traceback.print_exc() sys.stdin = save_stdin do_GET = do_POST = do_HEAD = run_cgi def index(self): ''' Print up an index of the available trackers ''' keys = self.TRACKER_HOMES.keys() if len(keys) == 1: self.send_response(302) self.send_header('Location', urllib.quote(keys[0]) + '/index') else: self.send_response(200) self.send_header('Content-Type', 'text/html') self.end_headers() w = self.wfile.write w(_('Roundup trackers index\n' '

Roundup trackers index

    \n')) keys.sort() for tracker in keys: w('
  1. %(tracker_name)s\n'%{ 'tracker_url': urllib.quote(tracker), 'tracker_name': cgi.escape(tracker)}) w('
') def inner_run_cgi(self): ''' This is the inner part of the CGI handling ''' rest = self.path # file-like object for the favicon.ico file information favicon_fileobj = None if rest == '/favicon.ico': # check to see if a custom favicon was specified, and set # favicon_fileobj to the input file if self.CONFIG is not None: favicon_filepath = os.path.abspath(self.CONFIG['FAVICON']) if os.access(favicon_filepath, os.R_OK): favicon_fileobj = open(favicon_filepath, 'rb') if favicon_fileobj is None: favicon_fileobj = StringIO.StringIO(favico) self.send_response(200) self.send_header('Content-Type', 'image/x-icon') self.end_headers() # this bufsize is completely arbitrary, I picked 4K because it sounded good. # if someone knows of a better buffer size, feel free to plug it in. bufsize = 4 * 1024 Processing = True while Processing: data = favicon_fileobj.read(bufsize) if len(data) > 0: self.wfile.write(data) else: Processing = False favicon_fileobj.close() return i = rest.rfind('?') if i >= 0: rest, query = rest[:i], rest[i+1:] else: query = '' # no tracker - spit out the index if rest == '/': self.index() return # figure the tracker l_path = rest.split('/') tracker_name = urllib.unquote(l_path[1]) # handle missing trailing '/' if len(l_path) == 2: self.send_response(301) # redirect - XXX https?? protocol = 'http' url = '%s://%s%s/'%(protocol, self.headers['host'], self.path) self.send_header('Location', url) self.end_headers() self.wfile.write('Moved Permanently') return # figure out what the rest of the path is if len(l_path) > 2: rest = '/'.join(l_path[2:]) else: rest = '/' # Set up the CGI environment env = {} env['TRACKER_NAME'] = tracker_name env['REQUEST_METHOD'] = self.command env['PATH_INFO'] = urllib.unquote(rest) if query: env['QUERY_STRING'] = query if self.headers.typeheader is None: env['CONTENT_TYPE'] = self.headers.type else: env['CONTENT_TYPE'] = self.headers.typeheader length = self.headers.getheader('content-length') if length: env['CONTENT_LENGTH'] = length co = filter(None, self.headers.getheaders('cookie')) if co: env['HTTP_COOKIE'] = ', '.join(co) env['HTTP_AUTHORIZATION'] = self.headers.getheader('authorization') env['SCRIPT_NAME'] = '' env['SERVER_NAME'] = self.server.server_name env['SERVER_PORT'] = str(self.server.server_port) env['HTTP_HOST'] = self.headers['host'] if os.environ.has_key('CGI_SHOW_TIMING'): env['CGI_SHOW_TIMING'] = os.environ['CGI_SHOW_TIMING'] env['HTTP_ACCEPT_LANGUAGE'] = self.headers.get('accept-language') # do the roundup thing tracker = self.get_tracker(tracker_name) tracker.Client(tracker, self, env).main() def address_string(self): if self.LOG_IPADDRESS: return self.client_address[0] else: host, port = self.client_address return socket.getfqdn(host) def log_message(self, format, *args): ''' Try to *safely* log to stderr. ''' try: BaseHTTPServer.BaseHTTPRequestHandler.log_message(self, format, *args) except IOError: # stderr is no longer viable pass def start_response(self, headers, response): self.send_response(response) for key, value in headers: self.send_header(key, value) self.end_headers() def error(): exc_type, exc_value = sys.exc_info()[:2] return _('Error: %s: %s' % (exc_type, exc_value)) def setgid(group): if group is None: return if not hasattr(os, 'setgid'): return # if root, setgid to the running user if os.getuid(): print _('WARNING: ignoring "-g" argument, not root') return try: import grp except ImportError: raise ValueError, _("Can't change groups - no grp module") try: try: gid = int(group) except ValueError: gid = grp.getgrnam(group)[2] else: grp.getgrgid(gid) except KeyError: raise ValueError,_("Group %(group)s doesn't exist")%locals() os.setgid(gid) def setuid(user): if not hasattr(os, 'getuid'): return # People can remove this check if they're really determined if user is None: if os.getuid(): return raise ValueError, _("Can't run as root!") if os.getuid(): print _('WARNING: ignoring "-u" argument, not root') return try: import pwd except ImportError: raise ValueError, _("Can't change users - no pwd module") try: try: uid = int(user) except ValueError: uid = pwd.getpwnam(user)[2] else: pwd.getpwuid(uid) except KeyError: raise ValueError, _("User %(user)s doesn't exist")%locals() os.setuid(uid) class TrackerHomeOption(configuration.FilePathOption): # Tracker homes do not need any description strings def format(self): return "%(name)s = %(value)s\n" % { "name": self.setting, "value": self.value2str(self._value), } class ServerConfig(configuration.Config): SETTINGS = ( ("main", ( (configuration.Option, "host", "", "Host name of the Roundup web server instance.\n" "If empty, listen on all network interfaces."), (configuration.IntegerNumberOption, "port", DEFAULT_PORT, "Port to listen on."), (configuration.NullableFilePathOption, "favicon", "favicon.ico", "Path to favicon.ico image file." " If unset, built-in favicon.ico is used."), (configuration.NullableOption, "user", "", "User ID as which the server will answer requests.\n" "In order to use this option, " "the server must be run initially as root.\n" "Availability: Unix."), (configuration.NullableOption, "group", "", "Group ID as which the server will answer requests.\n" "In order to use this option, " "the server must be run initially as root.\n" "Availability: Unix."), (configuration.BooleanOption, "log_hostnames", "no", "Log client machine names instead of IP addresses " "(much slower)"), (configuration.NullableFilePathOption, "pidfile", "", "File to which the server records " "the process id of the daemon.\n" "If this option is not set, " "the server will run in foreground\n"), (configuration.NullableFilePathOption, "logfile", "", "Log file path. If unset, log to stderr."), (configuration.Option, "multiprocess", DEFAULT_MULTIPROCESS, "Set processing of each request in separate subprocess.\n" "Allowed values: %s." % ", ".join(MULTIPROCESS_TYPES)), )), ("trackers", (), "Roundup trackers to serve.\n" "Each option in this section defines single Roundup tracker.\n" "Option name identifies the tracker and will appear in the URL.\n" "Option value is tracker home directory path.\n" "The path may be either absolute or relative\n" "to the directory containig this config file."), ) # options recognized by config OPTIONS = { "host": "n:", "port": "p:", "group": "g:", "user": "u:", "logfile": "l:", "pidfile": "d:", "log_hostnames": "N", "multiprocess": "t:", } def __init__(self, config_file=None): configuration.Config.__init__(self, config_file, self.SETTINGS) self.sections.append("trackers") def _adjust_options(self, config): """Add options for tracker homes""" # return early if there are no tracker definitions. # trackers must be specified on the command line. if not config.has_section("trackers"): return # config defaults appear in all sections. # filter them out. defaults = config.defaults().keys() for name in config.options("trackers"): if name not in defaults: self.add_option(TrackerHomeOption(self, "trackers", name)) def getopt(self, args, short_options="", long_options=(), config_load_options=("C", "config"), **options ): options.update(self.OPTIONS) return configuration.Config.getopt(self, args, short_options, long_options, config_load_options, **options) def _get_name(self): return "Roundup server" def trackers(self): """Return tracker definitions as a list of (name, home) pairs""" trackers = [] for option in self._get_section_options("trackers"): trackers.append((option, os.path.abspath( self["TRACKERS_" + option.upper()]))) return trackers def set_logging(self): """Initialise logging to the configured file, if any.""" # appending, unbuffered sys.stdout = sys.stderr = open(self["LOGFILE"], 'a', 0) def get_server(self): """Return HTTP server object to run""" # we don't want the cgi module interpreting the command-line args ;) sys.argv = sys.argv[:1] # preload all trackers unless we are in "debug" mode tracker_homes = self.trackers() if self["MULTIPROCESS"] == "debug": trackers = None else: trackers = dict([(name, roundup.instance.open(home, optimize=1)) for (name, home) in tracker_homes]) # build customized request handler class class RequestHandler(RoundupRequestHandler): LOG_IPADDRESS = not self["LOG_HOSTNAMES"] TRACKER_HOMES = dict(tracker_homes) TRACKERS = trackers DEBUG_MODE = self["MULTIPROCESS"] == "debug" CONFIG = self # obtain request server class if self["MULTIPROCESS"] not in MULTIPROCESS_TYPES: print _("Multiprocess mode \"%s\" is not available, " "switching to single-process") % self["MULTIPROCESS"] self["MULTIPROCESS"] = "none" server_class = BaseHTTPServer.HTTPServer elif self["MULTIPROCESS"] == "fork": class ForkingServer(SocketServer.ForkingMixIn, BaseHTTPServer.HTTPServer): pass server_class = ForkingServer elif self["MULTIPROCESS"] == "thread": class ThreadingServer(SocketServer.ThreadingMixIn, BaseHTTPServer.HTTPServer): pass server_class = ThreadingServer else: server_class = BaseHTTPServer.HTTPServer # obtain server before changing user id - allows to # use port < 1024 if started as root try: httpd = server_class((self["HOST"], self["PORT"]), RequestHandler) except socket.error, e: if e[0] == errno.EADDRINUSE: raise socket.error, \ _("Unable to bind to port %s, port already in use.") \ % self["PORT"] raise # change user and/or group setgid(self["GROUP"]) setuid(self["USER"]) # return the server return httpd try: import win32serviceutil except: RoundupService = None else: # allow the win32 import win32service class SvcShutdown(Exception): pass class RoundupService(win32serviceutil.ServiceFramework): _svc_name_ = "roundup" _svc_display_name_ = "Roundup Bug Tracker" running = 0 server = None def SvcDoRun(self): import servicemanager self.ReportServiceStatus(win32service.SERVICE_START_PENDING) config = ServerConfig() (optlist, args) = config.getopt(sys.argv[1:]) if not config["LOGFILE"]: servicemanager.LogMsg(servicemanager.EVENTLOG_ERROR_TYPE, servicemanager.PYS_SERVICE_STOPPED, (self._svc_display_name_, "\r\nMissing logfile option")) self.ReportServiceStatus(win32service.SERVICE_STOPPED) return config.set_logging() self.server = config.get_server() self.running = 1 self.ReportServiceStatus(win32service.SERVICE_RUNNING) servicemanager.LogMsg(servicemanager.EVENTLOG_INFORMATION_TYPE, servicemanager.PYS_SERVICE_STARTED, (self._svc_display_name_, " at %s:%s" % (config["HOST"], config["PORT"]))) while self.running: self.server.handle_request() servicemanager.LogMsg(servicemanager.EVENTLOG_INFORMATION_TYPE, servicemanager.PYS_SERVICE_STOPPED, (self._svc_display_name_, "")) self.ReportServiceStatus(win32service.SERVICE_STOPPED) def SvcStop(self): self.running = 0 # make dummy connection to self to terminate blocking accept() addr = self.server.socket.getsockname() if addr[0] == "0.0.0.0": addr = ("127.0.0.1", addr[1]) sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.connect(addr) sock.close() self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING) def usage(message=''): if RoundupService: os_part = \ ""''' -c Windows Service options. If you want to run the server as a Windows Service, you must use configuration file to specify tracker homes. Logfile option is required to run Roundup Tracker service. Typing "roundup-server -c help" shows Windows Services specifics.''' else: os_part = ""''' -u runs the Roundup web server as this UID -g runs the Roundup web server as this GID -d run the server in the background and write the server's PID to the file indicated by PIDfile. The -l option *must* be specified if -d is used.''' if message: message += '\n' print _('''%(message)sUsage: roundup-server [options] [name=tracker home]* Options: -v print the Roundup version number and exit -h print this text and exit -S create or update configuration file and exit -C use configuration file -n set the host name of the Roundup web server instance -p set the port to listen on (default: %(port)s) -l log to the file indicated by fname instead of stderr/stdout -N log client machine names instead of IP addresses (much slower) -t multiprocess mode (default: %(mp_def)s). Allowed values: %(mp_types)s. %(os_part)s Long options: --version print the Roundup version number and exit --help print this text and exit --save-config create or update configuration file and exit --config use configuration file All settings of the [main] section of the configuration file also may be specified in form --= Examples: roundup-server -S -C /opt/roundup/etc/roundup-server.ini \\ -n localhost -p 8917 -l /var/log/roundup.log \\ support=/var/spool/roundup-trackers/support roundup-server -C /opt/roundup/etc/roundup-server.ini roundup-server support=/var/spool/roundup-trackers/support roundup-server -d /var/run/roundup.pid -l /var/log/roundup.log \\ support=/var/spool/roundup-trackers/support Configuration file format: Roundup Server configuration file has common .ini file format. Configuration file created with 'roundup-server -S' contains detailed explanations for each option. Please see that file for option descriptions. How to use "name=tracker home": These arguments set the tracker home(s) to use. The name is how the tracker is identified in the URL (it's the first part of the URL path). The tracker home is the directory that was identified when you did "roundup-admin init". You may specify any number of these name=home pairs on the command-line. Make sure the name part doesn't include any url-unsafe characters like spaces, as these confuse IE. ''') % { "message": message, "os_part": os_part, "port": DEFAULT_PORT, "mp_def": DEFAULT_MULTIPROCESS, "mp_types": ", ".join(MULTIPROCESS_TYPES), } def daemonize(pidfile): ''' Turn this process into a daemon. - make sure the sys.std(in|out|err) are completely cut off - make our parent PID 1 Write our new PID to the pidfile. From A.M. Kuuchling (possibly originally Greg Ward) with modification from Oren Tirosh, and finally a small mod from me. ''' # Fork once if os.fork() != 0: os._exit(0) # Create new session os.setsid() # Second fork to force PPID=1 pid = os.fork() if pid: pidfile = open(pidfile, 'w') pidfile.write(str(pid)) pidfile.close() os._exit(0) os.chdir("/") # close off std(in|out|err), redirect to devnull so the file # descriptors can't be used again devnull = os.open('/dev/null', 0) os.dup2(devnull, 0) os.dup2(devnull, 1) os.dup2(devnull, 2) undefined = [] def run(port=undefined, success_message=None): ''' Script entry point - handle args and figure out what to to. ''' # time out after a minute if we can if hasattr(socket, 'setdefaulttimeout'): socket.setdefaulttimeout(60) config = ServerConfig() # additional options short_options = "hvS" if RoundupService: short_options += 'c' try: (optlist, args) = config.getopt(sys.argv[1:], short_options, ("help", "version", "save-config",)) except (getopt.GetoptError, configuration.ConfigurationError), e: usage(str(e)) return # if running in windows service mode, don't do any other stuff if ("-c", "") in optlist: # acquire command line options recognized by service short_options = "cC:" long_options = ["config"] for (long_name, short_name) in config.OPTIONS.items(): short_options += short_name long_name = long_name.lower().replace("_", "-") if short_name[-1] == ":": long_name += "=" long_options.append(long_name) optlist = getopt.getopt(sys.argv[1:], short_options, long_options)[0] svc_args = [] for (opt, arg) in optlist: if opt in ("-C", "-l"): # make sure file name is absolute svc_args.extend((opt, os.path.abspath(arg))) elif opt in ("--config", "--logfile"): # ditto, for long options svc_args.append("=".join(opt, os.path.abspath(arg))) elif opt != "-c": svc_args.extend(opt) RoundupService._exe_args_ = " ".join(svc_args) # pass the control to serviceutil win32serviceutil.HandleCommandLine(RoundupService, argv=sys.argv[:1] + args) return # add tracker names from command line. # this is done early to let '--save-config' handle the trackers. if args: for arg in args: try: name, home = arg.split('=') except ValueError: raise ValueError, _("Instances must be name=home") config.add_option(TrackerHomeOption(config, "trackers", name)) config["TRACKERS_" + name.upper()] = home # handle remaining options if optlist: for (opt, arg) in optlist: if opt in ("-h", "--help"): usage() elif opt in ("-v", "--version"): print '%s (python %s)' % (roundup_version, sys.version.split()[0]) elif opt in ("-S", "--save-config"): config.save() print _("Configuration saved to %s") % config.filepath # any of the above options prevent server from running return # port number in function arguments overrides config and command line if port is not undefined: config.PORT = port if config["LOGFILE"]: config["LOGFILE"] = os.path.abspath(config["LOGFILE"]) # switch logging from stderr/stdout to logfile config.set_logging() if config["PIDFILE"]: config["PIDFILE"] = os.path.abspath(config["PIDFILE"]) # fork the server from our parent if a pidfile is specified if config["PIDFILE"]: if not hasattr(os, 'fork'): print _("Sorry, you can't run the server as a daemon" " on this Operating System") sys.exit(0) else: daemonize(config["PIDFILE"]) # create the server httpd = config.get_server() if success_message: print success_message else: print _('Roundup server started on %(HOST)s:%(PORT)s') \ % config try: httpd.serve_forever() except KeyboardInterrupt: print 'Keyboard Interrupt: exiting' if __name__ == '__main__': run() # vim: set filetype=python sts=4 sw=4 et si :