root/releases/0.9/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 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 . 'mod/template/')));
    }

    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 . "mod/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>");
    };


    //
    // Give a chance to all registered modules
    //
    if ($allmods = get_list_of_plugins('mod') ) {
        foreach ($allmods as $mod) {
            $mod_pagesetup = $mod . '_pagesetup';
            if (function_exists($mod_pagesetup)) {
                $mod_pagesetup();
            }
        }
    }
}

function templates_page_draw ($param) {
    // Draws the page, given a title and a main body (parameters[0] and [1]).
    $title = $param[0];
    $mainbody = $param[1];

    $run_result = '';

    global $messages;

    ////
    //// Prepare things for the module run
    //// populating $PAGE as required
    ////
    if (empty($PAGE->setupdone)) {
        templates_page_setup();
    }

    $messageshell = "";
    if (isset($messages) && sizeof($messages) > 0) {
        foreach($messages as $message) {
            $messageshell .=templates_draw(array(
                                                 'context' => 'messages',
                                                 'message' => $message
                                                 )
                                           );
        }
        $messageshell =templates_draw(array(
                                            'context' => 'messageshell',
                                            'messages' => $messageshell
                                            )
                                      );
    }

    // If $parameter[2] is set, we'll substitute it for the
    // sidebar
    if (isset($param[2])) {
        $sidebarhtml = $param[2];
    } else {
        $sidebarhtml = run("display:sidebar");
    }    
    
    $run_result .=  templates_draw(array(
                            'context'      => 'pageshell',
                            'title'        => htmlspecialchars($title, ENT_COMPAT, 'utf-8'),
                            'menu'         => displaymenu(),
                            'submenu'      => displaymenu_sub(),
                            'top'          => displaymenu_top(),
                            'sidebar'      => $sidebarhtml,
                            'mainbody'     => $mainbody,
                            'messageshell' => $messageshell
                            ));
            
    return $run_result;
}

function templates_actions() {

    global $CFG,$USER,$db;

    // Actions

    global $template, $messages, $CFG;
    
    $action = optional_param('action');
    if (!logged_on) {
        return false;
    }

    $run_result = '';
    
    switch ($action) {
        case "templates:select":
            $id = optional_param('selected_template');
            if (substr($id, 0, 2) == "db") {
                $template_id = (int) substr($id,2);
                $exists = record_exists_sql('SELECT ident, shortname FROM '.$CFG->prefix.'templates WHERE ident = '.$template_id.' AND (owner = '.$USER->ident ." OR public='yes')");
            } else {
                $exists = file_exists($CFG->templatesroot . templates_shortname_to_file($id));
            }
            if ($exists) {
                $affected_areas = optional_param('affected_areas',0,PARAM_INT);
                if(is_array($affected_areas)) {
                    foreach($affected_areas as $index => $value) {
                        //TODO - check security
                        set_field('users','template_name',$id,'ident',$value);
                    }
                    $messages[] = __gettext("The templates have been changed according to your choices.");
                } else {
                    $messages[] = __gettext("No changes made as no area of change was selected!");
                }
            }
            break;
            

        case "templates:save":
            $templatearray = optional_param('template','','');
            $id = optional_param('save_template_id',0,PARAM_INT);
            $templatetitle = trim(optional_param('templatetitle'));
            if (!empty($templatearray) && !empty($id) && !empty($templatetitle)) {
                unset($_SESSION['template_element_cache'][$id]);
                $exists = record_exists('templates','ident',$id,'owner',$USER->ident);
                if ($exists) {
                    set_field('templates','name',$templatetitle,'ident',$id);
                    delete_records('template_elements','template_id',$id);
                    foreach($templatearray as $name => $content) {
                        //TODO Fix this with PARAM_CLEANHTML or similar
                        $cleanname = trim($name);
                        $cleancontent = trim($content);
                        if ($content != "" && $content != $template[$name]) {
                            $te = new StdClass;
                            $te->name = $cleanname;
                            $te->content = $cleancontent;
                            $te->template_id = $id;
                            insert_record('template_elements',$te);
                        }
                    }
                    $messages[] = __gettext("Your template has been updated.");
                }
            }
            break;
            
            
        case "deletetemplate":
            $id = optional_param('delete_template_id',0,PARAM_INT);
            unset($_SESSION['template_element_cache'][$id]);
            $exists = record_exists('templates','ident',$id,'owner',$USER->ident);
            if ($exists) {
                //$db->execute('UPDATE '.$CFG->prefix.'users SET template_id = -1 WHERE template_id = '.$id);
                set_field('users', 'template_id', -1, 'template_id', $id);
                delete_records('template_elements','template_id',$id);
                delete_records('templates','ident',$id);
                $messages[] = __gettext("Your template was deleted.");
            }
            break;
            
            
        case "templates:create":
            $based_on = optional_param('template_based_on');
            $name = trim(optional_param('new_template_name'));
            if (empty($CFG->disable_usertemplates) && !empty($name)) {
                $t = new StdClass;
                $t->name = $name;
                $t->public = 'no';
                $t->owner = $USER->ident;
                $new_template_id = insert_record('templates',$t);
                $t->shortname = 'db'.$new_template_id;
                $t->ident = $new_template_id;
                update_record('templates',$t);
                foreach(array('pageshell','css') as $template_element) {
                    if ($result = get_template_element($based_on, $template_element)) {
                        $element = new stdClass;
                        $element->template_id = $new_template_id;
                        $element->content = $result->content;
                        $element->name = $template_element;
                        insert_record('template_elements',$element);
                    }
                }
            }
            break;
    }
    return $run_result;
}
    
/// NOTE: this function takes a named array as single parameter
function templates_draw ($parameter) {

    // Draw a page element using a specified template (or, if the template is -1, the default)
    // $parameter['template'] = the template ID, $parameter['element'] = the template element,
    // all other $parameter[n] = template elements

    // Initialise global template variable, which contains the Default_Template
        global $template;
        
    // Initialise global template ID variable, which contains the template ID we're using
        global $template_name;
        global $page_owner;
        global $CFG;
        
        global $page_template_cache;
        
        $run_result = '';

        if ($parameter['context'] === 'topmenuitem') {
            // error_log("templates_draw pcontext " . print_r($parameter,1));
        }
    // Get template details
        if (!isset($template_name)) {
            if (!isset($page_owner) || $page_owner == -1) {
                $template_name = "Default_Template";
            } else {
                if (!$template_name = user_info('template_name',$page_owner)) {
                    $template_name = "Default_Template";
                }
            }
        }
        
    // Template ID override
        $t = optional_param('template_preview');
        if (!empty($t)) {
            $template_name = $t;
        }

        // TODO: Load templates on demand with backward compatibility
        templates_load_context($parameter['context']);

    // Grab the template content
        if ($template_name == "Default_Template" || ($parameter['context'] != "css" && $parameter['context'] != "pageshell")) {
            $template_element = $template[$parameter['context']];
        } else {
            if (!isset($page_template_cache[$parameter['context']])) {
                if ($result = get_template_element($template_name, $parameter['context'])) {
                    $page_template_cache[$parameter['context']] = $result;
                } else {
                    $page_template_cache[$parameter['context']] = $template[$parameter['context']];
                }
            } else {
                $result = $page_template_cache[$parameter['context']];
            }
            if (!empty($result)) {
                $template_element = $result->content;
            } else {
                $template_element = $template[$parameter['context']];
            }
        }
        
        if (!empty($CFG->templates->variables_substitute) && !empty($CFG->templates->variables_substitute[$parameter['context']])) {
            if (is_array($CFG->templates->variables_substitute[$parameter['context']])) {
                foreach ($CFG->templates->variables_substitute[$parameter['context']] as $sub_function) {
                    $template_element .= $sub_function($vars);
                }
            } elseif (is_callable($CFG->templates->variables_substitute[$parameter['context']])) {
                $template_element .= $CFG->templates->variables_substitute[$parameter['context']]($vars);
            }
        }

        if ($parameter['context'] === 'topmenuitem') {
            // error_log("templates_draw pcontext " . print_r($template_element));
        }

    // Substitute elements

        $functionbody = "
            \$passed = array(".var_export($parameter,true).",\$matches[1], '" . $template_name . "');
            return templates_variables_substitute(\$passed);
        ";
        
        // $template_element = templates_variables_substitute(array($parameter,$template_element));
        $body = preg_replace_callback("/\{\{([A-Za-z_0-9: ]*)\}\}/i",create_function('$matches',$functionbody),$template_element);
        
        $run_result = $body;
        return $run_result;
}

/***
 *** Draws a form to create a new template based on one of the existing choices.
 ***/
function templates_add () {
    global $USER;


    // Create a new template
        $header = __gettext("Create theme"); // gettext variable
        $desc = __gettext("Here you can create your own themes based on one of the existing public themes. Just select which public theme you would like to alter and then create your own. You will now have edit privilages."); // gettext variable

        $panel = <<< END
        
        <h2>$header</h2>
        <p>$desc</p>
        <form action="index.php" method="post">
        
END;

        $panel .= <<< END
        
END;

        $panel .=templates_draw(array(
                                                'context' => 'databox1',
                                                'name' => __gettext("Theme name"),
                                                'column1' => display_input_field(array("new_template_name","","text"))
                                            )
                                            );
        
        $default = __gettext("Default Template"); // gettext variable
        $templates_list = templates_list();
        $column1 = "<select name=\"template_based_on\">";
        foreach($templates_list as $template) {
            $name = __gettext($template['name']);
            $column1 .= "<option value=\"".$template['name']."\"";
            if ($template['name'] == "Default Template") {
                $column1 .= " selected=\"selected\"";
            }
            $column1 .= ">" . $name . "</option>";
        }
        
        $column1 .= <<< END
            </select>
END;
                        
        $panel .=templates_draw(array(
                                                'context' => 'databox1',
                                                'name' => __gettext("Based on"),
                                                'column1' => $column1
                                            )
                                            );
            
        $buttonValue = __gettext("Create Theme"); // gettext variable
        $panel .= <<< END
            
            <p>
                <input type="hidden" name="action" value="templates:create" />
                <input type="submit" value="$buttonValue" />
            </p>
        
        </form>
        
END;

        return $panel;
}

function templates_edit () {


    global $template;
    global $template_definition;
    global $USER;

    if (!isset($parameter)) {
    // Get template details
        if (!$template_name = user_info('template_name',$USER->ident)) {
            $template_name = "Default_Template";
        }
    } else {
        if (!is_array($parameter)) {
            $template_name = trim($parameter);
        } else {
            $template_name = "Default_Template";
        }
    }

    // Grab title, see if we can edit the template
        $editable = 0;
        if ($template_name == "Default_Template") {
            $templatetitle = __gettext("Default Theme");
        } else {
            if ($templatestuff = get_record('templates','shortname',$template_name)) {
                $templatetitle = $templatestuff->name;
                if ($templatestuff->owner == $USER->ident) {
                    $editable = 1;
                }
                if (($templatestuff->owner != $USER->ident) && ($templatestuff->public != 'yes')) {
                    $template_name = 'Default_Template';