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/superevents/utils.py

 from .models import Superevent, Log, Labelling
-from events.models import Event, EventLog
+from events.models import Event, EventLog, Tag
 from events.permission_utils import assign_default_perms
 
 import os
@@ -50,8 +50,11 @@ def create_superevent(submitter, t_start, t_0, t_end, preferred_event=None,
     creation_comment = ("Superevent created with t_start={t_start}, t_0={t_0},"
         " t_end={t_end}, preferred_event={preferred_event}").format(
         t_start=t_start, t_0=t_0, t_end=t_end, preferred_event=preferred_event)
+
     if events:
-        creation_comment += ", events={events}".format(", ".join(events))
+        creation_comment += ", events={events}".format(events=", ".join(
+            [ev.graceid() for ev in events]))
+
     # This is autogenerated, but people probably don't want to hide it
     # in the web interface
     superevent_creation_log = create_log(submitter, creation_comment, s,
@@ -109,7 +112,8 @@ def update_superevent(superevent, updater, issue_alert=True, **kwargs):
         issue_alert=False)
 
     # Write event log messages if preferred event changed
-    if (old_params['preferred_event'] != new_params['preferred_event']):
+    if new_params.has_key('preferred_event') and \
+        (old_params['preferred_event'] != new_params['preferred_event']):
         # Old preferred event
         old_msg = ("Removed as preferred event for superevent: "
             "{superevent_id}").format(superevent_id=superevent.superevent_id)
@@ -130,8 +134,7 @@ def update_superevent(superevent, updater, issue_alert=True, **kwargs):
 
 
 def create_log(issuer, comment, event_or_superevent, filename="",
-    data_file=None, file_version=None, tags=[], issue_alert=False,
-    autogenerated=False):
+    data_file=None, tags=[], issue_alert=False, autogenerated=False):
     """
     Assume data have already been validated by a form or serializer.
     tags should be a list of Tag objects (??)
@@ -202,8 +205,8 @@ def add_tag_to_log(log, tag, user, add_log_message=True, issue_alert=True):
 
     # Create log message to record tag addition?
     if add_log_message:
-        comment = 'Tagged message {N}: {tag_name}.'.format(N=log.N,
-            tag_name=tag.name),
+        comment = 'Tagged message {N}: {tag_name}'.format(N=log.N,
+            tag_name=tag.name)
         event_or_superevent = get_log_parent(log)
         log_for_tag_addition = create_log(user, comment, event_or_superevent,
             issue_alert=issue_alert, autogenerated=True)
@@ -217,7 +220,7 @@ def remove_tag_from_log(log, tag, user, add_log_message=True,
 
     # Create log message to record tag removal?
     if add_log_message:
-        comment = 'Removed tag {tag_name} from message {N}.'.format(
+        comment = 'Removed tag {tag_name} from message {N}'.format(
             N=log.N, tag_name=tag.name),
         event_or_superevent = get_log_parent(log)
         log_for_tag_removal = create_log(user, comment, event_or_superevent,
@@ -334,7 +337,7 @@ def remove_label_from_superevent(labelling, user, add_log_message=True,
     if add_log_message:
         # Record label addition in superevent logs
         comment = 'Removed label: {label_name}'.format(label_name=label_name)
-        log_for_label_removal = create_log(user, comment, superevent,
+        log_for_label_removal = create_log(user, comment, labelling.superevent,
             issue_alert=issue_alert, autogenerated=True)
 
     # TODO: send label alert (or update?) to superevent channel