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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
__all__ = ['show_bzrdir_info']
19
from io import StringIO
24
branch as _mod_branch,
34
from .errors import (NoWorkingTree, NotBranchError,
35
NoRepositoryPresent, NotLocalUrl)
36
from .missing import find_unmerged
39
def plural(n, base=u'', pl=None):
27
from bzrlib.errors import (NoWorkingTree, NotBranchError,
28
NoRepositoryPresent, NotLocalUrl)
29
from bzrlib.missing import find_unmerged
30
from bzrlib.symbol_versioning import (deprecated_function,
34
def plural(n, base='', pl=None):
42
37
elif pl is not None:
48
class LocationList(object):
50
def __init__(self, base_path):
52
self.base_path = base_path
54
def add_url(self, label, url):
55
"""Add a URL to the list, converting it to a path if possible"""
59
path = urlutils.local_path_from_url(url)
60
except urlutils.InvalidURL:
61
self.locs.append((label, url))
63
self.add_path(label, path)
65
def add_path(self, label, path):
66
"""Add a path, converting it to a relative path if possible"""
68
path = osutils.relpath(self.base_path, path)
69
except errors.PathNotChild:
75
path = path.rstrip('/')
76
self.locs.append((label, path))
79
max_len = max(len(l) for l, u in self.locs)
80
return [" %*s: %s\n" % (max_len, l, u) for l, u in self.locs]
83
def gather_location_info(repository=None, branch=None, working=None,
86
if branch is not None:
87
branch_path = branch.user_url
88
master_path = branch.get_bound_location()
89
if master_path is None:
90
master_path = branch_path
95
if control is not None and control.get_branch_reference():
96
locs['checkout of branch'] = control.get_branch_reference()
97
except NotBranchError:
100
working_path = working.user_url
43
def _repo_rel_url(repo_url, inner_url):
44
"""Return path with common prefix of repository path removed.
46
If path is not part of the repository, the original path is returned.
47
If path is equal to the repository, the current directory marker '.' is
49
Otherwise, a relative path is returned, with trailing '/' stripped.
51
inner_url = urlutils.normalize_url(inner_url)
52
repo_url = urlutils.normalize_url(repo_url)
53
if inner_url == repo_url:
55
result = urlutils.relative_url(repo_url, inner_url)
56
if result != inner_url:
57
result = result.rstrip('/')
61
def _show_location_info(repository, branch=None, working=None):
62
"""Show known locations for working, branch and repository."""
63
repository_path = repository.bzrdir.root_transport.base
65
if working and branch:
66
working_path = working.bzrdir.root_transport.base
67
branch_path = branch.bzrdir.root_transport.base
101
68
if working_path != branch_path:
102
locs['light checkout root'] = working_path
103
if master_path != branch_path:
69
# lightweight checkout
70
print ' light checkout root: %s' % working_path
104
71
if repository.is_shared():
105
locs['repository checkout root'] = branch_path
107
locs['checkout root'] = branch_path
108
if working_path != master_path:
109
(master_path_base, params) = urlutils.split_segment_parameters(
111
if working_path == master_path_base:
112
locs['checkout of co-located branch'] = params['branch']
113
elif 'branch' in params:
114
locs['checkout of branch'] = "%s, branch %s" % (
115
master_path_base, params['branch'])
117
locs['checkout of branch'] = master_path
72
# lightweight checkout of branch in shared repository
73
print ' shared repository: %s' % repository_path
74
print ' repository branch: %s' % (
75
_repo_rel_url(repository_path, branch_path))
77
# lightweight checkout of standalone branch
78
print ' checkout of branch: %s' % branch_path
118
79
elif repository.is_shared():
119
locs['repository branch'] = branch_path
120
elif branch_path is not None:
80
# branch with tree inside shared repository
81
print ' shared repository: %s' % repository_path
82
print ' repository checkout: %s' % (
83
_repo_rel_url(repository_path, branch_path))
84
elif branch.get_bound_location():
86
print ' checkout root: %s' % working_path
87
print ' checkout of branch: %s' % branch.get_bound_location()
122
locs['branch root'] = branch_path
90
print ' branch root: %s' % working_path
92
branch_path = branch.bzrdir.root_transport.base
93
if repository.is_shared():
94
# branch is part of shared repository
95
print ' shared repository: %s' % repository_path
96
print ' repository branch: %s' % (
97
_repo_rel_url(repository_path, branch_path))
100
print ' branch root: %s' % branch_path
125
if repository is not None and repository.is_shared():
126
# lightweight checkout of branch in shared repository
127
if branch_path is not None:
128
locs['repository branch'] = branch_path
129
elif branch_path is not None:
131
locs['branch root'] = branch_path
132
elif repository is not None:
133
locs['repository'] = repository.user_url
134
elif control is not None:
135
locs['control directory'] = control.user_url
137
# Really, at least a control directory should be
138
# passed in for this method to be useful.
140
if master_path != branch_path:
141
locs['bound to branch'] = master_path
142
if repository is not None and repository.is_shared():
143
# lightweight checkout of branch in shared repository
144
locs['shared repository'] = repository.user_url
145
order = ['control directory', 'light checkout root',
146
'repository checkout root', 'checkout root',
147
'checkout of branch', 'checkout of co-located branch',
148
'shared repository', 'repository', 'repository branch',
149
'branch root', 'bound to branch']
150
return [(n, locs[n]) for n in order if n in locs]
153
def _show_location_info(locs, outfile):
154
"""Show known locations for working, branch and repository."""
155
outfile.write('Location:\n')
156
path_list = LocationList(osutils.getcwd())
157
for name, loc in locs:
158
path_list.add_url(name, loc)
159
outfile.writelines(path_list.get_lines())
162
def _gather_related_branches(branch):
163
locs = LocationList(osutils.getcwd())
164
locs.add_url('public branch', branch.get_public_branch())
165
locs.add_url('push branch', branch.get_push_location())
166
locs.add_url('parent branch', branch.get_parent())
167
locs.add_url('submit branch', branch.get_submit_branch())
169
locs.add_url('stacked on', branch.get_stacked_on_url())
170
except (_mod_branch.UnstackableBranchFormat, errors.UnstackableRepositoryFormat,
176
def _show_related_info(branch, outfile):
103
assert repository.is_shared()
104
print ' shared repository: %s' % repository_path
107
def _show_related_info(branch):
177
108
"""Show parent and push location of branch."""
178
locs = _gather_related_branches(branch)
179
if len(locs.locs) > 0:
181
outfile.write('Related branches:\n')
182
outfile.writelines(locs.get_lines())
185
def _show_control_dir_info(control, outfile):
186
"""Show control dir information."""
187
if control._format.colocated_branches:
189
outfile.write('Control directory:\n')
190
outfile.write(' %d branches\n' % len(control.list_branches()))
193
def _show_format_info(control=None, repository=None, branch=None,
194
working=None, outfile=None):
109
if branch.get_parent() or branch.get_push_location():
111
print 'Related branches:'
112
if branch.get_parent():
113
if branch.get_push_location():
114
print ' parent branch: %s' % branch.get_parent()
116
print ' parent branch: %s' % branch.get_parent()
117
if branch.get_push_location():
118
print ' publish to branch: %s' % branch.get_push_location()
121
def _show_format_info(control=None, repository=None, branch=None, working=None):
195
122
"""Show known formats for control, working, branch and repository."""
197
outfile.write('Format:\n')
199
outfile.write(' control: %s\n' %
200
control._format.get_format_description())
126
print ' control: %s' % control._format.get_format_description()
202
outfile.write(' working tree: %s\n' %
203
working._format.get_format_description())
128
print ' working tree: %s' % working._format.get_format_description()
205
outfile.write(' branch: %s\n' %
206
branch._format.get_format_description())
130
print ' branch: %s' % branch._format.get_format_description()
208
outfile.write(' repository: %s\n' %
209
repository._format.get_format_description())
212
def _show_locking_info(repository=None, branch=None, working=None,
132
print ' repository: %s' % repository._format.get_format_description()
135
def _show_locking_info(repository, branch=None, working=None):
214
136
"""Show locking status of working, branch and repository."""
215
if (repository and repository.get_physical_lock_status() or
137
if (repository.get_physical_lock_status() or
216
138
(branch and branch.get_physical_lock_status()) or
217
(working and working.get_physical_lock_status())):
219
outfile.write('Lock status:\n')
139
(working and working.get_physical_lock_status())):
221
143
if working.get_physical_lock_status():
222
144
status = 'locked'
224
146
status = 'unlocked'
225
outfile.write(' working tree: %s\n' % status)
147
print ' working tree: %s' % status
227
149
if branch.get_physical_lock_status():
228
150
status = 'locked'
230
152
status = 'unlocked'
231
outfile.write(' branch: %s\n' % status)
153
print ' branch: %s' % status
233
155
if repository.get_physical_lock_status():
234
156
status = 'locked'
236
158
status = 'unlocked'
237
outfile.write(' repository: %s\n' % status)
240
def _show_missing_revisions_branch(branch, outfile):
159
print ' repository: %s' % status
162
def _show_missing_revisions_branch(branch):
241
163
"""Show missing master revisions in branch."""
242
164
# Try with inaccessible branch ?
243
165
master = branch.get_master_branch()
245
167
local_extra, remote_extra = find_unmerged(branch, master)
248
outfile.write(('Branch is out of date: missing %d '
249
'revision%s.\n') % (len(remote_extra),
250
plural(len(remote_extra))))
253
def _show_missing_revisions_working(working, outfile):
170
print 'Branch is out of date: missing %d revision%s.' % (
171
len(remote_extra), plural(len(remote_extra)))
174
def _show_missing_revisions_working(working):
254
175
"""Show missing revisions in working tree."""
255
176
branch = working.branch
257
branch_revno, branch_last_revision = branch.last_revision_info()
258
except errors.UnsupportedOperation:
177
basis = working.basis_tree()
178
work_inv = working.inventory
179
branch_revno, branch_last_revision = branch.last_revision_info()
261
181
tree_last_id = working.get_parent_ids()[0]
262
182
except IndexError:
293
outfile.write(' %8d unknown\n' % unknown_cnt)
294
outfile.write(' %8d ignored\n' % ignore_cnt)
213
print ' %8d unknown' % unknown_cnt
214
print ' %8d ignored' % ignore_cnt
297
for path, entry in working.iter_entries_by_dir():
298
if entry.kind == 'directory' and path != '':
217
for file_id in work_inv:
218
if (work_inv.get_file_kind(file_id) == 'directory' and
219
not work_inv.is_root(file_id)):
300
outfile.write(' %8d versioned %s\n' % (dir_cnt,
301
plural(dir_cnt, 'subdirectory', 'subdirectories')))
304
def _show_branch_stats(branch, verbose, outfile):
221
print ' %8d versioned %s' \
223
plural(dir_cnt, 'subdirectory', 'subdirectories'))
226
def _show_branch_stats(branch, verbose):
305
227
"""Show statistics about a branch."""
307
revno, head = branch.last_revision_info()
308
except errors.UnsupportedOperation:
311
outfile.write('Branch history:\n')
312
outfile.write(' %8d revision%s\n' % (revno, plural(revno)))
228
revno, head = branch.last_revision_info()
230
print 'Branch history:'
231
print ' %8d revision%s' % (revno, plural(revno))
313
232
stats = branch.repository.gather_stats(head, committers=verbose)
315
234
committers = stats['committers']
316
outfile.write(' %8d committer%s\n' % (committers,
235
print ' %8d committer%s' % (committers, plural(committers))
319
237
timestamp, timezone = stats['firstrev']
320
238
age = int((time.time() - timestamp) / 3600 / 24)
321
outfile.write(' %8d day%s old\n' % (age, plural(age)))
322
outfile.write(' first revision: %s\n' %
323
osutils.format_date(timestamp, timezone))
239
print ' %8d day%s old' % (age, plural(age))
240
print ' first revision: %s' % osutils.format_date(timestamp,
324
242
timestamp, timezone = stats['latestrev']
325
outfile.write(' latest revision: %s\n' %
326
osutils.format_date(timestamp, timezone))
243
print ' latest revision: %s' % osutils.format_date(timestamp,
330
def _show_repository_info(repository, outfile):
248
def _show_repository_info(repository):
331
249
"""Show settings of a repository."""
332
250
if repository.make_working_trees():
334
outfile.write('Create working tree for new branches inside '
338
def _show_repository_stats(repository, stats, outfile):
252
print 'Create working tree for new branches inside the repository.'
255
def _show_repository_stats(stats):
339
256
"""Show statistics about a repository."""
257
if 'revisions' in stats or 'size' in stats:
341
260
if 'revisions' in stats:
342
261
revisions = stats['revisions']
343
f.write(' %8d revision%s\n' % (revisions, plural(revisions)))
262
print ' %8d revision%s' % (revisions, plural(revisions))
344
263
if 'size' in stats:
345
f.write(' %8d KiB\n' % (stats['size'] / 1024))
346
for hook in hooks['repository']:
347
hook(repository, stats, f)
348
if f.getvalue() != "":
350
outfile.write('Repository:\n')
351
outfile.write(f.getvalue())
354
def show_bzrdir_info(a_controldir, verbose=False, outfile=None):
355
"""Output to stdout the 'info' for a_controldir."""
264
print ' %8d KiB' % (stats['size']/1024)
267
@deprecated_function(zero_eight)
269
"""Please see show_bzrdir_info."""
270
return show_bzrdir_info(b.bzrdir)
273
def show_bzrdir_info(a_bzrdir, verbose=False):
274
"""Output to stdout the 'info' for a_bzrdir."""
359
tree = a_controldir.open_workingtree(
276
working = a_bzrdir.open_workingtree(
360
277
recommend_upgrade=False)
361
except (NoWorkingTree, NotLocalUrl, NotBranchError):
364
branch = a_controldir.open_branch(name="")
365
except NotBranchError:
368
repository = a_controldir.open_repository()
369
except NoRepositoryPresent:
373
lockable = repository
375
repository = branch.repository
379
repository = branch.repository
382
if lockable is not None:
385
show_component_info(a_controldir, repository, branch, tree, verbose,
388
if lockable is not None:
392
def show_component_info(control, repository, branch=None, working=None,
393
verbose=1, outfile=None):
394
"""Write info about all bzrdir components to stdout"""
401
layout = describe_layout(repository, branch, working, control)
402
format = describe_format(control, repository, branch, working)
403
outfile.write("%s (format: %s)\n" % (layout, format))
405
gather_location_info(control=control, repository=repository,
406
branch=branch, working=working),
408
if branch is not None:
409
_show_related_info(branch, outfile)
412
_show_format_info(control, repository, branch, working, outfile)
413
_show_locking_info(repository, branch, working, outfile)
414
_show_control_dir_info(control, outfile)
415
if branch is not None:
416
_show_missing_revisions_branch(branch, outfile)
417
if working is not None:
418
_show_missing_revisions_working(working, outfile)
419
_show_working_stats(working, outfile)
420
elif branch is not None:
421
_show_missing_revisions_branch(branch, outfile)
422
if branch is not None:
423
show_committers = verbose >= 2
424
stats = _show_branch_stats(branch, show_committers, outfile)
425
elif repository is not None:
426
stats = repository.gather_stats()
427
if branch is None and working is None and repository is not None:
428
_show_repository_info(repository, outfile)
429
if repository is not None:
430
_show_repository_stats(repository, stats, outfile)
433
def describe_layout(repository=None, branch=None, tree=None, control=None):
434
"""Convert a control directory layout into a user-understandable term
436
Common outputs include "Standalone tree", "Repository branch" and
437
"Checkout". Uncommon outputs include "Unshared repository with trees"
438
and "Empty control directory"
440
if branch is None and control is not None:
442
branch_reference = control.get_branch_reference()
443
except NotBranchError:
446
if branch_reference is not None:
447
return "Dangling branch reference"
448
if repository is None:
449
return 'Empty control directory'
450
if branch is None and tree is None:
451
if repository.is_shared():
452
phrase = 'Shared repository'
454
phrase = 'Unshared repository'
456
if repository.make_working_trees():
457
extra.append('trees')
458
if len(control.branch_names()) > 0:
459
extra.append('colocated branches')
461
phrase += ' with ' + " and ".join(extra)
464
if repository.is_shared():
465
independence = "Repository "
467
independence = "Standalone "
472
if branch is None and tree is not None:
473
phrase = "branchless tree"
475
if (tree is not None and tree.controldir.control_url !=
476
branch.controldir.control_url):
478
phrase = "Lightweight checkout"
479
elif branch.get_bound_location() is not None:
480
if independence == 'Standalone ':
483
phrase = "Bound branch"
486
if independence != "":
487
phrase = phrase.lower()
488
return "%s%s" % (independence, phrase)
491
def describe_format(control, repository, branch, tree):
492
"""Determine the format of an existing control directory
494
Several candidates may be found. If so, the names are returned as a
495
single string, separated by ' or '.
497
If no matching candidate is found, "unnamed" is returned.
500
if (branch is not None and tree is not None and
501
branch.user_url != tree.user_url):
504
non_aliases = set(controldir.format_registry.keys())
505
non_aliases.difference_update(controldir.format_registry.aliases())
506
for key in non_aliases:
507
format = controldir.format_registry.make_controldir(key)
508
if isinstance(format, bzrdir.BzrDirMetaFormat1):
509
if (tree and format.workingtree_format !=
512
if (branch and format.get_branch_format() !=
515
if (repository and format.repository_format !=
518
if format.__class__ is not control._format.__class__:
520
candidates.append(key)
521
if len(candidates) == 0:
524
new_candidates = [c for c in candidates if not
525
controldir.format_registry.get_info(c).hidden]
526
if len(new_candidates) > 0:
527
# If there are any non-hidden formats that match, only return those to
528
# avoid listing hidden formats except when only a hidden format will
530
candidates = new_candidates
531
return ' or '.join(candidates)
534
class InfoHooks(_mod_hooks.Hooks):
535
"""Hooks for the info command."""
538
super(InfoHooks, self).__init__("breezy.info", "hooks")
541
"Invoked when displaying the statistics for a repository. "
542
"repository is called with a statistics dictionary as returned "
543
"by the repository and a file-like object to write to.", (1, 15))
280
show_tree_info(working, verbose)
284
except (NoWorkingTree, NotLocalUrl):
288
branch = a_bzrdir.open_branch()
291
show_branch_info(branch, verbose)
295
except NotBranchError:
299
repository = a_bzrdir.open_repository()
300
repository.lock_read()
302
show_repository_info(repository, verbose)
306
except NoRepositoryPresent:
309
# Return silently, cmd_info already returned NotBranchError if no bzrdir
313
def show_tree_info(working, verbose):
314
"""Output to stdout the 'info' for working."""
315
branch = working.branch
316
repository = branch.repository
317
control = working.bzrdir
319
_show_location_info(repository, branch, working)
320
_show_related_info(branch)
321
_show_format_info(control, repository, branch, working)
322
_show_locking_info(repository, branch, working)
323
_show_missing_revisions_branch(branch)
324
_show_missing_revisions_working(working)
325
_show_working_stats(working)
326
stats = _show_branch_stats(branch, verbose)
327
_show_repository_stats(stats)
330
def show_branch_info(branch, verbose):
331
"""Output to stdout the 'info' for branch."""
332
repository = branch.repository
333
control = branch.bzrdir
335
_show_location_info(repository, branch)
336
_show_related_info(branch)
337
_show_format_info(control, repository, branch)
338
_show_locking_info(repository, branch)
339
_show_missing_revisions_branch(branch)
340
stats = _show_branch_stats(branch, verbose)
341
_show_repository_stats(stats)
344
def show_repository_info(repository, verbose):
345
"""Output to stdout the 'info' for repository."""
346
control = repository.bzrdir
348
_show_location_info(repository)
349
_show_format_info(control, repository)
350
_show_locking_info(repository)
351
_show_repository_info(repository)
352
stats = repository.gather_stats()
353
_show_repository_stats(stats)
added
removed
bzrlib/info.py
