Major Additions - MySmilies VB (v3.7.0)

Hack Support

This hack is now discontinued - this means that while it will remain available for download and use, there will be no further updates, nor will support be provided as the thread is no longer monitored.

Please click Mark as Installed if you are using this hack.

NOTE: I have marked this hack as Re-usable Code - This means that code from this hack may be used in other hacks, which can ONLY be released on official vB sites that use Jelsoft's verification system to verify your vBulletin license status, and as long as Kentaurus and I are credited in your hack.


vBulletin Version Compatibility

This hack can only be used with vBulletin v3.7.x.


NOTE 1:
This is a port of Kentaurus's MySmilies VB for v3.6.x (version 1.03) to work with vBulletin v3.7.0.

Kentaurus has indicated that he would be helping me provide support - see this post in his thread for confirmation. He has been added as a CoAuthor for this hack. Permission for me to port his hack is granted at the bottom of the 1st post in his thread.

NOTE 2:
Because I did not write the original hack (this version of the hack was originally only ever meant to be an interim version before Kentaurus released his version), hacks that I have written myself will always take priority over this one, and as a consequence, this hack only tended to get worked on whenever I felt the urge to look at it. I do not feel the urge anymore so have discontinued the hack.

People are free to install or un-install this whenever they want.

If anyone wants to continue the development of this hack, then they are more than welcome to take over, as I have marked this as re-usable code, I don't mind either way.


So Whats New?

• Now has CSRF (cross-site request forgery) Protection (introduced in vBulletin v3.6.10 and v3.7.0 RC 4)
• 9 new plugins (cached all uncached templates, WOL sorted)
• Now fully phrased
• Auto-template injection (no template edits should now be needed)
• Smilie Links now only appear if the member has permission to use MySmiles
• Prettied up a couple of the templates
• Template edits, if needed, now use only a single variable in each case
• Signature custom smilie support added
• Fixed attachments showing when posted inline within the same post (this only affects a very small amount of installations to start with, which is why it took so long to replicate, and I can not replicate this with every installation)

What Does This Hack Do?

This hack puts the control of the smilies on the users. It lets any user (that you give permission to) upload or modify the smilies that he can use.

These are not the smilies that vb uses, these are user-customized smilies. The smilies that you already have in place are preserved and are still used. But users may upload their own smilies for their use, and they are kept separate from the standard forum smilies.

For users:

• Users can keep a library of their own smilies (they can upload them from their computer or web)
• Users enter their replacement text, for example, :iamhappy: would be changed to their own user happy smilie
• The custom smilies are parsed in any post, signature, or pm (does not include the new social network fuctionality that was added with v3.7.0 yet, it is on my to-do list)
• If they have enabled the WYSIWYG editor, smilies are shown there

For administrators:

• Usergroup control of who may upload custom smilies
• Usergroup control of the size (width, height, size in bytes) of the smilie
• Smilie quota, both for max number of smilies and max number of bytes or hard disk space
• The administrator can choose where to save the smilies (the directory, default: mysmiliesvb)
• Auto-template Injection - if the appropriate template hooks are available, you will not need to make any template edits at all, if edits needed you only need to paste a single variable where you need it

Installation Instructions

See the included Installation Instructions.txt file in the ms_mysmiliesvb.zip zip file.

ADDITIONAL NOTE:
A limitation exists with the fix that rectifies the problem of attachments showing when also posting them inline within the same post; when applied, all attachments will need to be displayed inline, if they have not been, then the ones that have not been posted inline will be hidden along with the ones that have been posted inline. Read Post #106 for more information on this.

Uninstall Instructions

1. Delete mysmiliesvb.php from your forum's root directory.
2. Delete the mysmiliesvb directory from your forum's root directory.
3. Delete class_dm_mysmiliesvb.php from your forum's /includes directory.
4. Delete bitfield_mysmiliesvb.xml from your forum's /includes/xml directory.
5. Delete delete.gif from your forum's /images/misc directory (if more than one style remember to delete it from all misc directories).
6. Optional Step: This step is only if the auto template injection does not work, and you did the optional template edits.
   In the USERCP_SHELL template, find and delete:
   
   PHP Code:

   $mysmilie_usercp 

   In the navbar template, find and delete:
   
   PHP Code:

   $mysmilie_navbar 

7. Uninstall the product in vB using the AdminCP Product Manager.

To Do List

Features are being done in the order that they appear on the list, and when I feel the urge to work on this hack. And as I have now completely lost the urge, it means that the rest of the requests will never be added.

1. [s]Signature custom smilie support[/s] - DONE
2. [s]Fully phrase the hack[/s] - DONE
3. [s]Usergroup Permissions - disabled by default[/s] - DONE
4. [s]Profile Comments custom smilie support[/s] - Will never be done
5. [s]Album Comments custom smilie support[/s] - Will never be done
6. [s]Social Group Comments custom smilie support[/s] - Will never be done
7. [s]Admin Control Panel utility to view/delete one, some or all custom smilies[/s] - Will never be done
8. [s]vB Blog custom smilie support[/s] - Will never be done

Version History

v3.7.005 - Wednesday 1st October 2008
-- Final Release
-- Fixed: Workaround for people having issues with uploading smilies from a url
-- Added: AdminCP Option to allow for which upload option shows for the end user
-- Added: Phrase for navbits - this hack is now fully phrased
-- Changed: mysmiliesvb.php file
-- Changed: MYSMILIES_MAIN template
-- Changed: Usergroup permissions - Can use custom smilies? now set to No by default

v3.7.004 - Thursday 7th August 2008
-- Fixed: Attachments were showing when the attachment was shown inline in the same post
-- Added: AdminCP Option to turn this fix On or Off

v3.7.003 - Wednesday 16th July 2008
-- Fixed: Cached templates
-- Changed: mysmilies_delete template
-- Added: Signature custom smilie support
---- thread/post creation
---- thread/post preview
---- postbit (including postbit_legacy)
---- edit signature
---- signature preview
---- user profile

v3.7.002 - Thursday 29th May 2008
-- Fixed: SQL Error problems some people upgrading from the v3.6.x version of this hack were having

v3.7.001 - Wednesday 14th May 2008
-- Initial v3.7.0 release


Thanks

My thanks go out to Kentaurus (who originally created this fantastic hack I have updated), and also to Paul M who gave me permission to use some of his install code.


Show Your Appreciation

Although not required, if you have enjoyed the benefits of this hack, and would like show your appreciation for my efforts, then please feel free to click on the Support Developer link and donate any amount you feel is appropriate.

[Tulsa]

has anyone else noticed that some smilies become smaller when added to this modification?

[Mosh]

Originally Posted by IvyKeepMommy

*installed*

My only request would be that the smilies be disabled by default so that it is easier to manage (in our case we have a number of user groups and only paid subscription members get to use their own smilies, so it was quite a bit of work to have to go and edit ALL the other user groups.)

It would have been much simpler if the default setting was to have it turned off and I could enable it for who I wanted, instead of having to disable it for everyone else

This is in the new version I am releasing today

[Mosh]

Originally Posted by sflmkv

sure try this one

http://www.mysmiley.net/imgs/smile/cool/cool0012.gif

I still can not reproduce this problem, and I have tried a lot of different environments and web browsers. As I can not reproduce it, I can not fix it.

So, what I am going to do, is add an admincp option to allow you and others to select which method(s) for uploading smilies they will see:

• Upload from PC
• Enter URL for image from another website
• Both of the above (default)

That way if you have an issue with one method or another (a very small percentage of you), or you want to restrict which method your end users are allowed to use, you can now do so.

I will be releasing this updated version today.

[Mosh]

Originally Posted by Tulsa

has anyone else noticed that some smilies become smaller when added to this modification?

That is the normal behaviour for this hack (instead of not allowing the image to be uploaded).

If a user tries uploading an image that is larger in dimensions than those specified for his usergroup, then the image will down-sized to the maximum dimensions allowed for that usergroup.

[Mosh]

Update: v3.7.005
-- Fixed: Workaround for people having issues with uploading smilies from a url
-- Added: AdminCP Option to allow for which upload option shows for the end user
-- Added: Phrase for navbits - this hack is now fully phrased
-- Changed: mysmiliesvb.php file
-- Changed: MYSMILIES_MAIN template
-- Changed: Usergroup permissions - Can use custom smilies? now set to No by default

[vfaguilera]

what are the steps to upgrade to the latest version?

[Mosh]

Originally Posted by vfaguilera

what are the steps to upgrade to the latest version?

Read the Installation Instructions included - you will need do at least steps 1 - 4.

[Hostboard]

Upgraded.

Thank you!

[Bill from Cleve]

Works great! Thanks!

[sflmkv]

upgraded to latest version and still having url issue, such a great a plugin also, for some strange reason using the new option of only showing the upload feature doesn't work.