* @author Joas Schilling * @author John Molakvoæ (skjnldsv) * @author Lukas Reschke * @author Morris Jobke * @author Robin Appelman * @author Roeland Jago Douma * @author Sergio Bertolin * @author Sergio Bertolín * @author Thomas Müller * @author Vincent Petry * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * */ use GuzzleHttp\Client as GClient; use GuzzleHttp\Message\ResponseInterface; use PHPUnit\Framework\Assert; use Sabre\DAV\Client as SClient; use Sabre\DAV\Xml\Property\ResourceType; require __DIR__ . '/../../vendor/autoload.php'; trait WebDav { use Sharing; /** @var string */ private $davPath = "remote.php/webdav"; /** @var boolean */ private $usingOldDavPath = true; /** @var ResponseInterface */ private $response; /** @var array map with user as key and another map as value, which has path as key and etag as value */ private $storedETAG = null; /** @var int */ private $storedFileID = null; /** * @Given /^using dav path "([^"]*)"$/ */ public function usingDavPath($davPath) { $this->davPath = $davPath; } /** * @Given /^using old dav path$/ */ public function usingOldDavPath() { $this->davPath = "remote.php/webdav"; $this->usingOldDavPath = true; } /** * @Given /^using new dav path$/ */ public function usingNewDavPath() { $this->davPath = "remote.php/dav"; $this->usingOldDavPath = false; } public function getDavFilesPath($user) { if ($this->usingOldDavPath === true) { return $this->davPath; } else { return $this->davPath . '/files/' . $user; } } public function makeDavRequest($user, $method, $path, $headers, $body = null, $type = "files") { if ($type === "files") { $fullUrl = substr($this->baseUrl, 0, -4) . $this->getDavFilesPath($user) . "$path"; } elseif ($type === "uploads") { $fullUrl = substr($this->baseUrl, 0, -4) . $this->davPath . "$path"; } $client = new GClient(); $options = [ 'headers' => $headers, 'body' => $body ]; if ($user === 'admin') { $options['auth'] = $this->adminUser; } else { $options['auth'] = [$user, $this->regularUser]; } return $client->request($method, $fullUrl, $options); } /** * @Given /^User "([^"]*)" moved (file|folder|entry) "([^"]*)" to "([^"]*)"$/ * @param string $user * @param string $fileSource * @param string $fileDestination */ public function userMovedFile($user, $entry, $fileSource, $fileDestination) { $fullUrl = substr($this->baseUrl, 0, -4) . $this->getDavFilesPath($user); $headers['Destination'] = $fullUrl . $fileDestination; $this->response = $this->makeDavRequest($user, "MOVE", $fileSource, $headers); Assert::assertEquals(201, $this->response->getStatusCode()); } /** * @When /^User "([^"]*)" moves (file|folder|entry) "([^"]*)" to "([^"]*)"$/ * @param string $user * @param string $fileSource * @param string $fileDestination */ public function userMovesFile($user, $entry, $fileSource, $fileDestination) { $fullUrl = substr($this->baseUrl, 0, -4) . $this->getDavFilesPath($user); $headers['Destination'] = $fullUrl . $fileDestination; try { $this->response = $this->makeDavRequest($user, "MOVE", $fileSource, $headers); } catch (\GuzzleHttp\Exception\ClientException $e) { $this->response = $e->getResponse(); } } /** * @When /^User "([^"]*)" copies file "([^"]*)" to "([^"]*)"$/ * @param string $user * @param string $fileSource * @param string $fileDestination */ public function userCopiesFileTo($user, $fileSource, $fileDestination) { $fullUrl = substr($this->baseUrl, 0, -4) . $this->getDavFilesPath($user); $headers['Destination'] = $fullUrl . $fileDestination; try { $this->response = $this->makeDavRequest($user, 'COPY', $fileSource, $headers); } catch (\GuzzleHttp\Exception\ClientException $e) { // 4xx and 5xx responses cause an exception $this->response = $e->getResponse(); } } /** * @When /^Downloading file "([^"]*)" with range "([^"]*)"$/ * @param string $fileSource * @param string $range */ public function downloadFileWithRange($fileSource, $range) { $headers['Range'] = $range; $this->response = $this->makeDavRequest($this->currentUser, "GET", $fileSource, $headers); } /** * @When /^Downloading last public shared file with range "([^"]*)"$/ * @param string $range */ public function downloadPublicFileWithRange($range) { $token = $this->lastShareData->data->token; $fullUrl = substr($this->baseUrl, 0, -4) . "public.php/webdav"; $client = new GClient(); $options = []; $options['auth'] = [$token, ""]; $options['headers'] = [ 'Range' => $range ]; $this->response = $client->request("GET", $fullUrl, $options); } /** * @When /^Downloading last public shared file inside a folder "([^"]*)" with range "([^"]*)"$/ * @param string $range */ public function downloadPublicFileInsideAFolderWithRange($path, $range) { $token = $this->lastShareData->data->token; $fullUrl = substr($this->baseUrl, 0, -4) . "public.php/webdav" . "$path"; $client = new GClient(); $options = [ 'headers' => [ 'Range' => $range ] ]; $options['auth'] = [$token, ""]; $this->response = $client->request("GET", $fullUrl, $options); } /** * @Then /^Downloaded content should be "([^"]*)"$/ * @param string $content */ public function downloadedContentShouldBe($content) { Assert::assertEquals($content, (string)$this->response->getBody()); } /** * @Then /^Downloaded content when downloading file "([^"]*)" with range "([^"]*)" should be "([^"]*)"$/ * @param string $fileSource * @param string $range * @param string $content */ public function downloadedContentWhenDownloadindShouldBe($fileSource, $range, $content) { $this->downloadFileWithRange($fileSource, $range); $this->downloadedContentShouldBe($content); } /** * @When Downloading file :fileName * @param string $fileName */ public function downloadingFile($fileName) { try { $this->response = $this->makeDavRequest($this->currentUser, 'GET', $fileName, []); } catch (\GuzzleHttp\Exception\ClientException $e) { $this->response = $e->getResponse(); } } /** * @Then Downloaded content should start with :start * @param int $start * @throws \Exception */ public function downloadedContentShouldStartWith($start) { if (strpos($this->response->getBody()->getContents(), $start) !== 0) { throw new \Exception( sprintf( "Expected '%s', got '%s'", $start, $this->response->getBody()->getContents() ) ); } } /** * @Then /^as "([^"]*)" gets properties of (file|folder|entry) "([^"]*)" with$/ * @param string $user * @param string $elementType * @param string $path * @param \Behat\Gherkin\Node\TableNode|null $propertiesTable */ public function asGetsPropertiesOfFolderWith($user, $elementType, $path, $propertiesTable) { $properties = null; if ($propertiesTable instanceof \Behat\Gherkin\Node\TableNode) { foreach ($propertiesTable->getRows() as $row) { $properties[] = $row[0]; } } $this->response = $this->listFolder($user, $path, 0, $properties); } /** * @Then /^as "([^"]*)" the (file|folder|entry) "([^"]*)" does not exist$/ * @param string $user * @param string $entry * @param string $path * @param \Behat\Gherkin\Node\TableNode|null $propertiesTable */ public function asTheFileOrFolderDoesNotExist($user, $entry, $path) { $client = $this->getSabreClient($user); $response = $client->request('HEAD', $this->makeSabrePath($user, $path)); if ($response['statusCode'] !== 404) { throw new \Exception($entry . ' "' . $path . '" expected to not exist (status code ' . $response['statusCode'] . ', expected 404)'); } return $response; } /** * @Then /^as "([^"]*)" the (file|folder|entry) "([^"]*)" exists$/ * @param string $user * @param string $entry * @param string $path */ public function asTheFileOrFolderExists($user, $entry, $path) { $this->response = $this->listFolder($user, $path, 0); } /** * @Then the single response should contain a property :key with value :value * @param string $key * @param string $expectedValue * @throws \Exception */ public function theSingleResponseShouldContainAPropertyWithValue($key, $expectedValue) { $keys = $this->response; if (!array_key_exists($key, $keys)) { throw new \Exception("Cannot find property \"$key\" with \"$expectedValue\""); } $value = $keys[$key]; if ($value instanceof ResourceType) { $value = $value->getValue(); if (empty($value)) { $value = ''; } else { $value = $value[0]; } } if ($value != $expectedValue) { throw new \Exception("Property \"$key\" found with value \"$value\", expected \"$expectedValue\""); } } /** * @Then the response should contain a share-types property with */ public function theResponseShouldContainAShareTypesPropertyWith($table) { $keys = $this->response; if (!array_key_exists('{http://owncloud.org/ns}share-types', $keys)) { throw new \Exception("Cannot find property \"{http://owncloud.org/ns}share-types\""); } $foundTypes = []; $data = $keys['{http://owncloud.org/ns}share-types']; foreach ($data as $item) { if ($item['name'] !== '{http://owncloud.org/ns}share-type') { throw new \Exception('Invalid property found: "' . $item['name'] . '"'); } $foundTypes[] = $item['value']; } foreach ($table->getRows() as $row) { $key = array_search($row[0], $foundTypes); if ($key === false) { throw new \Exception('Expected type ' . $row[0] . ' not found'); } unset($foundTypes[$key]); } if ($foundTypes !== []) { throw new \Exception('Found more share types then specified: ' . $foundTypes); } } /** * @Then the response should contain an empty property :property * @param string $property * @throws \Exception */ public function theResponseShouldContainAnEmptyProperty($property) { $properties = $this->response; if (!array_key_exists($property, $properties)) { throw new \Exception("Cannot find property \"$property\""); } if ($properties[$property] !== null) { throw new \Exception("Property \"$property\" is not empty"); } } /*Returns the elements of a propfind, $folderDepth requires 1 to see elements without children*/ public function listFolder($user, $path, $folderDepth, $properties = null) { $client = $this->getSabreClient($user); if (!$properties) { $properties = [ '{DAV:}getetag' ]; } $response = $client->propfind($this->makeSabrePath($user, $path), $properties, $folderDepth); return $response; } /* Returns the elements of a report command * @param string $user * @param string $path * @param string $properties properties which needs to be included in the report * @param string $filterRules filter-rules to choose what needs to appear in the report */ public function reportFolder($user, $path, $properties, $filterRules) { $client = $this->getSabreClient($user); $body = ' ' . $properties . ' ' . $filterRules . ' '; $response = $client->request('REPORT', $this->makeSabrePath($user, $path), $body); $parsedResponse = $client->parseMultistatus($response['body']); return $parsedResponse; } public function makeSabrePath($user, $path, $type = 'files') { if ($type === 'files') { return $this->encodePath($this->getDavFilesPath($user) . $path); } else { return $this->encodePath($this->davPath . '/' . $type . '/' . $user . '/' . $path); } } public function getSabreClient($user) { $fullUrl = substr($this->baseUrl, 0, -4); $settings = [ 'baseUri' => $fullUrl, 'userName' => $user, ]; if ($user === 'admin') { $settings['password'] = $this->adminUser[1]; } else { $settings['password'] = $this->regularUser; } $settings['authType'] = SClient::AUTH_BASIC; return new SClient($settings); } /** * @Then /^user "([^"]*)" should see following elements$/ * @param string $user * @param \Behat\Gherkin\Node\TableNode|null $expectedElements */ public function checkElementList($user, $expectedElements) { $elementList = $this->listFolder($user, '/', 3); if ($expectedElements instanceof \Behat\Gherkin\Node\TableNode) { $elementRows = $expectedElements->getRows(); $elementsSimplified = $this->simplifyArray($elementRows); foreach ($elementsSimplified as $expectedElement) { $webdavPath = "/" . $this->getDavFilesPath($user) . $expectedElement; if (!array_key_exists($webdavPath, $elementList)) { Assert::fail("$webdavPath" . " is not in propfind answer"); } } } } /** * @When User :user uploads file :source to :destination * @param string $user * @param string $source * @param string $destination */ public function userUploadsAFileTo($user, $source, $destination) { $file = \GuzzleHttp\Psr7\stream_for(fopen($source, 'r')); try { $this->response = $this->makeDavRequest($user, "PUT", $destination, [], $file); } catch (\GuzzleHttp\Exception\ServerException $e) { // 4xx and 5xx responses cause an exception $this->response = $e->getResponse(); } } /** * @When User :user adds a file of :bytes bytes to :destination * @param string $user * @param string $bytes * @param string $destination */ public function userAddsAFileTo($user, $bytes, $destination) { $filename = "filespecificSize.txt"; $this->createFileSpecificSize($filename, $bytes); Assert::assertEquals(1, file_exists("work/$filename")); $this->userUploadsAFileTo($user, "work/$filename", $destination); $this->removeFile("work/", $filename); $expectedElements = new \Behat\Gherkin\Node\TableNode([["$destination"]]); $this->checkElementList($user, $expectedElements); } /** * @When User :user uploads file with content :content to :destination */ public function userUploadsAFileWithContentTo($user, $content, $destination) { $file = \GuzzleHttp\Psr7\stream_for($content); try { $this->response = $this->makeDavRequest($user, "PUT", $destination, [], $file); } catch (\GuzzleHttp\Exception\ServerException $e) { // 4xx and 5xx responses cause an exception $this->response = $e->getResponse(); } } /** * @When /^User "([^"]*)" deletes (file|folder) "([^"]*)"$/ * @param string $user * @param string $type * @param string $file */ public function userDeletesFile($user, $type, $file) { try { $this->response = $this->makeDavRequest($user, 'DELETE', $file, []); } catch (\GuzzleHttp\Exception\ServerException $e) { // 4xx and 5xx responses cause an exception $this->response = $e->getResponse(); } } /** * @Given User :user created a folder :destination * @param string $user * @param string $destination */ public function userCreatedAFolder($user, $destination) { try { $destination = '/' . ltrim($destination, '/'); $this->response = $this->makeDavRequest($user, "MKCOL", $destination, []); } catch (\GuzzleHttp\Exception\ServerException $e) { // 4xx and 5xx responses cause an exception $this->response = $e->getResponse(); } } /** * @Given user :user uploads chunk file :num of :total with :data to :destination * @param string $user * @param int $num * @param int $total * @param string $data * @param string $destination */ public function userUploadsChunkFileOfWithToWithChecksum($user, $num, $total, $data, $destination) { $num -= 1; $data = \GuzzleHttp\Psr7\stream_for($data); $file = $destination . '-chunking-42-' . $total . '-' . $num; $this->makeDavRequest($user, 'PUT', $file, ['OC-Chunked' => '1'], $data, "uploads"); } /** * @Given user :user creates a new chunking upload with id :id */ public function userCreatesANewChunkingUploadWithId($user, $id) { $destination = '/uploads/' . $user . '/' . $id; $this->makeDavRequest($user, 'MKCOL', $destination, [], null, "uploads"); } /** * @Given user :user uploads new chunk file :num with :data to id :id */ public function userUploadsNewChunkFileOfWithToId($user, $num, $data, $id) { $data = \GuzzleHttp\Psr7\stream_for($data); $destination = '/uploads/' . $user . '/' . $id . '/' . $num; $this->makeDavRequest($user, 'PUT', $destination, [], $data, "uploads"); } /** * @Given user :user moves new chunk file with id :id to :dest */ public function userMovesNewChunkFileWithIdToMychunkedfile($user, $id, $dest) { $source = '/uploads/' . $user . '/' . $id . '/.file'; $destination = substr($this->baseUrl, 0, -4) . $this->getDavFilesPath($user) . $dest; $this->makeDavRequest($user, 'MOVE', $source, [ 'Destination' => $destination ], null, "uploads"); } /** * @Then user :user moves new chunk file with id :id to :dest with size :size */ public function userMovesNewChunkFileWithIdToMychunkedfileWithSize($user, $id, $dest, $size) { $source = '/uploads/' . $user . '/' . $id . '/.file'; $destination = substr($this->baseUrl, 0, -4) . $this->getDavFilesPath($user) . $dest; try { $this->response = $this->makeDavRequest($user, 'MOVE', $source, [ 'Destination' => $destination, 'OC-Total-Length' => $size ], null, "uploads"); } catch (\GuzzleHttp\Exception\BadResponseException $ex) { $this->response = $ex->getResponse(); } } /** * @Given /^Downloading file "([^"]*)" as "([^"]*)"$/ */ public function downloadingFileAs($fileName, $user) { try { $this->response = $this->makeDavRequest($user, 'GET', $fileName, []); } catch (\GuzzleHttp\Exception\ServerException $ex) { $this->response = $ex->getResponse(); } } /** * URL encodes the given path but keeps the slashes * * @param string $path to encode * @return string encoded path */ private function encodePath($path) { // slashes need to stay return str_replace('%2F', '/', rawurlencode($path)); } /** * @When user :user favorites element :path */ public function userFavoritesElement($user, $path) { $this->response = $this->changeFavStateOfAnElement($user, $path, 1, 0, null); } /** * @When user :user unfavorites element :path */ public function userUnfavoritesElement($user, $path) { $this->response = $this->changeFavStateOfAnElement($user, $path, 0, 0, null); } /*Set the elements of a proppatch, $folderDepth requires 1 to see elements without children*/ public function changeFavStateOfAnElement($user, $path, $favOrUnfav, $folderDepth, $properties = null) { $fullUrl = substr($this->baseUrl, 0, -4); $settings = [ 'baseUri' => $fullUrl, 'userName' => $user, ]; if ($user === 'admin') { $settings['password'] = $this->adminUser[1]; } else { $settings['password'] = $this->regularUser; } $settings['authType'] = SClient::AUTH_BASIC; $client = new SClient($settings); if (!$properties) { $properties = [ '{http://owncloud.org/ns}favorite' => $favOrUnfav ]; } $response = $client->proppatch($this->getDavFilesPath($user) . $path, $properties, $folderDepth); return $response; } /** * @Given user :user stores etag of element :path */ public function userStoresEtagOfElement($user, $path) { $propertiesTable = new \Behat\Gherkin\Node\TableNode([['{DAV:}getetag']]); $this->asGetsPropertiesOfFolderWith($user, 'entry', $path, $propertiesTable); $pathETAG[$path] = $this->response['{DAV:}getetag']; $this->storedETAG[$user] = $pathETAG; } /** * @Then etag of element :path of user :user has not changed */ public function checkIfETAGHasNotChanged($path, $user) { $propertiesTable = new \Behat\Gherkin\Node\TableNode([['{DAV:}getetag']]); $this->asGetsPropertiesOfFolderWith($user, 'entry', $path, $propertiesTable); Assert::assertEquals($this->response['{DAV:}getetag'], $this->storedETAG[$user][$path]); } /** * @Then etag of element :path of user :user has changed */ public function checkIfETAGHasChanged($path, $user) { $propertiesTable = new \Behat\Gherkin\Node\TableNode([['{DAV:}getetag']]); $this->asGetsPropertiesOfFolderWith($user, 'entry', $path, $propertiesTable); Assert::assertNotEquals($this->response['{DAV:}getetag'], $this->storedETAG[$user][$path]); } /** * @When Connecting to dav endpoint */ public function connectingToDavEndpoint() { try { $this->response = $this->makeDavRequest(null, 'PROPFIND', '', []); } catch (\GuzzleHttp\Exception\ClientException $e) { $this->response = $e->getResponse(); } } /** * @Then there are no duplicate headers */ public function thereAreNoDuplicateHeaders() { $headers = $this->response->getHeaders(); foreach ($headers as $headerName => $headerValues) { // if a header has multiple values, they must be different if (count($headerValues) > 1 && count(array_unique($headerValues)) < count($headerValues)) { throw new \Exception('Duplicate header found: ' . $headerName); } } } /** * @Then /^user "([^"]*)" in folder "([^"]*)" should have favorited the following elements$/ * @param string $user * @param string $folder * @param \Behat\Gherkin\Node\TableNode|null $expectedElements */ public function checkFavoritedElements($user, $folder, $expectedElements) { $elementList = $this->reportFolder($user, $folder, '', '1'); if ($expectedElements instanceof \Behat\Gherkin\Node\TableNode) { $elementRows = $expectedElements->getRows(); $elementsSimplified = $this->simplifyArray($elementRows); foreach ($elementsSimplified as $expectedElement) { $webdavPath = "/" . $this->getDavFilesPath($user) . $expectedElement; if (!array_key_exists($webdavPath, $elementList)) { Assert::fail("$webdavPath" . " is not in report answer"); } } } } /** * @When /^User "([^"]*)" deletes everything from folder "([^"]*)"$/ * @param string $user * @param string $folder */ public function userDeletesEverythingInFolder($user, $folder) { $elementList = $this->listFolder($user, $folder, 1); $elementListKeys = array_keys($elementList); array_shift($elementListKeys); $davPrefix = "/" . $this->getDavFilesPath($user); foreach ($elementListKeys as $element) { if (substr($element, 0, strlen($davPrefix)) == $davPrefix) { $element = substr($element, strlen($davPrefix)); } $this->userDeletesFile($user, "element", $element); } } /** * @param string $user * @param string $path * @return int */ private function getFileIdForPath($user, $path) { $propertiesTable = new \Behat\Gherkin\Node\TableNode([["{http://owncloud.org/ns}fileid"]]); $this->asGetsPropertiesOfFolderWith($user, 'file', $path, $propertiesTable); return (int)$this->response['{http://owncloud.org/ns}fileid']; } /** * @Given /^User "([^"]*)" stores id of file "([^"]*)"$/ * @param string $user * @param string $path */ public function userStoresFileIdForPath($user, $path) { $this->storedFileID = $this->getFileIdForPath($user, $path); } /** * @Given /^User "([^"]*)" checks id of file "([^"]*)"$/ * @param string $user * @param string $path */ public function userChecksFileIdForPath($user, $path) { $currentFileID = $this->getFileIdForPath($user, $path); Assert::assertEquals($currentFileID, $this->storedFileID); } }