sqspell_functions.php
All SquirrelSpell-wide functions are in this file.
Workaround for including function squirrelspell_version() in SM 1.5 CVS, where plugins' setup.php is not included by default.
load plugin configuration
SquirrelSpell version. Don't modify, since it identifies the format
of the user dictionary files and messing with this can do ugly stuff. :)
Used to check internal version of SquirrelSpell dictionary
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.
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.
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.
Deletes user's dictionary
Function was modified in 1.5.1 (sqspell 0.5). Older function is suffixed with '_old'
Deletes user's dictionary when it is corrupted.
Get user dictionary for selected language Function was modified in 1.5.1 (sqspell 0.5).
Older function is suffixed with '_old'
Get user's dictionary (old format)
This function returns only user-defined dictionary words that correspond to the requested language.
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'
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.
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.
Displays form that allows to enter different password for dictionary decryption.
If language is not set, function provides form to handle older dictionary files.
Creates an empty user dictionary for the sake of saving prefs or whatever.
This function is the GUI wrapper for the options page. SquirrelSpell uses it for creating all Options pages.
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.
Saves user's language preferences
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.
Saves user's dictionary Function was replaced in 1.5.1 (sqspell 0.5).
Older function is suffixed with '_old'
Writes user dictionary into the $username.words file, then changes mask to 0600. If encryption is needed -- does that, too.
Register option page block (internal function)
This function adds a "Check Spelling" link to the "Compose" row during message composition (internal function).
Upgrade dictionaries (internal function)
Transparently upgrades user's dictionaries when message listing is loaded
Documentation generated on Mon, 13 Jan 2020 04:23:34 +0100 by phpDocumentor 1.4.3