BlacklistPlugin.php 17 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 46
    const VERSION = STATUSNET_VERSION;

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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
    }

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

        // For storing blacklist patterns for nicknames
        $schema->ensureTable('nickname_blacklist',
                             array(new ColumnDef('pattern',
                                                 'varchar',
                                                 255,
                                                 false,
                                                 'PRI'),
                                   new ColumnDef('created',
                                                 'datetime',
                                                 null,
                                                 false)));

        $schema->ensureTable('homepage_blacklist',
                             array(new ColumnDef('pattern',
                                                 'varchar',
                                                 255,
                                                 false,
                                                 'PRI'),
                                   new ColumnDef('created',
                                                 'datetime',
                                                 null,
                                                 false)));

        return true;
106 107
    }

Evan Prodromou's avatar
Evan Prodromou committed
108 109 110 111 112 113 114 115 116 117
    /**
     * Retrieve an array from configuration
     *
     * Carefully checks a section.
     *
     * @param string $section Configuration section
     * @param string $setting Configuration setting
     *
     * @return array configuration values
     */
118 119 120 121 122 123 124 125 126
    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
127
            return explode("\r\n", $config);
128
        } else {
129 130
            // TRANS: Exception thrown if the Blacklist plugin configuration is incorrect.
            // TRANS: %1$s is a configuration section, %2$s is a configuration setting.
131
            throw new Exception(sprintf(_m('Unknown data type for config %1$s + %2$s.'),$section, $setting));
132 133 134
        }
    }

135 136 137 138 139 140 141 142 143
    /**
     * 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
     */
144
    function onStartRegisterUser(&$user, &$profile)
145
    {
146
        $homepage = strtolower($profile->homepage);
147 148 149

        if (!empty($homepage)) {
            if (!$this->_checkUrl($homepage)) {
150 151
                // TRANS: Validation failure for URL. %s is the URL.
                $msg = sprintf(_m("You may not register with homepage \"%s\"."),
152 153 154 155 156
                               $homepage);
                throw new ClientException($msg);
            }
        }

157
        $nickname = strtolower($profile->nickname);
158 159 160

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
161 162
                // TRANS: Validation failure for nickname. %s is the nickname.
                $msg = sprintf(_m("You may not register with nickname \"%s\"."),
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
                               $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)) {
186 187
                // TRANS: Validation failure for URL. %s is the URL.
                $msg = sprintf(_m("You may not use homepage \"%s\"."),
188 189 190 191 192 193 194 195 196
                               $homepage);
                throw new ClientException($msg);
            }
        }

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

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
197 198
                // TRANS: Validation failure for nickname. %s is the nickname.
                $msg = sprintf(_m("You may not use nickname \"%s\"."),
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
                               $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)) {
240
            // TRANS: Validation failure for URL. %s is the URL.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
241
            $msg = sprintf(_m("You may not use URL \"%s\" in notices."),
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
                           $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)
    {
260 261 262
        $patterns = $this->_getUrlPatterns();

        foreach ($patterns as $pattern) {
263
            if ($pattern != '' && preg_match("/$pattern/", $url)) {
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
                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)
    {
282 283 284
        $patterns = $this->_getNicknamePatterns();

        foreach ($patterns as $pattern) {
285
            if ($pattern != '' && preg_match("/$pattern/", $nickname)) {
286 287 288 289 290 291
                return false;
            }
        }

        return true;
    }
292

Evan Prodromou's avatar
Evan Prodromou committed
293 294 295 296 297 298 299 300 301
    /**
     * Add our actions to the URL router
     *
     * @param Net_URL_Mapper $m URL mapper for this hit
     *
     * @return boolean hook return
     */
    function onRouterInitialized($m)
    {
302
        $m->connect('panel/blacklist', array('action' => 'blacklistadminpanel'));
Evan Prodromou's avatar
Evan Prodromou committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316
        return true;
    }

    /**
     * Auto-load our classes if called
     *
     * @param string $cls Class to load
     *
     * @return boolean hook return
     */
    function onAutoload($cls)
    {
        switch (strtolower($cls))
        {
317 318 319 320
        case 'nickname_blacklist':
        case 'homepage_blacklist':
            include_once INSTALLDIR.'/plugins/Blacklist/'.ucfirst($cls).'.php';
            return false;
Evan Prodromou's avatar
Evan Prodromou committed
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
        case 'blacklistadminpanelaction':
            $base = strtolower(mb_substr($cls, 0, -6));
            include_once INSTALLDIR.'/plugins/Blacklist/'.$base.'.php';
            return false;
        default:
            return true;
        }
    }

    /**
     * Plugin version data
     *
     * @param array &$versions array of version blocks
     *
     * @return boolean hook value
     */
337 338 339 340 341
    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'Blacklist',
                            'version' => self::VERSION,
                            'author' => 'Evan Prodromou',
Evan Prodromou's avatar
Evan Prodromou committed
342 343
                            'homepage' =>
                            'http://status.net/wiki/Plugin:Blacklist',
344
                            'description' =>
345
                            // TRANS: Plugin description.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
346
                            _m('Keeps a blacklist of forbidden nickname '.
Evan Prodromou's avatar
Evan Prodromou committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
                               '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'),
383 384 385
                                // TRANS: Menu item in admin panel.
                                _m('MENU','Blacklist'),
                                // TRANS: Tooltip for menu item in admin panel.
386
                                _m('TOOLTIP','Blacklist configuration.'),
Evan Prodromou's avatar
Evan Prodromou committed
387 388 389 390
                                $action_name == 'blacklistadminpanel',
                                'nav_blacklist_admin_panel');
        }

391 392
        return true;
    }
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411

    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',
412
                               // TRANS: Checkbox label in the blacklist user form.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
413
                               _m('Add this nickname pattern to blacklist'),
414 415 416 417 418 419 420 421
                               'blacklistnicknamepattern',
                               $this->patternizeNickname($user->nickname));
        $action->elementEnd('li');

        if (!empty($profile->homepage)) {
            $action->elementStart('li');
            $this->checkboxAndText($action,
                                   'blacklisthomepage',
422
                                   // TRANS: Checkbox label in the blacklist user form.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
423
                                   _m('Add this homepage pattern to blacklist'),
424 425 426 427 428 429 430 431 432 433 434 435
                                   'blacklisthomepagepattern',
                                   $this->patternizeHomepage($profile->homepage));
            $action->elementEnd('li');
        }

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

    function onEndDeleteUser($action, $user)
    {
        if ($action->boolean('blacklisthomepage')) {
            $pattern = $action->trimmed('blacklisthomepagepattern');
436
            Homepage_blacklist::ensurePattern($pattern);
437 438 439 440
        }

        if ($action->boolean('blacklistnickname')) {
            $pattern = $action->trimmed('blacklistnicknamepattern');
441
            Nickname_blacklist::ensurePattern($pattern);
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
        }

        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;
    }
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500

    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)) {
501
                // TRANS: Exception thrown trying to post a notice while having set a blocked homepage URL. %s is the blocked URL.
502
                $msg = sprintf(_m("Users from \"%s\" are blocked."),
503 504 505 506 507
                               $homepage);
                throw new ClientException($msg);
            }
        }

Evan Prodromou's avatar
Evan Prodromou committed
508 509 510 511 512 513 514 515 516 517
        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.
                    $msg = sprintf(_m("Notices from nickname \"%s\" disallowed."),
                                   $nickname);
                    throw new ClientException($msg);
                }
518 519 520 521 522
            }
        }

        return true;
    }
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537

    /**
     * Check URLs and homepages for blacklisted users.
     */
    function onStartSubscribe($subscriber, $other)
    {
        foreach (array($other->profileurl, $other->homepage) as $url) {

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

            $url = strtolower($url);

            if (!$this->_checkUrl($url)) {
538
                // TRANS: Client exception thrown trying to subscribe to a person with a blocked homepage or site URL. %s is the blocked URL.
539
                $msg = sprintf(_m("Users from \"%s\" are blocked."),
540 541 542 543 544 545 546 547 548
                               $url);
                throw new ClientException($msg);
            }
        }

        $nickname = $other->nickname;

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
549
                // TRANS: Client exception thrown trying to subscribe to a person with a blocked nickname. %s is the blocked nickname.
550
                $msg = sprintf(_m("Cannot subscribe to nickname \"%s\"."),
551 552 553 554 555 556 557
                               $nickname);
                throw new ClientException($msg);
            }
        }

        return true;
    }
558
}