Add TTL to control feed freshness

https://github.com/marienfressinaud/FreshRSS/issues/250

3 files changed, 98 insertions, 76 deletions

diff --git a/app/Models/Configuration.php b/app/Models/Configuration.php
index ffd20deca..f2084b833 100644
--- a/app/Models/Configuration.php
+++ b/app/Models/Configuration.php
@@ -7,6 +7,7 @@ class FreshRSS_Configuration {
 		'language' => 'en',
 		'old_entries' => 3,
 		'keep_history_default' => 0,
+		'ttl_default' => 3600,
 		'mail_login' => '',
 		'token' => '',
 		'passwordHash' => '',	//CRYPT_BLOWFISH
@@ -159,6 +160,10 @@ class FreshRSS_Configuration {
 		$value = intval($value);
 		$this->data['keep_history_default'] = $value >= -1 ? $value : 0;
 	}
+	public function _ttl_default($value) {
+		$value = intval($value);
+		$this->data['ttl_default'] = $value >= -1 ? $value : 3600;
+	}
 	public function _shortcuts ($values) {
 		foreach ($values as $key => $value) {
 			if (isset($this->data['shortcuts'][$key])) {
diff --git a/app/Models/Feed.php b/app/Models/Feed.php
index c9f1230ad..576f37760 100644
--- a/app/Models/Feed.php
+++ b/app/Models/Feed.php
@@ -16,18 +16,19 @@ class FreshRSS_Feed extends Minz_Model {
 	private $httpAuth = '';
 	private $error = false;
 	private $keep_history = -2;
+	private $ttl = -2;
 	private $hash = null;
 	private $lockPath = '';
 
-	public function __construct ($url, $validate=true) {
+	public function __construct($url, $validate=true) {
 		if ($validate) {
-			$this->_url ($url);
+			$this->_url($url);
 		} else {
 			$this->url = $url;
 		}
 	}
 
-	public function id () {
+	public function id() {
 		return $this->id;
 	}
 
@@ -38,72 +39,75 @@ class FreshRSS_Feed extends Minz_Model {
 		return $this->hash;
 	}
 
-	public function url () {
+	public function url() {
 		return $this->url;
 	}
-	public function category () {
+	public function category() {
 		return $this->category;
 	}
-	public function entries () {
+	public function entries() {
 		return $this->entries === null ? array() : $this->entries;
 	}
-	public function name () {
+	public function name() {
 		return $this->name;
 	}
-	public function website () {
+	public function website() {
 		return $this->website;
 	}
-	public function description () {
+	public function description() {
 		return $this->description;
 	}
-	public function lastUpdate () {
+	public function lastUpdate() {
 		return $this->lastUpdate;
 	}
-	public function priority () {
+	public function priority() {
 		return $this->priority;
 	}
-	public function pathEntries () {
+	public function pathEntries() {
 		return $this->pathEntries;
 	}
-	public function httpAuth ($raw = true) {
+	public function httpAuth($raw = true) {
 		if ($raw) {
 			return $this->httpAuth;
 		} else {
-			$pos_colon = strpos ($this->httpAuth, ':');
-			$user = substr ($this->httpAuth, 0, $pos_colon);
-			$pass = substr ($this->httpAuth, $pos_colon + 1);
+			$pos_colon = strpos($this->httpAuth, ':');
+			$user = substr($this->httpAuth, 0, $pos_colon);
+			$pass = substr($this->httpAuth, $pos_colon + 1);
 
-			return array (
+			return array(
 				'username' => $user,
 				'password' => $pass
 			);
 		}
 	}
-	public function inError () {
+	public function inError() {
 		return $this->error;
 	}
-	public function keepHistory () {
+	public function keepHistory() {
 		return $this->keep_history;
 	}
-	public function nbEntries () {
+	public function ttl() {
+		return $this->ttl;
+	}
+	public function nbEntries() {
 		if ($this->nbEntries < 0) {
 			$feedDAO = FreshRSS_Factory::createFeedDao();
-			$this->nbEntries = $feedDAO->countEntries ($this->id ());
+			$this->nbEntries = $feedDAO->countEntries($this->id());
 		}
 
 		return $this->nbEntries;
 	}
-	public function nbNotRead () {
+	public function nbNotRead() {
 		if ($this->nbNotRead < 0) {
 			$feedDAO = FreshRSS_Factory::createFeedDao();
-			$this->nbNotRead = $feedDAO->countNotRead ($this->id ());
+			$this->nbNotRead = $feedDAO->countNotRead($this->id());
 		}
 
 		return $this->nbNotRead;
 	}
 	public function faviconPrepare() {
 		$file = DATA_PATH . '/favicons/' . $this->hash() . '.txt';
-		if (!file_exists ($file)) {
+		if (!file_exists($file)) {
 			$t = $this->website;
 			if ($t == '') {
 				$t = $this->url;
@@ -116,92 +120,98 @@ class FreshRSS_Feed extends Minz_Model {
 		@unlink($path . '.ico');
 		@unlink($path . '.txt');
 	}
-	public function favicon () {
-		return Minz_Url::display ('/f.php?' . $this->hash());
+	public function favicon() {
+		return Minz_Url::display('/f.php?' . $this->hash());
 	}
 
-	public function _id ($value) {
+	public function _id($value) {
 		$this->id = $value;
 	}
-	public function _url ($value, $validate=true) {
+	public function _url($value, $validate=true) {
 		$this->hash = null;
 		if ($validate) {
 			$value = checkUrl($value);
 		}
-		if (empty ($value)) {
-			throw new FreshRSS_BadUrl_Exception ($value);
+		if (empty($value)) {
+			throw new FreshRSS_BadUrl_Exception($value);
 		}
 		$this->url = $value;
 	}
-	public function _category ($value) {
+	public function _category($value) {
 		$value = intval($value);
 		$this->category = $value >= 0 ? $value : 0;
 	}
-	public function _name ($value) {
+	public function _name($value) {
 		$this->name = $value === null ? '' : $value;
 	}
-	public function _website ($value, $validate=true) {
+	public function _website($value, $validate=true) {
 		if ($validate) {
 			$value = checkUrl($value);
 		}
-		if (empty ($value)) {
+		if (empty($value)) {
 			$value = '';
 		}
 		$this->website = $value;
 	}
-	public function _description ($value) {
+	public function _description($value) {
 		$this->description = $value === null ? '' : $value;
 	}
-	public function _lastUpdate ($value) {
+	public function _lastUpdate($value) {
 		$this->lastUpdate = $value;
 	}
-	public function _priority ($value) {
+	public function _priority($value) {
 		$value = intval($value);
 		$this->priority = $value >= 0 ? $value : 10;
 	}
-	public function _pathEntries ($value) {
+	public function _pathEntries($value) {
 		$this->pathEntries = $value;
 	}
-	public function _httpAuth ($value) {
+	public function _httpAuth($value) {
 		$this->httpAuth = $value;
 	}
-	public function _error ($value) {
+	public function _error($value) {
 		$this->error = (bool)$value;
 	}
-	public function _keepHistory ($value) {
+	public function _keepHistory($value) {
 		$value = intval($value);
 		$value = min($value, 1000000);
 		$value = max($value, -2);
 		$this->keep_history = $value;
 	}
-	public function _nbNotRead ($value) {
+	public function _ttl($value) {
+		$value = intval($value);
+		$value = min($value, 100000000);
+		$value = max($value, -2);
+		$this->ttl = $value;
+	}
+	public function _nbNotRead($value) {
 		$this->nbNotRead = intval($value);
 	}
-	public function _nbEntries ($value) {
+	public function _nbEntries($value) {
 		$this->nbEntries = intval($value);
 	}
 
-	public function load ($loadDetails = false) {
+	public function load($loadDetails = false) {
 		if ($this->url !== null) {
 			if (CACHE_PATH === false) {
-				throw new Minz_FileNotExistException (
+				throw new Minz_FileNotExistException(
 					'CACHE_PATH',
 					Minz_Exception::ERROR
 				);
 			} else {
-				$url = htmlspecialchars_decode ($this->url, ENT_QUOTES);
+				$url = htmlspecialchars_decode($this->url, ENT_QUOTES);
 				if ($this->httpAuth != '') {
-					$url = preg_replace ('#((.+)://)(.+)#', '${1}' . $this->httpAuth . '@${3}', $url);
+					$url = preg_replace('#((.+)://)(.+)#', '${1}' . $this->httpAuth . '@${3}', $url);
 				}
 				$feed = customSimplePie();
-				$feed->set_feed_url ($url);
+				$feed->set_feed_url($url);
 				if (!$loadDetails) {	//Only activates auto-discovery when adding a new feed
 					$feed->set_autodiscovery_level(SIMPLEPIE_LOCATOR_NONE);
 				}
 				$mtime = $feed->init();
 
 				if ((!$mtime) || $feed->error()) {
-					throw new FreshRSS_Feed_Exception ($feed->error() . ' [' . $url . ']');
+					throw new FreshRSS_Feed_Exception($feed->error() . ' [' . $url . ']');
 				}
 
 				if ($loadDetails) {
@@ -209,7 +219,7 @@ class FreshRSS_Feed extends Minz_Model {
 					$subscribe_url = $feed->subscribe_url(false);
 
 					$title = strtr(html_only_entity_decode($feed->get_title()), array('<' => '&lt;', '>' => '&gt;', '"' => '&quot;'));	//HTML to HTML-PRE	//ENT_COMPAT except &
-					$this->_name ($title == '' ? $this->url : $title);
+					$this->_name($title == '' ? $this->url : $title);
 
 					$this->_website(html_only_entity_decode($feed->get_link()));
 					$this->_description(html_only_entity_decode($feed->get_description()));
@@ -221,12 +231,12 @@ class FreshRSS_Feed extends Minz_Model {
 				if ($subscribe_url !== null && $subscribe_url !== $this->url) {
 					if ($this->httpAuth != '') {
 						// on enlève les id si authentification HTTP
-						$subscribe_url = preg_replace ('#((.+)://)((.+)@)(.+)#', '${1}${5}', $subscribe_url);
+						$subscribe_url = preg_replace('#((.+)://)((.+)@)(.+)#', '${1}${5}', $subscribe_url);
 					}
-					$this->_url ($subscribe_url);
+					$this->_url($subscribe_url);
 				}
 
-				if (($mtime === true) || ($mtime > $this->lastUpdate)) {
+				if (($mtime === true) ||($mtime > $this->lastUpdate)) {
 					syslog(LOG_DEBUG, 'FreshRSS no cache ' . $mtime . ' > ' . $this->lastUpdate . ' for ' . $subscribe_url);
 					$this->loadEntries($feed);	// et on charge les articles du flux
 				} else {
@@ -240,25 +250,25 @@ class FreshRSS_Feed extends Minz_Model {
 		}
 	}
 
-	private function loadEntries ($feed) {
-		$entries = array ();
+	private function loadEntries($feed) {
+		$entries = array();
 
-		foreach ($feed->get_items () as $item) {
-			$title = html_only_entity_decode (strip_tags ($item->get_title ()));
-			$author = $item->get_author ();
-			$link = $item->get_permalink ();
-			$date = @strtotime ($item->get_date ());
+		foreach ($feed->get_items() as $item) {
+			$title = html_only_entity_decode(strip_tags($item->get_title()));
+			$author = $item->get_author();
+			$link = $item->get_permalink();
+			$date = @strtotime($item->get_date());
 
 			// gestion des tags (catégorie == tag)
-			$tags_tmp = $item->get_categories ();
-			$tags = array ();
+			$tags_tmp = $item->get_categories();
+			$tags = array();
 			if ($tags_tmp !== null) {
 				foreach ($tags_tmp as $tag) {
-					$tags[] = html_only_entity_decode ($tag->get_label ());
+					$tags[] = html_only_entity_decode($tag->get_label());
 				}
 			}
 
-			$content = html_only_entity_decode ($item->get_content ());
+			$content = html_only_entity_decode($item->get_content());
 
 			$elinks = array();
 			foreach ($item->get_enclosures() as $enclosure) {
@@ -276,16 +286,16 @@ class FreshRSS_Feed extends Minz_Model {
 				}
 			}
 
-			$entry = new FreshRSS_Entry (
-				$this->id (),
-				$item->get_id (),
+			$entry = new FreshRSS_Entry(
+				$this->id(),
+				$item->get_id(),
 				$title === null ? '' : $title,
-				$author === null ? '' : html_only_entity_decode ($author->name),
+				$author === null ? '' : html_only_entity_decode($author->name),
 				$content === null ? '' : $content,
 				$link === null ? '' : $link,
-				$date ? $date : time ()
+				$date ? $date : time()
 			);
-			$entry->_tags ($tags);
+			$entry->_tags($tags);
 			// permet de récupérer le contenu des flux tronqués
 			$entry->loadCompleteContent($this->pathEntries());
 
diff --git a/app/Models/FeedDAO.php b/app/Models/FeedDAO.php
index 5281b371d..83f3a6231 100644
--- a/app/Models/FeedDAO.php
+++ b/app/Models/FeedDAO.php
@@ -2,7 +2,7 @@
 
 class FreshRSS_FeedDAO extends Minz_ModelPdo {
 	public function addFeed($valuesTmp) {
-		$sql = 'INSERT INTO `' . $this->prefix . 'feed` (url, category, name, website, description, lastUpdate, priority, httpAuth, error, keep_history) VALUES(?, ?, ?, ?, ?, ?, 10, ?, 0, -2)';
+		$sql = 'INSERT INTO `' . $this->prefix . 'feed` (url, category, name, website, description, lastUpdate, priority, httpAuth, error, keep_history, ttl) VALUES(?, ?, ?, ?, ?, ?, 10, ?, 0, -2, -2)';
 		$stm = $this->bd->prepare($sql);
 
 		$values = array(
@@ -222,13 +222,19 @@ class FreshRSS_FeedDAO extends Minz_ModelPdo {
 		return $feedCategoryNames;
 	}
 
-	public function listFeedsOrderUpdate($cacheDuration = 1500) {
-		$sql = 'SELECT id, url, name, website, lastUpdate, pathEntries, httpAuth, keep_history '
+	public function listFeedsOrderUpdate($defaultCacheDuration = 3600) {
+		$sql = 'SELECT id, url, name, website, lastUpdate, pathEntries, httpAuth, keep_history, ttl '
 		     . 'FROM `' . $this->prefix . 'feed` '
-		     . 'WHERE lastUpdate < ' . (time() - intval($cacheDuration))
-		     . ' ORDER BY lastUpdate';
+		     . 'WHERE ttl <> -1 AND lastUpdate < (' . (time() + 60) . '-(CASE WHEN ttl=-2 THEN ' . intval($defaultCacheDuration) . ' ELSE ttl END)) '
+		     . 'ORDER BY lastUpdate';
 		$stm = $this->bd->prepare($sql);
-		$stm->execute();
+		if (!($stm && $stm->execute())) {
+			$sql2 = 'ALTER TABLE `' . $this->prefix . 'feed` ADD COLUMN ttl INT NOT NULL DEFAULT -2';	//v0.7.3
+			$stm = $this->bd->prepare($sql2);
+			$stm->execute();
+			$stm = $this->bd->prepare($sql);
+			$stm->execute();
+		}
 
 		return self::daoToFeed($stm->fetchAll(PDO::FETCH_ASSOC));
 	}
@@ -365,6 +371,7 @@ class FreshRSS_FeedDAO extends Minz_ModelPdo {
 			$myFeed->_httpAuth(isset($dao['httpAuth']) ? base64_decode($dao['httpAuth']) : '');
 			$myFeed->_error(isset($dao['error']) ? $dao['error'] : 0);
 			$myFeed->_keepHistory(isset($dao['keep_history']) ? $dao['keep_history'] : -2);
+			$myFeed->_ttl(isset($dao['ttl']) ? $dao['ttl'] : -2);
 			$myFeed->_nbNotRead(isset($dao['cache_nbUnreads']) ? $dao['cache_nbUnreads'] : 0);
 			$myFeed->_nbEntries(isset($dao['cache_nbEntries']) ? $dao['cache_nbEntries'] : 0);
 			if (isset($dao['id'])) {