fannie/install/InstallPluginsPage.php
<?php
/*******************************************************************************
Copyright 2011 Whole Foods Co-op
This file is part of CORE-POS.
CORE-POS is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
CORE-POS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
in the file license.txt along with IT CORE; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*********************************************************************************/
//ini_set('display_errors','1');
include(dirname(__FILE__) . '/../config.php');
if (!class_exists('FannieAPI')) {
include_once(dirname(__FILE__) . '/../classlib2.0/FannieAPI.php');
}
if (!function_exists('confset')) {
include(dirname(__FILE__) . '/util.php');
}
if (!function_exists('dropDeprecatedStructure')) {
include(dirname(__FILE__) . '/db.php');
}
/**
@class InstallPluginsPage
Class for the Plugins install and config options
*/
class InstallPluginsPage extends \COREPOS\Fannie\API\InstallPage {
protected $title = 'Fannie: Plugin Install';
protected $header = 'Fannie: Plugin Install Options';
public $description = "
Class for the Plugins install and config options page.
";
// This replaces the __construct() in the parent.
public function __construct() {
// To set authentication.
parent::__construct();
$SRC = '../src';
// Link to a file of CSS by using a function.
$this->addCssFile("$SRC/css/toggle-switch.css");
// __construct()
}
// If chunks of CSS are going to be added the function has to be
// redefined to return them.
// If this is to override x.css draw_page() needs to load it after the addCssFile
/**
Define any CSS needed
@return a CSS string
*/
function css_content(){
// These reduce the size of the slider to keep it from overlapping the text.
$css =".toggle label:after { width:70px; }
.toggle span { width:30px; }";
return $css;
//css_content()
}
function body_content(){
//Should this really be done with global?
global $FANNIE_PLUGIN_LIST, $FANNIE_PLUGIN_SETTINGS, $FANNIE_OP_DB;
ob_start();
echo showInstallTabs('Plugins');
?>
<form action=InstallPluginsPage.php method=post>
<?php
echo $this->writeCheck(dirname(__FILE__) . '/../config.php');
?>
<h4 class="install">Available plugins</h4>
<?php
if (!isset($FANNIE_PLUGIN_LIST)) $FANNIE_PLUGIN_LIST = array();
if (!is_array($FANNIE_PLUGIN_LIST)) $FANNIE_PLUGIN_LIST = array();
if (!isset($FANNIE_PLUGIN_SETTINGS)) $FANNIE_PLUGIN_SETTINGS = array();
if (!is_array($FANNIE_PLUGIN_SETTINGS)) $FANNIE_PLUGIN_SETTINGS = array();
$mods = FannieAPI::listModules('\COREPOS\Fannie\API\FanniePlugin');
$sortName = function($name) {
if (strstr($name, '\\')) {
$parts = explode('\\', $name);
$name = $parts[count($parts)-1];
}
return $name;
};
$modSort = function($a, $b) use ($sortName) {
$a = $sortName($a);
$b = $sortName($b);
if ($a == $b) {
return 0;
} else {
return $a < $b ? -1 : 1;
}
};
usort($mods, $modSort);
if (isset($_REQUEST['PLUGINLIST']) || isset($_REQUEST['psubmit'])){
$oldset = $FANNIE_PLUGIN_LIST;
if (!is_array($oldset)) $oldset = array();
$newset = isset($_REQUEST['PLUGINLIST']) ? $_REQUEST['PLUGINLIST'] : array();
foreach($newset as $plugin_class){
if (!\COREPOS\Fannie\API\FanniePlugin::IsEnabled($plugin_class)){
$obj = new $plugin_class();
$obj->pluginEnable();
}
}
foreach($oldset as $plugin_class){
if (!class_exists($plugin_class)) continue;
if (!in_array($plugin_class,$newset)){
$obj = new $plugin_class();
$obj->pluginDisable();
}
}
$FANNIE_PLUGIN_LIST = $_REQUEST['PLUGINLIST'];
}
echo '<table id="install" class="table">';
$count = 0;
$dbSettings = array();
$changeEvents = array();
foreach($mods as $m){
$enabled = False;
$instance = new $m();
foreach($FANNIE_PLUGIN_LIST as $r){
if ($r == $m){
$enabled = True;
break;
}
}
/* 17Jun13 Under Fannie Admin CSS the spacing is cramped.
The slider overlaps the text. Want it higher and to the right.
Not obvious why or how to fix.
Jiggered the CSS a little here and above but isn't really a fix.
*/
echo '<tr ' . ($count % 2 == 0 ? 'class="info"' : '') . '>
<td style="width:10em;"> </td>
<td style="width:25em;">'."\n";
echo '<fieldset class="toggle">'."\n";
printf('<input name="PLUGINLIST[]" id="plugin_%s" type="checkbox" %s
value="%s" onchange="$(\'#settings_%s\').toggle();" class="checkbox-inline" />
<label onclick="" for="plugin_%s">%s</label>',
$m, ($enabled?'checked':''), $m, $m, $m, $m);
echo "\n".'<span class="toggle-button"></span></fieldset>'."\n";
// 17Jun13 EL Added <br /> for overlap problem.
printf('<br /><span class="noteTxt">%s</span>',$instance->plugin_description);
echo '</td></tr>'."\n";
if (empty($instance->plugin_settings)){
echo '<tr ' . ($count % 2 == 0 ? 'class="info"' : '') . '>
<td colspan="2"><i>No settings required</i></td></tr>';
} else {
echo '<tr ' . ($count % 2 == 0 ? 'class="info"' : '') . '>
<td colspan="2" style="margin-bottom: 0px; height:auto;">';
printf('<div id="settings_%s" %s>',
$m, (!$enabled ? 'class="collapse"' : '')
);
if ($instance->version == 2) {
$dbSettings = $instance->getSettings();
}
/**
* All the version checking here is because version 1
* plugin settings are stored in the config.php
* variable $FANNIE_PLUGIN_SETTINGS but version 2
* plugin settings are stored in the database
*/
foreach($instance->plugin_settings as $field => $info){
$form_id = $m.'_'.$field;
// ignore submitted values if plugin was not enabled
if ($enabled && isset($_REQUEST[$form_id])) {
if ($instance->version == 1) {
$FANNIE_PLUGIN_SETTINGS[$field] = $_REQUEST[$form_id];
} elseif ($instance->version == 2) {
$dbSettings[$field] = $_REQUEST[$form_id];
}
}
$currentValue = '';
if ($instance->version == 1) {
$currentValue = isset($FANNIE_PLUGIN_SETTINGS[$field]) ? $FANNIE_PLUGIN_SETTINGS[$field] : '';
if (!isset($FANNIE_PLUGIN_SETTINGS[$field])) {
$currentValue = isset($info['default'])?$info['default']:'';
$FANNIE_PLUGIN_SETTINGS[$field] = $currentValue;
}
} elseif ($instance->version == 2) {
$currentValue = isset($dbSettings[$field]) ? $dbSettings[$field] : '';
if (!isset($dbSettings[$field])) {
$currentValue = isset($info['default'])?$info['default']:'';
$dbSettings[$field] = $currentValue;
}
if (isset($FANNIE_PLUGIN_SETTINGS[$field])) {
unset($FANNIE_PLUGIN_SETTINGS[$field]);
}
}
echo '<b>'.(isset($info['label'])?$info['label']:$field).'</b>: ';
if (isset($info['options'])) {
echo '<select name="' . $form_id . '" class="form-control">';
foreach ($info['options'] as $key => $val) {
printf('<option %s value="%s">%s</option>',
($currentValue == $val) ? 'selected' : '',
$val, $key);
}
echo '</select>';
} else {
printf('<input type="text" name="%s" value="%s" class="form-control" />',
$form_id,$currentValue);
}
// show the default if plugin isn't enabled, but
// unset so that it isn't saved in the configuration
if (!$enabled) {
if ($instance->version == 1) {
unset($FANNIE_PLUGIN_SETTINGS[$field]);
} elseif ($instance->version == 2) {
unset($dbSettings[$field]);
}
}
// 17Jun13 EL Added <br /> for crampedness problem.
if (isset($info['description']))
echo '<br /><span class="noteTxt">'.$info['description'].'</span>';
echo '<br />';
//confset($field,"'".$CORE_LOCAL->get($field)."'");
/*
* Re-key settings w/ namespace, if applicable
*/
if (strlen($instance->settingsNamespace) > 0) {
if ($instance->version == 1 && isset($FANNIE_PLUGIN_SETTINGS[$field])) {
$nsKey = $instance->settingsNamespace . "." . $field;
$FANNIE_PLUGIN_SETTINGS[$nsKey] = $FANNIE_PLUGIN_SETTINGS[$field];
unset($FANNIE_PLUGIN_SETTINGS[$field]);
} elseif ($instance->version == 2 && isset($dbSettings[$field])) {
$nsKey = $instance->settingsNamespace . "." . $field;
$dbSettings[$nsKey] = $dbSettings[$field];
unset($dbSettings[$field]);
}
}
}
if ($enabled && isset($_REQUEST['psubmit'])) {
$changeEvents[] = $instance;
}
echo '</div>';
echo '</td></tr>';
}
$count++;
}
echo '</table>';
$saveStr = "array(";
foreach($FANNIE_PLUGIN_LIST as $r){
$saveStr .= "'".$r."',";
}
$saveStr = rtrim($saveStr,",").")";
confset('FANNIE_PLUGIN_LIST',$saveStr);
$saveStr = "array(";
foreach($FANNIE_PLUGIN_SETTINGS as $key => $val){
$saveStr .= "'".$key."'=>'".$val."',";
}
$saveStr = rtrim($saveStr,",").")";
confset('FANNIE_PLUGIN_SETTINGS',$saveStr);
$dbc = FannieDB::get($FANNIE_OP_DB);
$dbc->startTransaction();
$prep = $dbc->prepare("INSERT INTO PluginSettings (name, setting) VALUES (?, ?)");
$dbc->query('TRUNCATE TABLE PluginSettings');
foreach ($dbSettings as $key => $val) {
$dbc->execute($prep, array($key, $val));
}
$dbc->commitTransaction();
foreach ($changeEvents as $instance) {
$instance->settingChange();
}
?>
<hr />
<p>
<button type="submit" name="psubmit" value="1" class="btn btn-default">Save Configuration</button>
</p>
</form>
<?php
return ob_get_clean();
// body_content
}
public function unitTest($phpunit)
{
$phpunit->assertNotEquals(0, strlen($this->body_content()));
}
// InstallPluginsPage
}
FannieDispatch::conditionalExec();