git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

BlacklistPlugin.php 15.5 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
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Plugin to prevent use of nicknames or URLs on a blacklist
 *
 * PHP version 5
 *
 * LICENCE: 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  Action
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
25
 * @copyright 2010 StatusNet Inc.
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

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

/**
 * Plugin to prevent use of nicknames or URLs on a blacklist
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Evan Prodromou <evan@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
class BlacklistPlugin extends Plugin
{
45
    const VERSION = GNUSOCIAL_VERSION;
46

47 48
    public $nicknames = array();
    public $urls      = array();
Evan Prodromou's avatar
Evan Prodromou committed
49
    public $canAdmin  = true;
50

51
    function _getNicknamePatterns()
52
    {
53
        $confNicknames = $this->_configArray('blacklist', 'nicknames');
Evan Prodromou's avatar
Evan Prodromou committed
54

55 56
        $dbNicknames = Nickname_blacklist::getPatterns();

57 58 59 60
        return array_merge($this->nicknames,
                           $confNicknames,
                           $dbNicknames);
    }
Evan Prodromou's avatar
Evan Prodromou committed
61

62 63
    function _getUrlPatterns()
    {
64
        $confURLs = $this->_configArray('blacklist', 'urls');
65

66 67
        $dbURLs = Homepage_blacklist::getPatterns();

68 69 70
        return array_merge($this->urls,
                           $confURLs,
                           $dbURLs);
71 72 73 74 75 76 77 78 79 80 81 82
    }

    /**
     * Database schema setup
     *
     * @return boolean hook value
     */
    function onCheckSchema()
    {
        $schema = Schema::get();

        // For storing blacklist patterns for nicknames
83 84
        $schema->ensureTable('nickname_blacklist', Nickname_blacklist::schemaDef());
        $schema->ensureTable('homepage_blacklist', Homepage_blacklist::schemaDef());
85 86

        return true;
87 88
    }

Evan Prodromou's avatar
Evan Prodromou committed
89 90 91 92 93 94 95 96 97 98
    /**
     * Retrieve an array from configuration
     *
     * Carefully checks a section.
     *
     * @param string $section Configuration section
     * @param string $setting Configuration setting
     *
     * @return array configuration values
     */
99 100 101 102 103 104 105 106 107
    function _configArray($section, $setting)
    {
        $config = common_config($section, $setting);

        if (empty($config)) {
            return array();
        } else if (is_array($config)) {
            return $config;
        } else if (is_string($config)) {
Evan Prodromou's avatar
Evan Prodromou committed
108
            return explode("\r\n", $config);
109
        } else {
110 111
            // TRANS: Exception thrown if the Blacklist plugin configuration is incorrect.
            // TRANS: %1$s is a configuration section, %2$s is a configuration setting.
112
            throw new Exception(sprintf(_m('Unknown data type for config %1$s + %2$s.'),$section, $setting));
113 114 115
        }
    }

116 117 118 119 120 121 122 123 124
    /**
     * Hook registration to prevent blacklisted homepages or nicknames
     *
     * Throws an exception if there's a blacklisted homepage or nickname.
     *
     * @param Action $action Action being called (usually register)
     *
     * @return boolean hook value
     */
125
    function onStartRegisterUser(&$user, &$profile)
126
    {
127
        $homepage = strtolower($profile->homepage);
128 129 130

        if (!empty($homepage)) {
            if (!$this->_checkUrl($homepage)) {
131 132
                // TRANS: Validation failure for URL. %s is the URL.
                $msg = sprintf(_m("You may not register with homepage \"%s\"."),
133 134 135 136 137
                               $homepage);
                throw new ClientException($msg);
            }
        }

138
        $nickname = strtolower($profile->nickname);
139 140 141

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
142 143
                // TRANS: Validation failure for nickname. %s is the nickname.
                $msg = sprintf(_m("You may not register with nickname \"%s\"."),
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
                               $nickname);
                throw new ClientException($msg);
            }
        }

        return true;
    }

    /**
     * Hook profile update to prevent blacklisted homepages or nicknames
     *
     * Throws an exception if there's a blacklisted homepage or nickname.
     *
     * @param Action $action Action being called (usually register)
     *
     * @return boolean hook value
     */
    function onStartProfileSaveForm($action)
    {
        $homepage = strtolower($action->trimmed('homepage'));

        if (!empty($homepage)) {
            if (!$this->_checkUrl($homepage)) {
167 168
                // TRANS: Validation failure for URL. %s is the URL.
                $msg = sprintf(_m("You may not use homepage \"%s\"."),
169 170 171 172 173 174 175 176 177
                               $homepage);
                throw new ClientException($msg);
            }
        }

        $nickname = strtolower($action->trimmed('nickname'));

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
178 179
                // TRANS: Validation failure for nickname. %s is the nickname.
                $msg = sprintf(_m("You may not use nickname \"%s\"."),
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
                               $nickname);
                throw new ClientException($msg);
            }
        }

        return true;
    }

    /**
     * Hook notice save to prevent blacklisted urls
     *
     * Throws an exception if there's a blacklisted url in the content.
     *
     * @param Notice &$notice Notice being saved
     *
     * @return boolean hook value
     */
    function onStartNoticeSave(&$notice)
    {
        common_replace_urls_callback($notice->content,
                                     array($this, 'checkNoticeUrl'));
        return true;
    }

    /**
     * Helper callback for notice save
     *
     * Throws an exception if there's a blacklisted url in the content.
     *
     * @param string $url URL in the notice content
     *
     * @return boolean hook value
     */
    function checkNoticeUrl($url)
    {
        // It comes in special'd, so we unspecial it
        // before comparing against patterns

        $url = htmlspecialchars_decode($url);

        if (!$this->_checkUrl($url)) {
221
            // TRANS: Validation failure for URL. %s is the URL.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
222
            $msg = sprintf(_m("You may not use URL \"%s\" in notices."),
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
                           $url);
            throw new ClientException($msg);
        }

        return $url;
    }

    /**
     * Helper for checking URLs
     *
     * Checks an URL against our patterns for a match.
     *
     * @param string $url URL to check
     *
     * @return boolean true means it's OK, false means it's bad
     */
    private function _checkUrl($url)
    {
241 242 243
        $patterns = $this->_getUrlPatterns();

        foreach ($patterns as $pattern) {
244
            if ($pattern != '' && preg_match("/$pattern/", $url)) {
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
                return false;
            }
        }

        return true;
    }

    /**
     * Helper for checking nicknames
     *
     * Checks a nickname against our patterns for a match.
     *
     * @param string $nickname nickname to check
     *
     * @return boolean true means it's OK, false means it's bad
     */
    private function _checkNickname($nickname)
    {
263 264 265
        $patterns = $this->_getNicknamePatterns();

        foreach ($patterns as $pattern) {
266
            if ($pattern != '' && preg_match("/$pattern/", $nickname)) {
267 268 269 270 271 272
                return false;
            }
        }

        return true;
    }
273

Evan Prodromou's avatar
Evan Prodromou committed
274 275 276 277 278 279 280 281 282
    /**
     * Add our actions to the URL router
     *
     * @param Net_URL_Mapper $m URL mapper for this hit
     *
     * @return boolean hook return
     */
    function onRouterInitialized($m)
    {
283
        $m->connect('panel/blacklist', array('action' => 'blacklistadminpanel'));
Evan Prodromou's avatar
Evan Prodromou committed
284 285 286 287 288 289 290 291 292 293
        return true;
    }

    /**
     * Plugin version data
     *
     * @param array &$versions array of version blocks
     *
     * @return boolean hook value
     */
294 295 296 297 298
    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'Blacklist',
                            'version' => self::VERSION,
                            'author' => 'Evan Prodromou',
Evan Prodromou's avatar
Evan Prodromou committed
299 300
                            'homepage' =>
                            'http://status.net/wiki/Plugin:Blacklist',
301
                            'description' =>
302
                            // TRANS: Plugin description.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
303
                            _m('Keeps a blacklist of forbidden nickname '.
Evan Prodromou's avatar
Evan Prodromou committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
                               'and URL patterns.'));
        return true;
    }

    /**
     * Determines if our admin panel can be shown
     *
     * @param string  $name  name of the admin panel
     * @param boolean &$isOK result
     *
     * @return boolean hook value
     */
    function onAdminPanelCheck($name, &$isOK)
    {
        if ($name == 'blacklist') {
            $isOK = $this->canAdmin;
            return false;
        }

        return true;
    }

    /**
     * Add our tab to the admin panel
     *
     * @param Widget $nav Admin panel nav
     *
     * @return boolean hook value
     */
    function onEndAdminPanelNav($nav)
    {
        if (AdminPanelAction::canAdmin('blacklist')) {

            $action_name = $nav->action->trimmed('action');

            $nav->out->menuItem(common_local_url('blacklistadminpanel'),
340 341 342
                                // TRANS: Menu item in admin panel.
                                _m('MENU','Blacklist'),
                                // TRANS: Tooltip for menu item in admin panel.
343
                                _m('TOOLTIP','Blacklist configuration.'),
Evan Prodromou's avatar
Evan Prodromou committed
344 345 346 347
                                $action_name == 'blacklistadminpanel',
                                'nav_blacklist_admin_panel');
        }

348 349
        return true;
    }
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

    function onEndDeleteUserForm($action, $user)
    {
        $cur = common_current_user();

        if (empty($cur) || !$cur->hasRight(Right::CONFIGURESITE)) {
            return;
        }

        $profile = $user->getProfile();

        if (empty($profile)) {
            return;
        }

        $action->elementStart('ul', 'form_data');
        $action->elementStart('li');
        $this->checkboxAndText($action,
                               'blacklistnickname',
369
                               // TRANS: Checkbox label in the blacklist user form.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
370
                               _m('Add this nickname pattern to blacklist'),
371 372 373 374 375 376 377 378
                               'blacklistnicknamepattern',
                               $this->patternizeNickname($user->nickname));
        $action->elementEnd('li');

        if (!empty($profile->homepage)) {
            $action->elementStart('li');
            $this->checkboxAndText($action,
                                   'blacklisthomepage',
379
                                   // TRANS: Checkbox label in the blacklist user form.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
380
                                   _m('Add this homepage pattern to blacklist'),
381 382 383 384 385 386 387 388 389 390 391 392
                                   'blacklisthomepagepattern',
                                   $this->patternizeHomepage($profile->homepage));
            $action->elementEnd('li');
        }

        $action->elementEnd('ul');
    }

    function onEndDeleteUser($action, $user)
    {
        if ($action->boolean('blacklisthomepage')) {
            $pattern = $action->trimmed('blacklisthomepagepattern');
393
            Homepage_blacklist::ensurePattern($pattern);
394 395 396 397
        }

        if ($action->boolean('blacklistnickname')) {
            $pattern = $action->trimmed('blacklistnicknamepattern');
398
            Nickname_blacklist::ensurePattern($pattern);
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
        }

        return true;
    }

    function checkboxAndText($action, $checkID, $label, $textID, $value)
    {
        $action->element('input', array('name' => $checkID,
                                        'type' => 'checkbox',
                                        'class' => 'checkbox',
                                        'id' => $checkID));

        $action->text(' ');

        $action->element('label', array('class' => 'checkbox',
                                        'for' => $checkID),
                         $label);

        $action->text(' ');

        $action->element('input', array('name' => $textID,
                                        'type' => 'text',
                                        'id' => $textID,
                                        'value' => $value));
    }

    function patternizeNickname($nickname)
    {
        return $nickname;
    }

    function patternizeHomepage($homepage)
    {
        $hostname = parse_url($homepage, PHP_URL_HOST);
        return $hostname;
    }
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457

    function onStartHandleFeedEntry($activity)
    {
        return $this->_checkActivity($activity);
    }

    function onStartHandleSalmon($activity)
    {
        return $this->_checkActivity($activity);
    }

    function _checkActivity($activity)
    {
        $actor = $activity->actor;

        if (empty($actor)) {
            return true;
        }

        $homepage = strtolower($actor->link);

        if (!empty($homepage)) {
            if (!$this->_checkUrl($homepage)) {
458
                // TRANS: Exception thrown trying to post a notice while having set a blocked homepage URL. %s is the blocked URL.
459
                $msg = sprintf(_m("Users from \"%s\" are blocked."),
460 461 462 463 464
                               $homepage);
                throw new ClientException($msg);
            }
        }

Evan Prodromou's avatar
Evan Prodromou committed
465 466 467 468 469 470
        if (!empty($actor->poco)) {
            $nickname = strtolower($actor->poco->preferredUsername);

            if (!empty($nickname)) {
                if (!$this->_checkNickname($nickname)) {
                    // TRANS: Exception thrown trying to post a notice while having a blocked nickname. %s is the blocked nickname.
471
                    $msg = sprintf(_m("Notices from nickname \"%s\" are disallowed."),
Evan Prodromou's avatar
Evan Prodromou committed
472 473 474
                                   $nickname);
                    throw new ClientException($msg);
                }
475 476 477 478 479
            }
        }

        return true;
    }
480 481 482 483

    /**
     * Check URLs and homepages for blacklisted users.
     */
484
    function onStartSubscribe(Profile $subscriber, Profile $other)
485 486 487 488 489 490 491 492 493 494
    {
        foreach (array($other->profileurl, $other->homepage) as $url) {

            if (empty($url)) {
                continue;
            }

            $url = strtolower($url);

            if (!$this->_checkUrl($url)) {
495
                // TRANS: Client exception thrown trying to subscribe to a person with a blocked homepage or site URL. %s is the blocked URL.
496
                $msg = sprintf(_m("Users from \"%s\" are blocked."),
497 498 499 500 501 502 503 504 505
                               $url);
                throw new ClientException($msg);
            }
        }

        $nickname = $other->nickname;

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
506
                // TRANS: Client exception thrown trying to subscribe to a person with a blocked nickname. %s is the blocked nickname.
507
                $msg = sprintf(_m("Cannot subscribe to nickname \"%s\"."),
508 509 510 511 512 513 514
                               $nickname);
                throw new ClientException($msg);
            }
        }

        return true;
    }
515
}