HtmlFormat.php

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2020 wemove digital solutions GmbH
 *
 * Licensed under the terms of the MIT License.
 *
 * See the LICENSE file distributed with this work for
 * additional information.
 */
namespace wcmf\lib\presentation\format\impl;
 
use wcmf\lib\config\ConfigurationException;
use wcmf\lib\core\ObjectFactory;
use wcmf\lib\persistence\ObjectId;
use wcmf\lib\presentation\format\impl\AbstractFormat;
use wcmf\lib\presentation\Request;
use wcmf\lib\presentation\Response;
use wcmf\lib\util\StringUtil;
 
/**
 * HtmlFormat implements the HTML request/response format. Since all data
 * from the external representation arrives in form fields, grouping of values
 * has to be done via the field names. So Nodes are represented by their values
 * whose field names are of the form value-`language`-`name`-`oid`. All of these
 * values will be removed from the request and replaced by Node instances
 * representing the data. Each node is stored under its object id in the data array.
 *
 * HtmlFormat serializes the response to a template, which will be rendered
 * by the View implementation defined in the configuration section 'view'.
 * The template is determined by the current action key. The response property
 * 'html_tpl_format' allows to select a specific version of that template file. E.g.
 * if the template would be home.tpl, setting the 'html_tpl_format' property
 * to 'mobile' would select the template home-mobile.tpl. If a version does
 * not exist, it is ignored and the default template is used.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class HtmlFormat extends AbstractFormat {
 
  private static $inputFieldNameDelimiter = '-';
  private static $sharedView = null;
 
  /**
   * @see Format::getMimeType()
   */
  public function getMimeType(Response $response=null) {
    return 'text/html';
  }
 
  /**
   * @see Format::isCached()
   */
  public function isCached(Response $response) {
    if (self::$sharedView == null) {
      self::$sharedView = ObjectFactory::getInstance('view');
    }
    $templateFile = $this->getTemplateFile($response);
    $cacheId = $response->getCacheId();
    return self::$sharedView->isCached($templateFile, $cacheId);
  }
 
  /**
   * @see Format::getCacheDate()
   */
  public function getCacheDate(Response $response) {
    if (self::$sharedView == null) {
      self::$sharedView = ObjectFactory::getInstance('view');
    }
    $templateFile = $this->getTemplateFile($response);
    $cacheId = $response->getCacheId();
    return self::$sharedView->getCacheDate($templateFile, $cacheId);
  }
 
  /**
   * @see AbstractFormat::deserializeValues()
   */
  protected function deserializeValues(Request $request) {
    // construct nodes from values serialized as form fields
    // nodes are encoded in separated fields with names value-<language>-<name>-<oid>
    $values = $request->getValues();
    foreach ($values as $key => $value) {
      $valueDef = self::getValueDefFromInputControlName($key);
      if ($valueDef != null) {
        // fix oid parameter (PHP replaces dots by underscore)
        $oidStr = preg_replace('/_/', '.', $valueDef['oid']);
        $oid = ObjectId::parse($oidStr);
        if ($oid) {
          $node = &$this->getNode($oid);
          $mapper = $node->getMapper();
          $pkNames = $mapper->getPkNames();
          $valueName = $valueDef['name'];
          if ($mapper->hasAttribute($valueName) && !in_array($valueName, $pkNames)) {
            $node->setValue($valueName, $value);
          }
          unset($values[$key]);
          $values[$oidStr] = $node;
        }
      }
    }
    return $values;
  }
 
  /**
   * @see AbstractFormat::serializeValues()
   */
  protected function serializeValues(Response $response) {
    // create the view
    $view = ObjectFactory::getInstance('view');
 
    // assign the response data to the view
    $values = $response->getValues();
    foreach ($values as $key => $value) {
      $view->setValue($key, $value);
    }
 
    // display the view
    $templateFile = $this->getTemplateFile($response);
    $view->render($templateFile, $response->getCacheId(), $response->getCacheLifetime());
 
    return $values;
  }
 
  /**
   * Get the object value definition from a HTML input field name.
   * @param $name The name of input field in the format value-`language`-`name`-`oid`, where name is the name
   *              of the attribute belonging to the node defined by oid
   * @return An associative array with keys 'oid', 'language', 'name' or null if the name is not valid
   */
  protected static function getValueDefFromInputControlName($name) {
    if (strpos($name, 'value') !== 0) {
      return null;
    }
    $def = [];
    $fieldDelimiter = StringUtil::escapeForRegex(self::$inputFieldNameDelimiter);
    $pieces = preg_split('/'.$fieldDelimiter.'/', $name);
    if (sizeof($pieces) != 4) {
      return null;
    }
    array_shift($pieces);
    $def['language'] = array_shift($pieces);
    $def['name'] = array_shift($pieces);
    $def['oid'] = array_shift($pieces);
 
    return $def;
  }
 
  /**
   * Get the template file for the given response
   * @param $response
   */
  protected function getTemplateFile(Response $response) {
    if (self::$sharedView == null) {
      self::$sharedView = ObjectFactory::getInstance('view');
    }
    // check if a view template is defined, prefer template property over configuration
    $viewTpl = $response->getProperty('html_tpl_file') !== null ? $response->getProperty('html_tpl_file') :
      self::$sharedView->getTemplate($response->getSender(),
                  $response->getContext(), $response->getAction());
    if (!$viewTpl) {
      throw new ConfigurationException("View definition missing for ".
                  "response: ".$response->__toString());
    }
 
    // check for html_format property in response
    // and add the suffix if existing
    $viewTplFile = WCMF_BASE.$viewTpl;
    $format = $response->getProperty('html_tpl_format');
    if (isset($format)) {
      $ext = pathinfo($viewTplFile, PATHINFO_EXTENSION);
      $formatViewTplFile = dirname($viewTplFile).'/'.basename($viewTplFile, ".$ext").'-'.$format.'.'.$ext;
    }
 
    // give precedence to format specific file
    $finalTplFile = isset($formatViewTplFile) && file_exists($formatViewTplFile) ?
            $formatViewTplFile : $viewTplFile;
    $response->setProperty('html_tpl', $finalTplFile);
    return $finalTplFile;
  }
}
?>