1
# Copyright (C) 2005, 2006 by Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
__all__ = ['show_bzrdir_info']
19
from cStringIO import StringIO
22
import bzrlib.diff as diff
23
30
from bzrlib.errors import (NoWorkingTree, NotBranchError,
24
31
NoRepositoryPresent, NotLocalUrl)
25
32
from bzrlib.missing import find_unmerged
26
import bzrlib.osutils as osutils
27
from bzrlib.symbol_versioning import (deprecated_function,
31
35
def plural(n, base='', pl=None):
40
def _repo_relpath(repo_path, path):
41
"""Return path with common prefix of repository path removed.
43
If path is not part of the repository, the original path is returned.
44
If path is equal to the repository, the current directory marker '.' is
47
path = osutils.normalizepath(path)
48
repo_path = osutils.normalizepath(repo_path)
51
if osutils.is_inside(repo_path, path):
52
return osutils.relpath(repo_path, path)
56
def _show_location_info(repository, branch=None, working=None):
57
"""Show known locations for working, branch and repository."""
58
repository_path = repository.bzrdir.root_transport.base
60
if working and branch:
61
working_path = working.bzrdir.root_transport.base
62
branch_path = branch.bzrdir.root_transport.base
44
class LocationList(object):
46
def __init__(self, base_path):
48
self.base_path = base_path
50
def add_url(self, label, url):
51
"""Add a URL to the list, converting it to a path if possible"""
55
path = urlutils.local_path_from_url(url)
56
except errors.InvalidURL:
57
self.locs.append((label, url))
59
self.add_path(label, path)
61
def add_path(self, label, path):
62
"""Add a path, converting it to a relative path if possible"""
64
path = osutils.relpath(self.base_path, path)
65
except errors.PathNotChild:
71
path = path.rstrip('/')
72
self.locs.append((label, path))
75
max_len = max(len(l) for l, u in self.locs)
76
return [" %*s: %s\n" % (max_len, l, u) for l, u in self.locs ]
79
def gather_location_info(repository, branch=None, working=None):
81
repository_path = repository.user_url
82
if branch is not None:
83
branch_path = branch.user_url
84
master_path = branch.get_bound_location()
85
if master_path is None:
86
master_path = branch_path
91
working_path = working.user_url
63
92
if working_path != branch_path:
64
# lightweight checkout
65
print ' light checkout root: %s' % working_path
93
locs['light checkout root'] = working_path
94
if master_path != branch_path:
66
95
if repository.is_shared():
67
# lightweight checkout of branch in shared repository
68
print ' shared repository: %s' % repository_path
69
print ' repository branch: %s' % (
70
_repo_relpath(repository_path, branch_path))
96
locs['repository checkout root'] = branch_path
72
# lightweight checkout of standalone branch
73
print ' checkout of branch: %s' % branch_path
98
locs['checkout root'] = branch_path
99
if working_path != master_path:
100
locs['checkout of branch'] = master_path
74
101
elif repository.is_shared():
75
# branch with tree inside shared repository
76
print ' shared repository: %s' % repository_path
77
print ' repository checkout: %s' % (
78
_repo_relpath(repository_path, branch_path))
79
elif branch.get_bound_location():
81
print ' checkout root: %s' % working_path
82
print ' checkout of branch: %s' % branch.get_bound_location()
102
locs['repository branch'] = branch_path
103
elif branch_path is not None:
85
print ' branch root: %s' % working_path
87
branch_path = branch.bzrdir.root_transport.base
105
locs['branch root'] = branch_path
88
108
if repository.is_shared():
89
# branch is part of shared repository
90
print ' shared repository: %s' % repository_path
91
print ' repository branch: %s' % (
92
_repo_relpath(repository_path, branch_path))
109
# lightweight checkout of branch in shared repository
110
if branch_path is not None:
111
locs['repository branch'] = branch_path
112
elif branch_path is not None:
114
locs['branch root'] = branch_path
115
if master_path != branch_path:
116
locs['bound to branch'] = master_path
95
print ' branch root: %s' % branch_path
98
assert repository.is_shared()
99
print ' shared repository: %s' % repository_path
102
def _show_related_info(branch):
118
locs['repository'] = repository_path
119
if repository.is_shared():
120
# lightweight checkout of branch in shared repository
121
locs['shared repository'] = repository_path
122
order = ['light checkout root', 'repository checkout root',
123
'checkout root', 'checkout of branch', 'shared repository',
124
'repository', 'repository branch', 'branch root',
126
return [(n, locs[n]) for n in order if n in locs]
129
def _show_location_info(locs, outfile):
130
"""Show known locations for working, branch and repository."""
131
outfile.write('Location:\n')
132
path_list = LocationList(osutils.getcwd())
133
for name, loc in locs:
134
path_list.add_url(name, loc)
135
outfile.writelines(path_list.get_lines())
138
def _gather_related_branches(branch):
139
locs = LocationList(osutils.getcwd())
140
locs.add_url('public branch', branch.get_public_branch())
141
locs.add_url('push branch', branch.get_push_location())
142
locs.add_url('parent branch', branch.get_parent())
143
locs.add_url('submit branch', branch.get_submit_branch())
145
locs.add_url('stacked on', branch.get_stacked_on_url())
146
except (errors.UnstackableBranchFormat, errors.UnstackableRepositoryFormat,
152
def _show_related_info(branch, outfile):
103
153
"""Show parent and push location of branch."""
104
if branch.get_parent() or branch.get_push_location():
106
print 'Related branches:'
107
if branch.get_parent():
108
if branch.get_push_location():
109
print ' parent branch: %s' % branch.get_parent()
111
print ' parent branch: %s' % branch.get_parent()
112
if branch.get_push_location():
113
print ' publish to branch: %s' % branch.get_push_location()
116
def _show_format_info(control=None, repository=None, branch=None, working=None):
154
locs = _gather_related_branches(branch)
155
if len(locs.locs) > 0:
157
outfile.write('Related branches:\n')
158
outfile.writelines(locs.get_lines())
161
def _show_format_info(control=None, repository=None, branch=None,
162
working=None, outfile=None):
117
163
"""Show known formats for control, working, branch and repository."""
165
outfile.write('Format:\n')
121
print ' control: %s' % control._format.get_format_description()
167
outfile.write(' control: %s\n' %
168
control._format.get_format_description())
123
print ' working tree: %s' % working._format.get_format_description()
170
outfile.write(' working tree: %s\n' %
171
working._format.get_format_description())
125
print ' branch: %s' % branch._format.get_format_description()
173
outfile.write(' branch: %s\n' %
174
branch._format.get_format_description())
127
print ' repository: %s' % repository._format.get_format_description()
130
def _show_locking_info(repository, branch=None, working=None):
176
outfile.write(' repository: %s\n' %
177
repository._format.get_format_description())
180
def _show_locking_info(repository, branch=None, working=None, outfile=None):
131
181
"""Show locking status of working, branch and repository."""
132
182
if (repository.get_physical_lock_status() or
133
183
(branch and branch.get_physical_lock_status()) or
134
184
(working and working.get_physical_lock_status())):
186
outfile.write('Lock status:\n')
138
188
if working.get_physical_lock_status():
139
189
status = 'locked'
141
191
status = 'unlocked'
142
print ' working tree: %s' % status
192
outfile.write(' working tree: %s\n' % status)
144
194
if branch.get_physical_lock_status():
145
195
status = 'locked'
147
197
status = 'unlocked'
148
print ' branch: %s' % status
198
outfile.write(' branch: %s\n' % status)
150
200
if repository.get_physical_lock_status():
151
201
status = 'locked'
153
203
status = 'unlocked'
154
print ' repository: %s' % status
157
def _show_missing_revisions_branch(branch):
204
outfile.write(' repository: %s\n' % status)
207
def _show_missing_revisions_branch(branch, outfile):
158
208
"""Show missing master revisions in branch."""
159
209
# Try with inaccessible branch ?
160
210
master = branch.get_master_branch()
162
212
local_extra, remote_extra = find_unmerged(branch, master)
165
print 'Branch is out of date: missing %d revision%s.' % (
166
len(remote_extra), plural(len(remote_extra)))
169
def _show_missing_revisions_working(working):
215
outfile.write(('Branch is out of date: missing %d '
216
'revision%s.\n') % (len(remote_extra),
217
plural(len(remote_extra))))
220
def _show_missing_revisions_working(working, outfile):
170
221
"""Show missing revisions in working tree."""
171
222
branch = working.branch
172
223
basis = working.basis_tree()
173
work_inv = working.inventory
174
delta = diff.compare_trees(basis, working, want_unchanged=True)
175
history = branch.revision_history()
176
tree_last_id = working.last_revision()
224
branch_revno, branch_last_revision = branch.last_revision_info()
226
tree_last_id = working.get_parent_ids()[0]
178
if len(history) and tree_last_id != history[-1]:
230
if branch_revno and tree_last_id != branch_last_revision:
179
231
tree_last_revno = branch.revision_id_to_revno(tree_last_id)
180
missing_count = len(history) - tree_last_revno
182
print 'Working tree is out of date: missing %d revision%s.' % (
183
missing_count, plural(missing_count))
186
def _show_working_stats(working):
232
missing_count = branch_revno - tree_last_revno
234
outfile.write(('Working tree is out of date: missing %d '
235
'revision%s.\n') % (missing_count, plural(missing_count)))
238
def _show_working_stats(working, outfile):
187
239
"""Show statistics about a working tree."""
188
240
basis = working.basis_tree()
189
work_inv = working.inventory
190
delta = diff.compare_trees(basis, working, want_unchanged=True)
241
delta = working.changes_from(basis, want_unchanged=True)
193
print 'In the working tree:'
194
print ' %8s unchanged' % len(delta.unchanged)
195
print ' %8d modified' % len(delta.modified)
196
print ' %8d added' % len(delta.added)
197
print ' %8d removed' % len(delta.removed)
198
print ' %8d renamed' % len(delta.renamed)
244
outfile.write('In the working tree:\n')
245
outfile.write(' %8s unchanged\n' % len(delta.unchanged))
246
outfile.write(' %8d modified\n' % len(delta.modified))
247
outfile.write(' %8d added\n' % len(delta.added))
248
outfile.write(' %8d removed\n' % len(delta.removed))
249
outfile.write(' %8d renamed\n' % len(delta.renamed))
200
251
ignore_cnt = unknown_cnt = 0
201
252
for path in working.extras():
206
print ' %8d unknown' % unknown_cnt
207
print ' %8d ignored' % ignore_cnt
257
outfile.write(' %8d unknown\n' % unknown_cnt)
258
outfile.write(' %8d ignored\n' % ignore_cnt)
210
for file_id in work_inv:
211
if work_inv.get_file_kind(file_id) == 'directory':
261
root_id = working.get_root_id()
262
for path, entry in working.iter_entries_by_dir():
263
if entry.kind == 'directory' and entry.file_id != root_id:
213
print ' %8d versioned %s' \
215
plural(dir_cnt, 'subdirectory', 'subdirectories'))
218
def _show_branch_stats(branch, verbose):
265
outfile.write(' %8d versioned %s\n' % (dir_cnt,
266
plural(dir_cnt, 'subdirectory', 'subdirectories')))
269
def _show_branch_stats(branch, verbose, outfile):
219
270
"""Show statistics about a branch."""
220
repository = branch.repository
221
history = branch.revision_history()
224
print 'Branch history:'
226
print ' %8d revision%s' % (revno, plural(revno))
271
revno, head = branch.last_revision_info()
273
outfile.write('Branch history:\n')
274
outfile.write(' %8d revision%s\n' % (revno, plural(revno)))
275
stats = branch.repository.gather_stats(head, committers=verbose)
230
committers[repository.get_revision(rev).committer] = True
231
print ' %8d committer%s' % (len(committers), plural(len(committers)))
233
firstrev = repository.get_revision(history[0])
234
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
235
print ' %8d day%s old' % (age, plural(age))
236
print ' first revision: %s' % osutils.format_date(firstrev.timestamp,
239
lastrev = repository.get_revision(history[-1])
240
print ' latest revision: %s' % osutils.format_date(lastrev.timestamp,
244
# print 'Text store:'
245
# c, t = branch.text_store.total_size()
246
# print ' %8d file texts' % c
247
# print ' %8d KiB' % (t/1024)
250
# print 'Inventory store:'
251
# c, t = branch.inventory_store.total_size()
252
# print ' %8d inventories' % c
253
# print ' %8d KiB' % (t/1024)
256
def _show_repository_info(repository):
277
committers = stats['committers']
278
outfile.write(' %8d committer%s\n' % (committers,
281
timestamp, timezone = stats['firstrev']
282
age = int((time.time() - timestamp) / 3600 / 24)
283
outfile.write(' %8d day%s old\n' % (age, plural(age)))
284
outfile.write(' first revision: %s\n' %
285
osutils.format_date(timestamp, timezone))
286
timestamp, timezone = stats['latestrev']
287
outfile.write(' latest revision: %s\n' %
288
osutils.format_date(timestamp, timezone))
292
def _show_repository_info(repository, outfile):
257
293
"""Show settings of a repository."""
258
294
if repository.make_working_trees():
260
print 'Create working tree for new branches inside the repository.'
263
def _show_repository_stats(repository):
296
outfile.write('Create working tree for new branches inside '
300
def _show_repository_stats(repository, stats, outfile):
264
301
"""Show statistics about a repository."""
265
if repository.bzrdir.root_transport.listable():
267
print 'Revision store:'
268
c, t = repository._revision_store.total_size(repository.get_transaction())
269
print ' %8d revision%s' % (c, plural(c))
270
print ' %8d KiB' % (t/1024)
273
@deprecated_function(zero_eight)
275
"""Please see show_bzrdir_info."""
276
return show_bzrdir_info(b.bzrdir)
279
def show_bzrdir_info(a_bzrdir, verbose=False):
303
if 'revisions' in stats:
304
revisions = stats['revisions']
305
f.write(' %8d revision%s\n' % (revisions, plural(revisions)))
307
f.write(' %8d KiB\n' % (stats['size']/1024))
308
for hook in hooks['repository']:
309
hook(repository, stats, f)
310
if f.getvalue() != "":
312
outfile.write('Repository:\n')
313
outfile.write(f.getvalue())
316
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
280
317
"""Output to stdout the 'info' for a_bzrdir."""
282
working = a_bzrdir.open_workingtree()
285
show_tree_info(working, verbose)
321
tree = a_bzrdir.open_workingtree(
322
recommend_upgrade=False)
289
323
except (NoWorkingTree, NotLocalUrl):
293
branch = a_bzrdir.open_branch()
296
show_branch_info(branch, verbose)
300
except NotBranchError:
304
repository = a_bzrdir.open_repository()
305
repository.lock_read()
307
show_repository_info(repository, verbose)
311
except NoRepositoryPresent:
314
# Return silently, cmd_info already returned NotBranchError if no bzrdir
318
def show_tree_info(working, verbose):
319
"""Output to stdout the 'info' for working."""
320
branch = working.branch
321
repository = branch.repository
322
control = working.bzrdir
324
_show_location_info(repository, branch, working)
325
_show_related_info(branch)
326
_show_format_info(control, repository, branch, working)
327
_show_locking_info(repository, branch, working)
328
_show_missing_revisions_branch(branch)
329
_show_missing_revisions_working(working)
330
_show_working_stats(working)
331
_show_branch_stats(branch, verbose)
332
_show_repository_stats(repository)
335
def show_branch_info(branch, verbose):
336
"""Output to stdout the 'info' for branch."""
337
repository = branch.repository
338
control = branch.bzrdir
340
_show_location_info(repository, branch)
341
_show_related_info(branch)
342
_show_format_info(control, repository, branch)
343
_show_locking_info(repository, branch)
344
_show_missing_revisions_branch(branch)
345
_show_branch_stats(branch, verbose)
346
_show_repository_stats(repository)
349
def show_repository_info(repository, verbose):
350
"""Output to stdout the 'info' for repository."""
351
control = repository.bzrdir
353
_show_location_info(repository)
354
_show_format_info(control, repository)
355
_show_locking_info(repository)
356
_show_repository_info(repository)
357
_show_repository_stats(repository)
326
branch = a_bzrdir.open_branch()
327
except NotBranchError:
330
repository = a_bzrdir.open_repository()
331
except NoRepositoryPresent:
332
# Return silently; cmd_info already returned NotBranchError
333
# if no bzrdir could be opened.
336
lockable = repository
338
repository = branch.repository
342
repository = branch.repository
347
show_component_info(a_bzrdir, repository, branch, tree, verbose,
353
def show_component_info(control, repository, branch=None, working=None,
354
verbose=1, outfile=None):
355
"""Write info about all bzrdir components to stdout"""
362
layout = describe_layout(repository, branch, working)
363
format = describe_format(control, repository, branch, working)
364
outfile.write("%s (format: %s)\n" % (layout, format))
365
_show_location_info(gather_location_info(repository, branch, working),
367
if branch is not None:
368
_show_related_info(branch, outfile)
371
_show_format_info(control, repository, branch, working, outfile)
372
_show_locking_info(repository, branch, working, outfile)
373
if branch is not None:
374
_show_missing_revisions_branch(branch, outfile)
375
if working is not None:
376
_show_missing_revisions_working(working, outfile)
377
_show_working_stats(working, outfile)
378
elif branch is not None:
379
_show_missing_revisions_branch(branch, outfile)
380
if branch is not None:
381
show_committers = verbose >= 2
382
stats = _show_branch_stats(branch, show_committers, outfile)
384
stats = repository.gather_stats()
385
if branch is None and working is None:
386
_show_repository_info(repository, outfile)
387
_show_repository_stats(repository, stats, outfile)
390
def describe_layout(repository=None, branch=None, tree=None):
391
"""Convert a control directory layout into a user-understandable term
393
Common outputs include "Standalone tree", "Repository branch" and
394
"Checkout". Uncommon outputs include "Unshared repository with trees"
395
and "Empty control directory"
397
if repository is None:
398
return 'Empty control directory'
399
if branch is None and tree is None:
400
if repository.is_shared():
401
phrase = 'Shared repository'
403
phrase = 'Unshared repository'
404
if repository.make_working_trees():
405
phrase += ' with trees'
408
if repository.is_shared():
409
independence = "Repository "
411
independence = "Standalone "
416
if branch is None and tree is not None:
417
phrase = "branchless tree"
419
if (tree is not None and tree.user_url !=
422
phrase = "Lightweight checkout"
423
elif branch.get_bound_location() is not None:
424
if independence == 'Standalone ':
427
phrase = "Bound branch"
430
if independence != "":
431
phrase = phrase.lower()
432
return "%s%s" % (independence, phrase)
435
def describe_format(control, repository, branch, tree):
436
"""Determine the format of an existing control directory
438
Several candidates may be found. If so, the names are returned as a
439
single string, separated by ' or '.
441
If no matching candidate is found, "unnamed" is returned.
444
if (branch is not None and tree is not None and
445
branch.user_url != tree.user_url):
448
non_aliases = set(bzrdir.format_registry.keys())
449
non_aliases.difference_update(bzrdir.format_registry.aliases())
450
for key in non_aliases:
451
format = bzrdir.format_registry.make_bzrdir(key)
452
if isinstance(format, bzrdir.BzrDirMetaFormat1):
453
if (tree and format.workingtree_format !=
456
if (branch and format.get_branch_format() !=
459
if (repository and format.repository_format !=
462
if format.__class__ is not control._format.__class__:
464
candidates.append(key)
465
if len(candidates) == 0:
468
new_candidates = [c for c in candidates if not
469
bzrdir.format_registry.get_info(c).hidden]
470
if len(new_candidates) > 0:
471
# If there are any non-hidden formats that match, only return those to
472
# avoid listing hidden formats except when only a hidden format will
474
candidates = new_candidates
475
return ' or '.join(candidates)
478
class InfoHooks(_mod_hooks.Hooks):
479
"""Hooks for the info command."""
482
super(InfoHooks, self).__init__("bzrlib.info", "hooks")
483
self.add_hook('repository',
484
"Invoked when displaying the statistics for a repository. "
485
"repository is called with a statistics dictionary as returned "
486
"by the repository and a file-like object to write to.", (1, 15))
added
removed
bzrlib/info.py
