######################################################################
#
# File: b2sdk/raw_simulator.py
#
# Copyright 2019 Backblaze Inc. All Rights Reserved.
#
# License https://www.backblaze.com/using_b2_code.html
#
######################################################################
import collections
import io
import random
import re
import time
import threading
from .b2http import ResponseContextManager
from .exception import (
BadJson,
BadUploadUrl,
ChecksumMismatch,
Conflict,
DuplicateBucketName,
FileNotPresent,
FileSha1Mismatch,
InvalidAuthToken,
InvalidMetadataDirective,
MissingPart,
NonExistentBucket,
PartSha1Mismatch,
Unauthorized,
UnsatisfiableRange,
)
from .raw_api import AbstractRawApi, HEX_DIGITS_AT_END, MetadataDirectiveMode
from .utils import (
b2_url_decode,
b2_url_encode,
ConcurrentUsedAuthTokenGuard,
hex_sha1_of_bytes,
)
from .stream.hashing import StreamWithHash
ALL_CAPABILITES = [
'listKeys',
'writeKeys',
'deleteKeys',
'listBuckets',
'writeBuckets',
'deleteBuckets',
'listFiles',
'readFiles',
'shareFiles',
'writeFiles',
'deleteFiles',
]
[docs]def get_bytes_range(data_bytes, bytes_range):
""" Slice bytes array using bytes range """
if bytes_range is None:
return data_bytes
if bytes_range[0] > bytes_range[1]:
raise UnsatisfiableRange()
if bytes_range[0] < 0:
raise UnsatisfiableRange()
if bytes_range[1] > len(data_bytes):
raise UnsatisfiableRange()
return data_bytes[bytes_range[0]:bytes_range[1]]
[docs]class KeySimulator(object):
"""
Hold information about one application key, which can be either
a master application key, or one created with create_key().
"""
[docs] def __init__(
self, account_id, name, application_key_id, key, capabilities, expiration_timestamp_or_none,
bucket_id_or_none, bucket_name_or_none, name_prefix_or_none
):
self.name = name
self.account_id = account_id
self.application_key_id = application_key_id
self.key = key
self.capabilities = capabilities
self.expiration_timestamp_or_none = expiration_timestamp_or_none
self.bucket_id_or_none = bucket_id_or_none
self.name_prefix_or_none = name_prefix_or_none
[docs] def as_key(self):
return dict(
accountId=self.account_id,
bucketId=self.bucket_id_or_none,
applicationKey=self.key,
applicationKeyId=self.application_key_id,
capabilities=self.capabilities,
expirationTimestamp=self.expiration_timestamp_or_none,
keyName=self.name,
namePrefix=self.name_prefix_or_none,
)
[docs] def as_created_key(self):
"""
Return the dict returned by b2_create_key.
This is just like the one for b2_list_keys, but also includes the secret key.
"""
result = self.as_key()
result['applicationKey'] = self.key
return result
[docs] def get_allowed(self):
"""
Return the 'allowed' structure to include in the response from b2_authorize_account.
"""
return dict(
bucketId=self.bucket_id_or_none,
capabilities=self.capabilities,
namePrefix=self.name_prefix_or_none,
)
[docs]class PartSimulator(object):
[docs] def __init__(self, file_id, part_number, content_length, content_sha1, part_data):
self.file_id = file_id
self.part_number = part_number
self.content_length = content_length
self.content_sha1 = content_sha1
self.part_data = part_data
[docs] def as_list_parts_dict(self):
return dict(
fileId=self.file_id,
partNumber=self.part_number,
contentLength=self.content_length,
contentSha1=self.content_sha1
) # yapf: disable
[docs]class FileSimulator(object):
"""
One of three: an unfinished large file, a finished file, or a deletion marker.
"""
[docs] def __init__(
self,
account_id,
bucket_id,
file_id,
action,
name,
content_type,
content_sha1,
file_info,
data_bytes,
upload_timestamp,
range_=None
):
self.account_id = account_id
self.bucket_id = bucket_id
self.file_id = file_id
self.action = action
self.name = name
if data_bytes is not None:
self.content_length = len(data_bytes)
self.content_type = content_type
self.content_sha1 = content_sha1
self.file_info = file_info
self.data_bytes = data_bytes
self.upload_timestamp = upload_timestamp
self.range_ = range_
if action == 'start':
self.parts = []
[docs] def sort_key(self):
"""
Return a key that can be used to sort the files in a
bucket in the order that b2_list_file_versions returns them.
"""
return (self.name, self.file_id)
[docs] def as_upload_result(self):
return dict(
fileId=self.file_id,
fileName=self.name,
accountId=self.account_id,
bucketId=self.bucket_id,
contentLength=len(self.data_bytes) if self.data_bytes is not None else 0,
contentType=self.content_type,
contentSha1=self.content_sha1,
fileInfo=self.file_info,
action=self.action,
uploadTimestamp=self.upload_timestamp
) # yapf: disable
[docs] def as_list_files_dict(self):
return dict(
fileId=self.file_id,
fileName=self.name,
contentLength=len(self.data_bytes) if self.data_bytes is not None else 0,
contentType=self.content_type,
contentSha1=self.content_sha1,
fileInfo=self.file_info,
action=self.action,
uploadTimestamp=self.upload_timestamp
) # yapf: disable
[docs] def as_start_large_file_result(self):
return dict(
fileId=self.file_id,
fileName=self.name,
accountId=self.account_id,
bucketId=self.bucket_id,
contentType=self.content_type,
fileInfo=self.file_info,
uploadTimestamp=self.upload_timestamp
) # yapf: disable
[docs] def add_part(self, part_number, part):
while len(self.parts) < part_number + 1:
self.parts.append(None)
self.parts[part_number] = part
[docs] def finish(self, part_sha1_array):
last_part_number = max(part.part_number for part in self.parts if part is not None)
for part_number in range(1, last_part_number + 1):
if self.parts[part_number] is None:
raise MissingPart(part_number)
my_part_sha1_array = [
self.parts[part_number].content_sha1 for part_number in range(1, last_part_number + 1)
]
if part_sha1_array != my_part_sha1_array:
raise ChecksumMismatch(
'sha1', expected=str(part_sha1_array), actual=str(my_part_sha1_array)
)
self.data_bytes = b''.join(
self.parts[part_number].part_data for part_number in range(1, last_part_number + 1)
)
self.content_length = len(self.data_bytes)
self.action = 'upload'
[docs] def is_visible(self):
"""
Does this file show up in b2_list_file_names?
"""
return self.action == 'upload'
[docs] def list_parts(self, start_part_number, max_part_count):
start_part_number = start_part_number or 1
max_part_count = max_part_count or 100
parts = [
part.as_list_parts_dict()
for part in self.parts if part is not None and start_part_number <= part.part_number
]
if len(parts) <= max_part_count:
next_part_number = None
else:
next_part_number = parts[max_part_count]['partNumber']
parts = parts[:max_part_count]
return dict(parts=parts, nextPartNumber=next_part_number)
FakeRequest = collections.namedtuple('FakeRequest', 'url headers')
[docs]class FakeResponse(object):
[docs] def __init__(self, file_sim, url, range_=None):
self.data_bytes = file_sim.data_bytes
self.headers = file_sim.as_download_headers(range_)
self.url = url
self.range_ = range_
if range_ is not None:
self.data_bytes = self.data_bytes[range_[0]:range_[1] + 1]
[docs] def iter_content(self, chunk_size=1):
start = 0
rnd = random.Random(self.url)
while start <= len(self.data_bytes):
time.sleep(rnd.random() * 0.01)
yield self.data_bytes[start:start + chunk_size]
start += chunk_size
@property
def request(self):
headers = {}
if self.range_ is not None:
headers['Range'] = '%s-%s' % self.range_
return FakeRequest(self.url, headers)
[docs]class BucketSimulator(object):
# File IDs start at 9999 and count down, so they sort in the order
# returned by list_file_versions. The IDs are strings.
FIRST_FILE_NUMBER = 9999
FIRST_FILE_ID = str(FIRST_FILE_NUMBER)
FILE_SIMULATOR_CLASS = FileSimulator
RESPONSE_CLASS = FakeResponse
[docs] def __init__(
self,
account_id,
bucket_id,
bucket_name,
bucket_type,
bucket_info=None,
cors_rules=None,
lifecycle_rules=None,
options_set=None
):
assert bucket_type in ['allPrivate', 'allPublic']
self.account_id = account_id
self.bucket_name = bucket_name
self.bucket_id = bucket_id
self.bucket_type = bucket_type
self.bucket_info = bucket_info or {}
self.cors_rules = cors_rules or []
self.lifecycle_rules = lifecycle_rules or []
self.options_set = options_set or set()
self.revision = 1
self.upload_url_counter = iter(range(200))
# File IDs count down, so that the most recent will come first when they are sorted.
self.file_id_counter = iter(range(self.FIRST_FILE_NUMBER, 0, -1))
self.upload_timestamp_counter = iter(range(5000, 9999))
self.file_id_to_file = dict()
# It would be nice to use an OrderedDict for this, but 2.6 doesn't have it.
self.file_name_and_id_to_file = dict()
[docs] def bucket_dict(self):
return dict(
accountId=self.account_id,
bucketName=self.bucket_name,
bucketId=self.bucket_id,
bucketType=self.bucket_type,
bucketInfo=self.bucket_info,
corsRules=self.cors_rules,
lifecycleRules=self.lifecycle_rules,
options=self.options_set,
revision=self.revision,
)
[docs] def cancel_large_file(self, file_id):
file_sim = self.file_id_to_file[file_id]
key = (file_sim.name, file_id)
del self.file_name_and_id_to_file[key]
del self.file_id_to_file[file_id]
return dict(
accountId=self.account_id,
bucketId=self.bucket_id,
fileId=file_id,
fileName=file_sim.name
) # yapf: disable
[docs] def delete_file_version(self, file_id, file_name):
key = (file_name, file_id)
file_sim = self.file_name_and_id_to_file[key]
del self.file_name_and_id_to_file[key]
del self.file_id_to_file[file_id]
return dict(fileId=file_id, fileName=file_name, uploadTimestamp=file_sim.upload_timestamp)
[docs] def download_file_by_id(self, file_id, url, range_=None):
file_sim = self.file_id_to_file[file_id]
return self._download_file_sim(file_sim, url, range_=range_)
[docs] def download_file_by_name(self, file_name, url, range_=None):
files = self.list_file_names(file_name, 1)['files']
if len(files) == 0:
raise FileNotPresent(file_id_or_name=file_name)
file_dict = files[0]
if file_dict['fileName'] != file_name or file_dict['action'] != 'upload':
raise FileNotPresent(file_id_or_name=file_name)
file_sim = self.file_name_and_id_to_file[(file_name, file_dict['fileId'])]
return self._download_file_sim(file_sim, url, range_=range_)
def _download_file_sim(self, file_sim, url, range_=None):
return ResponseContextManager(self.RESPONSE_CLASS(file_sim, url, range_))
[docs] def finish_large_file(self, file_id, part_sha1_array):
file_sim = self.file_id_to_file[file_id]
file_sim.finish(part_sha1_array)
return file_sim.as_upload_result()
[docs] def get_file_info_by_id(self, file_id):
return self.file_id_to_file[file_id].as_upload_result()
[docs] def get_file_info_by_name(self, file_name):
for ((name, id), file) in self.file_name_and_id_to_file.items():
if file_name == name:
return file.as_download_headers()
raise FileNotPresent(file_id_or_name=file_name, bucket_name=self.bucket_name)
[docs] def get_upload_url(self):
upload_id = next(self.upload_url_counter)
upload_url = 'https://upload.example.com/%s/%s' % (self.bucket_id, upload_id)
return dict(bucketId=self.bucket_id, uploadUrl=upload_url, authorizationToken=upload_url)
[docs] def get_upload_part_url(self, file_id):
upload_url = 'https://upload.example.com/part/%s/%d' % (file_id, random.randint(1, 10**9))
return dict(bucketId=self.bucket_id, uploadUrl=upload_url, authorizationToken=upload_url)
[docs] def hide_file(self, file_name):
file_id = self._next_file_id()
file_sim = self.FILE_SIMULATOR_CLASS(
self.account_id, self.bucket_id, file_id, 'hide', file_name, None, "none", {}, b'',
next(self.upload_timestamp_counter)
)
self.file_id_to_file[file_id] = file_sim
self.file_name_and_id_to_file[file_sim.sort_key()] = file_sim
return file_sim.as_list_files_dict()
[docs] def copy_file(
self,
file_id,
new_file_name,
bytes_range=None,
metadata_directive=None,
content_type=None,
file_info=None,
destination_bucket_id=None,
):
if metadata_directive is not None:
assert metadata_directive in tuple(MetadataDirectiveMode)
if metadata_directive is MetadataDirectiveMode.COPY and (
content_type is not None or file_info is not None
):
raise InvalidMetadataDirective(
'content_type and file_info should be None when metadata_directive is COPY'
)
elif metadata_directive is MetadataDirectiveMode.REPLACE and content_type is None:
raise InvalidMetadataDirective(
'content_type cannot be None when metadata_directive is REPLACE'
)
file_sim = self.file_id_to_file[file_id]
new_file_id = self._next_file_id()
data_bytes = get_bytes_range(file_sim.data_bytes, bytes_range)
destination_bucket_id = destination_bucket_id or self.bucket_id
copy_file_sim = self.FILE_SIMULATOR_CLASS(
self.account_id, destination_bucket_id, new_file_id, 'copy', new_file_name,
file_sim.content_type, file_sim.content_sha1, file_sim.file_info, data_bytes,
next(self.upload_timestamp_counter)
)
if metadata_directive is MetadataDirectiveMode.REPLACE:
copy_file_sim.content_type = content_type
copy_file_sim.file_info = file_info or file_sim.file_info
return copy_file_sim
[docs] def list_file_names(self, start_file_name=None, max_file_count=None, prefix=None):
assert prefix is None or start_file_name is None or start_file_name.startswith(prefix
), locals()
start_file_name = start_file_name or ''
max_file_count = max_file_count or 100
result_files = []
next_file_name = None
prev_file_name = None
for key in sorted(self.file_name_and_id_to_file):
(file_name, file_id) = key
assert file_id
if start_file_name <= file_name and file_name != prev_file_name:
if prefix is not None and not file_name.startswith(prefix):
break
prev_file_name = file_name
file_sim = self.file_name_and_id_to_file[key]
if file_sim.is_visible():
result_files.append(file_sim.as_list_files_dict())
if len(result_files) == max_file_count:
next_file_name = file_sim.name + ' '
break
return dict(files=result_files, nextFileName=next_file_name)
[docs] def list_file_versions(
self,
start_file_name=None,
start_file_id=None,
max_file_count=None,
prefix=None,
):
assert prefix is None or start_file_name is None or start_file_name.startswith(prefix
), locals()
start_file_name = start_file_name or ''
start_file_id = start_file_id or ''
max_file_count = max_file_count or 100
result_files = []
next_file_name = None
next_file_id = None
for key in sorted(self.file_name_and_id_to_file):
(file_name, file_id) = key
if (start_file_name < file_name) or (
start_file_name == file_name and
(start_file_id == '' or int(start_file_id) <= int(file_id))
):
file_sim = self.file_name_and_id_to_file[key]
if prefix is not None and not file_name.startswith(prefix):
break
result_files.append(file_sim.as_list_files_dict())
if len(result_files) == max_file_count:
next_file_name = file_sim.name
next_file_id = str(int(file_id) + 1)
break
return dict(files=result_files, nextFileName=next_file_name, nextFileId=next_file_id)
[docs] def list_parts(self, file_id, start_part_number, max_part_count):
file_sim = self.file_id_to_file[file_id]
return file_sim.list_parts(start_part_number, max_part_count)
[docs] def list_unfinished_large_files(self, start_file_id=None, max_file_count=None, prefix=None):
start_file_id = start_file_id or self.FIRST_FILE_ID
max_file_count = max_file_count or 100
all_unfinished_ids = set(
k for (k, v) in self.file_id_to_file.items()
if v.action == 'start' and k <= start_file_id and
(prefix is None or v.name.startswith(prefix))
)
ids_in_order = sorted(all_unfinished_ids, reverse=True)
file_dict_list = [
dict(
fileId=file_sim.file_id,
fileName=file_sim.name,
accountId=file_sim.account_id,
bucketId=file_sim.bucket_id,
contentType=file_sim.content_type,
fileInfo=file_sim.file_info
)
for file_sim in (
self.file_id_to_file[file_id] for file_id in ids_in_order[:max_file_count]
)
] # yapf: disable
next_file_id = None
if len(file_dict_list) == max_file_count:
next_file_id = str(int(file_dict_list[-1]['fileId']) - 1)
return dict(files=file_dict_list, nextFileId=next_file_id)
[docs] def start_large_file(self, file_name, content_type, file_info):
file_id = self._next_file_id()
file_sim = self.FILE_SIMULATOR_CLASS(
self.account_id, self.bucket_id, file_id, 'start', file_name, content_type, 'none',
file_info, None, next(self.upload_timestamp_counter)
) # yapf: disable
self.file_id_to_file[file_id] = file_sim
self.file_name_and_id_to_file[file_sim.sort_key()] = file_sim
return file_sim.as_start_large_file_result()
[docs] def update_bucket(
self,
bucket_type=None,
bucket_info=None,
cors_rules=None,
lifecycle_rules=None,
if_revision_is=None
):
if if_revision_is is not None and self.revision != if_revision_is:
raise Conflict()
if bucket_type is not None:
self.bucket_type = bucket_type
if bucket_info is not None:
self.bucket_info = bucket_info
if cors_rules is not None:
self.cors_rules = cors_rules
if lifecycle_rules is not None:
self.lifecycle_rules = lifecycle_rules
self.revision += 1
return self.bucket_dict()
[docs] def upload_file(
self, upload_id, upload_auth_token, file_name, content_length, content_type, content_sha1,
file_infos, data_stream
):
data_bytes = self._simulate_chunked_post(data_stream, content_length)
assert len(data_bytes) == content_length
if content_sha1 == HEX_DIGITS_AT_END:
content_sha1 = data_bytes[-40:].decode()
data_bytes = data_bytes[0:-40]
content_length -= 40
computed_sha1 = hex_sha1_of_bytes(data_bytes)
if content_sha1 != computed_sha1:
raise FileSha1Mismatch(file_name)
file_id = self._next_file_id()
file_sim = self.FILE_SIMULATOR_CLASS(
self.account_id, self.bucket_id, file_id, 'upload', file_name, content_type,
content_sha1, file_infos, data_bytes, next(self.upload_timestamp_counter)
)
self.file_id_to_file[file_id] = file_sim
self.file_name_and_id_to_file[file_sim.sort_key()] = file_sim
return file_sim.as_upload_result()
[docs] def upload_part(self, file_id, part_number, content_length, sha1_sum, input_stream):
file_sim = self.file_id_to_file[file_id]
part_data = self._simulate_chunked_post(input_stream, content_length)
assert len(part_data) == content_length
if sha1_sum == HEX_DIGITS_AT_END:
sha1_sum = part_data[-40:].decode()
part_data = part_data[0:-40]
content_length -= 40
computed_sha1 = hex_sha1_of_bytes(part_data)
if sha1_sum != computed_sha1:
raise PartSha1Mismatch(file_id)
part = PartSimulator(file_sim.file_id, part_number, content_length, sha1_sum, part_data)
file_sim.add_part(part_number, part)
return dict(
fileId=file_id,
partNumber=part_number,
contentLength=content_length,
contentSha1=sha1_sum
) # yapf: disable
def _simulate_chunked_post(
self, stream, content_length, min_chunks=4, max_chunk_size=8096, simulate_retry=True
):
chunk_size = max_chunk_size
chunks_num = self._chunks_number(content_length, chunk_size)
if chunks_num < min_chunks:
chunk_size = max(content_length // min_chunks, 1)
loop_count = 2 if simulate_retry else 1
stream_data = None
for _ in range(loop_count):
chunks = []
stream.seek(0) # we always do this in `do_post` in `b2http` so we want it here *always*
while True:
data = stream.read(chunk_size)
chunks.append(data)
if not data:
break
_stream_data = b''.join(chunks)
if stream_data is not None:
assert _stream_data == stream_data
stream_data = _stream_data
return stream_data
def _chunks_number(self, content_length, chunk_size):
chunks_number = content_length // chunk_size
if content_length % chunk_size > 0:
chunks_number = chunks_number + 1
return chunks_number
def _next_file_id(self):
return str(next(self.file_id_counter))
[docs]class RawSimulator(AbstractRawApi):
"""
Implement the same interface as B2RawApi by simulating all of the
calls and keeping state in memory.
The intended use for this class is for unit tests that test things
built on top of B2RawApi.
"""
BUCKET_SIMULATOR_CLASS = BucketSimulator
API_URL = 'http://api.example.com'
DOWNLOAD_URL = 'http://download.example.com'
MIN_PART_SIZE = 200
# This is the maximum duration in seconds that an application key can be valid (1000 days).
MAX_DURATION_IN_SECONDS = 86400000
UPLOAD_PART_MATCHER = re.compile('https://upload.example.com/part/([^/]*)')
UPLOAD_URL_MATCHER = re.compile(r'https://upload.example.com/([^/]*)/([^/]*)')
DOWNLOAD_URL_MATCHER = re.compile(
DOWNLOAD_URL + '(?:' + '|'.join(
(
'/b2api/v[0-9]+/b2_download_file_by_id\?fileId=(?P<file_id>[^/]+)',
'/file/(?P<bucket_name>[^/]+)/(?P<file_name>.+)',
)
) + ')$'
) # yapf: disable
[docs] def __init__(self):
# Map from application_key_id to KeySimulator.
# The entry for the master application key ID is for the master application
# key for the account, and the entries with non-master application keys
# are for keys created b2 createKey().
self.key_id_to_key = dict()
# Map from auth token to the KeySimulator for it.
self.auth_token_to_key = dict()
# Set of auth tokens that have expired
self.expired_auth_tokens = set()
# Map from auth token to a lock that upload procedure acquires
# when utilizing the token
self.currently_used_auth_tokens = collections.defaultdict(threading.Lock)
# Counter for generating auth tokens.
self.auth_token_counter = 0
# Counter for generating account IDs an their matching master application keys.
self.account_counter = 0
self.bucket_name_to_bucket = dict()
self.bucket_id_to_bucket = dict()
self.bucket_id_counter = iter(range(100))
self.file_id_to_bucket_id = {}
self.all_application_keys = []
self.app_key_counter = 0
self.upload_errors = []
[docs] def expire_auth_token(self, auth_token):
"""
Simulate the auth token expiring.
The next call that tries to use this auth token will get an
auth_token_expired error.
"""
assert auth_token in self.auth_token_to_key
self.expired_auth_tokens.add(auth_token)
[docs] def create_account(self):
"""
Return (accountId, masterApplicationKey) for a newly created account.
"""
# Pick the IDs for the account and the key
account_id = 'account-%d' % (self.account_counter,)
master_key = 'masterKey-%d' % (self.account_counter,)
self.account_counter += 1
# Create the key
self.key_id_to_key[account_id] = KeySimulator(
account_id=account_id,
name='master',
application_key_id=account_id,
key=master_key,
capabilities=ALL_CAPABILITES,
expiration_timestamp_or_none=None,
bucket_id_or_none=None,
bucket_name_or_none=None,
name_prefix_or_none=None,
)
# Return the info
return (account_id, master_key)
[docs] def set_upload_errors(self, errors):
"""
Store a sequence of exceptions to raise on upload. Each one will
be raised in turn, until they are all gone. Then the next upload
will succeed.
"""
assert len(self.upload_errors) == 0
self.upload_errors = errors
[docs] def authorize_account(self, realm_url, application_key_id, application_key):
key_sim = self.key_id_to_key.get(application_key_id)
if key_sim is None:
raise InvalidAuthToken('application key ID not valid', 'unauthorized')
if application_key != key_sim.key:
raise InvalidAuthToken('secret key is wrong', 'unauthorized')
auth_token = 'auth_token_%d' % (self.auth_token_counter,)
self.auth_token_counter += 1
self.auth_token_to_key[auth_token] = key_sim
allowed = key_sim.get_allowed()
bucketId = allowed.get('bucketId')
if (bucketId is not None) and (bucketId in self.bucket_id_to_bucket):
allowed['bucketName'] = self.bucket_id_to_bucket[bucketId].bucket_name
else:
allowed['bucketName'] = None
return dict(
accountId=key_sim.account_id,
authorizationToken=auth_token,
apiUrl=self.API_URL,
downloadUrl=self.DOWNLOAD_URL,
recommendedPartSize=self.MIN_PART_SIZE,
absoluteMinimumPartSize=self.MIN_PART_SIZE,
allowed=allowed,
)
[docs] def cancel_large_file(self, api_url, account_auth_token, file_id):
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
return bucket.cancel_large_file(file_id)
[docs] def create_bucket(
self,
api_url,
account_auth_token,
account_id,
bucket_name,
bucket_type,
bucket_info=None,
cors_rules=None,
lifecycle_rules=None
):
if not re.match(r'^[-a-zA-Z0-9]*$', bucket_name):
raise BadJson('illegal bucket name: ' + bucket_name)
self._assert_account_auth(api_url, account_auth_token, account_id, 'writeBuckets')
if bucket_name in self.bucket_name_to_bucket:
raise DuplicateBucketName(bucket_name)
bucket_id = 'bucket_' + str(next(self.bucket_id_counter))
bucket = self.BUCKET_SIMULATOR_CLASS(
account_id, bucket_id, bucket_name, bucket_type, bucket_info, cors_rules,
lifecycle_rules
)
self.bucket_name_to_bucket[bucket_name] = bucket
self.bucket_id_to_bucket[bucket_id] = bucket
return bucket.bucket_dict()
[docs] def create_key(
self, api_url, account_auth_token, account_id, capabilities, key_name,
valid_duration_seconds, bucket_id, name_prefix
):
if not re.match(r'^[A-Za-z0-9-]{1,100}$', key_name):
raise BadJson('illegal key name: ' + key_name)
if valid_duration_seconds is not None:
if valid_duration_seconds < 1 or valid_duration_seconds > self.MAX_DURATION_IN_SECONDS:
raise BadJson(
'valid duration must be greater than 0, and less than 1000 days in seconds'
)
self._assert_account_auth(api_url, account_auth_token, account_id, 'writeKeys')
if valid_duration_seconds is None:
expiration_timestamp_or_none = None
else:
expiration_timestamp_or_none = int(time.time() + valid_duration_seconds)
index = self.app_key_counter
self.app_key_counter += 1
application_key_id = 'appKeyId%d' % (index,)
app_key = 'appKey%d' % (index,)
if bucket_id is None:
bucket_name_or_none = None
else:
bucket_name_or_none = self._get_bucket_by_id(bucket_id).bucket_name
key_sim = KeySimulator(
account_id=account_id,
name=key_name,
application_key_id=application_key_id,
key=app_key,
capabilities=capabilities,
expiration_timestamp_or_none=expiration_timestamp_or_none,
bucket_id_or_none=bucket_id,
bucket_name_or_none=bucket_name_or_none,
name_prefix_or_none=name_prefix
)
self.key_id_to_key[application_key_id] = key_sim
self.all_application_keys.append(key_sim)
return key_sim.as_created_key()
[docs] def delete_file_version(self, api_url, account_auth_token, file_id, file_name):
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'deleteFiles')
return bucket.delete_file_version(file_id, file_name)
[docs] def delete_bucket(self, api_url, account_auth_token, account_id, bucket_id):
self._assert_account_auth(api_url, account_auth_token, account_id, 'deleteBuckets')
bucket = self._get_bucket_by_id(bucket_id)
del self.bucket_name_to_bucket[bucket.bucket_name]
del self.bucket_id_to_bucket[bucket_id]
return bucket.bucket_dict()
[docs] def download_file_from_url(self, account_auth_token_or_none, url, range_=None):
# TODO: check auth token if bucket is not public
matcher = self.DOWNLOAD_URL_MATCHER.match(url)
assert matcher is not None, url
groupdict = matcher.groupdict()
file_id = groupdict['file_id']
bucket_name = groupdict['bucket_name']
file_name = groupdict['file_name']
if file_id is not None:
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
return bucket.download_file_by_id(file_id, range_=range_, url=url)
elif bucket_name is not None and file_name is not None:
bucket = self._get_bucket_by_name(bucket_name)
return bucket.download_file_by_name(b2_url_decode(file_name), range_=range_, url=url)
else:
assert False
[docs] def delete_key(self, api_url, account_auth_token, application_key_id):
assert api_url == self.API_URL
return dict(
accountId='accountId',
applicationKeyId=application_key_id,
keyName='keyName',
capabilities=['listBuckets', 'readBuckets', 'writeBuckets']
)
[docs] def finish_large_file(self, api_url, account_auth_token, file_id, part_sha1_array):
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
return bucket.finish_large_file(file_id, part_sha1_array)
[docs] def get_download_authorization(
self, api_url, account_auth_token, bucket_id, file_name_prefix, valid_duration_in_seconds
):
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'shareFiles')
return {
'bucketId':
bucket_id,
'fileNamePrefix':
file_name_prefix,
'authorizationToken':
'fake_download_auth_token_%s_%s_%d' % (
bucket_id,
b2_url_encode(file_name_prefix),
valid_duration_in_seconds,
)
}
[docs] def get_file_info_by_id(self, api_url, account_auth_token, file_id):
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
return bucket.get_file_info_by_id(file_id)
[docs] def get_file_info_by_name(self, api_url, account_auth_token, bucket_name, file_name):
bucket = self._get_bucket_by_name(bucket_name)
info = bucket.get_file_info_by_name(file_name)
return info
[docs] def get_upload_url(self, api_url, account_auth_token, bucket_id):
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
return self._get_bucket_by_id(bucket_id).get_upload_url()
[docs] def get_upload_part_url(self, api_url, account_auth_token, file_id):
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
return self._get_bucket_by_id(bucket_id).get_upload_part_url(file_id)
[docs] def hide_file(self, api_url, account_auth_token, bucket_id, file_name):
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
response = bucket.hide_file(file_name)
self.file_id_to_bucket_id[response['fileId']] = bucket_id
return response
[docs] def copy_file(
self,
api_url,
account_auth_token,
source_file_id,
new_file_name,
bytes_range=None,
metadata_directive=None,
content_type=None,
file_info=None,
destination_bucket_id=None,
):
bucket_id = self.file_id_to_bucket_id[source_file_id]
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
copy_file_sim = bucket.copy_file(
source_file_id,
new_file_name,
bytes_range,
metadata_directive,
content_type,
file_info,
destination_bucket_id,
)
if destination_bucket_id:
# TODO: Handle and raise proper exception after server docs get updated
dest_bucket = self.bucket_id_to_bucket[destination_bucket_id]
assert dest_bucket.account_id == bucket.account_id
else:
dest_bucket = bucket
dest_bucket.file_id_to_file[copy_file_sim.file_id] = copy_file_sim
dest_bucket.file_name_and_id_to_file[copy_file_sim.sort_key()] = copy_file_sim
return copy_file_sim.as_upload_result()
[docs] def copy_part(
self,
api_url,
account_auth_token,
source_file_id,
large_file_id,
part_number,
bytes_range=None,
):
src_bucket_id = self.file_id_to_bucket_id[source_file_id]
src_bucket = self._get_bucket_by_id(src_bucket_id)
dest_bucket_id = self.file_id_to_bucket_id[large_file_id]
dest_bucket = self._get_bucket_by_id(dest_bucket_id)
self._assert_account_auth(api_url, account_auth_token, dest_bucket.account_id, 'writeFiles')
file_sim = src_bucket.file_id_to_file[source_file_id]
data_bytes = get_bytes_range(file_sim.data_bytes, bytes_range)
data_stream = StreamWithHash(io.BytesIO(data_bytes), len(data_bytes))
content_length = len(data_stream)
sha1_sum = HEX_DIGITS_AT_END
return dest_bucket.upload_part(
large_file_id, part_number, content_length, sha1_sum, data_stream
)
[docs] def list_buckets(
self, api_url, account_auth_token, account_id, bucket_id=None, bucket_name=None
):
# First, map the bucket name to a bucket_id, so that we can check auth.
if bucket_name is None:
bucket_id_for_auth = bucket_id
else:
bucket_id_for_auth = self._get_bucket_id_or_none_for_bucket_name(bucket_name)
self._assert_account_auth(
api_url, account_auth_token, account_id, 'listBuckets', bucket_id_for_auth
)
# Do the query
sorted_buckets = [
self.bucket_name_to_bucket[name] for name in sorted(self.bucket_name_to_bucket)
]
bucket_list = [
bucket.bucket_dict()
for bucket in sorted_buckets if self._bucket_matches(bucket, bucket_id, bucket_name)
]
return dict(buckets=bucket_list)
def _get_bucket_id_or_none_for_bucket_name(self, bucket_name):
for bucket in self.bucket_name_to_bucket.values():
if bucket.bucket_name == bucket_name:
return bucket.bucket_id
def _bucket_matches(self, bucket, bucket_id, bucket_name):
return (
(bucket_id is None or bucket.bucket_id == bucket_id) and
(bucket_name is None or bucket.bucket_name == bucket_name)
)
[docs] def list_file_names(
self,
api_url,
account_auth_token,
bucket_id,
start_file_name=None,
max_file_count=None,
prefix=None,
):
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(
api_url,
account_auth_token,
bucket.account_id,
'listFiles',
bucket_id=bucket_id,
file_name=prefix,
)
return bucket.list_file_names(start_file_name, max_file_count, prefix)
[docs] def list_file_versions(
self,
api_url,
account_auth_token,
bucket_id,
start_file_name=None,
start_file_id=None,
max_file_count=None,
prefix=None,
):
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(
api_url,
account_auth_token,
bucket.account_id,
'listFiles',
bucket_id=bucket_id,
file_name=prefix,
)
return bucket.list_file_versions(start_file_name, start_file_id, max_file_count, prefix)
[docs] def list_keys(
self,
api_url,
account_auth_token,
account_id,
max_key_count=1000,
start_application_key_id=None
):
self._assert_account_auth(api_url, account_auth_token, account_id, 'listKeys')
keys = map(lambda key: key.as_key(), self.all_application_keys)
return dict(keys=keys, nextKeyId=None)
[docs] def list_parts(self, api_url, account_auth_token, file_id, start_part_number, max_part_count):
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
return bucket.list_parts(file_id, start_part_number, max_part_count)
[docs] def list_unfinished_large_files(
self,
api_url,
account_auth_token,
bucket_id,
start_file_id=None,
max_file_count=None,
prefix=None
):
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(
api_url, account_auth_token, bucket.account_id, 'listFiles', file_name=prefix
)
start_file_id = start_file_id or ''
max_file_count = max_file_count or 100
return bucket.list_unfinished_large_files(start_file_id, max_file_count, prefix)
[docs] def start_large_file(
self, api_url, account_auth_token, bucket_id, file_name, content_type, file_info
):
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeFiles')
result = bucket.start_large_file(file_name, content_type, file_info)
self.file_id_to_bucket_id[result['fileId']] = bucket_id
return result
[docs] def update_bucket(
self,
api_url,
account_auth_token,
account_id,
bucket_id,
bucket_type=None,
bucket_info=None,
cors_rules=None,
lifecycle_rules=None,
if_revision_is=None
):
assert bucket_type or bucket_info
bucket = self._get_bucket_by_id(bucket_id)
self._assert_account_auth(api_url, account_auth_token, bucket.account_id, 'writeBuckets')
return bucket.update_bucket(
bucket_type=bucket_type,
bucket_info=bucket_info,
cors_rules=cors_rules,
lifecycle_rules=lifecycle_rules,
if_revision_is=if_revision_is
)
[docs] def upload_file(
self, upload_url, upload_auth_token, file_name, content_length, content_type, content_sha1,
file_infos, data_stream
):
with ConcurrentUsedAuthTokenGuard(
self.currently_used_auth_tokens[upload_auth_token], upload_auth_token
):
assert upload_url == upload_auth_token
url_match = self.UPLOAD_URL_MATCHER.match(upload_url)
if url_match is None:
raise BadUploadUrl(upload_url)
if self.upload_errors:
raise self.upload_errors.pop(0)
bucket_id, upload_id = url_match.groups()
bucket = self._get_bucket_by_id(bucket_id)
response = bucket.upload_file(
upload_id,
upload_auth_token,
file_name,
content_length,
content_type,
content_sha1,
file_infos,
data_stream,
)
file_id = response['fileId']
self.file_id_to_bucket_id[file_id] = bucket_id
return response
[docs] def upload_part(
self, upload_url, upload_auth_token, part_number, content_length, sha1_sum, input_stream
):
with ConcurrentUsedAuthTokenGuard(
self.currently_used_auth_tokens[upload_auth_token], upload_auth_token
):
url_match = self.UPLOAD_PART_MATCHER.match(upload_url)
if url_match is None:
raise BadUploadUrl(upload_url)
file_id = url_match.group(1)
bucket_id = self.file_id_to_bucket_id[file_id]
bucket = self._get_bucket_by_id(bucket_id)
part = bucket.upload_part(file_id, part_number, content_length, sha1_sum, input_stream)
return part
def _assert_account_auth(
self, api_url, account_auth_token, account_id, capability, bucket_id=None, file_name=None
):
key_sim = self.auth_token_to_key.get(account_auth_token)
assert key_sim is not None
assert api_url == self.API_URL
assert account_id == key_sim.account_id
if account_auth_token in self.expired_auth_tokens:
raise InvalidAuthToken('auth token expired', 'auth_token_expired')
if capability not in key_sim.capabilities:
raise Unauthorized('', 'unauthorized')
if key_sim.bucket_id_or_none is not None and key_sim.bucket_id_or_none != bucket_id:
raise Unauthorized('', 'unauthorized')
if key_sim.name_prefix_or_none is not None:
if file_name is not None and not file_name.startswith(key_sim.name_prefix_or_none):
raise Unauthorized('', 'unauthorized')
def _get_bucket_by_id(self, bucket_id):
if bucket_id not in self.bucket_id_to_bucket:
raise NonExistentBucket(bucket_id)
return self.bucket_id_to_bucket[bucket_id]
def _get_bucket_by_name(self, bucket_name):
if bucket_name not in self.bucket_name_to_bucket:
raise NonExistentBucket(bucket_name)
return self.bucket_name_to_bucket[bucket_name]