* @copyright 2007-2015 PrestaShop SA
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
/**
* @property RequestSql $object
*/
class AdminRequestSqlControllerCore extends AdminController
{
/**
* @var array : List of encoding type for a file
*/
public static $encoding_file = array(
array('value' => 1, 'name' => 'utf-8'),
array('value' => 2, 'name' => 'iso-8859-1')
);
public function __construct()
{
$this->bootstrap = true;
$this->table = 'request_sql';
$this->className = 'RequestSql';
$this->lang = false;
$this->export = true;
$this->context = Context::getContext();
$this->fields_list = array(
'id_request_sql' => array('title' => $this->l('ID'), 'class' => 'fixed-width-xs'),
'name' => array('title' => $this->l('SQL query Name')),
'sql' => array('title' => $this->l('SQL query'))
);
$this->fields_options = array(
'general' => array(
'title' => $this->l('Settings'),
'fields' => array(
'PS_ENCODING_FILE_MANAGER_SQL' => array(
'title' => $this->l('Select your default file encoding'),
'cast' => 'intval',
'type' => 'select',
'identifier' => 'value',
'list' => self::$encoding_file,
'visibility' => Shop::CONTEXT_ALL
)
),
'submit' => array('title' => $this->l('Save'))
)
);
$this->bulk_actions = array(
'delete' => array(
'text' => $this->l('Delete selected'),
'confirm' => $this->l('Delete selected items?'),
'icon' => 'icon-trash'
)
);
parent::__construct();
}
public function renderOptions()
{
// Set toolbar options
$this->display = 'options';
$this->show_toolbar = true;
$this->toolbar_scroll = true;
$this->initToolbar();
return parent::renderOptions();
}
public function initToolbar()
{
if ($this->display == 'view' && $id_request = Tools::getValue('id_request_sql')) {
$this->toolbar_btn['edit'] = array(
'href' => self::$currentIndex.'&updaterequest_sql&token='.$this->token.'&id_request_sql='.(int)$id_request,
'desc' => $this->l('Edit this SQL query')
);
}
parent::initToolbar();
if ($this->display == 'options') {
unset($this->toolbar_btn['new']);
}
}
public function renderList()
{
// Set toolbar options
$this->display = null;
$this->initToolbar();
$this->displayWarning($this->l('When saving the query, only the "SELECT" SQL statement is allowed.'));
$this->displayInformation('
'.$this->l('How do I create a new SQL query?').'
- '.$this->l('Click "Add New".').'
- '.$this->l('Fill in the fields and click "Save".').'
- '.$this->l('You can then view the query results by clicking on the Edit action in the dropdown menu: ').'
- '.$this->l('You can also export the query results as a CSV file by clicking on the Export button: ').'
');
$this->addRowAction('export');
$this->addRowAction('view');
$this->addRowAction('edit');
$this->addRowAction('delete');
return parent::renderList();
}
public function renderForm()
{
$this->fields_form = array(
'legend' => array(
'title' => $this->l('SQL query'),
'icon' => 'icon-cog'
),
'input' => array(
array(
'type' => 'text',
'label' => $this->l('SQL query name'),
'name' => 'name',
'size' => 103,
'required' => true
),
array(
'type' => 'textarea',
'label' => $this->l('SQL query'),
'name' => 'sql',
'cols' => 100,
'rows' => 10,
'required' => true
)
),
'submit' => array(
'title' => $this->l('Save')
)
);
$request = new RequestSql();
$this->tpl_form_vars = array('tables' => $request->getTables());
return parent::renderForm();
}
public function postProcess()
{
/* PrestaShop demo mode */
if (_PS_MODE_DEMO_) {
$this->errors[] = Tools::displayError('This functionality has been disabled.');
return;
}
return parent::postProcess();
}
/**
* method call when ajax request is made with the details row action
* @see AdminController::postProcess()
*/
public function ajaxProcess()
{
/* PrestaShop demo mode */
if (_PS_MODE_DEMO_) {
die(Tools::displayError('This functionality has been disabled.'));
}
if ($table = Tools::GetValue('table')) {
$request_sql = new RequestSql();
$attributes = $request_sql->getAttributesByTable($table);
foreach ($attributes as $key => $attribute) {
unset($attributes[$key]['Null']);
unset($attributes[$key]['Key']);
unset($attributes[$key]['Default']);
unset($attributes[$key]['Extra']);
}
die(Tools::jsonEncode($attributes));
}
}
public function renderView()
{
/** @var RequestSql $obj */
if (!($obj = $this->loadObject(true))) {
return;
}
$view = array();
if ($results = Db::getInstance()->executeS($obj->sql)) {
foreach (array_keys($results[0]) as $key) {
$tab_key[] = $key;
}
$view['name'] = $obj->name;
$view['key'] = $tab_key;
$view['results'] = $results;
$this->toolbar_title = $obj->name;
$request_sql = new RequestSql();
$view['attributes'] = $request_sql->attributes;
} else {
$view['error'] = true;
}
$this->tpl_view_vars = array(
'view' => $view
);
return parent::renderView();
}
public function _childValidation()
{
if (Tools::getValue('submitAdd'.$this->table) && $sql = Tools::getValue('sql')) {
$request_sql = new RequestSql();
$parser = $request_sql->parsingSql($sql);
$validate = $request_sql->validateParser($parser, false, $sql);
if (!$validate || count($request_sql->error_sql)) {
$this->displayError($request_sql->error_sql);
}
}
}
/**
* Display export action link
*
* @param $token
* @param int $id
*
* @return string
* @throws Exception
* @throws SmartyException
*/
public function displayExportLink($token, $id)
{
$tpl = $this->createTemplate('list_action_export.tpl');
$tpl->assign(array(
'href' => self::$currentIndex.'&token='.$this->token.'&'.$this->identifier.'='.$id.'&export'.$this->table.'=1',
'action' => $this->l('Export')
));
return $tpl->fetch();
}
public function initProcess()
{
parent::initProcess();
if (Tools::getValue('export'.$this->table)) {
$this->display = 'export';
$this->action = 'export';
}
}
public function initContent()
{
$this->initTabModuleList();
// toolbar (save, cancel, new, ..)
$this->initToolbar();
$this->initPageHeaderToolbar();
if ($this->display == 'edit' || $this->display == 'add') {
if (!$this->loadObject(true)) {
return;
}
$this->content .= $this->renderForm();
} elseif ($this->display == 'view') {
// Some controllers use the view action without an object
if ($this->className) {
$this->loadObject(true);
}
$this->content .= $this->renderView();
} elseif ($this->display == 'export') {
$this->generateExport();
} elseif (!$this->ajax) {
$this->content .= $this->renderList();
$this->content .= $this->renderOptions();
}
$this->context->smarty->assign(array(
'content' => $this->content,
'url_post' => self::$currentIndex.'&token='.$this->token,
'show_page_header_toolbar' => $this->show_page_header_toolbar,
'page_header_toolbar_title' => $this->page_header_toolbar_title,
'page_header_toolbar_btn' => $this->page_header_toolbar_btn
));
}
public function initPageHeaderToolbar()
{
if (empty($this->display)) {
$this->page_header_toolbar_btn['new_request'] = array(
'href' => self::$currentIndex.'&addrequest_sql&token='.$this->token,
'desc' => $this->l('Add new SQL query', null, null, false),
'icon' => 'process-icon-new'
);
}
parent::initPageHeaderToolbar();
}
/**
* Genrating a export file
*/
public function generateExport()
{
$id = Tools::getValue($this->identifier);
$export_dir = defined('_PS_HOST_MODE_') ? _PS_ROOT_DIR_.'/export/' : _PS_ADMIN_DIR_.'/export/';
if (!Validate::isFileName($id)) {
die(Tools::displayError());
}
$file = 'request_sql_'.$id.'.csv';
if ($csv = fopen($export_dir.$file, 'w')) {
$sql = RequestSql::getRequestSqlById($id);
if ($sql) {
$results = Db::getInstance()->executeS($sql[0]['sql']);
foreach (array_keys($results[0]) as $key) {
$tab_key[] = $key;
fputs($csv, $key.';');
}
foreach ($results as $result) {
fputs($csv, "\n");
foreach ($tab_key as $name) {
fputs($csv, '"'.strip_tags($result[$name]).'";');
}
}
if (file_exists($export_dir.$file)) {
$filesize = filesize($export_dir.$file);
$upload_max_filesize = Tools::convertBytes(ini_get('upload_max_filesize'));
if ($filesize < $upload_max_filesize) {
if (Configuration::get('PS_ENCODING_FILE_MANAGER_SQL')) {
$charset = Configuration::get('PS_ENCODING_FILE_MANAGER_SQL');
} else {
$charset = self::$encoding_file[0]['name'];
}
header('Content-Type: text/csv; charset='.$charset);
header('Cache-Control: no-store, no-cache');
header('Content-Disposition: attachment; filename="'.$file.'"');
header('Content-Length: '.$filesize);
readfile($export_dir.$file);
die();
} else {
$this->errors[] = Tools::DisplayError('The file is too large and can not be downloaded. Please use the LIMIT clause in this query.');
}
}
}
}
}
/**
* Display all errors
*
* @param $e : array of errors
*/
public function displayError($e)
{
foreach (array_keys($e) as $key) {
switch ($key) {
case 'checkedFrom':
if (isset($e[$key]['table'])) {
$this->errors[] = sprintf(Tools::displayError('The "%s" table does not exist.'), $e[$key]['table']);
} elseif (isset($e[$key]['attribut'])) {
$this->errors[] = sprintf(
Tools::displayError('The "%1$s" attribute does not exist in the "%2$s" table.'),
$e[$key]['attribut'][0],
$e[$key]['attribut'][1]
);
} else {
$this->errors[] = Tools::displayError('Undefined "checkedFrom" error');
}
break;
case 'checkedSelect':
if (isset($e[$key]['table'])) {
$this->errors[] = sprintf(Tools::displayError('The "%s" table does not exist.'), $e[$key]['table']);
} elseif (isset($e[$key]['attribut'])) {
$this->errors[] = sprintf(
Tools::displayError('The "%1$s" attribute does not exist in the "%2$s" table.'),
$e[$key]['attribut'][0],
$e[$key]['attribut'][1]
);
} elseif (isset($e[$key]['*'])) {
$this->errors[] = Tools::displayError('The "*" operator cannot be used in a nested query.');
} else {
$this->errors[] = Tools::displayError('Undefined "checkedSelect" error');
}
break;
case 'checkedWhere':
if (isset($e[$key]['operator'])) {
$this->errors[] = sprintf(Tools::displayError('The operator "%s" is incorrect.'), $e[$key]['operator']);
} elseif (isset($e[$key]['attribut'])) {
$this->errors[] = sprintf(
Tools::displayError('The "%1$s" attribute does not exist in the "%2$s" table.'),
$e[$key]['attribut'][0],
$e[$key]['attribut'][1]
);
} else {
$this->errors[] = Tools::displayError('Undefined "checkedWhere" error');
}
break;
case 'checkedHaving':
if (isset($e[$key]['operator'])) {
$this->errors[] = sprintf(Tools::displayError('The "%s" operator is incorrect.'), $e[$key]['operator']);
} elseif (isset($e[$key]['attribut'])) {
$this->errors[] = sprintf(
Tools::displayError('The "%1$s" attribute does not exist in the "%2$s" table.'),
$e[$key]['attribut'][0],
$e[$key]['attribut'][1]
);
} else {
$this->errors[] = Tools::displayError('Undefined "checkedHaving" error');
}
break;
case 'checkedOrder':
if (isset($e[$key]['attribut'])) {
$this->errors[] = sprintf(
Tools::displayError('The "%1$s" attribute does not exist in the "%2$s" table.'),
$e[$key]['attribut'][0],
$e[$key]['attribut'][1]
);
} else {
$this->errors[] = Tools::displayError('Undefined "checkedOrder" error');
}
break;
case 'checkedGroupBy':
if (isset($e[$key]['attribut'])) {
$this->errors[] = sprintf(
Tools::displayError('The "%1$s" attribute does not exist in the "%2$s" table.'),
$e[$key]['attribut'][0],
$e[$key]['attribut'][1]
);
} else {
$this->errors[] = Tools::displayError('Undefined "checkedGroupBy" error');
}
break;
case 'checkedLimit':
$this->errors[] = Tools::displayError('The LIMIT clause must contain numeric arguments.');
break;
case 'returnNameTable':
if (isset($e[$key]['reference'])) {
$this->errors[] = sprintf(
Tools::displayError('The "%1$s" reference does not exist in the "%2$s" table.'),
$e[$key]['reference'][0],
$e[$key]['attribut'][1]
);
} else {
$this->errors[] = Tools::displayError('When multiple tables are used, each attribute must refer back to a table.');
}
break;
case 'testedRequired':
$this->errors[] = sprintf(Tools::displayError('%s does not exist.'), $e[$key]);
break;
case 'testedUnauthorized':
$this->errors[] = sprintf(Tools::displayError('Is an unauthorized keyword.'), $e[$key]);
break;
}
}
}
}