application/FeedBuilder.php

   1 <?php
   2
   3 /**
   4  * FeedBuilder class.
   5  *
   6  * Used to build ATOM and RSS feeds data.
   7  */
   8 class FeedBuilder
   9 {
  10     /**
  11      * @var string Constant: RSS feed type.
  12      */
  13     public static $FEED_RSS = 'rss';
  14
  15     /**
  16      * @var string Constant: ATOM feed type.
  17      */
  18     public static $FEED_ATOM = 'atom';
  19
  20     /**
  21      * @var string Default language if the locale isn't set.
  22      */
  23     public static $DEFAULT_LANGUAGE = 'en-en';
  24
  25     /**
  26      * @var int Number of links to display in a feed by default.
  27      */
  28     public static $DEFAULT_NB_LINKS = 50;
  29
  30     /**
  31      * @var LinkDB instance.
  32      */
  33     protected $linkDB;
  34
  35     /**
  36      * @var string RSS or ATOM feed.
  37      */
  38     protected $feedType;
  39
  40     /**
  41      * @var array $_SERVER.
  42      */
  43     protected $serverInfo;
  44
  45     /**
  46      * @var array $_GET.
  47      */
  48     protected $userInput;
  49
  50     /**
  51      * @var boolean True if the user is currently logged in, false otherwise.
  52      */
  53     protected $isLoggedIn;
  54
  55     /**
  56      * @var boolean Use permalinks instead of direct links if true.
  57      */
  58     protected $usePermalinks;
  59
  60     /**
  61      * @var boolean true to hide dates in feeds.
  62      */
  63     protected $hideDates;
  64
  65     /**
  66      * @var string PubSub hub URL.
  67      */
  68     protected $pubsubhubUrl;
  69
  70     /**
  71      * @var string server locale.
  72      */
  73     protected $locale;
  74
  75     /**
  76      * @var DateTime Latest item date.
  77      */
  78     protected $latestDate;
  79
  80     /**
  81      * Feed constructor.
  82      *
  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.
  88      */
  89     public function __construct($linkDB, $feedType, $serverInfo, $userInput, $isLoggedIn)
  90     {
  91         $this->linkDB = $linkDB;
  92         $this->feedType = $feedType;
  93         $this->serverInfo = $serverInfo;
  94         $this->userInput = $userInput;
  95         $this->isLoggedIn = $isLoggedIn;
  96     }
  97
  98     /**
  99      * Build data for feed templates.
 100      *
 101      * @return array Formatted data for feeds templates.
 102      */
 103     public function buildData()
 104     {
 105         // Optionally filter the results:
 106         $linksToDisplay = $this->linkDB->filterSearch($this->userInput);
 107
 108         $nblinksToDisplay = $this->getNbLinks(count($linksToDisplay));
 109
 110         // Can't use array_keys() because $link is a LinkDB instance and not a real array.
 111         $keys = array();
 112         foreach ($linksToDisplay as $key => $value) {
 113             $keys[] = $key;
 114         }
 115
 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);
 120         }
 121
 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'] = escape(server_url($this->serverInfo))
 128                            . escape($this->serverInfo['REQUEST_URI']);
 129         $data['index_url'] = $pageaddr;
 130         $data['usepermalinks'] = $this->usePermalinks === true;
 131         $data['links'] = $linkDisplayed;
 132
 133         return $data;
 134     }
 135
 136     /**
 137      * Build a feed item (one per shaare).
 138      *
 139      * @param array  $link     Single link array extracted from LinkDB.
 140      * @param string $pageaddr Index URL.
 141      *
 142      * @return array Link array with feed attributes.
 143      */
 144     protected function buildItem($link, $pageaddr)
 145     {
 146         $link['guid'] = $pageaddr .'?'. smallHash($link['linkdate']);
 147         // Check for both signs of a note: starting with ? and 7 chars long.
 148         if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
 149             $link['url'] = $pageaddr . $link['url'];
 150         }
 151         if ($this->usePermalinks === true) {
 152             $permalink = '<a href="'. $link['url'] .'" title="Direct link">Direct link</a>';
 153         } else {
 154             $permalink = '<a href="'. $link['guid'] .'" title="Permalink">Permalink</a>';
 155         }
 156         $link['description'] = format_description($link['description']) . PHP_EOL .'<br>&#8212; '. $permalink;
 157
 158         $pubDate = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['linkdate']);
 159         $link['pub_iso_date'] = $this->getIsoDate($pubDate);
 160
 161         // atom:entry elements MUST contain exactly one atom:updated element.
 162         if (!empty($link['updated'])) {
 163             $upDate = DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, $link['updated']);
 164             $link['up_iso_date'] = $this->getIsoDate($upDate, DateTime::ATOM);
 165         } else {
 166             $link['up_iso_date'] = $this->getIsoDate($pubDate, DateTime::ATOM);;
 167         }
 168
 169         // Save the more recent item.
 170         if (empty($this->latestDate) || $this->latestDate < $pubDate) {
 171             $this->latestDate = $pubDate;
 172         }
 173         if (!empty($upDate) && $this->latestDate < $upDate) {
 174             $this->latestDate = $upDate;
 175         }
 176
 177         $taglist = array_filter(explode(' ', $link['tags']), 'strlen');
 178         uasort($taglist, 'strcasecmp');
 179         $link['taglist'] = $taglist;
 180
 181         return $link;
 182     }
 183
 184     /**
 185      * Assign PubSub hub URL.
 186      *
 187      * @param string $pubsubhubUrl PubSub hub url.
 188      */
 189     public function setPubsubhubUrl($pubsubhubUrl)
 190     {
 191         $this->pubsubhubUrl = $pubsubhubUrl;
 192     }
 193
 194     /**
 195      * Set this to true to use permalinks instead of direct links.
 196      *
 197      * @param boolean $usePermalinks true to force permalinks.
 198      */
 199     public function setUsePermalinks($usePermalinks)
 200     {
 201         $this->usePermalinks = $usePermalinks;
 202     }
 203
 204     /**
 205      * Set this to true to hide timestamps in feeds.
 206      *
 207      * @param boolean $hideDates true to enable.
 208      */
 209     public function setHideDates($hideDates)
 210     {
 211         $this->hideDates = $hideDates;
 212     }
 213
 214     /**
 215      * Set the locale. Used to show feed language.
 216      *
 217      * @param string $locale The locale (eg. 'fr_FR.UTF8').
 218      */
 219     public function setLocale($locale)
 220     {
 221         $this->locale = strtolower($locale);
 222     }
 223
 224     /**
 225      * Get the language according to the feed type, based on the locale:
 226      *
 227      *   - RSS format: en-us (default: 'en-en').
 228      *   - ATOM format: fr (default: 'en').
 229      *
 230      * @return string The language.
 231      */
 232     public function getTypeLanguage()
 233     {
 234         // Use the locale do define the language, if available.
 235         if (! empty($this->locale) && preg_match('/^\w{2}[_\-]\w{2}/', $this->locale)) {
 236             $length = ($this->feedType == self::$FEED_RSS) ? 5 : 2;
 237             return str_replace('_', '-', substr($this->locale, 0, $length));
 238         }
 239         return ($this->feedType == self::$FEED_RSS) ? 'en-en' : 'en';
 240     }
 241
 242     /**
 243      * Format the latest item date found according to the feed type.
 244      *
 245      * Return an empty string if invalid DateTime is passed.
 246      *
 247      * @return string Formatted date.
 248      */
 249     protected function getLatestDateFormatted()
 250     {
 251         if (empty($this->latestDate) || !$this->latestDate instanceof DateTime) {
 252             return '';
 253         }
 254
 255         $type = ($this->feedType == self::$FEED_RSS) ? DateTime::RSS : DateTime::ATOM;
 256         return $this->latestDate->format($type);
 257     }
 258
 259     /**
 260      * Get ISO date from DateTime according to feed type.
 261      *
 262      * @param DateTime    $date   Date to format.
 263      * @param string|bool $format Force format.
 264      *
 265      * @return string Formatted date.
 266      */
 267     protected function getIsoDate(DateTime $date, $format = false)
 268     {
 269         if ($format !== false) {
 270             return $date->format($format);
 271         }
 272         if ($this->feedType == self::$FEED_RSS) {
 273             return $date->format(DateTime::RSS);
 274
 275         }
 276         return $date->format(DateTime::ATOM);
 277     }
 278
 279     /**
 280      * Returns the number of link to display according to 'nb' user input parameter.
 281      *
 282      * If 'nb' not set or invalid, default value: $DEFAULT_NB_LINKS.
 283      * If 'nb' is set to 'all', display all filtered links (max parameter).
 284      *
 285      * @param int $max maximum number of links to display.
 286      *
 287      * @return int number of links to display.
 288      */
 289     public function getNbLinks($max)
 290     {
 291         if (empty($this->userInput['nb'])) {
 292             return self::$DEFAULT_NB_LINKS;
 293         }
 294
 295         if ($this->userInput['nb'] == 'all') {
 296             return $max;
 297         }
 298
 299         $intNb = intval($this->userInput['nb']);
 300         if (! is_int($intNb) || $intNb == 0) {
 301             return self::$DEFAULT_NB_LINKS;
 302         }
 303
 304         return $intNb;
 305     }
 306 }