class ProjectFacade:
def __init__(self):
self.project_service = ProjectService()
self.user_service = UserService()
self.project_dao = CaseDAO()
@staticmethod
def retrieve_logged_user_projects(logged_user_id):
projects = ProjectService.retrieve_all_user_projects(user_id=logged_user_id)
return [ProjectDto(project) for project in projects]
def create_project(self, logged_user, project_name, project_description):
self.project_service.store_project(logged_user, True, None, name=project_name,
description=project_description)
def get_datatypes_in_project(self, project_gid):
try:
project = self.project_service.find_project_lazy_by_gid(project_gid)
except ProjectServiceException:
raise InvalidIdentifierException()
datatypes = self.project_service.get_datatypes_in_project(project.id)
return [DataTypeDto(datatype) for datatype in datatypes]
def get_project_operations(self, project_gid, page_number):
try:
project = self.project_service.find_project_lazy_by_gid(project_gid)
except ProjectServiceException:
raise InvalidIdentifierException()
_, _, operations, pages = self.project_service.retrieve_project_full(project.id, current_page=int(page_number))
return [OperationDto(operation) for operation in operations], pages
def add_members_to_project(self, current_user_id, project_gid, new_members_gid):
try:
project = self.project_service.find_project_lazy_by_gid(project_gid)
except Exception:
raise InvalidIdentifierException("Invalid project identifier.")
if current_user_id != project.fk_admin:
raise AuthorizationRequestException("Your are not allowed to edit given project")
new_members_id = []
for gid in new_members_gid:
user = self.user_service.get_user_by_gid(gid)
if user is None:
raise InvalidInputException("Invalid user gid {}".format(gid))
new_members_id.append(user.id)
self.project_dao.add_members_to_project(project.id, new_members_id)
class GetOperationsInProjectResource(RestResource):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.project_service = ProjectService()
def get(self, project_gid):
"""
:return a list of project's Operation entities
"""
page_number = request.args.get(Strings.PAGE_NUMBER.value)
if page_number is None:
page_number = 1
try:
page_number = int(page_number)
except ValueError:
raise InvalidInputException(message="Invalid page number")
try:
project = self.project_service.find_project_lazy_by_gid(
project_gid)
except ProjectServiceException:
raise InvalidIdentifierException(INVALID_PROJECT_GID_MESSAGE %
project_gid)
_, _, operations, pages = self.project_service.retrieve_project_full(
project.id, current_page=int(page_number))
return {
"operations":
[OperationDto(operation) for operation in operations],
"pages": pages
}
class SimulationFacade:
def __init__(self):
self.logger = get_logger(self.__class__.__module__)
self.simulator_service = SimulatorService()
self.project_service = ProjectService()
def launch_simulation(self, current_user_id, zip_directory, project_gid):
try:
project = self.project_service.find_project_lazy_by_gid(project_gid)
except ProjectServiceException:
raise InvalidIdentifierException()
try:
simulator_h5_name = DirLoader(zip_directory, None).find_file_for_has_traits_type(Simulator)
simulator_file = os.path.join(zip_directory, simulator_h5_name)
except IOError:
raise InvalidInputException('No Simulator h5 file found in the archive')
try:
simulator_algorithm = AlgorithmService().get_algorithm_by_module_and_class(SimulatorAdapter.__module__,
SimulatorAdapter.__name__)
simulation = self.simulator_service.prepare_simulation_on_server(user_id=current_user_id,
project=project,
algorithm=simulator_algorithm,
zip_folder_path=zip_directory,
simulator_file=simulator_file)
return simulation.gid
except Exception as excep:
self.logger.error(excep, exc_info=True)
raise ServiceException(str(excep))
class ProjectMembersResource(RestResource):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.project_service = ProjectService()
self.user_service = UserService()
self.project_dao = CaseDAO()
def put(self, project_gid):
"""
Add members to the given project
:param project_gid: project gid
:param
"""
try:
project = self.project_service.find_project_lazy_by_gid(project_gid)
except Exception:
raise InvalidIdentifierException("Invalid project identifier.")
if get_current_user().id != project.fk_admin:
raise AuthorizationRequestException("Your are not allowed to edit given project")
input_data = flask.request.json
new_members_gid = input_data[
FormKeyInput.NEW_MEMBERS_GID.value] if FormKeyInput.NEW_MEMBERS_GID.value in input_data else []
new_members_id = []
for gid in new_members_gid:
user = self.user_service.get_user_by_gid(gid)
if user is None:
raise InvalidInputException("Invalid user gid {}".format(gid))
new_members_id.append(user.id)
self.project_dao.add_members_to_project(project.id, new_members_id)
class LaunchOperationResource(RestResource):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.logger = get_logger(self.__class__.__module__)
self.operation_service = OperationService()
self.project_service = ProjectService()
self.user_service = UserService()
self.files_helper = FilesHelper()
@check_permission(ProjectAccessPermission, 'project_gid')
def post(self, project_gid, algorithm_module, algorithm_classname):
"""
:generic method of launching Analyzers
"""
model_file = self.extract_file_from_request(request_file_key=RequestFileKey.LAUNCH_ANALYZERS_MODEL_FILE.value)
destination_folder = RestResource.get_destination_folder()
h5_path = RestResource.save_temporary_file(model_file, destination_folder)
try:
project = self.project_service.find_project_lazy_by_gid(project_gid)
except ProjectServiceException:
raise InvalidIdentifierException(INVALID_PROJECT_GID_MESSAGE % project_gid)
algorithm = FlowService.get_algorithm_by_module_and_class(algorithm_module, algorithm_classname)
if algorithm is None:
raise InvalidIdentifierException('No algorithm found for: %s.%s' % (algorithm_module, algorithm_classname))
try:
adapter_instance = ABCAdapter.build_adapter(algorithm)
view_model = adapter_instance.get_view_model_class()()
view_model_h5 = ViewModelH5(h5_path, view_model)
view_model_gid = view_model_h5.gid.load()
current_user = get_current_user()
operation = self.operation_service.prepare_operation(current_user.id, project.id, algorithm.id,
algorithm.algorithm_category, view_model_gid.hex, None,
{})
storage_path = self.files_helper.get_project_folder(project, str(operation.id))
if isinstance(adapter_instance, ABCUploader):
for key, value in adapter_instance.get_form_class().get_upload_information().items():
data_file = self.extract_file_from_request(request_file_key=key, file_extension=value)
data_file_path = RestResource.save_temporary_file(data_file, destination_folder)
file_name = os.path.basename(data_file_path)
upload_field = getattr(view_model_h5, key)
upload_field.store(os.path.join(storage_path, file_name))
shutil.move(data_file_path, storage_path)
shutil.move(h5_path, storage_path)
os.rmdir(destination_folder)
view_model_h5.close()
OperationService().launch_operation(operation.id, True)
except Exception as excep:
self.logger.error(excep, exc_info=True)
raise ServiceException(str(excep))
return operation.gid, HTTP_STATUS_CREATED
class FireSimulationResource(RestResource):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.logger = get_logger(self.__class__.__module__)
self.simulator_service = SimulatorService()
self.project_service = ProjectService()
@check_permission(ProjectAccessPermission, 'project_gid')
def post(self, project_gid):
"""
:start a simulation using a project id and a zip archive with the simulator data serialized
"""
file = self.extract_file_from_request(
request_file_key=RequestFileKey.SIMULATION_FILE_KEY.value,
file_extension=FilesHelper.TVB_ZIP_FILE_EXTENSION)
destination_folder = RestResource.get_destination_folder()
zip_path = RestResource.save_temporary_file(file, destination_folder)
try:
project = self.project_service.find_project_lazy_by_gid(
project_gid)
except ProjectServiceException:
raise InvalidIdentifierException(INVALID_PROJECT_GID_MESSAGE %
project_gid)
result = FilesHelper().unpack_zip(zip_path, os.path.dirname(zip_path))
if len(result) == 0:
raise InvalidInputException("Empty zip archive")
folder_path = os.path.dirname(result[0])
simulator_algorithm = FlowService().get_algorithm_by_module_and_class(
SimulatorAdapter.__module__, SimulatorAdapter.__name__)
try:
simulator_h5_name = DirLoader(
folder_path, None).find_file_for_has_traits_type(Simulator)
simulator_file = os.path.join(folder_path, simulator_h5_name)
except IOError:
raise InvalidInputException(
'No Simulator h5 file found in the archive')
try:
current_user = get_current_user()
operation = self.simulator_service.prepare_simulation_on_server(
user_id=current_user.id,
project=project,
algorithm=simulator_algorithm,
zip_folder_path=folder_path,
simulator_file=simulator_file)
except Exception as excep:
self.logger.error(excep, exc_info=True)
raise ServiceException(str(excep))
return operation.gid, HTTP_STATUS_CREATED
class GetDataInProjectResource(RestResource):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.project_service = ProjectService()
def get(self, project_gid):
"""
:return a list of DataType instances (subclasses) associated with the current project
"""
try:
project = self.project_service.find_project_lazy_by_gid(
project_gid)
except ProjectServiceException:
raise InvalidIdentifierException(INVALID_PROJECT_GID_MESSAGE %
project_gid)
datatypes = self.project_service.get_datatypes_in_project(project.id)
return [DataTypeDto(datatype) for datatype in datatypes]
class OperationFacade:
def __init__(self):
self.logger = get_logger(self.__class__.__module__)
self.operation_service = OperationService()
self.project_service = ProjectService()
self.user_service = UserService()
self.files_helper = FilesHelper()
@staticmethod
def get_operation_status(operation_gid):
operation = ProjectService.load_operation_by_gid(operation_gid)
if operation is None:
get_logger().warning(
"Invalid operation GID: {}".format(operation_gid))
raise InvalidIdentifierException()
return operation.status
@staticmethod
def get_operations_results(operation_gid):
operation = ProjectService.load_operation_lazy_by_gid(operation_gid)
if operation is None:
get_logger().warning(
"Invalid operation GID: {}".format(operation_gid))
raise InvalidIdentifierException()
data_types = ProjectService.get_results_for_operation(operation.id)
if data_types is None:
return []
return [DataTypeDto(datatype) for datatype in data_types]
def launch_operation(self, current_user_id, model_file, project_gid,
algorithm_module, algorithm_classname, fetch_file):
temp_folder = FilesHelper.create_temp_folder()
model_h5_path = FilesHelper.save_temporary_file(
model_file, temp_folder)
try:
project = self.project_service.find_project_lazy_by_gid(
project_gid)
except ProjectServiceException:
raise InvalidIdentifierException()
algorithm = AlgorithmService.get_algorithm_by_module_and_class(
algorithm_module, algorithm_classname)
if algorithm is None:
raise InvalidIdentifierException(
'No algorithm found for: %s.%s' %
(algorithm_module, algorithm_classname))
try:
adapter_instance = ABCAdapter.build_adapter(algorithm)
view_model = adapter_instance.get_view_model_class()()
view_model_h5 = ViewModelH5(model_h5_path, view_model)
view_model_gid = view_model_h5.gid.load()
operation = self.operation_service.prepare_operation(
current_user_id, project.id, algorithm, view_model_gid.hex)
storage_path = self.files_helper.get_project_folder(
project, str(operation.id))
if isinstance(adapter_instance, ABCUploader):
for key, value in adapter_instance.get_form_class(
).get_upload_information().items():
data_file = fetch_file(request_file_key=key,
file_extension=value)
data_file_path = FilesHelper.save_temporary_file(
data_file, temp_folder)
file_name = os.path.basename(data_file_path)
upload_field = getattr(view_model_h5, key)
upload_field.store(os.path.join(storage_path, file_name))
shutil.move(data_file_path, storage_path)
shutil.move(model_h5_path, storage_path)
os.rmdir(temp_folder)
view_model_h5.close()
OperationService().launch_operation(operation.id, True)
return operation.gid
except Exception as excep:
self.logger.error(excep, exc_info=True)
raise ServiceException(str(excep))
class OperationFacade:
def __init__(self):
self.logger = get_logger(self.__class__.__module__)
self.operation_service = OperationService()
self.project_service = ProjectService()
self.user_service = UserService()
@staticmethod
def get_operation_status(operation_gid):
operation = ProjectService.load_operation_by_gid(operation_gid)
if operation is None:
get_logger().warning(
"Invalid operation GID: {}".format(operation_gid))
raise InvalidIdentifierException()
return operation.status
@staticmethod
def get_operations_results(operation_gid):
operation = ProjectService.load_operation_lazy_by_gid(operation_gid)
if operation is None:
get_logger().warning(
"Invalid operation GID: {}".format(operation_gid))
raise InvalidIdentifierException()
data_types = ProjectService.get_results_for_operation(operation.id)
if data_types is None:
return []
return [DataTypeDto(datatype) for datatype in data_types]
def launch_operation(self, current_user_id, model_file, project_gid,
algorithm_module, algorithm_classname, fetch_file):
temp_folder = create_temp_folder()
model_h5_path = save_temporary_file(model_file, temp_folder)
try:
project = self.project_service.find_project_lazy_by_gid(
project_gid)
except ProjectServiceException:
raise InvalidIdentifierException()
try:
algorithm = AlgorithmService.get_algorithm_by_module_and_class(
algorithm_module, algorithm_classname)
if algorithm is None:
raise InvalidIdentifierException(
'No algorithm found for: %s.%s' %
(algorithm_module, algorithm_classname))
adapter_instance = ABCAdapter.build_adapter(algorithm)
view_model = h5.load_view_model_from_file(model_h5_path)
if isinstance(adapter_instance, ABCUploader):
with ViewModelH5(model_h5_path, view_model) as view_model_h5:
for key, value in adapter_instance.get_form_class(
).get_upload_information().items():
data_file = fetch_file(request_file_key=key,
file_extension=value)
data_file_path = save_temporary_file(
data_file, temp_folder)
view_model_h5.store_metadata_param(key, data_file_path)
view_model = h5.load_view_model_from_file(model_h5_path)
operation = self.operation_service.prepare_operation(
current_user_id, project, algorithm, view_model=view_model)
if os.path.exists(model_h5_path):
os.remove(model_h5_path)
OperationService().launch_operation(operation.id, True)
return operation.gid
except Exception as excep:
self.logger.error(excep, exc_info=True)
raise ServiceException(str(excep))
