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
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
19
__all__ = ['show_bzrdir_info']
24
import bzrlib.diff as diff
30
25
from bzrlib.errors import (NoWorkingTree, NotBranchError,
31
26
NoRepositoryPresent, NotLocalUrl)
32
27
from bzrlib.missing import find_unmerged
28
import bzrlib.osutils as osutils
29
from bzrlib.symbol_versioning import *
35
32
def plural(n, base='', pl=None):
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):
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."""
81
59
repository_path = repository.bzrdir.root_transport.base
82
if branch is not None:
83
branch_path = branch.bzrdir.root_transport.base
84
master_path = branch.get_bound_location()
85
if master_path is None:
86
master_path = branch_path
61
if working and branch:
91
62
working_path = working.bzrdir.root_transport.base
63
branch_path = branch.bzrdir.root_transport.base
92
64
if working_path != branch_path:
93
locs['light checkout root'] = working_path
94
if master_path != branch_path:
65
# lightweight checkout
66
print ' light checkout root: %s' % working_path
95
67
if repository.is_shared():
96
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))
98
locs['checkout root'] = branch_path
99
if working_path != master_path:
100
locs['checkout of branch'] = master_path
73
# lightweight checkout of standalone branch
74
print ' checkout of branch: %s' % branch_path
101
75
elif repository.is_shared():
102
locs['repository branch'] = branch_path
103
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()
105
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
108
if repository.is_shared():
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
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):
99
assert repository.is_shared()
100
print ' shared repository: %s' % repository_path
103
def _show_related_info(branch):
153
104
"""Show parent and push location of branch."""
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):
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):
163
118
"""Show known formats for control, working, branch and repository."""
165
outfile.write('Format:\n')
167
outfile.write(' control: %s\n' %
168
control._format.get_format_description())
122
print ' control: %s' % control._format.get_format_description()
170
outfile.write(' working tree: %s\n' %
171
working._format.get_format_description())
124
print ' working tree: %s' % working._format.get_format_description()
173
outfile.write(' branch: %s\n' %
174
branch._format.get_format_description())
126
print ' branch: %s' % branch._format.get_format_description()
176
outfile.write(' repository: %s\n' %
177
repository._format.get_format_description())
180
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):
181
132
"""Show locking status of working, branch and repository."""
182
133
if (repository.get_physical_lock_status() or
183
134
(branch and branch.get_physical_lock_status()) or
184
135
(working and working.get_physical_lock_status())):
186
outfile.write('Lock status:\n')
188
139
if working.get_physical_lock_status():
189
140
status = 'locked'
191
142
status = 'unlocked'
192
outfile.write(' working tree: %s\n' % status)
143
print ' working tree: %s' % status
194
145
if branch.get_physical_lock_status():
195
146
status = 'locked'
197
148
status = 'unlocked'
198
outfile.write(' branch: %s\n' % status)
149
print ' branch: %s' % status
200
151
if repository.get_physical_lock_status():
201
152
status = 'locked'
203
154
status = 'unlocked'
204
outfile.write(' repository: %s\n' % status)
207
def _show_missing_revisions_branch(branch, outfile):
155
print ' repository: %s' % status
158
def _show_missing_revisions_branch(branch):
208
159
"""Show missing master revisions in branch."""
209
160
# Try with inaccessible branch ?
210
161
master = branch.get_master_branch()
212
163
local_extra, remote_extra = find_unmerged(branch, master)
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):
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):
221
171
"""Show missing revisions in working tree."""
222
172
branch = working.branch
223
173
basis = working.basis_tree()
224
174
work_inv = working.inventory
225
branch_revno, branch_last_revision = branch.last_revision_info()
227
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()
231
if branch_revno and tree_last_id != branch_last_revision:
179
if len(history) and tree_last_id != history[-1]:
232
180
tree_last_revno = branch.revision_id_to_revno(tree_last_id)
233
missing_count = branch_revno - tree_last_revno
235
outfile.write(('Working tree is out of date: missing %d '
236
'revision%s.\n') % (missing_count, plural(missing_count)))
239
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):
240
188
"""Show statistics about a working tree."""
241
189
basis = working.basis_tree()
242
190
work_inv = working.inventory
243
delta = working.changes_from(basis, want_unchanged=True)
191
delta = diff.compare_trees(basis, working, want_unchanged=True)
246
outfile.write('In the working tree:\n')
247
outfile.write(' %8s unchanged\n' % len(delta.unchanged))
248
outfile.write(' %8d modified\n' % len(delta.modified))
249
outfile.write(' %8d added\n' % len(delta.added))
250
outfile.write(' %8d removed\n' % len(delta.removed))
251
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)
253
201
ignore_cnt = unknown_cnt = 0
254
202
for path in working.extras():
259
outfile.write(' %8d unknown\n' % unknown_cnt)
260
outfile.write(' %8d ignored\n' % ignore_cnt)
207
print ' %8d unknown' % unknown_cnt
208
print ' %8d ignored' % ignore_cnt
263
211
for file_id in work_inv:
264
if (work_inv.get_file_kind(file_id) == 'directory' and
265
not work_inv.is_root(file_id)):
212
if work_inv.get_file_kind(file_id) == 'directory':
267
outfile.write(' %8d versioned %s\n' % (dir_cnt,
268
plural(dir_cnt, 'subdirectory', 'subdirectories')))
271
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):
272
220
"""Show statistics about a branch."""
273
revno, head = branch.last_revision_info()
275
outfile.write('Branch history:\n')
276
outfile.write(' %8d revision%s\n' % (revno, plural(revno)))
277
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))
279
committers = stats['committers']
280
outfile.write(' %8d committer%s\n' % (committers,
283
timestamp, timezone = stats['firstrev']
284
age = int((time.time() - timestamp) / 3600 / 24)
285
outfile.write(' %8d day%s old\n' % (age, plural(age)))
286
outfile.write(' first revision: %s\n' %
287
osutils.format_date(timestamp, timezone))
288
timestamp, timezone = stats['latestrev']
289
outfile.write(' latest revision: %s\n' %
290
osutils.format_date(timestamp, timezone))
294
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):
295
258
"""Show settings of a repository."""
296
259
if repository.make_working_trees():
298
outfile.write('Create working tree for new branches inside '
302
def _show_repository_stats(stats, outfile):
261
print 'Create working tree for new branches inside the repository.'
264
def _show_repository_stats(repository):
303
265
"""Show statistics about a repository."""
304
if 'revisions' in stats or 'size' in stats:
306
outfile.write('Repository:\n')
307
if 'revisions' in stats:
308
revisions = stats['revisions']
309
outfile.write(' %8d revision%s\n' % (revisions, plural(revisions)))
311
outfile.write(' %8d KiB\n' % (stats['size']/1024))
314
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):
315
281
"""Output to stdout the 'info' for a_bzrdir."""
319
tree = a_bzrdir.open_workingtree(
320
recommend_upgrade=False)
283
working = a_bzrdir.open_workingtree()
286
show_tree_info(working, verbose)
321
290
except (NoWorkingTree, NotLocalUrl):
324
branch = a_bzrdir.open_branch()
325
except NotBranchError:
328
repository = a_bzrdir.open_repository()
329
except NoRepositoryPresent:
330
# Return silently; cmd_info already returned NotBranchError
331
# if no bzrdir could be opened.
334
lockable = repository
336
repository = branch.repository
340
repository = branch.repository
345
show_component_info(a_bzrdir, repository, branch, tree, verbose,
351
def show_component_info(control, repository, branch=None, working=None,
352
verbose=1, outfile=None):
353
"""Write info about all bzrdir components to stdout"""
360
layout = describe_layout(repository, branch, working)
361
format = describe_format(control, repository, branch, working)
362
outfile.write("%s (format: %s)\n" % (layout, format))
363
_show_location_info(gather_location_info(repository, branch, working),
365
if branch is not None:
366
_show_related_info(branch, outfile)
369
_show_format_info(control, repository, branch, working, outfile)
370
_show_locking_info(repository, branch, working, outfile)
371
if branch is not None:
372
_show_missing_revisions_branch(branch, outfile)
373
if working is not None:
374
_show_missing_revisions_working(working, outfile)
375
_show_working_stats(working, outfile)
376
elif branch is not None:
377
_show_missing_revisions_branch(branch, outfile)
378
if branch is not None:
379
stats = _show_branch_stats(branch, verbose==2, outfile)
381
stats = repository.gather_stats()
382
if branch is None and working is None:
383
_show_repository_info(repository, outfile)
384
_show_repository_stats(stats, outfile)
387
def describe_layout(repository=None, branch=None, tree=None):
388
"""Convert a control directory layout into a user-understandable term
390
Common outputs include "Standalone tree", "Repository branch" and
391
"Checkout". Uncommon outputs include "Unshared repository with trees"
392
and "Empty control directory"
394
if repository is None:
395
return 'Empty control directory'
396
if branch is None and tree is None:
397
if repository.is_shared():
398
phrase = 'Shared repository'
400
phrase = 'Unshared repository'
401
if repository.make_working_trees():
402
phrase += ' with trees'
405
if repository.is_shared():
406
independence = "Repository "
408
independence = "Standalone "
413
if branch is None and tree is not None:
414
phrase = "branchless tree"
416
if (tree is not None and tree.bzrdir.root_transport.base !=
417
branch.bzrdir.root_transport.base):
419
phrase = "Lightweight checkout"
420
elif branch.get_bound_location() is not None:
421
if independence == 'Standalone ':
424
phrase = "Bound branch"
427
if independence != "":
428
phrase = phrase.lower()
429
return "%s%s" % (independence, phrase)
432
def describe_format(control, repository, branch, tree):
433
"""Determine the format of an existing control directory
435
Several candidates may be found. If so, the names are returned as a
436
single string, separated by ' or '.
438
If no matching candidate is found, "unnamed" is returned.
441
if (branch is not None and tree is not None and
442
branch.bzrdir.root_transport.base !=
443
tree.bzrdir.root_transport.base):
446
non_aliases = set(bzrdir.format_registry.keys())
447
non_aliases.difference_update(bzrdir.format_registry.aliases())
448
for key in non_aliases:
449
format = bzrdir.format_registry.make_bzrdir(key)
450
if isinstance(format, bzrdir.BzrDirMetaFormat1):
451
if (tree and format.workingtree_format !=
454
if (branch and format.get_branch_format() !=
457
if (repository and format.repository_format !=
460
if format.__class__ is not control._format.__class__:
462
candidates.append(key)
463
if len(candidates) == 0:
466
new_candidates = [c for c in candidates if not
467
bzrdir.format_registry.get_info(c).hidden]
468
if len(new_candidates) > 0:
469
# If there are any non-hidden formats that match, only return those to
470
# avoid listing hidden formats except when only a hidden format will
472
candidates = new_candidates
473
return ' or '.join(candidates)
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)