inc/classes/main/template/mail/class_MailTemplateEngine.php

   1 <?php
   2 /**
   3  * The own template engine for loading caching and sending out images
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  * @todo                This template engine does not make use of setTemplateType()
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class MailTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
  26         /**
  27          * Main nodes in the XML tree
  28          */
  29         private $mainNodes = array(
  30                 'mail-data'
  31         );
  32
  33         /**
  34          * Sub nodes in the XML tree
  35          */
  36         private $subNodes = array(
  37                 'subject-line',
  38                 'sender-address',
  39                 'recipient-address',
  40                 'message'
  41         );
  42
  43         /**
  44          * Mailer instance
  45          */
  46         private $mailerInstance = null;
  47
  48         /**
  49          * Current main node
  50          */
  51         private $currMainNode = '';
  52
  53         /**
  54          * Protected constructor
  55          *
  56          * @return      void
  57          */
  58         protected function __construct () {
  59                 // Call parent constructor
  60                 parent::__construct(__CLASS__);
  61         }
  62
  63         /**
  64          * Creates an instance of the class TemplateEngine and prepares it for usage
  65          *
  66          * @param       $appInstance    A manageable application
  67          * @return      $templateInstance       An instance of TemplateEngine
  68          * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
  69          * @throws      InvalidBasePathStringException  If $templateBasePath is no string
  70          * @throws      BasePathIsNoDirectoryException  If $templateBasePath is no
  71          *                                                                                      directory or not found
  72          * @throws      BasePathReadProtectedException  If $templateBasePath is
  73          *                                                                                      read-protected
  74          */
  75         public final static function createMailTemplateEngine (ManageableApplication $appInstance) {
  76                 // Get a new instance
  77                 $templateInstance = new MailTemplateEngine();
  78
  79                 // Get language and file I/O instances from application
  80                 $langInstance = $appInstance->getLanguageInstance();
  81                 $ioInstance = $appInstance->getFileIoInstance();
  82
  83                 // Determine base path
  84                 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
  85
  86                 // Is the base path valid?
  87                 if (empty($templateBasePath)) {
  88                         // Base path is empty
  89                         throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  90                 } elseif (!is_string($templateBasePath)) {
  91                         // Is not a string
  92                         throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
  93                 } elseif (!is_dir($templateBasePath)) {
  94                         // Is not a path
  95                         throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
  96                 } elseif (!is_readable($templateBasePath)) {
  97                         // Is not readable
  98                         throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
  99                 }
 100
 101                 // Get configuration instance
 102                 $configInstance = FrameworkConfiguration::getInstance();
 103
 104                 // Set the base path
 105                 $templateInstance->setTemplateBasePath($templateBasePath);
 106
 107                 // Set the language and IO instances
 108                 $templateInstance->setLanguageInstance($langInstance);
 109                 $templateInstance->setFileIoInstance($ioInstance);
 110
 111                 // Set template extensions
 112                 $templateInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
 113                 $templateInstance->setCodeTemplateExtension($configInstance->getConfigEntry('code_template_extension'));
 114
 115                 // Absolute output path for compiled templates
 116                 $templateInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
 117
 118                 // Return the prepared instance
 119                 return $templateInstance;
 120         }
 121
 122         /**
 123          * Getter for current main node
 124          *
 125          * @return      $currMainNode   Current main node
 126          */
 127         public final function getCurrMainNode () {
 128                 return $this->currMainNode;
 129         }
 130
 131         /**
 132          * Getter for main node array
 133          *
 134          * @return      $mainNodes      Array with valid main node names
 135          */
 136         public final function getMainNodes () {
 137                 return $this->mainNodes;
 138         }
 139
 140         /**
 141          * Getter for sub node array
 142          *
 143          * @return      $subNodes       Array with valid sub node names
 144          */
 145         public final function getSubNodes () {
 146                 return $this->subNodes;
 147         }
 148
 149         /**
 150          * Handles the start element of an XML resource
 151          *
 152          * @param       $resource               XML parser resource (currently ignored)
 153          * @param       $element                The element we shall handle
 154          * @param       $attributes             All attributes
 155          * @return      void
 156          * @throws      InvalidXmlNodeException         If an unknown/invalid XML node name was found
 157          */
 158         protected function startElement ($resource, $element, array $attributes) {
 159                 // Initial method name which will never be called...
 160                 $methodName = 'initEmail';
 161
 162                 // Make the element name lower-case
 163                 $element = strtolower($element);
 164
 165                 // Is the element a main node?
 166                 //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
 167                 if (in_array($element, $this->getMainNodes())) {
 168                         // Okay, main node found!
 169                         $methodName = 'setEmail' . $this->convertToClassName($element);
 170                 } elseif (in_array($element, $this->getSubNodes())) {
 171                         // Sub node found
 172                         $methodName = 'setEmailProperty' . $this->convertToClassName($element);
 173                 } elseif ($element != 'text-mail') {
 174                         // Invalid node name found
 175                         throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
 176                 }
 177
 178                 // Call method
 179                 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
 180                 call_user_func_array(array($this, $methodName), $attributes);
 181         }
 182
 183         /**
 184          * Ends the main or sub node by sending out the gathered data
 185          *
 186          * @param       $resource       An XML resource pointer (currently ignored)
 187          * @param       $nodeName       Name of the node we want to finish
 188          * @return      void
 189          * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
 190          */
 191         protected function endElement ($resource, $nodeName) {
 192                 // Make all lower-case
 193                 $nodeName = strtolower($nodeName);
 194
 195                 // Does this match with current main node?
 196                 //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
 197                 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
 198                         // Did not match!
 199                         throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
 200                 } elseif (in_array($nodeName, $this->getSubNodes())) {
 201                         // Silently ignore sub nodes
 202                         return;
 203                 }
 204
 205                 // Construct method name
 206                 $methodName = 'finish' . $this->convertToClassName($nodeName);
 207
 208                 // Call the corresponding method
 209                 call_user_func_array(array($this, $methodName), array());
 210         }
 211
 212         /**
 213          * Adds the message text to the template engine
 214          *
 215          * @param       $resource               XML parser resource (currently ignored)
 216          * @param       $characters             Characters to handle
 217          * @return      void
 218          */
 219         protected function characterHandler ($resource, $characters) {
 220                 // Trim all spaces away
 221                 $characters = trim($characters);
 222
 223                 // Is this string empty?
 224                 if (empty($characters)) {
 225                         // Then skip it silently
 226                         return false;
 227                 } // END - if
 228
 229                 // Add the message now
 230                 $this->assignVariable('message', $characters);
 231         }
 232
 233         /**
 234          * Intializes the mail
 235          *
 236          * @return      void
 237          * @todo        Add cache creation here
 238          */
 239         private function initEmail () {
 240                 // Unfinished work!
 241         }
 242
 243         /**
 244          * Setter for mail data node
 245          *
 246          * @return      void
 247          * @todo        Should we call back the mailer class here?
 248          */
 249         private function setEmailMailData () {
 250                 // Set current main node
 251                 $this->currMainNode = 'mail-data';
 252         }
 253
 254         /**
 255          * Setter for sender address property
 256          *
 257          * @param       $senderAddress  Sender address to set in email
 258          * @return      void
 259          */
 260         private function setEmailPropertySenderAddress ($senderAddress) {
 261                 // Set the template variable
 262                 $this->assignVariable('sender', $senderAddress);
 263         }
 264
 265         /**
 266          * Setter for recipient address property
 267          *
 268          * @param       $recipientAddress       Recipient address to set in email
 269          * @return      void
 270          */
 271         private function setEmailPropertyRecipientAddress ($recipientAddress) {
 272                 // Set the template variable
 273                 $this->assignVariable('recipient', $recipientAddress);
 274         }
 275
 276         /**
 277          * Setter for subject line property
 278          *
 279          * @param       $subjectLine    Subject line to set in email
 280          * @return      void
 281          */
 282         private function setEmailPropertySubjectLine ($subjectLine) {
 283                 // Set the template variable
 284                 $this->assignVariable('subject', $subjectLine);
 285         }
 286
 287         /**
 288          * Method stub to avoid output
 289          *
 290          * @return      void
 291          */
 292         private function setEmailPropertyMessage () {
 293                 // Empty for now
 294         }
 295
 296         /**
 297          * Gets the template variable "message", stores it back as raw template data
 298          * and compiles all variables so the mail message got prepared for output
 299          *
 300          * @return      void
 301          */
 302         private function finishMailData () {
 303                 // Get the message and set it as new raw template data back
 304                 $message = $this->readVariable('message');
 305                 $this->setRawTemplateData($message);
 306
 307                 // Get some variables to compile
 308                 //$sender = $this->compileRawCode($this->readVariable('sender'));
 309                 //$this->assignVariable('sender', $sender);
 310
 311                 // Then compile all variables
 312                 $this->compileVariables();
 313         }
 314
 315         /**
 316          * Invokes the final mail process
 317          *
 318          * @return      void
 319          */
 320         private function finishTextMail () {
 321                 $this->getMailerInstance()->invokeMailDelivery();
 322         }
 323
 324         /**
 325          * Getter for image cache file (FQFN)
 326          *
 327          * @return      $fqfn   Full-qualified file name of the image cache
 328          * @todo        0% done
 329          */
 330         public function getMailCacheFqfn () {
 331                 // Initialize FQFN
 332                 $fqfn = '';
 333                 $this->debugBackTrace();
 334
 335                 // Return it
 336                 return $fqfn;
 337         }
 338
 339         /**
 340          * Setter for mailer instance
 341          *
 342          * @param       $mailerInstance         A mailer instance
 343          * @return      void
 344          */
 345         public final function setMailerInstance (DeliverableMail $mailerInstance) {
 346                 $this->mailerInstance = $mailerInstance;
 347         }
 348
 349         /**
 350          * Getter for mailer instance
 351          *
 352          * @return      $mailerInstance         A mailer instance
 353          */
 354         protected final function getMailerInstance () {
 355                 return $this->mailerInstance;
 356         }
 357
 358         /**
 359          * Outputs the mail to the world. This should only the mailer debug class do!
 360          *
 361          * @param       $responseInstance       An instance of a Responseable class
 362          * @return      void
 363          */
 364         public function transferToResponse (Responseable $responseInstance) {
 365                 $responseInstance->writeToBody($this->getCompiledData());
 366         }
 367 }
 368
 369 // [EOF]
 370 ?>