Workaround for including function squirrelspell_version() in SM 1.5 CVS, where plugins' setup.php is not included by default.

load plugin configuration

• todo: allow storing configuration file in config/ directory

SquirrelSpell version. Don't modify, since it identifies the format

of the user dictionary files and messing with this can do ugly stuff. :)

• deprecated:

Used to check internal version of SquirrelSpell dictionary

• return: true if stored dictionary version is $major.$minor or newer
• since: 1.5.1 (sqspell 0.5)

• integer $major: main version number
• integer $minor: second version number

This function checks for security attacks. A $MOD variable is

provided in the QUERY_STRING and includes one of the files from the modules directory ($MOD.mod). See if someone is trying to get out of the modules directory by providing dots, unicode strings, or slashes.

• return: since it bails out with an access error if needed.

• string $rMOD: the name of the module requested to include.

Encryption function used by plugin

This function does the encryption and decryption of the user dictionary. It is only available when PHP is compiled with mcrypt support (--with-mcrypt). See doc/CRYPTO for more information.

• return: content, or "PANIC" if the process bails out.

• $mode $mode: A string with either of the two recognized values: "encrypt" or "decrypt".
• $ckey $ckey: The key to use for processing (the user's password in our case.
• $input $input: Content to decrypt or encrypt, according to $mode.

Encryption function used by plugin (old format)

This function does the encryption and decryption of the user dictionary. It is only available when PHP is compiled with mcrypt support (--with-mcrypt). See doc/CRYPTO for more information.

• return: content, or "PANIC" if the process bails out.
• deprecated:
• since: 1.5.1 (sqspell 0.5)

• $mode $mode: A string with either of the two recognized values: "encrypt" or "decrypt".
• $ckey $ckey: The key to use for processing (the user's password in our case.
• $input $input: Content to decrypt or encrypt, according to $mode.

Deletes user's dictionary

Function was modified in 1.5.1 (sqspell 0.5). Older function is suffixed with '_old'

• string $lang: dictionary

Deletes user's dictionary when it is corrupted.

• deprecated:
• since: 1.5.1 (sqspell 0.5)

Get user dictionary for selected language Function was modified in 1.5.1 (sqspell 0.5).

Older function is suffixed with '_old'

• string $lang: language
• array 1: words stored in selected language dictionary

Get user's dictionary (old format)

This function returns only user-defined dictionary words that correspond to the requested language.

• return: list of words corresponding to the language requested.
• deprecated:
• since: 1.5.1 (sqspell 0.5)

• $words $words: The contents of the user's ".words" file.
• $lang $lang: Which language words to return, e.g. requesting "English" will return ONLY the words from user's English dictionary, disregarding any others.

gets list of available dictionaries from user's prefs.

Function was modified in 1.5.1 (sqspell 0.5). Older function is suffixed with '_old'

• return: list of dictionaries used by end user.

Get list of enabled languages.

Right now it just returns an array with the dictionaries available to the user for spell-checking. It will probably do more in the future, as features are added.

• return: a strings array with dictionaries available to this user, e.g. {"English", "Spanish"}, etc.
• deprecated:
• since: 1.5.1 (sqspell 0.5)

• string $words: The contents of the user's ".words" file.

Saves user's dictionary (old format)

This function operates the user dictionary. If the format is clear-text, then it just reads the file and returns it. However, if the file is encrypted (well, "garbled"), then it tries to decrypt it, checks whether the decryption was successful, troubleshoots if not, then returns the clear-text dictionary to the app.

• return: contents of the user's ".words" file, decrypted if necessary.
• deprecated:
• since: 1.5.1 (sqspell 0.5)

Displays form that allows to enter different password for dictionary decryption.

If language is not set, function provides form to handle older dictionary files.

• since: 1.5.1 (sqspell 0.5)

• string $lang: language

Creates an empty user dictionary for the sake of saving prefs or whatever.

• return: template to use when storing the user dictionary.
• deprecated:

This function is the GUI wrapper for the options page. SquirrelSpell uses it for creating all Options pages.

• string $title: The title of the page to display
• string $scriptsrc: This is used to link a file.js into the <script src="file.js"></script> format. This allows to separate javascript from the rest of the plugin and place it into the js/ directory.
• string $body: The body of the message to display.

Function similar to the one above. This one is a general wrapper for the Squirrelspell pop-up window. It's called form nearly everywhere, except the check_me module, since that one is highly customized.

• string $onload: Used to indicate and pass the name of a js function to call in a <body onload="function()" for automatic onload script execution.
• string $title: Title of the page.
• string $scriptsrc: If defined, link this javascript source page into the document using <script src="file.js"> format.
• string $body: The content to include.

Saves user's language preferences

• since: 1.5.1 (sqspell 0.5)

• array $langs: languages array (first key is default language)

This function transparently upgrades the 0.2 dictionary format to the 0.3 format, since user-defined languages have been added in 0.3 and the new format keeps user dictionaries selection in the file.

This function will be retired soon, as it's been a while since anyone has been using SquirrelSpell-0.2.

• return: of the 0.3-style user dictionary.
• deprecated:

• $words_string $words_string: Contents of the 0.2-style user dictionary.

Saves user's dictionary Function was replaced in 1.5.1 (sqspell 0.5).

Older function is suffixed with '_old'

• array $words: words that should be stored in dictionary
• string $lang: language

Writes user dictionary into the $username.words file, then changes mask to 0600. If encryption is needed -- does that, too.

• deprecated:
• since: 1.5.1 (sqspell 0.5)

• $words $words: The contents of the ".words" file to write.

Register option page block (internal function)

• since: 1.5.1 (sqspell 0.5)

This function adds a "Check Spelling" link to the "Compose" row during message composition (internal function).

• since: 1.5.1 (sqspell 0.5)

Upgrade dictionaries (internal function)

Transparently upgrades user's dictionaries when message listing is loaded

• since: 1.5.1 (sqspell 0.5)