useractivitystream.php 6.78 KB
Newer Older
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
<?php
/*
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010 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
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Class for activity streams
 *
 * Includes faves, notices, and subscriptions.
 *
 * We extend atomusernoticefeed since it does some nice setup for us.
 *
 */
class UserActivityStream extends AtomUserNoticeFeed
{
Evan Prodromou's avatar
Evan Prodromou committed
30 31
    public $activities = array();

32 33 34 35 36 37 38 39 40 41 42 43 44 45
    const OUTPUT_STRING = 1;
    const OUTPUT_RAW = 2;
    public $outputMode = self::OUTPUT_STRING;

    /**
     *
     * @param User $user
     * @param boolean $indent
     * @param boolean $outputMode: UserActivityStream::OUTPUT_STRING to return a string,
     *                           or UserActivityStream::OUTPUT_RAW to go to raw output.
     *                           Raw output mode will attempt to stream, keeping less
     *                           data in memory but will leave $this->activities incomplete.
     */
    function __construct($user, $indent = true, $outputMode = UserActivityStream::OUTPUT_STRING)
46 47 48
    {
        parent::__construct($user, null, $indent);

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
        $this->outputMode = $outputMode;
        if ($this->outputMode == self::OUTPUT_STRING) {
            // String buffering? Grab all the notices now.
            $notices = $this->getNotices();
        } elseif ($this->outputMode == self::OUTPUT_RAW) {
            // Raw output... need to restructure from the stringer init.
            $this->xw = new XMLWriter();
            $this->xw->openURI('php://output');
            if(is_null($indent)) {
                $indent = common_config('site', 'indent');
            }
            $this->xw->setIndent($indent);

            // We'll fetch notices later.
            $notices = array();
        } else {
            throw new Exception('Invalid outputMode provided to ' . __METHOD__);
        }

        // Assume that everything but notices is feasible
        // to pull at once and work with in memory...
70 71 72 73 74 75 76 77 78 79 80
        $subscriptions = $this->getSubscriptions();
        $subscribers   = $this->getSubscribers();
        $groups        = $this->getGroups();
        $faves         = $this->getFaves();

        $objs = array_merge($subscriptions, $subscribers, $groups, $faves, $notices);

        // Sort by create date

        usort($objs, 'UserActivityStream::compareObject');

81 82
        // We'll keep these around for later, and interleave them into
        // the output stream with the user's notices.
83
        foreach ($objs as $obj) {
Evan Prodromou's avatar
Evan Prodromou committed
84 85 86
            $this->activities[] = $obj->asActivity();
        }
    }
87

88 89 90 91
    /**
     * Interleave the pre-sorted subs/groups/faves with the user's
     * notices, all in reverse chron order.
     */
Evan Prodromou's avatar
Evan Prodromou committed
92 93
    function renderEntries()
    {
94
        $end = time() + 1;
Evan Prodromou's avatar
Evan Prodromou committed
95
        foreach ($this->activities as $act) {
96 97 98 99 100 101 102 103 104 105 106
            $start = $act->time;

            if ($this->outputMode == self::OUTPUT_RAW && $start != $end) {
                // In raw mode, we haven't pre-fetched notices.
                // Grab the chunks of notices between other activities.
                $notices = $this->getNoticesBetween($start, $end);
                foreach ($notices as $noticeAct) {
                    $noticeAct->asActivity()->outputTo($this, false, false);
                }
            }

107
            // Only show the author sub-element if it's different from default user
Evan Prodromou's avatar
Evan Prodromou committed
108
            $act->outputTo($this, false, ($act->actor->id != $this->user->uri));
109 110 111 112 113 114 115 116 117 118

            $end = $start;
        }

        if ($this->outputMode == self::OUTPUT_RAW) {
            // Grab anything after the last pre-sorted activity.
            $notices = $this->getNoticesBetween(0, $end);
            foreach ($notices as $noticeAct) {
                $noticeAct->asActivity()->outputTo($this, false, false);
            }
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
        }
    }

    function compareObject($a, $b)
    {
        $ac = strtotime((empty($a->created)) ? $a->modified : $a->created);
        $bc = strtotime((empty($b->created)) ? $b->modified : $b->created);

        return (($ac == $bc) ? 0 : (($ac < $bc) ? 1 : -1));
    }

    function getSubscriptions()
    {
        $subs = array();

        $sub = new Subscription();

        $sub->subscriber = $this->user->id;

        if ($sub->find()) {
            while ($sub->fetch()) {
                if ($sub->subscribed != $this->user->id) {
                    $subs[] = clone($sub);
                }
            }
        }

        return $subs;
    }

    function getSubscribers()
    {
        $subs = array();

        $sub = new Subscription();

        $sub->subscribed = $this->user->id;

        if ($sub->find()) {
            while ($sub->fetch()) {
                if ($sub->subscriber != $this->user->id) {
                    $subs[] = clone($sub);
                }
            }
        }

        return $subs;
    }

    function getFaves()
    {
        $faves = array();

        $fave = new Fave();

        $fave->user_id = $this->user->id;

        if ($fave->find()) {
            while ($fave->fetch()) {
                $faves[] = clone($fave);
            }
        }

        return $faves;
    }

185 186 187 188 189 190 191
    /**
     *
     * @param int $start unix timestamp for earliest
     * @param int $end unix timestamp for latest
     * @return array of Notice objects
     */
    function getNoticesBetween($start=0, $end=0)
192 193 194 195 196 197 198
    {
        $notices = array();

        $notice = new Notice();

        $notice->profile_id = $this->user->id;

199 200 201 202 203 204 205 206 207 208 209
        if ($start) {
            $tsstart = common_sql_date($start);
            $notice->whereAdd("created >= '$tsstart'");
        }
        if ($end) {
            $tsend = common_sql_date($end);
            $notice->whereAdd("created < '$tsend'");
        }

        $notice->orderBy('created DESC');

210 211 212 213 214 215 216 217 218
        if ($notice->find()) {
            while ($notice->fetch()) {
                $notices[] = clone($notice);
            }
        }

        return $notices;
    }

219 220 221 222 223
    function getNotices()
    {
        return $this->getNoticesBetween();
    }

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    function getGroups()
    {
        $groups = array();

        $gm = new Group_member();

        $gm->profile_id = $this->user->id;

        if ($gm->find()) {
            while ($gm->fetch()) {
                $groups[] = clone($gm);
            }
        }

        return $groups;
    }
}