root/releases/elgg0.8rc2/lib/templates.php

<?php

/*** NZVLE TODO
 *** 
 *** + Break the html/css bits of the Default_Template into separate files
 ***   they mess up the code layout and indentation, and generally don't 
 ***   belong here.
 *** + Clean up and document the calling conventions -- get rid of $parameter
 *** + the callbacks to template_variables_substitute are *evil* -- rework
 ***
 ***/

/***
 *** Takes in the short name of a template and returns the comparable version
 *** from the file system
 *** @param string $shortname short name of template to convert to file version
 ***/
function templates_shortname_to_file($shortname) {
    $shortname = str_replace(" ","_",$shortname);
    return $shortname;
}

/***
 *** Takes in the directory name of a template and returns the comparable version
 *** for use as a shortname to display
 *** @param string $foldername folder name of template to convert to internal version
 ***/
 function templates_file_to_shortname($foldername) {
     $foldername = str_replace("_"," ",$foldername);
     return $foldername;
 }
 
function default_template () {

    global $CFG;
    global $template;
    global $template_definition;
    $sitename = $CFG->sitename;

    $run_result = '';

    $template_definition[] = array(
                                    'id' => 'css',
                                    'name' => __gettext("Stylesheet"),
                                    'description' => __gettext("The Cascading Style Sheet for the template."),
                                    'glossary' => array(),
                                    'display'  => 1,
                                    );

    $template['css'] = file_get_contents($CFG->templatesroot . "Default_Template/css");
    
    $template_definition[] = array(
                                   'id' => 'pageshell',
                                   'name' => __gettext("Page Shell"),
                                   'description' => __gettext("The main page shell, including headers and footers."),
                                   'glossary' => array(
                                                       '{{metatags}}' => __gettext("Page metatags (mandatory) - must be in the 'head' portion of the page"),
                                                       '{{title}}' => __gettext("Page title"),
                                                       '{{menu}}' => __gettext("Menu"),
                                                       '{{topmenu}}' => __gettext("Status menu"),
                                                       '{{mainbody}}' => __gettext("Main body"),
                                                       '{{sidebar}}' => __gettext("Sidebar")
                                                       )
                                   );
    
    $welcome = __gettext("Welcome"); // gettext variable
       
    $template['pageshell'] = file_get_contents($CFG->templatesroot . "Default_Template/pageshell");

    $template['frontpage_loggedout'] = file_get_contents($CFG->templatesroot . "Default_Template/frontpage_loggedout");
    $template['frontpage_loggedin'] = file_get_contents($CFG->templatesroot . "Default_Template/frontpage_loggedin");
    
    // REMOVED stylesheet (was old version and should not have been here)
    // TODO: extract all Default_Template stuff from lib/templates.php

$template_definition[] = array(
                                    'id' => 'contentholder',
                                    'name' => __gettext("Content holder"),
                                    'description' => __gettext("Contains the main content for a page (as opposed to the sidebar or the title)."),
                                    'glossary' => array(
                                                            '{{title}}' => __gettext("The title"),
                                                            '{{submenu}}' => __gettext("The page submenu"),
                                                            '{{body}}' => __gettext("The body of the page")
                                                        )
                                    );    

    $template['contentholder'] = <<< END
    
    <div class="SectionContent">
    
    <h1>{{title}}</h1>
    {{submenu}}
    </div>
    {{body}}
    
END;

    $template_definition[] = array(
                                    'id' => 'ownerbox',
                                    'name' => __gettext("Owner box"),
                                    'description' => __gettext("A box containing a description of the owner of the current profile."),
                                    'glossary' => array(
                                                            '{{name}}' => __gettext("The user's name"),
                                                            '{{profileurl}}' => __gettext("The URL of the user's profile page, including terminating slash"),
                                                            '{{usericon}}' => __gettext("The user's icon, if it exists"),
                                                            '{{tagline}}' => __gettext("A short blurb about the user"),
                                                            '{{usermenu}}' => __gettext("Links to friend / unfriend a user"),
                                                            '{{lmshosts}}' => __gettext("Links to any lms hosts the user is attached to"),
                                                        )
                                    );

    $tags = __gettext("Tags");
    $resources = __gettext("Resources");
    $template['ownerbox'] = <<< END
    
    <div class="me">
        <div style="float: left; width: 70px"><a href="{{profileurl}}">{{usericon}}</a></div>
        <div style="margin-left: 75px; margin-top: 0px; padding-top: 0px; text-align: left" ><p>
            <span class="userdetails">{{name}}<br /><a href="{{profileurl}}rss/">RSS</a> | <a href="{{profileurl}}tags/">$tags</a> | <a href="{{profileurl}}newsclient/">$resources</a></span></p>
            <p>{{tagline}}</p>
            <p>{{lmshosts}}</p>
            <p style="margin-bottom: 3px" class="usermenu">{{usermenu}}</p>
        </div>
    </div>

END;
                                    
    $template_definition[] = array(
                                    'id' => 'infobox',
                                    'name' => __gettext("Information Box"),
                                    'description' => __gettext("A box containing a caption and some text, used extensively throughout the site. For example, the 'friends' box and most page bodies are info boxes. Of course, you can alter this template however you wish - it doesn't need to be an actual box."),
                                    'glossary' => array(
                                                            '{{name}}' => __gettext("The title"),
                                                            '{{contents}}' => __gettext("The contents of the box")
                                                        )
                                    );
    $template['infobox'] = <<< END

<table class="infobox" width="100%">
    <caption align="top">
        {{name}}
    </caption>
    <tr>
        <td>
{{contents}}
        </td>
    </tr>
</table><br />
END;

    $template_definition[] = array(
                                    'id' => 'messageshell',
                                    'name' => __gettext("System message shell"),
                                    'description' => __gettext("A list of system messages will be placed within the message shell."),
                                    'glossary' => array(
                                                            '{{messages}}' => __gettext("The messages")
                                                        )
                                    );

    $template['messageshell'] = <<< END
    
    <div id="js">{{messages}}</div><br />
    
END;

    $template_definition[] = array(
                                    'id' => 'messages',
                                    'name' => __gettext("Individual system messages"),
                                    'description' => __gettext("Each individual system message."),
                                    'glossary' => array(
                                                            '{{message}}' => __gettext("The system message")
                                                        )
                                    );

    $template['messages'] = <<< END

    <p>
        {{message}}
    </p>
    
END;
    

    $template_definition[] = array(
                                    'id' => 'menu',
                                    'name' => __gettext("Main menu shell"),
                                    'description' => __gettext("A list of main menu items will be placed within the menubar shell."),
                                    'glossary' => array(
                                                            '{{menuitems}}' => __gettext("The menu items")
                                                        )
                                    );

    $template['menu'] = <<< END
    
      {{menuitems}}
END;

    $template_definition[] = array(
                                    'id' => 'menuitem',
                                    'name' => __gettext("Individual main menu item"),
                                    'description' => __gettext("This is the template for each individual main menu item. A series of these is placed within the menubar shell template."),
                                    'glossary' => array(
                                                            '{{location}}' => __gettext("The URL of the menu item"),
                                                            '{{name}}' => __gettext("The menu item's name")
                                                        )
                                    );

    $template['menuitem'] = <<< END
    
    <li><a href="{{location}}">{{name}}</a></li>
    
END;

$template_definition[] = array(
                                    'id' => 'selectedmenuitem',
                                    'name' => __gettext("Selected individual main menu item"),
                                    'description' => __gettext("This is the template for an individual main menu item if it is selected."),
                                    'glossary' => array(
                                                            '{{location}}' => __gettext("The URL of the menu item"),
                                                            '{{name}}' => __gettext("The menu item's name")
                                                        )
                                    );

    $template['selectedmenuitem'] = <<< END
    
    <li><a class="current" href="{{location}}">{{name}}</a></li>
    
END;

    $template_definition[] = array(
                                    'id' => 'submenu',
                                    'name' => __gettext("Sub-menubar shell"),
                                    'description' => __gettext("A list of sub-menu items will be placed within the menubar shell."),
                                    'glossary' => array(
                                                            '{{submenuitems}}' => __gettext("The menu items")
                                                        )
                                    );

    $template['submenu'] = <<< END
    
        <h3>
            {{submenuitems}}
        </h3>
END;

    $template_definition[] = array(
                                    'id' => 'submenuitem',
                                    'name' => __gettext("Individual sub-menu item"),
                                    'description' => __gettext("This is the template for each individual sub-menu item. A series of these is placed within the sub-menubar shell template."),
                                    'glossary' => array(
                                                            '{{location}}' => __gettext("The URL of the menu item"),
                                                            '{{menu}}' => __gettext("The menu item's name")
                                                        )
                                    );

    $template['submenuitem'] = <<< END
    
    <a href="{{location}}">{{name}}</a>&nbsp;|
    
END;

    $template_definition[] = array(
                                    'id' => 'topmenu',
                                    'name' => __gettext("Status menubar shell"),
                                    'description' => __gettext("A list of statusbar menu items will be placed within the status menubar shell."),
                                    'glossary' => array(
                                                            '{{topmenuitems}}' => __gettext("The menu items")
                                                        )
                                    );

    $template['topmenu'] = <<< END
    
        <div id="StatusRight">
            {{topmenuitems}}
        </div>

END;

$template_definition[] = array(
                                    'id' => 'topmenuitem',
                                    'name' => __gettext("Individual statusbar menu item"),
                                    'description' => __gettext("This is the template for each individual statusbar menu item. A series of these is placed within the status menubar shell template."),
                                    'glossary' => array(
                                                            '{{location}}' => __gettext("The URL of the menu item"),
                                                            '{{menu}}' => __gettext("The menu item's name")
                                                        )
                                    );

    $template['topmenuitem'] = <<< END
    
    [<a href="{{location}}">{{name}}</a>]&nbsp;
    
END;

    $template_definition[] = array(
                                    'id' => 'databox',
                                    'name' => __gettext("Data input box (two columns)"),
                                    'description' => __gettext("This is mostly used whenever some input is taken from the user. For example, each of the fields in the profile edit screen is a data input box."),
                                    'glossary' => array(
                                                            '{{name}}' => __gettext("The name for the data we're inputting"),
                                                            '{{column1}}' => __gettext("The first item of data"),
                                                            '{{column2}}' => __gettext("The second item of data")
                                                        )
                                    );

    $template['databox'] = <<< END

<div class="infobox">
    <table width="95%" class="profiletable" align="center" style="margin-bottom: 3px">
    <tr>

        <td width="20%" class="fieldname" valign="top">
            <p><b>{{name}}</b></p>
        </td>
        <td width="50%" valign="top">
            <p>{{column1}}</p>
        </td>
        <td width="30%" valign="top">
            <p>{{column2}}</p>
        </td>
    </tr>
    </table>
</div>
        
END;

    $template_definition[] = array(
                                    'id' => 'databox1',
                                    'name' => __gettext("Data input box (one column)"),
                                    'description' => __gettext("A single-column version of the data box."),
                                    'glossary' => array(
                                                            '{{name}}' => __gettext("The name of the data we're inputting"),
                                                            '{{column1}}' => __gettext("The data itself")
                                                        )
                                    );

    $template['databox1'] = <<< END

<div class="infobox">
    <table width="95%" class="profiletable" align="center" style="margin-bottom: 3px">
    <tr>

        <td width="20%" class="fieldname" valign="top">
            <p><b>{{name}}</b></p>
        </td>
        <td width="80%" valign="top">
            <p>{{column1}}</p>
        </td>
    </tr>
    </table>
</div>
        
END;

    $template_definition[] = array(
                                    'id' => 'databoxvertical',
                                    'name' => __gettext("Data input box (vertical)"),
                                    'description' => __gettext("A slightly different version of the data box, used on this edit page amongst other places."),
                                    'glossary' => array(
                                                            '{{name}}' => __gettext("Name of the data we\'re inputting"),
                                                            '{{contents}}' => __gettext("The data itself")
                                                        )
                                    );

    $template['databoxvertical'] = <<< END
<div class="infobox">
    <table width="95%" class="fileTable" align="center" style="margin-bottom: 3px">
        <tr>
            <td class="fieldname">
                <p><b>{{name}}</b></p>
            </td>
        </tr>
        <tr>
            <td>
                <p>{{contents}}</p>
            </td>
        </tr>
    </table>
</div>
        
END;
return $run_result;
}

function templates_main () {

    global $PAGE;

    $run_result = '';

    /*
    *    Templates unit
    */

    // Load default values
        $function['init'][] = path . "units/templates/default_template.php";
        
    // Actions
        $function['templates:init'][] = path . "units/templates/template_actions.php";

    // Draw template (returns HTML as opposed to echoing it straight to the screen)
        $function['templates:draw'][] = path . "units/templates/template_draw.php";
        
    // Function to substitute variables within a template, used in templates:draw
        $function['templates:variables:substitute'][] = path . "units/templates/variables_substitute.php";

    // Function to draw the page, once supplied with a main body and title
        $function['templates:draw:page'][] = path . "units/templates/page_draw.php";
        
    // Function to display a list of templates
        $function['templates:view'][] = path . "units/templates/templates_view.php";
        $function['templates:preview'][] = path . "units/templates/templates_preview.php";
                
    // Function to display input fields for template editing
        $function['templates:edit'][] = path . "units/templates/templates_edit.php";
        
    // Function to allow the user to create a new template
        $function['templates:add'][] = path . "units/templates/templates_add.php";
        
    if ($context == "account") {
        $PAGE->menu_sub[] = array( 'name' => 'template:edit',
                                   'html' => templates_draw(array( 'context' => 'submenuitem',
                                                                   'name' => __gettext("Change theme"),
                                                                   'location' => url . '_templates/')));
    }

    return $run_result;
}

function templates_page_setup (){

    global $PAGE;
    global $CFG;

    if (!empty($PAGE->setupdone)) {
        return false; // don't run twice
    }

    $PAGE->setupdone = true; // leave your mark

    //
    // Populate $PAGE with links for non-module core code
    //

    if (isadmin()) {
        $PAGE->menu_top [] = array( 'name' => 'admin',
                                    //'html' => a_href("{$CFG->wwwroot}_admin/",
                                    //                "Administration"));
                                    'html' => "<li><a href=\"" . $CFG->wwwroot . "_admin/\">" . __gettext("Administration") . "</a></li>");
    }
    
    if (logged_on) {
        $PAGE->menu_top[] = array(
                                  'name' => 'userdetails',
                                  //'html' => a_href("{$CFG->wwwroot}_userdetails/",
                                  //                  "Account settings"));
                                  'html' => "<li><a href=\"" . $CFG->wwwroot . "_userdetails/\">" . __gettext("Account settings") . "</a></li>");
    
        $PAGE->menu_top[] = array(
                                  'name' => 'logoff',
                                  //'html' => a_href("{$CFG->wwwroot}login/logout.php",
                                  //                 "Log off"));
                                  'html' => "<li><a href=\"" . $CFG->wwwroot . "login/logout.php\">" . __gettext("Log off") . "</a></li>");
    };

    if (defined("context") && context == "account") {
        $PAGE->menu_sub[] = array(
                                  'name' => 'user:edit',
                                  'html' => a_href("{$CFG->wwwroot}_userdetails/",
                                                   __gettext("Edit user details")));
        $PAGE->menu_sub[] = array(