5 * Squirrelspell module.
7 * Copyright (c) 1999-2002 The SquirrelMail development team
8 * Licensed under the GNU GPL. For full terms see the file COPYING.
10 * This module is the main workhorse of SquirrelSpell. It submits
11 * the message to the spell-checker, parses the output, and loads
12 * the interface window.
16 * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
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.
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.
30 function SpellLink($jscode, $title, $link) {
31 echo "<td><a href=\"javascript:$jscode\" "
32 . "title=\"$title\">$link</a>"
37 * Declaring globals for users with E_ALL set.
39 global $SQSPELL_APP, $attachment_dir, $SQSPELL_EREG, $color;
41 $sqspell_text = $_POST['sqspell_text'];
42 $sqspell_use_app = $_POST['sqspell_use_app'];
45 * Now we explode the lines for three reasons:
46 * 1) So we can ignore lines starting with ">" (reply's)
47 * 2) So we can stop processing when we get to "--" on a single line,
48 * which means that the signature is starting
49 * 3) So we can add an extra space at the beginning of each line. This way
50 * ispell/aspell don't treat these as command characters.
52 $sqspell_raw_lines = explode("\n", $sqspell_text);
53 for ($i=0; $i<sizeof($sqspell_raw_lines); $i++){
55 * See if the signature is starting, which will be a "--" on the
56 * single line (after trimming).
58 if (trim($sqspell_raw_lines[$i]) == '--'){
62 * See if this is quoted text. Don't check the quoted text, since
63 * it's no business of ours how badly our correspondents misspell
66 if(substr($sqspell_raw_lines[$i], 0, 1) != '>'){
67 $sqspell_new_lines[$i] = ' ' . $sqspell_raw_lines[$i];
69 $sqspell_new_lines[$i] = '';
73 * $sqspell_new_lines array now contains the lines to submit to the
76 $sqspell_new_text=implode("\n", $sqspell_new_lines);
79 * Define the command used to spellcheck the document.
81 $sqspell_command=$SQSPELL_APP[$sqspell_use_app];
83 * For the simplicity's sake we'll put all text into a file in
84 * attachment_dir directory, then cat it and pipe it to
85 * sqspell_command. There are other ways to do it, including popen(),
86 * but it's unidirectional and no fun at all.
88 * The name of the file is an md5 hash of the message itself plus
89 * microtime. This prevents symlink attacks. The loop is here to
90 * further enhance this feature, and make sure we don't overwrite
91 * someone else's data, although the possibility of this happening is
95 $floc = "$attachment_dir/" . md5($sqspell_new_text . microtime());
96 } while (file_exists($floc));
98 * Write the contents to the file.
100 $fp=fopen($floc, 'w');
101 fwrite($fp, $sqspell_new_text);
104 * Execute ispell/aspell and catch the output.
106 exec("cat $floc | $sqspell_command 2>&1", $sqspell_output, $sqspell_exitcode);
108 * Remove the temp file.
113 * Check if the execution was successful. Bail out if it wasn't.
115 if ($sqspell_exitcode){
116 $msg= "<div align='center'>"
117 . sprintf(_("I tried to execute '%s', but it returned:"),
118 $sqspell_command) . "<pre>"
119 . nl2br(join("\n", $sqspell_output)) . "</pre>"
120 . "<form onsubmit=\"return false\">"
121 . "<input type=\"submit\" value=\" " . _("Close")
122 . " \" onclick=\"self.close()\"></form></div>";
123 sqspell_makeWindow(null, _("SquirrelSpell is misconfigured."), null, $msg);
128 * Load the user dictionary.
130 $words=sqspell_getLang(sqspell_getWords(), $sqspell_use_app);
132 * Define some variables to be used during the processing.
135 $missed_words=Array();
137 $locations = Array();
140 * Now we process the output of sqspell_command (ispell or aspell in
141 * ispell compatibility mode, whichever). I'm going to be scarce on
142 * comments here, since you can just look at the ispell/aspell output
143 * and figure out what's going on. ;) The best way to describe this is
146 for ($i=0; $i<sizeof($sqspell_output); $i++){
147 switch (substr($sqspell_output[$i], 0, 1)){
150 * Ispell adds empty lines when an end of line is reached
156 * Line begins with "&".
157 * This means there's a misspelled word and a few suggestions.
160 list($left, $right) = explode(": ", $sqspell_output[$i]);
161 $tmparray = explode(" ", $left);
162 $sqspell_word=$tmparray[1];
164 * Check if the word is in user dictionary.
166 if (!$SQSPELL_EREG("\n$sqspell_word\n", $words)){
167 $sqspell_symb=intval($tmparray[3])-1;
168 if (!isset($misses[$sqspell_word])) {
169 $misses[$sqspell_word] = $right;
170 $missed_words[$errors] = $sqspell_word;
173 if (isset($locations[$sqspell_word])){
174 $locations[$sqspell_word] .= ', ';
176 $locations[$sqspell_word] = '';
178 $locations[$sqspell_word] .= "$current_line:$sqspell_symb";
182 * Line begins with "#".
183 * This means a misspelled word and no suggestions.
186 $tmparray = explode(" ", $sqspell_output[$i]);
187 $sqspell_word=$tmparray[1];
190 * Check if the word is in user dictionary.
192 if (!$SQSPELL_EREG("\n$sqspell_word\n", $words)){
193 $sqspell_symb=intval($tmparray[2])-1;
194 if (!isset($misses[$sqspell_word])) {
195 $misses[$sqspell_word] = '_NONE';
196 $missed_words[$errors] = $sqspell_word;
199 if (isset($locations[$sqspell_word])) {
200 $locations[$sqspell_word] .= ', ';
202 $locations[$sqspell_word] = '';
204 $locations[$sqspell_word] .= "$current_line:$sqspell_symb";
212 * So, there are errors
213 * This is the only place where the generic GUI-wrapper is not
214 * called, but generated right here. This is due to the complexity
219 . '<title>' . _("SquirrelSpell Results") . '</title>';
221 * Check if there are user-defined stylesheets.
223 if ($theme_css != '') {
224 echo "<LINK REL=\"stylesheet\" TYPE=\"text/css\" HREF=\"$theme_css\">\n";
227 * Load the spelling errors into JavaScript arrays
230 echo "<script type=\"text/javascript\">\n"
233 $sqspell_lines = explode("\n", $sqspell_text);
235 * The javascript array sqspell_lines[] contains all lines of
236 * the message we've been checking.
238 echo "var sqspell_lines=new Array();\n";
239 for ($i=0; $i<sizeof($sqspell_lines); $i++){
240 echo "sqspell_lines[$i] = \""
241 . chop(addslashes($sqspell_lines[$i])) . "\";\n";
246 * The javascript array misses[] contais all misspelled words.
248 echo "var misses=new Array();\n";
249 for ($i=0; $i<sizeof($missed_words); $i++){
250 echo "misses[$i] = \"" . $missed_words[$i] . "\";\n";
255 * Suggestions are (guess what!) suggestions for misspellings
257 echo "var suggestions = new Array();\n";
259 while (list($word, $value) = each($misses)){
260 if ($value=='_NONE') $value='';
261 echo "suggestions[$i] = \"$value\";\n";
267 * Locations are where those misspellings are located, line:symbol
269 echo "var locations= new Array();\n";
271 while (list($word, $value) = each($locations)){
272 echo "locations[$i] = \"$value\";\n";
277 * Add some strings so they can be i18n'd.
279 echo "var ui_completed = \"" . _("Spellcheck completed. Commit changes?")
281 echo "var ui_nochange = \"" . _("No changes were made.") . "\";\n";
282 echo "var ui_wait = \""
283 . _("Now saving your personal dictionary... Please wait.")
288 * Did I mention that I hate dots on the end of contcatenated lines?
289 * Dots at the beginning make so much more sense!
293 . "<script src=\"js/check_me.js\" type=\"text/javascript\"></script>\n"
296 echo "<body bgcolor=\"$color[4]\" text=\"$color[8]\" link=\"$color[7]\" "
297 . "alink=\"$color[7]\" vlink=\"$color[7]\" "
298 . "onload=\"populateSqspellForm()\">\n";
300 <table width="100%" border="0" cellpadding="2">
302 <td bgcolor="<?php echo $color[9] ?>" align="center">
304 <?php printf( _("Found %s errors"), $errors ) ?>
316 <input type="hidden" name="MOD" value="forget_me_not" />
317 <input type="hidden" name="words" value="" />
318 <input type="hidden" name="sqspell_use_app"
319 value="<?php echo $sqspell_use_app ?>" />
320 <table border="0" width="100%">
324 $sptag = "<span style=\"background-color: $color[9]\">";
325 echo $sptag . _("Line with an error:") . '</span>';
328 <textarea name="sqspell_line_area" cols="50" rows="3"
329 wrap="hard" onfocus="this.blur()"></textarea>
333 <td align="right" width="25%">
335 echo $sptag . _("Error:") . '</span>';
338 <td align="left" width="25%">
339 <input name="sqspell_error" size="10" value=""
340 onfocus="this.blur()" />
342 <td align="right" width="25%">
344 echo $sptag . _("Suggestions:") . '</span>';
347 <td align="left" width="25%">
348 <select name="sqspell_suggestion"
349 onchange="if (this.options[this.selectedIndex].value != '_NONE') document.forms[0].sqspell_oruse.value=this.options[this.selectedIndex].value">
351 echo '<option>' . _("Suggestions") . '</option>';
359 echo $sptag . _("Change to:") . '</span>';
363 <input name="sqspell_oruse" size="15" value=""
364 onfocus="if(!this.value) this.value=document.forms[0].sqspell_error.value">
368 echo $sptag . _("Occurs times:") . '</span>';
372 <input name="sqspell_likethis" size=3 value="" onfocus="this.blur()">
375 <!-- hello? What is this? </td></tr> -->
377 <td colspan="4"><hr></td>
381 <table border="0" cellpadding="0" cellspacing="3" width="100%">
382 <tr align="center" bgcolor="<?php echo $color[9] ?>">
384 SpellLink('sqspellChange()',
385 _("Change this word"),
387 SpellLink('sqspellChangeAll()',
388 _("Change ALL occurances of this word"),
390 SpellLink('sqspellIgnore()',
391 _("Ignore this word"),
393 SpellLink('sqspellIgnoreAll()',
394 _("Ignore ALL occurances this word"),
396 SpellLink('sqspellRemember()',
397 _("Add this word to your personal dictionary"),
405 <td colspan="4"><hr></td>
408 <td colspan="4" align="center" bgcolor="<?php echo $color[9] ?>">
410 echo '<input type="button" value=" '
411 . _("Close and Commit")
412 . ' " onclick="if (confirm(\''
413 . _("The spellcheck is not finished. Really close and commit changes?")
414 . '\')) sqspellCommitChanges()">'
415 . ' <input type="button" value=" '
416 . _("Close and Cancel")
417 . ' " onclick="if (confirm(\''
418 . _("The spellcheck is not finished. Really close and discard changes?")
419 . '\')) self.close()">';
432 * AREN'T YOU SUCH A KNOW-IT-ALL!
434 $msg="<form onsubmit=\"return false\"><div align=\"center\">"
435 . "<input type=\"submit\" value=\" " . _("Close")
436 . " \" onclick=\"self.close()\"></div></form>";
437 sqspell_makeWindow(null, _("No errors found"), null, $msg);