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
ginit Initialise a new branch.
26
gmissing GTK+ missing revisions dialog.
27
gpreferences GTK+ preferences dialog.
29
gsend GTK+ send merge directive.
30
gstatus GTK+ status dialog.
31
gtags Manage branch tags.
32
visualise Graphically visualise this branch.
39
version_info = (0, 94, 0, 'dev', 0)
41
if version_info[3] == 'final':
42
version_string = '%d.%d.%d' % version_info[:3]
44
version_string = '%d.%d.%d%s%d' % version_info
45
__version__ = version_string
47
required_bzrlib = (1, 0)
49
def check_bzrlib_version(desired):
50
"""Check that bzrlib is compatible.
52
If version is < bzr-gtk version, assume incompatible.
54
bzrlib_version = bzrlib.version_info[:2]
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 Bazaar version %s is too old to be used with bzr-gtk'
63
' %s.' % (bzrlib.__version__, __version__))
64
raise BzrError('Version mismatch: %r, %r' % (version_info, bzrlib.version_info) )
67
if version_info[2] == "final":
68
check_bzrlib_version(required_bzrlib)
70
from bzrlib.trace import warning
71
if __name__ != 'bzrlib.plugins.gtk':
72
warning("Not running as bzrlib.plugins.gtk, things may break.")
74
from bzrlib.lazy_import import lazy_import
75
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.")
100
def set_ui_factory():
102
from ui import GtkUIFactory
104
bzrlib.ui.ui_factory = GtkUIFactory()
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 import BranchWindow
223
return BranchWindow(branch, revision, limit)
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)
246
revid = br.last_revision()
250
(revno, revid) = revision[0].in_history(br)
253
pp = start_viz_window(br, revid, limit)
254
pp.connect("destroy", lambda w: gtk.main_quit())
259
class cmd_gannotate(GTKCommand):
262
Browse changes to FILENAME line by line in a GTK+ window.
265
takes_args = ["filename", "line?"]
267
Option("all", help="Show annotations on all lines."),
268
Option("plain", help="Don't highlight annotation lines."),
269
Option("line", type=int, argname="lineno",
270
help="Jump to specified line number."),
273
aliases = ["gblame", "gpraise"]
275
def run(self, filename, all=False, plain=False, line='1', revision=None):
276
gtk = self.open_display()
281
raise BzrCommandError('Line argument ("%s") is not a number.' %
284
from annotate.gannotate import GAnnotateWindow
285
from annotate.config import GAnnotateConfig
286
from bzrlib.bzrdir import BzrDir
288
wt, br, path = BzrDir.open_containing_tree_or_branch(filename)
292
tree = br.basis_tree()
294
file_id = tree.path2id(path)
297
raise NotVersionedError(filename)
298
if revision is not None:
299
if len(revision) != 1:
300
raise BzrCommandError("Only 1 revion may be specified.")
301
revision_id = revision[0].in_history(br).rev_id
302
tree = br.repository.revision_tree(revision_id)
304
revision_id = getattr(tree, 'get_revision_id', lambda: None)()
306
window = GAnnotateWindow(all, plain)
307
window.connect("destroy", lambda w: gtk.main_quit())
308
window.set_title(path + " - gannotate")
309
config = GAnnotateConfig(window)
315
window.annotate(tree, br, file_id)
316
window.jump_to_line(line)
325
class cmd_gcommit(GTKCommand):
326
"""GTK+ commit dialog
328
Graphical user interface for committing revisions"""
334
def run(self, filename=None):
337
from commit import CommitDialog
338
from bzrlib.errors import (BzrCommandError,
345
(wt, path) = workingtree.WorkingTree.open_containing(filename)
347
except NoWorkingTree, e:
348
from dialog import error_dialog
349
error_dialog(_('Directory does not have a working tree'),
350
_('Operation aborted.'))
351
return 1 # should this be retval=3?
353
# It is a good habit to keep things locked for the duration, but it
354
# could cause difficulties if someone wants to do things in another
355
# window... We could lock_read() until we actually go to commit
356
# changes... Just a thought.
359
dlg = CommitDialog(wt)
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)
385
class cmd_gsend(GTKCommand):
386
"""GTK+ send merge directive.
390
(br, path) = branch.Branch.open_containing(".")
391
gtk = self.open_display()
392
from bzrlib.plugins.gtk.mergedirective import SendMergeDirectiveDialog
393
from StringIO import StringIO
394
dialog = SendMergeDirectiveDialog(br)
395
if dialog.run() == gtk.RESPONSE_OK:
397
outf.writelines(dialog.get_merge_directive().to_lines())
398
mail_client = br.get_config().get_mail_client()
399
mail_client.compose_merge_request(dialog.get_mail_to(), "[MERGE]",
405
class cmd_gconflicts(GTKCommand):
408
Select files from the list of conflicts and run an external utility to
412
(wt, path) = workingtree.WorkingTree.open_containing('.')
414
from bzrlib.plugins.gtk.conflicts import ConflictsDialog
415
dialog = ConflictsDialog(wt)
419
class cmd_gpreferences(GTKCommand):
420
""" GTK+ preferences dialog.
425
from bzrlib.plugins.gtk.preferences import PreferencesWindow
426
dialog = PreferencesWindow()
430
class cmd_gmissing(Command):
431
""" GTK+ missing revisions dialog.
434
takes_args = ["other_branch?"]
435
def run(self, other_branch=None):
436
pygtk = import_pygtk()
439
except RuntimeError, e:
440
if str(e) == "could not open display":
443
from bzrlib.plugins.gtk.missing import MissingWindow
444
from bzrlib.branch import Branch
446
local_branch = Branch.open_containing(".")[0]
447
if other_branch is None:
448
other_branch = local_branch.get_parent()
450
if other_branch is None:
451
raise errors.BzrCommandError("No peer location known or specified.")
452
remote_branch = Branch.open_containing(other_branch)[0]
454
local_branch.lock_read()
456
remote_branch.lock_read()
458
dialog = MissingWindow(local_branch, remote_branch)
461
remote_branch.unlock()
463
local_branch.unlock()
466
class cmd_ginit(GTKCommand):
469
from initialize import InitDialog
470
dialog = InitDialog(os.path.abspath(os.path.curdir))
474
class cmd_gtags(GTKCommand):
476
br = branch.Branch.open_containing('.')[0]
478
gtk = self.open_display()
479
from tags import TagsWindow
480
window = TagsWindow(br)
503
register_command(cmd)
506
class cmd_commit_notify(GTKCommand):
507
"""Run the bzr commit notifier.
509
This is a background program which will pop up a notification on the users
510
screen when a commit occurs.
514
from notify import NotifyPopupMenu
515
gtk = self.open_display()
516
menu = NotifyPopupMenu()
517
icon = gtk.status_icon_new_from_file(os.path.join(data_path(), "bzr-icon-64.png"))
518
icon.connect('popup-menu', menu.display)
524
from bzrlib.bzrdir import BzrDir
525
from bzrlib import errors
526
from bzrlib.osutils import format_date
527
from bzrlib.transport import get_transport
528
if getattr(dbus, 'version', (0,0,0)) >= (0,41,0):
530
from bzrlib.plugins.dbus import activity
531
bus = dbus.SessionBus()
532
# get the object so we can subscribe to callbacks from it.
533
broadcast_service = bus.get_object(
534
activity.Broadcast.DBUS_NAME,
535
activity.Broadcast.DBUS_PATH)
537
def catch_branch(revision_id, urls):
538
# TODO: show all the urls, or perhaps choose the 'best'.
541
if isinstance(revision_id, unicode):
542
revision_id = revision_id.encode('utf8')
543
transport = get_transport(url)
544
a_dir = BzrDir.open_from_transport(transport)
545
branch = a_dir.open_branch()
546
revno = branch.revision_id_to_revno(revision_id)
547
revision = branch.repository.get_revision(revision_id)
548
summary = 'New revision %d in %s' % (revno, url)
549
body = 'Committer: %s\n' % revision.committer
550
body += 'Date: %s\n' % format_date(revision.timestamp,
553
body += revision.message
554
body = cgi.escape(body)
555
nw = pynotify.Notification(summary, body)
556
def start_viz(notification=None, action=None, data=None):
557
"""Start the viz program."""
558
pp = start_viz_window(branch, revision_id)
560
def start_branch(notification=None, action=None, data=None):
561
"""Start a Branch dialog"""
562
from bzrlib.plugins.gtk.branch import BranchDialog
563
bd = BranchDialog(remote_path=url)
565
nw.add_action("inspect", "Inspect", start_viz, None)
566
nw.add_action("branch", "Branch", start_branch, None)
572
broadcast_service.connect_to_signal("Revision", catch_branch,
573
dbus_interface=activity.Broadcast.DBUS_INTERFACE)
574
pynotify.init("bzr commit-notify")
577
register_command(cmd_commit_notify)
580
class cmd_gselftest(GTKCommand):
581
"""Version of selftest that displays a notification at the end"""
583
takes_args = builtins.cmd_selftest.takes_args
584
takes_options = builtins.cmd_selftest.takes_options
585
_see_also = ['selftest']
587
def run(self, *args, **kwargs):
590
default_encoding = sys.getdefaultencoding()
591
# prevent gtk from blowing up later
593
# prevent gtk from messing with default encoding
595
if sys.getdefaultencoding() != default_encoding:
597
sys.setdefaultencoding(default_encoding)
598
result = builtins.cmd_selftest().run(*args, **kwargs)
601
body = 'Selftest succeeded in "%s"' % os.getcwd()
604
body = 'Selftest failed in "%s"' % os.getcwd()
605
pynotify.init("bzr gselftest")
606
note = pynotify.Notification(cgi.escape(summary), cgi.escape(body))
607
note.set_timeout(pynotify.EXPIRES_NEVER)
611
register_command(cmd_gselftest)
614
class cmd_test_gtk(GTKCommand):
615
"""Version of selftest that just runs the gtk test suite."""
617
takes_options = ['verbose',
618
Option('one', short_name='1',
619
help='Stop when one test fails.'),
620
Option('benchmark', help='Run the benchmarks.'),
621
Option('lsprof-timed',
622
help='Generate lsprof output for benchmarked'
623
' sections of code.'),
625
help='List the tests instead of running them.'),
626
Option('randomize', type=str, argname="SEED",
627
help='Randomize the order of tests using the given'
628
' seed or "now" for the current time.'),
630
takes_args = ['testspecs*']
632
def run(self, verbose=None, one=False, benchmark=None,
633
lsprof_timed=None, list_only=False, randomize=None,
634
testspecs_list=None):
635
from bzrlib import __path__ as bzrlib_path
636
from bzrlib.tests import selftest
638
print '%10s: %s' % ('bzrlib', bzrlib_path[0])
640
print 'No benchmarks yet'
643
test_suite_factory = bench_suite
646
# TODO: should possibly lock the history file...
647
benchfile = open(".perf_history", "at", buffering=1)
649
test_suite_factory = test_suite
654
if testspecs_list is not None:
655
pattern = '|'.join(testspecs_list)
660
result = selftest(verbose=verbose,
663
test_suite_factory=test_suite_factory,
664
lsprof_timed=lsprof_timed,
665
bench_history=benchfile,
667
random_seed=randomize,
670
if benchfile is not None:
673
register_command(cmd_test_gtk)
676
class cmd_ghandle_patch(GTKCommand):
678
takes_args = ['path']
681
from bzrlib.plugins.gtk.diff import DiffWindow, MergeDirectiveWindow
682
lines = open(path, 'rb').readlines()
684
directive = merge_directive.MergeDirective.from_lines(lines)
685
except errors.NotAMergeDirective:
686
window = DiffWindow()
687
window.set_diff_text(path, lines)
689
window = MergeDirectiveWindow(directive)
690
window.set_diff_text(path, directive.patch.splitlines(True))
692
gtk = self.open_display()
693
window.connect("destroy", gtk.main_quit)
697
register_command(cmd_ghandle_patch)
701
gettext.install('olive-gtk')
704
class NoDisplayError(BzrCommandError):
705
"""gtk could not find a proper display"""
708
return "No DISPLAY. Unable to run GTK+ application."
712
from unittest import TestSuite
715
default_encoding = sys.getdefaultencoding()
720
except errors.BzrCommandError:
722
result.addTest(tests.test_suite())
724
if sys.getdefaultencoding() != default_encoding:
726
sys.setdefaultencoding(default_encoding)