/b-gtk/fix-viz

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

« back to all changes in this revision

Viewing changes to commit.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-20 16:47:38 UTC
  • Revision ID: jelmer@canonical.com-20111220164738-l6tgnbttkxmq6877
Cope with some strings being unicode when returned by some versions of gtk.

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