PidFileHandler::setSystemLoggers() - Code Metrics - Inspection of "Fix Call to a member function getSystemLogger() on..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fe191c...d6f97a )

unknown

created 2021-06-08 16:34 UTC

PidFileHandler::setSystemLoggers() A

↳ Parent: PidFileHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

/**
 * TechDivision\Import\Handlers\PidFileHandler
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2020 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Handlers;

use Doctrine\Common\Collections\Collection;
use TechDivision\Import\Configuration\ConfigurationInterface;
use TechDivision\Import\Exceptions\LineNotFoundException;
use TechDivision\Import\Exceptions\FileNotFoundException;
use TechDivision\Import\Exceptions\ImportAlreadyRunningException;
use TechDivision\Import\SystemLoggerTrait;

/**
 * A PID file handler implementation.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2020 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */
class PidFileHandler implements PidFileHandlerInterface
{

    use SystemLoggerTrait;

    /**
     * The filehandle for the PID file.
     *
     * @var resource
     */
    private $fh;

    /**
     * The PID for the running processes.
     *
     * @var array
     */
    private $pid;

    /**
     * The system configuration.
     *
     * @var \TechDivision\Import\Configuration\ConfigurationInterface
     */
    private $configuration;

    /**
     * The generic file handler instance.
     *
     * @var \TechDivision\Import\Handlers\GenericFileHandlerInterface
     */
    private $genericFileHandler;

    /**
     * Initializes the file handler instance.
     *
     * @param \TechDivision\Import\Configuration\ConfigurationInterface $configuration      The actual configuration instance
     * @param \TechDivision\Import\Handlers\GenericFileHandlerInterface $genericFileHandler The actual file handler instance
     * @param \Doctrine\Common\Collections\Collection                   $systemLoggers      The array with the system logger instances
     */
    public function __construct(
        ConfigurationInterface $configuration,
        GenericFileHandlerInterface $genericFileHandler,
        Collection $systemLoggers = null
    ) {
        $this->configuration = $configuration;
        $this->genericFileHandler = $genericFileHandler;
        if ($systemLoggers) {
            $this->setSystemLoggers($systemLoggers);
        }
    }

    /**
     * The array with the system loggers.
     *
     * @param \Doctrine\Common\Collections\Collection $systemLoggers The system logger instances
     *
     * @return void
     */
    public function setSystemLoggers(Collection $systemLoggers)
    {
        $this->systemLoggers = $systemLoggers;

    }

    /**
     * Return's the system configuration.
     *
     * @return \TechDivision\Import\Configuration\ConfigurationInterface The system configuration
     */
    protected function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * Return's the generic file handler instance.
     *
     * @return \TechDivision\Import\Handlers\GenericFileHandlerInterface The generic file handler instance
     */
    protected function getGenericFileHandler()
    {
        return $this->genericFileHandler;
    }

    /**
     * Return's the PID filename to use.
     *
     * @return string The PID filename
     */
    protected function getPidFilename()
    {
        return $this->getConfiguration()->getPidFilename();
    }

    /**
     * Return's the unique serial for this import process.
     *
     * @return string The unique serial
     */
    protected function getSerial()
    {
        return $this->getConfiguration()->getSerial();
    }

    /**
     * Remove's the passed line from the file with the passed name.
     *
     * @param string   $line The line to be removed
     * @param resource $fh   The file handle of the file the line has to be removed
     *
     * @return void
     * @throws \Exception Is thrown, if the file doesn't exists, the line is not found or can not be removed
     */
    protected function removeLineFromFile($line, $fh)
    {
        return $this->getGenericFileHandler()->removeLineFromFile($line, $fh);
    }

    /**
     * Persist the UUID of the actual import process to the PID file.
     *
     * @return void
     * @throws \Exception Is thrown, if the PID can not be locked or the PID can not be added
     * @throws \TechDivision\Import\Exceptions\ImportAlreadyRunningException Is thrown, if a import process is already running
     */
    public function lock()
    {

        // query whether or not, the PID has already been set
        if ($this->pid === $this->getSerial()) {
            return;
        }

        // if not, initialize the PID
        $this->pid = $this->getSerial();


        // open the PID file
        $this->fh = fopen($filename = $this->getPidFilename(), 'a+');

        // try to lock the PID file exclusive
        if (!flock($this->fh, LOCK_EX|LOCK_NB)) {
            throw new ImportAlreadyRunningException(sprintf('PID file %s is already in use', $filename));
        }

        // append the PID to the PID file
        if (fwrite($this->fh, $this->pid . PHP_EOL) === false) {
            throw new \Exception(sprintf('Can\'t write PID %s to PID file %s', $this->pid, $filename));
        }
    }

    /**
     * Remove's the UUID of the actual import process from the PID file.
     *
     * @return void
     * @throws \Exception Is thrown, if the PID can not be removed
     */
    public function unlock()
    {
        try {
            // remove the PID from the PID file if set
            if ($this->pid === $this->getSerial() && is_resource($this->fh)) {
                // remove the PID from the file
                $this->removeLineFromFile($this->pid, $this->fh);

                // finally unlock/close the PID file
                flock($this->fh, LOCK_UN);
                fclose($this->fh);

                // if the PID file is empty, delete the file
                if (filesize($filename = $this->getPidFilename()) === 0) {
                    unlink($filename);
                }
            }
        } catch (FileNotFoundException $fnfe) {
            $this->getSystemLogger()->notice(sprintf('PID file %s doesn\'t exist', $this->getPidFilename()));
        } catch (LineNotFoundException $lnfe) {
            $this->getSystemLogger()->notice(sprintf('PID %s is can not be found in PID file %s', $this->pid, $this->getPidFilename()));
        } catch (\Exception $e) {
            throw new \Exception(sprintf('Can\'t remove PID %s from PID file %s', $this->pid, $this->getPidFilename()), null, $e);
        }
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Handlers\PidFileHandler
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2020 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Handlers;
22
23			use Doctrine\Common\Collections\Collection;
24			use TechDivision\Import\Configuration\ConfigurationInterface;
25			use TechDivision\Import\Exceptions\LineNotFoundException;
26			use TechDivision\Import\Exceptions\FileNotFoundException;
27			use TechDivision\Import\Exceptions\ImportAlreadyRunningException;
28			use TechDivision\Import\SystemLoggerTrait;
29
30			/**
31			* A PID file handler implementation.
32			*
33			* @author Tim Wagner <[email protected]>
34			* @copyright 2020 TechDivision GmbH <[email protected]>
35			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
36			* @link https://github.com/techdivision/import
37			* @link http://www.techdivision.com
38			*/
39			class PidFileHandler implements PidFileHandlerInterface
40			{
41
42			use SystemLoggerTrait;
43
44			/**
45			* The filehandle for the PID file.
46			*
47			* @var resource
48			*/
49			private $fh;
50
51			/**
52			* The PID for the running processes.
53			*
54			* @var array
55			*/
56			private $pid;
57
58			/**
59			* The system configuration.
60			*
61			* @var \TechDivision\Import\Configuration\ConfigurationInterface
62			*/
63			private $configuration;
64
65			/**
66			* The generic file handler instance.
67			*
68			* @var \TechDivision\Import\Handlers\GenericFileHandlerInterface
69			*/
70			private $genericFileHandler;
71
72			/**
73			* Initializes the file handler instance.
74			*
75			* @param \TechDivision\Import\Configuration\ConfigurationInterface $configuration The actual configuration instance
76			* @param \TechDivision\Import\Handlers\GenericFileHandlerInterface $genericFileHandler The actual file handler instance
77			* @param \Doctrine\Common\Collections\Collection $systemLoggers The array with the system logger instances
78			*/
79			public function __construct(
80			ConfigurationInterface $configuration,
81			GenericFileHandlerInterface $genericFileHandler,
82			Collection $systemLoggers = null
83			) {
84			$this->configuration = $configuration;
85			$this->genericFileHandler = $genericFileHandler;
86			if ($systemLoggers) {
87			$this->setSystemLoggers($systemLoggers);
88			}
89			}
90
91			/**
92			* The array with the system loggers.
93			*
94			* @param \Doctrine\Common\Collections\Collection $systemLoggers The system logger instances
95			*
96			* @return void
97			*/
98			public function setSystemLoggers(Collection $systemLoggers)
99			{
100			$this->systemLoggers = $systemLoggers;
			0 ignored issues – show Documentation Bug introduced 2021-06-08 16:36 UTC by Report Bug Copy Issue Report It seems like `$systemLoggers` of type `object<Doctrine\Common\Collections\Collection>` is incompatible with the declared type `array` of property `$systemLoggers`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
101			}
102
103			/**
104			* Return's the system configuration.
105			*
106			* @return \TechDivision\Import\Configuration\ConfigurationInterface The system configuration
107			*/
108			protected function getConfiguration()
109			{
110			return $this->configuration;
111			}
112
113			/**
114			* Return's the generic file handler instance.
115			*
116			* @return \TechDivision\Import\Handlers\GenericFileHandlerInterface The generic file handler instance
117			*/
118			protected function getGenericFileHandler()
119			{
120			return $this->genericFileHandler;
121			}
122
123			/**
124			* Return's the PID filename to use.
125			*
126			* @return string The PID filename
127			*/
128			protected function getPidFilename()
129			{
130			return $this->getConfiguration()->getPidFilename();
131			}
132
133			/**
134			* Return's the unique serial for this import process.
135			*
136			* @return string The unique serial
137			*/
138			protected function getSerial()
139			{
140			return $this->getConfiguration()->getSerial();
141			}
142
143			/**
144			* Remove's the passed line from the file with the passed name.
145			*
146			* @param string $line The line to be removed
147			* @param resource $fh The file handle of the file the line has to be removed
148			*
149			* @return void
150			* @throws \Exception Is thrown, if the file doesn't exists, the line is not found or can not be removed
151			*/
152			protected function removeLineFromFile($line, $fh)
153			{
154			return $this->getGenericFileHandler()->removeLineFromFile($line, $fh);
155			}
156
157			/**
158			* Persist the UUID of the actual import process to the PID file.
159			*
160			* @return void
161			* @throws \Exception Is thrown, if the PID can not be locked or the PID can not be added
162			* @throws \TechDivision\Import\Exceptions\ImportAlreadyRunningException Is thrown, if a import process is already running
163			*/
164			public function lock()
165			{
166
167			// query whether or not, the PID has already been set
168			if ($this->pid === $this->getSerial()) {
169			return;
170			}
171
172			// if not, initialize the PID
173			$this->pid = $this->getSerial();
			0 ignored issues – show Documentation Bug introduced 2020-04-03 16:23 UTC by Report Bug Copy Issue Report It seems like `$this->getSerial()` of type `string` is incompatible with the declared type `array` of property `$pid`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
174
175			// open the PID file
176			$this->fh = fopen($filename = $this->getPidFilename(), 'a+');
177
178			// try to lock the PID file exclusive
179			if (!flock($this->fh, LOCK_EX\|LOCK_NB)) {
180			throw new ImportAlreadyRunningException(sprintf('PID file %s is already in use', $filename));
181			}
182
183			// append the PID to the PID file
184			if (fwrite($this->fh, $this->pid . PHP_EOL) === false) {
185			throw new \Exception(sprintf('Can\'t write PID %s to PID file %s', $this->pid, $filename));
186			}
187			}
188
189			/**
190			* Remove's the UUID of the actual import process from the PID file.
191			*
192			* @return void
193			* @throws \Exception Is thrown, if the PID can not be removed
194			*/
195			public function unlock()
196			{
197			try {
198			// remove the PID from the PID file if set
199			if ($this->pid === $this->getSerial() && is_resource($this->fh)) {
200			// remove the PID from the file
201			$this->removeLineFromFile($this->pid, $this->fh);
202
203			// finally unlock/close the PID file
204			flock($this->fh, LOCK_UN);
205			fclose($this->fh);
206
207			// if the PID file is empty, delete the file
208			if (filesize($filename = $this->getPidFilename()) === 0) {
209			unlink($filename);
210			}
211			}
212			} catch (FileNotFoundException $fnfe) {
213			$this->getSystemLogger()->notice(sprintf('PID file %s doesn\'t exist', $this->getPidFilename()));
214			} catch (LineNotFoundException $lnfe) {
215			$this->getSystemLogger()->notice(sprintf('PID %s is can not be found in PID file %s', $this->pid, $this->getPidFilename()));
216			} catch (\Exception $e) {
217			throw new \Exception(sprintf('Can\'t remove PID %s from PID file %s', $this->pid, $this->getPidFilename()), null, $e);
218			}
219			}
220			}
221

techdivision / import

Push — master ( fe191c...d6f97a )

PidFileHandler::setSystemLoggers() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like