class.tx_caretakerinstance_CheckPathTestService.php

<?php
/***************************************************************
 * Copyright notice
 *
 * (c) 2009-2011 by n@work GmbH and networkteam GmbH
 *
 * All rights reserved
 *
 * This script is part of the Caretaker project. The Caretaker project
 * is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The GNU General Public License can be found at
 * http://www.gnu.org/copyleft/gpl.html.
 *
 * This script is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * This is a file of the caretaker project.
 * http://forge.typo3.org/projects/show/extension-caretaker
 *
 * Project sponsored by:
 * n@work GmbH - http://www.work.de
 * networkteam GmbH - http://www.networkteam.com/
 *
 * $Id$
 */

/**
 * Check for TYPO3 version
 *
 * @author Felix Oertel <oertel@networkteam.com>
 *
 */
class tx_caretakerinstance_CheckPathTestService extends tx_caretakerinstance_RemoteTestServiceBase
{
    /**
     * @return tx_caretaker_TestResult
     */
    public function runTest()
    {
        // fetch config values
        $paths = $this->getConfigValue('cppaths');
        $inverse = $this->getConfigValue('cpinverse');
        $type = $this->getConfigValue('cptype');
        $time = intval($this->getConfigValue('cptime'));
        $fileAgeShouldBe = $this->getConfigValue('cptimeflag');

        // catch required fields
        if (!$paths) {
            return tx_caretaker_TestResult::create(tx_caretaker_Constants::state_undefined, 0, 'Cannot test without path.');
        }

        // prepare tests
        $paths = explode(chr(10), $paths);
        foreach ($paths as $path) {
            $operations[] = array('CheckPathExists', $path);
        }
        // run
        $commandResult = $this->executeRemoteOperations($operations);

        // catch errors
        if (!$this->isCommandResultSuccessful($commandResult)) {
            return $this->getFailedCommandResultTestResult($commandResult);
        }

        // process resultset
        $resultset = $commandResult->getOperationResults();
        foreach ($resultset as $result) {
            $resValue = $result->getValue();

            if (!$result->isSuccessful() && !$inverse) {
                $msg[] = $resValue['path'] . ' does not exist';
                $resultState = tx_caretaker_Constants::state_error;
            } elseif ($result->isSuccessful() && $inverse) {
                $msg[] = $resValue['path'] . ' does exist';
                $resultState = tx_caretaker_Constants::state_error;
            } elseif ($result->isSuccessful() && $type && ($type != $resValue['type'])) {
                $msg[] = $resValue['path'] . ' exists, but is a ' . $resValue['type'];
                $resultState = tx_caretaker_Constants::state_error;
            }

            if ($fileAgeShouldBe != '' && $time != 0 && $result->isSuccessful()) {
                if ($resValue['time'] == 0) {
                    $msg[] = 'Seems like the caretaker_instance can\'t report the file modification time.';
                    $resultState = max($resultState, tx_caretaker_Constants::state_warning);
                } else {
                    $fileIsYounger = ((time() - $resValue['time']) < $time);
                    if (($fileAgeShouldBe == 'younger' && $fileIsYounger)
                        || ($fileAgeShouldBe == 'older' && !$fileIsYounger)
                    ) {
                        $resultState = tx_caretaker_Constants::state_error;
                        $msg[] = $resValue['path'] . ' is ' . ($fileIsYounger ? 'younger' : 'older') . ' than ' . $time . ' seconds';
                    } elseif ($inverse) {
                        // if we do time checks, the file exists, but it should not ($inverse), it's only a warning
                        $resultState = tx_caretaker_Constants::state_warning;
                    }
                }
            }
        }

        if (is_array($msg)) {
            return tx_caretaker_TestResult::create(
                $resultState,
                0,
                implode(chr(10), $msg)
            );
        }
        return tx_caretaker_TestResult::create(tx_caretaker_Constants::state_ok, 1);
    }
}