]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/threadednoticelist.php
Move prefill call to noticelist class
[quix0rs-gnu-social.git] / lib / threadednoticelist.php
index 6fb059491a28be0b708ca67a0be097ae1f688c4f..45c11453a7a63699f9cfb866c39939375d08f9c2 100644 (file)
@@ -48,9 +48,19 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
  * @see      NoticeListItem
  * @see      ProfileNoticeList
  */
-
 class ThreadedNoticeList extends NoticeList
 {
+    protected $userProfile;
+
+    function __construct($notice, $out=null, $profile=-1)
+    {
+        parent::__construct($notice, $out);
+        if (is_int($profile) && $profile == -1) {
+            $profile = Profile::current();
+        }
+        $this->userProfile = $profile;
+    }
+
     /**
      * show the list of notices
      *
@@ -59,23 +69,32 @@ class ThreadedNoticeList extends NoticeList
      *
      * @return int count of notices listed.
      */
-
     function show()
     {
         $this->out->elementStart('div', array('id' =>'notices_primary'));
-        $this->out->element('h2', null, _('Notices'));
+        // TRANS: Header for Notices section.
+        $this->out->element('h2', null, _m('HEADER','Notices'));
         $this->out->elementStart('ol', array('class' => 'notices threaded-notices xoxo'));
 
+               $notices = $this->notice->fetchAll();
+               $notices = array_slice($notices, 0, NOTICES_PER_PAGE);
+               
+       $this->prefill($notices);
+       
         $cnt = 0;
         $conversations = array();
-        while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
-            $cnt++;
-
-            if ($cnt > NOTICES_PER_PAGE) {
-                break;
+        
+        foreach ($notices as $notice) {
+
+            // Collapse repeats into their originals...
+            
+            if ($notice->repeat_of) {
+                $orig = Notice::staticGet('id', $notice->repeat_of);
+                if ($orig) {
+                    $notice = $orig;
+                }
             }
-
-            $convo = $this->notice->conversation;
+            $convo = $notice->conversation;
             if (!empty($conversations[$convo])) {
                 // Seen this convo already -- skip!
                 continue;
@@ -83,14 +102,10 @@ class ThreadedNoticeList extends NoticeList
             $conversations[$convo] = true;
 
             // Get the convo's root notice
-            // @fixme stream goes in wrong direction, this needs sane caching
-            //$notice = Notice::conversationStream($convo, 0, 1);
-            //$notice->fetch();
-            $notice = new Notice();
-            $notice->conversation = $this->notice->conversation;
-            $notice->orderBy('CREATED');
-            $notice->limit(1);
-            $notice->find(true);
+            $root = $notice->conversationRoot($this->userProfile);
+            if ($root) {
+                $notice = $root;
+            }
 
             try {
                 $item = $this->newListItem($notice);
@@ -118,10 +133,9 @@ class ThreadedNoticeList extends NoticeList
      *
      * @return NoticeListItem a list item for displaying the notice
      */
-
     function newListItem($notice)
     {
-        return new ThreadedNoticeListItem($notice, $this->out);
+        return new ThreadedNoticeListItem($notice, $this->out, $this->userProfile);
     }
 }
 
@@ -142,10 +156,20 @@ class ThreadedNoticeList extends NoticeList
  * @see      NoticeList
  * @see      ProfileNoticeListItem
  */
-
 class ThreadedNoticeListItem extends NoticeListItem
 {
-    const INITIAL_ITEMS = 3;
+    protected $userProfile = null;
+
+    function __construct($notice, $out=null, $profile=null)
+    {
+        parent::__construct($notice, $out);
+        $this->userProfile = $profile;
+    }
+
+    function initialItems()
+    {
+        return 3;
+    }
 
     function showContext()
     {
@@ -159,56 +183,91 @@ class ThreadedNoticeListItem extends NoticeListItem
      *
      * @return void
      */
-
     function showEnd()
     {
+        $max = $this->initialItems();
         if (!$this->repeat) {
-            $notice = Notice::conversationStream($this->notice->conversation, 0, self::INITIAL_ITEMS + 2);
+            $stream = new ConversationNoticeStream($this->notice->conversation, $this->userProfile);
+            $notice = $stream->getNotices(0, $max + 2);
             $notices = array();
             $cnt = 0;
             $moreCutoff = null;
             while ($notice->fetch()) {
-                if ($notice->id == $this->notice->id) {
-                    // Skip!
-                    continue;
-                }
-                $cnt++;
-                if ($cnt > self::INITIAL_ITEMS) {
-                    // boo-yah
-                    $moreCutoff = clone($notice);
-                    break;
+                if (Event::handle('StartAddNoticeReply', array($this, $this->notice, $notice))) {
+                    if ($notice->id == $this->notice->id) {
+                        // Skip!
+                        continue;
+                    }
+                    $cnt++;
+                    if ($cnt > $max) {
+                        // boo-yah
+                        $moreCutoff = clone($notice);
+                        break;
+                    }
+                    $notices[] = clone($notice); // *grumble* inefficient as hell
+                    Event::handle('EndAddNoticeReply', array($this, $this->notice, $notice));
                 }
-                $notices[] = clone($notice); // *grumble* inefficient as hell
             }
 
-            if ($notices) {
+            if (Event::handle('StartShowThreadedNoticeTail', array($this, $this->notice, &$notices))) {
                 $this->out->elementStart('ul', 'notices threaded-replies xoxo');
+
                 $item = new ThreadedNoticeListFavesItem($this->notice, $this->out);
                 $hasFaves = $item->show();
-                if ($moreCutoff) {
-                    $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out);
-                    $item->show();
-                }
-                foreach (array_reverse($notices) as $notice) {
-                    $item = new ThreadedNoticeListSubItem($notice, $this->out);
-                    $item->show();
+
+                $item = new ThreadedNoticeListRepeatsItem($this->notice, $this->out);
+                $hasRepeats = $item->show();
+
+                if ($notices) {
+
+                    if ($moreCutoff) {
+                        $item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out, count($notices));
+                        $item->show();
+                    }
+                    // XXX: replicating NoticeList::prefill(), annoyingly
+                    $this->prefill($notices);
+                    foreach (array_reverse($notices) as $notice) {
+                        if (Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice))) {
+                            $item = new ThreadedNoticeListSubItem($notice, $this->notice, $this->out);
+                            $item->show();
+                            Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice));
+                        }
+                    }
                 }
-                // @fixme do a proper can-post check that's consistent
-                // with the JS side
-                if (common_current_user()) {
-                    $item = new ThreadedNoticeListReplyItem($this->notice, $this->out);
-                    $item->show();
+
+                if ($notices || $hasFaves || $hasRepeats) {
+                    // @fixme do a proper can-post check that's consistent
+                    // with the JS side
+                    if (common_current_user()) {
+                        $item = new ThreadedNoticeListReplyItem($this->notice, $this->out);
+                        $item->show();
+                    }
                 }
                 $this->out->elementEnd('ul');
+                Event::handle('EndShowThreadedNoticeTail', array($this, $this->notice, $notices));
             }
         }
 
         parent::showEnd();
     }
+    
+    function prefill(&$notices)
+    {       
+       // Prefill the profiles
+       Notice::fillProfiles($notices);
+    }
 }
 
+// @todo FIXME: needs documentation.
 class ThreadedNoticeListSubItem extends NoticeListItem
 {
+    protected $root = null;
+
+    function __construct($notice, $root, $out)
+    {
+        $this->root = $root;
+        parent::__construct($notice, $out);
+    }
 
     function avatarSize()
     {
@@ -229,6 +288,30 @@ class ThreadedNoticeListSubItem extends NoticeListItem
     {
         //
     }
+
+    function getReplyProfiles()
+    {
+        $all = parent::getReplyProfiles();
+
+        $profiles = array();
+
+        $rootAuthor = $this->root->getProfile();
+
+        foreach ($all as $profile) {
+            if ($profile->id != $rootAuthor->id) {
+                $profiles[] = $profile;
+            }
+        }
+
+        return $profiles;
+    }
+
+    function showEnd()
+    {
+        $item = new ThreadedNoticeListInlineFavesItem($this->notice, $this->out);
+        $hasFaves = $item->show();
+        parent::showEnd();
+    }
 }
 
 /**
@@ -236,6 +319,13 @@ class ThreadedNoticeListSubItem extends NoticeListItem
  */
 class ThreadedNoticeListMoreItem extends NoticeListItem
 {
+    protected $cnt;
+
+    function __construct($notice, $out, $cnt)
+    {
+        parent::__construct($notice, $out);
+        $this->cnt = $cnt;
+    }
 
     /**
      * recipe function for displaying a single notice.
@@ -245,7 +335,6 @@ class ThreadedNoticeListMoreItem extends NoticeListItem
      *
      * @return void
      */
-
     function show()
     {
         $this->showStart();
@@ -258,7 +347,6 @@ class ThreadedNoticeListMoreItem extends NoticeListItem
      *
      * @return void
      */
-
     function showStart()
     {
         $this->out->elementStart('li', array('class' => 'notice-reply-comments'));
@@ -267,25 +355,24 @@ class ThreadedNoticeListMoreItem extends NoticeListItem
     function showMiniForm()
     {
         $id = $this->notice->conversation;
-        $url = common_local_url('conversation', array('id' => $id)) . '#notice-' . $this->notice->id;
+        $url = common_local_url('conversationreplies', array('id' => $id));
+
+        $n = Conversation::noticeCount($id) - 1;
 
-        $notice = new Notice();
-        $notice->conversation = $id;
-        $n = $notice->count() - 1;
-        $msg = sprintf(_m('Show %d reply', 'Show all %d replies', $n), $n);
+        // TRANS: Link to show replies for a notice.
+        // TRANS: %d is the number of replies to a notice and used for plural.
+        $msg = sprintf(_m('Show reply', 'Show all %d replies', $n), $n);
 
         $this->out->element('a', array('href' => $url), $msg);
     }
 }
 
-
 /**
  * Placeholder for reply form...
  * Same as get added at runtime via SN.U.NoticeInlineReplyPlaceholder
  */
 class ThreadedNoticeListReplyItem extends NoticeListItem
 {
-
     /**
      * recipe function for displaying a single notice.
      *
@@ -294,7 +381,6 @@ class ThreadedNoticeListReplyItem extends NoticeListItem
      *
      * @return void
      */
-
     function show()
     {
         $this->showStart();
@@ -307,7 +393,6 @@ class ThreadedNoticeListReplyItem extends NoticeListItem
      *
      * @return void
      */
-
     function showStart()
     {
         $this->out->elementStart('li', array('class' => 'notice-reply-placeholder'));
@@ -316,6 +401,7 @@ class ThreadedNoticeListReplyItem extends NoticeListItem
     function showMiniForm()
     {
         $this->out->element('input', array('class' => 'placeholder',
+                                           // TRANS: Field label for reply mini form.
                                            'value' => _('Write a reply...')));
     }
 }
@@ -323,57 +409,180 @@ class ThreadedNoticeListReplyItem extends NoticeListItem
 /**
  * Placeholder for showing faves...
  */
-class ThreadedNoticeListFavesItem extends NoticeListItem
+abstract class NoticeListActorsItem extends NoticeListItem
 {
+    /**
+     * @return array of profile IDs
+     */
+    abstract function getProfiles();
+
+    abstract function getListMessage($count, $you);
+
     function show()
     {
-        // @fixme caching & scalability!
-        $fave = new Fave();
-        $fave->notice_id = $this->notice->id;
-        $fave->find();
-
-        $cur = common_current_user();
-        $profiles = array();
+        $links = array();
         $you = false;
-        while ($fave->fetch()) {
-            if ($cur && $cur->id == $fave->user_id) {
+        $cur = common_current_user();
+        foreach ($this->getProfiles() as $id) {
+            if ($cur && $cur->id == $id) {
                 $you = true;
+                // TRANS: Reference to the logged in user in favourite list.
+                array_unshift($links, _m('FAVELIST', 'You'));
             } else {
-                $profiles[] = $fave->user_id;
-            }
-        }
-
-        $links = array();
-        if ($you) {
-            $links[] = _m('FAVELIST', 'You');
-        }
-        foreach ($profiles as $id) {
-            $profile = Profile::staticGet('id', $id);
-            if ($profile) {
-                $links[] = sprintf('<a href="%s" title="%s">%s</a>',
-                                   htmlspecialchars($profile->profileurl),
-                                   htmlspecialchars($profile->getBestName()),
-                                   htmlspecialchars($profile->nickname));
+                $profile = Profile::staticGet('id', $id);
+                if ($profile) {
+                    $links[] = sprintf('<a href="%s">%s</a>',
+                                       htmlspecialchars($profile->profileurl),
+                                       htmlspecialchars($profile->getBestName()));
+                }
             }
         }
 
         if ($links) {
             $count = count($links);
-            if ($count == 1 && $you) {
-                // darn first person being different from third person!
-                $msg = _m('FAVELIST', 'You have favored this notice');
-            } else {
-                // if 'you' is the first item...
-                $msg = _m('FAVELIST', '%1$s has favored this notice', '%1$s have favored this notice', $count);
-            }
-            $out = sprintf($msg, implode(', ', $links));
+            $msg = $this->getListMessage($count, $you);
+            $out = sprintf($msg, $this->magicList($links));
 
-            $this->out->elementStart('li', array('class' => 'notice-faves'));
+            $this->showStart();
             $this->out->raw($out);
-            $this->out->elementEnd('li');
+            $this->showEnd();
             return $count;
         } else {
             return 0;
         }
     }
+
+    function magicList($items)
+    {
+        if (count($items) == 0) {
+            return '';
+        } else if (count($items) == 1) {
+            return $items[0];
+        } else {
+            $first = array_slice($items, 0, -1);
+            $last = array_slice($items, -1, 1);
+            // TRANS: Separator in list of user names like "Jim, Bob, Mary".
+            $separator = _(', ');
+            // TRANS: For building a list such as "Jim, Bob, Mary and 5 others like this".
+            // TRANS: %1$s is a list of users, separated by a separator (default: ", "), %2$s is the last user in the list.
+            return sprintf(_m('FAVELIST', '%1$s and %2$s'), implode($separator, $first), implode($separator, $last));
+        }
+    }
+}
+
+/**
+ * Placeholder for showing faves...
+ */
+class ThreadedNoticeListFavesItem extends NoticeListActorsItem
+{
+    function getProfiles()
+    {
+        $fave = Fave::byNotice($this->notice->id);
+        $profiles = array();
+        while ($fave->fetch()) {
+            $profiles[] = $fave->user_id;
+        }
+        return $profiles;
+    }
+
+    function magicList($items)
+    {
+        if (count($items) > 4) {
+            return parent::magicList(array_slice($items, 0, 3));
+        } else {
+            return parent::magicList($items);
+        }
+    }
+
+    function getListMessage($count, $you)
+    {
+        if ($count == 1 && $you) {
+            // darn first person being different from third person!
+            // TRANS: List message for notice favoured by logged in user.
+            return _m('FAVELIST', 'You like this.');
+        } else if ($count > 4) {
+            // TRANS: List message for when more than 4 people like something.
+            // TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
+            // TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
+            return sprintf(_m('%%s and %d others like this.',
+                              '%%s and %d others like this.',
+                              $count),
+                           $count - 3);
+        } else {
+            // TRANS: List message for favoured notices.
+            // TRANS: %%s is a list of users liking a notice.
+            // TRANS: Plural is based on the number of of users that have favoured a notice.
+            return sprintf(_m('%%s likes this.',
+                              '%%s like this.',
+                              $count),
+                           $count);
+        }
+    }
+
+    function showStart()
+    {
+        $this->out->elementStart('li', array('class' => 'notice-data notice-faves'));
+    }
+
+    function showEnd()
+    {
+        $this->out->elementEnd('li');
+    }
+}
+
+// @todo FIXME: needs documentation.
+class ThreadedNoticeListInlineFavesItem extends ThreadedNoticeListFavesItem
+{
+    function showStart()
+    {
+        $this->out->elementStart('div', array('class' => 'entry-content notice-faves'));
+    }
+
+    function showEnd()
+    {
+        $this->out->elementEnd('div');
+    }
+}
+
+/**
+ * Placeholder for showing faves...
+ */
+class ThreadedNoticeListRepeatsItem extends NoticeListActorsItem
+{
+    function getProfiles()
+    {
+        $rep = $this->notice->repeatStream();
+
+        $profiles = array();
+        while ($rep->fetch()) {
+            $profiles[] = $rep->profile_id;
+        }
+        return $profiles;
+    }
+
+    function getListMessage($count, $you)
+    {
+        if ($count == 1 && $you) {
+            // darn first person being different from third person!
+            // TRANS: List message for notice repeated by logged in user.
+            return _m('REPEATLIST', 'You have repeated this notice.');
+        } else {
+            // TRANS: List message for repeated notices.
+            // TRANS: %d is the number of users that have repeated a notice.
+            return sprintf(_m('One person has repeated this notice.',
+                              '%d people have repeated this notice.',
+                              $count),
+                           $count);
+        }
+    }
+
+    function showStart()
+    {
+        $this->out->elementStart('li', array('class' => 'notice-data notice-repeats'));
+    }
+
+    function showEnd()
+    {
+        $this->out->elementEnd('li');
+    }
 }