← 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: 2006-04-18 22:41:16 UTC
  • mto: (1711.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1671.
  • Revision ID: robertc@robertcollins.net-20060418224116-9b723440fa56e404
 * 'Metadir' is now the default disk format. This improves behaviour in
   SFTP using circumstances and allows binding and rebinding and easier
   use of repositories. (Robert Collins, Aaron Bentley).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/info.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
 
# 
 
1
# Copyright (C) 2004, 2005 by Martin Pool
 
2
# Copyright (C) 2005 by Canonical Ltd
 
3
 
 
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
12
 
#
 
14
 
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
21
import time
20
22
 
21
23
 
22
 
from bzrlib import (
23
 
    bzrdir,
24
 
    diff,
25
 
    osutils,
26
 
    urlutils,
27
 
    )
 
24
import bzrlib.diff as diff
28
25
from bzrlib.errors import (NoWorkingTree, NotBranchError,
29
26
                           NoRepositoryPresent, NotLocalUrl)
30
27
from bzrlib.missing import find_unmerged
31
 
from bzrlib.symbol_versioning import (deprecated_function,
32
 
        zero_eight, zero_eighteen)
 
28
from bzrlib.osutils import format_date
 
29
from bzrlib.symbol_versioning import *
 
30
 
 
31
 
 
32
def _countiter(it):
 
33
    # surely there's a builtin for this?
 
34
    i = 0
 
35
    for j in it:
 
36
        i += 1
 
37
    return i        
33
38
 
34
39
 
35
40
def plural(n, base='', pl=None):
36
41
    if n == 1:
37
42
        return base
38
 
    elif pl is not None:
 
43
    elif pl != None:
39
44
        return pl
40
45
    else:
41
46
        return 's'
42
47
 
43
48
 
44
 
def _repo_rel_url(repo_url, inner_url):
45
 
    """Return path with common prefix of repository path removed.
46
 
 
47
 
    If path is not part of the repository, the original path is returned.
48
 
    If path is equal to the repository, the current directory marker '.' is
49
 
    returned.
50
 
    Otherwise, a relative path is returned, with trailing '/' stripped.
51
 
    """
52
 
    inner_url = urlutils.normalize_url(inner_url)
53
 
    repo_url = urlutils.normalize_url(repo_url)
54
 
    if inner_url == repo_url:
55
 
        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 = {}
83
 
    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:
93
 
        working_path = working.bzrdir.root_transport.base
94
 
        if working_path != branch_path:
95
 
            locs['light checkout root'] = working_path
96
 
        if master_path != branch_path:
97
 
            if repository.is_shared():
98
 
                locs['repository checkout root'] = branch_path
99
 
            else:
100
 
                locs['checkout root'] = branch_path
101
 
        if working_path != master_path:
102
 
            locs['checkout of branch'] = master_path
103
 
        elif repository.is_shared():
104
 
            locs['repository branch'] = _repo_rel_url(repository_path,
105
 
                branch_path)
106
 
        elif branch_path is not None:
107
 
            # standalone
108
 
            locs['branch root'] = branch_path
109
 
    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):
 
49
def _show_location_info(repository=None, branch=None, working=None):
134
50
    """Show known locations for working, branch and repository."""
135
51
    print 'Location:'
136
 
    path_list = _UrlList()
137
 
    for name, loc in locs:
138
 
        path_list.add_url(name, loc)
139
 
    path_list.print_lines()
140
 
 
141
 
 
142
 
def _show_related_info(branch):
143
 
    """Show parent and push location of branch."""
144
 
    if branch.get_parent() or branch.get_push_location():
145
 
        print
146
 
        print 'Related branches:'
 
52
    if working and branch and working.bzrdir != branch.bzrdir:
 
53
        # Lightweight checkout
 
54
        print '       checkout root: %s' % (
 
55
            working.bzrdir.root_transport.base)
 
56
        print '  checkout of branch: %s' % (
 
57
            branch.bzrdir.root_transport.base)
 
58
    elif branch:
 
59
        # Standalone or bound branch (normal checkout)
 
60
        print '         branch root: %s' % (
 
61
            branch.bzrdir.root_transport.base)
 
62
        if branch.get_bound_location():
 
63
            print '     bound to branch: %s' % branch.get_bound_location()
 
64
 
 
65
    if repository and (not branch or repository.bzrdir != branch.bzrdir):
 
66
        if repository.is_shared():
 
67
            print '   shared repository: %s' % (
 
68
                repository.bzrdir.root_transport.base)
 
69
        else:
 
70
            print '          repository: %s' % (
 
71
                repository.bzrdir.root_transport.base)
 
72
 
 
73
    if branch:
147
74
        if branch.get_parent():
148
 
            if branch.get_push_location():
149
 
                print '      parent branch: %s' % branch.get_parent()
150
 
            else:
151
 
                print '  parent branch: %s' % branch.get_parent()
 
75
            print '       parent branch: %s' % branch.get_parent()
152
76
        if branch.get_push_location():
153
 
            print '  publish to branch: %s' % branch.get_push_location()
 
77
            print '      push to branch: %s' % branch.get_push_location()
154
78
 
155
79
 
156
80
def _show_format_info(control=None, repository=None, branch=None, working=None):
167
91
        print '    repository: %s' % repository._format.get_format_description()
168
92
 
169
93
 
170
 
def _show_locking_info(repository, branch=None, working=None):
171
 
    """Show locking status of working, branch and repository."""
172
 
    if (repository.get_physical_lock_status() or
173
 
        (branch and branch.get_physical_lock_status()) or
174
 
        (working and working.get_physical_lock_status())):
175
 
        print
176
 
        print 'Lock status:'
177
 
        if working:
178
 
            if working.get_physical_lock_status():
179
 
                status = 'locked'
180
 
            else:
181
 
                status = 'unlocked'
182
 
            print '  working tree: %s' % status
183
 
        if branch:
184
 
            if branch.get_physical_lock_status():
185
 
                status = 'locked'
186
 
            else:
187
 
                status = 'unlocked'
188
 
            print '        branch: %s' % status
189
 
        if repository:
190
 
            if repository.get_physical_lock_status():
191
 
                status = 'locked'
192
 
            else:
193
 
                status = 'unlocked'
194
 
            print '    repository: %s' % status
195
 
 
196
 
 
197
94
def _show_missing_revisions_branch(branch):
198
95
    """Show missing master revisions in branch."""
199
96
    # Try with inaccessible branch ?
211
108
    branch = working.branch
212
109
    basis = working.basis_tree()
213
110
    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
 
111
    delta = diff.compare_trees(basis, working, want_unchanged=True)
 
112
    history = branch.revision_history()
 
113
    tree_last_id = working.last_revision()
219
114
 
220
 
    if branch_revno and tree_last_id != branch_last_revision:
 
115
    if len(history) and tree_last_id != history[-1]:
221
116
        tree_last_revno = branch.revision_id_to_revno(tree_last_id)
222
 
        missing_count = branch_revno - tree_last_revno
 
117
        missing_count = len(history) - tree_last_revno
223
118
        print
224
119
        print 'Working tree is out of date: missing %d revision%s.' % (
225
120
            missing_count, plural(missing_count))
229
124
    """Show statistics about a working tree."""
230
125
    basis = working.basis_tree()
231
126
    work_inv = working.inventory
232
 
    delta = working.changes_from(basis, want_unchanged=True)
 
127
    delta = diff.compare_trees(basis, working, want_unchanged=True)
233
128
 
234
129
    print
235
130
    print 'In the working tree:'
250
145
 
251
146
    dir_cnt = 0
252
147
    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)):
 
148
        if work_inv.get_file_kind(file_id) == 'directory':
255
149
            dir_cnt += 1
256
150
    print '  %8d versioned %s' \
257
151
          % (dir_cnt,
260
154
 
261
155
def _show_branch_stats(branch, verbose):
262
156
    """Show statistics about a branch."""
263
 
    revno, head = branch.last_revision_info()
 
157
    repository = branch.repository
 
158
    history = branch.revision_history()
 
159
 
264
160
    print
265
161
    print 'Branch history:'
 
162
    revno = len(history)
266
163
    print '  %8d revision%s' % (revno, plural(revno))
267
 
    stats = branch.repository.gather_stats(head, committers=verbose)
268
164
    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)
 
165
        committers = {}
 
166
        for rev in history:
 
167
            committers[repository.get_revision(rev).committer] = True
 
168
        print '  %8d committer%s' % (len(committers), plural(len(committers)))
 
169
    if revno > 0:
 
170
        firstrev = repository.get_revision(history[0])
 
171
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
274
172
        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
 
173
        print '   first revision: %s' % format_date(firstrev.timestamp,
 
174
                                                    firstrev.timezone)
 
175
 
 
176
        lastrev = repository.get_revision(history[-1])
 
177
        print '  latest revision: %s' % format_date(lastrev.timestamp,
 
178
                                                    lastrev.timezone)
 
179
 
 
180
#     print
 
181
#     print 'Text store:'
 
182
#     c, t = branch.text_store.total_size()
 
183
#     print '  %8d file texts' % c
 
184
#     print '  %8d KiB' % (t/1024)
 
185
 
 
186
#     print
 
187
#     print 'Inventory store:'
 
188
#     c, t = branch.inventory_store.total_size()
 
189
#     print '  %8d inventories' % c
 
190
#     print '  %8d KiB' % (t/1024)
281
191
 
282
192
 
283
193
def _show_repository_info(repository):
287
197
        print 'Create working tree for new branches inside the repository.'
288
198
 
289
199
 
290
 
def _show_repository_stats(stats):
 
200
def _show_repository_stats(repository):
291
201
    """Show statistics about a repository."""
292
 
    if 'revisions' in stats or 'size' in stats:
 
202
    if repository.bzrdir.root_transport.listable():
293
203
        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)
 
204
        print 'Revision store:'
 
205
        c, t = repository._revision_store.total_size(repository.get_transaction())
 
206
        print '  %8d revision%s' % (c, plural(c))
 
207
        print '  %8d KiB' % (t/1024)
 
208
 
452
209
 
453
210
@deprecated_function(zero_eight)
454
211
def show_info(b):
456
213
    return show_bzrdir_info(b.bzrdir)
457
214
 
458
215
 
459
 
@deprecated_function(zero_eighteen)
 
216
def show_bzrdir_info(a_bzrdir, verbose=False):
 
217
    """Output to stdout the 'info' for a_bzrdir."""
 
218
    try:
 
219
        working = a_bzrdir.open_workingtree()
 
220
        working.lock_read()
 
221
        try:
 
222
            show_tree_info(working, verbose)
 
223
        finally:
 
224
            working.unlock()
 
225
        return
 
226
    except (NoWorkingTree, NotLocalUrl):
 
227
        pass
 
228
 
 
229
    try:
 
230
        branch = a_bzrdir.open_branch()
 
231
        branch.lock_read()
 
232
        try:
 
233
            show_branch_info(branch, verbose)
 
234
        finally:
 
235
            branch.unlock()
 
236
        return
 
237
    except NotBranchError:
 
238
        pass
 
239
 
 
240
    try:
 
241
        repository = a_bzrdir.open_repository()
 
242
        repository.lock_read()
 
243
        try:
 
244
            show_repository_info(repository, verbose)
 
245
        finally:
 
246
            repository.unlock()
 
247
        return
 
248
    except NoRepositoryPresent:
 
249
        pass
 
250
 
 
251
    # Return silently, cmd_info returns NotBranchError if no bzrdir
 
252
    # could be opened.
 
253
 
 
254
 
460
255
def show_tree_info(working, verbose):
461
256
    """Output to stdout the 'info' for working."""
462
257
    branch = working.branch
463
258
    repository = branch.repository
464
259
    control = working.bzrdir
465
 
    show_component_info(control, repository, branch, working, verbose)
466
 
 
467
 
 
468
 
@deprecated_function(zero_eighteen)
 
260
 
 
261
    _show_location_info(repository, branch, working)
 
262
    _show_format_info(control, repository, branch, working)
 
263
    _show_missing_revisions_branch(branch)
 
264
    _show_missing_revisions_working(working)
 
265
    _show_working_stats(working)
 
266
    _show_branch_stats(branch, verbose)
 
267
    _show_repository_stats(repository)
 
268
 
 
269
 
469
270
def show_branch_info(branch, verbose):
470
271
    """Output to stdout the 'info' for branch."""
471
272
    repository = branch.repository
472
273
    control = branch.bzrdir
473
 
    show_component_info(control, repository, branch, verbose=verbose)
474
 
 
475
 
 
476
 
@deprecated_function(zero_eighteen)
 
274
 
 
275
    _show_location_info(repository, branch)
 
276
    _show_format_info(control, repository, branch)
 
277
    _show_missing_revisions_branch(branch)
 
278
    _show_branch_stats(branch, verbose)
 
279
    _show_repository_stats(repository)
 
280
 
 
281
 
477
282
def show_repository_info(repository, verbose):
478
 
    """Output to stdout the 'info' for repository."""
 
283
    """Output to stdout the 'info' for branch."""
479
284
    control = repository.bzrdir
480
 
    show_component_info(control, repository, verbose=verbose)
 
285
 
 
286
    _show_location_info(repository)
 
287
    _show_format_info(control, repository)
 
288
    _show_repository_info(repository)
 
289
    _show_repository_stats(repository)