mod/dialogue/lib.php

   1 <?php // $Id$
   2
   3 $DIALOGUE_DAYS = array (0 => 0, 7 => 7, 14 => 14, 30 => 30, 150 => 150, 365 => 365 );
   4
   5
   6 // STANDARD MODULE FUNCTIONS /////////////////////////////////////////////////////////
   7
   8 //////////////////////////////////////////////////////////////////////////////////////
   9 function dialogue_add_instance($dialogue) {
  10 // Given an object containing all the necessary data,
  11 // (defined by the form in mod.html) this function
  12 // will create a new instance and return the id number
  13 // of the new instance.
  14
  15     $dialogue->timemodified = time();
  16
  17     return insert_record("dialogue", $dialogue);
  18 }
  19
  20
  21 //////////////////////////////////////////////////////////////////////////////////////
  22 function dialogue_cron () {
  23 // Function to be run periodically according to the moodle cron
  24
  25     global $CFG, $USER;
  26
  27 // delete any closed conversations which have expired
  28     dialogue_delete_expired_conversations();
  29
  30 // Finds all dialogue entries that have yet to be mailed out, and mails them
  31     if ($entries = get_records_select("dialogue_entries", "mailed = '0'")) {
  32         foreach ($entries as $entry) {
  33
  34             echo "Processing dialogue entry $entry->id\n";
  35
  36             if (! $userfrom = get_record("user", "id", "$entry->userid")) {
  37                 echo "Could not find user $entry->userid\n";
  38                 continue;
  39             }
  40             // get conversation record
  41             if(!$conversation = get_record("dialogue_conversations", "id", $entry->conversationid)) {
  42                 echo "Could not find conversation $entry->conversationid\n";
  43             }
  44             if ($userfrom->id == $conversation->userid) {
  45                 if (!$userto = get_record("user", "id", $conversation->recipientid)) {
  46                     echo "Could not find use $conversation->recipientid\n";
  47                 }
  48             }
  49             else {
  50                 if (!$userto = get_record("user", "id", $conversation->userid)) {
  51                     echo "Could not find use $conversation->userid\n";
  52                 }
  53             }
  54
  55             $USER->lang = $userto->lang;
  56
  57             if (! $dialogue = get_record("dialogue", "id", $conversation->dialogueid)) {
  58                 echo "Could not find dialogue id $conversation->dialogueid\n";
  59                 continue;
  60             }
  61             if (! $course = get_record("course", "id", "$dialogue->course")) {
  62                 echo "Could not find course $dialogue->course\n";
  63                 continue;
  64             }
  65             if (! $cm = get_coursemodule_from_instance("dialogue", $dialogue->id, $course->id)) {
  66                 echo "Course Module ID was incorrect\n";
  67             }
  68
  69             if (! isstudent($course->id, $userfrom->id) and !isteacher($course->id, $userfrom->id)) {
  70                 continue;  // Not an active participant
  71             }
  72             if (! isstudent($course->id, $userto->id) and !isteacher($course->id, $userto->id)) {
  73                 continue;  // Not an active participant
  74             }
  75
  76             $strdialogues = get_string("modulenameplural", "dialogue");
  77             $strdialogue  = get_string("modulename", "dialogue");
  78
  79             unset($dialogueinfo);
  80             $dialogueinfo->userfrom = fullname($userfrom);
  81             $dialogueinfo->dialogue = "$dialogue->name";
  82             $dialogueinfo->url = "$CFG->wwwroot/mod/dialogue/view.php?id=$cm->id";
  83
  84             $postsubject = "$course->shortname: $strdialogues: $dialogue->name: ".
  85                 get_string("newentry", "dialogue");
  86             $posttext  = "$course->shortname -> $strdialogues -> $dialogue->name\n";
  87             $posttext .= "---------------------------------------------------------------------\n";
  88             $posttext .= get_string("dialoguemail", "dialogue", $dialogueinfo)." \n";
  89             $posttext .= "---------------------------------------------------------------------\n";
  90             if ($userto->mailformat == 1) {  // HTML
  91                 $posthtml = "<p><font face=\"sans-serif\">".
  92                 "<a href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> ->".
  93                 "<a href=\"$CFG->wwwroot/mod/dialogue/index.php?id=$course->id\">dialogues</a> ->".
  94                 "<a href=\"$CFG->wwwroot/mod/dialogue/view.php?id=$cm->id\">$dialogue->name</a></font></p>";
  95                 $posthtml .= "<hr /><font face=\"sans-serif\">";
  96                 $posthtml .= "<p>".get_string("dialoguemailhtml", "dialogue", $dialogueinfo)."</p>";
  97                 $posthtml .= "</font><hr />";
  98             } else {
  99               $posthtml = "";
 100             }
 101
 102             if (! email_to_user($userto, $userfrom, $postsubject, $posttext, $posthtml)) {
 103                 echo "Error: dialogue cron: Could not send out mail for id $entry->id to user $userto->id ($userto->email)\n";
 104             }
 105             if (! set_field("dialogue_entries", "mailed", "1", "id", "$entry->id")) {
 106                 echo "Could not update the mailed field for id $entry->id\n";
 107             }
 108         }
 109     }
 110
 111     return true;
 112 }
 113
 114
 115 //////////////////////////////////////////////////////////////////////////////////////
 116 function dialogue_delete_instance($id) {
 117 // Given an ID of an instance of this module,
 118 // this function will permanently delete the instance
 119 // and any data that depends on it.
 120
 121     if (! $dialogue = get_record("dialogue", "id", $id)) {
 122         return false;
 123     }
 124
 125     $result = true;
 126
 127     if (! delete_records("dialogue_conversations", "dialogueid", $dialogue->id)) {
 128         $result = false;
 129     }
 130
 131     if (! delete_records("dialogue_entries", "dialogueid", $dialogue->id)) {
 132         $result = false;
 133     }
 134
 135     if (! delete_records("dialogue", "id", $dialogue->id)) {
 136         $result = false;
 137     }
 138
 139     return $result;
 140
 141 }
 142
 143
 144 //////////////////////////////////////////////////////////////////////////////////////
 145 function dialogue_print_recent_activity($course, $isteacher, $timestart) {
 146     global $CFG;
 147
 148     // have a look for new entries
 149     $addentrycontent = false;
 150     if ($logs = dialogue_get_add_entry_logs($course, $timestart)) {
 151         // got some, see if any belong to a visible module
 152         foreach ($logs as $log) {
 153             // Create a temp valid module structure (only need courseid, moduleid)
 154             $tempmod->course = $course->id;
 155             $tempmod->id = $log->dialogueid;
 156             //Obtain the visible property from the instance
 157             if (instance_is_visible("dialogue",$tempmod)) {
 158                 $addentrycontent = true;
 159                 break;
 160             }
 161         }
 162         // if we got some "live" ones then output them
 163         if ($addentrycontent) {
 164             print_headline(get_string('newdialogueentries', 'dialogue').':');
 165             foreach ($logs as $log) {
 166                 //Create a temp valid module structure (only need courseid, moduleid)
 167                 $tempmod->course = $course->id;
 168                 $tempmod->id = $log->dialogueid;
 169                 //Obtain the visible property from the instance
 170                 if (instance_is_visible("dialogue",$tempmod)) {
 171                     print_recent_activity_note($log->time, $log, $isteacher, $log->name,
 172                                                $CFG->wwwroot.'/mod/dialogue/'.str_replace('&', '&amp;', $log->url));
 173                 }
 174             }
 175         }
 176     }
 177
 178     // have a look for open conversations
 179     $opencontent = false;
 180     if ($logs = dialogue_get_open_conversations($course)) {
 181         // got some, see if any belong to a visible module
 182         foreach ($logs as $log) {
 183             // Create a temp valid module structure (only need courseid, moduleid)
 184             $tempmod->course = $course->id;
 185             $tempmod->id = $log->dialogueid;
 186             //Obtain the visible property from the instance
 187             if (instance_is_visible('dialogue',$tempmod)) {
 188                 $opencontent = true;
 189                 break;
 190             }
 191         }
 192         // if we got some 'live' ones then output them
 193         if ($opencontent) {
 194             print_headline(get_string('opendialogueentries', 'dialogue').':');
 195             foreach ($logs as $log) {
 196                 //Create a temp valid module structure (only need courseid, moduleid)
 197                 $tempmod->course = $course->id;
 198                 $tempmod->id = $log->dialogueid;
 199                 //Obtain the visible property from the instance
 200                 if (instance_is_visible('dialogue',$tempmod)) {
 201                     print_recent_activity_note($log->time, $log, $isteacher, $log->name,
 202                                                $CFG->wwwroot.'/mod/dialogue/'.str_replace('&', '&amp;', $log->url));
 203                 }
 204             }
 205         }
 206     }
 207
 208     return $addentrycontent or $opencontent;
 209 }
 210
 211
 212
 213 //////////////////////////////////////////////////////////////////////////////////////
 214 function dialogue_update_instance($dialogue) {
 215 // Given an object containing all the necessary data,
 216 // (defined by the form in mod.html) this function
 217 // will update an existing instance with new data.
 218
 219     $dialogue->timemodified = time();
 220     $dialogue->id = $dialogue->instance;
 221
 222     return update_record("dialogue", $dialogue);
 223 }
 224
 225
 226 //////////////////////////////////////////////////////////////////////////////////////
 227 function dialogue_user_complete($course, $user, $mod, $dialogue) {
 228
 229     if ($conversations = dialogue_get_conversations($dialogue, $user)) {
 230         print_simple_box_start();
 231         $table->head = array (get_string("dialoguewith", "dialogue"),
 232             get_string("numberofentries", "dialogue"), get_string("lastentry", "dialogue"),
 233             get_string("status", "dialogue"));
 234         $table->width = "100%";
 235         $table->align = array ("left", "center", "left", "left");
 236         $table->size = array ("*", "*", "*", "*");
 237         $table->cellpadding = 2;
 238         $table->cellspacing = 0;
 239
 240         foreach ($conversations as $conversation) {
 241             if ($user->id != $conversation->userid) {
 242                 if (!$with = get_record("user", "id", $conversation->userid)) {
 243                     error("User's record not found");
 244                 }
 245             }
 246             else {
 247                 if (!$with = get_record("user", "id", $conversation->recipientid)) {
 248                     error("User's record not found");
 249                 }
 250             }
 251             $total = dialogue_count_entries($dialogue, $conversation);
 252             $byuser = dialogue_count_entries($dialogue, $conversation, $user);
 253             if ($conversation->closed) {
 254                 $status = get_string("closed", "dialogue");
 255             } else {
 256                 $status = get_string("open", "dialogue");
 257             }
 258             $table->data[] = array(fullname($with), $byuser." ".
 259                 get_string("of", "dialogue")." ".$total, userdate($conversation->timemodified), $status);
 260         }
 261         print_table($table);
 262         print_simple_box_end();
 263     }
 264     else {
 265         print_string("noentry", "dialogue");
 266     }
 267 }
 268
 269
 270 //////////////////////////////////////////////////////////////////////////////////////
 271 function dialogue_user_outline($course, $user, $mod, $dialogue) {
 272     if ($entries = dialogue_get_user_entries($dialogue, $user)) {
 273         $result->info = count($entries);
 274         foreach ($entries as $entry) {
 275             // dialogue_get_user_entries returns the most recent entry first
 276             $result->time = $entry->timecreated;
 277             break;
 278         }
 279         return $result;
 280     }
 281     return NULL;
 282 }
 283
 284 //////////////////////////////////////////////////////////////////////////////////////
 285 // Extra functions needed by the Standard functions
 286 //////////////////////////////////////////////////////////////////////////////////////
 287
 288 //////////////////////////////////////////////////////////////////////////////////////
 289 function dialogue_count_entries($dialogue, $conversation, $user = '') {
 290
 291     if (empty($user)) {
 292         return count_records_select("dialogue_entries", "conversationid = $conversation->id");
 293     }
 294     else {
 295         return count_records_select("dialogue_entries", "conversationid = $conversation->id AND
 296             userid = $user->id");
 297     }
 298 }
 299
 300
 301 //////////////////////////////////////////////////////////////////////////////////////
 302 function dialogue_delete_expired_conversations() {
 303
 304     if ($dialogues = get_records("dialogue")) {
 305        foreach ($dialogues as $dialogue) {
 306            if ($dialogue->deleteafter) {
 307                $expirytime = time() - $dialogue->deleteafter * 86400;
 308                if ($conversations = get_records_select("dialogue_conversations",
 309                    "timemodified < $expirytime AND closed = 1")) {
 310                    foreach ($conversations as $conversation) {
 311                        delete_records("dialogue_conversations", "id", $conversation->id);
 312                        delete_records("dialogue_entries", "conversationid", $conversation->id);
 313                    }
 314                }
 315            }
 316        }
 317     }
 318 }
 319
 320
 321 //////////////////////////////////////////////////////////////////////////////////////
 322 function dialogue_get_add_entry_logs($course, $timestart) {
 323     // get the "add entry" entries and add the first and last names, we are not interested in the entries
 324     // make by this user (the last condition)!
 325     global $CFG, $USER;
 326     if (!isset($USER->id)) {
 327         return false;
 328     }
 329     return get_records_sql("SELECT l.time, l.url, u.firstname, u.lastname, e.dialogueid, d.name
 330                              FROM {$CFG->prefix}log l,
 331                                 {$CFG->prefix}dialogue d,
 332                                 {$CFG->prefix}dialogue_conversations c,
 333                                 {$CFG->prefix}dialogue_entries e,
 334                                 {$CFG->prefix}user u
 335                             WHERE l.time > $timestart AND l.course = $course->id AND l.module = 'dialogue'
 336                                 AND l.action = 'add entry'
 337                                 AND e.id = l.info
 338                                 AND c.id = e.conversationid
 339                                 AND (c.userid = $USER->id or c.recipientid = $USER->id)
 340                                 AND d.id = e.dialogueid
 341                                 AND u.id = e.userid
 342                                 AND e.userid != $USER->id");
 343 }
 344
 345
 346 //////////////////////////////////////////////////////////////////////////////////////
 347 function dialogue_get_closed_logs($course, $timestart) {
 348     // get the "closed" entries and add the first and last names, we are not interested in the entries
 349     // make by this user (the last condition)!
 350     global $CFG, $USER;
 351     if (!isset($USER->id)) {
 352         return false;
 353     }
 354     return get_records_sql("SELECT l.time, l.url, u.firstname, u.lastname, c.dialogueid, d.name
 355                              FROM {$CFG->prefix}log l,
 356                                 {$CFG->prefix}dialogue d,
 357                                 {$CFG->prefix}dialogue_conversations c,
 358                                 {$CFG->prefix}user u
 359                             WHERE l.time > $timestart AND l.course = $course->id AND l.module = 'dialogue'
 360                                 AND l.action = 'closed'
 361                                 AND c.id = l.info
 362                                 AND (c.userid = $USER->id or c.recipientid = $USER->id)
 363                                 AND d.id = c.dialogueid
 364                                 AND u.id = c.lastid
 365                                 AND c.lastid != $USER->id");
 366 }
 367
 368
 369 //////////////////////////////////////////////////////////////////////////////////////
 370 function dialogue_get_conversations($dialogue, $user, $condition = '', $order = '') {
 371     global $CFG;
 372
 373     if (!empty($condition)) {
 374         $condition = ' AND '.$condition;
 375     }
 376     if (empty($order)) {
 377         $order = "timemodified DESC";
 378     }
 379     return get_records_select("dialogue_conversations", "dialogueid = $dialogue->id AND
 380             (userid = $user->id OR recipientid = $user->id) $condition", $order);
 381
 382
 383 }
 384
 385
 386 //////////////////////////////////////////////////////////////////////////////////////
 387 function dialogue_get_open_conversations($course) {
 388     // get the conversations which are waiting for a response for this user.
 389     // Add the first and last names of the other participant
 390     global $CFG, $USER;
 391     if (empty($USER->id)) {
 392         return false;
 393     }
 394     if ($conversations = get_records_sql("SELECT d.name AS dialoguename, c.id, c.dialogueid, c.timemodified, c.lastid
 395                             FROM {$CFG->prefix}dialogue d, {$CFG->prefix}dialogue_conversations c
 396                             WHERE d.course = $course->id
 397                                 AND c.dialogueid = d.id
 398                                 AND (c.userid = $USER->id OR c.recipientid = $USER->id)
 399                                 AND c.lastid != $USER->id
 400                                 AND c.closed =0")) {
 401
 402          foreach ($conversations as $conversation) {
 403             if (!$user = get_record("user", "id", $conversation->lastid)) {
 404                 error("Get open conversations: user record not found");
 405             }
 406             if (!$cm = get_coursemodule_from_instance("dialogue", $conversation->dialogueid, $course->id)) {
 407                 error("Course Module ID was incorrect");
 408             }
 409             $entry[$conversation->id]->dialogueid = $conversation->dialogueid;
 410             $entry[$conversation->id]->time = $conversation->timemodified;
 411             $entry[$conversation->id]->url = "view.php?id=$cm->id";
 412             $entry[$conversation->id]->firstname = $user->firstname;
 413             $entry[$conversation->id]->lastname = $user->lastname;
 414             $entry[$conversation->id]->name = $conversation->dialoguename;
 415         }
 416         return $entry;
 417     }
 418     return;
 419 }
 420
 421
 422 //////////////////////////////////////////////////////////////////////////////////////
 423 function dialogue_get_user_entries($dialogue, $user) {
 424     global $CFG;
 425     return get_records_select("dialogue_entries", "dialogueid = $dialogue->id AND userid = $user->id",
 426                 "timecreated DESC");
 427 }
 428
 429
 430
 431 ?>