lib/atomnoticefeed.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Class for building an Atom feed from a collection of notices
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Feed
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET'))
  31 {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Class for creating a feed that represents a collection of notices. Builds the
  37  * feed in memory. Get the feed as a string with AtomNoticeFeed::getString().
  38  *
  39  * @category Feed
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45 class AtomNoticeFeed extends Atom10Feed
  46 {
  47     var $cur;
  48
  49     /**
  50      * Constructor - adds a bunch of XML namespaces we need in our
  51      * notice-specific Atom feeds, and allows setting the current
  52      * authenticated user (useful for API methods).
  53      *
  54      * @param User    $cur     the current authenticated user (optional)
  55      * @param boolean $indent  Whether to indent XML output
  56      *
  57      */
  58     function __construct($cur = null, $indent = true) {
  59         parent::__construct($indent);
  60
  61         $this->cur = $cur;
  62
  63         // Feeds containing notice info use these namespaces
  64
  65         $this->addNamespace(
  66             'thr',
  67             'http://purl.org/syndication/thread/1.0'
  68         );
  69
  70         $this->addNamespace(
  71             'georss',
  72             'http://www.georss.org/georss'
  73         );
  74
  75         $this->addNamespace(
  76             'activity',
  77             'http://activitystrea.ms/spec/1.0/'
  78         );
  79
  80         $this->addNamespace(
  81             'media',
  82             'http://purl.org/syndication/atommedia'
  83         );
  84
  85         $this->addNamespace(
  86             'poco',
  87             'http://portablecontacts.net/spec/1.0'
  88         );
  89
  90         // XXX: What should the uri be?
  91         $this->addNamespace(
  92             'ostatus',
  93             'http://ostatus.org/schema/1.0'
  94         );
  95
  96         $this->addNamespace(
  97             'statusnet',
  98             'http://status.net/schema/api/1/'
  99         );
 100     }
 101
 102     /**
 103      * Add more than one Notice to the feed
 104      *
 105      * @param mixed $notices an array of Notice objects or handle
 106      *
 107      */
 108     function addEntryFromNotices($notices)
 109     {
 110         if (is_array($notices)) {
 111             foreach ($notices as $notice) {
 112                 $this->addEntryFromNotice($notice);
 113             }
 114         } else {
 115             while ($notices->fetch()) {
 116                 $this->addEntryFromNotice($notices);
 117             }
 118         }
 119     }
 120
 121     /**
 122      * Add a single Notice to the feed
 123      *
 124      * @param Notice $notice a Notice to add
 125      */
 126     function addEntryFromNotice($notice)
 127     {
 128         $source = $this->showSource();
 129         $author = $this->showAuthor();
 130
 131         $cur = empty($this->cur) ? common_current_user() : $this->cur;
 132
 133         $this->addEntryRaw($notice->asAtomEntry(false, $source, $author, $cur));
 134     }
 135
 136     function showSource()
 137     {
 138         return true;
 139     }
 140
 141     function showAuthor()
 142     {
 143         return true;
 144     }
 145 }