1
# Copyright (C) 2006 by Szilveszter Farkas (Phanatic) <szilveszter.farkas@gmail.com>
2
# Some parts of the code are:
3
# Copyright (C) 2005, 2006 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
import bzrlib.errors as errors
22
from bzrlib.branch import Branch
23
from bzrlib.workingtree import WorkingTree
25
from errors import (DifferentBranchesError, NotBranchError, PrefixFormatError,
28
def diff(revision=None, file_list=None, diff_options=None, prefix=None):
29
""" Save the diff into a temporary file.
31
:param revision: a list of revision numbers (one or two elements)
33
:param file_list: list of files you want to diff
35
:param diff_options: external diff options
37
:param prefix: 0 - p0, 1 - p1, or specify prefixes in the form of old/:new/
39
:return: path to the temporary file which contains the diff output (the frontend has to remove it!)
41
from tempfile import mkstemp
43
from bzrlib.builtins import internal_tree_files
44
from bzrlib.diff import show_diff_trees
45
from bzrlib.revisionspec import RevisionSpec_int
46
from bzrlib.workingtree import WorkingTree
48
from info_helper import diff_helper
50
if (prefix is None) or (prefix == '0'):
59
raise PrefixFormatError
60
old_label, new_label = prefix.split(":")
63
tree1, file_list = internal_tree_files(file_list)
67
except errors.FileInWrongBranch:
68
if len(file_list) != 2:
69
raise DifferentBranchesError
71
tree1, file1 = WorkingTree.open_containing(file_list[0])
72
tree2, file2 = WorkingTree.open_containing(file_list[1])
74
if file1 != "" or file2 != "":
75
raise DifferentBranchesError
79
tmpfile = mkstemp(prefix='olive_')
80
tmpfp = open(tmpfile[1], 'w')
82
if revision is not None:
84
raise RevisionValueError
86
if len(revision) >= 1:
87
revision[0] = RevisionSpec_int(revision[0])
88
if len(revision) == 2:
89
revision[1] = RevisionSpec_int(revision[1])
91
if (len(revision) == 1) or (revision[1].spec is None):
92
ret = diff_helper(tree1, file_list, diff_options,
94
old_label=old_label, new_label=new_label,
96
elif len(revision) == 2:
97
ret = diff_helper(tree1, file_list, diff_options,
98
revision[0], revision[1],
99
old_label=old_label, new_label=new_label,
102
raise RevisionValueError
104
if tree2 is not None:
105
ret = show_diff_trees(tree1, tree2, tmpfp,
106
specific_files=file_list,
107
external_diff_options=diff_options,
108
old_label=old_label, new_label=new_label)
110
ret = diff_helper(tree1, file_list, diff_options,
111
old_label=old_label, new_label=new_label,
122
""" Get info about branch, working tree, and repository
124
:param location: the location of the branch/working tree/repository
126
:return: the information in dictionary format
128
The following informations are delivered (if available):
129
ret['location']['lightcoroot']: Light checkout root
130
ret['location']['sharedrepo']: Shared repository
131
ret['location']['repobranch']: Repository branch
132
ret['location']['cobranch']: Checkout of branch
133
ret['location']['repoco']: Repository checkout
134
ret['location']['coroot']: Checkout root
135
ret['location']['branchroot']: Branch root
136
ret['related']['parentbranch']: Parent branch
137
ret['related']['publishbranch']: Publish to branch
138
ret['format']['control']: Control format
139
ret['format']['workingtree']: Working tree format
140
ret['format']['branch']: Branch format
141
ret['format']['repository']: Repository format
142
ret['locking']['workingtree']: Working tree lock status
143
ret['locking']['branch']: Branch lock status
144
ret['locking']['repository']: Repository lock status
145
ret['mrevbranch']['missing']: Missing revisions in branch
146
ret['mrevworking']['missing']: Missing revisions in working tree
147
ret['wtstats']['unchanged']: Unchanged files
148
ret['wtstats']['modified']: Modified files
149
ret['wtstats']['added']: Added files
150
ret['wtstats']['removed']: Removed files
151
ret['wtstats']['renamed']: Renamed files
152
ret['wtstats']['unknown']: Unknown files
153
ret['wtstats']['ignored']: Ingnored files
154
ret['wtstats']['subdirs']: Versioned subdirectories
155
ret['brstats']['revno']: Revisions in branch
156
ret['brstats']['commiters']: Number of commiters
157
ret['brstats']['age']: Age of branch in days
158
ret['brstats']['firstrev']: Time of first revision
159
ret['brstats']['lastrev']: Time of last revision
160
ret['repstats']['revisions']: Revisions in repository
161
ret['repstats']['size']: Size of repository in bytes
163
import bzrlib.bzrdir as bzrdir
168
a_bzrdir = bzrdir.BzrDir.open_containing(location)[0]
170
working = a_bzrdir.open_workingtree()
173
branch = working.branch
174
repository = branch.repository
175
control = working.bzrdir
177
ret['location'] = info_helper.get_location_info(repository, branch, working)
178
ret['related'] = info_helper.get_related_info(branch)
179
ret['format'] = info_helper.get_format_info(control, repository, branch, working)
180
ret['locking'] = info_helper.get_locking_info(repository, branch, working)
181
ret['mrevbranch'] = info_helper.get_missing_revisions_branch(branch)
182
ret['mrevworking'] = info_helper.get_missing_revisions_working(working)
183
ret['wtstats'] = info_helper.get_working_stats(working)
184
ret['brstats'] = info_helper.get_branch_stats(branch)
185
ret['repstats'] = info_helper.get_repository_stats(repository)
190
except (errors.NoWorkingTree, errors.NotLocalUrl):
194
branch = a_bzrdir.open_branch()
197
ret['location'] = info_helper.get_location_info(repository, branch)
198
ret['related'] = info_helper.get_related_info(branch)
199
ret['format'] = info_helper.get_format_info(control, repository, branch)
200
ret['locking'] = info_helper.get_locking_info(repository, branch)
201
ret['mrevbranch'] = info_helper.get_missing_revisions_branch(branch)
202
ret['brstats'] = info_helper.get_branch_stats(branch)
203
ret['repstats'] = info_helper.get_repository_stats(repository)
208
except errors.NotBranchError:
212
repository = a_bzrdir.open_repository()
213
repository.lock_read()
215
ret['location'] = info_helper.get_location_info(repository)
216
ret['format'] = info_helper.get_format_info(control, repository)
217
ret['locking'] = info_helper.get_locking_info(repository)
218
ret['repstats'] = info_helper.get_repository_stats(repository)
223
except errors.NoRepositoryPresent:
226
def is_checkout(location):
227
""" Check if the location is a checkout.
229
:param location: the location you want to check
231
:return: True or False respectively
234
branch = Branch.open_containing(location)[0]
235
except errors.NotBranchError:
239
working = WorkingTree.open_containing(location)[0]
243
working_path = working.bzrdir.root_transport.base
244
branch_path = branch.bzrdir.root_transport.base
246
if working_path != branch_path:
247
# lightweight checkout
249
elif branch.get_bound_location():
256
def log(location, timezone='original', verbose=False, show_ids=False,
257
forward=False, revision=None, log_format=None, message=None,
258
long=False, short=False, line=False):
259
""" Print log into a temporary file.
261
:param location: location of local/remote branch or file
263
:param timzone: requested timezone
265
:param verbose: verbose output
269
:param forward: if True, start from the earliest entry
271
:param revision: revision range as a list ([from, to])
273
:param log_format: line, short, long
275
:param message: show revisions whose message matches this regexp
277
:param long: long log format
279
:param short: short log format
281
:param line: line log format
283
:return: full path to the temporary file containing the log (the frontend has to remove it!)
285
from tempfile import mkstemp
287
from bzrlib import bzrdir
288
from bzrlib.builtins import get_log_format
289
from bzrlib.log import log_formatter, show_log
290
from bzrlib.revisionspec import RevisionSpec_int
292
assert message is None or isinstance(message, basestring), \
293
"invalid message argument %r" % message
294
direction = (forward and 'forward') or 'reverse'
299
# find the file id to log:
300
dir, fp = bzrdir.BzrDir.open_containing(location)
301
b = dir.open_branch()
305
inv = dir.open_workingtree().inventory
306
except (errors.NotBranchError, errors.NotLocalUrl):
307
# either no tree, or is remote.
308
inv = b.basis_tree().inventory
309
file_id = inv.path2id(fp)
311
if revision is not None:
312
if len(revision) >= 1:
313
revision[0] = RevisionSpec_int(revision[0])
314
if len(revision) == 2:
315
revision[1] = RevisionSpec_int(revision[1])
320
elif len(revision) == 1:
321
rev1 = rev2 = revision[0].in_history(b).revno
322
elif len(revision) == 2:
323
if revision[0].spec is None:
324
# missing begin-range means first revision
327
rev1 = revision[0].in_history(b).revno
329
if revision[1].spec is None:
330
# missing end-range means last known revision
333
rev2 = revision[1].in_history(b).revno
335
raise RevisionValueError
337
# By this point, the revision numbers are converted to the +ve
338
# form if they were supplied in the -ve form, so we can do
339
# this comparison in relative safety
341
(rev2, rev1) = (rev1, rev2)
343
if (log_format == None):
344
default = b.get_config().log_format()
345
log_format = get_log_format(long=long, short=short, line=line,
348
tmpfile = mkstemp(prefix='olive_')
349
tmpfp = open(tmpfile[1], 'w')
351
lf = log_formatter(log_format,
354
show_timezone=timezone)
368
def nick(branch, nickname=None):
369
""" Get or set nickname.
371
:param branch: path to the branch
373
:param nickname: if specified, the nickname will be set
378
branch = Branch.open_containing(branch)[0]
379
except errors.NotBranchError:
382
if nickname is not None:
383
branch.nick = nickname
388
""" Get current revision number for specified branch
390
:param branch: path to the branch
392
:return: revision number
395
revno = Branch.open_containing(branch)[0].revno()
396
except errors.NotBranchError:
402
""" Get version information from bzr
404
:return: bzrlib version
406
return bzrlib.__version__
408
def whoami(branch=None, email=False):
409
""" Get user's data (name and email address)
411
:param branch: if specified, the user's data will be looked up in the branch's config
413
:param email: if True, only the email address will be returned
415
:return: user info (only email address if email is True)
417
from bzrlib.workingtree import WorkingTree
419
if branch is not None:
421
b = WorkingTree.open_containing(u'.')[0].branch
422
config = bzrlib.config.BranchConfig(b)
423
except NotBranchError:
424
config = bzrlib.config.GlobalConfig()
426
config = bzrlib.config.GlobalConfig()
429
return config.user_email()
431
return config.username()