summaryrefslogtreecommitdiff
path: root/plugins/SubscriptionThrottle/SubscriptionThrottlePlugin.php
blob: 114113360e96835bd83576dbd4d9ea82125376b8 (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
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010, StatusNet, Inc.
 *
 * Plugin to throttle subscriptions by a user
 *
 * PHP version 5
 *
 * 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/>.
 *
 * @category  Throttle
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    // This check helps protect against security problems;
    // your code file can't be executed directly from the web.
    exit(1);
}

/**
 * Subscription throttle
 *
 * @category  Throttle
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

class SubscriptionThrottlePlugin extends Plugin
{
    public $subLimits = array(86400 => 100,
                              3600 => 50);

    public $groupLimits = array(86400 => 50,
                                3600 => 25);

    /**
     * Filter subscriptions to see if they're coming too fast.
     *
     * @param User $user  The user subscribing
     * @param User $other The user being subscribed to
     *
     * @return boolean hook value
     */

    function onStartSubscribe($user, $other)
    {
        foreach ($this->subLimits as $seconds => $limit) {
            $sub = $this->_getNthSub($user, $limit);

            if (!empty($sub)) {
                $subtime = strtotime($sub->created);
                $now     = time();
                if ($now - $subtime < $seconds) {
                    throw new Exception(_("Too many subscriptions. Take a break and try again later."));
                }
            }
        }

        return true;
    }

    /**
     * Filter group joins to see if they're coming too fast.
     *
     * @param Group $group The group being joined
     * @param User  $user  The user joining
     *
     * @return boolean hook value
     */

    function onStartJoinGroup($group, $user)
    {
        foreach ($this->groupLimits as $seconds => $limit) {
            $mem = $this->_getNthMem($user, $limit);
            if (!empty($mem)) {

                $jointime = strtotime($mem->created);
                $now      = time();
                if ($now - $jointime < $seconds) {
                    throw new Exception(_("Too many memberships. Take a break and try again later."));
                }
            }
        }

        return true;
    }

    /**
     * Get the Nth most recent subscription for this user
     *
     * @param User    $user The user to get subscriptions for
     * @param integer $n    How far to count back
     *
     * @return Subscription a subscription or null
     */

    private function _getNthSub($user, $n)
    {
        $sub = new Subscription();

        $sub->subscriber = $user->id;
        $sub->orderBy('created DESC');
        $sub->limit($n - 1, 1);

        if ($sub->find(true)) {
            return $sub;
        } else {
            return null;
        }
    }

    /**
     * Get the Nth most recent group membership for this user
     *
     * @param User    $user The user to get memberships for
     * @param integer $n    How far to count back
     *
     * @return Group_member a membership or null
     */

    private function _getNthMem($user, $n)
    {
        $mem = new Group_member();

        $mem->profile_id = $user->id;
        $mem->orderBy('created DESC');
        $mem->limit($n - 1, 1);

        if ($mem->find(true)) {
            return $mem;
        } else {
            return null;
        }
    }

    /**
     * Return plugin version data for display
     *
     * @param array &$versions Array of version arrays
     *
     * @return boolean hook value
     */

    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'SubscriptionThrottle',
                            'version' => STATUSNET_VERSION,
                            'author' => 'Evan Prodromou',
                            'homepage' => 'http://status.net/wiki/Plugin:SubscriptionThrottle',
                            'rawdescription' =>
                            _m('Configurable limits for subscriptions and group memberships.'));
        return true;
    }
}