rhodecode/lib/vcs/backends/git/inmemory.py

# Copyright (C) 2014-2024 RhodeCode GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/

"""
GIT inmemory module
"""

from rhodecode.lib.datelib import date_to_timestamp_plus_offset
from rhodecode.lib.str_utils import safe_str, get_default_encodings
from rhodecode.lib.vcs.backends import base


class GitInMemoryCommit(base.BaseInMemoryCommit):

    def commit(self, message, author, parents=None, branch=None, date=None, **kwargs):
        """
        Performs in-memory commit (doesn't check workdir in any way) and
        returns newly created `GitCommit`. Updates repository's
        `commit_ids`.

        :param message: message of the commit
        :param author: full username, i.e. "Joe Doe <[e-mail]>"
        :param parents: single parent or sequence of parents from which commit
          would be derived
        :param date: `datetime.datetime` instance. Defaults to
          ``datetime.datetime.now()``.
        :param branch: branch name, as string. If none given, default backend's
          branch would be used.

        :raises `CommitError`: if any error occurs while committing
        """
        self.check_integrity(parents)
        if branch is None:
            branch = self.repository.DEFAULT_BRANCH_NAME

        commit_tree = None
        if self.parents[0]:
            commit_tree = self.parents[0]._commit['tree']

        encoding = get_default_encodings()[0]
        updated = []
        for node in self.added + self.changed:
            content = node.content
            # TODO: left for reference pre py3 migration, probably need to be removed
            # if node.is_binary:
            #     content = node.content
            # else:
            #     content = node.content.encode(ENCODING)

            updated.append({
                'path': node.path,
                'node_path': node.name,
                'content': content,
                'mode': node.mode,
            })

        removed = [node.path for node in self.removed]

        date, tz = date_to_timestamp_plus_offset(date)

        author_time = kwargs.pop('author_time', date)
        author_tz = kwargs.pop('author_timezone', tz)

        commit_data = {
            'parents': [p._commit['id'] for p in self.parents if p],
            'author': safe_str(author),
            'committer': safe_str(author),
            'encoding': encoding,
            'message': safe_str(message),

            'commit_time': int(date),
            'commit_timezone': tz,

            'author_time': int(author_time),
            'author_timezone': author_tz,
        }

        commit_id = self.repository._remote.commit(
            commit_data, branch, commit_tree, updated, removed)

        # Update vcs repository object
        self.repository.append_commit_id(commit_id)

        # invalidate parsed refs after commit
        self.repository._refs = self.repository._get_refs()
        self.repository.branches = self.repository._get_branches()
        tip = self.repository.get_commit(commit_id)

        self.reset()
        return tip