Adding oauth body code (from Chuck), implemented outcome services (only replaceResult...

[moodle.git] / mod / lti / view.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 contains all necessary code to view a basiclti activity instance\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
require_once('../../config.php');\r
require_once($CFG->dirroot.'/mod/lti/lib.php');\r
require_once($CFG->dirroot.'/mod/lti/locallib.php');\r
\r
$id = optional_param('id', 0, PARAM_INT); // Course Module ID, or\r
$a  = optional_param('a', 0, PARAM_INT);  // lti ID\r
\r
if ($id) {\r
    if (! $cm = get_coursemodule_from_id("lti", $id)) {\r
        throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course Module ID was incorrect');\r
    }\r
\r
    if (! $course = $DB->get_record("course", array("id" => $cm->course))) {\r
        throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course is misconfigured');\r
    }\r
\r
    if (! $basiclti = $DB->get_record("lti", array("id" => $cm->instance))) {\r
        throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course module is incorrect');\r
    }\r
\r
} else {\r
    if (! $basiclti = $DB->get_record("lti", array("id" => $a))) {\r
        throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course module is incorrect');\r
    }\r
    if (! $course = $DB->get_record("course", array("id" => $basiclti->course))) {\r
        throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course is misconfigured');\r
    }\r
    if (! $cm = get_coursemodule_from_instance("lti", $basiclti->id, $course->id)) {\r
        throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course Module ID was incorrect');\r
    }\r
}\r
\r
$tool = lti_get_tool_by_url_match($basiclti->toolurl);\r
if($tool){\r
    $toolconfig = lti_get_type_config($tool->id);\r
} else {\r
    $toolconfig = array('launchcontainer' => LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS);\r
}\r
\r
$PAGE->set_cm($cm, $course); // set's up global $COURSE\r
$context = get_context_instance(CONTEXT_MODULE, $cm->id);\r
$PAGE->set_context($context);\r
\r
$url = new moodle_url('/mod/lti/view.php', array('id'=>$cm->id));\r
$PAGE->set_url($url);\r
\r
$launchcontainer = $basiclti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT ? \r
                        $toolconfig['launchcontainer'] :\r
                        $basiclti->launchcontainer;\r
\r
if($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS){\r
    $PAGE->set_pagelayout('frametop'); //Most frametops don't include footer, and pre-post blocks\r
    $PAGE->blocks->show_only_fake_blocks(); //Disable blocks for layouts which do include pre-post blocks\r
} else {\r
    $PAGE->set_pagelayout('incourse');\r
}\r
\r
require_login($course);\r
\r
add_to_log($course->id, "lti", "view", "view.php?id=$cm->id", "$basiclti->id");\r
\r
$pagetitle = strip_tags($course->shortname.': '.format_string($basiclti->name));\r
$PAGE->set_title($pagetitle);\r
$PAGE->set_heading($course->fullname);\r
\r
/// Print the page header\r
echo $OUTPUT->header();\r
\r
if($basiclti->showtitle) {\r
    /// Print the main part of the page\r
    echo $OUTPUT->heading(format_string($basiclti->name));\r
}\r
\r
if($basiclti->showdescription && $basiclti->intro){\r
    echo $OUTPUT->box($basiclti->intro, 'generalbox description', 'intro');\r
}\r
\r
if ($basiclti->instructorchoiceacceptgrades == 1) {\r
    echo '<div class="reportlink">'.submittedlink($cm).'</div>';\r
}\r
\r
if ( $launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW ) {\r
    echo "<script language=\"javascript\">//<![CDATA[\n";\r
    echo "window.open('launch.php?id=".$cm->id."','lti');";\r
    echo "//]]\n";\r
    echo "</script>\n";\r
    echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";\r
} else {\r
    // Request the launch content with an object tag\r
    echo '<object id="contentframe" height="600px" width="100%" type="text/html" data="launch.php?id='.$cm->id.'&amp;withobject=true"></object>';\r
    \r
    //Output script to make the object tag be as large as possible\r
    $resize = <<<'SCRIPT'\r
        <script type='text/javascript'>\r
        //<![CDATA[\r
            (function(){\r
                //Take scrollbars off the outer document to prevent double scroll bar effect\r
                document.body.style.overflow = 'hidden';\r
\r
                var dom = YAHOO.util.Dom;\r
                var frame = document.getElementById('contentframe');\r
\r
                var lastHeight;\r
\r
                var resize = function(){\r
                    var viewportHeight = dom.getViewportHeight();\r
\r
                    if(lastHeight !== Math.min(dom.getDocumentHeight(), viewportHeight)){\r
                        frame.style.height = viewportHeight - dom.getY(frame) + 'px';\r
\r
                        lastHeight = Math.min(dom.getDocumentHeight(), dom.getViewportHeight());\r
                    }\r
                };\r
\r
                resize();\r
\r
                setInterval(resize, 250);\r
            })();\r
        //]]\r
        </script>\r
SCRIPT;\r
    \r
    echo $resize;\r
}\r
\r
\r
/// Finish the page\r
echo $OUTPUT->footer();\r