mod/glossary/lib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Library of functions and constants for module glossary
  20  * (replace glossary with the name of your module and delete this line)
  21  *
  22  * @package   mod-glossary
  23  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25  */
  26
  27
  28 define("GLOSSARY_SHOW_ALL_CATEGORIES", 0);
  29 define("GLOSSARY_SHOW_NOT_CATEGORISED", -1);
  30
  31 define("GLOSSARY_NO_VIEW", -1);
  32 define("GLOSSARY_STANDARD_VIEW", 0);
  33 define("GLOSSARY_CATEGORY_VIEW", 1);
  34 define("GLOSSARY_DATE_VIEW", 2);
  35 define("GLOSSARY_AUTHOR_VIEW", 3);
  36 define("GLOSSARY_ADDENTRY_VIEW", 4);
  37 define("GLOSSARY_IMPORT_VIEW", 5);
  38 define("GLOSSARY_EXPORT_VIEW", 6);
  39 define("GLOSSARY_APPROVAL_VIEW", 7);
  40
  41 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
  42 /**
  43  * @global object
  44  * @param object $glossary
  45  * @return int
  46  */
  47 function glossary_add_instance($glossary) {
  48     global $DB;
  49 /// Given an object containing all the necessary data,
  50 /// (defined by the form in mod_form.php) this function
  51 /// will create a new instance and return the id number
  52 /// of the new instance.
  53
  54     if (empty($glossary->userating)) {
  55         $glossary->assessed = 0;
  56     }
  57
  58     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
  59         $glossary->assesstimestart  = 0;
  60         $glossary->assesstimefinish = 0;
  61     }
  62
  63     if (empty($glossary->globalglossary) ) {
  64         $glossary->globalglossary = 0;
  65     }
  66
  67     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
  68         $glossary->globalglossary = 0;
  69     }
  70
  71     $glossary->timecreated  = time();
  72     $glossary->timemodified = $glossary->timecreated;
  73
  74     //Check displayformat is a valid one
  75     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
  76     if (!in_array($glossary->displayformat, $formats)) {
  77         print_error('unknowformat', '', '', $glossary->displayformat);
  78     }
  79
  80     $returnid = $DB->insert_record("glossary", $glossary);
  81     $glossary->id = $returnid;
  82     glossary_grade_item_update($glossary);
  83
  84     return $returnid;
  85 }
  86
  87 /**
  88  * Given an object containing all the necessary data,
  89  * (defined by the form in mod_form.php) this function
  90  * will update an existing instance with new data.
  91  *
  92  * @global object
  93  * @global object
  94  * @param object $glossary
  95  * @return bool
  96  */
  97 function glossary_update_instance($glossary) {
  98     global $CFG, $DB;
  99
 100     if (empty($glossary->globalglossary)) {
 101         $glossary->globalglossary = 0;
 102     }
 103
 104     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
 105         // keep previous
 106         unset($glossary->globalglossary);
 107     }
 108
 109     $glossary->timemodified = time();
 110     $glossary->id           = $glossary->instance;
 111
 112     //if (empty($glossary->userating)) {
 113 //        $glossary->assessed = 0;
 114   //  }
 115
 116     if (empty($glossary->ratingtime) or empty($glossary->assessed)) {
 117         $glossary->assesstimestart  = 0;
 118         $glossary->assesstimefinish = 0;
 119     }
 120
 121     //Check displayformat is a valid one
 122     $formats = get_list_of_plugins('mod/glossary/formats','TEMPLATE');
 123     if (!in_array($glossary->displayformat, $formats)) {
 124         print_error('unknowformat', '', '', $glossary->displayformat);
 125     }
 126
 127     $return = $DB->update_record("glossary", $glossary);
 128     if ($glossary->defaultapproval) {
 129         $DB->execute("UPDATE {glossary_entries} SET approved = 1 where approved <> 1 and glossaryid = ?", array($glossary->id));
 130     }
 131     glossary_grade_item_update($glossary);
 132
 133     return $return;
 134 }
 135
 136 /**
 137  * Given an ID of an instance of this module,
 138  * this function will permanently delete the instance
 139  * and any data that depends on it.
 140  *
 141  * @global object
 142  * @param int $id glossary id
 143  * @return bool success
 144  */
 145 function glossary_delete_instance($id) {
 146     global $DB;
 147
 148     if (!$glossary = $DB->get_record('glossary', array('id'=>$id))) {
 149         return false;
 150     }
 151
 152     if (!$cm = get_coursemodule_from_instance('glossary', $id)) {
 153         return false;
 154     }
 155
 156     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
 157         return false;
 158     }
 159
 160     $fs = get_file_storage();
 161
 162     if ($glossary->mainglossary) {
 163         // unexport entries
 164         $sql = "SELECT ge.id, ge.sourceglossaryid, cm.id AS sourcecmid
 165                   FROM {glossary_entries} ge
 166                   JOIN {modules} m ON m.name = 'glossary'
 167                   JOIN {course_modules} cm ON (cm.module = m.id AND cm.instance = ge.sourceglossaryid)
 168                  WHERE ge.glossaryid = ? AND ge.sourceglossaryid > 0";
 169
 170         if ($exported = $DB->get_records_sql($sql, array($id))) {
 171             foreach ($exported as $entry) {
 172                 $entry->glossaryid = $entry->sourceglossaryid;
 173                 $entry->sourceglossaryid = 0;
 174                 $newcontext = get_context_instance(CONTEXT_MODULE, $entry->sourcecmid);
 175                 if ($oldfiles = $fs->get_area_files($context->id, 'glossary_attachment', $entry->id)) {
 176                     foreach ($oldfiles as $oldfile) {
 177                         $file_record = new object();
 178                         $file_record->contextid = $newcontext->id;
 179                         $fs->create_file_from_storedfile($file_record, $oldfile);
 180                     }
 181                     $fs->delete_area_files($context->id, 'glossary_attachment', $entry->id);
 182                     $entry->attachment = '1';
 183                 } else {
 184                     $entry->attachment = '0';
 185                 }
 186                 $DB->update_record('glossary_entries', $entry);
 187             }
 188         }
 189     } else {
 190         // move exported entries to main glossary
 191         $sql = "UPDATE {glossary_entries}
 192                    SET sourceglossaryid = 0
 193                  WHERE sourceglossaryid = ?";
 194         $DB->execute($sql, array($id));
 195     }
 196
 197     // Delete any dependent records
 198     $entry_select = "SELECT id FROM {glossary_entries} WHERE glossaryid = ?";
 199     $DB->delete_records_select('comments', "contextid={$context->id} AND commentarea='glossary_entry' AND itemid IN ($entry_select)", array($id));
 200     $DB->delete_records_select('glossary_alias',    "entryid IN ($entry_select)", array($id));
 201     $DB->delete_records_select('glossary_ratings',  "entryid IN ($entry_select)", array($id));
 202
 203     $category_select = "SELECT id FROM {glossary_categories} WHERE glossaryid = ?";
 204     $DB->delete_records_select('glossary_entries_categories', "categoryid IN ($category_select)", array($id));
 205     $DB->delete_records('glossary_categories', array('glossaryid'=>$id));
 206
 207     // delete all files
 208     $fs->delete_area_files($context->id);
 209
 210     glossary_grade_item_delete($glossary);
 211
 212     return $DB->delete_records('glossary', array('id'=>$id));
 213 }
 214
 215 /**
 216  * Return a small object with summary information about what a
 217  * user has done with a given particular instance of this module
 218  * Used for user activity reports.
 219  * $return->time = the time they did it
 220  * $return->info = a short text description
 221  *
 222  * @param object $course
 223  * @param object $user
 224  * @param object $mod
 225  * @param object $glossary
 226  * @return object|null
 227  */
 228 function glossary_user_outline($course, $user, $mod, $glossary) {
 229     global $CFG;
 230
 231     require_once("$CFG->libdir/gradelib.php");
 232     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
 233     if (empty($grades->items[0]->grades)) {
 234         $grade = false;
 235     } else {
 236         $grade = reset($grades->items[0]->grades);
 237     }
 238
 239     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
 240         $result = new object();
 241         $result->info = count($entries) . ' ' . get_string("entries", "glossary");
 242
 243         $lastentry = array_pop($entries);
 244         $result->time = $lastentry->timemodified;
 245
 246         if ($grade) {
 247             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
 248         }
 249         return $result;
 250     } else if ($grade) {
 251         $result = new object();
 252         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
 253         $result->time = $grade->dategraded;
 254         return $result;
 255     }
 256     return NULL;
 257 }
 258
 259 /**
 260  * @global object
 261  * @param int $glossaryid
 262  * @param int $userid
 263  * @return array
 264  */
 265 function glossary_get_user_entries($glossaryid, $userid) {
 266 /// Get all the entries for a user in a glossary
 267     global $DB;
 268
 269     return $DB->get_records_sql("SELECT e.*, u.firstname, u.lastname, u.email, u.picture
 270                                    FROM {glossary} g, {glossary_entries} e, {user} u
 271                              WHERE g.id = ?
 272                                AND e.glossaryid = g.id
 273                                AND e.userid = ?
 274                                AND e.userid = u.id
 275                           ORDER BY e.timemodified ASC", array($glossaryid, $userid));
 276 }
 277
 278 /**
 279  * Print a detailed representation of what a  user has done with
 280  * a given particular instance of this module, for user activity reports.
 281  *
 282  * @global object
 283  * @param object $course
 284  * @param object $user
 285  * @param object $mod
 286  * @param object $glossary
 287  */
 288 function glossary_user_complete($course, $user, $mod, $glossary) {
 289     global $CFG, $OUTPUT;
 290     require_once("$CFG->libdir/gradelib.php");
 291
 292     $grades = grade_get_grades($course->id, 'mod', 'glossary', $glossary->id, $user->id);
 293     if (!empty($grades->items[0]->grades)) {
 294         $grade = reset($grades->items[0]->grades);
 295         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
 296         if ($grade->str_feedback) {
 297             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
 298         }
 299     }
 300
 301     if ($entries = glossary_get_user_entries($glossary->id, $user->id)) {
 302         echo '<table width="95%" border="0"><tr><td>';
 303         foreach ($entries as $entry) {
 304             $cm = get_coursemodule_from_instance("glossary", $glossary->id, $course->id);
 305             glossary_print_entry($course, $cm, $glossary, $entry,"","",0);
 306             echo '<p>';
 307         }
 308         echo '</td></tr></table>';
 309     }
 310 }
 311 /**
 312  * Given a course and a time, this module should find recent activity
 313  * that has occurred in glossary activities and print it out.
 314  * Return true if there was output, or false is there was none.
 315  *
 316  * @global object
 317  * @global object
 318  * @global object
 319  * @param object $course
 320  * @param object $viewfullnames
 321  * @param int $timestart
 322  * @return bool
 323  */
 324 function glossary_print_recent_activity($course, $viewfullnames, $timestart) {
 325     global $CFG, $USER, $DB, $OUTPUT;
 326
 327     //TODO: use timestamp in approved field instead of changing timemodified when approving in 2.0
 328
 329     $modinfo = get_fast_modinfo($course);
 330     $ids = array();
 331     foreach ($modinfo->cms as $cm) {
 332         if ($cm->modname != 'glossary') {
 333             continue;
 334         }
 335         if (!$cm->uservisible) {
 336             continue;
 337         }
 338         $ids[$cm->instance] = $cm->instance;
 339     }
 340
 341     if (!$ids) {
 342         return false;
 343     }
 344
 345     $glist = implode(',', $ids); // there should not be hundreds of glossaries in one course, right?
 346
 347     if (!$entries = $DB->get_records_sql("SELECT ge.id, ge.concept, ge.approved, ge.timemodified, ge.glossaryid,
 348                                                  ge.userid, u.firstname, u.lastname, u.email, u.picture
 349                                             FROM {glossary_entries} ge
 350                                             JOIN {user} u ON u.id = ge.userid
 351                                            WHERE ge.glossaryid IN ($glist) AND ge.timemodified > ?
 352                                         ORDER BY ge.timemodified ASC", array($timestart))) {
 353         return false;
 354     }
 355
 356     $editor  = array();
 357
 358     foreach ($entries as $entryid=>$entry) {
 359         if ($entry->approved) {
 360             continue;
 361         }
 362
 363         if (!isset($editor[$entry->glossaryid])) {
 364             $editor[$entry->glossaryid] = has_capability('mod/glossary:approve', get_context_instance(CONTEXT_MODULE, $modinfo->instances['glossary'][$entry->glossaryid]->id));
 365         }
 366
 367         if (!$editor[$entry->glossaryid]) {
 368             unset($entries[$entryid]);
 369         }
 370     }
 371
 372     if (!$entries) {
 373         return false;
 374     }
 375     echo $OUTPUT->heading(get_string('newentries', 'glossary').':');
 376
 377     $strftimerecent = get_string('strftimerecent');
 378     foreach ($entries as $entry) {
 379         $link = $CFG->wwwroot.'/mod/glossary/view.php?g='.$entry->glossaryid.'&amp;mode=entry&amp;hook='.$entry->id;
 380         if ($entry->approved) {
 381             $dimmed = '';
 382         } else {
 383             $dimmed = ' dimmed_text';
 384         }
 385         echo '<div class="head'.$dimmed.'">';
 386         echo '<div class="date">'.userdate($entry->timemodified, $strftimerecent).'</div>';
 387         echo '<div class="name">'.fullname($entry, $viewfullnames).'</div>';
 388         echo '</div>';
 389         echo '<div class="info"><a href="'.$link.'">'.format_text($entry->concept, true).'</a></div>';
 390     }
 391
 392     return true;
 393 }
 394
 395 /**
 396  * @global object
 397  * @param object $log
 398  */
 399 function glossary_log_info($log) {
 400     global $DB;
 401
 402     return $DB->get_record_sql("SELECT e.*, u.firstname, u.lastname
 403                                   FROM {glossary_entries} e, {user} u
 404                                  WHERE e.id = ? AND u.id = ?", array($log->info, $log->userid));
 405 }
 406
 407 /**
 408  * Function to be run periodically according to the moodle cron
 409  * This function searches for things that need to be done, such
 410  * as sending out mail, toggling flags etc ...
 411  * @return bool
 412  */
 413 function glossary_cron () {
 414     return true;
 415 }
 416
 417 /**
 418  * Return grade for given user or all users.
 419  *
 420  * @global object
 421  * @param int $glossaryid id of glossary
 422  * @param int $userid optional user id, 0 means all users
 423  * @return array array of grades, false if none
 424  */
 425 function glossary_get_user_grades($glossary, $userid=0) {
 426     /*global $DB;
 427
 428     $params = array('userid'=>$userid, 'gid'=>$glossary->id);
 429
 430     $user = $userid ? "AND u.id = :userid" : "";
 431
 432     $sql = "SELECT u.id, u.id AS userid, avg(gr.rating) AS rawgrade
 433               FROM {user} u, {glossary_entries} ge, {glossary_ratings} gr
 434              WHERE u.id = ge.userid AND ge.id = gr.entryid
 435                    AND gr.userid != u.id AND ge.glossaryid = :gid
 436                    $user
 437           GROUP BY u.id";
 438
 439     return $DB->get_records_sql($sql, $params);*/
 440     global $CFG;
 441
 442     require_once($CFG->dirroot.'/rating/lib.php');
 443     $rm = new rating_manager();
 444
 445     $ratingoptions = new stdclass();
 446
 447     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
 448     $ratingoptions->modulename = 'glossary';
 449     $ratingoptions->moduleid   = $glossary->id;
 450
 451     $ratingoptions->userid = $userid;
 452     $ratingoptions->aggregationmethod = $glossary->assessed;
 453     $ratingoptions->scaleid = $glossary->scale;
 454     $ratingoptions->itemtable = 'glossary_entries';
 455     $ratingoptions->itemtableusercolumn = 'userid';
 456
 457     return $rm->get_user_grades($ratingoptions);
 458 }
 459
 460 /**
 461  * Return rating related permissions
 462  * @param string $options the context id
 463  * @return array an associative array of the user's rating permissions
 464  */
 465 function glossary_rating_permissions($options) {
 466     $contextid = $options;
 467     $context = get_context_instance_by_id($contextid);
 468
 469     if (!$context) {
 470         print_error('invalidcontext');
 471         return null;
 472     } else {
 473         return array('view'=>has_capability('mod/glossary:viewrating',$context), 'viewany'=>has_capability('mod/glossary:viewanyrating',$context), 'viewall'=>has_capability('mod/glossary:viewallratings',$context), 'rate'=>has_capability('mod/glossary:rate',$context));
 474     }
 475 }
 476
 477 /**
 478  * Returns the names of the table and columns necessary to check items for ratings
 479  * @return array an array containing the item table, item id and user id columns
 480  */
 481 function glossary_rating_item_check_info() {
 482     return array('glossary_entries','id','userid');
 483 }
 484
 485 /**
 486  * Update activity grades
 487  *
 488  * @global object
 489  * @global object
 490  * @param object $glossary null means all glossaries (with extra cmidnumber property)
 491  * @param int $userid specific user only, 0 means all
 492  */
 493 function glossary_update_grades($glossary=null, $userid=0, $nullifnone=true) {
 494     global $CFG, $DB;
 495     require_once($CFG->libdir.'/gradelib.php');
 496
 497     if (!$glossary->assessed) {
 498         glossary_grade_item_update($glossary);
 499
 500     } else if ($grades = glossary_get_user_grades($glossary, $userid)) {
 501         glossary_grade_item_update($glossary, $grades);
 502
 503     } else if ($userid and $nullifnone) {
 504         $grade = new object();
 505         $grade->userid   = $userid;
 506         $grade->rawgrade = NULL;
 507         glossary_grade_item_update($glossary, $grade);
 508
 509     } else {
 510         glossary_grade_item_update($glossary);
 511     }
 512 }
 513
 514 /**
 515  * Update all grades in gradebook.
 516  *
 517  * @global object
 518  */
 519 function glossary_upgrade_grades() {
 520     global $DB;
 521
 522     $sql = "SELECT COUNT('x')
 523               FROM {glossary} g, {course_modules} cm, {modules} m
 524              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
 525     $count = $DB->count_records_sql($sql);
 526
 527     $sql = "SELECT g.*, cm.idnumber AS cmidnumber, g.course AS courseid
 528               FROM {glossary} g, {course_modules} cm, {modules} m
 529              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id";
 530     if ($rs = $DB->get_recordset_sql($sql)) {
 531         $pbar = new progress_bar('glossaryupgradegrades', 500, true);
 532         $i=0;
 533         foreach ($rs as $glossary) {
 534             $i++;
 535             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
 536             glossary_update_grades($glossary, 0, false);
 537             $pbar->update($i, $count, "Updating Glossary grades ($i/$count).");
 538         }
 539         $rs->close();
 540     }
 541 }
 542
 543 /**
 544  * Create/update grade item for given glossary
 545  *
 546  * @global object
 547  * @param object $glossary object with extra cmidnumber
 548  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
 549  * @return int, 0 if ok, error code otherwise
 550  */
 551 function glossary_grade_item_update($glossary, $grades=NULL) {
 552     global $CFG;
 553     require_once($CFG->libdir.'/gradelib.php');
 554
 555     $params = array('itemname'=>$glossary->name, 'idnumber'=>$glossary->cmidnumber);
 556
 557     if (!$glossary->assessed or $glossary->scale == 0) {
 558         $params['gradetype'] = GRADE_TYPE_NONE;
 559
 560     } else if ($glossary->scale > 0) {
 561         $params['gradetype'] = GRADE_TYPE_VALUE;
 562         $params['grademax']  = $glossary->scale;
 563         $params['grademin']  = 0;
 564
 565     } else if ($glossary->scale < 0) {
 566         $params['gradetype'] = GRADE_TYPE_SCALE;
 567         $params['scaleid']   = -$glossary->scale;
 568     }
 569
 570     if ($grades  === 'reset') {
 571         $params['reset'] = true;
 572         $grades = NULL;
 573     }
 574
 575     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, $grades, $params);
 576 }
 577
 578 /**
 579  * Delete grade item for given glossary
 580  *
 581  * @global object
 582  * @param object $glossary object
 583  */
 584 function glossary_grade_item_delete($glossary) {
 585     global $CFG;
 586     require_once($CFG->libdir.'/gradelib.php');
 587
 588     return grade_update('mod/glossary', $glossary->course, 'mod', 'glossary', $glossary->id, 0, NULL, array('deleted'=>1));
 589 }
 590
 591 /**
 592  * Returns the users with data in one glossary
 593  * (users with records in glossary_entries, students)
 594  *
 595  * @global object
 596  * @param int $glossaryid
 597  * @return array
 598  */
 599 function glossary_get_participants($glossaryid) {
 600     global $DB;
 601
 602     //Get students
 603     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
 604                                         FROM {user} u, {glossary_entries} g
 605                                  WHERE g.glossaryid = ? AND u.id = g.userid", array($glossaryid));
 606
 607     //Return students array (it contains an array of unique users)
 608     return $students;
 609 }
 610
 611 /**
 612  * @global object
 613  * @param int $gloassryid
 614  * @param int $scaleid
 615  * @return bool
 616  */
 617 function glossary_scale_used ($glossaryid,$scaleid) {
 618 //This function returns if a scale is being used by one glossary
 619     global $DB;
 620
 621     $return = false;
 622
 623     $rec = $DB->get_record("glossary", array("id"=>$glossaryid, "scale"=>-$scaleid));
 624
 625     if (!empty($rec)  && !empty($scaleid)) {
 626         $return = true;
 627     }
 628
 629     return $return;
 630 }
 631
 632 /**
 633  * Checks if scale is being used by any instance of glossary
 634  *
 635  * This is used to find out if scale used anywhere
 636  *
 637  * @global object
 638  * @param int $scaleid
 639  * @return boolean True if the scale is used by any glossary
 640  */
 641 function glossary_scale_used_anywhere($scaleid) {
 642     global $DB;
 643
 644     if ($scaleid and $DB->record_exists('glossary', array('scale'=>-$scaleid))) {
 645         return true;
 646     } else {
 647         return false;
 648     }
 649 }
 650
 651 //////////////////////////////////////////////////////////////////////////////////////
 652 /// Any other glossary functions go here.  Each of them must have a name that
 653 /// starts with glossary_
 654
 655 /**
 656  * This function return an array of valid glossary_formats records
 657  * Everytime it's called, every existing format is checked, new formats
 658  * are included if detected and old formats are deleted and any glossary
 659  * using an invalid format is updated to the default (dictionary).
 660  *
 661  * @global object
 662  * @global object
 663  * @return array
 664  */
 665 function glossary_get_available_formats() {
 666     global $CFG, $DB;
 667
 668     //Get available formats (plugin) and insert (if necessary) them into glossary_formats
 669     $formats = get_list_of_plugins('mod/glossary/formats', 'TEMPLATE');
 670     $pluginformats = array();
 671     foreach ($formats as $format) {
 672         //If the format file exists
 673         if (file_exists($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php')) {
 674             include_once($CFG->dirroot.'/mod/glossary/formats/'.$format.'/'.$format.'_format.php');
 675             //If the function exists
 676             if (function_exists('glossary_show_entry_'.$format)) {
 677                 //Acummulate it as a valid format
 678                 $pluginformats[] = $format;
 679                 //If the format doesn't exist in the table
 680                 if (!$rec = $DB->get_record('glossary_formats', array('name'=>$format))) {
 681                     //Insert the record in glossary_formats
 682                     $gf = new object();
 683                     $gf->name = $format;
 684                     $gf->popupformatname = $format;
 685                     $gf->visible = 1;
 686                     $DB->insert_record("glossary_formats",$gf);
 687                 }
 688             }
 689         }
 690     }
 691
 692     //Delete non_existent formats from glossary_formats table
 693     $formats = $DB->get_records("glossary_formats");
 694     foreach ($formats as $format) {
 695         $todelete = false;
 696         //If the format in DB isn't a valid previously detected format then delete the record
 697         if (!in_array($format->name,$pluginformats)) {
 698             $todelete = true;
 699         }
 700
 701         if ($todelete) {
 702             //Delete the format
 703             $DB->delete_records('glossary_formats', array('name'=>$format->name));
 704             //Reasign existing glossaries to default (dictionary) format
 705             if ($glossaries = $DB->get_records('glossary', array('displayformat'=>$format->name))) {
 706                 foreach($glossaries as $glossary) {
 707                     $DB->set_field('glossary','displayformat','dictionary', array('id'=>$glossary->id));
 708                 }
 709             }
 710         }
 711     }
 712
 713     //Now everything is ready in glossary_formats table
 714     $formats = $DB->get_records("glossary_formats");
 715
 716     return $formats;
 717 }
 718
 719 /**
 720  * @param bool $debug
 721  * @param string $text
 722  * @param int $br
 723  */
 724 function glossary_debug($debug,$text,$br=1) {
 725     if ( $debug ) {
 726         echo '<font color="red">' . $text . '</font>';
 727         if ( $br ) {
 728             echo '<br />';
 729         }
 730     }
 731 }
 732
 733 /**
 734  *
 735  * @global object
 736  * @param int $glossaryid
 737  * @param string $entrylist
 738  * @param string $pivot
 739  * @return array
 740  */
 741 function glossary_get_entries($glossaryid, $entrylist, $pivot = "") {
 742     global $DB;
 743     if ($pivot) {
 744        $pivot .= ",";
 745     }
 746
 747     return $DB->get_records_sql("SELECT $pivot id,userid,concept,definition,format
 748                                    FROM {glossary_entries}
 749                                   WHERE glossaryid = ?
 750                                         AND id IN ($entrylist)", array($glossaryid));
 751 }
 752
 753 /**
 754  * @global object
 755  * @global object
 756  * @param object $concept
 757  * @param string $courseid
 758  * @return array
 759  */
 760 function glossary_get_entries_search($concept, $courseid) {
 761     global $CFG, $DB;
 762
 763     //Check if the user is an admin
 764     $bypassadmin = 1; //This means NO (by default)
 765     if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_SYSTEM))) {
 766         $bypassadmin = 0; //This means YES
 767     }
 768
 769     //Check if the user is a teacher
 770     $bypassteacher = 1; //This means NO (by default)
 771     if (has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $courseid))) {
 772         $bypassteacher = 0; //This means YES
 773     }
 774
 775     $conceptlower = moodle_strtolower(trim($concept));
 776
 777     $params = array('courseid1'=>$courseid, 'courseid2'=>$courseid, 'conceptlower'=>$conceptlower, 'concept'=>$concept);
 778
 779     return $DB->get_records_sql("SELECT e.*, g.name as glossaryname, cm.id as cmid, cm.course as courseid
 780                                    FROM {glossary_entries} e, {glossary} g,
 781                                         {course_modules} cm, {modules} m
 782                                   WHERE m.name = 'glossary' AND
 783                                         cm.module = m.id AND
 784                                         (cm.visible = 1 OR  cm.visible = $bypassadmin OR
 785                                             (cm.course = :courseid1 AND cm.visible = $bypassteacher)) AND
 786                                         g.id = cm.instance AND
 787                                         e.glossaryid = g.id  AND
 788                                         ( (e.casesensitive != 0 AND LOWER(concept) = :conceptlower) OR
 789                                           (e.casesensitive = 0 and concept = :concept)) AND
 790                                         (g.course = courseid2 OR g.globalglossary = 1) AND
 791                                          e.usedynalink != 0 AND
 792                                          g.usedynalink != 0", $params);
 793 }
 794
 795 /**
 796  * @global object
 797  * @global object
 798  * @param object $course
 799  * @param object $course
 800  * @param object $glossary
 801  * @param object $entry
 802  * @param string $mode
 803  * @param string $hook
 804  * @param int $printicons
 805  * @param int $displayformat
 806  * @param bool $printview
 807  * @return mixed
 808  */
 809 function glossary_print_entry($course, $cm, $glossary, $entry, $mode='',$hook='',$printicons = 1, $displayformat  = -1, $printview = false) {
 810     global $USER, $CFG;
 811     $return = false;
 812     if ( $displayformat < 0 ) {
 813         $displayformat = $glossary->displayformat;
 814     }
 815     if ($entry->approved or ($USER->id == $entry->userid) or ($mode == 'approval' and !$entry->approved) ) {
 816         $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
 817         if ($printview) {
 818             $functionname = 'glossary_print_entry_'.$displayformat;
 819         } else {
 820             $functionname = 'glossary_show_entry_'.$displayformat;
 821         }
 822
 823         if (file_exists($formatfile)) {
 824             include_once($formatfile);
 825             if (function_exists($functionname)) {
 826                 $return = $functionname($course, $cm, $glossary, $entry,$mode,$hook,$printicons);
 827             } else if ($printview) {
 828                 //If the glossary_print_entry_XXXX function doesn't exist, print default (old) print format
 829                 $return = glossary_print_entry_default($entry, $glossary, $cm);
 830             }
 831         }
 832     }
 833     return $return;
 834 }
 835
 836 /**
 837  * Default (old) print format used if custom function doesn't exist in format
 838  *
 839  * @param object $entry
 840  * @param object $glossary
 841  * @param object $cm
 842  * @return void Output is echo'd
 843  */
 844 function glossary_print_entry_default ($entry, $glossary, $cm) {
 845     echo '<h3>'. strip_tags($entry->concept) . ': </h3>';
 846
 847     $definition = $entry->definition;
 848
 849     $definition = '<span class="nolink">' . strip_tags($definition) . '</span>';
 850
 851     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 852     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'glossary_entry', $entry->id);
 853
 854     $options = new object();
 855     $options->para = false;
 856     $options->trusted = $entry->definitiontrust;
 857     $definition = format_text($definition, $entry->definitionformat, $options);
 858     echo ($definition);
 859     echo '<br /><br />';
 860 }
 861
 862 /**
 863  * Print glossary concept/term as a heading &lt;h3>
 864  * @param object $entry
 865  */
 866 function  glossary_print_entry_concept($entry) {
 867     global $OUTPUT;
 868     $options = new object();
 869     $options->para = false;
 870     $text = format_text($OUTPUT->heading('<span class="nolink">' . $entry->concept . '</span>', 3, 'nolink'), FORMAT_MOODLE, $options);
 871     if (!empty($entry->highlight)) {
 872         $text = highlight($entry->highlight, $text);
 873     }
 874     echo $text;
 875 }
 876
 877 /**
 878  *
 879  * @global object
 880  * @global array
 881  * @param object $entry
 882  * @param object $glossary
 883  * @param object $cm
 884  */
 885 function glossary_print_entry_definition($entry, $glossary, $cm) {
 886     global $DB;
 887
 888     $definition = $entry->definition;
 889
 890     global $GLOSSARY_EXCLUDECONCEPTS;
 891
 892     //Calculate all the strings to be no-linked
 893     //First, the concept
 894     $GLOSSARY_EXCLUDECONCEPTS=array($entry->concept);
 895     //Now the aliases
 896     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
 897         foreach ($aliases as $alias) {
 898             $GLOSSARY_EXCLUDECONCEPTS[]=trim($alias->alias);
 899         }
 900     }
 901
 902     $options = new object();
 903     $options->para = false;
 904     $options->trusted = $entry->definitiontrust;
 905
 906     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 907     $definition = file_rewrite_pluginfile_urls($definition, 'pluginfile.php', $context->id, 'glossary_entry', $entry->id);
 908
 909     $text = format_text($definition, $entry->definitionformat, $options);
 910
 911     // Stop excluding concepts from autolinking
 912     unset($GLOSSARY_EXCLUDECONCEPTS);
 913
 914     if (!empty($entry->highlight)) {
 915         $text = highlight($entry->highlight, $text);
 916     }
 917     if (isset($entry->footer)) {   // Unparsed footer info
 918         $text .= $entry->footer;
 919     }
 920     echo $text;
 921 }
 922
 923 /**
 924  *
 925  * @global object
 926  * @param object $course
 927  * @param object $cm
 928  * @param object $glossary
 929  * @param object $entry
 930  * @param string $mode
 931  * @param string $hook
 932  * @param string $type
 933  * @return string|void
 934  */
 935 function  glossary_print_entry_aliases($course, $cm, $glossary, $entry,$mode='',$hook='', $type = 'print') {
 936     global $DB;
 937
 938     $return = '';
 939     if ( $aliases = $DB->get_records('glossary_alias', array('entryid'=>$entry->id))) {
 940         foreach ($aliases as $alias) {
 941             if (trim($alias->alias)) {
 942                 if ($return == '') {
 943                     $return = '<select style="font-size:8pt">';
 944                 }
 945                 $return .= "<option>$alias->alias</option>";
 946             }
 947         }
 948         if ($return != '') {
 949             $return .= '</select>';
 950         }
 951     }
 952     if ($type == 'print') {
 953         echo $return;
 954     } else {
 955         return $return;
 956     }
 957 }
 958
 959 /**
 960  *
 961  * @global object
 962  * @global object
 963  * @global object
 964  * @param object $course
 965  * @param object $cm
 966  * @param object $glossary
 967  * @param object $entry
 968  * @param string $mode
 969  * @param string $hook
 970  * @param string $type
 971  * @return string|void
 972  */
 973 function glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode='',$hook='', $type = 'print') {
 974     global $USER, $CFG, $DB, $OUTPUT;
 975
 976     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 977
 978     $output = false;   //To decide if we must really return text in "return". Activate when needed only!
 979     $importedentry = ($entry->sourceglossaryid == $glossary->id);
 980     $ismainglossary = $glossary->mainglossary;
 981
 982
 983     $return = '<span class="commands">';
 984     // Differentiate links for each entry.
 985     $altsuffix = ': '.strip_tags(format_text($entry->concept));
 986
 987     if (!$entry->approved) {
 988         $output = true;
 989         $return .= get_string('entryishidden','glossary');
 990     }
 991
 992     if (has_capability('mod/glossary:manageentries', $context) or (isloggedin() and has_capability('mod/glossary:write', $context) and $entry->userid == $USER->id)) {
 993         // only teachers can export entries so check it out
 994         if (has_capability('mod/glossary:export', $context) and !$ismainglossary and !$importedentry) {
 995             $mainglossary = $DB->get_record('glossary', array('mainglossary'=>1,'course'=>$course->id));
 996             if ( $mainglossary ) {  // if there is a main glossary defined, allow to export the current entry
 997                 $output = true;
 998                 $return .= ' <a title="'.get_string('exporttomainglossary','glossary') . '" href="exportentry.php?id='.$entry->id.'&amp;prevmode='.$mode.'&amp;hook='.urlencode($hook).'"><img src="'.$OUTPUT->pix_url('export', 'glossary').'" class="iconsmall" alt="'.get_string('exporttomainglossary','glossary').$altsuffix.'" /></a>';
 999             }
1000         }
1001
1002         if ( $entry->sourceglossaryid ) {
1003             $icon = $OUTPUT->pix_url('minus', 'glossary');   // graphical metaphor (minus) for deleting an imported entry
1004         } else {
1005             $icon = $OUTPUT->pix_url('t/delete');
1006         }
1007
1008         //Decide if an entry is editable:
1009         // -It isn't a imported entry (so nobody can edit a imported (from secondary to main) entry)) and
1010         // -The user is teacher or he is a student with time permissions (edit period or editalways defined).
1011         $ineditperiod = ((time() - $entry->timecreated <  $CFG->maxeditingtime) || $glossary->editalways);
1012         if ( !$importedentry and (has_capability('mod/glossary:manageentries', $context) or ($entry->userid == $USER->id and ($ineditperiod and has_capability('mod/glossary:write', $context))))) {
1013             $output = true;
1014             $return .= " <a title=\"" . get_string("delete") . "\" href=\"deleteentry.php?id=$cm->id&amp;mode=delete&amp;entry=$entry->id&amp;prevmode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"";
1015             $return .= $icon;
1016             $return .= "\" class=\"iconsmall\" alt=\"" . get_string("delete") .$altsuffix."\" /></a> ";
1017
1018             $return .= " <a title=\"" . get_string("edit") . "\" href=\"edit.php?cmid=$cm->id&amp;id=$entry->id&amp;mode=$mode&amp;hook=".urlencode($hook)."\"><img src=\"" . $OUTPUT->pix_url('t/edit') . "\" class=\"iconsmall\" alt=\"" . get_string("edit") .$altsuffix. "\" /></a>";
1019         } elseif ( $importedentry ) {
1020             $return .= " <font size=\"-1\">" . get_string("exportedentry","glossary") . "</font>";
1021         }
1022     }
1023     if (has_capability('mod/glossary:exportentry', $context)
1024         || ($entry->userid == $USER->id
1025             && has_capability('mod/glossary:exportownentry', $context))) {
1026         require_once($CFG->libdir . '/portfoliolib.php');
1027         $button = new portfolio_add_button();
1028         $button->set_callback_options('glossary_entry_portfolio_caller',  array('id' => $cm->id, 'entryid' => $entry->id), '/mod/glossary/locallib.php');
1029
1030         $filecontext = $context;
1031         if ($entry->sourceglossaryid == $cm->instance) {
1032             if ($maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1033                 $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1034             }
1035         }
1036         $fs = get_file_storage();
1037         if ($files = $fs->get_area_files($filecontext->id, 'glossary_attachment', $entry->id, "timemodified", false)) {
1038             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
1039         } else {
1040             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
1041         }
1042
1043         $return .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1044     }
1045     $return .= "&nbsp;&nbsp;"; // just to make up a little the output in Mozilla ;)
1046
1047     $return .= '</span>';
1048
1049     if (has_capability('mod/glossary:comment', $context) and $glossary->allowcomments) {
1050         $output = true;
1051         if (!empty($CFG->usecomments)) {
1052             require_once($CFG->dirroot . '/comment/lib.php');
1053             $cmt = new stdclass;
1054             $cmt->pluginname = 'glossary';
1055             $cmt->context  = $context;
1056             $cmt->course   = $course;
1057             $cmt->cm       = $cm;
1058             $cmt->area     = 'glossary_entry';
1059             $cmt->itemid   = $entry->id;
1060             $cmt->showcount = true;
1061             $comment = new comment($cmt);
1062             $return .= '<div>'.$comment->output(true).'</div>';
1063         }
1064     }
1065
1066     //If we haven't calculated any REAL thing, delete result ($return)
1067     if (!$output) {
1068         $return = '';
1069     }
1070     //Print or get
1071     if ($type == 'print') {
1072         echo $return;
1073     } else {
1074         return $return;
1075     }
1076 }
1077
1078 /**
1079  * @param object $course
1080  * @param object $cm
1081  * @param object $glossary
1082  * @param object $entry
1083  * @param string $mode
1084  * @param object $hook
1085  * @param bool $printicons
1086  * @param bool $aliases
1087  * @return void
1088  */
1089 function  glossary_print_entry_lower_section($course, $cm, $glossary, $entry, $mode, $hook, $printicons, $aliases=true) {
1090     if ($aliases) {
1091         $aliases = glossary_print_entry_aliases($course, $cm, $glossary, $entry, $mode, $hook,'html');
1092     }
1093     $icons   = '';
1094     if ($printicons) {
1095         $icons   = glossary_print_entry_icons($course, $cm, $glossary, $entry, $mode, $hook,'html');
1096     }
1097     if ($aliases || $icons || $entry->rating) {
1098         echo '<table>';
1099         if ( $aliases ) {
1100             echo '<tr valign="top"><td class="aliases">' .
1101                   get_string('aliases','glossary').': '.$aliases . '</td></tr>';
1102         }
1103         if ($icons) {
1104             echo '<tr valign="top"><td class="icons">'.$icons.'</td></tr>';
1105         }
1106         if (!empty($entry->rating)) {
1107             echo '<tr valign="top"><td class="ratings">';
1108             glossary_print_entry_ratings($course, $entry);
1109             echo '</td></tr>';
1110         }
1111         echo '</table>';
1112     }
1113 }
1114
1115 /**
1116  * @todo Document this function
1117  */
1118 function glossary_print_entry_attachment($entry, $cm, $format=NULL, $align="right", $insidetable=true) {
1119 ///   valid format values: html  : Return the HTML link for the attachment as an icon
1120 ///                        text  : Return the HTML link for tha attachment as text
1121 ///                        blank : Print the output to the screen
1122     if ($entry->attachment) {
1123           if ($insidetable) {
1124               echo "<table border=\"0\" width=\"100%\" align=\"$align\"><tr><td align=\"$align\" nowrap=\"nowrap\">\n";
1125           }
1126           echo glossary_print_attachments($entry, $cm, $format, $align);
1127           if ($insidetable) {
1128               echo "</td></tr></table>\n";
1129           }
1130     }
1131 }
1132
1133 /**
1134  * @global object
1135  * @param object $cm
1136  * @param object $entry
1137  * @param string $mode
1138  * @param string $align
1139  * @param bool $insidetable
1140  */
1141 function  glossary_print_entry_approval($cm, $entry, $mode, $align="right", $insidetable=true) {
1142     global $CFG, $OUTPUT;
1143
1144     if ($mode == 'approval' and !$entry->approved) {
1145         if ($insidetable) {
1146             echo '<table class="glossaryapproval" align="'.$align.'"><tr><td align="'.$align.'">';
1147         }
1148         echo '<a title="'.get_string('approve','glossary').'" href="approve.php?eid='.$entry->id.'&amp;mode='.$mode.'&amp;sesskey='.sesskey().'"><img align="'.$align.'" src="'.$OUTPUT->pix_url('i/approve') . '" style="border:0px; width:34px; height:34px" alt="'.get_string('approve','glossary').'" /></a>';
1149         if ($insidetable) {
1150             echo '</td></tr></table>';
1151         }
1152     }
1153 }
1154
1155 /**
1156  * It returns all entries from all glossaries that matches the specified criteria
1157  *  within a given $course. It performs an $extended search if necessary.
1158  * It restrict the search to only one $glossary if the $glossary parameter is set.
1159  *
1160  * @global object
1161  * @global object
1162  * @param object $course
1163  * @param array $searchterms
1164  * @param int $extended
1165  * @param object $glossary
1166  * @return array
1167  */
1168 function glossary_search($course, $searchterms, $extended = 0, $glossary = NULL) {
1169     global $CFG, $DB;
1170
1171     if ( !$glossary ) {
1172         if ( $glossaries = $DB->get_records("glossary", array("course"=>$course->id)) ) {
1173             $glos = "";
1174             foreach ( $glossaries as $glossary ) {
1175                 $glos .= "$glossary->id,";
1176             }
1177             $glos = substr($glos,0,-1);
1178         }
1179     } else {
1180         $glos = $glossary->id;
1181     }
1182
1183     if (!has_capability('mod/glossary:manageentries', get_context_instance(CONTEXT_COURSE, $glossary->course))) {
1184         $glossarymodule = $DB->get_record("modules", array("name"=>"glossary"));
1185         $onlyvisible = " AND g.id = cm.instance AND cm.visible = 1 AND cm.module = $glossarymodule->id";
1186         $onlyvisibletable = ", {course_modules} cm";
1187     } else {
1188
1189         $onlyvisible = "";
1190         $onlyvisibletable = "";
1191     }
1192
1193     if ($DB->sql_regex_supported()) {
1194         $REGEXP    = $DB->sql_regex(true);
1195         $NOTREGEXP = $DB->sql_regex(false);
1196     }
1197     $LIKE = $DB->sql_ilike(); // case-insensitive
1198
1199     $searchcond = array();
1200     $params     = array();
1201     $i = 0;
1202
1203     $concat = $DB->sql_concat('e.concept', "' '", 'e.definition');
1204
1205
1206     foreach ($searchterms as $searchterm) {
1207         $i++;
1208
1209         $NOT = ''; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1210                    /// will use it to simulate the "-" operator with LIKE clause
1211
1212     /// Under Oracle and MSSQL, trim the + and - operators and perform
1213     /// simpler LIKE (or NOT LIKE) queries
1214         if (!$DB->sql_regex_supported()) {
1215             if (substr($searchterm, 0, 1) == '-') {
1216                 $NOT = ' NOT ';
1217             }
1218             $searchterm = trim($searchterm, '+-');
1219         }
1220
1221         // TODO: +- may not work for non latin languages
1222
1223         if (substr($searchterm,0,1) == '+') {
1224             $searchterm = trim($searchterm, '+-');
1225             $searchterm = preg_quote($searchterm, '|');
1226             $searchcond[] = "$concat $REGEXP :ss$i";
1227             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1228
1229         } else if (substr($searchterm,0,1) == "-") {
1230             $searchterm = trim($searchterm, '+-');
1231             $searchterm = preg_quote($searchterm, '|');
1232             $searchcond[] = "$concat $NOTREGEXP :ss$i";
1233             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1234
1235         } else {
1236             $searchcond[] = "$concat $NOT $LIKE :ss$i";
1237             $params['ss'.$i] = "%$searchterm%";
1238         }
1239     }
1240
1241     if (empty($searchcond)) {
1242         $totalcount = 0;
1243         return array();
1244     }
1245
1246     $searchcond = implode(" AND ", $searchcond);
1247
1248     $sql = "SELECT e.*
1249               FROM {glossary_entries} e, {glossary} g $onlyvisibletable
1250              WHERE $searchcond
1251                AND (e.glossaryid = g.id or e.sourceglossaryid = g.id) $onlyvisible
1252                AND g.id IN ($glos) AND e.approved <> 0";
1253
1254     return $DB->get_records_sql($sql, $params);
1255 }
1256
1257 /**
1258  * @global object
1259  * @param array $searchterms
1260  * @param object $glossary
1261  * @param bool $extended
1262  * @return array
1263  */
1264 function glossary_search_entries($searchterms, $glossary, $extended) {
1265     global $DB;
1266
1267     $course = $DB->get_record("course", array("id"=>$glossary->course));
1268     return glossary_search($course,$searchterms,$extended,$glossary);
1269 }
1270
1271 /**
1272  * if return=html, then return a html string.
1273  * if return=text, then return a text-only string.
1274  * otherwise, print HTML for non-images, and return image HTML
1275  *     if attachment is an image, $align set its aligment.
1276  *
1277  * @global object
1278  * @global object
1279  * @param object $entry
1280  * @param object $cm
1281  * @param string $type html, txt, empty
1282  * @param string $align left or right
1283  * @return string image string or nothing depending on $type param
1284  */
1285 function glossary_print_attachments($entry, $cm, $type=NULL, $align="left") {
1286     global $CFG, $DB, $OUTPUT;
1287
1288     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
1289         return '';
1290     }
1291
1292     if ($entry->sourceglossaryid == $cm->instance) {
1293         if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1294             return '';
1295         }
1296         $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1297
1298     } else {
1299         $filecontext = $context;
1300     }
1301
1302     $strattachment = get_string('attachment', 'glossary');
1303
1304     $fs = get_file_storage();
1305     $browser = get_file_browser();
1306
1307     $imagereturn = '';
1308     $output = '';
1309
1310     if ($files = $fs->get_area_files($filecontext->id, 'glossary_attachment', $entry->id, "timemodified", false)) {
1311         foreach ($files as $file) {
1312             $filename = $file->get_filename();
1313             $mimetype = $file->get_mimetype();
1314             $iconimage = '<img src="'.$OUTPUT->pix_url(file_mimetype_icon($mimetype)).'" class="icon" alt="'.$mimetype.'" />';
1315             $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/glossary_attachment/'.$entry->id.'/'.$filename);
1316
1317             if ($type == 'html') {
1318                 $output .= "<a href=\"$path\">$iconimage</a> ";
1319                 $output .= "<a href=\"$path\">".s($filename)."</a>";
1320                 $output .= "<br />";
1321
1322             } else if ($type == 'text') {
1323                 $output .= "$strattachment ".s($filename).":\n$path\n";
1324
1325             } else {
1326                 if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
1327                     // Image attachments don't get printed as links
1328                     $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
1329                 } else {
1330                     $output .= "<a href=\"$path\">$iconimage</a> ";
1331                     $output .= filter_text("<a href=\"$path\">".s($filename)."</a>");
1332                     $output .= '<br />';
1333                 }
1334             }
1335         }
1336     }
1337
1338     if ($type) {
1339         return $output;
1340     } else {
1341         echo $output;
1342         return $imagereturn;
1343     }
1344 }
1345
1346 /**
1347  * Lists all browsable file areas
1348  *
1349  * @param object $course
1350  * @param object $cm
1351  * @param object $context
1352  * @return array
1353  */
1354 function glossary_get_file_areas($course, $cm, $context) {
1355     $areas = array();
1356     return $areas;
1357 }
1358
1359 /**
1360  * Serves the glossary attachments. Implements needed access control ;-)
1361  *
1362  * @param object $course
1363  * @param object $cminfo
1364  * @param object $context
1365  * @param string $filearea
1366  * @param array $args
1367  * @param bool $forcedownload
1368  * @return bool false if file not found, does not return if found - justsend the file
1369  */
1370 function glossary_pluginfile($course, $cminfo, $context, $filearea, $args, $forcedownload) {
1371     global $CFG, $DB;
1372
1373     if (!$cminfo->uservisible) {
1374         return false;
1375     }
1376
1377     if ($filearea === 'glossary_attachment' or $filearea === 'glossary_entry') {
1378         $entryid = (int)array_shift($args);
1379
1380         if (!$cm = get_coursemodule_from_instance('glossary', $cminfo->instance, $course->id)) {
1381             return false;
1382         }
1383
1384         require_course_login($course, true, $cm);
1385
1386         if (!$entry = $DB->get_record('glossary_entries', array('id'=>$entryid))) {
1387             return false;
1388         }
1389
1390         if (!$glossary = $DB->get_record('glossary', array('id'=>$cminfo->instance))) {
1391             return false;
1392         }
1393
1394         if ($glossary->defaultapproval and !$entry->approved and !has_capability('mod/glossary:approve', $context)) {
1395             return false;
1396         }
1397
1398         if ($entry->glossaryid == $cminfo->instance) {
1399             $filecontext = $context;
1400
1401         } else if ($entry->sourceglossaryid == $cminfo->instance) {
1402             if (!$maincm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
1403                 print_error('invalidcoursemodule');
1404             }
1405             $filecontext = get_context_instance(CONTEXT_MODULE, $maincm->id);
1406
1407         } else {
1408             return false;
1409         }
1410
1411         $relativepath = '/'.implode('/', $args);
1412         $fullpath = $filecontext->id.$filearea.$entryid.$relativepath;
1413
1414         $fs = get_file_storage();
1415         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1416             return false;
1417         }
1418
1419         // finally send the file
1420         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
1421     }
1422
1423     return false;
1424 }
1425
1426 /**
1427  *
1428  */
1429 function glossary_print_tabbed_table_end() {
1430      echo "</div></div>";
1431 }
1432
1433 /**
1434  * @param object $cm
1435  * @param object $glossary
1436  * @param string $mode
1437  * @param string $hook
1438  * @param string $sortkey
1439  * @param string $sortorder
1440  */
1441 function glossary_print_approval_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1442     if ($glossary->showalphabet) {
1443         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1444     }
1445     glossary_print_special_links($cm, $glossary, $mode, $hook);
1446
1447     glossary_print_alphabet_links($cm, $glossary, $mode, $hook,$sortkey, $sortorder);
1448
1449     glossary_print_all_links($cm, $glossary, $mode, $hook);
1450
1451     glossary_print_sorting_links($cm, $mode, 'CREATION', 'asc');
1452 }
1453 /**
1454  * @param object $cm
1455  * @param object $glossary
1456  * @param string $hook
1457  * @param string $sortkey
1458  * @param string $sortorder
1459  */
1460 function glossary_print_import_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1461     echo '<div class="glossaryexplain">' . get_string("explainimport","glossary") . '</div>';
1462 }
1463
1464 /**
1465  * @param object $cm
1466  * @param object $glossary
1467  * @param string $hook
1468  * @param string $sortkey
1469  * @param string $sortorder
1470  */
1471 function glossary_print_export_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1472     echo '<div class="glossaryexplain">' . get_string("explainexport","glossary") . '</div>';
1473 }
1474 /**
1475  * @param object $cm
1476  * @param object $glossary
1477  * @param string $hook
1478  * @param string $sortkey
1479  * @param string $sortorder
1480  */
1481 function glossary_print_alphabet_menu($cm, $glossary, $mode, $hook, $sortkey='', $sortorder = '') {
1482     if ( $mode != 'date' ) {
1483         if ($glossary->showalphabet) {
1484             echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1485         }
1486
1487         glossary_print_special_links($cm, $glossary, $mode, $hook);
1488
1489         glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1490
1491         glossary_print_all_links($cm, $glossary, $mode, $hook);
1492     } else {
1493         glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1494     }
1495 }
1496
1497 /**
1498  * @param object $cm
1499  * @param object $glossary
1500  * @param string $hook
1501  * @param string $sortkey
1502  * @param string $sortorder
1503  */
1504 function glossary_print_author_menu($cm, $glossary,$mode, $hook, $sortkey = '', $sortorder = '') {
1505     if ($glossary->showalphabet) {
1506         echo '<div class="glossaryexplain">' . get_string("explainalphabet","glossary") . '</div><br />';
1507     }
1508
1509     glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder);
1510     glossary_print_all_links($cm, $glossary, $mode, $hook);
1511     glossary_print_sorting_links($cm, $mode, $sortkey,$sortorder);
1512 }
1513
1514 /**
1515  * @global object
1516  * @global object
1517  * @param object $cm
1518  * @param object $glossary
1519  * @param string $hook
1520  * @param object $category
1521  */
1522 function glossary_print_categories_menu($cm, $glossary, $hook, $category) {
1523      global $CFG, $DB, $OUTPUT;
1524
1525      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1526
1527      echo '<table border="0" width="100%">';
1528      echo '<tr>';
1529
1530      echo '<td align="center" style="width:20%">';
1531      if (has_capability('mod/glossary:managecategories', $context)) {
1532              $options['id'] = $cm->id;
1533              $options['mode'] = 'cat';
1534              $options['hook'] = $hook;
1535              echo $OUTPUT->single_button(new moodle_url("editcategories.php", $options), get_string("editcategories","glossary"), "get");
1536      }
1537      echo '</td>';
1538
1539      echo '<td align="center" style="width:60%">';
1540      echo '<b>';
1541
1542      $menu = array();
1543      $menu[GLOSSARY_SHOW_ALL_CATEGORIES] = get_string("allcategories","glossary");
1544      $menu[GLOSSARY_SHOW_NOT_CATEGORISED] = get_string("notcategorised","glossary");
1545
1546      $categories = $DB->get_records("glossary_categories", array("glossaryid"=>$glossary->id), "name ASC");
1547      $selected = '';
1548      if ( $categories ) {
1549           foreach ($categories as $currentcategory) {
1550                  $url = $currentcategory->id;
1551                  if ( $category ) {
1552                      if ($currentcategory->id == $category->id) {
1553                          $selected = $url;
1554                      }
1555                  }
1556                  $menu[$url] = clean_text($currentcategory->name); //Only clean, not filters
1557           }
1558      }
1559      if ( !$selected ) {
1560          $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1561      }
1562
1563      if ( $category ) {
1564         echo format_text($category->name, FORMAT_PLAIN);
1565      } else {
1566         if ( $hook == GLOSSARY_SHOW_NOT_CATEGORISED ) {
1567
1568             echo get_string("entrieswithoutcategory","glossary");
1569             $selected = GLOSSARY_SHOW_NOT_CATEGORISED;
1570
1571         } elseif ( $hook == GLOSSARY_SHOW_ALL_CATEGORIES ) {
1572
1573             echo get_string("allcategories","glossary");
1574             $selected = GLOSSARY_SHOW_ALL_CATEGORIES;
1575
1576         }
1577      }
1578      echo '</b></td>';
1579      echo '<td align="center" style="width:20%">';
1580
1581      $select = new single_select(new moodle_url("/mod/glossary/view.php", array('id'=>$cm->id, 'mode'=>'cat')), 'hook', $menu, $selected, null, "catmenu");
1582      echo $OUTPUT->render($select);
1583
1584      echo '</td>';
1585      echo '</tr>';
1586
1587      echo '</table>';
1588 }
1589
1590 /**
1591  * @global object
1592  * @param object $cm
1593  * @param object $glossary
1594  * @param string $mode
1595  * @param string $hook
1596  */
1597 function glossary_print_all_links($cm, $glossary, $mode, $hook) {
1598 global $CFG;
1599      if ( $glossary->showall) {
1600          $strallentries       = get_string("allentries", "glossary");
1601          if ( $hook == 'ALL' ) {
1602               echo "<b>$strallentries</b>";
1603          } else {
1604               $strexplainall = strip_tags(get_string("explainall","glossary"));
1605               echo "<a title=\"$strexplainall\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=ALL\">$strallentries</a>";
1606          }
1607      }
1608 }
1609
1610 /**
1611  * @global object
1612  * @param object $cm
1613  * @param object $glossary
1614  * @param string $mode
1615  * @param string $hook
1616  */
1617 function glossary_print_special_links($cm, $glossary, $mode, $hook) {
1618 global $CFG;
1619      if ( $glossary->showspecial) {
1620          $strspecial          = get_string("special", "glossary");
1621          if ( $hook == 'SPECIAL' ) {
1622               echo "<b>$strspecial</b> | ";
1623          } else {
1624               $strexplainspecial = strip_tags(get_string("explainspecial","glossary"));
1625               echo "<a title=\"$strexplainspecial\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=SPECIAL\">$strspecial</a> | ";
1626          }
1627      }
1628 }
1629
1630 /**
1631  * @global object
1632  * @param object $glossary
1633  * @param string $mode
1634  * @param string $hook
1635  * @param string $sortkey
1636  * @param string $sortorder
1637  */
1638 function glossary_print_alphabet_links($cm, $glossary, $mode, $hook, $sortkey, $sortorder) {
1639 global $CFG;
1640      if ( $glossary->showalphabet) {
1641           $alphabet = explode(",", get_string("alphabet"));
1642           $letters_by_line = 14;
1643           for ($i = 0; $i < count($alphabet); $i++) {
1644               if ( $hook == $alphabet[$i] and $hook) {
1645                    echo "<b>$alphabet[$i]</b>";
1646               } else {
1647                    echo "<a href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;mode=$mode&amp;hook=".urlencode($alphabet[$i])."&amp;sortkey=$sortkey&amp;sortorder=$sortorder\">$alphabet[$i]</a>";
1648               }
1649               if ((int) ($i % $letters_by_line) != 0 or $i == 0) {
1650                    echo ' | ';
1651               } else {
1652                    echo '<br />';
1653               }
1654           }
1655      }
1656 }
1657
1658 /**
1659  * @global object
1660  * @param object $cm
1661  * @param string $mode
1662  * @param string $sortkey
1663  * @param string $sortorder
1664  */
1665 function glossary_print_sorting_links($cm, $mode, $sortkey = '',$sortorder = '') {
1666     global $CFG, $OUTPUT;
1667
1668     $asc    = get_string("ascending","glossary");
1669     $desc   = get_string("descending","glossary");
1670     $bopen  = '<b>';
1671     $bclose = '</b>';
1672
1673      $neworder = '';
1674      $currentorder = '';
1675      $currentsort = '';
1676      if ( $sortorder ) {
1677          if ( $sortorder == 'asc' ) {
1678              $currentorder = $asc;
1679              $neworder = '&amp;sortorder=desc';
1680              $newordertitle = get_string('changeto', 'glossary', $desc);
1681          } else {
1682              $currentorder = $desc;
1683              $neworder = '&amp;sortorder=asc';
1684              $newordertitle = get_string('changeto', 'glossary', $asc);
1685          }
1686          $icon = " <img src=\"".$OUTPUT->pix_url($sortorder, 'glossary')."\" class=\"icon\" alt=\"$newordertitle\" />";
1687      } else {
1688          if ( $sortkey != 'CREATION' and $sortkey != 'UPDATE' and
1689                $sortkey != 'FIRSTNAME' and $sortkey != 'LASTNAME' ) {
1690              $icon = "";
1691              $newordertitle = $asc;
1692          } else {
1693              $newordertitle = $desc;
1694              $neworder = '&amp;sortorder=desc';
1695              $icon = ' <img src="'.$OUTPUT->pix_url('asc', 'glossary').'" class="icon" alt="'.$newordertitle.'" />';
1696          }
1697      }
1698      $ficon     = '';
1699      $fneworder = '';
1700      $fbtag     = '';
1701      $fendbtag  = '';
1702
1703      $sicon     = '';
1704      $sneworder = '';
1705
1706      $sbtag      = '';
1707      $fbtag      = '';
1708      $fendbtag      = '';
1709      $sendbtag      = '';
1710
1711      $sendbtag  = '';
1712
1713      if ( $sortkey == 'CREATION' or $sortkey == 'FIRSTNAME' ) {
1714          $ficon       = $icon;
1715          $fneworder   = $neworder;
1716          $fordertitle = $newordertitle;
1717          $sordertitle = $asc;
1718          $fbtag       = $bopen;
1719          $fendbtag    = $bclose;
1720      } elseif ($sortkey == 'UPDATE' or $sortkey == 'LASTNAME') {
1721          $sicon = $icon;
1722          $sneworder   = $neworder;
1723          $fordertitle = $asc;
1724          $sordertitle = $newordertitle;
1725          $sbtag       = $bopen;
1726          $sendbtag    = $bclose;
1727      } else {
1728          $fordertitle = $asc;
1729          $sordertitle = $asc;
1730      }
1731
1732      if ( $sortkey == 'CREATION' or $sortkey == 'UPDATE' ) {
1733          $forder = 'CREATION';
1734          $sorder =  'UPDATE';
1735          $fsort  = get_string("sortbycreation", "glossary");
1736          $ssort  = get_string("sortbylastupdate", "glossary");
1737
1738          $currentsort = $fsort;
1739          if ($sortkey == 'UPDATE') {
1740              $currentsort = $ssort;
1741          }
1742          $sort        = get_string("sortchronogically", "glossary");
1743      } elseif ( $sortkey == 'FIRSTNAME' or $sortkey == 'LASTNAME') {
1744          $forder = 'FIRSTNAME';
1745          $sorder =  'LASTNAME';
1746          $fsort  = get_string("firstname");
1747          $ssort  = get_string("lastname");
1748
1749          $currentsort = $fsort;
1750          if ($sortkey == 'LASTNAME') {
1751              $currentsort = $ssort;
1752          }
1753          $sort        = get_string("sortby", "glossary");
1754      }
1755      $current = '<span class="accesshide">'.get_string('current', 'glossary', "$currentsort $currentorder").'</span>';
1756      echo "<br />$current $sort: $sbtag<a title=\"$ssort $sordertitle\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;sortkey=$sorder$sneworder&amp;mode=$mode\">$ssort$sicon</a>$sendbtag | ".
1757                           "$fbtag<a title=\"$fsort $fordertitle\" href=\"$CFG->wwwroot/mod/glossary/view.php?id=$cm->id&amp;sortkey=$forder$fneworder&amp;mode=$mode\">$fsort$ficon</a>$fendbtag<br />";
1758 }
1759
1760 /**
1761  *
1762  * @param object $entry0
1763  * @param object $entry1
1764  * @return int [-1 | 0 | 1]
1765  */
1766 function glossary_sort_entries ( $entry0, $entry1 ) {
1767
1768     if ( moodle_strtolower(ltrim($entry0->concept)) < moodle_strtolower(ltrim($entry1->concept)) ) {
1769         return -1;
1770     } elseif ( moodle_strtolower(ltrim($entry0->concept)) > moodle_strtolower(ltrim($entry1->concept)) ) {
1771         return 1;
1772     } else {
1773         return 0;
1774     }
1775 }
1776
1777
1778 /**
1779  * @global object
1780  * @global object
1781  * @global object
1782  * @param object $course
1783  * @param object $entry
1784  * @return bool
1785  */
1786 function  glossary_print_entry_ratings($course, $entry) {
1787 /*    global $USER, $CFG, $DB;
1788
1789     $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid));
1790     $glossarymod = $DB->get_record('modules', array('name'=>'glossary'));
1791     $cm = $DB->get_record_sql("SELECT *
1792                                  FROM {course_modules}
1793                                 WHERE course = ? AND module = ? and instance = ?", array($course->id, $glossarymod->id, $glossary->id));
1794
1795     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1796
1797     if (!empty($ratings) and isloggedin()) {
1798         $useratings = true;
1799         if ($entry->rating->settings->assesstimestart and $entry->rating->settings->assesstimefinish) {
1800             if ($entry->timecreated < $ratings->assesstimestart or $entry->timecreated > $ratings->assesstimefinish) {
1801                 $useratings = false;
1802             }
1803         }
1804         if ($useratings) {
1805             if (has_capability('mod/glossary:viewrating', $context)) {
1806                 glossary_print_ratings_mean($entry->id, $ratings->scale);
1807                 if ($USER->id != $entry->userid) {
1808                      glossary_print_rating_menu($entry->id, $USER->id, $ratings->scale);
1809                      $ratingsmenuused = true;
1810                 }
1811             } else if ($USER->id == $entry->userid) {
1812                 glossary_print_ratings_mean($entry->id, $ratings->scale);
1813             } else if (!empty($ratings->allow) ) {
1814                 glossary_print_rating_menu($entry->id, $USER->id, $ratings->scale);
1815                 $ratingsmenuused = true;
1816             }
1817         }
1818     }
1819     return $ratingsmenuused;
1820     */
1821     global $OUTPUT;
1822     if( !empty($entry->rating) ){
1823         echo $OUTPUT->render($entry->rating);
1824     }
1825 }
1826
1827 /**
1828  *
1829  * @global object
1830  * @global object
1831  * @global object
1832  * @param int $courseid
1833  * @param array $entries
1834  * @param int $displayformat
1835  */
1836 function glossary_print_dynaentry($courseid, $entries, $displayformat = -1) {
1837     global $USER,$CFG, $DB;
1838
1839     echo '<div class="boxaligncenter">';
1840     echo '<table class="glossarypopup" cellspacing="0"><tr>';
1841     echo '<td>';
1842     if ( $entries ) {
1843         foreach ( $entries as $entry ) {
1844             if (! $glossary = $DB->get_record('glossary', array('id'=>$entry->glossaryid))) {
1845                 print_error('invalidid', 'glossary');
1846             }
1847             if (! $course = $DB->get_record('course', array('id'=>$glossary->course))) {
1848                 print_error('coursemisconf');
1849             }
1850             if (!$cm = get_coursemodule_from_instance('glossary', $entry->glossaryid, $glossary->course) ) {
1851                 print_error('invalidid', 'glossary');
1852             }
1853
1854             //If displayformat is present, override glossary->displayformat
1855             if ($displayformat < 0) {
1856                 $dp = $glossary->displayformat;
1857             } else {
1858                 $dp = $displayformat;
1859             }
1860
1861             //Get popupformatname
1862             $format = $DB->get_record('glossary_formats', array('name'=>$dp));
1863             $displayformat = $format->popupformatname;
1864
1865             //Check displayformat variable and set to default if necessary
1866             if (!$displayformat) {
1867                 $displayformat = 'dictionary';
1868             }
1869
1870             $formatfile = $CFG->dirroot.'/mod/glossary/formats/'.$displayformat.'/'.$displayformat.'_format.php';
1871             $functionname = 'glossary_show_entry_'.$displayformat;
1872
1873             if (file_exists($formatfile)) {
1874                 include_once($formatfile);
1875                 if (function_exists($functionname)) {
1876                     $functionname($course, $cm, $glossary, $entry,'','','','');
1877                 }
1878             }
1879         }
1880     }
1881     echo '</td>';
1882     echo '</tr></table></div>';
1883 }
1884
1885 /**
1886  *
1887  * @global object
1888  * @param array $entries
1889  * @param array $aliases
1890  * @param array $categories
1891  * @return string
1892  */
1893 function glossary_generate_export_csv($entries, $aliases, $categories) {
1894     global $CFG;
1895     $csv = '';
1896     $delimiter = '';
1897     require_once($CFG->libdir . '/csvlib.class.php');
1898     $delimiter = csv_import_reader::get_delimiter('comma');
1899     $csventries = array(0 => array(get_string('concept', 'glossary'), get_string('definition', 'glossary')));
1900     $csvaliases = array(0 => array());
1901     $csvcategories = array(0 => array());
1902     $aliascount = 0;
1903     $categorycount = 0;
1904
1905     foreach ($entries as $entry) {
1906         $thisaliasesentry = array();
1907         $thiscategoriesentry = array();
1908         $thiscsventry = array($entry->concept, nl2br($entry->definition));
1909
1910         if (array_key_exists($entry->id, $aliases) && is_array($aliases[$entry->id])) {
1911             $thiscount = count($aliases[$entry->id]);
1912             if ($thiscount > $aliascount) {
1913                 $aliascount = $thiscount;
1914             }
1915             foreach ($aliases[$entry->id] as $alias) {
1916                 $thisaliasesentry[] = trim($alias);
1917             }
1918         }
1919         if (array_key_exists($entry->id, $categories) && is_array($categories[$entry->id])) {
1920             $thiscount = count($categories[$entry->id]);
1921             if ($thiscount > $categorycount) {
1922                 $categorycount = $thiscount;
1923             }
1924             foreach ($categories[$entry->id] as $catentry) {
1925                 $thiscategoriesentry[] = trim($catentry);
1926             }
1927         }
1928         $csventries[$entry->id] = $thiscsventry;
1929         $csvaliases[$entry->id] = $thisaliasesentry;
1930         $csvcategories[$entry->id] = $thiscategoriesentry;
1931
1932     }
1933     $returnstr = '';
1934     foreach ($csventries as $id => $row) {
1935         $aliasstr = '';
1936         $categorystr = '';
1937         if ($id == 0) {
1938             $aliasstr = get_string('alias', 'glossary');
1939             $categorystr = get_string('category', 'glossary');
1940         }
1941         $row = array_merge($row, array_pad($csvaliases[$id], $aliascount, $aliasstr), array_pad($csvcategories[$id], $categorycount, $categorystr));
1942         $returnstr .= '"' . implode('"' . $delimiter . '"', $row) . '"' . "\n";
1943     }
1944     return $returnstr;
1945 }
1946
1947 /**
1948  * @todo Check whether the third argument is valid
1949  * @global object
1950  * @global object
1951  * @param object $glossary
1952  * @param string $hook
1953  * @param int $hook
1954  * @return string
1955  */
1956 function glossary_generate_export_file($glossary, $hook = "", $hook = 0) {
1957     global $CFG, $DB;
1958
1959     $co  = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1960
1961     $co .= glossary_start_tag("GLOSSARY",0,true);
1962     $co .= glossary_start_tag("INFO",1,true);
1963         $co .= glossary_full_tag("NAME",2,false,$glossary->name);
1964         $co .= glossary_full_tag("INTRO",2,false,$glossary->intro);
1965         $co .= glossary_full_tag("ALLOWDUPLICATEDENTRIES",2,false,$glossary->allowduplicatedentries);
1966         $co .= glossary_full_tag("DISPLAYFORMAT",2,false,$glossary->displayformat);
1967         $co .= glossary_full_tag("SHOWSPECIAL",2,false,$glossary->showspecial);
1968         $co .= glossary_full_tag("SHOWALPHABET",2,false,$glossary->showalphabet);
1969         $co .= glossary_full_tag("SHOWALL",2,false,$glossary->showall);
1970         $co .= glossary_full_tag("ALLOWCOMMENTS",2,false,$glossary->allowcomments);
1971         $co .= glossary_full_tag("USEDYNALINK",2,false,$glossary->usedynalink);
1972         $co .= glossary_full_tag("DEFAULTAPPROVAL",2,false,$glossary->defaultapproval);
1973         $co .= glossary_full_tag("GLOBALGLOSSARY",2,false,$glossary->globalglossary);
1974         $co .= glossary_full_tag("ENTBYPAGE",2,false,$glossary->entbypage);
1975
1976         if ( $entries = $DB->get_records("glossary_entries", array("glossaryid"=>$glossary->id))) {
1977             $co .= glossary_start_tag("ENTRIES",2,true);
1978             foreach ($entries as $entry) {
1979                 $permissiongranted = 1;
1980                 if ( $hook ) {
1981                     switch ( $hook ) {
1982                     case "ALL":
1983                     case "SPECIAL":
1984                     break;
1985                     default:
1986                         $permissiongranted = ($entry->concept[ strlen($hook)-1 ] == $hook);
1987                     break;
1988                     }
1989                 }
1990                 if ( $hook ) {
1991                     switch ( $hook ) {
1992                     case GLOSSARY_SHOW_ALL_CATEGORIES:
1993                     break;
1994                     case GLOSSARY_SHOW_NOT_CATEGORISED:
1995                         $permissiongranted = !$DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id));
1996                     break;
1997                     default:
1998                         $permissiongranted = $DB->record_exists("glossary_entries_categories", array("entryid"=>$entry->id, "categoryid"=>$hook));
1999                     break;
2000                     }
2001                 }
2002                 if ( $entry->approved and $permissiongranted ) {
2003                     $co .= glossary_start_tag("ENTRY",3,true);
2004                     $co .= glossary_full_tag("CONCEPT",4,false,trim($entry->concept));
2005                     $co .= glossary_full_tag("DEFINITION",4,false,$entry->definition);
2006                     $co .= glossary_full_tag("FORMAT",4,false,$entry->definitionformat);
2007                     $co .= glossary_full_tag("USEDYNALINK",4,false,$entry->usedynalink);
2008                     $co .= glossary_full_tag("CASESENSITIVE",4,false,$entry->casesensitive);
2009                     $co .= glossary_full_tag("FULLMATCH",4,false,$entry->fullmatch);
2010                     $co .= glossary_full_tag("TEACHERENTRY",4,false,$entry->teacherentry);
2011
2012                     if ( $aliases = $DB->get_records("glossary_alias", array("entryid"=>$entry->id))) {
2013                         $co .= glossary_start_tag("ALIASES",4,true);
2014                         foreach ($aliases as $alias) {
2015                             $co .= glossary_start_tag("ALIAS",5,true);
2016                                 $co .= glossary_full_tag("NAME",6,false,trim($alias->alias));
2017                             $co .= glossary_end_tag("ALIAS",5,true);
2018                         }
2019                         $co .= glossary_end_tag("ALIASES",4,true);
2020                     }
2021                     if ( $catentries = $DB->get_records("glossary_entries_categories", array("entryid"=>$entry->id))) {
2022                         $co .= glossary_start_tag("CATEGORIES",4,true);
2023                         foreach ($catentries as $catentry) {
2024                             $category = $DB->get_record("glossary_categories", array("id"=>$catentry->categoryid));
2025
2026                             $co .= glossary_start_tag("CATEGORY",5,true);
2027                                 $co .= glossary_full_tag("NAME",6,false,$category->name);
2028                                 $co .= glossary_full_tag("USEDYNALINK",6,false,$category->usedynalink);
2029                             $co .= glossary_end_tag("CATEGORY",5,true);
2030                         }
2031                         $co .= glossary_end_tag("CATEGORIES",4,true);
2032                     }
2033
2034                     $co .= glossary_end_tag("ENTRY",3,true);
2035                 }
2036             }
2037             $co .= glossary_end_tag("ENTRIES",2,true);
2038
2039         }
2040
2041
2042     $co .= glossary_end_tag("INFO",1,true);
2043     $co .= glossary_end_tag("GLOSSARY",0,true);
2044
2045     return $co;
2046 }
2047 /// Functions designed by Eloy Lafuente
2048 /// Functions to create, open and write header of the xml file
2049
2050 /**
2051  * Read import file and convert to current charset
2052  *
2053  * @global object
2054  * @param string $file
2055  * @return string
2056  */
2057 function glossary_read_imported_file($file_content) {
2058     require_once "../../lib/xmlize.php";
2059     global $CFG;
2060
2061     return xmlize($file_content, 0);
2062 }
2063
2064 /**
2065  * Return the xml start tag
2066  *
2067  * @param string $tag
2068  * @param int $level
2069  * @param bool $endline
2070  * @return string
2071  */
2072 function glossary_start_tag($tag,$level=0,$endline=false) {
2073         if ($endline) {
2074            $endchar = "\n";
2075         } else {
2076            $endchar = "";
2077         }
2078         return str_repeat(" ",$level*2)."<".strtoupper($tag).">".$endchar;
2079 }
2080
2081 /**
2082  * Return the xml end tag
2083  * @param string $tag
2084  * @param int $level
2085  * @param bool $endline
2086  * @return string
2087  */
2088 function glossary_end_tag($tag,$level=0,$endline=true) {
2089         if ($endline) {
2090            $endchar = "\n";
2091         } else {
2092            $endchar = "";
2093         }
2094         return str_repeat(" ",$level*2)."</".strtoupper($tag).">".$endchar;
2095 }
2096
2097 /**
2098  * Return the start tag, the contents and the end tag
2099  *
2100  * @global object
2101  * @param string $tag
2102  * @param int $level
2103  * @param bool $endline
2104  * @param string $content
2105  * @return string
2106  */
2107 function glossary_full_tag($tag,$level=0,$endline=true,$content) {
2108         global $CFG;
2109
2110         $st = glossary_start_tag($tag,$level,$endline);
2111         $co = preg_replace("/\r\n|\r/", "\n", s($content));
2112         $et = glossary_end_tag($tag,0,true);
2113         return $st.$co.$et;
2114 }
2115
2116 /**
2117  * How many unrated entries are in the given glossary for a given user?
2118  *
2119  * @global object
2120  * @param int $glossaryid
2121  * @param int $userid
2122  * @return int
2123  */
2124 function glossary_count_unrated_entries($glossaryid, $userid) {
2125     global $DB;
2126     if ($entries = $DB->get_record_sql("SELECT count('x') as num
2127                                           FROM {glossary_entries}
2128                                          WHERE glossaryid = ? AND userid <> ?", array($glossaryid, $userid))) {
2129
2130         if ($rated = $DB->get_record_sql("SELECT count(*) as num
2131                                             FROM {glossary_entries} e, {glossary_ratings} r
2132                                            WHERE e.glossaryid = ? AND e.id = r.entryid
2133                                                  AND r.userid = ?", array($glossaryid, $userid))) {
2134             $difference = $entries->num - $rated->num;
2135             if ($difference > 0) {
2136                 return $difference;
2137             } else {
2138                 return 0;    // Just in case there was a counting error
2139             }
2140         } else {
2141             return $entries->num;
2142         }
2143     } else {
2144         return 0;
2145     }
2146 }
2147
2148 /**
2149  *
2150  * Returns the html code to represent any pagging bar. Paramenters are:
2151  *
2152  * The function dinamically show the first and last pages, and "scroll" over pages.
2153  * Fully compatible with Moodle's print_paging_bar() function. Perhaps some day this
2154  * could replace the general one. ;-)
2155  *
2156  * @param int $totalcount total number of records to be displayed
2157  * @param int $page page currently selected (0 based)
2158  * @param int $perpage number of records per page
2159  * @param string $baseurl url to link in each page, the string 'page=XX' will be added automatically.
2160  *
2161  * @param int $maxpageallowed Optional maximum number of page allowed.
2162  * @param int $maxdisplay Optional maximum number of page links to show in the bar
2163  * @param string $separator Optional string to be used between pages in the bar
2164  * @param string $specialtext Optional string to be showed as an special link
2165  * @param string $specialvalue Optional value (page) to be used in the special link
2166  * @param bool $previousandnext Optional to decide if we want the previous and next links
2167  * @return string
2168  */
2169 function glossary_get_paging_bar($totalcount, $page, $perpage, $baseurl, $maxpageallowed=99999, $maxdisplay=20, $separator="&nbsp;", $specialtext="", $specialvalue=-1, $previousandnext = true) {
2170
2171     $code = '';
2172
2173     $showspecial = false;
2174     $specialselected = false;
2175
2176     //Check if we have to show the special link
2177     if (!empty($specialtext)) {
2178         $showspecial = true;
2179     }
2180     //Check if we are with the special link selected
2181     if ($showspecial && $page == $specialvalue) {
2182         $specialselected = true;
2183     }
2184
2185     //If there are results (more than 1 page)
2186     if ($totalcount > $perpage) {
2187         $code .= "<div style=\"text-align:center\">";
2188         $code .= "<p>".get_string("page").":";
2189
2190         $maxpage = (int)(($totalcount-1)/$perpage);
2191
2192         //Lower and upper limit of page
2193         if ($page < 0) {
2194             $page = 0;
2195         }
2196         if ($page > $maxpageallowed) {
2197             $page = $maxpageallowed;
2198         }
2199         if ($page > $maxpage) {
2200             $page = $maxpage;
2201         }
2202
2203         //Calculate the window of pages
2204         $pagefrom = $page - ((int)($maxdisplay / 2));
2205         if ($pagefrom < 0) {
2206             $pagefrom = 0;
2207         }
2208         $pageto = $pagefrom + $maxdisplay - 1;
2209         if ($pageto > $maxpageallowed) {
2210             $pageto = $maxpageallowed;
2211         }
2212         if ($pageto > $maxpage) {
2213             $pageto = $maxpage;
2214         }
2215
2216         //Some movements can be necessary if don't see enought pages
2217         if ($pageto - $pagefrom < $maxdisplay - 1) {
2218             if ($pageto - $maxdisplay + 1 > 0) {
2219                 $pagefrom = $pageto - $maxdisplay + 1;
2220             }
2221         }
2222
2223         //Calculate first and last if necessary
2224         $firstpagecode = '';
2225         $lastpagecode = '';
2226         if ($pagefrom > 0) {
2227             $firstpagecode = "$separator<a href=\"{$baseurl}page=0\">1</a>";
2228             if ($pagefrom > 1) {
2229                 $firstpagecode .= "$separator...";
2230             }
2231         }
2232         if ($pageto < $maxpage) {
2233             if ($pageto < $maxpage -1) {
2234                 $lastpagecode = "$separator...";
2235             }
2236             $lastpagecode .= "$separator<a href=\"{$baseurl}page=$maxpage\">".($maxpage+1)."</a>";
2237         }
2238
2239         //Previous
2240         if ($page > 0 && $previousandnext) {
2241             $pagenum = $page - 1;
2242             $code .= "&nbsp;(<a  href=\"{$baseurl}page=$pagenum\">".get_string("previous")."</a>)&nbsp;";
2243         }
2244
2245         //Add first
2246         $code .= $firstpagecode;
2247
2248         $pagenum = $pagefrom;
2249
2250         //List of maxdisplay pages
2251         while ($pagenum <= $pageto) {
2252             $pagetoshow = $pagenum +1;
2253             if ($pagenum == $page && !$specialselected) {
2254                 $code .= "$separator<b>$pagetoshow</b>";
2255             } else {
2256                 $code .= "$separator<a href=\"{$baseurl}page=$pagenum\">$pagetoshow</a>";
2257             }
2258             $pagenum++;
2259         }
2260
2261         //Add last
2262         $code .= $lastpagecode;
2263
2264         //Next
2265         if ($page < $maxpage && $page < $maxpageallowed && $previousandnext) {
2266             $pagenum = $page + 1;
2267             $code .= "$separator(<a href=\"{$baseurl}page=$pagenum\">".get_string("next")."</a>)";
2268         }
2269
2270         //Add special
2271         if ($showspecial) {
2272             $code .= '<br />';
2273             if ($specialselected) {
2274                 $code .= "<b>$specialtext</b>";
2275             } else {
2276                 $code .= "$separator<a href=\"{$baseurl}page=$specialvalue\">$specialtext</a>";
2277             }
2278         }
2279
2280         //End html
2281         $code .= "</p>";
2282         $code .= "</div>";
2283     }
2284
2285     return $code;
2286 }
2287 /**
2288  * @return array
2289  */
2290 function glossary_get_view_actions() {
2291     return array('view','view all','view entry');
2292 }
2293 /**
2294  * @return array
2295  */
2296 function glossary_get_post_actions() {
2297     return array('add category','add entry','approve entry','delete category','delete entry','edit category','update entry');
2298 }
2299
2300
2301 /**
2302  * Implementation of the function for printing the form elements that control
2303  * whether the course reset functionality affects the glossary.
2304  * @param object $mform form passed by reference
2305  */
2306 function glossary_reset_course_form_definition(&$mform) {
2307     $mform->addElement('header', 'glossaryheader', get_string('modulenameplural', 'glossary'));
2308     $mform->addElement('checkbox', 'reset_glossary_all', get_string('resetglossariesall','glossary'));
2309
2310     $mform->addElement('select', 'reset_glossary_types', get_string('resetglossaries', 'glossary'),
2311                        array('main'=>get_string('mainglossary', 'glossary'), 'secondary'=>get_string('secondaryglossary', 'glossary')), array('multiple' => 'multiple'));
2312     $mform->setAdvanced('reset_glossary_types');
2313     $mform->disabledIf('reset_glossary_types', 'reset_glossary_all', 'checked');
2314
2315     $mform->addElement('checkbox', 'reset_glossary_notenrolled', get_string('deletenotenrolled', 'glossary'));
2316     $mform->disabledIf('reset_glossary_notenrolled', 'reset_glossary_all', 'checked');
2317
2318     $mform->addElement('checkbox', 'reset_glossary_ratings', get_string('deleteallratings'));
2319     $mform->disabledIf('reset_glossary_ratings', 'reset_glossary_all', 'checked');
2320
2321     $mform->addElement('checkbox', 'reset_glossary_comments', get_string('deleteallcomments'));
2322     $mform->disabledIf('reset_glossary_comments', 'reset_glossary_all', 'checked');
2323 }
2324
2325 /**
2326  * Course reset form defaults.
2327  * @return array
2328  */
2329 function glossary_reset_course_form_defaults($course) {
2330     return array('reset_glossary_all'=>0, 'reset_glossary_ratings'=>1, 'reset_glossary_comments'=>1, 'reset_glossary_notenrolled'=>0);
2331 }
2332
2333 /**
2334  * Removes all grades from gradebook
2335  *
2336  * @global object
2337  * @param int $courseid
2338  * @param string optional type
2339  */
2340 function glossary_reset_gradebook($courseid, $type='') {
2341     global $DB;
2342
2343     switch ($type) {
2344         case 'main'      : $type = "AND g.mainglossary=1"; break;
2345         case 'secondary' : $type = "AND g.mainglossary=0"; break;
2346         default          : $type = ""; //all
2347     }
2348
2349     $sql = "SELECT g.*, cm.idnumber as cmidnumber, g.course as courseid
2350               FROM {glossary} g, {course_modules} cm, {modules} m
2351              WHERE m.name='glossary' AND m.id=cm.module AND cm.instance=g.id AND g.course=? $type";
2352
2353     if ($glossarys = $DB->get_records_sql($sql, array($courseid))) {
2354         foreach ($glossarys as $glossary) {
2355             glossary_grade_item_update($glossary, 'reset');
2356         }
2357     }
2358 }
2359 /**
2360  * Actual implementation of the rest coures functionality, delete all the
2361  * glossary responses for course $data->courseid.
2362  *
2363  * @global object
2364  * @param $data the data submitted from the reset course.
2365  * @return array status array
2366  */
2367 function glossary_reset_userdata($data) {
2368     global $CFG, $DB;
2369     require_once($CFG->dirroot.'/rating/lib.php');
2370
2371     $componentstr = get_string('modulenameplural', 'glossary');
2372     $status = array();
2373
2374     $allentriessql = "SELECT e.id
2375                         FROM {glossary_entries} e
2376                              JOIN {glossary} g ON e.glossaryid = g.id
2377                        WHERE g.course = ?";
2378
2379     $allglossariessql = "SELECT g.id
2380                            FROM {glossary} g
2381                           WHERE g.course = ?";
2382
2383     $params = array($data->courseid);
2384
2385     $fs = get_file_storage();
2386
2387     $rm = new rating_manager();
2388     $ratingdeloptions = new stdclass();
2389
2390     // delete entries if requested
2391     if (!empty($data->reset_glossary_all)
2392          or (!empty($data->reset_glossary_types) and in_array('main', $data->reset_glossary_types) and in_array('secondary', $data->reset_glossary_types))) {
2393
2394         //$DB->delete_records_select('glossary_ratings', "entryid IN ($allentriessql)", $params);
2395         // TODO: delete comments
2396         //$DB->delete_records_select('comments', "entryid IN ($allentriessql)", array());
2397         $DB->delete_records_select('glossary_entries', "glossaryid IN ($allglossariessql)", $params);
2398
2399         // now get rid of all attachments
2400         if ($glossaries = $DB->get_records_sql($allglossariessql, $params)) {
2401             foreach ($glossaries as $glossaryid=>$unused) {
2402                 if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2403                     continue;
2404                 }
2405                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2406                 $fs->delete_area_files($context->id, 'glossary_attachment');
2407
2408                 //delete ratings
2409                 $ratingdeloptions->contextid = $context->id;
2410                 $rm->delete_ratings($ratingdeloptions);
2411             }
2412         }
2413
2414         // remove all grades from gradebook
2415         if (empty($data->reset_gradebook_grades)) {
2416             glossary_reset_gradebook($data->courseid);
2417         }
2418
2419         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossariesall', 'glossary'), 'error'=>false);
2420
2421     } else if (!empty($data->reset_glossary_types)) {
2422         $mainentriessql         = "$allentries AND g.mainglossary=1";
2423         $secondaryentriessql    = "$allentries AND g.mainglossary=0";
2424
2425         $mainglossariessql      = "$allglossariessql AND g.mainglossary=1";
2426         $secondaryglossariessql = "$allglossariessql AND g.mainglossary=0";
2427
2428         if (in_array('main', $data->reset_glossary_types)) {
2429             //$DB->delete_records_select('glossary_ratings', "entryid IN ($mainentriessql)", $params);
2430             $DB->delete_records_select('glossary_comments', "entryid IN ($mainentriessql)", $params);
2431             $DB->delete_records_select('glossary_entries', "glossaryid IN ($mainglossariessql)", $params);
2432
2433             if ($glossaries = $DB->get_records_sql($mainglossariessql, $params)) {
2434                 foreach ($glossaries as $glossaryid=>$unused) {
2435                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2436                         continue;
2437                     }
2438                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2439                     $fs->delete_area_files($context->id, 'glossary_attachment');
2440
2441                     //delete ratings
2442                     $ratingdeloptions->contextid = $context->id;
2443                     $rm->delete_ratings($ratingdeloptions);
2444                 }
2445             }
2446
2447             // remove all grades from gradebook
2448             if (empty($data->reset_gradebook_grades)) {
2449                 glossary_reset_gradebook($data->courseid, 'main');
2450             }
2451
2452             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary'), 'error'=>false);
2453
2454         } else if (in_array('secondary', $data->reset_glossary_types)) {
2455             $DB->delete_records_select('glossary_ratings', "entryid IN ($secondaryentriessql)", $params);
2456             $DB->delete_records_select('glossary_comments', "entryid IN ($secondaryentriessql)", $params);
2457             $DB->delete_records_select('glossary_entries', "glossaryid IN ($secondaryglossariessql)", $params);
2458             // remove exported source flag from entries in main glossary
2459             $DB->execute("UPDATE {glossary_entries
2460                              SET sourceglossaryid=0
2461                            WHERE glossaryid IN ($mainglossariessql)", $params);
2462
2463             if ($glossaries = $DB->get_records_sql($secondaryglossariessql, $params)) {
2464                 foreach ($glossaries as $glossaryid=>$unused) {
2465                     if (!$cm = get_coursemodule_from_instance('glossary', $glossaryid)) {
2466                         continue;
2467                     }
2468                     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2469                     $fs->delete_area_files($context->id, 'glossary_attachment');
2470
2471                     //delete ratings
2472                     $ratingdeloptions->contextid = $context->id;
2473                     $rm->delete_ratings($ratingdeloptions);
2474                 }
2475             }
2476
2477             // remove all grades from gradebook
2478             if (empty($data->reset_gradebook_grades)) {
2479                 glossary_reset_gradebook($data->courseid, 'secondary');
2480             }
2481
2482             $status[] = array('component'=>$componentstr, 'item'=>get_string('resetglossaries', 'glossary').': '.get_string('secondaryglossary', 'glossary'), 'error'=>false);
2483         }
2484     }
2485
2486     // remove entries by users not enrolled into course
2487     if (!empty($data->reset_glossary_notenrolled)) {
2488         $entriessql = "SELECT e.id, e.userid, e.glossaryid, u.id AS userexists, u.deleted AS userdeleted
2489                          FROM {glossary_entries} e
2490                               JOIN {glossary} g ON e.glossaryid = g.id
2491                               LEFT JOIN {user} u ON e.userid = u.id
2492                         WHERE g.course = ? AND e.userid > 0";
2493
2494         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2495         $notenrolled = array();
2496         if ($rs = $DB->get_recordset_sql($entriessql, $params)) {
2497             foreach ($rs as $entry) {
2498                 if (array_key_exists($entry->userid, $notenrolled) or !$entry->userexists or $entry->userdeleted
2499                   or !is_enrolled($course_context , $entry->userid)) {
2500                     $DB->delete_records('glossary_ratings', array('entryid'=>$entry->id));
2501                     $DB->delete_records('glossary_comments', array('entryid'=>$entry->id));
2502                     $DB->delete_records('glossary_entries', array('id'=>$entry->id));
2503
2504                     if ($cm = get_coursemodule_from_instance('glossary', $entry->glossaryid)) {
2505                         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2506                         $fs->delete_area_files($context->id, 'glossary_attachment', $entry->id);
2507                     }
2508                 }
2509             }
2510             $rs->close();
2511             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'glossary'), 'error'=>false);
2512         }
2513     }
2514
2515     // remove all ratings
2516     if (!empty($data->reset_glossary_ratings)) {
2517         $DB->delete_records_select('glossary_ratings', "entryid IN ($allentriessql)", $params);
2518         // remove all grades from gradebook
2519         if (empty($data->reset_gradebook_grades)) {
2520             glossary_reset_gradebook($data->courseid);
2521         }
2522         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2523     }
2524
2525     // TODO: remove all comments
2526     if (!empty($data->reset_glossary_comments)) {
2527         $DB->delete_records_select('glossary_comments', "entryid IN ($allentriessql)", $params);
2528         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2529     }
2530
2531     /// updating dates - shift may be negative too
2532     if ($data->timeshift) {
2533         shift_course_mod_dates('glossary', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
2534         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2535     }
2536
2537     return $status;
2538 }
2539
2540 /**
2541  * Returns all other caps used in module
2542  * @return array
2543  */
2544 function glossary_get_extra_capabilities() {
2545     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/site:trustcontent');
2546 }
2547
2548 /**
2549  * @param string $feature FEATURE_xx constant for requested feature
2550  * @return mixed True if module supports feature, null if doesn't know
2551  */
2552 function glossary_supports($feature) {
2553     switch($feature) {
2554         case FEATURE_GROUPS:                  return false;
2555         case FEATURE_GROUPINGS:               return false;
2556         case FEATURE_GROUPMEMBERSONLY:        return true;
2557         case FEATURE_MOD_INTRO:               return true;
2558         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2559         case FEATURE_GRADE_HAS_GRADE:         return true;
2560         case FEATURE_GRADE_OUTCOMES:          return true;
2561         case FEATURE_RATE:                    return true;
2562         case FEATURE_BACKUP_MOODLE2:          return true;
2563
2564         default: return null;
2565     }
2566 }
2567
2568 function glossary_extend_navigation($navigation, $course, $module, $cm) {
2569     global $CFG;
2570     $navigation->add(get_string('standardview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'letter')));
2571     $navigation->add(get_string('categoryview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'cat')));
2572     $navigation->add(get_string('dateview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'date')));
2573     $navigation->add(get_string('authorview', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$cm->id, 'mode'=>'author')));
2574 }
2575
2576 /**
2577  * Adds module specific settings to the settings block
2578  *
2579  * @param settings_navigation $settings The settings navigation object
2580  * @param navigation_node $glossarynode The node to add module settings to
2581  */
2582 function glossary_extend_settings_navigation(settings_navigation $settings, navigation_node $glossarynode) {
2583     global $PAGE, $DB, $CFG, $USER;
2584
2585     $mode = optional_param('mode', '', PARAM_ALPHA);
2586     $hook = optional_param('hook', 'ALL', PARAM_CLEAN);
2587
2588     if (has_capability('mod/glossary:import', $PAGE->cm->context)) {
2589         $glossarynode->add(get_string('importentries', 'glossary'), new moodle_url('/mod/glossary/import.php', array('id'=>$PAGE->cm->id)));
2590     }
2591
2592     if (has_capability('mod/glossary:export', $PAGE->cm->context)) {
2593         $glossarynode->add(get_string('exportentries', 'glossary'), new moodle_url('/mod/glossary/export.php', array('id'=>$PAGE->cm->id, 'mode'=>$mode, 'hook'=>$hook)));
2594     }
2595
2596     if (has_capability('mod/glossary:approve', $PAGE->cm->context) && ($hiddenentries = $DB->count_records('glossary_entries', array('glossaryid'=>$PAGE->cm->instance, 'approved'=>0)))) {
2597         $glossarynode->add(get_string('waitingapproval', 'glossary'), new moodle_url('/mod/glossary/view.php', array('id'=>$PAGE->cm->id, 'mode'=>'approval')));
2598     }
2599
2600     if (has_capability('mod/glossary:write', $PAGE->cm->context)) {
2601         $glossarynode->add(get_string('addentry', 'glossary'), new moodle_url('/mod/glossary/edit.php', array('cmid'=>$PAGE->cm->id)));
2602     }
2603
2604     $glossary = $DB->get_record('glossary', array("id" => $PAGE->cm->instance));
2605
2606     if (!empty($CFG->enablerssfeeds) && !empty($CFG->glossary_enablerssfeeds)
2607     && $glossary->rsstype && $glossary->rssarticles) {
2608         require_once("$CFG->libdir/rsslib.php");
2609
2610         $string = get_string('rsstype','forum');
2611
2612         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'glossary', $glossary->id));
2613         $glossarynode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2614     }
2615 }