<?php if ( !defined('ABS_PATH') ) exit('ABS_PATH is not loaded. Direct access is not allowed.');

/*
 * Copyright 2014 Osclass
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

    /**
     * Category DAO
     */
    class Category extends DAO
    {
        /**
         *
         * @var type
         */
        private static $instance;
        private $_language;
        private $_tree;
        private $_categories;
        private $_categoriesEnabled;
        private $_relation;
        private $_emptyTree;
        private $_slugs;

        public static function newInstance()
        {
            if( !self::$instance instanceof self ) {
                self::$instance = new self;
            }
            return self::$instance;
        }

        /**
         * Set data related to t_category table
         */
        function __construct($l = '')
        {
            parent::__construct();
            $this->setTableName('t_category');
            $this->setPrimaryKey('pk_i_id');
            $array_fields = array(
                'pk_i_id',
                'fk_i_parent_id',
                'i_expiration_days',
                'i_position',
                'b_enabled',
                's_icon',
                'b_price_enabled'
            );
            $this->setFields($array_fields);

            if($l == '') {
                $l = osc_current_user_locale();
            }

            $this->_language   = $l;
            $this->_tree       = null;
            $this->_relation   = null;
            $this->_categories = null;
            $this->_emptyTree = true;
            $this->toTree();
        }

        /**
         * Comodin function to serve multiple queries
         *
         * *Note: param needs to be escaped, inside function will not be escaped
         *
         * @access public
         * @since unknown
         * @param mixed
         * @return array
         */
        public function listWhere($where = '')
        {
            if( $where !== '') {
                $this->dao->where( $where );
            }

            $this->dao->select("a.*, b.*, c.i_num_items");
            $this->dao->from( $this->getTableName().' as a' );
            $this->dao->join(
                DB_TABLE_PREFIX.'t_category_description as b',
                sprintf(
                    '(a.pk_i_id = b.fk_i_category_id AND b.fk_c_locale_code = "%s")',
                    $this->dao->connId->real_escape_string($this->_language)
                ),
                'INNER'
            );
            $this->dao->join(DB_TABLE_PREFIX.'t_category_stats  as c ', 'a.pk_i_id = c.fk_i_category_id', 'LEFT');
            $this->dao->orderBy('i_position', 'ASC');
            $rs = $this->dao->get();

            if( $rs === false ) {
                return array();
            }

            if( $rs->numRows() == 0 ) {
                return array();
            }

            return $rs->result();
        }

        /**
         * List all enabled categories
         *
         * @access public
         * @since unknown
         * @return array
         */
        public function listEnabled()
        {
            $this->dao->where("b.s_name != ''");
            $this->dao->where("a.b_enabled = 1");

            return $this->listWhere();
        }

        /**
         * Return categories in a tree
         *
         * @access public
         * @since unknown
         * @param bool $empty
         * @return array
         */
        public function toTree($empty = true)
        {
            $key    = md5(osc_base_url().(string)$this->_language.(string)$empty);
            $found  = null;
            $cache  = osc_cache_get($key, $found);
            if($cache===false) {
                if($empty==$this->_emptyTree && $this->_tree!=null) {
                    return $this->_tree;
                }
                $this->_empty_tree = $empty;
                // if listEnabled has been called before, don't redo the query
                if($this->_categoriesEnabled) {
                    $categories = $this->_categoriesEnabled;
                } else {
                    $this->_categoriesEnabled = $this->listEnabled();
                    $categories               = $this->_categoriesEnabled;
                }
                $this->_categories = array();
                $this->_relation = array();
                foreach($categories as $c) {
                    if($empty || (!$empty && $c['i_num_items']>0)) {
                        $this->_categories[$c['pk_i_id']] = $c;
                        if($c['fk_i_parent_id']==null) {
                            $this->_tree[] = $c;
                            $this->_relation[0][] = $c['pk_i_id'];
                        } else {
                            $this->_relation[$c['fk_i_parent_id']][] = $c['pk_i_id'];
                        }
                    }
                }

                if(count($this->_relation) == 0 || !isset($this->_relation[0]) ) {
                    return array();
                }

                $this->_tree = $this->sideTree($this->_relation[0], $this->_categories, $this->_relation);

                $cache['tree']         = $this->_tree;
                $cache['empty_tree']   = $this->_emptyTree;
                $cache['relation']     = $this->_relation;
                $cache['categories']   = $this->_categories;
                $cache['categoriesEnabled']   = $this->_categoriesEnabled;
                osc_cache_set($key, $cache, OSC_CACHE_TTL);
                return $this->_tree;
            } else {
                $this->_tree         = $cache['tree'];
                $this->_empty_tree   = $cache['empty_tree'];
                $this->_relation     = $cache['relation'];
                $this->_categories   = $cache['categories'];
                $this->_categoriesEnabled = $cache['categoriesEnabled'];
                return $this->_tree;
            }
        }

        /**
         * Helps create the tree
         *
         * @access private
         * @since unknown
         * @param array $branch
         * @param array $categories
         * @param array $relation
         * @return array
         */
        private function sideTree($branch, $categories, $relation)
        {
            $tree = array();
            if( !empty($branch) ) {
                foreach($branch as $b) {
                    $aux = $categories[$b];
                    if(isset($relation[$b]) && is_array($relation[$b])) {
                        $aux['categories'] = $this->sideTree($relation[$b], $categories, $relation);
                    } else {
                        $aux['categories'] = array();
                    }
                    $tree[] = $aux;
                }
            }
            return $tree;
        }

        /**
         * Find root categories
         *
         * @access public
         * @since unknown
         * @return array
         */
        public function findRootCategories()
        {
            // juanramon: specific condition
            $this->dao->where( 'a.fk_i_parent_id IS NULL' );
            // end specific condition

            return $this->listWhere();
        }

        /**
         * Find root enabled categories
         *
         * @access public
         * @since unknown
         * @return array
         */
        public function findRootCategoriesEnabled()
        {
            // juanramon: specific condition
            $this->dao->where( 'a.fk_i_parent_id IS NULL' );
            $this->dao->where( 'a.b_enabled', '1' );
            // end specific condition

            return $this->listWhere();
        }

        /**
         * Returna  tree of a given category as the root
         *
         * @access public
         * @since unknown
         * @param integer$category
         * @return array
         */
        public function toSubTree($category = null)
        {
            $this->toTree();
            if($category==null) {
                return array();
            } else {
                if(isset($this->_relation[$category])) {
                    $tree = $this->sideTree($this->_relation[$category], $this->_categories, $this->_relation);
                    return $tree;
                } else {
                    array();
                }
            }
        }

        /**
         * Lit all categories
         *
         * @access public
         * @since unknown
         * @return array
         */
        public function listAll($description = true)
        {
            // juanramon: specific condition
            $this->dao->where( '1 = 1' );
            // end specific condition

            return $this->listWhere();
        }

        /**
         * Return a tree of ALL (enabled & disabled) categories
         *
         * @access public
         * @since unknown
         * @return array
         */
        public function toTreeAll()
        {
            $categories = $this->listAll();
            $all_categories = array();
            $all_relation = array();
            $tree = array();
            foreach($categories as $c) {
                $all_categories[$c['pk_i_id']] = $c;
                if($c['fk_i_parent_id']==null) {
                    $tree[] = $c;
                    $all_relation[0][] = $c['pk_i_id'];
                } else {
                    $all_relation[$c['fk_i_parent_id']][] = $c['pk_i_id'];
                }
            }
            if(isset($all_relation[0])) {
                $tree = $this->sideTree($all_relation[0], $all_categories, $all_relation);
            } else {
                $tree = array();
            }
            return $tree;
        }

        /**
         * Given a category, return the branch from the root to the category
         *
         * @access public
         * @since unknown
         * @param integer$category
         * @return array
         */
        public function toRootTree($cat = null)
        {
            $tree = array();
            if($cat!=null) {
                $tree_b = array();
                if(is_numeric($cat)) {
                    $cat = $this->findByPrimaryKey($cat);
                } else {
                    $cat = $this->findBySlug($cat);
                }
                $tree[0] = $cat;
                while($cat['fk_i_parent_id']!=null) {
                    $cat = $this->findByPrimaryKey($cat['fk_i_parent_id']);
                    array_unshift($tree, '');//$cat);
                    $tree[0] = $cat;
                }
            }
            return $tree;
        }

        /**
         * Return the root category of a one given
         *
         * @access public
         * @since unknown
         * @param integer $categoryID
         * @return array
         */
        public function findRootCategory($categoryID)
        {
            // juanramon: specific condition
            $this->dao->where( 'a.fk_i_parent_id IS NOT NULL' );
            $this->dao->where( 'a.pk_i_id', $categoryID );
            // end specific condition

            $results = $this->listWhere();

            if( count($results) > 0 ) {
                return $this->findRootCategory( $results[0]['fk_i_parent_id'] );
            }

            return $this->findByPrimaryKey( $categoryID );
        }

        /**
         * Find a category find its slug
         *
         * @access public
         * @since unknown
         * @param string $slug
         * @return array
         */
        public function findBySlug($slug)
        {
            $slug = trim($slug);
            if($slug!='') {
                if(isset($this->_slugs[$slug])) {
                    return $this->findByPrimaryKey($this->_slugs[$slug]);
                }
                $slug = urlencode($slug);
                $this->dao->where('b.s_slug', $slug);
                // end specific condition

                $results = $this->listWhere();
                if (count($results) > 0) {
                    $this->_slugs[$slug] = $results[0]['pk_i_id'];
                    return $results[0];
                }
            }
            return array();
        }

        /**
         * Same as toRootTree but reverse the results
         *
         * @access public
         * @since unknown
         * @param integer$category_id
         * @return array
         */
        public function hierarchy($category_id)
        {
            return array_reverse($this->toRootTree($category_id));
        }

        /**
         * Check if it's a root category
         *
         * @access public
         * @since unknown
         * @param integer$category_id
         * @return boolean
         */
        public function isRoot($categoryID)
        {
            // juanramon: specific condition
            $this->dao->where( 'fk_i_parent_id IS NULL' );
            $this->dao->where( 'pk_i_id', $categoryID );
            // end specific condition

            $results = $this->listWhere();

            if( count($results) > 0 ) {
                return true;
            }

            return false;
        }

        /**
         * returns the children of a given category
         *
         * @access public
         * @since unknown
         * @param integer $categoryID
         * @return array
         */
        public function findSubcategories($categoryID)
        {
            $this->dao->where( 'fk_i_parent_id', (int)($categoryID));
            return $this->listWhere();
        }

        /**
         * returns the children of a given category
         *
         * @access public
         * @since unknown
         * @param integer $categoryID
         * @return array
         */
        public function findSubcategoriesEnabled($categoryID)
        {
            $this->dao->where( 'fk_i_parent_id', (int)($categoryID));
            $this->dao->where( 'a.b_enabled', '1' );
            return $this->listWhere();
        }

        /**
         * Return a category given an id
         * This overwrite findByPrimaryKey of DAO model because we store the
         * categories on an array for the tree and it's faster than a SQL query
         *
         * @access public
         * @since unknown
         * @param int $categoryID primary key
         * @return array
         */
        public function findByPrimaryKey($categoryID, $locale = "")
        {
            if($categoryID == null) {
                return false;
            }
            $key    = md5(osc_base_url().'Category:findByPrimaryKey:'.$categoryID.$locale);
            $found  = null;
            $cache  = osc_cache_get($key, $found);
            if($cache===false) {
                $category = array();

                if( isset($this->_categories[$categoryID]) ) {
                    $category = $this->_categories[$categoryID];

                    // if we already have locale data, we return the category
                    if( $locale=="" || ($locale!="" && isset($category['locale']))) {
                        if($locale!='' && isset($category['locale'][$locale])) {
                            $category['s_name'] = $category['locale'][$locale]['s_name'];
                            $category['s_description'] = $category['locale'][$locale]['s_description'];
                        }
                        osc_cache_set($key, $category, OSC_CACHE_TTL);
                        return $category;
                    }
                } else {
                    $this->dao->where('pk_i_id', $categoryID);
                    $category = $this->listWhere();

                    if(!isset($category[0]) || !isset($category[0]['pk_i_id'])) {
                        return false;
                    }
                    $category = $category[0];
                }

                $this->dao->select();
                $this->dao->from( $this->getTablePrefix() . 't_category_description' );
                $this->dao->where( 'fk_i_category_id', $category['pk_i_id'] );
                $this->dao->orderBy( 'fk_c_locale_code' );
                $result = $this->dao->get();

                if( $result == false ) {
                    return false;
                }

                $sub_rows = $result->result();
                $row      = array();
                foreach ($sub_rows as $sub_row) {
                    if(isset($sub_row['fk_c_locale_code'])) {
                        $row[$sub_row['fk_c_locale_code']] = $sub_row;
                    }
                }
                $category['locale'] = $row;

                // if it exists in the $categories array, we copy the row data
                if( array_key_exists($categoryID, $this->_categories) ) {
                    $this->_categories[$categoryID] = $category;
                }
                if($locale!='' && isset($category['locale'][$locale])) {
                    $category['s_name'] = $category['locale'][$locale]['s_name'];
                    $category['s_description'] = $category['locale'][$locale]['s_description'];
                }
                osc_cache_set($key, $category, OSC_CACHE_TTL);
                return $category;
            } else {
                return $cache;
            }
        }

        /**
         * Return a category's name given an id
         *
         * @access public
         * @since 3.1
         * @param int $categoryID primary key
         * @return string
         */
        public function findNameByPrimaryKey($categoryID)
        {
            if($categoryID == null) {
                return false;
            }

            $category = array();

            if( array_key_exists($categoryID, $this->_categories) ) {
                $category = $this->_categories[$categoryID];
            } else {
                $this->dao->select( "s_name" );
                $this->dao->from( $this->getTablePrefix() . 't_category_description' );
                $this->dao->where( 'fk_i_category_id', $categoryID );
                $result = $this->dao->get();

                if( $result == false ) {
                    return false;
                }

                $category = $result->row();
            }

            if(isset($category['s_name'])) {
                return $category['s_name'];
            } else {
                return __('Non-Existent Category');
            }
        }

        /**
         * Return list of categories' name and id by locale
         *
         * @access public
         * @since 3.2.1
         * @param string $locale
         * @return array
         */
        public function _findNameIDByLocale($locale = null)
        {
            if($locale == null) {
                return false;
            }

            $this->dao->select( "s_name, fk_i_category_id as pk_i_id" );
            $this->dao->from( $this->getTablePrefix() . 't_category_description' );
            $this->dao->where( 'fk_c_locale_code', $locale );
            $result = $this->dao->get();

            if( $result == false ) {
                return array();
            }

            return $result->result();
        }

        /**
         * delete a category and all information linked to it
         *
         * @access public
         * @since unknown
         * @param integer$pk primary key
         */
        public function deleteByPrimaryKey($pk)
        {
            $items = Item::newInstance()->findByCategoryID((int)($pk));
            $subcats = $this->findSubcategories((int)($pk));
            if (count($subcats) > 0) {
                foreach ($subcats as $s) {
                    $this->deleteByPrimaryKey((int)($s["pk_i_id"]));
                }
            }

            if (count($items) > 0) {
                foreach ($items as $item) {
                    Item::newInstance()->deleteByPrimaryKey($item["pk_i_id"]);
                }
            }

            osc_run_hook('delete_category', (int)($pk));

            $this->dao->delete( sprintf('%st_plugin_category', DB_TABLE_PREFIX), array('fk_i_category_id' => (int)($pk)) );
            $this->dao->delete( sprintf('%st_category_description', DB_TABLE_PREFIX), array('fk_i_category_id' => (int)($pk)) );
            $this->dao->delete( sprintf('%st_category_stats', DB_TABLE_PREFIX), array('fk_i_category_id' => (int)($pk)) );
            $this->dao->delete( sprintf('%st_meta_categories', DB_TABLE_PREFIX), array('fk_i_category_id' => (int)($pk)) );
            return $this->dao->delete( sprintf('%st_category', DB_TABLE_PREFIX), array('pk_i_id' => (int)($pk)) );
        }

        /**
         * Update a category
         *
         * @access public
         * @since unknown
         * @param array $fields
         * @param array $aFieldsDescriptions
         * @param int $pk primary key
         * @return mixed bool if there is an error, affectedRows if there isn't errors
         */
        public function updateByPrimaryKey($data, $pk)
        {
            $fields = $data['fields'];

            $aFieldsDescription = $data['aFieldsDescription'];
            $return       = true;
            $affectedRows = 0;
            //UPDATE for category
            $res = $this->dao->update($this->getTableName(), $fields, array('pk_i_id' => $pk));
            if($res >= 0) {
                // update dt_expiration (tablel t_item) using category.i_expiration_days
                if($fields['i_expiration_days'] > 0) {
                    $update_dt_expiration = sprintf('update %st_item as a
                        left join %st_category  as b on b.pk_i_id = a.fk_i_category_id
                        set a.dt_expiration = date_add(a.dt_pub_date, INTERVAL b.i_expiration_days DAY)
                        where a.fk_i_category_id = %d ', DB_TABLE_PREFIX, DB_TABLE_PREFIX, $pk );

                    $this->dao->query($update_dt_expiration);
                // update dt_expiration (table t_item) using the max date value
                } else if( $fields['i_expiration_days'] == 0) {
                    $update_dt_expiration = sprintf("update %st_item as a
                        set a.dt_expiration = '9999-12-31 23:59:59'
                        where a.fk_i_category_id = %s", DB_TABLE_PREFIX, $pk );

                    $this->dao->query($update_dt_expiration);
                }

                $affectedRows = $res;

                foreach ($aFieldsDescription as $k => $fieldsDescription) {
                    //UPDATE for description of categories
                    $fieldsDescription['fk_i_category_id'] = $pk;
                    $fieldsDescription['fk_c_locale_code'] = $k;
                    $slug_tmp = $slug = osc_sanitizeString(osc_apply_filter('slug', isset($fieldsDescription['s_name'])?$fieldsDescription['s_name']:''));
                    $slug_unique = 1;
                    while(true) {
                        $cat_slug = $this->findBySlug($slug);
                        if(!isset($cat_slug['pk_i_id']) || $cat_slug['pk_i_id']==$pk) {
                            break;
                        } else {
                            $slug = $slug_tmp . "_" . $slug_unique;
                            $slug_unique++;
                        }
                    }
                    $fieldsDescription['s_slug'] = $slug;
                    $array_where = array(
                        'fk_i_category_id'  => $pk,
                        'fk_c_locale_code'  => $fieldsDescription["fk_c_locale_code"]
                    );

                    $rs = $this->dao->update(DB_TABLE_PREFIX.'t_category_description', $fieldsDescription, $array_where);
                    if($rs == 0) {
                        $this->dao->select();
                        $this->dao->from($this->tableName." as a");
                        $this->dao->join(sprintf("%st_category_description as b", DB_TABLE_PREFIX), "a.pk_i_id = b.fk_i_category_id", "INNER");
                        $this->dao->where("a.pk_i_id", $pk);
                        $this->dao->where("b.fk_c_locale_code", $k);
                        $result = $this->dao->get();
                        $rows = $result->result();
                        if($result->numRows == 0) {
                            $res_insert = $this->insertDescription($fieldsDescription);
                            $affectedRows += 1;
                        }
                    } else if($rs > 0) {
                        $affectedRows += $rs;
                    } else if( is_bool($rs) ) { // catch error
                        if($return) {
                            $return = $rs;
                        }
                    }
                }
            } else {
                $return = $res;
            }

            if($return) {
                return $affectedRows;
            } else {
                return $return;
            }
        }

        /**
         * Inser a new category
         *
         * @access public
         * @since unknown
         * @param array $fields
         * @param array $aFieldsDescriptions
         */
        public function insert($fields, $aFieldsDescription = null )
        {
            $this->dao->insert($this->getTableName(),$fields);
            $category_id = $this->dao->insertedId();
            foreach ($aFieldsDescription as $k => $fieldsDescription) {
                $fieldsDescription['fk_i_category_id'] = $category_id;
                $fieldsDescription['fk_c_locale_code'] = $k;
                $slug_tmp = $slug = osc_sanitizeString(osc_apply_filter('slug', $fieldsDescription['s_name']));
                $slug_unique = 1;
                while(true) {
                    if(!$this->findBySlug($slug)) {
                        break;
                    } else {
                        $slug = $slug_tmp . "_" . $slug_unique;
                        $slug_unique++;
                    }
                }
                $fieldsDescription['s_slug'] = $slug;
                $this->dao->insert(DB_TABLE_PREFIX . 't_category_description',$fieldsDescription);
            }

            return $category_id;
        }

        /**
         * Insert the description of a category
         *
         * @access public
         * @since unknown
         * @param array $fields_description
         * @return bool
         */
        public function insertDescription($fields_description)
        {
            if (!empty($fields_description['s_name'])) {
                return $this->dao->insert(DB_TABLE_PREFIX . 't_category_description', $fields_description );
            }
        }

        /**
         * Update categories' order
         *
         * @access public
         * @since unknown
         * @param integer $pk_i_id
         * @param integer $order
         * @return mixed false on fail, int of num. of affected rows
         */
        public function updateOrder($pk_i_id, $order)
        {
            return $this->dao->update($this->tableName, array('i_position' => $order), array('pk_i_id' => $pk_i_id));

        }

        /**
         * Update categories' expiration
         *
         * @access public
         * @since unknown
         * @param integer $pk_i_id
         * @param integer $expiration
         * @param boolean $updateSubcategories
         * @return mixed false on fail, int of num. of affected rows
         */
        public function updateExpiration($pk_i_id, $expiration, $updateSubcategories = false)
        {
            $itemManager = Item::newInstance();

            $this->dao->select('pk_i_id');
            $this->dao->from(DB_TABLE_PREFIX.'t_item');
            $this->dao->where(sprintf('fk_i_category_id = %d', $pk_i_id));
            $result = $this->dao->get();
            if($result == false) {
                $items = array();
            }
            $items  = $result->result();
            foreach($items as $item) {
                $itemManager->updateExpirationDate($item['pk_i_id'], $expiration);
            }
            $result = $this->dao->update($this->tableName, array('i_expiration_days' => $expiration), array('pk_i_id'  => $pk_i_id));
            if($updateSubcategories) {
                $subcategories = $this->findSubcategories($pk_i_id);
                foreach($subcategories as $c) {
                    $this->updateExpiration($c['pk_i_id'], $expiration, true);
                }
            }
            return $result;
        }

        /**
         * Update categories' price enabled
         *
         * @access public
         * @since unknown
         * @param integer $pk_i_id
         * @param integer $enabled
         * @param boolean $updateSubcategories
         * @return bool true on pass, false on fail
         */
        public function updatePriceEnabled($pk_i_id, $enabled, $updateSubcategories = false)
        {
            $result = $this->dao->update($this->tableName, array('b_price_enabled' => $enabled), array('pk_i_id'  => $pk_i_id));
            if($updateSubcategories) {
                $subcategories = $this->findSubcategories($pk_i_id);
                foreach($subcategories as $c) {
                    $this->updatePriceEnabled($c['pk_i_id'], $enabled, true);
                }
            }
            return $result;
        }

        /**
         * update name of a category
         *
         * @access public
         * @since unknown
         * @param integer $pk_i_id
         * @param string $locale
         * @param string $name
         * @return mixed false on fail, int of num. of affected rows
         */
        public function updateName($pk_i_id, $locale, $name)
        {
            return $this->dao->update(DB_TABLE_PREFIX.'t_category_description', array('s_name' => $name), array('fk_i_category_id' => $pk_i_id,'fk_c_locale_code' => $locale));
        }

        /**
         * Formats a value before being inserted in DB.
         */
        public function formatValue($value)
        {
            if(is_null($value)) return DB_CONST_NULL;
            else $value = trim($value);
            switch($value) {
                case DB_FUNC_NOW:
                case DB_CONST_TRUE:
                case DB_CONST_FALSE:
                case DB_CONST_NULL:
                    break;
                default:
                    $value = '\'' . addslashes($value) . '\'';
                    break;
            }

            return $value;
        }
    }

    /* file end: ./oc-includes/osclass/model/Category.php */