root/releases/0.9rc1/mod/pages/lib.php

<?php
/**
 * Custom Pages plugin main file
 * $id$
 *
 * @copyright Copyright (c) 2007 Pro Soft Resources Inc. http://www.prosoftpeople.com
 * @author Rolando Espinoza La Fuente <rho@prosoftpeople.com>
 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
 * @todo documentation
 */

function pages_init() {
    global $CFG, $function, $PAGE;

    define('pages_allow_php_admin', true);
    define('pages_allow_php_user', false);
    define('pages_parse_keywords', true);
    define('pages_blog_textproc', false); // breaks content with br's

    pages_dbsetup();

    //DEPRECATED: legacy pages
    /*
    $PAGE->pages->old_compat = array(
        'about.php' => array(
            'title' => sprintf(__gettext('About %s'), $CFG->sitename),
            'function' => 'content:about',
            ),
        'faq.php' => array(
            'title' => sprintf(__gettext('%s FAQ'), $CFG->sitename),
            'function' => 'content:faq',
            ),
        'privacy.php' => array(
            'title' => sprintf(__gettext('%s Privacy Police'), $CFG->sitename),
            'function' => 'content:privacy',
            ),
        'terms.php' => array(
            'title' => sprintf(__gettext('%s Terms & Conditions'), $CFG->sitename),
            'function' => 'content:terms',
            ),
        'run_your_own.php' => array(
            'title' => sprintf(__gettext('Running your own %s'), $CFG->sitename),
            'function' => 'content:run_your_own',
            ),
        );

    $function["pages:frontpage_loggedin"][] = dirname(__FILE__) . "/lib/function_frontpage_loggedin.php";
    $function["pages:frontpage_loggedout"][] = dirname(__FILE__) . "/lib/function_frontpage_loggedout.php";

    $PAGE->pages->old_compat['frontpage_loggedin'] = array(
        'title' => sprintf(__gettext('Welcome {{username}}')),
        'function' => 'pages:frontpage_loggedin',
        );
    $PAGE->pages->old_compat['frontpage_loggedout'] = array(
        'title' => sprintf(__gettext('Welcome Guest')),
        'function' => 'pages:frontpage_loggedout',
        );
     */
}

function pages_pagesetup() {
    // backward compatibilty
    global $CFG, $PAGE;

    // menu keyword
    $CFG->templates->variables_substitute['pagesmenu'][] = 'pages_tplkw_menu';
    $CFG->templates->variables_substitute['page'][] = 'pages_tplkw_page';
    $CFG->templates->variables_substitute['sysadminemail'][] = 'pages_tplkw_sysadminemail';

    if (defined('context') && context == 'pages') {
        if (permissions_check('pages::edit', page_owner())) {
            $page_name = optional_param('page');
            $do_action = optional_param('do');

            if ($do_action != 'edit') {
                pages_submenu_add('pages:edit', __gettext('Edit this page'), pages_url($page_name, 'pages::edit', page_owner()), 0);
            }
        }
    }

    if (isloggedin()) {
        pages_menu_add('pages', __gettext('Your Pages'), get_url($_SESSION['userid'], 'pages::'));
    }

    // not show main site pages on sidebar
    sidebar_add(25, 'pages_sidebar', null, true, __gettext('Your pages'));
}

function pages_php_allowed() {
    if (page_owner() == -1
        || pages_allow_php_user
        || (pages_allow_php_admin && user_flag_get('admin', page_owner())))
    {
        return true;
    } else {
        return false;
    }
}

function pages_permissions_check($type, $ident) {
    $result = false;

    if (isadmin()) {
        return true;
    }

    switch ($type) {
        case 'pages::edit':
            if ($ident > 0) {
                $result = run('permissions:check', 'profile');
            } else {
                $result = false;
            }
            break;
        case 'pages::access':
            $access = get_field('pages', 'access', 'ident', $ident);
            $result = run('users:access_level_check', $access);
            break;
    }

    return $result;
}

function pages_dbsetup() {
    global $CFG, $METATABLES;

    if (!in_array($CFG->prefix . 'pages', $METATABLES)) {
        $dbscript = $CFG->dirroot . 'mod/pages/db/' . $CFG->dbtype . '.sql';

        if (is_readable($dbscript)) {
            modify_database($dbscript);

            // pages functions
            require_once(dirname(__FILE__) . '/lib/pages.inc.php');

            // insert first page
            $page = new StdClass;
            $page->name = __gettext('About');
            $page->title = __gettext('About') . " {{sitename}}";
            $page->content = @file_get_contents(dirname(__FILE__).'/legacy/content_about.html');

            $page = pages_create_page($page);

            if ($page) {
                set_config('pages_default', $page->ident);

                $_page = new StdClass;
                $_page->uri = 'privacy.php'; //backward compatibility
                $_page->title = __gettext('Privacy Policy');
                $_page->content = @file_get_contents(dirname(__FILE__).'/legacy/content_privacy.html');
                $_page->parent = $page->ident;
                $_page = pages_create_page($_page);

                $_page = new StdClass;
                $_page->uri = 'terms.php'; //backward compatibility
                $_page->title = __gettext('Terms and Conditions');
                $_page->content = @file_get_contents(dirname(__FILE__).'/legacy/content_terms.html');
                $_page->parent = $page->ident;
                $_page = pages_create_page($_page);
            }

            $page = new StdClass;
            $page->name = __gettext('FAQ');
            $page->title = __gettext('Frequently Asked Questions');
            $page->content = @file_get_contents(dirname(__FILE__).'/legacy/content_faq.html');

            $page = pages_create_page($page);

            //reload system
            header_redirect($CFG->wwwroot);

        } else {
            // not supported!
            error('Error: your database (' . $CFG->dbtype . ') is not supported by elgg pages plugin.');
        }

        print_continue('');
        exit();
    }
}

function pages_url($id=null, $type=null, $owner=-1) {
    global $CFG;
    if (!is_numeric($owner)) {
        trigger_error(__FUNCTION__.": invalid argument (owner: $owner)", E_USER_ERROR);
    }

    $url = '#'; //safe value

    if (empty($id)) {
        $id = pages_default($owner);
    }

    if (empty($type)) {
        $type = 'pages::page';
    }


    switch ($type) {
        case 'pages::':
            //id is user ident
            if ($id > 0) {
                $url = get_url($id, 'profile::');
                if (!empty($url)) $url .= 'pages/'; // url for user's pages
            } else {
                $url = $CFG->wwwroot . 'content/'; // url for site pages
            }
            break;
        case 'pages::page':
            if (is_string($id)) {
                // get from uri
                $page_name = $id;
            } elseif (is_int($id)) {
                $page_name = get_field('pages', 'uri', 'ident', $id, 'owner', $owner);
                if (empty($page_name)) {
                    trigger_error(__FUNCTION__.": page does not exists (page id: $id, owner: $owner)", E_USER_WARNING);
                    return null;
                }
            } else {
                trigger_error(__FUNCTION__.": invalid argument id.", E_USER_ERROR);
            }

            $url = get_url($owner, 'pages::') . $page_name;
            break;
        case 'pages::edit':
            $url = pages_url($id, 'pages::page', $owner) . '?do=edit';
            break;
    }

    return $url;
}

function pages_tplkw_menu($vars) {
    if (isset($vars[1])) {
        $owner = intval($vars[1]);
    } else {
        $owner = page_owner();
    }
    // force only keyword for site pages
    $owner = -1;

    return pages_html_menu(pages_get_mainmenu($owner));
}

function pages_tplkw_page($vars) {
    global $messages;
    $output = '';

    if (!isset($vars[1])) {
        $msg = "{{page}} keyword error, must provied a page name. e.g. {{page:Main}}";
        if (page_owner() == $_SESSION['userid']) {
            // show error to page owner
            $messages[] = $msg;
        }
        trigger_error($msg, E_USER_WARNING);
    } else {
        if (isset($vars[2])) {
            $page_id = $vars[2];
            $page_name = pages_build_uri($page_id);

            $username = $vars[1];
            // main site content
            if ($username == 'content') {
                $user_id = -1;
            } else {
                $user_id = (int)user_info_username('ident', $username);
            }

            if (empty($user_id)) {
                $msg = "{{page}} keyword error, invalid username: {$username}";
                if (page_owner() == $_SESSION['userid']) {
                    // show error to page owner
                    $messages[] = $msg;
                }
                trigger_error($msg, E_USER_WARNING);
            } else {
                $page_url = pages_url($page_name, 'pages::page', $user_id);
            }
        } else {
            $page_id = $vars[1];
            $page_name = pages_build_uri($page_id);
            $page_url = pages_url($page_name, 'pages::page', page_owner());
        }

        // return html link
        if (isset($page_url)) {
            $output =  pages_html_a($page_url, $page_id);
        }
    }

    return $output;
}

function pages_tplkw_sysadminemail() {
    global $CFG;
    return $CFG->sysadminemail;
}

function pages_frontpage($logged=false) {
    require_once(dirname(__FILE__) . '/lib/pages.inc.php');
    if ($logged) {
        $context = 'frontpage_loggedin';
        
        if (isadmin()) {
            pages_submenu_add('pages:edit_in', __gettext('Edit frontpage_loggedin'), pages_url('frontpage_loggedin', 'pages::edit', -1));
            pages_submenu_add('pages:edit_out', __gettext('Edit frontpage_loggedout'), pages_url('frontpage_loggedout', 'pages::edit', -1));
        }
    } else {
        $context = 'frontpage_loggedout';
    }
    return pages_get_page($context, -1);
}

function pages_sidebar() {
    global $CFG, $page_owner;

    $owner = page_owner();

    $menu_elements = pages_get_mainmenu($owner);

    if ($owner > 0) {
        if ($_SESSION['userid'] == $owner) {
            $title = __gettext('Your pages');
        }else {
            //$title = sprintf(__gettext("%s's pages"), htmlspecialchars(user_name($owner), ENT_COMPAT, 'utf-8'));
            $title = __gettext("Pages");
        }
    } else {
        $title = $CFG->sitename;
    }
    
    $body = templates_draw(array(
        'context' => 'sidebarholder',
        'title' => $title,
        'body' => pages_html_menu($menu_elements),
        ));

    return $body;
}

function pages_get_mainmenu($owner=-1) {
    global $CFG;
    if (!is_numeric($owner)) {
        trigger_error(__FUNCTION__.": invalid argument (owner: $owner)");
    }

    $elements = get_records_sql("SELECT ident,parent,name,uri,weight,owner FROM {$CFG->prefix}pages WHERE owner=? AND parent>=0 ORDER BY parent,weight,name", array($owner));

    $menu = array();
    if (is_array($elements)) {
        foreach ($elements as $e) {
            if ($e->parent == 0) {
                if (!isset($menu[$e->weight])) {
                    $menu[$e->ident] = array();
                }
                $menu[$e->ident][0] = $e;
            } else {
                if (!isset($menu[$e->parent][1])) {
                    $menu[$e->parent][1] = array();
                } 
                $menu[$e->parent][1][] = $e;
            }
        }
    }

    return $menu;
}

function pages_html_menu($elements) {
    $menu = '';
    global $page_owner;

    if (is_array($elements)) {
        $current_page = pages_current_page();
        $current_uri = !empty($current_page->uri) ? $current_page->uri : '';

        foreach ($elements as $p => $li) {
            if (is_array($li)) {
                $parent = $li[0];
                $childs = isset($li[1]) ? $li[1] : null;

                // set owner
                if (!isset($owner)) $owner = $parent->owner;

                if ($parent->uri == $current_uri) {
                    $parent_link = pages_html_a(pages_url($parent->uri, 'pages::page', $parent->owner), $parent->name, array('class' => 'selected'));
                } else {
                    $parent_link = pages_html_a(pages_url($parent->uri, 'pages::page', $parent->owner), $parent->name);
                }

                if (is_array($childs)) {
                    $submenu = '';
                    foreach ($childs as $child) {
                        if ($child->uri == $current_uri) {
                            $_li = pages_html_a(pages_url($child->uri, 'pages::page', $child->owner), $child->name, array('class' => 'selected'));
                        } else {
                            $_li = pages_html_a(pages_url($child->uri, 'pages::page', $child->owner), $child->name);
                        }
                        $submenu .= pages_html_wrap('li', $_li, array('class' => 'menu-item'));
                    }

                    $menu .= pages_html_wrap('li', $parent_link . pages_html_wrap('ul', $submenu), array('class' => 'menu-parent'));
                } else {
                    $menu .= pages_html_wrap('li', $parent_link, array('class' => 'menu-item'));
                }
            } else {
            }
        }
    }

    // workaround
    if (!isset($owner)) $owner = empty($page_owner) ? page_owner() : $page_owner;

    if (empty($menu)) {
        $main_link = pages_html_a(pages_url(__gettext('Main'), 'pages::page', $owner), __gettext('Main'));
        $menu .= pages_html_wrap('li', $main_link, array('class' => 'menu-item'));
    }

    // "add new" page link
    if (permissions_check('pages::edit',$owner)) {
        $new_page_link = pages_html_wrap('small', __gettext('New page'));
        $menu .= pages_html_wrap('li', pages_html_wrap('a', $new_page_link, array('href'=>pages_url('New_page', 'pages::edit', $owner), 'title'=>__gettext('New page')), array('class' => 'menu-item')));
    }

    if (!empty($menu)) {
        $menu = pages_html_wrap('ul', $menu);
    }

    return $menu;
}

function pages_current_page($page=null) {
    global $PAGE;

    if (!is_null($page)) {
        $PAGE->pages->current = $page;
    }

    if (!isset($PAGE->pages->current)) {
        $PAGE->pages->current = null;
    }

    return $PAGE->pages->current;
}

function pages_html_wrap($tag, $content=null, $attrs=null) {
    if (is_array($attrs)) {
        $extra = pages_html_array2attrs($attrs);
    } else {
        $extra = '';
    }

    if (!empty($content)) {
        $result = "<{$tag}{$extra}>{$content}</{$tag}>\n";
    } else {
        $result = "\n<{$tag} {$extra} />\n";
    }

    return $result;
}

function pages_html_a($url, $title, $attrs=null) {
    // Default attrs
    $extra = array(
        'title' => $title,
        'href' => $url,
        );

    if (is_array($attrs)) {
        $extra = array_merge($extra, $attrs);
    }

    return pages_html_wrap('a', htmlspecialchars($title, ENT_QUOTES, 'utf-8'), $extra);
}

function pages_html_input($type, $attrs=null) {
    if (!isset($attrs)) $attrs = array();

    $attrs = array_merge(array('type' => $type), $attrs);

    return pages_html_wrap('input', null, $attrs);
}

function pages_html_form($name, $body, $attrs=null) {
    if (!isset($attrs)) {$attrs = array();}

    if (!isset($attrs['id'])) { $attrs['id'] = $name; }
    if (!isset($attrs['name'])) { $attrs['name'] = $name; }
    if (!isset($attrs['method'])) { $attrs['method'] = 'post'; }
    if (!isset($attrs['action'])) { $attrs['action'] = ''; }

    if (isset($attrs['buttons'])) {
        $buttons = $attrs['buttons'];
    } else {
        $buttons = pages_html_input('submit', array('value' => __gettext('Submit')));
    }