OuNeT RdXxS Shell

/web/htdocs/www.euroroma.net/home/zenphoto/zp-core/zp-extensions/federated_logon.php

<?php
/**
 * Interface to federated login handlers
 *
 * The plugin will use a federated login such as Google Accounts as a logon server.
 * If the logon succeeds it will log that user onto Zenphoto. An attempt will be
 * made to match the user to an existing Zenphoto user. If such is found, then the
 * user is logged in as that Zenphoto user. If not, a Zenphoto user will be created
 * and the user logged in as him.
 *
 * The default priviledges for a created user are obtained from the <i>viewers</i> group.
 * (The user will belong to that group.) This will be the case whether or not the
 * user_groups plugin is enabled. If you want to be able to specify unique default
 * priviledges you will have to use the user_groups plugin at least until you have
 * defined your default group.
 *
 * You may also find the <i>user_expiry</i> plugin useful in conjunction with this plugin.
 * Since users may arbitrarily be created from those visitors who login with their
 * federated credentials you may want to "age" these users and remove them after some
 * period of time. That is done by the <i>user_expiry</i> plugin.
 *
 * Currently there is only one type of handler available. It is an OpenID handler based on the
 * {@link http://www.janrain.com/openid-enabled Janrain OpenID Enabled library}. There are
 * some server requirements for this library. To see if you server meets them run
 * the script <var>zp-core/zp-extensions/federated_logon/OpenID_detect.php</var>. It will give
 * you a report on what might need be done. You can ignore items about data stores as
 * they are not used in this implementation.
 *
 * See also the Janrain Readme.txt file.
 *
 * Zenphoto provides handlers for <var>Google</var>, <var>Yahoo</var>, <var>Verisign</var>, and <var>MyOpenid</var>.
 * Other handlers can be created and placed in the <var>plugins/federated_logon</var> folder.
 * Integration with Zenphoto is fairly simple. The logon handler script should be
 * named ending in <var>_logon.php</var>. The plugin will use the name up to that point as the
 * selector on the logon form.
 *
 * You need to preserve the <var>$_GET['redirect']</var> parameter for use after the authentication
 * is successful at which time you call the <var>federated_logon::credentials()</var> function passing a
 * <i>user ID</i>, <i>e-mail</i> and <i>name</i> (if you have them) and the redirection link you saved above.
 * For an example, the former is done at the beginning of the <var>OpenID_logon.php</var> script. The
 * latter is done in the "run()" function of OpenID_finish_auth.php
 *
 *
 * @author Stephen Billard (sbillard)
 * @package plugins
 * @subpackage users
 */
$plugin_is_filter = 9 | CLASS_PLUGIN;
$plugin_description = gettext('Handles logon from <em>OpenID</em> credential providers.');
$plugin_notice = sprintf(gettext('Run the <a href="%s">OpenID detect</a> script to check compatibility of your server configuration.'), FULLWEBPATH . '/' . ZENFOLDER . '/' . PLUGIN_FOLDER . '/federated_logon/Auth/OpenID_detect.php');
$plugin_author = "Stephen Billard (sbillard)";

$plugin_disable = (getOption('federated_logon_detect')) ? false : sprintf(gettext('Run the <a href="%s">OpenID detect</a> script to check compatibility of your server configuration.'), FULLWEBPATH . '/' . ZENFOLDER . '/' . PLUGIN_FOLDER . '/federated_logon/Auth/OpenID_detect.php');
if ($plugin_disable) {
    enableExtension('federated_logon', 0);
} else {
    $option_interface = 'federated_logon';
    zp_register_filter('theme_head', 'federated_logon::css');
    zp_register_filter('alt_login_handler', 'federated_logon::alt_login_handler');
    zp_register_filter('save_admin_custom_data', 'federated_logon::save_custom');
    zp_register_filter('edit_admin_custom_data', 'federated_logon::edit_admin');
    zp_register_filter('load_theme_script', 'federated_logon::verify');
}

/**
 * Option class
 *
 */
class federated_logon {

    /**
     * Option instantiation
     */
    function __construct() {
        global $_zp_authority;
        setOptionDefault('federated_login_group', 'viewers');
        $mailinglist = $_zp_authority->getAdminEmail(ADMIN_RIGHTS);
        if (count($mailinglist) == 0) { //    no one to send the notice to!
            setOption('register_user_notify', 0);
        } else {
            setOptionDefault('register_user_notify', 1);
        }
        $files = getPluginFiles('*_logon.php', 'federated_logon');
        foreach ($files as $key => $link) {
            setOptionDefault('federated_logon_handler' . $key, 1);
        }
    }

    /**
     * Provides option list
     */
    function getOptionsSupported() {
        global $_zp_authority, $_common_notify_handler;
        $admins = $_zp_authority->getAdministrators('groups');
        $ordered = array();
        foreach ($admins as $key => $admin) {
            if ($admin['rights'] && !($admin['rights'] & ADMIN_RIGHTS)) {
                $ordered[$admin['user']] = $admin['user'];
            }
        }
        $files = getPluginFiles('*_logon.php', 'federated_logon');
        foreach ($files as $key => $link) {
            $list[str_replace('_logon', '', $key)] = 'federated_logon_handler' . $key;
        }
        $options = array(gettext('Assign user to')     => array('key'                 => 'federated_login_group', 'type'             => OPTION_TYPE_SELECTOR,
                                        'order'             => 0,
                                        'selections' => $ordered,
                                        'desc'             => gettext('The user group to which to map the federated login.')),
                        gettext('Handlers')                 => array('key'                 => 'federated_logon_handler', 'type'             => OPTION_TYPE_CHECKBOX_ARRAY,
                                        'checkboxes' => $list,
                                        'order'             => 1,
                                        'desc'             => gettext('Un-check any handler you do not want to support.')),
                        gettext('Notify*')                 => array('key'             => 'register_user_notify', 'type'         => OPTION_TYPE_CHECKBOX,
                                        'disabled' => $_common_notify_handler,
                                        'order'         => 7,
                                        'desc'         => gettext('If checked, an e-mail will be sent to the gallery admin when a new user has verified his registration. (Verification is required only if the Federated Logon provider does not supply an e-mail address.)'))
        );
        $files = getPluginFiles('*_logon.php', 'federated_logon');

        $mailinglist = $_zp_authority->getAdminEmail(ADMIN_RIGHTS);
        if (count($mailinglist) == 0) { //    no one to send the notice to!
            $options[gettext('Notify*')]['disabled'] = true;
            $options[gettext('Notify*')]['desc'] .= ' ' . gettext('Of course there must be some Administrator with an e-mail address for this option to make sense!');
        }
        if ($_common_notify_handler) {
            $options['note'] = array('key'         => 'menu_truncate_note', 'type'     => OPTION_TYPE_NOTE,
                            'order'     => 8,
                            'desc'     => '<p class="notebox">' . $_common_notify_handler . '</p>');
        } else {
            $_common_notify_handler = gettext('* The option may be set via the <a href="javascript:gotoName(\'federated_logon\');"><em>register_user</em></a> plugin options.');
            $options['note'] = array('key'         => 'menu_truncate_note',
                            'type'     => OPTION_TYPE_NOTE,
                            'order'     => 8,
                            'desc'     => gettext('<p class="notebox">*<strong>Note:</strong> The setting of this option is shared with other plugins.</p>'));
        }
        return $options;
    }

    /**
     * Handles the custom option $option
     * @param $option
     * @param $currentValue
     */
    function handleOption($option, $currentValue) {

    }

    /**
     * Load the CSS for the logon buttons
     */
    static function css() {
        global $_zp_gallery;
        if (OFFSET_PATH) {
            $inTheme = false;
        } else {
            $inTheme = $_zp_gallery->getCurrentTheme();
        }
        $css = getPlugin('federated_logon/federated_logon_buttons.css', $inTheme, true);
        ?>
        <link rel="stylesheet" href="<?php echo $css; ?>" type="text/css" />
        <?php
    }

    /**
     * Provides a list of alternate handlers for logon
     * @param $handler_list
     */
    static function alt_login_handler($handler_list) {
        $files = getPluginFiles('*_logon.php', 'federated_logon');
        foreach ($files as $key => $link) {
            $option = getOption('federated_logon_handler' . $key);
            if ($option || is_null($option)) {
                $link = str_replace(SERVERPATH, WEBPATH, str_replace('\\', '/', $link));
                $name = str_replace('_', ' ', substr(basename($link), 0, -10));
                $handler_list[$name] = array('script' => $link, 'params' => array());
            }
        }
        return $handler_list;
    }

    /**
     * Common logon handler.
     * Will log the user on if he exists. Otherwise it will create a user accoung and log
     * on that account.
     *
     * Redirects into Zenphoto on success presuming there is a redirect link.
     *
     * @param $user
     * @param $email
     * @param $name
     * @param $redirect
     */
    static function credentials($user, $email, $name, $redirect) {
        $userobj = Zenphoto_Authority::getAnAdmin(array('`user`='     => $user, '`valid`=' => 1));
        $more = false;
        if ($userobj) { //    update if changed
            $save = false;
            if (!empty($email) && $email != $userobj->getEmail()) {
                $save = true;
                $userobj->setEmail($email);
            }
            if (!empty($name) && $name != $userobj->getName()) {
                $save = true;
                $userobj->setName($name);
            }
            if ($save) {
                $userobj->save();
            }
        } else { //    User does not exist, create him
            $groupname = getOption('federated_login_group');
            $groupobj = Zenphoto_Authority::getAnAdmin(array('`user`='     => $groupname, '`valid`=' => 0));
            if ($groupobj) {
                $group = NULL;
                if ($groupobj->getName() != 'template') {
                    $group = $groupname;
                }
                $userobj = Zenphoto_Authority::newAdministrator('');
                $userobj->transient = false;
                $userobj->setUser($user);
                $credentials = array('federated', 'user', 'email');
                if ($name)
                    $credentials[] = 'name';
                $userobj->setCredentials($credentials);
                $userobj->setName($name);
                $userobj->setPass($user . HASH_SEED . gmdate('d M Y H:i:s'));
                $userobj->setObjects(NULL);
                $userobj->setCustomData('');
                $userobj->setLanguage(getUserLocale());
                $userobj->setObjects($groupobj->getObjects());
                if (is_valid_email_zp($email)) {
                    $userobj->setEmail($email);
                    if (getOption('register_user_create_album')) {
                        $userobj->createPrimealbum();
                    }
                } else {
                    $groupobj = Zenphoto_Authority::getAnAdmin(array('`user`='     => 'federated_verify', '`valid`=' => 0));
                    if (empty($groupobj)) {
                        $groupobj = Zenphoto_Authority::newAdministrator('federated_verify', 0);
                        $groupobj->setName('group');
                        $groupobj->setRights(NO_RIGHTS);
                        $groupobj->save();
                    }
                    $group = 'federated_verify';
                    $redirect = WEBPATH . '/' . ZENFOLDER . '/admin.php';
                }
                $userobj->setRights($groupobj->getRights());
                $userobj->setGroup($group);
                $userobj->save();
            } else {
                $more = sprintf(gettext('Group %s does not exist.'), $groupname);
            }
        }
        if (!$more) {
            zp_apply_filter('federated_login_attempt', true, $user);
            Zenphoto_Authority::logUser($userobj);
            if ($redirect) {
                header("Location: " . $redirect);
            }
        }
        return $more;
    }

    /**
     * Check if an e-mail address has been provided
     * @param $updated
     * @param $userobj
     * @param $i
     * @param $alter
     */
    static function save_custom($updated, $userobj, $i, $alter) {
        global $_notification_sent;
        if (($userobj->getGroup() == 'federated_verify') && is_valid_email_zp($userobj->getEmail())) {
            $userobj->save();
            $admin_e = $userobj->getEmail();
            $user = $userobj->getUser();
            $key = bin2hex(serialize(array('user'     => $user, 'email'     => $admin_e, 'date'     => time())));
            $link = FULLWEBPATH . '/index.php?verify_federated_user=' . $key;
            $message = sprintf(gettext('Visit %s to validate your federated logon credentials.'), $link);
            zp_mail(get_language_string(gettext('Federated user confirmation')), $message, array($user => $admin_e));
        }
        return $updated;
    }

    /**
     * Enter Admin user tab handler
     * @param $html
     * @param $userobj
     * @param $i
     * @param $background
     * @param $current
     * @param $local_alterrights
     */
    static function edit_admin($html, $userobj, $i, $background, $current, $local_alterrights) {
        global $_zp_current_admin_obj;
        if (empty($_zp_current_admin_obj) || !$userobj->getValid())
            return $html;
        $federated = $userobj->getCredentials(); //    came from federated logon, disable the e-mail field
        if (!in_array('federated', $federated)) {
            $federated = false;
        }

        if ($userobj->getID() == $_zp_current_admin_obj->getID()) { //    The current logged on user
            if (($userobj->getGroup() == 'federated_verify')) { //    pending email address verification
                $email = $userobj->getEmail();
                if (empty($email)) {
                    $msg = gettext('<strong>NOTE:</strong> Update your profile with a valid <em>e-mail</em> address and you will be sent a link to validate your access to the site.');
                    $myhtml =
                                    '<tr' . ((!$current) ? ' style="display:none;"' : '') . ' class="userextrainfo">
                            <td' . ((!empty($background)) ? ' style="' . $background . '"' : '') . ' valign="top" colspan="2">' . "\n" .
                                    '<p class="notebox">' . $msg . '</p>' . "\n" .
                                    '</td>
                        </tr>' . "\n";
                    $html = $myhtml . $html;
                }
            }
        } else if ($federated) {
            $msg = gettext("<strong>NOTE:</strong> User's credentials came from a Federated logon.");
            $myhtml =
                            '<tr' . ((!$current) ? ' style="display:none;"' : '') . ' class="userextrainfo">
                    <td' . ((!empty($background)) ? ' style="' . $background . '"' : '') . ' valign="top" colspan="2">' . "\n" .
                            '<p class="notebox">' . $msg . '</p>' . "\n" .
                            '</td>
                </tr>' . "\n";
            $html = $myhtml . $html;
        }
        return $html;
    }

    /**
     * Processes the verification POST tickets
     * @param string $script (we do not use this)
     * @return string
     */
    static function verify($script) {
        //process any verifications posted
        if (isset($_GET['verify_federated_user'])) {
            $params = unserialize(pack("H*", trim(sanitize($_GET['verify_federated_user']), '.')));
            if ((time() - $params['date']) < 2592000) {
                $userobj = Zenphoto_Authority::getAnAdmin(array('`user`='     => $params['user'], '`email`=' => $params['email'], '`valid`>' => 0));
                if ($userobj) {
                    $groupname = getOption('federated_login_group');
                    $groupobj = Zenphoto_Authority::getAnAdmin(array('`user`='     => $groupname, '`valid`=' => 0));
                    if ($groupobj) {
                        $userobj->setRights($groupobj->getRights());
                        $userobj->setGroup($groupname);
                        $userobj->setObjects($groupobj->getObjects());
                        if (getOption('register_user_create_album')) {
                            $userobj->createPrimealbum();
                        }
                        $userobj->save();
                    }
                    zp_apply_filter('register_user_verified', $userobj);
                    if (getOption('register_logon_user_notify')) {
                        zp_mail(gettext('Zenphoto Gallery registration'), sprintf(gettext('%1$s (%2$s) has registered for the zenphoto gallery providing an e-mail address of %3$s.'), $userobj->getName(), $userobj->getUser(), $userobj->getEmail()));
                    }
                    Zenphoto_Authority::logUser($userobj);
                    header("Location: " . FULLWEBPATH . '/' . ZENFOLDER . '/admin.php');
                    exitZP();
                }
            }
        }
        return $script;
    }

    /**
     * Creates a list of logon buttons for federated logon handlers.
     * Note that it will use an image if one exists. The name of the image
     * should be cononical to the name of the logon handler, but without the "_logon'.
     * The image must be a PNG file.
     *
     * The styling of the buttons is done by the "federated_logon_buttons.css". If you do not like the
     * one provided place an alternate version in your theme folder or the plugins/federated_logon
     * folder.
     */
    static function buttons($redirect = NULL) {
        $alt_handlers = federated_logon::alt_login_handler('');
        ?>
        <ul class="logon_buttons">
            <?php
            foreach ($alt_handlers as $handler => $details) {
                $script = $details['script'];
                $authority = str_replace('_logon', '', stripSuffix(basename($script)));
                if (is_null($redirect)) {
                    $details['params'][] = 'redirect=/' . ZENFOLDER . '/admin.php';
                } else {
                    if (!empty($redirect)) {
                        $details['params'][] = 'redirect=' . $redirect;
                    }
                }
                If (count($details['params'])) {
                    $params = "'" . implode("','", $details['params']) . "'";
                } else {
                    $params = '';
                }
                ?>
                <li>
                    <span class="fed_buttons">
                        <a href="javascript:launchScript('<?php echo $script; ?>',[<?php echo $params; ?>]);" title="<?php echo $authority; ?>" >
                            <?php
                            $logo = ltrim(str_replace(WEBPATH, '', dirname($script)) . '/' . $authority . '.png', '/');
                            if (file_exists(SERVERPATH . '/' . $logo)) {
                                ?>
                                <img src="<?php echo WEBPATH . '/' . $logo; ?>" alt="<?php echo $authority; ?>" title="<?php printf(gettext('Login using %s'), $authority); ?>" />
                                <?php
                            } else {
                                echo $authority;
                            }
                            ?>
                        </a>
                    </span>
                </li>
                <?php
            }
            ?>
        </ul>
        <?php
    }

}
?>