aboutsummaryrefslogtreecommitdiffstats
path: root/core/Command/Config/Import.php
diff options
context:
space:
mode:
authorLukas Reschke <lukas@owncloud.com>2016-04-06 10:40:55 +0200
committerLukas Reschke <lukas@owncloud.com>2016-04-06 11:00:52 +0200
commita4b19a5b1e4079752e33d6eb75c72a47ce048bde (patch)
treedb63cde4a4c0c69fd7c284331ba84367a93279f6 /core/Command/Config/Import.php
parent046506dd146f823499098d0d2b0042072e436469 (diff)
downloadnextcloud-server-a4b19a5b1e4079752e33d6eb75c72a47ce048bde.tar.gz
nextcloud-server-a4b19a5b1e4079752e33d6eb75c72a47ce048bde.zip
Rename files to be PSR-4 compliant
Diffstat (limited to 'core/Command/Config/Import.php')
-rw-r--r--core/Command/Config/Import.php195
1 files changed, 195 insertions, 0 deletions
diff --git a/core/Command/Config/Import.php b/core/Command/Config/Import.php
new file mode 100644
index 00000000000..7f1e09d2c95
--- /dev/null
+++ b/core/Command/Config/Import.php
@@ -0,0 +1,195 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\Core\Command\Config;
+
+use OCP\IConfig;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Import extends Command {
+ protected $validRootKeys = ['system', 'apps'];
+
+ /** @var IConfig */
+ protected $config;
+
+ /**
+ * @param IConfig $config
+ */
+ public function __construct(IConfig $config) {
+ parent::__construct();
+ $this->config = $config;
+ }
+
+ protected function configure() {
+ $this
+ ->setName('config:import')
+ ->setDescription('Import a list of configs')
+ ->addArgument(
+ 'file',
+ InputArgument::OPTIONAL,
+ 'File with the json array to import'
+ )
+ ;
+ }
+
+ protected function execute(InputInterface $input, OutputInterface $output) {
+ $importFile = $input->getArgument('file');
+ if ($importFile !== null) {
+ $content = $this->getArrayFromFile($importFile);
+ } else {
+ $content = $this->getArrayFromStdin();
+ }
+
+ try {
+ $configs = $this->validateFileContent($content);
+ } catch (\UnexpectedValueException $e) {
+ $output->writeln('<error>' . $e->getMessage(). '</error>');
+ return;
+ }
+
+ if (!empty($configs['system'])) {
+ $this->config->setSystemValues($configs['system']);
+ }
+
+ if (!empty($configs['apps'])) {
+ foreach ($configs['apps'] as $app => $appConfigs) {
+ foreach ($appConfigs as $key => $value) {
+ if ($value === null) {
+ $this->config->deleteAppValue($app, $key);
+ } else {
+ $this->config->setAppValue($app, $key, $value);
+ }
+ }
+ }
+ }
+
+ $output->writeln('<info>Config successfully imported from: ' . $importFile . '</info>');
+ }
+
+ /**
+ * Get the content from stdin ("config:import < file.json")
+ *
+ * @return string
+ */
+ protected function getArrayFromStdin() {
+ // Read from stdin. stream_set_blocking is used to prevent blocking
+ // when nothing is passed via stdin.
+ stream_set_blocking(STDIN, 0);
+ $content = file_get_contents('php://stdin');
+ stream_set_blocking(STDIN, 1);
+ return $content;
+ }
+
+ /**
+ * Get the content of the specified file ("config:import file.json")
+ *
+ * @param string $importFile
+ * @return string
+ */
+ protected function getArrayFromFile($importFile) {
+ $content = file_get_contents($importFile);
+ return $content;
+ }
+
+ /**
+ * @param string $content
+ * @return array
+ * @throws \UnexpectedValueException when the array is invalid
+ */
+ protected function validateFileContent($content) {
+ $decodedContent = json_decode($content, true);
+ if (!is_array($decodedContent) || empty($decodedContent)) {
+ throw new \UnexpectedValueException('The file must contain a valid json array');
+ }
+
+ $this->validateArray($decodedContent);
+
+ return $decodedContent;
+ }
+
+ /**
+ * Validates that the array only contains `system` and `apps`
+ *
+ * @param array $array
+ */
+ protected function validateArray($array) {
+ $arrayKeys = array_keys($array);
+ $additionalKeys = array_diff($arrayKeys, $this->validRootKeys);
+ $commonKeys = array_intersect($arrayKeys, $this->validRootKeys);
+ if (!empty($additionalKeys)) {
+ throw new \UnexpectedValueException('Found invalid entries in root: ' . implode(', ', $additionalKeys));
+ }
+ if (empty($commonKeys)) {
+ throw new \UnexpectedValueException('At least one key of the following is expected: ' . implode(', ', $this->validRootKeys));
+ }
+
+ if (isset($array['system'])) {
+ if (is_array($array['system'])) {
+ foreach ($array['system'] as $name => $value) {
+ $this->checkTypeRecursively($value, $name);
+ }
+ } else {
+ throw new \UnexpectedValueException('The system config array is not an array');
+ }
+ }
+
+ if (isset($array['apps'])) {
+ if (is_array($array['apps'])) {
+ $this->validateAppsArray($array['apps']);
+ } else {
+ throw new \UnexpectedValueException('The apps config array is not an array');
+ }
+ }
+ }
+
+ /**
+ * @param mixed $configValue
+ * @param string $configName
+ */
+ protected function checkTypeRecursively($configValue, $configName) {
+ if (!is_array($configValue) && !is_bool($configValue) && !is_int($configValue) && !is_string($configValue) && !is_null($configValue)) {
+ throw new \UnexpectedValueException('Invalid system config value for "' . $configName . '". Only arrays, bools, integers, strings and null (delete) are allowed.');
+ }
+ if (is_array($configValue)) {
+ foreach ($configValue as $key => $value) {
+ $this->checkTypeRecursively($value, $configName);
+ }
+ }
+ }
+
+ /**
+ * Validates that app configs are only integers and strings
+ *
+ * @param array $array
+ */
+ protected function validateAppsArray($array) {
+ foreach ($array as $app => $configs) {
+ foreach ($configs as $name => $value) {
+ if (!is_int($value) && !is_string($value) && !is_null($value)) {
+ throw new \UnexpectedValueException('Invalid app config value for "' . $app . '":"' . $name . '". Only integers, strings and null (delete) are allowed.');
+ }
+ }
+ }
+ }
+}