<?php
+
/**
* check_me.mod
- * -------------
- * Squirrelspell module.
*
- * Copyright (c) 1999-2002 The SquirrelMail development team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * Squirrelspell module.
*
* This module is the main workhorse of SquirrelSpell. It submits
* the message to the spell-checker, parses the output, and loads
* the interface window.
*
- * $Id$
- *
- * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
- * @version $Date$
+ * @author Konstantin Riabitsev <icon at duke.edu>
+ * @copyright 1999-2020 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package plugins
+ * @subpackage squirrelspell
*/
/**
/**
* Declaring globals for users with E_ALL set.
*/
-global $sqspell_text, $SQSPELL_APP, $sqspell_use_app, $attachment_dir,
- $username, $SQSPELL_EREG, $color;
+global $SQSPELL_APP_DEFAULT, $SQSPELL_APP, $SQSPELL_SPELLCHECKER,
+ $SQSPELL_FORCE_POPEN, $attachment_dir, $color;
+
+if (! sqgetGlobalVar('sqspell_text',$sqspell_text,SQ_POST)) {
+ $sqspell_text = '';
+}
+if (! sqgetGlobalVar('sqspell_use_app',$sqspell_use_app,SQ_POST)) {
+ $sqspell_use_app = $SQSPELL_APP_DEFAULT;
+}
/**
- * Now we explode the lines for three reasons:
+ * Now we explode the lines for two reasons:
* 1) So we can ignore lines starting with ">" (reply's)
* 2) So we can stop processing when we get to "--" on a single line,
* which means that the signature is starting
- * 3) So we can add an extra space at the beginning of each line. This way
- * ispell/aspell don't treat these as command characters.
*/
$sqspell_raw_lines = explode("\n", $sqspell_text);
for ($i=0; $i<sizeof($sqspell_raw_lines); $i++){
* stuff.
*/
if(substr($sqspell_raw_lines[$i], 0, 1) != '>'){
- $sqspell_new_lines[$i] = ' ' . $sqspell_raw_lines[$i];
+ $sqspell_new_lines[$i] = $sqspell_raw_lines[$i];
} else {
$sqspell_new_lines[$i] = '';
}
*/
$sqspell_new_text=implode("\n", $sqspell_new_lines);
-/**
- * Define the command used to spellcheck the document.
- */
-$sqspell_command=$SQSPELL_APP[$sqspell_use_app];
-/**
- * For the simplicity's sake we'll put all text into a file in
- * attachment_dir directory, then cat it and pipe it to
- * sqspell_command. There are other ways to do it, including popen(),
- * but it's unidirectional and no fun at all.
- *
- * The name of the file is an md5 hash of the message itself plus
- * microtime. This prevents symlink attacks. The loop is here to
- * further enhance this feature, and make sure we don't overwrite
- * someone else's data, although the possibility of this happening is
- * QUITE remote.
- */
-do {
- $floc = "$attachment_dir/" . md5($sqspell_new_text . microtime());
-} while (file_exists($floc));
-/**
- * Write the contents to the file.
- */
-$fp=fopen($floc, 'w');
-fwrite($fp, $sqspell_new_text);
-fclose($fp);
-/**
- * Execute ispell/aspell and catch the output.
- */
-exec("cat $floc | $sqspell_command 2>&1", $sqspell_output, $sqspell_exitcode);
-/**
- * Remove the temp file.
- */
-unlink($floc);
+include_once(SM_PATH . 'plugins/squirrelspell/class/common.php');
+
+$aParams = array();
+$aParams['words'] = sqspell_getLang($sqspell_use_app);
+
+if ($SQSPELL_SPELLCHECKER===1) {
+ include_once(SM_PATH . 'plugins/squirrelspell/class/php_pspell.php');
+ $aParams['dictionary'] = $SQSPELL_APP[$sqspell_use_app];
+ $aParams['charset'] = $default_charset;
+ $check = new php_pspell($aParams);
+} else {
+ include_once(SM_PATH . 'plugins/squirrelspell/class/cmd_spell.php');
+ $aParams['spell_command'] = $SQSPELL_APP[$sqspell_use_app];
+ if ($SQSPELL_FORCE_POPEN) {
+ $aParams['use_proc_open'] = false;
+ } else {
+ $aParams['use_proc_open'] = check_php_version(4,3);
+ }
+ $aParams['temp_dir'] = $attachment_dir;
+ $aParams['debug'] = false;
+ $check = new cmd_spell($aParams);
+}
/**
- * Check if the execution was successful. Bail out if it wasn't.
+ * Check for class constructor function errors
*/
-if ($sqspell_exitcode){
- $msg= "<div align='center'>"
- . sprintf(_("I tried to execute '%s', but it returned:"),
- $sqspell_command) . "<pre>"
- . nl2br(join("\n", $sqspell_output)) . "</pre>"
- . "<form onsubmit=\"return false\">"
- . "<input type=\"submit\" value=\" " . _("Close")
- . " \" onclick=\"self.close()\"></form></div>";
+if (!empty($check->error)) {
+ $msg= '<div style="text-align: center;">'
+ . nl2br(sm_encode_html_special_chars($check->error))
+ . '<form onsubmit="return false">'
+ . '<input type="submit" value=" ' . _("Close")
+ . ' " onclick="self.close()" /></form></div>';
sqspell_makeWindow(null, _("SquirrelSpell is misconfigured."), null, $msg);
exit;
}
-/**
- * Load the user dictionary.
- */
-$words=sqspell_getLang(sqspell_getWords(), $sqspell_use_app);
-/**
- * Define some variables to be used during the processing.
- */
-$current_line=0;
$missed_words=Array();
$misses = Array();
$locations = Array();
$errors=0;
+$results = $check->check_text($sqspell_new_text);
+
/**
- * Now we process the output of sqspell_command (ispell or aspell in
- * ispell compatibility mode, whichever). I'm going to be scarce on
- * comments here, since you can just look at the ispell/aspell output
- * and figure out what's going on. ;) The best way to describe this is
- * "Dark Magic".
+ * Check for execution errors
*/
-for ($i=0; $i<sizeof($sqspell_output); $i++){
- switch (substr($sqspell_output[$i], 0, 1)){
- /**
- * Line is empty.
- * Ispell adds empty lines when an end of line is reached
- */
- case '':
- $current_line++;
- break;
- /**
- * Line begins with "&".
- * This means there's a misspelled word and a few suggestions.
- */
- case '&':
- list($left, $right) = explode(": ", $sqspell_output[$i]);
- $tmparray = explode(" ", $left);
- $sqspell_word=$tmparray[1];
- /**
- * Check if the word is in user dictionary.
- */
- if (!$SQSPELL_EREG("\n$sqspell_word\n", $words)){
- $sqspell_symb=intval($tmparray[3])-1;
- if (!$misses[$sqspell_word]) {
- $misses[$sqspell_word] = $right;
- $missed_words[$errors] = $sqspell_word;
- $errors++;
- }
- if ($locations[$sqspell_word]){
- $locations[$sqspell_word] .= ', ';
- }
- $locations[$sqspell_word] .= "$current_line:$sqspell_symb";
+if (!empty($check->error)) {
+ $msg= '<div style="text-align: center;">'
+ . nl2br(sm_encode_html_special_chars($check->error))
+ . '<form onsubmit="return false">'
+ . '<input type="submit" value=" ' . _("Close")
+ . ' " onclick="self.close()" /></form></div>';
+ sqspell_makeWindow(null, _("SquirrelSpell is misconfigured."), null, $msg);
+ exit;
+}
+
+if (is_array($results)) {
+ // convert variables to old style squirrelspell results
+ if (!empty($results)) {
+ foreach(array_keys($results) as $word) {
+ if (isset($results[$word]['locations'])) {
+ $missed_words[] = $word;
+ $locations[$word] = implode(', ',$results[$word]['locations']);
+ if (isset($results[$word]['suggestions'])) {
+ $misses[$word] = implode(', ',$results[$word]['suggestions']);
+ } else {
+ $misses[$word] = '_NONE';
+ }
+ } else {
+ // $word without 'locations'. ignore it
+ }
+ }
+ $errors = count($missed_words);
}
- break;
- /**
- * Line begins with "#".
- * This means a misspelled word and no suggestions.
- */
- case '#':
- $tmparray = explode(" ", $sqspell_output[$i]);
- $sqspell_word=$tmparray[1];
- /**
- *
- * Check if the word is in user dictionary.
- */
- if (!$SQSPELL_EREG("\n$sqspell_word\n", $words)){
- $sqspell_symb=intval($tmparray[2])-1;
- if (!$misses[$sqspell_word]) {
- $misses[$sqspell_word] = '_NONE';
- $missed_words[$errors] = $sqspell_word;
- $errors++;
- }
- if ($locations[$sqspell_word]) $locations[$sqspell_word] .= ', ';
- $locations[$sqspell_word] .= "$current_line:$sqspell_symb";
+} else {
+ if (!empty($check->error)) {
+ $error_msg = nl2br(sm_encode_html_special_chars($check->error));
+ } else {
+ $error_msg = _("Unknown error");
}
- break;
- }
+ $msg= '<div style="text-align: center;">'
+ . $error_msg
+ . '<form onsubmit="return false">'
+ . '<input type="submit" value=" ' . _("Close")
+ . ' " onclick="self.close()" /></form></div>';
+ sqspell_makeWindow(null, _("SquirrelSpell error."), null, $msg);
+ exit;
}
if ($errors){
- /**
- * So, there are errors
- * This is the only place where the generic GUI-wrapper is not
- * called, but generated right here. This is due to the complexity
- * of the output.
- */
- echo "<html>\n"
- . "<head>\n"
- . '<title>' . _("SquirrelSpell Results") . '</title>';
- /**
- * Check if there are user-defined stylesheets.
- */
- if ($theme_css != '') {
- echo "<LINK REL=\"stylesheet\" TYPE=\"text/css\" HREF=\"$theme_css\">\n";
- }
/**
* Load the spelling errors into JavaScript arrays
* (More dark magic!)
*/
- echo "<script type=\"text/javascript\">\n"
+ $extrajs="<script type=\"text/javascript\">\n"
. "<!--\n";
-
+
$sqspell_lines = explode("\n", $sqspell_text);
/**
* The javascript array sqspell_lines[] contains all lines of
* the message we've been checking.
*/
- echo "var sqspell_lines=new Array();\n";
+ $extrajs.= "var sqspell_lines=new Array();\n";
for ($i=0; $i<sizeof($sqspell_lines); $i++){
- echo "sqspell_lines[$i] = \""
- . chop(addslashes($sqspell_lines[$i])) . "\";\n";
- }
- echo "\n\n";
+ // use addcslashes for compatibility with magic_quotes_sybase
+ $extrajs.= "sqspell_lines[$i] = \""
+ . chop(addcslashes($sqspell_lines[$i], ">'\"\\\x0")) . "\";\n";
+ }
+ $extrajs.= "\n\n";
/**
* The javascript array misses[] contais all misspelled words.
*/
- echo "var misses=new Array();\n";
+ $extrajs.= "var misses=new Array();\n";
for ($i=0; $i<sizeof($missed_words); $i++){
- echo "misses[$i] = \"" . $missed_words[$i] . "\";\n";
+ $extrajs.= "misses[$i] = \"" . $missed_words[$i] . "\";\n";
}
- echo "\n\n";
-
+ $extrajs.= "\n\n";
+
/**
* Suggestions are (guess what!) suggestions for misspellings
*/
- echo "var suggestions = new Array();\n";
+ $extrajs.= "var suggestions = new Array();\n";
$i=0;
while (list($word, $value) = each($misses)){
if ($value=='_NONE') $value='';
- echo "suggestions[$i] = \"$value\";\n";
+ $extrajs.= "suggestions[$i] = \"$value\";\n";
$i++;
}
- echo "\n\n";
+ $extrajs.= "\n\n";
/**
* Locations are where those misspellings are located, line:symbol
*/
- echo "var locations= new Array();\n";
+ $extrajs.= "var locations= new Array();\n";
$i=0;
while (list($word, $value) = each($locations)){
- echo "locations[$i] = \"$value\";\n";
+ $extrajs.= "locations[$i] = \"$value\";\n";
$i++;
}
- /**
+ /**
* Add some strings so they can be i18n'd.
*/
- echo "var ui_completed = \"" . _("Spellcheck completed. Commit changes?")
+ $extrajs.= "var ui_completed = \"" . _("Spellcheck completed. Commit changes?")
. "\";\n";
- echo "var ui_nochange = \"" . _("No changes were made.") . "\";\n";
- echo "var ui_wait = \""
+ $extrajs.= "var ui_nochange = \"" . _("No changes were made.") . "\";\n";
+ $extrajs.= "var ui_wait = \""
. _("Now saving your personal dictionary... Please wait.")
. "\";\n";
-
+
/**
- * Did I mention that I hate dots on the end of contcatenated lines?
+ * Did I mention that I hate dots on the end of concatenated lines?
* Dots at the beginning make so much more sense!
*/
- echo "//-->\n"
+ $extrajs.= "//-->\n"
. "</script>\n"
- . "<script src=\"js/check_me.js\" type=\"text/javascript\"></script>\n"
- . "</head>\n";
-
+ . "<script src=\"js/check_me.js\" type=\"text/javascript\"></script>\n";
+
+
+ displayHtmlHeader(_("SquirrelSpell Results"),$extrajs);
+
echo "<body bgcolor=\"$color[4]\" text=\"$color[8]\" link=\"$color[7]\" "
. "alink=\"$color[7]\" vlink=\"$color[7]\" "
. "onload=\"populateSqspellForm()\">\n";
<tr>
<td bgcolor="<?php echo $color[9] ?>" align="center">
<b>
- <?php printf( _("Found %s errors"), $errors ) ?>
+ <?php printf( ngettext("Found %d error","Found %d errors",$errors), $errors ) ?>
</b>
</td>
</tr>
<tr>
<td>
- <hr>
+ <hr />
</td>
</tr>
<tr>
<form method="post">
<input type="hidden" name="MOD" value="forget_me_not" />
<input type="hidden" name="words" value="" />
- <input type="hidden" name="sqspell_use_app"
+ <input type="hidden" name="sqspell_use_app"
value="<?php echo $sqspell_use_app ?>" />
<table border="0" width="100%">
<tr align="center">
echo $sptag . _("Line with an error:") . '</span>';
?>
<br />
- <textarea name="sqspell_line_area" cols="50" rows="3"
- wrap="hard" onfocus="this.blur()"></textarea>
+ <textarea name="sqspell_line_area" cols="50" rows="3"
+ onfocus="this.blur()"></textarea>
</td>
</tr>
<tr valign="middle">
?>
</td>
<td align="left" width="25%">
- <input name="sqspell_error" size="10" value=""
+ <input name="sqspell_error" size="10" value=""
onfocus="this.blur()" />
</td>
<td align="right" width="25%">
?>
</td>
<td align="left" width="25%">
- <select name="sqspell_suggestion"
+ <select name="sqspell_suggestion"
onchange="if (this.options[this.selectedIndex].value != '_NONE') document.forms[0].sqspell_oruse.value=this.options[this.selectedIndex].value">
<?php
echo '<option>' . _("Suggestions") . '</option>';
</td>
<td align="left">
<input name="sqspell_oruse" size="15" value=""
- onfocus="if(!this.value) this.value=document.forms[0].sqspell_error.value">
+ onfocus="if(!this.value) this.value=document.forms[0].sqspell_error.value" />
</td>
<td align="right">
<?php
?>
</td>
<td align="left">
- <input name="sqspell_likethis" size=3 value="" onfocus="this.blur()">
+ <input name="sqspell_likethis" size=3 value="" onfocus="this.blur()" />
</td>
</tr>
<!-- hello? What is this? </td></tr> -->
<tr>
- <td colspan="4"><hr></td>
+ <td colspan="4"><hr /></td>
</tr>
<tr>
<td colspan="4">
<table border="0" cellpadding="0" cellspacing="3" width="100%">
- <tr align="center" bgcolor="<?php echo $color[9] ?>">
+ <tr align="center" bgcolor="<?php echo $color[9] ?>">
<?php
- SpellLink('sqspellChange()',
- _("Change this word"),
- _("Change"));
- SpellLink('sqspellChangeAll()',
- _("Change ALL occurances of this word"),
- _("Change All"));
- SpellLink('sqspellIgnore()',
- _("Ignore this word"),
- _("Ignore"));
- SpellLink('sqspellIgnoreAll()',
- _("Ignore ALL occurances this word"),
- _("Ignore All"));
- SpellLink('sqspellRemember()',
- _("Add this word to your personal dictionary"),
- _("Add to Dic"));
+ SpellLink('sqspellChange()',
+ _("Change this word"),
+ _("Change"));
+ SpellLink('sqspellChangeAll()',
+ _("Change ALL occurances of this word"),
+ _("Change All"));
+ SpellLink('sqspellIgnore()',
+ _("Ignore this word"),
+ _("Ignore"));
+ SpellLink('sqspellIgnoreAll()',
+ _("Ignore ALL occurances this word"),
+ _("Ignore All"));
+ SpellLink('sqspellRemember()',
+ _("Add this word to your personal dictionary"),
+ _("Add to Dic"));
?>
</tr>
</table>
</td>
</tr>
<tr>
- <td colspan="4"><hr></td>
+ <td colspan="4"><hr /></td>
</tr>
<tr>
- <td colspan="4" align="center" bgcolor="<?php echo $color[9] ?>">
- <?php
- echo '<input type="button" value=" '
- . _("Close and Commit")
- . ' " onclick="if (confirm(\''
- . _("The spellcheck is not finished. Really close and commit changes?")
- . '\')) sqspellCommitChanges()">'
- . ' <input type="button" value=" '
- . _("Close and Cancel")
- . ' " onclick="if (confirm(\''
- . _("The spellcheck is not finished. Really close and discard changes?")
- . '\')) self.close()">';
+ <td colspan="4" align="center" bgcolor="<?php echo $color[9] ?>">
+ <?php
+ echo '<input type="button" value=" '
+ . _("Close and Commit")
+ . ' " onclick="if (confirm(\''
+ . _("The spellcheck is not finished. Really close and commit changes?")
+ . '\')) sqspellCommitChanges()" />'
+ . ' <input type="button" value=" '
+ . _("Close and Cancel")
+ . ' " onclick="if (confirm(\''
+ . _("The spellcheck is not finished. Really close and discard changes?")
+ . '\')) self.close()" />';
?>
</td>
</tr>
/**
* AREN'T YOU SUCH A KNOW-IT-ALL!
*/
- $msg="<form onsubmit=\"return false\"><div align=\"center\">"
- . "<input type=\"submit\" value=\" " . _("Close")
- . " \" onclick=\"self.close()\"></div></form>";
+ $msg='<form onsubmit="return false"><div style="text-align: center;">' .
+ '<input type="submit" value=" ' . _("Close") .
+ ' " onclick="self.close()" /></div></form>';
sqspell_makeWindow(null, _("No errors found"), null, $msg);
}
* Local variables:
* mode: php
* End:
+ * vim: syntax=php et ts=4
*/
-?>
projects / squirrelmail.git / blobdiff