Merge branch 'MDL-28406_block_duplicate_21' of git://github.com/andyjdavis/moodle...
[moodle.git] / tag / coursetagslib.php
blobcb0e10afa5ebdf7d3695b25b91b917ea1911f2df
1 <?php
2 /**
3 * coursetagslib.php
4 * @author j.beedell@open.ac.uk July07
5 */
7 require_once $CFG->dirroot.'/tag/lib.php';
9 /**
10 * Returns an ordered array of tags associated with visible courses
11 * (boosted replacement of get_all_tags() allowing association with user and tagtype).
13 * @uses $CFG
14 * @param int $courseid, a 0 will return all distinct tags for visible courses
15 * @param int $userid optional the user id, a default of 0 will return all users tags for the course
16 * @param string $tagtype optional 'official' or 'default', empty returns both tag types
17 * @param int $numtags optional number of tags to display, default of 80 is set in the block, 0 returns all
18 * @param string $sort optional selected sorting, default is alpha sort (name) also timemodified or popularity
19 * @return array
21 function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $sort='name') {
23 global $CFG, $DB;
25 // get visible course ids
26 $courselist = array();
27 if ($courseid === 0) {
28 if ($courses = $DB->get_records_select('course', 'visible=1 AND category>0', null, '', 'id')) {
29 foreach ($courses as $key => $value) {
30 $courselist[] = $key;
35 // get tags from the db ordered by highest count first
36 $params = array();
37 $sql = "SELECT id as tkey, name, id, tagtype, rawname, f.timemodified, flag, count
38 FROM {tag} t,
39 (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
40 FROM {tag_instance}
41 WHERE itemtype = 'course' ";
43 if ($courseid > 0) {
44 $sql .= " AND itemid = :courseid ";
45 $params['courseid'] = $courseid;
46 } else {
47 if (!empty($courselist)) {
48 list($usql, $uparams) = $DB->get_in_or_equal($courselist, SQL_PARAMS_NAMED);
49 $sql .= "AND itemid $usql ";
50 $params = $params + $uparams;
54 if ($userid > 0) {
55 $sql .= " AND tiuserid = :userid ";
56 $params['userid'] = $userid;
59 $sql .= " GROUP BY tagid) f
60 WHERE t.id = f.tagid ";
61 if ($tagtype != '') {
62 $sql .= "AND tagtype = :tagtype ";
63 $params['tagtype'] = $tagtype;
65 $sql .= "ORDER BY count DESC, name ASC";
67 // limit the number of tags for output
68 if ($numtags == 0) {
69 $tags = $DB->get_records_sql($sql, $params);
70 } else {
71 $tags = $DB->get_records_sql($sql, $params, 0, $numtags);
74 // prepare the return
75 $return = array();
76 if ($tags) {
77 // sort the tag display order
78 if ($sort != 'popularity') {
79 $CFG->tagsort = $sort;
80 usort($tags, "coursetag_sort");
82 // avoid print_tag_cloud()'s ksort upsetting ordering by setting the key here
83 foreach ($tags as $value) {
84 $return[] = $value;
88 return $return;
92 /**
93 * Returns an ordered array of tags
94 * (replaces popular_tags_count() allowing sorting).
96 * @uses $CFG
97 * @param string $sort optional selected sorting, default is alpha sort (name) also timemodified or popularity
98 * @param int $numtags optional number of tags to display, default of 20 is set in the block, 0 returns all
99 * @return array
101 function coursetag_get_all_tags($sort='name', $numtags=0) {
103 global $CFG, $DB;
105 // note that this selects all tags except for courses that are not visible
106 $sql = "SELECT id, name, id, tagtype, rawname, f.timemodified, flag, count
107 FROM {tag} t,
108 (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
109 FROM {tag_instance} WHERE tagid NOT IN
110 (SELECT tagid FROM {tag_instance} ti, {course} c
111 WHERE c.visible = 0
112 AND ti.itemtype = 'course'
113 AND ti.itemid = c.id)
114 GROUP BY tagid) f
115 WHERE t.id = f.tagid
116 ORDER BY count DESC, name ASC";
117 if ($numtags == 0) {
118 $tags = $DB->get_records_sql($sql);
119 } else {
120 $tags = $DB->get_records_sql($sql, null, 0, $numtags);
123 $return = array();
124 if ($tags) {
125 if ($sort != 'popularity') {
126 $CFG->tagsort = $sort;
127 usort($tags, "coursetag_sort");
129 foreach ($tags as $value) {
130 $return[] = $value;
134 return $return;
138 * Callback function for coursetag_get_tags() and coursetag_get_all_tags() only
139 * @uses $CFG
141 function coursetag_sort($a, $b) {
142 // originally from block_blog_tags
143 global $CFG;
145 // set up the variable $tagsort as either 'name' or 'timemodified' only, 'popularity' does not need sorting
146 if (empty($CFG->tagsort)) {
147 $tagsort = 'name';
148 } else {
149 $tagsort = $CFG->tagsort;
152 if (is_numeric($a->$tagsort)) {
153 return ($a->$tagsort == $b->$tagsort) ? 0 : ($a->$tagsort > $b->$tagsort) ? 1 : -1;
154 } elseif (is_string($a->$tagsort)) {
155 return strcmp($a->$tagsort, $b->$tagsort);
156 } else {
157 return 0;
162 * Prints a tag cloud
164 * @param array $tagcloud array of tag objects (fields: id, name, rawname, count and flag)
165 * @param int $max_size maximum text size, in percentage
166 * @param int $min_size minimum text size, in percentage
167 * @param $return if true return html string
169 function coursetag_print_cloud($tagcloud, $return=false, $max_size=180, $min_size=80) {
171 global $CFG;
173 if (empty($tagcloud)) {
174 return;
177 ksort($tagcloud);
179 $count = array();
180 foreach ($tagcloud as $key => $value) {
181 if(!empty($value->count)) {
182 $count[$key] = log10($value->count);
183 } else {
184 $count[$key] = 0;
188 $max = max($count);
189 $min = min($count);
191 $spread = $max - $min;
192 if (0 == $spread) { // we don't want to divide by zero
193 $spread = 1;
196 $step = ($max_size - $min_size)/($spread);
198 $systemcontext = get_context_instance(CONTEXT_SYSTEM);
199 $can_manage_tags = has_capability('moodle/tag:manage', $systemcontext);
201 //prints the tag cloud
202 $output = '<ul class="tag-cloud inline-list">';
203 foreach ($tagcloud as $key => $tag) {
205 $size = $min_size + ((log10($tag->count) - $min) * $step);
206 $size = ceil($size);
208 $style = 'style="font-size: '.$size.'%"';
210 if ($tag->count > 1) {
211 $title = 'title="'.s(get_string('thingstaggedwith','tag', $tag)).'"';
212 } else {
213 $title = 'title="'.s(get_string('thingtaggedwith','tag', $tag)).'"';
216 $href = 'href="'.$CFG->wwwroot.'/tag/index.php?id='.$tag->id.'"';
218 //highlight tags that have been flagged as inappropriate for those who can manage them
219 $tagname = tag_display_name($tag);
220 if ($tag->flag > 0 && $can_manage_tags) {
221 $tagname = '<span class="flagged-tag">' . tag_display_name($tag) . '</span>';
224 $tag_link = '<li><a '.$href.' '.$title.' '. $style .'>'.$tagname.'</a></li> ';
226 $output .= $tag_link;
229 $output .= '</ul>'."\n";
231 if ($return) {
232 return $output;
233 } else {
234 echo $output;
239 * Returns javascript for use in tags block and supporting pages
240 * @param string $coursetagdivs comma separated divs ids
241 * @uses $CFG
243 function coursetag_get_jscript($coursetagdivs = '') {
244 global $CFG, $DB, $PAGE;
246 $PAGE->requires->js('/tag/tag.js');
247 $PAGE->requires->strings_for_js(array('jserror1', 'jserror2'), 'block_tags');
249 if ($coursetagdivs) {
250 $PAGE->requires->js_function_call('set_course_tag_divs', $coursetagdivs);
253 if ($coursetags = $DB->get_records('tag', null, 'name ASC', 'name, id')) {
254 foreach ($coursetags as $key => $value) {
255 $PAGE->requires->js_function_call('set_course_tag', array($key));
259 $PAGE->requires->js('/blocks/tags/coursetags.js');
261 return '';
265 * Returns javascript to create the links in the tag block footer.
267 function coursetag_get_jscript_links($elementid, $coursetagslinks) {
268 global $PAGE;
270 if (!empty($coursetagslinks)) {
271 foreach ($coursetagslinks as $a) {
272 $PAGE->requires->js_function_call('add_tag_footer_link', array($elementid, $a['title'], $a['onclick'], $a['text']), true);
276 return '';
280 * Returns all tags created by a user for a course
282 * @uses $CFG
283 * @param int $courseid
284 * @param int $userid
286 function coursetag_get_records($courseid, $userid) {
288 global $CFG, $DB;
290 $sql = "SELECT t.id, name, rawname
291 FROM {tag} t, {tag_instance} ti
292 WHERE t.id = ti.tagid
293 AND ti.tiuserid = :userid
294 AND ti.itemid = :courseid
295 ORDER BY name ASC";
297 return $DB->get_records_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid));
301 * Stores a tag for a course for a user
303 * @uses $CFG
304 * @param array $tags simple array of keywords to be stored
305 * @param integer $courseid
306 * @param integer $userid
307 * @param string $tagtype official or default only
308 * @param string $myurl optional for logging creation of course tags
310 function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
312 global $CFG;
314 if (is_array($tags) and !empty($tags)) {
315 foreach($tags as $tag) {
316 $tag = trim($tag);
317 if (strlen($tag) > 0) {
318 //tag_set_add('course', $courseid, $tag, $userid); //deletes official tags
320 //add tag if does not exist
321 if (!$tagid = tag_get_id($tag)) {
322 $tag_id_array = tag_add(array($tag), $tagtype);
323 $tagid = $tag_id_array[moodle_strtolower($tag)];
325 //ordering
326 $ordering = 0;
327 if ($current_ids = tag_get_tags_ids('course', $courseid)) {
328 end($current_ids);
329 $ordering = key($current_ids) + 1;
331 //set type
332 tag_type_set($tagid, $tagtype);
334 //tag_instance entry
335 tag_assign('course', $courseid, $tagid, $ordering, $userid);
337 //logging - note only for user added tags
338 if ($tagtype == 'default' and $myurl != '') {
339 $url = $myurl.'?query='.urlencode($tag);
340 add_to_log($courseid, 'coursetags', 'add', $url, 'Course tagged');
349 * Deletes a personal tag for a user for a course.
351 * @uses $CFG
352 * @param int $tagid
353 * @param int $userid
354 * @param int $courseid
356 function coursetag_delete_keyword($tagid, $userid, $courseid) {
358 global $CFG, $DB;
360 $sql = "SELECT COUNT(*)
361 FROM {tag_instance}
362 WHERE tagid = $tagid
363 AND tiuserid = $userid
364 AND itemtype = 'course'
365 AND itemid = $courseid";
366 if ($DB->count_records_sql($sql) == 1) {
367 $sql = "tagid = $tagid
368 AND tiuserid = $userid
369 AND itemtype = 'course'
370 AND itemid = $courseid";
371 $DB->delete_records_select('tag_instance', $sql);
372 // if there are no other instances of the tag then consider deleting the tag as well
373 if (!$DB->record_exists('tag_instance', array('tagid' => $tagid))) {
374 // if the tag is a personal tag then delete it - don't do official tags
375 if ($DB->record_exists('tag', array('id' => $tagid, 'tagtype' => 'default'))) {
376 $DB->delete_records('tag', array('id' => $tagid, 'tagtype' => 'default'));
379 } else {
380 print_error("errordeleting", 'tag', '', $tagid);
386 * Get courses tagged with a tag
388 * @param int $tagid
389 * @return array of course objects
391 function coursetag_get_tagged_courses($tagid) {
393 global $DB;
395 $courses = array();
396 if ($crs = $DB->get_records_select('tag_instance', "tagid=:tagid AND itemtype='course'", array('tagid'=>$tagid))) {
397 foreach ($crs as $c) {
398 //this capability check was introduced to stop display of courses that a student could not
399 //view, but arguably it is best that when clicking on a tag, the tagged course summary should
400 //be seen and then if the student clicks on that they will be given the opportunity to join
401 //note courses not visible should not have their tagid sent to this function
402 // $context = get_context_instance(CONTEXT_COURSE, $c->itemid);
403 //if (is_enrolled($context) oe is_viewing($context)) {
404 $course = $DB->get_record('course', array('id'=>$c->itemid));
405 $courses[$c->itemid] = $course;
409 return $courses;
414 * Course tagging function used only during the deletion of a
415 * course (called by lib/moodlelib.php) to clean up associated tags
417 * @param $courseid
418 * @param $showfeedback
420 function coursetag_delete_course_tags($courseid, $showfeedback=false) {
422 global $DB, $OUTPUT;
424 if ($tags = $DB->get_records_select('tag_instance', "itemtype='course' AND itemid=:courseid", array('courseid'=>$courseid))) {
425 foreach ($tags as $tag) {
426 //delete the course tag instance record
427 $DB->delete_records('tag_instance', array('tagid'=>$tag->tagid, 'itemtype'=>'course', 'itemid'=> $courseid));
428 // delete tag if there are no other tag_instance entries now
429 if (!($DB->record_exists('tag_instance', array('tagid'=>$tag->tagid)))) {
430 $DB->delete_records('tag', array('id'=>$tag->tagid));
435 if ($showfeedback) {
436 echo $OUTPUT->notification(get_string('deletedcoursetags', 'tag'));
441 * Function called by cron to create/update users rss feeds
443 * @uses $CFG
444 * @return true
446 * Function removed.
447 * rsslib.php needs updating to accept Dublin Core tags (dc/cc) input before this can work.
450 function coursetag_rss_feeds() {
452 global $CFG, $DB;
453 require_once($CFG->dirroot.'/lib/dmllib.php');
454 require_once($CFG->dirroot.'/lib/rsslib.php');
456 $status = true;
457 mtrace(' Preparing to update all user unit tags RSS feeds');
458 if (empty($CFG->enablerssfeeds)) {
459 mtrace(' RSS DISABLED (admin variables - enablerssfeeds)');
460 } else {
462 // Load all the categories for use later on
463 $categories = $DB->get_records('course_categories');
465 // get list of users who have tagged a unit
466 $sql = "
467 SELECT DISTINCT u.id as userid, u.username, u.firstname, u.lastname, u.email
468 FROM {user} u, {course} c, {tag_instance} cti, {tag} t
469 WHERE c.id = cti.itemid
470 AND u.id = cti.tiuserid
471 AND t.id = cti.tagid
472 AND t.tagtype = 'personal'
473 AND u.confirmed = 1
474 AND u.deleted = 0
475 ORDER BY userid";
476 if ($users = $DB->get_records_sql($sql)) {
478 $items = array(); //contains rss data items for each user
479 foreach ($users as $user) {
481 // loop through each user, getting the data (tags for courses)
482 $sql = "
483 SELECT cti.id, c.id as courseid, c.fullname, c.shortname, c.category, t.rawname, cti.timemodified
484 FROM {course} c, {tag_instance} cti, {tag} t
485 WHERE c.id = cti.itemid
486 AND cti.tiuserid = :userid{$user->userid}
487 AND cti.tagid = t.id
488 AND t.tagtype = 'personal'
489 ORDER BY courseid";
490 if ($usertags = $DB->get_records_sql($sql, array('userid' => $user->userid))) {
491 $latest_date = 0; //latest date any tag was created by a user
492 $c = 0; //course identifier
494 foreach ($usertags as $usertag) {
495 if ($usertag->courseid != $c) {
496 $c = $usertag->courseid;
497 $items[$c] = new stdClass();
498 $items[$c]->title = $usertag->fullname . '(' . $usertag->shortname . ')';
499 $items[$c]->link = $CFG->wwwroot . '/course/view.php?name=' . $usertag->shortname;
500 $items[$c]->description = ''; //needs to be blank
501 $items[$c]->category = $categories[$usertag->category]->name;
502 $items[$c]->subject[] = $usertag->rawname;
503 $items[$c]->pubdate = $usertag->timemodified;
504 $items[$c]->tag = true;
505 } else {
506 $items[$c]->subject[] .= $usertag->rawname;
508 // Check and set the latest modified date.
509 $latest_date = $usertag->timemodified > $latest_date ? $usertag->timemodified : $latest_date;
512 // Setup some vars for use while creating the file
513 $path = $CFG->dataroot.'/1/usertagsrss/'.$user->userid;
514 $file_name = 'user_unit_tags_rss.xml';
515 $title = get_string('rsstitle', 'tag', ucwords(strtolower($user->firstname.' '.$user->lastname)));
516 $desc = get_string('rssdesc', 'tag');
517 // check that the path exists
518 if (!file_exists($path)) {
519 mtrace(' Creating folder '.$path);
520 check_dir_exists($path, TRUE, TRUE);
523 // create or update the feed for the user
524 // this functionality can be copied into seperate lib as in next two lines
525 //require_once($CFG->dirroot.'/local/ocilib.php');
526 //oci_create_rss_feed( $path, $file_name, $latest_date, $items, $title, $desc, $dc=true, $cc=false);
528 // Set path to RSS file
529 $full_path = "$save_path/$file_name";
531 mtrace(" Preparing to update RSS feed for $file_name");
533 // First let's make sure there is work to do by checking the time the file was last modified,
534 // if a course was update after the file was mofified
535 if (file_exists($full_path)) {
536 if ($lastmodified = filemtime($full_path)) {
537 mtrace(" XML File $file_name Created on ".date( "D, j M Y G:i:s T", $lastmodified ));
538 mtrace(' Lastest course modification on '.date( "D, j M Y G:i:s T", $latest_date ));
539 if ($latest_date > $lastmodified) {
540 mtrace(" XML File $file_name needs updating");
541 $changes = true;
542 } else {
543 mtrace(" XML File $file_name doesn't need updating");
544 $changes = false;
547 } else {
548 mtrace(" XML File $file_name needs updating");
549 $changes = true;
552 if ($changes) {
553 // Now we know something has changed, write the new file
555 if (!empty($items)) {
556 // First set rss feeds common headers
557 $header = rss_standard_header(strip_tags(format_string($title,true)),
558 $CFG->wwwroot,
559 $desc,
560 true, true);
561 // Now all the rss items
562 if (!empty($header)) {
563 $articles = rss_add_items($items,$dc,$cc);
565 // Now all rss feeds common footers
566 if (!empty($header) && !empty($articles)) {
567 $footer = rss_standard_footer();
569 // Now, if everything is ok, concatenate it
570 if (!empty($header) && !empty($articles) && !empty($footer)) {
571 $result = $header.$articles.$footer;
572 } else {
573 $result = false;
575 } else {
576 $result = false;
579 // Save the XML contents to file
580 if (!empty($result)) {
581 $rss_file = fopen($full_path, "w");
582 if ($rss_file) {
583 $status = fwrite ($rss_file, $result);
584 fclose($rss_file);
585 } else {
586 $status = false;
590 // Output result
591 if (empty($result)) {
592 // There was nothing to put into the XML file. Delete it!
593 if( is_file($full_path) ) {
594 mtrace(" There were no items for XML File $file_name. Deleting XML File");
595 unlink($full_path);
596 mtrace(" $full_path -> (deleted)");
597 } else {
598 mtrace(" There were no items for the XML File $file_name and no file to delete. Ignore.");
600 } else {
601 if (!empty($status)) {
602 mtrace(" $full_path -> OK");
603 } else {
604 mtrace(" $full_path -> FAILED");
608 //end of oci_create_rss_feed()
614 return $status;
619 * Get official keywords for the <meta name="keywords"> in header.html
620 * use: echo '<meta name="keywords" content="'.coursetag_get_official_keywords($COURSE->id).'"/>';
621 * @uses $CFG
622 * @param int $courseid
623 * @return string
625 * Function removed but fully working
626 * This function is potentially useful to anyone wanting to improve search results for course pages.
627 * The idea is to add official tags (not personal tags to prevent their deletion) to all
628 * courses (facility not added yet) which will be automatically added to the page header to boost
629 * search engine specificity/ratings.
632 function coursetag_get_official_keywords($courseid, $asarray=false) {
633 global $CFG;
634 $returnstr = '';
635 $sql = "SELECT t.id, name, rawname
636 FROM {tag} t, {tag_instance} ti
637 WHERE ti.itemid = :courseid
638 AND ti.itemtype = 'course'
639 AND t.tagtype = 'official'
640 AND ti.tagid = t.id
641 ORDER BY name ASC";
642 if ($tags = $DB->get_records_sql($sql, array('courseid' => $courseid))) {
643 if ($asarray) {
644 return $tags;
646 foreach ($tags as $tag) {
647 if( empty($CFG->keeptagnamecase) ) {
648 $textlib = textlib_get_instance();
649 $name = $textlib->strtotitle($tag->name);
650 } else {
651 $name = $tag->rawname;
653 $returnstr .= $name.', ';
655 $returnstr = rtrim($returnstr, ', ');
657 return $returnstr;