class_StringAttribute.inc

<?php
/*
  This code is part of FusionDirectory (http://www.fusiondirectory.org/)
  Copyright (C) 2012-2016  FusionDirectory

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/

class StringAttribute extends \FusionDirectory\Core\SimplePlugin\Attribute
{
  protected $pattern;
  protected $example;
  protected $autocomplete = NULL;
  protected $trim         = FALSE;
  protected $inputType    = 'text';
  protected $html5pattern = NULL;

  function __construct ($label, $description, $ldapName, $required = FALSE, $defaultValue = "", $acl = "", $regexp = "", $example = NULL)
  {
    parent::__construct($label, $description, $ldapName, $required, $defaultValue, $acl);
    $this->setPattern($regexp);
    $this->example = ($example === NULL ? $defaultValue : $example);
  }

  function setExample ($example)
  {
    $this->example = $example;
  }

  public function getExample ()
  {
    return $this->example;
  }

  function setPattern ($pattern)
  {
    $this->pattern = $pattern;
    if (preg_match('/^(.)\^(.*)\$\1$/', $pattern, $m)) {
      /* Only convert anchored patterns
       * First and last characters are the same means no modifiers are in use
       */
      $this->html5pattern = $m[2];
    } else {
      $this->html5pattern = NULL;
    }
  }

  function renderFormInput (): string
  {
    $id = $this->getHtmlId();
    $attributes = [
      'value' => $this->getValue()
    ];
    if (!empty($this->managedAttributes)) {
      $js       = $this->managedAttributesJS();
      $attributes['onChange'] = 'javascript:'.$js;
    }
    if ($this->autocomplete !== NULL) {
      $attributes['autocomplete'] = $this->autocomplete;
    }
    if ($this->html5pattern !== NULL) {
      $attributes['pattern'] = $this->html5pattern;
    }
    if ($this->isSubAttribute) {
      $attributes['class'] = 'subattribute';
    } elseif ($this->isRequired()) {
      $attributes['required'] = 'required';
    }
    $display  = $this->renderInputField($this->inputType, $id, $attributes);
    return $this->renderAcl($display);
  }

  function renderTemplateInput (): string
  {
    $id = $this->getHtmlId();
    $attributes = [
      'value' => $this->getValue()
    ];
    if ($this->autocomplete !== NULL) {
      $attributes['autocomplete'] = $this->autocomplete;
    }
    if ($this->isSubAttribute) {
      $attributes['class'] = 'subattribute';
    }
    $display  = $this->renderInputField('text', $id, $attributes);
    return $this->renderAcl($display);
  }

  function fixPostValue ($value)
  {
    /* Replace CRLF by LF, to avoid non-ASCII chars in multiline values (mainly useful for textarea) */
    return str_replace(["\r\n", "\r"], "\n", $value);
  }

  function check ()
  {
    $error = parent::check();
    if (!empty($error)) {
      return $error;
    } else {
      if ($this->value !== "") {
        return $this->validate();
      }
    }
  }

  function validate ()
  {
    if (($this->pattern !== '') && !preg_match($this->pattern, $this->value)) {
      return new SimplePluginCheckError(
        $this,
        SimplePluginCheckError::invalidValue(sprintf('"%s"', $this->getValue()))
      );
    }
  }

  function setAutocomplete ($autocomplete)
  {
    if (is_bool($autocomplete)) {
      $this->autocomplete = ($autocomplete ? 'on' : 'off');
    } else {
      $this->autocomplete = $autocomplete;
    }
  }

  function getAutocomplete ()
  {
    return $this->autocomplete;
  }

  function checkValue ($value)
  {
    if (!is_scalar($value) && (!is_object($value) || !method_exists($value, '__toString'))) {
      throw new InvalidValueException(sprintf(_('StringAttribute "%s" was set to a non-compatible value'), $this->getLabel()));
    }
  }

  function setValue ($value)
  {
    if ($this->trim) {
      return parent::setValue(trim($value));
    } else {
      return parent::setValue($value);
    }
  }
}

class TrimmedStringAttribute extends StringAttribute
{
  protected $trim = TRUE;
}

class TextAreaAttribute extends StringAttribute
{
  function renderFormInput (): string
  {
    $id = $this->getHtmlId();
    $display  = '<textarea name="'.$id.'" id="'.$id.'"'.
                ($this->disabled ? ' disabled="disabled"' : '').
                ($this->isSubAttribute ? ' class="subattribute"' : ($this->isRequired() ? ' required="required"' : '')).
                '>'.
                '{literal}'.htmlescape($this->getValue()).'{/literal}</textarea>';
    return $this->renderAcl($display);
  }

  function renderTemplateInput (): string
  {
    $id = $this->getHtmlId();
    $display  = '<textarea name="'.$id.'" id="'.$id.'"'.
                ($this->disabled ? ' disabled="disabled"' : '').
                ($this->isSubAttribute ? ' class="subattribute"' : '').
                '>'.
                '{literal}'.htmlescape($this->getValue()).'{/literal}</textarea>';
    return $this->renderAcl($display);
  }
}

class PasswordAttribute extends StringAttribute
{
  protected $autocomplete = 'new-password';
  protected $inputType    = 'password';
}