Superevents

Adding superevents to GraceDB, including the necessary models, utility functions, and API resources. This has also resulted in changes to the overall configuration and some parts of the events model.

Many models in the events app, like Labels, Tags, EventLogs, etc. were needed in a similar form for superevents. We were able to completely reuse the existing Label and Tag models for superevents. In other cases, we had to abstract the main functionality of the class into an abstract base class and then implement separate models for events and superevents, due to foreign key requirements. This should leave the current functionality of the events models unchanged.

Some portions of the events API have been modified because of one of the following reasons:

• It didn't make sense and was unnecessarily difficult to duplicate for superevents
• It was inefficient or bad

These changes are documented here: https://bugs.ligo.org/redmine/issues/6133

gracedb/core/forms.py

+from django import forms
+from django.utils.translation import ugettext_lazy as _
+
+class ModelFormUpdateMixin(forms.ModelForm):
+    """
+    ModelForm mixin which provides the capability to update an existing model
+    object with input data which is incomplete - i.e., doesn't contain all
+    fields required by the form.
+
+    Usage:
+        # For a model with attributes 'attr1' and 'attr2 and a form that
+        # normally requires both attributes
+        data_dict = {'attr1': 'example'}
+        ExampleForm(data_dict, instance=model_instance)
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(ModelFormUpdateMixin, self).__init__(*args, **kwargs)
+
+        # If instance is provided, populate missing data
+        if self.instance.pk is not None:
+            self.populate_missing_data()
+
+    def get_instance_data(self):
+        # Should be overridden by concrete derived classes
+        return NotImplemented
+
+    def populate_missing_data(self):
+        """
+        Populate missing data fields from model instance.
+
+        NOTE: the actual data dictionary is populated, not initial data,
+        because missing fields in the input data would still be ignored.
+        """
+        if self.instance.pk is None:
+            self.add_error(None, _('Model instance not found'))
+
+        # Insert instance data for missing fields only
+        instance_data = self.get_instance_data()
+        for key in self.fields.keys():
+            if not self.data.has_key(key) and instance_data[key]:
+                self.data[key] = instance_data[key]