12
12
# along with this program; if not, write to the Free Software
13
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
"""Graphical support for Bazaar using GTK.
18
gannotate GTK+ annotate.
19
gbranch GTK+ branching.
20
gcheckout GTK+ checkout.
21
gcommit GTK+ commit dialog.
22
gconflicts GTK+ conflicts.
23
gdiff Show differences in working tree in a GTK+ Window.
24
ginit Initialise a new branch.
25
gloom GTK+ loom browse dialog
26
gmerge GTK+ merge dialog
27
gmissing GTK+ missing revisions dialog.
28
gpreferences GTK+ preferences dialog.
30
gsend GTK+ send merge directive.
31
gstatus GTK+ status dialog.
32
gtags Manage branch tags.
33
visualise Graphically visualise this branch.
36
from __future__ import absolute_import
41
if getattr(sys, "frozen", None) is not None: # we run bzr.exe
43
# FIXME: Unless a better packaging solution is found, the following
44
# provides a workaround for https://bugs.launchpad.net/bzr/+bug/388790 Also
45
# see https://code.edge.launchpad.net/~vila/bzr-gtk/388790-windows-setup
46
# for more details about while it's needed.
48
# NOTE: _lib must be ahead of bzrlib or sax.saxutils (in olive) fails
49
here = os.path.dirname(__file__)
50
sys.path.insert(0, os.path.join(here, '_lib'))
51
sys.path.append(os.path.join(here, '_lib/gtk-2.0'))
15
"""GTK+ frontends to Bazaar commands """
56
from bzrlib.commands import plugin_cmds
58
from bzrlib.plugins.gtk.info import (
59
bzr_plugin_version as version_info,
60
bzr_compatible_versions,
63
if version_info[3] == 'final':
64
version_string = '%d.%d.%d' % version_info[:3]
66
version_string = '%d.%d.%d%s%d' % version_info
67
__version__ = version_string
69
bzrlib.api.require_any_api(bzrlib, bzr_compatible_versions)
19
__version__ = '0.16.0'
20
version_info = tuple(int(n) for n in __version__.split('.'))
23
def check_bzrlib_version(desired):
24
"""Check that bzrlib is compatible.
26
If version is < bzr-gtk version, assume incompatible.
27
If version == bzr-gtk version, assume completely compatible
28
If version == bzr-gtk version + 1, assume compatible, with deprecations
29
Otherwise, assume incompatible.
31
desired_plus = (desired[0], desired[1]+1)
32
bzrlib_version = bzrlib.version_info[:2]
33
if bzrlib_version == desired:
36
from bzrlib.trace import warning
38
# get the message out any way we can
39
from warnings import warn as warning
40
if bzrlib_version < desired:
41
warning('Installed bzr version %s is too old to be used with bzr-gtk'
42
' %s.' % (bzrlib.__version__, __version__))
43
# Not using BzrNewError, because it may not exist.
44
raise Exception, ('Version mismatch', version_info)
46
warning('bzr-gtk is not up to date with installed bzr version %s.'
47
' \nThere should be a newer version available, e.g. %i.%i.'
48
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
49
if bzrlib_version != desired_plus:
50
raise Exception, 'Version mismatch'
53
check_bzrlib_version(version_info[:2])
55
from bzrlib.trace import warning
71
56
if __name__ != 'bzrlib.plugins.gtk':
72
from bzrlib.trace import warning
73
57
warning("Not running as bzrlib.plugins.gtk, things may break.")
59
from bzrlib.lazy_import import lazy_import
60
lazy_import(globals(), """
68
from bzrlib.commands import Command, register_command, display_command
69
from bzrlib.errors import NotVersionedError, BzrCommandError, NoSuchFile
70
from bzrlib.option import Option
78
raise errors.BzrCommandError("PyGTK not installed.")
76
83
def set_ui_factory():
77
from bzrlib.plugins.gtk.ui import GtkUIFactory
85
from ui import GtkUIFactory
79
87
bzrlib.ui.ui_factory = GtkUIFactory()
83
return [os.path.dirname(__file__),
85
"/usr/local/share/bzr-gtk"]
89
for basedir in data_basedirs():
90
path = os.path.join(basedir, *args)
91
if os.path.exists(path):
97
return data_path(os.path.join('icons', *args))
101
"gannotate": ["gblame", "gpraise"],
115
"visualise": ["visualize", "vis", "viz", 'glog'],
119
from bzrlib.plugins import loom
121
pass # Loom plugin doesn't appear to be present
123
commands["gloom"] = []
125
for cmd, aliases in commands.iteritems():
126
plugin_cmds.register_lazy("cmd_%s" % cmd, aliases,
127
"bzrlib.plugins.gtk.commands")
129
def save_commit_messages(*args):
130
from bzrlib.plugins.gtk import commitmsgs
131
commitmsgs.save_commit_messages(*args)
134
from bzrlib.hooks import install_lazy_named_hook
136
from bzrlib.branch import Branch
137
Branch.hooks.install_named_hook('post_uncommit',
138
save_commit_messages,
139
"Saving commit messages for gcommit")
141
install_lazy_named_hook("bzrlib.branch", "Branch.hooks",
142
'post_uncommit', save_commit_messages, "Saving commit messages for gcommit")
145
from bzrlib.registry import register_lazy
147
from bzrlib import config
148
option_registry = getattr(config, "option_registry", None)
149
if option_registry is not None:
150
config.option_registry.register_lazy('nautilus_integration',
151
'bzrlib.plugins.gtk.config', 'opt_nautilus_integration')
153
register_lazy("bzrlib.config", "option_registry",
154
'nautilus_integration', 'bzrlib.plugins.gtk.config',
155
'opt_nautilus_integration')
158
def load_tests(basic_tests, module, loader):
90
class GTKCommand(Command):
91
"""Abstract class providing GTK specific run commands."""
93
def open_display(self):
94
pygtk = import_pygtk()
97
except RuntimeError, e:
98
if str(e) == "could not open display":
105
dialog = self.get_gtk_dialog(os.path.abspath('.'))
109
class cmd_gbranch(GTKCommand):
114
def get_gtk_dialog(self, path):
115
from bzrlib.plugins.gtk.branch import BranchDialog
116
return BranchDialog(path)
119
class cmd_gcheckout(GTKCommand):
124
def get_gtk_dialog(self, path):
125
from bzrlib.plugins.gtk.checkout import CheckoutDialog
126
return CheckoutDialog(path)
130
class cmd_gpush(GTKCommand):
134
takes_args = [ "location?" ]
136
def run(self, location="."):
137
(br, path) = branch.Branch.open_containing(location)
139
from push import PushDialog
140
dialog = PushDialog(br)
145
class cmd_gdiff(GTKCommand):
146
"""Show differences in working tree in a GTK+ Window.
148
Otherwise, all changes for the tree are listed.
150
takes_args = ['filename?']
151
takes_options = ['revision']
154
def run(self, revision=None, filename=None):
156
wt = workingtree.WorkingTree.open_containing(".")[0]
160
if revision is not None:
161
if len(revision) == 1:
163
revision_id = revision[0].in_history(branch).rev_id
164
tree2 = branch.repository.revision_tree(revision_id)
165
elif len(revision) == 2:
166
revision_id_0 = revision[0].in_history(branch).rev_id
167
tree2 = branch.repository.revision_tree(revision_id_0)
168
revision_id_1 = revision[1].in_history(branch).rev_id
169
tree1 = branch.repository.revision_tree(revision_id_1)
172
tree2 = tree1.basis_tree()
174
from diff import DiffWindow
176
window = DiffWindow()
177
window.connect("destroy", gtk.main_quit)
178
window.set_diff("Working Tree", tree1, tree2)
179
if filename is not None:
180
tree_filename = wt.relpath(filename)
182
window.set_file(tree_filename)
184
if (tree1.inventory.path2id(tree_filename) is None and
185
tree2.inventory.path2id(tree_filename) is None):
186
raise NotVersionedError(filename)
187
raise BzrCommandError('No changes found for file "%s"' %
196
class cmd_visualise(Command):
197
"""Graphically visualise this branch.
199
Opens a graphical window to allow you to see the history of the branch
200
and relationships between revisions in a visual manner,
202
The default starting point is latest revision on the branch, you can
203
specify a starting point with -r revision.
207
Option('limit', "maximum number of revisions to display",
209
takes_args = [ "location?" ]
210
aliases = [ "visualize", "vis", "viz" ]
212
def run(self, location=".", revision=None, limit=None):
214
(br, path) = branch.Branch.open_containing(location)
216
br.repository.lock_read()
219
revid = br.last_revision()
223
(revno, revid) = revision[0].in_history(br)
225
from viz.branchwin import BranchWindow
229
pp.set_branch(br, revid, limit)
230
pp.connect("destroy", lambda w: gtk.main_quit())
234
br.repository.unlock()
238
class cmd_gannotate(GTKCommand):
241
Browse changes to FILENAME line by line in a GTK+ window.
244
takes_args = ["filename", "line?"]
246
Option("all", help="show annotations on all lines"),
247
Option("plain", help="don't highlight annotation lines"),
248
Option("line", type=int, argname="lineno",
249
help="jump to specified line number"),
252
aliases = ["gblame", "gpraise"]
254
def run(self, filename, all=False, plain=False, line='1', revision=None):
255
gtk = self.open_display()
260
raise BzrCommandError('Line argument ("%s") is not a number.' %
263
from annotate.gannotate import GAnnotateWindow
264
from annotate.config import GAnnotateConfig
265
from bzrlib.bzrdir import BzrDir
267
wt, br, path = BzrDir.open_containing_tree_or_branch(filename)
271
tree = br.basis_tree()
273
file_id = tree.path2id(path)
276
raise NotVersionedError(filename)
277
if revision is not None:
278
if len(revision) != 1:
279
raise BzrCommandError("Only 1 revion may be specified.")
280
revision_id = revision[0].in_history(br).rev_id
281
tree = br.repository.revision_tree(revision_id)
283
revision_id = getattr(tree, 'get_revision_id', lambda: None)()
285
window = GAnnotateWindow(all, plain)
286
window.connect("destroy", lambda w: gtk.main_quit())
287
window.set_title(path + " - gannotate")
288
config = GAnnotateConfig(window)
294
window.annotate(tree, br, file_id)
295
window.jump_to_line(line)
304
class cmd_gcommit(GTKCommand):
305
"""GTK+ commit dialog
307
Graphical user interface for committing revisions"""
313
def run(self, filename=None):
316
from commit import CommitDialog
317
from bzrlib.errors import (BzrCommandError,
324
(wt, path) = workingtree.WorkingTree.open_containing(filename)
326
except NotBranchError, e:
328
except NoWorkingTree, e:
331
(br, path) = branch.Branch.open_containing(path)
332
except NotBranchError, e:
335
commit = CommitDialog(wt, path, not br)
340
class cmd_gstatus(GTKCommand):
341
"""GTK+ status dialog
343
Graphical user interface for showing status
347
takes_args = ['PATH?']
350
def run(self, path='.'):
352
gtk = self.open_display()
353
from status import StatusDialog
354
(wt, wt_path) = workingtree.WorkingTree.open_containing(path)
355
status = StatusDialog(wt, wt_path)
356
status.connect("destroy", gtk.main_quit)
361
class cmd_gconflicts(GTKCommand):
366
(wt, path) = workingtree.WorkingTree.open_containing('.')
368
from bzrlib.plugins.gtk.conflicts import ConflictsDialog
369
dialog = ConflictsDialog(wt)
374
class cmd_gpreferences(GTKCommand):
375
""" GTK+ preferences dialog.
380
from bzrlib.plugins.gtk.preferences import PreferencesWindow
381
dialog = PreferencesWindow()
386
class cmd_gmissing(Command):
387
""" GTK+ missing revisions dialog.
390
takes_args = ["other_branch?"]
391
def run(self, other_branch=None):
392
pygtk = import_pygtk()
395
except RuntimeError, e:
396
if str(e) == "could not open display":
399
from bzrlib.plugins.gtk.missing import MissingWindow
400
from bzrlib.branch import Branch
402
local_branch = Branch.open_containing(".")[0]
403
if other_branch is None:
404
other_branch = local_branch.get_parent()
406
if other_branch is None:
407
raise errors.BzrCommandError("No peer location known or specified.")
408
remote_branch = Branch.open_containing(other_branch)[0]
410
local_branch.lock_read()
412
remote_branch.lock_read()
414
dialog = MissingWindow(local_branch, remote_branch)
417
remote_branch.unlock()
419
local_branch.unlock()
422
class cmd_ginit(GTKCommand):
425
from initialize import InitDialog
426
dialog = InitDialog(os.path.abspath(os.path.curdir))
446
register_command(cmd)
449
class cmd_commit_notify(GTKCommand):
450
"""Run the bzr commit notifier.
452
This is a background program which will pop up a notification on the users
453
screen when a commit occurs.
457
gtk = self.open_display()
462
from bzrlib.bzrdir import BzrDir
463
from bzrlib import errors
464
from bzrlib.osutils import format_date
465
from bzrlib.transport import get_transport
466
if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
468
from bzrlib.plugins.dbus import activity
469
bus = dbus.SessionBus()
470
# get the object so we can subscribe to callbacks from it.
471
broadcast_service = bus.get_object(
472
activity.Broadcast.DBUS_NAME,
473
activity.Broadcast.DBUS_PATH)
474
def catch_branch(revision_id, urls):
475
# TODO: show all the urls, or perhaps choose the 'best'.
478
if isinstance(revision_id, unicode):
479
revision_id = revision_id.encode('utf8')
480
transport = get_transport(url)
481
a_dir = BzrDir.open_from_transport(transport)
482
branch = a_dir.open_branch()
483
revno = branch.revision_id_to_revno(revision_id)
484
revision = branch.repository.get_revision(revision_id)
485
summary = 'New revision %d in %s' % (revno, url)
486
body = 'Committer: %s\n' % revision.committer
487
body += 'Date: %s\n' % format_date(revision.timestamp,
490
body += revision.message
491
body = cgi.escape(body)
492
nw = pynotify.Notification(summary, body)
498
broadcast_service.connect_to_signal("Revision", catch_branch,
499
dbus_interface=activity.Broadcast.DBUS_INTERFACE)
500
pynotify.init("bzr commit-notify")
503
register_command(cmd_commit_notify)
507
gettext.install('olive-gtk')
510
class NoDisplayError(BzrCommandError):
511
"""gtk could not find a proper display"""
514
return "No DISPLAY. Unable to run GTK+ application."
518
from unittest import TestSuite
163
521
default_encoding = sys.getdefaultencoding()
167
import gi.repository.Gtk
170
basic_tests.addTest(loader.loadTestsFromModuleNames(
171
["%s.%s" % (__name__, tmn) for tmn in testmod_names]))
524
result.addTest(tests.test_suite())
173
526
if sys.getdefaultencoding() != default_encoding:
175
528
sys.setdefaultencoding(default_encoding)