12
14
# along with this program; if not, write to the Free Software
13
15
# 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'))
17
"""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)
21
__version__ = '0.18.0'
22
version_info = tuple(int(n) for n in __version__.split('.'))
25
def check_bzrlib_version(desired):
26
"""Check that bzrlib is compatible.
28
If version is < bzr-gtk version, assume incompatible.
29
If version == bzr-gtk version, assume completely compatible
30
If version == bzr-gtk version + 1, assume compatible, with deprecations
31
Otherwise, assume incompatible.
33
desired_plus = (desired[0], desired[1]+1)
34
bzrlib_version = bzrlib.version_info[:2]
35
if bzrlib_version == desired or (bzrlib_version == desired_plus and
36
bzrlib.version_info[3] == 'dev'):
39
from bzrlib.trace import warning
41
# get the message out any way we can
42
from warnings import warn as warning
43
if bzrlib_version < desired:
44
from bzrlib.errors import BzrError
45
warning('Installed bzr version %s is too old to be used with bzr-gtk'
46
' %s.' % (bzrlib.__version__, __version__))
47
raise BzrError('Version mismatch: %r' % version_info)
49
warning('bzr-gtk is not up to date with installed bzr version %s.'
50
' \nThere should be a newer version available, e.g. %i.%i.'
51
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
52
if bzrlib_version != desired_plus:
53
raise Exception, 'Version mismatch'
56
check_bzrlib_version(version_info[:2])
58
from bzrlib.trace import warning
71
59
if __name__ != 'bzrlib.plugins.gtk':
72
from bzrlib.trace import warning
73
60
warning("Not running as bzrlib.plugins.gtk, things may break.")
62
from bzrlib.lazy_import import lazy_import
63
lazy_import(globals(), """
71
from bzrlib.commands import Command, register_command, display_command
72
from bzrlib.errors import NotVersionedError, BzrCommandError, NoSuchFile
73
from bzrlib.option import Option
81
raise errors.BzrCommandError("PyGTK not installed.")
76
86
def set_ui_factory():
77
from bzrlib.plugins.gtk.ui import GtkUIFactory
88
from ui import GtkUIFactory
79
90
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):
93
class GTKCommand(Command):
94
"""Abstract class providing GTK specific run commands."""
96
def open_display(self):
97
pygtk = import_pygtk()
100
except RuntimeError, e:
101
if str(e) == "could not open display":
108
dialog = self.get_gtk_dialog(os.path.abspath('.'))
112
class cmd_gbranch(GTKCommand):
117
def get_gtk_dialog(self, path):
118
from bzrlib.plugins.gtk.branch import BranchDialog
119
return BranchDialog(path)
122
class cmd_gcheckout(GTKCommand):
127
def get_gtk_dialog(self, path):
128
from bzrlib.plugins.gtk.checkout import CheckoutDialog
129
return CheckoutDialog(path)
133
class cmd_gpush(GTKCommand):
137
takes_args = [ "location?" ]
139
def run(self, location="."):
140
(br, path) = branch.Branch.open_containing(location)
142
from push import PushDialog
143
dialog = PushDialog(br)
148
class cmd_gdiff(GTKCommand):
149
"""Show differences in working tree in a GTK+ Window.
151
Otherwise, all changes for the tree are listed.
153
takes_args = ['filename?']
154
takes_options = ['revision']
157
def run(self, revision=None, filename=None):
159
wt = workingtree.WorkingTree.open_containing(".")[0]
163
if revision is not None:
164
if len(revision) == 1:
166
revision_id = revision[0].in_history(branch).rev_id
167
tree2 = branch.repository.revision_tree(revision_id)
168
elif len(revision) == 2:
169
revision_id_0 = revision[0].in_history(branch).rev_id
170
tree2 = branch.repository.revision_tree(revision_id_0)
171
revision_id_1 = revision[1].in_history(branch).rev_id
172
tree1 = branch.repository.revision_tree(revision_id_1)
175
tree2 = tree1.basis_tree()
177
from diff import DiffWindow
179
window = DiffWindow()
180
window.connect("destroy", gtk.main_quit)
181
window.set_diff("Working Tree", tree1, tree2)
182
if filename is not None:
183
tree_filename = wt.relpath(filename)
185
window.set_file(tree_filename)
187
if (tree1.path2id(tree_filename) is None and
188
tree2.path2id(tree_filename) is None):
189
raise NotVersionedError(filename)
190
raise BzrCommandError('No changes found for file "%s"' %
199
class cmd_visualise(Command):
200
"""Graphically visualise this branch.
202
Opens a graphical window to allow you to see the history of the branch
203
and relationships between revisions in a visual manner,
205
The default starting point is latest revision on the branch, you can
206
specify a starting point with -r revision.
210
Option('limit', "maximum number of revisions to display",
212
takes_args = [ "location?" ]
213
aliases = [ "visualize", "vis", "viz" ]
215
def run(self, location=".", revision=None, limit=None):
217
(br, path) = branch.Branch.open_containing(location)
219
br.repository.lock_read()
222
revid = br.last_revision()
226
(revno, revid) = revision[0].in_history(br)
228
from viz.branchwin import BranchWindow
232
pp.set_branch(br, revid, limit)
233
pp.connect("destroy", lambda w: gtk.main_quit())
237
br.repository.unlock()
241
class cmd_gannotate(GTKCommand):
244
Browse changes to FILENAME line by line in a GTK+ window.
247
takes_args = ["filename", "line?"]
249
Option("all", help="show annotations on all lines"),
250
Option("plain", help="don't highlight annotation lines"),
251
Option("line", type=int, argname="lineno",
252
help="jump to specified line number"),
255
aliases = ["gblame", "gpraise"]
257
def run(self, filename, all=False, plain=False, line='1', revision=None):
258
gtk = self.open_display()
263
raise BzrCommandError('Line argument ("%s") is not a number.' %
266
from annotate.gannotate import GAnnotateWindow
267
from annotate.config import GAnnotateConfig
268
from bzrlib.bzrdir import BzrDir
270
wt, br, path = BzrDir.open_containing_tree_or_branch(filename)
274
tree = br.basis_tree()
276
file_id = tree.path2id(path)
279
raise NotVersionedError(filename)
280
if revision is not None:
281
if len(revision) != 1:
282
raise BzrCommandError("Only 1 revion may be specified.")
283
revision_id = revision[0].in_history(br).rev_id
284
tree = br.repository.revision_tree(revision_id)
286
revision_id = getattr(tree, 'get_revision_id', lambda: None)()
288
window = GAnnotateWindow(all, plain)
289
window.connect("destroy", lambda w: gtk.main_quit())
290
window.set_title(path + " - gannotate")
291
config = GAnnotateConfig(window)
297
window.annotate(tree, br, file_id)
298
window.jump_to_line(line)
307
class cmd_gcommit(GTKCommand):
308
"""GTK+ commit dialog
310
Graphical user interface for committing revisions"""
316
def run(self, filename=None):
319
from commit import CommitDialog
320
from bzrlib.errors import (BzrCommandError,
327
(wt, path) = workingtree.WorkingTree.open_containing(filename)
329
except NoWorkingTree, e:
331
(br, path) = branch.Branch.open_containing(path)
333
commit = CommitDialog(wt, path, not br)
338
class cmd_gstatus(GTKCommand):
339
"""GTK+ status dialog
341
Graphical user interface for showing status
345
takes_args = ['PATH?']
348
def run(self, path='.'):
350
gtk = self.open_display()
351
from status import StatusDialog
352
(wt, wt_path) = workingtree.WorkingTree.open_containing(path)
353
status = StatusDialog(wt, wt_path)
354
status.connect("destroy", gtk.main_quit)
359
class cmd_gconflicts(GTKCommand):
364
(wt, path) = workingtree.WorkingTree.open_containing('.')
366
from bzrlib.plugins.gtk.conflicts import ConflictsDialog
367
dialog = ConflictsDialog(wt)
372
class cmd_gpreferences(GTKCommand):
373
""" GTK+ preferences dialog.
378
from bzrlib.plugins.gtk.preferences import PreferencesWindow
379
dialog = PreferencesWindow()
384
class cmd_gmissing(Command):
385
""" GTK+ missing revisions dialog.
388
takes_args = ["other_branch?"]
389
def run(self, other_branch=None):
390
pygtk = import_pygtk()
393
except RuntimeError, e:
394
if str(e) == "could not open display":
397
from bzrlib.plugins.gtk.missing import MissingWindow
398
from bzrlib.branch import Branch
400
local_branch = Branch.open_containing(".")[0]
401
if other_branch is None:
402
other_branch = local_branch.get_parent()
404
if other_branch is None:
405
raise errors.BzrCommandError("No peer location known or specified.")
406
remote_branch = Branch.open_containing(other_branch)[0]
408
local_branch.lock_read()
410
remote_branch.lock_read()
412
dialog = MissingWindow(local_branch, remote_branch)
415
remote_branch.unlock()
417
local_branch.unlock()
420
class cmd_ginit(GTKCommand):
423
from initialize import InitDialog
424
dialog = InitDialog(os.path.abspath(os.path.curdir))
428
class cmd_gtags(GTKCommand):
430
br = branch.Branch.open_containing('.')[0]
432
gtk = self.open_display()
433
from tags import TagsWindow
434
window = TagsWindow(br)
456
register_command(cmd)
459
class cmd_commit_notify(GTKCommand):
460
"""Run the bzr commit notifier.
462
This is a background program which will pop up a notification on the users
463
screen when a commit occurs.
467
from notify import NotifyPopupMenu
468
gtk = self.open_display()
469
menu = NotifyPopupMenu()
470
icon = gtk.status_icon_new_from_file("bzr-icon-64.png")
471
icon.connect('popup-menu', menu.display)
477
from bzrlib.bzrdir import BzrDir
478
from bzrlib import errors
479
from bzrlib.osutils import format_date
480
from bzrlib.transport import get_transport
481
if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
483
from bzrlib.plugins.dbus import activity
484
bus = dbus.SessionBus()
485
# get the object so we can subscribe to callbacks from it.
486
broadcast_service = bus.get_object(
487
activity.Broadcast.DBUS_NAME,
488
activity.Broadcast.DBUS_PATH)
490
def catch_branch(revision_id, urls):
491
# TODO: show all the urls, or perhaps choose the 'best'.
494
if isinstance(revision_id, unicode):
495
revision_id = revision_id.encode('utf8')
496
transport = get_transport(url)
497
a_dir = BzrDir.open_from_transport(transport)
498
branch = a_dir.open_branch()
499
revno = branch.revision_id_to_revno(revision_id)
500
revision = branch.repository.get_revision(revision_id)
501
summary = 'New revision %d in %s' % (revno, url)
502
body = 'Committer: %s\n' % revision.committer
503
body += 'Date: %s\n' % format_date(revision.timestamp,
506
body += revision.message
507
body = cgi.escape(body)
508
nw = pynotify.Notification(summary, body)
514
broadcast_service.connect_to_signal("Revision", catch_branch,
515
dbus_interface=activity.Broadcast.DBUS_INTERFACE)
516
pynotify.init("bzr commit-notify")
519
register_command(cmd_commit_notify)
523
gettext.install('olive-gtk')
526
class NoDisplayError(BzrCommandError):
527
"""gtk could not find a proper display"""
530
return "No DISPLAY. Unable to run GTK+ application."
534
from unittest import TestSuite
163
537
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]))
540
result.addTest(tests.test_suite())
173
542
if sys.getdefaultencoding() != default_encoding:
175
544
sys.setdefaultencoding(default_encoding)