~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Martin Pool
  • Date: 2005-04-26 05:20:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050426052016-8445d0f4fec584d0
- move all TODO items into ./TODO

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
16
18
 
17
 
__all__ = ['show_bzrdir_info']
18
 
 
19
 
import os
 
19
from sets import Set
20
20
import time
21
 
import sys
22
 
 
23
 
from bzrlib import (
24
 
    bzrdir,
25
 
    diff,
26
 
    errors,
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.bzrdir.root_transport.base
82
 
    if branch is not None:
83
 
        branch_path = branch.bzrdir.root_transport.base
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.bzrdir.root_transport.base
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))
252
 
 
253
 
    ignore_cnt = unknown_cnt = 0
254
 
    for path in working.extras():
255
 
        if working.is_ignored(path):
256
 
            ignore_cnt += 1
257
 
        else:
258
 
            unknown_cnt += 1
259
 
    outfile.write('  %8d unknown\n' % unknown_cnt)
260
 
    outfile.write('  %8d ignored\n' % ignore_cnt)
261
 
 
262
 
    dir_cnt = 0
263
 
    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)):
266
 
            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(stats, outfile):
303
 
    """Show statistics about a repository."""
304
 
    if 'revisions' in stats or 'size' in stats:
305
 
        outfile.write('\n')
306
 
        outfile.write('Repository:\n')
307
 
    if 'revisions' in stats:
308
 
        revisions = stats['revisions']
309
 
        outfile.write('  %8d revision%s\n' % (revisions, plural(revisions)))
310
 
    if 'size' in stats:
311
 
        outfile.write('  %8d KiB\n' % (stats['size']/1024))
312
 
 
313
 
 
314
 
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
315
 
    """Output to stdout the 'info' for a_bzrdir."""
316
 
    if outfile is None:
317
 
        outfile = sys.stdout
318
 
    try:
319
 
        tree = a_bzrdir.open_workingtree(
320
 
            recommend_upgrade=False)
321
 
    except (NoWorkingTree, NotLocalUrl):
322
 
        tree = None
323
 
        try:
324
 
            branch = a_bzrdir.open_branch()
325
 
        except NotBranchError:
326
 
            branch = None
327
 
            try:
328
 
                repository = a_bzrdir.open_repository()
329
 
            except NoRepositoryPresent:
330
 
                # Return silently; cmd_info already returned NotBranchError
331
 
                # if no bzrdir could be opened.
332
 
                return
333
 
            else:
334
 
                lockable = repository
335
 
        else:
336
 
            repository = branch.repository
337
 
            lockable = branch
338
 
    else:
339
 
        branch = tree.branch
340
 
        repository = branch.repository
341
 
        lockable = tree
342
 
 
343
 
    lockable.lock_read()
344
 
    try:
345
 
        show_component_info(a_bzrdir, repository, branch, tree, verbose,
346
 
                            outfile)
347
 
    finally:
348
 
        lockable.unlock()
349
 
 
350
 
 
351
 
def show_component_info(control, repository, branch=None, working=None,
352
 
    verbose=1, outfile=None):
353
 
    """Write info about all bzrdir components to stdout"""
354
 
    if outfile is None:
355
 
        outfile = sys.stdout
356
 
    if verbose is False:
357
 
        verbose = 1
358
 
    if verbose is True:
359
 
        verbose = 2
360
 
    layout = describe_layout(repository, branch, working)
361
 
    format = describe_format(control, repository, branch, working)
362
 
    outfile.write("%s (format: %s)\n" % (layout, format))
363
 
    _show_location_info(gather_location_info(repository, branch, working),
364
 
                        outfile)
365
 
    if branch is not None:
366
 
        _show_related_info(branch, outfile)
367
 
    if verbose == 0:
368
 
        return
369
 
    _show_format_info(control, repository, branch, working, outfile)
370
 
    _show_locking_info(repository, branch, working, outfile)
371
 
    if branch is not None:
372
 
        _show_missing_revisions_branch(branch, outfile)
373
 
    if working is not None:
374
 
        _show_missing_revisions_working(working, outfile)
375
 
        _show_working_stats(working, outfile)
376
 
    elif branch is not None:
377
 
        _show_missing_revisions_branch(branch, outfile)
378
 
    if branch is not None:
379
 
        stats = _show_branch_stats(branch, verbose==2, outfile)
380
 
    else:
381
 
        stats = repository.gather_stats()
382
 
    if branch is None and working is None:
383
 
        _show_repository_info(repository, outfile)
384
 
    _show_repository_stats(stats, outfile)
385
 
 
386
 
 
387
 
def describe_layout(repository=None, branch=None, tree=None):
388
 
    """Convert a control directory layout into a user-understandable term
389
 
 
390
 
    Common outputs include "Standalone tree", "Repository branch" and
391
 
    "Checkout".  Uncommon outputs include "Unshared repository with trees"
392
 
    and "Empty control directory"
393
 
    """
394
 
    if repository is None:
395
 
        return 'Empty control directory'
396
 
    if branch is None and tree is None:
397
 
        if repository.is_shared():
398
 
            phrase = 'Shared repository'
399
 
        else:
400
 
            phrase = 'Unshared repository'
401
 
        if repository.make_working_trees():
402
 
            phrase += ' with trees'
403
 
        return phrase
404
 
    else:
405
 
        if repository.is_shared():
406
 
            independence = "Repository "
407
 
        else:
408
 
            independence = "Standalone "
409
 
        if tree is not None:
410
 
            phrase = "tree"
411
 
        else:
412
 
            phrase = "branch"
413
 
        if branch is None and tree is not None:
414
 
            phrase = "branchless tree"
415
 
        else:
416
 
            if (tree is not None and tree.bzrdir.root_transport.base !=
417
 
                branch.bzrdir.root_transport.base):
418
 
                independence = ''
419
 
                phrase = "Lightweight checkout"
420
 
            elif branch.get_bound_location() is not None:
421
 
                if independence == 'Standalone ':
422
 
                    independence = ''
423
 
                if tree is None:
424
 
                    phrase = "Bound branch"
425
 
                else:
426
 
                    phrase = "Checkout"
427
 
        if independence != "":
428
 
            phrase = phrase.lower()
429
 
        return "%s%s" % (independence, phrase)
430
 
 
431
 
 
432
 
def describe_format(control, repository, branch, tree):
433
 
    """Determine the format of an existing control directory
434
 
 
435
 
    Several candidates may be found.  If so, the names are returned as a
436
 
    single string, separated by ' or '.
437
 
 
438
 
    If no matching candidate is found, "unnamed" is returned.
439
 
    """
440
 
    candidates  = []
441
 
    if (branch is not None and tree is not None and
442
 
        branch.bzrdir.root_transport.base !=
443
 
        tree.bzrdir.root_transport.base):
444
 
        branch = None
445
 
        repository = None
446
 
    non_aliases = set(bzrdir.format_registry.keys())
447
 
    non_aliases.difference_update(bzrdir.format_registry.aliases())
448
 
    for key in non_aliases:
449
 
        format = bzrdir.format_registry.make_bzrdir(key)
450
 
        if isinstance(format, bzrdir.BzrDirMetaFormat1):
451
 
            if (tree and format.workingtree_format !=
452
 
                tree._format):
453
 
                continue
454
 
            if (branch and format.get_branch_format() !=
455
 
                branch._format):
456
 
                continue
457
 
            if (repository and format.repository_format !=
458
 
                repository._format):
459
 
                continue
460
 
        if format.__class__ is not control._format.__class__:
461
 
            continue
462
 
        candidates.append(key)
463
 
    if len(candidates) == 0:
464
 
        return 'unnamed'
465
 
    candidates.sort()
466
 
    new_candidates = [c for c in candidates if not
467
 
        bzrdir.format_registry.get_info(c).hidden]
468
 
    if len(new_candidates) > 0:
469
 
        # If there are any non-hidden formats that match, only return those to
470
 
        # avoid listing hidden formats except when only a hidden format will
471
 
        # do.
472
 
        candidates = new_candidates
473
 
    return ' or '.join(candidates)
 
21
 
 
22
import bzrlib
 
23
from osutils import format_date
 
24
 
 
25
def show_info(b):
 
26
    # TODO: Maybe show space used by working tree, versioned files,
 
27
    # unknown files, text store.
 
28
    
 
29
    print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
 
30
 
 
31
    def plural(n, base='', pl=None):
 
32
        if n == 1:
 
33
            return base
 
34
        elif pl != None:
 
35
            return pl
 
36
        else:
 
37
            return 's'
 
38
 
 
39
    count_version_dirs = 0
 
40
 
 
41
    count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
 
42
    for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
 
43
        fs = st_tup[0]
 
44
        count_status[fs] += 1
 
45
        if fs not in ['I', '?'] and st_tup[4] == 'directory':
 
46
            count_version_dirs += 1
 
47
 
 
48
    print
 
49
    print 'in the working tree:'
 
50
    for name, fs in (('unchanged', '.'),
 
51
                     ('modified', 'M'), ('added', 'A'), ('removed', 'D'),
 
52
                     ('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
 
53
                     ):
 
54
        print '  %8d %s' % (count_status[fs], name)
 
55
    print '  %8d versioned subdirector%s' % (count_version_dirs,
 
56
                                             plural(count_version_dirs, 'y', 'ies'))
 
57
 
 
58
    print
 
59
    print 'branch history:'
 
60
    history = b.revision_history()
 
61
    revno = len(history)
 
62
    print '  %8d revision%s' % (revno, plural(revno))
 
63
    committers = Set()
 
64
    for rev in history:
 
65
        committers.add(b.get_revision(rev).committer)
 
66
    print '  %8d committer%s' % (len(committers), plural(len(committers)))
 
67
    if revno > 0:
 
68
        firstrev = b.get_revision(history[0])
 
69
        age = int((time.time() - firstrev.timestamp) / 3600 / 24)
 
70
        print '  %8d day%s old' % (age, plural(age))
 
71
        print '   first revision: %s' % format_date(firstrev.timestamp,
 
72
                                                    firstrev.timezone)
 
73
 
 
74
        lastrev = b.get_revision(history[-1])
 
75
        print '  latest revision: %s' % format_date(lastrev.timestamp,
 
76
                                                    lastrev.timezone)
 
77
 
 
78
    print
 
79
    print 'text store:'
 
80
    c, t = b.text_store.total_size()
 
81
    print '  %8d file texts' % c
 
82
    print '  %8d kB' % (t/1024)
 
83
 
 
84
    print
 
85
    print 'revision store:'
 
86
    c, t = b.revision_store.total_size()
 
87
    print '  %8d revisions' % c
 
88
    print '  %8d kB' % (t/1024)
 
89
 
 
90
 
 
91
    print
 
92
    print 'inventory store:'
 
93
    c, t = b.inventory_store.total_size()
 
94
    print '  %8d inventories' % c
 
95
    print '  %8d kB' % (t/1024)
 
96