~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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Commands for generating snapshot information about a bzr tree."""

from bzrlib.lazy_import import lazy_import

lazy_import(globals(), """

from bzrlib import (

    branch,

    errors,

    version_info_formats,

    workingtree,

    )

""")

from bzrlib.commands import Command

from bzrlib.option import Option

def _parse_version_info_format(format):

    """Convert a string passed by the user into a VersionInfoFormat.

    This looks in the version info format registry, and if the format

    cannot be found, generates a useful error exception.

    """

    try:

        return version_info_formats.get_builder(format)

    except KeyError:

        formats = version_info_formats.get_builder_formats()

        raise errors.BzrCommandError('No known version info format %s.'

                                     ' Supported types are: %s'

                                     % (format, formats))

class cmd_version_info(Command):

    """Show version information about this tree."""

    takes_options = [Option('format', type=_parse_version_info_format,

                            help='Select the output format.'),

                     Option('all', help='Include all possible information.'),

                     Option('check-clean', help='Check if tree is clean.'),

                     Option('include-history',

                            help='Include the revision-history.'),

                     Option('include-file-revisions',

                            help='Include the last revision for each file.')

                     ]

    takes_args = ['location?']

    encoding_type = 'exact'

    def run(self, location=None, format=None,

            all=False, check_clean=False, include_history=False,

            include_file_revisions=False):

        if location is None:

            location = '.'

        if format is None:

            format = version_info_formats.get_builder(None)

        wt = None

        try:

            wt = workingtree.WorkingTree.open_containing(location)[0]

        except errors.NoWorkingTree:

            b = branch.Branch.open(location)

        else:

            b = wt.branch

        if all:

            include_history = True

            check_clean = True

            include_file_revisions=True

        builder = format(b, working_tree=wt,

                check_for_clean=check_clean,

                include_revision_history=include_history,

                include_file_revisions=include_file_revisions)

        builder.generate(self.outf)