* @copyright 2007-2018 PrestaShop SA * @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) * International Registered Trademark & Property of PrestaShop SA */ /** * @property WebserviceKey $object */ class AdminWebserviceControllerCore extends AdminController { /** this will be filled later */ public $fields_form = array('webservice form'); protected $toolbar_scroll = false; public function __construct() { $this->bootstrap = true; $this->table = 'webservice_account'; $this->className = 'WebserviceKey'; $this->lang = false; $this->edit = true; $this->delete = true; $this->id_lang_default = Configuration::get('PS_LANG_DEFAULT'); parent::__construct(); $this->bulk_actions = array( 'delete' => array( 'text' => $this->trans('Delete selected', array(), 'Admin.Actions'), 'confirm' => $this->trans('Delete selected items?', array(), 'Admin.Notifications.Warning'), 'icon' => 'icon-trash', ), ); $this->fields_list = array( 'key' => array( 'title' => $this->trans('Key', array(), 'Admin.Advparameters.Feature'), 'class' => 'fixed-width-md', ), 'description' => array( 'title' => $this->trans('Key description', array(), 'Admin.Advparameters.Feature'), 'align' => 'left', 'orderby' => false, ), 'active' => array( 'title' => $this->trans('Enabled', array(), 'Admin.Global'), 'align' => 'center', 'active' => 'status', 'type' => 'bool', 'orderby' => false, 'class' => 'fixed-width-xs', ), ); $this->fields_options = array( 'general' => array( 'title' => $this->trans('Configuration', array(), 'Admin.Global'), 'fields' => array( 'PS_WEBSERVICE' => array('title' => $this->trans('Enable PrestaShop\'s webservice', array(), 'Admin.Advparameters.Feature'), 'desc' => $this->trans('Before activating the webservice, you must be sure to: ', array(), 'Admin.Advparameters.Help') . '
  1. ' . $this->trans('Check that URL rewriting is available on this server.', array(), 'Admin.Advparameters.Help') . '
  2. ' . $this->trans('Check that the five methods GET, POST, PUT, DELETE and HEAD are supported by this server.', array(), 'Admin.Advparameters.Help') . '
', 'cast' => 'intval', 'type' => 'bool', ), ), 'submit' => array('title' => $this->trans('Save', array(), 'Admin.Actions')), ), ); if (!defined('_PS_HOST_MODE_')) { $this->fields_options['general']['fields']['PS_WEBSERVICE_CGI_HOST'] = array( 'title' => $this->trans('Enable CGI mode for PHP', array(), 'Admin.Advparameters.Feature'), 'desc' => $this->trans('Before choosing "Yes", check that PHP is not configured as an Apache module on your server.', array(), 'Admin.Advparameters.Help'), 'cast' => 'intval', 'type' => 'bool', ); } } public function initPageHeaderToolbar() { if (empty($this->display)) { $this->page_header_toolbar_btn['new_webservice'] = array( 'href' => self::$currentIndex . '&addwebservice_account&token=' . $this->token, 'desc' => $this->trans('Add new webservice key', array(), 'Admin.Advparameters.Feature'), 'icon' => 'process-icon-new', ); } parent::initPageHeaderToolbar(); } protected function processUpdateOptions() { parent::processUpdateOptions(); Tools::generateHtaccess(); } public function renderForm() { $this->fields_form = array( 'legend' => array( 'title' => $this->trans('Webservice Accounts', array(), 'Admin.Advparameters.Feature'), 'icon' => 'icon-lock', ), 'input' => array( array( 'type' => 'textbutton', 'label' => $this->trans('Key', array(), 'Admin.Advparameters.Feature'), 'name' => 'key', 'id' => 'code', 'required' => true, 'hint' => $this->trans('Webservice account key.', array(), 'Admin.Advparameters.Feature'), 'button' => array( 'label' => $this->trans('Generate!', array(), 'Admin.Advparameters.Feature'), 'attributes' => array( 'onclick' => 'gencode(32)', ), ), ), array( 'type' => 'textarea', 'label' => $this->trans('Key description', array(), 'Admin.Advparameters.Feature'), 'name' => 'description', 'rows' => 3, 'cols' => 110, 'hint' => $this->trans('Quick description of the key: who it is for, what permissions it has, etc.', array(), 'Admin.Advparameters.Help'), ), array( 'type' => 'switch', 'label' => $this->trans('Status', array(), 'Admin.Global'), 'name' => 'active', 'required' => false, 'is_bool' => true, 'values' => array( array( 'id' => 'active_on', 'value' => 1, 'label' => $this->trans('Enabled', array(), 'Admin.Global'), ), array( 'id' => 'active_off', 'value' => 0, 'label' => $this->trans('Disabled', array(), 'Admin.Global'), ), ), ), array( 'type' => 'resources', 'label' => $this->trans('Permissions', array(), 'Admin.Advparameters.Feature'), 'name' => 'resources', ), ), ); if (Shop::isFeatureActive()) { $this->fields_form['input'][] = array( 'type' => 'shop', 'label' => $this->trans('Shop association', array(), 'Admin.Global'), 'name' => 'checkBoxShopAsso', ); } $this->fields_form['submit'] = array( 'title' => $this->trans('Save', array(), 'Admin.Actions'), ); if (!($obj = $this->loadObject(true))) { return; } $ressources = WebserviceRequest::getResources(); $permissions = WebserviceKey::getPermissionForAccount($obj->key); $this->tpl_form_vars = array( 'ressources' => $ressources, 'permissions' => $permissions, ); return parent::renderForm(); } public function initContent() { if ($this->display != 'add' && $this->display != 'edit') { $this->checkForWarning(); } parent::initContent(); } /** * Function used to render the options for this controller. */ public function renderOptions() { if ($this->fields_options && is_array($this->fields_options)) { $helper = new HelperOptions($this); $this->setHelperDisplay($helper); $helper->toolbar_scroll = true; $helper->toolbar_btn = array('save' => array( 'href' => '#', 'desc' => $this->trans('Save', array(), 'Admin.Actions'), )); $helper->id = $this->id; $helper->tpl_vars = $this->tpl_option_vars; $options = $helper->generateOptions($this->fields_options); return $options; } } public function initProcess() { parent::initProcess(); // This is a composite page, we don't want the "options" display mode if ($this->display == 'options') { $this->display = ''; } } public function postProcess() { if (Tools::getValue('key') && strlen(Tools::getValue('key')) < 32) { $this->errors[] = $this->trans('Key length must be 32 character long.', array(), 'Admin.Advparameters.Notification'); } if (WebserviceKey::keyExists(Tools::getValue('key')) && !Tools::getValue('id_webservice_account')) { $this->errors[] = $this->trans('This key already exists.', array(), 'Admin.Advparameters.Notification'); } return parent::postProcess(); } protected function afterAdd($object) { Tools::generateHtaccess(); WebserviceKey::setPermissionForAccount($object->id, Tools::getValue('resources', array())); } protected function afterUpdate($object) { Tools::generateHtaccess(); WebserviceKey::setPermissionForAccount($object->id, Tools::getValue('resources', array())); } public function checkForWarning() { if (strpos($_SERVER['SERVER_SOFTWARE'], 'Apache') === false) { $this->warnings[] = $this->trans('To avoid operating problems, please use an Apache server.', array(), 'Admin.Advparameters.Notification'); if (function_exists('apache_get_modules')) { $apache_modules = apache_get_modules(); if (!in_array('mod_auth_basic', $apache_modules)) { $this->warnings[] = $this->trans('Please activate the \'mod_auth_basic\' Apache module to allow authentication of PrestaShop\'s webservice.', array(), 'Admin.Advparameters.Notification'); } if (!in_array('mod_rewrite', $apache_modules)) { $this->warnings[] = $this->trans('Please activate the \'mod_rewrite\' Apache module to allow the PrestaShop webservice.', array(), 'Admin.Advparameters.Notification'); } } else { $this->warnings[] = $this->trans('We could not check to see if basic authentication and rewrite extensions have been activated. Please manually check if they\'ve been activated in order to use the PrestaShop webservice.', array(), 'Admin.Advparameters.Notification'); } } if (!extension_loaded('SimpleXML')) { $this->warnings[] = $this->trans('Please activate the \'SimpleXML\' PHP extension to allow testing of PrestaShop\'s webservice.', array(), 'Admin.Advparameters.Notification'); } if (!configuration::get('PS_SSL_ENABLED')) { $this->warnings[] = $this->trans('It is preferable to use SSL (https:) for webservice calls, as it avoids the "man in the middle" type security issues.', array(), 'Admin.Advparameters.Notification'); } foreach ($this->_list as $k => $item) { if ($item['is_module'] && $item['class_name'] && $item['module_name'] && ($instance = Module::getInstanceByName($item['module_name'])) && !$instance->useNormalPermissionBehaviour()) { unset($this->_list[$k]); } } $this->renderList(); } }