2016-02-02 17:03:53 +01:00
|
|
|
|
<?php
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The base class for H5P events. Extend to track H5P events in your system.
|
|
|
|
|
*
|
|
|
|
|
* @package H5P
|
|
|
|
|
* @copyright 2016 Joubel AS
|
|
|
|
|
* @license MIT
|
|
|
|
|
*/
|
2016-02-19 13:38:38 +01:00
|
|
|
|
abstract class H5PEventBase {
|
2016-02-02 17:03:53 +01:00
|
|
|
|
// Constants
|
|
|
|
|
const LOG_NONE = 0;
|
|
|
|
|
const LOG_ALL = 1;
|
|
|
|
|
const LOG_ACTIONS = 2;
|
|
|
|
|
|
|
|
|
|
// Static options
|
2016-02-19 13:38:38 +01:00
|
|
|
|
public static $log_level = self::LOG_ACTIONS;
|
2016-02-03 10:42:14 +01:00
|
|
|
|
public static $log_time = 2592000; // 30 Days
|
2016-02-02 17:03:53 +01:00
|
|
|
|
|
|
|
|
|
// Protected variables
|
2016-02-04 14:13:59 +01:00
|
|
|
|
protected $id, $type, $sub_type, $content_id, $content_title, $library_name, $library_version, $time;
|
2016-02-02 17:03:53 +01:00
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 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();
|
|
|
|
|
}
|
2016-02-19 13:38:38 +01:00
|
|
|
|
if (self::validStats($type, $sub_type)) {
|
|
|
|
|
$this->saveStats();
|
2016-02-10 11:49:20 +01:00
|
|
|
|
}
|
2016-02-02 17:03:53 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2016-02-10 11:49:20 +01:00
|
|
|
|
* Determines if the event type should be saved/logged.
|
|
|
|
|
*
|
2016-02-02 17:03:53 +01:00
|
|
|
|
* @param string $type
|
|
|
|
|
* Name of event type
|
|
|
|
|
* @param string $sub_type
|
|
|
|
|
* Name of event sub type
|
2016-02-10 11:49:20 +01:00
|
|
|
|
* @return boolean
|
2016-02-02 17:03:53 +01:00
|
|
|
|
*/
|
2016-02-19 13:38:38 +01:00
|
|
|
|
private static function validLogLevel($type, $sub_type) {
|
2016-02-02 17:03:53 +01:00
|
|
|
|
switch (self::$log_level) {
|
|
|
|
|
default:
|
|
|
|
|
case self::LOG_NONE:
|
|
|
|
|
return FALSE;
|
|
|
|
|
case self::LOG_ALL:
|
2016-02-10 11:49:20 +01:00
|
|
|
|
return TRUE; // Log everything
|
2016-02-02 17:03:53 +01:00
|
|
|
|
case self::LOG_ACTIONS:
|
2016-02-10 11:49:20 +01:00
|
|
|
|
if (self::isAction($type, $sub_type)) {
|
2016-02-02 17:03:53 +01:00
|
|
|
|
return TRUE; // Log actions
|
|
|
|
|
}
|
|
|
|
|
return FALSE;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-10 11:49:20 +01:00
|
|
|
|
/**
|
2016-02-19 13:38:38 +01:00
|
|
|
|
* Check if the event should be included in the statistics counter.
|
2016-02-10 11:49:20 +01:00
|
|
|
|
*
|
|
|
|
|
* @param string $type
|
|
|
|
|
* Name of event type
|
|
|
|
|
* @param string $sub_type
|
|
|
|
|
* Name of event sub type
|
|
|
|
|
* @return boolean
|
|
|
|
|
*/
|
2016-02-19 13:38:38 +01:00
|
|
|
|
private static function validStats($type, $sub_type) {
|
2016-02-10 11:49:20 +01:00
|
|
|
|
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;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
2016-02-19 13:38:38 +01:00
|
|
|
|
* Check if event type is an action.
|
2016-02-10 11:49:20 +01:00
|
|
|
|
*
|
|
|
|
|
* @param string $type
|
|
|
|
|
* Name of event type
|
|
|
|
|
* @param string $sub_type
|
|
|
|
|
* Name of event sub type
|
|
|
|
|
* @return boolean
|
|
|
|
|
*/
|
2016-02-19 13:38:38 +01:00
|
|
|
|
private static function isAction($type, $sub_type) {
|
2016-02-10 11:49:20 +01:00
|
|
|
|
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;
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-04 14:13:59 +01:00
|
|
|
|
/**
|
2016-02-19 13:38:38 +01:00
|
|
|
|
* 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.
|
2016-02-04 14:13:59 +01:00
|
|
|
|
*
|
2016-02-19 13:38:38 +01:00
|
|
|
|
* @return array with keyed values
|
2016-02-04 14:13:59 +01:00
|
|
|
|
*/
|
2016-02-19 13:38:38 +01:00
|
|
|
|
protected function getDataArray() {
|
2016-02-04 14:13:59 +01:00
|
|
|
|
return array(
|
2016-02-19 13:38:38 +01:00
|
|
|
|
'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
|
2016-02-04 14:13:59 +01:00
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-02 17:03:53 +01:00
|
|
|
|
/**
|
2016-02-19 13:38:38 +01:00
|
|
|
|
* A helper which makes it easier for systems to save the data.
|
|
|
|
|
* Used in WordPress.
|
|
|
|
|
*
|
|
|
|
|
* @return array with strings
|
2016-02-02 17:03:53 +01:00
|
|
|
|
*/
|
2016-02-19 13:38:38 +01:00
|
|
|
|
protected function getFormatArray() {
|
|
|
|
|
return array(
|
|
|
|
|
'%d',
|
|
|
|
|
'%s',
|
|
|
|
|
'%s',
|
|
|
|
|
'%d',
|
|
|
|
|
'%s',
|
|
|
|
|
'%s',
|
|
|
|
|
'%s'
|
|
|
|
|
);
|
2016-02-02 17:03:53 +01:00
|
|
|
|
}
|
2016-02-10 11:49:20 +01:00
|
|
|
|
|
|
|
|
|
/**
|
2016-02-19 13:38:38 +01:00
|
|
|
|
* Stores the event data in the database.
|
|
|
|
|
*
|
|
|
|
|
* Must be overriden by plugin.
|
2016-02-10 11:49:20 +01:00
|
|
|
|
*/
|
2016-02-19 13:38:38 +01:00
|
|
|
|
abstract protected function save();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Add current event data to statistics counter.
|
|
|
|
|
*
|
|
|
|
|
* Must be overriden by plugin.
|
|
|
|
|
*/
|
|
|
|
|
abstract protected function saveStats();
|
2016-02-02 17:03:53 +01:00
|
|
|
|
}
|