<?php

/*
+---------------------------------------------------------------------------+
| Revive Adserver                                                           |
| http://www.revive-adserver.com                                            |
|                                                                           |
| Copyright: See the COPYRIGHT.txt file.                                    |
| License: GPLv2 or later, see the LICENSE.txt file.                        |
+---------------------------------------------------------------------------+
*/

/**
 * @package    OpenXDll
 */

// Required permission class
require_once MAX_PATH . '/lib/OA/Permission.php';

// Required parent class
require_once MAX_PATH . '/lib/OA/BaseObjectWithErrors.php';
require_once MAX_PATH . '/lib/pear/Date.php';


// Standard statuses
define('OA_ENTITY_STATUS_RUNNING', 0);
define('OA_ENTITY_STATUS_PAUSED', 1);
define('OA_ENTITY_STATUS_AWAITING', 2);
define('OA_ENTITY_STATUS_EXPIRED', 3);
define('OA_ENTITY_STATUS_INACTIVE', 4);

// Special status which has always to be used when the entity is inactive for a remote reason
define('OA_ENTITY_STATUS_PENDING', 10);

// Advertiser signup statuses
define('OA_ENTITY_STATUS_APPROVAL', 21);
define('OA_ENTITY_STATUS_REJECTED', 22);


/**
 *
 * Base class for all Domain Logical Layer classes.
 *
 */
class OA_Dll extends OA_BaseObjectWithErrors
{
    public $aAllowTraffickerAndAbovePerm = [
        OA_ACCOUNT_MANAGER,
        OA_ACCOUNT_TRAFFICKER,
    ];
    public $aAllowAdvertiserAndAbovePerm = [
        OA_ACCOUNT_MANAGER,
        OA_ACCOUNT_ADVERTISER,
    ];

    /**
     * Email Address Validation.
     *
     * @access public
     *
     * @param string $emailAddress  Email Address
     *
     * @return boolean  Returns true if email is valid and false in other case.
     */
    public function checkEmail($emailAddress)
    {
        // Regex borrowed from HTML_QuickForm_Rule_Email
        if (!preg_match('/^((\"[^\"\f\n\r\t\v\b]+\")|([\w\!\#\$\%\&\'\*\+\-\~\/\^\`\|\{\}]+(\.[\w\!\#\$\%\&\'\*\+\-\~\/\^\`\|\{\}]+)*))@((\[(((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9])))\])|(((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9])))|((([A-Za-z0-9\-])+\.)+[A-Za-z\-]+))$/D', $emailAddress)) {
            $this->raiseError('Email is not valid');
            return false;
        }
        return true;
    }

    /**
     * Checks required string field in structure.
     *
     * @access public
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     * @param integer $maxLength      Max length of the field. If -1 -
     *                                  there is no maximum length
     *
     * @return boolean  Returns true when field exists and length is valid and
     * false in other case.
     */
    public function checkStructureRequiredStringField(&$oStructure, $fieldName, $maxLength = -1)
    {
        if (!isset($oStructure->$fieldName)) {
            $this->raiseError('Field \'' . $fieldName . '\' in structure does not exists');
            return false;
        }

        if (empty($oStructure->$fieldName)) {
            $this->raiseError('Data \'' . $fieldName . '\' in structure is empty');
            return false;
        }
        return $this->checkStructureNotRequiredStringField($oStructure, $fieldName, $maxLength);
    }

    /**
     * Checks not required string field in structure.
     *
     * @access public
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     * @param integer $maxLength      Max length of the field. If -1 -
     *                                 there is no maximum length
     *
     * @return boolean  Returns true when field exists and length is valid.
     *          Also returns true when field doesn't exist and false in other case.
     */
    public function checkStructureNotRequiredStringField(&$oStructure, $fieldName, $maxLength = -1)
    {
        if (isset($oStructure->$fieldName)) {
            if (!is_string($oStructure->$fieldName)) {
                $this->raiseError('Field \'' . $fieldName . '\' is not string');
                return false;
            }
            if ($maxLength != -1 && strlen($oStructure->$fieldName) > $maxLength) {
                $this->raiseError('Exceed Maximum length of field \'' . $fieldName . '\'');
                return false;
            }
        }

        return true;
    }

    /**
     * Checks required integer field in structure.
     *
     * @access public
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     *
     * @return boolean  Returns true when field exists and is integer, and false in other case.
     */
    public function checkStructureRequiredIntegerField(&$oStructure, $fieldName)
    {
        if (!isset($oStructure->$fieldName)) {
            $this->raiseError('Field \'' . $fieldName . '\' in structure does not exists');
            return false;
        }
        return $this->checkStructureNotRequiredIntegerField($oStructure, $fieldName);
    }

    /**
     * Checks not required integer field in structure.
     *
     * @access public
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     *
     * @return boolean  Returns true when field exists and is integer.
     *                      Also returns true when field doesn't exist, and returns false in other case.
     */
    public function checkStructureNotRequiredIntegerField(&$oStructure, $fieldName)
    {
        if (isset($oStructure->$fieldName)) {
            if (!is_int($oStructure->$fieldName)) {
                $this->raiseError('Field \'' . $fieldName . '\' is not integer');
                return false;
            }
        }
        return true;
    }

    /**
     * Checks required double field in structure.
     *
     * @access public
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     *
     * @return boolean  Returns true when field exists and is double, and false in other case.
     */
    public function checkStructureRequiredDoubleField(&$oStructure, $fieldName)
    {
        if (!isset($oStructure->$fieldName)) {
            $this->raiseError('Field \'' . $fieldName . '\' in structure does not exists');
            return false;
        }
        return $this->checkStructureNotRequiredDoubleField($oStructure, $fieldName);
    }

    /**
     * Checks not required double field in structure.
     *
     * @access public
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     *
     * @return boolean  Returns true when field exists and is a double.
     *                  Also returns true when field doesn't exist, and returns false in other case.
     */
    public function checkStructureNotRequiredDoubleField(&$oStructure, $fieldName)
    {
        if (isset($oStructure->$fieldName)) {
            if (!is_float($oStructure->$fieldName)) {
                $this->raiseError('Field \'' . $fieldName . '\' is not double ' . gettype($fieldName));
                return false;
            }
        }
        return true;
    }

    /**
     * Checks required boolean field in structure.
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     *
     * @return boolean  Returns true when field exists and it is boolean.
     *                      And returns false in other case.
     */
    public function checkStructureRequiredBooleanField(&$oStructure, $fieldName)
    {
        if (!isset($oStructure->$fieldName)) {
            $this->raiseError('Field \'' . $fieldName . '\' in structure does not exists');
            return false;
        }
        return $this->checkStructureNotRequiredIntegerField($oStructure, $fieldName);
    }

    /**
     * Checks not required boolean field in structure.
     *
     * @param structure &$oStructure  Structure to check
     * @param string $fieldName       Field name in structure to check
     *
     * @return boolean  Returns true when field exists and it is boolean.
     *                      Also returns true when field doesn't exists.
     *                      And returns false in other case.
     */
    public function checkStructureNotRequiredBooleanField(&$oStructure, $fieldName)
    {
        if (isset($oStructure->$fieldName)) {
            if (!is_bool($oStructure->$fieldName)) {
                $this->raiseError('Field \'' . $fieldName . '\' is not boolean');
                return false;
            }
        }
        return true;
    }

    /**
     * Checks whether end date is after start date.
     *
     * @access public
     *
     * @param date $oStartDate  Pear::Date object with Start Date
     * @param date $oEndDate    Pear::Date object with End Date
     *
     * @return boolean  Returns false when start date
     *                      is after end date and true in other case.
     */
    public function checkDateOrder($oStartDate, $oEndDate)
    {
        if ((isset($oStartDate) && isset($oEndDate)) &&
            (($oStartDate->format("%Y-%m-%d") != '0000-00-00') &&
            ($oEndDate->format("%Y-%m-%d") != '0000-00-00')) &&
            $oStartDate->after($oEndDate)) {
            $this->raiseError('The start date is after the end date');
            return false;
        } else {
            return true;
        }
    }

    /**
     * Checks if record for object exists in database.
     *
     * @access public
     *
     * @param string $table  Table name in database
     * @param integer $id    Id of the row in database
     *
     * @return boolean  True if exists
     */
    public function checkIdExistence($table, $id)
    {
        $tableId = match ($table) {
            'accounts' => 'account',
            'affiliates' => 'publisher',
            'clients' => 'advertiser',
            'banners' => 'banner',
            'zones' => 'zone',
            'campaigns' => 'campaign',
            'users' => 'user',
            'trackers' => 'tracker',
            'variables' => 'variable',
            default => $table,
        };

        $doObject = OA_Dal::factoryDO($table);
        if (empty($id) || !($object = $doObject->get($id))) {
            $this->raiseError('Unknown ' . $tableId . 'Id Error');
            return false;
        } else {
            return true;
        }
    }

    /**
     * Username Password validation.
     *
     * @access public
     *
     * @param string $username
     * @param string $password
     *
     * @return boolean  True if allowed
     */
    public function validateUsernamePassword($username, $password)
    {
        if (isset($username) && (strlen($username) == 0)) {
            $this->raiseError('Username is fewer than 1 character');
            return false;
        }

        if (!isset($username) && (strlen($password) > 0)) {
            $this->raiseError('Username is null and the password is not');
            return false;
        }

        if (strpos($password, '\\')) {
            $this->raiseError('Passwords cannot contain "\\"');
            return false;
        } else {
            return true;
        }
    }

    /**
     * Checks if user has access to specific area (for example admin or agency area)
     * Permissions are defined in www/admin/lib-permissions.inc.php file
     *
     * @access public
     *
     * @param string|string[] $permissions
     * @param string $table  Table name
     * @param int|null $id  Id (or empty if new is created)
     * @param int|null $allowed  check allowed
     * @param int $operationAccessType Does the current call require only a subset of the permissions?
     * 						If set to null, equivalent to asking permission to do everything on the object
     *
     * @return boolean  True if has access
     */
    public function checkPermissions($permissions, $table = '', $id = null, $allowed = null, $operationAccessType = OA_Permission::OPERATION_ALL)
    {
        $isError = false;
        if (isset($permissions) && !OA_Permission::isAccount($permissions)) {
            if (!OA_Permission::attemptToSwitchToAccount($permissions)) {
                $isError = true;
            }
        }

        // Should this check also be part of checkPermissions?
        if (!empty($id) && !$this->checkIdExistence($table, $id)) {
            return false;
        }

        if (isset($id) && !OA_Permission::hasAccessToObject($table, $id, $operationAccessType)) {
            if (!OA_Permission::attemptToSwitchForAccess($table, $id)) {
                $isError = true;
            }
        }

        if (isset($allowed)) {
            if (OA_Permission::isAccount(OA_ACCOUNT_ADVERTISER, OA_ACCOUNT_TRAFFICKER) && !OA_Permission::hasPermission($allowed)) {
                $isError = true;
            }
        }

        if (OA_Permission::OPERATION_DELETE === $operationAccessType && !OA_Permission::checkAccountPermission(OA_ACCOUNT_MANAGER, OA_PERM_MANAGER_DELETE)) {
            $isError = true;
        }

        if ($isError) {
            $this->raiseError('Access forbidden');
            return false;
        } else {
            // Set system timezone and return
            OA_setTimeZoneLocal();
            return true;
        }
    }

    public function getDefaultAgencyId()
    {
        return OA_Permission::getAgencyId();
    }

    public function checkAgencyPermissions($agencyId)
    {
        if (!empty($agencyId)) {
            if (!$this->checkIdExistence('agency', $agencyId)) {
                return false;
            }
            if ($this->checkPermissions(OA_ACCOUNT_MANAGER, 'agency', $agencyId)) {
                return true;
            } elseif ($this->checkPermissions([OA_ACCOUNT_ADVERTISER, OA_ACCOUNT_TRAFFICKER])) {
                return $agencyId == $this->getDefaultAgencyId();
            }
            $this->raiseError('Wrong AgencyId');
            return false;
        }

        return true;
    }
}
