path: root/modules-available/locationinfo/inc/coursebackend/coursebackend_hisinone.inc.php

<?php

class CourseBackend_HisInOne extends CourseBackend
{
	private $username;
	private $password;
	private $open;

	//Sets the location and the login information of this client
	public function setCredentials($json, $location, $serverID)
	{
		$this->error = false;
		$data = json_decode($json, true);
		$this->password = $data['password'];
		$this->username = $data['username'] . "\t" . $data['role'];
		$this->open = $data['open'];
		if ($this->open) {
			$this->location = $location . "/qisserver/services2/OpenCourseService";
		} else {
			$this->location = $location . "/qisserver/services2/CourseService";
		}
		$this->serverID = $serverID;
		return $this->checkConnection();
	}

	public function checkConnection()
	{
		if ($this->location = "") {
			$this->error = true;
			$this->errormsg = "No url is given";
			return !$this->error;
		}
		$this->findUnit(42);
		return !$this->error;
	}

	//Cache the timetables for 30 minutes ttables older than 60 are not refreshed
	public function getCacheTime()
	{
		return 30 * 60;
	}

	//ttables older than 60 minutes are not refreshed
	public function getRefreshTime()
	{
		return 60 * 60;
	}

	public function getDisplayName()
	{
		return "HisInOne";
	}

	public function getCredentials()
	{
		$credentials = ["username" => "string", "role" => "string", "password" => "string", "open" => "boolean"];
		return $credentials;
	}

	//Contstructs the Soap Header $doc is a DOMDocument this returns a DOMElement
	private function getHeader($doc)
	{
		$header = $doc->createElement('SOAP-ENV:Header');
		$security = $doc->createElementNS('http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd', 'ns2:Security');
		$mustunderstand = $doc->createAttribute('SOAP-ENV:mustUnderstand');
		$mustunderstand->value = 1;
		$security->appendChild($mustunderstand);
		$header->appendChild($security);
		$token = $doc->createElement('ns2:UsernameToken');
		$security->appendChild($token);
		$user = $doc->createElement('ns2:Username', $this->username);
		$token->appendChild($user);
		$pass = $doc->createElement('ns2:Password', $this->password);
		$type = $doc->createAttribute('Type');
		$type->value = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText';
		$pass->appendChild($type);
		$token->appendChild($pass);
		return $header;
	}

	//returns the IDs in an array for a given roomID or false if there was an error
	public function findUnit($roomID)
	{
		$termYear = date('Y');
		$termType = date('n');
		if ($termType > 3 && $termType < 10) {
			$termType = 2;
		} elseif ($termType > 10) {
			$termType = 1;
			$termYear = $termYear + 1;
		} else {
			$termType = 1;
		}
		$doc = new DOMDocument('1.0', 'utf-8');
		$doc->formatOutput = true;
		$envelope = $doc->createElementNS('http://schemas.xmlsoap.org/soap/envelope/', 'SOAP-ENV:Envelope');
		$doc->appendChild($envelope);
		if ($this->open) {
			$envelope->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:ns1', 'http://www.his.de/ws/OpenCourseService');
		} else {
			$envelope->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:ns1', 'http://www.his.de/ws/CourseService');
			$header = $this->getHeader($doc);
			$envelope->appendChild($header);
		}
		//Body of the request
		$body = $doc->createElement('SOAP-ENV:Body');
		$envelope->appendChild($body);
		$findUnit = $doc->createElement('ns1:findUnit');
		$body->appendChild($findUnit);
		$termYearN = $doc->createElement('termYear', $termYear);
		$findUnit->appendChild($termYearN);
		$termTypeValueId = $doc->createElement('termTypeValueId', $termType);
		$findUnit->appendChild($termTypeValueId);
		$roomIdN = $doc->createElement('ns1:roomId', $roomID);
		$findUnit->appendChild($roomIdN);

		$soap_request = $doc->saveXML();
		$response1 = $this->__doRequest($soap_request, "findUnit");
		if ($this->error == true) {
			return false;
		}
		$response2 = $this->toArray($response1);
		if (isset($response2['soapenvBody']['soapenvFault'])) {
			$this->error = true;
			$this->errormsg = $response2['soapenvBody']['soapenvFault']['faultcode'] . " " . $response2['soapenvBody']['soapenvFault']['faultstring'];
			return false;
		} else {
			$this->error = false;
		}
		try {
			if ($this->open) {
				$units = $response2['soapenvBody']['hisfindUnitResponse']['hisunits']['hisunit'];
				$id = [];
				foreach ($units as $unit) {
					$id[] = $unit['hisid'];
				}
			} else {
				$id = $response2['soapenvBody']['hisfindUnitResponse']['hisunitIds']['hisid'];
			}
		} catch (Exception $exception) {
			if ($this->error) {
				$id = false;
			} else {
				$this->error = true;
				$this->errormsg = "url send a xml in a wrong format";
				$id = false;
			}
		}
		return $id;
	}

	//This function sends a Soaprequest with the eventID and returns an array which contains much
	// informations, like start and enddates for events and their name. It returns false if there was an error
	public function readUnit($unit)
	{
		$doc = new DOMDocument('1.0', 'utf-8');
		$doc->formatOutput = true;
		$envelope = $doc->createElementNS('http://schemas.xmlsoap.org/soap/envelope/', 'SOAP-ENV:Envelope');
		$doc->appendChild($envelope);
		if ($this->open) {
			$envelope->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:ns1', 'http://www.his.de/ws/OpenCourseService');
		} else {
			$envelope->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:ns1', 'http://www.his.de/ws/CourseService');
			$header = $this->getHeader($doc);
			$envelope->appendChild($header);
		}
		//body of the request
		$body = $doc->createElement('SOAP-ENV:Body');
		$envelope->appendChild($body);
		$readUnit = $doc->createElement('ns1:readUnit');
		$body->appendChild($readUnit);
		$unitId = $doc->createElement('ns1:unitId', $unit);
		$readUnit->appendChild($unitId);

		$soap_request = $doc->saveXML();
		$response1 = $this->__doRequest($soap_request, "readUnit");
		if ($this->error == true) {
			return false;
		}
		$response2 = $this->toArray($response1);
		if (!$this->error) {
			if (isset($response2['soapenvBody']['soapenvFault'])) {
				$this->error = true;
				$this->errormsg = $response2['soapenvBody']['soapenvFault']['faultcode'] . " " . $response2['soapenvBody']['soapenvFault']['faultstring'];
				return false;
			} else {
				try {
					$this->error = false;
					$response3 = $response2['soapenvBody']['hisreadUnitResponse'];
				} catch (Exception $e) {
					$this->error = true;
					$this->errormsg = "url send a xml in a wrong format";
					return false;
				}
			}
		} else {
			return false;
		}

		return $response3;
	}

	//Makes a SOAP-Request as a normal POST
	function __doRequest($request, $action)
	{
		$header = array(
			"Content-type: text/xml;charset=\"utf-8\"",
			"SOAPAction: \"" . $action . "\"",
			"Content-length: " . strlen($request),
		);

		$soap_do = curl_init();

		$options = array(
			CURLOPT_RETURNTRANSFER => true,
			CURLOPT_FOLLOWLOCATION => true,
			CURLOPT_SSL_VERIFYHOST => false,
			CURLOPT_SSL_VERIFYPEER => false,
			CURLOPT_URL => $this->location,
			CURLOPT_POSTFIELDS => $request,
			CURLOPT_HTTPHEADER => $header,
		);

		curl_setopt_array($soap_do, $options);

		$output = curl_exec($soap_do);

		if ($output === false) {
			$this->error = true;
			$this->errormsg = 'Curl error: ' . curl_error($soap_do);
		} else {
			$this->error = false;
			$this->errormsg = "";
			///Operation completed successfully
		}
		curl_close($soap_do);
		return $output;
	}

	/**
	 * Request for a timetable
	 *
	 * @param $param int the roomid
	 * @return string the timetable as json or false if there was an error
	 */
	public function getJson($param)
	{
		//get all eventIDs in a given room
		$eventIDs = $this->findUnit($param);
		if ($this->error == true) {
			return false;
		}
		//get all information on each event
		$events = [];
		foreach ($eventIDs as $each_event) {
			$events[] = $this->readUnit((int)$each_event);
			if ($this->error == true) {
				return false;
			}
		}
		$timetable = array();
		$currentWeek = $this->getCurrentWeekDates();
		//Here I go over the soapresponse
		try {
			foreach ($events as $event) {
				$title = $event['hisunit']['hisplanelements']['hisplanelement'][0]['hisdefaulttext'];
				foreach ($event as $subject) {
					$units = $subject['hisplanelements']['hisplanelement'];
					foreach ($units as $unit) {
						$pdates = $unit['hisplannedDates']['hisplannedDate'];
						//there seems to be a bug that gives more than one individualDates in plannedDate
						//this construction catches it
						if (array_key_exists('hisindividualDates', $pdates)) {
							$dates = $pdates['hisindividualDates']['hisindividualDate'];
							foreach ($dates as $date) {
								$roomID = $date['hisroomId'];
								$datum = $date['hisexecutiondate'];
								if (intval($roomID) == $param && in_array($datum, $currentWeek)) {

									$startTime = $date['hisstarttime'];
									$endTime = $date['hisendtime'];
									$json = array(
										'title' => $title,
										'start' => $datum . " " . $startTime,
										'end' => $datum . " " . $endTime
									);
									array_push($timetable, $json);
								}
							}
						} else {
							foreach ($pdates as $dates2) {
								$dates = $dates2['hisindividualDates']['hisindividualDate'];
								foreach ($dates as $date) {
									$roomID = $date['hisroomId'];
									$datum = $date['hisexecutiondate'];
									if (intval($roomID) == $param && in_array($datum, $currentWeek)) {

										$startTime = $date['hisstarttime'];
										$endTime = $date['hisendtime'];
										$json = array(
											'title' => $title,
											'start' => $datum . " " . $startTime,
											'end' => $datum . " " . $endTime
										);
										array_push($timetable, $json);
									}
								}
							}
						}


					}
				}
			}
		} catch (Exception $e) {
			$this->error = true;
			$this->errormsg = "url returns a wrong xml";
			return false;
		}
		$timetable = json_encode($timetable);
		return $timetable;
	}

	//this function transforms a xml string into an array or return false if there was an error
	private function toArray($response)
	{
		try {
			$cleanresponse = preg_replace("/(<\/?)(\w+):([^>]*>)/", "$1$2$3", $response);
			$xml = new SimpleXMLElement($cleanresponse);
			$array = json_decode(json_encode((array)$xml), true);
		} catch (Exception $e) {
			$this->error = true;
			$this->errormsg = "url did not send a xml";
			$array = false;
		}
		return $array;
	}

	//Request for a timetable with roomids as array it will be boolean false if there was an error
	public function fetchSchedulesInternal($param)
	{
		$tTables = [];
		//get all eventIDs in a given room
		$eventIDs = [];
		foreach ($param as $ID) {
			$eventIDs = array_merge($eventIDs, $this->findUnit($ID));
			var_dump($eventIDs);
			$eventIDs = array_unique($eventIDs);
			if ($this->error == true) {
				return false;
			}
		}
		//get all information on each event
		foreach ($eventIDs as $each_event) {
			$events[] = $this->readUnit(intval($each_event));
			if ($this->error == true) {
				return false;
			}
		}
		$currentWeek = $this->getCurrentWeekDates();
		try {
			foreach ($param as $room) {
				$timetable = array();
				//Here I go over the soapresponse
				foreach ($events as $event) {
					$title = $event['hisunit']['hisplanelements']['hisplanelement'][0]['hisdefaulttext'];
					foreach ($event as $subject) {
						$units = $subject['hisplanelements']['hisplanelement'];
						foreach ($units as $unit) {
							$pdates = $unit['hisplannedDates']['hisplannedDate'];
							//there seems to be a bug that gives more than one individualDates in plannedDate
							//this construction catches it
							if (array_key_exists('hisindividualDates', $pdates)) {
								$dates = $pdates['hisindividualDates']['hisindividualDate'];
								foreach ($dates as $date) {
									$roomID = $date['hisroomId'];
									$datum = $date['hisexecutiondate'];
									if (intval($roomID) == $room && in_array($datum, $currentWeek)) {
										$startTime = $date['hisstarttime'];
										$endTime = $date['hisendtime'];
										$json = array(
											'title' => $title,
											'start' => $datum . " " . $startTime,
											'end' => $datum . " " . $endTime
										);
										array_push($timetable, $json);
									}
								}
							} else {
								foreach ($pdates as $dates2) {
									$dates = $dates2['hisindividualDates']['hisindividualDate'];
									foreach ($dates as $date) {
										$roomID = $date['hisroomId'];
										$datum = $date['hisexecutiondate'];
										if (intval($roomID) == $room && in_array($datum, $currentWeek)) {

											$startTime = $date['hisstarttime'];
											$endTime = $date['hisendtime'];
											$json = array(
												'title' => $title,
												'start' => $datum . " " . $startTime,
												'end' => $datum . " " . $endTime
											);
											array_push($timetable, $json);
										}
									}
								}
							}
						}
					}
				}
				$tTables[$room] = json_encode($timetable);
			}
		} catch (Exception $e) {
			$this->error = true;
			$this->errormsg = "url returns a wrong xml";
			return false;
		}
		return $tTables;
	}


	private function getCurrentWeekDates()
	{
		$DateArray = array();
		$startdate = strtotime('Now');
		for ($i = 0; $i <= 7; $i++) {
			$DateArray[] = date('Y-m-d', strtotime("+ {$i} day", $startdate));
		}
		return $DateArray;
	}

}