1
# Copyright (C) 2005-2010 Canonical Ltd
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.
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.
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
17
__all__ = ['show_bzrdir_info']
19
from cStringIO import StringIO
32
from bzrlib.errors import (NoWorkingTree, NotBranchError,
33
NoRepositoryPresent, NotLocalUrl)
34
from bzrlib.missing import find_unmerged
37
def plural(n, base='', pl=None):
46
class LocationList(object):
48
def __init__(self, base_path):
50
self.base_path = base_path
52
def add_url(self, label, url):
53
"""Add a URL to the list, converting it to a path if possible"""
57
path = urlutils.local_path_from_url(url)
58
except errors.InvalidURL:
59
self.locs.append((label, url))
61
self.add_path(label, path)
63
def add_path(self, label, path):
64
"""Add a path, converting it to a relative path if possible"""
66
path = osutils.relpath(self.base_path, path)
67
except errors.PathNotChild:
73
path = path.rstrip('/')
74
self.locs.append((label, path))
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 ]
81
def gather_location_info(repository, branch=None, working=None):
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
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
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:
107
locs['branch root'] = branch_path
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:
116
locs['branch root'] = branch_path
117
if master_path != branch_path:
118
locs['bound to branch'] = master_path
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',
128
return [(n, locs[n]) for n in order if n in locs]
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())
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())
147
locs.add_url('stacked on', branch.get_stacked_on_url())
148
except (errors.UnstackableBranchFormat, errors.UnstackableRepositoryFormat,
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:
159
outfile.write('Related branches:\n')
160
outfile.writelines(locs.get_lines())
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."""
167
outfile.write('Format:\n')
169
outfile.write(' control: %s\n' %
170
control._format.get_format_description())
172
outfile.write(' working tree: %s\n' %
173
working._format.get_format_description())
175
outfile.write(' branch: %s\n' %
176
branch._format.get_format_description())
178
outfile.write(' repository: %s\n' %
179
repository._format.get_format_description())
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())):
188
outfile.write('Lock status:\n')
190
if working.get_physical_lock_status():
194
outfile.write(' working tree: %s\n' % status)
196
if branch.get_physical_lock_status():
200
outfile.write(' branch: %s\n' % status)
202
if repository.get_physical_lock_status():
206
outfile.write(' repository: %s\n' % status)
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()
214
local_extra, remote_extra = find_unmerged(branch, master)
217
outfile.write(('Branch is out of date: missing %d '
218
'revision%s.\n') % (len(remote_extra),
219
plural(len(remote_extra))))
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()
229
tree_last_id = working.get_parent_ids()[0]
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
237
outfile.write(('Working tree is out of date: missing %d '
238
'revision%s.\n') % (missing_count, plural(missing_count)))
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)
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))
255
ignore_cnt = unknown_cnt = 0
256
for path in working.extras():
257
if working.is_ignored(path):
261
outfile.write(' %8d unknown\n' % unknown_cnt)
262
outfile.write(' %8d ignored\n' % ignore_cnt)
265
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)):
269
outfile.write(' %8d versioned %s\n' % (dir_cnt,
270
plural(dir_cnt, 'subdirectory', 'subdirectories')))
273
def _show_branch_stats(branch, verbose, outfile):
274
"""Show statistics about a branch."""
275
revno, head = branch.last_revision_info()
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)
281
committers = stats['committers']
282
outfile.write(' %8d committer%s\n' % (committers,
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))
296
def _show_repository_info(repository, outfile):
297
"""Show settings of a repository."""
298
if repository.make_working_trees():
300
outfile.write('Create working tree for new branches inside '
304
def _show_repository_stats(repository, stats, outfile):
305
"""Show statistics about a repository."""
307
if 'revisions' in stats:
308
revisions = stats['revisions']
309
f.write(' %8d revision%s\n' % (revisions, plural(revisions)))
311
f.write(' %8d KiB\n' % (stats['size']/1024))
312
for hook in hooks['repository']:
313
hook(repository, stats, f)
314
if f.getvalue() != "":
316
outfile.write('Repository:\n')
317
outfile.write(f.getvalue())
320
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
321
"""Output to stdout the 'info' for a_bzrdir."""
325
tree = a_bzrdir.open_workingtree(
326
recommend_upgrade=False)
327
except (NoWorkingTree, NotLocalUrl):
330
branch = a_bzrdir.open_branch()
331
except NotBranchError:
334
repository = a_bzrdir.open_repository()
335
except NoRepositoryPresent:
336
# Return silently; cmd_info already returned NotBranchError
337
# if no bzrdir could be opened.
340
lockable = repository
342
repository = branch.repository
346
repository = branch.repository
351
show_component_info(a_bzrdir, repository, branch, tree, verbose,
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"""
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),
371
if branch is not None:
372
_show_related_info(branch, outfile)
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)
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)
394
def describe_layout(repository=None, branch=None, tree=None):
395
"""Convert a control directory layout into a user-understandable term
397
Common outputs include "Standalone tree", "Repository branch" and
398
"Checkout". Uncommon outputs include "Unshared repository with trees"
399
and "Empty control directory"
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'
407
phrase = 'Unshared repository'
408
if repository.make_working_trees():
409
phrase += ' with trees'
412
if repository.is_shared():
413
independence = "Repository "
415
independence = "Standalone "
420
if branch is None and tree is not None:
421
phrase = "branchless tree"
423
if (tree is not None and tree.bzrdir.root_transport.base !=
424
branch.bzrdir.root_transport.base):
426
phrase = "Lightweight checkout"
427
elif branch.get_bound_location() is not None:
428
if independence == 'Standalone ':
431
phrase = "Bound branch"
434
if independence != "":
435
phrase = phrase.lower()
436
return "%s%s" % (independence, phrase)
439
def describe_format(control, repository, branch, tree):
440
"""Determine the format of an existing control directory
442
Several candidates may be found. If so, the names are returned as a
443
single string, separated by ' or '.
445
If no matching candidate is found, "unnamed" is returned.
448
if (branch is not None and tree is not None and
449
branch.bzrdir.root_transport.base !=
450
tree.bzrdir.root_transport.base):
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 !=
461
if (branch and format.get_branch_format() !=
464
if (repository and format.repository_format !=
467
if format.__class__ is not control._format.__class__:
469
candidates.append(key)
470
if len(candidates) == 0:
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
479
candidates = new_candidates
480
return ' or '.join(candidates)
483
class InfoHooks(_mod_hooks.Hooks):
484
"""Hooks for the info command."""
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),
added
removed
bzrlib/info.py
