Erstversion Moodle2.4 Syncronisation

2026-06-27 08:59:28 +00:00 · 2013-03-08 09:46:39 +00:00
parent 9cd21d82c9
commit 406be358e9
10 changed files with 3350 additions and 2 deletions
@@ -0,0 +1,563 @@
+<?php
+/* Copyright (C) 2013 FH Technikum-Wien
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Authors: Andreas Oesterreicher <andreas.oesterreicher@technikum-wien.at> and
+ */
+/*
+ * Connector fuer Moodle 2.4 User
+ * 
+ * FHComplete Moodle Plugin muss installiert sein fuer
+ * Webservice Funktion 'fhcomplete_user_get_users' 
+ */
+require_once(dirname(__FILE__).'/basis_db.class.php');
+
+class moodle_user extends basis_db
+{
+	public $log=''; 			//log message fuer Syncro
+	public $log_public='';		//log message fuer Syncro
+	public $sync_create=0; 	//anzahl der durchgefuehrten zuteilungen beim syncro
+	public $group_update=0;	//anzahl der updates an gruppen
+	private $serverurl;
+	
+	public $mdl_user_id;
+	public $mdl_user_username;
+	public $mdl_user_firstname;
+	public $mdl_user_lastname;
+		
+	/**
+	 * Konstruktor
+	 */
+	public function __construct()
+	{
+		$this->serverurl=MOODLE_PATH24.'/webservice/soap/server.php?wsdl=1&wstoken='.MOODLE_TOKEN24.'&'.microtime(true);
+		return true;
+	}
+	
+	/**
+	 * Laedt einen Moodle User
+	 *
+	 * @param $uid
+	 * @return boolean
+	 */
+	public function loaduser($uid)
+	{
+		$client = new SoapClient($this->serverurl); 
+		$response = $client->fhcomplete_user_get_users(array(array('key'=>'username', 'value'=>$uid)));
+
+		if(isset($response['users'][0]))
+		{
+			$this->mdl_user_id = $response['users'][0]['id'];
+			$this->mdl_user_username = $response['users'][0]['username'];
+			$this->mdl_user_firstname = $response['users'][0]['firstname'];
+			$this->mdl_user_lastname = $response['users'][0]['lastname'];
+			return true;
+		}
+		else 
+		{
+			$this->errormsg = 'Fehler beim Laden des Users';
+			return false;
+		}
+	}
+	
+	/**
+	 * Liefert ein Array mit allen Lektoren die
+	 * zu dem Moodle Kurs zugeteilt sind 
+	 */
+	public function getMitarbeiter($mdl_course_id)
+	{
+		//Mitarbeiter laden die zu diesem Kurs zugeteilt sind
+		$qry = "SELECT 
+					mitarbeiter_uid
+				FROM 
+					lehre.tbl_lehreinheitmitarbeiter JOIN lehre.tbl_moodle USING(lehreinheit_id) 
+				WHERE 
+					mdl_course_id=".$this->db_add_param($mdl_course_id, FHC_INTEGER)."
+				UNION
+				SELECT 
+					mitarbeiter_uid 
+				FROM 
+					lehre.tbl_lehreinheitmitarbeiter JOIN lehre.tbl_lehreinheit USING(lehreinheit_id)
+					JOIN lehre.tbl_moodle USING(lehrveranstaltung_id) 
+				WHERE 
+					tbl_lehreinheit.studiensemester_kurzbz=tbl_moodle.studiensemester_kurzbz
+					AND mdl_course_id=".$this->db_add_param($mdl_course_id, FHC_INTEGER);
+		$mitarbeiter=array();
+		if($this->db_query($qry))
+		{
+			while($row_ma = $this->db_fetch_object())
+			{
+				$mitarbeiter[] = $row_ma->mitarbeiter_uid;
+			}
+			return $mitarbeiter;
+		}
+		else 
+		{
+			$this->errormsg='Fehler beim Laden der Mitarbeiter';
+			return false;
+		}
+	}
+	
+	/**
+	 * Synchronisiert die Lektoren der Lehreinheiten
+	 * mit denen des Moodle Kurses
+	 * @param $mdl_course_id ID des MoodleKurses
+	 *        lehrveranstaltung_id wird nur angegeben beim Syncro von Testkursen
+	 *        studiensemester_kurzbz wird nur angegeben beim Syncro von Testkursen
+	 * @return true wenn ok, false wenn Fehler
+	 */
+	public function sync_lektoren($mdl_course_id, $lehrveranstaltung_id=null, $studiensemester_kurzbz=null)
+	{
+		//Mitarbeiter laden die zu diesem Kurs zugeteilt sind
+		if(!is_null($lehrveranstaltung_id) && !is_null($studiensemester_kurzbz))
+		{
+			//Bei Testkursen werden alle Lektoren einer Lehrveranstaltung zugeteilt
+			//da hier kein Eintrag in der tbl_moodle vorhanden ist, werden die Lektoren direkt aus
+			//der tbl_lehreinheitmitarbeiter geholt.
+			$qry = "SELECT 
+						mitarbeiter_uid 
+					FROM 
+						lehre.tbl_lehreinheitmitarbeiter 
+						JOIN lehre.tbl_lehreinheit USING(lehreinheit_id)
+					WHERE 
+						lehrveranstaltung_id=".$this->db_add_param($lehrveranstaltung_id, FHC_INTEGER)." 
+						AND studiensemester_kurzbz=".$this->db_add_param($studiensemester_kurzbz);	
+		}
+		else 
+		{
+			$qry = "SELECT 
+						mitarbeiter_uid
+					FROM 
+						lehre.tbl_lehreinheitmitarbeiter JOIN lehre.tbl_moodle USING(lehreinheit_id) 
+					WHERE 
+						mdl_course_id=".$this->db_add_param($mdl_course_id, FHC_INTEGER)."
+					UNION
+					SELECT 
+						mitarbeiter_uid 
+					FROM 
+						lehre.tbl_lehreinheitmitarbeiter JOIN lehre.tbl_lehreinheit USING(lehreinheit_id)
+						JOIN lehre.tbl_moodle USING(lehrveranstaltung_id) 
+					WHERE 
+						tbl_lehreinheit.studiensemester_kurzbz=tbl_moodle.studiensemester_kurzbz
+						AND mdl_course_id=".$this->db_add_param($mdl_course_id, FHC_INTEGER);
+		}
+		$mitarbeiter='';
+
+		$client = new SoapClient($this->serverurl); 
+		$enrolled_users = $client->core_enrol_get_enrolled_users($mdl_course_id,array());
+
+		if($result_ma = $this->db_query($qry))
+		{			
+			while($row_ma = $this->db_fetch_object($result_ma))
+			{
+				//MoodleID des Users holen bzw ggf neu anlegen
+				if(!$this->loaduser($row_ma->mitarbeiter_uid))
+				{
+					//User anlegen
+					if(!$this->createUser($row_ma->mitarbeiter_uid))
+					{
+						$this->errormsg = "Fehler beim Anlegen des Users $row_ma->mitarbeiter_uid: $this->errormsg";
+						return false;
+					}
+					else 
+						$this->errormsg = '';
+				}
+				
+				if($mitarbeiter!='')
+					$mitarbeiter.=',';
+				$mitarbeiter.=$this->mdl_user_id;
+				
+				$user_zugeteilt=false;
+				foreach($enrolled_users as $user)
+				{
+					if($user->id==$this->mdl_user_id)
+					{
+						$user_zugeteilt=true;
+						break;
+					}
+				}
+
+				if(!$user_zugeteilt)
+				{
+					//Mitarbeiter ist noch nicht zugeteilt.
+					$data = new stdClass();
+					$data->roleid=3; // 3=Lektor
+					$data->userid=$this->mdl_user_id;
+					$data->courseid=$mdl_course_id;
+
+					if($client->enrol_manual_enrol_users(array($data)))
+					{
+						$this->log.="\nder Lektor $this->mdl_user_firstname $this->mdl_user_lastname wurde zum Kurs hinzugefügt";
+						$this->log_public.="\nder Lektor $this->mdl_user_firstname $this->mdl_user_lastname wurde zum Kurs hinzugefügt";
+						$this->sync_create++;
+					}
+					else 
+						$this->log.="\nFehler beim Anlegen der Lektoren-Zuteilung: $this->errormsg";
+				}
+			}
+			
+			return true;
+		}
+		else 
+		{
+			$this->errormsg = 'Fehler beim Ermitteln der Zugeteilten Lektoren';
+			return false;
+		}
+	}
+	
+	/**
+	 * Synchronisiert die Studenten der Lehreinheiten
+	 * mit denen des Moodle Kurses
+	 * @param $mdl_course_id ID des MoodleKurses
+	 * @return true wenn ok, false wenn Fehler
+	 */
+	public function sync_studenten($mdl_course_id)
+	{
+		//Studentengruppen laden die zu diesem Kurs zugeteilt sind
+		$qry = "SELECT 
+					studiengang_kz, semester, verband, gruppe, gruppe_kurzbz, tbl_moodle.studiensemester_kurzbz, tbl_moodle.gruppen
+				FROM 
+					lehre.tbl_lehreinheitgruppe JOIN lehre.tbl_moodle USING(lehreinheit_id) 
+				WHERE 
+					mdl_course_id=".$this->db_add_param($mdl_course_id)."
+				UNION
+				SELECT 
+					studiengang_kz, semester, verband, gruppe, gruppe_kurzbz, tbl_moodle.studiensemester_kurzbz, tbl_moodle.gruppen
+				FROM 
+					lehre.tbl_lehreinheitgruppe JOIN lehre.tbl_lehreinheit USING(lehreinheit_id)
+					JOIN lehre.tbl_moodle USING(lehrveranstaltung_id) 
+				WHERE 
+					tbl_lehreinheit.studiensemester_kurzbz=tbl_moodle.studiensemester_kurzbz
+					AND mdl_course_id=".$this->db_add_param($mdl_course_id);
+		$studenten='';
+
+		$client = new SoapClient($this->serverurl); 
+		$enrolled_users = $client->core_enrol_get_enrolled_users($mdl_course_id, array());
+
+		if($result_std = $this->db_query($qry))
+		{			
+			while($row_std = $this->db_fetch_object($result_std))
+			{
+				//Schauen ob fuer diesen Kurs die Gruppen mitgesynct werden sollen
+				$gruppensync = $this->db_parse_bool($row_std->gruppen);
+				
+				//Studenten dieser Gruppe holen
+
+				if($row_std->gruppe_kurzbz=='') //LVB Gruppe
+				{
+					$qry = "SELECT
+								distinct student_uid
+							FROM
+								public.tbl_studentlehrverband
+							WHERE
+								studiensemester_kurzbz=".$this->db_add_param($row_std->studiensemester_kurzbz)." AND
+								studiengang_kz = ".$this->db_add_param($row_std->studiengang_kz)." AND
+								semester = ".$this->db_add_param($row_std->semester);
+
+					if(trim($row_std->verband)!='')
+					{
+						$qry.=" AND verband = ".$this->db_add_param($row_std->verband);
+						if(trim($row_std->gruppe)!='')
+						{
+							$qry.=" AND gruppe = ".$this->db_add_param($row_std->gruppe);
+						}
+					}
+					$studiengang_obj = new studiengang();
+					$studiengang_obj->load($row_std->studiengang_kz);
+					$gruppenbezeichnung = $studiengang_obj->kuerzel.'-'.trim($row_std->semester).trim($row_std->verband).trim($row_std->gruppe);
+				}
+				else //Spezialgruppe
+				{
+					$qry = "SELECT
+								distinct uid as student_uid
+							FROM
+								public.tbl_benutzergruppe
+							WHERE
+								gruppe_kurzbz=".$this->db_add_param($row_std->gruppe_kurzbz)." AND
+								studiensemester_kurzbz=".$this->db_add_param($row_std->studiensemester_kurzbz);
+					$gruppenbezeichnung = $row_std->gruppe_kurzbz;
+				}
+
+				if($result_user = $this->db_query($qry))
+				{
+					while($row_user = $this->db_fetch_object($result_user))
+					{
+						//MoodleID des Users holen bzw ggf neu anlegen
+						if(!$this->loaduser($row_user->student_uid))
+						{
+							//User anlegen
+							if(!$this->createUser($row_user->student_uid))
+							{
+								$this->errormsg = "Fehler beim Anlegen des Users $row_user->student_uid: $this->errormsg";
+								return false;
+							}
+							else 
+								$this->errormsg = '';
+						}
+						
+						if($studenten!='')
+							$studenten.=',';
+						$studenten.=$this->mdl_user_id;
+						
+						//Nachschauen ob dieser Student bereits zugeteilt ist
+
+						$user_zugeteilt=false;
+						foreach($enrolled_users as $user)
+						{
+							if(isset($user->id) && $user->id==$this->mdl_user_id)
+							{
+								$user_zugeteilt=true;
+								break;
+							}
+						}
+
+						if(!$user_zugeteilt)
+						{
+							//Student ist noch nicht zugeteilt.
+							
+							$data = new stdClass();
+							$data->roleid=5; // 5=Teilnehmer/Student
+							$data->userid=$this->mdl_user_id;
+							$data->courseid=$mdl_course_id;
+
+							if($client->enrol_manual_enrol_users(array($data)))
+							{
+								$this->log.="\nder Student $this->mdl_user_firstname $this->mdl_user_lastname wurde zum Kurs hinzugefügt";
+								$this->log_public.="\nder Student $this->mdl_user_firstname $this->mdl_user_lastname wurde zum Kurs hinzugefügt";
+								$this->sync_create++;
+							}
+							else 
+								$this->log.="\nFehler beim Anlegen der Studenten-Zuteilung: $this->errormsg";
+						}
+						//Gruppenzuteilung
+						if($gruppensync)
+						{
+							//Schauen ob die Gruppe vorhanden ist
+							if(!$groupid = $this->getGroup($mdl_course_id, $gruppenbezeichnung))
+							{
+								//wenn nicht dann anlegen
+								if(!$groupid = $this->createGroup($mdl_course_id, $gruppenbezeichnung))
+									continue;
+								$this->group_update++;
+								$this->log.="\nes wurde eine neue Gruppe angelgt: $gruppenbezeichnung";
+								$this->log_public.="\nes wurde eine neue Gruppe angelgt: $gruppenbezeichnung";
+							}
+							
+							//Schauen ob eine Zuteilung zu dieser Gruppe vorhanden ist
+							if(!$this->getGroupMember($groupid, $this->mdl_user_id))
+							{
+								//wenn nicht dann zuteilen
+								$this->createGroupMember($groupid, $this->mdl_user_id);
+								$this->group_update++;
+								$this->log.="\nder Student $this->mdl_user_firstname $this->mdl_user_lastname wurde der Gruppe $gruppenbezeichnung zugeordnet";
+								$this->log_public.="\nder Student $this->mdl_user_firstname $this->mdl_user_lastname wurde der Gruppe $gruppenbezeichnung zugeordnet";
+							}
+						}						
+					}
+				}
+			}
+			
+			return true;
+		}
+		else 
+		{
+			$this->errormsg = 'Fehler beim Ermitteln der Zugeteilten Studenten';
+			return false;
+		}
+	}
+	
+	/**
+	 * Schaut ob eine Zuteilung von Person zu Gruppe
+	 * existiert
+	 * @param grouid ID der Gruppe
+	 *        userid ID des Users
+	 * @return true wenn zugeteilt sonst false
+	 */
+	public function getGroupMember($groupid, $userid)
+	{
+		$client = new SoapClient($this->serverurl); 
+		$response = $client->core_group_get_group_members(array($groupid));
+
+		foreach($response as $row)
+		{
+			if(isset($row->id) && $row->id==$userid)
+				return true;
+		}
+		
+		return false;
+	}
+	
+	/**
+	 * Legt eine Zuteilung eines Users zu 
+	 * einer Gruppe an
+	 * @param groupid ID der Gruppe
+	 *        userid ID des Users
+	 * @return boolean
+	 */
+	public function createGroupMember($groupid, $userid)
+	{
+		$client = new SoapClient($this->serverurl); 
+		$response = $client->core_group_add_group_members(array(array('groupid'=>$groupid, 'userid'=>$userid)));
+		if(isset($response[0]))
+			return true;
+		else
+			return false;
+	}
+	
+	/**
+	 * Holt die ID einer MoodleGruppe
+	 * @param $mdl_course_id ID des Kurses
+	 *        $gruppenbezeichnung Name der Gruppe
+	 * @return GruppenID wenn ok, false im Fehlerfall
+	 */
+	public function getGroup($mdl_course_id, $gruppenbezeichnung)
+	{
+		$client = new SoapClient($this->serverurl); 
+		$response = $client->core_group_get_course_groups($mdl_course_id);
+
+		foreach($response as $row)
+		{
+			if($row['name']==$gruppenbezeichnung)
+				return $row['id'];
+		}
+
+		$this->errormsg = "Gruppe wurde nicht gefunden $gruppenbezeichnung";
+		return false;
+	}
+	
+	/**
+	 * Legt eine MoodleGruppe zu einem Kurs an
+	 * @param mdl_course_id ID des MoodleKuses
+	 *        gruppenbezeichnung Bezeichnung der Gruppe
+	 * @return ID der Gruppe wenn ok, false im Fehlerfall
+	 */
+	public function createGroup($mdl_course_id,  $gruppenbezeichnung)
+	{
+		$client = new SoapClient($this->serverurl); 
+		$data = new stdClass();
+		$data->courseid=$mdl_course_id;
+		$data->name = $gruppenbezeichnung;
+		$data->description = $gruppenbezeichnung;
+
+		$response = $client->core_group_create_groups(array($data));
+
+		if(isset($response[0]))
+		{
+			return $response[0]['id'];
+		}
+		else
+		{
+			$this->errormsg = 'Fehler beim Anlegen der Gruppe';
+			return false;
+		}
+	}
+		
+	/**
+	 * Legt einen User im Moodle an
+	 * @param $uid UID der Person die angelegt werden soll
+	 * @return true wenn ok, false wenn Fehler
+	 */
+	public function createUser($uid)
+	{
+		$qry = "SELECT uid, vorname, nachname FROM campus.vw_benutzer WHERE uid=".$this->db_add_param($uid);
+		if($this->db_query($qry))
+		{
+			if($row = $this->db_fetch_object())
+			{
+				$username = $row->uid;
+				$vorname = $row->vorname;
+				$nachname = $row->nachname;
+
+				$user = new stdClass();
+				$user->username = $username;
+				/* 
+				 Passwort muss gesetzt werden damit das Anlegen funktioniert.
+				 Es wird ein random Passwort gesetzt
+				 Dieses wird beim Login nicht verwendet da ueber ldap authentifiziert wird.
+				 Prefix ist noetig damit es nicht zu Problemen kommt wenn
+				 im Moodle die Passwort Policy aktiviert ist
+				*/
+				$user->password = "FHCv!A2".hash('sha512', rand()); 
+				$user->firstname = $vorname;
+				$user->lastname = $nachname;
+				$user->email = $username.'@'.DOMAIN;
+				$user->auth = 'ldap';
+				$user->idnumber = $username;
+				$user->lang = 'de';
+
+				$client = new SoapClient($this->serverurl); 
+				$response = $client->core_user_create_users(array($user));
+
+				if(isset($response[0]))
+				{
+					$this->mdl_user_id = $response[0]['id'];
+					return true;
+				}
+				else
+				{
+					$this->errormsg = 'Fehler beim Laden des Users';
+					return false;
+				}
+			}
+			else
+			{
+				$this->errormsg = 'Fehler beim Laden des Users';
+				return false;
+			}
+		}
+		else
+		{
+			$this->errormsg='Fehler beim Laden des Users';
+			return false;
+		}
+	}	
+	
+	/**
+	 * Teilt die TestStudenten zu einem Testkurs zu
+	 * @param mdl_course_id ID des Moodle Kurses
+	 */
+	public function createTestStudentenZuordnung($mdl_course_id)
+	{
+		//Context des Kurses holen
+		$mdlcourse = new moodle_course();
+		
+		$users = array('student1', 'student2', 'student3');
+
+		foreach ($users as $row_user)
+		{
+			//MoodleID des Users holen
+			if(!$this->loaduser($row_user))
+			{
+				$this->errormsg = "Fehler beim Laden des Users $row_user: $this->errormsg";
+				return false;				
+			}
+
+			$data = new stdClass();
+			$data->roleid=5;
+			$data->userid=$this->mdl_user_id;
+			$data->courseid=$mdl_course_id;
+
+			$client = new SoapClient($this->serverurl); 
+			$client->enrol_manual_enrol_users(array($data));
+			// WS-Funktion enrol_manual_enrol_users liefert immer null zurück
+			// Fehler bei der Zuordnung koennen daher nicht abgefangen werden.
+			// Eventuell sollten hier nochmals die Teilnehmer des Kurses geladen werden
+			// um zu pruefen ob die Zuordnung erfolgreich war.
+		}
+		
+		return true;
+	}
+}