/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/info.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-07 15:27:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6958.
  • Revision ID: jelmer@jelmer.uk-20180507152739-fuv9z9r0yzi7ln3t
Specify source in .coveragerc.

Show diffs side-by-side

added added

removed removed

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