Ticket #5641: ITicketCustomFieldValues.patch

trac/ticket/api.py

@@ -132 +132 @@
         ticket. Therefore, a return value of `[]` means everything is OK."""
 
 
+class ITicketCustomFieldValues(Interface):
+    """Allow for plugins to provide a list of possible values for custom fields."""
+
+    def get_values():
+        """Get a list of possible values for a custom field
+        
+        Must return a list of `(value, display)` tuples, one for each custom
+        value. `display` is currently ignored (e.g. just make it `None`)
+        but is included for future compatibility. A return value of `[]`
+        will suppress the display of the custom field"""
+
+
 class TicketContext(Context):
     """Context used for describing Ticket resources."""
 
@@ -176 +188 @@
         include_missing=False,
         doc="""Ordered list of workflow controllers to use for ticket actions
             (''since 0.11'').""")
+    custom_values = ExtensionPoint(ITicketCustomFieldValues)
 
     restrict_owner = BoolOption('ticket', 'restrict_owner', 'false',
         """Make the owner field of tickets use a drop-down menu. See
@@ -294 +307 @@
             }
             if field['type'] == 'select' or field['type'] == 'radio':
                 field['options'] = config.getlist(name + '.options', sep='|')
+                if len(field['options']) == 1 and field['options'][0].startswith('custom:'):
+                    custom_name = field['options'][0].split(':')[1]
+                    field['options'].pop()
+                    for custom_value in self.custom_values:
+                        if custom_value.__class__.__name__ == custom_name:
+                            for value,display in custom_value.get_values():
+                                field['options'].append(value)
+                            break
                 if '' in field['options']:
                     field['optional'] = True
                     field['options'].remove('')