← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Wouter van Heyst
  • Date: 2006-06-07 16:05:27 UTC
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: larstiq@larstiq.dyndns.org-20060607160527-2b3649154d0e2e84
more code cleanup

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
19
19
import time
20
20
 
21
21
 
22
 
from bzrlib import (
23
 
    bzrdir,
24
 
    diff,
25
 
    osutils,
26
 
    urlutils,
27
 
    )
 
22
import bzrlib.diff as diff
28
23
from bzrlib.errors import (NoWorkingTree, NotBranchError,
29
24
                           NoRepositoryPresent, NotLocalUrl)
30
25
from bzrlib.missing import find_unmerged
31
 
from bzrlib.symbol_versioning import (deprecated_function,
32
 
        zero_eight, zero_eighteen)
 
26
import bzrlib.osutils as osutils
 
27
from bzrlib.symbol_versioning import *
33
28
 
34
29
 
35
30
def plural(n, base='', pl=None):
36
31
    if n == 1:
37
32
        return base
38
 
    elif pl is not None:
 
33
    elif pl != None:
39
34
        return pl
40
35
    else:
41
36
        return 's'
42
37
 
43
38
 
44
 
def _repo_rel_url(repo_url, inner_url):
 
39
def _repo_relpath(repo_path, path):
45
40
    """Return path with common prefix of repository path removed.
46
41
 
47
42
    If path is not part of the repository, the original path is returned.
48
43
    If path is equal to the repository, the current directory marker '.' is
49
44
    returned.
50
 
    Otherwise, a relative path is returned, with trailing '/' stripped.
51
45
    """
52
 
    inner_url = urlutils.normalize_url(inner_url)
53
 
    repo_url = urlutils.normalize_url(repo_url)
54
 
    if inner_url == repo_url:
 
46
    path = osutils.normalizepath(path)
 
47
    repo_path = osutils.normalizepath(repo_path)
 
48
    if path == repo_path:
55
49
        return '.'
56
 
    result = urlutils.relative_url(repo_url, inner_url)
57
 
    if result != inner_url:
58
 
        result = result.rstrip('/')
59
 
    return result
60
 
 
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 = {}
 
50
    if osutils.is_inside(repo_path, path):
 
51
        return osutils.relpath(repo_path, path)
 
52
    return path
 
53
 
 
54
 
 
55
def _show_location_info(repository, branch=None, working=None):
 
56
    """Show known locations for working, branch and repository."""
83
57
    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:
 
58
    print 'Location:'
 
59
    if working and branch:
93
60
        working_path = working.bzrdir.root_transport.base
 
61
        branch_path = branch.bzrdir.root_transport.base
94
62
        if working_path != branch_path:
95
 
            locs['light checkout root'] = working_path
96
 
        if master_path != branch_path:
 
63
            # lightweight checkout
 
64
            print '  light checkout root: %s' % working_path
97
65
            if repository.is_shared():
98
 
                locs['repository checkout root'] = branch_path
 
66
                # lightweight checkout of branch in shared repository
 
67
                print '    shared repository: %s' % repository_path
 
68
                print '    repository branch: %s' % (
 
69
                    _repo_relpath(repository_path, branch_path))
99
70
            else:
100
 
                locs['checkout root'] = branch_path
101
 
        if working_path != master_path:
102
 
            locs['checkout of branch'] = master_path
 
71
                # lightweight checkout of standalone branch
 
72
                print '   checkout of branch: %s' % branch_path
103
73
        elif repository.is_shared():
104
 
            locs['repository branch'] = _repo_rel_url(repository_path,
105
 
                branch_path)
106
 
        elif branch_path is not None:
 
74
            # branch with tree inside shared repository
 
75
            print '    shared repository: %s' % repository_path
 
76
            print '  repository checkout: %s' % (
 
77
                _repo_relpath(repository_path, branch_path))
 
78
        elif branch.get_bound_location():
 
79
            # normal checkout
 
80
            print '       checkout root: %s' % working_path
 
81
            print '  checkout of branch: %s' % branch.get_bound_location()
 
82
        else:
107
83
            # standalone
108
 
            locs['branch root'] = branch_path
 
84
            print '  branch root: %s' % working_path
 
85
    elif branch:
 
86
        branch_path = branch.bzrdir.root_transport.base
 
87
        if repository.is_shared():
 
88
            # branch is part of shared repository
 
89
            print '  shared repository: %s' % repository_path
 
90
            print '  repository branch: %s' % (
 
91
                _repo_relpath(repository_path, branch_path))
 
92
        else:
 
93
            # standalone branch
 
94
            print '  branch root: %s' % branch_path
109
95
    else:
110
 
        working_path = None
111
 
        if repository.is_shared():
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
121
 
        else:
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()
 
96
        # shared repository
 
97
        assert repository.is_shared()
 
98
        print '  shared repository: %s' % repository_path
140
99
 
141
100
 
142
101
def _show_related_info(branch):
211
170
    branch = working.branch
212
171
    basis = working.basis_tree()
213
172
    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
 
173
    delta = diff.compare_trees(basis, working, want_unchanged=True)
 
174
    history = branch.revision_history()
 
175
    tree_last_id = working.last_revision()
219
176
 
220
 
    if branch_revno and tree_last_id != branch_last_revision:
 
177
    if len(history) and tree_last_id != history[-1]:
221
178
        tree_last_revno = branch.revision_id_to_revno(tree_last_id)
222
 
        missing_count = branch_revno - tree_last_revno
 
179
        missing_count = len(history) - tree_last_revno
223
180
        print
224
181
        print 'Working tree is out of date: missing %d revision%s.' % (
225
182
            missing_count, plural(missing_count))
229
186
    """Show statistics about a working tree."""
230
187
    basis = working.basis_tree()
231
188
    work_inv = working.inventory
232
 
    delta = working.changes_from(basis, want_unchanged=True)
 
189
    delta = diff.compare_trees(basis, working, want_unchanged=True)
233
190
 
234
191
    print
235
192
    print 'In the working tree:'
250
207
 
251
208
    dir_cnt = 0
252
209
    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)):
 
210
        if work_inv.get_file_kind(file_id) == 'directory':
255
211
            dir_cnt += 1
256
212
    print '  %8d versioned %s' \
257
213
          % (dir_cnt,
260
216
 
261
217
def _show_branch_stats(branch, verbose):
262
218
    """Show statistics about a branch."""
263
 
    revno, head = branch.last_revision_info()
 
219
    repository = branch.repository
 
220
    history = branch.revision_history()
 
221
 
264
222
    print
265
223
    print 'Branch history:'
 
224
    revno = len(history)
266
225
    print '  %8d revision%s' % (revno, plural(revno))
267
 
    stats = branch.repository.gather_stats(head, committers=verbose)
268
226
    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)
 
227
        committers = {}
 
228
        for rev in history:
 
229
            committers[repository.get_revision(rev).committer] = True
 
230
        print '  %8d committer%s' % (len(committers), plural(len(committers)))
 
231
    if revno > 0:
 
232
        firstrev = repository.get_revision(history[0])
 
233
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
274
234
        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
 
235
        print '   first revision: %s' % osutils.format_date(firstrev.timestamp,
 
236
                                                            firstrev.timezone)
 
237
 
 
238
        lastrev = repository.get_revision(history[-1])
 
239
        print '  latest revision: %s' % osutils.format_date(lastrev.timestamp,
 
240
                                                            lastrev.timezone)
 
241
 
 
242
#     print
 
243
#     print 'Text store:'
 
244
#     c, t = branch.text_store.total_size()
 
245
#     print '  %8d file texts' % c
 
246
#     print '  %8d KiB' % (t/1024)
 
247
 
 
248
#     print
 
249
#     print 'Inventory store:'
 
250
#     c, t = branch.inventory_store.total_size()
 
251
#     print '  %8d inventories' % c
 
252
#     print '  %8d KiB' % (t/1024)
281
253
 
282
254
 
283
255
def _show_repository_info(repository):
287
259
        print 'Create working tree for new branches inside the repository.'
288
260
 
289
261
 
290
 
def _show_repository_stats(stats):
 
262
def _show_repository_stats(repository):
291
263
    """Show statistics about a repository."""
292
 
    if 'revisions' in stats or 'size' in stats:
 
264
    if repository.bzrdir.root_transport.listable():
293
265
        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 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
        print 'Revision store:'
 
267
        c, t = repository._revision_store.total_size(repository.get_transaction())
 
268
        print '  %8d revision%s' % (c, plural(c))
 
269
        print '  %8d KiB' % (t/1024)
 
270
 
452
271
 
453
272
@deprecated_function(zero_eight)
454
273
def show_info(b):
456
275
    return show_bzrdir_info(b.bzrdir)
457
276
 
458
277
 
459
 
@deprecated_function(zero_eighteen)
 
278
def show_bzrdir_info(a_bzrdir, verbose=False):
 
279
    """Output to stdout the 'info' for a_bzrdir."""
 
280
    try:
 
281
        working = a_bzrdir.open_workingtree()
 
282
        working.lock_read()
 
283
        try:
 
284
            show_tree_info(working, verbose)
 
285
        finally:
 
286
            working.unlock()
 
287
        return
 
288
    except (NoWorkingTree, NotLocalUrl):
 
289
        pass
 
290
 
 
291
    try:
 
292
        branch = a_bzrdir.open_branch()
 
293
        branch.lock_read()
 
294
        try:
 
295
            show_branch_info(branch, verbose)
 
296
        finally:
 
297
            branch.unlock()
 
298
        return
 
299
    except NotBranchError:
 
300
        pass
 
301
 
 
302
    try:
 
303
        repository = a_bzrdir.open_repository()
 
304
        repository.lock_read()
 
305
        try:
 
306
            show_repository_info(repository, verbose)
 
307
        finally:
 
308
            repository.unlock()
 
309
        return
 
310
    except NoRepositoryPresent:
 
311
        pass
 
312
 
 
313
    # Return silently, cmd_info already returned NotBranchError if no bzrdir
 
314
    # could be opened.
 
315
 
 
316
 
460
317
def show_tree_info(working, verbose):
461
318
    """Output to stdout the 'info' for working."""
462
319
    branch = working.branch
463
320
    repository = branch.repository
464
321
    control = working.bzrdir
465
 
    show_component_info(control, repository, branch, working, verbose)
466
 
 
467
 
 
468
 
@deprecated_function(zero_eighteen)
 
322
 
 
323
    _show_location_info(repository, branch, working)
 
324
    _show_related_info(branch)
 
325
    _show_format_info(control, repository, branch, working)
 
326
    _show_locking_info(repository, branch, working)
 
327
    _show_missing_revisions_branch(branch)
 
328
    _show_missing_revisions_working(working)
 
329
    _show_working_stats(working)
 
330
    _show_branch_stats(branch, verbose)
 
331
    _show_repository_stats(repository)
 
332
 
 
333
 
469
334
def show_branch_info(branch, verbose):
470
335
    """Output to stdout the 'info' for branch."""
471
336
    repository = branch.repository
472
337
    control = branch.bzrdir
473
 
    show_component_info(control, repository, branch, verbose=verbose)
474
 
 
475
 
 
476
 
@deprecated_function(zero_eighteen)
 
338
 
 
339
    _show_location_info(repository, branch)
 
340
    _show_related_info(branch)
 
341
    _show_format_info(control, repository, branch)
 
342
    _show_locking_info(repository, branch)
 
343
    _show_missing_revisions_branch(branch)
 
344
    _show_branch_stats(branch, verbose)
 
345
    _show_repository_stats(repository)
 
346
 
 
347
 
477
348
def show_repository_info(repository, verbose):
478
349
    """Output to stdout the 'info' for repository."""
479
350
    control = repository.bzrdir
480
 
    show_component_info(control, repository, verbose=verbose)
 
351
 
 
352
    _show_location_info(repository)
 
353
    _show_format_info(control, repository)
 
354
    _show_locking_info(repository)
 
355
    _show_repository_info(repository)
 
356
    _show_repository_stats(repository)