<?php
##################################################
#
# Copyright (c) 2004-2015 OIC Group, Inc.
#
# This file is part of Exponent
#
# Exponent 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.
#
# GPL: http://www.gnu.org/licenses/gpl.txt
#
##################################################

/**
 * This is the class expRecord
 *
 * @subpackage Models
 * @package    Core
 */
class expRecord {
    protected $classinfo = null;
    public $classname = '';

    // database
    public $tablename = '';
    public $identifier = 'id';
    public $rank_by_field = '';
    // for segregating items into uniqueness within a subgroup instead of unique amongst all like items in system
    public $grouping_sql = '';

    // associated objects
    public $has_extended_fields = array();  // add single object db fields to this object (not the object methods)
    public $has_one = array();  // associate single object w/ matching id
    public $has_many = array();  // associate all objects w/ matching id's
    public $has_many_self = array();
    public $has_and_belongs_to_many = array();
    public $has_and_belongs_to_self = array();
    // sort order/direction for associated objects
    public $default_sort_field = '';
    public $default_sort_direction = '';
    // what associated objects should also receive associated objects when associated
    public $get_assoc_for = array();

    // attachable items
    protected $attachable_item_types = array();
    /* protected $attachable_item_types = array(  // list of available attachments
        'content_expCats'=>'expCat'
        'content_expComments'=>'expComment',
        'content_expDefinableFields'=> 'expDefinableField'
        'content_expFiles'=>'expFile',
        'content_expRatings'=>'expRating',
        'content_expSimpleNote'=>'expSimpleNote',
        'content_expTags'=>'expTag',
    );*/
    public $attachable_items_to_save;
    // what associated objects should also receive their attachments when associated
    public $get_attachable_for = array();

    // field validation settings
    public $validate = array();
    public $do_not_validate = array();

    public $supports_revisions = false;  // simple flag to turn on revisions/approval support for module
    public $needs_approval = false;  // flag for no approval authority

    /**
     * is model content searchable?
     *
     * @return bool
     */
    static function isSearchable() {
        return false;
    }

    /**
     * @param null $params
     * @param bool $get_assoc
     * @param bool $get_attached
     *
     * @return expRecord
     *
     */
    function __construct($params = null, $get_assoc = true, $get_attached = true) {
        global $db;

        // @TODO Change this conditional check as the default value in argument list
        // if the params come thru as a null value we need to convert to an empty array
        if (empty($params)) {
            $params       = array();
            $get_assoc    = false;
            $get_attached = false;
        }

        // figure out the basic table info about this model
        $this->classinfo = new ReflectionClass($this);
        $this->classname = $this->classinfo->getName();
        $this->tablename = isset($this->table) ? $this->table : $this->classinfo->getName();

        $supports_revisions = $this->supports_revisions && ENABLE_WORKFLOW;
        $needs_approval = $this->needs_approval && ENABLE_WORKFLOW;

        // if the user passed in arguments to this constructor then we need to
        // retrieve objects 

        // If a number was sent in, we assume this is a DB record ID, so pull it
        if (!is_object($params) && !is_array($params)) {
            $where = '';
            if (is_numeric($params)) {
                $this->build($db->selectArray($this->tablename, $this->identifier . '=' . $params, null, $supports_revisions));
                $identifier = $this->identifier;
                $params     = array($identifier => $params); // Convert $params (given number value) into an key/value pair
            } else {
                // try to look up by sef_url
                $values = $db->selectArray($this->tablename, "sef_url='" . expString::sanitize($params) . "'", null, $supports_revisions, $needs_approval);
                // if we didn't find it via sef_url then we should check by title
                if (empty($values)) $values = $db->selectArray($this->tablename, "title='" . expString::sanitize($params) . "'", null, $supports_revisions, $needs_approval);
                $this->build($values);
                $params = array('title'=> $params);
            }

        } else {
            // Otherwise we assume that in inbound is an array or Object to be processed as is.        
            $this->build($params);
        }

        // establish a pseudo publish date
        if (!empty($this->publish)) {
            $this->publish_date = $this->publish;
        } elseif (!empty($this->edited_at)) {
            $this->publish_date = $this->edited_at;
        } elseif (!empty($this->created_at)) {
            $this->publish_date = $this->created_at;
        }

        // setup the exception array if it's not there.  This array tells the getAssociatedObjectsForThisModel() function which 
        // modules NOT to setup.  This stops us from getting infinite loops with many to many relationships.
        $params['except']         = isset($params['except']) ? $params['except'] : array();
        $params['cascade_except'] = isset($params['cascade_except']) ? $params['cascade_except'] : false;

        if ($get_assoc) $this->getAssociatedObjectsForThisModel($params['except'], $params['cascade_except']);
        if ($get_attached) $this->getAttachableItems();
    }

    /**
     * find an item
     *
     * @param string $range
     * @param null   $where
     * @param null   $order
     * @param null   $limit
     * @param int    $limitstart
     * @param bool   $get_assoc
     * @param bool   $get_attached
     * @param array  $except
     * @param bool   $cascade_except
     *
     * @return array
     */
    public function find($range = 'all', $where = null, $order = null, $limit = null, $limitstart = 0, $get_assoc = true, $get_attached = true, $except = array(), $cascade_except = false) {
        global $db, $user;

        if (is_numeric($range)) {
            $where = $this->identifier . '=' . intval($range); // If we hit this then we are expecting just a simple id
            $range = 'first';
        }

        $sql = empty($where) ? 1 : $where;
        //eDebug("Supports Revisions:" . $this->supports_revisions);
//        if ($this->supports_revisions && $range != 'revisions') $sql .= " AND revision_id=(SELECT MAX(revision_id) FROM `" . $db->prefix . $this->tablename . "` WHERE $where)";
//        $sql .= empty($order) ? '' : ' ORDER BY ' . $order;
        $supports_revisions = $this->supports_revisions && ENABLE_WORKFLOW;
        if (ENABLE_WORKFLOW && $this->needs_approval) {
            $needs_approval = $user->id;
        } else {
            $needs_approval = false;
        }

        if (strcasecmp($range, 'all') == 0) {  // return all items matching request, most current revision
//            $sql .= empty($limit) ? '' : ' LIMIT ' . $limitstart . ',' . $limit;
            $limitsql = empty($limit) ? '' : ' LIMIT ' . $limitstart . ',' . $limit;
            return $db->selectExpObjects($this->tablename, $sql, $this->classname, $get_assoc, $get_attached, $except, $cascade_except, $order, $limitsql, $supports_revisions, $needs_approval);
        } elseif (strcasecmp($range, 'revisions') == 0) {  // return all items matching request, all revisions
//            $sql .= empty($limit) ? '' : ' LIMIT ' . $limitstart . ',' . $limit;
            $limitsql = empty($limit) ? '' : ' LIMIT ' . $limitstart . ',' . $limit;
            return $db->selectExpObjects($this->tablename, $sql, $this->classname, $get_assoc, $get_attached, $except, $cascade_except, $order, $limitsql);
        } elseif (strcasecmp($range, 'first') == 0) {  // return the first item matching request
//            $sql .= ' LIMIT 0,1';
            $limitsql = ' LIMIT 0,1';
            $records = $db->selectExpObjects($this->tablename, $sql, $this->classname, $get_assoc, $get_attached, $except, $cascade_except, $order, $limitsql, $supports_revisions, $needs_approval);
            return empty($records) ? null : $records[0];
        } elseif (strcasecmp($range, 'bytitle') == 0) {  // return items requested by title/sef_url (will there be more than one?)
            $limitsql = ' LIMIT 0,1';
            $records = $db->selectExpObjects($this->tablename, "title='" . $where . "' OR sef_url='" . $where . "'", $this->classname, $get_assoc, $get_attached, $except, $cascade_except, $order, $limitsql, $supports_revisions, $needs_approval);
            return empty($records) ? null : $records[0];
        } elseif (strcasecmp($range, 'count') == 0) {  // return count of items
            return $db->countObjects($this->tablename, $sql, $supports_revisions, $needs_approval);
        } elseif (strcasecmp($range, 'in') == 0) {  // return items requested by array of id#
            if (!is_array($where)) return array();
            foreach ($where as $id)
                $records[] = new $this->classname($id);
            return $records;
        } elseif (strcasecmp($range, 'bytag') == 0) {  // return items tagged with request (id or title/sef_url)
            if (!is_int($where))  $where = $db->selectObject(DB_TABLE_PREFIX . '_expTags',"title='" . $where . "' OR sef_url='" . $where . "'");
            $sql = 'SELECT DISTINCT m.id FROM ' . DB_TABLE_PREFIX . '_' . $this->tablename . ' m ';
            $sql .= 'JOIN ' . DB_TABLE_PREFIX . '_content_expTags ct ';
            $sql .= 'ON m.id = ct.content_id WHERE ct.exptags_id=' . intval($where) . " AND ct.content_type='" . $this->classname . "'";
            if ($supports_revisions) $sql .= " AND revision_id=(SELECT MAX(revision_id) FROM `" . $db->prefix . $this->tablename . "` WHERE ct.exptags_id=" . intval($where) . " AND ct.content_type='" . $this->classname . "'";
            $tag_assocs = $db->selectObjectsBySql($sql);
            $records    = array();
            foreach ($tag_assocs as $assoc) {
                $records[] = new $this->classname($assoc->id);
            }
            return $records;
        } elseif (strcasecmp($range, 'bycat') == 0) {  // return items categorized/grouped under request (id or title/sef_url)
            if (!is_int($where))  $where = $db->selectObject(DB_TABLE_PREFIX . '_expCats',"title='" . $where . "' OR sef_url='" . $where . "'");
            $sql = 'SELECT DISTINCT m.id FROM ' . DB_TABLE_PREFIX . '_' . $this->tablename . ' m ';
            $sql .= 'JOIN ' . DB_TABLE_PREFIX . '_content_expCats ct ';
            $sql .= 'ON m.id = ct.content_id WHERE ct.expcats_id=' . intval($where) . " AND ct.content_type='" . $this->classname . "'";
            if ($supports_revisions) $sql .= " AND revision_id=(SELECT MAX(revision_id) FROM `" . $db->prefix . $this->tablename . "` WHERE ct.expcats_id=" . intval($where) . " AND ct.content_type='" . $this->classname . "'";
            $cat_assocs = $db->selectObjectsBySql($sql);
            $records    = array();
            foreach ($cat_assocs as $assoc) {
                $records[] = new $this->classname($assoc->id);
            }
            return $records;
        }
    }

    /**
     * find an item by column
     *
     * @param       $column
     * @param       $value
     * @param bool  $get_assoc
     * @param bool  $get_attached
     * @param array $except
     * @param bool  $cascade_except
     *
     * @return array
     */
    public function findBy($column, $value, $get_assoc = true, $get_attached = true, $except = array(), $cascade_except = false) {
//        global $db;

        $where = "`" . $column . "`=";
        if (!is_numeric($value)) $where .= "'";
        $where .= $value;
        if (!is_numeric($value)) $where .= "'";
        return $this->find('first', $where, null, null, 0, $get_assoc, $get_attached, $except, $cascade_except);
    }

    /**
     * find a value(s) by column
     *
     * @param string    $range
     * @param string    $column
     * @param string    $where
     * @param string    $order
     * @param bool      $distinct
     *
     * @return array|bool
     */
    public function findValue($range = 'all', $column, $where=null, $order=null, $distinct=false) {
        global $db;

        if (strcasecmp($range, 'all') == 0) {  // return all items matching request
            return $db->selectColumn($this->tablename, $column, $where, $order, $distinct);
        } elseif (strcasecmp($range, 'first') == 0) {  // return single/first item matching request
            return $db->selectValue($this->tablename, $column, $where);
        }
        return false;
    }

    /**
     * update item
     *
     * @param array $params
     */
    public function update($params = array()) {
        if (is_array($params) && isset($params['current_revision_id'])) {
            $params['revision_id'] = $params['current_revision_id'];
            unset($params['current_revision_id']);
        }
        $this->checkForAttachableItems($params);
        $this->build($params);
        if (is_array($params)) {
            $this->save((isset($params['_validate']) ? $params['_validate'] : true));
        } elseif (is_object($params)) {
            $this->save((isset($params->_validate) ? $params->_validate : true));
        } else {
            $this->save(true);
        }
    }

    /**
     * re-construct the item from the database
     *
     * @return bool
     */
    public function refresh() {
        if (empty($this->id))
            return false;
        $this->__construct($this->id);
    }

    /**
     * Adds table fields as class properties to current "record" class.
     *
     * Loads Table schema data and creates new class properties based
     * upon the fields in given table.
     *
     * Additionally, if a record ID is given, that record is pulled and
     * field values are also populated into class properties.
     *
     * @name          build
     *
     * @category db_record
     * @uses     [db_type]::getDataDefinition() Builds  a data definition from existing table.
     * @requires $db
     *
     * @access   protected
     * @final
     * @PHPUnit  Not Defined
     *
     * @global object $db
     *
     * @param mixed   $params array or Object for table selection
     */
    public function build($params = array()) {
        global $db;

        // safeguard against bad data...we can only take objects and arrays here
        if (!is_array($params) && !is_object($params)) $params = array();

        // get the table definition and make sure all the params being passed in belong in this table
        $table = $db->getDataDefinition($this->tablename);

        //check for location_data
        if (is_array($params) && ((!empty($params['module']) || !empty($params['controller'])) && !empty($params['src']))) {
            $mod = !empty($params['module']) ? $params['module'] : (!empty($params['controller']) ? $params['controller'] : null);
            if (empty($params['module'])) $params['module'] = $params['controller'];
            $params['location_data'] = serialize(expCore::makeLocation($mod, $params['src']));
        } elseif (is_object($params) && ((!empty($params->module) || !empty($params->controller)) && !empty($params->src))) {
            $mod = !empty($params->module) ? $params->module : (!empty($params->controller) ? $params->controller : null);
            if (empty($params->module)) $params->module = $params->controller;
            $params->location_data = serialize(expCore::makeLocation($mod, $params->src));
        }

        // Build Class properties based off table fields
        foreach ($table as $col=> $colDef) {
            // check if the DB column has a corresponding value in the params array
            // if not, we check to see if the column is boolean...if so we set it to false
            // if not, then we check to see if we had a previous value in this particular 
            // record.  if so we reset it to itself so we don't lose the existing value.
            // this is good for when the developer is trying to update just a field or two 
            // in an existing record. 
            if (array_key_exists($col, $params)) {
                $value = is_array($params) ? $params[$col] : $params->$col;
                if ($colDef[0] == DB_DEF_INTEGER || $colDef[0] == DB_DEF_ID) {
                    $this->$col = preg_replace("/[^0-9-]/", "", $value);
                } elseif ($colDef[0] == DB_DEF_DECIMAL) {
                    $this->$col = preg_replace("/[^0-9.-]/", "", $value);
                } else {
                    $this->$col = $value;
                }
            } elseif ($colDef[0] == DB_DEF_BOOLEAN) {
                $this->$col = empty($this->$col) ? 0 : $this->$col;
            } elseif ($colDef[0] == DB_DEF_TIMESTAMP) {
                // yuidatetimecontrol sends in a checkbox and a date e.g., publish & publishdate
                $datename = $col . 'date';
                if (is_array($params) && isset($params[$datename])) {
                    $this->$col = yuidatetimecontrol::parseData($col, $params);
                } elseif (is_object($params) && isset($params->$datename)) {
                    $this->$col = yuidatetimecontrol::parseData($col, object2Array($params));
                } else {
                    $this->$col = !empty($this->$col) ? $this->$col : 0;
                }
            } else {
                $this->$col = !empty($this->$col) ? $this->$col : null;
            }

            //if (isset($this->col)) {
            if ($col != 'data' && is_string($this->$col)) {
                $this->$col = stripslashes($this->$col);
            }
            //}
            if (ENABLE_WORKFLOW && $this->supports_revisions && $col == 'revision_id' && $this->$col == null)
                $this->$col = 1;  // first revision is #1
        }
    }

    /**
     * rerank items
     *
     * @param        $direction
     * @param string $where
     */
    public function rerank($direction, $where = '') {
        global $db;

        if (!empty($this->rank)) {
            $next_prev = $direction == 'up' ? $this->rank - 1 : $this->rank + 1;
            $where .= empty($this->location_data) ? null : (!empty($where) ? " AND " : '') . "location_data='" . $this->location_data . "'" . $this->grouping_sql;
            $db->switchValues($this->tablename, 'rank', $this->rank, $next_prev, $where);
        }
    }

    /**
     * attach to item
     *
     * @param        $item
     * @param string $subtype
     * @param bool   $replace
     *
     * @return bool
     */
    public function attachItem($item, $subtype = '', $replace = true) { //FIXME only placed used is in helpController->copydocs (though we don't have attachments), & migration
        global $db;

        // make sure we have the info we need..otherwise return
        if (empty($item->id) && empty($this->id)) return false;
        // save the attachable items
//        $refname = strtolower($item->classname).'s_id';  //FIXME plural vs single?
//        $refname = strtolower($item->classname) . '_id'; //FIXME plural vs single?
        $refname = strtolower($item->tablename) . '_id';
        if ($replace) $db->delete($item->attachable_table, 'content_type="' . $this->classname . '" AND content_id=' . $this->id . ' AND ' . $refname . '=' . $item->id);
        $obj               = new stdClass();
        $obj->$refname     = $item->id;
        $obj->content_id   = $this->id;
        $obj->content_type = $this->classname;
        $obj->subtype      = $subtype;
        $obj->rank         = 1 + $db->max($item->attachable_table, 'rank', null, 'content_type="' . $this->classname . '" AND subtype="' . $subtype . '" AND content_id' . $this->id);
        $db->insertObject($obj, $item->attachable_table);
    }

    /**
     * save item
     *
     * @param bool $validate
     * @param bool $force_no_revisions
     */
    public function save($validate = false, $force_no_revisions = false) {
        global $db;

        // call the validation callback functions if we need to.
        if ($validate) {
            $this->beforeValidation();
            $this->validate();
            $this->afterValidation();
        }

        $this->beforeSave();

        // Save this object's associated objects to the database.
        // FIXME: we're not going to do this automagically until we get the refreshing figured out.
        //$this->saveAssociatedObjects(); 

        //Only grab fields that are valid and save this object
        $saveObj = new stdClass();
        $table   = $db->getDataDefinition($this->tablename);
        foreach ($table as $col=> $colDef) {
            $saveObj->$col = empty($this->$col) ? null : $this->$col;
        }

        if (ENABLE_WORKFLOW && $this->supports_revisions && !$this->approved && expPermissions::check('approve', expUnserialize($this->location_data))) {
            $saveObj->approved = true;  // auto-approve item if use has approve perm
        }
        $identifier = $this->identifier;
        if (!empty($saveObj->$identifier)) {
            $revise = $force_no_revisions ? false : $this->supports_revisions && ENABLE_WORKFLOW;
            $db->updateObject($saveObj, $this->tablename, null, $identifier, $revise);
            $this->afterUpdate();
        } else {
            $this->$identifier = $db->insertObject($saveObj, $this->tablename);
            $this->afterCreate();
        }

        // run the afterSave callback(s)
        $this->afterSave();
    }

    /**
     * before validating item
     */
    public function beforeValidation() {
        $this->runCallback('beforeValidation');
        if (empty($this->id)) {
            $this->beforeValidationOnCreate();
        } else {
            $this->beforeValidationOnUpdate();
        }
    }

    /**
     * before validating item during creation
     */
    public function beforeValidationOnCreate() {
        $this->runCallback('beforeValidationOnCreate');
    }

    /**
     * before validating item during update
     */
    public function beforeValidationOnUpdate() {
        $this->runCallback('beforeValidationOnUpdate');
    }

    /**
     * validate item sef_url
     *
     * @return bool
     */
    public function validate() {
        global $db;
        // check for an sef url field.  If it exists make sure it's valid and not a duplicate
        //this needs to check for SEF URLS being turned on also: TODO

        if (property_exists($this, 'sef_url') && !(in_array('sef_url', $this->do_not_validate))) {
            if (empty($this->sef_url)) $this->makeSefUrl();
            if (!isset($this->validates['is_valid_sef_name']['sef_url'])) $this->validates['is_valid_sef_name']['sef_url'] = array();
            if (!isset($this->validates['uniqueness_of']['sef_url'])) $this->validates['uniqueness_of']['sef_url']         = array();
        }

        // safeguard again loc data not being pass via forms...sometimes this happens when you're in a router
        // mapped view and src hasn't been passed in via link to the form 
        if (isset($this->id) && empty($this->location_data)) {
            $loc = $db->selectValue($this->tablename, 'location_data', 'id=' . $this->id);
            if (!empty($loc)) $this->location_data = $loc;
        }

        // run the validation as defined in the models
        if (!isset($this->validates)) return true;
        $messages = array();
        $post     = empty($_POST) ? array() : expString::sanitize($_POST);
        foreach ($this->validates as $validation=> $field) {
            foreach ($field as $key=> $value) {
                $fieldname = is_numeric($key) ? $value : $key;
                $opts      = is_numeric($key) ? array() : $value;
                $ret       = expValidator::$validation($fieldname, $this, $opts);
                if (!is_bool($ret)) {
                    $messages[] = $ret;
                    expValidator::setErrorField($fieldname);
                    unset($post[$fieldname]);
                }
            }
        }

        if (count($messages) >= 1) expValidator::failAndReturnToForm($messages, $post);
    }

    /**
     * after validating item
     */
    public function afterValidation() {
        $this->runCallback('afterValidation');
        if (empty($this->id)) {
            $this->afterValidationOnCreate();
        } else {
            $this->afterValidationOnUpdate();
        }
    }

    /**
     * after validating item during creation
     */
    public function afterValidationOnCreate() {
        $this->runCallback('afterValidationOnCreate');
    }

    /**
     * after validating item during update
     */
    public function afterValidationOnUpdate() {
        $this->runCallback('afterValidationOnUpdate');
    }

    /**
     * before saving item
     */
    public function beforeSave() {
        global $user, $db;

        $this->runCallback('beforeSave');
        // populate the magic fields
        if (empty($this->id)) {
            // timestamp the record
            if (property_exists($this, 'created_at')) $this->created_at = time();
            if (property_exists($this, 'edited_at')) $this->edited_at = time();
            // record the user saving the record.
            if (property_exists($this, 'poster')) $this->poster = empty($this->poster) ? $user->id : $this->poster;
            // fill in the rank field if it exist
            if (property_exists($this, 'rank')) {
//                if (!isset($this->rank)) {
                if (empty($this->rank)) {  // ranks begin at 1, so 0 is now last
                    $where = "1 ";
                    $where .= empty($this->location_data) ? null : "AND location_data='" . $this->location_data . "' ";
                    //FIXME: $where .= empty($this->rank_by_field) ? null : "AND " . $this->rank_by_field . "='" . $this->$this->rank_by_field . "'";
                    $groupby = empty($this->location_data) ? null : 'location_data';
                    $groupby .= empty($this->rank_by_field) ? null : (empty($groupby) ? null : ',' . $this->rank_by_field);
                    $this->rank = $db->max($this->tablename, 'rank', $groupby, $where . $this->grouping_sql) + 1;
                } else {
                    // check if this rank is already there..if so increment everything below it.
                    $obj = $db->selectObject($this->tablename, 'rank=' . $this->rank . $this->grouping_sql);
                    if (!empty($obj)) {
                        $db->increment($this->tablename, 'rank', 1, 'rank>=' . $this->rank . $this->grouping_sql);
                    }
                }
            }

            $this->beforeCreate();
        } else {
            // put the created_at time back the way it was so we don't set it 0
            if (property_exists($this, 'created_at') && $this->created_at == 0) {
                $this->created_at = $db->selectValue($this->tablename, 'created_at', 'id=' . $this->id);
            }

            // put the original posters id back the way it was so we don't set it 0
            if (property_exists($this, 'poster') && $this->poster == 0) {
                $this->poster = $db->selectValue($this->tablename, 'poster', 'id=' . $this->id);
            }

            //put the rank back to what it was so we don't set it 0
            if (property_exists($this, 'rank') && $this->rank == 0) {
                $this->rank = $db->selectValue($this->tablename, 'rank', 'id=' . $this->id);
            }

            if (property_exists($this, 'edited_at')) $this->edited_at = time();
            if (property_exists($this, 'editor')) $this->editor = $user->id;

            $this->beforeUpdate();
        }
    }

    /**
     * before creating item
     */
    public function beforeCreate() {
        $this->runCallback('beforeCreate');
    }

    /**
     * before updating item
     */
    public function beforeUpdate() {
        // we need some help migrating edited dates
        if (!empty($this->migrated_at)) {
            $this->edited_at = $this->migrated_at;
            unset($this->migrated_at);
        }
        $this->runCallback('beforeUpdate');
    }

    /**
     * after updating item
     */
    public function afterUpdate() {
        $this->runCallback('afterUpdate');
    }

    /**
     * after creating item
     */
    public function afterCreate() {
        $this->runCallback('afterCreate');
    }

    /**
     * after saving item
     */
    public function afterSave() {
        global $db;

        $this->runCallback('afterSave');

        // save all attached items
        if (!empty($this->attachable_items_to_save)) {
            foreach ($this->attachable_item_types as $type) {
                if (!empty($this->attachable_items_to_save[$type])) {
                    $itemtype = new $type();
                    // clean up (delete) old attachments since we'll create all from scratch
                    $db->delete($itemtype->attachable_table, 'content_type="' . $this->classname . '" AND content_id=' . $this->id);
//                    $refname = strtolower($type).'s_id';  //FIXME: find a better way to pluralize these names!!!
                    $refname = strtolower($itemtype->tablename) . '_id'; //FIXME: find a better way to pluralize these names!!!
                    foreach ($this->attachable_items_to_save[$type] as $subtype=> $item) {
                        $obj = new stdClass();
                        if (is_object($item)) {
                            if (!empty($item->id)) {
                                $obj->$refname     = $item->id;
                                $obj->subtype      = $subtype;
                                $obj->content_id   = $this->id;
                                $obj->content_type = $this->classname;
                                if ($type == 'expFile' || $type == 'expCats') $obj->rank = $item->rank + 1;
                                $db->insertObject($obj, $itemtype->attachable_table);
                            }
                        } elseif (is_array($item)) {
                            foreach ($item as $rank=>$value) {
                                if (is_numeric($value)) {
                                    $obj->$refname     = $value;
                                    $obj->subtype      = $subtype;
                                    $obj->content_id   = $this->id;
                                    $obj->content_type = $this->classname;
                                    if ($type == 'expFile' || $type == 'expCats') $obj->rank = $rank + 1;
                                    $db->insertObject($obj, $itemtype->attachable_table);
                                }
                            }
                        } elseif (is_numeric($item)) {
                            $obj->$refname     = $item;
                            $obj->content_id   = $this->id;
                            $obj->content_type = $this->classname;
                            if ($type == 'expFile' || $type == 'expCats') $obj->rank = $subtype + 1;
                            $db->insertObject($obj, $itemtype->attachable_table);
                        }
                    }
                }
            }
        }
    }

    /**
     * is run before deleting item
     */
    public function beforeDelete() {
        $this->runCallback('beforeDelete');
    }

    /**
     * delete item
     *
     * @param string $where
     *
     * @return bool
     */
    public function delete($where = '') {
        global $db;

        $id = $this->identifier;
        if (empty($this->$id)) return false;
        $this->beforeDelete();
        $db->delete($this->tablename, $id . '=' . $this->$id);
        if (!empty($where)) $where .= ' AND ';  // for help in reranking, NOT deleting object
        if (property_exists($this, 'rank')) $db->decrement($this->tablename, 'rank', 1, $where . 'rank>=' . $this->rank . $this->grouping_sql);

        // delete attached items
        foreach ($this->attachable_item_types as $content_table=> $type) {
            $db->delete($content_table, 'content_type="' . $this->classname . '" AND content_id=' . $this->$id);
        }
        // leave associated items to the model afterDelete method?
        $this->afterDelete();
    }

    /**
     * is run after deleting item
     */
    public function afterDelete() {
        $this->runCallback('afterDelete');
    }

    /**
     * jump to subclass calling routine
     *
     * @param $type
     *
     * @return bool
     */
    private function runCallback($type) {
        if (empty($type)) return false;

        // check for and run any callbacks listed in the $type array.
        if ($this->classinfo->hasProperty($type)) {
            $callbacks = $this->classinfo->getProperty($type);
            foreach ($callbacks->getValue(new $this->classname(null, false, false)) as $func) {
                $this->$func();
            }
        }
    }

    /**
     * make an sef_url for item
     */
    public function makeSefUrl() {
        global $db, $router;

        if (!empty($this->title)) {
			$this->sef_url = $router->encode($this->title);
		} else {
			$this->sef_url = $router->encode('Untitled');
		}
        $dupe = $db->selectValue($this->tablename, 'sef_url', 'sef_url="'.$this->sef_url.'"' . $this->grouping_sql);
		if (!empty($dupe)) {
			list($u, $s) = explode(' ',microtime());
			$this->sef_url .= '-'.$s.'-'.$u;
		}
        $this->runCallback('makeSefUrl');
    }

    /**
     * get item's associated objects
     *
     * Type of associations
     *   has_one
     *   has_many
     *   has_and_belongs_to_many
     *
     * @param null $obj
     *
     * @return null
     */
    public function getAssociatedObjects($obj = null) { //FIXME not used??
        global $db;

        $records = array();

        foreach ($this->has_one as $assoc_object) {
            $ret = $db->selectObjects($this->tablename, $assoc_object . '_id=' . $obj->id);
            if (!empty($ret)) $obj->$assoc_object = $ret;
        }

        foreach ($this->has_many as $assoc_object) {
            $ret = $db->selectObjects($assoc_object, $this->tablename . '_id=' . $obj->id);
            if (!empty($ret)) $obj->$assoc_object = $ret;
        }

        foreach ($this->has_and_belongs_to_many as $assoc_object) {
            if (strcmp($this->tablename, $assoc_object) > 0) {
                $tablename = $assoc_object . '_' . $this->tablename;
            } else {
                $tablename = $this->tablename . '_' . $assoc_object;
            }

            //$ret = $db->selectObjects($tablename, $this->tablename.'_id='.$obj->id);
            $instances = $db->selectObjects($tablename, $this->tablename . '_id=' . $obj->id);
            $ret       = array();
            foreach ($instances as $instance) {
                $fieldname = $assoc_object . '_id';
                $ret[]     = $db->selectObject($assoc_object, 'id=' . $instance->$fieldname);
            }
            if (!empty($ret)) $obj->$assoc_object = $ret;
        }

        return $obj;
    }

    /**
     * this function finds models that have this attachable item attached
     *
     * @param $content_type
     *
     * @return array
     */
    public function findWhereAttachedTo($content_type) {
        global $db;

        $objarray = array();
        if (!empty($this->id) && !empty($this->attachable_table)) {
//            $assocs = $db->selectObjects($this->attachable_table, $this->classname.'s_id='.$this->id.' AND content_type="'.$content_type.'"');  //FIXME is it plural where others are single?
            $assocs = $db->selectObjects($this->attachable_table, strtolower($this->tablename) . '_id=' . $this->id . ' AND content_type="' . $content_type . '"');
            foreach ($assocs as $assoc) {
                if (class_exists($assoc->content_type)) $objarray[] = new $assoc->content_type($assoc->content_id);
            }
        }

        return $objarray;
    }

    /**
     * check for what objects may be attached
     *
     * @param $params
     *
     * @return bool
     */
    protected function checkForAttachableItems($params) {
        if (empty($params)) return false;
        foreach ($this->attachable_item_types as $type) {
            if (array_key_exists($type, $params)) {
                $this->attachable_items_to_save[$type] = is_array($params) ? $params[$type] : $params->$type;
            }
        }
    }

    /**
     *  used for import/export
     *
     * @return array
     */
    function getAttachableItemTables() {
        return $this->attachable_item_types;
    }

    /**
     * get attached objects for this item
     */
    protected function getAttachableItems() {
        global $db;

        foreach ($this->attachable_item_types as $content_table=> $type) {
            if ($this->classname == $type) break;

            $tablename = str_ireplace('content_', '', $content_table);
            if (!isset($this->id)) {
                $this->$type = array();
            } else {
                $sql = 'SELECT ef.*, cef.subtype AS subtype FROM ';
                $sql .= DB_TABLE_PREFIX . '_' . $tablename . ' ef JOIN ' . DB_TABLE_PREFIX . '_' . $content_table . ' cef ';
                $sql .= "ON ef.id = cef." . $tablename . "_id";
                $sql .= " WHERE content_id=" . $this->id;
                $sql .= " AND content_type='" . $this->classname . "'";
                if ($type == 'expComment') {
                    $sql .= " AND approved='1'";
                }

                $order = ($type == 'expFile' || $type == 'expCats' || $type == 'expDefinableField') ? ' ORDER BY rank ASC' : null;
                $sql .= $order;

                $items = $db->selectArraysBySql($sql);

                $attacheditems = array();
                foreach ($items as $item) {
                    //FIXME: find a better way to unpluralize the name!
                    $idname = strtolower($type) . '_id';
                    if (empty($item['subtype'])) {
                        $attacheditems[] = new $type($item, false, false);
                    } else {
                        if (!isset($attacheditems[$item['subtype']])) $attacheditems[$item['subtype']] = array();
                        $attacheditems[$item['subtype']][] = new $type($item, false, false);
                    }
                }

                $this->$type = $attacheditems;
            }
        }
    }

    /**
     * gets associated objects for this model
     *
     * Type of associations
     *   has_extended_fields
     *   has_one
     *   has_many
     *   has_many_self
     *   has_and_belongs_to_many
     *   has_and_belongs_to_self
     *
     * @param array $except
     * @param bool  $cascade_except
     *
     */
    private function getAssociatedObjectsForThisModel($except = array(), $cascade_except = false) {
        global $db;

        foreach ($this->has_extended_fields as $assoc_object) {
            // figure out the name of the model based off the models tablename
            $obj                 = new $assoc_object(null, false, false);
            $this->$assoc_object = $obj->find('first', $this->tablename . '_id = ' . $this->id);
        }

        //this requires a field in the table only with the ID of the associated object we're looking for in its table
        foreach ($this->has_one as $assoc_object) {
            // figure out the name of the model based off the models tablename
            if (!in_array($assoc_object, $except)) {
                $obj     = new $assoc_object(null, false, false);
                $id_name = $obj->tablename . '_id';

                // check to see if we have an association yet.  if not we'll initialize an empty model
                $id = empty($this->$id_name) ? array() : $this->$id_name;

                $this->$assoc_object = new $assoc_object($id, in_array($assoc_object, $this->get_assoc_for), in_array($assoc_object, $this->get_attachable_for));
            } else {
                $this->$assoc_object = array();
            }
        }

        //TODO: perhaps add a 'in' option to the find so we can pass an array of ids and make ONE db call instead of looping
        foreach ($this->has_many as $assoc_object) {
            if (!in_array($assoc_object, $except)) {
                $assoc_obj = new $assoc_object();

                $ret       = $db->selectArrays($assoc_obj->tablename, $this->tablename . '_id=' . $this->id, $assoc_obj->default_sort_field != '' ? $assoc_obj->default_sort_field . " " . $assoc_obj->default_sort_direction : null);
                $records   = array();
                if ($cascade_except) {
                    $record['except']         = $except;
                    $record['cascade_except'] = $cascade_except;
                }
                foreach ($ret as $record) {
                    $records[] = new $assoc_object($record, in_array($assoc_object, $this->get_assoc_for), in_array($assoc_object, $this->get_attachable_for));
                }
                $this->$assoc_object = $records;
            } else {
                //eDebug("No: " .$assoc_object);
                $this->$assoc_object = array();
            }
        }

        foreach ($this->has_many_self as $assoc_object) {
            if (!in_array($assoc_object, $except)) {
                $assoc_obj = new $assoc_object();

                $ret       = $db->selectArrays($assoc_obj->tablename, $assoc_obj->has_many_self_id . '=' . $this->id, $assoc_obj->default_sort_field != '' ? $assoc_obj->default_sort_field . " " . $assoc_obj->default_sort_direction : null);
                $records   = array();
                foreach ($ret as $record) {
                    $records[] = new $assoc_object($record, in_array($assoc_object, $this->get_assoc_for), in_array($assoc_object, $this->get_attachable_for));
                }
                $this->$assoc_object = $records;
            } else {
                $this->$assoc_object = array();
            }
        }

        foreach ($this->has_and_belongs_to_many as $assoc_object) {
            if (!in_array($assoc_object, $except)) {
                $assocObj  = new $assoc_object(null, false, false);
                $tablename = $this->makeManyToManyTablename($assocObj->tablename);

                $ret     = $db->selectObjects($assocObj->tablename, 'id IN (SELECT ' . $assocObj->tablename . '_id from ' . DB_TABLE_PREFIX . '_' . $tablename . ' WHERE ' . $this->tablename . '_id=' . $this->id . ')', $assocObj->default_sort_field != '' ? $assocObj->default_sort_field . " " . $assocObj->default_sort_direction : null);
                $records = array();
                foreach ($ret as $record) {
                    $record_array = object2Array($record);
                    // put in the current model as an exception, otherwise the auto assoc's keep initializing instances of each other in an
                    // infinite loop
                    $record_array['except'] = array($this->classinfo->name);
                    if ($cascade_except) {
                        $record_array['except']         = array_merge($record_array['except'], $except);
                        $record_array['cascade_except'] = $cascade_except;
                    }
                    $records[] = new $assoc_object($record_array, in_array($assoc_object, $this->get_assoc_for), in_array($assoc_object, $this->get_attachable_for));
                }
                $this->$assoc_object = $records;
            } else {
                $this->$assoc_object = array();
            }
        }

        foreach ($this->has_and_belongs_to_self as $assoc_object) {
            if (!in_array($assoc_object, $except)) {
                $assocObj  = new $assoc_object(null, false, false);
                $tablename = $this->makeManyToManyTablename($assocObj->classname);

                $ret     = $db->selectObjects($assocObj->tablename, 'id IN (SELECT ' . $assocObj->classname . '_id from ' . DB_TABLE_PREFIX . '_' . $tablename . ' WHERE ' . $this->tablename . '_id=' . $this->id . ')');
                $records = array();
                foreach ($ret as $record) {
                    $record_array = object2Array($record);
                    // put in the current model as an exception, otherwise the auto assoc's keep initializing instances of each other in an
                    // infinite loop
                    $record_array['except'] = array($this->classinfo->name);
                    $records[]              = new $assoc_object($record_array, in_array($assoc_object, $this->get_assoc_for), in_array($assoc_object, $this->get_attachable_for));
                }
                $this->$assoc_object = $records;
            } else {
                $this->$assoc_object = array();
            }
        }
    }

    /**
     * get objects this item belongs to ??
     *
     * Type of associations
     *   has_and_belongs_to_many
     *
     * @param $datatype
     * @param $id
     */
    public function associateWith($datatype, $id) { //FIXME not used??
        global $db;

        $assocObj = new $datatype();

        if (in_array($datatype, $this->has_and_belongs_to_many)) {
            $tablename     = $this->makeManyToManyTablename($assocObj->tablename);
            $thisid        = $this->tablename . '_id';
            $otherid       = $assocObj->tablename . '_id';
            $obj           = new stdClass();
            $obj->$thisid  = $this->id;
            $obj->$otherid = $id;
            $db->insertObject($obj, $tablename);
        }
    }

    /**
     * save associated objects
     *
     * Type of associations
     *   has_one
     *
     */
    public function saveAssociatedObjects() {
//        global $db;

        foreach ($this->has_one as $assoc_object) {
            $obj = $this->$assoc_object;
            $obj->save();

            $assoc_id_name        = $assoc_object . '_id';
            $this->$assoc_id_name = $obj->id;
        }
    }

    //why the compare to flip order?
    /**
     * create a many to many table relationship
     *
     * @param $assoc_table
     *
     * @return string
     */
    private function makeManyToManyTablename($assoc_table) {
        if (strcmp($this->tablename, $assoc_table) > 0) {
            $tablename = $assoc_table . '_' . $this->tablename;
        } else {
            $tablename = $this->tablename . '_' . $assoc_table;
        }
        return $tablename;
    }

    /**
     * return the item poster
     *
     * @param null $display
     * @return null|string
     */
    public function getPoster($display = null) {
        if (isset($this->poster)) {
            $user = new user($this->poster);
            return user::getUserAttribution($user->id, $display);
        } else {
            return null;
        }
    }

    /**
     * return the item timestamp
     *
     * @param int $type
     *
     * @return mixed
     */
    public function getTimestamp($type = 0) {
        if ($type == 0) $getType = 'created_at';
        elseif ($type == 'publish') $getType = 'publish';
        else $getType = 'edited_at';
        if (isset($this->$getType)) return expDateTime::format_date($this->$getType, DISPLAY_DATETIME_FORMAT);
        else return null;
    }

}

;

?>