aboutsummaryrefslogtreecommitdiffstats
path: root/apps/user_ldap/lib/user/user.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/user_ldap/lib/user/user.php')
-rw-r--r--apps/user_ldap/lib/user/user.php529
1 files changed, 0 insertions, 529 deletions
diff --git a/apps/user_ldap/lib/user/user.php b/apps/user_ldap/lib/user/user.php
deleted file mode 100644
index 9bf505c5c22..00000000000
--- a/apps/user_ldap/lib/user/user.php
+++ /dev/null
@@ -1,529 +0,0 @@
-<?php
-/**
- * @author Arthur Schiwon <blizzz@owncloud.com>
- * @author Joas Schilling <nickvergessen@owncloud.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @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/>
- *
- */
-
-namespace OCA\user_ldap\lib\user;
-
-use OCA\user_ldap\lib\user\IUserTools;
-use OCA\user_ldap\lib\Connection;
-use OCA\user_ldap\lib\FilesystemHelper;
-use OCA\user_ldap\lib\LogWrapper;
-use OCP\IAvatarManager;
-use OCP\IConfig;
-use OCP\IUserManager;
-
-/**
- * User
- *
- * represents an LDAP user, gets and holds user-specific information from LDAP
- */
-class User {
- /**
- * @var IUserTools
- */
- protected $access;
- /**
- * @var Connection
- */
- protected $connection;
- /**
- * @var IConfig
- */
- protected $config;
- /**
- * @var FilesystemHelper
- */
- protected $fs;
- /**
- * @var \OCP\Image
- */
- protected $image;
- /**
- * @var LogWrapper
- */
- protected $log;
- /**
- * @var IAvatarManager
- */
- protected $avatarManager;
- /**
- * @var IUserManager
- */
- protected $userManager;
- /**
- * @var string
- */
- protected $dn;
- /**
- * @var string
- */
- protected $uid;
- /**
- * @var string[]
- */
- protected $refreshedFeatures = array();
- /**
- * @var string
- */
- protected $avatarImage;
-
- /**
- * DB config keys for user preferences
- */
- const USER_PREFKEY_FIRSTLOGIN = 'firstLoginAccomplished';
- const USER_PREFKEY_LASTREFRESH = 'lastFeatureRefresh';
-
- /**
- * @brief constructor, make sure the subclasses call this one!
- * @param string $username the internal username
- * @param string $dn the LDAP DN
- * @param IUserTools $access an instance that implements IUserTools for
- * LDAP interaction
- * @param IConfig $config
- * @param FilesystemHelper $fs
- * @param \OCP\Image $image any empty instance
- * @param LogWrapper $log
- * @param IAvatarManager $avatarManager
- * @param IUserManager $userManager
- */
- public function __construct($username, $dn, IUserTools $access,
- IConfig $config, FilesystemHelper $fs, \OCP\Image $image,
- LogWrapper $log, IAvatarManager $avatarManager, IUserManager $userManager) {
-
- $this->access = $access;
- $this->connection = $access->getConnection();
- $this->config = $config;
- $this->fs = $fs;
- $this->dn = $dn;
- $this->uid = $username;
- $this->image = $image;
- $this->log = $log;
- $this->avatarManager = $avatarManager;
- $this->userManager = $userManager;
- }
-
- /**
- * @brief updates properties like email, quota or avatar provided by LDAP
- * @return null
- */
- public function update() {
- if(is_null($this->dn)) {
- return null;
- }
-
- $hasLoggedIn = $this->config->getUserValue($this->uid, 'user_ldap',
- self::USER_PREFKEY_FIRSTLOGIN, 0);
-
- if($this->needsRefresh()) {
- $this->updateEmail();
- $this->updateQuota();
- if($hasLoggedIn !== 0) {
- //we do not need to try it, when the user has not been logged in
- //before, because the file system will not be ready.
- $this->updateAvatar();
- //in order to get an avatar as soon as possible, mark the user
- //as refreshed only when updating the avatar did happen
- $this->markRefreshTime();
- }
- }
- }
-
- /**
- * processes results from LDAP for attributes as returned by getAttributesToRead()
- * @param array $ldapEntry the user entry as retrieved from LDAP
- */
- public function processAttributes($ldapEntry) {
- $this->markRefreshTime();
- //Quota
- $attr = strtolower($this->connection->ldapQuotaAttribute);
- if(isset($ldapEntry[$attr])) {
- $this->updateQuota($ldapEntry[$attr][0]);
- }
- unset($attr);
-
- //Email
- $attr = strtolower($this->connection->ldapEmailAttribute);
- if(isset($ldapEntry[$attr])) {
- $this->updateEmail($ldapEntry[$attr][0]);
- }
- unset($attr);
-
- //displayName
- $displayName = $displayName2 = '';
- $attr = strtolower($this->connection->ldapUserDisplayName);
- if(isset($ldapEntry[$attr])) {
- $displayName = $ldapEntry[$attr][0];
- }
- $attr = strtolower($this->connection->ldapUserDisplayName2);
- if(isset($ldapEntry[$attr])) {
- $displayName2 = $ldapEntry[$attr][0];
- }
- if(!empty($displayName)) {
- $this->composeAndStoreDisplayName($displayName);
- $this->access->cacheUserDisplayName(
- $this->getUsername(),
- $displayName,
- $displayName2
- );
- }
- unset($attr);
-
- // LDAP Username, needed for s2s sharing
- if(isset($ldapEntry['uid'])) {
- $this->storeLDAPUserName($ldapEntry['uid'][0]);
- } else if(isset($ldapEntry['samaccountname'])) {
- $this->storeLDAPUserName($ldapEntry['samaccountname'][0]);
- }
-
- //homePath
- if(strpos($this->connection->homeFolderNamingRule, 'attr:') === 0) {
- $attr = strtolower(substr($this->connection->homeFolderNamingRule, strlen('attr:')));
- if(isset($ldapEntry[$attr])) {
- $this->access->cacheUserHome(
- $this->getUsername(), $this->getHomePath($ldapEntry[$attr][0]));
- }
- }
-
- //memberOf groups
- $cacheKey = 'getMemberOf'.$this->getUsername();
- $groups = false;
- if(isset($ldapEntry['memberof'])) {
- $groups = $ldapEntry['memberof'];
- }
- $this->connection->writeToCache($cacheKey, $groups);
-
- //Avatar
- $attrs = array('jpegphoto', 'thumbnailphoto');
- foreach ($attrs as $attr) {
- if(isset($ldapEntry[$attr])) {
- $this->avatarImage = $ldapEntry[$attr][0];
- // the call to the method that saves the avatar in the file
- // system must be postponed after the login. It is to ensure
- // external mounts are mounted properly (e.g. with login
- // credentials from the session).
- \OCP\Util::connectHook('OC_User', 'post_login', $this, 'updateAvatarPostLogin');
- break;
- }
- }
- }
-
- /**
- * @brief returns the LDAP DN of the user
- * @return string
- */
- public function getDN() {
- return $this->dn;
- }
-
- /**
- * @brief returns the ownCloud internal username of the user
- * @return string
- */
- public function getUsername() {
- return $this->uid;
- }
-
- /**
- * returns the home directory of the user if specified by LDAP settings
- * @param string $valueFromLDAP
- * @return bool|string
- * @throws \Exception
- */
- public function getHomePath($valueFromLDAP = null) {
- $path = $valueFromLDAP;
- $attr = null;
-
- if( is_null($path)
- && strpos($this->access->connection->homeFolderNamingRule, 'attr:') === 0
- && $this->access->connection->homeFolderNamingRule !== 'attr:')
- {
- $attr = substr($this->access->connection->homeFolderNamingRule, strlen('attr:'));
- $homedir = $this->access->readAttribute(
- $this->access->username2dn($this->getUsername()), $attr);
- if ($homedir && isset($homedir[0])) {
- $path = $homedir[0];
- }
- }
-
- if(!empty($path)) {
- //if attribute's value is an absolute path take this, otherwise append it to data dir
- //check for / at the beginning or pattern c:\ resp. c:/
- if( '/' !== $path[0]
- && !(3 < strlen($path) && ctype_alpha($path[0])
- && $path[1] === ':' && ('\\' === $path[2] || '/' === $path[2]))
- ) {
- $path = $this->config->getSystemValue('datadirectory',
- \OC::$SERVERROOT.'/data' ) . '/' . $path;
- }
- //we need it to store it in the DB as well in case a user gets
- //deleted so we can clean up afterwards
- $this->config->setUserValue(
- $this->getUsername(), 'user_ldap', 'homePath', $path
- );
- return $path;
- }
-
- if( !is_null($attr)
- && $this->config->getAppValue('user_ldap', 'enforce_home_folder_naming_rule', true)
- ) {
- // a naming rule attribute is defined, but it doesn't exist for that LDAP user
- throw new \Exception('Home dir attribute can\'t be read from LDAP for uid: ' . $this->getUsername());
- }
-
- //false will apply default behaviour as defined and done by OC_User
- $this->config->setUserValue($this->getUsername(), 'user_ldap', 'homePath', '');
- return false;
- }
-
- public function getMemberOfGroups() {
- $cacheKey = 'getMemberOf'.$this->getUsername();
- if($this->connection->isCached($cacheKey)) {
- return $this->connection->getFromCache($cacheKey);
- }
- $groupDNs = $this->access->readAttribute($this->getDN(), 'memberOf');
- $this->connection->writeToCache($cacheKey, $groupDNs);
- return $groupDNs;
- }
-
- /**
- * @brief reads the image from LDAP that shall be used as Avatar
- * @return string data (provided by LDAP) | false
- */
- public function getAvatarImage() {
- if(!is_null($this->avatarImage)) {
- return $this->avatarImage;
- }
-
- $this->avatarImage = false;
- $attributes = array('jpegPhoto', 'thumbnailPhoto');
- foreach($attributes as $attribute) {
- $result = $this->access->readAttribute($this->dn, $attribute);
- if($result !== false && is_array($result) && isset($result[0])) {
- $this->avatarImage = $result[0];
- break;
- }
- }
-
- return $this->avatarImage;
- }
-
- /**
- * @brief marks the user as having logged in at least once
- * @return null
- */
- public function markLogin() {
- $this->config->setUserValue(
- $this->uid, 'user_ldap', self::USER_PREFKEY_FIRSTLOGIN, 1);
- }
-
- /**
- * @brief marks the time when user features like email have been updated
- * @return null
- */
- public function markRefreshTime() {
- $this->config->setUserValue(
- $this->uid, 'user_ldap', self::USER_PREFKEY_LASTREFRESH, time());
- }
-
- /**
- * @brief checks whether user features needs to be updated again by
- * comparing the difference of time of the last refresh to now with the
- * desired interval
- * @return bool
- */
- private function needsRefresh() {
- $lastChecked = $this->config->getUserValue($this->uid, 'user_ldap',
- self::USER_PREFKEY_LASTREFRESH, 0);
-
- //TODO make interval configurable
- if((time() - intval($lastChecked)) < 86400 ) {
- return false;
- }
- return true;
- }
-
- /**
- * Stores a key-value pair in relation to this user
- *
- * @param string $key
- * @param string $value
- */
- private function store($key, $value) {
- $this->config->setUserValue($this->uid, 'user_ldap', $key, $value);
- }
-
- /**
- * Composes the display name and stores it in the database. The final
- * display name is returned.
- *
- * @param string $displayName
- * @param string $displayName2
- * @returns string the effective display name
- */
- public function composeAndStoreDisplayName($displayName, $displayName2 = '') {
- if(!empty($displayName2)) {
- $displayName .= ' (' . $displayName2 . ')';
- }
- $this->store('displayName', $displayName);
- return $displayName;
- }
-
- /**
- * Stores the LDAP Username in the Database
- * @param string $userName
- */
- public function storeLDAPUserName($userName) {
- $this->store('uid', $userName);
- }
-
- /**
- * @brief checks whether an update method specified by feature was run
- * already. If not, it will marked like this, because it is expected that
- * the method will be run, when false is returned.
- * @param string $feature email | quota | avatar (can be extended)
- * @return bool
- */
- private function wasRefreshed($feature) {
- if(isset($this->refreshedFeatures[$feature])) {
- return true;
- }
- $this->refreshedFeatures[$feature] = 1;
- return false;
- }
-
- /**
- * fetches the email from LDAP and stores it as ownCloud user value
- * @param string $valueFromLDAP if known, to save an LDAP read request
- * @return null
- */
- public function updateEmail($valueFromLDAP = null) {
- if($this->wasRefreshed('email')) {
- return;
- }
- $email = $valueFromLDAP;
- if(is_null($valueFromLDAP)) {
- $emailAttribute = $this->connection->ldapEmailAttribute;
- if(!empty($emailAttribute)) {
- $aEmail = $this->access->readAttribute($this->dn, $emailAttribute);
- if(is_array($aEmail) && (count($aEmail) > 0)) {
- $email = $aEmail[0];
- }
- }
- }
- if(!is_null($email)) {
- $user = $this->userManager->get($this->uid);
- $user->setEMailAddress($email);
- }
- }
-
- /**
- * fetches the quota from LDAP and stores it as ownCloud user value
- * @param string $valueFromLDAP the quota attribute's value can be passed,
- * to save the readAttribute request
- * @return null
- */
- public function updateQuota($valueFromLDAP = null) {
- if($this->wasRefreshed('quota')) {
- return;
- }
- //can be null
- $quotaDefault = $this->connection->ldapQuotaDefault;
- $quota = $quotaDefault !== '' ? $quotaDefault : null;
- $quota = !is_null($valueFromLDAP) ? $valueFromLDAP : $quota;
-
- if(is_null($valueFromLDAP)) {
- $quotaAttribute = $this->connection->ldapQuotaAttribute;
- if(!empty($quotaAttribute)) {
- $aQuota = $this->access->readAttribute($this->dn, $quotaAttribute);
- if($aQuota && (count($aQuota) > 0)) {
- $quota = $aQuota[0];
- }
- }
- }
- if(!is_null($quota)) {
- $user = $this->userManager->get($this->uid)->setQuota($quota);
- }
- }
-
- /**
- * called by a post_login hook to save the avatar picture
- *
- * @param array $params
- */
- public function updateAvatarPostLogin($params) {
- if(isset($params['uid']) && $params['uid'] === $this->getUsername()) {
- $this->updateAvatar();
- }
- }
-
- /**
- * @brief attempts to get an image from LDAP and sets it as ownCloud avatar
- * @return null
- */
- public function updateAvatar() {
- if($this->wasRefreshed('avatar')) {
- return;
- }
- $avatarImage = $this->getAvatarImage();
- if($avatarImage === false) {
- //not set, nothing left to do;
- return;
- }
- $this->image->loadFromBase64(base64_encode($avatarImage));
- $this->setOwnCloudAvatar();
- }
-
- /**
- * @brief sets an image as ownCloud avatar
- * @return null
- */
- private function setOwnCloudAvatar() {
- if(!$this->image->valid()) {
- $this->log->log('user_ldap', 'jpegPhoto data invalid for '.$this->dn,
- \OCP\Util::ERROR);
- return;
- }
- //make sure it is a square and not bigger than 128x128
- $size = min(array($this->image->width(), $this->image->height(), 128));
- if(!$this->image->centerCrop($size)) {
- $this->log->log('user_ldap',
- 'croping image for avatar failed for '.$this->dn,
- \OCP\Util::ERROR);
- return;
- }
-
- if(!$this->fs->isLoaded()) {
- $this->fs->setup($this->uid);
- }
-
- try {
- $avatar = $this->avatarManager->getAvatar($this->uid);
- $avatar->set($this->image);
- } catch (\Exception $e) {
- \OC::$server->getLogger()->notice(
- 'Could not set avatar for ' . $this->dn . ', because: ' . $e->getMessage(),
- ['app' => 'user_ldap']);
- }
- }
-
-}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 21:57:47 +0000