import os
import zipfile
import logging
from gi.repository import Gtk
from gi.repository import Gdk
from gi.repository import Pango
from gi.repository import GObject
import threading
from sugar3 import mime
from sugar3.graphics import style
PAGE_SIZE = 38
# remove hard line breaks, apply a simple logic to try identify
# the unneeded
def _clean_text(line):
if line != '\r\n' and len(line) > 2:
if line[-3] not in ('.', ',', '-', ';') and len(line) > 60:
line = line[:-2]
return line
class TextViewer(GObject.GObject):
__gsignals__ = {
'zoom-changed': (GObject.SignalFlags.RUN_FIRST, GObject.TYPE_NONE,
([int])),
'page-changed': (GObject.SignalFlags.RUN_FIRST, GObject.TYPE_NONE,
([int, int])),
'selection-changed': (GObject.SignalFlags.RUN_FIRST, GObject.TYPE_NONE,
([])), }
def setup(self, activity):
self._activity = activity
self.__going_fwd = False
self.__going_back = True
self.textview = Gtk.TextView()
self.textview.set_editable(False)
self.textview.set_cursor_visible(False)
self.textview.set_left_margin(50)
self.textview.set_right_margin(50)
self.textview.set_justification(Gtk.Justification.LEFT)
self.textview.set_wrap_mode(Gtk.WrapMode.WORD)
self.textview.connect('button-release-event',
self._view_buttonrelease_event_cb)
self.connect('selection-changed',
activity._view_selection_changed_cb)
self.textview.set_events(self.textview.get_events() |
Gdk.EventMask.TOUCH_MASK)
self.textview.connect('event', self.__touch_event_cb)
self._sw = Gtk.ScrolledWindow()
self._sw.add(self.textview)
self._v_vscrollbar = self._sw.get_vscrollbar()
self._v_scrollbar_value_changed_cb_id = \
self._v_vscrollbar.connect('value-changed',
self._v_scrollbar_value_changed_cb)
self._scrollbar = Gtk.VScrollbar()
self._scrollbar_change_value_cb_id = \
self._scrollbar.connect('change-value',
self._scrollbar_change_value_cb)
overlay = Gtk.Overlay()
hbox = Gtk.HBox()
overlay.add(hbox)
hbox.add(self._sw)
self._scrollbar.props.halign = Gtk.Align.END
self._scrollbar.props.valign = Gtk.Align.FILL
overlay.add_overlay(self._scrollbar)
overlay.show_all()
activity._hbox.pack_start(overlay, True, True, 0)
self._font_size = style.zoom(12)
self.font_desc = Pango.FontDescription("mono %d" % self._font_size)
self.textview.modify_font(self.font_desc)
self._zoom = 100
self.font_zoom_relation = self._zoom // self._font_size
self._current_page = 0
self.highlight_tag = self.textview.get_buffer().create_tag()
self.highlight_tag.set_property('underline', Pango.Underline.SINGLE)
self.highlight_tag.set_property('foreground', 'black')
self.highlight_tag.set_property('background', 'yellow')
# text to speech initialization
self.current_word = 0
self.word_tuples = []
self.spoken_word_tag = self.textview.get_buffer().create_tag()
self.spoken_word_tag.set_property('weight', Pango.Weight.BOLD)
self.normal_tag = self.textview.get_buffer().create_tag()
self.normal_tag.set_property('weight', Pango.Weight.NORMAL)
def load_document(self, file_path):
file_name = file_path.replace('file://', '')
mimetype = mime.get_for_file(file_path)
if mimetype == 'application/zip':
logging.debug('opening zip file')
self.zf = zipfile.ZipFile(file_path.replace('file://', ''), 'r')
self.book_files = self.zf.namelist()
extract_path = os.path.join(self._activity.get_activity_root(),
'instance')
for book_file in self.book_files:
if (book_file != 'annotations.pkl'):
self.zf.extract(book_file, extract_path)
file_name = os.path.join(extract_path, book_file)
logging.debug('opening file_name %s' % file_name)
self._etext_file = open(file_name, 'r')
self.page_index = [0]
pagecount = 0
linecount = 0
while self._etext_file:
line = self._etext_file.readline()
if not line:
break
line_increment = (len(line) // 80) + 1
linecount = linecount + line_increment
if linecount >= PAGE_SIZE:
position = self._etext_file.tell()
self.page_index.append(position)
linecount = 0
pagecount = pagecount + 1
self._pagecount = pagecount + 1
self.set_current_page(0)
self._scrollbar.set_range(0.0, self._pagecount - 1.0)
self._scrollbar.set_increments(1.0, 1.0)
# TODO: now that sugar3.speech has word signals
# call self.highlight_next_word on each word
# call self.reset_text_to_speech at end
def _show_page(self, page_number):
position = self.page_index[page_number]
self._etext_file.seek(position)
linecount = 0
label_text = '\n\n\n'
while linecount < PAGE_SIZE:
line = self._etext_file.readline()
if not line:
break
else:
line = _clean_text(line)
label_text = label_text + line
line_increment = (len(line) // 80) + 1
linecount = linecount + line_increment
textbuffer = self.textview.get_buffer()
label_text = label_text + '\n\n\n'
textbuffer.set_text(label_text)
self._prepare_text_to_speech(label_text)
def _v_scrollbar_value_changed_cb(self, scrollbar):
"""
This is the real scrollbar containing the text view
"""
if self._current_page < 1:
return
scrollval = scrollbar.get_value()
scroll_upper = self._v_vscrollbar.props.adjustment.props.upper
if self.__going_fwd and \
not self._current_page == self._pagecount:
if scrollval == scroll_upper:
self.set_current_page(self._current_page + 1)
elif self.__going_back and self._current_page > 1:
if scrollval == 0.0:
self.set_current_page(self._current_page - 1)
def _scrollbar_change_value_cb(self, range, scrolltype, value):
"""
This is the fake scrollbar visible, used to show the length of the book
"""
old_page = self._current_page
if scrolltype == Gtk.ScrollType.STEP_FORWARD:
self.__going_fwd = True
self.__going_back = False
elif scrolltype == Gtk.ScrollType.STEP_BACKWARD:
self.__going_fwd = False
self.__going_back = True
elif scrolltype == Gtk.ScrollType.JUMP or \
scrolltype == Gtk.ScrollType.PAGE_FORWARD or \
scrolltype == Gtk.ScrollType.PAGE_BACKWARD:
if value > self._scrollbar.props.adjustment.props.upper:
value = self._pagecount - 1
self._show_page(int(value))
self._current_page = int(value)
self.emit('page-changed', old_page, self._current_page)
else:
print('Warning: unknown scrolltype %s with value %f'
% (str(scrolltype), value))
# FIXME: This should not be needed here
self._scrollbar.set_value(self._current_page)
def __touch_event_cb(self, widget, event):
if event.type == Gdk.EventType.TOUCH_BEGIN:
x = event.touch.x
view_width = widget.get_allocation().width
if x > view_width * 3 // 4:
self.scroll(Gtk.ScrollType.PAGE_FORWARD, False)
elif x < view_width * 1 // 4:
self.scroll(Gtk.ScrollType.PAGE_BACKWARD, False)
def can_highlight(self):
return True
def get_selection_bounds(self):
if self.textview.get_buffer().get_selection_bounds():
begin, end = self.textview.get_buffer().get_selection_bounds()
return [begin.get_offset(), end.get_offset()]
else:
return []
def get_cursor_position(self):
insert_mark = self.textview.get_buffer().get_insert()
return self.textview.get_buffer().get_iter_at_mark(
insert_mark).get_offset()
def in_highlight(self):
# Verify if the selection already exist or the cursor
# is in a highlighted area
tuples_list = self._activity._bookmarkmanager.get_highlights(
self.get_current_page())
selection_tuple = self.get_selection_bounds()
in_bounds = False
highlight_found = None
for highlight_tuple in tuples_list:
logging.debug('control tuple %s' % str(highlight_tuple))
if selection_tuple:
if selection_tuple[0] >= highlight_tuple[0] and \
selection_tuple[1] <= highlight_tuple[1]:
in_bounds = True
highlight_found = highlight_tuple
break
return in_bounds, highlight_found
def show_highlights(self, page):
tuples_list = self._activity._bookmarkmanager.get_highlights(page)
textbuffer = self.textview.get_buffer()
bounds = textbuffer.get_bounds()
textbuffer.remove_all_tags(bounds[0], bounds[1])
for highlight_tuple in tuples_list:
iterStart = textbuffer.get_iter_at_offset(highlight_tuple[0])
iterEnd = textbuffer.get_iter_at_offset(highlight_tuple[1])
textbuffer.apply_tag(self.highlight_tag, iterStart, iterEnd)
def toggle_highlight(self, highlight):
found, old_highlight_found = self.in_highlight()
if highlight:
selection_tuple = self.get_selection_bounds()
self._activity._bookmarkmanager.add_highlight(
self.get_current_page(), selection_tuple)
else:
self._activity._bookmarkmanager.del_highlight(
self.get_current_page(), old_highlight_found)
self.show_highlights(self.get_current_page())
def connect_page_changed_handler(self, handler):
self.connect('page-changed', handler)
def can_do_text_to_speech(self):
return True
def get_marked_words(self):
"Adds a mark between each word of text."
i = self.current_word
marked_up_text = '<speak> '
while i < len(self.word_tuples):
word_tuple = self.word_tuples[i]
marked_up_text = marked_up_text + \
' <mark name="' + str(i) + '"/>' + word_tuple[2]
i = i + 1
print(marked_up_text)
return marked_up_text + '</speak>'
def reset_text_to_speech(self):
self.current_word = 0
def _prepare_text_to_speech(self, page_text):
i = 0
j = 0
word_begin = 0
word_end = 0
ignore_chars = [' ', '\n', '\r', '_', '[', '{', ']', '}', '|',
'<', '>', '*', '+', '/', '\\']
ignore_set = set(ignore_chars)
self.word_tuples = []
len_page_text = len(page_text)
while i < len_page_text:
if page_text[i] not in ignore_set:
word_begin = i
j = i
while j < len_page_text and page_text[j] not in ignore_set:
j = j + 1
word_end = j
i = j
word_tuple = (word_begin, word_end,
page_text[word_begin: word_end])
if word_tuple[2] != '\r':
self.word_tuples.append(word_tuple)
i = i + 1
def highlight_next_word(self, word_count):
if word_count < len(self.word_tuples):
word_tuple = self.word_tuples[word_count]
textbuffer = self.textview.get_buffer()
iterStart = textbuffer.get_iter_at_offset(word_tuple[0])
iterEnd = textbuffer.get_iter_at_offset(word_tuple[1])
bounds = textbuffer.get_bounds()
textbuffer.apply_tag(self.normal_tag, bounds[0], iterStart)
textbuffer.apply_tag(self.spoken_word_tag, iterStart, iterEnd)
v_adjustment = self._sw.get_vadjustment()
max_pos = v_adjustment.get_upper() - v_adjustment.get_page_size()
max_pos = max_pos * word_count
max_pos = max_pos // len(self.word_tuples)
v_adjustment.set_value(max_pos)
self.current_word = word_count
return True
def update_metadata(self, activity):
self.metadata = activity.metadata
self.metadata['Read_zoom'] = str(self.get_zoom())
def load_metadata(self, activity):
self.metadata = activity.metadata
if 'Read_zoom' in self.metadata:
try:
logging.debug('Loading zoom %s', self.metadata['Read_zoom'])
self.set_zoom(float(self.metadata['Read_zoom']))
except:
pass
def set_current_page(self, page):
old_page = self._current_page
self._current_page = page
self._show_page(self._current_page)
self._scrollbar.handler_block(self._scrollbar_change_value_cb_id)
self._scrollbar.set_value(self._current_page)
self._scrollbar.handler_unblock(self._scrollbar_change_value_cb_id)
self.emit('page-changed', old_page, self._current_page)
def scroll(self, scrolltype, horizontal):
v_adjustment = self._sw.get_vadjustment()
v_value = v_adjustment.get_value()
if scrolltype in (Gtk.ScrollType.PAGE_BACKWARD,
Gtk.ScrollType.PAGE_FORWARD):
step = v_adjustment.get_page_increment()
else:
step = v_adjustment.get_step_increment()
if scrolltype in (Gtk.ScrollType.PAGE_BACKWARD,
Gtk.ScrollType.STEP_BACKWARD):
self.__going_fwd = False
self.__going_back = True
if v_value <= v_adjustment.get_lower():
self.previous_page()
v_adjustment.set_value(v_adjustment.get_upper() -
v_adjustment.get_page_size())
return
if v_value > v_adjustment.get_lower():
new_value = v_value - step
if new_value < v_adjustment.get_lower():
new_value = v_adjustment.get_lower()
v_adjustment.set_value(new_value)
elif scrolltype in (Gtk.ScrollType.PAGE_FORWARD,
Gtk.ScrollType.STEP_FORWARD):
self.__going_fwd = True
self.__going_back = False
if v_value >= v_adjustment.get_upper() - \
v_adjustment.get_page_size():
self.next_page()
return
if v_value < v_adjustment.get_upper() - \
v_adjustment.get_page_size():
new_value = v_value + step
if new_value > v_adjustment.get_upper() - \
v_adjustment.get_page_size():
new_value = v_adjustment.get_upper() - \
v_adjustment.get_page_size()
v_adjustment.set_value(new_value)
elif scrolltype == Gtk.ScrollType.START:
self.set_current_page(0)
elif scrolltype == Gtk.ScrollType.END:
self.set_current_page(self._pagecount - 1)
def previous_page(self):
v_adjustment = self._sw.get_vadjustment()
v_adjustment.set_value(v_adjustment.get_upper() -
v_adjustment.get_page_size())
self.set_current_page(max(0, self.get_current_page() - 1))
def next_page(self):
v_adjustment = self._sw.get_vadjustment()
v_adjustment.set_value(v_adjustment.get_lower())
self.set_current_page(
min(self._pagecount - 1, self.get_current_page() + 1))
def get_current_page(self):
return self._current_page
def get_pagecount(self):
return self._pagecount
def update_toc(self, activity):
pass
def handle_link(self, link):
pass
def get_current_file(self):
pass
def copy(self):
clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
self.textview.get_buffer().copy_clipboard(clipboard)
def _view_buttonrelease_event_cb(self, view, event):
self._has_selection = \
self.textview.get_buffer().get_selection_bounds() != ()
self.emit('selection-changed')
def get_has_selection(self):
return self._has_selection
def find_set_highlight_search(self, boolean):
pass
def setup_find_job(self, text, _find_updated_cb):
self._find_job = _JobFind(self._etext_file, start_page=0,
n_pages=self._pagecount,
text=text, case_sensitive=False)
self._find_updated_handler = self._find_job.connect(
'updated', _find_updated_cb)
return self._find_job, self._find_updated_handler
def find_next(self):
self._find_job.find_next()
def find_previous(self):
self._find_job.find_previous()
def find_changed(self, job, page):
self.set_current_page(job.get_page())
self._show_found_text(job.get_founded_tuple())
def _show_found_text(self, founded_tuple):
textbuffer = self.textview.get_buffer()
tag = textbuffer.create_tag()
tag.set_property('weight', Pango.Weight.BOLD)
tag.set_property('foreground', 'white')
tag.set_property('background', 'black')
iterStart = textbuffer.get_iter_at_offset(founded_tuple[1])
iterEnd = textbuffer.get_iter_at_offset(founded_tuple[2])
textbuffer.apply_tag(tag, iterStart, iterEnd)
def get_zoom(self):
return self.font_zoom_relation * self._font_size
def connect_zoom_handler(self, handler):
self._view_notify_zoom_handler = self.connect('zoom-changed',
handler)
return self._view_notify_zoom_handler
def set_zoom(self, value):
self._zoom = value
self._font_size = self._zoom // self.font_zoom_relation
self.font_desc.set_size(self._font_size * 1024)
self.textview.modify_font(self.font_desc)
def zoom_in(self):
self._set_font_size(self._font_size + 1)
def zoom_out(self):
self._set_font_size(self._font_size - 1)
def _set_font_size(self, size):
self._font_size = size
self.font_desc.set_size(self._font_size * 1024)
self.textview.modify_font(self.font_desc)
self._zoom = self.font_zoom_relation * self._font_size
self.emit('zoom-changed', self._zoom)
def zoom_to_width(self):
pass
def can_zoom_in(self):
return True
def can_zoom_out(self):
return self._font_size > 1
def can_zoom_to_width(self):
return False
def zoom_to_best_fit(self):
return False
def zoom_to_actual_size(self):
return False
def can_rotate(self):
return False
class _JobFind(GObject.GObject):
__gsignals__ = {
'updated': (GObject.SignalFlags.RUN_FIRST, GObject.TYPE_NONE, ([])), }
def __init__(self, text_file, start_page, n_pages, text,
case_sensitive=False):
GObject.GObject.__init__(self)
Gdk.threads_init()
self._finished = False
self._text_file = text_file
self._start_page = start_page
self._n_pages = n_pages
self._text = text
self._case_sensitive = case_sensitive
self.threads = []
s_thread = _SearchThread(self)
self.threads.append(s_thread)
s_thread.start()
def cancel(self):
'''
Cancels the search job
'''
for s_thread in self.threads:
s_thread.stop()
def is_finished(self):
'''
Returns True if the entire search job has been finished
'''
return self._finished
def get_search_text(self):
'''
Returns the search text
'''
return self._text
def get_case_sensitive(self):
'''
Returns True if the search is case-sensitive
'''
return self._case_sensitive
def find_next(self):
self.threads[-1].find_next()
def find_previous(self):
self.threads[-1].find_previous()
def get_page(self):
return self.threads[-1].get_page()
def get_founded_tuple(self):
return self.threads[-1].get_founded_tuple()
class _SearchThread(threading.Thread):
def __init__(self, obj):
threading.Thread.__init__(self)
self.obj = obj
self.stopthread = threading.Event()
def _start_search(self):
pagecount = 0
linecount = 0
charcount = 0
self._found_records = []
self._current_found_item = -1
self.obj._text_file.seek(0)
while self.obj._text_file:
line = self.obj._text_file.readline()
line = _clean_text(line)
line_length = len(line)
if not line:
break
line_increment = (len(line) // 80) + 1
linecount = linecount + line_increment
positions = self._allindices(line.lower(), self.obj._text.lower())
for position in positions:
found_pos = charcount + position + 3
found_tuple = (pagecount, found_pos,
len(self.obj._text) + found_pos)
self._found_records.append(found_tuple)
self._current_found_item = 0
charcount = charcount + line_length
if linecount >= PAGE_SIZE:
linecount = 0
charcount = 0
pagecount = pagecount + 1
if self._current_found_item == 0:
self.current_found_tuple = \
self._found_records[self._current_found_item]
self._page = self.current_found_tuple[0]
Gdk.threads_enter()
self.obj._finished = True
self.obj.emit('updated')
Gdk.threads_leave()
return False
def _allindices(self, line, search, listindex=None, offset=0):
if listindex is None:
listindex = []
if (line.find(search) == -1):
return listindex
else:
offset = line.index(search) + offset
listindex.append(offset)
line = line[(line.index(search) + 1):]
return self._allindices(line, search, listindex, offset + 1)
def run(self):
self._start_search()
def stop(self):
self.stopthread.set()
def find_next(self):
self._current_found_item = self._current_found_item + 1
if self._current_found_item >= len(self._found_records):
self._current_found_item = 0
self.current_found_tuple = \
self._found_records[self._current_found_item]
self._page = self.current_found_tuple[0]
self.obj.emit('updated')
def find_previous(self):
self._current_found_item = self._current_found_item - 1
if self._current_found_item <= 0:
self._current_found_item = len(self._found_records) - 1
self.current_found_tuple = \
self._found_records[self._current_found_item]
self._page = self.current_found_tuple[0]
self.obj.emit('updated')
def get_page(self):
return self._page
def get_founded_tuple(self):
return self.current_found_tuple