mod/journal/lib.php

   1 <?php // $Id$
   2
   3
   4 if (!isset($CFG->journal_showrecentactivity)) {
   5     set_config("journal_showrecentactivity", true);
   6 }
   7
   8
   9
  10 // STANDARD MODULE FUNCTIONS /////////////////////////////////////////////////////////
  11
  12 function journal_user_outline($course, $user, $mod, $journal) {
  13     if ($entry = get_record("journal_entries", "userid", $user->id, "journal", $journal->id)) {
  14
  15         $numwords = count(preg_split("/\w\b/", $entry->text)) - 1;
  16
  17         $result->info = get_string("numwords", "", $numwords);
  18         $result->time = $entry->modified;
  19         return $result;
  20     }
  21     return NULL;
  22 }
  23
  24
  25 function journal_user_complete($course, $user, $mod, $journal) {
  26
  27     if ($entry = get_record("journal_entries", "userid", $user->id, "journal", $journal->id)) {
  28
  29         print_simple_box_start();
  30         if ($entry->modified) {
  31             echo "<p><font size=\"1\">".get_string("lastedited").": ".userdate($entry->modified)."</font></p>";
  32         }
  33         if ($entry->text) {
  34             echo format_text($entry->text, $entry->format);
  35         }
  36         if ($entry->teacher) {
  37             $grades = make_grades_menu($journal->assessed);
  38             journal_print_feedback($course, $entry, $grades);
  39         }
  40         print_simple_box_end();
  41
  42     } else {
  43         print_string("noentry", "journal");
  44     }
  45 }
  46
  47
  48 function journal_user_complete_index($course, $user, $journal, $journalopen, $heading) {
  49 /// Prints a journal, entry and feedback ... used on the journal index page.
  50
  51     if (isteacher($course->id)) {
  52         $entrycount = journal_count_entries($journal, get_current_group($course->id));
  53         $entryinfo  = "&nbsp;(<a href=\"report.php?id=$journal->coursemodule\">".get_string("viewallentries","journal", $entrycount)."</a>)";
  54     } else {
  55         $entryinfo = "";
  56     }
  57
  58     $journal->name = "<a href=\"view.php?id=$journal->coursemodule\">".format_string($journal->name,true)."</a>";
  59
  60     if ($heading) {
  61         echo "<h3>$heading - $journal->name$entryinfo</h3>";
  62     } else {
  63         echo "<h3>$journal->name$entryinfo</h3>";
  64     }
  65
  66     print_simple_box_start("left", "90%");
  67     echo format_text($journal->intro,  $journal->introformat);
  68     print_simple_box_end();
  69     echo "<br clear=\"all\" />";
  70     echo "<br />";
  71
  72     if (isstudent($course->id) or isteacher($course->id)) {
  73
  74         print_simple_box_start("right", "90%");
  75
  76         if ($journalopen) {
  77             echo "<p align=\"right\"><a href=\"edit.php?id=$journal->coursemodule\">";
  78             echo get_string("edit")."</a></p>";
  79         } else {
  80             echo "<p align=\"right\"><a href=\"view.php?id=$journal->coursemodule\">";
  81             echo get_string("view")."</a></p>";
  82         }
  83
  84         if ($entry = get_record("journal_entries", "userid", $user->id, "journal", $journal->id)) {
  85             if ($entry->modified) {
  86                 echo "<p align=\"center\"><font size=\"1\">".get_string("lastedited").": ".userdate($entry->modified)."</font></p>";
  87             }
  88             if ($entry->text) {
  89                 echo format_text($entry->text, $entry->format);
  90             }
  91             if ($entry->teacher) {
  92                 $grades = make_grades_menu($journal->assessed);
  93                 journal_print_feedback($course, $entry, $grades);
  94             }
  95         } else {
  96             print_string("noentry", "journal");
  97         }
  98
  99         print_simple_box_end();
 100         echo "<br clear=\"all\" />";
 101         echo "<br />";
 102     }
 103
 104 }
 105
 106
 107 function journal_cron () {
 108 // Function to be run periodically according to the moodle cron
 109 // Finds all journal notifications that have yet to be mailed out, and mails them
 110
 111     global $CFG, $USER;
 112
 113     $cutofftime = time() - $CFG->maxeditingtime;
 114
 115     if ($entries = journal_get_unmailed_graded($cutofftime)) {
 116         $timenow = time();
 117
 118         foreach ($entries as $entry) {
 119
 120             echo "Processing journal entry $entry->id\n";
 121
 122             if (! $user = get_record("user", "id", "$entry->userid")) {
 123                 echo "Could not find user $entry->userid\n";
 124                 continue;
 125             }
 126
 127             $USER->lang = $user->lang;
 128
 129             if (! $course = get_record("course", "id", "$entry->course")) {
 130                 echo "Could not find course $entry->course\n";
 131                 continue;
 132             }
 133
 134             if (! isstudent($course->id, $user->id) and !isteacher($course->id, $user->id)) {
 135                 continue;  // Not an active participant
 136             }
 137
 138             if (! $teacher = get_record("user", "id", "$entry->teacher")) {
 139                 echo "Could not find teacher $entry->teacher\n";
 140                 continue;
 141             }
 142
 143
 144             if (! $mod = get_coursemodule_from_instance("journal", $entry->journal, $course->id)) {
 145                 echo "Could not find course module for journal id $entry->journal\n";
 146                 continue;
 147             }
 148
 149             unset($journalinfo);
 150             $journalinfo->teacher = fullname($teacher);
 151             $journalinfo->journal = format_string($entry->name,true);
 152             $journalinfo->url = "$CFG->wwwroot/mod/journal/view.php?id=$mod->id";
 153             $modnamepl = get_string( 'modulenameplural','journal' );
 154             $msubject = get_string( 'mailsubject','journal' );
 155
 156             $postsubject = "$course->shortname: $msubject: ".format_string($entry->name,true);
 157             $posttext  = "$course->shortname -> $modnamepl -> ".format_string($entry->name,true)."\n";
 158             $posttext .= "---------------------------------------------------------------------\n";
 159             $posttext .= get_string("journalmail", "journal", $journalinfo)."\n";
 160             $posttext .= "---------------------------------------------------------------------\n";
 161             if ($user->mailformat == 1) {  // HTML
 162                 $posthtml = "<p><font face=\"sans-serif\">".
 163                 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> ->".
 164                 "<a href=\"$CFG->wwwroot/mod/journal/index.php?id=$course->id\">journals</a> ->".
 165                 "<a href=\"$CFG->wwwroot/mod/journal/view.php?id=$mod->id\">".format_string($entry->name,true)."</a></font></p>";
 166                 $posthtml .= "<hr /><font face=\"sans-serif\">";
 167                 $posthtml .= "<p>".get_string("journalmailhtml", "journal", $journalinfo)."</p>";
 168                 $posthtml .= "</font><hr />";
 169             } else {
 170               $posthtml = "";
 171             }
 172
 173             if (! email_to_user($user, $teacher, $postsubject, $posttext, $posthtml)) {
 174                 echo "Error: Journal cron: Could not send out mail for id $entry->id to user $user->id ($user->email)\n";
 175             }
 176             if (! set_field("journal_entries", "mailed", "1", "id", "$entry->id")) {
 177                 echo "Could not update the mailed field for id $entry->id\n";
 178             }
 179         }
 180     }
 181
 182     return true;
 183 }
 184
 185 function journal_print_recent_activity($course, $isteacher, $timestart) {
 186     global $CFG;
 187
 188     if (!empty($CFG->journal_showrecentactivity)) {    // Don't even bother
 189         return false;
 190     }
 191
 192     $content = false;
 193     $journals = NULL;
 194
 195     // log table should not be used here
 196
 197     if (!$logs = get_records_select('log', 'time > \''.$timestart.'\' AND '.
 198                                            'course = \''.$course->id.'\' AND '.
 199                                            'module = \'journal\' AND '.
 200                                            '(action = \'add entry\' OR action = \'update entry\')', 'time ASC')){
 201         return false;
 202     }
 203
 204     foreach ($logs as $log) {
 205         ///Get journal info.  I'll need it later
 206         $j_log_info = journal_log_info($log);
 207
 208         $cm = $modinfo->instances['journal'][$j_log_info->id];
 209         if (!$cm->uservisible) {
 210             continue;
 211         }
 212
 213         if (!isset($journals[$log->info])) {
 214             $journals[$log->info] = $j_log_info;
 215             $journals[$log->info]->time = $log->time;
 216             $journals[$log->info]->url = str_replace('&', '&amp;', $log->url);
 217         }
 218     }
 219
 220     if ($journals) {
 221         $content = true;
 222         print_headline(get_string('newjournalentries', 'journal').':');
 223         foreach ($journals as $journal) {
 224             print_recent_activity_note($journal->time, $journal, $journal->name,
 225                                        $CFG->wwwroot.'/mod/journal/'.$journal->url);
 226         }
 227     }
 228
 229     return $content;
 230 }
 231
 232 function journal_grades($journalid) {
 233 /// Must return an array of grades, indexed by user, and a max grade.
 234
 235     if (!$journal = get_record("journal", "id", $journalid)) {
 236         return NULL;
 237     }
 238
 239     $grades = get_records_menu("journal_entries", "journal",
 240                                $journal->id, "", "userid,rating");
 241
 242     if ($journal->assessed > 0) {
 243         $return->grades = $grades;
 244         $return->maxgrade = $journal->assessed;
 245
 246     } else if ($journal->assessed == 0) {
 247         return NULL;
 248
 249     } else {
 250         if ($scale = get_record("scale", "id", - $journal->assessed)) {
 251             $scalegrades = make_menu_from_list($scale->scale);
 252             if ($grades) {
 253                 foreach ($grades as $key => $grade) {
 254                     $grades[$key] = $scalegrades[$grade];
 255                 }
 256             }
 257         }
 258         $return->grades = $grades;
 259         $return->maxgrade = "";
 260     }
 261
 262     return $return;
 263 }
 264
 265 function journal_get_participants($journalid) {
 266 //Returns the users with data in one journal
 267 //(users with records in journal_entries, students and teachers)
 268
 269     global $CFG;
 270
 271     //Get students
 272     $students = get_records_sql("SELECT DISTINCT u.id, u.id
 273                                  FROM {$CFG->prefix}user u,
 274                                       {$CFG->prefix}journal_entries j
 275                                  WHERE j.journal = '$journalid' and
 276                                        u.id = j.userid");
 277     //Get teachers
 278     $teachers = get_records_sql("SELECT DISTINCT u.id, u.id
 279                                  FROM {$CFG->prefix}user u,
 280                                       {$CFG->prefix}journal_entries j
 281                                  WHERE j.journal = '$journalid' and
 282                                        u.id = j.teacher");
 283
 284     //Add teachers to students
 285     if ($teachers) {
 286         foreach ($teachers as $teacher) {
 287             $students[$teacher->id] = $teacher;
 288         }
 289     }
 290     //Return students array (it contains an array of unique users)
 291     return ($students);
 292 }
 293
 294 function journal_scale_used ($journalid,$scaleid) {
 295 //This function returns if a scale is being used by one journal
 296
 297     $return = false;
 298
 299     $rec = get_record("journal","id","$journalid","assessed","-$scaleid");
 300
 301     if (!empty($rec) && !empty($scaleid)) {
 302         $return = true;
 303     }
 304
 305     return $return;
 306 }
 307
 308 /**
 309  * Checks if scale is being used by any instance of journal
 310  *
 311  * This is used to find out if scale used anywhere
 312  * @param $scaleid int
 313  * @return boolean True if the scale is used by any journal
 314  */
 315 function journal_scale_used_anywhere($scaleid) {
 316     if ($scaleid and record_exists('journal', 'assessed', -$scaleid)) {
 317         return true;
 318     } else {
 319         return false;
 320     }
 321 }
 322
 323 // SQL FUNCTIONS ///////////////////////////////////////////////////////////////////
 324
 325 function journal_get_users_done($journal) {
 326     global $CFG;
 327
 328     $journals = get_records_sql ("SELECT u.*
 329                                   FROM {$CFG->prefix}journal_entries j,
 330                                        {$CFG->prefix}user u
 331                                  WHERE j.userid = u.id
 332                                    AND j.journal = $journal->id
 333                               ORDER BY j.modified DESC");
 334
 335     if (empty($journals)) {
 336         return NULL;
 337     }
 338
 339     // remove unenrolled participants
 340     foreach ($journals as $key=>$user) {
 341         if (!isteacher($journal->course, $user->id) and !isstudent($journal->course, $user->id)) {
 342             unset($journals[$key]);
 343         }
 344     }
 345     return $journals;
 346 }
 347
 348 function journal_count_entries($journal, $groupid=0) {
 349 /// Counts all the journal entries (optionally in a given group)
 350
 351     global $CFG, $db;
 352
 353     if ($groupid) {     /// How many in a particular group?
 354         return count_records_sql("SELECT COUNT(*)
 355                                      FROM {$CFG->prefix}journal_entries j,
 356                                           {$CFG->prefix}groups_members g
 357                                     WHERE j.journal = $journal->id
 358                                       AND g.groupid = '$groupid'
 359                                       AND j.userid = g.userid");
 360
 361     } else { /// Count all the entries from the whole course
 362
 363         $journals = get_records_sql ("SELECT u.*
 364                                       FROM {$CFG->prefix}journal_entries j,
 365                                            {$CFG->prefix}user u
 366                                      WHERE j.userid = u.id
 367                                        AND j.journal = $journal->id
 368                                   ORDER BY j.modified DESC");
 369
 370         if (empty($journals)) {
 371             return 0;
 372         }
 373
 374         // remove unenrolled participants
 375         foreach ($journals as $key=>$user) {
 376             if (!isteacher($journal->course, $user->id) and !isstudent($journal->course, $user->id)) {
 377                 unset($journals[$key]);
 378             }
 379         }
 380         return count($journals);
 381     }
 382 }
 383
 384
 385 function journal_get_unmailed_graded($cutofftime) {
 386     global $CFG;
 387     return get_records_sql("SELECT e.*, j.course, j.name
 388                               FROM {$CFG->prefix}journal_entries e,
 389                                    {$CFG->prefix}journal j
 390                              WHERE e.mailed = '0'
 391                                AND e.timemarked < '$cutofftime'
 392                                AND e.timemarked > 0
 393                                AND e.journal = j.id");
 394 }
 395
 396 function journal_log_info($log) {
 397     global $CFG;
 398     return get_record_sql("SELECT j.*, u.firstname, u.lastname
 399                              FROM {$CFG->prefix}journal j,
 400                                   {$CFG->prefix}journal_entries e,
 401                                   {$CFG->prefix}user u
 402                             WHERE e.id = '$log->info'
 403                               AND e.journal = j.id
 404                               AND e.userid = u.id");
 405 }
 406
 407 // OTHER JOURNAL FUNCTIONS ///////////////////////////////////////////////////////////////////
 408
 409
 410
 411 function journal_print_user_entry($course, $user, $entry, $teachers, $grades) {
 412     global $USER;
 413
 414     echo "\n<table border=\"1\" cellspacing=\"0\" valign=\"top\" cellpadding=\"10\">";
 415
 416     echo "\n<tr>";
 417     echo "\n<td rowspan=\"2\" width=\"35\" valign=\"top\">";
 418     print_user_picture($user->id, $course->id, $user->picture);
 419     echo "</td>";
 420     echo "<td nowrap=\"nowrap\" width=\"100%\">".fullname($user);
 421     if ($entry) {
 422         echo "&nbsp;&nbsp;<font size=\"1\">".get_string("lastedited").": ".userdate($entry->modified)."</font>";
 423     }
 424     echo "</td>";
 425     echo "</tr>";
 426
 427     echo "\n<tr><td width=\"100%\">";
 428     if ($entry) {
 429         echo format_text($entry->text, $entry->format);
 430     } else {
 431         print_string("noentry", "journal");
 432     }
 433     echo "</td></tr>";
 434
 435     if ($entry) {
 436         echo "\n<tr>";
 437         echo "<td width=\"35\" valign=\"top\">";
 438         if (!$entry->teacher) {
 439             $entry->teacher = $USER->id;
 440         }
 441         print_user_picture($entry->teacher, $course->id, $teachers[$entry->teacher]->picture);
 442         echo "</td>";
 443         echo "<td>".get_string("feedback").":";
 444         choose_from_menu($grades, "r$entry->id", $entry->rating, get_string("nograde")."...");
 445         if ($entry->timemarked) {
 446             echo "&nbsp;&nbsp;<font size=\"1\">".userdate($entry->timemarked)."</font>";
 447         }
 448         echo "<br /><textarea name=\"c$entry->id\" rows=\"12\" cols=\"60\" wrap=\"virtual\">";
 449         p($entry->entrycomment);
 450         echo "</textarea><br />";
 451         echo "</td></tr>";
 452     }
 453     echo "</table><br clear=\"all\" />\n";
 454 }
 455
 456
 457 function journal_add_instance($journal) {
 458 // Given an object containing all the necessary data,
 459 // (defined by the form in mod.html) this function
 460 // will create a new instance and return the id number
 461 // of the new instance.
 462
 463     $journal->timemodified = time();
 464
 465     return insert_record("journal", $journal);
 466 }
 467
 468
 469 function journal_update_instance($journal) {
 470 // Given an object containing all the necessary data,
 471 // (defined by the form in mod.html) this function
 472 // will update an existing instance with new data.
 473
 474     $journal->timemodified = time();
 475     $journal->id = $journal->instance;
 476
 477     return update_record("journal", $journal);
 478 }
 479
 480
 481 function journal_delete_instance($id) {
 482 // Given an ID of an instance of this module,
 483 // this function will permanently delete the instance
 484 // and any data that depends on it.
 485
 486     if (! $journal = get_record("journal", "id", $id)) {
 487         return false;
 488     }
 489
 490     $result = true;
 491
 492     if (! delete_records("journal_entries", "journal", $journal->id)) {
 493         $result = false;
 494     }
 495
 496     if (! delete_records("journal", "id", $journal->id)) {
 497         $result = false;
 498     }
 499
 500     return $result;
 501
 502 }
 503
 504
 505 function journal_print_feedback($course, $entry, $grades) {
 506     global $CFG;
 507
 508     if (! $teacher = get_record('user', 'id', $entry->teacher)) {
 509         error('Weird journal error');
 510     }
 511
 512     echo '<table cellspacing="0" align="center" class="feedbackbox">';
 513
 514     echo '<tr>';
 515     echo '<td class="left picture">';
 516     print_user_picture($teacher->id, $course->id, $teacher->picture);
 517     echo '</td>';
 518     echo '<td class="entryheader">';
 519     echo '<span class="author">'.fullname($teacher).'</span>';
 520     echo '&nbsp;&nbsp;<span class="time">'.userdate($entry->timemarked).'</span>';
 521     echo '</td>';
 522     echo '</tr>';
 523
 524     echo '<tr>';
 525     echo '<td class="left side">&nbsp;</td>';
 526     echo '<td class="entrycontent">';
 527
 528     echo '<div class="grade">';
 529
 530     if (!empty($entry->rating) and !empty($grades[$entry->rating])) {
 531         echo get_string('grade').': ';
 532         echo $grades[$entry->rating];
 533     } else {
 534         print_string('nograde');
 535     }
 536     echo '</div>';
 537
 538     echo format_text($entry->entrycomment);
 539     echo '</td></tr></table>';
 540 }
 541
 542 function journal_get_view_actions() {
 543     return array('view','view all','view responses');
 544 }
 545
 546 function journal_get_post_actions() {
 547     return array('add entry','update entry','update feedback');
 548 }
 549
 550 /**
 551  * Returns all other caps used in module
 552  */
 553 function journal_get_extra_capabilities() {
 554     return array('moodle/site:accessallgroups');
 555 }
 556
 557 ?>