docvert-web.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import sys
import io
import uuid
import os.path
import socket
import optparse
import cgi
docvert_root = os.path.dirname(os.path.abspath(__file__))
inbuilt_bottle_path = os.path.join(docvert_root, 'lib/bottle')
try:
    import bottle
    if not hasattr(bottle, 'static_file'):
        message = "Notice: Old version of Bottle at %s, instead using bundled version at %s%sbottle.py" % (bottle.__file__, inbuilt_bottle_path, os.sep)
        print(message)
        raise ImportError(message)
except ImportError as exception:
    try:
        sys.path.insert(0, inbuilt_bottle_path)
        try:
            reload(bottle)
        except NameError:
            import bottle
    except ImportError:
        sys.stderr.write("Error: Unable to find Bottle libraries in %s. Exiting...\n" % sys.path)
        sys.exit(0)
import lib.bottlesession.bottlesession
bottle.debug(True)
import core.docvert
import core.docvert_storage
import core.docvert_exception
import core.document_type

# START DEFAULT CONFIG
theme='default'
host='localhost'
port=8080
# END CONFIG
parser = optparse.OptionParser()
parser.add_option("-p", "--port", dest="port", help="Port to run on", type="int")
parser.add_option("-H", "--host", dest="host", help="Hostname or IP run on", type="str")
(options, args) = parser.parse_args()
if options.port:
    port = options.port
if options.host:
    host = options.host
theme_directory='%s/core/web_service_themes' % docvert_root
bottle.TEMPLATE_PATH.append('%s/%s' % (theme_directory, theme))

# URL mappings

@bottle.route('/index', method='GET')
@bottle.route('/', method='GET')
@bottle.view('index')
def index():
    return dict(list(core.docvert.get_all_pipelines(False).items()) + list({"libreOfficeStatus": core.docvert_libreoffice.checkLibreOfficeStatus()}.items()) )

@bottle.route('/static/:path#.*#', method='GET')
def static(path=''):
    return bottle.static_file(path, root=theme_directory)

@bottle.route('/lib/:path#.*#', method='GET')
def libstatic(path=None):
    return bottle.static_file(path, root='%s/lib' % docvert_root)

@bottle.route('/web-service.php', method='POST') #for legacy Docvert support
@bottle.route('/web-service', method='POST')
@bottle.view('web-service')
def webservice():
    files = dict()
    first_document_id = None
    there_was_at_least_one_thing_uploaded = False
    for key, item in bottle.request.files.items():
        there_was_at_least_one_thing_uploaded = True
        items = bottle.request.files.getall(key)
        for field_storage in items:
            filename = field_storage.filename
            unique = 1
            if filename in files and files[filename].getvalue() == field_storage.value: #remove same file uploaded multiple times
                continue
            while filename in files:
                filename = field_storage.filename + str(unique)
                unique += 1
            files[filename] = io.BytesIO(field_storage.value)
    pipeline_id = bottle.request.POST.get('pipeline')
    if pipeline_id.startswith('autopipeline:'): #Docvert 4.x
        pipeline_id = pipeline_id[len('autopipeline:'):]
    auto_pipeline_id = None
    if bottle.request.POST.get('break_up_pages_ui_version'):
        if bottle.request.POST.get('break_up_pages'):
            auto_pipeline_id = bottle.request.POST.get('autopipeline')
        if auto_pipeline_id is None:
            pipelines = list(core.docvert.get_all_pipelines().items())
            for pipelinetype_key, pipelinetype_value in pipelines:
                if pipelinetype_key == "auto_pipelines":
                    for pipeline in pipelinetype_value:
                        if "nothing" in pipeline["id"].lower():
                            auto_pipeline_id = pipeline["id"]
    else:
        auto_pipeline_id = bottle.request.POST.get('autopipeline')
    docvert_4_default = '.default'
    if auto_pipeline_id and auto_pipeline_id.endswith(docvert_4_default):
        auto_pipeline_id = auto_pipeline_id[0:-len(docvert_4_default)]
    after_conversion = bottle.request.POST.get('afterconversion')
    urls = bottle.request.POST.getall('upload_web[]')
    if len(urls) == 1 and urls[0] == '':
        urls = list()
    else:
        urls = set(urls)
    response = None
    if there_was_at_least_one_thing_uploaded is False: #while we could have counted len(files) or len(urls) the logic around those is more complex, and I don't want to show this error unless there was genuinely no files uploaded
        bottle.response.content_type = "text/html"
        return '<!DOCTYPE html><html><body><h1>Error: No files were uploaded</h1><p>Known issues that can cause this:</p><ul><li>Permissions problem on the server or browser: Try ensuring that your upload file has all read permissions set.</li><li>Chrome/Chromium can sometimes cause file upload problems (some combination of Chrome/Bottle, it\'s not a Docvert-specific bug). Sorry, but Firefox seems to work.</li></ul><hr><a href="/">Try again?</a></body></html>'
    try:
        response = core.docvert.process_conversion(files, urls, pipeline_id, 'pipelines', auto_pipeline_id, suppress_errors=True)
    except core.docvert_exception.debug_exception as exception:
        bottle.response.content_type = exception.content_type
        return exception.data
    conversion_id = "%s" % uuid.uuid4()
    if after_conversion == "downloadZip" or after_conversion == "zip":
        bottle.response.content_type = 'application/zip'
        bottle.response.headers['Content-Disposition'] = 'attachment; filename="%s.zip"' % response.get_zip_name()
        return response.to_zip().getvalue()
    pipeline_summary = "%s (%s)" % (pipeline_id, auto_pipeline_id)
    session_manager = lib.bottlesession.bottlesession.PickleSession()
    session = session_manager.get_session()
    session[conversion_id] = response
    conversions_tabs = dict()
    first_document_url = "conversions/%s/%s/" % (conversion_id, response.default_document)
    for filename in list(files.keys()):
        thumbnail_path = "%s/thumbnail.png" % filename
        if thumbnail_path in response:
            thumbnail_path = None
        conversions_tabs[filename] = dict(friendly_name=response.get_friendly_name_if_available(filename), pipeline=pipeline_id, auto_pipeline=auto_pipeline_id, thumbnail_path=thumbnail_path)
    try:
        session_manager.save(session)
    except OSError as e:
        import traceback
        traceback.print_exc(file=sys.stdout)
        conversions_tabs = {'Session file problem': dict(friendly_name='Session file problem', pipeline=None, auto_pipeline=None, thumbnail_path=None) }
        first_document_url = "/bottle_session_file_problem"
    return dict(conversions=conversions_tabs, conversion_id=conversion_id, first_document_url=first_document_url)

@bottle.route('/favicon.ico', method='GET')
def favicon():
    return bottle.static_file('favicon.ico', root='%s/%s' % (theme_directory, theme))

@bottle.route('/bottle_session_file_problem', method='GET')
def bottle_session_file_problem():
    print('%s/lib/bottle' % docvert_root)
    return bottle.static_file('bottle_session_file_problem.html', root='%s/lib/bottle' % docvert_root)

@bottle.route('/conversions/:conversion_id/:path#.*#')
def conversion_static_file(conversion_id, path):
    session_manager = lib.bottlesession.bottlesession.PickleSession()
    session = session_manager.get_session()
    if conversion_id not in session: # They don't have authorisation
        raise bottle.HTTPError(code=404)
    filetypes = {".xml":"text/xml", ".html":"text/html", ".xhtml":"text/html", ".htm":"text/html", ".svg":"image/svg+xml", ".txt":"text/plain", ".png":"image/png", ".gif":"image/gif", ".bmp":"image/x-ms-bmp", ".jpg":"image/jpeg", ".jpe":"image/jpeg", ".jpeg":"image/jpeg", ".css":"text/css", ".js":"text/javascript", ".odt":"application/vnd.oasis.opendocument.text", ".odp":"application/vnd.oasis.opendocument.presentation", ".ods":"application/vnd.oasis.opendocument.spreadsheet", ".dbk":"application/docbook+xml"}
    if path not in session[conversion_id]: # They have authorisation but that exact path doesn't exist, try fallbacks
        fallbacks = ["index.html", "index.htm", "index.xml", "index.php", "default.htm", "default.html", "index.asp", "default.aspx", "index.aspx", "default.aspx", "index.txt", "index.odt", "default.odt", "index.dbk", "default.dbk"]
        valid_fallback_path = None
        separator = "/"
        if path.endswith("/"):
            separator = ""
        for fallback in fallbacks:
            fallback_path = path+separator+fallback
            if fallback_path in session[conversion_id]:
                valid_fallback_path = fallback_path
                break
        if valid_fallback_path is None:
            raise bottle.HTTPError(code=404)
        path = valid_fallback_path
        extension = os.path.splitext(path)[1]
        if extension == ".odt":
            bottle.response.content_type = filetypes[".html"]
            link_html = 'click here to download %s' % cgi.escape(os.path.basename(path))
            thumbnail_path = "%s/thumbnail.png" % path[0:path.rfind("/")]
            if thumbnail_path in session[conversion_id]:
                link_html = '<img src="thumbnail.png"><br>' + link_html
            return '<!DOCTYPE html><html><head><title>%s</title><style type="text/css">body{font-family:sans-serif;font-size:small} a{text-decoration:none} p{text-align:center} img{clear:both;border: solid 1px #cccccc}</style></head><body><p><a href="%s">%s</a></p></body></html>' % (
                cgi.escape(path),
                cgi.escape(os.path.basename(path)),
                link_html
            )
    extension = os.path.splitext(path)[1]
    if extension in filetypes:
        bottle.response.content_type = filetypes[extension]
    else:
        bottle.response.content_type = "text/plain"
    return session[conversion_id][path]

@bottle.route('/conversions-zip/:conversion_id')
def conversion_zip(conversion_id):
    session_manager = lib.bottlesession.bottlesession.PickleSession()
    session = session_manager.get_session()
    if conversion_id not in session: # They don't have authorisation
        raise bottle.HTTPError(code=404)
    bottle.response.content_type = 'application/zip'
    bottle.response.headers['Content-Disposition'] = 'attachment; filename="%s.zip"' % session[conversion_id].get_zip_name()
    return session[conversion_id].to_zip().getvalue()

@bottle.route('/libreoffice-status', method='GET')
def libreoffice_status():
    return bottle.json_dumps( {"libreoffice-status":core.docvert_libreoffice.checkLibreOfficeStatus()} )

@bottle.route('/tests', method='GET')
@bottle.view('tests')
def tests():
    return core.docvert.get_all_pipelines()

@bottle.route('/web-service/tests/:test_id', method='GET')
def web_service_tests(test_id):
    suppress_error = bottle.request.GET.get('suppress_error') == "true"
    storage = core.docvert_storage.storage_memory_based()
    error_message = None
    if suppress_error:
        try:
            core.docvert.process_pipeline(None, test_id, "tests", None, storage)
        except Exception as exception:
            bottle.response.content_type = "text/plain"
            class_name = "%s" % type(exception).__name__
            return bottle.json_dumps([{"status":"fail", "message": "Unable to run tests due to exception. <%s> %s" % (class_name, exception)}])
    else:
        try:
            core.docvert.process_pipeline(None, test_id, "tests", None, storage)
        except (core.docvert_exception.debug_exception, core.docvert_exception.debug_xml_exception) as exception:
            bottle.response.content_type = exception.content_type
            return exception.data
    return bottle.json_dumps(storage.tests)

@bottle.route('/tests/', method='GET')
def tests_wrongdir():
    bottle.redirect('/tests')

@bottle.route('/3rdparty/sscdocapi')
def third_party_sscdocapi():
    return bottle.static_file('sscdocapi.html', root='%s/core/3rd-party/' % docvert_root)    

try:
    bottle.run(host=host, port=port, quiet=False)
except socket.error as e:
    if 'address already in use' in str(e).lower():
        print('ERROR: %s:%i already in use.\nTry another port? Use command line parameter -H HOST or -p PORT to change it.' % (host, port))
    else:
        raise