/b-gtk/fix-viz

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/b-gtk/fix-viz

« back to all changes in this revision

Viewing changes to commit.py

  • Committer: Vincent Ladeuil
  • Date: 2008-06-09 15:59:13 UTC
  • mto: This revision was merged to the branch mainline in revision 503.
  • Revision ID: v.ladeuil+lp@free.fr-20080609155913-ueadh6vzmn81wwuk
Fix test failing after a feature rename in bzr.

* tests/test_diff.py:
(TestDiffView.test_unicode):
bzrlib.tests.test_diff.UnicodeFilename has benn renamed
bzrlib.tests.UnicodeFilenameFeature in bzr.

* tests/test_commit.py:
(TestCommitDialog_Commit.test_commit_unicode_messages):
bzrlib.tests.test_diff.UnicodeFilename has benn renamed
bzrlib.tests.UnicodeFilenameFeature in bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
commit.py
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
16
16
 
17
 
import re
18
 
 
19
17
try:
20
18
    import pygtk
21
19
    pygtk.require("2.0")
26
24
import gobject
27
25
import pango
28
26
 
29
 
from bzrlib import (
30
 
    errors,
31
 
    osutils,
32
 
    trace,
33
 
    )
34
 
try:
35
 
    from bzrlib import bencode
36
 
except ImportError:
37
 
    from bzrlib.util import bencode
 
27
import os.path
 
28
import re
 
29
 
 
30
from bzrlib import errors, osutils
 
31
from bzrlib.trace import mutter
 
32
from bzrlib.util import bencode
38
33
 
39
34
from bzrlib.plugins.gtk import _i18n
40
 
from bzrlib.plugins.gtk.dialog import question_dialog
41
 
from bzrlib.plugins.gtk.errors import show_bzr_error
 
35
from dialog import error_dialog, question_dialog
 
36
from errors import show_bzr_error
42
37
 
43
38
try:
44
39
    import dbus
102
97
    return pm
103
98
 
104
99
 
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')
110
 
 
111
 
 
112
100
class CommitDialog(gtk.Dialog):
113
101
    """Implementation of Commit."""
114
102
 
115
103
    def __init__(self, wt, selected=None, parent=None):
116
 
        gtk.Dialog.__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",
 
105
                                  parent=parent,
 
106
                                  flags=0,
 
107
                                  buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
119
108
        self._question_dialog = question_dialog
120
109
 
121
 
        self.set_type_hint(gtk.gdk.WINDOW_TYPE_HINT_NORMAL)
122
 
 
123
110
        self._wt = wt
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
127
114
        self._enable_per_file_commits = True
128
115
        self._commit_all_changes = True
129
116
        self.committed_revision_id = None # Nothing has been committed yet
130
 
        self._saved_commit_messages_manager = SavedCommitMessagesManager(self._wt, self._wt.branch)
131
117
 
132
118
        self.setup_params()
133
119
        self.construct()
202
188
        self._basis_tree.lock_read()
203
189
        try:
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:
209
194
                    enabled = False
210
195
                else:
211
196
                    enabled = True
212
 
                try:
213
 
                    default_message = saved_file_messages[file_id]
214
 
                except KeyError:
215
 
                    default_message = ''
216
197
                item_iter = store.append([
217
198
                    file_id,
218
199
                    real_path.encode('UTF-8'),
219
200
                    enabled,
220
201
                    display_path.encode('UTF-8'),
221
202
                    change_type,
222
 
                    default_message, # Initial comment
 
203
                    '', # Initial comment
223
204
                    ])
224
205
                if self._selected and enabled:
225
206
                    initial_cursor = store.get_path(item_iter)
251
232
                proxy_obj = bus.get_object('org.freedesktop.NetworkManager',
252
233
                                           '/org/freedesktop/NetworkManager')
253
234
            except dbus.DBusException:
254
 
                trace.mutter("networkmanager not available.")
 
235
                mutter("networkmanager not available.")
255
236
                self._check_local.show()
256
237
                return
257
238
            
263
244
            except dbus.DBusException, e:
264
245
                # Silently drop errors. While DBus may be
265
246
                # available, NetworkManager doesn't necessarily have to be
266
 
                trace.mutter("unable to get networkmanager state: %r" % e)
 
247
                mutter("unable to get networkmanager state: %r" % e)
267
248
        self._check_local.show()
268
249
 
269
250
    def _fill_in_per_file_info(self):
322
303
                            gtk.gdk.CONTROL_MASK, 0, self._on_accel_next)
323
304
        self.add_accel_group(group)
324
305
 
325
 
        # ignore the escape key (avoid closing the window)
326
 
        self.connect_object('close', self.emit_stop_by_name, 'close')
327
 
 
328
306
    def _construct_left_pane(self):
329
307
        self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
330
308
        self._construct_file_list()
357
335
        self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
358
336
 
359
337
    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
338
        self._button_commit = gtk.Button(_i18n("Comm_it"), use_underline=True)
365
339
        self._button_commit.connect('clicked', self._on_commit_clicked)
366
340
        self._button_commit.set_flags(gtk.CAN_DEFAULT)
562
536
        scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
563
537
 
564
538
        self._global_message_text_view = gtk.TextView()
565
 
        self._set_global_commit_message(self._saved_commit_messages_manager.get()[0])
566
539
        self._global_message_text_view.modify_font(pango.FontDescription("Monospace"))
567
540
        scroller.add(self._global_message_text_view)
568
541
        scroller.set_shadow_type(gtk.SHADOW_IN)
654
627
            if self._commit_all_changes or record[2]:# [2] checkbox
655
628
                file_id = record[0] # [0] file_id
656
629
                path = record[1]    # [1] real path
657
 
                # [5] commit message
658
 
                file_message = _sanitize_and_decode_message(record[5])
 
630
                file_message = record[5] # [5] commit message
659
631
                files.append(path.decode('UTF-8'))
660
632
                if self._enable_per_file_commits and file_message:
661
633
                    # All of this needs to be utf-8 information
662
 
                    file_message = file_message.encode('UTF-8')
663
634
                    file_info.append({'path':path, 'file_id':file_id,
664
635
                                     'message':file_message})
665
636
        file_info.sort(key=lambda x:(x['path'], x['file_id']))
669
640
            return files, []
670
641
 
671
642
    @show_bzr_error
672
 
    def _on_cancel_clicked(self, button):
673
 
        """ Cancel button clicked handler. """
674
 
        self._do_cancel()
675
 
 
676
 
    @show_bzr_error
677
 
    def _on_delete_window(self, source, event):
678
 
        """ Delete window handler. """
679
 
        self._do_cancel()
680
 
 
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 ?'),
691
 
                parent=self)
692
 
            if response == gtk.RESPONSE_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.RESPONSE_CANCEL) # close window
697
 
 
698
 
    @show_bzr_error
699
643
    def _on_commit_clicked(self, button):
700
644
        """ Commit button clicked handler. """
701
645
        self._do_commit()
706
650
        if message == '':
707
651
            response = self._question_dialog(
708
652
                _i18n('Commit with an empty message?'),
709
 
                _i18n('You can describe your commit intent in the message.'),
710
 
                parent=self)
 
653
                _i18n('You can describe your commit intent in the message.'))
711
654
            if response == gtk.RESPONSE_NO:
712
655
                # Kindly give focus to message area
713
656
                self._global_message_text_view.grab_focus()
727
670
        for path in self._wt.unknowns():
728
671
            response = self._question_dialog(
729
672
                _i18n("Commit with unknowns?"),
730
 
                _i18n("Unknown files exist in the working tree. Commit anyway?"),
731
 
                parent=self)
732
 
                # Doesn't set a parent for the dialog..
 
673
                _i18n("Unknown files exist in the working tree. Commit anyway?"))
733
674
            if response == gtk.RESPONSE_NO:
734
675
                return
735
676
            break
749
690
            response = self._question_dialog(
750
691
                _i18n('Commit with no changes?'),
751
692
                _i18n('There are no changes in the working tree.'
752
 
                      ' Do you want to commit anyway?'),
753
 
                parent=self)
 
693
                      ' Do you want to commit anyway?'))
754
694
            if response == gtk.RESPONSE_YES:
755
695
                rev_id = self._wt.commit(message,
756
696
                               allow_pointless=True,
759
699
                               specific_files=specific_files,
760
700
                               revprops=revprops)
761
701
        self.committed_revision_id = rev_id
762
 
        # destroy old comments if any
763
 
        SavedCommitMessagesManager().save(self._wt, self._wt.branch)
764
702
        self.response(gtk.RESPONSE_OK)
765
703
 
766
704
    def _get_global_commit_message(self):
767
705
        buf = self._global_message_text_view.get_buffer()
768
706
        start, end = buf.get_bounds()
769
 
        text = buf.get_text(start, end)
770
 
        return _sanitize_and_decode_message(text)
 
707
        return buf.get_text(start, end).decode('utf-8')
771
708
 
772
709
    def _set_global_commit_message(self, message):
773
710
        """Just a helper for the test suite."""
794
731
                                       show_offset=False)
795
732
        rev_dict['revision_id'] = rev.revision_id
796
733
        return rev_dict
797
 
 
798
 
 
799
 
class SavedCommitMessagesManager:
800
 
    """Save glogal and per-file commit messages.
801
 
 
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.
804
 
    """
805
 
 
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."""
809
 
        if branch is None:
810
 
            self.global_message = u''
811
 
            self.file_messages = {}
812
 
        else:
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'))
822
 
            else:
823
 
                self.file_messages = {}
824
 
 
825
 
    def get(self):
826
 
        return self.global_message, self.file_messages
827
 
 
828
 
    def is_not_empty(self):
829
 
        return bool(self.global_message or self.file_messages)
830
 
 
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."""
835
 
        file_messages = {}
836
 
        for fi in file_info:
837
 
            file_message = fi['message']
838
 
            if file_message:
839
 
                file_messages[fi['file_id']] = file_message # utf-8 strings
840
 
        for k,v in file_messages.iteritems():
841
 
            try:
842
 
                self.file_messages[k] = v + '\n******\n' + self.file_messages[k]
843
 
            except KeyError:
844
 
                self.file_messages[k] = v
845
 
        if self.global_message:
846
 
            self.global_message = global_message + '\n******\n' \
847
 
                + self.global_message
848
 
        else:
849
 
            self.global_message = global_message
850
 
 
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()
862
 
        # requires one:
863
 
        config.set_user_option(
864
 
            'gtk_file_commit_messages',
865
 
            bencode.bencode(self.file_messages).decode('UTF-8'))
866
 
 
867
 
 
868
 
def save_commit_messages(local, master, old_revno, old_revid,
869
 
                         new_revno, new_revid):
870
 
    b = local
871
 
    if b is None:
872
 
        b = master
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:
880
 
            break
881
 
        cur_revno -= 1
882
 
        rev = b.repository.get_revision(rev_id)
883
 
        file_info = rev.properties.get('file-info', None)
884
 
        if file_info is None:
885
 
            file_info = {}
886
 
        else:
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)
891
 
 
892
 
        parents = graph.get_parent_map([rev_id]).get(rev_id, None)
893
 
        if not parents:
894
 
            continue
895
 
    mgr.save(None, b)