chore: first pass at clearing out canonical_name

Author: rjsparks

ietf/api/tests.py

@@ -993,7 +993,7 @@ def do_rfc_test(self, draft_name):
         )
 
         num_received = received
-        received = self.getJson(dict(name=rfc.canonical_name()))
+        received = self.getJson(dict(name=rfc.name))
         self.assertEqual(num_received, received, 'RFC by canonical name gives same result as by number')
 
         received = self.getJson(dict(name=f'RfC {number}'))
@@ -1032,7 +1032,7 @@ def test_rfc_with_tombstone(self):
         draft = reload_db_objects(draft)
 
         # Some old rfcs had tombstones that shouldn't be used for comparisons
-        received = self.getJson(dict(name=rfc.canonical_name()))
+        received = self.getJson(dict(name=rfc.name))
         self.assertTrue(received['previous'].endswith('00'))
 
     def do_rfc_with_broken_history_test(self, draft_name):
@@ -1048,7 +1048,7 @@ def do_rfc_with_broken_history_test(self, draft_name):
             received,
             dict(
                 content_url=rfc.get_href(),
-                name=rfc.canonical_name(),
+                name=rfc.name,
                 previous=f'{draft.name}-10',
                 previous_url= f'{settings.IETF_ID_ARCHIVE_URL}{draft.name}-10.txt',
             ),

ietf/bin/rfc-editor-index-updates

@@ -99,7 +99,7 @@ if newpid == 0:
         pipe("%s -a %s %s" % (settings.RSYNC_BINARY,settings.RFC_TEXT_RSYNC_SOURCE,settings.RFC_PATH))
         for rfc in new_rfcs:
             rebuild_reference_relations(rfc)
-            log("Updated references for %s"%rfc.canonical_name())
+            log("Updated references for %s"%rfc.name)
     except:
         subject = "Exception in updating references for new rfcs: %s : %s" % (sys.exc_info()[0],sys.exc_info()[1])
         msg = "%s\n%s\n----\n%s"%(sys.exc_info()[0],sys.exc_info()[1],traceback.format_tb(sys.exc_info()[2])) 

ietf/doc/admin.py

@@ -45,7 +45,7 @@ class RelatedDocumentInline(admin.TabularInline):
     model = RelatedDocument
     fk_name= 'source'
     def this(self, instance):
-        return instance.source.canonical_name()
+        return instance.source.name
     readonly_fields = ['this', ]
     fields = ['this', 'relationship', 'target', ]
     raw_id_fields = ['target']

ietf/doc/factories.py

@@ -119,12 +119,6 @@ def states(obj, create, extracted, **kwargs):
         else:
             obj.set_state(State.objects.get(type_id='rfc',slug='published'))
 
-    @factory.post_generation
-    def reset_canonical_name(obj, create, extracted, **kwargs): 
-        if hasattr(obj, '_canonical_name'):
-            del obj._canonical_name
-        return None
-
 
 class IndividualDraftFactory(BaseDocumentFactory):
 

ietf/doc/feeds.py

@@ -46,7 +46,7 @@ def link(self, obj):
             raise FeedDoesNotExist
         return urlreverse(
             "ietf.doc.views_doc.document_history",
-            kwargs=dict(name=obj.canonical_name()),
+            kwargs=dict(name=obj.name),
         )
 
     def subtitle(self, obj):
@@ -86,7 +86,7 @@ def item_link(self, item):
         return (
             urlreverse(
                 "ietf.doc.views_doc.document_history",
-                kwargs=dict(name=item.doc.canonical_name()),
+                kwargs=dict(name=item.doc.name),
             )
             + "#history-%s" % item.pk
         )
@@ -208,13 +208,13 @@ def items(self):
         return [doc for doc, time in results]
 
     def item_title(self, item):
-        return "%s : %s" % (item.canonical_name(), item.title)
+        return "%s : %s" % (item.name, item.title)
 
     def item_description(self, item):
         return item.abstract
 
     def item_link(self, item):
-        return "https://rfc-editor.org/info/%s" % item.canonical_name()
+        return "https://rfc-editor.org/info/%s" % item.name
 
     def item_pubdate(self, item):
         return item.publication_time
@@ -229,23 +229,23 @@ def item_extra_kwargs(self, item):
                 for fmt, media_type in [("txt", "text/plain"), ("html", "text/html")]:
                     media_contents.append(
                         {
-                            "url": f"https://rfc-editor.org/rfc/{item.canonical_name()}.{fmt}",
+                            "url": f"https://rfc-editor.org/rfc/{item.name}.{fmt}",
                             "media_type": media_type,
                             "is_format_of": self.item_link(item),
                         }
                     )
             if item.rfc_number not in [571, 587]:
                 media_contents.append(
                     {
-                        "url": f"https://www.rfc-editor.org/rfc/pdfrfc/{item.canonical_name()}.txt.pdf",
+                        "url": f"https://www.rfc-editor.org/rfc/pdfrfc/{item.name}.txt.pdf",
                         "media_type": "application/pdf",
                         "is_format_of": self.item_link(item),
                     }
                 )
         else:
             media_contents.append(
                 {
-                    "url": f"https://www.rfc-editor.org/rfc/{item.canonical_name()}.xml",
+                    "url": f"https://www.rfc-editor.org/rfc/{item.name}.xml",
                     "media_type": "application/rfc+xml",
                 }
             )
@@ -256,16 +256,16 @@ def item_extra_kwargs(self, item):
             ]:
                 media_contents.append(
                     {
-                        "url": f"https://rfc-editor.org/rfc/{item.canonical_name()}.{fmt}",
+                        "url": f"https://rfc-editor.org/rfc/{item.name}.{fmt}",
                         "media_type": media_type,
-                        "is_format_of": f"https://www.rfc-editor.org/rfc/{item.canonical_name()}.xml",
+                        "is_format_of": f"https://www.rfc-editor.org/rfc/{item.name}.xml",
                     }
                 )
         extra.update({"media_contents": media_contents})
 
-        extra.update({"doi": "10.17487/%s" % item.canonical_name().upper()})
+        extra.update({"doi": "10.17487/%s" % item.name.upper()})
         extra.update(
-            {"doiuri": "http://dx.doi.org/10.17487/%s" % item.canonical_name().upper()}
+            {"doiuri": "http://dx.doi.org/10.17487/%s" % item.name.upper()}
         )
 
         # R104 Publisher (Mandatory - but we need a string from them first)

ietf/doc/mails.py

@@ -202,7 +202,7 @@ def generate_last_call_announcement(request, doc):
 
     doc.filled_title = textwrap.fill(doc.title, width=70, subsequent_indent=" " * 3)
 
-    iprs = iprs_from_docs(related_docs(Document.objects.get(name=doc.canonical_name())))
+    iprs = iprs_from_docs(related_docs(Document.objects.get(name=doc.name)))
     if iprs:
         ipr_links = [ urlreverse("ietf.ipr.views.show", kwargs=dict(id=i.id)) for i in iprs]
         ipr_links = [ settings.IDTRACKER_BASE_URL+url if not url.startswith("http") else url for url in ipr_links ]

ietf/doc/models.py

@@ -173,25 +173,25 @@ def get_base_name(self):
             if self.uploaded_filename:
                 self._cached_base_name = self.uploaded_filename
             elif self.type_id == 'rfc':
-                self._cached_base_name = "%s.txt" % self.canonical_name()  
+                self._cached_base_name = "%s.txt" % self.name  
             elif self.type_id == 'draft':
                 if self.is_dochistory():
                     self._cached_base_name = "%s-%s.txt" % (self.doc.name, self.rev)
                 else:
                     self._cached_base_name = "%s-%s.txt" % (self.name, self.rev)
             elif self.type_id in ["slides", "agenda", "minutes", "bluesheets", "procmaterials", ] and self.meeting_related():
                 ext = 'pdf' if self.type_id == 'procmaterials' else 'txt'
-                self._cached_base_name = f'{self.canonical_name()}-{self.rev}.{ext}'
+                self._cached_base_name = f'{self.name}-{self.rev}.{ext}'
             elif self.type_id == 'review':
                 # TODO: This will be wrong if a review is updated on the same day it was created (or updated more than once on the same day)
                 self._cached_base_name = "%s.txt" % self.name
             elif self.type_id in ['bofreq', 'statement']:
                 self._cached_base_name = "%s-%s.md" % (self.name, self.rev)
             else:
                 if self.rev:
-                    self._cached_base_name = "%s-%s.txt" % (self.canonical_name(), self.rev)
+                    self._cached_base_name = "%s-%s.txt" % (self.name, self.rev)
                 else:
-                    self._cached_base_name = "%s.txt" % (self.canonical_name(), )
+                    self._cached_base_name = "%s.txt" % (self.name, )
         return self._cached_base_name
 
     def get_file_name(self):
@@ -507,7 +507,7 @@ def all_related_that_doc(self, relationship, related=None):
     def replaces(self):
         return set([ d for r in self.related_that_doc("replaces") for d in r.docs.all() ])
 
-    def replaces_canonical_name(self):
+    def replaces_name(self):
         s = set([ r.document for r in self.related_that_doc("replaces")])
         first = list(s)[0] if s else None
         return None if first is None else first.filename_with_rev()
@@ -540,7 +540,7 @@ def html_body(self, classes=""):
         if self.get_state_slug() == "rfc":
             try:
                 html = Path(
-                    os.path.join(settings.RFC_PATH, self.canonical_name() + ".html")
+                    os.path.join(settings.RFC_PATH, self.name + ".html")
                 ).read_text()
             except (IOError, UnicodeDecodeError):
                 return None
@@ -805,7 +805,7 @@ def get_absolute_url(self):
             name = self.name
             url = None
             if self.type_id == "draft" and self.get_state_slug() == "rfc":
-                name = self.canonical_name()
+                name = self.name
                 url = urlreverse('ietf.doc.views_doc.document_main', kwargs={ 'name': name }, urlconf="ietf.urls")
             elif self.type_id in ('slides','bluesheets','recording'):
                 session = self.session_set.first()
@@ -844,7 +844,7 @@ def latest_event(self, *args, **filter_args):
         return e
 
     def display_name(self):
-        name = self.canonical_name()
+        name = self.name
         if name.startswith('rfc'):
             name = name.upper()
         return name
@@ -1109,10 +1109,7 @@ def __str__(self):
 
 class DocHistory(DocumentInfo):
     doc = ForeignKey(Document, related_name="history_set")
-    # the name here is used to capture the canonical name at the time
-    # - it would perhaps be more elegant to simply call the attribute
-    # canonical_name and replace the function on Document with a
-    # property
+
     name = models.CharField(max_length=255)
 
     def __str__(self):
@@ -1124,11 +1121,6 @@ def get_related_session(self):
     def get_related_proceedings_material(self):
         return self.doc.get_related_proceedings_material()
 
-    def canonical_name(self):
-        if hasattr(self, '_canonical_name'):
-            return self._canonical_name
-        return self.name
-
     def latest_event(self, *args, **kwargs):
         kwargs["time__lte"] = self.time
         return self.doc.latest_event(*args, **kwargs)

ietf/doc/templatetags/ietf_filters.py

@@ -139,7 +139,7 @@ def rfceditor_info_url(rfcnum : str):
     return urljoin(settings.RFC_EDITOR_INFO_BASE_URL, f'rfc{rfcnum}')
 
 
-def doc_canonical_name(name):
+def doc_name(name):
     """Check whether a given document exists, and return its canonical name"""
 
     def find_unique(n):
@@ -174,7 +174,7 @@ def find_unique(n):
 
 
 def link_charter_doc_match(match):
-    if not doc_canonical_name(match[0]):
+    if not doc_name(match[0]):
         return match[0]
     url = urlreverse(
         "ietf.doc.views_doc.document_main",
@@ -187,7 +187,7 @@ def link_non_charter_doc_match(match):
     name = match[0]
     # handle "I-D.*"" reference-style matches
     name = re.sub(r"^i-d\.(.*)", r"draft-\1", name, flags=re.IGNORECASE)
-    cname = doc_canonical_name(name)
+    cname = doc_name(name)
     if not cname:
         return match[0]
     if name == cname:
@@ -202,7 +202,7 @@ def link_non_charter_doc_match(match):
         url = urlreverse("ietf.doc.views_doc.document_main", kwargs=dict(name=cname))
         return f'<a href="{url}">{match[0]}</a>'
 
-    cname = doc_canonical_name(name)
+    cname = doc_name(name)
     if not cname:
         return match[0]
     if name == cname:
@@ -222,7 +222,7 @@ def link_non_charter_doc_match(match):
 def link_other_doc_match(match):
     doc = match[2].strip().lower()
     rev = match[3]
-    if not doc_canonical_name(doc + rev):
+    if not doc_name(doc + rev):
         return match[0]
     url = urlreverse("ietf.doc.views_doc.document_main", kwargs=dict(name=doc + rev))
     return f'<a href="{url}">{match[1]}</a>'
@@ -268,7 +268,7 @@ def urlize_related_source_list(related, document_html=False):
     names = set()
     titles = set()
     for rel in related:
-        name=rel.source.canonical_name()
+        name=rel.source.name
         title = rel.source.title
         if name in names and title in titles:
             continue
@@ -289,7 +289,7 @@ def urlize_related_target_list(related, document_html=False):
     """Convert a list of RelatedDocuments into list of links using the target document's canonical name"""
     links = []
     for rel in related:
-        name=rel.target.canonical_name()
+        name=rel.target.name
         title = rel.target.title
         url = urlreverse('ietf.doc.views_doc.document_main' if document_html is False else 'ietf.doc.views_doc.document_html', kwargs=dict(name=name))
         name = escape(name)