Test Setup Failed
Push — master ( e0b94e...572c87 )
by Php Easy Api
04:39
created

ErrorProvider::handle()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 20
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 4
nc 1
nop 0
dl 0
loc 20
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace Resta\Exception;
4
5
use Resta\Support\Str;
6
use Resta\Support\Dependencies;
7
use Resta\Support\ClosureDispatcher;
8
use Resta\Foundation\ApplicationProvider;
9
use Resta\Foundation\PathManager\StaticPathModel;
10
11
class ErrorProvider extends ApplicationProvider
12
{
13
    /**
14
     * @var null|string
15
     */
16
    protected $lang;
17
18
    /**
19
     * @var null|object
20
     */
21
    protected $exception;
22
23
    /**
24
     * @var array
25
     */
26
    protected $data = array();
27
28
    /**
29
     * @var array
30
     */
31
    protected $result = [];
32
33
    /**
34
     * get status according to exception trace
35
     *
36
     * @return void
37
     */
38
    private function getStatusAccordingToExceptionTrace()
39
    {
40
        if($this->app->has('exceptiontrace')) {
41
            $this->data['status'] = (int)$this->app['exceptiontrace']['callNamespace']->getCode();
42
        }
43
        else {
44
            $this->data['status'] = (int)$this->exception::exceptionTypeCodes($this->data['errType']);
0 ignored issues
show
Bug introduced by
The method exceptionTypeCodes() does not exist on null. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

44
            $this->data['status'] = (int)$this->exception::/** @scrutinizer ignore-call */ exceptionTypeCodes($this->data['errType']);

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
45
        }
46
    }
47
48
    /**
49
     * @return void|mixed
50
     */
51
    private function getStatusFromContext()
52
    {
53
        $this->getStatusAccordingToExceptionTrace();
54
55
        $this->app->terminate('responseSuccess');
56
        $this->app->terminate('responseStatus');
57
        $this->app->register('responseSuccess',(bool)false);
58
        $this->app->register('responseStatus',$this->data['status']);
59
60
61
        $optionalException = str_replace("\\","\\\\",$this->app->namespace()->exception());
62
63
        if(preg_match('@'.$optionalException.'@is',$this->data['errType'])){
64
65
            //trace pattern
66
            $trace = $this->data['errContext']['trace'];
67
            if(preg_match('@Stack trace:\n#0(.*)\n#1@is',$trace,$traceArray)){
68
69
                $traceFile = str_replace(root,'',$traceArray[1]);
70
71
                if(preg_match('@(.*)\((\d+)\)@is',$traceFile,$traceResolve)){
72
                    $this->data['errFile'] = $traceResolve[1];
73
                    $this->data['errLine'] = (int)$traceResolve[2];
74
                }
75
            }
76
77
78
            $this->data['errType'] = class_basename($this->data['errType']);
79
        }
80
81
        if(is_array($meta = config('response.meta'))){
82
83
            //set as the success object is false
84
            $this->data['appExceptionSuccess'] = [];
85
        }
86
        else{
87
88
            //set as the success object is false
89
            $this->data['appExceptionSuccess'] = ['success'=>(bool)false,'status'=>$this->data['status']];
90
        }
91
    }
92
93
    /**
94
     * error provider handle
95
     *
96
     * @return void
97
     */
98
    public function handle()
99
    {
100
        //sets which php errors are reported
101
        error_reporting(0);
102
103
        // in general we will use the exception class
104
        // in the store/config directory to make it possible
105
        // to change the user-based exceptions.
106
        $this->exception = StaticPathModel::$store.'\Config\Exception';
0 ignored issues
show
Documentation Bug introduced by
It seems like Resta\Foundation\PathMan...e . '\Config\Exception' of type string is incompatible with the declared type null|object of property $exception.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
107
108
        //This function can be used for defining your own way of handling errors during runtime,
109
        //for example in applications in which you need to do cleanup of data/files when a critical error happens,
110
        //or when you need to trigger an error under certain conditions (using trigger_error()).
111
        set_error_handler([$this,'setErrorHandler']);
112
113
        //Registers a callback to be executed after script execution finishes or exit() is called.
114
        //Multiple calls to register_shutdown_function() can be made, and each will be called in the same order as
115
        //they were registered. If you call exit() within one registered shutdown function,
116
        //processing will stop completely and no other registered shutdown functions will be called.
117
        register_shutdown_function([$this,'fatalErrorShutdownHandler']);
118
119
    }
120
121
    /**
122
     * set error handler
123
     *
124
     * @param null|string $errNo
125
     * @param null|string $errStr
126
     * @param null|string $errFile
127
     * @param null|string $errLine
128
     * @param null|string $errContext
129
     */
130
    public function setErrorHandler($errNo=null, $errStr=null, $errFile=null, $errLine=null, $errContext=null)
131
    {
132
        // in case of a deficiency,
133
        // we need to boot our general needs to be needed for the exception.
134
        Dependencies::loadBootstrapperNeedsForException();
135
136
        // in general we will use the exception class
137
        // in the store/config directory to make it possible
138
        // to change the user-based exceptions.
139
        $this->data['exception']            = $this->exception;
140
        $this->data['errType']              = 'Undefined';
141
        $this->data['errStrReal']           = $errStr;
142
        $this->data['errorClassNamespace']  = null;
143
        $this->data['errFile']              = $errFile;
144
        $this->data['errLine']              = $errLine;
145
        $this->data['errNo']                = $errNo;
146
147
        // catch exception via preg match
148
        // and then clear the Uncaught statement from inside.
149
        $this->getUncaughtProcess();
150
151
        //get status from context
152
        $this->getStatusFromContext();
153
154
        //get lang message for exception
155
        $this->getLangMessageForException();
156
157
        if($this->app->has('exceptiontrace')){
158
159
            $customExceptionTrace   = $this->app['exceptiontrace'];
160
            $this->data['errFile']  = $customExceptionTrace['file'];
161
            $this->data['errLine']  = $customExceptionTrace['line'];
162
        }
163
164
        $environment = $this->app->environment();
165
166
        $vendorDirectory = str_replace(root.''.DIRECTORY_SEPARATOR.'','',$this->data['errFile']);
167
168
        if(preg_match('@vendor.*\.php@is',$vendorDirectory,$vd)){
169
            $vendorDirectory = $vd[0];
170
        }
171
172
        if(Str::startsWith($vendorDirectory,'vendor')
173
            && Str::startsWith($vendorDirectory,'vendor/php-resta')===false)
174
        {
175
176
            $externalMessage = ($environment==="production") ?
177
                'An unexpected external error has occurred' :
178
                $this->data['errStrReal'];
179
180
            $this->result = $this->getAppException($environment,$externalMessage);
181
182
183
            //Get or Set the HTTP response code
184
            http_response_code(500);
185
            $this->app->terminate('responseStatus');
186
            $this->app->register('responseStatus',500);
187
188
189
        }
190
        else{
191
192
            if($environment=='production' && preg_match('@SQLSTATE@is',$this->data['errStrReal'])){
193
                $externalMessage = 'An unexpected external error has occurred';
194
            }
195
            else{
196
                $externalMessage = $this->data['errStrReal'];
197
            }
198
199
            $this->result = $this->getAppException($environment,$externalMessage);
200
201
            //Get or Set the HTTP response code
202
            http_response_code($this->data['status']);
203
        }
204
205
        // exception extender The exception information
206
        // that is presented as an extra to the exception result set.
207
        $this->result = $this->getExceptionExtender();
208
209
        if($environment==="production"){
210
211
            $productionLogMessage = $this->getAppException('local',$this->data['errStrReal']);
212
            $this->app->register('productionLogMessage',$this->app->get('out')->outputFormatter($productionLogMessage));
213
        }
214
215
        //set json app exception
216
        $this->app->register('routerResult',$this->result);
217
218
        if($this->app->has('exceptionContainer')){
219
            $exceptionContainer = $this->app->get('exceptionContainer');
220
            $this->result = $exceptionContainer($this->result,$this->data['status']);
221
        }
222
223
        $restaOutHandle = null;
224
225
        if(!defined('responseApp')){
226
            $restaOutHandle = $this->app->get('out')->handle();
227
        }
228
229
        header("HTTP/1.1 ".$this->data['status']);
230
231
        if($restaOutHandle===null){
232
233
            //header set and symfony response call
234
            header('Content-type:application/json;charset=utf-8');
235
236
            echo json_encode($this->app->get('out')->outputFormatter($this->result));
237
        }
238
        else{
239
            echo $restaOutHandle;
240
        }
241
242
        exit();
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
243
    }
244
245
    /**
246
     * @param $environment
247
     * @return mixed
248
     */
249
    private function getAppException($environment,$message)
250
    {
251
        return $this->data['appExceptionSuccess']+$this->data['exception']::$environment(
252
                $this->data['errNo'],
253
                $message,
254
                $this->data['errFile'],
255
                $this->data['errLine'],
256
                $this->data['errType'],
257
                $this->data['lang']
258
            );
259
    }
260
261
    /**
262
     * get exception extender object
263
     *
264
     * @return mixed
265
     */
266
    private function getExceptionExtender()
267
    {
268
        return  $this->app->resolve(
269
            $this->app->get('macro')->call('exceptionExtender',function(){
270
                return ExceptionExtender::class;
271
            }),
272
            ['result'=>$this->result])->getResult();
273
    }
274
275
    /**
276
     * fatal error shutdown handler
277
     *
278
     * @return mixed
279
     */
280
    public function fatalErrorShutdownHandler()
281
    {
282
        //get fatal error
283
        $last_error = error_get_last();
284
285
        $this->inStackTrace($last_error);
286
287
        if(!is_null($last_error)){
0 ignored issues
show
introduced by
The condition is_null($last_error) is always false.
Loading history...
288
289
            if(!defined('methodName')){
290
                define('methodName',null);
291
            }
292
293
            if($this->app->has('exceptionFile')){
294
                $last_error['file'] = $this->app['exceptionFile'];
295
                $last_error['line'] = $this->app['exceptionLine'];
296
            }
297
298
            $this->setErrorHandler(
299
                E_ERROR,
300
                $last_error['message'],
301
                $last_error['file'],
302
                $last_error['line'],
303
                []
0 ignored issues
show
Bug introduced by
array() of type array is incompatible with the type null|string expected by parameter $errContext of Resta\Exception\ErrorProvider::setErrorHandler(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

303
                /** @scrutinizer ignore-type */ []
Loading history...
304
            );
305
        }
306
    }
307
308
    /**
309
     * @param $error
310
     */
311
    public function inStackTrace($error)
312
    {
313
        if($this->app->has('urlComponent')){
314
            if(!preg_match('@'.$this->app['urlComponent']['project'].'@',$error['file'])
315
                && !$this->app->has('exceptionFile')){
316
                if(preg_match('@ in\s(.*?)\n@is',$error['message'],$result)){
317
                    $errorMessage = explode(":",$result[1]);
318
                    $this->app->register('exceptionFile',$errorMessage[0]);
319
                    $this->app->register('exceptionLine',$errorMessage[1]);
320
                }
321
            }
322
        }
323
    }
324
325
    /**
326
     * @return void|mixed
327
     */
328
    private function getLangMessageForException()
329
    {
330
        $clone = clone $this;
331
332
        if($this->app->has('exceptionTranslate')){
333
334
            $langMessage = trans('exception.'.$this->app->get('exceptionTranslate'));
335
336
            if(!is_null($langMessage) && $this->app->has('exceptionTranslateParams')){
337
338
                if(count($this->app['exceptionTranslateParams'][$this->app['exceptionTranslate']])){
339
                    foreach ($this->app['exceptionTranslateParams'][$this->app['exceptionTranslate']] as $key=>$value){
340
341
                        $valueLangName = !is_null(trans('default.'.$value)) ? trans('default.'.$value) : $value;
342
                        $langMessage = preg_replace('@\('.$key.'\)@is',$valueLangName,$langMessage);
343
                    }
344
                }
345
            }
346
347
            if($langMessage!==null){
348
                $this->data['errStrReal'] = $langMessage;
349
            }
350
        }
351
352
        if(class_exists($this->data['errorClassNamespace'])
353
            &&
354
            (Str::startsWith($this->data['errorClassNamespace'],'App')
355
                || Str::startsWith($this->data['errorClassNamespace'],__NAMESPACE__))){
356
357
            ClosureDispatcher::bind($this->data['errorClassNamespace'])->call(function() use ($clone) {
358
                if(property_exists($this,'lang')){
359
                    $clone->setLang($this->lang);
360
                }
361
            });
362
        }
363
364
        $this->data['lang'] = $clone->lang;
365
366
        $langMessage = (!is_null($this->data['lang'])) ? trans('exception.'.$this->data['lang']) : null;
367
368
        if($langMessage!==null){
369
            $this->data['errStrReal'] = $langMessage;
370
        }
371
    }
372
373
    /**
374
     * get uncaught process
375
     *
376
     * @return void|mixed
377
     */
378
    private function getUncaughtProcess()
379
    {
380
        // catch exception via preg match
381
        // and then clear the Uncaught statement from inside.
382
        if(preg_match('@(.*?):@is',$this->data['errStrReal'],$errArr)){
383
384
            $this->data['errType'] = trim(str_replace('Uncaught','',$errArr[1]));
385
            $this->data['errorClassNamespace'] = $this->data['errType'];
386
        }
387
388
        if(preg_match('@Uncaught@is',$this->data['errStrReal'])
389
            && preg_match('@(.*?):(.*?)\sin\s@is',$this->data['errStrReal'],$errStrRealArray)){
390
            $this->data['errStrReal'] = trim($errStrRealArray[2]);
391
        }
392
393
        $this->data['errContext']['trace'] = $this->data['errStrReal'];
394
    }
395
396
    /**
397
     * get result for exception
398
     *
399
     * @return array
400
     */
401
    public function getResult()
402
    {
403
        return $this->result;
404
    }
405
406
    /**
407
     * @param null|string $lang
408
     */
409
    public function setLang($lang=null)
410
    {
411
        $this->lang = $lang;
412
    }
413
414
}