class_helpersAttribute.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 TestValidateAttribute extends StringAttribute
{
  protected $testFunc = '';

  function validate ()
  {
    $func = $this->testFunc;
    if (!tests::$func($this->value)) {
      return new SimplePluginCheckError(
        $this,
        SimplePluginCheckError::invalidValue(sprintf('"%s"', $this->value))
      );
    }
  }
}

class MailAttribute extends TestValidateAttribute
{
  protected $trim       = TRUE;
  protected $testFunc   = 'is_email';
  protected $inputType  = 'email';
}

class HostNameAttribute extends TestValidateAttribute
{
  protected $testFunc = 'is_valid_hostname';
}

class UidAttribute extends TestValidateAttribute
{
  protected $testFunc = 'is_uid';
}

class PathAttribute extends TestValidateAttribute
{
  protected $trim = TRUE;

  protected $testFunc = 'is_path';
}

class URLAttribute extends TestValidateAttribute
{
  protected $trim       = TRUE;
  protected $testFunc   = 'is_url';
  protected $inputType  = 'url';
}

class IPAttribute extends TestValidateAttribute
{
  protected $trim = TRUE;

  protected $testFunc = 'is_ip';
}

class IPv4Attribute extends TestValidateAttribute
{
  protected $trim = TRUE;

  protected $testFunc = 'is_ipv4';
}

class IPv6Attribute extends TestValidateAttribute
{
  protected $trim = TRUE;

  protected $testFunc = 'is_ipv6';
}

class MacAddressAttribute extends StringAttribute
{
  protected $trim = TRUE;

  function __construct ($label, $description, $ldapName, $required = FALSE, $defaultValue = '', $acl = '')
  {
    parent::__construct($label, $description, $ldapName, $required, $defaultValue, $acl, '/^([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2}$/', '5E:FF:56:A2:AF:15');
  }

  function setValue ($value)
  {
    return parent::setValue(strtolower($value));
  }
}

class CharSeparatedCompositeAttribute extends CompositeAttribute
{
  private $sep;

  function __construct ($description, $ldapName, $attributes, $sep, $acl = "", $label = "Composite attribute")
  {
    parent::__construct($description, $ldapName, $attributes, '', '', $acl, $label);
    $this->sep = $sep;
  }

  function readValues (string $value): array
  {
    return explode($this->sep, $value);
  }

  function writeValues (array $values)
  {
    return join($this->sep, $values);
  }
}

class PipeSeparatedCompositeAttribute extends CharSeparatedCompositeAttribute
{
  function __construct ($description, $ldapName, $attributes, $acl = "", $label = "Composite attribute")
  {
    parent::__construct($description, $ldapName, $attributes, '|', $acl, $label);
  }
}

class CommaListAttribute extends CompositeAttribute
{
  private $sep = ',';

  function __construct ($ldapName, $attribute, $sep = ',')
  {
    parent::__construct(
      $attribute->getDescription(), $ldapName,
      [
        $attribute
      ], '', ''
    );
    $this->sep = $sep;
  }

  function readValues (string $value): array
  {
    if ($value == '') {
      return [[]];
    } else {
      return [explode($this->sep, $value)];
    }
  }

  function writeValues (array $values)
  {
    return join($this->sep, $values[0]);
  }
}

class UnitIntAttribute extends CompositeAttribute
{
  /* $units should contains 1 in its keys as a fallback unit */
  function __construct ($label, $description, $ldapName, $required, $units, $min = FALSE, $max = FALSE, $defaultValue = "", $acl = "")
  {
    parent::__construct($description, $ldapName,
      [
        new IntAttribute('', '', $ldapName.'_int', $required, $min, $max, $defaultValue),
        new SelectAttribute('', '', $ldapName.'_select', TRUE, array_keys($units), '', array_values($units)),
      ], '', '',
      $acl, $label
    );
    $this->setLinearRendering(TRUE);
    $this->setRequired($required); /* As we use linear rendering we want the asterisk in the label if required */
  }

  function readValues (string $value): array
  {
    $choices = $this->attributes[1]->getChoices();
    sort($choices);
    if (($value === '') || ($value == 0)) {
      return [$value, $choices[0]];
    }
    /* Find the appropriate unit */
    for (
      $i = (count($choices) - 1);
      ($value % $choices[$i] != 0) && ($i > 0);
      $i--
    );
    return [$value / $choices[$i], $choices[$i]];
  }

  function writeValues (array $values)
  {
    if ($values[0] === '') {
      return '';
    }
    return $values[0] * $values[1];
  }

  function displayValue ($value): string
  {
    $values = $this->readValues($value);
    return $values[0].$this->attributes[1]->displayValue($values[1]);
  }
}

class BytesSizeAttribute extends UnitIntAttribute
{
  function __construct ($label, $description, $ldapName, $required, $min = FALSE, $max = FALSE, $defaultValue = "", $acl = "")
  {
    $units = [
      1         => _('B'),
      1024 ** 1 => _('KiB'),
      1024 ** 2 => _('MiB'),
      1024 ** 3 => _('GiB'),
      1024 ** 4 => _('TiB'),
    ];
    parent::__construct($label, $description, $ldapName, $required, $units, $min, $max, $defaultValue, $acl);
  }
}

class TimeAttribute extends UnitIntAttribute
{
  function __construct ($label, $description, $ldapName, $required, $min = FALSE, $max = FALSE, $defaultValue = "", $acl = "")
  {
    $units = [
      1     => _('seconds'),
      60    => _('minutes'),
      3600  => _('hours'),
      86400 => _('days'),
    ];
    parent::__construct($label, $description, $ldapName, $required, $units, $min, $max, $defaultValue, $acl);
  }
}