simpleid/www/page.inc.php

<?php 
/*
 * SimpleID
 *
 * Copyright (C) Kelvin Mo 2009
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 * 
 * $Id$
 */

/**
 * Functions for displaying various pages in SimpleID.
 *
 * @package simpleid
 * @filesource
 * @since 0.7
 */
 
/**
 * Displays the dashboard page.
 */
function page_dashboard() {
    global $user;
    global $xtpl;
    
    // Require HTTPS, redirect if necessary
    check_https('redirect', true);
    
    if ($user == NULL) {
        user_login_form('');
        return;
    }
    
    user_header();
    page_nav();
    
    $blocks = _page_welcome_block();
    
    $blocks = array_merge($blocks, _page_dashboard_otp_block(), extension_invoke_all('page_dashboard'));
    $blocks = array_map('page_render_block', $blocks);
    $xtpl->assign('blocks', implode($blocks));
    $xtpl->parse('main.blocks');
    
    $xtpl->assign('title', t('Dashboard'));
    $xtpl->parse('main');
    $xtpl->out('main');

}

/**
 * Displays the profile page.
 */
function page_profile() {
    global $user;
    global $xtpl;
    
    // Require HTTPS, redirect if necessary
    check_https('redirect', true);
    
    if ($user == NULL) {
        user_login_form('my/profile');
        return;
    }
    
    user_header();
    page_nav();
    
    $blocks = _page_discovery_block();

    $blocks = array_merge($blocks, _user_page_profile(), extension_invoke_all('page_profile'));
    $blocks = array_map('page_render_block', $blocks); 
    $xtpl->assign('blocks', implode($blocks));
    $xtpl->parse('main.blocks');
    
    $xtpl->assign(array('js_locale_label' => 'code', 'js_locale_text' => addslashes(t('<em>You need to set at least one of OpenID 1.x or OpenID 2 to generate the code.</em>'))));
    $xtpl->parse('main.js_locale');
    
    $xtpl->assign('javascript', '<script src="' . get_base_path() . 'html/page-profile.js" type="text/javascript"></script>');
    $xtpl->assign('title', t('My Profile'));
    $xtpl->parse('main');
    $xtpl->out('main');
}

/**
 * Returns the user's home page.
 */
function page_sites() {
    global $user;
    global $xtpl;
    
    // Require HTTPS, redirect if necessary
    check_https('redirect', true);
    
    if ($user == NULL) {
        user_login_form('my/sites');
        return;
    }
    
    user_header();
    page_nav();
    
    if (isset($user['rp'])) {
        $user_rps =& $user['rp'];
    } else {
        $user_rps = array();
    }
    
    if (isset($_POST['tk'])) {
        if (!validate_form_token($_POST['tk'], 'autorelease')) {
            set_message(t('SimpleID detected a potential security attack.  Please try again.'));
        } else {
            if (isset($_POST['autorelease'])) {
                foreach ($_POST['autorelease'] as $realm => $autorelease) {
                    if (isset($user_rps[$realm])) {
                        $user_rps[$realm]['auto_release'] = ($autorelease) ? 1 : 0;
                    }
                }
            }
            
            if (isset($_POST['remove'])) {
                foreach ($_POST['remove'] as $realm => $autorelease) {
                    if (isset($user_rps[$realm])) {
                        unset($user_rps[$realm]);
                    }
                }
            }
            
            if (isset($_POST['update-all'])) {
                foreach ($user_rps as $realm => $values) {
                    $user_rps[$realm]['auto_release'] = (isset($_POST['autorelease'][$realm]) && $_POST['autorelease'][$realm]) ? 1 : 0;
                }
            }
            
            user_save($user);
    
            set_message(t('Your preferences have been saved.'));
        }
    }
    
    if ($user_rps) {
        uksort($user_rps, '_page_sites_sort');
        foreach ($user_rps as $realm => $rp) {
            $xtpl->assign('realm_name', preg_replace('@^https?://(www\.|\*\.)?@', '<span class="url-elide">$0</span>', htmlspecialchars($rp['realm'], ENT_QUOTES, 'UTF-8')));
            $xtpl->assign('realm', htmlspecialchars($rp['realm'], ENT_QUOTES, 'UTF-8'));
            $xtpl->assign('last_time', htmlspecialchars($rp['last_time'], ENT_QUOTES, 'UTF-8'));
            $xtpl->assign('last_time_formatted', htmlspecialchars(strftime(SIMPLEID_DATE_TIME_FORMAT, $rp['last_time']), ENT_QUOTES, 'UTF-8'));
            $xtpl->assign('auto_release', (isset($rp['auto_release']) && $rp['auto_release']) ? 'checked="checked"' : '');
            
            if (SIMPLEID_VERIFY_RETURN_URL_USING_REALM) {
                // $rp_info would usually expire by now, so we allow for stale results to be retrieved to improve performance
                $rp_info = simpleid_get_rp_info($realm, TRUE);
                if (!isset($rp_info['return_to_verified']) || !$rp_info['return_to_verified']) $xtpl->assign('realm_class', 'return-to-suspect');
            }
            
            $xtpl->parse('main.sites.realm');
        }
    }
    
    if (!$user_rps || (count($user_rps) == 0)) {
        $xtpl->assign('disabled', 'disabled="disabled"');
    }
    
    $xtpl->assign('token', get_form_token('autorelease'));
    
    $xtpl->assign('realm_label', t('Site'));
    $xtpl->assign('last_time_label', t('Last access'));
    $xtpl->assign('auto_release_label', t('Automatic'));
    $xtpl->assign('remove_label', t('Remove'));
    $xtpl->assign('submit_button', t('Submit'));    
    
    $xtpl->parse('main.sites');
    
    $xtpl->assign(array('js_locale_label' => 'openid_suspect', 'js_locale_text' => addslashes(t('This web site has not confirmed its identity and might be fraudulent.')) . '\n\n' . addslashes(t('Are you sure you wish to automatically send your information to this site for any future requests?'))));
    $xtpl->parse('main.js_locale');
    
    $xtpl->assign('title', t('My Sites'));
    $xtpl->assign('javascript', '<script src="' . get_base_path() . 'html/openid-consent.js" type="text/javascript"></script>');
    $xtpl->parse('main');
    $xtpl->out('main');
}

/**
 * A custom sort function for realms.  This strips out the following:
 *
 * - http://
 * - https://
 * - www.
 * - *.
 *
 * @param string $a
 * @param string $b
 * @return int
 */
function _page_sites_sort($a, $b) {
    $a = preg_replace('@^https?://(www\.|\*\.)?@', '', $a);
    $b = preg_replace('@^https?://(www\.|\*\.)?@', '', $b);
    return strcasecmp($a, $b);
}

/**
 * Set up the navigation section in the header
 */
function page_nav() {
    global $user;
    global $xtpl;
    
    $xtpl->assign('nav_base', trim(simpleid_url(' ', '', true)));
    
    $xtpl->assign('nav_dashboard_label', t('Dashboard'));
    $xtpl->assign('nav_profile_label', t('My Profile'));
    $xtpl->assign('nav_sites_label', t('My Sites'));
    
    $xtpl->parse('main.nav_toggle');
    $xtpl->parse('main.nav');
}

/**
 * Renders a particular block.
 *
 * @param array $block the block to render
 * @return string the HTML of the rendered block
 */
function page_render_block($block) {
    static $xtpl_block;
    
    if (!$xtpl_block) $xtpl_block = new XTemplate('html/block.xtpl');
    
    $xtpl_block->reset('block');
    $xtpl_block->assign('id', $block['id']);
    $xtpl_block->assign('title', $block['title']);
    $xtpl_block->assign('content', $block['content']);
    
    if (isset($block['links'])) {
        $xtpl_block->assign('links', $block['links']);
        $xtpl_block->parse('block.links');
    }
    
    $xtpl_block->parse('block');
    return $xtpl_block->text('block');
}

/**
 * Returns the welcome block.
 *
 * @return array the welcome block
 */
function _page_welcome_block() {
    global $user;
    
    return array(array(
        'id' => 'welcome',
        'title' => t('Welcome'),
        'content' => t('You are logged in as %uid (%identity).', array('%uid' => $user['uid'], '%identity' => $user['identity']))
    ));
}

/**
 * Returns the dashboard OTP block.
 *
 * @return array the dashboard OTP block
 */
function _page_dashboard_otp_block() {
    global $user;

    $base_path = get_base_path();

    $html = '<p>' . t('Login verification adds an extra layer of protection to your account. When enabled, you will need to enter an additional security code whenever you log into SimpleID.') . '</p>';

    if (isset($user['otp'])) {
        $html .= '<p>' . t('Login verification is <strong>enabled</strong>.') . '</p>';
        $html .= '<form action="' . $base_path . 'index.php" method="post" enctype="application/x-www-form-urlencoded"><input type="hidden" name="tk" value="'. get_form_token('dashboard_otp') . '"/>';
        $html .= '<input type="hidden" name="q" value="otp"/><input type="submit" name="op" value="' . t('Disable') . '" /></form>';
    } else {
        $html .= '<p>' . t('Login verification is <strong>disabled</strong>. To enable login verification, click the button below.') . '</p>';
        $html .= '<form action="' . $base_path . 'index.php" method="post" enctype="application/x-www-form-urlencoded"><input type="hidden" name="tk" value="'. get_form_token('dashboard_otp') . '"/>';
        $html .= '<input type="hidden" name="q" value="otp"/><input type="submit" name="op" value="' . t('Enable') . '" /></form>';
    }
    
    return array(array(
        'id' => 'otp',
        'title' => t('Login Verification'),
        'content' => $html
    ));
}

/**
 * Returns a block containing discovery information.
 *
 * @return array the discovery block
 */
function _page_discovery_block() {
    global $user;
    
    $html = "<h3>" . t('&lt;link&gt; tags') . "</h3>";
    
    $html .= "<div><label><input type=\"checkbox\" name=\"openid1\" value=\"1\" id=\"discovery-openid1\" class=\"discovery-checkbox\" />" . t('OpenID 1.x') . "</label>";
    $html .= "<label><input type=\"checkbox\" name=\"openid2\" value=\"1\" id=\"discovery-openid2\" class=\"discovery-checkbox\" />" . t('OpenID 2.0') . "</label>";
    $html .= "<label><input type=\"checkbox\" name=\"local-id\" value=\"1\" id=\"discovery-local-id\" class=\"discovery-checkbox\" />" . t('Claim a different identifier') . "</label></div>";
    $html .= "<pre id=\"discovery-link-tags\">";
    $html .= "</pre>";
    $html .= "<ul id=\"discovery-templates\"><li class=\"openid1\">&lt;link rel=&quot;openid.server&quot; href=&quot;" . htmlspecialchars(simpleid_url(), ENT_QUOTES, 'UTF-8') . "&quot; /&gt;</li>\n";
    $html .= "<li class=\"openid2\">&lt;link rel=&quot;openid2.provider&quot; href=&quot;" . htmlspecialchars(simpleid_url(), ENT_QUOTES, 'UTF-8') ."&quot; /&gt;</li>\n";
    $html .= "<li class=\"openid1-local-id\">&lt;link rel=&quot;openid.delegate&quot; href=&quot;" . htmlspecialchars($user['identity'], ENT_QUOTES, 'UTF-8') . "&quot; /&gt;</li>\n";
    $html .= "<li class=\"openid2-local-id\">&lt;link rel=&quot;openid2.local_id&quot; href=&quot;" . htmlspecialchars($user['identity'], ENT_QUOTES, 'UTF-8') ."&quot; /&gt;</li></ul>\n";

    $html .= "<h3>" . t('YADIS') . "</h3>";
    $html .= "<ol><li>" . t('Write your own or <a href="!url">download</a> your YADIS document', array('!url' => simpleid_url('xrds/'. $user['uid'], '', true))) . "</li>";
    $html .= "<li><div>" . t('Add HTTP headers or &lt;meta&gt; tag, e.g.:') . "<div><pre>&lt;meta http-equiv=&quot;X-XRDS-Location&quot; content=&quot;" . htmlspecialchars(simpleid_url('xrds/'. $user['uid']), ENT_QUOTES, 'UTF-8') . "&quot; /></pre>";
    $html .= "</li></ol>";
    
    return array(array(
        'id' => 'discovery',
        'title' => t('Claim your Identifier'),
        'content' => $html,
        'links' => '<a href="http://simpleid.org/docs/1/identity-claim/">More information</a>'
    ));
}
?>