google-cse.php

<?php
/*
Plugin Name: Google CSE
Plugin URI: http://wordpress.org/extend/plugins/google-cse/
Description: Google powered search for your WordPress site or blog.
Version: 1.0.8
Author: Erik Eng
Author URI: http://erikeng.se/
License: GPLv2 or later
*/

/**
 * Define constants
 *
 * @constant string GCSE_VERSION Plugin version
 */
define('GCSE_VERSION', '1.0.6');

/**
 * Security
 *
 */
if(!function_exists('add_action')) {
    echo 'Hi there!  I\'m just a plugin, not much I can do when called directly.';
    exit;
}

/**
 * Admin
 *
 */
if(is_admin()) {
    require_once dirname( __FILE__ ) . '/admin.php';
}

/**
 * TODO: Localization
 *
 */

/**
 * Google API Request
 *
 * @see wp_remote_get
 *
 * @param boolean $test
 *
 * @since 1.0
 *
 * @return array
 */
function gcse_request($test = false)
{
    global $wp_query;
    $options = get_option('gcse_options');
    $q       = html_entity_decode(get_search_query());

    if(isset($options['key']) && $options['key'] &&
        isset($options['id']) && $options['id']) {

        // Build URL
        $num    = isset($wp_query->query_vars['posts_per_page']) &&
            $wp_query->query_vars['posts_per_page'] < 11 ?
            $wp_query->query_vars['posts_per_page'] : 10;
        $start  = isset($wp_query->query_vars['paged']) &&
            $wp_query->query_vars['paged'] ?
            ($wp_query->query_vars['paged']-1)*$num+1 : 1;
        $params = http_build_query(array(
            'key'         => trim($options['key']),
            'cx'          => trim($options['id']),
            'alt'         => 'json',
            'num'         => $num,
            'start'       => $start,
            'prettyPrint' => 'false',
            'q'           => $q));
        $url    = 'https://www.googleapis.com/customsearch/v1?'.$params;

        // Check for and return cached response
        if($response = get_transient('gcse_'.md5($url))) {
            return json_decode($response, true);
        }

        // Request response
        if(is_wp_error($response = wp_remote_get($url, array('sslverify' => false)))) {
            return array('error' => array('errors' =>
                array(array('reason' => $response->get_error_message()))));
        }
    }

    // Save and return new response
    if(isset($response['body'])) {
        set_transient('gcse_'.md5($url), $response['body'], 3600);
        return json_decode($response['body'], true);
    }
    else {
        return array();
    }
}

/**
 * Search Results
 *
 * @since 1.0
 *
 */
function gcse_results($posts, $q) {
    if($q->is_single !== true && $q->is_search === true) {
        global $wp_query;
        $response = gcse_request();
        if(isset($response['items']) && $response['items']) {

            $results = array();
            $options = get_option('gcse_options');
            foreach($response['items'] as $result) {
                if(!isset($options['match']) && $id = gcse_url_to_postid($result['link'])) {
                    $post = get_post($id);
                }
                else {
                    $mime = false;
                    if(!empty($result['mime'])) {
                        switch($result['mime']) {
                            case "application/pdf":
                                $mime = "PDF";
                                break;
                            case "application/vnd.openxmlformats-officedocument.presentationml.presentation":
                            case "application/vnd.openxmlformats-officedocument.presentationml.template":
                            case "application/vnd.openxmlformats-officedocument.presentationml.slideshow":
                            case "application/vnd.ms-powerpoint.addin.macroEnabled.12":
                            case "application/vnd.ms-powerpoint.presentation.macroEnabled.12":
                            case "application/vnd.ms-powerpoint.template.macroEnabled.12":
                            case "application/vnd.ms-powerpoint.slideshow.macroEnabled.12":
                            case "application/vnd.ms-powerpoint":
                                $mime = "PPT";
                                break;
                            case "application/msword":
                            case "application/vnd.openxmlformats-officedocument.wordprocessingml.document":
                            case "application/vnd.openxmlformats-officedocument.wordprocessingml.template":
                            case "application/vnd.ms-word.document.macroEnabled.12":
                            case "application/vnd.ms-word.template.macroEnabled.12":
                                $mime = "DOC";
                                break;
                            case "application/vnd.ms-excel":
                            case "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":
                            case "application/vnd.openxmlformats-officedocument.spreadsheetml.template":
                            case "application/vnd.ms-excel.sheet.macroEnabled.12":
                            case "application/vnd.ms-excel.template.macroEnabled.12":
                            case "application/vnd.ms-excel.addin.macroEnabled.12":
                            case "application/vnd.ms-excel.sheet.binary.macroEnabled.12":
                                $mime = "XLS";
                                break;
                        }
                    }
                    $post = (object)array(
                        'post_type'      => 'page',
                        'post_title'     => $result['title'],
                        'post_author'    => '',
                        'post_date'      => '',
                        'post_status'    => 'published',
                        'post_excerpt'   => $result['snippet'],
                        'post_content'   => $result['htmlSnippet'],
                        'guid'           => $result['link'],
                        'post_type'      => 'search',
                        'ID'             => 0,
                        'comment_status' => 'closed',
                        'mime'           => $mime,
                    );

                	// Adding in the featured image. You can use it if you'd like.
                    if(isset($result['pagemap']) && isset($result['pagemap']['cse_image']['0'])) {
                        $post->cse_img = $result['pagemap']['cse_image'][0]['src'];
                    }
                }
                $results[] = $post;
            }

            $post = '';
            // Set results as posts
            $posts = $results;
            $results = '';
            // Update post count
            $wp_query->post_count = count($posts);

            $wp_query->found_posts = $response['searchInformation']['totalResults'];

            // Pagination
            $posts_per_page = $wp_query->query_vars['posts_per_page'] < 11 ?
                $wp_query->query_vars['posts_per_page'] : 10;
            $wp_query->max_num_pages = ceil(
                $response['searchInformation']['totalResults'] /
                $posts_per_page);

            // Apply filters
            add_filter('the_permalink', 'gcse_permalink');
        }
    }
    return $posts;
}
if(!is_admin()) {
    // Modifies results directly after query is made
    add_filter('posts_request', 'gcse_set_dummy_sql', 10, 2);
    add_filter('posts_results', 'gcse_results', 99, 2);
    add_filter('posts_results', 'gcse_fallback', 100, 2);
}

/**
 * URL to Post ID
 *
 * @param string $url
 *
 * @since 1.0
 *
 * @see url_to_postid
 * @see http://betterwp.net/wordpress-tips/url_to_postid-for-custom-post-types/
 *
 * @return int
 */
function gcse_url_to_postid($url)
{
    // TODO: Check url to post id map cache

    return url_to_postid($url);
}

/**
 * Permalink Filter
 *
 * @since 1.0
 *
 * @param string $the_permalink
 *
 * @return string
 *
 */
function gcse_permalink($the_permalink)
{
    if(function_exists('is_main_query') && is_main_query() && $the_permalink == '') {
        global $post;
        return $post->guid;
    }
    else {
        return $the_permalink;
    }
}

/**
 * Set Dummy SQL
 * 
 * Set the sql to SELECT TRUE to avoid a heavy sql query from the database that we won't use (we will get the results from Google Search)
 *
 * @since 1.0.8
 *
 * @param string $sql, $q
 *
 * @return string
 *
 */
function gcse_set_dummy_sql($sql, $q)
{
    if($q->is_single !== true && $q->is_search === true) {
        return "SELECT TRUE";
    }
    remove_filter('posts_request','gcse_set_dummy_sql',10);
    return $sql;
}

/**
 * Fallback
 *
 * After the Google Custom Search returns the results, we check if they are from a SELECT TRUE query.
 * If that is the case, it means the request to GCSE failed, so we have to get the results from our own database.
 *
 * @since 1.0.8
 *
 * @param array $posts, object $q
 *
 * @return array
 *
 */
function gcse_fallback($posts, $q)
{
    if($q->is_single != true && $q->is_search == true) {
        if (($posts[0]->filter == 'raw' && $posts[0]->TRUE == '1')) {
            remove_filter('posts_request','gcse_set_dummy_sql',10);
            remove_filter('posts_results','gcse_results',99);
            remove_filter('posts_results','fallback_google_cse',100);
            $posts = $q->get_posts();
        }
    }
    return $posts;
}