1
# This program is free software; you can redistribute it and/or modify
2
# it under the terms of the GNU General Public License as published by
3
# the Free Software Foundation; either version 2 of the License, or
4
# (at your option) any later version.
6
# This program is distributed in the hope that it will be useful,
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
# GNU General Public License for more details.
11
# You should have received a copy of the GNU General Public License
12
# along with this program; if not, write to the Free Software
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
"""Graphical support for Bazaar using GTK.
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.
25
ghandle-patch Display and optionally merge a merge directive or patch.
26
ginit Initialise a new branch.
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.
40
version_info = (0, 94, 0, 'dev', 0)
42
if version_info[3] == 'final':
43
version_string = '%d.%d.%d' % version_info[:3]
45
version_string = '%d.%d.%d%s%d' % version_info
46
__version__ = version_string
48
required_bzrlib = (1, 0)
50
def check_bzrlib_version(desired):
51
"""Check that bzrlib is compatible.
53
If version is < bzr-gtk version, assume incompatible.
55
bzrlib_version = bzrlib.version_info[:2]
57
from bzrlib.trace import warning
59
# get the message out any way we can
60
from warnings import warn as warning
61
if bzrlib_version < desired:
62
from bzrlib.errors import BzrError
63
warning('Installed Bazaar version %s is too old to be used with bzr-gtk'
64
' %s.' % (bzrlib.__version__, __version__))
65
raise BzrError('Version mismatch: %r, %r' % (version_info, bzrlib.version_info) )
68
if version_info[2] == "final":
69
check_bzrlib_version(required_bzrlib)
71
from bzrlib.trace import warning
72
if __name__ != 'bzrlib.plugins.gtk':
73
warning("Not running as bzrlib.plugins.gtk, things may break.")
75
from bzrlib.lazy_import import lazy_import
76
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
def set_ui_factory():
103
from ui import GtkUIFactory
105
bzrlib.ui.ui_factory = GtkUIFactory()
109
return os.path.dirname(__file__)
112
class GTKCommand(Command):
113
"""Abstract class providing GTK specific run commands."""
115
def open_display(self):
116
pygtk = import_pygtk()
119
except RuntimeError, e:
120
if str(e) == "could not open display":
127
dialog = self.get_gtk_dialog(os.path.abspath('.'))
131
class cmd_gbranch(GTKCommand):
136
def get_gtk_dialog(self, path):
137
from bzrlib.plugins.gtk.branch import BranchDialog
138
return BranchDialog(path)
141
class cmd_gcheckout(GTKCommand):
146
def get_gtk_dialog(self, path):
147
from bzrlib.plugins.gtk.checkout import CheckoutDialog
148
return CheckoutDialog(path)
152
class cmd_gpush(GTKCommand):
156
takes_args = [ "location?" ]
158
def run(self, location="."):
159
(br, path) = branch.Branch.open_containing(location)
161
from push import PushDialog
162
dialog = PushDialog(br.repository, br.last_revision(), br)
167
class cmd_gdiff(GTKCommand):
168
"""Show differences in working tree in a GTK+ Window.
170
Otherwise, all changes for the tree are listed.
172
takes_args = ['filename?']
173
takes_options = ['revision']
176
def run(self, revision=None, filename=None):
178
wt = workingtree.WorkingTree.open_containing(".")[0]
182
if revision is not None:
183
if len(revision) == 1:
185
revision_id = revision[0].in_history(branch).rev_id
186
tree2 = branch.repository.revision_tree(revision_id)
187
elif len(revision) == 2:
188
revision_id_0 = revision[0].in_history(branch).rev_id
189
tree2 = branch.repository.revision_tree(revision_id_0)
190
revision_id_1 = revision[1].in_history(branch).rev_id
191
tree1 = branch.repository.revision_tree(revision_id_1)
194
tree2 = tree1.basis_tree()
196
from diff import DiffWindow
198
window = DiffWindow()
199
window.connect("destroy", gtk.main_quit)
200
window.set_diff("Working Tree", tree1, tree2)
201
if filename is not None:
202
tree_filename = wt.relpath(filename)
204
window.set_file(tree_filename)
206
if (tree1.path2id(tree_filename) is None and
207
tree2.path2id(tree_filename) is None):
208
raise NotVersionedError(filename)
209
raise BzrCommandError('No changes found for file "%s"' %
218
def start_viz_window(branch, revision, limit=None):
219
"""Start viz on branch with revision revision.
221
:return: The viz window object.
223
from viz import BranchWindow
224
return BranchWindow(branch, revision, limit)
227
class cmd_visualise(Command):
228
"""Graphically visualise this branch.
230
Opens a graphical window to allow you to see the history of the branch
231
and relationships between revisions in a visual manner,
233
The default starting point is latest revision on the branch, you can
234
specify a starting point with -r revision.
238
Option('limit', "Maximum number of revisions to display.",
240
takes_args = [ "location?" ]
241
aliases = [ "visualize", "vis", "viz" ]
243
def run(self, location=".", revision=None, limit=None):
245
(br, path) = branch.Branch.open_containing(location)
247
revid = br.last_revision()
251
(revno, revid) = revision[0].in_history(br)
254
pp = start_viz_window(br, revid, limit)
255
pp.connect("destroy", lambda w: gtk.main_quit())
260
class cmd_gannotate(GTKCommand):
263
Browse changes to FILENAME line by line in a GTK+ window.
266
takes_args = ["filename", "line?"]
268
Option("all", help="Show annotations on all lines."),
269
Option("plain", help="Don't highlight annotation lines."),
270
Option("line", type=int, argname="lineno",
271
help="Jump to specified line number."),
274
aliases = ["gblame", "gpraise"]
276
def run(self, filename, all=False, plain=False, line='1', revision=None):
277
gtk = self.open_display()
282
raise BzrCommandError('Line argument ("%s") is not a number.' %
285
from annotate.gannotate import GAnnotateWindow
286
from annotate.config import GAnnotateConfig
287
from bzrlib.bzrdir import BzrDir
289
wt, br, path = BzrDir.open_containing_tree_or_branch(filename)
293
tree = br.basis_tree()
295
file_id = tree.path2id(path)
298
raise NotVersionedError(filename)
299
if revision is not None:
300
if len(revision) != 1:
301
raise BzrCommandError("Only 1 revion may be specified.")
302
revision_id = revision[0].in_history(br).rev_id
303
tree = br.repository.revision_tree(revision_id)
305
revision_id = getattr(tree, 'get_revision_id', lambda: None)()
307
window = GAnnotateWindow(all, plain)
308
window.connect("destroy", lambda w: gtk.main_quit())
309
window.set_title(path + " - gannotate")
310
config = GAnnotateConfig(window)
316
window.annotate(tree, br, file_id)
317
window.jump_to_line(line)
326
class cmd_gcommit(GTKCommand):
327
"""GTK+ commit dialog
329
Graphical user interface for committing revisions"""
335
def run(self, filename=None):
338
from commit import CommitDialog
339
from bzrlib.errors import (BzrCommandError,
346
(wt, path) = workingtree.WorkingTree.open_containing(filename)
348
except NoWorkingTree, e:
349
from dialog import error_dialog
350
error_dialog(_('Directory does not have a working tree'),
351
_('Operation aborted.'))
352
return 1 # should this be retval=3?
354
# It is a good habit to keep things locked for the duration, but it
355
# could cause difficulties if someone wants to do things in another
356
# window... We could lock_read() until we actually go to commit
357
# changes... Just a thought.
360
dlg = CommitDialog(wt)
366
class cmd_gstatus(GTKCommand):
367
"""GTK+ status dialog
369
Graphical user interface for showing status
373
takes_args = ['PATH?']
376
def run(self, path='.'):
378
gtk = self.open_display()
379
from status import StatusDialog
380
(wt, wt_path) = workingtree.WorkingTree.open_containing(path)
381
status = StatusDialog(wt, wt_path)
382
status.connect("destroy", gtk.main_quit)
386
class cmd_gsend(GTKCommand):
387
"""GTK+ send merge directive.
391
(br, path) = branch.Branch.open_containing(".")
392
gtk = self.open_display()
393
from bzrlib.plugins.gtk.mergedirective import SendMergeDirectiveDialog
394
from StringIO import StringIO
395
dialog = SendMergeDirectiveDialog(br)
396
if dialog.run() == gtk.RESPONSE_OK:
398
outf.writelines(dialog.get_merge_directive().to_lines())
399
mail_client = br.get_config().get_mail_client()
400
mail_client.compose_merge_request(dialog.get_mail_to(), "[MERGE]",
406
class cmd_gconflicts(GTKCommand):
409
Select files from the list of conflicts and run an external utility to
413
(wt, path) = workingtree.WorkingTree.open_containing('.')
415
from bzrlib.plugins.gtk.conflicts import ConflictsDialog
416
dialog = ConflictsDialog(wt)
420
class cmd_gpreferences(GTKCommand):
421
""" GTK+ preferences dialog.
426
from bzrlib.plugins.gtk.preferences import PreferencesWindow
427
dialog = PreferencesWindow()
431
class cmd_gmissing(Command):
432
""" GTK+ missing revisions dialog.
435
takes_args = ["other_branch?"]
436
def run(self, other_branch=None):
437
pygtk = import_pygtk()
440
except RuntimeError, e:
441
if str(e) == "could not open display":
444
from bzrlib.plugins.gtk.missing import MissingWindow
445
from bzrlib.branch import Branch
447
local_branch = Branch.open_containing(".")[0]
448
if other_branch is None:
449
other_branch = local_branch.get_parent()
451
if other_branch is None:
452
raise errors.BzrCommandError("No peer location known or specified.")
453
remote_branch = Branch.open_containing(other_branch)[0]
455
local_branch.lock_read()
457
remote_branch.lock_read()
459
dialog = MissingWindow(local_branch, remote_branch)
462
remote_branch.unlock()
464
local_branch.unlock()
467
class cmd_ginit(GTKCommand):
470
from initialize import InitDialog
471
dialog = InitDialog(os.path.abspath(os.path.curdir))
475
class cmd_gtags(GTKCommand):
477
br = branch.Branch.open_containing('.')[0]
479
gtk = self.open_display()
480
from tags import TagsWindow
481
window = TagsWindow(br)
504
register_command(cmd)
507
class cmd_commit_notify(GTKCommand):
508
"""Run the bzr commit notifier.
510
This is a background program which will pop up a notification on the users
511
screen when a commit occurs.
515
from notify import NotifyPopupMenu
516
gtk = self.open_display()
517
menu = NotifyPopupMenu()
518
icon = gtk.status_icon_new_from_file(os.path.join(data_path(), "bzr-icon-64.png"))
519
icon.connect('popup-menu', menu.display)
525
from bzrlib.bzrdir import BzrDir
526
from bzrlib import errors
527
from bzrlib.osutils import format_date
528
from bzrlib.transport import get_transport
529
if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
531
from bzrlib.plugins.dbus import activity
532
bus = dbus.SessionBus()
533
# get the object so we can subscribe to callbacks from it.
534
broadcast_service = bus.get_object(
535
activity.Broadcast.DBUS_NAME,
536
activity.Broadcast.DBUS_PATH)
538
def catch_branch(revision_id, urls):
539
# TODO: show all the urls, or perhaps choose the 'best'.
542
if isinstance(revision_id, unicode):
543
revision_id = revision_id.encode('utf8')
544
transport = get_transport(url)
545
a_dir = BzrDir.open_from_transport(transport)
546
branch = a_dir.open_branch()
547
revno = branch.revision_id_to_revno(revision_id)
548
revision = branch.repository.get_revision(revision_id)
549
summary = 'New revision %d in %s' % (revno, url)
550
body = 'Committer: %s\n' % revision.committer
551
body += 'Date: %s\n' % format_date(revision.timestamp,
554
body += revision.message
555
body = cgi.escape(body)
556
nw = pynotify.Notification(summary, body)
557
def start_viz(notification=None, action=None, data=None):
558
"""Start the viz program."""
559
pp = start_viz_window(branch, revision_id)
561
def start_branch(notification=None, action=None, data=None):
562
"""Start a Branch dialog"""
563
from bzrlib.plugins.gtk.branch import BranchDialog
564
bd = BranchDialog(remote_path=url)
566
nw.add_action("inspect", "Inspect", start_viz, None)
567
nw.add_action("branch", "Branch", start_branch, None)
573
broadcast_service.connect_to_signal("Revision", catch_branch,
574
dbus_interface=activity.Broadcast.DBUS_INTERFACE)
575
pynotify.init("bzr commit-notify")
578
register_command(cmd_commit_notify)
581
class cmd_gselftest(GTKCommand):
582
"""Version of selftest that displays a notification at the end"""
584
takes_args = builtins.cmd_selftest.takes_args
585
takes_options = builtins.cmd_selftest.takes_options
586
_see_also = ['selftest']
588
def run(self, *args, **kwargs):
591
default_encoding = sys.getdefaultencoding()
592
# prevent gtk from blowing up later
594
# prevent gtk from messing with default encoding
596
if sys.getdefaultencoding() != default_encoding:
598
sys.setdefaultencoding(default_encoding)
599
result = builtins.cmd_selftest().run(*args, **kwargs)
602
body = 'Selftest succeeded in "%s"' % os.getcwd()
605
body = 'Selftest failed in "%s"' % os.getcwd()
606
pynotify.init("bzr gselftest")
607
note = pynotify.Notification(cgi.escape(summary), cgi.escape(body))
608
note.set_timeout(pynotify.EXPIRES_NEVER)
612
register_command(cmd_gselftest)
615
class cmd_test_gtk(GTKCommand):
616
"""Version of selftest that just runs the gtk test suite."""
618
takes_options = ['verbose',
619
Option('one', short_name='1',
620
help='Stop when one test fails.'),
621
Option('benchmark', help='Run the benchmarks.'),
622
Option('lsprof-timed',
623
help='Generate lsprof output for benchmarked'
624
' sections of code.'),
626
help='List the tests instead of running them.'),
627
Option('randomize', type=str, argname="SEED",
628
help='Randomize the order of tests using the given'
629
' seed or "now" for the current time.'),
631
takes_args = ['testspecs*']
633
def run(self, verbose=None, one=False, benchmark=None,
634
lsprof_timed=None, list_only=False, randomize=None,
635
testspecs_list=None):
636
from bzrlib import __path__ as bzrlib_path
637
from bzrlib.tests import selftest
639
print '%10s: %s' % ('bzrlib', bzrlib_path[0])
641
print 'No benchmarks yet'
644
test_suite_factory = bench_suite
647
# TODO: should possibly lock the history file...
648
benchfile = open(".perf_history", "at", buffering=1)
650
test_suite_factory = test_suite
655
if testspecs_list is not None:
656
pattern = '|'.join(testspecs_list)
661
result = selftest(verbose=verbose,
664
test_suite_factory=test_suite_factory,
665
lsprof_timed=lsprof_timed,
666
bench_history=benchfile,
668
random_seed=randomize,
671
if benchfile is not None:
674
register_command(cmd_test_gtk)
677
class cmd_ghandle_patch(GTKCommand):
678
"""Display a patch or merge directive, possibly merging.
680
This is a helper, meant to be launched from other programs like browsers
681
or email clients. Since these programs often do not allow parameters to
682
be provided, a "handle-patch" script is included.
685
takes_args = ['path']
688
from bzrlib.plugins.gtk.diff import DiffWindow, MergeDirectiveWindow
689
lines = open(path, 'rb').readlines()
691
directive = merge_directive.MergeDirective.from_lines(lines)
692
except errors.NotAMergeDirective:
693
window = DiffWindow()
694
window.set_diff_text(path, lines)
696
window = MergeDirectiveWindow(directive)
697
window.set_diff_text(path, directive.patch.splitlines(True))
699
gtk = self.open_display()
700
window.connect("destroy", gtk.main_quit)
704
register_command(cmd_ghandle_patch)
708
gettext.install('olive-gtk')
711
class NoDisplayError(BzrCommandError):
712
"""gtk could not find a proper display"""
715
return "No DISPLAY. Unable to run GTK+ application."
719
from unittest import TestSuite
722
default_encoding = sys.getdefaultencoding()
727
except errors.BzrCommandError:
729
result.addTest(tests.test_suite())
731
if sys.getdefaultencoding() != default_encoding:
733
sys.setdefaultencoding(default_encoding)