/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: Curtis Hovey
  • Date: 2011-09-08 03:11:06 UTC
  • mto: This revision was merged to the branch mainline in revision 741.
  • Revision ID: sinzui.is@verizon.net-20110908031106-c0s7grzmctdyghcm
Fixed packing args.

Show diffs side-by-side

added added

removed removed

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