Merge branch 'HFP-1905-metadata-system' of https://github.com/h5p/h5p-php-library into HFP-1905-metadata-system

h5p-default-storage.class.php

@@ -451,6 +451,19 @@ class H5PDefaultStorage implements \H5PFileStorage {
     return self::dirReady($this->path);
   }
 
+  /**
+   * Check if the file presave.js exists in the root of the library
+   *
+   * @param string $libraryFolder
+   * @param string $developmentPath
+   * @return bool
+   */
+  public function hasPresave($libraryFolder, $developmentPath = null) {
+      $path = is_null($developmentPath) ? 'libraries' . DIRECTORY_SEPARATOR . $libraryFolder : $developmentPath;
+      $filePath = realpath($this->path . DIRECTORY_SEPARATOR . $path . DIRECTORY_SEPARATOR . 'presave.js');
+    return file_exists($filePath);
+  }
+
   /**
    * Recursive function for copying directories.
    *

h5p-file-storage.interface.php

@@ -190,4 +190,13 @@ interface H5PFileStorage {
    * @return bool True if server has the proper write access
    */
   public function hasWriteAccess();
+
+  /**
+   * Check if the library has a presave.js in the root folder
+   *
+   * @param string $libraryName
+   * @param string $developmentPath
+   * @return bool
+   */
+  public function hasPresave($libraryName, $developmentPath = null);
 }

h5p.classes.php

@@ -4168,6 +4168,10 @@ class H5PContentValidator {
                 'value' => 'U',
                 'label' => $this->h5pF->t('Undisclosed')
               ),
+              (object) array(
+                'type' => 'optgroup',
+                'label' => $this->h5pF->t('Creative Commons'),
+                'options' => [
                   (object) array(
                     'value' => 'CC BY',
                     'label' => $this->h5pF->t('CC Attribution'),
@@ -4206,6 +4210,8 @@ class H5PContentValidator {
                     'value' => 'CC PDM',
                     'label' => $this->h5pF->t('Public Domain Mark')
                   ),
+                ]
+              ),
               (object) array(
                 'value' => 'GNU GPL',
                 'label' => $this->h5pF->t('General Public License v3')

js/h5p.js

@@ -2120,9 +2120,187 @@ H5P.createTitle = function (rawTitle, maxLength) {
     contentUserDataAjax(contentId, dataId, subContentId, undefined, null);
   };
 
+  /**
+   * Prepares the content parameters for storing in the clipboard.
+   *
+   * @class
+   * @param {Object} parameters The parameters for the content to store
+   * @param {string} [genericProperty] If only part of the parameters are generic, which part
+   * @param {string} [specificKey] If the parameters are specific, what content type does it fit
+   * @returns {Object} Ready for the clipboard
+   */
+  H5P.ClipboardItem = function (parameters, genericProperty, specificKey) {
+    var self = this;
+
+    /**
+     * Set relative dimensions when params contains a file with a width and a height.
+     * Very useful to be compatible with wysiwyg editors.
+     *
+     * @private
+     */
+    var setDimensionsFromFile = function () {
+      if (!self.generic) {
+        return;
+      }
+      var params = self.specific[self.generic];
+      if (!params.params.file || !params.params.file.width || !params.params.file.height) {
+        return;
+      }
+
+      self.width = 20; // %
+      self.height = (params.params.file.height / params.params.file.width) * self.width;
+    }
+
+    if (!genericProperty) {
+      genericProperty = 'action';
+      parameters = {
+        action: parameters
+      };
+    }
+
+    self.specific = parameters;
+
+    if (genericProperty && parameters[genericProperty]) {
+      self.generic = genericProperty;
+    }
+    if (specificKey) {
+      self.from = specificKey;
+    }
+
+    if (window.H5PEditor && H5PEditor.contentId) {
+      self.contentId = H5PEditor.contentId;
+    }
+
+    if (!self.specific.width && !self.specific.height) {
+      setDimensionsFromFile();
+    }
+  };
+
+  /**
+   * Store item in the H5P Clipboard.
+   *
+   * @param {H5P.ClipboardItem|*} clipboardItem
+   */
+  H5P.clipboardify = function (clipboardItem) {
+    if (!(clipboardItem instanceof H5P.ClipboardItem)) {
+      clipboardItem = new H5P.ClipboardItem(clipboardItem);
+    }
+
+    localStorage.setItem('h5pClipboard', JSON.stringify(clipboardItem));
+
+    // Clear cache
+    parsedClipboard = null;
+
+    // Trigger an event so all 'Paste' buttons may be enabled.
+    H5P.externalDispatcher.trigger('datainclipboard', {reset: false});
+  };
+
+  /**
+   * This is a cache for pasted data to prevent parsing multiple times.
+   * @type {Object}
+   */
+  var parsedClipboard = null;
+
+  /**
+   * Retrieve parsed clipboard data.
+   *
+   * @return {Object}
+   */
+  H5P.getClipboard = function () {
+    if (!parsedClipboard) {
+      parsedClipboard = parseClipboard();
+    }
+
+    return parsedClipboard;
+  }
+
+  /**
+   * Get item from the H5P Clipboard.
+   *
+   * @private
+   * @param {boolean} [skipUpdateFileUrls]
+   * @return {Object}
+   */
+  var parseClipboard = function () {
+    var clipboardData = localStorage.getItem('h5pClipboard');
+    if (!clipboardData) {
+      return;
+    }
+
+    // Try to parse clipboard dat
+    try {
+      clipboardData = JSON.parse(clipboardData);
+    }
+    catch (err) {
+      console.error('Unable to parse JSON from clipboard.', err);
+      return;
+    }
+
+    // Update file URLs
+    updateFileUrls(clipboardData.specific, function (path) {
+      var isTmpFile = (path.substr(-4, 4) === '#tmp');
+      if (!isTmpFile && clipboardData.contentId) {
+        // Comes from existing content
+
+        if (H5PEditor.contentId) {
+          // .. to existing content
+          return '../' + clipboardData.contentId + '/' + path;
+        }
+        else {
+          // .. to new content
+          return (H5PEditor.contentRelUrl ? H5PEditor.contentRelUrl : '../content/') + clipboardData.contentId + '/' + path;
+        }
+      }
+      return path; // Will automatically be looked for in tmp folder
+    });
+
+
+    if (clipboardData.generic) {
+      // Use reference instead of key
+      clipboardData.generic = clipboardData.specific[clipboardData.generic];
+
+      // Avoid multiple content with same ID
+      delete clipboardData.generic.subContentId;
+    }
+
+    return clipboardData;
+  };
+
+  /**
+   * Update file URLs. Useful when copying content.
+   *
+   * @private
+   * @param {object} params Reference
+   * @param {function} handler Modifies the path to work when pasted
+   */
+  var updateFileUrls = function (params, handler) {
+    for (var prop in params) {
+      if (params.hasOwnProperty(prop) && params[prop] instanceof Object) {
+        var obj = params[prop];
+        if (obj.path !== undefined && obj.mime !== undefined) {
+          obj.path = handler(obj.path);
+        }
+        else {
+          updateFileUrls(obj, handler);
+        }
+      }
+    }
+  };
+
   // Init H5P when page is fully loadded
   $(document).ready(function () {
 
+    window.addEventListener('storage', function (event) {
+      // Pick up clipboard changes from other tabs
+      if (event.key === 'h5pClipboard') {
+        // Clear cache
+        parsedClipboard = null;
+
+        // Trigger an event so all 'Paste' buttons may be enabled.
+        H5P.externalDispatcher.trigger('datainclipboard', {reset: event.newValue === null});
+      }
+    });
+
     var ccVersions = {
       'default': '4.0',
       '4.0': H5P.t('licenseCC40'),