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 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
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
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):
99
class CommitDialog(gtk.Dialog):
108
100
"""Implementation of Commit."""
110
102
def __init__(self, wt, selected=None, parent=None):
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)
103
gtk.Dialog.__init__(self, title="Commit - Olive",
106
buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
114
107
self._question_dialog = question_dialog
116
self.set_type_hint(Gdk.WindowTypeHint.NORMAL)
119
110
# TODO: Do something with this value, it is used by Olive
120
111
# It used to set all changes but this one to False
197
186
self._wt.lock_read()
198
187
self._basis_tree.lock_read()
200
from diff import iter_changes_to_status
201
saved_file_messages = self._saved_commit_messages_manager.get()[1]
189
from diff import _iter_changes_to_status
202
190
for (file_id, real_path, change_type, display_path
203
) in iter_changes_to_status(self._basis_tree, self._wt):
191
) in _iter_changes_to_status(self._basis_tree, self._wt):
204
192
if self._selected and real_path != self._selected:
209
default_message = saved_file_messages[file_id]
212
196
item_iter = store.append([
214
198
real_path.encode('UTF-8'),
216
200
display_path.encode('UTF-8'),
218
default_message, # Initial comment
202
'', # Initial comment
220
204
if self._selected and enabled:
221
205
initial_cursor = store.get_path(item_iter)
313
291
self._hpane.set_position(300)
315
293
def _construct_accelerators(self):
316
group = Gtk.AccelGroup()
317
group.connect(Gdk.keyval_from_name('N'),
318
Gdk.ModifierType.CONTROL_MASK, 0, self._on_accel_next)
294
group = gtk.AccelGroup()
295
group.connect_group(gtk.gdk.keyval_from_name('N'),
296
gtk.gdk.CONTROL_MASK, 0, self._on_accel_next)
319
297
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')
324
299
def _construct_left_pane(self):
325
self._left_pane_box = Gtk.VBox(homogeneous=False, spacing=5)
300
self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
326
301
self._construct_file_list()
327
302
self._construct_pending_list()
329
self._check_local = Gtk.CheckButton(_i18n("_Only commit locally"),
304
self._check_local = gtk.CheckButton(_("_Only commit locally"),
330
305
use_underline=True)
331
self._left_pane_box.pack_end(self._check_local, False, False, 0)
306
self._left_pane_box.pack_end(self._check_local, False, False)
332
307
self._check_local.set_active(False)
334
309
self._hpane.pack1(self._left_pane_box, resize=False, shrink=False)
353
328
self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
355
330
def _construct_action_pane(self):
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)
331
self._button_commit = gtk.Button(_("Comm_it"), use_underline=True)
362
332
self._button_commit.connect('clicked', self._on_commit_clicked)
363
self._button_commit.set_can_default(True)
333
self._button_commit.set_flags(gtk.CAN_DEFAULT)
364
334
self._button_commit.show()
365
self.get_action_area().pack_end(
366
self._button_commit, True, True, 0)
335
self.action_area.pack_end(self._button_commit)
367
336
self._button_commit.grab_default()
369
338
def _add_to_right_table(self, widget, weight, expanding=False):
384
353
self._right_pane_table_row = end_row
386
355
def _construct_file_list(self):
387
self._files_box = Gtk.VBox(homogeneous=False, spacing=0)
388
file_label = Gtk.Label(label=_i18n('Files'))
356
self._files_box = gtk.VBox(homogeneous=False, spacing=0)
357
file_label = gtk.Label(_('Files'))
389
358
# file_label.show()
390
self._files_box.pack_start(file_label, False, True, 0)
359
self._files_box.pack_start(file_label, 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)
361
self._commit_all_files_radio = gtk.RadioButton(
362
None, _("Commit all changes"))
363
self._files_box.pack_start(self._commit_all_files_radio, expand=False)
395
364
self._commit_all_files_radio.show()
396
365
self._commit_all_files_radio.connect('toggled',
397
366
self._toggle_commit_selection)
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)
367
self._commit_selected_radio = gtk.RadioButton(
368
self._commit_all_files_radio, _("Only commit selected changes"))
369
self._files_box.pack_start(self._commit_selected_radio, expand=False)
401
370
self._commit_selected_radio.show()
402
371
self._commit_selected_radio.connect('toggled',
403
372
self._toggle_commit_selection)
404
373
if self._pending:
405
self._commit_all_files_radio.set_label(_i18n('Commit all changes*'))
374
self._commit_all_files_radio.set_label(_('Commit all changes*'))
406
375
self._commit_all_files_radio.set_sensitive(False)
407
376
self._commit_selected_radio.set_sensitive(False)
409
scroller = Gtk.ScrolledWindow()
410
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
411
self._treeview_files = Gtk.TreeView()
378
scroller = gtk.ScrolledWindow()
379
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
380
self._treeview_files = gtk.TreeView()
412
381
self._treeview_files.show()
413
382
scroller.add(self._treeview_files)
414
scroller.set_shadow_type(Gtk.ShadowType.IN)
383
scroller.set_shadow_type(gtk.SHADOW_IN)
416
self._files_box.pack_start(scroller, True, True, 0)
385
self._files_box.pack_start(scroller,
386
expand=True, fill=True)
417
387
self._files_box.show()
418
self._left_pane_box.pack_start(self._files_box, True, True, 0)
388
self._left_pane_box.pack_start(self._files_box)
420
390
# Keep note that all strings stored in a ListStore must be UTF-8
421
391
# strings. GTK does not support directly setting and restoring Unicode
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
393
liststore = gtk.ListStore(
394
gobject.TYPE_STRING, # [0] file_id
395
gobject.TYPE_STRING, # [1] real path
396
gobject.TYPE_BOOLEAN, # [2] checkbox
397
gobject.TYPE_STRING, # [3] display path
398
gobject.TYPE_STRING, # [4] changes type
399
gobject.TYPE_STRING, # [5] commit message
431
401
self._files_store = liststore
432
402
self._treeview_files.set_model(liststore)
433
crt = Gtk.CellRendererToggle()
403
crt = gtk.CellRendererToggle()
434
404
crt.set_property('activatable', not bool(self._pending))
435
405
crt.connect("toggled", self._toggle_commit, self._files_store)
436
406
if self._pending:
437
name = _i18n('Commit*')
439
name = _i18n('Commit')
440
commit_col = Gtk.TreeViewColumn(name, crt, active=2)
410
commit_col = gtk.TreeViewColumn(name, crt, active=2)
441
411
commit_col.set_visible(False)
442
412
self._treeview_files.append_column(commit_col)
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))
413
self._treeview_files.append_column(gtk.TreeViewColumn(_('Path'),
414
gtk.CellRendererText(), text=3))
415
self._treeview_files.append_column(gtk.TreeViewColumn(_('Type'),
416
gtk.CellRendererText(), text=4))
447
417
self._treeview_files.connect('cursor-changed',
448
418
self._on_treeview_files_cursor_changed)
464
434
checked_col.set_visible(False)
466
436
checked_col.set_visible(True)
467
renderer = checked_col.get_cells()[0]
437
renderer = checked_col.get_cell_renderers()[0]
468
438
renderer.set_property('activatable', not all_files)
470
440
def _construct_pending_list(self):
471
441
# Pending information defaults to hidden, we put it all in 1 box, so
472
442
# that we can show/hide all of them at once
473
self._pending_box = Gtk.VBox()
443
self._pending_box = gtk.VBox()
474
444
self._pending_box.hide()
476
pending_message = Gtk.Label()
446
pending_message = gtk.Label()
477
447
pending_message.set_markup(
478
_i18n('<i>* Cannot select specific files when merging</i>'))
479
self._pending_box.pack_start(pending_message, False, True, 5)
448
_('<i>* Cannot select specific files when merging</i>'))
449
self._pending_box.pack_start(pending_message, expand=False, padding=5)
480
450
pending_message.show()
482
pending_label = Gtk.Label(label=_i18n('Pending Revisions'))
483
self._pending_box.pack_start(pending_label, False, True, 0)
452
pending_label = gtk.Label(_('Pending Revisions'))
453
self._pending_box.pack_start(pending_label, expand=False, padding=0)
484
454
pending_label.show()
486
scroller = Gtk.ScrolledWindow()
487
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
488
self._treeview_pending = Gtk.TreeView()
456
scroller = gtk.ScrolledWindow()
457
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
458
self._treeview_pending = gtk.TreeView()
489
459
scroller.add(self._treeview_pending)
490
scroller.set_shadow_type(Gtk.ShadowType.IN)
460
scroller.set_shadow_type(gtk.SHADOW_IN)
492
self._pending_box.pack_start(scroller, True, True, 5)
462
self._pending_box.pack_start(scroller,
463
expand=True, fill=True, padding=5)
493
464
self._treeview_pending.show()
494
self._left_pane_box.pack_start(self._pending_box, True, True, 0)
465
self._left_pane_box.pack_start(self._pending_box)
496
liststore = Gtk.ListStore(GObject.TYPE_STRING, # revision_id
497
GObject.TYPE_STRING, # date
498
GObject.TYPE_STRING, # committer
499
GObject.TYPE_STRING, # summary
467
liststore = gtk.ListStore(gobject.TYPE_STRING, # revision_id
468
gobject.TYPE_STRING, # date
469
gobject.TYPE_STRING, # committer
470
gobject.TYPE_STRING, # summary
501
472
self._pending_store = liststore
502
473
self._treeview_pending.set_model(liststore)
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))
474
self._treeview_pending.append_column(gtk.TreeViewColumn(_('Date'),
475
gtk.CellRendererText(), text=1))
476
self._treeview_pending.append_column(gtk.TreeViewColumn(_('Committer'),
477
gtk.CellRendererText(), text=2))
478
self._treeview_pending.append_column(gtk.TreeViewColumn(_('Summary'),
479
gtk.CellRendererText(), text=3))
510
481
def _construct_diff_view(self):
511
from bzrlib.plugins.gtk.diff import DiffView
482
from diff import DiffView
513
484
# TODO: jam 2007-10-30 The diff label is currently disabled. If we
514
485
# decide that we really don't ever want to display it, we should
515
486
# actually remove it, and other references to it, along with the
516
487
# tests that it is set properly.
517
self._diff_label = Gtk.Label(label=_i18n('Diff for whole tree'))
488
self._diff_label = gtk.Label(_('Diff for whole tree'))
518
489
self._diff_label.set_alignment(0, 0)
519
490
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
520
491
self._add_to_right_table(self._diff_label, 1, False)
525
496
self._diff_view.show()
527
498
def _construct_file_message(self):
528
scroller = Gtk.ScrolledWindow()
529
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
499
scroller = gtk.ScrolledWindow()
500
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
531
self._file_message_text_view = Gtk.TextView()
502
self._file_message_text_view = gtk.TextView()
532
503
scroller.add(self._file_message_text_view)
533
scroller.set_shadow_type(Gtk.ShadowType.IN)
504
scroller.set_shadow_type(gtk.SHADOW_IN)
536
self._file_message_text_view.modify_font(Pango.FontDescription("Monospace"))
537
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
507
self._file_message_text_view.modify_font(pango.FontDescription("Monospace"))
508
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
538
509
self._file_message_text_view.set_accepts_tab(False)
539
510
self._file_message_text_view.show()
541
self._file_message_expander = Gtk.Expander(
542
label=_i18n('File commit message'))
512
self._file_message_expander = gtk.Expander(_('File commit message'))
543
513
self._file_message_expander.set_expanded(True)
544
514
self._file_message_expander.add(scroller)
545
515
self._add_to_right_table(self._file_message_expander, 1, False)
546
516
self._file_message_expander.show()
548
518
def _construct_global_message(self):
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>'))
519
self._global_message_label = gtk.Label(_('Global Commit Message'))
520
self._global_message_label.set_markup(_('<b>Global Commit Message</b>'))
552
521
self._global_message_label.set_alignment(0, 0)
553
522
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
554
523
self._add_to_right_table(self._global_message_label, 1, False)
555
524
# Can we remove the spacing between the label and the box?
556
525
self._global_message_label.show()
558
scroller = Gtk.ScrolledWindow()
559
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
527
scroller = gtk.ScrolledWindow()
528
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
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"))
530
self._global_message_text_view = gtk.TextView()
531
self._global_message_text_view.modify_font(pango.FontDescription("Monospace"))
564
532
scroller.add(self._global_message_text_view)
565
scroller.set_shadow_type(Gtk.ShadowType.IN)
533
scroller.set_shadow_type(gtk.SHADOW_IN)
567
535
self._add_to_right_table(scroller, 2, True)
568
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
536
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
569
537
self._file_message_text_view.set_accepts_tab(False)
570
538
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
697
635
def _on_commit_clicked(self, button):
698
636
""" Commit button clicked handler. """
699
637
self._do_commit()
792
723
show_offset=False)
793
724
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)