123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200 |
- <?php
- /**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
- use GuzzleHttp\Client as GClient;
- use PHPUnit\Framework\Assert;
- use Psr\Http\Message\ResponseInterface;
- use Sabre\DAV\Client as SClient;
- use Sabre\DAV\Xml\Property\ResourceType;
- require __DIR__ . '/../../vendor/autoload.php';
- trait WebDav {
- use Sharing;
- private string $davPath = 'remote.php/webdav';
- private bool $usingOldDavPath = true;
- private ?array $storedETAG = null; // map with user as key and another map as value, which has path as key and etag as value
- private ?int $storedFileID = null;
- /** @var ResponseInterface */
- private $response;
- private array $parsedResponse = [];
- private string $s3MultipartDestination;
- private string $uploadId;
- /** @var string[] */
- private array $parts = [];
- /**
- * @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;
- }
- /**
- * @Given /^using new public dav path$/
- */
- public function usingNewPublicDavPath() {
- $this->davPath = 'public.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";
- } else {
- $fullUrl = substr($this->baseUrl, 0, -4) . $this->davPath . '/' . $type . "$path";
- }
- $client = new GClient();
- $options = [
- 'headers' => $headers,
- 'body' => $body
- ];
- if ($user === 'admin') {
- $options['auth'] = $this->adminUser;
- } elseif ($user !== '') {
- $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/dav/files/$token";
- $client = new GClient();
- $options = [];
- $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/dav/files/$token/$path";
- $client = new GClient();
- $options = [
- 'headers' => [
- 'Range' => $range
- ]
- ];
- $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 /^File "([^"]*)" should have prop "([^"]*):([^"]*)" equal to "([^"]*)"$/
- * @param string $file
- * @param string $prefix
- * @param string $prop
- * @param string $value
- */
- public function checkPropForFile($file, $prefix, $prop, $value) {
- $elementList = $this->propfindFile($this->currentUser, $file, "<$prefix:$prop/>");
- $property = $elementList['/' . $this->getDavFilesPath($this->currentUser) . $file][200]["{DAV:}$prop"];
- Assert::assertEquals($property, $value);
- }
- /**
- * @Then /^Image search should work$/
- */
- public function search(): void {
- $this->searchFile($this->currentUser);
- Assert::assertEquals(207, $this->response->getStatusCode());
- }
- /**
- * @Then /^Favorite search should work$/
- */
- public function searchFavorite(): void {
- $this->searchFile(
- $this->currentUser,
- '<oc:favorite/>',
- null,
- '<d:eq>
- <d:prop>
- <oc:favorite/>
- </d:prop>
- <d:literal>yes</d:literal>
- </d:eq>'
- );
- Assert::assertEquals(207, $this->response->getStatusCode());
- }
- /**
- * @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 folder :folderName
- */
- public function downloadingFolder(string $folderName) {
- try {
- $this->response = $this->makeDavRequest($this->currentUser, 'GET', $folderName, ['Accept' => 'application/zip']);
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- /**
- * @When Downloading public folder :folderName
- */
- public function downloadPublicFolder(string $folderName) {
- $token = $this->lastShareData->data->token;
- $fullUrl = substr($this->baseUrl, 0, -4) . "public.php/dav/files/$token/$folderName";
- $client = new GClient();
- $options = [];
- $options['headers'] = [
- 'Accept' => 'application/zip'
- ];
- $this->response = $client->request('GET', $fullUrl, $options);
- }
- /**
- * @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();
- }
- }
- /**
- * @When Downloading public file :filename
- */
- public function downloadingPublicFile(string $filename) {
- $token = $this->lastShareData->data->token;
- $fullUrl = substr($this->baseUrl, 0, -4) . "public.php/dav/files/$token/$filename";
- $client = new GClient();
- $options = [
- 'headers' => [
- 'X-Requested-With' => 'XMLHttpRequest',
- ]
- ];
- try {
- $this->response = $client->request('GET', $fullUrl, $options);
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- /**
- * @When Downloading public file :filename without ajax header
- */
- public function downloadingPublicFileWithoutHeader(string $filename) {
- $token = $this->lastShareData->data->token;
- $fullUrl = substr($this->baseUrl, 0, -4) . "public.php/dav/files/$token/$filename";
- $client = new GClient();
- try {
- $this->response = $client->request('GET', $fullUrl);
- } 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 response should be empty
- * @throws \Exception
- */
- public function theResponseShouldBeEmpty(): void {
- $response = ($this->response instanceof ResponseInterface) ? $this->convertResponseToDavEntries() : $this->response;
- if ($response === []) {
- return;
- }
- throw new \Exception('response is not empty');
- }
- /**
- * @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) {
- $response = ($this->response instanceof ResponseInterface) ? $this->convertResponseToDavSingleEntry() : $this->response;
- if (!array_key_exists($key, $response)) {
- throw new \Exception("Cannot find property \"$key\" with \"$expectedValue\"");
- }
- $value = $response[$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 profind command
- * @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 propfindFile(string $user, string $path, string $properties = '') {
- $client = $this->getSabreClient($user);
- $body = '<?xml version="1.0" encoding="utf-8" ?>
- <d:propfind xmlns:d="DAV:"
- xmlns:oc="http://owncloud.org/ns"
- xmlns:nc="http://nextcloud.org/ns"
- xmlns:ocs="http://open-collaboration-services.org/ns">
- <d:prop>
- ' . $properties . '
- </d:prop>
- </d:propfind>';
- $response = $client->request('PROPFIND', $this->makeSabrePath($user, $path), $body);
- $parsedResponse = $client->parseMultistatus($response['body']);
- return $parsedResponse;
- }
- /**
- * Returns the elements of a searc command
- * @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 searchFile(string $user, ?string $properties = null, ?string $scope = null, ?string $condition = null) {
- $client = $this->getSabreClient($user);
- if ($properties === null) {
- $properties = '<oc:fileid /> <d:getlastmodified /> <d:getetag /> <d:getcontenttype /> <d:getcontentlength /> <nc:has-preview /> <oc:favorite /> <d:resourcetype />';
- }
- if ($condition === null) {
- $condition = '<d:and>
- <d:or>
- <d:eq>
- <d:prop>
- <d:getcontenttype/>
- </d:prop>
- <d:literal>image/png</d:literal>
- </d:eq>
- <d:eq>
- <d:prop>
- <d:getcontenttype/>
- </d:prop>
- <d:literal>image/jpeg</d:literal>
- </d:eq>
- <d:eq>
- <d:prop>
- <d:getcontenttype/>
- </d:prop>
- <d:literal>image/heic</d:literal>
- </d:eq>
- <d:eq>
- <d:prop>
- <d:getcontenttype/>
- </d:prop>
- <d:literal>video/mp4</d:literal>
- </d:eq>
- <d:eq>
- <d:prop>
- <d:getcontenttype/>
- </d:prop>
- <d:literal>video/quicktime</d:literal>
- </d:eq>
- </d:or>
- <d:eq>
- <d:prop>
- <oc:owner-id/>
- </d:prop>
- <d:literal>' . $user . '</d:literal>
- </d:eq>
- </d:and>';
- }
- if ($scope === null) {
- $scope = '<d:href>/files/' . $user . '</d:href><d:depth>infinity</d:depth>';
- }
- $body = '<?xml version="1.0" encoding="UTF-8"?>
- <d:searchrequest xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns" xmlns:ns="https://github.com/icewind1991/SearchDAV/ns" xmlns:ocs="http://open-collaboration-services.org/ns">
- <d:basicsearch>
- <d:select>
- <d:prop>' . $properties . '</d:prop>
- </d:select>
- <d:from><d:scope>' . $scope . '</d:scope></d:from>
- <d:where>' . $condition . '</d:where>
- <d:orderby>
- <d:order>
- <d:prop><d:getlastmodified/></d:prop>
- <d:descending/>
- </d:order>
- </d:orderby>
- <d:limit>
- <d:nresults>35</d:nresults>
- <ns:firstresult>0</ns:firstresult>
- </d:limit>
- </d:basicsearch>
- </d:searchrequest>';
- try {
- $this->response = $this->makeDavRequest($user, 'SEARCH', '', [
- 'Content-Type' => 'text/xml'
- ], $body, '');
- var_dump((string)$this->response->getBody());
- } catch (\GuzzleHttp\Exception\ServerException $e) {
- // 5xx responses cause a server exception
- $this->response = $e->getResponse();
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- // 4xx responses cause a client exception
- $this->response = $e->getResponse();
- }
- }
- /* 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 = '<?xml version="1.0" encoding="utf-8" ?>
- <oc:filter-files xmlns:a="DAV:" xmlns:oc="http://owncloud.org/ns" >
- <a:prop>
- ' . $properties . '
- </a:prop>
- <oc:filter-rules>
- ' . $filterRules . '
- </oc:filter-rules>
- </oc:filter-files>';
- $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\Utils::streamFor(fopen($source, 'r'));
- try {
- $this->response = $this->makeDavRequest($user, 'PUT', $destination, [], $file);
- } catch (\GuzzleHttp\Exception\ServerException $e) {
- // 5xx responses cause a server exception
- $this->response = $e->getResponse();
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- // 4xx responses cause a client 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\Utils::streamFor($content);
- try {
- $this->response = $this->makeDavRequest($user, 'PUT', $destination, [], $file);
- } catch (\GuzzleHttp\Exception\ServerException $e) {
- // 5xx responses cause a server exception
- $this->response = $e->getResponse();
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- // 4xx responses cause a client 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) {
- // 5xx responses cause a server exception
- $this->response = $e->getResponse();
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- // 4xx responses cause a client 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) {
- // 5xx responses cause a server exception
- $this->response = $e->getResponse();
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- // 4xx responses cause a client exception
- $this->response = $e->getResponse();
- }
- }
- /**
- * @Given user :user uploads bulked files :name1 with :content1 and :name2 with :content2 and :name3 with :content3
- * @param string $user
- * @param string $name1
- * @param string $content1
- * @param string $name2
- * @param string $content2
- * @param string $name3
- * @param string $content3
- */
- public function userUploadsBulkedFiles($user, $name1, $content1, $name2, $content2, $name3, $content3) {
- $boundary = 'boundary_azertyuiop';
- $body = '';
- $body .= '--' . $boundary . "\r\n";
- $body .= 'X-File-Path: ' . $name1 . "\r\n";
- $body .= "X-File-MD5: f6a6263167c92de8644ac998b3c4e4d1\r\n";
- $body .= "X-OC-Mtime: 1111111111\r\n";
- $body .= 'Content-Length: ' . strlen($content1) . "\r\n";
- $body .= "\r\n";
- $body .= $content1 . "\r\n";
- $body .= '--' . $boundary . "\r\n";
- $body .= 'X-File-Path: ' . $name2 . "\r\n";
- $body .= "X-File-MD5: 87c7d4068be07d390a1fffd21bf1e944\r\n";
- $body .= "X-OC-Mtime: 2222222222\r\n";
- $body .= 'Content-Length: ' . strlen($content2) . "\r\n";
- $body .= "\r\n";
- $body .= $content2 . "\r\n";
- $body .= '--' . $boundary . "\r\n";
- $body .= 'X-File-Path: ' . $name3 . "\r\n";
- $body .= "X-File-MD5: e86a1cf0678099986a901c79086f5617\r\n";
- $body .= "X-File-Mtime: 3333333333\r\n";
- $body .= 'Content-Length: ' . strlen($content3) . "\r\n";
- $body .= "\r\n";
- $body .= $content3 . "\r\n";
- $body .= '--' . $boundary . "--\r\n";
- $stream = fopen('php://temp', 'r+');
- fwrite($stream, $body);
- rewind($stream);
- $client = new GClient();
- $options = [
- 'auth' => [$user, $this->regularUser],
- 'headers' => [
- 'Content-Type' => 'multipart/related; boundary=' . $boundary,
- 'Content-Length' => (string)strlen($body),
- ],
- 'body' => $body
- ];
- return $client->request('POST', substr($this->baseUrl, 0, -4) . 'remote.php/dav/bulk', $options);
- }
- /**
- * @Given user :user creates a new chunking upload with id :id
- */
- public function userCreatesANewChunkingUploadWithId($user, $id) {
- $this->parts = [];
- $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\Utils::streamFor($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 user :user creates a new chunking v2 upload with id :id and destination :targetDestination
- */
- public function userCreatesANewChunkingv2UploadWithIdAndDestination($user, $id, $targetDestination) {
- $this->s3MultipartDestination = $this->getTargetDestination($user, $targetDestination);
- $this->newUploadId();
- $destination = '/uploads/' . $user . '/' . $this->getUploadId($id);
- $this->response = $this->makeDavRequest($user, 'MKCOL', $destination, [
- 'Destination' => $this->s3MultipartDestination,
- ], null, 'uploads');
- }
- /**
- * @Given user :user uploads new chunk v2 file :num to id :id
- */
- public function userUploadsNewChunkv2FileToIdAndDestination($user, $num, $id) {
- $data = \GuzzleHttp\Psr7\Utils::streamFor(fopen('/tmp/part-upload-' . $num, 'r'));
- $destination = '/uploads/' . $user . '/' . $this->getUploadId($id) . '/' . $num;
- $this->response = $this->makeDavRequest($user, 'PUT', $destination, [
- 'Destination' => $this->s3MultipartDestination
- ], $data, 'uploads');
- }
- /**
- * @Given user :user moves new chunk v2 file with id :id
- */
- public function userMovesNewChunkv2FileWithIdToMychunkedfileAndDestination($user, $id) {
- $source = '/uploads/' . $user . '/' . $this->getUploadId($id) . '/.file';
- try {
- $this->response = $this->makeDavRequest($user, 'MOVE', $source, [
- 'Destination' => $this->s3MultipartDestination,
- ], null, 'uploads');
- } catch (\GuzzleHttp\Exception\ServerException $e) {
- // 5xx responses cause a server exception
- $this->response = $e->getResponse();
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- // 4xx responses cause a client exception
- $this->response = $e->getResponse();
- }
- }
- private function getTargetDestination(string $user, string $destination): string {
- return substr($this->baseUrl, 0, -4) . $this->getDavFilesPath($user) . $destination;
- }
- private function getUploadId(string $id): string {
- return $id . '-' . $this->uploadId;
- }
- private function newUploadId() {
- $this->uploadId = (string)time();
- }
- /**
- * @Given /^Downloading file "([^"]*)" as "([^"]*)"$/
- */
- public function downloadingFileAs($fileName, $user) {
- try {
- $this->response = $this->makeDavRequest($user, 'GET', $fileName, []);
- } catch (\GuzzleHttp\Exception\ServerException $e) {
- // 5xx responses cause a server exception
- $this->response = $e->getResponse();
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- // 4xx responses cause a client exception
- $this->response = $e->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();
- }
- }
- /**
- * @When Requesting share note on dav endpoint
- */
- public function requestingShareNote() {
- $propfind = '<d:propfind xmlns:d="DAV:" xmlns:nc="http://nextcloud.org/ns"><d:prop><nc:note /></d:prop></d:propfind>';
- if (count($this->lastShareData->data->element) > 0) {
- $token = $this->lastShareData->data[0]->token;
- } else {
- $token = $this->lastShareData->data->token;
- }
- try {
- $this->response = $this->makeDavRequest('', 'PROPFIND', $token, [], $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,
- '<oc:favorite/>',
- '<oc:favorite>1</oc:favorite>');
- 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);
- }
- /**
- * @Given /^user "([^"]*)" creates a file locally with "([^"]*)" x 5 MB chunks$/
- */
- public function userCreatesAFileLocallyWithChunks($arg1, $chunks) {
- $this->parts = [];
- for ($i = 1;$i <= (int)$chunks;$i++) {
- $randomletter = substr(str_shuffle('abcdefghijklmnopqrstuvwxyz'), 0, 1);
- file_put_contents('/tmp/part-upload-' . $i, str_repeat($randomletter, 5 * 1024 * 1024));
- $this->parts[] = '/tmp/part-upload-' . $i;
- }
- }
- /**
- * @Given user :user creates the chunk :id with a size of :size MB
- */
- public function userCreatesAChunk($user, $id, $size) {
- $randomletter = substr(str_shuffle('abcdefghijklmnopqrstuvwxyz'), 0, 1);
- file_put_contents('/tmp/part-upload-' . $id, str_repeat($randomletter, (int)$size * 1024 * 1024));
- $this->parts[] = '/tmp/part-upload-' . $id;
- }
- /**
- * @Then /^Downloaded content should be the created file$/
- */
- public function downloadedContentShouldBeTheCreatedFile() {
- $content = '';
- sort($this->parts);
- foreach ($this->parts as $part) {
- $content .= file_get_contents($part);
- }
- Assert::assertEquals($content, (string)$this->response->getBody());
- }
- /**
- * @Then /^the S3 multipart upload was successful with status "([^"]*)"$/
- */
- public function theSmultipartUploadWasSuccessful($status) {
- Assert::assertEquals((int)$status, $this->response->getStatusCode());
- }
- /**
- * @Then /^the upload should fail on object storage$/
- */
- public function theUploadShouldFailOnObjectStorage() {
- $descriptor = [
- 0 => ['pipe', 'r'],
- 1 => ['pipe', 'w'],
- 2 => ['pipe', 'w'],
- ];
- $process = proc_open('php occ config:system:get objectstore --no-ansi', $descriptor, $pipes, '../../');
- $lastCode = proc_close($process);
- if ($lastCode === 0) {
- $this->theHTTPStatusCodeShouldBe(500);
- }
- }
- /**
- * @return array
- * @throws Exception
- */
- private function convertResponseToDavSingleEntry(): array {
- $results = $this->convertResponseToDavEntries();
- if (count($results) > 1) {
- throw new \Exception('result is empty or contain more than one (1) entry');
- }
- return array_shift($results);
- }
- /**
- * @return array
- */
- private function convertResponseToDavEntries(): array {
- $client = $this->getSabreClient($this->currentUser);
- $parsedResponse = $client->parseMultiStatus((string)$this->response->getBody());
- $results = [];
- foreach ($parsedResponse as $href => $statusList) {
- $results[$href] = $statusList[200] ?? [];
- }
- return $results;
- }
- }
|