[squirrelmail.git] / plugins / sent_subfolders / setup.php

<?php

/**
 * setup.php -- Sent Subfolders Setup File
 *
 * Copyright (c) 1999-2002 The SquirrelMail Project Team
 * Licensed under the GNU GPL. For full terms see the file COPYING.
 *
 * This is a standard Squirrelmail-1.2 API for plugins.
 *
 * $Id$
 */

define('SMPREF_SENT_SUBFOLDERS_DISABLED',  0);
define('SMPREF_SENT_SUBFOLDERS_YEARLY',    1);
define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
define('SMPREF_SENT_SUBFOLDERS_MONTHLY',   3);
define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');

function squirrelmail_plugin_init_sent_subfolders() {
    /* Standard initialization API. */
    global $squirrelmail_plugin_hooks;

    /* The hooks to make the sent subfolders display correctly. */
    $squirrelmail_plugin_hooks
    ['check_handleAsSent_result']['sent_subfolders'] =
        'sent_subfolders_check_handleAsSent';

    /* The hooks to automatically update sent subfolders. */
    $squirrelmail_plugin_hooks
    ['left_main_before']['sent_subfolders'] =
        'sent_subfolders_update_sentfolder';

    $squirrelmail_plugin_hooks
    ['compose_send']['sent_subfolders'] =
        'sent_subfolders_update_sentfolder';

    /* The hook to load the sent subfolders prefs. */
    $squirrelmail_plugin_hooks
    ['loading_prefs']['sent_subfolders'] =
        'sent_subfolders_load_prefs';

    /* The hooks to handle sent subfolders options. */
    $squirrelmail_plugin_hooks
    ['optpage_loadhook_folder']['sent_subfolders'] =
        'sent_subfolders_optpage_loadhook_folders';
}

function sent_subfolders_check_handleAsSent() {
    global $handleAsSent_result, $sent_subfolders_base;
    global $use_sent_subfolders;
    $sent_subfolders_base = 'INBOX.Sent';
    $args = func_get_arg(0);

    /* Only check the folder string if we have been passed a mailbox. */
    if ($use_sent_subfolders && (count($args) > 1)) {
        /* Chop up the folder strings as needed. */
        $base_str = $sent_subfolders_base . $delimiter;
        $mbox_str = substr($args[1], 0, strlen($base_str));

        /* Perform the comparison. */
        $handleAsSent_result =
            ( $handleAsSent_result
            || ($base_str == $mbox_str)
            || ($sent_subfolders_base == $args[1])
            );
    }
}

function sent_subfolders_load_prefs() {
    global $use_sent_subfolders;
    global $sent_subfolders_setting, $sent_subfolders_base;

    $use_sent_subfolders = getPref
    ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);

    $sent_subfolders_setting = getPref
    ($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED);

    $sent_subfolders_base = getPref
    ($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE);
}

function sent_subfolders_optpage_loadhook_folders() {
    global $optpage_data, $username, $key, $imapServerAddress, $imapPort;

    /* Get some imap data we need later. */
    $imapConnection =
        sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
    $boxes = sqimap_mailbox_list($imapConnection);
    sqimap_logout($imapConnection);

    /* Load the Sent Subfolder Options into an array. */
    $optgrp = _("Sent Subfolders Options");
    $optvals = array();

    $optvals[] = array(
        'name'    => 'sent_subfolders_setting',
        'caption' => _("Use Sent Subfolders"),
        'type'    => SMOPT_TYPE_STRLIST,
        'refresh' => SMOPT_REFRESH_FOLDERLIST,
        'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED  => _("Disabled"),
                        SMPREF_SENT_SUBFOLDERS_MONTHLY   => _("Monthly"),
                        SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
                        SMPREF_SENT_SUBFOLDERS_YEARLY    => _("Yearly")),
        'save'    => 'save_option_sent_subfolders_setting'
    );

    $sent_subfolders_base_values = array();
    foreach ($boxes as $folder) {
        if (strtolower($folder['unformatted']) != 'inbox') {
            $real_value = $folder['unformatted-dm'];
            $disp_value = str_replace(' ', '&nbsp;', $folder['formatted']);
            $sent_subfolders_base_values[$real_value] = $disp_value;
        }
    }

    $optvals[] = array(
        'name'    => 'sent_subfolders_base',
        'caption' => _("Base Sent Folder"),
        'type'    => SMOPT_TYPE_STRLIST,
        'refresh' => SMOPT_REFRESH_FOLDERLIST,
        'posvals' => $sent_subfolders_base_values
    );

    /* Add our option data to the global array. */
    $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp;
    $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals;
}

function save_option_sent_subfolders_setting($option) {
    global $data_dir, $username, $use_sent_subfolders;

    /* Set use_sent_subfolders as either on or off. */
    if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
        setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
    } else {
        setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
        setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
    }

    /* Now just save the option as normal. */
    save_option($option);
}

function sent_subfolders_update_sentfolder() {
    global $sent_folder, $delimiter, $auto_create_special, $auto_create_done;
    global $sent_subfolders_base, $sent_subfolders_setting;
    global $username, $data_dir, $key, $imapServerAddress, $imapPort;
    global $use_sent_subfolders, $move_to_sent, $imap_server_type;

    if ($use_sent_subfolders || $move_to_sent) {
        $year = date('Y');
        $month = date('m');
        $quarter = sent_subfolder_getQuarter($month);

        /*
            Regarding the structure we've got three main possibilities.
            One sent holder. level 0.
            Multiple year holders with messages in it. level 1.
            Multiple year folders with holders in it. level 2.
        */
        switch ($sent_subfolders_setting) {
        case SMPREF_SENT_SUBFOLDERS_YEARLY:
            $level = 1;
            $sent_subfolder = $sent_subfolders_base
                            . $year;
            $year_folder = $sent_subfolder;
            break;
        case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
            $level = 2;
            $sent_subfolder = $sent_subfolders_base
                            . $year
                            . $delimiter . $quarter;
            $year_folder = $sent_subfolders_base
                            . $year;
            break;
        case SMPREF_SENT_SUBFOLDERS_MONTHLY:
            $level = 2;
            $sent_subfolder = $sent_subfolders_base
                            . $year
                            . $delimiter . $month;
            $year_folder = $sent_subfolders_base . $year;
            break;
        case SMPREF_SENT_SUBFOLDERS_DISABLED:
        default:
            $level = 0;
            $sent_subfolder = $sent_folder;
            $year_folder = $sent_folder;
        }

        if( $sent_subfolders_setting <> SMPREF_SENT_SUBFOLDERS_DISABLED && 
            $imap_server_type <> 'uw' ) {
            $year_folder .= $delimiter;            
        }

        /* If this folder is NOT the current sent folder, update stuff. */
        if ($sent_subfolder != $sent_folder) {
            /* First, update the sent folder. */

            setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
            setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
            $sent_folder = $sent_subfolder;
            $move_to_sent = SMPREF_ON;

            /* Auto-create folders, if they do not yet exist. */
            if ($sent_folder != 'none') {
                /* Create the imap connection. */
                $ic = sqimap_login
                ($username, $key, $imapServerAddress, $imapPort, 10);

                /* Auto-create the year folder, if it does not yet exist. */
                if (!sqimap_mailbox_exists($ic, $year_folder)) {
                    sqimap_mailbox_create($ic, $year_folder, ($level==1)?'':'noselect');
                } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
                    sqimap_subscribe($ic, $year_folder);
                }

                /* Auto-create the subfolder, if it does not yet exist. */
                if (!sqimap_mailbox_exists($ic, $sent_folder)) {
                    sqimap_mailbox_create($ic, $sent_folder, '');
                } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
                    sqimap_subscribe($ic, $sent_subfolder);
                }

                /* Close the imap connection. */
                sqimap_logout($ic);
            }
        }
    }
}

function sent_subfolder_getQuarter($month) {
    switch ($month) {
        case '01':
        case '02':
        case '03':
            $result = '1';
            break;
        case '04':
        case '05':
        case '06':
            $result = '2';
            break;
        case '07':
        case '08':
        case '09':
            $result = '3';
            break;
        case '10':
        case '11':
        case '12':
            $result = '4';
            break;
        default:
            $result = 'ERR';
    }

    /* Return the current quarter. */
    return ('Q' . $result);
}

?>
Commit	Line	Data
a3439b27	1	<?php
	2
	3	/**
	4	* setup.php -- Sent Subfolders Setup File
	5	*
	6	* Copyright (c) 1999-2002 The SquirrelMail Project Team
	7	* Licensed under the GNU GPL. For full terms see the file COPYING.
	8	*
	9	* This is a standard Squirrelmail-1.2 API for plugins.
	10	*
	11	* $Id$
	12	*/
	13
	14	define('SMPREF_SENT_SUBFOLDERS_DISABLED', 0);
	15	define('SMPREF_SENT_SUBFOLDERS_YEARLY', 1);
	16	define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
	17	define('SMPREF_SENT_SUBFOLDERS_MONTHLY', 3);
	18	define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
	19
	20	function squirrelmail_plugin_init_sent_subfolders() {
	21	/* Standard initialization API. */
	22	global $squirrelmail_plugin_hooks;
	23
	24	/* The hooks to make the sent subfolders display correctly. */
	25	$squirrelmail_plugin_hooks
	26	['check_handleAsSent_result']['sent_subfolders'] =
	27	'sent_subfolders_check_handleAsSent';
	28
	29	/* The hooks to automatically update sent subfolders. */
	30	$squirrelmail_plugin_hooks
	31	['left_main_before']['sent_subfolders'] =
	32	'sent_subfolders_update_sentfolder';
	33
	34	$squirrelmail_plugin_hooks
	35	['compose_send']['sent_subfolders'] =
	36	'sent_subfolders_update_sentfolder';
	37
	38	/* The hook to load the sent subfolders prefs. */
	39	$squirrelmail_plugin_hooks
	40	['loading_prefs']['sent_subfolders'] =
	41	'sent_subfolders_load_prefs';
	42
	43	/* The hooks to handle sent subfolders options. */
	44	$squirrelmail_plugin_hooks
	45	['optpage_loadhook_folder']['sent_subfolders'] =
	46	'sent_subfolders_optpage_loadhook_folders';
	47	}
	48
	49	function sent_subfolders_check_handleAsSent() {
	50	global $handleAsSent_result, $sent_subfolders_base;
	51	global $use_sent_subfolders;
	52	$sent_subfolders_base = 'INBOX.Sent';
	53	$args = func_get_arg(0);
	54
	55	/* Only check the folder string if we have been passed a mailbox. */
	56	if ($use_sent_subfolders && (count($args) > 1)) {
	57	/* Chop up the folder strings as needed. */
	58	$base_str = $sent_subfolders_base . $delimiter;
	59	$mbox_str = substr($args[1], 0, strlen($base_str));
	60
	61	/* Perform the comparison. */
	62	$handleAsSent_result =
	63	( $handleAsSent_result
d79e01f5	64	\|\| ($base_str == $mbox_str)
d79e01f5	65	\|\| ($sent_subfolders_base == $args[1])
a3439b27	66	);
	67	}
	68	}
	69
	70	function sent_subfolders_load_prefs() {
	71	global $use_sent_subfolders;
	72	global $sent_subfolders_setting, $sent_subfolders_base;
	73
	74	$use_sent_subfolders = getPref
	75	($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
d79e01f5	76
a3439b27	77	$sent_subfolders_setting = getPref
	78	($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED);
	79
	80	$sent_subfolders_base = getPref
	81	($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE);
	82	}
	83
	84	function sent_subfolders_optpage_loadhook_folders() {
	85	global $optpage_data, $username, $key, $imapServerAddress, $imapPort;
	86
	87	/* Get some imap data we need later. */
	88	$imapConnection =
	89	sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
	90	$boxes = sqimap_mailbox_list($imapConnection);
	91	sqimap_logout($imapConnection);
	92
	93	/* Load the Sent Subfolder Options into an array. */
	94	$optgrp = _("Sent Subfolders Options");
	95	$optvals = array();
	96
	97	$optvals[] = array(
	98	'name' => 'sent_subfolders_setting',
	99	'caption' => _("Use Sent Subfolders"),
	100	'type' => SMOPT_TYPE_STRLIST,
	101	'refresh' => SMOPT_REFRESH_FOLDERLIST,
	102	'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED => _("Disabled"),
d79e01f5	103	SMPREF_SENT_SUBFOLDERS_MONTHLY => _("Monthly"),
	104	SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
	105	SMPREF_SENT_SUBFOLDERS_YEARLY => _("Yearly")),
a3439b27	106	'save' => 'save_option_sent_subfolders_setting'
	107	);
	108
	109	$sent_subfolders_base_values = array();
	110	foreach ($boxes as $folder) {
	111	if (strtolower($folder['unformatted']) != 'inbox') {
	112	$real_value = $folder['unformatted-dm'];
	113	$disp_value = str_replace(' ', ' ', $folder['formatted']);
	114	$sent_subfolders_base_values[$real_value] = $disp_value;
	115	}
	116	}
	117
	118	$optvals[] = array(
	119	'name' => 'sent_subfolders_base',
	120	'caption' => _("Base Sent Folder"),
	121	'type' => SMOPT_TYPE_STRLIST,
	122	'refresh' => SMOPT_REFRESH_FOLDERLIST,
	123	'posvals' => $sent_subfolders_base_values
	124	);
	125
	126	/* Add our option data to the global array. */
	127	$optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp;
	128	$optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals;
	129	}
	130
	131	function save_option_sent_subfolders_setting($option) {
	132	global $data_dir, $username, $use_sent_subfolders;
	133
	134	/* Set use_sent_subfolders as either on or off. */
	135	if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
	136	setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
	137	} else {
	138	setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
	139	setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
	140	}
	141
	142	/* Now just save the option as normal. */
	143	save_option($option);
	144	}
	145
	146	function sent_subfolders_update_sentfolder() {
	147	global $sent_folder, $delimiter, $auto_create_special, $auto_create_done;
	148	global $sent_subfolders_base, $sent_subfolders_setting;
	149	global $username, $data_dir, $key, $imapServerAddress, $imapPort;
64727b20	150	global $use_sent_subfolders, $move_to_sent, $imap_server_type;
d79e01f5	151
1c52ba77	152	if ($use_sent_subfolders \|\| $move_to_sent) {
a3439b27	153	$year = date('Y');
	154	$month = date('m');
	155	$quarter = sent_subfolder_getQuarter($month);
	156
1c52ba77	157	/*
	158	Regarding the structure we've got three main possibilities.
	159	One sent holder. level 0.
	160	Multiple year holders with messages in it. level 1.
	161	Multiple year folders with holders in it. level 2.
	162	*/
a3439b27	163	switch ($sent_subfolders_setting) {
1c52ba77	164	case SMPREF_SENT_SUBFOLDERS_YEARLY:
	165	$level = 1;
	166	$sent_subfolder = $sent_subfolders_base
	167	. $year;
	168	$year_folder = $sent_subfolder;
	169	break;
	170	case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
	171	$level = 2;
	172	$sent_subfolder = $sent_subfolders_base
	173	. $year
	174	. $delimiter . $quarter;
	175	$year_folder = $sent_subfolders_base
a3add160	176	. $year;
1c52ba77	177	break;
	178	case SMPREF_SENT_SUBFOLDERS_MONTHLY:
	179	$level = 2;
	180	$sent_subfolder = $sent_subfolders_base
	181	. $year
	182	. $delimiter . $month;
a3add160	183	$year_folder = $sent_subfolders_base . $year;
1c52ba77	184	break;
	185	case SMPREF_SENT_SUBFOLDERS_DISABLED:
	186	default:
	187	$level = 0;
	188	$sent_subfolder = $sent_folder;
	189	$year_folder = $sent_folder;
a3439b27	190	}
a3439b27	191
64727b20	192	if( $sent_subfolders_setting <> SMPREF_SENT_SUBFOLDERS_DISABLED &&
	193	$imap_server_type <> 'uw' ) {
	194	$year_folder .= $delimiter;
	195	}
	196
a3439b27	197	/* If this folder is NOT the current sent folder, update stuff. */
	198	if ($sent_subfolder != $sent_folder) {
	199	/* First, update the sent folder. */
1c52ba77	200
a3439b27	201	setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
	202	setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
	203	$sent_folder = $sent_subfolder;
	204	$move_to_sent = SMPREF_ON;
	205
	206	/* Auto-create folders, if they do not yet exist. */
	207	if ($sent_folder != 'none') {
	208	/* Create the imap connection. */
	209	$ic = sqimap_login
	210	($username, $key, $imapServerAddress, $imapPort, 10);
d79e01f5	211
a3439b27	212	/* Auto-create the year folder, if it does not yet exist. */
a3439b27	213	if (!sqimap_mailbox_exists($ic, $year_folder)) {
1c52ba77	214	sqimap_mailbox_create($ic, $year_folder, ($level==1)?'':'noselect');
a3439b27	215	} else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
	216	sqimap_subscribe($ic, $year_folder);
	217	}
d79e01f5	218
a3439b27	219	/* Auto-create the subfolder, if it does not yet exist. */
	220	if (!sqimap_mailbox_exists($ic, $sent_folder)) {
	221	sqimap_mailbox_create($ic, $sent_folder, '');
1c52ba77	222	} else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
1c52ba77	223	sqimap_subscribe($ic, $sent_subfolder);
a3439b27	224	}
	225
	226	/* Close the imap connection. */
	227	sqimap_logout($ic);
	228	}
	229	}
	230	}
	231	}
	232
	233	function sent_subfolder_getQuarter($month) {
	234	switch ($month) {
	235	case '01':
	236	case '02':
d79e01f5	237	case '03':
	238	$result = '1';
	239	break;
a3439b27	240	case '04':
a3439b27	241	case '05':
d79e01f5	242	case '06':
	243	$result = '2';
	244	break;
a3439b27	245	case '07':
a3439b27	246	case '08':
d79e01f5	247	case '09':
	248	$result = '3';
	249	break;
a3439b27	250	case '10':
a3439b27	251	case '11':
d79e01f5	252	case '12':
	253	$result = '4';
	254	break;
	255	default:
	256	$result = 'ERR';
a3439b27	257	}
	258
	259	/* Return the current quarter. */
	260	return ('Q' . $result);
	261	}
	262
	263	?>