def remove_all_account_manager_components_from_config(self):
env = self._testenv.get_trac_environment()
components = AgiloConfig(env).get_section('components')
for name in components.get_options_by_prefix('acct_mgr',
chop_prefix=False):
components.remove_option(name, save=False)
components.save()
def remove_all_account_manager_components_from_config(self):
env = self._testenv.get_trac_environment()
components = AgiloConfig(env).get_section('components')
for name in components.get_options_by_prefix('acct_mgr', chop_prefix=False):
components.remove_option(name, save=False)
components.save()
class CustomFields(Component):
""" These methods should be part of TicketSystem API/Data Model.
Adds update_custom_field and delete_custom_field methods.
(The get_custom_fields is already part of the API - just redirect here,
and add option to only get one named field back.)
"""
def __init__(self, *args, **kwargs):
"""Initialize the component and set a TracConfig"""
self.ticket_custom = \
AgiloConfig(self.env).get_section(AgiloConfig.TICKET_CUSTOM)
def get_custom_fields(self, field_name=None):
"""
Returns the custom fields from TicketSystem component.
Use a field name to find a specific custom field only
"""
if not field_name: # return full list
return AgiloTicketSystem(self.env).get_custom_fields()
else: # only return specific item with cfname
all = AgiloTicketSystem(self.env).get_custom_fields()
for item in all:
if item[Key.NAME] == field_name:
return item
return None # item not found
def _store_all_options_for_custom_field(self, customfield):
added_keys = list()
changed = False
for key in customfield:
if key == Key.NAME:
continue
elif key == Key.TYPE:
config_key = customfield[Key.NAME]
else:
config_key = '%s.%s' % (customfield[Key.NAME], key)
value = customfield[key]
if isinstance(value, list):
value = '|'.join(value)
if value not in ['', None]:
changed = True
self.ticket_custom.change_option(config_key, value, save=False)
added_keys.append(key)
if changed:
self._remove_old_keys(customfield[Key.NAME], added_keys)
self.ticket_custom.save()
def _del_custom_field_value(self, customfield, prop=None):
"""Deletes a property from a custom field"""
if not prop:
self.ticket_custom.remove_option(customfield[Key.NAME])
else:
self.ticket_custom.remove_option('%s.%s' % (customfield[Key.NAME], prop))
def _validate_input(self, customfield, create):
"""Checks the input values and raises a TracError if severe problems
are detected."""
# Name, Type are required
if not (customfield.get(Key.NAME) and customfield.get(Key.TYPE)):
raise TracError("Custom field needs at least a name and type.")
# Use lowercase custom fieldnames only
f_name = unicode(customfield[Key.NAME]).lower()
# Only alphanumeric characters (and [-_]) allowed for custom fieldname
if re.search('^[a-z0-9-_]+$', f_name) == None:
raise TracError("Only alphanumeric characters allowed for custom field name (a-z or 0-9 or -_).")
# If Create, check that field does not already exist
if create and self.ticket_custom.get(f_name):
raise TracError("Can not create as field already exists.")
# Check that it is a valid field type
f_type = customfield[Key.TYPE]
if not f_type in ('text', 'checkbox', 'select', 'radio', 'textarea'):
raise TracError("%s is not a valid field type" % f_type)
if (Key.ORDER in customfield) and (not str(customfield.get(Key.ORDER)).isdigit()):
raise TracError("%s is not a valid number for %s" % (customfield.get(Key.ORDER), Key.ORDER))
customfield[Key.NAME] = f_name
def update_custom_field(self, customfield, create=False):
"""
Update or create a new custom field (if requested).
customfield is a dictionary with the following possible keys:
name = name of field (alphanumeric only)
type = text|checkbox|select|radio|textarea
label = label description
value = default value for field content
options = options for select and radio types (list, leave first empty for optional)
cols = number of columns for text area
rows = number of rows for text area
order = specify sort order for field
"""
self._validate_input(customfield, create)
f_type = customfield[Key.TYPE]
if f_type == 'textarea':
def set_default_value(key, default):
if (key not in customfield) or \
(not unicode(customfield[key]).isdigit()):
customfield[key] = unicode(default)
# dwt: why is this called twice?
set_default_value(Key.COLS, 60)
set_default_value(Key.COLS, 5)
if create:
number_of_custom_fields = len(self.get_custom_fields())
# We assume that the currently added custom field is not present in
# the return value of get_custom_fields and we start counting from 0
customfield[Key.ORDER] = str(number_of_custom_fields)
self._store_all_options_for_custom_field(customfield)
AgiloTicketSystem(self.env).reset_ticket_fields()
# TODO: Check that you can change the type from select to something different
# and the options are gone afterwards
def _set_custom_field_value(self, customfield, prop=None):
"""Sets a value in the custom fields for a given property key"""
config_key = value = None
if prop:
value = customfield.get(prop)
if isinstance(value, list):
value = '|'.join(value)
config_key = '%s.%s' % (customfield[Key.NAME], prop)
else:
# Used to set the type
config_key = customfield[Key.NAME]
value = customfield[Key.TYPE]
self.ticket_custom.change_option(config_key, value)
def _remove_old_keys(self, fieldname, added_keys):
for key in (Key.VALUE, Key.OPTIONS, Key.COLS, Key.ROWS):
if key not in added_keys:
self.ticket_custom.remove_option('%s.%s' % (fieldname, key),
save=False)
def delete_custom_field(self, field_name):
"""Deletes a custom field"""
if not self.ticket_custom.get(field_name):
return # Nothing to do here - cannot find field
# Need to redo the order of fields that are after the field to be deleted
order_to_delete = self.ticket_custom.get_int('%s.%s' % (field_name, Key.ORDER))
cfs = self.get_custom_fields()
for field in cfs:
if field[Key.ORDER] > order_to_delete:
field[Key.ORDER] -= 1
self._set_custom_field_value(field, Key.ORDER)
elif field[Key.NAME] == field_name:
# Remove any data for the custom field (covering all bases)
self._del_custom_field_value(field)
# Save settings
self.ticket_custom.save()
AgiloTicketSystem(self.env).reset_ticket_fields()
