← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: John Arbash Meinel
  • Date: 2006-07-27 18:14:48 UTC
  • mto: (1946.2.6 reduce-knit-churn)
  • mto: This revision was merged to the branch mainline in revision 1887.
  • Revision ID: john@arbash-meinel.com-20060727181448-62962f823be5d3cc
minor typo fix

Show diffs side-by-side

added added

removed removed

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