mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2024-11-30 12:33:52 -06:00
f195b18f2d
Ship the web code using server mode with appropriate paths by default and enable the runtime to override the mode, and force into desktop changing the appropriate paths to user-specific ones. Note that this change will likely cause more advanced users to have to tweak configs. RPMs will also need changes to create /var/lib/pgadmin and /var/log/pgadmin, owned by the webserver account.
150 lines
5.2 KiB
Python
150 lines
5.2 KiB
Python
##########################################################################
|
|
#
|
|
# pgAdmin 4 - PostgreSQL Tools
|
|
#
|
|
# Copyright (C) 2013 - 2017, The pgAdmin Development Team
|
|
# This software is released under the PostgreSQL Licence
|
|
#
|
|
##########################################################################
|
|
|
|
"""This is the main application entry point for pgAdmin 4. If running on
|
|
a webserver, this will provide the WSGI interface, otherwise, we're going
|
|
to start a web server."""
|
|
|
|
import os
|
|
import sys
|
|
|
|
if sys.version_info[0] >= 3:
|
|
import builtins
|
|
else:
|
|
import __builtin__ as builtins
|
|
|
|
# We need to include the root directory in sys.path to ensure that we can
|
|
# find everything we need when running in the standalone runtime.
|
|
root = os.path.dirname(os.path.realpath(__file__))
|
|
if sys.path[0] != root:
|
|
sys.path.insert(0, root)
|
|
|
|
# Grab the SERVER_MODE if it's been set by the runtime
|
|
if 'SERVER_MODE' in globals():
|
|
builtins.SERVER_MODE = globals()['SERVER_MODE']
|
|
else:
|
|
builtins.SERVER_MODE = None
|
|
|
|
import config
|
|
from pgadmin import create_app
|
|
from pgadmin.utils import u, fs_encoding, file_quote
|
|
|
|
if config.DEBUG:
|
|
from pgadmin.utils.javascript.javascript_bundler import JavascriptBundler, JsState
|
|
|
|
# Get the config database schema version. We store this in pgadmin.model
|
|
# as it turns out that putting it in the config files isn't a great idea
|
|
from pgadmin.model import SCHEMA_VERSION
|
|
config.SETTINGS_SCHEMA_VERSION = SCHEMA_VERSION
|
|
|
|
##########################################################################
|
|
# Sanity checks
|
|
##########################################################################
|
|
|
|
# Check if the database exists. If it does not, create it.
|
|
if not os.path.isfile(config.SQLITE_PATH):
|
|
setupfile = os.path.join(
|
|
os.path.dirname(os.path.realpath(u(__file__, fs_encoding))), u'setup.py'
|
|
)
|
|
exec(open(file_quote(setupfile), 'r').read())
|
|
|
|
##########################################################################
|
|
# Server startup
|
|
##########################################################################
|
|
|
|
# Build Javascript files
|
|
if config.DEBUG:
|
|
javascriptBundler = JavascriptBundler()
|
|
javascriptBundler.bundle()
|
|
|
|
# Create the app!
|
|
app = create_app()
|
|
|
|
if config.DEBUG:
|
|
app.debug = True
|
|
else:
|
|
app.debug = False
|
|
|
|
# respond to JS
|
|
if config.DEBUG:
|
|
if javascriptBundler.report() == JsState.NONE:
|
|
app.logger.error("Unable to generate javascript")
|
|
app.logger.error("To run the app ensure that yarn install command runs successfully")
|
|
raise Exception("No generated javascript, aborting")
|
|
|
|
# Start the web server. The port number should have already been set by the
|
|
# runtime if we're running in desktop mode, otherwise we'll just use the
|
|
# Flask default.
|
|
PGADMIN_RUNTIME = False
|
|
if 'PGADMIN_PORT' in globals():
|
|
app.logger.debug('Running under the desktop runtime, port: %s',
|
|
globals()['PGADMIN_PORT'])
|
|
server_port = int(globals()['PGADMIN_PORT'])
|
|
PGADMIN_RUNTIME = True
|
|
elif 'PGADMIN_PORT' in os.environ:
|
|
port = os.environ['PGADMIN_PORT']
|
|
app.logger.debug(
|
|
'Not running under the desktop runtime, port: %s',
|
|
port)
|
|
server_port = int(port)
|
|
else:
|
|
app.logger.debug(
|
|
'Not running under the desktop runtime, port: %s',
|
|
config.DEFAULT_SERVER_PORT)
|
|
server_port = config.DEFAULT_SERVER_PORT
|
|
|
|
# Let the application save the status about the runtime for using it later.
|
|
app.PGADMIN_RUNTIME = PGADMIN_RUNTIME
|
|
|
|
# Set the key if appropriate
|
|
if 'PGADMIN_KEY' in globals():
|
|
app.PGADMIN_KEY = globals()['PGADMIN_KEY']
|
|
app.logger.debug("Desktop security key: %s" % app.PGADMIN_KEY)
|
|
else:
|
|
app.PGADMIN_KEY = ''
|
|
|
|
# Output a startup message if we're not under the runtime and startup.
|
|
# If we're under WSGI, we don't need to worry about this
|
|
if __name__ == '__main__':
|
|
if not PGADMIN_RUNTIME:
|
|
print("Starting %s. Please navigate to http://%s:%d in your browser." %
|
|
(config.APP_NAME, config.DEFAULT_SERVER, server_port))
|
|
sys.stdout.flush()
|
|
else:
|
|
# For unknown reason the Qt runtime does not pass the environment
|
|
# variables (i.e. PYTHONHOME, and PYTHONPATH), to the Python
|
|
# sub-processes, leading to failures executing background processes.
|
|
#
|
|
# This has been observed only on windows. On *nix systems, it is likely
|
|
# picking the system python environment, which is good enough to run
|
|
# the process-executor.
|
|
#
|
|
# Setting PYTHONHOME launch them properly.
|
|
from pgadmin.utils import IS_WIN
|
|
if IS_WIN:
|
|
os.environ['PYTHONHOME'] = sys.prefix
|
|
|
|
# Initialize Flask service only once
|
|
# If `WERKZEUG_RUN_MAIN` is None, i.e: app is initializing for first time
|
|
# so set `use_reloader` = False, thus reload won't call.
|
|
# Reference:
|
|
# https://github.com/pallets/werkzeug/issues/220#issuecomment-11176538
|
|
try:
|
|
app.run(
|
|
host=config.DEFAULT_SERVER,
|
|
port=server_port,
|
|
use_reloader=(
|
|
(not PGADMIN_RUNTIME) and app.debug
|
|
and os.environ.get("WERKZEUG_RUN_MAIN") is not None
|
|
),
|
|
threaded=config.THREADED_MODE
|
|
)
|
|
except IOError:
|
|
app.logger.error("Error starting the app server: %s", sys.exc_info())
|