Remove .state and .*_state on Document in favour of generic states

mapping, port the codebase to use these states
 - Legacy-Id: 3660

Author: OleLaursen

ietf/idrfc/expire.py

@@ -4,14 +4,14 @@
 from django.template.loader import render_to_string
 from django.db.models import Q
 
-import datetime, os, shutil, glob, re
+import datetime, os, shutil, glob, re, itertools
 
 from ietf.idtracker.models import InternetDraft, IDDates, IDStatus, IDState, DocumentComment, IDAuthor,WGChair
 from ietf.utils.mail import send_mail, send_mail_subj
 from ietf.idrfc.utils import log_state_changed, add_document_comment
-from doc.models import Document, DocEvent, save_document_in_history
-from name.models import IesgDocStateName, DocStateName, DocTagName
-from person.models import Person, Email
+from redesign.doc.models import Document, DocEvent, save_document_in_history, State
+from redesign.name.models import DocTagName
+from redesign.person.models import Person, Email
 
 INTERNET_DRAFT_DAYS_TO_EXPIRE = 185
 
@@ -36,7 +36,11 @@ def document_expires(doc):
         return None
 
 def expirable_documents():
-    return Document.objects.filter(state="active").exclude(tags="rfc-rev").filter(Q(iesg_state=None) | Q(iesg_state__order__gte=42))
+    d = Document.objects.filter(states__type="draft", states__slug="active").exclude(tags="rfc-rev")
+    # we need to get those that either don't have a state or have a
+    # state >= 42 (AD watching), unfortunately that doesn't appear to
+    # be possible to get to work directly in Django 1.1
+    return itertools.chain(d.exclude(states__type="draft-iesg").distinct(), d.filter(states__type="draft-iesg", states__order__gte=42).distinct())
 
 def get_soon_to_expire_ids(days):
     start_date = datetime.date.today() - datetime.timedelta(InternetDraft.DAYS_TO_EXPIRE - 1)
@@ -104,7 +108,8 @@ def send_expire_warning_for_idREDESIGN(doc):
     if doc.group.type_id != "individ":
         cc = [e.formatted_email() for e in Email.objects.filter(role__group=doc.group, role__name="chair") if not e.address.startswith("unknown-email")]
 
-    state = doc.iesg_state.name if doc.iesg_state else "I-D Exists"
+    s = doc.get_state("draft-iesg")
+    state = s.name if s else "I-D Exists"
 
     frm = None
     request = None
@@ -138,8 +143,9 @@ def send_expire_notice_for_idREDESIGN(doc):
     if not doc.ad:
         return
 
-    state = doc.iesg_state.name if doc.iesg_state else "I-D Exists"
-    
+    s = doc.get_state("draft-iesg")
+    state = s.name if s else "I-D Exists"
+
     request = None
     to = doc.ad.formatted_email()
     send_mail(request, to,
@@ -216,10 +222,10 @@ def move_file(f):
 
     save_document_in_history(doc)
     if doc.latest_event(type='started_iesg_process'):
-        dead_state = IesgDocStateName.objects.get(slug="dead")
-        if doc.iesg_state != dead_state:
-            prev = doc.iesg_state
-            doc.iesg_state = dead_state
+        dead_state = State.objects.get(type="draft-iesg", slug="dead")
+        prev = doc.get_state("draft-iesg")
+        if prev != dead_state:
+            doc.set_state(dead_state)
             log_state_changed(None, doc, system, prev)
 
         e = DocEvent(doc=doc, by=system)
@@ -228,7 +234,7 @@ def move_file(f):
         e.save()
 
     doc.rev = new_revision # FIXME: incrementing the revision like this is messed up
-    doc.state = DocStateName.objects.get(slug="expired")
+    doc.set_state(State.objects.get(type="draft", slug="expired"))
     doc.time = datetime.datetime.now()
     doc.save()
 
@@ -334,10 +340,10 @@ def move_file_to(subdir):
         try:
             doc = Document.objects.get(name=filename, rev=revision)
 
-            if doc.state_id == "rfc":
+            if doc.get_state_slug() == "rfc":
                 if ext != ".txt":
                     move_file_to("unknown_ids")
-            elif doc.state_id in ("expired", "auth-rm", "repl", "ietf-rm"):
+            elif doc.get_state_slug() in ("expired", "repl", "auth-rm", "ietf-rm"):
                 e = doc.latest_event(type__in=('expired_document', 'new_revision', "completed_resurrect"))
                 expiration_date = e.time.date() if e and e.type == "expired_document" else None
 

ietf/idrfc/idrfc_wrapper.py

@@ -121,11 +121,11 @@ def __init__(self, draft):
 
     def rfc_editor_state(self):
         if settings.USE_DB_REDESIGN_PROXY_CLASSES:
-            if self._draft.rfc_state:
+            s = self._draft.get_state("draft-rfceditor")
+            if s:
                 # extract possible extra states
                 tags = self._draft.tags.filter(slug__in=("iana-crd", "ref", "missref"))
-                s = [self._draft.rfc_state.name] + [t.slug.replace("-crd", "").upper() for t in tags]
-                return " ".join(s)
+                return " ".join([s.name] + [t.slug.replace("-crd", "").upper() for t in tags])
             else:
                 return None
 

ietf/idrfc/lastcall.py

@@ -8,8 +8,7 @@
 from ietf.idrfc.mails import *
 from ietf.idrfc.utils import *
 
-from doc.models import Document, DocEvent, LastCallDocEvent, WriteupDocEvent, save_document_in_history
-from name.models import IesgDocStateName
+from doc.models import Document, DocEvent, LastCallDocEvent, WriteupDocEvent, save_document_in_history, State
 from person.models import Person
 
 def request_last_call(request, doc):
@@ -47,7 +46,7 @@ def get_expired_last_calls():
 
 def get_expired_last_callsREDESIGN():
     today = datetime.date.today()
-    for d in Document.objects.filter(iesg_state="lc"):
+    for d in Document.objects.filter(states__type="draft-iesg", states__slug="lc"):
         e = d.latest_event(LastCallDocEvent, type="sent_last_call")
         if e and e.expires.date() <= today:
             yield d
@@ -71,18 +70,18 @@ def expire_last_call(doc):
     email_last_call_expired(doc)
 
 def expire_last_callREDESIGN(doc):
-    state = IesgDocStateName.objects.get(slug="writeupw")
+    state = State.objects.get(type="draft-iesg", slug="writeupw")
 
     e = doc.latest_event(WriteupDocEvent, type="changed_ballot_writeup_text")
     if e and "What does this protocol do and why" not in e.text:
-        # if it boiler-plate text has been removed, we assume the
+        # if boiler-plate text has been removed, we assume the
         # write-up has been written
-        state = IesgDocStateName.objects.get(slug="goaheadw")
+        state = State.objects.get(type="draft-iesg", slug="goaheadw")
 
     save_document_in_history(doc)
 
-    prev = doc.iesg_state
-    doc.iesg_state = state
+    prev = doc.get_state("draft-iesg")
+    doc.set_state(state)
     e = log_state_changed(None, doc, Person.objects.get(name="(System)"), prev)
 
     doc.time = e.time

ietf/idrfc/mails.py

@@ -269,7 +269,7 @@ def generate_approval_mail_rfc_editor(request, doc):
 DO_NOT_PUBLISH_IESG_STATES = ("nopubadw", "nopubanw")
 
 def generate_approval_mailREDESIGN(request, doc):
-    if doc.iesg_state_id in DO_NOT_PUBLISH_IESG_STATES or doc.tags.filter(slug='via-rfc'):
+    if doc.get_state_slug("draft-iesg") in DO_NOT_PUBLISH_IESG_STATES or doc.tags.filter(slug='via-rfc'):
         mail = generate_approval_mail_rfc_editor(request, doc)
     else:
         mail = generate_approval_mail_approved(request, doc)
@@ -320,7 +320,7 @@ def generate_approval_mail_approved(request, doc):
     else:
         contacts = "The IESG contact person is %s." % director.name
 
-    doc_type = "RFC" if doc.state_id == "rfc" else "Internet Draft"
+    doc_type = "RFC" if doc.get_state_slug() == "rfc" else "Internet Draft"
 
     return render_to_string("idrfc/approval_mail.txt",
                             dict(doc=doc,
@@ -338,8 +338,8 @@ def generate_approval_mail_approved(request, doc):
 def generate_approval_mail_rfc_editorREDESIGN(request, doc):
     full_status = full_intended_status(doc.intended_std_level.name)
     status = full_status.replace("a ", "").replace("an ", "")
-    disapproved = doc.iesg_state_id in DO_NOT_PUBLISH_IESG_STATES
-    doc_type = "RFC" if doc.state_id == "rfc" else "Internet Draft"
+    disapproved = doc.get_state_slug("draft-iesg") in DO_NOT_PUBLISH_IESG_STATES
+    doc_type = "RFC" if doc.get_state_slug() == "rfc" else "Internet Draft"
 
     return render_to_string("idrfc/approval_mail_rfc_editor.txt",
                             dict(doc=doc,
@@ -619,7 +619,7 @@ def email_last_call_expired(doc):
               cc="iesg-secretary@ietf.org")
 
 def email_last_call_expiredREDESIGN(doc):
-    text = "IETF Last Call has ended, and the state has been changed to\n%s." % doc.iesg_state.name
+    text = "IETF Last Call has ended, and the state has been changed to\n%s." % doc.get_state("draft-iesg").name
 
     send_mail(None,
               "iesg@ietf.org",

ietf/idrfc/mirror_rfc_editor_queue.py

@@ -197,8 +197,8 @@ def insert_into_database(drafts, refs):
 
 def get_rfc_tag_mapping():
     """Return dict with RFC Editor state name -> DocTagName"""
-    from name.models import DocTagName
-    from name.utils import name
+    from redesign.name.models import DocTagName
+    from redesign.name.utils import name
 
     return {
         'IANA': name(DocTagName, 'iana-crd', 'IANA coordination', "RFC-Editor/IANA Registration Coordination"),
@@ -207,22 +207,21 @@ def get_rfc_tag_mapping():
     }
 
 def get_rfc_state_mapping():
-    """Return dict with RFC Editor state name -> RfcDocStateName"""
-    from name.models import RfcDocStateName
-    from name.utils import name
-    
+    """Return dict with RFC Editor state name -> State"""
+    from redesign.doc.models import State, StateType
+    t = StateType.objects.get(slug="draft-rfceditor")
     return {
-        'AUTH': name(RfcDocStateName, 'auth', 'AUTH', "Awaiting author action"),
-        'AUTH48': name(RfcDocStateName, 'auth48', "AUTH48", "Awaiting final author approval"),
-        'EDIT': name(RfcDocStateName, 'edit', 'EDIT', "Approved by the stream manager (e.g., IESG, IAB, IRSG, ISE), awaiting processing and publishing"),
-        'IANA': name(RfcDocStateName, 'iana-crd', 'IANA', "RFC-Editor/IANA Registration Coordination"),
-        'IESG': name(RfcDocStateName, 'iesg', 'IESG', "Holding for IESG action"),
-        'ISR': name(RfcDocStateName, 'isr', 'ISR', "Independent Submission Review by the ISE "),
-        'ISR-AUTH': name(RfcDocStateName, 'isr-auth', 'ISR-AUTH', "Independent Submission awaiting author update, or in discussion between author and ISE"),
-        'REF': name(RfcDocStateName, 'ref', 'REF', "Holding for normative reference"),
-        'RFC-EDITOR': name(RfcDocStateName, 'rfc-edit', 'RFC-EDITOR', "Awaiting final RFC Editor review before AUTH48"),
-        'TO': name(RfcDocStateName, 'timeout', 'TO', "Time-out period during which the IESG reviews document for conflict/concurrence with other IETF working group work"),
-        'MISSREF': name(RfcDocStateName, 'missref', 'MISSREF', "Awaiting missing normative reference"),
+        'AUTH': State.objects.get_or_create(type=t, slug='auth', name='AUTH', desc="Awaiting author action")[0],
+        'AUTH48': State.objects.get_or_create(type=t, slug='auth48', name="AUTH48", desc="Awaiting final author approval")[0],
+        'EDIT': State.objects.get_or_create(type=t, slug='edit', name='EDIT', desc="Approved by the stream manager (e.g., IESG, IAB, IRSG, ISE), awaiting processing and publishing")[0],
+        'IANA': State.objects.get_or_create(type=t, slug='iana-crd', name='IANA', desc="RFC-Editor/IANA Registration Coordination")[0],
+        'IESG': State.objects.get_or_create(type=t, slug='iesg', name='IESG', desc="Holding for IESG action")[0],
+        'ISR': State.objects.get_or_create(type=t, slug='isr', name='ISR', desc="Independent Submission Review by the ISE ")[0],
+        'ISR-AUTH': State.objects.get_or_create(type=t, slug='isr-auth', name='ISR-AUTH', desc="Independent Submission awaiting author update, or in discussion between author and ISE")[0],
+        'REF': State.objects.get_or_create(type=t, slug='ref', name='REF', desc="Holding for normative reference")[0],
+        'RFC-EDITOR': State.objects.get_or_create(type=t, slug='rfc-edit', name='RFC-EDITOR', desc="Awaiting final RFC Editor review before AUTH48")[0],
+        'TO': State.objects.get_or_create(type=t, slug='timeout', name='TO', desc="Time-out period during which the IESG reviews document for conflict/concurrence with other IETF working group work")[0],
+        'MISSREF': State.objects.get_or_create(type=t, slug='missref', name='MISSREF', desc="Awaiting missing normative reference")[0],
     }
 
 
@@ -237,10 +236,9 @@ def insert_into_databaseREDESIGN(drafts, refs):
     rfc_editor_tags = tags.values()
 
     log("removing old data...")
-    for d in Document.objects.exclude(rfc_state=None).filter(tags__in=rfc_editor_tags):
+    for d in Document.objects.filter(states__type="draft-rfceditor").distinct():
         d.tags.remove(*rfc_editor_tags)
-
-    Document.objects.exclude(rfc_state=None).update(rfc_state=None)
+        d.unset_state("draft-rfceditor")
 
     log("inserting new data...")
 
@@ -254,8 +252,7 @@ def insert_into_databaseREDESIGN(drafts, refs):
         s = state.split(" ")
         if s:
             # first is state
-            d.rfc_state = states[s[0]]
-            d.save()
+            d.set_state(states[s[0]])
 
             # remainding are tags
             for x in s[1:]:

ietf/idrfc/mirror_rfc_index.py

@@ -178,11 +178,11 @@ def get_stream_mapping():
 
 @django.db.transaction.commit_on_success
 def insert_to_databaseREDESIGN(data):
-    from person.models import Person
-    from doc.models import Document, DocAlias, DocEvent, RelatedDocument
-    from group.models import Group
-    from name.models import DocTagName, DocRelationshipName
-    from name.utils import name
+    from redesign.person.models import Person
+    from redesign.doc.models import Document, DocAlias, DocEvent, RelatedDocument, State
+    from redesign.group.models import Group
+    from redesign.name.models import DocTagName, DocRelationshipName
+    from redesign.name.utils import name
 
     system = Person.objects.get(name="(System)")
     std_level_mapping = get_std_level_mapping()
@@ -242,8 +242,8 @@ def insert_to_databaseREDESIGN(data):
             doc.std_level = std_level_mapping[current_status]
             changed = True
 
-        if doc.state_id != "rfc":
-            doc.state_id = "rfc"
+        if doc.get_state_slug() != "rfc":
+            doc.set_state(State.objects.filter(type="draft", slug="rfc"))
             changed = True
 
         if doc.stream != stream_mapping[stream]: