processmaker-files/workflow/engine/src/ProcessMaker/Policies/ControlUnderUpdating.php

<?php

namespace ProcessMaker\Policies;

use \Luracast\Restler\iAuthenticate;
use \Luracast\Restler\RestException;

/**
 * ControlUnderUpdating sends an error signal 503 to report that the application 
 * is in update.
 */
class ControlUnderUpdating implements iAuthenticate
{

    /**
     * Access verification method.
     *
     * API access will be denied when this method returns false
     *
     * @return boolean true when api access is allowed false otherwise
     * @throws RestException
     */
    public function __isAllowed()
    {
        $response = true;
        self::verifyUnderUpgrading();
        return $response;
    }

    /**
     * Required by interface iAuthenticate 
     * @return string string to be used with WWW-Authenticate header
     * @example Basic
     * @example Digest
     * @example OAuth
     * @return string
     */
    public function __getWWWAuthenticateString()
    {
        return '';
    }

    /**
     * Verify under upgrading, if the state is under update an exception is 
     * thrown of type RestException.
     * @throws RestException
     */
    public static function verifyUnderUpgrading()
    {
        $underUpdating = \Bootstrap::isPMUnderUpdating();
        if ($underUpdating['action']) {
            $sysTemp = true;
            if (defined('SYS_TEMP')) {
                $sysTemp = $underUpdating['workspace'] == SYS_TEMP;
            }
            if ($underUpdating['workspace'] == 'true' || $sysTemp) {
                $message = 'The server is currently unable to handle the request '
                        . 'due to temporary overloading or server maintenance ('
                        . 'an application update has probably been performed on '
                        . 'the server)';
                throw new RestException(503, $message);
            }
        }
    }

}