Software Heritage archived object

diff --git a/assets/src/bundles/webapp/iframes.js b/assets/src/bundles/browse/iframe.js similarity index 75% rename from assets/src/bundles/webapp/iframes.js rename to assets/src/bundles/browse/iframe.js index 4a7b5301..225cd629 100644 --- a/assets/src/bundles/webapp/iframes.js +++ b/assets/src/bundles/browse/iframe.js @@ -1,23 +1,23 @@ /** - * Copyright (C) 2021 The Software Heritage developers + * Copyright (C) 2021-2022 The Software Heritage developers * See the AUTHORS file at the top-level directory of this distribution * License: GNU Affero General Public License version 3, or any later version * See top-level LICENSE file for more information */ export function showIframeInfoModal(objectType, objectSWHID) { const html = `

You can embed that ${objectType} view in an external website through the use of an iframe. Use the following HTML code to do so.

<iframe style="width: 100%; height: 500px; border: 1px solid rgba(0, 0, 0, 0.125);"
-        src="${window.location.origin}${Urls.swhid_iframe(objectSWHID.replaceAll('\n', ''))}">
+        src="${window.location.origin}${Urls.browse_swhid_iframe(objectSWHID.replaceAll('\n', ''))}">
 </iframe>

`; swh.webapp.showModalHtml(`Software Heritage ${objectType} iframe`, html, '1000px'); swh.webapp.highlightCode(false, '.swh-iframe-html'); } diff --git a/assets/src/bundles/browse/index.js b/assets/src/bundles/browse/index.js index bda1363c..bccaa22a 100644 --- a/assets/src/bundles/browse/index.js +++ b/assets/src/bundles/browse/index.js @@ -1,18 +1,19 @@ /** - * Copyright (C) 2018 The Software Heritage developers + * Copyright (C) 2018-2022 The Software Heritage developers * See the AUTHORS file at the top-level directory of this distribution * License: GNU Affero General Public License version 3, or any later version * See top-level LICENSE file for more information */ // main bundle for the swh-web/browse application -import './browse.css'; import './breadcrumbs.css'; +import './browse.css'; import './content.css'; import './snapshot-navigation.css'; -export * from './snapshot-navigation'; -export * from './origin-search'; export * from './browse-utils'; +export * from './iframe'; +export * from './origin-search'; +export * from './snapshot-navigation'; export * from './swhid-utils'; diff --git a/assets/src/bundles/webapp/index.js b/assets/src/bundles/webapp/index.js index d4f04bfd..8862ad2a 100644 --- a/assets/src/bundles/webapp/index.js +++ b/assets/src/bundles/webapp/index.js @@ -1,29 +1,27 @@ /** - * Copyright (C) 2018-2021 The Software Heritage developers + * Copyright (C) 2018-2022 The Software Heritage developers * See the AUTHORS file at the top-level directory of this distribution * License: GNU Affero General Public License version 3, or any later version * See top-level LICENSE file for more information */ // webapp entrypoint bundle centralizing global custom stylesheets // and utility js modules used in all swh-web applications // global swh-web custom stylesheets -import './webapp.css'; import './breadcrumbs.css'; import './coverage.css'; - -export * from './webapp-utils'; +import './webapp.css'; // utility js modules +export * from './badges'; export * from './code-highlighting'; -export * from './readme-rendering'; -export * from './pdf-rendering'; -export * from './notebook-rendering'; -export * from './xss-filtering'; export * from './history-counters'; -export * from './badges'; -export * from './sentry'; export * from './math-typesetting'; +export * from './notebook-rendering'; +export * from './pdf-rendering'; +export * from './readme-rendering'; +export * from './sentry'; export * from './status-widget'; -export * from './iframes'; +export * from './webapp-utils'; +export * from './xss-filtering'; diff --git a/swh/web/templates/misc/iframe.html b/swh/web/browse/templates/browse-iframe.html similarity index 97% rename from swh/web/templates/misc/iframe.html rename to swh/web/browse/templates/browse-iframe.html index c89516bb..eb479797 100644 --- a/swh/web/templates/misc/iframe.html +++ b/swh/web/browse/templates/browse-iframe.html @@ -1,182 +1,182 @@ {% comment %} -Copyright (C) 2021 The Software Heritage developers +Copyright (C) 2021-2022 The Software Heritage developers See the AUTHORS file at the top-level directory of this distribution License: GNU Affero General Public License version 3, or any later version See top-level LICENSE file for more information {% endcomment %} {% load static %} {% load render_bundle from webpack_loader %} {% load swh_templatetags %} Software Heritage archived object {% render_bundle 'vendors' %} {% render_bundle 'webapp' %} {% render_bundle 'browse' %}

{% include "includes/show-swhids.html" %}

Software Heritage

Navigating in

{% if swhid != focus_swhid %} -

Reset view

{% endif %} View in the archive

{% include "includes/breadcrumbs.html" %}

{% if error_code != 200 %} {% include "includes/http-error.html" %} {% elif object_type == "cnt" %} {% include "includes/content-display.html" %} {% elif object_type == "dir" %} {% include "includes/directory-display.html" %} {% endif %}

{% if object_type == "cnt" %} {% endif %} diff --git a/swh/web/browse/templates/includes/show-swhids.html b/swh/web/browse/templates/includes/show-swhids.html index 42e4df57..a6ad7c61 100644 --- a/swh/web/browse/templates/includes/show-swhids.html +++ b/swh/web/browse/templates/includes/show-swhids.html @@ -1,123 +1,123 @@ {% comment %} -Copyright (C) 2017-2021 The Software Heritage developers +Copyright (C) 2017-2022 The Software Heritage developers See the AUTHORS file at the top-level directory of this distribution License: GNU Affero General Public License version 3, or any later version See top-level LICENSE file for more information {% endcomment %} {% load swh_templatetags %} {% if swhids_info %}

{% if swhids_info|length > 1 %} Permalinks {% else %} Permalink {% endif %}

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Heritage persistent IDentifiers (SWHIDs) must be used instead of copying and pasting the url from the address bar of the browser (as there is no guarantee the current URI scheme will remain the same over time).

Select below a type of object currently browsed in order to display its associated SWHID and permalink.

{{ swhid_info.object_type.name.lower }}
{{ swhid_info.object_type.name.lower }}

{% for swhid_info in swhids_info %} {% if forloop.first %}

{% else %}

{% endif %}

{% if not iframe_mode %}

{% if snapshot_context and snapshot_context.origin_info %}

{% endif %} {% if swhid_info.object_id %}

{% endif %} {% if swhid_info.object_type.name.lower == "content" or swhid_info.object_type.name.lower == "directory" %} + onclick="swh.browse.showIframeInfoModal('{{ swhid_info.object_type.name.lower }}', $(this).parent().parent().find('.swhid').text())"> Iframe embedding {% endif %}

{% endif %} {% if swhid_info.object_id %}

{{ swhid_info.swhid }}

{% endif %} {% if swhid_info.swhid_with_context is not None %}

{% endif %}

{% endfor %}

{% endif %} diff --git a/swh/web/browse/urls.py b/swh/web/browse/urls.py index 0bf42504..38b6b93b 100644 --- a/swh/web/browse/urls.py +++ b/swh/web/browse/urls.py @@ -1,64 +1,74 @@ # Copyright (C) 2017-2022 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU Affero General Public License version 3, or any later version # See top-level LICENSE file for more information from django.http import HttpRequest, HttpResponse from django.shortcuts import redirect, render from django.urls import re_path as url from swh.web.browse.browseurls import BrowseUrls from swh.web.browse.identifiers import swhid_browse import swh.web.browse.views.content # noqa import swh.web.browse.views.directory # noqa +import swh.web.browse.views.iframe # noqa import swh.web.browse.views.origin # noqa import swh.web.browse.views.release # noqa import swh.web.browse.views.revision # noqa import swh.web.browse.views.snapshot # noqa from swh.web.utils import origin_visit_types, reverse def _browse_help_view(request: HttpRequest) -> HttpResponse: return render( request, "browse-help.html", {"heading": "How to browse the archive ?"} ) def _browse_search_view(request: HttpRequest) -> HttpResponse: return render( request, "browse-search.html", { "heading": "Search software origins to browse", "visit_types": origin_visit_types(), }, ) def _browse_vault_view(request: HttpRequest) -> HttpResponse: return render( request, "browse-vault-ui.html", {"heading": "Download archive content from the Vault"}, ) def _browse_origin_save_view(request: HttpRequest) -> HttpResponse: return redirect(reverse("origin-save")) +def _browse_swhid_iframe_legacy(request: HttpRequest, swhid: str) -> HttpResponse: + return redirect(reverse("browse-swhid-iframe", url_args={"swhid": swhid})) + + urlpatterns = [ url(r"^browse/$", _browse_search_view), url(r"^browse/help/$", _browse_help_view, name="browse-help"), url(r"^browse/search/$", _browse_search_view, name="browse-search"), url(r"^browse/vault/$", _browse_vault_view, name="browse-vault"), # for backward compatibility url(r"^browse/origin/save/$", _browse_origin_save_view, name="browse-origin-save"), url( r"^browse/(?Pswh:[0-9]+:[a-z]+:[0-9a-f]+.*)/$", swhid_browse, name="browse-swhid-legacy", ), + url( + r"^embed/(?Pswh:[0-9]+:[a-z]+:[0-9a-f]+.*)/$", + _browse_swhid_iframe_legacy, + name="browse-swhid-iframe-legacy", + ), ] urlpatterns += BrowseUrls.get_url_patterns() diff --git a/swh/web/misc/iframe.py b/swh/web/browse/views/iframe.py similarity index 96% rename from swh/web/misc/iframe.py rename to swh/web/browse/views/iframe.py index 43a01f5b..63ced9da 100644 --- a/swh/web/misc/iframe.py +++ b/swh/web/browse/views/iframe.py @@ -1,339 +1,344 @@ # Copyright (C) 2021-2022 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU Affero General Public License version 3, or any later version # See top-level LICENSE file for more information from typing import Any, Dict, List, Optional, Tuple from django.shortcuts import render from django.urls import re_path as url from django.views.decorators.clickjacking import xframe_options_exempt from swh.model.hashutil import hash_to_bytes from swh.model.swhids import CoreSWHID, ObjectType, QualifiedSWHID +from swh.web.browse.browseurls import browse_route from swh.web.browse.snapshot_context import get_snapshot_context from swh.web.browse.utils import ( content_display_max_size, get_directory_entries, prepare_content_for_display, request_content, ) from swh.web.utils import archive, gen_path_info, reverse from swh.web.utils.exc import BadInputExc, NotFoundExc, http_status_code_message from swh.web.utils.identifiers import get_swhid, get_swhids_info from swh.web.utils.typing import SnapshotContext, SWHObjectInfo def _get_content_rendering_data(cnt_swhid: QualifiedSWHID, path: str) -> Dict[str, Any]: content_data = request_content(f"sha1_git:{cnt_swhid.object_id.hex()}") content = None language = None mimetype = None if content_data.get("raw_data") is not None: content_display_data = prepare_content_for_display( content_data["raw_data"], content_data["mimetype"], path ) content = content_display_data["content_data"] language = content_display_data["language"] mimetype = content_display_data["mimetype"] return { "content": content, "content_size": content_data.get("length"), "max_content_size": content_display_max_size, "filename": path.split("/")[-1], "encoding": content_data.get("encoding"), "mimetype": mimetype, "language": language, } def _get_directory_rendering_data( dir_swhid: QualifiedSWHID, focus_swhid: QualifiedSWHID, path: str, ) -> Dict[str, Any]: dirs, files = get_directory_entries(dir_swhid.object_id.hex()) for d in dirs: if d["type"] == "rev": d["url"] = None else: dir_swhid = QualifiedSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(d["target"]), origin=dir_swhid.origin, visit=dir_swhid.visit, anchor=dir_swhid.anchor, path=(path or "/") + d["name"] + "/", ) d["url"] = reverse( - "swhid-iframe", + "browse-swhid-iframe", url_args={"swhid": str(dir_swhid)}, query_params={"focus_swhid": str(focus_swhid)}, ) for f in files: object_id = hash_to_bytes(f["target"]) cnt_swhid = QualifiedSWHID( object_type=ObjectType.CONTENT, object_id=object_id, origin=dir_swhid.origin, visit=dir_swhid.visit, anchor=dir_swhid.anchor, path=(path or "/") + f["name"], lines=(focus_swhid.lines if object_id == focus_swhid.object_id else None), ) f["url"] = reverse( - "swhid-iframe", + "browse-swhid-iframe", url_args={"swhid": str(cnt_swhid)}, query_params={"focus_swhid": str(focus_swhid)}, ) return {"dirs": dirs, "files": files} def _get_breacrumbs_data( swhid: QualifiedSWHID, focus_swhid: QualifiedSWHID, path: str, snapshot_context: Optional[SnapshotContext] = None, ) -> Tuple[List[Dict[str, Any]], Optional[str]]: breadcrumbs = [] filename = None # strip any leading or trailing slash from path qualifier of SWHID if path and path[0] == "/": path = path[1:] if path and path[-1] == "/": path = path[:-1] if swhid.object_type == ObjectType.CONTENT: split_path = path.split("/") filename = split_path[-1] path = path[: -len(filename)] path_info = gen_path_info(path) if path != "/" else [] root_dir = None if snapshot_context and snapshot_context["root_directory"]: root_dir = snapshot_context["root_directory"] elif swhid.anchor and swhid.anchor.object_type == ObjectType.DIRECTORY: root_dir = swhid.anchor.object_id.hex() elif focus_swhid.object_type == ObjectType.DIRECTORY: root_dir = focus_swhid.object_id.hex() if root_dir: root_dir_swhid = QualifiedSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(root_dir), origin=swhid.origin, visit=swhid.visit, anchor=swhid.anchor, ) breadcrumbs.append( { "name": root_dir[:7], "object_id": root_dir_swhid.object_id.hex(), "path": "/", "url": reverse( - "swhid-iframe", + "browse-swhid-iframe", url_args={"swhid": str(root_dir_swhid)}, query_params={ "focus_swhid": str(focus_swhid) if focus_swhid != root_dir_swhid else None }, ), } ) for pi in path_info: dir_info = archive.lookup_directory_with_path(root_dir, pi["path"]) dir_swhid = QualifiedSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(dir_info["target"]), origin=swhid.origin, visit=swhid.visit, anchor=swhid.anchor, path="/" + pi["path"] + "/", ) breadcrumbs.append( { "name": pi["name"], "object_id": dir_swhid.object_id.hex(), "path": dir_swhid.path.decode("utf-8") if dir_swhid.path else "", "url": reverse( - "swhid-iframe", + "browse-swhid-iframe", url_args={"swhid": str(dir_swhid)}, query_params={"focus_swhid": str(focus_swhid)}, ), } ) if filename: breadcrumbs.append( { "name": filename, "object_id": swhid.object_id.hex(), "path": path, "url": "", } ) return breadcrumbs, root_dir +@browse_route( + r"embed/(?Pswh:[0-9]+:[a-z]+:[0-9a-f]+.*)/", + view_name="browse-swhid-iframe", +) @xframe_options_exempt def swhid_iframe(request, swhid: str): """Django view that can be embedded in an iframe to display objects archived by Software Heritage (currently contents and directories) in a minimalist Web UI. """ focus_swhid = request.GET.get("focus_swhid", swhid) parsed_swhid = None view_data = {} breadcrumbs: List[Dict[str, Any]] = [] swh_objects = [] snapshot_context = None swhids_info_extra_context = {} archive_link = None try: parsed_swhid = get_swhid(swhid) parsed_focus_swhid = get_swhid(focus_swhid) path = parsed_swhid.path.decode("utf-8") if parsed_swhid.path else "" snapshot_context = None revision_id = None if ( parsed_swhid.anchor and parsed_swhid.anchor.object_type == ObjectType.REVISION ): revision_id = parsed_swhid.anchor.object_id.hex() if parsed_swhid.origin or parsed_swhid.visit: snapshot_context = get_snapshot_context( origin_url=parsed_swhid.origin, snapshot_id=parsed_swhid.visit.object_id.hex() if parsed_swhid.visit else None, revision_id=revision_id, ) error_info: Dict[str, Any] = {"status_code": 200, "description": ""} if parsed_swhid and parsed_swhid.object_type == ObjectType.CONTENT: view_data = _get_content_rendering_data(parsed_swhid, path) swh_objects.append( SWHObjectInfo( object_type=ObjectType.CONTENT, object_id=parsed_swhid.object_id.hex(), ) ) elif parsed_swhid and parsed_swhid.object_type == ObjectType.DIRECTORY: view_data = _get_directory_rendering_data( parsed_swhid, parsed_focus_swhid, path ) swh_objects.append( SWHObjectInfo( object_type=ObjectType.DIRECTORY, object_id=parsed_swhid.object_id.hex(), ) ) elif parsed_swhid: error_info = { "status_code": 400, "description": ( f"Objects of type {parsed_swhid.object_type} are not supported" ), } swhids_info_extra_context["path"] = path if parsed_swhid and view_data: breadcrumbs, root_dir = _get_breacrumbs_data( parsed_swhid, parsed_focus_swhid, path, snapshot_context ) if parsed_swhid.object_type == ObjectType.CONTENT and len(breadcrumbs) > 1: swh_objects.append( SWHObjectInfo( object_type=ObjectType.DIRECTORY, object_id=breadcrumbs[-2]["object_id"], ) ) swhids_info_extra_context["path"] = breadcrumbs[-2]["path"] swhids_info_extra_context["filename"] = breadcrumbs[-1]["name"] if snapshot_context: swh_objects.append( SWHObjectInfo( object_type=ObjectType.REVISION, object_id=snapshot_context["revision_id"] or "", ) ) swh_objects.append( SWHObjectInfo( object_type=ObjectType.SNAPSHOT, object_id=snapshot_context["snapshot_id"] or "", ) ) archive_link = reverse("browse-swhid", url_args={"swhid": swhid}) if ( parsed_swhid.origin is None and parsed_swhid.visit is None and parsed_swhid.anchor is None and root_dir is not None ): # qualifier values cannot be used to get root directory from them, # we need to add it as anchor in the SWHID argument of the archive link root_dir_swhid = CoreSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(root_dir) ) archive_swhid = QualifiedSWHID( object_type=parsed_swhid.object_type, object_id=parsed_swhid.object_id, path=parsed_swhid.path, anchor=root_dir_swhid, ) archive_link = reverse( "browse-swhid", url_args={"swhid": f"{archive_swhid}"}, ) except BadInputExc as e: error_info = {"status_code": 400, "description": f"BadInputExc: {str(e)}"} except NotFoundExc as e: error_info = {"status_code": 404, "description": f"NotFoundExc: {str(e)}"} except Exception as e: error_info = {"status_code": 500, "description": str(e)} return render( request, - "misc/iframe.html", + "browse-iframe.html", { **view_data, "iframe_mode": True, "object_type": parsed_swhid.object_type.value if parsed_swhid else None, "lines": parsed_swhid.lines if parsed_swhid else None, "breadcrumbs": breadcrumbs, "swhid": swhid, "focus_swhid": focus_swhid, "archive_link": archive_link, "error_code": error_info["status_code"], "error_message": http_status_code_message.get(error_info["status_code"]), "error_description": error_info["description"], "snapshot_context": None, "swhids_info": get_swhids_info( swh_objects, snapshot_context, swhids_info_extra_context ), }, status=error_info["status_code"], ) urlpatterns = [ url( r"^embed/(?Pswh:[0-9]+:[a-z]+:[0-9a-f]+.*)/$", swhid_iframe, - name="swhid-iframe", + name="browse-swhid-iframe", ), ] diff --git a/swh/web/misc/urls.py b/swh/web/misc/urls.py index 87d30106..d48c545c 100644 --- a/swh/web/misc/urls.py +++ b/swh/web/misc/urls.py @@ -1,120 +1,119 @@ # Copyright (C) 2019-2022 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU Affero General Public License version 3, or any later version # See top-level LICENSE file for more information import json import requests from django.conf.urls import include from django.contrib.staticfiles import finders from django.http import JsonResponse from django.shortcuts import render from django.urls import re_path as url from django.views.decorators.clickjacking import xframe_options_exempt from swh.web.config import get_config from swh.web.misc.metrics import prometheus_metrics from swh.web.utils import archive from swh.web.utils.exc import sentry_capture_exception def _jslicenses(request): jslicenses_file = finders.find("jssources/jslicenses.json") jslicenses_data = json.load(open(jslicenses_file)) jslicenses_data = sorted( jslicenses_data.items(), key=lambda item: item[0].split("/")[-1] ) return render(request, "misc/jslicenses.html", {"jslicenses_data": jslicenses_data}) def _stat_counters(request): stat_counters = archive.stat_counters() url = get_config()["history_counters_url"] stat_counters_history = {} try: response = requests.get(url, timeout=5) stat_counters_history = json.loads(response.text) except Exception as exc: sentry_capture_exception(exc) counters = { "stat_counters": stat_counters, "stat_counters_history": stat_counters_history, } return JsonResponse(counters) @xframe_options_exempt def hiring_banner(request): lang = request.GET.get("lang") return render( request, "misc/hiring-banner-iframe.html", { "lang": lang if lang else "en", }, ) urlpatterns = [ url(r"^", include("swh.web.misc.coverage")), url(r"^jslicenses/$", _jslicenses, name="jslicenses"), url(r"^stat_counters/$", _stat_counters, name="stat-counters"), url(r"^", include("swh.web.misc.badges")), url(r"^metrics/prometheus/$", prometheus_metrics, name="metrics-prometheus"), - url(r"^", include("swh.web.misc.iframe")), url(r"^", include("swh.web.misc.fundraising")), url(r"^hiring/banner/$", hiring_banner, name="swh-hiring-banner"), ] # when running end to end tests through cypress, declare some extra # endpoints to provide input data for some of those tests if get_config()["e2e_tests_mode"]: from swh.web.tests.views import ( get_content_code_data_all_exts, get_content_code_data_all_filenames, get_content_code_data_by_ext, get_content_code_data_by_filename, get_content_other_data_by_ext, ) urlpatterns.append( url( r"^tests/data/content/code/extension/(?P.+)/$", get_content_code_data_by_ext, name="tests-content-code-extension", ) ) urlpatterns.append( url( r"^tests/data/content/other/extension/(?P.+)/$", get_content_other_data_by_ext, name="tests-content-other-extension", ) ) urlpatterns.append( url( r"^tests/data/content/code/extensions/$", get_content_code_data_all_exts, name="tests-content-code-extensions", ) ) urlpatterns.append( url( r"^tests/data/content/code/filename/(?P.+)/$", get_content_code_data_by_filename, name="tests-content-code-filename", ) ) urlpatterns.append( url( r"^tests/data/content/code/filenames/$", get_content_code_data_all_filenames, name="tests-content-code-filenames", ) ) diff --git a/swh/web/tests/misc/test_iframe.py b/swh/web/tests/browse/views/test_iframe.py similarity index 57% rename from swh/web/tests/misc/test_iframe.py rename to swh/web/tests/browse/views/test_iframe.py index 9a063304..323084b1 100644 --- a/swh/web/tests/misc/test_iframe.py +++ b/swh/web/tests/browse/views/test_iframe.py @@ -1,106 +1,126 @@ -# Copyright (C) 2021 The Software Heritage developers +# Copyright (C) 2021-2022 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU Affero General Public License version 3, or any later version # See top-level LICENSE file for more information import random from swh.model.hashutil import hash_to_bytes from swh.model.swhids import CoreSWHID, ObjectType, QualifiedSWHID from swh.web.tests.django_asserts import assert_contains from swh.web.tests.helpers import check_html_get_response from swh.web.utils import reverse def test_content_swhid_iframe(client, content_swhid): - url = reverse("swhid-iframe", url_args={"swhid": str(content_swhid)}) + url = reverse("browse-swhid-iframe", url_args={"swhid": str(content_swhid)}) check_html_get_response( - client, url, status_code=200, template_used="misc/iframe.html" + client, url, status_code=200, template_used="browse-iframe.html" ) def test_content_core_swhid_iframe(client, content_swhid): content_core_swhid = CoreSWHID( object_type=content_swhid.object_type, object_id=content_swhid.object_id ) - url = reverse("swhid-iframe", url_args={"swhid": str(content_core_swhid)}) + url = reverse("browse-swhid-iframe", url_args={"swhid": str(content_core_swhid)}) check_html_get_response( - client, url, status_code=200, template_used="misc/iframe.html" + client, url, status_code=200, template_used="browse-iframe.html" ) def test_directory_swhid_iframe(client, directory_swhid): - url = reverse("swhid-iframe", url_args={"swhid": str(directory_swhid)}) + url = reverse("browse-swhid-iframe", url_args={"swhid": str(directory_swhid)}) check_html_get_response( - client, url, status_code=200, template_used="misc/iframe.html" + client, url, status_code=200, template_used="browse-iframe.html" ) def test_directory_core_swhid_iframe(client, directory_swhid): directory_core_swhid = CoreSWHID( object_type=directory_swhid.object_type, object_id=directory_swhid.object_id ) - url = reverse("swhid-iframe", url_args={"swhid": str(directory_core_swhid)}) + url = reverse("browse-swhid-iframe", url_args={"swhid": str(directory_core_swhid)}) check_html_get_response( - client, url, status_code=200, template_used="misc/iframe.html" + client, url, status_code=200, template_used="browse-iframe.html" ) def test_iframe_unsupported_object(client, revision_swhid): - url = reverse("swhid-iframe", url_args={"swhid": str(revision_swhid)}) + url = reverse("browse-swhid-iframe", url_args={"swhid": str(revision_swhid)}) check_html_get_response( - client, url, status_code=400, template_used="misc/iframe.html" + client, url, status_code=400, template_used="browse-iframe.html" ) def test_iframe_object_not_found(client, unknown_directory): swhid = CoreSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(unknown_directory) ) - url = reverse("swhid-iframe", url_args={"swhid": str(swhid)}) + url = reverse("browse-swhid-iframe", url_args={"swhid": str(swhid)}) check_html_get_response( - client, url, status_code=404, template_used="misc/iframe.html" + client, url, status_code=404, template_used="browse-iframe.html" ) def test_swhid_iframe_unknown_error(client, mocker, content_swhid): - mocker.patch("swh.web.misc.iframe.get_swhid").side_effect = Exception("Error") - url = reverse("swhid-iframe", url_args={"swhid": str(content_swhid)}) + mocker.patch("swh.web.browse.views.iframe.get_swhid").side_effect = Exception( + "Error" + ) + url = reverse("browse-swhid-iframe", url_args={"swhid": str(content_swhid)}) check_html_get_response( - client, url, status_code=500, template_used="misc/iframe.html" + client, url, status_code=500, template_used="browse-iframe.html" ) def test_iframe_directory_no_snapshot_context( client, archive_data, directory_with_subdirs ): dir_content = archive_data.directory_ls(directory_with_subdirs) subdir = random.choice([e for e in dir_content if e["type"] == "dir"]) path = f"/{subdir['name']}/" root_swhid = CoreSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(directory_with_subdirs), ) swhid = CoreSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(subdir["target"]) ) qualified_swhid = QualifiedSWHID( object_type=ObjectType.DIRECTORY, object_id=hash_to_bytes(subdir["target"]), anchor=root_swhid, path=path, ) url = reverse( - "swhid-iframe", + "browse-swhid-iframe", url_args={"swhid": f"{str(swhid)};path={path}"}, query_params={"focus_swhid": str(root_swhid)}, ) resp = check_html_get_response( - client, url, status_code=200, template_used="misc/iframe.html" + client, url, status_code=200, template_used="browse-iframe.html" ) archive_url = reverse("browse-swhid", url_args={"swhid": str(qualified_swhid)}) assert_contains(resp, archive_url) + + +def test_iframe_legacy_url_redirection(client, directory_swhid): + directory_core_swhid = CoreSWHID( + object_type=directory_swhid.object_type, object_id=directory_swhid.object_id + ) + url = reverse( + "browse-swhid-iframe-legacy", url_args={"swhid": str(directory_core_swhid)} + ) + resp = check_html_get_response( + client, + url, + status_code=302, + ) + + assert resp["Location"] == reverse( + "browse-swhid-iframe", url_args={"swhid": str(directory_core_swhid)} + )