Browse Source
Merge pull request #101 from LDAPAccountManager/configImportExport
Merge pull request #101 from LDAPAccountManager/configImportExport
Config import exportpull/102/head
gruberroland
3 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 1986 additions and 193 deletions
-
3composer.json
-
BINlam/graphics/confImportExport.png
-
10lam/lib/account.inc
-
157lam/lib/config.inc
-
55lam/lib/html.inc
-
2lam/lib/lists.inc
-
4lam/lib/modules.inc
-
2lam/lib/pdf.inc
-
270lam/lib/pdfstruct.inc
-
652lam/lib/persistence.inc
-
186lam/lib/profiles.inc
-
40lam/lib/selfService.inc
-
10lam/style/500_layout.css
-
277lam/templates/config/confImportExport.php
-
96lam/templates/config/index.php
-
12lam/templates/pdfedit/pdfmain.php
-
8lam/templates/pdfedit/pdfpage.php
-
6lam/templates/profedit/profilepage.php
-
2lam/templates/upload/masscreate.php
-
52lam/tests/lib/LAMCfgMainTest.php
-
61lam/tests/lib/LAMConfigTest.php
-
11lam/tests/lib/accountTest.php
-
138lam/tests/lib/pdfstructTest.php
-
104lam/tests/lib/persistenceTest.php
-
21lam/tests/lib/selfServiceTest.php
|
After Width: 32 | Height: 32 | Size: 2.7 KiB |
@ -0,0 +1,652 @@ |
|||
<?php |
|||
namespace LAM\PERSISTENCE; |
|||
use LAM\PDF\PDFStructure; |
|||
use LAM\PDF\PDFStructureReader; |
|||
use LAM\PDF\PDFStructureWriter; |
|||
use LAMCfgMain; |
|||
use LAMConfig; |
|||
use LAMException; |
|||
use selfServiceProfile; |
|||
use function LAM\PDF\getAvailableLogos; |
|||
use function LAM\PDF\getPDFStructures; |
|||
use function LAM\PDF\getPdfTemplateLogoBinary; |
|||
use function LAM\PDF\getPdfTemplateLogoNames; |
|||
use function LAM\PDF\getPdfTemplateNames; |
|||
use function LAM\PDF\uploadPDFLogo; |
|||
use function LAM\PROFILES\getAccountProfiles; |
|||
use function LAM\PROFILES\getProfileTemplateNames; |
|||
use function LAM\PROFILES\installTemplateAccountProfile; |
|||
use function LAM\PROFILES\loadAccountProfile; |
|||
use function LAM\PROFILES\loadTemplateAccountProfile; |
|||
use function LAM\PROFILES\saveAccountProfile; |
|||
|
|||
/* |
|||
|
|||
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'; |
|||
include_once __DIR__ . '/profiles.inc'; |
|||
|
|||
/** |
|||
* Exporter for LAM's configuration data. |
|||
*/ |
|||
class ConfigDataExporter { |
|||
|
|||
/** |
|||
* Exports LAM's configuration data in JSON format. |
|||
* @throws LAMException error during export |
|||
*/ |
|||
public function exportAsJson() { |
|||
$mainCfg = $this->_getMainConfiguration(); |
|||
$jsonData = array(); |
|||
$jsonData['mainConfig'] = $this->_getMainConfigData($mainCfg); |
|||
$jsonData['certificates'] = $this->_getCertificates($mainCfg); |
|||
$serverProfileNames = getConfigProfiles(); |
|||
$serverProfiles = array(); |
|||
foreach ($serverProfileNames as $serverProfileName) { |
|||
$serverProfiles[$serverProfileName] = new \LAMConfig($serverProfileName); |
|||
} |
|||
$jsonData['serverProfiles'] = $this->_getServerProfiles($serverProfiles); |
|||
$jsonData['accountProfiles'] = $this->_getAccountProfiles($serverProfiles); |
|||
$jsonData['accountProfileTemplates'] = $this->_getAccountProfileTemplates(); |
|||
$jsonData['pdfProfiles'] = $this->_getPdfProfiles($serverProfiles); |
|||
$jsonData['pdfProfileTemplates'] = $this->_getPdfProfileTemplates(); |
|||
$jsonData['selfServiceProfiles'] = $this->_getSelfServiceProfiles(); |
|||
/** |
|||
* TODO |
|||
* |
|||
* webauthn |
|||
*/ |
|||
return json_encode($jsonData); |
|||
} |
|||
|
|||
/** |
|||
* Returns the main configuration. |
|||
* |
|||
* @return LAMCfgMain main config |
|||
*/ |
|||
public function _getMainConfiguration() { |
|||
return new LAMCfgMain(); |
|||
} |
|||
|
|||
/** |
|||
* Internal function to read master configuration. |
|||
* |
|||
* @param LAMCfgMain $mainCfg main config |
|||
* @return array data |
|||
*/ |
|||
public function _getMainConfigData($mainCfg) { |
|||
return $mainCfg->exportData(); |
|||
} |
|||
|
|||
/** |
|||
* Returns the certificate file content. |
|||
* |
|||
* @param LAMCfgMain $mainCfg main config |
|||
* @return array data |
|||
*/ |
|||
public function _getCertificates($mainCfg) { |
|||
return $mainCfg->exportCertificates(); |
|||
} |
|||
|
|||
/** |
|||
* Returns the content of the server profiles. |
|||
* |
|||
* @param array $serverProfiles list of server profiles (name => object) |
|||
* @return array $data |
|||
*/ |
|||
public function _getServerProfiles($serverProfiles) { |
|||
$data = array(); |
|||
foreach ($serverProfiles as $profileName => $serverProfile) { |
|||
$data[$profileName] = $serverProfile->exportData(); |
|||
} |
|||
return $data; |
|||
} |
|||
|
|||
/** |
|||
* 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; |
|||
} |
|||
|
|||
/** |
|||
* Returns the content of the account profile templates. |
|||
* |
|||
* @return array $data |
|||
* @throws LAMException error reading template |
|||
*/ |
|||
public function _getAccountProfileTemplates() { |
|||
$data = array(); |
|||
$accountProfileTemplateNames = getProfileTemplateNames(); |
|||
foreach ($accountProfileTemplateNames as $scope => $templateNames) { |
|||
foreach ($templateNames as $templateName) { |
|||
$accountProfileTemplate = loadTemplateAccountProfile($templateName, $scope); |
|||
$data[$scope][$templateName] = $accountProfileTemplate; |
|||
} |
|||
} |
|||
return $data; |
|||
} |
|||
|
|||
/** |
|||
* Returns the content of the PDF profiles. |
|||
* |
|||
* @param array $serverProfiles list of server profiles (name => object) |
|||
* @return array $data |
|||
*/ |
|||
public function _getPdfProfiles($serverProfiles) { |
|||
$data = array(); |
|||
foreach ($serverProfiles as $profileName => $serverProfile) { |
|||
foreach ($serverProfile->get_ActiveTypes() as $typeId) { |
|||
$pdfProfileNames = getPDFStructures($typeId, $profileName); |
|||
$reader = new PDFStructureReader($profileName); |
|||
foreach ($pdfProfileNames as $pdfProfileName) { |
|||
$pdfStructure = $reader->read($typeId, $pdfProfileName); |
|||
$data[$profileName]['structures'][$typeId][$pdfProfileName] = $pdfStructure->export(); |
|||
} |
|||
} |
|||
$logoData = getAvailableLogos($profileName); |
|||
foreach ($logoData as $logo) { |
|||
$logoFileName = $logo['filename']; |
|||
$logoPath = __DIR__ . '/../config/pdf/' . $profileName . '/logos/' . $logoFileName; |
|||
$handle = fopen($logoPath, 'r'); |
|||
$logoBinary = fread($handle, 100000000); |
|||
fclose($handle); |
|||
$data[$profileName]['logos'][$logoFileName] = base64_encode($logoBinary); |
|||
} |
|||
} |
|||
return $data; |
|||
} |
|||
|
|||
/** |
|||
* Returns the content of the account profile templates. |
|||
* |
|||
* @return array $data |
|||
* @throws LAMException error reading template |
|||
*/ |
|||
public function _getPdfProfileTemplates() { |
|||
$data = array(); |
|||
$pdfTemplateNames = getPdfTemplateNames(); |
|||
$reader = new PDFStructureReader(\LAM\PDF\GLOBAL_PROFILE); |
|||
foreach ($pdfTemplateNames as $scope => $templateNames) { |
|||
foreach ($templateNames as $templateName) { |
|||
$pdfStructure = $reader->read($scope, $templateName); |
|||
$data['structures'][$scope][$templateName] = $pdfStructure->export(); |
|||
} |
|||
} |
|||
$logoNames = getPdfTemplateLogoNames(); |
|||
foreach ($logoNames as $logoName) { |
|||
$data['logos'][$logoName] = base64_encode(getPdfTemplateLogoBinary($logoName)); |
|||
} |
|||
return $data; |
|||
} |
|||
|
|||
/** |
|||
* Returns the content of the self service profiles. |
|||
* |
|||
* @return array data |
|||
*/ |
|||
public function _getSelfServiceProfiles() { |
|||
$data = array(); |
|||
$profileTypes = getSelfServiceProfiles(); |
|||
foreach ($profileTypes as $profileType => $profileNames) { |
|||
foreach ($profileNames as $profileName) { |
|||
$profile = loadSelfServiceProfile($profileName, $profileType); |
|||
if ($profile === false) { |
|||
continue; |
|||
} |
|||
$data[$profileType][$profileName] = $profile->export(); |
|||
} |
|||
} |
|||
return $data; |
|||
} |
|||
|
|||
} |
|||
|
|||
/** |
|||
* 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) { |
|||
$data = json_decode($json, true); |
|||
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; |
|||
case 'certificates': |
|||
$steps[] = new ImporterStep(_('SSL certificates'), 'certificates', $value); |
|||
break; |
|||
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; |
|||
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; |
|||
case 'accountProfileTemplates': |
|||
$steps[] = new ImporterStep(_('Account profiles') . ' - ' . _('Global templates'), 'accountProfileTemplates', $value); |
|||
break; |
|||
case 'pdfProfiles': |
|||
$mainStep = new ImporterStep(_('PDF structures'), 'pdfProfiles', $value); |
|||
foreach ($value as $profileName => $profileData) { |
|||
$mainStep->addSubStep(new ImporterStep($profileName, 'pdfProfile_' . $profileName, $profileData)); |
|||
} |
|||
$steps[] = $mainStep; |
|||
break; |
|||
case 'pdfProfileTemplates': |
|||
$steps[] = new ImporterStep(_('PDF structures') . ' - ' . _('Global templates'), 'pdfProfileTemplates', $value); |
|||
break; |
|||
case 'selfServiceProfiles': |
|||
$steps[] = new ImporterStep(_('Self service profiles'), 'selfServiceProfiles', $value); |
|||
break; |
|||
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 |
|||
* @throws LAMException if error occurred |
|||
*/ |
|||
public function runImport($steps) { |
|||
foreach ($steps as $step) { |
|||
if (!$step->isActive()) { |
|||
continue; |
|||
} |
|||
$key = $step->getKey(); |
|||
switch ($key) { |
|||
case 'mainConfig': |
|||
$this->importMainConfig($step->getValue()); |
|||
break; |
|||
case 'certificates': |
|||
$this->importCertificates($step->getValue()); |
|||
break; |
|||
case 'serverProfiles': |
|||
$this->importServerProfiles($step); |
|||
break; |
|||
case 'accountProfiles': |
|||
$this->importAccountProfiles($step); |
|||
break; |
|||
case 'accountProfileTemplates': |
|||
$this->importAccountProfileTemplates($step); |
|||
break; |
|||
case 'pdfProfiles': |
|||
$this->importPdfProfiles($step); |
|||
break; |
|||
case 'pdfProfileTemplates': |
|||
$this->importPdfProfileTemplates($step); |
|||
break; |
|||
case 'selfServiceProfiles': |
|||
$this->importSelfServiceProfiles($step); |
|||
break; |
|||
default: |
|||
logNewMessage(LOG_WARNING, 'Unknown import type: ' . $key); |
|||
} |
|||
} |
|||
} |
|||
|
|||
/** |
|||
* 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); |
|||
} |
|||
|
|||
/** |
|||
* Imports the server profiles. |
|||
* |
|||
* @param ImporterStep $step step |
|||
* @throws LAMException error during import |
|||
*/ |
|||
private function importServerProfiles($step) { |
|||
$failedProfiles = array(); |
|||
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); |
|||
$result = $serverProfile->save(); |
|||
if ($result === LAMConfig::SAVE_FAIL) { |
|||
$failedProfiles[] = $profileName; |
|||
} |
|||
} |
|||
if (!empty($failedProfiles)) { |
|||
throw new LAMException(_('Unable to save server profile.'), implode(', ', $failedProfiles)); |
|||
} |
|||
} |
|||
|
|||
/** |
|||
* 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)); |
|||
} |
|||
} |
|||
|
|||
/** |
|||
* Imports the account profile templates. |
|||
* |
|||
* @param ImporterStep $step step |
|||
* @throws LAMException error during import |
|||
*/ |
|||
private function importAccountProfileTemplates($step) { |
|||
$data = $step->getValue(); |
|||
foreach ($data as $typeId => $accountProfileTemplates) { |
|||
foreach ($accountProfileTemplates as $accountProfileTemplateName => $accountProfileData) { |
|||
installTemplateAccountProfile($typeId, $accountProfileTemplateName, $accountProfileData); |
|||
} |
|||
} |
|||
} |
|||
|
|||
/** |
|||
* Imports the PDF profiles. |
|||
* |
|||
* @param ImporterStep $step step |
|||
* @throws LAMException error during import |
|||
*/ |
|||
private function importPdfProfiles($step) { |
|||
$failedProfiles = array(); |
|||
foreach ($step->getSubSteps() as $profileStep) { |
|||
if (!$profileStep->isActive()) { |
|||
continue; |
|||
} |
|||
$data = $profileStep->getValue(); |
|||
$serverProfileName = str_replace('pdfProfile_', '', $profileStep->getKey()); |
|||
if (isset($data['structures'])) { |
|||
$writer = new PDFStructureWriter($serverProfileName); |
|||
foreach ($data['structures'] as $typeId => $pdfProfiles) { |
|||
foreach ($pdfProfiles as $pdfProfileName => $pdfProfileData) { |
|||
$structure = new PDFStructure(); |
|||
$structure->import($pdfProfileData); |
|||
try { |
|||
$writer->write($typeId, $pdfProfileName, $structure); |
|||
} |
|||
catch (LAMException $e) { |
|||
logNewMessage(LOG_ERR, $e->getTitle() . ' ' . $e->getMessage()); |
|||
$failedProfiles[] = $serverProfileName . ':' . $typeId . ':' . $pdfProfileName; |
|||
} |
|||
} |
|||
} |
|||
} |
|||
if (isset($data['logos'])) { |
|||
foreach ($data['logos'] as $logoFileName => $logoData) { |
|||
$tempFilePath = tempnam("/tmp", "lam"); |
|||
$tempFile = fopen($tempFilePath, "w"); |
|||
$logoBinary = base64_decode($logoData); |
|||
fwrite($tempFile, $logoBinary); |
|||
fclose($tempFile); |
|||
uploadPDFLogo($tempFilePath, $logoFileName, $serverProfileName); |
|||
unlink($tempFilePath); |
|||
} |
|||
} |
|||
} |
|||
if (!empty($failedProfiles)) { |
|||
throw new LAMException(_('Could not save PDF structure, access denied.'), implode(', ', $failedProfiles)); |
|||
} |
|||
} |
|||
|
|||
/** |
|||
* Imports the PDF profile templates. |
|||
* |
|||
* @param ImporterStep $step step |
|||
* @throws LAMException error during import |
|||
*/ |
|||
private function importPdfProfileTemplates($step) { |
|||
$failedNames = array(); |
|||
$data = $step->getValue(); |
|||
if (isset($data['structures'])) { |
|||
$writer = new PDFStructureWriter(\LAM\PDF\GLOBAL_PROFILE); |
|||
foreach ($data['structures'] as $typeId => $pdfProfiles) { |
|||
foreach ($pdfProfiles as $pdfProfileName => $pdfProfileData) { |
|||
$structure = new PDFStructure(); |
|||
$structure->import($pdfProfileData); |
|||