summaryrefslogtreecommitdiff
path: root/classes/Notice_inbox.php
blob: d3ddad656a7aae8492f1bee4d80afd3959193b92 (plain)
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
185
186
187
188
189
190
191
192
193
<?php
/*
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2008, 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
 * 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/>.
 */

if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }

require_once INSTALLDIR.'/classes/Memcached_DataObject.php';

// We keep 5 pages of inbox notices in memcache, +1 for pagination check

define('INBOX_CACHE_WINDOW', 101);
define('NOTICE_INBOX_GC_BOXCAR', 128);
define('NOTICE_INBOX_GC_MAX', 12800);
define('NOTICE_INBOX_LIMIT', 1000);
define('NOTICE_INBOX_SOFT_LIMIT', 1000);

define('NOTICE_INBOX_SOURCE_SUB', 1);
define('NOTICE_INBOX_SOURCE_GROUP', 2);
define('NOTICE_INBOX_SOURCE_REPLY', 3);
define('NOTICE_INBOX_SOURCE_FORWARD', 4);
define('NOTICE_INBOX_SOURCE_GATEWAY', -1);

class Notice_inbox extends Memcached_DataObject
{
    ###START_AUTOCODE
    /* the code below is auto generated do not remove the above tag */

    public $__table = 'notice_inbox';                    // table name
    public $user_id;                         // int(4)  primary_key not_null
    public $notice_id;                       // int(4)  primary_key not_null
    public $created;                         // datetime()   not_null
    public $source;                          // tinyint(1)   default_1

    /* Static get */
    function staticGet($k,$v=null)
    { return Memcached_DataObject::staticGet('Notice_inbox',$k,$v); }

    /* the code above is auto generated do not remove the tag below */
    ###END_AUTOCODE

    function stream($user_id, $offset, $limit, $since_id, $max_id, $since, $own=false)
    {
        return Notice::stream(array('Notice_inbox', '_streamDirect'),
                              array($user_id, $own),
                              ($own) ? 'notice_inbox:by_user:'.$user_id :
                              'notice_inbox:by_user_own:'.$user_id,
                              $offset, $limit, $since_id, $max_id, $since);
    }

    function _streamDirect($user_id, $own, $offset, $limit, $since_id, $max_id, $since)
    {
        $inbox = new Notice_inbox();

        $inbox->user_id = $user_id;

        if (!$own) {
            $inbox->whereAdd('source != ' . NOTICE_INBOX_SOURCE_GATEWAY);
        }

        if ($since_id != 0) {
            $inbox->whereAdd('notice_id > ' . $since_id);
        }

        if ($max_id != 0) {
            $inbox->whereAdd('notice_id <= ' . $max_id);
        }

        if (!is_null($since)) {
            $inbox->whereAdd('created > \'' . date('Y-m-d H:i:s', $since) . '\'');
        }

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

        if (!is_null($offset)) {
            $inbox->limit($offset, $limit);
        }

        $ids = array();

        if ($inbox->find()) {
            while ($inbox->fetch()) {
                $ids[] = $inbox->notice_id;
            }
        }

        return $ids;
    }

    function &pkeyGet($kv)
    {
        return Memcached_DataObject::pkeyGet('Notice_inbox', $kv);
    }

    /**
     * Trim inbox for a given user to latest NOTICE_INBOX_LIMIT items
     * (up to NOTICE_INBOX_GC_MAX will be deleted).
     *
     * @param int $user_id
     * @return int count of notices dropped from the inbox, if any
     */
    static function gc($user_id)
    {
        $entry = new Notice_inbox();
        $entry->user_id = $user_id;
        $entry->orderBy('created DESC');
        $entry->limit(NOTICE_INBOX_LIMIT - 1, NOTICE_INBOX_GC_MAX);

        $total = $entry->find();

        if ($total > 0) {
            $notices = array();
            $cnt = 0;
            while ($entry->fetch()) {
                $notices[] = $entry->notice_id;
                $cnt++;
                if ($cnt >= NOTICE_INBOX_GC_BOXCAR) {
                    self::deleteMatching($user_id, $notices);
                    $notices = array();
                    $cnt = 0;
                }
            }

            if ($cnt > 0) {
                self::deleteMatching($user_id, $notices);
                $notices = array();
            }
        }

        return $total;
    }

    static function deleteMatching($user_id, $notices)
    {
        $entry = new Notice_inbox();
        return $entry->query('DELETE FROM notice_inbox '.
                             'WHERE user_id = ' . $user_id . ' ' .
                             'AND notice_id in ('.implode(',', $notices).')');
    }

    static function bulkInsert($notice_id, $created, $ni)
    {
        $cnt = 0;

        $qryhdr = 'INSERT INTO notice_inbox (user_id, notice_id, source, created) VALUES ';
        $qry = $qryhdr;

        foreach ($ni as $id => $source) {
            if ($cnt > 0) {
                $qry .= ', ';
            }
            $qry .= '('.$id.', '.$notice_id.', '.$source.", '".$created. "') ";
            $cnt++;
            if (rand() % NOTICE_INBOX_SOFT_LIMIT == 0) {
                // FIXME: Causes lag in replicated servers
                // Notice_inbox::gc($id);
            }
            if ($cnt >= MAX_BOXCARS) {
                $inbox = new Notice_inbox();
                $result = $inbox->query($qry);
                if (PEAR::isError($result)) {
                    common_log_db_error($inbox, $qry);
                }
                $qry = $qryhdr;
                $cnt = 0;
            }
        }

        if ($cnt > 0) {
            $inbox = new Notice_inbox();
            $result = $inbox->query($qry);
            if (PEAR::isError($result)) {
                common_log_db_error($inbox, $qry);
            }
        }

        return;
    }
}