Module: Custom Attachment Icons
Posted by Joe Curia
|
October 08, 2008 10:59PM |
This module allows the admin to replace the normal attachment icon with icons relating to the type of the attachments or link in the post. Each supported type has a language entry for Alt/Title display. The module also searches for [ img ], [ video ], and [ mp3 ] bbcode tags and the extensions of http links inside the body of messages as they are posted. Thanks go to Maurice Makaay for his regex coding to detect the image and video links.
Installation and Usage:
In order to use this module, you must first install and enable it like any other module. Then you must edit your list.tpl, list_threads.tpl, or read_threads.tpl file to utilize the additional icons. For example, in the Emerald template you should change:
If you are not installing this module as a part of a new phorum installation, you will want to run the script to check past posts for bbcode and url links to count as attachments. This option can be found on the settings page.
At this time, if you want to customize the icons or add more file types, you can edit the mime_types.php file. Please note that any customized icons should be placed in the images folder, should be 16px by 16px, and should have a counterpart with a "multi_" prefix if you want to show a different icon when more than one attachment of a single type is attached (ie. two pictures).
Support for the Recent Messages module has been added, with two edits needed:
First, the ./mods/recent_messages/recent_messages.php file must be edited to add these lines (I have included the three existing lines as a reference point for where to place the new code):
Next, the ./mods/recent_messages/templates/emerald/render_message_row.tpl file must be edited to add this line (again with existing code for reference):
Todo:
- Find a way to avoid template editing if at all possible (not looking good)
- Allow the admin to customize or add type icons from the settings page
- Add further features as requested or as they pop into my head
Joe Curia (aka Azumandias)
Modules: l0Admin Mass Email00000000l000000Automatic Time Zones000ll.l00000Enhanced Custom Profiles0.00Google Calendar0000l.l000000Post Previews
000000000Admin Security Suite000000000000Check Modules for Upgrades0000External Authentication000000Group Auto-Email00000.00000Private Message Alerts
000000000Attachment Download Counter0000Custom Attachment Icons000ll.ll00Favorite Forums000000.00000Highlighted Search Terms0000Self-Delete Posts Option
000000000Attachment Watermarks0l00000000Custom Language Database00l.l.0Forum Lockdown00000.00000Ignore Forums0000000000000Threaded Tree View
000000000Automatic Message Pruning00.llll.00Easy Color Scheme Manager0l.l00Forum Subscriptions0000lll000Moderated User Group
Templates:lGeneric Integration000000000 0000Simple Rounded000000 00000000Tabbed Emerald
Edited 5 time(s). Last edit at 05/04/2009 12:05AM by Joe Curia.
Installation and Usage:
In order to use this module, you must first install and enable it like any other module. Then you must edit your list.tpl, list_threads.tpl, or read_threads.tpl file to utilize the additional icons. For example, in the Emerald template you should change:
{IF MESSAGES->meta->attachments}<img src="{URL->TEMPLATE}/images/attach.png" class="icon1616" title="{LANG->Attachments}" alt="{LANG->Attachments}" /> {/IF}
to read:
{INCLUDE "custom_attachment_icons::list_icons"}
A notice will be posted at the top of the forum for admin if the template edits have not been made. This mainly serves as a reminder if a future upgrade overwrites the template edits you mad while installing this module, and can be disabled from the settings page if needed.
If you are not installing this module as a part of a new phorum installation, you will want to run the script to check past posts for bbcode and url links to count as attachments. This option can be found on the settings page.
At this time, if you want to customize the icons or add more file types, you can edit the mime_types.php file. Please note that any customized icons should be placed in the images folder, should be 16px by 16px, and should have a counterpart with a "multi_" prefix if you want to show a different icon when more than one attachment of a single type is attached (ie. two pictures).
Support for the Recent Messages module has been added, with two edits needed:
First, the ./mods/recent_messages/recent_messages.php file must be edited to add these lines (I have included the three existing lines as a reference point for where to place the new code):
// ----------------------------------------------------------------------
// Setup template data.
// ----------------------------------------------------------------------
// run list mods
if (isset($PHORUM["hooks"]["list"]))
$messages = phorum_hook("list",$messages);
Next, the ./mods/recent_messages/templates/emerald/render_message_row.tpl file must be edited to add this line (again with existing code for reference):
<h4><a {IF subjectclass}class="{subjectclass}"{/IF}
href="{MESSAGE->URL->READ}">{MESSAGE->subject}</a>
{INCLUDE "custom_attachment_icons::recent_messages_icons"}
</h4>
Todo:
- Find a way to avoid template editing if at all possible (not looking good)
- Allow the admin to customize or add type icons from the settings page
- Add further features as requested or as they pop into my head
Joe Curia (aka Azumandias)
Modules: l0Admin Mass Email00000000l000000Automatic Time Zones000ll.l00000Enhanced Custom Profiles0.00Google Calendar0000l.l000000Post Previews
000000000Admin Security Suite000000000000Check Modules for Upgrades0000External Authentication000000Group Auto-Email00000.00000Private Message Alerts
000000000Attachment Download Counter0000Custom Attachment Icons000ll.ll00Favorite Forums000000.00000Highlighted Search Terms0000Self-Delete Posts Option
000000000Attachment Watermarks0l00000000Custom Language Database00l.l.0Forum Lockdown00000.00000Ignore Forums0000000000000Threaded Tree View
000000000Automatic Message Pruning00.llll.00Easy Color Scheme Manager0l.l00Forum Subscriptions0000lll000Moderated User Group
Templates:lGeneric Integration000000000 0000Simple Rounded000000 00000000Tabbed Emerald
Edited 5 time(s). Last edit at 05/04/2009 12:05AM by Joe Curia.
|
October 09, 2008 03:28AM |
Chapeau!
*scratches this one of his list* :)
I'll answer the question from the other thread where you posted in here, since this seems the correct place for discussing the mod (the question was about updating all messages in the database).
Using the recent messages code would not be a good way to go over all messages. That code works best for the most recent messages. The queries and indexes are fine-tuned to that. The further you go into the historic messages, the slower the function will do its work.
You need to write a custom query to go over all messages. You can keep the query extremely simple and use api functions to get to the data. The idea is like this:
For processing all users, we already built something into the db layer (phorum_db_user_get_all()). It might be nice to have the same function for messages as well, so that can be used to loop over the messages without having to revert to custom queries.
When building an admin panel for rebuilding all icons, the most important thing to take care or are large message databases. The user needs some visual feedback to know that processing is going on and care has to be taken to not let PHP stop the script because it is running too long. It's a bit like the rebuilding of display names (admin panel, database integrity). There I did some poor man's solution to do the processing in multiple page loads, while showing the progress. Maybe you can fetch some ideas from that code. Of course, an Ajaxy system could make it somewhat nicer.
Maurice Makaay
Phorum Development Team
my blog 
linkedin profile 
secret sauce
Edited 1 time(s). Last edit at 10/09/2008 03:48AM by Maurice Makaay.
*scratches this one of his list* :)
I'll answer the question from the other thread where you posted in here, since this seems the correct place for discussing the mod (the question was about updating all messages in the database).
Using the recent messages code would not be a good way to go over all messages. That code works best for the most recent messages. The queries and indexes are fine-tuned to that. The further you go into the historic messages, the slower the function will do its work.
You need to write a custom query to go over all messages. You can keep the query extremely simple and use api functions to get to the data. The idea is like this:
Language: PHP$res = phorum_db_interact( DB_RETURN_RES, "SELECT message_id FROM {$PHORUM[';message_table';]}" ); while ($row = phorum_db_fetch_row($res, DB_RETURN_ROW)) { $message_id = $row[0]; // ... from here on you can do the processing for the // ... the message_id. }
For processing all users, we already built something into the db layer (phorum_db_user_get_all()). It might be nice to have the same function for messages as well, so that can be used to loop over the messages without having to revert to custom queries.
When building an admin panel for rebuilding all icons, the most important thing to take care or are large message databases. The user needs some visual feedback to know that processing is going on and care has to be taken to not let PHP stop the script because it is running too long. It's a bit like the rebuilding of display names (admin panel, database integrity). There I did some poor man's solution to do the processing in multiple page loads, while showing the progress. Maybe you can fetch some ideas from that code. Of course, an Ajaxy system could make it somewhat nicer.
Maurice Makaay
Phorum Development Team
my blog linkedin profile secret sauceEdited 1 time(s). Last edit at 10/09/2008 03:48AM by Maurice Makaay.
|
October 09, 2008 09:05AM |
|
October 09, 2008 09:48AM |
Programming for the millions (of messages).
That's what this all is about. Glad to be of help.
Maurice Makaay
Phorum Development Team
my blog linkedin profile secret sauce
That's what this all is about. Glad to be of help.
Maurice Makaay
Phorum Development Team
my blog linkedin profile secret sauce
|
October 10, 2008 09:48AM |
|
October 15, 2008 12:56AM |
|
October 21, 2008 07:40PM |
|
October 21, 2008 07:53PM |
|
October 21, 2008 07:59PM |
Sorry, only registered users may post in this forum.