* @author Robin Rainton * @package plugins * @subpackage ldapfolderinfo * @version $Id: setup.php,v 1.4 2007/08/23 13:54:56 avel Exp $ */ /** * Squirrelmail plugin initialize * @return string */ function squirrelmail_plugin_init_ldapfolderinfo() { global $squirrelmail_plugin_hooks; /* Application Logic Hooks */ $squirrelmail_plugin_hooks['left_main_before']['ldapfolderinfo'] = 'ldapfolderinfo_left_before'; $squirrelmail_plugin_hooks['uoa_left_main_boxes_structure']['ldapfolderinfo'] = 'ldapfolderinfo_fill_boxes_structure'; $squirrelmail_plugin_hooks['uoa_template_getboxstructure']['ldapfolderinfo'] = 'ldapfolderinfo_template_getboxstructure'; /* Template / Display Hooks */ $squirrelmail_plugin_hooks['menuline']['ldapfolderinfo'] = 'ldapfolderinfo_menuline'; $squirrelmail_plugin_hooks['folders_bottom']['ldapfolderinfo'] = 'ldapfolderinfo_display_verbose_link'; $squirrelmail_plugin_hooks['uoa_left_main_after_each_folder']['ldapfolderinfo'] = 'ldapfolderinfo_left_main_after_each_folder'; $squirrelmail_plugin_hooks['template_construct_left_main.tpl']['ldapfolderinfo'] = 'ldapfolderinfo_left_after'; $squirrelmail_plugin_hooks['template_construct_page_header.tpl']['ldapfolderinfo'] = 'ldapfolderinfo_tpl_pagetop'; $squirrelmail_plugin_hooks['uoa_read_menubar_buttons.tpl_reply_links']['ldapfolderinfo'] = 'ldapfolderinfo_display_reply_folder'; } /** * Fill the boxes structure, that is returned by function * sqimap_mailbox_tree(), with information from ldap. * * @see ldapfolderinfo_fill_boxes_structure_do() */ function ldapfolderinfo_fill_boxes_structure(&$boxes) { include_once(SM_PATH . 'plugins/ldapfolderinfo/include/constants.inc.php'); include_once(SM_PATH . 'plugins/ldapfolderinfo/include/functions.inc.php'); include_once(SM_PATH . 'plugins/ldapuserdata/config.php'); ldapfolderinfo_fill_boxes_structure_do($boxes); } /** * Fill the boxes structure that is calculated in the * function getBoxStructure() in templates/util_left_main.php, * in order to be fed to the template authors. * * @see ldapfolderinfo_template_getboxstructure_do() */ function ldapfolderinfo_template_getboxstructure(&$args) { include_once(SM_PATH . 'plugins/ldapfolderinfo/include/constants.inc.php'); include_once(SM_PATH . 'plugins/ldapfolderinfo/include/functions.inc.php'); include_once(SM_PATH . 'plugins/ldapuserdata/config.php'); return ldapfolderinfo_template_getboxstructure_do($args); } /** * Supply each line of left-main with the appropriate information. * * Not yet used. * * @todo Place new hook properly. */ function ldapfolderinfo_left_main_after_each_folder(&$args) { // args[1] = box // args[2] = pre // args[3] = end return; if(!empty($args[1]['Description'])) { $args[2] .= ''; $args[3] .= ''; } if(!empty($args[1]['PostAddress'])) { $args[3] .= ' ' . _("Post"); } } /** * Hooks for "left-before". * * 1) Cache the ldapfolderinfo. * 2) Call the corresponding function to display the quota root usage in the left * frame. * @return string */ function ldapfolderinfo_left_before() { global $ldapfolderinfo, $mailboxes; include_once(SM_PATH . 'plugins/ldapfolderinfo/include/constants.inc.php'); if(isset($_SESSION['ldapfolderinfo'])) { $ldapfolderinfo = $_SESSION['ldapfolderinfo']; } else { include_once(SM_PATH . 'plugins/ldapfolderinfo/include/functions.inc.php'); include_once(SM_PATH . 'plugins/ldapuserdata/config.php'); include_once(SM_PATH . 'plugins/ldapuserdata/functions.php'); $ldapfolderinfo = ldapfolderinfo_cache_ldap($mailboxes); } include_once(SM_PATH . 'plugins/ldapfolderinfo/include/quota.inc.php'); include_once(SM_PATH . 'plugins/ldapfolderinfo/include/quota_display.inc.php'); ldapfolderinfo_display_quota_usage_do(); } /** * Hooks for left-after: * (new style, SM 1.5): * * Display link to Folder information / sizes page. * * @param array $args * @return array */ function ldapfolderinfo_left_after(&$args) { return array('left_main_after' => ldapfolderinfo_terse_link()); } /** * Informational text in pagetop bar. * * @param array $args * @return array */ function ldapfolderinfo_tpl_pagetop(&$args) { bindtextdomain ('ldapfolderinfo', SM_PATH . 'plugins/ldapfolderinfo/locale'); $prev = textdomain ('ldapfolderinfo'); include_once(SM_PATH . 'plugins/ldapfolderinfo/include/pagetop.inc.php'); $args[1]->assign('current_folder_str_additional', ldapfolderinfo_pagetop_do()); bindtextdomain('squirrelmail', SM_PATH . 'locale'); textdomain('squirrelmail'); return $args; } /** * Display a verbose link on the Folders page * @return string */ function ldapfolderinfo_display_verbose_link() { global $color; bindtextdomain ('ldapfolderinfo', SM_PATH . 'plugins/ldapfolderinfo/locale'); textdomain ('ldapfolderinfo'); echo html_tag( 'table', '', 'center', '', 'width="100%" cellpadding="5" cellspacing="0" border="0"' ) . html_tag( 'tr' ) . html_tag( 'td', '', 'center', $color[4] ) . html_tag( 'table', '', 'center', '', 'width="70%" cellpadding="4" cellspacing="0" border="0"' ) . html_tag( 'tr', html_tag( 'td', '' . _("Folders Information") . '', 'center', $color[9] ) ) . html_tag( 'tr' ) . html_tag( 'td', '', 'center', $color[0] ) ; echo '

'. _("For more information about your folders, please see the"). ' '. _("Folders Information Page"). '.

'; bindtextdomain('squirrelmail', SM_PATH . 'locale'); textdomain('squirrelmail'); echo html_tag( 'tr', html_tag( 'td', ' ', 'left', $color[4] ) ) ."\n"; echo ' '; } /** * Display a terse link on the left frame, after the folder list. * @return string */ function ldapfolderinfo_terse_link() { global $color; bindtextdomain ('ldapfolderinfo', SM_PATH . 'plugins/ldapfolderinfo/locale'); textdomain ('ldapfolderinfo'); $out = '

'. '' . ' '. _("Folders Information") . '

'; bindtextdomain('squirrelmail', SM_PATH . 'locale'); textdomain('squirrelmail'); return $out; } /** * Link to reply straight to shared folder. * compose.php will handle the proper address needed, according to the value of * $mailbox that is passed. * * Extra hook: 'uoa_read_menubar_buttons.tpl_reply_links' in file * templates/default/read_menubar_buttons.tpl. * * @return void */ function ldapfolderinfo_display_reply_folder(&$args) { global $mailbox, $button_onclick; include_once(SM_PATH . 'plugins/ldapfolderinfo/include/functions.inc.php'); if(is_shared_folder($mailbox)) { echo ''; } } /** * Display menuline link * @return void */ function ldapfolderinfo_menuline() { displayInternalLink('plugins/ldapfolderinfo/subscription.php',_("Subscribe")); echo " \n"; } /** * Squirrelmail plugin information * @return array */ function ldapfolderinfo_info() { return array( 'version' => '0.1', 'requirements' => 'University of Athens LDAP-enabled Cyrus (http://email.uoa.gr) and configured LDAP server.'. 'Also, plugin useracl, and if LDAP functionality is desired, plugins directory and ldapuserdata.' ); } /** * Versioning information * @return string */ function ldapfolderinfo_version() { $info = ldapfolderinfo_info(); return $info['version']; }