Menu
▾
▴
[677ee7]: / roundup-admin Maximize Restore History
846 lines (761 with data), 31.2 kB
#! /usr/bin/env python
#
# 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,v 1.37 2001-10-23 01:00:18 richard Exp $
import sys
if int(sys.version[0]) < 2:
print 'Roundup requires python 2.0 or later.'
sys.exit(1)
import string, os, getpass, getopt, re
try:
import csv
except ImportError:
csv = None
from roundup import date, hyperdb, roundupdb, init, password
import roundup.instance
class AdminTool:
def __init__(self):
self.commands = {}
for k in AdminTool.__dict__.keys():
if k[:3] == 'do_':
self.commands[k[3:]] = getattr(self, k)
self.help = {}
for k in AdminTool.__dict__.keys():
if k[:5] == 'help_':
self.help[k[5:]] = getattr(self, k)
def usage(message=''):
if message: message = 'Problem: '+message+'\n'
print '''%sUsage: roundup-admin [-i instance home] [-u login] [-c] <command> <arguments>
Help:
roundup-admin -h
roundup-admin help -- this help
roundup-admin help <command> -- command-specific help
roundup-admin help all -- all available help
Options:
-i instance home -- specify the issue tracker "home directory" to administer
-u -- the user[:password] to use for commands
-c -- when outputting lists of data, just comma-separate them'''%message
self.help_commands()
def help_commands(self):
print 'Commands:',
commands = ['']
for command in self.commands.values():
h = command.__doc__.split('\n')[0]
commands.append(h[7:])
commands.sort()
print '\n '.join(commands)
def help_all(self):
print '''
All commands (except help) require an instance specifier. This is just the path
to the roundup instance you're working with. A roundup instance is where
roundup keeps the database and configuration file that defines an issue
tracker. It may be thought of as the issue tracker's "home directory". It may
be specified in the environment variable ROUNDUP_INSTANCE or on the command
line as "-i instance".
A designator is a classname and a nodeid concatenated, eg. bug1, user10, ...
Property values are represented as strings in command arguments and in the
printed results:
. Strings are, well, strings.
. Date values are printed in the full date format in the local time zone, and
accepted in the full format or any of the partial formats explained below.
. Link values are printed as node designators. When given as an argument,
node designators and key strings are both accepted.
. Multilink values are printed as lists of node designators joined by commas.
When given as an argument, node designators and key strings are both
accepted; an empty string, a single node, or a list of nodes joined by
commas is accepted.
When multiple nodes are specified to the roundup get or roundup set
commands, the specified properties are retrieved or set on all the listed
nodes.
When multiple results are returned by the roundup get or roundup find
commands, they are printed one per line (default) or joined by commas (with
the -c) option.
Where the command changes data, a login name/password is required. The
login may be specified as either "name" or "name:password".
. ROUNDUP_LOGIN environment variable
. the -u command-line option
If either the name or password is not supplied, they are obtained from the
command-line.
Date format examples:
"2000-04-17.03:45" means <Date 2000-04-17.08:45:00>
"2000-04-17" means <Date 2000-04-17.00:00:00>
"01-25" means <Date yyyy-01-25.00:00:00>
"08-13.22:13" means <Date yyyy-08-14.03:13:00>
"11-07.09:32:43" means <Date yyyy-11-07.14:32:43>
"14:25" means <Date yyyy-mm-dd.19:25:00>
"8:47:11" means <Date yyyy-mm-dd.13:47:11>
"." means "right now"
Command help:
'''
for name, command in self.commands.items():
print '%s:'%name
print ' ',command.__doc__
def do_help(self, args, nl_re=re.compile('[\r\n]'),
indent_re=re.compile(r'^(\s+)\S+')):
'''Usage: help topic
Give help about topic.
commands -- list commands
<command> -- help specific to a command
initopts -- init command options
all -- all available help
'''
help = self.help.get(args[0], None)
if help:
help()
return
help = self.commands.get(args[0], None)
if help:
# display the help, removing the docsring indent
lines = nl_re.split(help.__doc__)
print lines[0]
indent = indent_re.match(lines[1])
if indent: indent = len(indent.group(1))
for line in lines[1:]:
if indent:
print line[indent:]
else:
print line
else:
print 'Sorry, no help for "%s"'%args[0]
def help_initopts(self):
import roundup.templates
templates = roundup.templates.listTemplates()
print 'Templates:', ', '.join(templates)
import roundup.backends
backends = roundup.backends.__all__
print 'Back ends:', ', '.join(backends)
def do_init(self, instance_home, args):
'''Usage: init [template [backend [admin password]]]
Initialise a new Roundup instance.
The command will prompt for the instance home directory (if not supplied
through INSTANCE_HOME or the -i option. The template, backend and admin
password may be specified on the command-line as arguments, in that
order.
See also initopts help.
'''
# select template
import roundup.templates
templates = roundup.templates.listTemplates()
template = len(args) > 1 and args[1] or ''
if template not in templates:
print 'Templates:', ', '.join(templates)
while template not in templates:
template = raw_input('Select template [extended]: ').strip()
if not template:
template = 'extended'
import roundup.backends
backends = roundup.backends.__all__
backend = len(args) > 2 and args[2] or ''
if backend not in backends:
print 'Back ends:', ', '.join(backends)
while backend not in backends:
backend = raw_input('Select backend [anydbm]: ').strip()
if not backend:
backend = 'anydbm'
if len(args) > 3:
adminpw = confirm = args[3]
else:
adminpw = ''
confirm = 'x'
while adminpw != confirm:
adminpw = getpass.getpass('Admin Password: ')
confirm = getpass.getpass(' Confirm: ')
init.init(instance_home, template, backend, adminpw)
return 0
def do_get(self, args):
'''Usage: get property designator[,designator]*
Get the given property of one or more designator(s).
Retrieves the property value of the nodes specified by the designators.
'''
propname = args[0]
designators = string.split(args[1], ',')
l = []
for designator in designators:
try:
classname, nodeid = roundupdb.splitDesignator(designator)
except roundupdb.DesignatorError, message:
print 'Error: %s'%message
return 1
if self.comma_sep:
l.append(self.db.getclass(classname).get(nodeid, propname))
else:
print self.db.getclass(classname).get(nodeid, propname)
if self.comma_sep:
print ','.join(l)
return 0
def do_set(self, args):
'''Usage: set designator[,designator]* propname=value ...
Set the given property of one or more designator(s).
Sets the property to the value for all designators given.
'''
from roundup import hyperdb
designators = string.split(args[0], ',')
props = {}
for prop in args[1:]:
key, value = prop.split('=')
props[key] = value
for designator in designators:
try:
classname, nodeid = roundupdb.splitDesignator(designator)
except roundupdb.DesignatorError, message:
print 'Error: %s'%message
return 1
cl = self.db.getclass(classname)
properties = cl.getprops()
for key, value in props.items():
type = properties[key]
if isinstance(type, hyperdb.String):
continue
elif isinstance(type, hyperdb.Password):
props[key] = password.Password(value)
elif isinstance(type, hyperdb.Date):
props[key] = date.Date(value)
elif isinstance(type, hyperdb.Interval):
props[key] = date.Interval(value)
elif isinstance(type, hyperdb.Link):
props[key] = value
elif isinstance(type, hyperdb.Multilink):
props[key] = value.split(',')
apply(cl.set, (nodeid, ), props)
return 0
def do_find(self, args):
'''Usage: find classname propname=value ...
Find the nodes of the given class with a given link property value.
Find the nodes of the given class with a given link property value. The
value may be either the nodeid of the linked node, or its key value.
'''
classname = args[0]
cl = self.db.getclass(classname)
# look up the linked-to class and get the nodeid that has the value
propname, value = args[1].split('=')
num_re = re.compile('^\d+$')
if not num_re.match(value):
propcl = cl.properties[propname]
if (not isinstance(propcl, hyperdb.Link) and not
isinstance(type, hyperdb.Multilink)):
print 'You may only "find" link properties'
return 1
propcl = self.db.getclass(propcl.classname)
value = propcl.lookup(value)
# now do the find
if self.comma_sep:
print ','.join(cl.find(**{propname: value}))
else:
print cl.find(**{propname: value})
return 0
def do_spec(self, args):
'''Usage: spec classname
Show the properties for a classname.
This lists the properties for a given class.
'''
classname = args[0]
cl = self.db.getclass(classname)
keyprop = cl.getkey()
for key, value in cl.properties.items():
if keyprop == key:
print '%s: %s (key property)'%(key, value)
else:
print '%s: %s'%(key, value)
def do_create(self, args):
'''Usage: create classname property=value ...
Create a new entry of a given class.
This creates a new entry of the given class using the property
name=value arguments provided on the command line after the "create"
command.
'''
from roundup import hyperdb
classname = args[0]
cl = self.db.getclass(classname)
props = {}
properties = cl.getprops(protected = 0)
if len(args) == 1:
# ask for the properties
for key, value in properties.items():
if key == 'id': continue
name = value.__class__.__name__
if isinstance(value , hyperdb.Password):
again = None
while value != again:
value = getpass.getpass('%s (Password): '%key.capitalize())
again = getpass.getpass(' %s (Again): '%key.capitalize())
if value != again: print 'Sorry, try again...'
if value:
props[key] = value
else:
value = raw_input('%s (%s): '%(key.capitalize(), name))
if value:
props[key] = value
else:
# use the args
for prop in args[1:]:
key, value = prop.split('=')
props[key] = value
# convert types
for key in props.keys():
type = properties[key]
if isinstance(type, hyperdb.Date):
props[key] = date.Date(value)
elif isinstance(type, hyperdb.Interval):
props[key] = date.Interval(value)
elif isinstance(type, hyperdb.Password):
props[key] = password.Password(value)
elif isinstance(type, hyperdb.Multilink):
props[key] = value.split(',')
if cl.getkey() and not props.has_key(cl.getkey()):
print "You must provide the '%s' property."%cl.getkey()
else:
print apply(cl.create, (), props)
return 0
def do_list(self, args):
'''Usage: list classname [property]
List the instances of a class.
Lists all instances of the given class. If the property is not
specified, the "label" property is used. The label property is tried
in order: the key, "name", "title" and then the first property,
alphabetically.
'''
classname = args[0]
cl = self.db.getclass(classname)
if len(args) > 1:
key = args[1]
else:
key = cl.labelprop()
if self.comma_sep:
print ','.join(cl.list())
else:
for nodeid in cl.list():
value = cl.get(nodeid, key)
print "%4s: %s"%(nodeid, value)
return 0
def do_table(self, args):
'''Usage: table classname [property[,property]*]
List the instances of a class in tabular form.
Lists all instances of the given class. If the properties are not
specified, all properties are displayed. By default, the column widths
are the width of the property names. The width may be explicitly defined
by defining the property as "name:width". For example::
roundup> table priority id,name:10
Id Name
1 fatal-bug
2 bug
3 usability
4 feature
'''
classname = args[0]
cl = self.db.getclass(classname)
if len(args) > 1:
prop_names = args[1].split(',')
else:
prop_names = cl.getprops().keys()
props = []
for name in prop_names:
if ':' in name:
name, width = name.split(':')
props.append((name, int(width)))
else:
props.append((name, len(name)))
print ' '.join([string.capitalize(name) for name, width in props])
for nodeid in cl.list():
l = []
for name, width in props:
if name != 'id':
value = str(cl.get(nodeid, name))
else:
value = str(nodeid)
f = '%%-%ds'%width
l.append(f%value[:width])
print ' '.join(l)
return 0
def do_history(self, args):
'''Usage: history designator
Show the history entries of a designator.
Lists the journal entries for the node identified by the designator.
'''
try:
classname, nodeid = roundupdb.splitDesignator(args[0])
except roundupdb.DesignatorError, message:
print 'Error: %s'%message
return 1
# TODO: handle the -c option?
print self.db.getclass(classname).history(nodeid)
return 0
def do_retire(self, args):
'''Usage: retire designator[,designator]*
Retire the node specified by designator.
This action indicates that a particular node is not to be retrieved by
the list or find commands, and its key value may be re-used.
'''
designators = string.split(args[0], ',')
for designator in designators:
try:
classname, nodeid = roundupdb.splitDesignator(designator)
except roundupdb.DesignatorError, message:
print 'Error: %s'%message
return 1
self.db.getclass(classname).retire(nodeid)
return 0
def do_export(self, args):
'''Usage: export class[,class] destination_dir
Export the database to tab-separated-value files.
This action exports the current data from the database into
tab-separated-value files that are placed in the nominated destination
directory. The journals are not exported.
'''
if len(args) < 2:
print do_export.__doc__
return 1
classes = string.split(args[0], ',')
dir = args[1]
# use the csv parser if we can - it's faster
if csv is not None:
p = csv.parser(field_sep=':')
# do all the classes specified
for classname in classes:
cl = self.db.getclass(classname)
f = open(os.path.join(dir, classname+'.csv'), 'w')
f.write(string.join(cl.properties.keys(), ':') + '\n')
# all nodes for this class
properties = cl.properties.items()
for nodeid in cl.list():
l = []
for prop, type in properties:
value = cl.get(nodeid, prop)
# convert data where needed
if isinstance(type, hyperdb.Date):
value = value.get_tuple()
elif isinstance(type, hyperdb.Interval):
value = value.get_tuple()
elif isinstance(type, hyperdb.Password):
value = str(value)
l.append(repr(value))
# now write
if csv is not None:
f.write(p.join(l) + '\n')
else:
# escape the individual entries to they're valid CSV
m = []
for entry in l:
if '"' in entry:
entry = '""'.join(entry.split('"'))
if ':' in entry:
entry = '"%s"'%entry
m.append(entry)
f.write(':'.join(m) + '\n')
return 0
def do_import(self, args):
'''Usage: import class file
Import the contents of the tab-separated-value file.
The file must define the same properties as the class (including having
a "header" line with those property names.) The new nodes are added to
the existing database - if you want to create a new database using the
imported data, then create a new database (or, tediously, retire all
the old data.)
'''
if len(args) < 2:
print do_import.__doc__
return 1
if csv is None:
print 'Sorry, you need the csv module to use this function.'
print 'Get it from: http://www.object-craft.com.au/projects/csv/'
return 1
from roundup import hyperdb
# ensure that the properties and the CSV file headings match
cl = self.db.getclass(args[0])
f = open(args[1])
p = csv.parser(field_sep=':')
file_props = p.parse(f.readline())
props = cl.properties.keys()
m = file_props[:]
m.sort()
props.sort()
if m != props:
print 'Import file doesn\'t define the same properties as "%s".'%args[0]
return 1
# loop through the file and create a node for each entry
n = range(len(props))
while 1:
line = f.readline()
if not line: break
# parse lines until we get a complete entry
while 1:
l = p.parse(line)
if l: break
# make the new node's property map
d = {}
for i in n:
# Use eval to reverse the repr() used to output the CSV
value = eval(l[i])
# Figure the property for this column
key = file_props[i]
type = cl.properties[key]
# Convert for property type
if isinstance(type, hyperdb.Date):
value = date.Date(value)
elif isinstance(type, hyperdb.Interval):
value = date.Interval(value)
elif isinstance(type, hyperdb.Password):
pwd = password.Password()
pwd.unpack(value)
value = pwd
if value is not None:
d[key] = value
# and create the new node
apply(cl.create, (), d)
return 0
def run_command(self, args):
'''Run a single command
'''
command = args[0]
# handle help now
if command == 'help':
if len(args)>1:
self.do_help(args[1:])
return 0
self.do_help(['help'])
return 0
if command == 'morehelp':
self.do_help(['help'])
self.help_commands()
self.help_all()
return 0
# make sure we have an instance_home
while not self.instance_home:
self.instance_home = raw_input('Enter instance home: ').strip()
# before we open the db, we may be doing an init
if command == 'init':
return self.do_init(self.instance_home, args)
function = self.commands.get(command, None)
# not a valid command
if function is None:
print 'Unknown command "%s" ("help commands" for a list)'%command
return 1
# get the instance
instance = roundup.instance.open(self.instance_home)
self.db = instance.open('admin')
if len(args) < 2:
print function.__doc__
return 1
# do the command
try:
return function(args[1:])
finally:
self.db.close()
return 1
def interactive(self, ws_re=re.compile(r'\s+')):
'''Run in an interactive mode
'''
print 'Roundup {version} ready for input.'
print 'Type "help" for help.'
try:
import readline
except ImportError:
print "Note: command history and editing not available"
while 1:
try:
command = raw_input('roundup> ')
except EOFError:
print '.. exit'
return 0
args = ws_re.split(command)
if not args: continue
if args[0] in ('quit', 'exit'): return 0
self.run_command(args)
def main(self):
opts, args = getopt.getopt(sys.argv[1:], 'i:u:hc')
# handle command-line args
self.instance_home = os.environ.get('ROUNDUP_INSTANCE', '')
name = password = ''
if os.environ.has_key('ROUNDUP_LOGIN'):
l = os.environ['ROUNDUP_LOGIN'].split(':')
name = l[0]
if len(l) > 1:
password = l[1]
self.comma_sep = 0
for opt, arg in opts:
if opt == '-h':
usage()
return 0
if opt == '-i':
self.instance_home = arg
if opt == '-c':
self.comma_sep = 1
# if no command - go interactive
if not args:
return self.interactive()
self.run_command(args)
if __name__ == '__main__':
tool = AdminTool()
sys.exit(tool.main())
#
# $Log: not supported by cvs2svn $
# Revision 1.36 2001/10/21 00:45:15 richard
# Added author identification to e-mail messages from roundup.
#
# Revision 1.35 2001/10/20 11:58:48 richard
# Catch errors in login - no username or password supplied.
# Fixed editing of password (Password property type) thanks Roch'e Compaan.
#
# Revision 1.34 2001/10/18 02:16:42 richard
# Oops, committed the admin script with the wierd #! line.
# Also, made the thing into a class to reduce parameter passing.
# Nuked the leading whitespace from the help __doc__ displays too.
#
# Revision 1.33 2001/10/17 23:13:19 richard
# Did a fair bit of work on the admin tool. Now has an extra command "table"
# which displays node information in a tabular format. Also fixed import and
# export so they work. Removed freshen.
# Fixed quopri usage in mailgw from bug reports.
#
# Revision 1.32 2001/10/17 06:57:29 richard
# Interactive startup blurb - need to figure how to get the version in there.
#
# Revision 1.31 2001/10/17 06:17:26 richard
# Now with readline support :)
#
# Revision 1.30 2001/10/17 06:04:00 richard
# Beginnings of an interactive mode for roundup-admin
#
# Revision 1.29 2001/10/16 03:48:01 richard
# admin tool now complains if a "find" is attempted with a non-link property.
#
# Revision 1.28 2001/10/13 00:07:39 richard
# More help in admin tool.
#
# Revision 1.27 2001/10/11 23:43:04 richard
# Implemented the comma-separated printing option in the admin tool.
# Fixed a typo (more of a vim-o actually :) in mailgw.
#
# Revision 1.26 2001/10/11 05:03:51 richard
# Marked the roundup-admin import/export as experimental since they're not fully
# operational.
#
# Revision 1.25 2001/10/10 04:12:32 richard
# The setup.cfg file is just causing pain. Away it goes.
#
# Revision 1.24 2001/10/10 03:54:57 richard
# Added database importing and exporting through CSV files.
# Uses the csv module from object-craft for exporting if it's available.
# Requires the csv module for importing.
#
# Revision 1.23 2001/10/09 23:36:25 richard
# Spit out command help if roundup-admin command doesn't get an argument.
#
# Revision 1.22 2001/10/09 07:25:59 richard
# Added the Password property type. See "pydoc roundup.password" for
# implementation details. Have updated some of the documentation too.
#
# Revision 1.21 2001/10/05 02:23:24 richard
# . roundup-admin create now prompts for property info if none is supplied
# on the command-line.
# . hyperdb Class getprops() method may now return only the mutable
# properties.
# . Login now uses cookies, which makes it a whole lot more flexible. We can
# now support anonymous user access (read-only, unless there's an
# "anonymous" user, in which case write access is permitted). Login
# handling has been moved into cgi_client.Client.main()
# . The "extended" schema is now the default in roundup init.
# . The schemas have had their page headings modified to cope with the new
# login handling. Existing installations should copy the interfaces.py
# file from the roundup lib directory to their instance home.
# . Incorrectly had a Bizar Software copyright on the cgitb.py module from
# Ping - has been removed.
# . Fixed a whole bunch of places in the CGI interface where we should have
# been returning Not Found instead of throwing an exception.
# . Fixed a deviation from the spec: trying to modify the 'id' property of
# an item now throws an exception.
#
# Revision 1.20 2001/10/04 02:12:42 richard
# Added nicer command-line item adding: passing no arguments will enter an
# interactive more which asks for each property in turn. While I was at it, I
# fixed an implementation problem WRT the spec - I wasn't raising a
# ValueError if the key property was missing from a create(). Also added a
# protected=boolean argument to getprops() so we can list only the mutable
# properties (defaults to yes, which lists the immutables).
#
# Revision 1.19 2001/10/01 06:40:43 richard
# made do_get have the args in the correct order
#
# Revision 1.18 2001/09/18 22:58:37 richard
#
# Added some more help to roundu-admin
#
# Revision 1.17 2001/08/28 05:58:33 anthonybaxter
# added missing 'import' statements.
#
# Revision 1.16 2001/08/12 06:32:36 richard
# using isinstance(blah, Foo) now instead of isFooType
#
# Revision 1.15 2001/08/07 00:24:42 richard
# stupid typo
#
# Revision 1.14 2001/08/07 00:15:51 richard
# Added the copyright/license notice to (nearly) all files at request of
# Bizar Software.
#
# Revision 1.13 2001/08/05 07:44:13 richard
# Instances are now opened by a special function that generates a unique
# module name for the instances on import time.
#
# Revision 1.12 2001/08/03 01:28:33 richard
# Used the much nicer load_package, pointed out by Steve Majewski.
#
# Revision 1.11 2001/08/03 00:59:34 richard
# Instance import now imports the instance using imp.load_module so that
# we can have instance homes of "roundup" or other existing python package
# names.
#
# Revision 1.10 2001/07/30 08:12:17 richard
# Added time logging and file uploading to the templates.
#
# Revision 1.9 2001/07/30 03:52:55 richard
# init help now lists templates and backends
#
# Revision 1.8 2001/07/30 02:37:07 richard
# Freshen is really broken. Commented out.
#
# Revision 1.7 2001/07/30 01:28:46 richard
# Bugfixes
#
# Revision 1.6 2001/07/30 00:57:51 richard
# Now uses getopt, much improved command-line parsing. Much fuller help. Much
# better internal structure. It's just BETTER. :)
#
# Revision 1.5 2001/07/30 00:04:48 richard
# Made the "init" prompting more friendly.
#
# Revision 1.4 2001/07/29 07:01:39 richard
# Added vim command to all source so that we don't get no steenkin' tabs :)
#
# Revision 1.3 2001/07/23 08:45:28 richard
# ok, so now "./roundup-admin init" will ask questions in an attempt to get a
# workable instance_home set up :)
# _and_ anydbm has had its first test :)
#
# Revision 1.2 2001/07/23 08:20:44 richard
# Moved over to using marshal in the bsddb and anydbm backends.
# roundup-admin now has a "freshen" command that'll load/save all nodes (not
# retired - mod hyperdb.Class.list() so it lists retired nodes)
#
# Revision 1.1 2001/07/23 03:46:48 richard
# moving the bin files to facilitate out-of-the-boxness
#
# Revision 1.1 2001/07/22 11:15:45 richard
# More Grande Splite stuff
#
#
# vim: set filetype=python ts=4 sw=4 et si