Differential D6521 Diff 23705 swh/objstorage/backends/http.py

Changeset View

Standalone View

swh/objstorage/backends/http.py

This file was added.

				# Copyright (C) 2021 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 logging
				from urllib.parse import urljoin

				import requests

				from swh.model import hashutil
				from swh.objstorage.exc import Error, ObjNotFoundError
				from swh.objstorage.objstorage import (
				DEFAULT_LIMIT,
				ObjStorage,
				compute_hash,
				decompressors,
				)

				LOGGER = logging.getLogger(__name__)
				LOGGER.setLevel(logging.ERROR)


				class HTTPReadOnlyObjStorage(ObjStorage):
				"""Simple ObjStorage retrieving objects from an HTTP server.

				For example, can be used to retrieve objects from S3:

				objstorage:
				cls: http
				url: https://softwareheritage.s3.amazonaws.com/content/
				"""

				def __init__(self, url=None, compression=None, **kwargs):
				super().__init__(**kwargs)
				self.session = requests.sessions.Session()
				self.root_path = url
				if not self.root_path.endswith("/"):
				self.root_path += "/"
				self.compression = compression

				def check_config(self, *, check_write):
				"""Check the configuration for this object storage"""
				# FIXME: hopefully this blew up during instantiation
				vlorentzUnsubmitted Done Inline Actions why would it? vlorentz: why would it?
				douarddaAuthorUnsubmitted Done Inline Actions blind copy/paste... will remove douardda: blind copy/paste... will remove
				return True

				def __contains__(self, obj_id):
				resp = self.session.head(self._path(obj_id))
				return resp.status_code == 200

				def __iter__(self):
				raise NotImplementedError()

				def __len__(self):
				raise NotImplementedError()

				def add(self, content, obj_id=None, check_presence=True):
				raise NotImplementedError()

				def restore(self, content, obj_id=None):
				raise NotImplementedError()
				vlorentzUnsubmitted Done Inline Actions could you add messages? Just `"HTTPReadOnlyObjStorage does not implement xxx"` would be fine. (the traceback isn't always preserved when the error goes through a serialization layer) vlorentz: could you add messages? Just `"HTTPReadOnlyObjStorage does not implement xxx"` would be fine.
				douarddaAuthorUnsubmitted Done Inline Actions good thinking, will do douardda: good thinking, will do

				def get(self, obj_id):
				try:
				resp = self.session.get(self._path(obj_id))
				resp.raise_for_status()
				except Exception:
				raise ObjNotFoundError(obj_id)

				ret: bytes = resp.content
				if self.compression:
				d = decompressors[self.compression]()
				ret = d.decompress(ret)
				if d.unused_data:
				hex_obj_id = hashutil.hash_to_hex(obj_id)
				raise Error("Corrupt object %s: trailing data found" % hex_obj_id)
				return ret

				def check(self, obj_id):
				# Check the content integrity
				obj_content = self.get(obj_id)
				content_obj_id = compute_hash(obj_content)
				if content_obj_id != obj_id:
				raise Error(obj_id)

				def delete(self, obj_id):
				raise NotImplementedError()

				def list_content(self, last_obj_id=None, limit=DEFAULT_LIMIT):
				raise NotImplementedError()

				def _path(self, obj_id):
				return urljoin(self.root_path, hashutil.hash_to_hex(obj_id))