![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/admin.py b/roundup/admin.py
index ebc22c8cb553d86ab295a2d60be2c891bd2af518..9ae6ba3eb5cb04ea625aeb7076ef262c14e95f81 100644 (file)
--- a/roundup/admin.py
+++ b/roundup/admin.py
# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#
-# $Id: admin.py,v 1.49 2003-03-26 11:02:28 richard Exp $
+# $Id: admin.py,v 1.61 2003-11-13 04:12:10 richard Exp $
'''Administration commands for maintaining Roundup trackers.
'''
-import sys, os, getpass, getopt, re, UserDict, shlex, shutil
-try:
- import csv
-except ImportError:
- csv = None
-from roundup import date, hyperdb, roundupdb, init, password, token
+import sys, os, getpass, getopt, re, UserDict, shutil, rfc822
+from roundup import date, hyperdb, roundupdb, init, password, token, rcsv
from roundup import __version__ as roundup_version
import roundup.instance
from roundup.i18n import _
-u -- the user[:password] to use for commands
-d -- print full designators not just class id numbers
-c -- when outputting lists of data, comma-separate them.
- Same as '-S ","'.
+ Same as '-S ","'.
-S <string> -- when outputting lists of data, string-separate them
-s -- when outputting lists of data, space-separate them.
- Same as '-S " "'.
+ Same as '-S " "'.
Only one of -s, -c or -S can be specified.
print line
return 0
+ def listTemplates(self):
+ ''' List all the available templates.
+
+ Look in the following places, where the later rules take precedence:
+
+ 1. <prefix>/share/roundup/templates/*
+ this should be the standard place to find them when Roundup is
+ installed
+ 2. <roundup.admin.__file__>/../templates/*
+ this will be used if Roundup's run in the distro (aka. source)
+ directory
+ 3. <current working dir>/*
+ this is for when someone unpacks a 3rd-party template
+ 4. <current working dir>
+ this is for someone who "cd"s to the 3rd-party template dir
+ '''
+ # OK, try <prefix>/share/roundup/templates
+ # -- this module (roundup.admin) will be installed in something
+ # like:
+ # /usr/lib/python2.2/site-packages/roundup/admin.py (5 dirs up)
+ # c:\python22\lib\site-packages\roundup\admin.py (4 dirs up)
+ # we're interested in where the "lib" directory is - ie. the /usr/
+ # part
+ templates = {}
+ for N in 4, 5:
+ path = __file__
+ # move up N elements in the path
+ for i in range(N):
+ path = os.path.dirname(path)
+ tdir = os.path.join(path, 'share', 'roundup', 'templates')
+ if os.path.isdir(tdir):
+ templates = init.listTemplates(tdir)
+ break
+
+ # OK, now try as if we're in the roundup source distribution
+ # directory, so this module will be in .../roundup-*/roundup/admin.py
+ # and we're interested in the .../roundup-*/ part.
+ path = __file__
+ for i in range(2):
+ path = os.path.dirname(path)
+ tdir = os.path.join(path, 'templates')
+ if os.path.isdir(tdir):
+ templates.update(init.listTemplates(tdir))
+
+ # Try subdirs of the current dir
+ templates.update(init.listTemplates(os.getcwd()))
+
+ # Finally, try the current directory as a template
+ template = init.loadTemplateInfo(os.getcwd())
+ if template:
+ templates[template['name']] = template
+
+ return templates
+
def help_initopts(self):
- import roundup.templates
- templates = roundup.templates.listTemplates()
- print _('Templates:'), ', '.join(templates)
+ templates = self.listTemplates()
+ print _('Templates:'), ', '.join(templates.keys())
import roundup.backends
backends = roundup.backends.__all__
print _('Back ends:'), ', '.join(backends)
' does not exist')%locals()
# select template
- import roundup.templates
- templates = roundup.templates.listTemplates()
+ templates = self.listTemplates()
template = len(args) > 1 and args[1] or ''
- if template not in templates:
- print _('Templates:'), ', '.join(templates)
- while template not in templates:
+ if not templates.has_key(template):
+ print _('Templates:'), ', '.join(templates.keys())
+ while not templates.has_key(template):
template = raw_input(_('Select template [classic]: ')).strip()
if not template:
template = 'classic'
# XXX perform a unit test based on the user's selections
# install!
- init.install(tracker_home, template)
+ init.install(tracker_home, templates[template]['path'])
init.write_select_db(tracker_home, backend)
print _('''
# get the class
cl = self.get_class(classname)
try:
- id=[]
+ id=[]
if self.separator:
if self.print_designator:
- # see if property is a link or multilink for
- # which getting a desginator make sense.
- # Algorithm: Get the properties of the
- # current designator's class. (cl.getprops)
- # get the property object for the property the
- # user requested (properties[propname])
- # verify its type (isinstance...)
- # raise error if not link/multilink
- # get class name for link/multilink property
- # do the get on the designators
- # append the new designators
- # print
- properties = cl.getprops()
- property = properties[propname]
- if not (isinstance(property, hyperdb.Multilink) or
+ # see if property is a link or multilink for
+ # which getting a desginator make sense.
+ # Algorithm: Get the properties of the
+ # current designator's class. (cl.getprops)
+ # get the property object for the property the
+ # user requested (properties[propname])
+ # verify its type (isinstance...)
+ # raise error if not link/multilink
+ # get class name for link/multilink property
+ # do the get on the designators
+ # append the new designators
+ # print
+ properties = cl.getprops()
+ property = properties[propname]
+ if not (isinstance(property, hyperdb.Multilink) or
isinstance(property, hyperdb.Link)):
raise UsageError, _('property %s is not of type Multilink or Link so -d flag does not apply.')%propname
propclassname = self.db.getclass(property.classname).classname
- id = cl.get(nodeid, propname)
- for i in id:
- l.append(propclassname + i)
- else:
- id = cl.get(nodeid, propname)
+ id = cl.get(nodeid, propname)
for i in id:
- l.append(i)
+ l.append(propclassname + i)
+ else:
+ id = cl.get(nodeid, propname)
+ for i in id:
+ l.append(i)
else:
if self.print_designator:
- properties = cl.getprops()
- property = properties[propname]
- if not (isinstance(property, hyperdb.Multilink) or
+ properties = cl.getprops()
+ property = properties[propname]
+ if not (isinstance(property, hyperdb.Multilink) or
isinstance(property, hyperdb.Link)):
raise UsageError, _('property %s is not of type Multilink or Link so -d flag does not apply.')%propname
propclassname = self.db.getclass(property.classname).classname
- id = cl.get(nodeid, propname)
- for i in id:
+ id = cl.get(nodeid, propname)
+ for i in id:
print propclassname + i
else:
print cl.get(nodeid, propname)
def do_set(self, args, pwre = re.compile(r'{(\w+)}(.+)')):
- '''Usage: set [items] property=value property=value ...
+ '''Usage: set items property=value property=value ...
Set the given properties of one or more items(s).
- The items may be specified as a class or as a comma-separated
+ The items are specified as a class or as a comma-separated
list of item designators (ie "designator[,designator,...]").
This command sets the properties to the values for all designators
properties = cl.getprops()
for key, value in props.items():
- proptype = properties[key]
- if isinstance(proptype, hyperdb.Multilink):
- if value is None:
- props[key] = []
- else:
- props[key] = value.split(',')
- elif value is None:
- continue
- elif isinstance(proptype, hyperdb.String):
- continue
- elif isinstance(proptype, hyperdb.Password):
- m = pwre.match(value)
- if m:
- # password is being given to us encrypted
- p = password.Password()
- p.scheme = m.group(1)
- p.password = m.group(2)
- props[key] = p
- else:
- props[key] = password.Password(value)
- elif isinstance(proptype, hyperdb.Date):
- try:
- props[key] = date.Date(value)
- except ValueError, message:
- raise UsageError, '"%s": %s'%(value, message)
- elif isinstance(proptype, hyperdb.Interval):
- try:
- props[key] = date.Interval(value)
- except ValueError, message:
- raise UsageError, '"%s": %s'%(value, message)
- elif isinstance(proptype, hyperdb.Link):
- props[key] = value
- elif isinstance(proptype, hyperdb.Boolean):
- props[key] = value.lower() in ('yes', 'true', 'on', '1')
- elif isinstance(proptype, hyperdb.Number):
- props[key] = float(value)
+ try:
+ props[key] = hyperdb.rawToHyperdb(self.db, cl, itemid,
+ key, value)
+ except hyperdb.HyperdbValueError, message:
+ raise UsageError, message
# try the set
try:
designator = []
if self.separator:
if self.print_designator:
- id=apply(cl.find, (), props)
- for i in id:
- designator.append(classname + i)
+ id=apply(cl.find, (), props)
+ for i in id:
+ designator.append(classname + i)
print self.separator.join(designator)
else:
- print self.separator.join(apply(cl.find, (), props))
+ print self.separator.join(apply(cl.find, (), props))
else:
if self.print_designator:
- id=apply(cl.find, (), props)
- for i in id:
- designator.append(classname + i)
+ id=apply(cl.find, (), props)
+ for i in id:
+ designator.append(classname + i)
print designator
- else:
- print apply(cl.find, (), props)
+ else:
+ print apply(cl.find, (), props)
except KeyError:
raise UsageError, _('%(classname)s has no property '
'"%(propname)s"')%locals()
raise UsageError, _('Not enough arguments supplied')
# decode the node designator
- for designator in args[0].split(','):
+ for designator in args[0].split(','):
try:
classname, nodeid = hyperdb.splitDesignator(designator)
- except hyperdb.DesignatorError, message:
- raise UsageError, message
+ except hyperdb.DesignatorError, message:
+ raise UsageError, message
- # get the class
- cl = self.get_class(classname)
+ # get the class
+ cl = self.get_class(classname)
- # display the values
- for key in cl.properties.keys():
- value = cl.get(nodeid, key)
- print _('%(key)s: %(value)s')%locals()
+ # display the values
+ keys = cl.properties.keys()
+ keys.sort()
+ for key in keys:
+ value = cl.get(nodeid, key)
+ print _('%(key)s: %(value)s')%locals()
def do_create(self, args, pwre = re.compile(r'{(\w+)}(.+)')):
'''Usage: create classname property=value ...
# convert types
for propname, value in props.items():
- # get the property
try:
- proptype = properties[propname]
- except KeyError:
- raise UsageError, _('%(classname)s has no property '
- '"%(propname)s"')%locals()
-
- if isinstance(proptype, hyperdb.Date):
- try:
- props[propname] = date.Date(value)
- except ValueError, message:
- raise UsageError, _('"%(value)s": %(message)s')%locals()
- elif isinstance(proptype, hyperdb.Interval):
- try:
- props[propname] = date.Interval(value)
- except ValueError, message:
- raise UsageError, _('"%(value)s": %(message)s')%locals()
- elif isinstance(proptype, hyperdb.Password):
- m = pwre.match(value)
- if m:
- # password is being given to us encrypted
- p = password.Password()
- p.scheme = m.group(1)
- p.password = m.group(2)
- props[propname] = p
- else:
- props[propname] = password.Password(value)
- elif isinstance(proptype, hyperdb.Multilink):
- props[propname] = value.split(',')
- elif isinstance(proptype, hyperdb.Boolean):
- props[propname] = value.lower() in ('yes', 'true', 'on', '1')
- elif isinstance(proptype, hyperdb.Number):
- props[propname] = float(value)
+ props[key] = hyperdb.rawToHyperdb(self.db, cl, None,
+ propname, value)
+ except hyperdb.HyperdbValueError, message:
+ raise UsageError, message
# check for the key property
propname = cl.getkey()
in order: the key, "name", "title" and then the first property,
alphabetically.
- With -c, -S or -s print a list of item id's if no property specified.
+ With -c, -S or -s print a list of item id's if no property specified.
If property specified, print list of that property for every class
- instance.
+ instance.
'''
- if len(args) > 2:
- raise UsageError, _('Too many arguments supplied')
+ if len(args) > 2:
+ raise UsageError, _('Too many arguments supplied')
if len(args) < 1:
raise UsageError, _('Not enough arguments supplied')
classname = args[0]
propname = cl.labelprop()
if self.separator:
- if len(args) == 2:
- # create a list of propnames since user specified propname
- proplist=[]
- for nodeid in cl.list():
- try:
- proplist.append(cl.get(nodeid, propname))
- except KeyError:
- raise UsageError, _('%(classname)s has no property '
- '"%(propname)s"')%locals()
- print self.separator.join(proplist)
- else:
- # create a list of index id's since user didn't specify
- # otherwise
+ if len(args) == 2:
+ # create a list of propnames since user specified propname
+ proplist=[]
+ for nodeid in cl.list():
+ try:
+ proplist.append(cl.get(nodeid, propname))
+ except KeyError:
+ raise UsageError, _('%(classname)s has no property '
+ '"%(propname)s"')%locals()
+ print self.separator.join(proplist)
+ else:
+ # create a list of index id's since user didn't specify
+ # otherwise
print self.separator.join(cl.list())
else:
for nodeid in cl.list():
colon-separated-value files that are placed in the nominated
destination directory. The journals are not exported.
'''
- # we need the CSV module
- if csv is None:
- raise UsageError, \
- _('Sorry, you need the csv module to use this function.\n'
- 'Get it from: http://www.object-craft.com.au/projects/csv/')
-
# grab the directory to export to
if len(args) < 1:
raise UsageError, _('Not enough arguments supplied')
+ if rcsv.error:
+ raise UsageError, _(rcsv.error)
+
dir = args[-1]
# get the list of classes to export
else:
classes = self.db.classes.keys()
- # use the csv parser if we can - it's faster
- p = csv.parser(field_sep=':')
-
# do all the classes specified
for classname in classes:
cl = self.get_class(classname)
f = open(os.path.join(dir, classname+'.csv'), 'w')
+ writer = rcsv.writer(f, rcsv.colon_separated)
properties = cl.getprops()
propnames = properties.keys()
propnames.sort()
- l = propnames[:]
- l.append('is retired')
- print >> f, p.join(l)
+ fields = propnames[:]
+ fields.append('is retired')
+ writer.writerow(fields)
# all nodes for this class (not using list() 'cos it doesn't
# include retired nodes)
for nodeid in self.db.getclass(classname).getnodeids():
# get the regular props
- print >>f, p.join(cl.export_list(propnames, nodeid))
+ writer.writerow (cl.export_list(propnames, nodeid))
# close this file
f.close()
'''
if len(args) < 1:
raise UsageError, _('Not enough arguments supplied')
- if csv is None:
- raise UsageError, \
- _('Sorry, you need the csv module to use this function.\n'
- 'Get it from: http://www.object-craft.com.au/projects/csv/')
-
+ if rcsv.error:
+ raise UsageError, _(rcsv.error)
from roundup import hyperdb
for file in os.listdir(args[0]):
# ensure that the properties and the CSV file headings match
cl = self.get_class(classname)
- p = csv.parser(field_sep=':')
- file_props = p.parse(f.readline())
-
-# XXX we don't _really_ need to do this...
-# properties = cl.getprops()
-# propnames = properties.keys()
-# propnames.sort()
-# m = file_props[:]
-# m.sort()
-# if m != propnames:
-# raise UsageError, _('Import file doesn\'t define the same '
-# 'properties as "%(arg0)s".')%{'arg0': args[0]}
+ reader = rcsv.reader(f, rcsv.colon_separated)
+ file_props = None
+ maxid = 1
# loop through the file and create a node for each entry
- maxid = 1
- 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
- line = f.readline()
- if not line:
- raise ValueError, "Unexpected EOF during CSV parse"
+ for r in reader:
+ if file_props is None:
+ file_props = r
+ continue
# do the import and figure the current highest nodeid
- maxid = max(maxid, int(cl.import_list(file_props, l)))
+ maxid = max(maxid, int(cl.import_list(file_props, r)))
+ # set the id counter
print 'setting', classname, maxid+1
self.db.setid(classname, str(maxid+1))
return 0
if opt == '-i':
self.tracker_home = arg
if opt == '-c':
- if self.separator != None:
- self.usage('Only one of -c, -S and -s may be specified')
- return 1
+ if self.separator != None:
+ self.usage('Only one of -c, -S and -s may be specified')
+ return 1
self.separator = ','
if opt == '-S':
- if self.separator != None:
- self.usage('Only one of -c, -S and -s may be specified')
- return 1
+ if self.separator != None:
+ self.usage('Only one of -c, -S and -s may be specified')
+ return 1
self.separator = arg
- if opt == '-s':
- if self.separator != None:
- self.usage('Only one of -c, -S and -s may be specified')
- return 1
+ if opt == '-s':
+ if self.separator != None:
+ self.usage('Only one of -c, -S and -s may be specified')
+ return 1
self.separator = ' '
if opt == '-d':
self.print_designator = 1