Changeset 915

Timestamp:

07/21/08 18:36:52 (3 months ago)

Author:

bermiferrer

Message:

Refactoring the monolithic AkMail? object into

AkMailMessage? (contains message headers, simple body, and parts)
AkMailPart? (message parts)
AkMailBase? (common functionality for messages and parts)
AkMailHeader? (for message and part headers - not implemented yet)
AkMailComposer? (multipart and nested message composer)

Right now the nested message composing ( Multipart( text + html ) + Attachment ) is not supported unless parts are set manually using

set(
'parts' => array('...')
)

We need to make it work in this scenario:

signup()

renders automatically

signup.text.plain.tpl
signup.text.html.tpl

and using setAttachment() we need to be able to add attachments, wrapping previous inline message into a multipart/alternative part and changing AkMailMessage? content type to multipart/mixed

Files:

• branches/action_mailer/lib/AkActionMailer.php (modified) (13 diffs)
• branches/action_mailer/lib/AkActionMailer/AkActionMailerQuoting.php (modified) (1 diff)
• branches/action_mailer/lib/AkActionMailer/AkMail.php (deleted)
• branches/action_mailer/lib/AkActionMailer/AkMailBase.php (added)
• branches/action_mailer/lib/AkActionMailer/AkMailComposer.php (added)
• branches/action_mailer/lib/AkActionMailer/AkMailEncoder.php (modified) (1 diff)
• branches/action_mailer/lib/AkActionMailer/AkMailHeader.php (added)
• branches/action_mailer/lib/AkActionMailer/AkMailMessage.php (added)
• branches/action_mailer/lib/AkActionMailer/AkMailParser.php (modified) (4 diffs)
• branches/action_mailer/lib/AkActionMailer/AkMailPart.php (added)
• branches/action_mailer/test/fixtures/app/models/test_mailer.php (modified) (9 diffs)
• branches/action_mailer/test/fixtures/app/views/test_mailer/multipart_rendering.text.html.tpl (modified) (1 diff)
• branches/action_mailer/test/unit/lib/AkActionMailer.php (modified) (20 diffs)

branches/action_mailer/lib/AkActionMailer.php

@@ -18 +18 @@
-
-require_once(AK_LIB_DIR.DS.'AkBaseModel.php');
-
+Message
-require_once(AK_LIB_DIR.DS.'AkActionMailer'.DS.'AkMailParser.php');
-require_once(AK_LIB_DIR.DS.'AkActionMailer'.DS.'AkActionMailerQuoting.php');
@@ -276 +276 @@
-    var $helpers = array('mail');
-    var $_MailDriver;
-
+Message
-
-    function __construct($Driver = null)
@@ -456 +456 @@
-    {
-        $args = func_get_args();
-        print_r($args);
-        return call_user_func_array(array(&$this->_MailDriver, 'setAttachment'), $args);
-    }
@@ -468 +467 @@
-     * This simplifies creating mail objects from datasources.
-     * 
-s
+d
-     */
-    function set($attributes = array())
@@ -476 +475 @@
-            unset($attributes['template']);
-        }
+
+        if((!empty($attributes['attachment']) || !empty($attributes['attachments'])) &&
+        (empty($attributes['parts']) && empty($attributes['part']) && empty($attributes['body']))){
+            // we can render here the body if there are attachments
+        }
+
-        $this->_MailDriver->set($attributes);
-    }
+
-
-    /**
@@ -514 +520 @@
-    function receive($raw_mail)
-    {
-
+Base
-        return $this->_MailDriver;
-    }
@@ -529 +535 @@
-    function deliverDirectly(&$Mail)
-    {
-AkMail
+$this->_defaultMailDriverName 
-        $Mail->send();
-    }
@@ -536 +542 @@
-    /**
-     * Initialize the mailer via the given +method_name+. The body will be
-
+Message
-     */
-    function &create($method_name, $parameters, $content_type = '')
@@ -549 +555 @@
-        }
-        $parameters = @array_shift($args);
-        $content_type = @array_shift($args);
-
-        $Mail =& $this->_MailDriver;
+
+        $this->_prepareInlineBodyParts($Mail);
+
+        $Mail->setMimeVersion((empty($Mail->mime_version) && !empty($Mail->parts)) ? '1.0' : $Mail->mime_version);
+
+        $this->Mail =& $Mail;
+        return $Mail;
+    }
+
+    function _prepareInlineBodyParts(&$Mail, $mail_content_type = 'multipart/alternative')
+    {
-
-        if(!is_string($Mail->body)){
@@ -557 +573 @@
-                $Mail->_avoid_multipart_propagation = true;
-                $templates = $this->_getAvailableTemplates();
+                $alternative_multiparts = array();
-                foreach ($templates as $template_name){
-                    if(preg_match('/^([^\.]+)\.([^\.]+\.[^\.]+)\.(tpl)$/',$template_name, $match)){
-                        if($this->template == $match[1]){
-                            $content_type = str_replace('.','/', $match[2]);
-
+
+
-                            'content_type' => $content_type,
-                            'disposition' => 'inline',
-                            'charset' => @$Mail->charset,
-
+
+
+
-                        }
-                    }
-                }
+
-                if(!empty($Mail->parts)){
-'multipart/alternative'
+$mail_content_type
-                    $Mail->parts = $Mail->getSortedParts($Mail->parts, $Mail->implicit_parts_order);
-                }
@@ -595 +616 @@
-            }
-        }
-
-        $Mail->setMimeVersion((empty($Mail->mime_version) && !empty($Mail->parts)) ? '1.0' : $Mail->mime_version);
-
-        $this->Mail =& $Mail;
-        return $Mail;
-    }
-
@@ -612 +628 @@
-
-    /**
-
+Message
-    * object (from the AkActionMailer::create method). If no cached mail object exists, and
-    * no alternate has been given as the parameter, this will fail.
@@ -700 +716 @@
-    function performTestDelivery(&$Mail)
-    {
- return ;
+
-        $this->deliveries[] =& $Mail->getEncoded();
-    }

branches/action_mailer/lib/AkActionMailer/AkActionMailerQuoting.php

@@ -49 +49 @@
-            
-            $line = preg_replace($search_pattern, 'sprintf( "=%02X", ord ( "$0" ) ) ;', $line );
-utf8_
+
-            
-            $last_char = ord($line[$length-1]);

branches/action_mailer/lib/AkActionMailer/AkMailEncoder.php

@@ -1 +1 @@
-<?php
-
-Mail_mimeEncode
+AkObject
-{
-
-
+    
+    
+    
-    function setMimeContents($options = array())
-    {

branches/action_mailer/lib/AkActionMailer/AkMailParser.php

@@ -32 +32 @@
-    }
-
-
+, $object_type = 'AkMailMessage'
-    {
-        $parser_class = empty($options['parser_class']) ? 'AkMailParser' : $options['parser_class'];
-        $Parser =& new $parser_class($options);
-stdClass
+$object_type
-        $raw_message = empty($raw_message) ? $Parser->raw_message : $raw_message;
-        if(!empty($raw_message)){
@@ -90 +90 @@
-                return false;
-            }else{
-
+, array(), 'AkMailPart'
-            }
-            $this->parts[] = $Part;
@@ -228 +228 @@
-                $header['encoded'] = $header['value'];
-                $header['value'] = $header_value;
+                isset($charset) && $header['charset'] = $charset;
-            }
-        }
@@ -281 +282 @@
-    }
-
+    
+    function importStructure(&$MailOrPart, $structure = array())
+    {
+        if(isset($structure['header'])){
+            $structure['headers'] = $structure['header'];
+            unset($structure['header']);
+        }
+        foreach ($structure as $attribute=>$value){
+            if($attribute[0] != '_'){
+                $attribute_setter = 'set'.AkInflector::camelize($attribute);
+                if(method_exists($MailOrPart, $attribute_setter)){
+                    $MailOrPart->$attribute_setter($value);
+                }else{
+                    $MailOrPart->{AkInflector::underscore($attribute)} = $value;
+                }
+            }
+        }
+        return ;
+    }
+    
+    
+    function extractImagesIntoInlineParts(&$Mail, $options = array())
+    {
+        $html =& $Mail->body;
+        require_once(AK_LIB_DIR.DS.'AkActionView'.DS.'helpers'.DS.'text_helper.php');
+        $images = TextHelper::get_image_urls_from_html($html);
+        $html_images = array();
+        if(!empty($images)){
+            require_once(AK_LIB_DIR.DS.'AkImage.php');
+            require_once(AK_LIB_DIR.DS.'AkActionView'.DS.'helpers'.DS.'asset_tag_helper.php');
+
+            $images = array_diff(array_unique($images), array(''));
+
+            foreach ($images as $image){
+                $original_image_name = $image;
+                $image = $this->_getImagePath($image);
+                if(!empty($image)){
+                    $extenssion = substr($image, strrpos('.'.$image,'.'));
+                    $image_name = Ak::uuid().'.'.$extenssion;
+                    $html_images[$original_image_name] = 'cid:'.$image_name;
+
+                    $Mail->setAttachment('image/'.$extenssion, array(
+                    'body' => Ak::file_get_contents($image),
+                    'filename' => $image_name,
+                    'content_disposition' => 'inline',
+                    'content_id' => '<'.$image_name.'>',
+                    ));
+                }
+            }
+            $modified_html = str_replace(array_keys($html_images),array_values($html_images), $html);
+            if($modified_html != $html){
+                $html = $modified_html;
+                $Mail->_moveBodyToInlinePart(false);
+            }
+        }
+    }
+    
+    function _getImagePath($path)
+    {
+        if(preg_match('/^http(s)?:\/\//', $path)){
+            $path_info = pathinfo($path);
+            $base_file_name = Ak::sanitize_include($path_info['basename'], 'paranaoid');
+            if(empty($path_info['extension'])){ // no extension, we don't do magic stuff
+                $path = '';
+            }else{
+                $local_path = AK_TMP_DIR.DS.'mailer'.DS.'remote_images'.DS.md5($base_file_name['dirname']).DS.$base_file_name.'.'.$path_info['extension'];
+                if(!file_exists($local_path) || (time() > @filemtime($local_path)+7200)){
+                    if(!Ak::file_put_contents($local_path, Ak::url_get_contents($path))){
+                        return '';
+                    }
+                }
+                return $local_path;
+            }
+        }
+
+        $path = AK_PUBLIC_DIR.Ak::sanitize_include($path);
+
+        if(!file_exists($path)){
+            $path = '';
+        }
+        return $path;
+    }
+
-}
-

branches/action_mailer/test/fixtures/app/models/test_mailer.php

@@ -4 +4 @@
-{
-    var $delivery_method = 'test';
-
+
-    function signed_up($recipient)
-    {
@@ -78 +78 @@
-        'bcc' => "Grytøyr <stian3@example.com>",
-        'body' => "Nothing to see here.",
- 
+
-        ));
-    }
@@ -119 +119 @@
-        'subject' => "Foo áëô îü",
-        'from' => "test@example.com",
-utf
+UTF
-        'parts' => array(
-        array('content_type' => 'text/plain', 'body' => 'blah'),
@@ -234 +234 @@
-
-        'parts' => array(
-
-
-
-
-
+
+
+
+
+
+
+
+
-        ),
-
+
+
-        'attachment' => array(
-    
+
-        )
-        ));
@@ -256 +260 @@
-
-        'part' => array('content_type' => 'text/html', 'body' => 'yo'),
-
+
-        'attachment' => array(
-    
-
-
-
-
+
+
+
+
+
-    function unnamed_attachment($recipient)
-    {
@@ -272 +276 @@
-
-        'part' => array('content_type' => 'text/plain', 'body' => 'hullo'),
-
+
-        'attachment' => array(
-    
+
-        )
-        ));
@@ -290 +294 @@
-    }
-
-
+
-    function custom_content_type_attributes()
-    {
@@ -308 +312 @@
-        'recipients' => "bermi@bermilabs.com",
-        'subject' => "Multipart rendering",
-
-
-
-
-
-
-
-
+
+
+
+
-        return ;
+
-        $this->set(array(
-        'recipients' => "no.one@example.com",
@@ -323 +324 @@
-        ));
-    }
-
+
-    function &receive($raw_email)
-    {

branches/action_mailer/test/fixtures/app/views/test_mailer/multipart_rendering.text.html.tpl

@@ -8 +8 @@
-<hidden>
-<img src="http://www.bermilabs.com/images/bermilabs_logo.png" />
+
-<img src="/images/akelos_framework_logo.png" />
-</hidden>

branches/action_mailer/test/unit/lib/AkActionMailer.php

@@ -97 +97 @@
-        $headers = array(
-        "Subject: =?ISO-8859-1?Q?=C9ste_es_el_sof=E1_del_q_habl=E9_=5B?=\n\r =?ISO-8859-1?Q?Fwd=3A_Sof=E1=2E=5D_?="=>'Subject: Éste es el sofá del q hablé [Fwd: Sofá.]',
-
+
-        "Subject: =?ISO-8859-1?Q?=C9ste_es_el_sof=E1_del_q_habl=E9_=5B?==?ISO-8859-1?Q?Fwd=3A_Sof=E1=2E=5D_?="=>'Subject: Éste es el sofá del q hablé [Fwd: Sofá.]',
-
+
-        'Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?='=>'Subject: Prüfung Prüfung',
-        'Subject: =?iso-8859-1?Q?RV:_=5BFwd:__chiste_inform=E1tico=5D?='=>'Subject: RV: [Fwd:  chiste informático]',
@@ -106 +106 @@
-        'X-Akelos-Random: =?UTF-8?B?ZXN0w6Egw6MgYsOkc8OqNjQ=?='=>'X-Akelos-Random: está ã bäsê64',
-        //'X-Akelos-Random: =?ISO-2022-JP?B?GyRCJDMkcyRLJEEkT0AkMyYbKEI=?='=>'X-Akelos-Random: こんにちは世界',
-
+
-        'X-Akelos-Random: =?UTF-8?Q?E=C3=B1e_de_Espa=C3=B1a?= =?UTF-8?Q?_Fwd:_?= =?UTF-8?Q?=E3=81=93=E3=82=93=E3=81=AB=E3=81=A1=E3=81=AF=E4=B8=96=E7=95=8C?='=>'X-Akelos-Random: Eñe de España Fwd: こんにちは世界',
-        'From: =?ISO-8859-1?Q?Crist=F3bal_G=F3mez_Moreno?= <cristobal@example.com>'=>'From: Cristóbal Gómez Moreno <cristobal@example.com>',
-
+
-        "Subject: =?ISO-8859-1?Q?=C9ste_es_el_sof=E1_del_q_habl=E9_=5B?=\n =?ISO-8859-1?Q?Fwd=3A_Sof=E1=2E=5D_?="=>'Subject: Éste es el sofá del q hablé [Fwd: Sofá.]'
-        );
@@ -124 +124 @@
-    function test_email_quoted_with_0d0a()
-    {
-
+Base
-        $this->assertPattern('/Elapsed time/', $Mail->body);
-    }
@@ -130 +130 @@
-    function test_email_with_partially_quoted_subject()
-    {
-
+Base
-        $this->assertEqual("Re: Test: \"\346\274\242\345\255\227\" mid \"\346\274\242\345\255\227\" tail", $Mail->subject);
-    }
@@ -136 +136 @@
-    /**/
-}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
@@ -147 +164 @@
-    function new_mail($charset = 'utf-8')
-    {
-
+Message
-        $Mail->setMimeVersion('1.0');
-        $Mail->setContentType('text/plain; charset:'.$charset);
@@ -157 +174 @@
-    {
-        $this->Mailer =& new AkActionMailer();
-//
+
-        $this->Mailer->perform_deliveries = true;
-        $this->Mailer->deliveries = array();
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    function test_nested_parts()
-    {
-
-
-
+
+
+
+
-        $this->assertEqual(2, count($Created->parts));
-        $this->assertEqual(2, count($Created->parts[0]->parts));
-        $this->assertEqual( "multipart/mixed", $Created->content_type);
-        $this->assertEqual( "multipart/alternative", $Created->parts[0]->content_type );
-
+
+
-        $this->assertEqual( "text/plain", $Created->parts[0]->parts[0]->content_type );
+        
-        $this->assertEqual( "text/html", $Created->parts[0]->parts[1]->content_type );
-        $this->assertEqual( "application/octet-stream", $Created->parts[1]->content_type );
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    function test_attachment_with_custom_header()
-    {
-
-
-
-
+
+
+
+
+
-
-    function test_signed_up()
@@ -200 +257 @@
-        $this->assertTrue($Created = $TestMailer->create('signed_up', $this->recipient));
-        $this->assertEqual($Expected->getEncoded(), $Created->getEncoded());
+        
-        $this->assertTrue($TestMailer->deliver('signed_up', $this->recipient));
-        $this->assertTrue(!empty($TestMailer->deliveries[0]));
-        $this->assertEqual($Expected->getEncoded(), $TestMailer->deliveries[0]);
-
-
+
+
+
+
-    function test_custom_template()
-    {
@@ -216 +276 @@
-        $this->assertTrue($Created = $TestMailer->create('custom_template', $this->recipient));
-        $this->assertEqual($Expected->getEncoded(), $Created->getEncoded());
+        
-    }
-
@@ -259 +320 @@
-        $this->assertEqual($Expected->getEncoded(), $TestMailer->deliveries[0]);
-    }
-
-
-
@@ -284 +344 @@
-        $this->assertTrue(!empty($TestMailer->deliveries[0]));
-        $this->assertEqual($Expected->getEncoded(), $TestMailer->deliveries[0]);
-
-
+
+
+
+
-
-
@@ -308 +370 @@
-        $this->assertTrue(!empty($TestMailer->deliveries[0]));
-        $this->assertEqual($Expected->getEncoded(), $TestMailer->deliveries[0]);
-
-
-
+
+
+
+
+
-    function test_perform_deliveries_flag()
-    {
@@ -324 +388 @@
-
-    }
+  
-
-    function test_unquote_quoted_printable_subject()
@@ -335 +400 @@
-EOF;
-
-
+Base
-        $this->assertEqual("testing testing \326\244", $Mail->subject);
-
-
-
+
+
+
+
-
-    function test_unquote_7bit_subject()
@@ -351 +417 @@
-EOF;
-
-
+Base
-        $this->assertEqual("this == working?", $Mail->subject);
-        $this->assertEqual("this == working?", $Mail->getSubject());
@@ -369 +435 @@
-EOF;
-
-
+Base
-        $this->assertEqual("The=3Dbody", $Mail->body);
-        $this->assertEqual("The=3Dbody", $Mail->getBody());
@@ -386 +452 @@
-EOF;
-
-
+Base
-        $this->assertEqual("The=body", $Mail->body);
-        $this->assertEqual("The=3Dbody", $Mail->getBody());
@@ -403 +469 @@
-EOF;
-
-
+Base
-        $this->assertEqual("The body", $Mail->body);
-        $this->assertEqual("VGhlIGJvZHk=", $Mail->getBody());
@@ -446 +512 @@
-        $TestMailer =& new TestMailer();
-        $this->assertTrue($Created = $TestMailer->create('utf8_body', $this->recipient));
+
-        $this->assertPattern("/\nFrom: =\?UTF-8\?Q\?Foo_.*?\?= <extended@example.com>\r/", $Created->getEncoded());
-        $this->assertPattern("/To: =\?UTF-8\?Q\?Foo_.*?\?= <extended@example.com>, Ex=\r\n ample Recipient <me/", $Created->getEncoded());
@@ -690 +757 @@
-    
-    /**/
-    
-    function test_should_render_multipart_message()
-    {
-        $TestMailer =& new TestMailer();
-        $TestMailer->deliver('multipart_rendering');
-        
-        echo $TestMailer->getRawMessage();
-    }
-    
-    
-}
-
-//
+
-Ak::test('Tests_for_AkActionMailer');
-