mod/lams/lib.php

   1 <?PHP  // $Id$
   2
   3 /// Library of functions and constants for module lams
   4 require_once($CFG->dirroot.'/lib/datalib.php');
   5 require_once($CFG->dirroot.'/lib/moodlelib.php');
   6 require_once($CFG->dirroot.'/lib/soap/nusoap.php');
   7
   8
   9 function lams_add_instance($lams) {
  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     global $USER;
  15     $lams->timemodified = time();
  16     $lams->learning_session_id = lams_get_lesson($USER->username,$lams->sequence,$lams->course,$lams->name,$lams->introduction,"normal");
  17   return insert_record("lams", $lams);
  18 }
  19
  20
  21 function lams_update_instance($lams) {
  22 /// Given an object containing all the necessary data,
  23 /// (defined by the form in mod.html) this function
  24 /// will update an existing instance with new data.
  25     //echo "enter lams_update_instance<br/>";
  26   $lams->timemodified = time();
  27   $lams->id = $lams->instance;
  28   lams_delete_lesson($USER->username,$lams->learning_session_id);
  29     $lams->learning_session_id = lams_get_lesson($USER->username,$lams->sequence,$lams->course,$lams->name,$lams->introduction,"normal");
  30     if(!$lams->learning_session_id){
  31         return false;
  32     }
  33     # May have to add extra stuff in here #
  34   //echo $lams->id."<br/>";
  35     //echo $lams->sequence."<br/>";
  36     //echo $lams->course."<br/>";
  37     //echo $lams->name."<br/>";
  38     //echo $lams->introduction."<br/>";
  39     //echo $lams->learning_session_id."<br/>";
  40     //echo "exit lams_update_instance<br/>";
  41   return update_record("lams", $lams);
  42 }
  43
  44
  45 function lams_delete_instance($id) {
  46 /// Given an ID of an instance of this module,
  47 /// this function will permanently delete the instance
  48 /// and any data that depends on it.
  49
  50   if (! $lams = get_record("lams", "id", "$id")) {
  51       return false;
  52   }
  53
  54   $result = true;
  55
  56   # Delete any dependent records here #
  57     lams_delete_lesson($USER->username,$lams->learning_session_id);
  58   if (! delete_records("lams", "id", "$lams->id")) {
  59       $result = false;
  60   }
  61
  62   return $result;
  63 }
  64
  65 function lams_user_outline($course, $user, $mod, $lams) {
  66 /// Return a small object with summary information about what a
  67 /// user has done with a given particular instance of this module
  68 /// Used for user activity reports.
  69 /// $return->time = the time they did it
  70 /// $return->info = a short text description
  71
  72   return $return;
  73 }
  74
  75 function lams_user_complete($course, $user, $mod, $lams) {
  76 /// Print a detailed representation of what a  user has done with
  77 /// a given particular instance of this module, for user activity reports.
  78
  79   return true;
  80 }
  81
  82 function lams_print_recent_activity($course, $isteacher, $timestart) {
  83 /// Given a course and a time, this module should find recent activity
  84 /// that has occurred in lams activities and print it out.
  85 /// Return true if there was output, or false is there was none.
  86
  87   global $CFG;
  88
  89   return false;  //  True if anything was printed, otherwise false
  90 }
  91
  92 function lams_cron () {
  93 /// Function to be run periodically according to the moodle cron
  94 /// This function searches for things that need to be done, such
  95 /// as sending out mail, toggling flags etc ...
  96
  97   global $CFG;
  98
  99   return true;
 100 }
 101
 102 function lams_grades($lamsid) {
 103 /// Must return an array of grades for a given instance of this module,
 104 /// indexed by user.  It also returns a maximum allowed grade.
 105 ///
 106 ///    $return->grades = array of grades;
 107 ///    $return->maxgrade = maximum allowed grade;
 108 ///
 109 ///    return $return;
 110
 111   return NULL;
 112 }
 113
 114 function lams_get_participants($lamsid) {
 115 //Must return an array of user records (all data) who are participants
 116 //for a given instance of lams. Must include every user involved
 117 //in the instance, independient of his role (student, teacher, admin...)
 118 //See other modules as example.
 119
 120   return false;
 121 }
 122
 123 function lams_scale_used ($lamsid,$scaleid) {
 124 //This function returns if a scale is being used by one lams
 125 //it it has support for grading and scales. Commented code should be
 126 //modified if necessary. See forum, glossary or journal modules
 127 //as reference.
 128
 129   $return = false;
 130
 131   //$rec = get_record("lams","id","$lamsid","scale","-$scaleid");
 132   //
 133   //if (!empty($rec)  && !empty($scaleid)) {
 134   //    $return = true;
 135   //}
 136
 137   return $return;
 138 }
 139
 140 //////////////////////////////////////////////////////////////////////////////////////
 141 /// Any other lams functions go here.  Each of them must have a name that
 142 /// starts with lams_
 143
 144 function lams_get_soap_client($relativeurl) {
 145     global $CFG;
 146     if(!isset($CFG->lams_serverurl))
 147     {
 148         return NULL;
 149     }
 150     $wsdl = $CFG->lams_serverurl.$relativeurl;
 151     $s = new soap_client($wsdl,true,false,false,false,false,2,3);
 152     return $s;
 153 }
 154
 155 /**
 156  * Get sequences(learning designs) for the user in LAMS
 157  *
 158  * @param string $username The username of the user. Set this to "" if you would just like to get sequences for the currently logged in user.
 159  * @return Array sequence array
 160  * @TODO complete the documentation of this function
 161  */
 162 function lams_get_sequences($username,$courseid) {
 163     global $CFG,$USER;
 164     if(!isset($CFG->lams_serverid)||!isset($CFG->lams_serverkey)||!isset($CFG->lams_serverurl))
 165     {
 166         return get_string("notsetup", "lams");
 167     }
 168     $relativeurl="/services/LearningDesignService?wsdl";
 169     $s = lams_get_soap_client($relativeurl);
 170     if(is_null($s)){
 171         return NULL;
 172     }
 173     $datetime =    date("F d,Y g:i a");
 174     /*
 175     $login = lams_get_user($username,$courseid);
 176     if(empty($login)){
 177         return NULL;
 178     }
 179     */
 180     if(!isset($username)){
 181         $username = $USER->username;
 182     }
 183     $rawstring = trim($datetime).trim($username).trim($CFG->lams_serverid).trim($CFG->lams_serverkey);
 184     $hashvalue = sha1(strtolower($rawstring));
 185     $parameters = array($CFG->lams_serverid,$datetime,$hashvalue,$username);
 186     $result = $s->call('getAllLearningDesigns',$parameters);//Array of simpleLearningDesign objects
 187     if($s->getError()){//if some exception happened
 188         $result = $s->getError();//return the string describing the error
 189     }
 190     unset($s);
 191     return $result;
 192 }
 193
 194 /**
 195  * Get learning session(lesson) id from LAMS
 196  *
 197  * @param string $username The username of the user. Set this to "" if you would just like the currently logged in user to create the lesson
 198  * @param int $ldid The id of the learning design that the lesson is based on
 199  * @param int $courseid The id of the course that the lesson is associated with.
 200  * @param string $title The title of the lesson
 201  * @param string $desc The description of the lesson
 202  * @param string $type The type of the lesson. Two types: normal, preview
 203  * @return int lesson id
 204  */
 205 function lams_get_lesson($username,$ldid,$courseid,$title,$desc,$type) {
 206     //echo "enter lams_get_lesson<br/>";
 207     global $CFG,$USER;
 208     if(!isset($CFG->lams_serverid)||!isset($CFG->lams_serverkey))
 209     {
 210         //echo "serverid or serverkey is not set<br/>";
 211         return NULL;
 212     }
 213     $relativeurl="/services/LearningSessionService?wsdl";
 214     $s = lams_get_soap_client($relativeurl);
 215     if(is_null($s)){
 216         //echo "soap client is null<br/>";
 217         return NULL;
 218     }
 219     $datetime =    date("F d,Y g:i a");
 220     if(!isset($username)){
 221         $username = $USER->username;
 222     }
 223     $plaintext = $datetime.$username.$CFG->lams_serverid.$CFG->lams_serverkey;
 224     //echo $plaintext;
 225     $hashvalue = sha1(strtolower($plaintext));
 226     //echo $hashvalue;
 227     $parameters = array($CFG->lams_serverid,$datetime,$hashvalue,$username,$ldid,$courseid,$title,$desc,$type);
 228     $result = $s->call('createLearningSession',$parameters);
 229     //echo "result:".$result."<br/>";
 230     //echo "exit lams_get_lesson<br/>";
 231     if($s->getError()){
 232         $result = $s->getError();
 233     }
 234     unset($s);
 235     return $result;
 236 }
 237
 238 /**
 239  * Delete learning session(lesson) from LAMS
 240  *
 241  * @param string $username The username of the user. Set this to "" if you would just like the currently logged in user to create the lesson
 242  * @param int $lsid The id of the learning session(lesson)
 243  * @return true or false
 244  */
 245 function lams_delete_lesson($username,$lsid) {
 246     //echo "enter lams_get_lesson<br/>";
 247     global $CFG,$USER;
 248     if(!isset($CFG->lams_serverid)||!isset($CFG->lams_serverkey))
 249     {
 250         return "The LAMS serverId and serverKey have not been set up";
 251     }
 252     $relativeurl="/services/LearningSessionService?wsdl";
 253     $s = lams_get_soap_client($relativeurl);
 254     if(is_null($s)){
 255         return "Failed to get soap client based on:".$relativeurl;
 256     }
 257     $datetime =    date("F d,Y g:i a");
 258     if(!isset($username)){
 259         $username = $USER->username;
 260     }
 261     $plaintext = $datetime.$username.$CFG->lams_serverid.$CFG->lams_serverkey;
 262     //echo $plaintext;
 263     $hashvalue = sha1(strtolower($plaintext));
 264     //echo $hashvalue;
 265     $parameters = array($CFG->lams_serverid,$datetime,$hashvalue,$username,$lsid);
 266     $result = $s->call('deleteLearningSession',$parameters);
 267     if($s->getError()){
 268         $result = $s->getError();
 269     }
 270     unset($s);
 271     return $result;
 272 }
 273
 274
 275 /**
 276  * Get class in LAMS
 277  * @param int courseid
 278  * @return int class id
 279  * @TODO complete the documentation of this function
 280  */
 281  /*
 282 function lams_get_class($courseid) {
 283     global $CFG,$USER;
 284     //echo "enter lams_get_class"."<br/>";
 285     $orgId = lams_get_organisation();
 286     if(empty($orgId)){
 287         return NULL;
 288     }
 289   $lams_course = get_record("lams_course","course", $courseid);
 290   if(empty($lams_course)){//LAMS class hasn't been created
 291        //create LAMS class
 292       $relativeurl="/services/UserManagementService?wsdl";
 293       $s = lams_get_soap_client($relativeurl);
 294       if(is_null($s)){
 295           return NULL;
 296       }
 297       $datetime =    date("F d,Y g:i a");
 298       $rawstring = $datetime.$CFG->lams_serverid.$CFG->lams_serverkey;
 299       $hashvalue = sha1(strtolower($rawstring));
 300       $parameters = array($CFG->lams_serverid,$datetime,$hashvalue);
 301       $result = $s->call('createClass',$parameters);
 302       //echo "<xmp/>".$s->request."</xmp>";
 303       //echo "<xmp/>".$s->response."</xmp>";
 304       //echo "result:".$result."<br/>";
 305        $lams_course->course = $courseid;
 306        $lams_course->classid = $result;
 307         insert_record("lams_course",$lams_course);
 308         //echo "exit lams_get_class"."<br/>";
 309          return $result;
 310   }else{
 311       //echo "exit lams_get_class"."<br/>";
 312       return $lams_course->classid;
 313   }
 314 }
 315 */
 316 /**
 317  * Get organisation in LAMS
 318  *
 319  * @return int organisation id
 320  * @TODO complete the documentation of this function
 321  */
 322  /*
 323 function lams_get_organisation() {
 324     global $CFG,$USER;
 325     //echo "enter lams_get_organisaiton"."<br/>";
 326     if(!isset($CFG->lams_serverid)||!isset($CFG->lams_serverkey))
 327     {
 328         return NULL;
 329     }
 330     if(!isset($CFG->lams_orgid)){
 331       $relativeurl="/services/UserManagementService?wsdl";
 332       $s = lams_get_soap_client($relativeurl);
 333       if(empty($s)){
 334           return NULL;
 335       }
 336       $datetime =    date("F d,Y g:i a");
 337       $rawstring = $datetime.$CFG->lams_serverid.$CFG->lams_serverkey;
 338       $hashvalue = sha1(strtolower($rawstring));
 339       $parameters = array($CFG->lams_serverid,$datetime,$hashvalue);
 340       $result = $s->call('createOrganisation',$parameters);
 341       //echo "<xmp/>".$s->request."</xmp>";
 342       //echo "<xmp/>".$s->response."</xmp>";
 343       set_config("lams_orgid",$result);
 344       //echo "result:".$result."<br/>";
 345       //echo "exit lams_get_organisaiton"."<br/>";
 346       return $result;
 347     }else{
 348         //echo "exit lams_get_organisaiton"."<br/>";
 349         return $CFG->lams_orgid;
 350     }
 351 }
 352 */
 353
 354 /**
 355  * Get user in LAMS
 356  *
 357  * @param string $username The username of the user. Set this to "" if you would just like to create LAMS user for the currently logged in user
 358  * @param string $roles The user's roles in LAMS
 359  * @param int $classid The id of the class that the user belongs to. The class should be already created in LAMS by calling lams_create_class()
 360  * @param int $orgid The id of the organisation that  the user belongs to. The organisation should be already created in LAMS by calling lams_create_organisation()
 361  * @return user login in LAMS if the user is successfully created
 362  * @TODO complete the documentation of this function
 363  */
 364  /*
 365 function lams_get_user($username,$courseid) {
 366     global $CFG,$USER;
 367     //echo "enter lams_get_user"."<br/>";
 368     if(!isset($CFG->lams_serverid)||!isset($CFG->lams_serverkey))
 369     {
 370         return NULL;
 371     }
 372     $lams_user = get_record("lams_user","username",$username);
 373     if(empty($lams_user)){//LAMS user hasn't been created
 374         $classid = lams_get_class($courseid);
 375         if(empty($classid)){//Can't get class id from lams_course table. Something wrong!
 376             return NULL;
 377         }
 378         $orgid = lams_get_organisation();//It won't be NULL. See lams_get_class function
 379         $user = get_record("user","username",$username);
 380         if(empty($user)){//Something wrong
 381             return NULL;
 382         }
 383         $roles = lams_get_user_roles($user->id,$courseid);
 384       $relativeurl="/services/UserManagementService?wsdl";
 385       $s = lams_get_soap_client($relativeurl);
 386       if(empty($s)){
 387           return NULL;
 388       }
 389       $datetime =    date("F d,Y g:i a");
 390       $login = $username;
 391       $rawstring = $datetime.$login.$CFG->lams_serverid.$CFG->lams_serverkey;
 392       $hashvalue = sha1(strtolower($rawstring));
 393       $parameters = array($CFG->lams_serverid,$datetime,$hashvalue,$login,"password",$roles,$classid,$orgid);
 394       $result = $s->call('createUser',$parameters);
 395       //echo "<xmp/>".$s->request."</xmp>";
 396       //echo "<xmp/>".$s->response."</xmp>";
 397       $lams_user->username = $username;
 398       $lams_user->login = $result;
 399       insert_record("lams_user",$lams_user);
 400       //echo "result:".$result."<br/>";
 401       //echo "exit lams_get_user"."<br/>";
 402       return $result;
 403     }else{
 404         //echo "exit lams_get_user"."<br/>";
 405         return $lams_user->login;
 406     }
 407 }
 408 */
 409
 410 /**
 411  * Mapping moodle roles to LAMS roles
 412  *
 413  * @param int $courseid The id of the course that is being viewed
 414  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
 415  * @return formatted string describing LAMS roles
 416  * @TODO fill the gap of roles mapping between moodle and LAMS
 417  */
 418  /*
 419 function lams_get_user_roles($userid=0, $courseid){
 420     $roles = "";
 421     if(isadmin($userid)){
 422         $roles = "administrator"."|"."auhtor"."|"."staff";
 423     }else    if(isteacheredit($courseid,$userid)){
 424         $roles = "auhtor"."|"."staff";
 425     }else if(isteacher($courseid,$userid)){
 426         $roles = "staff";
 427     }
 428     if(isstudent($courseid,$userid)){
 429         if(empty($roles)){
 430             $roles = "learner";
 431         }else{
 432             $roles .= "|"."learner";
 433         }
 434     }
 435     //echo $roles."<br/>";
 436     return $roles;
 437 }
 438 */
 439
 440 ?>