def create_user(self, username=None, password=None, password2=None,
role=None, email=None, comment=None, email_msg=None, validated=False, skip_import=False):
"""
Service Layer for creating a new user.
"""
if (username is None) or len(username) < 1:
raise UsernameException("Empty UserName!")
if (password is None) or len(password) < 1:
raise UsernameException("Empty password!")
if password2 is None:
password2 = password
if password != password2:
raise UsernameException("Passwords do not match!")
try:
user_validated = (role == 'ADMINISTRATOR') or validated
user = model.User(username, password, email, user_validated, role)
if email_msg is None:
email_msg = 'Hello ' + username + TEXT_CREATE
admin_msg = (TEXT_CREATE_TO_ADMIN + username + ' :\n ' + TvbProfile.current.web.BASE_URL +
'user/validate/' + username + '\n\n"' + str(comment) + '"')
self.logger.info("Registering user " + username + " !")
if role != 'ADMINISTRATOR' and email is not None:
admins = UserService.get_administrators()
admin = admins[randint(0, len(admins) - 1)]
if admin.email is not None and (admin.email != TvbProfile.current.web.admin.DEFAULT_ADMIN_EMAIL):
# Do not send validation email in case default admin email remained unchanged
email_sender.send(FROM_ADDRESS, admin.email, SUBJECT_REGISTER, admin_msg)
self.logger.debug("Email sent to:" + admin.email + " for validating user:"******" !")
email_sender.send(FROM_ADDRESS, email, SUBJECT_REGISTER, email_msg)
self.logger.debug("Email sent to:" + email + " for notifying new user:"******" !")
user = dao.store_entity(user)
if role == model.ROLE_ADMINISTRATOR and not skip_import:
to_upload = os.path.join(os.path.dirname(tvb_data.__file__), "Default_Project.zip")
if not os.path.exists(to_upload):
self.logger.warning("Could not find DEFAULT PROJECT at path %s. You might want to import it "
"yourself. See TVB documentation about where to find it!" % to_upload)
return TEXT_DISPLAY
ImportService().import_project_structure(to_upload, user.id)
else:
try:
default_prj_id = dao.get_project_by_gid(DEFAULT_PROJECT_GID).id
dao.add_members_to_project(default_prj_id, [user.id])
except Exception:
self.logger.warning(
"Could not link user_id: %d with project_gid: %s " % (user.id, DEFAULT_PROJECT_GID))
return TEXT_DISPLAY
except Exception as excep:
self.logger.exception("Could not create user!")
raise UsernameException(str(excep))
def store_project(self, current_user, is_create, selected_id, **data):
"""
We want to create/update a project entity.
"""
# Validate Unique Name
new_name = data["name"]
if len(new_name) < 1:
raise ProjectServiceException("Invalid project name!")
projects_no = dao.count_projects_for_name(new_name, selected_id)
if projects_no > 0:
err = {'name': 'Please choose another name, this one is used!'}
raise formencode.Invalid("Duplicate Name Error", {}, None, error_dict=err)
started_operations = dao.get_operation_numbers(selected_id)[1]
if started_operations > 0:
raise ProjectServiceException("A project can not be renamed while operations are still running!")
if is_create:
current_proj = model.Project(new_name, current_user.id, data["description"])
self.structure_helper.get_project_folder(current_proj)
else:
try:
current_proj = dao.get_project_by_id(selected_id)
except Exception as excep:
self.logger.exception("An error has occurred!")
raise ProjectServiceException(str(excep))
if current_proj.name != new_name:
self.structure_helper.rename_project_structure(current_proj.name, new_name)
current_proj.name = new_name
current_proj.description = data["description"]
# Commit to make sure we have a valid ID
current_proj.refresh_update_date()
self.structure_helper.write_project_metadata(current_proj)
current_proj = dao.store_entity(current_proj)
# Retrieve, to initialize lazy attributes
current_proj = dao.get_project_by_id(current_proj.id)
# Update share settings on current Project entity
visited_pages = []
prj_admin = current_proj.administrator.username
if 'visited_pages' in data and data['visited_pages']:
visited_pages = data['visited_pages'].split(',')
for page in visited_pages:
members = UserService.retrieve_all_users(prj_admin, int(page))[0]
members = [m.id for m in members]
dao.delete_members_for_project(current_proj.id, members)
selected_user_ids = data["users"]
dao.add_members_to_project(current_proj.id, selected_user_ids)
# Finish operation
self.logger.debug("Edit/Save OK for project:" + str(current_proj.id) + ' by user:' + current_user.username)
return current_proj
def add_member_to_project(self, project_gid, user_id):
"""
Create a link between Project and User
:param project_gid: GID to identify a project uniquely
:param user_id: ID for the user we want to be able to access the Project
:return: True is the link was created, False otherwise
"""
try:
default_prj = dao.get_project_by_gid(project_gid)
default_prj_id = default_prj.id
dao.add_members_to_project(default_prj_id, [user_id])
return True
except Exception:
self.logger.warning("Could not link user_id: %d with project_gid: %s " % (user_id, project_gid))
return False
def store_project(self, current_user, is_create, selected_id, **data):
"""
We want to create/update a project entity.
"""
# Validate Unique Name
new_name = data["name"]
if len(new_name) < 1:
raise ProjectServiceException("Invalid project name!")
projects_no = dao.count_projects_for_name(new_name, selected_id)
if projects_no > 0:
err = {'name': 'Please choose another name, this one is used!'}
raise formencode.Invalid("Duplicate Name Error", {},
None,
error_dict=err)
started_operations = dao.get_operation_numbers(selected_id)[1]
if started_operations > 0:
raise ProjectServiceException(
"A project can not be renamed while operations are still running!"
)
if is_create:
current_proj = Project(new_name, current_user.id,
data["description"])
self.storage_interface.get_project_folder(current_proj.name)
else:
try:
current_proj = dao.get_project_by_id(selected_id)
except Exception as excep:
self.logger.exception("An error has occurred!")
raise ProjectServiceException(str(excep))
if current_proj.name != new_name:
self.storage_interface.rename_project(current_proj.name,
new_name)
current_proj.name = new_name
current_proj.description = data["description"]
# Commit to make sure we have a valid ID
current_proj.refresh_update_date()
_, metadata_proj = current_proj.to_dict()
self.storage_interface.write_project_metadata(metadata_proj)
current_proj = dao.store_entity(current_proj)
# Retrieve, to initialize lazy attributes
current_proj = dao.get_project_by_id(current_proj.id)
# Update share settings on current Project entity
visited_pages = []
prj_admin = current_proj.administrator.username
if 'visited_pages' in data and data['visited_pages']:
visited_pages = data['visited_pages'].split(',')
for page in visited_pages:
members = UserService.retrieve_users_except([prj_admin], int(page),
MEMBERS_PAGE_SIZE)[0]
members = [m.id for m in members]
dao.delete_members_for_project(current_proj.id, members)
selected_user_ids = data["users"]
if is_create and current_user.id not in selected_user_ids:
# Make the project admin also member of the current project
selected_user_ids.append(current_user.id)
dao.add_members_to_project(current_proj.id, selected_user_ids)
# Finish operation
self.logger.debug("Edit/Save OK for project:" + str(current_proj.id) +
' by user:' + current_user.username)
return current_proj
def create_user(self,
username=None,
password=None,
password2=None,
role=None,
email=None,
comment=None,
email_msg=None,
validated=False,
skip_import=False):
"""
Service Layer for creating a new user.
"""
if (username is None) or len(username) < 1:
raise UsernameException("Empty UserName!")
if (password is None) or len(password) < 1:
raise UsernameException("Empty password!")
if password2 is None:
password2 = password
if password != password2:
raise UsernameException("Passwords do not match!")
try:
user_validated = (role == 'ADMINISTRATOR') or validated
user = model.User(username, password, email, user_validated, role)
if email_msg is None:
email_msg = 'Hello ' + username + TEXT_CREATE
admin_msg = (TEXT_CREATE_TO_ADMIN + username + ' :\n ' +
TvbProfile.current.web.BASE_URL + 'user/validate/' +
username + '\n\n"' + str(comment) + '"')
self.logger.info("Registering user " + username + " !")
if role != 'ADMINISTRATOR' and email is not None:
admins = UserService.get_administrators()
admin = admins[randint(0, len(admins) - 1)]
if admin.email is not None and (
admin.email !=
TvbProfile.current.web.admin.DEFAULT_ADMIN_EMAIL):
# Do not send validation email in case default admin email remained unchanged
email_sender.send(FROM_ADDRESS, admin.email,
SUBJECT_REGISTER, admin_msg)
self.logger.debug("Email sent to:" + admin.email +
" for validating user:"******" !")
email_sender.send(FROM_ADDRESS, email, SUBJECT_REGISTER,
email_msg)
self.logger.debug("Email sent to:" + email +
" for notifying new user:"******" !")
user = dao.store_entity(user)
if role == model.ROLE_ADMINISTRATOR and not skip_import:
to_upload = os.path.join(os.path.dirname(tvb_data.__file__),
"Default_Project.zip")
if not os.path.exists(to_upload):
self.logger.warning(
"Could not find DEFAULT PROJECT at path %s. You might want to import it "
"yourself. See TVB documentation about where to find it!"
% to_upload)
return TEXT_DISPLAY
ImportService().import_project_structure(to_upload, user.id)
else:
try:
default_prj_id = dao.get_project_by_gid(
DEFAULT_PROJECT_GID).id
dao.add_members_to_project(default_prj_id, [user.id])
except Exception:
self.logger.warning(
"Could not link user_id: %d with project_gid: %s " %
(user.id, DEFAULT_PROJECT_GID))
return TEXT_DISPLAY
except Exception as excep:
self.logger.exception("Could not create user!")
raise UsernameException(str(excep))
