LDAPAccountManager/lam/lib/persistence.inc

386 lines
9.5 KiB
PHP
Raw Normal View History

2020-04-12 10:39:52 +00:00
<?php
namespace LAM\PERSISTENCE;
2020-04-12 19:51:19 +00:00
use LAMCfgMain;
2020-04-19 18:40:40 +00:00
use LAMConfig;
2020-04-12 19:51:19 +00:00
use LAMException;
2020-05-03 08:32:35 +00:00
use function LAM\PROFILES\getAccountProfiles;
use function LAM\PROFILES\loadAccountProfile;
use function LAM\PROFILES\saveAccountProfile;
2020-04-12 19:51:19 +00:00
2020-04-12 10:39:52 +00:00
/*
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
Copyright (C) 2020 Roland Gruber
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* This file includes functions to manage the persistence of LAM's configuration files.
*
* @package configuration
* @author Roland Gruber
*/
include_once __DIR__ . '/config.inc';
2020-05-03 08:32:35 +00:00
include_once __DIR__ . '/profiles.inc';
2020-04-12 10:39:52 +00:00
/**
2020-04-12 19:51:19 +00:00
* Exporter for LAM's configuration data.
2020-04-12 10:39:52 +00:00
*/
class ConfigDataExporter {
/**
* Exports LAM's configuration data in JSON format.
*/
public function exportAsJson() {
2020-04-13 13:40:33 +00:00
$mainCfg = $this->_getMainConfiguration();
2020-04-12 10:39:52 +00:00
$jsonData = array();
2020-04-13 13:40:33 +00:00
$jsonData['mainConfig'] = $this->_getMainConfigData($mainCfg);
$jsonData['certificates'] = $this->_getCertificates($mainCfg);
2020-05-03 08:32:35 +00:00
$serverProfileNames = getConfigProfiles();
$serverProfiles = array();
foreach ($serverProfileNames as $serverProfileName) {
$serverProfiles[$serverProfileName] = new \LAMConfig($serverProfileName);
}
$jsonData['serverProfiles'] = $this->_getServerProfiles($serverProfiles);
$jsonData['accountProfiles'] = $this->_getAccountProfiles($serverProfiles);
2020-04-13 13:40:33 +00:00
/**
* TODO
*
* account profiles
* PDF profiles
* self service profiles
2020-04-19 18:40:40 +00:00
* webauthn
2020-04-13 13:40:33 +00:00
*/
2020-04-12 10:39:52 +00:00
return json_encode($jsonData);
}
2020-04-13 13:40:33 +00:00
/**
* Returns the main configuration.
*
* @return LAMCfgMain main config
*/
public function _getMainConfiguration() {
return new LAMCfgMain();
}
2020-04-12 10:39:52 +00:00
/**
* Internal function to read master configuration.
*
2020-04-13 13:40:33 +00:00
* @param LAMCfgMain $mainCfg main config
2020-04-12 10:39:52 +00:00
* @return array data
*/
2020-04-13 13:40:33 +00:00
public function _getMainConfigData($mainCfg) {
2020-04-12 10:39:52 +00:00
return $mainCfg->exportData();
}
2020-04-13 13:40:33 +00:00
/**
* Returns the certificate file content.
*
* @param LAMCfgMain $mainCfg main config
* @return array data
*/
public function _getCertificates($mainCfg) {
return $mainCfg->exportCertificates();
}
2020-04-19 18:40:40 +00:00
/**
* Returns the content of the server profiles.
*
2020-05-03 08:32:35 +00:00
* @param array $serverProfiles list of server profiles (name => object)
2020-04-19 18:40:40 +00:00
* @return array $data
*/
2020-05-03 08:32:35 +00:00
public function _getServerProfiles($serverProfiles) {
2020-04-19 18:40:40 +00:00
$data = array();
2020-05-03 08:32:35 +00:00
foreach ($serverProfiles as $profileName => $serverProfile) {
2020-04-19 18:40:40 +00:00
$data[$profileName] = $serverProfile->exportData();
}
return $data;
}
2020-05-03 08:32:35 +00:00
/**
* Returns the content of the account profiles.
*
* @param array $serverProfiles list of server profiles (name => object)
* @return array $data
*/
public function _getAccountProfiles($serverProfiles) {
$data = array();
foreach ($serverProfiles as $profileName => $serverProfile) {
foreach ($serverProfile->get_ActiveTypes() as $typeId) {
$accountProfileNames = getAccountProfiles($typeId, $profileName);
foreach ($accountProfileNames as $accountProfileName) {
$accountProfile = loadAccountProfile($accountProfileName, $typeId, $profileName);
$data[$profileName][$typeId][$accountProfileName] = $accountProfile;
}
}
}
return $data;
}
2020-04-12 10:39:52 +00:00
}
2020-04-12 19:51:19 +00:00
/**
* Importer for LAM's configuration data.
*/
class ConfigDataImporter {
/**
* Returns a list of possible import objects.
*
* @param string $json JSON data
* @return ImporterStep[] steps
* @throws LAMException if invalid format
*/
public function getPossibleImportSteps($json) {
2020-04-19 18:40:40 +00:00
$data = json_decode($json, true);
2020-04-12 19:51:19 +00:00
if ($data === null) {
throw new LAMException(_('Unable to read import file.'));
}
$steps = array();
foreach ($data as $key => $value) {
switch ($key) {
case 'mainConfig':
$steps[] = new ImporterStep(_('General settings'), 'mainConfig', $value);
break;
2020-04-13 13:40:33 +00:00
case 'certificates':
$steps[] = new ImporterStep(_('SSL certificates'), 'certificates', $value);
break;
2020-04-19 18:40:40 +00:00
case 'serverProfiles':
$mainStep = new ImporterStep(_('Server profiles'), 'serverProfiles', $value);
foreach ($value as $profileName => $profileData) {
$mainStep->addSubStep(new ImporterStep($profileName, 'serverProfile_' . $profileName, $profileData));
}
$steps[] = $mainStep;
break;
2020-05-03 08:32:35 +00:00
case 'accountProfiles':
$mainStep = new ImporterStep(_('Account profiles'), 'accountProfiles', $value);
foreach ($value as $profileName => $profileData) {
$mainStep->addSubStep(new ImporterStep($profileName, 'accountProfile_' . $profileName, $profileData));
}
$steps[] = $mainStep;
break;
2020-04-12 19:51:19 +00:00
default:
logNewMessage(LOG_WARNING, 'Unknown import type: ' . $key);
}
}
if (empty($steps)) {
throw new LAMException(_('Unable to read import file.'));
}
return $steps;
}
/**
* Runs the actual import.
*
* @param ImporterStep[] $steps import steps
2020-04-13 13:40:33 +00:00
* @throws LAMException if error occurred
2020-04-12 19:51:19 +00:00
*/
public function runImport($steps) {
foreach ($steps as $step) {
if (!$step->isActive()) {
continue;
}
$key = $step->getKey();
switch ($key) {
case 'mainConfig':
2020-04-13 13:40:33 +00:00
$this->importMainConfig($step->getValue());
break;
case 'certificates':
$this->importCertificates($step->getValue());
2020-04-12 19:51:19 +00:00
break;
2020-04-26 06:55:09 +00:00
case 'serverProfiles':
$this->importServerProfiles($step);
break;
2020-05-03 08:32:35 +00:00
case 'accountProfiles':
$this->importAccountProfiles($step);
break;
2020-04-12 19:51:19 +00:00
default:
logNewMessage(LOG_WARNING, 'Unknown import type: ' . $key);
}
}
}
2020-04-13 13:40:33 +00:00
/**
* Imports the main configuration.
*
* @param array $data main config data
* @throws LAMException error during import
*/
private function importMainConfig($data) {
$cfgMain = new LAMCfgMain();
$cfgMain->importData($data);
$cfgMain->save();
}
/**
* Imports the SSL certificates.
*
* @param null|string $data file content
* @throws LAMException error during import
*/
private function importCertificates($data) {
$cfgMain = new LAMCfgMain();
$cfgMain->importCertificates($data);
}
2020-04-26 06:55:09 +00:00
/**
* Imports the server profiles.
*
* @param ImporterStep $step step
* @throws LAMException error during import
*/
private function importServerProfiles($step) {
2020-04-27 19:53:50 +00:00
$failedProfiles = array();
2020-04-26 06:55:09 +00:00
foreach ($step->getSubSteps() as $profileStep) {
if (!$profileStep->isActive()) {
continue;
}
$data = $profileStep->getValue();
$profileName = str_replace('serverProfile_', '', $profileStep->getKey());
$serverProfile = new LAMConfig($profileName);
$serverProfile->importData($data);
2020-04-27 19:53:50 +00:00
$result = $serverProfile->save();
if ($result === LAMConfig::SAVE_FAIL) {
$failedProfiles[] = $profileName;
}
}
if (!empty($failedProfiles)) {
throw new LAMException(_('Unable to save server profile.'), implode(', ', $failedProfiles));
2020-04-26 06:55:09 +00:00
}
}
2020-05-03 08:32:35 +00:00
/**
* Imports the account profiles.
*
* @param ImporterStep $step step
* @throws LAMException error during import
*/
private function importAccountProfiles($step) {
$failedProfiles = array();
foreach ($step->getSubSteps() as $profileStep) {
if (!$profileStep->isActive()) {
continue;
}
$data = $profileStep->getValue();
$serverProfileName = str_replace('accountProfile_', '', $profileStep->getKey());
$serverProfile = new LAMConfig($serverProfileName);
foreach ($data as $typeId => $accountProfiles) {
foreach ($accountProfiles as $accountProfileName => $accountProfileData) {
$result = saveAccountProfile($accountProfileData, $accountProfileName, $typeId, $serverProfile);
if (!$result) {
$failedProfiles[] = $serverProfileName . ':' . $typeId . ':' . $accountProfileName;
}
}
}
}
if (!empty($failedProfiles)) {
throw new LAMException(_('Unable to save account profile.'), implode(', ', $failedProfiles));
}
}
2020-04-12 19:51:19 +00:00
}
/**
* Step of the import process.
*/
class ImporterStep {
private $label;
private $key;
private $value;
private $active = false;
2020-04-19 18:40:40 +00:00
private $subSteps = array();
2020-04-12 19:51:19 +00:00
/**
* Constructor.
*
* @param string $label label
* @param string $key key
* @param array $value value
*/
2020-04-26 06:55:09 +00:00
public function __construct($label, $key, $value) {
2020-04-12 19:51:19 +00:00
$this->label = $label;
$this->key = $key;
2020-04-26 06:55:09 +00:00
$this->value = $value;
2020-04-12 19:51:19 +00:00
}
/**
* Returns the label.
*
* @return string label
*/
public function getLabel() {
return $this->label;
}
/**
* Returns the key.
*
* @return string key
*/
public function getKey() {
return $this->key;
}
/**
* Returns if this step should be executed.
*
* @return bool active
*/
public function isActive(): bool {
return $this->active;
}
/**
* Sets if this step should be executed.
*
* @param bool $active active
*/
public function setActive(bool $active) {
$this->active = $active;
}
/**
* Returns the value.
*
* @return string value
*/
public function getValue() {
return $this->value;
}
2020-04-19 18:40:40 +00:00
/**
* Adds a sub-step.
*
* @param ImporterStep $subStep sub-step
*/
public function addSubStep($subStep) {
$this->subSteps[] = $subStep;
}
/**
* Returns the sub-steps.
*
* @return ImporterStep[] sub-steps
*/
public function getSubSteps() {
return $this->subSteps;
}
2020-04-12 19:51:19 +00:00
}