source: sandbox/expressoMail1_2/corretor_ortografico/spell_checker/spell_checker.php @ 2543

Revision 2543, 17.7 KB checked in by nathalie.silva, 14 years ago (diff)

Ticket #891 - Alterado o ignore, e quando a palavra foi corrigida, não abre o suggestion- Nathalie

Line 
1<?php
2/**********************************************************************************************
3 * AJAX Spell Checker - Version 2.8
4 * (C) 2005 - Garrison Locke
5 *
6 * This spell checker is built in the style of the Gmail spell
7 * checker.  It uses AJAX to communicate with the backend without
8 * requiring the page be reloaded.  If you use this code, please
9 * give me credit and a link to my site would be nice.
10 * http://www.broken-notebook.com.
11 *
12 * Copyright (c) 2005, Garrison Locke
13 * All rights reserved.
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions are met:
17 *
18 *   * Redistributions of source code must retain the above copyright notice,
19 *     this list of conditions and the following disclaimer.
20 *   * Redistributions in binary form must reproduce the above copyright notice,
21 *     this list of conditions and the following disclaimer in the documentation
22 *     and/or other materials provided with the distribution.
23 *   * Neither the name of the http://www.broken-notebook.com nor the names of its
24 *     contributors may be used to endorse or promote products derived from this
25 *     software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30 * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
31 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
34 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
36 * OF SUCH DAMAGE.
37 *
38 ***********************************************************************************************/
39
40// User-configurable list of allowed HTML tags and attributes.
41// Thanks to Jake Olefsky for this little addition
42//$allowed_html = '<strong><small><p><br><a><b><u><i><img><code><ul><ol><li>';  //Removed. Accept alll HTML tags.
43
44// Set the max number of suggestions to return at a time.
45define('MAX_SUGGESTIONS', 3);
46
47// Set whether to use a personal dictionary.
48$usePersonalDict = false;
49
50//Set whether users are allowed to update the personal dictionary.
51$editablePersonalDict = false;
52
53// If using a personal dictionary, set the path to it.  Default is in the
54// personal_dictionary subdirectory of the location of spell_checker.php.
55$path_to_personal_dictionary = dirname(__FILE__) . "/personal_dictionary/personal_dictionary.txt";
56
57//If pspell doesn't exist, then include the pspell wrapper for aspell.
58if(!function_exists('pspell_suggest'))
59{
60        // Set the path to aspell if you need to use it.
61        define('ASPELL_BIN','/usr/bin/aspell');
62        require_once ("pspell_comp.php");
63}
64
65// Create and configure a link to the pspell module.
66
67//$pspell_config = pspell_config_create("en");
68pspell_config_mode($pspell_config, PSPELL_FAST);
69
70if($usePersonalDict)
71{
72        // Allows the use of a custom dictionary (Thanks to Dylan Thurston for this addition).
73        pspell_config_personal($pspell_config, $path_to_personal_dictionary);
74}
75
76//$pspell_link = pspell_new_config($pspell_config);
77
78
79require_once("cpaint/cpaint2.inc.php"); //AJAX library file
80
81$cp = new cpaint();
82$cp->register('showSuggestions');
83$cp->register('spellCheck');
84$cp->register('switchText');
85$cp->register('addWord');
86$cp->start();
87$cp->return_data();
88
89
90/*************************************************************
91 * showSuggestions($word, $id)
92 *
93 * The showSuggestions function creates the list of up to 10
94 * suggestions to return for the given misspelled word.
95 *
96 * $word - The misspelled word that was clicked on
97 * $id - The id of the span containing the misspelled word.
98 *
99 *************************************************************/
100function showSuggestions($word, $id, $language)
101{
102        global $editablePersonalDict; //bool to set editability of personal dictionary
103        //global $pspell_link; //the global link to the pspell module
104        $pspell_link = pspell_new($language);
105        global $cp; //the CPAINT object
106       
107        $retVal = "";
108       
109        $suggestions = pspell_suggest($pspell_link, $word);  //an array of all the suggestions that psepll returns for $word.
110       
111        // If the number of suggestions returned by pspell is less than the maximum
112        // number, just use the number of suggestions returned.
113        $numSuggestions = count($suggestions);
114        $tmpNum = min($numSuggestions, MAX_SUGGESTIONS);
115                       
116        if($tmpNum > 0)
117        {
118                //this creates the table of suggestions.
119                //in the onclick event it has a call to the replaceWord javascript function which does the actual replacing on the page
120                for($i=0; $i<$tmpNum; $i++)
121                {
122                        $retVal .= "<div class=\"suggestion\" onclick=\"replaceWord('" . addslashes_custom($id) . "', '" . addslashes(utf8_encode($suggestions[$i])) . "'); return false;\">" . utf8_encode($suggestions[$i]) . " </div>";
123                }
124       
125                if($editablePersonalDict)
126                {
127                        $retVal .= "<div class=\"addtoDictionary\" onclick=\"addWord('" . addslashes_custom($id) . "'); return false;\">Add To Dictionary</div>";
128                }
129
130                //Ignore the suggestion - Added by Nathalie
131                $retVal .= "<div class=\"ignore\" onclick=\"ignore('" .  addslashes_custom($id)  . "', '" .   addslashes($word)   . "'); return false;\"> Ignorar </div>";
132
133
134        }
135        else
136        {
137                $retVal .= "Sem sugestão";
138                $retVal .= "<div class=\"ignore\" onclick=\"ignore('" .  addslashes_custom($id)  . "', '" .   addslashes($word)   . "'); return false;\"> Ignorar </div>";
139        }
140       
141        $cp->set_data($retVal);  //the return value - a string containing the table of suggestions.
142       
143} // end showSuggestions
144
145 
146/*************************************************************
147 * spellCheck($string)
148 *
149 * The spellCheck function takes the string of text entered
150 * in the text box and spell checks it.  It splits the text
151 * on anything inside of < > in order to prevent html from being
152 * spell checked.  Then any text is split on spaces so that only
153 * one word is spell checked at a time.  This creates a multidimensional
154 * array.  The array is flattened.  The array is looped through
155 * ignoring the html lines and spell checking the others.  If a word
156 * is misspelled, code is wrapped around it to highlight it and to
157 * make it clickable to show the user the suggestions for that
158 * misspelled word.
159 *
160 * $string - The string of text from the text box that is to be
161 *           spell checked.
162 *
163 *************************************************************/
164function spellCheck($string, $varName, $language)
165{
166        //global $pspell_link; //the global link to the pspell module
167        $pspell_link = pspell_new($language);
168        global $cp; //the CPAINT object
169        $retVal = "";
170
171        $string = stripslashes_custom($string); //we only need to strip slashes if magic quotes are on
172
173        $string = remove_word_junk($string);
174
175        //make all the returns in the text look the same
176        $string = preg_replace("/\r?\n/", "\n", $string);
177   
178        //splits the string on any html tags, preserving the tags and putting them in the $words array
179        $words = preg_split("/(<[^<>]*>)/", $string, -1, PREG_SPLIT_DELIM_CAPTURE);
180   
181        $numResults = count($words); //the number of elements in the array.
182
183        $misspelledCount = 0;   
184   
185        //this loop looks through the words array and splits any lines of text that aren't html tags on space, preserving the spaces.
186        for($i=0; $i<$numResults; $i++){
187                // Words alternate between real words and html tags, starting with words.
188                if(($i & 1) == 0) // Even-numbered entries are word sets.
189                {
190                        $words[$i] = preg_split("/(\s+)/", $words[$i], -1, PREG_SPLIT_DELIM_CAPTURE); //then split it on the spaces
191
192                        // Now go through each word and link up the misspelled ones.
193                        $numWords = count($words[$i]);
194                        for($j=0; $j<$numWords; $j++)
195                        {
196                                $word = utf8_decode($words[$i][$j]);
197
198                                $reg_expr = utf8_decode('A-ZáàâãÀéÚêëíìïîóòÎõöúùûÌÜÿçñÁÀÂÃÄÉÈÊËÍÌÏÎÓÒÔÕÖÚÙÛÜÝÇÑ');
199
200                                preg_match("/[$reg_expr]*/i", $word , $tmp); //get the word that is in the array slot $i
201
202                                $tmpWord = $tmp[0]; //should only have one element in the array anyway, so it's just assign it to $tmpWord
203                                $words[$i][$j] = utf8_decode($words[$i][$j]);
204
205                                //And we replace the word in the array with the span that highlights it and gives it an onClick parameter to show the suggestions.
206                                if(!pspell_check($pspell_link, $tmpWord)) // Adicionar Nathalie
207                                {                                       
208                                        $onClick = "onclick=\"setCurrentObject(" . $varName . "); showSuggestions('" . addslashes($tmpWord) . "', '" . $varName . "_" . $misspelledCount . "_" . addslashes($tmpWord) . "'); return false;\"";
209                                        $words[$i][$j] = str_replace($tmpWord, "<div " . $onClick . " id=\"" . $varName . "_" . $misspelledCount . "_" . $tmpWord . "\" class=\"highlight\">" . stripslashes($tmpWord) . " </div>", $words[$i][$j]);
210                                        $misspelledCount++;
211                                }
212                               
213                                $words[$i][$j] = str_replace("\n", "<br />", $words[$i][$j]); //replace any breaks with <br />'s, for html display
214                               
215                        }//end for $j
216                }//end if
217               
218                else //otherwise, we wrap all the html tags in comments to make them not displayed
219                {
220                        $words[$i] = str_replace("<", "<!--<", $words[$i]);
221                        $words[$i] = str_replace(">", ">-->", $words[$i]);
222                }
223        }//end for $i
224
225        $words = flattenArray($words); //flatten the array to be one dimensional.
226        $numResults = count($words); //the number of elements in the array after it's been flattened.
227       
228        $string = ""; //return string 
229   
230        //if there were no misspellings, start the string with a 0.
231        if($misspelledCount == 0)
232        {
233                $string = "0";
234        }
235       
236        else //else, there were misspellings, start the string with a 1.
237        {
238                $string = "1";
239        }
240       
241        // Concatenate all the words/tags/etc. back into a string and append it to the result.
242        $string .= implode('', $words);
243
244        $string = preg_replace("/<!--</i", "<", $string);  //Retira os comentários das tags HTML
245        $string = preg_replace("/>-->/i", ">", $string);
246       
247        ////Function Removed from the original. Accept alll HTML tags.
248        //remove comments from around all html tags except for <a> because we don't want the links to be clickable
249        //but we want the html to be rendered in the div for preview purposes.
250        /*$string = preg_replace("/<!--<br( [^>]*)?>-->/i", "<br />", $string);
251        $string = preg_replace("/<!--<p( [^>]*)?>-->/i", "<p>", $string);
252        $string = preg_replace("/<!--<\/p>-->/i", "</p>", $string);
253        $string = preg_replace("/<!--<b( [^>]*)?>-->/i", "<b>", $string);
254        $string = preg_replace("/<!--<\/b>-->/i", "</b>", $string);
255        $string = preg_replace("/<!--<strong( [^>]*)?>-->/i", "<strong>", $string);
256        $string = preg_replace("/<!--<\/strong>-->/i", "</strong>", $string);
257        $string = preg_replace("/<!--<i( [^>]*)?>-->/i", "<i>", $string);
258        $string = preg_replace("/<!--<\/i>-->/i", "</i>", $string);
259        $string = preg_replace("/<!--<small( [^>]*)?>-->/i", "<small>", $string);
260        $string = preg_replace("/<!--<\/small>-->/i", "</small>", $string);
261        $string = preg_replace("/<!--<ul( [^>]*)?>-->/i", "<ul>", $string);
262        $string = preg_replace("/<!--<\/ul>-->/i", "</ul>", $string);
263        $string = preg_replace("/<!--<li( [^>]*)?>-->/i", "<li>", $string);
264        $string = preg_replace("/<!--<\/li>-->/i", "</li>", $string);
265        $string = preg_replace("/<!--<img (?:[^>]+ )?src=\"?([^\"]*)\"?[^>]*>-->/i", "<img src=\"\\1\" />", $string);
266<<<<<<< .mine
267
268        $string = preg_replace("/<!--<table( [^>]*)?>-->/i", "<table border=\"\\\" >", $string);
269        $string = preg_replace("/<!--<\/table>-->/i", "</table>", $string);
270        $string = preg_replace("/<!--<td( [^>]*)?>-->/i", "<td>", $string);
271        $string = preg_replace("/<!--<\/td>-->/i", "</td>", $string);
272        $string = preg_replace("/<!--<tbody( [^>]*)?>-->/i", "<tbody>", $string);
273        $string = preg_replace("/<!--<\/tbody>-->/i", "</tbody>", $string);
274        $string = preg_replace("/<!--<tr( [^>]*)?>-->/i", "<tr>", $string);
275        $string = preg_replace("/<!--<\/tr>-->/i", "</tr>", $string);*/
276               
277        $cp->set_data(utf8_encode($string));  //return value - string containing all the markup for the misspelled words.
278
279} // end spellCheck
280
281
282/*************************************************************
283 * addWord($str)
284 *
285 * This function adds a word to the custom dictionary
286 *
287 * @param $str The word to be added
288 *************************************************************/
289function addWord($str)
290{
291        global $editablePersonalDict;
292        //global $pspell_link; //the global link to the pspell module
293        $pspell_link = pspell_new("pt_BR");
294        global $cp; //the CPAINT object
295        $retVal = "";
296        pspell_add_to_personal($pspell_link, $str);
297        if($editablePersonalDict && pspell_save_wordlist($pspell_link))
298        {
299                $retVal = "Save successful!";
300        }
301       
302        else
303        {
304                $retVal = "Save Failed!";
305        }
306       
307        $cp->set_data($retVal);
308} // end addWord
309
310
311
312/*************************************************************
313 * flattenArray($array)
314 *
315 * The flattenArray function is a recursive function that takes a
316 * multidimensional array and flattens it to be a one-dimensional
317 * array.  The one-dimensional flattened array is returned.
318 *
319 * $array - The array to be flattened.
320 *
321 *************************************************************/
322function flattenArray($array)
323{
324        $flatArray = array();
325        foreach($array as $subElement)
326        {
327        if(is_array($subElement))
328                {
329                        $flatArray = array_merge($flatArray, flattenArray($subElement));
330                }
331                else
332                {
333                        $flatArray[] = $subElement;
334                }
335        }
336       
337        return $flatArray;
338} // end flattenArray
339
340
341/*************************************************************
342 * stripslashes_custom($string)
343 *
344 * This is a custom stripslashes function that only strips
345 * the slashes if magic quotes are on.  This is written for
346 * compatibility with other servers in the event someone doesn't
347 * have magic quotes on.
348 *
349 * $string - The string that might need the slashes stripped.
350 *
351 *************************************************************/
352function stripslashes_custom($string)
353{
354        if(get_magic_quotes_gpc())
355        {
356                return stripslashes($string);
357        }
358        else
359        {
360                return $string;
361        }
362} // end stripslashes_custom
363
364/*************************************************************
365 * addslashes_custom($string)
366 *
367 * This is a custom addslashes function that only adds
368 * the slashes if magic quotes are off.  This is written for
369 * compatibility with other servers in the event someone doesn't
370 * have magic quotes on.
371 *
372 * $string - The string that might need the slashes added.
373 *
374 *************************************************************/
375function addslashes_custom($string)
376{
377        if(!get_magic_quotes_gpc())
378        {
379                return addslashes($string);
380        }
381        else
382        {
383                return $string;
384        }
385} // end addslashes_custom
386
387
388/*************************************************************
389 * remove_word_junk($t)
390 *
391 * This function strips out all the crap that Word tries to
392 * add to it's text in the even someone pastes in code from
393 * Word.
394 *
395 * $t - The text to be cleaned
396 *
397 *************************************************************/
398function remove_word_junk($t)
399{
400        $a=array(
401        "\xe2\x80\x9c"=>'"',
402        "\xe2\x80\x9d"=>'"',
403        "\xe2\x80\x99"=>"'",
404        "\xe2\x80\xa6"=>"...",
405        "\xe2\x80\x98"=>"'",
406        "\xe2\x80\x94"=>"---",
407        "\xe2\x80\x93"=>"--",
408        "\x85"=>"...",
409        "\221"=>"'",
410        "\222"=>"'",
411        "\223"=>'"',
412        "\224"=>'"',
413        "\x97"=>"---",
414        "\x96"=>"--"
415        );
416
417        foreach($a as $k=>$v){
418                $oa[]=$k;
419                $ra[]=$v;
420        }
421       
422        $t=trim(str_replace($oa,$ra,$t));
423        return $t;
424
425} // end remove_word_junk
426
427
428/*************************************************************
429 * switchText($string)
430 *
431 * This function prepares the text to be sent back to the text
432 * box from the div.  The comments are removed and breaks are
433 * converted back into \n's.  All the html tags that the user
434 * might have entered that aren't on the approved list:
435 * <p><br><a><b><strong><i><small><ul><li> are stripped out.
436 * The user-entered returns have already been replaced with
437 * $u2026 so that they can be preserved.  I replace all the
438 * \n's that might have been added by the browser (Firefox does
439 * this in trying to pretty up the HTML) with " " so that
440 * everything will look the way it did when the user typed it
441 * in the box the first time.
442 *
443 * $string - The string of html from the div that will be sent
444 *           back to the text box.
445 *
446 *************************************************************/
447function switchText($string)
448{
449        global $allowed_html;
450        global $cp; //the CPAINT object
451        $string = remove_word_junk($string);
452        $string = preg_replace("/<!--/", "", $string);
453        $string = preg_replace("/-->/", "", $string);   
454        $string = preg_replace("/\r?\n/", " ", $string);
455        $string = stripslashes_custom($string); //we only need to strip slashes if magic quotes are on
456        //$string = strip_tags($string, $allowed_html); //Removed. Accept all HTML tags.
457        $string = preg_replace('{&lt;/?span.*?&gt;}i', '', $string);
458        $string = html_entity_decode($string);
459
460        $cp->set_data($string); //the return value
461     
462       
463} // end switchText
464
465?>
Note: See TracBrowser for help on using the repository browser.