From 04707a9f8ace4db2491127e6ebb20f0bf26e33dd Mon Sep 17 00:00:00 2001
From: Oliver Tacke <o.tacke@posteo.de>
Date: Wed, 13 Jun 2018 18:36:23 +0200
Subject: [PATCH 01/25] HFP-1871 Add function to load MathDisplay if params
 contain math

---
 h5p.classes.php | 60 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 59 insertions(+), 1 deletion(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index 2efebbd..b160abd 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1770,7 +1770,7 @@ abstract class H5PHubEndpoints {
  * Functions and storage shared by the other H5P classes
  */
 class H5PCore {
-  
+
   public static $coreApi = array(
     'majorVersion' => 1,
     'minorVersion' => 16
@@ -1938,6 +1938,14 @@ class H5PCore {
     }
     $validator->validateLibrary($params, (object) array('options' => array($params->library)));
 
+    // Add MathDisplay.
+    // TODO: Get library name for MathDisplay dynamically
+    // TODO: Get regexp from MathDisplay config
+    // TODO: Find out how to pass settings to MathDisplay
+    if ($this->containsMath($params->params)) {
+      $validator->addMathDisplay('H5P.MathDisplay 0.1');
+    }
+
     $params = json_encode($params->params);
 
     // Update content dependencies.
@@ -1970,6 +1978,39 @@ class H5PCore {
     return $params;
   }
 
+  /**
+   * Determine if params contain math.
+   *
+   * @param {object} params - Parameters.
+   * @param {string} [mathPattern] - Regular expression to identify math.
+   * @param {boolean} [found] - Used for recursion.
+   * @return {boolean} True, if params contain math.
+   */
+  private function containsMath ($params, $mathPattern = '/\$\$.+\$\$|\\\[.+\\\]|\\\(.+\\\)/', $found = false) {
+    foreach($params as $property => $value) {
+      if (gettype($value) === 'string') {
+        if (preg_match($mathPattern, $value) === 1) {
+          $found = true;
+          break;
+        }
+      }
+      if ($found === false) {
+        if (gettype($value) === 'array') {
+          for ($i = 0; $i < sizeof($value); $i++) {
+            $found = $this->containsMath($value[$i], $mathPattern, $found);
+            if ($found === true) {
+              break;
+            }
+          }
+        }
+        if (gettype($value) === 'object') {
+          $found = $this->containsMath($value, $mathPattern, $found);
+        }
+      }
+    }
+    return $found;
+  }
+
   /**
    * Generate content slug
    *
@@ -3204,6 +3245,23 @@ class H5PContentValidator {
     $this->dependencies = array();
   }
 
+  /**
+   * Add MathDisplay.
+   */
+  public function addMathDisplay($libraryName) {
+    $libSpec = H5PCore::libraryFromString($libraryName);
+    $library = $this->h5pC->loadLibrary($libSpec['machineName'], $libSpec['majorVersion'], $libSpec['minorVersion']);
+    $library['semantics'] = $this->h5pC->loadLibrarySemantics($libSpec['machineName'], $libSpec['majorVersion'], $libSpec['minorVersion']);
+
+    $depKey = 'preloaded-' . $library['machineName'];
+    $this->dependencies[$depKey] = array(
+      'library' => $library,
+      'type' => 'preloaded'
+    );
+    $this->nextWeight = $this->h5pC->findLibraryDependencies($this->dependencies, $library, $this->nextWeight);
+    $this->dependencies[$depKey]['weight'] = $this->nextWeight++;
+  }
+
   /**
    * Get the flat dependency tree.
    *

From 62b6345c497b9740834257b243382a64a20811cc Mon Sep 17 00:00:00 2001
From: Oliver Tacke <o.tacke@posteo.de>
Date: Wed, 25 Jul 2018 15:08:29 +0200
Subject: [PATCH 02/25] HFP-1871 Use param from MathDisplay library.json for
 configuration

---
 h5p.classes.php | 40 ++++++++++++++++++++++++++++++++++------
 1 file changed, 34 insertions(+), 6 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index b160abd..a61cb61 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1938,12 +1938,37 @@ class H5PCore {
     }
     $validator->validateLibrary($params, (object) array('options' => array($params->library)));
 
-    // Add MathDisplay.
-    // TODO: Get library name for MathDisplay dynamically
-    // TODO: Get regexp from MathDisplay config
+    // Add latest MathDisplay version if content contains math
     // TODO: Find out how to pass settings to MathDisplay
-    if ($this->containsMath($params->params)) {
-      $validator->addMathDisplay('H5P.MathDisplay 0.1');
+    $libs = $this->h5pF->loadLibraries();
+
+    // Get latest version of MathDisplay library
+    $mathLibs = $libs['H5P.MathDisplay'];
+    foreach($mathLibs as $libVersion) {
+      if ($libVersion->major_version === $majorMax && $libVersion->minor_version > $minorMax) {
+        $mathLib = $libVersion;
+      }
+      else if ($libVersion->major_version > $majorMax) {
+        $mathLib = $libVersion;
+      }
+    }
+
+    if (isset($mathLib)) {
+      // Retrieve regular expression from library.json
+      // Careful: \ will have to be escaped itself inside json
+      $libParams = $this->loadLibrary($mathLib->name, $mathLib->major_version, $mathLib->minor_version);
+      // Is there a general function to pass a "path" to that finds a parameter?
+      $libParamsTypes = $libParams['addTo']['content']['types'];
+      foreach($libParamsTypes as $type => $property) {
+        $regex = $property['text']['regex'];
+        if (isset($regex)) {
+          break;
+        }
+      }
+
+      if ($this->containsMath($params->params, $regex)) {
+        $validator->addMathDisplay($mathLib->name . ' ' . $mathLib->major_version . '.' . $mathLib->minor_version);
+      }
     }
 
     $params = json_encode($params->params);
@@ -1986,7 +2011,10 @@ class H5PCore {
    * @param {boolean} [found] - Used for recursion.
    * @return {boolean} True, if params contain math.
    */
-  private function containsMath ($params, $mathPattern = '/\$\$.+\$\$|\\\[.+\\\]|\\\(.+\\\)/', $found = false) {
+  private function containsMath ($params, $mathPattern, $found = false) {
+    if (!isset($mathPattern) == NULL) {
+      $mathPattern = '/\$\$.+\$\$|\\\[.+\\\]|\\\(.+\\\)/';
+    }
     foreach($params as $property => $value) {
       if (gettype($value) === 'string') {
         if (preg_match($mathPattern, $value) === 1) {

From 942fd922bc40166e58ab5a4a85e93ac5e0665576 Mon Sep 17 00:00:00 2001
From: Oliver Tacke <o.tacke@posteo.de>
Date: Thu, 26 Jul 2018 10:37:16 +0200
Subject: [PATCH 03/25] HFP-1871 Add general function to get values from
 library json config

---
 h5p.classes.php | 53 ++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 44 insertions(+), 9 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index a61cb61..f56a284 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1939,7 +1939,6 @@ class H5PCore {
     $validator->validateLibrary($params, (object) array('options' => array($params->library)));
 
     // Add latest MathDisplay version if content contains math
-    // TODO: Find out how to pass settings to MathDisplay
     $libs = $this->h5pF->loadLibraries();
 
     // Get latest version of MathDisplay library
@@ -1957,14 +1956,7 @@ class H5PCore {
       // Retrieve regular expression from library.json
       // Careful: \ will have to be escaped itself inside json
       $libParams = $this->loadLibrary($mathLib->name, $mathLib->major_version, $mathLib->minor_version);
-      // Is there a general function to pass a "path" to that finds a parameter?
-      $libParamsTypes = $libParams['addTo']['content']['types'];
-      foreach($libParamsTypes as $type => $property) {
-        $regex = $property['text']['regex'];
-        if (isset($regex)) {
-          break;
-        }
-      }
+      $regex = $this->retrieveValue($libParams, 'addTo.content.types.text.regex');
 
       if ($this->containsMath($params->params, $regex)) {
         $validator->addMathDisplay($mathLib->name . ' ' . $mathLib->major_version . '.' . $mathLib->minor_version);
@@ -2003,6 +1995,49 @@ class H5PCore {
     return $params;
   }
 
+  /**
+   * Retrieve a value from a nested mixed array structure.
+   *
+   * @param Array $params Array to be looked in.
+   * @param String $path Supposed path to the value.
+   * @param String [$delimiter='.'] Property delimiter within the path.
+   * @return Object|NULL The object found or NULL.
+   */
+  private function retrieveValue ($params, $path, $delimiter='.') {
+    $path = explode($delimiter, $path);
+
+    // Property not found
+    if (!isset($params[$path[0]])) {
+      return NULL;
+    }
+
+    $first = $params[$path[0]];
+
+    // End of path, done
+    if (sizeof($path) === 1) {
+      return $first;
+    }
+
+    // We cannot go deeper
+    if (!is_array($first)) {
+      return NULL;
+    }
+
+    // Regular Array
+    if (isset($first[0])) {
+      foreach($first as $number => $object) {
+        $found = $this->retrieveValue($object, implode($delimiter, array_slice($path, 1)));
+        if (isset($found)) {
+          return $found;
+        }
+      }
+      return NULL;
+    }
+
+    // Associative Array
+    return $this->retrieveValue($first, implode('.', array_slice($path, 1)));
+  }
+
   /**
    * Determine if params contain math.
    *

From 9314c55994783c58bfb023d23954102bae0cfed9 Mon Sep 17 00:00:00 2001
From: Oliver Tacke <o.tacke@posteo.de>
Date: Thu, 26 Jul 2018 19:34:46 +0200
Subject: [PATCH 04/25] HFP-1871 Clean code

---
 h5p.classes.php | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index f56a284..78d6d06 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1938,10 +1938,8 @@ class H5PCore {
     }
     $validator->validateLibrary($params, (object) array('options' => array($params->library)));
 
-    // Add latest MathDisplay version if content contains math
-    $libs = $this->h5pF->loadLibraries();
-
     // Get latest version of MathDisplay library
+    $libs = $this->h5pF->loadLibraries();
     $mathLibs = $libs['H5P.MathDisplay'];
     foreach($mathLibs as $libVersion) {
       if ($libVersion->major_version === $majorMax && $libVersion->minor_version > $minorMax) {
@@ -1952,6 +1950,7 @@ class H5PCore {
       }
     }
 
+    // Add latest MathDisplay version if content contains math
     if (isset($mathLib)) {
       // Retrieve regular expression from library.json
       // Careful: \ will have to be escaped itself inside json

From d068b82ff56f4bad1cc870b7696e0cad833204ea Mon Sep 17 00:00:00 2001
From: Oliver Tacke <o.tacke@posteo.de>
Date: Mon, 30 Jul 2018 14:52:36 +0200
Subject: [PATCH 05/25] HFP-1871 Fix sanitization of containsMath

---
 h5p.classes.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index 78d6d06..3478f23 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -2046,7 +2046,7 @@ class H5PCore {
    * @return {boolean} True, if params contain math.
    */
   private function containsMath ($params, $mathPattern, $found = false) {
-    if (!isset($mathPattern) == NULL) {
+    if (!isset($mathPattern)) {
       $mathPattern = '/\$\$.+\$\$|\\\[.+\\\]|\\\(.+\\\)/';
     }
     foreach($params as $property => $value) {

From 64e5ab442437fcee36a733523224737b4e09f8bd Mon Sep 17 00:00:00 2001
From: Oliver Tacke <o.tacke@posteo.de>
Date: Wed, 1 Aug 2018 10:55:13 +0200
Subject: [PATCH 06/25] HFP-1871 Fix missing variables

---
 h5p.classes.php | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index 3478f23..2aeee76 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1941,12 +1941,18 @@ class H5PCore {
     // Get latest version of MathDisplay library
     $libs = $this->h5pF->loadLibraries();
     $mathLibs = $libs['H5P.MathDisplay'];
+
+    $majorMax = '0';
+    $minorMax = '0';
     foreach($mathLibs as $libVersion) {
-      if ($libVersion->major_version === $majorMax && $libVersion->minor_version > $minorMax) {
+      if ($libVersion->major_version === $majorMax && $libVersion->minor_version >= $minorMax) {
         $mathLib = $libVersion;
+        $minorMax = $libVersion->minor_version;
       }
       else if ($libVersion->major_version > $majorMax) {
         $mathLib = $libVersion;
+        $majorMax = $libVersion->major_version;
+        $minorMax = $libVersion->minor_version;
       }
     }
 

From 6c4f904079ccbefbd6c3b4ac805b60dc264a2b39 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Thu, 23 Aug 2018 10:24:20 +0200
Subject: [PATCH 07/25] Generalize addons

---
 h5p.classes.php | 63 +++++++++++++++++++++++--------------------------
 1 file changed, 29 insertions(+), 34 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index 2aeee76..04249fc 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -101,6 +101,13 @@ interface H5PFrameworkInterface {
    */
   public function getUploadedH5pPath();
 
+  /**
+   * Load addon libraries
+   *
+   * @return array
+   */
+  public function loadAddons();
+
   /**
    * Get a list of the current installed libraries
    *
@@ -1609,7 +1616,7 @@ Class H5PExport {
               $library['minorVersion']
           );
 
-          if ($isDevLibrary !== NULL) {
+          if ($isDevLibrary !== NULL && isset($library['path'])) {
             $exportFolder = "/" . $library['path'];
           }
         }
@@ -1938,33 +1945,20 @@ class H5PCore {
     }
     $validator->validateLibrary($params, (object) array('options' => array($params->library)));
 
-    // Get latest version of MathDisplay library
-    $libs = $this->h5pF->loadLibraries();
-    $mathLibs = $libs['H5P.MathDisplay'];
+    // Handle addons:
+    $addons = $this->h5pF->loadAddons();
+    foreach ($addons as $addon) {
+      $add_to = json_decode($addon['addTo']);
 
-    $majorMax = '0';
-    $minorMax = '0';
-    foreach($mathLibs as $libVersion) {
-      if ($libVersion->major_version === $majorMax && $libVersion->minor_version >= $minorMax) {
-        $mathLib = $libVersion;
-        $minorMax = $libVersion->minor_version;
-      }
-      else if ($libVersion->major_version > $majorMax) {
-        $mathLib = $libVersion;
-        $majorMax = $libVersion->major_version;
-        $minorMax = $libVersion->minor_version;
-      }
-    }
+      if (isset($add_to->content->types)) {
+        foreach($add_to->content->types as $type) {
+          if ($this->textAddonMatches($params->params, $type->text->regex)) {
+            $validator->addon($addon);
 
-    // Add latest MathDisplay version if content contains math
-    if (isset($mathLib)) {
-      // Retrieve regular expression from library.json
-      // Careful: \ will have to be escaped itself inside json
-      $libParams = $this->loadLibrary($mathLib->name, $mathLib->major_version, $mathLib->minor_version);
-      $regex = $this->retrieveValue($libParams, 'addTo.content.types.text.regex');
-
-      if ($this->containsMath($params->params, $regex)) {
-        $validator->addMathDisplay($mathLib->name . ' ' . $mathLib->major_version . '.' . $mathLib->minor_version);
+            // Addon can only be added once
+            break;
+          }
+        }
       }
     }
 
@@ -2051,7 +2045,7 @@ class H5PCore {
    * @param {boolean} [found] - Used for recursion.
    * @return {boolean} True, if params contain math.
    */
-  private function containsMath ($params, $mathPattern, $found = false) {
+  private function textAddonMatches($params, $mathPattern, $found = false) {
     if (!isset($mathPattern)) {
       $mathPattern = '/\$\$.+\$\$|\\\[.+\\\]|\\\(.+\\\)/';
     }
@@ -2065,14 +2059,14 @@ class H5PCore {
       if ($found === false) {
         if (gettype($value) === 'array') {
           for ($i = 0; $i < sizeof($value); $i++) {
-            $found = $this->containsMath($value[$i], $mathPattern, $found);
+            $found = $this->textAddonMatches($value[$i], $mathPattern, $found);
             if ($found === true) {
               break;
             }
           }
         }
         if (gettype($value) === 'object') {
-          $found = $this->containsMath($value, $mathPattern, $found);
+          $found = $this->textAddonMatches($value, $mathPattern, $found);
         }
       }
     }
@@ -3314,12 +3308,13 @@ class H5PContentValidator {
   }
 
   /**
-   * Add MathDisplay.
+   * Add Addon library.
    */
-  public function addMathDisplay($libraryName) {
-    $libSpec = H5PCore::libraryFromString($libraryName);
-    $library = $this->h5pC->loadLibrary($libSpec['machineName'], $libSpec['majorVersion'], $libSpec['minorVersion']);
-    $library['semantics'] = $this->h5pC->loadLibrarySemantics($libSpec['machineName'], $libSpec['majorVersion'], $libSpec['minorVersion']);
+  public function addon($library) {
+    // We need to run loadLibrarySemantics even if we have loadeed semantics from db, in case of
+    // 1) development foler
+    // 2) Invocation of semantics alter hook
+    $library['semantics'] = $this->h5pC->loadLibrarySemantics($library['machineName'], $library['majorVersion'], $library['minorVersion']);
 
     $depKey = 'preloaded-' . $library['machineName'];
     $this->dependencies[$depKey] = array(

From 0c7df179a7a348c8387859311a8c0d8164ad9002 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Fri, 24 Aug 2018 12:55:42 +0200
Subject: [PATCH 08/25] Fix content upgrade bug

---
 h5p.classes.php                   |  2 +-
 js/h5p-content-upgrade-process.js |  2 +-
 js/h5p-content-upgrade.js         | 11 +++++------
 3 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index d9b4e4b..df958b0 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1806,7 +1806,7 @@ class H5PCore {
 
   public static $coreApi = array(
     'majorVersion' => 1,
-    'minorVersion' => 16
+    'minorVersion' => 19
   );
   public static $styles = array(
     'styles/h5p.css',
diff --git a/js/h5p-content-upgrade-process.js b/js/h5p-content-upgrade-process.js
index 81e55de..5277eb6 100644
--- a/js/h5p-content-upgrade-process.js
+++ b/js/h5p-content-upgrade-process.js
@@ -26,7 +26,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
 
     // Make extras possible to work with
     for (var element in extras) {
-      if (extras.hasOwnProperty(element)) {
+      if (extras[element] !== undefined) {
         try {
           extras[element] = JSON.parse(extras[element]);
           if (!(extras[element] instanceof Object)) {
diff --git a/js/h5p-content-upgrade.js b/js/h5p-content-upgrade.js
index 564a0a8..de17fc1 100644
--- a/js/h5p-content-upgrade.js
+++ b/js/h5p-content-upgrade.js
@@ -248,10 +248,9 @@
     self.current++;
     self.working++;
 
-    // Rewrap metadata
-    if (self.extras.metadata) {
-      self.extras.metadata = self.extras.metadata[id];
-    }
+    var extras = {
+      metadata: (self.extras.metadata && self.extras.metadata[id]) ? self.extras.metadata[id] : undefined
+    };
 
     if (worker) {
       worker.postMessage({
@@ -261,11 +260,11 @@
         oldVersion: info.library.version,
         newVersion: self.version.toString(),
         params: self.parameters[id],
-        extras: self.extras
+        extras: extras
       });
     }
     else {
-      new H5P.ContentUpgradeProcess(info.library.name, new Version(info.library.version), self.version, self.parameters[id], self.extras, id, function loadLibrary(name, version, next) {
+      new H5P.ContentUpgradeProcess(info.library.name, new Version(info.library.version), self.version, self.parameters[id], extras, id, function loadLibrary(name, version, next) {
         self.loadLibrary(name, version, function (err, library) {
           if (library.upgradesScript) {
             self.loadScript(library.upgradesScript, function (err) {

From ee0e97e17b04830424757cc2dc2b63c660df71ae Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 27 Aug 2018 13:52:33 +0200
Subject: [PATCH 09/25] HFP-1871 Skip loading semantics for addons

---
 h5p.classes.php | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index 04249fc..22bf9ea 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -3311,11 +3311,6 @@ class H5PContentValidator {
    * Add Addon library.
    */
   public function addon($library) {
-    // We need to run loadLibrarySemantics even if we have loadeed semantics from db, in case of
-    // 1) development foler
-    // 2) Invocation of semantics alter hook
-    $library['semantics'] = $this->h5pC->loadLibrarySemantics($library['machineName'], $library['majorVersion'], $library['minorVersion']);
-
     $depKey = 'preloaded-' . $library['machineName'];
     $this->dependencies[$depKey] = array(
       'library' => $library,

From 6959f65022ca2b217d6ae0a614ce799a9f5e1101 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 27 Aug 2018 14:53:17 +0200
Subject: [PATCH 10/25] HFP-1871 Add library config as a generic feature

---
 h5p.classes.php |  8 ++++++++
 js/h5p.js       | 11 +++++++++++
 2 files changed, 19 insertions(+)

diff --git a/h5p.classes.php b/h5p.classes.php
index 511bf5b..134ffdb 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -108,6 +108,14 @@ interface H5PFrameworkInterface {
    */
   public function loadAddons();
 
+  /**
+   * Load config for libraries
+   *
+   * @param array $libraries
+   * @return array
+   */
+  public function getLibraryConfig($libraries = NULL);
+
   /**
    * Get a list of the current installed libraries
    *
diff --git a/js/h5p.js b/js/h5p.js
index f10df8f..38f6022 100644
--- a/js/h5p.js
+++ b/js/h5p.js
@@ -2242,6 +2242,17 @@ H5P.createTitle = function (rawTitle, maxLength) {
     H5P.externalDispatcher.trigger('datainclipboard', {reset: false});
   };
 
+  /**
+   * Get config for a library
+   *
+   * @param string machineName
+   * @return Object
+   */
+  H5P.getLibraryConfig = function (machineName) {
+    var hasConfig = H5PIntegration.libraryConfig && H5PIntegration.libraryConfig[machineName];
+    return hasConfig ? H5PIntegration.libraryConfig[machineName] : {};
+  };
+
   /**
    * Get item from the H5P Clipboard.
    *

From 8c374be79d3c13f75f561b567832697625f43abd Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Tue, 28 Aug 2018 08:08:56 +0200
Subject: [PATCH 11/25] HFP-1871 Improve addon feature

---
 h5p.classes.php | 46 +++++++++++++++++++---------------------------
 1 file changed, 19 insertions(+), 27 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index 134ffdb..6f48f53 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1993,10 +1993,12 @@ class H5PCore {
 
       if (isset($add_to->content->types)) {
         foreach($add_to->content->types as $type) {
-          if ($this->textAddonMatches($params->params, $type->text->regex)) {
+
+          if (isset($type->text->regex) &&
+              $this->textAddonMatches($params->params, $type->text->regex)) {
             $validator->addon($addon);
 
-            // Addon can only be added once
+            // An addon shall only be added once
             break;
           }
         }
@@ -2079,39 +2081,29 @@ class H5PCore {
   }
 
   /**
-   * Determine if params contain math.
+   * Determine if params contain any match.
    *
    * @param {object} params - Parameters.
-   * @param {string} [mathPattern] - Regular expression to identify math.
+   * @param {string} [pattern] - Regular expression to identify pattern.
    * @param {boolean} [found] - Used for recursion.
-   * @return {boolean} True, if params contain math.
+   * @return {boolean} True, if params matches pattern.
    */
-  private function textAddonMatches($params, $mathPattern, $found = false) {
-    if (!isset($mathPattern)) {
-      $mathPattern = '/\$\$.+\$\$|\\\[.+\\\]|\\\(.+\\\)/';
-    }
-    foreach($params as $property => $value) {
-      if (gettype($value) === 'string') {
-        if (preg_match($mathPattern, $value) === 1) {
-          $found = true;
-          break;
-        }
+  private function textAddonMatches($params, $pattern, $found = false) {
+    $type = gettype($params);
+    if ($type === 'string') {
+      if (preg_match($pattern, $params) === 1) {
+        return true;
       }
-      if ($found === false) {
-        if (gettype($value) === 'array') {
-          for ($i = 0; $i < sizeof($value); $i++) {
-            $found = $this->textAddonMatches($value[$i], $mathPattern, $found);
-            if ($found === true) {
-              break;
-            }
-          }
-        }
-        if (gettype($value) === 'object') {
-          $found = $this->textAddonMatches($value, $mathPattern, $found);
+    }
+    elseif ($type === 'array' || $type === 'object') {
+      foreach ($params as $value) {
+        $found = $this->textAddonMatches($value, $pattern, $found);
+        if ($found === true) {
+          return true;
         }
       }
     }
-    return $found;
+    return false;
   }
 
   /**

From 768eb2a64bd268b74f7c7da2de50347e858efd9b Mon Sep 17 00:00:00 2001
From: Frode Petterson <frode.andre.petterson@gmail.com>
Date: Wed, 29 Aug 2018 14:30:31 +0200
Subject: [PATCH 12/25] Remove unkown todo comment

---
 h5p.classes.php | 1 -
 1 file changed, 1 deletion(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index 6f48f53..35be986 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -3682,7 +3682,6 @@ class H5PContentValidator {
 
     if (isset($file->copyright)) {
       $this->validateGroup($file->copyright, $this->getCopyrightSemantics());
-      // TODO: We'll need to do something here about getMetadataSemantics() if we change the widgets
     }
   }
 

From e094da76fa545a152f969707b2647e1b0050166d Mon Sep 17 00:00:00 2001
From: Frode Petterson <frode.andre.petterson@gmail.com>
Date: Thu, 30 Aug 2018 12:33:24 +0200
Subject: [PATCH 13/25] HFP-1900 Remove metadata/extras from upgrade for main
 content

---
 js/h5p-content-upgrade-process.js | 71 +++++++++++--------------------
 js/h5p-content-upgrade-worker.js  |  7 ++-
 js/h5p-content-upgrade.js         | 25 ++++-------
 3 files changed, 36 insertions(+), 67 deletions(-)

diff --git a/js/h5p-content-upgrade-process.js b/js/h5p-content-upgrade-process.js
index 5277eb6..3562d6d 100644
--- a/js/h5p-content-upgrade-process.js
+++ b/js/h5p-content-upgrade-process.js
@@ -7,7 +7,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
    * @class
    * @namespace H5P
    */
-  function ContentUpgradeProcess(name, oldVersion, newVersion, params, extras, id, loadLibrary, done) {
+  function ContentUpgradeProcess(name, oldVersion, newVersion, params, id, loadLibrary, done) {
     var self = this;
 
     // Make params possible to work with
@@ -24,38 +24,28 @@ H5P.ContentUpgradeProcess = (function (Version) {
       });
     }
 
-    // Make extras possible to work with
-    for (var element in extras) {
-      if (extras[element] !== undefined) {
-        try {
-          extras[element] = JSON.parse(extras[element]);
-          if (!(extras[element] instanceof Object)) {
-            throw true;
-          }
-        }
-        catch (event) {
-          return done({
-            type: 'errorExtrasBroken',
-            id: id
-          });
-        }
-      }
-    }
-
     self.loadLibrary = loadLibrary;
-    self.upgrade(name, oldVersion, newVersion, params, extras, function (err, result) {
+    self.upgrade(name, oldVersion, newVersion, params, function (err, upgradedParams) {
       if (err) {
         return done(err);
       }
 
-      done(null, JSON.stringify(params), JSON.stringify(extras));
+      done(null, JSON.stringify(upgradedParams));
     });
   }
 
   /**
+   * Run content upgrade.
    *
+   * @public
+   * @param {string} name
+   * @param {Version} oldVersion
+   * @param {Version} newVersion
+   * @param {Object} params Only for subcontent
+   * @param {Function} done Only for subcontent
+   * @param {Object} [metadata] Only for subcontent
    */
-  ContentUpgradeProcess.prototype.upgrade = function (name, oldVersion, newVersion, params, extras, done) {
+  ContentUpgradeProcess.prototype.upgrade = function (name, oldVersion, newVersion, params, done, metadata) {
     var self = this;
 
     // Load library details and upgrade routines
@@ -65,7 +55,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
       }
 
       // Run upgrade routines on params
-      self.processParams(library, oldVersion, newVersion, params, extras, function (err, params, extras) {
+      self.processParams(library, oldVersion, newVersion, params, metadata, function (err, params, metadata) {
         if (err) {
           return done(err);
         }
@@ -79,7 +69,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
             next(err);
           });
         }, function (err) {
-          done(err, params, extras);
+          done(err, params, metadata);
         });
       });
     });
@@ -95,7 +85,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
    * @param {Object} params
    * @param {Function} next
    */
-  ContentUpgradeProcess.prototype.processParams = function (library, oldVersion, newVersion, params, extras, next) {
+  ContentUpgradeProcess.prototype.processParams = function (library, oldVersion, newVersion, params, metadata, next) {
     if (H5PUpgrades[library.name] === undefined) {
       if (library.upgradesScript) {
         // Upgrades script should be loaded so the upgrades should be here.
@@ -130,17 +120,11 @@ H5P.ContentUpgradeProcess = (function (Version) {
             try {
               unnecessaryWrapper(params, function (err, upgradedParams, upgradedExtras) {
                 params = upgradedParams;
-                /**
-                 * "params" (and "extras", e.g. metadata) flow through each update function and are changed
-                 * if necessary. Since "extras" was added later and old update functions don't return
-                 * it, we need to ignore undefined values here -- or change every single update function
-                 * in all content types.
-                 */
-                if (upgradedExtras) {
-                  extras = upgradedExtras;
+                if (upgradedExtras && upgradedExtras.metadata) { // Optional
+                  metadata = upgradedExtras.metadata;
                 }
                 nextMinor(err);
-              }, extras);
+              }, {metadata: metadata});
             }
             catch (err) {
               if (console && console.log) {
@@ -154,7 +138,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
         }, nextMajor);
       }
     }, function (err) {
-      next(err, params, extras);
+      next(err, params, metadata);
     });
   };
 
@@ -195,24 +179,17 @@ H5P.ContentUpgradeProcess = (function (Version) {
               return done(); // Larger or same version that's available
             }
 
-            // Currently, we only use metadata as additional things that might need change
-            var extras = {
-              metadata: params.metadata
-            };
-
             // A newer version is available, upgrade params
-            return self.upgrade(availableLib[0], usedVer, availableVer, params.params, extras, function (err, upgraded, extras) {
+            return self.upgrade(availableLib[0], usedVer, availableVer, params.params, function (err, upgradedParams, upgradedMetadata) {
               if (!err) {
                 params.library = availableLib[0] + ' ' + availableVer.major + '.' + availableVer.minor;
-                params.params = upgraded;
-                if (extras) {
-                  if (extras.metadata) {
-                    params.metadata = extras.metadata;
-                  }
+                params.params = upgradedParams;
+                if (upgradedMetadata) {
+                  params.metadata = upgradedMetadata;
                 }
               }
               done(err, params);
-            });
+            }, params.metadata);
           }
         }
         done();
diff --git a/js/h5p-content-upgrade-worker.js b/js/h5p-content-upgrade-worker.js
index af0be94..26ad038 100644
--- a/js/h5p-content-upgrade-worker.js
+++ b/js/h5p-content-upgrade-worker.js
@@ -9,7 +9,7 @@ var libraryLoadedCallback;
 var messageHandlers = {
   newJob: function (job) {
     // Start new job
-    new H5P.ContentUpgradeProcess(job.name, new H5P.Version(job.oldVersion), new H5P.Version(job.newVersion), job.params, job.extras, job.id, function loadLibrary(name, version, next) {
+    new H5P.ContentUpgradeProcess(job.name, new H5P.Version(job.oldVersion), new H5P.Version(job.newVersion), job.params, job.id, function loadLibrary(name, version, next) {
       // TODO: Cache?
       postMessage({
         action: 'loadLibrary',
@@ -17,7 +17,7 @@ var messageHandlers = {
         version: version.toString()
       });
       libraryLoadedCallback = next;
-    }, function done(err, result, extras) {
+    }, function done(err, result) {
       if (err) {
         // Return error
         postMessage({
@@ -33,8 +33,7 @@ var messageHandlers = {
       postMessage({
         action: 'done',
         id: job.id,
-        params: result,
-        extras: extras
+        params: result
       });
     });
   },
diff --git a/js/h5p-content-upgrade.js b/js/h5p-content-upgrade.js
index de17fc1..9c1e4ce 100644
--- a/js/h5p-content-upgrade.js
+++ b/js/h5p-content-upgrade.js
@@ -116,7 +116,7 @@
     // Register message handlers
     var messageHandlers = {
       done: function (result) {
-        self.workDone(result.id, result.params, result.extras, this);
+        self.workDone(result.id, result.params, this);
       },
       error: function (error) {
         self.printError(error.err);
@@ -184,7 +184,7 @@
       self.token = inData.token;
 
       // Start processing
-      self.processBatch(inData.params, {metadata: inData.metadata});
+      self.processBatch(inData.params);
     });
   };
 
@@ -202,7 +202,7 @@
    *
    * @param {Object} parameters
    */
-  ContentUpgrade.prototype.processBatch = function (parameters, extras) {
+  ContentUpgrade.prototype.processBatch = function (parameters) {
     var self = this;
 
     // Track upgraded params
@@ -210,7 +210,6 @@
 
     // Track current batch
     self.parameters = parameters;
-    self.extras = extras;
 
     // Create id mapping
     self.ids = [];
@@ -248,10 +247,6 @@
     self.current++;
     self.working++;
 
-    var extras = {
-      metadata: (self.extras.metadata && self.extras.metadata[id]) ? self.extras.metadata[id] : undefined
-    };
-
     if (worker) {
       worker.postMessage({
         action: 'newJob',
@@ -259,12 +254,11 @@
         name: info.library.name,
         oldVersion: info.library.version,
         newVersion: self.version.toString(),
-        params: self.parameters[id],
-        extras: extras
+        params: self.parameters[id]
       });
     }
     else {
-      new H5P.ContentUpgradeProcess(info.library.name, new Version(info.library.version), self.version, self.parameters[id], extras, id, function loadLibrary(name, version, next) {
+      new H5P.ContentUpgradeProcess(info.library.name, new Version(info.library.version), self.version, self.parameters[id], id, function loadLibrary(name, version, next) {
         self.loadLibrary(name, version, function (err, library) {
           if (library.upgradesScript) {
             self.loadScript(library.upgradesScript, function (err) {
@@ -279,13 +273,13 @@
           }
         });
 
-      }, function done(err, result, extras) {
+      }, function done(err, result) {
         if (err) {
           self.printError(err);
           return ;
         }
 
-        self.workDone(id, result, extras);
+        self.workDone(id, result);
       });
     }
   };
@@ -293,7 +287,7 @@
   /**
    *
    */
-  ContentUpgrade.prototype.workDone = function (id, result, extras, worker) {
+  ContentUpgrade.prototype.workDone = function (id, result, worker) {
     var self = this;
 
     self.working--;
@@ -308,8 +302,7 @@
       self.nextBatch({
         libraryId: self.version.libraryId,
         token: self.token,
-        params: JSON.stringify(self.upgraded),
-        extras: extras
+        params: JSON.stringify(self.upgraded)
       });
     }
   };

From e74fb6009ac980f4bb8f768865784cba33e22e7a Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Thu, 30 Aug 2018 12:35:46 +0200
Subject: [PATCH 14/25] Use title from metadata object when creating xAPI stmt

---
 js/h5p-x-api-event.js |  6 +++---
 js/h5p.js             | 14 ++++++++++++++
 2 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/js/h5p-x-api-event.js b/js/h5p-x-api-event.js
index c1d6c66..4cec937 100644
--- a/js/h5p-x-api-event.js
+++ b/js/h5p-x-api-event.js
@@ -133,9 +133,10 @@ H5P.XAPIEvent.prototype.setObject = function (instance) {
       }
     }
     else {
-      if (H5PIntegration && H5PIntegration.contents && H5PIntegration.contents['cid-' + instance.contentId].title) {
+      var content = H5P.getContentForInstance(instance.contentId);
+      if (content && content.metadata && content.metadata.title) {
         this.data.statement.object.definition.name = {
-          "en-US": H5P.createTitle(H5PIntegration.contents['cid-' + instance.contentId].title)
+          "en-US": H5P.createTitle(content.metadata.title)
         };
       }
     }
@@ -150,7 +151,6 @@ H5P.XAPIEvent.prototype.setObject = function (instance) {
  */
 H5P.XAPIEvent.prototype.setContext = function (instance) {
   if (instance.parent && (instance.parent.contentId || instance.parent.subContentId)) {
-    var parentId = instance.parent.subContentId === undefined ? instance.parent.contentId : instance.parent.subContentId;
     this.data.statement.context = {
       "contextActivities": {
         "parent": [
diff --git a/js/h5p.js b/js/h5p.js
index 38f6022..4330ade 100644
--- a/js/h5p.js
+++ b/js/h5p.js
@@ -2140,6 +2140,20 @@ H5P.createTitle = function (rawTitle, maxLength) {
     contentUserDataAjax(contentId, dataId, subContentId, undefined, null);
   };
 
+  /**
+   * Function for getting content for a certain ID
+   *
+   * @param {number} contentId
+   * @return {Object}
+   */
+  H5P.getContentForInstance = function (contentId) {
+    var key = 'cid-' + contentId;
+    var exists = H5PIntegration && H5PIntegration.contents &&
+                 H5PIntegration.contents[key];
+
+    return exists ? H5PIntegration.contents[key] : undefined;
+  };
+
   /**
    * Prepares the content parameters for storing in the clipboard.
    *

From 775b45ab6c5733e7d52c5cf352b60bebe4913297 Mon Sep 17 00:00:00 2001
From: Oliver Tacke <o.tacke@posteo.de>
Date: Fri, 31 Aug 2018 09:32:23 +0200
Subject: [PATCH 15/25] HFP-2094 Add metadata property to validation of
 library.json

---
 h5p.classes.php | 1 +
 1 file changed, 1 insertion(+)

diff --git a/h5p.classes.php b/h5p.classes.php
index 6f48f53..024235c 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -680,6 +680,7 @@ class H5PValidator {
     'author' => '/^.{1,255}$/',
     'license' => '/^(cc-by|cc-by-sa|cc-by-nd|cc-by-nc|cc-by-nc-sa|cc-by-nc-nd|pd|cr|MIT|GPL1|GPL2|GPL3|MPL|MPL2)$/',
     'description' => '/^.{1,}$/',
+    'metadata' => '/^(0|1)$/',
     'dynamicDependencies' => array(
       'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
       'majorVersion' => '/^[0-9]{1,5}$/',

From 97eab5c3ced65375ccfc48752a0fd9e762080f6e Mon Sep 17 00:00:00 2001
From: Frode Petterson <frode.andre.petterson@gmail.com>
Date: Fri, 31 Aug 2018 17:28:43 +0200
Subject: [PATCH 16/25] JI-848 Add changing main content metadata in upgrade

(except for title!)
---
 js/h5p-content-upgrade-process.js | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/js/h5p-content-upgrade-process.js b/js/h5p-content-upgrade-process.js
index 3562d6d..d50a09c 100644
--- a/js/h5p-content-upgrade-process.js
+++ b/js/h5p-content-upgrade-process.js
@@ -25,12 +25,12 @@ H5P.ContentUpgradeProcess = (function (Version) {
     }
 
     self.loadLibrary = loadLibrary;
-    self.upgrade(name, oldVersion, newVersion, params, function (err, upgradedParams) {
+    self.upgrade(name, oldVersion, newVersion, params.params, params.metadata, function (err, upgradedParams, upgradedMetadata) {
       if (err) {
         return done(err);
       }
 
-      done(null, JSON.stringify(upgradedParams));
+      done(null, JSON.stringify({params: upgradedParams, metadata: upgradedMetadata}));
     });
   }
 
@@ -41,11 +41,11 @@ H5P.ContentUpgradeProcess = (function (Version) {
    * @param {string} name
    * @param {Version} oldVersion
    * @param {Version} newVersion
-   * @param {Object} params Only for subcontent
-   * @param {Function} done Only for subcontent
-   * @param {Object} [metadata] Only for subcontent
+   * @param {Object} params
+   * @param {Object} metadata
+   * @param {Function} done
    */
-  ContentUpgradeProcess.prototype.upgrade = function (name, oldVersion, newVersion, params, done, metadata) {
+  ContentUpgradeProcess.prototype.upgrade = function (name, oldVersion, newVersion, params, metadata, done) {
     var self = this;
 
     // Load library details and upgrade routines
@@ -180,7 +180,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
             }
 
             // A newer version is available, upgrade params
-            return self.upgrade(availableLib[0], usedVer, availableVer, params.params, function (err, upgradedParams, upgradedMetadata) {
+            return self.upgrade(availableLib[0], usedVer, availableVer, params.params, params.metadata, function (err, upgradedParams, upgradedMetadata) {
               if (!err) {
                 params.library = availableLib[0] + ' ' + availableVer.major + '.' + availableVer.minor;
                 params.params = upgradedParams;
@@ -189,7 +189,7 @@ H5P.ContentUpgradeProcess = (function (Version) {
                 }
               }
               done(err, params);
-            }, params.metadata);
+            });
           }
         }
         done();

From e257e5ecff7e1a6478662b17ddce7198e8850109 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 10 Sep 2018 11:30:57 +0200
Subject: [PATCH 17/25] HFP-2185 Treat major & minor version as int (not
 string)

---
 js/h5p.js | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/js/h5p.js b/js/h5p.js
index 4330ade..42f9519 100644
--- a/js/h5p.js
+++ b/js/h5p.js
@@ -1657,8 +1657,8 @@ H5P.libraryFromString = function (library) {
   if (res !== null) {
     return {
       'machineName': res[1],
-      'majorVersion': res[2],
-      'minorVersion': res[3]
+      'majorVersion': parseInt(res[2]),
+      'minorVersion': parseInt(res[3])
     };
   }
   else {

From 425aac5d33a1fd4d1c14a2211e57948991b7bce4 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Tue, 11 Sep 2018 11:50:51 +0200
Subject: [PATCH 18/25] HFP-2183 Set metadata when saving library

---
 h5p-development.class.php | 3 +++
 h5p.classes.php           | 4 ++++
 2 files changed, 7 insertions(+)

diff --git a/h5p-development.class.php b/h5p-development.class.php
index 6c891f9..4188d88 100644
--- a/h5p-development.class.php
+++ b/h5p-development.class.php
@@ -86,6 +86,9 @@ class H5PDevelopment {
 
       // Save/update library.
       $library['libraryId'] = $this->h5pF->getLibraryId($library['machineName'], $library['majorVersion'], $library['minorVersion']);
+      if (!isset($library['metadata'])) {
+        $library['metadata'] = 0;
+      }
       $this->h5pF->saveLibraryData($library, $library['libraryId'] === FALSE);
 
       $library['path'] = 'development/' . $contents[$i];
diff --git a/h5p.classes.php b/h5p.classes.php
index e4a5608..a93d8a4 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -210,6 +210,7 @@ interface H5PFrameworkInterface {
    *   - minorVersion: The library's minorVersion
    *   - patchVersion: The library's patchVersion
    *   - runnable: 1 if the library is a content type, 0 otherwise
+   *   - metadata: 1 if the library should support setting metadata (copyright etc)
    *   - fullscreen(optional): 1 if the library supports fullscreen, 0 otherwise
    *   - embedTypes(optional): list of supported embed types
    *   - preloadedJs(optional): list of associative arrays containing:
@@ -1440,6 +1441,9 @@ class H5PStorage {
       $library['saveDependencies'] = TRUE;
 
       // Save library meta data
+      if (!isset($library['metadata'])) {
+        $library['metadata'] = 0;
+      }
       $this->h5pF->saveLibraryData($library, $new);
 
       // Save library folder

From 8067277e63804b8241acf46774b006627271bdca Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 17 Sep 2018 08:41:31 +0200
Subject: [PATCH 19/25] JI-857 Add support for optgroup type in semantics

---
 h5p.classes.php | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index a93d8a4..a3c5dca 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -3555,8 +3555,17 @@ class H5PContentValidator {
       // We have a strict set of options to choose from.
       $strict = TRUE;
       $options = array();
+
       foreach ($semantics->options as $option) {
-        $options[$option->value] = TRUE;
+        // Support optgroup - just flatten options into one
+        if (isset($option->type) && $option->type === 'optgroup') {
+          foreach ($option->options as $suboption) {
+            $options[$suboption->value] = TRUE;
+          }
+        }
+        elseif (isset($option->value)) {
+          $options[$option->value] = TRUE;
+        }
       }
     }
 

From 74f9a8403414bbfa14024a24d7373f2e4adc280c Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 17 Sep 2018 08:45:18 +0200
Subject: [PATCH 20/25] JI-857 Make metadata semantics describe the actual data
 structure

---
 h5p.classes.php | 319 +++++++++++++++++++++++-------------------------
 1 file changed, 153 insertions(+), 166 deletions(-)

diff --git a/h5p.classes.php b/h5p.classes.php
index a3c5dca..4c22804 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -4284,155 +4284,152 @@ class H5PContentValidator {
       )
     );
 
-    $semantics = (object) array(
+    $semantics = array(
       (object) array(
-        'name' => 'copyright',
-        'type' => 'group',
-        'label' => $this->h5pF->t('Copyright information'),
-        'fields' => array(
+        'name' => 'title',
+        'type' => 'text',
+        'label' => $this->h5pF->t('Title'),
+        'placeholder' => 'La Gioconda'
+      ),
+      (object) array(
+        'name' => 'license',
+        'type' => 'select',
+        'label' => $this->h5pF->t('License'),
+        'default' => 'U',
+        'options' => array(
           (object) array(
-            'name' => 'title',
-            'type' => 'text',
-            'label' => $this->h5pF->t('Title'),
-            'placeholder' => 'La Gioconda'
+            'value' => 'U',
+            'label' => $this->h5pF->t('Undisclosed')
           ),
           (object) array(
-            'name' => 'license',
-            'type' => 'select',
-            'label' => $this->h5pF->t('License'),
-            'default' => 'U',
-            'options' => array(
+            'type' => 'optgroup',
+            'label' => $this->h5pF->t('Creative Commons'),
+            'options' => [
               (object) array(
-                'value' => 'U',
-                'label' => $this->h5pF->t('Undisclosed')
+                'value' => 'CC BY',
+                'label' => $this->h5pF->t('Attribution (CC BY)'),
+                'versions' => $cc_versions
               ),
               (object) array(
-                'type' => 'optgroup',
-                'label' => $this->h5pF->t('Creative Commons'),
-                'options' => [
-                  (object) array(
-                    'value' => 'CC BY',
-                    'label' => $this->h5pF->t('Attribution (CC BY)'),
-                    'versions' => $cc_versions
-                  ),
-                  (object) array(
-                    'value' => 'CC BY-SA',
-                    'label' => $this->h5pF->t('Attribution-ShareAlike (CC BY-SA)'),
-                    'versions' => $cc_versions
-                  ),
-                  (object) array(
-                    'value' => 'CC BY-ND',
-                    'label' => $this->h5pF->t('Attribution-NoDerivs (CC BY-ND)'),
-                    'versions' => $cc_versions
-                  ),
-                  (object) array(
-                    'value' => 'CC BY-NC',
-                    'label' => $this->h5pF->t('Attribution-NonCommercial (CC BY-NC)'),
-                    'versions' => $cc_versions
-                  ),
-                  (object) array(
-                    'value' => 'CC BY-NC-SA',
-                    'label' => $this->h5pF->t('Attribution-NonCommercial-ShareAlike (CC BY-NC-SA)'),
-                    'versions' => $cc_versions
-                  ),
-                  (object) array(
-                    'value' => 'CC BY-NC-ND',
-                    'label' => $this->h5pF->t('Attribution-NonCommercial-NoDerivs (CC BY-NC-ND)'),
-                    'versions' => $cc_versions
-                  ),
-                  (object) array(
-                    'value' => 'CC0 1.0',
-                    'label' => $this->h5pF->t('Public Domain Dedication (CC0)')
-                  ),
-                  (object) array(
-                    'value' => 'CC PDM',
-                    'label' => $this->h5pF->t('Public Domain Mark (PDM)')
-                  ),
-                ]
+                'value' => 'CC BY-SA',
+                'label' => $this->h5pF->t('Attribution-ShareAlike (CC BY-SA)'),
+                'versions' => $cc_versions
               ),
               (object) array(
-                'value' => 'GNU GPL',
-                'label' => $this->h5pF->t('General Public License v3')
+                'value' => 'CC BY-ND',
+                'label' => $this->h5pF->t('Attribution-NoDerivs (CC BY-ND)'),
+                'versions' => $cc_versions
               ),
               (object) array(
-                'value' => 'PD',
-                'label' => $this->h5pF->t('Public Domain')
+                'value' => 'CC BY-NC',
+                'label' => $this->h5pF->t('Attribution-NonCommercial (CC BY-NC)'),
+                'versions' => $cc_versions
               ),
               (object) array(
-                'value' => 'ODC PDDL',
-                'label' => $this->h5pF->t('Public Domain Dedication and Licence')
+                'value' => 'CC BY-NC-SA',
+                'label' => $this->h5pF->t('Attribution-NonCommercial-ShareAlike (CC BY-NC-SA)'),
+                'versions' => $cc_versions
               ),
               (object) array(
-                'value' => 'C',
-                'label' => $this->h5pF->t('Copyright')
-              )
-            )
+                'value' => 'CC BY-NC-ND',
+                'label' => $this->h5pF->t('Attribution-NonCommercial-NoDerivs (CC BY-NC-ND)'),
+                'versions' => $cc_versions
+              ),
+              (object) array(
+                'value' => 'CC0 1.0',
+                'label' => $this->h5pF->t('Public Domain Dedication (CC0)')
+              ),
+              (object) array(
+                'value' => 'CC PDM',
+                'label' => $this->h5pF->t('Public Domain Mark (PDM)')
+              ),
+            ]
           ),
           (object) array(
-            'name' => 'licenseVersion',
-            'type' => 'select',
-            'label' => $this->h5pF->t('License Version'),
-            'options' => array(),
-            'optional' => TRUE
+            'value' => 'GNU GPL',
+            'label' => $this->h5pF->t('General Public License v3')
           ),
           (object) array(
-            'name' => 'yearFrom',
-            'type' => 'number',
-            'label' => $this->h5pF->t('Years (from)'),
-            'placeholder' => '1991',
-            'min' => '-9999',
-            'max' => '9999',
-            'optional' => TRUE
+            'value' => 'PD',
+            'label' => $this->h5pF->t('Public Domain')
           ),
           (object) array(
-            'name' => 'yearTo',
-            'type' => 'number',
-            'label' => $this->h5pF->t('Years (to)'),
-            'placeholder' => '1992',
-            'min' => '-9999',
-            'max' => '9999',
-            'optional' => TRUE
+            'value' => 'ODC PDDL',
+            'label' => $this->h5pF->t('Public Domain Dedication and Licence')
           ),
           (object) array(
-            'name' => 'source',
-            'type' => 'text',
-            'label' => $this->h5pF->t('Source'),
-            'placeholder' => 'https://',
-            'optional' => TRUE
+            'value' => 'C',
+            'label' => $this->h5pF->t('Copyright')
           )
         )
       ),
       (object) array(
-        'name' => 'authorWidget',
-        'type' => 'group',
-        'fields'=> array(
-          (object) array(
-            'label' => $this->h5pF->t("Author's name"),
-            'name' => "name",
-            'optional' => TRUE,
-            'type' => "text"
-          ),
-          (object) array(
-            'name' => 'role',
-            'type' => 'select',
-            'label' => $this->h5pF->t("Author's role"),
-            'default' => 'Author',
-            'options' => array(
-              (object) array(
-                'value' => 'Author',
-                'label' => $this->h5pF->t('Author')
-              ),
-              (object) array(
-                'value' => 'Editor',
-                'label' => $this->h5pF->t('Editor')
-              ),
-              (object) array(
-                'value' => 'Licensee',
-                'label' => $this->h5pF->t('Licensee')
-              ),
-              (object) array(
-                'value' => 'Originator',
-                'label' => $this->h5pF->t('Originator')
+        'name' => 'licenseVersion',
+        'type' => 'select',
+        'label' => $this->h5pF->t('License Version'),
+        'options' => $cc_versions,
+        'optional' => TRUE
+      ),
+      (object) array(
+        'name' => 'yearFrom',
+        'type' => 'number',
+        'label' => $this->h5pF->t('Years (from)'),
+        'placeholder' => '1991',
+        'min' => '-9999',
+        'max' => '9999',
+        'optional' => TRUE
+      ),
+      (object) array(
+        'name' => 'yearTo',
+        'type' => 'number',
+        'label' => $this->h5pF->t('Years (to)'),
+        'placeholder' => '1992',
+        'min' => '-9999',
+        'max' => '9999',
+        'optional' => TRUE
+      ),
+      (object) array(
+        'name' => 'source',
+        'type' => 'text',
+        'label' => $this->h5pF->t('Source'),
+        'placeholder' => 'https://',
+        'optional' => TRUE
+      ),
+      (object) array(
+        'name' => 'authors',
+        'type' => 'list',
+        'field' => (object) array (
+          'name' => 'author',
+          'type' => 'group',
+          'fields'=> array(
+            (object) array(
+              'label' => $this->h5pF->t("Author's name"),
+              'name' => 'name',
+              'optional' => TRUE,
+              'type' => 'text'
+            ),
+            (object) array(
+              'name' => 'role',
+              'type' => 'select',
+              'label' => $this->h5pF->t("Author's role"),
+              'default' => 'Author',
+              'options' => array(
+                (object) array(
+                  'value' => 'Author',
+                  'label' => $this->h5pF->t('Author')
+                ),
+                (object) array(
+                  'value' => 'Editor',
+                  'label' => $this->h5pF->t('Editor')
+                ),
+                (object) array(
+                  'value' => 'Licensee',
+                  'label' => $this->h5pF->t('Licensee')
+                ),
+                (object) array(
+                  'value' => 'Originator',
+                  'label' => $this->h5pF->t('Originator')
+                )
               )
             )
           )
@@ -4440,60 +4437,50 @@ class H5PContentValidator {
       ),
       (object) array(
         'name' => 'licenseExtras',
-        'type' => 'textarea',
+        'type' => 'text',
+        'widget' => 'textarea',
         'label' => $this->h5pF->t('License Extras'),
         'optional' => TRUE,
         'description' => $this->h5pF->t('Any additional information about the license')
       ),
       (object) array(
-        'name' => 'changeLog',
-        'type' => 'group',
-        'expanded' => FALSE,
-        'label' => $this->h5pF->t('Change Log'),
-        'fields' => array(
-          (object) array (
-            'name' => 'changeLogForm',
-            'type' => 'group',
-            'label' => $this->h5pF->t('Question'),
-            'expanded' => TRUE,
-            'fields' => array(
-              (object) array(
-                'name' => 'date',
-                'type' => 'text',
-                'label' => $this->h5pF->t('Date'),
-                'optional' => TRUE
-              ),
-              (object) array(
-                'name' => 'author',
-                'type' => 'text',
-                'label' => $this->h5pF->t('Changed by'),
-                'optional' => TRUE
-              ),
-              (object) array(
-                'name' => 'log',
-                'type' => 'textarea',
-                'label' => $this->h5pF->t('Description of change'),
-                'placeholder' => $this->h5pF->t('Photo cropped, text changed, etc.'),
-                'optional' => TRUE
-              )
+        'name' => 'changes',
+        'type' => 'list',
+        'field' => (object) array(
+          'name' => 'change',
+          'type' => 'group',
+          'label' => $this->h5pF->t('Change Log'),
+          'fields' => array(
+            (object) array(
+              'name' => 'date',
+              'type' => 'text',
+              'label' => $this->h5pF->t('Date'),
+              'optional' => TRUE
+            ),
+            (object) array(
+              'name' => 'author',
+              'type' => 'text',
+              'label' => $this->h5pF->t('Changed by'),
+              'optional' => TRUE
+            ),
+            (object) array(
+              'name' => 'log',
+              'type' => 'text',
+              'widget' => 'textarea',
+              'label' => $this->h5pF->t('Description of change'),
+              'placeholder' => $this->h5pF->t('Photo cropped, text changed, etc.'),
+              'optional' => TRUE
             )
           )
         )
       ),
-      (object) array(
+      (object) array (
         'name' => 'authorComments',
-        'label' => $this->h5pF->t('Additional Information'),
-        'type' => 'group',
-        'expanded' => FALSE,
-        'fields' => array(
-          (object) array (
-            'name' => 'authorComments',
-            'type' => 'textarea',
-            'label' => $this->h5pF->t('Author comments'),
-            'description' => $this->h5pF->t('Comments for the editor of the content (This text will not be published as a part of copyright info)'),
-            'optional' => TRUE
-          )
-        )
+        'type' => 'text',
+        'widget' => 'textarea',
+        'label' => $this->h5pF->t('Author comments'),
+        'description' => $this->h5pF->t('Comments for the editor of the content (This text will not be published as a part of copyright info)'),
+        'optional' => TRUE
       )
     );
 

From 4fe8eca0f2fdd6848edbadbb0b535fb7c73c70c3 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 17 Sep 2018 08:58:38 +0200
Subject: [PATCH 21/25] JI-857 Validate metadata

---
 h5p.classes.php | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/h5p.classes.php b/h5p.classes.php
index 4c22804..659f224 100644
--- a/h5p.classes.php
+++ b/h5p.classes.php
@@ -1939,6 +1939,10 @@ class H5PCore {
     $content = $this->h5pF->loadContent($id);
 
     if ($content !== NULL) {
+      // Validate main content's metadata
+      $validator = new H5PContentValidator($this->h5pF, $this);
+      $validator->validateMetadata($content['metadata']);
+
       $content['library'] = array(
         'id' => $content['libraryId'],
         'name' => $content['libraryName'],
@@ -3367,6 +3371,21 @@ class H5PContentValidator {
     return $this->dependencies;
   }
 
+  /**
+   * Validate metadata
+   *
+   * @param array $metadata
+   */
+  public function validateMetadata(&$metadata) {
+    $semantics = $this->getMetadataSemantics();
+
+    $group = (object)$metadata;
+    $this->validateGroup($group, (object) array(
+      'type' => 'group',
+      'fields' => $semantics,
+    ), FALSE);
+  }
+
   /**
    * Validate given text value against text semantics.
    * @param $text
@@ -3883,10 +3902,17 @@ class H5PContentValidator {
       $library = $this->libraries[$value->library];
     }
 
+    // Validate parameters
     $this->validateGroup($value->params, (object) array(
       'type' => 'group',
       'fields' => $library['semantics'],
     ), FALSE);
+
+    // Validate subcontent's metadata
+    if (isset($value->metadata)) {
+      $this->validateMetadata($value->metadata);
+    }
+
     $validKeys = array('library', 'params', 'subContentId', 'metadata');
     if (isset($semantics->extraAttributes)) {
       $validKeys = array_merge($validKeys, $semantics->extraAttributes);

From eb766b0081cd75bf5303f6f6bb75481b4778608c Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 17 Sep 2018 11:47:05 +0200
Subject: [PATCH 22/25] HFP-2184 Add utility class for handling metadata

---
 h5p-metadata.class.php | 84 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 h5p-metadata.class.php

diff --git a/h5p-metadata.class.php b/h5p-metadata.class.php
new file mode 100644
index 0000000..b60158f
--- /dev/null
+++ b/h5p-metadata.class.php
@@ -0,0 +1,84 @@
+<?php
+/**
+ * Utility class for handling metadata
+ */
+abstract class H5PMetadata {
+
+  const FIELDS = array(
+    'authors' => array(
+      'type' => 'json'
+    ),
+    'changes' => array(
+      'type' => 'json'
+    ),
+    'source' => array(
+      'type' => 'text',
+      'maxLength' => 255
+    ),
+    'license' => array(
+      'type' => 'text',
+      'maxLength' => 32
+    ),
+    'licenseVersion' => array(
+      'type' => 'text',
+      'maxLength' => 10
+    ),
+    'licenseExtras' => array(
+      'type' => 'text',
+      'maxLength' => 5000
+    ),
+    'authorComments' => array(
+      'type' => 'text',
+      'maxLength' => 5000
+    ),
+    'yearFrom' => array(
+      'type' => 'int'
+    ),
+    'yearTo' => array(
+      'type' => 'int'
+    )
+  );
+
+  /**
+   * Make the metadata into an associative array keyed by the property names
+   * @param mixed $metadata Array or object containing metadata
+   * @return array
+   */
+  public static function toDBArray($metadata, &$types = array()) {
+    $fields = array();
+
+    if (!is_array($metadata)) {
+      $metadata = (array) $metadata;
+    }
+
+    foreach (self::FIELDS as $key => $config) {
+      if (isset($metadata[$key])) {
+        $value = $metadata[$key];
+        $db_field_name = strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $key));
+
+        switch ($config['type']) {
+          case 'text':
+            if (strlen($value) > $config['maxLength']) {
+              $value = mb_substr($value, 0, $config['maxLength']);
+            }
+            $types[] = '%s';
+            break;
+
+          case 'int':
+            $value = ($value !== null) ? intval($value): null;
+            $types[] = '%i';
+            break;
+
+          case 'json':
+            $value = json_encode($value);
+            $types[] = '%s';
+            break;
+        }
+
+        $fields[$db_field_name] = $value;
+      }
+    }
+
+    return $fields;
+  }
+}

From 3d1c1cbe38a0febedd3076c901693a31c461f634 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 17 Sep 2018 12:53:09 +0200
Subject: [PATCH 23/25] Autoload metadata class

---
 composer.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/composer.json b/composer.json
index fac6c53..9b1cc88 100644
--- a/composer.json
+++ b/composer.json
@@ -28,7 +28,8 @@
           "h5p-development.class.php",
           "h5p-file-storage.interface.php",
           "h5p-default-storage.class.php",
-          "h5p-event-base.class.php"
+          "h5p-event-base.class.php",
+          "h5p-metadata.class.php"
         ]
     }
 }

From 2bf38c5b005b0752789e503bab11db17f5a2f41b Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 17 Sep 2018 12:54:21 +0200
Subject: [PATCH 24/25] Support title in metadata

---
 h5p-metadata.class.php | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/h5p-metadata.class.php b/h5p-metadata.class.php
index b60158f..eb0f529 100644
--- a/h5p-metadata.class.php
+++ b/h5p-metadata.class.php
@@ -5,6 +5,10 @@
 abstract class H5PMetadata {
 
   const FIELDS = array(
+    'title' => array(
+      'type' => 'text',
+      'maxLength' => 255
+    ),
     'authors' => array(
       'type' => 'json'
     ),
@@ -42,9 +46,11 @@ abstract class H5PMetadata {
   /**
    * Make the metadata into an associative array keyed by the property names
    * @param mixed $metadata Array or object containing metadata
+   * @param bool $include_title
+   * @param array $types
    * @return array
    */
-  public static function toDBArray($metadata, &$types = array()) {
+  public static function toDBArray($metadata, $include_title = true, &$types = array()) {
     $fields = array();
 
     if (!is_array($metadata)) {
@@ -52,6 +58,11 @@ abstract class H5PMetadata {
     }
 
     foreach (self::FIELDS as $key => $config) {
+
+      if ($key === 'title' && !$include_title) {
+        continue;
+      }
+
       if (isset($metadata[$key])) {
         $value = $metadata[$key];
         $db_field_name = strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $key));

From c9cb23e06c65ef2d703e76dcf9fca63016d32981 Mon Sep 17 00:00:00 2001
From: Paal Joergensen <pal.jorgensen@gmail.com>
Date: Mon, 17 Sep 2018 13:44:42 +0200
Subject: [PATCH 25/25] Add generic function for generating metadata JSON

---
 h5p-metadata.class.php | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/h5p-metadata.class.php b/h5p-metadata.class.php
index eb0f529..efff0cf 100644
--- a/h5p-metadata.class.php
+++ b/h5p-metadata.class.php
@@ -43,6 +43,28 @@ abstract class H5PMetadata {
     )
   );
 
+  /**
+   * JSON encode metadata
+   *
+   * @param object $content
+   * @return string
+   */
+  public static function toJSON($content) {
+    // Note: deliberatly creating JSON string "manually" to improve performance
+    return
+      '{"title":' . (isset($content->title) ? json_encode($content->title) : 'null') .
+      ',"authors":' . (isset($content->authors) ? $content->authors : 'null') .
+      ',"source":' . (isset($content->source) ? '"' . $content->source . '"' : 'null') .
+      ',"license":' . (isset($content->license) ? '"' . $content->license . '"' : 'null') .
+      ',"licenseVersion":' . (isset($content->license_version) ? '"' . $content->license_version . '"' : 'null') .
+      ',"licenseExtras":' . (isset($content->license_extras) ? json_encode($content->license_extras) : 'null') .
+      ',"yearFrom":' . (isset($content->year_from) ? $content->year_from : 'null') .
+      ',"yearTo":' .  (isset($content->year_to) ? $content->year_to : 'null') .
+      ',"changes":' . (isset($content->changes) ? $content->changes : 'null') .
+      ',"authorComments":' . (isset($content->author_comments) ? json_encode($content->author_comments) : 'null') . '}';
+  }
+
+
   /**
    * Make the metadata into an associative array keyed by the property names
    * @param mixed $metadata Array or object containing metadata