Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
- Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
- PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/h5p/h5plib/v124/joubel/core/ -> h5p.classes.php (source)
<?php
namespace Moodle;
use ZipArchive;
/**
* Interface defining functions the h5p library needs the framework to implement
*/
interface H5PFrameworkInterface {
/**
* Returns info for the current platform
*
* @return array
* An associative array containing:
* - name: The name of the platform, for instance "Wordpress"
* - version: The version of the platform, for instance "4.0"
* - h5pVersion: The version of the H5P plugin/module
*/
public function getPlatformInfo();
/**
* Fetches a file from a remote server using HTTP GET
*
* @param string $url Where you want to get or send data.
* @param array $data Data to post to the URL.
* @param bool $blocking Set to 'FALSE' to instantly time out (fire and forget).
* @param string $stream Path to where the file should be saved.
< * @return string The content (response body). NULL if something went wrong
> * @param bool $fullData Return additional response data such as headers and potentially other data
> * @param array $headers Headers to send
> * @param array $files Files to send
> * @param string $method
> *
> * @return string|array The content (response body), or an array with data. NULL if something went wrong
*/
< public function fetchExternalData($url, $data = NULL, $blocking = TRUE, $stream = NULL);
> public function fetchExternalData($url, $data = NULL, $blocking = TRUE, $stream = NULL, $fullData = FALSE, $headers = array(), $files = array(), $method = 'POST');
/**
* Set the tutorial URL for a library. All versions of the library is set
*
* @param string $machineName
* @param string $tutorialUrl
*/
public function setLibraryTutorialUrl($machineName, $tutorialUrl);
/**
* Show the user an error message
*
* @param string $message The error message
* @param string $code An optional code
*/
public function setErrorMessage($message, $code = NULL);
/**
* Show the user an information message
*
* @param string $message
* The error message
*/
public function setInfoMessage($message);
/**
* Return messages
*
* @param string $type 'info' or 'error'
* @return string[]
*/
public function getMessages($type);
/**
* Translation function
*
* @param string $message
* The english string to be translated.
* @param array $replacements
* An associative array of replacements to make after translation. Incidences
* of any key in this array are replaced with the corresponding value. Based
* on the first character of the key, the value is escaped and/or themed:
* - !variable: inserted as is
* - @variable: escape plain text to HTML
* - %variable: escape text and theme as a placeholder for user-submitted
* content
* @return string Translated string
* Translated string
*/
public function t($message, $replacements = array());
/**
* Get URL to file in the specific library
* @param string $libraryFolderName
* @param string $fileName
* @return string URL to file
*/
public function getLibraryFileUrl($libraryFolderName, $fileName);
/**
* Get the Path to the last uploaded h5p
*
* @return string
* Path to the folder where the last uploaded h5p for this session is located.
*/
public function getUploadedH5pFolderPath();
/**
* Get the path to the last uploaded h5p file
*
* @return string
* Path to the last uploaded h5p
*/
public function getUploadedH5pPath();
/**
* Load addon libraries
*
* @return array
*/
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
*
* @return array
* Associative array containing one entry per machine name.
* For each machineName there is a list of libraries(with different versions)
*/
public function loadLibraries();
/**
* Returns the URL to the library admin page
*
* @return string
* URL to admin page
*/
public function getAdminUrl();
/**
* Get id to an existing library.
* If version number is not specified, the newest version will be returned.
*
* @param string $machineName
* The librarys machine name
* @param int $majorVersion
* Optional major version number for library
* @param int $minorVersion
* Optional minor version number for library
* @return int
* The id of the specified library or FALSE
*/
public function getLibraryId($machineName, $majorVersion = NULL, $minorVersion = NULL);
/**
* Get file extension whitelist
*
* The default extension list is part of h5p, but admins should be allowed to modify it
*
* @param boolean $isLibrary
* TRUE if this is the whitelist for a library. FALSE if it is the whitelist
* for the content folder we are getting
* @param string $defaultContentWhitelist
* A string of file extensions separated by whitespace
* @param string $defaultLibraryWhitelist
* A string of file extensions separated by whitespace
*/
public function getWhitelist($isLibrary, $defaultContentWhitelist, $defaultLibraryWhitelist);
/**
* Is the library a patched version of an existing library?
*
* @param object $library
* An associative array containing:
* - machineName: The library machineName
* - majorVersion: The librarys majorVersion
* - minorVersion: The librarys minorVersion
* - patchVersion: The librarys patchVersion
* @return boolean
* TRUE if the library is a patched version of an existing library
* FALSE otherwise
*/
public function isPatchedLibrary($library);
/**
* Is H5P in development mode?
*
* @return boolean
* TRUE if H5P development mode is active
* FALSE otherwise
*/
public function isInDevMode();
/**
* Is the current user allowed to update libraries?
*
* @return boolean
* TRUE if the user is allowed to update libraries
* FALSE if the user is not allowed to update libraries
*/
public function mayUpdateLibraries();
/**
* Store data about a library
*
* Also fills in the libraryId in the libraryData object if the object is new
*
* @param object $libraryData
* Associative array containing:
* - libraryId: The id of the library if it is an existing library.
* - title: The library's name
* - machineName: The library machineName
* - majorVersion: The library's majorVersion
* - minorVersion: The library's minorVersion
* - patchVersion: The library's patchVersion
* - runnable: 1 if the library is a content type, 0 otherwise
* - metadataSettings: Associative array containing:
* - disable: 1 if the library should not support setting metadata (copyright etc)
* - disableExtraTitleField: 1 if the library don't need the extra title field
* - fullscreen(optional): 1 if the library supports fullscreen, 0 otherwise
* - embedTypes(optional): list of supported embed types
* - preloadedJs(optional): list of associative arrays containing:
* - path: path to a js file relative to the library root folder
* - preloadedCss(optional): list of associative arrays containing:
* - path: path to css file relative to the library root folder
* - dropLibraryCss(optional): list of associative arrays containing:
* - machineName: machine name for the librarys that are to drop their css
* - semantics(optional): Json describing the content structure for the library
* - language(optional): associative array containing:
* - languageCode: Translation in json format
* @param bool $new
* @return
*/
public function saveLibraryData(&$libraryData, $new = TRUE);
/**
* Insert new content.
*
* @param array $content
* An associative array containing:
* - id: The content id
* - params: The content in json format
* - library: An associative array containing:
* - libraryId: The id of the main library for this content
* @param int $contentMainId
* Main id for the content if this is a system that supports versions
*/
public function insertContent($content, $contentMainId = NULL);
/**
* Update old content.
*
* @param array $content
* An associative array containing:
* - id: The content id
* - params: The content in json format
* - library: An associative array containing:
* - libraryId: The id of the main library for this content
* @param int $contentMainId
* Main id for the content if this is a system that supports versions
*/
public function updateContent($content, $contentMainId = NULL);
/**
* Resets marked user data for the given content.
*
* @param int $contentId
*/
public function resetContentUserData($contentId);
/**
* Save what libraries a library is depending on
*
* @param int $libraryId
* Library Id for the library we're saving dependencies for
* @param array $dependencies
* List of dependencies as associative arrays containing:
* - machineName: The library machineName
* - majorVersion: The library's majorVersion
* - minorVersion: The library's minorVersion
* @param string $dependency_type
* What type of dependency this is, the following values are allowed:
* - editor
* - preloaded
* - dynamic
*/
public function saveLibraryDependencies($libraryId, $dependencies, $dependency_type);
/**
* Give an H5P the same library dependencies as a given H5P
*
* @param int $contentId
* Id identifying the content
* @param int $copyFromId
* Id identifying the content to be copied
* @param int $contentMainId
* Main id for the content, typically used in frameworks
* That supports versions. (In this case the content id will typically be
* the version id, and the contentMainId will be the frameworks content id
*/
public function copyLibraryUsage($contentId, $copyFromId, $contentMainId = NULL);
/**
* Deletes content data
*
* @param int $contentId
* Id identifying the content
*/
public function deleteContentData($contentId);
/**
* Delete what libraries a content item is using
*
* @param int $contentId
* Content Id of the content we'll be deleting library usage for
*/
public function deleteLibraryUsage($contentId);
/**
* Saves what libraries the content uses
*
* @param int $contentId
* Id identifying the content
* @param array $librariesInUse
* List of libraries the content uses. Libraries consist of associative arrays with:
* - library: Associative array containing:
* - dropLibraryCss(optional): comma separated list of machineNames
* - machineName: Machine name for the library
* - libraryId: Id of the library
* - type: The dependency type. Allowed values:
* - editor
* - dynamic
* - preloaded
*/
public function saveLibraryUsage($contentId, $librariesInUse);
/**
* Get number of content/nodes using a library, and the number of
* dependencies to other libraries
*
* @param int $libraryId
* Library identifier
* @param boolean $skipContent
* Flag to indicate if content usage should be skipped
* @return array
* Associative array containing:
* - content: Number of content using the library
* - libraries: Number of libraries depending on the library
*/
public function getLibraryUsage($libraryId, $skipContent = FALSE);
/**
* Loads a library
*
* @param string $machineName
* The library's machine name
* @param int $majorVersion
* The library's major version
* @param int $minorVersion
* The library's minor version
* @return array|FALSE
* FALSE if the library does not exist.
* Otherwise an associative array containing:
* - libraryId: The id of the library if it is an existing library.
* - title: The library's name
* - machineName: The library machineName
* - majorVersion: The library's majorVersion
* - minorVersion: The library's minorVersion
* - patchVersion: The library's patchVersion
* - runnable: 1 if the library is a content type, 0 otherwise
* - fullscreen(optional): 1 if the library supports fullscreen, 0 otherwise
* - embedTypes(optional): list of supported embed types
* - preloadedJs(optional): comma separated string with js file paths
* - preloadedCss(optional): comma separated sting with css file paths
* - dropLibraryCss(optional): list of associative arrays containing:
* - machineName: machine name for the librarys that are to drop their css
* - semantics(optional): Json describing the content structure for the library
* - preloadedDependencies(optional): list of associative arrays containing:
* - machineName: Machine name for a library this library is depending on
* - majorVersion: Major version for a library this library is depending on
* - minorVersion: Minor for a library this library is depending on
* - dynamicDependencies(optional): list of associative arrays containing:
* - machineName: Machine name for a library this library is depending on
* - majorVersion: Major version for a library this library is depending on
* - minorVersion: Minor for a library this library is depending on
* - editorDependencies(optional): list of associative arrays containing:
* - machineName: Machine name for a library this library is depending on
* - majorVersion: Major version for a library this library is depending on
* - minorVersion: Minor for a library this library is depending on
*/
public function loadLibrary($machineName, $majorVersion, $minorVersion);
/**
* Loads library semantics.
*
* @param string $machineName
* Machine name for the library
* @param int $majorVersion
* The library's major version
* @param int $minorVersion
* The library's minor version
* @return string
* The library's semantics as json
*/
public function loadLibrarySemantics($machineName, $majorVersion, $minorVersion);
/**
* Makes it possible to alter the semantics, adding custom fields, etc.
*
* @param array $semantics
* Associative array representing the semantics
* @param string $machineName
* The library's machine name
* @param int $majorVersion
* The library's major version
* @param int $minorVersion
* The library's minor version
*/
public function alterLibrarySemantics(&$semantics, $machineName, $majorVersion, $minorVersion);
/**
* Delete all dependencies belonging to given library
*
* @param int $libraryId
* Library identifier
*/
public function deleteLibraryDependencies($libraryId);
/**
* Start an atomic operation against the dependency storage
*/
public function lockDependencyStorage();
/**
* Stops an atomic operation against the dependency storage
*/
public function unlockDependencyStorage();
/**
* Delete a library from database and file system
*
* @param stdClass $library
* Library object with id, name, major version and minor version.
*/
public function deleteLibrary($library);
/**
* Load content.
*
* @param int $id
* Content identifier
* @return array
* Associative array containing:
* - contentId: Identifier for the content
* - params: json content as string
* - embedType: csv of embed types
* - title: The contents title
* - language: Language code for the content
* - libraryId: Id for the main library
* - libraryName: The library machine name
* - libraryMajorVersion: The library's majorVersion
* - libraryMinorVersion: The library's minorVersion
* - libraryEmbedTypes: CSV of the main library's embed types
* - libraryFullscreen: 1 if fullscreen is supported. 0 otherwise.
*/
public function loadContent($id);
/**
* Load dependencies for the given content of the given type.
*
* @param int $id
* Content identifier
* @param int $type
* Dependency types. Allowed values:
* - editor
* - preloaded
* - dynamic
* @return array
* List of associative arrays containing:
* - libraryId: The id of the library if it is an existing library.
* - machineName: The library machineName
* - majorVersion: The library's majorVersion
* - minorVersion: The library's minorVersion
* - patchVersion: The library's patchVersion
* - preloadedJs(optional): comma separated string with js file paths
* - preloadedCss(optional): comma separated sting with css file paths
* - dropCss(optional): csv of machine names
*/
public function loadContentDependencies($id, $type = NULL);
/**
* Get stored setting.
*
* @param string $name
* Identifier for the setting
* @param string $default
* Optional default value if settings is not set
* @return mixed
* Whatever has been stored as the setting
*/
public function getOption($name, $default = NULL);
/**
* Stores the given setting.
* For example when did we last check h5p.org for updates to our libraries.
*
* @param string $name
* Identifier for the setting
* @param mixed $value Data
* Whatever we want to store as the setting
*/
public function setOption($name, $value);
/**
* This will update selected fields on the given content.
*
* @param int $id Content identifier
* @param array $fields Content fields, e.g. filtered or slug.
*/
public function updateContentFields($id, $fields);
/**
* Will clear filtered params for all the content that uses the specified
* libraries. This means that the content dependencies will have to be rebuilt,
* and the parameters re-filtered.
*
* @param array $library_ids
*/
public function clearFilteredParameters($library_ids);
/**
* Get number of contents that has to get their content dependencies rebuilt
* and parameters re-filtered.
*
* @return int
*/
public function getNumNotFiltered();
/**
* Get number of contents using library as main library.
*
* @param int $libraryId
* @param array $skip
* @return int
*/
public function getNumContent($libraryId, $skip = NULL);
/**
* Determines if content slug is used.
*
* @param string $slug
* @return boolean
*/
public function isContentSlugAvailable($slug);
/**
* Generates statistics from the event log per library
*
* @param string $type Type of event to generate stats for
* @return array Number values indexed by library name and version
*/
public function getLibraryStats($type);
/**
* Aggregate the current number of H5P authors
* @return int
*/
public function getNumAuthors();
/**
* Stores hash keys for cached assets, aggregated JavaScripts and
* stylesheets, and connects it to libraries so that we know which cache file
* to delete when a library is updated.
*
* @param string $key
* Hash key for the given libraries
* @param array $libraries
* List of dependencies(libraries) used to create the key
*/
public function saveCachedAssets($key, $libraries);
/**
* Locate hash keys for given library and delete them.
* Used when cache file are deleted.
*
* @param int $library_id
* Library identifier
* @return array
* List of hash keys removed
*/
public function deleteCachedAssets($library_id);
/**
* Get the amount of content items associated to a library
* return int
*/
public function getLibraryContentCount();
/**
* Will trigger after the export file is created.
*/
public function afterExportCreated($content, $filename);
/**
* Check if user has permissions to an action
*
* @method hasPermission
* @param [H5PPermission] $permission Permission type, ref H5PPermission
* @param [int] $id Id need by platform to determine permission
* @return boolean
*/
public function hasPermission($permission, $id = NULL);
/**
* Replaces existing content type cache with the one passed in
*
* @param object $contentTypeCache Json with an array called 'libraries'
* containing the new content type cache that should replace the old one.
*/
public function replaceContentTypeCache($contentTypeCache);
/**
* Checks if the given library has a higher version.
*
* @param array $library
* @return boolean
*/
public function libraryHasUpgrade($library);
>
}
> /**
> * Replace content hub metadata cache
/**
> *
* This class is used for validating H5P files
> * @param JsonSerializable $metadata Metadata as received from content hub
*/
> * @param string $lang Language in ISO 639-1
class H5PValidator {
> *
public $h5pF;
> * @return mixed
public $h5pC;
> */
> public function replaceContentHubMetadataCache($metadata, $lang);
// Schemas used to validate the h5p files
>
private $h5pRequired = array(
> /**
'title' => '/^.{1,255}$/',
> * Get content hub metadata cache from db
'language' => '/^[-a-zA-Z]{1,10}$/',
> *
'preloadedDependencies' => array(
> * @param string $lang Language code in ISO 639-1
'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
> *
'majorVersion' => '/^[0-9]{1,5}$/',
> * @return JsonSerializable Json string
'minorVersion' => '/^[0-9]{1,5}$/',
> */
),
> public function getContentHubMetadataCache($lang = 'en');
'mainLibrary' => '/^[$a-z_][0-9a-z_\.$]{1,254}$/i',
>
'embedTypes' => array('iframe', 'div'),
> /**
);
> * Get time of last content hub metadata check
> *
private $h5pOptional = array(
> * @param string $lang Language code iin ISO 639-1 format
'contentType' => '/^.{1,255}$/',
> *
'dynamicDependencies' => array(
> * @return string|null Time in RFC7231 format
'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
> */
'majorVersion' => '/^[0-9]{1,5}$/',
> public function getContentHubMetadataChecked($lang = 'en');
'minorVersion' => '/^[0-9]{1,5}$/',
>
),
> /**
// deprecated
> * Set time of last content hub metadata check
'author' => '/^.{1,255}$/',
> *
'authors' => array(
> * @param int|null $time Time in RFC7231 format
'name' => '/^.{1,255}$/',
> * @param string $lang Language code iin ISO 639-1 format
'role' => '/^\w+$/',
> *
),
> * @return bool True if successful
'source' => '/^(http[s]?:\/\/.+)$/',
> */
'license' => '/^(CC BY|CC BY-SA|CC BY-ND|CC BY-NC|CC BY-NC-SA|CC BY-NC-ND|CC0 1\.0|GNU GPL|PD|ODC PDDL|CC PDM|U|C)$/',
> public function setContentHubMetadataChecked($time, $lang = 'en');
'licenseVersion' => '/^(1\.0|2\.0|2\.5|3\.0|4\.0)$/',
> public $h5pCV;
< 'licenseExtras' => '/^.{1,5000}$/',
> 'licenseExtras' => '/^.{1,5000}$/s',
'yearsFrom' => '/^([0-9]{1,4})$/',
'yearsTo' => '/^([0-9]{1,4})$/',
'changes' => array(
'date' => '/^[0-9]{2}-[0-9]{2}-[0-9]{2} [0-9]{1,2}:[0-9]{2}:[0-9]{2}$/',
'author' => '/^.{1,255}$/',
< 'log' => '/^.{1,5000}$/'
> 'log' => '/^.{1,5000}$/s'
),
< 'authorComments' => '/^.{1,5000}$/',
> 'authorComments' => '/^.{1,5000}$/s',
'w' => '/^[0-9]{1,4}$/',
'h' => '/^[0-9]{1,4}$/',
// deprecated
'metaKeywords' => '/^.{1,}$/',
// deprecated
'metaDescription' => '/^.{1,}$/',
);
// Schemas used to validate the library files
private $libraryRequired = array(
'title' => '/^.{1,255}$/',
'majorVersion' => '/^[0-9]{1,5}$/',
'minorVersion' => '/^[0-9]{1,5}$/',
'patchVersion' => '/^[0-9]{1,5}$/',
'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
'runnable' => '/^(0|1)$/',
);
private $libraryOptional = array(
'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,}$/',
'metadataSettings' => array(
'disable' => '/^(0|1)$/',
'disableExtraTitleField' => '/^(0|1)$/'
),
'dynamicDependencies' => array(
'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
'majorVersion' => '/^[0-9]{1,5}$/',
'minorVersion' => '/^[0-9]{1,5}$/',
),
'preloadedDependencies' => array(
'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
'majorVersion' => '/^[0-9]{1,5}$/',
'minorVersion' => '/^[0-9]{1,5}$/',
),
'editorDependencies' => array(
'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
'majorVersion' => '/^[0-9]{1,5}$/',
'minorVersion' => '/^[0-9]{1,5}$/',
),
'preloadedJs' => array(
'path' => '/^((\\\|\/)?[a-z_\-\s0-9\.]+)+\.js$/i',
),
'preloadedCss' => array(
'path' => '/^((\\\|\/)?[a-z_\-\s0-9\.]+)+\.css$/i',
),
'dropLibraryCss' => array(
'machineName' => '/^[\w0-9\-\.]{1,255}$/i',
),
'w' => '/^[0-9]{1,4}$/',
'h' => '/^[0-9]{1,4}$/',
'embedTypes' => array('iframe', 'div'),
'fullscreen' => '/^(0|1)$/',
'coreApi' => array(
'majorVersion' => '/^[0-9]{1,5}$/',
'minorVersion' => '/^[0-9]{1,5}$/',
),
);
/**
* Constructor for the H5PValidator
*
* @param H5PFrameworkInterface $H5PFramework
* The frameworks implementation of the H5PFrameworkInterface
* @param H5PCore $H5PCore
*/
public function __construct($H5PFramework, $H5PCore) {
$this->h5pF = $H5PFramework;
$this->h5pC = $H5PCore;
$this->h5pCV = new H5PContentValidator($this->h5pF, $this->h5pC);
}
/**
* Validates a .h5p file
*
* @param bool $skipContent
* @param bool $upgradeOnly
* @return bool TRUE if the .h5p file is valid
* TRUE if the .h5p file is valid
*/
public function isValidPackage($skipContent = FALSE, $upgradeOnly = FALSE) {
> // Create a temporary dir to extract package in.
// Check dependencies, make sure Zip is present
> $tmpDir = $this->h5pF->getUploadedH5pFolderPath();
if (!class_exists('ZipArchive')) {
> $tmpPath = $this->h5pF->getUploadedH5pPath();
$this->h5pF->setErrorMessage($this->h5pF->t('Your PHP version does not support ZipArchive.'), 'zip-archive-unsupported');
>
unlink($tmpPath);
return FALSE;
}
if (!extension_loaded('mbstring')) {
$this->h5pF->setErrorMessage($this->h5pF->t('The mbstring PHP extension is not loaded. H5P need this to function properly'), 'mbstring-unsupported');
unlink($tmpPath);
return FALSE;
}
< // Create a temporary dir to extract package in.
< $tmpDir = $this->h5pF->getUploadedH5pFolderPath();
< $tmpPath = $this->h5pF->getUploadedH5pPath();
<
// Only allow files with the .h5p extension:
if (strtolower(substr($tmpPath, -3)) !== 'h5p') {
$this->h5pF->setErrorMessage($this->h5pF->t('The file you uploaded is not a valid HTML5 Package (It does not have the .h5p file extension)'), 'missing-h5p-extension');
unlink($tmpPath);
return FALSE;
}
// Extract and then remove the package file.
$zip = new ZipArchive;
// Open the package
if ($zip->open($tmpPath) !== TRUE) {
$this->h5pF->setErrorMessage($this->h5pF->t('The file you uploaded is not a valid HTML5 Package (We are unable to unzip it)'), 'unable-to-unzip');
unlink($tmpPath);
return FALSE;
}
if ($this->h5pC->disableFileCheck !== TRUE) {
list($contentWhitelist, $contentRegExp) = $this->getWhitelistRegExp(FALSE);
list($libraryWhitelist, $libraryRegExp) = $this->getWhitelistRegExp(TRUE);
}
$canInstall = $this->h5pC->mayUpdateLibraries();
$valid = TRUE;
$libraries = array();
$totalSize = 0;
$mainH5pExists = FALSE;
$contentExists = FALSE;
// Check for valid file types, JSON files + file sizes before continuing to unpack.
for ($i = 0; $i < $zip->numFiles; $i++) {
$fileStat = $zip->statIndex($i);
if (!empty($this->h5pC->maxFileSize) && $fileStat['size'] > $this->h5pC->maxFileSize) {
// Error file is too large
$this->h5pF->setErrorMessage($this->h5pF->t('One of the files inside the package exceeds the maximum file size allowed. (%file %used > %max)', array('%file' => $fileStat['name'], '%used' => ($fileStat['size'] / 1048576) . ' MB', '%max' => ($this->h5pC->maxFileSize / 1048576) . ' MB')), 'file-size-too-large');
$valid = FALSE;
}
$totalSize += $fileStat['size'];
$fileName = mb_strtolower($fileStat['name']);
< if (preg_match('/(^[\._]|\/[\._])/', $fileName) !== 0) {
> if (preg_match('/(^[\._]|\/[\._]|\\\[\._])/', $fileName) !== 0) {
continue; // Skip any file or folder starting with a . or _
}
elseif ($fileName === 'h5p.json') {
$mainH5pExists = TRUE;
}
elseif ($fileName === 'content/content.json') {
$contentExists = TRUE;
}
elseif (substr($fileName, 0, 8) === 'content/') {
// This is a content file, check that the file type is allowed
if ($skipContent === FALSE && $this->h5pC->disableFileCheck !== TRUE && !preg_match($contentRegExp, $fileName)) {
$this->h5pF->setErrorMessage($this->h5pF->t('File "%filename" not allowed. Only files with the following extensions are allowed: %files-allowed.', array('%filename' => $fileStat['name'], '%files-allowed' => $contentWhitelist)), 'not-in-whitelist');
$valid = FALSE;
}
}
elseif ($canInstall && strpos($fileName, '/') !== FALSE) {
// This is a library file, check that the file type is allowed
if ($this->h5pC->disableFileCheck !== TRUE && !preg_match($libraryRegExp, $fileName)) {
$this->h5pF->setErrorMessage($this->h5pF->t('File "%filename" not allowed. Only files with the following extensions are allowed: %files-allowed.', array('%filename' => $fileStat['name'], '%files-allowed' => $libraryWhitelist)), 'not-in-whitelist');
$valid = FALSE;
}
// Further library validation happens after the files are extracted
}
}
if (!empty($this->h5pC->maxTotalSize) && $totalSize > $this->h5pC->maxTotalSize) {
// Error total size of the zip is too large
$this->h5pF->setErrorMessage($this->h5pF->t('The total size of the unpacked files exceeds the maximum size allowed. (%used > %max)', array('%used' => ($totalSize / 1048576) . ' MB', '%max' => ($this->h5pC->maxTotalSize / 1048576) . ' MB')), 'total-size-too-large');
$valid = FALSE;
}
if ($skipContent === FALSE) {
// Not skipping content, require two valid JSON files from the package
if (!$contentExists) {
$this->h5pF->setErrorMessage($this->h5pF->t('A valid content folder is missing'), 'invalid-content-folder');
$valid = FALSE;
}
else {
$contentJsonData = $this->getJson($tmpPath, $zip, 'content/content.json'); // TODO: Is this case-senstivie?
if ($contentJsonData === NULL) {
return FALSE; // Breaking error when reading from the archive.
}
elseif ($contentJsonData === FALSE) {
$valid = FALSE; // Validation error when parsing JSON
}
}
if (!$mainH5pExists) {
$this->h5pF->setErrorMessage($this->h5pF->t('A valid main h5p.json file is missing'), 'invalid-h5p-json-file');
$valid = FALSE;
}
else {
$mainH5pData = $this->getJson($tmpPath, $zip, 'h5p.json', TRUE);
if ($mainH5pData === NULL) {
return FALSE; // Breaking error when reading from the archive.
}
elseif ($mainH5pData === FALSE) {
$valid = FALSE; // Validation error when parsing JSON
}
elseif (!$this->isValidH5pData($mainH5pData, 'h5p.json', $this->h5pRequired, $this->h5pOptional)) {
$this->h5pF->setErrorMessage($this->h5pF->t('The main h5p.json file is not valid'), 'invalid-h5p-json-file'); // Is this message a bit redundant?
$valid = FALSE;
}
}
}
if (!$valid) {
// If something has failed during the initial checks of the package
// we will not unpack it or continue validation.
$zip->close();
unlink($tmpPath);
return FALSE;
}
// Extract the files from the package
for ($i = 0; $i < $zip->numFiles; $i++) {
$fileName = $zip->statIndex($i)['name'];
< if (preg_match('/(^[\._]|\/[\._])/', $fileName) !== 0) {
> if (preg_match('/(^[\._]|\/[\._]|\\\[\._])/', $fileName) !== 0) {
continue; // Skip any file or folder starting with a . or _
}
$isContentFile = (substr($fileName, 0, 8) === 'content/');
$isFolder = (strpos($fileName, '/') !== FALSE);
if ($skipContent !== FALSE && $isContentFile) {
continue; // Skipping any content files
}
if (!($isContentFile || ($canInstall && $isFolder))) {
continue; // Not something we want to unpack
}
// Get file stream
$fileStream = $zip->getStream($fileName);
if (!$fileStream) {
// This is a breaking error, there's no need to continue. (the rest of the files will fail as well)
$this->h5pF->setErrorMessage($this->h5pF->t('Unable to read file from the package: %fileName', array('%fileName' => $fileName)), 'unable-to-read-package-file');
$zip->close();
unlink($path);
H5PCore::deleteFileTree($tmpDir);
return FALSE;
}
// Use file interface to allow overrides
$this->h5pC->fs->saveFileFromZip($tmpDir, $fileName, $fileStream);
// Clean up
if (is_resource($fileStream)) {
fclose($fileStream);
}
}
// We're done with the zip file, clean up the stuff
$zip->close();
unlink($tmpPath);
if ($canInstall) {
// Process and validate libraries using the unpacked library folders
$files = scandir($tmpDir);
foreach ($files as $file) {
$filePath = $tmpDir . '/' . $file;
if ($file === '.' || $file === '..' || $file === 'content' || !is_dir($filePath)) {
continue; // Skip
}
$libraryH5PData = $this->getLibraryData($file, $filePath, $tmpDir);
if ($libraryH5PData === FALSE) {
$valid = FALSE;
continue; // Failed, but continue validating the rest of the libraries
}
// Library's directory name must be:
// - <machineName>
// - or -
// - <machineName>-<majorVersion>.<minorVersion>
// where machineName, majorVersion and minorVersion is read from library.json
< if ($libraryH5PData['machineName'] !== $file && H5PCore::libraryToString($libraryH5PData, TRUE) !== $file) {
> if ($libraryH5PData['machineName'] !== $file && H5PCore::libraryToFolderName($libraryH5PData) !== $file) {
$this->h5pF->setErrorMessage($this->h5pF->t('Library directory name must match machineName or machineName-majorVersion.minorVersion (from library.json). (Directory: %directoryName , machineName: %machineName, majorVersion: %majorVersion, minorVersion: %minorVersion)', array(
'%directoryName' => $file,
'%machineName' => $libraryH5PData['machineName'],
'%majorVersion' => $libraryH5PData['majorVersion'],
'%minorVersion' => $libraryH5PData['minorVersion'])), 'library-directory-name-mismatch');
$valid = FALSE;
continue; // Failed, but continue validating the rest of the libraries
}
$libraryH5PData['uploadDirectory'] = $filePath;
$libraries[H5PCore::libraryToString($libraryH5PData)] = $libraryH5PData;
}
}
if ($valid) {
if ($upgradeOnly) {
// When upgrading, we only add the already installed libraries, and
// the new dependent libraries
$upgrades = array();
foreach ($libraries as $libString => &$library) {
// Is this library already installed?
if ($this->h5pF->getLibraryId($library['machineName']) !== FALSE) {
$upgrades[$libString] = $library;
}
}
while ($missingLibraries = $this->getMissingLibraries($upgrades)) {
foreach ($missingLibraries as $libString => $missing) {
$library = $libraries[$libString];
if ($library) {
$upgrades[$libString] = $library;
}
}
}
$libraries = $upgrades;
}
$this->h5pC->librariesJsonData = $libraries;
if ($skipContent === FALSE) {
$this->h5pC->mainJsonData = $mainH5pData;
$this->h5pC->contentJsonData = $contentJsonData;
$libraries['mainH5pData'] = $mainH5pData; // Check for the dependencies in h5p.json as well as in the libraries
}
$missingLibraries = $this->getMissingLibraries($libraries);
foreach ($missingLibraries as $libString => $missing) {
if ($this->h5pC->getLibraryId($missing, $libString)) {
unset($missingLibraries[$libString]);
}
}
if (!empty($missingLibraries)) {
// We still have missing libraries, check if our main library has an upgrade (BUT only if we has content)
$mainDependency = NULL;
if (!$skipContent && !empty($mainH5pData)) {
foreach ($mainH5pData['preloadedDependencies'] as $dep) {
if ($dep['machineName'] === $mainH5pData['mainLibrary']) {
$mainDependency = $dep;
}
}
}
if ($skipContent || !$mainDependency || !$this->h5pF->libraryHasUpgrade(array(
'machineName' => $mainDependency['machineName'],
'majorVersion' => $mainDependency['majorVersion'],
'minorVersion' => $mainDependency['minorVersion']
))) {
foreach ($missingLibraries as $libString => $library) {
> if (!empty($mainDependency) && $library['machineName'] === $mainDependency['machineName']) {
$this->h5pF->setErrorMessage($this->h5pF->t('Missing required library @library', array('@library' => $libString)), 'missing-required-library');
> $this->h5pF->setErrorMessage($this->h5pF->t('Missing main library @library', array('@library' => $libString )), 'missing-main-library');
$valid = FALSE;
> }
}
> else {
if (!$this->h5pC->mayUpdateLibraries()) {
> }
$this->h5pF->setInfoMessage($this->h5pF->t("Note that the libraries may exist in the file you uploaded, but you're not allowed to upload new libraries. Contact the site administrator about this."));
$valid = FALSE;
}
}
}
}
if (!$valid) {
H5PCore::deleteFileTree($tmpDir);
}
return $valid;
}
/**
* Help read JSON from the archive
*
* @param string $path
* @param ZipArchive $zip
* @param string $file
* @return mixed JSON content if valid, FALSE for invalid, NULL for breaking error.
*/
private function getJson($path, $zip, $file, $assoc = FALSE) {
// Get stream
$stream = $zip->getStream($file);
if (!$stream) {
// Breaking error, no need to continue validating.
$this->h5pF->setErrorMessage($this->h5pF->t('Unable to read file from the package: %fileName', array('%fileName' => $file)), 'unable-to-read-package-file');
$zip->close();
unlink($path);
return NULL;
}
// Read data
$contents = '';
while (!feof($stream)) {
$contents .= fread($stream, 2);
}
// Decode the data
$json = json_decode($contents, $assoc);
if ($json === NULL) {
// JSON cannot be decoded or the recursion limit has been reached.
$this->h5pF->setErrorMessage($this->h5pF->t('Unable to parse JSON from the package: %fileName', array('%fileName' => $file)), 'unable-to-parse-package');
return FALSE;
}
// All OK
return $json;
}
/**
* Help retrieve file type regexp whitelist from plugin.
*
* @param bool $isLibrary Separate list with more allowed file types
* @return string RegExp
*/
private function getWhitelistRegExp($isLibrary) {
$whitelist = $this->h5pF->getWhitelist($isLibrary, H5PCore::$defaultContentWhitelist, H5PCore::$defaultLibraryWhitelistExtras);
return array($whitelist, '/\.(' . preg_replace('/ +/i', '|', preg_quote($whitelist)) . ')$/i');
}
/**
* Validates a H5P library
*
* @param string $file
* Name of the library folder
* @param string $filePath
* Path to the library folder
* @param string $tmpDir
* Path to the temporary upload directory
* @return boolean|array
* H5P data from library.json and semantics if the library is valid
* FALSE if the library isn't valid
*/
public function getLibraryData($file, $filePath, $tmpDir) {
if (preg_match('/^[\w0-9\-\.]{1,255}$/i', $file) === 0) {
$this->h5pF->setErrorMessage($this->h5pF->t('Invalid library name: %name', array('%name' => $file)), 'invalid-library-name');
return FALSE;
}
$h5pData = $this->getJsonData($filePath . '/' . 'library.json');
if ($h5pData === FALSE) {
$this->h5pF->setErrorMessage($this->h5pF->t('Could not find library.json file with valid json format for library %name', array('%name' => $file)), 'invalid-library-json-file');
return FALSE;
}
// validate json if a semantics file is provided
$semanticsPath = $filePath . '/' . 'semantics.json';
if (file_exists($semanticsPath)) {
$semantics = $this->getJsonData($semanticsPath, TRUE);
if ($semantics === FALSE) {
$this->h5pF->setErrorMessage($this->h5pF->t('Invalid semantics.json file has been included in the library %name', array('%name' => $file)), 'invalid-semantics-json-file');
return FALSE;
}
else {
$h5pData['semantics'] = $semantics;
}
}
// validate language folder if it exists
$languagePath = $filePath . '/' . 'language';
if (is_dir($languagePath)) {
$languageFiles = scandir($languagePath);
foreach ($languageFiles as $languageFile) {
if (in_array($languageFile, array('.', '..'))) {
continue;
}
if (preg_match('/^(-?[a-z]+){1,7}\.json$/i', $languageFile) === 0) {
$this->h5pF->setErrorMessage($this->h5pF->t('Invalid language file %file in library %library', array('%file' => $languageFile, '%library' => $file)), 'invalid-language-file');
return FALSE;
}
$languageJson = $this->getJsonData($languagePath . '/' . $languageFile, TRUE);
if ($languageJson === FALSE) {
$this->h5pF->setErrorMessage($this->h5pF->t('Invalid language file %languageFile has been included in the library %name', array('%languageFile' => $languageFile, '%name' => $file)), 'invalid-language-file');
return FALSE;
}
$parts = explode('.', $languageFile); // $parts[0] is the language code
$h5pData['language'][$parts[0]] = $languageJson;
}
}
// Check for icon:
$h5pData['hasIcon'] = file_exists($filePath . '/' . 'icon.svg');
$validLibrary = $this->isValidH5pData($h5pData, $file, $this->libraryRequired, $this->libraryOptional);
//$validLibrary = $this->h5pCV->validateContentFiles($filePath, TRUE) && $validLibrary;
if (isset($h5pData['preloadedJs'])) {
$validLibrary = $this->isExistingFiles($h5pData['preloadedJs'], $tmpDir, $file) && $validLibrary;
}
if (isset($h5pData['preloadedCss'])) {
$validLibrary = $this->isExistingFiles($h5pData['preloadedCss'], $tmpDir, $file) && $validLibrary;
}
if ($validLibrary) {
return $h5pData;
}
else {
return FALSE;
}
}
/**
* Use the dependency declarations to find any missing libraries
*
* @param array $libraries
* A multidimensional array of libraries keyed with machineName first and majorVersion second
* @return array
* A list of libraries that are missing keyed with machineName and holds objects with
* machineName, majorVersion and minorVersion properties
*/
private function getMissingLibraries($libraries) {
$missing = array();
foreach ($libraries as $library) {
if (isset($library['preloadedDependencies'])) {
$missing = array_merge($missing, $this->getMissingDependencies($library['preloadedDependencies'], $libraries));
}
if (isset($library['dynamicDependencies'])) {
$missing = array_merge($missing, $this->getMissingDependencies($library['dynamicDependencies'], $libraries));
}
if (isset($library['editorDependencies'])) {
$missing = array_merge($missing, $this->getMissingDependencies($library['editorDependencies'], $libraries));
}
}
return $missing;
}
/**
* Helper function for getMissingLibraries, searches for dependency required libraries in
* the provided list of libraries
*
* @param array $dependencies
* A list of objects with machineName, majorVersion and minorVersion properties
* @param array $libraries
* An array of libraries keyed with machineName
* @return
* A list of libraries that are missing keyed with machineName and holds objects with
* machineName, majorVersion and minorVersion properties
*/
private function getMissingDependencies($dependencies, $libraries) {
$missing = array();
foreach ($dependencies as $dependency) {
$libString = H5PCore::libraryToString($dependency);
if (!isset($libraries[$libString])) {
$missing[$libString] = $dependency;
}
}
return $missing;
}
/**
* Figure out if the provided file paths exists
*
* Triggers error messages if files doesn't exist
*
* @param array $files
* List of file paths relative to $tmpDir
* @param string $tmpDir
* Path to the directory where the $files are stored.
* @param string $library
* Name of the library we are processing
* @return boolean
* TRUE if all the files excists
*/
private function isExistingFiles($files, $tmpDir, $library) {
foreach ($files as $file) {
$path = str_replace(array('/', '\\'), '/', $file['path']);
if (!file_exists($tmpDir . '/' . $library . '/' . $path)) {
$this->h5pF->setErrorMessage($this->h5pF->t('The file "%file" is missing from library: "%name"', array('%file' => $path, '%name' => $library)), 'library-missing-file');
return FALSE;
}
}
return TRUE;
}
/**
* Validates h5p.json and library.json data
*
* Error messages are triggered if the data isn't valid
*
* @param array $h5pData
* h5p data
* @param string $library_name
* Name of the library we are processing
* @param array $required
* Validation pattern for required properties
* @param array $optional
* Validation pattern for optional properties
* @return boolean
* TRUE if the $h5pData is valid
*/
private function isValidH5pData($h5pData, $library_name, $required, $optional) {
$valid = $this->isValidRequiredH5pData($h5pData, $required, $library_name);
$valid = $this->isValidOptionalH5pData($h5pData, $optional, $library_name) && $valid;
// Check the library's required API version of Core.
// If no requirement is set this implicitly means 1.0.
if (isset($h5pData['coreApi']) && !empty($h5pData['coreApi'])) {
if (($h5pData['coreApi']['majorVersion'] > H5PCore::$coreApi['majorVersion']) ||
( ($h5pData['coreApi']['majorVersion'] == H5PCore::$coreApi['majorVersion']) &&
($h5pData['coreApi']['minorVersion'] > H5PCore::$coreApi['minorVersion']) )) {
$this->h5pF->setErrorMessage(
$this->h5pF->t('The system was unable to install the <em>%component</em> component from the package, it requires a newer version of the H5P plugin. This site is currently running version %current, whereas the required version is %required or higher. You should consider upgrading and then try again.',
array(
'%component' => (isset($h5pData['title']) ? $h5pData['title'] : $library_name),
'%current' => H5PCore::$coreApi['majorVersion'] . '.' . H5PCore::$coreApi['minorVersion'],
'%required' => $h5pData['coreApi']['majorVersion'] . '.' . $h5pData['coreApi']['minorVersion']
)
),
'api-version-unsupported'
);
$valid = false;
}
}
return $valid;
}
/**
* Helper function for isValidH5pData
*
* Validates the optional part of the h5pData
*
* Triggers error messages
*
* @param array $h5pData
* h5p data
* @param array $requirements
* Validation pattern
* @param string $library_name
* Name of the library we are processing
* @return boolean
* TRUE if the optional part of the $h5pData is valid
*/
private function isValidOptionalH5pData($h5pData, $requirements, $library_name) {
$valid = TRUE;
foreach ($h5pData as $key => $value) {
if (isset($requirements[$key])) {
$valid = $this->isValidRequirement($value, $requirements[$key], $library_name, $key) && $valid;
}
// Else: ignore, a package can have parameters that this library doesn't care about, but that library
// specific implementations does care about...
}
return $valid;
}
/**
* Validate a requirement given as regexp or an array of requirements
*
* @param mixed $h5pData
* The data to be validated
* @param mixed $requirement
* The requirement the data is to be validated against, regexp or array of requirements
* @param string $library_name
* Name of the library we are validating(used in error messages)
* @param string $property_name
* Name of the property we are validating(used in error messages)
* @return boolean
* TRUE if valid, FALSE if invalid
*/
private function isValidRequirement($h5pData, $requirement, $library_name, $property_name) {
$valid = TRUE;
if (is_string($requirement)) {
if ($requirement == 'boolean') {
if (!is_bool($h5pData)) {
$this->h5pF->setErrorMessage($this->h5pF->t("Invalid data provided for %property in %library. Boolean expected.", array('%property' => $property_name, '%library' => $library_name)));
$valid = FALSE;
}
}
else {
// The requirement is a regexp, match it against the data
if (is_string($h5pData) || is_int($h5pData)) {
if (preg_match($requirement, $h5pData) === 0) {
$this->h5pF->setErrorMessage($this->h5pF->t("Invalid data provided for %property in %library", array('%property' => $property_name, '%library' => $library_name)));
$valid = FALSE;
}
}
else {
$this->h5pF->setErrorMessage($this->h5pF->t("Invalid data provided for %property in %library", array('%property' => $property_name, '%library' => $library_name)));
$valid = FALSE;
}
}
}
elseif (is_array($requirement)) {
// We have sub requirements
if (is_array($h5pData)) {
if (is_array(current($h5pData))) {
foreach ($h5pData as $sub_h5pData) {
$valid = $this->isValidRequiredH5pData($sub_h5pData, $requirement, $library_name) && $valid;
}
}
else {
$valid = $this->isValidRequiredH5pData($h5pData, $requirement, $library_name) && $valid;
}
}
else {
$this->h5pF->setErrorMessage($this->h5pF->t("Invalid data provided for %property in %library", array('%property' => $property_name, '%library' => $library_name)));
$valid = FALSE;
}
}
else {
$this->h5pF->setErrorMessage($this->h5pF->t("Can't read the property %property in %library", array('%property' => $property_name, '%library' => $library_name)));
$valid = FALSE;
}
return $valid;
}
/**
* Validates the required h5p data in libraray.json and h5p.json
*
* @param mixed $h5pData
* Data to be validated
* @param array $requirements
* Array with regexp to validate the data against
* @param string $library_name
* Name of the library we are validating (used in error messages)
* @return boolean
* TRUE if all the required data exists and is valid, FALSE otherwise
*/
private function isValidRequiredH5pData($h5pData, $requirements, $library_name) {
$valid = TRUE;
foreach ($requirements as $required => $requirement) {
if (is_int($required)) {
// We have an array of allowed options
return $this->isValidH5pDataOptions($h5pData, $requirements, $library_name);
}
if (isset($h5pData[$required])) {
$valid = $this->isValidRequirement($h5pData[$required], $requirement, $library_name, $required) && $valid;
}
else {
$this->h5pF->setErrorMessage($this->h5pF->t('The required property %property is missing from %library', array('%property' => $required, '%library' => $library_name)), 'missing-required-property');
$valid = FALSE;
}
}
return $valid;
}
/**
* Validates h5p data against a set of allowed values(options)
*
* @param array $selected
* The option(s) that has been specified
* @param array $allowed
* The allowed options
* @param string $library_name
* Name of the library we are validating (used in error messages)
* @return boolean
* TRUE if the specified data is valid, FALSE otherwise
*/
private function isValidH5pDataOptions($selected, $allowed, $library_name) {
$valid = TRUE;
foreach ($selected as $value) {
if (!in_array($value, $allowed)) {
$this->h5pF->setErrorMessage($this->h5pF->t('Illegal option %option in %library', array('%option' => $value, '%library' => $library_name)), 'illegal-option-in-library');
$valid = FALSE;
}
}
return $valid;
}
/**
* Fetch json data from file
*
* @param string $filePath
* Path to the file holding the json string
* @param boolean $return_as_string
* If true the json data will be decoded in order to validate it, but will be
* returned as string
* @return mixed
* FALSE if the file can't be read or the contents can't be decoded
* string if the $return as string parameter is set
* array otherwise
*/
private function getJsonData($filePath, $return_as_string = FALSE) {
$json = file_get_contents($filePath);
if ($json === FALSE) {
return FALSE; // Cannot read from file.
}
$jsonData = json_decode($json, TRUE);
if ($jsonData === NULL) {
return FALSE; // JSON cannot be decoded or the recursion limit has been reached.
}
return $return_as_string ? $json : $jsonData;
}
/**
* Helper function that copies an array
*
* @param array $array
* The array to be copied
* @return array
* Copy of $array. All objects are cloned
*/
private function arrayCopy(array $array) {
$result = array();
foreach ($array as $key => $val) {
if (is_array($val)) {
$result[$key] = self::arrayCopy($val);
}
elseif (is_object($val)) {
$result[$key] = clone $val;
}
else {
$result[$key] = $val;
}
}
return $result;
}
}
/**
* This class is used for saving H5P files
*/
class H5PStorage {
public $h5pF;
public $h5pC;
public $contentId = NULL; // Quick fix so WP can get ID of new content.
/**
* Constructor for the H5PStorage
*
* @param H5PFrameworkInterface|object $H5PFramework
* The frameworks implementation of the H5PFrameworkInterface
* @param H5PCore $H5PCore
*/
public function __construct(H5PFrameworkInterface $H5PFramework, H5PCore $H5PCore) {
$this->h5pF = $H5PFramework;
$this->h5pC = $H5PCore;
}
/**
* Saves a H5P file
*
* @param null $content
* @param int $contentMainId
* The main id for the content we are saving. This is used if the framework
* we're integrating with uses content id's and version id's
* @param bool $skipContent
* @param array $options
* @return bool TRUE if one or more libraries were updated
* TRUE if one or more libraries were updated
* FALSE otherwise
*/
public function savePackage($content = NULL, $contentMainId = NULL, $skipContent = FALSE, $options = array()) {
if ($this->h5pC->mayUpdateLibraries()) {
// Save the libraries we processed during validation
$this->saveLibraries();
}
if (!$skipContent) {
$basePath = $this->h5pF->getUploadedH5pFolderPath();
$current_path = $basePath . '/' . 'content';
// Save content
if ($content === NULL) {
$content = array();
}
if (!is_array($content)) {
$content = array('id' => $content);
}
// Find main library version
foreach ($this->h5pC->mainJsonData['preloadedDependencies'] as $dep) {
if ($dep['machineName'] === $this->h5pC->mainJsonData['mainLibrary']) {
$dep['libraryId'] = $this->h5pC->getLibraryId($dep);
$content['library'] = $dep;
break;
}
}
$content['params'] = file_get_contents($current_path . '/' . 'content.json');
if (isset($options['disable'])) {
$content['disable'] = $options['disable'];
}
$content['id'] = $this->h5pC->saveContent($content, $contentMainId);
$this->contentId = $content['id'];
try {
// Save content folder contents
$this->h5pC->fs->saveContent($current_path, $content);
}
catch (Exception $e) {
$this->h5pF->setErrorMessage($e->getMessage(), 'save-content-failed');
}
// Remove temp content folder
H5PCore::deleteFileTree($basePath);
}
}
/**
* Helps savePackage.
*
* @return int Number of libraries saved
*/
private function saveLibraries() {
// Keep track of the number of libraries that have been saved
$newOnes = 0;
$oldOnes = 0;
// Go through libraries that came with this package
foreach ($this->h5pC->librariesJsonData as $libString => &$library) {
< // Find local library identifier
< $libraryId = $this->h5pC->getLibraryId($library, $libString);
> // Find local library with same major + minor
> $existingLibrary = $this->h5pC->loadLibrary($library['machineName'], $library['majorVersion'], $library['minorVersion']);
// Assume new library
$new = TRUE;
< if ($libraryId) {
< // Found old library
< $library['libraryId'] = $libraryId;
<
< if ($this->h5pF->isPatchedLibrary($library)) {
< // This is a newer version than ours. Upgrade!
< $new = FALSE;
< }
< else {
> if (isset($existingLibrary['libraryId'])) {
> $new = false;
> // We have the library installed already (with the same major + minor)
>
> $library['libraryId'] = $existingLibrary['libraryId'];
>
> // Is this a newer patchVersion?
> $newerPatchVersion = $existingLibrary['patchVersion'] < $library['patchVersion'];
>
> if (!$newerPatchVersion) {
$library['saveDependencies'] = FALSE;
// This is an older version, no need to save.
continue;
}
}
// Indicate that the dependencies of this library should be saved.
$library['saveDependencies'] = TRUE;
// Convert metadataSettings values to boolean & json_encode it before saving
$library['metadataSettings'] = isset($library['metadataSettings']) ?
H5PMetadata::boolifyAndEncodeSettings($library['metadataSettings']) :
NULL;
> // MOODLE PATCH: The library needs to be saved in database first before creating the files, because the libraryid is used
$this->h5pF->saveLibraryData($library, $new);
> // as itemid for the files.
> // Update our DB
// Save library folder
$this->h5pC->fs->saveLibrary($library);
// Remove cached assets that uses this library
if ($this->h5pC->aggregateAssets && isset($library['libraryId'])) {
$removedKeys = $this->h5pF->deleteCachedAssets($library['libraryId']);
$this->h5pC->fs->deleteCachedAssets($removedKeys);
}
// Remove tmp folder
H5PCore::deleteFileTree($library['uploadDirectory']);
> if ($existingLibrary) {
if ($new) {
> $this->h5pC->fs->deleteLibrary($existingLibrary);
$newOnes++;
> }
}
>
else {
$oldOnes++;
}
}
// Go through the libraries again to save dependencies.
< $library_ids = [];
> $library_ids = array();
foreach ($this->h5pC->librariesJsonData as &$library) {
if (!$library['saveDependencies']) {
continue;
}
// TODO: Should the table be locked for this operation?
// Remove any old dependencies
$this->h5pF->deleteLibraryDependencies($library['libraryId']);
// Insert the different new ones
if (isset($library['preloadedDependencies'])) {
$this->h5pF->saveLibraryDependencies($library['libraryId'], $library['preloadedDependencies'], 'preloaded');
}
if (isset($library['dynamicDependencies'])) {
$this->h5pF->saveLibraryDependencies($library['libraryId'], $library['dynamicDependencies'], 'dynamic');
}
if (isset($library['editorDependencies'])) {
$this->h5pF->saveLibraryDependencies($library['libraryId'], $library['editorDependencies'], 'editor');
}
$library_ids[] = $library['libraryId'];
}
// Make sure libraries dependencies, parameter filtering and export files gets regenerated for all content who uses these libraries.
if (!empty($library_ids)) {
$this->h5pF->clearFilteredParameters($library_ids);
}
// Tell the user what we've done.
if ($newOnes && $oldOnes) {
if ($newOnes === 1) {
if ($oldOnes === 1) {
// Singular Singular
$message = $this->h5pF->t('Added %new new H5P library and updated %old old one.', array('%new' => $newOnes, '%old' => $oldOnes));
}
else {
// Singular Plural
$message = $this->h5pF->t('Added %new new H5P library and updated %old old ones.', array('%new' => $newOnes, '%old' => $oldOnes));
}
}
else {
// Plural
if ($oldOnes === 1) {
// Plural Singular
$message = $this->h5pF->t('Added %new new H5P libraries and updated %old old one.', array('%new' => $newOnes, '%old' => $oldOnes));
}
else {
// Plural Plural
$message = $this->h5pF->t('Added %new new H5P libraries and updated %old old ones.', array('%new' => $newOnes, '%old' => $oldOnes));
}
}
}
elseif ($newOnes) {
if ($newOnes === 1) {
// Singular
$message = $this->h5pF->t('Added %new new H5P library.', array('%new' => $newOnes));
}
else {
// Plural
$message = $this->h5pF->t('Added %new new H5P libraries.', array('%new' => $newOnes));
}
}
elseif ($oldOnes) {
if ($oldOnes === 1) {
// Singular
$message = $this->h5pF->t('Updated %old H5P library.', array('%old' => $oldOnes));
}
else {
// Plural
$message = $this->h5pF->t('Updated %old H5P libraries.', array('%old' => $oldOnes));
}
}
if (isset($message)) {
$this->h5pF->setInfoMessage($message);
}
}
/**
* Delete an H5P package
*
* @param $content
*/
public function deletePackage($content) {
$this->h5pC->fs->deleteContent($content);
$this->h5pC->fs->deleteExport(($content['slug'] ? $content['slug'] . '-' : '') . $content['id'] . '.h5p');
$this->h5pF->deleteContentData($content['id']);
}
/**
* Copy/clone an H5P package
*
* May for instance be used if the content is being revisioned without
* uploading a new H5P package
*
* @param int $contentId
* The new content id
* @param int $copyFromId
* The content id of the content that should be cloned
* @param int $contentMainId
* The main id of the new content (used in frameworks that support revisioning)
*/
public function copyPackage($contentId, $copyFromId, $contentMainId = NULL) {
$this->h5pC->fs->cloneContent($copyFromId, $contentId);
$this->h5pF->copyLibraryUsage($contentId, $copyFromId, $contentMainId);
}
}
/**
* This class is used for exporting zips
*/
Class H5PExport {
public $h5pF;
public $h5pC;
/**
* Constructor for the H5PExport
*
* @param H5PFrameworkInterface|object $H5PFramework
* The frameworks implementation of the H5PFrameworkInterface
* @param H5PCore $H5PCore
* Reference to an instance of H5PCore
*/
public function __construct(H5PFrameworkInterface $H5PFramework, H5PCore $H5PCore) {
$this->h5pF = $H5PFramework;
$this->h5pC = $H5PCore;
}
/**
* Reverts the replace pattern used by the text editor
*
* @param string $value
* @return string
*/
private static function revertH5PEditorTextEscape($value) {
return str_replace('<', '<', str_replace('>', '>', str_replace(''', "'", str_replace('"', '"', $value))));
}
/**
* Return path to h5p package.
*
* Creates package if not already created
*
* @param array $content
* @return string
*/
public function createExportFile($content) {
// Get path to temporary folder, where export will be contained
$tmpPath = $this->h5pC->fs->getTmpPath();
mkdir($tmpPath, 0777, true);
try {
// Create content folder and populate with files
$this->h5pC->fs->exportContent($content['id'], "{$tmpPath}/content");
}
catch (Exception $e) {
$this->h5pF->setErrorMessage($this->h5pF->t($e->getMessage()), 'failed-creating-export-file');
H5PCore::deleteFileTree($tmpPath);
return FALSE;
}
// Update content.json with content from database
file_put_contents("{$tmpPath}/content/content.json", $content['filtered']);
// Make embedType into an array
$embedTypes = explode(', ', $content['embedType']);
// Build h5p.json, the en-/de-coding will ensure proper escaping
$h5pJson = array (
'title' => self::revertH5PEditorTextEscape($content['title']),
'language' => (isset($content['language']) && strlen(trim($content['language'])) !== 0) ? $content['language'] : 'und',
'mainLibrary' => $content['library']['name'],
'embedTypes' => $embedTypes
);
foreach(array('authors', 'source', 'license', 'licenseVersion', 'licenseExtras' ,'yearFrom', 'yearTo', 'changes', 'authorComments', 'defaultLanguage') as $field) {
if (isset($content['metadata'][$field]) && $content['metadata'][$field] !== '') {
if (($field !== 'authors' && $field !== 'changes') || (count($content['metadata'][$field]) > 0)) {
$h5pJson[$field] = json_decode(json_encode($content['metadata'][$field], TRUE));
}
}
}
// Remove all values that are not set
foreach ($h5pJson as $key => $value) {
if (!isset($value)) {
unset($h5pJson[$key]);
}
}
// Add dependencies to h5p
foreach ($content['dependencies'] as $dependency) {
$library = $dependency['library'];
try {
$exportFolder = NULL;
// Determine path of export library
if (isset($this->h5pC) && isset($this->h5pC->h5pD)) {
// Tries to find library in development folder
$isDevLibrary = $this->h5pC->h5pD->getLibrary(
$library['machineName'],
$library['majorVersion'],
$library['minorVersion']
);
if ($isDevLibrary !== NULL && isset($library['path'])) {
$exportFolder = "/" . $library['path'];
}
}
// Export required libraries
$this->h5pC->fs->exportLibrary($library, $tmpPath, $exportFolder);
}
catch (Exception $e) {
$this->h5pF->setErrorMessage($this->h5pF->t($e->getMessage()), 'failed-creating-export-file');
H5PCore::deleteFileTree($tmpPath);
return FALSE;
}
// Do not add editor dependencies to h5p json.
if ($dependency['type'] === 'editor') {
continue;
}
// Add to h5p.json dependencies
$h5pJson[$dependency['type'] . 'Dependencies'][] = array(
'machineName' => $library['machineName'],
'majorVersion' => $library['majorVersion'],
'minorVersion' => $library['minorVersion']
);
}
// Save h5p.json
$results = print_r(json_encode($h5pJson), true);
file_put_contents("{$tmpPath}/h5p.json", $results);
// Get a complete file list from our tmp dir
$files = array();
self::populateFileList($tmpPath, $files);
// Get path to temporary export target file
$tmpFile = $this->h5pC->fs->getTmpPath();
// Create new zip instance.
$zip = new ZipArchive();
$zip->open($tmpFile, ZipArchive::CREATE | ZipArchive::OVERWRITE);
// Add all the files from the tmp dir.
foreach ($files as $file) {
// Please note that the zip format has no concept of folders, we must
// use forward slashes to separate our directories.
if (file_exists(realpath($file->absolutePath))) {
$zip->addFile(realpath($file->absolutePath), $file->relativePath);
}
}
// Close zip and remove tmp dir
$zip->close();
H5PCore::deleteFileTree($tmpPath);
$filename = $content['slug'] . '-' . $content['id'] . '.h5p';
try {
// Save export
$this->h5pC->fs->saveExport($tmpFile, $filename);
}
catch (Exception $e) {
$this->h5pF->setErrorMessage($this->h5pF->t($e->getMessage()), 'failed-creating-export-file');
return false;
}
unlink($tmpFile);
$this->h5pF->afterExportCreated($content, $filename);
return true;
}
/**
* Recursive function the will add the files of the given directory to the
* given files list. All files are objects with an absolute path and
* a relative path. The relative path is forward slashes only! Great for
* use in zip files and URLs.
*
* @param string $dir path
* @param array $files list
* @param string $relative prefix. Optional
*/
private static function populateFileList($dir, &$files, $relative = '') {
$strip = strlen($dir) + 1;
$contents = glob($dir . '/' . '*');
if (!empty($contents)) {
foreach ($contents as $file) {
$rel = $relative . substr($file, $strip);
if (is_dir($file)) {
self::populateFileList($file, $files, $rel . '/');
}
else {
$files[] = (object) array(
'absolutePath' => $file,
'relativePath' => $rel
);
}
}
}
}
/**
* Delete .h5p file
*
* @param array $content object
*/
public function deleteExport($content) {
$this->h5pC->fs->deleteExport(($content['slug'] ? $content['slug'] . '-' : '') . $content['id'] . '.h5p');
}
/**
* Add editor libraries to the list of libraries
*
* These are not supposed to go into h5p.json, but must be included with the rest
* of the libraries
*
* TODO This is a private function that is not currently being used
*
* @param array $libraries
* List of libraries keyed by machineName
* @param array $editorLibraries
* List of libraries keyed by machineName
* @return array List of libraries keyed by machineName
*/
private function addEditorLibraries($libraries, $editorLibraries) {
foreach ($editorLibraries as $editorLibrary) {
$libraries[$editorLibrary['machineName']] = $editorLibrary;
}
return $libraries;
}
}
abstract class H5PPermission {
const DOWNLOAD_H5P = 0;
const EMBED_H5P = 1;
const CREATE_RESTRICTED = 2;
const UPDATE_LIBRARIES = 3;
const INSTALL_RECOMMENDED = 4;
const COPY_H5P = 8;
}
abstract class H5PDisplayOptionBehaviour {
const NEVER_SHOW = 0;
const CONTROLLED_BY_AUTHOR_DEFAULT_ON = 1;
const CONTROLLED_BY_AUTHOR_DEFAULT_OFF = 2;
const ALWAYS_SHOW = 3;
const CONTROLLED_BY_PERMISSIONS = 4;
}
> abstract class H5PContentHubSyncStatus {
abstract class H5PHubEndpoints {
> const NOT_SYNCED = 0;
const CONTENT_TYPES = 'api.h5p.org/v1/content-types/';
> const SYNCED = 1;
const SITES = 'api.h5p.org/v1/sites';
> const WAITING = 2;
> const FAILED = 3;
public static function createURL($endpoint) {
> }
$protocol = (extension_loaded('openssl') ? 'https' : 'http');
>
return "{$protocol}://{$endpoint}";
> abstract class H5PContentStatus {
}
> const STATUS_UNPUBLISHED = 0;
}
> const STATUS_DOWNLOADED = 1;
> const STATUS_WAITING = 2;
/**
> const STATUS_FAILED_DOWNLOAD = 3;
* Functions and storage shared by the other H5P classes
> const STATUS_FAILED_VALIDATION = 4;
*/
> const STATUS_SUSPENDED = 5;
class H5PCore {
> }
>
public static $coreApi = array(
> const METADATA = 'hub-api.h5p.org/v1/metadata';
'majorVersion' => 1,
> const CONTENT = 'hub-api.h5p.org/v1/contents';
'minorVersion' => 24
> const REGISTER = 'hub-api.h5p.org/v1/accounts';
< 'minorVersion' => 24
> 'minorVersion' => 25
public static $styles = array(
'styles/h5p.css',
'styles/h5p-confirmation-dialog.css',
< 'styles/h5p-core-button.css'
> 'styles/h5p-core-button.css',
> 'styles/h5p-tooltip.css',
);
public static $scripts = array(
'js/jquery.js',
'js/h5p.js',
'js/h5p-event-dispatcher.js',
'js/h5p-x-api-event.js',
'js/h5p-x-api.js',
'js/h5p-content-type.js',
'js/h5p-confirmation-dialog.js',
'js/h5p-action-bar.js',
'js/request-queue.js',
> 'js/h5p-tooltip.js',
);
public static $adminScripts = array(
'js/jquery.js',
'js/h5p-utils.js',
);
< public static $defaultContentWhitelist = 'json png jpg jpeg gif bmp tif tiff svg eot ttf woff woff2 otf webm mp4 ogg mp3 m4a wav txt pdf rtf doc docx xls xlsx ppt pptx odt ods odp xml csv diff patch swf md textile vtt webvtt';
> public static $defaultContentWhitelist = 'json png jpg jpeg gif bmp tif tiff svg eot ttf woff woff2 otf webm mp4 ogg mp3 m4a wav txt pdf rtf doc docx xls xlsx ppt pptx odt ods odp xml csv diff patch swf md textile vtt webvtt gltf glb';
public static $defaultLibraryWhitelistExtras = 'js css';
public $librariesJsonData, $contentJsonData, $mainJsonData, $h5pF, $fs, $h5pD, $disableFileCheck;
const SECONDS_IN_WEEK = 604800;
private $exportEnabled;
// Disable flags
const DISABLE_NONE = 0;
const DISABLE_FRAME = 1;
const DISABLE_DOWNLOAD = 2;
const DISABLE_EMBED = 4;
const DISABLE_COPYRIGHT = 8;
const DISABLE_ABOUT = 16;
const DISPLAY_OPTION_FRAME = 'frame';
const DISPLAY_OPTION_DOWNLOAD = 'export';
const DISPLAY_OPTION_EMBED = 'embed';
const DISPLAY_OPTION_COPYRIGHT = 'copyright';
const DISPLAY_OPTION_ABOUT = 'icon';
const DISPLAY_OPTION_COPY = 'copy';
// Map flags to string
public static $disable = array(
self::DISABLE_FRAME => self::DISPLAY_OPTION_FRAME,
self::DISABLE_DOWNLOAD => self::DISPLAY_OPTION_DOWNLOAD,
self::DISABLE_EMBED => self::DISPLAY_OPTION_EMBED,
self::DISABLE_COPYRIGHT => self::DISPLAY_OPTION_COPYRIGHT
);
> /** @var string To file storage directory. */
/**
> public $url;
* Constructor for the H5PCore
>
*
> /** @var int evelopment mode. */
* @param H5PFrameworkInterface $H5PFramework
> public $development_mode;
* The frameworks implementation of the H5PFrameworkInterface
>
* @param string|H5PFileStorage $path H5P file storage directory or class.
> /** @var bool aggregated files for assets. */
* @param string $url To file storage directory.
> public $aggregateAssets;
* @param string $language code. Defaults to english.
>
* @param boolean $export enabled?
> /** @var string full path of plugin. */
*/
> protected $fullPluginPath;
public function __construct(H5PFrameworkInterface $H5PFramework, $path, $url, $language = 'en', $export = FALSE) {
>
$this->h5pF = $H5PFramework;
> /** @var string regex for converting copied files paths. */
> public $relativePathRegExp;
$this->fs = ($path instanceof H5PFileStorage ? $path : new H5PDefaultStorage($path));
>
$this->url = $url;
$this->exportEnabled = $export;
$this->development_mode = H5PDevelopment::MODE_NONE;
$this->aggregateAssets = FALSE; // Off by default.. for now
$this->detectSiteType();
$this->fullPluginPath = preg_replace('/\/[^\/]+[\/]?$/', '' , dirname(__FILE__));
// Standard regex for converting copied files paths
$this->relativePathRegExp = '/^((\.\.\/){1,2})(.*content\/)?(\d+|editor)\/(.+)$/';
}
/**
* Save content and clear cache.
*
* @param array $content
* @param null|int $contentMainId
* @return int Content ID
*/
public function saveContent($content, $contentMainId = NULL) {
if (isset($content['id'])) {
$this->h5pF->updateContent($content, $contentMainId);
}
else {
$content['id'] = $this->h5pF->insertContent($content, $contentMainId);
}
// Some user data for content has to be reset when the content changes.
$this->h5pF->resetContentUserData($contentMainId ? $contentMainId : $content['id']);
return $content['id'];
}
/**
* Load content.
*
* @param int $id for content.
* @return object
*/
public function loadContent($id) {
$content = $this->h5pF->loadContent($id);
if ($content !== NULL) {
// Validate main content's metadata
$validator = new H5PContentValidator($this->h5pF, $this);
$content['metadata'] = $validator->validateMetadata($content['metadata']);
$content['library'] = array(
'id' => $content['libraryId'],
'name' => $content['libraryName'],
'majorVersion' => $content['libraryMajorVersion'],
'minorVersion' => $content['libraryMinorVersion'],
'embedTypes' => $content['libraryEmbedTypes'],
'fullscreen' => $content['libraryFullscreen'],
);
unset($content['libraryId'], $content['libraryName'], $content['libraryEmbedTypes'], $content['libraryFullscreen']);
// // TODO: Move to filterParameters?
// if (isset($this->h5pD)) {
// // TODO: Remove Drupal specific stuff
// $json_content_path = file_create_path(file_directory_path() . '/' . variable_get('h5p_default_path', 'h5p') . '/content/' . $id . '/content.json');
// if (file_exists($json_content_path) === TRUE) {
// $json_content = file_get_contents($json_content_path);
// if (json_decode($json_content, TRUE) !== FALSE) {
// drupal_set_message(t('Invalid json in json content'), 'warning');
// }
// $content['params'] = $json_content;
// }
// }
}
return $content;
}
/**
* Filter content run parameters, rebuild content dependency cache and export file.
*
* @param Object|array $content
* @return Object NULL on failure.
*/
public function filterParameters(&$content) {
if (!empty($content['filtered']) &&
(!$this->exportEnabled ||
($content['slug'] &&
$this->fs->hasExport($content['slug'] . '-' . $content['id'] . '.h5p')))) {
return $content['filtered'];
}
if (!(isset($content['library']) && isset($content['params']))) {
return NULL;
}
// Validate and filter against main library semantics.
$validator = new H5PContentValidator($this->h5pF, $this);
$params = (object) array(
'library' => H5PCore::libraryToString($content['library']),
'params' => json_decode($content['params'])
);
if (!$params->params) {
return NULL;
}
$validator->validateLibrary($params, (object) array('options' => array($params->library)));
// Handle addons:
$addons = $this->h5pF->loadAddons();
foreach ($addons as $addon) {
$add_to = json_decode($addon['addTo']);
if (isset($add_to->content->types)) {
foreach($add_to->content->types as $type) {
if (isset($type->text->regex) &&
$this->textAddonMatches($params->params, $type->text->regex)) {
$validator->addon($addon);
// An addon shall only be added once
break;
}
}
}
}
$params = json_encode($params->params);
// Update content dependencies.
$content['dependencies'] = $validator->getDependencies();
// Sometimes the parameters are filtered before content has been created
if ($content['id']) {
$this->h5pF->deleteLibraryUsage($content['id']);
$this->h5pF->saveLibraryUsage($content['id'], $content['dependencies']);
if (!$content['slug']) {
$content['slug'] = $this->generateContentSlug($content);
// Remove old export file
$this->fs->deleteExport($content['id'] . '.h5p');
}
if ($this->exportEnabled) {
// Recreate export file
$exporter = new H5PExport($this->h5pF, $this);
$content['filtered'] = $params;
$exporter->createExportFile($content);
}
// Cache.
$this->h5pF->updateContentFields($content['id'], array(
'filtered' => $params,
'slug' => $content['slug']
));
}
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 any match.
*
* @param {object} params - Parameters.
* @param {string} [pattern] - Regular expression to identify pattern.
* @param {boolean} [found] - Used for recursion.
* @return {boolean} True, if params matches pattern.
*/
private function textAddonMatches($params, $pattern, $found = false) {
$type = gettype($params);
if ($type === 'string') {
if (preg_match($pattern, $params) === 1) {
return true;
}
}
elseif ($type === 'array' || $type === 'object') {
foreach ($params as $value) {
$found = $this->textAddonMatches($value, $pattern, $found);
if ($found === true) {
return true;
}
}
}
return false;
}
/**
* Generate content slug
*
* @param array $content object
* @return string unique content slug
*/
private function generateContentSlug($content) {
$slug = H5PCore::slugify($content['title']);
$available = NULL;
while (!$available) {
if ($available === FALSE) {
// If not available, add number suffix.
$matches = array();
if (preg_match('/(.+-)([0-9]+)$/', $slug, $matches)) {
$slug = $matches[1] . (intval($matches[2]) + 1);
}
else {
$slug .= '-2';
}
}
$available = $this->h5pF->isContentSlugAvailable($slug);
}
return $slug;
}
/**
* Find the files required for this content to work.
*
* @param int $id for content.
* @param null $type
* @return array
*/
public function loadContentDependencies($id, $type = NULL) {
$dependencies = $this->h5pF->loadContentDependencies($id, $type);
if (isset($this->h5pD)) {
$developmentLibraries = $this->h5pD->getLibraries();
foreach ($dependencies as $key => $dependency) {
$libraryString = H5PCore::libraryToString($dependency);
if (isset($developmentLibraries[$libraryString])) {
$developmentLibraries[$libraryString]['dependencyType'] = $dependencies[$key]['dependencyType'];
$dependencies[$key] = $developmentLibraries[$libraryString];
}
}
}
return $dependencies;
}
/**
* Get all dependency assets of the given type
*
* @param array $dependency
* @param string $type
* @param array $assets
* @param string $prefix Optional. Make paths relative to another dir.
*/
private function getDependencyAssets($dependency, $type, &$assets, $prefix = '') {
// Check if dependency has any files of this type
if (empty($dependency[$type]) || $dependency[$type][0] === '') {
return;
}
// Check if we should skip CSS.
if ($type === 'preloadedCss' && (isset($dependency['dropCss']) && $dependency['dropCss'] === '1')) {
return;
}
foreach ($dependency[$type] as $file) {
$assets[] = (object) array(
'path' => $prefix . '/' . $dependency['path'] . '/' . trim(is_array($file) ? $file['path'] : $file),
'version' => $dependency['version']
);
}
}
/**
* Combines path with cache buster / version.
*
* @param array $assets
* @return array
*/
public function getAssetsUrls($assets) {
$urls = array();
foreach ($assets as $asset) {
$url = $asset->path;
// Add URL prefix if not external
if (strpos($asset->path, '://') === FALSE) {
$url = $this->url . $url;
}
// Add version/cache buster if set
if (isset($asset->version)) {
$url .= $asset->version;
}
$urls[] = $url;
}
return $urls;
}
/**
* Return file paths for all dependencies files.
*
* @param array $dependencies
* @param string $prefix Optional. Make paths relative to another dir.
* @return array files.
*/
public function getDependenciesFiles($dependencies, $prefix = '') {
// Build files list for assets
$files = array(
'scripts' => array(),
'styles' => array()
);
$key = null;
// Avoid caching empty files
if (empty($dependencies)) {
return $files;
}
if ($this->aggregateAssets) {
// Get aggregated files for assets
$key = self::getDependenciesHash($dependencies);
$cachedAssets = $this->fs->getCachedAssets($key);
if ($cachedAssets !== NULL) {
return array_merge($files, $cachedAssets); // Using cached assets
}
}
// Using content dependencies
foreach ($dependencies as $dependency) {
if (isset($dependency['path']) === FALSE) {
$dependency['path'] = $this->getDependencyPath($dependency);
$dependency['preloadedJs'] = explode(',', $dependency['preloadedJs']);
$dependency['preloadedCss'] = explode(',', $dependency['preloadedCss']);
}
$dependency['version'] = "?ver={$dependency['majorVersion']}.{$dependency['minorVersion']}.{$dependency['patchVersion']}";
$this->getDependencyAssets($dependency, 'preloadedJs', $files['scripts'], $prefix);
$this->getDependencyAssets($dependency, 'preloadedCss', $files['styles'], $prefix);
}
if ($this->aggregateAssets) {
// Aggregate and store assets
$this->fs->cacheAssets($files, $key);
// Keep track of which libraries have been cached in case they are updated
$this->h5pF->saveCachedAssets($key, $dependencies);
}
return $files;
}
/**
* Get the path to the dependency.
*
< * @param stdClass $dependency
> * @param array $dependency
* @return string
*/
< protected function getDependencyPath(array $dependency): string {
< return H5PCore::libraryToString($dependency, TRUE);
> protected function getDependencyPath(array $dependency) {
> return 'libraries/' . H5PCore::libraryToFolderName($dependency);
}
private static function getDependenciesHash(&$dependencies) {
// Build hash of dependencies
$toHash = array();
// Use unique identifier for each library version
foreach ($dependencies as $dep) {
$toHash[] = "{$dep['machineName']}-{$dep['majorVersion']}.{$dep['minorVersion']}.{$dep['patchVersion']}";
}
// Sort in case the same dependencies comes in a different order
sort($toHash);
// Calculate hash sum
return hash('sha1', implode('', $toHash));
}
/**
* Load library semantics.
*
* @param $name
* @param $majorVersion
* @param $minorVersion
* @return string
*/
public function loadLibrarySemantics($name, $majorVersion, $minorVersion) {
$semantics = NULL;
if (isset($this->h5pD)) {
// Try to load from dev lib
$semantics = $this->h5pD->getSemantics($name, $majorVersion, $minorVersion);
}
if ($semantics === NULL) {
// Try to load from DB.
$semantics = $this->h5pF->loadLibrarySemantics($name, $majorVersion, $minorVersion);
}
if ($semantics !== NULL) {
$semantics = json_decode($semantics);
$this->h5pF->alterLibrarySemantics($semantics, $name, $majorVersion, $minorVersion);
}
return $semantics;
}
/**
* Load library.
*
* @param $name
* @param $majorVersion
* @param $minorVersion
* @return array or null.
*/
public function loadLibrary($name, $majorVersion, $minorVersion) {
$library = NULL;
if (isset($this->h5pD)) {
// Try to load from dev
$library = $this->h5pD->getLibrary($name, $majorVersion, $minorVersion);
if ($library !== NULL) {
$library['semantics'] = $this->h5pD->getSemantics($name, $majorVersion, $minorVersion);
}
}
if ($library === NULL) {
// Try to load from DB.
$library = $this->h5pF->loadLibrary($name, $majorVersion, $minorVersion);
}
return $library;
}
/**
* Deletes a library
*
* @param stdClass $libraryId
*/
public function deleteLibrary($libraryId) {
$this->h5pF->deleteLibrary($libraryId);
}
/**
* Recursive. Goes through the dependency tree for the given library and
* adds all the dependencies to the given array in a flat format.
*
* @param $dependencies
* @param array $library To find all dependencies for.
* @param int $nextWeight An integer determining the order of the libraries
* when they are loaded
* @param bool $editor Used internally to force all preloaded sub dependencies
* of an editor dependency to be editor dependencies.
* @return int
*/
public function findLibraryDependencies(&$dependencies, $library, $nextWeight = 1, $editor = FALSE) {
foreach (array('dynamic', 'preloaded', 'editor') as $type) {
$property = $type . 'Dependencies';
if (!isset($library[$property])) {
continue; // Skip, no such dependencies.
}
if ($type === 'preloaded' && $editor === TRUE) {
// All preloaded dependencies of an editor library is set to editor.
$type = 'editor';
}
foreach ($library[$property] as $dependency) {
$dependencyKey = $type . '-' . $dependency['machineName'];
if (isset($dependencies[$dependencyKey]) === TRUE) {
continue; // Skip, already have this.
}
$dependencyLibrary = $this->loadLibrary($dependency['machineName'], $dependency['majorVersion'], $dependency['minorVersion']);
if ($dependencyLibrary) {
$dependencies[$dependencyKey] = array(
'library' => $dependencyLibrary,
'type' => $type
);
$nextWeight = $this->findLibraryDependencies($dependencies, $dependencyLibrary, $nextWeight, $type === 'editor');
$dependencies[$dependencyKey]['weight'] = $nextWeight++;
}
else {
// This site is missing a dependency!
$this->h5pF->setErrorMessage($this->h5pF->t('Missing dependency @dep required by @lib.', array('@dep' => H5PCore::libraryToString($dependency), '@lib' => H5PCore::libraryToString($library))), 'missing-library-dependency');
}
}
}
return $nextWeight;
}
/**
* Check if a library is of the version we're looking for
*
* Same version means that the majorVersion and minorVersion is the same
*
* @param array $library
* Data from library.json
* @param array $dependency
* Definition of what library we're looking for
* @return boolean
* TRUE if the library is the same version as the dependency
* FALSE otherwise
*/
public function isSameVersion($library, $dependency) {
if ($library['machineName'] != $dependency['machineName']) {
return FALSE;
}
if ($library['majorVersion'] != $dependency['majorVersion']) {
return FALSE;
}
if ($library['minorVersion'] != $dependency['minorVersion']) {
return FALSE;
}
return TRUE;
}
/**
* Recursive function for removing directories.
*
* @param string $dir
* Path to the directory we'll be deleting
* @return boolean
* Indicates if the directory existed.
*/
public static function deleteFileTree($dir) {
if (!is_dir($dir)) {
return false;
}
if (is_link($dir)) {
// Do not traverse and delete linked content, simply unlink.
unlink($dir);
return;
}
$files = array_diff(scandir($dir), array('.','..'));
foreach ($files as $file) {
$filepath = "$dir/$file";
// Note that links may resolve as directories
if (!is_dir($filepath) || is_link($filepath)) {
// Unlink files and links
unlink($filepath);
}
else {
// Traverse subdir and delete files
self::deleteFileTree($filepath);
}
}
return rmdir($dir);
}
/**
* Writes library data as string on the form {machineName} {majorVersion}.{minorVersion}
*
* @param array $library
< * With keys machineName, majorVersion and minorVersion
< * @param boolean $folderName
< * Use hyphen instead of space in returned string.
> * With keys (machineName and/or name), majorVersion and minorVersion
* @return string
* On the form {machineName} {majorVersion}.{minorVersion}
*/
< public static function libraryToString($library, $folderName = FALSE) {
< return (isset($library['machineName']) ? $library['machineName'] : $library['name']) . ($folderName ? '-' : ' ') . $library['majorVersion'] . '.' . $library['minorVersion'];
> public static function libraryToString($library) {
> $name = $library['machineName'] ?? $library['name'];
>
> return "{$name} {$library['majorVersion']}.{$library['minorVersion']}";
> }
>
> /**
> * Get the name of a library's folder name
> *
> * @return string
> */
> public static function libraryToFolderName($library) {
> $name = $library['machineName'] ?? $library['name'];
> $includePatchVersion = $library['patchVersionInFolderName'] ?? false;
>
> return "{$name}-{$library['majorVersion']}.{$library['minorVersion']}" . ($includePatchVersion ? ".{$library['patchVersion']}" : '');
}
/**
* Parses library data from a string on the form {machineName} {majorVersion}.{minorVersion}
*
* @param string $libraryString
* On the form {machineName} {majorVersion}.{minorVersion}
* @return array|FALSE
* With keys machineName, majorVersion and minorVersion.
* Returns FALSE only if string is not parsable in the normal library
* string formats "Lib.Name-x.y" or "Lib.Name x.y"
*/
public static function libraryFromString($libraryString) {
$re = '/^([\w0-9\-\.]{1,255})[\-\ ]([0-9]{1,5})\.([0-9]{1,5})$/i';
$matches = array();
$res = preg_match($re, $libraryString, $matches);
if ($res) {
return array(
'machineName' => $matches[1],
'majorVersion' => $matches[2],
'minorVersion' => $matches[3]
);
}
return FALSE;
}
/**
* Determine the correct embed type to use.
*
* @param $contentEmbedType
* @param $libraryEmbedTypes
* @return string 'div' or 'iframe'.
*/
public static function determineEmbedType($contentEmbedType, $libraryEmbedTypes) {
// Detect content embed type
$embedType = strpos(strtolower($contentEmbedType), 'div') !== FALSE ? 'div' : 'iframe';
if ($libraryEmbedTypes !== NULL && $libraryEmbedTypes !== '') {
// Check that embed type is available for library
$embedTypes = strtolower($libraryEmbedTypes);
if (strpos($embedTypes, $embedType) === FALSE) {
// Not available, pick default.
$embedType = strpos($embedTypes, 'div') !== FALSE ? 'div' : 'iframe';
}
}
return $embedType;
}
/**
* Get the absolute version for the library as a human readable string.
*
* @param object $library
* @return string
*/
public static function libraryVersion($library) {
return $library->major_version . '.' . $library->minor_version . '.' . $library->patch_version;
}
/**
* Determine which versions content with the given library can be upgraded to.
*
* @param object $library
* @param array $versions
* @return array
*/
public function getUpgrades($library, $versions) {
$upgrades = array();
foreach ($versions as $upgrade) {
if ($upgrade->major_version > $library->major_version || $upgrade->major_version === $library->major_version && $upgrade->minor_version > $library->minor_version) {
$upgrades[$upgrade->id] = H5PCore::libraryVersion($upgrade);
}
}
return $upgrades;
}
/**
* Converts all the properties of the given object or array from
* snake_case to camelCase. Useful after fetching data from the database.
*
* Note that some databases does not support camelCase.
*
* @param mixed $arr input
* @param boolean $obj return object
* @return mixed object or array
*/
public static function snakeToCamel($arr, $obj = false) {
$newArr = array();
foreach ($arr as $key => $val) {
$next = -1;
while (($next = strpos($key, '_', $next + 1)) !== FALSE) {
$key = substr_replace($key, strtoupper($key[$next + 1]), $next, 2);
}
$newArr[$key] = $val;
}
return $obj ? (object) $newArr : $newArr;
}
/**
* Detects if the site was accessed from localhost,
* through a local network or from the internet.
*/
public function detectSiteType() {
$type = $this->h5pF->getOption('site_type', 'local');
// Determine remote/visitor origin
if ($type === 'network' ||
($type === 'local' &&
isset($_SERVER['REMOTE_ADDR']) &&
!preg_match('/^localhost$|^127(?:\.[0-9]+){0,2}\.[0-9]+$|^(?:0*\:)*?:?0*1$/i', $_SERVER['REMOTE_ADDR']))) {
if (isset($_SERVER['REMOTE_ADDR']) && filter_var($_SERVER['REMOTE_ADDR'], FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE)) {
// Internet
$this->h5pF->setOption('site_type', 'internet');
}
elseif ($type === 'local') {
// Local network
$this->h5pF->setOption('site_type', 'network');
}
}
}
/**
* Get a list of installed libraries, different minor versions will
* return separate entries.
*
* @return array
* A distinct array of installed libraries
*/
public function getLibrariesInstalled() {
$librariesInstalled = array();
$libs = $this->h5pF->loadLibraries();
foreach($libs as $libName => $library) {
foreach($library as $libVersion) {
$librariesInstalled[$libName.' '.$libVersion->major_version.'.'.$libVersion->minor_version] = $libVersion->patch_version;
}
}
return $librariesInstalled;
}
/**
* Easy way to combine similar data sets.
*
* @param array $inputs Multiple arrays with data
* @return array
*/
public function combineArrayValues($inputs) {
$results = array();
foreach ($inputs as $index => $values) {
foreach ($values as $key => $value) {
$results[$key][$index] = $value;
}
}
return $results;
}
/**
* Communicate with H5P.org and get content type cache. Each platform
* implementation is responsible for invoking this, eg using cron
*
* @param bool $fetchingDisabled
> * @param bool $onlyRegister Only register site with H5P.org
*
* @return bool|object Returns endpoint data if found, otherwise FALSE
*/
< public function fetchLibrariesMetadata($fetchingDisabled = FALSE) {
> public function fetchLibrariesMetadata($fetchingDisabled = FALSE, $onlyRegister = false) {
// Gather data
$uuid = $this->h5pF->getOption('site_uuid', '');
$platform = $this->h5pF->getPlatformInfo();
$registrationData = array(
'uuid' => $uuid,
'platform_name' => $platform['name'],
'platform_version' => $platform['version'],
'h5p_version' => $platform['h5pVersion'],
'disabled' => $fetchingDisabled ? 1 : 0,
'local_id' => hash('crc32', $this->fullPluginPath),
'type' => $this->h5pF->getOption('site_type', 'local'),
'core_api_version' => H5PCore::$coreApi['majorVersion'] . '.' .
H5PCore::$coreApi['minorVersion']
);
// Register site if it is not registered
if (empty($uuid)) {
$registration = $this->h5pF->fetchExternalData(H5PHubEndpoints::createURL(H5PHubEndpoints::SITES), $registrationData);
// Failed retrieving uuid
if (!$registration) {
$errorMessage = $this->h5pF->t('Site could not be registered with the hub. Please contact your site administrator.');
$this->h5pF->setErrorMessage($errorMessage);
$this->h5pF->setErrorMessage(
$this->h5pF->t('The H5P Hub has been disabled until this problem can be resolved. You may still upload libraries through the "H5P Libraries" page.'),
'registration-failed-hub-disabled'
);
return FALSE;
}
// Successfully retrieved new uuid
$json = json_decode($registration);
$registrationData['uuid'] = $json->uuid;
$this->h5pF->setOption('site_uuid', $json->uuid);
$this->h5pF->setInfoMessage(
$this->h5pF->t('Your site was successfully registered with the H5P Hub.')
);
> $uuid = $json->uuid;
// TODO: Uncomment when key is once again available in H5P Settings
// $this->h5pF->setInfoMessage(
// $this->h5pF->t('You have been provided a unique key that identifies you with the Hub when receiving new updates. The key is available for viewing in the "H5P Settings" page.')
// );
}
> if ($onlyRegister) {
if ($this->h5pF->getOption('send_usage_statistics', TRUE)) {
> return $uuid;
$siteData = array_merge(
> }
$registrationData,
>
array(
'num_authors' => $this->h5pF->getNumAuthors(),
'libraries' => json_encode($this->combineArrayValues(array(
'patch' => $this->getLibrariesInstalled(),
'content' => $this->h5pF->getLibraryContentCount(),
'loaded' => $this->h5pF->getLibraryStats('library'),
'created' => $this->h5pF->getLibraryStats('content create'),
'createdUpload' => $this->h5pF->getLibraryStats('content create upload'),
'deleted' => $this->h5pF->getLibraryStats('content delete'),
'resultViews' => $this->h5pF->getLibraryStats('results content'),
'shortcodeInserts' => $this->h5pF->getLibraryStats('content shortcode insert')
)))
)
);
}
else {
$siteData = $registrationData;
}
$result = $this->updateContentTypeCache($siteData);
// No data received
if (!$result || empty($result)) {
return FALSE;
}
// Handle libraries metadata
if (isset($result->libraries)) {
foreach ($result->libraries as $library) {
if (isset($library->tutorialUrl) && isset($library->machineName)) {
$this->h5pF->setLibraryTutorialUrl($library->machineNamee, $library->tutorialUrl);
}
}
}
return $result;
}
/**
* Create representation of display options as int
*
* @param array $sources
* @param int $current
* @return int
*/
public function getStorableDisplayOptions(&$sources, $current) {
// Download - force setting it if always on or always off
$download = $this->h5pF->getOption(self::DISPLAY_OPTION_DOWNLOAD, H5PDisplayOptionBehaviour::ALWAYS_SHOW);
if ($download == H5PDisplayOptionBehaviour::ALWAYS_SHOW ||
$download == H5PDisplayOptionBehaviour::NEVER_SHOW) {
$sources[self::DISPLAY_OPTION_DOWNLOAD] = ($download == H5PDisplayOptionBehaviour::ALWAYS_SHOW);
}
// Embed - force setting it if always on or always off
$embed = $this->h5pF->getOption(self::DISPLAY_OPTION_EMBED, H5PDisplayOptionBehaviour::ALWAYS_SHOW);
if ($embed == H5PDisplayOptionBehaviour::ALWAYS_SHOW ||
$embed == H5PDisplayOptionBehaviour::NEVER_SHOW) {
$sources[self::DISPLAY_OPTION_EMBED] = ($embed == H5PDisplayOptionBehaviour::ALWAYS_SHOW);
}
foreach (H5PCore::$disable as $bit => $option) {
if (!isset($sources[$option]) || !$sources[$option]) {
$current |= $bit; // Disable
}
else {
$current &= ~$bit; // Enable
}
}
return $current;
}
/**
* Determine display options visibility and value on edit
*
* @param int $disable
* @return array
*/
public function getDisplayOptionsForEdit($disable = NULL) {
$display_options = array();
$current_display_options = $disable === NULL ? array() : $this->getDisplayOptionsAsArray($disable);
if ($this->h5pF->getOption(self::DISPLAY_OPTION_FRAME, TRUE)) {
$display_options[self::DISPLAY_OPTION_FRAME] =
isset($current_display_options[self::DISPLAY_OPTION_FRAME]) ?
$current_display_options[self::DISPLAY_OPTION_FRAME] :
TRUE;
// Download
$export = $this->h5pF->getOption(self::DISPLAY_OPTION_DOWNLOAD, H5PDisplayOptionBehaviour::ALWAYS_SHOW);
if ($export == H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_ON ||
$export == H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_OFF) {
$display_options[self::DISPLAY_OPTION_DOWNLOAD] =
isset($current_display_options[self::DISPLAY_OPTION_DOWNLOAD]) ?
$current_display_options[self::DISPLAY_OPTION_DOWNLOAD] :
($export == H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_ON);
}
// Embed
$embed = $this->h5pF->getOption(self::DISPLAY_OPTION_EMBED, H5PDisplayOptionBehaviour::ALWAYS_SHOW);
if ($embed == H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_ON ||
$embed == H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_OFF) {
$display_options[self::DISPLAY_OPTION_EMBED] =
isset($current_display_options[self::DISPLAY_OPTION_EMBED]) ?
$current_display_options[self::DISPLAY_OPTION_EMBED] :
($embed == H5PDisplayOptionBehaviour::CONTROLLED_BY_AUTHOR_DEFAULT_ON);
}
// Copyright
if ($this->h5pF->getOption(self::DISPLAY_OPTION_COPYRIGHT, TRUE)) {
$display_options[self::DISPLAY_OPTION_COPYRIGHT] =
isset($current_display_options[self::DISPLAY_OPTION_COPYRIGHT]) ?
$current_display_options[self::DISPLAY_OPTION_COPYRIGHT] :
TRUE;
}
}
return $display_options;
}
/**
* Helper function used to figure out embed & download behaviour
*
* @param string $option_name
* @param H5PPermission $permission
* @param int $id
* @param bool &$value
*/
private function setDisplayOptionOverrides($option_name, $permission, $id, &$value) {
$behaviour = $this->h5pF->getOption($option_name, H5PDisplayOptionBehaviour::ALWAYS_SHOW);
// If never show globally, force hide
if ($behaviour == H5PDisplayOptionBehaviour::NEVER_SHOW) {
$value = false;
}
elseif ($behaviour == H5PDisplayOptionBehaviour::ALWAYS_SHOW) {
// If always show or permissions say so, force show
$value = true;
}
elseif ($behaviour == H5PDisplayOptionBehaviour::CONTROLLED_BY_PERMISSIONS) {
$value = $this->h5pF->hasPermission($permission, $id);
}
}
/**
* Determine display option visibility when viewing H5P
*
* @param int $display_options
* @param int $id Might be content id or user id.
* Depends on what the platform needs to be able to determine permissions.
* @return array
*/
public function getDisplayOptionsForView($disable, $id) {
$display_options = $this->getDisplayOptionsAsArray($disable);
if ($this->h5pF->getOption(self::DISPLAY_OPTION_FRAME, TRUE) == FALSE) {
$display_options[self::DISPLAY_OPTION_FRAME] = false;
}
else {
$this->setDisplayOptionOverrides(self::DISPLAY_OPTION_DOWNLOAD, H5PPermission::DOWNLOAD_H5P, $id, $display_options[self::DISPLAY_OPTION_DOWNLOAD]);
$this->setDisplayOptionOverrides(self::DISPLAY_OPTION_EMBED, H5PPermission::EMBED_H5P, $id, $display_options[self::DISPLAY_OPTION_EMBED]);
if ($this->h5pF->getOption(self::DISPLAY_OPTION_COPYRIGHT, TRUE) == FALSE) {
$display_options[self::DISPLAY_OPTION_COPYRIGHT] = false;
}
}
$display_options[self::DISPLAY_OPTION_COPY] = $this->h5pF->hasPermission(H5PPermission::COPY_H5P, $id);
return $display_options;
}
/**
* Convert display options as single byte to array
*
* @param int $disable
* @return array
*/
private function getDisplayOptionsAsArray($disable) {
return array(
self::DISPLAY_OPTION_FRAME => !($disable & H5PCore::DISABLE_FRAME),
self::DISPLAY_OPTION_DOWNLOAD => !($disable & H5PCore::DISABLE_DOWNLOAD),
self::DISPLAY_OPTION_EMBED => !($disable & H5PCore::DISABLE_EMBED),
self::DISPLAY_OPTION_COPYRIGHT => !($disable & H5PCore::DISABLE_COPYRIGHT),
self::DISPLAY_OPTION_ABOUT => !!$this->h5pF->getOption(self::DISPLAY_OPTION_ABOUT, TRUE),
);
}
/**
* Small helper for getting the library's ID.
*
* @param array $library
* @param string [$libString]
* @return int Identifier, or FALSE if non-existent
*/
public function getLibraryId($library, $libString = NULL) {
> static $libraryIdMap = [];
if (!$libString) {
>
$libString = self::libraryToString($library);
}
if (!isset($libraryIdMap[$libString])) {
$libraryIdMap[$libString] = $this->h5pF->getLibraryId($library['machineName'], $library['majorVersion'], $library['minorVersion']);
}
return $libraryIdMap[$libString];
}
/**
* Convert strings of text into simple kebab case slugs.
* Very useful for readable urls etc.
*
* @param string $input
* @return string
*/
public static function slugify($input) {
// Down low
$input = strtolower($input);
// Replace common chars
$input = str_replace(
array('æ', 'ø', 'ö', 'ó', 'ô', 'Ò', 'Õ', 'Ý', 'ý', 'ÿ', 'ā', 'ă', 'ą', 'œ', 'å', 'ä', 'á', 'à', 'â', 'ã', 'ç', 'ć', 'ĉ', 'ċ', 'č', 'é', 'è', 'ê', 'ë', 'í', 'ì', 'î', 'ï', 'ú', 'ñ', 'ü', 'ù', 'û', 'ß', 'ď', 'đ', 'ē', 'ĕ', 'ė', 'ę', 'ě', 'ĝ', 'ğ', 'ġ', 'ģ', 'ĥ', 'ħ', 'ĩ', 'ī', 'ĭ', 'į', 'ı', 'ij', 'ĵ', 'ķ', 'ĺ', 'ļ', 'ľ', 'ŀ', 'ł', 'ń', 'ņ', 'ň', 'ʼn', 'ō', 'ŏ', 'ő', 'ŕ', 'ŗ', 'ř', 'ś', 'ŝ', 'ş', 'š', 'ţ', 'ť', 'ŧ', 'ũ', 'ū', 'ŭ', 'ů', 'ű', 'ų', 'ŵ', 'ŷ', 'ź', 'ż', 'ž', 'ſ', 'ƒ', 'ơ', 'ư', 'ǎ', 'ǐ', 'ǒ', 'ǔ', 'ǖ', 'ǘ', 'ǚ', 'ǜ', 'ǻ', 'ǽ', 'ǿ'),
array('ae', 'oe', 'o', 'o', 'o', 'oe', 'o', 'o', 'y', 'y', 'y', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'a', 'c', 'c', 'c', 'c', 'c', 'e', 'e', 'e', 'e', 'i', 'i', 'i', 'i', 'u', 'n', 'u', 'u', 'u', 'es', 'd', 'd', 'e', 'e', 'e', 'e', 'e', 'g', 'g', 'g', 'g', 'h', 'h', 'i', 'i', 'i', 'i', 'i', 'ij', 'j', 'k', 'l', 'l', 'l', 'l', 'l', 'n', 'n', 'n', 'n', 'o', 'o', 'o', 'r', 'r', 'r', 's', 's', 's', 's', 't', 't', 't', 'u', 'u', 'u', 'u', 'u', 'u', 'w', 'y', 'z', 'z', 'z', 's', 'f', 'o', 'u', 'a', 'i', 'o', 'u', 'u', 'u', 'u', 'u', 'a', 'ae', 'oe'),
$input);
// Replace everything else
$input = preg_replace('/[^a-z0-9]/', '-', $input);
// Prevent double hyphen
$input = preg_replace('/-{2,}/', '-', $input);
// Prevent hyphen in beginning or end
$input = trim($input, '-');
// Prevent to long slug
if (strlen($input) > 91) {
$input = substr($input, 0, 92);
}
// Prevent empty slug
if ($input === '') {
$input = 'interactive';
}
return $input;
}
/**
* Makes it easier to print response when AJAX request succeeds.
*
* @param mixed $data
* @since 1.6.0
*/
public static function ajaxSuccess($data = NULL, $only_data = FALSE) {
$response = array(
'success' => TRUE
);
if ($data !== NULL) {
$response['data'] = $data;
// Pass data flatly to support old methods
if ($only_data) {
$response = $data;
}
}
self::printJson($response);
}
/**
* Makes it easier to print response when AJAX request fails.
* Will exit after printing error.
*
* @param string $message A human readable error message
* @param string $error_code An machine readable error code that a client
* should be able to interpret
* @param null|int $status_code Http response code
* @param array [$details=null] Better description of the error and possible which action to take
* @since 1.6.0
*/
public static function ajaxError($message = NULL, $error_code = NULL, $status_code = NULL, $details = NULL) {
$response = array(
'success' => FALSE
);
if ($message !== NULL) {
$response['message'] = $message;
}
if ($error_code !== NULL) {
$response['errorCode'] = $error_code;
}
if ($details !== NULL) {
$response['details'] = $details;
}
self::printJson($response, $status_code);
}
/**
* Print JSON headers with UTF-8 charset and json encode response data.
* Makes it easier to respond using JSON.
*
* @param mixed $data
* @param null|int $status_code Http response code
*/
private static function printJson($data, $status_code = NULL) {
header('Cache-Control: no-cache');
header('Content-Type: application/json; charset=utf-8');
print json_encode($data);
}
/**
* Get a new H5P security token for the given action.
*
* @param string $action
* @return string token
*/
public static function createToken($action) {
// Create and return token
return self::hashToken($action, self::getTimeFactor());
}
/**
* Create a time based number which is unique for each 12 hour.
* @return int
*/
private static function getTimeFactor() {
return ceil(time() / (86400 / 2));
}
/**
* Generate a unique hash string based on action, time and token
*
* @param string $action
* @param int $time_factor
* @return string
*/
private static function hashToken($action, $time_factor) {
global $SESSION;
if (!isset($SESSION->h5p_token)) {
// Create an unique key which is used to create action tokens for this session.
if (function_exists('random_bytes')) {
$SESSION->h5p_token = base64_encode(random_bytes(15));
}
else if (function_exists('openssl_random_pseudo_bytes')) {
$SESSION->h5p_token = base64_encode(openssl_random_pseudo_bytes(15));
}
else {
$SESSION->h5p_token = uniqid('', TRUE);
}
}
// Create hash and return
return substr(hash('md5', $action . $time_factor . $SESSION->h5p_token), -16, 13);
}
/**
* Verify if the given token is valid for the given action.
*
* @param string $action
* @param string $token
* @return boolean valid token
*/
public static function validToken($action, $token) {
// Get the timefactor
$time_factor = self::getTimeFactor();
// Check token to see if it's valid
return $token === self::hashToken($action, $time_factor) || // Under 12 hours
$token === self::hashToken($action, $time_factor - 1); // Between 12-24 hours
}
/**
* Update content type cache
*
* @param object $postData Data sent to the hub
*
* @return bool|object Returns endpoint data if found, otherwise FALSE
*/
public function updateContentTypeCache($postData = NULL) {
$interface = $this->h5pF;
// Make sure data is sent!
if (!isset($postData) || !isset($postData['uuid'])) {
return $this->fetchLibrariesMetadata();
}
$postData['current_cache'] = $this->h5pF->getOption('content_type_cache_updated_at', 0);
$data = $interface->fetchExternalData(H5PHubEndpoints::createURL(H5PHubEndpoints::CONTENT_TYPES), $postData);
if (! $this->h5pF->getOption('hub_is_enabled', TRUE)) {
return TRUE;
}
// No data received
if (!$data) {
$interface->setErrorMessage(
$interface->t("Couldn't communicate with the H5P Hub. Please try again later."),
'failed-communicationg-with-hub'
);
return FALSE;
}
$json = json_decode($data);
// No libraries received
if (!isset($json->contentTypes) || empty($json->contentTypes)) {
$interface->setErrorMessage(
$interface->t('No content types were received from the H5P Hub. Please try again later.'),
'no-content-types-from-hub'
);
return FALSE;
}
// Replace content type cache
$interface->replaceContentTypeCache($json);
// Inform of the changes and update timestamp
$interface->setInfoMessage($interface->t('Library cache was successfully updated!'));
$interface->setOption('content_type_cache_updated_at', time());
return $data;
}
/**
> * Update content hub metadata cache
* Check if the current server setup is valid and set error messages
> */
*
> public function updateContentHubMetadataCache($lang = 'en') {
* @return object Setup object with errors and disable hub properties
> $url = H5PHubEndpoints::createURL(H5PHubEndpoints::METADATA);
*/
> $lastModified = $this->h5pF->getContentHubMetadataChecked($lang);
public function checkSetupErrorMessage() {
>
$setup = (object) array(
> $headers = array();
'errors' => array(),
> if (!empty($lastModified)) {
'disable_hub' => FALSE
> $headers['If-Modified-Since'] = $lastModified;
);
> }
> $data = $this->h5pF->fetchExternalData("{$url}?lang={$lang}", NULL, TRUE, NULL, TRUE, $headers, NULL, 'GET');
if (!class_exists('ZipArchive')) {
> $lastChecked = new DateTime('now', new DateTimeZone('GMT'));
$setup->errors[] = $this->h5pF->t('Your PHP version does not support ZipArchive.');
>
$setup->disable_hub = TRUE;
> if ($data['status'] !== 200 && $data['status'] !== 304) {
}
> // If this was not a success, set the error message and return
> $this->h5pF->setErrorMessage(
if (!extension_loaded('mbstring')) {
> $this->h5pF->t('No metadata was received from the H5P Hub. Please try again later.')
$setup->errors[] = $this->h5pF->t(
> );
'The mbstring PHP extension is not loaded. H5P needs this to function properly'
> return null;
);
> }
$setup->disable_hub = TRUE;
>
}
> // Update timestamp
> $this->h5pF->setContentHubMetadataChecked($lastChecked->getTimestamp(), $lang);
// Check php version >= 5.2
>
$php_version = explode('.', phpversion());
> // Not modified
if ($php_version[0] < 5 || ($php_version[0] === 5 && $php_version[1] < 2)) {
> if ($data['status'] === 304) {
$setup->errors[] = $this->h5pF->t('Your PHP version is outdated. H5P requires version 5.2 to function properly. Version 5.6 or later is recommended.');
> return null;
$setup->disable_hub = TRUE;
> }
}
> $this->h5pF->replaceContentHubMetadataCache($data['data'], $lang);
> // TODO: If 200 should we have checked if it decodes? Or 'success'? Not sure if necessary though
// Check write access
> return $data['data'];
if (!$this->fs->hasWriteAccess()) {
> }
$setup->errors[] = $this->h5pF->t('A problem with the server write access was detected. Please make sure that your server can write to your data folder.');
>
$setup->disable_hub = TRUE;
> /**
}
> * Get updated content hub metadata cache
> *
$max_upload_size = self::returnBytes(ini_get('upload_max_filesize'));
> * @param string $lang Language as ISO 639-1 code
$max_post_size = self::returnBytes(ini_get('post_max_size'));
> *
$byte_threshold = 5000000; // 5MB
> * @return JsonSerializable|string
if ($max_upload_size < $byte_threshold) {
> */
$setup->errors[] =
> public function getUpdatedContentHubMetadataCache($lang = 'en') {
$this->h5pF->t('Your PHP max upload size is quite small. With your current setup, you may not upload files larger than %number MB. This might be a problem when trying to upload H5Ps, images and videos. Please consider to increase it to more than 5MB.', array('%number' => number_format($max_upload_size / 1024 / 1024, 2, '.', ' ')));
> $lastUpdate = $this->h5pF->getContentHubMetadataChecked($lang);
}
> if (!$lastUpdate) {
> return $this->updateContentHubMetadataCache($lang);
if ($max_post_size < $byte_threshold) {
> }
$setup->errors[] =
>
$this->h5pF->t('Your PHP max post size is quite small. With your current setup, you may not upload files larger than %number MB. This might be a problem when trying to upload H5Ps, images and videos. Please consider to increase it to more than 5MB', array('%number' => number_format($max_upload_size / 1024 / 1024, 2, '.', ' ')));
> $lastUpdate = new DateTime($lastUpdate);
}
> $expirationTime = $lastUpdate->getTimestamp() + (60 * 60 * 24); // Check once per day
> if (time() > $expirationTime) {
if ($max_upload_size > $max_post_size) {
> $update = $this->updateContentHubMetadataCache($lang);
$setup->errors[] =
> if (!empty($update)) {
$this->h5pF->t('Your PHP max upload size is bigger than your max post size. This is known to cause issues in some installations.');
> return $update;
}
> }
> }
// Check SSL
>
if (!extension_loaded('openssl')) {
> $storedCache = $this->h5pF->getContentHubMetadataCache($lang);
$setup->errors[] =
> if (!$storedCache) {
$this->h5pF->t('Your server does not have SSL enabled. SSL should be enabled to ensure a secure connection with the H5P hub.');
> // We don't have the value stored for some reason, reset last update and re-fetch
$setup->disable_hub = TRUE;
> $this->h5pF->setContentHubMetadataChecked(null, $lang);
}
> return $this->updateContentHubMetadataCache($lang);
> }
return $setup;
>
}
> return $storedCache;
> }
/**
>
* Check that all H5P requirements for the server setup is met.
> /**
*/
public function checkSetupForRequirements() {
$setup = $this->checkSetupErrorMessage();
$this->h5pF->setOption('hub_is_enabled', !$setup->disable_hub);
if (!empty($setup->errors)) {
foreach ($setup->errors as $err) {
$this->h5pF->setErrorMessage($err);
}
}
if ($setup->disable_hub) {
// Inform how to re-enable hub
$this->h5pF->setErrorMessage(
$this->h5pF->t('H5P hub communication has been disabled because one or more H5P requirements failed.')
);
$this->h5pF->setErrorMessage(
$this->h5pF->t('When you have revised your server setup you may re-enable H5P hub communication in H5P Settings.')
);
}
}
/**
* Return bytes from php_ini string value
*
* @param string $val
*
* @return int|string
*/
public static function returnBytes($val) {
$val = trim($val);
$last = strtolower($val[strlen($val) - 1]);
$bytes = (int) $val;
switch ($last) {
case 'g':
$bytes *= 1024;
case 'm':
$bytes *= 1024;
case 'k':
$bytes *= 1024;
}
return $bytes;
}
/**
* Check if the current user has permission to update and install new
* libraries.
*
* @param bool [$set] Optional, sets the permission
* @return bool
*/
public function mayUpdateLibraries($set = null) {
static $can;
if ($set !== null) {
// Use value set
$can = $set;
}
if ($can === null) {
// Ask our framework
$can = $this->h5pF->mayUpdateLibraries();
}
return $can;
}
/**
* Provide localization for the Core JS
* @return array
*/
public function getLocalization() {
return array(
'fullscreen' => $this->h5pF->t('Fullscreen'),
'disableFullscreen' => $this->h5pF->t('Disable fullscreen'),
'download' => $this->h5pF->t('Download'),
'copyrights' => $this->h5pF->t('Rights of use'),
'embed' => $this->h5pF->t('Embed'),
'size' => $this->h5pF->t('Size'),
'showAdvanced' => $this->h5pF->t('Show advanced'),
'hideAdvanced' => $this->h5pF->t('Hide advanced'),
'advancedHelp' => $this->h5pF->t('Include this script on your website if you want dynamic sizing of the embedded content:'),
'copyrightInformation' => $this->h5pF->t('Rights of use'),
'close' => $this->h5pF->t('Close'),
'title' => $this->h5pF->t('Title'),
'author' => $this->h5pF->t('Author'),
'year' => $this->h5pF->t('Year'),
'source' => $this->h5pF->t('Source'),
'license' => $this->h5pF->t('License'),
'thumbnail' => $this->h5pF->t('Thumbnail'),
'noCopyrights' => $this->h5pF->t('No copyright information available for this content.'),
'reuse' => $this->h5pF->t('Reuse'),
'reuseContent' => $this->h5pF->t('Reuse Content'),
'reuseDescription' => $this->h5pF->t('Reuse this content.'),
'downloadDescription' => $this->h5pF->t('Download this content as a H5P file.'),
'copyrightsDescription' => $this->h5pF->t('View copyright information for this content.'),
'embedDescription' => $this->h5pF->t('View the embed code for this content.'),
'h5pDescription' => $this->h5pF->t('Visit H5P.org to check out more cool content.'),
'contentChanged' => $this->h5pF->t('This content has changed since you last used it.'),
'startingOver' => $this->h5pF->t("You'll be starting over."),
'by' => $this->h5pF->t('by'),
'showMore' => $this->h5pF->t('Show more'),
'showLess' => $this->h5pF->t('Show less'),
'subLevel' => $this->h5pF->t('Sublevel'),
'confirmDialogHeader' => $this->h5pF->t('Confirm action'),
'confirmDialogBody' => $this->h5pF->t('Please confirm that you wish to proceed. This action is not reversible.'),
'cancelLabel' => $this->h5pF->t('Cancel'),
'confirmLabel' => $this->h5pF->t('Confirm'),
'licenseU' => $this->h5pF->t('Undisclosed'),
'licenseCCBY' => $this->h5pF->t('Attribution'),
'licenseCCBYSA' => $this->h5pF->t('Attribution-ShareAlike'),
'licenseCCBYND' => $this->h5pF->t('Attribution-NoDerivs'),
'licenseCCBYNC' => $this->h5pF->t('Attribution-NonCommercial'),
'licenseCCBYNCSA' => $this->h5pF->t('Attribution-NonCommercial-ShareAlike'),
'licenseCCBYNCND' => $this->h5pF->t('Attribution-NonCommercial-NoDerivs'),
'licenseCC40' => $this->h5pF->t('4.0 International'),
'licenseCC30' => $this->h5pF->t('3.0 Unported'),
'licenseCC25' => $this->h5pF->t('2.5 Generic'),
'licenseCC20' => $this->h5pF->t('2.0 Generic'),
'licenseCC10' => $this->h5pF->t('1.0 Generic'),
'licenseGPL' => $this->h5pF->t('General Public License'),
'licenseV3' => $this->h5pF->t('Version 3'),
'licenseV2' => $this->h5pF->t('Version 2'),
'licenseV1' => $this->h5pF->t('Version 1'),
'licensePD' => $this->h5pF->t('Public Domain'),
'licenseCC010' => $this->h5pF->t('CC0 1.0 Universal (CC0 1.0) Public Domain Dedication'),
'licensePDM' => $this->h5pF->t('Public Domain Mark'),
'licenseC' => $this->h5pF->t('Copyright'),
'contentType' => $this->h5pF->t('Content Type'),
'licenseExtras' => $this->h5pF->t('License Extras'),
'changes' => $this->h5pF->t('Changelog'),
'contentCopied' => $this->h5pF->t('Content is copied to the clipboard'),
'connectionLost' => $this->h5pF->t('Connection lost. Results will be stored and sent when you regain connection.'),
'connectionReestablished' => $this->h5pF->t('Connection reestablished.'),
'resubmitScores' => $this->h5pF->t('Attempting to submit stored results.'),
'offlineDialogHeader' => $this->h5pF->t('Your connection to the server was lost'),
'offlineDialogBody' => $this->h5pF->t('We were unable to send information about your completion of this task. Please check your internet connection.'),
'offlineDialogRetryMessage' => $this->h5pF->t('Retrying in :num....'),
'offlineDialogRetryButtonLabel' => $this->h5pF->t('Retry now'),
'offlineSuccessfulSubmit' => $this->h5pF->t('Successfully submitted results.'),
> 'mainTitle' => $this->h5pF->t('Sharing <strong>:title</strong>'),
);
> 'editInfoTitle' => $this->h5pF->t('Edit info for <strong>:title</strong>'),
}
> 'cancel' => $this->h5pF->t('Cancel'),
}
> 'back' => $this->h5pF->t('Back'),
> 'next' => $this->h5pF->t('Next'),
/**
> 'reviewInfo' => $this->h5pF->t('Review info'),
* Functions for validating basic types from H5P library semantics.
> 'share' => $this->h5pF->t('Share'),
* @property bool allowedStyles
> 'saveChanges' => $this->h5pF->t('Save changes'),
*/
> 'registerOnHub' => $this->h5pF->t('Register on the H5P Hub'),
class H5PContentValidator {
> 'updateRegistrationOnHub' => $this->h5pF->t('Save account settings'),
public $h5pF;
> 'requiredInfo' => $this->h5pF->t('Required Info'),
public $h5pC;
> 'optionalInfo' => $this->h5pF->t('Optional Info'),
private $typeMap, $libraries, $dependencies, $nextWeight;
> 'reviewAndShare' => $this->h5pF->t('Review & Share'),
private static $allowed_styleable_tags = array('span', 'p', 'div','h1','h2','h3', 'td');
> 'reviewAndSave' => $this->h5pF->t('Review & Save'),
> 'shared' => $this->h5pF->t('Shared'),
/**
> 'currentStep' => $this->h5pF->t('Step :step of :total'),
* Constructor for the H5PContentValidator
> 'sharingNote' => $this->h5pF->t('All content details can be edited after sharing'),
*
> 'licenseDescription' => $this->h5pF->t('Select a license for your content'),
* @param object $H5PFramework
> 'licenseVersion' => $this->h5pF->t('License Version'),
* The frameworks implementation of the H5PFrameworkInterface
> 'licenseVersionDescription' => $this->h5pF->t('Select a license version'),
* @param object $H5PCore
> 'disciplineLabel' => $this->h5pF->t('Disciplines'),
* The main H5PCore instance
> 'disciplineDescription' => $this->h5pF->t('You can select multiple disciplines'),
*/
> 'disciplineLimitReachedMessage' => $this->h5pF->t('You can select up to :numDisciplines disciplines'),
public function __construct($H5PFramework, $H5PCore) {
> 'discipline' => array(
$this->h5pF = $H5PFramework;
> 'searchPlaceholder' => $this->h5pF->t('Type to search for disciplines'),
$this->h5pC = $H5PCore;
> 'in' => $this->h5pF->t('in'),
$this->typeMap = array(
> 'dropdownButton' => $this->h5pF->t('Dropdown button'),
'text' => 'validateText',
> ),
'number' => 'validateNumber',
> 'removeChip' => $this->h5pF->t('Remove :chip from the list'),
'boolean' => 'validateBoolean',
> 'keywordsPlaceholder' => $this->h5pF->t('Add keywords'),
'list' => 'validateList',
> 'keywords' => $this->h5pF->t('Keywords'),
'group' => 'validateGroup',
> 'keywordsDescription' => $this->h5pF->t('You can add multiple keywords separated by commas. Press "Enter" or "Add" to confirm keywords'),
'file' => 'validateFile',
> 'altText' => $this->h5pF->t('Alt text'),
'image' => 'validateImage',
> 'reviewMessage' => $this->h5pF->t('Please review the info below before you share'),
'video' => 'validateVideo',
> 'subContentWarning' => $this->h5pF->t('Sub-content (images, questions etc.) will be shared under :license unless otherwise specified in the authoring tool'),
'audio' => 'validateAudio',
> 'disciplines' => $this->h5pF->t('Disciplines'),
'select' => 'validateSelect',
> 'shortDescription' => $this->h5pF->t('Short description'),
'library' => 'validateLibrary',
> 'longDescription' => $this->h5pF->t('Long description'),
);
> 'icon' => $this->h5pF->t('Icon'),
$this->nextWeight = 1;
> 'screenshots' => $this->h5pF->t('Screenshots'),
> 'helpChoosingLicense' => $this->h5pF->t('Help me choose a license'),
// Keep track of the libraries we load to avoid loading it multiple times.
> 'shareFailed' => $this->h5pF->t('Share failed.'),
$this->libraries = array();
> 'editingFailed' => $this->h5pF->t('Editing failed.'),
> 'shareTryAgain' => $this->h5pF->t('Something went wrong, please try to share again.'),
// Keep track of all dependencies for the given content.
> 'pleaseWait' => $this->h5pF->t('Please wait...'),
$this->dependencies = array();
> 'language' => $this->h5pF->t('Language'),
}
> 'level' => $this->h5pF->t('Level'),
> 'shortDescriptionPlaceholder' => $this->h5pF->t('Short description of your content'),
/**
> 'longDescriptionPlaceholder' => $this->h5pF->t('Long description of your content'),
* Add Addon library.
> 'description' => $this->h5pF->t('Description'),
*/
> 'iconDescription' => $this->h5pF->t('640x480px. If not selected content will use category icon'),
public function addon($library) {
> 'screenshotsDescription' => $this->h5pF->t('Add up to five screenshots of your content'),
$depKey = 'preloaded-' . $library['machineName'];
> 'submitted' => $this->h5pF->t('Submitted!'),
$this->dependencies[$depKey] = array(
> 'isNowSubmitted' => $this->h5pF->t('Is now submitted to H5P Hub'),
'library' => $library,
> 'changeHasBeenSubmitted' => $this->h5pF->t('A change has been submited for'),
'type' => 'preloaded'
> 'contentAvailable' => $this->h5pF->t('Your content will normally be available in the Hub within one business day.'),
);
> 'contentUpdateSoon' => $this->h5pF->t('Your content will update soon'),
$this->nextWeight = $this->h5pC->findLibraryDependencies($this->dependencies, $library, $this->nextWeight);
> 'contentLicenseTitle' => $this->h5pF->t('Content License Info'),
$this->dependencies[$depKey]['weight'] = $this->nextWeight++;
> 'licenseDialogDescription' => $this->h5pF->t('Click on a specific license to get info about proper usage'),
}
> 'publisherFieldTitle' => $this->h5pF->t('Publisher'),
> 'publisherFieldDescription' => $this->h5pF->t('This will display as the "Publisher name" on shared content'),
/**
> 'emailAddress' => $this->h5pF->t('Email Address'),
* Get the flat dependency tree.
> 'publisherDescription' => $this->h5pF->t('Publisher description'),
*
> 'publisherDescriptionText' => $this->h5pF->t('This will be displayed under "Publisher info" on shared content'),
* @return array
> 'contactPerson' => $this->h5pF->t('Contact Person'),
*/
> 'phone' => $this->h5pF->t('Phone'),
public function getDependencies() {
> 'address' => $this->h5pF->t('Address'),
return $this->dependencies;
> 'city' => $this->h5pF->t('City'),
}
> 'zip' => $this->h5pF->t('Zip'),
> 'country' => $this->h5pF->t('Country'),
/**
> 'logoUploadText' => $this->h5pF->t('Organization logo or avatar'),
* Validate metadata
> 'acceptTerms' => $this->h5pF->t('I accept the <a href=":url" target="_blank">terms of use</a>'),
*
> 'successfullyRegistred' => $this->h5pF->t('You have successfully registered an account on the H5P Hub'),
* @param array $metadata
> 'successfullyRegistredDescription' => $this->h5pF->t('You account details can be changed'),
* @return array Validated & filtered
> 'successfullyUpdated' => $this->h5pF->t('Your H5P Hub account settings have successfully been changed'),
*/
> 'accountDetailsLinkText' => $this->h5pF->t('here'),
public function validateMetadata($metadata) {
> 'registrationTitle' => $this->h5pF->t('H5P Hub Registration'),
$semantics = $this->getMetadataSemantics();
> 'registrationFailed' => $this->h5pF->t('An error occurred'),
$group = (object)$metadata;
> 'registrationFailedDescription' => $this->h5pF->t('We were not able to create an account at this point. Something went wrong. Try again later.'),
> 'maxLength' => $this->h5pF->t(':length is the maximum number of characters'),
// Stop complaining about "invalid selected option in select" for
> 'keywordExists' => $this->h5pF->t('Keyword already exists!'),
// old content without license chosen.
> 'licenseDetails' => $this->h5pF->t('License details'),
if (!isset($group->license)) {
> 'remove' => $this->h5pF->t('Remove'),
$group->license = 'U';
> 'removeImage' => $this->h5pF->t('Remove image'),
}
> 'cancelPublishConfirmationDialogTitle' => $this->h5pF->t('Cancel sharing'),
> 'cancelPublishConfirmationDialogDescription' => $this->h5pF->t('Are you sure you want to cancel the sharing process?'),
$this->validateGroup($group, (object) array(
> 'cancelPublishConfirmationDialogCancelButtonText' => $this->h5pF->t('No'),
'type' => 'group',
> 'cancelPublishConfirmationDialogConfirmButtonText' => $this->h5pF->t('Yes'),
'fields' => $semantics,
> 'add' => $this->h5pF->t('Add'),
), FALSE);
> 'age' => $this->h5pF->t('Typical age'),
> 'ageDescription' => $this->h5pF->t('The target audience of this content. Possible input formats separated by commas: "1,34-45,-50,59-".'),
return (array)$group;
> 'invalidAge' => $this->h5pF->t('Invalid input format for Typical age. Possible input formats separated by commas: "1, 34-45, -50, -59-".'),
}
> 'contactPersonDescription' => $this->h5pF->t('H5P will reach out to the contact person in case there are any issues with the content shared by the publisher. The contact person\'s name or other information will not be published or shared with third parties'),
> 'emailAddressDescription' => $this->h5pF->t('The email address will be used by H5P to reach out to the publisher in case of any issues with the content or in case the publisher needs to recover their account. It will not be published or shared with any third parties'),
/**
> 'copyrightWarning' => $this->h5pF->t('Copyrighted material cannot be shared in the H5P Content Hub. If the content is licensed with a OER friendly license like Creative Commons, please choose the appropriate license. If not this content cannot be shared.'),
* Validate given text value against text semantics.
> 'keywordsExits' => $this->h5pF->t('Keywords already exists!'),
* @param $text
> 'someKeywordsExits' => $this->h5pF->t('Some of these keywords already exist'),
* @param $semantics
> 'width' => $this->h5pF->t('width'),
*/
> 'height' => $this->h5pF->t('height')
public function validateText(&$text, $semantics) {
>
if (!is_string($text)) {
> /**
$text = '';
> * Publish content on the H5P Hub.
}
> *
if (isset($semantics->tags)) {
> * @param bigint $id
// Not testing for empty array allows us to use the 4 defaults without
> * @return stdClass
// specifying them in semantics.
> */
$tags = array_merge(array('div', 'span', 'p', 'br'), $semantics->tags);
> public function hubRetrieveContent($id) {
> $headers = array(
// Add related tags for table etc.
> 'Authorization' => $this->hubGetAuthorizationHeader(),
if (in_array('table', $tags)) {
> 'Accept' => 'application/json',
$tags = array_merge($tags, array('tr', 'td', 'th', 'colgroup', 'thead', 'tbody', 'tfoot'));
> );
}
>
if (in_array('b', $tags) && ! in_array('strong', $tags)) {
> $response = $this->h5pF->fetchExternalData(
$tags[] = 'strong';
> H5PHubEndpoints::createURL(H5PHubEndpoints::CONTENT . "/{$id}"),
}
> NULL, TRUE, NULL, TRUE, $headers
if (in_array('i', $tags) && ! in_array('em', $tags)) {
> );
$tags[] = 'em';
>
}
> if (empty($response['data'])) {
if (in_array('ul', $tags) || in_array('ol', $tags) && ! in_array('li', $tags)) {
> throw new Exception($this->h5pF->t('Unable to authorize with the H5P Hub. Please check your Hub registration and connection.'));
$tags[] = 'li';
> }
}
>
if (in_array('del', $tags) || in_array('strike', $tags) && ! in_array('s', $tags)) {
> if (isset($response['status']) && $response['status'] !== 200) {
$tags[] = 's';
> if ($response['status'] === 404) {
}
> $this->h5pF->setErrorMessage($this->h5pF->t('Content is not shared on the H5P OER Hub.'));
> return NULL;
// Determine allowed style tags
> }
$stylePatterns = array();
> throw new Exception($this->h5pF->t('Connecting to the content hub failed, please try again later.'));
// All styles must be start to end patterns (^...$)
> }
if (isset($semantics->font)) {
>
if (isset($semantics->font->size) && $semantics->font->size) {
> $hub_content = json_decode($response['data'])->data;
$stylePatterns[] = '/^font-size: *[0-9.]+(em|px|%) *;?$/i';
> $hub_content->id = "$hub_content->id";
}
> return $hub_content;
if (isset($semantics->font->family) && $semantics->font->family) {
> }
$stylePatterns[] = '/^font-family: *[-a-z0-9," ]+;?$/i';
>
}
> /**
if (isset($semantics->font->color) && $semantics->font->color) {
> * Publish content on the H5P Hub.
$stylePatterns[] = '/^color: *(#[a-f0-9]{3}[a-f0-9]{3}?|rgba?\([0-9, ]+\)) *;?$/i';
> *
}
> * @param array $data Data from content publishing process
if (isset($semantics->font->background) && $semantics->font->background) {
> * @param array $files Files to upload with the content publish
$stylePatterns[] = '/^background-color: *(#[a-f0-9]{3}[a-f0-9]{3}?|rgba?\([0-9, ]+\)) *;?$/i';
> * @param bigint $content_hub_id For updating existing content
}
> * @return stdClass
if (isset($semantics->font->spacing) && $semantics->font->spacing) {
> */
$stylePatterns[] = '/^letter-spacing: *[0-9.]+(em|px|%) *;?$/i';
> public function hubPublishContent($data, $files, $content_hub_id = NULL) {
}
> $headers = array(
if (isset($semantics->font->height) && $semantics->font->height) {
> 'Authorization' => $this->hubGetAuthorizationHeader(),
$stylePatterns[] = '/^line-height: *[0-9.]+(em|px|%|) *;?$/i';
> 'Accept' => 'application/json',
}
> );
}
>
> $data['published'] = '1';
// Alignment is allowed for all wysiwyg texts
> $endpoint = H5PHubEndpoints::CONTENT;
$stylePatterns[] = '/^text-align: *(center|left|right);?$/i';
> if ($content_hub_id !== NULL) {
> $endpoint .= "/{$content_hub_id}";
// Strip invalid HTML tags.
> $data['_method'] = 'PUT';
$text = $this->filter_xss($text, $tags, $stylePatterns);
> }
}
>
else {
> $response = $this->h5pF->fetchExternalData(
// Filter text to plain text.
> H5PHubEndpoints::createURL($endpoint),
$text = htmlspecialchars($text, ENT_QUOTES, 'UTF-8', FALSE);
> $data, TRUE, NULL, TRUE, $headers, $files
}
> );
>
// Check if string is within allowed length
> if (empty($response['data']) || $response['status'] === 403) {
if (isset($semantics->maxLength)) {
> throw new Exception($this->h5pF->t('Unable to authorize with the H5P Hub. Please check your Hub registration and connection.'));
if (!extension_loaded('mbstring')) {
> }
$this->h5pF->setErrorMessage($this->h5pF->t('The mbstring PHP extension is not loaded. H5P need this to function properly'), 'mbstring-unsupported');
>
}
> if (isset($response['status']) && $response['status'] !== 200) {
else {
> throw new Exception($this->h5pF->t('Connecting to the content hub failed, please try again later.'));
$text = mb_substr($text, 0, $semantics->maxLength);
> }
}
>
}
> $result = json_decode($response['data']);
> if (isset($result->success) && $result->success === TRUE) {
// Check if string is according to optional regexp in semantics
> return $result;
if (!($text === '' && isset($semantics->optional) && $semantics->optional) && isset($semantics->regexp)) {
> }
// Escaping '/' found in patterns, so that it does not break regexp fencing.
> elseif (!empty($result->errors)) {
$pattern = '/' . str_replace('/', '\\/', $semantics->regexp->pattern) . '/';
> // Relay any error messages
$pattern .= isset($semantics->regexp->modifiers) ? $semantics->regexp->modifiers : '';
> $e = new Exception($this->h5pF->t('Validation failed.'));
if (preg_match($pattern, $text) === 0) {
> $e->errors = $result->errors;
// Note: explicitly ignore return value FALSE, to avoid removing text
> throw $e;
// if regexp is invalid...
> }
$this->h5pF->setErrorMessage($this->h5pF->t('Provided string is not valid according to regexp in semantics. (value: "%value", regexp: "%regexp")', array('%value' => $text, '%regexp' => $pattern)), 'semantics-invalid-according-regexp');
> }
$text = '';
>
}
> /**
}
> * Creates the authorization header needed to access the private parts of
}
> * the H5P Hub.
> *
/**
> * @return string
* Validates content files
> */
*
> public function hubGetAuthorizationHeader() {
* @param string $contentPath
> $site_uuid = $this->h5pF->getOption('site_uuid', '');
* The path containing content files to validate.
> $hub_secret = $this->h5pF->getOption('hub_secret', '');
* @param bool $isLibrary
> if (empty($site_uuid)) {
* @return bool TRUE if all files are valid
> $this->h5pF->setErrorMessage($this->h5pF->t('Missing Site UUID. Please check your Hub registration.'));
* TRUE if all files are valid
> }
* FALSE if one or more files fail validation. Error message should be set accordingly by validator.
> elseif (empty($hub_secret)) {
*/
> $this->h5pF->setErrorMessage($this->h5pF->t('Missing Hub Secret. Please check your Hub registration.'));
public function validateContentFiles($contentPath, $isLibrary = FALSE) {
> }
if ($this->h5pC->disableFileCheck === TRUE) {
> return 'Basic ' . base64_encode("$site_uuid:$hub_secret");
return TRUE;
> }
}
>
> /**
// Scan content directory for files, recurse into sub directories.
> * Unpublish content from content hub
$files = array_diff(scandir($contentPath), array('.','..'));
> *
$valid = TRUE;
> * @param integer $hubId Content hub id
$whitelist = $this->h5pF->getWhitelist($isLibrary, H5PCore::$defaultContentWhitelist, H5PCore::$defaultLibraryWhitelistExtras);
> *
> * @return bool True if successful
$wl_regex = '/\.(' . preg_replace('/ +/i', '|', preg_quote($whitelist)) . ')$/i';
> */
> public function hubUnpublishContent($hubId) {
foreach ($files as $file) {
> $headers = array(
$filePath = $contentPath . '/' . $file;
> 'Authorization' => $this->hubGetAuthorizationHeader(),
if (is_dir($filePath)) {
> 'Accept' => 'application/json',
$valid = $this->validateContentFiles($filePath, $isLibrary) && $valid;
> );
}
>
else {
> $url = H5PHubEndpoints::createURL(H5PHubEndpoints::CONTENT);
// Snipped from drupal 6 "file_validate_extensions". Using own code
> $response = $this->h5pF->fetchExternalData("{$url}/{$hubId}", array(
// to avoid 1. creating a file-like object just to test for the known
> 'published' => '0',
// file name, 2. testing against a returned error array that could
> ), true, null, true, $headers, array(), 'PUT');
// never be more than 1 element long anyway, 3. recreating the regex
>
// for every file.
> // Remove shared status if successful
if (!extension_loaded('mbstring')) {
> if (!empty($response) && $response['status'] === 200) {
$this->h5pF->setErrorMessage($this->h5pF->t('The mbstring PHP extension is not loaded. H5P need this to function properly'), 'mbstring-unsupported');
> $msg = $this->h5pF->t('Content successfully unpublished');
$valid = FALSE;
> $this->h5pF->setInfoMessage($msg);
}
>
else if (!preg_match($wl_regex, mb_strtolower($file))) {
> return true;
$this->h5pF->setErrorMessage($this->h5pF->t('File "%filename" not allowed. Only files with the following extensions are allowed: %files-allowed.', array('%filename' => $file, '%files-allowed' => $whitelist)), 'not-in-whitelist');
> }
$valid = FALSE;
> $msg = $this->h5pF->t('Content unpublish failed');
}
> $this->h5pF->setErrorMessage($msg);
}
>
}
> return false;
return $valid;
> }
}
>
> /**
/**
> * Sync content with content hub
* Validate given value against number semantics
> *
* @param $number
> * @param integer $hubId Content hub id
* @param $semantics
> * @param string $exportPath Export path where .h5p for content can be found
*/
> *
public function validateNumber(&$number, $semantics) {
> * @return bool
// Validate that $number is indeed a number
> */
if (!is_numeric($number)) {
> public function hubSyncContent($hubId, $exportPath) {
$number = 0;
> $headers = array(
}
> 'Authorization' => $this->hubGetAuthorizationHeader(),
// Check if number is within valid bounds. Move within bounds if not.
> 'Accept' => 'application/json',
if (isset($semantics->min) && $number < $semantics->min) {
> );
$number = $semantics->min;
>
}
> $url = H5PHubEndpoints::createURL(H5PHubEndpoints::CONTENT);
if (isset($semantics->max) && $number > $semantics->max) {
> $response = $this->h5pF->fetchExternalData("{$url}/{$hubId}", array(
$number = $semantics->max;
> 'download_url' => $exportPath,
}
> 'resync' => '1',
// Check if number is within allowed bounds even if step value is set.
> ), true, null, true, $headers, array(), 'PUT');
if (isset($semantics->step)) {
>
$testNumber = $number - (isset($semantics->min) ? $semantics->min : 0);
> if (!empty($response) && $response['status'] === 200) {
$rest = $testNumber % $semantics->step;
> $msg = $this->h5pF->t('Content sync queued');
if ($rest !== 0) {
> $this->h5pF->setInfoMessage($msg);
$number -= $rest;
> return true;
}
> }
}
>
// Check if number has proper number of decimals.
> $msg = $this->h5pF->t('Content sync failed');
if (isset($semantics->decimals)) {
> $this->h5pF->setErrorMessage($msg);
$number = round($number, $semantics->decimals);
> return false;
}
> }
}
>
> /**
/**
> * Fetch account info for our site from the content hub
* Validate given value against boolean semantics
> *
* @param $bool
> * @return array|bool|string False if account is not setup, otherwise data
* @return bool
> */
*/
> public function hubAccountInfo() {
public function validateBoolean(&$bool) {
> $siteUuid = $this->h5pF->getOption('site_uuid', null);
return is_bool($bool);
> $secret = $this->h5pF->getOption('hub_secret', null);
}
> if (empty($siteUuid) && !empty($secret)) {
> $this->h5pF->setErrorMessage($this->h5pF->t('H5P Hub secret is set without a site uuid. This may be fixed by restoring the site uuid or removing the hub secret and registering a new account with the content hub.'));
/**
> throw new Exception('Hub secret not set');
* Validate select values
> }
* @param $select
>
* @param $semantics
> if (empty($siteUuid) || empty($secret)) {
*/
> return false;
public function validateSelect(&$select, $semantics) {
> }
$optional = isset($semantics->optional) && $semantics->optional;
>
$strict = FALSE;
> $headers = array(
if (isset($semantics->options) && !empty($semantics->options)) {
> 'Authorization' => $this->hubGetAuthorizationHeader(),
// We have a strict set of options to choose from.
> 'Accept' => 'application/json',
$strict = TRUE;
> );
$options = array();
>
> $url = H5PHubEndpoints::createURL(H5PHubEndpoints::REGISTER);
foreach ($semantics->options as $option) {
> $accountInfo = $this->h5pF->fetchExternalData("{$url}/{$siteUuid}",
// Support optgroup - just flatten options into one
> null, true, null, true, $headers, array(), 'GET');
if (isset($option->type) && $option->type === 'optgroup') {
>
foreach ($option->options as $suboption) {
> if ($accountInfo['status'] === 401) {
$options[$suboption->value] = TRUE;
> // Unauthenticated, invalid hub secret and site uuid combination
}
> $this->h5pF->setErrorMessage($this->h5pF->t('Hub account authentication info is invalid. This may be fixed by an admin by restoring the hub secret or register a new account with the content hub.'));
}
> return false;
elseif (isset($option->value)) {
> }
$options[$option->value] = TRUE;
>
}
> if ($accountInfo['status'] !== 200) {
}
> return false;
}
> }
>
if (isset($semantics->multiple) && $semantics->multiple) {
> return json_decode($accountInfo['data'])->data;
// Multi-choice generates array of values. Test each one against valid
> }
// options, if we are strict. First make sure we are working on an
>
// array.
> /**
if (!is_array($select)) {
> * Register account
$select = array($select);
> *
}
> * @param array $formData Form data. Should include: name, email, description,
> * contact_person, phone, address, city, zip, country, remove_logo
foreach ($select as $key => &$value) {
> * @param object $logo Input image
if ($strict && !$optional && !isset($options[$value])) {
> *
$this->h5pF->setErrorMessage($this->h5pF->t('Invalid selected option in multi-select.'));
> * @return array
unset($select[$key]);
> */
}
> public function hubRegisterAccount($formData, $logo) {
else {
>
$select[$key] = htmlspecialchars($value, ENT_QUOTES, 'UTF-8', FALSE);
> $uuid = $this->h5pF->getOption('site_uuid', '');
}
> if (empty($uuid)) {
}
> // Attempt to fetch a new site uuid
}
> $uuid = $this->fetchLibrariesMetadata(false, true);
else {
> if (!$uuid) {
// Single mode. If we get an array in here, we chop off the first
> return [
// element and use that instead.
> 'message' => $this->h5pF->t('Site is missing a unique site uuid and was unable to set a new one. The H5P Content Hub is disabled until this problem can be resolved. Please make sure the H5P Hub is enabled in the H5P settings and try again later.'),
if (is_array($select)) {
> 'status_code' => 403,
$select = $select[0];
> 'error_code' => 'MISSING_SITE_UUID',
}
> 'success' => FALSE,
> ];
if ($strict && !$optional && !isset($options[$select])) {
> }
$this->h5pF->setErrorMessage($this->h5pF->t('Invalid selected option in select.'));
> }
$select = $semantics->options[0]->value;
>
}
> $formData['site_uuid'] = $uuid;
$select = htmlspecialchars($select, ENT_QUOTES, 'UTF-8', FALSE);
>
}
> $headers = [];
}
> $endpoint = H5PHubEndpoints::REGISTER;
> // Update if already registered
/**
> $hasRegistered = $this->h5pF->getOption('hub_secret');
* Validate given list value against list semantics.
> if ($hasRegistered) {
* Will recurse into validating each item in the list according to the type.
> $endpoint .= "/{$uuid}";
* @param $list
> $formData['_method'] = 'PUT';
* @param $semantics
> $headers = [
*/
> 'Authorization' => $this->hubGetAuthorizationHeader(),
public function validateList(&$list, $semantics) {
> ];
$field = $semantics->field;
> }
$function = $this->typeMap[$field->type];
>
> $url = H5PHubEndpoints::createURL($endpoint);
// Check that list is not longer than allowed length. We do this before
> $registration = $this->h5pF->fetchExternalData(
// iterating to avoid unnecessary work.
> $url,
if (isset($semantics->max)) {
> $formData,
array_splice($list, $semantics->max);
> NULL,
}
> NULL,
> TRUE,
if (!is_array($list)) {
> $headers,
$list = array();
> isset($logo) ? ['logo' => $logo] : []
}
> );
>
// Validate each element in list.
> try {
foreach ($list as $key => &$value) {
> $results = json_decode($registration['data']);
if (!is_int($key)) {
> } catch (Exception $e) {
array_splice($list, $key, 1);
> return [
continue;
> 'message' => 'Could not parse json response.',
}
> 'status_code' => 424,
$this->$function($value, $field);
> 'error_code' => 'COULD_NOT_PARSE_RESPONSE',
if ($value === NULL) {
> 'success' => FALSE,
array_splice($list, $key, 1);
> ];
}
> }
}
>
> if (isset($results->errors->site_uuid)) {
if (count($list) === 0) {
> return [
$list = NULL;
> 'message' => 'Site UUID is not unique. This must be fixed by an admin by restoring the hub secret or remove the site uuid and register as a new account with the content hub.',
}
> 'status_code' => 403,
}
> 'error_code' => 'SITE_UUID_NOT_UNIQUE',
> 'success' => FALSE,
/**
> ];
* Validate a file like object, such as video, image, audio and file.
> }
* @param $file
>
* @param $semantics
> if (isset($results->errors->logo)) {
* @param array $typeValidKeys
> return [
*/
> 'message' => $results->errors->logo[0],
private function _validateFilelike(&$file, $semantics, $typeValidKeys = array()) {
> 'status_code' => 400,
// Do not allow to use files from other content folders.
> 'success' => FALSE,
$matches = array();
> ];
if (preg_match($this->h5pC->relativePathRegExp, $file->path, $matches)) {
> }
$file->path = $matches[5];
>
}
> if (
> !isset($results->success)
// Remove temporary files suffix
> || $results->success === FALSE
if (substr($file->path, -4, 4) === '#tmp') {
> || !$hasRegistered && !isset($results->account->secret)
$file->path = substr($file->path, 0, strlen($file->path) - 4);
> || $registration['status'] !== 200
}
> ) {
> return [
// Make sure path and mime does not have any special chars
> 'message' => 'Registration failed.',
$file->path = htmlspecialchars($file->path, ENT_QUOTES, 'UTF-8', FALSE);
> 'status_code' => 422,
if (isset($file->mime)) {
> 'error_code' => 'REGISTRATION_FAILED',
$file->mime = htmlspecialchars($file->mime, ENT_QUOTES, 'UTF-8', FALSE);
> 'success' => FALSE,
}
> ];
> }
// Remove attributes that should not exist, they may contain JSON escape
>
// code.
> if (!$hasRegistered) {
$validKeys = array_merge(array('path', 'mime', 'copyright'), $typeValidKeys);
> $this->h5pF->setOption('hub_secret', $results->account->secret);
if (isset($semantics->extraAttributes)) {
> }
$validKeys = array_merge($validKeys, $semantics->extraAttributes); // TODO: Validate extraAttributes
>
}
> return [
$this->filterParams($file, $validKeys);
> 'message' => $this->h5pF->t('Account successfully registered.'),
> 'status_code' => 200,
if (isset($file->width)) {
> 'success' => TRUE,
$file->width = intval($file->width);
> ];
}
> }
>
if (isset($file->height)) {
> /**
$file->height = intval($file->height);
> * Get status of content from content hub
}
> *
> * @param string $hubContentId
if (isset($file->codecs)) {
> * @param int $syncStatus
$file->codecs = htmlspecialchars($file->codecs, ENT_QUOTES, 'UTF-8', FALSE);
> *
}
> * @return false|int Returns a new H5PContentStatus if successful, else false
> */
if (isset($file->bitrate)) {
> public function getHubContentStatus($hubContentId, $syncStatus) {
$file->bitrate = intval($file->bitrate);
> $headers = array(
}
> 'Authorization' => $this->hubGetAuthorizationHeader(),
> 'Accept' => 'application/json',
if (isset($file->quality)) {
> );
if (!is_object($file->quality) || !isset($file->quality->level) || !isset($file->quality->label)) {
>
unset($file->quality);
> $url = H5PHubEndpoints::createURL(H5PHubEndpoints::CONTENT);
}
> $response = $this->h5pF->fetchExternalData("{$url}/{$hubContentId}/status",
else {
> null, true, null, true, $headers);
$this->filterParams($file->quality, array('level', 'label'));
>
$file->quality->level = intval($file->quality->level);
> if (isset($response['status']) && $response['status'] === 403) {
$file->quality->label = htmlspecialchars($file->quality->label, ENT_QUOTES, 'UTF-8', FALSE);
> $msg = $this->h5pF->t('The request for content status was unauthorized. This could be because the content belongs to a different account, or your account is not setup properly.');
}
> $this->h5pF->setErrorMessage($msg);
}
> return false;
> }
if (isset($file->copyright)) {
> if (empty($response) || $response['status'] !== 200) {
$this->validateGroup($file->copyright, $this->getCopyrightSemantics());
> $msg = $this->h5pF->t('Could not get content hub sync status for content.');
}
> $this->h5pF->setErrorMessage($msg);
}
> return false;
> }
/**
>
* Validate given file data
> $data = json_decode($response['data']);
* @param $file
>
* @param $semantics
> if (isset($data->messages)) {
*/
> // TODO: Is this the right place/way to display them?
public function validateFile(&$file, $semantics) {
>
$this->_validateFilelike($file, $semantics);
> if (!empty($data->messages->info)) {
}
> foreach ($data->messages->info as $info) {
> $this->h5pF->setInfoMessage($info);
/**
> }
* Validate given image data
> }
* @param $image
> if (!empty($data->messages->error)) {
* @param $semantics
> foreach ($data->messages->error as $error) {
*/
> $this->h5pF->setErrorMessage($error->message, $error->code);
public function validateImage(&$image, $semantics) {
> }
$this->_validateFilelike($image, $semantics, array('width', 'height', 'originalImage'));
> }
}
> }
>
/**
> $contentStatus = intval($data->status);
* Validate given video data
> // Content status updated
* @param $video
> if ($contentStatus !== H5PContentStatus::STATUS_WAITING) {
* @param $semantics
> $newState = H5PContentHubSyncStatus::SYNCED;
*/
> if ($contentStatus !== H5PContentStatus::STATUS_DOWNLOADED) {
public function validateVideo(&$video, $semantics) {
> $newState = H5PContentHubSyncStatus::FAILED;
foreach ($video as &$variant) {
> }
$this->_validateFilelike($variant, $semantics, array('width', 'height', 'codecs', 'quality', 'bitrate'));
> else if (intval($syncStatus) !== $contentStatus) {
}
> // Content status successfully transitioned to synced/downloaded
}
> $successMsg = $this->h5pF->t('Content was successfully shared on the content hub.');
> $this->h5pF->setInfoMessage($successMsg);
/**
> }
* Validate given audio data
>
* @param $audio
> return $newState;
* @param $semantics
> }
*/
>
public function validateAudio(&$audio, $semantics) {
> return false;
foreach ($audio as &$variant) {
> }
$this->_validateFilelike($variant, $semantics);
> /** @var bool Allowed styles status. */
}
> protected $allowedStyles;
}
>
/**
* Validate given group value against group semantics.
* Will recurse into validating each group member.
* @param $group
* @param $semantics
* @param bool $flatten
*/
public function validateGroup(&$group, $semantics, $flatten = TRUE) {
// Groups with just one field are compressed in the editor to only output
// the child content. (Exemption for fake groups created by
// "validateBySemantics" above)
$function = null;
$field = null;
$isSubContent = isset($semantics->isSubContent) && $semantics->isSubContent === TRUE;
if (count($semantics->fields) == 1 && $flatten && !$isSubContent) {
$field = $semantics->fields[0];
$function = $this->typeMap[$field->type];
$this->$function($group, $field);
}
else {
foreach ($group as $key => &$value) {
// If subContentId is set, keep value
if($isSubContent && ($key == 'subContentId')){
continue;
}
// Find semantics for name=$key
$found = FALSE;
foreach ($semantics->fields as $field) {
if ($field->name == $key) {
if (isset($semantics->optional) && $semantics->optional) {
$field->optional = TRUE;
}
$function = $this->typeMap[$field->type];
$found = TRUE;
break;
}
}
if ($found) {
if ($function) {
$this->$function($value, $field);
if ($value === NULL) {
unset($group->$key);
}
}
else {
// We have a field type in semantics for which we don't have a
// known validator.
$this->h5pF->setErrorMessage($this->h5pF->t('H5P internal error: unknown content type "@type" in semantics. Removing content!', array('@type' => $field->type)), 'semantics-unknown-type');
unset($group->$key);
}
}
else {
// If validator is not found, something exists in content that does
// not have a corresponding semantics field. Remove it.
// $this->h5pF->setErrorMessage($this->h5pF->t('H5P internal error: no validator exists for @key', array('@key' => $key)));
unset($group->$key);
}
}
}
< if (!(isset($semantics->optional) && $semantics->optional)) {
< if ($group === NULL) {
< // Error no value. Errors aren't printed...
< return;
< }
< foreach ($semantics->fields as $field) {
< if (!(isset($field->optional) && $field->optional)) {
< // Check if field is in group.
< if (! property_exists($group, $field->name)) {
< //$this->h5pF->setErrorMessage($this->h5pF->t('No value given for mandatory field ' . $field->name));
< }
< }
< }
< }
}
/**
* Validate given library value against library semantics.
* Check if provided library is within allowed options.
*
* Will recurse into validating the library's semantics too.
* @param $value
* @param $semantics
*/
public function validateLibrary(&$value, $semantics) {
if (!isset($value->library)) {
$value = NULL;
return;
}
// Check for array of objects or array of strings
if (is_object($semantics->options[0])) {
$getLibraryNames = function ($item) {
return $item->name;
};
$libraryNames = array_map($getLibraryNames, $semantics->options);
}
else {
$libraryNames = $semantics->options;
}
if (!in_array($value->library, $libraryNames)) {
$message = NULL;
// Create an understandable error message:
$machineNameArray = explode(' ', $value->library);
$machineName = $machineNameArray[0];
foreach ($libraryNames as $semanticsLibrary) {
$semanticsMachineNameArray = explode(' ', $semanticsLibrary);
$semanticsMachineName = $semanticsMachineNameArray[0];
if ($machineName === $semanticsMachineName) {
// Using the wrong version of the library in the content
$message = $this->h5pF->t('The version of the H5P library %machineName used in this content is not valid. Content contains %contentLibrary, but it should be %semanticsLibrary.', array(
'%machineName' => $machineName,
'%contentLibrary' => $value->library,
'%semanticsLibrary' => $semanticsLibrary
));
break;
}
}
// Using a library in content that is not present at all in semantics
if ($message === NULL) {
$message = $this->h5pF->t('The H5P library %library used in the content is not valid', array(
'%library' => $value->library
));
}
$this->h5pF->setErrorMessage($message);
$value = NULL;
return;
}
if (!isset($this->libraries[$value->library])) {
$libSpec = H5PCore::libraryFromString($value->library);
$library = $this->h5pC->loadLibrary($libSpec['machineName'], $libSpec['majorVersion'], $libSpec['minorVersion']);
$library['semantics'] = $this->h5pC->loadLibrarySemantics($libSpec['machineName'], $libSpec['majorVersion'], $libSpec['minorVersion']);
$this->libraries[$value->library] = $library;
}
else {
$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)) {
$value->metadata = $this->validateMetadata($value->metadata);
}
$validKeys = array('library', 'params', 'subContentId', 'metadata');
if (isset($semantics->extraAttributes)) {
$validKeys = array_merge($validKeys, $semantics->extraAttributes);
}
$this->filterParams($value, $validKeys);
if (isset($value->subContentId) && ! preg_match('/^\{?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}\}?$/', $value->subContentId)) {
unset($value->subContentId);
}
// Find all dependencies for this library
$depKey = 'preloaded-' . $library['machineName'];
if (!isset($this->dependencies[$depKey])) {
$this->dependencies[$depKey] = array(
'library' => $library,
'type' => 'preloaded'
);
$this->nextWeight = $this->h5pC->findLibraryDependencies($this->dependencies, $library, $this->nextWeight);
$this->dependencies[$depKey]['weight'] = $this->nextWeight++;
}
}
/**
* Check params for a whitelist of allowed properties
*
* @param array/object $params
* @param array $whitelist
*/
public function filterParams(&$params, $whitelist) {
foreach ($params as $key => $value) {
if (!in_array($key, $whitelist)) {
unset($params->{$key});
}
}
}
// XSS filters copied from drupal 7 common.inc. Some modifications done to
// replace Drupal one-liner functions with corresponding flat PHP.
/**
* Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
*
* Based on kses by Ulf Harnhammar, see http://sourceforge.net/projects/kses.
* For examples of various XSS attacks, see: http://ha.ckers.org/xss.html.
*
* This code does four things:
* - Removes characters and constructs that can trick browsers.
* - Makes sure all HTML entities are well-formed.
* - Makes sure all HTML tags and attributes are well-formed.
* - Makes sure no HTML tags contain URLs with a disallowed protocol (e.g.
* javascript:).
*
* @param $string
* The string with raw HTML in it. It will be stripped of everything that can
* cause an XSS attack.
* @param array $allowed_tags
* An array of allowed tags.
*
* @param bool $allowedStyles
* @return mixed|string An XSS safe version of $string, or an empty string if $string is not
* An XSS safe version of $string, or an empty string if $string is not
* valid UTF-8.
* @ingroup sanitation
*/
private function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd'), $allowedStyles = FALSE) {
if (strlen($string) == 0) {
return $string;
}
// Only operate on valid UTF-8 strings. This is necessary to prevent cross
// site scripting issues on Internet Explorer 6. (Line copied from
// drupal_validate_utf8)
if (preg_match('/^./us', $string) != 1) {
return '';
}
$this->allowedStyles = $allowedStyles;
// Store the text format.
$this->_filter_xss_split($allowed_tags, TRUE);
// Remove NULL characters (ignored by some browsers).
$string = str_replace(chr(0), '', $string);
// Remove Netscape 4 JS entities.
$string = preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
// Defuse all HTML entities.
$string = str_replace('&', '&', $string);
// Change back only well-formed entities in our whitelist:
// Decimal numeric entities.
$string = preg_replace('/&#([0-9]+;)/', '&#\1', $string);
// Hexadecimal numeric entities.
$string = preg_replace('/&#[Xx]0*((?:[0-9A-Fa-f]{2})+;)/', '&#x\1', $string);
// Named entities.
$string = preg_replace('/&([A-Za-z][A-Za-z0-9]*;)/', '&\1', $string);
return preg_replace_callback('%
(
<(?=[^a-zA-Z!/]) # a lone <
| # or
<!--.*?--> # a comment
| # or
<[^>]*(>|$) # a string that starts with a <, up until the > or the end of the string
| # or
> # just a >
)%x', array($this, '_filter_xss_split'), $string);
}
/**
* Processes an HTML tag.
*
* @param $m
* An array with various meaning depending on the value of $store.
* If $store is TRUE then the array contains the allowed tags.
* If $store is FALSE then the array has one element, the HTML tag to process.
* @param bool $store
* Whether to store $m.
* @return string If the element isn't allowed, an empty string. Otherwise, the cleaned up
* If the element isn't allowed, an empty string. Otherwise, the cleaned up
* version of the HTML element.
*/
private function _filter_xss_split($m, $store = FALSE) {
static $allowed_html;
if ($store) {
$allowed_html = array_flip($m);
return $allowed_html;
}
$string = $m[1];
if (substr($string, 0, 1) != '<') {
// We matched a lone ">" character.
return '>';
}
elseif (strlen($string) == 1) {
// We matched a lone "<" character.
return '<';
}
if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9\-]+)\s*([^>]*)>?|(<!--.*?-->)$%', $string, $matches)) {
// Seriously malformed.
return '';
}
$slash = trim($matches[1]);
$elem = &$matches[2];
$attrList = &$matches[3];
$comment = &$matches[4];
if ($comment) {
$elem = '!--';
}
if (!isset($allowed_html[strtolower($elem)])) {
// Disallowed HTML element.
return '';
}
if ($comment) {
return $comment;
}
if ($slash != '') {
return "</$elem>";
}
// Is there a closing XHTML slash at the end of the attributes?
$attrList = preg_replace('%(\s?)/\s*$%', '\1', $attrList, -1, $count);
$xhtml_slash = $count ? ' /' : '';
// Clean up attributes.
$attr2 = implode(' ', $this->_filter_xss_attributes($attrList, (in_array($elem, self::$allowed_styleable_tags) ? $this->allowedStyles : FALSE)));
$attr2 = preg_replace('/[<>]/', '', $attr2);
$attr2 = strlen($attr2) ? ' ' . $attr2 : '';
return "<$elem$attr2$xhtml_slash>";
}
/**
* Processes a string of HTML attributes.
*
* @param $attr
* @param array|bool|object $allowedStyles
* @return array Cleaned up version of the HTML attributes.
* Cleaned up version of the HTML attributes.
*/
private function _filter_xss_attributes($attr, $allowedStyles = FALSE) {
$attrArr = array();
$mode = 0;
$attrName = '';
$skip = false;
while (strlen($attr) != 0) {
// Was the last operation successful?
$working = 0;
switch ($mode) {
case 0:
// Attribute name, href for instance.
if (preg_match('/^([-a-zA-Z]+)/', $attr, $match)) {
$attrName = strtolower($match[1]);
$skip = (
$attrName == 'style' ||
substr($attrName, 0, 2) == 'on' ||
substr($attrName, 0, 1) == '-' ||
// Ignore long attributes to avoid unnecessary processing overhead.
strlen($attrName) > 96
);
$working = $mode = 1;
$attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
}
break;
case 1:
// Equals sign or valueless ("selected").
if (preg_match('/^\s*=\s*/', $attr)) {
$working = 1; $mode = 2;
$attr = preg_replace('/^\s*=\s*/', '', $attr);
break;
}
if (preg_match('/^\s+/', $attr)) {
$working = 1; $mode = 0;
if (!$skip) {
$attrArr[] = $attrName;
}
$attr = preg_replace('/^\s+/', '', $attr);
}
break;
case 2:
// Attribute value, a URL after href= for instance.
if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) {
if ($allowedStyles && $attrName === 'style') {
// Allow certain styles
foreach ($allowedStyles as $pattern) {
if (preg_match($pattern, $match[1])) {
// All patterns are start to end patterns, and CKEditor adds one span per style
$attrArr[] = 'style="' . $match[1] . '"';
break;
}
}
break;
}
$thisVal = $this->filter_xss_bad_protocol($match[1]);
if (!$skip) {
$attrArr[] = "$attrName=\"$thisVal\"";
}
$working = 1;
$mode = 0;
$attr = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
break;
}
if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) {
$thisVal = $this->filter_xss_bad_protocol($match[1]);
if (!$skip) {
$attrArr[] = "$attrName='$thisVal'";
}
$working = 1; $mode = 0;
$attr = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
break;
}
if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) {
$thisVal = $this->filter_xss_bad_protocol($match[1]);
if (!$skip) {
$attrArr[] = "$attrName=\"$thisVal\"";
}
$working = 1; $mode = 0;
$attr = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
}
break;
}
if ($working == 0) {
// Not well formed; remove and try again.
$attr = preg_replace('/
^
(
"[^"]*("|$) # - a string that starts with a double quote, up until the next double quote or the end of the string
| # or
\'[^\']*(\'|$)| # - a string that starts with a quote, up until the next quote or the end of the string
| # or
\S # - a non-whitespace character
)* # any number of the above three
\s* # any number of whitespaces
/x', '', $attr);
$mode = 0;
}
}
// The attribute list ends with a valueless attribute like "selected".
if ($mode == 1 && !$skip) {
$attrArr[] = $attrName;
}
return $attrArr;
}
// TODO: Remove Drupal related stuff in docs.
/**
* Processes an HTML attribute value and strips dangerous protocols from URLs.
*
* @param $string
* The string with the attribute value.
* @param bool $decode
* (deprecated) Whether to decode entities in the $string. Set to FALSE if the
* $string is in plain text, TRUE otherwise. Defaults to TRUE. This parameter
* is deprecated and will be removed in Drupal 8. To process a plain-text URI,
* call _strip_dangerous_protocols() or check_url() instead.
* @return string Cleaned up and HTML-escaped version of $string.
* Cleaned up and HTML-escaped version of $string.
*/
private function filter_xss_bad_protocol($string, $decode = TRUE) {
// Get the plain text representation of the attribute value (i.e. its meaning).
// @todo Remove the $decode parameter in Drupal 8, and always assume an HTML
// string that needs decoding.
if ($decode) {
$string = html_entity_decode($string, ENT_QUOTES, 'UTF-8');
}
return htmlspecialchars($this->_strip_dangerous_protocols($string), ENT_QUOTES, 'UTF-8', FALSE);
}
/**
* Strips dangerous protocols (e.g. 'javascript:') from a URI.
*
* This function must be called for all URIs within user-entered input prior
* to being output to an HTML attribute value. It is often called as part of
* check_url() or filter_xss(), but those functions return an HTML-encoded
* string, so this function can be called independently when the output needs to
* be a plain-text string for passing to t(), l(), drupal_attributes(), or
* another function that will call check_plain() separately.
*
* @param $uri
* A plain-text URI that might contain dangerous protocols.
* @return string A plain-text URI stripped of dangerous protocols. As with all plain-text
* A plain-text URI stripped of dangerous protocols. As with all plain-text
* strings, this return value must not be output to an HTML page without
* check_plain() being called on it. However, it can be passed to functions
* expecting plain-text strings.
* @see check_url()
*/
private function _strip_dangerous_protocols($uri) {
static $allowed_protocols;
if (!isset($allowed_protocols)) {
$allowed_protocols = array_flip(array('ftp', 'http', 'https', 'mailto'));
}
// Iteratively remove any invalid protocol found.
do {
$before = $uri;
$colonPos = strpos($uri, ':');
if ($colonPos > 0) {
// We found a colon, possibly a protocol. Verify.
$protocol = substr($uri, 0, $colonPos);
// If a colon is preceded by a slash, question mark or hash, it cannot
// possibly be part of the URL scheme. This must be a relative URL, which
// inherits the (safe) protocol of the base document.
if (preg_match('![/?#]!', $protocol)) {
break;
}
// Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
// (URI Comparison) scheme comparison must be case-insensitive.
if (!isset($allowed_protocols[strtolower($protocol)])) {
$uri = substr($uri, $colonPos + 1);
}
}
} while ($before != $uri);
return $uri;
}
public function getMetadataSemantics() {
static $semantics;
$cc_versions = array(
(object) array(
'value' => '4.0',
'label' => $this->h5pF->t('4.0 International')
),
(object) array(
'value' => '3.0',
'label' => $this->h5pF->t('3.0 Unported')
),
(object) array(
'value' => '2.5',
'label' => $this->h5pF->t('2.5 Generic')
),
(object) array(
'value' => '2.0',
'label' => $this->h5pF->t('2.0 Generic')
),
(object) array(
'value' => '1.0',
'label' => $this->h5pF->t('1.0 Generic')
)
);
$semantics = array(
(object) array(
'name' => 'title',
'type' => 'text',
'label' => $this->h5pF->t('Title'),
'placeholder' => 'La Gioconda'
> ),
),
> (object) array(
(object) array(
> 'name' => 'a11yTitle',
'name' => 'license',
> 'type' => 'text',
'type' => 'select',
> 'label' => $this->h5pF->t('Assistive Technologies label'),
'label' => $this->h5pF->t('License'),
> 'optional' => TRUE,
'default' => 'U',
'options' => array(
(object) array(
'value' => 'U',
'label' => $this->h5pF->t('Undisclosed')
),
(object) array(
'type' => 'optgroup',
'label' => $this->h5pF->t('Creative Commons'),
'options' => array(
(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)')
),
)
),
(object) array(
'value' => 'GNU GPL',
'label' => $this->h5pF->t('General Public License v3')
),
(object) array(
'value' => 'PD',
'label' => $this->h5pF->t('Public Domain')
),
(object) array(
'value' => 'ODC PDDL',
'label' => $this->h5pF->t('Public Domain Dedication and Licence')
),
(object) array(
'value' => 'C',
'label' => $this->h5pF->t('Copyright')
)
)
),
(object) array(
'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')
)
)
)
)
)
),
(object) array(
'name' => 'licenseExtras',
'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' => 'changes',
'type' => 'list',
'field' => (object) array(
'name' => 'change',
'type' => 'group',
'label' => $this->h5pF->t('Changelog'),
'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 (
'name' => 'authorComments',
'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
),
(object) array(
'name' => 'contentType',
'type' => 'text',
'widget' => 'none'
),
(object) array(
'name' => 'defaultLanguage',
'type' => 'text',
'widget' => 'none'
)
);
return $semantics;
}
public function getCopyrightSemantics() {
static $semantics;
if ($semantics === NULL) {
$cc_versions = array(
(object) array(
'value' => '4.0',
'label' => $this->h5pF->t('4.0 International')
),
(object) array(
'value' => '3.0',
'label' => $this->h5pF->t('3.0 Unported')
),
(object) array(
'value' => '2.5',
'label' => $this->h5pF->t('2.5 Generic')
),
(object) array(
'value' => '2.0',
'label' => $this->h5pF->t('2.0 Generic')
),
(object) array(
'value' => '1.0',
'label' => $this->h5pF->t('1.0 Generic')
)
);
$semantics = (object) array(
'name' => 'copyright',
'type' => 'group',
'label' => $this->h5pF->t('Copyright information'),
'fields' => array(
(object) array(
'name' => 'title',
'type' => 'text',
'label' => $this->h5pF->t('Title'),
'placeholder' => 'La Gioconda',
'optional' => TRUE
),
(object) array(
'name' => 'author',
'type' => 'text',
'label' => $this->h5pF->t('Author'),
'placeholder' => 'Leonardo da Vinci',
'optional' => TRUE
),
(object) array(
'name' => 'year',
'type' => 'text',
'label' => $this->h5pF->t('Year(s)'),
'placeholder' => '1503 - 1517',
'optional' => TRUE
),
(object) array(
'name' => 'source',
'type' => 'text',
'label' => $this->h5pF->t('Source'),
'placeholder' => 'http://en.wikipedia.org/wiki/Mona_Lisa',
'optional' => true,
'regexp' => (object) array(
'pattern' => '^http[s]?://.+',
'modifiers' => 'i'
)
),
(object) array(
'name' => 'license',
'type' => 'select',
'label' => $this->h5pF->t('License'),
'default' => 'U',
'options' => array(
(object) array(
'value' => 'U',
'label' => $this->h5pF->t('Undisclosed')
),
(object) array(
'value' => 'CC BY',
'label' => $this->h5pF->t('Attribution'),
'versions' => $cc_versions
),
(object) array(
'value' => 'CC BY-SA',
'label' => $this->h5pF->t('Attribution-ShareAlike'),
'versions' => $cc_versions
),
(object) array(
'value' => 'CC BY-ND',
'label' => $this->h5pF->t('Attribution-NoDerivs'),
'versions' => $cc_versions
),
(object) array(
'value' => 'CC BY-NC',
'label' => $this->h5pF->t('Attribution-NonCommercial'),
'versions' => $cc_versions
),
(object) array(
'value' => 'CC BY-NC-SA',
'label' => $this->h5pF->t('Attribution-NonCommercial-ShareAlike'),
'versions' => $cc_versions
),
(object) array(
'value' => 'CC BY-NC-ND',
'label' => $this->h5pF->t('Attribution-NonCommercial-NoDerivs'),
'versions' => $cc_versions
),
(object) array(
'value' => 'GNU GPL',
'label' => $this->h5pF->t('General Public License'),
'versions' => array(
(object) array(
'value' => 'v3',
'label' => $this->h5pF->t('Version 3')
),
(object) array(
'value' => 'v2',
'label' => $this->h5pF->t('Version 2')
),
(object) array(
'value' => 'v1',
'label' => $this->h5pF->t('Version 1')
)
)
),
(object) array(
'value' => 'PD',
'label' => $this->h5pF->t('Public Domain'),
'versions' => array(
(object) array(
'value' => '-',
'label' => '-'
),
(object) array(
'value' => 'CC0 1.0',
'label' => $this->h5pF->t('CC0 1.0 Universal')
),
(object) array(
'value' => 'CC PDM',
'label' => $this->h5pF->t('Public Domain Mark')
)
)
),
(object) array(
'value' => 'C',
'label' => $this->h5pF->t('Copyright')
)
)
),
(object) array(
'name' => 'version',
'type' => 'select',
'label' => $this->h5pF->t('License Version'),
'options' => array()
)
)
);
}
return $semantics;
}
}
