~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

- rules for using destructors

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