/
CWebService.php
357 lines (336 loc) · 10.3 KB
/
CWebService.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?php
/**
* CWebService class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright 2008-2013 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* CWebService encapsulates SoapServer and provides a WSDL-based web service.
*
* PHP SOAP extension is required.
*
* CWebService makes use of {@link CWsdlGenerator} and can generate the WSDL
* on-the-fly without requiring you to write complex WSDL. However WSDL generator
* could be customized through {@link generatorConfig} property.
*
* To generate the WSDL based on doc comment blocks in the service provider class,
* call {@link generateWsdl} or {@link renderWsdl}. To process the web service
* requests, call {@link run}.
*
* @property string $methodName The currently requested method name. Empty if no method is being requested.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package system.web.services
* @since 1.0
*/
class CWebService extends CComponent
{
const SOAP_ERROR=1001;
/**
* @var string|object the web service provider class or object.
* If specified as a class name, it can be a path alias.
*/
public $provider;
/**
* @var string the URL for WSDL. This is required by {@link run()}.
*/
public $wsdlUrl;
/**
* @var string the URL for the Web service. This is required by {@link generateWsdl()} and {@link renderWsdl()}.
*/
public $serviceUrl;
/**
* @var integer number of seconds that the generated WSDL can remain valid in cache. Defaults to 0, meaning no caching.
*/
public $wsdlCacheDuration=0;
/**
* @var string the ID of the cache application component that is used to cache the generated WSDL.
* Defaults to 'cache' which refers to the primary cache application component.
* Set this property to false if you want to disable caching WSDL.
*/
public $cacheID='cache';
/**
* @var string encoding of the Web service. Defaults to 'UTF-8'.
*/
public $encoding='UTF-8';
/**
* @var array a list of classes that are declared as complex types in WSDL.
* This should be an array with WSDL types as keys and names of PHP classes as values.
* A PHP class can also be specified as a path alias.
* @see http://www.php.net/manual/en/soapserver.soapserver.php
*/
public $classMap=array();
/**
* @var string actor of the SOAP service. Defaults to null, meaning not set.
*/
public $actor;
/**
* @var string SOAP version (e.g. '1.1' or '1.2'). Defaults to null, meaning not set.
*/
public $soapVersion;
/**
* @var integer the persistence mode of the SOAP server.
* @see http://www.php.net/manual/en/soapserver.setpersistence.php
*/
public $persistence;
/**
* @var string|array WSDL generator configuration. This property may be useful in purpose of enhancing features
* of the standard {@link CWsdlGenerator} class by extending it. For example, some developers may need support
* of the <code>xsd:xsd:base64Binary</code> elements. Another use case is to change initial values
* at instantiation of the default {@link CWsdlGenerator}. The value of this property will be passed
* to {@link Yii::createComponent} to create the generator object. Default value is 'CWsdlGenerator'.
* @since 1.1.12
*/
public $generatorConfig='CWsdlGenerator';
private $_method;
/**
* Constructor.
* @param mixed $provider the web service provider class name or object
* @param string $wsdlUrl the URL for WSDL. This is required by {@link run()}.
* @param string $serviceUrl the URL for the Web service. This is required by {@link generateWsdl()} and {@link renderWsdl()}.
*/
public function __construct($provider,$wsdlUrl,$serviceUrl)
{
$this->provider=$provider;
$this->wsdlUrl=$wsdlUrl;
$this->serviceUrl=$serviceUrl;
}
/**
* The PHP error handler.
* @param CErrorEvent $event the PHP error event
*/
public function handleError($event)
{
$event->handled=true;
$message=$event->message;
if(YII_DEBUG)
{
$trace=debug_backtrace();
if(isset($trace[2]) && isset($trace[2]['file']) && isset($trace[2]['line']))
$message.=' ('.$trace[2]['file'].':'.$trace[2]['line'].')';
}
throw new CException($message,self::SOAP_ERROR);
}
/**
* Generates and displays the WSDL as defined by the provider.
* @see generateWsdl
*/
public function renderWsdl()
{
$wsdl=$this->generateWsdl();
header('Content-Type: text/xml;charset='.$this->encoding);
header('Content-Length: '.(function_exists('mb_strlen') ? mb_strlen($wsdl,'8bit') : strlen($wsdl)));
echo $wsdl;
}
/**
* Generates the WSDL as defined by the provider.
* The cached version may be used if the WSDL is found valid in cache.
* @return string the generated WSDL
* @see wsdlCacheDuration
*/
public function generateWsdl()
{
$providerClass=is_object($this->provider) ? get_class($this->provider) : Yii::import($this->provider,true);
if($this->wsdlCacheDuration>0 && $this->cacheID!==false && ($cache=Yii::app()->getComponent($this->cacheID))!==null)
{
$key='Yii.CWebService.'.$providerClass.$this->serviceUrl.$this->encoding;
if(($wsdl=$cache->get($key))!==false)
return $wsdl;
}
$generator=Yii::createComponent($this->generatorConfig);
$wsdl=$generator->generateWsdl($providerClass,$this->serviceUrl,$this->encoding);
if(isset($key))
$cache->set($key,$wsdl,$this->wsdlCacheDuration);
return $wsdl;
}
/**
* Handles the web service request.
*/
public function run()
{
header('Content-Type: text/xml;charset='.$this->encoding);
if(YII_DEBUG)
ini_set("soap.wsdl_cache_enabled",0);
$server=new SoapServer($this->wsdlUrl,$this->getOptions());
Yii::app()->attachEventHandler('onError',array($this,'handleError'));
try
{
if($this->persistence!==null)
$server->setPersistence($this->persistence);
if(is_string($this->provider))
$provider=Yii::createComponent($this->provider);
else
$provider=$this->provider;
if(method_exists($server,'setObject'))
{
if (is_array($this->generatorConfig) && isset($this->generatorConfig['bindingStyle'])
&& $this->generatorConfig['bindingStyle']==='document')
{
$server->setObject(new CDocumentSoapObjectWrapper($provider));
}
else
{
$server->setObject($provider);
}
}
else
{
if (is_array($this->generatorConfig) && isset($this->generatorConfig['bindingStyle'])
&& $this->generatorConfig['bindingStyle']==='document')
{
$server->setClass('CDocumentSoapObjectWrapper',$provider);
}
else
{
$server->setClass('CSoapObjectWrapper',$provider);
}
}
if($provider instanceof IWebServiceProvider)
{
if($provider->beforeWebMethod($this))
{
$server->handle();
$provider->afterWebMethod($this);
}
}
else
$server->handle();
}
catch(Exception $e)
{
if($e->getCode()!==self::SOAP_ERROR) // non-PHP error
{
// only log for non-PHP-error case because application's error handler already logs it
// php <5.2 doesn't support string conversion auto-magically
Yii::log($e->__toString(),CLogger::LEVEL_ERROR,'application');
}
$message=$e->getMessage();
if(YII_DEBUG)
$message.=' ('.$e->getFile().':'.$e->getLine().")\n".$e->getTraceAsString();
// We need to end application explicitly because of
// http://bugs.php.net/bug.php?id=49513
Yii::app()->onEndRequest(new CEvent($this));
$server->fault(get_class($e),$message);
exit(1);
}
}
/**
* @return string the currently requested method name. Empty if no method is being requested.
*/
public function getMethodName()
{
if($this->_method===null)
{
// before PHP 5.6 php://input could be read only once
// since PHP 5.6 $HTTP_RAW_POST_DATA is deprecated
if(version_compare(PHP_VERSION, '5.6.0', '<') && isset($HTTP_RAW_POST_DATA))
$request=$HTTP_RAW_POST_DATA;
else
$request=file_get_contents('php://input');
if(preg_match('/<.*?:Body[^>]*>\s*<.*?:(\w+)/mi',$request,$matches))
$this->_method=$matches[1];
else
$this->_method='';
}
return $this->_method;
}
/**
* @return array options for creating SoapServer instance
* @see http://www.php.net/manual/en/soapserver.soapserver.php
*/
protected function getOptions()
{
$options=array();
if($this->soapVersion==='1.1')
$options['soap_version']=SOAP_1_1;
elseif($this->soapVersion==='1.2')
$options['soap_version']=SOAP_1_2;
if($this->actor!==null)
$options['actor']=$this->actor;
$options['encoding']=$this->encoding;
foreach($this->classMap as $type=>$className)
{
$className=Yii::import($className,true);
if(is_int($type))
$type=$className;
$options['classmap'][$type]=$className;
}
return $options;
}
}
/**
* CSoapObjectWrapper is a wrapper class internally used when SoapServer::setObject() is not defined.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package system.web.services
*/
class CSoapObjectWrapper
{
/**
* @var object the service provider
*/
public $object=null;
/**
* Constructor.
* @param object $object the service provider
*/
public function __construct($object)
{
$this->object=$object;
}
/**
* PHP __call magic method.
* This method calls the service provider to execute the actual logic.
* @param string $name method name
* @param array $arguments method arguments
* @return mixed method return value
*/
public function __call($name,$arguments)
{
return call_user_func_array(array($this->object,$name),$arguments);
}
}
/**
* CDocumentSoapObjectWrapper is a wrapper class internally used
* when generatorConfig contains bindingStyle key set to document value.
*
* @author Jan Was <jwas@nets.com.pl>
* @package system.web.services
*/
class CDocumentSoapObjectWrapper
{
/**
* @var object the service provider
*/
public $object=null;
/**
* Constructor.
* @param object $object the service provider
*/
public function __construct($object)
{
$this->object=$object;
}
/**
* PHP __call magic method.
* This method calls the service provider to execute the actual logic.
* @param string $name method name
* @param array $arguments method arguments
* @return mixed method return value
*/
public function __call($name,$arguments)
{
if (is_array($arguments) && isset($arguments[0]))
{
$result = call_user_func_array(array($this->object, $name), (array)$arguments[0]);
}
else
{
$result = call_user_func_array(array($this->object, $name), $arguments);
}
return $result === null ? $result : array($name . 'Result' => $result);
}
}