← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Patch Queue Manager
  • Date: 2014-04-09 13:36:25 UTC
  • mfrom: (6592.1.2 1303879-py27-issues)
  • Revision ID: pqm@pqm.ubuntu.com-20140409133625-s24spv3kha2w2860
(vila) Fix python-2.7.6 test failures. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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