openquake.server package

Subpackages

• openquake.server.db package
  • openquake.server.db.actions module
  • openquake.server.db.upgrade_manager module
  • Module contents
• openquake.server.v1 package
  • openquake.server.v1.calc_urls module
  • Module contents

Submodules

openquake.server.dbserver module

class openquake.server.dbserver.DbServer(db, address, num_workers=5)

Bases: object

A server collecting the received commands into a queue

dworker(sock)

start()

Start database worker threads

stop()

Stop the DbServer

openquake.server.dbserver.check_foreign()

Check if we the DbServer is the right one

openquake.server.dbserver.different_paths(path1, path2)

openquake.server.dbserver.ensure_on()

Start the DbServer if it is off

openquake.server.dbserver.get_status(address=None)

Check if the DbServer is up.

Parameters

address – pair (hostname, port)

Returns

‘running’ or ‘not-running’

openquake.server.dbserver.run_server(dbhostport=None, loglevel='WARN', foreground=False)

Run the DbServer on the given database file and port. If not given, use the settings in openquake.cfg.

openquake.server.manage module

openquake.server.manage.fakedbcmd(action, *args)

A dispatcher to the database server.

Parameters

• action – database action to perform

• args – arguments

openquake.server.middleware module

class openquake.server.middleware.LoginRequiredMiddleware(get_response)

Bases: object

Middleware that requires a user to be authenticated to view any page other than LOGIN_URL. Exemptions to this requirement can be specified in settings via a list of regular expressions in LOGIN_EXEMPT_URLS.

Requires authentication middleware and template context processors to be loaded. You’ll get an error if they aren’t.

openquake.server.settings module

openquake.server.urls module

openquake.server.utils module

openquake.server.utils.check_webserver_running(url='http://localhost:8800', max_retries=30)

Returns True if a given URL is responding within a given timeout.

openquake.server.utils.get_acl_on(request)

Returns True if ACL should be honorated, returns otherwise False.

openquake.server.utils.get_user(request)

Returns the users from request if authentication is enabled, otherwise returns the default user (from settings, or as reported by the OS).

openquake.server.utils.get_valid_users(request)

” Returns a list of users based on groups membership. Returns a list made of a single user when it is not member of any group.

openquake.server.utils.is_superuser(request)

Without authentication (settings.LOCKDOW is false) every user is considered a superuser, otherwise look at the attribute request.user.is_superuser.

openquake.server.utils.oq_server_context_processor(request)

A custom context processor which allows injection of additional context variables.

openquake.server.utils.user_has_permission(request, owner)

Returns True if user coming from the request has the permission to view a resource, returns false otherwise.

openquake.server.views module

openquake.server.views.DEFAULT_EXPORT_TYPE = 'xml'

For exporting calculation outputs, the client can request a specific format (xml, geojson, csv, etc.). If the client does not specify give them (NRML) XML by default.

openquake.server.views.aelo_callback(job_id, job_owner_email, outputs_uri, inputs, exc=None)

openquake.server.views.aelo_run(request, *args, **kwargs)

openquake.server.views.ajax_login(request, *args, **kwargs)

openquake.server.views.ajax_logout(request, *args, **kwargs)

openquake.server.views.calc(request, *args, **kwargs)

openquake.server.views.calc_abort(request, *args, **kwargs)

openquake.server.views.calc_datastore(request, *args, **kwargs)

openquake.server.views.calc_list(request, *args, **kwargs)

openquake.server.views.calc_log(request, *args, **kwargs)

openquake.server.views.calc_log_size(request, *args, **kwargs)

openquake.server.views.calc_remove(request, *args, **kwargs)

openquake.server.views.calc_result(request, *args, **kwargs)

openquake.server.views.calc_results(request, *args, **kwargs)

openquake.server.views.calc_run(request, *args, **kwargs)

openquake.server.views.calc_traceback(request, *args, **kwargs)

openquake.server.views.cross_domain_ajax(func)

openquake.server.views.extract(request, *args, **kwargs)

openquake.server.views.get_available_gsims(request, *args, **kwargs)

openquake.server.views.get_engine_latest_version(request, *args, **kwargs)

openquake.server.views.get_engine_version(request, *args, **kwargs)

openquake.server.views.get_ini_defaults(request, *args, **kwargs)

openquake.server.views.hmap_png(request, *args, **kwargs)

openquake.server.views.license(request, **kwargs)

openquake.server.views.log_to_json(log)

Convert a log record into a list of strings

openquake.server.views.on_same_fs(request, *args, **kwargs)

openquake.server.views.save_pik(job, dirname)

Save a LogContext object in pickled format; returns the path to it

openquake.server.views.store(request_files, ini, calc_id)

Store the uploaded files in calc_dir and select the job file by looking at the .ini extension.

Returns

full path of the ini file

openquake.server.views.submit_job(request_files, ini, username, hc_id)

Create a job object from the given files and run it in a new process.

Returns

a job ID

openquake.server.views.validate_nrml(request, *args, **kwargs)

openquake.server.views.validate_zip(request, *args, **kwargs)

openquake.server.views.web_engine(request, **kwargs)

openquake.server.views.web_engine_get_outputs(request, *args, **kwargs)

openquake.server.wsgi module

Module contents