server/apps/user_ldap/lib/proxy.php

201 lines
5.1 KiB
PHP
Raw Normal View History

<?php
/**
2015-03-26 10:44:34 +00:00
* @author Arthur Schiwon <blizzz@owncloud.com>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Christopher Schäpers <kondou@ts.unde.re>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Morris Jobke <hey@morrisjobke.de>
2016-01-12 14:02:16 +00:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
2016-01-12 14:02:16 +00:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 10:44:34 +00:00
* @license AGPL-3.0
*
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.
*
2015-03-26 10:44:34 +00:00
* This program is distributed in the hope that it will be useful,
* 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.
*
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/>
*
*/
namespace OCA\user_ldap\lib;
use OCA\user_ldap\lib\Access;
use OCA\User_LDAP\Mapping\UserMapping;
use OCA\User_LDAP\Mapping\GroupMapping;
abstract class Proxy {
static private $accesses = array();
private $ldap = null;
2015-05-08 11:27:27 +00:00
/** @var \OCP\ICache|null */
private $cache;
/**
* @param ILDAPWrapper $ldap
*/
public function __construct(ILDAPWrapper $ldap) {
$this->ldap = $ldap;
2015-05-08 11:27:27 +00:00
$memcache = \OC::$server->getMemCacheFactory();
if($memcache->isAvailable()) {
$this->cache = $memcache->create();
}
}
/**
2014-05-13 11:29:25 +00:00
* @param string $configPrefix
*/
private function addAccess($configPrefix) {
static $ocConfig;
static $fs;
static $log;
static $avatarM;
static $userMap;
static $groupMap;
2015-01-06 23:52:18 +00:00
static $db;
static $coreUserManager;
if(is_null($fs)) {
$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);
$coreUserManager = \OC::$server->getUserManager();
}
$userManager =
new user\Manager($ocConfig, $fs, $log, $avatarM, new \OCP\Image(), $db, $coreUserManager);
$connector = new Connection($this->ldap, $configPrefix);
$access = new Access($connector, $this->ldap, $userManager);
$access->setUserMapper($userMap);
$access->setGroupMapper($groupMap);
self::$accesses[$configPrefix] = $access;
}
/**
2014-05-13 11:29:25 +00:00
* @param string $configPrefix
* @return mixed
*/
protected function getAccess($configPrefix) {
if(!isset(self::$accesses[$configPrefix])) {
$this->addAccess($configPrefix);
}
return self::$accesses[$configPrefix];
}
/**
2014-05-13 11:29:25 +00:00
* @param string $uid
* @return string
*/
protected function getUserCacheKey($uid) {
return 'user-'.$uid.'-lastSeenOn';
}
/**
2014-05-13 11:29:25 +00:00
* @param string $gid
* @return string
*/
protected function getGroupCacheKey($gid) {
return 'group-'.$gid.'-lastSeenOn';
}
/**
2014-05-13 11:29:25 +00:00
* @param string $id
* @param string $method
* @param array $parameters
* @param bool $passOnWhen
* @return mixed
*/
abstract protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
/**
2014-05-13 11:29:25 +00:00
* @param string $id
* @param string $method
* @param array $parameters
* @return mixed
*/
abstract protected function walkBackends($id, $method, $parameters);
/**
* Takes care of the request to the User backend
2014-05-13 11:29:25 +00:00
* @param string $id
* @param string $method string, the method of the user backend that shall be called
* @param array $parameters an array of parameters to be passed
* @param bool $passOnWhen
* @return mixed, the result of the specified method
*/
protected function handleRequest($id, $method, $parameters, $passOnWhen = false) {
$result = $this->callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
if($result === $passOnWhen) {
$result = $this->walkBackends($id, $method, $parameters);
}
return $result;
}
/**
2014-05-13 11:29:25 +00:00
* @param string|null $key
* @return string
*/
private function getCacheKey($key) {
$prefix = 'LDAP-Proxy-';
if(is_null($key)) {
return $prefix;
}
return $prefix.md5($key);
}
/**
2014-05-13 11:29:25 +00:00
* @param string $key
* @return mixed|null
*/
public function getFromCache($key) {
2015-05-08 11:27:27 +00:00
if(is_null($this->cache) || !$this->isCached($key)) {
return null;
}
$key = $this->getCacheKey($key);
return json_decode(base64_decode($this->cache->get($key)));
}
/**
2014-05-13 11:29:25 +00:00
* @param string $key
* @return bool
*/
public function isCached($key) {
2015-05-08 11:27:27 +00:00
if(is_null($this->cache)) {
return false;
}
$key = $this->getCacheKey($key);
return $this->cache->hasKey($key);
}
/**
2014-05-13 11:29:25 +00:00
* @param string $key
* @param mixed $value
*/
public function writeToCache($key, $value) {
2015-05-08 11:27:27 +00:00
if(is_null($this->cache)) {
return;
}
$key = $this->getCacheKey($key);
$value = base64_encode(json_encode($value));
$this->cache->set($key, $value, '2592000');
}
public function clearCache() {
2015-05-08 11:27:27 +00:00
if(is_null($this->cache)) {
return;
}
$this->cache->clear($this->getCacheKey(null));
}
}