2 namespace Shaarli\Feed
;
5 use Shaarli\Bookmark\Bookmark
;
6 use Shaarli\Bookmark\BookmarkServiceInterface
;
7 use Shaarli\Formatter\BookmarkFormatter
;
12 * Used to build ATOM and RSS feeds data.
17 * @var string Constant: RSS feed type.
19 public static $FEED_RSS = 'rss';
22 * @var string Constant: ATOM feed type.
24 public static $FEED_ATOM = 'atom';
27 * @var string Default language if the locale isn't set.
29 public static $DEFAULT_LANGUAGE = 'en-en';
32 * @var int Number of bookmarks to display in a feed by default.
34 public static $DEFAULT_NB_LINKS = 50;
37 * @var BookmarkServiceInterface instance.
42 * @var BookmarkFormatter instance.
47 * @var string RSS or ATOM feed.
54 protected $serverInfo;
62 * @var boolean True if the user is currently logged in, false otherwise.
64 protected $isLoggedIn;
67 * @var boolean Use permalinks instead of direct bookmarks if true.
69 protected $usePermalinks;
72 * @var boolean true to hide dates in feeds.
77 * @var string server locale.
82 * @var DateTime Latest item date.
84 protected $latestDate;
89 * @param BookmarkServiceInterface $linkDB LinkDB instance.
90 * @param BookmarkFormatter $formatter instance.
91 * @param string $feedType Type of feed.
92 * @param array $serverInfo $_SERVER.
93 * @param array $userInput $_GET.
94 * @param boolean $isLoggedIn True if the user is currently logged in, false otherwise.
96 public function __construct($linkDB, $formatter, $feedType, $serverInfo, $userInput, $isLoggedIn)
98 $this->linkDB
= $linkDB;
99 $this->formatter
= $formatter;
100 $this->feedType
= $feedType;
101 $this->serverInfo
= $serverInfo;
102 $this->userInput
= $userInput;
103 $this->isLoggedIn
= $isLoggedIn;
107 * Build data for feed templates.
109 * @return array Formatted data for feeds templates.
111 public function buildData()
113 // Search for untagged bookmarks
114 if (isset($this->userInput
['searchtags']) && empty($this->userInput
['searchtags'])) {
115 $this->userInput
['searchtags'] = false;
118 // Optionally filter the results:
119 $linksToDisplay = $this->linkDB
->search($this->userInput
);
121 $nblinksToDisplay = $this->getNbLinks(count($linksToDisplay));
123 // Can't use array_keys() because $link is a LinkDB instance and not a real array.
125 foreach ($linksToDisplay as $key => $value) {
129 $pageaddr = escape(index_url($this->serverInfo
));
130 $this->formatter
->addContextData('index_url', $pageaddr);
131 $linkDisplayed = array();
132 for ($i = 0; $i < $nblinksToDisplay && $i < count($keys); $i++
) {
133 $linkDisplayed[$keys[$i]] = $this->buildItem($linksToDisplay[$keys[$i]], $pageaddr);
136 $data['language'] = $this->getTypeLanguage();
137 $data['last_update'] = $this->getLatestDateFormatted();
138 $data['show_dates'] = !$this->hideDates
|| $this->isLoggedIn
;
139 // Remove leading slash from REQUEST_URI.
140 $data['self_link'] = escape(server_url($this->serverInfo
))
141 . escape($this->serverInfo
['REQUEST_URI']);
142 $data['index_url'] = $pageaddr;
143 $data['usepermalinks'] = $this->usePermalinks
=== true;
144 $data['links'] = $linkDisplayed;
150 * Build a feed item (one per shaare).
152 * @param Bookmark $link Single link array extracted from LinkDB.
153 * @param string $pageaddr Index URL.
155 * @return array Link array with feed attributes.
157 protected function buildItem($link, $pageaddr)
159 $data = $this->formatter
->format($link);
160 $data['guid'] = $pageaddr . '?' . $data['shorturl'];
161 if ($this->usePermalinks
=== true) {
162 $permalink = '<a href="'. $data['url'] .'" title="'. t('Direct link') .'">'. t('Direct link') .'</a>';
164 $permalink = '<a href="'. $data['guid'] .'" title="'. t('Permalink') .'">'. t('Permalink') .'</a>';
166 $data['description'] .= PHP_EOL
. PHP_EOL
. '<br>— ' . $permalink;
168 $data['pub_iso_date'] = $this->getIsoDate($data['created']);
170 // atom:entry elements MUST contain exactly one atom:updated element.
171 if (!empty($link->getUpdated())) {
172 $data['up_iso_date'] = $this->getIsoDate($data['updated'], DateTime
::ATOM
);
174 $data['up_iso_date'] = $this->getIsoDate($data['created'], DateTime
::ATOM
);
177 // Save the more recent item.
178 if (empty($this->latestDate
) || $this->latestDate
< $data['created']) {
179 $this->latestDate
= $data['created'];
181 if (!empty($data['updated']) && $this->latestDate
< $data['updated']) {
182 $this->latestDate
= $data['updated'];
189 * Set this to true to use permalinks instead of direct bookmarks.
191 * @param boolean $usePermalinks true to force permalinks.
193 public function setUsePermalinks($usePermalinks)
195 $this->usePermalinks
= $usePermalinks;
199 * Set this to true to hide timestamps in feeds.
201 * @param boolean $hideDates true to enable.
203 public function setHideDates($hideDates)
205 $this->hideDates
= $hideDates;
209 * Set the locale. Used to show feed language.
211 * @param string $locale The locale (eg. 'fr_FR.UTF8').
213 public function setLocale($locale)
215 $this->locale
= strtolower($locale);
219 * Get the language according to the feed type, based on the locale:
221 * - RSS format: en-us (default: 'en-en').
222 * - ATOM format: fr (default: 'en').
224 * @return string The language.
226 public function getTypeLanguage()
228 // Use the locale do define the language, if available.
229 if (!empty($this->locale
) && preg_match('/^\w{2}[_\-]\w{2}/', $this->locale
)) {
230 $length = ($this->feedType
=== self
::$FEED_RSS) ? 5 : 2;
231 return str_replace('_', '-', substr($this->locale
, 0, $length));
233 return ($this->feedType
=== self
::$FEED_RSS) ? 'en-en' : 'en';
237 * Format the latest item date found according to the feed type.
239 * Return an empty string if invalid DateTime is passed.
241 * @return string Formatted date.
243 protected function getLatestDateFormatted()
245 if (empty($this->latestDate
) || !$this->latestDate
instanceof DateTime
) {
249 $type = ($this->feedType
== self
::$FEED_RSS) ? DateTime
::RSS
: DateTime
::ATOM
;
250 return $this->latestDate
->format($type);
254 * Get ISO date from DateTime according to feed type.
256 * @param DateTime $date Date to format.
257 * @param string|bool $format Force format.
259 * @return string Formatted date.
261 protected function getIsoDate(DateTime
$date, $format = false)
263 if ($format !== false) {
264 return $date->format($format);
266 if ($this->feedType
== self
::$FEED_RSS) {
267 return $date->format(DateTime
::RSS
);
269 return $date->format(DateTime
::ATOM
);
273 * Returns the number of link to display according to 'nb' user input parameter.
275 * If 'nb' not set or invalid, default value: $DEFAULT_NB_LINKS.
276 * If 'nb' is set to 'all', display all filtered bookmarks (max parameter).
278 * @param int $max maximum number of bookmarks to display.
280 * @return int number of bookmarks to display.
282 public function getNbLinks($max)
284 if (empty($this->userInput
['nb'])) {
285 return self
::$DEFAULT_NB_LINKS;
288 if ($this->userInput
['nb'] == 'all') {
292 $intNb = intval($this->userInput
['nb']);
293 if (!is_int($intNb) || $intNb == 0) {
294 return self
::$DEFAULT_NB_LINKS;