def add_new_user(toyz_settings, tid, params):
"""
Add a new user to the toyz application.
Parameters
- toyz_settings ( :py:class:`toyz.utils.core.ToyzSettings`): Settings for the toyz
application
- tid (*string* ): Task ID of the client user running the task
- params (*dict* ): Any parameters sent by the client (see *params* below)
Params
- user_id (*string* ): Id of user to add
Response
- id: 'notification'
- func: 'add_new_user'
- msg: 'User/Group added correctly'
"""
user = core.get_user_type(params)
user_id = six.next(six.itervalues(user))
pwd = core.encrypt_pwd(toyz_settings, user_id)
db_utils.update_param(toyz_settings.db, 'pwd', pwd=pwd, **user)
if 'user_id' in user:
# set permissions and shortcuts for users home path
core.check_user_shortcuts(toyz_settings, **user)
# Add user to all users
db_utils.update_param(toyz_settings.db, 'users', group_id='all', users=[user['user_id']])
msg = 'User added correctly'
else:
msg = 'Group added correctly'
response = {
'id': 'notification',
'func': 'add_new_user',
'msg': msg
}
return response
def add_new_user(toyz_settings, tid, params):
"""
Add a new user to the toyz application.
Parameters
- toyz_settings ( :py:class:`toyz.utils.core.ToyzSettings`): Settings for the toyz
application
- tid (*string* ): Task ID of the client user running the task
- params (*dict* ): Any parameters sent by the client (see *params* below)
Params
- user_id (*string* ): Id of user to add
Response
- id: 'notification'
- func: 'add_new_user'
- msg: 'User/Group added correctly'
"""
user = core.get_user_type(params)
user_id = six.next(six.itervalues(user))
pwd = core.encrypt_pwd(toyz_settings, user_id)
db_utils.update_param(toyz_settings.db, 'pwd', pwd=pwd, **user)
if 'user_id' in user:
# set permissions and shortcuts for users home path
core.check_user_shortcuts(toyz_settings, **user)
# Add user to all users
db_utils.update_param(toyz_settings.db,
'users',
group_id='all',
users=[user['user_id']])
msg = 'User added correctly'
else:
msg = 'Group added correctly'
response = {'id': 'notification', 'func': 'add_new_user', 'msg': msg}
return response
def new_session(self, user_id, websocket, session_id=None):
"""
Open a new websocket session for a given user
Parameters
user_id ( :py:class:`toyz.utils.core.ToyzUser` ): User id
websocket (:py:class:`toyz.web.app.WebSocketHandler` ): new websocket opened
"""
import datetime
if user_id not in self.user_sessions:
self.user_sessions[user_id] = {}
print("Users logged in:", self.user_sessions.keys())
if session_id is None:
session_id = str(datetime.datetime.now()).replace(
' ', '__').replace('.', '-').replace(':', '_')
self.user_sessions[user_id][session_id] = websocket
shortcuts = db_utils.get_param(self.toyz_settings.db,
'shortcuts',
user_id=user_id)
shortcuts = core.check_user_shortcuts(self.toyz_settings, user_id,
shortcuts)
websocket.session = {
'user_id': user_id,
'session_id': session_id,
'path': os.path.join(shortcuts['temp'], session_id),
}
core.create_paths(websocket.session['path'])
#initialize process for session jobs
websocket.job_pipe, remote_pipe = multiprocessing.Pipe()
websocket.process = multiprocessing.Process(target=job_process,
args=(session_id,
remote_pipe,
websocket.job_pipe))
websocket.process.start()
remote_pipe.close()
process_events = (tornado.ioloop.IOLoop.READ
| tornado.ioloop.IOLoop.ERROR)
tornado.ioloop.IOLoop.current().add_handler(websocket.job_pipe,
websocket.send_response,
process_events)
websocket.write_message({
'id': 'initialize',
'user_id': user_id,
'session_id': session_id,
})
def new_session(self, user_id, websocket, session_id=None):
"""
Open a new websocket session for a given user
Parameters
user_id ( :py:class:`toyz.utils.core.ToyzUser` ): User id
websocket (:py:class:`toyz.web.app.WebSocketHandler` ): new websocket opened
"""
import datetime
if user_id not in self.user_sessions:
self.user_sessions[user_id] = {}
print("Users logged in:", self.user_sessions.keys())
if session_id is None:
session_id = str(
datetime.datetime.now()).replace(' ','__').replace('.','-').replace(':','_')
self.user_sessions[user_id][session_id] = websocket
shortcuts = db_utils.get_param(self.toyz_settings.db, 'shortcuts',
user_id=user_id)
shortcuts = core.check_user_shortcuts(self.toyz_settings, user_id, shortcuts)
websocket.session = {
'user_id': user_id,
'session_id': session_id,
'path': os.path.join(shortcuts['temp'], session_id),
}
core.create_paths(websocket.session['path'])
#initialize process for session jobs
websocket.job_pipe, remote_pipe = multiprocessing.Pipe()
websocket.process = multiprocessing.Process(
target = job_process, args=(session_id, remote_pipe, websocket.job_pipe))
websocket.process.start()
remote_pipe.close()
process_events = (tornado.ioloop.IOLoop.READ | tornado.ioloop.IOLoop.ERROR)
tornado.ioloop.IOLoop.current().add_handler(
websocket.job_pipe, websocket.send_response, process_events)
websocket.write_message({
'id': 'initialize',
'user_id': user_id,
'session_id': session_id,
})
def load_user_settings(toyz_settings, tid, params):
"""
Load settings for a given user
Parameters
- toyz_settings ( :py:class:`toyz.utils.core.ToyzSettings`): Settings for the toyz
application
- tid (*string* ): Task ID of the client user running the task
- params (*dict* ): Any parameters sent by the client (**None** for this function)
Response for all users
- id: 'user_settings'
- shortcuts (*dict* ): Dictionary of ``shortcut_name: shortcut_path`` 's for the user
- workspaces (*dict* ): Dictionary of ``workspace_name: workspace_settings`` for the
user
Additional response keys for users in the **modify_toyz** group
- modules (*list* ): List of toyz modules the user can run
- toyz (*dict* ): Dictionary of ``toy_name: path_to_toy`` 's that the user can run
Additional reponse keys for admins
- config (*dict* ): Configuration settings for the application
- db (*dict* ): Database settings
- web (*dict*): Web settings
- security (*dict* ): Security settings
- users (*list* ): list of all users in the database
- groups (*list* ): list of all groups in the database
- user_settings (*dict* ): Settings for a specified user (initially the *admin*)
- group_settings (*dict* ): Settings for a specified group (initially the *admin* group)
"""
from toyz.utils import third_party
dbs = toyz_settings.db
old_shortcuts = db_utils.get_param(dbs, 'shortcuts', user_id=tid['user_id'])
shortcuts = core.check_user_shortcuts(toyz_settings, tid['user_id'], old_shortcuts)
workspaces = db_utils.get_param(dbs, 'workspaces', user_id=tid['user_id'])
response = {
'id':'user_settings',
'shortcuts': shortcuts,
'workspaces': workspaces
}
# set the default workspace sharing options
if len(workspaces)>0:
response['workspace'] = sorted(workspaces.keys())[0]
groups = db_utils.get_param(toyz_settings.db, 'groups', user_id=tid['user_id'])
# Only allow administrators to modify user settings
if tid['user_id']=='admin' or 'admin' in groups:
all_users = db_utils.get_all_ids(dbs, 'user_id')
all_groups = db_utils.get_all_ids(dbs, 'group_id')
user_settings = load_user_info(toyz_settings, tid, {
'user_id': 'admin',
'user_attr': ['groups', 'modules', 'toyz', 'paths'],
})
group_settings = load_user_info(toyz_settings, tid, {
'group_id': 'admin',
'user_attr': ['groups', 'modules', 'toyz', 'paths'],
})
del user_settings['id']
del group_settings['id']
user_settings['user_id'] = 'admin'
group_settings['group_id'] = 'admin'
response.update({
'config': toyz_settings.config.__dict__,
'db': toyz_settings.db.__dict__,
'web': toyz_settings.web.__dict__,
'security': toyz_settings.security.__dict__,
'users': all_users,
'groups': all_groups,
'user_settings': user_settings,
'group_settings': group_settings
})
# Only allow power users to modify toyz they have access to
if 'modify_toyz' in groups or 'admin' in groups or tid['user_id'] == 'admin':
response.update({
'modules': db_utils.get_param(dbs, 'modules', user_id=tid['user_id']),
'toyz': db_utils.get_param(dbs, 'toyz', user_id=tid['user_id'])
})
return response
def load_user_settings(toyz_settings, tid, params):
"""
Load settings for a given user
Parameters
- toyz_settings ( :py:class:`toyz.utils.core.ToyzSettings`): Settings for the toyz
application
- tid (*string* ): Task ID of the client user running the task
- params (*dict* ): Any parameters sent by the client (**None** for this function)
Response for all users
- id: 'user_settings'
- shortcuts (*dict* ): Dictionary of ``shortcut_name: shortcut_path`` 's for the user
- workspaces (*dict* ): Dictionary of ``workspace_name: workspace_settings`` for the
user
Additional response keys for users in the **modify_toyz** group
- modules (*list* ): List of toyz modules the user can run
- toyz (*dict* ): Dictionary of ``toy_name: path_to_toy`` 's that the user can run
Additional reponse keys for admins
- config (*dict* ): Configuration settings for the application
- db (*dict* ): Database settings
- web (*dict*): Web settings
- security (*dict* ): Security settings
- users (*list* ): list of all users in the database
- groups (*list* ): list of all groups in the database
- user_settings (*dict* ): Settings for a specified user (initially the *admin*)
- group_settings (*dict* ): Settings for a specified group (initially the *admin* group)
"""
from toyz.utils import third_party
dbs = toyz_settings.db
old_shortcuts = db_utils.get_param(dbs,
'shortcuts',
user_id=tid['user_id'])
shortcuts = core.check_user_shortcuts(toyz_settings, tid['user_id'],
old_shortcuts)
workspaces = db_utils.get_param(dbs, 'workspaces', user_id=tid['user_id'])
response = {
'id': 'user_settings',
'shortcuts': shortcuts,
'workspaces': workspaces
}
# set the default workspace sharing options
if len(workspaces) > 0:
response['workspace'] = sorted(workspaces.keys())[0]
groups = db_utils.get_param(toyz_settings.db,
'groups',
user_id=tid['user_id'])
# Only allow administrators to modify user settings
if tid['user_id'] == 'admin' or 'admin' in groups:
all_users = db_utils.get_all_ids(dbs, 'user_id')
all_groups = db_utils.get_all_ids(dbs, 'group_id')
user_settings = load_user_info(
toyz_settings, tid, {
'user_id': 'admin',
'user_attr': ['groups', 'modules', 'toyz', 'paths'],
})
group_settings = load_user_info(
toyz_settings, tid, {
'group_id': 'admin',
'user_attr': ['groups', 'modules', 'toyz', 'paths'],
})
del user_settings['id']
del group_settings['id']
user_settings['user_id'] = 'admin'
group_settings['group_id'] = 'admin'
response.update({
'config': toyz_settings.config.__dict__,
'db': toyz_settings.db.__dict__,
'web': toyz_settings.web.__dict__,
'security': toyz_settings.security.__dict__,
'users': all_users,
'groups': all_groups,
'user_settings': user_settings,
'group_settings': group_settings
})
# Only allow power users to modify toyz they have access to
if 'modify_toyz' in groups or 'admin' in groups or tid[
'user_id'] == 'admin':
response.update({
'modules':
db_utils.get_param(dbs, 'modules', user_id=tid['user_id']),
'toyz':
db_utils.get_param(dbs, 'toyz', user_id=tid['user_id'])
})
return response
