[squirrelmail.git] / functions / template / message_list_util.php

<?php

/**
 * message_list_util.php
 *
 * Helper functions for message list templates.
 *
 * The following functions are utility functions for templates. Do not
 * echo output in these functions.
 *
 * @copyright 2005-2020 The SquirrelMail Project Team
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
 * @version $Id$
 * @package squirrelmail
 */


/**
 * @param array $aOrder
 * @return array
 */
function calcMessageListColumnWidth($aOrder) {
    /**
     * Width of the displayed columns
     */
    $aWidthTpl = array(
        SQM_COL_CHECK => 1,
        SQM_COL_FROM =>  25,
        SQM_COL_DATE => 15,
        SQM_COL_SUBJ  => 100,
        SQM_COL_FLAGS => 2,
        SQM_COL_SIZE  => 5,
        SQM_COL_PRIO => 1,
        SQM_COL_ATTACHMENT => 1,
        SQM_COL_INT_DATE => 15,
        SQM_COL_TO => 25,
        SQM_COL_CC => 25,
        SQM_COL_BCC => 25
    );

    /**
     * Calculate the width of the subject column based on the
     * widths of the other columns
     */
    if (isset($aOrder[SQM_COL_SUBJ])) {
        foreach($aOrder as $iCol) {
            if ($iCol != SQM_COL_SUBJ) {
                $aWidthTpl[SQM_COL_SUBJ] -= $aWidthTpl[$iCol];
            }
        }
    }
    $aWidth = array();
    foreach($aOrder as $iCol) {
        $aWidth[$iCol] = $aWidthTpl[$iCol];
    }

    $iCheckTotalWidth = $iTotalWidth = 0;
    foreach($aOrder as $iCol) { $iTotalWidth += $aWidth[$iCol];}

    $iTotalWidth = ($iTotalWidth) ? $iTotalWidth : 100; // divide by zero check. shouldn't be needed

    // correct the width to 100%
    foreach($aOrder as $iCol) {
        $aWidth[$iCol] = round( (100 / $iTotalWidth) * $aWidth[$iCol] , 0);
        $iCheckTotalWidth += $aWidth[$iCol];
    }
    if ($iCheckTotalWidth > 100) { // correction needed
       $iCol = array_search(max($aWidth),$aWidth);
       $aWidth[$iCol] -= $iCheckTotalWidth-100;
    }
    return $aWidth;
}


/**
 * Function to retrieve correct icon based on provided message flags.  This is 
 * a merge/replacement for getFlagIcon() and getFlagText() functions.
 * 
 * @param array $aFlags associative array with seen,deleted,anwered and flag keys.
 * @param string $icon_theme_path path to user's currently selected icon theme.
 * @return string $icon full HTML img tag or text icon, depending on of user prefs
 * @author Steve Brown
 */
function getFlagIcon ($aFlags, $icon_theme_path) {
    /**
     * 0  = unseen
     * 1  = seen
     * 2  = deleted
     * 3  = deleted seen
     * 4  = answered
     * 5  = answered seen
     * 6  = answered deleted
     * 7  = answered deleted seen
     * 8  = flagged
     * 9  = flagged seen
     * 10 = flagged deleted
     * 11 = flagged deleted seen
     * 12 = flagged answered
     * 13 = flagged aswered seen
     * 14 = flagged answered deleted
     * 15 = flagged anserwed deleted seen
     * ...
     * 32 = forwarded
     * 33 = forwarded seen
     * 34 = forwarded deleted
     * 35 = forwarded deleted seen
     * ...
     * 41 = flagged forwarded seen
     * 42 = flagged forwarded deleted
     * 43 = flagged forwarded deleted seen
     */

    /**
     * Use static vars to avoid initialisation of the array on each displayed row
     */
    global $nbsp;
    static $flag_icons, $flag_values;
    if (!isset($flag_icons)) {
        // This is by no means complete...
        $flag_icons = array (  
        //      Image icon name                  Text Icon   Alt/Title Text
        //      ---------------                  ---------   --------------
        array ('msg_new.png',                    $nbsp,      '('._("New").')') ,
        array ('msg_read.png',                   $nbsp,      '('._("Read").')'),
        // i18n: "D" is short for "Deleted". Make sure that two icon strings aren't translated to the same character (only in 1.5).
        array ('msg_new_deleted.png',            _("D"),     '('._("Deleted").')'),
        array ('msg_read_deleted.png',           _("D"),     '('._("Deleted").')'),
        // i18n: "A" is short for "Answered". Make sure that two icon strings aren't translated to the same character (only in 1.5).
        array ('msg_new_reply.png',              _("A"),     '('._("Answered").')'),
        array ('msg_read_reply.png',             _("A"),     '('._("Answered").')'),
        array ('msg_new_deleted_reply.png',      _("D"),     '('._("Answered").')'),
        array ('msg_read_deleted_reply.png',     _("D"),     '('._("Answered").')'),
        // i18n: "F" is short for "Flagged". Make sure that two icon strings aren't translated to the same character (only in 1.5).
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        // i18n: "O" is short for "Forwarded". Make sure that two icon strings aren't translated to the same character (only in 1.5).
        array ('msg_new_forwarded.png',          _("O"),     '('._("Forwarded").')'),
        array ('msg_read_forwarded.png',         _("O"),     '('._("Forwarded").')'),
        array ('msg_new_deleted_forwarded.png',  _("D"),     '('._("Forwarded").')'),
        array ('msg_read_deleted_forwarded.png', _("D"),     '('._("Forwarded").')'),
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        FALSE,
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        array ('flagged.png',                    _("F"),     '('._("Flagged").')'),
        );
        
        $flag_values = array('seen'      => 1,
                             'deleted'   => 2,
                             'answered'  => 4,
                             'flagged'   => 8,
                             'draft'     => 16,
                             'forwarded' => 32);
    }

    /**
     * The flags entry contain all items displayed in the flag column.
     */
    $icon = '';

    $index = 0;
    foreach ($aFlags as $flag => $flagvalue) {
         switch ($flag) {
            case 'deleted':
            case 'answered':
            case 'forwarded':
            case 'seen':
            case 'flagged': if ($flagvalue) $index += $flag_values[$flag]; break;
            default: break;
        }
    }
    
    if (!empty($flag_icons[$index])) {
        $data = $flag_icons[$index];
    } else {
//FIXME: previously this default was set to the last value of the $flag_icons array (when it was index 15 - flagged anserwed deleted seen) but I don't understand why... am changing it to flagged (index 15 just shows (only) the flag icon anyway)
        $data = $flag_icons[8]; // default to just flagged
    }

    $icon = getIcon($icon_theme_path, $data[0], $data[1], $data[2]);
    return $icon;
}


/**
 * Function to retrieve correct priority icon based on user prefs
 * 
 * @param integer $priority priority value of message
 * @param string $icon_theme_path path to user's currently selected icon theme.
 * @return string $icon full HTML img tag or text icon, depending on of user prefs
 * @author Steve Brown
 */
function getPriorityIcon ($priority, $icon_theme_path) {
    $icon = '';

    switch ($priority) {
        case 1:
        case 2:
            $icon = getIcon($icon_theme_path, 'prio_high.png', create_span('!', 'high_priority'), _("High priority"));
            break;
        case 5:
            $icon = getIcon($icon_theme_path, 'prio_low.png', create_span('&#8595;', 'low_priority'), _("Low priority"));
            break;
        default:
            $icon = getIcon($icon_theme_path, 'transparent.png', '', _("Normal priority"), 5);
            break;
    }

    return $icon;
}


/**
 * Function to retrieve correct attchment icon based on user prefs
 * 
 * @param boolean $attach TRUE if the message has an attachment
 * @param string $icon_theme_path path to user's currently selected icon theme.
 * @return string $icon full HTML img tag or text icon, depending on of user prefs
 * @author Steve Brown
 */
function getAttachmentIcon ($attach, $icon_theme_path) {
    $icon = '';
    
    $icon_file = $attach ? 'attach.png' : 'transparent.png';
    $alt_text = $attach ? _("Attachment") : _("No attachment");
    $text = $attach ? '+' : '';
    $icon = getIcon($icon_theme_path, $icon_file, $text, $alt_text);

    return $icon;
}
Commit	Line	Data
bb1e750e	1	<?php
	2
	3	/**
	4	* message_list_util.php
	5	*
	6	* Helper functions for message list templates.
	7	*
	8	* The following functions are utility functions for templates. Do not
	9	* echo output in these functions.
	10	*
c4faef33	11	* @copyright 2005-2020 The SquirrelMail Project Team
bb1e750e	12	* @license http://opensource.org/licenses/gpl-license.php GNU Public License
	13	* @version $Id$
	14	* @package squirrelmail
	15	*/
	16
	17
	18	/**
	19	* @param array $aOrder
	20	* @return array
	21	*/
	22	function calcMessageListColumnWidth($aOrder) {
	23	/**
	24	* Width of the displayed columns
	25	*/
	26	$aWidthTpl = array(
	27	SQM_COL_CHECK => 1,
	28	SQM_COL_FROM => 25,
4e0fd0cc	29	SQM_COL_DATE => 15,
bb1e750e	30	SQM_COL_SUBJ => 100,
	31	SQM_COL_FLAGS => 2,
	32	SQM_COL_SIZE => 5,
	33	SQM_COL_PRIO => 1,
	34	SQM_COL_ATTACHMENT => 1,
4e0fd0cc	35	SQM_COL_INT_DATE => 15,
bb1e750e	36	SQM_COL_TO => 25,
	37	SQM_COL_CC => 25,
	38	SQM_COL_BCC => 25
	39	);
	40
	41	/**
	42	* Calculate the width of the subject column based on the
	43	* widths of the other columns
	44	*/
	45	if (isset($aOrder[SQM_COL_SUBJ])) {
	46	foreach($aOrder as $iCol) {
	47	if ($iCol != SQM_COL_SUBJ) {
	48	$aWidthTpl[SQM_COL_SUBJ] -= $aWidthTpl[$iCol];
	49	}
	50	}
	51	}
	52	$aWidth = array();
	53	foreach($aOrder as $iCol) {
	54	$aWidth[$iCol] = $aWidthTpl[$iCol];
	55	}
	56
	57	$iCheckTotalWidth = $iTotalWidth = 0;
	58	foreach($aOrder as $iCol) { $iTotalWidth += $aWidth[$iCol];}
	59
	60	$iTotalWidth = ($iTotalWidth) ? $iTotalWidth : 100; // divide by zero check. shouldn't be needed
	61
	62	// correct the width to 100%
	63	foreach($aOrder as $iCol) {
	64	$aWidth[$iCol] = round( (100 / $iTotalWidth) * $aWidth[$iCol] , 0);
	65	$iCheckTotalWidth += $aWidth[$iCol];
	66	}
	67	if ($iCheckTotalWidth > 100) { // correction needed
	68	$iCol = array_search(max($aWidth),$aWidth);
	69	$aWidth[$iCol] -= $iCheckTotalWidth-100;
	70	}
	71	return $aWidth;
	72	}
	73
	74
	75	/**
	76	* Function to retrieve correct icon based on provided message flags. This is
	77	* a merge/replacement for getFlagIcon() and getFlagText() functions.
	78	*
	79	* @param array $aFlags associative array with seen,deleted,anwered and flag keys.
	80	* @param string $icon_theme_path path to user's currently selected icon theme.
	81	* @return string $icon full HTML img tag or text icon, depending on of user prefs
	82	* @author Steve Brown
	83	*/
	84	function getFlagIcon ($aFlags, $icon_theme_path) {
	85	/**
	86	* 0 = unseen
	87	* 1 = seen
	88	* 2 = deleted
	89	* 3 = deleted seen
	90	* 4 = answered
	91	* 5 = answered seen
	92	* 6 = answered deleted
	93	* 7 = answered deleted seen
	94	* 8 = flagged
	95	* 9 = flagged seen
	96	* 10 = flagged deleted
	97	* 11 = flagged deleted seen
	98	* 12 = flagged answered
	99	* 13 = flagged aswered seen
100	* 14 = flagged answered deleted
101	* 15 = flagged anserwed deleted seen
1a753239	102	* ...
	103	* 32 = forwarded
	104	* 33 = forwarded seen
	105	* 34 = forwarded deleted
	106	* 35 = forwarded deleted seen
	107	* ...
	108	* 41 = flagged forwarded seen
	109	* 42 = flagged forwarded deleted
	110	* 43 = flagged forwarded deleted seen
bb1e750e	111	*/
	112
	113	/**
	114	* Use static vars to avoid initialisation of the array on each displayed row
	115	*/
1a753239	116	global $nbsp;
bb1e750e	117	static $flag_icons, $flag_values;
	118	if (!isset($flag_icons)) {
	119	// This is by no means complete...
1a753239	120	$flag_icons = array (
	121	// Image icon name Text Icon Alt/Title Text
	122	// --------------- --------- --------------
	123	array ('msg_new.png', $nbsp, '('._("New").')') ,
	124	array ('msg_read.png', $nbsp, '('._("Read").')'),
93a29a5d	125	// i18n: "D" is short for "Deleted". Make sure that two icon strings aren't translated to the same character (only in 1.5).
1a753239	126	array ('msg_new_deleted.png', _("D"), '('._("Deleted").')'),
1a753239	127	array ('msg_read_deleted.png', _("D"), '('._("Deleted").')'),
93a29a5d	128	// i18n: "A" is short for "Answered". Make sure that two icon strings aren't translated to the same character (only in 1.5).
1a753239	129	array ('msg_new_reply.png', _("A"), '('._("Answered").')'),
	130	array ('msg_read_reply.png', _("A"), '('._("Answered").')'),
	131	array ('msg_new_deleted_reply.png', _("D"), '('._("Answered").')'),
	132	array ('msg_read_deleted_reply.png', _("D"), '('._("Answered").')'),
93a29a5d	133	// i18n: "F" is short for "Flagged". Make sure that two icon strings aren't translated to the same character (only in 1.5).
1a753239	134	array ('flagged.png', _("F"), '('._("Flagged").')'),
	135	array ('flagged.png', _("F"), '('._("Flagged").')'),
	136	array ('flagged.png', _("F"), '('._("Flagged").')'),
	137	array ('flagged.png', _("F"), '('._("Flagged").')'),
	138	array ('flagged.png', _("F"), '('._("Flagged").')'),
	139	array ('flagged.png', _("F"), '('._("Flagged").')'),
	140	array ('flagged.png', _("F"), '('._("Flagged").')'),
	141	array ('flagged.png', _("F"), '('._("Flagged").')'),
	142	FALSE,
	143	FALSE,
	144	FALSE,
	145	FALSE,
	146	FALSE,
	147	FALSE,
	148	FALSE,
	149	FALSE,
	150	FALSE,
	151	FALSE,
	152	FALSE,
	153	FALSE,
	154	FALSE,
	155	FALSE,
	156	FALSE,
	157	FALSE,
93a29a5d	158	// i18n: "O" is short for "Forwarded". Make sure that two icon strings aren't translated to the same character (only in 1.5).
1a753239	159	array ('msg_new_forwarded.png', _("O"), '('._("Forwarded").')'),
	160	array ('msg_read_forwarded.png', _("O"), '('._("Forwarded").')'),
	161	array ('msg_new_deleted_forwarded.png', _("D"), '('._("Forwarded").')'),
	162	array ('msg_read_deleted_forwarded.png', _("D"), '('._("Forwarded").')'),
	163	FALSE,
	164	FALSE,
	165	FALSE,
	166	FALSE,
	167	FALSE,
	168	array ('flagged.png', _("F"), '('._("Flagged").')'),
	169	array ('flagged.png', _("F"), '('._("Flagged").')'),
	170	array ('flagged.png', _("F"), '('._("Flagged").')'),
	171	);
bb1e750e	172
1a753239	173	$flag_values = array('seen' => 1,
	174	'deleted' => 2,
	175	'answered' => 4,
	176	'flagged' => 8,
	177	'draft' => 16,
	178	'forwarded' => 32);
bb1e750e	179	}
	180
	181	/**
	182	* The flags entry contain all items displayed in the flag column.
	183	*/
	184	$icon = '';
	185
	186	$index = 0;
	187	foreach ($aFlags as $flag => $flagvalue) {
	188	switch ($flag) {
	189	case 'deleted':
	190	case 'answered':
1a753239	191	case 'forwarded':
bb1e750e	192	case 'seen':
	193	case 'flagged': if ($flagvalue) $index += $flag_values[$flag]; break;
	194	default: break;
	195	}
	196	}
	197
1a753239	198	if (!empty($flag_icons[$index])) {
bb1e750e	199	$data = $flag_icons[$index];
bb1e750e	200	} else {
1a753239	201	//FIXME: previously this default was set to the last value of the $flag_icons array (when it was index 15 - flagged anserwed deleted seen) but I don't understand why... am changing it to flagged (index 15 just shows (only) the flag icon anyway)
1a753239	202	$data = $flag_icons[8]; // default to just flagged
bb1e750e	203	}
	204
	205	$icon = getIcon($icon_theme_path, $data[0], $data[1], $data[2]);
	206	return $icon;
	207	}
	208
	209
	210	/**
	211	* Function to retrieve correct priority icon based on user prefs
	212	*
	213	* @param integer $priority priority value of message
	214	* @param string $icon_theme_path path to user's currently selected icon theme.
	215	* @return string $icon full HTML img tag or text icon, depending on of user prefs
	216	* @author Steve Brown
	217	*/
	218	function getPriorityIcon ($priority, $icon_theme_path) {
	219	$icon = '';
	220
	221	switch ($priority) {
	222	case 1:
	223	case 2:
61a878cc	224	$icon = getIcon($icon_theme_path, 'prio_high.png', create_span('!', 'high_priority'), _("High priority"));
bb1e750e	225	break;
bb1e750e	226	case 5:
61a878cc	227	$icon = getIcon($icon_theme_path, 'prio_low.png', create_span('↓', 'low_priority'), _("Low priority"));
bb1e750e	228	break;
bb1e750e	229	default:
61a878cc	230	$icon = getIcon($icon_theme_path, 'transparent.png', '', _("Normal priority"), 5);
bb1e750e	231	break;
bb1e750e	232	}
bb1e750e	233
	234	return $icon;
	235	}
	236
	237
	238	/**
	239	* Function to retrieve correct attchment icon based on user prefs
	240	*
	241	* @param boolean $attach TRUE if the message has an attachment
	242	* @param string $icon_theme_path path to user's currently selected icon theme.
	243	* @return string $icon full HTML img tag or text icon, depending on of user prefs
	244	* @author Steve Brown
	245	*/
	246	function getAttachmentIcon ($attach, $icon_theme_path) {
	247	$icon = '';
	248
	249	$icon_file = $attach ? 'attach.png' : 'transparent.png';
61a878cc	250	$alt_text = $attach ? _("Attachment") : _("No attachment");
bb1e750e	251	$text = $attach ? '+' : '';
61a878cc	252	$icon = getIcon($icon_theme_path, $icon_file, $text, $alt_text);
bb1e750e	253
	254	return $icon;
	255	}