Page MenuHomeSoftware Heritage
Files F9342478

No OneTemporary
Actions

View Options

diff --git a/swh/deposit/api/private/deposit_check.py b/swh/deposit/api/private/deposit_check.py
index 4b10af6e..a142069c 100644
--- a/swh/deposit/api/private/deposit_check.py
+++ b/swh/deposit/api/private/deposit_check.py
@@ -1,180 +1,183 @@
# Copyright (C) 2017-2018 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
import json
import patoolib
from rest_framework import status
from ..common import SWHGetDepositAPI, SWHPrivateAPIView
from ...config import DEPOSIT_STATUS_VERIFIED, DEPOSIT_STATUS_REJECTED
from ...config import ARCHIVE_TYPE, METADATA_TYPE
from ...models import Deposit, DepositRequest
class SWHChecksDeposit(SWHGetDepositAPI, SWHPrivateAPIView):
"""Dedicated class to read a deposit's raw archives content.
Only GET is supported.
"""
def _deposit_requests(self, deposit, request_type):
"""Given a deposit, yields its associated deposit_request
Args:
deposit (Deposit): Deposit to list requests for
request_type (str): Archive or metadata type
Yields:
deposit requests of type request_type associated to the deposit
"""
deposit_requests = DepositRequest.objects.filter(
type=self.deposit_request_types[request_type],
deposit=deposit).order_by('id')
for deposit_request in deposit_requests:
yield deposit_request
def _check_deposit_archives(self, deposit):
"""Given a deposit, check each deposit request of type archive.
Args:
The deposit to check archives for
Returns
True if all archives are ok, False otherwise.
"""
requests = list(self._deposit_requests(
deposit, request_type=ARCHIVE_TYPE))
if len(requests) == 0: # no associated archive is refused
return False
for dr in requests:
check = self._check_archive(dr.archive.path)
if not check:
return False
return True
def _check_archive(self, archive_path):
"""Check that a given archive is actually ok for reading.
Args:
archive_path (str): Archive to check
Returns:
True if archive is successfully read, False otherwise.
"""
try:
patoolib.test_archive(archive_path, verbosity=-1)
except:
return False
else:
return True
def _metadata_get(self, deposit):
"""Given a deposit, aggregate all metadata requests.
Args:
The deposit to check metadata for.
Returns:
True if the deposit's associated metadata are ok, False otherwise.
"""
metadata = {}
for dr in self._deposit_requests(deposit, request_type=METADATA_TYPE):
metadata.update(dr.metadata)
return metadata
def _check_metadata(self, metadata):
"""Check to execute on all metadata for mandatory field presence.
Args:
metadata (dict): Metadata to actually check
Returns:
True if metadata is ok, False otherwise.
"""
required_fields = (('url',),
('external_identifier',),
('name', 'title'),
('author',))
result = all(any(name in field
for field in metadata
for name in possible_names)
for possible_names in required_fields)
return result
def _check_url(self, client_domain, metadata):
"""Check compatibility between client_domain and url field in metadata
Args:
client_domain (str): url associated with the deposit's client
metadata (dict): Metadata where to find url
Returns:
True if url is ok, False otherwise.
"""
metadata_urls = []
for field in metadata:
if 'url' in field:
metadata_urls.append(metadata[field])
return any(client_domain in url
for url in metadata_urls)
def process_get(self, req, collection_name, deposit_id):
"""Build a unique tarball from the multiple received and stream that
content to the client.
Args:
req (Request):
collection_name (str): Collection owning the deposit
deposit_id (id): Deposit concerned by the reading
Returns:
Tuple status, stream of content, content-type
"""
deposit = Deposit.objects.get(pk=deposit_id)
client_domain = deposit.client.domain
metadata = self._metadata_get(deposit)
problems = []
# will check each deposit's associated request (both of type
# archive and metadata) for errors
archives_status = self._check_deposit_archives(deposit)
if not archives_status:
problems.append('archive(s)')
metadata_status = self._check_metadata(metadata)
if not metadata_status:
problems.append('metadata')
url_status = self._check_url(client_domain, metadata)
if not url_status:
problems.append('url')
deposit_status = archives_status and metadata_status and url_status
# if any problems arose, the deposit is rejected
if not deposit_status:
deposit.status = DEPOSIT_STATUS_REJECTED
+ response = {
+ 'status': deposit.status,
+ 'details': 'Some %s failed the checks.' % (
+ ' and '.join(problems), ),
+ }
else:
deposit.status = DEPOSIT_STATUS_VERIFIED
+ response = {
+ 'status': deposit.status,
+ }
+
deposit.save()
- return (status.HTTP_200_OK,
- json.dumps({
- 'status': deposit.status,
- 'details': 'Some %s failed the checks.' % (
- ' and '.join(problems), ),
- }),
- 'application/json')
+ return status.HTTP_200_OK, json.dumps(response), 'application/json'

File Metadata

Mime Type
text/x-diff
Expires
Fri, Jul 4, 12:45 PM (2 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3252023

Event Timeline

About · Developer information · Legal