OpenSlides/server/openslides/__main__.py

271 lines
8.5 KiB
Python
Raw Normal View History

#!/usr/bin/env python
import os
import sys
2018-08-22 22:00:08 +02:00
from typing import Dict
import django
from django.core.management import call_command, execute_from_command_line
import openslides
2018-02-06 08:04:31 +01:00
from openslides.utils.arguments import arguments
from openslides.utils.main import (
2015-01-16 14:18:34 +01:00
ExceptionArgumentParser,
UnknownCommand,
get_default_settings_dir,
get_local_settings_dir,
is_local_installation,
open_browser,
setup_django_settings_module,
write_settings,
)
2019-08-20 12:00:54 +02:00
from openslides.utils.startup import run_startup_hooks
def main():
"""
Main entrance to OpenSlides.
"""
2015-01-16 14:18:34 +01:00
parser = get_parser()
try:
known_args, unknown_args = parser.parse_known_args()
except UnknownCommand:
unknown_command = True
else:
2015-01-16 14:18:34 +01:00
unknown_command = False
2015-01-16 14:18:34 +01:00
if unknown_command:
# Run a command, that is defined by the django management api
local_installation = is_local_installation()
setup_django_settings_module(local_installation=local_installation)
2015-01-16 14:18:34 +01:00
execute_from_command_line(sys.argv)
else:
# Check for unknown_args.
if unknown_args:
2019-01-12 23:01:42 +01:00
joined_unknown_args = " ".join(unknown_args)
parser.error(f"Unknown arguments {joined_unknown_args}")
# Save arguments, if one wants to access them later.
2018-02-06 08:04:31 +01:00
arguments.set_arguments(known_args)
2015-01-16 14:18:34 +01:00
# Run a command that is defined here
# These are commands that can not rely on an existing settings
known_args.callback(known_args)
2015-01-16 14:18:34 +01:00
def get_parser():
"""
2015-01-16 14:18:34 +01:00
Parses all command line arguments.
"""
if len(sys.argv) == 1:
# Use start subcommand if called by openslides console script without
# any other arguments.
2019-01-06 16:22:33 +01:00
sys.argv.append("start")
# Init parser
2019-01-06 16:22:33 +01:00
description = "Start script for OpenSlides."
if "manage.py" not in sys.argv[0]:
description += """
If it is called without any argument, this will be treated as
if it is called with the 'start' subcommand. That means
OpenSlides will setup default settings and database, start the
webserver, launch the default web browser and open the
webinterface.
"""
epilog = """
There are some more subcommands available. They belong to Django's
command-line utility for administrative tasks. Type '%(prog)s help'
(without the two hyphen-minus characters) to list them all. Type
'%(prog)s help <subcommand>' for help on a specific subcommand.
"""
2019-01-06 16:22:33 +01:00
parser = ExceptionArgumentParser(description=description, epilog=epilog)
# Add version argument
parser.add_argument(
2019-01-06 16:22:33 +01:00
"--version",
action="version",
version=openslides.__version__,
2019-01-06 16:22:33 +01:00
help="Show version number and exit.",
)
# Init subparsers
subparsers = parser.add_subparsers(
2019-01-06 16:22:33 +01:00
dest="subcommand",
title="Available subcommands",
2013-11-23 18:49:51 +01:00
description="Type '%s <subcommand> --help' for help on a "
2019-01-06 16:22:33 +01:00
"specific subcommand." % parser.prog, # type: ignore
help="You can choose only one subcommand at once.",
metavar="",
)
# Subcommand start
start_help = (
2019-01-06 16:22:33 +01:00
"Setup settings and database, start webserver, launch the "
"default web browser and open the webinterface. The environment "
"variable DJANGO_SETTINGS_MODULE is ignored."
)
subcommand_start = subparsers.add_parser(
2019-01-06 16:22:33 +01:00
"start", description=start_help, help=start_help
)
subcommand_start.set_defaults(callback=start)
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--no-browser",
action="store_true",
help="Do not launch the default web browser.",
)
2018-01-12 08:40:15 +01:00
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--debug-email",
action="store_true",
help="Change the email backend to console output.",
)
2018-02-06 08:04:31 +01:00
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--no-template-caching",
action="store_true",
2018-02-06 08:04:31 +01:00
default=False,
2019-01-06 16:22:33 +01:00
help="Disables caching of templates.",
)
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--host",
action="store",
default="0.0.0.0",
help="IP address to listen on. Default is 0.0.0.0.",
)
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--port",
action="store",
default="8000",
help="Port to listen on. Default is 8000.",
)
2015-01-16 14:18:34 +01:00
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--settings_dir", action="store", default=None, help="The settings directory."
)
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--settings_filename",
action="store",
default="settings.py",
help="The used settings file name. The file is created, if it does not exist.",
)
2015-01-16 14:18:34 +01:00
subcommand_start.add_argument(
2019-01-06 16:22:33 +01:00
"--local-installation",
action="store_true",
help="Store settings and user files in a local directory.",
)
2015-01-16 14:18:34 +01:00
# Subcommand createsettings
2019-01-06 16:22:33 +01:00
createsettings_help = "Creates the settings file."
2015-01-16 14:18:34 +01:00
subcommand_createsettings = subparsers.add_parser(
2019-01-06 16:22:33 +01:00
"createsettings", description=createsettings_help, help=createsettings_help
)
2015-01-16 14:18:34 +01:00
subcommand_createsettings.set_defaults(callback=createsettings)
subcommand_createsettings.add_argument(
2019-01-06 16:22:33 +01:00
"--settings_dir",
action="store",
2015-01-16 14:18:34 +01:00
default=None,
2019-01-06 16:22:33 +01:00
help="The used settings file directory. All settings files are created, even if they exist.",
)
2018-01-26 09:35:49 +01:00
subcommand_createsettings.add_argument(
2019-01-06 16:22:33 +01:00
"--settings_filename",
action="store",
default="settings.py",
help="The used settings file name. The file is created, if it does not exist.",
)
2015-01-16 14:18:34 +01:00
subcommand_createsettings.add_argument(
2019-01-06 16:22:33 +01:00
"--local-installation",
action="store_true",
help="Store settings and user files in a local directory.",
)
# Help text for several Django subcommands
django_subcommands = (
2019-01-06 16:22:33 +01:00
("backupdb", "Backups the SQLite3 database."),
("createsuperuser", "Creates or resets the admin user."),
("migrate", "Updates database schema."),
2019-01-20 10:05:50 +01:00
("runserver", "Starts the built-in webserver."),
)
for django_subcommand, help_text in django_subcommands:
2017-08-24 12:26:55 +02:00
subparsers._choices_actions.append( # type: ignore
subparsers._ChoicesPseudoAction( # type: ignore
2019-01-06 16:22:33 +01:00
django_subcommand, (), help_text
)
)
2015-01-16 14:18:34 +01:00
return parser
2015-01-16 14:18:34 +01:00
def start(args):
"""
2015-01-16 14:18:34 +01:00
Starts OpenSlides: Runs migrations and runs runserver.
"""
settings_dir = args.settings_dir
settings_filename = args.settings_filename
local_installation = is_local_installation()
if settings_dir is None:
if local_installation:
settings_dir = get_local_settings_dir()
2015-01-16 14:18:34 +01:00
else:
settings_dir = get_default_settings_dir()
# Write django settings if it does not exists.
settings_path = os.path.join(settings_dir, settings_filename)
2015-01-16 14:18:34 +01:00
if not os.path.isfile(settings_path):
createsettings(args)
2015-01-16 14:18:34 +01:00
# Set the django setting module and run migrations
# A manual given environment variable will be overwritten
setup_django_settings_module(settings_path, local_installation=local_installation)
django.setup()
from django.conf import settings
2018-01-12 08:40:15 +01:00
if args.debug_email:
2019-01-06 16:22:33 +01:00
settings.EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
2018-01-12 08:40:15 +01:00
# Migrate database
2019-01-06 16:22:33 +01:00
call_command("migrate")
# Open the browser
if not args.no_browser:
open_browser(args.host, args.port)
2019-08-20 12:00:54 +02:00
run_startup_hooks()
2019-01-20 10:05:50 +01:00
# Start the built-in webserver
#
# Use flag --noreload to tell Django not to reload the server.
# Therefor we have to set the keyword noreload to False because Django
# parses this directly to the use_reloader keyword.
#
# Use flag --insecure to serve static files even if DEBUG is False.
call_command(
2019-01-06 16:22:33 +01:00
"runserver",
2019-01-12 23:01:42 +01:00
f"{args.host}:{args.port}",
noreload=False, # Means True, see above.
insecure=True,
)
2015-01-16 14:18:34 +01:00
def createsettings(args):
"""
2015-01-16 14:18:34 +01:00
Creates settings for OpenSlides.
"""
settings_dir = args.settings_dir
local_installation = is_local_installation()
2018-08-22 22:00:08 +02:00
context: Dict[str, str] = {}
if local_installation:
if settings_dir is None:
settings_dir = get_local_settings_dir()
2015-01-16 14:18:34 +01:00
context = {
2019-01-06 16:22:33 +01:00
"openslides_user_data_dir": repr(
os.path.join(os.getcwd(), "personal_data", "var")
),
"debug": "True",
}
settings_path = write_settings(settings_dir, args.settings_filename, **context)
2019-01-12 23:01:42 +01:00
print(f"Settings created at {settings_path}")
if __name__ == "__main__":
sys.exit(main())