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
19
from gi.repository import Gtk
20
from gi.repository import GObject
21
from gi.repository import Pango
29
from bzrlib import bencode
31
from bzrlib.util import bencode
33
from bzrlib.plugins.gtk.dialog import question_dialog
34
from bzrlib.plugins.gtk.errors import show_bzr_error
35
from bzrlib.plugins.gtk.i18n import _i18n
30
from bzrlib import errors, osutils
31
from bzrlib.trace import mutter
32
from bzrlib.util import bencode
34
from bzrlib.plugins.gtk import _i18n
35
from dialog import error_dialog, question_dialog
36
from errors import show_bzr_error
99
_newline_variants_re = re.compile(r'\r\n?')
100
def _sanitize_and_decode_message(utf8_message):
101
"""Turn a utf-8 message into a sanitized Unicode message."""
102
fixed_newline = _newline_variants_re.sub('\n', utf8_message)
103
return fixed_newline.decode('utf-8')
106
class CommitDialog(Gtk.Dialog):
100
class CommitDialog(gtk.Dialog):
107
101
"""Implementation of Commit."""
109
103
def __init__(self, wt, selected=None, parent=None):
110
GObject.GObject.__init__(self, title="Commit to %s" % wt.basedir,
111
parent=parent, flags=0,)
112
self.connect('delete-event', self._on_delete_window)
104
gtk.Dialog.__init__(self, title="Commit - Olive",
107
buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
113
108
self._question_dialog = question_dialog
115
self.set_type_hint(Gdk.WindowTypeHint.NORMAL)
118
111
# TODO: Do something with this value, it is used by Olive
119
112
# It used to set all changes but this one to False
196
188
self._basis_tree.lock_read()
198
190
from diff import iter_changes_to_status
199
saved_file_messages = self._saved_commit_messages_manager.get()[1]
200
191
for (file_id, real_path, change_type, display_path
201
192
) in iter_changes_to_status(self._basis_tree, self._wt):
202
193
if self._selected and real_path != self._selected:
207
default_message = saved_file_messages[file_id]
210
197
item_iter = store.append([
212
199
real_path.encode('UTF-8'),
214
201
display_path.encode('UTF-8'),
216
default_message, # Initial comment
203
'', # Initial comment
218
205
if self._selected and enabled:
219
206
initial_cursor = store.get_path(item_iter)
311
298
self._hpane.set_position(300)
313
300
def _construct_accelerators(self):
314
group = Gtk.AccelGroup()
315
group.connect_group(Gdk.keyval_from_name('N'),
316
Gdk.EventMask.CONTROL_MASK, 0, self._on_accel_next)
301
group = gtk.AccelGroup()
302
group.connect_group(gtk.gdk.keyval_from_name('N'),
303
gtk.gdk.CONTROL_MASK, 0, self._on_accel_next)
317
304
self.add_accel_group(group)
319
306
# ignore the escape key (avoid closing the window)
320
307
self.connect_object('close', self.emit_stop_by_name, 'close')
322
309
def _construct_left_pane(self):
323
self._left_pane_box = Gtk.VBox(homogeneous=False, spacing=5)
310
self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
324
311
self._construct_file_list()
325
312
self._construct_pending_list()
327
self._check_local = Gtk.CheckButton(_i18n("_Only commit locally"),
314
self._check_local = gtk.CheckButton(_i18n("_Only commit locally"),
328
315
use_underline=True)
329
316
self._left_pane_box.pack_end(self._check_local, False, False)
330
317
self._check_local.set_active(False)
351
338
self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
353
340
def _construct_action_pane(self):
354
self._button_cancel = Gtk.Button(stock=Gtk.STOCK_CANCEL)
355
self._button_cancel.connect('clicked', self._on_cancel_clicked)
356
self._button_cancel.show()
357
self.action_area.pack_end(self._button_cancel)
358
self._button_commit = Gtk.Button(_i18n("Comm_it"), use_underline=True)
341
self._button_commit = gtk.Button(_i18n("Comm_it"), use_underline=True)
359
342
self._button_commit.connect('clicked', self._on_commit_clicked)
360
self._button_commit.set_can_default(True)
343
self._button_commit.set_flags(gtk.CAN_DEFAULT)
361
344
self._button_commit.show()
362
345
self.action_area.pack_end(self._button_commit)
363
346
self._button_commit.grab_default()
380
363
self._right_pane_table_row = end_row
382
365
def _construct_file_list(self):
383
self._files_box = Gtk.VBox(homogeneous=False, spacing=0)
384
file_label = Gtk.Label(label=_i18n('Files'))
366
self._files_box = gtk.VBox(homogeneous=False, spacing=0)
367
file_label = gtk.Label(_i18n('Files'))
385
368
# file_label.show()
386
self._files_box.pack_start(file_label, False, True, 0)
369
self._files_box.pack_start(file_label, expand=False)
388
self._commit_all_files_radio = Gtk.RadioButton(
371
self._commit_all_files_radio = gtk.RadioButton(
389
372
None, _i18n("Commit all changes"))
390
self._files_box.pack_start(self._commit_all_files_radio, False, True, 0)
373
self._files_box.pack_start(self._commit_all_files_radio, expand=False)
391
374
self._commit_all_files_radio.show()
392
375
self._commit_all_files_radio.connect('toggled',
393
376
self._toggle_commit_selection)
394
self._commit_selected_radio = Gtk.RadioButton(
377
self._commit_selected_radio = gtk.RadioButton(
395
378
self._commit_all_files_radio, _i18n("Only commit selected changes"))
396
self._files_box.pack_start(self._commit_selected_radio, False, True, 0)
379
self._files_box.pack_start(self._commit_selected_radio, expand=False)
397
380
self._commit_selected_radio.show()
398
381
self._commit_selected_radio.connect('toggled',
399
382
self._toggle_commit_selection)
402
385
self._commit_all_files_radio.set_sensitive(False)
403
386
self._commit_selected_radio.set_sensitive(False)
405
scroller = Gtk.ScrolledWindow()
406
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
407
self._treeview_files = Gtk.TreeView()
388
scroller = gtk.ScrolledWindow()
389
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
390
self._treeview_files = gtk.TreeView()
408
391
self._treeview_files.show()
409
392
scroller.add(self._treeview_files)
410
scroller.set_shadow_type(Gtk.ShadowType.IN)
393
scroller.set_shadow_type(gtk.SHADOW_IN)
412
395
self._files_box.pack_start(scroller,
413
396
expand=True, fill=True)
414
397
self._files_box.show()
415
self._left_pane_box.pack_start(self._files_box, True, True, 0)
398
self._left_pane_box.pack_start(self._files_box)
417
400
# Keep note that all strings stored in a ListStore must be UTF-8
418
401
# strings. GTK does not support directly setting and restoring Unicode
420
liststore = Gtk.ListStore(
421
GObject.TYPE_STRING, # [0] file_id
422
GObject.TYPE_STRING, # [1] real path
423
GObject.TYPE_BOOLEAN, # [2] checkbox
424
GObject.TYPE_STRING, # [3] display path
425
GObject.TYPE_STRING, # [4] changes type
426
GObject.TYPE_STRING, # [5] commit message
403
liststore = gtk.ListStore(
404
gobject.TYPE_STRING, # [0] file_id
405
gobject.TYPE_STRING, # [1] real path
406
gobject.TYPE_BOOLEAN, # [2] checkbox
407
gobject.TYPE_STRING, # [3] display path
408
gobject.TYPE_STRING, # [4] changes type
409
gobject.TYPE_STRING, # [5] commit message
428
411
self._files_store = liststore
429
412
self._treeview_files.set_model(liststore)
430
crt = Gtk.CellRendererToggle()
413
crt = gtk.CellRendererToggle()
431
414
crt.set_property('activatable', not bool(self._pending))
432
415
crt.connect("toggled", self._toggle_commit, self._files_store)
433
416
if self._pending:
434
417
name = _i18n('Commit*')
436
419
name = _i18n('Commit')
437
commit_col = Gtk.TreeViewColumn(name, crt, active=2)
420
commit_col = gtk.TreeViewColumn(name, crt, active=2)
438
421
commit_col.set_visible(False)
439
422
self._treeview_files.append_column(commit_col)
440
self._treeview_files.append_column(Gtk.TreeViewColumn(_i18n('Path'),
441
Gtk.CellRendererText(), text=3))
442
self._treeview_files.append_column(Gtk.TreeViewColumn(_i18n('Type'),
443
Gtk.CellRendererText(), text=4))
423
self._treeview_files.append_column(gtk.TreeViewColumn(_i18n('Path'),
424
gtk.CellRendererText(), text=3))
425
self._treeview_files.append_column(gtk.TreeViewColumn(_i18n('Type'),
426
gtk.CellRendererText(), text=4))
444
427
self._treeview_files.connect('cursor-changed',
445
428
self._on_treeview_files_cursor_changed)
467
450
def _construct_pending_list(self):
468
451
# Pending information defaults to hidden, we put it all in 1 box, so
469
452
# that we can show/hide all of them at once
470
self._pending_box = Gtk.VBox()
453
self._pending_box = gtk.VBox()
471
454
self._pending_box.hide()
473
pending_message = Gtk.Label()
456
pending_message = gtk.Label()
474
457
pending_message.set_markup(
475
458
_i18n('<i>* Cannot select specific files when merging</i>'))
476
459
self._pending_box.pack_start(pending_message, expand=False, padding=5)
477
460
pending_message.show()
479
pending_label = Gtk.Label(label=_i18n('Pending Revisions'))
462
pending_label = gtk.Label(_i18n('Pending Revisions'))
480
463
self._pending_box.pack_start(pending_label, expand=False, padding=0)
481
464
pending_label.show()
483
scroller = Gtk.ScrolledWindow()
484
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
485
self._treeview_pending = Gtk.TreeView()
466
scroller = gtk.ScrolledWindow()
467
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
468
self._treeview_pending = gtk.TreeView()
486
469
scroller.add(self._treeview_pending)
487
scroller.set_shadow_type(Gtk.ShadowType.IN)
470
scroller.set_shadow_type(gtk.SHADOW_IN)
489
472
self._pending_box.pack_start(scroller,
490
473
expand=True, fill=True, padding=5)
491
474
self._treeview_pending.show()
492
self._left_pane_box.pack_start(self._pending_box, True, True, 0)
475
self._left_pane_box.pack_start(self._pending_box)
494
liststore = Gtk.ListStore(GObject.TYPE_STRING, # revision_id
495
GObject.TYPE_STRING, # date
496
GObject.TYPE_STRING, # committer
497
GObject.TYPE_STRING, # summary
477
liststore = gtk.ListStore(gobject.TYPE_STRING, # revision_id
478
gobject.TYPE_STRING, # date
479
gobject.TYPE_STRING, # committer
480
gobject.TYPE_STRING, # summary
499
482
self._pending_store = liststore
500
483
self._treeview_pending.set_model(liststore)
501
self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Date'),
502
Gtk.CellRendererText(), text=1))
503
self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Committer'),
504
Gtk.CellRendererText(), text=2))
505
self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Summary'),
506
Gtk.CellRendererText(), text=3))
484
self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Date'),
485
gtk.CellRendererText(), text=1))
486
self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Committer'),
487
gtk.CellRendererText(), text=2))
488
self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Summary'),
489
gtk.CellRendererText(), text=3))
508
491
def _construct_diff_view(self):
509
from bzrlib.plugins.gtk.diff import DiffView
492
from diff import DiffView
511
494
# TODO: jam 2007-10-30 The diff label is currently disabled. If we
512
495
# decide that we really don't ever want to display it, we should
513
496
# actually remove it, and other references to it, along with the
514
497
# tests that it is set properly.
515
self._diff_label = Gtk.Label(label=_i18n('Diff for whole tree'))
498
self._diff_label = gtk.Label(_i18n('Diff for whole tree'))
516
499
self._diff_label.set_alignment(0, 0)
517
500
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
518
501
self._add_to_right_table(self._diff_label, 1, False)
523
506
self._diff_view.show()
525
508
def _construct_file_message(self):
526
scroller = Gtk.ScrolledWindow()
527
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
509
scroller = gtk.ScrolledWindow()
510
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
529
self._file_message_text_view = Gtk.TextView()
512
self._file_message_text_view = gtk.TextView()
530
513
scroller.add(self._file_message_text_view)
531
scroller.set_shadow_type(Gtk.ShadowType.IN)
514
scroller.set_shadow_type(gtk.SHADOW_IN)
534
self._file_message_text_view.modify_font(Pango.FontDescription("Monospace"))
535
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
517
self._file_message_text_view.modify_font(pango.FontDescription("Monospace"))
518
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
536
519
self._file_message_text_view.set_accepts_tab(False)
537
520
self._file_message_text_view.show()
539
self._file_message_expander = Gtk.Expander(_i18n('File commit message'))
522
self._file_message_expander = gtk.Expander(_i18n('File commit message'))
540
523
self._file_message_expander.set_expanded(True)
541
524
self._file_message_expander.add(scroller)
542
525
self._add_to_right_table(self._file_message_expander, 1, False)
543
526
self._file_message_expander.show()
545
528
def _construct_global_message(self):
546
self._global_message_label = Gtk.Label(label=_i18n('Global Commit Message'))
529
self._global_message_label = gtk.Label(_i18n('Global Commit Message'))
547
530
self._global_message_label.set_markup(
548
531
_i18n('<b>Global Commit Message</b>'))
549
532
self._global_message_label.set_alignment(0, 0)
552
535
# Can we remove the spacing between the label and the box?
553
536
self._global_message_label.show()
555
scroller = Gtk.ScrolledWindow()
556
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
538
scroller = gtk.ScrolledWindow()
539
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
558
self._global_message_text_view = Gtk.TextView()
559
self._set_global_commit_message(self._saved_commit_messages_manager.get()[0])
560
self._global_message_text_view.modify_font(Pango.FontDescription("Monospace"))
541
self._global_message_text_view = gtk.TextView()
542
self._global_message_text_view.modify_font(pango.FontDescription("Monospace"))
561
543
scroller.add(self._global_message_text_view)
562
scroller.set_shadow_type(Gtk.ShadowType.IN)
544
scroller.set_shadow_type(gtk.SHADOW_IN)
564
546
self._add_to_right_table(scroller, 2, True)
565
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
547
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
566
548
self._file_message_text_view.set_accepts_tab(False)
567
549
self._global_message_text_view.show()
666
def _on_cancel_clicked(self, button):
667
""" Cancel button clicked handler. """
671
def _on_delete_window(self, source, event):
672
""" Delete window handler. """
675
def _do_cancel(self):
676
"""If requested, saves commit messages when cancelling gcommit; they are re-used by a next gcommit"""
677
mgr = SavedCommitMessagesManager()
678
self._saved_commit_messages_manager = mgr
679
mgr.insert(self._get_global_commit_message(),
680
self._get_specific_files()[1])
681
if mgr.is_not_empty(): # maybe worth saving
682
response = self._question_dialog(
683
_i18n('Commit cancelled'),
684
_i18n('Do you want to save your commit messages ?'),
686
if response == Gtk.ResponseType.NO:
687
# save nothing and destroy old comments if any
688
mgr = SavedCommitMessagesManager()
689
mgr.save(self._wt, self._wt.branch)
690
self.response(Gtk.ResponseType.CANCEL) # close window
693
646
def _on_commit_clicked(self, button):
694
647
""" Commit button clicked handler. """
695
648
self._do_commit()
753
702
specific_files=specific_files,
754
703
revprops=revprops)
755
704
self.committed_revision_id = rev_id
756
# destroy old comments if any
757
SavedCommitMessagesManager().save(self._wt, self._wt.branch)
758
self.response(Gtk.ResponseType.OK)
705
self.response(gtk.RESPONSE_OK)
760
707
def _get_global_commit_message(self):
761
708
buf = self._global_message_text_view.get_buffer()
762
709
start, end = buf.get_bounds()
763
text = buf.get_text(start, end)
764
return _sanitize_and_decode_message(text)
710
return buf.get_text(start, end).decode('utf-8')
766
712
def _set_global_commit_message(self, message):
767
713
"""Just a helper for the test suite."""
788
734
show_offset=False)
789
735
rev_dict['revision_id'] = rev.revision_id
793
class SavedCommitMessagesManager:
794
"""Save glogal and per-file commit messages.
796
Saves global commit message and utf-8 file_id->message dictionary
797
of per-file commit messages on disk. Re-reads them later for re-using.
800
def __init__(self, tree=None, branch=None):
801
"""If branch is None, builds empty messages, otherwise reads them
802
from branch's disk storage. 'tree' argument is for the future."""
804
self.global_message = u''
805
self.file_messages = {}
807
config = branch.get_config()
808
self.global_message = config.get_user_option(
809
'gtk_global_commit_message')
810
if self.global_message is None:
811
self.global_message = u''
812
file_messages = config.get_user_option('gtk_file_commit_messages')
813
if file_messages: # unicode and B-encoded:
814
self.file_messages = bencode.bdecode(
815
file_messages.encode('UTF-8'))
817
self.file_messages = {}
820
return self.global_message, self.file_messages
822
def is_not_empty(self):
823
return bool(self.global_message or self.file_messages)
825
def insert(self, global_message, file_info):
826
"""Formats per-file commit messages (list of dictionaries, one per file)
827
into one utf-8 file_id->message dictionary and merges this with
828
previously existing dictionary. Merges global commit message too."""
831
file_message = fi['message']
833
file_messages[fi['file_id']] = file_message # utf-8 strings
834
for k,v in file_messages.iteritems():
836
self.file_messages[k] = v + '\n******\n' + self.file_messages[k]
838
self.file_messages[k] = v
839
if self.global_message:
840
self.global_message = global_message + '\n******\n' \
841
+ self.global_message
843
self.global_message = global_message
845
def save(self, tree, branch):
846
# We store in branch's config, which can be a problem if two gcommit
847
# are done in two checkouts of one single branch (comments overwrite
848
# each other). Ideally should be in working tree. But uncommit does
849
# not always have a working tree, though it always has a branch.
850
# 'tree' argument is for the future
851
config = branch.get_config()
852
# should it be named "gtk_" or some more neutral name ("gui_" ?) to
853
# be compatible with qbzr in the future?
854
config.set_user_option('gtk_global_commit_message', self.global_message)
855
# bencode() does not know unicode objects but set_user_option()
857
config.set_user_option(
858
'gtk_file_commit_messages',
859
bencode.bencode(self.file_messages).decode('UTF-8'))
862
def save_commit_messages(local, master, old_revno, old_revid,
863
new_revno, new_revid):
867
mgr = SavedCommitMessagesManager(None, b)
868
revid_iterator = b.repository.iter_reverse_revision_history(old_revid)
869
cur_revno = old_revno
870
new_revision_id = old_revid
871
graph = b.repository.get_graph()
872
for rev_id in revid_iterator:
873
if cur_revno == new_revno:
876
rev = b.repository.get_revision(rev_id)
877
file_info = rev.properties.get('file-info', None)
878
if file_info is None:
881
file_info = bencode.bdecode(file_info.encode('UTF-8'))
882
global_message = osutils.safe_unicode(rev.message)
883
# Concatenate comment of the uncommitted revision
884
mgr.insert(global_message, file_info)
886
parents = graph.get_parent_map([rev_id]).get(rev_id, None)