root/tags/0.8.2.1/bb-includes/functions.php

<?php
/* INIT */

function bb_global_sanitize( $array, $trim = true ) {
    foreach ($array as $k => $v) {
        if ( is_array($v) ) {
            $array[$k] = bb_global_sanitize($v);
        } else {
            if ( !get_magic_quotes_gpc() )
                $array[$k] = addslashes($v);
            if ( $trim )
                $array[$k] = trim($array[$k]);
        }
    }
    return $array;
}

function bb_is_installed() { // Maybe we should grab all forums and cache them.
    global $bbdb;
    $bbdb->hide_errors();
    $installed = $bbdb->get_var("SELECT * FROM $bbdb->forums LIMIT 1");
    $bbdb->show_errors();
    return $installed;
}

/* Forums */

function bb_get_forums_hierarchical( $root = 0, $depth = 0, $_leaves = false ) {
    $root = (int) $root;

    $_recursed = (bool) $_leaves;

    if ( false === $_leaves )
        $_leaves = get_forums();

    if ( !$_leaves )
        return false;

    $branch = array();

    foreach ( $_leaves as $l => $leaf ) {
        if ( $root == $leaf->forum_parent ) {
            $new_root = (int) $leaf->forum_id;
            unset($_leaves[$l]);
            $branch[$new_root] = 1 == $depth ? true : bb_get_forums_hierarchical( $new_root, $depth - 1, $_leaves );
        }
    }

    if ( !$_recursed )
        return $tree = empty($branch) ? false : $branch;

    return $branch ? $branch : true;
}

function get_forums( $args = null ) {
    if ( is_numeric($args) ) {
        $args = array( 'child_of' => $args, 'hierarchical' => 1, 'depth' => 0 );
    } elseif ( is_callable($args) ) {
        $args = array( 'callback' => $args );
        if ( 1 < func_num_args() )
            $args['callback_args'] = func_get_arg(1);
    }

    $defaults = array( 'callback' => false, 'callback_args' => false, 'child_of' => 0, 'hierarchical' => 0, 'depth' => 0 );
    $args = wp_parse_args( $args, $defaults );

    extract($args, EXTR_SKIP);
    $child_of = (int) $child_of;
    $hierarchical = 'false' == $hierarchical ? false : (bool) $hierarchical;
    $depth = (int) $depth;

    global $bb_cache;
    $forums = (array) apply_filters( 'get_forums', $bb_cache->get_forums() );

    if ( $child_of || $hierarchical || $depth ) {
        $_forums = bb_get_forums_hierarchical( $child_of, $depth );
        $_forums = (array) bb_flatten_array( $_forums );

        foreach ( array_keys($_forums) as $_id )
            $_forums[$_id] = $forums[$_id];

        $forums = $_forums;
    }

    if ( !is_callable($callback) )
        return $forums;

    if ( !is_array($callback_args) )
        $callback_args = array();

    foreach ( array_keys($forums) as $f ) :
        $_callback_args = $callback_args;
        array_push( $_callback_args, $forums[$f]->forum_id );
        if ( false == call_user_func_array( $callback, $_callback_args ) ) // $forum_id will be last arg;
            unset($forums[$f]);
    endforeach;
    return $forums;
}

function get_forum( $id ) {
    global $bb_cache;
    return $bb_cache->get_forum( $id );
}

/* Topics */

function get_topic( $id, $cache = true ) {
    global $bb_cache, $bb_topic_cache;
    if ( !$id = (int) $id )
        return false;
    if ( isset( $bb_topic_cache[$id] ) && $cache )
        return $bb_topic_cache[$id];
    else
        return $bb_cache->get_topic($id, $cache);
}

function get_latest_topics( $forum = 0, $page = 1, $exclude = '') {
    global $bbdb;
    $forum = (int) $forum;
    $page = (int) $page;
    $where = 'WHERE topic_status = 0';
    if ( $forum )
        $where .= " AND forum_id = $forum ";
    if ( !empty( $exclude ) )
        $where .= " AND forum_id NOT IN ('$exclude') ";
    if ( is_front() )
        $where .= " AND topic_sticky <> 2 ";
    elseif ( is_forum() || is_view() )
        $where .= " AND topic_sticky = 0 ";
    $limit = bb_get_option('page_topics');
    $where = apply_filters('get_latest_topics_where', $where);
    $order_by = apply_filters('get_latest_topics_order_by', 'topic_time DESC' );
    if ( 1 < $page )
        $limit = ($limit * ($page - 1)) . ", $limit";
    if ( $topics = $bbdb->get_results("SELECT SQL_CALC_FOUND_ROWS * FROM $bbdb->topics $where ORDER BY $order_by LIMIT $limit") )
        return bb_append_meta( $topics, 'topic' );
    else
        return false;
}

function get_sticky_topics( $forum = 0, $display = 1 ) {
    global $bbdb;
    if ( 1 != $display )
        return false;
    $forum = (int) $forum;
    if ( is_front() )
        $where = 'WHERE topic_sticky = 2  AND topic_status = 0';
    else    $where = 'WHERE topic_sticky <> 0 AND topic_status = 0';
    if ( $forum )
        $where .= " AND forum_id = $forum ";
    $where = apply_filters('get_sticky_topics_where', $where);
    $order_by = apply_filters('get_sticky_topics_order_by', 'topic_time DESC' );
    if ( $stickies = $bbdb->get_results("SELECT SQL_CALC_FOUND_ROWS * FROM $bbdb->topics $where ORDER BY $order_by") )
        return bb_append_meta( $stickies, 'topic' );    
    else    return false;
}

function get_recent_user_threads( $user_id ) {
    global $bbdb, $page;
    $limit = bb_get_option('page_topics');
    if ( 1 < $page )
        $limit = ($limit * ($page - 1)) . ", $limit";
    $join = apply_filters('get_recent_user_threads_join', '', $user_id);
    $where = apply_filters('get_recent_user_threads_where', 'AND topic_status = 0', $user_id);
    $order_by = apply_filters( 'get_recent_user_threads_order_by', 'topic_start_time DESC', $user_id);
    if ( $topics = $bbdb->get_results("SELECT SQL_CALC_FOUND_ROWS * FROM $bbdb->topics $join WHERE topic_poster = $user_id $where ORDER BY $order_by LIMIT $limit") )
        $topics = bb_append_meta( $topics, 'topic' );
    return $topics;
}

function bb_new_topic( $title, $forum, $tags = '' ) {
    global $bbdb, $bb_cache;
    $title = apply_filters('pre_topic_title', $title, false);
    $title = bb_trim_for_db( $title, 150 );
    $slug  = $_slug = bb_slug_sanitize($title);
    while ( is_numeric($slug) || $existing_slug = $bbdb->get_var("SELECT topic_slug FROM $bbdb->topics WHERE topic_slug = '$slug'") )
        $slug = bb_slug_increment($_slug, $existing_slug);

    $forum = (int) $forum;
    $now   = bb_current_time('mysql');

    $id = bb_get_current_user_info( 'id' );
    $name = bb_get_current_user_info( 'name' );

    if ( $forum && $title ) {
        $bbdb->query("INSERT INTO $bbdb->topics 
        (topic_title, topic_slug, topic_poster, topic_poster_name, topic_last_poster, topic_last_poster_name, topic_start_time, topic_time, forum_id)
        VALUES
        ('$title',    '$slug',    $id,          '$name',           $id,               '$name',                '$now',           '$now',     $forum)");
        $topic_id = $bbdb->insert_id;
        if ( !empty( $tags ) )
            add_topic_tags( $topic_id, $tags );
        $bbdb->query("UPDATE $bbdb->forums SET topics = topics + 1 WHERE forum_id = $forum");
        $bb_cache->flush_many( 'forum', $forum_id );
        do_action('bb_new_topic', $topic_id);
        return $topic_id;
    } else {
        return false;
    }
}

function bb_update_topic( $title, $topic_id ) {
    global $bbdb, $bb_cache;
    $title = apply_filters('pre_topic_title', $title, $topic_id);
    $topic_id = (int) $topic_id;

    if ( $topic_id && $title ) {
        $bbdb->query("UPDATE $bbdb->topics SET topic_title = '$title' WHERE topic_id = $topic_id");
        $bb_cache->flush_one( 'topic', $topic_id );
        do_action('bb_update_topic', $topic_id);
        return $topic_id;
    } else {
        return false;
    }
}

function bb_delete_topic( $topic_id, $new_status = 0 ) {
    global $bbdb, $bb_cache, $bb_table_prefix;
    $topic_id = (int) $topic_id;
    add_filter( 'get_topic_where', 'no_where' );
    if ( $topic = get_topic( $topic_id ) ) {
        $new_status = (int) $new_status;
        $old_status = (int) $topic->topic_status;
        if ( $new_status == $old_status )
            return;
        if ( 0 != $old_status && 0 == $new_status )
            add_filter('get_thread_post_ids_where', 'no_where');
        $post_ids = get_thread_post_ids( $topic_id );
        $post_ids['post'] = array_reverse((array) $post_ids['post']);
        foreach ( $post_ids['post'] as $post_id )
            _bb_delete_post( $post_id, $new_status );

        $ids = array_unique((array) $post_ids['poster']);
        foreach ( $ids as $id )
            if ( $user = bb_get_user( $id ) )
                bb_update_usermeta( $user->ID, $bb_table_prefix . 'topics_replied', ( $old_status ? $user->topics_replied + 1 : $user->topics_replied - 1 ) );

        if ( $new_status ) {
            bb_remove_topic_tags( $topic_id );
            $bbdb->query("UPDATE $bbdb->topics SET topic_status = '$new_status', tag_count = 0 WHERE topic_id = '$topic_id'");
            $bbdb->query("UPDATE $bbdb->forums SET topics = topics - 1, posts = posts - '$topic->topic_posts' WHERE forum_id = '$topic->forum_id'");
        } else {
            $bbdb->query("UPDATE $bbdb->topics SET topic_status = '$new_status' WHERE topic_id = '$topic_id'");
            $topic_posts = $bbdb->get_var("SELECT COUNT(*) FROM $bbdb->posts WHERE topic_id = '$topic_id' AND post_status = 0");
            $all_posts = $bbdb->get_var("SELECT COUNT(*) FROM $bbdb->posts WHERE topic_id = '$topic_id'");
            bb_update_topicmeta( $topic_id, 'deleted_posts', $all_posts - $topic_posts );
            $bbdb->query("UPDATE $bbdb->forums SET topics = topics + 1, posts = posts + '$topic_posts' WHERE forum_id = '$topic->forum_id'");
            $bbdb->query("UPDATE $bbdb->topics SET topic_posts = '$topic_posts' WHERE topic_id = '$topic_id'");
            bb_topic_set_last_post( $topic_id );
            update_post_positions( $topic_id );
        }
            
        do_action( 'bb_delete_topic', $topic_id, $new_status, $old_status );
        $bb_cache->flush_one( 'topic', $topic_id );
        $bb_cache->flush_many( 'thread', $topic_id );
        return $topic_id;
    } else {
        return false;
    }
}

function bb_move_topic( $topic_id, $forum_id ) {
    global $bbdb, $bb_cache;
    $topic_id = (int) $topic_id;
    $forum_id = (int) $forum_id;
    $topic = get_topic( $topic_id );
    if ( $topic && $topic->forum_id != $forum_id && get_forum( $forum_id ) ) {
        $bbdb->query("UPDATE $bbdb->posts SET forum_id = $forum_id WHERE topic_id = $topic_id");
        $bbdb->query("UPDATE $bbdb->topics SET forum_id = $forum_id WHERE topic_id = $topic_id");
        $bbdb->query("UPDATE $bbdb->forums SET topics = topics + 1, posts = posts + $topic->topic_posts WHERE forum_id = $forum_id");
        $bbdb->query("UPDATE $bbdb->forums SET topics = topics - 1, posts = posts - $topic->topic_posts WHERE forum_id = $topic->forum_id");
        $bb_cache->flush_one( 'topic', $topic_id );
        $bb_cache->flush_many( 'forum', $forum_id );
        return $forum_id;
    }
    return false;
}

function bb_topic_set_last_post( $topic_id ) {
    global $bbdb;
    $old_post = $bbdb->get_row("SELECT post_id, poster_id, post_time FROM $bbdb->posts WHERE topic_id = $topic_id AND post_status = 0 ORDER BY post_time DESC LIMIT 1");
    $old_name = $bbdb->get_var("SELECT user_login FROM $bbdb->users WHERE ID = $old_post->poster_id");
    $bbdb->query("UPDATE $bbdb->topics SET topic_time = '$old_post->post_time', topic_last_poster = $old_post->poster_id, topic_last_poster_name = '$old_name', topic_last_post_id = $old_post->post_id WHERE topic_id = $topic_id");
}    

function bb_close_topic( $topic_id ) {
    global $bbdb, $bb_cache;
    $topic_id = (int) $topic_id;
    $bb_cache->flush_one( 'topic', $topic_id );
    $r = $bbdb->query("UPDATE $bbdb->topics SET topic_open = '0' WHERE topic_id = $topic_id");
    do_action('close_topic', $topic_id, $r);
    return $r;
}

function bb_open_topic( $topic_id ) {
    global $bbdb, $bb_cache;
    $topic_id = (int) $topic_id;
    $bb_cache->flush_one( 'topic', $topic_id );
    $r = $bbdb->query("UPDATE $bbdb->topics SET topic_open = '1' WHERE topic_id = $topic_id");
    do_action('open_topic', $topic_id, $r);
    return $r;
}

function bb_stick_topic( $topic_id, $super = 0 ) {
    global $bbdb, $bb_cache;
    $topic_id = (int) $topic_id;
    $stick = 1 + abs((int) $super);
    $bb_cache->flush_one( 'topic', $topic_id );
    $r = $bbdb->query("UPDATE $bbdb->topics SET topic_sticky = '$stick' WHERE topic_id = $topic_id");
    do_action('stick_topic', $topic_id, $r);
}

function bb_unstick_topic( $topic_id ) {
    global $bbdb, $bb_cache;
    $topic_id = (int) $topic_id;
    $bb_cache->flush_one( 'topic', $topic_id );
    $r = $bbdb->query("UPDATE $bbdb->topics SET topic_sticky = '0' WHERE topic_id = $topic_id");
    do_action('unstick_topic', $topic_id, $r);
    return $r;
}

function topic_is_open( $topic_id = 0 ) {
    $topic = get_topic( get_topic_id( $topic_id ) );
    return 1 == $topic->topic_open;
}

function topic_is_sticky( $topic_id = 0 ) {
    $topic = get_topic( get_topic_id( $topic_id ) );
    return '0' !== $topic->topic_sticky;
}

/* Thread */ // Thread, topic?  Guh-wah?  TODO: consistency in nomenclature

function get_thread( $topic_id, $page = 1, $reverse = 0 ) {
    global $bb_cache;
    return $bb_cache->get_thread( $topic_id, $page, $reverse );
}

function get_thread_post_ids( $topic_id ) {
    global $bbdb, $thread_ids_cache;
    if ( !isset( $thread_ids_cache[$topic_id] ) ) {
        $where = apply_filters('get_thread_post_ids_where', 'AND post_status = 0');
        $thread_ids_cache[$topic_id]['post'] = (array) $bbdb->get_col("SELECT post_id, poster_id FROM $bbdb->posts WHERE topic_id = $topic_id $where ORDER BY post_time");
        $thread_ids_cache[$topic_id]['poster'] = (array) $bbdb->get_col('', 1);
    }
    return $thread_ids_cache[$topic_id];
}

/* Posts */

function bb_get_post( $post_id ) {
    global $bb_post_cache, $bbdb;
    $post_id = (int) $post_id;
    if ( !isset( $bb_post_cache[$post_id] ) )
        $bb_post_cache[$post_id] = $bbdb->get_row("SELECT * FROM $bbdb->posts WHERE post_id = $post_id");
    return $bb_post_cache[$post_id];
}

function bb_is_first( $post_id ) { // First post in thread
    global $bbdb;
    $bb_post = bb_get_post( $post_id );
    $where = apply_filters('bb_is_first_where', 'AND post_status = 0');
    $first_post = $bbdb->get_var("SELECT post_id FROM $bbdb->posts WHERE topic_id = $bb_post->topic_id $where ORDER BY post_id ASC LIMIT 1");

    return $post_id == $first_post;
}

// Globalizes the result.
function bb_get_first_post( $_topic = false, $author_cache = true ) {
    global $topic, $bb_first_post_cache, $bb_post;
    if ( !$_topic )
        $topic_id = (int) $topic->topic_id;
    else if ( is_object($_topic) )
        $topic_id = (int) $_topic->topic_id;
    else if ( is_numeric($_topic) )
        $topic_id = (int) $_topic;

    if ( !$topic_id )
        return false;

    if ( isset($bb_first_post_cache[$topic_id]) ) {
        $post = bb_get_post( $bb_first_post_cache[$topic_id] );
    } else {
        $first_posts = bb_cache_first_posts( array($topic_id), $author_cache );
        if ( isset($first_posts[$topic_id]) )
            $post = $first_posts[$topic_id];
    }

    if ( $post ) {
        $bb_post = $post;
        return $bb_post;
    }

    return false;
}

// Ignore the return value.  Cache first posts with this function and use bb_get_first_post to grab each.
function bb_cache_first_posts( $_topics = false, $author_cache = true ) {
    global $topics, $bb_first_post_cache, $bb_cache, $bbdb;
    if ( !$_topics )
        $_topics =& $topics;
    if ( !is_array($_topics) )
        return false;

    $topic_ids = array();
    foreach ( $_topics as $topic )
        if ( is_object($topic) )
            $topic_ids[] = (int) $topic->topic_id;
        else if ( is_numeric($topic) )
            $topic_ids[] = (int) $topic;

    $_topic_ids = join(',', $topic_ids);

    $posts = (array) $bb_cache->cache_posts( "SELECT * FROM $bbdb->posts WHERE topic_id IN ($_topic_ids) AND post_position = 1 AND post_status = 0" );

    $first_posts = array();
    foreach ( $posts as $post ) {
        $bb_first_post_cache[(int) $post->topic_id] = (int) $post->post_id;
        $first_posts[(int) $post->topic_id] = $post;
    }

    if ( $author_cache )
        post_author_cache( $posts );

    return $first_posts;
}

// Globalizes the result
function bb_get_last_post( $_topic = false, $author_cache = true ) {
    global $topic, $bb_post;
    if ( !$_topic )
        $topic_id = (int) $topic->topic_id;
    else if ( is_object($_topic) )
        $topic_id = (int) $_topic->topic_id;
    else if ( is_numeric($_topic) )
        $topic_id = (int) $_topic;

    if ( !$topic_id )
        return false;

    $_topic = get_topic( $topic_id );

    if ( $post = bb_get_post( $_topic->topic_last_post_id ) ) {
        if ( $author_cache )
            post_author_cache( array($post) );
        $bb_post = $post;
    }

    return $post;
}

// No return value. Cache last posts with this function and use bb_get_last_post to grab each.
function bb_cache_last_posts( $_topics = false, $author_cache = true ) {
    global $topics, $bb_topic_cache, $bb_cache, $bbdb;
    if ( !$_topics )
        $_topics =& $topics;
    if ( !is_array($_topics) )
        return false;

    $last_post_ids = array();
    $topic_ids = array();
    foreach ( $_topics