diff --git a/swh/loader/dir/converters.py b/swh/loader/dir/converters.py index 3027065..dd6107a 100644 --- a/swh/loader/dir/converters.py +++ b/swh/loader/dir/converters.py @@ -1,106 +1,115 @@ # Copyright (C) 2015 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 """Convert dir objects to dictionaries suitable for swh.storage""" from datetime import datetime from swh.loader.dir.git.git import GitType def format_date(signature): """Convert the date from a signature to a datetime""" return datetime.datetime.fromtimestamp(signature.time, datetime.timezone.utc) -def blob_to_content(obj, log=None, max_content_size=None, origin_id=None): +def blob_to_content(obj, objects, log=None, max_content_size=None, origin_id=None): """Convert to a compliant swh content. """ size = obj['length'] - obj.update({ + ret = { + 'sha1': obj['sha1'], + 'sha256': obj['sha256'], + 'sha1_git': obj['sha1_git'], + 'data': obj['data'], + 'length': size, 'perms': obj['perms'].value, 'type': obj['type'].value - }) + } if max_content_size and size > max_content_size: if log: log.info('Skipping content %s, too large (%s > %s)' % (obj['sha1_git'], size, max_content_size)) - obj.update({'status': 'absent', + ret.update({'status': 'absent', 'reason': 'Content too large', 'origin': origin_id}) - return obj + return ret - obj.update({ + ret.update({ 'status': 'visible' }) - return obj + return ret -def tree_to_directory(id, repo, log=None): - """Format a tree as a directory""" - ret = { - 'id': id.raw, - } - entries = [] - ret['entries'] = entries +# Map of type to swh types +_entry_type_map = { + GitType.TREE: 'dir', + GitType.BLOB: 'file', + GitType.COMM: 'rev', +} - entry_type_map = { - GitType.TREE: 'dir', - GitType.BLOB: 'file', - GitType.COMM: 'rev', - } - for entry in repo[id]: +def tree_to_directory(tree, objects, log=None): + """Format a tree as a directory + + """ + entries = [] + for entry in objects[tree['path']]: entries.append({ - 'type': entry_type_map[entry.type], - 'perms': entry.filemode, - 'name': entry.name, - 'target': entry.id.raw, + 'type': _entry_type_map[entry['type']], + 'perms': entry['perms'].value, + 'name': entry['name'], + 'target': entry['sha1_git'], 'atime': None, 'mtime': None, 'ctime': None, }) - return ret + return { + 'id': tree['sha1_git'], + 'perms': tree['perms'].value, + 'type': tree['type'].value, + 'entries': entries + } def commit_to_revision(id, repo, log=None): """Format a commit as a revision""" commit = repo[id] author = commit.author committer = commit.committer return { 'id': id.raw, 'date': format_date(author), 'date_offset': author.offset, 'committer_date': format_date(committer), 'committer_date_offset': committer.offset, 'type': 'git', 'directory': commit.tree_id.raw, 'message': commit.raw_message, 'author_name': author.name, 'author_email': author.email, 'committer_name': committer.name, 'committer_email': committer.email, 'parents': [p.raw for p in commit.parent_ids], } def ref_to_occurrence(ref): """Format a reference as an occurrence""" return ref def origin_url_to_origin(origin_url): """Format a pygit2.Repository as an origin suitable for swh.storage""" return { 'type': 'dir', 'url': origin_url, } diff --git a/swh/loader/dir/git/git.py b/swh/loader/dir/git/git.py index 440d825..a040dfc 100644 --- a/swh/loader/dir/git/git.py +++ b/swh/loader/dir/git/git.py @@ -1,252 +1,253 @@ # Copyright (C) 2015 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 os from enum import Enum from swh.loader.dir.git import utils class GitType(Enum): BLOB = b'blob' TREE = b'tree' EXEC = b'exec' LINK = b'link' COMM = b'commit' RELE = b'release' class GitPerm(Enum): BLOB = b'100644' TREE = b'40000' EXEC = b'100755' LINK = b'120000' def compute_directory_git_sha1(dirpath, hashes): """Compute a directory git sha1 for a dirpath. Args: dirpath: the directory's absolute path hashes: list of tree entries with keys: - sha1_git: the tree entry's sha1 - name: file or subdir's name - perms: the tree entry's sha1 permissions Returns: dictionary with sha1_git as key and the actual binary sha1 as value. Assumes: Every path exists in hashes. """ def sort_by_entry_name(hashes): return sorted(hashes, key=lambda entry: entry['name']) def row_entry_tree_format(hashes): return map(lambda entry: b''.join([entry['perms'].value, b' ', entry['name'], b'\0', entry['sha1_git']]), hashes) rows = row_entry_tree_format(sort_by_entry_name(hashes[dirpath])) return utils.hashdata(b''.join(rows), 'tree') def compute_revision_git_sha1(hashes, info): """Compute a revision's hash. Use the entry's sha1_git as tree representation. Args: hashes: info: Additional dictionary information needed to compute a synthetic revision. Following keys are expected: - revision_author_name - revision_author_email - revision_author_date - revision_author_offset - revision_committer_name - revision_committer_email - revision_committer_date - revision_committer_offset - revision_message """ tree_hash = utils.hash_to_hex(hashes[''][0]['sha1_git']) revision_content = ("""tree %s author %s <%s> %s %s committer %s <%s> %s %s %s """ % (tree_hash, info['revision_author_name'], info['revision_author_email'], info['revision_author_date'], info['revision_author_offset'], info['revision_committer_name'], info['revision_committer_email'], info['revision_committer_date'], info['revision_committer_offset'], info['revision_message'])).encode('utf-8') return utils.hashdata(revision_content, 'commit') def compute_link_metadata(linkpath): """Given a linkpath, compute the git metadata. Args: linkpath: absolute pathname of the link Returns: Dictionary of values: - name: basename of the link - perms: git permission for link - type: git type for link """ m_hashes = utils.hashlink(linkpath) m_hashes.update({ 'name': bytes(os.path.basename(linkpath), 'utf-8'), 'perms': GitPerm.LINK, 'type': GitType.BLOB, 'path': linkpath }) return m_hashes def compute_blob_metadata(filepath): """Given a filepath, compute the git metadata. Args: filepath: absolute pathname of the file. Returns: Dictionary of values: - name: basename of the file - perms: git permission for file - type: git type for file """ m_hashes = utils.hashfile(filepath) m_hashes.update({ 'name': bytes(os.path.basename(filepath), 'utf-8'), 'perms': GitPerm.EXEC if os.access(filepath, os.X_OK) else GitPerm.BLOB, 'type': GitType.BLOB, 'path': filepath }) return m_hashes def compute_tree_metadata(dirname, ls_hashes): """Given a dirname, compute the git metadata. Args: dirname: absolute pathname of the directory. Returns: Dictionary of values: - name: basename of the directory - perms: git permission for directory - type: git type for directory """ tree_hash = compute_directory_git_sha1(dirname, ls_hashes) tree_hash.update({ 'name': bytes(os.path.basename(dirname), 'utf-8'), 'perms': GitPerm.TREE, 'type': GitType.TREE, 'path': dirname }) return tree_hash def walk_and_compute_sha1_from_directory(rootdir): """Compute git sha1 from directory rootdir. Empty directories are skipped. Returns: Dictionary of entries with keys and as values a list of directory entries. Those are list of dictionary with keys: - 'perms' - 'type' - 'name' - 'sha1_git' - and specifically content: 'sha1', 'sha256', ... (may be extended...) Note: One special key is '' to indicate the upper root of the directory. (This is typically the entry point of the revision). Raises: Nothing If something is raised, this is a programmatic error. """ ls_hashes = {} empty_dirs = set() link_dirs = set() for dirpath, dirnames, filenames in os.walk(rootdir, topdown=False): hashes = [] if not(dirnames) and not(filenames): empty_dirs.add(dirpath) continue links = [ file for file in filenames if os.path.islink(os.path.join(dirpath, file)) ] + \ [ dir for dir in dirnames if os.path.islink(os.path.join(dirpath, dir))] for link in links: linkpath = os.path.join(dirpath, link) link_dirs.add(linkpath) m_hashes = compute_link_metadata(linkpath) hashes.append(m_hashes) for filename in [ file for file in filenames if os.path.join(dirpath, file) not in link_dirs ]: filepath = os.path.join(dirpath, filename) m_hashes = compute_blob_metadata(filepath) hashes.append(m_hashes) ls_hashes.update({ dirpath: hashes }) dir_hashes = [] subdirs = [ dir for dir in dirnames if os.path.join(dirpath, dir) not in (empty_dirs | link_dirs) ] for dirname in subdirs: fulldirname = os.path.join(dirpath, dirname) tree_hash = compute_tree_metadata(fulldirname, ls_hashes) dir_hashes.append(tree_hash) ls_hashes.update({ dirpath: ls_hashes.get(dirpath, []) + dir_hashes }) # compute the current directory hashes root_hash = compute_directory_git_sha1(rootdir, ls_hashes) root_hash.update({ - 'name': bytes(rootdir, 'utf-8'), + 'path': rootdir, + 'name': bytes(os.path.basename(rootdir), 'utf-8'), 'perms': GitPerm.TREE, 'type': GitType.TREE }) ls_hashes.update({ '': [root_hash] }) return ls_hashes diff --git a/swh/loader/dir/loader.py b/swh/loader/dir/loader.py index d48b88e..aa2f8df 100644 --- a/swh/loader/dir/loader.py +++ b/swh/loader/dir/loader.py @@ -1,490 +1,495 @@ # Copyright (C) 2015 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 import uuid import traceback import os import psycopg2 from retrying import retry from swh.core import config from swh.loader.dir import converters from swh.loader.dir.git import git from swh.loader.dir.git.git import GitType def send_in_packets(source_list, formatter, sender, packet_size, packet_size_bytes=None, *args, **kwargs): """Send objects from `source_list`, passed through `formatter` (with extra args *args, **kwargs), using the `sender`, in packets of `packet_size` objects (and of max `packet_size_bytes`). """ formatted_objects = [] count = 0 if not packet_size_bytes: packet_size_bytes = 0 for obj in source_list: formatted_object = formatter(obj, *args, **kwargs) if formatted_object: formatted_objects.append(formatted_object) else: continue if packet_size_bytes: count += formatted_object['length'] if len(formatted_objects) >= packet_size or count > packet_size_bytes: sender(formatted_objects) formatted_objects = [] count = 0 if formatted_objects: sender(formatted_objects) def retry_loading(error): """Retry policy when the database raises an integrity error""" if not isinstance(error, psycopg2.IntegrityError): return False logger = logging.getLogger('swh.loader.git.DirLoader') error_name = error.__module__ + '.' + error.__class__.__name__ logger.warning('Retry loading a batch', exc_info=False, extra={ 'swh_type': 'storage_retry', 'swh_exception_type': error_name, 'swh_exception': traceback.format_exception( error.__class__, error, error.__traceback__, ), }) return True class DirLoader(config.SWHConfig): """A bulk loader for a directory""" DEFAULT_CONFIG = { 'storage_class': ('str', 'remote_storage'), 'storage_args': ('list[str]', ['http://localhost:5000/']), 'send_contents': ('bool', True), 'send_directories': ('bool', True), 'send_revisions': ('bool', True), 'send_releases': ('bool', True), 'send_occurrences': ('bool', True), 'content_packet_size': ('int', 10000), 'content_packet_size_bytes': ('int', 1024 * 1024 * 1024), 'directory_packet_size': ('int', 25000), 'revision_packet_size': ('int', 100000), 'release_packet_size': ('int', 100000), 'occurrence_packet_size': ('int', 100000), } def __init__(self, config): self.config = config if self.config['storage_class'] == 'remote_storage': from swh.storage.api.client import RemoteStorage as Storage else: from swh.storage import Storage self.storage = Storage(*self.config['storage_args']) self.log = logging.getLogger('swh.loader.dir.DirLoader') @retry(retry_on_exception=retry_loading, stop_max_attempt_number=3) def send_contents(self, content_list): """Actually send properly formatted contents to the database""" num_contents = len(content_list) log_id = str(uuid.uuid4()) self.log.debug("Sending %d contents" % num_contents, extra={ 'swh_type': 'storage_send_start', 'swh_content_type': 'content', 'swh_num': num_contents, 'swh_id': log_id, }) self.storage.content_add(content_list) self.log.debug("Done sending %d contents" % num_contents, extra={ 'swh_type': 'storage_send_end', 'swh_content_type': 'content', 'swh_num': num_contents, 'swh_id': log_id, }) @retry(retry_on_exception=retry_loading, stop_max_attempt_number=3) def send_directories(self, directory_list): """Actually send properly formatted directories to the database""" num_directories = len(directory_list) log_id = str(uuid.uuid4()) self.log.debug("Sending %d directories" % num_directories, extra={ 'swh_type': 'storage_send_start', 'swh_content_type': 'directory', 'swh_num': num_directories, 'swh_id': log_id, }) self.storage.directory_add(directory_list) self.log.debug("Done sending %d directories" % num_directories, extra={ 'swh_type': 'storage_send_end', 'swh_content_type': 'directory', 'swh_num': num_directories, 'swh_id': log_id, }) @retry(retry_on_exception=retry_loading, stop_max_attempt_number=3) def send_revisions(self, revision_list): """Actually send properly formatted revisions to the database""" num_revisions = len(revision_list) log_id = str(uuid.uuid4()) self.log.debug("Sending %d revisions" % num_revisions, extra={ 'swh_type': 'storage_send_start', 'swh_content_type': 'revision', 'swh_num': num_revisions, 'swh_id': log_id, }) self.storage.revision_add(revision_list) self.log.debug("Done sending %d revisions" % num_revisions, extra={ 'swh_type': 'storage_send_end', 'swh_content_type': 'revision', 'swh_num': num_revisions, 'swh_id': log_id, }) @retry(retry_on_exception=retry_loading, stop_max_attempt_number=3) def send_releases(self, release_list): """Actually send properly formatted releases to the database""" num_releases = len(release_list) log_id = str(uuid.uuid4()) self.log.debug("Sending %d releases" % num_releases, extra={ 'swh_type': 'storage_send_start', 'swh_content_type': 'release', 'swh_num': num_releases, 'swh_id': log_id, }) self.storage.release_add(release_list) self.log.debug("Done sending %d releases" % num_releases, extra={ 'swh_type': 'storage_send_end', 'swh_content_type': 'release', 'swh_num': num_releases, 'swh_id': log_id, }) @retry(retry_on_exception=retry_loading, stop_max_attempt_number=3) def send_occurrences(self, occurrence_list): """Actually send properly formatted occurrences to the database""" num_occurrences = len(occurrence_list) log_id = str(uuid.uuid4()) self.log.debug("Sending %d occurrences" % num_occurrences, extra={ 'swh_type': 'storage_send_start', 'swh_content_type': 'occurrence', 'swh_num': num_occurrences, 'swh_id': log_id, }) self.storage.occurrence_add(occurrence_list) self.log.debug("Done sending %d occurrences" % num_occurrences, extra={ 'swh_type': 'storage_send_end', 'swh_content_type': 'occurrence', 'swh_num': num_occurrences, 'swh_id': log_id, }) def get_or_create_origin(self, origin_url): origin = converters.origin_url_to_origin(origin_url) origin['id'] = self.storage.origin_add_one(origin) return origin def dir_origin(self, root_dir, origin_url): log_id = str(uuid.uuid4()) self.log.debug('Creating origin for %s' % origin_url, extra={ 'swh_type': 'storage_send_start', 'swh_content_type': 'origin', 'swh_num': 1, 'swh_id': log_id }) origin = self.get_or_create_origin(origin_url) self.log.debug('Done creating origin for %s' % origin_url, extra={ 'swh_type': 'storage_send_end', 'swh_content_type': 'origin', 'swh_num': 1, 'swh_id': log_id }) return origin def dir_revision(self, root_dir, origin_url, revision_date, revision_offset, revision_committer_date, revision_committer_offset, revision_type, revision_message, revision_author, revision_committer): """Create a revision. """ log_id = str(uuid.uuid4()) self.log.debug('Creating origin for %s' % origin_url, extra={ 'swh_type': 'storage_send_start', 'swh_content_type': 'origin', 'swh_num': 1, 'swh_id': log_id }) self.get_or_create_origin(origin_url) self.log.debug('Done creating origin for %s' % origin_url, extra={ 'swh_type': 'storage_send_end', 'swh_content_type': 'origin', 'swh_num': 1, 'swh_id': log_id }) - def bulk_send_blobs(self, root_dir, blobs, origin_id): + def bulk_send_blobs(self, objects, blobs, origin_id): """Format blobs as swh contents and send them to the database""" packet_size = self.config['content_packet_size'] packet_size_bytes = self.config['content_packet_size_bytes'] max_content_size = self.config['content_size_limit'] send_in_packets(blobs, converters.blob_to_content, self.send_contents, packet_size, packet_size_bytes=packet_size_bytes, - log=self.log, max_content_size=max_content_size, + objects=objects, + log=self.log, + max_content_size=max_content_size, origin_id=origin_id) - def bulk_send_trees(self, root_dir, trees): + def bulk_send_trees(self, objects, trees): """Format trees as swh directories and send them to the database""" packet_size = self.config['directory_packet_size'] send_in_packets(trees, converters.tree_to_directory, self.send_directories, packet_size, + objects=objects, log=self.log) - def bulk_send_commits(self, root_dir, commits): + def bulk_send_commits(self, objects, commits): """Format commits as swh revisions and send them to the database""" packet_size = self.config['revision_packet_size'] send_in_packets(commits, converters.commit_to_revision, self.send_revisions, packet_size, log=self.log) - def bulk_send_annotated_tags(self, root_dir, tags): + def bulk_send_annotated_tags(self, objects, tags): """Format annotated tags (pygit2.Tag objects) as swh releases and send them to the database """ packet_size = self.config['release_packet_size'] send_in_packets(tags, converters.annotated_tag_to_release, - self.send_releases, packet_size, root_dir=root_dir, + self.send_releases, packet_size, log=self.log) - def bulk_send_refs(self, root_dir, refs): + def bulk_send_refs(self, objects, refs): """Format git references as swh occurrences and send them to the database """ packet_size = self.config['occurrence_packet_size'] send_in_packets(refs, converters.ref_to_occurrence, self.send_occurrences, packet_size) def compute_dir_ref(self, root_dir, branch, revision_hash, origin_id, authority_id, validity): """List all the refs from the given root directory root_dir. Args: - root_dir: the root directory - branch: occurrence's branch name - revision_hash: the revision hash - origin_id (int): the id of the origin from which the root_dir is taken - validity (datetime.datetime): the validity date for the repository's refs - authority_id (int): the id of the authority on `validity`. Returns: One dictionary with keys: - branch (str): name of the ref - revision (sha1_git): revision pointed at by the ref - origin (int) - validity (datetime.DateTime) - authority (int) Compatible with occurrence_add. """ log_id = str(uuid.uuid4()) self.log.debug("Computing occurrence %s representation at %s" % ( branch, revision_hash), extra={ 'swh_type': 'computing_occurrence_dir', 'swh_name': branch, 'swh_target': str(revision_hash), 'swh_id': log_id, }) return { 'branch': branch, 'revision': revision_hash, 'origin': origin_id, 'validity': validity, 'authority': authority_id, } def list_repo_objs(self, root_dir, info): """List all objects from root_dir. Args: - root_dir (path): the directory to list Returns: a dict containing lists of `Oid`s with keys for each object type: - CONTENT - DIRECTORY """ def get_objects_per_object_type(objects_per_path): m = { GitType.BLOB: [], GitType.TREE: [], GitType.COMM: [], GitType.RELE: [] } - for path in objects_per_path: - for obj in objects_per_path[path]: + for tree_path in objects_per_path: + objs = objects_per_path[tree_path] + # print('tree_path: %s, objs: %s' % (tree_path, objs)) + for obj in objs: m[obj['type']].append(obj) return m log_id = str(uuid.uuid4()) self.log.info("Started listing %s" % root_dir, extra={ 'swh_type': 'git_list_objs_start', 'swh_repo': root_dir, 'swh_id': log_id, }) objects_per_path = git.walk_and_compute_sha1_from_directory(root_dir) objects = get_objects_per_object_type(objects_per_path) revision = git.compute_revision_git_sha1(objects_per_path, info) objects.update({ GitType.COMM: [revision] }) self.log.info("Done listing the objects in %s: %d contents, " "%d directories, %d revisions, %d releases" % ( root_dir, len(objects[GitType.BLOB]), len(objects[GitType.TREE]), len(objects[GitType.COMM]), len(objects[GitType.RELE]) ), extra={ 'swh_type': 'git_list_objs_end', 'swh_repo': root_dir, 'swh_num_blobs': len(objects[GitType.BLOB]), 'swh_num_trees': len(objects[GitType.TREE]), 'swh_num_commits': len(objects[GitType.COMM]), 'swh_num_releases': len(objects[GitType.RELE]), 'swh_id': log_id, }) - return objects + return objects, objects_per_path def open_dir(self, root_dir): return root_dir - def load_dir(self, root_dir, objects, refs, origin_id): + def load_dir(self, root_dir, objects, objects_per_path, refs, origin_id): if self.config['send_contents']: - self.bulk_send_blobs(root_dir, objects[GitType.BLOB], origin_id) + self.bulk_send_blobs(objects_per_path, objects[GitType.BLOB], origin_id) else: self.log.info('Not sending contents') - # if self.config['send_directories']: - # self.bulk_send_trees(root_dir, objects[GitType.TREE]) - # else: - # self.log.info('Not sending directories') + if self.config['send_directories']: + self.bulk_send_trees(objects_per_path, objects[GitType.TREE]) + else: + self.log.info('Not sending directories') # if self.config['send_revisions']: - # self.bulk_send_commits(root_dir, objects[GitType.COMM]) + # self.bulk_send_commits(objects_per_path, objects[GitType.COMM]) # else: # self.log.info('Not sending revisions') # if self.config['send_releases']: - # self.bulk_send_annotated_tags(root_dir, objects[GitType.RELE]) + # self.bulk_send_annotated_tags(objects_per_path, objects[GitType.RELE]) # else: # self.log.info('Not sending releases') # if self.config['send_occurrences']: - # self.bulk_send_refs(root_dir, refs) + # self.bulk_send_refs(objects_per_path, refs) # else: # self.log.info('Not sending occurrences') def process(self, root_dir): # Checks the input try: files = os.listdir(root_dir) if files == []: self.log.info('Skipping empty directory %s' % root_dir, extra={ 'swh_type': 'dir_repo_list_refs', 'swh_repo': root_dir, 'swh_num_refs': 0, }) return except FileNotFoundError: self.log.info('Skipping inexistant directory %s' % root_dir, extra={ 'swh_type': 'dir_repo_list_refs', 'swh_repo': root_dir, 'swh_num_refs': 0, }) return # Open repository root_dir = self.open_dir(root_dir) # Add origin to storage if needed, use the one from config if not origin = self.dir_origin(root_dir, self.config['origin_url']) # We want to load the repository, walk all the objects - objects = self.list_repo_objs(root_dir, self.config) + objects, objects_per_path = self.list_repo_objs(root_dir, self.config) # Compute revision information (mixed from outside input + dir content) revision = objects[GitType.COMM][0] # Parse all the refs from our root_dir ref = self.compute_dir_ref(root_dir, origin['id'], self.config['branch'], revision['sha1_git'], self.config['authority_id'], self.config['validity']) # Finally, load the repository - self.load_dir(root_dir, objects, [ref], origin['id']) + self.load_dir(root_dir, objects, objects_per_path, [ref], origin['id'])