LockingIterator::unlock() - Code Metrics - Inspection of "Made LockingIterator exception safe" - SuRaMoN/itertools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cf02ee...931a03 )

by SuRaMoN

created 2016-06-29 09:28 UTC

LockingIterator::unlock() A

↳ Parent: LockingIterator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	2

Metric	Value
c	4
b	0
f	2
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	0

<?php

namespace itertools;

use ArrayIterator;
use Exception;
use IteratorIterator;

class LockingIterator extends IteratorIterator
{
    protected $lockFp;
    protected $dir;
    protected $lockNameMapper;

    public function __construct($iterable, $dir, $lockNameMapper = null)
    {
        parent::__construct(IterUtil::asTraversable($iterable));
        $this->dir = $dir;
        $this->lockNameMapper = $lockNameMapper;
    }

    protected function lock($name)
    {
        @mkdir($this->dir, 0777, true);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        if (! is_dir($this->dir) || ! is_writable($this->dir)) {
            throw new Exception("Could not create directory '{$this->dir}' to store lock files");
        }
        $this->lockFp = fopen("{$this->dir}/$name", 'w+');
        if (false === $this->lockFp) {
            throw new Exception("Error while trying to open lockfile '{$this->dir}/$name'");
        }
        $flockStatus = flock($this->lockFp, LOCK_EX);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if (false === $this->flockStatus) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            throw new Exception("Error while trying to lock file '{$this->dir}/$name'");
        }
    }

    protected function unlock()
    {
        flock($this->lockFp, LOCK_UN);
        fclose($this->lockFp);
        $this->lockFp = null;
    }

    public function current()
    {
        $current = parent::current();
        if ($this->lockFp === null) {
            $this->lock($this->getLockName($current));
        }
        return $current;
    }

    protected function getLockName($current)
    {
        if (null === $this->lockNameMapper) {
            return $current;
        }
        return call_user_func($this->lockNameMapper, $current);
    }
    

    public function next()
    {
        if ($this->lockFp !== null) {
            $this->unlock();
        }
        parent::next();
    }
}

 


1			<?php
2
3			namespace itertools;
4
5			use ArrayIterator;
6			use Exception;
7			use IteratorIterator;
8
9			class LockingIterator extends IteratorIterator
10			{
11			protected $lockFp;
12			protected $dir;
13			protected $lockNameMapper;
14
15			public function __construct($iterable, $dir, $lockNameMapper = null)
16			{
17			parent::__construct(IterUtil::asTraversable($iterable));
18			$this->dir = $dir;
19			$this->lockNameMapper = $lockNameMapper;
20			}
21
22			protected function lock($name)
23			{
24			@mkdir($this->dir, 0777, true);
			0 ignored issues – show Security Best Practice introduced 2015-11-27 15:17 UTC by Report Bug Copy Issue Report 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...
25			if (! is_dir($this->dir) \|\| ! is_writable($this->dir)) {
26			throw new Exception("Could not create directory '{$this->dir}' to store lock files");
27			}
28			$this->lockFp = fopen("{$this->dir}/$name", 'w+');
29			if (false === $this->lockFp) {
30			throw new Exception("Error while trying to open lockfile '{$this->dir}/$name'");
31			}
32			$flockStatus = flock($this->lockFp, LOCK_EX);
			0 ignored issues – show Unused Code introduced 2016-06-29 09:31 UTC by Report Bug Copy Issue Report `$flockStatus` 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...
33			if (false === $this->flockStatus) {
			0 ignored issues – show Bug introduced 2016-06-29 09:31 UTC by Report Bug Copy Issue Report The property `flockStatus` 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...
34			throw new Exception("Error while trying to lock file '{$this->dir}/$name'");
35			}
36			}
37
38			protected function unlock()
39			{
40			flock($this->lockFp, LOCK_UN);
41			fclose($this->lockFp);
42			$this->lockFp = null;
43			}
44
45			public function current()
46			{
47			$current = parent::current();
48			if ($this->lockFp === null) {
49			$this->lock($this->getLockName($current));
50			}
51			return $current;
52			}
53
54			protected function getLockName($current)
55			{
56			if (null === $this->lockNameMapper) {
57			return $current;
58			}
59			return call_user_func($this->lockNameMapper, $current);
60			}
61
62
63			public function next()
64			{
65			if ($this->lockFp !== null) {
66			$this->unlock();
67			}
68			parent::next();
69			}
70			}
71
72
73

SuRaMoN / itertools

Push — master ( cf02ee...931a03 )

LockingIterator::unlock() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like