14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30
from bzrlib import errors, osutils
31
from bzrlib.trace import mutter
32
from bzrlib.util import bencode
34
from dialog import error_dialog, question_dialog
35
from errors import show_bzr_error
19
from gi.repository import Gdk
20
from gi.repository import Gtk
21
from gi.repository import GObject
22
from gi.repository import Pango
30
from bzrlib import bencode
32
from bzrlib.util import bencode
34
from bzrlib.plugins.gtk.dialog import question_dialog
35
from bzrlib.plugins.gtk.errors import show_bzr_error
36
from bzrlib.plugins.gtk.i18n import _i18n
99
class CommitDialog(gtk.Dialog):
100
_newline_variants_re = re.compile(r'\r\n?')
101
def _sanitize_and_decode_message(utf8_message):
102
"""Turn a utf-8 message into a sanitized Unicode message."""
103
fixed_newline = _newline_variants_re.sub('\n', utf8_message)
104
return fixed_newline.decode('utf-8')
107
class CommitDialog(Gtk.Dialog):
100
108
"""Implementation of Commit."""
102
110
def __init__(self, wt, selected=None, parent=None):
103
gtk.Dialog.__init__(self, title="Commit - Olive",
106
buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
111
super(CommitDialog, self).__init__(
112
title="Commit to %s" % wt.basedir, parent=parent, flags=0)
113
self.connect('delete-event', self._on_delete_window)
107
114
self._question_dialog = question_dialog
116
self.set_type_hint(Gdk.WindowTypeHint.NORMAL)
110
119
# TODO: Do something with this value, it is used by Olive
111
120
# It used to set all changes but this one to False
297
313
self._hpane.set_position(300)
299
315
def _construct_accelerators(self):
300
group = gtk.AccelGroup()
301
group.connect_group(gtk.gdk.keyval_from_name('N'),
302
gtk.gdk.CONTROL_MASK, 0, self._on_accel_next)
316
group = Gtk.AccelGroup()
317
group.connect(Gdk.keyval_from_name('N'),
318
Gdk.ModifierType.CONTROL_MASK, 0, self._on_accel_next)
303
319
self.add_accel_group(group)
321
# ignore the escape key (avoid closing the window)
322
self.connect_object('close', self.emit_stop_by_name, 'close')
305
324
def _construct_left_pane(self):
306
self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
325
self._left_pane_box = Gtk.VBox(homogeneous=False, spacing=5)
307
326
self._construct_file_list()
308
327
self._construct_pending_list()
310
self._check_local = gtk.CheckButton(_("_Only commit locally"),
329
self._check_local = Gtk.CheckButton(_i18n("_Only commit locally"),
311
330
use_underline=True)
312
self._left_pane_box.pack_end(self._check_local, False, False)
331
self._left_pane_box.pack_end(self._check_local, False, False, 0)
313
332
self._check_local.set_active(False)
315
334
self._hpane.pack1(self._left_pane_box, resize=False, shrink=False)
334
353
self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
336
355
def _construct_action_pane(self):
337
self._button_commit = gtk.Button(_("Comm_it"), use_underline=True)
356
self._button_cancel = Gtk.Button(stock=Gtk.STOCK_CANCEL)
357
self._button_cancel.connect('clicked', self._on_cancel_clicked)
358
self._button_cancel.show()
359
self.get_action_area().pack_end(
360
self._button_cancel, True, True, 0)
361
self._button_commit = Gtk.Button(_i18n("Comm_it"), use_underline=True)
338
362
self._button_commit.connect('clicked', self._on_commit_clicked)
339
self._button_commit.set_flags(gtk.CAN_DEFAULT)
363
self._button_commit.set_can_default(True)
340
364
self._button_commit.show()
341
self.action_area.pack_end(self._button_commit)
365
self.get_action_area().pack_end(
366
self._button_commit, True, True, 0)
342
367
self._button_commit.grab_default()
344
369
def _add_to_right_table(self, widget, weight, expanding=False):
359
384
self._right_pane_table_row = end_row
361
386
def _construct_file_list(self):
362
self._files_box = gtk.VBox(homogeneous=False, spacing=0)
363
file_label = gtk.Label(_('Files'))
387
self._files_box = Gtk.VBox(homogeneous=False, spacing=0)
388
file_label = Gtk.Label(label=_i18n('Files'))
364
389
# file_label.show()
365
self._files_box.pack_start(file_label, expand=False)
390
self._files_box.pack_start(file_label, False, True, 0)
367
self._commit_all_files_radio = gtk.RadioButton(
368
None, _("Commit all changes"))
369
self._files_box.pack_start(self._commit_all_files_radio, expand=False)
392
self._commit_all_files_radio = Gtk.RadioButton.new_with_label(
393
None, _i18n("Commit all changes"))
394
self._files_box.pack_start(self._commit_all_files_radio, False, True, 0)
370
395
self._commit_all_files_radio.show()
371
396
self._commit_all_files_radio.connect('toggled',
372
397
self._toggle_commit_selection)
373
self._commit_selected_radio = gtk.RadioButton(
374
self._commit_all_files_radio, _("Only commit selected changes"))
375
self._files_box.pack_start(self._commit_selected_radio, expand=False)
398
self._commit_selected_radio = Gtk.RadioButton.new_with_label_from_widget(
399
self._commit_all_files_radio, _i18n("Only commit selected changes"))
400
self._files_box.pack_start(self._commit_selected_radio, False, True, 0)
376
401
self._commit_selected_radio.show()
377
402
self._commit_selected_radio.connect('toggled',
378
403
self._toggle_commit_selection)
379
404
if self._pending:
380
self._commit_all_files_radio.set_label(_('Commit all changes*'))
405
self._commit_all_files_radio.set_label(_i18n('Commit all changes*'))
381
406
self._commit_all_files_radio.set_sensitive(False)
382
407
self._commit_selected_radio.set_sensitive(False)
384
scroller = gtk.ScrolledWindow()
385
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
386
self._treeview_files = gtk.TreeView()
409
scroller = Gtk.ScrolledWindow()
410
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
411
self._treeview_files = Gtk.TreeView()
387
412
self._treeview_files.show()
388
413
scroller.add(self._treeview_files)
389
scroller.set_shadow_type(gtk.SHADOW_IN)
414
scroller.set_shadow_type(Gtk.ShadowType.IN)
391
self._files_box.pack_start(scroller,
392
expand=True, fill=True)
416
self._files_box.pack_start(scroller, True, True, 0)
393
417
self._files_box.show()
394
self._left_pane_box.pack_start(self._files_box)
418
self._left_pane_box.pack_start(self._files_box, True, True, 0)
396
420
# Keep note that all strings stored in a ListStore must be UTF-8
397
421
# strings. GTK does not support directly setting and restoring Unicode
399
liststore = gtk.ListStore(
400
gobject.TYPE_STRING, # [0] file_id
401
gobject.TYPE_STRING, # [1] real path
402
gobject.TYPE_BOOLEAN, # [2] checkbox
403
gobject.TYPE_STRING, # [3] display path
404
gobject.TYPE_STRING, # [4] changes type
405
gobject.TYPE_STRING, # [5] commit message
423
liststore = Gtk.ListStore(
424
GObject.TYPE_STRING, # [0] file_id
425
GObject.TYPE_STRING, # [1] real path
426
GObject.TYPE_BOOLEAN, # [2] checkbox
427
GObject.TYPE_STRING, # [3] display path
428
GObject.TYPE_STRING, # [4] changes type
429
GObject.TYPE_STRING, # [5] commit message
407
431
self._files_store = liststore
408
432
self._treeview_files.set_model(liststore)
409
crt = gtk.CellRendererToggle()
433
crt = Gtk.CellRendererToggle()
410
434
crt.set_property('activatable', not bool(self._pending))
411
435
crt.connect("toggled", self._toggle_commit, self._files_store)
412
436
if self._pending:
437
name = _i18n('Commit*')
416
commit_col = gtk.TreeViewColumn(name, crt, active=2)
439
name = _i18n('Commit')
440
commit_col = Gtk.TreeViewColumn(name, crt, active=2)
417
441
commit_col.set_visible(False)
418
442
self._treeview_files.append_column(commit_col)
419
self._treeview_files.append_column(gtk.TreeViewColumn(_('Path'),
420
gtk.CellRendererText(), text=3))
421
self._treeview_files.append_column(gtk.TreeViewColumn(_('Type'),
422
gtk.CellRendererText(), text=4))
443
self._treeview_files.append_column(Gtk.TreeViewColumn(_i18n('Path'),
444
Gtk.CellRendererText(), text=3))
445
self._treeview_files.append_column(Gtk.TreeViewColumn(_i18n('Type'),
446
Gtk.CellRendererText(), text=4))
423
447
self._treeview_files.connect('cursor-changed',
424
448
self._on_treeview_files_cursor_changed)
440
464
checked_col.set_visible(False)
442
466
checked_col.set_visible(True)
443
renderer = checked_col.get_cell_renderers()[0]
467
renderer = checked_col.get_cells()[0]
444
468
renderer.set_property('activatable', not all_files)
446
470
def _construct_pending_list(self):
447
471
# Pending information defaults to hidden, we put it all in 1 box, so
448
472
# that we can show/hide all of them at once
449
self._pending_box = gtk.VBox()
473
self._pending_box = Gtk.VBox()
450
474
self._pending_box.hide()
452
pending_message = gtk.Label()
476
pending_message = Gtk.Label()
453
477
pending_message.set_markup(
454
_('<i>* Cannot select specific files when merging</i>'))
455
self._pending_box.pack_start(pending_message, expand=False, padding=5)
478
_i18n('<i>* Cannot select specific files when merging</i>'))
479
self._pending_box.pack_start(pending_message, False, True, 5)
456
480
pending_message.show()
458
pending_label = gtk.Label(_('Pending Revisions'))
459
self._pending_box.pack_start(pending_label, expand=False, padding=0)
482
pending_label = Gtk.Label(label=_i18n('Pending Revisions'))
483
self._pending_box.pack_start(pending_label, False, True, 0)
460
484
pending_label.show()
462
scroller = gtk.ScrolledWindow()
463
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
464
self._treeview_pending = gtk.TreeView()
486
scroller = Gtk.ScrolledWindow()
487
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
488
self._treeview_pending = Gtk.TreeView()
465
489
scroller.add(self._treeview_pending)
466
scroller.set_shadow_type(gtk.SHADOW_IN)
490
scroller.set_shadow_type(Gtk.ShadowType.IN)
468
self._pending_box.pack_start(scroller,
469
expand=True, fill=True, padding=5)
492
self._pending_box.pack_start(scroller, True, True, 5)
470
493
self._treeview_pending.show()
471
self._left_pane_box.pack_start(self._pending_box)
494
self._left_pane_box.pack_start(self._pending_box, True, True, 0)
473
liststore = gtk.ListStore(gobject.TYPE_STRING, # revision_id
474
gobject.TYPE_STRING, # date
475
gobject.TYPE_STRING, # committer
476
gobject.TYPE_STRING, # summary
496
liststore = Gtk.ListStore(GObject.TYPE_STRING, # revision_id
497
GObject.TYPE_STRING, # date
498
GObject.TYPE_STRING, # committer
499
GObject.TYPE_STRING, # summary
478
501
self._pending_store = liststore
479
502
self._treeview_pending.set_model(liststore)
480
self._treeview_pending.append_column(gtk.TreeViewColumn(_('Date'),
481
gtk.CellRendererText(), text=1))
482
self._treeview_pending.append_column(gtk.TreeViewColumn(_('Committer'),
483
gtk.CellRendererText(), text=2))
484
self._treeview_pending.append_column(gtk.TreeViewColumn(_('Summary'),
485
gtk.CellRendererText(), text=3))
503
self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Date'),
504
Gtk.CellRendererText(), text=1))
505
self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Committer'),
506
Gtk.CellRendererText(), text=2))
507
self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Summary'),
508
Gtk.CellRendererText(), text=3))
487
510
def _construct_diff_view(self):
488
from diff import DiffView
511
from bzrlib.plugins.gtk.diff import DiffView
490
513
# TODO: jam 2007-10-30 The diff label is currently disabled. If we
491
514
# decide that we really don't ever want to display it, we should
492
515
# actually remove it, and other references to it, along with the
493
516
# tests that it is set properly.
494
self._diff_label = gtk.Label(_('Diff for whole tree'))
517
self._diff_label = Gtk.Label(label=_i18n('Diff for whole tree'))
495
518
self._diff_label.set_alignment(0, 0)
496
519
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
497
520
self._add_to_right_table(self._diff_label, 1, False)
502
525
self._diff_view.show()
504
527
def _construct_file_message(self):
505
scroller = gtk.ScrolledWindow()
506
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
528
scroller = Gtk.ScrolledWindow()
529
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
508
self._file_message_text_view = gtk.TextView()
531
self._file_message_text_view = Gtk.TextView()
509
532
scroller.add(self._file_message_text_view)
510
scroller.set_shadow_type(gtk.SHADOW_IN)
533
scroller.set_shadow_type(Gtk.ShadowType.IN)
513
self._file_message_text_view.modify_font(pango.FontDescription("Monospace"))
514
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
536
self._file_message_text_view.modify_font(Pango.FontDescription("Monospace"))
537
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
515
538
self._file_message_text_view.set_accepts_tab(False)
516
539
self._file_message_text_view.show()
518
self._file_message_expander = gtk.Expander(_('File commit message'))
541
self._file_message_expander = Gtk.Expander(
542
label=_i18n('File commit message'))
519
543
self._file_message_expander.set_expanded(True)
520
544
self._file_message_expander.add(scroller)
521
545
self._add_to_right_table(self._file_message_expander, 1, False)
522
546
self._file_message_expander.show()
524
548
def _construct_global_message(self):
525
self._global_message_label = gtk.Label(_('Global Commit Message'))
526
self._global_message_label.set_markup(_('<b>Global Commit Message</b>'))
549
self._global_message_label = Gtk.Label(label=_i18n('Global Commit Message'))
550
self._global_message_label.set_markup(
551
_i18n('<b>Global Commit Message</b>'))
527
552
self._global_message_label.set_alignment(0, 0)
528
553
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
529
554
self._add_to_right_table(self._global_message_label, 1, False)
530
555
# Can we remove the spacing between the label and the box?
531
556
self._global_message_label.show()
533
scroller = gtk.ScrolledWindow()
534
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
558
scroller = Gtk.ScrolledWindow()
559
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
536
self._global_message_text_view = gtk.TextView()
537
self._global_message_text_view.modify_font(pango.FontDescription("Monospace"))
561
self._global_message_text_view = Gtk.TextView()
562
self._set_global_commit_message(self._saved_commit_messages_manager.get()[0])
563
self._global_message_text_view.modify_font(Pango.FontDescription("Monospace"))
538
564
scroller.add(self._global_message_text_view)
539
scroller.set_shadow_type(gtk.SHADOW_IN)
565
scroller.set_shadow_type(Gtk.ShadowType.IN)
541
567
self._add_to_right_table(scroller, 2, True)
542
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
568
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
543
569
self._file_message_text_view.set_accepts_tab(False)
544
570
self._global_message_text_view.show()
670
def _on_cancel_clicked(self, button):
671
""" Cancel button clicked handler. """
675
def _on_delete_window(self, source, event):
676
""" Delete window handler. """
679
def _do_cancel(self):
680
"""If requested, saves commit messages when cancelling gcommit; they are re-used by a next gcommit"""
681
mgr = SavedCommitMessagesManager()
682
self._saved_commit_messages_manager = mgr
683
mgr.insert(self._get_global_commit_message(),
684
self._get_specific_files()[1])
685
if mgr.is_not_empty(): # maybe worth saving
686
response = self._question_dialog(
687
_i18n('Commit cancelled'),
688
_i18n('Do you want to save your commit messages ?'),
690
if response == Gtk.ResponseType.NO:
691
# save nothing and destroy old comments if any
692
mgr = SavedCommitMessagesManager()
693
mgr.save(self._wt, self._wt.branch)
694
self.response(Gtk.ResponseType.CANCEL) # close window
641
697
def _on_commit_clicked(self, button):
642
698
""" Commit button clicked handler. """
643
699
self._do_commit()
729
792
show_offset=False)
730
793
rev_dict['revision_id'] = rev.revision_id
797
class SavedCommitMessagesManager:
798
"""Save glogal and per-file commit messages.
800
Saves global commit message and utf-8 file_id->message dictionary
801
of per-file commit messages on disk. Re-reads them later for re-using.
804
def __init__(self, tree=None, branch=None):
805
"""If branch is None, builds empty messages, otherwise reads them
806
from branch's disk storage. 'tree' argument is for the future."""
808
self.global_message = u''
809
self.file_messages = {}
811
config = branch.get_config()
812
self.global_message = config.get_user_option(
813
'gtk_global_commit_message')
814
if self.global_message is None:
815
self.global_message = u''
816
file_messages = config.get_user_option('gtk_file_commit_messages')
817
if file_messages: # unicode and B-encoded:
818
self.file_messages = bencode.bdecode(
819
file_messages.encode('UTF-8'))
821
self.file_messages = {}
824
return self.global_message, self.file_messages
826
def is_not_empty(self):
827
return bool(self.global_message or self.file_messages)
829
def insert(self, global_message, file_info):
830
"""Formats per-file commit messages (list of dictionaries, one per file)
831
into one utf-8 file_id->message dictionary and merges this with
832
previously existing dictionary. Merges global commit message too."""
835
file_message = fi['message']
837
file_messages[fi['file_id']] = file_message # utf-8 strings
838
for k,v in file_messages.iteritems():
840
self.file_messages[k] = v + '\n******\n' + self.file_messages[k]
842
self.file_messages[k] = v
843
if self.global_message:
844
self.global_message = global_message + '\n******\n' \
845
+ self.global_message
847
self.global_message = global_message
849
def save(self, tree, branch):
850
# We store in branch's config, which can be a problem if two gcommit
851
# are done in two checkouts of one single branch (comments overwrite
852
# each other). Ideally should be in working tree. But uncommit does
853
# not always have a working tree, though it always has a branch.
854
# 'tree' argument is for the future
855
config = branch.get_config()
856
# should it be named "gtk_" or some more neutral name ("gui_" ?) to
857
# be compatible with qbzr in the future?
858
config.set_user_option('gtk_global_commit_message', self.global_message)
859
# bencode() does not know unicode objects but set_user_option()
861
config.set_user_option(
862
'gtk_file_commit_messages',
863
bencode.bencode(self.file_messages).decode('UTF-8'))
866
def save_commit_messages(local, master, old_revno, old_revid,
867
new_revno, new_revid):
871
mgr = SavedCommitMessagesManager(None, b)
872
revid_iterator = b.repository.iter_reverse_revision_history(old_revid)
873
cur_revno = old_revno
874
new_revision_id = old_revid
875
graph = b.repository.get_graph()
876
for rev_id in revid_iterator:
877
if cur_revno == new_revno:
880
rev = b.repository.get_revision(rev_id)
881
file_info = rev.properties.get('file-info', None)
882
if file_info is None:
885
file_info = bencode.bdecode(file_info.encode('UTF-8'))
886
global_message = osutils.safe_unicode(rev.message)
887
# Concatenate comment of the uncommitted revision
888
mgr.insert(global_message, file_info)
890
parents = graph.get_parent_map([rev_id]).get(rev_id, None)