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
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
19
__all__ = ['show_bzrdir_info']
21
from cStringIO import StringIO
24
import bzrlib.diff as diff
33
25
from bzrlib.errors import (NoWorkingTree, NotBranchError,
34
26
NoRepositoryPresent, NotLocalUrl)
35
27
from bzrlib.missing import find_unmerged
28
from bzrlib.osutils import format_date
29
from bzrlib.symbol_versioning import *
33
# surely there's a builtin for this?
38
40
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):
49
def _show_location_info(repository=None, branch=None, working=None):
145
50
"""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):
52
if working and branch and working.bzrdir != branch.bzrdir:
53
# Lightweight checkout
54
print ' checkout root: %s' % (
55
working.bzrdir.root_transport.base)
56
print ' checkout of branch: %s' % (
57
branch.bzrdir.root_transport.base)
59
# Standalone or bound branch (normal checkout)
60
print ' branch root: %s' % (
61
branch.bzrdir.root_transport.base)
62
if branch.get_bound_location():
63
print ' bound to branch: %s' % branch.get_bound_location()
65
if repository and (not branch or repository.bzrdir != branch.bzrdir):
66
if repository.is_shared():
67
print ' shared repository: %s' % (
68
repository.bzrdir.root_transport.base)
70
print ' repository: %s' % (
71
repository.bzrdir.root_transport.base)
74
if branch.get_parent():
75
print ' parent branch: %s' % branch.get_parent()
76
if branch.get_push_location():
77
print ' push to branch: %s' % branch.get_push_location()
80
def _show_format_info(control=None, repository=None, branch=None, working=None):
186
81
"""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())
85
print ' control: %s' % control._format.get_format_description()
193
outfile.write(' working tree: %s\n' %
194
working._format.get_format_description())
87
print ' working tree: %s' % working._format.get_format_description()
196
outfile.write(' branch: %s\n' %
197
branch._format.get_format_description())
89
print ' branch: %s' % branch._format.get_format_description()
199
outfile.write(' repository: %s\n' %
200
repository._format.get_format_description())
203
def _show_locking_info(repository=None, branch=None, working=None,
205
"""Show locking status of working, branch and repository."""
206
if (repository and repository.get_physical_lock_status() or
207
(branch and branch.get_physical_lock_status()) or
208
(working and working.get_physical_lock_status())):
210
outfile.write('Lock status:\n')
212
if working.get_physical_lock_status():
216
outfile.write(' working tree: %s\n' % status)
218
if branch.get_physical_lock_status():
222
outfile.write(' branch: %s\n' % status)
224
if repository.get_physical_lock_status():
228
outfile.write(' repository: %s\n' % status)
231
def _show_missing_revisions_branch(branch, outfile):
91
print ' repository: %s' % repository._format.get_format_description()
94
def _show_missing_revisions_branch(branch):
232
95
"""Show missing master revisions in branch."""
233
96
# Try with inaccessible branch ?
234
97
master = branch.get_master_branch()
236
99
local_extra, remote_extra = find_unmerged(branch, master)
239
outfile.write(('Branch is out of date: missing %d '
240
'revision%s.\n') % (len(remote_extra),
241
plural(len(remote_extra))))
244
def _show_missing_revisions_working(working, outfile):
102
print 'Branch is out of date: missing %d revision%s.' % (
103
len(remote_extra), plural(len(remote_extra)))
106
def _show_missing_revisions_working(working):
245
107
"""Show missing revisions in working tree."""
246
108
branch = working.branch
247
109
basis = working.basis_tree()
249
branch_revno, branch_last_revision = branch.last_revision_info()
250
except errors.UnsupportedOperation:
253
tree_last_id = working.get_parent_ids()[0]
110
work_inv = working.inventory
111
delta = diff.compare_trees(basis, working, want_unchanged=True)
112
history = branch.revision_history()
113
tree_last_id = working.last_revision()
257
if branch_revno and tree_last_id != branch_last_revision:
115
if len(history) and tree_last_id != history[-1]:
258
116
tree_last_revno = branch.revision_id_to_revno(tree_last_id)
259
missing_count = branch_revno - tree_last_revno
261
outfile.write(('Working tree is out of date: missing %d '
262
'revision%s.\n') % (missing_count, plural(missing_count)))
265
def _show_working_stats(working, outfile):
117
missing_count = len(history) - tree_last_revno
119
print 'Working tree is out of date: missing %d revision%s.' % (
120
missing_count, plural(missing_count))
123
def _show_working_stats(working):
266
124
"""Show statistics about a working tree."""
267
125
basis = working.basis_tree()
268
delta = working.changes_from(basis, want_unchanged=True)
126
work_inv = working.inventory
127
delta = diff.compare_trees(basis, working, want_unchanged=True)
271
outfile.write('In the working tree:\n')
272
outfile.write(' %8s unchanged\n' % len(delta.unchanged))
273
outfile.write(' %8d modified\n' % len(delta.modified))
274
outfile.write(' %8d added\n' % len(delta.added))
275
outfile.write(' %8d removed\n' % len(delta.removed))
276
outfile.write(' %8d renamed\n' % len(delta.renamed))
130
print 'In the working tree:'
131
print ' %8s unchanged' % len(delta.unchanged)
132
print ' %8d modified' % len(delta.modified)
133
print ' %8d added' % len(delta.added)
134
print ' %8d removed' % len(delta.removed)
135
print ' %8d renamed' % len(delta.renamed)
278
137
ignore_cnt = unknown_cnt = 0
279
138
for path in working.extras():
284
outfile.write(' %8d unknown\n' % unknown_cnt)
285
outfile.write(' %8d ignored\n' % ignore_cnt)
143
print ' %8d unknown' % unknown_cnt
144
print ' %8d ignored' % ignore_cnt
288
root_id = working.get_root_id()
289
for path, entry in working.iter_entries_by_dir():
290
if entry.kind == 'directory' and entry.file_id != root_id:
147
for file_id in work_inv:
148
if work_inv.get_file_kind(file_id) == 'directory':
292
outfile.write(' %8d versioned %s\n' % (dir_cnt,
293
plural(dir_cnt, 'subdirectory', 'subdirectories')))
296
def _show_branch_stats(branch, verbose, outfile):
150
print ' %8d versioned %s' \
152
plural(dir_cnt, 'subdirectory', 'subdirectories'))
155
def _show_branch_stats(branch, verbose):
297
156
"""Show statistics about a branch."""
299
revno, head = branch.last_revision_info()
300
except errors.UnsupportedOperation:
303
outfile.write('Branch history:\n')
304
outfile.write(' %8d revision%s\n' % (revno, plural(revno)))
305
stats = branch.repository.gather_stats(head, committers=verbose)
157
repository = branch.repository
158
history = branch.revision_history()
161
print 'Branch history:'
163
print ' %8d revision%s' % (revno, plural(revno))
307
committers = stats['committers']
308
outfile.write(' %8d committer%s\n' % (committers,
311
timestamp, timezone = stats['firstrev']
312
age = int((time.time() - timestamp) / 3600 / 24)
313
outfile.write(' %8d day%s old\n' % (age, plural(age)))
314
outfile.write(' first revision: %s\n' %
315
osutils.format_date(timestamp, timezone))
316
timestamp, timezone = stats['latestrev']
317
outfile.write(' latest revision: %s\n' %
318
osutils.format_date(timestamp, timezone))
322
def _show_repository_info(repository, outfile):
167
committers[repository.get_revision(rev).committer] = True
168
print ' %8d committer%s' % (len(committers), plural(len(committers)))
170
firstrev = repository.get_revision(history[0])
171
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
172
print ' %8d day%s old' % (age, plural(age))
173
print ' first revision: %s' % format_date(firstrev.timestamp,
176
lastrev = repository.get_revision(history[-1])
177
print ' latest revision: %s' % format_date(lastrev.timestamp,
181
# print 'Text store:'
182
# c, t = branch.text_store.total_size()
183
# print ' %8d file texts' % c
184
# print ' %8d KiB' % (t/1024)
187
# print 'Inventory store:'
188
# c, t = branch.inventory_store.total_size()
189
# print ' %8d inventories' % c
190
# print ' %8d KiB' % (t/1024)
193
def _show_repository_info(repository):
323
194
"""Show settings of a repository."""
324
195
if repository.make_working_trees():
326
outfile.write('Create working tree for new branches inside '
330
def _show_repository_stats(repository, stats, outfile):
197
print 'Create working tree for new branches inside the repository.'
200
def _show_repository_stats(repository):
331
201
"""Show statistics about a repository."""
333
if 'revisions' in stats:
334
revisions = stats['revisions']
335
f.write(' %8d revision%s\n' % (revisions, plural(revisions)))
337
f.write(' %8d KiB\n' % (stats['size']/1024))
338
for hook in hooks['repository']:
339
hook(repository, stats, f)
340
if f.getvalue() != "":
342
outfile.write('Repository:\n')
343
outfile.write(f.getvalue())
346
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
202
if repository.bzrdir.root_transport.listable():
204
print 'Revision store:'
205
c, t = repository._revision_store.total_size(repository.get_transaction())
206
print ' %8d revision%s' % (c, plural(c))
207
print ' %8d KiB' % (t/1024)
210
@deprecated_function(zero_eight)
212
"""Please see show_bzrdir_info."""
213
return show_bzrdir_info(b.bzrdir)
216
def show_bzrdir_info(a_bzrdir, verbose=False):
347
217
"""Output to stdout the 'info' for a_bzrdir."""
351
tree = a_bzrdir.open_workingtree(
352
recommend_upgrade=False)
353
except (NoWorkingTree, NotLocalUrl, NotBranchError):
356
branch = a_bzrdir.open_branch(name="")
357
except NotBranchError:
360
repository = a_bzrdir.open_repository()
361
except NoRepositoryPresent:
365
lockable = repository
367
repository = branch.repository
371
repository = branch.repository
374
if lockable is not None:
377
show_component_info(a_bzrdir, repository, branch, tree, verbose,
380
if lockable is not None:
384
def show_component_info(control, repository, branch=None, working=None,
385
verbose=1, outfile=None):
386
"""Write info about all bzrdir components to stdout"""
393
layout = describe_layout(repository, branch, working, control)
394
format = describe_format(control, repository, branch, working)
395
outfile.write("%s (format: %s)\n" % (layout, format))
397
gather_location_info(control=control, repository=repository,
398
branch=branch, working=working),
400
if branch is not None:
401
_show_related_info(branch, outfile)
404
_show_format_info(control, repository, branch, working, outfile)
405
_show_locking_info(repository, branch, working, outfile)
406
_show_control_dir_info(control, outfile)
407
if branch is not None:
408
_show_missing_revisions_branch(branch, outfile)
409
if working is not None:
410
_show_missing_revisions_working(working, outfile)
411
_show_working_stats(working, outfile)
412
elif branch is not None:
413
_show_missing_revisions_branch(branch, outfile)
414
if branch is not None:
415
show_committers = verbose >= 2
416
stats = _show_branch_stats(branch, show_committers, outfile)
417
elif repository is not None:
418
stats = repository.gather_stats()
419
if branch is None and working is None and repository is not None:
420
_show_repository_info(repository, outfile)
421
if repository is not None:
422
_show_repository_stats(repository, stats, outfile)
425
def describe_layout(repository=None, branch=None, tree=None, control=None):
426
"""Convert a control directory layout into a user-understandable term
428
Common outputs include "Standalone tree", "Repository branch" and
429
"Checkout". Uncommon outputs include "Unshared repository with trees"
430
and "Empty control directory"
432
if branch is None and control is not None:
434
branch_reference = control.get_branch_reference()
435
except NotBranchError:
438
if branch_reference is not None:
439
return "Dangling branch reference"
440
if repository is None:
441
return 'Empty control directory'
442
if branch is None and tree is None:
443
if repository.is_shared():
444
phrase = 'Shared repository'
446
phrase = 'Unshared repository'
448
if repository.make_working_trees():
449
extra.append('trees')
450
if len(control.get_branches()) > 0:
451
extra.append('colocated branches')
453
phrase += ' with ' + " and ".join(extra)
456
if repository.is_shared():
457
independence = "Repository "
459
independence = "Standalone "
464
if branch is None and tree is not None:
465
phrase = "branchless tree"
467
if (tree is not None and tree.user_url !=
470
phrase = "Lightweight checkout"
471
elif branch.get_bound_location() is not None:
472
if independence == 'Standalone ':
475
phrase = "Bound branch"
478
if independence != "":
479
phrase = phrase.lower()
480
return "%s%s" % (independence, phrase)
483
def describe_format(control, repository, branch, tree):
484
"""Determine the format of an existing control directory
486
Several candidates may be found. If so, the names are returned as a
487
single string, separated by ' or '.
489
If no matching candidate is found, "unnamed" is returned.
492
if (branch is not None and tree is not None and
493
branch.user_url != tree.user_url):
496
non_aliases = set(controldir.format_registry.keys())
497
non_aliases.difference_update(controldir.format_registry.aliases())
498
for key in non_aliases:
499
format = controldir.format_registry.make_bzrdir(key)
500
if isinstance(format, bzrdir.BzrDirMetaFormat1):
501
if (tree and format.workingtree_format !=
504
if (branch and format.get_branch_format() !=
507
if (repository and format.repository_format !=
510
if format.__class__ is not control._format.__class__:
512
candidates.append(key)
513
if len(candidates) == 0:
516
new_candidates = [c for c in candidates if not
517
controldir.format_registry.get_info(c).hidden]
518
if len(new_candidates) > 0:
519
# If there are any non-hidden formats that match, only return those to
520
# avoid listing hidden formats except when only a hidden format will
522
candidates = new_candidates
523
return ' or '.join(candidates)
526
class InfoHooks(_mod_hooks.Hooks):
527
"""Hooks for the info command."""
530
super(InfoHooks, self).__init__("bzrlib.info", "hooks")
531
self.add_hook('repository',
532
"Invoked when displaying the statistics for a repository. "
533
"repository is called with a statistics dictionary as returned "
534
"by the repository and a file-like object to write to.", (1, 15))
219
working = a_bzrdir.open_workingtree()
222
show_tree_info(working, verbose)
226
except (NoWorkingTree, NotLocalUrl):
230
branch = a_bzrdir.open_branch()
233
show_branch_info(branch, verbose)
237
except NotBranchError:
241
repository = a_bzrdir.open_repository()
242
repository.lock_read()
244
show_repository_info(repository, verbose)
248
except NoRepositoryPresent:
251
# Return silently, cmd_info returns NotBranchError if no bzrdir
255
def show_tree_info(working, verbose):
256
"""Output to stdout the 'info' for working."""
257
branch = working.branch
258
repository = branch.repository
259
control = working.bzrdir
261
_show_location_info(repository, branch, working)
262
_show_format_info(control, repository, branch, working)
263
_show_missing_revisions_branch(branch)
264
_show_missing_revisions_working(working)
265
_show_working_stats(working)
266
_show_branch_stats(branch, verbose)
267
_show_repository_stats(repository)
270
def show_branch_info(branch, verbose):
271
"""Output to stdout the 'info' for branch."""
272
repository = branch.repository
273
control = branch.bzrdir
275
_show_location_info(repository, branch)
276
_show_format_info(control, repository, branch)
277
_show_missing_revisions_branch(branch)
278
_show_branch_stats(branch, verbose)
279
_show_repository_stats(repository)
282
def show_repository_info(repository, verbose):
283
"""Output to stdout the 'info' for branch."""
284
control = repository.bzrdir
286
_show_location_info(repository)
287
_show_format_info(control, repository)
288
_show_repository_info(repository)
289
_show_repository_stats(repository)
added
removed
bzrlib/info.py
