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

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