15
15
"""Graphical support for Bazaar using GTK.
17
17
This plugin includes:
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.
18
commit-notify Start the graphical notifier of commits.
19
gannotate GTK+ annotate.
20
gbranch GTK+ branching.
21
gcheckout GTK+ checkout.
22
gcommit GTK+ commit dialog
23
gconflicts GTK+ conflicts.
24
gdiff Show differences in working tree in a GTK+ Window.
24
25
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.
26
gmissing GTK+ missing revisions dialog.
27
gpreferences GTK+ preferences dialog.
29
gstatus GTK+ status dialog
32
30
gtags Manage branch tags.
33
visualise Graphically visualise this branch.
31
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'))
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)
36
__version__ = '0.90.0'
37
version_info = tuple(int(n) for n in __version__.split('.'))
40
def check_bzrlib_version(desired):
41
"""Check that bzrlib is compatible.
43
If version is < bzr-gtk version, assume incompatible.
44
If version == bzr-gtk version, assume completely compatible
45
If version == bzr-gtk version + 1, assume compatible, with deprecations
46
Otherwise, assume incompatible.
48
desired_plus = (desired[0], desired[1]+1)
49
bzrlib_version = bzrlib.version_info[:2]
50
if bzrlib_version == desired or (bzrlib_version == desired_plus and
51
bzrlib.version_info[3] == 'dev'):
54
from bzrlib.trace import warning
56
# get the message out any way we can
57
from warnings import warn as warning
58
if bzrlib_version < desired:
59
from bzrlib.errors import BzrError
60
warning('Installed bzr version %s is too old to be used with bzr-gtk'
61
' %s.' % (bzrlib.__version__, __version__))
62
raise BzrError('Version mismatch: %r' % (version_info,) )
64
warning('bzr-gtk is not up to date with installed bzr version %s.'
65
' \nThere should be a newer version available, e.g. %i.%i.'
66
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
69
check_bzrlib_version(version_info[:2])
71
from bzrlib.trace import warning
71
72
if __name__ != 'bzrlib.plugins.gtk':
72
from bzrlib.trace import warning
73
73
warning("Not running as bzrlib.plugins.gtk, things may break.")
75
from bzrlib.lazy_import import lazy_import
76
lazy_import(globals(), """
85
from bzrlib.commands import Command, register_command, display_command
86
from bzrlib.errors import NotVersionedError, BzrCommandError, NoSuchFile
87
from bzrlib.option import Option
95
raise errors.BzrCommandError("PyGTK not installed.")
76
100
def set_ui_factory():
77
from bzrlib.plugins.gtk.ui import GtkUIFactory
102
from ui import GtkUIFactory
79
104
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):
108
return os.path.dirname(__file__)
111
class GTKCommand(Command):
112
"""Abstract class providing GTK specific run commands."""
114
def open_display(self):
115
pygtk = import_pygtk()
118
except RuntimeError, e:
119
if str(e) == "could not open display":
126
dialog = self.get_gtk_dialog(os.path.abspath('.'))
130
class cmd_gbranch(GTKCommand):
135
def get_gtk_dialog(self, path):
136
from bzrlib.plugins.gtk.branch import BranchDialog
137
return BranchDialog(path)
140
class cmd_gcheckout(GTKCommand):
145
def get_gtk_dialog(self, path):
146
from bzrlib.plugins.gtk.checkout import CheckoutDialog
147
return CheckoutDialog(path)
151
class cmd_gpush(GTKCommand):
155
takes_args = [ "location?" ]
157
def run(self, location="."):
158
(br, path) = branch.Branch.open_containing(location)
160
from push import PushDialog
161
dialog = PushDialog(br.repository, br.last_revision(), br)
166
class cmd_gdiff(GTKCommand):
167
"""Show differences in working tree in a GTK+ Window.
169
Otherwise, all changes for the tree are listed.
171
takes_args = ['filename?']
172
takes_options = ['revision']
175
def run(self, revision=None, filename=None):
177
wt = workingtree.WorkingTree.open_containing(".")[0]
181
if revision is not None:
182
if len(revision) == 1:
184
revision_id = revision[0].in_history(branch).rev_id
185
tree2 = branch.repository.revision_tree(revision_id)
186
elif len(revision) == 2:
187
revision_id_0 = revision[0].in_history(branch).rev_id
188
tree2 = branch.repository.revision_tree(revision_id_0)
189
revision_id_1 = revision[1].in_history(branch).rev_id
190
tree1 = branch.repository.revision_tree(revision_id_1)
193
tree2 = tree1.basis_tree()
195
from diff import DiffWindow
197
window = DiffWindow()
198
window.connect("destroy", gtk.main_quit)
199
window.set_diff("Working Tree", tree1, tree2)
200
if filename is not None:
201
tree_filename = wt.relpath(filename)
203
window.set_file(tree_filename)
205
if (tree1.path2id(tree_filename) is None and
206
tree2.path2id(tree_filename) is None):
207
raise NotVersionedError(filename)
208
raise BzrCommandError('No changes found for file "%s"' %
217
def start_viz_window(branch, revision, limit=None):
218
"""Start viz on branch with revision revision.
220
:return: The viz window object.
222
from viz.branchwin import BranchWindow
225
pp.set_branch(branch, revision, limit)
226
# cleanup locks when the window is closed
227
pp.connect("destroy", lambda w: branch.unlock())
231
class cmd_visualise(Command):
232
"""Graphically visualise this branch.
234
Opens a graphical window to allow you to see the history of the branch
235
and relationships between revisions in a visual manner,
237
The default starting point is latest revision on the branch, you can
238
specify a starting point with -r revision.
242
Option('limit', "Maximum number of revisions to display.",
244
takes_args = [ "location?" ]
245
aliases = [ "visualize", "vis", "viz" ]
247
def run(self, location=".", revision=None, limit=None):
249
(br, path) = branch.Branch.open_containing(location)
253
revid = br.last_revision()
257
(revno, revid) = revision[0].in_history(br)
260
pp = start_viz_window(br, revid, limit)
261
pp.connect("destroy", lambda w: gtk.main_quit())
268
class cmd_gannotate(GTKCommand):
271
Browse changes to FILENAME line by line in a GTK+ window.
274
takes_args = ["filename", "line?"]
276
Option("all", help="Show annotations on all lines."),
277
Option("plain", help="Don't highlight annotation lines."),
278
Option("line", type=int, argname="lineno",
279
help="Jump to specified line number."),
282
aliases = ["gblame", "gpraise"]
284
def run(self, filename, all=False, plain=False, line='1', revision=None):
285
gtk = self.open_display()
290
raise BzrCommandError('Line argument ("%s") is not a number.' %
293
from annotate.gannotate import GAnnotateWindow
294
from annotate.config import GAnnotateConfig
295
from bzrlib.bzrdir import BzrDir
297
wt, br, path = BzrDir.open_containing_tree_or_branch(filename)
301
tree = br.basis_tree()
303
file_id = tree.path2id(path)
306
raise NotVersionedError(filename)
307
if revision is not None:
308
if len(revision) != 1:
309
raise BzrCommandError("Only 1 revion may be specified.")
310
revision_id = revision[0].in_history(br).rev_id
311
tree = br.repository.revision_tree(revision_id)
313
revision_id = getattr(tree, 'get_revision_id', lambda: None)()
315
window = GAnnotateWindow(all, plain)
316
window.connect("destroy", lambda w: gtk.main_quit())
317
window.set_title(path + " - gannotate")
318
config = GAnnotateConfig(window)
324
window.annotate(tree, br, file_id)
325
window.jump_to_line(line)
334
class cmd_gcommit(GTKCommand):
335
"""GTK+ commit dialog
337
Graphical user interface for committing revisions"""
343
def run(self, filename=None):
346
from commit import CommitDialog
347
from bzrlib.errors import (BzrCommandError,
354
(wt, path) = workingtree.WorkingTree.open_containing(filename)
356
except NoWorkingTree, e:
358
(br, path) = branch.Branch.open_containing(path)
360
commit = CommitDialog(wt, path, not br)
365
class cmd_gstatus(GTKCommand):
366
"""GTK+ status dialog
368
Graphical user interface for showing status
372
takes_args = ['PATH?']
375
def run(self, path='.'):
377
gtk = self.open_display()
378
from status import StatusDialog
379
(wt, wt_path) = workingtree.WorkingTree.open_containing(path)
380
status = StatusDialog(wt, wt_path)
381
status.connect("destroy", gtk.main_quit)
386
class cmd_gconflicts(GTKCommand):
389
Select files from the list of conflicts and run an external utility to
393
(wt, path) = workingtree.WorkingTree.open_containing('.')
395
from bzrlib.plugins.gtk.conflicts import ConflictsDialog
396
dialog = ConflictsDialog(wt)
401
class cmd_gpreferences(GTKCommand):
402
""" GTK+ preferences dialog.
407
from bzrlib.plugins.gtk.preferences import PreferencesWindow
408
dialog = PreferencesWindow()
413
class cmd_gmissing(Command):
414
""" GTK+ missing revisions dialog.
417
takes_args = ["other_branch?"]
418
def run(self, other_branch=None):
419
pygtk = import_pygtk()
422
except RuntimeError, e:
423
if str(e) == "could not open display":
426
from bzrlib.plugins.gtk.missing import MissingWindow
427
from bzrlib.branch import Branch
429
local_branch = Branch.open_containing(".")[0]
430
if other_branch is None:
431
other_branch = local_branch.get_parent()
433
if other_branch is None:
434
raise errors.BzrCommandError("No peer location known or specified.")
435
remote_branch = Branch.open_containing(other_branch)[0]
437
local_branch.lock_read()
439
remote_branch.lock_read()
441
dialog = MissingWindow(local_branch, remote_branch)
444
remote_branch.unlock()
446
local_branch.unlock()
449
class cmd_ginit(GTKCommand):
452
from initialize import InitDialog
453
dialog = InitDialog(os.path.abspath(os.path.curdir))
457
class cmd_gtags(GTKCommand):
459
br = branch.Branch.open_containing('.')[0]
461
gtk = self.open_display()
462
from tags import TagsWindow
463
window = TagsWindow(br)
485
register_command(cmd)
488
class cmd_commit_notify(GTKCommand):
489
"""Run the bzr commit notifier.
491
This is a background program which will pop up a notification on the users
492
screen when a commit occurs.
496
from notify import NotifyPopupMenu
497
gtk = self.open_display()
498
menu = NotifyPopupMenu()
499
icon = gtk.status_icon_new_from_file(os.path.join(data_path(), "bzr-icon-64.png"))
500
icon.connect('popup-menu', menu.display)
506
from bzrlib.bzrdir import BzrDir
507
from bzrlib import errors
508
from bzrlib.osutils import format_date
509
from bzrlib.transport import get_transport
510
if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
512
from bzrlib.plugins.dbus import activity
513
bus = dbus.SessionBus()
514
# get the object so we can subscribe to callbacks from it.
515
broadcast_service = bus.get_object(
516
activity.Broadcast.DBUS_NAME,
517
activity.Broadcast.DBUS_PATH)
519
def catch_branch(revision_id, urls):
520
# TODO: show all the urls, or perhaps choose the 'best'.
523
if isinstance(revision_id, unicode):
524
revision_id = revision_id.encode('utf8')
525
transport = get_transport(url)
526
a_dir = BzrDir.open_from_transport(transport)
527
branch = a_dir.open_branch()
528
revno = branch.revision_id_to_revno(revision_id)
529
revision = branch.repository.get_revision(revision_id)
530
summary = 'New revision %d in %s' % (revno, url)
531
body = 'Committer: %s\n' % revision.committer
532
body += 'Date: %s\n' % format_date(revision.timestamp,
535
body += revision.message
536
body = cgi.escape(body)
537
nw = pynotify.Notification(summary, body)
538
def start_viz(notification=None, action=None, data=None):
539
"""Start the viz program."""
540
pp = start_viz_window(branch, revision_id)
542
def start_branch(notification=None, action=None, data=None):
543
"""Start a Branch dialog"""
544
from bzrlib.plugins.gtk.branch import BranchDialog
545
bd = BranchDialog(remote_path=url)
547
nw.add_action("inspect", "Inspect", start_viz, None)
548
nw.add_action("branch", "Branch", start_branch, None)
554
broadcast_service.connect_to_signal("Revision", catch_branch,
555
dbus_interface=activity.Broadcast.DBUS_INTERFACE)
556
pynotify.init("bzr commit-notify")
559
register_command(cmd_commit_notify)
562
class cmd_gselftest(GTKCommand):
563
"""Version of selftest that displays a notification at the end"""
565
takes_args = builtins.cmd_selftest.takes_args
566
takes_options = builtins.cmd_selftest.takes_options
567
_see_also = ['selftest']
569
def run(self, *args, **kwargs):
572
default_encoding = sys.getdefaultencoding()
573
# prevent gtk from blowing up later
575
# prevent gtk from messing with default encoding
577
if sys.getdefaultencoding() != default_encoding:
579
sys.setdefaultencoding(default_encoding)
580
result = builtins.cmd_selftest().run(*args, **kwargs)
583
body = 'Selftest succeeded in "%s"' % os.getcwd()
586
body = 'Selftest failed in "%s"' % os.getcwd()
587
pynotify.init("bzr gselftest")
588
note = pynotify.Notification(cgi.escape(summary), cgi.escape(body))
589
note.set_timeout(pynotify.EXPIRES_NEVER)
593
register_command(cmd_gselftest)
597
gettext.install('olive-gtk')
600
class NoDisplayError(BzrCommandError):
601
"""gtk could not find a proper display"""
604
return "No DISPLAY. Unable to run GTK+ application."
608
from unittest import TestSuite
163
611
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]))
614
result.addTest(tests.test_suite())
173
616
if sys.getdefaultencoding() != default_encoding:
175
618
sys.setdefaultencoding(default_encoding)