actions/conversation.php

   1 <?php
   2 /**
   3  * Display a conversation in the browser
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2009, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 // XXX: not sure how to do paging yet,
  35 // so set a 60-notice limit
  36
  37 require_once INSTALLDIR.'/lib/noticelist.php';
  38
  39 /**
  40  * Conversation tree in the browser
  41  *
  42  * @category Action
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  46  * @link     http://status.net/
  47  */
  48
  49 class ConversationAction extends Action
  50 {
  51     var $id   = null;
  52     var $page = null;
  53
  54     /**
  55      * Initialization.
  56      *
  57      * @param array $args Web and URL arguments
  58      *
  59      * @return boolean false if id not passed in
  60      */
  61
  62     function prepare($args)
  63     {
  64         parent::prepare($args);
  65         $this->id = $this->trimmed('id');
  66         if (empty($this->id)) {
  67             return false;
  68         }
  69         $this->id = $this->id+0;
  70         $this->page = $this->trimmed('page');
  71         if (empty($this->page)) {
  72             $this->page = 1;
  73         }
  74         return true;
  75     }
  76
  77     /**
  78      * Handle the action
  79      *
  80      * @param array $args Web and URL arguments
  81      *
  82      * @return void
  83      */
  84
  85     function handle($args)
  86     {
  87         parent::handle($args);
  88         $this->showPage();
  89     }
  90
  91     /**
  92      * Returns the page title
  93      *
  94      * @return string page title
  95      */
  96
  97     function title()
  98     {
  99         return _("Conversation");
 100     }
 101
 102     /**
 103      * Show content.
 104      *
 105      * Display a hierarchical unordered list in the content area.
 106      * Uses ConversationTree to do most of the heavy lifting.
 107      *
 108      * @return void
 109      */
 110
 111     function showContent()
 112     {
 113         $notices = Notice::conversationStream($this->id, null, null);
 114
 115         $ct = new ConversationTree($notices, $this);
 116
 117         $cnt = $ct->show();
 118     }
 119
 120     function isReadOnly()
 121     {
 122         return true;
 123     }
 124 }
 125
 126 /**
 127  * Conversation tree
 128  *
 129  * The widget class for displaying a hierarchical list of notices.
 130  *
 131  * @category Widget
 132  * @package  StatusNet
 133  * @author   Evan Prodromou <evan@status.net>
 134  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
 135  * @link     http://status.net/
 136  */
 137
 138 class ConversationTree extends NoticeList
 139 {
 140     var $tree  = null;
 141     var $table = null;
 142
 143     /**
 144      * Show the tree of notices
 145      *
 146      * @return void
 147      */
 148
 149     function show()
 150     {
 151         $cnt = $this->_buildTree();
 152
 153         $this->out->elementStart('div', array('id' =>'notices_primary'));
 154         $this->out->element('h2', null, _('Notices'));
 155         $this->out->elementStart('ol', array('class' => 'notices xoxo'));
 156
 157         if (array_key_exists('root', $this->tree)) {
 158             $rootid = $this->tree['root'][0];
 159             $this->showNoticePlus($rootid);
 160         }
 161
 162         $this->out->elementEnd('ol');
 163         $this->out->elementEnd('div');
 164
 165         return $cnt;
 166     }
 167
 168     function _buildTree()
 169     {
 170         $cnt = 0;
 171
 172         $this->tree  = array();
 173         $this->table = array();
 174
 175         while ($this->notice->fetch()) {
 176
 177             $cnt++;
 178
 179             $id     = $this->notice->id;
 180             $notice = clone($this->notice);
 181
 182             $this->table[$id] = $notice;
 183
 184             if (is_null($notice->reply_to)) {
 185                 $this->tree['root'] = array($notice->id);
 186             } else if (array_key_exists($notice->reply_to, $this->tree)) {
 187                 $this->tree[$notice->reply_to][] = $notice->id;
 188             } else {
 189                 $this->tree[$notice->reply_to] = array($notice->id);
 190             }
 191         }
 192
 193         return $cnt;
 194     }
 195
 196     /**
 197      * Shows a notice plus its list of children.
 198      *
 199      * @param integer $id ID of the notice to show
 200      *
 201      * @return void
 202      */
 203
 204     function showNoticePlus($id)
 205     {
 206         $notice = $this->table[$id];
 207
 208         // We take responsibility for doing the li
 209
 210         $this->out->elementStart('li', array('class' => 'hentry notice',
 211                                              'id' => 'notice-' . $id));
 212
 213         $item = $this->newListItem($notice);
 214         $item->show();
 215
 216         if (array_key_exists($id, $this->tree)) {
 217             $children = $this->tree[$id];
 218
 219             $this->out->elementStart('ol', array('class' => 'notices'));
 220
 221             sort($children);
 222
 223             foreach ($children as $child) {
 224                 $this->showNoticePlus($child);
 225             }
 226
 227             $this->out->elementEnd('ol');
 228         }
 229
 230         $this->out->elementEnd('li');
 231     }
 232
 233     /**
 234      * Override parent class to return our preferred item.
 235      *
 236      * @param Notice $notice Notice to display
 237      *
 238      * @return NoticeListItem a list item to show
 239      */
 240
 241     function newListItem($notice)
 242     {
 243         return new ConversationTreeItem($notice, $this->out);
 244     }
 245 }
 246
 247 /**
 248  * Conversation tree list item
 249  *
 250  * Special class of NoticeListItem for use inside conversation trees.
 251  *
 252  * @category Widget
 253  * @package  StatusNet
 254  * @author   Evan Prodromou <evan@status.net>
 255  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
 256  * @link     http://status.net/
 257  */
 258
 259 class ConversationTreeItem extends NoticeListItem
 260 {
 261     /**
 262      * start a single notice.
 263      *
 264      * The default creates the <li>; we skip, since the ConversationTree
 265      * takes care of that.
 266      *
 267      * @return void
 268      */
 269
 270     function showStart()
 271     {
 272         return;
 273     }
 274
 275     /**
 276      * finish the notice
 277      *
 278      * The default closes the <li>; we skip, since the ConversationTree
 279      * takes care of that.
 280      *
 281      * @return void
 282      */
 283
 284     function showEnd()
 285     {
 286         return;
 287     }
 288
 289     /**
 290      * show link to notice conversation page
 291      *
 292      * Since we're only used on the conversation page, we skip this
 293      *
 294      * @return void
 295      */
 296
 297     function showContext()
 298     {
 299         return;
 300     }
 301 }