Completed
Pull Request — master (#117)
by Robbert
08:59
created

ariadne_object::findTemplateOnPath()   C

Complexity

Conditions 18
Paths 15

Size

Total Lines 51
Code Lines 36

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 32
CRAP Score 20.592

Importance

Changes 5
Bugs 2 Features 0
Metric Value
cc 18
eloc 36
nc 15
nop 5
dl 0
loc 51
rs 5.5967
c 5
b 2
f 0
ccs 32
cts 40
cp 0.8
crap 20.592

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 38 and the first side effect is on line 36.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
    /******************************************************************
3
     pobject.phtml                                         Muze Ariadne
4
     ------------------------------------------------------------------
5
     Author: Muze ([email protected])
6
     Date: 31 october 2002
7
8
     Copyright 2002 Muze
9
10
     This file is part of Ariadne.
11
12
     Ariadne is free software; you can redistribute it and/or modify
13
     it under the terms of the GNU General Public License as published
14
     by the Free Software Foundation; either version 2 of the License,
15
     or (at your option) any later version.
16
17
     Ariadne is distributed in the hope that it will be useful,
18
     but WITHOUT ANY WARRANTY; without even the implied warranty of
19
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20
     GNU General Public License for more details.
21
22
     You should have received a copy of the GNU General Public License
23
     along with Ariadne; if not, write to the Free Software
24
     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
25
     02111-1307  USA
26
27
    -------------------------------------------------------------------
28
29
     Class inheritance: 	pobject
30
     Description:
31
32
       This is the class definition file of the pobject class.
33
34
    ******************************************************************/
35
36
debug("pobject: Load","object");
37
38
abstract class ariadne_object extends object { // ariadne_object class definition
39
40
	public $store;
41
	public $path;
42
	public $data;
43
44 184
	public function init($store, $path, $data) {
45 184
		$this->store=$store;
46 184
		$this->path=$path;
47 184
		$this->data=$data;
48 184
		if ( !isset($this->data->config) ) {
49 28
			$this->data->config = new object();
50 14
		}
51 184
	}
52
53 184
	public function call($arCallFunction="view.html", $arCallArgs=array()) {
54
	/***********************************************************************
55
	  call tries to find the template ($arCallFunction) for the current
56
	  object. If it is not defined there, call will search the superclasses
57
	  until either it or the template 'default.phtml' is found.
58
59
	  $arCallFunction must be the name of a class or object template.
60
	    it can be prepended with "{classname}::". classname must be either
61
	    a valid ariadne class (derived from pobject). call()
62
	    will then try to find the template starting at the given classname.
63
		e.g.:
64
		call("pobject::view.html") will show the view.html template of
65
	      pobject, with the data of the current object.
66
67
	  variables available to templates:
68
	  local: arCallFunction, arCallArgs, arCallTemplate, data
69
	  global: AR, ARConfig, ARCurrent, ARBeenHere, ARnls
70
	***********************************************************************/
71 184
	global $AR, $ARConfig, $ARCurrent, $ARBeenHere, $ARnls;
72
73 184
		if ( $arCallFunction instanceof \Closure ) {
74 4
			$arCallFunctionName = 'Closure';
75 6
		} else {
76 184
			$arCallFunctionName = (string) $arCallFunction;
77
		}
78 184
		debug("pobject: ".$this->path.": call($arCallFunctionName, ".debug_serialize($arCallArgs).")","object","all","IN");
79
80
		// default to view.html
81 184
		if (!$arCallFunction) {
82 10
			$arCallFunction="view.html";
83
		}
84
		// clear previous results
85 184
		unset($ARCurrent->arResult);
86
87
		// callstack is needed for getvar()
88 184
		$ARCurrent->arCallStack[]=&$arCallArgs;
89
		// keep track of the context (php or pinp) in which the called template runs. call always sets it php, CheckConfig sets it to pinp if necessary.
90 184
		$this->pushContext( array(
91 184
			"arSuperContext" => array(),
92 184
			"arCurrentObject" => $this,
93 184
			"scope" => "php",
94 92
			"arCallFunction" => $arCallFunction
95 92
		) );
96
97
		// convert the deprecated urlencoded arguments to an array
98 184
		if (isset($arCallArgs) && is_string($arCallArgs)) {
99 184
			$ARCurrent->arTemp=$arCallArgs;
100 184
			$arCallArgs=array();
101 184
			parse_str($ARCurrent->arTemp, $arCallArgs);
102 92
		}
103
		// import the arguments in the current scope, but don't overwrite existing
104
		// variables.
105 184
		if (isset($arCallArgs) && is_array($arCallArgs)) {
106 184
			extract($arCallArgs,EXTR_SKIP);
107 92
		}
108
		// now find the initial nls selection (CheckConfig is needed for per
109
		// tree selected defaults)
110 184
		if ($ARCurrent->nls) {
111
			$this->reqnls=$ARCurrent->nls;
0 ignored issues
show
Bug introduced by
The property reqnls does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
112 184
		} else if (isset($ARConfig->cache[$this->path]) && $ARConfig->cache[$this->path]->nls->default) {
113 100
			$this->reqnls = $ARConfig->cache[$this->path]->nls->default;
114 50
		} else {
115 184
			$this->reqnls=$AR->nls->default;
116
		}
117 184
		if (isset($this->data->nls->list[$this->reqnls]) || !isset($this->data->nls)) {
118
			// the requested language is available
119 184
			$this->nls=$this->reqnls;
0 ignored issues
show
Bug introduced by
The property nls does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
120 184
			$nls=&$this->nls;
121 92
		} else {
122
			// the requested language is not available, use default of the
123
			// current object instead.
124
			$this->nls=$this->data->nls->default;
125 2
			$nls=&$this->nls;
126
		}
127 184
		if ($nls && isset($this->data->$nls)) {
128
			// now set the data and nlsdata pointers
129 132
			$this->nlsdata=$this->data->$nls;
0 ignored issues
show
Bug introduced by
The property nlsdata does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
130 132
			$nlsdata=&$this->nlsdata;
131 132
			$data=&$this->data;
132 66
		} else {
133
			// this object doesn't support nls data
134 184
			$this->nlsdata=$this->data;
135 184
			$nlsdata=&$this->data;
136 184
			$data=&$this->data;
137 2
		}
138 184
		if (isset($this->data->custom['none'])) {
139 6
			$customdata=$this->data->custom['none'];
140 4
		}
141 184
		if (isset($this->data->custom[$nls])) {
142
			$customnlsdata=$this->data->custom[$nls];
143
		}
144
145 184
		$arCallFunctionOrig = $arCallFunction;
146 184
		if (strpos($arCallFunctionName,"::")!==false) {
147
			// template of a specific class defined via call("class::template");
148 24
			list($arType, $arCallFunction)=explode("::",$arCallFunctionName);
149 24
			$temp = explode(":", $arType );
150 24
			if( count($temp) > 1 ) {
151
				$libname = $temp[0];
152
				$arType = $temp[1];
153 12
				$arCallFunction = $libname.":".$arCallFunction;
154
			}
155 12
		} else {
156 184
			$arType=$this->type;
0 ignored issues
show
Bug introduced by
The property type does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
157
		}
158
159 184
		if ( $arCallFunction instanceof \Closure ) {
160 4
			$context = $this->getContext(ARCALLINGCONTEXT);
161 4
			if ( $context["scope"] != "pinp" ) {
162
				$arResult = $arCallFunction($this );
163
			} else {
164 4
				if ( $this->CheckSilent('read') ) {
165 4
					$arResult = $arCallFunction($this);
166 2
				}
167
			}
168 2
		} else {
169 184
			if ($arCallFunction[0] === "#") {
170 10
				$ARCurrent->arCallClassTemplate = true;
171
				$arCallFunction = substr($arCallFunction, 1);
172
			} else {
173 184
				$ARCurrent->arCallClassTemplate = false;
174
			}
175
176 184
			if( $arCallFunction == "system.get.phtml" && ( $context = $this->getContext(ARCALLINGCONTEXT) ) && $context["scope"] != "pinp" ) {
177 34
				$arResult = $this;
178 16
			} else {
179 184
				$libtemplate = strpos($arCallFunction,":");
180 184
				$codedir = $this->store->get_config("code");
181
182
				// if it is a subtype object, disk templates do not exists,
183 184
				$subcpos = strpos($arType, '.');
184 184
				if ($subcpos !== false ) {
185
					// subtype, skip looking for templates
186 24
					$arSuper = substr($arType, 0, $subcpos);
187 24
					if(!isset($AR->superClass[$arType])){
188 4
						$AR->superClass[$arType]=$arSuper;
189 2
					}
190 24
					$arType=$arSuper;
191 12
				}
192
193 184
				while ($arType !== "ariadne_object") {
194
195
					// search for the template, stop at the root class ('ariadne_object')
196
					// (this should not happen, as pobject must have a 'default.phtml')
197 184
					$arCallTemplate=$codedir."templates/".$arType."/".$arCallFunction;
198 184
					if ($libtemplate === false && file_exists($arCallTemplate)) {
199
						//debug('found '.$arCallTemplate, 'all');
0 ignored issues
show
Unused Code Comprehensibility introduced by
70% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
200
						// template found
201 184
						$arCallFunction = $arCallFunctionOrig;
202 184
						include($arCallTemplate);
203 184
						break;
204 184
					} else if (file_exists($codedir."templates/".$arType."/default.phtml")) {
205
						//debug('found default.phtml', 'all');
0 ignored issues
show
Unused Code Comprehensibility introduced by
75% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
206
						// template not found, but we did find a 'default.phtml'
207 8
						include($this->store->get_config("code")."templates/".$arType."/default.phtml");
208 10
						break;
209 12
					} else {
210 184
						if (!($arSuper=$AR->superClass[$arType])) {
211
							// no template found, no default.phtml found, try superclass.
212
213 8
							if (!class_exists($arType, false)) {
214
								// the given class was not yet loaded, so do that now
215
								$this->store->newobject('','',$arType,new object);
216
							}
217 10
							$arSuper=get_parent_class($arType);
218
219 20
							$AR->superClass[$arType]=$arSuper;
220 4
						}
221 184
						$arType=$arSuper;
222 2
					}
223 92
				}
224
			}
225 2
		}
226 184
		array_pop($ARCurrent->arCallStack);
227 184
		$this->popContext();
228 184
		debug("pobject: call: end","all","all","OUT");
229 184
		if (isset($ARCurrent->arResult)) {
230
			// pinp templates can return results via putvar("arResult",$result);
231 20
			$arResult=$ARCurrent->arResult;
232 20
			unset($ARCurrent->arResult);
233 10
		}
234 184
		if (isset($arResult)) {
235
			// only do a return if we really have something to return
236 184
			return $arResult;
237
		}
238 24
	}
239
240 2
	public function ls($path="", $function="list.html", $args="") {
241 2
		$path=$this->store->make_path($this->path, $path);
242 2
		return $this->store->call($function, $args, $this->store->ls($path));
243 2
	}
244
245 56
	public function get($path, $function="view.html", $args="") {
246 56
		$path=$this->store->make_path($this->path, $path);
247 56
		return $this->store->call($function, $args, $this->store->get($path));
248 2
	}
249
250 6
	public function parents($path, $function="list.html", $args="", $top="") {
251
		/* FIXME: $this->store->parents is too slow when a lot of objects are in ariadne (2million+) */
0 ignored issues
show
Coding Style introduced by
Comment refers to a FIXME task "$this->store->parents is too slow when a lot of objects are in ariadne (2million+) */"
Loading history...
252
		/* but this fix should be done in the store, not here */
253 4
		if (!$top) {
254 6
			$top = $this->currentsection();
255 2
		} else {
256 6
			$top = $this->store->make_path($this->path, $top);
257
		}
258
259 4
		$path=$this->store->make_path($this->path, $path);
260
261 4
		if ($path != $this->path ) {
262 4
			$target = current($this->get($path,"system.get.phtml"));
263 2
		} else {
264 4
			$target = $this;
265
		}
266
267 4
		$parents = array();
268 4
		if (strpos($target->path, $top) === 0) {
269 4
			$parents[] = $target;
270 4
			while ($target && $target->path != $top) {
271 4
				$target = current($target->get($target->parent, "system.get.phtml"));
272 4
				$parents[] = $target;
273 4
			}
274 2
		}
275 4
		$parents = array_reverse($parents);
276 4
		$result = array();
277 6
		foreach ($parents as $parent) {
278 4
			if ( $parent ) { // might not have read access to this object
279 4
				$result[] = $parent->call($function, $args);
280 2
			}
281 2
		}
282
283 4
		return $result;
284
	}
285
286 4
	public function find($path, $criteria, $function="list.html", $args="", $limit=100, $offset=0) {
287 4
		$path = $this->store->make_path($this->path, $path);
288 4
		$objects = $this->store->find($path, $criteria, $limit, $offset);
289 4
		if (!$this->store->error) {
290 4
			$result = $this->store->call($function, $args, $objects);
291 2 View Code Duplication
		} else {
292
			$this->error = ar::error( ''.$this->store->error, 1110, $this->store->error );
0 ignored issues
show
Bug introduced by
The property error does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
293
			$result = false;
294 2
		}
295 4
		return $result;
296
	}
297
298
	public function count_find($path='', $query='') {
299
		$path=$this->store->make_path($this->path, $path);
300
		if (method_exists($this->store, 'count_find')) {
301
			$result = $this->store->count_find($path, $query, 0);
302
		} else {
303
			$result = $this->store->count($this->store->find($path, $query, 0));
304
		}
305
		return $result;
306
	}
307
308
	public function count_ls($path) {
309
		return $this->store->count($this->store->ls($path));
310
	}
311
312 2
	private function saveMergeWorkflowResult($properties, $wf_result) {
313
		foreach ($wf_result as $wf_prop_name => $wf_prop) {
314
			foreach ($wf_prop as $wf_prop_index => $wf_prop_record) {
315
				if (!isset($wf_prop_record)) {
316
					unset($properties[$wf_prop_name][$wf_prop_index]);
317
				} else {
318
					$record = array();
319 View Code Duplication
					foreach ($wf_prop_record as $wf_prop_field => $wf_prop_value) {
320
						switch (gettype($wf_prop_value)) {
321 2
							case "integer":
322
							case "boolean":
323
							case "double":
324
								$value = $wf_prop_value;
325
								break;
326
							default:
327
								$value = $wf_prop_value;
328
								// backwards compatibility, store will do the escaping from now on
329
								// will be removed in the future
330
								if (substr($wf_prop_value, 0, 1) === "'" && substr($wf_prop_value, -1) === "'"
331
										&& "'".AddSlashes(StripSlashes(substr($wf_prop_value, 1, -1)))."'" == $wf_prop_value) {
332
									$value = stripSlashes(substr($wf_prop_value,1,-1));
333
									// todo add deprecated warning
334
								}
335
336 2
						}
337
						$record[$wf_prop_field] = $value;
338
					}
339
					$properties[$wf_prop_name][] = $record;
340
				}
341
			}
342
		}
343
344
		return $properties;
345
	}
346
347
	/*
348
		saves custom data
349
		returns properties for custom data
350
	*/
351 49
	private function saveCustomData($configcache, $properties) {
352 49
		$custom = $this->getdata("custom", "none");
353 48
		@parse_str($custom);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
354 48
		if (isset($custom) && is_array($custom)) {
355
			foreach($custom as $nls=>$entries){
356
				if (isset($entries) && is_array($entries)) {
357
					foreach ( $entries as $customkey => $customval ){
358
						$this->data->custom[$nls][$customkey] = $customval;
359
					}
360
				}
361
			}
362
		}
363
		// the above works because either $custom comes from the form entry, and parse_str returns an
364
		// array with the name $custom, or $custom comes from the object and is an array and as such
365
		// parse_str fails miserably thus keeping the array $custom intact.
366
367 48
		if (isset($this->data->custom) && is_array($this->data->custom)) {
368
			foreach($this->data->custom as $nls => $cdata) {
369
				foreach($cdata as $name => $value){
370
					// one index, this order (name, value, nls) ?
371
					if ($configcache->custom[$name]['containsHTML']) {
372
						$this->_load('mod_url.php');
373
						$value = URL::RAWtoAR($value, $nls);
374
						$this->data->custom[$nls][$name] = $value;
375
					}
376
					if ($configcache->custom[$name]['property']) {
377
						if (isset($value) && is_array($value)) {
378
							foreach($value as $valkey => $valvalue ) {
379
								$properties["custom"][] = [
380
									"name"  => $name,
381
									"value" => $valvalue,
382
									"nls"   => $nls,
383
								];
384
							}
385
						} else {
386
							$properties["custom"][] = [
387
								"name"  => $name,
388
								"value" => $value,
389
								"nls"   => $nls,
390
							];
391
392
						}
393
					}
394
				}
395
			}
396
		}
397 48
		return $properties;
398
	}
399
400 49
	public function save($properties="", $vtype="") {
401
	/***********************************************************************
402
	  save the current object.
403
	  if this is a new object ($this->arIsNewObject) the path is checked and
404
	  the object is saved under the new path.
405
	***********************************************************************/
406 48
	global $AR, $ARnls, $ARCurrent;
407 48
		debug("pobject: save([properties], $vtype)","object");
408 48
		debug("pobject: save: path=".$this->path,"object");
409 48
		$configcache=$this->loadConfig();
410 49
		$needsUnlock = false;
411 48
		$arIsNewObject = false;
412 48
		$result = false;
413 48
		$this->error = '';
414 48
		if ($this->arIsNewObject) { // save a new object
0 ignored issues
show
Bug introduced by
The property arIsNewObject does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
415 24
			debug("pobject: save: new object","all");
416 24
			$this->path = $this->make_path();
417 24
			$arNewParent=$this->make_path("..");
418 24
			$arNewFilename=basename($this->path);
419 24
			$arIsNewObject = true;
420 24
			if (preg_match("|^[a-z0-9_\{\}\.\:-]+$|i",$arNewFilename)) { // no "/" allowed, these will void the 'add' grant check.
421 24
				if (!$this->exists($this->path)) { //arNewFilename)) {
422 24
					if ($this->exists($arNewParent)) {
423 24
						if (!$config = $this->data->config) {
424 12
							$config=new object();
425
						}
426 12
					} else {
427 12
						$this->error = ar::error( sprintf($ARnls["err:noparent"],$arNewParent), 1102);
428
					}
429 12
				} else {
430 12
					$this->error = ar::error( sprintf($ARnls["err:alreadyexists"],$arNewFilename), 1103);
431
				}
432 12
			} else {
433 12
				$this->error = ar::error( sprintf($ARnls["err:fileillegalchars"],$arNewFilename), 1104);
434
			}
435 12
		} else { // existing object
436 48
			debug("pobject: save: existing object","all");
437 48
			if ($this->exists($this->path)) { // prevent 'funny stuff'
438 48
				if (!$this->lock()) {
439
					$this->error = ar::error( $ARnls["err:objectalreadylocked"], 1105);
440
				} else {
441 48
					$needsUnlock = true;
442 48
					$config = $this->data->config;
443
				}
444 24
			} else {
445
				$this->error = ar::error($ARnls["err:corruptpathnosave"], 1106);
446
			}
447
		}
448
		// pre checks done
449
		// return now on error
450 48
		if ($this->error) {
451
			return $result;;
452
		}
453
454
455 48
		if ($ARCurrent->arCallStack) {
456 48
			$arCallArgs = end($ARCurrent->arCallStack);
457 24
		} else {
458 20
			$arCallArgs = array();
459
		}
460
461 48
		$context = $this->getContext();
462
463 48
		$wf_object = $this->store->newobject($this->path, $this->parent, $this->type, $this->data, $this->id, $this->lastchanged, $this->vtype, 0, $this->priority);
0 ignored issues
show
Bug introduced by
The property parent does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
Bug introduced by
The property id does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
Bug introduced by
The property lastchanged does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
Bug introduced by
The property vtype does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
Bug introduced by
The property priority does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
464 48
		if ( $arIsNewObject) {
465 24
			$wf_object->arIsNewObject=$arIsNewObject;
466 12
		}
467
468
		/* save custom data */
469 48
		$properties = $this->saveCustomData($configcache, $properties);
470
471
		// this makes sure the event handlers are run on $wf_object, so that $this->data changes don't change the data of the object to be saved
472 48
		$this->pushContext(array('scope' => 'php', 'arCurrentObject' => $wf_object));
473
474 48
		$eventData = new object();
475 48
		$eventData->arCallArgs = $arCallArgs;
0 ignored issues
show
Bug introduced by
The property arCallArgs does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
476 48
		$eventData->arCallFunction	= $context['arCallFunction'];
0 ignored issues
show
Bug introduced by
The property arCallFunction does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
477 48
		$eventData->arIsNewObject = $arIsNewObject;
0 ignored issues
show
Bug introduced by
The property arIsNewObject does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
478 48
		$eventData->arProperties = $properties;
0 ignored issues
show
Bug introduced by
The property arProperties does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
479 48
		$eventData = ar_events::fire( 'onbeforesave', $eventData );
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
480
481
		// pop the wf_object, not needed later, the extra scope might hinder other code
482 48
		$this->popContext();
483
484 48
		if ( !$eventData ) {
485
			return false; // prevent saving of the object.
486
		}
487
488
		// arguments can be altered by event handlers, only usefull when a workflow template is also defined
489 48
		$arCallArgs = $eventData->arCallArgs;
490
491
		// the properties from the eventData are the new property list
492
		// no need to merge them with $properties, just manipulate the properties array directly
493
		// in the event data. unlike the user.workflow.pre.html template
494 48
		if (isset( $eventData->arProperties ) && is_array( $eventData->arProperties ) ) {
495 48
			$properties = $eventData->arProperties;
496 24
		} else {
497 44
			$properties = array();
498
		}
499
500
		// pass the current properties list to the workflow template
501
		// for backwards compatibility and workflow templates that just
502
		// returned only their own properties, merge them afterwards
503
		// don't do this for the eventData arProperties!
504 48
		$arCallArgs['properties'] = $properties;
505 48
		$wf_result = $wf_object->call("user.workflow.pre.html", $arCallArgs);
506
		/* merge workflow properties */
507 48
		if (isset($wf_result) && is_array($wf_result) ){
508
			$properties = $this->saveMergeWorkflowResult($properties,$wf_result);
509
		}
510
511 48
		$this->error = $wf_object->error;
512 48
		$this->priority = $wf_object->priority;
513 48
		$this->data = $wf_object->data;
514 48
		$this->data->config = $config;
0 ignored issues
show
Bug introduced by
The variable $config does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
515 48
		$this->data->mtime=time();
516 48
		if($arIsNewObject) {
517 24
			$this->data->ctime=$this->data->mtime;
518 12
		}
519
520 48
		$this->data->muser=$AR->user->data->login;
521 48
		if( !$this->data->config->owner ) {
522 24
			if( !$this->data->config->owner_name) {
523 24
				$this->data->config->owner_name=$AR->user->data->name;
524 12
			}
525 24
			$this->data->config->owner=$AR->user->data->login;
526 24
			$properties["owner"][0]["value"]=$this->data->config->owner;
527 12
		}
528 48
		$properties["time"][0]["ctime"]=$this->data->ctime;
529 48
		$properties["time"][0]["mtime"]=$this->data->mtime;
530 48
		$properties["time"][0]["muser"]=$this->data->muser;
531
532
533 48
		if (!$this->error) {
534 48
			if ($this->path=$this->store->save($this->path, $this->type, $this->data, $properties, $vtype, $this->priority)) {
535 48
				unset($this->arIsNewObject);
536 48
				$this->id=$this->exists($this->path);
537 48
				$result=$this->path;
538
539 48
				$config=$this->data->config; // need to set it again, to copy owner config data
540
541 48
				$wf_object = $this->store->newobject($this->path, $this->parent, $this->type, $this->data, $this->id, $this->lastchanged, $this->vtype, 0, $this->priority);
542 48
				$arCallArgs = $eventData->arCallArgs; // returned from onbeforesave event
543 48
				$arCallArgs['properties'] = $properties;
544
545 48
				if ($arIsNewObject) {
546 24
					$wf_object->arIsNewObject = $arIsNewObject;
547 12
				}
548 48
				$wf_result = $wf_object->call("user.workflow.post.html", $arCallArgs);
549 48
				$this->error = $wf_object->error;
550 48
				$this->priority = $wf_object->priority;
551 48
				$this->data = $wf_object->data;
552 48
				$this->data->config = $config;
553
				/* merge workflow properties */
554
555 48
				if (isset($wf_result) && is_array($wf_result) ){
556
					$properties = $this->saveMergeWorkflowResult($properties,$wf_result);
557
558
					if (!$this->store->save($this->path, $this->type, $this->data, $properties, $this->vtype, $this->priority)) {
559
						$this->error = ar::error( ''.$this->store->error, 1108, $this->store->error);
560
						$result = false;
561
					}
562 1
				}
563
				// all save actions have been done, fire onsave.
564 48
				$this->data->config = $config;
565
566
				//$this->ClearCache($this->path, true, false);
0 ignored issues
show
Unused Code Comprehensibility introduced by
74% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
567 48
				$eventData->arProperties = $properties;
568 48
				$this->pushContext(array('scope' => 'php', 'arCurrentObject' => $this));
569 48
				ar_events::fire( 'onsave', $eventData ); // nothing to prevent here, so ignore return value
570 48
				$this->popContext();
571 24 View Code Duplication
			} else {
572
				$this->error = ar::error( ''.$this->store->error, 1107, $this->store->error);
573
				$result = false;
574
			}
575 24
		}
576 48
		if( $needsUnlock == true ){
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
577 48
			$this->unlock();
578 24
		}
579
580 48
		if ($this->data->nls->list[$this->nls]) {
581 48
			$mynlsdata=$this->data->{$this->nls};
582 24
		} else if ($this->data->nls->default) {
583
			$mynlsdata=$this->data->{$this->data->nls->default};
584
		} else {
585
			$mynlsdata=$this->data;
586
		}
587
588 48
		unset($this->nlsdata);
589 48
		$this->nlsdata=$mynlsdata;
590
591 48
		debug("pobject: save: end","all");
592 48
		return $result;
593
	}
594
595
	public function link($to) {
596
		return $this->store->link($this->path, $this->make_path($to));
597
	}
598
599
	public function delete() {
600
	global $ARCurrent;
601
		$result	= false;
602
		$this->error = '';
603
		if ($ARCurrent->arCallStack) {
604
			$arCallArgs = end($ARCurrent->arCallStack);
605
		} else {
606
			$arCallArgs = array();
607
		}
608
		$context = $this->getContext();
609
610
		$eventData = new object();
611
		$eventData->arCallArgs = $arCallArgs;
0 ignored issues
show
Bug introduced by
The property arCallArgs does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
612
		$eventData->arCallFunction = $context['arCallFunction'];
0 ignored issues
show
Bug introduced by
The property arCallFunction does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
613
		$eventData = ar_events::fire( 'onbeforedelete', $eventData );
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
614
		if ( !$eventData ) {
615
			return false;
616
		}
617
		$this->call("user.workflow.delete.pre.html", $eventData->arCallArgs);
618
		if (!$this->error) {
619
			if ($this->store->delete($this->path)) {
620
				$result = true;
621
				$this->call("user.workflow.delete.post.html", $eventData->arCallArgs);
622
				ar_events::fire( 'ondelete', $eventData );
623
			} else {
624
				$this->error = ar::error( ''.$this->store->error, 1107, $this->store->error);
625
			}
626
		}
627
		return $result;
628
	}
629
630 56
	public function exists($path) {
631 56
		$path=$this->make_path($path);
632 56
		return $this->store->exists($path);
633
	}
634
635 72
	public function make_path($path="") {
636
		switch($path){
637 72
			case '':
638 72
			case '.':
639 68
			case $this->path:
640 72
				return $this->path;
641
				break;
642 60
			case '..':
643 24
				return $this->parent;
644
				break;
645 30
			default:
646 60
				return $this->store->make_path($this->path, $path);
647 30
		}
648
	}
649
650
	public function make_ariadne_url($path="") {
651
		global $AR;
652
		$path = $this->make_path($path);
653
		return $AR->host . $AR->root . $this->store->get_config('rootoptions') . $path;
654
	}
655
656
657 52
	public function make_url($path="", $nls=false, $session=true, $https=null, $keephost=null) {
658 52
		global $ARConfig, $AR, $ARCurrent;
659
660 52
		$rootoptions=$this->store->get_config('rootoptions');
661 52
		if (!$session || ($nls !== false)) {
662 52
			$rootoptions = "";
663 52
			if ($session && isset($ARCurrent->session->id) && !$AR->hideSessionIDfromURL) {
664
				$rootoptions .= "/-".$ARCurrent->session->id."-";
665
			}
666 52
			if ($nls) {
667 48
				$rootoptions_nonls = $rootoptions;
668 48
				$rootoptions .= '/'.$nls;
669 24
			}
670 26
		}
671 52
		$path=$this->make_path($path);
672
673
		// now run CheckConfig and get the parentsite of the path found
674 52
		if (!$temp_config=$ARConfig->cache[$path]) {
675 4
			$temp_path = $path;
676 4
			while (!($temp_site = $this->currentsite($temp_path)) && $temp_path!='/') {
677
				$temp_path = $this->make_path($temp_path.'../');
678
			}
679 4
			$temp_config=$ARConfig->cache[$temp_site];
680 2
		}
681
682 52
		if ( !isset($keephost) && (
683 52
			(!$nls && $this->compare_hosts($AR->host, $temp_config->root["value"])) ||
684 52
			($nls && ($this->compare_hosts($AR->host, $temp_config->root['list']['nls'][$nls])))
685 26
		)) {
686
			$keephost = false;
687
		}
688
689 52
		if (!$keephost) {
690 52
			if ($nls) {
691 48
				$url=$temp_config->root["list"]["nls"][$nls];
692 48
				if (isset($url) && is_array($url)) {
693
					$url = current( $url );
694
				}
695 48
				if ($url) {
696 View Code Duplication
					if (substr($url, -1)=='/') {
697
						$url=substr($url, 0, -1);
698
					}
699
					$url .= $rootoptions_nonls;
0 ignored issues
show
Bug introduced by
The variable $rootoptions_nonls does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
700
				}
701 24
			}
702 52
			if (!$url) {
0 ignored issues
show
Bug introduced by
The variable $url does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
703 52
				$checkNLS = $nls;
704 52
				if (!$checkNLS) {
705 28
					$checkNLS = $this->nls;
706 14
				}
707 52
				$urlList = $temp_config->root['list']['nls'][$checkNLS];
708 52
				if (isset($urlList) && is_array($urlList)) {
709
					$url = reset($urlList) . $rootoptions;
710
				} else {
711 52
					$url = $temp_config->root["value"].$rootoptions;
712
				}
713 26
			}
714 52
			$url.=substr($path, strlen($temp_config->root["path"])-1);
715
716 52
			if (is_bool($https)) {
717
				if ($https) {
718
					if ($AR->https) {
719
						$url = preg_replace('/^http:/', 'https:', $url);
720
					}
721
				} else {
722 26
					$url = preg_replace('/^https:/', 'http:', $url);
723
				}
724
			}
725 26
		} else {
726 48
			$checkNLS = $nls;
727 48
			if (!$checkNLS) {
728
				$checkNLS = $this->nls;
729
			}
730 48
			$urlCheck = $temp_config->root['list']['nls'][$checkNLS];
731 48
			if (!is_array($urlCheck)) {
732 48
				$urlCheck = $temp_config->root["value"];
733 24
			}
734 48
			$requestedHost = ldGetRequestedHost();
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $requestedHost is correct as ldGetRequestedHost() seems to always returns null.
Loading history...
735 48
			if ($this->compare_hosts($requestedHost, $urlCheck)) {
736
				$url = $requestedHost . $rootoptions;
737
				$url .= substr($path, strlen($temp_config->root["path"])-1);
738
			} else {
739
				//$url=$AR->host.$AR->root.$rootoptions.$path;
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
740 48
				$url = $protocol . $requestedHost . $AR->root . $rootoptions . $path;
0 ignored issues
show
Bug introduced by
The variable $protocol does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
741
			}
742
		}
743 52
		return $url;
744
	}
745
746 52
	protected function compare_hosts($url1, $url2) {
747
		// Check if hosts are equal, so that http://www.muze.nl and //www.muze.nl also match.
748
		// using preg_replace instead of parse_url() because the latter doesn't parse '//www.muze.nl' correctly.
749 52
		if (isset($url2) ) {
750 52
			if ( !is_array($url2) ){
751 52
				$url2 = array($url2);
752 26
			}
753 26
		} else {
754 48
			$url2 = array();
755
		}
756
757 52
		$prepurl1 = preg_replace('|^[a-z:]*//|i', '', $url1);
758
759 52
		foreach($url2 as $url) {
760
			if (
761 52
					$url == $url1 ||
762 52
					$prepurl1 == preg_replace('|^[a-z:]*//|i', '', $url2)
763 26
				) {
764 26
				return true;
765
			}
766 26
		}
767 52
		return false;
768
	}
769
770 48
	public function make_local_url($path="", $nls=false, $session=true, $https=null) {
771 48
		global $ARCurrent, $ARConfig;
772 48
		$site = false;
773 48
		$path = $this->make_path($path);
774 48
		$checkpath = $path;
775
776 48
		$redirects = $ARCurrent->shortcut_redirect;
777 48
		if (isset($redirects) && is_array($redirects)) {
778
			$newpath = $checkpath;
779
			$c_redirects = count($redirects);
780
			$c_redirects_done = 0;
781 View Code Duplication
			while (count($redirects) && ($redir = array_pop($redirects)) && $redir['keepurl'] && substr($newpath, 0, strlen($redir['dest'])) == $redir['dest']) {
782
				$c_redirects_done++;
783
				$newpath = $redir['src'].substr($newpath, strlen($redir['dest']));
784
			}
785
786
			if ($c_redirects_done == $c_redirects) {
787
				$checkpath = $redir['src'];
0 ignored issues
show
Bug introduced by
The variable $redir does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
788
			}
789
		}
790
791
		do {
792 48
			if (!$config=$ARConfig->cache[$checkpath]) {
793
				$config=($ARConfig->cache[$checkpath]) ? $ARConfig->cache[$checkpath] : $this->loadConfig($checkpath);
794
			}
795 48
			if ($config) {
796 48
				$checkNLS = $nls;
797 48
				if (!$checkNLS) {
798
					$checkNLS = $this->nls;
799
				}
800 48
				$urlCheck = $config->root['list']['nls'][$checkNLS];
801 48
				if (!is_array($urlCheck)) {
802 48
					$urlCheck = $config->root["value"];
803 24
				}
804 48
				$requestedHost = ldGetRequestedHost();
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $requestedHost is correct as ldGetRequestedHost() seems to always returns null.
Loading history...
805
806 48
				if ($this->compare_hosts($requestedHost, $urlCheck)) {
807
					$site=$config->site;
808
				}
809 24
			}
810 48
			$prevpath=$checkpath;
811 48
			$checkpath=$this->make_path($checkpath."../");
812 48
		} while ($prevpath!=$checkpath && !$site);
813 48
		if (!$site) {
814 48
			$site='/';
815 24
		}
816 48
		$site_url=$this->make_url($site, $nls, $session, $https, true);
817 48
		if ($newpath) { // $newpath is the destination of a shortcut redirection, with keepurl on
818
			$rest=substr($newpath, strlen($site));
0 ignored issues
show
Bug introduced by
The variable $newpath does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
819
		} else {
820 48
			$rest=substr($path, strlen($site));
821
		}
822 48
		return $site_url.$rest;
823
	}
824
825
	public function AR_implements($implements) {
826
		$type = current(explode(".",$this->type));
827
		return $this->store->AR_implements($type, $implements);
828
	}
829
830 View Code Duplication
	public function getlocks() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
831
		global $AR;
832
		if ($this->store->mod_lock) {
833
			$result=$this->store->mod_lock->getlocks($AR->user->data->login);
834
		} else {
835
			$result="";
836
		}
837
		return $result;
838
	}
839
840 48 View Code Duplication
	public function lock($mode="O", $time=0) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
841 48
	global $AR;
842 48
		if ($this->store->mod_lock) {
843 48
			$result=$this->store->mod_lock->lock($AR->user->data->login,$this->path,$mode,$time);
844 24
		} else {
845
			$result=true; // no lock module, so lock is 'set'
846
		}
847 48
		return $result;
848
	}
849
850 48 View Code Duplication
	public function unlock() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
851 48
	global $AR;
852 48
		if ($this->store->mod_lock) {
853 48
			$result=$this->store->mod_lock->unlock($AR->user->data->login,$this->path);
854 24
		} else {
855
			$result=true;
856
		}
857 48
		return $result;
858
	}
859
860
	public function touch($id=0, $timestamp=-1) {
861
		if (!$id) {
862
			$id = $this->id;
863
		}
864
		$result = $this->store->touch($id, $timestamp);
865 View Code Duplication
		if ($this->store->error) {
866
			$this->error = ar::error( ''.$this->store->error, 1107, $this->store->error);
867
		}
868
		return $result;
869
	}
870
871
	public function mogrify($id=0, $type, $vtype=null) {
0 ignored issues
show
Coding Style introduced by
Parameters which have default values should be placed at the end.

If you place a parameter with a default value before a parameter with a default value, the default value of the first parameter will never be used as it will always need to be passed anyway:

// $a must always be passed; it's default value is never used.
function someFunction($a = 5, $b) { }
Loading history...
872
		if (!$id) {
873
			$id = $this->id;
874
		}
875
		if (!$vtype) {
876
			$vtype = $type;
877
		}
878
		if (strpos($vtype, '.')!==false) {
879
			$vtype = substr($vtype, 0, strpos($vtype, '.'));
880
		}
881
		$result = $this->store->mogrify($id, $type, $vtype);
882 View Code Duplication
		if ($this->store->error) {
883
			$this->error = ar::error( ''.$this->store->error, 1107, $this->store->error);
884
		}
885
		return $result;
886
	}
887
888
	public function can_mogrify() {
889
		if ($this->path == "/system/users/admin/") {
890
			return false;
891
		}
892
		return true;
893
	}
894
895
	public function load_properties($scope='') {
896
		return $this->store->load_properties($this->id,'',$scope);
897
	}
898
899
	public function _load_properties($scope='') {
900
		return $this->store->load_properties($this->id,'',$scope);
901
	}
902
903
	public function load_property($property, $scope='') {
904
		return $this->store->load_property($this->id,$property,$scope);
905
	}
906
907
	public function _load_property($property, $scope='') {
908
		return $this->store->load_property($this->id,$property,$scope);
909
	}
910
911 4
	public function GetValidGrants($path="") {
912
	/********************************************************************
913
914
	  This function finds all grants in effect on this object for the
915
	  logged in user! $AR->user must already be set.
916
917
	  Grants are checked in the following way:
918
	  1) First all parents of this object are checked for grants for this
919
	     specific user. The 'nearest' grants are valid, and the path of
920
	     parent that set these grants will be the upper limit for the
921
	     checking of group grants.
922
	  2) Now all groups of which the user is a member are checked for
923
	     grants. Likewise, all parents are checked for group grants, upto
924
	     but not including the upperlimit as set in 1. All group grants
925
	     found are merged into one grants list.
926
	  3) If there are gropup grants, this means that there are group
927
	     grants set in a parent nearer to this object than the user grants
928
	     and therefore the groupgrants must be merged with the
929
	     usergrants.
930
931
	  this results in:
932
	  1	/		user: read edit		group: none
933
	  2	/dir/					group: read
934
	  3	/dir2/		user: none		group: read
935
	  4	/dir/dir3/				group2: edit
936
	  case 1: the user takes precedence over the group, grants are 'read edit'
937
	  case 2: groupgrants are merged with usergrants, as its grants are set
938
	          in a 'nearer' parent (itself). grants are 'read edit'.
939
	  case 3: user takes precedence again. grants are 'none'.
940
	  case 4: All group grants are merged with the usergrants.
941
	          Therefore the grants are 'none read edit'.
942
	********************************************************************/
943
944 4
	global $AR;
945
946 4
		if ($AR->user) { 	// login and retrieval of user object
947 4
			if (!$path) {
948 4
				$path=$this->path;
949 2
			}
950 4
			if (!$AR->user->grants[$path]) {
951 4
				$grants=array();
952 4
				$userpath=$AR->user->FindGrants($path, $grants);
953
				// if not already done, find all groups of which the user is a member
954 4
				if (!is_array($AR->user->externalgroupmemberships) || count($AR->user->externalgroupmemberships)==0) {
955 4
					$criteria["members"]["login"]["="]=$AR->user->data->login;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$criteria was never initialized. Although not strictly required by PHP, it is generally a good practice to add $criteria = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
956 2
				} else {
957
					// Use the group memberships of external databases (e.g. LDAP)
958
					$criteria="members.login='".AddSlashes($AR->user->data->login)."'";
959
					foreach (array_keys($AR->user->externalgroupmemberships) as $group) {
960
						$criteria.=" or login.value='".AddSlashes($group)."'";
961
					}
962
				}
963 4
				if (!$AR->user->groups) {
964 4
					$groups=$this->find("/system/groups/",$criteria, "system.get.phtml");
965 4
					if (isset($groups) && is_array($groups)) {
966 4
						foreach($groups as $group ){
967 4
							if (is_object($group)) {
968 4
								$AR->user->groups[$group->path] = $group;
969 2
							}
970 2
						}
971 2
					}
972 4
					if (isset($AR->user->data->config->groups) && is_array($AR->user->data->config->groups)) {
973 4
						foreach ($AR->user->data->config->groups as $groupPath => $groupId) {
974 4
							if (!$AR->user->groups[$groupPath]) {
975 2
								$AR->user->groups[$groupPath] = current($this->get($groupPath, "system.get.phtml"));
976
							}
977 2
						}
978 2
					}
979 4
					if (!$AR->user->groups["/system/groups/public/"]) {
980
						if ($public=current($this->get("/system/groups/public/", "system.get.phtml"))) {
981
							$AR->user->groups[$public->path] = $public;
982
						}
983
					}
984 2
				}
985 4
				if ($AR->user->groups) {
986
					/* check for owner grants (set by system.get.config.phtml) */
987 4
					if (isset($AR->user->ownergrants) && is_array($AR->user->ownergrants)) {
988
						if (!$AR->user->groups["owner"]) {
989
							$AR->user->groups["owner"] = @current($this->get("/system/groups/owner/", "system.get.phtml"));
990
						}
991
						$AR->user->groups["owner"]->data->config->usergrants = $AR->user->ownergrants;
992
					}
993 4 View Code Duplication
					foreach($AR->user->groups as $group){
994 4
						$groupgrants=array();
995 4
						if (is_object($group)) {
996 4
							$group->FindGrants($path, $groupgrants, $userpath);
997 4
							if (isset($grants) && is_array($grants)) {
998 4
								foreach($groupgrants as $gkey => $gval ){
999
									if (isset($grants[$gkey]) && is_array($grants[$gkey]) && is_array($gval)) {
1000
										$grants[$gkey]=array_merge($gval, $grants[$gkey]);
1001
									} else
1002
									if ($gval && !is_array($gval)) {
1003
										$grants[$gkey] = $gval;
1004
									} else
1005
									if ($gval && !$grants[$gkey]) {
1006 2
										$grants[$gkey] = $gval;
1007
									}
1008 2
								}
1009 2
							} else {
1010 2
								$grants = $groupgrants;
1011
							}
1012 2
						}
1013 2
					}
1014 2
				}
1015 4
				if(isset($AR->sgGrants) && is_array($AR->sgGrants) ) {
1016
					ksort($AR->sgGrants);
1017
					$ppath = $this->make_path($path);
1018 View Code Duplication
					foreach( $AR->sgGrants as $sgpath => $sggrants) {
1019
						$sgpath = $this->make_path($sgpath);
1020
						if( substr($ppath, 0, strlen($sgpath)) == $sgpath ) { // sgpath is parent of ppath or equal to ppath
1021
							if (isset($grants) && is_array($grants)) {
1022
								foreach($sggrants as $gkey => $gval ){
1023
									if (isset($grants[$gkey]) && is_array($grants[$gkey]) && is_array($gval)) {
1024
										$grants[$gkey]=array_merge($gval, $grants[$gkey]);
1025
									} else
1026
									if ($gval && !is_array($gval)) {
1027
										$grants[$gkey] = $gval;
1028
									} else
1029
									if ($gval && !$grants[$gkey]) {
1030
										$grants[$gkey] = $gval;
1031
									}
1032
								}
1033
							} else {
1034
								$grants = $sggrants;
1035
							}
1036
						}
1037
					}
1038
				}
1039 4
				$AR->user->grants[$path]=$grants;
1040 2
			}
1041 4
			$grants=$AR->user->grants[$path];
1042
1043 2
		}
1044 4
		debug("pobject: GetValidGrants(user:".$AR->user->data->login."): end ( ".debug_serialize($grants)." )","all");
0 ignored issues
show
Bug introduced by
The variable $grants does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1045 4
		return $grants;
1046
	}
1047
1048
1049 184
	public function pushContext($context) {
1050 184
	global $AR;
1051 184
		if(!empty($AR->context)) {
1052 72
			$context = array_merge(end($AR->context), $context);
1053 36
		}
1054 184
		array_push($AR->context, $context);
1055 184
	}
1056
1057
	public function setContext($context, $level=0) {
1058
	global $AR;
1059
		$AR->context[count($AR->context)-(1+$level)]=$context;
1060
	}
1061
1062 184
	public function popContext() {
1063 184
	global $AR;
1064 184
		return array_pop($AR->context);
1065
	}
1066
1067 184
	public static function getContext($level=0) {
1068 184
	global $AR;
1069 184
		return $AR->context[count($AR->context)-(1+$level)];
1070
	}
1071
1072 72
	public function CheckAdmin($user) {
1073 72
	if ($user->data->login == "admin") {
1074 68
			return true;
1075
		}
1076 4
		if ($user->data->groups['/system/groups/admin/']) {
1077
			return true;
1078
		}
1079 4
		return false;
1080
	}
1081
1082 60
	public function CheckLogin($grant, $modifier=ARTHISTYPE) {
1083 60
	global $AR,$ARnls,$ARConfig,$ARCurrent,$ARConfigChecked;
1084 60
		if (!$this->store->is_supported("grants")) {
1085
			debug("pobject: store doesn't support grants");
1086
			return true;
1087
		}
1088 60
		if ($modifier==ARTHISTYPE) {
1089 60
			$modifier=$this->type;
1090 30
		}
1091
1092
		/* load config cache */
1093 60
		if (!isset($ARConfig->cache[$this->path])) {
1094
			// since this is usually run before CheckConfig, make sure
1095
			// it doesn't set cache time
1096
			$realConfigChecked = $ARConfigChecked;
1097
			$ARConfigChecked = true;
1098
			$this->loadConfig();
1099
			$ARConfigChecked = $realConfigChecked;
1100
		}
1101
1102 60
		$isadmin = $this->CheckAdmin($AR->user);
1103
1104 60
		if (!$isadmin && !$AR->user->grants[$this->path]) {
1105
			$grants = $this->GetValidGrants();
1106
		} else {
1107 60
			$grants = $AR->user->grants[$this->path];
1108
		}
1109
1110 60
		if ($AR->user->data->login!="public") {
1111
			// Don't remove this or MSIE users won't get uptodate pages...
1112 60
			ldSetClientCache(false);
1113 30
		}
1114
1115 60
		if ( 	( !$grants[$grant]
1116 60
					|| ( $modifier && is_array($grants[$grant]) && !$grants[$grant][$modifier] )
1117 60
				) && !$isadmin ) {
1118
			// do login
1119
			$arLoginMessage = $ARnls["accessdenied"];
1120
			ldAccessDenied($this->path, $arLoginMessage);
1121
			$result=false;
1122
		} else {
1123 60
			$result=($grants || $isadmin);
1124
		}
1125
1126 60
		$ARCurrent->arLoginSilent=1;
1127 60
		return $result;
1128
	}
1129
1130
1131 4
	public function CheckPublic($grant, $modifier=ARTHISTYPE) {
1132 4
	global $AR;
1133
1134 4
		$result=false;
1135 4
		if (!$AR->public) {
1136 4
			$this->pushContext(array('scope' => 'php', 'arCurrentObject' => $this));
1137 4
				$AR->public=current($this->get("/system/users/public/", "system.get.phtml"));
1138 4
			$this->popContext();
1139 2
		}
1140 4
		if ($AR->public) {
1141 4
			$AR->private=$AR->user;
1142 4
			$AR->user=$AR->public;
1143 4
			$result=$this->CheckSilent($grant, $modifier);
1144 4
			$AR->user=$AR->private;
1145 2
		}
1146 4
		return $result;
1147
	}
1148
1149 44
	public function CheckSilent($grant, $modifier=ARTHISTYPE, $path=".") {
1150 44
	global $AR, $ARConfig;
1151 44
		$path = $this->make_path($path);
1152 44
		if ($modifier==ARTHISTYPE) {
1153 44
			$modifier=$this->type;
1154 22
		}
1155
1156
		/* load config cache */
1157 44
		if (!$ARConfig->cache[$path]) {
1158 8
			$this->loadConfig($path);
1159 4
		}
1160 44
		if ($this->CheckAdmin($AR->user)) {
1161 40
			$result=1;
1162 24
		} else if ($grants=$AR->user->grants[$path]) {
1163
			$result=$grants[$grant];
1164
		} else {
1165 4
			$grants=$this->GetValidGrants();
1166 4
			$result=$grants[$grant];
1167
		}
1168 44
		if ($modifier && is_array($result)) {
1169
			$result=$result[$modifier];
1170
		}
1171 44
		return $result;
1172
	}
1173
1174
	public function CheckNewFile($newfilename) {
1175
	global $ARnls;
1176
	/**********************************************************************
1177
1178
	  This function performs all the necessary checks on a path to see
1179
	whether it's a valid path for a new object. This consists of:
1180
	1) checking for invalid characters, valid chars are "a-zA-Z0-9./_-"
1181
	2) checking whether the path starts and ends with a "/".
1182
	3) checking whether the path doesn't exist already.
1183
	4) checking whether the parent exists.
1184
1185
	if all this checks out, it returns 1. If not, $this->error is set to
1186
	the correct error message.
1187
1188
	**********************************************************************/
1189
1190
		$this->error="";
1191
		if (preg_match("|^/[a-z0-9\./_-]*/$|i",$newfilename)) {
1192
			if (!$this->store->exists($newfilename)) {
1193
				$parent=$this->store->make_path($newfilename, "..");
1194
				if ($this->store->exists($parent)) {
1195
					$result=1;
1196
				} else {
1197
					$this->error = ar::error( sprintf($ARnls["err:filenameinvalidnoparent"],$newfilename,$parent), 1102);
1198
				}
1199
			} else {
1200
				$this->error = ar::error( sprintf($ARnls["err:chooseotherfilename"],$newfilename), 1103);
1201
			}
1202
		} else {
1203
			$this->error = ar::error( sprintf($ARnls["err:fileillegalchars"],$newfilename)." ".$ARnls["err:startendslash"], 1104);
1204
		}
1205
		return $result;
0 ignored issues
show
Bug introduced by
The variable $result does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1206
	}
1207
1208 View Code Duplication
	public function resetConfig($path='') {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1209
	global $ARConfig;
1210
		$path = $this->make_path($path);
1211
		if ($ARConfig->cache[$path]) {
1212
			$path = preg_quote($path,'/');
1213
			$keys = preg_grep('/^'.$path.'/',array_keys($ARConfig->cache));
1214
			foreach ($keys as $cachepath) {
1215
				unset($ARConfig->cache[$cachepath]);
1216
				unset($ARConfig->pinpcache[$cachepath]);
1217
			}
1218
		}
1219
	}
1220
1221 36 View Code Duplication
	public function clearChildConfigs($path='') {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1222 36
	global $ARConfig;
1223 36
		$path = $this->make_path($path);
1224 36
		if ($ARConfig->cache[$path]) {
1225 36
			$path = preg_quote($path,'/');
1226 36
			$keys = preg_grep('/^'.$path.'./',array_keys($ARConfig->cache));
1227 36
			foreach($keys as $cachepath) {
1228 4
				unset($ARConfig->cache[$cachepath]);
1229 4
				unset($ARConfig->pinpcache[$cachepath]);
1230 4
				unset($ARConfig->libraries[$cachepath]);
1231 18
			}
1232 18
		}
1233 36
	}
1234
1235 36
	protected function getConfig() {
1236 36
	global $ARConfig, $ARCurrent, $ARConfigChecked;
1237 36
		$this->pushContext(array('scope' => 'php', 'arCurrentObject' => $this));
1238
		// $context=$this->getContext(0);
0 ignored issues
show
Unused Code Comprehensibility introduced by
70% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1239
		// debug("getConfig(".$this->path.") context: ".$context['scope'] );
0 ignored issues
show
Unused Code Comprehensibility introduced by
62% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1240
		// debug(print_r($ARConfig->nls, true));
0 ignored issues
show
Unused Code Comprehensibility introduced by
65% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1241 36
		if( !$ARConfig->cache[$this->parent] && $this->parent!=".." ) {
1242 4
			$parent = current($this->get($this->parent, "system.get.phtml"));
1243 4
			if ($parent) {
1244 4
				$parent->getConfig();
1245 2
			}
1246 2
		}
1247
1248 36
		$this->getConfigData();
1249
1250 36
		$ARConfig->pinpcache[$this->path] = $ARConfig->pinpcache[$this->parent];
1251
		// backwards compatibility when calling templates from config.ini
1252 36
		$prevArConfig = $ARCurrent->arConfig;
1253 36
		$ARCurrent->arConfig = $ARConfig->pinpcache[$this->path];
1254
1255 36
		$arCallArgs['arConfig'] = $ARConfig->pinpcache[$this->path];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$arCallArgs was never initialized. Although not strictly required by PHP, it is generally a good practice to add $arCallArgs = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1256
1257
		/* calling config.ini directly for each system.get.config.phtml call */
1258 36
		$loginSilent = $ARCurrent->arLoginSilent;
1259 36
		$ARCurrent->arLoginSilent = true;
1260
		// debug("getConfig:checkconfig start");
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1261
1262 36
		$initialNLS = $ARCurrent->nls;
1263 36
		$initialConfigChecked = $ARConfigChecked;
1264
1265 36
		$ARConfig->cache[$this->path]->inConfigIni = true;
1266 36
		if ($ARConfig->cache[$this->path]->hasConfigIni && !$this->CheckConfig('config.ini', $arCallArgs)) {
0 ignored issues
show
Documentation introduced by
$arCallArgs is of type array<string,?,{"arConfig":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
Bug Best Practice introduced by
The expression $this->CheckConfig('config.ini', $arCallArgs) of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
1267
			//debug("pobject::getConfig() loaded config.ini @ ".$this->path);
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1268
			// debug("getConfig:checkconfig einde");
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1269 4
			$arConfig = $ARCurrent->arResult;
1270 4
			if (!isset($arConfig)) {
1271
				$arConfig = $ARCurrent->arConfig;
1272
			}
1273 4
			unset($ARCurrent->arResult);
1274 4
			if (isset($arConfig['library']) && is_array($arConfig['library'])) {
1275
				if (!$ARConfig->libraries[$this->path]) {
1276
					$ARConfig->libraries[$this->path] = array();
1277
				}
1278
				foreach ($arConfig['library'] as $libName => $libPath) {
1279
					$this->loadLibrary($libName, $libPath);
1280
				}
1281
				unset($arConfig['library']);
1282
			}
1283 4
			$ARConfig->pinpcache[$this->path] = (array) $arConfig;
1284 2
		}
1285 36
		$ARConfig->cache[$this->path]->inConfigIni = false;
1286 36
		$this->clearChildConfigs( $this->path ); // remove any config data for child objects, since these are set before their parent config was set
1287 36
		$ARConfigChecked = $initialConfigChecked;
1288 36
		$ARCurrent->nls = $initialNLS;
1289
1290 36
		$arConfig = &$ARConfig->pinpcache[$this->path];
1291 36 View Code Duplication
		if (!is_array($arConfig['authentication']['userdirs'])) {
1292
			$arConfig['authentication']['userdirs'] = array('/system/users/');
1293
		} else {
1294 36
			if (reset($arConfig['authentication']['userdirs']) != '/system/users/') {
1295
				array_unshift($arConfig['authentication']['userdirs'], '/system/users/');
1296
			}
1297
		}
1298 36 View Code Duplication
		if (!is_array($arConfig['authentication']['groupdirs'])) {
1299
			$arConfig['authentication']['groupdirs'] = array('/system/groups/');
1300
		} else {
1301 36
			if (reset($arConfig['authentication']['groupdirs']) != '/system/groups/') {
1302
				array_unshift($arConfig['authentication']['groupdirs'], '/system/groups/');
1303
			}
1304
		}
1305
1306 36
		$ARCurrent->arLoginSilent = $loginSilent;
1307 36
		$ARCurrent->arConfig = $prevArConfig;
1308 36
		$this->popContext();
1309 36
	}
1310
1311 36
	protected function getConfigData() {
1312 36
	global $ARConfig, $AR;
1313 36
		$context = $this->getContext(0);
1314 36
		if (!$ARConfig->cache[$this->path] && $context["scope"] != "pinp") {
1315
			// first inherit parent configuration data
1316 36
			$configcache= clone $ARConfig->cache[$this->parent];
1317 36
			$configcache->localTemplates = [];
1318 36
			$configcache->pinpTemplates = [];
1319 36
			$configcache->id = $this->id;
1320
1321
			// cache default templates
1322 36
			if (isset($this->data->config->templates) && count($this->data->config->templates)) {
1323
				$configcache->pinpTemplates    = $this->data->config->pinp;
1324
				$configcache->privatetemplates = $this->data->config->privatetemplates;
1325
				$configcache->localTemplates   = $this->data->config->templates;
1326
1327
				if( !$configcache->hasDefaultConfigIni ) {
1328
					foreach($configcache->localTemplates as $type => $templates ) {
1329
						if( isset($templates["config.ini"]) ) {
1330
							$configcache->hasDefaultConfigIni = true;
1331
							$configcache->hasConfigIni = true;
1332
							break;
1333
						}
1334
					}
1335
				}
1336 36
			} else if (isset($this->data->config->pinp) && count($this->data->config->pinp)) {
1337 4
				$configcache->pinpTemplates    = $this->data->config->pinp;
1338 2
			}
1339
1340 36
			if( !$configcache->hasDefaultConfigIni ) {
1341 36
				$configcache->hasConfigIni = false;
1342 36
				if(isset($this->data->config->pinp) && is_array($this->data->config->pinp) ) {
1343 4
					foreach( $this->data->config->pinp as $type => $templates ) {
1344 4
						if( isset($templates["config.ini"]) ) {
1345 4
							$configcache->hasConfigIni = true;
1346 4
							break;
1347
						}
1348 2
					}
1349 2
				}
1350 18
			}
1351
1352 36
			$localcachesettings = $this->data->config->cacheSettings;
1353 36
			if (!is_array($localcachesettings) ){
1354 36
				$localcachesettings = array();
1355 18
			}
1356
1357 36
			if (!is_array($configcache->cacheSettings) ) {
1358
				$configcache->cacheSettings = array();
1359
			}
1360
1361 36
			if ($this->data->config->cacheconfig) { // When removing this part, also fix the setting below.
1362 4
				$configcache->cache=$this->data->config->cacheconfig;
1363 2
			}
1364
1365 36
			if (!isset($localcachesettings['serverCache']) && isset($this->data->config->cacheconfig)) {
1366 4
				$localcachesettings["serverCache"] = $this->data->config->cacheconfig;
1367 2
			}
1368
1369 36
			if ($localcachesettings['serverCache'] != 0 ) {
1370 4
				$localcachesettings['serverCacheDefault'] = $localcachesettings['serverCache'];
1371 2
			}
1372
1373 36
			$configcache->cacheSettings = $localcachesettings + $configcache->cacheSettings;
1374
1375
			// store the current object type
1376 36
			$configcache->type = $this->type;
1377
1378 36
			if ($this->data->config->typetree && ($this->data->config->typetree!="inherit")) {
1379
				$configcache->typetree=$this->data->config->typetree;
1380
			}
1381 36
			if (isset($this->data->config->nlsconfig->list)) {
1382 4
				$configcache->nls = clone $this->data->config->nlsconfig;
1383 2
			}
1384
1385 36
			if ($this->data->config->grants["pgroup"]["owner"]) {
1386
				$configcache->ownergrants = $this->data->config->grants["pgroup"]["owner"];
1387
			}
1388 36
			if (isset($configcache->ownergrants) && is_array($configcache->ownergrants)) {
1389
				if ($AR->user && $AR->user->data->login != 'public' && $AR->user->data->login === $this->data->config->owner) {
1390
					$ownergrants = $configcache->ownergrants;
1391
					if (isset($ownergrants) && is_array($ownergrants)) {
1392
						foreach( $ownergrants as $grant => $val ) {
1393
							$AR->user->ownergrants[$this->path][$grant] = $val;
1394
						}
1395
					}
1396
				}
1397
			}
1398
1399 36
			if (isset($this->data->config->customconfig) && is_array($this->data->config->customconfig)) {
1400
				$configcache->custom=array_merge(is_array($configcache->custom)?$configcache->custom:array(), $this->data->config->customconfig);
1401
			}
1402 36
			$ARConfig->cache[$this->path]=$configcache;
1403
1404 18
		}
1405 36
	}
1406
1407 64
	public function loadConfig($path='') {
1408 64
	global $ARConfig, $ARConfigChecked, $ARCurrent;
1409 64
		$path=$this->make_path($path);
1410
		// debug("loadConfig($path)");
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1411 64
		if (!isset($ARConfig->cache[$path]) ) {
1412 36
			$allnls = $ARCurrent->allnls;
1413 36
			$ARCurrent->allnls = true;
1414 36
			$configChecked = $ARConfigChecked;
1415 36
			if (($this->path == $path && !$this->arIsNewObject) || $this->exists($path)) {
1416 36
				$this->pushContext(array("scope" => "php"));
1417 36
				if( $this->path == $path ) {
1418
					// debug("loadConfig: currentpath $path ");
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1419 36
					$this->getConfig();
1420 18
				} else {
1421
					//debug("loadConfig: get path $path ");
1422 4
					$cur_obj = current($this->get($path, "system.get.phtml"));
1423 4
					$cur_obj->getConfig();
1424
				}
1425 36
				$this->popContext();
1426 36
				$result=$ARConfig->cache[$path];
1427 18
			} else if ($path === '/') {
1428
				// special case: / doesn't exists in the store
1429
				$result=$ARConfig->cache['..'];
1430
			} else {
1431
				$parent=$this->make_path($path.'../');
1432
				if (!$ARConfig->cache[$parent]) {
1433
					$this->pushContext(array("scope" => "php"));
1434
					// debug("loadConfig: parent $parent");
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1435
					$cur_obj = current($this->get($parent, "system.get.phtml"));
1436
					if( $cur_obj ) {
1437
						$cur_obj->getConfig();
1438
					}
1439
					$this->popContext();
1440
				}
1441
				$result=$ARConfig->cache[$parent];
1442
				$ARConfig->cache[ $path ] = $result;
1443
				$ARConfig->pinpcache[ $path ] = $ARConfig->pinpcache[ $parent ];
1444
			}
1445
			// restore old ARConfigChecked state
1446 36
			$ARConfigChecked = $configChecked;
1447 36
			$ARCurrent->allnls = $allnls;
1448 18
		} else {
1449
			// debug("loadConfig: exists $path ");
0 ignored issues
show
Unused Code Comprehensibility introduced by
67% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1450 52
			$result=$ARConfig->cache[$path];
1451
		}
1452 64
		return $result;
1453
	}
1454
1455
1456
	// TODO: look for a way to merge loadConfig and loadUserConfig into one function
1457
1458 12
	public function loadUserConfig($path='') {
1459 12
	global $ARConfig;
1460 12
		$path = $this->make_path($path);
1461 12
		$parent = $this->make_path($path.'../');
1462
1463 12
		if (!$ARConfig->cache[$path]) {
1464
			$this->loadConfig($path);
1465
		}
1466 12
		if (!$ARConfig->pinpcache[$path]) {
1467
			$config = $ARConfig->pinpcache[$parent];
1468
		} else {
1469 12
			$config = $ARConfig->pinpcache[$path];
1470
		}
1471 12
		return (array)$config;
1472
	}
1473
1474 4
	public function loadLibrary($name, $path) {
1475 4
	global $ARConfig;
1476 4
		$path=$this->make_path($path);
1477 4
		debug("pobject::loadLibrary($name, $path);");
1478 4
		if ($name===ARUNNAMED) {
1479 4
			if (strstr($path, $this->path)===0) {
0 ignored issues
show
Unused Code Bug introduced by
The strict comparison === seems to always evaluate to false as the types of strstr($path, $this->path) (string) and 0 (integer) can never be identical. Maybe you want to use a loose comparison == instead?
Loading history...
1480
				return ar::error('You cannot load an unnamed library from a child object.', 1109);
1481
			} else {
1482 4
				if (!isset($ARConfig->libraries[$this->path])) {
1483 4
					$ARConfig->libraries[$this->path] = [ $path ];
1484 2
				} else {
1485 2
					array_unshift($ARConfig->libraries[$this->path],$path);
1486
				}
1487
			}
1488 2
		} else if ($name && is_string($name)) {
1489
			$ARConfig->libraries[$this->path][$name]=$path;
1490
		} else if (is_int($name)) {
1491
			$ARConfig->libraries[$this->path][$name]=$path;
1492
		} else {
1493
			return ar::error('Illegal library name: '.$name, 1110);
1494
		}
1495 4
	}
1496
1497
	// returns a list of libraries loaded on $path
1498
	public function getLibraries($path = '') {
1499
	global $ARConfig;
1500
		$path = $this->make_path($path);
1501
		return (array)$ARConfig->libraries[$path];
1502
	}
1503
1504
	public function mergeLibraryConfig( $defaultLibraryName, $defaults ) {
1505
		$libraryName = ar::getvar('arLibrary');
1506
		if ( is_numeric($libraryName) || $libraryName == 'current' ) { // library is loaded unnamed
1507
			$libraryName = $defaultLibraryName;
1508
		}
1509
		if ( $libraryName ) {
1510
			$userConfig = ar::acquire('defaults.'.$libraryName);
1511
			if (isset($userConfig) && is_array($userConfig) ) {
1512
				$defaults = array_merge( $defaults, $userConfig );
1513
			}
1514
		}
1515
		return array_merge( $defaults, $this->getvar('arCallArgs') );
1516
	}
1517
1518
	public function _mergeLibraryConfig( $defaultLibraryName, $defaults ) {
1519
		return $this->mergeLibraryConfig( $defaultLibraryName, $defaults );
1520
	}
1521
1522 60
	protected function findTemplateOnPath($path, $arCallFunction, $arType, $reqnls, &$arSuperContext){
1523
1524 60
		debug('findTemplateOnPath: ['.$arType .']['.$arCallFunction.']['.$reqnls.']');
1525 60
		while ($arType!='ariadne_object' ) {
1526 60
			list($arMatchType,$arMatchSubType) = explode('.',$arType,2);
1527 60
			$local = ($path === $this->path);
1528 60
			debug("findTemplateOnPath context [". $path.":".$arType.":".$arCallFunction ."]");
1529 60
			$templates = ar('template')->ls($path);
1530 60
			if(isset($templates[$arCallFunction])) {
1531 12
				$template = null;
1532 12
				if (!isset($arSuperContext[$path.":".$arType.":".$arCallFunction])) {
1533
					$template = array_reduce($templates[$arCallFunction] , function($carry, $item) use ($arMatchType,$arMatchSubType, $reqnls, $local) {
1534 12
						if ( ( $item['local'] == true && $local == true ) || $item['local'] == false ) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
1535 12
							if ($item['type'] === $arMatchType && ($item['subtype'] == $arMatchSubType) ) {
1536 12
								if (isset($carry) && $carry['language'] !== 'any') {
1537
									return $carry;
1538 12
								} else if ($item['language'] === 'any' || $item['language'] === $reqnls ) {
1539 12
									return $item;
1540
								}
1541
							}
1542
						}
1543
						return $carry;
1544 12
					}, null);
1545 6
				}
1546 12
				if ( isset($template) && !isset($arSuperContext[$path.":".$arType.":".$arCallFunction])) {
1547 12
					debug("findTemplateOnPath returning for [". $path.":".$arType.":".$arCallFunction ."]");
1548 12
					return $template;
1549
				}
1550
			}
1551 48
			if (!isset($AR->superClass[$arType])) {
1552
				// no template found, no default.phtml found, try superclass.
1553 48
				if ($subcpos = strpos($arType, '.')) {
1554 24
					$arSuper = substr($arType, 0, $subcpos);
1555 12
				} else {
1556 48
					if (!class_exists($arType, false )) {
1557
						// the given class was not yet loaded, so do that now
1558
						$arTemp=$this->store->newobject('','',$arType,new object);
1559
					} else {
1560 48
						$arTemp=new $arType();
1561
					}
1562 48
					$arSuper=get_parent_class($arTemp);
1563
				}
1564 48
				$AR->superClass[$arType]=$arSuper;
0 ignored issues
show
Bug introduced by
The variable $AR does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
1565 24
			} else {
1566
				$arSuper=$AR->superClass[$arType];
1567
			}
1568 48
			$arType=$arSuper;
1569 24
		}
1570
1571 48
		return null;
1572
	}
1573
1574 60
	public function getPinpTemplate($arCallFunction='view.html', $path=".", $top="", $inLibrary = false, $librariesSeen = null, $arSuperContext=array()) {
1575 60
	global $ARCurrent, $ARConfig, $AR, $ARConfigChecked;
1576 60
		debug("getPinpTemplate: function: $arCallFunction; path: $path; top: $top; inLib: $inLibrary","class");
1577 60
		$result = array();
0 ignored issues
show
Unused Code introduced by
$result is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
1578 60
		if (!$top) {
1579 60
			$top = '/';
1580 30
		}
1581 60
		$path = $this->make_path($path);
1582 60
		if (!is_array($arSuperContext)) {
1583
			$arSuperContext = array();
1584
		}
1585
1586 60
		$typepos = strpos($arCallFunction,"::");
1587 60
		if ($typepos !== false ) {
1588
			// template of a specific class defined via call("class::template");
1589
			$arCallType     = substr($arCallFunction, 0, $typepos);
1590
			$arCallFunction = substr($arCallFunction, $typepos+1);
1591
		} else {
1592 60
			$arCallType=$this->type;
1593
		}
1594
1595 60
		$libpos = strpos($arCallFunction,":");
1596 60
		if ( $libpos !== false ) {
1597
			// template of a specific library defined via call("library:template");
1598
			$arLibrary      = substr($arCallFunction, 0, $libpos);
1599
			$arCallFunction = substr($arCallFunction, $libpos+1);
1600
1601
			if ($arLibrary == 'current') {
1602
				// load the current arLibrary
1603
				$context       = $this->getContext(1);
1604
				$arLibrary     = $context['arLibrary'];
1605
				$arLibraryPath = $context['arLibraryPath'];
1606
			} else {
1607
				$libpath = $path;
1608
				while (!isset($arLibraryPath) && $libpath!=$lastlibpath) {
0 ignored issues
show
Bug introduced by
The variable $lastlibpath does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1609
					$lastlibpath = $libpath;
1610
					if (isset($ARConfig->libraries[$libpath][$arLibrary])) {
1611
						$arLibraryPath = $ARConfig->libraries[$libpath][$arLibrary];
1612
					} else {
1613
						if ($libpath == $top) {
1614
							break;
1615
						}
1616
						$libpath=$this->store->make_path($libpath, "..");
1617
					}
1618
				}
1619
			}
1620
			if ($arLibraryPath) {
1621
				debug("getPinpTemplate: found library '$arLibrary'. Searching for [".$arCallType."] $arCallFunction on '".$arLibraryPath."' up to '$top'");
0 ignored issues
show
Bug introduced by
The variable $arLibraryPath does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1622
				$librariesSeen[$arLibraryPath] = true;
1623
				$inLibrary = true;
1624
				$path = $arLibraryPath;
1625
			} else {
1626
				debug("getPinpTemplate: Failed to find library $arLibrary");
1627
			}
1628
			$path = $this->make_path($path);
1629
			debug("final lib path is ".$path);
1630
		}
1631
1632 60
		$checkpath           = $path;
1633 60
		$lastcheckedpath     = "";
1634 60
		$arCallClassTemplate = $ARCurrent->arCallClassTemplate;
1635 60
		$reqnls              = $this->reqnls;
1636 60
		$template            = null;
1637 60
		while (!$arCallClassTemplate && !isset($template) && $checkpath!=$lastcheckedpath) {
1638 60
			debug("getPinpTemplate: checking for ".$arCallFunction." on ".$checkpath);
1639 60
			$lastcheckedpath = $checkpath;
1640
1641 60
			$template = $this->findTemplateOnPath( $checkpath, $arCallFunction, $arCallType, $reqnls, $arSuperContext);
1642
1643 60
			if (isset($template)) {
1644
				// haal info uit template
1645 12
				debug("getPinpTemplate: found ".$arCallFunction." on ".$checkpath);
1646 54
			} else if ($inLibrary) {
1647
1648
				// faster matching on psection, prefix doesn't have to be a valid type
1649
				$prefix = substr($ARConfig->cache[$checkpath]->type,0,8);
1650
1651
				if ($prefix === 'psection') {
1652
					 debug("BREAKING; $arTemplateId");
0 ignored issues
show
Bug introduced by
The variable $arTemplateId does not exist. Did you mean $template?

This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name.

The variable may have been renamed without also renaming all references.

Loading history...
1653
					// break search operation when we have found a
1654
					// psection object
1655
					break;
1656
				}
1657
			} else {
1658 48
				if (isset($ARConfig->libraries[$checkpath])) {
1659
					// need to check for unnamed libraries
1660 48
					$libraries = array_filter($ARConfig->libraries[$checkpath],'is_int',ARRAY_FILTER_USE_KEY);
1661 48
					foreach( $libraries as $libpath ) {
1662 48
						$libprevpath = null;
1663 48
						while($libpath != $libprevpath ) {
1664 48
							$libprevpath = $libpath;
1665
1666 48
							$template = $this->findTemplateOnPath( $libpath, $arCallFunction, $arCallType, $reqnls, $arSuperContext);
1667 48
							if (isset($template)) {
1668
								break 2;
1669
							}
1670
1671 48
							$prefix = substr($ARConfig->cache[$libpath]->type,0,8);
1672 48
							if ($prefix === 'psection' || $top == $libpath) {
1673 48
								break;
1674
							}
1675
1676 48
							$libpath = $this->store->make_path($libpath, "..");
1677 24
						}
1678 24
					}
1679 48
					debug("getPinpTemplate: found ".$arCallFunction." on ".$template['path']);
1680 24
				}
1681
1682
			}
1683
1684 60
			if ($checkpath == $top) {
1685 48
				break;
1686
			}
1687
1688 60
			debug("getPinpTemplate: DONE checking for ".$arCallFunction." on ".$checkpath);
1689 60
			$checkpath=$this->store->make_path($checkpath, "..");
1690
			
1691 30
		}
1692 60
		$result = null;
1693 60
		if(isset($template)) {
1694 12
			$result = [];
1695 12
			debug("getPinpTemplate END; ".$template['id'] .' '.$template['path']);
1696 12
			$type = $template['type'];
1697 12
			if(isset($template['subtype'])) {
1698
				$type .= '.' . $template['subtype'];
1699
			}
1700 12
			$result["arTemplateId"]       = $template['id'];
1701 12
			$result["arCallTemplate"]     = $template['filename'];
1702 12
			$result["arCallType"]         = $arCallType;
1703 12
			$result["arCallTemplateName"] = $arCallFunction;
1704 12
			$result["arCallTemplateNLS"]  = $template['language'];
1705 12
			$result["arCallTemplateType"] = $type;
1706 12
			$result["arCallTemplatePath"] = $template['path'];
1707 12
			$result["arLibrary"]          = $arLibrary;
0 ignored issues
show
Bug introduced by
The variable $arLibrary does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1708 12
			$result["arLibraryPath"]      = $arLibraryPath;
1709 12
			$result["arLibrariesSeen"]    = $librariesSeen;
1710 12
			$result["arPrivateTemplate"]  = $template['private'];
1711 6
		}
1712 60
		return $result;
1713
	}
1714
1715 64
	public function CheckConfig($arCallFunction="", $arCallArgs="") {
1716
	// returns true when cache isn't up to date and no other template is
1717
	// defined for $path/$function. Else it takes care of output to the
1718
	// browser.
1719
	// All these templates must exist under a fixed directory, $AR->dir->templates
1720 64
	global $nocache, $AR, $ARConfig, $ARCurrent, $ARBeenHere, $ARnls, $ARConfigChecked;
1721 64
		$MAX_LOOP_COUNT=10;
1722
1723
1724
		// system templates (.phtml) have $arCallFunction=='', so the first check in the next line is to
1725
		// make sure that loopcounts don't apply to those templates.
1726 64
		if (0 && $arCallFunction && $ARBeenHere[$this->path][$arCallFunction]>$MAX_LOOP_COUNT) { // protect against infinite loops
1727
			error(sprintf($ARnls["err:maxloopexceed"],$this->path,$arCallFunction,$arCallArgs));
1728
			$this->store->close();
1729
			exit();
0 ignored issues
show
Coding Style Compatibility introduced by
The method CheckConfig() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
1730
		} else {
1731 64
			$ARBeenHere[$this->path][$arCallFunction]+=1;
1732
1733
			// this will prevent the parents from setting the cache time
1734 64
			$initialConfigChecked = $ARConfigChecked;
1735 64
			$ARConfigChecked = true;
1736 64
			$config = ($ARConfig->cache[$this->path]) ? $ARConfig->cache[$this->path] : $this->loadConfig();
1737 64
			$ARConfigChecked = $initialConfigChecked;
1738 64
			$ARConfig->nls=$config->nls;
1739
1740
1741
			// if a default language is entered in a parent and no language is
1742
			// explicitly selected in the url, use that default.
1743
			// The root starts with the system default (ariadne.phtml config file)
1744 64
			if ( !$ARCurrent->nls ) {
1745 64
				if ( $config->root['nls'] ) {
1746
					$this->reqnls = $config->root['nls'];
1747
					if ( !$ARConfigChecked ) {
1748
						$ARCurrent->nls = $this->reqnls;
1749
					}
1750 64
				} else if ( $config->nls->default ) {
1751 64
					$this->reqnls = $config->nls->default;
1752 64
					$this->nls = $this->reqnls;
1753 64
					if ( !$ARConfigChecked ) {
1754 32
						$ARCurrent->nls = $this->nls;
1755
					}
1756 32
				}
1757 32
			} else {
1758
				$this->reqnls = $ARCurrent->nls;
1759
			}
1760 64
			$nls = &$this->nls;
1761 64
			$reqnls = &$this->reqnls;
1762
1763 64
			if (!$ARConfigChecked && is_object($ARnls)) {
1764
				$ARnls->setLanguage($ARCurrent->nls);
1765
			}
1766
1767
1768 64
			if (!$ARCurrent->arContentTypeSent) {
1769
				ldHeader("Content-Type: text/html; charset=UTF-8");
1770
				$ARCurrent->arContentTypeSent = true;
1771
			}
1772
1773
/*			// FIXME: the acceptlang code works a bit too well.. it overrides psite configuration settings.
0 ignored issues
show
Unused Code Comprehensibility introduced by
56% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
Coding Style introduced by
Comment refers to a FIXME task "the acceptlang code works a bit too well.. it overrides psite configuration settings"
Loading history...
1774
1775
			if ($ARCurrent->acceptlang && !$ARCurrent->nls) {
1776
				if ($ARCurrent->acceptlang && is_array($this->data->nls->list)) {
1777
					$validlangs = array_intersect(array_keys($ARCurrent->acceptlang), array_keys($this->data->nls->list));
1778
				}
1779
				if ($validlangs) {
1780
					$reqnls=array_shift($validlangs);
1781
					$ARCurrent->nls = $reqnls;
1782
				}
1783
			}
1784
*/
1785 64 View Code Duplication
			if (isset($this->data->custom) && is_array($this->data->custom) && $this->data->custom['none']) {
1786 4
				$this->customdata=$this->data->custom['none'];
0 ignored issues
show
Bug introduced by
The property customdata does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
1787 2
			}
1788 64 View Code Duplication
			if (isset($this->data->custom) && is_array($this->data->custom) && $this->data->custom[$nls]) {
1789
				$this->customnlsdata=$this->data->custom[$nls];
0 ignored issues
show
Bug introduced by
The property customnlsdata does not seem to exist. Did you mean nlsdata?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1790
			}
1791
1792 64
			if (!$ARConfigChecked) {
1793
				// this template is the first template called in this request.
1794
				$eventData = new object();
1795
				$eventData->arCallArgs = $arCallArgs;
0 ignored issues
show
Bug introduced by
The property arCallArgs does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1796
				$eventData->arCallFunction = $arCallFunction;
0 ignored issues
show
Bug introduced by
The property arCallFunction does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1797
1798
				$ARConfigChecked = true;
1799
				$result = ar_events::fire( 'onbeforeview', $eventData );
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1800
				$ARConfigChecked = $initialConfigChecked;
1801
				if ( !$result ) { //prevent default action: view
1802
					return false;
1803
				}
1804
			}
1805
1806 64
			if (!$ARConfigChecked) {
1807
				// if this object isn't available in the requested language, show
1808
				// a language select dialog with all available languages for this object.
1809
				if (isset($this->data->nls) && !$this->data->name) {
1810
					if (!$ARCurrent->forcenls && (!isset($this->data->nls->list[$reqnls]) || !$config->nls->list[$reqnls])) {
1811
						if (!$ARCurrent->nolangcheck && $arCallFunction != 'config.ini') {
1812
							$ARCurrent->nolangcheck=1;
1813
							$eventData = new object();
1814
							$eventData->arCallFunction = $arCallFunction;
1815
							$eventData->arCallArgs = $arCallArgs;
1816
							$eventData->arRequestedNLS = $reqnls;
0 ignored issues
show
Bug introduced by
The property arRequestedNLS does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1817
							$result = ar_events::fire( 'onlanguagenotfound', $eventData );
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1818
							if ( $result ) { // continue with default action: langaugeselect
1819
								$result->arCallArgs["arOriginalFunction"] = $result->arCallFunction;
1820
								$this->call("user.languageselect.html", $result->arCallArgs);
1821
								return false;
1822
							}
1823
						} else {
1824
							$this->nlsdata=$this->data->$nls;
1825
						}
1826
					} else {
1827
						$this->nlsdata=$this->data->$reqnls;
1828
					}
1829
				}
1830
				$ARCurrent->nolangcheck=1;
1831
			}
1832
1833
			/*
1834
				Set ARConfigChecked to true to indicate that we have been here
1835
				earlier.
1836
			*/
1837 64
			$ARConfigChecked = true;
1838 64
			if ($arCallFunction) { // don't search for templates named ''
1839
				// FIXME: Redirect code has to move to getPinpTemplate()
0 ignored issues
show
Coding Style introduced by
Comment refers to a FIXME task "Redirect code has to move to getPinpTemplate"
Loading history...
1840 60
				$redirects	= $ARCurrent->shortcut_redirect;
1841 60
				if (isset($redirects) && is_array($redirects)) {
1842
					$redirpath = $this->path;
1843
					while (!$template['arTemplateId'] &&
0 ignored issues
show
Bug introduced by
The variable $template does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1844
							($redir = array_pop($redirects)) &&
1845
							$redir["keepurl"] &&
1846
							(substr($redirpath, 0, strlen($redir["dest"])) == $redir["dest"])
1847
					) {
1848
						$template = $this->getPinpTemplate($arCallFunction, $redirpath, $redir["dest"]);
1849
						$redirpath = $redir['src'];
1850
					}
1851
1852
					if (!$template["arTemplateId"] && $redirpath) {
1853
						$template = $this->getPinpTemplate($arCallFunction, $redirpath);
1854
					}
1855
				}
1856 60
				if (!$template["arTemplateId"]) {
1857 60
					$template = $this->getPinpTemplate($arCallFunction);
1858 30
				}
1859
1860 60
				if ($template["arCallTemplate"] && $template["arTemplateId"]) {
1861 12
					if (!isset($ARCurrent->cacheTemplateChain)) {
1862
						$ARCurrent->cacheTemplateChain = array();
1863
					}
1864 12
					if (!isset($ARCurrent->cacheTemplateChain[$template["arTemplateId"]])) {
1865 8
						$ARCurrent->cacheTemplateChain[$template["arTemplateId"]] = array();
1866 4
					}
1867 12
					if (!isset($ARCurrent->cacheTemplateChain[$template["arTemplateId"]][$template['arCallTemplate']])) {
1868 12
						$ARCurrent->cacheTemplateChain[$template["arTemplateId"]][$template['arCallTemplate']] = array();
1869 6
					}
1870 12
					if (!isset($ARCurrent->cacheTemplateChain[$template["arTemplateId"]][$template['arCallTemplate']][$template['arCallTemplateType']])) {
1871 12
						$ARCurrent->cacheTemplateChain[$template["arTemplateId"]][$template['arCallTemplate']][$template['arCallTemplateType']] = 0;
1872 6
					}
1873 12
					$ARCurrent->cacheTemplateChain[$template["arTemplateId"]][$template['arCallTemplate']][$template['arCallTemplateType']]++;
1874
1875
1876 12
					debug("CheckConfig: arCallTemplate=".$template["arCallTemplate"].", arTemplateId=".$template["arTemplateId"],"object");
1877
					// $arCallTemplate=$this->store->get_config("files")."templates".$arCallTemplate;
0 ignored issues
show
Unused Code Comprehensibility introduced by
63% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1878
					// check if template exists, if it doesn't exist, then continue the original template that called CheckConfig
1879 12
					$arTemplates=$this->store->get_filestore("templates");
0 ignored issues
show
Unused Code introduced by
$arTemplates is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
1880 12
					$exists = ar('template')->exists($template['arCallTemplatePath'],$template["arCallTemplate"]);
1881 12
					if ( $exists ) {
1882
						// check if the requested language exists, if not do not display anything,
1883
						// unless otherwise indicated by $ARCurrent->allnls
1884
						// This triggers only for pinp templates called by other templates,
1885
						// as the first template (in the url) will first trigger the language
1886
						// choice dialogue instead.
1887 12
						$arLibrary = $template['arLibrary'];
1888 12
						if (is_int($arLibrary)) {
1889
							// set the library name for unnamed libraries to 'current'
1890
							// so that calls using getvar('arLibrary') will keep on working
1891
							$arLibrary = "current";
1892
						}
1893
1894 12 View Code Duplication
						if (!is_string($arCallArgs)) {
1895 12
							$arCallArgs['arCallFunction'] = $arCallFunction;
1896 12
							$arCallArgs['arLibrary']      = $arLibrary;
1897 12
							$arCallArgs['arLibraryPath']  = $template["arLibraryPath"];
1898 6
						}
1899
1900 12
						$ARCurrent->arCallStack[]=$arCallArgs;
1901
						// start running a pinp template
1902
1903 12
						$this->pushContext(
1904
							array(
1905 12
								"scope"              => "pinp",
1906 12
								"arLibrary"          => $arLibrary,
1907 12
								"arLibraryPath"      => $template['arLibraryPath'],
1908 12
								"arCallFunction"     => $arCallFunction,
1909 12
								"arCurrentObject"    => $this,
1910 12
								"arCallType"         => $template['arCallType'],
1911 12
								"arCallTemplateName" => $template['arCallTemplateName'],
1912 12
								"arCallTemplateNLS"  => $template['arCallTemplateNLS'],
1913 12
								"arCallTemplateType" => $template['arCallTemplateType'],
1914 12
								"arCallTemplatePath" => $template['arCallTemplatePath'],
1915 12
								"arLibrariesSeen"    => $template['arLibrariesSeen']
1916 6
							)
1917 6
						);
1918
1919
						// FIXME: is 2 het correcte getal? Kan dit minder magisch?
0 ignored issues
show
Coding Style introduced by
Comment refers to a FIXME task "is 2 het correcte getal? Kan dit minder magisch?"
Loading history...
1920 12
						if (count($ARCurrent->arCallStack) == 2 && true === $template['arPrivateTemplate']) {
1921
							// Do not allow private templates to be called first in the stack.
1922
							// echo "Bad request";
1923
1924
							// FIXME: Echte header sturen? Of gewoon niet uitvoeren? Wat is het correcte gedrag?
0 ignored issues
show
Coding Style introduced by
Comment refers to a FIXME task "Echte header sturen? Of gewoon niet uitvoeren? Wat is het correcte gedrag?"
Loading history...
1925
							// Return true zorgt er voor dat de default 404 handler het oppikt alsof het template niet bestaat.
1926
							$this->popContext();
1927
							array_pop($ARCurrent->arCallStack);
1928
							return true;
1929 12
						} else if ($ARCurrent->forcenls || isset($this->data->nls->list[$reqnls])) {
1930
							// the requested language is available.
1931 12
							$this->nlsdata=$this->data->$reqnls;
1932 12
							$this->nls=$reqnls;
1933 12
							$continue=true;
1934 6
						} else if (!isset($this->data->nls)) {
1935
							// the object has no language support
1936
							$this->nlsdata=$this->data;
1937
							$continue=true;
1938
						} else if (($ARCurrent->allnls) || (!$initialConfigChecked && $ARCurrent->nolangcheck)) {
1939
							// all objects must be displayed
1940
							// $this->reqnls=$this->nls; // set requested nls, for checks
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1941
							$this->nls = isset($this->data->nls->default) ? $this->data->nls->default : $this->reqnls;
1942
							$this->nlsdata = $this->data->$nls ?: $this->data->{$this->nls} ?: $this->data;
1943
							$continue=true;
1944
						} else {
1945
							debug("CheckConfig: requested language not available, allnls not set","object");
1946
							// -> skip this object (do not run template but do return false)
1947
							$continue=false;
1948
						}
1949 12
						if ($continue) {
1950 12
							$eventData = new object();
1951 12 View Code Duplication
							if ( !$AR->contextCallHandler ) { /* prevent onbeforecall from re-entering here */
1952 12
								$AR->contextCallHandler = true;
1953 12
								$eventData->arCallArgs = $arCallArgs;
1954 12
								$eventData->arCallFunction = $arCallFunction;
1955 12
								$eventData->arContext = $this->getContext();
0 ignored issues
show
Bug introduced by
The property arContext does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1956 12
								$eventData = ar_events::fire('onbeforecall', $eventData);
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1957 12
								$ARCurrent->arResult = $eventData->arResult;
1958 12
								$AR->contextCallHandler = false;
1959 12
								$continue = ($eventData!=false);
1960 6
							}
1961 12
							if ( $continue ) {
1962 12
								if (!isset($ARCurrent->cacheCallChainSettings)) {
1963
									$ARCurrent->cacheCallChainSettings = array();
1964
								}
1965 12
								if ($ARConfig->cache[$this->path]->inConfigIni == false) {
1966 8
									$ARCurrent->cacheCallChainSettings[$this->id] = $config->cacheSettings;
1967 4
								}
1968
1969 12
								if ($ARCurrent->ARShowTemplateBorders) {
1970
									echo "<!-- arTemplateStart\nData: ".$this->type." ".$this->path." \nTemplate: ".$template["arCallTemplatePath"]." ".$template["arCallTemplate"]." \nLibrary:".$template["arLibrary"]." -->";
1971
								}
1972 12
								set_error_handler(array('pobject','pinpErrorHandler'),error_reporting());
1973 12
								$func = ar('template')->get($template['arCallTemplatePath'],$template['arCallTemplate']);
1974 12
								if(is_callable($func)){
1975 12
									$arResult = $func($this);
1976 6
								}
1977 12
								restore_error_handler();
1978 12
								if (isset($arResult)) {
1979 12
									$ARCurrent->arResult=$arResult;
1980 6
								}
1981 12
								if ($ARCurrent->ARShowTemplateBorders) {
1982
									echo "<!-- arTemplateEnd -->";
1983
								}
1984 12 View Code Duplication
								if ( !$AR->contextCallHandler ) { /* prevent oncall from re-entering here */
1985 12
									$AR->contextCallHandler = true;
1986 12
									$temp = $ARCurrent->arResult; /* event listeners will change ARCurrent->arResult */
1987 12
									$eventData->arResult = $temp;
1988 12
									ar_events::fire('oncall', $eventData );
1989 12
									$ARCurrent->arResult = $temp; /* restore correct result */
1990 12
									$AR->contextCallHandler = false;
1991 6
								}
1992 6
							}
1993 6
						}
1994 12
						array_pop($ARCurrent->arCallStack);
1995 12
						$this->popContext();
1996
1997 12
						if ( !$initialConfigChecked && $arCallFunction != 'config.ini' ) {
1998
							// this template was the first template called in this request.
1999
							$eventData = new object();
2000
							$eventData->arCallArgs = $arCallArgs;
2001
							$eventData->arCallFunction = $arCallFunction;
2002
							ar_events::fire( 'onview', $eventData ); // no default action to prevent, so ignore return value.
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2003
						}
2004 12
						return false;
2005
					} else {
2006 4
						debug("pobject: CheckConfig: no such file: ".$template["arTemplateId"].$template["arCallTemplate"]."","all");
2007
					}
2008 2
				} else {
2009 48
					debug("CheckConfig: no arCallTemplate ($arCallFunction from '$this->path')","object");
2010
				}
2011
2012 26
			}
2013
		}
2014 56
		return true;
2015
	}
2016
2017 24
	public function ClearCache($path="", $private=true, $recurse=false) {
2018 24
	global $AR;
2019 24
		$norealnode = false;
2020 24
		if (!$path) {
2021
			$path=$this->path;
2022
		} else {
2023 24
			$realpath = current($this->get($path, "system.get.path.phtml"));
2024 24
			if($realpath != false) {
2025 24
				$path = $realpath;
2026 12
			} else {
2027
				$norealnode = true;
2028
			}
2029
		}
2030
2031 24
		if($norealnode !== true) {
2032
			/*
2033
				we don't want to recurse to the currentsite, because the path
2034
				doesn't exists in the database, so it doesn't have a currentsite
2035
2036
				the privatecache should be emptied by delete, or by the cleanup
2037
				cronjob. The current path doesn't exists in the database, so a
2038
				object id which is needed to find the node in the cache, isn't
2039
				available
2040
			*/
2041
2042 24
			if ($private ) {
2043
				// now remove any private cache entries.
2044
				// FIXME: this doesn't scale very well.
0 ignored issues
show
Coding Style introduced by
Comment refers to a FIXME task "this doesn't scale very well"
Loading history...
2045
				//        only scalable solution is storage in a database
2046
				//        but it will need the original path info to
2047
				//        remove recursively fast enough.
2048
				//        this means a change in the filestore api. -> 2.5
2049
2050
				// Use chunks of max 5000 objects at a time to be more memory-efficient;
2051 24
				$pcache=$this->store->get_filestore("privatecache");
2052 24
				if ($recurse) {
2053
					$offset = 0;
2054
					$limit = 5000;
2055
					$ids=$this->store->info($this->store->find($path, "" , $limit, $offset));
2056
					while (is_array($ids) && count($ids)) {
2057
						foreach($ids as $value) {
2058
							$eventData = new object();
2059
							$eventData = ar_events::fire( 'onbeforeclearprivatecache', $eventData, $value['type'], $value['path'] );
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2060
							if ( !$eventData ) {
2061
								continue;
2062
							}
2063
2064
							$pcache->purge($value["id"]);
2065
							ar_events::fire( 'onclearprivatecache', $eventData, $value['type'], $value['path'] );
2066
						}
2067
2068
						$offset += $limit;
2069
						$ids = $this->store->info($this->store->find($path, "", $limit, $offset));
2070
					}
2071
				} else {
2072 24
					$eventData = new object();
2073 24
					$eventData = ar_events::fire( 'onbeforeclearprivatecache', $eventData, $this->type, $this->path );
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2074 24
					if ( $eventData ) {
2075 24
						$pcache->purge($this->id);
2076 24
						ar_events::fire( 'onclearprivatecache', $eventData, $this->type, $this->path );
2077 12
					}
2078
				}
2079 12
			}
2080
2081
			// now clear all parents untill the current site
2082 24
			$site=$this->currentsite($path);
2083 24
			$project=$this->currentproject($path);
2084 24
			if ($path!=$site && $path != $project && $path!='/') {
2085 24
				$parent=$this->make_path($path.'../');
2086 24
				$this->ClearCache($parent, $private, false);
2087 12
			}
2088 12
		}
2089 24
		$recursed = array();
2090
2091
		// filesystem cache image filenames are always lower case, so
2092
		// use special path for that. Remember 'real' path name for
2093
		// recursion and stuff
2094 24
		$fs_path=strtolower($path);
2095 24
		$nlslist=$AR->nls->list;
2096 24
		$nlslist["."]="default";
2097 24
		$cache_types[] = "normal";
0 ignored issues
show
Coding Style Comprehensibility introduced by
$cache_types was never initialized. Although not strictly required by PHP, it is generally a good practice to add $cache_types = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
2098 24
		$cache_types[] = "compressed";
2099 24
		$cache_types[] = "session";
2100
2101 24
		global $cache_config,$store_config;
2102 24
		$cachestore=new cache($cache_config);
2103
2104
2105 24
		$filestore = $this->store->get_config("files");
2106 24
		foreach($cache_types as $type){
2107 24
			foreach($nlslist as $nls => $language){
2108
				// break away if nls doesn't exists
2109
				// is dir is cached, so it should not cost more that it add's in speed
2110 24
				if(!is_dir($filestore."cache/$type/$nls")){
2111 24
					continue;
2112
				}
2113
2114
				$fpath=$filestore."cache/$type/$nls".$fs_path;
2115
				$hpath=$filestore."cacheheaders/$type/$nls".$fs_path;
2116
				if ($dir=@dir($fpath)) {
2117
					while (false !== ($entry = $dir->read())) {
2118
						if ($entry!="." && $entry!="..") {
2119
							if (is_file($fpath.$entry)) {
2120
								@unlink($fpath.$entry);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2121
								@unlink($hpath.$entry);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2122
								$cachestore->delete("/".$type."/".$nls.$fs_path.$entry);
2123
							} else if ( $recurse && !$recursed[$entry]) {
2124
								$this->ClearCache($path.$entry."/", false, true);
2125
								$recursed[$entry]=true;
2126
							}
2127
						}
2128
					}
2129
					$dir->close();
2130
					// remove empty directory entry's, hide errors about directory entry's with content
2131
					@rmdir($fpath);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2132
					@rmdir($hpath);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2133
				} else if (file_exists(substr($fpath,0,-1)."=")) {
2134
					@unlink(substr($fpath,0,-1)."=");
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2135
					@unlink(substr($hpath,0,-1)."=");
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2136 12
					$cachestore->delete("/".$type."/".$nls.substr($fs_path,0,-1)."=");
2137
				}
2138 12
			}
2139 12
		}
2140 24
	}
2141
2142
	public function getcache($name, $nls="") {
2143
		global $ARCurrent, $ARnls;
2144
		$result=false;
0 ignored issues
show
Unused Code introduced by
$result is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
2145
		$this->error = '';
2146
		if ($name) {
2147
			$result=false;
0 ignored issues
show
Unused Code introduced by
$result is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
2148
			if (!$nls) {
2149
				$nls=$this->nls;
2150
			}
2151
			$file=$nls.".".$name;
2152
2153
			$minfresh = time();
2154
			if (isset($ARCurrent->RequestCacheControl["min-fresh"])) {
2155
				$minfresh += $ARCurrent->RequestCacheControl["min-fresh"];
2156
			}
2157
2158
			$pcache=$this->store->get_filestore("privatecache");
2159
			if ( $pcache->exists($this->id, $file) &&
2160
			     ($pcache->mtime($this->id, $file) > ($minfresh) )  ) {
2161
2162
				$result = $pcache->read($this->id, $file);
2163
2164
				$contentType = $ARCurrent->ldHeaders['content-type'];
2165
				if (preg_match('|^content-type:[ ]*([^ /]+)/|i', $contentType, $matches)) {
2166
					$contentType = $matches[1];
2167
				} else {
2168
					$contentType = '';
2169
				}
2170
2171 View Code Duplication
				if (!$contentType || strtolower($contentType) == 'text') {
2172
					require_once($this->store->get_config('code')."modules/mod_url.php");
2173
					$temp = explode('.', $file);
2174
					$imageNLS = $temp[0];
2175
					$result = URL::ARtoRAW($result, $imageNLS);
0 ignored issues
show
Unused Code introduced by
The call to URL::ARtoRAW() has too many arguments starting with $imageNLS.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2176
				}
2177
			} else {
2178
				$result=false;
2179
				$ARCurrent->cache[]=$file;
2180
				ob_start();
2181
				/* output buffering is recursive, so this won't interfere with
2182
				   normal page caching, unless you forget to call savecache()...
2183
				   so normal pagecache needs to check $ARCurrent->cache, if it's
2184
				   not empty, issue a warning and don't cache the outputbuffer...
2185
				   savecache() must then pop the stack.
2186
				*/
2187
			}
2188
		} else {
2189
			$this->error = ar::error($ARnls["err:nonamecache"], 1111);
2190
			$result = false;
2191
		}
2192
		return $result;
2193
	}
2194
2195
	public function cached($name, $nls="") {
2196
		if ($image=$this->getcache($name, $nls)) {
2197
			echo $image;
2198
			$result=true;
2199
		} else {
2200
			$result=false;
2201
		}
2202
		return $result;
2203
	}
2204
2205
	public function savecache($time="") {
2206
		global $ARCurrent, $ARnls, $DB;
2207
		$result = false;
0 ignored issues
show
Unused Code introduced by
$result is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
2208
		$this->error = '';
2209
		if (!$time) {
2210
			$time=2; // 'freshness' in hours.
2211
		}
2212
		if ($file=array_pop($ARCurrent->cache)) {
2213
			$image=ob_get_contents();
2214
			if ($image !== false) {
2215
				$result = true;
2216
				$origimage = $image;
2217
2218
				$contentType = $ARCurrent->ldHeaders['content-type'];
2219
				if (preg_match('|^content-type:[ ]*([^ /]+)/|i', $contentType, $matches)) {
2220
					$contentType = $matches[1];
2221
				} else {
2222
					$contentType = '';
2223
				}
2224
2225 View Code Duplication
				if (!$contentType || strtolower($contentType) == 'text') {
2226
					require_once($this->store->get_config('code')."modules/mod_url.php");
2227
					$temp = explode('.', $file);
2228
					$imageNLS = $temp[0];
2229
					$image = URL::RAWtoAR($image, $imageNLS);
2230
				}
2231
2232
				if( $time > 0  && $DB["wasUsed"] == 0) {
2233
					$pcache=$this->store->get_filestore("privatecache");
2234
					$pcache->write($image, $this->id, $file);
2235
					$time=time()+($time*3600);
2236 View Code Duplication
					if (!$pcache->touch($this->id, $file, $time)) {
2237
						$this->error = ar::error("savecache: ERROR: couldn't touch $file", 1113);
2238
						$result = false;
2239
					}
2240
				}
2241
				ob_end_clean();
2242
				echo $origimage;
2243
			} else {
2244
				debug("skipped saving cache - ob_get_contents returned false so output buffering was not active", "all");
2245
				$result = false;
2246
			}
2247
		} else {
2248
			$this->error = ar::error($ARnls["err:savecachenofile"], 1112);
2249
			$result = false;
2250
		}
2251
		return $result;
2252
	}
2253
2254
	public function getdatacache($name) {
2255
		global $ARCurrent, $ARnls;
2256
		$result=false;
2257
		$this->error = '';
2258
		if ($name) {
2259
2260
			$minfresh = time();
2261
			if (isset($ARCurrent->RequestCacheControl["min-fresh"])) {
2262
				$minfresh += $ARCurrent->RequestCacheControl["min-fresh"];
2263
			}
2264
2265
			$pcache=$this->store->get_filestore("privatecache");
2266
			if ( $pcache->exists($this->id, $name) &&
2267
			     ($pcache->mtime($this->id, $name) > $minfresh) ) {
2268
				$result = unserialize($pcache->read($this->id, $name));
2269
			} else {
2270
				debug("getdatacache: $name doesn't exists, returning false.","all");
2271
			}
2272
		} else {
2273
			$this->error = ar::error($ARnls["err:nonamecache"], 1111);
2274
		}
2275
		return $result;
2276
	}
2277
2278
	public function savedatacache($name,$data,$time="") {
2279
		global $DB;
2280
		$this->error = '';
2281
		if (!$time) {
2282
			$time=2; // 'freshness' in hours.
2283
		}
2284
		$pcache=$this->store->get_filestore("privatecache");
2285
		if( $time > 0  && $DB["wasUsed"] == 0) {
2286
			$pcache->write(serialize($data), $this->id, $name);
2287
			$time=time()+($time*3600);
2288 View Code Duplication
			if (!$pcache->touch($this->id, $name, $time)) {
2289
				$this->error = ar::error('Could not touch '.$name, 1113);
2290
				return false;
2291
			}
2292
		}
2293
		return true;
2294
	}
2295
2296 52
	public function getdata($varname, $nls="none", $emptyResult=false) {
0 ignored issues
show
Coding Style introduced by
getdata uses the super-global variable $_POST which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
Coding Style introduced by
getdata uses the super-global variable $_GET which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
2297
	// function to retrieve variables from $this->data, with the correct
2298
	// language version.
2299 52
	global $ARCurrent;
2300
2301 52
		$result = false;
2302 52
		if ($nls!="none") {
2303 48 View Code Duplication
			if ($ARCurrent->arCallStack) {
2304 48
				$arCallArgs=end($ARCurrent->arCallStack);
2305 48
				if (isset($arCallArgs) && is_array($arCallArgs)) {
2306 48
					extract($arCallArgs);
2307 24
				} else if (is_string($arCallArgs)) {
2308
					Parse_Str($arCallArgs);
2309
				}
2310 24
			}
2311 48
			if (isset(${$nls}[$varname])) {
2312 28
				$result=${$nls}[$varname];
2313 48
			} else if (isset($ARCurrent->$nls) && isset($ARCurrent->$nls->$varname)) {
2314
				$result=$ARCurrent->$nls->$varname;
2315 48
			} else if (($values=$_POST[$nls]) && isset($values[$varname])) {
2316
				$result=$values[$varname];
2317 48
			} else if (($values=$_GET[$nls]) && isset($values[$varname])) {
2318
				$result=$values[$varname];
2319 48
			} else if (($arStoreVars=$_POST["arStoreVars"]) && isset($arStoreVars[$nls][$varname])) {
2320
				$result=$arStoreVars[$nls][$varname];
2321 48
			} else if (($arStoreVars=$_GET["arStoreVars"]) && isset($arStoreVars[$nls][$varname])) {
2322
				$result=$arStoreVars[$nls][$varname];
2323
			}
2324 48
			if ($result===false) {
2325 48
				if (isset($this->data->${nls}) && isset($this->data->${nls}->${varname})) {
2326 36
					$result=$this->data->${nls}->${varname};
2327 12
				}
2328 24
			}
2329 24
		} else { // language independant variable.
2330 52 View Code Duplication
			if ($ARCurrent->arCallStack) {
2331 52
				$arCallArgs=end($ARCurrent->arCallStack);
2332 52
				if (isset($arCallArgs) && is_array($arCallArgs)) {
2333 48
					extract($arCallArgs);
2334 34
				} else if (is_string($arCallArgs)) {
2335
					Parse_Str($arCallArgs);
2336
				}
2337 26
			}
2338 52
			if (isset($$varname)) {
2339 24
				$result=$$varname;
2340 52
			} else if (isset($ARCurrent->$varname)) {
2341
				$result=$ARCurrent->$varname;
2342 52 View Code Duplication
			} else if (isset($_POST[$varname])) {
2343
				$result=$_POST[$varname];
2344 52
			} else if (isset($_GET[$varname])) {
2345
				$result=$_GET[$varname];
2346 52
			} else if (($arStoreVars=$_POST["arStoreVars"]) && isset($arStoreVars[$varname])) {
2347
				$result=$arStoreVars[$varname];
2348 52
			} else if (($arStoreVars=$_GET["arStoreVars"]) && isset($arStoreVars[$varname])) {
2349
				$result=$arStoreVars[$varname];
2350
			}
2351 52
			if ($result===false) {
2352 52
				if (isset($this->data->$varname)) {
2353 24
					$result=$this->data->$varname;
2354 12
				}
2355 26
			}
2356
		}
2357 52
		if ( $result === false ) {
2358 52
			$result = $emptyResult;
2359 26
		}
2360 52
		return $result;
2361
	}
2362
2363
	public function showdata($varname, $nls="none", $emptyResult=false) {
2364
		echo htmlspecialchars($this->getdata($varname, $nls, $emptyResult), ENT_QUOTES, 'UTF-8');
2365
	}
2366
2367
	public function setnls($nls) {
2368
		ldSetNls($nls);
2369
	}
2370
2371
	public function getcharset() {
2372
		return "UTF-8";
2373
	}
2374
2375
	public function HTTPRequest($method, $url, $postdata = "", $port=80 ) {
2376
		$maxtries = 5;
2377
		$tries = 0;
2378
		$redirecting = true;
2379
2380
		if(isset($postdata) && is_array($postdata)) {
2381
			foreach($postdata as $key=>$val) {
2382
				if(!is_integer($key)) {
2383
					$data .= "$key=".urlencode($val)."&";
0 ignored issues
show
Bug introduced by
The variable $data does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
2384
				}
2385
			}
2386
		} else {
2387
			$data = $postdata;
2388
		}
2389
2390
		while ($redirecting && $tries < $maxtries) {
2391
			$tries++;
2392
			// get host name and URI from URL, URI not needed though
2393
			preg_match("/^([htps]*:\/\/)?([^\/]+)(.*)/i", $url, $matches);
2394
			$host = $matches[2];
2395
			$uri = $matches[3];
2396
			if (!$matches[1]) {
2397
				$url="http://".$url;
2398
			}
2399
			$connection = @fsockopen( $host, $port, $errno, $errstr, 120);
2400
			if( $connection ) {
2401
				if( strtoupper($method) == "GET" ) {
2402
					if ($data) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $data of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2403
						$uri .= "?" . $data;
2404
					}
2405
					fputs( $connection, "GET $uri HTTP/1.0\r\n");
2406
				} else if( strtoupper($method) == "POST" ) {
2407
					fputs( $connection, "POST $uri HTTP/1.0\r\n");
2408
				} else {
2409
					fputs( $connection, "$method $uri HTTP/1.0\r\n");
2410
				}
2411
2412
				fputs( $connection, "Host: $host\r\n");
2413
				fputs( $connection, "Accept: */*\r\n");
2414
				fputs( $connection, "Accept: image/gif\r\n");
2415
				fputs( $connection, "Accept: image/x-xbitmap\r\n");
2416
				fputs( $connection, "Accept: image/jpeg\r\n");
2417
2418
				if( strtoupper($method) == "POST" ) {
2419
					$strlength = strlen( $data);
2420
					fputs( $connection, "Content-type: application/x-www-form-urlencoded\r\n" );
2421
					fputs( $connection, "Content-length: ".$strlength."\r\n\r\n");
2422
					fputs( $connection, $data."\r\n");
2423
				}
2424
2425
				fputs( $connection, "\r\n" , 2);
2426
2427
				$headerContents = '';
2428
				$headerStart = 0;
2429
				$headerEnd = 0;
2430
				$redirecting = false;
2431
2432
				while (!feof($connection)) {
2433
					$currentLine = fgets ($connection, 1024);
2434
					if ($headerEnd && $redirecting) {
2435
						break;
2436
					} else if ($headerEnd && !$redirecting) {
2437
						//this is the html from the page
2438
						$contents = $contents . $currentLine;
0 ignored issues
show
Bug introduced by
The variable $contents does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
2439
					} else if ( preg_match("/^HTTP/", $currentLine) ) {
2440
						//came to the start of the header
2441
						$headerStart = 1;
2442
						$headerContents = $currentLine;
2443
					} else if ( $headerStart && preg_match('/^[\n\r\t ]*$/', $currentLine) ) {
2444
						//came to the end of the header
2445
						$headerEnd = 1;
2446
					} else {
2447
						//this is the header, if you want it...
2448
						if (preg_match("/^Location: (.+?)\n/is",$currentLine,$matches) ) {
2449
							$headerContents .= $currentLine;
2450
							//redirects are sometimes relative
2451
							$newurl = $matches[1];
2452
							if (!preg_match("/http:\/\//i", $newurl, $matches) ) {
2453
								$url .= $newurl;
2454
							} else {
2455
								$url = $newurl;
2456
							}
2457
							//extra \r's get picked up sometimes
2458
							//i think only with relative redirects
2459
							//this is a quick fix.
2460
							$url = preg_replace("/\r/s","",$url);
2461
							$redirecting = true;
2462
						} else {
2463
							$headerContents.=$currentLine;
2464
						}
2465
					}
2466
				}
2467
			} else {
2468
				$this->error="$errstr ($errno)";
2469
				$contents=false;
2470
				$url = "";
2471
			}
2472
			@fclose($connection);
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2473
		}
2474
		if (($method!="GET") && ($method!="POST")) {
2475
			$contents=$headerContents."\n".$contents;
0 ignored issues
show
Bug introduced by
The variable $headerContents does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
2476
		}
2477
		return $contents;
2478
	}
2479
2480
	public function make_filesize( $size="" ,$precision=0) {
2481
		$suffixes = array('B','KB','MB','GB','TB','PB','EB','ZB','YB');
2482
2483
		if( $size === "" ) {
2484
			$size = $this->size;
0 ignored issues
show
Bug introduced by
The property size does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
2485
		}
2486
		while ( (count($suffixes) > 1) && ($size > 1024) ){
2487
			$size = $size / 1024;
2488
			array_shift($suffixes);
2489
		}
2490
		$size = round($size,$precision);
2491
		if($precision==0){ // compatible with the old make_filesize
2492
			$size = intval($size);
2493
		}
2494
		$result = $size." ".array_shift($suffixes);
2495
		return $result;
2496
	}
2497
2498
	public function convertToUTF8($data, $charset = "CP1252") {
2499
2500
		include_once($this->store->get_config("code")."modules/mod_unicode.php");
2501
2502
		if (isset($data) && is_array($data)) {
2503
			foreach($data as $key => $val){
2504
				$data[$key] = $this->convertToUTF8($val, $charset);
2505
			}
2506
		} else
2507
		if (is_object($data)) {
2508
			foreach($data as $key => $val){
2509
				$data->$key = $this->convertToUTF8($val, $charset);
2510
			}
2511
		} else {
2512
			$data = unicode::convertToUTF8($charset, $data);
2513
		}
2514
		return $data;
2515
	}
2516
2517 28
	public function resetloopcheck() {
2518 28
		global $ARBeenHere;
2519 28
		$ARBeenHere=array();
2520 28
	}
2521
2522
/********************************************************************
2523
2524
  "safe" functions.
2525
2526
  The following functions are safe versions of existing functions
2527
  above.
2528
  - They don't change anything in the database.
2529
    This means that to save/delete something, a user will need to call
2530
    "system.save.data.phtml" or "system.delete.phtml" which check grants.
2531
  - All functions except _get and _exists don't take a path as
2532
    argument, they use the current objects path instead.
2533
2534
  These are meant to be used by 'pinp' versions of templates,
2535
  meaning user defined templates. 'pinp' rewrites call to functions
2536
  to the form '$this->_function'.
2537
2538
  All pinp files automatically first call CheckLogin('read').
2539
2540
********************************************************************/
2541
2542
	public function _call($function, $args="") {
2543
		// remove possible path information (greedy match)
2544
		if ( !( $function instanceof \Closure ) ) {
2545
			$function = basename( (string) $function );
2546
		}
2547
		return $this->call($function, $args);
0 ignored issues
show
Bug introduced by
It seems like $function can also be of type object<Closure>; however, ariadne_object::call() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
Documentation introduced by
$args is of type string, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2548
	}
2549
2550
	public function _call_super($arCallArgs="") {
2551
	global $ARCurrent, $AR;
2552
		$context = $this->getContext();
2553
		if (!$arCallArgs) {
2554
			$arCallArgs = end($ARCurrent->arCallStack);
2555
		}
2556
		$arSuperContext  = (array)$context['arSuperContext'];
2557
		$arLibrary       = $context['arLibrary'];
2558
		$arLibraryPath   = $context['arLibraryPath'];
2559
		$arCallType      = $context['arCallTemplateType'];
2560
		$arSuperPath     = $context['arCallTemplatePath'];
2561
		$arLibrariesSeen = $context['arLibrariesSeen'];
2562
		$arCallFunction  = $arSuperFunction = $context['arCallFunction'];
2563
		if ($arLibrary) {
2564
			$arSuperFunction = str_replace($arLibrary.':', '', $arCallFunction);
2565
		}
2566
		if (strpos($arSuperFunction, "::") !== false) {
2567
			// template of a specific class defined via call("class::template");
2568
			list($arBaseType, $arSuperFunction)=explode("::", $arSuperFunction);
0 ignored issues
show
Unused Code introduced by
The assignment to $arBaseType is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
2569
		}
2570
		// remove current library path from the arLibrariesSeen array so that
2571
		// Ariadne will be able to re-enter the library and toggle the arSuperContext boolean there.
2572
		unset($arLibrariesSeen[$arLibraryPath]);
2573
		$arSuperContext[$arSuperPath.":".$arCallType.":".$arSuperFunction] = true;
2574
2575
		debug("call_super: searching for the template following (path: $arSuperPath; type: $arCallType; function: $arCallFunction) from $this->path");
2576
		// FIXME: Redirect code has to move to getPinpTemplate()
0 ignored issues
show
Coding Style introduced by
Comment refers to a FIXME task "Redirect code has to move to getPinpTemplate"
Loading history...
2577
		$redirects	= $ARCurrent->shortcut_redirect;
2578
		if (isset($redirects) && is_array($redirects)) {
2579
			$redirpath = $this->path;
2580
			while (!$template['arTemplateId'] &&
0 ignored issues
show
Bug introduced by
The variable $template does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
2581
				($redir = array_pop($redirects)) &&
2582
				$redir["keepurl"] &&
2583
				(substr($redirpath, 0, strlen($redir["dest"])) == $redir["dest"])
2584
			) {
2585
				debug("call_super: following shortcut redirect: $redirpath; to ".$redir["dest"]);
2586
				$template = $this->getPinpTemplate($arCallFunction, $redirpath, $redir["dest"], false, $arLibrariesSeen, $arSuperContext);
2587
				$redirpath = $redir['src'];
2588
			}
2589 View Code Duplication
			if (!$template["arTemplateId"]) {
2590
				$template = $this->getPinpTemplate($arCallFunction, $redirpath, '', false, $arLibrariesSeen, $arSuperContext);
2591
			}
2592
		}
2593 View Code Duplication
		if (!$template["arTemplateId"]) {
2594
			$template = $this->getPinpTemplate($arCallFunction, $this->path, '', false, $arLibrariesSeen, $arSuperContext);
2595
		}
2596
		if ($template["arCallTemplate"] && $template["arTemplateId"]) {
2597
			$exists = ar('template')->exists($template['arCallTemplatePath'],$template["arCallTemplate"]);
2598
			if ( $exists ) {
2599
				debug("call_super: found template ".$template["arCallTemplate"]." on object with id ".$template["arTemplateId"]);
2600
				$arLibrary = $template['arLibrary'];
2601
				debug("call_super: found template on ".$template["arTemplateId"]);
2602
				if (is_int($arLibrary)) {
2603
					// set the library name for unnamed libraries to 'current'
2604
					// so that calls using getvar('arLibrary') will keep on working
2605
					$arLibrary = "current";
2606
				}
2607 View Code Duplication
				if (!is_string($arCallArgs)) {
2608
					$arCallArgs['arCallFunction'] = $arCallFunction;
2609
					$arCallArgs['arLibrary'] = $arLibrary;
2610
					$arCallArgs['arLibraryPath'] = $template["arLibraryPath"];
2611
				}
2612
				$ARCurrent->arCallStack[]=$arCallArgs;
2613
				$this->pushContext(
2614
					array(
2615
						"scope"              => "pinp",
2616
						"arSuperContext"     => $arSuperContext,
2617
						"arLibrary"          => $arLibrary,
2618
						"arLibraryPath"      => $template['arLibraryPath'],
2619
						"arCallFunction"     => $arCallFunction,
2620
						"arCurrentObject"    => $this,
2621
						"arCallType"         => $template['arCallType'],
2622
						"arCallTemplateName" => $template['arCallTemplateName'],
2623
						"arCallTemplateNLS"  => $template['arCallTemplateNLS'],
2624
						"arCallTemplateType" => $template['arCallTemplateType'],
2625
						"arCallTemplatePath" => $template['arCallTemplatePath']
2626
					)
2627
				);
2628
				$continue = true;
2629
				$eventData = new object();
2630 View Code Duplication
				if ( !$AR->contextCallHandler ) { /* prevent onbeforecall from re-entering here */
2631
					$AR->contextCallHandler = true;
2632
					$eventData->arCallArgs = $arCallArgs;
0 ignored issues
show
Bug introduced by
The property arCallArgs does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
2633
					$eventData->arCallFunction = $arCallFunction;
0 ignored issues
show
Bug introduced by
The property arCallFunction does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
2634
					$eventData->arContext = $this->getContext();
0 ignored issues
show
Bug introduced by
The property arContext does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
2635
					$eventData = ar_events::fire('onbeforecall', $eventData);
0 ignored issues
show
Documentation introduced by
$eventData is of type object<object>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2636
					$ARCurrent->arResult = $eventData->arResult;
2637
					$AR->contextCallHandler = false;
2638
					$continue = ($eventData!=false);
2639
				}
2640
				if ( $continue ) {
2641
					set_error_handler(array('pobject','pinpErrorHandler'),error_reporting());
2642
					$func = ar('template')->get($template['arCallTemplatePath'],$template['arCallTemplate']);
2643
					if(is_callable($func)){
2644
						$arResult = $func($this);
2645
					}
2646
					restore_error_handler();
2647
2648 View Code Duplication
					if ( !$AR->contextCallHandler ) { /* prevent oncall from re-entering here */
2649
						$AR->contextCallHandler = true;
2650
						$temp = $ARCurrent->arResult; /* event listeners will change ARCurrent->arResult */
2651
						$eventData->arResult = $arResult;
0 ignored issues
show
Bug introduced by
The variable $arResult does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
2652
						ar_events::fire('oncall', $eventData );
2653
						$ARCurrent->arResult = $temp; /* restore correct result */
2654
						$AR->contextCallHandler = false;
2655
					}
2656
				}
2657
				array_pop($ARCurrent->arCallStack);
2658
				$this->popContext();
2659
			}
2660
		}
2661
		return $arResult;
2662
	}
2663
2664
	public function _get($path, $function="view.html", $args="") {
2665
		// remove possible path information (greedy match)
2666
		if ( !($function instanceof \Closure) ) {
2667
			$function = basename( (string) $function);
2668
		}
2669
		return $this->store->call($function, $args,
2670
			$this->store->get(
2671
				$this->make_path($path)));
2672
	}
2673
2674
	public function _call_object($object, $function, $args="") {
2675
		return $object->call($function, $args);
2676
	}
2677
2678 View Code Duplication
	public function _ls($function="list.html", $args="") {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
2679
		// remove possible path information (greedy match)
2680
		if ( ! ( $function instanceof \Closure ) ) {
2681
			$function = basename( (string) $function );
2682
		}
2683
		return $this->store->call($function, $args,
2684
			$this->store->ls($this->path));
2685
	}
2686
2687 View Code Duplication
	public function _parents($function="list.html", $args="", $top="") {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
2688
		// remove possible path information (greedy match)
2689
		if ( !($function instanceof \Closure ) ) {
2690
			$function = basename( (string) $function);
2691
		}
2692
		return $this->parents($this->path, $function, $args, $top);
2693
	}
2694
2695
	public function _find($criteria, $function="list.html", $args="", $limit=100, $offset=0) {
2696
		$this->error = '';
2697
		// remove possible path information (greedy match)
2698
		if ( !($function instanceof \Closure ) ) {
2699
			$function = basename( (string) $function);
2700
		}
2701
		$result = $this->store->call($function, $args,
2702
			$this->store->find($this->path, $criteria, $limit, $offset));
2703 View Code Duplication
		if ($this->store->error) {
2704
			$this->error = ar::error( ''.$this->store->error, 1107, $this->store->error );
2705
		}
2706
		return $result;
2707
	}
2708
2709
	public function _exists($path) {
2710
		return $this->store->exists($this->make_path($path));
2711
	}
2712
2713
	public function _implements($implements) {
2714
		return $this->AR_implements($implements);
2715
	}
2716
2717 52
	public function getvar($var) {
0 ignored issues
show
Coding Style introduced by
getvar uses the super-global variable $_POST which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
Coding Style introduced by
getvar uses the super-global variable $_GET which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
2718 52
	global $ARCurrent, $ARConfig; // Warning: if you add other variables here, make sure you cannot get at it through $$var.
2719
2720 52 View Code Duplication
		if ($ARCurrent->arCallStack) {
2721 48
			$arCallArgs=end($ARCurrent->arCallStack);
2722 48
			if (isset($arCallArgs) && is_array($arCallArgs)) {
2723 36
				extract($arCallArgs);
2724 32
			} else if (is_string($arCallArgs)) {
2725
				Parse_Str($arCallArgs);
2726
			}
2727 24
		}
2728 52
		if (isset($$var) && ($var!='ARConfig')) {
2729 16
			$result=$$var;
2730 52
		} else if (isset($ARCurrent->$var)) {
2731
			$result=$ARCurrent->$var;
2732 52
		} else if (isset($ARConfig->pinpcache[$this->path][$var])) {
2733
			$result=$ARConfig->pinpcache[$this->path][$var];
2734 52 View Code Duplication
		} else if (isset($_POST[$var])) {
2735
			$result=$_POST[$var];
2736 52
		} else if (isset($_GET[$var])) {
2737
			$result=$_GET[$var];
2738 52
		} else if (($arStoreVars=$_POST["arStoreVars"]) && isset($arStoreVars[$var])) {
2739
			$result=$arStoreVars[$var];
2740 52
		} else if (($arStoreVars=$_GET["arStoreVars"]) && isset($arStoreVars[$var])) {
2741
			$result=$arStoreVars[$var];
2742
		}
2743 52
		return $result;
2744
	}
2745
2746
	public function _getvar($var) {
2747
		return $this->getvar($var);
2748
	}
2749
2750
	public function putvar($var, $value) {
2751
		global $ARCurrent;
2752
2753
		$ARCurrent->$var=$value;
2754
	}
2755
2756
	public function _putvar($var, $value) {
2757
		return $this->putvar($var, $value);
2758
	}
2759
2760
	public function _setnls($nls) {
2761
		$this->setnls($nls);
2762
	}
2763
2764
	// not exposed to pinp for obvious reasons
2765
	public function sgKey($grants) {
2766
		global $AR;
2767
		if( !$AR->sgSalt || !$this->CheckSilent("config") ) {
2768
			return false;
2769
		}
2770
		// serialize the grants so the order does not matter, mod_grant takes care of the sorting for us
2771
		$this->_load("mod_grant.php");
2772
		$mg = new mod_grant();
2773
		$grantsarray = array();
2774
		$mg->compile($grants, $grantsarray);
2775
		$grants = serialize($grantsarray);
2776
		return sha1( $AR->sgSalt . $grants . $this->path);
2777
	}
2778
2779
	public function sgBegin($grants, $key = '', $path = '.') {
2780
		global $AR;
2781
		$result = false;
2782
		$context = $this->getContext();
2783
		$path    = $this->make_path($path);
2784
2785
		// serialize the grants so the order does not matter, mod_grant takes care of the sorting for us
2786
		$this->_load("mod_grant.php");
2787
		$mg = new mod_grant();
2788
		$grantsarray = array();
2789
		$mg->compile($grants, $grantsarray);
2790
2791
		if ($context['scope'] == 'pinp') {
2792
			$checkgrants = serialize($grantsarray);
2793
			$check = ( $AR->sgSalt ? sha1( $AR->sgSalt . $checkgrants . $path) : false ); // not using suKey because that checks for config grant
2794
		} else {
2795
			$check = true;
2796
			$key = true;
2797
		}
2798
		if( $check !== false && $check === $key ) {
2799
			$AR->user->grants = array(); // unset all grants for the current user, this makes sure GetValidGrants gets called again for this path and all childs
2800
			$grantsarray = (array)$AR->sgGrants[$path];
2801
			$mg->compile($grants, $grantsarray);
2802
			$AR->sgGrants[$path] = $grantsarray;
2803
			$result = true;
2804
		}
2805
		return $result;
2806
	}
2807
2808
	public function sgEnd($path = '.') {
2809
		global $AR;
2810
		$AR->user->grants = array(); // unset all grants for the current user, this makes sure GetValidGrants gets called again for this path and all childs
2811
		$path = $this->make_path( $path );
2812
		unset($AR->sgGrants[$path]);
2813
		return true; // temp return true;
0 ignored issues
show
Unused Code Comprehensibility introduced by
43% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
2814
	}
2815
2816
	public function sgCall($grants, $key, $function="view.html", $args="") {
2817
		$result = false;
2818
		if( $this->sgBegin($grants, $key ) ) {
2819
			$result = $this->call($function, $args);
0 ignored issues
show
Documentation introduced by
$args is of type string, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2820
			$this->sgEnd();
2821
		}
2822
		return $result;
2823
	}
2824
2825
	public function _sgBegin($grants, $key, $path = '.') {
2826
		return $this->sgBegin($grants, $key, $path);
2827
	}
2828
2829
	public function _sgEnd($path = '.') {
2830
		return $this->sgEnd($path);
2831
	}
2832
2833
	public function _sgCall($grants, $key, $function="view.html", $args="") {
2834
		return $this->sgCall($grants, $key, $function, $args);
2835
	}
2836
2837
	public function _widget($arWidgetName, $arWidgetTemplate, $arWidgetArgs="", $arWidgetType="lib") {
2838
	global $AR, $ARConfig, $ARCurrent, $ARnls;
2839
2840
		$arWidgetName=preg_replace("/[^a-zA-Z0-9\/]/","",$arWidgetName);
2841
		$arWidgetTemplate=preg_replace("/[^a-zA-Z0-9\.]/","",$arWidgetTemplate);
2842
		$wgResult=null;
2843
		if ($arWidgetType=="www") {
2844
			$coderoot=$AR->dir->root;
2845
		} else {
2846
			$coderoot=$this->store->get_config("code");
2847
		}
2848
		if (file_exists($coderoot."widgets/$arWidgetName")) {
2849
			if (file_exists($coderoot."widgets/$arWidgetName/$arWidgetTemplate")) {
2850
				if (isset($arWidgetArgs) && is_array($arWidgetArgs)) {
2851
					extract($arWidgetArgs);
2852
				} else if (is_string($arWidgetArgs)) {
2853
					Parse_str($arWidgetArgs);
2854
				}
2855
				include($coderoot."widgets/$arWidgetName/$arWidgetTemplate");
2856
			} else {
2857
				error("Template $arWidgetTemplate for widget $arWidgetName not found.");
2858
			}
2859
		} else {
2860
			error(sprintf($ARnls["err:widgetnotfound"],$arWidgetName));
2861
		}
2862
		if ($wgResult) {
2863
			return $wgResult;
2864
		}
2865
	}
2866
2867
	public function _getdata($varname, $nls="none", $emptyResult=false) {
2868
		return $this->getdata($varname, $nls, $emptyResult);
2869
	}
2870
2871
	public function _showdata($varname, $nls="none", $emptyResult=false) {
2872
		$this->showdata($varname, $nls, $emptyResult);
2873
	}
2874
2875
	public function _gettext($index=false) {
2876
	global $ARnls;
2877
		if (!$index) {
2878
			return $ARnls;
2879
		} else {
2880
			return $ARnls[$index];
2881
		}
2882
	}
2883
2884
	public function _loadtext($nls, $section="") {
2885
	global $ARnls, $ARCurrent;
2886
		if( is_object($ARnls) ) {
2887
			$ARnls->load($section, $nls);
2888
			$ARnls->setLanguage($nls);
2889
			$this->ARnls = $ARnls;
0 ignored issues
show
Bug introduced by
The property ARnls does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
2890
		} else { // older loaders and other shizzle
2891
2892
			$nls = preg_replace('/[^a-z]*/i','',$nls);
2893
			$section = preg_replace('/[^a-z0-9\._:-]*/i','',$section);
2894
			if (!$section) {
2895
				include($this->store->get_config("code")."nls/".$nls);
2896
				$this->ARnls = array_merge((array)$this->ARnls, $ARnls);
2897
			} else {
2898
				$nlsfile = $this->store->get_config("code")."nls/".$section.".".$nls;
2899
				if(strpos($nlsfile, ':') === false && file_exists($nlsfile)) {
2900
					include($nlsfile);
2901
					$this->ARnls = array_merge((array)$this->ARnls, $ARnls);
2902
				} else {
2903
					// current result;
2904
					$arResult = $ARCurrent->arResult;
2905
					$this->pushContext(array());
2906
						$oldnls = $this->reqnls;
2907
						$this->reqnls = $nls;
2908
						$this->CheckConfig($section, array('nls' => $nls));
0 ignored issues
show
Documentation introduced by
array('nls' => $nls) is of type array<string,?,{"nls":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2909
						$this->reqnls = $oldnls;
2910
					$this->popContext();
2911
					// reset current result (CheckConfig may have changed it when it should not have).
2912
					$ARCurrent->arResult = $arResult;
2913
				}
2914
			}
2915
		}
2916
	}
2917
2918
	public function _startsession() {
2919
	global $ARCurrent;
2920
		ldStartSession(0);
2921
		return $ARCurrent->session->id;
2922
	}
2923
2924
	public function _putsessionvar($varname, $varvalue) {
2925
	global $ARCurrent;
2926
2927
		if ($ARCurrent->session) {
2928
			return $ARCurrent->session->put($varname, $varvalue);
2929
		} else {
2930
			return false;
2931
		}
2932
	}
2933
2934
	public function _getsessionvar($varname) {
2935
	global $ARCurrent;
2936
2937
		if ($ARCurrent->session) {
2938
			return $ARCurrent->session->get($varname);
2939
		} else {
2940
			return false;
2941
		}
2942
	}
2943
2944
	public function _setsessiontimeout($timeout = 0) {
2945
	global $ARCurrent;
2946
		if ($ARCurrent->session) {
2947
			return $ARCurrent->session->setTimeout($timeout);
2948
		} else {
2949
			return false;
2950
		}
2951
	}
2952
2953
	public function _killsession() {
2954
	global $ARCurrent;
2955
2956
		if ($ARCurrent->session) {
2957
			$ARCurrent->session->kill();
2958
			unset($ARCurrent->session);
2959
		}
2960
	}
2961
2962
	public function _sessionid() {
2963
	global $ARCurrent;
2964
		if ($ARCurrent->session) {
2965
			return $ARCurrent->session->id;
2966
		} else {
2967
			return 0;
2968
		}
2969
	}
2970
2971
	public function _resetloopcheck() {
2972
		return $this->resetloopcheck();
2973
	}
2974
2975
	public function _make_path($path="") {
2976
		return $this->make_path($path);
2977
	}
2978
2979
	public function _make_ariadne_url($path="") {
2980
		return $this->make_ariadne_url($path);
2981
	}
2982
2983
	public function _make_url($path="", $nls=false, $session=true, $https=null, $keephost=null) {
2984
		return $this->make_url($path, $nls, $session, $https, $keephost);
2985
	}
2986
2987
	public function _make_local_url($path="", $nls=false, $session=true, $https=null) {
2988
		return $this->make_local_url($path, $nls, $session, $https);
2989
	}
2990
2991
	public function _getcache($name, $nls='') {
2992
		return $this->getcache($name, $nls);
2993
	}
2994
2995
	public function _cached($name, $nls='') {
2996
		return $this->cached($name, $nls);
2997
	}
2998
2999
	public function _savecache($time="") {
3000
		return $this->savecache($time);
3001
	}
3002
3003
	public function _getdatacache($name) {
3004
		return $this->getdatacache($name);
3005
	}
3006
3007
	public function _savedatacache($name,$data,$time="")
3008
	{
3009
		return $this->savedatacache($name,$data,$time);
3010
	}
3011
3012 56
	public function currentsite($path="", $skipRedirects = false) {
3013 56
		global $ARCurrent, $ARConfig;
3014 56
		if (!$path) {
3015 48
			$path=$this->path;
3016 24
		}
3017 56
		$config=($ARConfig->cache[$path]) ? $ARConfig->cache[$path] : $this->loadConfig($path);
3018 56
		if (!$skipRedirects && @count($ARCurrent->shortcut_redirect)) {
3019
			$redir = end($ARCurrent->shortcut_redirect);
3020
			if ($redir["keepurl"] && substr($path, 0, strlen($redir["dest"])) == $redir["dest"]) {
3021
				if (substr($config->site, 0, strlen($redir["dest"]))!=$redir["dest"]) {
3022
					// search currentsite from the reference
3023
					$config = ($ARConfig->cache[$redir['src']]) ? $ARConfig->cache[$redir['src']] : $this->loadConfig($redir['src']);
3024
				}
3025
			}
3026
		}
3027 56
		return $config->site;
3028
	}
3029
3030
	public function parentsite($site) {
3031
	global $ARConfig;
3032
		$path=$this->store->make_path($site, "..");
3033
		$config=($ARConfig->cache[$path]) ? $ARConfig->cache[$path] : $this->loadConfig($path);
3034
		return $config->site;
3035
	}
3036
3037 4 View Code Duplication
	public function currentsection($path="") {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3038 4
	global $ARConfig;
3039 4
		if (!$path) {
3040 4
			$path=$this->path;
3041 2
		}
3042 4
		$config=($ARConfig->cache[$path]) ? $ARConfig->cache[$path] : $this->loadConfig($path);
3043 4
		return $config->section;
3044
	}
3045
3046 View Code Duplication
	public function parentsection($path) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3047
	global $ARConfig;
3048
		$path=$this->store->make_path($path, "..");
3049
		$config=($ARConfig->cache[$path]) ? $ARConfig->cache[$path] : $this->loadConfig($path);
3050
		return $config->section;
3051
	}
3052
3053 24 View Code Duplication
	public function currentproject($path="") {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3054 24
	global $ARConfig;
3055 24
		if (!$path) {
3056
			$path=$this->path;
3057
		}
3058 24
		$config=($ARConfig->cache[$path]) ? $ARConfig->cache[$path] : $this->loadConfig($path);
3059 24
		return $config->project;
3060
	}
3061
3062
	public function parentproject($path) {
3063
	global $ARConfig;
3064
		$path=$this->store->make_path($path, "..");
3065
		$config=($ARConfig->cache[$path]) ? $ARConfig->cache[$path] : $this->loadConfig($path);
3066
		return $config->project;
3067
	}
3068
3069
	public function validateFormSecret() {
3070
		global $ARCurrent;
3071
		if (!$ARCurrent->session) {
3072
			return true;
3073
		}
3074
3075
		if ($ARCurrent->session && $ARCurrent->session->data && $ARCurrent->session->data->formSecret) {
3076
			$formSecret = $this->getvar("formSecret");
3077
			return ($formSecret === $ARCurrent->session->data->formSecret);
3078
		}
3079
		return false;
3080
	}
3081
3082
	public function _validateFormSecret() {
3083
		return $this->validateFormSecret();
3084
	}
3085
3086
	public function getValue($name, $nls=false) {
3087
	global $ARCurrent;
3088
		switch ($nls) {
3089
			case "none":
3090
				$result = $this->data->$name;
3091
			break;
3092
			case false:
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
3093
				$nls = $ARCurrent->nls;
3094
				if (!isset($this->data->$nls) || !isset($this->data->$nls->$name)) {
3095
					$result = $this->data->$name;
3096
					break;
3097
				}
3098
			default:
3099
				$result = $this->data->$nls->$name;
3100
		}
3101
		return $result;
3102
	}
3103
3104
	public function setValue($name, $value, $nls=false) {
3105
3106
	global $AR, $ARConfig;
3107
		if ($value === null) {
3108
			if ($nls && $nls!="none") {
3109
				unset($this->data->$nls->$name);
3110
				if (!count(get_object_vars($this->data->$nls))) {
3111
					unset($this->data->$nls);
3112
					unset($this->data->nls->list[$nls]);
3113
					if (!count($this->data->nls->list)) {
3114
						unset($this->data->nls->list);
3115
						unset($this->data->nls);
3116
					} else {
3117
						if ($this->data->nls->default == $nls) {
3118
							if ($this->data->nls->list[$ARConfig->nls->default]) {
3119
								$this->data->nls->default = $ARConfig->nls->default;
3120
							} else {
3121
								list($this->data->nls->default) = each($this->data->nls->list);
3122
							}
3123
						}
3124
					}
3125
				}
3126
			} else {
3127
				unset($this->data->$name);
3128
			}
3129
		} else
3130
		if (!$nls) {
3131
			$this->data->$name = $value;
3132
		} else {
3133
			if (!$this->data->$nls) {
3134
				$this->data->$nls = new object;
3135
				if (!$this->data->nls) {
3136
					$this->data->nls = new object;
3137
					$this->data->nls->default = $nls;
0 ignored issues
show
Bug introduced by
The property default does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
3138
				}
3139
				$this->data->nls->list[$nls] = $AR->nls->list[$nls];
0 ignored issues
show
Bug introduced by
The property list does not seem to exist in object.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
3140
			}
3141
			$this->data->$nls->$name = $value;
3142
		}
3143
	}
3144
3145
	public function showValue($name, $nls=false) {
3146
		$result = $this->getValue($name, $nls);
3147
		echo $result;
3148
		return $result;
3149
	}
3150
3151
	public function _getValue($name, $nls=false) {
3152
		return $this->getValue($name, $nls);
3153
	}
3154
3155
	public function _setValue($name, $value, $nls=false) {
3156
		return $this->setValue($name, $value, $nls);
3157
	}
3158
3159
	public function _showValue($name, $nls=false) {
3160
		return $this->showValue($name, $nls);
3161
	}
3162
3163
	public function _currentsite($path="", $skipRedirects = false) {
3164
		return $this->currentsite( $path, $skipRedirects );
3165
	}
3166
3167
	public function _parentsite($site) {
3168
		return $this->parentsite($site);
3169
	}
3170
3171
	public function _currentsection() {
3172
		return $this->currentsection();
3173
	}
3174
3175
	public function _parentsection($section) {
3176
		return $this->parentsection($section);
3177
	}
3178
3179
	public function _currentproject() {
3180
		return $this->currentproject();
3181
	}
3182
3183
	public function _parentproject($path) {
3184
		return $this->parentproject($path);
3185
	}
3186
3187
	public function _checkAdmin($user) {
3188
		return $this->CheckAdmin($user);
3189
	}
3190
3191
	public function _checkgrant($grant, $modifier=ARTHISTYPE, $path=".") {
3192
		// as this is called within a pinp template,
3193
		// all the grants are already loaded, so
3194
		// checksilent will fullfill our needs
3195
		$this->pushContext(array("scope" => "php"));
3196
			$result = $this->CheckSilent($grant, $modifier, $path);
3197
		$this->popContext();
3198
		return $result;
3199
	}
3200
3201
	public function _checkpublic($grant, $modifier=ARTHISTYPE) {
3202
3203
		return $this->CheckPublic($grant, $modifier);
3204
	}
3205
3206
	public function _getcharset() {
3207
		return $this->getcharset();
3208
	}
3209
3210
	public function _count_find($query='') {
3211
		return $this->count_find($this->path, $query);
3212
	}
3213
3214
	public function _count_ls() {
3215
		return $this->count_ls($this->path);
3216
	}
3217
3218
	public function _HTTPRequest($method, $url, $postdata = "", $port=80) {
3219
		return $this->HTTPRequest($method, $url, $postdata, $port);
3220
	}
3221
3222
	public function _make_filesize( $size="" ,$precision=0) {
3223
		return $this->make_filesize( $size ,$precision);
3224
	}
3225
3226
	public function _convertToUTF8($data, $charset = "CP1252") {
3227
		return $this->convertToUTF8($data,$charset);
3228
	}
3229
3230
	public function _getuser() {
3231
	global $AR;
3232
		if ($AR->pinp_user && $AR->pinp_user->data->login == $AR->user->data->login) {
3233
			$user = $AR->pinp_user;
3234
		} else {
3235
			$this->pushContext(array("scope" => "php"));
3236
				if ( $AR->user instanceof ariadne_object ) {
3237
					$user = current($AR->user->get(".", "system.get.phtml"));
3238
				} else {
3239
					$user = $AR->user;
3240
				}
3241
				$AR->pinp_user = $user;
3242
			$this->popContext();
3243
		}
3244
		return $user;
3245
	}
3246
3247
	public function ARinclude($file) {
3248
		include($file);
3249
	}
3250
3251 4
	public function _load($class) {
3252
		// only allow access to modules in the modules directory.
3253 4
		$class = preg_replace('/[^a-z0-9\._]/i','',$class);
3254 4
		include_once($this->store->get_config("code")."modules/".$class);
3255 4
	}
3256
3257
	public function _import($class) {
3258
		// deprecated
3259
		return $this->_load($class);
3260
	}
3261
3262 40
	public function html_to_text($text) {
3263 40
		$trans = array_flip(get_html_translation_table(HTML_ENTITIES));
3264 40
		$cb  = function($matches) use ($trans) {
3265
			return strtr($matches[1],$trans);
3266 40
		};
3267
		//strip nonbreaking space, strip script and style blocks, strip html tags, convert html entites, strip extra white space
3268 40
		$search_clean = array("%&nbsp;%i", "%<(script|style)[^>]*>.*?<\/(script|style)[^>]*>%si", "%<[\/]*[^<>]*>%Usi", "%\s+%");
3269 40
		$replace_clean = array(" ", " ", " ", " ");
3270
3271 40
		$text = preg_replace_callback(
3272 40
			"%(\&[a-zA-Z0-9\#]+;)%s",
3273 14
			$cb,
3274
			$text
3275 14
		);
3276 40
		$text = preg_replace($search_clean, $replace_clean, $text);
3277 40
		return $text;
3278
	}
3279
3280
	public function _html_to_text($text) {
3281
		return $this->html_to_text($text);
3282
	}
3283
3284
	public function _newobject($filename, $type) {
3285
		$newpath=$this->make_path($filename);
3286
		$newparent=$this->store->make_path($newpath, "..");
3287
		$data=new object;
3288
		$object=$this->store->newobject($newpath, $newparent, $type, $data);
3289
		$object->arIsNewObject=true;
3290
		return $object;
3291
	}
3292
3293
	public function _save($properties="", $vtype="") {
3294
		if (isset($properties) && is_array($properties)) {
3295
			// isn't this double work, the save function doesn this again
3296
			foreach ($properties as $prop_name => $prop) {
3297
				foreach ($prop as $prop_index => $prop_record) {
3298
					$record = array();
3299 View Code Duplication
					foreach ($prop_record as $prop_field => $prop_value) {
3300
						switch (gettype($prop_value)) {
3301
							case "integer":
3302
							case "boolean":
3303
							case "double":
3304
								$value = $prop_value;
3305
							break;
3306
							default:
3307
								$value = $prop_value;
3308
								if (substr($prop_value, 0, 1) === "'" && substr($prop_value, -1) === "'"
3309
										&& "'".AddSlashes(StripSlashes(substr($prop_value, 1, -1)))."'" == $prop_value) {
3310
									$value = stripSlashes(substr($prop_value,1,-1));
3311
									// todo add deprecated warning
3312
								}
3313
						}
3314
						$record[$prop_field] = $value;
3315
					}
3316
					$properties[$prop_name][$prop_index] = $record;
3317
				}
3318
			}
3319
		}
3320
3321
		if ($this->arIsNewObject && $this->CheckSilent('add', $this->type)) {
3322
			unset($this->data->config);
3323
			$result = $this->save($properties, $vtype);
0 ignored issues
show
Bug introduced by
It seems like $properties can also be of type array or null; however, ariadne_object::save() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
3324
		} else if (!$this->arIsNewObject && $this->CheckSilent('edit', $this->type)) {
3325
			$this->data->config = current($this->get('.', 'system.get.data.config.phtml'));
3326
			$result = $this->save($properties, $vtype);
0 ignored issues
show
Bug introduced by
It seems like $properties can also be of type array or null; however, ariadne_object::save() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
3327
		}
3328
		return $result;
0 ignored issues
show
Bug introduced by
The variable $result does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
3329
	}
3330
3331
	public function _is_supported($feature) {
3332
		return $this->store->is_supported($feature);
3333
	}
3334
3335
	/*
3336
		since the preg_replace() function is able to execute normal php code
3337
		we have to intercept all preg_replace() calls and parse the
3338
		php code with the pinp parser.
3339
	*/
3340
3341
3342
	/*	this is a private function used by the _preg_replace wrapper */
3343
	// FIXME: remove this function when the minimal php version for ariadne is raised to php 7.0
0 ignored issues
show
Coding Style introduced by
Comment refers to a FIXME task "remove this function when the minimal php version for ariadne is raised to php 7.0"
Loading history...
3344
	protected function preg_replace_compile($pattern, $replacement) {
3345
	global $AR;
3346
		include_once($this->store->get_config("code")."modules/mod_pinp.phtml");
3347
		preg_match("/^\s*(.)/", $pattern, $regs);
3348
		$delim = $regs[1];
3349
		if (@eregi("\\${delim}[^$delim]*\\${delim}.*e.*".'$', $pattern)) {
3350
			$pinp = new pinp($AR->PINP_Functions, 'local->', '$AR_this->_');
3351
			return substr($pinp->compile("<pinp>$replacement</pinp>"), 5, -2);
3352
		} else {
3353
			return $replacement;
3354
		}
3355
	}
3356
3357
	public function _preg_replace($pattern, $replacement, $text, $limit = -1) {
3358
		if (version_compare(PHP_VERSION, '7.0.0', '<')) {
3359
			if (isset($pattern) && is_array($pattern)) {
3360
				$newrepl = array();
3361
				reset($replacement);
3362
				foreach ($pattern as $i_pattern) {
3363
					list(, $i_replacement) = each($replacement);
3364
					$newrepl[] = $this->preg_replace_compile($i_pattern, $i_replacement);
3365
				}
3366
			} else {
3367
				$newrepl = $this->preg_replace_compile($pattern, $replacement);
3368
			}
3369
		} else {
3370
			// php7 is safe, no more eval
3371
			$newrepl = $replacement;
3372
		}
3373
		return preg_replace($pattern, $newrepl, $text, $limit);
3374
	}
3375
3376
	/* ob_start accepts a callback but we don't want that
3377
	 * this wrapper removes the arguments from the ob_start call
3378
	 */
3379
	public function _ob_start() {
3380
		return ob_start();
3381
	}
3382
3383
	public function _loadConfig($path='') {
3384
		return clone $this->loadConfig($path);
3385
	}
3386
3387
	public function _loadUserConfig($path='') {
3388
		return $this->loadUserConfig($path);
3389
	}
3390
3391
	public function _loadLibrary($name, $path) {
3392 4
		return $this->loadLibrary($name, $path);
3393
	}
3394
3395
	public function _resetConfig($path='') {
3396
		return $this->resetConfig($path);
3397
	}
3398
3399
	public function _getLibraries($path = '') {
3400
		return $this->getLibraries($path);
3401
	}
3402
3403
3404
	public function _getSetting($setting) {
3405
	global $AR;
3406
3407
		switch ($setting) {
3408
			case 'www':
3409
			case 'dir:www':
3410
				return $AR->dir->www;
3411
			case 'images':
3412
			case 'dir:images':
3413
				return $AR->dir->images;
3414
			case 'ARSessionKeyCheck':
3415
				$result = null;
3416
				if (function_exists('ldGenerateSessionKeyCheck')) {
3417
					$result = ldGenerateSessionKeyCheck();
3418
				}
3419
				return $result;
3420
			break;
3421
			case 'nls:list':
3422
				return $AR->nls->list;
3423
			break;
3424
			case 'nls:default':
3425
				return $AR->nls->default;
3426
			break;
3427
			case 'svn':
3428
				return $AR->SVN->enabled;
3429
			break;
3430
		}
3431
	}
3432
3433
	public function __call($name,$arguments) {
3434
		if ( $name[0] == '_' ) {
3435
			$fname = substr($name, 1);
3436
			if ( isset($this->{$fname}) && $this->{$fname} instanceof \Closure ) {
3437
				\Closure::bind( $this->{$fname}, $this );
3438
				return call_user_func_array( $this->{$fname}, $arguments);
3439
			}
3440
		}
3441
		switch($name) {
3442
			case "implements":
3443
				return $this->AR_implements($arguments[0]);
3444
			break;
3445
			default:
3446
				trigger_error(sprintf('Call to undefined function: %s::%s().', get_class($this), $name), E_USER_ERROR);
3447
				return false;
3448
			break;
3449
		}
3450
	}
3451
3452
	static public function pinpErrorHandler($errno, $errstr, $errfile, $errline, $errcontext) {
0 ignored issues
show
Unused Code introduced by
The parameter $errfile is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $errcontext is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Coding Style introduced by
As per PSR2, the static declaration should come after the visibility declaration.
Loading history...
3453 5
		global $nocache;
3454 5
		if (($errno & error_reporting()) == 0) {
3455 5
			return true;
3456
		}
3457
3458
		$nocache = true;
3459
		$context = pobject::getContext();
3460
		if ($context["arLibraryPath"]) { //  != null) {
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
3461
			$msg = "Error on line $errline in ".$context['arCallTemplateType'].'::'.$context['arCallFunction'] ." in library ".$context["arLibraryPath"] ."\n".$errstr."\n";
3462
		} else {
3463
			$msg = "Error on line $errline in ".$context['arCallTemplateType'].'::'.$context['arCallFunction'] ." on object ".$context['arCurrentObject']->path."\n".$errstr."\n";
3464
		}
3465
		$display = ini_get('display_errors');
3466
3467
		if($display) {
3468
			echo $msg;
3469
		}
3470
		error_log($msg);
3471
3472
		return false;
3473
	}
3474
3475
} // end of ariadne_object class definition
3476