Skip to content

Commit

Permalink
Merge branch 'wip-MDL-39962-master' of git://github.com/abgreeve/moodle
Browse files Browse the repository at this point in the history
  • Loading branch information
marinaglancy committed Sep 24, 2013
2 parents 40643dc + b97d94f commit 72f6cb3
Show file tree
Hide file tree
Showing 9 changed files with 321 additions and 78 deletions.
95 changes: 95 additions & 0 deletions mod/lti/classes/event/unknown_service_api_called.php
@@ -0,0 +1,95 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* This file contains an event for an unknown service API call.
*
* @package mod_lti
* @copyright 2013 Adrian Greeve <adrian@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace mod_lti\event;
defined('MOODLE_INTERNAL') || die();

/**
* Event for when something happens with an unknown lti service API call.
*
* @package mod_lti
* @copyright 2013 Adrian Greeve <adrian@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class unknown_service_api_called extends \core\event\base {

/** Old data to be used for the legacy event. */
protected $legacydata;

/**
* Set method for legacy data.
*
* @param stdClass $data legacy event data.
*/
public function set_legacy_data($data) {
$this->legacydata = $data;
}

/**
* Init method.
*/
protected function init() {
$this->data['objecttable'] = 'lti';
$this->data['crud'] = 'r';
$this->data['level'] = self::LEVEL_OTHER;
$this->data['context'] = \context_system::instance();
}

/**
* Returns localised description of what happened.
*
* @return string
*/
public function get_description() {
return 'An unknown call to a service api was made.';
}

/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('ltiunknownserviceapicall', 'mod_lti');
}

/**
* Does this event replace a legacy event?
*
* @return null|string legacy event name
*/
public static function get_legacy_eventname() {
return 'lti_unknown_service_api_call';
}

/**
* Legacy event data if get_legacy_eventname() is not empty.
*
* @return mixed
*/
protected function get_legacy_eventdata() {
return $this->legacydata;
}

}
1 change: 1 addition & 0 deletions mod/lti/lang/en/lti.php
Expand Up @@ -237,6 +237,7 @@
</p>';
$string['lti_tool_request_added'] = 'Tool configuration request successfully submitted. You may need to contact an administrator to complete the tool configuration.';
$string['lti_tool_request_existing'] = 'A tool configuration for the tool domain has already been submitted.';
$string['ltiunknownserviceapicall'] = 'LTI unknown service API call.';
$string['main_admin'] = 'General help';
$string['main_admin_help'] = 'External tools allow Moodle users to seamlessly interact with learning resources hosted remotely. Through a special
launch protocol, the remote tool will have access to some general information about the launching user. For example,
Expand Down
18 changes: 11 additions & 7 deletions mod/lti/service.php
Expand Up @@ -145,19 +145,23 @@
//Fire an event if we get a web service request which we don't support directly.
//This will allow others to extend the LTI services, which I expect to be a common
//use case, at least until the spec matures.
$data = new stdClass();
$data->body = $rawbody;
$data->xml = $xml;
$data->messagetype = $messagetype;
$data->consumerkey = $consumerkey;
$data->sharedsecret = $sharedsecret;
// Please note that you will have to change $eventdata['other']['body'] into an xml
// element in an event observer as done above.
$eventdata = array();
$eventdata['other'] = array();
$eventdata['other']['body'] = $rawbody;
$eventdata['other']['messagetype'] = $messagetype;
$eventdata['other']['consumerkey'] = $consumerkey;
$eventdata['other']['sharedsecret'] = $sharedsecret;

//If an event handler handles the web service, it should set this global to true
//So this code knows whether to send an "operation not supported" or not.
global $lti_web_service_handled;
$lti_web_service_handled = false;

events_trigger('lti_unknown_service_api_call', $data);
$event = \mod_lti\event\unknown_service_api_called::create($eventdata);
$event->set_legacy_data($eventdata);
$event->trigger();

if (!$lti_web_service_handled) {
$responsexml = lti_get_response_xml(
Expand Down
82 changes: 82 additions & 0 deletions mod/workshop/allocation/scheduled/classes/observer.php
@@ -0,0 +1,82 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* Event observers for workshopallocation_scheduled.
*
* @package workshopallocation_scheduled
* @copyright 2013 Adrian Greeve <adrian@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace workshopallocation_scheduled;
defined('MOODLE_INTERNAL') || die();

/**
* Class for workshopallocation_scheduled observers.
*
* @package workshopallocation_scheduled
* @copyright 2013 Adrian Greeve <adrian@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class observer {

/**
* Triggered when the '\mod_workshop\event\course_module_viewed' event is triggered.
*
* This does the same job as {@link workshopallocation_scheduled_cron()} but for the
* single workshop. The idea is that we do not need to wait for cron to execute.
* Displaying the workshop main view.php can trigger the scheduled allocation, too.
*
* @param \mod_workshop\event\course_module_viewed $event
* @return bool
*/
public static function workshop_viewed($event) {
global $DB;

$workshop = $event->get_record_snapshot('workshop', $event->objectid);
$course = $event->get_record_snapshot('course', $event->courseid);
$cm = $event->get_record_snapshot('course_modules', $event->contextinstanceid);

$workshop = new \workshop($workshop, $cm, $course);
$now = time();

// Non-expensive check to see if the scheduled allocation can even happen.
if ($workshop->phase == \workshop::PHASE_SUBMISSION and $workshop->submissionend > 0 and $workshop->submissionend < $now) {

// Make sure the scheduled allocation has been configured for this workshop, that it has not
// been executed yet and that the passed workshop record is still valid.
$sql = "SELECT a.id
FROM {workshopallocation_scheduled} a
JOIN {workshop} w ON a.workshopid = w.id
WHERE w.id = :workshopid
AND a.enabled = 1
AND w.phase = :phase
AND w.submissionend > 0
AND w.submissionend < :now
AND (a.timeallocated IS NULL OR a.timeallocated < w.submissionend)";
$params = array('workshopid' => $workshop->id, 'phase' => \workshop::PHASE_SUBMISSION, 'now' => $now);

if ($DB->record_exists_sql($sql, $params)) {
// Allocate submissions for assessments.
$allocator = $workshop->allocator_instance('scheduled');
$result = $allocator->execute();
// Todo inform the teachers about the results.
}
}
return true;
}
}
15 changes: 5 additions & 10 deletions mod/workshop/allocation/scheduled/db/events.php
Expand Up @@ -27,14 +27,9 @@

defined('MOODLE_INTERNAL') || die();

$handlers = array(

// The workshop main page is displayed to the user
'workshop_viewed' => array(
'handlerfile' => '/mod/workshop/allocation/scheduled/lib.php',
'handlerfunction' => 'workshopallocation_scheduled_workshop_viewed',
'schedule' => 'instant',
'internal' => 1,
),

$observers = array(
array(
'eventname' => '\mod_workshop\event\course_module_viewed',
'callback' => '\workshopallocation_scheduled\observer::workshop_viewed',
)
);
47 changes: 0 additions & 47 deletions mod/workshop/allocation/scheduled/lib.php
Expand Up @@ -285,50 +285,3 @@ function workshopallocation_scheduled_cron() {
// todo inform the teachers about the results
}
}

////////////////////////////////////////////////////////////////////////////////
// Events API
////////////////////////////////////////////////////////////////////////////////

/**
* Handler for the 'workshop_viewed' event
*
* This does the same job as {@link workshopallocation_scheduled_cron()} but for the
* single workshop. The idea is that we do not need to wait forcron to execute.
* Displaying the workshop main view.php can trigger the scheduled allocation, too.
*
* @param stdClass $event event data
* @return bool
*/
function workshopallocation_scheduled_workshop_viewed($event) {
global $DB;

$workshop = $event->workshop;
$now = time();

// Non-expensive check to see if the scheduled allocation can even happen.
if ($workshop->phase == workshop::PHASE_SUBMISSION and $workshop->submissionend > 0 and $workshop->submissionend < $now) {

// Make sure the scheduled allocation has been configured for this workshop, that it has not
// been executed yet and that the passed workshop record is still valid.
$sql = "SELECT a.id
FROM {workshopallocation_scheduled} a
JOIN {workshop} w ON a.workshopid = w.id
WHERE w.id = :workshopid
AND a.enabled = 1
AND w.phase = :phase
AND w.submissionend > 0
AND w.submissionend < :now
AND (a.timeallocated IS NULL OR a.timeallocated < w.submissionend)";
$params = array('workshopid' => $workshop->id, 'phase' => workshop::PHASE_SUBMISSION, 'now' => $now);

if ($DB->record_exists_sql($sql, $params)) {
// Allocate submissions for assessments.
$allocator = $workshop->allocator_instance('scheduled');
$result = $allocator->execute();
// todo inform the teachers about the results
}
}

return true;
}
106 changes: 106 additions & 0 deletions mod/workshop/classes/event/course_module_viewed.php
@@ -0,0 +1,106 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* This file contains an event for when a workshop activity is viewed.
*
* @package mod_workshop
* @copyright 2013 Adrian Greeve <adrian@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace mod_workshop\event;
defined('MOODLE_INTERNAL') || die();

/**
* Event for when a workshop activity is viewed.
*
* @package mod_workshop
* @copyright 2013 Adrian Greeve
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class course_module_viewed extends \core\event\content_viewed {

/**
* Init method.
*/
protected function init() {
$this->data['crud'] = 'r';
$this->data['level'] = self::LEVEL_PARTICIPATING;
$this->data['objecttable'] = 'workshop';
}

/**
* Does this event replace a legacy event?
*
* @return string legacy event name
*/
public static function get_legacy_eventname() {
return 'workshop_viewed';
}

/**
* Returns non-localised description of what happened.
*
* @return string
*/
public function get_description() {
return 'User with id ' . $this->userid . ' viewed content ' . $this->get_url() . ' In phase ' . $this->other['content'];
}

/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('workshopviewed', 'workshop');
}

/**
* Returns relevant URL.
* @return \moodle_url
*/
public function get_url() {
$url = '/mod/workshop/view.php';
return new \moodle_url($url, array('id'=>$this->context->instanceid));
}

/**
* Legacy event data if get_legacy_eventname() is not empty.
*
* @return mixed
*/
protected function get_legacy_eventdata() {
global $USER;

$workshop = $this->get_record_snapshot('workshop', $this->objectid);
$course = $this->get_record_snapshot('course', $this->courseid);
$cm = $this->get_record_snapshot('course_modules', $this->context->instanceid);
$workshop = new \workshop($workshop, $cm, $course);
return (object)array('workshop' => $workshop, 'user' => $USER);
}

/**
* replace add_to_log() statement.
*
* @return array of parameters to be passed to legacy add_to_log() function.
*/
protected function get_legacy_logdata() {
$url = new \moodle_url('view.php', array('id' => $this->context->instanceid));
return array($this->courseid, 'workshop', 'view', $url->out(), $this->objectid, $this->context->instanceid);
}
}

0 comments on commit 72f6cb3

Please sign in to comment.