| Current File : /home/kelaby89/abl.academy/wp-content/plugins/h5p/admin/class-h5p-library-admin.php |
<?php
/**
* H5P Plugin.
*
* @package H5P
* @author Joubel <[email protected]>
* @license MIT
* @link http://joubel.com
* @copyright 2014 Joubel
*/
/**
* H5P Library Admin class
*
* @package H5P_Plugin_Admin
* @author Joubel <[email protected]>
*/
class H5PLibraryAdmin {
/**
* @since 1.1.0
*/
private $plugin_slug = NULL;
/**
* Keep track of the current library.
*
* @since 1.1.0
*/
private $library = NULL;
/**
* Initialize library admin
*
* @since 1.1.0
* @param string $plugin_slug
*/
public function __construct($plugin_slug) {
$this->plugin_slug = $plugin_slug;
}
/**
* Load content and alter page title for certain pages.
*
* @since 1.1.0
* @param string $page
* @param string $admin_title
* @param string $title
* @return string
*/
public function alter_title($page, $admin_title, $title) {
$task = filter_input(INPUT_GET, 'task', FILTER_SANITIZE_STRING);
// Find library title
$show = ($task === 'show');
$delete = ($task === 'delete');
$upgrade = ($task === 'upgrade');
if ($show || $delete || $upgrade) {
$library = $this->get_library();
if ($library) {
if ($delete) {
$admin_title = str_replace($title, __('Delete', $this->plugin_slug), $admin_title);
}
else if ($upgrade) {
$admin_title = str_replace($title, __('Content Upgrade', $this->plugin_slug), $admin_title);
$plugin = H5P_Plugin::get_instance();
$plugin->get_h5p_instance('core'); // Load core
}
$admin_title = esc_html($library->title) . ($upgrade ? ' (' . H5PCore::libraryVersion($library) . ')' : '') . ' ‹ ' . $admin_title;
}
}
return $admin_title;
}
/**
* Load library
*
* @since 1.1.0
* @param int $id optional
*/
private function get_library($id = NULL) {
global $wpdb;
if ($this->library !== NULL) {
return $this->library; // Return the current loaded library.
}
if ($id === NULL) {
$id = filter_input(INPUT_GET, 'id', FILTER_SANITIZE_NUMBER_INT);
}
// Try to find content with $id.
$this->library = $wpdb->get_row($wpdb->prepare(
"SELECT id, title, name, major_version, minor_version, patch_version, runnable, fullscreen
FROM {$wpdb->prefix}h5p_libraries
WHERE id = %d",
$id
)
);
if (!$this->library) {
H5P_Plugin_Admin::set_error(sprintf(__('Cannot find library with id: %d.', $this->plugin_slug), $id));
}
return $this->library;
}
/**
* Display admin interface for managing content libraries.
*
* @since 1.1.0
*/
public function display_libraries_page() {
switch (filter_input(INPUT_GET, 'task', FILTER_SANITIZE_STRING)) {
case NULL:
$this->display_libraries();
return;
case 'show':
$this->display_library_details();
return;
case 'delete':
$library = $this->get_library();
H5P_Plugin_Admin::print_messages();
if ($library) {
include_once('views/library-delete.php');
}
return;
case 'upgrade':
$library = $this->get_library();
if ($library) {
$settings = $this->display_content_upgrades($library);
}
include_once('views/library-content-upgrade.php');
if (isset($settings)) {
$plugin = H5P_Plugin::get_instance();
$plugin->print_settings($settings, 'H5PAdminIntegration');
}
return;
}
print '<div class="wrap"><h2>' . esc_html__('Unknown task.', $this->plugin_slug) . '</h2></div>';
}
/**
* Display a list of all h5p content libraries.
*
* @since 1.1.0
*/
private function display_libraries() {
$plugin = H5P_Plugin::get_instance();
$core = $plugin->get_h5p_instance('core');
$interface = $plugin->get_h5p_instance('interface');
$not_cached = $interface->getNumNotFiltered();
$libraries = $interface->loadLibraries();
$settings = array(
'containerSelector' => '#h5p-admin-container',
'extraTableClasses' => 'wp-list-table widefat fixed',
'l10n' => array(
'NA' => __('N/A', $this->plugin_slug),
'viewLibrary' => __('View library details', $this->plugin_slug),
'deleteLibrary' => __('Delete library', $this->plugin_slug),
'upgradeLibrary' => __('Upgrade library content', $this->plugin_slug)
)
);
// Add settings for each library
$i = 0;
foreach ($libraries as $versions) {
foreach ($versions as $library) {
$usage = $interface->getLibraryUsage($library->id, $not_cached ? TRUE : FALSE);
if ($library->runnable) {
$upgrades = $core->getUpgrades($library, $versions);
$upgradeUrl = empty($upgrades) ? FALSE : admin_url('admin.php?page=h5p_libraries&task=upgrade&id=' . $library->id . '&destination=' . admin_url('admin.php?page=h5p_libraries'));
$restricted = ($library->restricted ? TRUE : FALSE);
$restricted_url = admin_url('admin-ajax.php?action=h5p_restrict_library' .
'&id=' . $library->id .
'&token=' . wp_create_nonce('h5p_library_' . $i) .
'&token_id=' . $i .
'&restrict=' . ($library->restricted === '1' ? 0 : 1));
}
else {
$upgradeUrl = NULL;
$restricted = NULL;
$restricted_url = NULL;
}
$contents_count = $interface->getNumContent($library->id);
$settings['libraryList']['listData'][] = array(
'title' => $library->title . ' (' . H5PCore::libraryVersion($library) . ')',
'restricted' => $restricted,
'restrictedUrl' => $restricted_url,
'numContent' => $contents_count === 0 ? '' : $contents_count,
'numContentDependencies' => $usage['content'] < 1 ? '' : $usage['content'],
'numLibraryDependencies' => $usage['libraries'] === 0 ? '' : $usage['libraries'],
'upgradeUrl' => $upgradeUrl,
'detailsUrl' => admin_url('admin.php?page=h5p_libraries&task=show&id=' . $library->id),
'deleteUrl' => admin_url('admin.php?page=h5p_libraries&task=delete&id=' . $library->id)
);
$i++;
}
}
// Translations
$settings['libraryList']['listHeaders'] = array(
__('Title', $this->plugin_slug),
__('Restricted', $this->plugin_slug),
array(
'text' => __('Contents', $this->plugin_slug),
'class' => 'h5p-admin-center'
),
array(
'text' => __('Contents using it', $this->plugin_slug),
'class' => 'h5p-admin-center'
),
array(
'text' => __('Libraries using it', $this->plugin_slug),
'class' => 'h5p-admin-center'
),
__('Actions', $this->plugin_slug)
);
// Make it possible to rebuild all caches.
if ($not_cached) {
$settings['libraryList']['notCached'] = $this->get_not_cached_settings($not_cached);
}
// Assets
$this->add_admin_assets();
H5P_Plugin_Admin::add_script('library-list', 'h5p-php-library/js/h5p-library-list.js');
// Load content type cache time
$last_update = get_site_option('h5p_content_type_cache_updated_at', '');
$hubOn = get_option('h5p_hub_is_enabled', TRUE);
include_once('views/libraries.php');
$plugin->print_settings($settings, 'H5PAdminIntegration');
}
/**
* Handles upload of H5P libraries.
*
* @since 1.1.0
*/
public function process_libraries() {
$post = ($_SERVER['REQUEST_METHOD'] === 'POST');
$task = filter_input(INPUT_GET, 'task');
if ($post) {
// A form as has been submitted
if (isset($_FILES['h5p_file'])) {
// If file upload, we're uploading libraries
if ($_FILES['h5p_file']['error'] == UPLOAD_ERR_OK) {
// No upload errors, try to install package
check_admin_referer('h5p_library', 'lets_upgrade_that'); // Verify form
$plugin_admin = H5P_Plugin_Admin::get_instance();
$plugin_admin->handle_upload(NULL, filter_input(INPUT_POST, 'h5p_upgrade_only') ? TRUE : FALSE);
}
else {
$phpFileUploadErrors = array(
UPLOAD_ERR_INI_SIZE => 'The uploaded file exceeds the upload_max_filesize directive in php.ini',
UPLOAD_ERR_FORM_SIZE => 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form',
UPLOAD_ERR_PARTIAL => 'The uploaded file was only partially uploaded',
UPLOAD_ERR_NO_FILE => 'No file was uploaded',
UPLOAD_ERR_NO_TMP_DIR => 'Missing a temporary folder',
UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk.',
UPLOAD_ERR_EXTENSION => 'A PHP extension stopped the file upload.',
);
$errorMessage = $phpFileUploadErrors[$_FILES['h5p_file']['error']];
H5P_Plugin_Admin::set_error(__($errorMessage, $this->plugin_slug));
}
return;
}
elseif (filter_input(INPUT_POST, 'sync_hub')) {
check_admin_referer('h5p_sync', 'sync_hub'); // Verify form
// Update content type cache
$plugin = H5P_Plugin::get_instance();
$core = $plugin->get_h5p_instance('core');
$core->updateContentTypeCache();
}
}
if ($task === 'delete') {
$library = $this->get_library();
if (!$library) {
return;
}
$plugin = H5P_Plugin::get_instance();
$interface = $plugin->get_h5p_instance('interface');
// Check if this library can be deleted
$usage = $interface->getLibraryUsage($library->id, $interface->getNumNotFiltered() ? TRUE : FALSE);
if ($usage['content'] !== 0 || $usage['libraries'] !== 0) {
H5P_Plugin_Admin::set_error(__('This Library is used by content or other libraries and can therefore not be deleted.', $this->plugin_slug));
return; // Nope
}
if ($post) {
check_admin_referer('h5p_library', 'lets_delete_this'); // Verify delete form
$interface->deleteLibrary($this->library);
wp_safe_redirect(admin_url('admin.php?page=h5p_libraries'));
}
}
}
/**
* Display details for a given content library.
*
* @since 1.1.0
*/
private function display_library_details() {
global $wpdb;
$library = $this->get_library();
H5P_Plugin_Admin::print_messages();
if (!$library) {
return;
}
// Add settings and translations
$plugin = H5P_Plugin::get_instance();
$interface = $plugin->get_h5p_instance('interface');
$settings = array(
'containerSelector' => '#h5p-admin-container',
);
// Build the translations needed
$settings['libraryInfo']['translations'] = array(
'noContent' => __('No content is using this library', $this->plugin_slug),
'contentHeader' => __('Content using this library', $this->plugin_slug),
'pageSizeSelectorLabel' => __('Elements per page', $this->plugin_slug),
'filterPlaceholder' => __('Filter content', $this->plugin_slug),
'pageXOfY' => __('Page $x of $y', $this->plugin_slug),
);
$notCached = $interface->getNumNotFiltered();
if ($notCached) {
$settings['libraryInfo']['notCached'] = $this->get_not_cached_settings($notCached);
}
else {
// List content which uses this library
$contents = $wpdb->get_results($wpdb->prepare(
"SELECT DISTINCT hc.id, hc.title
FROM {$wpdb->prefix}h5p_contents_libraries hcl
JOIN {$wpdb->prefix}h5p_contents hc ON hcl.content_id = hc.id
WHERE hcl.library_id = %d
ORDER BY hc.title",
$library->id
)
);
foreach($contents as $content) {
$settings['libraryInfo']['content'][] = array(
'title' => $content->title,
'url' => admin_url('admin.php?page=h5p&task=show&id=' . $content->id),
);
}
}
// Build library info
$settings['libraryInfo']['info'] = array(
__('Version', $this->plugin_slug) => H5PCore::libraryVersion($library),
__('Fullscreen', $this->plugin_slug) => $library->fullscreen ? __('Yes', $this->plugin_slug) : __('No', $this->plugin_slug),
__('Content library', $this->plugin_slug) => $library->runnable ? __('Yes', $this->plugin_slug) : __('No', $this->plugin_slug),
__('Used by', $this->plugin_slug) => (isset($contents) ? sprintf(_n('1 content', '%d contents', count($contents), $this->plugin_slug), count($contents)) : __('N/A', $this->plugin_slug)),
);
$this->add_admin_assets();
H5P_Plugin_Admin::add_script('library-list', 'h5p-php-library/js/h5p-library-details.js');
include_once('views/library-details.php');
$plugin->print_settings($settings, 'H5PAdminIntegration');
}
/**
* Display a list of all h5p content libraries.
*
* @since 1.1.0
*/
private function display_content_upgrades($library) {
global $wpdb;
$plugin = H5P_Plugin::get_instance();
$core = $plugin->get_h5p_instance('core');
$interface = $plugin->get_h5p_instance('interface');
$versions = $wpdb->get_results($wpdb->prepare(
"SELECT hl2.id, hl2.name, hl2.title, hl2.major_version, hl2.minor_version, hl2.patch_version
FROM {$wpdb->prefix}h5p_libraries hl1
JOIN {$wpdb->prefix}h5p_libraries hl2
ON hl2.name = hl1.name
WHERE hl1.id = %d
ORDER BY hl2.title ASC, hl2.major_version ASC, hl2.minor_version ASC",
$library->id
));
foreach ($versions as $version) {
if ($version->id === $library->id) {
$upgrades = $core->getUpgrades($version, $versions);
break;
}
}
if (count($versions) < 2) {
H5P_Plugin_Admin::set_error(__('There are no available upgrades for this library.', $this->plugin_slug));
return NULL;
}
// Get num of contents that can be upgraded
$contents = $interface->getNumContent($library->id);
if (!$contents) {
H5P_Plugin_Admin::set_error(__("There's no content instances to upgrade.", $this->plugin_slug));
return NULL;
}
$contents_plural = sprintf(_n('1 content', '%d contents', $contents, $this->plugin_slug), $contents);
// Add JavaScript settings
$return = filter_input(INPUT_GET, 'destination');
$settings = array(
'containerSelector' => '#h5p-admin-container',
'libraryInfo' => array(
'message' => sprintf(__('You are about to upgrade %s. Please select upgrade version.', $this->plugin_slug), $contents_plural),
'inProgress' => __('Upgrading to %ver...', $this->plugin_slug),
'error' => __('An error occurred while processing parameters:', $this->plugin_slug),
'errorData' => __('Could not load data for library %lib.', $this->plugin_slug),
'errorContent' => __('Could not upgrade content %id:', $this->plugin_slug),
'errorScript' => __('Could not load upgrades script for %lib.', $this->plugin_slug),
'errorParamsBroken' => __('Parameters are broken.', $this->plugin_slug),
'errorLibrary' => __('Missing required library %lib.', $this->plugin_slug),
'errorTooHighVersion' => __('Parameters contain %used while only %supported or earlier are supported.', $this->plugin_slug),
'errorNotSupported' => __('Parameters contain %used which is not supported.', $this->plugin_slug),
'done' => sprintf(__('You have successfully upgraded %s.', $this->plugin_slug), $contents_plural) . ($return ? '<br/><a href="' . $return . '">' . __('Return', $this->plugin_slug) . '</a>' : ''),
'library' => array(
'name' => $library->name,
'version' => $library->major_version . '.' . $library->minor_version,
),
'libraryBaseUrl' => admin_url('admin-ajax.php?action=h5p_content_upgrade_library&library='),
'scriptBaseUrl' => plugins_url('h5p/h5p-php-library/js'),
'buster' => '?ver=' . H5P_Plugin::VERSION,
'versions' => $upgrades,
'contents' => $contents,
'buttonLabel' => __('Upgrade', $this->plugin_slug),
'infoUrl' => admin_url('admin-ajax.php?action=h5p_content_upgrade_progress&id=' . $library->id),
'total' => $contents,
'token' => wp_create_nonce('h5p_content_upgrade')
)
);
$this->add_admin_assets();
H5P_Plugin_Admin::add_script('version', 'h5p-php-library/js/h5p-version.js');
H5P_Plugin_Admin::add_script('content-upgrade', 'h5p-php-library/js/h5p-content-upgrade.js');
return $settings;
}
/**
* Helps rebuild all content caches.
*
* @since 1.1.0
*/
public function ajax_rebuild_cache() {
global $wpdb;
if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
exit; // POST is required
}
$plugin = H5P_Plugin::get_instance();
$core = $plugin->get_h5p_instance('core');
// Do as many as we can in five seconds.
$start = microtime(TRUE);
$contents = $wpdb->get_results(
"SELECT id
FROM {$wpdb->prefix}h5p_contents
WHERE filtered = ''"
);
$done = 0;
foreach($contents as $content) {
$content = $core->loadContent($content->id);
$core->filterParameters($content);
$done++;
if ((microtime(TRUE) - $start) > 5) {
break;
}
}
print (count($contents) - $done);
exit;
}
/**
* Add generic admin interface assets.
*
* @since 1.1.0
*/
private function add_admin_assets() {
foreach (H5PCore::$adminScripts as $script) {
H5P_Plugin_Admin::add_script('admin-' . $script, 'h5p-php-library/' . $script);
}
H5P_Plugin_Admin::add_style('h5p', 'h5p-php-library/styles/h5p.css');
H5P_Plugin_Admin::add_style('admin', 'h5p-php-library/styles/h5p-admin.css');
}
/**
* JavaScript settings needed to rebuild content caches.
*
* @since 1.1.0
*/
private function get_not_cached_settings($num) {
return array(
'num' => $num,
'url' => admin_url('admin-ajax.php?action=h5p_rebuild_cache'),
'message' => __('Not all content has gotten their cache rebuilt. This is required to be able to delete libraries, and to display how many contents that uses the library.', $this->plugin_slug),
'progress' => sprintf(_n('1 content need to get its cache rebuilt.', '%d contents needs to get their cache rebuilt.', $num, $this->plugin_slug), $num),
'button' => __('Rebuild cache', $this->plugin_slug)
);
}
/**
* AJAX processing for content upgrade script.
*/
public function ajax_upgrade_progress() {
global $wpdb;
header('Cache-Control: no-cache');
if (!wp_verify_nonce(filter_input(INPUT_POST, 'token'), 'h5p_content_upgrade')) {
print __('Error, invalid security token!', $this->plugin_slug);
exit;
}
$library_id = filter_input(INPUT_GET, 'id');
if (!$library_id) {
print __('Error, missing library!', $this->plugin_slug);
exit;
}
// Get the library we're upgrading to
$to_library = $wpdb->get_row($wpdb->prepare(
"SELECT id, name, major_version, minor_version
FROM {$wpdb->prefix}h5p_libraries
WHERE id = %d",
filter_input(INPUT_POST, 'libraryId')
));
if (!$to_library) {
print __('Error, invalid library!', $this->plugin_slug);
exit;
}
// Prepare response
$out = new stdClass();
$out->params = array();
$out->token = wp_create_nonce('h5p_content_upgrade');
// Get updated params
$params = filter_input(INPUT_POST, 'params');
if ($params !== NULL) {
// Update params.
$params = json_decode($params);
foreach ($params as $id => $param) {
$upgraded = json_decode($param);
$metadata = isset($upgraded->metadata) ? $upgraded->metadata : array();
$format = array();
$fields = array_merge(\H5PMetadata::toDBArray($metadata, false, false, $format), array(
'updated_at' => current_time('mysql', 1),
'parameters' => json_encode($upgraded->params),
'library_id' => $to_library->id,
'filtered' => ''
));
$format[] = '%s'; // updated_at
$format[] = '%s'; // parameters
$format[] = '%d'; // library_id
$format[] = '%s'; // filtered
$wpdb->update(
$wpdb->prefix . 'h5p_contents',
$fields,
array('id' => $id),
$format,
array('%d')
);
// Log content upgrade successful
new H5P_Event('content', 'upgrade',
$id, $wpdb->get_var($wpdb->prepare("SELECT title FROM {$wpdb->prefix}h5p_contents WHERE id = %d", $id)),
$to_library->name, $to_library->major_version . '.' . $to_library->minor_version);
}
}
// Determine if any content has been skipped during the process
$skipped = filter_input(INPUT_POST, 'skipped');
if ($skipped !== NULL) {
$out->skipped = json_decode($skipped);
// Clean up input, only numbers
foreach ($out->skipped as $i => $id) {
$out->skipped[$i] = intval($id);
}
$skipped = implode(',', $out->skipped);
}
else {
$out->skipped = array();
}
// Prepare our interface
$plugin = H5P_Plugin::get_instance();
$interface = $plugin->get_h5p_instance('interface');
// Get number of contents for this library
$out->left = $interface->getNumContent($library_id, $skipped);
if ($out->left) {
$skip_query = empty($skipped) ? '' : " AND id NOT IN ($skipped)";
// Find the 40 first contents using library and add to params
$contents = $wpdb->get_results($wpdb->prepare(
"SELECT id, parameters AS params, title, authors, source, license,
license_version, license_extras, year_from, year_to, changes,
author_comments, default_language, a11y_title
FROM {$wpdb->prefix}h5p_contents
WHERE library_id = %d
{$skip_query}
LIMIT 40",
$library_id
));
foreach ($contents as $content) {
$out->params[$content->id] =
'{"params":' . $content->params .
',"metadata":' . \H5PMetadata::toJSON($content) . '}';
}
}
header('Content-type: application/json');
print json_encode($out);
exit;
}
/**
* AJAX loading of libraries for content upgrade script.
*
* @since 1.1.0
* @param string $name
* @param int $major
* @param int $minor
*/
public function ajax_upgrade_library() {
header('Cache-Control: no-cache');
$library_string = filter_input(INPUT_GET, 'library');
if (!$library_string) {
print __('Error, missing library!', $this->plugin_slug);
exit;
}
$library_parts = explode('/', $library_string);
if (count($library_parts) !== 4) {
print __('Error, invalid library!', $this->plugin_slug);
exit;
}
$library = (object) array(
'name' => $library_parts[1],
'version' => (object) array(
'major' => $library_parts[2],
'minor' => $library_parts[3]
)
);
$plugin = H5P_Plugin::get_instance();
$core = $plugin->get_h5p_instance('core');
$library->semantics = $core->loadLibrarySemantics($library->name, $library->version->major, $library->version->minor);
// TODO: Library development mode
// if ($core->development_mode & H5PDevelopment::MODE_LIBRARY) {
// $dev_lib = $core->h5pD->getLibrary($library->name, $library->version->major, $library->version->minor);
// }
if (isset($dev_lib)) {
$upgrades_script_path = $upgrades_script_url = $dev_lib['path'] . '/upgrades.js';
}
else {
$suffix = '/libraries/' . $library->name . '-' . $library->version->major . '.' . $library->version->minor . '/upgrades.js';
$upgrades_script_path = $plugin->get_h5p_path() . $suffix;
$upgrades_script_url = $plugin->get_h5p_url() . $suffix;
}
if (file_exists($upgrades_script_path)) {
$library->upgradesScript = $upgrades_script_url;
}
header('Content-type: application/json');
print json_encode($library);
exit;
}
/**
* Handle ajax request to restrict access to the given library.
*
* @since 1.2.0
*/
public function ajax_restrict_access() {
global $wpdb;
$library_id = filter_input(INPUT_GET, 'id');
$restricted = filter_input(INPUT_GET, 'restrict');
$restrict = ($restricted === '1');
$token_id = filter_input(INPUT_GET, 'token_id');
if (!wp_verify_nonce(filter_input(INPUT_GET, 'token'), 'h5p_library_' . $token_id) || (!$restrict && $restricted !== '0')) {
return;
}
$wpdb->update(
$wpdb->prefix . 'h5p_libraries',
array('restricted' => $restricted),
array('id' => $library_id),
array('%d'),
array('%d')
);
header('Content-type: application/json');
print json_encode(array(
'url' => admin_url('admin-ajax.php?action=h5p_restrict_library' .
'&id=' . $library_id .
'&token=' . wp_create_nonce('h5p_library_' . $token_id) .
'&token_id=' . $token_id .
'&restrict=' . ($restrict ? 0 : 1)),
));
exit;
}
}