diff --git a/actions/DisplayAction.php b/actions/DisplayAction.php index d8baf016..005333f2 100644 --- a/actions/DisplayAction.php +++ b/actions/DisplayAction.php @@ -43,7 +43,7 @@ class DisplayAction implements ActionInterface $noproxy = array_key_exists('_noproxy', $request) && filter_var($request['_noproxy'], FILTER_VALIDATE_BOOLEAN); - if (defined('PROXY_URL') && PROXY_BYBRIDGE && $noproxy) { + if (Configuration::getConfig('proxy', 'url') && Configuration::getConfig('proxy', 'by_bridge') && $noproxy) { define('NOPROXY', true); } diff --git a/docs/02_CLI/index.md b/docs/02_CLI/index.md index 9cbbf63c..9292746a 100644 --- a/docs/02_CLI/index.md +++ b/docs/02_CLI/index.md @@ -27,9 +27,9 @@ This parameter specifies the format in which RSS-Bridge returns the contents. RS RSS-Bridge supports optional parameters. These parameters are only valid if the options have been enabled in the index.php script. -### _noproxy +### \_noproxy -This parameter is only available if a proxy server has been specified via `PROXY_URL` and 'PROXY_BYBRIDGE' has been enabled. This is a Boolean parameter that can be set to '1' (true) or '0' (false). +This parameter is only available if a proxy server has been specified via `proxy.url` and `proxy.by_bridge` has been enabled. This is a Boolean parameter that can be set to `true` or `false`. ## Bridge parameters diff --git a/docs/03_For_Hosts/07_Customizations.md b/docs/03_For_Hosts/07_Customizations.md index ffc60990..be4c7f85 100644 --- a/docs/03_For_Hosts/07_Customizations.md +++ b/docs/03_For_Hosts/07_Customizations.md @@ -1,9 +1,9 @@ -RSS-Bridge ships a few options the host may or may not activate. All options are currently defined in the [index.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/index.php) file. This means they'll be reset after upgrading RSS-Bridge! +RSS-Bridge ships a few options the host may or may not activate. All options are listed in the [config.default.ini.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/config.default.ini.php) file, see [Custom Configuration](08_Custom_Configuration.md) section for more information. ## Customizable cache timeout Sometimes it is necessary to specify custom timeouts to update contents more frequently than the bridge maintainer intended. In these cases the client may specify a custom cache timeout to prevent loading contents from cache earlier (or later). -This option can be activated by setting the `CUSTOM_CACHE_TIMEOUT` to `true`. When enabled each bridge receives an additional parameter `Cache timeout in seconds` that can be set to any value between 1 and 86400 (24 hours). If the value is not within the limits the default settings apply (as specified by the bridge maintainer). +This option can be activated by setting the [`cache.custom_timeout`](08_Custom_Configuration.md#custom_timeout) option to `true`. When enabled each bridge receives an additional parameter `Cache timeout in seconds` that can be set to any value between 1 and 86400 (24 hours). If the value is not within the limits the default settings apply (as specified by the bridge maintainer). -The cache timeout is send to RSS-Bridge using the `_cache_timeout` parameter. RSS-Bridge will return an error message if the parameter is received and the option is disabled. \ No newline at end of file +The cache timeout is send to RSS-Bridge using the `_cache_timeout` parameter. RSS-Bridge will return an error message if the parameter is received and the option is disabled. diff --git a/docs/03_For_Hosts/08_Custom_Configuration.md b/docs/03_For_Hosts/08_Custom_Configuration.md index afc5eb2e..9a1f78f2 100644 --- a/docs/03_For_Hosts/08_Custom_Configuration.md +++ b/docs/03_For_Hosts/08_Custom_Configuration.md @@ -17,7 +17,7 @@ __Notice__: If a parameter is not specified in your `config.ini.php` RSS-Bridge The configuration file is split into sections: * [system](#system) -* [http client](#http client) +* [http client](#http-client) * [cache](#cache) * [proxy](#proxy) * [authentication](#authentication) @@ -179,4 +179,4 @@ Defines how error messages are returned by RSS-Bridge Defines how often an error must occur before it is reported to the user -`report_limit`: 1 (default) \ No newline at end of file +`report_limit`: 1 (default) diff --git a/lib/BridgeCard.php b/lib/BridgeCard.php index 9e5b151e..dbb2a23d 100644 --- a/lib/BridgeCard.php +++ b/lib/BridgeCard.php @@ -324,9 +324,9 @@ This bridge is not fetching its content through a secure connection'; $donationsAllowed = Configuration::getConfig('admin', 'donations'); - if (defined('PROXY_URL') && PROXY_BYBRIDGE) { + if (Configuration::getConfig('proxy', 'url') && Configuration::getConfig('proxy', 'by_bridge')) { $parameters['global']['_noproxy'] = [ - 'name' => 'Disable proxy (' . ((defined('PROXY_NAME') && PROXY_NAME) ? PROXY_NAME : PROXY_URL) . ')', + 'name' => 'Disable proxy (' . (Configuration::getConfig('proxy', 'name') ?: Configuration::getConfig('proxy', 'url')) . ')', 'type' => 'checkbox' ]; } diff --git a/lib/Configuration.php b/lib/Configuration.php index 000b8bd5..7311c351 100644 --- a/lib/Configuration.php +++ b/lib/Configuration.php @@ -168,28 +168,20 @@ final class Configuration date_default_timezone_set(self::getConfig('system', 'timezone')); if (!is_string(self::getConfig('proxy', 'url'))) { + /** URL of the proxy server */ self::reportConfigurationError('proxy', 'url', 'Is not a valid string'); } - if (!empty(self::getConfig('proxy', 'url'))) { - /** URL of the proxy server */ - define('PROXY_URL', self::getConfig('proxy', 'url')); - } - + /** True if proxy usage can be enabled selectively for each bridge */ if (!is_bool(self::getConfig('proxy', 'by_bridge'))) { self::reportConfigurationError('proxy', 'by_bridge', 'Is not a valid Boolean'); } - /** True if proxy usage can be enabled selectively for each bridge */ - define('PROXY_BYBRIDGE', self::getConfig('proxy', 'by_bridge')); - if (!is_string(self::getConfig('proxy', 'name'))) { + /** Name of the proxy server */ self::reportConfigurationError('proxy', 'name', 'Is not a valid string'); } - /** Name of the proxy server */ - define('PROXY_NAME', self::getConfig('proxy', 'name')); - if (!is_string(self::getConfig('cache', 'type'))) { self::reportConfigurationError('cache', 'type', 'Is not a valid string'); } diff --git a/lib/contents.php b/lib/contents.php index d55edf8f..60282212 100644 --- a/lib/contents.php +++ b/lib/contents.php @@ -79,8 +79,8 @@ function getContents( 'headers' => $httpHeaders, 'curl_options' => $curlOptions, ]; - if (defined('PROXY_URL') && !defined('NOPROXY')) { - $config['proxy'] = PROXY_URL; + if (Configuration::getConfig('proxy', 'url') && !defined('NOPROXY')) { + $config['proxy'] = Configuration::getConfig('proxy', 'url'); } if (!Debug::isEnabled() && $cache->getTime()) { $config['if_not_modified_since'] = $cache->getTime();