Merge branch 'event-logging' of github.com:h5p/h5p-php-library into event-logging
Conflicts: h5p.classes.phppull/17/head
Frode Petterson
commit
f05a370b42
|
|
@ -0,0 +1,191 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* The base class for H5P events. Extend to track H5P events in your system.
|
||||
*
|
||||
* @package H5P
|
||||
* @copyright 2016 Joubel AS
|
||||
* @license MIT
|
||||
*/
|
||||
abstract class H5PEventBase {
|
||||
// Constants
|
||||
const LOG_NONE = 0;
|
||||
const LOG_ALL = 1;
|
||||
const LOG_ACTIONS = 2;
|
||||
|
||||
// Static options
|
||||
public static $log_level = self::LOG_ACTIONS;
|
||||
public static $log_time = 2592000; // 30 Days
|
||||
|
||||
// Protected variables
|
||||
protected $id, $type, $sub_type, $content_id, $content_title, $library_name, $library_version, $time;
|
||||
|
||||
/**
|
||||
* Adds event type, h5p library and timestamp to event before saving it.
|
||||
*
|
||||
* Common event types with sub type:
|
||||
* content, <none> – content view
|
||||
* embed – viewed through embed code
|
||||
* shortcode – viewed through internal shortcode
|
||||
* edit – opened in editor
|
||||
* delete – deleted
|
||||
* create – created through editor
|
||||
* create upload – created through upload
|
||||
* update – updated through editor
|
||||
* update upload – updated through upload
|
||||
* upgrade – upgraded
|
||||
*
|
||||
* results, <none> – view own results
|
||||
* content – view results for content
|
||||
* set – new results inserted or updated
|
||||
*
|
||||
* settings, <none> – settings page loaded
|
||||
*
|
||||
* library, <none> – loaded in editor
|
||||
* create – new library installed
|
||||
* update – old library updated
|
||||
*
|
||||
* @param string $type
|
||||
* Name of event type
|
||||
* @param string $sub_type
|
||||
* Name of event sub type
|
||||
* @param string $content_id
|
||||
* Identifier for content affacted by the event
|
||||
* @param string $content_title
|
||||
* Content title (makes it easier to know which content was deleted etc.)
|
||||
* @param string $library_name
|
||||
* Name of the library affacted by the event
|
||||
* @param string $library_version
|
||||
* Library version
|
||||
*/
|
||||
function __construct($type, $sub_type = NULL, $content_id = NULL, $content_title = NULL, $library_name = NULL, $library_version = NULL) {
|
||||
$this->type = $type;
|
||||
$this->sub_type = $sub_type;
|
||||
$this->content_id = $content_id;
|
||||
$this->content_title = $content_title;
|
||||
$this->library_name = $library_name;
|
||||
$this->library_version = $library_version;
|
||||
$this->time = time();
|
||||
|
||||
if (self::validLogLevel($type, $sub_type)) {
|
||||
$this->save();
|
||||
}
|
||||
if (self::validStats($type, $sub_type)) {
|
||||
$this->saveStats();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if the event type should be saved/logged.
|
||||
*
|
||||
* @param string $type
|
||||
* Name of event type
|
||||
* @param string $sub_type
|
||||
* Name of event sub type
|
||||
* @return boolean
|
||||
*/
|
||||
private static function validLogLevel($type, $sub_type) {
|
||||
switch (self::$log_level) {
|
||||
default:
|
||||
case self::LOG_NONE:
|
||||
return FALSE;
|
||||
case self::LOG_ALL:
|
||||
return TRUE; // Log everything
|
||||
case self::LOG_ACTIONS:
|
||||
if (self::isAction($type, $sub_type)) {
|
||||
return TRUE; // Log actions
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the event should be included in the statistics counter.
|
||||
*
|
||||
* @param string $type
|
||||
* Name of event type
|
||||
* @param string $sub_type
|
||||
* Name of event sub type
|
||||
* @return boolean
|
||||
*/
|
||||
private static function validStats($type, $sub_type) {
|
||||
if ( ($type === 'content' && $sub_type === 'shortcode insert') || // Count number of shortcode inserts
|
||||
($type === 'library' && $sub_type === NULL) || // Count number of times library is loaded in editor
|
||||
($type === 'results' && $sub_type === 'content') ) { // Count number of times results page has been opened
|
||||
return TRUE;
|
||||
}
|
||||
elseif (self::isAction($type, $sub_type)) { // Count all actions
|
||||
return TRUE;
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if event type is an action.
|
||||
*
|
||||
* @param string $type
|
||||
* Name of event type
|
||||
* @param string $sub_type
|
||||
* Name of event sub type
|
||||
* @return boolean
|
||||
*/
|
||||
private static function isAction($type, $sub_type) {
|
||||
if ( ($type === 'content' && in_array($sub_type, array('create', 'create upload', 'update', 'update upload', 'upgrade', 'delete'))) ||
|
||||
($type === 'library' && in_array($sub_type, array('create', 'update'))) ) {
|
||||
return TRUE; // Log actions
|
||||
}
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
/**
|
||||
* A helper which makes it easier for systems to save the data.
|
||||
* Add all relevant properties to a assoc. array.
|
||||
* There are no NULL values. Empty string or 0 is used instead.
|
||||
* Used by both Drupal and WordPress.
|
||||
*
|
||||
* @return array with keyed values
|
||||
*/
|
||||
protected function getDataArray() {
|
||||
return array(
|
||||
'created_at' => $this->time,
|
||||
'type' => $this->type,
|
||||
'sub_type' => empty($this->sub_type) ? '' : $this->sub_type,
|
||||
'content_id' => empty($this->content_id) ? 0 : $this->content_id,
|
||||
'content_title' => empty($this->content_title) ? '' : $this->content_title,
|
||||
'library_name' => empty($this->library_name) ? '' : $this->library_name,
|
||||
'library_version' => empty($this->library_version) ? '' : $this->library_version
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* A helper which makes it easier for systems to save the data.
|
||||
* Used in WordPress.
|
||||
*
|
||||
* @return array with strings
|
||||
*/
|
||||
protected function getFormatArray() {
|
||||
return array(
|
||||
'%d',
|
||||
'%s',
|
||||
'%s',
|
||||
'%d',
|
||||
'%s',
|
||||
'%s',
|
||||
'%s'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Stores the event data in the database.
|
||||
*
|
||||
* Must be overriden by plugin.
|
||||
*/
|
||||
abstract protected function save();
|
||||
|
||||
/**
|
||||
* Add current event data to statistics counter.
|
||||
*
|
||||
* Must be overriden by plugin.
|
||||
*/
|
||||
abstract protected function saveStats();
|
||||
}
|
||||
133
h5p.classes.php
133
h5p.classes.php
|
|
@ -547,6 +547,20 @@ interface H5PFrameworkInterface {
|
|||
* @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();
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -1712,6 +1726,7 @@ class H5PCore {
|
|||
}
|
||||
|
||||
$this->detectSiteType();
|
||||
$this->fullPluginPath = preg_replace('/\/[^\/]+[\/]?$/', '' , dirname(__FILE__));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -2390,10 +2405,8 @@ class H5PCore {
|
|||
$type = $this->h5pF->getOption('site_type', 'local');
|
||||
|
||||
// Determine remote/visitor origin
|
||||
$localhostPattern = '/^localhost$|^127(?:\.[0-9]+){0,2}\.[0-9]+$|^(?:0*\:)*?:?0*1$/i';
|
||||
|
||||
// localhost
|
||||
if ($type !== 'internet' && !preg_match($localhostPattern, $_SERVER['REMOTE_ADDR'])) {
|
||||
if ($type === 'network' ||
|
||||
($type === 'local' && !preg_match('/^localhost$|^127(?:\.[0-9]+){0,2}\.[0-9]+$|^(?:0*\:)*?:?0*1$/i', $_SERVER['REMOTE_ADDR']))) {
|
||||
if (filter_var($_SERVER['REMOTE_ADDR'], FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE)) {
|
||||
// Internet
|
||||
$this->h5pF->setOption('site_type', 'internet');
|
||||
|
|
@ -2405,38 +2418,108 @@ class H5PCore {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 $library) {
|
||||
foreach($library as $libVersion) {
|
||||
$librariesInstalled[$libVersion->name.' '.$libVersion->major_version.'.'.$libVersion->minor_version] = $libVersion->patch_version;
|
||||
}
|
||||
}
|
||||
|
||||
return $librariesInstalled;
|
||||
}
|
||||
|
||||
/**
|
||||
* Easy way to combine smiliar 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;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch a list of libraries' metadata from h5p.org.
|
||||
* Save URL tutorial to database. Each platform implementation
|
||||
* is responsible for invoking this, eg using cron
|
||||
*/
|
||||
public function fetchLibrariesMetadata($fetchingDisabled = FALSE) {
|
||||
$platformInfo = $this->h5pF->getPlatformInfo();
|
||||
$platformInfo['autoFetchingDisabled'] = $fetchingDisabled;
|
||||
$platformInfo['uuid'] = $this->h5pF->getOption('site_uuid', '');
|
||||
$platformInfo['siteType'] = $this->h5pF->getOption('site_type', 'local');
|
||||
$platformInfo['libraryContentCount'] = $this->h5pF->getLibraryContentCount();
|
||||
// Gather data
|
||||
$uuid = $this->h5pF->getOption('site_uuid', '');
|
||||
$platform = $this->h5pF->getPlatformInfo();
|
||||
$data = array(
|
||||
'api_version' => 2,
|
||||
'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'),
|
||||
'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')
|
||||
)))
|
||||
);
|
||||
|
||||
// Adding random string to GET to be sure nothing is cached
|
||||
$random = substr(str_shuffle("0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"), 0, 5);
|
||||
$json = $this->h5pF->fetchExternalData('http://h5p.org/libraries-metadata.json?api=1&platform=' . urlencode(json_encode($platformInfo)) . '&x=' . urlencode($random));
|
||||
if ($json !== NULL) {
|
||||
$json = json_decode($json);
|
||||
if (isset($json->libraries)) {
|
||||
foreach ($json->libraries as $machineName => $libInfo) {
|
||||
$this->h5pF->setLibraryTutorialUrl($machineName, $libInfo->tutorialUrl);
|
||||
}
|
||||
}
|
||||
if($platformInfo['uuid'] === '' && isset($json->uuid)) {
|
||||
$this->h5pF->setOption('site_uuid', $json->uuid);
|
||||
}
|
||||
if (isset($json->latest) && !empty($json->latest)) {
|
||||
$this->h5pF->setOption('update_available', $json->latest->releasedAt);
|
||||
$this->h5pF->setOption('update_available_path', $json->latest->path);
|
||||
// Send request
|
||||
$protocol = (extension_loaded('openssl') ? 'https' : 'http');
|
||||
$result = $this->h5pF->fetchExternalData("{$protocol}://h5p.org/libraries-metadata.json", $data);
|
||||
if (empty($result)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Process results
|
||||
$json = json_decode($result);
|
||||
if (empty($json)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Handle libraries metadata
|
||||
if (isset($json->libraries)) {
|
||||
foreach ($json->libraries as $machineName => $libInfo) {
|
||||
$this->h5pF->setLibraryTutorialUrl($machineName, $libInfo->tutorialUrl);
|
||||
}
|
||||
}
|
||||
|
||||
// Handle new uuid
|
||||
if ($uuid === '' && isset($json->uuid)) {
|
||||
$this->h5pF->setOption('site_uuid', $json->uuid);
|
||||
}
|
||||
|
||||
// Handle lastest version of H5P
|
||||
if (!empty($json->latest)) {
|
||||
$this->h5pF->setOption('update_available', $json->latest->releasedAt);
|
||||
$this->h5pF->setOption('update_available_path', $json->latest->path);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
public function getGlobalDisable() {
|
||||
$disable = self::DISABLE_NONE;
|
||||
|
||||
|
|
|
|||
|
|
@ -139,8 +139,8 @@ H5P.EventDispatcher = (function () {
|
|||
}
|
||||
|
||||
var once = function (event) {
|
||||
self.off(event, once);
|
||||
listener.apply(this, event);
|
||||
self.off(event.type, once);
|
||||
listener.call(this, event);
|
||||
};
|
||||
|
||||
self.on(type, once, thisArg);
|
||||
|
|
|
|||
Loading…
Reference in New Issue