b90bcee1fc
* [Exceptions] Don't return header for bridge exceptions
* [Exceptions] Add link to list in exception message
This is an alternative when the button is not rendered
for some reason.
* [index] Don't return bridge exception for formats
* [index] Return feed item for bridge exceptions
* [BridgeAbstract] Rename 'getCacheTime' to 'getModifiedTime'
* [BridgeAbstract] Move caching to index.php to separate concerns
index.php needs more control over caching behavior in order to cache
exceptions. This cannot be done in a bridge, as the bridge might be
broken, thus preventing caching from working.
This also (and more importantly) separates concerns. The bridge should
not even care if caching is involved or not. Its purpose is to collect
and provide data.
Response times should be faster, as more complex bridge functions like
'setDatas' (evaluates all input parameters to predict the current
context) and 'collectData' (collects data from sites) can be skipped
entirely.
Notice: In its current form, index.php takes care of caching. This
could, however, be moved into a separate class (i.e. CacheAbstract)
in order to make implementation details cache specific.
* [index] Add '_error_time' parameter to $item['uri']
This ensures that error messages are recognized by feed readers as
new errors after 24 hours. During that time the same item is returned
no matter how often the cache is cleared.
References https://github.com/RSS-Bridge/rss-bridge/issues/814#issuecomment-420876162
* [index] Include '_error_time' in the title for errors
This prevents feed readers from "updating" feeds based on the title
* [index] Handle "HTTP_IF_MODIFIED_SINCE" client requests
Implementation is based on `BridgeAbstract::dieIfNotModified()`,
introduced in 422c125d8e and
simplified based on https://stackoverflow.com/a/10847262
Basically, before returning cached data we check if the client send
the "HTTP_IF_MODIFIED_SINCE" header. If the modification time is
more recent or equal to the cache time, we reply with "HTTP/1.1 304
Not Modified" (same as before). Otherwise send the cached data.
* [index] Don't encode exception message with `htmlspecialchars`
* [Exceptions] Include error message in exception
* [index] Show different error message for error code 0
65 lines
1,002 B
PHP
65 lines
1,002 B
PHP
<?php
|
|
interface BridgeInterface {
|
|
|
|
/**
|
|
* Collects data from the site
|
|
*/
|
|
public function collectData();
|
|
|
|
/**
|
|
* Returns the description
|
|
*
|
|
* @return string Description
|
|
*/
|
|
public function getDescription();
|
|
|
|
/**
|
|
* Returns an array of collected items
|
|
*
|
|
* @return array Associative array of items
|
|
*/
|
|
public function getItems();
|
|
|
|
/**
|
|
* Returns the bridge maintainer
|
|
*
|
|
* @return string Bridge maintainer
|
|
*/
|
|
public function getMaintainer();
|
|
|
|
/**
|
|
* Returns the bridge name
|
|
*
|
|
* @return string Bridge name
|
|
*/
|
|
public function getName();
|
|
|
|
/**
|
|
* Returns the bridge icon
|
|
*
|
|
* @return string Bridge icon
|
|
*/
|
|
public function getIcon();
|
|
|
|
/**
|
|
* Returns the bridge parameters
|
|
*
|
|
* @return array Bridge parameters
|
|
*/
|
|
public function getParameters();
|
|
|
|
/**
|
|
* Returns the bridge URI
|
|
*
|
|
* @return string Bridge URI
|
|
*/
|
|
public function getURI();
|
|
|
|
/**
|
|
* Returns the cache timeout
|
|
*
|
|
* @return int Cache timeout
|
|
*/
|
|
public function getCacheTimeout();
|
|
}
|