/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: 2012-02-09 02:55:06 UTC
  • mto: This revision was merged to the branch mainline in revision 776.
  • Revision ID: sinzui.is@verizon.net-20120209025506-qa8yd8livobyv5yy
Replace unsupports notify event with an new strategy to set and pane size
when the config is saved.
Hush lint.

Show diffs side-by-side

added added

removed removed

Lines of Context:
commit.py
 
1
# Copyright (C) 2006 by Szilveszter Farkas (Phanatic) <szilveszter.farkas@gmail.com>
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
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
    bencode,
 
26
    errors,
 
27
    osutils,
 
28
    trace,
 
29
    )
 
30
from bzrlib.plugins.gtk.dialog import question_dialog
 
31
from bzrlib.plugins.gtk.errors import show_bzr_error
 
32
from bzrlib.plugins.gtk.i18n import _i18n
 
33
from bzrlib.plugins.gtk.commitmsgs import SavedCommitMessagesManager
 
34
 
 
35
try:
 
36
    import dbus
 
37
    import dbus.glib
 
38
    have_dbus = True
 
39
except ImportError:
 
40
    have_dbus = False
 
41
 
 
42
 
 
43
def pending_revisions(wt):
 
44
    """Return a list of pending merges or None if there are none of them.
 
45
 
 
46
    Arguably this should be a core function, and
 
47
    ``bzrlib.status.show_pending_merges`` should be built on top of it.
 
48
 
 
49
    :return: [(rev, [children])]
 
50
    """
 
51
    parents = wt.get_parent_ids()
 
52
    if len(parents) < 2:
 
53
        return None
 
54
 
 
55
    # The basic pending merge algorithm uses the same algorithm as
 
56
    # bzrlib.status.show_pending_merges
 
57
    pending = parents[1:]
 
58
    branch = wt.branch
 
59
    last_revision = parents[0]
 
60
 
 
61
    if last_revision is not None:
 
62
        graph = branch.repository.get_graph()
 
63
        ignore = set([r for r,ps in graph.iter_ancestry([last_revision])])
 
64
    else:
 
65
        ignore = set([])
 
66
 
 
67
    pm = []
 
68
    for merge in pending:
 
69
        ignore.add(merge)
 
70
        try:
 
71
            rev = branch.repository.get_revision(merge)
 
72
            children = []
 
73
            pm.append((rev, children))
 
74
 
 
75
            # This does need to be topo sorted, so we search backwards
 
76
            inner_merges = branch.repository.get_ancestry(merge)
 
77
            assert inner_merges[0] is None
 
78
            inner_merges.pop(0)
 
79
            for mmerge in reversed(inner_merges):
 
80
                if mmerge in ignore:
 
81
                    continue
 
82
                rev = branch.repository.get_revision(mmerge)
 
83
                children.append(rev)
 
84
 
 
85
                ignore.add(mmerge)
 
86
        except errors.NoSuchRevision:
 
87
            print "DEBUG: NoSuchRevision:", merge
 
88
 
 
89
    return pm
 
90
 
 
91
 
 
92
_newline_variants_re = re.compile(r'\r\n?')
 
93
def _sanitize_and_decode_message(utf8_message):
 
94
    """Turn a utf-8 message into a sanitized Unicode message."""
 
95
    fixed_newline = _newline_variants_re.sub('\n', utf8_message)
 
96
    return osutils.safe_unicode(fixed_newline)
 
97
 
 
98
 
 
99
class CommitDialog(Gtk.Dialog):
 
100
    """Implementation of Commit."""
 
101
 
 
102
    def __init__(self, wt, selected=None, parent=None):
 
103
        super(CommitDialog, self).__init__(
 
104
            title="Commit to %s" % wt.basedir, parent=parent, flags=0)
 
105
        self.connect('delete-event', self._on_delete_window)
 
106
        self._question_dialog = question_dialog
 
107
 
 
108
        self.set_type_hint(Gdk.WindowTypeHint.NORMAL)
 
109
 
 
110
        self._wt = wt
 
111
        # TODO: Do something with this value, it is used by Olive
 
112
        #       It used to set all changes but this one to False
 
113
        self._selected = selected
 
114
        self._enable_per_file_commits = True
 
115
        self._commit_all_changes = True
 
116
        self.committed_revision_id = None # Nothing has been committed yet
 
117
        self._last_selected_file = None
 
118
        self._saved_commit_messages_manager = SavedCommitMessagesManager(
 
119
            self._wt, self._wt.branch)
 
120
 
 
121
        self.setup_params()
 
122
        self.construct()
 
123
        self.fill_in_data()
 
124
 
 
125
    def setup_params(self):
 
126
        """Setup the member variables for state."""
 
127
        self._basis_tree = self._wt.basis_tree()
 
128
        self._delta = None
 
129
        self._wt.lock_read()
 
130
        try:
 
131
            self._pending = pending_revisions(self._wt)
 
132
        finally:
 
133
            self._wt.unlock()
 
134
 
 
135
        self._is_checkout = (self._wt.branch.get_bound_location() is not None)
 
136
 
 
137
    def fill_in_data(self):
 
138
        # Now that we are built, handle changes to the view based on the state
 
139
        self._fill_in_pending()
 
140
        self._fill_in_diff()
 
141
        self._fill_in_files()
 
142
        self._fill_in_checkout()
 
143
        self._fill_in_per_file_info()
 
144
 
 
145
    def _fill_in_pending(self):
 
146
        if not self._pending:
 
147
            self._pending_box.hide()
 
148
            return
 
149
 
 
150
        # TODO: We'd really prefer this to be a nested list
 
151
        for rev, children in self._pending:
 
152
            rev_info = self._rev_to_pending_info(rev)
 
153
            self._pending_store.append([
 
154
                rev_info['revision_id'],
 
155
                rev_info['date'],
 
156
                rev_info['committer'],
 
157
                rev_info['summary'],
 
158
                ])
 
159
            for child in children:
 
160
                rev_info = self._rev_to_pending_info(child)
 
161
                self._pending_store.append([
 
162
                    rev_info['revision_id'],
 
163
                    rev_info['date'],
 
164
                    rev_info['committer'],
 
165
                    rev_info['summary'],
 
166
                    ])
 
167
        self._pending_box.show()
 
168
 
 
169
    def _fill_in_files(self):
 
170
        # We should really use add a progress bar of some kind.
 
171
        # While we fill in the view, hide the store
 
172
        store = self._files_store
 
173
        self._treeview_files.set_model(None)
 
174
 
 
175
        added = _i18n('added')
 
176
        removed = _i18n('removed')
 
177
        renamed = _i18n('renamed')
 
178
        renamed_and_modified = _i18n('renamed and modified')
 
179
        modified = _i18n('modified')
 
180
        kind_changed = _i18n('kind changed')
 
181
 
 
182
        # The store holds:
 
183
        # [file_id, real path, checkbox, display path, changes type, message]
 
184
        # iter_changes returns:
 
185
        # (file_id, (path_in_source, path_in_target),
 
186
        #  changed_content, versioned, parent, name, kind,
 
187
        #  executable)
 
188
 
 
189
        all_enabled = (self._selected is None)
 
190
        # The first entry is always the 'whole tree'
 
191
        all_iter = store.append(["", "", all_enabled, 'All Files', '', ''])
 
192
        initial_cursor = store.get_path(all_iter)
 
193
        # should we pass specific_files?
 
194
        self._wt.lock_read()
 
195
        self._basis_tree.lock_read()
 
196
        try:
 
197
            from diff import iter_changes_to_status
 
198
            saved_file_messages = self._saved_commit_messages_manager.get()[1]
 
199
            for (file_id, real_path, change_type, display_path
 
200
                ) in iter_changes_to_status(self._basis_tree, self._wt):
 
201
                if self._selected and real_path != self._selected:
 
202
                    enabled = False
 
203
                else:
 
204
                    enabled = True
 
205
                try:
 
206
                    default_message = saved_file_messages[file_id]
 
207
                except KeyError:
 
208
                    default_message = ''
 
209
                item_iter = store.append([
 
210
                    file_id,
 
211
                    real_path.encode('UTF-8'),
 
212
                    enabled,
 
213
                    display_path.encode('UTF-8'),
 
214
                    change_type,
 
215
                    default_message, # Initial comment
 
216
                    ])
 
217
                if self._selected and enabled:
 
218
                    initial_cursor = store.get_path(item_iter)
 
219
        finally:
 
220
            self._basis_tree.unlock()
 
221
            self._wt.unlock()
 
222
 
 
223
        self._treeview_files.set_model(store)
 
224
        self._last_selected_file = None
 
225
        # This sets the cursor, which causes the expander to close, which
 
226
        # causes the _file_message_text_view to never get realized. So we have
 
227
        # to give it a little kick, or it warns when we try to grab the focus
 
228
        self._treeview_files.set_cursor(initial_cursor, None, False)
 
229
 
 
230
        def _realize_file_message_tree_view(*args):
 
231
            self._file_message_text_view.realize()
 
232
        self.connect_after('realize', _realize_file_message_tree_view)
 
233
 
 
234
    def _fill_in_diff(self):
 
235
        self._diff_view.set_trees(self._wt, self._basis_tree)
 
236
 
 
237
    def _fill_in_checkout(self):
 
238
        if not self._is_checkout:
 
239
            self._check_local.hide()
 
240
            return
 
241
        if have_dbus:
 
242
            bus = dbus.SystemBus()
 
243
            try:
 
244
                proxy_obj = bus.get_object('org.freedesktop.NetworkManager',
 
245
                                           '/org/freedesktop/NetworkManager')
 
246
            except dbus.DBusException:
 
247
                trace.mutter("networkmanager not available.")
 
248
                self._check_local.show()
 
249
                return
 
250
            
 
251
            dbus_iface = dbus.Interface(proxy_obj,
 
252
                                        'org.freedesktop.NetworkManager')
 
253
            try:
 
254
                # 3 is the enum value for STATE_CONNECTED
 
255
                self._check_local.set_active(dbus_iface.state() != 3)
 
256
            except dbus.DBusException, e:
 
257
                # Silently drop errors. While DBus may be
 
258
                # available, NetworkManager doesn't necessarily have to be
 
259
                trace.mutter("unable to get networkmanager state: %r" % e)
 
260
        self._check_local.show()
 
261
 
 
262
    def _fill_in_per_file_info(self):
 
263
        config = self._wt.branch.get_config()
 
264
        enable_per_file_commits = config.get_user_option('per_file_commits')
 
265
        if (enable_per_file_commits is None
 
266
            or enable_per_file_commits.lower()
 
267
                not in ('y', 'yes', 'on', 'enable', '1', 't', 'true')):
 
268
            self._enable_per_file_commits = False
 
269
        else:
 
270
            self._enable_per_file_commits = True
 
271
        if not self._enable_per_file_commits:
 
272
            self._file_message_expander.hide()
 
273
            self._global_message_label.set_markup(_i18n('<b>Commit Message</b>'))
 
274
 
 
275
    def _compute_delta(self):
 
276
        self._delta = self._wt.changes_from(self._basis_tree)
 
277
 
 
278
    def construct(self):
 
279
        """Build up the dialog widgets."""
 
280
        # The primary pane which splits it into left and right (adjustable)
 
281
        # sections.
 
282
        self._hpane = Gtk.HPaned()
 
283
 
 
284
        self._construct_left_pane()
 
285
        self._construct_right_pane()
 
286
        self._construct_action_pane()
 
287
 
 
288
        self.get_content_area().pack_start(self._hpane, True, True, 0)
 
289
        self._hpane.show()
 
290
        self.set_focus(self._global_message_text_view)
 
291
 
 
292
        self._construct_accelerators()
 
293
        self._set_sizes()
 
294
 
 
295
    def _set_sizes(self):
 
296
        # This seems like a reasonable default, we might like it to
 
297
        # be a bit wider, so that by default we can fit an 80-line diff in the
 
298
        # diff window.
 
299
        # Alternatively, we should be saving the last position/size rather than
 
300
        # setting it to a fixed value every time we start up.
 
301
        screen = self.get_screen()
 
302
        monitor = 0 # We would like it to be the monitor we are going to
 
303
                    # display on, but I don't know how to figure that out
 
304
                    # Only really useful for freaks like me that run dual
 
305
                    # monitor, with different sizes on the monitors
 
306
        monitor_rect = screen.get_monitor_geometry(monitor)
 
307
        width = int(monitor_rect.width * 0.66)
 
308
        height = int(monitor_rect.height * 0.66)
 
309
        self.set_default_size(width, height)
 
310
        self._hpane.set_position(300)
 
311
 
 
312
    def _construct_accelerators(self):
 
313
        group = Gtk.AccelGroup()
 
314
        group.connect(Gdk.keyval_from_name('N'),
 
315
                      Gdk.ModifierType.CONTROL_MASK, 0, self._on_accel_next)
 
316
        self.add_accel_group(group)
 
317
 
 
318
        # ignore the escape key (avoid closing the window)
 
319
        self.connect_object('close', self.emit_stop_by_name, 'close')
 
320
 
 
321
    def _construct_left_pane(self):
 
322
        self._left_pane_box = Gtk.VBox(homogeneous=False, spacing=5)
 
323
        self._construct_file_list()
 
324
        self._construct_pending_list()
 
325
 
 
326
        self._check_local = Gtk.CheckButton(_i18n("_Only commit locally"),
 
327
                                            use_underline=True)
 
328
        self._left_pane_box.pack_end(self._check_local, False, False, 0)
 
329
        self._check_local.set_active(False)
 
330
 
 
331
        self._hpane.pack1(self._left_pane_box, resize=False, shrink=False)
 
332
        self._left_pane_box.show()
 
333
 
 
334
    def _construct_right_pane(self):
 
335
        # TODO: I really want to make it so the diff view gets more space than
 
336
        # the global commit message, and the per-file commit message gets even
 
337
        # less. When I did it with wxGlade, I set it to 4 for diff, 2 for
 
338
        # commit, and 1 for file commit, and it looked good. But I don't seem
 
339
        # to have a way to do that with the gtk boxes... :( (Which is extra
 
340
        # weird since wx uses gtk on Linux...)
 
341
        self._right_pane_table = Gtk.Table(rows=10, columns=1, homogeneous=False)
 
342
        self._right_pane_table.set_row_spacings(5)
 
343
        self._right_pane_table.set_col_spacings(5)
 
344
        self._right_pane_table_row = 0
 
345
        self._construct_diff_view()
 
346
        self._construct_file_message()
 
347
        self._construct_global_message()
 
348
 
 
349
        self._right_pane_table.show()
 
350
        self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
 
351
 
 
352
    def _construct_action_pane(self):
 
353
        self._button_cancel = Gtk.Button(stock=Gtk.STOCK_CANCEL)
 
354
        self._button_cancel.connect('clicked', self._on_cancel_clicked)
 
355
        self._button_cancel.show()
 
356
        self.get_action_area().pack_end(
 
357
            self._button_cancel, True, True, 0)
 
358
        self._button_commit = Gtk.Button(_i18n("Comm_it"), use_underline=True)
 
359
        self._button_commit.connect('clicked', self._on_commit_clicked)
 
360
        self._button_commit.set_can_default(True)
 
361
        self._button_commit.show()
 
362
        self.get_action_area().pack_end(
 
363
            self._button_commit, True, True, 0)
 
364
        self._button_commit.grab_default()
 
365
 
 
366
    def _add_to_right_table(self, widget, weight, expanding=False):
 
367
        """Add another widget to the table
 
368
 
 
369
        :param widget: The object to add
 
370
        :param weight: How many rows does this widget get to request
 
371
        :param expanding: Should expand|fill|shrink be set?
 
372
        """
 
373
        end_row = self._right_pane_table_row + weight
 
374
        options = 0
 
375
        expand_opts = Gtk.AttachOptions.EXPAND | Gtk.AttachOptions.FILL | Gtk.AttachOptions.SHRINK
 
376
        if expanding:
 
377
            options = expand_opts
 
378
        self._right_pane_table.attach(widget, 0, 1,
 
379
                                      self._right_pane_table_row, end_row,
 
380
                                      xoptions=expand_opts, yoptions=options)
 
381
        self._right_pane_table_row = end_row
 
382
 
 
383
    def _construct_file_list(self):
 
384
        self._files_box = Gtk.VBox(homogeneous=False, spacing=0)
 
385
        file_label = Gtk.Label(label=_i18n('Files'))
 
386
        # file_label.show()
 
387
        self._files_box.pack_start(file_label, False, True, 0)
 
388
 
 
389
        self._commit_all_files_radio = Gtk.RadioButton.new_with_label(
 
390
            None, _i18n("Commit all changes"))
 
391
        self._files_box.pack_start(self._commit_all_files_radio, False, True, 0)
 
392
        self._commit_all_files_radio.show()
 
393
        self._commit_all_files_radio.connect('toggled',
 
394
            self._toggle_commit_selection)
 
395
        self._commit_selected_radio = Gtk.RadioButton.new_with_label_from_widget(
 
396
            self._commit_all_files_radio, _i18n("Only commit selected changes"))
 
397
        self._files_box.pack_start(self._commit_selected_radio, False, True, 0)
 
398
        self._commit_selected_radio.show()
 
399
        self._commit_selected_radio.connect('toggled',
 
400
            self._toggle_commit_selection)
 
401
        if self._pending:
 
402
            self._commit_all_files_radio.set_label(_i18n('Commit all changes*'))
 
403
            self._commit_all_files_radio.set_sensitive(False)
 
404
            self._commit_selected_radio.set_sensitive(False)
 
405
 
 
406
        scroller = Gtk.ScrolledWindow()
 
407
        scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
 
408
        self._treeview_files = Gtk.TreeView()
 
409
        self._treeview_files.show()
 
410
        scroller.add(self._treeview_files)
 
411
        scroller.set_shadow_type(Gtk.ShadowType.IN)
 
412
        scroller.show()
 
413
        self._files_box.pack_start(scroller, True, True, 0)
 
414
        self._files_box.show()
 
415
        self._left_pane_box.pack_start(self._files_box, True, True, 0)
 
416
 
 
417
        # Keep note that all strings stored in a ListStore must be UTF-8
 
418
        # strings. GTK does not support directly setting and restoring Unicode
 
419
        # objects.
 
420
        liststore = Gtk.ListStore(
 
421
            GObject.TYPE_STRING,  # [0] file_id
 
422
            GObject.TYPE_STRING,  # [1] real path
 
423
            GObject.TYPE_BOOLEAN, # [2] checkbox
 
424
            GObject.TYPE_STRING,  # [3] display path
 
425
            GObject.TYPE_STRING,  # [4] changes type
 
426
            GObject.TYPE_STRING,  # [5] commit message
 
427
            )
 
428
        self._files_store = liststore
 
429
        self._treeview_files.set_model(liststore)
 
430
        crt = Gtk.CellRendererToggle()
 
431
        crt.set_property('activatable', not bool(self._pending))
 
432
        crt.connect("toggled", self._toggle_commit, self._files_store)
 
433
        if self._pending:
 
434
            name = _i18n('Commit*')
 
435
        else:
 
436
            name = _i18n('Commit')
 
437
        commit_col = Gtk.TreeViewColumn(name, crt, active=2)
 
438
        commit_col.set_visible(False)
 
439
        self._treeview_files.append_column(commit_col)
 
440
        self._treeview_files.append_column(Gtk.TreeViewColumn(_i18n('Path'),
 
441
                                           Gtk.CellRendererText(), text=3))
 
442
        self._treeview_files.append_column(Gtk.TreeViewColumn(_i18n('Type'),
 
443
                                           Gtk.CellRendererText(), text=4))
 
444
        self._treeview_files.connect('cursor-changed',
 
445
                                     self._on_treeview_files_cursor_changed)
 
446
 
 
447
    def _toggle_commit(self, cell, path, model):
 
448
        if model[path][0] == "": # No file_id means 'All Files'
 
449
            new_val = not model[path][2]
 
450
            for node in model:
 
451
                node[2] = new_val
 
452
        else:
 
453
            model[path][2] = not model[path][2]
 
454
 
 
455
    def _toggle_commit_selection(self, button):
 
456
        all_files = self._commit_all_files_radio.get_active()
 
457
        if self._commit_all_changes != all_files:
 
458
            checked_col = self._treeview_files.get_column(0)
 
459
            self._commit_all_changes = all_files
 
460
            if all_files:
 
461
                checked_col.set_visible(False)
 
462
            else:
 
463
                checked_col.set_visible(True)
 
464
            renderer = checked_col.get_cells()[0]
 
465
            renderer.set_property('activatable', not all_files)
 
466
 
 
467
    def _construct_pending_list(self):
 
468
        # Pending information defaults to hidden, we put it all in 1 box, so
 
469
        # that we can show/hide all of them at once
 
470
        self._pending_box = Gtk.VBox()
 
471
        self._pending_box.hide()
 
472
 
 
473
        pending_message = Gtk.Label()
 
474
        pending_message.set_markup(
 
475
            _i18n('<i>* Cannot select specific files when merging</i>'))
 
476
        self._pending_box.pack_start(pending_message, False, True, 5)
 
477
        pending_message.show()
 
478
 
 
479
        pending_label = Gtk.Label(label=_i18n('Pending Revisions'))
 
480
        self._pending_box.pack_start(pending_label, False, True, 0)
 
481
        pending_label.show()
 
482
 
 
483
        scroller = Gtk.ScrolledWindow()
 
484
        scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
 
485
        self._treeview_pending = Gtk.TreeView()
 
486
        scroller.add(self._treeview_pending)
 
487
        scroller.set_shadow_type(Gtk.ShadowType.IN)
 
488
        scroller.show()
 
489
        self._pending_box.pack_start(scroller, True, True, 5)
 
490
        self._treeview_pending.show()
 
491
        self._left_pane_box.pack_start(self._pending_box, True, True, 0)
 
492
 
 
493
        liststore = Gtk.ListStore(GObject.TYPE_STRING, # revision_id
 
494
                                  GObject.TYPE_STRING, # date
 
495
                                  GObject.TYPE_STRING, # committer
 
496
                                  GObject.TYPE_STRING, # summary
 
497
                                 )
 
498
        self._pending_store = liststore
 
499
        self._treeview_pending.set_model(liststore)
 
500
        self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Date'),
 
501
                                             Gtk.CellRendererText(), text=1))
 
502
        self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Committer'),
 
503
                                             Gtk.CellRendererText(), text=2))
 
504
        self._treeview_pending.append_column(Gtk.TreeViewColumn(_i18n('Summary'),
 
505
                                             Gtk.CellRendererText(), text=3))
 
506
 
 
507
    def _construct_diff_view(self):
 
508
        from bzrlib.plugins.gtk.diff import DiffView
 
509
 
 
510
        # TODO: jam 2007-10-30 The diff label is currently disabled. If we
 
511
        #       decide that we really don't ever want to display it, we should
 
512
        #       actually remove it, and other references to it, along with the
 
513
        #       tests that it is set properly.
 
514
        self._diff_label = Gtk.Label(label=_i18n('Diff for whole tree'))
 
515
        self._diff_label.set_alignment(0, 0)
 
516
        self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
 
517
        self._add_to_right_table(self._diff_label, 1, False)
 
518
        # self._diff_label.show()
 
519
 
 
520
        self._diff_view = DiffView()
 
521
        self._add_to_right_table(self._diff_view, 4, True)
 
522
        self._diff_view.show()
 
523
 
 
524
    def _construct_file_message(self):
 
525
        scroller = Gtk.ScrolledWindow()
 
526
        scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
 
527
 
 
528
        self._file_message_text_view = Gtk.TextView()
 
529
        scroller.add(self._file_message_text_view)
 
530
        scroller.set_shadow_type(Gtk.ShadowType.IN)
 
531
        scroller.show()
 
532
 
 
533
        self._file_message_text_view.modify_font(Pango.FontDescription("Monospace"))
 
534
        self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
 
535
        self._file_message_text_view.set_accepts_tab(False)
 
536
        self._file_message_text_view.show()
 
537
 
 
538
        self._file_message_expander = Gtk.Expander(
 
539
            label=_i18n('File commit message'))
 
540
        self._file_message_expander.set_expanded(True)
 
541
        self._file_message_expander.add(scroller)
 
542
        self._add_to_right_table(self._file_message_expander, 1, False)
 
543
        self._file_message_expander.show()
 
544
 
 
545
    def _construct_global_message(self):
 
546
        self._global_message_label = Gtk.Label(label=_i18n('Global Commit Message'))
 
547
        self._global_message_label.set_markup(
 
548
            _i18n('<b>Global Commit Message</b>'))
 
549
        self._global_message_label.set_alignment(0, 0)
 
550
        self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
 
551
        self._add_to_right_table(self._global_message_label, 1, False)
 
552
        # Can we remove the spacing between the label and the box?
 
553
        self._global_message_label.show()
 
554
 
 
555
        scroller = Gtk.ScrolledWindow()
 
556
        scroller.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
 
557
 
 
558
        self._global_message_text_view = Gtk.TextView()
 
559
        self._set_global_commit_message(self._saved_commit_messages_manager.get()[0])
 
560
        self._global_message_text_view.modify_font(Pango.FontDescription("Monospace"))
 
561
        scroller.add(self._global_message_text_view)
 
562
        scroller.set_shadow_type(Gtk.ShadowType.IN)
 
563
        scroller.show()
 
564
        self._add_to_right_table(scroller, 2, True)
 
565
        self._file_message_text_view.set_wrap_mode(Gtk.WrapMode.WORD)
 
566
        self._file_message_text_view.set_accepts_tab(False)
 
567
        self._global_message_text_view.show()
 
568
 
 
569
    def _on_treeview_files_cursor_changed(self, treeview):
 
570
        treeselection = treeview.get_selection()
 
571
        if treeselection is None:
 
572
            # The treeview was probably destroyed as the dialog closes.
 
573
            return
 
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 == "":
 
580
                self._diff_view.show_diff(None)
 
581
            else:
 
582
                self._diff_view.show_diff([osutils.safe_unicode(path)])
 
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), "", 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 == "": # 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
 
 
639
    def _get_specific_files(self):
 
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] == "", "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 = osutils.safe_utf8(record[0]) # [0] file_id
 
654
                path = osutils.safe_utf8(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()
 
703
 
 
704
        if message == '':
 
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:
 
710
                # Kindly give focus to message area
 
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')
 
739
        try:
 
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)
 
746
        except errors.PointlessCommit:
 
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