nextcloud / server

lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php

Indentation +13 added lines, -13 removed lines

@@ -32,18 +32,18 @@
  */
 class ProviderDoesNotExistsException extends HintException {
 
-	/**
-	 * ProviderDoesNotExistsException constructor.
-	 *
-	 * @since 14.0.0
-	 *
-	 * @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.
+     *
+     * @since 14.0.0
+     *
+     * @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);
+    }
 
 }

lib/public/Federation/Exceptions/ActionNotSupportedException.php

Indentation +12 added lines, -12 removed lines

@@ -32,17 +32,17 @@
  */
 class ActionNotSupportedException extends HintException {
 
-	/**
-	 * ActionNotSupportedException constructor.
-	 *
-	 * @since 14.0.0
-	 *
-	 */
-	public function __construct($action) {
-		$l = \OC::$server->getL10N('federation');
-		$message = 'Action "' . $action . '" not supported or implemented.';
-		$hint = $l->t('Action "%s" not supported or implemented.', [$action]);
-		parent::__construct($message, $hint);
-	}
+    /**
+     * ActionNotSupportedException constructor.
+     *
+     * @since 14.0.0
+     *
+     */
+    public function __construct($action) {
+        $l = \OC::$server->getL10N('federation');
+        $message = 'Action "' . $action . '" not supported or implemented.';
+        $hint = $l->t('Action "%s" not supported or implemented.', [$action]);
+        parent::__construct($message, $hint);
+    }
 
 }

lib/public/Federation/ICloudFederationFactory.php

Indentation +28 added lines, -28 removed lines

@@ -30,33 +30,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 string $sharedByDisplayName display name of the user who shared the resource
-	 * @param string $sharedSecret used to authenticate requests across servers
-	 * @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, $sharedSecret, $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 string $sharedByDisplayName display name of the user who shared the resource
+     * @param string $sharedSecret used to authenticate requests across servers
+     * @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, $sharedSecret, $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/IServerContainer.php

Indentation +506 added lines, -506 removed lines

@@ -60,510 +60,510 @@
  */
 interface IServerContainer extends IContainer {
 
-	/**
-	 * The calendar manager will act as a broker between consumers for calendar information and
-	 * providers which actual deliver the calendar information.
-	 *
-	 * @return \OCP\Calendar\IManager
-	 * @since 13.0.0
-	 */
-	public function getCalendarManager();
-
-	/**
-	 * The contacts manager will act as a broker between consumers for contacts information and
-	 * providers which actual deliver the contact information.
-	 *
-	 * @return \OCP\Contacts\IManager
-	 * @since 6.0.0
-	 */
-	public function getContactsManager();
-
-	/**
-	 * The current request object holding all information about the request currently being processed
-	 * is returned from this method.
-	 * In case the current execution was not initiated by a web request null is returned
-	 *
-	 * @return \OCP\IRequest
-	 * @since 6.0.0
-	 */
-	public function getRequest();
-
-	/**
-	 * Returns the preview manager which can create preview images for a given file
-	 *
-	 * @return \OCP\IPreview
-	 * @since 6.0.0
-	 */
-	public function getPreviewManager();
-
-	/**
-	 * Returns the tag manager which can get and set tags for different object types
-	 *
-	 * @see \OCP\ITagManager::load()
-	 * @return \OCP\ITagManager
-	 * @since 6.0.0
-	 */
-	public function getTagManager();
-
-	/**
-	 * Returns the root folder of ownCloud's data directory
-	 *
-	 * @return \OCP\Files\IRootFolder
-	 * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder
-	 */
-	public function getRootFolder();
-
-	/**
-	 * Returns a view to ownCloud's files folder
-	 *
-	 * @param string $userId user ID
-	 * @return \OCP\Files\Folder
-	 * @since 6.0.0 - parameter $userId was added in 8.0.0
-	 * @see getUserFolder in \OCP\Files\IRootFolder
-	 */
-	public function getUserFolder($userId = null);
-
-	/**
-	 * Returns an app-specific view in ownClouds data directory
-	 *
-	 * @return \OCP\Files\Folder
-	 * @since 6.0.0
-	 * @deprecated 9.2.0 use IAppData
-	 */
-	public function getAppFolder();
-
-	/**
-	 * Returns a user manager
-	 *
-	 * @return \OCP\IUserManager
-	 * @since 8.0.0
-	 */
-	public function getUserManager();
-
-	/**
-	 * Returns a group manager
-	 *
-	 * @return \OCP\IGroupManager
-	 * @since 8.0.0
-	 */
-	public function getGroupManager();
-
-	/**
-	 * Returns the user session
-	 *
-	 * @return \OCP\IUserSession
-	 * @since 6.0.0
-	 */
-	public function getUserSession();
-
-	/**
-	 * Returns the navigation manager
-	 *
-	 * @return \OCP\INavigationManager
-	 * @since 6.0.0
-	 */
-	public function getNavigationManager();
-
-	/**
-	 * Returns the config manager
-	 *
-	 * @return \OCP\IConfig
-	 * @since 6.0.0
-	 */
-	public function getConfig();
-
-	/**
-	 * Returns a Crypto instance
-	 *
-	 * @return \OCP\Security\ICrypto
-	 * @since 8.0.0
-	 */
-	public function getCrypto();
-
-	/**
-	 * Returns a Hasher instance
-	 *
-	 * @return \OCP\Security\IHasher
-	 * @since 8.0.0
-	 */
-	public function getHasher();
-
-	/**
-	 * Returns a SecureRandom instance
-	 *
-	 * @return \OCP\Security\ISecureRandom
-	 * @since 8.1.0
-	 */
-	public function getSecureRandom();
-
-	/**
-	 * Returns a CredentialsManager instance
-	 *
-	 * @return \OCP\Security\ICredentialsManager
-	 * @since 9.0.0
-	 */
-	public function getCredentialsManager();
-
-	/**
-	 * Returns the app config manager
-	 *
-	 * @return \OCP\IAppConfig
-	 * @since 7.0.0
-	 */
-	public function getAppConfig();
-
-	/**
-	 * @return \OCP\L10N\IFactory
-	 * @since 8.2.0
-	 */
-	public function getL10NFactory();
-
-	/**
-	 * get an L10N instance
-	 * @param string $app appid
-	 * @param string $lang
-	 * @return \OCP\IL10N
-	 * @since 6.0.0 - parameter $lang was added in 8.0.0
-	 */
-	public function getL10N($app, $lang = null);
-
-	/**
-	 * @return \OC\Encryption\Manager
-	 * @since 8.1.0
-	 */
-	public function getEncryptionManager();
-
-	/**
-	 * @return \OC\Encryption\File
-	 * @since 8.1.0
-	 */
-	public function getEncryptionFilesHelper();
-
-	/**
-	 * @return \OCP\Encryption\Keys\IStorage
-	 * @since 8.1.0
-	 */
-	public function getEncryptionKeyStorage();
-
-	/**
-	 * Returns the URL generator
-	 *
-	 * @return \OCP\IURLGenerator
-	 * @since 6.0.0
-	 */
-	public function getURLGenerator();
-
-	/**
-	 * Returns an ICache instance
-	 *
-	 * @return \OCP\ICache
-	 * @since 6.0.0
-	 */
-	public function getCache();
-
-	/**
-	 * Returns an \OCP\CacheFactory instance
-	 *
-	 * @return \OCP\ICacheFactory
-	 * @since 7.0.0
-	 */
-	public function getMemCacheFactory();
-
-	/**
-	 * Returns the current session
-	 *
-	 * @return \OCP\ISession
-	 * @since 6.0.0
-	 */
-	public function getSession();
-
-	/**
-	 * Returns the activity manager
-	 *
-	 * @return \OCP\Activity\IManager
-	 * @since 6.0.0
-	 */
-	public function getActivityManager();
-
-	/**
-	 * Returns the current session
-	 *
-	 * @return \OCP\IDBConnection
-	 * @since 6.0.0
-	 */
-	public function getDatabaseConnection();
-
-	/**
-	 * Returns an avatar manager, used for avatar functionality
-	 *
-	 * @return \OCP\IAvatarManager
-	 * @since 6.0.0
-	 */
-	public function getAvatarManager();
-
-	/**
-	 * Returns an job list for controlling background jobs
-	 *
-	 * @return \OCP\BackgroundJob\IJobList
-	 * @since 7.0.0
-	 */
-	public function getJobList();
-
-	/**
-	 * Returns a logger instance
-	 *
-	 * @return \OCP\ILogger
-	 * @since 8.0.0
-	 */
-	public function getLogger();
-
-	/**
-	 * returns a log factory instance
-	 *
-	 * @return ILogFactory
-	 * @since 14.0.0
-	 */
-	public function getLogFactory();
-
-	/**
-	 * Returns a router for generating and matching urls
-	 *
-	 * @return \OCP\Route\IRouter
-	 * @since 7.0.0
-	 */
-	public function getRouter();
-
-	/**
-	 * Returns a search instance
-	 *
-	 * @return \OCP\ISearch
-	 * @since 7.0.0
-	 */
-	public function getSearch();
-
-	/**
-	 * Get the certificate manager for the user
-	 *
-	 * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager
-	 * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in
-	 * @since 8.0.0
-	 */
-	public function getCertificateManager($userId = null);
-
-	/**
-	 * Create a new event source
-	 *
-	 * @return \OCP\IEventSource
-	 * @since 8.0.0
-	 */
-	public function createEventSource();
-
-	/**
-	 * Returns an instance of the HTTP client service
-	 *
-	 * @return \OCP\Http\Client\IClientService
-	 * @since 8.1.0
-	 */
-	public function getHTTPClientService();
-
-	/**
-	 * Get the active event logger
-	 *
-	 * @return \OCP\Diagnostics\IEventLogger
-	 * @since 8.0.0
-	 */
-	public function getEventLogger();
-
-	/**
-	 * Get the active query logger
-	 *
-	 * The returned logger only logs data when debug mode is enabled
-	 *
-	 * @return \OCP\Diagnostics\IQueryLogger
-	 * @since 8.0.0
-	 */
-	public function getQueryLogger();
-
-	/**
-	 * Get the manager for temporary files and folders
-	 *
-	 * @return \OCP\ITempManager
-	 * @since 8.0.0
-	 */
-	public function getTempManager();
-
-	/**
-	 * Get the app manager
-	 *
-	 * @return \OCP\App\IAppManager
-	 * @since 8.0.0
-	 */
-	public function getAppManager();
-
-	/**
-	 * Get the webroot
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getWebRoot();
-
-	/**
-	 * @return \OCP\Files\Config\IMountProviderCollection
-	 * @since 8.0.0
-	 */
-	public function getMountProviderCollection();
-
-	/**
-	 * Get the IniWrapper
-	 *
-	 * @return \bantu\IniGetWrapper\IniGetWrapper
-	 * @since 8.0.0
-	 */
-	public function getIniWrapper();
-	/**
-	 * @return \OCP\Command\IBus
-	 * @since 8.1.0
-	 */
-	public function getCommandBus();
-
-	/**
-	 * Creates a new mailer
-	 *
-	 * @return \OCP\Mail\IMailer
-	 * @since 8.1.0
-	 */
-	public function getMailer();
-
-	/**
-	 * Get the locking provider
-	 *
-	 * @return \OCP\Lock\ILockingProvider
-	 * @since 8.1.0
-	 */
-	public function getLockingProvider();
-
-	/**
-	 * @return \OCP\Files\Mount\IMountManager
-	 * @since 8.2.0
-	 */
-	public function getMountManager();
-
-	/**
-	 * Get the MimeTypeDetector
-	 *
-	 * @return \OCP\Files\IMimeTypeDetector
-	 * @since 8.2.0
-	 */
-	public function getMimeTypeDetector();
-
-	/**
-	 * Get the MimeTypeLoader
-	 *
-	 * @return \OCP\Files\IMimeTypeLoader
-	 * @since 8.2.0
-	 */
-	public function getMimeTypeLoader();
-
-	/**
-	 * Get the EventDispatcher
-	 *
-	 * @return EventDispatcherInterface
-	 * @since 8.2.0
-	 */
-	public function getEventDispatcher();
-
-	/**
-	 * Get the Notification Manager
-	 *
-	 * @return \OCP\Notification\IManager
-	 * @since 9.0.0
-	 */
-	public function getNotificationManager();
-
-	/**
-	 * @return \OCP\Comments\ICommentsManager
-	 * @since 9.0.0
-	 */
-	public function getCommentsManager();
-
-	/**
-	 * Returns the system-tag manager
-	 *
-	 * @return \OCP\SystemTag\ISystemTagManager
-	 *
-	 * @since 9.0.0
-	 */
-	public function getSystemTagManager();
-
-	/**
-	 * Returns the system-tag object mapper
-	 *
-	 * @return \OCP\SystemTag\ISystemTagObjectMapper
-	 *
-	 * @since 9.0.0
-	 */
-	public function getSystemTagObjectMapper();
-
-	/**
-	 * Returns the share manager
-	 *
-	 * @return \OCP\Share\IManager
-	 * @since 9.0.0
-	 */
-	public function getShareManager();
-
-	/**
-	 * @return IContentSecurityPolicyManager
-	 * @since 9.0.0
-	 */
-	public function getContentSecurityPolicyManager();
-
-	/**
-	 * @return \OCP\IDateTimeZone
-	 * @since 8.0.0
-	 */
-	public function getDateTimeZone();
-
-	/**
-	 * @return \OCP\IDateTimeFormatter
-	 * @since 8.0.0
-	 */
-	public function getDateTimeFormatter();
-
-	/**
-	 * @return \OCP\Federation\ICloudIdManager
-	 * @since 12.0.0
-	 */
-	public function getCloudIdManager();
-
-	/**
-	 * @return \OCP\GlobalScale\IConfig
-	 * @since 14.0.0
-	 */
-	public function getGlobalScaleConfig();
-
-	/**
-	 * @return ICloudFederationFactory
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationFactory();
-
-	/**
-	 * @return ICloudFederationProviderManager
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationProviderManager();
-
-	/**
-	 * @return \OCP\Remote\Api\IApiFactory
-	 * @since 13.0.0
-	 */
-	public function getRemoteApiFactory();
-
-	/**
-	 * @return \OCP\Remote\IInstanceFactory
-	 * @since 13.0.0
-	 */
-	public function getRemoteInstanceFactory();
+    /**
+     * The calendar manager will act as a broker between consumers for calendar information and
+     * providers which actual deliver the calendar information.
+     *
+     * @return \OCP\Calendar\IManager
+     * @since 13.0.0
+     */
+    public function getCalendarManager();
+
+    /**
+     * The contacts manager will act as a broker between consumers for contacts information and
+     * providers which actual deliver the contact information.
+     *
+     * @return \OCP\Contacts\IManager
+     * @since 6.0.0
+     */
+    public function getContactsManager();
+
+    /**
+     * The current request object holding all information about the request currently being processed
+     * is returned from this method.
+     * In case the current execution was not initiated by a web request null is returned
+     *
+     * @return \OCP\IRequest
+     * @since 6.0.0
+     */
+    public function getRequest();
+
+    /**
+     * Returns the preview manager which can create preview images for a given file
+     *
+     * @return \OCP\IPreview
+     * @since 6.0.0
+     */
+    public function getPreviewManager();
+
+    /**
+     * Returns the tag manager which can get and set tags for different object types
+     *
+     * @see \OCP\ITagManager::load()
+     * @return \OCP\ITagManager
+     * @since 6.0.0
+     */
+    public function getTagManager();
+
+    /**
+     * Returns the root folder of ownCloud's data directory
+     *
+     * @return \OCP\Files\IRootFolder
+     * @since 6.0.0 - between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder
+     */
+    public function getRootFolder();
+
+    /**
+     * Returns a view to ownCloud's files folder
+     *
+     * @param string $userId user ID
+     * @return \OCP\Files\Folder
+     * @since 6.0.0 - parameter $userId was added in 8.0.0
+     * @see getUserFolder in \OCP\Files\IRootFolder
+     */
+    public function getUserFolder($userId = null);
+
+    /**
+     * Returns an app-specific view in ownClouds data directory
+     *
+     * @return \OCP\Files\Folder
+     * @since 6.0.0
+     * @deprecated 9.2.0 use IAppData
+     */
+    public function getAppFolder();
+
+    /**
+     * Returns a user manager
+     *
+     * @return \OCP\IUserManager
+     * @since 8.0.0
+     */
+    public function getUserManager();
+
+    /**
+     * Returns a group manager
+     *
+     * @return \OCP\IGroupManager
+     * @since 8.0.0
+     */
+    public function getGroupManager();
+
+    /**
+     * Returns the user session
+     *
+     * @return \OCP\IUserSession
+     * @since 6.0.0
+     */
+    public function getUserSession();
+
+    /**
+     * Returns the navigation manager
+     *
+     * @return \OCP\INavigationManager
+     * @since 6.0.0
+     */
+    public function getNavigationManager();
+
+    /**
+     * Returns the config manager
+     *
+     * @return \OCP\IConfig
+     * @since 6.0.0
+     */
+    public function getConfig();
+
+    /**
+     * Returns a Crypto instance
+     *
+     * @return \OCP\Security\ICrypto
+     * @since 8.0.0
+     */
+    public function getCrypto();
+
+    /**
+     * Returns a Hasher instance
+     *
+     * @return \OCP\Security\IHasher
+     * @since 8.0.0
+     */
+    public function getHasher();
+
+    /**
+     * Returns a SecureRandom instance
+     *
+     * @return \OCP\Security\ISecureRandom
+     * @since 8.1.0
+     */
+    public function getSecureRandom();
+
+    /**
+     * Returns a CredentialsManager instance
+     *
+     * @return \OCP\Security\ICredentialsManager
+     * @since 9.0.0
+     */
+    public function getCredentialsManager();
+
+    /**
+     * Returns the app config manager
+     *
+     * @return \OCP\IAppConfig
+     * @since 7.0.0
+     */
+    public function getAppConfig();
+
+    /**
+     * @return \OCP\L10N\IFactory
+     * @since 8.2.0
+     */
+    public function getL10NFactory();
+
+    /**
+     * get an L10N instance
+     * @param string $app appid
+     * @param string $lang
+     * @return \OCP\IL10N
+     * @since 6.0.0 - parameter $lang was added in 8.0.0
+     */
+    public function getL10N($app, $lang = null);
+
+    /**
+     * @return \OC\Encryption\Manager
+     * @since 8.1.0
+     */
+    public function getEncryptionManager();
+
+    /**
+     * @return \OC\Encryption\File
+     * @since 8.1.0
+     */
+    public function getEncryptionFilesHelper();
+
+    /**
+     * @return \OCP\Encryption\Keys\IStorage
+     * @since 8.1.0
+     */
+    public function getEncryptionKeyStorage();
+
+    /**
+     * Returns the URL generator
+     *
+     * @return \OCP\IURLGenerator
+     * @since 6.0.0
+     */
+    public function getURLGenerator();
+
+    /**
+     * Returns an ICache instance
+     *
+     * @return \OCP\ICache
+     * @since 6.0.0
+     */
+    public function getCache();
+
+    /**
+     * Returns an \OCP\CacheFactory instance
+     *
+     * @return \OCP\ICacheFactory
+     * @since 7.0.0
+     */
+    public function getMemCacheFactory();
+
+    /**
+     * Returns the current session
+     *
+     * @return \OCP\ISession
+     * @since 6.0.0
+     */
+    public function getSession();
+
+    /**
+     * Returns the activity manager
+     *
+     * @return \OCP\Activity\IManager
+     * @since 6.0.0
+     */
+    public function getActivityManager();
+
+    /**
+     * Returns the current session
+     *
+     * @return \OCP\IDBConnection
+     * @since 6.0.0
+     */
+    public function getDatabaseConnection();
+
+    /**
+     * Returns an avatar manager, used for avatar functionality
+     *
+     * @return \OCP\IAvatarManager
+     * @since 6.0.0
+     */
+    public function getAvatarManager();
+
+    /**
+     * Returns an job list for controlling background jobs
+     *
+     * @return \OCP\BackgroundJob\IJobList
+     * @since 7.0.0
+     */
+    public function getJobList();
+
+    /**
+     * Returns a logger instance
+     *
+     * @return \OCP\ILogger
+     * @since 8.0.0
+     */
+    public function getLogger();
+
+    /**
+     * returns a log factory instance
+     *
+     * @return ILogFactory
+     * @since 14.0.0
+     */
+    public function getLogFactory();
+
+    /**
+     * Returns a router for generating and matching urls
+     *
+     * @return \OCP\Route\IRouter
+     * @since 7.0.0
+     */
+    public function getRouter();
+
+    /**
+     * Returns a search instance
+     *
+     * @return \OCP\ISearch
+     * @since 7.0.0
+     */
+    public function getSearch();
+
+    /**
+     * Get the certificate manager for the user
+     *
+     * @param string $userId (optional) if not specified the current loggedin user is used, use null to get the system certificate manager
+     * @return \OCP\ICertificateManager | null if $userId is null and no user is logged in
+     * @since 8.0.0
+     */
+    public function getCertificateManager($userId = null);
+
+    /**
+     * Create a new event source
+     *
+     * @return \OCP\IEventSource
+     * @since 8.0.0
+     */
+    public function createEventSource();
+
+    /**
+     * Returns an instance of the HTTP client service
+     *
+     * @return \OCP\Http\Client\IClientService
+     * @since 8.1.0
+     */
+    public function getHTTPClientService();
+
+    /**
+     * Get the active event logger
+     *
+     * @return \OCP\Diagnostics\IEventLogger
+     * @since 8.0.0
+     */
+    public function getEventLogger();
+
+    /**
+     * Get the active query logger
+     *
+     * The returned logger only logs data when debug mode is enabled
+     *
+     * @return \OCP\Diagnostics\IQueryLogger
+     * @since 8.0.0
+     */
+    public function getQueryLogger();
+
+    /**
+     * Get the manager for temporary files and folders
+     *
+     * @return \OCP\ITempManager
+     * @since 8.0.0
+     */
+    public function getTempManager();
+
+    /**
+     * Get the app manager
+     *
+     * @return \OCP\App\IAppManager
+     * @since 8.0.0
+     */
+    public function getAppManager();
+
+    /**
+     * Get the webroot
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getWebRoot();
+
+    /**
+     * @return \OCP\Files\Config\IMountProviderCollection
+     * @since 8.0.0
+     */
+    public function getMountProviderCollection();
+
+    /**
+     * Get the IniWrapper
+     *
+     * @return \bantu\IniGetWrapper\IniGetWrapper
+     * @since 8.0.0
+     */
+    public function getIniWrapper();
+    /**
+     * @return \OCP\Command\IBus
+     * @since 8.1.0
+     */
+    public function getCommandBus();
+
+    /**
+     * Creates a new mailer
+     *
+     * @return \OCP\Mail\IMailer
+     * @since 8.1.0
+     */
+    public function getMailer();
+
+    /**
+     * Get the locking provider
+     *
+     * @return \OCP\Lock\ILockingProvider
+     * @since 8.1.0
+     */
+    public function getLockingProvider();
+
+    /**
+     * @return \OCP\Files\Mount\IMountManager
+     * @since 8.2.0
+     */
+    public function getMountManager();
+
+    /**
+     * Get the MimeTypeDetector
+     *
+     * @return \OCP\Files\IMimeTypeDetector
+     * @since 8.2.0
+     */
+    public function getMimeTypeDetector();
+
+    /**
+     * Get the MimeTypeLoader
+     *
+     * @return \OCP\Files\IMimeTypeLoader
+     * @since 8.2.0
+     */
+    public function getMimeTypeLoader();
+
+    /**
+     * Get the EventDispatcher
+     *
+     * @return EventDispatcherInterface
+     * @since 8.2.0
+     */
+    public function getEventDispatcher();
+
+    /**
+     * Get the Notification Manager
+     *
+     * @return \OCP\Notification\IManager
+     * @since 9.0.0
+     */
+    public function getNotificationManager();
+
+    /**
+     * @return \OCP\Comments\ICommentsManager
+     * @since 9.0.0
+     */
+    public function getCommentsManager();
+
+    /**
+     * Returns the system-tag manager
+     *
+     * @return \OCP\SystemTag\ISystemTagManager
+     *
+     * @since 9.0.0
+     */
+    public function getSystemTagManager();
+
+    /**
+     * Returns the system-tag object mapper
+     *
+     * @return \OCP\SystemTag\ISystemTagObjectMapper
+     *
+     * @since 9.0.0
+     */
+    public function getSystemTagObjectMapper();
+
+    /**
+     * Returns the share manager
+     *
+     * @return \OCP\Share\IManager
+     * @since 9.0.0
+     */
+    public function getShareManager();
+
+    /**
+     * @return IContentSecurityPolicyManager
+     * @since 9.0.0
+     */
+    public function getContentSecurityPolicyManager();
+
+    /**
+     * @return \OCP\IDateTimeZone
+     * @since 8.0.0
+     */
+    public function getDateTimeZone();
+
+    /**
+     * @return \OCP\IDateTimeFormatter
+     * @since 8.0.0
+     */
+    public function getDateTimeFormatter();
+
+    /**
+     * @return \OCP\Federation\ICloudIdManager
+     * @since 12.0.0
+     */
+    public function getCloudIdManager();
+
+    /**
+     * @return \OCP\GlobalScale\IConfig
+     * @since 14.0.0
+     */
+    public function getGlobalScaleConfig();
+
+    /**
+     * @return ICloudFederationFactory
+     * @since 14.0.0
+     */
+    public function getCloudFederationFactory();
+
+    /**
+     * @return ICloudFederationProviderManager
+     * @since 14.0.0
+     */
+    public function getCloudFederationProviderManager();
+
+    /**
+     * @return \OCP\Remote\Api\IApiFactory
+     * @since 13.0.0
+     */
+    public function getRemoteApiFactory();
+
+    /**
+     * @return \OCP\Remote\IInstanceFactory
+     * @since 13.0.0
+     */
+    public function getRemoteInstanceFactory();
 }

lib/public/Federation/Exceptions/AuthenticationFailedException.php

Indentation +12 added lines, -12 removed lines

@@ -32,17 +32,17 @@
  */
 class AuthenticationFailedException extends HintException {
 
-	/**
-	 * BadRequestException constructor.
-	 *
-	 * @since 14.0.0
-	 *
-	 */
-	public function __construct() {
-		$l = \OC::$server->getL10N('federation');
-		$message = 'Authentication failed, wrong token or provider ID given';
-		$hint = $l->t('Authentication failed, wrong token or provider ID given');
-		parent::__construct($message, $hint);
-	}
+    /**
+     * BadRequestException constructor.
+     *
+     * @since 14.0.0
+     *
+     */
+    public function __construct() {
+        $l = \OC::$server->getL10N('federation');
+        $message = 'Authentication failed, wrong token or provider ID given';
+        $hint = $l->t('Authentication failed, wrong token or provider ID given');
+        parent::__construct($message, $hint);
+    }
 
 }

apps/federatedfilesharing/lib/Controller/RequestHandlerController.php

Indentation +427 added lines, -427 removed lines

@@ -52,431 +52,431 @@
 
 class RequestHandlerController extends OCSController {
 
-	/** @var FederatedShareProvider */
-	private $federatedShareProvider;
-
-	/** @var IDBConnection */
-	private $connection;
-
-	/** @var Share\IManager */
-	private $shareManager;
-
-	/** @var Notifications */
-	private $notifications;
-
-	/** @var AddressHandler */
-	private $addressHandler;
-
-	/** @var  IUserManager */
-	private $userManager;
-
-	/** @var string */
-	private $shareTable = 'share';
-
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var ICloudFederationFactory */
-	private $cloudFederationFactory;
-
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
-
-	/**
-	 * Server2Server constructor.
-	 *
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param FederatedShareProvider $federatedShareProvider
-	 * @param IDBConnection $connection
-	 * @param Share\IManager $shareManager
-	 * @param Notifications $notifications
-	 * @param AddressHandler $addressHandler
-	 * @param IUserManager $userManager
-	 * @param ICloudIdManager $cloudIdManager
-	 * @param ILogger $logger
-	 * @param ICloudFederationFactory $cloudFederationFactory
-	 * @param ICloudFederationProviderManager $cloudFederationProviderManager
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								FederatedShareProvider $federatedShareProvider,
-								IDBConnection $connection,
-								Share\IManager $shareManager,
-								Notifications $notifications,
-								AddressHandler $addressHandler,
-								IUserManager $userManager,
-								ICloudIdManager $cloudIdManager,
-								ILogger $logger,
-								ICloudFederationFactory $cloudFederationFactory,
-								ICloudFederationProviderManager $cloudFederationProviderManager
-	) {
-		parent::__construct($appName, $request);
-
-		$this->federatedShareProvider = $federatedShareProvider;
-		$this->connection = $connection;
-		$this->shareManager = $shareManager;
-		$this->notifications = $notifications;
-		$this->addressHandler = $addressHandler;
-		$this->userManager = $userManager;
-		$this->cloudIdManager = $cloudIdManager;
-		$this->logger = $logger;
-		$this->cloudFederationFactory = $cloudFederationFactory;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * create a new share
-	 *
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 */
-	public function createShare() {
-
-		$remote = isset($_POST['remote']) ? $_POST['remote'] : null;
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-		$name = isset($_POST['name']) ? $_POST['name'] : null;
-		$owner = isset($_POST['owner']) ? $_POST['owner'] : null;
-		$sharedBy = isset($_POST['sharedBy']) ? $_POST['sharedBy'] : null;
-		$shareWith = isset($_POST['shareWith']) ? $_POST['shareWith'] : null;
-		$remoteId = isset($_POST['remoteId']) ? (int)$_POST['remoteId'] : null;
-		$sharedByFederatedId = isset($_POST['sharedByFederatedId']) ? $_POST['sharedByFederatedId'] : null;
-		$ownerFederatedId = isset($_POST['ownerFederatedId']) ? $_POST['ownerFederatedId'] : null;
-
-		if ($ownerFederatedId === null) {
-			$ownerFederatedId = $this->cloudIdManager->getCloudId($owner, $this->cleanupRemote($remote))->getId();
-		}
-		// if the owner of the share and the initiator are the same user
-		// we also complete the federated share ID for the initiator
-		if ($sharedByFederatedId === null && $owner === $sharedBy) {
-			$sharedByFederatedId = $ownerFederatedId;
-		}
-
-		$share = $this->cloudFederationFactory->getCloudFederationShare(
-			$shareWith,
-			$name,
-			'',
-			$remoteId,
-			$ownerFederatedId,
-			$owner,
-			$sharedByFederatedId,
-			$sharedBy,
-			$token,
-			'user',
-			'file'
-		);
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$provider->shareReceived($share);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ProviderCouldNotAddShareException $e) {
-			throw new OCSException($e->getMessage(), 400);
-		} catch (\Exception $e) {
-			throw new OCSException('internal server error, was not able to add share from ' . $remote, 500);
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * create re-share on behalf of another user
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSBadRequestException
-	 * @throws OCSException
-	 * @throws OCSForbiddenException
-	 */
-	public function reShare($id) {
-
-		$token = $this->request->getParam('token', null);
-		$shareWith = $this->request->getParam('shareWith', null);
-		$permission = (int)$this->request->getParam('permission', null);
-		$remoteId = (int)$this->request->getParam('remoteId', null);
-
-		if ($id === null ||
-			$token === null ||
-			$shareWith === null ||
-			$permission === null ||
-			$remoteId === null
-		) {
-			throw new OCSBadRequestException();
-		}
-
-		$notification = [
-			'sharedSecret' => $token,
-			'shareWith' => $shareWith,
-			'senderId' => $remoteId,
-			'message' => 'Recipient of a share ask the owner to reshare the file'
-		];
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			list($newToken, $localId) = $provider->notificationReceived('REQUEST_RESHARE', $id, $notification);
-			return new Http\DataResponse([
-				'token' => $newToken,
-				'remoteId' => $localId
-			]);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ShareNotFound $e) {
-			$this->logger->debug('Share not found: ' . $e->getMessage());
-		} catch (\Exception $e) {
-			$this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
-		}
-
-		throw new OCSBadRequestException();
-	}
-
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * accept server-to-server share
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 * @throws ShareNotFound
-	 * @throws \OC\HintException
-	 */
-	public function acceptShare($id) {
-
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-
-		$notification = [
-			'sharedSecret' => $token,
-			'message' => 'Recipient accept the share'
-		];
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$provider->notificationReceived('SHARE_ACCEPTED', $id, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ShareNotFound $e) {
-			$this->logger->debug('Share not found: ' . $e->getMessage());
-		} catch (\Exception $e) {
-			$this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * decline server-to-server share
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 */
-	public function declineShare($id) {
-
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-
-		$notification = [
-			'sharedSecret' => $token,
-			'message' => 'Recipient declined the share'
-		];
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$provider->notificationReceived('SHARE_DECLINED', $id, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		} catch (ShareNotFound $e) {
-			$this->logger->debug('Share not found: ' . $e->getMessage());
-		} catch (\Exception $e) {
-			$this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * remove server-to-server share if it was unshared by the owner
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSException
-	 */
-	public function unshare($id) {
-
-		if (!$this->isS2SEnabled()) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		}
-
-		$token = isset($_POST['token']) ? $_POST['token'] : null;
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$notification = ['sharedSecret' => $token];
-			$provider->notificationReceived('SHARE_UNSHARED', $id, $notification);
-		} catch (\Exception $e) {
-			$this->logger->debug('processing unshare notification failed: ' . $e->getMessage());
-		}
-
-		return new Http\DataResponse();
-	}
-
-	private function cleanupRemote($remote) {
-		$remote = substr($remote, strpos($remote, '://') + 3);
-
-		return rtrim($remote, '/');
-	}
-
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * federated share was revoked, either by the owner or the re-sharer
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSBadRequestException
-	 */
-	public function revoke($id) {
-
-		$token = $this->request->getParam('token');
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$notification = ['sharedSecret' => $token];
-			$provider->notificationReceived('RESHARE_UNDO', $id, $notification);
-			return new Http\DataResponse();
-		} catch (\Exception $e) {
-			throw new OCSBadRequestException();
-		}
-
-	}
-
-	/**
-	 * check if server-to-server sharing is enabled
-	 *
-	 * @param bool $incoming
-	 * @return bool
-	 */
-	private function isS2SEnabled($incoming = false) {
-
-		$result = \OCP\App::isEnabled('files_sharing');
-
-		if ($incoming) {
-			$result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled();
-		} else {
-			$result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
-		}
-
-		return $result;
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * update share information to keep federated re-shares in sync
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws OCSBadRequestException
-	 */
-	public function updatePermissions($id) {
-		$token = $this->request->getParam('token', null);
-		$ncPermissions = $this->request->getParam('permissions', null);
-
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
-			$ocmPermissions = $this->ncPermissions2ocmPermissions((int)$ncPermissions);
-			$notification = ['sharedSecret' => $token, 'permission' => $ocmPermissions];
-			$provider->notificationReceived('RESHARE_CHANGE_PERMISSION', $id, $notification);
-		} catch (\Exception $e) {
-			$this->logger->debug($e->getMessage());
-			throw new OCSBadRequestException();
-		}
-
-		return new Http\DataResponse();
-	}
-
-	/**
-	 * translate Nextcloud permissions to OCM Permissions
-	 *
-	 * @param $ncPermissions
-	 * @return array
-	 */
-	protected function ncPermissions2ocmPermissions($ncPermissions) {
-
-		$ocmPermissions = [];
-
-		if ($ncPermissions & Constants::PERMISSION_SHARE) {
-			$ocmPermissions[] = 'share';
-		}
-
-		if ($ncPermissions & Constants::PERMISSION_READ) {
-			$ocmPermissions[] = 'read';
-		}
-
-		if (($ncPermissions & Constants::PERMISSION_CREATE) ||
-			($ncPermissions & Constants::PERMISSION_UPDATE)) {
-			$ocmPermissions[] = 'write';
-		}
-
-		return $ocmPermissions;
-
-	}
-
-	/**
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 *
-	 * change the owner of a server-to-server share
-	 *
-	 * @param int $id
-	 * @return Http\DataResponse
-	 * @throws \InvalidArgumentException
-	 * @throws OCSException
-	 */
-	public function move($id) {
-
-		if (!$this->isS2SEnabled()) {
-			throw new OCSException('Server does not support federated cloud sharing', 503);
-		}
-
-		$token = $this->request->getParam('token');
-		$remote = $this->request->getParam('remote');
-		$newRemoteId = $this->request->getParam('remote_id', $id);
-		$cloudId = $this->cloudIdManager->resolveCloudId($remote);
-
-		$qb = $this->connection->getQueryBuilder();
-		$query = $qb->update('share_external')
-			->set('remote', $qb->createNamedParameter($cloudId->getRemote()))
-			->set('owner', $qb->createNamedParameter($cloudId->getUser()))
-			->set('remote_id', $qb->createNamedParameter($newRemoteId))
-			->where($qb->expr()->eq('remote_id', $qb->createNamedParameter($id)))
-			->andWhere($qb->expr()->eq('share_token', $qb->createNamedParameter($token)));
-		$affected = $query->execute();
-
-		if ($affected > 0) {
-			return new Http\DataResponse(['remote' => $cloudId->getRemote(), 'owner' => $cloudId->getUser()]);
-		} else {
-			throw new OCSBadRequestException('Share not found or token invalid');
-		}
-	}
+    /** @var FederatedShareProvider */
+    private $federatedShareProvider;
+
+    /** @var IDBConnection */
+    private $connection;
+
+    /** @var Share\IManager */
+    private $shareManager;
+
+    /** @var Notifications */
+    private $notifications;
+
+    /** @var AddressHandler */
+    private $addressHandler;
+
+    /** @var  IUserManager */
+    private $userManager;
+
+    /** @var string */
+    private $shareTable = 'share';
+
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var ICloudFederationFactory */
+    private $cloudFederationFactory;
+
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
+
+    /**
+     * Server2Server constructor.
+     *
+     * @param string $appName
+     * @param IRequest $request
+     * @param FederatedShareProvider $federatedShareProvider
+     * @param IDBConnection $connection
+     * @param Share\IManager $shareManager
+     * @param Notifications $notifications
+     * @param AddressHandler $addressHandler
+     * @param IUserManager $userManager
+     * @param ICloudIdManager $cloudIdManager
+     * @param ILogger $logger
+     * @param ICloudFederationFactory $cloudFederationFactory
+     * @param ICloudFederationProviderManager $cloudFederationProviderManager
+     */
+    public function __construct($appName,
+                                IRequest $request,
+                                FederatedShareProvider $federatedShareProvider,
+                                IDBConnection $connection,
+                                Share\IManager $shareManager,
+                                Notifications $notifications,
+                                AddressHandler $addressHandler,
+                                IUserManager $userManager,
+                                ICloudIdManager $cloudIdManager,
+                                ILogger $logger,
+                                ICloudFederationFactory $cloudFederationFactory,
+                                ICloudFederationProviderManager $cloudFederationProviderManager
+    ) {
+        parent::__construct($appName, $request);
+
+        $this->federatedShareProvider = $federatedShareProvider;
+        $this->connection = $connection;
+        $this->shareManager = $shareManager;
+        $this->notifications = $notifications;
+        $this->addressHandler = $addressHandler;
+        $this->userManager = $userManager;
+        $this->cloudIdManager = $cloudIdManager;
+        $this->logger = $logger;
+        $this->cloudFederationFactory = $cloudFederationFactory;
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * create a new share
+     *
+     * @return Http\DataResponse
+     * @throws OCSException
+     */
+    public function createShare() {
+
+        $remote = isset($_POST['remote']) ? $_POST['remote'] : null;
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+        $name = isset($_POST['name']) ? $_POST['name'] : null;
+        $owner = isset($_POST['owner']) ? $_POST['owner'] : null;
+        $sharedBy = isset($_POST['sharedBy']) ? $_POST['sharedBy'] : null;
+        $shareWith = isset($_POST['shareWith']) ? $_POST['shareWith'] : null;
+        $remoteId = isset($_POST['remoteId']) ? (int)$_POST['remoteId'] : null;
+        $sharedByFederatedId = isset($_POST['sharedByFederatedId']) ? $_POST['sharedByFederatedId'] : null;
+        $ownerFederatedId = isset($_POST['ownerFederatedId']) ? $_POST['ownerFederatedId'] : null;
+
+        if ($ownerFederatedId === null) {
+            $ownerFederatedId = $this->cloudIdManager->getCloudId($owner, $this->cleanupRemote($remote))->getId();
+        }
+        // if the owner of the share and the initiator are the same user
+        // we also complete the federated share ID for the initiator
+        if ($sharedByFederatedId === null && $owner === $sharedBy) {
+            $sharedByFederatedId = $ownerFederatedId;
+        }
+
+        $share = $this->cloudFederationFactory->getCloudFederationShare(
+            $shareWith,
+            $name,
+            '',
+            $remoteId,
+            $ownerFederatedId,
+            $owner,
+            $sharedByFederatedId,
+            $sharedBy,
+            $token,
+            'user',
+            'file'
+        );
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $provider->shareReceived($share);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ProviderCouldNotAddShareException $e) {
+            throw new OCSException($e->getMessage(), 400);
+        } catch (\Exception $e) {
+            throw new OCSException('internal server error, was not able to add share from ' . $remote, 500);
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * create re-share on behalf of another user
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSBadRequestException
+     * @throws OCSException
+     * @throws OCSForbiddenException
+     */
+    public function reShare($id) {
+
+        $token = $this->request->getParam('token', null);
+        $shareWith = $this->request->getParam('shareWith', null);
+        $permission = (int)$this->request->getParam('permission', null);
+        $remoteId = (int)$this->request->getParam('remoteId', null);
+
+        if ($id === null ||
+            $token === null ||
+            $shareWith === null ||
+            $permission === null ||
+            $remoteId === null
+        ) {
+            throw new OCSBadRequestException();
+        }
+
+        $notification = [
+            'sharedSecret' => $token,
+            'shareWith' => $shareWith,
+            'senderId' => $remoteId,
+            'message' => 'Recipient of a share ask the owner to reshare the file'
+        ];
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            list($newToken, $localId) = $provider->notificationReceived('REQUEST_RESHARE', $id, $notification);
+            return new Http\DataResponse([
+                'token' => $newToken,
+                'remoteId' => $localId
+            ]);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ShareNotFound $e) {
+            $this->logger->debug('Share not found: ' . $e->getMessage());
+        } catch (\Exception $e) {
+            $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
+        }
+
+        throw new OCSBadRequestException();
+    }
+
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * accept server-to-server share
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSException
+     * @throws ShareNotFound
+     * @throws \OC\HintException
+     */
+    public function acceptShare($id) {
+
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+
+        $notification = [
+            'sharedSecret' => $token,
+            'message' => 'Recipient accept the share'
+        ];
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $provider->notificationReceived('SHARE_ACCEPTED', $id, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ShareNotFound $e) {
+            $this->logger->debug('Share not found: ' . $e->getMessage());
+        } catch (\Exception $e) {
+            $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * decline server-to-server share
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSException
+     */
+    public function declineShare($id) {
+
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+
+        $notification = [
+            'sharedSecret' => $token,
+            'message' => 'Recipient declined the share'
+        ];
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $provider->notificationReceived('SHARE_DECLINED', $id, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        } catch (ShareNotFound $e) {
+            $this->logger->debug('Share not found: ' . $e->getMessage());
+        } catch (\Exception $e) {
+            $this->logger->debug('internal server error, can not process notification: ' . $e->getMessage());
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * remove server-to-server share if it was unshared by the owner
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSException
+     */
+    public function unshare($id) {
+
+        if (!$this->isS2SEnabled()) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        }
+
+        $token = isset($_POST['token']) ? $_POST['token'] : null;
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $notification = ['sharedSecret' => $token];
+            $provider->notificationReceived('SHARE_UNSHARED', $id, $notification);
+        } catch (\Exception $e) {
+            $this->logger->debug('processing unshare notification failed: ' . $e->getMessage());
+        }
+
+        return new Http\DataResponse();
+    }
+
+    private function cleanupRemote($remote) {
+        $remote = substr($remote, strpos($remote, '://') + 3);
+
+        return rtrim($remote, '/');
+    }
+
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * federated share was revoked, either by the owner or the re-sharer
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSBadRequestException
+     */
+    public function revoke($id) {
+
+        $token = $this->request->getParam('token');
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $notification = ['sharedSecret' => $token];
+            $provider->notificationReceived('RESHARE_UNDO', $id, $notification);
+            return new Http\DataResponse();
+        } catch (\Exception $e) {
+            throw new OCSBadRequestException();
+        }
+
+    }
+
+    /**
+     * check if server-to-server sharing is enabled
+     *
+     * @param bool $incoming
+     * @return bool
+     */
+    private function isS2SEnabled($incoming = false) {
+
+        $result = \OCP\App::isEnabled('files_sharing');
+
+        if ($incoming) {
+            $result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled();
+        } else {
+            $result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
+        }
+
+        return $result;
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * update share information to keep federated re-shares in sync
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws OCSBadRequestException
+     */
+    public function updatePermissions($id) {
+        $token = $this->request->getParam('token', null);
+        $ncPermissions = $this->request->getParam('permissions', null);
+
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider('file');
+            $ocmPermissions = $this->ncPermissions2ocmPermissions((int)$ncPermissions);
+            $notification = ['sharedSecret' => $token, 'permission' => $ocmPermissions];
+            $provider->notificationReceived('RESHARE_CHANGE_PERMISSION', $id, $notification);
+        } catch (\Exception $e) {
+            $this->logger->debug($e->getMessage());
+            throw new OCSBadRequestException();
+        }
+
+        return new Http\DataResponse();
+    }
+
+    /**
+     * translate Nextcloud permissions to OCM Permissions
+     *
+     * @param $ncPermissions
+     * @return array
+     */
+    protected function ncPermissions2ocmPermissions($ncPermissions) {
+
+        $ocmPermissions = [];
+
+        if ($ncPermissions & Constants::PERMISSION_SHARE) {
+            $ocmPermissions[] = 'share';
+        }
+
+        if ($ncPermissions & Constants::PERMISSION_READ) {
+            $ocmPermissions[] = 'read';
+        }
+
+        if (($ncPermissions & Constants::PERMISSION_CREATE) ||
+            ($ncPermissions & Constants::PERMISSION_UPDATE)) {
+            $ocmPermissions[] = 'write';
+        }
+
+        return $ocmPermissions;
+
+    }
+
+    /**
+     * @NoCSRFRequired
+     * @PublicPage
+     *
+     * change the owner of a server-to-server share
+     *
+     * @param int $id
+     * @return Http\DataResponse
+     * @throws \InvalidArgumentException
+     * @throws OCSException
+     */
+    public function move($id) {
+
+        if (!$this->isS2SEnabled()) {
+            throw new OCSException('Server does not support federated cloud sharing', 503);
+        }
+
+        $token = $this->request->getParam('token');
+        $remote = $this->request->getParam('remote');
+        $newRemoteId = $this->request->getParam('remote_id', $id);
+        $cloudId = $this->cloudIdManager->resolveCloudId($remote);
+
+        $qb = $this->connection->getQueryBuilder();
+        $query = $qb->update('share_external')
+            ->set('remote', $qb->createNamedParameter($cloudId->getRemote()))
+            ->set('owner', $qb->createNamedParameter($cloudId->getUser()))
+            ->set('remote_id', $qb->createNamedParameter($newRemoteId))
+            ->where($qb->expr()->eq('remote_id', $qb->createNamedParameter($id)))
+            ->andWhere($qb->expr()->eq('share_token', $qb->createNamedParameter($token)));
+        $affected = $query->execute();
+
+        if ($affected > 0) {
+            return new Http\DataResponse(['remote' => $cloudId->getRemote(), 'owner' => $cloudId->getUser()]);
+        } else {
+            throw new OCSBadRequestException('Share not found or token invalid');
+        }
+    }
 }

lib/public/Federation/ICloudFederationProviderManager.php

Indentation +64 added lines, -64 removed lines

@@ -32,76 +32,76 @@
  */
 interface ICloudFederationProviderManager {
 
-	/**
-	 * Registers an callback function which must return an cloud federation provider
-	 *
-	 * @param string $resourceType which resource type does the provider handles
-	 * @param string $displayName user facing name of the federated share provider
-	 * @param callable $callback
-	 * @throws Exceptions\ProviderAlreadyExistsException
-	 *
-	 * @since 14.0.0
-	 */
-	public function addCloudFederationProvider($resourceType, $displayName, callable $callback);
+    /**
+     * Registers an callback function which must return an cloud federation provider
+     *
+     * @param string $resourceType which resource type does the provider handles
+     * @param string $displayName user facing name of the federated share provider
+     * @param callable $callback
+     * @throws Exceptions\ProviderAlreadyExistsException
+     *
+     * @since 14.0.0
+     */
+    public function addCloudFederationProvider($resourceType, $displayName, callable $callback);
 
-	/**
-	 * remove cloud federation provider
-	 *
-	 * @param string $resourceType
-	 *
-	 * @since 14.0.0
-	 */
-	public function removeCloudFederationProvider($resourceType);
+    /**
+     * remove cloud federation provider
+     *
+     * @param string $resourceType
+     *
+     * @since 14.0.0
+     */
+    public function removeCloudFederationProvider($resourceType);
 
-	/**
-	 * get a list of all cloudFederationProviders
-	 *
-	 * @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
-	 *
-	 * @since 14.0.0
-	 */
-	public function getAllCloudFederationProviders();
+    /**
+     * get a list of all cloudFederationProviders
+     *
+     * @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
+     *
+     * @since 14.0.0
+     */
+    public function getAllCloudFederationProviders();
 
-	/**
-	 * get a specific cloud federation provider
-	 *
-	 * @param string $resourceType
-	 * @return ICloudFederationProvider
-	 * @throws Exceptions\ProviderDoesNotExistsException;
-	 *
-	 * @since 14.0.0
-	 */
-	public function getCloudFederationProvider($resourceType);
+    /**
+     * get a specific cloud federation provider
+     *
+     * @param string $resourceType
+     * @return ICloudFederationProvider
+     * @throws Exceptions\ProviderDoesNotExistsException;
+     *
+     * @since 14.0.0
+     */
+    public function getCloudFederationProvider($resourceType);
 
-	/**
-	 * send federated share
-	 *
-	 * @param ICloudFederationShare $share
-	 * @return bool
-	 *
-	 * @since 14.0.0
-	 */
-	public function sendShare(ICloudFederationShare $share);
+    /**
+     * send federated share
+     *
+     * @param ICloudFederationShare $share
+     * @return bool
+     *
+     * @since 14.0.0
+     */
+    public function sendShare(ICloudFederationShare $share);
 
-	/**
-	 * send notification about existing share
-	 *
-	 * @param string $url
-	 * @param ICloudFederationNotification $notification
-	 * @return mixed
-	 *
-	 * @since 14.0.0
-	 */
-	public function sendNotification($url, ICloudFederationNotification $notification);
+    /**
+     * send notification about existing share
+     *
+     * @param string $url
+     * @param ICloudFederationNotification $notification
+     * @return mixed
+     *
+     * @since 14.0.0
+     */
+    public function sendNotification($url, ICloudFederationNotification $notification);
 
-	/**
-	 * check if the new cloud federation API is ready to be used
-	 *
-	 * @return bool
-	 *
-	 * @since 14.0.0
-	 */
-	public function isReady();
+    /**
+     * check if the new cloud federation API is ready to be used
+     *
+     * @return bool
+     *
+     * @since 14.0.0
+     */
+    public function isReady();
 
 
 }

lib/private/Federation/CloudFederationProviderManager.php

Indentation +183 added lines, -183 removed lines

@@ -42,189 +42,189 @@
  */
 class CloudFederationProviderManager implements ICloudFederationProviderManager {
 
-	/** @var array list of available cloud federation providers */
-	private $cloudFederationProvider;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var IClientService */
-	private $httpClientService;
-
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
-
-	/** @var ILogger */
-	private $logger;
-
-	private $supportedAPIVersion = '1.0-proposal1';
-
-	/**
-	 * CloudFederationProviderManager constructor.
-	 *
-	 * @param IAppManager $appManager
-	 * @param IClientService $httpClientService
-	 * @param ICloudIdManager $cloudIdManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(IAppManager $appManager,
-								IClientService $httpClientService,
-								ICloudIdManager $cloudIdManager,
-								ILogger $logger) {
-		$this->cloudFederationProvider= [];
-		$this->appManager = $appManager;
-		$this->httpClientService = $httpClientService;
-		$this->cloudIdManager = $cloudIdManager;
-		$this->logger = $logger;
-	}
-
-
-	/**
-	 * Registers an callback function which must return an cloud federation provider
-	 *
-	 * @param string $resourceType which resource type does the provider handles
-	 * @param string $displayName user facing name of the federated share provider
-	 * @param callable $callback
-	 */
-	public function addCloudFederationProvider($resourceType, $displayName, callable $callback) {
-		$this->cloudFederationProvider[$resourceType] = [
-			'resourceType' => $resourceType,
-			'displayName' => $displayName,
-			'callback' => $callback,
-		];
-
-	}
-
-	/**
-	 * remove cloud federation provider
-	 *
-	 * @param string $providerId
-	 */
-	public function removeCloudFederationProvider($providerId) {
-		unset($this->cloudFederationProvider[$providerId]);
-	}
-
-	/**
-	 * get a list of all cloudFederationProviders
-	 *
-	 * @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
-	 */
-	public function getAllCloudFederationProviders() {
-		return $this->cloudFederationProvider;
-	}
-
-	/**
-	 * get a specific cloud federation provider
-	 *
-	 * @param string $resourceType
-	 * @return ICloudFederationProvider
-	 * @throws ProviderDoesNotExistsException
-	 */
-	public function getCloudFederationProvider($resourceType) {
-		if (isset($this->cloudFederationProvider[$resourceType])) {
-			return call_user_func($this->cloudFederationProvider[$resourceType]['callback']);
-		} else {
-			throw new ProviderDoesNotExistsException($resourceType);
-		}
-	}
-
-	public function sendShare(ICloudFederationShare $share) {
-		$cloudID = $this->cloudIdManager->resolveCloudId($share->getShareWith());
-		$ocmEndPoint = $this->getOCMEndPoint($cloudID->getRemote());
-
-		if (empty($ocmEndPoint)) {
-			return false;
-		}
-
-		$client = $this->httpClientService->newClient();
-		try {
-			$response = $client->post($ocmEndPoint . '/shares', [
-				'body' => $share->getShare(),
-				'timeout' => 10,
-				'connect_timeout' => 10,
-			]);
-
-			if ($response->getStatusCode() === Http::STATUS_CREATED) {
-				return true;
-			}
-
-		} catch (\Exception $e) {
-			// if flat re-sharing is not supported by the remote server
-			// we re-throw the exception and fall back to the old behaviour.
-			// (flat re-shares has been introduced in Nextcloud 9.1)
-			if ($e->getCode() === Http::STATUS_INTERNAL_SERVER_ERROR) {
-				throw $e;
-			}
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * @param string $url
-	 * @param ICloudFederationNotification $notification
-	 * @return mixed
-	 */
-	public function sendNotification($url, ICloudFederationNotification $notification) {
-		$ocmEndPoint = $this->getOCMEndPoint($url);
-
-		if (empty($ocmEndPoint)) {
-			return false;
-		}
-
-		$client = $this->httpClientService->newClient();
-		try {
-			$response = $client->post($ocmEndPoint . '/notifications', [
-				'body' => $notification->getMessage(),
-				'timeout' => 10,
-				'connect_timeout' => 10,
-			]);
-			if ($response->getStatusCode() === Http::STATUS_CREATED) {
-				$result = json_decode($response->getBody(), true);
-				return (is_array($result)) ? $result : [];
-			}
-		} catch (\Exception $e) {
-			// log the error and return false
-			$this->logger->error('error while sending notification for federated share: ' . $e->getMessage());
-		}
-
-		return false;
-	}
-
-	/**
-	 * check if the new cloud federation API is ready to be used
-	 *
-	 * @return bool
-	 */
-	public function isReady() {
-		return $this->appManager->isEnabledForUser('cloud_federation_api');
-	}
-	/**
-	 * check if server supports the new OCM api and ask for the correct end-point
-	 *
-	 * @param string $url full base URL of the cloud server
-	 * @return string
-	 */
-	protected function getOCMEndPoint($url) {
-		$client = $this->httpClientService->newClient();
-		try {
-			$response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]);
-		} catch (\Exception $e) {
-			return '';
-		}
-
-		$result = $response->getBody();
-		$result = json_decode($result, true);
-
-		$supportedVersion = isset($result['apiVersion']) && $result['apiVersion'] === $this->supportedAPIVersion;
-
-		if (isset($result['endPoint']) && $supportedVersion) {
-			return $result['endPoint'];
-		}
-
-		return '';
-	}
+    /** @var array list of available cloud federation providers */
+    private $cloudFederationProvider;
+
+    /** @var IAppManager */
+    private $appManager;
+
+    /** @var IClientService */
+    private $httpClientService;
+
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
+
+    /** @var ILogger */
+    private $logger;
+
+    private $supportedAPIVersion = '1.0-proposal1';
+
+    /**
+     * CloudFederationProviderManager constructor.
+     *
+     * @param IAppManager $appManager
+     * @param IClientService $httpClientService
+     * @param ICloudIdManager $cloudIdManager
+     * @param ILogger $logger
+     */
+    public function __construct(IAppManager $appManager,
+                                IClientService $httpClientService,
+                                ICloudIdManager $cloudIdManager,
+                                ILogger $logger) {
+        $this->cloudFederationProvider= [];
+        $this->appManager = $appManager;
+        $this->httpClientService = $httpClientService;
+        $this->cloudIdManager = $cloudIdManager;
+        $this->logger = $logger;
+    }
+
+
+    /**
+     * Registers an callback function which must return an cloud federation provider
+     *
+     * @param string $resourceType which resource type does the provider handles
+     * @param string $displayName user facing name of the federated share provider
+     * @param callable $callback
+     */
+    public function addCloudFederationProvider($resourceType, $displayName, callable $callback) {
+        $this->cloudFederationProvider[$resourceType] = [
+            'resourceType' => $resourceType,
+            'displayName' => $displayName,
+            'callback' => $callback,
+        ];
+
+    }
+
+    /**
+     * remove cloud federation provider
+     *
+     * @param string $providerId
+     */
+    public function removeCloudFederationProvider($providerId) {
+        unset($this->cloudFederationProvider[$providerId]);
+    }
+
+    /**
+     * get a list of all cloudFederationProviders
+     *
+     * @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
+     */
+    public function getAllCloudFederationProviders() {
+        return $this->cloudFederationProvider;
+    }
+
+    /**
+     * get a specific cloud federation provider
+     *
+     * @param string $resourceType
+     * @return ICloudFederationProvider
+     * @throws ProviderDoesNotExistsException
+     */
+    public function getCloudFederationProvider($resourceType) {
+        if (isset($this->cloudFederationProvider[$resourceType])) {
+            return call_user_func($this->cloudFederationProvider[$resourceType]['callback']);
+        } else {
+            throw new ProviderDoesNotExistsException($resourceType);
+        }
+    }
+
+    public function sendShare(ICloudFederationShare $share) {
+        $cloudID = $this->cloudIdManager->resolveCloudId($share->getShareWith());
+        $ocmEndPoint = $this->getOCMEndPoint($cloudID->getRemote());
+
+        if (empty($ocmEndPoint)) {
+            return false;
+        }
+
+        $client = $this->httpClientService->newClient();
+        try {
+            $response = $client->post($ocmEndPoint . '/shares', [
+                'body' => $share->getShare(),
+                'timeout' => 10,
+                'connect_timeout' => 10,
+            ]);
+
+            if ($response->getStatusCode() === Http::STATUS_CREATED) {
+                return true;
+            }
+
+        } catch (\Exception $e) {
+            // if flat re-sharing is not supported by the remote server
+            // we re-throw the exception and fall back to the old behaviour.
+            // (flat re-shares has been introduced in Nextcloud 9.1)
+            if ($e->getCode() === Http::STATUS_INTERNAL_SERVER_ERROR) {
+                throw $e;
+            }
+        }
+
+        return false;
+
+    }
+
+    /**
+     * @param string $url
+     * @param ICloudFederationNotification $notification
+     * @return mixed
+     */
+    public function sendNotification($url, ICloudFederationNotification $notification) {
+        $ocmEndPoint = $this->getOCMEndPoint($url);
+
+        if (empty($ocmEndPoint)) {
+            return false;
+        }
+
+        $client = $this->httpClientService->newClient();
+        try {
+            $response = $client->post($ocmEndPoint . '/notifications', [
+                'body' => $notification->getMessage(),
+                'timeout' => 10,
+                'connect_timeout' => 10,
+            ]);
+            if ($response->getStatusCode() === Http::STATUS_CREATED) {
+                $result = json_decode($response->getBody(), true);
+                return (is_array($result)) ? $result : [];
+            }
+        } catch (\Exception $e) {
+            // log the error and return false
+            $this->logger->error('error while sending notification for federated share: ' . $e->getMessage());
+        }
+
+        return false;
+    }
+
+    /**
+     * check if the new cloud federation API is ready to be used
+     *
+     * @return bool
+     */
+    public function isReady() {
+        return $this->appManager->isEnabledForUser('cloud_federation_api');
+    }
+    /**
+     * check if server supports the new OCM api and ask for the correct end-point
+     *
+     * @param string $url full base URL of the cloud server
+     * @return string
+     */
+    protected function getOCMEndPoint($url) {
+        $client = $this->httpClientService->newClient();
+        try {
+            $response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]);
+        } catch (\Exception $e) {
+            return '';
+        }
+
+        $result = $response->getBody();
+        $result = json_decode($result, true);
+
+        $supportedVersion = isset($result['apiVersion']) && $result['apiVersion'] === $this->supportedAPIVersion;
+
+        if (isset($result['endPoint']) && $supportedVersion) {
+            return $result['endPoint'];
+        }
+
+        return '';
+    }
 
 
 }

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

Indentation +195 added lines, -195 removed lines

@@ -51,225 +51,225 @@
  */
 class RequestHandlerController extends Controller {
 
-	/** @var ILogger */
-	private $logger;
+    /** @var ILogger */
+    private $logger;
 
-	/** @var IUserManager */
-	private $userManager;
+    /** @var IUserManager */
+    private $userManager;
 
-	/** @var IURLGenerator */
-	private $urlGenerator;
+    /** @var IURLGenerator */
+    private $urlGenerator;
 
-	/** @var ICloudFederationProviderManager */
-	private $cloudFederationProviderManager;
+    /** @var ICloudFederationProviderManager */
+    private $cloudFederationProviderManager;
 
-	/** @var Config */
-	private $config;
+    /** @var Config */
+    private $config;
 
-	/** @var ICloudFederationFactory */
-	private $factory;
+    /** @var ICloudFederationFactory */
+    private $factory;
 
-	/** @var ICloudIdManager */
-	private $cloudIdManager;
+    /** @var ICloudIdManager */
+    private $cloudIdManager;
 
-	public function __construct($appName,
-								IRequest $request,
-								ILogger $logger,
-								IUserManager $userManager,
-								IURLGenerator $urlGenerator,
-								ICloudFederationProviderManager $cloudFederationProviderManager,
-								Config $config,
-								ICloudFederationFactory $factory,
-								ICloudIdManager $cloudIdManager
-	) {
-		parent::__construct($appName, $request);
+    public function __construct($appName,
+                                IRequest $request,
+                                ILogger $logger,
+                                IUserManager $userManager,
+                                IURLGenerator $urlGenerator,
+                                ICloudFederationProviderManager $cloudFederationProviderManager,
+                                Config $config,
+                                ICloudFederationFactory $factory,
+                                ICloudIdManager $cloudIdManager
+    ) {
+        parent::__construct($appName, $request);
 
-		$this->logger = $logger;
-		$this->userManager = $userManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cloudFederationProviderManager = $cloudFederationProviderManager;
-		$this->config = $config;
-		$this->factory = $factory;
-		$this->cloudIdManager = $cloudIdManager;
-	}
+        $this->logger = $logger;
+        $this->userManager = $userManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->cloudFederationProviderManager = $cloudFederationProviderManager;
+        $this->config = $config;
+        $this->factory = $factory;
+        $this->cloudIdManager = $cloudIdManager;
+    }
 
-	/**
-	 * 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 string $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@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
-	 */
-	public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
+    /**
+     * 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 string $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@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
+     */
+    public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
 
-		// 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']) ||
-			!isset($protocol['options']['sharedSecret'])
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        // 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']) ||
+            !isset($protocol['options']['sharedSecret'])
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
-		$cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
-		$shareWithLocalId = $cloudId->getUser();
-		$shareWith = $this->mapUid($shareWithLocalId);
+        $cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
+        $shareWithLocalId = $cloudId->getUser();
+        $shareWith = $this->mapUid($shareWithLocalId);
 
-		if (!$this->userManager->userExists($shareWith)) {
-			return new JSONResponse(
-				['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        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;
+        // 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;
-		}
+        // 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, '', $shareType, $resourceType);
-			$share->setProtocol($protocol);
-			$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
-			);
-		}
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, '', $shareType, $resourceType);
+            $share->setProtocol($protocol);
+            $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
+            );
+        }
 
-		$user = $this->userManager->get($shareWithLocalId);
-		$recipientDisplayName = '';
-		if($user) {
-			$recipientDisplayName = $user->getDisplayName();
-		}
+        $user = $this->userManager->get($shareWithLocalId);
+        $recipientDisplayName = '';
+        if($user) {
+            $recipientDisplayName = $user->getDisplayName();
+        }
 
-		return new JSONResponse(
-			['recipientDisplayName' => $recipientDisplayName],
-			Http::STATUS_CREATED);
+        return new JSONResponse(
+            ['recipientDisplayName' => $recipientDisplayName],
+            Http::STATUS_CREATED);
 
-	}
+    }
 
-	/**
-	 * receive notification about existing share
-	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @BruteForceProtection(action=receiveFederatedShareNotification)
-	 *
-	 * @param string $notificationType (notification type, e.g. SHARE_ACCEPTED)
-	 * @param string $resourceType (calendar, file, contact,...)
-	 * @param string $providerId id of the share
-	 * @param array $notification the actual payload of the notification
-	 * @return JSONResponse
-	 */
-	public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) {
+    /**
+     * receive notification about existing share
+     *
+     * @NoCSRFRequired
+     * @PublicPage
+     * @BruteForceProtection(action=receiveFederatedShareNotification)
+     *
+     * @param string $notificationType (notification type, e.g. SHARE_ACCEPTED)
+     * @param string $resourceType (calendar, file, contact,...)
+     * @param string $providerId id of the share
+     * @param array $notification the actual payload of the notification
+     * @return JSONResponse
+     */
+    public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) {
 
-		// check if all required parameters are set
-		if ($notificationType === null ||
-			$resourceType === null ||
-			$providerId === null ||
-			!is_array($notification)
-		) {
-			return new JSONResponse(
-				['message' => 'Missing arguments'],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        // check if all required parameters are set
+        if ($notificationType === null ||
+            $resourceType === null ||
+            $providerId === null ||
+            !is_array($notification)
+        ) {
+            return new JSONResponse(
+                ['message' => 'Missing arguments'],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
-		try {
-			$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
-			$result = $provider->notificationReceived($notificationType, $providerId, $notification);
-		} catch (ProviderDoesNotExistsException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ShareNotFound $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_BAD_REQUEST
-			);
-		} catch (ActionNotSupportedException $e) {
-			return new JSONResponse(
-				['message' => $e->getMessage()],
-				Http::STATUS_NOT_IMPLEMENTED
-			);
-		} catch (BadRequestException $e) {
-			return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
-		} catch (AuthenticationFailedException $e) {
-			return new JSONResponse(["message" => "RESOURCE_NOT_FOUND"], Http::STATUS_FORBIDDEN);
-		}
-		catch (\Exception $e) {
-			return new JSONResponse(
-				['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
-				Http::STATUS_BAD_REQUEST
-			);
-		}
+        try {
+            $provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
+            $result = $provider->notificationReceived($notificationType, $providerId, $notification);
+        } catch (ProviderDoesNotExistsException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ShareNotFound $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_BAD_REQUEST
+            );
+        } catch (ActionNotSupportedException $e) {
+            return new JSONResponse(
+                ['message' => $e->getMessage()],
+                Http::STATUS_NOT_IMPLEMENTED
+            );
+        } catch (BadRequestException $e) {
+            return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
+        } catch (AuthenticationFailedException $e) {
+            return new JSONResponse(["message" => "RESOURCE_NOT_FOUND"], Http::STATUS_FORBIDDEN);
+        }
+        catch (\Exception $e) {
+            return new JSONResponse(
+                ['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
+                Http::STATUS_BAD_REQUEST
+            );
+        }
 
-		return new JSONResponse($result,Http::STATUS_CREATED);
+        return new JSONResponse($result,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]);
+    /**
+     * 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;
-	}
+        return $uid;
+    }
 
 }