Spell Checker: PungoSpell for vBulletin3 Standard and WYSIWYG modes

There's also a vB 3.5 version: https://vborg.vbsupport.ru/showthrea...threadid=83258

PungoSpell for vBulletin3 WYSIWYG and Standard mode

Intro: PungoSpell supports WYSIWYG mode disply using DHTML on the spell check popup window. It uses PHP's buitin PSPELL module. Many have this already compiled in, but if not, it's easy to add.

What this hack does This hack modifies the PungoSpell software package from PungoSpell to allow spell checking on vBulletin for both modes, WYSIWYG and standard mode.

Change Log:

v1.6 December 25, 2005: Security fix for cases where you allow HTML posts and they contain malicious code (Credit goes to Brendan Donahue for finding the issue and alerting TechGuy, and to TechGuy for alerting me to it)

v1.5. Minor bug fixes

v1.4
1. Fixed scrolling, so the spelling window will scroll to the next mis-spelled word.
2. Changed config defaults to allow the most common configuration. The "Learn" function is turned of by default. Make sure you test it before tunrning it on.
3. Re-worded comments on config options, hopefully they will now make sense.

v1.3
1. Created a new config file (pungo-spell-config.php) to avoid the need to edit checkspelling.php, which is a bit tricky with end of line characters.
2. Added an option to disable the learn feature. This may be needed if your aspell setup does not allow, or not properly setup, for personal wordlists.
3. The language is now defined in the config file as well.

v1.1:
1. Added a "Learn" button. This allows users to add words into the dictionary.
2. Restricted access to members only, with allowed usergroups definable in config file
3. Restrict user groups allowed to use the "Learn" feature. Configurable option.
3. Options to ignore quote blocks, code bloacks, and PHP blocks
4. Added buttons (Thesarus and Lookup) with links to Merriam Webster's online thesarus and dictionary links with the suggestion for misspelled words.
5. Added Quit and Done buttons. One to quite without saving, and one to save without going through the whole post for suggestions.
6. Fixed extra lines added for WYSIWYG paragraphs
7. Made it skip vBCode tags, so it won't spell check URL's

v1.0:
Initial version, . Identical to PungoSpell functionality, but adapted to handle vBulletins's WYSIWYG and standard mode.


Note: There's another hack for spell checker for vBulletin3 using PHPSpell. You might want to compare both to decide which one you like best.
https://vborg.vbsupport.ru/showthrea...threadid=65723

PHPSpell has a "learn" button, to allow adding new words to the dictionary, PungoSpell does not. PungoSpell has a better WYSIWYG display, while PHPSpell does not hide HTML and vBCode tags. So each one has it's advantages and disadvantages.

In a future release, I'll try to add a "learn" functionality to PungoSpell. (done)

Credit PungoSpell Is a free software using the MIT license. By default, it will work fine in standard mode. This hack will allow it to work for both standard and WYSIWYG.

Requirements: You will need to have PSPELL compiled into your PHP setup. Many have this by default. To find out if you already have it, check your PHP info from the vBulletin Admin Panel: Import & Maintenance > View PHP Info. Search for "pspell". If it's there, you're fine. If not, you can recompile PHP with the "--with-pspell" paramater.

From the readme file:

What does it require?
---------------------

PHP 4.3.1 (http://www.php.net) or greater with Pspell support enabled.
If your system doesn't have pspell/aspell installed, see the pspell source page at
http://pspell.sourceforge.net to download it.

What browsers does it work with?
-------------------------------

Only "modern" browsers that support DOM level 2 (http://www.w3.org/TR/DOM-Level-2-Core/) are supported. MSIE 5.5+, Opera 7.2+, NS 6+ should work fine for you. Your milage may vary.

Demo: http://frigate.clemson.edu/local/pun...l/example.html

Bugs: Scrolling down to the misspelled word is not yet working.

Instructions

1. Download the attached file, and unpack into your main forum directory. Make sure the file "custom.pws" is writable by apache, otherwise the "Learn" function will not work.

2. It has English setup by default. If you want it to use any other language, it's easy. Just edit the config file "pungo-spell-config.php".

Change this line:

$my_lang = "en";

"en" stands for English. Change it to the code of the language you want. Like "fr" for French, for example. Make sure your system has the required dictionary. You see the dictionary config by typing "aspell config" at the command line, to see which dictionaries you have.

Also, in the file custom.pws, the first line reads something like:

personal_ws-1.1 en 0

You will need to change en to the language you use, like fr

3. Edit the config section in checkspelling.php to suit your needs:
[code]
// Config section
$my_lang = "en"; // set the language you want, make sure you have the correct aspell dictionary on your system

// Access restriction options
$allow_guests = 0; // Change to 1 if you allow guests to post and use the spell checker
$restrict_groups = 0; // Change to 1 to enable access restriction by group id
$allowd_groups = array (2, 5, 6); // usergroups who can access the spell checker

// Learn function options
$customwordlist = "custom.pws"; // make sure this file is readable by your apache user
$learn_enabled = 0; // set to 1 to enable the learn feature. Make sure you test first, to ensure your server setup allows this.
$restrict_learn_function = 0; // set to 1 if you want to restrict which usergroup id may add words to your dictionary.
$word_list_maintainers = array (2, 5, 6); // usergroups that are allowed to use the "Learn" feature
//

// Ignore options
$ignore_quotes = 1; // 1 means ignore the [QUOTE] block, 0 means spell check within quotes
$ignore_code = 1; // Same but for the

 tag
 $ignore_php = 1; 				// Same, but for the [PHP] tag 
 
 // end config section

4. Edit each template where you'd like to have the spell checker. For example:

newreply template

A. Find

</head>

Add above

<script src="spellcheck.js"></script>

B. Add somewhere the followin (below $navbar for example)g:

   <form name="spell_form" id="spell_form" method="POST" target="spellWindow"
                    action="checkspelling.php">
                <input type="hidden" name="spell_formname" value="">
                <input type="hidden" name="spell_fieldname" value="">
                <input type="hidden" name="spellstring" value="">
             </form>

C. Find the submit and preview buttons:

		<input type="submit" class="button" name="sbutton" value="$vbphrase[submit_reply]" accesskey="s" tabindex="1" />
 		<input type="submit" class="button" name="preview" value="$vbphrase[preview_post]" accesskey="p" tabindex="1" />

Add below:

           <if condition="DOTOOLBAR!=2">
           <input type="hidden" name="toolbar" value="1" />
           <input type="button" class="button" value="Spell Check" onClick="spellCheck( 'vbform',  'message', '1');">
           <else />
           <input type="hidden" name="toolbar" value="2" />
           <input type="button" class="button" value="Spell Check" onClick="spellCheck( 'vbform',  'WYSIWYG_HTML', '2');">
           </if>

And repeat the same steps for other templates like newthread etc.

Optional: Other Templates that contain edit boxes are:
USERCP_SHELL just add the first change (A) here in above the </head section. Required for pm_newpm and modifysignature.
editpost
Calendar Templates: calendar_edit
New Posting Templates: newreply, newthread
Modify User Options Templates: modifysignature (add the the first change (A) in USERCP_SHELL) and the rest (B and C) here.


Quick reply

1. Show Thread Templates: Put change (A) in showthread, and the rest (B and C) in showthread_quickreply

2. Contributed by Boofo:

change:

<if condition="DOTOOLBAR!=2">

to:

<if condition="$WYSIWYG!=2">

I may have missed a few templates, so let me know.


Private Messages

To install in Private Messaging, check Chris's post here:
https://vborg.vbsupport.ru/showpost....6&postcount=84

------

Trouble shooting:

1. If you get a spell check window that says "This is a test". This is most likely due to end of line characters caused by an editor. To resolve this, re-upload the original files with FTP in binary mode. When editing the config file, make sure you use an editor that does not add any end of line characters, such as "vi" or others.

2. Learn doesn't work: Try this: Change the first line from custom.pws:

personal_ws-1.1 en 0

To:

personal_ws-1.1 english 0

en worked fine for me on Fedora and Gentoo, but I had to change to english on RHE.

-----

Enjoy

P.S. The two screenshots below show the spell check popup menu. One for standard mode, and one for WYSIWYG mode.

[DTC]

OK, figured it out! We were missing the .pwli file in the pspell data directory. Cpanel had to wack it at one point...go figure...

Here's what ya need to do:

Check the pspell data directory. If you don't know where that is type:

pspell-config pkgdatadir

That should tell you where to look. In my case it was /usr/share/pspell/

You need to create a file in that directory called en-aspell.pwli (I use english) and the only thing that is in the file is the path to your dictionary. In my case the file contains one line as below:

/usr/lib/aspell/english

Bingo, it works again...

Good 'ole CPanel....

Hope that helps anyone else that has the problem...

[Mark.B]

My hosts upgraded to php 4.3.10 tonight and it fixed the error.

[Dio]

If I am posting a new thread or replying to a thread life is good, but when I try to respond to a thread that has "quoting" in it I get an error message - it tells me to talk with my administrator. Any ideas how to correct it so that it is available when spell checking is used during a reply with quoting in it?

[Wifey]

All of a sudden my spell check isn't working. I'm not sure if it was from a query I ran a few days ago and I have no idea why. It's at least not getting an error anymore when I try to use it since I had my hosting move me to a newer server, but I just reinstalled this hack and I don't understand why it's not working.

I hit spell check and a blank window pops up saying its done. Any ideas?

[Dio]

Is there anybody out there supporting this hack?

[LunaTech]

I've solved the "An error has occured, ....your administrator" error in my case. I noticed it only happend when the text had a carrige return. If it was only one line of text no problems. So, not surprisingly, it turns out the problem stems from a carrige return being imbedded in the checkspelling.php. If you edit that file, you must not do it in DOS mode. If you edit the file in DOS mode, it'll break the carrige return and mess up your code. Try uploading a fresh copy of checkspelling.php (in binary mode) if you have any trouble.

[Dio]

Originally Posted by LunaTech

I've solved the "An error has occured, ....your administrator" error in my case. I noticed it only happend when the text had a carrige return. If it was only one line of text no problems. So, not surprisingly, it turns out the problem stems from a carrige return being imbedded in the checkspelling.php. If you edit that file, you must not do it in DOS mode. If you edit the file in DOS mode, it'll break the carrige return and mess up your code. Try uploading a fresh copy of checkspelling.php (in binary mode) if you have any trouble.

Thank you for the response!

Where is the carrige return in the checkspelling.php file, is this something that I can delete? I've uploaded a fresh copy of checkspelling.php and it did not correct the problem. :ermm:

[LunaTech]

Line 47, 48, and 49 should look like (note, I've replaced the HEX 0D character, the line break, in with a space so it displays right on this page):

// can't have newlines or carriage returns in javascript string
$mystr = str_replace(" ", "", $mystr);
$mystr = str_replace("\n", "_|_", $mystr);

Not:

// can't have newlines or carriage returns in javascript string
$mystr = str_replace("
", "", $mystr);
$mystr = str_replace("\n", "_|_", $mystr);

The problem is most editors won't read it right. I had to use UltraEdit32, in UNIX mode. To see if you're having the same problem as I did, try spell checking a single line of text with no line breaks. Just like 3 words. If that works fine but more text doesn't - that's probably the problem.

[Dio]

Originally Posted by LunaTech

Line 47, 48, and 49 should look like (note, I've replaced the HEX 0D character, the line break, in with a space so it displays right on this page):

// can't have newlines or carriage returns in javascript string
$mystr = str_replace(" ", "", $mystr);
$mystr = str_replace("\n", "_|_", $mystr);

Not:

// can't have newlines or carriage returns in javascript string
$mystr = str_replace("
", "", $mystr);
$mystr = str_replace("\n", "_|_", $mystr);

The problem is most editors won't read it right. I had to use UltraEdit32, in UNIX mode. To see if you're having the same problem as I did, try spell checking a single line of text with no line breaks. Just like 3 words. If that works fine but more text doesn't - that's probably the problem.

Hmmm....I made the changes that you suggested but they did not correct the problem. :ermm:

[Wifey]

Alrighty I made those changes and I uploaded a fresh install and I'm still having issues.

It was working LIKE A CHARM before then all of a sudden decided not to anymore.

When I hit check spelling the windo pops up, loads, and it's blank and says it's done.