Major post review changes

namespaces
Pål Jørgensen 2014-11-01 17:05:15 +01:00
parent 1752d4eccf
commit f01d002f66
1 changed files with 84 additions and 18 deletions

View File

@ -11,9 +11,18 @@ interface H5PFrameworkInterface {
* An associative array containing: * An associative array containing:
* - name: The name of the plattform, for instance "Wordpress" * - name: The name of the plattform, for instance "Wordpress"
* - version: The version of the pattform, for instance "4.0" * - version: The version of the pattform, for instance "4.0"
* - uuid: UUID for site installation
*/ */
public function getPlatformInfo(); public function getPlatformInfo();
/**
* 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 * Show the user an error message
* *
@ -2028,6 +2037,34 @@ class H5PCore {
return $obj ? (object) $newArr : $newArr; return $obj ? (object) $newArr : $newArr;
} }
/**
* Generates a UUID v4. Taken from: http://php.net/manual/en/function.uniqid.php
*
* @return string uuid
*/
public static function generateUUID() {
return sprintf('%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
// 32 bits for "time_low"
mt_rand(0, 0xffff), mt_rand(0, 0xffff),
// 16 bits for "time_mid"
mt_rand(0, 0xffff),
// 16 bits for "time_hi_and_version",
// four most significant bits holds version number 4
mt_rand(0, 0x0fff) | 0x4000,
// 16 bits, 8 bits for "clk_seq_hi_res",
// 8 bits for "clk_seq_low",
// two most significant bits holds zero and one for variant DCE1.1
mt_rand(0, 0x3fff) | 0x8000,
// 48 bits for "node"
mt_rand(0, 0xffff), mt_rand(0, 0xffff), mt_rand(0, 0xffff)
);
}
/** /**
* Check if currently installed H5P libraries are supported by * Check if currently installed H5P libraries are supported by
* the current versjon of core. Which versions of which libraries are supported is * the current versjon of core. Which versions of which libraries are supported is
@ -2157,27 +2194,56 @@ class H5PCore {
} }
/** /**
* Get a list of libraries' metadata from h5p.org. Cache it, and refetch once a week. * Fetch a list of libraries' metadata from h5p.org.
* * Save URL tutorial to database. Each platform implementation
* @return mixed An object of objects keyed by machineName * is responsible for invoking this, eg using cron
*/ */
public function getLibrariesMetadata() { public function fetchLibrariesMetadata($fetchingDisabled = FALSE) {
// Fetch from cache: $platformInfo = $this->h5pF->getPlatformInfo();
$metadata = $this->h5pF->cacheGet('libraries','metadata'); $platformInfo['autoFetchingDisabled'] = $fetchingDisabled;
$json = H5PExternalDataFetcher::fetchJson('http://h5p.lvh.me/h5p.org/libraries-metadata.json?api=1&platform=' . urlencode(json_encode($platformInfo)));
// If not available in cache, or older than a week => refetch! if ($json !== NULL) {
if ($metadata === NULL || $metadata->lastTimeFetched < (time() - self::SECONDS_IN_WEEK)) { foreach ($json as $machineName => $libInfo) {
$platformInfo = $this->h5pF->getPlatformInfo(); $this->h5pF->setLibraryTutorialUrl($machineName, $libInfo->tutorialUrl);
$json = file_get_contents('http://h5p.org/libraries-metadata.json?platform=' . json_encode($platformInfo)); }
$metadata = new stdClass();
$metadata->json = ($json === FALSE ? NULL : json_decode($json));
$metadata->lastTimeFetched = time();
$this->h5pF->cacheSet('libraries','metadata', $metadata);
} }
}
}
return $metadata->json; /**
* Class responsible for fetching external data (using http)
*/
class H5PExternalDataFetcher {
public static function fetchJson($url) {
$json = self::fetch($url);
return ($json === NULL) ? NULL : json_decode($json);
}
public static function fetch($url) {
if (ini_get('allow_url_fopen') == TRUE) {
return self::fetchFopen($url);
}
else if (function_exists('curl_init')) {
return self::fetchCurl($url);
}
else {
// Enable 'allow_url_fopen' or install cURL.
// TODO - this could be reported to the user.
return NULL;
}
}
private static function fetchFopen($url) {
return file_get_contents($url);
}
private static function fetchCurl($url) {
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($curl);
curl_close($curl);
return $result;
} }
} }