Source code for openquake.commands.webui

# -*- coding: utf-8 -*-
# vim: tabstop=4 shiftwidth=4 softtabstop=4
#
# Copyright (C) 2016-2024 GEM Foundation
#
# OpenQuake is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# OpenQuake is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with OpenQuake.  If not, see <http://www.gnu.org/licenses/>.

import os
import sys
import subprocess
import webbrowser

from openquake.baselib import config, general
from openquake.server import dbserver, db
from openquake.server.utils import check_webserver_running

commands = ['start']

def runserver(hostport=None, skip_browser=False):
    args = [sys.executable, '-m', 'openquake.server.manage', 'runserver']
    # the reload functionality of the Django development server interferes
    # with SIGCHLD and causes zombies, thus it is disabled
    args.append('--noreload')
    if hostport:
        args.append(hostport)
    p = subprocess.Popen(args)
    if not skip_browser:
        url = 'http://' + hostport
        if check_webserver_running(url):
            webbrowser.open(url)
    p.wait()
    if p.returncode != 0:
        sys.exit(p.returncode)


def main(cmd, hostport='127.0.0.1:8800', skip_browser: bool = False):
    """
    Start the webui server in foreground. Other webui commands can be launched
    after activating the openquake virtual environment, using Django’s
    command-line utility for administrative tasks, e.g.:
    manage.py <command> [options]
    """
    dbpath = os.path.realpath(os.path.expanduser(config.dbserver.file))
    if os.path.isfile(dbpath) and not os.access(dbpath, os.W_OK):
        sys.exit('This command must be run by the proper user: '
                 'see the documentation for details')
    dbserver.ensure_on()  # start the dbserver in a subprocess
    # reset any computation left in the 'executing' state
    db.actions.reset_is_running(dbserver.db)
    print('Starting, using version %s' % general.engine_version())
    runserver(hostport, skip_browser)


main.cmd = dict(help='webui command', choices=commands)
main.hostport = 'a string of the form <hostname:port>'
main.skip_browser = 'do not automatically open the browser'