Issues in SettingsController.php - Fixed Issues - Inspection of "Merge pull request #1059 from nextcloud/bugfix/noi..." - nextcloud/richdocuments - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 692ee8...4447d0 )

by Julius

created 2020-06-25 13:49 UTC

lib/Controller/SettingsController.php (1 issue)

Labels

Unused Code 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * ownCloud - Richdocuments App
 *
 * @author Victor Dubiniuk
 * @copyright 2014 Victor Dubiniuk [email protected]
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 */

namespace OCA\Richdocuments\Controller;

use OCA\Richdocuments\Service\CapabilitiesService;
use OCA\Richdocuments\Service\DemoService;
use OCA\Richdocuments\WOPI\DiscoveryManager;
use OCA\Richdocuments\WOPI\Parser;
use \OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http\NotFoundResponse;
use OCP\Http\Client\IClientService;
use OCP\ICache;
use \OCP\IRequest;
use \OCP\IL10N;
use OCA\Richdocuments\AppConfig;
use OCP\IConfig;
use OCP\PreConditionNotMetException;

class SettingsController extends Controller{
	/** @var IL10N */
	private $l10n;
	/** @var AppConfig */
	private $appConfig;
	/** @var IConfig */
	private $config;
	/** @var DiscoveryManager  */
	private $discoveryManager;
	/** @var Parser */
	private $wopiParser;
	/** @var string */
	private $userId;
	/** @var CapabilitiesService */
	private $capabilitiesService;
	/** @var DemoService */
	private $demoService;

	/**
	 * @param string $appName
	 * @param IRequest $request
	 * @param IL10N $l10n
	 * @param AppConfig $appConfig
	 * @param IConfig $config
	 * @param DiscoveryManager $discoveryManager
	 * @param Parser $wopiParser
	 * @param string $userId
	 * @param CapabilitiesService $capabilitiesService
	 */
	public function __construct($appName,
		IRequest $request,
		IL10N $l10n,
		AppConfig $appConfig,
		IConfig $config,
		DiscoveryManager $discoveryManager,
		Parser $wopiParser,
		$userId,
		CapabilitiesService $capabilitiesService,
		DemoService $demoService
	) {
		parent::__construct($appName, $request);
		$this->l10n = $l10n;
		$this->appConfig = $appConfig;
		$this->config = $config;
		$this->discoveryManager = $discoveryManager;
		$this->wopiParser = $wopiParser;
		$this->userId = $userId;
		$this->capabilitiesService = $capabilitiesService;
		$this->demoService = $demoService;
	}

	/**
	 * @PublicPage
	 * @NoCSRFRequired
	 * @throws \Exception
	 */
	public function checkSettings() {
		try {
			$response = $this->discoveryManager->fetchFromRemote();
		} catch (\Exception $e) {
			return new DataResponse([
				'status' => $e->getCode(),
				'message' => $e->getMessage()
			], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new DataResponse();
	}

	public function demoServers() {
		$demoServers = $this->demoService->fetchDemoServers(true);
		if (count($demoServers) > 0) {
			return new DataResponse($demoServers);
		}
		return new NotFoundResponse([]);
	}

	/**
	 * @NoAdminRequired
	 *
	 * @return JSONResponse
	 */
	public function getSettings() {
		return new JSONResponse([
			'wopi_url' => $this->appConfig->getAppValue('wopi_url'),
			'public_wopi_url' => $this->appConfig->getAppValue('public_wopi_url'),
			'disable_certificate_verification' => $this->appConfig->getAppValue('disable_certificate_verification', '') !== '',

			'edit_groups' => $this->appConfig->getAppValue('edit_groups'),
			'use_groups' => $this->appConfig->getAppValue('use_groups'),
			'doc_format' => $this->appConfig->getAppValue('doc_format'),
		]);
	}

	/**
	 * @param string $wopi_url
	 * @param string $disable_certificate_verification
	 * @param string $edit_groups
	 * @param string $use_groups
	 * @param string $doc_format
	 * @param string $external_apps
	 * @param string $canonical_webroot
	 * @return JSONResponse
	 */
	public function setSettings($wopi_url,
	                            $disable_certificate_verification,
	                            $edit_groups,
	                            $use_groups,
	                            $doc_format,
	                            $external_apps,
	                            $canonical_webroot) {
		$message = $this->l10n->t('Saved');

		if ($wopi_url !== null){
			$this->appConfig->setAppValue('wopi_url', $wopi_url);
		}

		if ($disable_certificate_verification !== null) {
			$this->appConfig->setAppValue(
				'disable_certificate_verification',
				$disable_certificate_verification === true ? 'yes' : ''
			);
		}

		if ($edit_groups !== null){
			$this->appConfig->setAppValue('edit_groups', $edit_groups);
		}

		if ($use_groups !== null){
			$this->appConfig->setAppValue('use_groups', $use_groups);
		}

		if ($doc_format !== null) {
			$this->appConfig->setAppValue('doc_format', $doc_format);
		}

		if ($external_apps !== null) {
			$this->appConfig->setAppValue('external_apps', $external_apps);
		}

		if ($canonical_webroot !== null) {
			$this->appConfig->setAppValue('canonical_webroot', $canonical_webroot);
		}

		$this->discoveryManager->refretch();
		$this->capabilitiesService->clear();
		try {
			$capaUrlSrc = $this->wopiParser->getUrlSrc('Capabilities');
			if (is_array($capaUrlSrc) && $capaUrlSrc['action'] === 'getinfo') {
				$public_wopi_url = str_replace('/hosting/capabilities', '', $capaUrlSrc['urlsrc']);
				if ($public_wopi_url !== null) {
					$this->appConfig->setAppValue('public_wopi_url', $public_wopi_url);
					$colon = strpos($public_wopi_url, ':', 0);
					if ($this->request->getServerProtocol() !== substr($public_wopi_url, 0, $colon)){
						$message = $this->l10n->t('Saved with error: Collabora Online should use the same protocol as the server installation.');
					}
				}
			}
		} catch (\Exception $e){
			if ($wopi_url !== null) {
				return new JSONResponse([
					'status' => 'error',
					'data' => ['message' => 'Failed to connect to the remote server']
				], 500);
			}
		}

		$this->capabilitiesService->clear();
		$this->capabilitiesService->refretch();

		$response = [
			'status' => 'success',
			'data' => ['message' => $message]
		];

		return new JSONResponse($response);
	}

	public function updateWatermarkSettings($settings = []) {
		$supportedOptions = [
			'watermark_text',
			'watermark_enabled',
			'watermark_shareAll',
			'watermark_shareRead',
			'watermark_linkSecure',
			'watermark_linkRead',
			'watermark_linkAll',
			'watermark_linkTags',
			'watermark_linkTagsList',
			'watermark_allGroups',
			'watermark_allGroupsList',
			'watermark_allTags',
			'watermark_allTagsList',
		];
		$message = $this->l10n->t('Saved');

		$watermarkSettings = $settings['watermark'];
		foreach ($watermarkSettings as $key => $value) {
			$fullKey = 'watermark_' . $key;
			if (in_array($fullKey, $supportedOptions) !== true) {
				return new JSONResponse([
					'status' => 'error',
					'data' => ['message' => $this->l10n->t('Invalid config key') . ' ' . $fullKey]
				], Http::STATUS_BAD_REQUEST);
			}
			$value = $value === true ? 'yes' : $value;
			$value = $value === false ? 'no' : $value;
			if (AppConfig::APP_SETTING_TYPES[$fullKey] === 'array') {
				$value = implode(',', $value);
			}
			$this->appConfig->setAppValue($fullKey, $value);
		}

		$response = [
			'status' => 'success',
			'data' => ['message' => $message]
		];

		return new JSONResponse($response);
	}

	/**
	 * @NoAdminRequired
	 *
	 * @param $key
	 * @param $value
	 * @return JSONResponse
	 */
	public function setPersonalSettings($templateFolder) {
		$message = $this->l10n->t('Saved');
		$status = 'success';

		if ($templateFolder !== null){
			try {
				$this->config->setUserValue($this->userId, 'richdocuments', 'templateFolder', $templateFolder);
			} catch (PreConditionNotMetException $e) {
				$message = $this->l10n->t('Error when saving');
				$status = 'error';
			}
		}

		$response = [
			'status' => $status,
			'data' => ['message' => $message]
		];

		return new JSONResponse($response);

	}
}


1			<?php
2			/**
3			* ownCloud - Richdocuments App
4			*
5			* @author Victor Dubiniuk
6			* @copyright 2014 Victor Dubiniuk [email protected]
7			*
8			* This file is licensed under the Affero General Public License version 3 or
9			* later.
10			*/
11
12			namespace OCA\Richdocuments\Controller;
13
14			use OCA\Richdocuments\Service\CapabilitiesService;
15			use OCA\Richdocuments\Service\DemoService;
16			use OCA\Richdocuments\WOPI\DiscoveryManager;
17			use OCA\Richdocuments\WOPI\Parser;
18			use \OCP\AppFramework\Controller;
19			use OCP\AppFramework\Http;
20			use OCP\AppFramework\Http\DataResponse;
21			use OCP\AppFramework\Http\JSONResponse;
22			use OCP\AppFramework\Http\NotFoundResponse;
23			use OCP\Http\Client\IClientService;
24			use OCP\ICache;
25			use \OCP\IRequest;
26			use \OCP\IL10N;
27			use OCA\Richdocuments\AppConfig;
28			use OCP\IConfig;
29			use OCP\PreConditionNotMetException;
30
31			class SettingsController extends Controller{
32			/** @var IL10N */
33			private $l10n;
34			/** @var AppConfig */
35			private $appConfig;
36			/** @var IConfig */
37			private $config;
38			/** @var DiscoveryManager */
39			private $discoveryManager;
40			/** @var Parser */
41			private $wopiParser;
42			/** @var string */
43			private $userId;
44			/** @var CapabilitiesService */
45			private $capabilitiesService;
46			/** @var DemoService */
47			private $demoService;
48
49			/**
50			* @param string $appName
51			* @param IRequest $request
52			* @param IL10N $l10n
53			* @param AppConfig $appConfig
54			* @param IConfig $config
55			* @param DiscoveryManager $discoveryManager
56			* @param Parser $wopiParser
57			* @param string $userId
58			* @param CapabilitiesService $capabilitiesService
59			*/
60			public function __construct($appName,
61			IRequest $request,
62			IL10N $l10n,
63			AppConfig $appConfig,
64			IConfig $config,
65			DiscoveryManager $discoveryManager,
66			Parser $wopiParser,
67			$userId,
68			CapabilitiesService $capabilitiesService,
69			DemoService $demoService
70			) {
71			parent::__construct($appName, $request);
72			$this->l10n = $l10n;
73			$this->appConfig = $appConfig;
74			$this->config = $config;
75			$this->discoveryManager = $discoveryManager;
76			$this->wopiParser = $wopiParser;
77			$this->userId = $userId;
78			$this->capabilitiesService = $capabilitiesService;
79			$this->demoService = $demoService;
80			}
81
82			/**
83			* @PublicPage
84			* @NoCSRFRequired
85			* @throws \Exception
86			*/
87			public function checkSettings() {
88			try {
89			$response = $this->discoveryManager->fetchFromRemote();
90			} catch (\Exception $e) {
91			return new DataResponse([
92			'status' => $e->getCode(),
93			'message' => $e->getMessage()
94			], Http::STATUS_INTERNAL_SERVER_ERROR);
95			}
96
97			return new DataResponse();
98			}
99
100			public function demoServers() {
101			$demoServers = $this->demoService->fetchDemoServers(true);
102			if (count($demoServers) > 0) {
103			return new DataResponse($demoServers);
104			}
105			return new NotFoundResponse([]);
106			}
107
108			/**
109			* @NoAdminRequired
110			*
111			* @return JSONResponse
112			*/
113			public function getSettings() {
114			return new JSONResponse([
115			'wopi_url' => $this->appConfig->getAppValue('wopi_url'),
116			'public_wopi_url' => $this->appConfig->getAppValue('public_wopi_url'),
117			'disable_certificate_verification' => $this->appConfig->getAppValue('disable_certificate_verification', '') !== '',
			0 ignored issues – show Unused Code introduced 2020-05-12 10:16 UTC by Report Bug Copy Issue Report Show Similar Issues like this The call to `AppConfig::getAppValue()` has too many arguments starting with `''`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
118			'edit_groups' => $this->appConfig->getAppValue('edit_groups'),
119			'use_groups' => $this->appConfig->getAppValue('use_groups'),
120			'doc_format' => $this->appConfig->getAppValue('doc_format'),
121			]);
122			}
123
124			/**
125			* @param string $wopi_url
126			* @param string $disable_certificate_verification
127			* @param string $edit_groups
128			* @param string $use_groups
129			* @param string $doc_format
130			* @param string $external_apps
131			* @param string $canonical_webroot
132			* @return JSONResponse
133			*/
134			public function setSettings($wopi_url,
135			$disable_certificate_verification,
136			$edit_groups,
137			$use_groups,
138			$doc_format,
139			$external_apps,
140			$canonical_webroot) {
141			$message = $this->l10n->t('Saved');
142
143			if ($wopi_url !== null){
144			$this->appConfig->setAppValue('wopi_url', $wopi_url);
145			}
146
147			if ($disable_certificate_verification !== null) {
148			$this->appConfig->setAppValue(
149			'disable_certificate_verification',
150			$disable_certificate_verification === true ? 'yes' : ''
151			);
152			}
153
154			if ($edit_groups !== null){
155			$this->appConfig->setAppValue('edit_groups', $edit_groups);
156			}
157
158			if ($use_groups !== null){
159			$this->appConfig->setAppValue('use_groups', $use_groups);
160			}
161
162			if ($doc_format !== null) {
163			$this->appConfig->setAppValue('doc_format', $doc_format);
164			}
165
166			if ($external_apps !== null) {
167			$this->appConfig->setAppValue('external_apps', $external_apps);
168			}
169
170			if ($canonical_webroot !== null) {
171			$this->appConfig->setAppValue('canonical_webroot', $canonical_webroot);
172			}
173
174			$this->discoveryManager->refretch();
175			$this->capabilitiesService->clear();
176			try {
177			$capaUrlSrc = $this->wopiParser->getUrlSrc('Capabilities');
178			if (is_array($capaUrlSrc) && $capaUrlSrc['action'] === 'getinfo') {
179			$public_wopi_url = str_replace('/hosting/capabilities', '', $capaUrlSrc['urlsrc']);
180			if ($public_wopi_url !== null) {
181			$this->appConfig->setAppValue('public_wopi_url', $public_wopi_url);
182			$colon = strpos($public_wopi_url, ':', 0);
183			if ($this->request->getServerProtocol() !== substr($public_wopi_url, 0, $colon)){
184			$message = $this->l10n->t('Saved with error: Collabora Online should use the same protocol as the server installation.');
185			}
186			}
187			}
188			} catch (\Exception $e){
189			if ($wopi_url !== null) {
190			return new JSONResponse([
191			'status' => 'error',
192			'data' => ['message' => 'Failed to connect to the remote server']
193			], 500);
194			}
195			}
196
197			$this->capabilitiesService->clear();
198			$this->capabilitiesService->refretch();
199
200			$response = [
201			'status' => 'success',
202			'data' => ['message' => $message]
203			];
204
205			return new JSONResponse($response);
206			}
207
208			public function updateWatermarkSettings($settings = []) {
209			$supportedOptions = [
210			'watermark_text',
211			'watermark_enabled',
212			'watermark_shareAll',
213			'watermark_shareRead',
214			'watermark_linkSecure',
215			'watermark_linkRead',
216			'watermark_linkAll',
217			'watermark_linkTags',
218			'watermark_linkTagsList',
219			'watermark_allGroups',
220			'watermark_allGroupsList',
221			'watermark_allTags',
222			'watermark_allTagsList',
223			];
224			$message = $this->l10n->t('Saved');
225
226			$watermarkSettings = $settings['watermark'];
227			foreach ($watermarkSettings as $key => $value) {
228			$fullKey = 'watermark_' . $key;
229			if (in_array($fullKey, $supportedOptions) !== true) {
230			return new JSONResponse([
231			'status' => 'error',
232			'data' => ['message' => $this->l10n->t('Invalid config key') . ' ' . $fullKey]
233			], Http::STATUS_BAD_REQUEST);
234			}
235			$value = $value === true ? 'yes' : $value;
236			$value = $value === false ? 'no' : $value;
237			if (AppConfig::APP_SETTING_TYPES[$fullKey] === 'array') {
238			$value = implode(',', $value);
239			}
240			$this->appConfig->setAppValue($fullKey, $value);
241			}
242
243			$response = [
244			'status' => 'success',
245			'data' => ['message' => $message]
246			];
247
248			return new JSONResponse($response);
249			}
250
251			/**
252			* @NoAdminRequired
253			*
254			* @param $key
255			* @param $value
256			* @return JSONResponse
257			*/
258			public function setPersonalSettings($templateFolder) {
259			$message = $this->l10n->t('Saved');
260			$status = 'success';
261
262			if ($templateFolder !== null){
263			try {
264			$this->config->setUserValue($this->userId, 'richdocuments', 'templateFolder', $templateFolder);
265			} catch (PreConditionNotMetException $e) {
266			$message = $this->l10n->t('Error when saving');
267			$status = 'error';
268			}
269			}
270
271			$response = [
272			'status' => $status,
273			'data' => ['message' => $message]
274			];
275
276			return new JSONResponse($response);
277
278			}
279			}
280

nextcloud / richdocuments

Push — master ( 692ee8...4447d0 )

lib/Controller/SettingsController.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like