/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: Jelmer Vernooij
  • Date: 2010-05-25 17:09:02 UTC
  • mto: This revision was merged to the branch mainline in revision 691.
  • Revision ID: jelmer@samba.org-20100525170902-3to8g5iw7ovw79kh
Split out olive into a separate directory.

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 os.path
 
18
import re
 
19
 
17
20
try:
18
21
    import pygtk
19
22
    pygtk.require("2.0")
21
24
    pass
22
25
 
23
26
import gtk
24
 
import gtk.glade
25
27
import gobject
26
28
import pango
27
29
 
28
 
import bzrlib.errors as errors
29
 
from bzrlib import osutils
30
 
 
31
 
from dialog import error_dialog, question_dialog
32
 
from guifiles import GLADEFILENAME
33
 
 
34
 
 
35
 
class CommitDialog:
36
 
    """ Display Commit dialog and perform the needed actions. """
37
 
    def __init__(self, wt, wtpath, notbranch):
38
 
        """ Initialize the Commit dialog.
39
 
        :param  wt:         bzr working tree object
40
 
        :param  wtpath:     path to working tree root
41
 
        :param  notbranch:  flag that path is not a brach
42
 
        :type   notbranch:  bool
43
 
        """
44
 
        self.glade = gtk.glade.XML(GLADEFILENAME, 'window_commit', 'olive-gtk')
45
 
        
46
 
        self.wt = wt
47
 
        self.wtpath = wtpath
48
 
        self.notbranch = notbranch
49
 
 
50
 
        # Get some important widgets
51
 
        self.window = self.glade.get_widget('window_commit')
52
 
        self.checkbutton_local = self.glade.get_widget('checkbutton_commit_local')
53
 
        self.textview = self.glade.get_widget('textview_commit')
54
 
        self.file_expander = self.glade.get_widget('expander_commit_select')
55
 
        self.file_view = self.glade.get_widget('treeview_commit_select')
56
 
        self.pending_expander = self.glade.get_widget('expander_commit_pending')
57
 
        self.pending_label = self.glade.get_widget('label_commit_pending')
58
 
        self.pending_view = self.glade.get_widget('treeview_commit_pending')
59
 
 
60
 
        if wt is None or notbranch:
61
 
            return
62
 
        
63
 
        # Set the delta
64
 
        self.old_tree = self.wt.branch.repository.revision_tree(self.wt.branch.last_revision())
65
 
        self.delta = self.wt.changes_from(self.old_tree)
66
 
        
67
 
        # Get pending merges
68
 
        self.pending = self._pending_merges(self.wt)
69
 
        
70
 
        # Dictionary for signal_autoconnect
71
 
        dic = { "on_button_commit_commit_clicked": self.commit,
72
 
                "on_button_commit_cancel_clicked": self.close }
73
 
 
74
 
        # Connect the signals to the handlers
75
 
        self.glade.signal_autoconnect(dic)
76
 
        
77
 
        # Create the file list
78
 
        self._create_file_view()
79
 
        # Create the pending merges
80
 
        self._create_pending_merges()
81
 
    
82
 
    def display(self):
83
 
        """ Display the Push dialog.
84
 
        @return:    True if dialog is shown.
85
 
        """
86
 
        if self.wt is None and not self.notbranch:
87
 
            error_dialog(_('Directory does not have a working tree'),
88
 
                         _('Operation aborted.'))
89
 
            self.close()
90
 
            return False
91
 
        if self.notbranch:
92
 
            error_dialog(_('Directory is not a branch'),
93
 
                         _('You can perform this action only in a branch.'))
94
 
            self.close()
95
 
            return False
 
30
from bzrlib import (
 
31
    branch,
 
32
    errors,
 
33
    osutils,
 
34
    trace,
 
35
    )
 
36
try:
 
37
    from bzrlib import bencode
 
38
except ImportError:
 
39
    from bzrlib.util import bencode
 
40
 
 
41
from bzrlib.plugins.gtk import _i18n
 
42
from bzrlib.plugins.gtk.dialog import question_dialog
 
43
from bzrlib.plugins.gtk.errors import show_bzr_error
 
44
 
 
45
try:
 
46
    import dbus
 
47
    import dbus.glib
 
48
    have_dbus = True
 
49
except ImportError:
 
50
    have_dbus = False
 
51
 
 
52
 
 
53
def pending_revisions(wt):
 
54
    """Return a list of pending merges or None if there are none of them.
 
55
 
 
56
    Arguably this should be a core function, and
 
57
    ``bzrlib.status.show_pending_merges`` should be built on top of it.
 
58
 
 
59
    :return: [(rev, [children])]
 
60
    """
 
61
    parents = wt.get_parent_ids()
 
62
    if len(parents) < 2:
 
63
        return None
 
64
 
 
65
    # The basic pending merge algorithm uses the same algorithm as
 
66
    # bzrlib.status.show_pending_merges
 
67
    pending = parents[1:]
 
68
    branch = wt.branch
 
69
    last_revision = parents[0]
 
70
 
 
71
    if last_revision is not None:
 
72
        try:
 
73
            ignore = set(branch.repository.get_ancestry(last_revision,
 
74
                                                        topo_sorted=False))
 
75
        except errors.NoSuchRevision:
 
76
            # the last revision is a ghost : assume everything is new
 
77
            # except for it
 
78
            ignore = set([None, last_revision])
 
79
    else:
 
80
        ignore = set([None])
 
81
 
 
82
    pm = []
 
83
    for merge in pending:
 
84
        ignore.add(merge)
 
85
        try:
 
86
            rev = branch.repository.get_revision(merge)
 
87
            children = []
 
88
            pm.append((rev, children))
 
89
 
 
90
            # This does need to be topo sorted, so we search backwards
 
91
            inner_merges = branch.repository.get_ancestry(merge)
 
92
            assert inner_merges[0] is None
 
93
            inner_merges.pop(0)
 
94
            for mmerge in reversed(inner_merges):
 
95
                if mmerge in ignore:
 
96
                    continue
 
97
                rev = branch.repository.get_revision(mmerge)
 
98
                children.append(rev)
 
99
 
 
100
                ignore.add(mmerge)
 
101
        except errors.NoSuchRevision:
 
102
            print "DEBUG: NoSuchRevision:", merge
 
103
 
 
104
    return pm
 
105
 
 
106
 
 
107
_newline_variants_re = re.compile(r'\r\n?')
 
108
def _sanitize_and_decode_message(utf8_message):
 
109
    """Turn a utf-8 message into a sanitized Unicode message."""
 
110
    fixed_newline = _newline_variants_re.sub('\n', utf8_message)
 
111
    return fixed_newline.decode('utf-8')
 
112
 
 
113
 
 
114
class CommitDialog(gtk.Dialog):
 
115
    """Implementation of Commit."""
 
116
 
 
117
    def __init__(self, wt, selected=None, parent=None):
 
118
        gtk.Dialog.__init__(self, title="Commit to %s" % wt.basedir,
 
119
                            parent=parent, flags=0,)
 
120
        self.connect('delete-event', self._on_delete_window)
 
121
        self._question_dialog = question_dialog
 
122
 
 
123
        self.set_type_hint(gtk.gdk.WINDOW_TYPE_HINT_NORMAL)
 
124
 
 
125
        self._wt = wt
 
126
        # TODO: Do something with this value, it is used by Olive
 
127
        #       It used to set all changes but this one to False
 
128
        self._selected = selected
 
129
        self._enable_per_file_commits = True
 
130
        self._commit_all_changes = True
 
131
        self.committed_revision_id = None # Nothing has been committed yet
 
132
        self._saved_commit_messages_manager = SavedCommitMessagesManager(self._wt, self._wt.branch)
 
133
 
 
134
        self.setup_params()
 
135
        self.construct()
 
136
        self.fill_in_data()
 
137
 
 
138
    def setup_params(self):
 
139
        """Setup the member variables for state."""
 
140
        self._basis_tree = self._wt.basis_tree()
 
141
        self._delta = None
 
142
        self._pending = pending_revisions(self._wt)
 
143
 
 
144
        self._is_checkout = (self._wt.branch.get_bound_location() is not None)
 
145
 
 
146
    def fill_in_data(self):
 
147
        # Now that we are built, handle changes to the view based on the state
 
148
        self._fill_in_pending()
 
149
        self._fill_in_diff()
 
150
        self._fill_in_files()
 
151
        self._fill_in_checkout()
 
152
        self._fill_in_per_file_info()
 
153
 
 
154
    def _fill_in_pending(self):
 
155
        if not self._pending:
 
156
            self._pending_box.hide()
 
157
            return
 
158
 
 
159
        # TODO: We'd really prefer this to be a nested list
 
160
        for rev, children in self._pending:
 
161
            rev_info = self._rev_to_pending_info(rev)
 
162
            self._pending_store.append([
 
163
                rev_info['revision_id'],
 
164
                rev_info['date'],
 
165
                rev_info['committer'],
 
166
                rev_info['summary'],
 
167
                ])
 
168
            for child in children:
 
169
                rev_info = self._rev_to_pending_info(child)
 
170
                self._pending_store.append([
 
171
                    rev_info['revision_id'],
 
172
                    rev_info['date'],
 
173
                    rev_info['committer'],
 
174
                    rev_info['summary'],
 
175
                    ])
 
176
        self._pending_box.show()
 
177
 
 
178
    def _fill_in_files(self):
 
179
        # We should really use add a progress bar of some kind.
 
180
        # While we fill in the view, hide the store
 
181
        store = self._files_store
 
182
        self._treeview_files.set_model(None)
 
183
 
 
184
        added = _i18n('added')
 
185
        removed = _i18n('removed')
 
186
        renamed = _i18n('renamed')
 
187
        renamed_and_modified = _i18n('renamed and modified')
 
188
        modified = _i18n('modified')
 
189
        kind_changed = _i18n('kind changed')
 
190
 
 
191
        # The store holds:
 
192
        # [file_id, real path, checkbox, display path, changes type, message]
 
193
        # iter_changes returns:
 
194
        # (file_id, (path_in_source, path_in_target),
 
195
        #  changed_content, versioned, parent, name, kind,
 
196
        #  executable)
 
197
 
 
198
        all_enabled = (self._selected is None)
 
199
        # The first entry is always the 'whole tree'
 
200
        all_iter = store.append([None, None, all_enabled, 'All Files', '', ''])
 
201
        initial_cursor = store.get_path(all_iter)
 
202
        # should we pass specific_files?
 
203
        self._wt.lock_read()
 
204
        self._basis_tree.lock_read()
 
205
        try:
 
206
            from diff import iter_changes_to_status
 
207
            saved_file_messages = self._saved_commit_messages_manager.get()[1]
 
208
            for (file_id, real_path, change_type, display_path
 
209
                ) in iter_changes_to_status(self._basis_tree, self._wt):
 
210
                if self._selected and real_path != self._selected:
 
211
                    enabled = False
 
212
                else:
 
213
                    enabled = True
 
214
                try:
 
215
                    default_message = saved_file_messages[file_id]
 
216
                except KeyError:
 
217
                    default_message = ''
 
218
                item_iter = store.append([
 
219
                    file_id,
 
220
                    real_path.encode('UTF-8'),
 
221
                    enabled,
 
222
                    display_path.encode('UTF-8'),
 
223
                    change_type,
 
224
                    default_message, # Initial comment
 
225
                    ])
 
226
                if self._selected and enabled:
 
227
                    initial_cursor = store.get_path(item_iter)
 
228
        finally:
 
229
            self._basis_tree.unlock()
 
230
            self._wt.unlock()
 
231
 
 
232
        self._treeview_files.set_model(store)
 
233
        self._last_selected_file = None
 
234
        # This sets the cursor, which causes the expander to close, which
 
235
        # causes the _file_message_text_view to never get realized. So we have
 
236
        # to give it a little kick, or it warns when we try to grab the focus
 
237
        self._treeview_files.set_cursor(initial_cursor)
 
238
 
 
239
        def _realize_file_message_tree_view(*args):
 
240
            self._file_message_text_view.realize()
 
241
        self.connect_after('realize', _realize_file_message_tree_view)
 
242
 
 
243
    def _fill_in_diff(self):
 
244
        self._diff_view.set_trees(self._wt, self._basis_tree)
 
245
 
 
246
    def _fill_in_checkout(self):
 
247
        if not self._is_checkout:
 
248
            self._check_local.hide()
 
249
            return
 
250
        if have_dbus:
 
251
            bus = dbus.SystemBus()
 
252
            try:
 
253
                proxy_obj = bus.get_object('org.freedesktop.NetworkManager',
 
254
                                           '/org/freedesktop/NetworkManager')
 
255
            except dbus.DBusException:
 
256
                trace.mutter("networkmanager not available.")
 
257
                self._check_local.show()
 
258
                return
 
259
            
 
260
            dbus_iface = dbus.Interface(proxy_obj,
 
261
                                        'org.freedesktop.NetworkManager')
 
262
            try:
 
263
                # 3 is the enum value for STATE_CONNECTED
 
264
                self._check_local.set_active(dbus_iface.state() != 3)
 
265
            except dbus.DBusException, e:
 
266
                # Silently drop errors. While DBus may be
 
267
                # available, NetworkManager doesn't necessarily have to be
 
268
                trace.mutter("unable to get networkmanager state: %r" % e)
 
269
        self._check_local.show()
 
270
 
 
271
    def _fill_in_per_file_info(self):
 
272
        config = self._wt.branch.get_config()
 
273
        enable_per_file_commits = config.get_user_option('per_file_commits')
 
274
        if (enable_per_file_commits is None
 
275
            or enable_per_file_commits.lower()
 
276
                not in ('y', 'yes', 'on', 'enable', '1', 't', 'true')):
 
277
            self._enable_per_file_commits = False
96
278
        else:
97
 
            if self.wt.branch.get_bound_location() is not None:
98
 
                # we have a checkout, so the local commit checkbox must appear
99
 
                self.checkbutton_local.show()
100
 
            
101
 
            if self.pending:
102
 
                # There are pending merges, file selection not supported
103
 
                self.file_expander.set_expanded(False)
104
 
                self.file_view.set_sensitive(False)
105
 
            else:
106
 
                # No pending merges
107
 
                self.pending_expander.hide()
108
 
            
109
 
            self.textview.modify_font(pango.FontDescription("Monospace"))
110
 
            self.window.show()
111
 
            return True
112
 
    
113
 
    def _create_file_view(self):
114
 
        self.file_store = gtk.ListStore(gobject.TYPE_BOOLEAN,   # [0] checkbox
115
 
                                        gobject.TYPE_STRING,    # [1] path to display
116
 
                                        gobject.TYPE_STRING,    # [2] changes type
117
 
                                        gobject.TYPE_STRING)    # [3] real path
118
 
        self.file_view.set_model(self.file_store)
 
279
            self._enable_per_file_commits = True
 
280
        if not self._enable_per_file_commits:
 
281
            self._file_message_expander.hide()
 
282
            self._global_message_label.set_markup(_i18n('<b>Commit Message</b>'))
 
283
 
 
284
    def _compute_delta(self):
 
285
        self._delta = self._wt.changes_from(self._basis_tree)
 
286
 
 
287
    def construct(self):
 
288
        """Build up the dialog widgets."""
 
289
        # The primary pane which splits it into left and right (adjustable)
 
290
        # sections.
 
291
        self._hpane = gtk.HPaned()
 
292
 
 
293
        self._construct_left_pane()
 
294
        self._construct_right_pane()
 
295
        self._construct_action_pane()
 
296
 
 
297
        self.vbox.pack_start(self._hpane)
 
298
        self._hpane.show()
 
299
        self.set_focus(self._global_message_text_view)
 
300
 
 
301
        self._construct_accelerators()
 
302
        self._set_sizes()
 
303
 
 
304
    def _set_sizes(self):
 
305
        # This seems like a reasonable default, we might like it to
 
306
        # be a bit wider, so that by default we can fit an 80-line diff in the
 
307
        # diff window.
 
308
        # Alternatively, we should be saving the last position/size rather than
 
309
        # setting it to a fixed value every time we start up.
 
310
        screen = self.get_screen()
 
311
        monitor = 0 # We would like it to be the monitor we are going to
 
312
                    # display on, but I don't know how to figure that out
 
313
                    # Only really useful for freaks like me that run dual
 
314
                    # monitor, with different sizes on the monitors
 
315
        monitor_rect = screen.get_monitor_geometry(monitor)
 
316
        width = int(monitor_rect.width * 0.66)
 
317
        height = int(monitor_rect.height * 0.66)
 
318
        self.set_default_size(width, height)
 
319
        self._hpane.set_position(300)
 
320
 
 
321
    def _construct_accelerators(self):
 
322
        group = gtk.AccelGroup()
 
323
        group.connect_group(gtk.gdk.keyval_from_name('N'),
 
324
                            gtk.gdk.CONTROL_MASK, 0, self._on_accel_next)
 
325
        self.add_accel_group(group)
 
326
 
 
327
        # ignore the escape key (avoid closing the window)
 
328
        self.connect_object('close', self.emit_stop_by_name, 'close')
 
329
 
 
330
    def _construct_left_pane(self):
 
331
        self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
 
332
        self._construct_file_list()
 
333
        self._construct_pending_list()
 
334
 
 
335
        self._check_local = gtk.CheckButton(_i18n("_Only commit locally"),
 
336
                                            use_underline=True)
 
337
        self._left_pane_box.pack_end(self._check_local, False, False)
 
338
        self._check_local.set_active(False)
 
339
 
 
340
        self._hpane.pack1(self._left_pane_box, resize=False, shrink=False)
 
341
        self._left_pane_box.show()
 
342
 
 
343
    def _construct_right_pane(self):
 
344
        # TODO: I really want to make it so the diff view gets more space than
 
345
        # the global commit message, and the per-file commit message gets even
 
346
        # less. When I did it with wxGlade, I set it to 4 for diff, 2 for
 
347
        # commit, and 1 for file commit, and it looked good. But I don't seem
 
348
        # to have a way to do that with the gtk boxes... :( (Which is extra
 
349
        # weird since wx uses gtk on Linux...)
 
350
        self._right_pane_table = gtk.Table(rows=10, columns=1, homogeneous=False)
 
351
        self._right_pane_table.set_row_spacings(5)
 
352
        self._right_pane_table.set_col_spacings(5)
 
353
        self._right_pane_table_row = 0
 
354
        self._construct_diff_view()
 
355
        self._construct_file_message()
 
356
        self._construct_global_message()
 
357
 
 
358
        self._right_pane_table.show()
 
359
        self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
 
360
 
 
361
    def _construct_action_pane(self):
 
362
        self._button_cancel = gtk.Button(stock=gtk.STOCK_CANCEL)
 
363
        self._button_cancel.connect('clicked', self._on_cancel_clicked)
 
364
        self._button_cancel.show()
 
365
        self.action_area.pack_end(self._button_cancel)
 
366
        self._button_commit = gtk.Button(_i18n("Comm_it"), use_underline=True)
 
367
        self._button_commit.connect('clicked', self._on_commit_clicked)
 
368
        self._button_commit.set_flags(gtk.CAN_DEFAULT)
 
369
        self._button_commit.show()
 
370
        self.action_area.pack_end(self._button_commit)
 
371
        self._button_commit.grab_default()
 
372
 
 
373
    def _add_to_right_table(self, widget, weight, expanding=False):
 
374
        """Add another widget to the table
 
375
 
 
376
        :param widget: The object to add
 
377
        :param weight: How many rows does this widget get to request
 
378
        :param expanding: Should expand|fill|shrink be set?
 
379
        """
 
380
        end_row = self._right_pane_table_row + weight
 
381
        options = 0
 
382
        expand_opts = gtk.EXPAND | gtk.FILL | gtk.SHRINK
 
383
        if expanding:
 
384
            options = expand_opts
 
385
        self._right_pane_table.attach(widget, 0, 1,
 
386
                                      self._right_pane_table_row, end_row,
 
387
                                      xoptions=expand_opts, yoptions=options)
 
388
        self._right_pane_table_row = end_row
 
389
 
 
390
    def _construct_file_list(self):
 
391
        self._files_box = gtk.VBox(homogeneous=False, spacing=0)
 
392
        file_label = gtk.Label(_i18n('Files'))
 
393
        # file_label.show()
 
394
        self._files_box.pack_start(file_label, expand=False)
 
395
 
 
396
        self._commit_all_files_radio = gtk.RadioButton(
 
397
            None, _i18n("Commit all changes"))
 
398
        self._files_box.pack_start(self._commit_all_files_radio, expand=False)
 
399
        self._commit_all_files_radio.show()
 
400
        self._commit_all_files_radio.connect('toggled',
 
401
            self._toggle_commit_selection)
 
402
        self._commit_selected_radio = gtk.RadioButton(
 
403
            self._commit_all_files_radio, _i18n("Only commit selected changes"))
 
404
        self._files_box.pack_start(self._commit_selected_radio, expand=False)
 
405
        self._commit_selected_radio.show()
 
406
        self._commit_selected_radio.connect('toggled',
 
407
            self._toggle_commit_selection)
 
408
        if self._pending:
 
409
            self._commit_all_files_radio.set_label(_i18n('Commit all changes*'))
 
410
            self._commit_all_files_radio.set_sensitive(False)
 
411
            self._commit_selected_radio.set_sensitive(False)
 
412
 
 
413
        scroller = gtk.ScrolledWindow()
 
414
        scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
 
415
        self._treeview_files = gtk.TreeView()
 
416
        self._treeview_files.show()
 
417
        scroller.add(self._treeview_files)
 
418
        scroller.set_shadow_type(gtk.SHADOW_IN)
 
419
        scroller.show()
 
420
        self._files_box.pack_start(scroller,
 
421
                                   expand=True, fill=True)
 
422
        self._files_box.show()
 
423
        self._left_pane_box.pack_start(self._files_box)
 
424
 
 
425
        # Keep note that all strings stored in a ListStore must be UTF-8
 
426
        # strings. GTK does not support directly setting and restoring Unicode
 
427
        # objects.
 
428
        liststore = gtk.ListStore(
 
429
            gobject.TYPE_STRING,  # [0] file_id
 
430
            gobject.TYPE_STRING,  # [1] real path
 
431
            gobject.TYPE_BOOLEAN, # [2] checkbox
 
432
            gobject.TYPE_STRING,  # [3] display path
 
433
            gobject.TYPE_STRING,  # [4] changes type
 
434
            gobject.TYPE_STRING,  # [5] commit message
 
435
            )
 
436
        self._files_store = liststore
 
437
        self._treeview_files.set_model(liststore)
119
438
        crt = gtk.CellRendererToggle()
120
 
        crt.set_property("activatable", True)
121
 
        crt.connect("toggled", self._toggle_commit, self.file_store)
122
 
        self.file_view.append_column(gtk.TreeViewColumn(_('Commit'),
123
 
                                     crt, active=0))
124
 
        self.file_view.append_column(gtk.TreeViewColumn(_('Path'),
125
 
                                     gtk.CellRendererText(), text=1))
126
 
        self.file_view.append_column(gtk.TreeViewColumn(_('Type'),
127
 
                                     gtk.CellRendererText(), text=2))
128
 
 
129
 
        for path, id, kind in self.delta.added:
130
 
            marker = osutils.kind_marker(kind)
131
 
            self.file_store.append([ True, path+marker, _('added'), path ])
132
 
 
133
 
        for path, id, kind in self.delta.removed:
134
 
            marker = osutils.kind_marker(kind)
135
 
            self.file_store.append([ True, path+marker, _('removed'), path ])
136
 
 
137
 
        for oldpath, newpath, id, kind, text_modified, meta_modified in self.delta.renamed:
138
 
            marker = osutils.kind_marker(kind)
139
 
            if text_modified or meta_modified:
140
 
                changes = _('renamed and modified')
141
 
            else:
142
 
                changes = _('renamed')
143
 
            self.file_store.append([ True,
144
 
                                     oldpath+marker + '  =>  ' + newpath+marker,
145
 
                                     changes,
146
 
                                     newpath
147
 
                                   ])
148
 
 
149
 
        for path, id, kind, text_modified, meta_modified in self.delta.modified:
150
 
            marker = osutils.kind_marker(kind)
151
 
            self.file_store.append([ True, path+marker, _('modified'), path ])
152
 
    
153
 
    def _create_pending_merges(self):
154
 
        if not self.pending:
155
 
            # hide unused pending merge part
156
 
            scrolled_window = self.glade.get_widget('scrolledwindow_commit_pending')
157
 
            parent = scrolled_window.get_parent()
158
 
            parent.remove(scrolled_window)
159
 
            parent = self.pending_label.get_parent()
160
 
            parent.remove(self.pending_label)
 
439
        crt.set_property('activatable', not bool(self._pending))
 
440
        crt.connect("toggled", self._toggle_commit, self._files_store)
 
441
        if self._pending:
 
442
            name = _i18n('Commit*')
 
443
        else:
 
444
            name = _i18n('Commit')
 
445
        commit_col = gtk.TreeViewColumn(name, crt, active=2)
 
446
        commit_col.set_visible(False)
 
447
        self._treeview_files.append_column(commit_col)
 
448
        self._treeview_files.append_column(gtk.TreeViewColumn(_i18n('Path'),
 
449
                                           gtk.CellRendererText(), text=3))
 
450
        self._treeview_files.append_column(gtk.TreeViewColumn(_i18n('Type'),
 
451
                                           gtk.CellRendererText(), text=4))
 
452
        self._treeview_files.connect('cursor-changed',
 
453
                                     self._on_treeview_files_cursor_changed)
 
454
 
 
455
    def _toggle_commit(self, cell, path, model):
 
456
        if model[path][0] is None: # No file_id means 'All Files'
 
457
            new_val = not model[path][2]
 
458
            for node in model:
 
459
                node[2] = new_val
 
460
        else:
 
461
            model[path][2] = not model[path][2]
 
462
 
 
463
    def _toggle_commit_selection(self, button):
 
464
        all_files = self._commit_all_files_radio.get_active()
 
465
        if self._commit_all_changes != all_files:
 
466
            checked_col = self._treeview_files.get_column(0)
 
467
            self._commit_all_changes = all_files
 
468
            if all_files:
 
469
                checked_col.set_visible(False)
 
470
            else:
 
471
                checked_col.set_visible(True)
 
472
            renderer = checked_col.get_cell_renderers()[0]
 
473
            renderer.set_property('activatable', not all_files)
 
474
 
 
475
    def _construct_pending_list(self):
 
476
        # Pending information defaults to hidden, we put it all in 1 box, so
 
477
        # that we can show/hide all of them at once
 
478
        self._pending_box = gtk.VBox()
 
479
        self._pending_box.hide()
 
480
 
 
481
        pending_message = gtk.Label()
 
482
        pending_message.set_markup(
 
483
            _i18n('<i>* Cannot select specific files when merging</i>'))
 
484
        self._pending_box.pack_start(pending_message, expand=False, padding=5)
 
485
        pending_message.show()
 
486
 
 
487
        pending_label = gtk.Label(_i18n('Pending Revisions'))
 
488
        self._pending_box.pack_start(pending_label, expand=False, padding=0)
 
489
        pending_label.show()
 
490
 
 
491
        scroller = gtk.ScrolledWindow()
 
492
        scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
 
493
        self._treeview_pending = gtk.TreeView()
 
494
        scroller.add(self._treeview_pending)
 
495
        scroller.set_shadow_type(gtk.SHADOW_IN)
 
496
        scroller.show()
 
497
        self._pending_box.pack_start(scroller,
 
498
                                     expand=True, fill=True, padding=5)
 
499
        self._treeview_pending.show()
 
500
        self._left_pane_box.pack_start(self._pending_box)
 
501
 
 
502
        liststore = gtk.ListStore(gobject.TYPE_STRING, # revision_id
 
503
                                  gobject.TYPE_STRING, # date
 
504
                                  gobject.TYPE_STRING, # committer
 
505
                                  gobject.TYPE_STRING, # summary
 
506
                                 )
 
507
        self._pending_store = liststore
 
508
        self._treeview_pending.set_model(liststore)
 
509
        self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Date'),
 
510
                                             gtk.CellRendererText(), text=1))
 
511
        self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Committer'),
 
512
                                             gtk.CellRendererText(), text=2))
 
513
        self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Summary'),
 
514
                                             gtk.CellRendererText(), text=3))
 
515
 
 
516
    def _construct_diff_view(self):
 
517
        from diff import DiffView
 
518
 
 
519
        # TODO: jam 2007-10-30 The diff label is currently disabled. If we
 
520
        #       decide that we really don't ever want to display it, we should
 
521
        #       actually remove it, and other references to it, along with the
 
522
        #       tests that it is set properly.
 
523
        self._diff_label = gtk.Label(_i18n('Diff for whole tree'))
 
524
        self._diff_label.set_alignment(0, 0)
 
525
        self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
 
526
        self._add_to_right_table(self._diff_label, 1, False)
 
527
        # self._diff_label.show()
 
528
 
 
529
        self._diff_view = DiffView()
 
530
        self._add_to_right_table(self._diff_view, 4, True)
 
531
        self._diff_view.show()
 
532
 
 
533
    def _construct_file_message(self):
 
534
        scroller = gtk.ScrolledWindow()
 
535
        scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
 
536
 
 
537
        self._file_message_text_view = gtk.TextView()
 
538
        scroller.add(self._file_message_text_view)
 
539
        scroller.set_shadow_type(gtk.SHADOW_IN)
 
540
        scroller.show()
 
541
 
 
542
        self._file_message_text_view.modify_font(pango.FontDescription("Monospace"))
 
543
        self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
 
544
        self._file_message_text_view.set_accepts_tab(False)
 
545
        self._file_message_text_view.show()
 
546
 
 
547
        self._file_message_expander = gtk.Expander(_i18n('File commit message'))
 
548
        self._file_message_expander.set_expanded(True)
 
549
        self._file_message_expander.add(scroller)
 
550
        self._add_to_right_table(self._file_message_expander, 1, False)
 
551
        self._file_message_expander.show()
 
552
 
 
553
    def _construct_global_message(self):
 
554
        self._global_message_label = gtk.Label(_i18n('Global Commit Message'))
 
555
        self._global_message_label.set_markup(
 
556
            _i18n('<b>Global Commit Message</b>'))
 
557
        self._global_message_label.set_alignment(0, 0)
 
558
        self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
 
559
        self._add_to_right_table(self._global_message_label, 1, False)
 
560
        # Can we remove the spacing between the label and the box?
 
561
        self._global_message_label.show()
 
562
 
 
563
        scroller = gtk.ScrolledWindow()
 
564
        scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
 
565
 
 
566
        self._global_message_text_view = gtk.TextView()
 
567
        self._set_global_commit_message(self._saved_commit_messages_manager.get()[0])
 
568
        self._global_message_text_view.modify_font(pango.FontDescription("Monospace"))
 
569
        scroller.add(self._global_message_text_view)
 
570
        scroller.set_shadow_type(gtk.SHADOW_IN)
 
571
        scroller.show()
 
572
        self._add_to_right_table(scroller, 2, True)
 
573
        self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
 
574
        self._file_message_text_view.set_accepts_tab(False)
 
575
        self._global_message_text_view.show()
 
576
 
 
577
    def _on_treeview_files_cursor_changed(self, treeview):
 
578
        treeselection = treeview.get_selection()
 
579
        (model, selection) = treeselection.get_selected()
 
580
 
 
581
        if selection is not None:
 
582
            path, display_path = model.get(selection, 1, 3)
 
583
            self._diff_label.set_text(_i18n('Diff for ') + display_path)
 
584
            if path is None:
 
585
                self._diff_view.show_diff(None)
 
586
            else:
 
587
                self._diff_view.show_diff([path.decode('UTF-8')])
 
588
            self._update_per_file_info(selection)
 
589
 
 
590
    def _on_accel_next(self, accel_group, window, keyval, modifier):
 
591
        # We don't really care about any of the parameters, because we know
 
592
        # where this message came from
 
593
        tree_selection = self._treeview_files.get_selection()
 
594
        (model, selection) = tree_selection.get_selected()
 
595
        if selection is None:
 
596
            next = None
 
597
        else:
 
598
            next = model.iter_next(selection)
 
599
 
 
600
        if next is None:
 
601
            # We have either made it to the end of the list, or nothing was
 
602
            # selected. Either way, select All Files, and jump to the global
 
603
            # commit message.
 
604
            self._treeview_files.set_cursor((0,))
 
605
            self._global_message_text_view.grab_focus()
 
606
        else:
 
607
            # Set the cursor to this entry, and jump to the per-file commit
 
608
            # message
 
609
            self._treeview_files.set_cursor(model.get_path(next))
 
610
            self._file_message_text_view.grab_focus()
 
611
 
 
612
    def _save_current_file_message(self):
 
613
        if self._last_selected_file is None:
 
614
            return # Nothing to save
 
615
        text_buffer = self._file_message_text_view.get_buffer()
 
616
        cur_text = text_buffer.get_text(text_buffer.get_start_iter(),
 
617
                                        text_buffer.get_end_iter())
 
618
        last_selected = self._files_store.get_iter(self._last_selected_file)
 
619
        self._files_store.set_value(last_selected, 5, cur_text)
 
620
 
 
621
    def _update_per_file_info(self, selection):
 
622
        # The node is changing, so cache the current message
 
623
        if not self._enable_per_file_commits:
161
624
            return
162
 
        
163
 
        liststore = gtk.ListStore(gobject.TYPE_STRING,
164
 
                                  gobject.TYPE_STRING,
165
 
                                  gobject.TYPE_STRING)
166
 
        self.pending_view.set_model(liststore)
167
 
        
168
 
        self.pending_view.append_column(gtk.TreeViewColumn(_('Date'),
169
 
                                        gtk.CellRendererText(), text=0))
170
 
        self.pending_view.append_column(gtk.TreeViewColumn(_('Committer'),
171
 
                                        gtk.CellRendererText(), text=1))
172
 
        self.pending_view.append_column(gtk.TreeViewColumn(_('Summary'),
173
 
                                        gtk.CellRendererText(), text=2))
174
 
        
175
 
        for item in self.pending:
176
 
            liststore.append([ item['date'],
177
 
                               item['committer'],
178
 
                               item['summary'] ])
179
 
    
 
625
 
 
626
        self._save_current_file_message()
 
627
        text_buffer = self._file_message_text_view.get_buffer()
 
628
        file_id, display_path, message = self._files_store.get(selection, 0, 3, 5)
 
629
        if file_id is None: # Whole tree
 
630
            self._file_message_expander.set_label(_i18n('File commit message'))
 
631
            self._file_message_expander.set_expanded(False)
 
632
            self._file_message_expander.set_sensitive(False)
 
633
            text_buffer.set_text('')
 
634
            self._last_selected_file = None
 
635
        else:
 
636
            self._file_message_expander.set_label(_i18n('Commit message for ')
 
637
                                                  + display_path)
 
638
            self._file_message_expander.set_expanded(True)
 
639
            self._file_message_expander.set_sensitive(True)
 
640
            text_buffer.set_text(message)
 
641
            self._last_selected_file = self._files_store.get_path(selection)
 
642
 
180
643
    def _get_specific_files(self):
181
 
        ret = []
182
 
        it = self.file_store.get_iter_first()
183
 
        while it:
184
 
            if self.file_store.get_value(it, 0):
185
 
                # get real path from hidden column 3
186
 
                ret.append(self.file_store.get_value(it, 3))
187
 
            it = self.file_store.iter_next(it)
188
 
 
189
 
        return ret
190
 
    
191
 
    def _toggle_commit(self, cell, path, model):
192
 
        model[path][0] = not model[path][0]
193
 
        return
194
 
    
195
 
    def _pending_merges(self, wt):
196
 
        """ Return a list of pending merges or None if there are none of them. """
197
 
        parents = wt.get_parent_ids()
198
 
        if len(parents) < 2:
199
 
            return None
200
 
        
201
 
        import re
202
 
        from bzrlib.osutils import format_date
203
 
        
204
 
        pending = parents[1:]
205
 
        branch = wt.branch
206
 
        last_revision = parents[0]
207
 
        
208
 
        if last_revision is not None:
209
 
            try:
210
 
                ignore = set(branch.repository.get_ancestry(last_revision))
211
 
            except errors.NoSuchRevision:
212
 
                # the last revision is a ghost : assume everything is new 
213
 
                # except for it
214
 
                ignore = set([None, last_revision])
215
 
        else:
216
 
            ignore = set([None])
217
 
        
218
 
        pm = []
219
 
        for merge in pending:
220
 
            ignore.add(merge)
221
 
            try:
222
 
                m_revision = branch.repository.get_revision(merge)
223
 
                
224
 
                rev = {}
225
 
                rev['committer'] = re.sub('<.*@.*>', '', m_revision.committer).strip(' ')
226
 
                rev['summary'] = m_revision.get_summary()
227
 
                rev['date'] = format_date(m_revision.timestamp,
228
 
                                          m_revision.timezone or 0, 
229
 
                                          'original', date_fmt="%Y-%m-%d",
230
 
                                          show_offset=False)
231
 
                
232
 
                pm.append(rev)
233
 
                
234
 
                inner_merges = branch.repository.get_ancestry(merge)
235
 
                assert inner_merges[0] is None
236
 
                inner_merges.pop(0)
237
 
                inner_merges.reverse()
238
 
                for mmerge in inner_merges:
239
 
                    if mmerge in ignore:
240
 
                        continue
241
 
                    mm_revision = branch.repository.get_revision(mmerge)
242
 
                    
243
 
                    rev = {}
244
 
                    rev['committer'] = re.sub('<.*@.*>', '', mm_revision.committer).strip(' ')
245
 
                    rev['summary'] = mm_revision.get_summary()
246
 
                    rev['date'] = format_date(mm_revision.timestamp,
247
 
                                              mm_revision.timezone or 0, 
248
 
                                              'original', date_fmt="%Y-%m-%d",
249
 
                                              show_offset=False)
250
 
                
251
 
                    pm.append(rev)
252
 
                    
253
 
                    ignore.add(mmerge)
254
 
            except errors.NoSuchRevision:
255
 
                print "DEBUG: NoSuchRevision:", merge
256
 
        
257
 
        return pm
258
 
 
259
 
    def commit(self, widget):
260
 
        textbuffer = self.textview.get_buffer()
261
 
        start, end = textbuffer.get_bounds()
262
 
        message = textbuffer.get_text(start, end).decode('utf-8')
263
 
        
264
 
        checkbutton_strict = self.glade.get_widget('checkbutton_commit_strict')
265
 
        checkbutton_force = self.glade.get_widget('checkbutton_commit_force')
266
 
        
267
 
        if not self.pending:
268
 
            specific_files = self._get_specific_files()
269
 
        else:
270
 
            specific_files = None
 
644
        """Return the list of selected paths, and file info.
 
645
 
 
646
        :return: ([unicode paths], [{utf-8 file info}]
 
647
        """
 
648
        self._save_current_file_message()
 
649
        files = []
 
650
        records = iter(self._files_store)
 
651
        rec = records.next() # Skip the All Files record
 
652
        assert rec[0] is None, "Are we skipping the wrong record?"
 
653
 
 
654
        file_info = []
 
655
        for record in records:
 
656
            if self._commit_all_changes or record[2]:# [2] checkbox
 
657
                file_id = record[0] # [0] file_id
 
658
                path = record[1]    # [1] real path
 
659
                # [5] commit message
 
660
                file_message = _sanitize_and_decode_message(record[5])
 
661
                files.append(path.decode('UTF-8'))
 
662
                if self._enable_per_file_commits and file_message:
 
663
                    # All of this needs to be utf-8 information
 
664
                    file_message = file_message.encode('UTF-8')
 
665
                    file_info.append({'path':path, 'file_id':file_id,
 
666
                                     'message':file_message})
 
667
        file_info.sort(key=lambda x:(x['path'], x['file_id']))
 
668
        if self._enable_per_file_commits:
 
669
            return files, file_info
 
670
        else:
 
671
            return files, []
 
672
 
 
673
    @show_bzr_error
 
674
    def _on_cancel_clicked(self, button):
 
675
        """ Cancel button clicked handler. """
 
676
        self._do_cancel()
 
677
 
 
678
    @show_bzr_error
 
679
    def _on_delete_window(self, source, event):
 
680
        """ Delete window handler. """
 
681
        self._do_cancel()
 
682
 
 
683
    def _do_cancel(self):
 
684
        """If requested, saves commit messages when cancelling gcommit; they are re-used by a next gcommit"""
 
685
        mgr = SavedCommitMessagesManager()
 
686
        self._saved_commit_messages_manager = mgr
 
687
        mgr.insert(self._get_global_commit_message(),
 
688
                   self._get_specific_files()[1])
 
689
        if mgr.is_not_empty(): # maybe worth saving
 
690
            response = self._question_dialog(
 
691
                _i18n('Commit cancelled'),
 
692
                _i18n('Do you want to save your commit messages ?'),
 
693
                parent=self)
 
694
            if response == gtk.RESPONSE_NO:
 
695
                 # save nothing and destroy old comments if any
 
696
                mgr = SavedCommitMessagesManager()
 
697
        mgr.save(self._wt, self._wt.branch)
 
698
        self.response(gtk.RESPONSE_CANCEL) # close window
 
699
 
 
700
    @show_bzr_error
 
701
    def _on_commit_clicked(self, button):
 
702
        """ Commit button clicked handler. """
 
703
        self._do_commit()
 
704
 
 
705
    def _do_commit(self):
 
706
        message = self._get_global_commit_message()
271
707
 
272
708
        if message == '':
273
 
            response = question_dialog('Commit with an empty message ?',
274
 
                                       'You can describe your commit intent'
275
 
                                       +' in the message')
 
709
            response = self._question_dialog(
 
710
                _i18n('Commit with an empty message?'),
 
711
                _i18n('You can describe your commit intent in the message.'),
 
712
                parent=self)
276
713
            if response == gtk.RESPONSE_NO:
277
714
                # Kindly give focus to message area
278
 
                self.textview.grab_focus()
279
 
                return
280
 
 
 
715
                self._global_message_text_view.grab_focus()
 
716
                return
 
717
 
 
718
        specific_files, file_info = self._get_specific_files()
 
719
        if self._pending:
 
720
            specific_files = None
 
721
 
 
722
        local = self._check_local.get_active()
 
723
 
 
724
        # All we care about is if there is a single unknown, so if this loop is
 
725
        # entered, then there are unknown files.
 
726
        # TODO: jam 20071002 It seems like this should cancel the dialog
 
727
        #       entirely, since there isn't a way for them to add the unknown
 
728
        #       files at this point.
 
729
        for path in self._wt.unknowns():
 
730
            response = self._question_dialog(
 
731
                _i18n("Commit with unknowns?"),
 
732
                _i18n("Unknown files exist in the working tree. Commit anyway?"),
 
733
                parent=self)
 
734
                # Doesn't set a parent for the dialog..
 
735
            if response == gtk.RESPONSE_NO:
 
736
                return
 
737
            break
 
738
 
 
739
        rev_id = None
 
740
        revprops = {}
 
741
        if file_info:
 
742
            revprops['file-info'] = bencode.bencode(file_info).decode('UTF-8')
281
743
        try:
282
 
            self.wt.commit(message,
283
 
                           allow_pointless=checkbutton_force.get_active(),
284
 
                           strict=checkbutton_strict.get_active(),
285
 
                           local=self.checkbutton_local.get_active(),
286
 
                           specific_files=specific_files)
287
 
        except errors.NotBranchError:
288
 
            error_dialog(_('Directory is not a branch'),
289
 
                         _('You can perform this action only in a branch.'))
290
 
            return
291
 
        except errors.LocalRequiresBoundBranch:
292
 
            error_dialog(_('Directory is not a checkout'),
293
 
                         _('You can perform local commit only on checkouts.'))
294
 
            return
 
744
            rev_id = self._wt.commit(message,
 
745
                       allow_pointless=False,
 
746
                       strict=False,
 
747
                       local=local,
 
748
                       specific_files=specific_files,
 
749
                       revprops=revprops)
295
750
        except errors.PointlessCommit:
296
 
            error_dialog(_('No changes to commit'),
297
 
                         _('Try force commit if you want to commit anyway.'))
298
 
            return
299
 
        except errors.ConflictsInTree:
300
 
            error_dialog(_('Conflicts in tree'),
301
 
                         _('You need to resolve the conflicts before committing.'))
302
 
            return
303
 
        except errors.StrictCommitFailed:
304
 
            error_dialog(_('Strict commit failed'),
305
 
                         _('There are unknown files in the working tree.\nPlease add or delete them.'))
306
 
            return
307
 
        except errors.BoundBranchOutOfDate, errmsg:
308
 
            error_dialog(_('Bound branch is out of date'),
309
 
                         _('%s') % errmsg)
310
 
            return
311
 
        except errors.BzrError, msg:
312
 
            error_dialog(_('Unknown bzr error'), str(msg))
313
 
            return
314
 
        except Exception, msg:
315
 
            error_dialog(_('Unknown error'), str(msg))
316
 
            return
317
 
 
318
 
        self.close()
319
 
 
320
 
    def close(self, widget=None):
321
 
        self.window.destroy()
 
751
            response = self._question_dialog(
 
752
                _i18n('Commit with no changes?'),
 
753
                _i18n('There are no changes in the working tree.'
 
754
                      ' Do you want to commit anyway?'),
 
755
                parent=self)
 
756
            if response == gtk.RESPONSE_YES:
 
757
                rev_id = self._wt.commit(message,
 
758
                               allow_pointless=True,
 
759
                               strict=False,
 
760
                               local=local,
 
761
                               specific_files=specific_files,
 
762
                               revprops=revprops)
 
763
        self.committed_revision_id = rev_id
 
764
        # destroy old comments if any
 
765
        SavedCommitMessagesManager().save(self._wt, self._wt.branch)
 
766
        self.response(gtk.RESPONSE_OK)
 
767
 
 
768
    def _get_global_commit_message(self):
 
769
        buf = self._global_message_text_view.get_buffer()
 
770
        start, end = buf.get_bounds()
 
771
        text = buf.get_text(start, end)
 
772
        return _sanitize_and_decode_message(text)
 
773
 
 
774
    def _set_global_commit_message(self, message):
 
775
        """Just a helper for the test suite."""
 
776
        if isinstance(message, unicode):
 
777
            message = message.encode('UTF-8')
 
778
        self._global_message_text_view.get_buffer().set_text(message)
 
779
 
 
780
    def _set_file_commit_message(self, message):
 
781
        """Helper for the test suite."""
 
782
        if isinstance(message, unicode):
 
783
            message = message.encode('UTF-8')
 
784
        self._file_message_text_view.get_buffer().set_text(message)
 
785
 
 
786
    @staticmethod
 
787
    def _rev_to_pending_info(rev):
 
788
        """Get the information from a pending merge."""
 
789
        from bzrlib.osutils import format_date
 
790
        rev_dict = {}
 
791
        rev_dict['committer'] = re.sub('<.*@.*>', '', rev.committer).strip(' ')
 
792
        rev_dict['summary'] = rev.get_summary()
 
793
        rev_dict['date'] = format_date(rev.timestamp,
 
794
                                       rev.timezone or 0,
 
795
                                       'original', date_fmt="%Y-%m-%d",
 
796
                                       show_offset=False)
 
797
        rev_dict['revision_id'] = rev.revision_id
 
798
        return rev_dict
 
799
 
 
800
 
 
801
class SavedCommitMessagesManager:
 
802
    """Save glogal and per-file commit messages.
 
803
 
 
804
    Saves global commit message and utf-8 file_id->message dictionary
 
805
    of per-file commit messages on disk. Re-reads them later for re-using.
 
806
    """
 
807
 
 
808
    def __init__(self, tree=None, branch=None):
 
809
        """If branch is None, builds empty messages, otherwise reads them
 
810
        from branch's disk storage. 'tree' argument is for the future."""
 
811
        if branch is None:
 
812
            self.global_message = u''
 
813
            self.file_messages = {}
 
814
        else:
 
815
            config = branch.get_config()._get_branch_data_config()
 
816
            self.global_message = config.get_user_option(
 
817
                'gtk_global_commit_message')
 
818
            if self.global_message is None:
 
819
                self.global_message = u''
 
820
            file_messages = config.get_user_option('gtk_file_commit_messages')
 
821
            if file_messages: # unicode and B-encoded:
 
822
                self.file_messages = bencode.bdecode(
 
823
                    file_messages.encode('UTF-8'))
 
824
            else:
 
825
                self.file_messages = {}
 
826
 
 
827
    def get(self):
 
828
        return self.global_message, self.file_messages
 
829
 
 
830
    def is_not_empty(self):
 
831
        return bool(self.global_message or self.file_messages)
 
832
 
 
833
    def insert(self, global_message, file_info):
 
834
        """Formats per-file commit messages (list of dictionaries, one per file)
 
835
        into one utf-8 file_id->message dictionary and merges this with
 
836
        previously existing dictionary. Merges global commit message too."""
 
837
        file_messages = {}
 
838
        for fi in file_info:
 
839
            file_message = fi['message']
 
840
            if file_message:
 
841
                file_messages[fi['file_id']] = file_message # utf-8 strings
 
842
        for k,v in file_messages.iteritems():
 
843
            try:
 
844
                self.file_messages[k] = v + '\n******\n' + self.file_messages[k]
 
845
            except KeyError:
 
846
                self.file_messages[k] = v
 
847
        if self.global_message:
 
848
            self.global_message = global_message + '\n******\n' \
 
849
                + self.global_message
 
850
        else:
 
851
            self.global_message = global_message
 
852
 
 
853
    def save(self, tree, branch):
 
854
        # We store in branch's config, which can be a problem if two gcommit
 
855
        # are done in two checkouts of one single branch (comments overwrite
 
856
        # each other). Ideally should be in working tree. But uncommit does
 
857
        # not always have a working tree, though it always has a branch.
 
858
        # 'tree' argument is for the future
 
859
        config = branch.get_config()
 
860
        # should it be named "gtk_" or some more neutral name ("gui_" ?) to
 
861
        # be compatible with qbzr in the future?
 
862
        config.set_user_option('gtk_global_commit_message', self.global_message)
 
863
        # bencode() does not know unicode objects but set_user_option()
 
864
        # requires one:
 
865
        config.set_user_option(
 
866
            'gtk_file_commit_messages',
 
867
            bencode.bencode(self.file_messages).decode('UTF-8'))
 
868
 
 
869
 
 
870
def save_commit_messages(local, master, old_revno, old_revid,
 
871
                         new_revno, new_revid):
 
872
    b = local
 
873
    if b is None:
 
874
        b = master
 
875
    mgr = SavedCommitMessagesManager(None, b)
 
876
    revid_iterator = b.repository.iter_reverse_revision_history(old_revid)
 
877
    cur_revno = old_revno
 
878
    new_revision_id = old_revid
 
879
    graph = b.repository.get_graph()
 
880
    for rev_id in revid_iterator:
 
881
        if cur_revno == new_revno:
 
882
            break
 
883
        cur_revno -= 1
 
884
        rev = b.repository.get_revision(rev_id)
 
885
        file_info = rev.properties.get('file-info', None)
 
886
        if file_info is None:
 
887
            file_info = {}
 
888
        else:
 
889
            file_info = bencode.bdecode(file_info.encode('UTF-8'))
 
890
        global_message = osutils.safe_unicode(rev.message)
 
891
        # Concatenate comment of the uncommitted revision
 
892
        mgr.insert(global_message, file_info)
 
893
 
 
894
        parents = graph.get_parent_map([rev_id]).get(rev_id, None)
 
895
        if not parents:
 
896
            continue
 
897
    mgr.save(None, b)