We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

BlacklistPlugin.php 13.6 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
{
Evan Prodromou's avatar
Evan Prodromou committed
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 129 130 131 132
        } else {
            throw new Exception("Unknown data type for config $section + $setting");
        }
    }

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
    /**
     * 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
     */
    function onStartRegistrationTry($action)
    {
        $homepage = strtolower($action->trimmed('homepage'));

        if (!empty($homepage)) {
            if (!$this->_checkUrl($homepage)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
148
                $msg = sprintf(_m("You may not register with homepage '%s'."),
149 150 151 152 153 154 155 156 157
                               $homepage);
                throw new ClientException($msg);
            }
        }

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

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
158
                $msg = sprintf(_m("You may not register with nickname '%s'."),
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
                               $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)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
182
                $msg = sprintf(_m("You may not use homepage '%s'."),
183 184 185 186 187 188 189 190 191
                               $homepage);
                throw new ClientException($msg);
            }
        }

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

        if (!empty($nickname)) {
            if (!$this->_checkNickname($nickname)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
192
                $msg = sprintf(_m("You may not use nickname '%s'."),
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 221 222 223 224 225 226 227 228 229 230 231 232 233
                               $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)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
234
            $msg = sprintf(_m("You may not use URL \"%s\" in notices."),
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
                           $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)
    {
253 254 255
        $patterns = $this->_getUrlPatterns();

        foreach ($patterns as $pattern) {
256
            if ($pattern != '' && preg_match("/$pattern/", $url)) {
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
                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)
    {
275 276 277
        $patterns = $this->_getNicknamePatterns();

        foreach ($patterns as $pattern) {
278
            if ($pattern != '' && preg_match("/$pattern/", $nickname)) {
279 280 281 282 283 284
                return false;
            }
        }

        return true;
    }
Evan Prodromou's avatar
Evan Prodromou committed
285

Evan Prodromou's avatar
Evan Prodromou committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    /**
     * Add our actions to the URL router
     *
     * @param Net_URL_Mapper $m URL mapper for this hit
     *
     * @return boolean hook return
     */
    function onRouterInitialized($m)
    {
        $m->connect('admin/blacklist', array('action' => 'blacklistadminpanel'));
        return true;
    }

    /**
     * Auto-load our classes if called
     *
     * @param string $cls Class to load
     *
     * @return boolean hook return
     */
    function onAutoload($cls)
    {
        switch (strtolower($cls))
        {
310 311 312 313
        case 'nickname_blacklist':
        case 'homepage_blacklist':
            include_once INSTALLDIR.'/plugins/Blacklist/'.ucfirst($cls).'.php';
            return false;
Evan Prodromou's avatar
Evan Prodromou committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
        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
     */
Evan Prodromou's avatar
Evan Prodromou committed
330 331 332 333 334
    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'Blacklist',
                            'version' => self::VERSION,
                            'author' => 'Evan Prodromou',
Evan Prodromou's avatar
Evan Prodromou committed
335 336
                            'homepage' =>
                            'http://status.net/wiki/Plugin:Blacklist',
Evan Prodromou's avatar
Evan Prodromou committed
337
                            'description' =>
Siebrand Mazeland's avatar
Siebrand Mazeland committed
338
                            _m('Keeps a blacklist of forbidden nickname '.
Evan Prodromou's avatar
Evan Prodromou committed
339 340 341 342 343 344 345 346 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
                               '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'),
Siebrand Mazeland's avatar
Siebrand Mazeland committed
375 376
                                _m('Blacklist'),
                                _m('Blacklist configuration'),
Evan Prodromou's avatar
Evan Prodromou committed
377 378 379 380
                                $action_name == 'blacklistadminpanel',
                                'nav_blacklist_admin_panel');
        }

Evan Prodromou's avatar
Evan Prodromou committed
381 382
        return true;
    }
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

    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',
Siebrand Mazeland's avatar
Siebrand Mazeland committed
402
                               _m('Add this nickname pattern to blacklist'),
403 404 405 406 407 408 409 410
                               'blacklistnicknamepattern',
                               $this->patternizeNickname($user->nickname));
        $action->elementEnd('li');

        if (!empty($profile->homepage)) {
            $action->elementStart('li');
            $this->checkboxAndText($action,
                                   'blacklisthomepage',
Siebrand Mazeland's avatar
Siebrand Mazeland committed
411
                                   _m('Add this homepage pattern to blacklist'),
412 413 414 415 416 417 418 419 420 421 422 423
                                   'blacklisthomepagepattern',
                                   $this->patternizeHomepage($profile->homepage));
            $action->elementEnd('li');
        }

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

    function onEndDeleteUser($action, $user)
    {
        if ($action->boolean('blacklisthomepage')) {
            $pattern = $action->trimmed('blacklisthomepagepattern');
424
            Homepage_blacklist::ensurePattern($pattern);
425 426 427 428
        }

        if ($action->boolean('blacklistnickname')) {
            $pattern = $action->trimmed('blacklistnicknamepattern');
429
            Nickname_blacklist::ensurePattern($pattern);
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
        }

        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;
    }
466
}