Website Module

The website module uses Tornado, a fast and scalable python web server.

There are three groups of handlers:

• Main website

  This is the external website users will see when interacting with IceProd. It has been broken down into several sub-handlers for easier maintenance.

• JSONRPC

  This is the machine-readable portion of the website. Jobs talk to the server through this mechanism. The main website also uses this for various actions.

• lib downloads

  This is a directory of downloads local to the IceProd instance. Usually this will be the necessary software to run the iceprod core.

class iceprod.server.modules.website.website(*args, **kwargs)

The main website module.

Run the website, which is required for anything to work.

stop()

Stop website

kill()

Kill website

logrotate()

Rotate the Nginx logs.

start()

Run the website

iceprod.server.modules.website.catch_error(method)

Decorator to catch and handle errors on handlers

iceprod.server.modules.website.authenticated_secure(method)

Decorate methods with this to require that the user be logged in to a secure area.

If the user is not logged in, they will be redirected to the configured login url <RequestHandler.get_login_url>.

If you configure a login url with a query parameter, Tornado will assume you know what you’re doing and use it as-is. If not, it will add a next parameter so the login page knows where to send you once you’re logged in.

class iceprod.server.modules.website.MyHandler(application, request, **kwargs)

Default Handler

initialize(cfg, modules, fileio, debug=False, statsd=None)

Get some params from the website module

Parameters:

• cfg – the global config
• modules – modules handle
• fileio – AsyncFileIO object
• debug – debug flag (optional)

db_call(*args, **kwargs)

Make a database call, returning the result

get()

GET is invalid and returns an error

post()

POST is invalid and returns an error

set_default_headers()

class iceprod.server.modules.website.JSONRPCHandler(application, request, **kwargs)

JSONRPC 2.0 Handler.

Call DB methods using RPC over json.

check_xsrf_cookie()

post(*args, **kwargs)

Parses json in the jsonrpc format, returning results in jsonrpc format as well.

json_error(error, status=400, request_id=None)

Create a proper jsonrpc error message

class iceprod.server.modules.website.LibHandler(application, request, **kwargs)

Handler for iceprod library downloads.

These are straight http downloads like normal.

initialize(prefix, directory, **kwargs)

Get some params from the website module

Parameters:

• fileio – AsyncFileIO object
• prefix – library url prefix
• directory – library directory on disk

get(*args, **kwargs)

Look up a library

class iceprod.server.modules.website.PublicHandler(application, request, **kwargs)

Handler for public facing website

get_template_namespace()

get_current_user()

write_error(status_code=500, **kwargs)

Write out custom error page.

class iceprod.server.modules.website.Default(application, request, **kwargs)

Handle / urls

get(*args, **kwargs)

class iceprod.server.modules.website.Submit(application, request, **kwargs)

Handle /submit urls

get(*args, **kwargs)

class iceprod.server.modules.website.Config(application, request, **kwargs)

Handle /submit urls

get(*args, **kwargs)

class iceprod.server.modules.website.Site(application, request, **kwargs)

Handle /site urls

get(*args, **kwargs)

class iceprod.server.modules.website.Dataset(application, request, **kwargs)

Handle /dataset urls

get(*args, **kwargs)

class iceprod.server.modules.website.Task(application, request, **kwargs)

Handle /task urls

get(*args, **kwargs)

class iceprod.server.modules.website.Job(application, request, **kwargs)

Handle /job urls

get(*args, **kwargs)

class iceprod.server.modules.website.Documentation(application, request, **kwargs)

get(*args, **kwargs)

class iceprod.server.modules.website.Log(application, request, **kwargs)

get(*args, **kwargs)

class iceprod.server.modules.website.GroupsHandler(application, request, **kwargs)

View/modify groups

get(*args, **kwargs)

class iceprod.server.modules.website.UserAccount(application, request, **kwargs)

View/modify a user account

get(*args, **kwargs)

post(*args, **kwargs)

class iceprod.server.modules.website.Help(application, request, **kwargs)

Help Page

get(*args, **kwargs)

class iceprod.server.modules.website.Other(application, request, **kwargs)

Handle any other urls - this is basically all 404

get(*args, **kwargs)

class iceprod.server.modules.website.Login(application, request, **kwargs)

Handle the login url

get(*args, **kwargs)

post(*args, **kwargs)

class iceprod.server.modules.website.Logout(application, request, **kwargs)

get(*args, **kwargs)