1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 | <?php /* * Copyright (C) 2008 Anis uddin Ahmad <anisniit@gmail.com> * Copyright (C) 2010-2012 Michael Bemmerl <mail@mx-server.de> * * This file is part of the "Universal Feed Writer" project. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ // RSS 0.90 Officially obsoleted by 1.0 // RSS 0.91, 0.92, 0.93 and 0.94 Officially obsoleted by 2.0 // So, define constants for RSS 1.0, RSS 2.0 and ATOM define('RSS1', 'RSS 1.0', true); define('RSS2', 'RSS 2.0', true); define('ATOM', 'ATOM', true); if (!class_exists('FeedItem')) require dirname(__FILE__) . '/FeedItem.php'; /** * Universal Feed Writer class * * Generate RSS 1.0, RSS2.0 and ATOM Feeds * * @package UniversalFeedWriter * @author Anis uddin Ahmad <anisniit@gmail.com> * @link http://www.ajaxray.com/projects/rss */ abstract class FeedWriter { private $channels = array(); // Collection of channel elements private $items = array(); // Collection of items as object of FeedItem class. private $data = array(); // Store some other version wise data private $CDATAEncoding = array(); // The tag names which have to encoded as CDATA private $version = null; /** * Constructor * * @param constant the version constant (RSS1/RSS2/ATOM). */ protected function __construct($version = RSS2) { $this->version = $version; // Setting default value for essential channel elements $this->channels['title'] = $version . ' Feed'; $this->channels['link'] = 'http://www.ajaxray.com/blog'; //Tag names to encode in CDATA $this->CDATAEncoding = array('description', 'content:encoded', 'summary'); } // Start # public functions --------------------------------------------- /** * Set a channel element * @access public * @param string name of the channel tag * @param string content of the channel tag * @return void */ public function setChannelElement($elementName, $content) { $this->channels[$elementName] = $content; } /** * Set multiple channel elements from an array. Array elements * should be 'channelName' => 'channelContent' format. * * @access public * @param array array of channels * @return void */ public function setChannelElementsFromArray($elementArray) { if (!is_array($elementArray)) return; foreach ($elementArray as $elementName => $content) { $this->setChannelElement($elementName, $content); } } /** * Genarate the actual RSS/ATOM file * * @access public * @param bool FALSE if the specific feed media type should be send. * @return void */ public function generateFeed($useGenericContentType = FALSE) { $contentType = "text/xml"; if (!$useGenericContentType) { switch($this->version) { case RSS2 : $contentType = "application/rss+xml"; break; case RSS1 : $contentType = "application/rdf+xml"; break; case ATOM : $contentType = "application/atom+xml"; break; } } header("Content-Type: " . $contentType); $this->printHeader(); $this->printChannels(); $this->printItems(); $this->printFooter(); } /** * Create a new FeedItem. * * @access public * @return object instance of FeedItem class */ public function createNewItem() { $Item = new FeedItem($this->version); return $Item; } /** * Add a FeedItem to the main class * * @access public * @param object instance of FeedItem class * @return void */ public function addItem(FeedItem $feedItem) { if ($feedItem->getVersion() != $this->version) die('Feed type mismatch: This instance can handle ' . $this->version . ' feeds only, but item with type ' . $feedItem->getVersion() . ' given.'); $this->items[] = $feedItem; } // Wrapper functions ------------------------------------------------------------------- /** * Set the 'title' channel element * * @access public * @param string value of 'title' channel tag * @return void */ public function setTitle($title) { $this->setChannelElement('title', $title); } /** * Set the 'updated' channel element of an ATOM feed * * @access public * @param string value of 'updated' channel tag * @return void */ public function setDate($date) { if ($this->version != ATOM) return; if ($date instanceof DateTime) $date = $date->format(DateTime::ATOM); else if(is_numeric($date)) $date = date(DATE_ATOM, $date); else $date = date(DATE_ATOM, strtotime($date)); $this->setChannelElement('updated', $date); } /** * Set the 'description' channel element * * @access public * @param string value of 'description' channel tag * @return void */ public function setDescription($desciption) { if ($this->version != ATOM) $this->setChannelElement('description', $desciption); } /** * Set the 'link' channel element * * @access public * @param string value of 'link' channel tag * @return void */ public function setLink($link) { $this->setChannelElement('link', $link); } /** * Set the 'image' channel element * * @access public * @param string title of image * @param string link url of the image * @param string path url of the image * @return void */ public function setImage($title, $link, $url) { $this->setChannelElement('image', array('title'=>$title, 'link'=>$link, 'url'=>$url)); } /** * Set the 'about' channel element. Only for RSS 1.0 * * @access public * @param string value of 'about' channel tag * @return void */ public function setChannelAbout($url) { $this->data['ChannelAbout'] = $url; } /** * Generates an UUID * @author Anis uddin Ahmad <admin@ajaxray.com> * @param string an optional prefix * @return string the formated uuid */ public static function uuid($key = null, $prefix = '') { $key = ($key == null)? uniqid(rand()) : $key; $chars = md5($key); $uuid = substr($chars,0,8) . '-'; $uuid .= substr($chars,8,4) . '-'; $uuid .= substr($chars,12,4) . '-'; $uuid .= substr($chars,16,4) . '-'; $uuid .= substr($chars,20,12); return $prefix . $uuid; } // End # public functions ---------------------------------------------- // Start # private functions ---------------------------------------------- /** * Prints the xml and rss namespace * * @access private * @return void */ private function printHeader() { $out = '<?xml version="1.0" encoding="utf-8"?>' . PHP_EOL; if($this->version == RSS2) { $out .= '<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:wfw="http://wellformedweb.org/CommentAPI/">'; } elseif($this->version == RSS1) { $out .= '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns="http://purl.org/rss/1.0/" xmlns:dc="http://purl.org/dc/elements/1.1/">'; } else if($this->version == ATOM) { $out .= '<feed xmlns="http://www.w3.org/2005/Atom">'; } $out .= PHP_EOL; echo $out; } /** * Closes the open tags at the end of file * * @access private * @return void */ private function printFooter() { if($this->version == RSS2) { echo '</channel>' . PHP_EOL . '</rss>'; } elseif($this->version == RSS1) { echo '</rdf:RDF>'; } else if($this->version == ATOM) { echo '</feed>'; } } /** * Creates a single node as xml format * * @access private * @param string name of the tag * @param mixed tag value as string or array of nested tags in 'tagName' => 'tagValue' format * @param array Attributes(if any) in 'attrName' => 'attrValue' format * @return string formatted xml tag */ private function makeNode($tagName, $tagContent, $attributes = null) { $nodeText = ''; $attrText = ''; if(is_array($attributes) && count($attributes) > 0) { foreach ($attributes as $key => $value) { $value = htmlspecialchars($value); $attrText .= " $key=\"$value\" "; } // Get rid of the last whitespace $attrText = substr($attrText, 0, strlen($attrText) - 1); } if(is_array($tagContent) && $this->version == RSS1) { $attrText = ' rdf:parseType="Resource"'; } $attrText .= (in_array($tagName, $this->CDATAEncoding) && $this->version == ATOM) ? ' type="html"' : ''; $nodeText .= "<{$tagName}{$attrText}>"; $nodeText .= (in_array($tagName, $this->CDATAEncoding)) ? '<![CDATA[' : ''; if(is_array($tagContent)) { foreach ($tagContent as $key => $value) { $nodeText .= $this->makeNode($key, $value); } } else { $nodeText .= (in_array($tagName, $this->CDATAEncoding))? $this->sanitizeCDATA($tagContent) : htmlspecialchars($tagContent); } $nodeText .= (in_array($tagName, $this->CDATAEncoding)) ? ']]>' : ''; $nodeText .= "</$tagName>" . PHP_EOL; return $nodeText; } /** * @desc Print channels * @access private * @return void */ private function printChannels() { //Start channel tag switch ($this->version) { case RSS2: echo '<channel>' |