DomainStatusNetworkPlugin.php 8.27 KB
Newer Older
1 2 3 4 5 6
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2011, StatusNet, Inc.
 *
 * One status_network per email domain
Siebrand Mazeland's avatar
Siebrand Mazeland committed
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
 * 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  DomainStatusNetwork
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2011 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);
}

37 38 39 40 41
$_dir = dirname(__FILE__);

require_once $_dir . '/extlib/effectiveTLDs.inc.php';
require_once $_dir . '/extlib/regDomain.inc.php';

42 43 44 45 46 47 48 49 50 51 52 53 54
/**
 * Tools to map one status_network to one email domain in a multi-site
 * installation.
 *
 * @category  DomainStatusNetwork
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2011 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class DomainStatusNetworkPlugin extends Plugin
{
55 56
    static $_thetree = null;

57 58
    function initialize()
    {
59 60 61
        // For various reasons this gets squished

        global $tldTree;
Siebrand Mazeland's avatar
Siebrand Mazeland committed
62

63 64 65 66 67 68
        if (empty($tldTree)) {
            if (!empty(self::$_thetree)) {
                $tldTree = self::$_thetree;
            }
        }

69 70 71 72 73 74 75
        $nickname = StatusNet::currentSite();

        if (empty($nickname)) {
            $this->log(LOG_WARNING, "No current site");
            return;
        }

76
        try {
77
            $sn = Status_network::getKV('nickname', $nickname);
78 79
        } catch (Exception $e) {
            $this->log(LOG_ERR, $e->getMessage());
80
            return;
81 82 83 84 85 86
        }

        $tags = $sn->getTags();

        foreach ($tags as $tag) {
            if (strncmp($tag, 'domain=', 7) == 0) {
87
                $domain = substr($tag, 7);
Evan Prodromou's avatar
Evan Prodromou committed
88
                $this->log(LOG_INFO, "Setting email domain to {$domain}");
89
                common_config_append('email', 'whitelist', $domain);
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
    static function toDomain($raw)
    {
        $parts = explode('@', $raw);

        if (count($parts) == 1) {
            $domain = $parts[0];
        } else {
            $domain = $parts[1];
        }

        $domain = strtolower(trim($domain));

        return $domain;
    }

    static function registeredDomain($domain)
    {
        return getRegisteredDomain($domain);
    }

    static function nicknameAvailable($nickname)
    {
116
        $sn = Status_network::getKV('nickname', $nickname);
117 118 119
        if (!empty($sn)) {
            return false;
        }
120
        $usn = Unavailable_status_network::getKV('nickname', $nickname);
121 122 123 124
        if (!empty($usn)) {
            return false;
        }
        return true;
125 126
    }

127 128 129 130 131 132 133 134 135 136 137
    function onRouterInitialized($m)
    {
        if (common_config('globalapi', 'enabled')) {
            foreach (array('register', 'login', 'recover') as $method) {
                $m->connect('api/statusnet/global/'.$method,
                            array('action' => 'global'.$method));
            }
        }
        return true;
    }

138 139 140 141 142 143 144 145 146
    function onLoginAction($action, &$login) {
        $this->debug($action);
        if (in_array($action, array('globalregister', 'globallogin', 'globalrecover'))) {
            $login = true;
            return false;
        }
        return true;
    }

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
    static function nicknameForDomain($domain)
    {
        $registered = self::registeredDomain($domain);

        $parts = explode('.', $registered);

        $base = $parts[0];

        if (self::nicknameAvailable($base)) {
            return $base;
        }

        $domainish = str_replace('.', '-', $registered);

        if (self::nicknameAvailable($domainish)) {
            return $domainish;
        }

        $i = 1;

        // We don't need to keep doing this forever

        while ($i < 1024) {
            $candidate = $domainish.'-'.$i;
            if (self::nicknameAvailable($candidate)) {
                return $candidate;
            }
            $i++;
        }

        return null;
    }

    static function siteForDomain($domain)
    {
        $snt = Status_network_tag::withTag('domain='.$domain);

        while ($snt->fetch()) {
185
            $sn = Status_network::getKV('site_id', $snt->site_id);
186 187 188 189 190 191 192
            if (!empty($sn)) {
                return $sn;
            }
        }
        return null;
    }

193 194 195
    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'DomainStatusNetwork',
196
                            'version' => GNUSOCIAL_VERSION,
197 198 199
                            'author' => 'Evan Prodromou',
                            'homepage' => 'http://status.net/wiki/Plugin:DomainStatusNetwork',
                            'rawdescription' =>
Siebrand Mazeland's avatar
Siebrand Mazeland committed
200
                            // TRANS: Plugin description.
201 202 203
                            _m('A plugin that maps a single status_network to an email domain.'));
        return true;
    }
204

205 206 207 208 209 210 211 212 213 214 215 216
    static function userExists($email)
    {
        $domain = self::toDomain($email);

        $sn = self::siteForDomain($domain);

        if (empty($sn)) {
            return false;
        }

        StatusNet::switchSite($sn->nickname);

217
        $user = User::getKV('email', $email);
218 219 220 221

        return !empty($user);
    }

222
    static function registerEmail($email)
223 224 225
    {
        $domain = self::toDomain($email);

Evan Prodromou's avatar
Evan Prodromou committed
226 227 228 229
        if (FreeEmail::isFree($domain)) {
            throw new ClientException(_("Use your work email."));
        }

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
        $sn = self::siteForDomain($domain);

        if (empty($sn)) {
            $installer = new DomainStatusNetworkInstaller($domain);

            // Do the thing
            $installer->main();

            $sn = $installer->getStatusNetwork();

            $config = $installer->getConfig();

            Status_network::$wildcard = $config['WILDCARD'];
        }

        StatusNet::switchSite($sn->nickname);

        $confirm = EmailRegistrationPlugin::registerEmail($email);

        return $confirm;
    }
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

    static function login($email, $password)
    {
        $domain = self::toDomain($email);

        $sn = self::siteForDomain($domain);

        if (empty($sn)) {
            throw new ClientException(_("No such site."));
        }

        StatusNet::switchSite($sn->nickname);

        $user = common_check_user($email, $password);

        if (empty($user)) {
            // TRANS: Form validation error displayed when trying to log in with incorrect credentials.
            throw new ClientException(_('Incorrect username or password.'));
        }

        $loginToken = Login_token::makeNew($user);

        if (empty($loginToken)) {
274
            throw new ServerException(sprintf(_('Could not create new login token for user %s'), $user->nickname));
275 276 277 278 279
        }

        $url = common_local_url('otp', array('user_id' => $loginToken->user_id,
                                             'token' => $loginToken->token));

280 281 282 283
        if (empty($url)) {
            throw new ServerException(sprintf(_('Could not create new OTP URL for user %s'), $user->nickname));
        }

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
        return $url;
    }

    static function recoverPassword($email)
    {
        $domain = self::toDomain($email);

        $sn = self::siteForDomain($domain);

        if (empty($sn)) {
            throw new NoSuchUserException(array('email' => $email));
        }

        StatusNet::switchSite($sn->nickname);

299
        $user = User::getKV('email', $email);
300 301 302 303 304
        
        if (empty($user)) {
            throw new ClientException(_('No such user.'));
        }
    }
305
}
306 307 308 309 310

// The way addPlugin() works, this global variable gets disappeared.
// So, we re-appear it.

DomainStatusNetworkPlugin::$_thetree = $tldTree;