# vim:fileencoding=utf-8 # License: GPL v3 Copyright: 2022, Kovid Goyal from __python__ import bound_methods, hash_literals from elementmaker import E from gettext import gettext as _ from ajax import ajax, ajax_send from book_list.cover_grid import THUMBNAIL_MAX_HEIGHT, THUMBNAIL_MAX_WIDTH from book_list.globals import get_current_query, get_session_data from book_list.library_data import current_library_id, download_url, library_data from book_list.router import home, open_book_url, push_state from book_list.top_bar import create_top_bar from book_list.ui import query_as_href, set_panel_handler from book_list.views import create_image from complete import create_search_bar from dom import add_extra_css, clear, set_css, svgicon from modals import create_custom_dialog, error_dialog, info_dialog, question_dialog from widgets import create_spinner overall_container_id = '' current_fts_query = {} query_id_counter = 0 add_extra_css(def (): sel = '.fts-help-display ' style = f'{sel} ' + '{ padding-top: 0.5ex }\n' style += f'{sel} div' + ' { margin-top: 0.5ex }\n' style += f'{sel} .h' + ' { font-weight: bold; padding-bottom: 0.25ex }\n' style += f'{sel} .bq' + ' { margin-left: 1em; margin-top: 0.5ex; margin-bottom: 0.5ex; font-style: normal; font-weight: 700 }\n' style += f'{sel} p' + ' { margin: 0}\n' style += '.fts-highlight-match { font-style: normal; font-weight: bold }\n' return style ) def component(name): c = document.getElementById(overall_container_id) if c: return c.querySelector(f'[data-component="{name}"]') def showing_search_panel(): c = component('search') return bool(c and c.style.display is 'block') def make_new_fts_query(q): nonlocal current_fts_query, query_id_counter query_id_counter += 1 current_fts_query = {'query_id': query_id_counter + ''} if current_library_id(): current_fts_query.library_id = current_library_id() Object.assign(current_fts_query, q) xhr = ajax('fts/search', on_initial_fts_fetched, query=current_fts_query, bypass_cache=True) xhr.send() def enable_indexing(): def on_response(end_type, xhr, ev): if end_type is 'abort' or not showing_search_panel(): return if end_type is not 'load': if xhr.status is 403: return error_dialog(_('Permission denied'), _( 'You do not have permission to enable indexing. Only logged in users with write permission are allowed.'), xhr.error_html) return error_dialog(_('Failed to enable indexing'), _('Enabling indexing failed. Click "Show details" for more information.'), xhr.error_html) library_data.fts_enabled = True info_dialog( _('Indexing enabled'), _('Indexing of this library has been enabled. Depending on library size it can take a long time to index all books.') ) ajax_send(f'fts/indexing', True, on_response) def report_fts_not_enabled(): question_dialog(_('Full text searching disabled'), _( 'Full text search indexing has not been enabled for this library. Once enabled, indexing' ' will take some time to complete after which searching will work. Enable indexing?'), def (yes): if yes: enable_indexing() ) def on_initial_fts_fetched(end_type, xhr, ev): if end_type is 'abort' or not showing_search_panel(): return if end_type is not 'load': clear_to_waiting_for_results(_('No matches found')) if xhr.status is 428: return report_fts_not_enabled() return error_dialog(_('Failed to search'), _('The search failed. Click "Show details" for more information.'), xhr.error_html) try: results = JSON.parse(xhr.responseText) except Exception as err: return error_dialog(_('Server error'), _('Failed to parse search response from server.'), err + '') if results.query_id + '' is not current_fts_query.query_id: return current_fts_query.results = results show_initial_results() def execute_search_interactive(): nonlocal current_fts_query query = component('query').querySelector('input').value if not query or query.length < 1: error_dialog(_('No search query specified'), _('A search word/phrase must be specified before attempting to search')) clear_to_help() return q = get_current_query() q.fts_panel = 'search' q.fts_query = query q.fts_use_stemming = 'y' if component('related_words').checked else 'n' if q.restricted is 'y': q.restriction = component('restrict').querySelector('input').value current_fts_query = {} push_state(q, replace=True) def build_search_page(): # search input container container = component('search') clear(container) search_bar = create_search_bar( execute_search_interactive, 'search-books-fts', tooltip=_('Search for books'), placeholder=_('Enter words to search for'), button='icon-button' ) set_css(search_bar, flex_grow='10', margin_right='0.5em') search_bar.dataset.component = 'query' container.appendChild(search_bar) sd = get_session_data() related_words = E.label(E.input( type='checkbox', data_component='related_words', checked=bool(sd.get('fts_related_words'))), onchange=def (): sd = get_session_data() rw = bool(component('related_words').checked) if rw is not sd.get('fts_related_words'): get_session_data().set('fts_related_words', rw) , ' ' + _('Match on related words'), title = _( 'With this option searching for words will also match on any related words (supported in several languages). For' ' example, in the English language: {0} matches {1} and {2} as well').format( 'correction', 'correcting', 'corrected') ) container.appendChild(E.div(style='padding-top: 1ex;', related_words)) restrict_bar = create_search_bar( execute_search_interactive, 'search-books-fts-restrict', tooltip=_('Restrict the results to only books matching this query'), placeholder=_('Restrict to books matching...') ) set_css(restrict_bar, flex_grow='10', margin_right='0.5em') restrict_bar.dataset.component = 'restrict' container.appendChild(E.div(style='padding-top: 1ex; display: flex; width: 100%; align-items: center', svgicon('search'), E.span('\xa0'), restrict_bar)) # Search help container.appendChild(E.div(style='border-top: 1px currentColor solid; margin-top: 1ex', data_component='results')) def clear_to_waiting_for_results(msg): container = component('results') if not container: return clear(container) msg = msg or (_('Searching, please wait') + '…') container.appendChild(E.div( style='margin: auto; width: 100%; text-align: center; margin-top: 4ex', create_spinner(), '\xa0' + msg )) def toggle_restrict(): container = component('restrict') if not container: return q = get_current_query() q.restricted = 'n' if q.restricted is 'y' else 'y' push_state(q, replace=True) def clear_to_help(): container = component('results') if not container: return clear(container) container.appendChild(E.div(class_='fts-help-display')) restrict = get_current_query().restricted is 'y' container.appendChild(E.div( style='margin-top: 1ex', E.a(_('Re-index all books in this library'), class_='blue-link', href='javascript:void(0)', onclick=reindex_all), E.span('\xa0\xa0'), E.a(_('Disable full text search'), class_='blue-link', href='javascript:void(0)', onclick=disable_fts), E.span('\xa0\xa0'), E.a( _('Search all books') if restrict else _('Search a subset of books'), class_='blue-link', href='javascript:void(0)', onclick=toggle_restrict ), )) container = container.firstChild fts_url = 'https://www.sqlite.org/fts5.html#full_text_query_syntax' html = _('''
Search for single words

Simply type the word:

awesome
calibre
Search for phrases

Enclose the phrase in quotes:

"early run"
"song of love"
Boolean searches
(calibre AND ebook) NOT gun
simple NOT ("high bar" OR hard)
Phrases near each other
NEAR("people" "in Asia" "try")
NEAR("Kovid" "calibre", 30)

Here, 30 is the most words allowed between near groups. Defaults to 10 when unspecified.

Complete syntax reference
\ ''').format(fts_url=fts_url) container.innerHTML = html a = container.querySelector('a[href]') a.setAttribute('target', '_new') a.classList.add('blue-link') def apply_search_panel_state(): q = get_current_query() ftsq = {'query': q.fts_query or '', 'use_stemming': q.fts_use_stemming or 'y', 'restriction': q.restriction if q.restricted is 'y' else ''} component('query').querySelector('input').value = ftsq.query component('related_words').checked = ftsq.use_stemming is 'y' r = component('restrict') r.parentNode.style.display = 'flex' if ftsq.restriction is not '' else 'none' r.querySelector('input').value = q.restriction or '' if not ftsq.query: clear_to_help() return if (current_fts_query.query is not ftsq.query or current_fts_query.use_stemming is not ftsq.use_stemming or current_fts_query.restriction is not ftsq.restriction): make_new_fts_query(ftsq) clear_to_waiting_for_results(_('Searching for {}, please wait…').format(ftsq.query)) return show_initial_results() def open_format(book_id, fmt): snippets = current_fts_query.results?.snippets if snippets: snippets = snippets[book_id] text = '' if snippets and fmt is not 'PDF': for s in snippets: if s.formats.indexOf(fmt) > -1: text = s.text break url = open_book_url(book_id, fmt) if fmt is 'PDF': url = download_url(book_id, fmt, 'inline') w = window.open(url, '_blank') if text: text = str.strip(text, '…').replaceAll('\x1c', '').replaceAll('\x1e', '') w.read_book_initial_open_search_text = {'text': text, 'query': current_fts_query.query} def reindex_book(book_id): def on_response(end_type, xhr, ev): if end_type is 'abort' or not showing_search_panel(): return if end_type is not 'load': if xhr.status is 403: return error_dialog(_('Permission denied'), _( 'You do not have permission to re-index books. Only logged in users with write permission are allowed to re-index'), xhr.error_html) return error_dialog(_('Failed to re-index'), _('Re-indexing the book failed. Click "Show details" for more information.'), xhr.error_html) info_dialog(_('Re-indexing scheduled'), _('The book has been scheduled for re-indexing') if book_id else _( 'All books have been scheduled for re-indexing') ) if book_id: ajax_send(f'fts/reindex', {book_id: []}, on_response) else: ajax_send(f'fts/reindex', 'all', on_response) def reindex_all(): question_dialog(_('Are you sure?'), _('Re-indexing all books in the library can take a long time. Are you sure you want to proceed?'), def (yes): if yes: reindex_book() ) def disable_fts_backend(): def on_response(end_type, xhr, ev): if end_type is 'abort' or not showing_search_panel(): return if end_type is not 'load': if xhr.status is 403: return error_dialog(_('Permission denied'), _( 'You do not have permission to disable FTS. Only logged in users with write permission are allowed to disable FTS.'), xhr.error_html) return error_dialog(_('Disabling FTS failed'), _('Disabling FTS failed. Click "Show details" for more information.'), xhr.error_html) library_data.fts_enabled = False info_dialog( _('Full text searching disabled'), _('Full text searching for this library has been disabled. In the future the entire' ' library will have to be re-indexed when re-enabling full text searching.'), on_close=def (): window.setTimeout(home) ) ajax(f'fts/disable', on_response, bypass_cache=True).send() def disable_fts(): question_dialog( _('Are you sure?'), _('Disabling full text search means that in the future the entire library will have to be' ' re-indexed to use full text search. Are you sure you want to proceed?'), def (yes): if yes: disable_fts_backend() ) def book_result_tile_clicked(ev): result_tile = ev.currentTarget bid = int(result_tile.dataset.bookId) results = current_fts_query.results formats = [] for x in results.results: if x.book_id is bid: formats.push(x.format) create_custom_dialog(result_tile.title, def (parent, close_modal): fmc = E.div( style='display: flex; flex-wrap: wrap; margin-top: 1ex' ) def open_format_and_close(book_id, fmt): open_format(book_id, fmt) close_modal() def reindex(book_id): close_modal() reindex_book(book_id) for fmt in formats: a = E.a(fmt, class_='blue-link', style='cursor: pointer; margin: 1ex; display: block', href='javascript: void(0)', onclick=open_format_and_close.bind(None, bid, fmt)) fmc.appendChild(a) parent.appendChild(E.div( _('Click one of the formats below to open the book at this search result (except PDF which will open at the start):'), fmc )) parent.appendChild(E.div( style='margin-top: 1ex', E.a(_('Open the details page for this book'), class_='blue-link', target='_blank', href=query_as_href({'book_id': str(bid)}, 'book_details')) )) parent.appendChild(E.div( style='margin-top: 1ex', E.a(_('Re-index this book'), class_='blue-link', href='javascript: void(0)', onclick=reindex.bind(None, bid)) )) ) def book_result_tile(book_id, title, authors): tile_height, img_max_width = '16ex', '12ex' img = create_image(book_id, THUMBNAIL_MAX_WIDTH, THUMBNAIL_MAX_HEIGHT, def (): pass;) img.style.maxHeight = tile_height img.style.maxWidth = img_max_width tooltip = (title) + ' ' + _('by') + ' ' + (authors) img.alt = _('Cover of') + ' ' + tooltip return E.div( onclick=book_result_tile_clicked, title=tooltip, data_book_id=book_id + '', data_snippets_needed='1', style=f'cursor: pointer; margin-bottom: 1ex; display:flex; height: {tile_height}; max-height: {tile_height}; width: 100%; align-items: stretch', E.div( style=f'margin-right: 1ex; width: {img_max_width}', img ), E.div( style=f'display:flex; flex-direction: column; height: 100%; overflow-y: auto', E.div(E.span(style='font-size: small; font-style: normal; font-weight: 600; opacity: 0.5;', _('loading'), '…'), class_='snippets_container'), ) ) def on_snippets_fetched(end_type, xhr, ev): if end_type is 'abort' or not showing_search_panel(): return if end_type is not 'load': return error_dialog(_('Failed to search'), _('The search failed. Click "Show details" for more information.'), xhr.error_html) container = component('results') if not container: return try: results = JSON.parse(xhr.responseText) except Exception as err: return error_dialog(_('Server error'), _('Failed to parse search response from server.'), err + '') if results.query_id is not current_fts_query.query_id: return if not current_fts_query.results.snippets: current_fts_query.results.snippets = {} Object.assign(current_fts_query.results.snippets, results.snippets) show_snippets(results.snippets) fetch_snippets() def render_text(parent, text): in_highlighted = False while text.length > 0: q = '\x1e' if in_highlighted else '\x1c' idx = text.indexOf(q) if idx < 0: idx = text.length chunk = text[:idx] text = text[idx + 1:] if in_highlighted: parent.append(E.span(class_='fts-highlight-match', chunk)) in_highlighted = False else: parent.append(E.span(chunk)) in_highlighted = True def show_snippets(snippets): container = component('results') for book_id in Object.keys(snippets): c = container.querySelector(f'[data-book-id="{book_id}"]') if c: v'delete c.dataset.snippetsNeeded' s = c.querySelector('.snippets_container') clear(s) for x in snippets[book_id]: f = ' '.join(x.formats) e = E.div(E.code( style='border: solid 1px currentColor; border-radius: 6px; padding: 0 4px; font-size: smaller', data_formats=f, f) ) e.appendChild(E.span(' ')) render_text(e, x.text) s.appendChild(e) def fetch_snippets(): container = component('results') if not container: return ids = [] for x in container.querySelectorAll('[data-snippets-needed="1"]'): book_id = int(x.dataset.bookId) ids.push(book_id) if ids.length > 1: break if ids.length < 1: return ids = ','.join(ids) q = {} Object.assign(q, current_fts_query) q.results = v'undefined' xhr = ajax(f'fts/snippets/{ids}', on_snippets_fetched, query=q, bypass_cache=True) xhr.send() def show_initial_results(): container = component('results') if not container: return clear(container) results = current_fts_query.results left, total = results.indexing_status['left'], results.indexing_status['total'] if left > 0: pc = int(((total - left) / total) * 100) container.appendChild(E.div( style='margin-top: 0.5ex', E.span(_('WARNING:'), style='color: red; font-weight: bold'), '\xa0', _('Indexing of library only {}% complete, search results may be incomplete.').format(pc) )) rc = E.div(style='margin-top: 0.5ex') container.appendChild(rc) mm = results.metadata seen = {} for r in results.results: bid = r['book_id'] m = mm[bid] if not seen[bid]: rc.appendChild(book_result_tile(bid, m['title'], m['authors'])) seen[bid] = rc.lastChild rc.appendChild(E.hr()) if results.results.length < 1: rc.appendChild(E.div(_('No matches found'))) fetch_snippets() def show_panel(visible): c = component(visible) if c: x = c.parentNode.firstChild while x: if x.nodeType is 1 and x.dataset.component: x.style.display = 'block' if x is c else 'none' x = x.nextSibling def show_search_panel(): show_panel('search') apply_search_panel_state() def show_index_panel(): show_panel('index') def init(container_id): nonlocal overall_container_id overall_container_id = container_id container = document.getElementById(container_id) create_top_bar(container, title=_('Search text of books'), icon='back') container.appendChild(E.div(data_component='index')) container.appendChild(E.div( data_component='search', style='padding:1ex 1em; margin-top: 0.5ex;' )) build_search_page() q = get_current_query() if not q.fts_panel or q.fts_panel is 'search': show_search_panel() elif q.fts_panel is 'index': show_index_panel() def set_panel_handlers(): set_panel_handler('fts', init)