/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-03-04 00:09:11 UTC
  • mto: This revision was merged to the branch mainline in revision 782.
  • Revision ID: sinzui.is@verizon.net-20120304000911-iaw196xcw4zfta9m
Added test to verify that DivergedBranches is handled.

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