From fd5a7ea56cba2f22f84e7ada257c89d5ee354331 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CPaul?= <“pstoica@paulstoica.com”> Date: Tue, 14 Nov 2023 16:32:44 -0500 Subject: [PATCH 1/6] moved styles and javascript to files --- linkcheck/static/linkcheck/css/styles.css | 96 +++++++++++++ linkcheck/static/linkcheck/js/script.js | 55 ++++++++ .../templates/linkcheck/base_linkcheck.html | 5 + linkcheck/templates/linkcheck/coverage.html | 4 +- linkcheck/templates/linkcheck/paginator.html | 4 +- linkcheck/templates/linkcheck/report.html | 131 ++---------------- linkcheck/tests/test_linkcheck.py | 4 +- linkcheck/views.py | 2 +- 8 files changed, 172 insertions(+), 129 deletions(-) create mode 100644 linkcheck/static/linkcheck/css/styles.css create mode 100644 linkcheck/static/linkcheck/js/script.js diff --git a/linkcheck/static/linkcheck/css/styles.css b/linkcheck/static/linkcheck/css/styles.css new file mode 100644 index 0000000..8bc4690 --- /dev/null +++ b/linkcheck/static/linkcheck/css/styles.css @@ -0,0 +1,96 @@ + +.objecttype { + width: 99%!important; + margin-bottom: 30px; + border: 0 !important; +} + +.objecttype td { + border: 0; +} + +.module { + width: 100%!important; + border: 0 !important; +} + +.object { + width: 100%!important; + margin: 0; + padding: 35px 0 0 0; +} + +.links { + width: 100%!important; + background-color: white; + border: 1px solid #ddd; + margin: 10px 0 0 0; +} + +.links td, .links tr { + border: 1px solid #ddd; +} + +.links th { + border: 0!important; +} + +td.actioncell { + border-left: 0 !important; + width: 60px !important; +} + +#linkcheck-nav { + width: 100%; + margin-left: auto; + margin-right: auto; + text-align: center; + padding: 10px; +} + +#linkcheck-nav a { + text-decoration: underline; +} + +/* Header Styles */ +.header-cell { + padding: 0; +} + +.header-table-small { + width: 20%; +} + +.header-table-big { + width: 40%; + +} + +.header-report { + display: inline; + padding-left: 5px; +} + +.header-link { + text-decoration: underline; +} + +/* table body styles */ +.emphasis { + font-weight: bold; +} +.coloured-green { + color: green; +} +.coloured-red { + color: red; +} + +/* other styles */ +.current { + margin: 0 25px; +} + +.center-aligned { + text-align: center; +} \ No newline at end of file diff --git a/linkcheck/static/linkcheck/js/script.js b/linkcheck/static/linkcheck/js/script.js new file mode 100644 index 0000000..e54735d --- /dev/null +++ b/linkcheck/static/linkcheck/js/script.js @@ -0,0 +1,55 @@ +function showProgressDots(numberOfDots) { + var progress = document.getElementById('progressDots'); + if (!progress) return; + switch(numberOfDots) { + case 1: + progress.innerHTML = '.  '; + timerHandle = setTimeout('showProgressDots(2)',200); + break; + case 2: + progress.innerHTML = '.. '; + timerHandle = setTimeout('showProgressDots(3)',200); + break; + case 3: + progress.innerHTML = '...'; + timerHandle = setTimeout('showProgressDots(1)',200); + break; + } +} + +$(document).ready(function() { + + const csrfToken = document.querySelector('[name=csrfmiddlewaretoken]').value; + + $(".ignore").submit(function(){ + $.post(this.action, {'csrfmiddlewaretoken': csrfToken}, (data) => { + $('tr#link' + data.link).hide('medium'); + var ignored_count = parseInt($('#ignored_count').text()); + ignored_count++; + $('#ignored_count').text(ignored_count); + }); + return false; + }); + + $(".unignore").submit(function(){ + $.post(this.action, {'csrfmiddlewaretoken': csrfToken}, (data) => { + $('tr#link' + data.link).hide('medium'); + var ignored_count = parseInt($('#ignored_count').text()); + ignored_count--; + $('#ignored_count').text(ignored_count); + }); + return false; + }); + + $(".recheck").submit(function(){ + $(this).closest('tr').find('td.link_message').html('Checking'); + showProgressDots(1); + $.post(this.action, {'csrfmiddlewaretoken': csrfToken}, (data) => { + var links = data['links']; + for (var link in links) { + $('tr#link'+links[link]).find('td.link_message').text(data['message']).css('color', data['colour']); + } + }); + return false; + }); +}); diff --git a/linkcheck/templates/linkcheck/base_linkcheck.html b/linkcheck/templates/linkcheck/base_linkcheck.html index 03bdcd8..756fc4f 100644 --- a/linkcheck/templates/linkcheck/base_linkcheck.html +++ b/linkcheck/templates/linkcheck/base_linkcheck.html @@ -5,6 +5,11 @@ {% translate "Link Checker" %} {{ block.super }} {% endblock %} +{% block head %} + + +{% endblock %} + {% block breadcrumbs %}
{% translate "Home" %} › diff --git a/linkcheck/templates/linkcheck/coverage.html b/linkcheck/templates/linkcheck/coverage.html index 0f1c4eb..f0a8954 100644 --- a/linkcheck/templates/linkcheck/coverage.html +++ b/linkcheck/templates/linkcheck/coverage.html @@ -26,10 +26,10 @@ {% for model in coverage_data %} {{ model.name }} - + {{ model.is_covered|yesno:_("Yes,No") }} - + {% if not model.is_covered %} {{ model.suggested_config|render_config }} {% endif %} diff --git a/linkcheck/templates/linkcheck/paginator.html b/linkcheck/templates/linkcheck/paginator.html index d48eb0d..5ebb778 100644 --- a/linkcheck/templates/linkcheck/paginator.html +++ b/linkcheck/templates/linkcheck/paginator.html @@ -1,5 +1,5 @@ {% load i18n %} -
+
{% if pages.number > 1 %} < First @@ -13,7 +13,7 @@ << {% translate "Previous" %} {% endif %} - + {% blocktrans with current=pages.number max=pages.paginator.num_pages %}Page {{ current }} of {{ max }}{% endblocktrans %} diff --git a/linkcheck/templates/linkcheck/report.html b/linkcheck/templates/linkcheck/report.html index 161a968..d61ddd5 100644 --- a/linkcheck/templates/linkcheck/report.html +++ b/linkcheck/templates/linkcheck/report.html @@ -3,120 +3,7 @@ {% load linkcheck_model_tags %} {% block extrahead %} {{ block.super }} - - - {% endblock %} {% block innercontent %} @@ -133,17 +20,17 @@ {% for content_type in content_types_list %} -

{{content_type.content_type|get_verbose_name_plural}}

+

{{content_type.content_type|get_verbose_name_plural}}

{% for object in content_type.object_list %}
-

{{report_type}} in '{{object.object}}'

   - {% blocktrans with content_type_name=content_type.content_type.name %}View {{ content_type_name }}{% endblocktrans %}   - {% if object.admin_url %}{% blocktrans with content_type_name=content_type.content_type.name %}Edit {{ content_type_name }}{% endblocktrans %}{% endif %} +

{{report_type}} in '{{object.object}}'

   + {% blocktrans with content_type_name=content_type.content_type.name %}View {{ content_type_name }}{% endblocktrans %}   + {% if object.admin_url %}{% blocktrans with content_type_name=content_type.content_type.name %}Edit {{ content_type_name }}{% endblocktrans %}{% endif %} - - - - + + + + {% for link in object.link_list %} @@ -151,7 +38,7 @@

{{report_type}} in '{{object.obj

- + ' - '' - '', + '' + '', html=True, ) diff --git a/linkcheck/views.py b/linkcheck/views.py index 41de93e..b28ad2b 100644 --- a/linkcheck/views.py +++ b/linkcheck/views.py @@ -169,7 +169,7 @@ def get_status_message(): broken_links = Link.objects.filter(ignore=False, url__status=False).count() if broken_links: return ( - "We've found {} broken link{}.
" + "We've found {} broken link{}.
" "View/fix broken links".format( broken_links, "s" if broken_links > 1 else "", From 5fdd84ce38f58209489b3ec072c5de46d23ecf62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CPaul?= <“pstoica@paulstoica.com”> Date: Tue, 14 Nov 2023 16:54:29 -0500 Subject: [PATCH 2/6] adding setup and readme --- README.rst | 2 ++ setup.py | 3 +++ 2 files changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 82481df..ef17b8f 100644 --- a/README.rst +++ b/README.rst @@ -50,6 +50,8 @@ Basic usage path('admin/linkcheck/', include('linkcheck.urls')) +#. Run ``./manage.py collectstatic`` if you're deploying your app in production environment. + #. View ``/admin/linkcheck/`` from your browser. We are aware that this documentation is on the brief side of things so any diff --git a/setup.py b/setup.py index 49c3909..0bd6330 100644 --- a/setup.py +++ b/setup.py @@ -23,6 +23,9 @@ def read(fname): license='BSD', url='https://github.com/DjangoAdminHackers/django-linkcheck', packages=find_packages(), + package_data={ + 'linkcheck': ['static/linkcheck/css/*', 'static/linkcheck/js/*'], + }, include_package_data=True, install_requires=['django>=3.2', 'requests'], extras_require={ From 54636be49005ef9c55e14f640236adf531022b1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CPaul?= <“pstoica@paulstoica.com”> Date: Tue, 14 Nov 2023 19:34:27 -0500 Subject: [PATCH 3/6] added load static --- linkcheck/templates/linkcheck/coverage.html | 1 + linkcheck/templates/linkcheck/paginator.html | 2 ++ linkcheck/templates/linkcheck/report.html | 2 ++ 3 files changed, 5 insertions(+) diff --git a/linkcheck/templates/linkcheck/coverage.html b/linkcheck/templates/linkcheck/coverage.html index f0a8954..4cfab04 100644 --- a/linkcheck/templates/linkcheck/coverage.html +++ b/linkcheck/templates/linkcheck/coverage.html @@ -1,4 +1,5 @@ {% extends "linkcheck/base_linkcheck.html" %} +{% load static %} {% load i18n %} {% load linkcheck_coverage_tags %} diff --git a/linkcheck/templates/linkcheck/paginator.html b/linkcheck/templates/linkcheck/paginator.html index 5ebb778..5f53721 100644 --- a/linkcheck/templates/linkcheck/paginator.html +++ b/linkcheck/templates/linkcheck/paginator.html @@ -1,4 +1,6 @@ +{% load static %} {% load i18n %} +
{% if pages.number > 1 %} diff --git a/linkcheck/templates/linkcheck/report.html b/linkcheck/templates/linkcheck/report.html index d61ddd5..2310570 100644 --- a/linkcheck/templates/linkcheck/report.html +++ b/linkcheck/templates/linkcheck/report.html @@ -1,6 +1,8 @@ +{% load static %} {% extends "linkcheck/base_linkcheck.html" %} {% load i18n %} {% load linkcheck_model_tags %} + {% block extrahead %} {{ block.super }} From 95851e65cf2fcc0e40df1624fd57058f16854b39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CPaul?= <“pstoica@paulstoica.com”> Date: Tue, 14 Nov 2023 19:41:55 -0500 Subject: [PATCH 4/6] collect static in base --- linkcheck/templates/linkcheck/base_linkcheck.html | 1 + linkcheck/templates/linkcheck/coverage.html | 1 - linkcheck/templates/linkcheck/paginator.html | 1 - linkcheck/templates/linkcheck/report.html | 1 - 4 files changed, 1 insertion(+), 3 deletions(-) diff --git a/linkcheck/templates/linkcheck/base_linkcheck.html b/linkcheck/templates/linkcheck/base_linkcheck.html index 756fc4f..7a5a55b 100644 --- a/linkcheck/templates/linkcheck/base_linkcheck.html +++ b/linkcheck/templates/linkcheck/base_linkcheck.html @@ -1,4 +1,5 @@ {% extends "admin/change_list.html" %} +{% load static %} {% load i18n %} {% block title %} diff --git a/linkcheck/templates/linkcheck/coverage.html b/linkcheck/templates/linkcheck/coverage.html index 4cfab04..f0a8954 100644 --- a/linkcheck/templates/linkcheck/coverage.html +++ b/linkcheck/templates/linkcheck/coverage.html @@ -1,5 +1,4 @@ {% extends "linkcheck/base_linkcheck.html" %} -{% load static %} {% load i18n %} {% load linkcheck_coverage_tags %} diff --git a/linkcheck/templates/linkcheck/paginator.html b/linkcheck/templates/linkcheck/paginator.html index 5f53721..6607806 100644 --- a/linkcheck/templates/linkcheck/paginator.html +++ b/linkcheck/templates/linkcheck/paginator.html @@ -1,4 +1,3 @@ -{% load static %} {% load i18n %}
diff --git a/linkcheck/templates/linkcheck/report.html b/linkcheck/templates/linkcheck/report.html index 2310570..dd6d0a1 100644 --- a/linkcheck/templates/linkcheck/report.html +++ b/linkcheck/templates/linkcheck/report.html @@ -1,4 +1,3 @@ -{% load static %} {% extends "linkcheck/base_linkcheck.html" %} {% load i18n %} {% load linkcheck_model_tags %} From 43e5eca0d5203442db588c00215a6a94b758a70e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CPaul?= <“pstoica@paulstoica.com”> Date: Wed, 15 Nov 2023 10:10:45 -0500 Subject: [PATCH 5/6] bloack.super in base for jquery, head > extrahead, modif showProgressDots which triggered CSP error --- linkcheck/static/linkcheck/js/script.js | 6 +++--- linkcheck/templates/linkcheck/base_linkcheck.html | 6 ++++-- linkcheck/templates/linkcheck/report.html | 5 ----- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/linkcheck/static/linkcheck/js/script.js b/linkcheck/static/linkcheck/js/script.js index e54735d..a39180e 100644 --- a/linkcheck/static/linkcheck/js/script.js +++ b/linkcheck/static/linkcheck/js/script.js @@ -4,15 +4,15 @@ function showProgressDots(numberOfDots) { switch(numberOfDots) { case 1: progress.innerHTML = '.  '; - timerHandle = setTimeout('showProgressDots(2)',200); + timerHandle = setTimeout(function() { showProgressDots(2); }, 200); break; case 2: progress.innerHTML = '.. '; - timerHandle = setTimeout('showProgressDots(3)',200); + timerHandle = setTimeout(function() { showProgressDots(3); }, 200); break; case 3: progress.innerHTML = '...'; - timerHandle = setTimeout('showProgressDots(1)',200); + timerHandle = setTimeout(function() { showProgressDots(1); }, 200); break; } } diff --git a/linkcheck/templates/linkcheck/base_linkcheck.html b/linkcheck/templates/linkcheck/base_linkcheck.html index 7a5a55b..e32de44 100644 --- a/linkcheck/templates/linkcheck/base_linkcheck.html +++ b/linkcheck/templates/linkcheck/base_linkcheck.html @@ -3,12 +3,14 @@ {% load i18n %} {% block title %} - {% translate "Link Checker" %} {{ block.super }} + {% translate "Link Checker" %} {% endblock %} -{% block head %} +{% block extrahead %} + {{ block.super }} + {% endblock %} {% block breadcrumbs %} diff --git a/linkcheck/templates/linkcheck/report.html b/linkcheck/templates/linkcheck/report.html index dd6d0a1..23b2862 100644 --- a/linkcheck/templates/linkcheck/report.html +++ b/linkcheck/templates/linkcheck/report.html @@ -2,11 +2,6 @@ {% load i18n %} {% load linkcheck_model_tags %} -{% block extrahead %} -{{ block.super }} - -{% endblock %} - {% block innercontent %}
From 2693e61d30ffa888b20c6891d6522bc84160ac0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CPaul?= <“pstoica@paulstoica.com”> Date: Wed, 15 Nov 2023 10:15:05 -0500 Subject: [PATCH 6/6] set actions_on_top to true --- linkcheck/views.py | 1 + 1 file changed, 1 insertion(+) diff --git a/linkcheck/views.py b/linkcheck/views.py index b28ad2b..25a8ae2 100644 --- a/linkcheck/views.py +++ b/linkcheck/views.py @@ -150,6 +150,7 @@ def report(request): 'qry_data': rqst.urlencode(), 'report_type': report_type, 'ignored_count': Link.objects.filter(ignore=True).count(), + 'actions_on_top': True, }, )
{% translate "Destination" %}{% translate "Linked Text" %}{% translate "Field to edit" %}{% translate "Status" %}{% translate "Destination" %}{% translate "Linked Text" %}{% translate "Field to edit" %}{% translate "Status" %} {{link.display_url}} {% if link.text == "empty" %}none{% else %}"{{link.text}}"{% endif %} {{link.field}}{{link.url.message}}{{link.url.message}} {% if not link.url.status %}
diff --git a/linkcheck/tests/test_linkcheck.py b/linkcheck/tests/test_linkcheck.py index a857efb..05abad3 100644 --- a/linkcheck/tests/test_linkcheck.py +++ b/linkcheck/tests/test_linkcheck.py @@ -1074,8 +1074,8 @@ def test_coverage_view(self): self.assertContains( response, '
sampleapp.BookYes
Yes