mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-10-06 02:02:24 +02:00
fb5a3e11a8
- Add caching to plugin scan, default is to rescan once a day - Remove lingering unneeded requires
489 lines
15 KiB
PHP
489 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* eGroupWare - importexport
|
|
*
|
|
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
|
|
* @package importexport
|
|
* @link http://www.egroupware.org
|
|
* @author Cornelius Weiss <nelius@cwtech.de>
|
|
* @copyright Cornelius Weiss <nelius@cwtech.de>
|
|
* @version $Id$
|
|
*/
|
|
|
|
/**
|
|
* Userinterface to define {im|ex}ports
|
|
*
|
|
* @package importexport
|
|
*/
|
|
class importexport_definitions_ui
|
|
{
|
|
const _debug = false;
|
|
|
|
const _appname = 'importexport';
|
|
|
|
public $public_functions = array(
|
|
'edit' => true,
|
|
'index' => true,
|
|
'wizard' => true,
|
|
'import_definition' => true,
|
|
);
|
|
|
|
/**
|
|
* holds all available plugins
|
|
*
|
|
* @var array
|
|
*/
|
|
var $plugins;
|
|
|
|
/**
|
|
* holds user chosen plugin after step20
|
|
*
|
|
* @var object
|
|
*/
|
|
var $plugin;
|
|
|
|
/**
|
|
* xajax response object
|
|
*
|
|
* @var object
|
|
*/
|
|
var $response = true;
|
|
|
|
function __construct()
|
|
{
|
|
// we cant deal with notice and warnings, as we are on ajax!
|
|
error_reporting(E_ALL & ~E_NOTICE & ~E_WARNING);
|
|
$GLOBALS['egw']->translation->add_app(self::_appname);
|
|
$GLOBALS['egw_info']['flags']['currentapp'] = self::_appname;
|
|
|
|
$GLOBALS['egw_info']['flags']['include_xajax'] = true;
|
|
$this->etpl = new etemplate();
|
|
$this->clock = html::image(self::_appname,'clock');
|
|
$this->steps = array(
|
|
'wizard_step10' => lang('Choose an application'),
|
|
'wizard_step20' => lang('Choose a plugin'),
|
|
'wizard_step21' => lang('Choose a name for this definition'),
|
|
'wizard_step90' => lang('Which users are allowed to use this definition'),
|
|
'wizard_finish' => '',
|
|
);
|
|
//register plugins
|
|
$this->plugins = importexport_helper_functions::get_plugins();
|
|
}
|
|
|
|
/**
|
|
* List defined {im|ex}ports
|
|
*
|
|
* @param array $content=null
|
|
*/
|
|
function index($content = null,$msg='')
|
|
{
|
|
$bodefinitions = new importexport_definitions_bo(array('name' => '*'));
|
|
if (is_array($content))
|
|
{
|
|
if (isset($content['delete']))
|
|
{
|
|
$bodefinitions->delete(array_keys($content['delete'],'pressed'));
|
|
}
|
|
elseif(($button = array_search('pressed',$content)) !== false)
|
|
{
|
|
$selected = array_keys($content['selected'],1);
|
|
if(count($selected) < 1 || !is_array($selected)) exit();
|
|
switch ($button)
|
|
{
|
|
case 'delete_selected' :
|
|
$bodefinitions->delete($selected);
|
|
break;
|
|
|
|
case 'export_selected' :
|
|
$mime_type = ($GLOBALS['egw']->html->user_agent == 'msie' || $GLOBALS['egw']->html->user_agent == 'opera') ?
|
|
'application/octetstream' : 'application/octet-stream';
|
|
$name = 'importexport_definition.xml';
|
|
header('Content-Type: ' . $mime_type);
|
|
header('Content-Disposition: attachment; filename="'.$name.'"');
|
|
echo $bodefinitions->export($selected);
|
|
exit();
|
|
|
|
break;
|
|
|
|
default:
|
|
}
|
|
}
|
|
|
|
}
|
|
$etpl = new etemplate(self::_appname.'.definition_index');
|
|
|
|
// we need an offset because of autocontinued rows in etemplate ...
|
|
$definitions = array('row0');
|
|
|
|
foreach ($bodefinitions->get_definitions() as $identifier) {
|
|
$definition = new importexport_definition($identifier);
|
|
$definitions[] = $definition->get_record_array();
|
|
unset($definition);
|
|
}
|
|
$content = $definitions;
|
|
return $etpl->exec( self::_appname.'.importexport_definitions_ui.index', $content, array(), $readonlys, $preserv );
|
|
}
|
|
|
|
function edit()
|
|
{
|
|
if(!$_definition = $_GET['definition'])
|
|
{
|
|
//close window
|
|
}
|
|
$definition = array('name' => $_definition);
|
|
$bodefinitions = new importexport_definitions_bo();
|
|
$definition = $bodefinitions->read($definition);
|
|
$definition['edit'] = true;
|
|
$this->wizard($definition);
|
|
}
|
|
|
|
function wizard($content = null, $msg='')
|
|
{
|
|
$GLOBALS['egw_info']['flags']['java_script'] .=
|
|
"<script LANGUAGE='JavaScript'>
|
|
function xajax_eT_wrapper_init() {
|
|
//window.resizeTo(document.documentElement.scrollWidth+20,document.documentElement.offsetHeight+40);
|
|
window.moveTo(screen.availWidth/2 - window.outerWidth/2,
|
|
screen.availHeight/2 - window.outerHeight/2);
|
|
}
|
|
</script>";
|
|
|
|
$this->etpl->read('importexport.wizardbox');
|
|
$this->wizard_content_template =& $this->etpl->children[0]['data'][1]['A'][2][1]['name'];
|
|
|
|
if(is_array($content) &&! $content['edit'])
|
|
{
|
|
if(self::_debug) error_log('importexport.wizard->$content '. print_r($content,true));
|
|
// fetch plugin object
|
|
if($content['plugin'] && $content['application'])
|
|
{
|
|
$wizard_name = $content['application'] . '_wizard_' . str_replace($content['application'] . '_', '', $content['plugin']);
|
|
|
|
// we need to deal with the wizard object if exists
|
|
if (file_exists(EGW_SERVER_ROOT . '/'. $content['application'].'/importexport/class.wizard_'. $content['plugin'].'.inc.php'))
|
|
{
|
|
error_log('Deprecated location for importexport wizard. Please move it to app/inc/ and rename it to follow new conventions');
|
|
}
|
|
elseif (file_exists(EGW_SERVER_ROOT . '/'. $content['application']."/inc/class.$wizard_name.inc.php"))
|
|
{
|
|
$wizard_plugin = $wizard_name;
|
|
}
|
|
else
|
|
{
|
|
$wizard_plugin = $content['plugin'];
|
|
}
|
|
$this->plugin = is_object($GLOBALS['egw']->$wizard_plugin) ? $GLOBALS['egw']->$wizard_plugin : new $wizard_plugin;
|
|
|
|
// Global object needs to be the same, or references to plugin don't work
|
|
if(!is_object($GLOBALS['egw']->importexport_definitions_ui) || $GLOBALS['egw']->importexport_definitions_ui !== $this)
|
|
$GLOBALS['egw']->importexport_definitions_ui =& $this;
|
|
}
|
|
// deal with buttons even if we are not on ajax
|
|
if(isset($content['button']) && array_search('pressed',$content['button']) === false && count($content['button']) == 1)
|
|
{
|
|
$button = array_keys($content['button']);
|
|
$content['button'] = array($button[0] => 'pressed');
|
|
}
|
|
|
|
// post process submitted step
|
|
if($content['step']) {
|
|
if(!key_exists($content['step'],$this->steps))
|
|
$next_step = $this->plugin->$content['step']($content);
|
|
else
|
|
$next_step = $this->$content['step']($content);
|
|
} else {
|
|
die('Cannot find next step');
|
|
}
|
|
|
|
// pre precess next step
|
|
$sel_options = $readonlys = $preserv = array();
|
|
|
|
// Disable finish button if required fields are missing
|
|
if(!$content['name'] || !$content['type'] || !$content['plugin']) {
|
|
$GLOBALS['egw']->js->set_onload("disable_button('exec[button][finish]');");
|
|
}
|
|
if(!key_exists($next_step,$this->steps))
|
|
{
|
|
$this->wizard_content_template = $this->plugin->$next_step($content,$sel_options,$readonlys,$preserv);
|
|
}
|
|
else
|
|
{
|
|
$this->wizard_content_template = $this->$next_step($content,$sel_options,$readonlys,$preserv);
|
|
}
|
|
|
|
$html = $this->etpl->exec(self::_appname.'.importexport_definitions_ui.wizard',$content,$sel_options,$readonlys,$preserv,1);
|
|
}
|
|
else
|
|
{
|
|
// initial content
|
|
$GLOBALS['egw']->js->set_onload("xajax_eT_wrapper_init();");
|
|
$GLOBALS['egw']->js->set_onload("disable_button('exec[button][previous]');");
|
|
|
|
$sel_options = $readonlys = $preserv = array();
|
|
if($content['edit'])
|
|
unset ($content['edit']);
|
|
|
|
$this->wizard_content_template = $this->wizard_step10($content, $sel_options, $readonlys, $preserv);
|
|
$html = $this->etpl->exec(self::_appname.'.importexport_definitions_ui.wizard',$content,$sel_options,$readonlys,$preserv,1);
|
|
}
|
|
|
|
if(class_exists('xajaxResponse'))
|
|
{
|
|
$this->response = new xajaxResponse();
|
|
|
|
if ($content['closewindow'])
|
|
{
|
|
$this->response->addScript("window.close();");
|
|
$this->response->addScript("opener.location.reload();");
|
|
// If Browser can't close window we display a "close" buuton and
|
|
// need to disable normal buttons
|
|
$this->response->addAssign('exec[button][previous]','style.display', 'none');
|
|
$this->response->addAssign('exec[button][next]','style.display', 'none');
|
|
$this->response->addAssign('exec[button][finish]','style.display', 'none');
|
|
$this->response->addAssign('exec[button][cancel]','style.display', 'none');
|
|
}
|
|
$this->response->addAssign('contentbox', 'innerHTML', $html);
|
|
if (isset($GLOBALS['egw']->js) && $GLOBALS['egw']->js->body['onLoad'])
|
|
{
|
|
$this->response->addScript($GLOBALS['egw']->js->body['onLoad']);
|
|
}
|
|
$this->response->addAssign('picturebox', 'style.display', 'none');
|
|
$this->response->addScript("set_style_by_class('div','popupManual','display','inline');");
|
|
|
|
return $this->response->getXML();
|
|
}
|
|
else
|
|
{
|
|
$GLOBALS['egw']->js->set_onload("document.getElementById('picturebox').style.display = 'none';");
|
|
$GLOBALS['egw']->common->egw_header();
|
|
echo '<div id="divMain">'."\n";
|
|
echo '<div><h3>{Im|Ex}port Wizard</h3></div>';
|
|
// adding a manual icon to every popup
|
|
if ($GLOBALS['egw_info']['user']['apps']['manual'])
|
|
{
|
|
$manual = new etemplate('etemplate.popup.manual');
|
|
echo $manual->exec(self::_appname.'.importexport_definitions_ui.wizard',$content,$sel_options,$readonlys,$preserv,1);
|
|
unset($manual);
|
|
}
|
|
|
|
echo '<div id="contentbox">';
|
|
echo $html;
|
|
echo '</div></div>'."\n";
|
|
echo '<style type="text/css">#picturebox { position: absolute; right: 27px; top: 24px; }</style>'."\n";
|
|
echo '<div id="picturebox">'. $this->clock. '</div>';
|
|
return;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* gets name of next step
|
|
*
|
|
* @param string $curr_step
|
|
* @param int $step_width
|
|
* @return string containing function name of next step
|
|
*/
|
|
function get_step ($curr_step, $step_width)
|
|
{
|
|
/*if($content['plugin'] && $content['application']&& !is_object($this->plugin))
|
|
{
|
|
$plugin_definition = $this->plugins[$content['application']][$content['plugin']]['definition'];
|
|
if($plugin_definition) $this->plugin = new $plugin_definition;
|
|
}*/
|
|
if(is_object($this->plugin) && is_array($this->plugin->steps))
|
|
{
|
|
$steps = array_merge($this->steps,$this->plugin->steps);
|
|
$steps = array_flip($steps); asort($steps); $steps = array_flip($steps);
|
|
}
|
|
else
|
|
{
|
|
$steps = $this->steps;
|
|
}
|
|
$step_keys = array_keys($steps);
|
|
$nn = array_search($curr_step,$step_keys)+(int)$step_width;
|
|
return (key_exists($nn,$step_keys)) ? $step_keys[$nn] : 'wizard_finish';
|
|
}
|
|
|
|
|
|
function wizard_step10(&$content, &$sel_options, &$readonlys, &$preserv)
|
|
{
|
|
if(self::_debug) error_log('importexport.importexport_definitions_ui::wizard_step10->$content '.print_r($content,true));
|
|
|
|
// return from step10
|
|
if ($content['step'] == 'wizard_step10')
|
|
{
|
|
switch (array_search('pressed', $content['button']))
|
|
{
|
|
case 'next':
|
|
return $this->get_step($content['step'],1);
|
|
case 'finish':
|
|
return 'wizard_finish';
|
|
default :
|
|
return $this->wizard_step10($content,$sel_options,$readonlys,$preserv);
|
|
}
|
|
|
|
}
|
|
// init step10
|
|
else
|
|
{
|
|
$content['msg'] = $this->steps['wizard_step10'];
|
|
foreach ($this->plugins as $appname => $options) $sel_options['application'][$appname] = lang($appname);
|
|
$GLOBALS['egw']->js->set_onload("disable_button('exec[button][previous]');");
|
|
$content['step'] = 'wizard_step10';
|
|
$preserv = $content;
|
|
unset ($preserv['button']);
|
|
return 'importexport.wizard_chooseapp';
|
|
}
|
|
|
|
}
|
|
|
|
// get plugin
|
|
function wizard_step20(&$content, &$sel_options, &$readonlys, &$preserv)
|
|
{
|
|
if(self::_debug) error_log('importexport.' . get_class($this) . '::wizard_step20->$content '.print_r($content,true));
|
|
|
|
// return from step20
|
|
if ($content['step'] == 'wizard_step20')
|
|
{
|
|
switch (array_search('pressed', $content['button']))
|
|
{
|
|
case 'next':
|
|
// There's no real reason the plugin has to come from any of these, as long as it has a $steps variable
|
|
if($this->plugin instanceof importexport_iface_import_plugin || $this->plugin instanceof importexport_wizard_basic_import_csv) {
|
|
$content['type'] = 'import';
|
|
} elseif($this->plugin instanceof importexport_iface_export_plugin) {
|
|
$content['type'] = 'export';
|
|
} else {
|
|
throw new egw_exception('Invalid plugin');
|
|
}
|
|
return $this->get_step($content['step'],1);
|
|
case 'previous' :
|
|
unset ($content['plugin']);
|
|
if(is_object($this->response)) {
|
|
$this->response->addScript("disable_button('exec[button][previous]');");
|
|
}
|
|
return $this->get_step($content['step'],-1);
|
|
case 'finish':
|
|
return 'wizard_finish';
|
|
default :
|
|
return $this->wizard_step20($content,$sel_options,$readonlys,$preserv);
|
|
}
|
|
}
|
|
// init step20
|
|
else
|
|
{
|
|
$content['msg'] = $this->steps['wizard_step20'];
|
|
foreach ($this->plugins[$content['application']] as $type => $plugins) {
|
|
foreach($plugins as $plugin => $name) {
|
|
$sel_options['plugin'][$plugin] = $name;
|
|
}
|
|
}
|
|
$content['step'] = 'wizard_step20';
|
|
$preserv = $content;
|
|
unset ($preserv['button']);
|
|
return 'importexport.wizard_chooseplugin';
|
|
}
|
|
|
|
|
|
}
|
|
|
|
// name
|
|
function wizard_step21(&$content, &$sel_options, &$readonlys, &$preserv)
|
|
{
|
|
if(self::_debug) error_log('importexport.importexport_definitions_ui::wizard_step21->$content '.print_r($content,true));
|
|
|
|
// return from step21
|
|
if ($content['step'] == 'wizard_step21')
|
|
{
|
|
switch (array_search('pressed', $content['button']))
|
|
{
|
|
case 'next':
|
|
return $this->get_step($content['step'],1);
|
|
case 'previous' :
|
|
return $this->get_step($content['step'],-1);
|
|
case 'finish':
|
|
return 'wizard_finish';
|
|
default :
|
|
return $this->wizard_step21($content,$sel_options,$readonlys,$preserv);
|
|
}
|
|
}
|
|
// init step21
|
|
else
|
|
{
|
|
$content['msg'] = $this->steps['wizard_step21'];
|
|
$content['step'] = 'wizard_step21';
|
|
$preserv = $content;
|
|
unset ($preserv['button']);
|
|
return 'importexport.wizard_choosename';
|
|
}
|
|
}
|
|
|
|
// allowed users
|
|
function wizard_step90(&$content, &$sel_options, &$readonlys, &$preserv)
|
|
{
|
|
if(self::_debug) error_log('importexport.importexport_definitions_ui::wizard_step90->$content '.print_r($content,true));
|
|
|
|
// return from step90
|
|
if ($content['step'] == 'wizard_step90')
|
|
{
|
|
$content['allowed_users'] = implode(',',$content['allowed_users']);
|
|
|
|
// workaround for some ugly bug related to readonlys;
|
|
switch (array_search('pressed', $content['button']))
|
|
{
|
|
case 'previous' :
|
|
return $this->get_step($content['step'],-1);
|
|
case 'next':
|
|
case 'finish':
|
|
return 'wizard_finish';
|
|
default :
|
|
return $this->wizard_step90($content,$sel_options,$readonlys,$preserv);
|
|
}
|
|
}
|
|
// init step90
|
|
else
|
|
{
|
|
$content['msg'] = $this->steps['wizard_step90'];
|
|
$content['step'] = 'wizard_step90';
|
|
$preserv = $content;
|
|
unset ($preserv['button']);
|
|
$GLOBALS['egw']->js->set_onload("disable_button('exec[button][next]');");
|
|
if(is_object($this->response)) {
|
|
$this->response->addAssign('exec[button][next]','style.display', 'none');
|
|
}
|
|
return 'importexport.wizard_chooseallowedusers';
|
|
}
|
|
}
|
|
|
|
function wizard_finish(&$content)
|
|
{
|
|
if(self::_debug) error_log('importexport.importexport_definitions_ui::wizard_finish->$content '.print_r($content,true));
|
|
// Take out some UI leavings
|
|
unset($content['msg']);
|
|
unset($content['step']);
|
|
unset($content['button']);
|
|
|
|
$bodefinitions = new importexport_definitions_bo();
|
|
$bodefinitions->save($content);
|
|
// This message is displayed if browser cant close window
|
|
$content['msg'] = lang('ImportExport wizard finished successfully!');
|
|
$content['closewindow'] = true;
|
|
return 'importexport.wizard_close';
|
|
}
|
|
|
|
function import_definition($content='')
|
|
{
|
|
$bodefinitions = new importexport_definitions_bo();
|
|
if (is_array($content))
|
|
{
|
|
$bodefinitions->import($content['import_file']['tmp_name']);
|
|
// TODO make redirect here!
|
|
return $this->index();
|
|
}
|
|
else
|
|
{
|
|
$etpl = new etemplate(self::_appname.'.import_definition');
|
|
return $etpl->exec(self::_appname.'.importexport_definitions_ui.import_definition',$content,array(),$readonlys,$preserv);
|
|
}
|
|
}
|
|
}
|