<?php
/*
This code is part of FusionDirectory (http://www.fusiondirectory.org/)
Copyright (C) 2014-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.
*/
/*!
* \file class_template.inc
* Source code for the class template
*/
/*! \brief Class for applying a template */
class template
{
protected $type;
protected $dn;
protected $needed;
protected $attrs;
protected $tabObject;
protected $attributes;
protected $applied = FALSE;
static protected $uiSpecialAttributes = array('dn','cn','uid','sn','givenName');
static function plInfo()
{
return array(
'plShortName' => _('Template'),
'plDescription' => _('Object template, used to create several objects with similar values'),
/* Categories for templates are computed in config class */
'plCategory' => array(),
'plProvidedAcls' => array(
'template_cn' => _('Template name')
)
);
}
static function getTemplatedTypes()
{
$result = array();
$types = objects::types();
foreach ($types as $type) {
if (in_array($type, departmentManagement::getDepartmentTypes())) {
continue;
}
$infos = objects::infos($type);
if ($infos['templateActive']) {
$result[$type] = $infos['name'];
}
}
asort($result);
return $result;
}
function __construct($type, $dn, $targetdn = NULL)
{
$this->type = $type;
$this->dn = $dn;
list($this->attrs, $depends) = templateHandling::fetch($this->dn);
$this->needed = templateHandling::neededAttrs($this->attrs, $depends);
$this->needed[] = 'base';
if ($targetdn === NULL) {
$this->tabObject = objects::create($this->type);
} else {
trigger_error("This should not be used for now");
$this->tabObject = objects::open($this->dn, $this->type);
}
$tempTabObject = objects::open($this->dn, $this->type); /* Used to know which tab is activated */
$this->attributes = array();
$tempTabObject->setActiveTabs($this->tabObject);
foreach ($this->tabObject->by_object as $class => $tab) {
if ($tab->is_account || $tab->ignore_account) {
$this->attributes[$class] = array();
$attrs = array_unique(array_merge($tab->getRequiredAttributes(), $this->needed));
foreach (array_keys($tab->attributesAccess) as $attr) {
if (!$tab->showInTemplate($attr, $this->attrs)) {
continue;
}
if (in_array($attr, $attrs)) {
$this->attributes[$class][] = $attr;
}
}
}
}
}
/*! \brief Used when you need to re-apply the same template with different values */
function reset()
{
list($this->attrs, $depends) = templateHandling::fetch($this->dn);
// This is needed because it removes %askme% values from attrs
$this->needed = templateHandling::neededAttrs($this->attrs, $depends);
$this->needed[] = 'base';
$this->tabObject = objects::create($this->type);
/* Used to know which tab is activated */
$tempTabObject = objects::open($this->dn, $this->type);
foreach ($tempTabObject->by_object as $class => $plugin) {
if ($plugin->is_account || $plugin->ignore_account) {
$this->tabObject->by_object[$class]->is_account = $plugin->is_account;
}
}
$this->applied = FALSE;
}
function getDn()
{
return $this->dn;
}
function getBase()
{
if (is_object($this->tabObject)) {
return $this->tabObject->getBaseObject()->base;
} else {
$infos = objects::infos($this->type);
return dn2base($this->dn, 'ou=templates,'.$infos['ou']);
}
}
function getNeeded()
{
return $this->attributes;
}
function serialize()
{
$ret = array();
foreach ($this->tabObject->by_object as $class => $plugin) {
if (!isset($this->attributes[$class])) {
continue;
}
$ret[$class] = array('name' => $this->tabObject->by_name[$class], 'attrs' => array());
foreach ($this->attributes[$class] as $attr) {
$plugin->attributesAccess[$attr]->serializeAttribute($ret[$class]['attrs'], FALSE);
}
$ret[$class]['attrs_order'] = array_keys($ret[$class]['attrs']);
}
return $ret;
}
function deserialize($values)
{
foreach ($values as $class => $class_values) {
$result = $this->tabObject->by_object[$class]->deserializeValues($class_values);
if ($result !== TRUE) {
return $result;
}
}
return TRUE;
}
function save_object()
{
foreach ($this->tabObject->by_object as $plugin) {
$plugin->save_object();
}
}
public function dialogOpened ()
{
return $this->tabObject->dialogOpened();
}
function execute()
{
$smarty = get_smarty();
$sections = array();
$posted = array();
$smarty->assign('baseACL', 'rw');
foreach ($this->tabObject->by_object as $class => &$plugin) {
if (!isset($this->attributes[$class])) {
continue;
}
if ($plugin->is_modal_dialog()) {
$dialogResult = $plugin->dialog->execute();
if ($dialogResult === FALSE) {
$plugin->closeDialog();
} else {
$this->tabObject->current = $class;
return $dialogResult;
}
}
$attributesRendered = array();
foreach ($this->attributes[$class] as $attr) {
if ($plugin->attributesAccess[$attr]->getAclInfo() !== FALSE) {
// We assign ACLs so that attributes can use them in their template code
$smarty->assign($plugin->attributesAccess[$attr]->getAcl().'ACL', $plugin->aclGetPermissions($plugin->attributesAccess[$attr]->getAcl()));
}
$plugin->attributesAccess[$attr]->renderAttribute($attributesRendered, FALSE);
}
$smarty->assign('section', $class);
$smarty->assign('sectionId', $class);
$smarty->assign('sectionClasses', ' fullwidth');
$smarty->assign('attributes', $attributesRendered);
$posted[] = $class.'_posted';
$sections[] = $smarty->fetch(get_template_path('simpleplugin_section.tpl'));
}
unset($plugin);
$smarty->assign('sections', $sections);
$smarty->assign('hiddenPostedInput', $posted);
$smarty->assign('focusedField', '');
return $smarty->fetch(get_template_path('simpleplugin.tpl'));
}
/* Apply template and current values to an object and returns it for saving or edition
* Cannot be called twice! If you need to, call reset between calls */
function apply($targetdn = NULL)
{
if ($this->applied) {
trigger_error('Templates can’t be applied twice without calling reset before');
return;
}
if ($targetdn !== NULL) {
$this->tabObject = objects::open($targetdn, $this->type);
unset($this->attrs['objectClass']['count']);
foreach ($this->tabObject->by_object as $class => $plugin) {
if ($plugin->is_account || $plugin->ignore_account) {
$this->attrs['objectClass'] = $plugin->mergeObjectClasses($this->attrs['objectClass']);
}
}
}
foreach ($this->tabObject->by_object as $class => &$plugin) {
if (!isset($this->attributes[$class])) {
continue;
}
foreach ($this->attributes[$class] as $attr) {
$plugin->attributesAccess[$attr]->fillLdapValue($this->attrs);
}
}
unset($plugin);
foreach ($this->tabObject->by_object as $class => &$plugin) {
if (!isset($this->attributes[$class])) {
continue;
}
foreach ($this->attributes[$class] as $attr) {
$plugin->attributesAccess[$attr]->fillLdapValueHook($this->attrs);
}
}
unset($plugin);
foreach ($this->attrs as &$array) {
if (!is_array($array)) {
$array = array($array);
}
if (!isset($array['count'])) {
$array['count'] = count($array);
}
}
unset($array);
$ui = get_userinfo();
$specialAttrs = array();
foreach (static::$uiSpecialAttributes as $attr) {
$specialAttrs['caller'.strtoupper($attr)] = $ui->$attr;
}
$this->attrs = templateHandling::parseArray($this->attrs, $specialAttrs);
$this->tabObject->adapt_from_template($this->attrs, array_merge(...$this->attributes));
$this->applied = TRUE;
return $this->tabObject;
}
}