source: trunk/libs/Post.php @ 1375

<?php
/**
 * Post functions
 *
 * PHP version 5
 *
 * LICENSE: Hotaru CMS 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 3 of 
 * the License, or (at your option) any later version. 
 *
 * Hotaru CMS is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
 * FITNESS FOR A PARTICULAR PURPOSE. 
 *
 * You should have received a copy of the GNU General Public License along 
 * with Hotaru CMS. If not, see http://www.gnu.org/licenses/.
 * 
 * @category  Content Management System
 * @package   HotaruCMS
 * @author    Nick Ramsay <admin@hotarucms.org>
 * @copyright Copyright (c) 2009, Hotaru CMS
 * @license   http://www.gnu.org/copyleft/gpl.html GNU General Public License
 * @link      http://www.hotarucms.org/
 */
class Post
{
    // individual posts
    protected $id = 0;
    protected $archived         = 'N';            // archived Yes or No (Y/N)
    protected $author           = 0;            // post author
    protected $date             = '';           // post submission date
    protected $status           = 'unsaved';    // initial status before database entry
    protected $type             = '';           // post type, e.g. news, blog, forum
    protected $category         = 1;            // default category 'all'
    protected $tags             = '';           // tags
    protected $title            = '';           // post title
    protected $origUrl          = '';           // original url for the submitted post
    protected $domain           = '';           // the domain of the submitted url
    protected $url              = '';           // post slug (needs BASEURL and category attached)
    protected $content          = '';           // post description
    protected $contentLength    = 50;           // default min characters for content
    protected $summary          = '';           // truncated post description
    protected $summaryLength    = 200;          // default max characters for summary
    protected $comments         ='open';        // is the comment form open or closed?
    protected $subscribe        = 0;            // is the post author subscribed to comments?

    public $vars                = array();      // for additional fields

    /**
     * Access modifier to set protected properties
     */
    public function __set($var, $val)
    {
        $this->$var = $val;  
    }
    
    
    /**
     * Access modifier to get protected properties
     */
    public function &__get($var)
    {
        return $this->$var;
    }
    
    
    /**
     * Get all the settings for the current post
     *
     * @param int $post_id - Optional row from the posts table in the database
     * @param array $post_row - a post already fetched from the db, just needs reading
     * @return bool
     */    
    public function readPost($h, $post_id = 0, $post_row = NULL)
    {
        $h->vars['post_error'] = false; 
        
        if (!$post_id && !$post_row) {
            $post_id = $this->id;   // use the id already assigned to $h->post
        }
        
        if ($post_id != 0) {
            $post_row = $h->getPost($post_id);
            if (!$post_row) { $h->vars['post_error'] = true; return false; }
        }
        
        if ($post_row) {
            $this->id = $post_row->post_id;
            $this->archived = $post_row->post_archived;
            $this->author = $post_row->post_author;
            $this->date = $post_row->post_date;
            $this->status = $post_row->post_status;
            $this->type = urldecode($post_row->post_type);
            $this->category = urldecode($post_row->post_category);
            $this->tags = stripslashes(urldecode($post_row->post_tags));
            $this->title = stripslashes(urldecode($post_row->post_title));
            $this->origUrl = urldecode($post_row->post_orig_url);
            $this->domain = urldecode($post_row->post_domain);
            $this->url = urldecode($post_row->post_url);
            $this->content = stripslashes(urldecode($post_row->post_content));
            $this->comments = $post_row->post_comments;
            $this->subscribe = $post_row->post_subscribe;
            
            $this->vars['post_row'] = $post_row;    // make available to plugins
            
            $h->pluginHook('post_read_post');
                        
            return true;
        } else {
            return false;
        }
        
    }
    
    
    /**
     * Gets a single post from the database
     *
     * @param int $post_id - post id of the post to get
     * @return array|false
     */    
    public function getPost($h, $post_id = 0)
    {
        // Build SQL
        $query = "SELECT * FROM " . TABLE_POSTS . " WHERE post_id = %d ORDER BY post_date DESC";
        $sql = $h->db->prepare($query, $post_id);
        
        // Create temp cache array
        if (!isset($h->vars['tempPostCache'])) { $h->vars['tempPostCache'] = array(); }

        // If this query has already been read once this page load, we should have it in memory...
        if (array_key_exists($sql, $h->vars['tempPostCache'])) {
            // Fetch from memory
            $post = $h->vars['tempPostCache'][$sql];
        } else {
            // Fetch from database
            $post = $h->db->get_row($sql);
            $h->vars['tempPostCache'][$sql] = $post;
        }

        if ($post) { return $post; } else { return false; }
    }
    
    
    /**
     * Add a post to the database
     *
     * @return true
     */    
    public function addPost($h)
    {
        $sql = "INSERT INTO " . TABLE_POSTS . " SET post_author = %d, post_date = CURRENT_TIMESTAMP, post_status = %s, post_type = %s, post_category = %d, post_tags = %s, post_title = %s, post_orig_url = %s, post_domain = %s, post_url = %s, post_content = %s, post_subscribe = %d, post_updateby = %d";
        
        $h->db->query($h->db->prepare($sql, $this->author, $this->status, urlencode($this->type), $this->category, urlencode(trim($this->tags)), urlencode(trim($this->title)), urlencode($this->origUrl), urlencode($this->domain), urlencode(trim($this->url)), urlencode(trim($this->content)), $this->subscribe, $h->currentUser->id));
        
        $last_insert_id = $h->db->get_var($h->db->prepare("SELECT LAST_INSERT_ID()"));
        
        $this->id = $last_insert_id;
        $this->vars['last_insert_id'] = $last_insert_id;    // make it available outside this class
        
        // Update post_date field if $this->date has been declared
        // Normally used when scheduling or auto-submitting posts
        if ($this->date) {
           $date = date('YmdHis', $this->date);
           $sql = "UPDATE " . TABLE_POSTS . " SET post_date = %s WHERE post_id = %d";
           $h->db->query($h->db->prepare($sql, $date, $last_insert_id));
        }

        // Add tags to the Tags table:
        require_once(LIBS . 'Tags.php');
        $tags = new TagFunctions();
        $tags->addTags($h, $this->id, $this->tags);
        
        $h->pluginHook('post_add_post');
        
        return true;
    }
    
    
    /**
     * Update a post in the database
     *
     * @return true
     */    
    public function updatePost($h)
    {
        if (strstr($this->origUrl, BASEURL)) {
            // original url contains our base url, so it must be an "editorial" post.
            // Therefore, it's essential we rebuild this source url to match the updated post title to avoid errors:
            $this->origUrl = $h->url(array('page'=>$this->id)); // update the url with the real one
        }
        
        $parsed = parse_url($this->origUrl);
        if (isset($parsed['scheme'])){ $this->domain = $parsed['scheme'] . "://" . $parsed['host']; }
        
        $sql = "UPDATE " . TABLE_POSTS . " SET post_author = %d, post_status = %s, post_type = %s, post_category = %d, post_tags = %s, post_title = %s, post_orig_url = %s, post_domain = %s, post_url = %s, post_content = %s, post_subscribe = %d, post_comments = %s, post_updateby = %d WHERE post_id = %d";
        
        $h->db->query($h->db->prepare($sql, $this->author, $this->status, urlencode($this->type), $this->category, urlencode(trim($this->tags)), urlencode(trim($this->title)), urlencode($this->origUrl), urlencode($this->domain), urlencode(trim($this->url)), urlencode(trim($this->content)), $this->subscribe, $this->comments, $h->currentUser->id, $this->id));
        
        $h->post->id = $this->id; // a small hack to get the id for use in plugins.
        
        // Update tags in the Tags table:
        require_once(LIBS . 'Tags.php');
        $tags = new TagFunctions();
        $tags->deleteTags($h, $this->id); // delete existing tags
        $tags->addTags($h, $this->id, $this->tags); // insert new or updated tags
        
        $h->pluginHook('post_update_post');
        
        return true;
    }
    
    
    /**
     * Physically delete a post from the database 
     *
     * There's a plugin hook in here to delete their parts, e.g. votes, coments, tags, etc.
     */    
    public function deletePost($h)
    {
        if (!$this->id) { return false; }
        
        $sql = "DELETE FROM " . TABLE_POSTS . " WHERE post_id = %d";
        $h->db->query($h->db->prepare($sql, $this->id));
        
        $h->post->id = $this->id; // a small hack to get the id for use in plugins.
        
        // Delete tags from the Tags table:
        require_once(LIBS . 'Tags.php');
        $tags = new TagFunctions();
        $tags->deleteTags($h, $this->id); // delete existing tags
        
        $h->pluginHook('post_delete_post');
        
        // Need to clear both these cache to be sure the post is removed from widgets:
        $h->clearCache('html_cache', false); 
        $h->clearCache('db_cache', false); 
    }
    
    
    /**
     * Physically delete all posts by a specified user
     *
     * @param array $user_id
     * @return bool
     */
    public function deletePosts($h, $user_id = 0) 
    {
        if (!$user_id) { return false; }
        
        $sql = "SELECT post_id FROM " . TABLE_POSTS. " WHERE post_author = %d";
        $results = $h->db->get_results($h->db->prepare($sql, $user_id));
        
        if ($results) {
            foreach ($results as $r) {
                $h->post->id = $r->post_id; // used by other plugins in "post_delete_post" function/hook
                $this->deletePost($h);
            }
        }
        
        return true;
    }
    
    
    /**
     * Update a post's status
     *
     * @param string $status
     * @param int $post_id (optional)
     * @return true
     */    
    public function changePostStatus($h, $status = "processing", $post_id = 0)
    {
        $this->status = $status;
        if (!$post_id) { $post_id = $this->id; }
            
        $sql = "UPDATE " . TABLE_POSTS . " SET post_status = %s WHERE post_id = %d";
        $h->db->query($h->db->prepare($sql, $this->status, $post_id));
        
        // hacks for plugins:
        $h->post->id = $post_id;
         
        $h->pluginHook('post_change_status');
                
        return true;
    }
    
    
    /**
     * Checks for existence of a url
     *
     * @return array|false - array of posts
     */    
    public function urlExists($h, $url = '')
    {
        $sql = "SELECT post_id, post_status FROM " . TABLE_POSTS . " WHERE post_orig_url = %s";
        $posts = $h->db->get_results($h->db->prepare($sql, urlencode($url)));

        if (!$posts) { return false; }
        
        // we know there's at least one post with the same url, so if it's processing, let's delete it:
        foreach ($posts as $post) {
            if ($post->post_status == 'processing') {
                $h->post->id = $post->post_id;
                $h->deletePost($h);
            }
        }

        // One last check to see if a post is present:
        $sql = "SELECT count(post_id) FROM " . TABLE_POSTS . " WHERE post_orig_url = %s";
        $posts = $h->db->get_var($h->db->prepare($sql, urlencode($url)));
        
        if ($posts > 0) { return $posts; } else { return false; }
    }
    
    
    /**
     * Checks for existence of a post title
     *
     * @param str $title
     * @return int - id of post with matching title
     */
    public function titleExists($h, $title = '')
    {
        $title = trim($title);
        $sql = "SELECT post_id, post_status FROM " . TABLE_POSTS . " WHERE post_title = %s";
        $posts = $h->db->get_results($h->db->prepare($sql, urlencode($title)));
        
        if (!$posts) { return false; }
        
        // we know there's at least one post with the same title, so if it's processing, let's delete it:
        foreach ($posts as $post) {
            if ($post->post_status == 'processing') {
                $h->post->id = $post->post_id;
                $h->deletePost($h);
            }
        }
        
        // One last check to see if a post is present:
        $sql = "SELECT post_id FROM " . TABLE_POSTS . " WHERE post_title = %s";
        $post_id = $h->db->get_var($h->db->prepare($sql, urlencode($title)));
        
        if ($post_id) { return $post_id; } else { return false; }
    }
    
    
    /**
     * Checks for existence of a post with given post_url
     *
     * @param str $post_url (slug)
     * @return int - id of post with matching url
     */
    public function isPostUrl($h, $post_url = '')
    {
        $sql = "SELECT post_id FROM " . TABLE_POSTS . " WHERE post_url = %s";
        $post_id = $h->db->get_var($h->db->prepare($sql, urlencode($post_url)));
        if ($post_id) { return $post_id; } else { return false; }
    }
    
    
    /**
     * Count how many approved posts a user has had
     *
     * @param int $userid (optional)
     * @return int 
     */
    public function postsApproved($h, $user_id = 0)
    {
        if (!$user_id) { $user_id = $h->currentUser->id; }
        
        $sql = "SELECT COUNT(*) FROM " . TABLE_POSTS . " WHERE (post_status = %s || post_status = %s) AND post_author = %d";
        $count = $h->db->get_var($h->db->prepare($sql, 'top', 'new', $user_id));
        
        return $count;
        
    }
    
    
    /**
     * Delete posts with "processing" status that are older than 30 minutes
     */
    public function deleteProcessingPosts($h)
    {
        $exp = date('YmdHis', strtotime("-30 mins"));
        $sql = "DELETE FROM " . TABLE_POSTS . " WHERE post_status = %s AND post_date < %s";
        $h->db->query($h->db->prepare($sql, 'processing', $exp));
    }
    

    /**
     * Count posts in the last X hours/minutes for this user
     *
     * @param int $hours
     * @param int $minutes
     * @param int $user_id (optional)
     * @return int 
     */
    public function countPosts($h, $hours = 0, $minutes = 0, $user_id = 0)
    {
        if (!$user_id) { $user_id = $h->currentUser->id; }
        if ($hours) { 
            $time_ago = "-" . $hours . " Hours";
        } else {
            $time_ago = "-" . $minutes . " minutes";
        } 
        
        $start = date('YmdHis', strtotime("now"));
        $end = date('YmdHis', strtotime($time_ago));
        $sql = "SELECT COUNT(post_id) FROM " . TABLE_POSTS . " WHERE post_archived = %s AND post_author = %d AND (post_date >= %s AND post_date <= %s)";
        $count = $h->db->get_var($h->db->prepare($sql, 'N', $user_id, $end, $start));
        
        return $count;
    }
    
    
    /**
     * Get Unique Post Statuses
     *
     * @return array|false
     */
    public function getUniqueStatuses($h) 
    {
        /* This function pulls all the different statuses from current links, 
        or adds some defaults if not present.*/

        $unique_statuses = array();
        
        // Some essentials:
        array_push($unique_statuses, 'new');
        array_push($unique_statuses, 'top');
        array_push($unique_statuses, 'pending');
        array_push($unique_statuses, 'buried');
        array_push($unique_statuses, 'processing');
        
        // Add any other statuses already in use:
        $sql = "SELECT DISTINCT post_status FROM " . TABLE_POSTS;
        $statuses = $h->db->get_results($h->db->prepare($sql));
        if ($statuses) {
            foreach ($statuses as $status) {
                if ($status->post_status && !in_array($status->post_status, $unique_statuses)) {
                    array_push($unique_statuses, $status->post_status);
                }
            }
        }
        
        if ($unique_statuses) { return $unique_statuses; } else { return false; }
    }
    
    
    /**
     * Post stats
     *
     * @param string $stat_type
     * @return int
     */
    public function stats($h, $stat_type = '')
    {
        switch ($stat_type) {
            case 'total_posts':
                $sql = "SELECT count(post_id) FROM " . TABLE_POSTS;
                $posts = $h->db->get_var($sql);
                break;
            case 'approved_posts':
                $sql = "SELECT count(post_id) FROM " . TABLE_POSTS . " WHERE post_status = %s OR post_status = %s";
                $posts = $h->db->get_var($h->db->prepare($sql, 'top', 'new'));
                break;
            case 'pending_posts':
                $sql = "SELECT count(post_id) FROM " . TABLE_POSTS . " WHERE post_status = %s";
                $posts = $h->db->get_var($h->db->prepare($sql, 'pending'));
                break;
            case 'buried_posts':
                $sql = "SELECT count(post_id) FROM " . TABLE_POSTS . " WHERE post_status = %s";
                $posts = $h->db->get_var($h->db->prepare($sql, 'buried'));
                break;
            case 'archived_posts':
                $sql = "SELECT count(post_id) FROM " . TABLE_POSTS . " WHERE post_archived = %s";
                $posts = $h->db->get_var($h->db->prepare($sql, 'Y'));
                break;
            default:
                $posts = 0;
        }
        
        return $posts;
    }
}
?>