17
15
"""Graphical support for Bazaar using GTK.
19
17
This plugin includes:
20
commit-notify Start the graphical notifier of commits.
21
gannotate GTK+ annotate.
22
gbranch GTK+ branching.
23
gcheckout GTK+ checkout.
24
gcommit GTK+ commit dialog
26
gdiff Show differences in working tree in a GTK+ Window.
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.
27
24
ginit Initialise a new branch.
28
gmissing GTK+ missing revisions dialog.
29
gpreferences GTK+ preferences dialog.
31
gstatus GTK+ status dialog
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
32
gtags Manage branch tags.
33
visualise Graphically visualise this branch.
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'))
38
__version__ = '0.18.0'
39
version_info = tuple(int(n) for n in __version__.split('.'))
42
def check_bzrlib_version(desired):
43
"""Check that bzrlib is compatible.
45
If version is < bzr-gtk version, assume incompatible.
46
If version == bzr-gtk version, assume completely compatible
47
If version == bzr-gtk version + 1, assume compatible, with deprecations
48
Otherwise, assume incompatible.
50
desired_plus = (desired[0], desired[1]+1)
51
bzrlib_version = bzrlib.version_info[:2]
52
if bzrlib_version == desired or (bzrlib_version == desired_plus and
53
bzrlib.version_info[3] == 'dev'):
56
from bzrlib.trace import warning
58
# get the message out any way we can
59
from warnings import warn as warning
60
if bzrlib_version < desired:
61
from bzrlib.errors import BzrError
62
warning('Installed bzr version %s is too old to be used with bzr-gtk'
63
' %s.' % (bzrlib.__version__, __version__))
64
raise BzrError('Version mismatch: %r' % version_info)
66
warning('bzr-gtk is not up to date with installed bzr version %s.'
67
' \nThere should be a newer version available, e.g. %i.%i.'
68
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
71
check_bzrlib_version(version_info[:2])
73
from bzrlib.trace import warning
59
from bzrlib.commands import plugin_cmds
61
from bzrlib.plugins.gtk.info import (
62
bzr_plugin_version as version_info,
63
bzr_compatible_versions,
66
if version_info[3] == 'final':
67
version_string = '%d.%d.%d' % version_info[:3]
69
version_string = '%d.%d.%d%s%d' % version_info
70
__version__ = version_string
72
bzrlib.api.require_any_api(bzrlib, bzr_compatible_versions)
74
74
if __name__ != 'bzrlib.plugins.gtk':
75
from bzrlib.trace import warning
75
76
warning("Not running as bzrlib.plugins.gtk, things may break.")
77
from bzrlib.lazy_import import lazy_import
78
lazy_import(globals(), """
86
from bzrlib.commands import Command, register_command, display_command
87
from bzrlib.errors import NotVersionedError, BzrCommandError, NoSuchFile
88
from bzrlib.option import Option
96
raise errors.BzrCommandError("PyGTK not installed.")
101
79
def set_ui_factory():
103
from ui import GtkUIFactory
80
from bzrlib.plugins.gtk.ui import GtkUIFactory
105
82
bzrlib.ui.ui_factory = GtkUIFactory()
108
class GTKCommand(Command):
109
"""Abstract class providing GTK specific run commands."""
111
def open_display(self):
112
pygtk = import_pygtk()
115
except RuntimeError, e:
116
if str(e) == "could not open display":
123
dialog = self.get_gtk_dialog(os.path.abspath('.'))
127
class cmd_gbranch(GTKCommand):
132
def get_gtk_dialog(self, path):
133
from bzrlib.plugins.gtk.branch import BranchDialog
134
return BranchDialog(path)
137
class cmd_gcheckout(GTKCommand):
142
def get_gtk_dialog(self, path):
143
from bzrlib.plugins.gtk.checkout import CheckoutDialog
144
return CheckoutDialog(path)
148
class cmd_gpush(GTKCommand):
152
takes_args = [ "location?" ]
154
def run(self, location="."):
155
(br, path) = branch.Branch.open_containing(location)
157
from push import PushDialog
158
dialog = PushDialog(br)
163
class cmd_gdiff(GTKCommand):
164
"""Show differences in working tree in a GTK+ Window.
166
Otherwise, all changes for the tree are listed.
168
takes_args = ['filename?']
169
takes_options = ['revision']
172
def run(self, revision=None, filename=None):
174
wt = workingtree.WorkingTree.open_containing(".")[0]
178
if revision is not None:
179
if len(revision) == 1:
181
revision_id = revision[0].in_history(branch).rev_id
182
tree2 = branch.repository.revision_tree(revision_id)
183
elif len(revision) == 2:
184
revision_id_0 = revision[0].in_history(branch).rev_id
185
tree2 = branch.repository.revision_tree(revision_id_0)
186
revision_id_1 = revision[1].in_history(branch).rev_id
187
tree1 = branch.repository.revision_tree(revision_id_1)
190
tree2 = tree1.basis_tree()
192
from diff import DiffWindow
194
window = DiffWindow()
195
window.connect("destroy", gtk.main_quit)
196
window.set_diff("Working Tree", tree1, tree2)
197
if filename is not None:
198
tree_filename = wt.relpath(filename)
200
window.set_file(tree_filename)
202
if (tree1.path2id(tree_filename) is None and
203
tree2.path2id(tree_filename) is None):
204
raise NotVersionedError(filename)
205
raise BzrCommandError('No changes found for file "%s"' %
214
def start_viz_window(branch, revision, limit=None):
215
"""Start viz on branch with revision revision.
217
:return: The viz window object.
219
from viz.branchwin import BranchWindow
222
pp.set_branch(branch, revision, limit)
223
# cleanup locks when the window is closed
224
pp.connect("destroy", lambda w: branch.unlock())
228
class cmd_visualise(Command):
229
"""Graphically visualise this branch.
231
Opens a graphical window to allow you to see the history of the branch
232
and relationships between revisions in a visual manner,
234
The default starting point is latest revision on the branch, you can
235
specify a starting point with -r revision.
239
Option('limit', "Maximum number of revisions to display.",
241
takes_args = [ "location?" ]
242
aliases = [ "visualize", "vis", "viz" ]
244
def run(self, location=".", revision=None, limit=None):
246
(br, path) = branch.Branch.open_containing(location)
250
revid = br.last_revision()
254
(revno, revid) = revision[0].in_history(br)
257
pp = start_viz_window(br, revid, limit)
258
pp.connect("destroy", lambda w: gtk.main_quit())
265
class cmd_gannotate(GTKCommand):
268
Browse changes to FILENAME line by line in a GTK+ window.
271
takes_args = ["filename", "line?"]
273
Option("all", help="Show annotations on all lines."),
274
Option("plain", help="Don't highlight annotation lines."),
275
Option("line", type=int, argname="lineno",
276
help="Jump to specified line number."),
279
aliases = ["gblame", "gpraise"]
281
def run(self, filename, all=False, plain=False, line='1', revision=None):
282
gtk = self.open_display()
287
raise BzrCommandError('Line argument ("%s") is not a number.' %
290
from annotate.gannotate import GAnnotateWindow
291
from annotate.config import GAnnotateConfig
292
from bzrlib.bzrdir import BzrDir
294
wt, br, path = BzrDir.open_containing_tree_or_branch(filename)
298
tree = br.basis_tree()
300
file_id = tree.path2id(path)
303
raise NotVersionedError(filename)
304
if revision is not None:
305
if len(revision) != 1:
306
raise BzrCommandError("Only 1 revion may be specified.")
307
revision_id = revision[0].in_history(br).rev_id
308
tree = br.repository.revision_tree(revision_id)
310
revision_id = getattr(tree, 'get_revision_id', lambda: None)()
312
window = GAnnotateWindow(all, plain)
313
window.connect("destroy", lambda w: gtk.main_quit())
314
window.set_title(path + " - gannotate")
315
config = GAnnotateConfig(window)
321
window.annotate(tree, br, file_id)
322
window.jump_to_line(line)
331
class cmd_gcommit(GTKCommand):
332
"""GTK+ commit dialog
334
Graphical user interface for committing revisions"""
340
def run(self, filename=None):
343
from commit import CommitDialog
344
from bzrlib.errors import (BzrCommandError,
351
(wt, path) = workingtree.WorkingTree.open_containing(filename)
353
except NoWorkingTree, e:
355
(br, path) = branch.Branch.open_containing(path)
357
commit = CommitDialog(wt, path, not br)
362
class cmd_gstatus(GTKCommand):
363
"""GTK+ status dialog
365
Graphical user interface for showing status
369
takes_args = ['PATH?']
372
def run(self, path='.'):
374
gtk = self.open_display()
375
from status import StatusDialog
376
(wt, wt_path) = workingtree.WorkingTree.open_containing(path)
377
status = StatusDialog(wt, wt_path)
378
status.connect("destroy", gtk.main_quit)
383
class cmd_gconflicts(GTKCommand):
388
(wt, path) = workingtree.WorkingTree.open_containing('.')
390
from bzrlib.plugins.gtk.conflicts import ConflictsDialog
391
dialog = ConflictsDialog(wt)
396
class cmd_gpreferences(GTKCommand):
397
""" GTK+ preferences dialog.
402
from bzrlib.plugins.gtk.preferences import PreferencesWindow
403
dialog = PreferencesWindow()
408
class cmd_gmissing(Command):
409
""" GTK+ missing revisions dialog.
412
takes_args = ["other_branch?"]
413
def run(self, other_branch=None):
414
pygtk = import_pygtk()
417
except RuntimeError, e:
418
if str(e) == "could not open display":
421
from bzrlib.plugins.gtk.missing import MissingWindow
422
from bzrlib.branch import Branch
424
local_branch = Branch.open_containing(".")[0]
425
if other_branch is None:
426
other_branch = local_branch.get_parent()
428
if other_branch is None:
429
raise errors.BzrCommandError("No peer location known or specified.")
430
remote_branch = Branch.open_containing(other_branch)[0]
432
local_branch.lock_read()
434
remote_branch.lock_read()
436
dialog = MissingWindow(local_branch, remote_branch)
439
remote_branch.unlock()
441
local_branch.unlock()
444
class cmd_ginit(GTKCommand):
447
from initialize import InitDialog
448
dialog = InitDialog(os.path.abspath(os.path.curdir))
452
class cmd_gtags(GTKCommand):
454
br = branch.Branch.open_containing('.')[0]
456
gtk = self.open_display()
457
from tags import TagsWindow
458
window = TagsWindow(br)
480
register_command(cmd)
483
class cmd_commit_notify(GTKCommand):
484
"""Run the bzr commit notifier.
486
This is a background program which will pop up a notification on the users
487
screen when a commit occurs.
491
from notify import NotifyPopupMenu
492
gtk = self.open_display()
493
menu = NotifyPopupMenu()
494
icon = gtk.status_icon_new_from_file("bzr-icon-64.png")
495
icon.connect('popup-menu', menu.display)
501
from bzrlib.bzrdir import BzrDir
502
from bzrlib import errors
503
from bzrlib.osutils import format_date
504
from bzrlib.transport import get_transport
505
if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
507
from bzrlib.plugins.dbus import activity
508
bus = dbus.SessionBus()
509
# get the object so we can subscribe to callbacks from it.
510
broadcast_service = bus.get_object(
511
activity.Broadcast.DBUS_NAME,
512
activity.Broadcast.DBUS_PATH)
514
def catch_branch(revision_id, urls):
515
# TODO: show all the urls, or perhaps choose the 'best'.
518
if isinstance(revision_id, unicode):
519
revision_id = revision_id.encode('utf8')
520
transport = get_transport(url)
521
a_dir = BzrDir.open_from_transport(transport)
522
branch = a_dir.open_branch()
523
revno = branch.revision_id_to_revno(revision_id)
524
revision = branch.repository.get_revision(revision_id)
525
summary = 'New revision %d in %s' % (revno, url)
526
body = 'Committer: %s\n' % revision.committer
527
body += 'Date: %s\n' % format_date(revision.timestamp,
530
body += revision.message
531
body = cgi.escape(body)
532
nw = pynotify.Notification(summary, body)
533
def start_viz(notification=None, action=None, data=None):
534
"""Start the viz program."""
535
pp = start_viz_window(branch, revision_id)
537
def start_branch(notification=None, action=None, data=None):
538
"""Start a Branch dialog"""
539
from bzrlib.plugins.gtk.branch import BranchDialog
540
bd = BranchDialog(remote_path=url)
542
nw.add_action("inspect", "Inspect", start_viz, None)
543
nw.add_action("branch", "Branch", start_branch, None)
549
broadcast_service.connect_to_signal("Revision", catch_branch,
550
dbus_interface=activity.Broadcast.DBUS_INTERFACE)
551
pynotify.init("bzr commit-notify")
554
register_command(cmd_commit_notify)
558
gettext.install('olive-gtk')
561
class NoDisplayError(BzrCommandError):
562
"""gtk could not find a proper display"""
565
return "No DISPLAY. Unable to run GTK+ application."
569
from unittest import TestSuite
86
return [os.path.dirname(__file__),
88
"/usr/local/share/bzr-gtk"]
92
for basedir in data_basedirs():
93
path = os.path.join(basedir, *args)
94
if os.path.exists(path):
100
return data_path(os.path.join('icons', *args))
104
"gannotate": ["gblame", "gpraise"],
118
"visualise": ["visualize", "vis", "viz", 'glog'],
122
from bzrlib.plugins import loom
124
pass # Loom plugin doesn't appear to be present
126
commands["gloom"] = []
128
for cmd, aliases in commands.iteritems():
129
plugin_cmds.register_lazy("cmd_%s" % cmd, aliases,
130
"bzrlib.plugins.gtk.commands")
132
def save_commit_messages(*args):
133
from bzrlib.plugins.gtk import commitmsgs
134
commitmsgs.save_commit_messages(*args)
137
from bzrlib.hooks import install_lazy_named_hook
139
from bzrlib.branch import Branch
140
Branch.hooks.install_named_hook('post_uncommit',
141
save_commit_messages,
142
"Saving commit messages for gcommit")
144
install_lazy_named_hook("bzrlib.branch", "Branch.hooks",
145
'post_uncommit', save_commit_messages, "Saving commit messages for gcommit")
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
def load_tests(basic_tests, module, loader):
572
158
default_encoding = sys.getdefaultencoding()
575
result.addTest(tests.test_suite())
162
import gi.repository.Gtk
165
basic_tests.addTest(loader.loadTestsFromModuleNames(
166
["%s.%s" % (__name__, tmn) for tmn in testmod_names]))
577
168
if sys.getdefaultencoding() != default_encoding:
579
170
sys.setdefaultencoding(default_encoding)