[Core] Support for donation URLs

RSS-Bridge · May 11, 2021 · c1c2a30 · c1c2a30
1 parent d7ba778
commit c1c2a30
Show file tree

Hide file tree

Showing 11 changed files with 62 additions and 3 deletions.
diff --git a/actions/DisplayAction.php b/actions/DisplayAction.php
@@ -151,6 +151,7 @@ public function execute() {
 				$infos = array(
 					'name' => $bridge->getName(),
 					'uri'  => $bridge->getURI(),
+					'donationUri'  => $bridge->getDonationURI(),
 					'icon' => $bridge->getIcon()
 				);
 			} catch(Error $e) {

diff --git a/actions/ListAction.php b/actions/ListAction.php
@@ -39,6 +39,7 @@ public function execute() {
 			$list->bridges[$bridgeName] = array(
 				'status' => $status,
 				'uri' => $bridge->getURI(),
+				'donationUri' => $bridge->getDonationURI(),
 				'name' => $bridge->getName(),
 				'icon' => $bridge->getIcon(),
 				'parameters' => $bridge->getParameters(),

diff --git a/config.default.ini.php b/config.default.ini.php
@@ -29,6 +29,13 @@
 ; ""    = Disabled (default)
 email = ""
 
+; Show Donation information for bridges if available.
+; This will display a 'Donate' link on the bridge view
+; and a "Donate" button in the HTML view of the bridges feed.
+; true  = enabled (default)
+; false = disabled
+donations = true
+
 [proxy]
 
 ; Sets the proxy url (i.e. "tcp://192.168.0.0:32")

diff --git a/formats/HtmlFormat.php b/formats/HtmlFormat.php
@@ -6,6 +6,8 @@ public function stringify(){
 		$extraInfos = $this->getExtraInfos();
 		$title = htmlspecialchars($extraInfos['name']);
 		$uri = htmlspecialchars($extraInfos['uri']);
+		$donationUri = htmlspecialchars($extraInfos['donationUri']);
+		$donationsAllowed = Configuration::getConfig('admin', 'donations');
 
 		// Dynamically build buttons for all formats (except HTML)
 		$formatFac = new FormatFactory();
@@ -26,6 +28,11 @@ public function stringify(){
 			$links .= $this->buildLink($format, $query, $mime) . PHP_EOL;
 		}
 
+		if($donationUri !== '' && $donationsAllowed) {
+			$buttons .= '<a href="' . $donationUri . '" target="_blank"><button class="highlight">Donate to maintainer</button></a>' . PHP_EOL;
+			$links .= '<link href="' . $donationUri . ' target="_blank"" title="Donate to Maintainer" rel="alternate">' . PHP_EOL;
+		}
+
 		$entries = '';
 		foreach($this->getItems() as $item) {
 			$entryAuthor = $item->getAuthor() ? '<br /><p class="author">by: ' . $item->getAuthor() . '</p>' : '';

diff --git a/lib/BridgeAbstract.php b/lib/BridgeAbstract.php
@@ -40,6 +40,13 @@ abstract class BridgeAbstract implements BridgeInterface {
 	 */
 	const URI = '';
 
+	/**
+	 * Donation URI to the site the bridge is intended to be used for.
+	 *
+	 * Use {@see BridgeAbstract::getDonationURI()} to read this parameter
+	 */
+	const DONATION_URI = '';
+
 	/**
 	 * A brief description of what the bridge can do
 	 *
@@ -336,6 +343,11 @@ public function getURI(){
 		return static::URI;
 	}
 
+	/** {@inheritdoc} */
+	public function getDonationURI(){
+		return static::DONATION_URI;
+	}
+
 	/** {@inheritdoc} */
 	public function getCacheTimeout(){
 		return static::CACHE_TIMEOUT;

diff --git a/lib/BridgeCard.php b/lib/BridgeCard.php
@@ -322,6 +322,10 @@ static function displayBridgeCard($bridgeName, $formats, $isActive = true){
 		$icon = $bridge->getIcon();
 		$description = $bridge->getDescription();
 		$parameters = $bridge->getParameters();
+		$donationUri = $bridge->getDonationURI();
+		$maintainer = $bridge->getMaintainer();
+
+		$donationsAllowed = Configuration::getConfig('admin', 'donations');
 
 		if(defined('PROXY_URL') && PROXY_BYBRIDGE) {
 			$parameters['global']['_noproxy'] = array(
@@ -372,7 +376,12 @@ static function displayBridgeCard($bridgeName, $formats, $isActive = true){
 		}
 
 		$card .= '<label class="showless" for="showmore-' . $bridgeName . '">Show less</label>';
-		$card .= '<p class="maintainer">' . $bridge->getMaintainer() . '</p>';
+		if($donationUri !== '' && $donationsAllowed){
+			$card .= '<p class="maintainer">' . $maintainer . ' ~ <a href="' . $donationUri . '">Donate</a></p>';
+		}
+		else {
+			$card .= '<p class="maintainer">' . $maintainer . '</p>';
+		}
 		$card .= '</section>';
 
 		return $card;

diff --git a/lib/BridgeInterface.php b/lib/BridgeInterface.php
@@ -120,6 +120,13 @@ public function getParameters();
 	 */
 	public function getURI();
 
+	/**
+	 * Returns the bridge Donation URI
+	 *
+	 * @return string Bridge Donation URI
+	 */
+	public function getDonationURI();
+
 	/**
 	 * Returns the cache timeout
 	 *

diff --git a/lib/BridgeList.php b/lib/BridgeList.php
@@ -154,6 +154,7 @@ private static function getSearchbar() {
 	private static function getFooter($totalBridges, $totalActiveBridges, $showInactive) {
 		$version = Configuration::getVersion();
 
+		$donationsAllowed = Configuration::getConfig('admin', 'donations');
 		$email = Configuration::getConfig('admin', 'email');
 		$admininfo = '';
 		if (!empty($email)) {
@@ -178,10 +179,14 @@ private static function getFooter($totalBridges, $totalActiveBridges, $showInact
 
 		}
 
+		if($donationsAllowed){
+			$donation = ' ~ <a href="http://www.google.com">Donate</a>';
+		}
+
 		return <<<EOD
 <section class="footer">
 	<a href="https://github.com/rss-bridge/rss-bridge">RSS-Bridge ~ Public Domain</a><br>
-	<p class="version">{$version}</p>
+	<p class="version">{$version}{$donation}</p>
 	{$totalActiveBridges}/{$totalBridges} active bridges.<br>
 	{$inactive}
 	{$admininfo}

diff --git a/lib/Configuration.php b/lib/Configuration.php
@@ -197,6 +197,9 @@ public static function loadConfiguration() {
 		if(!empty(self::getConfig('admin', 'email'))
 		&& !filter_var(self::getConfig('admin', 'email'), FILTER_VALIDATE_EMAIL))
 			self::reportConfigurationError('admin', 'email', 'Is not a valid email address');
+
+		if(!is_bool(self::getConfig('admin', 'donations')))
+		self::reportConfigurationError('admin', 'donations', 'Is not a valid Boolean');
 
 		if(!is_string(self::getConfig('error', 'output')))
 			self::reportConfigurationError('error', 'output', 'Is not a valid String');

diff --git a/lib/FormatAbstract.php b/lib/FormatAbstract.php
@@ -140,7 +140,7 @@ public function getItems(){
 	 * @param array $extraInfos {@inheritdoc}
 	 */
 	public function setExtraInfos(array $extraInfos = array()){
-		foreach(array('name', 'uri', 'icon') as $infoName) {
+		foreach(array('name', 'uri', 'icon', 'donationUri') as $infoName) {
 			if(!isset($extraInfos[$infoName])) {
 				$extraInfos[$infoName] = '';
 			}

diff --git a/static/HtmlFormat.css b/static/HtmlFormat.css
@@ -96,6 +96,13 @@ html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockq
  button:hover {
 	background: #49afff;
 }
+ button.highlight {
+	background: #ff6600;
+}
+ button.highlight:hover {
+	background: #ff8a3b;
+}
+
 
 @media screen and (max-width: 767px) {