Add support for room shares #1050

danxuliu · 2018-07-16T04:41:33Z

First of all sorry for the massive size of this pull request. If it is any comfort to you it is basically a big specification of integration tests with some code in between :-P

This pull request, with its server counterpart, makes possible to share a file or folder into a Talk room. The integration test will need to be launched again once the server part is merged.

Room shares are heavily based on (read, copy-pasted from :-P ) group shares, although with some differences. In the same way that a user must be a participant of a room to send a message to it a user must be a participant of a room to share a file with it (in the case of group shares enforcing that is enabled in the settings). Similarly, when a user leaves a room she has no longer access to the shares in the room; for consistency, her own shares are also removed.

This Talk part adds a new IShareProvider, RoomShareProvider, which provides the core operations (create, update, delete...) for each share type. To try to make it more manageable for review each operation is added incrementally in its own commit, followed by commits that add the integration tests that verify that operation.

Due to the current architecture of the sharing system it is not enough to provide an IShareProvider to add a new type of share; the controllers for the sharing API also need to be modified to support each type of share. Due to this, and to keep the server isolated from the Talk details (for example, whether a file can be shared with certain type of room or not, or how to generate the display name for a room share), the controllers just delegate those checks or actions to helper classes defined in Talk.

Note that this pull request just adds the core implementation of room shares. Other features, like sending a message in the chat to inform the rest of the users that a file was shared, show the name of the participants as the display name of the share when the room has no name set, or making possible to share files from the Talk UI itself will be added in other pull requests. In any case, all those changes are Talk specific; no changes are needed in the server for them.

Also note that this pull request implements room shares, but not search for room collaborators (so even if room shares are implemented you can not test them from the UI); this is implemented in #1051

nickvergessen · 2018-07-16T10:11:13Z

In the same way that a user must be a participant of a room to send a message to it a user must be a participant of a room to share a file with it (in the case of group shares enforcing that is enabled in the settings).

Just to be sure I understood this correctly: you must only be able to share to rooms you are part of

nickvergessen · 2018-07-16T10:13:42Z

lib/AppInfo/Application.php

+			/** @var Room $room */
+			$room = $event->getSubject();
+
+			$users = $room->getParticipants()['users'];


Oh wait, the event is missing the information who is disconnecting?!
Let's fix that instead of doing such crazy stuff in here

Originally I tried to fix the event data, but ended with the current approach. I have no idea why... but I hope that I had a good reason for that hack :-P

nickvergessen · 2018-07-16T10:17:38Z

lib/Share/Helper/ShareAPIController.php

+	 * @param IShare $share
+	 * @return array
+	 */
+	public function formatShare(IShare $share): array {


This is shared with DeletedShareAPIController extract into a base class?

nickvergessen · 2018-07-16T10:22:13Z

lib/Share/RoomShareProvider.php

+	 * @param int $itemSource
+	 * @param string $target
+	 * @param int $permissions
+	 * @param DateTime|null $expirationDate


\DateTime

nickvergessen · 2018-07-16T10:27:13Z

lib/Share/RoomShareProvider.php

+	 * @return IShare
+	 */
+	private function createShareObject($data) {
+		$share = new Share($this->rootFolder, $this->userManager);


OCP\Share\IManager::newShare() instead of direct access to a private class

The methods of the helper class are called from the main \OCA\Files_Sharing\Controller\ShareAPIController class to perform actions or checks specific to room shares, thus keeping the main ShareAPIController of the server isolated from the Talk details. Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>

The methods of the helper class are called from the main \OCA\Files_Sharing\Controller\DeletedShareAPIController class to perform actions or checks specific to room shares, thus keeping the main DeletedShareAPIController of the server isolated from the Talk details. Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>

This forces the users and groups to be created again from scratch as needed for each new scenario, thus preventing actions performed in a previous scenario, like creating a new folder, from affecting the following scenarios. Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>