Renaming global functions to include lti prefix

[moodle.git] / mod / lti / mod_form.php

<?php\r
// This file is part of BasicLTI4Moodle\r
//\r
// BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)\r
// consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web\r
// based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI\r
// specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS\r
// are already supporting or going to support BasicLTI. This project Implements the consumer\r
// for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.\r
// BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem\r
// at the GESSI research group at UPC.\r
// SimpleLTI consumer for Moodle is an implementation of the early specification of LTI\r
// by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a\r
// Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.\r
//\r
// BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis\r
// of the Universitat Politecnica de Catalunya http://www.upc.edu\r
// Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu\r
//\r
// Moodle is free software: you can redistribute it and/or modify\r
// it under the terms of the GNU General Public License as published by\r
// the Free Software Foundation, either version 3 of the License, or\r
// (at your option) any later version.\r
//\r
// Moodle is distributed in the hope that it will be useful,\r
// but WITHOUT ANY WARRANTY; without even the implied warranty of\r
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
// GNU General Public License for more details.\r
//\r
// You should have received a copy of the GNU General Public License\r
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\r
\r
/**\r
 * This file defines the main basiclti configuration form\r
 *\r
 * @package lti\r
 * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis\r
 *  marc.alier@upc.edu\r
 * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu\r
 *\r
 * @author Marc Alier\r
 * @author Jordi Piguillem\r
 * @author Nikolas Galanis\r
 *\r
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\r
 */\r
\r
defined('MOODLE_INTERNAL') || die;\r
\r
require_once($CFG->dirroot.'/course/moodleform_mod.php');\r
require_once($CFG->dirroot.'/mod/lti/locallib.php');\r
\r
class mod_lti_mod_form extends moodleform_mod {\r
\r
    function definition() {\r
        global $DB;\r
\r
        $typename = optional_param('type', false, PARAM_ALPHA);\r
\r
        if (empty($typename)) {\r
            //Updating instance\r
            if (!empty($this->_instance)) {\r
                $basiclti = $DB->get_record('lti', array('id' => $this->_instance));\r
                $this->typeid = $basiclti->typeid;\r
\r
                $typeconfig = lti_get_config($basiclti);\r
                $this->typeconfig = $typeconfig;\r
\r
            } else { // New not pre-configured instance\r
                $this->typeid = 0;\r
            }\r
        } else {\r
            // New pre-configured instance\r
            $basicltitype = $DB->get_record('lti_types', array('rawname' => $typename));\r
            $this->typeid = $basicltitype->id;\r
\r
            $typeconfig = lti_get_type_config($this->typeid);\r
            $this->typeconfig = $typeconfig;\r
        }\r
\r
        $mform =& $this->_form;\r
//-------------------------------------------------------------------------------\r
    /// Adding the "general" fieldset, where all the common settings are shown\r
        $mform->addElement('header', 'general', get_string('general', 'form'));\r
    /// Adding the standard "name" field\r
        $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size'=>'64'));\r
        $mform->setType('name', PARAM_TEXT);\r
        $mform->addRule('name', null, 'required', null, 'client');\r
    /// Adding the optional "intro" and "introformat" pair of fields\r
        $this->add_intro_editor(false, get_string('basicltiintro', 'lti'));\r
        $mform->setAdvanced('introeditor');\r
\r
        $mform->addElement('checkbox', 'showtitle', '&nbsp;', ' ' . get_string('display_name', 'lti'));\r
        $mform->setAdvanced('showtitle');\r
        \r
        $mform->addElement('checkbox', 'showdescription', '&nbsp;', ' ' . get_string('display_description', 'lti'));\r
        $mform->setAdvanced('showdescription');\r
        \r
        //Tool settings\r
        $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'), lti_get_types_for_add_instance());\r
        //$mform->setDefault('typeid', '0');\r
        \r
        $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size'=>'64'));\r
        $mform->setType('toolurl', PARAM_TEXT);\r
        \r
        $launchoptions=array();\r
        $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');\r
        $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');\r
        $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');\r
        $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');\r
\r
        $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);\r
        $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);\r
        \r
        $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));\r
        $mform->setType('resourcekey', PARAM_TEXT);\r
        $mform->setAdvanced('resourcekey');\r
\r
        $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));\r
        $mform->setType('password', PARAM_TEXT);\r
        $mform->setAdvanced('password');\r
        \r
        $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows'=>4, 'cols'=>60));\r
        $mform->setType('instructorcustomparameters', PARAM_TEXT);\r
        $mform->setAdvanced('instructorcustomparameters');\r
        \r
//-------------------------------------------------------------------------------\r
        //$mform->addElement('hidden', 'typeid', $this->typeid);\r
        //$mform->addElement('hidden', 'toolurl', $this->typeconfig['toolurl']);\r
        $mform->addElement('hidden', 'type', $typename);\r
\r
//-------------------------------------------------------------------------------\r
        // Add privacy preferences fieldset where users choose whether to send their data\r
        $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));\r
\r
        $mform->addElement('checkbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));\r
        $mform->setDefault('instructorchoicesendname', '1');\r
        \r
        $mform->addElement('checkbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));\r
        $mform->setDefault('instructorchoicesendemailaddr', '1');\r
        \r
        $mform->addElement('checkbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));\r
        $mform->setDefault('instructorchoiceacceptgrades', '1');\r
        \r
        $mform->addElement('checkbox', 'instructorchoiceallowroster', '&nbsp;', ' ' . get_string('share_roster', 'lti'));\r
        $mform->setDefault('instructorchoiceallowroster', '1');\r
\r
//-------------------------------------------------------------------------------\r
\r
/*        $debugoptions=array();\r
        $debugoptions[0] = get_string('debuglaunchoff', 'lti');\r
        $debugoptions[1] = get_string('debuglaunchon', 'lti');\r
\r
        $mform->addElement('select', 'debuglaunch', get_string('debuglaunch', 'lti'), $debugoptions);\r
\r
        if (isset($this->typeconfig['debuglaunch'])) {\r
            if ($this->typeconfig['debuglaunch'] == 0) {\r
                $mform->setDefault('debuglaunch', '0');\r
            } else if ($this->typeconfig['debuglaunch'] == 1) {\r
                $mform->setDefault('debuglaunch', '1');\r
            }\r
        }\r
*/\r
\r
//-------------------------------------------------------------------------------\r
        // add standard elements, common to all modules\r
        $this->standard_coursemodule_elements();\r
        \r
        $mform->setAdvanced('cmidnumber');\r
//-------------------------------------------------------------------------------\r
        // add standard buttons, common to all modules\r
        $this->add_action_buttons();\r
    }\r
\r
    /**\r
     * Make fields editable or non-editable depending on the administrator choices\r
     * @see moodleform_mod::definition_after_data()\r
     */\r
    function definition_after_data() {\r
        parent::definition_after_data();\r
       /* $mform     =& $this->_form;\r
        $typeid      =& $mform->getElement('typeid');\r
        $typeidvalue = $mform->getElementValue('typeid');\r
\r
        //Depending on the selection of the administrator\r
        //we don't want to have these appear as possible selections in the form but\r
        //we want the form to display them if they are set.\r
        if (!empty($typeidvalue)) {\r
            $typeconfig = lti_get_type_config($typeidvalue);\r
\r
            if ($typeconfig["sendname"] != 2) {\r
                $field =& $mform->getElement('instructorchoicesendname');\r
                $mform->setDefault('instructorchoicesendname', $typeconfig["sendname"]);\r
                $field->freeze();\r
                $field->setPersistantFreeze(true);\r
            }\r
            if ($typeconfig["sendemailaddr"] != 2) {\r
                $field =& $mform->getElement('instructorchoicesendemailaddr');\r
                $mform->setDefault('instructorchoicesendemailaddr', $typeconfig["sendemailaddr"]);\r
                $field->freeze();\r
                $field->setPersistantFreeze(true);\r
            }\r
            if ($typeconfig["acceptgrades"] != 2) {\r
                $field =& $mform->getElement('instructorchoiceacceptgrades');\r
                $mform->setDefault('instructorchoiceacceptgrades', $typeconfig["acceptgrades"]);\r
                $field->freeze();\r
                $field->setPersistantFreeze(true);\r
            }\r
            if ($typeconfig["allowroster"] != 2) {\r
                $field =& $mform->getElement('instructorchoiceallowroster');\r
                $mform->setDefault('instructorchoiceallowroster', $typeconfig["allowroster"]);\r
                $field->freeze();\r
                $field->setPersistantFreeze(true);\r
            }\r
            if ($typeconfig["allowsetting"] != 2) {\r
                $field =& $mform->getElement('instructorchoiceallowsetting');\r
                $mform->setDefault('instructorchoiceallowsetting', $typeconfig["allowsetting"]);\r
                $field->freeze();\r
                $field->setPersistantFreeze(true);\r
            }\r
        }*/\r
    }\r
\r
    /**\r
     * Function overwritten to change default values using\r
     * global configuration\r
     *\r
     * @param array $default_values passed by reference\r
     */\r
    function data_preprocessing(&$default_values) {\r
/*        global $CFG;\r
        $default_values['typeid'] = $this->typeid;\r
\r
        if (!isset($default_values['toolurl'])) {\r
            if (isset($this->typeconfig['toolurl'])) {\r
                $default_values['toolurl'] = $this->typeconfig['toolurl'];\r
            } else if (isset($CFG->lti_toolurl)) {\r
                $default_values['toolurl'] = $CFG->lti_toolurl;\r
            }\r
        }\r
\r
        if (!isset($default_values['resourcekey'])) {\r
            if (isset($this->typeconfig['resourcekey'])) {\r
                $default_values['resourcekey'] = $this->typeconfig['resourcekey'];\r
            } else if (isset($CFG->lti_resourcekey)) {\r
                $default_values['resourcekey'] = $CFG->lti_resourcekey;\r
            }\r
        }\r
\r
        if (!isset($default_values['password'])) {\r
            if (isset($this->typeconfig['password'])) {\r
                $default_values['password'] = $this->typeconfig['password'];\r
            } else if (isset($CFG->lti_password)) {\r
                $default_values['password'] = $CFG->lti_password;\r
            }\r
        }\r
\r
        if (!isset($default_values['preferheight'])) {\r
            if (isset($this->typeconfig['preferheight'])) {\r
                $default_values['preferheight'] = $this->typeconfig['preferheight'];\r
            } else if (isset($CFG->lti_preferheight)) {\r
                $default_values['preferheight'] = $CFG->lti_preferheight;\r
            }\r
        }\r
\r
        if (!isset($default_values['sendname'])) {\r
            if (isset($this->typeconfig['sendname'])) {\r
                $default_values['sendname'] = $this->typeconfig['sendname'];\r
            } else if (isset($CFG->lti_sendname)) {\r
                $default_values['sendname'] = $CFG->lti_sendname;\r
            }\r
        }\r
\r
        if (!isset($default_values['instructorchoicesendname'])) {\r
            if (isset($this->typeconfig['instructorchoicesendname'])) {\r
                $default_values['instructorchoicesendname'] = $this->typeconfig['instructorchoicesendname'];\r
            } else {\r
                if ($this->typeconfig['sendname'] == 2) {\r
                    $default_values['instructorchoicesendname'] = $CFG->lti_instructorchoicesendname;\r
                } else {\r
                      $default_values['instructorchoicesendname'] = $this->typeconfig['sendname'];\r
                }\r
            }\r
        }\r
\r
        if (!isset($default_values['sendemailaddr'])) {\r
            if (isset($this->typeconfig['sendemailaddr'])) {\r
                $default_values['sendemailaddr'] = $this->typeconfig['sendemailaddr'];\r
            } else if (isset($CFG->lti_sendemailaddr)) {\r
                $default_values['sendemailaddr'] = $CFG->lti_sendemailaddr;\r
            }\r
        }\r
\r
        if (!isset($default_values['instructorchoicesendemailaddr'])) {\r
            if (isset($this->typeconfig['instructorchoicesendemailaddr'])) {\r
                $default_values['instructorchoicesendemailaddr'] = $this->typeconfig['instructorchoicesendemailaddr'];\r
            } else {\r
                if ($this->typeconfig['sendemailaddr'] == 2) {\r
                    $default_values['instructorchoicesendemailaddr'] = $CFG->lti_instructorchoicesendemailaddr;\r
                } else {\r
                      $default_values['instructorchoicesendemailaddr'] = $this->typeconfig['sendemailaddr'];\r
                }\r
            }\r
        }\r
\r
        if (!isset($default_values['acceptgrades'])) {\r
            if (isset($this->typeconfig['acceptgrades'])) {\r
                $default_values['acceptgrades'] = $this->typeconfig['acceptgrades'];\r
            } else if (isset($CFG->lti_acceptgrades)) {\r
                $default_values['acceptgrades'] = $CFG->lti_acceptgrades;\r
            }\r
        }\r
\r
        if (!isset($default_values['instructorchoiceacceptgrades'])) {\r
            if (isset($this->typeconfig['instructorchoiceacceptgrades'])) {\r
                $default_values['instructorchoiceacceptgrades'] = $this->typeconfig['instructorchoiceacceptgrades'];\r
            } else {\r
                if ($this->typeconfig['acceptgrades'] == 2) {\r
                    $default_values['instructorchoiceacceptgrades'] = $CFG->lti_instructorchoiceacceptgrades;\r
                } else {\r
                      $default_values['instructorchoiceacceptgrades'] = $this->typeconfig['acceptgrades'];\r
                }\r
            }\r
        }\r
\r
        if (!isset($default_values['allowroster'])) {\r
            if (isset($this->typeconfig['allowroster'])) {\r
                $default_values['allowroster'] = $this->typeconfig['allowroster'];\r
            } else if (isset($CFG->lti_allowroster)) {\r
                $default_values['allowroster'] = $CFG->lti_allowroster;\r
            }\r
        }\r
\r
        if (!isset($default_values['instructorchoiceallowroster'])) {\r
            if (isset($this->typeconfig['instructorchoiceallowroster'])) {\r
                $default_values['instructorchoiceallowroster'] = $this->typeconfig['instructorchoiceallowroster'];\r
            } else {\r
                if ($this->typeconfig['allowroster'] == 2) {\r
                    $default_values['instructorchoiceallowroster'] = $CFG->lti_instructorchoiceallowroster;\r
                } else {\r
                      $default_values['instructorchoiceallowroster'] = $this->typeconfig['allowroster'];\r
                }\r
            }\r
        }\r
\r
        if (!isset($default_values['allowsetting'])) {\r
            if (isset($this->typeconfig['allowsetting'])) {\r
                $default_values['allowsetting'] = $this->typeconfig['allowsetting'];\r
            } else if (isset($CFG->lti_allowsetting)) {\r
                $default_values['allowsetting'] = $CFG->lti_allowsetting;\r
            }\r
        }\r
\r
        if (!isset($default_values['instructorchoiceallowsetting'])) {\r
            if (isset($this->typeconfig['instructorchoiceallowsetting'])) {\r
                $default_values['instructorchoiceallowsetting'] = $this->typeconfig['instructorchoiceallowsetting'];\r
            } else {\r
                if ($this->typeconfig['allowsetting'] == 2) {\r
                    $default_values['instructorchoiceallowsetting'] = $CFG->lti_instructorchoiceallowsetting;\r
                } else {\r
                      $default_values['instructorchoiceallowsetting'] = $this->typeconfig['allowsetting'];\r
                }\r
            }\r
        }\r
\r
        if (!isset($default_values['customparameters'])) {\r
            if (isset($this->typeconfig['customparameters'])) {\r
                $default_values['customparameters'] = $this->typeconfig['customparameters'];\r
            } else if (isset($CFG->lti_customparameters)) {\r
                $default_values['customparameters'] = $CFG->lti_customparameters;\r
            }\r
        }\r
\r
        if (!isset($default_values['allowinstructorcustom'])) {\r
            if (isset($this->typeconfig['allowinstructorcustom'])) {\r
                $default_values['allowinstructorcustom'] = $this->typeconfig['allowinstructorcustom'];\r
            } else if (isset($CFG->lti_allowinstructorcustom)) {\r
                $default_values['allowinstructorcustom'] = $CFG->lti_allowinstructorcustom;\r
            }\r
        }\r
\r
        if (!isset($default_values['organizationid'])) {\r
            if (isset($this->typeconfig['organizationid'])) {\r
                $default_values['organizationid'] = $this->typeconfig['organizationid'];\r
            } else if (isset($CFG->lti_organizationid)) {\r
                $default_values['organizationid'] = $CFG->lti_organizationid;\r
            }\r
        }\r
\r
        if (!isset($default_values['organizationurl'])) {\r
            if (isset($this->typeconfig['organizationurl'])) {\r
                $default_values['organizationurl'] = $this->typeconfig['organizationurl'];\r
            } else if (isset($CFG->lti_organizationurl)) {\r
                $default_values['organizationurl'] = $CFG->lti_organizationurl;\r
            }\r
        }\r
\r
        if (!isset($default_values['organizationdescr'])) {\r
            if (isset($this->typeconfig['organizationdescr'])) {\r
                $default_values['organizationdescr'] = $this->typeconfig['organizationdescr'];\r
            } else if (isset($CFG->lti_organizationdescr)) {\r
                $default_values['organizationdescr'] = $CFG->lti_organizationdescr;\r
            }\r
        }\r
\r
        if (!isset($default_values['launchinpopup'])) {\r
            if (isset($this->typeconfig['launchinpopup'])) {\r
                $default_values['launchinpopup'] = $this->typeconfig['launchinpopup'];\r
            } else if (isset($CFG->lti_launchinpopup)) {\r
                $default_values['launchinpopup'] = $CFG->lti_launchinpopup;\r
            }\r
        }\r
*/\r
    }\r
}\r
\r