maketank/Froxlor
2
0
Fork 0
Code Pull Requests Releases Activity

ported CLI stuff to namespaces-layout

Browse Source 
Signed-off-by: Michael Kaufmann <d00p@froxlor.org>
This commit is contained in:
Michael Kaufmann
2018-12-19 13:59:11 +01:00
parent 3ff20e327f
commit 28f24fda72
12 changed files with 1122 additions and 1059 deletions
Download Patch File Download Diff File Expand all files Collapse all files

555
lib/Froxlor/Config/ConfigDaemon.php Normal file
View File

@@ -0,0 +1,555 @@
<?php
namespace Froxlor\Config;
/**
* This file is part of the Froxlor project.
* Copyright (c) 2010 the Froxlor Team (see authors).
*
* For the full copyright and license information, please view the COPYING
* file that was distributed with this source code. You can also view the
* COPYING file online at http://files.froxlor.org/misc/COPYING.txt
*
* @copyright (c) the authors
* @author Florian Aders <eleras@froxlor.org>
* @author Froxlor team <team@froxlor.org> (2010-)
* @license GPLv2 http://files.froxlor.org/misc/COPYING.txt
* @package Classes
*
* @since 0.9.34
*/
/**
* Class ConfigDaemon
*
* Parses a distributions XML - file and gives access to the configuration
* Not to be used directly
*
* @copyright (c) the authors
* @author Florian Aders <eleras@froxlor.org>
* @author Froxlor team <team@froxlor.org> (2010-)
* @license GPLv2 http://files.froxlor.org/misc/COPYING.txt
* @package Classes
*/
class ConfigDaemon
{
/**
* Holding the commands for this daemon
*
* @var array
*/
private $orders = array();
/**
* Store the parsed SimpleXMLElement for usage
*
* @var \SimpleXMLElement
*/
private $fullxml;
/**
* Memorize if we already parsed the XML
*
* @var bool
*/
private $isparsed = false;
/**
* Sub - area of the full - XML only holding the daemon - data we are interessted in
*
* @var \SimpleXMLElement
*/
private $daemon;
/**
* xpath leading to this daemon in the full XML
*
* @var string
*/
private $xpath;
/**
* cache of sql-data if used
*/
private $_sqldata_cache = null;
/**
* Human - readable title of this service
*
* @var string
*/
public $title;
/**
* Whether this is the default daemon of the service-category
*
* @var boolean
*/
public $default;
public function __construct($xml, $xpath)
{
$this->fullxml = $xml;
$this->xpath = $xpath;
$this->daemon = $this->fullxml->xpath($this->xpath);
$attributes = $this->daemon[0]->attributes();
if ($attributes['title'] != '') {
$this->title = $this->_parseContent((string) $attributes['title']);
}
if (isset($attributes['default'])) {
$this->default = ($attributes['default'] == true);
}
}
/**
* Parse the XML and populate $this->orders
*
* @return bool
*/
private function _parse()
{
// We only want to parse the stuff one time
if ($this->isparsed == true) {
return true;
}
$preparsed = array();
// First: let's push everything into an array and expand all includes
foreach ($this->daemon[0]->children() as $order) {
switch ((string) $order->getName()) {
case "install":
case "file":
case "command":
// Normal stuff, just add it to the preparsed - array
$preparsed[] = $order;
break;
case "include":
// Includes, get the part we want via xpath
$includes = $this->fullxml->xpath((string) $order);
foreach ($includes[0] as $include) {
// The "include" is also a child, so just skip it, would make a mess later
if ((string) $include->getName() == 'include') {
continue;
}
$preparsed[] = $include;
}
break;
// The next 3 are groupings, <visibility> MUST come first in this to work properly
case "commands":
case "files":
case "installs":
// Hold the results
$visibility = 1;
foreach ($order->children() as $child) {
switch ((string) $child->getName()) {
case "visibility":
$visibility += $this->_checkVisibility($child);
break;
case "install":
case "file":
case "command":
if ($visibility > 0) {
$preparsed[] = $child;
}
break;
case "include":
// Includes, get the part we want via xpath
$includes = $this->fullxml->xpath((string) $child);
foreach ($includes[0] as $include) {
// The "include" is also a child, so just skip it, would make a mess later
if ((string) $include->getName() == 'include') {
continue;
}
$preparsed[] = $include;
}
break;
}
}
break;
}
}
// Go through every preparsed order and evaluate what should happen to it
foreach ($preparsed as $order) {
$parsedorder = $this->_parseOrder($order);
// We got an array (= valid order) and the array already has a type -> add to stack
if (is_array($parsedorder) && array_key_exists('type', $parsedorder)) {
$this->orders[] = $parsedorder;
// We got an array, but no type, means we got multiple orders back, at them to the stack one at a time
} elseif (is_array($parsedorder)) {
foreach ($parsedorder as $neworder) {
$this->orders[] = $neworder;
}
}
}
// Switch flag to indicate we parsed our data
$this->isparsed = true;
return true;
}
/**
* Get config for this daemon
*
* The returned array will be an array of array, each sub-array looking like this:
* array('type' => 'install|file|command', 'content' => '<TEXT>')
* If the type is "file", an additional "name" - element will be added to the array
* To configure a daemon, the steps in the array must be followed in order
*
* @return array
*/
public function getConfig()
{
$this->_parse();
return $this->orders;
}
/**
* Parse a single order and return it in a format for easier usage
*
* @param
* SimpleXMLElement object holding a single order from the distribution - XML
* @return array|string
*/
private function _parseOrder($order)
{
$attributes = array();
foreach ($order->attributes() as $key => $value) {
$attributes[(string) $key] = (string) $value;
}
$parsedorder = '';
switch ((string) $order->getName()) {
case "file":
$parsedorder = $this->_parseFile($order, $attributes);
break;
case "command":
$parsedorder = $this->_parseCommand($order, $attributes);
break;
case "install":
$parsedorder = $this->_parseInstall($order, $attributes);
break;
default:
throw new \Exception('Invalid order: ' . (string) $order->getName());
}
return $parsedorder;
}
/**
* Parse a install - order and return it in a format for easier usage
*
* @param
* SimpleXMLElement object holding a single install from the distribution - XML
* @return array|string
*/
private function _parseInstall($order, $attributes)
{
// No sub - elements, so the content can be returned directly
if ($order->count() == 0) {
return array(
'type' => 'install',
'content' => $this->_parseContent(trim((string) $order))
);
}
// Hold the results
$visibility = 1;
$content = '';
foreach ($order->children() as $child) {
switch ((string) $child->getName()) {
case "visibility":
$visibility += $this->_checkVisibility($child);
break;
case "content":
$content = trim((string) $child);
break;
}
}
if ($visibility > 0) {
return array(
'type' => 'install',
'content' => $this->_parseContent($content)
);
} else {
return '';
}
}
/**
* Parse a command - order and return it in a format for easier usage
*
* @param
* SimpleXMLElement object holding a single command from the distribution - XML
* @return array|string
*/
private function _parseCommand($order, $attributes)
{
// No sub - elements, so the content can be returned directly
if ($order->count() == 0) {
return array(
'type' => 'command',
'content' => $this->_parseContent(trim((string) $order))
);
}
// Hold the results
$visibility = 1;
$content = '';
foreach ($order->children() as $child) {
switch ((string) $child->getName()) {
case "visibility":
$visibility += $this->_checkVisibility($child);
break;
case "content":
$content = trim((string) $child);
break;
}
}
if ($visibility > 0) {
return array(
'type' => 'command',
'content' => $this->_parseContent($content)
);
} else {
return '';
}
}
/**
* Parse a file - order and return it in a format for easier usage
*
* @param
* SimpleXMLElement object holding a single file from the distribution - XML
* @return array|string
*/
private function _parseFile($order, $attributes)
{
$visibility = 1;
// No sub - elements, so the content can be returned directly
if ($order->count() == 0) {
$content = (string) $order;
} else {
// Hold the results
foreach ($order->children() as $child) {
switch ((string) $child->getName()) {
case "visibility":
$visibility += $this->_checkVisibility($child);
break;
case "content":
$content = (string) $child;
break;
}
}
}
$return = array();
// Check if the original file should be backupped
// @TODO: Maybe have a backup - location somewhere central?
// @TODO: Use IO - class
if (array_key_exists('backup', $attributes)) {
if (array_key_exists('mode', $attributes) && $attributes['mode'] == 'append') {
$cmd = 'cp';
} else {
$cmd = 'mv';
}
$return[] = array(
'type' => 'command',
'content' => $cmd . ' "' . $this->_parseContent($attributes['name']) . '" "' . $this->_parseContent($attributes['name']) . '.frx.bak"',
'execute' => "pre"
);
}
// Now the content of the file can be written
if (isset($attributes['mode'])) {
$return[] = array(
'type' => 'file',
'content' => $this->_parseContent($content),
'name' => $this->_parseContent($attributes['name']),
'mode' => $this->_parseContent($attributes['mode'])
);
} else {
$return[] = array(
'type' => 'file',
'content' => $this->_parseContent($content),
'name' => $this->_parseContent($attributes['name'])
);
}
// Let's check if the mode of the file should be changed
if (array_key_exists('chmod', $attributes)) {
$return[] = array(
'type' => 'command',
'content' => 'chmod ' . $attributes['chmod'] . ' "' . $this->_parseContent($attributes['name']) . '"',
'execute' => "post"
);
}
// Let's check if the owner of the file should be changed
if (array_key_exists('chown', $attributes)) {
$return[] = array(
'type' => 'command',
'content' => 'chown ' . $attributes['chown'] . ' "' . $this->_parseContent($attributes['name']) . '"',
'execute' => "post"
);
}
// If we have more than 1 element, we want to group this stuff for easier processing later
if (count($return) > 1) {
$return = array(
'type' => 'file',
'subcommands' => $return,
'name' => $this->_parseContent($attributes['name'])
);
}
if ($visibility > 0) {
return $return;
} else {
return '';
}
}
/**
* Replace placeholders with content
*
* @param string $content
* @return string $content w/o placeholder
*/
private function _parseContent($content)
{
$content = preg_replace_callback('/\{\{(.*)\}\}/Ui', function ($matches) {
if (preg_match('/^settings\.(.*)$/', $matches[1], $match)) {
return \Froxlor\Settings::Get($match[1]);
} elseif (preg_match('/^lng\.(.*)(?:\.(.*)(?:\.(.*)))$/U', $matches[1], $match)) {
global $lng;
if (isset($match[1]) && $match[1] != '' && isset($match[2]) && $match[2] != '' && isset($match[3]) && $match[3] != '') {
return $lng[$match[1]][$match[2]][$match[3]];
} elseif (isset($match[1]) && $match[1] != '' && isset($match[2]) && $match[2] != '') {
return $lng[$match[1]][$match[2]];
} elseif (isset($match[1]) && $match[1] != '') {
return $lng[$match[1]];
}
return '';
} elseif (preg_match('/^const\.(.*)$/', $matches[1], $match)) {
if (defined($match[1])) {
return constant($match[1]);
} else {
return '';
}
} elseif (preg_match('/^sql\.(.*)$/', $matches[1], $match)) {
if (is_null($this->_sqldata_cache)) {
// read in sql-data (if exists)
if (file_exists(\Froxlor\Froxlor::getInstallDir() . "/lib/userdata.inc.php")) {
require \Froxlor\Froxlor::getInstallDir() . "/lib/userdata.inc.php";
unset($sql_root);
$this->_sqldata_cache = $sql;
}
}
return isset($this->_sqldata_cache[$match[1]]) ? $this->_sqldata_cache[$match[1]] : '';
}
}, $content);
return $content;
}
/**
* Check if visibility should be changed
*
* @param \SimpleXMLElement $order
* @return int 0|-1
*/
private function _checkVisibility($order)
{
$attributes = array();
foreach ($order->attributes() as $key => $value) {
$attributes[(string) $key] = $this->_parseContent(trim((string) $value));
}
$order = $this->_parseContent(trim((string) $order));
if (! array_key_exists('mode', $attributes)) {
throw new \Exception('"<visibility>' . $order . '</visibility>" is missing mode');
}
$return = 0;
switch ($attributes['mode']) {
case "isfile":
if (! is_file($order)) {
$return = - 1;
}
;
break;
case "notisfile":
if (is_file($order)) {
$return = - 1;
}
;
break;
case "isdir":
if (! is_dir($order)) {
$return = - 1;
}
;
break;
case "notisdir":
if (is_dir($order)) {
$return = - 1;
}
;
break;
case "false":
if ($order == true) {
$return = - 1;
}
;
break;
case "true":
if ($order == false) {
$return = - 1;
}
;
break;
case "notempty":
if ($order == "") {
$return = - 1;
}
;
break;
case "userexists":
if (posix_getpwuid($order) === false) {
$return = - 1;
}
;
break;
case "groupexists":
if (posix_getgrgid($order) === false) {
$return = - 1;
}
;
break;
case "usernotexists":
if (is_array(posix_getpwuid($order))) {
$return = - 1;
}
;
break;
case "groupnotexists":
if (is_array(posix_getgrgid($order))) {
$return = - 1;
}
;
break;
case "usernamenotexists":
if (is_array(posix_getpwnam($order))) {
$return = - 1;
}
;
break;
case "equals":
$return = (isset($attributes['value']) && $attributes['value'] == $order ? 0 : - 1);
break;
}
return $return;
}
}

192
lib/Froxlor/Config/ConfigParser.php Normal file
View File

@@ -0,0 +1,192 @@
<?php
namespace Froxlor\Config;
/**
* This file is part of the Froxlor project.
* Copyright (c) 2010 the Froxlor Team (see authors).
*
* For the full copyright and license information, please view the COPYING
* file that was distributed with this source code. You can also view the
* COPYING file online at http://files.froxlor.org/misc/COPYING.txt
*
* @copyright (c) the authors
* @author Florian Aders <eleras@froxlor.org>
* @author Froxlor team <team@froxlor.org> (2010-)
* @license GPLv2 http://files.froxlor.org/misc/COPYING.txt
* @package Classes
*
* @since 0.9.34
*/
/**
* Class ConfigParser
*
* Parses a distributions XML - file and gives access to the configuration
*
* @copyright (c) the authors
* @author Florian Aders <eleras@froxlor.org>
* @author Froxlor team <team@froxlor.org> (2010-)
* @license GPLv2 http://files.froxlor.org/misc/COPYING.txt
* @package Classes
*/
class ConfigParser
{
/**
* Holding the available services in the XML
*
* @var array
*/
private $services = array();
/**
* Store the parsed SimpleXMLElement for usage
*
* @var \SimpleXMLElement
*/
private $xml;
/**
* Memorize if we already parsed the XML
*
* @var bool
*/
private $isparsed = false;
/**
* Name of the distribution this configuration is for
*
* @var string
*/
public $distributionName = '';
/**
* Codename of the distribution this configuration is for
*
* @var string
*/
public $distributionCodename = '';
/**
* Version of the distribution this configuration is for
*
* @var string
*/
public $distributionVersion = '';
/**
* Recommended editor
*
* @var string
*/
public $distributionEditor = '/bin/nano';
/**
* Show if this configuration is deprecated
*
* @var bool
*/
public $deprecated = false;
/**
* Constructor
*
* Initialize the XML - ConfigParser
*
* @param string $filename
* filename of the froxlor - configurationfile
* @return void
*/
public function __construct($filename)
{
if (! is_readable($filename)) {
throw new \Exception('File not readable');
}
$this->xml = simplexml_load_file($filename);
if ($this->xml === false) {
$error = '';
foreach (libxml_get_errors() as $error) {
$error .= "\t" . $error->message;
}
throw new \Exception($error);
}
// Let's see if we can find a <distribution> block in the XML
$distribution = $this->xml->xpath('//distribution');
// No distribution found - can't use this file
if (! is_array($distribution)) {
throw new \Exception('Invalid XML, no distribution found');
}
// Search for attributes we understand
foreach ($distribution[0]->attributes() as $key => $value) {
switch ((string) $key) {
case "name":
$this->distributionName = (string) $value;
break;
case "version":
$this->distributionVersion = (string) $value;
break;
case "codename":
$this->distributionCodename = (string) $value;
break;
case "defaulteditor":
$this->distributionEditor = (string) $value;
break;
case "deprecated":
(string) $value == 'true' ? $this->deprecated = true : $this->deprecated = false;
break;
}
}
}
/**
* Parse the XML and populate $this->services
*
* @return bool
*/
private function _parse()
{
// We only want to parse the stuff one time
if ($this->isparsed == true) {
return true;
}
// Get all services
$services = $this->xml->xpath('//services/service');
foreach ($services as $service) {
// We don't want comments
if ($service->getName() == 'comment') {
continue;
}
// Search the attributes for "type"
foreach ($service->attributes() as $key => $value) {
if ($key == 'type') {
$this->services[(string) $value] = new ConfigService($this->xml, '//services/service[@type="' . (string) $value . '"]');
}
}
}
// Switch flag to indicate we parsed our data
$this->isparsed = true;
return true;
}
/**
* Return all services defined by the XML
*
* The array will hold ConfigService - Objects for further handling
*
* @return array
*/
public function getServices()
{
// Let's parse this shit(!)
$this->_parse();
// Return our carefully searched for services
return $this->services;
}
}

159
lib/Froxlor/Config/ConfigService.php Normal file
View File

@@ -0,0 +1,159 @@
<?php
namespace Froxlor\Config;
/**
* This file is part of the Froxlor project.
* Copyright (c) 2010 the Froxlor Team (see authors).
*
* For the full copyright and license information, please view the COPYING
* file that was distributed with this source code. You can also view the
* COPYING file online at http://files.froxlor.org/misc/COPYING.txt
*
* @copyright (c) the authors
* @author Florian Aders <eleras@froxlor.org>
* @author Froxlor team <team@froxlor.org> (2010-)
* @license GPLv2 http://files.froxlor.org/misc/COPYING.txt
* @package Classes
*
* @since 0.9.34
*/
/**
* Class ConfigService
*
* Parses a distributions XML - file and gives access to the services within
* Not to be used directly
*
* @copyright (c) the authors
* @author Florian Aders <eleras@froxlor.org>
* @author Froxlor team <team@froxlor.org> (2010-)
* @license GPLv2 http://files.froxlor.org/misc/COPYING.txt
* @package Classes
*/
class ConfigService
{
/**
* Holding the available daemons in this service
*
* @var array
*/
private $daemons = array();
/**
* Store the parsed SimpleXMLElement for usage
*
* @var \SimpleXMLElement
*/
private $fullxml;
/**
* Memorize if we already parsed the XML
*
* @var bool
*/
private $isparsed = false;
/**
* xpath leading to this service in the full XML
*
* @var string
*/
private $xpath;
/**
* Human - readable title of this service
*
* @var string
*/
public $title;
public function __construct($xml, $xpath)
{
$this->fullxml = $xml;
$this->xpath = $xpath;
$service = $this->fullxml->xpath($this->xpath);
$attributes = $service[0]->attributes();
if ($attributes['title'] != '') {
$this->title = $this->_parseContent((string) $attributes['title']);
}
}
/**
* Parse the XML and populate $this->daemons
*
* @return bool
*/
private function _parse()
{
// We only want to parse the stuff one time
if ($this->isparsed == true) {
return true;
}
$daemons = $this->fullxml->xpath($this->xpath . '/daemon');
foreach ($daemons as $daemon) {
if ($daemon->getName() == 'comment') {
continue;
}
$name = '';
$nametag = '';
$versiontag = '';
foreach ($daemon->attributes() as $key => $value) {
if ($key == 'name' && $name == '') {
$name = (string) $value;
$nametag = "[@name='" . $value . "']";
} elseif ($key == 'name' && $name != '') {
$name = (string) $value . '_' . $name;
$nametag = "[@name='" . $value . "']";
} elseif ($key == 'version' && $name == '') {
$name = str_replace('.', '', $value);
$versiontag = "[@version='" . $value . "']";
} elseif ($key == 'version' && $name != '') {
$name = $name . str_replace('.', '', $value);
$versiontag = "[@version='" . $value . "']";
}
}
if ($name == '') {
throw new \Exception('No name attribute for daemon');
}
$this->daemons[$name] = new ConfigDaemon($this->fullxml, $this->xpath . "/daemon" . $nametag . $versiontag);
}
// Switch flag to indicate we parsed our data
$this->isparsed = true;
return true;
}
/**
* Replace placeholders with content
*
* @param string $content
* @return string $content w/o placeholder
*/
private function _parseContent($content)
{
$content = preg_replace_callback('/\{\{(.*)\}\}/Ui', function ($matches) {
if (preg_match('/^settings\.(.*)$/', $matches[1], $match)) {
return \Froxlor\Settings::Get($match[1]);
} elseif (preg_match('/^lng\.(.*)(?:\.(.*)(?:\.(.*)))$/U', $matches[1], $match)) {
global $lng;
if (isset($match[1]) && $match[1] != '' && isset($match[2]) && $match[2] != '' && isset($match[3]) && $match[3] != '') {
return $lng[$match[1]][$match[2]][$match[3]];
} elseif (isset($match[1]) && $match[1] != '' && isset($match[2]) && $match[2] != '') {
return $lng[$match[1]][$match[2]];
} elseif (isset($match[1]) && $match[1] != '') {
return $lng[$match[1]];
}
return '';
}
}, $content);
return $content;
}
public function getDaemons()
{
$this->_parse();
return $this->daemons;
}
}