Source for file setup.php

Documentation is available at setup.php

  1. <?php
  2.  
  3. /**
  4.  * setup.php -- Sent Subfolders Setup File
  5.  *
  6.  * Copyright (c) 1999-2020 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: setup.php 14840 2020-01-07 07:42:38Z pdontthink $
  12.  * @package plugins
  13.  * @subpackage sent_subfolders
  14.  */
  15.  
  16. /** 
  17.  * 
  18.  */
  19. define('SMPREF_SENT_SUBFOLDERS_DISABLED',  0);
  20. define('SMPREF_SENT_SUBFOLDERS_YEARLY',    1);
  21. define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2);
  22. define('SMPREF_SENT_SUBFOLDERS_MONTHLY',   3);
  23. define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS');
  24.  
  25. /**
  26.  * Adds plugin to squirrelmail hooks
  27.  */
  28. function squirrelmail_plugin_init_sent_subfolders() {
  29.     /* Standard initialization API. */
  30.     global $squirrelmail_plugin_hooks;
  31.  
  32.     /* The hooks to make the sent subfolders display correctly. */
  33.     $squirrelmail_plugin_hooks
  34.     ['check_handleAsSent_result']['sent_subfolders'] =
  35.         'sent_subfolders_check_handleAsSent';
  36.  
  37.     /* The hooks to automatically update sent subfolders. */
  38.     $squirrelmail_plugin_hooks
  39.     ['left_main_before']['sent_subfolders'] =
  40.         'sent_subfolders_update_sentfolder';
  41.  
  42.     $squirrelmail_plugin_hooks
  43.     ['compose_send']['sent_subfolders'] =
  44.         'sent_subfolders_update_sentfolder';
  45.  
  46.     /* The hook to load the sent subfolders prefs. */
  47.     $squirrelmail_plugin_hooks
  48.     ['loading_prefs']['sent_subfolders'] =
  49.         'sent_subfolders_load_prefs';
  50.  
  51.     /* The hooks to handle sent subfolders options. */
  52.     $squirrelmail_plugin_hooks
  53.     ['optpage_loadhook_folder']['sent_subfolders'] =
  54.         'sent_subfolders_optpage_loadhook_folders';
  55.  
  56.     /* mark base sent folder as special mailbox */
  57.     $squirrelmail_plugin_hooks
  58.     ['special_mailbox']['sent_subfolders'] = 
  59.     'sent_subfolders_special_mailbox';
  60. }
  61.  
  62. function sent_subfolders_check_handleAsSent() {
  63.     global $handleAsSent_result, $sent_subfolders_base,
  64.            $use_sent_subfolders;
  65.  
  66.     $args = func_get_arg(0);
  67.     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
  68.  
  69.     /* Only check the folder string if we have been passed a mailbox. */
  70.     if ($use_sent_subfolders && (count($args) > 1)) {
  71.         /* Chop up the folder strings as needed. */
  72.         $base_str = $sent_subfolders_base . $delimiter;
  73.         $mbox_str = substr($args[1], 0, strlen($base_str));
  74.  
  75.         /* Perform the comparison. */
  76.         $handleAsSent_result =
  77.             ( $handleAsSent_result
  78.             || ($base_str == $mbox_str)
  79.             || ($sent_subfolders_base == $args[1])
  80.             );
  81.     }
  82. }
  83.  
  84. /**
  85.  * Loads sent_subfolders settings
  86.  */
  87. function sent_subfolders_load_prefs() {
  88.     global $use_sent_subfolders, $data_dir, $username, $sent_folder,
  89.            $sent_subfolders_setting, $sent_subfolders_base;
  90.  
  91.     $use_sent_subfolders = getPref
  92.     ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
  93.  
  94.     $sent_subfolders_setting = getPref
  95.     ($data_dir, $username, 'sent_subfolders_setting', SMPREF_SENT_SUBFOLDERS_DISABLED);
  96.  
  97.     $sent_subfolders_base = getPref
  98.     ($data_dir, $username, 'sent_subfolders_base', $sent_folder);
  99. }
  100.  
  101. /**
  102.  * Adds sent_subfolders options in folder preferences
  103.  */
  104. function sent_subfolders_optpage_loadhook_folders() {
  105.     global $optpage_data, $imapServerAddress, $imapPort, $imap_stream_options;
  106.  
  107.     sqgetGlobalVar('username', $username, SQ_SESSION);
  108.     sqgetGlobalVar('key', $key, SQ_COOKIE);
  109.  
  110.     /* Get some imap data we need later. */
  111.     $imapConnection =
  112.         sqimap_login($username, $key, $imapServerAddress, $imapPort, 0, $imap_stream_options);
  113.     $boxes = sqimap_mailbox_list($imapConnection);
  114.     sqimap_logout($imapConnection);
  115.  
  116.     /* Load the Sent Subfolder Options into an array. */
  117.     $optgrp = _("Sent Subfolders Options");
  118.     $optvals = array();
  119.  
  120.     $optvals[] = array(
  121.         'name'    => 'sent_subfolders_setting',
  122.         'caption' => _("Use Sent Subfolders"),
  123.         'type'    => SMOPT_TYPE_STRLIST,
  124.         'refresh' => SMOPT_REFRESH_FOLDERLIST,
  125.         'posvals' => array(SMPREF_SENT_SUBFOLDERS_DISABLED  => _("Disabled"),
  126.                         SMPREF_SENT_SUBFOLDERS_MONTHLY   => _("Monthly"),
  127.                         SMPREF_SENT_SUBFOLDERS_QUARTERLY => _("Quarterly"),
  128.                         SMPREF_SENT_SUBFOLDERS_YEARLY    => _("Yearly")),
  129.         'save'    => 'save_option_sent_subfolders_setting'
  130.     );
  131.  
  132.     $filtered_folders=array_filter($boxes, "filter_folders");
  133.     $sent_subfolders_base_values = array('whatever'=>$filtered_folders);
  134.  
  135.     $optvals[] = array(
  136.         'name'    => 'sent_subfolders_base',
  137.         'caption' => _("Base Sent Folder"),
  138.         'type'    => SMOPT_TYPE_FLDRLIST,
  139.         'refresh' => SMOPT_REFRESH_FOLDERLIST,
  140.         'posvals' => $sent_subfolders_base_values,
  141.         'save'    => 'save_option_sent_subfolders_base',
  142.     );
  143.  
  144.     /* Add our option data to the global array. */
  145.     $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp;
  146.     $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals;
  147. }
  148.  
  149. /**
  150.  * Defines folder filtering rules
  151.  *
  152.  * Callback function that should exclude some folders from folder listing.
  153.  * @param array $fldr list of folders. See sqimap_mailbox_list
  154.  * @return boolean returns true, if folder has to included in folder listing
  155.  * @access private
  156.  */
  157. function filter_folders($fldr) {
  158.     return strtolower($fldr['unformatted'])!='inbox';
  159. }
  160.  
  161. /**
  162.  * Saves sent_subfolder_options
  163.  */
  164. function save_option_sent_subfolders_setting($option) {
  165.     global $data_dir, $username, $use_sent_subfolders, $sent_subfolders_base;
  166.  
  167.     /* Set use_sent_subfolders as either on or off. */
  168.     if ($option->new_value == SMPREF_SENT_SUBFOLDERS_DISABLED) {
  169.         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
  170.         // for lack of anything better
  171.         setPref($data_dir, $username, 'sent_folder', $sent_subfolders_base);
  172.     } else {
  173.         setPref($data_dir, $username, 'use_sent_subfolders', SMPREF_ON);
  174.         setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
  175.         $check_sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', '');
  176.         if ($check_sent_subfolders_base === '') {
  177.             setPref($data_dir, $username, 'sent_subfolders_base', $sent_subfolders_base);
  178.         }
  179.     }
  180.  
  181.     /* Now just save the option as normal. */
  182.     save_option($option);
  183. }
  184.  
  185. /**
  186.  * Update sent_subfolders settings
  187.  *
  188.  * function updates default sent folder value and
  189.  * creates required imap folders
  190.  */
  191. function sent_subfolders_update_sentfolder() {
  192.     global $sent_folder, $auto_create_special, $auto_create_done;
  193.     global $sent_subfolders_base, $sent_subfolders_setting;
  194.     global $data_dir, $imapServerAddress, $imapPort, $imap_stream_options;
  195.     global $use_sent_subfolders, $move_to_sent, $imap_server_type;
  196.  
  197.     sqgetGlobalVar('username', $username, SQ_SESSION);
  198.     sqgetGlobalVar('key', $key, SQ_COOKIE);
  199.     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
  200.     
  201.     if ($use_sent_subfolders || $move_to_sent) {
  202.         $year = date('Y');
  203.         $month = date('m');
  204.         $quarter = sent_subfolder_getQuarter($month);
  205.  
  206.         /*
  207.             Regarding the structure we've got three main possibilities.
  208.             One sent holder. level 0.
  209.             Multiple year holders with messages in it. level 1.
  210.             Multiple year folders with holders in it. level 2.
  211.         */
  212. /*
  213.         if( $imap_server_type == 'uw' ) {
  214.             $cnd_delimiter = '';
  215.         } else {
  216.             $cnd_delimiter = $delimiter;
  217.         }
  218. */        
  219.         $cnd_delimiter = $delimiter;
  220.                                         
  221.         switch ($sent_subfolders_setting) {
  222.         case SMPREF_SENT_SUBFOLDERS_YEARLY:
  223.             $level = 1;
  224.             $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
  225.                             . $year;
  226.             break;
  227.         case SMPREF_SENT_SUBFOLDERS_QUARTERLY:
  228.             $level = 2;
  229.             $sent_subfolder = $sent_subfolders_base . $cnd_delimiter 
  230.                             . $year
  231.                             . $delimiter . $quarter;
  232.             $year_folder = $sent_subfolders_base . $cnd_delimiter
  233.                             . $year;
  234.             break;
  235.         case SMPREF_SENT_SUBFOLDERS_MONTHLY:
  236.             $level = 2;
  237.             $sent_subfolder = $sent_subfolders_base . $cnd_delimiter
  238.                             . $year
  239.                             . $delimiter . $month;
  240.             $year_folder = $sent_subfolders_base . $cnd_delimiter . $year;
  241.             break;
  242.         case SMPREF_SENT_SUBFOLDERS_DISABLED:
  243.         default:
  244.             $level = 0;
  245.             $sent_subfolder = $sent_folder;
  246.             $year_folder = $sent_folder;
  247.         }
  248.  
  249.         /* If this folder is NOT the current sent folder, update stuff. */
  250.         if ($sent_subfolder != $sent_folder) {
  251.             /* First, update the sent folder. */
  252.  
  253.             setPref($data_dir, $username, 'sent_folder', $sent_subfolder);
  254.             setPref($data_dir, $username, 'move_to_sent', SMPREF_ON);
  255.             $sent_folder = $sent_subfolder;
  256.             $move_to_sent = SMPREF_ON;
  257.  
  258.             /* Auto-create folders, if they do not yet exist. */
  259.             if ($sent_folder != 'none') {
  260.                 /* Create the imap connection. */
  261.                 $ic = sqimap_login
  262.                 ($username, $key, $imapServerAddress, $imapPort, 10, $imap_stream_options);
  263.  
  264.                 /* Auto-create the year folder, if it does not yet exist.
  265.                    (only for monthly/quarterly modes */
  266.                 if ($sent_subfolders_setting != SMPREF_SENT_SUBFOLDERS_YEARLY) {
  267.                     if (!sqimap_mailbox_exists($ic, $year_folder)) {
  268.                         sqimap_mailbox_create($ic, $year_folder, ($level==1)?'':'noselect');
  269.                     } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) {
  270.                         sqimap_subscribe($ic, $year_folder);
  271.                     }
  272.                 }
  273.  
  274.                 /* Auto-create the subfolder, if it does not yet exist. */
  275.                 if (!sqimap_mailbox_exists($ic, $sent_folder)) {
  276.                     sqimap_mailbox_create($ic, $sent_folder, '');
  277.                 } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) {
  278.                     sqimap_subscribe($ic, $sent_subfolder);
  279.                 }
  280.  
  281.                 /* Close the imap connection. */
  282.                 sqimap_logout($ic);
  283.             }
  284.         }
  285.     }
  286. }
  287.  
  288. /**
  289.  * Update the folder settings/auto-create new subfolder
  290.  */
  291. function save_option_sent_subfolders_base($option) {
  292.     // first save the option as normal
  293.     save_option($option);
  294.  
  295.     // now update folder settings and auto-create first subfolder if needed
  296.     sent_subfolders_update_sentfolder();
  297. }
  298.  
  299. /**
  300.  * Sets quarter subfolder names
  301.  *
  302.  * @param string $month numeric month
  303.  * @return string quarter name (Q + number)
  304.  */
  305. function sent_subfolder_getQuarter($month) {
  306.     switch ($month) {
  307.         case '01':
  308.         case '02':
  309.         case '03':
  310.             $result = '1';
  311.             break;
  312.         case '04':
  313.         case '05':
  314.         case '06':
  315.             $result = '2';
  316.             break;
  317.         case '07':
  318.         case '08':
  319.         case '09':
  320.             $result = '3';
  321.             break;
  322.         case '10':
  323.         case '11':
  324.         case '12':
  325.             $result = '4';
  326.             break;
  327.         default:
  328.             $result = 'ERR';
  329.     }
  330.  
  331.     /* Return the current quarter. */
  332.     return ('Q' . $result);
  333. }
  334.  
  335. /**
  336.  * detects if mailbox is part of sent_subfolders
  337.  *
  338.  * @param string $mb imap folder name
  339.  * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders
  340.  */
  341. function sent_subfolders_special_mailbox($mb) {
  342.     global $data_dir, $username, $sent_folder;
  343.  
  344.     sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
  345. /*
  346.     if( $imap_server_type == 'uw' ) {
  347.         $cnd_delimiter = '';
  348.     } else {
  349.         $cnd_delimiter = $delimiter;
  350.     }
  351. */        
  352.     $cnd_delimiter = $delimiter;
  353.  
  354.     $use_sent_subfolders = getPref
  355.         ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF);
  356.     $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', $sent_folder);
  357.  
  358.     if ($use_sent_subfolders == SMPREF_ON && 
  359.     ($mb == $sent_subfolders_base || stristr($mb,$sent_subfolders_base. $cnd_delimiter) ) ) {
  360.     return 1;
  361.     }
  362.     return 0;
  363. }

Documentation generated on Mon, 13 Jan 2020 04:25:19 +0100 by phpDocumentor 1.4.3