Spellchecker removed

With spell checkers available in all modern browsers, having a spell checker in
DokuWiki's core code is no longer necessary. This patch removes the spell
checking feature. It will be made available as optional plugin.

darcs-hash:20071123125840-7ad00-faf7aa4673421dbb3fad904ba5b46b4927a5176d.gz

2 files changed, 0 insertions, 316 deletions

diff --git a/lib/exe/js.php b/lib/exe/js.php
index c4fd81616..ad166da8d 100644
--- a/lib/exe/js.php
+++ b/lib/exe/js.php
@@ -50,9 +50,6 @@ function js_out(){
     if($edit){
         if($write){
             $files[] = DOKU_INC.'lib/scripts/edit.js';
-            if($conf['spellchecker']){
-                $files[] = DOKU_INC.'lib/scripts/spellcheck.js';
-            }
         }
         $files[] = DOKU_INC.'lib/scripts/media.js';
     }
@@ -118,17 +115,6 @@ function js_out(){
 
             // add lock timer
             js_runonstart("locktimer.init(".($conf['locktime'] - 60).",'".js_escape($lang['willexpire'])."',".$conf['usedraft'].")");
-
-            // load spell checker
-            if($conf['spellchecker']){
-                js_runonstart("ajax_spell.init('".
-                               js_escape($lang['spell_start'])."','".
-                               js_escape($lang['spell_stop'])."','".
-                               js_escape($lang['spell_wait'])."','".
-                               js_escape($lang['spell_noerr'])."','".
-                               js_escape($lang['spell_nosug'])."','".
-                               js_escape($lang['spell_change'])."')");
-            }
         }
     }
 
diff --git a/lib/exe/spellcheck.php b/lib/exe/spellcheck.php
deleted file mode 100644
index 01c70832e..000000000
--- a/lib/exe/spellcheck.php
+++ /dev/null
@@ -1,302 +0,0 @@
-<?php
-/**
- * DokuWiki Spellcheck AJAX backend
- *
- * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
- * @author     Andreas Gohr <andi@splitbrain.org>
- */
-
-/**
- * Licence info: This spellchecker is inspired by code by Garrison Locke available
- * at http://www.broken-notebook.com/spell_checker/index.php (licensed under the Terms
- * of an BSD license). The code in this file was nearly completly rewritten for DokuWiki
- * and is licensed under GPL version 2 (See COPYING for details).
- *
- * Original Copyright notice follows:
- *
- * Copyright (c) 2005, Garrison Locke
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- *   * Redistributions of source code must retain the above copyright notice,
- *     this list of conditions and the following disclaimer.
- *   * Redistributions in binary form must reproduce the above copyright notice,
- *     this list of conditions and the following disclaimer in the documentation
- *     and/or other materials provided with the distribution.
- *   * Neither the name of the http://www.broken-notebook.com nor the names of its
- *     contributors may be used to endorse or promote products derived from this
- *     software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
- * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
- * OF SUCH DAMAGE.
- */
-
-//fix for Opera XMLHttpRequests
-if(!count($_POST) && $HTTP_RAW_POST_DATA){
-  parse_str($HTTP_RAW_POST_DATA, $_POST);
-}
-
-if(!defined('DOKU_INC')) define('DOKU_INC',dirname(__FILE__).'/../../');
-require_once (DOKU_INC.'inc/init.php');
-session_write_close();
-require_once (DOKU_INC.'inc/utf8.php');
-require_once (DOKU_INC.'inc/aspell.php');
-require_once (DOKU_INC.'inc/common.php');
-
-header('Content-Type: text/plain; charset=utf-8');
-
-//create spell object
-$spell = new Aspell($conf['lang'],null,'utf-8');
-$spell->setMode(PSPELL_FAST);
-
-//add personal dictionary
-if(@file_exists(DOKU_INC.'conf/words.aspell')){
-  $spell->personal = DOKU_INC.'conf/words.aspell';
-}
-
-//call the requested function
-$call = 'spell_'.$_POST['call'];
-if(function_exists($call)){
-  $call();
-}else{
-  print "The called function does not exist!";
-}
-
-/**
- * replaces a link with blanks of same length
- * The first string is the complete link and
- * and the second optional string might be the
- * alternative text that would become part of
- * the result string and will be checked for
- * spelling errors again.
- *
- * callback for preg_replace_callback
- *
- * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
- * @author Andreas Gohr <andi@splitbrain.org>
- */
-function spaceslink($matches){
-  $string  = unslash($matches[1]);
-  $check   = unslash($matches[2]);
-  $result  = '  '; //opening [[
-  $result .= str_pad('',utf8_strlen($string),' ');
-  $result .= $check;
-  $result .= '  '; //closing ]]
-
-  return $result;
-}
-
-/**
- * Spellchecker. Called by an AJAX request
- *
- * Runs the given Text through Aspell and prints XHTML with
- * markup. The first char represents the error code:
- *
- * 0 - No spelling mistakes
- * 1 - Spelling mistakes found
- * 2 - An error occurred error message follows
- *
- * @author Andreas Gohr <andi@splitbrain.org>
- */
-function spell_check() {
-  global $spell;
-  $string = $_POST['data'];
-  $misspell = false;
-
-  // for streamlined line endings
-  $string = preg_replace("/(\015\012)|(\015)/","\012",$string);
-  $string = htmlspecialchars($string);
-
-  // make sure multiple spaces and leading are kept
-  $string = preg_replace('/^ /m','&nbsp;',$string);
-  $string = preg_replace('/  /','&nbsp; ',$string);
-
-  // we need the text as array later
-  $data = explode("\n",$string);
-
-  // don't check links and medialinks for spelling errors
-  $string = preg_replace_callback('/\{\{(.*?)(\|(.*?))?(\}\})/','spaceslink',$string);
-  $string = preg_replace_callback('/\[\[(.*?)(\|(.*?))?(\]\])/','spaceslink',$string);
-
-  // run aspell in terse sgml mode, ignore nbsp as correct word
-  if(!$spell->runAspell($string,$out,$err,array('!','+html','@nbsp'))){
-    print '2'; //to indicate an error
-    print "An error occurred while trying to run the spellchecker:\n";
-    print $err;
-    return;
-  }
-
-  #use this to debug raw aspell output
-  #print "1$out"; return;
-
-  // go through the result
-  $lines = split("\n",$out);
-  $rcnt  = count($lines)-1;    // aspell result count
-  $lcnt  = count($data)+1;     // original line counter
-
-
-  for($i=$rcnt; $i>=0; $i--){
-    $line = trim($lines[$i]);
-    if($line[0] == '@') continue; // comment
-    if($line[0] == '*') continue; // no mistake in this word
-    if($line[0] == '+') continue; // root of word was found
-    if($line[0] == '?') continue; // word was guessed
-    if(empty($line)){
-      // empty line -> new source line
-      $lcnt--;
-      continue;
-    }
-    // now get the misspelled words
-    if(preg_match('/^& ([^ ]+) (\d+) (\d+): (.*)/',$line,$match)){
-      // match with suggestions
-      $word = $match[1];
-      $off  = $match[3]-1;
-      $sug  = split(', ',$match[4]);
-    }elseif(preg_match('/^# ([^ ]+) (\d+)/',$line,$match)){
-      // match without suggestions
-      $word = $match[1];
-      $off  = $match[2]-1;
-      $sug  = null;
-    }else{
-      // couldn't parse output
-      print '2';
-      print "The spellchecker output couldn't be parsed.\n";
-      print "Line $i:".$line;
-      return;
-    }
-
-    $misspell = true;
-    //aspell < 0.60 returns singlebyte offsets
-    if($spell->version >= 600){
-      $len  = utf8_strlen($word);
-      $data[$lcnt] = utf8_substr_replace($data[$lcnt],spell_formatword($word,$sug),$off, $len);
-    }else{
-      $len  = strlen($word);
-      $data[$lcnt] = substr_replace($data[$lcnt],spell_formatword($word,$sug),$off, $len);
-    }
-
-  }//end of output parsing
-
-  // the first char returns the spell info
-  if($misspell){
-    $string = '1'.join('<br />',$data);
-  }else{
-    $string = '0'.join('<br />',$data);
-  }
-
-  if(!$_POST['utf8']){
-    // encode multibyte chars as entities for broken Konqueror
-    $string = utf8_tohtml($string);
-  }
-
-  //output
-  print $string;
-}
-
-/**
- * Formats a word with needed markup for the Suggestion Popup
- *
- * @author Andreas Gohr <andi@splitbrain.org>
- */
-function spell_formatword($word,$suggestions=null){
-  static $i = 1;
-
-  if(is_array($suggestions)){
-    //restrict to maximum of 7 elements
-    $suggestions = array_slice($suggestions,0,7);
-    $suggestions = array_map('htmlspecialchars',$suggestions);
-
-    if(!$_POST['utf8']){
-      //konqueror's broken UTF-8 handling needs this
-      $suggestions = array_map('utf8_tohtml',$suggestions);
-    }
-
-    $suggestions = array_map('addslashes',$suggestions);
-
-    $sug = ",'".join("','",$suggestions)."'"; // build javascript args
-  }else{
-    $sug = '';
-  }
-
-  $link = '<a href="javascript:ajax_spell.suggest('.$i.$sug.')" '.
-          'class="spell_error" id="spell__error'.$i.'">'.htmlspecialchars($word).'</a>';
-  $i++;
-  return $link;
-}
-
-/**
- * Rewrite markuped XHTML back to plain Text. AJAX callback
- *
- * @author Andreas Gohr <andi@splitbrain.org>
- */
-function spell_resume(){
-  $text = $_POST['data'];
-
-  //some browsers insert newlines instead of spaces
-  $text = preg_replace("/(\r\n|\n|\r)/", ' ', $text);
-  $text = preg_replace("=<br */?>=i", "\n", $text);
-
-  // remove HTML tags
-  $text = strip_tags($text);
-
-  // restore spaces
-  $text = preg_replace('/&nbsp;/',' ',$text);
-  $text = preg_replace('/\xC2\xA0/',' ',$text);
-
-  // restore quoted special chars
-  $text = unhtmlspecialchars($text);
-
-  // check if UTF-8 is accepted
-  if(!$_POST['utf8']){
-    // protect '&' (gets removed in JS later)
-    $text = str_replace('&','&amp;',$text);
-    // encode multibyte chars as entities for broken Konqueror
-    $text = utf8_tohtml($text);
-  }
-
-  // output
-  print $text;
-}
-
-/**
- * Just send data back as received for UTF-8 testing
- */
-function spell_utf8test(){
-  // we need to return the raw value - substr protects against XSS
-  print substr($_POST['data'],0,3);
-}
-
-/**
- * Reverse htmlspecialchars
- *
- * @author <donwilson at gmail dot com>
- * @author Andreas Gohr <andi@splitbrain.org>
- */
-function unhtmlspecialchars($string, $quotstyle=ENT_COMPAT){
-  $string = str_replace ( '&amp;', '&', $string );
-  $string = str_replace ( '&lt;', '<', $string );
-  $string = str_replace ( '&gt;', '>', $string );
-
-  if($quotstyle != ENT_NOQUOTES){
-    $string = str_replace ( '&quot;', '\"', $string );
-  }
-  if($quotstyle == ENT_QUOTES){
-    $string = str_replace ( '&#39;', '\'', $string );
-    $string = str_replace ( '&#039;', '\'', $string );
-  }
-
-  return $string;
-}
-
-//Setup VIM: ex: et ts=2 enc=utf-8 :
-?>