some minor fixes and clode cleanup

Signed-off-by: Bjoern Schiessle <[email protected]>

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

@@ -108,7 +108,6 @@ public function __construct($appName,
 	 * @param string $ownerDisplayName display name of the user who shared the item
 	 * @param string $sharedBy provider specific UID of the user who shared the resource
 	 * @param string $sharedByDisplayName display name of the user who shared the resource
-	 * @param string $sharedSecret use to authenticate accross servers
 	 * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
 	 * @param string $shareType ('group' or 'user' share)
 	 * @param $resourceType ('file', 'calendar',...)

apps/federatedfilesharing/lib/FederatedShareProvider.php

@@ -506,13 +506,13 @@ public function getChildren(IShare $parent) {
 	 * Delete a share (owner unShares the file)
 	 *
 	 * @param IShare $share
+	 * @throws ShareNotFound
+	 * @throws \OC\HintException
 	 */
 	public function delete(IShare $share) {
 
 		list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedWith());
 
-		$isOwner = false;
-
 		// if the local user is the owner we can send the unShare request directly...
 		if ($this->userManager->userExists($share->getShareOwner())) {
 			$this->notifications->sendRemoteUnShare($remote, $share->getId(), $share->getToken());

apps/federatedfilesharing/lib/ocm/CloudFederationProviderFiles.php

@@ -162,7 +162,6 @@ public function shareReceived(ICloudFederationShare $share) {
 
 		list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner());
 
-		$remote = $remote;
 		$token = $share->getShareSecret();
 		$name = $share->getResourceName();
 		$owner = $share->getOwnerDisplayName();
@@ -247,7 +246,7 @@ public function shareReceived(ICloudFederationShare $share) {
 			} catch (\Exception $e) {
 				$this->logger->logException($e, [
 					'message' => 'Server can not add remote share.',
-					'level' => Util::ERROR,
+					'level' => ILogger::ERROR,
 					'app' => 'files_sharing'
 				]);
 				throw new ProviderCouldNotAddShareException('internal server error, was not able to add share from ' . $remote, '', HTTP::STATUS_INTERNAL_SERVER_ERROR);
@@ -304,7 +303,7 @@ public function notificationReceived($notificationType, $providerId, array $noti
 	 * @throws BadRequestException
 	 * @throws \OC\HintException
 	 */
-	private function shareAccepted($id, $notification) {
+	private function shareAccepted($id, array $notification) {
 
 		if (!$this->isS2SEnabled()) {
 			throw new ActionNotSupportedException('Server does not support federated cloud sharing');
@@ -376,7 +375,7 @@ protected function executeAcceptShare(IShare $share) {
 	 * @throws \OC\HintException
 	 *
 	 */
-	protected function shareDeclined($id, $notification) {
+	protected function shareDeclined($id, array $notification) {
 
 		if (!$this->isS2SEnabled()) {
 			throw new ActionNotSupportedException('Server does not support federated cloud sharing');
@@ -446,12 +445,12 @@ protected function executeDeclineShare(IShare $share) {
 	 * received the notification that the owner unshared a file from you
 	 *
 	 * @param string $id
-	 * @param string $notification
+	 * @param array $notification
 	 * @return array
 	 * @throws AuthenticationFailedException
 	 * @throws BadRequestException
 	 */
-	private function undoReshare($id, $notification) {
+	private function undoReshare($id, array $notification) {
 		if (!isset($notification['sharedSecret'])) {
 			throw new BadRequestException(['sharedSecret']);
 		}
@@ -550,15 +549,15 @@ private function cleanupRemote($remote) {
 	/**
 	 * recipient of a share request to re-share the file with another user
 	 *
-	 * @param $id
-	 * @param $notification
+	 * @param string $id
+	 * @param array $notification
 	 * @return array
 	 * @throws AuthenticationFailedException
 	 * @throws BadRequestException
 	 * @throws ProviderCouldNotAddShareException
 	 * @throws ShareNotFound
 	 */
-	protected function reshareRequested($id, $notification) {
+	protected function reshareRequested($id, array $notification) {
 
 		if (!isset($notification['sharedSecret'])) {
 			throw new BadRequestException(['sharedSecret']);
@@ -602,7 +601,6 @@ protected function reshareRequested($id, $notification) {
 			throw new ProviderCouldNotAddShareException('resharing not allowed for share: ' . $id);
 		}
 
-		throw new BadRequestException([]);
 	}
 
 	/**
@@ -615,7 +613,7 @@ protected function reshareRequested($id, $notification) {
 	 * @throws AuthenticationFailedException
 	 * @throws BadRequestException
 	 */
-	protected function updateResharePermissions($id, $notification) {
+	protected function updateResharePermissions($id, array $notification) {
 
 		if (!isset($notification['sharedSecret'])) {
 			throw new BadRequestException(['sharedSecret']);
@@ -640,12 +638,11 @@ protected function updateResharePermissions($id, $notification) {
 	/**
 	 * translate OCM Permissions to Nextcloud permissions
 	 *
-	 * @param $ocmPermissions
+	 * @param array $ocmPermissions
 	 * @return int
 	 * @throws BadRequestException
 	 */
-	protected function ocmPermissions2ncPermissions($ocmPermissions) {
-		error_log("ocm permissions: " . json_encode($ocmPermissions));
+	protected function ocmPermissions2ncPermissions(array $ocmPermissions) {
 		$ncPermissions = 0;
 		foreach($ocmPermissions as $permission) {
 			switch (strtolower($permission)) {
@@ -701,7 +698,7 @@ private function getFile($user, $fileSource) {
 		$args = Filesystem::is_dir($file) ? array('dir' => $file) : array('dir' => dirname($file), 'scrollto' => $file);
 		$link = Util::linkToAbsolute('files', 'index.php', $args);
 
-		return array($file, $link);
+		return [$file, $link];
 
 	}
 

lib/private/Federation/CloudFederationNotification.php

@@ -23,6 +23,13 @@
 
 use OCP\Federation\ICloudFederationNotification;
 
+/**
+ * Class CloudFederationNotification
+ *
+ * @package OC\Federation
+ *
+ * @since 14.0.0
+ */
 class CloudFederationNotification implements ICloudFederationNotification {
 
 	private $message = [];

lib/private/Federation/CloudFederationProviderManager.php

@@ -200,7 +200,7 @@ public function sendNotification($url, ICloudFederationNotification $notificatio
 	 * @return bool
 	 */
 	public function isReady() {
-		return $this->appManager->isEnabledForUser('cloud_federation_api', false);
+		return $this->appManager->isEnabledForUser('cloud_federation_api');
 	}
 	/**
 	 * check if server supports the new OCM api and ask for the correct end-point

lib/public/Federation/Exceptions/ActionNotSupportedException.php

@@ -23,11 +23,20 @@
 
 use OC\HintException;
 
+/**
+ * Class ActionNotSupportedException
+ *
+ * @package OCP\Federation\Exceptions
+ *
+ * @since 14.0.0
+ */
 class ActionNotSupportedException extends HintException {
 
 	/**
 	 * ActionNotSupportedException constructor.
 	 *
+	 * @since 14.0.0
+	 *
 	 */
 	public function __construct($action) {
 		$l = \OC::$server->getL10N('federation');

lib/public/Federation/Exceptions/AuthenticationFailedException.php

@@ -23,12 +23,20 @@
 
 use OC\HintException;
 
+/**
+ * Class AuthenticationFailedException
+ *
+ * @package OCP\Federation\Exceptions
+ *
+ * @since 14.0.0
+ */
 class AuthenticationFailedException extends HintException {
 
 	/**
 	 * BadRequestException constructor.
 	 *
-	 * @param array $missingParameters
+	 * @since 14.0.0
+	 *
 	 */
 	public function __construct() {
 		$l = \OC::$server->getL10N('federation');

lib/public/Federation/Exceptions/BadRequestException.php

@@ -23,13 +23,22 @@
 
 use OC\HintException;
 
+/**
+ * Class BadRequestException
+ *
+ * @package OCP\Federation\Exceptions
+ *
+ * @since 14.0.0
+ */
 class BadRequestException extends HintException {
 
 	private $parameterList;
 
 	/**
 	 * BadRequestException constructor.
 	 *
+	 * @since 14.0.0
+	 *
 	 * @param array $missingParameters
 	 */
 	public function __construct(array $missingParameters) {
@@ -44,6 +53,8 @@ public function __construct(array $missingParameters) {
 	/**
 	 * get array with the return message as defined in the OCM API
 	 *
+	 * @since 14.0.0
+	 *
 	 * @return array
 	 */
 	public function getReturnMessage() {

lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php

@@ -23,11 +23,20 @@
 
 use OC\HintException;
 
+/**
+ * Class ProviderAlreadyExistsException
+ *
+ * @package OCP\Federation\Exceptions
+ *
+ * @since 14.0.0
+ */
 class ProviderAlreadyExistsException extends HintException {
 
 	/**
 	 * ProviderAlreadyExistsException constructor.
 	 *
+	 * @since 14.0.0
+	 *
 	 * @param string $newProviderId cloud federation provider ID of the new provider
 	 * @param string $existingProviderName name of cloud federation provider which already use the same ID
 	 */

lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php

@@ -24,8 +24,25 @@
 use OC\HintException;
 use OCP\AppFramework\Http;
 
+/**
+ * Class ProviderCouldNotAddShareException
+ *
+ * @package OCP\Federation\Exceptions
+ *
+ * @since 14.0.0
+ */
 class ProviderCouldNotAddShareException extends HintException {
 
+	/**
+	 * ProviderCouldNotAddShareException constructor.
+	 *
+	 * @since 14.0.0
+	 *
+	 * @param string $message
+	 * @param string $hint
+	 * @param int $code
+	 * @param \Exception|null $previous
+	 */
 	public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) {
 		parent::__construct($message, $hint, $code, $previous);
 	}

lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php

@@ -23,11 +23,20 @@
 
 use OC\HintException;
 
+/**
+ * Class ProviderDoesNotExistsException
+ *
+ * @package OCP\Federation\Exceptions
+ *
+ * @since 14.0.0
+ */
 class ProviderDoesNotExistsException extends HintException {
 
 	/**
 	 * ProviderDoesNotExistsException constructor.
 	 *
+	 * @since 14.0.0
+	 *
 	 * @param string $providerId cloud federation provider ID
 	 */
 	public function __construct($providerId) {

lib/public/Federation/ICloudFederationFactory.php

@@ -21,6 +21,13 @@
 
 namespace OCP\Federation;
 
+/**
+ * Interface ICloudFederationFactory
+ *
+ * @package OCP\Federation
+ *
+ * @since 14.0.0
+ */
 interface ICloudFederationFactory {
 
 	/**

lib/public/Federation/ICloudFederationNotification.php

@@ -21,6 +21,13 @@
 
 namespace OCP\Federation;
 
+/**
+ * Interface ICloudFederationNotification
+ *
+ * @package OCP\Federation
+ *
+ * @since 14.0.0
+ */
 interface ICloudFederationNotification {
 
 	/**
@@ -31,15 +38,14 @@ interface ICloudFederationNotification {
 	 * @param $providerId id of the share
 	 * @param array $notification , payload of the notification
 	 *
-	 * @return
 	 * @since 14.0.0
 	 */
 	public function setMessage($notificationType, $resourceType, $providerId, array $notification);
 
 	/**
 	 * get message, ready to send out
 	 *
-	 * @return string
+	 * @return array
 	 *
 	 * @since 14.0.0
 	 */

lib/public/Federation/ICloudFederationShare.php

@@ -21,6 +21,13 @@
 
 namespace OCP\Federation;
 
+/**
+ * Interface ICloudFederationShare
+ *
+ * @package OCP\Federation
+ *
+ * @since 14.0.0
+ */
 interface ICloudFederationShare {
 
 	/**

lib/public/IServerContainer.php

@@ -557,6 +557,7 @@ public function getCloudIdManager();
 
 	/**
 	 * @return \OCP\GlobalScale\IConfig
+	 * @since 14.0.0
 	 */
 	public function getGlobalScaleConfig();