plugins/squirrelspell/modules/check_me.mod

   1 <?php
   2 /**
   3  * check_me.mod
   4  * -------------
   5  * Squirrelspell module.
   6  *
   7  * Copyright (c) 1999-2002 The SquirrelMail development team
   8  * Licensed under the GNU GPL. For full terms see the file COPYING.
   9  *
  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.
  13  *
  14  * $Id$
  15  *
  16  * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
  17  * @version $Date$
  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, $attachment_dir, $SQSPELL_EREG, $color;
  40
  41 $sqspell_text = $_POST['sqspell_text'];
  42 $sqspell_use_app = $_POST['sqspell_use_app'];
  43
  44 /**
  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.
  51  */
  52 $sqspell_raw_lines = explode("\n", $sqspell_text);
  53 for ($i=0; $i<sizeof($sqspell_raw_lines); $i++){
  54   /**
  55    * See if the signature is starting, which will be a "--" on the
  56    * single line (after trimming).
  57    */
  58   if (trim($sqspell_raw_lines[$i]) == '--'){
  59     break;
  60   }
  61   /**
  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
  64    * stuff.
  65    */
  66   if(substr($sqspell_raw_lines[$i], 0, 1) != '>'){
  67     $sqspell_new_lines[$i] = ' ' . $sqspell_raw_lines[$i];
  68   } else {
  69     $sqspell_new_lines[$i] = '';
  70   }
  71 }
  72 /**
  73  * $sqspell_new_lines array now contains the lines to submit to the
  74  * spellchecker.
  75  */
  76 $sqspell_new_text=implode("\n", $sqspell_new_lines);
  77
  78 /**
  79  * Define the command used to spellcheck the document.
  80  */
  81 $sqspell_command=$SQSPELL_APP[$sqspell_use_app];
  82 /**
  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.
  87  *
  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
  92  * QUITE remote.
  93  */
  94 do {
  95   $floc = "$attachment_dir/" . md5($sqspell_new_text . microtime());
  96 } while (file_exists($floc));
  97 /**
  98  * Write the contents to the file.
  99  */
 100 $fp=fopen($floc, 'w');
 101 fwrite($fp, $sqspell_new_text);
 102 fclose($fp);
 103 /**
 104  * Execute ispell/aspell and catch the output.
 105  */
 106 exec("cat $floc | $sqspell_command 2>&1", $sqspell_output, $sqspell_exitcode);
 107 /**
 108  * Remove the temp file.
 109  */
 110 unlink($floc);
 111
 112 /**
 113  * Check if the execution was successful. Bail out if it wasn't.
 114  */
 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);
 124   exit;
 125 }
 126
 127 /**
 128  * Load the user dictionary.
 129  */
 130 $words=sqspell_getLang(sqspell_getWords(), $sqspell_use_app);
 131 /**
 132  * Define some variables to be used during the processing.
 133  */
 134 $current_line=0;
 135 $missed_words=Array();
 136 $misses = Array();
 137 $locations = Array();
 138 $errors=0;
 139 /**
 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
 144  * "Dark Magic".
 145  */
 146 for ($i=0; $i<sizeof($sqspell_output); $i++){
 147   switch (substr($sqspell_output[$i], 0, 1)){
 148   /**
 149    * Line is empty.
 150    * Ispell adds empty lines when an end of line is reached
 151    */
 152   case '':
 153     $current_line++;
 154   break;
 155   /**
 156    * Line begins with "&".
 157    * This means there's a misspelled word and a few suggestions.
 158    */
 159   case '&':
 160     list($left, $right) = explode(": ", $sqspell_output[$i]);
 161     $tmparray = explode(" ", $left);
 162     $sqspell_word=$tmparray[1];
 163     /**
 164      * Check if the word is in user dictionary.
 165      */
 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;
 171         $errors++;
 172       }
 173       if (isset($locations[$sqspell_word])){
 174         $locations[$sqspell_word] .= ', ';
 175       } else {
 176         $locations[$sqspell_word] = '';
 177       }
 178       $locations[$sqspell_word] .= "$current_line:$sqspell_symb";
 179     }
 180   break;
 181   /**
 182    * Line begins with "#".
 183    * This means a misspelled word and no suggestions.
 184    */
 185   case '#':
 186     $tmparray = explode(" ", $sqspell_output[$i]);
 187     $sqspell_word=$tmparray[1];
 188     /**
 189      *
 190      * Check if the word is in user dictionary.
 191      */
 192     if (!$SQSPELL_EREG("\n$sqspell_word\n", $words)){
 193       $sqspell_symb=intval($tmparray[2])-1;
 194       if (!$misses[$sqspell_word]) {
 195         $misses[$sqspell_word] = '_NONE';
 196         $missed_words[$errors] = $sqspell_word;
 197         $errors++;
 198       }
 199       if ($locations[$sqspell_word]) $locations[$sqspell_word] .= ', ';
 200       $locations[$sqspell_word] .= "$current_line:$sqspell_symb";
 201     }
 202   break;
 203   }
 204 }
 205
 206 if ($errors){
 207   /**
 208    * So, there are errors
 209    * This is the only place where the generic GUI-wrapper is not
 210    * called, but generated right here. This is due to the complexity
 211    * of the output.
 212    */
 213   echo "<html>\n"
 214     . "<head>\n"
 215     . '<title>' . _("SquirrelSpell Results") . '</title>';
 216   /**
 217    * Check if there are user-defined stylesheets.
 218    */
 219   if ($theme_css != '') {
 220     echo "<LINK REL=\"stylesheet\" TYPE=\"text/css\" HREF=\"$theme_css\">\n";
 221   }
 222   /**
 223    * Load the spelling errors into JavaScript arrays
 224    * (More dark magic!)
 225    */
 226   echo "<script type=\"text/javascript\">\n"
 227     . "<!--\n";
 228
 229   $sqspell_lines = explode("\n", $sqspell_text);
 230   /**
 231    * The javascript array sqspell_lines[] contains all lines of
 232    * the message we've been checking.
 233    */
 234   echo "var sqspell_lines=new Array();\n";
 235   for ($i=0; $i<sizeof($sqspell_lines); $i++){
 236     echo "sqspell_lines[$i] = \""
 237       . chop(addslashes($sqspell_lines[$i])) . "\";\n";
 238   }
 239   echo "\n\n";
 240
 241   /**
 242    * The javascript array misses[] contais all misspelled words.
 243    */
 244   echo "var misses=new Array();\n";
 245   for ($i=0; $i<sizeof($missed_words); $i++){
 246     echo "misses[$i] = \"" . $missed_words[$i] . "\";\n";
 247   }
 248   echo "\n\n";
 249
 250   /**
 251    * Suggestions are (guess what!) suggestions for misspellings
 252    */
 253   echo "var suggestions = new Array();\n";
 254   $i=0;
 255   while (list($word, $value) = each($misses)){
 256     if ($value=='_NONE') $value='';
 257     echo "suggestions[$i] = \"$value\";\n";
 258     $i++;
 259   }
 260   echo "\n\n";
 261
 262   /**
 263    * Locations are where those misspellings are located, line:symbol
 264    */
 265   echo "var locations= new Array();\n";
 266   $i=0;
 267   while (list($word, $value) = each($locations)){
 268     echo "locations[$i] = \"$value\";\n";
 269     $i++;
 270   }
 271
 272   /**
 273    * Add some strings so they can be i18n'd.
 274    */
 275   echo "var ui_completed = \"" . _("Spellcheck completed. Commit changes?")
 276     . "\";\n";
 277   echo "var ui_nochange = \"" . _("No changes were made.") . "\";\n";
 278   echo "var ui_wait = \""
 279     . _("Now saving your personal dictionary... Please wait.")
 280     . "\";\n";
 281
 282
 283   /**
 284    * Did I mention that I hate dots on the end of contcatenated lines?
 285    * Dots at the beginning make so much more sense!
 286    */
 287   echo "//-->\n"
 288     . "</script>\n"
 289     . "<script src=\"js/check_me.js\" type=\"text/javascript\"></script>\n"
 290     . "</head>\n";
 291
 292   echo "<body bgcolor=\"$color[4]\" text=\"$color[8]\" link=\"$color[7]\" "
 293     . "alink=\"$color[7]\" vlink=\"$color[7]\" "
 294     . "onload=\"populateSqspellForm()\">\n";
 295   ?>
 296   <table width="100%" border="0" cellpadding="2">
 297    <tr>
 298     <td bgcolor="<?php echo $color[9] ?>" align="center">
 299      <b>
 300       <?php printf( _("Found %s errors"), $errors ) ?>
 301      </b>
 302     </td>
 303    </tr>
 304    <tr>
 305     <td>
 306       <hr>
 307     </td>
 308    </tr>
 309    <tr>
 310     <td>
 311      <form method="post">
 312       <input type="hidden" name="MOD" value="forget_me_not" />
 313       <input type="hidden" name="words" value="" />
 314       <input type="hidden" name="sqspell_use_app"
 315              value="<?php echo $sqspell_use_app ?>" />
 316       <table border="0" width="100%">
 317        <tr align="center">
 318         <td colspan="4">
 319          <?php
 320           $sptag = "<span style=\"background-color: $color[9]\">";
 321           echo $sptag . _("Line with an error:") . '</span>';
 322          ?>
 323          <br />
 324          <textarea name="sqspell_line_area" cols="50" rows="3"
 325                    wrap="hard" onfocus="this.blur()"></textarea>
 326         </td>
 327        </tr>
 328        <tr valign="middle">
 329         <td align="right" width="25%">
 330          <?php
 331           echo $sptag . _("Error:") . '</span>';
 332          ?>
 333         </td>
 334         <td align="left" width="25%">
 335          <input name="sqspell_error" size="10" value=""
 336                 onfocus="this.blur()" />
 337         </td>
 338         <td align="right" width="25%">
 339          <?php
 340           echo $sptag . _("Suggestions:") . '</span>';
 341          ?>
 342         </td>
 343         <td align="left" width="25%">
 344          <select name="sqspell_suggestion"
 345                  onchange="if (this.options[this.selectedIndex].value != '_NONE') document.forms[0].sqspell_oruse.value=this.options[this.selectedIndex].value">
 346           <?php
 347            echo '<option>' . _("Suggestions") . '</option>';
 348           ?>
 349          </select>
 350         </td>
 351        </tr>
 352        <tr>
 353         <td align="right">
 354          <?php
 355           echo $sptag . _("Change to:") . '</span>';
 356          ?>
 357         </td>
 358         <td align="left">
 359          <input name="sqspell_oruse" size="15" value=""
 360                 onfocus="if(!this.value) this.value=document.forms[0].sqspell_error.value">
 361         </td>
 362         <td align="right">
 363          <?php
 364           echo $sptag . _("Occurs times:") . '</span>';
 365          ?>
 366         </td>
 367         <td align="left">
 368          <input name="sqspell_likethis" size=3 value="" onfocus="this.blur()">
 369         </td>
 370        </tr>
 371         <!-- hello? What is this? </td></tr> -->
 372        <tr>
 373         <td colspan="4"><hr></td>
 374        </tr>
 375        <tr>
 376         <td colspan="4">
 377          <table border="0" cellpadding="0" cellspacing="3" width="100%">
 378           <tr align="center" bgcolor="<?php echo $color[9] ?>">
 379            <?php
 380             SpellLink('sqspellChange()',
 381                       _("Change this word"),
 382                       _("Change"));
 383             SpellLink('sqspellChangeAll()',
 384                       _("Change ALL occurances of this word"),
 385                       _("Change All"));
 386             SpellLink('sqspellIgnore()',
 387                       _("Ignore this word"),
 388                       _("Ignore"));
 389             SpellLink('sqspellIgnoreAll()',
 390                       _("Ignore ALL occurances this word"),
 391                       _("Ignore All"));
 392             SpellLink('sqspellRemember()',
 393                       _("Add this word to your personal dictionary"),
 394                       _("Add to Dic"));
 395            ?>
 396           </tr>
 397          </table>
 398         </td>
 399        </tr>
 400        <tr>
 401         <td colspan="4"><hr></td>
 402        </tr>
 403        <tr>
 404         <td colspan="4" align="center" bgcolor="<?php echo $color[9] ?>">
 405          <?php
 406           echo '<input type="button" value="  '
 407             . _("Close and Commit")
 408             . '  " onclick="if (confirm(\''
 409             . _("The spellcheck is not finished. Really close and commit changes?")
 410             . '\')) sqspellCommitChanges()">'
 411             . ' <input type="button" value="  '
 412             . _("Close and Cancel")
 413             . '  " onclick="if (confirm(\''
 414             . _("The spellcheck is not finished. Really close and discard changes?")
 415             . '\')) self.close()">';
 416          ?>
 417         </td>
 418        </tr>
 419       </table>
 420      </form>
 421     </td>
 422    </tr>
 423   </table>
 424   </body></html>
 425   <?php
 426 } else {
 427   /**
 428    * AREN'T YOU SUCH A KNOW-IT-ALL!
 429    */
 430   $msg="<form onsubmit=\"return false\"><div align=\"center\">"
 431      . "<input type=\"submit\" value=\"  " . _("Close")
 432      . "  \" onclick=\"self.close()\"></div></form>";
 433   sqspell_makeWindow(null, _("No errors found"), null, $msg);
 434 }
 435
 436 /**
 437  * For Emacs weenies:
 438  * Local variables:
 439  * mode: php
 440  * End:
 441  */
 442 ?>