- #35638, add udate to imap_fetch_overview

diff --git a/NEWS b/NEWS
index 50daebd2ce9ebbc3e368c9da3e597e00e156c62a..0cdab56fd4736354ffa5dac35d7c3aaf8b40bd11 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -68,6 +68,9 @@ PHP                                                                        NEWS
 - Fixed bug #48902 (Timezone database fallback map is outdated). (Derick)
 - Fixed bug #46111 (Some timezone identifiers can not be parsed). (Derick)
 - Fixed bug #35673 (formatOutput does not work with saveHTML). (Rob)
+- Implement feature request #35638 (Adding udate to imap_fetch_overview results).
+  (Charles_Duffy at dell dot com )
+
 
 ?? ??? 20??, PHP 5.3.2
 - Upgraded bundled sqlite to version 3.6.22. (Ilia)

diff --git a/ext/imap/php_imap.c b/ext/imap/php_imap.c
index 5e47510d484e561c9c3451a5c0e5591f1bb37aa0..5432d84ff47c655c96693eb2c975b73a2b503684 100644 (file)
--- a/ext/imap/php_imap.c
+++ b/ext/imap/php_imap.c
@@ -3420,6 +3420,7 @@ PHP_FUNCTION(imap_fetch_overview)
                                add_property_long(myoverview, "deleted", elt->deleted);
                                add_property_long(myoverview, "seen", elt->seen);
                                add_property_long(myoverview, "draft", elt->draft);
+                               add_property_long(myoverview, "udate", mail_longdate(elt));
                                add_next_index_object(return_value, myoverview TSRMLS_CC);
                        }
                }

diff --git a/ext/imap/tests/imap_fetch_overview_basic.phpt b/ext/imap/tests/imap_fetch_overview_basic.phpt
index 2b4623febf2b4df65273e49101be44ac3df757d1..83fab123912c04fd4ae156af7d02dd34d51e3b9c 100644 (file)
--- a/ext/imap/tests/imap_fetch_overview_basic.phpt
+++ b/ext/imap/tests/imap_fetch_overview_basic.phpt
@@ -23,28 +23,11 @@ $stream_id = setup_test_mailbox('', 2, $mailbox, 'notSimple');
 $msg_no = imap_uid($stream_id, 1);
 $options = FT_UID;
 
-//Set mandatory response fields
-$mandatoryFields = array(
-                    'size',
-                    'uid',
-                    'msgno',
-                    'recent',
-                    'flagged',
-                    'answered',
-                    'deleted',
-                    'seen',
-                    'draft',
-                   );
-
 // Calling imap_fetch_overview() with all possible arguments
 echo "\n-- All possible arguments --\n";
 $a =  imap_fetch_overview($stream_id, "$msg_no", $options) ;
 echo "\n--> Object #1\n";
-foreach ($mandatoryFields as $mf) 
-{
-  $z = $a[0]->$mf;
-  echo "$mf is $z\n";
-}
+displayOverviewFields($a[0]);
 
 // Calling imap_fetch_overview() with mandatory arguments
 echo "\n-- Mandatory arguments --\n";
@@ -52,19 +35,11 @@ $a = imap_fetch_overview($stream_id, '1:2') ;
 
 //first object in array
 echo "\n--> Object #1\n";
-foreach ($mandatoryFields as $mf) 
-{
-  $z = $a[0]->$mf;
-  echo "$mf is $z\n";
-}
+displayOverviewFields($a[0]);
 
 //Second object in array
 echo "\n--> Object #2\n";
-foreach ($mandatoryFields as $mf) 
-{
-  $z = $a[1]->$mf;
-  echo "$mf is $z\n";
-}
+displayOverviewFields($a[1]);
 
 imap_close($stream_id);
 
@@ -91,6 +66,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 -- Mandatory arguments --
 
@@ -104,6 +80,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 --> Object #2
 size is %d
@@ -115,4 +92,5 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 ===DONE===

diff --git a/ext/imap/tests/imap_fetch_overview_variation2.phpt b/ext/imap/tests/imap_fetch_overview_variation2.phpt
index 8634cefab7878595422d205ffd8c2fbce7513bb8..086885f6a5cf76514544243280646fb4ec45504e 100644 (file)
--- a/ext/imap/tests/imap_fetch_overview_variation2.phpt
+++ b/ext/imap/tests/imap_fetch_overview_variation2.phpt
@@ -22,20 +22,6 @@ require_once(dirname(__FILE__).'/imap_include.inc');
 // Initialise function arguments not being substituted
 $stream_id = setup_test_mailbox('', 1, $mailbox, 'notSimple'); // set up temp mailbox with 1 msg
 
-//Set mandatory response fields
-$mandatoryFields = array(
-                    'size',
-                    'uid',
-                    'msgno',
-                    'recent',
-                    'flagged',
-                    'answered',
-                    'deleted',
-                    'seen',
-                    'draft',
-                   );
-
-
 //get an unset variable
 $unset_var = 10;
 unset ($unset_var);
@@ -114,11 +100,7 @@ foreach($inputs as $input) {
        if (!$overview) {
                echo imap_last_error() . "\n";
        } else {
-                foreach ($mandatoryFields as $mf)
-                {
-                  $z = $overview[0]->$mf;
-                  echo "$mf is $z\n";
-                }
+               displayOverviewFields($overview[0]);
         }
        $iterator++;
 };
@@ -151,6 +133,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 -- Testing with second argument value: int(12345)
 Sequence out of range
@@ -189,6 +172,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 -- Testing with second argument value: bool(false)
 Sequence out of range
@@ -203,6 +187,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 -- Testing with second argument value: bool(false)
 Sequence out of range

diff --git a/ext/imap/tests/imap_fetch_overview_variation5.phpt b/ext/imap/tests/imap_fetch_overview_variation5.phpt
index d5bc88858a89ed8cb31970baebcc8f64e7b4df04..5feeedb523f11e0017cc97bab78e0f8c76f22637 100644 (file)
--- a/ext/imap/tests/imap_fetch_overview_variation5.phpt
+++ b/ext/imap/tests/imap_fetch_overview_variation5.phpt
@@ -22,19 +22,6 @@ require_once(dirname(__FILE__).'/imap_include.inc');
 
 $stream_id = setup_test_mailbox('', 3, $mailbox, 'notSimple'); // set up temp mailbox with 3 msgs
 
-//Set mandatory response fields
-$mandatoryFields = array(
-                    'size',
-                    'uid',
-                    'msgno',
-                    'recent',
-                    'flagged',
-                    'answered',
-                    'deleted',
-                    'seen',
-                    'draft',
-                   );
-
 $sequences = array (0,     4,     '4', // out of range
                     '2',   '1,3', '1, 2',
                     '1:3'); // pass uid without setting FT_UID option
@@ -47,11 +34,7 @@ foreach($sequences as $msg_no) {
         } else {
                foreach($overview as $ov) {
                        echo "\n";
-                                foreach ($mandatoryFields as $mf)
-                                {
-                                       $z = $ov->$mf;
-                                       echo "$mf is $z\n";
-                       }
+                       displayOverviewFields($ov);
                         }
         }
 }
@@ -89,6 +72,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 -- $msg_no is 1,3 --
 
@@ -101,6 +85,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 size is %d
 uid is %d
@@ -111,6 +96,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 -- $msg_no is 1, 2 --
 Syntax error in sequence
@@ -126,6 +112,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 size is %d
 uid is %d
@@ -136,6 +123,7 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 
 size is %d
 uid is %d
@@ -146,4 +134,5 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 ===DONE===

diff --git a/ext/imap/tests/imap_fetch_overview_variation6.phpt b/ext/imap/tests/imap_fetch_overview_variation6.phpt
index 6ee65f68f0e73c8d9b5b742e1632e955f182a831..bdf05579de9cbd2bcfa0afcb56efd11e05d30810 100644 (file)
--- a/ext/imap/tests/imap_fetch_overview_variation6.phpt
+++ b/ext/imap/tests/imap_fetch_overview_variation6.phpt
@@ -22,30 +22,13 @@ require_once(dirname(__FILE__).'/imap_include.inc');
 $stream_id = setup_test_mailbox('', 0, $mailbox); // setup temp mailbox
 create_multipart_message($stream_id, $mailbox);
 
-//Set mandatory response fields
-$mandatoryFields = array(
-                    'size',
-                    'uid',
-                    'msgno',
-                    'recent',
-                    'flagged',
-                    'answered',
-                    'deleted',
-                    'seen',
-                    'draft',
-                   );
-
 // refresh msg numbers
 imap_check($stream_id);
 $msg_no = 1;
 
 $a = imap_fetch_overview($stream_id, $msg_no);
 echo "\n--> Object #1\n";
-foreach ($mandatoryFields as $mf)
-{
-  $z = $a[0]->$mf;
-  echo "$mf is $z\n";
-}
+displayOverviewFields($a[0]);
 
 
 
@@ -122,4 +105,5 @@ answered is 0
 deleted is 0
 seen is 0
 draft is 0
+udate is OK
 ===DONE===

diff --git a/ext/imap/tests/imap_include.inc b/ext/imap/tests/imap_include.inc
index 3f9845476c1bd8f7f47f4c5d737dfd61c57245a0..ed36239572fd4260d809fd3c48dbdd760b0b9463 100644 (file)
--- a/ext/imap/tests/imap_include.inc
+++ b/ext/imap/tests/imap_include.inc
@@ -9,10 +9,56 @@ $password = 'p4ssw0rd';
 $users = array("webmaster", "info", "admin", "foo"); // tests require 4 valid userids
 $mailbox_prefix = "phpttest"; // name used for test mailbox
 
+// record test start time (used by displayOverviewFields())
+$start_time = time();
+
+// list of fields to expect
+$mandatory_overview_fields = array(
+                    'size',
+                    'uid',
+                    'msgno',
+                    'recent',
+                    'flagged',
+                    'answered',
+                    'deleted',
+                    'seen',
+                    'draft',
+                    'udate',
+                   );
+
+/**
+ * Display all fields in an element from an imap_fetch_overview() response
+ *
+ * Special handling for 'udate', which will vary run-to-run; assumes an IMAP
+ * server with its clock synced to the current system, which is consistent with
+ * setup instructions in ext/imap/tests/README
+ *
+ * @param array resp element from the return value of imap_fetch_overview()
+ */
+function displayOverviewFields($resp, $fields=null) {
+  global $mandatory_overview_fields;
+  global $start_time;
+
+  foreach ($fields ? $fields : $mandatory_overview_fields as $mf)
+  {
+    $z = $resp->$mf;
+    if ($mf == 'udate') {
+      if (($z >= $start_time) && ($z <= time())) {
+        echo "$mf is OK\n";
+      } else {
+        echo "$mf is BAD ($z)\n";
+      }
+    } else {
+      echo "$mf is $z\n";
+    }
+  }
+}
+
+
 /**
  * Create a test mailbox and populate with msgs 
  *
- * @para, string mailbox_suffix Suffix used to uniquely identify mailboxes
+ * @param string mailbox_suffix Suffix used to uniquely identify mailboxes
  * @param int message_count number of test msgs to be written to new mailbox 
  * 
  * @return IMAP stream to new mailbox on sucesss; FALSE on failure