xref: /OpenGrok/tools/src/main/python/opengrok_tools/scm/repofactory.py (revision ae5b3cb81c9e71cf489cd9e38e66f063f1180c30)

#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# See LICENSE.txt included in this distribution for the specific
# language governing permissions and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at LICENSE.txt.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
#
# Portions Copyright 2020 Robert Williams

import logging

from .cvs import CVSRepository
from .git import GitRepository
from .mercurial import MercurialRepository
from .perforce import PerforceRepository
from .repo import RepoRepository
from .svn import SubversionRepository
from .teamware import TeamwareRepository


def get_repository(path, repo_type, project,
                   commands=None, env=None, hooks=None, timeout=None):
    """
    :param path: full path for the working directory
    :param repo_type: repository type name
    :param project: project name
    :param commands: commands dictionary with paths to SCM utilities
    :param env: environment variables dictionary
    :param hooks: hook dictionary
    :param timeout: timeout in seconds
    :return: a Repository derived object according to the type specified
    or None if given repository type cannot be found.
    """

    logger = logging.getLogger(__name__)

    repo_lower = repo_type.lower()

    logger.debug("Constructing repository object of type '{}' for path '{}'".
                 format(repo_type, path))

    if not commands:
        commands = {}

    if repo_lower in ["mercurial", "hg"]:
        return MercurialRepository(repo_type, logger, path, project,
                                   commands.get("hg"),
                                   env, hooks, timeout)
    elif repo_lower in ["teamware", "sccs"]:
        return TeamwareRepository(repo_type, logger, path, project,
                                  commands.get("teamware"),
                                  env, hooks, timeout)
    elif repo_lower == "cvs":
        return CVSRepository(repo_type, logger, path, project,
                             commands.get("cvs"),
                             env, hooks, timeout)
    elif repo_lower in ["svn", "subversion"]:
        return SubversionRepository(repo_type, logger, path, project,
                                    commands.get("svn"),
                                    env, hooks, timeout)
    elif repo_lower == "git":
        return GitRepository(repo_type, logger, path, project,
                             commands.get("git"),
                             env, hooks, timeout)
    elif repo_lower == "perforce":
        return PerforceRepository(repo_type, logger, path, project,
                                  commands.get("perforce"),
                                  env, hooks, timeout)
    elif repo_lower == "repo":
        return RepoRepository(repo_type, logger, path, project,
                              commands.get("repo"),
                              env, hooks, timeout)
    else:
        logger.warning("Unsupported repository type {}: {}".
                       format(repo_type, path))
        return None