2013-01-11 17:13:22 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 14:49:16 +00:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2016-05-26 17:56:05 +00:00
|
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
|
|
* @author Christopher Schäpers <kondou@ts.unde.re>
|
2016-07-21 14:49:16 +00:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
2016-05-26 17:56:05 +00:00
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2016-01-12 14:02:16 +00:00
|
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
2017-11-06 14:56:42 +00:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
|
|
* @author Roger Szabo <roger.szabo@web.de>
|
2016-07-21 14:49:16 +00:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2013-01-11 17:13:22 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* @license AGPL-3.0
|
2013-01-11 17:13:22 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* 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.
|
2013-01-11 17:13:22 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2013-01-11 17:13:22 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 10:44:34 +00:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2013-01-11 17:13:22 +00:00
|
|
|
*
|
2015-03-26 10:44:34 +00:00
|
|
|
* 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/>
|
2013-01-11 17:13:22 +00:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2016-05-12 14:11:59 +00:00
|
|
|
namespace OCA\User_LDAP;
|
2013-01-11 17:13:22 +00:00
|
|
|
|
2014-11-05 12:05:07 +00:00
|
|
|
use OCA\User_LDAP\Mapping\UserMapping;
|
|
|
|
use OCA\User_LDAP\Mapping\GroupMapping;
|
2016-06-13 17:32:54 +00:00
|
|
|
use OCA\User_LDAP\User\Manager;
|
2013-09-10 15:11:02 +00:00
|
|
|
|
2013-01-11 17:13:22 +00:00
|
|
|
abstract class Proxy {
|
2013-09-10 15:11:02 +00:00
|
|
|
static private $accesses = array();
|
|
|
|
private $ldap = null;
|
2013-01-11 17:13:22 +00:00
|
|
|
|
2015-05-08 11:27:27 +00:00
|
|
|
/** @var \OCP\ICache|null */
|
|
|
|
private $cache;
|
|
|
|
|
2014-05-11 13:17:27 +00:00
|
|
|
/**
|
|
|
|
* @param ILDAPWrapper $ldap
|
|
|
|
*/
|
2013-09-10 15:11:02 +00:00
|
|
|
public function __construct(ILDAPWrapper $ldap) {
|
|
|
|
$this->ldap = $ldap;
|
2015-05-08 11:27:27 +00:00
|
|
|
$memcache = \OC::$server->getMemCacheFactory();
|
|
|
|
if($memcache->isAvailable()) {
|
2017-12-15 10:31:13 +00:00
|
|
|
$this->cache = $memcache->createDistributed();
|
2015-05-08 11:27:27 +00:00
|
|
|
}
|
2013-01-11 17:13:22 +00:00
|
|
|
}
|
|
|
|
|
2014-05-11 13:17:27 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $configPrefix
|
2014-05-11 13:17:27 +00:00
|
|
|
*/
|
2013-09-10 15:11:02 +00:00
|
|
|
private function addAccess($configPrefix) {
|
2014-03-27 17:01:14 +00:00
|
|
|
static $ocConfig;
|
|
|
|
static $fs;
|
|
|
|
static $log;
|
|
|
|
static $avatarM;
|
2014-11-05 12:05:07 +00:00
|
|
|
static $userMap;
|
|
|
|
static $groupMap;
|
2015-01-06 23:52:18 +00:00
|
|
|
static $db;
|
2016-03-02 12:02:43 +00:00
|
|
|
static $coreUserManager;
|
2017-03-31 07:16:22 +00:00
|
|
|
static $coreNotificationManager;
|
2017-10-19 09:05:24 +00:00
|
|
|
if($fs === null) {
|
2014-03-27 17:01:14 +00:00
|
|
|
$ocConfig = \OC::$server->getConfig();
|
|
|
|
$fs = new FilesystemHelper();
|
|
|
|
$log = new LogWrapper();
|
|
|
|
$avatarM = \OC::$server->getAvatarManager();
|
2015-01-06 23:52:18 +00:00
|
|
|
$db = \OC::$server->getDatabaseConnection();
|
|
|
|
$userMap = new UserMapping($db);
|
|
|
|
$groupMap = new GroupMapping($db);
|
2016-03-02 12:02:43 +00:00
|
|
|
$coreUserManager = \OC::$server->getUserManager();
|
2017-03-31 07:16:22 +00:00
|
|
|
$coreNotificationManager = \OC::$server->getNotificationManager();
|
2014-03-27 17:01:14 +00:00
|
|
|
}
|
|
|
|
$userManager =
|
2017-03-31 07:16:22 +00:00
|
|
|
new Manager($ocConfig, $fs, $log, $avatarM, new \OCP\Image(), $db,
|
|
|
|
$coreUserManager, $coreNotificationManager);
|
2013-09-10 15:11:02 +00:00
|
|
|
$connector = new Connection($this->ldap, $configPrefix);
|
2017-11-08 00:51:14 +00:00
|
|
|
$access = new Access($connector, $this->ldap, $userManager, new Helper($ocConfig), $ocConfig);
|
2014-11-05 12:05:07 +00:00
|
|
|
$access->setUserMapper($userMap);
|
|
|
|
$access->setGroupMapper($groupMap);
|
|
|
|
self::$accesses[$configPrefix] = $access;
|
2013-01-11 17:13:22 +00:00
|
|
|
}
|
|
|
|
|
2014-05-11 13:17:27 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $configPrefix
|
2014-05-11 13:17:27 +00:00
|
|
|
* @return mixed
|
|
|
|
*/
|
2013-09-10 15:11:02 +00:00
|
|
|
protected function getAccess($configPrefix) {
|
|
|
|
if(!isset(self::$accesses[$configPrefix])) {
|
|
|
|
$this->addAccess($configPrefix);
|
2013-01-11 17:13:22 +00:00
|
|
|
}
|
2013-09-10 15:11:02 +00:00
|
|
|
return self::$accesses[$configPrefix];
|
2013-01-11 17:13:22 +00:00
|
|
|
}
|
|
|
|
|
2014-05-11 13:17:27 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $uid
|
2014-05-11 13:17:27 +00:00
|
|
|
* @return string
|
|
|
|
*/
|
2013-01-11 17:13:22 +00:00
|
|
|
protected function getUserCacheKey($uid) {
|
|
|
|
return 'user-'.$uid.'-lastSeenOn';
|
|
|
|
}
|
|
|
|
|
2014-05-11 13:17:27 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $gid
|
2014-05-11 13:17:27 +00:00
|
|
|
* @return string
|
|
|
|
*/
|
2013-01-11 17:13:22 +00:00
|
|
|
protected function getGroupCacheKey($gid) {
|
|
|
|
return 'group-'.$gid.'-lastSeenOn';
|
|
|
|
}
|
|
|
|
|
2014-02-06 15:30:58 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $id
|
|
|
|
* @param string $method
|
|
|
|
* @param array $parameters
|
2014-05-11 13:17:27 +00:00
|
|
|
* @param bool $passOnWhen
|
|
|
|
* @return mixed
|
2014-02-06 15:30:58 +00:00
|
|
|
*/
|
2013-11-25 21:05:00 +00:00
|
|
|
abstract protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
|
2014-02-19 08:31:54 +00:00
|
|
|
|
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $id
|
|
|
|
* @param string $method
|
|
|
|
* @param array $parameters
|
2014-05-11 13:17:27 +00:00
|
|
|
* @return mixed
|
2014-02-19 08:31:54 +00:00
|
|
|
*/
|
2013-01-11 17:13:22 +00:00
|
|
|
abstract protected function walkBackends($id, $method, $parameters);
|
|
|
|
|
2017-02-17 17:45:33 +00:00
|
|
|
/**
|
|
|
|
* @param string $id
|
|
|
|
* @return Access
|
|
|
|
*/
|
|
|
|
abstract public function getLDAPAccess($id);
|
|
|
|
|
2013-01-11 17:13:22 +00:00
|
|
|
/**
|
2014-05-19 15:50:53 +00:00
|
|
|
* Takes care of the request to the User backend
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $id
|
2014-02-06 15:30:58 +00:00
|
|
|
* @param string $method string, the method of the user backend that shall be called
|
2014-05-11 13:17:27 +00:00
|
|
|
* @param array $parameters an array of parameters to be passed
|
|
|
|
* @param bool $passOnWhen
|
2013-01-11 17:13:22 +00:00
|
|
|
* @return mixed, the result of the specified method
|
|
|
|
*/
|
2013-11-25 21:05:00 +00:00
|
|
|
protected function handleRequest($id, $method, $parameters, $passOnWhen = false) {
|
|
|
|
$result = $this->callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
|
|
|
|
if($result === $passOnWhen) {
|
2013-01-11 17:13:22 +00:00
|
|
|
$result = $this->walkBackends($id, $method, $parameters);
|
|
|
|
}
|
|
|
|
return $result;
|
|
|
|
}
|
|
|
|
|
2014-04-14 15:39:29 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string|null $key
|
2014-05-11 13:17:27 +00:00
|
|
|
* @return string
|
2014-04-14 15:39:29 +00:00
|
|
|
*/
|
2013-01-11 17:13:22 +00:00
|
|
|
private function getCacheKey($key) {
|
|
|
|
$prefix = 'LDAP-Proxy-';
|
2017-10-19 09:05:24 +00:00
|
|
|
if($key === null) {
|
2013-01-11 17:13:22 +00:00
|
|
|
return $prefix;
|
|
|
|
}
|
2018-03-02 15:26:36 +00:00
|
|
|
return $prefix.hash('sha256', $key);
|
2013-01-11 17:13:22 +00:00
|
|
|
}
|
|
|
|
|
2014-02-06 15:30:58 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $key
|
2014-05-11 13:17:27 +00:00
|
|
|
* @return mixed|null
|
2014-02-06 15:30:58 +00:00
|
|
|
*/
|
2013-01-11 17:13:22 +00:00
|
|
|
public function getFromCache($key) {
|
2017-10-19 09:03:31 +00:00
|
|
|
if($this->cache === null) {
|
2013-01-11 17:13:22 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
$key = $this->getCacheKey($key);
|
2017-10-19 09:03:31 +00:00
|
|
|
$value = $this->cache->get($key);
|
|
|
|
if ($value === null) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
return json_decode(base64_decode($value));
|
2013-01-11 17:13:22 +00:00
|
|
|
}
|
|
|
|
|
2014-02-06 15:30:58 +00:00
|
|
|
/**
|
2014-05-13 11:29:25 +00:00
|
|
|
* @param string $key
|
|
|
|
* @param mixed $value
|
2014-02-06 15:30:58 +00:00
|
|
|
*/
|
2013-01-11 17:13:22 +00:00
|
|
|
public function writeToCache($key, $value) {
|
2017-10-19 09:05:24 +00:00
|
|
|
if($this->cache === null) {
|
2015-05-08 11:27:27 +00:00
|
|
|
return;
|
|
|
|
}
|
2013-01-11 17:13:22 +00:00
|
|
|
$key = $this->getCacheKey($key);
|
2015-09-02 10:12:31 +00:00
|
|
|
$value = base64_encode(json_encode($value));
|
2017-10-19 09:05:24 +00:00
|
|
|
$this->cache->set($key, $value, 2592000);
|
2013-01-11 17:13:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public function clearCache() {
|
2017-10-19 09:05:24 +00:00
|
|
|
if($this->cache === null) {
|
2015-05-08 11:27:27 +00:00
|
|
|
return;
|
|
|
|
}
|
2013-01-11 17:13:22 +00:00
|
|
|
$this->cache->clear($this->getCacheKey(null));
|
|
|
|
}
|
2013-08-18 09:02:08 +00:00
|
|
|
}
|