Introduced prioritization and penalties for TM keys

inc/validation/schema/job_keys.json

@@ -0,0 +1,78 @@
+{
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "mine": {
+      "type": "array",
+      "nullable": true,
+      "items": {
+        "type": "object",
+        "$ref": "#/definitions/key"
+      }
+    },
+    "ownergroup": {
+      "type": "array",
+      "nullable": true,
+      "items": {
+        "type": "object",
+        "$ref": "#/definitions/key"
+      }
+    },
+    "anonymous": {
+      "type": "array",
+      "nullable": true,
+      "items": {
+        "type": "object",
+        "$ref": "#/definitions/key"
+      }
+    }
+  },
+  "required": [
+    "mine",
+    "ownergroup",
+    "anonymous"
+  ],
+  "definitions": {
+    "key": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        },
+        "glos": {
+          "type": ["boolean", "integer", "string"]
+        },
+        "owner": {
+          "type": ["boolean", "integer", "string"]
+        },
+        "tm": {
+          "type": ["boolean", "integer", "string"]
+        },
+        "r": {
+          "type": ["boolean", "integer", "string"]
+        },
+        "w": {
+          "type": ["boolean", "integer", "string"]
+        },
+        "penalty": {
+          "type": "integer",
+          "nullable": true,
+          "maximum": 100,
+          "minimum": 0
+        }
+      },
+      "required": [
+        "name",
+        "key",
+        "glos",
+        "tm",
+        "r",
+        "w"
+      ]
+    }
+  }
+}

inc/validation/schema/private_tm_key_json.json

@@ -0,0 +1,49 @@
+{
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "tm_prioritization": {
+      "type": "boolean"
+    },
+    "keys": {
+      "type": "array",
+      "nullable": true,
+      "items": {
+        "type": "object",
+        "$ref": "#/definitions/key"
+      }
+    }
+  },
+  "required": [
+    "tm_prioritization",
+    "keys"
+  ],
+  "definitions": {
+    "key": {
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "read": {
+          "type": "boolean"
+        },
+        "write": {
+          "type": "boolean"
+        },
+        "penalty": {
+          "type": "integer",
+          "nullable": true,
+          "maximum": 100,
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "read",
+        "write"
+      ]
+    }
+  }
+}

inc/validation/schema/project_template.json

@@ -11,6 +11,9 @@
     "id_team": {
       "type": ["integer", "string"]
     },
+    "tm_prioritization": {
+      "type": "boolean"
+    },
     "pretranslate_100": {
       "type": "boolean"
     },
@@ -92,6 +95,12 @@
         },
         "w": {
           "type": "boolean"
+        },
+        "penalty": {
+          "type": "integer",
+          "nullable": true,
+          "maximum": 100,
+          "minimum": 0
         }
       }
     },

lib/Controller/API/App/TmKeyManagementController.php

@@ -31,10 +31,11 @@ public function getByJob(){
             exit();
         }
 
+        $job_keyList = json_decode( $chunk->tm_keys, true );
+
         if(!$this->isLoggedIn()){
 
             $tmKeys = [];
-            $job_keyList = json_decode( $chunk->tm_keys, true );
 
             foreach ( $job_keyList as $jobKey ) {
                 $jobKey = new TmKeyManagement_ClientTmKeyStruct( $jobKey );
@@ -63,7 +64,7 @@ public function getByJob(){
         $keys = $userKeys->getKeys( $chunk->tm_keys );
 
         $this->response->json( [
-            'tm_keys' => $keys['job_keys']
+            'tm_keys' => $this->sortKeysInTheRightOrder($keys['job_keys'], $job_keyList)
         ] );
     }
 
@@ -76,4 +77,35 @@ public function getByJob(){
     private function isJobRevision($idJob, $password) {
         return CatUtils::getIsRevisionFromIdJobAndPassword( $idJob, $password );
     }
+
+    /**
+     * This function sorts the $keys array based on $job_keyList.
+     * $keys can contain shared and/or hidden keys
+     *
+     * @param $keys
+     * @param $jobKeyList
+     * @return mixed
+     */
+    private function sortKeysInTheRightOrder($keys, $jobKeyList)
+    {
+        $sortedKeys = [];
+
+        foreach ($jobKeyList as $jobKey){
+            $filter = array_filter($keys, function ($key) use($jobKey){
+
+                if($jobKey['key'] === $key->key){
+                    return true;
+                }
+
+                // compare only last 5 chars (hidden keys)
+                return substr($jobKey['key'], -5) === substr($key->key, -5);
+            });
+
+            if(!empty($filter)){
+                $sortedKeys[] = array_values($filter)[0];
+            }
+        }
+
+        return $sortedKeys;
+    }
 }

lib/Controller/API/NewController.php

@@ -53,6 +53,11 @@ class NewController extends ajaxController {
      */
     private $private_tm_key;
 
+    /**
+     * @var array
+     */
+    private $tm_prioritization = false;
+
     private $private_tm_user = null;
     private $private_tm_pass = null;
 
@@ -189,6 +194,7 @@ public function __construct() {
                         'options' => [ 'default' => 1, 'min_range' => 0 ]
                 ],
                 'private_tm_key'             => [ 'filter' => FILTER_SANITIZE_STRING, 'flags' => FILTER_FLAG_STRIP_LOW ],
+                'private_tm_key_json'        => [ 'filter' => FILTER_SANITIZE_STRING, 'flags' => FILTER_FLAG_STRIP_LOW ],
                 'subject'                    => [
                         'filter' => FILTER_SANITIZE_STRING, 'flags' => FILTER_FLAG_STRIP_LOW | FILTER_FLAG_STRIP_HIGH
                 ],
@@ -246,7 +252,7 @@ public function __construct() {
          * Note 2022-10-13
          * ----------------------------------
          *
-         * We trim every space private_tm_key
+         * We trim every space in instructions
          * in order to avoid mispelling errors
          *
          */
@@ -657,21 +663,22 @@ public function doAction() {
         $projectStructure[ 'project_name' ] = $this->postInput[ 'project_name' ];
         $projectStructure[ 'job_subject' ]  = $this->postInput[ 'subject' ];
 
-        $projectStructure[ 'private_tm_key' ]   = $this->private_tm_key;
-        $projectStructure[ 'private_tm_user' ]  = $this->private_tm_user;
-        $projectStructure[ 'private_tm_pass' ]  = $this->private_tm_pass;
-        $projectStructure[ 'uploadToken' ]      = $uploadFile->getDirUploadToken();
-        $projectStructure[ 'array_files' ]      = $arFiles; //list of file name
-        $projectStructure[ 'array_files_meta' ] = $arMeta; //list of file metadata
-        $projectStructure[ 'source_language' ]  = $this->postInput[ 'source_lang' ];
-        $projectStructure[ 'target_language' ]  = explode( ',', $this->postInput[ 'target_lang' ] );
-        $projectStructure[ 'mt_engine' ]        = $this->postInput[ 'mt_engine' ];
-        $projectStructure[ 'tms_engine' ]       = $this->postInput[ 'tms_engine' ];
-        $projectStructure[ 'status' ]           = Constants_ProjectStatus::STATUS_NOT_READY_FOR_ANALYSIS;
-        $projectStructure[ 'owner' ]            = $this->user->email;
-        $projectStructure[ 'metadata' ]         = $this->metadata;
-        $projectStructure[ 'pretranslate_100' ] = (int)!!$this->postInput[ 'pretranslate_100' ]; // Force pretranslate_100 to be 0 or 1
-        $projectStructure[ 'pretranslate_101' ] = isset( $this->postInput[ 'pretranslate_101' ] ) ? (int)$this->postInput[ 'pretranslate_101' ] : 1;
+        $projectStructure[ 'private_tm_key' ]    = $this->private_tm_key;
+        $projectStructure[ 'private_tm_user' ]   = $this->private_tm_user;
+        $projectStructure[ 'private_tm_pass' ]   = $this->private_tm_pass;
+        $projectStructure[ 'uploadToken' ]       = $uploadFile->getDirUploadToken();
+        $projectStructure[ 'array_files' ]       = $arFiles; //list of file name
+        $projectStructure[ 'array_files_meta' ]  = $arMeta; //list of file metadata
+        $projectStructure[ 'source_language' ]   = $this->postInput[ 'source_lang' ];
+        $projectStructure[ 'target_language' ]   = explode( ',', $this->postInput[ 'target_lang' ] );
+        $projectStructure[ 'mt_engine' ]         = $this->postInput[ 'mt_engine' ];
+        $projectStructure[ 'tms_engine' ]        = $this->postInput[ 'tms_engine' ];
+        $projectStructure[ 'tm_prioritization' ] = $this->tm_prioritization;
+        $projectStructure[ 'status' ]            = Constants_ProjectStatus::STATUS_NOT_READY_FOR_ANALYSIS;
+        $projectStructure[ 'owner' ]             = $this->user->email;
+        $projectStructure[ 'metadata' ]          = $this->metadata;
+        $projectStructure[ 'pretranslate_100' ]  = (int)!!$this->postInput[ 'pretranslate_100' ]; // Force pretranslate_100 to be 0 or 1
+        $projectStructure[ 'pretranslate_101' ]  = isset( $this->postInput[ 'pretranslate_101' ] ) ? (int)$this->postInput[ 'pretranslate_101' ] : 1;
 
         $projectStructure[ 'dictation' ]         = $this->postInput[ 'dictation' ] ?? null;
         $projectStructure[ 'show_whitespace' ]   = $this->postInput[ 'show_whitespace' ] ?? null;
@@ -1030,10 +1037,44 @@ private static function __parseTmKeyInput( $tmKeyString ) {
     protected function __validateTmAndKeys() {
 
         try {
-            $this->private_tm_key = array_map(
+            if(!empty($this->postInput[ 'private_tm_key_json' ])){
+                $json = html_entity_decode( $this->postInput[ 'private_tm_key_json' ] );
+
+                // first check if `filters_extraction_parameters` is a valid JSON
+                if ( !Utils::isJson( $json ) ) {
+                    throw new Exception( "filters_extraction_parameters is not a valid JSON" );
+                }
+
+                $schema = file_get_contents( INIT::$ROOT . '/inc/validation/schema/private_tm_key_json.json' );
+
+                $validatorObject       = new JSONValidatorObject();
+                $validatorObject->json = $json;
+
+                $validator = new JSONValidator( $schema );
+                $validator->validate( $validatorObject );
+
+                $privateTmKeyJsonObject = json_decode($json);
+
+                $this->tm_prioritization = $privateTmKeyJsonObject->tm_prioritization;
+
+                $this->private_tm_key = array_map(
+                    function ($item){
+                        return [
+                            'key' => $item->key,
+                            'r' => $item->read,
+                            'w' => $item->write,
+                            'penalty' => $item->penalty,
+                        ];
+                    },
+                    $privateTmKeyJsonObject->keys
+                );
+
+            } else {
+                $this->private_tm_key = array_map(
                     [ 'NewController', '__parseTmKeyInput' ],
                     explode( ",", $this->postInput[ 'private_tm_key' ] )
-            );
+                );
+            }
         } catch ( Exception $e ) {
             throw new Exception( $e->getMessage(), -6 );
         }
@@ -1071,10 +1112,11 @@ protected function __validateTmAndKeys() {
 
                     $this->private_tm_key[ $__key_idx ] =
                             [
-                                    'key'  => $newUser->key,
-                                    'name' => null,
-                                    'r'    => $tm_key[ 'r' ],
-                                    'w'    => $tm_key[ 'w' ]
+                                    'key'     => $newUser->key,
+                                    'name'    => null,
+                                    'penalty' => $tm_key[ 'penalty' ] ?? null,
+                                    'r'       => $tm_key[ 'r' ],
+                                    'w'       => $tm_key[ 'w' ],
 
                             ];
                     $this->new_keys[]                   = $newUser->key;
@@ -1089,10 +1131,11 @@ protected function __validateTmAndKeys() {
                 $uid = $this->user->uid;
 
                 $this_tm_key = [
-                        'key'  => $tm_key[ 'key' ],
-                        'name' => null,
-                        'r'    => $tm_key[ 'r' ],
-                        'w'    => $tm_key[ 'w' ]
+                        'key'     => $tm_key[ 'key' ],
+                        'name'    => null,
+                        'penalty' => $tm_key[ 'penalty' ] ?? null,
+                        'r'       => $tm_key[ 'r' ],
+                        'w'       => $tm_key[ 'w' ]
                 ];
 
                 /**

lib/Controller/API/V3/MetaDataController.php

@@ -46,7 +46,7 @@ private function getProjectInfo( Projects_ProjectStruct $project ) {
 
         foreach ( $project->getMetadata() as $metadatum ) {
             $key            = $metadatum->key;
-            $metadata->$key = $metadatum->getValue();
+            $metadata->$key = is_numeric($metadatum->getValue()) ? (int)$metadatum->getValue() : $metadatum->getValue();
         }
 
         return $metadata;
@@ -64,16 +64,16 @@ private function getJobMetaData( Jobs_JobStruct $job ) {
 
         foreach ( $jobMetaDataDao->getByJobIdAndPassword( $job->id, $job->password, 60 * 5 ) as $metadatum ) {
             $key            = $metadatum->key;
-            $metadata->$key = $metadatum->value;
+            $metadata->$key = is_numeric($metadatum->value) ? (int)$metadatum->value : $metadatum->value;
         }
 
         return $metadata;
     }
 
     /**
      * @param Jobs_JobStruct $job
-     *
      * @return array
+     * @throws \ReflectionException
      */
     private function getJobFilesMetaData( Jobs_JobStruct $job ) {
 
@@ -84,7 +84,7 @@ private function getJobFilesMetaData( Jobs_JobStruct $job ) {
             $metadatum = new stdClass();
             foreach ( $filesMetaDataDao->getByJobIdProjectAndIdFile( $job->getProject()->id, $file->id, 60 * 5 ) as $meta ) {
                 $key             = $meta->key;
-                $metadatum->$key = $meta->value;
+                $metadatum->$key = is_numeric($meta->value) ? (int)$meta->value : $meta->value;
             }
 
             $metadataObject           = new \stdClass();