1
# Copyright (C) 2005, 2006, 2007 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
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
19
__all__ = ['show_bzrdir_info']
19
from cStringIO import StringIO
24
import bzrlib.diff as diff
32
25
from bzrlib.errors import (NoWorkingTree, NotBranchError,
33
26
NoRepositoryPresent, NotLocalUrl)
34
27
from bzrlib.missing import find_unmerged
28
import bzrlib.osutils as osutils
29
from bzrlib.symbol_versioning import *
37
32
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):
41
def _repo_relpath(repo_path, path):
42
"""Return path with common prefix of repository path removed.
44
If path is not part of the repository, the original path is returned.
45
If path is equal to the repository, the current directory marker '.' is
48
path = osutils.normalizepath(path)
49
repo_path = osutils.normalizepath(repo_path)
52
if osutils.is_inside(repo_path, path):
53
return osutils.relpath(repo_path, path)
57
def _show_location_info(repository, branch=None, working=None):
58
"""Show known locations for working, branch and repository."""
83
59
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
61
if working and branch:
93
62
working_path = working.bzrdir.root_transport.base
63
branch_path = branch.bzrdir.root_transport.base
94
64
if working_path != branch_path:
95
locs['light checkout root'] = working_path
96
if master_path != branch_path:
65
# lightweight checkout
66
print ' light checkout root: %s' % working_path
97
67
if repository.is_shared():
98
locs['repository checkout root'] = branch_path
68
# lightweight checkout of branch in shared repository
69
print ' shared repository: %s' % repository_path
70
print ' repository branch: %s' % (
71
_repo_relpath(repository_path, branch_path))
100
locs['checkout root'] = branch_path
101
if working_path != master_path:
102
locs['checkout of branch'] = master_path
73
# lightweight checkout of standalone branch
74
print ' checkout of branch: %s' % branch_path
103
75
elif repository.is_shared():
104
locs['repository branch'] = branch_path
105
elif branch_path is not None:
76
# branch with tree inside shared repository
77
print ' shared repository: %s' % repository_path
78
print ' repository checkout: %s' % (
79
_repo_relpath(repository_path, branch_path))
80
elif branch.get_bound_location():
82
print ' checkout root: %s' % working_path
83
print ' checkout of branch: %s' % branch.get_bound_location()
107
locs['branch root'] = branch_path
86
print ' branch root: %s' % working_path
88
branch_path = branch.bzrdir.root_transport.base
89
if repository.is_shared():
90
# branch is part of shared repository
91
print ' shared repository: %s' % repository_path
92
print ' repository branch: %s' % (
93
_repo_relpath(repository_path, branch_path))
96
print ' branch root: %s' % 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):
99
assert repository.is_shared()
100
print ' shared repository: %s' % repository_path
103
def _show_related_info(branch):
155
104
"""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):
105
if branch.get_parent() or branch.get_push_location():
107
print 'Related branches:'
108
if branch.get_parent():
109
if branch.get_push_location():
110
print ' parent branch: %s' % branch.get_parent()
112
print ' parent branch: %s' % branch.get_parent()
113
if branch.get_push_location():
114
print ' publish to branch: %s' % branch.get_push_location()
117
def _show_format_info(control=None, repository=None, branch=None, working=None):
165
118
"""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())
122
print ' control: %s' % control._format.get_format_description()
172
outfile.write(' working tree: %s\n' %
173
working._format.get_format_description())
124
print ' working tree: %s' % working._format.get_format_description()
175
outfile.write(' branch: %s\n' %
176
branch._format.get_format_description())
126
print ' branch: %s' % 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):
128
print ' repository: %s' % repository._format.get_format_description()
131
def _show_locking_info(repository, branch=None, working=None):
183
132
"""Show locking status of working, branch and repository."""
184
133
if (repository.get_physical_lock_status() or
185
134
(branch and branch.get_physical_lock_status()) or
186
135
(working and working.get_physical_lock_status())):
188
outfile.write('Lock status:\n')
190
139
if working.get_physical_lock_status():
191
140
status = 'locked'
193
142
status = 'unlocked'
194
outfile.write(' working tree: %s\n' % status)
143
print ' working tree: %s' % status
196
145
if branch.get_physical_lock_status():
197
146
status = 'locked'
199
148
status = 'unlocked'
200
outfile.write(' branch: %s\n' % status)
149
print ' branch: %s' % status
202
151
if repository.get_physical_lock_status():
203
152
status = 'locked'
205
154
status = 'unlocked'
206
outfile.write(' repository: %s\n' % status)
209
def _show_missing_revisions_branch(branch, outfile):
155
print ' repository: %s' % status
158
def _show_missing_revisions_branch(branch):
210
159
"""Show missing master revisions in branch."""
211
160
# Try with inaccessible branch ?
212
161
master = branch.get_master_branch()
214
163
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):
166
print 'Branch is out of date: missing %d revision%s.' % (
167
len(remote_extra), plural(len(remote_extra)))
170
def _show_missing_revisions_working(working):
223
171
"""Show missing revisions in working tree."""
224
172
branch = working.branch
225
173
basis = working.basis_tree()
226
174
work_inv = working.inventory
227
branch_revno, branch_last_revision = branch.last_revision_info()
229
tree_last_id = working.get_parent_ids()[0]
175
delta = diff.compare_trees(basis, working, want_unchanged=True)
176
history = branch.revision_history()
177
tree_last_id = working.last_revision()
233
if branch_revno and tree_last_id != branch_last_revision:
179
if len(history) and tree_last_id != history[-1]:
234
180
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):
181
missing_count = len(history) - tree_last_revno
183
print 'Working tree is out of date: missing %d revision%s.' % (
184
missing_count, plural(missing_count))
187
def _show_working_stats(working):
242
188
"""Show statistics about a working tree."""
243
189
basis = working.basis_tree()
244
190
work_inv = working.inventory
245
delta = working.changes_from(basis, want_unchanged=True)
191
delta = diff.compare_trees(basis, working, 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))
194
print 'In the working tree:'
195
print ' %8s unchanged' % len(delta.unchanged)
196
print ' %8d modified' % len(delta.modified)
197
print ' %8d added' % len(delta.added)
198
print ' %8d removed' % len(delta.removed)
199
print ' %8d renamed' % len(delta.renamed)
255
201
ignore_cnt = unknown_cnt = 0
256
202
for path in working.extras():
261
outfile.write(' %8d unknown\n' % unknown_cnt)
262
outfile.write(' %8d ignored\n' % ignore_cnt)
207
print ' %8d unknown' % unknown_cnt
208
print ' %8d ignored' % ignore_cnt
265
211
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)):
212
if work_inv.get_file_kind(file_id) == 'directory':
269
outfile.write(' %8d versioned %s\n' % (dir_cnt,
270
plural(dir_cnt, 'subdirectory', 'subdirectories')))
273
def _show_branch_stats(branch, verbose, outfile):
214
print ' %8d versioned %s' \
216
plural(dir_cnt, 'subdirectory', 'subdirectories'))
219
def _show_branch_stats(branch, verbose):
274
220
"""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)
221
repository = branch.repository
222
history = branch.revision_history()
225
print 'Branch history:'
227
print ' %8d revision%s' % (revno, plural(revno))
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):
231
committers[repository.get_revision(rev).committer] = True
232
print ' %8d committer%s' % (len(committers), plural(len(committers)))
234
firstrev = repository.get_revision(history[0])
235
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
236
print ' %8d day%s old' % (age, plural(age))
237
print ' first revision: %s' % osutils.format_date(firstrev.timestamp,
240
lastrev = repository.get_revision(history[-1])
241
print ' latest revision: %s' % osutils.format_date(lastrev.timestamp,
245
# print 'Text store:'
246
# c, t = branch.text_store.total_size()
247
# print ' %8d file texts' % c
248
# print ' %8d KiB' % (t/1024)
251
# print 'Inventory store:'
252
# c, t = branch.inventory_store.total_size()
253
# print ' %8d inventories' % c
254
# print ' %8d KiB' % (t/1024)
257
def _show_repository_info(repository):
297
258
"""Show settings of a repository."""
298
259
if repository.make_working_trees():
300
outfile.write('Create working tree for new branches inside '
304
def _show_repository_stats(repository, stats, outfile):
261
print 'Create working tree for new branches inside the repository.'
264
def _show_repository_stats(repository):
305
265
"""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):
266
if repository.bzrdir.root_transport.listable():
268
print 'Revision store:'
269
c, t = repository._revision_store.total_size(repository.get_transaction())
270
print ' %8d revision%s' % (c, plural(c))
271
print ' %8d KiB' % (t/1024)
274
@deprecated_function(zero_eight)
276
"""Please see show_bzrdir_info."""
277
return show_bzrdir_info(b.bzrdir)
280
def show_bzrdir_info(a_bzrdir, verbose=False):
321
281
"""Output to stdout the 'info' for a_bzrdir."""
325
tree = a_bzrdir.open_workingtree(
326
recommend_upgrade=False)
283
working = a_bzrdir.open_workingtree()
286
show_tree_info(working, verbose)
327
290
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),
294
branch = a_bzrdir.open_branch()
297
show_branch_info(branch, verbose)
301
except NotBranchError:
305
repository = a_bzrdir.open_repository()
306
repository.lock_read()
308
show_repository_info(repository, verbose)
312
except NoRepositoryPresent:
315
# Return silently, cmd_info already returned NotBranchError if no bzrdir
319
def show_tree_info(working, verbose):
320
"""Output to stdout the 'info' for working."""
321
branch = working.branch
322
repository = branch.repository
323
control = working.bzrdir
325
_show_location_info(repository, branch, working)
326
_show_related_info(branch)
327
_show_format_info(control, repository, branch, working)
328
_show_locking_info(repository, branch, working)
329
_show_missing_revisions_branch(branch)
330
_show_missing_revisions_working(working)
331
_show_working_stats(working)
332
_show_branch_stats(branch, verbose)
333
_show_repository_stats(repository)
336
def show_branch_info(branch, verbose):
337
"""Output to stdout the 'info' for branch."""
338
repository = branch.repository
339
control = branch.bzrdir
341
_show_location_info(repository, branch)
342
_show_related_info(branch)
343
_show_format_info(control, repository, branch)
344
_show_locking_info(repository, branch)
345
_show_missing_revisions_branch(branch)
346
_show_branch_stats(branch, verbose)
347
_show_repository_stats(repository)
350
def show_repository_info(repository, verbose):
351
"""Output to stdout the 'info' for repository."""
352
control = repository.bzrdir
354
_show_location_info(repository)
355
_show_format_info(control, repository)
356
_show_locking_info(repository)
357
_show_repository_info(repository)
358
_show_repository_stats(repository)
added
removed
bzrlib/info.py
