# -*- coding: utf-8 -*- #Copyright (c) 2010 Nate Theis #Copyright (c) 2011 Walter Bender # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # You should have received a copy of the GNU Lesser General Public # License along with this library; if not, write to the # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. '''A simple text editor for Sugar Written mostly by Nate Theis Some GTK code borrowed from Pippy ''' from groupthink import sugar_tools, gtk_tools from gettext import gettext as _ import os import gtk import pango import time import gtksourceview2 as gtksourceview import logging _logger = logging.getLogger('edit-activity') from sugar.activity import activity try: # Can use 'New' toolbar design? from sugar.graphics.toolbarbox import ToolbarBox _HAVE_TOOLBOX = True except ImportError: _HAVE_TOOLBOX = False if _HAVE_TOOLBOX: from sugar.activity.widgets import ActivityToolbarButton, StopButton from sugar.graphics.toolbarbox import ToolbarButton from sugar.graphics import style from sugar.activity.activity import EditToolbar from sugar.graphics.toolbutton import ToolButton from sugar.graphics.alert import Alert from sugar.graphics.icon import Icon import mdnames def _button_factory(icon_name, tooltip, callback, toolbar, cb_arg=None, accelerator=None): '''Factory for making toolbar buttons''' my_button = ToolButton(icon_name) my_button.set_tooltip(tooltip) my_button.props.sensitive = True if accelerator is not None: my_button.props.accelerator = accelerator if cb_arg is not None: my_button.connect('clicked', callback, cb_arg) else: my_button.connect('clicked', callback) if hasattr(toolbar, 'insert'): # the main toolbar toolbar.insert(my_button, -1) else: # or a secondary toolbar toolbar.props.page.insert(my_button, -1) my_button.show() return my_button class EditActivity(sugar_tools.GroupActivity): '''A text editor for Sugar pylint says I need a docstring. Here you go. ''' message_preparing = _("Loading...") message_joining = _("Joining shared activity...") message_loading = _("Reading journal entry...") def checkts(self): '''Check the timestamp If someone's modified our file in an external editor, we should reload the contents ''' mtime = self.metadata[mdnames.sugartimestamp_md] etime = self.metadata[mdnames.cloudtimestamp_md] return mtime > etime def __init__(self, handle): '''We want to set up the buffer et al. early on sure there's early_setup, but that's not early enough ''' self._object_id = handle.object_id self.buffer = gtksourceview.Buffer() self.refresh_buffer = False self.text_view = gtksourceview.View(self.buffer) self.scrollwindow = gtk.ScrolledWindow() self.scrollwindow.add(self.text_view) sugar_tools.GroupActivity.__init__(self, handle) self.gnome_folder = os.environ['HOME'] if mdnames.gnomefilename_md in self.metadata: self.gnome_filename = self.metadata[mdnames.gnomefilename_md] else: self.gnome_filename = None def fix_mimetype(self): '''We must have a mimetype. Sometimes, we don't (when we get launched newly.) This fixes that.''' if self.metadata[mdnames.mimetype_md] == '': self.metadata[mdnames.mimetype_md] = "text/plain" #we MUST have a mimetype def setup_toolbar(self): '''Setup the top toolbar. Groupthink needs some work here.''' if _HAVE_TOOLBOX: # 'New' Sugar toolbar design toolbox = ToolbarBox() activity_button = ActivityToolbarButton(self) toolbox.toolbar.insert(activity_button, 0) activity_button.show() self.set_toolbar_box(toolbox) toolbox.show() toolbar = toolbox.toolbar self.edit_toolbar = EditToolbar() edit_toolbar_button = ToolbarButton( page=self.edit_toolbar, icon_name='toolbar-edit') self.edit_toolbar.show() toolbar.insert(edit_toolbar_button, -1) edit_toolbar_button.show() else: # 'Old' Sugar toolbar design self.edit_toolbar = EditToolbar() toolbox = activity.ActivityToolbox(self) self.set_toolbox(toolbox) toolbox.add_toolbar(_('Edit'), self.edit_toolbar) toolbox.show() toolbox.set_current_toolbar(1) toolbar = self.edit_toolbar self.edit_toolbar.undo.connect('clicked', self.undobutton_cb) self.edit_toolbar.redo.connect('clicked', self.redobutton_cb) self.edit_toolbar.copy.connect('clicked', self.copybutton_cb) self.edit_toolbar.paste.connect('clicked', self.pastebutton_cb) # Only enable file open dialogs if this is a new, unshared instance if self._object_id is None: self._load_file_from_gnome = _button_factory( 'user-document-open', _('New file from GNOME'), self._load_file_from_gnome_cb, toolbar) # But always enable save as to GNOME self._save_file_to_gnome = _button_factory( 'user-document-save', _('Save file to GNOME'), self._save_as_file_to_gnome_cb, toolbar) if _HAVE_TOOLBOX: separator = gtk.SeparatorToolItem() separator.props.draw = False separator.set_expand(True) toolbar.insert(separator, -1) separator.show() stop_button = StopButton(self) stop_button.props.accelerator = 'q' toolbox.toolbar.insert(stop_button, -1) stop_button.show() def initialize_display(self): '''Set up GTK and friends''' self.fix_mimetype() self.cloud.shared_buffer = gtk_tools.TextBufferSharePoint(self.buffer) self.setup_toolbar() #Some graphics code borrowed from Pippy lang_manager = gtksourceview.language_manager_get_default() if hasattr(lang_manager, 'list_languages'): langs = lang_manager.list_languages() else: lang_ids = lang_manager.get_language_ids() langs = [lang_manager.get_language(lang_id) \ for lang_id in lang_ids] for lang in langs: for mtype in lang.get_mime_types(): if mtype == self.metadata[mdnames.mimetype_md]: self.buffer.set_language(lang) break self.text_view.set_editable(True) self.text_view.set_cursor_visible(True) if self.metadata[mdnames.mimetype_md] == "text/plain": self.text_view.set_show_line_numbers(False) self.text_view.set_wrap_mode(gtk.WRAP_WORD) font = pango.FontDescription("Bitstream Vera Sans " + str(style.FONT_SIZE)) else: if hasattr(self.buffer, 'set_highlight'): self.buffer.set_highlight(True) else: self.buffer.set_highlight_syntax(True) self.text_view.set_show_line_numbers(True) self.text_view.set_wrap_mode(gtk.WRAP_CHAR) self.text_view.set_insert_spaces_instead_of_tabs(True) self.text_view.set_tab_width(2) self.text_view.set_auto_indent(True) font = pango.FontDescription("Monospace " + str(style.FONT_SIZE)) self.text_view.modify_font(font) if self.refresh_buffer: #see load_from_journal() self.buffer.begin_not_undoable_action() self.buffer.set_text(self.refresh_buffer) self.buffer.end_not_undoable_action() self.text_view.show() #Return the main widget. our parents take care of GTK stuff return self.scrollwindow def _load_file_from_gnome_cb(self, button=None): ''' Opens a chooser dialog to file system for loading ''' text = self._get_text() if len(text) > 0: discard_alert = Alert() discard_alert.props.title = _('You have been typing. Discard?') discard_alert.props.msg = self._get_text()[0:min(25, len(text))] +\ '...' cancel_icon = Icon(icon_name='dialog-cancel') discard_alert.add_button(gtk.RESPONSE_CANCEL, _('Cancel'), cancel_icon) cancel_icon.show() discard_icon = Icon(icon_name='dialog-ok') discard_alert.add_button(gtk.RESPONSE_APPLY, _('Discard'), discard_icon) discard_icon.show() self.add_alert(discard_alert) discard_alert.connect('response', self.__discard_cb) discard_alert.show() else: self._open_dialog() def __discard_cb(self, alert, response_id): ''' Callback for positive response to discard alert ''' if response_id is gtk.RESPONSE_APPLY: self._open_dialog() self.remove_alert(alert) def _open_dialog(self): ''' The GNOME file open dialog ''' dialog = gtk.FileChooserDialog( _('Load...'), None, gtk.FILE_CHOOSER_ACTION_OPEN, (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL, gtk.STOCK_OPEN, gtk.RESPONSE_OK)) dialog.set_default_response(gtk.RESPONSE_OK) dialog.set_current_folder(self.gnome_folder) response = dialog.run() if response == gtk.RESPONSE_OK: self.load_from_journal(dialog.get_filename()) self.gnome_folder = dialog.get_current_folder() self.gnome_filename = dialog.get_filename() self.metadata['title'] = self.gnome_filename self.metadata[mdnames.gnomefilename_md] = self.gnome_filename dialog.destroy() def _save_as_file_to_gnome_cb(self, button=None): ''' Opens a chooser dialog to file system for save as ''' dialog = gtk.FileChooserDialog( _('Save as...'), None, gtk.FILE_CHOOSER_ACTION_OPEN, (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL, gtk.STOCK_SAVE_AS, gtk.RESPONSE_OK)) dialog.set_default_response(gtk.RESPONSE_OK) dialog.set_current_folder(self.gnome_folder) if self.gnome_filename is not None: dialog.set_filename(self.gnome_filename) response = dialog.run() if response == gtk.RESPONSE_OK: self.gnome_folder = dialog.get_current_folder() self.gnome_filename = dialog.get_filename() self.metadata['title'] = self.gnome_filename self.metadata[mdnames.gnomefilename_md] = self.gnome_filename if os.path.exists(dialog.get_filename()): exists_alert = Alert() exists_alert.props.title = _('File exists. Overwrite?') exists_alert.props.msg = dialog.get_filename() cancel_icon = Icon(icon_name='dialog-cancel') exists_alert.add_button(gtk.RESPONSE_CANCEL, _('Cancel'), cancel_icon) cancel_icon.show() save_icon = Icon(icon_name='dialog-ok') exists_alert.add_button(gtk.RESPONSE_APPLY, _('Overwrite'), save_icon) save_icon.show() self.add_alert(exists_alert) exists_alert.connect('response', self.__overwrite_cb) exists_alert.show() else: self._write_to_file(self.gnome_filename) dialog.destroy() def __overwrite_cb(self, alert, response_id): ''' Callback for positive response to overwrite alert ''' if response_id is gtk.RESPONSE_APPLY: self._write_to_file(self.gnome_filename) self.remove_alert(alert) def _get_text(self): ''' Get text from edit buffer ''' bounds = self.buffer.get_bounds() return self.buffer.get_text(bounds[0], bounds[1]) def _write_to_file(self, filename): ''' Write text to file, either in the datastore or file system ''' fhandle = open(filename, "w") text = self._get_text() fhandle.write(text) fhandle.close() return text def save_to_journal(self, filename, cloudstring): '''Saves to the journal. We use metadata magic to keep the collab. stuff''' # TODO: Only save cloudstring_md if we have been sharing. self.metadata[mdnames.cloudstring_md] = cloudstring #We can do full-text search on all Edit documents, yay self.metadata[mdnames.contents_md] = self._write_to_file(filename) self.fix_mimetype() #If we edit the file in another way, we need to reload the contents #we fudge the timestamp forwards by 5 seconds #mmmm, fudge self.metadata[mdnames.cloudtimestamp_md] = time.clock() + 5 def load_from_journal(self, filename): '''Load the file. Duh.''' _logger.debug('loading %s' % (filename)) if mdnames.cloudstring_md in self.metadata: if self.checkts(): #if we were edited in another program #we need to reload the text #setting self.refresh_buffer makes us do that text = open(filename, "r").read() # yay hackish one-line read self.refresh_buffer = text #File has been saved with Edit, thus #load the fancy collaboration data #instead of just the text return self.metadata[mdnames.cloudstring_md] else: text = open(filename, "r").read() # yay hackish one-line read self.buffer.set_text(text) return None def when_shared(self): ''' Does this get called by Groupthink? ''' self._edit_toolbar.undo.set_sensitive(False) self._edit_toolbar.redo.set_sensitive(False) self._load_file_from_journal.set_sensitive(False) def undobutton_cb(self, button): if self.buffer.can_undo(): self.buffer.undo() def redobutton_cb(self, button): global text_buffer if self.buffer.can_redo(): self.buffer.redo() def copybutton_cb(self, button): self.buffer.copy_clipboard(gtk.Clipboard()) def pastebutton_cb(self, button): self.buffer.paste_clipboard(gtk.Clipboard(), None, True)