Skip to content

Commit

Permalink
Implementing a possibility to download system/environment information…
Browse files Browse the repository at this point in the history 
… for support purposes.

The output is a text file which is probably not the best solution. Hope for some input
  • Loading branch information
@Radek-Suski @phproberto
Radek-Suski authored and phproberto committed Nov 2, 2015
1 parent b3c2e1f commit df88d4e
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 3 deletions.
122 changes: 122 additions & 0 deletions administrator/components/com_admin/controller.php
View file
Expand Up @@ -16,4 +16,126 @@
*/
class AdminController extends JControllerLegacy
{
/**
* Creating a text file with all relevant system setting
*/
public function download()
{
JSession::checkToken() or jexit(JText::_('JInvalid_Token'));
/** @var AdminModelSysInfo $model */
$model = $this->getModel('sysinfo');
$settingsToLoad = array('PhpSettings', 'Config', 'Info');
foreach($settingsToLoad as $section) {
$settings[$section] = $this->loadSetting($section, $model);
}
$directories = $this->loadSetting('Directory', $model);
if(count($directories)) {
foreach($directories as $directory => $data) {
$settings['Directory'][$directory] = $directory.($data['writable'] ? ' is writable' : 'is not writable');
}
}
$phpInfo = $this->parsePhpInfo($model->getPHPInfo());
// remove sensitive information from the phpinfo output
$remove = array('HTTP_HOST','Server Administrator', 'Server Root', 'HTTP_ORIGIN', 'HTTP_REFERER', 'HTTP_COOKIE', 'SERVER_NAME', 'SERVER_ADDR', 'REMOTE_ADDR', 'DOCUMENT_ROOT', 'CONTEXT_DOCUMENT_ROOT', 'SERVER_ADMIN', 'SCRIPT_FILENAME', 'HTTP Request', 'Host', 'Referer');
foreach($phpInfo as $section => $values) {
foreach ( $values as $name => $setting ) {
if(in_array($name, $remove)) {
$setting = strlen($name) ? 'set' : 'not set';
}
$settings['PhpInfo'][$section][$name] = $setting;
}
}
header('Content-Disposition: attachment; filename="systeminfo-' . microtime( true) . '.txt"');
header('Content-Transfer-Encoding: text');
$this->renderFile($settings);
JFactory::getApplication()->close();
}


/**
* Parses array to generate plain text output
* @param array $settings
* @param int $level
*/
protected function renderFile( $settings, $level = -1 )
{
if(count($settings)) {
$margin = null;
foreach($settings as $name => $value) {
if( $level > 0 ) {
$margin = str_repeat("\t", $level);
}
if( is_array($value)) {
if($name=='Directive') {
continue;
}
echo "\n";
echo $margin."=============\n";
echo $margin.$name."\n";
echo $margin."=============\n";
$this->renderFile($value,$level+1);
}
else {
if(is_bool($value)) {
$value = $value ? 'true' : 'false';
}
if(is_int($name) && ($name == 0 || $name == 1)) {
$name = ($name==0 ? 'Local Value' : 'Master Value');
}
echo $margin.$name.': '.$value."\n";
}
}
}
}

/**
* Parse phpinfo output into an array
* Source https://gist.github.com/sbmzhcn/6255314
* */
protected function parsePhpInfo($string)
{
$string = strip_tags($string, '<h2><th><td>');
$string = preg_replace('/<th[^>]*>([^<]+)<\/th>/', '<info>\1</info>', $string);
$string = preg_replace('/<td[^>]*>([^<]+)<\/td>/', '<info>\1</info>', $string);
$t = preg_split('/(<h2[^>]*>[^<]+<\/h2>)/', $string, -1, PREG_SPLIT_DELIM_CAPTURE);
$r = array(); $count = count($t);
$p1 = '<info>([^<]+)<\/info>';
$p2 = '/'.$p1.'\s*'.$p1.'\s*'.$p1.'/';
$p3 = '/'.$p1.'\s*'.$p1.'/';
for ($i = 1; $i < $count; $i++) {
if (preg_match('/<h2[^>]*>([^<]+)<\/h2>/', $t[$i], $matchs)) {
$name = trim($matchs[1]);
$vals = explode("\n", $t[$i + 1]);
foreach ($vals AS $val) {
if (preg_match($p2, $val, $matchs)) { // 3cols
$r[$name][trim($matchs[1])] = array(trim($matchs[2]), trim($matchs[3]));
} elseif (preg_match($p3, $val, $matchs)) { // 2cols
$r[$name][trim($matchs[1])] = trim($matchs[2]);
}
}
}
}
return $r;
}

/**
* Load particular section
*/
protected function loadSetting($section, $model)
{
/** security sensitive information to be removed from the output */
static $remove = array('dbprefix', 'open_basedir', 'session.save_path', 'mailfrom', 'fromname', 'smtphost', 'log_path', 'tmp_path', 'proxy_host', 'proxy_user', 'proxy_pass', 'memcache_server_host', 'memcached_server_host', 'session_memcache_server_host', 'session_memcached_server_host');
$settings = array();
$method = 'get'.$section;
$sectionsValues = $model->$method();
if(count($sectionsValues)) {
foreach($sectionsValues as $setting => $value) {
if(in_array($setting, $remove)) {
$value = strlen($value) ? 'set' : 'not set';
}
$settings[$setting] = $value;
}
}
return $settings;
}
}
4 changes: 3 additions & 1 deletion administrator/components/com_admin/views/sysinfo/tmpl/default.php
View file
Expand Up @@ -13,7 +13,7 @@
JHtml::addIncludePath(JPATH_COMPONENT . '/helpers/html');
?>

<form action="<?php echo JRoute::_('index.php'); ?>" method="post" name="adminForm" id="adminForm">
<form action="<?php echo JRoute::_('index.php?option=com_admin&view=sysinfo'); ?>" method="post" name="adminForm" id="adminForm">
<div class="row-fluid">
<!-- Begin Content -->
<div class="span12">
Expand Down Expand Up @@ -41,6 +41,8 @@

<?php echo JHtml::_('bootstrap.endTabSet'); ?>
</div>
<input type="hidden" name="task" value="" />
<?php echo JHtml::_('form.token'); ?>
<!-- End Content -->
</div>
</form>
5 changes: 3 additions & 2 deletions administrator/components/com_admin/views/sysinfo/view.html.php
View file
Expand Up @@ -3,8 +3,8 @@
* @package Joomla.Administrator
* @subpackage com_admin
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

defined('_JEXEC') or die;
Expand Down Expand Up @@ -116,6 +116,7 @@ protected function _setSubMenu()
protected function addToolbar()
{
JToolbarHelper::title(JText::_('COM_ADMIN_SYSTEM_INFORMATION'), 'info-2 systeminfo');
JToolbarHelper::custom('download', 'download', 'download', 'COM_ADMIN_DOWNLOAD_SYSTEM_INFORMATION', false);
JToolbarHelper::help('JHELP_SITE_SYSTEM_INFORMATION');
}
}
1 change: 1 addition & 0 deletions administrator/language/en-GB/en-GB.com_admin.ini
View file
Expand Up @@ -15,6 +15,7 @@ COM_ADMIN_DIRECTORY="Folder"
COM_ADMIN_DIRECTORY_PERMISSIONS="Folder Permissions"
COM_ADMIN_DISABLED_FUNCTIONS="Disabled Functions"
COM_ADMIN_DISPLAY_ERRORS="Display Errors"
COM_ADMIN_DOWNLOAD_SYSTEM_INFORMATION="Download System Information"
COM_ADMIN_FILE_UPLOADS="File Uploads"
COM_ADMIN_GLOSSARY="Glossary"
COM_ADMIN_GO="Go"
Expand Down

0 comments on commit df88d4e

Please sign in to comment.