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
21
19
pygtk.require("2.0")
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
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
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):
100
class CommitDialog(gtk.Dialog):
113
101
"""Implementation of Commit."""
115
103
def __init__(self, wt, selected=None, parent=None):
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)
104
gtk.Dialog.__init__(self, title="Commit - Olive",
107
buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
119
108
self._question_dialog = question_dialog
121
self.set_type_hint(Gdk.WindowTypeHint.NORMAL)
124
111
# TODO: Do something with this value, it is used by Olive
125
112
# It used to set all changes but this one to False
202
188
self._basis_tree.lock_read()
204
190
from diff import iter_changes_to_status
205
saved_file_messages = self._saved_commit_messages_manager.get()[1]
206
191
for (file_id, real_path, change_type, display_path
207
192
) in iter_changes_to_status(self._basis_tree, self._wt):
208
193
if self._selected and real_path != self._selected:
213
default_message = saved_file_messages[file_id]
216
197
item_iter = store.append([
218
199
real_path.encode('UTF-8'),
220
201
display_path.encode('UTF-8'),
222
default_message, # Initial comment
203
'', # Initial comment
224
205
if self._selected and enabled:
225
206
initial_cursor = store.get_path(item_iter)
317
298
self._hpane.set_position(300)
319
300
def _construct_accelerators(self):
320
group = Gtk.AccelGroup()
321
group.connect_group(Gdk.keyval_from_name('N'),
322
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)
323
304
self.add_accel_group(group)
325
306
# ignore the escape key (avoid closing the window)
326
307
self.connect_object('close', self.emit_stop_by_name, 'close')
328
309
def _construct_left_pane(self):
329
self._left_pane_box = Gtk.VBox(homogeneous=False, spacing=5)
310
self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
330
311
self._construct_file_list()
331
312
self._construct_pending_list()
333
self._check_local = Gtk.CheckButton(_i18n("_Only commit locally"),
314
self._check_local = gtk.CheckButton(_i18n("_Only commit locally"),
334
315
use_underline=True)
335
316
self._left_pane_box.pack_end(self._check_local, False, False)
336
317
self._check_local.set_active(False)
357
338
self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
359
340
def _construct_action_pane(self):
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)
341
self._button_commit = gtk.Button(_i18n("Comm_it"), use_underline=True)
365
342
self._button_commit.connect('clicked', self._on_commit_clicked)
366
self._button_commit.set_can_default(True)
343
self._button_commit.set_flags(gtk.CAN_DEFAULT)
367
344
self._button_commit.show()
368
345
self.action_area.pack_end(self._button_commit)
369
346
self._button_commit.grab_default()
386
363
self._right_pane_table_row = end_row
388
365
def _construct_file_list(self):
389
self._files_box = Gtk.VBox(homogeneous=False, spacing=0)
390
file_label = Gtk.Label(label=_i18n('Files'))
366
self._files_box = gtk.VBox(homogeneous=False, spacing=0)
367
file_label = gtk.Label(_i18n('Files'))
391
368
# file_label.show()
392
self._files_box.pack_start(file_label, False, True, 0)
369
self._files_box.pack_start(file_label, expand=False)
394
self._commit_all_files_radio = Gtk.RadioButton(
371
self._commit_all_files_radio = gtk.RadioButton(
395
372
None, _i18n("Commit all changes"))
396
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)
397
374
self._commit_all_files_radio.show()
398
375
self._commit_all_files_radio.connect('toggled',
399
376
self._toggle_commit_selection)
400
self._commit_selected_radio = Gtk.RadioButton(
377
self._commit_selected_radio = gtk.RadioButton(
401
378
self._commit_all_files_radio, _i18n("Only commit selected changes"))
402
self._files_box.pack_start(self._commit_selected_radio, False, True, 0)
379
self._files_box.pack_start(self._commit_selected_radio, expand=False)
403
380
self._commit_selected_radio.show()
404
381
self._commit_selected_radio.connect('toggled',
405
382
self._toggle_commit_selection)
408
385
self._commit_all_files_radio.set_sensitive(False)
409
386
self._commit_selected_radio.set_sensitive(False)
411
scroller = Gtk.ScrolledWindow()
412
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
413
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()
414
391
self._treeview_files.show()
415
392
scroller.add(self._treeview_files)
416
scroller.set_shadow_type(Gtk.ShadowType.IN)
393
scroller.set_shadow_type(gtk.SHADOW_IN)
418
395
self._files_box.pack_start(scroller,
419
396
expand=True, fill=True)
420
397
self._files_box.show()
421
self._left_pane_box.pack_start(self._files_box, True, True, 0)
398
self._left_pane_box.pack_start(self._files_box)
423
400
# Keep note that all strings stored in a ListStore must be UTF-8
424
401
# strings. GTK does not support directly setting and restoring Unicode
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
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
434
411
self._files_store = liststore
435
412
self._treeview_files.set_model(liststore)
436
crt = Gtk.CellRendererToggle()
413
crt = gtk.CellRendererToggle()
437
414
crt.set_property('activatable', not bool(self._pending))
438
415
crt.connect("toggled", self._toggle_commit, self._files_store)
439
416
if self._pending:
440
417
name = _i18n('Commit*')
442
419
name = _i18n('Commit')
443
commit_col = Gtk.TreeViewColumn(name, crt, active=2)
420
commit_col = gtk.TreeViewColumn(name, crt, active=2)
444
421
commit_col.set_visible(False)
445
422
self._treeview_files.append_column(commit_col)
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))
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))
450
427
self._treeview_files.connect('cursor-changed',
451
428
self._on_treeview_files_cursor_changed)
473
450
def _construct_pending_list(self):
474
451
# Pending information defaults to hidden, we put it all in 1 box, so
475
452
# that we can show/hide all of them at once
476
self._pending_box = Gtk.VBox()
453
self._pending_box = gtk.VBox()
477
454
self._pending_box.hide()
479
pending_message = Gtk.Label()
456
pending_message = gtk.Label()
480
457
pending_message.set_markup(
481
458
_i18n('<i>* Cannot select specific files when merging</i>'))
482
459
self._pending_box.pack_start(pending_message, expand=False, padding=5)
483
460
pending_message.show()
485
pending_label = Gtk.Label(label=_i18n('Pending Revisions'))
462
pending_label = gtk.Label(_i18n('Pending Revisions'))
486
463
self._pending_box.pack_start(pending_label, expand=False, padding=0)
487
464
pending_label.show()
489
scroller = Gtk.ScrolledWindow()
490
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
491
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()
492
469
scroller.add(self._treeview_pending)
493
scroller.set_shadow_type(Gtk.ShadowType.IN)
470
scroller.set_shadow_type(gtk.SHADOW_IN)
495
472
self._pending_box.pack_start(scroller,
496
473
expand=True, fill=True, padding=5)
497
474
self._treeview_pending.show()
498
self._left_pane_box.pack_start(self._pending_box, True, True, 0)
475
self._left_pane_box.pack_start(self._pending_box)
500
liststore = Gtk.ListStore(GObject.TYPE_STRING, # revision_id
501
GObject.TYPE_STRING, # date
502
GObject.TYPE_STRING, # committer
503
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
505
482
self._pending_store = liststore
506
483
self._treeview_pending.set_model(liststore)
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))
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))
514
491
def _construct_diff_view(self):
515
from bzrlib.plugins.gtk.diff import DiffView
492
from diff import DiffView
517
494
# TODO: jam 2007-10-30 The diff label is currently disabled. If we
518
495
# decide that we really don't ever want to display it, we should
519
496
# actually remove it, and other references to it, along with the
520
497
# tests that it is set properly.
521
self._diff_label = Gtk.Label(label=_i18n('Diff for whole tree'))
498
self._diff_label = gtk.Label(_i18n('Diff for whole tree'))
522
499
self._diff_label.set_alignment(0, 0)
523
500
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
524
501
self._add_to_right_table(self._diff_label, 1, False)
529
506
self._diff_view.show()
531
508
def _construct_file_message(self):
532
scroller = Gtk.ScrolledWindow()
533
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
509
scroller = gtk.ScrolledWindow()
510
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
535
self._file_message_text_view = Gtk.TextView()
512
self._file_message_text_view = gtk.TextView()
536
513
scroller.add(self._file_message_text_view)
537
scroller.set_shadow_type(Gtk.ShadowType.IN)
514
scroller.set_shadow_type(gtk.SHADOW_IN)
540
self._file_message_text_view.modify_font(Pango.FontDescription("Monospace"))
541
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)
542
519
self._file_message_text_view.set_accepts_tab(False)
543
520
self._file_message_text_view.show()
545
self._file_message_expander = Gtk.Expander(_i18n('File commit message'))
522
self._file_message_expander = gtk.Expander(_i18n('File commit message'))
546
523
self._file_message_expander.set_expanded(True)
547
524
self._file_message_expander.add(scroller)
548
525
self._add_to_right_table(self._file_message_expander, 1, False)
549
526
self._file_message_expander.show()
551
528
def _construct_global_message(self):
552
self._global_message_label = Gtk.Label(label=_i18n('Global Commit Message'))
529
self._global_message_label = gtk.Label(_i18n('Global Commit Message'))
553
530
self._global_message_label.set_markup(
554
531
_i18n('<b>Global Commit Message</b>'))
555
532
self._global_message_label.set_alignment(0, 0)
558
535
# Can we remove the spacing between the label and the box?
559
536
self._global_message_label.show()
561
scroller = Gtk.ScrolledWindow()
562
scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
538
scroller = gtk.ScrolledWindow()
539
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
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"))
541
self._global_message_text_view = gtk.TextView()
542
self._global_message_text_view.modify_font(pango.FontDescription("Monospace"))
567
543
scroller.add(self._global_message_text_view)
568
scroller.set_shadow_type(Gtk.ShadowType.IN)
544
scroller.set_shadow_type(gtk.SHADOW_IN)
570
546
self._add_to_right_table(scroller, 2, True)
571
self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
547
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
572
548
self._file_message_text_view.set_accepts_tab(False)
573
549
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
699
646
def _on_commit_clicked(self, button):
700
647
""" Commit button clicked handler. """
701
648
self._do_commit()
759
702
specific_files=specific_files,
760
703
revprops=revprops)
761
704
self.committed_revision_id = rev_id
762
# destroy old comments if any
763
SavedCommitMessagesManager().save(self._wt, self._wt.branch)
764
self.response(Gtk.ResponseType.OK)
705
self.response(gtk.RESPONSE_OK)
766
707
def _get_global_commit_message(self):
767
708
buf = self._global_message_text_view.get_buffer()
768
709
start, end = buf.get_bounds()
769
text = buf.get_text(start, end)
770
return _sanitize_and_decode_message(text)
710
return buf.get_text(start, end).decode('utf-8')
772
712
def _set_global_commit_message(self, message):
773
713
"""Just a helper for the test suite."""
794
734
show_offset=False)
795
735
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)