1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
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.
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.
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
17
from __future__ import absolute_import
19
__all__ = ['show_bzrdir_info']
21
from cStringIO import StringIO
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33
from bzrlib.errors import (NoWorkingTree, NotBranchError,
34
NoRepositoryPresent, NotLocalUrl)
35
from bzrlib.missing import find_unmerged
38
def plural(n, base='', pl=None):
47
class LocationList(object):
49
def __init__(self, base_path):
51
self.base_path = base_path
53
def add_url(self, label, url):
54
"""Add a URL to the list, converting it to a path if possible"""
58
path = urlutils.local_path_from_url(url)
59
except errors.InvalidURL:
60
self.locs.append((label, url))
62
self.add_path(label, path)
64
def add_path(self, label, path):
65
"""Add a path, converting it to a relative path if possible"""
67
path = osutils.relpath(self.base_path, path)
68
except errors.PathNotChild:
74
path = path.rstrip('/')
75
self.locs.append((label, path))
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 ]
82
def gather_location_info(repository=None, branch=None, working=None,
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
94
if control is not None and control.get_branch_reference():
95
locs['checkout of branch'] = control.get_branch_reference()
96
except NotBranchError:
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
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:
113
locs['branch root'] = branch_path
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:
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
128
# Really, at least a control directory should be
129
# passed in for this method to be useful.
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',
141
return [(n, locs[n]) for n in order if n in locs]
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())
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())
160
locs.add_url('stacked on', branch.get_stacked_on_url())
161
except (errors.UnstackableBranchFormat, errors.UnstackableRepositoryFormat,
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:
172
outfile.write('Related branches:\n')
173
outfile.writelines(locs.get_lines())
176
def _show_control_dir_info(control, outfile):
177
"""Show control dir information."""
178
if control._format.colocated_branches:
180
outfile.write('Control directory:\n')
181
outfile.write(' %d branches\n' % len(control.list_branches()))
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."""
188
outfile.write('Format:\n')
190
outfile.write(' control: %s\n' %
191
control._format.get_format_description())
193
outfile.write(' working tree: %s\n' %
194
working._format.get_format_description())
196
outfile.write(' branch: %s\n' %
197
branch._format.get_format_description())
199
outfile.write(' repository: %s\n' %
200
repository._format.get_format_description())
203
def _show_locking_info(repository, branch=None, working=None, outfile=None):
204
"""Show locking status of working, branch and repository."""
205
if (repository.get_physical_lock_status() or
206
(branch and branch.get_physical_lock_status()) or
207
(working and working.get_physical_lock_status())):
209
outfile.write('Lock status:\n')
211
if working.get_physical_lock_status():
215
outfile.write(' working tree: %s\n' % status)
217
if branch.get_physical_lock_status():
221
outfile.write(' branch: %s\n' % status)
223
if repository.get_physical_lock_status():
227
outfile.write(' repository: %s\n' % status)
230
def _show_missing_revisions_branch(branch, outfile):
231
"""Show missing master revisions in branch."""
232
# Try with inaccessible branch ?
233
master = branch.get_master_branch()
235
local_extra, remote_extra = find_unmerged(branch, master)
238
outfile.write(('Branch is out of date: missing %d '
239
'revision%s.\n') % (len(remote_extra),
240
plural(len(remote_extra))))
243
def _show_missing_revisions_working(working, outfile):
244
"""Show missing revisions in working tree."""
245
branch = working.branch
246
basis = working.basis_tree()
248
branch_revno, branch_last_revision = branch.last_revision_info()
249
except errors.UnsupportedOperation:
252
tree_last_id = working.get_parent_ids()[0]
256
if branch_revno and tree_last_id != branch_last_revision:
257
tree_last_revno = branch.revision_id_to_revno(tree_last_id)
258
missing_count = branch_revno - tree_last_revno
260
outfile.write(('Working tree is out of date: missing %d '
261
'revision%s.\n') % (missing_count, plural(missing_count)))
264
def _show_working_stats(working, outfile):
265
"""Show statistics about a working tree."""
266
basis = working.basis_tree()
267
delta = working.changes_from(basis, want_unchanged=True)
270
outfile.write('In the working tree:\n')
271
outfile.write(' %8s unchanged\n' % len(delta.unchanged))
272
outfile.write(' %8d modified\n' % len(delta.modified))
273
outfile.write(' %8d added\n' % len(delta.added))
274
outfile.write(' %8d removed\n' % len(delta.removed))
275
outfile.write(' %8d renamed\n' % len(delta.renamed))
21
from osutils import format_date
25
# surely there's a builtin for this?
36
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
38
def plural(n, base='', pl=None):
46
count_version_dirs = 0
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)
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)
277
61
ignore_cnt = unknown_cnt = 0
278
62
for path in working.extras():
283
outfile.write(' %8d unknown\n' % unknown_cnt)
284
outfile.write(' %8d ignored\n' % ignore_cnt)
68
print ' %8d unknown' % unknown_cnt
69
print ' %8d ignored' % ignore_cnt
287
root_id = working.get_root_id()
288
for path, entry in working.iter_entries_by_dir():
289
if entry.kind == 'directory' and entry.file_id != root_id:
72
for file_id in work_inv:
73
if work_inv.get_file_kind(file_id) == 'directory':
291
outfile.write(' %8d versioned %s\n' % (dir_cnt,
292
plural(dir_cnt, 'subdirectory', 'subdirectories')))
295
def _show_branch_stats(branch, verbose, outfile):
296
"""Show statistics about a branch."""
298
revno, head = branch.last_revision_info()
299
except errors.UnsupportedOperation:
302
outfile.write('Branch history:\n')
303
outfile.write(' %8d revision%s\n' % (revno, plural(revno)))
304
stats = branch.repository.gather_stats(head, committers=verbose)
306
committers = stats['committers']
307
outfile.write(' %8d committer%s\n' % (committers,
310
timestamp, timezone = stats['firstrev']
311
age = int((time.time() - timestamp) / 3600 / 24)
312
outfile.write(' %8d day%s old\n' % (age, plural(age)))
313
outfile.write(' first revision: %s\n' %
314
osutils.format_date(timestamp, timezone))
315
timestamp, timezone = stats['latestrev']
316
outfile.write(' latest revision: %s\n' %
317
osutils.format_date(timestamp, timezone))
321
def _show_repository_info(repository, outfile):
322
"""Show settings of a repository."""
323
if repository.make_working_trees():
325
outfile.write('Create working tree for new branches inside '
329
def _show_repository_stats(repository, stats, outfile):
330
"""Show statistics about a repository."""
332
if 'revisions' in stats:
333
revisions = stats['revisions']
334
f.write(' %8d revision%s\n' % (revisions, plural(revisions)))
336
f.write(' %8d KiB\n' % (stats['size']/1024))
337
for hook in hooks['repository']:
338
hook(repository, stats, f)
339
if f.getvalue() != "":
341
outfile.write('Repository:\n')
342
outfile.write(f.getvalue())
345
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
346
"""Output to stdout the 'info' for a_bzrdir."""
350
tree = a_bzrdir.open_workingtree(
351
recommend_upgrade=False)
352
except (NoWorkingTree, NotLocalUrl, NotBranchError):
355
branch = a_bzrdir.open_branch()
356
except NotBranchError:
359
repository = a_bzrdir.open_repository()
360
except NoRepositoryPresent:
364
lockable = repository
366
repository = branch.repository
370
repository = branch.repository
373
if lockable is not None:
376
show_component_info(a_bzrdir, repository, branch, tree, verbose,
379
if lockable is not None:
383
def show_component_info(control, repository, branch=None, working=None,
384
verbose=1, outfile=None):
385
"""Write info about all bzrdir components to stdout"""
392
layout = describe_layout(repository, branch, working, control)
393
format = describe_format(control, repository, branch, working)
394
outfile.write("%s (format: %s)\n" % (layout, format))
396
gather_location_info(control=control, repository=repository,
397
branch=branch, working=working),
399
if branch is not None:
400
_show_related_info(branch, outfile)
403
_show_format_info(control, repository, branch, working, outfile)
404
_show_locking_info(repository, branch, working, outfile)
405
_show_control_dir_info(control, outfile)
406
if branch is not None:
407
_show_missing_revisions_branch(branch, outfile)
408
if working is not None:
409
_show_missing_revisions_working(working, outfile)
410
_show_working_stats(working, outfile)
411
elif branch is not None:
412
_show_missing_revisions_branch(branch, outfile)
413
if branch is not None:
414
show_committers = verbose >= 2
415
stats = _show_branch_stats(branch, show_committers, outfile)
417
stats = repository.gather_stats()
418
if branch is None and working is None:
419
_show_repository_info(repository, outfile)
420
_show_repository_stats(repository, stats, outfile)
423
def describe_layout(repository=None, branch=None, tree=None, control=None):
424
"""Convert a control directory layout into a user-understandable term
426
Common outputs include "Standalone tree", "Repository branch" and
427
"Checkout". Uncommon outputs include "Unshared repository with trees"
428
and "Empty control directory"
430
if branch is None and control is not None:
432
branch_reference = control.get_branch_reference()
433
except NotBranchError:
436
if branch_reference is not None:
437
return "Dangling branch reference"
438
if repository is None:
439
return 'Empty control directory'
440
if branch is None and tree is None:
441
if repository.is_shared():
442
phrase = 'Shared repository'
444
phrase = 'Unshared repository'
445
if repository.make_working_trees():
446
phrase += ' with trees'
449
if repository.is_shared():
450
independence = "Repository "
452
independence = "Standalone "
457
if branch is None and tree is not None:
458
phrase = "branchless tree"
460
if (tree is not None and tree.user_url !=
463
phrase = "Lightweight checkout"
464
elif branch.get_bound_location() is not None:
465
if independence == 'Standalone ':
468
phrase = "Bound branch"
471
if independence != "":
472
phrase = phrase.lower()
473
return "%s%s" % (independence, phrase)
476
def describe_format(control, repository, branch, tree):
477
"""Determine the format of an existing control directory
479
Several candidates may be found. If so, the names are returned as a
480
single string, separated by ' or '.
482
If no matching candidate is found, "unnamed" is returned.
485
if (branch is not None and tree is not None and
486
branch.user_url != tree.user_url):
489
non_aliases = set(controldir.format_registry.keys())
490
non_aliases.difference_update(controldir.format_registry.aliases())
491
for key in non_aliases:
492
format = controldir.format_registry.make_bzrdir(key)
493
if isinstance(format, bzrdir.BzrDirMetaFormat1):
494
if (tree and format.workingtree_format !=
497
if (branch and format.get_branch_format() !=
500
if (repository and format.repository_format !=
503
if format.__class__ is not control._format.__class__:
505
candidates.append(key)
506
if len(candidates) == 0:
509
new_candidates = [c for c in candidates if not
510
controldir.format_registry.get_info(c).hidden]
511
if len(new_candidates) > 0:
512
# If there are any non-hidden formats that match, only return those to
513
# avoid listing hidden formats except when only a hidden format will
515
candidates = new_candidates
516
return ' or '.join(candidates)
519
class InfoHooks(_mod_hooks.Hooks):
520
"""Hooks for the info command."""
523
super(InfoHooks, self).__init__("bzrlib.info", "hooks")
524
self.add_hook('repository',
525
"Invoked when displaying the statistics for a repository. "
526
"repository is called with a statistics dictionary as returned "
527
"by the repository and a file-like object to write to.", (1, 15))
75
print ' %8d versioned %s' \
77
plural(dir_cnt, 'subdirectory', 'subdirectories'))
80
print 'branch history:'
81
history = b.revision_history()
83
print ' %8d revision%s' % (revno, plural(revno))
86
committers[b.get_revision(rev).committer] = True
87
print ' %8d committer%s' % (len(committers), plural(len(committers)))
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,
95
lastrev = b.get_revision(history[-1])
96
print ' latest revision: %s' % format_date(lastrev.timestamp,
101
c, t = b.text_store.total_size()
102
print ' %8d file texts' % c
103
print ' %8d kB' % (t/1024)
106
print 'revision store:'
107
c, t = b.revision_store.total_size()
108
print ' %8d revisions' % c
109
print ' %8d kB' % (t/1024)
113
print 'inventory store:'
114
c, t = b.inventory_store.total_size()
115
print ' %8d inventories' % c
116
print ' %8d kB' % (t/1024)
added
removed
bzrlib/info.py
