Mercurial Repository: p/roundup/code: roundup/admin.py comparison

comparison roundup/admin.py @ 7250:ee972b3073cb

alphabetize all do_X methods. Makes it easier to figure out where the method is defined and provides a structure for adding new methods. No functional changes just moving existing functions around.

author	John Rouillard <rouilj@ieee.org>
date	Wed, 12 Apr 2023 09:52:51 -0400
parents	bd2dc1484b39
children	9c067ed4568b

comparison

equal deleted inserted replaced

-:bd2dc1484b39
+:ee972b3073cb
 print(_('%s:') % name)
 print('   ', _(command.__doc__))
 nl_re = re.compile('[\r\n]')
 # indent_re defined above
-def do_help(self, args, nl_re=nl_re, indent_re=indent_re):
-''"""Usage: help topic
-Give help about topic.
-commands  -- list commands
-<command> -- help specific to a command
-initopts  -- init command options
-all       -- all available help
-"""
-if len(args) > 0:
-topic = args[0]
-else:
-topic = 'help'
-# try help_ methods
-if topic in self.help:
-self.help[topic]()
-return 0
-# try command docstrings
-try:
-cmd_docs = self.commands.get(topic)
-except KeyError:
-print(_('Sorry, no help for "%(topic)s"') % locals())
-return 1
-# display the help for each match, removing the docstring indent
-for _name, help in cmd_docs:
-lines = nl_re.split(_(help.__doc__))
-print(lines[0])
-indent = indent_re.match(lines[1])
-if indent: indent = len(indent.group(1))  # noqa: E701
-for line in lines[1:]:
-if indent:
-print(line[indent:])
-else:
-print(line)
-return 0
 def listTemplates(self, trace_search=False):
 """ List all the available templates.
 Look in the following places, where the later rules take precedence:
 print(_('Templates:'), ', '.join(templates))
 import roundup.backends
 backends = roundup.backends.list_backends()
 print(_('Back ends:'), ', '.join(backends))
-def do_install(self, tracker_home, args):
-''"""Usage: install [template [backend [key=val[,key=val]]]]
-Install a new Roundup tracker.
-The command will prompt for the tracker home directory
-(if not supplied through TRACKER_HOME or the -i option).
-The template and backend may be specified on the command-line
-as arguments, in that order.
-Command line arguments following the backend allows you to
-pass initial values for config options.  For example, passing
-"web_http_auth=no,rdbms_user=dinsdale" will override defaults
-for options http_auth in section [web] and user in section [rdbms].
-Please be careful to not use spaces in this argument! (Enclose
-whole argument in quotes if you need spaces in option value).
-The initialise command must be called after this command in order
-to initialise the tracker's database. You may edit the tracker's
-initial database contents before running that command by editing
-the tracker's dbinit.py module init() function.
-See also initopts help.
-"""
-if len(args) < 1:
-raise UsageError(_('Not enough arguments supplied'))
-# make sure the tracker home can be created
-tracker_home = os.path.abspath(tracker_home)
-parent = os.path.split(tracker_home)[0]
-if not os.path.exists(parent):
-raise UsageError(_('Instance home parent directory "%(parent)s"'
-' does not exist') % locals())
-config_ini_file = os.path.join(tracker_home, CoreConfig.INI_FILE)
-# check for both old- and new-style configs
-if list(filter(os.path.exists, [config_ini_file,
-os.path.join(tracker_home, 'config.py')])):
-if not self.force:
-ok = self.my_input(_(
-"""WARNING: There appears to be a tracker in "%(tracker_home)s"!
-If you re-install it, you will lose all the data!
-Erase it? Y/N: """) % locals())  # noqa: E122
-if ok.strip().lower() != 'y':
-return 0
-# clear it out so the install isn't confused
-shutil.rmtree(tracker_home)
-# select template
-templates = self.listTemplates()
-template = self._get_choice(
-list_name=_('Templates:'),
-prompt=_('Select template'),
-options=templates,
-argument=len(args) > 1 and args[1] or '',
-default='classic')
-# select hyperdb backend
-import roundup.backends
-backends = roundup.backends.list_backends()
-backend = self._get_choice(
-list_name=_('Back ends:'),
-prompt=_('Select backend'),
-options=backends,
-argument=len(args) > 2 and args[2] or '',
-default='anydbm')
-# XXX perform a unit test based on the user's selections
-# Process configuration file definitions
-if len(args) > 3:
-try:
-defns = dict([item.split("=") for item in args[3].split(",")])
-except Exception:
-print(_('Error in configuration settings: "%s"') % args[3])
-raise
-else:
-defns = {}
-defns['rdbms_backend'] = backend
-# load config_ini.ini from template if it exists.
-# it sets parameters like template_engine that are
-# template specific.
-template_config = UserConfig(templates[template]['path'] +
-"/config_ini.ini")
-for k in template_config.keys():
-if k == 'HOME':  # ignore home. It is a default param.
-continue
-defns[k] = template_config[k]
-# install!
-init.install(tracker_home, templates[template]['path'], settings=defns)
-# Remove config_ini.ini file from tracker_home (not template dir).
-# Ignore file not found - not all templates have
-#   config_ini.ini files.
-try:
-os.remove(tracker_home + "/config_ini.ini")
-except OSError as e:  # FileNotFound exception under py3
-if e.errno == 2:
-pass
-else:
-raise
-print(_("""
----------------------------------------------------------------------------
-You should now edit the tracker configuration file:
-%(config_file)s""") % {"config_file": config_ini_file})
-# find list of options that need manual adjustments
-# XXX config._get_unset_options() is marked as private
-#   (leading underscore).  make it public or don't care?
-need_set = CoreConfig(tracker_home)._get_unset_options()
-if need_set:
-print(_(" ... at a minimum, you must set following options:"))
-for section in need_set:
-print("   [%s]: %s" % (section, ", ".join(need_set[section])))
-# note about schema modifications
-print(_("""
-If you wish to modify the database schema,
-you should also edit the schema file:
-%(database_config_file)s
-You may also change the database initialisation file:
-%(database_init_file)s
-... see the documentation on customizing for more information.
-You MUST run the "roundup-admin initialise" command once you've performed
-the above steps.
----------------------------------------------------------------------------
-""") % {'database_config_file': os.path.join(tracker_home, 'schema.py'),
-'database_init_file': os.path.join(tracker_home, 'initial_data.py')}) \
-# noqa: E122
-return 0
 def _get_choice(self, list_name, prompt, options, argument, default=None):
 if default is None:
 default = options[0]  # just pick the first one
 if argument in options:
 return argument
 argument = self.my_input('%s [%s]: ' % (prompt, default))
 if not argument:
 return default
 return argument
+def do_commit(self, args):
+''"""Usage: commit
+Commit changes made to the database during an interactive session.
+The changes made during an interactive session are not
+automatically written to the database - they must be committed
+using this command.
+One-off commands on the command-line are automatically committed if
+they are successful.
+"""
+self.db.commit()
+self.db_uncommitted = False
+return 0
+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.
+"""
+if len(args) < 1:
+raise UsageError(_('Not enough arguments supplied'))
+from roundup import hyperdb
+classname = args[0]
+# get the class
+cl = self.get_class(classname)
+# now do a create
+props = {}
+properties = cl.getprops(protected=0)
+if len(args) == 1:
+# ask for the properties
+for key in properties:
+if key == 'id': continue  # noqa: E701
+value = properties[key]
+name = value.__class__.__name__
+if isinstance(value, hyperdb.Password):
+again = None
+while value != again:
+value = getpass.getpass(_('%(propname)s (Password): ')
+%
+{'propname': key.capitalize()})
+again = getpass.getpass(_('   %(propname)s (Again): ')
+%
+{'propname': key.capitalize()})
+if value != again:
+print(_('Sorry, try again...'))
+if value:
+props[key] = value
+else:
+value = self.my_input(_('%(propname)s (%(proptype)s): ') % {
+'propname': key.capitalize(), 'proptype': name})
+if value:
+props[key] = value
+else:
+props = self.props_from_args(args[1:])
+# convert types
+for propname in props:
+try:
+props[propname] = hyperdb.rawToHyperdb(self.db, cl, None,
+propname,
+props[propname])
+except hyperdb.HyperdbValueError as message:
+raise UsageError(message)
+# check for the key property
+propname = cl.getkey()
+if propname and propname not in props:
+raise UsageError(_('you must provide the "%(propname)s" '
+'property.') % locals())
+# do the actual create
+try:
+sys.stdout.write(cl.create(**props) + '\n')
+except (TypeError, IndexError, ValueError) as message:
+raise UsageError(message)
+self.db_uncommitted = True
+return 0
+def do_display(self, args):
+''"""Usage: display designator[,designator]*
+Show the property values for the given node(s).
+A designator is a classname and a nodeid concatenated,
+eg. bug1, user10, ...
+This lists the properties and their associated values
+for the given node.
+"""
+if len(args) < 1:
+raise UsageError(_('Not enough arguments supplied'))
+# decode the node designator
+for designator in args[0].split(','):
+try:
+classname, nodeid = hyperdb.splitDesignator(designator)
+except hyperdb.DesignatorError as message:
+raise UsageError(message)
+# get the class
+cl = self.get_class(classname)
+# display the values
+keys = sorted(cl.properties)
+for key in keys:
+value = cl.get(nodeid, key)
+print(_('%(key)s: %(value)s') % locals())
+def do_export(self, args, export_files=True):
+''"""Usage: export [[-]class[,class]] export_dir
+Export the database to colon-separated-value files.
+To exclude the files (e.g. for the msg or file class),
+use the exporttables command.
+Optionally limit the export to just the named classes
+or exclude the named classes, if the 1st argument starts with '-'.
+This action exports the current data from the database into
+colon-separated-value files that are placed in the nominated
+destination directory.
+"""
+# grab the directory to export to
+if len(args) < 1:
+raise UsageError(_('Not enough arguments supplied'))
+dir = args[-1]
+# get the list of classes to export
+if len(args) == 2:
+if args[0].startswith('-'):
+classes = [c for c in self.db.classes
+if c not in args[0][1:].split(',')]
+else:
+classes = args[0].split(',')
+else:
+classes = self.db.classes
+class colon_separated(csv.excel):
+delimiter = ':'
+# make sure target dir exists
+if not os.path.exists(dir):
+os.makedirs(dir)
+# maximum csv field length exceeding configured size?
+max_len = self.db.config.CSV_FIELD_SIZE
+# do all the classes specified
+for classname in classes:
+cl = self.get_class(classname)
+if not export_files and hasattr(cl, 'export_files'):
+sys.stdout.write('Exporting %s WITHOUT the files\r\n' %
+classname)
+with open(os.path.join(dir, classname+'.csv'), 'w') as f:
+writer = csv.writer(f, colon_separated)
+propnames = cl.export_propnames()
+fields = propnames[:]
+fields.append('is retired')
+writer.writerow(fields)
+# If a node has a key, sort all nodes by key
+# with retired nodes first. Retired nodes
+# must occur before a non-retired node with
+# the same key. Otherwise you get an
+# IntegrityError: UNIQUE constraint failed:
+#     _class.__retired__, _<class>._<keyname>
+# on imports to rdbms.
+all_nodes = cl.getnodeids()
+classkey = cl.getkey()
+if classkey:  # False sorts before True, so negate is_retired
+keysort = lambda i: (cl.get(i, classkey),  # noqa: E731
+not cl.is_retired(i))
+all_nodes.sort(key=keysort)
+# if there is no classkey no need to sort
+for nodeid in all_nodes:
+if self.verbose:
+sys.stdout.write('\rExporting %s - %s' %
+(classname, nodeid))
+sys.stdout.flush()
+node = cl.getnode(nodeid)
+exp = cl.export_list(propnames, nodeid)
+lensum = sum([len(repr_export(node[p])) for
+p in propnames])
+# for a safe upper bound of field length we add
+# difference between CSV len and sum of all field lengths
+d = sum([len(x) for x in exp]) - lensum
+if not d > 0:
+raise AssertionError("Bad assertion d > 0")
+for p in propnames:
+ll = len(repr_export(node[p])) + d
+if ll > max_len:
+max_len = ll
+writer.writerow(exp)
+if export_files and hasattr(cl, 'export_files'):
+cl.export_files(dir, nodeid)
+# export the journals
+with open(os.path.join(dir, classname+'-journals.csv'), 'w') as jf:
+if self.verbose:
+sys.stdout.write("\nExporting Journal for %s\n" %
+classname)
+sys.stdout.flush()
+journals = csv.writer(jf, colon_separated)
+for row in cl.export_journals():
+journals.writerow(row)
+if max_len > self.db.config.CSV_FIELD_SIZE:
+print("Warning: config csv_field_size should be at least %s" %
+max_len, file=sys.stderr)
+return 0
+def do_exporttables(self, args):
+''"""Usage: exporttables [[-]class[,class]] export_dir
+Export the database to colon-separated-value files, excluding the
+files below $TRACKER_HOME/db/files/ (which can be archived separately).
+To include the files, use the export command.
+Optionally limit the export to just the named classes
+or exclude the named classes, if the 1st argument starts with '-'.
+This action exports the current data from the database into
+colon-separated-value files that are placed in the nominated
+destination directory.
+"""
+return self.do_export(args, export_files=False)
+def do_filter(self, args):
+''"""Usage: filter classname propname=value ...
+Find the nodes of the given class with a given property value.
+Find the nodes of the given class with a given property value.
+Multiple values can be specified by separating them with commas.
+If property is a string, all values must match. I.E. it's an
+'and' operation. If the property is a link/multilink any value
+matches. I.E. an 'or' operation.
+"""
+if len(args) < 1:
+raise UsageError(_('Not enough arguments supplied'))
+classname = args[0]
+# get the class
+cl = self.get_class(classname)
+# handle the propname=value argument
+props = self.props_from_args(args[1:])
+# convert the user-input value to a value used for filter
+# multiple , separated values become a list
+for propname, value in props.items():
+if ',' in value:
+values = value.split(',')
+else:
+values = [value]
+props[propname] = []
+# start handling transitive props
+# given filter issue assignedto.roles=Admin
+# start at issue
+curclass = cl
+lastprop = propname  # handle case 'issue assignedto=admin'
+if '.' in propname:
+# start splitting transitive prop into components
+# we end when we have no more links
+for pn in propname.split('.'):
+try:
+lastprop = pn  # get current component
+# get classname for this link
+try:
+curclassname = curclass.getprops()[pn].classname
+except KeyError:
+raise UsageError(_(
+"Class %(curclassname)s has "
+"no property %(pn)s in %(propname)s." %
+locals()))
+# get class object
+curclass = self.get_class(curclassname)
+except AttributeError:
+# curclass.getprops()[pn].classname raises this
+# when we are at a non link/multilink property
+pass
+for value in values:
+val = hyperdb.rawToHyperdb(self.db, curclass, None,
+lastprop, value)
+props[propname].append(val)
+# now do the filter
+try:
+id = []
+designator = []
+props = {"filterspec": props}
+if self.separator:
+if self.print_designator:
+id = cl.filter(None, **props)
+for i in id:
+designator.append(classname + i)
+print(self.separator.join(designator))
+else:
+print(self.separator.join(cl.filter(None, **props)))
+else:
+if self.print_designator:
+id = cl.filter(None, **props)
+for i in id:
+designator.append(classname + i)
+print(designator)
+else:
+print(cl.filter(None, **props))
+except KeyError:
+raise UsageError(_('%(classname)s has no property '
+'"%(propname)s"') % locals())
+except (ValueError, TypeError) as message:
+raise UsageError(message)
+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.
+"""
+if len(args) < 1:
+raise UsageError(_('Not enough arguments supplied'))
+classname = args[0]
+# get the class
+cl = self.get_class(classname)
+# handle the propname=value argument
+props = self.props_from_args(args[1:])
+# convert the user-input value to a value used for find()
+for propname, value in props.items():
+if ',' in value:
+values = value.split(',')
+else:
+values = [value]
+d = props[propname] = {}
+for value in values:
+value = hyperdb.rawToHyperdb(self.db, cl, None,
+propname, value)
+if isinstance(value, list):
+for entry in value:
+d[entry] = 1
+else:
+d[value] = 1
+# now do the find
+try:
+id = []
+designator = []
+if self.separator:
+if self.print_designator:
+id = cl.find(**props)
+for i in id:
+designator.append(classname + i)
+print(self.separator.join(designator))
+else:
+print(self.separator.join(cl.find(**props)))
+else:
+if self.print_designator:
+id = cl.find(**props)
+for i in id:
+designator.append(classname + i)
+print(designator)
+else:
+print(cl.find(**props))
+except KeyError:
+raise UsageError(_('%(classname)s has no property '
+'"%(propname)s"') % locals())
+except (ValueError, TypeError) as message:
+raise UsageError(message)
+return 0
 def do_genconfig(self, args, update=False):
 ''"""Usage: genconfig <filename>
 Generate a new tracker config file (ini style) with default
 values in <filename>.
 """
 else:
 # generate default config
 config = CoreConfig()
 config.save(args[0])
-def do_updateconfig(self, args):
-''"""Usage: updateconfig <filename>
-Generate an updated tracker config file (ini style) in
-<filename>. Use current settings from existing roundup
-tracker in tracker home.
-"""
-self.do_genconfig(args, update=True)
-def do_initialise(self, tracker_home, args):
-''"""Usage: initialise [adminpw]
-Initialise a new Roundup tracker.
-The administrator details will be set at this step.
-Execute the tracker's initialisation function dbinit.init()
-"""
-# password
-if len(args) > 1:
-adminpw = args[1]
-else:
-adminpw = ''
-confirm = 'x'
-while adminpw != confirm:
-adminpw = getpass.getpass(_('Admin Password: '))
-confirm = getpass.getpass(_('       Confirm: '))
-# make sure the tracker home is installed
-if not os.path.exists(tracker_home):
-raise UsageError(_('Instance home does not exist') % locals())
-try:
-tracker = roundup.instance.open(tracker_home)
-except roundup.instance.TrackerError:
-raise UsageError(_('Instance has not been installed') % locals())
-# is there already a database?
-if tracker.exists():
-if not self.force:
-ok = self.my_input(_(
-"""WARNING: The database is already initialised!
-If you re-initialise it, you will lose all the data!
-Erase it? Y/N: """))  # noqa: E122
-if ok.strip().lower() != 'y':
-return 0
-# nuke it
-tracker.nuke()
-# GO
-try:
-tracker.init(password.Password(adminpw, config=tracker.config),
-tx_Source='cli')
-except OptionUnsetError as e:
-raise UsageError("In %(tracker_home)s/config.ini - %(error)s" % {
-'error': str(e), 'tracker_home': tracker_home})
-return 0
 def do_get(self, args):
 ''"""Usage: get property designator[,designator]*
 Get the given property of one or more designator(s).
 if self.separator:
 print(self.separator.join(linked_props))
 return 0
-def do_set(self, args):
+def do_help(self, args, nl_re=nl_re, indent_re=indent_re):
-''"""Usage: set items property=value property=value ...
+''"""Usage: help topic
-Set the given properties of one or more items(s).
+Give help about topic.
-The items are specified as a class or as a comma-separated
+commands  -- list commands
-list of item designators (ie "designator[,designator,...]").
+<command> -- help specific to a command
+initopts  -- init command options
+all       -- all available help
+"""
+if len(args) > 0:
+topic = args[0]
+else:
+topic = 'help'
+# try help_ methods
+if topic in self.help:
+self.help[topic]()
+return 0
+# try command docstrings
+try:
+cmd_docs = self.commands.get(topic)
+except KeyError:
+print(_('Sorry, no help for "%(topic)s"') % locals())
+return 1
+# display the help for each match, removing the docstring indent
+for _name, help in cmd_docs:
+lines = nl_re.split(_(help.__doc__))
+print(lines[0])
+indent = indent_re.match(lines[1])
+if indent: indent = len(indent.group(1))  # noqa: E701
+for line in lines[1:]:
+if indent:
+print(line[indent:])
+else:
+print(line)
+return 0
+def do_history(self, args):
+''"""Usage: history designator [skipquiet]
+Show the history entries of a designator.
 A designator is a classname and a nodeid concatenated,
 eg. bug1, user10, ...
-This command sets the properties to the values for all
+Lists the journal entries viewable by the user for the
-designators given. If a class is used, the property will be
+node identified by the designator. If skipquiet is the
-set for all items in the class. If the value is missing
+second argument, journal entries for quiet properties
-(ie. "property=") then the property is un-set. If the property
+are not shown.
-is a multilink, you specify the linked ids for the multilink
+"""
-as comma-separated numbers (ie "1,2,3").
-"""
-import copy  # needed for copying props list
-if len(args) < 2:
-raise UsageError(_('Not enough arguments supplied'))
-from roundup import hyperdb
-designators = args[0].split(',')
-if len(designators) == 1:
-designator = designators[0]
-try:
-designator = hyperdb.splitDesignator(designator)
-designators = [designator]
-except hyperdb.DesignatorError:
-cl = self.get_class(designator)
-designators = [(designator, x) for x in cl.list()]
-else:
-try:
-designators = [hyperdb.splitDesignator(x) for x in designators]
-except hyperdb.DesignatorError as message:
-raise UsageError(message)
-# get the props from the args
-propset = self.props_from_args(args[1:])  # parse the cli once
-# now do the set for all the nodes
-for classname, itemid in designators:
-props = copy.copy(propset)  # make a new copy for every designator
-cl = self.get_class(classname)
-for key, value in list(props.items()):
-try:
-# You must reinitialize the props every time though.
-# if props['nosy'] = '+admin' initally, it gets
-# set to 'demo,admin' (assuming it was set to demo
-# in the db) after rawToHyperdb returns.
-# This  new value is used for all the rest of the
-# designators if not reinitalized.
-props[key] = hyperdb.rawToHyperdb(self.db, cl, itemid,
-key, value)
-except hyperdb.HyperdbValueError as message:
-raise UsageError(message)
-# try the set
-try:
-cl.set(itemid, **props)
-except (TypeError, IndexError, ValueError) as message:
-raise UsageError(message)
-self.db_uncommitted = True
-return 0
-def do_filter(self, args):
-''"""Usage: filter classname propname=value ...
-Find the nodes of the given class with a given property value.
-Find the nodes of the given class with a given property value.
-Multiple values can be specified by separating them with commas.
-If property is a string, all values must match. I.E. it's an
-'and' operation. If the property is a link/multilink any value
-matches. I.E. an 'or' operation.
-"""
 if len(args) < 1:
 raise UsageError(_('Not enough arguments supplied'))
-classname = args[0]
-# get the class
-cl = self.get_class(classname)
-# handle the propname=value argument
-props = self.props_from_args(args[1:])
-# convert the user-input value to a value used for filter
-# multiple , separated values become a list
-for propname, value in props.items():
-if ',' in value:
-values = value.split(',')
-else:
-values = [value]
-props[propname] = []
-# start handling transitive props
-# given filter issue assignedto.roles=Admin
-# start at issue
-curclass = cl
-lastprop = propname  # handle case 'issue assignedto=admin'
-if '.' in propname:
-# start splitting transitive prop into components
-# we end when we have no more links
-for pn in propname.split('.'):
-try:
-lastprop = pn  # get current component
-# get classname for this link
-try:
-curclassname = curclass.getprops()[pn].classname
-except KeyError:
-raise UsageError(_(
-"Class %(curclassname)s has "
-"no property %(pn)s in %(propname)s." %
-locals()))
-# get class object
-curclass = self.get_class(curclassname)
-except AttributeError:
-# curclass.getprops()[pn].classname raises this
-# when we are at a non link/multilink property
-pass
-for value in values:
-val = hyperdb.rawToHyperdb(self.db, curclass, None,
-lastprop, value)
-props[propname].append(val)
-# now do the filter
 try:
-id = []
+classname, nodeid = hyperdb.splitDesignator(args[0])
-designator = []
+except hyperdb.DesignatorError as message:
-props = {"filterspec": props}
+raise UsageError(message)
-if self.separator:
+skipquiet = False
-if self.print_designator:
+if len(args) == 2:
-id = cl.filter(None, **props)
+if args[1] != 'skipquiet':
-for i in id:
+raise UsageError("Second argument is not skipquiet")
-designator.append(classname + i)
+skipquiet = True
-print(self.separator.join(designator))
-else:
+try:
-print(self.separator.join(cl.filter(None, **props)))
+print(self.db.getclass(classname).history(nodeid,
-else:
+skipquiet=skipquiet))
-if self.print_designator:
-id = cl.filter(None, **props)
-for i in id:
-designator.append(classname + i)
-print(designator)
-else:
-print(cl.filter(None, **props))
 except KeyError:
-raise UsageError(_('%(classname)s has no property '
+raise UsageError(_('no such class "%(classname)s"') % locals())
-'"%(propname)s"') % locals())
+except IndexError:
-except (ValueError, TypeError) as message:
+raise UsageError(_('no such %(classname)s node '
-raise UsageError(message)
+'"%(nodeid)s"') % locals())
 return 0
-def do_find(self, args):
+def do_import(self, args, import_files=True):
-''"""Usage: find classname propname=value ...
+''"""Usage: import import_dir
-Find the nodes of the given class with a given link property value.
+Import a database from the directory containing CSV files,
+two per class to import.
-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
+The files used in the import are:
-value.
+<class>.csv
+This must define the same properties as the class (including
+having a "header" line with those property names.)
+<class>-journals.csv
+This defines the journals for the items being imported.
+The imported nodes will have the same nodeid as defined in the
+import file, thus replacing any existing content.
+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) < 1:
 raise UsageError(_('Not enough arguments supplied'))
-classname = args[0]
-# get the class
+if hasattr(csv, 'field_size_limit'):
-cl = self.get_class(classname)
+csv.field_size_limit(self.db.config.CSV_FIELD_SIZE)
-# handle the propname=value argument
+# directory to import from
-props = self.props_from_args(args[1:])
+dir = args[0]
-# convert the user-input value to a value used for find()
+class colon_separated(csv.excel):
-for propname, value in props.items():
+delimiter = ':'
-if ',' in value:
-values = value.split(',')
+# import all the files
-else:
+for file in os.listdir(dir):
-values = [value]
+classname, ext = os.path.splitext(file)
-d = props[propname] = {}
+# we only care about CSV files
-for value in values:
+if ext != '.csv' or classname.endswith('-journals'):
-value = hyperdb.rawToHyperdb(self.db, cl, None,
+continue
-propname, value)
-if isinstance(value, list):
+cl = self.get_class(classname)
-for entry in value:
-d[entry] = 1
+# ensure that the properties and the CSV file headings match
-else:
+with open(os.path.join(dir, file), 'r') as f:
-d[value] = 1
+reader = csv.reader(f, colon_separated)
+file_props = None
-# now do the find
+maxid = 1
+# loop through the file and create a node for each entry
+for n, r in enumerate(reader):
+if file_props is None:
+file_props = r
+continue
+if self.verbose:
+sys.stdout.write('\rImporting %s - %s' % (classname, n))
+sys.stdout.flush()
+# do the import and figure the current highest nodeid
+nodeid = cl.import_list(file_props, r)
+if hasattr(cl, 'import_files') and import_files:
+cl.import_files(dir, nodeid)
+maxid = max(maxid, int(nodeid))
+# (print to sys.stdout here to allow tests to squash it .. ugh)
+print(file=sys.stdout)
+# import the journals
+with open(os.path.join(args[0], classname + '-journals.csv'), 'r') as f:
+reader = csv.reader(f, colon_separated)
+cl.import_journals(reader)
+# (print to sys.stdout here to allow tests to squash it .. ugh)
+print('setting', classname, maxid+1, file=sys.stdout)
+# set the id counter
+self.db.setid(classname, str(maxid+1))
+self.db_uncommitted = True
+return 0
+def do_importtables(self, args):
+''"""Usage: importtables export_dir
+This imports the database tables exported using exporttables.
+"""
+return self.do_import(args, import_files=False)
+def do_initialise(self, tracker_home, args):
+''"""Usage: initialise [adminpw]
+Initialise a new Roundup tracker.
+The administrator details will be set at this step.
+Execute the tracker's initialisation function dbinit.init()
+"""
+# password
+if len(args) > 1:
+adminpw = args[1]
+else:
+adminpw = ''
+confirm = 'x'
+while adminpw != confirm:
+adminpw = getpass.getpass(_('Admin Password: '))
+confirm = getpass.getpass(_('       Confirm: '))
+# make sure the tracker home is installed
+if not os.path.exists(tracker_home):
+raise UsageError(_('Instance home does not exist') % locals())
 try:
-id = []
+tracker = roundup.instance.open(tracker_home)
-designator = []
+except roundup.instance.TrackerError:
-if self.separator:
+raise UsageError(_('Instance has not been installed') % locals())
-if self.print_designator:
-id = cl.find(**props)
+# is there already a database?
-for i in id:
+if tracker.exists():
-designator.append(classname + i)
+if not self.force:
-print(self.separator.join(designator))
+ok = self.my_input(_(
-else:
+"""WARNING: The database is already initialised!
-print(self.separator.join(cl.find(**props)))
+If you re-initialise it, you will lose all the data!
+Erase it? Y/N: """))  # noqa: E122
-else:
+if ok.strip().lower() != 'y':
-if self.print_designator:
+return 0
-id = cl.find(**props)
-for i in id:
+# nuke it
-designator.append(classname + i)
+tracker.nuke()
-print(designator)
-else:
+# GO
-print(cl.find(**props))
+try:
-except KeyError:
+tracker.init(password.Password(adminpw, config=tracker.config),
-raise UsageError(_('%(classname)s has no property '
+tx_Source='cli')
-'"%(propname)s"') % locals())
+except OptionUnsetError as e:
-except (ValueError, TypeError) as message:
+raise UsageError("In %(tracker_home)s/config.ini - %(error)s" % {
-raise UsageError(message)
+'error': str(e), 'tracker_home': tracker_home})
-return 0
+return 0
-def do_specification(self, args):
-''"""Usage: specification classname
+def do_install(self, tracker_home, args):
-Show the properties for a classname.
+''"""Usage: install [template [backend [key=val[,key=val]]]]
+Install a new Roundup tracker.
-This lists the properties for a given class.
+The command will prompt for the tracker home directory
+(if not supplied through TRACKER_HOME or the -i option).
+The template and backend may be specified on the command-line
+as arguments, in that order.
+Command line arguments following the backend allows you to
+pass initial values for config options.  For example, passing
+"web_http_auth=no,rdbms_user=dinsdale" will override defaults
+for options http_auth in section [web] and user in section [rdbms].
+Please be careful to not use spaces in this argument! (Enclose
+whole argument in quotes if you need spaces in option value).
+The initialise command must be called after this command in order
+to initialise the tracker's database. You may edit the tracker's
+initial database contents before running that command by editing
+the tracker's dbinit.py module init() function.
+See also initopts help.
 """
 if len(args) < 1:
 raise UsageError(_('Not enough arguments supplied'))
-classname = args[0]
-# get the class
+# make sure the tracker home can be created
-cl = self.get_class(classname)
+tracker_home = os.path.abspath(tracker_home)
+parent = os.path.split(tracker_home)[0]
-# get the key property
+if not os.path.exists(parent):
-keyprop = cl.getkey()
+raise UsageError(_('Instance home parent directory "%(parent)s"'
-for key in cl.properties:
+' does not exist') % locals())
-value = cl.properties[key]
-if keyprop == key:
+config_ini_file = os.path.join(tracker_home, CoreConfig.INI_FILE)
-sys.stdout.write(_('%(key)s: %(value)s (key property)\n') %
+# check for both old- and new-style configs
-locals())
+if list(filter(os.path.exists, [config_ini_file,
+os.path.join(tracker_home, 'config.py')])):
+if not self.force:
+ok = self.my_input(_(
+"""WARNING: There appears to be a tracker in "%(tracker_home)s"!
+If you re-install it, you will lose all the data!
+Erase it? Y/N: """) % locals())  # noqa: E122
+if ok.strip().lower() != 'y':
+return 0
+# clear it out so the install isn't confused
+shutil.rmtree(tracker_home)
+# select template
+templates = self.listTemplates()
+template = self._get_choice(
+list_name=_('Templates:'),
+prompt=_('Select template'),
+options=templates,
+argument=len(args) > 1 and args[1] or '',
+default='classic')
+# select hyperdb backend
+import roundup.backends
+backends = roundup.backends.list_backends()
+backend = self._get_choice(
+list_name=_('Back ends:'),
+prompt=_('Select backend'),
+options=backends,
+argument=len(args) > 2 and args[2] or '',
+default='anydbm')
+# XXX perform a unit test based on the user's selections
+# Process configuration file definitions
+if len(args) > 3:
+try:
+defns = dict([item.split("=") for item in args[3].split(",")])
+except Exception:
+print(_('Error in configuration settings: "%s"') % args[3])
+raise
+else:
+defns = {}
+defns['rdbms_backend'] = backend
+# load config_ini.ini from template if it exists.
+# it sets parameters like template_engine that are
+# template specific.
+template_config = UserConfig(templates[template]['path'] +
+"/config_ini.ini")
+for k in template_config.keys():
+if k == 'HOME':  # ignore home. It is a default param.
+continue
+defns[k] = template_config[k]
+# install!
+init.install(tracker_home, templates[template]['path'], settings=defns)
+# Remove config_ini.ini file from tracker_home (not template dir).
+# Ignore file not found - not all templates have
+#   config_ini.ini files.
+try:
+os.remove(tracker_home + "/config_ini.ini")
+except OSError as e:  # FileNotFound exception under py3
+if e.errno == 2:
+pass
 else:
-sys.stdout.write(_('%(key)s: %(value)s\n') % locals())
+raise
-def do_display(self, args):
+print(_("""
-''"""Usage: display designator[,designator]*
+---------------------------------------------------------------------------
+You should now edit the tracker configuration file:
-Show the property values for the given node(s).
+%(config_file)s""") % {"config_file": config_ini_file})
-A designator is a classname and a nodeid concatenated,
+# find list of options that need manual adjustments
-eg. bug1, user10, ...
+# XXX config._get_unset_options() is marked as private
+#   (leading underscore).  make it public or don't care?
-This lists the properties and their associated values
+need_set = CoreConfig(tracker_home)._get_unset_options()
-for the given node.
+if need_set:
-"""
+print(_(" ... at a minimum, you must set following options:"))
-if len(args) < 1:
+for section in need_set:
-raise UsageError(_('Not enough arguments supplied'))
+print("   [%s]: %s" % (section, ", ".join(need_set[section])))
-# decode the node designator
+# note about schema modifications
-for designator in args[0].split(','):
+print(_("""
-try:
+If you wish to modify the database schema,
-classname, nodeid = hyperdb.splitDesignator(designator)
+you should also edit the schema file:
-except hyperdb.DesignatorError as message:
+%(database_config_file)s
-raise UsageError(message)
+You may also change the database initialisation file:
+%(database_init_file)s
-# get the class
+... see the documentation on customizing for more information.
-cl = self.get_class(classname)
+You MUST run the "roundup-admin initialise" command once you've performed
-# display the values
+the above steps.
-keys = sorted(cl.properties)
+---------------------------------------------------------------------------
-for key in keys:
+""") % {'database_config_file': os.path.join(tracker_home, 'schema.py'),
-value = cl.get(nodeid, key)
+'database_init_file': os.path.join(tracker_home, 'initial_data.py')}) \
-print(_('%(key)s: %(value)s') % locals())
+# noqa: E122
-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.
-"""
-if len(args) < 1:
-raise UsageError(_('Not enough arguments supplied'))
-from roundup import hyperdb
-classname = args[0]
-# get the class
-cl = self.get_class(classname)
-# now do a create
-props = {}
-properties = cl.getprops(protected=0)
-if len(args) == 1:
-# ask for the properties
-for key in properties:
-if key == 'id': continue  # noqa: E701
-value = properties[key]
-name = value.__class__.__name__
-if isinstance(value, hyperdb.Password):
-again = None
-while value != again:
-value = getpass.getpass(_('%(propname)s (Password): ')
-%
-{'propname': key.capitalize()})
-again = getpass.getpass(_('   %(propname)s (Again): ')
-%
-{'propname': key.capitalize()})
-if value != again:
-print(_('Sorry, try again...'))
-if value:
-props[key] = value
-else:
-value = self.my_input(_('%(propname)s (%(proptype)s): ') % {
-'propname': key.capitalize(), 'proptype': name})
-if value:
-props[key] = value
-else:
-props = self.props_from_args(args[1:])
-# convert types
-for propname in props:
-try:
-props[propname] = hyperdb.rawToHyperdb(self.db, cl, None,
-propname,
-props[propname])
-except hyperdb.HyperdbValueError as message:
-raise UsageError(message)
-# check for the key property
-propname = cl.getkey()
-if propname and propname not in props:
-raise UsageError(_('you must provide the "%(propname)s" '
-'property.') % locals())
-# do the actual create
-try:
-sys.stdout.write(cl.create(**props) + '\n')
-except (TypeError, IndexError, ValueError) as message:
-raise UsageError(message)
-self.db_uncommitted = True
 return 0
 def do_list(self, args):
 ''"""Usage: list classname [property]
 List the instances of a class.
 raise UsageError(_('%(classname)s has no property '
 '"%(propname)s"') % locals())
 print(_('%(nodeid)4s: %(value)s') % locals())
 return 0
-def do_templates(self, args):
+def do_migrate(self, args):
-''"""Usage: templates [trace_search]
+''"""Usage: migrate
-List templates and their installed directories.
+Update a tracker's database to be compatible with the Roundup
-With trace_search also list all directories that are
+codebase.
-searched for templates.
-"""
+You should run the "migrate" command for your tracker once
-import textwrap
+you've installed the latest codebase.
-trace_search = False
+Do this before you use the web, command-line or mail interface
-if args and args[0] == "trace_search":
+and before any users access the tracker.
-trace_search = True
+This command will respond with either "Tracker updated" (if
-templates = self.listTemplates(trace_search=trace_search)
+you've not previously run it on an RDBMS backend) or "No
+migration action required" (if you have run it, or have used
-for name in sorted(list(templates.keys())):
+another interface to the tracker, or possibly because you are
-templates[name]['description'] = textwrap.fill(
+using anydbm).
-"\n".join([line.lstrip() for line in
-templates[name]['description'].split("\n")]),
+It's safe to run this even if it's not required, so just get
-70,
+into the habit.
-subsequent_indent="      "
+"""
-)
+if self.db.db_version_updated:
-print("""
+print(_('Tracker updated to schema version %s.') %
-Name: %(name)s
+self.db.database_schema['version'])
-Path: %(path)s
+self.db_uncommitted = True
-Desc: %(description)s
+else:
-""" % templates[name])
+print(_('No migration action required. At schema version %s.') %
+self.db.database_schema['version'])
-def do_table(self, args):
+return 0
-''"""Usage: table classname [property[,property]*]
-List the instances of a class in tabular form.
+def do_pack(self, args):
+''"""Usage: pack period | date
-Lists all instances of the given class. If the properties are not
-specified, all properties are displayed. By default, the column
+Remove journal entries older than a period of time specified or
-widths are the width of the largest value. The width may be
+before a certain date.
-explicitly defined by defining the property as "name:width".
-For example::
+A period is specified using the suffixes "y", "m", and "d". The
+suffix "w" (for "week") means 7 days.
-roundup> table priority id,name:10
-Id Name
+"3y" means three years
-1  fatal-bug
+"2y 1m" means two years and one month
-2  bug
+"1m 25d" means one month and 25 days
-3  usability
+"2w 3d" means two weeks and three days
-4  feature
+Date format is "YYYY-MM-DD" eg:
-Also to make the width of the column the width of the label,
+2001-01-01
-leave a trailing : without a width on the property. For example::
+"""
-roundup> table priority id,name:
+if len(args) != 1:
-Id Name
-1  fata
-2  bug
-3  usab
-4  feat
-will result in a the 4 character wide "Name" column.
-"""
-if len(args) < 1:
 raise UsageError(_('Not enough arguments supplied'))
-classname = args[0]
+# are we dealing with a period or a date
-# get the class
+value = args[0]
-cl = self.get_class(classname)
+date_re = re.compile(r"""
+(?P<date>\d\d\d\d-\d\d?-\d\d?)? # yyyy-mm-dd
-# figure the property names to display
+(?P<period>(\d+y\s*)?(\d+m\s*)?(\d+d\s*)?)?
-if len(args) > 1:
+""", re.VERBOSE)
-prop_names = args[1].split(',')
+m = date_re.match(value)
-all_props = cl.getprops()
+if not m:
-for spec in prop_names:
+raise ValueError(_('Invalid format'))
-if ':' in spec:
+m = m.groupdict()
+if m['period']:
+pack_before = date.Date(". - %s" % value)
+elif m['date']:
+pack_before = date.Date(value)
+self.db.pack(pack_before)
+self.db_uncommitted = True
+return 0
+def do_perftest(self, args):
+''"""Usage: perftest [mode] [arguments]*
+Time operations in Roundup. Supported arguments:
+[password] [rounds=<integer>] [scheme=<scheme>]
+'password' is the default mode.  The tracker's config.ini
+setting for 'password_pbkdf2_default_rounds' is the default
+value for 'rounds'. On the command line, 'rounds' can include
+thousands separator of ',' or '.'.  'scheme' is the default
+coded into Roundup. List supported schemes by using 'scheme='.
+"""
+from roundup.anypy.time_ import perf_counter
+props = {"rounds": self.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS,
+"scheme": password.Password.known_schemes[0]}
+print_supported_schemes = lambda: print(
+"Supported schemes (default is first, case "
+"sensitive):\n   %s." %
+", ".join(password.Password.known_schemes))
+if (args[0].find("=") != -1):
+args.insert(0, 'password')
+props.update(self.props_from_args(args[1:]))
+if args[0] == "password":
+try:
+# convert 10,000,000 or 10.000.000 to 10000000
+r = int(re.sub('[,.]', '', props['rounds']))
+if r < 1000:
+print(_("Invalid 'rounds'. Must be larger than 999."))
+return
+props['rounds'] = r
+except (TypeError, ValueError):
+print(_("Invalid 'rounds'. It must be an integer not: %s") %
+props['rounds'])
+return
+if props['scheme'] is None:
+print_supported_schemes()
+return
+self.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = props['rounds']
+try:
+tic = perf_counter()
+pw_hash = password.encodePassword(
+"this is a long password to hash",
+props['scheme'],
+None,
+config=self.db.config
+)
+toc = perf_counter()
+except password.PasswordValueError as e:
+print(e)
+print_supported_schemes()
+return
+if props['scheme'].startswith('PBKDF2'):
+(rounds, salt, _raw_salt, digest) = password.pbkdf2_unpack(
+pw_hash)
+else:
+rounds = _("scheme does not support rounds.")
+print(_(
+"Hash time: %(time)0.9f seconds, scheme: %(scheme)s, "
+"rounds: %(rounds)s") %
+{"time": toc-tic, "scheme": props['scheme'],
+"rounds": rounds})
+designator_re = re.compile('([A-Za-z]+)([0-9]+)')
+def do_reindex(self, args, desre=designator_re):
+''"""Usage: reindex [classname|designator]*
+Re-generate a tracker's search indexes.
+This will re-generate the search indexes for a tracker.
+This will typically happen automatically.
+"""
+if args:
+for arg in args:
+m = desre.match(arg)
+if m:
+cl = self.get_class(m.group(1))
 try:
-propname, width = spec.split(':')
+cl.index(m.group(2))
-except (ValueError, TypeError):
+except IndexError:
-raise UsageError(_('"%(spec)s" not '
+raise UsageError(_('no such item "%(designator)s"') % {
-'name:width') % locals())
+'designator': arg})
 else:
-propname = spec
+cl = self.get_class(arg)
-if propname not in all_props:
+self.db.reindex(arg)
-raise UsageError(_('%(classname)s has no property '
-'"%(propname)s"') % locals())
 else:
-prop_names = cl.getprops()
+self.db.reindex(show_progress=True)
-# now figure column widths
-props = []
-for spec in prop_names:
-if ':' in spec:
-name, width = spec.split(':')
-if width == '':
-# spec includes trailing :, use label/name width
-props.append((name, len(name)))
-else:
-try:
-props.append((name, int(width)))
-except ValueError:
-raise UsageError(_('"%(spec)s" does not have an '
-'integer width: "%(width)s"') %
-locals())
-else:
-# this is going to be slow
-maxlen = len(spec)
-for nodeid in cl.list():
-curlen = len(str(cl.get(nodeid, spec)))
-if curlen > maxlen:
-maxlen = curlen
-props.append((spec, maxlen))
-# now display the heading
-print(' '.join([name.capitalize().ljust(width)
-for name, width in props]))
-# and the table data
-for nodeid in cl.list():
-table_columns = []
-for name, width in props:
-if name != 'id':
-try:
-value = str(cl.get(nodeid, name))
-except KeyError:
-# we already checked if the property is valid - a
-# KeyError here means the node just doesn't have a
-# value for it
-value = ''
-else:
-value = str(nodeid)
-f = '%%-%ds' % width
-table_columns.append(f % value[:width])
-print(' '.join(table_columns))
-return 0
-def do_history(self, args):
-''"""Usage: history designator [skipquiet]
-Show the history entries of a designator.
-A designator is a classname and a nodeid concatenated,
-eg. bug1, user10, ...
-Lists the journal entries viewable by the user for the
-node identified by the designator. If skipquiet is the
-second argument, journal entries for quiet properties
-are not shown.
-"""
-if len(args) < 1:
-raise UsageError(_('Not enough arguments supplied'))
-try:
-classname, nodeid = hyperdb.splitDesignator(args[0])
-except hyperdb.DesignatorError as message:
-raise UsageError(message)
-skipquiet = False
-if len(args) == 2:
-if args[1] != 'skipquiet':
-raise UsageError("Second argument is not skipquiet")
-skipquiet = True
-try:
-print(self.db.getclass(classname).history(nodeid,
-skipquiet=skipquiet))
-except KeyError:
-raise UsageError(_('no such class "%(classname)s"') % locals())
-except IndexError:
-raise UsageError(_('no such %(classname)s node '
-'"%(nodeid)s"') % locals())
-return 0
-def do_commit(self, args):
-''"""Usage: commit
-Commit changes made to the database during an interactive session.
-The changes made during an interactive session are not
-automatically written to the database - they must be committed
-using this command.
-One-off commands on the command-line are automatically committed if
-they are successful.
-"""
-self.db.commit()
-self.db_uncommitted = False
-return 0
-def do_rollback(self, args):
-''"""Usage: rollback
-Undo all changes that are pending commit to the database.
-The changes made during an interactive session are not
-automatically written to the database - they must be committed
-manually. This command undoes all those changes, so a commit
-immediately after would make no changes to the database.
-"""
-self.db.rollback()
-self.db_uncommitted = False
-return 0
-def do_retire(self, args):
-''"""Usage: retire designator[,designator]*
-Retire the node specified by designator.
-A designator is a classname and a nodeid concatenated,
-eg. bug1, user10, ...
-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.
-"""
-if len(args) < 1:
-raise UsageError(_('Not enough arguments supplied'))
-designators = args[0].split(',')
-for designator in designators:
-try:
-classname, nodeid = hyperdb.splitDesignator(designator)
-except hyperdb.DesignatorError as message:
-raise UsageError(message)
-try:
-self.db.getclass(classname).retire(nodeid)
-except KeyError:
-raise UsageError(_('no such class "%(classname)s"') % locals())
-except IndexError:
-raise UsageError(_('no such %(classname)s node '
-'"%(nodeid)s"') % locals())
-self.db_uncommitted = True
 return 0
 def do_restore(self, args):
 ''"""Usage: restore designator[,designator]*
 Restore the retired node specified by designator.
 raise UsageError(_('no such %(classname)s node '
 '" % (nodeid)s"') % locals())
 self.db_uncommitted = True
 return 0
-def do_export(self, args, export_files=True):
+def do_retire(self, args):
-''"""Usage: export [[-]class[,class]] export_dir
+''"""Usage: retire designator[,designator]*
-Export the database to colon-separated-value files.
+Retire the node specified by designator.
-To exclude the files (e.g. for the msg or file class),
-use the exporttables command.
+A designator is a classname and a nodeid concatenated,
+eg. bug1, user10, ...
-Optionally limit the export to just the named classes
-or exclude the named classes, if the 1st argument starts with '-'.
+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.
-This action exports the current data from the database into
+"""
-colon-separated-value files that are placed in the nominated
-destination directory.
-"""
-# grab the directory to export to
 if len(args) < 1:
 raise UsageError(_('Not enough arguments supplied'))
+designators = args[0].split(',')
-dir = args[-1]
+for designator in designators:
+try:
-# get the list of classes to export
+classname, nodeid = hyperdb.splitDesignator(designator)
-if len(args) == 2:
+except hyperdb.DesignatorError as message:
-if args[0].startswith('-'):
+raise UsageError(message)
-classes = [c for c in self.db.classes
+try:
-if c not in args[0][1:].split(',')]
+self.db.getclass(classname).retire(nodeid)
-else:
+except KeyError:
-classes = args[0].split(',')
+raise UsageError(_('no such class "%(classname)s"') % locals())
-else:
+except IndexError:
-classes = self.db.classes
+raise UsageError(_('no such %(classname)s node '
+'"%(nodeid)s"') % locals())
-class colon_separated(csv.excel):
-delimiter = ':'
-# make sure target dir exists
-if not os.path.exists(dir):
-os.makedirs(dir)
-# maximum csv field length exceeding configured size?
-max_len = self.db.config.CSV_FIELD_SIZE
-# do all the classes specified
-for classname in classes:
-cl = self.get_class(classname)
-if not export_files and hasattr(cl, 'export_files'):
-sys.stdout.write('Exporting %s WITHOUT the files\r\n' %
-classname)
-with open(os.path.join(dir, classname+'.csv'), 'w') as f:
-writer = csv.writer(f, colon_separated)
-propnames = cl.export_propnames()
-fields = propnames[:]
-fields.append('is retired')
-writer.writerow(fields)
-# If a node has a key, sort all nodes by key
-# with retired nodes first. Retired nodes
-# must occur before a non-retired node with
-# the same key. Otherwise you get an
-# IntegrityError: UNIQUE constraint failed:
-#     _class.__retired__, _<class>._<keyname>
-# on imports to rdbms.
-all_nodes = cl.getnodeids()
-classkey = cl.getkey()
-if classkey:  # False sorts before True, so negate is_retired
-keysort = lambda i: (cl.get(i, classkey),  # noqa: E731
-not cl.is_retired(i))
-all_nodes.sort(key=keysort)
-# if there is no classkey no need to sort
-for nodeid in all_nodes:
-if self.verbose:
-sys.stdout.write('\rExporting %s - %s' %
-(classname, nodeid))
-sys.stdout.flush()
-node = cl.getnode(nodeid)
-exp = cl.export_list(propnames, nodeid)
-lensum = sum([len(repr_export(node[p])) for
-p in propnames])
-# for a safe upper bound of field length we add
-# difference between CSV len and sum of all field lengths
-d = sum([len(x) for x in exp]) - lensum
-if not d > 0:
-raise AssertionError("Bad assertion d > 0")
-for p in propnames:
-ll = len(repr_export(node[p])) + d
-if ll > max_len:
-max_len = ll
-writer.writerow(exp)
-if export_files and hasattr(cl, 'export_files'):
-cl.export_files(dir, nodeid)
-# export the journals
-with open(os.path.join(dir, classname+'-journals.csv'), 'w') as jf:
-if self.verbose:
-sys.stdout.write("\nExporting Journal for %s\n" %
-classname)
-sys.stdout.flush()
-journals = csv.writer(jf, colon_separated)
-for row in cl.export_journals():
-journals.writerow(row)
-if max_len > self.db.config.CSV_FIELD_SIZE:
-print("Warning: config csv_field_size should be at least %s" %
-max_len, file=sys.stderr)
-return 0
-def do_exporttables(self, args):
-''"""Usage: exporttables [[-]class[,class]] export_dir
-Export the database to colon-separated-value files, excluding the
-files below $TRACKER_HOME/db/files/ (which can be archived separately).
-To include the files, use the export command.
-Optionally limit the export to just the named classes
-or exclude the named classes, if the 1st argument starts with '-'.
-This action exports the current data from the database into
-colon-separated-value files that are placed in the nominated
-destination directory.
-"""
-return self.do_export(args, export_files=False)
-def do_import(self, args, import_files=True):
-''"""Usage: import import_dir
-Import a database from the directory containing CSV files,
-two per class to import.
-The files used in the import are:
-<class>.csv
-This must define the same properties as the class (including
-having a "header" line with those property names.)
-<class>-journals.csv
-This defines the journals for the items being imported.
-The imported nodes will have the same nodeid as defined in the
-import file, thus replacing any existing content.
-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) < 1:
-raise UsageError(_('Not enough arguments supplied'))
-if hasattr(csv, 'field_size_limit'):
-csv.field_size_limit(self.db.config.CSV_FIELD_SIZE)
-# directory to import from
-dir = args[0]
-class colon_separated(csv.excel):
-delimiter = ':'
-# import all the files
-for file in os.listdir(dir):
-classname, ext = os.path.splitext(file)
-# we only care about CSV files
-if ext != '.csv' or classname.endswith('-journals'):
-continue
-cl = self.get_class(classname)
-# ensure that the properties and the CSV file headings match
-with open(os.path.join(dir, file), 'r') as f:
-reader = csv.reader(f, colon_separated)
-file_props = None
-maxid = 1
-# loop through the file and create a node for each entry
-for n, r in enumerate(reader):
-if file_props is None:
-file_props = r
-continue
-if self.verbose:
-sys.stdout.write('\rImporting %s - %s' % (classname, n))
-sys.stdout.flush()
-# do the import and figure the current highest nodeid
-nodeid = cl.import_list(file_props, r)
-if hasattr(cl, 'import_files') and import_files:
-cl.import_files(dir, nodeid)
-maxid = max(maxid, int(nodeid))
-# (print to sys.stdout here to allow tests to squash it .. ugh)
-print(file=sys.stdout)
-# import the journals
-with open(os.path.join(args[0], classname + '-journals.csv'), 'r') as f:
-reader = csv.reader(f, colon_separated)
-cl.import_journals(reader)
-# (print to sys.stdout here to allow tests to squash it .. ugh)
-print('setting', classname, maxid+1, file=sys.stdout)
-# set the id counter
-self.db.setid(classname, str(maxid+1))
 self.db_uncommitted = True
 return 0
-def do_importtables(self, args):
+def do_rollback(self, args):
-''"""Usage: importtables export_dir
+''"""Usage: rollback
+Undo all changes that are pending commit to the database.
-This imports the database tables exported using exporttables.
-"""
+The changes made during an interactive session are not
-return self.do_import(args, import_files=False)
+automatically written to the database - they must be committed
+manually. This command undoes all those changes, so a commit
-def do_pack(self, args):
+immediately after would make no changes to the database.
-''"""Usage: pack period | date
+"""
+self.db.rollback()
-Remove journal entries older than a period of time specified or
+self.db_uncommitted = False
-before a certain date.
-A period is specified using the suffixes "y", "m", and "d". The
-suffix "w" (for "week") means 7 days.
-"3y" means three years
-"2y 1m" means two years and one month
-"1m 25d" means one month and 25 days
-"2w 3d" means two weeks and three days
-Date format is "YYYY-MM-DD" eg:
-2001-01-01
-"""
-if len(args) != 1:
-raise UsageError(_('Not enough arguments supplied'))
-# are we dealing with a period or a date
-value = args[0]
-date_re = re.compile(r"""
-(?P<date>\d\d\d\d-\d\d?-\d\d?)? # yyyy-mm-dd
-(?P<period>(\d+y\s*)?(\d+m\s*)?(\d+d\s*)?)?
-""", re.VERBOSE)
-m = date_re.match(value)
-if not m:
-raise ValueError(_('Invalid format'))
-m = m.groupdict()
-if m['period']:
-pack_before = date.Date(". - %s" % value)
-elif m['date']:
-pack_before = date.Date(value)
-self.db.pack(pack_before)
-self.db_uncommitted = True
-return 0
-designator_re = re.compile('([A-Za-z]+)([0-9]+)')
-def do_reindex(self, args, desre=designator_re):
-''"""Usage: reindex [classname|designator]*
-Re-generate a tracker's search indexes.
-This will re-generate the search indexes for a tracker.
-This will typically happen automatically.
-"""
-if args:
-for arg in args:
-m = desre.match(arg)
-if m:
-cl = self.get_class(m.group(1))
-try:
-cl.index(m.group(2))
-except IndexError:
-raise UsageError(_('no such item "%(designator)s"') % {
-'designator': arg})
-else:
-cl = self.get_class(arg)
-self.db.reindex(arg)
-else:
-self.db.reindex(show_progress=True)
 return 0
 def do_security(self, args):
 ''"""Usage: security [Role name]
 '"%(klass)s" only)\n') % d)
 else:
 sys.stdout.write(_(' %(description)s (%(name)s)\n') % d)
 return 0
-def do_migrate(self, args):
+def do_set(self, args):
-''"""Usage: migrate
+''"""Usage: set items property=value property=value ...
+Set the given properties of one or more items(s).
-Update a tracker's database to be compatible with the Roundup
-codebase.
+The items are specified as a class or as a comma-separated
+list of item designators (ie "designator[,designator,...]").
-You should run the "migrate" command for your tracker once
-you've installed the latest codebase.
+A designator is a classname and a nodeid concatenated,
+eg. bug1, user10, ...
-Do this before you use the web, command-line or mail interface
-and before any users access the tracker.
+This command sets the properties to the values for all
+designators given. If a class is used, the property will be
-This command will respond with either "Tracker updated" (if
+set for all items in the class. If the value is missing
-you've not previously run it on an RDBMS backend) or "No
+(ie. "property=") then the property is un-set. If the property
-migration action required" (if you have run it, or have used
+is a multilink, you specify the linked ids for the multilink
-another interface to the tracker, or possibly because you are
+as comma-separated numbers (ie "1,2,3").
-using anydbm).
+"""
-It's safe to run this even if it's not required, so just get
+import copy  # needed for copying props list
-into the habit.
-"""
+if len(args) < 2:
-if self.db.db_version_updated:
+raise UsageError(_('Not enough arguments supplied'))
-print(_('Tracker updated to schema version %s.') %
+from roundup import hyperdb
-self.db.database_schema['version'])
-self.db_uncommitted = True
+designators = args[0].split(',')
+if len(designators) == 1:
+designator = designators[0]
+try:
+designator = hyperdb.splitDesignator(designator)
+designators = [designator]
+except hyperdb.DesignatorError:
+cl = self.get_class(designator)
+designators = [(designator, x) for x in cl.list()]
 else:
-print(_('No migration action required. At schema version %s.') %
-self.db.database_schema['version'])
-return 0
-def do_perftest(self, args):
-''"""Usage: perftest [mode] [arguments]*
-Time operations in Roundup. Supported arguments:
-[password] [rounds=<integer>] [scheme=<scheme>]
-'password' is the default mode.  The tracker's config.ini
-setting for 'password_pbkdf2_default_rounds' is the default
-value for 'rounds'. On the command line, 'rounds' can include
-thousands separator of ',' or '.'.  'scheme' is the default
-coded into Roundup. List supported schemes by using 'scheme='.
-"""
-from roundup.anypy.time_ import perf_counter
-props = {"rounds": self.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS,
-"scheme": password.Password.known_schemes[0]}
-print_supported_schemes = lambda: print(
-"Supported schemes (default is first, case "
-"sensitive):\n   %s." %
-", ".join(password.Password.known_schemes))
-if (args[0].find("=") != -1):
-args.insert(0, 'password')
-props.update(self.props_from_args(args[1:]))
-if args[0] == "password":
 try:
-# convert 10,000,000 or 10.000.000 to 10000000
+designators = [hyperdb.splitDesignator(x) for x in designators]
-r = int(re.sub('[,.]', '', props['rounds']))
+except hyperdb.DesignatorError as message:
-if r < 1000:
+raise UsageError(message)
-print(_("Invalid 'rounds'. Must be larger than 999."))
-return
+# get the props from the args
-props['rounds'] = r
+propset = self.props_from_args(args[1:])  # parse the cli once
-except (TypeError, ValueError):
-print(_("Invalid 'rounds'. It must be an integer not: %s") %
+# now do the set for all the nodes
-props['rounds'])
+for classname, itemid in designators:
-return
+props = copy.copy(propset)  # make a new copy for every designator
-if props['scheme'] is None:
+cl = self.get_class(classname)
-print_supported_schemes()
-return
+for key, value in list(props.items()):
+try:
-self.db.config.PASSWORD_PBKDF2_DEFAULT_ROUNDS = props['rounds']
+# You must reinitialize the props every time though.
+# if props['nosy'] = '+admin' initally, it gets
+# set to 'demo,admin' (assuming it was set to demo
+# in the db) after rawToHyperdb returns.
+# This  new value is used for all the rest of the
+# designators if not reinitalized.
+props[key] = hyperdb.rawToHyperdb(self.db, cl, itemid,
+key, value)
+except hyperdb.HyperdbValueError as message:
+raise UsageError(message)
+# try the set
 try:
-tic = perf_counter()
+cl.set(itemid, **props)
-pw_hash = password.encodePassword(
+except (TypeError, IndexError, ValueError) as message:
-"this is a long password to hash",
+raise UsageError(message)
-props['scheme'],
+self.db_uncommitted = True
-None,
+return 0
-config=self.db.config
-)
+def do_specification(self, args):
-toc = perf_counter()
+''"""Usage: specification classname
-except password.PasswordValueError as e:
+Show the properties for a classname.
-print(e)
-print_supported_schemes()
+This lists the properties for a given class.
-return
+"""
+if len(args) < 1:
-if props['scheme'].startswith('PBKDF2'):
+raise UsageError(_('Not enough arguments supplied'))
-(rounds, salt, _raw_salt, digest) = password.pbkdf2_unpack(
+classname = args[0]
-pw_hash)
+# get the class
+cl = self.get_class(classname)
+# get the key property
+keyprop = cl.getkey()
+for key in cl.properties:
+value = cl.properties[key]
+if keyprop == key:
+sys.stdout.write(_('%(key)s: %(value)s (key property)\n') %
+locals())
 else:
-rounds = _("scheme does not support rounds.")
+sys.stdout.write(_('%(key)s: %(value)s\n') % locals())
-print(_(
+def do_table(self, args):
-"Hash time: %(time)0.9f seconds, scheme: %(scheme)s, "
+''"""Usage: table classname [property[,property]*]
-"rounds: %(rounds)s") %
+List the instances of a class in tabular form.
-{"time": toc-tic, "scheme": props['scheme'],
-"rounds": rounds})
+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 largest value. 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
+Also to make the width of the column the width of the label,
+leave a trailing : without a width on the property. For example::
+roundup> table priority id,name:
+Id Name
+1  fata
+2  bug
+3  usab
+4  feat
+will result in a the 4 character wide "Name" column.
+"""
+if len(args) < 1:
+raise UsageError(_('Not enough arguments supplied'))
+classname = args[0]
+# get the class
+cl = self.get_class(classname)
+# figure the property names to display
+if len(args) > 1:
+prop_names = args[1].split(',')
+all_props = cl.getprops()
+for spec in prop_names:
+if ':' in spec:
+try:
+propname, width = spec.split(':')
+except (ValueError, TypeError):
+raise UsageError(_('"%(spec)s" not '
+'name:width') % locals())
+else:
+propname = spec
+if propname not in all_props:
+raise UsageError(_('%(classname)s has no property '
+'"%(propname)s"') % locals())
+else:
+prop_names = cl.getprops()
+# now figure column widths
+props = []
+for spec in prop_names:
+if ':' in spec:
+name, width = spec.split(':')
+if width == '':
+# spec includes trailing :, use label/name width
+props.append((name, len(name)))
+else:
+try:
+props.append((name, int(width)))
+except ValueError:
+raise UsageError(_('"%(spec)s" does not have an '
+'integer width: "%(width)s"') %
+locals())
+else:
+# this is going to be slow
+maxlen = len(spec)
+for nodeid in cl.list():
+curlen = len(str(cl.get(nodeid, spec)))
+if curlen > maxlen:
+maxlen = curlen
+props.append((spec, maxlen))
+# now display the heading
+print(' '.join([name.capitalize().ljust(width)
+for name, width in props]))
+# and the table data
+for nodeid in cl.list():
+table_columns = []
+for name, width in props:
+if name != 'id':
+try:
+value = str(cl.get(nodeid, name))
+except KeyError:
+# we already checked if the property is valid - a
+# KeyError here means the node just doesn't have a
+# value for it
+value = ''
+else:
+value = str(nodeid)
+f = '%%-%ds' % width
+table_columns.append(f % value[:width])
+print(' '.join(table_columns))
+return 0
+def do_templates(self, args):
+''"""Usage: templates [trace_search]
+List templates and their installed directories.
+With trace_search also list all directories that are
+searched for templates.
+"""
+import textwrap
+trace_search = False
+if args and args[0] == "trace_search":
+trace_search = True
+templates = self.listTemplates(trace_search=trace_search)
+for name in sorted(list(templates.keys())):
+templates[name]['description'] = textwrap.fill(
+"\n".join([line.lstrip() for line in
+templates[name]['description'].split("\n")]),
+70,
+subsequent_indent="      "
+)
+print("""
+Name: %(name)s
+Path: %(path)s
+Desc: %(description)s
+""" % templates[name])
+def do_updateconfig(self, args):
+''"""Usage: updateconfig <filename>
+Generate an updated tracker config file (ini style) in
+<filename>. Use current settings from existing roundup
+tracker in tracker home.
+"""
+self.do_genconfig(args, update=True)
 def run_command(self, args):
 """Run a single command
 """
 command = args[0]

Mercurial > p > roundup > code

comparison roundup/admin.py @ 7250:ee972b3073cb