123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Phil Davis <phil.davis@inf.org>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Sergio Bertolin <sbertolin@solidgear.es>
- * @author Vincent Petry <vincent@nextcloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- require __DIR__ . '/../../vendor/autoload.php';
- use Behat\Gherkin\Node\TableNode;
- use GuzzleHttp\Client;
- use GuzzleHttp\Message\ResponseInterface;
- class TagsContext implements \Behat\Behat\Context\Context {
- /** @var string */
- private $baseUrl;
- /** @var Client */
- private $client;
- /** @var ResponseInterface */
- private $response;
- /**
- * @param string $baseUrl
- */
- public function __construct($baseUrl) {
- $this->baseUrl = $baseUrl;
- // in case of ci deployment we take the server url from the environment
- $testServerUrl = getenv('TEST_SERVER_URL');
- if ($testServerUrl !== false) {
- $this->baseUrl = substr($testServerUrl, 0, -5);
- }
- }
- /** @BeforeScenario */
- public function setUpScenario() {
- $this->client = new Client();
- }
- /** @AfterScenario */
- public function tearDownScenario() {
- $user = 'admin';
- $tags = $this->requestTagsForUser($user);
- foreach ($tags as $tagId => $tag) {
- $this->response = $this->client->delete(
- $this->baseUrl . '/remote.php/dav/systemtags/' . $tagId,
- [
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- 'headers' => [
- 'Content-Type' => 'application/json',
- ],
- ]
- );
- }
- try {
- $this->client->delete(
- $this->baseUrl . '/remote.php/webdav/myFileToTag.txt',
- [
- 'auth' => [
- 'user0',
- '123456',
- ],
- 'headers' => [
- 'Content-Type' => 'application/json',
- ],
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- }
- }
- /**
- * @param string $userName
- * @return string
- */
- private function getPasswordForUser($userName) {
- if ($userName === 'admin') {
- return 'admin';
- }
- return '123456';
- }
- /**
- * @param string $user
- * @param string $type
- * @param string $name
- * @param string $groups
- */
- private function createTag($user, $type, $name, $groups = null) {
- $userVisible = true;
- $userAssignable = true;
- switch ($type) {
- case 'normal':
- break;
- case 'not user-assignable':
- $userAssignable = false;
- break;
- case 'not user-visible':
- $userVisible = false;
- break;
- default:
- throw new \Exception('Unsupported type');
- }
- $body = [
- 'name' => $name,
- 'userVisible' => $userVisible,
- 'userAssignable' => $userAssignable,
- ];
- if ($groups !== null) {
- $body['groups'] = $groups;
- }
- try {
- $this->response = $this->client->post(
- $this->baseUrl . '/remote.php/dav/systemtags/',
- [
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- 'headers' => [
- 'Content-Type' => 'application/json',
- ],
- 'body' => json_encode($body)
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- /**
- * @When :user creates a :type tag with name :name
- * @param string $user
- * @param string $type
- * @param string $name
- * @throws \Exception
- */
- public function createsATagWithName($user, $type, $name) {
- $this->createTag($user, $type, $name);
- }
- /**
- * @When :user creates a :type tag with name :name and groups :groups
- * @param string $user
- * @param string $type
- * @param string $name
- * @param string $groups
- * @throws \Exception
- */
- public function createsATagWithNameAndGroups($user, $type, $name, $groups) {
- $this->createTag($user, $type, $name, $groups);
- }
- /**
- * @Then The response should have a status code :statusCode
- * @param int $statusCode
- * @throws \Exception
- */
- public function theResponseShouldHaveAStatusCode($statusCode) {
- if ((int)$statusCode !== $this->response->getStatusCode()) {
- throw new \Exception("Expected $statusCode, got " . $this->response->getStatusCode());
- }
- }
- /**
- * Returns all tags for a given user
- *
- * @param string $user
- * @return array
- */
- private function requestTagsForUser($user, $withGroups = false) {
- try {
- $body = '<?xml version="1.0"?>
- <d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
- <d:prop>
- <oc:id />
- <oc:display-name />
- <oc:user-visible />
- <oc:user-assignable />
- <oc:can-assign />
- ';
- if ($withGroups) {
- $body .= '<oc:groups />';
- }
- $body .= '
- </d:prop>
- </d:propfind>';
- $this->response = $this->client->request(
- 'PROPFIND',
- $this->baseUrl . '/remote.php/dav/systemtags/',
- [
- 'body' => $body,
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- 'headers' => [
- 'Content-Type' => 'application/json',
- ],
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- $tags = [];
- $service = new Sabre\Xml\Service();
- $parsed = $service->parse($this->response->getBody()->getContents());
- foreach ($parsed as $entry) {
- $singleEntry = $entry['value'][1]['value'][0]['value'];
- if (empty($singleEntry[0]['value'])) {
- continue;
- }
- // FIXME: use actual property names instead of guessing index position
- $tags[$singleEntry[0]['value']] = [
- 'display-name' => $singleEntry[1]['value'],
- 'user-visible' => $singleEntry[2]['value'],
- 'user-assignable' => $singleEntry[3]['value'],
- 'can-assign' => $singleEntry[4]['value'],
- ];
- if (isset($singleEntry[5])) {
- $tags[$singleEntry[0]['value']]['groups'] = $singleEntry[5]['value'];
- }
- }
- return $tags;
- }
- /**
- * @Then The following tags should exist for :user
- * @param string $user
- * @param TableNode $table
- * @throws \Exception
- */
- public function theFollowingTagsShouldExistFor($user, TableNode $table) {
- $tags = $this->requestTagsForUser($user);
- if (count($table->getRows()) !== count($tags)) {
- throw new \Exception(
- sprintf(
- "Expected %s tags, got %s.",
- count($table->getRows()),
- count($tags)
- )
- );
- }
- foreach ($table->getRowsHash() as $rowDisplayName => $row) {
- foreach ($tags as $key => $tag) {
- if (
- $tag['display-name'] === $rowDisplayName &&
- $tag['user-visible'] === $row[0] &&
- $tag['user-assignable'] === $row[1]
- ) {
- unset($tags[$key]);
- }
- }
- }
- if (count($tags) !== 0) {
- throw new \Exception('Not expected response');
- }
- }
- /**
- * @Then the user :user :can assign The :type tag with name :tagName
- */
- public function theUserCanAssignTheTag($user, $can, $type, $tagName) {
- $foundTag = $this->findTag($type, $tagName, $user);
- if ($foundTag === null) {
- throw new \Exception('No matching tag found');
- }
- if ($can === 'can') {
- $expected = 'true';
- } elseif ($can === 'cannot') {
- $expected = 'false';
- } else {
- throw new \Exception('Invalid condition, must be "can" or "cannot"');
- }
- if ($foundTag['can-assign'] !== $expected) {
- throw new \Exception('Tag cannot be assigned by user');
- }
- }
- /**
- * @Then The :type tag with name :tagName has the groups :groups
- */
- public function theTagHasGroup($type, $tagName, $groups) {
- $foundTag = $this->findTag($type, $tagName, 'admin', true);
- if ($foundTag === null) {
- throw new \Exception('No matching tag found');
- }
- if ($foundTag['groups'] !== $groups) {
- throw new \Exception('Tag has groups "' . $foundTag['group'] . '" instead of the expected "' . $groups . '"');
- }
- }
- /**
- * @Then :count tags should exist for :user
- * @param int $count
- * @param string $user
- * @throws \Exception
- */
- public function tagsShouldExistFor($count, $user) {
- if ((int)$count !== count($this->requestTagsForUser($user))) {
- throw new \Exception("Expected $count tags, got " . count($this->requestTagsForUser($user)));
- }
- }
- /**
- * Find tag by type and name
- *
- * @param string $type tag type
- * @param string $tagName tag name
- * @param string $user retrieved from which user
- * @param bool $withGroups whether to also query the tag's groups
- *
- * @return array tag values or null if not found
- */
- private function findTag($type, $tagName, $user = 'admin', $withGroups = false) {
- $tags = $this->requestTagsForUser($user, $withGroups);
- $userAssignable = 'true';
- $userVisible = 'true';
- switch ($type) {
- case 'normal':
- break;
- case 'not user-assignable':
- $userAssignable = 'false';
- break;
- case 'not user-visible':
- $userVisible = 'false';
- break;
- default:
- throw new \Exception('Unsupported type');
- }
- $foundTag = null;
- foreach ($tags as $tag) {
- if ($tag['display-name'] === $tagName
- && $tag['user-visible'] === $userVisible
- && $tag['user-assignable'] === $userAssignable) {
- $foundTag = $tag;
- break;
- }
- }
- return $foundTag;
- }
- /**
- * @param string $name
- * @return int
- */
- private function findTagIdByName($name) {
- $tags = $this->requestTagsForUser('admin');
- $tagId = 0;
- foreach ($tags as $id => $tag) {
- if ($tag['display-name'] === $name) {
- $tagId = $id;
- break;
- }
- }
- return (int)$tagId;
- }
- /**
- * @When :user edits the tag with name :oldNmae and sets its name to :newName
- * @param string $user
- * @param string $oldName
- * @param string $newName
- * @throws \Exception
- */
- public function editsTheTagWithNameAndSetsItsNameTo($user, $oldName, $newName) {
- $tagId = $this->findTagIdByName($oldName);
- if ($tagId === 0) {
- throw new \Exception('Could not find tag to rename');
- }
- try {
- $this->response = $this->client->request(
- 'PROPPATCH',
- $this->baseUrl . '/remote.php/dav/systemtags/' . $tagId,
- [
- 'body' => '<?xml version="1.0"?>
- <d:propertyupdate xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
- <d:set>
- <d:prop>
- <oc:display-name>' . $newName . '</oc:display-name>
- </d:prop>
- </d:set>
- </d:propertyupdate>',
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- /**
- * @When :user edits the tag with name :oldNmae and sets its groups to :groups
- * @param string $user
- * @param string $oldName
- * @param string $groups
- * @throws \Exception
- */
- public function editsTheTagWithNameAndSetsItsGroupsTo($user, $oldName, $groups) {
- $tagId = $this->findTagIdByName($oldName);
- if ($tagId === 0) {
- throw new \Exception('Could not find tag to rename');
- }
- try {
- $this->response = $this->client->request(
- 'PROPPATCH',
- $this->baseUrl . '/remote.php/dav/systemtags/' . $tagId,
- [
- 'body' => '<?xml version="1.0"?>
- <d:propertyupdate xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
- <d:set>
- <d:prop>
- <oc:groups>' . $groups . '</oc:groups>
- </d:prop>
- </d:set>
- </d:propertyupdate>',
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- /**
- * @When :user deletes the tag with name :name
- * @param string $user
- * @param string $name
- */
- public function deletesTheTagWithName($user, $name) {
- $tagId = $this->findTagIdByName($name);
- try {
- $this->response = $this->client->delete(
- $this->baseUrl . '/remote.php/dav/systemtags/' . $tagId,
- [
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- 'headers' => [
- 'Content-Type' => 'application/json',
- ],
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- /**
- * @param string $path
- * @param string $user
- * @return int
- */
- private function getFileIdForPath($path, $user) {
- $url = $this->baseUrl . '/remote.php/webdav/' . $path;
- $credentials = base64_encode($user . ':' . $this->getPasswordForUser($user));
- $context = stream_context_create([
- 'http' => [
- 'method' => 'PROPFIND',
- 'header' => "Authorization: Basic $credentials\r\nContent-Type: application/x-www-form-urlencoded",
- 'content' => '<?xml version="1.0"?>
- <d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
- <d:prop>
- <oc:fileid />
- </d:prop>
- </d:propfind>'
- ]
- ]);
- $response = file_get_contents($url, false, $context);
- preg_match_all('/\<oc:fileid\>(.*?)\<\/oc:fileid\>/', $response, $matches);
- return (int)$matches[1][0];
- }
- /**
- * @When /^"([^"]*)" adds the tag "([^"]*)" to "([^"]*)" (shared|owned) by "([^"]*)"$/
- * @param string $taggingUser
- * @param string $tagName
- * @param string $fileName
- * @param string $sharingUser
- */
- public function addsTheTagToSharedBy($taggingUser, $tagName, $fileName, $sharedOrOwnedBy, $sharingUser) {
- $fileId = $this->getFileIdForPath($fileName, $sharingUser);
- $tagId = $this->findTagIdByName($tagName);
- try {
- $this->response = $this->client->put(
- $this->baseUrl . '/remote.php/dav/systemtags-relations/files/' . $fileId . '/' . $tagId,
- [
- 'auth' => [
- $taggingUser,
- $this->getPasswordForUser($taggingUser),
- ]
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- /**
- * @Then /^"([^"]*)" (shared|owned) by "([^"]*)" has the following tags$/
- * @param string $fileName
- * @param string $sharingUser
- * @param TableNode $table
- * @throws \Exception
- */
- public function sharedByHasTheFollowingTags($fileName, $sharedOrOwnedBy, $sharingUser, TableNode $table) {
- $loadedExpectedTags = $table->getTable();
- $expectedTags = [];
- foreach ($loadedExpectedTags as $expected) {
- $expectedTags[] = $expected[0];
- }
- // Get the real tags
- $response = $this->client->request(
- 'PROPFIND',
- $this->baseUrl . '/remote.php/dav/systemtags-relations/files/' . $this->getFileIdForPath($fileName, $sharingUser),
- [
- 'auth' => [
- $sharingUser,
- $this->getPasswordForUser($sharingUser),
- ],
- 'body' => '<?xml version="1.0"?>
- <d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
- <d:prop>
- <oc:id />
- <oc:display-name />
- <oc:user-visible />
- <oc:user-assignable />
- </d:prop>
- </d:propfind>',
- ]
- )->getBody()->getContents();
- preg_match_all('/\<oc:display-name\>(.*?)\<\/oc:display-name\>/', $response, $realTags);
- foreach ($expectedTags as $key => $row) {
- foreach ($realTags as $tag) {
- if ($tag[0] === $row) {
- unset($expectedTags[$key]);
- }
- }
- }
- if (count($expectedTags) !== 0) {
- throw new \Exception('Not all tags found.');
- }
- }
- /**
- * @Then :fileName shared by :sharingUser has the following tags for :user
- * @param string $fileName
- * @param string $sharingUser
- * @param string $user
- * @param TableNode $table
- * @throws \Exception
- */
- public function sharedByHasTheFollowingTagsFor($fileName, $sharingUser, $user, TableNode $table) {
- $loadedExpectedTags = $table->getTable();
- $expectedTags = [];
- foreach ($loadedExpectedTags as $expected) {
- $expectedTags[] = $expected[0];
- }
- // Get the real tags
- try {
- $this->response = $this->client->request(
- 'PROPFIND',
- $this->baseUrl . '/remote.php/dav/systemtags-relations/files/' . $this->getFileIdForPath($fileName, $sharingUser),
- [
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- 'body' => '<?xml version="1.0"?>
- <d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
- <d:prop>
- <oc:id />
- <oc:display-name />
- <oc:user-visible />
- <oc:user-assignable />
- </d:prop>
- </d:propfind>',
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- preg_match_all('/\<oc:display-name\>(.*?)\<\/oc:display-name\>/', $this->response->getBody()->getContents(), $realTags);
- $realTags = array_filter($realTags);
- $expectedTags = array_filter($expectedTags);
- foreach ($expectedTags as $key => $row) {
- foreach ($realTags as $tag) {
- foreach ($tag as $index => $foo) {
- if ($tag[$index] === $row) {
- unset($expectedTags[$key]);
- }
- }
- }
- }
- if (count($expectedTags) !== 0) {
- throw new \Exception('Not all tags found.');
- }
- }
- /**
- * @When :user removes the tag :tagName from :fileName shared by :shareUser
- * @param string $user
- * @param string $tagName
- * @param string $fileName
- * @param string $shareUser
- */
- public function removesTheTagFromSharedBy($user, $tagName, $fileName, $shareUser) {
- $tagId = $this->findTagIdByName($tagName);
- $fileId = $this->getFileIdForPath($fileName, $shareUser);
- try {
- $this->response = $this->client->delete(
- $this->baseUrl . '/remote.php/dav/systemtags-relations/files/' . $fileId . '/' . $tagId,
- [
- 'auth' => [
- $user,
- $this->getPasswordForUser($user),
- ],
- ]
- );
- } catch (\GuzzleHttp\Exception\ClientException $e) {
- $this->response = $e->getResponse();
- }
- }
- }
|