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