← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-09-20 02:40:52 UTC
  • mfrom: (2835.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070920024052-y2l7r5o00zrpnr73
No longer propagate index differences automatically (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/info.py
1
 
# Copyright (C) 2004, 2005 by Martin Pool
2
 
# Copyright (C) 2005 by Canonical Ltd
3
 
 
4
 
 
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
# 
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
__all__ = ['show_bzrdir_info']
20
18
 
 
19
import os
21
20
import time
22
 
 
23
 
 
24
 
import bzrlib.diff as diff
 
21
import sys
 
22
 
 
23
from bzrlib import (
 
24
    bzrdir,
 
25
    diff,
 
26
    errors,
 
27
    osutils,
 
28
    urlutils,
 
29
    )
25
30
from bzrlib.errors import (NoWorkingTree, NotBranchError,
26
31
                           NoRepositoryPresent, NotLocalUrl)
27
32
from bzrlib.missing import find_unmerged
28
 
import bzrlib.osutils as osutils
29
 
from bzrlib.symbol_versioning import *
 
33
from bzrlib.symbol_versioning import (deprecated_function,
 
34
        zero_eighteen)
30
35
 
31
36
 
32
37
def plural(n, base='', pl=None):
33
38
    if n == 1:
34
39
        return base
35
 
    elif pl != None:
 
40
    elif pl is not None:
36
41
        return pl
37
42
    else:
38
43
        return 's'
39
44
 
40
45
 
41
 
def _repo_relpath(repo_path, path):
42
 
    """Return path with common prefix of repository path removed.
43
 
 
44
 
    If path is not part of the repository, the original path is returned.
45
 
    If path is equal to the repository, the current directory marker '.' is
46
 
    returned.
47
 
    """
48
 
    path = osutils.normalizepath(path)
49
 
    repo_path = osutils.normalizepath(repo_path)
50
 
    if path == repo_path:
51
 
        return '.'
52
 
    if osutils.is_inside(repo_path, path):
53
 
        return osutils.relpath(repo_path, path)
54
 
    return path
55
 
 
56
 
 
57
 
def _show_location_info(repository, branch=None, working=None):
58
 
    """Show known locations for working, branch and repository."""
 
46
class LocationList(object):
 
47
 
 
48
    def __init__(self, base_path):
 
49
        self.locs = []
 
50
        self.base_path = base_path
 
51
 
 
52
    def add_url(self, label, url):
 
53
        """Add a URL to the list, converting it to a path if possible"""
 
54
        if url is None:
 
55
            return
 
56
        try:
 
57
            path = urlutils.local_path_from_url(url)
 
58
        except errors.InvalidURL:
 
59
            self.locs.append((label, url))
 
60
        else:
 
61
            self.add_path(label, path)
 
62
 
 
63
    def add_path(self, label, path):
 
64
        """Add a path, converting it to a relative path if possible"""
 
65
        try:
 
66
            path = osutils.relpath(self.base_path, path)
 
67
        except errors.PathNotChild:
 
68
            pass
 
69
        else:
 
70
            if path == '':
 
71
                path = '.'
 
72
        if path != '/':
 
73
            path = path.rstrip('/')
 
74
        self.locs.append((label, path))
 
75
 
 
76
    def get_lines(self):
 
77
        max_len = max(len(l) for l, u in self.locs)
 
78
        return ["  %*s: %s\n" % (max_len, l, u) for l, u in self.locs ]
 
79
 
 
80
 
 
81
def gather_location_info(repository, branch=None, working=None):
 
82
    locs = {}
59
83
    repository_path = repository.bzrdir.root_transport.base
60
 
    print 'Location:'
61
 
    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:
62
93
        working_path = working.bzrdir.root_transport.base
63
 
        branch_path = branch.bzrdir.root_transport.base
64
94
        if working_path != branch_path:
65
 
            # lightweight checkout
66
 
            print '  light checkout root: %s' % working_path
 
95
            locs['light checkout root'] = working_path
 
96
        if master_path != branch_path:
67
97
            if repository.is_shared():
68
 
                # lightweight checkout of branch in shared repository
69
 
                print '    shared repository: %s' % repository_path
70
 
                print '    repository branch: %s' % (
71
 
                    _repo_relpath(repository_path, branch_path))
 
98
                locs['repository checkout root'] = branch_path
72
99
            else:
73
 
                # lightweight checkout of standalone branch
74
 
                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
75
103
        elif repository.is_shared():
76
 
            # branch with tree inside shared repository
77
 
            print '    shared repository: %s' % repository_path
78
 
            print '  repository checkout: %s' % (
79
 
                _repo_relpath(repository_path, branch_path))
80
 
        elif branch.get_bound_location():
81
 
            # normal checkout
82
 
            print '       checkout root: %s' % working_path
83
 
            print '  checkout of branch: %s' % branch.get_bound_location()
84
 
        else:
 
104
            locs['repository branch'] = branch_path
 
105
        elif branch_path is not None:
85
106
            # standalone
86
 
            print '  branch root: %s' % working_path
87
 
    elif branch:
88
 
        branch_path = branch.bzrdir.root_transport.base
 
107
            locs['branch root'] = branch_path
 
108
    else:
 
109
        working_path = None
89
110
        if repository.is_shared():
90
 
            # branch is part of shared repository
91
 
            print '  shared repository: %s' % repository_path
92
 
            print '  repository branch: %s' % (
93
 
                _repo_relpath(repository_path, branch_path))
 
111
            # lightweight checkout of branch in shared repository
 
112
            if branch_path is not None:
 
113
                locs['repository branch'] = branch_path
 
114
        elif branch_path is not None:
 
115
            # standalone
 
116
            locs['branch root'] = branch_path
 
117
            if master_path != branch_path:
 
118
                locs['bound to branch'] = master_path
94
119
        else:
95
 
            # standalone branch
96
 
            print '  branch root: %s' % branch_path
97
 
    else:
98
 
        # shared repository
99
 
        assert repository.is_shared()
100
 
        print '  shared repository: %s' % repository_path
101
 
 
102
 
 
103
 
def _show_related_info(branch):
 
120
            locs['repository'] = repository_path
 
121
    if repository.is_shared():
 
122
        # lightweight checkout of branch in shared repository
 
123
        locs['shared repository'] = repository_path
 
124
    order = ['light checkout root', 'repository checkout root',
 
125
             'checkout root', 'checkout of branch', 'shared repository',
 
126
             'repository', 'repository branch', 'branch root',
 
127
             'bound to branch']
 
128
    return [(n, locs[n]) for n in order if n in locs]
 
129
 
 
130
 
 
131
def _show_location_info(locs):
 
132
    """Show known locations for working, branch and repository."""
 
133
    print 'Location:'
 
134
    path_list = LocationList(os.getcwd())
 
135
    for name, loc in locs:
 
136
        path_list.add_url(name, loc)
 
137
    sys.stdout.writelines(path_list.get_lines())
 
138
 
 
139
def _gather_related_branches(branch):
 
140
    locs = LocationList(os.getcwd())
 
141
    locs.add_url('public branch', branch.get_public_branch())
 
142
    locs.add_url('push branch', branch.get_push_location())
 
143
    locs.add_url('parent branch', branch.get_parent())
 
144
    locs.add_url('submit branch', branch.get_submit_branch())
 
145
    return locs
 
146
 
 
147
def _show_related_info(branch, outfile):
104
148
    """Show parent and push location of branch."""
105
 
    if branch.get_parent() or branch.get_push_location():
106
 
        print
107
 
        print 'Related branches:'
108
 
        if branch.get_parent():
109
 
            if branch.get_push_location():
110
 
                print '      parent branch: %s' % branch.get_parent()
111
 
            else:
112
 
                print '  parent branch: %s' % branch.get_parent()
113
 
        if branch.get_push_location():
114
 
            print '  publish to branch: %s' % branch.get_push_location()
 
149
    locs = _gather_related_branches(branch)
 
150
    if len(locs.locs) > 0:
 
151
        print >> outfile
 
152
        print >> outfile, 'Related branches:'
 
153
        outfile.writelines(locs.get_lines())
115
154
 
116
155
 
117
156
def _show_format_info(control=None, repository=None, branch=None, working=None):
172
211
    branch = working.branch
173
212
    basis = working.basis_tree()
174
213
    work_inv = working.inventory
175
 
    delta = diff.compare_trees(basis, working, want_unchanged=True)
176
 
    history = branch.revision_history()
177
 
    tree_last_id = working.last_revision()
 
214
    branch_revno, branch_last_revision = branch.last_revision_info()
 
215
    try:
 
216
        tree_last_id = working.get_parent_ids()[0]
 
217
    except IndexError:
 
218
        tree_last_id = None
178
219
 
179
 
    if len(history) and tree_last_id != history[-1]:
 
220
    if branch_revno and tree_last_id != branch_last_revision:
180
221
        tree_last_revno = branch.revision_id_to_revno(tree_last_id)
181
 
        missing_count = len(history) - tree_last_revno
 
222
        missing_count = branch_revno - tree_last_revno
182
223
        print
183
224
        print 'Working tree is out of date: missing %d revision%s.' % (
184
225
            missing_count, plural(missing_count))
188
229
    """Show statistics about a working tree."""
189
230
    basis = working.basis_tree()
190
231
    work_inv = working.inventory
191
 
    delta = diff.compare_trees(basis, working, want_unchanged=True)
 
232
    delta = working.changes_from(basis, want_unchanged=True)
192
233
 
193
234
    print
194
235
    print 'In the working tree:'
209
250
 
210
251
    dir_cnt = 0
211
252
    for file_id in work_inv:
212
 
        if work_inv.get_file_kind(file_id) == 'directory':
 
253
        if (work_inv.get_file_kind(file_id) == 'directory' and 
 
254
            not work_inv.is_root(file_id)):
213
255
            dir_cnt += 1
214
256
    print '  %8d versioned %s' \
215
257
          % (dir_cnt,
218
260
 
219
261
def _show_branch_stats(branch, verbose):
220
262
    """Show statistics about a branch."""
221
 
    repository = branch.repository
222
 
    history = branch.revision_history()
223
 
 
 
263
    revno, head = branch.last_revision_info()
224
264
    print
225
265
    print 'Branch history:'
226
 
    revno = len(history)
227
266
    print '  %8d revision%s' % (revno, plural(revno))
 
267
    stats = branch.repository.gather_stats(head, committers=verbose)
228
268
    if verbose:
229
 
        committers = {}
230
 
        for rev in history:
231
 
            committers[repository.get_revision(rev).committer] = True
232
 
        print '  %8d committer%s' % (len(committers), plural(len(committers)))
233
 
    if revno > 0:
234
 
        firstrev = repository.get_revision(history[0])
235
 
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
 
269
        committers = stats['committers']
 
270
        print '  %8d committer%s' % (committers, plural(committers))
 
271
    if revno:
 
272
        timestamp, timezone = stats['firstrev']
 
273
        age = int((time.time() - timestamp) / 3600 / 24)
236
274
        print '  %8d day%s old' % (age, plural(age))
237
 
        print '   first revision: %s' % osutils.format_date(firstrev.timestamp,
238
 
                                                            firstrev.timezone)
239
 
 
240
 
        lastrev = repository.get_revision(history[-1])
241
 
        print '  latest revision: %s' % osutils.format_date(lastrev.timestamp,
242
 
                                                            lastrev.timezone)
243
 
 
244
 
#     print
245
 
#     print 'Text store:'
246
 
#     c, t = branch.text_store.total_size()
247
 
#     print '  %8d file texts' % c
248
 
#     print '  %8d KiB' % (t/1024)
249
 
 
250
 
#     print
251
 
#     print 'Inventory store:'
252
 
#     c, t = branch.inventory_store.total_size()
253
 
#     print '  %8d inventories' % c
254
 
#     print '  %8d KiB' % (t/1024)
 
275
        print '   first revision: %s' % osutils.format_date(timestamp,
 
276
            timezone)
 
277
        timestamp, timezone = stats['latestrev']
 
278
        print '  latest revision: %s' % osutils.format_date(timestamp,
 
279
            timezone)
 
280
    return stats
255
281
 
256
282
 
257
283
def _show_repository_info(repository):
261
287
        print 'Create working tree for new branches inside the repository.'
262
288
 
263
289
 
264
 
def _show_repository_stats(repository):
 
290
def _show_repository_stats(stats):
265
291
    """Show statistics about a repository."""
266
 
    if repository.bzrdir.root_transport.listable():
 
292
    if 'revisions' in stats or 'size' in stats:
267
293
        print
268
 
        print 'Revision store:'
269
 
        c, t = repository._revision_store.total_size(repository.get_transaction())
270
 
        print '  %8d revision%s' % (c, plural(c))
271
 
        print '  %8d KiB' % (t/1024)
272
 
 
273
 
 
274
 
@deprecated_function(zero_eight)
275
 
def show_info(b):
276
 
    """Please see show_bzrdir_info."""
277
 
    return show_bzrdir_info(b.bzrdir)
278
 
 
 
294
        print 'Repository:'
 
295
    if 'revisions' in stats:
 
296
        revisions = stats['revisions']
 
297
        print '  %8d revision%s' % (revisions, plural(revisions))
 
298
    if 'size' in stats:
 
299
        print '  %8d KiB' % (stats['size']/1024)
279
300
 
280
301
def show_bzrdir_info(a_bzrdir, verbose=False):
281
302
    """Output to stdout the 'info' for a_bzrdir."""
282
303
    try:
283
 
        working = a_bzrdir.open_workingtree()
284
 
        working.lock_read()
285
 
        try:
286
 
            show_tree_info(working, verbose)
287
 
        finally:
288
 
            working.unlock()
289
 
        return
 
304
        tree = a_bzrdir.open_workingtree(
 
305
            recommend_upgrade=False)
290
306
    except (NoWorkingTree, NotLocalUrl):
291
 
        pass
292
 
 
293
 
    try:
294
 
        branch = a_bzrdir.open_branch()
295
 
        branch.lock_read()
296
 
        try:
297
 
            show_branch_info(branch, verbose)
298
 
        finally:
299
 
            branch.unlock()
300
 
        return
301
 
    except NotBranchError:
302
 
        pass
303
 
 
304
 
    try:
305
 
        repository = a_bzrdir.open_repository()
306
 
        repository.lock_read()
307
 
        try:
308
 
            show_repository_info(repository, verbose)
309
 
        finally:
310
 
            repository.unlock()
311
 
        return
312
 
    except NoRepositoryPresent:
313
 
        pass
314
 
 
315
 
    # Return silently, cmd_info already returned NotBranchError if no bzrdir
316
 
    # could be opened.
317
 
 
318
 
 
 
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 branch is not None:
 
347
        _show_related_info(branch, sys.stdout)
 
348
    if verbose == 0:
 
349
        return
 
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)
 
452
 
 
453
 
 
454
@deprecated_function(zero_eighteen)
319
455
def show_tree_info(working, verbose):
320
456
    """Output to stdout the 'info' for working."""
321
457
    branch = working.branch
322
458
    repository = branch.repository
323
459
    control = working.bzrdir
324
 
 
325
 
    _show_location_info(repository, branch, working)
326
 
    _show_related_info(branch)
327
 
    _show_format_info(control, repository, branch, working)
328
 
    _show_locking_info(repository, branch, working)
329
 
    _show_missing_revisions_branch(branch)
330
 
    _show_missing_revisions_working(working)
331
 
    _show_working_stats(working)
332
 
    _show_branch_stats(branch, verbose)
333
 
    _show_repository_stats(repository)
334
 
 
335
 
 
 
460
    show_component_info(control, repository, branch, working, verbose)
 
461
 
 
462
 
 
463
@deprecated_function(zero_eighteen)
336
464
def show_branch_info(branch, verbose):
337
465
    """Output to stdout the 'info' for branch."""
338
466
    repository = branch.repository
339
467
    control = branch.bzrdir
340
 
 
341
 
    _show_location_info(repository, branch)
342
 
    _show_related_info(branch)
343
 
    _show_format_info(control, repository, branch)
344
 
    _show_locking_info(repository, branch)
345
 
    _show_missing_revisions_branch(branch)
346
 
    _show_branch_stats(branch, verbose)
347
 
    _show_repository_stats(repository)
348
 
 
349
 
 
 
468
    show_component_info(control, repository, branch, verbose=verbose)
 
469
 
 
470
 
 
471
@deprecated_function(zero_eighteen)
350
472
def show_repository_info(repository, verbose):
351
473
    """Output to stdout the 'info' for repository."""
352
474
    control = repository.bzrdir
353
 
 
354
 
    _show_location_info(repository)
355
 
    _show_format_info(control, repository)
356
 
    _show_locking_info(repository)
357
 
    _show_repository_info(repository)
358
 
    _show_repository_stats(repository)
 
475
    show_component_info(control, repository, verbose=verbose)