Page MenuHomeSoftware Heritage
Files F9343065

origin_save.py
No OneTemporary
Actions

origin_save.py
View Options

# Copyright (C) 2018-2021 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.conf.urls import url
from django.core.paginator import Paginator
from django.db.models import Q
from django.http import JsonResponse
from django.shortcuts import render
from rest_framework.decorators import api_view, authentication_classes
from swh.web.api.throttling import throttle_scope
from swh.web.common.exc import ForbiddenExc
from swh.web.common.models import SaveOriginRequest
from swh.web.common.origin_save import (
create_save_origin_request,
get_savable_visit_types,
get_save_origin_task_info,
)
from swh.web.common.utils import EnforceCSRFAuthentication
def _origin_save_view(request):
return render(
request,
"misc/origin-save.html",
{"heading": ("Request the saving of a software origin into " "the archive")},
)
@api_view(["POST"])
@authentication_classes((EnforceCSRFAuthentication,))
@throttle_scope("swh_save_origin")
def _origin_save_request(request, visit_type, origin_url):
"""
This view is called through AJAX from the save code now form of swh-web.
We use DRF here as we want to rate limit the number of submitted requests
per user to avoid being possibly flooded by bots.
"""
try:
response = create_save_origin_request(visit_type, origin_url)
return JsonResponse(response)
except ForbiddenExc as exc:
return JsonResponse({"detail": str(exc)}, status=403)
except Exception as exc:
return JsonResponse({"detail": str(exc)}, status=500)
def _visit_save_types_list(request):
visit_types = get_savable_visit_types()
return JsonResponse(visit_types, safe=False)
def _origin_save_requests_list(request, status):
if status != "all":
save_requests = SaveOriginRequest.objects.filter(status=status)
else:
save_requests = SaveOriginRequest.objects.all()
table_data = {}
table_data["recordsTotal"] = save_requests.count()
table_data["draw"] = int(request.GET["draw"])
search_value = request.GET["search[value]"]
column_order = request.GET["order[0][column]"]
field_order = request.GET["columns[%s][name]" % column_order]
order_dir = request.GET["order[0][dir]"]
if order_dir == "desc":
field_order = "-" + field_order
save_requests = save_requests.order_by(field_order)
length = int(request.GET["length"])
page = int(request.GET["start"]) / length + 1
if search_value:
save_requests = save_requests.filter(
Q(status__icontains=search_value)
| Q(loading_task_status__icontains=search_value)
| Q(visit_type__icontains=search_value)
| Q(origin_url__icontains=search_value)
)
table_data["recordsFiltered"] = save_requests.count()
paginator = Paginator(save_requests, length)
table_data["data"] = [sor.to_dict() for sor in paginator.page(page).object_list]
return JsonResponse(table_data)
def _save_origin_task_info(request, save_request_id):
request_info = get_save_origin_task_info(
save_request_id, full_info=request.user.is_staff
)
for date_field in ("scheduled", "started", "ended"):
if date_field in request_info and request_info[date_field] is not None:
request_info[date_field] = request_info[date_field].isoformat()
return JsonResponse(request_info)
urlpatterns = [
url(r"^save/$", _origin_save_view, name="origin-save"),
url(
r"^save/(?P<visit_type>.+)/url/(?P<origin_url>.+)/$",
_origin_save_request,
name="origin-save-request",
),
url(r"^save/types/list/$", _visit_save_types_list, name="origin-save-types-list"),
url(
r"^save/requests/list/(?P<status>.+)/$",
_origin_save_requests_list,
name="origin-save-requests-list",
),
url(
r"^save/task/info/(?P<save_request_id>.+)/",
_save_origin_task_info,
name="origin-save-task-info",
),
]

File Metadata

Mime Type
text/x-python
Expires
Fri, Jul 4, 1:14 PM (1 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3363671

Event Timeline

About · Developer information · Legal