Rebase 783-contributing-file on branch 'dev'

1 files changed, 195 insertions, 0 deletions

diff --git a/app/Models/Search.php b/app/Models/Search.php
new file mode 100644
index 000000000..ef8fc883d
--- /dev/null
+++ b/app/Models/Search.php
@@ -0,0 +1,195 @@
+<?php
+
+/**
+ * Contains a search from the search form.
+ *
+ * It allows to extract meaningful bits of the search and store them in a
+ * convenient object
+ */
+class FreshRSS_Search {
+
+	// This contains the user input string
+	private $raw_input;
+	// The following properties are extracted from the raw input
+	private $intitle;
+	private $min_date;
+	private $max_date;
+	private $min_pubdate;
+	private $max_pubdate;
+	private $inurl;
+	private $author;
+	private $tags;
+	private $search;
+
+	public function __construct($input) {
+		if (strcmp($input, '') == 0) {
+			return;
+		}
+		$this->raw_input = $input;
+		$input = $this->parseIntitleSearch($input);
+		$input = $this->parseAuthorSearch($input);
+		$input = $this->parseInurlSearch($input);
+		$input = $this->parsePubdateSearch($input);
+		$input = $this->parseDateSearch($input);
+		$input = $this->parseTagsSeach($input);
+		$this->search = $this->cleanSearch($input);
+	}
+
+	public function getRawInput() {
+		return $this->raw_input;
+	}
+
+	public function getIntitle() {
+		return $this->intitle;
+	}
+
+	public function getMinDate() {
+		return $this->min_date;
+	}
+
+	public function getMaxDate() {
+		return $this->max_date;
+	}
+
+	public function getMinPubdate() {
+		return $this->min_pubdate;
+	}
+
+	public function getMaxPubdate() {
+		return $this->max_pubdate;
+	}
+
+	public function getInurl() {
+		return $this->inurl;
+	}
+
+	public function getAuthor() {
+		return $this->author;
+	}
+
+	public function getTags() {
+		return $this->tags;
+	}
+
+	public function getSearch() {
+		return $this->search;
+	}
+
+	/**
+	 * Parse the search string to find intitle keyword and the search related
+	 * to it.
+	 * The search is the first word following the keyword.
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	private function parseIntitleSearch($input) {
+		if (preg_match('/intitle:(?P<delim>[\'"])(?P<search>.*)(?P=delim)/U', $input, $matches)) {
+			$this->intitle = $matches['search'];
+			return str_replace($matches[0], '', $input);
+		}
+		if (preg_match('/intitle:(?P<search>\w*)/', $input, $matches)) {
+			$this->intitle = $matches['search'];
+			return str_replace($matches[0], '', $input);
+		}
+		return $input;
+	}
+
+	/**
+	 * Parse the search string to find author keyword and the search related
+	 * to it.
+	 * The search is the first word following the keyword except when using
+	 * a delimiter. Supported delimiters are single quote (') and double
+	 * quotes (").
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	private function parseAuthorSearch($input) {
+		if (preg_match('/author:(?P<delim>[\'"])(?P<search>.*)(?P=delim)/U', $input, $matches)) {
+			$this->author = $matches['search'];
+			return str_replace($matches[0], '', $input);
+		}
+		if (preg_match('/author:(?P<search>\w*)/', $input, $matches)) {
+			$this->author = $matches['search'];
+			return str_replace($matches[0], '', $input);
+		}
+		return $input;
+	}
+
+	/**
+	 * Parse the search string to find inurl keyword and the search related
+	 * to it.
+	 * The search is the first word following the keyword except.
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	private function parseInurlSearch($input) {
+		if (preg_match('/inurl:(?P<search>[^\s]*)/', $input, $matches)) {
+			$this->inurl = $matches['search'];
+			return str_replace($matches[0], '', $input);
+		}
+		return $input;
+	}
+
+	/**
+	 * Parse the search string to find date keyword and the search related
+	 * to it.
+	 * The search is the first word following the keyword.
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	private function parseDateSearch($input) {
+		if (preg_match('/date:(?P<search>[^\s]*)/', $input, $matches)) {
+			list($this->min_date, $this->max_date) = parseDateInterval($matches['search']);
+			return str_replace($matches[0], '', $input);
+		}
+		return $input;
+	}
+
+	/**
+	 * Parse the search string to find pubdate keyword and the search related
+	 * to it.
+	 * The search is the first word following the keyword.
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	private function parsePubdateSearch($input) {
+		if (preg_match('/pubdate:(?P<search>[^\s]*)/', $input, $matches)) {
+			list($this->min_pubdate, $this->max_pubdate) = parseDateInterval($matches['search']);
+			return str_replace($matches[0], '', $input);
+		}
+		return $input;
+	}
+
+	/**
+	 * Parse the search string to find tags keyword (# followed by a word)
+	 * and the search related to it.
+	 * The search is the first word following the #.
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	private function parseTagsSeach($input) {
+		if (preg_match_all('/#(?P<search>[^\s]+)/', $input, $matches)) {
+			$this->tags = $matches['search'];
+			return str_replace($matches[0], '', $input);
+		}
+		return $input;
+	}
+
+	/**
+	 * Remove all unnecessary spaces in the search
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	private function cleanSearch($input) {
+		$input = preg_replace('/\s+/', ' ', $input);
+		return trim($input);
+	}
+
+}