1
# Copyright (C) 2006 by Szilveszter Farkas (Phanatic) <szilveszter.farkas@gmail.com>
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.
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.
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
30
from bzrlib import errors, osutils
31
from bzrlib.trace import mutter
32
from bzrlib.util import bencode
34
from bzrlib.plugins.gtk import _i18n
35
from bzrlib.plugins.gtk.dialog import question_dialog
36
from bzrlib.plugins.gtk.errors import show_bzr_error
46
def pending_revisions(wt):
47
"""Return a list of pending merges or None if there are none of them.
49
Arguably this should be a core function, and
50
``bzrlib.status.show_pending_merges`` should be built on top of it.
52
:return: [(rev, [children])]
54
parents = wt.get_parent_ids()
58
# The basic pending merge algorithm uses the same algorithm as
59
# bzrlib.status.show_pending_merges
62
last_revision = parents[0]
64
if last_revision is not None:
66
ignore = set(branch.repository.get_ancestry(last_revision,
68
except errors.NoSuchRevision:
69
# the last revision is a ghost : assume everything is new
71
ignore = set([None, last_revision])
79
rev = branch.repository.get_revision(merge)
81
pm.append((rev, children))
83
# This does need to be topo sorted, so we search backwards
84
inner_merges = branch.repository.get_ancestry(merge)
85
assert inner_merges[0] is None
87
for mmerge in reversed(inner_merges):
90
rev = branch.repository.get_revision(mmerge)
94
except errors.NoSuchRevision:
95
print "DEBUG: NoSuchRevision:", merge
100
class CommitDialog(gtk.Dialog):
101
"""Implementation of Commit."""
103
def __init__(self, wt, selected=None, parent=None):
104
gtk.Dialog.__init__(self, title="Commit - Olive",
107
buttons=(gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL))
110
# TODO: Do something with this value, it is used by Olive
111
# It used to set all changes but this one to False
112
self._selected = selected
113
self._enable_per_file_commits = True
114
self._commit_all_changes = True
115
self.committed_revision_id = None # Nothing has been committed yet
121
def setup_params(self):
122
"""Setup the member variables for state."""
123
self._basis_tree = self._wt.basis_tree()
125
self._pending = pending_revisions(self._wt)
127
self._is_checkout = (self._wt.branch.get_bound_location() is not None)
129
def fill_in_data(self):
130
# Now that we are built, handle changes to the view based on the state
131
self._fill_in_pending()
133
self._fill_in_files()
134
self._fill_in_checkout()
135
self._fill_in_per_file_info()
137
def _fill_in_pending(self):
138
if not self._pending:
139
self._pending_box.hide()
142
# TODO: We'd really prefer this to be a nested list
143
for rev, children in self._pending:
144
rev_info = self._rev_to_pending_info(rev)
145
self._pending_store.append([
146
rev_info['revision_id'],
148
rev_info['committer'],
151
for child in children:
152
rev_info = self._rev_to_pending_info(child)
153
self._pending_store.append([
154
rev_info['revision_id'],
156
rev_info['committer'],
159
self._pending_box.show()
161
def _fill_in_files(self):
162
# We should really use add a progress bar of some kind.
163
# While we fill in the view, hide the store
164
store = self._files_store
165
self._treeview_files.set_model(None)
167
added = _i18n('added')
168
removed = _i18n('removed')
169
renamed = _i18n('renamed')
170
renamed_and_modified = _i18n('renamed and modified')
171
modified = _i18n('modified')
172
kind_changed = _i18n('kind changed')
175
# [file_id, real path, checkbox, display path, changes type, message]
176
# iter_changes returns:
177
# (file_id, (path_in_source, path_in_target),
178
# changed_content, versioned, parent, name, kind,
181
all_enabled = (self._selected is None)
182
# The first entry is always the 'whole tree'
183
all_iter = store.append([None, None, all_enabled, 'All Files', '', ''])
184
initial_cursor = store.get_path(all_iter)
185
# should we pass specific_files?
187
self._basis_tree.lock_read()
189
from diff import iter_changes_to_status
190
for (file_id, real_path, change_type, display_path
191
) in iter_changes_to_status(self._basis_tree, self._wt):
192
if self._selected and real_path != self._selected:
196
item_iter = store.append([
198
real_path.encode('UTF-8'),
200
display_path.encode('UTF-8'),
202
'', # Initial comment
204
if self._selected and enabled:
205
initial_cursor = store.get_path(item_iter)
207
self._basis_tree.unlock()
210
self._treeview_files.set_model(store)
211
self._last_selected_file = None
212
# This sets the cursor, which causes the expander to close, which
213
# causes the _file_message_text_view to never get realized. So we have
214
# to give it a little kick, or it warns when we try to grab the focus
215
self._treeview_files.set_cursor(initial_cursor)
217
def _realize_file_message_tree_view(*args):
218
self._file_message_text_view.realize()
219
self.connect_after('realize', _realize_file_message_tree_view)
221
def _fill_in_diff(self):
222
self._diff_view.set_trees(self._wt, self._basis_tree)
224
def _fill_in_checkout(self):
225
if not self._is_checkout:
226
self._check_local.hide()
229
bus = dbus.SystemBus()
231
proxy_obj = bus.get_object('org.freedesktop.NetworkManager',
232
'/org/freedesktop/NetworkManager')
233
except dbus.DBusException:
234
mutter("networkmanager not available.")
235
self._check_local.show()
238
dbus_iface = dbus.Interface(proxy_obj,
239
'org.freedesktop.NetworkManager')
241
# 3 is the enum value for STATE_CONNECTED
242
self._check_local.set_active(dbus_iface.state() != 3)
243
except dbus.DBusException, e:
244
# Silently drop errors. While DBus may be
245
# available, NetworkManager doesn't necessarily have to be
246
mutter("unable to get networkmanager state: %r" % e)
247
self._check_local.show()
249
def _fill_in_per_file_info(self):
250
config = self._wt.branch.get_config()
251
enable_per_file_commits = config.get_user_option('per_file_commits')
252
if (enable_per_file_commits is None
253
or enable_per_file_commits.lower()
254
not in ('y', 'yes', 'on', 'enable', '1', 't', 'true')):
255
self._enable_per_file_commits = False
257
self._enable_per_file_commits = True
258
if not self._enable_per_file_commits:
259
self._file_message_expander.hide()
260
self._global_message_label.set_markup(_i18n('<b>Commit Message</b>'))
262
def _compute_delta(self):
263
self._delta = self._wt.changes_from(self._basis_tree)
266
"""Build up the dialog widgets."""
267
# The primary pane which splits it into left and right (adjustable)
269
self._hpane = gtk.HPaned()
271
self._construct_left_pane()
272
self._construct_right_pane()
273
self._construct_action_pane()
275
self.vbox.pack_start(self._hpane)
277
self.set_focus(self._global_message_text_view)
279
self._construct_accelerators()
282
def _set_sizes(self):
283
# This seems like a reasonable default, we might like it to
284
# be a bit wider, so that by default we can fit an 80-line diff in the
286
# Alternatively, we should be saving the last position/size rather than
287
# setting it to a fixed value every time we start up.
288
screen = self.get_screen()
289
monitor = 0 # We would like it to be the monitor we are going to
290
# display on, but I don't know how to figure that out
291
# Only really useful for freaks like me that run dual
292
# monitor, with different sizes on the monitors
293
monitor_rect = screen.get_monitor_geometry(monitor)
294
width = int(monitor_rect.width * 0.66)
295
height = int(monitor_rect.height * 0.66)
296
self.set_default_size(width, height)
297
self._hpane.set_position(300)
299
def _construct_accelerators(self):
300
group = gtk.AccelGroup()
301
group.connect_group(gtk.gdk.keyval_from_name('N'),
302
gtk.gdk.CONTROL_MASK, 0, self._on_accel_next)
303
self.add_accel_group(group)
305
# ignore the escape key (avoid closing the window)
306
self.connect_object('close', self.emit_stop_by_name, 'close')
308
def _construct_left_pane(self):
309
self._left_pane_box = gtk.VBox(homogeneous=False, spacing=5)
310
self._construct_file_list()
311
self._construct_pending_list()
313
self._check_local = gtk.CheckButton(_i18n("_Only commit locally"),
315
self._left_pane_box.pack_end(self._check_local, False, False)
316
self._check_local.set_active(False)
318
self._hpane.pack1(self._left_pane_box, resize=False, shrink=False)
319
self._left_pane_box.show()
321
def _construct_right_pane(self):
322
# TODO: I really want to make it so the diff view gets more space than
323
# the global commit message, and the per-file commit message gets even
324
# less. When I did it with wxGlade, I set it to 4 for diff, 2 for
325
# commit, and 1 for file commit, and it looked good. But I don't seem
326
# to have a way to do that with the gtk boxes... :( (Which is extra
327
# weird since wx uses gtk on Linux...)
328
self._right_pane_table = gtk.Table(rows=10, columns=1, homogeneous=False)
329
self._right_pane_table.set_row_spacings(5)
330
self._right_pane_table.set_col_spacings(5)
331
self._right_pane_table_row = 0
332
self._construct_diff_view()
333
self._construct_file_message()
334
self._construct_global_message()
336
self._right_pane_table.show()
337
self._hpane.pack2(self._right_pane_table, resize=True, shrink=True)
339
def _construct_action_pane(self):
340
self._button_commit = gtk.Button(_i18n("Comm_it"), use_underline=True)
341
self._button_commit.connect('clicked', self._on_commit_clicked)
342
self._button_commit.set_flags(gtk.CAN_DEFAULT)
343
self._button_commit.show()
344
self.action_area.pack_end(self._button_commit)
345
self._button_commit.grab_default()
347
def _add_to_right_table(self, widget, weight, expanding=False):
348
"""Add another widget to the table
350
:param widget: The object to add
351
:param weight: How many rows does this widget get to request
352
:param expanding: Should expand|fill|shrink be set?
354
end_row = self._right_pane_table_row + weight
356
expand_opts = gtk.EXPAND | gtk.FILL | gtk.SHRINK
358
options = expand_opts
359
self._right_pane_table.attach(widget, 0, 1,
360
self._right_pane_table_row, end_row,
361
xoptions=expand_opts, yoptions=options)
362
self._right_pane_table_row = end_row
364
def _construct_file_list(self):
365
self._files_box = gtk.VBox(homogeneous=False, spacing=0)
366
file_label = gtk.Label(_i18n('Files'))
368
self._files_box.pack_start(file_label, expand=False)
370
self._commit_all_files_radio = gtk.RadioButton(
371
None, _i18n("Commit all changes"))
372
self._files_box.pack_start(self._commit_all_files_radio, expand=False)
373
self._commit_all_files_radio.show()
374
self._commit_all_files_radio.connect('toggled',
375
self._toggle_commit_selection)
376
self._commit_selected_radio = gtk.RadioButton(
377
self._commit_all_files_radio, _i18n("Only commit selected changes"))
378
self._files_box.pack_start(self._commit_selected_radio, expand=False)
379
self._commit_selected_radio.show()
380
self._commit_selected_radio.connect('toggled',
381
self._toggle_commit_selection)
383
self._commit_all_files_radio.set_label(_i18n('Commit all changes*'))
384
self._commit_all_files_radio.set_sensitive(False)
385
self._commit_selected_radio.set_sensitive(False)
387
scroller = gtk.ScrolledWindow()
388
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
389
self._treeview_files = gtk.TreeView()
390
self._treeview_files.show()
391
scroller.add(self._treeview_files)
392
scroller.set_shadow_type(gtk.SHADOW_IN)
394
self._files_box.pack_start(scroller,
395
expand=True, fill=True)
396
self._files_box.show()
397
self._left_pane_box.pack_start(self._files_box)
399
# Keep note that all strings stored in a ListStore must be UTF-8
400
# strings. GTK does not support directly setting and restoring Unicode
402
liststore = gtk.ListStore(
403
gobject.TYPE_STRING, # [0] file_id
404
gobject.TYPE_STRING, # [1] real path
405
gobject.TYPE_BOOLEAN, # [2] checkbox
406
gobject.TYPE_STRING, # [3] display path
407
gobject.TYPE_STRING, # [4] changes type
408
gobject.TYPE_STRING, # [5] commit message
410
self._files_store = liststore
411
self._treeview_files.set_model(liststore)
412
crt = gtk.CellRendererToggle()
413
crt.set_property('activatable', not bool(self._pending))
414
crt.connect("toggled", self._toggle_commit, self._files_store)
416
name = _i18n('Commit*')
418
name = _i18n('Commit')
419
commit_col = gtk.TreeViewColumn(name, crt, active=2)
420
commit_col.set_visible(False)
421
self._treeview_files.append_column(commit_col)
422
self._treeview_files.append_column(gtk.TreeViewColumn(_i18n('Path'),
423
gtk.CellRendererText(), text=3))
424
self._treeview_files.append_column(gtk.TreeViewColumn(_i18n('Type'),
425
gtk.CellRendererText(), text=4))
426
self._treeview_files.connect('cursor-changed',
427
self._on_treeview_files_cursor_changed)
429
def _toggle_commit(self, cell, path, model):
430
if model[path][0] is None: # No file_id means 'All Files'
431
new_val = not model[path][2]
435
model[path][2] = not model[path][2]
437
def _toggle_commit_selection(self, button):
438
all_files = self._commit_all_files_radio.get_active()
439
if self._commit_all_changes != all_files:
440
checked_col = self._treeview_files.get_column(0)
441
self._commit_all_changes = all_files
443
checked_col.set_visible(False)
445
checked_col.set_visible(True)
446
renderer = checked_col.get_cell_renderers()[0]
447
renderer.set_property('activatable', not all_files)
449
def _construct_pending_list(self):
450
# Pending information defaults to hidden, we put it all in 1 box, so
451
# that we can show/hide all of them at once
452
self._pending_box = gtk.VBox()
453
self._pending_box.hide()
455
pending_message = gtk.Label()
456
pending_message.set_markup(
457
_i18n('<i>* Cannot select specific files when merging</i>'))
458
self._pending_box.pack_start(pending_message, expand=False, padding=5)
459
pending_message.show()
461
pending_label = gtk.Label(_i18n('Pending Revisions'))
462
self._pending_box.pack_start(pending_label, expand=False, padding=0)
465
scroller = gtk.ScrolledWindow()
466
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
467
self._treeview_pending = gtk.TreeView()
468
scroller.add(self._treeview_pending)
469
scroller.set_shadow_type(gtk.SHADOW_IN)
471
self._pending_box.pack_start(scroller,
472
expand=True, fill=True, padding=5)
473
self._treeview_pending.show()
474
self._left_pane_box.pack_start(self._pending_box)
476
liststore = gtk.ListStore(gobject.TYPE_STRING, # revision_id
477
gobject.TYPE_STRING, # date
478
gobject.TYPE_STRING, # committer
479
gobject.TYPE_STRING, # summary
481
self._pending_store = liststore
482
self._treeview_pending.set_model(liststore)
483
self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Date'),
484
gtk.CellRendererText(), text=1))
485
self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Committer'),
486
gtk.CellRendererText(), text=2))
487
self._treeview_pending.append_column(gtk.TreeViewColumn(_i18n('Summary'),
488
gtk.CellRendererText(), text=3))
490
def _construct_diff_view(self):
491
from diff import DiffView
493
# TODO: jam 2007-10-30 The diff label is currently disabled. If we
494
# decide that we really don't ever want to display it, we should
495
# actually remove it, and other references to it, along with the
496
# tests that it is set properly.
497
self._diff_label = gtk.Label(_i18n('Diff for whole tree'))
498
self._diff_label.set_alignment(0, 0)
499
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
500
self._add_to_right_table(self._diff_label, 1, False)
501
# self._diff_label.show()
503
self._diff_view = DiffView()
504
self._add_to_right_table(self._diff_view, 4, True)
505
self._diff_view.show()
507
def _construct_file_message(self):
508
scroller = gtk.ScrolledWindow()
509
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
511
self._file_message_text_view = gtk.TextView()
512
scroller.add(self._file_message_text_view)
513
scroller.set_shadow_type(gtk.SHADOW_IN)
516
self._file_message_text_view.modify_font(pango.FontDescription("Monospace"))
517
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
518
self._file_message_text_view.set_accepts_tab(False)
519
self._file_message_text_view.show()
521
self._file_message_expander = gtk.Expander(_i18n('File commit message'))
522
self._file_message_expander.set_expanded(True)
523
self._file_message_expander.add(scroller)
524
self._add_to_right_table(self._file_message_expander, 1, False)
525
self._file_message_expander.show()
527
def _construct_global_message(self):
528
self._global_message_label = gtk.Label(_i18n('Global Commit Message'))
529
self._global_message_label.set_markup(
530
_i18n('<b>Global Commit Message</b>'))
531
self._global_message_label.set_alignment(0, 0)
532
self._right_pane_table.set_row_spacing(self._right_pane_table_row, 0)
533
self._add_to_right_table(self._global_message_label, 1, False)
534
# Can we remove the spacing between the label and the box?
535
self._global_message_label.show()
537
scroller = gtk.ScrolledWindow()
538
scroller.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
540
self._global_message_text_view = gtk.TextView()
541
self._global_message_text_view.modify_font(pango.FontDescription("Monospace"))
542
scroller.add(self._global_message_text_view)
543
scroller.set_shadow_type(gtk.SHADOW_IN)
545
self._add_to_right_table(scroller, 2, True)
546
self._file_message_text_view.set_wrap_mode(gtk.WRAP_WORD)
547
self._file_message_text_view.set_accepts_tab(False)
548
self._global_message_text_view.show()
550
def _on_treeview_files_cursor_changed(self, treeview):
551
treeselection = treeview.get_selection()
552
(model, selection) = treeselection.get_selected()
554
if selection is not None:
555
path, display_path = model.get(selection, 1, 3)
556
self._diff_label.set_text(_i18n('Diff for ') + display_path)
558
self._diff_view.show_diff(None)
560
self._diff_view.show_diff([path.decode('UTF-8')])
561
self._update_per_file_info(selection)
563
def _on_accel_next(self, accel_group, window, keyval, modifier):
564
# We don't really care about any of the parameters, because we know
565
# where this message came from
566
tree_selection = self._treeview_files.get_selection()
567
(model, selection) = tree_selection.get_selected()
568
if selection is None:
571
next = model.iter_next(selection)
574
# We have either made it to the end of the list, or nothing was
575
# selected. Either way, select All Files, and jump to the global
577
self._treeview_files.set_cursor((0,))
578
self._global_message_text_view.grab_focus()
580
# Set the cursor to this entry, and jump to the per-file commit
582
self._treeview_files.set_cursor(model.get_path(next))
583
self._file_message_text_view.grab_focus()
585
def _save_current_file_message(self):
586
if self._last_selected_file is None:
587
return # Nothing to save
588
text_buffer = self._file_message_text_view.get_buffer()
589
cur_text = text_buffer.get_text(text_buffer.get_start_iter(),
590
text_buffer.get_end_iter())
591
last_selected = self._files_store.get_iter(self._last_selected_file)
592
self._files_store.set_value(last_selected, 5, cur_text)
594
def _update_per_file_info(self, selection):
595
# The node is changing, so cache the current message
596
if not self._enable_per_file_commits:
599
self._save_current_file_message()
600
text_buffer = self._file_message_text_view.get_buffer()
601
file_id, display_path, message = self._files_store.get(selection, 0, 3, 5)
602
if file_id is None: # Whole tree
603
self._file_message_expander.set_label(_i18n('File commit message'))
604
self._file_message_expander.set_expanded(False)
605
self._file_message_expander.set_sensitive(False)
606
text_buffer.set_text('')
607
self._last_selected_file = None
609
self._file_message_expander.set_label(_i18n('Commit message for ')
611
self._file_message_expander.set_expanded(True)
612
self._file_message_expander.set_sensitive(True)
613
text_buffer.set_text(message)
614
self._last_selected_file = self._files_store.get_path(selection)
616
def _get_specific_files(self):
617
"""Return the list of selected paths, and file info.
619
:return: ([unicode paths], [{utf-8 file info}]
621
self._save_current_file_message()
623
records = iter(self._files_store)
624
rec = records.next() # Skip the All Files record
625
assert rec[0] is None, "Are we skipping the wrong record?"
628
for record in records:
629
if self._commit_all_changes or record[2]:# [2] checkbox
630
file_id = record[0] # [0] file_id
631
path = record[1] # [1] real path
632
file_message = record[5] # [5] commit message
633
files.append(path.decode('UTF-8'))
634
if self._enable_per_file_commits and file_message:
635
# All of this needs to be utf-8 information
636
file_info.append({'path':path, 'file_id':file_id,
637
'message':file_message})
638
file_info.sort(key=lambda x:(x['path'], x['file_id']))
639
if self._enable_per_file_commits:
640
return files, file_info
645
def _on_commit_clicked(self, button):
646
""" Commit button clicked handler. """
649
def _do_commit(self):
650
message = self._get_global_commit_message()
653
response = question_dialog(
654
_i18n('Commit with an empty message?'),
655
_i18n('You can describe your commit intent in the message.'),
657
if response == gtk.RESPONSE_NO:
658
# Kindly give focus to message area
659
self._global_message_text_view.grab_focus()
662
specific_files, file_info = self._get_specific_files()
664
specific_files = None
666
local = self._check_local.get_active()
668
# All we care about is if there is a single unknown, so if this loop is
669
# entered, then there are unknown files.
670
# TODO: jam 20071002 It seems like this should cancel the dialog
671
# entirely, since there isn't a way for them to add the unknown
672
# files at this point.
673
for path in self._wt.unknowns():
674
response = question_dialog(
675
_i18n("Commit with unknowns?"),
676
_i18n("Unknown files exist in the working tree. Commit anyway?"),
678
# Doesn't set a parent for the dialog..
679
if response == gtk.RESPONSE_NO:
686
revprops['file-info'] = bencode.bencode(file_info).decode('UTF-8')
688
rev_id = self._wt.commit(message,
689
allow_pointless=False,
692
specific_files=specific_files,
694
except errors.PointlessCommit:
695
response = question_dialog(
696
_i18n('Commit with no changes?'),
697
_i18n('There are no changes in the working tree.'
698
' Do you want to commit anyway?'),
700
if response == gtk.RESPONSE_YES:
701
rev_id = self._wt.commit(message,
702
allow_pointless=True,
705
specific_files=specific_files,
707
self.committed_revision_id = rev_id
708
self.response(gtk.RESPONSE_OK)
710
def _get_global_commit_message(self):
711
buf = self._global_message_text_view.get_buffer()
712
start, end = buf.get_bounds()
713
return buf.get_text(start, end).decode('utf-8')
715
def _set_global_commit_message(self, message):
716
"""Just a helper for the test suite."""
717
if isinstance(message, unicode):
718
message = message.encode('UTF-8')
719
self._global_message_text_view.get_buffer().set_text(message)
721
def _set_file_commit_message(self, message):
722
"""Helper for the test suite."""
723
if isinstance(message, unicode):
724
message = message.encode('UTF-8')
725
self._file_message_text_view.get_buffer().set_text(message)
728
def _rev_to_pending_info(rev):
729
"""Get the information from a pending merge."""
730
from bzrlib.osutils import format_date
732
rev_dict['committer'] = re.sub('<.*@.*>', '', rev.committer).strip(' ')
733
rev_dict['summary'] = rev.get_summary()
734
rev_dict['date'] = format_date(rev.timestamp,
736
'original', date_fmt="%Y-%m-%d",
738
rev_dict['revision_id'] = rev.revision_id