]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/FeedBuilder.php
6 * Used to build ATOM and RSS feeds data.
11 * @var string Constant: RSS feed type.
13 public static $FEED_RSS = 'rss';
16 * @var string Constant: ATOM feed type.
18 public static $FEED_ATOM = 'atom';
21 * @var string Default language if the locale isn't set.
23 public static $DEFAULT_LANGUAGE = 'en-en';
26 * @var int Number of links to display in a feed by default.
28 public static $DEFAULT_NB_LINKS = 50;
31 * @var LinkDB instance.
36 * @var string RSS or ATOM feed.
41 * @var array $_SERVER.
43 protected $serverInfo;
51 * @var boolean True if the user is currently logged in, false otherwise.
53 protected $isLoggedIn;
56 * @var boolean Use permalinks instead of direct links if true.
58 protected $usePermalinks;
61 * @var boolean true to hide dates in feeds.
66 * @var string PubSub hub URL.
68 protected $pubsubhubUrl;
71 * @var string server locale.
76 * @var DateTime Latest item date.
78 protected $latestDate;
83 * @param LinkDB $linkDB LinkDB instance.
84 * @param string $feedType Type of feed.
85 * @param array $serverInfo $_SERVER.
86 * @param array $userInput $_GET.
87 * @param boolean $isLoggedIn True if the user is currently logged in, false otherwise.
89 public function __construct($linkDB, $feedType, $serverInfo, $userInput, $isLoggedIn)
91 $this->linkDB
= $linkDB;
92 $this->feedType
= $feedType;
93 $this->serverInfo
= $serverInfo;
94 $this->userInput
= $userInput;
95 $this->isLoggedIn
= $isLoggedIn;
99 * Build data for feed templates.
101 * @return array Formatted data for feeds templates.
103 public function buildData()
105 // Optionally filter the results:
106 $linksToDisplay = $this->linkDB
->filterSearch($this->userInput
);
108 $nblinksToDisplay = $this->getNbLinks(count($linksToDisplay));
110 // Can't use array_keys() because $link is a LinkDB instance and not a real array.
112 foreach ($linksToDisplay as $key => $value) {
116 $pageaddr = escape(index_url($this->serverInfo
));
117 $linkDisplayed = array();
118 for ($i = 0; $i < $nblinksToDisplay && $i < count($keys); $i++
) {
119 $linkDisplayed[$keys[$i]] = $this->buildItem($linksToDisplay[$keys[$i]], $pageaddr);
122 $data['language'] = $this->getTypeLanguage();
123 $data['pubsubhub_url'] = $this->pubsubhubUrl
;
124 $data['last_update'] = $this->getLatestDateFormatted();
125 $data['show_dates'] = !$this->hideDates
|| $this->isLoggedIn
;
126 // Remove leading slash from REQUEST_URI.
127 $data['self_link'] = $pageaddr . escape(ltrim($this->serverInfo
['REQUEST_URI'], '/'));
128 $data['index_url'] = $pageaddr;
129 $data['usepermalinks'] = $this->usePermalinks
=== true;
130 $data['links'] = $linkDisplayed;
136 * Build a feed item (one per shaare).
138 * @param array $link Single link array extracted from LinkDB.
139 * @param string $pageaddr Index URL.
141 * @return array Link array with feed attributes.
143 protected function buildItem($link, $pageaddr)
145 $link['guid'] = $pageaddr .'?'. smallHash($link['linkdate']);
146 // Check for both signs of a note: starting with ? and 7 chars long.
147 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
148 $link['url'] = $pageaddr . $link['url'];
150 if ($this->usePermalinks
=== true) {
151 $permalink = '<a href="'. $link['url'] .'" title="Direct link">Direct link</a>';
153 $permalink = '<a href="'. $link['guid'] .'" title="Permalink">Permalink</a>';
155 $link['description'] = format_description($link['description']) . PHP_EOL
.'<br>— '. $permalink;
157 $pubDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $link['linkdate']);
158 $link['pub_iso_date'] = $this->getIsoDate($pubDate);
160 // atom:entry elements MUST contain exactly one atom:updated element.
161 if (!empty($link['updated'])) {
162 $upDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $link['updated']);
163 $link['up_iso_date'] = $this->getIsoDate($upDate, DateTime
::ATOM
);
165 $link['up_iso_date'] = $this->getIsoDate($pubDate, DateTime
::ATOM
);;
168 // Save the more recent item.
169 if (empty($this->latestDate
) || $this->latestDate
< $pubDate) {
170 $this->latestDate
= $pubDate;
172 if (!empty($upDate) && $this->latestDate
< $upDate) {
173 $this->latestDate
= $upDate;
176 $taglist = array_filter(explode(' ', $link['tags']), 'strlen');
177 uasort($taglist, 'strcasecmp');
178 $link['taglist'] = $taglist;
184 * Assign PubSub hub URL.
186 * @param string $pubsubhubUrl PubSub hub url.
188 public function setPubsubhubUrl($pubsubhubUrl)
190 $this->pubsubhubUrl
= $pubsubhubUrl;
194 * Set this to true to use permalinks instead of direct links.
196 * @param boolean $usePermalinks true to force permalinks.
198 public function setUsePermalinks($usePermalinks)
200 $this->usePermalinks
= $usePermalinks;
204 * Set this to true to hide timestamps in feeds.
206 * @param boolean $hideDates true to enable.
208 public function setHideDates($hideDates)
210 $this->hideDates
= $hideDates;
214 * Set the locale. Used to show feed language.
216 * @param string $locale The locale (eg. 'fr_FR.UTF8').
218 public function setLocale($locale)
220 $this->locale
= strtolower($locale);
224 * Get the language according to the feed type, based on the locale:
226 * - RSS format: en-us (default: 'en-en').
227 * - ATOM format: fr (default: 'en').
229 * @return string The language.
231 public function getTypeLanguage()
233 // Use the locale do define the language, if available.
234 if (! empty($this->locale
) && preg_match('/^\w{2}[_\-]\w{2}/', $this->locale
)) {
235 $length = ($this->feedType
== self
::$FEED_RSS) ? 5 : 2;
236 return str_replace('_', '-', substr($this->locale
, 0, $length));
238 return ($this->feedType
== self
::$FEED_RSS) ? 'en-en' : 'en';
242 * Format the latest item date found according to the feed type.
244 * Return an empty string if invalid DateTime is passed.
246 * @return string Formatted date.
248 protected function getLatestDateFormatted()
250 if (empty($this->latestDate
) || !$this->latestDate
instanceof DateTime
) {
254 $type = ($this->feedType
== self
::$FEED_RSS) ? DateTime
::RSS
: DateTime
::ATOM
;
255 return $this->latestDate
->format($type);
259 * Get ISO date from DateTime according to feed type.
261 * @param DateTime $date Date to format.
262 * @param string|bool $format Force format.
264 * @return string Formatted date.
266 protected function getIsoDate(DateTime
$date, $format = false)
268 if ($format !== false) {
269 return $date->format($format);
271 if ($this->feedType
== self
::$FEED_RSS) {
272 return $date->format(DateTime
::RSS
);
275 return $date->format(DateTime
::ATOM
);
279 * Returns the number of link to display according to 'nb' user input parameter.
281 * If 'nb' not set or invalid, default value: $DEFAULT_NB_LINKS.
282 * If 'nb' is set to 'all', display all filtered links (max parameter).
284 * @param int $max maximum number of links to display.
286 * @return int number of links to display.
288 public function getNbLinks($max)
290 if (empty($this->userInput
['nb'])) {
291 return self
::$DEFAULT_NB_LINKS;
294 if ($this->userInput
['nb'] == 'all') {
298 $intNb = intval($this->userInput
['nb']);
299 if (! is_int($intNb) || $intNb == 0) {
300 return self
::$DEFAULT_NB_LINKS;