From c7ca0b7d8e9f3f15c54eb6bfb7b504277470bd68 Mon Sep 17 00:00:00 2001 From: Jennifer Richards Date: Thu, 11 Jan 2024 15:08:24 -0400 Subject: [PATCH] Revert "chore: Replace markup_txt with rfc2html (#6632)" (#6909) This reverts commit e24fb601db9e81c467aadf28b82fdc2d259b0f16. --- ietf/doc/views_doc.py | 16 +++--- ietf/templates/doc/document_draft.html | 17 ++----- ietf/templates/doc/document_html.html | 4 +- ietf/templates/doc/document_rfc.html | 17 ++----- ietf/utils/markup_txt.py | 69 ++++++++++++++++++++++++++ ietf/utils/test_runner.py | 1 - 6 files changed, 85 insertions(+), 39 deletions(-) create mode 100644 ietf/utils/markup_txt.py diff --git a/ietf/doc/views_doc.py b/ietf/doc/views_doc.py index b26741dc1..293d32daf 100644 --- a/ietf/doc/views_doc.py +++ b/ietf/doc/views_doc.py @@ -51,8 +51,6 @@ from django.conf import settings from django import forms from django.contrib.staticfiles import finders -import rfc2html - import debug # pyflakes:ignore from ietf.doc.models import ( Document, DocHistory, DocEvent, BallotDocEvent, BallotType, @@ -82,7 +80,7 @@ from ietf.meeting.utils import group_sessions, get_upcoming_manageable_sessions, from ietf.review.models import ReviewAssignment from ietf.review.utils import can_request_review_of_doc, review_assignments_to_list_for_docs, review_requests_to_list_for_docs from ietf.review.utils import no_review_from_teams_on_doc -from ietf.utils import log, markdown +from ietf.utils import markup_txt, log, markdown from ietf.utils.draft import PlaintextDraft from ietf.utils.response import permission_denied from ietf.utils.text import maybe_split @@ -266,9 +264,7 @@ def document_main(request, name, rev=None, document_html=False): file_urls, found_types = build_file_urls(doc) content = doc.text_or_error() # pyflakes:ignore - content = maybe_split(content, split=split_content) - if content: - content = rfc2html.markup(content) + content = markup_txt.markup(maybe_split(content, split=split_content)) if not found_types: content = "This RFC is not currently available online." @@ -404,9 +400,7 @@ def document_main(request, name, rev=None, document_html=False): file_urls, found_types = build_file_urls(doc) content = doc.text_or_error() # pyflakes:ignore - content = maybe_split(content, split=split_content) - if content: - content = rfc2html.markup(content) + content = markup_txt.markup(maybe_split(content, split=split_content)) latest_revision = doc.latest_event(NewRevisionDocEvent, type="new_revision") @@ -781,7 +775,7 @@ def document_main(request, name, rev=None, document_html=False): content = "A conflict review response has not yet been proposed." else: content = doc.text_or_error() # pyflakes:ignore - content = markdown.markdown(content) + content = markup_txt.markup(content) ballot_summary = None if doc.get_state_slug() in ("iesgeval", ) and doc.active_ballot(): @@ -896,6 +890,8 @@ def document_main(request, name, rev=None, document_html=False): basename = "{}.txt".format(doc.name) pathname = os.path.join(doc.get_file_path(), basename) content = get_unicode_document_content(basename, pathname) + # If we want to go back to using markup_txt.markup_unicode, call it explicitly here like this: + # content = markup_txt.markup_unicode(content, split=False, width=80) assignments = ReviewAssignment.objects.filter(review__name=doc.name) review_assignment = assignments.first() diff --git a/ietf/templates/doc/document_draft.html b/ietf/templates/doc/document_draft.html index 39c04943f..8d9abf284 100644 --- a/ietf/templates/doc/document_draft.html +++ b/ietf/templates/doc/document_draft.html @@ -15,15 +15,7 @@ {% endblock %} -{% block morecss %} - .rfcmarkup :is(h1, h2, h3, h4, h5, h6), - .rfcmarkup :is(.h1, .h2, .h3, .h4, .h5, .h6) { - font-weight: bold; - font-size: 1em; - } - .rfcmarkup .newpage { margin-top: -1.5em; } - .rfcmarkup .grey, hr { opacity: .25; } -{% endblock %} +{% block morecss %}.inline { display: inline; }{% endblock %} {% block title %} {% if doc.type_id == "rfc" and not snapshot %} RFC {{ rfc_number }} - {{ doc.title }} @@ -666,7 +658,7 @@ Nits -
+
{% analytical_body_bottom %} - \ No newline at end of file + diff --git a/ietf/templates/doc/document_rfc.html b/ietf/templates/doc/document_rfc.html index 37aeaa08f..36c9babd7 100644 --- a/ietf/templates/doc/document_rfc.html +++ b/ietf/templates/doc/document_rfc.html @@ -15,15 +15,7 @@ {% endblock %} -{% block morecss %} - .rfcmarkup :is(h1, h2, h3, h4, h5, h6), - .rfcmarkup :is(.h1, .h2, .h3, .h4, .h5, .h6) { - font-weight: bold; - font-size: 1em; - } - .rfcmarkup .newpage { margin-top: -1.5em; } - .rfcmarkup .grey, hr { opacity: .25; } -{% endblock %} +{% block morecss %}.inline { display: inline; }{% endblock %} {% block title %} RFC {{ doc.rfc_number }} - {{ doc.title }} {% endblock %} @@ -163,9 +155,8 @@
RFC {{ doc.rfc_number }}
-
- - {{ content|safe|default:"(Unavailable)" }} +
+ 
{{ content|sanitize|safe|default:"(Unavailable)" }}
{% if split_content %} @@ -182,4 +173,4 @@ - {% endblock %} \ No newline at end of file + {% endblock %} diff --git a/ietf/utils/markup_txt.py b/ietf/utils/markup_txt.py new file mode 100644 index 000000000..0c8d25ca2 --- /dev/null +++ b/ietf/utils/markup_txt.py @@ -0,0 +1,69 @@ +# Copyright The IETF Trust 2009-2020, All Rights Reserved +# -*- coding: utf-8 -*- +# +# Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +# All rights reserved. Contact: Pasi Eronen +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# +# * Redistributions in binary form must reproduce the above +# copyright notice, this list of conditions and the following +# disclaimer in the documentation and/or other materials provided +# with the distribution. +# +# * Neither the name of the Nokia Corporation and/or its +# subsidiary(-ies) nor the names of its contributors may be used +# to endorse or promote products derived from this software +# without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +import re + +from django.utils.html import escape + +from ietf.utils import log +from ietf.utils.text import wordwrap + +def markup(content, width=None): + log.assertion('isinstance(content, str)') + # normalize line endings to LF only + content = content.replace("\r\n", "\n") + content = content.replace("\r", "\n") + + # remove leading white space + content = content.lstrip() + # remove runs of blank lines + content = re.sub("\n\n\n+", "\n\n", content) + + # maybe wordwrap. This must be done before the escaping below. + if width: + content = wordwrap(content, width) + + # expand tabs + escape + content = escape(content.expandtabs()) + + content = re.sub(r"\n(.+\[Page \d+\])\n\f\n(.+)\n", r"""\n\g<1>\n\g<2>\n""", content) + content = re.sub(r"\n(.+\[Page \d+\])\n\s*$", r"""\n\g<1>\n""", content) + # remove remaining FFs (to be valid XHTML) + content = content.replace("\f","\n") + + content = re.sub(r"\n\n([0-9]+\\.|[A-Z]\\.[0-9]|Appendix|Status of|Abstract|Table of|Full Copyright|Copyright|Intellectual Property|Acknowled|Author|Index)(.*)(?=\n\n)", r"""\n\n\g<1>\g<2>""", content) + + return content \ No newline at end of file diff --git a/ietf/utils/test_runner.py b/ietf/utils/test_runner.py index 882ab8a92..5901da806 100644 --- a/ietf/utils/test_runner.py +++ b/ietf/utils/test_runner.py @@ -196,7 +196,6 @@ def vnu_filter_message(msg, filter_db_issues, filter_test_issues): if filter_test_issues and re.search( r"""Ceci\ n'est\ pas\ une\ URL| ^The\ '\w+'\ attribute\ on\ the\ '\w+'\ element\ is\ obsolete| - ^Duplicate\ ID|^The\ first\ occurrence\ of\ ID| ^Section\ lacks\ heading""", msg["message"], flags=re.VERBOSE,