]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/conversation.php
change controlyourself.ca to status.net
[quix0rs-gnu-social.git] / actions / conversation.php
index f3beade6c77b6772541a54534d4b724a8890e8c5..b284e4dd7514a6eb1755221ab05874a59e99d1a3 100644 (file)
@@ -5,13 +5,13 @@
  * PHP version 5
  *
  * @category Action
- * @package  Laconica
- * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
- * @link     http://laconi.ca/
+ * @link     http://status.net/
  *
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2009, StatusNet, Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
@@ -31,21 +31,24 @@ if (!defined('LACONICA')) {
     exit(1);
 }
 
-require_once(INSTALLDIR.'/lib/noticelist.php');
+// XXX: not sure how to do paging yet,
+// so set a 60-notice limit
+
+require_once INSTALLDIR.'/lib/noticelist.php';
 
 /**
  * Conversation tree in the browser
  *
  * @category Action
- * @package  Laconica
- * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
- * @link     http://laconi.ca/
+ * @link     http://status.net/
  */
 
 class ConversationAction extends Action
 {
-    var $id = null;
+    var $id   = null;
     var $page = null;
 
     /**
@@ -63,6 +66,7 @@ class ConversationAction extends Action
         if (empty($this->id)) {
             return false;
         }
+        $this->id = $this->id+0;
         $this->page = $this->trimmed('page');
         if (empty($this->page)) {
             $this->page = 1;
@@ -70,60 +74,115 @@ class ConversationAction extends Action
         return true;
     }
 
+    /**
+     * Handle the action
+     *
+     * @param array $args Web and URL arguments
+     *
+     * @return void
+     */
+
     function handle($args)
     {
         parent::handle($args);
         $this->showPage();
     }
 
+    /**
+     * Returns the page title
+     *
+     * @return string page title
+     */
+
     function title()
     {
         return _("Conversation");
     }
 
+    /**
+     * Show content.
+     *
+     * Display a hierarchical unordered list in the content area.
+     * Uses ConversationTree to do most of the heavy lifting.
+     *
+     * @return void
+     */
+
     function showContent()
     {
-        // FIXME this needs to be a tree, not a list
-
-        $qry = 'SELECT * FROM notice WHERE conversation = %s ';
-
-        $offset = ($this->page-1)*NOTICES_PER_PAGE;
-        $limit  = NOTICES_PER_PAGE + 1;
-
-        $txt = sprintf($qry, $this->id);
-
-        $notices = Notice::getStream($txt,
-                                     'notice:conversation:'.$this->id,
-                                     $offset, $limit);
+        $notices = Notice::conversationStream($this->id, null, null);
 
         $ct = new ConversationTree($notices, $this);
 
         $cnt = $ct->show();
-
-        $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
-                          $this->page, 'conversation', array('id' => $this->id));
     }
 
+    function isReadOnly()
+    {
+        return true;
+    }
 }
 
+/**
+ * Conversation tree
+ *
+ * The widget class for displaying a hierarchical list of notices.
+ *
+ * @category Widget
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ */
+
 class ConversationTree extends NoticeList
 {
-    var $tree = null;
+    var $tree  = null;
     var $table = null;
 
+    /**
+     * Show the tree of notices
+     *
+     * @return void
+     */
+
     function show()
+    {
+        $cnt = $this->_buildTree();
+
+        $this->out->elementStart('div', array('id' =>'notices_primary'));
+        $this->out->element('h2', null, _('Notices'));
+        $this->out->elementStart('ol', array('class' => 'notices xoxo'));
+
+        if (array_key_exists('root', $this->tree)) {
+            $rootid = $this->tree['root'][0];
+            $this->showNoticePlus($rootid);
+        }
+
+        $this->out->elementEnd('ol');
+        $this->out->elementEnd('div');
+
+        return $cnt;
+    }
+
+    function _buildTree()
     {
         $cnt = 0;
 
-        $this->tree = array();
-        $table = array();
+        $this->tree  = array();
+        $this->table = array();
 
         while ($this->notice->fetch()) {
+
             $cnt++;
-            $this->table[$this->notice->id] = clone($this->notice);
+
+            $id     = $this->notice->id;
+            $notice = clone($this->notice);
+
+            $this->table[$id] = $notice;
+
             if (is_null($notice->reply_to)) {
-                // We assume no notice has -1 ID
-                $this->tree[-1] = array($notice->id);
+                $this->tree['root'] = array($notice->id);
             } else if (array_key_exists($notice->reply_to, $this->tree)) {
                 $this->tree[$notice->reply_to][] = $notice->id;
             } else {
@@ -131,30 +190,25 @@ class ConversationTree extends NoticeList
             }
         }
 
-        $this->out->elementStart('div', array('id' =>'notices_primary'));
-        $this->out->element('h2', null, _('Notices'));
-        $this->out->elementStart('ul', array('class' => 'notices'));
-
-        if (array_key_exists(-1, $this->tree)) {
-            $this->showNoticePlus($this->tree[-1][0]);
-        }
-
-        $this->out->elementEnd('ul');
-        $this->out->elementEnd('div');
-
         return $cnt;
     }
 
+    /**
+     * Shows a notice plus its list of children.
+     *
+     * @param integer $id ID of the notice to show
+     *
+     * @return void
+     */
+
     function showNoticePlus($id)
     {
         $notice = $this->table[$id];
 
-        print_r($notice);
-
         // We take responsibility for doing the li
 
         $this->out->elementStart('li', array('class' => 'hentry notice',
-                                             'id' => 'notice-' . $this->notice->id));
+                                             'id' => 'notice-' . $id));
 
         $item = $this->newListItem($notice);
         $item->show();
@@ -162,38 +216,86 @@ class ConversationTree extends NoticeList
         if (array_key_exists($id, $this->tree)) {
             $children = $this->tree[$id];
 
-            $this->out->elementStart('ul', array('class' => 'notices'));
+            $this->out->elementStart('ol', array('class' => 'notices'));
+
+            sort($children);
 
             foreach ($children as $child) {
                 $this->showNoticePlus($child);
             }
 
-            $this->out->elementEnd('ul');
+            $this->out->elementEnd('ol');
         }
 
         $this->out->elementEnd('li');
     }
 
+    /**
+     * Override parent class to return our preferred item.
+     *
+     * @param Notice $notice Notice to display
+     *
+     * @return NoticeListItem a list item to show
+     */
+
     function newListItem($notice)
     {
         return new ConversationTreeItem($notice, $this->out);
     }
 }
 
+/**
+ * Conversation tree list item
+ *
+ * Special class of NoticeListItem for use inside conversation trees.
+ *
+ * @category Widget
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ */
+
 class ConversationTreeItem extends NoticeListItem
 {
+    /**
+     * start a single notice.
+     *
+     * The default creates the <li>; we skip, since the ConversationTree
+     * takes care of that.
+     *
+     * @return void
+     */
+
     function showStart()
     {
-        // skip; ConversationTree draws the list
+        return;
     }
 
+    /**
+     * finish the notice
+     *
+     * The default closes the <li>; we skip, since the ConversationTree
+     * takes care of that.
+     *
+     * @return void
+     */
+
     function showEnd()
     {
-        // skip; ConversationTree draws the list
+        return;
     }
 
+    /**
+     * show link to notice conversation page
+     *
+     * Since we're only used on the conversation page, we skip this
+     *
+     * @return void
+     */
+
     function showContext()
     {
-        // skip; this _is_ the context!
+        return;
     }
-}
\ No newline at end of file
+}