~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2005, 2006 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

"""Routines for extracting all version information from a bzr branch."""

import time

from bzrlib.osutils import local_time_offset, format_date

from bzrlib import registry

def create_date_str(timestamp=None, offset=None):

    """Just a wrapper around format_date to provide the right format.

    We don't want to use '%a' in the time string, because it is locale

    dependant. We also want to force timezone original, and show_offset

    Without parameters this function yields the current date in the local

    time zone.

    """

    if timestamp is None and offset is None:

        timestamp = time.time()

        offset = local_time_offset()

    return format_date(timestamp, offset, date_fmt='%Y-%m-%d %H:%M:%S',

                       timezone='original', show_offset=True)

class VersionInfoBuilder(object):

    """A class which lets you build up information about a revision."""

    def __init__(self, branch, working_tree=None,

                check_for_clean=False,

                include_revision_history=False,

                include_file_revisions=False,

                template=None):

        """Build up information about the given branch.

        If working_tree is given, it can be checked for changes.

        :param branch: The branch to work on

        :param working_tree: If supplied, preferentially check

            the working tree for changes.

        :param check_for_clean: If False, we will skip the expense

            of looking for changes.

        :param include_revision_history: If True, the output

            will include the full mainline revision history, including

            date and message

        :param include_file_revisions: The output should

            include the explicit last-changed revision for each file.

        :param template: Template for the output formatting, not used by

            all builders.

        """

        self._branch = branch

        self._working_tree = working_tree

        self._check = check_for_clean

        self._include_history = include_revision_history

        self._include_file_revs = include_file_revisions

        self._template = template

        self._clean = None

        self._file_revisions = {}

        self._revision_history_info= []

    def _extract_file_revisions(self):

        """Extract the working revisions for all files"""

        # Things seem clean if we never look :)

        self._clean = True

        if self._working_tree is not None:

            basis_tree = self._working_tree.basis_tree()

            # TODO: jam 20070215 The working tree should actually be locked at

            #       a higher level, but this will do for now.

            self._working_tree.lock_read()

        else:

            basis_tree = self._branch.basis_tree()

        basis_tree.lock_read()

        try:

            # Build up the list from the basis inventory

            for info in basis_tree.list_files(include_root=True):

                self._file_revisions[info[0]] = info[-1].revision

            if not self._check or self._working_tree is None:

                return

            delta = self._working_tree.changes_from(basis_tree,

                                                    include_root=True)

            # Using a 2-pass algorithm for renames. This is because you might have

            # renamed something out of the way, and then created a new file

            # in which case we would rather see the new marker

            # Or you might have removed the target, and then renamed

            # in which case we would rather see the renamed marker

            for (old_path, new_path, file_id,

                 kind, text_mod, meta_mod) in delta.renamed:

                self._clean = False

                self._file_revisions[old_path] = u'renamed to %s' % (new_path,)

            for path, file_id, kind in delta.removed:

                self._clean = False

                self._file_revisions[path] = 'removed'

            for path, file_id, kind in delta.added:

                self._clean = False

                self._file_revisions[path] = 'new'

            for (old_path, new_path, file_id,

                 kind, text_mod, meta_mod) in delta.renamed:

                self._clean = False

                self._file_revisions[new_path] = u'renamed from %s' % (old_path,)

            for path, file_id, kind, text_mod, meta_mod in delta.modified:

                self._clean = False

                self._file_revisions[path] = 'modified'

            for path in self._working_tree.unknowns():

                self._clean = False

                self._file_revisions[path] = 'unversioned'

        finally:

            basis_tree.unlock()

            if self._working_tree is not None:

                self._working_tree.unlock()

    def _extract_revision_history(self):

        """Find the messages for all revisions in history."""

        # Unfortunately, there is no WorkingTree.revision_history

        rev_hist = self._branch.revision_history()

        if self._working_tree is not None:

            last_rev = self._working_tree.last_revision()

            if last_rev not in rev_hist:

                raise AssertionError(

                    "Working Tree's last revision not in branch.revision_history")

            rev_hist = rev_hist[:rev_hist.index(last_rev)+1]

        repository =  self._branch.repository

        repository.lock_read()

        try:

            for revision_id in rev_hist:

                rev = repository.get_revision(revision_id)

                self._revision_history_info.append(

                    (rev.revision_id, rev.message,

                     rev.timestamp, rev.timezone))

        finally:

            repository.unlock()

    def _get_revision_id(self):

        """Get the revision id we are working on."""

        if self._working_tree is not None:

            return self._working_tree.last_revision()

        return self._branch.last_revision()

    def _get_revno_str(self, revision_id):

        numbers = self._branch.revision_id_to_dotted_revno(revision_id)

        revno_str = '.'.join([str(num) for num in numbers])

        return revno_str

    def generate(self, to_file):

        """Output the version information to the supplied file.

        :param to_file: The file to write the stream to. The output

                will already be encoded, so to_file should not try

                to change encodings.

        :return: None

        """

        raise NotImplementedError(VersionInfoBuilder.generate)

format_registry = registry.Registry()

format_registry.register_lazy(

    'rio',

    'bzrlib.version_info_formats.format_rio',

    'RioVersionInfoBuilder',

    'Version info in RIO (simple text) format (default).')

format_registry.default_key = 'rio'

format_registry.register_lazy(

    'python',

    'bzrlib.version_info_formats.format_python',

    'PythonVersionInfoBuilder',

    'Version info in Python format.')

format_registry.register_lazy(

    'custom',

    'bzrlib.version_info_formats.format_custom',

    'CustomVersionInfoBuilder',

    'Version info in Custom template-based format.')