lib/moodlelib.php

   1 <?PHP // $Id$
   2
   3 //
   4 // moodlelib.php
   5 //
   6 // Large collection of useful functions used by many parts of Moodle.
   7 //
   8 // Martin Dougiamas, 2000
   9 //
  10
  11 /// STANDARD WEB PAGE PARTS ///////////////////////////////////////////////////
  12
  13 function print_header ($title="", $heading="", $navigation="", $focus="", $meta="", $cache=true, $button="") {
  14 // $title - appears top of window
  15 // $heading - appears top of page
  16 // $navigation - premade navigation string
  17 // $focus - indicates form element eg  inputform.password
  18 // $meta - meta tags in the header
  19 // $cache - should this page be cacheable?
  20 // $button - code for a button in the top-right
  21     global $USER, $CFG, $THEME;
  22
  23     if (file_exists("$CFG->dirroot/theme/$CFG->theme/styles.css")) {
  24         $styles = "$CFG->wwwroot/theme/$CFG->theme/styles.css";
  25     } else {
  26         $styles = "$CFG->wwwroot/theme/standard/styles.css";
  27     }
  28
  29     if ($navigation == "home") {
  30         $home = true;
  31         $navigation = "";
  32     }
  33
  34     if (!$button and $navigation) {
  35         if (isset($USER->id)) {
  36             $button = "<FONT SIZE=2><A HREF=\"$CFG->wwwroot/login/logout.php\">".get_string("logout")."</A></FONT>";
  37         } else {
  38             $button = "<FONT SIZE=2><A HREF=\"$CFG->wwwroot/login/index.php\">".get_string("login")."</A></FONT>";
  39         }
  40     }
  41
  42     // Specify character set ... default is iso-8859-1 but some languages might need something else
  43     // Could be optimised by carrying the charset variable around in $USER
  44     if (current_language() == "en") {
  45         $meta .= "<META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=iso-8859-1\">\n";
  46     } else {
  47         $meta .= "<META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=".get_string("thischarset")."\">\n";
  48     }
  49
  50     if ($CFG->langdir == "RTL") {
  51         $direction = " DIR=\"RTL\"";
  52     } else {
  53         $direction = " DIR=\"LTR\"";
  54     }
  55
  56     if (!$cache) {   // Do everything we can to prevent clients and proxies caching
  57         @header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
  58         @header("Pragma: no-cache");
  59         $meta .= "\n<META HTTP-EQUIV=\"Pragma\" CONTENT=\"no-cache\">";
  60         $meta .= "\n<META HTTP-EQUIV=\"Expires\" CONTENT=\"0\">";
  61     }
  62
  63     include ("$CFG->dirroot/theme/$CFG->theme/header.html");
  64 }
  65
  66 function print_footer ($course=NULL) {
  67 // Can provide a course object to make the footer contain a link to
  68 // to the course home page, otherwise the link will go to the site home
  69     global $USER, $CFG, $THEME;
  70
  71     if ($course) {
  72         if ($course == "home") {   // special case for site home page - please do not remove
  73             $homelink  = "<P ALIGN=center><A TITLE=\"Moodle $CFG->release ($CFG->version)\" HREF=\"http://moodle.com/\">";
  74             $homelink .= "<BR><IMG WIDTH=130 HEIGHT=19 SRC=\"pix/madewithmoodle2.gif\" BORDER=0></A></P>";
  75         } else {
  76             $homelink = "<A TARGET=_top HREF=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</A>";
  77         }
  78     } else {
  79         $homelink = "<A TARGET=_top HREF=\"$CFG->wwwroot\">".get_string("home")."</A>";
  80     }
  81     if ($USER->realuser) {
  82         if ($realuser = get_record("user", "id", $USER->realuser)) {
  83             $realuserinfo = " [$realuser->firstname $realuser->lastname] ";
  84         }
  85     }
  86     if ($USER->id) {
  87         if ($course) {
  88            if ($course == "home") {
  89                $site = get_site();
  90                $username = "<A HREF=\"$CFG->wwwroot/user/view.php?id=$USER->id&course=$site->id\">$USER->firstname $USER->lastname</A>";
  91            } else {
  92                $username = "<A HREF=\"$CFG->wwwroot/user/view.php?id=$USER->id&course=$course->id\">$USER->firstname $USER->lastname</A>";
  93            }
  94         } else {
  95            $username = "$USER->firstname $USER->lastname";
  96         }
  97         $loggedinas = $realuserinfo.get_string("loggedinas", "moodle", "$username").
  98                       " (<A HREF=\"$CFG->wwwroot/login/logout.php\">".get_string("logout")."</A>)";
  99     } else {
 100         $loggedinas = get_string("loggedinnot", "moodle").
 101                       " (<A HREF=\"$CFG->wwwroot/login/index.php\">".get_string("login")."</A>)";
 102     }
 103
 104     include ("$CFG->dirroot/theme/$CFG->theme/footer.html");
 105 }
 106
 107 function print_navigation ($navigation) {
 108    global $CFG;
 109
 110    if ($navigation) {
 111        if (! $site = get_site()) {
 112            $site->shortname = get_string("home");;
 113        }
 114        echo "<A TARGET=_top HREF=\"$CFG->wwwroot/\">$site->shortname</A> -> $navigation";
 115    }
 116 }
 117
 118 function print_heading($text, $align="CENTER", $size=3) {
 119     echo "<P ALIGN=\"$align\"><FONT SIZE=\"$size\"><B>".stripslashes($text)."</B></FONT></P>";
 120 }
 121
 122 function print_heading_with_help($text, $helppage, $module="moodle") {
 123 // Centered heading with attached help button (same title text)
 124     echo "<P ALIGN=\"CENTER\"><FONT SIZE=\"3\"><B>".stripslashes($text);
 125     helpbutton($helppage, $text, $module);
 126     echo "</B></FONT></P>";
 127 }
 128
 129 function print_continue($link) {
 130     global $HTTP_REFERER;
 131
 132     if (!$link) {
 133         $link = $HTTP_REFERER;
 134     }
 135
 136     print_heading("<A HREF=\"$link\">".get_string("continue")."</A>");
 137 }
 138
 139
 140 function print_simple_box($message, $align="", $width="", $color="#FFFFFF", $padding=5, $border=1) {
 141     print_simple_box_start($align, $width, $color, $padding, $border);
 142     echo "<P>".stripslashes($message)."</P>";
 143     print_simple_box_end();
 144 }
 145
 146 function print_simple_box_start($align="", $width="", $color="#FFFFFF", $padding=5, $border=1) {
 147     global $THEME;
 148
 149     if ($align) {
 150         $tablealign = "ALIGN=\"$align\"";
 151     }
 152     if ($width) {
 153         $tablewidth = "WIDTH=\"$width\"";
 154         $innertablewidth = "WIDTH=\"100%\"";
 155     }
 156     echo "<TABLE $tablealign $tablewidth BORDER=0 CELLPADDING=\"$border\" CELLSPACING=0>";
 157     echo "<TR><TD BGCOLOR=\"$THEME->borders\">\n";
 158     echo "<TABLE $innertablewidth BORDER=0 CELLPADDING=\"$padding\" CELLSPACING=0><TR><TD BGCOLOR=\"$color\">";
 159 }
 160
 161 function print_simple_box_end() {
 162     echo "</TD></TR></TABLE>";
 163     echo "</TD></TR></TABLE>";
 164 }
 165
 166 function print_single_button($link, $options, $label="OK") {
 167     echo "<FORM ACTION=\"$link\" METHOD=GET>";
 168     if ($options) {
 169         foreach ($options as $name => $value) {
 170             echo "<INPUT TYPE=hidden NAME=\"$name\" VALUE=\"$value\">";
 171         }
 172     }
 173     echo "<INPUT TYPE=submit VALUE=\"$label\"></FORM>";
 174 }
 175
 176 function print_spacer($height=1, $width=1, $br=true) {
 177     global $CFG;
 178     echo "<IMG HEIGHT=\"$height\" WIDTH=\"$width\" SRC=\"$CFG->wwwroot/pix/spacer.gif\" ALT=\"\">";
 179     if ($br) {
 180         echo "<BR>\n";
 181     }
 182 }
 183
 184 function print_file_picture($path, $courseid=0, $height="", $width="", $link="") {
 185 // Given the path to a picture file in a course, or a URL,
 186 // this function includes the picture in the page.
 187     global $CFG;
 188
 189     if ($height) {
 190         $height = "HEIGHT=\"$height\"";
 191     }
 192     if ($width) {
 193         $width = "WIDTH=\"$width\"";
 194     }
 195     if ($link) {
 196         echo "<A HREF=\"$link\">";
 197     }
 198     if (substr(strtolower($path), 0, 7) == "http://") {
 199         echo "<IMG BORDER=0 $height $width SRC=\"$path\">";
 200
 201     } else if ($courseid) {
 202         echo "<IMG BORDER=0 $height $width SRC=\"";
 203         if ($CFG->slasharguments) {        // Use this method if possible for better caching
 204             echo "$CFG->wwwroot/file.php/$courseid/$path";
 205         } else {
 206             echo "$CFG->wwwroot/file.php?file=$courseid/$path";
 207         }
 208         echo "\">";
 209     } else {
 210         echo "Error: must pass URL or course";
 211     }
 212     if ($link) {
 213         echo "</A>";
 214     }
 215 }
 216
 217 function print_user_picture($userid, $courseid, $picture, $large=false, $returnstring=false) {
 218     global $CFG;
 219
 220     $output = "<A HREF=\"$CFG->wwwroot/user/view.php?id=$userid&course=$courseid\">";
 221     if ($large) {
 222         $file = "f1.jpg";
 223         $size = 100;
 224     } else {
 225         $file = "f2.jpg";
 226         $size = 35;
 227     }
 228     if ($picture) {
 229         if ($CFG->slasharguments) {        // Use this method if possible for better caching
 230             $output .= "<IMG SRC=\"$CFG->wwwroot/user/pix.php/$userid/$file\" BORDER=0 WIDTH=$size HEIGHT=$size ALT=\"\">";
 231         } else {
 232             $output .= "<IMG SRC=\"$CFG->wwwroot/user/pix.php?file=/$userid/$file\" BORDER=0 WIDTH=$size HEIGHT=$size ALT=\"\">";
 233         }
 234     } else {
 235         $output .= "<IMG SRC=\"$CFG->wwwroot/user/default/$file\" BORDER=0 WIDTH=$size HEIGHT=$size ALT=\"\">";
 236     }
 237     $output .= "</A>";
 238
 239     if ($returnstring) {
 240         return $output;
 241     } else {
 242         echo $output;
 243     }
 244 }
 245
 246 function print_table($table) {
 247 // Prints a nicely formatted table.
 248 // $table is an object with several properties.
 249 //     $table->head      is an array of heading names.
 250 //     $table->align     is an array of column alignments
 251 //     $table->size      is an array of column sizes
 252 //     $table->data[]    is an array of arrays containing the data.
 253 //     $table->width     is an percentage of the page
 254 //     $table->cellpadding    padding on each cell
 255 //     $table->cellspacing    spacing between cells
 256
 257     if (isset($table->align)) {
 258         foreach ($table->align as $key => $aa) {
 259             if ($aa) {
 260                 $align[$key] = " ALIGN=\"$aa\"";
 261             } else {
 262                 $align[$key] = "";
 263             }
 264         }
 265     }
 266     if (isset($table->size)) {
 267         foreach ($table->size as $key => $ss) {
 268             if ($ss) {
 269                 $size[$key] = " WIDTH=\"$ss\"";
 270             } else {
 271                 $size[$key] = "";
 272             }
 273         }
 274     }
 275
 276     if (!$table->width) {
 277         $table->width = "80%";
 278     }
 279
 280     if (!$table->cellpadding) {
 281         $table->cellpadding = "5";
 282     }
 283
 284     if (!$table->cellspacing) {
 285         $table->cellspacing = "1";
 286     }
 287
 288     print_simple_box_start("CENTER", "$table->width", "#FFFFFF", 0);
 289     echo "<TABLE WIDTH=100% BORDER=0 valign=top align=center ";
 290     echo " cellpadding=\"$table->cellpadding\" cellspacing=\"$table->cellspacing\">\n";
 291
 292     if ($table->head) {
 293         echo "<TR>";
 294         foreach ($table->head as $key => $heading) {
 295             echo "<TH VALIGN=top ".$align[$key].$size[$key].">$heading</TH>";
 296         }
 297         echo "</TR>\n";
 298     }
 299
 300     foreach ($table->data as $row) {
 301         echo "<TR VALIGN=TOP>";
 302         foreach ($row as $key => $item) {
 303             echo "<TD ".$align[$key].$size[$key].">$item</TD>";
 304         }
 305         echo "</TR>\n";
 306     }
 307     echo "</TABLE>\n";
 308     print_simple_box_end();
 309
 310     return true;
 311 }
 312
 313 function print_editing_switch($courseid) {
 314     global $CFG, $USER;
 315
 316     if (isteacher($courseid)) {
 317         if ($USER->editing) {
 318             echo "<A HREF=\"$CFG->wwwroot/course/view.php?id=$courseid&edit=off\">Turn editing off</A>";
 319         } else {
 320             echo "<A HREF=\"$CFG->wwwroot/course/view.php?id=$courseid&edit=on\">Turn editing on</A>";
 321         }
 322     }
 323 }
 324
 325 function format_float($num, $places=0) {
 326     return sprintf("%.$places"."f", $num);
 327 }
 328
 329 function print_textarea($richedit, $rows, $cols, $width, $height, $name, $value="") {
 330     global $CFG, $THEME;
 331
 332     if ($richedit) {
 333         echo "<object id=richedit style=\"BACKGROUND-COLOR: buttonface\"";
 334         echo " data=\"$CFG->wwwroot/lib/rte/richedit.html\"";
 335         echo " width=\"$width\" height=\"$height\" ";
 336         echo " type=\"text/x-scriptlet\" VIEWASTEXT></object>\n";
 337         echo "<TEXTAREA style=\"display:none\" NAME=\"$name\" ROWS=1 COLS=1>";
 338         p($value);
 339         echo "</TEXTAREA>\n";
 340     } else {
 341         echo "<TEXTAREA name=\"$name\" rows=\"$rows\" cols=\"$cols\" wrap=virtual>";
 342         p($value);
 343         echo "</TEXTAREA>\n";
 344     }
 345 }
 346
 347 function print_richedit_javascript($form, $name, $source="no") {
 348     echo "<SCRIPT language=\"JavaScript\" event=\"onload\" for=\"window\">\n";
 349     echo "   document.richedit.options = \"history=no;source=$source\";";
 350     echo "   document.richedit.docHtml = $form.$name.innerText;";
 351     echo "</SCRIPT>";
 352 }
 353
 354
 355 function update_course_icon($courseid) {
 356 // Used to be an icon, but it's now a simple form button
 357     global $CFG, $USER;
 358
 359     if (isteacher($courseid)) {
 360         if ($USER->editing) {
 361             $string = get_string("turneditingoff");
 362             $edit = "off";
 363         } else {
 364             $string = get_string("turneditingon");
 365             $edit = "on";
 366         }
 367         return "<FORM TARGET=_parent METHOD=GET ACTION=\"$CFG->wwwroot/course/view.php\">".
 368                "<INPUT TYPE=hidden NAME=id VALUE=\"$courseid\">".
 369                "<INPUT TYPE=hidden NAME=edit VALUE=\"$edit\">".
 370                "<INPUT TYPE=submit VALUE=\"$string\"></FORM>";
 371     }
 372 }
 373
 374 function update_module_button($moduleid, $courseid, $string) {
 375 // Prints the editing button on a module "view" page
 376     global $CFG;
 377
 378     if (isteacher($courseid)) {
 379         $string = get_string("updatethis", "", $string);
 380         return "<FORM TARGET=_parent METHOD=GET ACTION=\"$CFG->wwwroot/course/mod.php\">".
 381                "<INPUT TYPE=hidden NAME=update VALUE=\"$moduleid\">".
 382                "<INPUT TYPE=hidden NAME=return VALUE=\"true\">".
 383                "<INPUT TYPE=submit VALUE=\"$string\"></FORM>";
 384     }
 385 }
 386
 387
 388 function print_date_selector($day, $month, $year, $currenttime=0) {
 389 // Currenttime is a default timestamp in GMT
 390 // Prints form items with the names $day, $month and $year
 391
 392     if (!$currenttime) {
 393         $currenttime = time();
 394     }
 395     $currentdate = usergetdate($currenttime);
 396
 397     for ($i=1; $i<=31; $i++) {
 398         $days[$i] = "$i";
 399     }
 400     for ($i=1; $i<=12; $i++) {
 401         $months[$i] = date("F", mktime(0,0,0,$i,1,2000));
 402     }
 403     for ($i=2000; $i<=2010; $i++) {
 404         $years[$i] = $i;
 405     }
 406     choose_from_menu($days,   $day,   $currentdate[mday], "");
 407     choose_from_menu($months, $month, $currentdate[mon],  "");
 408     choose_from_menu($years,  $year,  $currentdate[year], "");
 409 }
 410
 411 function print_time_selector($hour, $minute, $currenttime=0) {
 412 // Currenttime is a default timestamp in GMT
 413 // Prints form items with the names $hour and $minute
 414
 415     if (!$currenttime) {
 416         $currenttime = time();
 417     }
 418     $currentdate = usergetdate($currenttime);
 419     for ($i=0; $i<=23; $i++) {
 420         $hours[$i] = sprintf("%02d",$i);
 421     }
 422     for ($i=0; $i<=59; $i++) {
 423         $minutes[$i] = sprintf("%02d",$i);
 424     }
 425     choose_from_menu($hours,   $hour,   $currentdate[hours],   "");
 426     choose_from_menu($minutes, $minute, $currentdate[minutes], "");
 427 }
 428
 429 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0) {
 430 // Given date parts in user time, produce a GMT timestamp
 431
 432    return mktime((int)$hour,(int)$minute,(int)$second,(int)$month,(int)$day,(int)$year);
 433 }
 434
 435 function format_time($totalsecs, $str=NULL) {
 436 // Given an amount of time in seconds, prints it
 437 // nicely as months, days, hours etc as needed
 438
 439     $totalsecs = abs($totalsecs);
 440
 441     if (!$str) {  // Create the str structure the slow way
 442         $str->day   = get_string("day");
 443         $str->days  = get_string("days");
 444         $str->hour  = get_string("hour");
 445         $str->hours = get_string("hours");
 446         $str->min   = get_string("min");
 447         $str->mins  = get_string("mins");
 448         $str->sec   = get_string("sec");
 449         $str->secs  = get_string("secs");
 450     }
 451
 452     $days      = floor($totalsecs/86400);
 453     $remainder = $totalsecs - ($days*86400);
 454     $hours     = floor($remainder/3600);
 455     $remainder = $remainder - ($hours*3600);
 456     $mins      = floor($remainder/60);
 457     $secs      = $remainder - ($mins*60);
 458
 459     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
 460     $sm = ($mins == 1)  ? $str->min  : $str->mins;
 461     $sh = ($hours == 1) ? $str->hour : $str->hours;
 462     $sd = ($days == 1)  ? $str->day  : $str->days;
 463
 464     if ($days)  $odays  = "$days $sd";
 465     if ($hours) $ohours = "$hours $sh";
 466     if ($mins)  $omins  = "$mins $sm";
 467     if ($secs)  $osecs  = "$secs $ss";
 468
 469     if ($days)  return "$odays $ohours";
 470     if ($hours) return "$ohours $omins";
 471     if ($mins)  return "$omins $osecs";
 472     if ($secs)  return "$osecs";
 473     return get_string("now");
 474 }
 475
 476 function userdate($date, $format="", $timezone=99) {
 477 // Returns a formatted string that represents a date in user time
 478 // WARNING: note that the format is for strftime(), not date().
 479
 480     global $USER;
 481
 482     if ($format == "") {
 483         $format = "%A, %e %B %Y, %I:%M %p";
 484     }
 485     if ($timezone == 99) {
 486         if (isset($USER->timezone)) {
 487             $timezone = (float)$USER->timezone;
 488         }
 489     }
 490     if (abs($timezone) > 12) {
 491         return strftime("$format", $date);
 492     }
 493     return gmstrftime($format, $date + (int)($timezone * 3600));
 494 }
 495
 496 function usergetdate($date, $timezone=99) {
 497 // Given a $date timestamp in GMT, returns an array
 498 // that represents the date in user time
 499
 500     global $USER;
 501
 502     if ($timezone == 99) {
 503         $timezone = (float)$USER->timezone;
 504     }
 505     if (abs($timezone) > 12) {
 506         return getdate($date);
 507     }
 508     //There is no gmgetdate so I have to fake it...
 509     $date = $date + (int)($timezone * 3600);
 510     $getdate["seconds"] = gmstrftime("%S", $date);
 511     $getdate["minutes"] = gmstrftime("%M", $date);
 512     $getdate["hours"]   = gmstrftime("%H", $date);
 513     $getdate["mday"]    = gmstrftime("%d", $date);
 514     $getdate["wday"]    = gmstrftime("%u", $date);
 515     $getdate["mon"]     = gmstrftime("%m", $date);
 516     $getdate["year"]    = gmstrftime("%Y", $date);
 517     $getdate["yday"]    = gmstrftime("%j", $date);
 518     $getdate["weekday"] = gmstrftime("%A", $date);
 519     $getdate["month"]   = gmstrftime("%B", $date);
 520     return $getdate;
 521 }
 522
 523 function usertime($date, $timezone=99) {
 524 // Given a GMT timestamp (seconds since epoch), offsets it by
 525 // the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
 526     global $USER;
 527
 528     if ($timezone == 99) {
 529         $timezone = (float)$USER->timezone;
 530     }
 531     if (abs($timezone) > 12) {
 532         return $date;
 533     }
 534     return $date - (int)($timezone * 3600);
 535 }
 536
 537 function usergetmidnight($date, $timezone=99) {
 538 // Given a time, return the GMT timestamp of the most recent midnight
 539 // for the current user.
 540     global $USER;
 541
 542     if ($timezone == 99) {
 543         $timezone = (float)$USER->timezone;
 544     }
 545
 546     $userdate = usergetdate($date, $timezone);
 547
 548     if (abs($timezone) > 12) {
 549         return mktime(0, 0, 0, $userdate["mon"], $userdate["mday"], $userdate["year"]);
 550     }
 551
 552     $timemidnight = gmmktime (0, 0, 0, $userdate["mon"], $userdate["mday"], $userdate["year"]);
 553     return usertime($timemidnight, $timezone); // Time of midnight of this user's day, in GMT
 554
 555 }
 556
 557 function usertimezone($timezone=99) {
 558 // returns a string that prints the user's timezone
 559     global $USER;
 560
 561     if ($timezone == 99) {
 562         $timezone = (float)$USER->timezone;
 563     }
 564     if (abs($timezone) > 12) {
 565         return "server time";
 566     }
 567     if (abs($timezone) < 0.5) {
 568         return "GMT";
 569     }
 570     if ($timezone > 0) {
 571         return "GMT+$timezone";
 572     } else {
 573         return "GMT$timezone";
 574     }
 575 }
 576
 577
 578 function error ($message, $link="") {
 579     global $CFG, $SESSION;
 580
 581     print_header(get_string("error"));
 582     echo "<BR>";
 583     print_simple_box($message, "center", "", "#FFBBBB");
 584
 585     if (!$link) {
 586         if ( !empty($SESSION->fromurl) ) {
 587             $link = "$SESSION->fromurl";
 588             unset($SESSION->fromurl);
 589             save_session("SESSION");
 590         } else {
 591             $link = "$CFG->wwwroot";
 592         }
 593     }
 594     print_continue($link);
 595     print_footer();
 596     die;
 597 }
 598
 599 function helpbutton ($page, $title="", $module="moodle", $image=true, $text="") {
 600     // $page = the keyword that defines a help page
 601     // $title = the title of links, rollover tips, alt tags etc
 602     // $module = which module is the page defined in
 603     // $image = use a help image for the link?  (otherwise uses text)
 604     // $text = if defined then this text is used in the page, and
 605     //         the $page variable is ignored.
 606     global $CFG;
 607
 608     if ($module == "") {
 609         $module = "moodle";
 610     }
 611     if ($image) {
 612         $linkobject = "<IMG BORDER=0 HEIGHT=17 WIDTH=22 ALT=\"$title\" SRC=\"$CFG->wwwroot/pix/help.gif\">";
 613     } else {
 614         $linkobject = $title;
 615     }
 616     if ($text) {
 617         $url = "/help.php?module=$module&text=$text";
 618     } else {
 619         $url = "/help.php?module=$module&file=$page.html";
 620     }
 621     link_to_popup_window ($url, "popup", $linkobject, 400, 500, $title);
 622 }
 623
 624 function notice ($message, $link="") {
 625     global $THEME, $HTTP_REFERER;
 626
 627     if (!$link) {
 628         $link = $HTTP_REFERER;
 629     }
 630
 631     echo "<BR>";
 632     print_simple_box($message, "center", "", "$THEME->cellheading");
 633     print_heading("<A HREF=\"$link\">".get_string("continue")."</A>");
 634     print_footer();
 635     die;
 636 }
 637
 638 function notice_yesno ($message, $linkyes, $linkno) {
 639     global $THEME;
 640
 641     print_simple_box_start("center", "", "$THEME->cellheading");
 642     echo "<P ALIGN=CENTER><FONT SIZE=3>$message</FONT></P>";
 643     echo "<P ALIGN=CENTER><FONT SIZE=3><B>";
 644     echo "<A HREF=\"$linkyes\">".get_string("yes")."</A>";
 645     echo "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;";
 646     echo "<A HREF=\"$linkno\">".get_string("no")."</A>";
 647     echo "</B></FONT></P>";
 648     print_simple_box_end();
 649 }
 650
 651 function redirect($url, $message="", $delay=0) {
 652 // Uses META tags to redirect the user, after printing a notice
 653
 654     echo "<META HTTP-EQUIV='Refresh' CONTENT='$delay; URL=$url'>";
 655
 656     if (!empty($message)) {
 657         print_header();
 658         echo "<CENTER>";
 659         echo "<P>$message</P>";
 660         echo "<P>( <A HREF=\"$url\">".get_string("continue")."</A> )</P>";
 661         echo "</CENTER>";
 662     }
 663     die;
 664 }
 665
 666 function notify ($message) {
 667     echo "<P align=center><B><FONT COLOR=#FF0000>$message</FONT></B></P>\n";
 668 }
 669
 670
 671
 672 /// PARAMETER HANDLING ////////////////////////////////////////////////////
 673
 674 function require_variable($var) {
 675     if (! isset($var)) {
 676         error("A required parameter was missing");
 677     }
 678 }
 679
 680 function optional_variable(&$var, $default=0) {
 681     if (! isset($var)) {
 682         $var = $default;
 683     }
 684 }
 685
 686
 687
 688
 689 /// DATABASE HANDLING ////////////////////////////////////////////////
 690
 691 function execute_sql($command, $feedback=true) {
 692 // Completely general
 693
 694     global $db;
 695
 696     $result = $db->Execute("$command");
 697
 698     if ($result) {
 699         if ($feedback) {
 700             echo "<P><FONT COLOR=green><B>".get_string("success")."</B></FONT></P>";
 701         }
 702         return true;
 703     } else {
 704         if ($feedback) {
 705             echo "<P><FONT COLOR=red><B>".get_string("error")."</B></FONT></P>";
 706         }
 707         return false;
 708     }
 709 }
 710
 711 function modify_database($sqlfile) {
 712 // Assumes that the input text file consists of a number
 713 // of SQL statements ENDING WITH SEMICOLONS.  The semicolons
 714 // MUST be the last character in a line.
 715 // Lines that are blank or that start with "#" are ignored.
 716 // Only tested with mysql dump files (mysqldump -p -d moodle)
 717
 718
 719     if (file_exists($sqlfile)) {
 720         $success = true;
 721         $lines = file($sqlfile);
 722         $command = "";
 723
 724         while ( list($i, $line) = each($lines) ) {
 725             $line = chop($line);
 726             $length = strlen($line);
 727
 728             if ($length  &&  substr($line, 0, 1) <> "#") {
 729                 if (substr($line, $length-1, 1) == ";") {
 730                     $line = substr($line, 0, $length-1);   // strip ;
 731                     $command .= $line;
 732                     if (! execute_sql($command)) {
 733                         $success = false;
 734                     }
 735                     $command = "";
 736                 } else {
 737                     $command .= $line;
 738                 }
 739             }
 740         }
 741
 742     } else {
 743         $success = false;
 744         echo "<P>Tried to modify database, but \"$sqlfile\" doesn't exist!</P>";
 745     }
 746
 747     return $success;
 748 }
 749
 750
 751 function record_exists($table, $field, $value) {
 752     global $db;
 753
 754     $rs = $db->Execute("SELECT * FROM $table WHERE $field = '$value' LIMIT 1");
 755     if (!$rs) return false;
 756
 757     if ( $rs->RecordCount() ) {
 758         return true;
 759     } else {
 760         return false;
 761     }
 762 }
 763
 764 function record_exists_sql($sql) {
 765     global $db;
 766
 767     $rs = $db->Execute($sql);
 768     if (!$rs) return false;
 769
 770     if ( $rs->RecordCount() ) {
 771         return true;
 772     } else {
 773         return false;
 774     }
 775 }
 776
 777
 778 function count_records($table, $selector, $value) {
 779 // Get all the records and count them
 780     global $db;
 781
 782     $rs = $db->Execute("SELECT COUNT(*) FROM $table WHERE $selector = '$value'");
 783     if (!$rs) return 0;
 784
 785     return $rs->fields[0];
 786 }
 787
 788 function count_records_sql($sql) {
 789 // Get all the records and count them
 790     global $db;
 791
 792     $rs = $db->Execute("$sql");
 793     if (!$rs) return 0;
 794
 795     return $rs->fields[0];
 796 }
 797
 798 function get_record($table, $selector, $value) {
 799 // Get a single record as an object
 800     global $db;
 801
 802     $rs = $db->Execute("SELECT * FROM $table WHERE $selector = '$value'");
 803     if (!$rs) return false;
 804
 805     if ( $rs->RecordCount() == 1 ) {
 806         return (object)$rs->fields;
 807     } else {
 808         return false;
 809     }
 810 }
 811
 812 function get_record_sql($sql) {
 813 // Get a single record as an object
 814 // The sql statement is provided as a string.
 815
 816     global $db;
 817
 818     $rs = $db->Execute("$sql");
 819     if (!$rs) return false;
 820
 821     if ( $rs->RecordCount() == 1 ) {
 822         return (object)$rs->fields;
 823     } else {
 824         return false;
 825     }
 826 }
 827
 828 function get_records($table, $selector, $value, $sort="", $fields="*") {
 829 // Get a number of records as an array of objects
 830 // Can optionally be sorted eg "time ASC" or "time DESC"
 831 // If "fields" is specified, only those fields are returned
 832 // The "key" is the first column returned, eg usually "id"
 833     global $db;
 834
 835     if ($sort) {
 836         $sortorder = "ORDER BY $sort";
 837     }
 838     $sql = "SELECT $fields FROM $table WHERE $selector = '$value' $sortorder";
 839
 840     return get_records_sql($sql);
 841 }
 842
 843
 844 function get_records_list($table, $selector, $values, $sort="", $fields="*") {
 845 // Get a number of records as an array of objects
 846 // Differs from get_records() in that the values variable
 847 // can be a comma-separated list of values eg  "4,5,6,10"
 848 // Can optionally be sorted eg "time ASC" or "time DESC"
 849 // The "key" is the first column returned, eg usually "id"
 850     global $db;
 851
 852     if ($sort) {
 853         $sortorder = "ORDER BY $sort";
 854     }
 855     $sql = "SELECT $fields FROM $table WHERE $selector in ($values) $sortorder";
 856
 857     return get_records_sql($sql);
 858 }
 859
 860
 861 function get_records_sql($sql) {
 862 // Get a number of records as an array of objects
 863 // The "key" is the first column returned, eg usually "id"
 864 // The sql statement is provided as a string.
 865
 866     global $db;
 867
 868     $rs = $db->Execute("$sql");
 869     if (!$rs) return false;
 870
 871     if ( $rs->RecordCount() > 0 ) {
 872         if ($records = $rs->GetAssoc(true)) {
 873             foreach ($records as $key => $record) {
 874                 $objects[$key] = (object) $record;
 875             }
 876             return $objects;
 877         } else {
 878             return false;
 879         }
 880     } else {
 881         return false;
 882     }
 883 }
 884
 885 function get_records_sql_menu($sql) {
 886 // Given an SQL select, this function returns an associative
 887 // array of the first two columns.  This is most useful in
 888 // combination with the choose_from_menu function to create
 889 // a form menu.
 890
 891     global $db;
 892
 893     $rs = $db->Execute("$sql");
 894     if (!$rs) return false;
 895
 896     if ( $rs->RecordCount() > 0 ) {
 897         while (!$rs->EOF) {
 898             $menu[$rs->fields[0]] = $rs->fields[1];
 899             $rs->MoveNext();
 900         }
 901         return $menu;
 902
 903     } else {
 904         return false;
 905     }
 906 }
 907
 908 function get_field($table, $field, $selector, $value) {
 909     global $db;
 910
 911     $rs = $db->Execute("SELECT $field FROM $table WHERE $selector = '$value'");
 912     if (!$rs) return false;
 913
 914     if ( $rs->RecordCount() == 1 ) {
 915         return $rs->fields["$field"];
 916     } else {
 917         return false;
 918     }
 919 }
 920
 921 function set_field($table, $field, $newvalue, $selector, $value) {
 922     global $db;
 923
 924     return $db->Execute("UPDATE $table SET $field = '$newvalue' WHERE $selector = '$value'");
 925 }
 926
 927 function set_config($name, $value) {
 928 // No need for get_config because they are usually always available in $CFG
 929
 930     if (get_field("config", "value", "name", $name)) {
 931         return set_field("config", "value", $value, "name", $name);
 932     } else {
 933         $config->name = $name;
 934         $config->value = $value;
 935         return insert_record("config", $config);
 936     }
 937 }
 938
 939 function delete_records($table, $selector, $value) {
 940 // Delete one or more records from a table
 941     global $db;
 942
 943     return $db->Execute("DELETE FROM $table WHERE $selector = '$value'");
 944 }
 945
 946 function insert_record($table, $dataobject) {
 947 // Insert a record into a table and return the "id" field
 948 // $dataobject is an object containing needed data
 949
 950     global $db;
 951
 952     // Determine all the fields needed
 953     if (! $columns = $db->MetaColumns("$table")) {
 954         return false;
 955     }
 956
 957     $data = (array)$dataobject;
 958
 959     // Pull out data matching these fields
 960     foreach ($columns as $column) {
 961         if ($column->name <> "id" && isset($data[$column->name]) ) {
 962             $ddd[$column->name] = $data[$column->name];
 963         }
 964     }
 965
 966     // Construct SQL queries
 967     if (! $numddd = count($ddd)) {
 968         return 0;
 969     }
 970
 971     $count = 0;
 972     $insert = "";
 973     $select = "";
 974
 975     foreach ($ddd as $key => $value) {
 976         $count++;
 977         $insert .= "$key = '$value'";
 978         $select .= "$key = '$value'";
 979         if ($count < $numddd) {
 980             $insert .= ", ";
 981             $select .= " AND ";
 982         }
 983     }
 984
 985     if (! $rs = $db->Execute("INSERT INTO $table SET $insert")) {
 986         return false;
 987     }
 988
 989     // Pull it out again to find the id.  This is the most cross-platform method.
 990     if ($rs = $db->Execute("SELECT id FROM $table WHERE $select")) {
 991         return $rs->fields[0];
 992     } else {
 993         return false;
 994     }
 995 }
 996
 997
 998 function update_record($table, $dataobject) {
 999 // Update a record in a table
1000 // $dataobject is an object containing needed data
1001
1002     global $db;
1003
1004     if (! isset($dataobject->id) ) {
1005         return false;
1006     }
1007
1008     // Determine all the fields in the table
1009     if (!$columns = $db->MetaColumns($table)) {
1010         return false;
1011     }
1012     $data = (array)$dataobject;
1013
1014     // Pull out data matching these fields
1015     foreach ($columns as $column) {
1016         if ($column->name <> "id" && isset($data[$column->name]) ) {
1017             $ddd[$column->name] = $data[$column->name];
1018         }
1019     }
1020
1021     // Construct SQL queries
1022     $numddd = count($ddd);
1023     $count = 0;
1024     $update = "";
1025
1026     foreach ($ddd as $key => $value) {
1027         $count++;
1028         $update .= "$key = '$value'";
1029         if ($count < $numddd) {
1030             $update .= ", ";
1031         }
1032     }
1033
1034     if ($rs = $db->Execute("UPDATE $table SET $update WHERE id = '$dataobject->id'")) {
1035         return true;
1036     } else {
1037         return false;
1038     }
1039 }
1040
1041
1042 function print_object($object) {
1043 // Mostly just for debugging
1044
1045     $array = (array)$object;
1046     foreach ($array as $key => $item) {
1047         echo "$key -> $item <BR>";
1048     }
1049 }
1050
1051
1052 /// USER DATABASE ////////////////////////////////////////////////
1053
1054 function get_user_info_from_db($field, $value) {
1055
1056     global $db;
1057
1058     if (!$field || !$value)
1059         return false;
1060
1061     if (! $result = $db->Execute("SELECT * FROM user WHERE $field = '$value' AND deleted <> '1'")) {
1062         error("Could not find any active users!");
1063     }
1064
1065     if ( $result->RecordCount() == 1 ) {
1066         $user = (object)$result->fields;
1067
1068         $rs = $db->Execute("SELECT course FROM user_students WHERE user = '$user->id' ");
1069         while (!$rs->EOF) {
1070             $course = $rs->fields["course"];
1071             $user->student["$course"] = true;
1072             $rs->MoveNext();
1073         }
1074
1075         $rs = $db->Execute("SELECT course FROM user_teachers WHERE user = '$user->id' ");
1076         while (!$rs->EOF) {
1077             $course = $rs->fields["course"];
1078             $user->teacher["$course"] = true;
1079             $rs->MoveNext();
1080         }
1081
1082         $rs = $db->Execute("SELECT * FROM user_admins WHERE user = '$user->id' ");
1083         while (!$rs->EOF) {
1084             $user->admin = true;
1085             $rs->MoveNext();
1086         }
1087
1088         if ($course = get_site()) {
1089             // Everyone is always a member of the top course
1090             $user->student["$course->id"] = true;
1091         }
1092
1093         return $user;
1094
1095     } else {
1096         return false;
1097     }
1098 }
1099
1100 function update_user_in_db() {
1101
1102    global $db, $USER, $REMOTE_ADDR;
1103
1104    if (!isset($USER->id))
1105        return false;
1106
1107    $timenow = time();
1108    if ($db->Execute("UPDATE user SET lastIP='$REMOTE_ADDR', lastaccess='$timenow' WHERE id = '$USER->id' ")) {
1109        return true;
1110    } else {
1111        return false;
1112    }
1113 }
1114
1115 function require_login($courseid=0) {
1116 // This function checks that the current user is logged in, and optionally
1117 // whether they are "logged in" or allowed to be in a particular course.
1118 // If not, then it redirects them to the site login or course enrolment.
1119
1120     global $CFG, $SESSION, $USER, $FULLME, $HTTP_REFERER, $PHPSESSID;
1121
1122     // First check that the user is logged in to the site.
1123
1124     if (! (isset($USER->loggedin) and $USER->confirmed and ($USER->site == $CFG->wwwroot)) ) { // They're not
1125         $SESSION->wantsurl = $FULLME;
1126         $SESSION->fromurl  = $HTTP_REFERER;
1127         save_session("SESSION");
1128         $USER = NULL;
1129         save_session("USER");
1130         if ($PHPSESSID) { // Cookies not enabled.
1131             redirect("$CFG->wwwroot/login/index.php?PHPSESSID=$PHPSESSID");
1132         } else {
1133             redirect("$CFG->wwwroot/login/index.php");
1134         }
1135         die;
1136     }
1137
1138     // Next, check if the user can be in a particular course
1139     if ($courseid) {
1140         if ($USER->student[$courseid] || $USER->teacher[$courseid] || $USER->admin) {
1141             if (!isset($USER->realuser)) {  // Don't update if this isn't a realuser
1142                 update_user_in_db();
1143             }
1144             if (!$USER->email) {            // User logged in, but has not set up profile!
1145                                             // This can occur with external authentication
1146                 redirect("$CFG->wwwroot/user/edit.php?id=$USER->id&course=$courseid");
1147                 die;
1148             }
1149             return;   // user is a member of this course.
1150         }
1151         if (! $course = get_record("course", "id", $courseid)) {
1152             error("That course doesn't exist");
1153         }
1154         if ($USER->username == "guest") {
1155             switch ($course->guest) {
1156                 case 0: // Guests not allowed
1157                     print_header();
1158                     notice(get_string("guestsnotallowed", "", $course->fullname));
1159                     break;
1160                 case 1: // Guests allowed
1161                     update_user_in_db();
1162                     return;
1163                 case 2: // Guests allowed with key (drop through)
1164                     break;
1165             }
1166         }
1167
1168         // Currently not enrolled in the course, so see if they want to enrol
1169         $SESSION->wantsurl = $FULLME;
1170         save_session("SESSION");
1171         redirect("$CFG->wwwroot/course/enrol.php?id=$courseid");
1172         die;
1173     }
1174 }
1175
1176
1177
1178 function update_login_count() {
1179     global $SESSION;
1180
1181     $max_logins = 10;
1182
1183     if (empty($SESSION->logincount)) {
1184         $SESSION->logincount = 1;
1185     } else {
1186         $SESSION->logincount++;
1187     }
1188     save_session("SESSION");
1189
1190     if ($SESSION->logincount > $max_logins) {
1191         unset($SESSION->wantsurl);
1192         save_session("SESSION");
1193         error("Sorry, you have exceeded the allowed number of login attempts. Restart your browser.");
1194     }
1195 }
1196
1197 function remove_admin($user) {
1198     global $db;
1199
1200     return $db->Execute("DELETE FROM user_admins WHERE user = '$user'");
1201 }
1202
1203 function remove_teacher($user, $course=0) {
1204     global $db;
1205
1206     if ($course) {
1207         /// First delete any crucial stuff that might still send mail
1208         if ($forums = get_records("forum", "course", $course)) {
1209             foreach ($forums as $forum) {
1210                 $db->Execute("DELETE FROM forum_subscriptions WHERE forum = '$forum->id' AND user = '$user'");
1211             }
1212         }
1213         return $db->Execute("DELETE FROM user_teachers WHERE user = '$user' AND course = '$course'");
1214     } else {
1215         delete_records("forum_subscriptions", "user", $user);
1216         return delete_records("user_teachers", "user", $user);
1217     }
1218 }
1219
1220
1221 function enrol_student($user, $course) {
1222     global $db;
1223
1224         $timenow = time();
1225
1226         $rs = $db->Execute("INSERT INTO user_students (user, course, start, end, time)
1227                         VALUES ($user, $course, 0, 0, $timenow)");
1228         if ($rs) {
1229                 return true;
1230         } else {
1231             return false;
1232         }
1233 }
1234
1235 function unenrol_student($user, $course=0) {
1236     global $db;
1237
1238     if ($course) {
1239         /// First delete any crucial stuff that might still send mail
1240         if ($forums = get_records("forum", "course", $course)) {
1241             foreach ($forums as $forum) {
1242                 $db->Execute("DELETE FROM forum_subscriptions WHERE forum = '$forum->id' AND user = '$user'");
1243             }
1244         }
1245         return $db->Execute("DELETE FROM user_students WHERE user = '$user' AND course = '$course'");
1246
1247     } else {
1248         delete_records("forum_subscriptions", "user", $user);
1249         return delete_records("user_students", "user", $user);
1250     }
1251 }
1252
1253
1254 function isadmin($userid=0) {
1255     global $USER;
1256
1257     if (!$userid) {
1258         return $USER->admin;
1259     }
1260
1261     return record_exists_sql("SELECT * FROM user_admins WHERE user='$userid'");
1262 }
1263
1264 function isteacher($courseid, $userid=0) {
1265     global $USER;
1266
1267     if (isadmin($userid)) {  // admins can do anything the teacher can
1268         return true;
1269     }
1270
1271     if (!$userid) {
1272         return $USER->teacher[$courseid];
1273     }
1274
1275     return record_exists_sql("SELECT * FROM user_teachers WHERE user='$userid' AND course='$courseid'");
1276 }
1277
1278
1279 function isstudent($courseid, $userid=0) {
1280     global $USER;
1281
1282     if (!$userid) {
1283         return $USER->student[$courseid];
1284     }
1285
1286     $timenow = time();   // todo:  add time check below
1287
1288     return record_exists_sql("SELECT * FROM user_students WHERE user='$userid' AND course='$courseid'");
1289 }
1290
1291 function isguest($userid=0) {
1292     global $USER;
1293
1294     if (!$userid) {
1295         return ($USER->username == "guest");
1296     }
1297
1298     return record_exists_sql("SELECT * FROM user WHERE id='$userid' AND username = 'guest' ");
1299 }
1300
1301 function isediting($courseid, $user=NULL) {
1302     global $USER;
1303     if (!$user){
1304         $user = $USER;
1305     }
1306     return ($user->editing and isteacher($courseid, $user->id));
1307 }
1308
1309 function reset_login_count() {
1310     global $SESSION;
1311
1312     $SESSION->logincount = 0;
1313     save_session("SESSION");
1314 }
1315
1316
1317 function set_moodle_cookie($thing) {
1318
1319     $days = 60;
1320     $seconds = 60*60*24*$days;
1321
1322     setCookie ('MOODLEID', "", time() - 3600, "/");
1323     setCookie ('MOODLEID', rc4encrypt($thing), time()+$seconds, "/");
1324 }
1325
1326
1327 function get_moodle_cookie() {
1328     global $MOODLEID;
1329     return rc4decrypt($MOODLEID);
1330 }
1331
1332
1333 function save_session($VAR) {
1334 // Copies temporary session variable to permanent sesson variable
1335 // eg $_SESSION["USER"] = $USER;
1336     global $$VAR;
1337     $_SESSION[$VAR] = $$VAR;
1338 }
1339
1340
1341 function create_user_record($username, $password) {
1342 // Creates a bare-bones user record
1343     global $REMOTE_ADDR, $CFG;
1344
1345     if ($CFG->auth_update_userinfo and function_exists(auth_get_userinfo)) {
1346         if ($newinfo = auth_get_userinfo($username)) {
1347             foreach ($newinfo as $key=>$value){
1348                 $newuser->$key = $value;
1349             }
1350         }
1351     }
1352
1353     $newuser->username = $username;
1354     $newuser->password = md5($password);
1355     $newuser->lang = $CFG->lang;
1356     $newuser->confirmed = 1;
1357     $newuser->lastIP = $REMOTE_ADDR;
1358     $newuser->timemodified = time();
1359
1360     if (insert_record("user", $newuser)) {
1361         return get_user_info_from_db("username", $username);
1362     }
1363     return false;
1364 }
1365
1366 function authenticate_user_login($username, $password) {
1367 // Given a username and password, this function looks them
1368 // up using the currently selected authentication mechanism,
1369 // and if the authentication is successful, it returns a
1370 // valid $user object from the 'user' table.
1371 //
1372 // Uses auth_ functions from the currently active auth module
1373
1374     global $CFG;
1375
1376     if (!isset($CFG->auth)) {
1377         $CFG->auth = "email";    // Default authentication module
1378     }
1379
1380     require_once("$CFG->dirroot/auth/$CFG->auth/lib.php");
1381
1382     if (auth_user_login($username, $password)) {  // Successful authentication
1383
1384         if ($user = get_user_info_from_db("username", $username)) {
1385             if (md5($password) <> $user->password) {
1386                 set_field("user", "password", md5($password), "username", $username);
1387             }
1388             return $user;
1389
1390         } else {
1391             return create_user_record($username, $password);
1392         }
1393     }
1394     return false;
1395 }
1396
1397
1398 function get_site () {
1399 // Returns $course object of the top-level site.
1400     if ( $course = get_record("course", "category", 0)) {
1401         return $course;
1402     } else {
1403         return false;
1404     }
1405 }
1406
1407 function get_admin () {
1408 // Returns $user object of the main admin user
1409
1410     if ( $admins = get_records_sql("SELECT u.* FROM user u, user_admins a WHERE a.user = u.id ORDER BY u.id ASC")) {
1411         foreach ($admins as $admin) {
1412             return $admin;   // ie the first one
1413         }
1414     } else {
1415         return false;
1416     }
1417 }
1418
1419 function get_teacher($courseid) {
1420 // Returns $user object of the main teacher for a course
1421     if ( $teachers = get_records_sql("SELECT u.* FROM user u, user_teachers t
1422                                       WHERE t.user = u.id AND t.course = '$courseid'
1423                                       ORDER BY t.authority ASC")) {
1424         foreach ($teachers as $teacher) {
1425             if ($teacher->authority) {
1426                 return $teacher;   // the highest authority teacher
1427             }
1428         }
1429     } else {
1430         return false;
1431     }
1432 }
1433
1434 function get_course_students($courseid, $sort="u.lastaccess DESC") {
1435     return get_records_sql("SELECT u.* FROM user u, user_students s
1436                             WHERE s.course = '$courseid' AND s.user = u.id AND u.deleted = '0'
1437                             ORDER BY $sort");
1438 }
1439
1440 function get_course_teachers($courseid, $sort="t.authority ASC") {
1441     return get_records_sql("SELECT u.*,t.authority,t.role FROM user u, user_teachers t
1442                             WHERE t.course = '$courseid' AND t.user = u.id AND u.deleted = '0'
1443                             ORDER BY $sort");
1444 }
1445
1446 function get_course_users($courseid, $sort="u.lastaccess DESC") {
1447 // Using this method because the direct SQL just would not always work!
1448
1449     $teachers = get_course_teachers($courseid, $sort);
1450     $students = get_course_students($courseid, $sort);
1451
1452     if ($teachers and $students) {
1453         return array_merge($teachers, $students);
1454     } else if ($teachers) {
1455         return $teachers;
1456     } else {
1457         return $students;
1458     }
1459
1460 //    return get_records_sql("SELECT u.* FROM user u, user_students s, user_teachers t
1461 //                            WHERE (s.course = '$courseid' AND s.user = u.id) OR
1462 //                                  (t.course = '$courseid' AND t.user = u.id)
1463 //                            ORDER BY $sort");
1464 }
1465
1466
1467
1468 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1469
1470 function get_coursemodule_from_instance($modulename, $instance, $courseid) {
1471 // Given an instance of a module, finds the coursemodule description
1472
1473     return get_record_sql("SELECT cm.*, m.name
1474                            FROM course_modules cm, modules md, $modulename m
1475                            WHERE cm.course = '$courseid' AND
1476                                  cm.deleted = '0' AND
1477                                  cm.instance = m.id AND
1478                                  md.name = '$modulename' AND
1479                                  md.id = cm.module AND
1480                                  m.id = '$instance'");
1481
1482 }
1483
1484 function get_all_instances_in_course($modulename, $courseid, $sort="cw.section") {
1485 // Returns an array of all the active instances of a particular
1486 // module in a given course.   Returns false on any errors.
1487
1488     return get_records_sql("SELECT m.*,cw.section,cm.id as coursemodule
1489                             FROM course_modules cm, course_sections cw, modules md, $modulename m
1490                             WHERE cm.course = '$courseid' AND
1491                                   cm.instance = m.id AND
1492                                   cm.deleted = '0' AND
1493                                   cm.section = cw.id AND
1494                                   md.name = '$modulename' AND
1495                                   md.id = cm.module
1496                             ORDER BY $sort");
1497
1498 }
1499
1500
1501
1502
1503 /// CORRESPONDENCE  ////////////////////////////////////////////////
1504
1505 function email_to_user($user, $from, $subject, $messagetext, $messagehtml="", $attachment="", $attachname="") {
1506 //  user        - a user record as an object
1507 //  from        - a user record as an object
1508 //  subject     - plain text subject line of the email
1509 //  messagetext - plain text version of the message
1510 //  messagehtml - complete html version of the message (optional)
1511 //  attachment  - a file on the filesystem, relative to $CFG->dataroot
1512 //  attachname  - the name of the file (extension indicates MIME)
1513
1514     global $CFG, $_SERVER;
1515
1516     include_once("$CFG->libdir/phpmailer/class.phpmailer.php");
1517
1518     if (!$user) {
1519         return false;
1520     }
1521
1522     $mail = new phpmailer;
1523
1524     $mail->Version = "Moodle $CFG->version";           // mailer version
1525     $mail->PluginDir = "$CFG->libdir/phpmailer/";      // plugin directory (eg smtp plugin)
1526
1527     if ($CFG->smtphosts) {
1528         $mail->IsSMTP();                               // use SMTP directly
1529         $mail->Host = "$CFG->smtphosts";               // specify main and backup servers
1530
1531         if ($CFG->smtpuser) {                          // Use SMTP authentication
1532             $mail->SMTPAuth = true;
1533             $mail->Username = $CFG->smtpuser;
1534             $mail->Password = $CFG->smtppass;
1535         }
1536     } else {
1537         $mail->IsMail();                               // use PHP mail() = sendmail
1538     }
1539
1540     $mail->From     = "$from->email";
1541     $mail->FromName = "$from->firstname $from->lastname";
1542     $mail->Subject  =  stripslashes($subject);
1543
1544     $mail->AddAddress("$user->email", "$user->firstname $user->lastname");
1545
1546     $mail->WordWrap = 70;                               // set word wrap
1547
1548     if ($messagehtml) {
1549         $mail->IsHTML(true);
1550         $mail->Body    =  $messagehtml;
1551         $mail->AltBody =  "\n$messagetext\n";
1552     } else {
1553         $mail->IsHTML(false);
1554         $mail->Body =  "\n$messagetext\n";
1555     }
1556
1557     if ($attachment && $attachname) {
1558         if (ereg( "\\.\\." ,$attachment )) {    // Security check for ".." in dir path
1559             $adminuser = get_admin();
1560             $mail->AddAddress("$adminuser->email", "$adminuser->firstname $adminuser->lastname");
1561             $mail->AddStringAttachment("Error in attachment.  User attempted to attach a filename with a unsafe name.", "error.txt", "8bit", "text/plain");
1562         } else {
1563             include_once("$CFG->dirroot/files/mimetypes.php");
1564             $mimetype = mimeinfo("type", $attachname);
1565             $mail->AddAttachment("$CFG->dataroot/$attachment", "$attachname", "base64", "$mimetype");
1566         }
1567     }
1568
1569     if ($mail->Send()) {
1570         return true;
1571     } else {
1572         echo "ERROR: $mail->ErrorInfo\n";
1573         $site = get_site();
1574         add_to_log($site->id, "library", "mailer", $_SERVER["REQUEST_URI"], "ERROR: $mail->ErrorInfo");
1575         return false;
1576     }
1577 }
1578
1579
1580 /// FILE HANDLING  /////////////////////////////////////////////
1581
1582 function make_upload_directory($directory) {
1583 // $directory = a string of directory names under $CFG->dataroot
1584 // eg  stuff/assignment/1
1585 // Returns full directory if successful, false if not
1586
1587     global $CFG;
1588
1589     $currdir = $CFG->dataroot;
1590     if (!file_exists($currdir)) {
1591         if (! mkdir($currdir, 0750)) {
1592             notify("ERROR: You need to create the directory $currdir with web server write access");
1593             return false;
1594         }
1595     }
1596
1597     $dirarray = explode("/", $directory);
1598
1599     foreach ($dirarray as $dir) {
1600         $currdir = "$currdir/$dir";
1601         if (! file_exists($currdir)) {
1602             if (! mkdir($currdir, 0750)) {
1603                 notify("ERROR: Could not find or create a directory ($currdir)");
1604                 return false;
1605             }
1606         }
1607     }
1608
1609     return $currdir;
1610 }
1611
1612 function make_mod_upload_directory($courseid) {
1613     global $CFG;
1614
1615     if (! $moddata = make_upload_directory("$courseid/$CFG->moddata")) {
1616         return false;
1617     }
1618
1619     $strreadme = get_string("readme");
1620
1621     if (file_exists("$CFG->dirroot/lang/$CFG->lang/docs/module_files.txt")) {
1622         copy("$CFG->dirroot/lang/$CFG->lang/docs/module_files.txt", "$moddata/$strreadme.txt");
1623     } else {
1624         copy("$CFG->dirroot/lang/en/docs/module_files.txt", "$moddata/$strreadme.txt");
1625     }
1626     return $moddata;
1627 }
1628
1629
1630 function valid_uploaded_file($newfile) {
1631 // Returns current name of file on disk if true
1632     if (is_uploaded_file($newfile['tmp_name']) and $newfile['size'] > 0) {
1633         return $newfile['tmp_name'];
1634     } else {
1635         return "";
1636     }
1637 }
1638
1639 function get_max_upload_file_size() {
1640     if (! $filesize = ini_get("upload_max_filesize")) {
1641         $filesize = "5M";
1642     }
1643     return get_real_size($filesize);
1644 }
1645
1646 function get_directory_list($rootdir, $excludefile="", $descend=true) {
1647 // Returns an array with all the filenames in
1648 // all subdirectories, relative to the given rootdir.
1649 // If excludefile is defined, then that file/directory is ignored
1650
1651     $dirs = array();
1652
1653     $dir = opendir($rootdir);
1654
1655     while ($file = readdir($dir)) {
1656         if ($file != "." and $file != ".." and $file != "CVS" and $file != $excludefile) {
1657             $fullfile = $rootdir."/".$file;
1658             if ($descend and filetype($fullfile) == "dir") {
1659                 $subdirs = get_directory_list($fullfile, $excludefile, $descend);
1660                 foreach ($subdirs as $subdir) {
1661                     $dirs[] = $file."/".$subdir;
1662                 }
1663             } else {
1664                 $dirs[] = $file;
1665             }
1666         }
1667     }
1668     closedir($dir);
1669
1670     asort($dirs);
1671
1672     return $dirs;
1673 }
1674
1675 function get_real_size($size=0) {
1676 // Converts numbers like 10M into bytes
1677     if (!$size) {
1678         return 0;
1679     }
1680     $scan['MB'] = 1048576;
1681     $scan['M'] = 1048576;
1682     $scan['KB'] = 1024;
1683     $scan['K'] = 1024;
1684
1685     while (list($key) = each($scan)) {
1686         if ((strlen($size)>strlen($key))&&(substr($size, strlen($size) - strlen($key))==$key)) {
1687             $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
1688             break;
1689         }
1690     }
1691     return $size;
1692 }
1693
1694 function display_size($size) {
1695 // Converts bytes into display form
1696     if ($size >= 1073741824) {
1697         $size = round($size / 1073741824 * 10) / 10 . "Gb";
1698     } else if ($size >= 1048576) {
1699         $size = round($size / 1048576 * 10) / 10 . "Mb";
1700     } else if ($size >= 1024) {
1701         $size = round($size / 1024 * 10) / 10 . "Kb";
1702     } else {
1703         $size = $size . "b";
1704     }
1705     return $size;
1706 }
1707
1708 function clean_filename($string) {
1709     $string = eregi_replace("\.\.", "", $string);
1710     $string = eregi_replace("[^([:alnum:]|\.)]", "_", $string);
1711     return    eregi_replace("_+", "_", $string);
1712 }
1713
1714
1715 /// STRING TRANSLATION  ////////////////////////////////////////
1716
1717 function print_string($identifier, $module="", $a=NULL) {
1718     echo get_string($identifier, $module, $a);
1719 }
1720
1721 function current_language() {
1722 // Returns the code for the current language
1723     global $CFG, $USER;
1724
1725     if (isset($USER->lang)) {    // User language can override site language
1726         return $USER->lang;
1727     } else {
1728         return $CFG->lang;
1729     }
1730 }
1731
1732 function get_string($identifier, $module="", $a=NULL) {
1733 // Return the translated string specified by $identifier as
1734 // for $module.  Uses the same format files as STphp.
1735 // $a is an object, string or number that can be used
1736 // within translation strings
1737 //
1738 // eg "hello \$a->firstname \$a->lastname"
1739 // or "hello \$a"
1740
1741     global $CFG;
1742
1743     $lang = current_language();
1744
1745     if ($module == "") {
1746         $module = "moodle";
1747     }
1748
1749     $langpath = "$CFG->dirroot/lang";
1750     $langfile = "$langpath/$lang/$module.php";
1751
1752     if (!file_exists($langfile)) {                // try English instead
1753         $langfile = "$langpath/en/$module.php";
1754         if (!file_exists($langfile)) {
1755             return "ERROR: No lang file ($langpath/en/$module.php)!";
1756         }
1757     }
1758
1759     if ($result = get_string_from_file($identifier, $langfile, "\$resultstring")) {
1760
1761         eval($result);
1762         return $resultstring;
1763
1764     } else {
1765         if ($lang == "en") {
1766             return "[['$identifier']]";
1767
1768         } else {   // Try looking in the english file.
1769             $langfile = "$langpath/en/$module.php";
1770             if (!file_exists($langfile)) {
1771                 return "ERROR: No lang file ($langpath/en/$module.php)!";
1772             }
1773             if ($result = get_string_from_file($identifier, $langfile, "\$resultstring")) {
1774                 eval($result);
1775                 return $resultstring;
1776             } else {
1777                 return "[['$identifier']]";
1778             }
1779         }
1780     }
1781 }
1782
1783
1784 function get_string_from_file($identifier, $langfile, $destination) {
1785 // This function is only used from get_string().
1786     include ($langfile);
1787
1788     if (!isset ($string[$identifier])) {
1789         return false;
1790     }
1791
1792     return "$destination = sprintf(\"".$string[$identifier]."\");";
1793 }
1794
1795
1796 function get_list_of_languages() {
1797 /// Returns a list of language codes and their full names
1798     global $CFG;
1799
1800     if (!$langdirs = get_list_of_plugins("lang")) {
1801         return false;
1802     }
1803
1804     foreach ($langdirs as $lang) {
1805         include("$CFG->dirroot/lang/$lang/moodle.php");
1806         $languages[$lang] = $string["thislanguage"]." ($lang)";
1807         unset($string);
1808     }
1809     return $languages;
1810 }
1811
1812
1813 /// ENCRYPTION  ////////////////////////////////////////////////
1814
1815 function rc4encrypt($data) {
1816     $password = "nfgjeingjk";
1817     return endecrypt($password, $data, "");
1818 }
1819
1820 function rc4decrypt($data) {
1821     $password = "nfgjeingjk";
1822     return endecrypt($password, $data, "de");
1823 }
1824
1825 function endecrypt ($pwd, $data, $case) {
1826 // Based on a class by Mukul Sabharwal [mukulsabharwal@yahoo.com]
1827
1828     if ($case == 'de') {
1829         $data = urldecode($data);
1830     }
1831
1832     $key[] = "";
1833     $box[] = "";
1834     $temp_swap = "";
1835     $pwd_length = 0;
1836
1837     $pwd_length = strlen($pwd);
1838
1839     for ($i = 0; $i <= 255; $i++) {
1840         $key[$i] = ord(substr($pwd, ($i % $pwd_length), 1));
1841         $box[$i] = $i;
1842     }
1843
1844     $x = 0;
1845
1846     for ($i = 0; $i <= 255; $i++) {
1847         $x = ($x + $box[$i] + $key[$i]) % 256;
1848         $temp_swap = $box[$i];
1849         $box[$i] = $box[$x];
1850         $box[$x] = $temp_swap;
1851     }
1852
1853     $temp = "";
1854     $k = "";
1855
1856     $cipherby = "";
1857     $cipher = "";
1858
1859     $a = 0;
1860     $j = 0;
1861
1862     for ($i = 0; $i < strlen($data); $i++) {
1863         $a = ($a + 1) % 256;
1864         $j = ($j + $box[$a]) % 256;
1865         $temp = $box[$a];
1866         $box[$a] = $box[$j];
1867         $box[$j] = $temp;
1868         $k = $box[(($box[$a] + $box[$j]) % 256)];
1869         $cipherby = ord(substr($data, $i, 1)) ^ $k;
1870         $cipher .= chr($cipherby);
1871     }
1872
1873     if ($case == 'de') {
1874         $cipher = urldecode(urlencode($cipher));
1875     } else {
1876         $cipher = urlencode($cipher);
1877     }
1878
1879     return $cipher;
1880 }
1881
1882
1883 /// MISCELLANEOUS ////////////////////////////////////////////////////////////////////
1884
1885 function count_words($string) {
1886     $string = strip_tags($string);
1887     return count(preg_split("/\w\b/", $string)) - 1;
1888 }
1889
1890 function getweek ($startdate, $thedate) {
1891 // Given dates in seconds, how many weeks is the date from startdate
1892 // The first week is 1, the second 2 etc ...
1893
1894     if ($thedate < $startdate) {   // error
1895         return 0;
1896     }
1897
1898     return floor(($thedate - $startdate) / 604800.0) + 1;
1899 }
1900
1901 function add_to_log($course, $module, $action, $url="", $info="") {
1902 // Add an entry to the log table.  These are "action" focussed rather
1903 // than web server hits, and provide a way to easily reconstruct what
1904 // any particular student has been doing.
1905 //
1906 // course = the course id
1907 // module = forum, journal, resource, course, user etc
1908 // action = view, edit, post (often but not always the same as the file.php)
1909 // url    = the file and parameters used to see the results of the action
1910 // info   = additional description information
1911
1912
1913     global $db, $USER, $REMOTE_ADDR;
1914
1915     if (isset($USER->realuser)) {  // Don't log
1916         return;
1917     }
1918
1919     $timenow = time();
1920     $info = addslashes($info);
1921
1922     $result = $db->Execute("INSERT INTO log
1923                             SET time = '$timenow',
1924                                 user = '$USER->id',
1925                                 course = '$course',
1926                                 ip = '$REMOTE_ADDR',
1927                                 module = '$module',
1928                                 action = '$action',
1929                                 url = '$url',
1930                                 info = '$info'");
1931     if (!$result) {
1932         echo "<P>Error: Could not insert a new entry to the Moodle log</P>";  // Don't throw an error
1933     }
1934 }
1935
1936 function generate_password($maxlen=10) {
1937 // returns a randomly generated password of length $maxlen.  inspired by
1938 // http://www.phpbuilder.com/columns/jesus19990502.php3
1939
1940     global $CFG;
1941
1942     $fillers = "1234567890!$-+";
1943     $wordlist = file($CFG->wordlist);
1944
1945     srand((double) microtime() * 1000000);
1946     $word1 = trim($wordlist[rand(0, count($wordlist) - 1)]);
1947     $word2 = trim($wordlist[rand(0, count($wordlist) - 1)]);
1948     $filler1 = $fillers[rand(0, strlen($fillers) - 1)];
1949
1950     return substr($word1 . $filler1 . $word2, 0, $maxlen);
1951 }
1952
1953 function moodle_needs_upgrading() {
1954 // Checks version numbers of Main code and all modules to see
1955 // if there are any mismatches ... returns true or false
1956     global $CFG;
1957
1958     include_once("$CFG->dirroot/version.php");  # defines $version and upgrades
1959     if ($CFG->version) {
1960         if ($version > $CFG->version) {
1961             return true;
1962         }
1963         if ($mods = get_list_of_plugins("mod")) {
1964             foreach ($mods as $mod) {
1965                 $fullmod = "$CFG->dirroot/mod/$mod";
1966                 unset($module);
1967                 include_once("$fullmod/version.php");  # defines $module with version etc
1968                 if ($currmodule = get_record("modules", "name", $mod)) {
1969                     if ($module->version > $currmodule->version) {
1970                         return true;
1971                     }
1972                 }
1973             }
1974         }
1975     } else {
1976         return true;
1977     }
1978     return false;
1979 }
1980
1981
1982 function get_list_of_plugins($plugin="mod") {
1983 // Lists plugin directories within some directory
1984
1985     global $CFG;
1986
1987     $basedir = opendir("$CFG->dirroot/$plugin");
1988     while ($dir = readdir($basedir)) {
1989         if ($dir == "." || $dir == ".." || $dir == "CVS") {
1990             continue;
1991         }
1992         if (filetype("$CFG->dirroot/$plugin/$dir") != "dir") {
1993             continue;
1994         }
1995         $plugins[] = $dir;
1996     }
1997     if ($plugins) {
1998         asort($plugins);
1999     }
2000     return $plugins;
2001 }
2002
2003
2004 function check_php_version($version="4.1.0") {
2005 // Returns true is the current version of PHP is greater that the specified one
2006     $minversion = intval(str_replace(".", "", $version));
2007     $curversion = intval(str_replace(".", "", phpversion()));
2008     return ($curversion >= $minversion);
2009 }
2010
2011 function check_browser_version($brand="MSIE", $version=5.5) {
2012 // Checks to see if is a browser matches the specified
2013 // brand and is equal or better version.
2014     global $HTTP_USER_AGENT;
2015
2016     if (!$HTTP_USER_AGENT) {
2017         return false;
2018     }
2019     $string = explode(";", $HTTP_USER_AGENT);
2020     if (!isset($string[1])) {
2021         return false;
2022     }
2023     $string = explode(" ", trim($string[1]));
2024     if (!isset($string[0]) and !isset($string[1])) {
2025         return false;
2026     }
2027     if ($string[0] == $brand and (float)$string[1] >= $version ) {
2028         return true;
2029     }
2030     return false;
2031 }
2032
2033 function can_use_richtext_editor() {
2034     global $USER, $CFG;
2035     if ($USER->htmleditor and $CFG->htmleditor) {
2036         return check_browser_version("MSIE", 5.5);
2037     }
2038     return false;
2039 }
2040
2041
2042 function check_gd_version() {
2043     ob_start();
2044     phpinfo();
2045     $phpinfo = ob_get_contents();
2046     ob_end_clean();
2047
2048     $phpinfo = explode("\n",$phpinfo);
2049
2050     $gdversion = 0;
2051
2052     foreach ($phpinfo as $text) {
2053         $parts = explode('</b>',$text);
2054         foreach ($parts as $key => $val) {
2055             $parts[$key] = strip_tags($val);
2056         }
2057         if ($parts[0]=="GD Version") {
2058             $gdversion = intval($parts[1]);
2059         }
2060     }
2061
2062     return $gdversion;   // 1, 2 or 0
2063 }
2064
2065
2066
2067 ?>