File: //home/posscale/subdomains/xibo/lib/Controller/Maintenance.php
<?php
/*
* Spring Signage Ltd - http://www.springsignage.com
* Copyright (C) 2015 Spring Signage Ltd
* (Maintenance.php)
*/
namespace Xibo\Controller;
use Xibo\Entity\Task;
use Xibo\Exception\AccessDeniedException;
use Xibo\Exception\ConfigurationException;
use Xibo\Exception\ControllerNotImplemented;
use Xibo\Factory\DisplayFactory;
use Xibo\Factory\DisplayGroupFactory;
use Xibo\Factory\LayoutFactory;
use Xibo\Factory\MediaFactory;
use Xibo\Factory\ScheduleFactory;
use Xibo\Factory\TaskFactory;
use Xibo\Factory\WidgetFactory;
use Xibo\Service\ConfigServiceInterface;
use Xibo\Service\DateServiceInterface;
use Xibo\Service\LogServiceInterface;
use Xibo\Service\SanitizerServiceInterface;
use Xibo\Storage\StorageServiceInterface;
/**
* Class Maintenance
* @package Xibo\Controller
*/
class Maintenance extends Base
{
/** @var TaskFactory */
private $taskFactory;
/** @var StorageServiceInterface */
private $store;
/** @var MediaFactory */
private $mediaFactory;
/** @var LayoutFactory */
private $layoutFactory;
/** @var WidgetFactory */
private $widgetFactory;
/** @var DisplayGroupFactory */
private $displayGroupFactory;
/** @var DisplayFactory */
private $displayFactory;
/** @var ScheduleFactory */
private $scheduleFactory;
/**
* Set common dependencies.
* @param LogServiceInterface $log
* @param SanitizerServiceInterface $sanitizerService
* @param \Xibo\Helper\ApplicationState $state
* @param \Xibo\Entity\User $user
* @param \Xibo\Service\HelpServiceInterface $help
* @param DateServiceInterface $date
* @param ConfigServiceInterface $config
* @param StorageServiceInterface $store
* @param TaskFactory $taskFactory
* @param MediaFactory $mediaFactory
* @param LayoutFactory $layoutFactory
* @param WidgetFactory $widgetFactory
* @param DisplayGroupFactory $displayGroupFactory
* @param DisplayFactory $displayFactory
* @param ScheduleFactory $scheduleFactory
*/
public function __construct($log, $sanitizerService, $state, $user, $help, $date, $config, $store, $taskFactory, $mediaFactory, $layoutFactory, $widgetFactory, $displayGroupFactory, $displayFactory, $scheduleFactory)
{
$this->setCommonDependencies($log, $sanitizerService, $state, $user, $help, $date, $config);
$this->taskFactory = $taskFactory;
$this->store = $store;
$this->mediaFactory = $mediaFactory;
$this->layoutFactory = $layoutFactory;
$this->widgetFactory = $widgetFactory;
$this->displayGroupFactory = $displayGroupFactory;
$this->displayFactory = $displayFactory;
$this->scheduleFactory = $scheduleFactory;
}
/**
* Run Maintenance through the WEB portal
*/
public function run()
{
// Output HTML Headers
print '<html>';
print ' <head>';
print ' <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />';
print ' <title>Maintenance</title>';
print ' </head>';
print '<body>';
// Should the Scheduled Task script be running at all?
if ($this->getConfig()->GetSetting("MAINTENANCE_ENABLED")=="Off") {
print "<h1>" . __("Maintenance Disabled") . "</h1>";
print __("Maintenance tasks are disabled at the moment. Please enable them in the "Settings" dialog.");
} else {
$quick = ($this->getSanitizer()->getCheckbox('quick') == 1);
// Set defaults that don't match on purpose!
$key = 1;
$aKey = 2;
$pKey = 3;
if ($this->getConfig()->GetSetting("MAINTENANCE_ENABLED")=="Protected") {
// Check that the magic parameter is set
$key = $this->getConfig()->GetSetting("MAINTENANCE_KEY");
// Get key from arguments
$pKey = $this->getSanitizer()->getString('key');
}
if (($aKey == $key) || ($pKey == $key) || ($this->getConfig()->GetSetting("MAINTENANCE_ENABLED")=="On")) {
// Are we full maintenance?
if (!$quick) {
$this->runTask('MaintenanceDailyTask');
}
// Always run quick tasks
$this->runTask('MaintenanceRegularTask');
$this->runTask('EmailNotificationsTask');
}
else {
print __("Maintenance key invalid.");
}
}
// Output HTML Footers
print "\n </body>\n";
print "</html>";
$this->getLog()->debug('Maintenance Complete');
// No output
$this->setNoOutput(true);
}
/**
* Run task
* @param $class
*/
private function runTask($class)
{
/** @var \Xibo\Controller\Task $taskController */
$taskController = $this->getApp()->container->get('\Xibo\Controller\Task');
$taskController->setApp($this->getApp());
$task = $this->taskFactory->getByClass('\Xibo\XTR\\' . $class);
// Check we aren't already running
if ($task->status == Task::$STATUS_RUNNING) {
echo __('Task already running');
} else {
// Hand off to the task controller
$taskController->run($task->taskId);
// Echo the task output
$task = $this->taskFactory->getById($task->taskId);
echo \Parsedown::instance()->text($task->lastRunMessage);
}
}
/**
* Tidy Library Form
*/
public function tidyLibraryForm()
{
$this->getState()->template = 'maintenance-form-tidy';
$this->getState()->setData([
'help' => $this->getHelp()->link('Settings', 'TidyLibrary')
]);
}
/**
* Tidies up the library
*/
public function tidyLibrary()
{
$tidyOldRevisions = $this->getSanitizer()->getCheckbox('tidyOldRevisions');
$cleanUnusedFiles = $this->getSanitizer()->getCheckbox('cleanUnusedFiles');
$tidyGenericFiles = $this->getSanitizer()->getCheckbox('tidyGenericFiles');
if ($this->getConfig()->GetSetting('SETTING_LIBRARY_TIDY_ENABLED') != 1)
throw new AccessDeniedException(__('Sorry this function is disabled.'));
// Also run a script to tidy up orphaned media in the library
$library = $this->getConfig()->GetSetting('LIBRARY_LOCATION');
$this->getLog()->debug('Library Location: ' . $library);
// Remove temporary files
$this->getApp()->container->get('\Xibo\Controller\Library')->removeTempFiles();
$media = array();
$unusedMedia = array();
$unusedRevisions = array();
// DataSets with library images
$dataSetSql = '
SELECT dataset.dataSetId, datasetcolumn.heading
FROM dataset
INNER JOIN datasetcolumn
ON datasetcolumn.DataSetID = dataset.DataSetID
WHERE DataTypeID = 5;
';
$dataSets = $this->store->select($dataSetSql, []);
// Run a query to get an array containing all of the media in the library
// this must contain ALL media, so that we can delete files in the storage that aren;t in the table
$sql = '
SELECT media.mediaid, media.storedAs, media.type, media.isedited,
SUM(CASE WHEN IFNULL(lkwidgetmedia.widgetId, 0) = 0 THEN 0 ELSE 1 END) AS UsedInLayoutCount,
SUM(CASE WHEN IFNULL(lkmediadisplaygroup.mediaId, 0) = 0 THEN 0 ELSE 1 END) AS UsedInDisplayCount,
SUM(CASE WHEN IFNULL(layout.layoutId, 0) = 0 THEN 0 ELSE 1 END) AS UsedInBackgroundImageCount
';
if (count($dataSets) > 0) {
$sql .= ' , SUM(CASE WHEN IFNULL(dataSetImages.mediaId, 0) = 0 THEN 0 ELSE 1 END) AS UsedInDataSetCount ';
} else {
$sql .= ' , 0 AS UsedInDataSetCount ';
}
$sql .= '
FROM `media`
LEFT OUTER JOIN `lkwidgetmedia`
ON lkwidgetmedia.mediaid = media.mediaid
LEFT OUTER JOIN `lkmediadisplaygroup`
ON lkmediadisplaygroup.mediaid = media.mediaid
LEFT OUTER JOIN `layout`
ON `layout`.backgroundImageId = `media`.mediaId
';
if (count($dataSets) > 0) {
$sql .= ' LEFT OUTER JOIN (';
$first = true;
foreach ($dataSets as $dataSet) {
if (!$first)
$sql .= ' UNION ALL ';
$first = false;
$dataSetId = $this->getSanitizer()->getInt('dataSetId', $dataSet);
$heading = $this->getSanitizer()->getString('heading', $dataSet);
$sql .= ' SELECT ' . $heading . ' AS mediaId FROM `dataset_' . $dataSetId . '`';
}
$sql .= ') dataSetImages
ON dataSetImages.mediaId = `media`.mediaId
';
}
$sql .= '
GROUP BY media.mediaid, media.storedAs, media.type, media.isedited
';
foreach ($this->store->select($sql, []) as $row) {
$media[$row['storedAs']] = $row;
$type = $this->getSanitizer()->getString('type', $row);
// Ignore any module files or fonts
if ($type == 'module' || $type == 'font' || ($type == 'genericfile' && $tidyGenericFiles != 1))
continue;
// Collect media revisions that aren't used
if ($tidyOldRevisions && $row['UsedInLayoutCount'] <= 0 && $row['UsedInDisplayCount'] <= 0 && $row['UsedInBackgroundImageCount'] <= 0 && $row['UsedInDataSetCount'] <= 0 && $row['isedited'] > 0) {
$unusedRevisions[$row['storedAs']] = $row;
}
// Collect any files that aren't used
else if ($cleanUnusedFiles && $row['UsedInLayoutCount'] <= 0 && $row['UsedInDisplayCount'] <= 0 && $row['UsedInBackgroundImageCount'] <= 0 && $row['UsedInDataSetCount'] <= 0) {
$unusedMedia[$row['storedAs']] = $row;
}
}
$i = 0;
// Library location
$libraryLocation = $this->getConfig()->GetSetting("LIBRARY_LOCATION");
// Get a list of all media files
foreach(scandir($library) as $file) {
if ($file == '.' || $file == '..')
continue;
if (is_dir($library . $file))
continue;
// Ignore thumbnails
if (strstr($file, 'tn_'))
continue;
// Ignore XLF files
if (strstr($file, '.xlf'))
continue;
$i++;
// Is this file in the system anywhere?
if (!array_key_exists($file, $media)) {
// Totally missing
$this->getLog()->debug('Deleting file: ' . $file);
// If not, delete it
unlink($libraryLocation . $file);
}
else if (array_key_exists($file, $unusedRevisions)) {
// It exists but isn't being used any more
$this->getLog()->debug('Deleting unused revision media: ' . $media[$file]['mediaid']);
$this->mediaFactory->getById($media[$file]['mediaid'])
->setChildObjectDependencies($this->layoutFactory, $this->widgetFactory, $this->displayGroupFactory, $this->displayFactory, $this->scheduleFactory)
->delete();
}
else if (array_key_exists($file, $unusedMedia)) {
// It exists but isn't being used any more
$this->getLog()->debug('Deleting unused media: ' . $media[$file]['mediaid']);
$this->mediaFactory->getById($media[$file]['mediaid'])
->setChildObjectDependencies($this->layoutFactory, $this->widgetFactory, $this->displayGroupFactory, $this->displayFactory, $this->scheduleFactory)
->delete();
}
else {
$i--;
}
}
// Return
$this->getState()->hydrate([
'message' => __('Library Tidy Complete'),
'data' => [
'tidied' => $i
]
]);
}
/**
* Export Form
*/
public function exportForm()
{
if ($this->getUser()->userTypeId != 1)
throw new AccessDeniedException();
$this->getState()->template = 'maintenance-form-export';
}
/**
* Backup the Database
*/
public function export()
{
// Check we can run mysql
if (!function_exists('exec'))
throw new ControllerNotImplemented(__('Exec is not available.'));
// Global database variables to seed into exec
global $dbhost;
global $dbuser;
global $dbpass;
global $dbname;
// get temporary file
$libraryLocation = $this->getConfig()->GetSetting('LIBRARY_LOCATION') . 'temp/';
$fileNameStructure = $libraryLocation . 'structure.dump';
$fileNameData = $libraryLocation . 'data.dump';
$zipFile = $libraryLocation . 'database.tar.gz';
// Run mysqldump structure to a temporary file
$command = 'mysqldump --opt --host=' . $dbhost . ' --user=' . $dbuser . ' --password=' . addslashes($dbpass) . ' ' . $dbname . ' --no-data > ' . escapeshellarg($fileNameStructure) . ' ';
exec($command);
// Run mysqldump data to a temporary file
$command = 'mysqldump --opt --host=' . $dbhost . ' --user=' . $dbuser . ' --password=' . addslashes($dbpass) . ' ' . $dbname . ' --ignore-table=' . $dbname . '.log --ignore-table=' . $dbname . '.oauth_log > ' . escapeshellarg($fileNameData) . ' ';
exec($command);
// Check it worked
if (!file_exists($fileNameStructure) || !file_exists($fileNameData))
throw new ConfigurationException(__('Database dump failed.'));
// Zippy
$this->getLog()->debug($zipFile);
$zip = new \ZipArchive();
$zip->open($zipFile, \ZipArchive::OVERWRITE);
$zip->addFile($fileNameStructure, 'structure.dump');
$zip->addFile($fileNameData, 'data.dump');
$zip->close();
// Remove the dump file
unlink($fileNameStructure);
unlink($fileNameData);
// Uncomment only if you are having permission issues
// chmod($zipFile, 0777);
// Push file back to browser
if (ini_get('zlib.output_compression')) {
ini_set('zlib.output_compression', 'Off');
}
$size = filesize($zipFile);
header('Content-Type: application/octet-stream');
header("Content-Transfer-Encoding: Binary");
header("Content-disposition: attachment; filename=\"" . basename($zipFile) . "\"");
header('Content-Length: ' . $size);
// Send via Apache X-Sendfile header?
if ($this->getConfig()->GetSetting('SENDFILE_MODE') == 'Apache') {
header("X-Sendfile: $zipFile");
$this->getApp()->halt(200);
}
// Send via Nginx X-Accel-Redirect?
if ($this->getConfig()->GetSetting('SENDFILE_MODE') == 'Nginx') {
header("X-Accel-Redirect: /download/temp/" . basename($zipFile));
$this->getApp()->halt(200);
}
// Return the file with PHP
readfile($zipFile);
$this->setNoOutput(true);
}
}