<?php



/*

 * @copyright  Copyright (c) 2011 by  ESS-UA.

 */



abstract class Ess_M2ePro_Model_Abstract extends Mage_Core_Model_Abstract

{

    const SETTING_FIELD_TYPE_JSON          = 'json';

    const SETTING_FIELD_TYPE_SERIALIZATION = 'serialization';



    // ########################################



    /**

     * @param int $id

     * @param null|string $field

     * @return Ess_M2ePro_Model_Abstract

     * @throws LogicException

     */

    public function loadInstance($id, $field = NULL)

    {

        $this->load($id,$field);



        if (is_null($this->getId())) {

            throw new LogicException('Instance does not exist.');

        }



        return $this;

    }



    /**

     * @return bool

     * @throws LogicException

     */

    public function isLocked()

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        if ($this->isLockedObject(NULL)) {

            return true;

        }



        return false;

    }



    /**

     * @return bool

     * @throws LogicException

     */

    public function deleteInstance()

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        if ($this->isLocked()) {

            return false;

        }



        $this->delete();

        return true;

    }



    // ########################################



    public function delete()

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        $this->deleteObjectLocks();

        return parent::delete();

    }



    public function deleteProcessingRequests()

    {

        $processingRequestsHashes = array();

        foreach ($this->getObjectLocks() as $lockedObject) {

            $processingRequestsHashes[] = $lockedObject->getRelatedHash();

        }



        /** @var $collection Mage_Core_Model_Mysql4_Collection_Abstract */

        $collection = Mage::getModel('M2ePro/Processing_Request')->getCollection();

        $collection->addFieldToFilter('hash', array('in'=>array_unique($processingRequestsHashes)));



        foreach ($collection->getItems() as $processingRequest) {

            /** @var $processingRequest Ess_M2ePro_Model_Processing_Request */

            $processingRequest->executeAsFailed('Request was deleted during account deleting.');

        }

    }



    // ########################################



    public function addObjectLock($tag = NULL, $relatedHash = NULL, $description = NULL)

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        if ($this->isLockedObject($tag,$relatedHash)) {

            return;

        }



        $model = Mage::getModel('M2ePro/LockedObject');



        $dataForAdd = array(

            'model_name' => $this->_resourceName,

            'object_id' => $this->getId(),

            'related_hash' => $relatedHash,

            'tag' => $tag,

            'description' => $description

        );



        $model->setData($dataForAdd)->save();

    }



    public function deleteObjectLocks($tag = false, $relatedHash = false)

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        $lockedObjects = $this->getObjectLocks($tag,$relatedHash);

        foreach ($lockedObjects as $lockedObject) {

            /** @var $lockedObject Ess_M2ePro_Model_LockedObject */

            $lockedObject->deleteInstance();

        }

    }



    //-----------------------------------------



    public function isLockedObject($tag = false, $relatedHash = false)

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        return count($this->getObjectLocks($tag,$relatedHash)) > 0;

    }



    public function getObjectLocks($tag = false, $relatedHash = false)

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        $lockedCollection = Mage::getModel('M2ePro/LockedObject')->getCollection();



        $lockedCollection->addFieldToFilter('model_name',$this->_resourceName);

        $lockedCollection->addFieldToFilter('object_id',$this->getId());



        is_null($tag) && $tag = array('null'=>true);

        $tag !== false && $lockedCollection->addFieldToFilter('tag',$tag);

        $relatedHash !== false && $lockedCollection->addFieldToFilter('related_hash',$relatedHash);



        return $lockedCollection->getItems();

    }



    // ########################################



    /**

     * @param string $modelName

     * @param string $fieldName

     * @param bool $asObjects

     * @param array $filters

     * @param array $sort

     * @return array

     * @throws LogicException

     */

    protected function getRelatedSimpleItems($modelName, $fieldName, $asObjects = false,

                                             array $filters = array(), array $sort = array())

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        $tempModel = Mage::getModel('M2ePro/'.$modelName);



        if (is_null($tempModel) || !($tempModel instanceof Ess_M2ePro_Model_Abstract)) {

            return array();

        }



        return $this->getRelatedItems($tempModel,$fieldName,$asObjects,$filters,$sort);

    }



    /**

     * @param Ess_M2ePro_Model_Abstract $model

     * @param string $fieldName

     * @param bool $asObjects

     * @param array $filters

     * @param array $sort

     * @return array

     * @throws LogicException

     */

    protected function getRelatedItems(Ess_M2ePro_Model_Abstract $model, $fieldName, $asObjects = false,

                                       array $filters = array(), array $sort = array())

    {

        if (is_null($this->getId())) {

            throw new LogicException('Method require loaded instance first');

        }



        /** @var $tempCollection Mage_Core_Model_Mysql4_Collection_Abstract */

        $tempCollection = $model->getCollection();

        $tempCollection->addFieldToFilter($fieldName, $this->getId());



        foreach ($filters as $field=>$filter) {

            $tempCollection->addFieldToFilter('`'.$field.'`', $filter);

        }



        foreach ($sort as $field => $order) {

            $order = strtoupper(trim($order));

            if ($order != Varien_Data_Collection::SORT_ORDER_ASC &&

                $order != Varien_Data_Collection::SORT_ORDER_DESC) {

                continue;

            }

            $tempCollection->setOrder($field,$order);

        }



        if ((bool)$asObjects) {

            return $tempCollection->getItems();

        }



        $tempArray = $tempCollection->toArray();

        return $tempArray['items'];

    }



    // ########################################



    /**

     * @param string $fieldName

     * @param string $encodeType

     *

     * @return array

     *

     * @throws LogicException

     */

    public function getSettings($fieldName, $encodeType = self::SETTING_FIELD_TYPE_JSON)

    {

        $settings = $this->getData((string)$fieldName);



        if (is_null($settings)) {

            return array();

        }



        if ($encodeType == self::SETTING_FIELD_TYPE_JSON) {

            $settings = json_decode($settings, true);

        } else if ($encodeType == self::SETTING_FIELD_TYPE_SERIALIZATION) {

            $settings = @unserialize($settings);

        } else {

            // Parser hack -> Mage::helper('M2ePro')->__('Encoding type "%type%" is not supported.');

            $message = 'Encoding type "%type%" is not supported.';

            throw new LogicException(str_replace('%type%', $encodeType, $message));

        }



        return is_array($settings) ? $settings : array();

    }



    /**

     * @param string       $fieldName

     * @param string|array $settingNamePath

     * @param mixed        $defaultValue

     * @param string       $encodeType

     *

     * @return mixed|null

     */

    public function getSetting($fieldName,

                               $settingNamePath,

                               $defaultValue = NULL,

                               $encodeType = self::SETTING_FIELD_TYPE_JSON)

    {

        if (empty($settingNamePath)) {

            return $defaultValue;

        }



        $settings = $this->getSettings($fieldName, $encodeType);



        !is_array($settingNamePath) && $settingNamePath = array($settingNamePath);



        foreach ($settingNamePath as $pathPart) {

            if (!isset($settings[$pathPart])) {

                return $defaultValue;

            }



            $settings = $settings[$pathPart];

        }



        if (is_numeric($settings)) {

            $settings = ctype_digit($settings) ? (int)$settings : $settings;

        }



        return $settings;

    }



    /**

     * @param string $fieldName

     * @param array  $settings

     * @param string $encodeType

     *

     * @return Ess_M2ePro_Model_Abstract

     *

     * @throws LogicException

     */

    public function setSettings($fieldName, array $settings = array(), $encodeType = self::SETTING_FIELD_TYPE_JSON)

    {

        if ($encodeType == self::SETTING_FIELD_TYPE_JSON) {

            $settings = json_encode($settings);

        } else if ($encodeType == self::SETTING_FIELD_TYPE_SERIALIZATION) {

            $settings = serialize($settings);

        } else {

            // Parser hack -> Mage::helper('M2ePro')->__('Encoding type "%type%" is not supported.');

            $message = 'Encoding type "%type%" is not supported.';

            throw new LogicException(str_replace('%type%', $encodeType, $message));

        }



        $this->setData((string)$fieldName, $settings);



        return $this;

    }



    /**

     * @param string       $fieldName

     * @param string|array $settingNamePath

     * @param mixed        $settingValue

     * @param string       $encodeType

     *

     * @return Ess_M2ePro_Model_Abstract

     */

    public function setSetting($fieldName,

                               $settingNamePath,

                               $settingValue,

                               $encodeType = self::SETTING_FIELD_TYPE_JSON)

    {

        if (empty($settingNamePath)) {

            return $this;

        }



        !is_array($settingNamePath) && $settingNamePath = array($settingNamePath);



        while ($pathPart = array_pop($settingNamePath)) {

            $settingValue = array($pathPart => $settingValue);

        }



        $originalSettings = $this->getSettings($fieldName, $encodeType);

        $mergedSettings = Mage::helper('M2ePro')->arrayReplaceRecursive($originalSettings, $settingValue);



        $this->setSettings($fieldName, $mergedSettings, $encodeType);



        return $this;

    }



    // ########################################

}