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 bzrlib.plugins.gtk import _i18n
35
from dialog import error_dialog, question_dialog
36
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
100
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):
101
108
"""Implementation of Commit."""
103
110
def __init__(self, wt, selected=None, parent=None):
104
gtk.Dialog.__init__(self, title="Commit - Olive",
107
buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
111
Gtk.Dialog.__init__(self, title="Commit to %s" % wt.basedir,
112
parent=parent, flags=0,)
113
self.connect('delete-event', self._on_delete_window)
108
114
self._question_dialog = question_dialog
116
self.set_type_hint(Gdk.WindowTypeHint.NORMAL)
111
119
# TODO: Do something with this value, it is used by Olive
112
120
# It used to set all changes but this one to False
188
198
self._basis_tree.lock_read()
190
200
from diff import iter_changes_to_status
201
saved_file_messages = self._saved_commit_messages_manager.get()[1]
191
202
for (file_id, real_path, change_type, display_path
192
203
) in iter_changes_to_status(self._basis_tree, self._wt):
193
204
if self._selected and real_path != self._selected:
209
default_message = saved_file_messages[file_id]
197
212
item_iter = store.append([
199
214
real_path.encode('UTF-8'),
201
216
display_path.encode('UTF-8'),
203
'', # Initial comment
218
default_message, # Initial comment
205
220
if self._selected and enabled:
206
221
initial_cursor = store.get_path(item_iter)
298
313
self._hpane.set_position(300)
300
315
def _construct_accelerators(self):
301
group = gtk.AccelGroup()
302
group.connect_group(gtk.gdk.keyval_from_name('N'),
303
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)
304
319
self.add_accel_group(group)
306
321
# ignore the escape key (avoid closing the window)
307
322
self.connect_object('close', self.emit_stop_by_name, 'close')
309
324
def _construct_left_pane(self):
310
self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
325
self._left_pane_box = Gtk.VBox(homogeneous=False, spacing=5)
311
326
self._construct_file_list()
312
327
self._construct_pending_list()
314
self._check_local = gtk.CheckButton(_i18n("_Only commit locally"),
329
self._check_local = Gtk.CheckButton(_i18n("_Only commit locally"),
315
330
use_underline=True)
316
self._left_pane_box.pack_end(self._check_local, False, False)
331
self._left_pane_box.pack_end(self._check_local, False, False, 0)
317
332
self._check_local.set_active(False)
319
334
self._hpane.pack1(self._left_pane_box, resize=False, shrink=False)
338
353
self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
340
355
def _construct_action_pane(self):
341
self._button_commit = gtk.Button(_i18n("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)
342
362
self._button_commit.connect('clicked', self._on_commit_clicked)
343
self._button_commit.set_flags(gtk.CAN_DEFAULT)
363
self._button_commit.set_can_default(True)
344
364
self._button_commit.show()
345
self.action_area.pack_end(self._button_commit)
365
self.get_action_area().pack_end(
366
self._button_commit, True, True, 0)
346
367
self._button_commit.grab_default()
348
369
def _add_to_right_table(self, widget, weight, expanding=False):
363
384
self._right_pane_table_row = end_row
365
386
def _construct_file_list(self):
366
self._files_box = gtk.VBox(homogeneous=False, spacing=0)
367
file_label = gtk.Label(_i18n('Files'))
387
self._files_box = Gtk.VBox(homogeneous=False, spacing=0)
388
file_label = Gtk.Label(label=_i18n('Files'))
368
389
# file_label.show()
369
self._files_box.pack_start(file_label, expand=False)
390
self._files_box.pack_start(file_label, False, True, 0)
371
self._commit_all_files_radio = gtk.RadioButton(
392
self._commit_all_files_radio = Gtk.RadioButton.new_with_label(
372
393
None, _i18n("Commit all changes"))
373
self._files_box.pack_start(self._commit_all_files_radio, expand=False)
394
self._files_box.pack_start(self._commit_all_files_radio, False, True, 0)
374
395
self._commit_all_files_radio.show()
375
396
self._commit_all_files_radio.connect('toggled',
376
397
self._toggle_commit_selection)
377
self._commit_selected_radio = gtk.RadioButton(
398
self._commit_selected_radio = Gtk.RadioButton.new_with_label_from_widget(
378
399
self._commit_all_files_radio, _i18n("Only commit selected changes"))
379
self._files_box.pack_start(self._commit_selected_radio, expand=False)
400
self._files_box.pack_start(self._commit_selected_radio, False, True, 0)
380
401
self._commit_selected_radio.show()
381
402
self._commit_selected_radio.connect('toggled',
382
403
self._toggle_commit_selection)
385
406
self._commit_all_files_radio.set_sensitive(False)
386
407
self._commit_selected_radio.set_sensitive(False)
388
scroller = gtk.ScrolledWindow()
389
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
390
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()
391
412
self._treeview_files.show()
392
413
scroller.add(self._treeview_files)
393
scroller.set_shadow_type(gtk.SHADOW_IN)
414
scroller.set_shadow_type(Gtk.ShadowType.IN)
395
self._files_box.pack_start(scroller,
396
expand=True, fill=True)
416
self._files_box.pack_start(scroller, True, True, 0)
397
417
self._files_box.show()
398
self._left_pane_box.pack_start(self._files_box)
418
self._left_pane_box.pack_start(self._files_box, True, True, 0)
400
420
# Keep note that all strings stored in a ListStore must be UTF-8
401
421
# strings. GTK does not support directly setting and restoring Unicode
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
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
411
431
self._files_store = liststore
412
432
self._treeview_files.set_model(liststore)
413
crt = gtk.CellRendererToggle()
433
crt = Gtk.CellRendererToggle()
414
434
crt.set_property('activatable', not bool(self._pending))
415
435
crt.connect("toggled", self._toggle_commit, self._files_store)
416
436
if self._pending:
417
437
name = _i18n('Commit*')
419
439
name = _i18n('Commit')
420
commit_col = gtk.TreeViewColumn(name, crt, active=2)
440
commit_col = Gtk.TreeViewColumn(name, crt, active=2)
421
441
commit_col.set_visible(False)
422
442
self._treeview_files.append_column(commit_col)
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))
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))
427
447
self._treeview_files.connect('cursor-changed',
428
448
self._on_treeview_files_cursor_changed)
444
464
checked_col.set_visible(False)
446
466
checked_col.set_visible(True)
447
renderer = checked_col.get_cell_renderers()[0]
467
renderer = checked_col.get_cells()[0]
448
468
renderer.set_property('activatable', not all_files)
450
470
def _construct_pending_list(self):
451
471
# Pending information defaults to hidden, we put it all in 1 box, so
452
472
# that we can show/hide all of them at once
453
self._pending_box = gtk.VBox()
473
self._pending_box = Gtk.VBox()
454
474
self._pending_box.hide()
456
pending_message = gtk.Label()
476
pending_message = Gtk.Label()
457
477
pending_message.set_markup(
458
478
_i18n('<i>* Cannot select specific files when merging</i>'))
459
self._pending_box.pack_start(pending_message, expand=False, padding=5)
479
self._pending_box.pack_start(pending_message, False, True, 5)
460
480
pending_message.show()
462
pending_label = gtk.Label(_i18n('Pending Revisions'))
463
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)
464
484
pending_label.show()
466
scroller = gtk.ScrolledWindow()
467
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
468
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()
469
489
scroller.add(self._treeview_pending)
470
scroller.set_shadow_type(gtk.SHADOW_IN)
490
scroller.set_shadow_type(Gtk.ShadowType.IN)
472
self._pending_box.pack_start(scroller,
473
expand=True, fill=True, padding=5)
492
self._pending_box.pack_start(scroller, True, True, 5)
474
493
self._treeview_pending.show()
475
self._left_pane_box.pack_start(self._pending_box)
494
self._left_pane_box.pack_start(self._pending_box, True, True, 0)
477
liststore = gtk.ListStore(gobject.TYPE_STRING, # revision_id
478
gobject.TYPE_STRING, # date
479
gobject.TYPE_STRING, # committer
480
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
482
501
self._pending_store = liststore
483
502
self._treeview_pending.set_model(liststore)
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))
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))
491
510
def _construct_diff_view(self):
492
from diff import DiffView
511
from bzrlib.plugins.gtk.diff import DiffView
494
513
# TODO: jam 2007-10-30 The diff label is currently disabled. If we
495
514
# decide that we really don't ever want to display it, we should
496
515
# actually remove it, and other references to it, along with the
497
516
# tests that it is set properly.
498
self._diff_label = gtk.Label(_i18n('Diff for whole tree'))
517
self._diff_label = Gtk.Label(label=_i18n('Diff for whole tree'))
499
518
self._diff_label.set_alignment(0, 0)
500
519
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
501
520
self._add_to_right_table(self._diff_label, 1, False)
506
525
self._diff_view.show()
508
527
def _construct_file_message(self):
509
scroller = gtk.ScrolledWindow()
510
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
528
scroller = Gtk.ScrolledWindow()
529
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
512
self._file_message_text_view = gtk.TextView()
531
self._file_message_text_view = Gtk.TextView()
513
532
scroller.add(self._file_message_text_view)
514
scroller.set_shadow_type(gtk.SHADOW_IN)
533
scroller.set_shadow_type(Gtk.ShadowType.IN)
517
self._file_message_text_view.modify_font(pango.FontDescription("Monospace"))
518
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)
519
538
self._file_message_text_view.set_accepts_tab(False)
520
539
self._file_message_text_view.show()
522
self._file_message_expander = gtk.Expander(_i18n('File commit message'))
541
self._file_message_expander = Gtk.Expander(
542
label=_i18n('File commit message'))
523
543
self._file_message_expander.set_expanded(True)
524
544
self._file_message_expander.add(scroller)
525
545
self._add_to_right_table(self._file_message_expander, 1, False)
526
546
self._file_message_expander.show()
528
548
def _construct_global_message(self):
529
self._global_message_label = gtk.Label(_i18n('Global Commit Message'))
549
self._global_message_label = Gtk.Label(label=_i18n('Global Commit Message'))
530
550
self._global_message_label.set_markup(
531
551
_i18n('<b>Global Commit Message</b>'))
532
552
self._global_message_label.set_alignment(0, 0)
535
555
# Can we remove the spacing between the label and the box?
536
556
self._global_message_label.show()
538
scroller = gtk.ScrolledWindow()
539
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
558
scroller = Gtk.ScrolledWindow()
559
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
541
self._global_message_text_view = gtk.TextView()
542
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"))
543
564
scroller.add(self._global_message_text_view)
544
scroller.set_shadow_type(gtk.SHADOW_IN)
565
scroller.set_shadow_type(Gtk.ShadowType.IN)
546
567
self._add_to_right_table(scroller, 2, True)
547
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
568
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
548
569
self._file_message_text_view.set_accepts_tab(False)
549
570
self._global_message_text_view.show()
575
596
# We have either made it to the end of the list, or nothing was
576
597
# selected. Either way, select All Files, and jump to the global
577
598
# commit message.
578
self._treeview_files.set_cursor((0,))
599
self._treeview_files.set_cursor(
600
Gtk.TreePath(path=0), None, False)
579
601
self._global_message_text_view.grab_focus()
581
603
# Set the cursor to this entry, and jump to the per-file commit
583
self._treeview_files.set_cursor(model.get_path(next))
605
self._treeview_files.set_cursor(model.get_path(next), None, False)
584
606
self._file_message_text_view.grab_focus()
586
608
def _save_current_file_message(self):
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
646
697
def _on_commit_clicked(self, button):
647
698
""" Commit button clicked handler. """
648
699
self._do_commit()
702
757
specific_files=specific_files,
703
758
revprops=revprops)
704
759
self.committed_revision_id = rev_id
705
self.response(gtk.RESPONSE_OK)
760
# destroy old comments if any
761
SavedCommitMessagesManager().save(self._wt, self._wt.branch)
762
self.response(Gtk.ResponseType.OK)
707
764
def _get_global_commit_message(self):
708
765
buf = self._global_message_text_view.get_buffer()
709
766
start, end = buf.get_bounds()
710
return buf.get_text(start, end).decode('utf-8')
767
text = buf.get_text(start, end, True)
768
return _sanitize_and_decode_message(text)
712
770
def _set_global_commit_message(self, message):
713
771
"""Just a helper for the test suite."""
734
792
show_offset=False)
735
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)