controllers Package

autologging

Edited by Bogdan Valean <bogdan.valean@codemart.ro> : 29.05.2020 - Use internal TVB Logger by default. - Add logged user GID to the logging message

tvb.interfaces.web.controllers.autologging.TRACE = 1

A custom tracing log level, lower in severity than logging.DEBUG.

tvb.interfaces.web.controllers.autologging.install_traced_noop()

Replace the traced() decorator with an identity (no-op) decorator.

Although the overhead of a @traced function or method is minimal when the TRACED log level is disabled, there is still some overhead (the logging level check, an extra function call).

If you would like to completely eliminate this overhead, call this function before any classes or functions in your application are decorated with @traced. The traced() decorator will be replaced with a no-op decorator that simply returns the class or function unmodified.

Note

The recommended way to install the no-op @traced decorator is to set the AUTOLOGGING_TRACED_NOOP environment variable to any non-empty value.

If the AUTOLOGGING_TRACED_NOOP environment variable is set to a non-empty value when Autologging is loaded, the @traced no-op will be installed automatically.

As an alternative to setting the AUTOLOGGING_TRACED_NOOP environment variable, you can also call this function directly in your application’s bootstrap module. For example:

import autologging

if running_in_production:
    autologging.install_traced_noop()

Warning

This function does not “revert” any already-@traced class or function! It simply replaces the autologging.traced module reference with a no-op.

For this reason it is imperative that autologging.install_traced_noop() be called before the @traced decorator has been applied to any class or function in the application. (This is why the AUTOLOGGING_TRACED_NOOP environment variable is the recommended approach for installing the no-op - it allows Autologging itself to guarantee that the no-op is installed before any classes or functions are decorated.)

tvb.interfaces.web.controllers.autologging.logged(obj)

Add a logger member to a decorated class or function.

Parameters:

obj – the class or function object being decorated, or an optional logging.Logger object to be used as the parent logger (instead of the default module-named logger)

Returns:

obj if obj is a class or function; otherwise, if obj is a logger, return a lambda decorator that will in turn set the logger attribute and return obj

If obj is a class, then obj.__log will have the logger name “<module-name>.<class-name>”:

>>> import sys
>>> logging.basicConfig(
...     level=logging.DEBUG, stream=sys.stdout,
...     format="%(levelname)s:%(name)s:%(funcName)s:%(message)s")
>>> @logged
... class Sample:
...
...     def test(self):
...         self.__log.debug("This is a test.")
...
>>> Sample().test()
DEBUG:autologging.Sample:test:This is a test.

Note

Autologging will prefer to use the class’s __qualname__ when it is available (Python 3.3+). Otherwise, the class’s __name__ is used. For example:

class Outer:

   @logged
   class Nested: pass

Under Python 3.3+, Nested.__log will have the name “autologging.Outer.Nested”, while under Python 2.7 or 3.2, the logger name will be “autologging.Nested”.

Changed in version 0.4.0: Functions decorated with @logged use a single underscore in the logger variable name (e.g. my_function._log) rather than a double underscore.

If obj is a function, then obj._log will have the logger name “<module-name>”:

>>> import sys
>>> logging.basicConfig(
...     level=logging.DEBUG, stream=sys.stdout,
...     format="%(levelname)s:%(name)s:%(funcName)s:%(message)s")
>>> @logged
... def test():
...     test._log.debug("This is a test.")
...
>>> test()
DEBUG:autologging:test:This is a test.

Note

Within a logged function, the _log attribute must be qualified by the function name.

If obj is a logging.Logger object, then that logger is used as the parent logger (instead of the default module-named logger):

>>> import sys
>>> logging.basicConfig(
...     level=logging.DEBUG, stream=sys.stdout,
...     format="%(levelname)s:%(name)s:%(funcName)s:%(message)s")
>>> @logged(logging.getLogger("test.parent"))
... class Sample:
...     def test(self):
...         self.__log.debug("This is a test.")
...
>>> Sample().test()
DEBUG:test.parent.Sample:test:This is a test.

Again, functions are similar:

>>> import sys
>>> logging.basicConfig(
...     level=logging.DEBUG, stream=sys.stdout,
...     format="%(levelname)s:%(name)s:%(funcName)s:%(message)s")
>>> @logged(logging.getLogger("test.parent"))
... def test():
...     test._log.debug("This is a test.")
...
>>> test()
DEBUG:test.parent:test:This is a test.

Note

For classes, the logger member is made “private” (i.e. __log with double underscore) to ensure that log messages that include the %(name)s format placeholder are written with the correct name.

Consider a subclass of a @logged-decorated parent class. If the subclass were not decorated with @logged and could access the parent’s logger member directly to make logging calls, those log messages would display the name of the parent class, not the subclass.

Therefore, subclasses of a @logged-decorated parent class that wish to use a provided self.__log object must themselves be decorated with @logged.

Warning

Although the @logged and @traced decorators will “do the right thing” regardless of the order in which they are applied to the same function, it is recommended that @logged always be used as the innermost decorator:

@traced
@logged
def my_function():
    my_function._log.info("message")

This is because @logged simply sets the _log attribute and then returns the original function, making it “safe” to use in combination with any other decorator.

Note

Both Jython and IronPython report an “internal” class name using its mangled form, which will be reflected in the default logger name.

For example, in the sample code below, both Jython and IronPython will use the default logger name “autologging._Outer__Nested” (whereas CPython/PyPy/Stackless would use “autologging.__Nested” under Python 2 or “autologging.Outer.__Nested” under Python 3.3+)

class Outer:
   @logged
   class __Nested:
      pass

Warning

IronPython does not fully support frames (even with the -X:FullFrames option), so you are likely to see things like misreported line numbers and “<unknown file>” in log records emitted when running under IronPython.

tvb.interfaces.web.controllers.autologging.traced(*args, **keywords)

Turn the @traced decorator into a no-op.

base_controller

The Main class in this file is initialized in web/run.py to be served on the root of the Web site.

This is the main UI entry point.

class tvb.interfaces.web.controllers.base_controller.BaseController

Bases: object

This class contains the methods served at the root of the Web site.

MAX_SIZE_ERROR_MSG = 'Max operation size has been exceeded. The current project admin can change this limit in Project - Basic Properties'

static build_path(path)

error(**data)

Error page to redirect when something extremely bad happened

fill_default_attributes(template_dictionary, escape_db_operations=False)

Fill into ‘template_dictionary’ data that we want to have ready in UI.

fill_overlay_attributes(template_dictionary, title, description, content_template, css_class, tabs_horizontal=None, overlay_indexes=None, tabs_vertical=None)

This method prepares parameters for rendering overlay (overlay.html)

Parameters:

• title – overlay title

• description – overlay description

• content_template – path&name of the template file which will fill overlay content (without .html)

• css_class – CSS class to be applied on overlay

• tabs_horizontal – list of strings containing names of the tabs spread horizontally

• tabs_vertical – list of strings containing names of the tabs spread vertically

static get_url_adapter(step_key, adapter_id, back_page=None)

Compute the URLs for a given adapter. Same URL is used both for GET and POST.

index()

/ Path response Redirects to /tvb

static mark_file_for_delete(file_name, delete_parent_folder=False)

This method stores provided file name in session, and later on when request is done, all these files/folders are deleted

Parameters:

• file_name – name of the file or folder to be deleted

• delete_parent_folder – specify if the parent folder of the file should be removed too.

redirect(path)

render_adapter_form(adapter_form, is_callout=False)

showBlockerOverlay(**data)

Returns the content of the blocking overlay (covers entire page and do not allow any action)

tvb(error=False, **data)

/tvb URL Returns the home page with the messages stored in the user’s session.

update_operations_count()

If a project is selected, update Operation Numbers in call-out.

common

Constants and functions used by all controllers Custom exceptions

exception tvb.interfaces.web.controllers.common.InvalidFormValues(message, error_dict=None)

Bases: TVBException

Exception to be thrown in case of existing some invalid values in a form.

display_full_errors()

exception tvb.interfaces.web.controllers.common.MissingDataException(message)

Bases: TVBException

exception tvb.interfaces.web.controllers.common.NotAllowed(message, redirect_url)

Bases: TVBException

Raised when accessing a resource is not allowed

exception tvb.interfaces.web.controllers.common.NotAuthenticated(message, redirect_url)

Bases: NotAllowed

Raised when accessing a protected method with no user logged in

tvb.interfaces.web.controllers.common.add2session(key, value)

Set in session, at a key, a value

tvb.interfaces.web.controllers.common.expire_session()

Expires and cleans current session.

tvb.interfaces.web.controllers.common.get_current_project()

Get current Project from session

tvb.interfaces.web.controllers.common.get_from_session(attribute)

check if something exists in session and return

tvb.interfaces.web.controllers.common.get_logged_user()

Get current logged User from session

tvb.interfaces.web.controllers.common.get_message_from_session()

tvb.interfaces.web.controllers.common.has_error_message()

check if the session contains an error message

tvb.interfaces.web.controllers.common.pop_message_from_session()

Pops the message stored in the session and it’s type If no message is present returns an empty info message :returns: a message dict

tvb.interfaces.web.controllers.common.remove_from_session(key)

Remove from session an attributes if exists.

tvb.interfaces.web.controllers.common.remove_project_from_session()

tvb.interfaces.web.controllers.common.set_error_message(msg)

Set error message in session

tvb.interfaces.web.controllers.common.set_important_message(msg)

Set info message in session

tvb.interfaces.web.controllers.common.set_info_message(msg)

Set info message in session

tvb.interfaces.web.controllers.common.set_message(msg, m_type='INFO')

Set in session a message of a given type

tvb.interfaces.web.controllers.common.set_warning_message(msg)

Set warning message in session

decorators

Decorators for Cherrypy exposed methods are defined here.

tvb.interfaces.web.controllers.decorators.check_admin(func)

Decorator to check if a user is administrator before accessing a controller method

tvb.interfaces.web.controllers.decorators.check_kc_user(func)

Decorator used to check if the incoming request has a valid keycloak refresh token

tvb.interfaces.web.controllers.decorators.check_kube_user(func)

tvb.interfaces.web.controllers.decorators.check_user(func)

Decorator to check if a user is logged before accessing a controller method.

tvb.interfaces.web.controllers.decorators.context_selected(func)

Decorator to check if a project is currently selected.

tvb.interfaces.web.controllers.decorators.expose_endpoint(func)

Equivalent to @cherrypy.expose @check_kc_user

tvb.interfaces.web.controllers.decorators.expose_fragment(template_name)

Equivalent to @cherrypy.expose @handle_error(redirect=False) @using_template2(template) @check_user

tvb.interfaces.web.controllers.decorators.expose_json(func)

Equivalent to @cherrypy.expose @handle_error(redirect=False) @jsonify @check_user

tvb.interfaces.web.controllers.decorators.expose_numpy_array(func)

tvb.interfaces.web.controllers.decorators.expose_page(func)

Equivalent to @cherrypy.expose @handle_error(redirect=True) @using_template2(‘base_template’) @check_user

tvb.interfaces.web.controllers.decorators.handle_error(redirect)

If redirect is true(default) all errors will generate redirects. Generic errors will redirect to the error page. Authentication errors to login pages. If redirect is false redirect will be converted to errors http 500 All errors are logged Redirect false is used by ajax calls

tvb.interfaces.web.controllers.decorators.jsonify(func)

Decorator to wrap all JSON calls, and log on server in case of an exception.

tvb.interfaces.web.controllers.decorators.ndarray_to_http_binary(func)

Decorator to wrap calls that return numpy arrays. It serializes them as binary http response

tvb.interfaces.web.controllers.decorators.profile_func(func)

tvb.interfaces.web.controllers.decorators.settings(func)

Decorator to check if a the settings file exists before allowing access to some parts of TVB.

tvb.interfaces.web.controllers.decorators.using_template(template_name)

Decorator that renders a template

flow_controller

Steps which a user needs to execute for achieving a given action are described here.

class tvb.interfaces.web.controllers.flow_controller.FlowController

Bases: BaseController

This class takes care of executing steps in projects.

NEW_SELECTION_NAME = 'New selection'

cancel_or_remove_operation(operation_id, is_group, remove_after_stop=False)

Stop the operation given by operation_id. If is_group is true stop all the operations from that group.

create_row_of_specs(count)

default(step_key, adapter_key, cancel=False, back_page=None, **data)

Render a specific adapter. ‘data’ are arguments for POST

execute_post(project_id, submit_url, step_key, algorithm, **data)

Execute HTTP POST on a generic step.

fill_default_attributes(template_dictionary, title='-')

Overwrite base controller to add required parameters for adapter templates.

get_adapter_template(project_id, algorithm_id, is_upload=False, back_page=None, is_callout=False)

Get the template for an adapter based on the algo group id.

get_available_selections(**data)

get_filtered_datatypes(dt_module, dt_class, filters, has_all_option, has_none_option)

Given the name from the input tree, the dataType required and a number of filters, return the available dataType that satisfy the conditions imposed.

get_pse_filters()

get_simple_adapter_interface(algorithm_id, parent_div='', is_uploader=False)

AJAX exposed method. Will return only the interface for a adapter, to be used when tabs are needed.

get_template_for_adapter(project_id, step_key, stored_adapter, submit_url, is_burst=True, is_callout=False)

Get Input HTML Interface template or a given adapter

getadapterinterface(project_id, algorithm_id, back_page=None)

AJAX exposed method. Will return only a piece of a page, to be integrated as part in another page.

invoke_adapter(algo_id, method_name, entity_gid, **kwargs)

prepare_group_launch(group_gid, step_key, algorithm_id, **data)

Receives as input a group gid and an algorithm given by category and id, along with data that gives the name of the required input parameter for the algorithm. Having these generate a range of GID’s for all the DataTypes in the group and launch a new operation group.

read_binary_datatype_attribute(entity_gid, method_name, datatype_kwargs='null', **kwargs)

read_datatype_attribute(entity_gid, dataset_name, flatten=False, datatype_kwargs='null', **kwargs)

Retrieve from a given DataType a property or a method result.

Returns:

JSON representation of the attribute.

Parameters:

• entity_gid – GID for DataType entity

• dataset_name – name of the dataType property /method

• flatten – result should be flatten before return (use with WebGL data mainly e.g vertices/triangles) Ignored if the attribute is not an ndarray

• datatype_kwargs – if passed, will contain a dictionary of type {‘name’ : ‘gid’}, and for each such pair, a load_entity will be performed and kwargs will be updated to contain the result

• kwargs – extra parameters to be passed when dataset_name is method.

read_from_h5_file(entity_gid, method_name, flatten=False, datatype_kwargs='null', **kwargs)

readserverstaticfile(coded_path)

Retrieve file from Local storage, having a File System Path.

refresh_subform(data_name, subform_label, spatial_model_key)

reload_burst_operation(operation_id, is_group, **_)

Find out from which burst was this operation launched. Set that burst as the selected one and redirect to the burst page.

reloadoperation(operation_id, **_)

Redirect to Operation Input selection page, with input data already selected.

show_group_of_algorithms(step_key, algorithm_ids)

step_analyzers()

Choose exact action/adapter for current step.

step_connectivity()

Display menu for Connectivity Footer tab.

store_exploration_section(val_range, step, dt_group_guid)

Launching method for further simulations.

store_measure_points_selection(ui_name, **data)

Save a MeasurePoints selection (new or update existing entity).

store_pse_filter(config_name, **data)

hpc_controller

REST endpoints that we use while running simulations on HPC nodes.

class tvb.interfaces.web.controllers.hpc_controller.HPCController

Bases: object

Receive requests from simulation jobs that run on HPC nodes.

encryption_config(simulator_gid, operation_id)

update_status(simulator_gid, operation_id, **data)

kube_controller

class tvb.interfaces.web.controllers.kube_controller.KubeController

Bases: BaseController

data_encryption_handler(method, **data)

start_operation_pod(operation_id)

stop_operation_process(operation_id)

settings_controller

class tvb.interfaces.web.controllers.settings_controller.AsciiValidator(*args, **kw)

Bases: FancyValidator

Allow only ascii strings

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 115

class tvb.interfaces.web.controllers.settings_controller.DiskSpaceValidator(*args, **kw)

Bases: FancyValidator

Custom validator for TVB disk space / user.

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 111

class tvb.interfaces.web.controllers.settings_controller.PortValidator(*args, **kw)

Bases: FancyValidator

Custom validator for OS Port number.

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 112

class tvb.interfaces.web.controllers.settings_controller.SettingsController

Bases: UserController

Controller for TVB-Settings web page. Inherit from UserController, to have the same fill_default_attributes method (with versionInfo).

check_db_url(**data)

Action on DB-URL validate button.

settings(save_settings=False, **data)

Main settings page submit and get

class tvb.interfaces.web.controllers.settings_controller.SettingsForm(*args, **kw)

Bases: Schema

Validate Settings Page inputs.

Messages

badDictType:

The input must be dict-like (not a %(type)s: %(value)r)

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

missingValue:

Missing value

noneType:

The input must be a string (not None)

notExpected:

The input field %(name)s was not expected.

singleValueExpected:

Please provide only one value

chained_validators = []

declarative_count = 137

fields = {'ADMINISTRATOR_DISPLAY_NAME': <All [<UnicodeString object 119 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, <PlainText object 120 regex=re.compile('^[a-zA-Z_\\-0-9]*$')>]>, 'ADMINISTRATOR_EMAIL': <Email object 123 not_empty=True>, 'ADMINISTRATOR_NAME': <All [<UnicodeString object 116 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, <PlainText object 117 regex=re.compile('^[a-zA-Z_\\-0-9]*$')>]>, 'ADMINISTRATOR_PASSWORD': <UnicodeString object 122 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'CLUSTER_SCHEDULER': <UnicodeString object 128 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'DEPLOY_CLUSTER': <Bool object 127>, 'ENABLE_KEYCLOAK_LOGIN': <Bool object 131>, 'KEYCLOAK_CONFIGURATION': <UnicodeString object 129 inputEncoding='utf-8' outputEncoding='utf-8'>, 'KEYCLOAK_WEB_CONFIGURATION': <UnicodeString object 130 inputEncoding='utf-8' outputEncoding='utf-8'>, 'MAXIMUM_NR_OF_OPS_IN_RANGE': <Int object 136 max=5000 min=5 not_empty=True>, 'MAXIMUM_NR_OF_THREADS': <ThreadNrValidator object 134>, 'MAXIMUM_NR_OF_VERTICES_ON_SURFACE': <SurfaceVerticesNrValidator object 135>, 'SELECTED_DB': <UnicodeString object 125 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'TVB_STORAGE': <UnicodeString object 132 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'URL_VALUE': <UnicodeString object 126 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'USR_DISK_SPACE': <DiskSpaceValidator object 133 not_empty=True>, 'WEB_SERVER_PORT': <PortValidator object 124>}

pre_validators = []

class tvb.interfaces.web.controllers.settings_controller.SurfaceVerticesNrValidator(*args, **kw)

Bases: FancyValidator

Custom validator for the number of vertices allowed for a surface

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

MAX_VALUE = 16777217

declarative_count = 114

class tvb.interfaces.web.controllers.settings_controller.ThreadNrValidator(*args, **kw)

Bases: FancyValidator

Custom validator number of threads.

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 113

users_controller

Here, user related tasks are described. Basic authentication processes are described here, but also user related annotation (checked-logged).

class tvb.interfaces.web.controllers.users_controller.EditUserForm(*args, **kw)

Bases: Schema

Validate fields on user-edit

Messages

badDictType:

The input must be dict-like (not a %(type)s: %(value)r)

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

missingValue:

Missing value

noneType:

The input must be a string (not None)

notExpected:

The input field %(name)s was not expected.

singleValueExpected:

Please provide only one value

chained_validators = [<FieldsMatch object 108 field_names=('password', 'password2')>, <RequireIfMissing object 109 present='old_password' required='password'>]

declarative_count = 110

fields = {'email': <Email object 107 if_missing=None>, 'old_password': <UnicodeString object 104 if_missing=None inputEncoding='utf-8' outputEncoding='utf-8'>, 'password': <UnicodeString object 105 if_missing=None inputEncoding='utf-8' outputEncoding='utf-8'>, 'password2': <UnicodeString object 106 if_missing=None inputEncoding='utf-8' outputEncoding='utf-8'>}

pre_validators = []

class tvb.interfaces.web.controllers.users_controller.KeycloakLoginForm(*args, **kw)

Bases: Schema

Validate for Login UI Form

Messages

badDictType:

The input must be dict-like (not a %(type)s: %(value)r)

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

missingValue:

Missing value

noneType:

The input must be a string (not None)

notExpected:

The input field %(name)s was not expected.

singleValueExpected:

Please provide only one value

chained_validators = []

declarative_count = 87

empty_msg = 'Please enter a value'

fields = {'auth_token': <UnicodeString object 86 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8' use_builtins_gettext=False>}

pre_validators = []

class tvb.interfaces.web.controllers.users_controller.LoginForm(*args, **kw)

Bases: Schema

Validate for Login UI Form

Messages

badDictType:

The input must be dict-like (not a %(type)s: %(value)r)

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

missingValue:

Missing value

noneType:

The input must be a string (not None)

notExpected:

The input field %(name)s was not expected.

singleValueExpected:

Please provide only one value

chained_validators = []

declarative_count = 85

empty_msg = 'Please enter a value'

fields = {'password': <UnicodeString object 84 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8' use_builtins_gettext=False>, 'username': <UnicodeString object 83 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8' use_builtins_gettext=False>}

pre_validators = []

class tvb.interfaces.web.controllers.users_controller.RecoveryForm(*args, **kw)

Bases: Schema

Validate Recover Password Form

Messages

badDictType:

The input must be dict-like (not a %(type)s: %(value)r)

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

missingValue:

Missing value

noneType:

The input must be a string (not None)

notExpected:

The input field %(name)s was not expected.

singleValueExpected:

Please provide only one value

chained_validators = []

declarative_count = 103

fields = {'email': <Email object 101 not_empty=True>, 'username': <UnicodeString object 102 inputEncoding='utf-8' not_empty=False outputEncoding='utf-8'>}

pre_validators = []

class tvb.interfaces.web.controllers.users_controller.RegisterForm(*args, **kw)

Bases: Schema

Validate Register Form

Messages

badDictType:

The input must be dict-like (not a %(type)s: %(value)r)

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

missingValue:

Missing value

noneType:

The input must be a string (not None)

notExpected:

The input field %(name)s was not expected.

singleValueExpected:

Please provide only one value

chained_validators = [<FieldsMatch object 99 field_names=('password', 'password2')>]

declarative_count = 100

fields = {'comment': <UnicodeString object 97 inputEncoding='utf-8' outputEncoding='utf-8'>, 'display_name': <UnicodeString object 93 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'email': <Email object 96 not_empty=True>, 'password': <UnicodeString object 94 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'password2': <UnicodeString object 95 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, 'role': <UnicodeString object 98 inputEncoding='utf-8' outputEncoding='utf-8'>, 'username': <All [<UnicodeString object 89 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, <PlainText object 90 regex=re.compile('^[a-zA-Z_\\-0-9]*$')>, <UniqueUsername object 91>]>}

pre_validators = []

class tvb.interfaces.web.controllers.users_controller.UniqueUsername(*args, **kw)

Bases: FancyValidator

Custom validator to check that a given user-name is unique.

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 88

class tvb.interfaces.web.controllers.users_controller.UserController

Bases: BaseController

This class takes care of the user authentication and/or register.

base_url(**data)

check_sso()

create_new(cancel=False, **data)

Create new user with data submitted from UI.

fill_default_attributes(template_dictionary)

Fill into ‘template_dictionary’ data that we want to have ready in UI.

get_color_schemes_json()

get_viewer_color_scheme()

index(**data)

Login page (with or without messages).

is_storage_ready()

Check if all storage updates are done

keycloak_web_config()

logout()

Logging out user and clean session

profile(logout=False, save=False, **data)

Display current user’s profile page. On POST: logout, or save password/email.

recoverpassword(cancel=False, **data)

This form should reset a password for a given userName/email and send a notification message to that email.

register(cancel=False, **data)

This register form send an e-mail to the user and to the site admin.

set_viewer_color_scheme(color_scheme_name)

switch_online_help()

Switch flag that displays online helps

usermanagement(cancel=False, page=1, do_persist=False, **data)

Display a table used for user management.

validate(name)

A link to this page will be sent to the administrator to validate the registration of each user.

Subpackages

• burst Package
  • base_controller
    • BurstBaseController
      • BurstBaseController.fill_default_attributes()
  • dynamic_model_controller
    • Dynamic
    • DynamicModelController
      • DynamicModelController.KEY_CACHED_DYNAMIC_MODEL
      • DynamicModelController.LOGGER
      • DynamicModelController.dynamic_detail()
      • DynamicModelController.fill_default_attributes()
      • DynamicModelController.get_cached_dynamic()
      • DynamicModelController.graph_changed()
      • DynamicModelController.index()
      • DynamicModelController.integrator_parameters_changed()
      • DynamicModelController.model_changed()
      • DynamicModelController.parameters_changed()
      • DynamicModelController.refresh_subform()
      • DynamicModelController.submit()
      • DynamicModelController.trajectories()
    • SessionCache
      • SessionCache.SESSION_KEY
  • exploration_controller
    • ParameterExplorationController
      • ParameterExplorationController.draw_discrete_exploration()
      • ParameterExplorationController.draw_isocline_exploration()
      • ParameterExplorationController.get_default_pse_viewer()
      • ParameterExplorationController.get_metric_matrix()
      • ParameterExplorationController.get_node_matrix()
      • ParameterExplorationController.get_series_array_discrete()
      • ParameterExplorationController.pse_error()
  • matjax
    • configure_matjax_doc()
  • noise_configuration_controller
    • NoiseConfigurationController
      • NoiseConfigurationController.group_noise_array_by_state_var()
      • NoiseConfigurationController.index()
      • NoiseConfigurationController.init_noise_config_values()
      • NoiseConfigurationController.submit()
  • region_model_parameters_controller
    • RegionsModelParametersController
      • RegionsModelParametersController.index()
      • RegionsModelParametersController.no_dynamics_page()
      • RegionsModelParametersController.submit_model_parameters()
  • transfer_vector_controller
    • TransferVectorController
      • TransferVectorController.apply_transfer_function()
      • TransferVectorController.base_url
      • TransferVectorController.clear_histogram()
      • TransferVectorController.fill_default_attributes()
      • TransferVectorController.get_equation_chart()
      • TransferVectorController.index()
      • TransferVectorController.no_connectivity_measure_page()
      • TransferVectorController.set_connectivity_measure()
      • TransferVectorController.set_model_parameter()
      • TransferVectorController.set_transfer_function_param()
      • TransferVectorController.submit_model_parameter()
      • TransferVectorController.title
• help Package
  • help_config
    • HelpConfig
      • HelpConfig.ANALYZE_HELP_PAGE
      • HelpConfig.BURST_HELP_PAGE
      • HelpConfig.CONNECTIVITY_HELP_PAGE
      • HelpConfig.HELP_PAGE_PATH
      • HelpConfig.MAIN_HELP_PAGE
      • HelpConfig.PROJECT_HELP_PAGE
      • HelpConfig.STIMULUS_HELP_PAGE
      • HelpConfig.USER_HELP_PAGE
      • HelpConfig.get_help_url()
  • help_controller
    • HelpController
      • HelpController.showOnlineHelp()
• project Package
  • figure_controller
    • EditPreview
      • EditPreview.chained_validators
      • EditPreview.declarative_count
      • EditPreview.fields
      • EditPreview.pre_validators
    • FigureController
      • FigureController.displayresultfigures()
      • FigureController.displayzoomedimage()
      • FigureController.downloadimage()
      • FigureController.editresultfigures()
      • FigureController.storeresultfigure()
  • project_controller
    • EditForm
      • EditForm.chained_validators
      • EditForm.declarative_count
      • EditForm.fields
      • EditForm.invalis_name_msg
      • EditForm.pre_validators
    • ProjectController
      • ProjectController.KEY_OPERATION_FILTERS
      • ProjectController.NODE_OPERATION_GROUP_TYPE
      • ProjectController.NODE_OPERATION_TYPE
      • ProjectController.PRROJECTS_FOR_LINK_KEY
      • ProjectController.PRROJECTS_LINKED_KEY
      • ProjectController.createlink()
      • ProjectController.downloaddatatype()
      • ProjectController.downloadproject()
      • ProjectController.editone()
      • ProjectController.editstructure()
      • ProjectController.fill_default_attributes()
      • ProjectController.generate_call_out_control()
      • ProjectController.get_data_uploader_overlay()
      • ProjectController.get_datatype_details()
      • ProjectController.get_linkable_projects()
      • ProjectController.get_operation_details()
      • ProjectController.get_project_structure_grouping()
      • ProjectController.get_project_uploader_overlay()
      • ProjectController.getmemberspage()
      • ProjectController.index()
      • ProjectController.launchloader()
      • ProjectController.noderemove()
      • ProjectController.projectupload()
      • ProjectController.readjsonstructure()
      • ProjectController.removelink()
      • ProjectController.set_project_structure_grouping()
      • ProjectController.set_visibility()
      • ProjectController.show_confirmation_overlay()
      • ProjectController.updatemetadata()
      • ProjectController.viewall()
      • ProjectController.viewoperations()
• simulator Package
  • monitors_wizard_handler
    • MonitorsWizardHandler
      • MonitorsWizardHandler.get_current_and_next_monitor_form()
      • MonitorsWizardHandler.get_fragment_after_monitors()
      • MonitorsWizardHandler.handle_next_fragment_for_monitors()
      • MonitorsWizardHandler.prepare_monitor_fragment()
      • MonitorsWizardHandler.prepare_monitor_legend()
      • MonitorsWizardHandler.prepare_next_fragment_after_noise()
      • MonitorsWizardHandler.set_monitors_list_on_simulator()
      • MonitorsWizardHandler.update_monitor()
  • simulator_controller
    • SimulatorController
      • SimulatorController.BRANCH_NAME_FORMAT
      • SimulatorController.COPY_NAME_FORMAT
      • SimulatorController.KEY_IS_LOAD_AFTER_REDIRECT
      • SimulatorController.KEY_KEEP_SAME_SIM_WIZARD
      • SimulatorController.branch_simulator_configuration()
      • SimulatorController.build_monitor_url()
      • SimulatorController.cancel_or_remove_burst()
      • SimulatorController.cancel_or_remove_operation()
      • SimulatorController.copy_simulator_configuration()
      • SimulatorController.export()
      • SimulatorController.get_first_monitor_fragment_url()
      • SimulatorController.get_history_status()
      • SimulatorController.get_last_fragment_url()
      • SimulatorController.get_upload_overlay()
      • SimulatorController.get_url_after_monitor_equation()
      • SimulatorController.get_url_after_monitors()
      • SimulatorController.get_url_for_final_fragment()
      • SimulatorController.get_urls_for_next_monitor_fragment()
      • SimulatorController.index()
      • SimulatorController.launch_pse()
      • SimulatorController.launch_simulation()
      • SimulatorController.load_burst_history()
      • SimulatorController.load_burst_read_only()
      • SimulatorController.load_simulator_configuration_from_zip()
      • SimulatorController.prepare_first_fragment()
      • SimulatorController.rename_burst()
      • SimulatorController.reset_simulator_configuration()
      • SimulatorController.set_connectivity()
      • SimulatorController.set_cortex()
      • SimulatorController.set_coupling_params()
      • SimulatorController.set_fragment_url()
      • SimulatorController.set_integrator()
      • SimulatorController.set_integrator_params()
      • SimulatorController.set_model()
      • SimulatorController.set_model_params()
      • SimulatorController.set_monitor_equation()
      • SimulatorController.set_monitor_params()
      • SimulatorController.set_monitors()
      • SimulatorController.set_noise_equation_params()
      • SimulatorController.set_noise_params()
      • SimulatorController.set_pse_params()
      • SimulatorController.set_stimulus()
      • SimulatorController.set_surface()
      • SimulatorController.setup_pse()
  • simulator_fragment_rendering_rules
    • SimulatorFragmentRenderingRules
      • SimulatorFragmentRenderingRules.FIRST_FORM_URL
      • SimulatorFragmentRenderingRules.disable_fields
      • SimulatorFragmentRenderingRules.hide_launch_and_setup_pse_button
      • SimulatorFragmentRenderingRules.hide_previous_button
      • SimulatorFragmentRenderingRules.include_branch_button
      • SimulatorFragmentRenderingRules.include_launch_button
      • SimulatorFragmentRenderingRules.include_launch_pse_button
      • SimulatorFragmentRenderingRules.include_next_button
      • SimulatorFragmentRenderingRules.include_previous_button
      • SimulatorFragmentRenderingRules.include_setup_noise
      • SimulatorFragmentRenderingRules.include_setup_pse
      • SimulatorFragmentRenderingRules.include_setup_region_model
      • SimulatorFragmentRenderingRules.include_setup_surface_model
      • SimulatorFragmentRenderingRules.load_readonly
      • SimulatorFragmentRenderingRules.to_dict()
  • simulator_wizzard_urls
    • SimulatorWizzardURLs
      • SimulatorWizzardURLs.LAUNCH_PSE_URL
      • SimulatorWizzardURLs.SETUP_PSE_URL
      • SimulatorWizzardURLs.SET_CONNECTIVITY_URL
      • SimulatorWizzardURLs.SET_CORTEX_URL
      • SimulatorWizzardURLs.SET_COUPLING_PARAMS_URL
      • SimulatorWizzardURLs.SET_INTEGRATOR_PARAMS_URL
      • SimulatorWizzardURLs.SET_INTEGRATOR_URL
      • SimulatorWizzardURLs.SET_MODEL_PARAMS_URL
      • SimulatorWizzardURLs.SET_MODEL_URL
      • SimulatorWizzardURLs.SET_MONITORS_URL
      • SimulatorWizzardURLs.SET_MONITOR_EQUATION_URL
      • SimulatorWizzardURLs.SET_MONITOR_PARAMS_URL
      • SimulatorWizzardURLs.SET_NOISE_EQUATION_PARAMS_URL
      • SimulatorWizzardURLs.SET_NOISE_PARAMS_URL
      • SimulatorWizzardURLs.SET_PSE_PARAMS_URL
      • SimulatorWizzardURLs.SET_STIMULUS_URL
      • SimulatorWizzardURLs.SET_SURFACE_URL
• spatial Package
  • base_spatio_temporal_controller
    • SpatioTemporalController
      • SpatioTemporalController.MSG_MISSING_SURFACE
      • SpatioTemporalController.display_surface()
      • SpatioTemporalController.fill_default_attributes()
      • SpatioTemporalController.get_series_json()
      • SpatioTemporalController.get_ui_message()
      • SpatioTemporalController.get_x_axis_range()
      • SpatioTemporalController.index()
      • SpatioTemporalController.render_spatial_form()
  • local_connectivity_controller
    • LocalConnectivityController
      • LocalConnectivityController.CUTOFF_FIELD
      • LocalConnectivityController.DISPLAY_NAME_FIELD
      • LocalConnectivityController.EQUATION_FIELD
      • LocalConnectivityController.EQUATION_PARAMS_FIELD
      • LocalConnectivityController.SURFACE_FIELD
      • LocalConnectivityController.base_url
      • LocalConnectivityController.compute_data_for_gradient_view()
      • LocalConnectivityController.create_local_connectivity()
      • LocalConnectivityController.fill_default_attributes()
      • LocalConnectivityController.get_equation_chart()
      • LocalConnectivityController.get_series_json()
      • LocalConnectivityController.load_local_connectivity()
      • LocalConnectivityController.reset_local_connectivity()
      • LocalConnectivityController.set_cutoff_value()
      • LocalConnectivityController.set_display_name()
      • LocalConnectivityController.set_equation_param()
      • LocalConnectivityController.set_surface()
      • LocalConnectivityController.step_1()
      • LocalConnectivityController.step_2()
  • region_stimulus_controller
    • RegionStimulusController
      • RegionStimulusController.CONNECTIVITY_FIELD
      • RegionStimulusController.DISPLAY_NAME_FIELD
      • RegionStimulusController.MSG_MISSING_CONNECTIVITY
      • RegionStimulusController.TEMPORAL_FIELD
      • RegionStimulusController.TEMPORAL_PARAMS_FIELD
      • RegionStimulusController.base_url
      • RegionStimulusController.create_stimulus()
      • RegionStimulusController.display_connectivity()
      • RegionStimulusController.do_step()
      • RegionStimulusController.fill_default_attributes()
      • RegionStimulusController.get_equation_chart()
      • RegionStimulusController.load_region_stimulus()
      • RegionStimulusController.reset_region_stimulus()
      • RegionStimulusController.set_connectivity()
      • RegionStimulusController.set_display_name()
      • RegionStimulusController.set_temporal_param()
      • RegionStimulusController.step_1()
      • RegionStimulusController.step_1_submit()
      • RegionStimulusController.step_2()
      • RegionStimulusController.step_2_submit()
      • RegionStimulusController.update_scaling()
  • surface_model_parameters_controller
    • SurfaceModelParametersController
      • SurfaceModelParametersController.EQUATION_FIELD
      • SurfaceModelParametersController.EQUATION_PARAMS_FIELD
      • SurfaceModelParametersController.MODEL_PARAM_FIELD
      • SurfaceModelParametersController.apply_equation()
      • SurfaceModelParametersController.apply_focal_point()
      • SurfaceModelParametersController.base_url
      • SurfaceModelParametersController.edit_model_parameters()
      • SurfaceModelParametersController.fill_default_attributes()
      • SurfaceModelParametersController.get_data_from_burst_configuration()
      • SurfaceModelParametersController.get_equation_chart()
      • SurfaceModelParametersController.get_focal_points()
      • SurfaceModelParametersController.remove_focal_point()
      • SurfaceModelParametersController.set_equation_param()
      • SurfaceModelParametersController.set_model_parameter()
      • SurfaceModelParametersController.submit_model_parameters()
  • surface_stimulus_controller
    • SurfaceStimulusController
      • SurfaceStimulusController.DISPLAY_NAME_FIELD
      • SurfaceStimulusController.SPATIAL_FIELD
      • SurfaceStimulusController.SPATIAL_PARAMS_FIELD
      • SurfaceStimulusController.SURFACE_FIELD
      • SurfaceStimulusController.TEMPORAL_FIELD
      • SurfaceStimulusController.TEMPORAL_PARAMS_FIELD
      • SurfaceStimulusController.base_url
      • SurfaceStimulusController.create_stimulus()
      • SurfaceStimulusController.do_step()
      • SurfaceStimulusController.fill_default_attributes()
      • SurfaceStimulusController.get_spatial_equation_chart()
      • SurfaceStimulusController.get_stimulus_chunk()
      • SurfaceStimulusController.get_temporal_equation_chart()
      • SurfaceStimulusController.load_surface_stimulus()
      • SurfaceStimulusController.reload_default()
      • SurfaceStimulusController.set_display_name()
      • SurfaceStimulusController.set_spatial_param()
      • SurfaceStimulusController.set_surface()
      • SurfaceStimulusController.set_temporal_param()
      • SurfaceStimulusController.step_1()
      • SurfaceStimulusController.step_1_submit()
      • SurfaceStimulusController.step_2()
      • SurfaceStimulusController.step_2_submit()
      • SurfaceStimulusController.view_stimulus()