Start work on FTS support for calibredb

src/calibre/db/cli/cmd_fts_index.py

@@ -0,0 +1,130 @@
+#!/usr/bin/env python
+# License: GPLv3 Copyright: 2017, Kovid Goyal <kovid at kovidgoyal.net>
+
+import sys
+
+version = 0  # change this if you change signature of implementation()
+
+
+def implementation(db, notify_changes, action, adata=None):
+    if action == 'status':
+        if db.is_fts_enabled():
+            l, t = db.fts_indexing_progress()
+            return {'enabled': True, 'left': l, 'total': t}
+        return {'enabled': False, 'left': -1, 'total': -1}
+
+    if action == 'enable':
+        if not db.is_fts_enabled():
+            db.enable_fts()
+        l, t = db.fts_indexing_progress()
+        return {'enabled': True, 'left': l, 'total': t}
+
+    if action == 'disable':
+        if db.is_fts_enabled():
+            db.enable_fts(enabled=False)
+        return
+
+
+def option_parser(get_parser, args):
+    parser = get_parser(
+        _(
+            '''\
+%prog fts_index [options] enable/disable/status/reindex
+
+Control the fts indexing process.
+'''
+    ))
+    parser.add_option(
+        '--wait-for-completion',
+        default=False,
+        action='store_true',
+        help=_('Wait till all books are indexed, showing indexing progress periodically')
+    )
+    return parser
+
+
+def run_job(dbctx, which, adata=None):
+    try:
+        return dbctx.run('fts_index', which, adata)
+    except Exception as e:
+        if getattr(e, 'suppress_traceback', False):
+            raise SystemExit(str(e))
+        raise
+
+
+def local_wait_for_completion(db):
+    from calibre.db.listeners import EventType
+    from queue import Queue
+
+    db.fts_indexing_sleep_time = 0.1
+    q = Queue()
+
+    def listen(event_type, library_id, event_data):
+        if event_type is EventType.indexing_progress_changed:
+            print(1111111, event_data)
+            q.put(event_data)
+
+    def show_progress(left, total):
+        print('\r' + _('{} of {} book files left to index').format(left, total), flush=True, end='')
+
+    db.add_listener(listen)
+    l, t = db.fts_indexing_progress()
+    if l < 1:
+        return
+    show_progress(l, t)
+
+    while True:
+        l, t = q.get()
+        if l < 1:
+            return
+        show_progress(l, t)
+
+
+def main(opts, args, dbctx):
+    if len(args) < 1:
+        dbctx.option_parser.print_help()
+        raise SystemExit(_('Error: You must specify the indexing action'))
+    action = args[0]
+
+    if action == 'status':
+        s = run_job(dbctx, 'status')
+        if s['enabled']:
+            print(_('FTS Indexing is enabled'))
+            print(_('{0} of {1} books files remain to be indexed').format(s['left'], s['total']))
+        else:
+            print(_('FTS Indexing is disabled'))
+            raise SystemExit(2)
+
+    if action == 'enable':
+        s = run_job(dbctx, 'enable')
+        print(_('FTS indexing has been enabled'))
+        print(_('{0} of {1} books files remain to be indexed').format(s['left'], s['total']))
+
+    if action == 'disable':
+        print(_('Disabling indexing will mean that all books will have to be re-checked when re-enabling indexing. Are you sure?'))
+        while True:
+            try:
+                q = input(_('Type {} to proceed, anything else to abort').format('"disable"') + ': ')
+            except KeyboardInterrupt:
+                sys.excepthook = lambda *a: None
+                raise
+            if q in ('disable', '"disable"'):
+                break
+            else:
+                return 0
+        run_job(dbctx, 'disable')
+        print(_('FTS indexing has been disabled'))
+        return 0
+
+    if opts.wait_for_completion:
+        print(_('Waiting for FTS indexing to complete...'))
+        try:
+            if dbctx.is_remote:
+                raise NotImplementedError('TODO: Implement waiting for completion via polling')
+            else:
+                local_wait_for_completion(dbctx.db.new_api)
+        except KeyboardInterrupt:
+            sys.excepthook = lambda *a: None
+            raise
+        print(_('All books indexed!'))
+    return 0

src/calibre/db/cli/main.py

@@ -21,7 +21,7 @@ COMMANDS = (
     'set_metadata', 'export', 'catalog', 'saved_searches', 'add_custom_column',
     'custom_columns', 'remove_custom_column', 'set_custom', 'restore_database',
     'check_library', 'list_categories', 'backup_metadata', 'clone', 'embed_metadata',
-    'search'
+    'search', 'fts_index'
 )
 
 
@@ -126,7 +126,8 @@ def read_credentials(opts):
 
 class DBCtx:
 
-    def __init__(self, opts):
+    def __init__(self, opts, option_parser):
+        self.option_parser = option_parser
         self.library_path = opts.library_path or prefs['library_path']
         self.timeout = opts.timeout
         self.url = None
@@ -243,11 +244,12 @@ def main(args=sys.argv):
             break
     else:
         parser.print_help()
-        return 1
+        print()
+        raise SystemExit(_('Error: You must specify a command from the list above'))
     del args[i]
     parser = option_parser_for(cmd, args[1:])()
     opts, args = parser.parse_args(args)
-    return run_cmd(cmd, opts, args[1:], DBCtx(opts))
+    return run_cmd(cmd, opts, args[1:], DBCtx(opts, parser))
 
 
 if __name__ == '__main__':