diff --git a/phpBB/adm/style/acp_storage.html b/phpBB/adm/style/acp_storage.html new file mode 100644 index 0000000000..4689a7546d --- /dev/null +++ b/phpBB/adm/style/acp_storage.html @@ -0,0 +1,76 @@ +{% include 'overall_header.html' %} + + + +

{{ lang('STORAGE_TITLE') }}

+ +

{{ lang('STORAGE_TITLE_EXPLAIN') }}

+ +
+ + {% for storage in STORAGES %} +
+ {{ lang('STORAGE_' ~ storage.get_name | upper ~ '_TITLE') }} +
+

{{ lang('STORAGE_SELECT_DESC') }}
+
+ +
+
+
+ + {% for provider in PROVIDERS if provider.is_available %} +
+ {{ lang('STORAGE_' ~ storage.get_name | upper ~ '_TITLE') }} - {{ lang('STORAGE_ADAPTER_' ~ provider.get_name | upper ~ '_NAME') }} + {% for name, options in provider.get_options %} + {% set title = 'STORAGE_ADAPTER_' ~ provider.get_name | upper ~ '_OPTION_' ~ name | upper %} + {% set description = 'STORAGE_ADAPTER_' ~ provider.get_name | upper ~ '_OPTION_' ~ name | upper ~ '_EXPLAIN' %} + {% set input_id = storage.get_name ~ '_' ~ provider.get_name ~ '_' ~ name %} + {% set input_type = options['type'] %} + {% set input_name = storage.get_name ~ '[' ~ name ~ ']' %} + {% set input_value = attribute(config, 'storage\\' ~ storage.get_name ~ '\\config\\' ~ name) %} +
+
+ + {% if lang_defined(description) %} +
{{ lang(description) }} + {% endif %} +
+
+ {% if input_type in ['text', 'password', 'email'] %} + + {% elseif input_type == 'textarea' %} + + {% elseif input_type == 'radio' %} + {% for option_name, option_value in options['options'] %} + {{ lang(option_name) }} + {% endfor %} + {% elseif input_type == 'select' %} + + {% endif %} +
+
+ {% endfor %} +
+ {% endfor %} + {% endfor %} + +
+ {{ lang('SUBMIT') }} +   + + {{ S_FORM_TOKEN }} +
+
+ +{% include 'overall_footer.html' %} diff --git a/phpBB/config/default/container/services_storage.yml b/phpBB/config/default/container/services_storage.yml index 32b74687c9..3593b8264a 100644 --- a/phpBB/config/default/container/services_storage.yml +++ b/phpBB/config/default/container/services_storage.yml @@ -18,6 +18,13 @@ services: - '@storage.provider_collection' # Collections + storage.storage_collection: + class: phpbb\di\service_collection + arguments: + - '@service_container' + tags: + - { name: service_collection, tag: storage } + storage.adapter_collection: class: phpbb\di\service_collection arguments: diff --git a/phpBB/config/default/container/services_twig.yml b/phpBB/config/default/container/services_twig.yml index e9c0360436..c7ce82632a 100644 --- a/phpBB/config/default/container/services_twig.yml +++ b/phpBB/config/default/container/services_twig.yml @@ -15,6 +15,7 @@ services: - [] calls: - [setLexer, ['@template.twig.lexer']] + - [addGlobal, ['config', '@config']] template.twig.lexer: class: phpbb\template\twig\lexer diff --git a/phpBB/includes/acp/acp_storage.php b/phpBB/includes/acp/acp_storage.php new file mode 100644 index 0000000000..b2647843f1 --- /dev/null +++ b/phpBB/includes/acp/acp_storage.php @@ -0,0 +1,318 @@ + +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +class acp_storage +{ + /** @var \phpbb\config $config */ + protected $config; + + /** @var \phpbb\language\language $lang */ + protected $lang; + + /** @var \phpbb\request\request */ + protected $request; + + /** @var \phpbb\template\template */ + protected $template; + + /** @var \phpbb\user */ + protected $user; + + /** @var \phpbb\di\service_collection */ + protected $provider_collection; + + /** @var \phpbb\di\service_collection */ + protected $storage_collection; + + /** @var string */ + public $page_title; + + /** @var string */ + public $tpl_name; + + /** @var string */ + public $u_action; + + /** + * @param string $id + * @param string $mode + */ + public function main($id, $mode) + { + global $phpbb_container, $phpbb_dispatcher; + + $this->config = $phpbb_container->get('config'); + $this->lang = $phpbb_container->get('language'); + $this->request = $phpbb_container->get('request'); + $this->template = $phpbb_container->get('template'); + $this->user = $phpbb_container->get('user'); + $this->provider_collection = $phpbb_container->get('storage.provider_collection'); + $this->storage_collection = $phpbb_container->get('storage.storage_collection'); + + // Add necesary language files + $this->lang->add_lang(['acp/storage']); + + /** + * Add language strings + * + * @event core.acp_storage_load + * @since 3.3.0-a1 + */ + $phpbb_dispatcher->dispatch('core.acp_storage_load'); + + $this->overview($id, $mode); + } + + /** + * @param string $id + * @param string $mode + */ + public function overview($id, $mode) + { + $form_key = 'acp_storage'; + add_form_key($form_key); + + // Template from adm/style + $this->tpl_name = 'acp_storage'; + + // Set page title + $this->page_title = 'STORAGE_TITLE'; + + if ($this->request->is_set_post('submit')) + { + $modified_storages = []; + $messages = []; + + if (!check_form_key($form_key)) + { + $messages[] = $this->lang->lang('FORM_INVALID'); + } + + foreach ($this->storage_collection as $storage) + { + $storage_name = $storage->get_name(); + + $options = $this->get_provider_options($this->get_current_provider($storage_name)); + + $modified = false; + + // Check if provider have been modified + if ($this->get_new_provider($storage_name) != $this->get_current_provider($storage_name)) + { + $modified = true; + } + + // Check if options have been modified + if (!$modified) + { + foreach (array_keys($options) as $definition) + { + if ($this->get_new_definition($storage_name, $definition) != $this->get_current_definition($storage_name, $definition)) + { + $modified = true; + break; + } + } + } + + // If the storage have been modified, validate options + if ($modified) + { + $modified_storages[] = $storage_name; + $this->validate_data($storage_name, $messages); + } + } + + if (!empty($modified_storages)) + { + if (empty($messages)) + { + foreach ($modified_storages as $storage_name) + { + $this->update_storage_config($storage_name); + } + + trigger_error($this->lang->lang('STORAGE_UPDATE_SUCCESSFUL') . adm_back_link($this->u_action), E_USER_NOTICE); + } + else + { + trigger_error(implode('
', $messages) . adm_back_link($this->u_action), E_USER_WARNING); + } + } + + // If there is no errors + trigger_error($this->lang->lang('STORAGE_NO_CHANGES') . adm_back_link($this->u_action), E_USER_WARNING); + } + + $this->template->assign_vars(array( + 'STORAGES' => $this->storage_collection, + 'PROVIDERS' => $this->provider_collection, + )); + } + + /** + * Get the current provider from config + * + * @param string $key Storage name + * @return string The current provider + */ + protected function get_current_provider($storage_name) + { + return $this->config['storage\\' . $storage_name . '\\provider']; + } + + /** + * Get the new provider from the request + * + * @param string $key Storage name + * @return string The new provider + */ + protected function get_new_provider($storage_name) + { + return $this->request->variable([$storage_name, 'provider'], ''); + } + + /** + * Get adapter definitions from a provider + * + * @param string $provider Provider class + * @return array Adapter definitions + */ + protected function get_provider_options($provider) + { + return $this->provider_collection->get_by_class($provider)->get_options(); + } + + /** + * Get the current value of the definition of a storage from config + * + * @param string $storage_name Storage name + * @param string $definition Definition + * @return string Definition value + */ + protected function get_current_definition($storage_name, $definition) + { + return $this->config['storage\\' . $storage_name . '\\config\\' . $definition]; + } + + /** + * Get the new value of the definition of a storage from the request + * + * @param string $storage_name Storage name + * @param string $definition Definition + * @return string Definition value + */ + protected function get_new_definition($storage_name, $definition) + { + return $this->request->variable([$storage_name, $definition], ''); + } + + /** + * Validates data + * + * @param string $storage_name Storage name + * @param array $messages Reference to messages array + */ + protected function validate_data($storage_name, &$messages) + { + $storage_title = $this->lang->lang('STORAGE_' . strtoupper($storage_name) . '_TITLE'); + + // Check if provider exists + try + { + $new_provider = $this->provider_collection->get_by_class($this->get_new_provider($storage_name)); + } + catch (\Exception $e) + { + $messages[] = $this->lang->lang('STORAGE_PROVIDER_NOT_EXISTS', $storage_title); + return; + } + + // Check if provider is available + if (!$new_provider->is_available()) + { + $messages[] = $this->lang->lang('STORAGE_PROVIDER_NOT_AVAILABLE', $storage_title); + return; + } + + // Check options + $new_options = $this->get_provider_options($this->get_new_provider($storage_name)); + + foreach ($new_options as $definition_key => $definition_value) + { + $provider = $this->provider_collection->get_by_class($this->get_new_provider($storage_name)); + $definition_title = $this->lang->lang('STORAGE_ADAPTER_' . strtoupper($provider->get_name()) . '_OPTION_' . strtoupper($definition_key)); + + $value = $this->get_new_definition($storage_name, $definition_key); + + switch ($definition_value['type']) + { + case 'email': + if (!filter_var($value, FILTER_VALIDATE_EMAIL)) + { + $messages[] = $this->lang->lang('STORAGE_FORM_TYPE_EMAIL_INCORRECT_FORMAT', $definition_title, $storage_title); + } + case 'text': + case 'password': + $maxlength = isset($definition_value['maxlength']) ? $definition_value['maxlength'] : 255; + if (strlen($value) > $maxlength) + { + $messages[] = $this->lang->lang('STORAGE_FORM_TYPE_TEXT_TOO_LONG', $definition_title, $storage_title); + } + break; + case 'radio': + case 'select': + if (!in_array($value, array_values($definition_value['options']))) + { + $messages[] = $this->lang->lang('STORAGE_FORM_TYPE_SELECT_NOT_AVAILABLE', $definition_title, $storage_title); + } + break; + } + } + } + + /** + * Updates an storage with the info provided in the form + * + * @param string $storage_name Storage name + */ + protected function update_storage_config($storage_name) + { + $current_options = $this->get_provider_options($this->get_current_provider($storage_name)); + + // Remove old storage config + foreach (array_keys($current_options) as $definition) + { + $this->config->delete('storage\\' . $storage_name . '\\config\\' . $definition); + } + + // Update provider + $this->config->set('storage\\' . $storage_name . '\\provider', $this->get_new_provider($storage_name)); + + // Set new storage config + $new_options = $this->get_provider_options($this->get_new_provider($storage_name)); + + foreach (array_keys($new_options) as $definition) + { + $this->config->set('storage\\' . $storage_name . '\\config\\' . $definition, $this->get_new_definition($storage_name, $definition)); + } + } +} diff --git a/phpBB/includes/acp/info/acp_storage.php b/phpBB/includes/acp/info/acp_storage.php new file mode 100644 index 0000000000..25807be91f --- /dev/null +++ b/phpBB/includes/acp/info/acp_storage.php @@ -0,0 +1,34 @@ + +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +class acp_storage_info +{ + function module() + { + return array( + 'filename' => 'acp_storage', + 'title' => 'ACP_STORAGE', + 'modes' => array( + 'settings' => array('title' => 'ACP_STORAGE_SETTINGS', 'auth' => 'acl_a_storage', 'cat' => array('ACP_SERVER_CONFIGURATION')), + ), + ); + } + + function install() + { + } + + function uninstall() + { + } +} diff --git a/phpBB/install/schemas/schema_data.sql b/phpBB/install/schemas/schema_data.sql index fbe36bee05..b965d2e784 100644 --- a/phpBB/install/schemas/schema_data.sql +++ b/phpBB/install/schemas/schema_data.sql @@ -407,6 +407,7 @@ INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_reasons', 1); INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_roles', 1); INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_search', 1); INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_server', 1); +INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_storage', 1); INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_styles', 1); INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_switchperm', 1); INSERT INTO phpbb_acl_options (auth_option, is_global) VALUES ('a_uauth', 1); @@ -522,7 +523,7 @@ INSERT INTO phpbb_ranks (rank_title, rank_min, rank_special, rank_image) VALUES # -- Roles data # Standard Admin (a_) -INSERT INTO phpbb_acl_roles_data (role_id, auth_option_id, auth_setting) SELECT 1, auth_option_id, 1 FROM phpbb_acl_options WHERE auth_option LIKE 'a_%' AND auth_option NOT IN ('a_switchperm', 'a_jabber', 'a_phpinfo', 'a_server', 'a_backup', 'a_styles', 'a_clearlogs', 'a_modules', 'a_language', 'a_email', 'a_bots', 'a_search', 'a_aauth', 'a_roles'); +INSERT INTO phpbb_acl_roles_data (role_id, auth_option_id, auth_setting) SELECT 1, auth_option_id, 1 FROM phpbb_acl_options WHERE auth_option LIKE 'a_%' AND auth_option NOT IN ('a_switchperm', 'a_jabber', 'a_phpinfo', 'a_server', 'a_backup', 'a_styles', 'a_clearlogs', 'a_modules', 'a_language', 'a_email', 'a_bots', 'a_search', 'a_storage', 'a_aauth', 'a_roles'); # Forum admin (a_) INSERT INTO phpbb_acl_roles_data (role_id, auth_option_id, auth_setting) SELECT 2, auth_option_id, 1 FROM phpbb_acl_options WHERE auth_option LIKE 'a_%' AND auth_option IN ('a_', 'a_authgroups', 'a_authusers', 'a_fauth', 'a_forum', 'a_forumadd', 'a_forumdel', 'a_mauth', 'a_prune', 'a_uauth', 'a_viewauth', 'a_viewlogs'); diff --git a/phpBB/language/en/acp/common.php b/phpBB/language/en/acp/common.php index 8cc87dd892..a371c27d8e 100644 --- a/phpBB/language/en/acp/common.php +++ b/phpBB/language/en/acp/common.php @@ -178,6 +178,9 @@ $lang = array_merge($lang, array( 'ACP_SERVER_SETTINGS' => 'Server settings', 'ACP_SIGNATURE_SETTINGS' => 'Signature settings', 'ACP_SMILIES' => 'Smilies', + + 'ACP_STORAGE_SETTINGS' => 'Storage settings', + 'ACP_STYLE_MANAGEMENT' => 'Style management', 'ACP_STYLES' => 'Styles', 'ACP_STYLES_CACHE' => 'Purge Cache', diff --git a/phpBB/language/en/acp/storage.php b/phpBB/language/en/acp/storage.php new file mode 100644 index 0000000000..638df2177e --- /dev/null +++ b/phpBB/language/en/acp/storage.php @@ -0,0 +1,64 @@ + +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +/** +* DO NOT CHANGE +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +if (empty($lang) || !is_array($lang)) +{ + $lang = array(); +} + +// DEVELOPERS PLEASE NOTE +// +// All language files should use UTF-8 as their encoding and the files must not contain a BOM. +// +// Placeholders can now contain order information, e.g. instead of +// 'Page %s of %s' you can (and should) write 'Page %1$s of %2$s', this allows +// translators to re-order the output of data while ensuring it remains correct +// +// You do not need this where single placeholders are used, e.g. 'Message %d' is fine +// equally where a string contains only two placeholders which are used to wrap text +// in a url you again do not need to specify an order e.g., 'Click %sHERE%s' is fine + +$lang = array_merge($lang, array( + + // Template + 'STORAGE_TITLE' => 'Storage Settings', + 'STORAGE_TITLE_EXPLAIN' => 'Change storage providers for the file storage types of phpBB. Choose local or remote providers to store files added to or created by phpBB.', + 'STORAGE_SELECT' => 'Select storage', + 'STORAGE_SELECT_DESC' => 'Select a storage from the list.', + + // Storage names + 'STORAGE_ATTACHMENT_TITLE' => 'Attachments storage', + 'STORAGE_AVATAR_TITLE' => 'Avatars storage', + 'STORAGE_BACKUP_TITLE' => 'Backup storage', + + // Local adapter + 'STORAGE_ADAPTER_LOCAL_NAME' => 'Local', + 'STORAGE_ADAPTER_LOCAL_OPTION_PATH' => 'Path', + + // Form validation + 'STORAGE_UPDATE_SUCCESSFUL' => 'All storage types were successfully updated.', + 'STORAGE_NO_CHANGES' => 'No changes have been applied.', + 'STORAGE_PROVIDER_NOT_EXISTS' => 'Provider selected for %s doesn’t exist.', + 'STORAGE_PROVIDER_NOT_AVAILABLE' => 'Provider selected for %s is not available.', + 'STORAGE_FORM_TYPE_EMAIL_INCORRECT_FORMAT' => 'Incorrect email for %s of %s.', + 'STORAGE_FORM_TYPE_TEXT_TOO_LONG' => 'Text is too long for %s of %s.', + 'STORAGE_FORM_TYPE_SELECT_NOT_AVAILABLE' => 'Selected value is not available for %s of %s.', +)); diff --git a/phpBB/phpbb/storage/adapter_factory.php b/phpBB/phpbb/storage/adapter_factory.php index 4b27269524..6be702c0c8 100644 --- a/phpBB/phpbb/storage/adapter_factory.php +++ b/phpBB/phpbb/storage/adapter_factory.php @@ -83,9 +83,9 @@ class adapter_factory { $options = []; - foreach ($definitions as $def) + foreach (array_keys($definitions) as $definition) { - $options[$def] = $this->config['storage\\' . $storage_name . '\\config\\' . $def]; + $options[$definition] = $this->config['storage\\' . $storage_name . '\\config\\' . $definition]; } return $options; diff --git a/phpBB/phpbb/storage/provider/local.php b/phpBB/phpbb/storage/provider/local.php index 370178cf47..7ec94d3d2e 100644 --- a/phpBB/phpbb/storage/provider/local.php +++ b/phpBB/phpbb/storage/provider/local.php @@ -15,6 +15,14 @@ namespace phpbb\storage\provider; class local implements provider_interface { + /** + * {@inheritdoc} + */ + public function get_name() + { + return 'local'; + } + /** * {@inheritdoc} */ @@ -28,7 +36,7 @@ class local implements provider_interface */ public function get_options() { - return ['path']; + return ['path' => array('type' => 'text')]; } /** diff --git a/phpBB/phpbb/storage/provider/provider_interface.php b/phpBB/phpbb/storage/provider/provider_interface.php index d2e78d907f..a61845bccc 100644 --- a/phpBB/phpbb/storage/provider/provider_interface.php +++ b/phpBB/phpbb/storage/provider/provider_interface.php @@ -15,6 +15,13 @@ namespace phpbb\storage\provider; interface provider_interface { + /** + * Gets adapter name. + * + * @return string + */ + public function get_name(); + /** * Gets adapter class. * diff --git a/phpBB/phpbb/storage/storage.php b/phpBB/phpbb/storage/storage.php index 089ccce737..a380f93663 100644 --- a/phpBB/phpbb/storage/storage.php +++ b/phpBB/phpbb/storage/storage.php @@ -45,6 +45,16 @@ class storage $this->storage_name = $storage_name; } + /** + * Returns storage name + * + * @return string + */ + public function get_name() + { + return $this->storage_name; + } + /** * Returns an adapter instance * diff --git a/phpBB/phpbb/template/twig/extension.php b/phpBB/phpbb/template/twig/extension.php index b2e2edb102..da290529c5 100644 --- a/phpBB/phpbb/template/twig/extension.php +++ b/phpBB/phpbb/template/twig/extension.php @@ -86,6 +86,7 @@ class extension extends \Twig_Extension return array( new \Twig_SimpleFunction('lang', array($this, 'lang')), new \Twig_SimpleFunction('lang_defined', array($this, 'lang_defined')), + new \Twig_SimpleFunction('get_class', array($this, 'get_class')), ); } @@ -185,12 +186,24 @@ class extension extends \Twig_Extension } /** - * Check if a language variable exists - * - * @return bool - */ + * Check if a language variable exists + * + * @return bool + */ public function lang_defined($key) { return call_user_func_array([$this->language, 'is_set'], [$key]); } + + /* + * Returns the name of the class of an object + * + * @param object $object The object + * + * @return string + */ + public function get_class($object) + { + return get_class($object); + } }