Skip to content

Commit

Permalink
MDL-40908 core_tag: created an 'item_untagged' event
Browse files Browse the repository at this point in the history
  • Loading branch information
mdjnelson committed Apr 4, 2014
1 parent bf2ae26 commit d999407
Show file tree
Hide file tree
Showing 7 changed files with 351 additions and 44 deletions.
5 changes: 3 additions & 2 deletions course/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -1637,6 +1637,7 @@ function course_delete_module($cmid) {
require_once($CFG->libdir.'/gradelib.php');
require_once($CFG->dirroot.'/blog/lib.php');
require_once($CFG->dirroot.'/calendar/lib.php');
require_once($CFG->dirroot . '/tag/lib.php');

// Get the course module.
if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
Expand Down Expand Up @@ -1703,8 +1704,8 @@ function course_delete_module($cmid) {
$DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));

// Delete the tag instances.
$DB->delete_records('tag_instance', array('component' => 'mod_' . $modulename, 'contextid' => $modcontext->id));
// Delete all tag instances associated with the instance of this module.
tag_delete_instances('mod_' . $modulename, $modcontext->id);

// Delete the context.
context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
Expand Down
2 changes: 1 addition & 1 deletion lang/en/tag.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
$string['description'] = 'Description';
$string['edittag'] = 'Edit this tag';
$string['entertags'] = 'Enter tags separated by commas';
$string['errordeleting'] = 'Error deleting tag with id {$a}, please report to your system administrator.';
$string['errortagfrontpage'] = 'Tagging the site main page is not allowed';
$string['errorupdatingrecord'] = 'Error updating tag record';
$string['eventitemtagged'] = 'Item tagged';
$string['eventitemuntagged'] = 'Item untagged';
$string['eventtagcreated'] = 'Tag created';
$string['eventtagdeleted'] = 'Tag deleted';
$string['eventtagflagged'] = 'Tag flagged';
Expand Down
7 changes: 4 additions & 3 deletions lib/adminlib.php
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,10 @@ function uninstall_plugin($type, $name) {

echo $OUTPUT->heading($pluginname);

// Delete all tag instances associated with this plugin.
require_once($CFG->dirroot . '/tag/lib.php');
tag_delete_instances($component);

// Custom plugin uninstall.
$plugindirectory = core_component::get_plugin_directory($type, $name);
$uninstalllib = $plugindirectory . '/db/uninstall.php';
Expand Down Expand Up @@ -231,9 +235,6 @@ function uninstall_plugin($type, $name) {
$fs = get_file_storage();
$fs->delete_component_files($component);

// Delete all tag instances for this component.
$DB->delete_records('tag_instance', array('component' => $component));

// Finally purge all caches.
purge_all_caches();

Expand Down
98 changes: 98 additions & 0 deletions lib/classes/event/item_untagged.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?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/>.

/**
* Item untagged event.
*
* @property-read array $other {
* Extra information about event.
*
* - int tagid: the id of the tag.
* - string tagname: the name of the tag.
* - string tagrawname: the raw name of the tag.
* - int itemid: the id of the item tagged.
* - string itemtype: the type of item tagged.
* }
*
* @package core
* @copyright 2014 Mark Nelson <markn@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace core\event;

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

class item_untagged extends base {

/**
* Initialise the event data.
*/
protected function init() {
$this->data['objecttable'] = 'tag_instance';
$this->data['crud'] = 'd';
$this->data['edulevel'] = self::LEVEL_OTHER;
}

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

/**
* Returns non-localised description of what happened.
*
* @return string
*/
public function get_description() {
return 'The tag with the id ' . $this->other['tagid'] . ' was removed from the item type \'' . s($this->other['itemtype']) .
'\' with the id ' . $this->other['itemid'] . ' by the user with the id ' . $this->userid;
}

/**
* Custom validation.
*
* @throws \coding_exception when validation does not pass.
* @return void
*/
protected function validate_data() {
parent::validate_data();

if (!isset($this->other['tagid'])) {
throw new \coding_exception('The tagid must be set in $other.');
}

if (!isset($this->other['itemid'])) {
throw new \coding_exception('The itemid must be set in $other.');
}

if (!isset($this->other['itemtype'])) {
throw new \coding_exception('The itemtype must be set in $other.');
}

if (!isset($this->other['tagname'])) {
throw new \coding_exception('The tagname must be set in $other.');
}

if (!isset($this->other['tagrawname'])) {
throw new \coding_exception('The tagrawname must be set in $other.');
}
}
}
25 changes: 1 addition & 24 deletions tag/coursetagslib.php
Original file line number Diff line number Diff line change
Expand Up @@ -267,30 +267,7 @@ function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='officia
* @param int $courseid the course that the tag is associated with
*/
function coursetag_delete_keyword($tagid, $userid, $courseid) {
global $DB;

$sql = "SELECT *
FROM {tag_instance}
WHERE tagid = :tagid
AND tiuserid = :userid
AND itemtype = 'course'
AND itemid = :courseid";
if ($DB->record_exists_sql($sql, array('tagid' => $tagid, 'userid' => $userid, 'courseid' => $courseid))) {
$sql = "tagid = :tagid
AND tiuserid = :userid
AND itemtype = 'course'
AND itemid = :courseid";
$DB->delete_records_select('tag_instance', $sql, array('tagid' => $tagid, 'userid' => $userid, 'courseid' => $courseid));
// If there are no other instances of the tag then consider deleting the tag as well.
if (!$DB->record_exists('tag_instance', array('tagid' => $tagid))) {
// If the tag is a personal tag then delete it - don't do official tags.
if ($tag = $DB->get_record('tag', array('id' => $tagid, 'tagtype' => 'default'))) {
tag_delete($tagid);
}
}
} else {
print_error("errordeleting", 'tag', '', $tagid);
}
tag_delete_instance('course', $courseid, $tagid, $userid);
}

/**
Expand Down
134 changes: 122 additions & 12 deletions tag/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -656,8 +656,9 @@ function tag_delete($tagids) {
// Use the tagids to create a select statement to be used later.
list($tagsql, $tagparams) = $DB->get_in_or_equal($tagids);

// Store the tags we are going to delete.
// Store the tags and tag instances we are going to delete.
$tags = $DB->get_records_select('tag', 'id ' . $tagsql, $tagparams);
$taginstances = $DB->get_records_select('tag_instance', 'tagid ' . $tagsql, $tagparams);

// Delete all the tag instances.
$select = 'WHERE tagid ' . $tagsql;
Expand All @@ -673,6 +674,34 @@ function tag_delete($tagids) {
$sql = "DELETE FROM {tag} $select";
$DB->execute($sql, $tagparams);

// Fire an event that these items were untagged.
if ($taginstances) {
// Save the system context in case the 'contextid' column in the 'tag_instance' table is null.
$syscontextid = context_system::instance()->id;
// Loop through the tag instances and fire an 'item_untagged' event.
foreach ($taginstances as $taginstance) {
// We can not fire an event with 'null' as the contextid.
if (is_null($taginstance->contextid)) {
$taginstance->contextid = $syscontextid;
}

// Trigger item untagged event.
$event = \core\event\item_untagged::create(array(
'objectid' => $taginstance->id,
'contextid' => $taginstance->contextid,
'other' => array(
'tagid' => $taginstance->tagid,
'tagname' => $tags[$taginstance->tagid]->name,
'tagrawname' => $tags[$taginstance->tagid]->rawname,
'itemid' => $taginstance->itemid,
'itemtype' => $taginstance->itemtype
)
));
$event->add_record_snapshot('tag_instance', $taginstance);
$event->trigger();
}
}

// Fire an event that these tags were deleted.
if ($tags) {
$context = context_system::instance();
Expand Down Expand Up @@ -702,6 +731,57 @@ function tag_delete($tagids) {
return true;
}

/**
* Deletes all the tag instances given a component and an optional contextid.
*
* @param string $component
* @param int $contextid if null, then we delete all tag instances for the $component
*/
function tag_delete_instances($component, $contextid = null) {
global $DB;

$sql = "SELECT ti.*, t.name, t.rawname
FROM {tag_instance} ti
JOIN {tag} t
ON ti.tagid = t.id ";
if (is_null($contextid)) {
$params = array('component' => $component);
$sql .= "WHERE ti.component = :component";
} else {
$params = array('component' => $component, 'contextid' => $contextid);
$sql .= "WHERE ti.component = :component
AND ti.contextid = :contextid";
}
if ($taginstances = $DB->get_records_sql($sql, $params)) {
// Now remove all the tag instances.
$DB->delete_records('tag_instance',$params);
// Save the system context in case the 'contextid' column in the 'tag_instance' table is null.
$syscontextid = context_system::instance()->id;
// Loop through the tag instances and fire an 'item_untagged' event.
foreach ($taginstances as $taginstance) {
// We can not fire an event with 'null' as the contextid.
if (is_null($taginstance->contextid)) {
$taginstance->contextid = $syscontextid;
}

// Trigger item untagged event.
$event = \core\event\item_untagged::create(array(
'objectid' => $taginstance->id,
'contextid' => $taginstance->contextid,
'other' => array(
'tagid' => $taginstance->tagid,
'tagname' => $taginstance->name,
'tagrawname' => $taginstance->rawname,
'itemid' => $taginstance->itemid,
'itemtype' => $taginstance->itemtype
)
));
$event->add_record_snapshot('tag_instance', $taginstance);
$event->trigger();
}
}
}

/**
* Delete one instance of a tag. If the last instance was deleted, it will also delete the tag, unless its type is 'official'.
*
Expand All @@ -711,20 +791,50 @@ function tag_delete($tagids) {
* @param string $record_type the type of the record for which to remove the instance
* @param int $record_id the id of the record for which to remove the instance
* @param int $tagid the tagid that needs to be removed
* @param int $userid (optional) the userid
* @return bool true on success, false otherwise
*/
function tag_delete_instance($record_type, $record_id, $tagid) {
global $CFG, $DB;
function tag_delete_instance($record_type, $record_id, $tagid, $userid = null) {
global $DB;

if ($DB->delete_records('tag_instance', array('tagid'=>$tagid, 'itemtype'=>$record_type, 'itemid'=>$record_id))) {
if (!$DB->record_exists_sql("SELECT * ".
"FROM {tag} tg ".
"WHERE tg.id = ? AND ( tg.tagtype = 'official' OR ".
"EXISTS (SELECT 1
FROM {tag_instance} ti
WHERE ti.tagid = ?) )",
array($tagid, $tagid))) {
return tag_delete($tagid);
if (is_null($userid)) {
$taginstance = $DB->get_record('tag_instance', array('tagid' => $tagid, 'itemtype' => $record_type, 'itemid' => $record_id));
} else {
$taginstance = $DB->get_record('tag_instance', array('tagid' => $tagid, 'itemtype' => $record_type, 'itemid' => $record_id,
'tiuserid' => $userid));
}
if ($taginstance) {
// Get the tag.
$tag = $DB->get_record('tag', array('id' => $tagid));

$DB->delete_records('tag_instance', array('id' => $taginstance->id));

// We can not fire an event with 'null' as the contextid.
if (is_null($taginstance->contextid)) {
$taginstance->contextid = context_system::instance()->id;
}

// Trigger item untagged event.
$event = \core\event\item_untagged::create(array(
'objectid' => $taginstance->id,
'contextid' => $taginstance->contextid,
'other' => array(
'tagid' => $tag->id,
'tagname' => $tag->name,
'tagrawname' => $tag->rawname,
'itemid' => $taginstance->itemid,
'itemtype' => $taginstance->itemtype
)
));
$event->add_record_snapshot('tag_instance', $taginstance);
$event->trigger();

// If there are no other instances of the tag then consider deleting the tag as well.
if (!$DB->record_exists('tag_instance', array('tagid' => $tagid))) {
// If the tag is a personal tag then delete it - don't delete official tags.
if ($tag->tagtype == 'default') {
tag_delete($tagid);
}
}
} else {
return false;
Expand Down
Loading

0 comments on commit d999407

Please sign in to comment.