itertools\LockingIterator

Complexity

Total Complexity

13

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	5
Bugs	1	Features	2

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	lock()	0	15	5
A	unlock()	0	6	1
A	current()	0	8	2
A	getLockName()	0	7	2
A	next()	0	7	2

<?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);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        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);

$flockStatus is not used, you could remove the assignment.

        if (false === $this->flockStatus) {

The property flockStatus does not exist. Did you maybe forget to declare it?

            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();
    }
}