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
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.19.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(), """
84
from bzrlib.commands import Command, register_command, display_command
85
from bzrlib.errors import NotVersionedError, BzrCommandError, NoSuchFile
86
from bzrlib.option import Option
94
raise errors.BzrCommandError("PyGTK not installed.")
76
99
def set_ui_factory():
77
from bzrlib.plugins.gtk.ui import GtkUIFactory
101
from ui import GtkUIFactory
79
103
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):
106
class GTKCommand(Command):
107
"""Abstract class providing GTK specific run commands."""
109
def open_display(self):
110
pygtk = import_pygtk()
113
except RuntimeError, e:
114
if str(e) == "could not open display":
121
dialog = self.get_gtk_dialog(os.path.abspath('.'))
125
class cmd_gbranch(GTKCommand):
130
def get_gtk_dialog(self, path):
131
from bzrlib.plugins.gtk.branch import BranchDialog
132
return BranchDialog(path)
135
class cmd_gcheckout(GTKCommand):
140
def get_gtk_dialog(self, path):
141
from bzrlib.plugins.gtk.checkout import CheckoutDialog
142
return CheckoutDialog(path)
146
class cmd_gpush(GTKCommand):
150
takes_args = [ "location?" ]
152
def run(self, location="."):
153
(br, path) = branch.Branch.open_containing(location)
155
from push import PushDialog
156
dialog = PushDialog(br.repository, br.last_revision(), br)
161
class cmd_gdiff(GTKCommand):
162
"""Show differences in working tree in a GTK+ Window.
164
Otherwise, all changes for the tree are listed.
166
takes_args = ['filename?']
167
takes_options = ['revision']
170
def run(self, revision=None, filename=None):
172
wt = workingtree.WorkingTree.open_containing(".")[0]
176
if revision is not None:
177
if len(revision) == 1:
179
revision_id = revision[0].in_history(branch).rev_id
180
tree2 = branch.repository.revision_tree(revision_id)
181
elif len(revision) == 2:
182
revision_id_0 = revision[0].in_history(branch).rev_id
183
tree2 = branch.repository.revision_tree(revision_id_0)
184
revision_id_1 = revision[1].in_history(branch).rev_id
185
tree1 = branch.repository.revision_tree(revision_id_1)
188
tree2 = tree1.basis_tree()
190
from diff import DiffWindow
192
window = DiffWindow()
193
window.connect("destroy", gtk.main_quit)
194
window.set_diff("Working Tree", tree1, tree2)
195
if filename is not None:
196
tree_filename = wt.relpath(filename)
198
window.set_file(tree_filename)
200
if (tree1.path2id(tree_filename) is None and
201
tree2.path2id(tree_filename) is None):
202
raise NotVersionedError(filename)
203
raise BzrCommandError('No changes found for file "%s"' %
212
def start_viz_window(branch, revision, limit=None):
213
"""Start viz on branch with revision revision.
215
:return: The viz window object.
217
from viz.branchwin import BranchWindow
220
pp.set_branch(branch, revision, limit)
221
# cleanup locks when the window is closed
222
pp.connect("destroy", lambda w: branch.unlock())
226
class cmd_visualise(Command):
227
"""Graphically visualise this branch.
229
Opens a graphical window to allow you to see the history of the branch
230
and relationships between revisions in a visual manner,
232
The default starting point is latest revision on the branch, you can
233
specify a starting point with -r revision.
237
Option('limit', "Maximum number of revisions to display.",
239
takes_args = [ "location?" ]
240
aliases = [ "visualize", "vis", "viz" ]
242
def run(self, location=".", revision=None, limit=None):
244
(br, path) = branch.Branch.open_containing(location)
248
revid = br.last_revision()
252
(revno, revid) = revision[0].in_history(br)
255
pp = start_viz_window(br, revid, limit)
256
pp.connect("destroy", lambda w: gtk.main_quit())
263
class cmd_gannotate(GTKCommand):
266
Browse changes to FILENAME line by line in a GTK+ window.
269
takes_args = ["filename", "line?"]
271
Option("all", help="Show annotations on all lines."),
272
Option("plain", help="Don't highlight annotation lines."),
273
Option("line", type=int, argname="lineno",
274
help="Jump to specified line number."),
277
aliases = ["gblame", "gpraise"]
279
def run(self, filename, all=False, plain=False, line='1', revision=None):
280
gtk = self.open_display()
285
raise BzrCommandError('Line argument ("%s") is not a number.' %
288
from annotate.gannotate import GAnnotateWindow
289
from annotate.config import GAnnotateConfig
290
from bzrlib.bzrdir import BzrDir
292
wt, br, path = BzrDir.open_containing_tree_or_branch(filename)
296
tree = br.basis_tree()
298
file_id = tree.path2id(path)
301
raise NotVersionedError(filename)
302
if revision is not None:
303
if len(revision) != 1:
304
raise BzrCommandError("Only 1 revion may be specified.")
305
revision_id = revision[0].in_history(br).rev_id
306
tree = br.repository.revision_tree(revision_id)
308
revision_id = getattr(tree, 'get_revision_id', lambda: None)()
310
window = GAnnotateWindow(all, plain)
311
window.connect("destroy", lambda w: gtk.main_quit())
312
window.set_title(path + " - gannotate")
313
config = GAnnotateConfig(window)
319
window.annotate(tree, br, file_id)
320
window.jump_to_line(line)
329
class cmd_gcommit(GTKCommand):
330
"""GTK+ commit dialog
332
Graphical user interface for committing revisions"""
338
def run(self, filename=None):
341
from commit import CommitDialog
342
from bzrlib.errors import (BzrCommandError,
349
(wt, path) = workingtree.WorkingTree.open_containing(filename)
351
except NoWorkingTree, e:
353
(br, path) = branch.Branch.open_containing(path)
355
commit = CommitDialog(wt, path, not br)
360
class cmd_gstatus(GTKCommand):
361
"""GTK+ status dialog
363
Graphical user interface for showing status
367
takes_args = ['PATH?']
370
def run(self, path='.'):
372
gtk = self.open_display()
373
from status import StatusDialog
374
(wt, wt_path) = workingtree.WorkingTree.open_containing(path)
375
status = StatusDialog(wt, wt_path)
376
status.connect("destroy", gtk.main_quit)
381
class cmd_gconflicts(GTKCommand):
386
(wt, path) = workingtree.WorkingTree.open_containing('.')
388
from bzrlib.plugins.gtk.conflicts import ConflictsDialog
389
dialog = ConflictsDialog(wt)
394
class cmd_gpreferences(GTKCommand):
395
""" GTK+ preferences dialog.
400
from bzrlib.plugins.gtk.preferences import PreferencesWindow
401
dialog = PreferencesWindow()
406
class cmd_gmissing(Command):
407
""" GTK+ missing revisions dialog.
410
takes_args = ["other_branch?"]
411
def run(self, other_branch=None):
412
pygtk = import_pygtk()
415
except RuntimeError, e:
416
if str(e) == "could not open display":
419
from bzrlib.plugins.gtk.missing import MissingWindow
420
from bzrlib.branch import Branch
422
local_branch = Branch.open_containing(".")[0]
423
if other_branch is None:
424
other_branch = local_branch.get_parent()
426
if other_branch is None:
427
raise errors.BzrCommandError("No peer location known or specified.")
428
remote_branch = Branch.open_containing(other_branch)[0]
430
local_branch.lock_read()
432
remote_branch.lock_read()
434
dialog = MissingWindow(local_branch, remote_branch)
437
remote_branch.unlock()
439
local_branch.unlock()
442
class cmd_ginit(GTKCommand):
445
from initialize import InitDialog
446
dialog = InitDialog(os.path.abspath(os.path.curdir))
450
class cmd_gtags(GTKCommand):
452
br = branch.Branch.open_containing('.')[0]
454
gtk = self.open_display()
455
from tags import TagsWindow
456
window = TagsWindow(br)
478
register_command(cmd)
481
class cmd_commit_notify(GTKCommand):
482
"""Run the bzr commit notifier.
484
This is a background program which will pop up a notification on the users
485
screen when a commit occurs.
489
from notify import NotifyPopupMenu
490
gtk = self.open_display()
491
menu = NotifyPopupMenu()
492
icon = gtk.status_icon_new_from_file("bzr-icon-64.png")
493
icon.connect('popup-menu', menu.display)
499
from bzrlib.bzrdir import BzrDir
500
from bzrlib import errors
501
from bzrlib.osutils import format_date
502
from bzrlib.transport import get_transport
503
if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
505
from bzrlib.plugins.dbus import activity
506
bus = dbus.SessionBus()
507
# get the object so we can subscribe to callbacks from it.
508
broadcast_service = bus.get_object(
509
activity.Broadcast.DBUS_NAME,
510
activity.Broadcast.DBUS_PATH)
512
def catch_branch(revision_id, urls):
513
# TODO: show all the urls, or perhaps choose the 'best'.
516
if isinstance(revision_id, unicode):
517
revision_id = revision_id.encode('utf8')
518
transport = get_transport(url)
519
a_dir = BzrDir.open_from_transport(transport)
520
branch = a_dir.open_branch()
521
revno = branch.revision_id_to_revno(revision_id)
522
revision = branch.repository.get_revision(revision_id)
523
summary = 'New revision %d in %s' % (revno, url)
524
body = 'Committer: %s\n' % revision.committer
525
body += 'Date: %s\n' % format_date(revision.timestamp,
528
body += revision.message
529
body = cgi.escape(body)
530
nw = pynotify.Notification(summary, body)
531
def start_viz(notification=None, action=None, data=None):
532
"""Start the viz program."""
533
pp = start_viz_window(branch, revision_id)
535
def start_branch(notification=None, action=None, data=None):
536
"""Start a Branch dialog"""
537
from bzrlib.plugins.gtk.branch import BranchDialog
538
bd = BranchDialog(remote_path=url)
540
nw.add_action("inspect", "Inspect", start_viz, None)
541
nw.add_action("branch", "Branch", start_branch, None)
547
broadcast_service.connect_to_signal("Revision", catch_branch,
548
dbus_interface=activity.Broadcast.DBUS_INTERFACE)
549
pynotify.init("bzr commit-notify")
552
register_command(cmd_commit_notify)
556
gettext.install('olive-gtk')
559
class NoDisplayError(BzrCommandError):
560
"""gtk could not find a proper display"""
563
return "No DISPLAY. Unable to run GTK+ application."
567
from unittest import TestSuite
163
570
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]))
573
result.addTest(tests.test_suite())
173
575
if sys.getdefaultencoding() != default_encoding:
175
577
sys.setdefaultencoding(default_encoding)