← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Robert Collins
  • Date: 2007-06-28 02:43:50 UTC
  • mfrom: (2553 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2558.
  • Revision ID: robertc@robertcollins.net-20070628024350-z8bdm0y6yz2uyf4o
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/info.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
# 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
 
21
21
 
22
22
from bzrlib import (
 
23
    bzrdir,
23
24
    diff,
24
25
    osutils,
25
26
    urlutils,
28
29
                           NoRepositoryPresent, NotLocalUrl)
29
30
from bzrlib.missing import find_unmerged
30
31
from bzrlib.symbol_versioning import (deprecated_function,
31
 
        zero_eight)
 
32
        zero_eight, zero_eighteen)
32
33
 
33
34
 
34
35
def plural(n, base='', pl=None):
57
58
        result = result.rstrip('/')
58
59
    return result
59
60
 
60
 
 
61
 
def _show_location_info(repository, branch=None, working=None):
62
 
    """Show known locations for working, branch and repository."""
 
61
class _UrlList(object):
 
62
 
 
63
    def __init__(self):
 
64
        self.urls = []
 
65
 
 
66
    def add_url(self, label, url):
 
67
        self.add_path(label, urlutils.unescape_for_display(url, 'ascii'))
 
68
 
 
69
    def add_url(self, label, url):
 
70
        self.add_path(label, url)
 
71
 
 
72
    def add_path(self, label, path):
 
73
        self.urls.append((label, path))
 
74
 
 
75
    def print_lines(self):
 
76
        max_len = max(len(l) for l, u in self.urls)
 
77
        for label, url in self.urls:
 
78
            print "  %*s: %s" % (max_len, label, url)
 
79
 
 
80
 
 
81
def gather_location_info(repository, branch=None, working=None):
 
82
    locs = {}
63
83
    repository_path = repository.bzrdir.root_transport.base
64
 
    print 'Location:'
65
 
    if working and branch:
 
84
    if branch is not None:
 
85
        branch_path = branch.bzrdir.root_transport.base
 
86
        master_path = branch.get_bound_location()
 
87
        if master_path is None:
 
88
            master_path = branch_path
 
89
    else:
 
90
        branch_path = None
 
91
        master_path = None
 
92
    if working:
66
93
        working_path = working.bzrdir.root_transport.base
67
 
        branch_path = branch.bzrdir.root_transport.base
68
94
        if working_path != branch_path:
69
 
            # lightweight checkout
70
 
            print ' light checkout root: %s' % working_path
 
95
            locs['light checkout root'] = working_path
 
96
        if master_path != branch_path:
71
97
            if repository.is_shared():
72
 
                # lightweight checkout of branch in shared repository
73
 
                print '   shared repository: %s' % repository_path
74
 
                print '   repository branch: %s' % (
75
 
                    _repo_rel_url(repository_path, branch_path))
 
98
                locs['repository checkout root'] = branch_path
76
99
            else:
77
 
                # lightweight checkout of standalone branch
78
 
                print '  checkout of branch: %s' % branch_path
 
100
                locs['checkout root'] = branch_path
 
101
        if working_path != master_path:
 
102
            locs['checkout of branch'] = master_path
79
103
        elif repository.is_shared():
80
 
            # branch with tree inside shared repository
81
 
            print '    shared repository: %s' % repository_path
82
 
            print '  repository checkout: %s' % (
83
 
                _repo_rel_url(repository_path, branch_path))
84
 
        elif branch.get_bound_location():
85
 
            # normal checkout
86
 
            print '       checkout root: %s' % working_path
87
 
            print '  checkout of branch: %s' % branch.get_bound_location()
88
 
        else:
 
104
            locs['repository branch'] = _repo_rel_url(repository_path,
 
105
                branch_path)
 
106
        elif branch_path is not None:
89
107
            # standalone
90
 
            print '  branch root: %s' % working_path
91
 
    elif branch:
92
 
        branch_path = branch.bzrdir.root_transport.base
 
108
            locs['branch root'] = branch_path
 
109
    else:
 
110
        working_path = None
93
111
        if repository.is_shared():
94
 
            # branch is part of shared repository
95
 
            print '  shared repository: %s' % repository_path
96
 
            print '  repository branch: %s' % (
97
 
                _repo_rel_url(repository_path, branch_path))
 
112
            # lightweight checkout of branch in shared repository
 
113
            if branch_path is not None:
 
114
                locs['repository branch'] = _repo_rel_url(repository_path,
 
115
                                                          branch_path)
 
116
        elif branch_path is not None:
 
117
            # standalone
 
118
            locs['branch root'] = branch_path
 
119
            if master_path != branch_path:
 
120
                locs['bound to branch'] = master_path
98
121
        else:
99
 
            # standalone branch
100
 
            print '  branch root: %s' % branch_path
101
 
    else:
102
 
        # shared repository
103
 
        assert repository.is_shared()
104
 
        print '  shared repository: %s' % repository_path
 
122
            locs['repository'] = repository_path
 
123
    if repository.is_shared():
 
124
        # lightweight checkout of branch in shared repository
 
125
        locs['shared repository'] = repository_path
 
126
    order = ['light checkout root', 'repository checkout root',
 
127
             'checkout root', 'checkout of branch', 'shared repository',
 
128
             'repository', 'repository branch', 'branch root',
 
129
             'bound to branch']
 
130
    return [(n, locs[n]) for n in order if n in locs]
 
131
 
 
132
 
 
133
def _show_location_info(locs):
 
134
    """Show known locations for working, branch and repository."""
 
135
    print 'Location:'
 
136
    path_list = _UrlList()
 
137
    for name, loc in locs:
 
138
        path_list.add_url(name, loc)
 
139
    path_list.print_lines()
105
140
 
106
141
 
107
142
def _show_related_info(branch):
256
291
    """Show statistics about a repository."""
257
292
    if 'revisions' in stats or 'size' in stats:
258
293
        print
259
 
        print 'Revision store:'
 
294
        print 'Repository:'
260
295
    if 'revisions' in stats:
261
296
        revisions = stats['revisions']
262
297
        print '  %8d revision%s' % (revisions, plural(revisions))
263
298
    if 'size' in stats:
264
299
        print '  %8d KiB' % (stats['size']/1024)
265
300
 
 
301
def show_bzrdir_info(a_bzrdir, verbose=False):
 
302
    """Output to stdout the 'info' for a_bzrdir."""
 
303
    try:
 
304
        tree = a_bzrdir.open_workingtree(
 
305
            recommend_upgrade=False)
 
306
    except (NoWorkingTree, NotLocalUrl):
 
307
        tree = None
 
308
        try:
 
309
            branch = a_bzrdir.open_branch()
 
310
        except NotBranchError:
 
311
            branch = None
 
312
            try:
 
313
                repository = a_bzrdir.open_repository()
 
314
            except NoRepositoryPresent:
 
315
                # Return silently; cmd_info already returned NotBranchError
 
316
                # if no bzrdir could be opened.
 
317
                return
 
318
            else:
 
319
                lockable = repository
 
320
        else:
 
321
            repository = branch.repository
 
322
            lockable = branch
 
323
    else:
 
324
        branch = tree.branch
 
325
        repository = branch.repository
 
326
        lockable = tree
 
327
 
 
328
    lockable.lock_read()
 
329
    try:
 
330
        show_component_info(a_bzrdir, repository, branch, tree, verbose)
 
331
    finally:
 
332
        lockable.unlock()
 
333
 
 
334
 
 
335
def show_component_info(control, repository, branch=None, working=None,
 
336
    verbose=1):
 
337
    """Write info about all bzrdir components to stdout"""
 
338
    if verbose is False:
 
339
        verbose = 1
 
340
    if verbose is True:
 
341
        verbose = 2
 
342
    layout = describe_layout(repository, branch, working)
 
343
    format = describe_format(control, repository, branch, working)
 
344
    print "%s (format: %s)" % (layout, format)
 
345
    _show_location_info(gather_location_info(repository, branch, working))
 
346
    if verbose == 0:
 
347
        return
 
348
    if branch is not None:
 
349
        _show_related_info(branch)
 
350
    _show_format_info(control, repository, branch, working)
 
351
    _show_locking_info(repository, branch, working)
 
352
    if branch is not None:
 
353
        _show_missing_revisions_branch(branch)
 
354
    if working is not None:
 
355
        _show_missing_revisions_working(working)
 
356
        _show_working_stats(working)
 
357
    elif branch is not None:
 
358
        _show_missing_revisions_branch(branch)
 
359
    if branch is not None:
 
360
        stats = _show_branch_stats(branch, verbose==2)
 
361
    else:
 
362
        stats = repository.gather_stats()
 
363
    if branch is None and working is None:
 
364
        _show_repository_info(repository)
 
365
    _show_repository_stats(stats)
 
366
 
 
367
 
 
368
def describe_layout(repository=None, branch=None, tree=None):
 
369
    """Convert a control directory layout into a user-understandable term
 
370
 
 
371
    Common outputs include "Standalone tree", "Repository branch" and
 
372
    "Checkout".  Uncommon outputs include "Unshared repository with trees"
 
373
    and "Empty control directory"
 
374
    """
 
375
    if repository is None:
 
376
        return 'Empty control directory'
 
377
    if branch is None and tree is None:
 
378
        if repository.is_shared():
 
379
            phrase = 'Shared repository'
 
380
        else:
 
381
            phrase = 'Unshared repository'
 
382
        if repository.make_working_trees():
 
383
            phrase += ' with trees'
 
384
        return phrase
 
385
    else:
 
386
        if repository.is_shared():
 
387
            independence = "Repository "
 
388
        else:
 
389
            independence = "Standalone "
 
390
        if tree is not None:
 
391
            phrase = "tree"
 
392
        else:
 
393
            phrase = "branch"
 
394
        if branch is None and tree is not None:
 
395
            phrase = "branchless tree"
 
396
        else:
 
397
            if (tree is not None and tree.bzrdir.root_transport.base !=
 
398
                branch.bzrdir.root_transport.base):
 
399
                independence = ''
 
400
                phrase = "Lightweight checkout"
 
401
            elif branch.get_bound_location() is not None:
 
402
                if independence == 'Standalone ':
 
403
                    independence = ''
 
404
                if tree is None:
 
405
                    phrase = "Bound branch"
 
406
                else:
 
407
                    phrase = "Checkout"
 
408
        if independence != "":
 
409
            phrase = phrase.lower()
 
410
        return "%s%s" % (independence, phrase)
 
411
 
 
412
 
 
413
def describe_format(control, repository, branch, tree):
 
414
    """Determine the format of an existing control directory
 
415
 
 
416
    Several candidates may be found.  If so, the names are returned as a
 
417
    single string, separated by ' or '.
 
418
 
 
419
    If no matching candidate is found, "unnamed" is returned.
 
420
    """
 
421
    candidates  = []
 
422
    if (branch is not None and tree is not None and
 
423
        branch.bzrdir.root_transport.base !=
 
424
        tree.bzrdir.root_transport.base):
 
425
        branch = None
 
426
        repository = None
 
427
    for key in bzrdir.format_registry.keys():
 
428
        format = bzrdir.format_registry.make_bzrdir(key)
 
429
        if isinstance(format, bzrdir.BzrDirMetaFormat1):
 
430
            if (tree and format.workingtree_format !=
 
431
                tree._format):
 
432
                continue
 
433
            if (branch and format.get_branch_format() !=
 
434
                branch._format):
 
435
                continue
 
436
            if (repository and format.repository_format !=
 
437
                repository._format):
 
438
                continue
 
439
        if format.__class__ is not control._format.__class__:
 
440
            continue
 
441
        candidates.append(key)
 
442
    if len(candidates) == 0:
 
443
        return 'unnamed'
 
444
    new_candidates = [c for c in candidates if c != 'default']
 
445
    if len(new_candidates) > 0:
 
446
        candidates = new_candidates
 
447
    new_candidates = [c for c in candidates if not
 
448
        bzrdir.format_registry.get_info(c).hidden]
 
449
    if len(new_candidates) > 0:
 
450
        candidates = new_candidates
 
451
    return ' or '.join(candidates)
266
452
 
267
453
@deprecated_function(zero_eight)
268
454
def show_info(b):
270
456
    return show_bzrdir_info(b.bzrdir)
271
457
 
272
458
 
273
 
def show_bzrdir_info(a_bzrdir, verbose=False):
274
 
    """Output to stdout the 'info' for a_bzrdir."""
275
 
    try:
276
 
        working = a_bzrdir.open_workingtree()
277
 
        working.lock_read()
278
 
        try:
279
 
            show_tree_info(working, verbose)
280
 
        finally:
281
 
            working.unlock()
282
 
        return
283
 
    except (NoWorkingTree, NotLocalUrl):
284
 
        pass
285
 
 
286
 
    try:
287
 
        branch = a_bzrdir.open_branch()
288
 
        branch.lock_read()
289
 
        try:
290
 
            show_branch_info(branch, verbose)
291
 
        finally:
292
 
            branch.unlock()
293
 
        return
294
 
    except NotBranchError:
295
 
        pass
296
 
 
297
 
    try:
298
 
        repository = a_bzrdir.open_repository()
299
 
        repository.lock_read()
300
 
        try:
301
 
            show_repository_info(repository, verbose)
302
 
        finally:
303
 
            repository.unlock()
304
 
        return
305
 
    except NoRepositoryPresent:
306
 
        pass
307
 
 
308
 
    # Return silently, cmd_info already returned NotBranchError if no bzrdir
309
 
    # could be opened.
310
 
 
311
 
 
 
459
@deprecated_function(zero_eighteen)
312
460
def show_tree_info(working, verbose):
313
461
    """Output to stdout the 'info' for working."""
314
462
    branch = working.branch
315
463
    repository = branch.repository
316
464
    control = working.bzrdir
317
 
 
318
 
    _show_location_info(repository, branch, working)
319
 
    _show_related_info(branch)
320
 
    _show_format_info(control, repository, branch, working)
321
 
    _show_locking_info(repository, branch, working)
322
 
    _show_missing_revisions_branch(branch)
323
 
    _show_missing_revisions_working(working)
324
 
    _show_working_stats(working)
325
 
    stats = _show_branch_stats(branch, verbose)
326
 
    _show_repository_stats(stats)
327
 
 
328
 
 
 
465
    show_component_info(control, repository, branch, working, verbose)
 
466
 
 
467
 
 
468
@deprecated_function(zero_eighteen)
329
469
def show_branch_info(branch, verbose):
330
470
    """Output to stdout the 'info' for branch."""
331
471
    repository = branch.repository
332
472
    control = branch.bzrdir
333
 
 
334
 
    _show_location_info(repository, branch)
335
 
    _show_related_info(branch)
336
 
    _show_format_info(control, repository, branch)
337
 
    _show_locking_info(repository, branch)
338
 
    _show_missing_revisions_branch(branch)
339
 
    stats = _show_branch_stats(branch, verbose)
340
 
    _show_repository_stats(stats)
341
 
 
342
 
 
 
473
    show_component_info(control, repository, branch, verbose=verbose)
 
474
 
 
475
 
 
476
@deprecated_function(zero_eighteen)
343
477
def show_repository_info(repository, verbose):
344
478
    """Output to stdout the 'info' for repository."""
345
479
    control = repository.bzrdir
346
 
 
347
 
    _show_location_info(repository)
348
 
    _show_format_info(control, repository)
349
 
    _show_locking_info(repository)
350
 
    _show_repository_info(repository)
351
 
    stats = repository.gather_stats()
352
 
    _show_repository_stats(stats)
 
480
    show_component_info(control, repository, verbose=verbose)