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))) {
$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);
$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';
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';
$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();
--- /dev/null
+<?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.');
+ }
+ }
+}
* @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);
}
/**
// 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;
$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();
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'.
*
* @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;
require_once($CFG->dirroot . '/tag/lib.php');
require_once($CFG->dirroot . '/tag/coursetagslib.php');
+// Used to create a wiki page to tag.
+require_once($CFG->dirroot . '/mod/wiki/locallib.php');
+
class core_tag_events_testcase extends advanced_testcase {
/**
$this->assertEventLegacyLogData($expected, $event);
}
+ /**
+ * Test the item untagged event.
+ */
+ public function test_item_untagged() {
+ global $DB;
+
+ $this->setAdminUser();
+
+ // Create a course to tag.
+ $course = $this->getDataGenerator()->create_course();
+
+ // Create a wiki page to tag.
+ $wikigenerator = $this->getDataGenerator()->get_plugin_generator('mod_wiki');
+ $wiki = $wikigenerator->create_instance(array('course' => $course->id));
+ $subwikiid = wiki_add_subwiki($wiki->id, 0);
+ $wikipageid = wiki_create_page($subwikiid, 'Title', FORMAT_HTML, '2');
+
+ // Create the tag.
+ $tag = $this->getDataGenerator()->create_tag();
+
+ // Assign a tag to a course.
+ tag_assign('course', $course->id, $tag->id, 1, 2, 'core', context_course::instance($course->id)->id);
+
+ // Trigger and capture the event for untagging a course.
+ $sink = $this->redirectEvents();
+ coursetag_delete_keyword($tag->id, 2, $course->id);
+ $events = $sink->get_events();
+ $event = reset($events);
+
+ // Check that the course was untagged and the event data is valid.
+ $this->assertEquals(0, $DB->count_records('tag_instance'));
+ $this->assertInstanceOf('\core\event\item_untagged', $event);
+ $this->assertEquals(context_course::instance($course->id), $event->get_context());
+
+ // Create the tag.
+ $tag = $this->getDataGenerator()->create_tag();
+
+ // Assign a tag to a wiki this time.
+ tag_assign('wiki_pages', $wikipageid, $tag->id, 1, 2, 'mod_wiki', context_module::instance($wiki->cmid)->id);
+
+ // Trigger and capture the event for deleting this tag instance.
+ $sink = $this->redirectEvents();
+ tag_delete_instance('wiki_pages', $wikipageid, $tag->id);
+ $events = $sink->get_events();
+ $event = reset($events);
+
+ // Check that wiki page was untagged and the event data is valid.
+ $this->assertEquals(0, $DB->count_records('tag_instance'));
+ $this->assertInstanceOf('\core\event\item_untagged', $event);
+ $this->assertEquals(context_module::instance($wiki->cmid), $event->get_context());
+
+ // Create a tag again - the other would have been deleted since there were no more instances associated with it.
+ $tag = $this->getDataGenerator()->create_tag();
+
+ // Assign a tag to the wiki again.
+ tag_assign('wiki_pages', $wikipageid, $tag->id, 1, 2, 'mod_wiki', context_module::instance($wiki->cmid)->id);
+
+ // Now we want to delete this tag, and because there is only one tag instance
+ // associated with it, it should get deleted as well.
+ $sink = $this->redirectEvents();
+ tag_delete($tag->id);
+ $events = $sink->get_events();
+ $event = reset($events);
+
+ // Check that wiki page was untagged and the event data is valid.
+ $this->assertEquals(0, $DB->count_records('tag_instance'));
+ $this->assertInstanceOf('\core\event\item_untagged', $event);
+ $this->assertEquals(context_module::instance($wiki->cmid), $event->get_context());
+
+ // Create a tag again - the other would have been deleted since there were no more instances associated with it.
+ $tag = $this->getDataGenerator()->create_tag();
+
+ // Assign a tag to the wiki again.
+ tag_assign('wiki_pages', $wikipageid, $tag->id, 1, 2, 'mod_wiki', context_module::instance($wiki->cmid)->id);
+
+ // Delete all tag instances for this wiki instance.
+ $sink = $this->redirectEvents();
+ tag_delete_instances('mod_wiki', context_module::instance($wiki->cmid)->id);
+ $events = $sink->get_events();
+ $event = reset($events);
+
+ // Check that wiki page was untagged and the event data is valid.
+ $this->assertEquals(0, $DB->count_records('tag_instance'));
+ $this->assertInstanceOf('\core\event\item_untagged', $event);
+ $this->assertEquals(context_module::instance($wiki->cmid), $event->get_context());
+
+ // Create another wiki.
+ $wiki2 = $wikigenerator->create_instance(array('course' => $course->id));
+ $subwikiid2 = wiki_add_subwiki($wiki2->id, 0);
+ $wikipageid2 = wiki_create_page($subwikiid2, 'Title', FORMAT_HTML, '2');
+
+ // Assign a tag to both wiki pages.
+ tag_assign('wiki_pages', $wikipageid, $tag->id, 1, 2, 'mod_wiki', context_module::instance($wiki->cmid)->id);
+ tag_assign('wiki_pages', $wikipageid2, $tag->id, 1, 2, 'mod_wiki', context_module::instance($wiki2->cmid)->id);
+
+ // Now remove all tag_instances associated with all wikis.
+ $sink = $this->redirectEvents();
+ tag_delete_instances('mod_wiki');
+ $events = $sink->get_events();
+
+ // There will be two events - one for each wiki instance removed.
+ $event1 = reset($events);
+ $event2 = $events[1];
+
+ // Check that wiki pages were untagged.
+ $this->assertEquals(0, $DB->count_records('tag_instance'));
+
+ // Check the first event data is valid.
+ $this->assertInstanceOf('\core\event\item_untagged', $event1);
+ $this->assertEquals(context_module::instance($wiki->cmid), $event1->get_context());
+
+ // Check that the second event data is valid.
+ $this->assertInstanceOf('\core\event\item_untagged', $event2);
+ $this->assertEquals(context_module::instance($wiki2->cmid), $event2->get_context());
+ }
+
/**
* Test the tag flagged event.
*/
$sink = $this->redirectEvents();
coursetag_delete_keyword($tag->id, 2, $course->id);
$events = $sink->get_events();
- $event = reset($events);
+ $event = $events[1];
// Check that the tag was deleted and the event data is valid.
$this->assertEquals(0, $DB->count_records('tag'));
$sink = $this->redirectEvents();
coursetag_delete_course_tags($course->id);
$events = $sink->get_events();
- $event = reset($events);
+ $event = $events[1];
// Check that the tag was deleted and the event data is valid.
$this->assertEquals(0, $DB->count_records('tag'));
$sink = $this->redirectEvents();
coursetag_delete_course_tags($course->id);
$events = $sink->get_events();
+ $events = array($events[2], $events[3]);
// Check that the tags were deleted and the events data is valid.
$this->assertEquals(0, $DB->count_records('tag'));
