Current File : /opt/bitnami/apps/moodle/htdocs.backup/h5p/tests/generator/lib.php
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Generator for the core_h5p subsystem.
*
* @package core_h5p
* @category test
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
use core_h5p\autoloader;
use core_h5p\core;
defined('MOODLE_INTERNAL') || die();
/**
* Generator for the core_h5p subsystem.
*
* @package core_h5p
* @category test
* @copyright 2019 Victor Deniz <victor@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_h5p_generator extends \component_generator_base {
/**
* Convenience function to create a file.
*
* @param string $file path to a file.
* @param string $content file content.
*/
public function create_file(string $file, string $content=''): void {
$handle = fopen($file, 'w+');
// File content is not relevant.
if (empty($content)) {
$content = hash("md5", $file);
}
fwrite($handle, $content);
fclose($handle);
}
/**
* Creates the file record. Currently used for the cache tests.
*
* @param string $type Either 'scripts' or 'styles'.
* @param string $path Path to the file in the file system.
* @param string $version Not really needed at the moment.
*/
protected function add_libfile_to_array(string $type, string $path, string $version, &$files): void {
$files[$type][] = (object)[
'path' => $path,
'version' => "?ver=$version"
];
}
/**
* Create the necessary files and return an array structure for a library.
*
* @param string $uploaddirectory Base directory for the library.
* @param int $libraryid Library id.
* @param string $machinename Name for this library.
* @param int $majorversion Major version (any number will do).
* @param int $minorversion Minor version (any number will do).
* @return array A list of library data and files that the core API will understand.
*/
public function create_library(string $uploaddirectory, int $libraryid, string $machinename, int $majorversion,
int $minorversion): array {
/** @var array $files an array used in the cache tests. */
$files = ['scripts' => [], 'styles' => []];
check_dir_exists($uploaddirectory . '/' . 'scripts');
check_dir_exists($uploaddirectory . '/' . 'styles');
$jsonfile = $uploaddirectory . '/' . 'library.json';
$jsfile = $uploaddirectory . '/' . 'scripts/testlib.min.js';
$cssfile = $uploaddirectory . '/' . 'styles/testlib.min.css';
$this->create_file($jsonfile);
$this->create_file($jsfile);
$this->create_file($cssfile);
$lib = [
'title' => 'Test lib',
'description' => 'Test library description',
'majorVersion' => $majorversion,
'minorVersion' => $minorversion,
'patchVersion' => 2,
'machineName' => $machinename,
'preloadedJs' => [
[
'path' => 'scripts' . '/' . 'testlib.min.js'
]
],
'preloadedCss' => [
[
'path' => 'styles' . '/' . 'testlib.min.css'
]
],
'uploadDirectory' => $uploaddirectory,
'libraryId' => $libraryid
];
$version = "{$majorversion}.{$minorversion}.2";
$libname = "{$machinename}-{$majorversion}.{$minorversion}";
$path = '/' . 'libraries' . '/' . $libraryid . '/' . $libname . '/' . 'scripts' . '/' . 'testlib.min.js';
$this->add_libfile_to_array('scripts', $path, $version, $files);
$path = '/' . 'libraries' . '/' . $libraryid .'/' . $libname . '/' . 'styles' . '/' . 'testlib.min.css';
$this->add_libfile_to_array('styles', $path, $version, $files);
return [$lib, $files];
}
/**
* Save the library files on the filesystem.
*
* @param stdClss $lib The library data
*/
private function save_library(stdClass $lib) {
// Get a temp path.
$filestorage = new \core_h5p\file_storage();
$temppath = $filestorage->getTmpPath();
// Create and save the library files on the filesystem.
$basedirectorymain = $temppath . '/' . $lib->machinename . '-' .
$lib->majorversion . '.' . $lib->minorversion;
list($library, $libraryfiles) = $this->create_library($basedirectorymain, $lib->id, $lib->machinename,
$lib->majorversion, $lib->minorversion);
$filestorage->saveLibrary($library);
}
/**
* Populate H5P database tables with relevant data to simulate the process of adding H5P content.
*
* @param bool $createlibraryfiles Whether to create and store library files on the filesystem
* @return stdClass An object representing the added H5P records
*/
public function generate_h5p_data(bool $createlibraryfiles = false): stdClass {
// Create libraries.
$mainlib = $libraries[] = $this->create_library_record('MainLibrary', 'Main Lib', 1, 0);
$lib1 = $libraries[] = $this->create_library_record('Library1', 'Lib1', 2, 0);
$lib2 = $libraries[] = $this->create_library_record('Library2', 'Lib2', 2, 1);
$lib3 = $libraries[] = $this->create_library_record('Library3', 'Lib3', 3, 2);
$lib4 = $libraries[] = $this->create_library_record('Library4', 'Lib4', 1, 1);
$lib5 = $libraries[] = $this->create_library_record('Library5', 'Lib5', 1, 3);
if ($createlibraryfiles) {
foreach ($libraries as $lib) {
// Create and save the library files on the filesystem.
$this->save_library($lib);
}
}
// Create h5p content.
$h5p = $this->create_h5p_record($mainlib->id);
// Create h5p content library dependencies.
$this->create_contents_libraries_record($h5p, $mainlib->id);
$this->create_contents_libraries_record($h5p, $lib1->id);
$this->create_contents_libraries_record($h5p, $lib2->id);
$this->create_contents_libraries_record($h5p, $lib3->id);
$this->create_contents_libraries_record($h5p, $lib4->id);
// Create library dependencies for $mainlib.
$this->create_library_dependency_record($mainlib->id, $lib1->id);
$this->create_library_dependency_record($mainlib->id, $lib2->id);
$this->create_library_dependency_record($mainlib->id, $lib3->id);
// Create library dependencies for $lib1.
$this->create_library_dependency_record($lib1->id, $lib2->id);
$this->create_library_dependency_record($lib1->id, $lib3->id);
$this->create_library_dependency_record($lib1->id, $lib4->id);
// Create library dependencies for $lib3.
$this->create_library_dependency_record($lib3->id, $lib5->id);
return (object) [
'h5pcontent' => (object) array(
'h5pid' => $h5p,
'contentdependencies' => array($mainlib, $lib1, $lib2, $lib3, $lib4)
),
'mainlib' => (object) array(
'data' => $mainlib,
'dependencies' => array($lib1, $lib2, $lib3)
),
'lib1' => (object) array(
'data' => $lib1,
'dependencies' => array($lib2, $lib3, $lib4)
),
'lib2' => (object) array(
'data' => $lib2,
'dependencies' => array()
),
'lib3' => (object) array(
'data' => $lib3,
'dependencies' => array($lib5)
),
'lib4' => (object) array(
'data' => $lib4,
'dependencies' => array()
),
'lib5' => (object) array(
'data' => $lib5,
'dependencies' => array()
),
];
}
/**
* Create a record in the h5p_libraries database table.
*
* @param string $machinename The library machine name
* @param string $title The library's name
* @param int $majorversion The library's major version
* @param int $minorversion The library's minor version
* @param int $patchversion The library's patch version
* @param string $semantics Json describing the content structure for the library
* @param string $addto The plugin configuration data
* @return stdClass An object representing the added library record
*/
public function create_library_record(string $machinename, string $title, int $majorversion = 1,
int $minorversion = 0, int $patchversion = 1, string $semantics = '', string $addto = null): stdClass {
global $DB;
$content = array(
'machinename' => $machinename,
'title' => $title,
'majorversion' => $majorversion,
'minorversion' => $minorversion,
'patchversion' => $patchversion,
'runnable' => 1,
'fullscreen' => 1,
'preloadedjs' => 'js/example.js',
'preloadedcss' => 'css/example.css',
'droplibrarycss' => '',
'semantics' => $semantics,
'addto' => $addto
);
$libraryid = $DB->insert_record('h5p_libraries', $content);
return $DB->get_record('h5p_libraries', ['id' => $libraryid]);
}
/**
* Create a record in the h5p database table.
*
* @param int $mainlibid The ID of the content's main library
* @param string $jsoncontent The content in json format
* @param string $filtered The filtered content parameters
* @return int The ID of the added record
*/
public function create_h5p_record(int $mainlibid, string $jsoncontent = null, string $filtered = null): int {
global $DB;
if (!$jsoncontent) {
$jsoncontent = json_encode(
array(
'text' => '<p>Dummy text<\/p>\n',
'questions' => '<p>Test question<\/p>\n'
)
);
}
if (!$filtered) {
$filtered = json_encode(
array(
'text' => 'Dummy text',
'questions' => 'Test question'
)
);
}
return $DB->insert_record(
'h5p',
array(
'jsoncontent' => $jsoncontent,
'displayoptions' => 8,
'mainlibraryid' => $mainlibid,
'timecreated' => time(),
'timemodified' => time(),
'filtered' => $filtered,
'pathnamehash' => sha1('pathname'),
'contenthash' => sha1('content')
)
);
}
/**
* Create a record in the h5p_contents_libraries database table.
*
* @param string $h5pid The ID of the H5P content
* @param int $libid The ID of the library
* @param string $dependencytype The dependency type
* @return int The ID of the added record
*/
public function create_contents_libraries_record(string $h5pid, int $libid,
string $dependencytype = 'preloaded'): int {
global $DB;
return $DB->insert_record(
'h5p_contents_libraries',
array(
'h5pid' => $h5pid,
'libraryid' => $libid,
'dependencytype' => $dependencytype,
'dropcss' => 0,
'weight' => 1
)
);
}
/**
* Create a record in the h5p_library_dependencies database table.
*
* @param int $libid The ID of the library
* @param int $requiredlibid The ID of the required library
* @param string $dependencytype The dependency type
* @return int The ID of the added record
*/
public function create_library_dependency_record(int $libid, int $requiredlibid,
string $dependencytype = 'preloaded'): int {
global $DB;
return $DB->insert_record(
'h5p_library_dependencies',
array(
'libraryid' => $libid,
'requiredlibraryid' => $requiredlibid,
'dependencytype' => $dependencytype
)
);
}
/**
* Create H5P content type records in the h5p_libraries database table.
*
* @param array $typestonotinstall H5P content types that should not be installed
* @param core $core h5p_test_core instance required to use the exttests URL
* @return array Data of the content types not installed.
*/
public function create_content_types(array $typestonotinstall, core $core): array {
global $DB;
autoloader::register();
// Get info of latest content types versions.
$contenttypes = $core->get_latest_content_types()->contentTypes;
$installedtypes = 0;
// Fake installation of all other H5P content types.
foreach ($contenttypes as $contenttype) {
// Don't install pending content types.
if (in_array($contenttype->id, $typestonotinstall)) {
continue;
}
$library = [
'machinename' => $contenttype->id,
'majorversion' => $contenttype->version->major,
'minorversion' => $contenttype->version->minor,
'patchversion' => $contenttype->version->patch,
'runnable' => 1,
'coremajor' => $contenttype->coreApiVersionNeeded->major,
'coreminor' => $contenttype->coreApiVersionNeeded->minor
];
$DB->insert_record('h5p_libraries', (object) $library);
$installedtypes++;
}
return [$installedtypes, count($typestonotinstall)];
}
}
Mini Shell