Html.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\Controller\View;

class Html extends \Rsi\Fred\Controller\View{

  const RESOURCE_NO_PUSH = 1; //!< Do not add a push header for the resource.
  const RESOURCE_PROXY = 2; //!< Serve the resource through the proxy component.
  const RESOURCE_ASYNC = 4; //!< Serve the resource with the asynchronous attribute.
  const RESOURCE_DEFER = 8; //!< Serve the resource with the deferred attribute.

  public $convert = true;

  public $debugMinifyProbability = 4; //!< Chance (1 in x) for using minified file in debug mode.
  public $asyncPrefix = '@'; //!< Resource ID prefix to indicate asynchronous loading.
  public $deferPrefix = '$'; //!< Resource ID prefix to indicate deferred loading.
  public $integrityAlgo = 'sha256'; //!< Hashing algorithm to use for subresource integrity (empty = do not use).
  public $widgetClassNames = []; //!< View widget class name (value) per widget class name (key).
  public $defaultWidgetNamespace = __CLASS__ . '\\Widget';
  public $defaultWidgetClassName = __CLASS__ . '\\Widget';
  public $renderedWidgetIds = [];
  public $builderClassNames = [null => __CLASS__ . '\\Builder']; //!< Default builder class name per client type (null =
    // default).
  public $actionCaptionPrefix = 'action'; //!< Prefix to prepend to the action name to get a translation ID.
  public $defaultTemplatePath = null;
  public $formClass = 'fred';
  public $formInvalidMessage = null;

  protected $_integrityCacheFile = null;
  protected $_integrityHashes = null;

  protected $_style = [];
  protected $_styleSrc = [];
  protected $_script = [];
  protected $_scriptInit = [];
  protected $_scriptSrc = [];
  protected $_noPush = [];
  protected $_widgets = [];
  protected $_template = null;

  protected function init(){
    parent::init();
    $this->publish('template');
  }

  protected function addResource(&$resource,$id,$value,$options = null){
    if(!$id) $id = count($resource);
    if($options & self::RESOURCE_PROXY) $this->_noPush[] = $value = $this->component('proxy')->add($value);
    elseif($options & self::RESOURCE_NO_PUSH) $this->_noPush[] = $value;
    if($options & self::RESOURCE_ASYNC) $id = $this->asyncPrefix . $id;
    elseif($options & self::RESOURCE_DEFER) $id = $this->deferPrefix . $id;
    $resource[$id] = $value;
  }

  public function addStyle($style,$id = null){
    $this->addResource($this->_style,$id,$style);
  }

  public function addStyleSrc($source,$id = null,$options = null){
    $this->addResource($this->_styleSrc,$id,$source,$options);
  }

  public function addScript($script,$id = null){
    $this->addResource($this->_script,$id,$script);
  }

  public function addScriptInit($script,$id = null){
    $this->addResource($this->_scriptInit,$id,$script);
  }

  public function addScriptSrc($source,$id = null,$options = null){
    $this->addResource($this->_scriptSrc,$id,$source,$options);
  }

  protected function integrity($resource,$hash = null){
    if($this->_integrityHashes === null){
      $this->_integrityHashes = [];
      if($this->_integrityCacheFile){
        try{
          $this->_integrityHashes = include($this->_integrityCacheFile);
        }
        catch(\Exception $e){
          $this->component('log')->info($e);
        }
        if($hash){
          $this->_integrityHashes[$resource] = $this->integrityAlgo . '-' . base64_encode($hash);
          file_put_contents($this->_integrityCacheFile,'<?php return ' . var_export($this->_integrityHashes,true) . ';');
        }
      }
    }
    return $this->_integrityHashes[$resource] ?? false;
  }

  public function minifyFiles($type,$sources,$target = null,$id = null,$options = null){
    $target = $this->minifiedPath . $target;
    $root = \Rsi\Http::docRoot();
    $resource = substr($target,strlen($root));
    $func = [$this,'add' . ucfirst($type) . 'Src'];
    if(!$this->_fred->debug || !rand(0,$this->debugMinifyProbability)) return call_user_func($func,$resource,$id,$options);
    $this->component('minify')->handler($type)->files(\Rsi\Record::prefix($sources,$root),$target);
    if($this->integrityAlgo) $this->integrity($resource,hash_file($this->integrityAlgo,$target,true));
    foreach($sources as $source) call_user_func($func,$source,null,$options);
  }

  public function minifyScripts($sources,$target = null,$id = null,$options = null){
    $this->minifyFiles('script',$sources,$target,$id,$options);
  }

  public function minifyStyles($sources,$target = null,$id = null,$options = null){
    $this->minifyFiles('style',$sources,$target,$id,$options);
  }

  public function head(){
    $html = $this->component('html');
    $location = $this->component('location');
    $head = $this->title ? $html->_title($this->title) : null;
    foreach($this->_styleSrc as $source){
      $url = $location->rewrite($source);
      $push = !in_array($source,$this->_noPush) && \Rsi\Http::pushHeader($url,'style');
      $head .= $html->style(null,[
        'integrity' => $push ? false : $this->integrity($url)
      ],$url);
    }
    if($this->_style) $head .= $html->style(implode("\n",$this->_style));
    foreach($this->_scriptSrc as $id => $source){
      $url = $location->rewrite($source);
      $push = !in_array($source,$this->_noPush) && \Rsi\Http::pushHeader($url,'script');
      $head .= $html->script(null,[
        'async' => \Rsi\Str::startsWith($id,$this->asyncPrefix),
        'defer' => \Rsi\Str::startsWith($id,$this->deferPrefix),
        'integrity' => $push ? false : $this->integrity($url)
      ],$url);
    }
    return $head;
  }

  public function script(){
    $client_config = array_merge($this->_fred->clientConfig(),$extra_config = [
      'controller' => $this->_controller->clientConfig()
    ]);
    $session = new \Rsi\Fred\Component\Session(get_class());
    $local_config = $session->localConfig ?: [];
    $session->localConfig = array_merge($local_config,$client_config);
    if($session->configCheck && ($session->configCheck == \Rsi\Http::getCookie('fred-configCheck'))){
      foreach($client_config as $name => &$config) if(
        ($this->_fred->has($name) || array_key_exists($name,$extra_config)) &&
        ($config === \Rsi\Record::get($local_config,$name))
      ) $config = null;
      unset($config);
    }
    $client_config['check'] = $session->configCheck = \Rsi\Str::random(8);
    if($this->mobile) $client_config['mobile'] = true;
    return ($this->_fred->debug ? '"use strict";' : '') . '
      var fred;
      document.addEventListener("DOMContentLoaded",function(){' .
        implode("\n",$this->_script) . '
        fred = new rsi.Fred(' . $this->jsonEncode($client_config) . ');' .
        ($this->_scriptInit ? '
        $(document).on("init.fred",function(){
          ' . implode("\n",$this->_scriptInit) . '
        });' : '') . '
        fred.init();
      },false);';
  }
  /**
   * Create a view widget.
   * First the complete model widget class name is looked up in the widgetClassNames. If not found this is retried with only
   * the basename. If not found the basename is sought in the defaultWidgetNamespace, and the same goes for the client config
   * class name (stripped from the default model widget namespace). If still no result, the defaultWidgetClassName is used.
   * @param string $id  Widget ID.
   * @param \\Rsi\\Fred\\Conroller\\Widget $widget  Model widget.
   * @return \\Rsi\\Fred\\Controller\\View\\Html\\Widget
   */
  public function createWidget($id,$widget){
    $widget_class_name = get_class($widget);
    if(
      array_key_exists($widget_class_name,$this->widgetClassNames) ||
      array_key_exists($widget_class_name = \Rsi\File::basename($widget_class_name),$this->widgetClassNames)
    ) $class_name = $this->widgetClassNames[$widget_class_name];
    elseif(
      !class_exists($class_name = $this->defaultWidgetNamespace . '\\' . $widget_class_name) &&
      !class_exists($class_name = $this->defaultWidgetNamespace . '\\' . str_replace($this->_controller->defaultWidgetNamespace . '\\','',\Rsi\Record::get($widget->clientConfig(),\Rsi\Fred\Controller\Widget::CLASS_NAME)))
    ) $class_name = $this->defaultWidgetClassName;
    return new $class_name($id,$this,$widget);
  }

  public function widget($id){
    if(!array_key_exists($id,$this->_widgets)) $this->_widgets[$id] = $this->createWidget($id,$this->_controller->widgets[$id]);
    return $this->_widgets[$id];
  }

  public function notRenderedWidgetIds($ids = null){
    return array_diff(is_array($ids) ? $ids : array_keys($this->_controller->widgets),$this->renderedWidgetIds);
  }

  public function renderWidget($id){
    $this->renderedWidgetIds[] = $id;
    $value = null;
    $raw = false;
    $request = $this->_fred->request;
    if(array_key_exists($id,$request->data))
      $value = $request->data[$id];
    elseif($raw = array_key_exists($id,$request->errors))
      $value = $request->get($id);
    else
      $value = $this->_controller->widgets[$id]->defaultValue;
    return $this->widget($id)->render($value,$raw);
  }
  /**
   * Render the widgets.
   * @param array $ids  ID's of the widgets to render (default = all not rendered yet).
   * @param Rsi\Fred\Controller\View\Html\Builder $builder  Builder to use (uses builderClassNames to create a new if empty).
   * @return string  Rendered HTML.
   */
  protected function renderWidgets($ids = null,$builder = null){
    if(!$ids) $ids = $this->notRenderedWidgetIds();
    if(!$ids) return null;
    if(!$builder){
      $class_name = array_key_exists($type = $this->_fred->client->type ?: null,$this->builderClassNames)
        ? $this->builderClassNames[$type]
        : $this->builderClassNames[null];
      $builder = new $class_name($this);
    }
    return $builder->build($ids);
  }

  protected function renderFormAction($action){
    return $this->component('html')->button(
      $this->component('trans')->id($this->actionCaptionPrefix . $action,null,$action),
      ['type' => 'submit','id' => 'action' . ucfirst($action),'name' => 'action','value' => $action,'class' => 'action']
    );
  }

  protected function renderFormActions(){
    $content = '';
    foreach($this->_controller->actions('form') as $action) $content .= $this->renderFormAction($action);
    return $this->component('html')->div($content,null,'fred-actions');
  }
  /**
   * Render the form.
   * @param string $content  The content for the form (default = all widgets).
   * @return string  HTML for the form.
   */
  protected function renderForm($content = null){
    if($content === null) $content = $this->renderWidgets() . $this->renderFormActions();
    return $this->component('html')->form($content,['class' => $this->formClass],$this->_controller->route());
  }

  public function render(){
    if($fragment = $this->_controller->fragmentId){
      if(($str = $this->component('trans')->fragment($fragment)) !== false) print($str);
      elseif(method_exists($this,$method = 'fragment' . ucfirst($fragment))) print(call_user_func([$this,$method]));
      else $this->_fred->externalError('Unknown fragment',['class' => get_called_class(),'fragment' => $fragment]);
    }
    elseif($redir = $this->_fred->request->redir) \Rsi\Http::redirHeader($redir);
    else require($this->template ?: $this->defaultTemplatePath . \Rsi\File::basename(strtolower(get_called_class())) . '.php');
  }

  protected function getMobile(){
    return $this->_fred->client->mobile;
  }

}