Merge branch '296_critetion_to_web'

Author: HadronCollider

app/api/criteria.py

@@ -1,19 +1,109 @@
-import logging
-
 from bson import ObjectId
-from flask import Blueprint
+from flask import Blueprint, request
+import logging
+from json import dumps
 
 from app.check_access import check_access
+from app.criteria import CRITERIONS
+from app.criteria.utils import create_criterion
 from app.criteria_pack import CriteriaPackFactory
 from app.lti_session_passback.auth_checkers import is_admin
-from app.mongo_odm import TrainingsDBManager
-from app.utils import check_argument_is_convertible_to_object_id
+from app.mongo_models import Criterion
+from app.mongo_odm import TrainingsDBManager, CriterionDBManager
+from app.root_logger import get_root_logger
+from app.utils import check_argument_is_convertible_to_object_id, remove_blank_and_none, try_load_json, check_dict_keys
+
+
+api_criteria = Blueprint('api_criteria', __name__, url_prefix="/api/criterion")
+logger = get_root_logger('web')
+
+
+@api_criteria.route('/create/', methods=['POST'])
+def create_new_criterion():
+    if not is_admin():
+        return {}, 404
+
+    return update_criterion('')
+
+
+@api_criteria.route('/<criterion_name>/', methods=['GET'])
+def get_criterion(criterion_name):
+    if not check_access():
+        return {}, 404
+    db_criterion = CriterionDBManager().get_criterion_by_name(criterion_name)
+    if db_criterion:
+        return db_criterion.to_dict()
+    else:
+        return {}, 200
+
+
+@api_criteria.route('/<criterion_name>/', methods=['POST'])
+def update_criterion(criterion_name):
+    if not is_admin():
+        return {}, 404
+
+    criterion_dict, msg = try_load_criterion_dict(
+        request.form.get('parameters'))
+    if msg:
+        return {'message': msg}, 200
+
+    base_criterion_name = request.form.get('base_criterion', '')
+    base_criterion = CRITERIONS.get(base_criterion_name)
+    if not base_criterion:
+        return {'message': f"No such base critetion '{base_criterion_name}'"}, 200
+
+    db_criterion = CriterionDBManager().get_criterion_by_name(
+        criterion_dict['name'])
+    if not db_criterion:
+        db_criterion = Criterion(name=criterion_dict['name'], parameters={},
+                                 base_criterion=base_criterion_name)
 
-api_criteria = Blueprint('api_criteria', __name__)
-logger = logging.getLogger('root_logger')
+    instance, msg = check_criterion_dict(base_criterion, criterion_dict)
+    if msg:
+        return {'message': msg}, 200
 
+    db_criterion.parameters = instance.dict.get('parameters')
+    db_criterion.base_criterion = base_criterion_name
+    db_criterion.save()
+    logger.info(f"Updated criterion {db_criterion.name}")
+    return {
+        'message': 'OK',
+        'name': db_criterion.name,
+        'time': int(db_criterion.last_update.timestamp()*1000)
+    }, 200
 
-@api_criteria.route('/api/criteria/<training_id>/<criterion_name>/<parameter_name>/', methods=['GET'])
+
+@api_criteria.route('/<criterion_name>/structure/', methods=['GET'])
+def get_criteria_structure(criterion_name):
+    if not check_access():
+        return {}, 404
+    criterion = CRITERIONS.get(criterion_name)
+    if create_criterion:
+        return criterion.structure()
+    else:
+        return {}, 404
+
+@api_criteria.route('/list/', methods=['GET'])
+def get_all_criterions():
+    if not is_admin():
+        return {}, 404
+    
+    criterions = CriterionDBManager().get_all_criterions()
+    return {
+        'criterions': criterions,
+        'message': 'OK'
+    }
+
+
+@api_criteria.route('/structures', methods=['GET'])
+def get_all_criterion_structures():
+    if not is_admin():
+        return {}, 404
+
+    return {name: dumps(criterion.structure(), indent=3) for name, criterion in CRITERIONS.items()}
+
+
+@api_criteria.route('/<training_id>/<criterion_name>/<parameter_name>/', methods=['GET'])
 def get_criterion_parameter_value(training_id: str, criterion_name, parameter_name) -> (dict, int):
     """
     Endpoint to retrieve criterion parameter value.
@@ -39,3 +129,26 @@ def get_criterion_parameter_value(training_id: str, criterion_name, parameter_na
     if parameter_value is None:
         return {'message': 'No parameter with name = {}.'.format(parameter_name)}, 404
     return {'parameterName': parameter_name, 'parameterValue': parameter_value, 'message': 'OK'}, 200
+
+
+def check_criterion_dict(base_criterion, criterion_dict):
+    instance, msg = create_criterion(base_criterion, criterion_dict)
+    # try to get criterion's description
+    if not instance:
+        return False, f"Error on creating instance of {base_criterion.__name__} with params {criterion_dict['parameters']} for new criterion '{criterion_dict['name']}'.<br>{msg}"
+    return instance, ''
+
+
+def try_load_criterion_dict(json_str):
+    criterion_dict, msg = try_load_json(json_str)
+    if msg:
+        return False, msg  # error on parsing
+
+    criterion_dict = remove_blank_and_none(criterion_dict)
+
+    msg = check_dict_keys(
+        criterion_dict, ('name', 'parameters'))
+    if msg:
+        return False, msg  # error with dict keys
+
+    return criterion_dict, ''

app/criteria/README.md

@@ -19,6 +19,7 @@ class EmptyCriterion:
 
     def __init__(self, parameters: dict, dependent_criteria: list):
         super().__init__(
+            name=name,
             parameters=parameters,
             dependent_criteria=dependent_criteria,
         )
@@ -34,8 +35,7 @@ class EmptyCriterion:
 ## Правила реализации и работы с модулями
 - Все файлы, необходимые для критерия, размещаются в директории с именем, соответствующем названию критерия в стиле `lower_case_with_underscores`.
 - Класс критерия размещается в файле `criterion.py`
-- Для возможности импорта критерия в других модулях системы, необходимо разместить импорт класс критерия в `__init__.py`
-    - Также для корректной работы системы необходимо внести класс критерия по ключу, соответствующему названию класса, в `CRITERIONS` в том же модуле.
+- Для возможности импорта критерия в других модулях системы, необходимо разместить импорт класса критерия в `critetions.py`
     - Внешние модули должны знать только классы критериев - никакие другие функции/классы/переменные не импортируются и не выносятся
 ```
 from .empty_criterion.criterion import EmptyCriterion

app/criteria/__init__.py

@@ -1,24 +1,7 @@
-from .fillers_number.criterion import FillersNumberCriterion
-from .fillers_ratio.criterion import FillersRatioCriterion
-from .len_text_on_slide.critetion import LenTextOnSlideCriterion
-from .number_slides.critetion import NumberSlidesCriterion
-from .number_word_on_slide.critetion import NumberWordOnSlideCriterion
-from .speech_duration.criterion import SpeechDurationCriterion
-from .speech_is_not_in_database.criterion import SpeechIsNotInDatabaseCriterion
-from .speech_pace.criterion import SpeechPaceCriterion
-from .strict_speech_duration.criterion import StrictSpeechDurationCriterion
+import sys, inspect
 
-CRITERIONS = {
-    FillersNumberCriterion.__name__: FillersNumberCriterion,
-    FillersRatioCriterion.__name__: FillersRatioCriterion,
-    LenTextOnSlideCriterion.__name__: LenTextOnSlideCriterion,
-    NumberSlidesCriterion.__name__: NumberSlidesCriterion,
-    NumberWordOnSlideCriterion.__name__: NumberWordOnSlideCriterion,
-    SpeechDurationCriterion.__name__: SpeechDurationCriterion,
-    SpeechIsNotInDatabaseCriterion.__name__: SpeechIsNotInDatabaseCriterion,
-    SpeechPaceCriterion.__name__: SpeechPaceCriterion,
-    StrictSpeechDurationCriterion.__name__: StrictSpeechDurationCriterion,
-}
+from .criterions import *
+from .utils import check_criterions, create_criterion
 
 
-from .utils import check_criterions
+CRITERIONS = dict(inspect.getmembers(sys.modules[__name__], inspect.isclass))

app/criteria/criterion_base.py

@@ -8,8 +8,8 @@ class Criterion:
 
     PARAMETERS = dict()
 
-    def __init__(self, parameters: dict, dependent_criteria: list):
-        self.name = self.__class__.__name__
+    def __init__(self, parameters: dict, dependent_criteria: list, name=''):
+        self.name = name if name else self.__class__.__name__
         self.parameters = parameters
         self.dependent_criteria = dependent_criteria
 
@@ -21,8 +21,15 @@ def apply(self, audio: Audio, presentation: Presentation, training_id: ObjectId,
             -> CriterionResult:
         raise NotImplementedError()
 
+    @property
+    def dict(self) -> dict:
+        return dict(
+            name = self.name,
+            parameters = self.parameters
+        )
+
     @classmethod
-    def structure_to_json(cls):
+    def structure(cls) -> dict:
         # for simplicity, dependent criteria are removed
         return dict(
             name=cls.__name__,
@@ -32,4 +39,4 @@ def structure_to_json(cls):
     @classmethod
     def from_dict(cls, dictionary):
         dependent_criterions = []   # for simplicity,  dependent criteria are removed
-        return cls(dictionary['parameters'], dependent_criterions)
+        return cls(dictionary['parameters'], dependent_criterions, name=dictionary.get('name'))

app/criteria/criterions.py

@@ -0,0 +1,9 @@
+from .fillers_number.criterion import FillersNumberCriterion
+from .fillers_ratio.criterion import FillersRatioCriterion
+from .len_text_on_slide.critetion import LenTextOnSlideCriterion
+from .number_slides.critetion import NumberSlidesCriterion
+from .number_word_on_slide.critetion import NumberWordOnSlideCriterion
+from .speech_duration.criterion import SpeechDurationCriterion
+from .speech_is_not_in_database.criterion import SpeechIsNotInDatabaseCriterion
+from .speech_pace.criterion import SpeechPaceCriterion
+from .strict_speech_duration.criterion import StrictSpeechDurationCriterion

app/criteria/fillers_number/criterion.py

@@ -11,8 +11,9 @@ class FillersNumberCriterion(Criterion):
         maximum_fillers_number=int.__name__
     )
 
-    def __init__(self, parameters, dependent_criteria):
+    def __init__(self, parameters, dependent_criteria, name=''):
         super().__init__(
+            name=name,
             parameters=parameters,
             dependent_criteria=dependent_criteria,
         )

app/criteria/fillers_ratio/criterion.py

@@ -10,12 +10,13 @@ class FillersRatioCriterion(Criterion):
         fillers=list.__name__
     )
 
-    def __init__(self, parameters, dependent_criteria):
+    def __init__(self, parameters, dependent_criteria, name=''):
         if 'fillers' not in parameters:
             raise ValueError(
                 'parameters should contain {}.'.format('fillers'))
 
         super().__init__(
+            name=name,
             parameters=parameters,
             dependent_criteria=dependent_criteria,
         )

app/criteria/len_text_on_slide/critetion.py

@@ -12,11 +12,12 @@ class LenTextOnSlideCriterion(Criterion):
         minimal_number_words=int.__name__
     )
 
-    def __init__(self, parameters, dependent_criteria):
+    def __init__(self, parameters, dependent_criteria, name=''):
         if 'minimal_number_words' not in parameters:
             raise ValueError(
                 'parameters should contain \'minimal_number_words\'.')
         super().__init__(
+            name=name,
             parameters=parameters,
             dependent_criteria=dependent_criteria,
         )

app/criteria/number_slides/critetion.py

@@ -11,11 +11,12 @@ class NumberSlidesCriterion(Criterion):
         maximal_allowed_slide_number=int.__name__
     )
 
-    def __init__(self, parameters, dependent_criteria):
+    def __init__(self, parameters, dependent_criteria, name=''):
         if 'minimal_allowed_slide_number' not in parameters and 'maximal_allowed_slide_number' not in parameters:
             raise ValueError(
                 'parameters should contain \'minimal_allowed_slide_number\' or \'maximal_allowed_slide_number\'.')
         super().__init__(
+            name=name,
             parameters=parameters,
             dependent_criteria=dependent_criteria,
         )

app/criteria/number_word_on_slide/critetion.py

@@ -10,11 +10,12 @@ class NumberWordOnSlideCriterion(Criterion):
         minimal_number_words=int.__name__
     )
 
-    def __init__(self, parameters, dependent_criteria):
+    def __init__(self, parameters, dependent_criteria, name=''):
         if 'minimal_number_words' not in parameters:
             raise ValueError(
                 'parameters should contain \'minimal_number_words\'.')
         super().__init__(
+            name=name,
             parameters=parameters,
             dependent_criteria=dependent_criteria,
         )