35f27f7e5bf9e129894a25ba153118d546952753
[squirrelmail.git] / plugins / squirrelspell / modules / check_me.mod
1 <?php
2
3 /**
4  * check_me.mod
5  *
6  * Squirrelspell module.
7  *
8  * This module is the main workhorse of SquirrelSpell. It submits
9  * the message to the spell-checker, parses the output, and loads
10  * the interface window.
11  *
12  * @author Konstantin Riabitsev <icon at duke.edu>
13  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
14  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
15  * @version $Id$
16  * @package plugins
17  * @subpackage squirrelspell
18  */
19
20 /**
21  * This function makes a javascript-powered link. Not sure why
22  * Philippe decided to move it outside the main code, but hey. ;)
23  * I bet for the i18n reasons.
24  *
25  * @param  $jscode Javascript code to include in the link.
26  * @param  $title  A little pop-up title to provide for the links.
27  * @param  $link   The content of the link.
28  * @return         void, since this just draws the content.
29  */
30 function SpellLink($jscode, $title, $link) {
31   echo "<td><a href=\"javascript:$jscode\" "
32     . "title=\"$title\">$link</a>"
33     . '</td>';
34 }
35
36 /**
37  * Declaring globals for users with E_ALL set.
38  */
39 global $SQSPELL_APP_DEFAULT, $SQSPELL_APP, $SQSPELL_SPELLCHECKER, 
40   $SQSPELL_FORCE_POPEN, $attachment_dir, $color;
41
42 if (! sqgetGlobalVar('sqspell_text',$sqspell_text,SQ_POST)) {
43   $sqspell_text = '';
44 }
45 if (! sqgetGlobalVar('sqspell_use_app',$sqspell_use_app,SQ_POST)) {
46   $sqspell_use_app = $SQSPELL_APP_DEFAULT;
47 }
48
49 /**
50  * Now we explode the lines for two reasons:
51  * 1) So we can ignore lines starting with ">" (reply's)
52  * 2) So we can stop processing when we get to "--" on a single line,
53  *    which means that the signature is starting
54  */
55 $sqspell_raw_lines = explode("\n", $sqspell_text);
56 for ($i=0; $i<sizeof($sqspell_raw_lines); $i++){
57   /**
58    * See if the signature is starting, which will be a "--" on the
59    * single line (after trimming).
60    */
61   if (trim($sqspell_raw_lines[$i]) == '--'){
62     break;
63   }
64   /**
65    * See if this is quoted text. Don't check the quoted text, since
66    * it's no business of ours how badly our correspondents misspell
67    * stuff.
68    */
69   if(substr($sqspell_raw_lines[$i], 0, 1) != '>'){
70     $sqspell_new_lines[$i] = $sqspell_raw_lines[$i];
71   } else {
72     $sqspell_new_lines[$i] = '';
73   }
74 }
75 /**
76  * $sqspell_new_lines array now contains the lines to submit to the
77  * spellchecker.
78  */
79 $sqspell_new_text=implode("\n", $sqspell_new_lines);
80
81 include_once(SM_PATH . 'plugins/squirrelspell/class/common.php');
82
83 $aParams = array();
84 $aParams['words'] = sqspell_getLang($sqspell_use_app);
85
86 if ($SQSPELL_SPELLCHECKER===1) {
87     include_once(SM_PATH . 'plugins/squirrelspell/class/php_pspell.php');
88     $aParams['dictionary'] = $SQSPELL_APP[$sqspell_use_app];
89     $aParams['charset'] = $default_charset;
90     $check = new php_pspell($aParams);
91 } else {
92     include_once(SM_PATH . 'plugins/squirrelspell/class/cmd_spell.php');
93     $aParams['spell_command'] = $SQSPELL_APP[$sqspell_use_app];
94     if ($SQSPELL_FORCE_POPEN) {
95         $aParams['use_proc_open'] = false;
96     } else {
97         $aParams['use_proc_open'] = check_php_version(4,3);
98     }
99     $aParams['temp_dir'] = $attachment_dir;
100     $aParams['debug'] = false;
101     $check = new cmd_spell($aParams);
102 }
103
104 /**
105  * Check for class constructor function errors
106  */
107 if (!empty($check->error)) {
108   $msg= '<div style="text-align: center;">'
109       . nl2br(htmlspecialchars($check->error))
110      . '<form onsubmit="return false">'
111      . '<input type="submit" value="  ' . _("Close")
112      . '  " onclick="self.close()" /></form></div>';
113   sqspell_makeWindow(null, _("SquirrelSpell is misconfigured."), null, $msg);
114   exit;
115 }
116
117 $missed_words=Array();
118 $misses = Array();
119 $locations = Array();
120 $errors=0;
121 $results = $check->check_text($sqspell_new_text);
122
123 /**
124  * Check for execution errors
125  */
126 if (!empty($check->error)) {
127   $msg= '<div style="text-align: center;">'
128       . nl2br(htmlspecialchars($check->error))
129      . '<form onsubmit="return false">'
130      . '<input type="submit" value="  ' . _("Close")
131      . '  " onclick="self.close()" /></form></div>';
132   sqspell_makeWindow(null, _("SquirrelSpell is misconfigured."), null, $msg);
133   exit;
134 }
135
136 if (is_array($results)) {
137     // convert variables to old style squirrelspell results
138     if (!empty($results)) {
139         foreach(array_keys($results) as $word) {
140             if (isset($results[$word]['locations'])) {
141                 $missed_words[] = $word;
142                 $locations[$word] = implode(', ',$results[$word]['locations']);
143                 if (isset($results[$word]['suggestions'])) {
144                     $misses[$word] = implode(', ',$results[$word]['suggestions']);
145                 } else {
146                     $misses[$word] = '_NONE';
147                 }
148             } else {
149                 // $word without 'locations'. ignore it
150             }
151         }
152         $errors = count($missed_words);
153     }
154 } else {
155     if (!empty($check->error)) {
156         $error_msg = nl2br(htmlspecialchars($check->error));
157     } else {
158         $error_msg = _("Unknown error");
159     }
160     $msg= '<div style="text-align: center;">'
161         . $error_msg
162      . '<form onsubmit="return false">'
163      . '<input type="submit" value="  ' . _("Close")
164      . '  " onclick="self.close()" /></form></div>';
165     sqspell_makeWindow(null, _("SquirrelSpell error."), null, $msg);
166     exit;
167 }
168
169 if ($errors){
170   /**
171    * Load the spelling errors into JavaScript arrays
172    * (More dark magic!)
173    */
174   $extrajs="<script type=\"text/javascript\">\n"
175     . "<!--\n";
176
177   $sqspell_lines = explode("\n", $sqspell_text);
178   /**
179    * The javascript array sqspell_lines[] contains all lines of
180    * the message we've been checking.
181    */
182   $extrajs.= "var sqspell_lines=new Array();\n";
183   for ($i=0; $i<sizeof($sqspell_lines); $i++){
184     $extrajs.= "sqspell_lines[$i] = \""
185       . chop(addslashes($sqspell_lines[$i])) . "\";\n";
186   }
187   $extrajs.= "\n\n";
188
189   /**
190    * The javascript array misses[] contais all misspelled words.
191    */
192   $extrajs.= "var misses=new Array();\n";
193   for ($i=0; $i<sizeof($missed_words); $i++){
194     $extrajs.= "misses[$i] = \"" . $missed_words[$i] . "\";\n";
195   }
196   $extrajs.= "\n\n";
197
198   /**
199    * Suggestions are (guess what!) suggestions for misspellings
200    */
201   $extrajs.= "var suggestions = new Array();\n";
202   $i=0;
203   while (list($word, $value) = each($misses)){
204     if ($value=='_NONE') $value='';
205     $extrajs.= "suggestions[$i] = \"$value\";\n";
206     $i++;
207   }
208   $extrajs.= "\n\n";
209
210   /**
211    * Locations are where those misspellings are located, line:symbol
212    */
213   $extrajs.= "var locations= new Array();\n";
214   $i=0;
215   while (list($word, $value) = each($locations)){
216     $extrajs.= "locations[$i] = \"$value\";\n";
217     $i++;
218   }
219
220   /**
221    * Add some strings so they can be i18n'd.
222    */
223   $extrajs.= "var ui_completed = \"" . _("Spellcheck completed. Commit changes?")
224     . "\";\n";
225   $extrajs.= "var ui_nochange = \"" . _("No changes were made.") . "\";\n";
226   $extrajs.= "var ui_wait = \""
227     . _("Now saving your personal dictionary... Please wait.")
228     . "\";\n";
229
230
231   /**
232    * Did I mention that I hate dots on the end of contcatenated lines?
233    * Dots at the beginning make so much more sense!
234    */
235   $extrajs.= "//-->\n"
236     . "</script>\n"
237     . "<script src=\"js/check_me.js\" type=\"text/javascript\"></script>\n";
238
239
240   displayHtmlHeader(_("SquirrelSpell Results"),$extrajs);
241
242   echo "<body bgcolor=\"$color[4]\" text=\"$color[8]\" link=\"$color[7]\" "
243     . "alink=\"$color[7]\" vlink=\"$color[7]\" "
244     . "onload=\"populateSqspellForm()\">\n";
245   ?>
246   <table width="100%" border="0" cellpadding="2">
247    <tr>
248     <td bgcolor="<?php echo $color[9] ?>" align="center">
249      <b>
250       <?php printf( ngettext("Found %d error","Found %d errors",$errors), $errors ) ?>
251      </b>
252     </td>
253    </tr>
254    <tr>
255     <td>
256       <hr />
257     </td>
258    </tr>
259    <tr>
260     <td>
261      <form method="post">
262       <input type="hidden" name="MOD" value="forget_me_not" />
263       <input type="hidden" name="words" value="" />
264       <input type="hidden" name="sqspell_use_app"
265              value="<?php echo $sqspell_use_app ?>" />
266       <table border="0" width="100%">
267        <tr align="center">
268         <td colspan="4">
269          <?php
270           $sptag = "<span style=\"background-color: $color[9]\">";
271           echo $sptag . _("Line with an error:") . '</span>';
272          ?>
273          <br />
274          <textarea name="sqspell_line_area" cols="50" rows="3"
275                    onfocus="this.blur()"></textarea>
276         </td>
277        </tr>
278        <tr valign="middle">
279         <td align="right" width="25%">
280          <?php
281           echo $sptag . _("Error:") . '</span>';
282          ?>
283         </td>
284         <td align="left" width="25%">
285          <input name="sqspell_error" size="10" value=""
286                 onfocus="this.blur()" />
287         </td>
288         <td align="right" width="25%">
289          <?php
290           echo $sptag . _("Suggestions:") . '</span>';
291          ?>
292         </td>
293         <td align="left" width="25%">
294          <select name="sqspell_suggestion"
295                  onchange="if (this.options[this.selectedIndex].value != '_NONE') document.forms[0].sqspell_oruse.value=this.options[this.selectedIndex].value">
296           <?php
297            echo '<option>' . _("Suggestions") . '</option>';
298           ?>
299          </select>
300         </td>
301        </tr>
302        <tr>
303         <td align="right">
304          <?php
305           echo $sptag . _("Change to:") . '</span>';
306          ?>
307         </td>
308         <td align="left">
309          <input name="sqspell_oruse" size="15" value=""
310                 onfocus="if(!this.value) this.value=document.forms[0].sqspell_error.value" />
311         </td>
312         <td align="right">
313          <?php
314           echo $sptag . _("Occurs times:") . '</span>';
315          ?>
316         </td>
317         <td align="left">
318          <input name="sqspell_likethis" size=3 value="" onfocus="this.blur()" />
319         </td>
320        </tr>
321         <!-- hello? What is this? </td></tr> -->
322        <tr>
323         <td colspan="4"><hr /></td>
324        </tr>
325        <tr>
326         <td colspan="4">
327          <table border="0" cellpadding="0" cellspacing="3" width="100%">
328           <tr align="center" bgcolor="<?php echo $color[9] ?>">
329            <?php
330            SpellLink('sqspellChange()',
331                    _("Change this word"),
332                    _("Change"));
333          SpellLink('sqspellChangeAll()',
334                  _("Change ALL occurances of this word"),
335                  _("Change All"));
336          SpellLink('sqspellIgnore()',
337                  _("Ignore this word"),
338                  _("Ignore"));
339          SpellLink('sqspellIgnoreAll()',
340                  _("Ignore ALL occurances this word"),
341                  _("Ignore All"));
342          SpellLink('sqspellRemember()',
343                  _("Add this word to your personal dictionary"),
344                  _("Add to Dic"));
345            ?>
346           </tr>
347          </table>
348         </td>
349        </tr>
350        <tr>
351         <td colspan="4"><hr /></td>
352        </tr>
353        <tr>
354         <td colspan="4" align="center" bgcolor="<?php echo $color[9] ?>">
355          <?php
356              echo '<input type="button" value="  '
357                  . _("Close and Commit")
358                  . '  " onclick="if (confirm(\''
359                  . _("The spellcheck is not finished. Really close and commit changes?")
360                  . '\')) sqspellCommitChanges()" />'
361                  . ' <input type="button" value="  '
362                  . _("Close and Cancel")
363                  . '  " onclick="if (confirm(\''
364                  . _("The spellcheck is not finished. Really close and discard changes?")
365                  . '\')) self.close()" />';
366          ?>
367         </td>
368        </tr>
369       </table>
370      </form>
371     </td>
372    </tr>
373   </table>
374   </body></html>
375   <?php
376 } else {
377   /**
378    * AREN'T YOU SUCH A KNOW-IT-ALL!
379    */
380   $msg='<form onsubmit="return false"><div style="text-align: center;">' .
381        '<input type="submit" value="  ' . _("Close") .
382        '  " onclick="self.close()" /></div></form>';
383   sqspell_makeWindow(null, _("No errors found"), null, $msg);
384 }
385
386 /**
387  * For Emacs weenies:
388  * Local variables:
389  * mode: php
390  * End:
391  * vim: syntax=php et ts=4
392  */