Current Directory: /home/astoriaah/www/old15/administrator/components/com_akeeba/models
Viewing File: /home/astoriaah/www/old15/administrator/components/com_akeeba/models/backups.php
<?php
/**
* @package AkeebaBackup
* @copyright Copyright (c)2009-2014 Nicholas K. Dionysopoulos
* @license GNU General Public License version 3, or later
* @since 3.2.5
*/
// Protect from unauthorized access
defined('_JEXEC') or die();
use Akeeba\Engine\Factory;
use Akeeba\Engine\Platform;
/**
* The back-end backup model
*/
class AkeebaModelBackups extends F0FModel
{
/**
* Starts or step a backup process
*
* @return array An Akeeba Engine return array
*/
public function runBackup()
{
$ret_array = array();
$ajaxTask = $this->getState('ajax');
$tag = $this->getState('tag');
$backupId = $this->getState('backupid');
switch ($ajaxTask)
{
case 'start':
// Description is passed through a strict filter which removes HTML
$description = $this->getState('description');
// The comment is passed through the Safe HTML filter (note: use 2 to force no filtering)
$comment = $this->getState('comment');
$jpskey = $this->getState('jpskey');
$angiekey = $this->getState('angiekey');
if (is_null($backupId))
{
$db = $this->getDbo();
$query = $db->getQuery(true)
->select('MAX(' . $db->qn('id') . ')')
->from($db->qn('#__ak_stats'));
try
{
$maxId = $db->setQuery($query)->loadResult();
}
catch (Exception $e)
{
$maxId = 0;
}
$backupId = 'id' . ($maxId + 1);
}
// Try resetting the engine
Factory::resetState(array(
'maxrun' => 0
));
// Remove any stale memory files left over from the previous step
if (empty($tag))
{
$tag = Platform::getInstance()->get_backup_origin();
}
$tempVarsTag = $tag;
$tempVarsTag .= empty($backupId) ? '' : ('.' . $backupId);
Factory::getFactoryStorage()->reset($tempVarsTag);
Factory::loadState($tag, $backupId);
$kettenrad = Factory::getKettenrad();
$kettenrad->setBackupId($backupId);
// Take care of System Restore Point setup
if ($tag == 'restorepoint')
{
// Fetch the extension's version information
require_once JPATH_COMPONENT_ADMINISTRATOR . '/assets/xmlslurp/xmlslurp.php';
$slurp = new LiveUpdateXMLSlurp();
$exttype = $this->getState('type');
switch ($exttype)
{
case 'component':
$extname = 'com_';
break;
case 'file':
$extname = 'file';
break;
case 'library':
$extname = 'lib_';
break;
case 'module':
$extname = 'mod_';
break;
case 'package':
$extname = 'pkg_';
break;
case 'plugin':
$extname = 'plg_';
break;
case 'template':
$extname = 'tpl_';
break;
default:
$extname = '';
break;
}
$extname .= $this->getState('name');
$info = $slurp->getInfo($extname, '');
// Get the configOverrides for this extension
$configOverrides = $this->getConfigOverridesForSRP($extname, $info);
// Create an SRP descriptor
$srpdescriptor = array(
'type' => $this->getState('type'),
'name' => $this->getState('name'),
'group' => $this->getState('group'),
'version' => $info['version'],
'date' => $info['date']
);
// Set the description and comment
$description = "System Restore Point - " . JText::_($exttype) . ": $extname";
$comment = "---BEGIN SRP---\n" . json_encode($srpdescriptor) . "\n---END SRP---";
$jpskey = '';
$angiekey = '';
// Set a custom finalization action queue
$configOverrides['volatile.core.finalization.action_handlers'] = array(
new Akeeba\Engine\Finalization\Srpquotas()
);
$configOverrides['volatile.core.finalization.action_queue'] = array(
'remove_temp_files',
'update_statistics',
'update_filesizes',
'apply_srp_quotas'
);
// Apply the configuration overrides, please
$platform = Platform::getInstance();
$platform->configOverrides = $configOverrides;
}
$options = array(
'description' => $description,
'comment' => $comment,
'jpskey' => $jpskey,
'angiekey' => $angiekey,
);
$kettenrad->setup($options);
$kettenrad->tick();
if (($kettenrad->getState() != 'running') && ($tag == 'restorepoint'))
{
Factory::saveState($tag, $backupId);
Factory::loadState($tag, $backupId);
$kettenrad = Factory::getKettenrad();
$kettenrad->setBackupId($backupId);
$kettenrad->tick();
}
$ret_array = $kettenrad->getStatusArray();
$kettenrad->resetWarnings(); // So as not to have duplicate warnings reports
Factory::saveState($tag, $backupId);
break;
case 'step':
Factory::loadState($tag, $backupId);
$kettenrad = Factory::getKettenrad();
$kettenrad->setBackupId($backupId);
$kettenrad->tick();
$ret_array = $kettenrad->getStatusArray();
$kettenrad->resetWarnings(); // So as not to have duplicate warnings reports
Factory::saveState($tag, $backupId);
if ($ret_array['HasRun'] == 1)
{
// Clean up
Factory::nuke();
$tempVarsTag = $tag;
$tempVarsTag .= empty($backupId) ? '' : ('.' . $backupId);
Factory::getFactoryStorage()->reset($tempVarsTag);
}
break;
default:
break;
}
return $ret_array;
}
/**
* Gets the configuration overrides for a System Restore Point backup
*
* @param string $extname The extension shortname, e.g. com_foobar
* @param array $info The structure returned by Live Update's XMLSlurp class
* @param array $extraConfig Extra configuration that will be merged with the default one
*
* @return array
*/
private function getConfigOverridesForSRP($extname, $info, $extraConfig = array())
{
// Get the defaults from the URL
$config = array(
'akeeba.basic.archive_name' => 'restore-point-[DATE]-[TIME]',
'akeeba.basic.backup_type' => 'full',
'akeeba.advanced.archiver_engine' => 'jpa',
'akeeba.advanced.postproc_engine' => 'none',
'akeeba.advanced.embedded_installer' => 'none',
'engine.archiver.common.dereference_symlinks' => true, // hopefully no extension has symlinks inside its own directories...
'core.filters.srp.type' => array($this->getState('type')),
'core.filters.srp.group' => array($this->getState('group')),
'core.filters.srp.name' => array($this->getState('name')),
'core.filters.srp.customdirs' => $this->getState('customdirs'),
'core.filters.srp.customfiles' => $this->getState('customfiles'),
'core.filters.srp.extraprefixes' => $this->getState('extraprefixes'),
'core.filters.srp.customtables' => $this->getState('customtables'),
'core.filters.srp.skiptables' => $this->getState('skiptables'),
'core.filters.srp.langfiles' => $this->getState('langfiles')
);
if ($extraConfig)
{
$config = array_merge($config, $extraConfig);
}
$type = end($config['core.filters.srp.type']);
reset($config['core.filters.srp.type']);
// Parse a local file stored in (backend)/assets/srpdefs/$extname.xml
JLoader::import('joomla.filesystem.file');
$filename = JPATH_COMPONENT_ADMINISTRATOR . '/assets/srpdefs/' . $extname . '.xml';
if (JFile::exists($filename))
{
$xml = new SimpleXMLElement($filename, LIBXML_NONET, true);
if ($xml instanceof SimpleXMLElement)
{
$extraConfig = $this->parseRestorePointXML($xml);
if ($extraConfig !== false)
{
$this->mergeSRPConfig($config, $extraConfig);
}
}
unset($xml);
}
// Parse the extension's manifest file and look for a <restorepoint> tag
if (!empty($info['xmlfile']))
{
$xml = new SimpleXMLElement($info['xmlfile'], LIBXML_NONET, true);
if ($xml instanceof SimpleXMLElement)
{
$restorepoint = $xml->restorepoint;
$extraConfig = false;
if (count($restorepoint))
{
$extraConfig = $this->parseRestorePointXML($restorepoint);
}
// Do our automatic logic only if there aren't any restorepoints inside the manifest
elseif ($type == 'file')
{
$extraConfig = $this->parseFileXML($xml);
}
elseif ($type == 'library')
{
$extraConfig = $this->parseLibXML($xml);
}
elseif (in_array($type, array('component', 'module', 'plugin')))
{
$extraConfig = $this->parseMediaXML($xml);
}
elseif ($type == 'package')
{
$extraConfig = $this->parsePackageXML($xml);
// While creating a SRP for packages I have to exclude the package itself,
// so I'm going to unset these variables from the main $config variable
$config['core.filters.srp.type'] = array();
$config['core.filters.srp.name'] = array();
$config['core.filters.srp.group'] = array();
}
if ($extraConfig !== false)
{
$this->mergeSRPConfig($config, $extraConfig);
}
}
unset($restorepoint);
unset($xml);
}
return $config;
}
/**
* Parses the Restore Point definition XML
*
* @param SimpleXMLElement $xml
*
* @return boolean|array False if there is no restore point data set, or a list of SRP overrides
*/
private function parseRestorePointXML(SimpleXMLElement $xml)
{
if (!count($xml))
{
return false;
}
$ret = array();
// 1. Group name -- core.filters.srp.group
if (count($xml->group))
{
$ret['core.filters.srp.group'] = (string)($xml->group);
}
// 2. Custom dirs -- core.filters.srp.customdirs
$customdirs = $xml->customdirs;
if (count($customdirs))
{
$stack = array();
$children = $customdirs->children();
foreach ($children as $child)
{
if ($child->getName() == 'dir')
{
$stack[] = (string)$child;
}
}
if (!empty($stack))
{
$ret['core.filters.srp.customdirs'] = $stack;
}
}
// 3. Extra prefixes -- core.filters.srp.extraprefixes
$extraprefixes = $xml->extraprefixes;
if (count($extraprefixes))
{
$stack = array();
$children = $extraprefixes->children();
foreach ($children as $child)
{
if ($child->getName() == 'prefix')
{
$stack[] = (string)$child;
}
}
if (!empty($stack))
{
$ret['core.filters.srp.extraprefixes'] = $stack;
}
}
// 4. Custom tables -- core.filters.srp.customtables
$customtables = $xml->customtables;
if (count($customtables))
{
$stack = array();
$children = $customtables->children();
foreach ($children as $child)
{
if ($child->getName() == 'table')
{
$stack[] = (string)$child;
}
}
if (!empty($stack))
{
$ret['core.filters.srp.customtables'] = $stack;
}
}
// 5. Skip tables -- core.filters.srp.skiptables
$skiptables = $xml->skiptables;
if (count($skiptables))
{
$stack = array();
$children = $skiptables->children();
foreach ($children as $child)
{
if ($child->getName() == 'table')
{
$stack[] = (string)$child;
}
}
if (!empty($stack))
{
$ret['core.filters.srp.skiptables'] = $stack;
}
}
// 6. Language files -- core.filters.srp.langfiles
$langfiles = $xml->langfiles;
if (count($langfiles))
{
$stack = array();
$children = $langfiles->children();
foreach ($children as $child)
{
if ($child->getName() == 'lang')
{
$stack[] = (string)$child;
}
}
if (!empty($stack))
{
$ret['core.filters.srp.langfiles'] = $stack;
}
}
// 7. Custom files -- core.filters.srp.customfiles
$customfiles = $xml->customfiles;
if (count($customfiles))
{
$stack = array();
$children = $customfiles->children();
foreach ($children as $child)
{
if ($child->getName() == 'file')
{
$stack[] = (string)$child;
}
}
if (!empty($stack))
{
$ret['core.filters.srp.customfiles'] = $stack;
}
}
if (empty($ret))
{
return false;
}
return $ret;
}
/**
* Parses an XML file of type file
*
* @param SimpleXMLElement $xml XML resource
*
* @return boolean|array False if there is no restore point data set, or a list of SRP overrides
*/
private function parseFileXML(SimpleXMLElement $xml)
{
$return = false;
$elements = $xml->xpath('//files');
foreach ($elements as $element)
{
$target = (string)$element->attributes()->target;
$filenames = (array)$element->filename;
$filenames = array_merge($filenames, (array)$element->file);
$folders = (array)$element->folder;
$destination = $target ? rtrim($target, '/') . '/' : '';
foreach ($filenames as $filename)
{
$return['core.filters.srp.customfiles'][] = $destination . (string)$filename;
}
foreach ($folders as $folder)
{
$return['core.filters.srp.customdirs'][] = $destination . (string)$folder;
}
}
return $return;
}
/**
* Parses an XML file of type file
*
* @param SimpleXMLElement $xml XML resource
*
* @return boolean|array False if there is no restore point data set, or a list of SRP overrides
*/
private function parseLibXML(SimpleXMLElement $xml)
{
$return = false;
$elements = $xml->xpath('//files');
foreach ($elements as $element)
{
$target = (string)$element->attributes()->folder;
$filenames = (array)$element->filename;
$filenames = array_merge($filenames, (array)$element->file);
$folders = (array)$element->folder;
$destination = $target ? 'libraries/' . rtrim($target, '/') . '/' : 'libraries/';
foreach ($filenames as $filename)
{
$return['core.filters.srp.customfiles'][] = $destination . (string)$filename;
}
foreach ($folders as $folder)
{
$return['core.filters.srp.customdirs'][] = $destination . (string)$folder;
}
}
return $return;
}
private function parseMediaXML(SimpleXMLElement $xml)
{
$return = false;
$elements = $xml->xpath('media');
foreach ($elements as $element)
{
$filenames = (array)$element->filename;
$folders = (array)$element->folder;
$destination = (string)$element->attributes()->folder . '/' . (string)$element->attributes()->destination;
$destination = rtrim($destination, '/') . '/';
foreach ($filenames as $filename)
{
$return['core.filters.srp.customfiles'][] = $destination . (string)$filename;
}
foreach ($folders as $folder)
{
$return['core.filters.srp.customdirs'][] = $destination . (string)$folder;
}
}
return $return;
}
private function parsePackageXML(SimpleXMLElement $xml)
{
$return = array();
$files = (array)$xml->xpath('//file');
$slurp = new LiveUpdateXMLSlurp();
foreach ($files as $file)
{
$group = '';
$type = (string)$file->attributes()->type;
$extension = (string)$file->attributes()->id;
$info = $slurp->getInfo($extension, '');
if ($type == 'plugin')
{
$group = (string)$file->attributes()->group;
}
if ($type == 'module')
{
$group = (string)$file->attributes()->client;
}
$return['core.filters.srp.name'][] = $extension;
$return['core.filters.srp.type'][] = $type;
$return['core.filters.srp.group'][] = $group;
$return = $this->getConfigOverridesForSRP($extension, $info, $return);
}
if (!$return)
{
$return = false;
}
return $return;
}
private function mergeSRPConfig(&$config, $extraConfig)
{
foreach ($config as $key => $value)
{
if (array_key_exists($key, $extraConfig))
{
if (is_array($value) && is_array($extraConfig[$key]))
{
$config[$key] = array_merge($extraConfig[$key], $value);
}
}
}
}
}