nextcloud / server

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

Spacing +5 added lines, -5 removed lines

@@ -137,7 +137,7 @@ 
 
 		if (!$this->userManager->userExists($shareWith)) {
 			return new JSONResponse(
-				['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
+				['message' => 'User "'.$shareWith.'" does not exists at '.$this->urlGenerator->getBaseUrl()],
 				Http::STATUS_BAD_REQUEST
 			);
 		}
@@ -168,7 +168,7 @@ 
 			);
 		} catch (\Exception $e) {
 			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+				['message' => 'Internal error at '.$this->urlGenerator->getBaseUrl()],
 				Http::STATUS_BAD_REQUEST
 			);
 		}
@@ -222,7 +222,7 @@ 
 			);
 		} catch (\Exception $e) {
 			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+				['message' => 'Internal error at '.$this->urlGenerator->getBaseUrl()],
 				Http::STATUS_BAD_REQUEST
 			);
 		}
@@ -244,13 +244,13 @@ 
 	private function mapUid($uid) {
 		\OC::$server->getURLGenerator()->linkToDocs('key');
 		// FIXME this should be a method in the user management instead
-		$this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
+		$this->logger->debug('shareWith before, '.$uid, ['app' => $this->appName]);
 		\OCP\Util::emitHook(
 			'\OCA\Files_Sharing\API\Server2Server',
 			'preLoginNameUsedAsUserName',
 			array('uid' => &$uid)
 		);
-		$this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
+		$this->logger->debug('shareWith after, '.$uid, ['app' => $this->appName]);
 
 		return $uid;
 	}

Indentation +207 added lines, -207 removed lines

@@ -47,212 +47,212 @@
  */
 class RequestHandlerController extends Controller {
 
-	/** @var ILogger */
-	private $logger;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
-
-	/** @var Config */
-	private $config;
-
-	/** @var ICloudFederationFactory */
-	private $factory;
-
-	public function __construct($appName,
-								IRequest $request,
-								ILogger $logger,
-								IUserManager $userManager,
-								IURLGenerator $urlGenerator,
-								ICloudFederationProviderManager $cloudFederationProviderManager,
-								Config $config,
-								ICloudFederationFactory $factory
-	) {
-		parent::__construct($appName, $request);
-
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-		$this->config = $config;
-		$this->factory = $factory;
-	}
-
-	/**
-	 * add share
-	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @BruteForceProtection(action=receiveFederatedShare)
-	 *
-	 * @param string $shareWith
-	 * @param string $name resource name (e.g. document.odt)
-	 * @param string $description share description (optional)
-	 * @param string $providerId resource UID on the provider side
-	 * @param string $owner provider specific UID of the user who owns the resource
-	 * @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 $sharedByDisplayName display name of the user who shared the resource
-	 * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
-	 * @param string $shareType ('group' or 'user' share)
-	 * @param $resourceType ('file', 'calendar',...)
-	 * @return Http\DataResponse|JSONResponse
-	 *
-	 * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"access_token":"8Lrd1FVEREthux7","permissions":31}}}' http://localhost/server/index.php/ocm/shares
-	 */
-	public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
-
-		if (!$this->config->incomingRequestsEnabled()) {
-			return new JSONResponse(
-				['message' => 'This server doesn\'t support outgoing federated shares'],
-			Http::STATUS_NOT_IMPLEMENTED
-			);
-		}
-
-		// check if all required parameters are set
-		if ($shareWith === null ||
-			$name === null ||
-			$providerId === null ||
-			$owner === null ||
-			$resourceType === null ||
-			$shareType === null ||
-			!is_array($protocol) ||
-			!isset($protocol['name']) ||
-			!isset ($protocol['options']) ||
-			!is_array($protocol['options'])
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		$shareWith = $this->mapUid($shareWith);
-
-		if (!$this->userManager->userExists($shareWith)) {
-			return new JSONResponse(
-				['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		// if no explicit display name is given, we use the uid as display name
-		$ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
-		$sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
-
-		// sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
-		if ($sharedBy === null) {
-			$sharedBy = $owner;
-			$sharedByDisplayName = $ownerDisplayName;
-		}
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-			$share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType);
-			$id = $provider->shareReceived($share);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		} catch (ProviderCouldNotAddShareException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				$e->getCode()
-			);
-		} catch (\Exception $e) {
-			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		return new JSONResponse(
-			['id' => $id, 'createdAt' => time()],
-			Http::STATUS_CREATED);
-
-	}
-
-	/**
-	 * receive notification about existing share
-	 *
-	 * @param $resourceType ('file', 'calendar',...)
-	 * @param string $name resource name (e.g "file", "calendar",...)
-	 * @param string $id unique id of the corresponding item on the receiving site
-	 * @param array $notification contain the actual notification, content is defined by cloud federation provider
-	 * @return JSONResponse
-	 */
-	public function receiveNotification($resourceType, $name, $id, $notification) {
-		if (!$this->config->incomingRequestsEnabled()) {
-			return new JSONResponse(
-				['message' => 'This server doesn\'t support outgoing federated shares'],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		}
-
-		// check if all required parameters are set
-		if ($name === null ||
-			$id === null ||
-			!is_array($notification)
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-			$provider->notificationReceived($id, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ShareNotFoundException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (\Exception $e) {
-			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
-
-
-		return new JSONResponse(
-			['id' => $id, 'createdAt' => date()],
-			Http::STATUS_CREATED);
-
-
-	}
-
-	/**
-	 * map login name to internal LDAP UID if a LDAP backend is in use
-	 *
-	 * @param string $uid
-	 * @return string mixed
-	 */
-	private function mapUid($uid) {
-		\OC::$server->getURLGenerator()->linkToDocs('key');
-		// FIXME this should be a method in the user management instead
-		$this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
-		\OCP\Util::emitHook(
-			'\OCA\Files_Sharing\API\Server2Server',
-			'preLoginNameUsedAsUserName',
-			array('uid' => &$uid)
-		);
-		$this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
-
-		return $uid;
-	}
+    /** @var ILogger */
+    private $logger;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
+
+    /** @var Config */
+    private $config;
+
+    /** @var ICloudFederationFactory */
+    private $factory;
+
+    public function __construct($appName,
+                                IRequest $request,
+                                ILogger $logger,
+                                IUserManager $userManager,
+                                IURLGenerator $urlGenerator,
+                                ICloudFederationProviderManager $cloudFederationProviderManager,
+                                Config $config,
+                                ICloudFederationFactory $factory
+    ) {
+        parent::__construct($appName, $request);
+
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+        $this->config = $config;
+        $this->factory = $factory;
+    }
+
+    /**
+     * add share
+     *
+     * @NoCSRFRequired
+     * @PublicPage
+     * @BruteForceProtection(action=receiveFederatedShare)
+     *
+     * @param string $shareWith
+     * @param string $name resource name (e.g. document.odt)
+     * @param string $description share description (optional)
+     * @param string $providerId resource UID on the provider side
+     * @param string $owner provider specific UID of the user who owns the resource
+     * @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 $sharedByDisplayName display name of the user who shared the resource
+     * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
+     * @param string $shareType ('group' or 'user' share)
+     * @param $resourceType ('file', 'calendar',...)
+     * @return Http\DataResponse|JSONResponse
+     *
+     * Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"access_token":"8Lrd1FVEREthux7","permissions":31}}}' http://localhost/server/index.php/ocm/shares
+     */
+    public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
+
+        if (!$this->config->incomingRequestsEnabled()) {
+            return new JSONResponse(
+                ['message' => 'This server doesn\'t support outgoing federated shares'],
+            Http::STATUS_NOT_IMPLEMENTED
+            );
+        }
+
+        // check if all required parameters are set
+        if ($shareWith === null ||
+            $name === null ||
+            $providerId === null ||
+            $owner === null ||
+            $resourceType === null ||
+            $shareType === null ||
+            !is_array($protocol) ||
+            !isset($protocol['name']) ||
+            !isset ($protocol['options']) ||
+            !is_array($protocol['options'])
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        $shareWith = $this->mapUid($shareWith);
+
+        if (!$this->userManager->userExists($shareWith)) {
+            return new JSONResponse(
+                ['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        // if no explicit display name is given, we use the uid as display name
+        $ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
+        $sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
+
+        // sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
+        if ($sharedBy === null) {
+            $sharedBy = $owner;
+            $sharedByDisplayName = $ownerDisplayName;
+        }
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType);
+            $id = $provider->shareReceived($share);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        } catch (ProviderCouldNotAddShareException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                $e->getCode()
+            );
+        } catch (\Exception $e) {
+            return new JSONResponse(
+                ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        return new JSONResponse(
+            ['id' => $id, 'createdAt' => time()],
+            Http::STATUS_CREATED);
+
+    }
+
+    /**
+     * receive notification about existing share
+     *
+     * @param $resourceType ('file', 'calendar',...)
+     * @param string $name resource name (e.g "file", "calendar",...)
+     * @param string $id unique id of the corresponding item on the receiving site
+     * @param array $notification contain the actual notification, content is defined by cloud federation provider
+     * @return JSONResponse
+     */
+    public function receiveNotification($resourceType, $name, $id, $notification) {
+        if (!$this->config->incomingRequestsEnabled()) {
+            return new JSONResponse(
+                ['message' => 'This server doesn\'t support outgoing federated shares'],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        }
+
+        // check if all required parameters are set
+        if ($name === null ||
+            $id === null ||
+            !is_array($notification)
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $provider->notificationReceived($id, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ShareNotFoundException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (\Exception $e) {
+            return new JSONResponse(
+                ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
+
+
+        return new JSONResponse(
+            ['id' => $id, 'createdAt' => date()],
+            Http::STATUS_CREATED);
+
+
+    }
+
+    /**
+     * map login name to internal LDAP UID if a LDAP backend is in use
+     *
+     * @param string $uid
+     * @return string mixed
+     */
+    private function mapUid($uid) {
+        \OC::$server->getURLGenerator()->linkToDocs('key');
+        // FIXME this should be a method in the user management instead
+        $this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
+        \OCP\Util::emitHook(
+            '\OCA\Files_Sharing\API\Server2Server',
+            'preLoginNameUsedAsUserName',
+            array('uid' => &$uid)
+        );
+        $this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
+
+        return $uid;
+    }
 
 }

lib/public/Federation/ICloudFederationProvider.php

Indentation +36 added lines, -36 removed lines

@@ -36,44 +36,44 @@
 
 interface ICloudFederationProvider {
 
-	/**
-	 * get the name of the share type, handled by this provider
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShareType();
+    /**
+     * get the name of the share type, handled by this provider
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShareType();
 
-	/**
-	 * send new share to another server
-	 *
-	 * @since 14.0.0
-	 */
-	public function sendShare();
+    /**
+     * send new share to another server
+     *
+     * @since 14.0.0
+     */
+    public function sendShare();
 
-	/**
-	 * share received from another server
-	 *
-	 * @param ICloudFederationShare $share
-	 * @return string provider specific unique ID of the share
-	 *
-	 * @throws ProviderCouldNotAddShareException
-	 *
-	 * @since 14.0.0
-	 */
-	public function shareReceived(ICloudFederationShare $share);
+    /**
+     * share received from another server
+     *
+     * @param ICloudFederationShare $share
+     * @return string provider specific unique ID of the share
+     *
+     * @throws ProviderCouldNotAddShareException
+     *
+     * @since 14.0.0
+     */
+    public function shareReceived(ICloudFederationShare $share);
 
-	/**
-	 * notification received from another server
-	 *
-	 * @param string $id unique ID of a already existing share
-	 * @param array $notification provider specific notification
-	 *
-	 * @throws ShareNotFoundException
-	 *
-	 * @since 14.0.0
-	 */
-	public function notificationReceived($id, $notification);
+    /**
+     * notification received from another server
+     *
+     * @param string $id unique ID of a already existing share
+     * @param array $notification provider specific notification
+     *
+     * @throws ShareNotFoundException
+     *
+     * @since 14.0.0
+     */
+    public function notificationReceived($id, $notification);
 
 }

lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php

Indentation +3 added lines, -3 removed lines

@@ -26,9 +26,9 @@
 
 class ProviderCouldNotAddShareException extends HintException {
 
-	public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) {
-		parent::__construct($message, $hint, $code, $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

Indentation +11 added lines, -11 removed lines

@@ -25,16 +25,16 @@
 
 class ProviderDoesNotExistsException extends HintException {
 
-	/**
-	 * ProviderDoesNotExistsException constructor.
-	 *
-	 * @param string $providerId cloud federation provider ID
-	 */
-	public function __construct($providerId) {
-		$l = \OC::$server->getL10N('federation');
-		$message = 'Cloud Federation Provider with ID: "' . $providerId . '" does not exist.';
-		$hint = $l->t('Cloud Federation Provider with ID: "%s" does not exist.', [$providerId]);
-		parent::__construct($message, $hint);
-	}
+    /**
+     * ProviderDoesNotExistsException constructor.
+     *
+     * @param string $providerId cloud federation provider ID
+     */
+    public function __construct($providerId) {
+        $l = \OC::$server->getL10N('federation');
+        $message = 'Cloud Federation Provider with ID: "' . $providerId . '" does not exist.';
+        $hint = $l->t('Cloud Federation Provider with ID: "%s" does not exist.', [$providerId]);
+        parent::__construct($message, $hint);
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
 	 */
 	public function __construct($providerId) {
 		$l = \OC::$server->getL10N('federation');
-		$message = 'Cloud Federation Provider with ID: "' . $providerId . '" does not exist.';
+		$message = 'Cloud Federation Provider with ID: "'.$providerId.'" does not exist.';
 		$hint = $l->t('Cloud Federation Provider with ID: "%s" does not exist.', [$providerId]);
 		parent::__construct($message, $hint);
 	}

lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php

Indentation +12 added lines, -12 removed lines

@@ -25,17 +25,17 @@
 
 class ProviderAlreadyExistsException extends HintException {
 
-	/**
-	 * ProviderAlreadyExistsException constructor.
-	 *
-	 * @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
-	 */
-	public function __construct($newProviderId, $existingProviderName) {
-		$l = \OC::$server->getL10N('federation');
-		$message = 'Id "' . $newProviderId . '" already used by cloud federation provider "' . $existingProviderName . '"';
-		$hint = $l->t('Id "%s" already used by cloud federation provider "%s"', [$newProviderId, $existingProviderName]);
-		parent::__construct($message, $hint);
-	}
+    /**
+     * ProviderAlreadyExistsException constructor.
+     *
+     * @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
+     */
+    public function __construct($newProviderId, $existingProviderName) {
+        $l = \OC::$server->getL10N('federation');
+        $message = 'Id "' . $newProviderId . '" already used by cloud federation provider "' . $existingProviderName . '"';
+        $hint = $l->t('Id "%s" already used by cloud federation provider "%s"', [$newProviderId, $existingProviderName]);
+        parent::__construct($message, $hint);
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 	 */
 	public function __construct($newProviderId, $existingProviderName) {
 		$l = \OC::$server->getL10N('federation');
-		$message = 'Id "' . $newProviderId . '" already used by cloud federation provider "' . $existingProviderName . '"';
+		$message = 'Id "'.$newProviderId.'" already used by cloud federation provider "'.$existingProviderName.'"';
 		$hint = $l->t('Id "%s" already used by cloud federation provider "%s"', [$newProviderId, $existingProviderName]);
 		parent::__construct($message, $hint);
 	}

lib/public/Federation/ICloudFederationNotification.php

Indentation +17 added lines, -17 removed lines

@@ -23,22 +23,22 @@
 
 interface ICloudFederationNotification {
 
-	/**
-	 * add a message to the notification
-	 *
-	 * @param string $identifier
-	 * @param string $message
-	 *
-	 * @since 14.0.0
-	 */
-	public function setMessage($identifier, $message);
+    /**
+     * add a message to the notification
+     *
+     * @param string $identifier
+     * @param string $message
+     *
+     * @since 14.0.0
+     */
+    public function setMessage($identifier, $message);
 
-	/**
-	 * get JSON encoded Message, ready to send out
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getMessage();
+    /**
+     * get JSON encoded Message, ready to send out
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getMessage();
 }

lib/public/Federation/ICloudFederationFactory.php

Indentation +28 added lines, -28 removed lines

@@ -23,33 +23,33 @@
 
 interface ICloudFederationFactory {
 
-	/**
-	 * get a CloudFederationShare Object to prepare a share you want to send
-	 *
-	 * @param string $shareWith
-	 * @param string $name resource name (e.g. document.odt)
-	 * @param string $description share description (optional)
-	 * @param string $providerId resource UID on the provider side
-	 * @param string $owner provider specific UID of the user who owns the resource
-	 * @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 $sharedByDisplayName display name of the user who shared the resource
-	 * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
-	 * @param string $shareType ('group' or 'user' share)
-	 * @param $resourceType ('file', 'calendar',...)
-	 * @return ICloudFederationShare
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType);
+    /**
+     * get a CloudFederationShare Object to prepare a share you want to send
+     *
+     * @param string $shareWith
+     * @param string $name resource name (e.g. document.odt)
+     * @param string $description share description (optional)
+     * @param string $providerId resource UID on the provider side
+     * @param string $owner provider specific UID of the user who owns the resource
+     * @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 $sharedByDisplayName display name of the user who shared the resource
+     * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
+     * @param string $shareType ('group' or 'user' share)
+     * @param $resourceType ('file', 'calendar',...)
+     * @return ICloudFederationShare
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType);
 
-	/**
-	 * get a Cloud FederationNotification object to prepare a notification you
-	 * want to send
-	 *
-	 * @return ICloudFederationNotification
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationNotification();
+    /**
+     * get a Cloud FederationNotification object to prepare a notification you
+     * want to send
+     *
+     * @return ICloudFederationNotification
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationNotification();
 }

lib/public/Federation/ICloudFederationShare.php

Indentation +206 added lines, -206 removed lines

@@ -23,211 +23,211 @@
 
 interface ICloudFederationShare {
 
-	/**
-	 * set uid of the recipient
-	 *
-	 * @param string $user
-	 *
-	 * @since 14.0.0
-	 */
-	public function setShareWith($user);
-
-	/**
-	 * set resource name (e.g. file, calendar, contact,...)
-	 *
-	 * @param string $name
-	 *
-	 * @since 14.0.0
-	 */
-	public function setResourceName($name);
-
-	/**
-	 * set resource type (e.g. file, calendar, contact,...)
-	 *
-	 * @param string $resourceType
-	 *
-	 * @since 14.0.0
-	 */
-	public function setResourceType($resourceType);
-
-	/**
-	 * set resource description (optional)
-	 *
-	 * @param string $description
-	 *
-	 * @since 14.0.0
-	 */
-	public function setDescription($description);
-
-	/**
-	 * set provider ID (e.g. file ID)
-	 *
-	 * @param string $providerId
-	 *
-	 * @since 14.0.0
-	 */
-	public function setProviderId($providerId);
-
-	/**
-	 * set owner UID
-	 *
-	 * @param string $owner
-	 *
-	 * @since 14.0.0
-	 */
-	public function setOwner($owner);
-
-	/**
-	 * set owner display name
-	 *
-	 * @param string $ownerDisplayName
-	 *
-	 * @since 14.0.0
-	 */
-	public function setOwnerDisplayName($ownerDisplayName);
-
-	/**
-	 * set UID of the user who sends the share
-	 *
-	 * @param string $sharedBy
-	 *
-	 * @since 14.0.0
-	 */
-	public function setSharedBy($sharedBy);
-
-	/**
-	 * set display name of the user who sends the share
-	 *
-	 * @param $sharedByDisplayName
-	 *
-	 * @since 14.0.0
-	 */
-	public function setSharedByDisplayName($sharedByDisplayName);
-
-	/**
-	 * set protocol specification
-	 *
-	 * @param array $protocol
-	 *
-	 * @since 14.0.0
-	 */
-	public function setProtocol(array $protocol);
-
-	/**
-	 * share type (group or user)
-	 *
-	 * @param string $shareType
-	 *
-	 * @since 14.0.0
-	 */
-	public function setShareType($shareType);
-
-	/**
-	 * get JSON encoded share, ready to send out
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShare();
-
-	/**
-	 * get uid of the recipient
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShareWith();
-
-	/**
-	 * get resource name (e.g. file, calendar, contact,...)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getResourceName();
-
-	/**
-	 * get resource type (e.g. file, calendar, contact,...)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getResourceType();
-
-	/**
-	 * get resource description (optional)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getDescription();
-
-	/**
-	 * get provider ID (e.g. file ID)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getProviderId();
-
-	/**
-	 * get owner UID
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getOwner();
-
-	/**
-	 * get owner display name
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getOwnerDisplayName();
-
-	/**
-	 * get UID of the user who sends the share
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getSharedBy();
-
-	/**
-	 * get display name of the user who sends the share
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getSharedByDisplayName();
-
-	/**
-	 * get share type (group or user)
-	 *
-	 * @return string
-	 *
-	 * @since 14.0.0
-	 */
-	public function getShareType();
-
-	/**
-	 * get protocol specification
-	 *
-	 * @return array
-	 *
-	 * @since 14.0.0
-	 */
-	public function getProtocol();
+    /**
+     * set uid of the recipient
+     *
+     * @param string $user
+     *
+     * @since 14.0.0
+     */
+    public function setShareWith($user);
+
+    /**
+     * set resource name (e.g. file, calendar, contact,...)
+     *
+     * @param string $name
+     *
+     * @since 14.0.0
+     */
+    public function setResourceName($name);
+
+    /**
+     * set resource type (e.g. file, calendar, contact,...)
+     *
+     * @param string $resourceType
+     *
+     * @since 14.0.0
+     */
+    public function setResourceType($resourceType);
+
+    /**
+     * set resource description (optional)
+     *
+     * @param string $description
+     *
+     * @since 14.0.0
+     */
+    public function setDescription($description);
+
+    /**
+     * set provider ID (e.g. file ID)
+     *
+     * @param string $providerId
+     *
+     * @since 14.0.0
+     */
+    public function setProviderId($providerId);
+
+    /**
+     * set owner UID
+     *
+     * @param string $owner
+     *
+     * @since 14.0.0
+     */
+    public function setOwner($owner);
+
+    /**
+     * set owner display name
+     *
+     * @param string $ownerDisplayName
+     *
+     * @since 14.0.0
+     */
+    public function setOwnerDisplayName($ownerDisplayName);
+
+    /**
+     * set UID of the user who sends the share
+     *
+     * @param string $sharedBy
+     *
+     * @since 14.0.0
+     */
+    public function setSharedBy($sharedBy);
+
+    /**
+     * set display name of the user who sends the share
+     *
+     * @param $sharedByDisplayName
+     *
+     * @since 14.0.0
+     */
+    public function setSharedByDisplayName($sharedByDisplayName);
+
+    /**
+     * set protocol specification
+     *
+     * @param array $protocol
+     *
+     * @since 14.0.0
+     */
+    public function setProtocol(array $protocol);
+
+    /**
+     * share type (group or user)
+     *
+     * @param string $shareType
+     *
+     * @since 14.0.0
+     */
+    public function setShareType($shareType);
+
+    /**
+     * get JSON encoded share, ready to send out
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShare();
+
+    /**
+     * get uid of the recipient
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShareWith();
+
+    /**
+     * get resource name (e.g. file, calendar, contact,...)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getResourceName();
+
+    /**
+     * get resource type (e.g. file, calendar, contact,...)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getResourceType();
+
+    /**
+     * get resource description (optional)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getDescription();
+
+    /**
+     * get provider ID (e.g. file ID)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getProviderId();
+
+    /**
+     * get owner UID
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getOwner();
+
+    /**
+     * get owner display name
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getOwnerDisplayName();
+
+    /**
+     * get UID of the user who sends the share
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getSharedBy();
+
+    /**
+     * get display name of the user who sends the share
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getSharedByDisplayName();
+
+    /**
+     * get share type (group or user)
+     *
+     * @return string
+     *
+     * @since 14.0.0
+     */
+    public function getShareType();
+
+    /**
+     * get protocol specification
+     *
+     * @return array
+     *
+     * @since 14.0.0
+     */
+    public function getProtocol();
 
 }

lib/private/Federation/CloudFederationFactory.php

Indentation +32 added lines, -32 removed lines

@@ -27,37 +27,37 @@
 
 class CloudFederationFactory implements ICloudFederationFactory {
 
-	/**
-	 * get a CloudFederationShare Object to prepare a share you want to send
-	 *
-	 * @param string $shareWith
-	 * @param string $name resource name (e.g. document.odt)
-	 * @param string $description share description (optional)
-	 * @param string $providerId resource UID on the provider side
-	 * @param string $owner provider specific UID of the user who owns the resource
-	 * @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 $sharedByDisplayName display name of the user who shared the resource
-	 * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
-	 * @param string $shareType ('group' or 'user' share)
-	 * @param $resourceType ('file', 'calendar',...)
-	 * @return ICloudFederationShare
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
-		return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType);
-	}
+    /**
+     * get a CloudFederationShare Object to prepare a share you want to send
+     *
+     * @param string $shareWith
+     * @param string $name resource name (e.g. document.odt)
+     * @param string $description share description (optional)
+     * @param string $providerId resource UID on the provider side
+     * @param string $owner provider specific UID of the user who owns the resource
+     * @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 $sharedByDisplayName display name of the user who shared the resource
+     * @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
+     * @param string $shareType ('group' or 'user' share)
+     * @param $resourceType ('file', 'calendar',...)
+     * @return ICloudFederationShare
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
+        return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType);
+    }
 
-	/**
-	 * get a Cloud FederationNotification object to prepare a notification you
-	 * want to send
-	 *
-	 * @return ICloudFederationNotification
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationNotification() {
-		return new CloudFederationNotification();
-	}
+    /**
+     * get a Cloud FederationNotification object to prepare a notification you
+     * want to send
+     *
+     * @return ICloudFederationNotification
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationNotification() {
+        return new CloudFederationNotification();
+    }
 }