~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2005-2010 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# 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 General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

# The newly committed revision is going to have a shape corresponding

# to that of the working tree.  Files that are not in the

# working tree and that were in the predecessor are reported as

# removed --- this can include files that were either removed from the

# inventory or deleted in the working tree.  If they were only

# deleted from disk, they are removed from the working inventory.

# We then consider the remaining entries, which will be in the new

# version.  Directory entries are simply copied across.  File entries

# must be checked to see if a new version of the file should be

# recorded.  For each parent revision tree, we check to see what

# version of the file was present.  If the file was present in at

# least one tree, and if it was the same version in all the trees,

# then we can just refer to that version.  Otherwise, a new version

# representing the merger of the file versions must be added.

# TODO: Update hashcache before and after - or does the WorkingTree

# look after that?

# TODO: Rather than mashing together the ancestry and storing it back,

# perhaps the weave should have single method which does it all in one

# go, avoiding a lot of redundant work.

# TODO: Perhaps give a warning if one of the revisions marked as

# merged is already in the ancestry, and then don't record it as a

# distinct parent.

# TODO: If the file is newly merged but unchanged from the version it

# merges from, then it should still be reported as newly added

# relative to the basis revision.

# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with

# the rest of the code; add a deprecation of the old name.

import os

import re

import sys

import time

from cStringIO import StringIO

from bzrlib import (

    debug,

    errors,

    revision,

    trace,

    tree,

    xml_serializer,

    )

from bzrlib.branch import Branch

from bzrlib.cleanup import OperationWithCleanups

import bzrlib.config

from bzrlib.errors import (BzrError, PointlessCommit,

                           ConflictsInTree,

                           StrictCommitFailed

                           )

from bzrlib.osutils import (get_user_encoding,

                            kind_marker, isdir,isfile, is_inside_any,

                            is_inside_or_parent_of_any,

                            minimum_path_selection,

                            quotefn, sha_file, split_lines,

                            splitpath,

                            )

from bzrlib.testament import Testament

from bzrlib.trace import mutter, note, warning, is_quiet

from bzrlib.inventory import Inventory, InventoryEntry, make_entry

from bzrlib import symbol_versioning

from bzrlib.symbol_versioning import (deprecated_passed,

        deprecated_function,

        DEPRECATED_PARAMETER)

from bzrlib.workingtree import WorkingTree

from bzrlib.urlutils import unescape_for_display

import bzrlib.ui

class NullCommitReporter(object):

    """I report on progress of a commit."""

    def started(self, revno, revid, location=None):

        if location is None:

            symbol_versioning.warn("As of bzr 1.0 you must pass a location "

                                   "to started.", DeprecationWarning,

                                   stacklevel=2)

        pass

    def snapshot_change(self, change, path):

        pass

    def completed(self, revno, rev_id):

        pass

    def deleted(self, path):

        pass

    def missing(self, path):

        pass

    def renamed(self, change, old_path, new_path):

        pass

    def is_verbose(self):

        return False

class ReportCommitToLog(NullCommitReporter):

    def _note(self, format, *args):

        """Output a message.

        Subclasses may choose to override this method.

        """

        note(format, *args)

    def snapshot_change(self, change, path):

        if path == '' and change in ('added', 'modified'):

            return

        self._note("%s %s", change, path)

    def started(self, revno, rev_id, location=None):

        if location is not None:

            location = ' to: ' + unescape_for_display(location, 'utf-8')

        else:

            # When started was added, location was only made optional by

            # accident.  Matt Nordhoff 20071129

            symbol_versioning.warn("As of bzr 1.0 you must pass a location "

                                   "to started.", DeprecationWarning,

                                   stacklevel=2)

            location = ''

        self._note('Committing%s', location)

    def completed(self, revno, rev_id):

        self._note('Committed revision %d.', revno)

        # self._note goes to the console too; so while we want to log the

        # rev_id, we can't trivially only log it. (See bug 526425). Long

        # term we should rearrange the reporting structure, but for now

        # we just mutter seperately. We mutter the revid and revno together

        # so that concurrent bzr invocations won't lead to confusion.

        mutter('Committed revid %s as revno %d.', rev_id, revno)

    def deleted(self, path):

        self._note('deleted %s', path)

    def missing(self, path):

        self._note('missing %s', path)

    def renamed(self, change, old_path, new_path):

        self._note('%s %s => %s', change, old_path, new_path)

    def is_verbose(self):

        return True

class Commit(object):

    """Task of committing a new revision.

    This is a MethodObject: it accumulates state as the commit is

    prepared, and then it is discarded.  It doesn't represent

    historical revisions, just the act of recording a new one.

            missing_ids

            Modified to hold a list of files that have been deleted from

            the working directory; these should be removed from the

            working inventory.

    """

    def __init__(self,

                 reporter=None,

                 config=None):

        """Create a Commit object.

        :param reporter: the default reporter to use or None to decide later

        """

        self.reporter = reporter

        self.config = config

    def commit(self,

               message=None,

               timestamp=None,

               timezone=None,

               committer=None,

               specific_files=None,

               rev_id=None,

               allow_pointless=True,

               strict=False,

               verbose=False,

               revprops=None,

               working_tree=None,

               local=False,

               reporter=None,

               config=None,

               message_callback=None,

               recursive='down',

               exclude=None,

               possible_master_transports=None):

        """Commit working copy as a new revision.

        :param message: the commit message (it or message_callback is required)

        :param message_callback: A callback: message = message_callback(cmt_obj)

        :param timestamp: if not None, seconds-since-epoch for a

            postdated/predated commit.

        :param specific_files: If not None, commit only those files. An empty

            list means 'commit no files'.

        :param rev_id: If set, use this as the new revision id.

            Useful for test or import commands that need to tightly

            control what revisions are assigned.  If you duplicate

            a revision id that exists elsewhere it is your own fault.

            If null (default), a time/random revision id is generated.

        :param allow_pointless: If true (default), commit even if nothing

            has changed and no merges are recorded.

        :param strict: If true, don't allow a commit if the working tree

            contains unknown files.

        :param revprops: Properties for new revision

        :param local: Perform a local only commit.

        :param reporter: the reporter to use or None for the default

        :param verbose: if True and the reporter is not None, report everything

        :param recursive: If set to 'down', commit in any subtrees that have

            pending changes of any sort during this commit.

        :param exclude: None or a list of relative paths to exclude from the

            commit. Pending changes to excluded files will be ignored by the

            commit.

        """

        operation = OperationWithCleanups(self._commit)

        self.revprops = revprops or {}

        # XXX: Can be set on __init__ or passed in - this is a bit ugly.

        self.config = config or self.config

        return operation.run(

               message=message,

               timestamp=timestamp,

               timezone=timezone,

               committer=committer,

               specific_files=specific_files,

               rev_id=rev_id,

               allow_pointless=allow_pointless,

               strict=strict,

               verbose=verbose,

               working_tree=working_tree,

               local=local,

               reporter=reporter,

               message_callback=message_callback,

               recursive=recursive,

               exclude=exclude,

               possible_master_transports=possible_master_transports)

    def _commit(self, operation, message, timestamp, timezone, committer,

            specific_files, rev_id, allow_pointless, strict, verbose,

            working_tree, local, reporter, message_callback, recursive,

            exclude, possible_master_transports):

        mutter('preparing to commit')

        if working_tree is None:

            raise BzrError("working_tree must be passed into commit().")

        else:

            self.work_tree = working_tree

            self.branch = self.work_tree.branch

            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():

                if not self.branch.repository.supports_rich_root():

                    raise errors.RootNotRich()

        if message_callback is None:

            if message is not None:

                if isinstance(message, str):

                    message = message.decode(get_user_encoding())

                message_callback = lambda x: message

            else:

                raise BzrError("The message or message_callback keyword"

                               " parameter is required for commit().")

        self.bound_branch = None

        self.any_entries_deleted = False

        if exclude is not None:

            self.exclude = sorted(

                minimum_path_selection(exclude))

        else:

            self.exclude = []

        self.local = local

        self.master_branch = None

        self.recursive = recursive

        self.rev_id = None

        # self.specific_files is None to indicate no filter, or any iterable to

        # indicate a filter - [] means no files at all, as per iter_changes.

        if specific_files is not None:

            self.specific_files = sorted(

                minimum_path_selection(specific_files))

        else:

            self.specific_files = None

        self.allow_pointless = allow_pointless

        self.message_callback = message_callback

        self.timestamp = timestamp

        self.timezone = timezone

        self.committer = committer

        self.strict = strict

        self.verbose = verbose

        self.work_tree.lock_write()

        operation.add_cleanup(self.work_tree.unlock)

        self.parents = self.work_tree.get_parent_ids()

        # We can use record_iter_changes IFF iter_changes is compatible with

        # the command line parameters, and the repository has fast delta

        # generation. See bug 347649.

        self.use_record_iter_changes = (

            not self.exclude and 

            not self.branch.repository._format.supports_tree_reference and

            (self.branch.repository._format.fast_deltas or

             len(self.parents) < 2))

        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()

        operation.add_cleanup(self.pb.finished)

        self.basis_revid = self.work_tree.last_revision()

        self.basis_tree = self.work_tree.basis_tree()

        self.basis_tree.lock_read()

        operation.add_cleanup(self.basis_tree.unlock)

        # Cannot commit with conflicts present.

        if len(self.work_tree.conflicts()) > 0:

            raise ConflictsInTree

        # Setup the bound branch variables as needed.

        self._check_bound_branch(operation, possible_master_transports)

        # Check that the working tree is up to date

        old_revno, new_revno = self._check_out_of_date_tree()

        # Complete configuration setup

        if reporter is not None:

            self.reporter = reporter

        elif self.reporter is None:

            self.reporter = self._select_reporter()

        if self.config is None:

            self.config = self.branch.get_config()

        self._set_specific_file_ids()

        # Setup the progress bar. As the number of files that need to be

        # committed in unknown, progress is reported as stages.

        # We keep track of entries separately though and include that

        # information in the progress bar during the relevant stages.

        self.pb_stage_name = ""

        self.pb_stage_count = 0

        self.pb_stage_total = 5

        if self.bound_branch:

            self.pb_stage_total += 1

        self.pb.show_pct = False

        self.pb.show_spinner = False

        self.pb.show_eta = False

        self.pb.show_count = True

        self.pb.show_bar = True

        self._gather_parents()

        # After a merge, a selected file commit is not supported.

        # See 'bzr help merge' for an explanation as to why.

        if len(self.parents) > 1 and self.specific_files is not None:

            raise errors.CannotCommitSelectedFileMerge(self.specific_files)

        # Excludes are a form of selected file commit.

        if len(self.parents) > 1 and self.exclude:

            raise errors.CannotCommitSelectedFileMerge(self.exclude)

        # Collect the changes

        self._set_progress_stage("Collecting changes", counter=True)

        self.builder = self.branch.get_commit_builder(self.parents,

            self.config, timestamp, timezone, committer, self.revprops, rev_id)

        try:

            self.builder.will_record_deletes()

            # find the location being committed to

            if self.bound_branch:

                master_location = self.master_branch.base

            else:

                master_location = self.branch.base

            # report the start of the commit

            self.reporter.started(new_revno, self.rev_id, master_location)

            self._update_builder_with_changes()

            self._check_pointless()

            # TODO: Now the new inventory is known, check for conflicts.

            # ADHB 2006-08-08: If this is done, populate_new_inv should not add

            # weave lines, because nothing should be recorded until it is known

            # that commit will succeed.

            self._set_progress_stage("Saving data locally")

            self.builder.finish_inventory()

            # Prompt the user for a commit message if none provided

            message = message_callback(self)

            self.message = message

            # Add revision data to the local branch

            self.rev_id = self.builder.commit(self.message)

        except Exception, e:

            mutter("aborting commit write group because of exception:")

            trace.log_exception_quietly()

            note("aborting commit write group: %r" % (e,))

            self.builder.abort()

            raise

        self._process_pre_hooks(old_revno, new_revno)

        # Upload revision data to the master.

        # this will propagate merged revisions too if needed.

        if self.bound_branch:

            self._set_progress_stage("Uploading data to master branch")

            # 'commit' to the master first so a timeout here causes the

            # local branch to be out of date

            self.master_branch.import_last_revision_info(

                self.branch.repository, new_revno, self.rev_id)

        # and now do the commit locally.

        self.branch.set_last_revision_info(new_revno, self.rev_id)

        # Make the working tree be up to date with the branch. This

        # includes automatic changes scheduled to be made to the tree, such

        # as updating its basis and unversioning paths that were missing.

        self.work_tree.unversion(self.deleted_ids)

        self._set_progress_stage("Updating the working tree")

        self.work_tree.update_basis_by_delta(self.rev_id,

             self.builder.get_basis_delta())

        self.reporter.completed(new_revno, self.rev_id)

        self._process_post_hooks(old_revno, new_revno)

        return self.rev_id

    def _select_reporter(self):

        """Select the CommitReporter to use."""

        if is_quiet():

            return NullCommitReporter()

        return ReportCommitToLog()

    def _check_pointless(self):

        if self.allow_pointless:

            return

        # A merge with no effect on files

        if len(self.parents) > 1:

            return

        # TODO: we could simplify this by using self.builder.basis_delta.

        # The initial commit adds a root directory, but this in itself is not

        # a worthwhile commit.

        if (self.basis_revid == revision.NULL_REVISION and

            ((self.builder.new_inventory is not None and

             len(self.builder.new_inventory) == 1) or

            len(self.builder._basis_delta) == 1)):

            raise PointlessCommit()

        if self.builder.any_changes():

            return

        raise PointlessCommit()

    def _check_bound_branch(self, operation, possible_master_transports=None):

        """Check to see if the local branch is bound.

        If it is bound, then most of the commit will actually be

        done using the remote branch as the target branch.

        Only at the end will the local branch be updated.

        """

        if self.local and not self.branch.get_bound_location():

            raise errors.LocalRequiresBoundBranch()

        if not self.local:

            self.master_branch = self.branch.get_master_branch(

                possible_master_transports)

        if not self.master_branch:

            # make this branch the reference branch for out of date checks.

            self.master_branch = self.branch

            return

        # If the master branch is bound, we must fail

        master_bound_location = self.master_branch.get_bound_location()

        if master_bound_location:

            raise errors.CommitToDoubleBoundBranch(self.branch,

                    self.master_branch, master_bound_location)

        # TODO: jam 20051230 We could automatically push local

        #       commits to the remote branch if they would fit.

        #       But for now, just require remote to be identical

        #       to local.

        # Make sure the local branch is identical to the master

        master_info = self.master_branch.last_revision_info()

        local_info = self.branch.last_revision_info()

        if local_info != master_info:

            raise errors.BoundBranchOutOfDate(self.branch,

                    self.master_branch)

        # Now things are ready to change the master branch

        # so grab the lock

        self.bound_branch = self.branch

        self.master_branch.lock_write()

        operation.add_cleanup(self.master_branch.unlock)

    def _check_out_of_date_tree(self):

        """Check that the working tree is up to date.

        :return: old_revision_number,new_revision_number tuple

        """

        try:

            first_tree_parent = self.work_tree.get_parent_ids()[0]

        except IndexError:

            # if there are no parents, treat our parent as 'None'

            # this is so that we still consider the master branch

            # - in a checkout scenario the tree may have no

            # parents but the branch may do.

            first_tree_parent = bzrlib.revision.NULL_REVISION

        old_revno, master_last = self.master_branch.last_revision_info()

        if master_last != first_tree_parent:

            if master_last != bzrlib.revision.NULL_REVISION:

                raise errors.OutOfDateTree(self.work_tree)

        if self.branch.repository.has_revision(first_tree_parent):

            new_revno = old_revno + 1

        else:

            # ghost parents never appear in revision history.

            new_revno = 1

        return old_revno,new_revno

    def _process_pre_hooks(self, old_revno, new_revno):

        """Process any registered pre commit hooks."""

        self._set_progress_stage("Running pre_commit hooks")

        self._process_hooks("pre_commit", old_revno, new_revno)

    def _process_post_hooks(self, old_revno, new_revno):

        """Process any registered post commit hooks."""

        # Process the post commit hooks, if any

        self._set_progress_stage("Running post_commit hooks")

        # old style commit hooks - should be deprecated ? (obsoleted in

        # 0.15)

        if self.config.post_commit() is not None:

            hooks = self.config.post_commit().split(' ')

            # this would be nicer with twisted.python.reflect.namedAny

            for hook in hooks:

                result = eval(hook + '(branch, rev_id)',

                              {'branch':self.branch,

                               'bzrlib':bzrlib,

                               'rev_id':self.rev_id})

        # process new style post commit hooks

        self._process_hooks("post_commit", old_revno, new_revno)

    def _process_hooks(self, hook_name, old_revno, new_revno):

        if not Branch.hooks[hook_name]:

            return

        # new style commit hooks:

        if not self.bound_branch:

            hook_master = self.branch

            hook_local = None

        else:

            hook_master = self.master_branch

            hook_local = self.branch

        # With bound branches, when the master is behind the local branch,

        # the 'old_revno' and old_revid values here are incorrect.

        # XXX: FIXME ^. RBC 20060206

        if self.parents:

            old_revid = self.parents[0]

        else:

            old_revid = bzrlib.revision.NULL_REVISION

        if hook_name == "pre_commit":

            future_tree = self.builder.revision_tree()

            tree_delta = future_tree.changes_from(self.basis_tree,

                                             include_root=True)

        for hook in Branch.hooks[hook_name]:

            # show the running hook in the progress bar. As hooks may

            # end up doing nothing (e.g. because they are not configured by

            # the user) this is still showing progress, not showing overall

            # actions - its up to each plugin to show a UI if it want's to

            # (such as 'Emailing diff to foo@example.com').

            self.pb_stage_name = "Running %s hooks [%s]" % \

                (hook_name, Branch.hooks.get_hook_name(hook))

            self._emit_progress()

            if 'hooks' in debug.debug_flags:

                mutter("Invoking commit hook: %r", hook)

            if hook_name == "post_commit":

                hook(hook_local, hook_master, old_revno, old_revid, new_revno,

                     self.rev_id)

            elif hook_name == "pre_commit":

                hook(hook_local, hook_master,

                     old_revno, old_revid, new_revno, self.rev_id,

                     tree_delta, future_tree)

    def _gather_parents(self):

        """Record the parents of a merge for merge detection."""

        # TODO: Make sure that this list doesn't contain duplicate

        # entries and the order is preserved when doing this.

        if self.use_record_iter_changes:

            return

        self.basis_inv = self.basis_tree.inventory

        self.parent_invs = [self.basis_inv]

        for revision in self.parents[1:]:

            if self.branch.repository.has_revision(revision):

                mutter('commit parent revision {%s}', revision)

                inventory = self.branch.repository.get_inventory(revision)

                self.parent_invs.append(inventory)

            else:

                mutter('commit parent ghost revision {%s}', revision)

    def _update_builder_with_changes(self):

        """Update the commit builder with the data about what has changed.

        """

        exclude = self.exclude

        specific_files = self.specific_files

        mutter("Selecting files for commit with filter %s", specific_files)

        self._check_strict()

        if self.use_record_iter_changes:

            iter_changes = self.work_tree.iter_changes(self.basis_tree,

                specific_files=specific_files)

            iter_changes = self._filter_iter_changes(iter_changes)

            for file_id, path, fs_hash in self.builder.record_iter_changes(

                self.work_tree, self.basis_revid, iter_changes):

                self.work_tree._observed_sha1(file_id, path, fs_hash)

        else:

            # Build the new inventory

            self._populate_from_inventory()

            self._record_unselected()

            self._report_and_accumulate_deletes()

    def _filter_iter_changes(self, iter_changes):

        """Process iter_changes.

        This method reports on the changes in iter_changes to the user, and 

        converts 'missing' entries in the iter_changes iterator to 'deleted'

        entries. 'missing' entries have their

        :param iter_changes: An iter_changes to process.

        :return: A generator of changes.

        """

        reporter = self.reporter

        report_changes = reporter.is_verbose()

        deleted_ids = []

        for change in iter_changes:

            if report_changes:

                old_path = change[1][0]

                new_path = change[1][1]

                versioned = change[3][1]

            kind = change[6][1]

            versioned = change[3][1]

            if kind is None and versioned:

                # 'missing' path

                if report_changes:

                    reporter.missing(new_path)

                deleted_ids.append(change[0])

                # Reset the new path (None) and new versioned flag (False)

                change = (change[0], (change[1][0], None), change[2],

                    (change[3][0], False)) + change[4:]

            elif kind == 'tree-reference':

                if self.recursive == 'down':

                    self._commit_nested_tree(change[0], change[1][1])

            if change[3][0] or change[3][1]:

                yield change

                if report_changes:

                    if new_path is None:

                        reporter.deleted(old_path)