~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Robert Collins
  • Date: 2005-12-02 03:23:47 UTC
  • Revision ID: robertc@robertcollins.net-20051202032347-ba08123207a945a0
Test for Jeff Bailey.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
__all__ = ['show_bzrdir_info']
18
 
 
19
 
from cStringIO import StringIO
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 
20
19
import time
21
 
import sys
22
 
 
23
 
from bzrlib import (
24
 
    bzrdir,
25
 
    errors,
26
 
    hooks as _mod_hooks,
27
 
    osutils,
28
 
    urlutils,
29
 
    )
30
 
from bzrlib.errors import (NoWorkingTree, NotBranchError,
31
 
                           NoRepositoryPresent, NotLocalUrl)
32
 
from bzrlib.missing import find_unmerged
33
 
 
34
 
 
35
 
def plural(n, base='', pl=None):
36
 
    if n == 1:
37
 
        return base
38
 
    elif pl is not None:
39
 
        return pl
40
 
    else:
41
 
        return 's'
42
 
 
43
 
 
44
 
class LocationList(object):
45
 
 
46
 
    def __init__(self, base_path):
47
 
        self.locs = []
48
 
        self.base_path = base_path
49
 
 
50
 
    def add_url(self, label, url):
51
 
        """Add a URL to the list, converting it to a path if possible"""
52
 
        if url is None:
53
 
            return
54
 
        try:
55
 
            path = urlutils.local_path_from_url(url)
56
 
        except errors.InvalidURL:
57
 
            self.locs.append((label, url))
58
 
        else:
59
 
            self.add_path(label, path)
60
 
 
61
 
    def add_path(self, label, path):
62
 
        """Add a path, converting it to a relative path if possible"""
63
 
        try:
64
 
            path = osutils.relpath(self.base_path, path)
65
 
        except errors.PathNotChild:
66
 
            pass
67
 
        else:
68
 
            if path == '':
69
 
                path = '.'
70
 
        if path != '/':
71
 
            path = path.rstrip('/')
72
 
        self.locs.append((label, path))
73
 
 
74
 
    def get_lines(self):
75
 
        max_len = max(len(l) for l, u in self.locs)
76
 
        return ["  %*s: %s\n" % (max_len, l, u) for l, u in self.locs ]
77
 
 
78
 
 
79
 
def gather_location_info(repository, branch=None, working=None):
80
 
    locs = {}
81
 
    repository_path = repository.user_url
82
 
    if branch is not None:
83
 
        branch_path = branch.user_url
84
 
        master_path = branch.get_bound_location()
85
 
        if master_path is None:
86
 
            master_path = branch_path
87
 
    else:
88
 
        branch_path = None
89
 
        master_path = None
90
 
    if working:
91
 
        working_path = working.user_url
92
 
        if working_path != branch_path:
93
 
            locs['light checkout root'] = working_path
94
 
        if master_path != branch_path:
95
 
            if repository.is_shared():
96
 
                locs['repository checkout root'] = branch_path
97
 
            else:
98
 
                locs['checkout root'] = branch_path
99
 
        if working_path != master_path:
100
 
            locs['checkout of branch'] = master_path
101
 
        elif repository.is_shared():
102
 
            locs['repository branch'] = branch_path
103
 
        elif branch_path is not None:
104
 
            # standalone
105
 
            locs['branch root'] = branch_path
106
 
    else:
107
 
        working_path = None
108
 
        if repository.is_shared():
109
 
            # lightweight checkout of branch in shared repository
110
 
            if branch_path is not None:
111
 
                locs['repository branch'] = branch_path
112
 
        elif branch_path is not None:
113
 
            # standalone
114
 
            locs['branch root'] = branch_path
115
 
            if master_path != branch_path:
116
 
                locs['bound to branch'] = master_path
117
 
        else:
118
 
            locs['repository'] = repository_path
119
 
    if repository.is_shared():
120
 
        # lightweight checkout of branch in shared repository
121
 
        locs['shared repository'] = repository_path
122
 
    order = ['light checkout root', 'repository checkout root',
123
 
             'checkout root', 'checkout of branch', 'shared repository',
124
 
             'repository', 'repository branch', 'branch root',
125
 
             'bound to branch']
126
 
    return [(n, locs[n]) for n in order if n in locs]
127
 
 
128
 
 
129
 
def _show_location_info(locs, outfile):
130
 
    """Show known locations for working, branch and repository."""
131
 
    outfile.write('Location:\n')
132
 
    path_list = LocationList(osutils.getcwd())
133
 
    for name, loc in locs:
134
 
        path_list.add_url(name, loc)
135
 
    outfile.writelines(path_list.get_lines())
136
 
 
137
 
 
138
 
def _gather_related_branches(branch):
139
 
    locs = LocationList(osutils.getcwd())
140
 
    locs.add_url('public branch', branch.get_public_branch())
141
 
    locs.add_url('push branch', branch.get_push_location())
142
 
    locs.add_url('parent branch', branch.get_parent())
143
 
    locs.add_url('submit branch', branch.get_submit_branch())
144
 
    try:
145
 
        locs.add_url('stacked on', branch.get_stacked_on_url())
146
 
    except (errors.UnstackableBranchFormat, errors.UnstackableRepositoryFormat,
147
 
        errors.NotStacked):
148
 
        pass
149
 
    return locs
150
 
 
151
 
 
152
 
def _show_related_info(branch, outfile):
153
 
    """Show parent and push location of branch."""
154
 
    locs = _gather_related_branches(branch)
155
 
    if len(locs.locs) > 0:
156
 
        outfile.write('\n')
157
 
        outfile.write('Related branches:\n')
158
 
        outfile.writelines(locs.get_lines())
159
 
 
160
 
 
161
 
def _show_format_info(control=None, repository=None, branch=None,
162
 
                      working=None, outfile=None):
163
 
    """Show known formats for control, working, branch and repository."""
164
 
    outfile.write('\n')
165
 
    outfile.write('Format:\n')
166
 
    if control:
167
 
        outfile.write('       control: %s\n' %
168
 
            control._format.get_format_description())
169
 
    if working:
170
 
        outfile.write('  working tree: %s\n' %
171
 
            working._format.get_format_description())
172
 
    if branch:
173
 
        outfile.write('        branch: %s\n' %
174
 
            branch._format.get_format_description())
175
 
    if repository:
176
 
        outfile.write('    repository: %s\n' %
177
 
            repository._format.get_format_description())
178
 
 
179
 
 
180
 
def _show_locking_info(repository, branch=None, working=None, outfile=None):
181
 
    """Show locking status of working, branch and repository."""
182
 
    if (repository.get_physical_lock_status() or
183
 
        (branch and branch.get_physical_lock_status()) or
184
 
        (working and working.get_physical_lock_status())):
185
 
        outfile.write('\n')
186
 
        outfile.write('Lock status:\n')
187
 
        if working:
188
 
            if working.get_physical_lock_status():
189
 
                status = 'locked'
190
 
            else:
191
 
                status = 'unlocked'
192
 
            outfile.write('  working tree: %s\n' % status)
193
 
        if branch:
194
 
            if branch.get_physical_lock_status():
195
 
                status = 'locked'
196
 
            else:
197
 
                status = 'unlocked'
198
 
            outfile.write('        branch: %s\n' % status)
199
 
        if repository:
200
 
            if repository.get_physical_lock_status():
201
 
                status = 'locked'
202
 
            else:
203
 
                status = 'unlocked'
204
 
            outfile.write('    repository: %s\n' % status)
205
 
 
206
 
 
207
 
def _show_missing_revisions_branch(branch, outfile):
208
 
    """Show missing master revisions in branch."""
209
 
    # Try with inaccessible branch ?
210
 
    master = branch.get_master_branch()
211
 
    if master:
212
 
        local_extra, remote_extra = find_unmerged(branch, master)
213
 
        if remote_extra:
214
 
            outfile.write('\n')
215
 
            outfile.write(('Branch is out of date: missing %d '
216
 
                'revision%s.\n') % (len(remote_extra),
217
 
                plural(len(remote_extra))))
218
 
 
219
 
 
220
 
def _show_missing_revisions_working(working, outfile):
221
 
    """Show missing revisions in working tree."""
222
 
    branch = working.branch
223
 
    basis = working.basis_tree()
224
 
    work_inv = working.inventory
225
 
    branch_revno, branch_last_revision = branch.last_revision_info()
226
 
    try:
227
 
        tree_last_id = working.get_parent_ids()[0]
228
 
    except IndexError:
229
 
        tree_last_id = None
230
 
 
231
 
    if branch_revno and tree_last_id != branch_last_revision:
232
 
        tree_last_revno = branch.revision_id_to_revno(tree_last_id)
233
 
        missing_count = branch_revno - tree_last_revno
234
 
        outfile.write('\n')
235
 
        outfile.write(('Working tree is out of date: missing %d '
236
 
            'revision%s.\n') % (missing_count, plural(missing_count)))
237
 
 
238
 
 
239
 
def _show_working_stats(working, outfile):
240
 
    """Show statistics about a working tree."""
241
 
    basis = working.basis_tree()
242
 
    work_inv = working.inventory
243
 
    delta = working.changes_from(basis, want_unchanged=True)
244
 
 
245
 
    outfile.write('\n')
246
 
    outfile.write('In the working tree:\n')
247
 
    outfile.write('  %8s unchanged\n' % len(delta.unchanged))
248
 
    outfile.write('  %8d modified\n' % len(delta.modified))
249
 
    outfile.write('  %8d added\n' % len(delta.added))
250
 
    outfile.write('  %8d removed\n' % len(delta.removed))
251
 
    outfile.write('  %8d renamed\n' % len(delta.renamed))
 
20
 
 
21
from bzrlib.osutils import format_date
 
22
 
 
23
 
 
24
def _countiter(it):
 
25
    # surely there's a builtin for this?
 
26
    i = 0
 
27
    for j in it:
 
28
        i += 1
 
29
    return i        
 
30
 
 
31
 
 
32
 
 
33
def show_info(b):
 
34
    import diff
 
35
    
 
36
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
 
37
 
 
38
    def plural(n, base='', pl=None):
 
39
        if n == 1:
 
40
            return base
 
41
        elif pl != None:
 
42
            return pl
 
43
        else:
 
44
            return 's'
 
45
 
 
46
    count_version_dirs = 0
 
47
 
 
48
    basis = b.basis_tree()
 
49
    working = b.working_tree()
 
50
    work_inv = working.inventory
 
51
    delta = diff.compare_trees(basis, working, want_unchanged=True)
 
52
    
 
53
    print
 
54
    print 'in the working tree:'
 
55
    print '  %8s unchanged' % len(delta.unchanged)
 
56
    print '  %8d modified' % len(delta.modified)
 
57
    print '  %8d added' % len(delta.added)
 
58
    print '  %8d removed' % len(delta.removed)
 
59
    print '  %8d renamed' % len(delta.renamed)
252
60
 
253
61
    ignore_cnt = unknown_cnt = 0
254
62
    for path in working.extras():
256
64
            ignore_cnt += 1
257
65
        else:
258
66
            unknown_cnt += 1
259
 
    outfile.write('  %8d unknown\n' % unknown_cnt)
260
 
    outfile.write('  %8d ignored\n' % ignore_cnt)
 
67
 
 
68
    print '  %8d unknown' % unknown_cnt
 
69
    print '  %8d ignored' % ignore_cnt
261
70
 
262
71
    dir_cnt = 0
263
72
    for file_id in work_inv:
264
 
        if (work_inv.get_file_kind(file_id) == 'directory' and
265
 
            not work_inv.is_root(file_id)):
 
73
        if work_inv.get_file_kind(file_id) == 'directory':
266
74
            dir_cnt += 1
267
 
    outfile.write('  %8d versioned %s\n' % (dir_cnt,
268
 
        plural(dir_cnt, 'subdirectory', 'subdirectories')))
269
 
 
270
 
 
271
 
def _show_branch_stats(branch, verbose, outfile):
272
 
    """Show statistics about a branch."""
273
 
    revno, head = branch.last_revision_info()
274
 
    outfile.write('\n')
275
 
    outfile.write('Branch history:\n')
276
 
    outfile.write('  %8d revision%s\n' % (revno, plural(revno)))
277
 
    stats = branch.repository.gather_stats(head, committers=verbose)
278
 
    if verbose:
279
 
        committers = stats['committers']
280
 
        outfile.write('  %8d committer%s\n' % (committers,
281
 
            plural(committers)))
282
 
    if revno:
283
 
        timestamp, timezone = stats['firstrev']
284
 
        age = int((time.time() - timestamp) / 3600 / 24)
285
 
        outfile.write('  %8d day%s old\n' % (age, plural(age)))
286
 
        outfile.write('   first revision: %s\n' %
287
 
            osutils.format_date(timestamp, timezone))
288
 
        timestamp, timezone = stats['latestrev']
289
 
        outfile.write('  latest revision: %s\n' %
290
 
            osutils.format_date(timestamp, timezone))
291
 
    return stats
292
 
 
293
 
 
294
 
def _show_repository_info(repository, outfile):
295
 
    """Show settings of a repository."""
296
 
    if repository.make_working_trees():
297
 
        outfile.write('\n')
298
 
        outfile.write('Create working tree for new branches inside '
299
 
            'the repository.\n')
300
 
 
301
 
 
302
 
def _show_repository_stats(repository, stats, outfile):
303
 
    """Show statistics about a repository."""
304
 
    f = StringIO()
305
 
    if 'revisions' in stats:
306
 
        revisions = stats['revisions']
307
 
        f.write('  %8d revision%s\n' % (revisions, plural(revisions)))
308
 
    if 'size' in stats:
309
 
        f.write('  %8d KiB\n' % (stats['size']/1024))
310
 
    for hook in hooks['repository']:
311
 
        hook(repository, stats, f)
312
 
    if f.getvalue() != "":
313
 
        outfile.write('\n')
314
 
        outfile.write('Repository:\n')
315
 
        outfile.write(f.getvalue())
316
 
 
317
 
 
318
 
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
319
 
    """Output to stdout the 'info' for a_bzrdir."""
320
 
    if outfile is None:
321
 
        outfile = sys.stdout
322
 
    try:
323
 
        tree = a_bzrdir.open_workingtree(
324
 
            recommend_upgrade=False)
325
 
    except (NoWorkingTree, NotLocalUrl):
326
 
        tree = None
327
 
        try:
328
 
            branch = a_bzrdir.open_branch()
329
 
        except NotBranchError:
330
 
            branch = None
331
 
            try:
332
 
                repository = a_bzrdir.open_repository()
333
 
            except NoRepositoryPresent:
334
 
                # Return silently; cmd_info already returned NotBranchError
335
 
                # if no bzrdir could be opened.
336
 
                return
337
 
            else:
338
 
                lockable = repository
339
 
        else:
340
 
            repository = branch.repository
341
 
            lockable = branch
342
 
    else:
343
 
        branch = tree.branch
344
 
        repository = branch.repository
345
 
        lockable = tree
346
 
 
347
 
    lockable.lock_read()
348
 
    try:
349
 
        show_component_info(a_bzrdir, repository, branch, tree, verbose,
350
 
                            outfile)
351
 
    finally:
352
 
        lockable.unlock()
353
 
 
354
 
 
355
 
def show_component_info(control, repository, branch=None, working=None,
356
 
    verbose=1, outfile=None):
357
 
    """Write info about all bzrdir components to stdout"""
358
 
    if outfile is None:
359
 
        outfile = sys.stdout
360
 
    if verbose is False:
361
 
        verbose = 1
362
 
    if verbose is True:
363
 
        verbose = 2
364
 
    layout = describe_layout(repository, branch, working)
365
 
    format = describe_format(control, repository, branch, working)
366
 
    outfile.write("%s (format: %s)\n" % (layout, format))
367
 
    _show_location_info(gather_location_info(repository, branch, working),
368
 
                        outfile)
369
 
    if branch is not None:
370
 
        _show_related_info(branch, outfile)
371
 
    if verbose == 0:
372
 
        return
373
 
    _show_format_info(control, repository, branch, working, outfile)
374
 
    _show_locking_info(repository, branch, working, outfile)
375
 
    if branch is not None:
376
 
        _show_missing_revisions_branch(branch, outfile)
377
 
    if working is not None:
378
 
        _show_missing_revisions_working(working, outfile)
379
 
        _show_working_stats(working, outfile)
380
 
    elif branch is not None:
381
 
        _show_missing_revisions_branch(branch, outfile)
382
 
    if branch is not None:
383
 
        show_committers = verbose >= 2
384
 
        stats = _show_branch_stats(branch, show_committers, outfile)
385
 
    else:
386
 
        stats = repository.gather_stats()
387
 
    if branch is None and working is None:
388
 
        _show_repository_info(repository, outfile)
389
 
    _show_repository_stats(repository, stats, outfile)
390
 
 
391
 
 
392
 
def describe_layout(repository=None, branch=None, tree=None):
393
 
    """Convert a control directory layout into a user-understandable term
394
 
 
395
 
    Common outputs include "Standalone tree", "Repository branch" and
396
 
    "Checkout".  Uncommon outputs include "Unshared repository with trees"
397
 
    and "Empty control directory"
398
 
    """
399
 
    if repository is None:
400
 
        return 'Empty control directory'
401
 
    if branch is None and tree is None:
402
 
        if repository.is_shared():
403
 
            phrase = 'Shared repository'
404
 
        else:
405
 
            phrase = 'Unshared repository'
406
 
        if repository.make_working_trees():
407
 
            phrase += ' with trees'
408
 
        return phrase
409
 
    else:
410
 
        if repository.is_shared():
411
 
            independence = "Repository "
412
 
        else:
413
 
            independence = "Standalone "
414
 
        if tree is not None:
415
 
            phrase = "tree"
416
 
        else:
417
 
            phrase = "branch"
418
 
        if branch is None and tree is not None:
419
 
            phrase = "branchless tree"
420
 
        else:
421
 
            if (tree is not None and tree.user_url !=
422
 
                branch.user_url):
423
 
                independence = ''
424
 
                phrase = "Lightweight checkout"
425
 
            elif branch.get_bound_location() is not None:
426
 
                if independence == 'Standalone ':
427
 
                    independence = ''
428
 
                if tree is None:
429
 
                    phrase = "Bound branch"
430
 
                else:
431
 
                    phrase = "Checkout"
432
 
        if independence != "":
433
 
            phrase = phrase.lower()
434
 
        return "%s%s" % (independence, phrase)
435
 
 
436
 
 
437
 
def describe_format(control, repository, branch, tree):
438
 
    """Determine the format of an existing control directory
439
 
 
440
 
    Several candidates may be found.  If so, the names are returned as a
441
 
    single string, separated by ' or '.
442
 
 
443
 
    If no matching candidate is found, "unnamed" is returned.
444
 
    """
445
 
    candidates  = []
446
 
    if (branch is not None and tree is not None and
447
 
        branch.user_url != tree.user_url):
448
 
        branch = None
449
 
        repository = None
450
 
    non_aliases = set(bzrdir.format_registry.keys())
451
 
    non_aliases.difference_update(bzrdir.format_registry.aliases())
452
 
    for key in non_aliases:
453
 
        format = bzrdir.format_registry.make_bzrdir(key)
454
 
        if isinstance(format, bzrdir.BzrDirMetaFormat1):
455
 
            if (tree and format.workingtree_format !=
456
 
                tree._format):
457
 
                continue
458
 
            if (branch and format.get_branch_format() !=
459
 
                branch._format):
460
 
                continue
461
 
            if (repository and format.repository_format !=
462
 
                repository._format):
463
 
                continue
464
 
        if format.__class__ is not control._format.__class__:
465
 
            continue
466
 
        candidates.append(key)
467
 
    if len(candidates) == 0:
468
 
        return 'unnamed'
469
 
    candidates.sort()
470
 
    new_candidates = [c for c in candidates if not
471
 
        bzrdir.format_registry.get_info(c).hidden]
472
 
    if len(new_candidates) > 0:
473
 
        # If there are any non-hidden formats that match, only return those to
474
 
        # avoid listing hidden formats except when only a hidden format will
475
 
        # do.
476
 
        candidates = new_candidates
477
 
    return ' or '.join(candidates)
478
 
 
479
 
 
480
 
class InfoHooks(_mod_hooks.Hooks):
481
 
    """Hooks for the info command."""
482
 
 
483
 
    def __init__(self):
484
 
        super(InfoHooks, self).__init__()
485
 
        self.create_hook(_mod_hooks.HookPoint('repository',
486
 
            "Invoked when displaying the statistics for a repository. "
487
 
            "repository is called with a statistics dictionary as returned "
488
 
            "by the repository and a file-like object to write to.", (1, 15), 
489
 
            None))
490
 
 
491
 
 
492
 
hooks = InfoHooks()
 
75
    print '  %8d versioned %s' \
 
76
          % (dir_cnt,
 
77
             plural(dir_cnt, 'subdirectory', 'subdirectories'))
 
78
 
 
79
    print
 
80
    print 'branch history:'
 
81
    history = b.revision_history()
 
82
    revno = len(history)
 
83
    print '  %8d revision%s' % (revno, plural(revno))
 
84
    committers = {}
 
85
    for rev in history:
 
86
        committers[b.get_revision(rev).committer] = True
 
87
    print '  %8d committer%s' % (len(committers), plural(len(committers)))
 
88
    if revno > 0:
 
89
        firstrev = b.get_revision(history[0])
 
90
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
 
91
        print '  %8d day%s old' % (age, plural(age))
 
92
        print '   first revision: %s' % format_date(firstrev.timestamp,
 
93
                                                    firstrev.timezone)
 
94
 
 
95
        lastrev = b.get_revision(history[-1])
 
96
        print '  latest revision: %s' % format_date(lastrev.timestamp,
 
97
                                                    lastrev.timezone)
 
98
 
 
99
#     print
 
100
#     print 'text store:'
 
101
#     c, t = b.text_store.total_size()
 
102
#     print '  %8d file texts' % c
 
103
#     print '  %8d kB' % (t/1024)
 
104
 
 
105
    print
 
106
    print 'revision store:'
 
107
    c, t = b.revision_store.total_size()
 
108
    print '  %8d revisions' % c
 
109
    print '  %8d kB' % (t/1024)
 
110
 
 
111
 
 
112
#     print
 
113
#     print 'inventory store:'
 
114
#     c, t = b.inventory_store.total_size()
 
115
#     print '  %8d inventories' % c
 
116
#     print '  %8d kB' % (t/1024)
 
117