~bzr-pqm/bzr/bzr.dev

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

__all__ = ['show_bzrdir_info']

import time

from bzrlib import (

    diff,

    osutils,

    urlutils,

    )

from bzrlib.errors import (NoWorkingTree, NotBranchError,

                           NoRepositoryPresent, NotLocalUrl)

from bzrlib.missing import find_unmerged

from bzrlib.symbol_versioning import (deprecated_function,

        zero_eight)

def plural(n, base='', pl=None):

    if n == 1:

        return base

    elif pl is not None:

        return pl

    else:

        return 's'

def _repo_rel_url(repo_url, inner_url):

    """Return path with common prefix of repository path removed.

    If path is not part of the repository, the original path is returned.

    If path is equal to the repository, the current directory marker '.' is

    returned.

    Otherwise, a relative path is returned, with trailing '/' stripped.

    """

    inner_url = urlutils.normalize_url(inner_url)

    repo_url = urlutils.normalize_url(repo_url)

    if inner_url == repo_url:

        return '.'

    result = urlutils.relative_url(repo_url, inner_url)

    if result != inner_url:

        result = result.rstrip('/')

    return result

def _show_location_info(repository, branch=None, working=None):

    """Show known locations for working, branch and repository."""

    repository_path = repository.bzrdir.root_transport.base

    print 'Location:'

    if working and branch:

        working_path = working.bzrdir.root_transport.base

        branch_path = branch.bzrdir.root_transport.base

        if working_path != branch_path:

            # lightweight checkout

            print ' light checkout root: %s' % working_path

            if repository.is_shared():

                # lightweight checkout of branch in shared repository

                print '   shared repository: %s' % repository_path

                print '   repository branch: %s' % (

                    _repo_rel_url(repository_path, branch_path))

            else:

                # lightweight checkout of standalone branch

                print '  checkout of branch: %s' % branch_path

        elif repository.is_shared():

            # branch with tree inside shared repository

            print '    shared repository: %s' % repository_path

            print '  repository checkout: %s' % (

                _repo_rel_url(repository_path, branch_path))

        elif branch.get_bound_location():

            # normal checkout

            print '       checkout root: %s' % working_path

            print '  checkout of branch: %s' % branch.get_bound_location()

        else:

            # standalone

            print '  branch root: %s' % working_path

    elif branch:

        branch_path = branch.bzrdir.root_transport.base

        if repository.is_shared():

            # branch is part of shared repository

            print '  shared repository: %s' % repository_path

            print '  repository branch: %s' % (

                _repo_rel_url(repository_path, branch_path))

        else:

            # standalone branch

            print '  branch root: %s' % branch_path

    else:

        # shared repository

        assert repository.is_shared()

        print '  shared repository: %s' % repository_path

def _show_related_info(branch):

    """Show parent and push location of branch."""

    if branch.get_parent() or branch.get_push_location():

        print

        print 'Related branches:'

        if branch.get_parent():

            if branch.get_push_location():

                print '      parent branch: %s' % branch.get_parent()

            else:

                print '  parent branch: %s' % branch.get_parent()

        if branch.get_push_location():

            print '  publish to branch: %s' % branch.get_push_location()

def _show_format_info(control=None, repository=None, branch=None, working=None):

    """Show known formats for control, working, branch and repository."""

    print

    print 'Format:'

    if control:

        print '       control: %s' % control._format.get_format_description()

    if working:

        print '  working tree: %s' % working._format.get_format_description()

    if branch:

        print '        branch: %s' % branch._format.get_format_description()

    if repository:

        print '    repository: %s' % repository._format.get_format_description()

def _show_locking_info(repository, branch=None, working=None):

    """Show locking status of working, branch and repository."""

    if (repository.get_physical_lock_status() or

        (branch and branch.get_physical_lock_status()) or

        (working and working.get_physical_lock_status())):

        print

        print 'Lock status:'

        if working:

            if working.get_physical_lock_status():

                status = 'locked'

            else:

                status = 'unlocked'

            print '  working tree: %s' % status

        if branch:

            if branch.get_physical_lock_status():

                status = 'locked'

            else:

                status = 'unlocked'

            print '        branch: %s' % status

        if repository:

            if repository.get_physical_lock_status():

                status = 'locked'

            else:

                status = 'unlocked'

            print '    repository: %s' % status

def _show_missing_revisions_branch(branch):

    """Show missing master revisions in branch."""

    # Try with inaccessible branch ?

    master = branch.get_master_branch()

    if master:

        local_extra, remote_extra = find_unmerged(branch, master)

        if remote_extra:

            print

            print 'Branch is out of date: missing %d revision%s.' % (

                len(remote_extra), plural(len(remote_extra)))

def _show_missing_revisions_working(working):

    """Show missing revisions in working tree."""

    branch = working.branch

    basis = working.basis_tree()

    work_inv = working.inventory

    branch_revno, branch_last_revision = branch.last_revision_info()

    try:

        tree_last_id = working.get_parent_ids()[0]

    except IndexError:

        tree_last_id = None

    if branch_revno and tree_last_id != branch_last_revision:

        tree_last_revno = branch.revision_id_to_revno(tree_last_id)

        missing_count = branch_revno - tree_last_revno

        print

        print 'Working tree is out of date: missing %d revision%s.' % (

            missing_count, plural(missing_count))

def _show_working_stats(working):

    """Show statistics about a working tree."""

    basis = working.basis_tree()

    work_inv = working.inventory

    delta = working.changes_from(basis, want_unchanged=True)

    print

    print 'In the working tree:'

    print '  %8s unchanged' % len(delta.unchanged)

    print '  %8d modified' % len(delta.modified)

    print '  %8d added' % len(delta.added)

    print '  %8d removed' % len(delta.removed)

    print '  %8d renamed' % len(delta.renamed)

    ignore_cnt = unknown_cnt = 0

    for path in working.extras():

        if working.is_ignored(path):

            ignore_cnt += 1

        else:

            unknown_cnt += 1

    print '  %8d unknown' % unknown_cnt

    print '  %8d ignored' % ignore_cnt

    dir_cnt = 0

    for file_id in work_inv:

        if (work_inv.get_file_kind(file_id) == 'directory' and 

            not work_inv.is_root(file_id)):

            dir_cnt += 1

    print '  %8d versioned %s' \

          % (dir_cnt,

             plural(dir_cnt, 'subdirectory', 'subdirectories'))

def _show_branch_stats(branch, verbose):

    """Show statistics about a branch."""

    revno, head = branch.last_revision_info()

    print

    print 'Branch history:'

    print '  %8d revision%s' % (revno, plural(revno))

    stats = branch.repository.gather_stats(head, committers=verbose)

    if verbose:

        committers = stats['committers']

        print '  %8d committer%s' % (committers, plural(committers))

    if revno:

        timestamp, timezone = stats['firstrev']

        age = int((time.time() - timestamp) / 3600 / 24)

        print '  %8d day%s old' % (age, plural(age))

        print '   first revision: %s' % osutils.format_date(timestamp,

            timezone)

        timestamp, timezone = stats['latestrev']

        print '  latest revision: %s' % osutils.format_date(timestamp,

            timezone)

    return stats

def _show_repository_info(repository):

    """Show settings of a repository."""

    if repository.make_working_trees():

        print

        print 'Create working tree for new branches inside the repository.'

def _show_repository_stats(stats):

    """Show statistics about a repository."""

    if 'revisions' in stats or 'size' in stats:

        print

        print 'Repository:'

    if 'revisions' in stats:

        revisions = stats['revisions']

        print '  %8d revision%s' % (revisions, plural(revisions))

    if 'size' in stats:

        print '  %8d KiB' % (stats['size']/1024)

@deprecated_function(zero_eight)

def show_info(b):

    """Please see show_bzrdir_info."""

    return show_bzrdir_info(b.bzrdir)

def show_bzrdir_info(a_bzrdir, verbose=False):

    """Output to stdout the 'info' for a_bzrdir."""

    try:

        working = a_bzrdir.open_workingtree(

            recommend_upgrade=False)

        working.lock_read()

        try:

            show_tree_info(working, verbose)

        finally:

            working.unlock()

        return

    except (NoWorkingTree, NotLocalUrl):

        pass

    try:

        branch = a_bzrdir.open_branch()

        branch.lock_read()

        try:

            show_branch_info(branch, verbose)

        finally:

            branch.unlock()

        return

    except NotBranchError:

        pass

    try:

        repository = a_bzrdir.open_repository()

        repository.lock_read()

        try:

            show_repository_info(repository, verbose)

        finally:

            repository.unlock()

        return

    except NoRepositoryPresent:

        pass

    # Return silently, cmd_info already returned NotBranchError if no bzrdir

    # could be opened.

def show_tree_info(working, verbose):

    """Output to stdout the 'info' for working."""

    branch = working.branch

    repository = branch.repository

    control = working.bzrdir

    _show_location_info(repository, branch, working)

    _show_related_info(branch)

    _show_format_info(control, repository, branch, working)

    _show_locking_info(repository, branch, working)

    _show_missing_revisions_branch(branch)

    _show_missing_revisions_working(working)

    _show_working_stats(working)

    stats = _show_branch_stats(branch, verbose)

    _show_repository_stats(stats)

def show_branch_info(branch, verbose):

    """Output to stdout the 'info' for branch."""

    repository = branch.repository

    control = branch.bzrdir

    _show_location_info(repository, branch)

    _show_related_info(branch)

    _show_format_info(control, repository, branch)

    _show_locking_info(repository, branch)

    _show_missing_revisions_branch(branch)

    stats = _show_branch_stats(branch, verbose)

    _show_repository_stats(stats)

def show_repository_info(repository, verbose):

    """Output to stdout the 'info' for repository."""

    control = repository.bzrdir

    _show_location_info(repository)

    _show_format_info(control, repository)

    _show_locking_info(repository)

    _show_repository_info(repository)

    stats = repository.gather_stats()

    _show_repository_stats(stats)