MDL-20700 coding style cleanup - cvs keywords removed, closign php tag removed, trail...
[moodle.git] / tag / lib.php
1 <?php
3 /**
4  * Moodle tag library
5  *
6  * Tag strings : you can use any character in tags, except the comma (which is
7  * the separator) and the '\' (backslash).  Note that many spaces (or other
8  * blank characters) will get "compressed" into one. A tag string is always a
9  * rawurlencode'd string. This is the same behavior as http://del.icio.us.
10  *
11  * A "record" is a php array (note that an object will work too) that contains
12  * the following variables :
13  *  - type: the table containing the record that we are tagging (eg: for a
14  *    blog, this is table 'post', and for a user it is 'user')
15  *  - id: the id of the record
16  *
17  * TODO: turn this into a full-fledged categorization system. This could start
18  * by modifying (removing, probably) the 'tag type' to use another table
19  * describing the relationship between tags (parents, sibling, etc.), which
20  * could then be merged with the 'course categorization' system...
21  *
22  * BASIC INSTRUCTIONS :
23  *  - to "tag a blog post" (for example):
24  *        tag_set('post', $blog_post->id, $array_of_tags);
25  *
26  *  - to "remove all the tags on a blog post":
27  *        tag_set('post', $blog_post->id, array());
28  *
29  * Tag set will create tags that need to be created.
30  *
31  * @version: $Id$
32  * @licence http://www.gnu.org/copyleft/gpl.html GNU Public License
33  * @package moodlecore
34  * @subpackage tag
35  * @see http://www.php.net/manual/en/function.urlencode.php
36  */
38 define('TAG_RETURN_ARRAY', 0);
39 define('TAG_RETURN_OBJECT', 1);
40 define('TAG_RETURN_TEXT', 2);
41 define('TAG_RETURN_HTML', 3);
43 define('TAG_CASE_LOWER', 0);
44 define('TAG_CASE_ORIGINAL', 1);
46 define('TAG_RELATED_ALL', 0);
47 define('TAG_RELATED_MANUAL', 1);
48 define('TAG_RELATED_CORRELATED', 2);
50 ///////////////////////////////////////////////////////
51 /////////////////// PUBLIC TAG API ////////////////////
53 /// Functions for settings tags  //////////////////////
55 /**
56  * Set the tags assigned to a record.  This overwrites the current tags.
57  *
58  * This function is meant to be fed the string coming up from the user
59  * interface, which contains all tags assigned to a record.
60  *
61  * @param string $record_type the type of record to tag ('post' for blogs,
62  *     'user' for users, 'tag' for tags, etc.
63  * @param int $record_id the id of the record to tag
64  * @param array $tags the array of tags to set on the record. If
65  *     given an empty array, all tags will be removed.
66  * @return void
67  */
68 function tag_set($record_type, $record_id, $tags) {
70     static $in_recursion_semaphore = false; // this is to prevent loops when tagging a tag
71     if ( $record_type == 'tag' && !$in_recursion_semaphore) {
72         $current_tagged_tag_name = tag_get_name($record_id);
73     }
75     $tags_ids = tag_get_id($tags, TAG_RETURN_ARRAY); // force an array, even if we only have one tag.
76     $cleaned_tags = tag_normalize($tags);
77     //echo 'tags-in-tag_set'; var_dump($tags); var_dump($tags_ids); var_dump($cleaned_tags);
79     $current_ids = tag_get_tags_ids($record_type, $record_id);
80     //var_dump($current_ids);
82     // for data coherence reasons, it's better to remove deleted tags
83     // before adding new data: ordering could be duplicated.
84     foreach($current_ids as $current_id) {
85         if (!in_array($current_id, $tags_ids)) {
86             tag_delete_instance($record_type, $record_id, $current_id);
87             if ( $record_type == 'tag' && !$in_recursion_semaphore) {
88                 // if we are removing a tag-on-a-tag (manually related tag),
89                 // we need to remove the opposite relationship as well.
90                 tag_delete_instance('tag', $current_id, $record_id);
91             }
92         }
93     }
95     if (empty($tags)) {
96         return true;
97     }
99     foreach($tags as $ordering => $tag) {
100         $tag = trim($tag);
101         if (!$tag) {
102             continue;
103         }
105         $clean_tag = $cleaned_tags[$tag];
106         $tag_current_id = $tags_ids[$clean_tag];
108         if ( is_null($tag_current_id) ) {
109             // create new tags
110             //echo "call to add tag $tag\n";
111             $new_tag = tag_add($tag);
112             $tag_current_id = $new_tag[$clean_tag];
113         }
115         tag_assign($record_type, $record_id, $tag_current_id, $ordering);
117         // if we are tagging a tag (adding a manually-assigned related tag), we
118         // need to create the opposite relationship as well.
119         if ( $record_type == 'tag' && !$in_recursion_semaphore) {
120             $in_recursion_semaphore = true;
121             tag_set_add('tag', $tag_current_id, $current_tagged_tag_name);
122             $in_recursion_semaphore = false;
123         }
124     }
127 /**
128  * Adds a tag to a record, without overwriting the current tags.
129  *
130  * @param string $record_type the type of record to tag ('post' for blogs,
131  *     'user' for users, etc.
132  * @param int $record_id the id of the record to tag
133  * @param string $tag the tag to add
134  * @return void
135  */
136 function tag_set_add($record_type, $record_id, $tag) {
138     $new_tags = array();
139     foreach( tag_get_tags($record_type, $record_id) as $current_tag ) {
140         $new_tags[] = $current_tag->rawname;
141     }
142     $new_tags[] = $tag;
144     return tag_set($record_type, $record_id, $new_tags);
147 /**
148  * Removes a tag from a record, without overwriting other current tags.
149  *
150  * @param string $record_type the type of record to tag ('post' for blogs,
151  *     'user' for users, etc.
152  * @param int $record_id the id of the record to tag
153  * @param string $tag the tag to delete
154  * @return void
155  */
156 function tag_set_delete($record_type, $record_id, $tag) {
158     $new_tags = array();
159     foreach( tag_get_tags($record_type, $record_id) as $current_tag ) {
160         if ($current_tag->name != $tag) {  // Keep all tags but the one specified
161             $new_tags[] = $current_tag->name;
162         }
163     }
165     return tag_set($record_type, $record_id, $new_tags);
168 /**
169  * Set the type of a tag.  At this time (version 1.9) the possible values
170  * are 'default' or 'official'.  Official tags will be displayed separately "at
171  * tagging time" (while selecting the tags to apply to a record).
172  *
173  * @param string $tagid tagid to modify
174  * @param string $type either 'default' or 'official'
175  * @return true on success, false otherwise
176  */
177 function tag_type_set($tagid, $type) {
178     global $DB;
180     if ($tag = $DB->get_record('tag', array('id'=>$tagid), 'id')) {
181         $tag->tagtype = $type;
182         $tag->timemodified = time();
183         return $DB->update_record('tag', $tag);
184     }
185     return false;
189 /**
190  * Set the description of a tag
191  *
192  * @param int $tagid the id of the tag
193  * @param string $description the description
194  * @param int $descriptionformat the moodle text format of the description
195  * @return true on success, false otherwise
196  */
197 function tag_description_set($tagid, $description, $descriptionformat) {
198     global $DB;
200     if ($tag = $DB->get_record('tag', array('id'=>$tagid),'id')) {
201         $tag->description = $description;
202         $tag->descriptionformat = $descriptionformat;
203         $tag->timemodified = time();
204         return $DB->update_record('tag', $tag);
205     }
206     return false;
214 /// Functions for getting information about tags //////
216 /**
217  * Simple function to just return a single tag object when you know the name or something
218  *
219  * @param string $field which field do we use to identify the tag: id, name or rawname
220  * @param string $value the required value of the aforementioned field
221  * @param string $returnfields which fields do we want returned?
222  * @return tag object
223  *
224  **/
225 function tag_get($field, $value, $returnfields='id, name, rawname') {
226     global $DB;
228     if ($field == 'name') {
229         $value = moodle_strtolower($value);   // To cope with input that might just be wrong case
230     }
231     return $DB->get_record('tag', array($field=>$value), $returnfields);
235 /**
236  * Get the array of db record of tags associated to a record (instances).  Use
237  * tag_get_tags_csv to get the same information in a comma-separated string.
238  *
239  * @param string $record_type the record type for which we want to get the tags
240  * @param int $record_id the record id for which we want to get the tags
241  * @param string $type the tag type (either 'default' or 'official'). By default,
242  *     all tags are returned.
243  * @param int $userid optional only required for course tagging
244  * @return array the array of tags
245  */
246 function tag_get_tags($record_type, $record_id, $type=null, $userid=0) {
247     global $CFG, $DB;
249     $params = array();
251     if ($type) {
252         $sql_type = "AND tg.tagtype = :type";
253         $params['type'] = $type;
254     } else {
255         $sql_type = '';
256     }
258    $u = null;
259     if ($userid) {
260         $u =  "AND ti.tiuserid = :userid ";
261         $params['userid'] = $userid;
262     }
264     $sql = "SELECT tg.id, tg.tagtype, tg.name, tg.rawname, tg.flag, ti.ordering
265               FROM {tag_instance} ti JOIN {tag} tg ON tg.id = ti.tagid
266               WHERE ti.itemtype = :recordtype AND ti.itemid = :recordid $u $sql_type
267            ORDER BY ti.ordering ASC";
268     $params['recordtype'] = $record_type;
269     $params['recordid']   = $record_id;
271     // if the fields in this query are changed, you need to do the same changes in tag_get_correlated_tags
272     return $DB->get_records_sql($sql, $params);
273     // This version of the query, reversing the ON clause, "correctly" returns
274     // a row with NULL values for instances that are still in the DB even though
275     // the tag has been deleted.  This shouldn't happen, but if it did, using
276     // this query could help "clean it up".  This causes bugs at this time.
277     //$tags = $DB->get_records_sql("SELECT ti.tagid, tg.tagtype, tg.name, tg.rawname, tg.flag, ti.ordering ".
278     //    "FROM {tag_instance} ti LEFT JOIN {tag} tg ON ti.tagid = tg.id ".
279     //    "WHERE ti.itemtype = '{$record_type}' AND ti.itemid = '{$record_id}' {$type} ".
280     //    "ORDER BY ti.ordering ASC");
283 /**
284  * Get the array of tags display names, indexed by id.
285  *
286  * @param string $record_type the record type for which we want to get the tags
287  * @param int $record_id the record id for which we want to get the tags
288  * @param string $type the tag type (either 'default' or 'official'). By default,
289  *     all tags are returned.
290  * @return array the array of tags (with the value returned by tag_display_name), indexed by id
291  */
292 function tag_get_tags_array($record_type, $record_id, $type=null) {
293     $tags = array();
294     foreach(tag_get_tags($record_type, $record_id, $type) as $tag) {
295         $tags[$tag->id] = tag_display_name($tag);
296     }
297     return $tags;
300 /**
301  * Get a comma-separated string of tags associated to a record.  Use tag_get_tags
302  * to get the same information in an array.
303  *
304  * @param string $record_type the record type for which we want to get the tags
305  * @param int $record_id the record id for which we want to get the tags
306  * @param int $html either TAG_RETURN_HTML or TAG_RETURN_TEXT, depending
307  *     on the type of output desired
308  * @param string $type either 'official' or 'default', if null, all tags are
309  *     returned
310  * @return string the comma-separated list of tags.
311  */
312 function tag_get_tags_csv($record_type, $record_id, $html=TAG_RETURN_HTML, $type=null) {
313     global $CFG;
315     $tags_names = array();
316     foreach(tag_get_tags($record_type, $record_id, $type) as $tag) {
317         if ($html == TAG_RETURN_TEXT) {
318             $tags_names[] = tag_display_name($tag, TAG_RETURN_TEXT);
319         } else { // TAG_RETURN_HTML
320             $tags_names[] = '<a href="'. $CFG->wwwroot .'/tag/index.php?tag='. rawurlencode($tag->name) .'">'. tag_display_name($tag) .'</a>';
321         }
322     }
323     return implode(', ', $tags_names);
326 /**
327  * Get an array of tag ids associated to a record.
328  *
329  * @param string $record_type the record type for which we want to get the tags
330  * @param int $record_id the record id for which we want to get the tags
331  * @return array of tag ids, indexed and sorted by 'ordering'
332  */
333 function tag_get_tags_ids($record_type, $record_id) {
335     $tag_ids = array();
336     foreach (tag_get_tags($record_type, $record_id) as $tag) {
337         if ( array_key_exists($tag->ordering, $tag_ids) ) {
338             // until we can add a unique constraint, in table tag_instance,
339             // on (itemtype, itemid, ordering), this is needed to prevent a bug
340             // TODO : modify database in 2.0
341             $tag->ordering++;
342         }
343         $tag_ids[$tag->ordering] = $tag->id;
344     }
345     ksort($tag_ids);
346     return $tag_ids;
349 /**
350  * Returns the database ID of a set of tags.
351  *
352  * @param mixed $tags one tag, or array of tags, to look for.
353  * @param bool $return_value specify the type of the returned value. Either
354  *     TAG_RETURN_OBJECT, or TAG_RETURN_ARRAY (default). If TAG_RETURN_ARRAY
355  *     is specified, an array will be returned even if only one tag was
356  *     passed in $tags.
357  * @return mixed tag-indexed array of ids (or objects, if second parameter is
358  *     TAG_RETURN_OBJECT), or only an int, if only one tag is given *and* the
359  *     second parameter is null. No value for a key means the tag wasn't found.
360  */
361 function tag_get_id($tags, $return_value=null) {
362     global $CFG, $DB;
364     static $tag_id_cache = array();
366     $return_an_int = false;
367     if (!is_array($tags)) {
368         if(is_null($return_value) || $return_value == TAG_RETURN_OBJECT) {
369             $return_an_int = true;
370         }
371         $tags = array($tags);
372     }
374     $result = array();
376     //TODO: test this and see if it helps performance without breaking anything
377     //foreach($tags as $key => $tag) {
378     //    $clean_tag = moodle_strtolower($tag);
379     //    if ( array_key_exists($clean_tag), $tag_id_cache) ) {
380     //        $result[$clean_tag] = $tag_id_cache[$clean_tag];
381     //        $tags[$key] = ''; // prevent further processing for this one.
382     //    }
383     //}
385     $tags = array_values(tag_normalize($tags));
386     foreach($tags as $key => $tag) {
387         $tags[$key] = moodle_strtolower($tag);
388         $result[moodle_strtolower($tag)] = null; // key must exists : no value for a key means the tag wasn't found.
389     }
391     if (empty($tags)) {
392         return array();
393     }
395     list($tag_string, $params) = $DB->get_in_or_equal($tags);
397     if ($rs = $DB->get_recordset_sql("SELECT * FROM {tag} WHERE name $tag_string ORDER BY name", $params)) {
398         foreach ($rs as $record) {
399             if ($return_value == TAG_RETURN_OBJECT) {
400                 $result[$record->name] = $record;
401             } else { // TAG_RETURN_ARRAY
402                 $result[$record->name] = $record->id;
403             }
404         }
405         $rs->close();
406     }
408     if ($return_an_int) {
409         return array_pop($result);
410     }
412     return $result;
416 /**
417  * Returns tags related to a tag
418  *
419  * Related tags of a tag come from two sources:
420  *   - manually added related tags, which are tag_instance entries for that tag
421  *   - correlated tags, which are a calculated
422  *
423  * @param string $tag_name_or_id is a single **normalized** tag name or the id
424  *     of a tag
425  * @param int $type the function will return either manually
426  *     (TAG_RELATED_MANUAL) related tags or correlated (TAG_RELATED_CORRELATED)
427  *     tags. Default is TAG_RELATED_ALL, which returns everything.
428  * @param int $limitnum return a subset comprising this many records (optional,
429  *     default is 10)
430  * @return array an array of tag objects
431  */
432 function tag_get_related_tags($tagid, $type=TAG_RELATED_ALL, $limitnum=10) {
434     $related_tags = array();
436     if ( $type == TAG_RELATED_ALL || $type == TAG_RELATED_MANUAL) {
437         //gets the manually added related tags
438         $related_tags = tag_get_tags('tag', $tagid);
439     }
441     if ( $type == TAG_RELATED_ALL || $type == TAG_RELATED_CORRELATED ) {
442         //gets the correlated tags
443         $automatic_related_tags = tag_get_correlated($tagid, $limitnum);
444         if (is_array($automatic_related_tags)) {
445             $related_tags = array_merge($related_tags, $automatic_related_tags);
446         }
447     }
449     return array_slice(object_array_unique($related_tags), 0 , $limitnum);
452 /**
453  * Get a comma-separated list of tags related to another tag.
454  *
455  * @param array $related_tags the array returned by tag_get_related_tags
456  * @param int $html either TAG_RETURN_HTML (default) or TAG_RETURN_TEXT : return html links, or just text.
457  * @return string comma-separated list
458  */
459 function tag_get_related_tags_csv($related_tags, $html=TAG_RETURN_HTML) {
460     global $CFG;
462     $tags_names = array();
463     foreach($related_tags as $tag) {
464         if ( $html == TAG_RETURN_TEXT) {
465             $tags_names[] = tag_display_name($tag, TAG_RETURN_TEXT);
466         } else {
467             // TAG_RETURN_HTML
468             $tags_names[] = '<a href="'. $CFG->wwwroot .'/tag/index.php?tag='. rawurlencode($tag->name) .'">'. tag_display_name($tag) .'</a>';
469         }
470     }
472     return implode(', ', $tags_names);
475 /**
476  * Change the "value" of a tag, and update the associated 'name'.
477  *
478  * @param int $tagid the id of the tag to modify
479  * @param string $newtag the new rawname
480  * @return bool true on success, false otherwise
481  */
482 function tag_rename($tagid, $newrawname) {
483     global $DB;
485     if (! $newrawname_clean = array_shift(tag_normalize($newrawname, TAG_CASE_ORIGINAL)) ) {
486         return false;
487     }
489     if (! $newname_clean = moodle_strtolower($newrawname_clean)) {
490         return false;
491     }
493     // Prevent the rename if a tag with that name already exists
494     if ($existing = tag_get('name', $newname_clean, 'id, name, rawname')) {
495         if ($existing->id != $tagid) {  // Another tag already exists with this name
496             return false;
497         }
498     }
500     if ($tag = tag_get('id', $tagid, 'id, name, rawname')) {
501         $tag->rawname      = $newrawname_clean;
502         $tag->name         = $newname_clean;
503         $tag->timemodified = time();
504         return $DB->update_record('tag', $tag);
505     }
506     return false;
510 /**
511  * Delete one or more tag, and all their instances if there are any left.
512  *
513  * @param mixed $tagids one tagid (int), or one array of tagids to delete
514  * @return bool true on success, false otherwise
515  */
516 function tag_delete($tagids) {
517     global $DB;
519     if (!is_array($tagids)) {
520         $tagids = array($tagids);
521     }
523     $success = true;
524     foreach( $tagids as $tagid ) {
525         if (is_null($tagid)) { // can happen if tag doesn't exists
526             continue;
527         }
528         // only delete the main entry if there were no problems deleting all the
529         // instances - that (and the fact we won't often delete lots of tags)
530         // is the reason for not using $DB->delete_records_select()
531         if ($DB->delete_records('tag_instance', array('tagid'=>$tagid)) ) {
532             $success &= (bool) $DB->delete_records('tag', array('id'=>$tagid));
533         }
534     }
536     return $success;
539 /**
540  * Delete one instance of a tag.  If the last instance was deleted, it will
541  * also delete the tag, unless its type is 'official'.
542  *
543  * @param string $record_type the type of the record for which to remove the instance
544  * @param int $record_id the id of the record for which to remove the instance
545  * @param int $tagid the tagid that needs to be removed
546  * @return bool true on success, false otherwise
547  */
548 function tag_delete_instance($record_type, $record_id, $tagid) {
549     global $CFG, $DB;
551     if ($DB->delete_records('tag_instance', array('tagid'=>$tagid, 'itemtype'=>$record_type, 'itemid'=>$record_id))) {
552         if (!$DB->record_exists_sql("SELECT * ".
553                                       "FROM {tag} tg ".
554                                      "WHERE tg.id = ? AND ( tg.tagtype = 'official' OR ".
555                                         "EXISTS (SELECT 1
556                                                    FROM {tag_instance} ti
557                                                   WHERE ti.tagid = ?) )",
558                                      array($tagid, $tagid))) {
559             return tag_delete($tagid);
560         }
561     } else {
562         return false;
563     }
565     return true;
569 /**
570  * Function that returns the name that should be displayed for a specific tag
571  *
572  * @param object $tag_object a line out of tag table, as returned by the adobd functions
573  * @param int $html TAG_RETURN_HTML (default) will return htmlspecialchars encoded string, TAG_RETURN_TEXT will not encode.
574  * @return string
575  */
576 function tag_display_name($tagobject, $html=TAG_RETURN_HTML) {
578     global $CFG;
580     if(!isset($tagobject->name)) {
581         return '';
582     }
584     if (empty($CFG->keeptagnamecase)) {
585         //this is the normalized tag name
586         $textlib = textlib_get_instance();
587         $tagname = $textlib->strtotitle($tagobject->name);
588     } else {
589         //original casing of the tag name
590         $tagname = $tagobject->rawname;
591     }
593     if ($html == TAG_RETURN_TEXT) {
594         return $tagname;
595     } else { // TAG_RETURN_HTML
596         return htmlspecialchars($tagname);
597     }
600 /**
601  * Find all records tagged with a tag of a given type ('post', 'user', etc.)
602  *
603  * @param string $tag tag to look for
604  * @param string $type type to restrict search to.  If null, every matching
605  *     record will be returned
606  * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
607  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
608  * @return array of matching objects, indexed by record id, from the table containing the type requested
609  */
610 function tag_find_records($tag, $type, $limitfrom='', $limitnum='') {
611     global $CFG, $DB;
613     if (!$tag || !$type) {
614         return array();
615     }
617     $tagid = tag_get_id($tag);
619     $query = "SELECT it.*
620                 FROM {".$type."} it INNER JOIN {tag_instance} tt ON it.id = tt.itemid
621                WHERE tt.itemtype = ? AND tt.tagid = ?";
622     $params = array($type, $tagid);
624     return $DB->get_records_sql($query, $params, $limitfrom, $limitnum);
630 ///////////////////////////////////////////////////////
631 /////////////////// PRIVATE TAG API ///////////////////
633 /**
634  * Adds one or more tag in the database.  This function should not be called
635  * directly : you should use tag_set.
636  *
637  * @param mixed $tags one tag, or an array of tags, to be created
638  * @param string $type type of tag to be created ("default" is the default
639  *     value and "official" is the only other supported value at this time). An
640  *     official tag is kept even if there are no records tagged with it.
641  * @return an array of tags ids, indexed by their lowercase normalized names.
642  *     Any boolean false in the array indicates an error while adding the tag.
643  */
644 function tag_add($tags, $type="default") {
645     global $USER, $DB;
647     if (!is_array($tags)) {
648         $tags = array($tags);
649     }
651     $tag_object = new StdClass;
652     $tag_object->tagtype      = $type;
653     $tag_object->userid       = $USER->id;
654     $tag_object->timemodified = time();
656     $clean_tags = tag_normalize($tags, TAG_CASE_ORIGINAL);
658     $tags_ids = array();
659     foreach($clean_tags as $tag) {
660         $tag = trim($tag);
661         if (!$tag) {
662             $tags_ids[$tag] = false;
663         } else {
664             // note that the difference between rawname and name is only
665             // capitalization : the rawname is NOT the same at the rawtag.
666             $tag_object->rawname = $tag;
667             $tag_name_lc         = moodle_strtolower($tag);
668             $tag_object->name    = $tag_name_lc;
669             //var_dump($tag_object);
670             $tags_ids[$tag_name_lc] = $DB->insert_record('tag', $tag_object);
671         }
672     }
674     return $tags_ids;
677 /**
678  * Assigns a tag to a record: if the record already exists, the time and
679  * ordering will be updated.
680  *
681  * @param string $record_type the type of the record that will be tagged
682  * @param int $record_id the id of the record that will be tagged
683  * @param string $tagid the tag id to set on the record.
684  * @param int $ordering the order of the instance for this record
685  * @param int $userid optional only required for course tagging
686  * @return bool true on success, false otherwise
687  */
688 function tag_assign($record_type, $record_id, $tagid, $ordering, $userid = 0) {
689     global $DB;
691     if ( $tag_instance_object = $DB->get_record('tag_instance', array('tagid'=>$tagid, 'itemtype'=>$record_type, 'itemid'=>$record_id, 'tiuserid'=>$userid), 'id')) {
692         $tag_instance_object->ordering     = $ordering;
693         $tag_instance_object->timemodified = time();
694         return $DB->update_record('tag_instance', $tag_instance_object);
695     } else {
696         $tag_instance_object = new StdClass;
697         $tag_instance_object->tagid        = $tagid;
698         $tag_instance_object->itemid       = $record_id;
699         $tag_instance_object->itemtype     = $record_type;
700         $tag_instance_object->ordering     = $ordering;
701         $tag_instance_object->timemodified = time();
702         $tag_instance_object->tiuserid     = $userid;
703         return $DB->insert_record('tag_instance', $tag_instance_object);
704     }
707 /**
708  * Function that returns tags that start with some text, for use by the autocomplete feature
709  *
710  * @param string $text string that the tag names will be matched against
711  * @return mixed an array of objects, or false if no records were found or an error occured.
712  */
713 function tag_autocomplete($text) {
714     global $DB;
715     return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
716                                    FROM {tag} tg
717                                   WHERE tg.name LIKE ?", array(moodle_strtolower($text)."%"));
720 /**
721  * Clean up the tag tables, making sure all tagged object still exists.
722  *
723  * This should normally not be necessary, but in case related tags are not deleted
724  * when the tagged record is removed, this should be done once in a while, perhaps on
725  * an occasional cron run.  On a site with lots of tags, this could become an expensive
726  * function to call: don't run at peak time.
727  */
728 function tag_cleanup() {
729     global $DB;
731     $instances = $DB->get_recordset('tag_instance');
733     // cleanup tag instances
734     foreach ($instances as $instance) {
735         $delete = false;
737         if (!$DB->record_exists('tag', array('id'=>$instance->tagid))) {
738             // if the tag has been removed, instance should be deleted.
739             $delete = true;
740         } else {
741             switch ($instance->itemtype) {
742                 case 'user': // users are marked as deleted, but not actually deleted
743                     if ($DB->record_exists('user', array('id'=>$instance->itemid, 'deleted'=>1))) {
744                         $delete = true;
745                     }
746                     break;
747                 default: // anything else, if the instance is not there, delete.
748                     if (!$DB->record_exists($instance->itemtype, array('id'=>$instance->itemid))) {
749                         $delete = true;
750                     }
751                     break;
752             }
753         }
754         if ($delete) {
755             tag_delete_instance($instance->itemtype, $instance->itemid, $instance->tagid);
756             //debugging('deleting tag_instance #'. $instance->id .', linked to tag id #'. $instance->tagid, DEBUG_DEVELOPER);
757         }
758     }
759     $instances->close();
761     // TODO: this will only clean tags of type 'default'.  This is good as
762     // it won't delete 'official' tags, but the day we get more than two
763     // types, we need to fix this.
764     $unused_tags = $DB->get_recordset_sql("SELECT tg.id
765                                              FROM {tag} tg
766                                             WHERE tg.tagtype = 'default'
767                                                   AND NOT EXISTS (
768                                                       SELECT 'x'
769                                                         FROM {tag_instance} ti
770                                                        WHERE ti.tagid = tg.id
771                                                   )");
773     // cleanup tags
774     foreach ($unused_tags as $unused_tag) {
775         tag_delete($unused_tag->id);
776         //debugging('deleting unused tag #'. $unused_tag->id,  DEBUG_DEVELOPER);
777     }
778     $unused_tags->close();
781 /**
782  * Calculates and stores the correlated tags of all tags.
783  * The correlations are stored in the 'tag_correlation' table.
784  *
785  * Two tags are correlated if they appear together a lot.
786  * Ex.: Users tagged with "computers" will probably also be tagged with "algorithms".
787  *
788  * The rationale for the 'tag_correlation' table is performance.
789  * It works as a cache for a potentially heavy load query done at the 'tag_instance' table.
790  * So, the 'tag_correlation' table stores redundant information derived from the 'tag_instance' table.
791  *
792  * @param number $min_correlation cutoff percentage (optional, default is 2)
793  */
794 function tag_compute_correlations($min_correlation=2) {
795     global $DB;
797     if (!$all_tags = $DB->get_records('tag')) {
798         return;
799     }
801     $tag_correlation_obj = new object();
802     foreach($all_tags as $tag) {
804         // query that counts how many times any tag appears together in items
805         // with the tag passed as argument ($tag_id)
806         $query = "SELECT tb.tagid
807                     FROM {tag_instance} ta JOIN {tag_instance} tb ON ta.itemid = tb.itemid
808                    WHERE ta.tagid = ? AND tb.tagid <> ?
809                 GROUP BY tb.tagid
810                   HAVING COUNT(*) > ?
811                 ORDER BY COUNT(*) DESC";
812         $params = array($tag->id, $tag->id, $min_correlation);
814         $correlated = array();
816         // Correlated tags happen when they appear together in more occasions
817         // than $min_correlation.
818         if ($tag_correlations = $DB->get_records_sql($query, $params)) {
819             foreach($tag_correlations as $correlation) {
820             // commented out - now done in query. kept here in case it breaks on some db
821             // if($correlation->nr >= $min_correlation){
822                     $correlated[] = $correlation->tagid;
823             // }
824             }
825         }
827         if (empty($correlated)) {
828             continue;
829         }
831         $correlated = implode(',', $correlated);
832         //var_dump($correlated);
834         //saves correlation info in the caching table
835         if ($tag_correlation_obj = $DB->get_record('tag_correlation', array('tagid'=>$tag->id), 'tagid')) {
836             $tag_correlation_obj->correlatedtags = $correlated;
837             $DB->update_record('tag_correlation', $tag_correlation_obj);
838         } else {
839             $tag_correlation_obj->tagid          = $tag->id;
840             $tag_correlation_obj->correlatedtags = $correlated;
841             $DB->insert_record('tag_correlation', $tag_correlation_obj);
842         }
843     }
846 /**
847  * Tasks that should be performed at cron time
848  */
849 function tag_cron() {
850     tag_compute_correlations();
851     tag_cleanup();
854 /**
855  * Search for tags with names that match some text
856  *
857  * @param string $text escaped string that the tag names will be matched against
858  * @param boolean $ordered If true, tags are ordered by their popularity. If false, no ordering.
859  * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
860  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
861  * @return mixed an array of objects, or false if no records were found or an error occured.
862  */
863 function tag_find_tags($text, $ordered=true, $limitfrom='', $limitnum='') {
864     global $DB;
866     $text = array_shift(tag_normalize($text, TAG_CASE_LOWER));
868     if ($ordered) {
869         $query = "SELECT tg.id, tg.name, tg.rawname, COUNT(ti.id) AS count
870                     FROM {tag} tg LEFT JOIN {tag_instance} ti ON tg.id = ti.tagid
871                    WHERE tg.name LIKE ?
872                 GROUP BY tg.id, tg.name, tg.rawname
873                 ORDER BY count DESC";
874     } else {
875         $query = "SELECT tg.id, tg.name, tg.rawname
876                     FROM {tag} tg
877                    WHERE tg.name LIKE ?";
878     }
879     $params = array("%{$text}%");
880     return $DB->get_records_sql($query, $params, $limitfrom , $limitnum);
883 /**
884  * Get the name of a tag
885  *
886  * @param mixed $tagids the id of the tag, or an array of ids
887  * @return mixed string name of one tag, or id-indexed array of strings
888  */
889 function tag_get_name($tagids) {
890     global $DB;
892     if (!is_array($tagids)) {
893         if ($tag = $DB->get_record('tag', array('id'=>$tagids))) {
894             return $tag->name;
895         }
896         return false;
897     }
899     $tag_names = array();
900     foreach($DB->get_records_list('tag', 'id', $tagids) as $tag) {
901         $tag_names[$tag->id] = $tag->name;
902     }
904     return $tag_names;
907 /**
908  * Returns the correlated tags of a tag, retrieved from the tag_correlation
909  * table.  Make sure cron runs, otherwise the table will be empty and this
910  * function won't return anything.
911  *
912  * @param int $tag_id is a single tag id
913  * @return array an array of tag objects, empty if no correlated tags are found
914  */
915 function tag_get_correlated($tag_id, $limitnum=null) {
916     global $DB;
918     $tag_correlation = $DB->get_record('tag_correlation', array('tagid'=>$tag_id));
920     if (!$tag_correlation || empty($tag_correlation->correlatedtags)) {
921         return array();
922     }
924     // this is (and has to) return the same fields as the query in tag_get_tags
925     if ( !$result = $DB->get_records_sql("SELECT tg.id, tg.tagtype, tg.name, tg.rawname, tg.flag, ti.ordering
926                                             FROM {tag} tg INNER JOIN {tag_instance} ti ON tg.id = ti.tagid
927                                            WHERE tg.id IN ({$tag_correlation->correlatedtags})") ) {
928         return array();
929     }
931     return $result;
934 /**
935  * Function that normalizes a list of tag names.
936  *
937  * @param mixed $tags array of tags, or a single tag.
938  * @param int $case case to use for returned value (default: lower case).
939  *     Either TAG_CASE_LOWER (default) or TAG_CASE_ORIGINAL
940  * @return array of lowercased normalized tags, indexed by the normalized tag,
941  *     in the same order as the original array. (Eg: 'Banana' => 'banana').
942  */
943 function tag_normalize($rawtags, $case = TAG_CASE_LOWER) {
945     // cache normalized tags, to prevent costly repeated calls to clean_param
946     static $cleaned_tags_lc = array(); // lower case - use for comparison
947     static $cleaned_tags_mc = array(); // mixed case - use for saving to database
949     if ( !is_array($rawtags) ) {
950         $rawtags = array($rawtags);
951     }
953     $result = array();
954     foreach($rawtags as $rawtag) {
955         $rawtag = trim($rawtag);
956         if (!$rawtag) {
957             continue;
958         }
959         if ( !array_key_exists($rawtag, $cleaned_tags_lc) ) {
960             $cleaned_tags_lc[$rawtag] = moodle_strtolower( clean_param($rawtag, PARAM_TAG) );
961             $cleaned_tags_mc[$rawtag] = clean_param($rawtag, PARAM_TAG);
962         }
963         if ( $case == TAG_CASE_LOWER ) {
964             $result[$rawtag] = $cleaned_tags_lc[$rawtag];
965         } else { // TAG_CASE_ORIGINAL
966             $result[$rawtag] = $cleaned_tags_mc[$rawtag];
967         }
968     }
970     return $result;
973 /**
974  * Count how many records are tagged with a specific tag,
975  *
976  * @param string $record record to look for ('post', 'user', etc.)
977  * @param int $tag is a single tag id
978  * @return int number of mathing tags.
979  */
980 function tag_record_count($record_type, $tagid) {
981     global $DB;
982     return $DB->count_records('tag_instance', array('itemtype'=>$record_type, 'tagid'=>$tagid));
985 /**
986  * Determine if a record is tagged with a specific tag
987  *
988  * @param string $record_type the record type to look for
989  * @param int $record_id the record id to look for
990  * @param string $tag a tag name
991  * @return bool true if it is tagged, false otherwise
992  */
993 function tag_record_tagged_with($record_type, $record_id, $tag) {
994     global $DB;
995     if ($tagid = tag_get_id($tag)) {
996         return $DB->count_records('tag_instance', array('itemtype'=>$record_type, 'itemid'=>$record_id, 'tagid'=>$tagid));
997     } else {
998         return 0; // tag doesn't exist
999     }
1002 /**
1003  * Flag a tag as inapropriate
1004  *
1005  * @param mixed $tagids one (int) tagid, or an array of tagids
1006  * @return void
1007  */
1008 function tag_set_flag($tagids) {
1009     global $DB;
1011     $tagids = (array)$tagids;
1012     foreach ($tagids as $tagid) {
1013         $tag = $DB->get_record('tag', array('id'=>$tagid), 'id, flag');
1014         $tag->flag++;
1015         $tag->timemodified = time();
1016         $DB->update_record('tag', $tag);
1017     }
1020 /**
1021  * Remove the inapropriate flag on a tag
1022  *
1023  * @param mixed $tagids one (int) tagid, or an array of tagids
1024  * @return bool true if function succeeds, false otherwise
1025  */
1026 function tag_unset_flag($tagids) {
1027     global $DB;
1029     if ( is_array($tagids) ) {
1030         $tagids = implode(',', $tagids);
1031     }
1032     $timemodified = time();
1033     return $DB->execute("UPDATE {tag} SET flag = 0, timemodified = ? WHERE id IN ($tagids)", array($timemodified));