egroupware/phpgwapi/inc/class.soap_server.inc.php

<?php
// SOAP server class

// for example usage, see the test_server.php file.

	class soap_server
	{
		function soap_server($data='',$serviceNow=False)
		{
			// create empty dispatch map
			$this->dispatch_map = array();
			$this->debug_flag = True;
			$this->debug_str = '';
			$this->headers = '';
			$this->request = '';
			$this->result = 'successful';
			$this->fault = false;
			$this->fault_code = '';
			$this->fault_str = '';
			$this->fault_actor = '';

			if($serviceNow == 1)
			{
				$this->service($data);
			}
		}

		// parses request and posts response
		function service($data)
		{
			// $response is a soap_msg object
			$response = get_class($data) == 'soapmsg' ? $date : $this->parseRequest($data);
			$this->debug("parsed request and got an object of this class '".get_class($response)."'");
			$this->debug("server sending...");
			// pass along the debug string
			if($this->debug_flag)
			{
				$response->debug($this->debug_str);
			}
			$payload = $response->serialize();
			// print headers
			if($this->fault)
			{
				$header[] = "HTTP/1.0 500 Internal Server Error\r\n";
			}
			else
			{
				$header[] = "HTTP/1.0 200 OK\r\n";
				$header[] = "Status: 200\r\n";
			}
			$header[] = "Server: SOAPx4 Server v0.344359s\r\n";
			$header[] = "Connection: Close\r\n";
			$header[] = "Content-Type: text/xml; charset=UTF-8\r\n";
			$header[] = "Content-Length: ".strlen($payload)."\r\n\r\n";
			reset($header);
			foreach($header as $hdr)
			{
				header($hdr);
			}
			print $payload;
		}

		function parseRequest($data="")
		{
			global $HTTP_SERVER_VARS;

			$this->debug("entering parseRequest() on ".date("H:i Y-m-d"));
			$request_uri = $HTTP_SERVER_VARS["REQUEST_URI"];
			$this->debug("request uri: $request_uri");
			// get headers
			$headers_array = getallheaders();
			foreach($headers_array as $k=>$v)
			{
				$dump .= "$k: $v\r\n";
			}
			$dump .= "\r\n\r\n".$data;
			$this->headers = $headers_array;
			$this->request = $dump;

			// get SOAPAction header -> methodname
			if($headers_array["SOAPAction"])
			{
				$action = str_replace('"','',$headers_array["SOAPAction"]);
				if(preg_match('/'."^urn:".'/',$action))
				{
					$this->service = substr($action,4);
				}
				elseif(preg_match('/'.".php".'/',$action))
				{
					$this->service = preg_replace('/"|\\//','',substr(strrchr($action,".php"),4,strlen(strrchr($action,"/"))));
				}
				$this->debug("got service: $this->service");
			}
			else
			{
				// throw a fault if no soapaction
				$this->debug("ERROR: no SOAPAction header found");
			}
			// NOTE:::: throw a fault for no/bad soapaction here?

			// parse response, get soap parser obj
			$parser = CreateObject('phpgwapi.soap_parser',$data);
			// get/set methodname
			$this->methodname = $parser->root_struct_name;
			$this->debug("method name: $this->methodname");

			// does method exist?
			$test = preg_replace('/'."\.".'/','_',$this->methodname);
			if(function_exists($test))
			{
				$method = $this->methodname = $test;
				$this->debug("method '$this->methodname' exists");
			}
			else
			{
				/* egroupware customization - createobject based on methodname */
				list($app,$class,$method) = explode('.',$this->methodname);
				if(preg_match('/'."^service".'/',$app))
				{
					$args  = $class;
					$class = 'service';
					$app   = 'phpgwapi';
					$obj   = CreateObject(sprintf('%s.%s',$app,$class),$args);
					unset($args);
				}
				else
				{
					$obj = CreateObject(sprintf('%s.%s',$app,$class));
				}
				$this->debug('app: ' . $app . ', class: ' . $class . ', method: ' . $method);
				/*
				// "method not found" fault here
				$this->debug("method '$obj->method' not found!");
				$this->result = "fault: method not found";
				$this->make_fault("Server","method '$obj->method' not defined in service '$this->service'");
				return $this->fault();
				*/
			}

			// if fault occurred during message parsing
			if($parser->fault())
			{
				// parser debug
				$this->debug($parser->debug_str);
				$this->result = "fault: error in msg parsing or eval";
				$this->make_fault("Server","error in msg parsing or eval:\n".$parser->get_response());
				// return soapresp
				return $this->fault();
				// else successfully parsed request into soapval object
			}
			else
			{
				// get eval_str
				$this->debug("calling parser->get_response()");
				// evaluate it, getting back a soapval object
				if(!$request_val = $parser->get_response())
				{
					return $this->fault();
				}
				// parser debug
				$this->debug($parser->debug_str);
				if(get_class($request_val) == "soapval")
				{
					if (is_object($obj))
					{
						/* Add the function to the server map */
						$in  = "array('" . implode("','",$obj->soap_functions[$method]['in']) . "')";
						$out = "array('" . implode("','",$obj->soap_functions[$method]['out']) . "')";
						$evalmap  = "\$this->add_to_map(\$this->methodname,$in,$out);";
						eval($evalmap);
					}
					/* verify that soapval objects in request match the methods signature */
					if($this->verify_method($request_val))
					{
						$this->debug("request data - name: $request_val->name, type: $request_val->type, value: $request_val->value");
						if($this->input_value)
						{
							/* decode the soapval object, and pass resulting values to the requested method */
							if(!$request_data = $request_val->decode())
							{
								$this->make_fault("Server","Unable to decode response from soapval object into native php type.");
								return $this->fault();
							}
							$this->debug("request data: $request_data");
						}

						/* if there are return values */
						if($this->return_type = $this->get_return_type())
						{
							$this->debug("got return type: '$this->return_type'");
							/* if there are parameters to pass */
							if($request_data)
							{
								if (is_object($obj))
								{
									$code = "\$method_response = call_user_func(array($obj,$method),";
									$this->debug("about to call object method '$class\-\>$method' with args");
								}
								else
								{
									$code = '$method_response = ' . $this->methodname . "('";
									$args = implode("','",$request_data['return']);
									$this->debug("about to call method '$this->methodname' with args: $args");
								}
								/* call method with parameters */
								$code .= implode("','",$request_data['return']);
								/*
								while(list($x,$y) = each($request_data))
								{
									$code .= "\$request_data[$x]" . ',';
								}
								$code = substr($code,0,-1) .");";
								*/
								$code .= "');";
								$this->debug('CODE: ' . $code);
								if(eval($code))
								{
									if (is_object($obj))
									{
										$this->make_fault("Server","Object method call failed for '$class\-\>$method' with params: ".join(',',$request_data));
									}
									else
									{
										$this->make_fault("Server","Method call failed for '$this->methodname' with params: ".join(',',$request_data));
									}
									return $this->fault();
								}
								$this->debug('Response: ' . $method_response);
								//							_debug_array($method_response);
							}
							else
							{
								/* call method w/ no parameters */
								if (is_object($obj))
								{
									$this->debug("about to call object method '$obj\-\>$method'");
									if(!$method_response = call_user_func(array($obj,$method)))
									{
										$this->make_fault("Server","Method call failed for '$obj->method' with no params");
										return $this->fault();
									}
								}
								else
								{
									$this->debug("about to call method '$this->methodname'");
									if(!$method_response = call_user_func($this->methodname))
									{
										$this->make_fault("Server","Method call failed for '$this->methodname' with no params");
										return $this->fault();
									}
								}
							}
							/* no return values */
						}
						else
						{
							if($request_data)
							{
								/* call method with parameters */
								$code = "\$method_response = call_user_func(array(\$obj,\$method),";
								while(list($x,$y) = each($request_data))
								{
									$code .= "\$request_data[$x]" . ',';
								}
								$code = substr($code,0,-1) .");";
								$this->debug("about to call object method '$obj\-\>$method'");
								eval($code);
							}
							else
							{
								/* call method w/ no parameters */
								if(is_object($obj))
								{
									$this->debug("about to call object method '$obj\-\>$method'");
									call_user_func(array($obj,$method));
								}
								else
								{
									$this->debug("about to call method '$method'");
									call_user_func($method);
								}
							}
						}

						/* create soap_val object w/ return values from method, use method signature to determine type */
						if(get_class($method_response) != 'soapval')
						{
							$return_val = CreateObject('phpgwapi.soapval',$method,$this->return_type,$method_response);
						}
						else
						{
							$return_val = $method_response;
						}
						$this->debug($return_val->debug_str);
						/* response object is a soap_msg object */
						$return_msg =  CreateObject('phpgwapi.soapmsg',$method.'Response',array($return_val),$this->service);
						if($this->debug_flag)
						{
							$return_msg->debug_flag = true;
						}
						$this->result = "successful";
						return $return_msg;
					}
					else
					{
						// debug
						$this->debug("ERROR: request not verified against method signature");
						$this->result = "fault: request failed validation against method signature";
						// return soapresp
						return $this->fault();
					}
				}
				else
				{
					// debug
					$this->debug("ERROR: parser did not return soapval object: $request_val ".get_class($request_val));
					$this->result = "fault: parser did not return soapval object: $request_val";
					// return fault
					$this->make_fault("Server","parser did not return soapval object: $request_val");
					return $this->fault();
				}
			}
		}

		function verify_method($request)
		{
			//return true;
			$this->debug("entered verify_method() w/ request name: ".$request->name);
			$params = $request->value;
			// if there are input parameters required...
			if($sig = $this->dispatch_map[$this->methodname]["in"])
			{
				$this->input_value = count($sig);
				if(is_array($params))
				{
					$this->debug("entered verify_method() with ".count($params)." parameters");
					foreach($params as $v)
					{
						$this->debug("param '$v->name' of type '$v->type'");
					}
					// validate the number of parameters
					if(count($params) == count($sig))
					{
						$this->debug("got correct number of parameters: ".count($sig));
						// make array of param types
						foreach($params as $param)
						{
							$p[] = strtolower($param->type);
						}
						// validate each param's type
						for($i=0; $i < count($p); $i++)
						{
							// type not match
							if(strtolower($sig[$i]) != strtolower($p[$i]))
							{
								$this->debug("mismatched parameter types: $sig[$i] != $p[$i]");
								$this->make_fault("Client","soap request contained mismatching parameters of name $v->name had type $p[$i], which did not match signature's type: $sig[$i]");
								return false;
							}
							$this->debug("parameter type match: $sig[$i] = $p[$i]");
						}
						return true;
						// oops, wrong number of paramss
					}
					else
					{
						$this->debug("oops, wrong number of parameter!");
						$this->make_fault("Client","soap request contained incorrect number of parameters. method '$this->methodname' required ".count($sig)." and request provided ".count($params));
						return false;
					}
					// oops, no params...
				}
				else
				{
					$this->debug("oops, no parameters sent! Method '$this->methodname' requires ".count($sig)." input parameters!");
					$this->make_fault("Client","soap request contained incorrect number of parameters. method '$this->methodname' requires ".count($sig)." parameters, and request provided none");
					return false;
				}
				// no params
			}
			elseif( (count($params)==0) && (count($sig) <= 1) )
			{
				$this->input_values = 0;
				return true;
			}
			else
			{
				//$this->debug("well, request passed parameters to a method that requires none?");
				//$this->make_fault("Client","method '$this->methodname' requires no parameters. The request passed in ".count($params).": ".@implode(" param: ",$params) );
				return true;
			}
		}

		// get string return type from dispatch map
		function get_return_type()
		{
			if(count($this->dispatch_map[$this->methodname]["out"]) >= 1)
			{
				$type = array_shift($this->dispatch_map[$this->methodname]["out"]);
				$this->debug("got return type from dispatch map: '$type'");
				return $type;
			}
			return false;
		}

		// dbg
		function debug($string)
		{
			if($this->debug_flag)
			{
				$this->debug_str .= "$string\n";
			}
		}

		// add a method to the dispatch map
		function add_to_map($methodname,$in,$out)
		{
			$this->dispatch_map[$methodname]["in"] = $in;
			$this->dispatch_map[$methodname]["out"] = $out;
		}

		// set up a fault
		function fault()
		{
			return CreateObject('phpgwapi.soapmsg',
			"Fault",
			array(
				"faultcode" => $this->fault_code,
				"faultstring" => $this->fault_str,
				"faultactor" => $this->fault_actor,
				"faultdetail" => $this->fault_detail.$this->debug_str
			),
			"http://schemas.xmlphpgwapi.org/soap/envelope/"
		);
	}

	function make_fault($fault_code,$fault_string)
	{
		$this->fault_code = $fault_code;
		$this->fault_str = $fault_string;
		$this->fault = true;
	}
}
?>