lib/plugin/GooglePlugin.php

   1 <?php
   2
   3 /**
   4  * Copyright 2004 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 require_once 'lib/Google.php';
  24
  25 /**
  26  * This module is a wrapper for the Google Web APIs. It allows you to do Google searches,
  27  * retrieve pages from the Google cache, and ask Google for spelling suggestions.
  28  *
  29  * Note: You must first obtain a license key at http://www.google.com/apis/
  30  * Max 1000 queries per day.
  31  *
  32  * Other possible sample usages:
  33  *   Auto-monitor the web for new information on a subject
  34  *   Glean market research insights and trends over time
  35  *   Invent a catchy online game
  36  *   Create a novel UI for searching
  37  *   Add Google's spell-checking to an application
  38  */
  39 class WikiPlugin_GooglePlugin
  40     extends WikiPlugin
  41 {
  42     function getDescription()
  43     {
  44         return _("Make use of the Google API.");
  45     }
  46
  47     function getDefaultArguments()
  48     {
  49         return array('q' => '',
  50             'mode' => 'search', // or 'cache' or 'spell'
  51             'startIndex' => 1,
  52             'maxResults' => 10, // fixed to 10 for now by google
  53             'formsize' => 30,
  54             // 'language' => `??
  55             //'license_key'  => false,
  56         );
  57     }
  58
  59     function run($dbi, $argstr, &$request, $basepage)
  60     {
  61         $args = $this->getArgs($argstr, $request);
  62         //        if (empty($args['s']))
  63         //    return '';
  64         $html = HTML();
  65         extract($args);
  66         // prevent from dump
  67         if ($q and $request->isPost()) {
  68             require_once 'lib/Google.php';
  69             $google = new Google();
  70             if (!$google) return '';
  71             switch ($mode) {
  72                 case 'search':
  73                     $result = $google->doGoogleSearch($q);
  74                     break;
  75                 case 'cache':
  76                     $result = $google->doGetCachedPage($q);
  77                     break;
  78                 case 'spell':
  79                     $result = $google->doSpellingSuggestion($q);
  80                     break;
  81                 default:
  82                     trigger_error("Invalid mode");
  83             }
  84             if (isa($result, 'HTML'))
  85                 $html->pushContent($result);
  86             if (isa($result, 'GoogleSearchResults')) {
  87                 //TODO: result template
  88                 if (!empty($result->resultElements)) {
  89                     $list = HTML::ol();
  90                     foreach ($result->resultElements as $res) {
  91                         $li = HTML::li(LinkURL($res['URL'], $res['directoryTitle']), HTML::br(),
  92                             $res['directoryTitle'] ? HTML(HTML::raw('&nbsp;&nbsp;'), HTML::em($res['summary']), ' -- ', LinkURL($res['URL'])) : '');
  93                         $list->pushContent($li);
  94                     }
  95                     $html->pushContent($list);
  96                 } else
  97                     return _("Nothing found");
  98             }
  99             if (is_string($result)) {
 100                 // cache content also?
 101                 $html->pushContent(HTML::blockquote(HTML::raw($result)));
 102             }
 103         }
 104         if ($formsize < 1) $formsize = 30;
 105         // todo: template
 106         $form = HTML::form(array('action' => $request->getPostURL(),
 107                 'method' => 'post',
 108                 //'class'  => 'class', //fixme
 109                 'accept-charset' => 'UTF-8'),
 110             HiddenInputs(array('pagename' => $basepage,
 111                 'mode' => $mode)));
 112         $form->pushContent(HTML::input(array('type' => 'text',
 113             'value' => $q,
 114             'name' => 'q',
 115             'size' => $formsize)));
 116         $form->pushContent(HTML::input(array('type' => 'submit',
 117             'class' => 'button',
 118             'value' => gettext($mode)
 119         )));
 120         return HTML($html, $form);
 121     }
 122 }
 123
 124 // Local Variables:
 125 // mode: php
 126 // tab-width: 8
 127 // c-basic-offset: 4
 128 // c-hanging-comment-ender-p: nil
 129 // indent-tabs-mode: nil
 130 // End: