Skip to content

Commit

Permalink
Merge pull request #16525 from nextcloud/bugfix/external-user-substit…
Browse files Browse the repository at this point in the history
…ution

files_external: proper user context for sharing
  • Loading branch information
blizzz authored Aug 2, 2019
2 parents 67f90cb + ef237f8 commit bc40916
Show file tree
Hide file tree
Showing 7 changed files with 128 additions and 32 deletions.
2 changes: 1 addition & 1 deletion apps/files_external/lib/Config/ConfigAdapter.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public function __construct(
*/
private function prepareStorageConfig(StorageConfig &$storage, IUser $user) {
foreach ($storage->getBackendOptions() as $option => $value) {
$storage->setBackendOption($option, \OC_Mount_Config::substitutePlaceholdersInConfig($value));
$storage->setBackendOption($option, \OC_Mount_Config::substitutePlaceholdersInConfig($value, $user->getUID()));
}

$objectStore = $storage->getBackendOption('objectstore');
Expand Down
2 changes: 1 addition & 1 deletion apps/files_external/lib/Config/SimpleSubstitutionTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ trait SimpleSubstitutionTrait {
* @var string the placeholder without $ prefix
* @since 16.0.0
*/
private $placeholder;
protected $placeholder;

/** @var string */
protected $sanitizedPlaceholder;
Expand Down
89 changes: 89 additions & 0 deletions apps/files_external/lib/Config/UserContext.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?php
/**
* @copyright Copyright (c) 2019 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @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 <http://www.gnu.org/licenses/>.
*
*/

namespace OCA\Files_External\Config;

use OCP\IRequest;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\IManager as ShareManager;

class UserContext {

/** @var IUserSession */
private $session;

/** @var ShareManager */
private $shareManager;

/** @var IRequest */
private $request;

/** @var string */
private $userId;

/** @var IUserManager */
private $userManager;

public function __construct(IUserSession $session, ShareManager $manager, IRequest $request, IUserManager $userManager) {
$this->session = $session;
$this->shareManager = $manager;
$this->request = $request;
$this->userManager = $userManager;
}

public function getSession(): IUserSession {
return $this->session;
}

public function setUserId(string $userId): void {
$this->userId = $userId;
}

protected function getUserId(): ?string {
if ($this->userId !== null) {
return $this->userId;
}
if($this->session && $this->session->getUser() !== null) {
return $this->session->getUser()->getUID();
}
try {
$shareToken = $this->request->getParam('token');
$share = $this->shareManager->getShareByToken($shareToken);
return $share->getShareOwner();
} catch (ShareNotFound $e) {}

return null;
}

protected function getUser(): ?IUser {
$userId = $this->getUserId();
if($userId !== null) {
return $this->userManager->get($userId);
}
return null;
}

}
19 changes: 4 additions & 15 deletions apps/files_external/lib/Config/UserPlaceholderHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,31 +23,20 @@

namespace OCA\Files_External\Config;

use OCP\IUserSession;

class UserPlaceholderHandler implements IConfigHandler {
class UserPlaceholderHandler extends UserContext implements IConfigHandler {
use SimpleSubstitutionTrait;

/** @var IUserSession */
private $session;

public function __construct(IUserSession $session) {
$this->session = $session;
$this->placeholder = 'user';
}

/**
* @param mixed $optionValue
* @return mixed the same type as $optionValue
* @since 16.0.0
*/
public function handle($optionValue) {
$user = $this->session->getUser();
if($user === null) {
$this->placeholder = 'user';
$uid = $this->getUserId();
if($uid === null) {
return $optionValue;
}
$uid = $user->getUID();

return $this->processInput($optionValue, $uid);
}
}
11 changes: 8 additions & 3 deletions apps/files_external/lib/config.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
use OCP\IUserManager;
use OCA\Files_External\Service\GlobalStoragesService;
use OCA\Files_External\Service\UserStoragesService;
use OCA\Files_External\Config\UserContext;

/**
* Class to configure mount.json globally and for users
Expand Down Expand Up @@ -107,7 +108,7 @@ public static function getAbsoluteMountPoints($uid) {
$mountPoint = '/'.$uid.'/files'.$storage->getMountPoint();
$mountEntry = self::prepareMountPointEntry($storage, false);
foreach ($mountEntry['options'] as &$option) {
$option = self::substitutePlaceholdersInConfig($option);
$option = self::substitutePlaceholdersInConfig($option, $uid);
}
$mountPoints[$mountPoint] = $mountEntry;
}
Expand All @@ -116,7 +117,7 @@ public static function getAbsoluteMountPoints($uid) {
$mountPoint = '/'.$uid.'/files'.$storage->getMountPoint();
$mountEntry = self::prepareMountPointEntry($storage, true);
foreach ($mountEntry['options'] as &$option) {
$option = self::substitutePlaceholdersInConfig($uid, $option);
$option = self::substitutePlaceholdersInConfig($option, $uid);
}
$mountPoints[$mountPoint] = $mountEntry;
}
Expand Down Expand Up @@ -211,16 +212,20 @@ public static function setUserVars($user, $input) {

/**
* @param mixed $input
* @param string|null $userId
* @return mixed
* @throws \OCP\AppFramework\QueryException
* @since 16.0.0
*/
public static function substitutePlaceholdersInConfig($input) {
public static function substitutePlaceholdersInConfig($input, string $userId = null) {
/** @var BackendService $backendService */
$backendService = self::$app->getContainer()->query(BackendService::class);
/** @var IConfigHandler[] $handlers */
$handlers = $backendService->getConfigHandlers();
foreach ($handlers as $handler) {
if ($handler instanceof UserContext && $userId !== null) {
$handler->setUserId($userId);
}
$input = $handler->handle($input);
}
return $input;
Expand Down
21 changes: 20 additions & 1 deletion apps/files_external/tests/Config/UserPlaceholderHandlerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,12 @@
namespace OCA\files_external\tests\Config;

use OCA\Files_External\Config\UserPlaceholderHandler;
use OCP\IRequest;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\IManager;

class UserPlaceholderHandlerTest extends \Test\TestCase {
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject */
Expand All @@ -34,6 +38,15 @@ class UserPlaceholderHandlerTest extends \Test\TestCase {
/** @var IUserSession|\PHPUnit_Framework_MockObject_MockObject */
protected $session;

/** @var IManager|\PHPUnit_Framework_MockObject_MockObject */
private $shareManager;

/** @var IRequest|\PHPUnit_Framework_MockObject_MockObject */
private $request;

/** @var IUserManager|\PHPUnit_Framework_MockObject_MockObject */
private $userManager;

/** @var UserPlaceholderHandler */
protected $handler;

Expand All @@ -45,8 +58,11 @@ public function setUp() {
->method('getUid')
->willReturn('alice');
$this->session = $this->createMock(IUserSession::class);
$this->shareManager = $this->createMock(IManager::class);
$this->request = $this->createMock(IRequest::class);
$this->userManager = $this->createMock(IUserManager::class);

$this->handler = new UserPlaceholderHandler($this->session);
$this->handler = new UserPlaceholderHandler($this->session, $this->shareManager, $this->request, $this->userManager);
}

protected function setUser() {
Expand Down Expand Up @@ -75,6 +91,9 @@ public function testHandle($option, $expected) {
* @dataProvider optionProvider
*/
public function testHandleNoUser($option) {
$this->shareManager->expects($this->once())
->method('getShareByToken')
->willThrowException(new ShareNotFound());
$this->assertSame($option, $this->handler->handle($option));
}

Expand Down
16 changes: 5 additions & 11 deletions apps/user_ldap/lib/Handler/ExtStorageConfigHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,22 @@

use OCA\Files_External\Config\IConfigHandler;
use OCA\Files_External\Config\SimpleSubstitutionTrait;
use OCA\Files_External\Config\UserContext;
use OCA\User_LDAP\User_Proxy;
use OCP\IUserSession;

class ExtStorageConfigHandler implements IConfigHandler {
class ExtStorageConfigHandler extends UserContext implements IConfigHandler {
use SimpleSubstitutionTrait;

/** @var IUserSession */
private $session;

public function __construct(IUserSession $session) {
$this->placeholder = 'home';
$this->session = $session;
}

/**
* @param mixed $optionValue
* @return mixed the same type as $optionValue
* @since 16.0.0
* @throws \Exception
*/
public function handle($optionValue) {
$user = $this->session->getUser();
$this->placeholder = 'home';
$user = $this->getUser();

if($user === null) {
return $optionValue;
}
Expand Down

0 comments on commit bc40916

Please sign in to comment.