org.opencms.db.generic.CmsUserDriver Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.db.generic;
import org.opencms.configuration.CmsConfigurationManager;
import org.opencms.configuration.CmsParameterConfiguration;
import org.opencms.db.CmsDbContext;
import org.opencms.db.CmsDbEntryAlreadyExistsException;
import org.opencms.db.CmsDbEntryNotFoundException;
import org.opencms.db.CmsDbIoException;
import org.opencms.db.CmsDbSqlException;
import org.opencms.db.CmsDbUtil;
import org.opencms.db.CmsDriverManager;
import org.opencms.db.CmsUserSettings;
import org.opencms.db.CmsVisitEntryFilter;
import org.opencms.db.I_CmsProjectDriver;
import org.opencms.db.I_CmsUserDriver;
import org.opencms.file.CmsDataAccessException;
import org.opencms.file.CmsFolder;
import org.opencms.file.CmsGroup;
import org.opencms.file.CmsProject;
import org.opencms.file.CmsProperty;
import org.opencms.file.CmsPropertyDefinition;
import org.opencms.file.CmsResource;
import org.opencms.file.CmsResourceFilter;
import org.opencms.file.CmsUser;
import org.opencms.file.CmsUserSearchParameters;
import org.opencms.file.CmsVfsResourceNotFoundException;
import org.opencms.file.types.CmsResourceTypeFolder;
import org.opencms.i18n.CmsEncoder;
import org.opencms.i18n.CmsLocaleManager;
import org.opencms.i18n.CmsMessageContainer;
import org.opencms.main.CmsEvent;
import org.opencms.main.CmsException;
import org.opencms.main.CmsInitException;
import org.opencms.main.CmsLog;
import org.opencms.main.I_CmsEventListener;
import org.opencms.main.OpenCms;
import org.opencms.monitor.CmsMemoryMonitor;
import org.opencms.relations.CmsRelation;
import org.opencms.relations.CmsRelationFilter;
import org.opencms.relations.CmsRelationType;
import org.opencms.security.CmsAccessControlEntry;
import org.opencms.security.CmsOrganizationalUnit;
import org.opencms.security.CmsPasswordEncryptionException;
import org.opencms.security.CmsRole;
import org.opencms.security.I_CmsPrincipal;
import org.opencms.util.CmsDataTypeUtil;
import org.opencms.util.CmsMacroResolver;
import org.opencms.util.CmsPair;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsUUID;
import java.io.IOException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.concurrent.locks.Lock;
import org.apache.commons.logging.Log;
import com.google.common.util.concurrent.Striped;
/**
* Generic (ANSI-SQL) database server implementation of the user driver methods.
*
* @since 6.0.0
*/
public class CmsUserDriver implements I_CmsUserDriver {
/** The root path for organizational units. */
public static final String ORGUNIT_BASE_FOLDER = "/system/orgunits/";
/** The internal request attribute to indicate that the password has not to be digested. */
public static final String REQ_ATTR_DONT_DIGEST_PASSWORD = "DONT_DIGEST_PASSWORD";
// TODO: remove all these constants
/** Attribute WRITE USER_ADDINFO. */
private static final String ATTRIBUTE_USERADDINFO = "A_USERADDINFO";
/** Attribute WRITE USER_ADDINFO value delete. */
private static final String ATTRIBUTE_USERADDINFO_VALUE_DELETE = "delete";
/** Attribute WRITE USER_ADDINFO value insert. */
private static final String ATTRIBUTE_USERADDINFO_VALUE_INSERT = "insert";
/** Attribute WRITE USER_ADDINFO value update. */
private static final String ATTRIBUTE_USERADDINFO_VALUE_UPDATE = "update";
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(org.opencms.db.generic.CmsUserDriver.class);
/** The name of the offline project. */
private static final String OFFLINE_PROJECT_NAME = "Offline";
/** Property for the organizational unit description. */
private static final String ORGUNIT_PROPERTY_DESCRIPTION = CmsPropertyDefinition.PROPERTY_DESCRIPTION;
/** Property for the organizational unit default project id. */
private static final String ORGUNIT_PROPERTY_PROJECTID = CmsPropertyDefinition.PROPERTY_KEYWORDS;
/** Striped lock used to synchronize writing of additional infos for users. */
private static Striped USER_INFO_LOCKS = Striped.lock(16);
/** A digest to encrypt the passwords. */
protected MessageDigest m_digest;
/** The algorithm used to encode passwords. */
protected String m_digestAlgorithm;
/** The file.encoding to code passwords after encryption with digest. */
protected String m_digestFileEncoding;
/** The driver manager. */
protected CmsDriverManager m_driverManager;
/** The SQL manager. */
protected CmsSqlManager m_sqlManager;
/**
* @see org.opencms.db.I_CmsUserDriver#addResourceToOrganizationalUnit(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, org.opencms.file.CmsResource)
*/
public void addResourceToOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsResource resource)
throws CmsDataAccessException {
try {
// check if the resource is a folder
if (resource.isFile()) {
throw new CmsDataAccessException(
Messages.get().container(
Messages.ERR_ORGUNIT_RESOURCE_IS_NOT_FOLDER_2,
orgUnit.getName(),
dbc.removeSiteRoot(resource.getRootPath())));
}
// read the resource representing the organizational unit
CmsResource ouResource = m_driverManager.readResource(
dbc,
ORGUNIT_BASE_FOLDER + orgUnit.getName(),
CmsResourceFilter.ALL);
// get the associated resources
List vfsPaths = new ArrayList(internalResourcesForOrgUnit(dbc, ouResource));
// check resource scope for non root ous
if (orgUnit.getParentFqn() != null) {
// get the parent ou
CmsOrganizationalUnit parentOu = m_driverManager.readOrganizationalUnit(dbc, orgUnit.getParentFqn());
// validate
internalValidateResourceForOrgUnit(dbc, parentOu, resource.getRootPath());
} else {
// allow to set the first resource
if (!vfsPaths.isEmpty()) {
throw new CmsDataAccessException(
org.opencms.security.Messages.get().container(
org.opencms.security.Messages.ERR_ORGUNIT_ROOT_EDITION_0));
}
}
// add the new resource
CmsRelation relation = new CmsRelation(ouResource, resource, CmsRelationType.OU_RESOURCE);
m_driverManager.getVfsDriver(dbc).createRelation(dbc, dbc.currentProject().getUuid(), relation);
m_driverManager.getVfsDriver(dbc).createRelation(dbc, CmsProject.ONLINE_PROJECT_ID, relation);
try {
// be sure the project was not deleted
CmsProject project = m_driverManager.readProject(dbc, orgUnit.getProjectId());
// maintain the default project synchronized
m_driverManager.getProjectDriver(dbc).createProjectResource(
dbc,
orgUnit.getProjectId(),
resource.getRootPath());
OpenCms.fireCmsEvent(
I_CmsEventListener.EVENT_PROJECT_MODIFIED,
Collections. singletonMap("project", project));
} catch (CmsDbEntryNotFoundException e) {
// ignore
} finally {
// fire a resource modification event
Map data = new HashMap(2);
data.put(I_CmsEventListener.KEY_RESOURCE, ouResource);
data.put(I_CmsEventListener.KEY_CHANGE, new Integer(CmsDriverManager.CHANGED_RESOURCE));
OpenCms.fireCmsEvent(new CmsEvent(I_CmsEventListener.EVENT_RESOURCE_MODIFIED, data));
}
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#countUsers(org.opencms.db.CmsDbContext, org.opencms.file.CmsUserSearchParameters)
*/
public long countUsers(CmsDbContext dbc, CmsUserSearchParameters searchParams) throws CmsDataAccessException {
CmsPair> queryAndParams = createUserQuery(searchParams, true);
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatementForSql(conn, queryAndParams.getFirst());
CmsDbUtil.fillParameters(stmt, queryAndParams.getSecond());
res = stmt.executeQuery();
long result = 0;
while (res.next()) {
result = res.getLong(1);
}
return result;
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#createAccessControlEntry(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, int, int, int)
*/
public void createAccessControlEntry(
CmsDbContext dbc,
CmsProject project,
CmsUUID resource,
CmsUUID principal,
int allowed,
int denied,
int flags) throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_CREATE_5");
stmt.setString(1, resource.toString());
stmt.setString(2, principal.toString());
stmt.setInt(3, allowed);
stmt.setInt(4, denied);
stmt.setInt(5, flags);
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#createGroup(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, int, java.lang.String)
*/
public CmsGroup createGroup(
CmsDbContext dbc,
CmsUUID groupId,
String groupFqn,
String description,
int flags,
String parentGroupFqn) throws CmsDataAccessException {
CmsUUID parentId = CmsUUID.getNullUUID();
CmsGroup group = null;
Connection conn = null;
PreparedStatement stmt = null;
if (existsGroup(dbc, groupFqn)) {
CmsMessageContainer message = Messages.get().container(
Messages.ERR_GROUP_WITH_NAME_ALREADY_EXISTS_1,
groupFqn);
if (LOG.isErrorEnabled()) {
LOG.error(message.key());
}
throw new CmsDbEntryAlreadyExistsException(message);
}
try {
// get the id of the parent group if necessary
if (CmsStringUtil.isNotEmpty(parentGroupFqn)) {
parentId = readGroup(dbc, parentGroupFqn).getId();
}
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_CREATE_GROUP_6");
// write new group to the database
stmt.setString(1, groupId.toString());
stmt.setString(2, parentId.toString());
stmt.setString(3, CmsOrganizationalUnit.getSimpleName(groupFqn));
stmt.setString(4, m_sqlManager.validateEmpty(description));
stmt.setInt(5, flags);
stmt.setString(6, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn));
stmt.executeUpdate();
group = new CmsGroup(groupId, parentId, groupFqn, description, flags);
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
return group;
}
/**
* @see org.opencms.db.I_CmsUserDriver#createOrganizationalUnit(org.opencms.db.CmsDbContext, java.lang.String, java.lang.String, int, org.opencms.security.CmsOrganizationalUnit, String)
*/
public CmsOrganizationalUnit createOrganizationalUnit(
CmsDbContext dbc,
String name,
String description,
int flags,
CmsOrganizationalUnit parent,
String associatedResource) throws CmsDataAccessException {
// check the parent
if ((parent == null) && !name.equals("")) {
throw new CmsDataAccessException(
org.opencms.db.Messages.get().container(org.opencms.db.Messages.ERR_PARENT_ORGUNIT_NULL_0));
}
try {
// get the parent ou folder
CmsResource parentFolder = internalOrgUnitFolder(dbc, parent);
CmsResource resource = null;
// only normal OUs have to have at least one resource
if (((flags & CmsOrganizationalUnit.FLAG_WEBUSERS) == 0) || (associatedResource != null)) {
// check that the associated resource exists and if is a folder
resource = m_driverManager.readFolder(dbc, associatedResource, CmsResourceFilter.ALL);
}
String ouPath = ORGUNIT_BASE_FOLDER;
// validate resource
if ((parentFolder != null) && (resource != null)) {
internalValidateResourceForOrgUnit(
dbc,
internalCreateOrgUnitFromResource(dbc, parentFolder),
resource.getRootPath());
}
if (parentFolder != null) {
ouPath = parentFolder.getRootPath();
if (!ouPath.endsWith("/")) {
ouPath += "/";
}
}
// create the resource
CmsResource ouFolder = internalCreateResourceForOrgUnit(dbc, ouPath + name, flags);
// write description property
internalWriteOrgUnitProperty(
dbc,
ouFolder,
new CmsProperty(ORGUNIT_PROPERTY_DESCRIPTION, description, null));
// create the ou object
CmsOrganizationalUnit ou = internalCreateOrgUnitFromResource(dbc, ouFolder);
if ((ou.getParentFqn() != null)) {
// if not the root ou, create default roles & groups
// for the root ou, are created in #fillDefaults
Locale locale = CmsLocaleManager.getDefaultLocale();
if (dbc.getRequestContext() != null) {
locale = dbc.getRequestContext().getLocale();
}
// create default groups
internalCreateDefaultGroups(dbc, ou.getName(), ou.getDisplayName(locale), ou.hasFlagWebuser());
if (!ou.hasFlagWebuser()) {
// create default project
CmsProject project = m_driverManager.createProject(
dbc,
ou.getName() + OFFLINE_PROJECT_NAME,
"",
ou.getName() + OpenCms.getDefaultUsers().getGroupUsers(),
ou.getName() + OpenCms.getDefaultUsers().getGroupUsers(),
CmsProject.PROJECT_TYPE_NORMAL);
// write project id property
internalWriteOrgUnitProperty(
dbc,
ouFolder,
new CmsProperty(ORGUNIT_PROPERTY_PROJECTID, project.getUuid().toString(), null));
} else {
// write project id property
internalWriteOrgUnitProperty(
dbc,
ouFolder,
new CmsProperty(ORGUNIT_PROPERTY_PROJECTID, CmsUUID.getNullUUID().toString(), null));
}
} else {
// write project id property
internalWriteOrgUnitProperty(
dbc,
ouFolder,
new CmsProperty(ORGUNIT_PROPERTY_PROJECTID, CmsUUID.getNullUUID().toString(), null));
}
// reread the ou, to actualize the project id
ou = internalCreateOrgUnitFromResource(dbc, ouFolder);
if (resource != null) {
// add the given resource
m_driverManager.addResourceToOrgUnit(dbc, ou, resource);
}
OpenCms.fireCmsEvent(I_CmsEventListener.EVENT_CLEAR_ONLINE_CACHES, null);
// return the new created ou
return ou;
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#createRootOrganizationalUnit(org.opencms.db.CmsDbContext)
*/
public void createRootOrganizationalUnit(CmsDbContext dbc) {
try {
readOrganizationalUnit(dbc, "");
} catch (CmsException e) {
try {
CmsProject onlineProject = dbc.currentProject();
CmsProject setupProject = onlineProject;
// get the right offline project
try {
// this if setting up OpenCms
setupProject = m_driverManager.readProject(dbc, I_CmsProjectDriver.SETUP_PROJECT_NAME);
} catch (CmsException exc) {
// this if updating OpenCms
try {
setupProject = m_driverManager.readProject(dbc, "Offline");
} catch (CmsException exc2) {
// there is nothing to do, if no offline project found
}
}
dbc.getRequestContext().setCurrentProject(setupProject);
try {
createOrganizationalUnit(
dbc,
"",
CmsMacroResolver.localizedKeyMacro(Messages.GUI_ORGUNIT_ROOT_DESCRIPTION_0, null),
0,
null,
"/");
} finally {
dbc.getRequestContext().setCurrentProject(onlineProject);
}
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_ROOT_ORGUNIT_DEFAULTS_INITIALIZED_0));
}
} catch (CmsException exc) {
if (CmsLog.INIT.isErrorEnabled()) {
CmsLog.INIT.error(
Messages.get().getBundle().key(Messages.INIT_ROOT_ORGUNIT_INITIALIZATION_FAILED_0),
exc);
}
throw new CmsInitException(Messages.get().container(Messages.ERR_INITIALIZING_USER_DRIVER_0), exc);
}
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#createUser(CmsDbContext, CmsUUID, String, String, String, String, String, long, int, long, Map)
*/
public CmsUser createUser(
CmsDbContext dbc,
CmsUUID id,
String userFqn,
String password,
String firstname,
String lastname,
String email,
long lastlogin,
int flags,
long dateCreated,
Map additionalInfos) throws CmsDataAccessException {
Connection conn = null;
PreparedStatement stmt = null;
if (existsUser(dbc, userFqn)) {
CmsMessageContainer message = Messages.get().container(
Messages.ERR_USER_WITH_NAME_ALREADY_EXISTS_1,
userFqn);
if (LOG.isErrorEnabled()) {
LOG.error(message.key());
}
throw new CmsDbEntryAlreadyExistsException(message);
}
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_ADD_10");
stmt.setString(1, id.toString());
stmt.setString(2, CmsOrganizationalUnit.getSimpleName(userFqn));
stmt.setString(3, password);
stmt.setString(4, m_sqlManager.validateEmpty(firstname));
stmt.setString(5, m_sqlManager.validateEmpty(lastname));
stmt.setString(6, m_sqlManager.validateEmpty(email));
stmt.setLong(7, lastlogin);
stmt.setInt(8, flags);
stmt.setString(9, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn));
stmt.setLong(10, (dateCreated == 0 ? System.currentTimeMillis() : dateCreated));
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
internalWriteUserInfos(dbc, id, additionalInfos);
return readUser(dbc, id);
}
/**
* @see org.opencms.db.I_CmsUserDriver#createUserInGroup(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
*/
public void createUserInGroup(CmsDbContext dbc, CmsUUID userId, CmsUUID groupId) throws CmsDataAccessException {
Connection conn = null;
PreparedStatement stmt = null;
// check if user is already in group
if (!internalValidateUserInGroup(dbc, userId, groupId)) {
// if not, add this user to the group
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_ADD_USER_TO_GROUP_3");
// write the new assignment to the database
stmt.setString(1, groupId.toString());
stmt.setString(2, userId.toString());
// flag field is not used yet
stmt.setInt(3, 0);
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#deleteGroup(org.opencms.db.CmsDbContext, java.lang.String)
*/
public void deleteGroup(CmsDbContext dbc, String groupFqn) throws CmsDataAccessException {
Connection conn = null;
PreparedStatement stmt = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_DELETE_GROUP_2");
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(groupFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn));
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#deleteOrganizationalUnit(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit)
*/
public void deleteOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit organizationalUnit)
throws CmsDataAccessException {
try {
CmsResource resource = m_driverManager.readResource(
dbc,
ORGUNIT_BASE_FOLDER + organizationalUnit.getName(),
CmsResourceFilter.DEFAULT);
internalDeleteOrgUnitResource(dbc, resource);
if (organizationalUnit.getProjectId() != null) {
try {
// maintain the default project synchronized
m_driverManager.deleteProject(
dbc,
m_driverManager.readProject(dbc, organizationalUnit.getProjectId()),
false);
} catch (CmsDbEntryNotFoundException e) {
// ignore
}
}
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#deleteUser(org.opencms.db.CmsDbContext, java.lang.String)
*/
public void deleteUser(CmsDbContext dbc, String userFqn) throws CmsDataAccessException {
CmsUser user = readUser(dbc, userFqn);
Connection conn = null;
PreparedStatement stmt = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_DELETE_2");
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(userFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn));
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
// delete the additional infos
deleteUserInfos(dbc, user.getId());
if (OpenCms.getSubscriptionManager().isEnabled()) {
// delete visited resource information from log
CmsVisitEntryFilter filter = CmsVisitEntryFilter.ALL.filterUser(user.getId());
m_driverManager.getSubscriptionDriver().deleteVisits(
dbc,
OpenCms.getSubscriptionManager().getPoolName(),
filter);
// delete all subscribed resources for user
m_driverManager.getSubscriptionDriver().unsubscribeAllResourcesFor(
dbc,
OpenCms.getSubscriptionManager().getPoolName(),
user);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#deleteUserInfos(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID)
*/
public void deleteUserInfos(CmsDbContext dbc, CmsUUID userId) throws CmsDataAccessException {
Connection conn = null;
PreparedStatement stmt = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERDATA_DELETE_1");
stmt.setString(1, userId.toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#deleteUserInGroup(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
*/
public void deleteUserInGroup(CmsDbContext dbc, CmsUUID userId, CmsUUID groupId) throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_REMOVE_USER_FROM_GROUP_2");
stmt.setString(1, groupId.toString());
stmt.setString(2, userId.toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#destroy()
*/
public void destroy() throws Throwable {
m_sqlManager = null;
m_driverManager = null;
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_SHUTDOWN_DRIVER_1, getClass().getName()));
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#existsGroup(org.opencms.db.CmsDbContext, java.lang.String)
*/
public boolean existsGroup(CmsDbContext dbc, String groupFqn) throws CmsDataAccessException {
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
boolean result = false;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_READ_BY_NAME_2");
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(groupFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn));
res = stmt.executeQuery();
// create new Cms group object
if (res.next()) {
result = true;
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
} else {
result = false;
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return result;
}
/**
* @see org.opencms.db.I_CmsUserDriver#existsUser(org.opencms.db.CmsDbContext, java.lang.String)
*/
public boolean existsUser(CmsDbContext dbc, String userFqn) throws CmsDataAccessException {
PreparedStatement stmt = null;
ResultSet res = null;
Connection conn = null;
boolean result = false;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_READ_BY_NAME_2");
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(userFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn));
res = stmt.executeQuery();
if (res.next()) {
result = true;
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
} else {
result = false;
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return result;
}
/**
* @see org.opencms.db.I_CmsUserDriver#fillDefaults(org.opencms.db.CmsDbContext)
*/
public void fillDefaults(CmsDbContext dbc) throws CmsInitException {
try {
CmsOrganizationalUnit ou = (CmsOrganizationalUnit)(dbc.getAttribute(CmsDriverManager.ATTR_INIT_OU));
if (ou == null) {
internalCreateDefaultGroups(dbc, "", "", false);
} else {
internalCreateDefaultGroups(dbc, ou.getName(), ou.getDescription(), ou.hasFlagWebuser());
}
} catch (CmsException e) {
if (CmsLog.INIT.isErrorEnabled()) {
CmsLog.INIT.error(Messages.get().getBundle().key(Messages.INIT_DEFAULT_USERS_CREATION_FAILED_0), e);
}
throw new CmsInitException(Messages.get().container(Messages.ERR_INITIALIZING_USER_DRIVER_0), e);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#getGroups(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, boolean, boolean)
*/
public List getGroups(
CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean includeSubOus,
boolean readRoles) throws CmsDataAccessException {
// compose the query
String sqlQuery = createRoleQuery("C_GROUPS_GET_GROUPS_0", includeSubOus, readRoles);
// adjust parameter to use with LIKE
String ouFqn = CmsOrganizationalUnit.SEPARATOR + orgUnit.getName();
if (includeSubOus) {
ouFqn += "%";
}
// execute it
List groups = new ArrayList();
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
// create statement
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatementForSql(conn, sqlQuery);
stmt.setString(1, ouFqn);
stmt.setInt(2, I_CmsPrincipal.FLAG_GROUP_ROLE);
res = stmt.executeQuery();
// create new Cms group objects
while (res.next()) {
groups.add(internalCreateGroup(res));
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return groups;
}
/**
* @see org.opencms.db.I_CmsUserDriver#getOrganizationalUnits(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, boolean)
*/
public List getOrganizationalUnits(
CmsDbContext dbc,
CmsOrganizationalUnit parent,
boolean includeChildren) throws CmsDataAccessException {
List orgUnits = new ArrayList();
try {
CmsResource parentFolder = internalOrgUnitFolder(dbc, parent);
Iterator itResources = m_driverManager.readResources(
dbc,
parentFolder,
CmsResourceFilter.DEFAULT,
includeChildren).iterator();
while (itResources.hasNext()) {
CmsResource resource = itResources.next();
orgUnits.add(internalCreateOrgUnitFromResource(dbc, resource));
}
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
return orgUnits;
}
/**
* @see org.opencms.db.I_CmsUserDriver#getResourcesForOrganizationalUnit(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit)
*/
public List getResourcesForOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit)
throws CmsDataAccessException {
List result = new ArrayList();
try {
CmsResource ouResource = m_driverManager.readResource(
dbc,
ORGUNIT_BASE_FOLDER + orgUnit.getName(),
CmsResourceFilter.ALL);
Iterator itPaths = internalResourcesForOrgUnit(dbc, ouResource).iterator();
while (itPaths.hasNext()) {
String path = itPaths.next();
try {
result.add(m_driverManager.readResource(dbc, path, CmsResourceFilter.ALL));
} catch (CmsVfsResourceNotFoundException e) {
LOG.error(e.getLocalizedMessage(), e);
}
}
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
return result;
}
/**
* @see org.opencms.db.I_CmsUserDriver#getSqlManager()
*/
public CmsSqlManager getSqlManager() {
return m_sqlManager;
}
/**
* @see org.opencms.db.I_CmsUserDriver#getUsers(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, boolean)
*/
public List getUsers(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, boolean recursive)
throws CmsDataAccessException {
return internalGetUsers(dbc, orgUnit, recursive, true);
}
/**
* @see org.opencms.db.I_CmsUserDriver#getUsersWithoutAdditionalInfo(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, boolean)
*/
public List getUsersWithoutAdditionalInfo(
CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean recursive) throws CmsDataAccessException {
return internalGetUsers(dbc, orgUnit, recursive, false);
}
/**
* @see org.opencms.db.I_CmsDriver#init(org.opencms.db.CmsDbContext, org.opencms.configuration.CmsConfigurationManager, java.util.List, org.opencms.db.CmsDriverManager)
*/
public void init(
CmsDbContext dbc,
CmsConfigurationManager configurationManager,
List successiveDrivers,
CmsDriverManager driverManager) {
CmsParameterConfiguration config = configurationManager.getConfiguration();
String poolUrl = config.get("db.user.pool");
String classname = config.get("db.user.sqlmanager");
m_sqlManager = initSqlManager(classname);
m_sqlManager.init(I_CmsUserDriver.DRIVER_TYPE_ID, poolUrl);
m_driverManager = driverManager;
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_ASSIGNED_POOL_1, poolUrl));
}
m_digestAlgorithm = config.getString(CmsDriverManager.CONFIGURATION_DB + ".user.digest.type", "MD5");
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_DIGEST_ALGORITHM_1, m_digestAlgorithm));
}
m_digestFileEncoding = config.getString(
CmsDriverManager.CONFIGURATION_DB + ".user.digest.encoding",
CmsEncoder.ENCODING_UTF_8);
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_DIGEST_ENCODING_1, m_digestFileEncoding));
}
// create the digest
try {
m_digest = MessageDigest.getInstance(m_digestAlgorithm);
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(
Messages.get().getBundle().key(
Messages.INIT_DIGEST_ENC_3,
m_digest.getAlgorithm(),
m_digest.getProvider().getName(),
String.valueOf(m_digest.getProvider().getVersion())));
}
} catch (NoSuchAlgorithmException e) {
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_SET_DIGEST_ERROR_0), e);
}
}
if ((successiveDrivers != null) && !successiveDrivers.isEmpty()) {
if (LOG.isWarnEnabled()) {
LOG.warn(
Messages.get().getBundle().key(
Messages.LOG_SUCCESSIVE_DRIVERS_UNSUPPORTED_1,
getClass().getName()));
}
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#initSqlManager(String)
*/
public org.opencms.db.generic.CmsSqlManager initSqlManager(String classname) {
return CmsSqlManager.getInstance(classname);
}
/**
* @see org.opencms.db.I_CmsUserDriver#publishAccessControlEntries(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsProject, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
*/
public void publishAccessControlEntries(
CmsDbContext dbc,
CmsProject offlineProject,
CmsProject onlineProject,
CmsUUID offlineId,
CmsUUID onlineId) throws CmsDataAccessException {
// at first, we remove all access contries of this resource in the online project
m_driverManager.getUserDriver(dbc).removeAccessControlEntries(dbc, onlineProject, onlineId);
// then, we copy the access control entries from the offline project into the online project
CmsUUID dbcProjectId = dbc.getProjectId();
if ((dbcProjectId != null) && !dbc.getProjectId().isNullUUID()) {
dbc.setProjectId(offlineProject.getUuid());
} else {
dbc.setProjectId(CmsUUID.getNullUUID());
}
List aces = m_driverManager.getUserDriver(dbc).readAccessControlEntries(
dbc,
offlineProject,
offlineId,
false);
dbc.setProjectId(dbcProjectId);
for (CmsAccessControlEntry ace : aces) {
m_driverManager.getUserDriver(dbc).writeAccessControlEntry(dbc, onlineProject, ace);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#readAccessControlEntries(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.util.CmsUUID, boolean)
*/
public List readAccessControlEntries(
CmsDbContext dbc,
CmsProject project,
CmsUUID resource,
boolean inheritedOnly) throws CmsDataAccessException {
List aceList = new ArrayList();
PreparedStatement stmt = null;
Connection conn = null;
ResultSet res = null;
try {
conn = m_sqlManager.getConnection(dbc);
if (resource.equals(CmsAccessControlEntry.PRINCIPAL_READALL_ID)) {
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_READ_ENTRIES_0");
} else {
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_READ_ENTRIES_1");
String resId = resource.toString();
stmt.setString(1, resId);
}
res = stmt.executeQuery();
// create new CmsAccessControlEntry and add to list
while (res.next()) {
CmsAccessControlEntry ace = internalCreateAce(res);
if (inheritedOnly && !ace.isInheriting()) {
continue;
}
if (inheritedOnly && ace.isInheriting()) {
ace.setFlags(CmsAccessControlEntry.ACCESS_FLAGS_INHERITED);
}
aceList.add(ace);
}
return aceList;
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#readAccessControlEntry(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
*/
public CmsAccessControlEntry readAccessControlEntry(
CmsDbContext dbc,
CmsProject project,
CmsUUID resource,
CmsUUID principal) throws CmsDataAccessException {
CmsAccessControlEntry ace = null;
PreparedStatement stmt = null;
Connection conn = null;
ResultSet res = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_READ_ENTRY_2");
stmt.setString(1, resource.toString());
stmt.setString(2, principal.toString());
res = stmt.executeQuery();
// create new CmsAccessControlEntry
if (res.next()) {
ace = internalCreateAce(res);
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
} else {
res.close();
res = null;
throw new CmsDbEntryNotFoundException(
Messages.get().container(Messages.ERR_NO_ACE_FOUND_2, resource, principal));
}
return ace;
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#readChildGroups(org.opencms.db.CmsDbContext, java.lang.String)
*/
public List readChildGroups(CmsDbContext dbc, String parentGroupFqn) throws CmsDataAccessException {
List children = new ArrayList();
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
// get parent group
CmsGroup parent = m_driverManager.getUserDriver(dbc).readGroup(dbc, parentGroupFqn);
// parent group exists, so get all children
if (parent != null) {
// create statement
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_GET_CHILD_1");
stmt.setString(1, parent.getId().toString());
res = stmt.executeQuery();
// create new Cms group objects
while (res.next()) {
children.add(internalCreateGroup(res));
}
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
// close all db-resources
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return children;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readGroup(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID)
*/
public CmsGroup readGroup(CmsDbContext dbc, CmsUUID groupId) throws CmsDataAccessException {
CmsGroup group = null;
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_READ_BY_ID_1");
// read the group from the database
stmt.setString(1, groupId.toString());
res = stmt.executeQuery();
// create new Cms group object
if (res.next()) {
group = internalCreateGroup(res);
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
} else {
CmsMessageContainer message = Messages.get().container(Messages.ERR_NO_GROUP_WITH_ID_1, groupId);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key());
}
throw new CmsDbEntryNotFoundException(message);
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return group;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readGroup(org.opencms.db.CmsDbContext, java.lang.String)
*/
public CmsGroup readGroup(CmsDbContext dbc, String groupFqn) throws CmsDataAccessException {
CmsGroup group = null;
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_READ_BY_NAME_2");
// read the group from the database
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(groupFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn));
res = stmt.executeQuery();
// create new Cms group object
if (res.next()) {
group = internalCreateGroup(res);
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
} else {
CmsMessageContainer message = org.opencms.db.Messages.get().container(
org.opencms.db.Messages.ERR_UNKNOWN_GROUP_1,
groupFqn);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key(), new Exception());
}
throw new CmsDbEntryNotFoundException(message);
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return group;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readGroupsOfUser(CmsDbContext, CmsUUID, String, boolean, String, boolean)
*/
public List readGroupsOfUser(
CmsDbContext dbc,
CmsUUID userId,
String ouFqn,
boolean includeChildOus,
String remoteAddress,
boolean readRoles) throws CmsDataAccessException {
// compose the query
String sqlQuery = createRoleQuery("C_GROUPS_GET_GROUPS_OF_USER_1", includeChildOus, readRoles);
// adjust parameter to use with LIKE
String ouFqnParam = CmsOrganizationalUnit.SEPARATOR + ouFqn;
if (includeChildOus) {
ouFqnParam += "%";
}
// execute it
List groups = new ArrayList();
PreparedStatement stmt = null;
ResultSet res = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatementForSql(conn, sqlQuery);
// get all all groups of the user
stmt.setString(1, userId.toString());
stmt.setString(2, ouFqnParam);
stmt.setInt(3, I_CmsPrincipal.FLAG_GROUP_ROLE);
res = stmt.executeQuery();
while (res.next()) {
groups.add(internalCreateGroup(res));
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return groups;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readOrganizationalUnit(org.opencms.db.CmsDbContext, String)
*/
public CmsOrganizationalUnit readOrganizationalUnit(CmsDbContext dbc, String ouFqn) throws CmsDataAccessException {
try {
CmsResource resource = m_driverManager.readResource(
dbc,
ORGUNIT_BASE_FOLDER + ouFqn,
CmsResourceFilter.DEFAULT);
return internalCreateOrgUnitFromResource(dbc, resource);
} catch (CmsVfsResourceNotFoundException e) {
throw new CmsDbEntryNotFoundException(Messages.get().container(Messages.ERR_READ_ORGUNIT_1, ouFqn), e);
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#readUser(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID)
*/
public CmsUser readUser(CmsDbContext dbc, CmsUUID id) throws CmsDataAccessException {
PreparedStatement stmt = null;
ResultSet res = null;
CmsUser user = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_READ_BY_ID_1");
stmt.setString(1, id.toString());
res = stmt.executeQuery();
// create new Cms user object
if (res.next()) {
user = internalCreateUser(dbc, res);
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
} else {
CmsMessageContainer message = Messages.get().container(Messages.ERR_NO_USER_WITH_ID_1, id);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key());
}
throw new CmsDbEntryNotFoundException(message);
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
Map info = readUserInfos(dbc, user.getId());
user.setAdditionalInfo(info);
return user;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readUser(org.opencms.db.CmsDbContext, java.lang.String)
*/
public CmsUser readUser(CmsDbContext dbc, String userFqn) throws CmsDataAccessException {
PreparedStatement stmt = null;
ResultSet res = null;
CmsUser user = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_READ_BY_NAME_2");
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(userFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn));
res = stmt.executeQuery();
if (res.next()) {
user = internalCreateUser(dbc, res);
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
} else {
CmsMessageContainer message = org.opencms.db.Messages.get().container(
org.opencms.db.Messages.ERR_UNKNOWN_USER_1,
userFqn);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key());
}
throw new CmsDbEntryNotFoundException(message);
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
Map info = readUserInfos(dbc, user.getId());
user.setAdditionalInfo(info);
return user;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readUser(org.opencms.db.CmsDbContext, java.lang.String, java.lang.String, String)
*/
public CmsUser readUser(CmsDbContext dbc, String userFqn, String password, String remoteAddress)
throws CmsDataAccessException {
PreparedStatement stmt = null;
ResultSet res = null;
CmsUser user = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_READ_BY_NAME_2");
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(userFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn));
res = stmt.executeQuery();
boolean success = false;
// create the user object
if (res.next()) {
user = internalCreateUser(dbc, res);
// validate the password stored for the user
success = OpenCms.getPasswordHandler().checkPassword(password, user.getPassword(), true);
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
}
if (!success) {
CmsMessageContainer message = org.opencms.db.Messages.get().container(
org.opencms.db.Messages.ERR_UNKNOWN_USER_1,
userFqn);
if (LOG.isDebugEnabled()) {
LOG.debug(message.key());
}
throw new CmsDbEntryNotFoundException(message);
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
@SuppressWarnings("null")
Map info = readUserInfos(dbc, user.getId());
user.setAdditionalInfo(info);
return user;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readUserInfos(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID)
*/
public Map readUserInfos(CmsDbContext dbc, CmsUUID userId) throws CmsDataAccessException {
Map infos = new HashMap();
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
// create statement
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERDATA_READ_1");
stmt.setString(1, userId.toString());
res = stmt.executeQuery();
// read the infos
while (res.next()) {
String key = res.getString(m_sqlManager.readQuery("C_USERDATA_KEY_0"));
String type = res.getString(m_sqlManager.readQuery("C_USERDATA_TYPE_0"));
byte[] value = m_sqlManager.getBytes(res, m_sqlManager.readQuery("C_USERDATA_VALUE_0"));
// deserialize
Object data = null;
try {
if (LOG.isDebugEnabled()) {
LOG.debug(Messages.get().getBundle().key(Messages.LOG_DBG_READUSERINFO_2, key, type));
if (value != null) {
try {
LOG.debug(
Messages.get().getBundle().key(
Messages.LOG_DBG_READUSERINFO_VALUE_1,
new String(value)));
} catch (Exception e) {
// noop
}
} else {
LOG.debug(Messages.get().getBundle().key(Messages.LOG_DBG_READUSERINFO_VALUE_1, null));
}
}
data = CmsDataTypeUtil.dataDeserialize(value, type);
} catch (Exception e) {
LOG.error(
Messages.get().container(Messages.ERR_READING_ADDITIONAL_INFO_1, userId.toString()).key(),
e);
}
if ((key != null) && (data != null)) {
infos.put(key, data);
}
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return infos;
}
/**
* @see org.opencms.db.I_CmsUserDriver#readUsersOfGroup(CmsDbContext, String, boolean)
*/
public List readUsersOfGroup(CmsDbContext dbc, String groupFqn, boolean includeOtherOuUsers)
throws CmsDataAccessException {
String sqlQuery = "C_GROUPS_GET_USERS_OF_GROUP_2";
if (includeOtherOuUsers) {
sqlQuery = "C_GROUPS_GET_ALL_USERS_OF_GROUP_2";
}
List users = new ArrayList();
PreparedStatement stmt = null;
ResultSet res = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, sqlQuery);
stmt.setString(1, CmsOrganizationalUnit.getSimpleName(groupFqn));
stmt.setString(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn));
res = stmt.executeQuery();
while (res.next()) {
users.add(internalCreateUser(dbc, res));
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
for (CmsUser user : users) {
Map info = readUserInfos(dbc, user.getId());
user.setAdditionalInfo(info);
}
return users;
}
/**
* @see org.opencms.db.I_CmsUserDriver#removeAccessControlEntries(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.util.CmsUUID)
*/
public void removeAccessControlEntries(CmsDbContext dbc, CmsProject project, CmsUUID resource)
throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_REMOVE_ALL_1");
stmt.setString(1, resource.toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#removeAccessControlEntriesForPrincipal(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsProject, org.opencms.util.CmsUUID)
*/
public void removeAccessControlEntriesForPrincipal(
CmsDbContext dbc,
CmsProject project,
CmsProject onlineProject,
CmsUUID principal) throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
// TODO: refactor for only one project at a time
if (dbc.getProjectId().isNullUUID()) {
// offline project available
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_REMOVE_ALL_FOR_PRINCIPAL_1");
stmt.setString(1, principal.toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, onlineProject, "C_ACCESS_REMOVE_ALL_FOR_PRINCIPAL_1");
stmt.setString(1, principal.toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#removeAccessControlEntry(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
*/
public void removeAccessControlEntry(CmsDbContext dbc, CmsProject project, CmsUUID resource, CmsUUID principal)
throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_REMOVE_2");
stmt.setString(1, resource.toString());
stmt.setString(2, principal.toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#removeResourceFromOrganizationalUnit(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, CmsResource)
*/
public void removeResourceFromOrganizationalUnit(
CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
CmsResource resource) throws CmsDataAccessException {
// check for root ou
if (orgUnit.getParentFqn() == null) {
throw new CmsDataAccessException(
org.opencms.security.Messages.get().container(
org.opencms.security.Messages.ERR_ORGUNIT_ROOT_EDITION_0));
}
try {
// read the representing resource
CmsResource ouResource = m_driverManager.readResource(
dbc,
ORGUNIT_BASE_FOLDER + orgUnit.getName(),
CmsResourceFilter.ALL);
// get the associated resources
List vfsPaths = new ArrayList(internalResourcesForOrgUnit(dbc, ouResource));
// check if associated
if (!vfsPaths.contains(resource.getRootPath())) {
throw new CmsDataAccessException(
Messages.get().container(
Messages.ERR_ORGUNIT_DOESNOT_CONTAINS_RESOURCE_2,
orgUnit.getName(),
dbc.removeSiteRoot(resource.getRootPath())));
}
if ((vfsPaths.size() == 1) && !orgUnit.hasFlagWebuser()) {
// normal ous have to have at least one resource
throw new CmsDataAccessException(
Messages.get().container(
Messages.ERR_ORGUNIT_REMOVE_LAST_RESOURCE_2,
orgUnit.getName(),
dbc.removeSiteRoot(resource.getRootPath())));
}
// remove the resource
CmsRelationFilter filter = CmsRelationFilter.TARGETS.filterPath(resource.getRootPath());
m_driverManager.getVfsDriver(dbc).deleteRelations(dbc, dbc.currentProject().getUuid(), ouResource, filter);
m_driverManager.getVfsDriver(dbc).deleteRelations(dbc, CmsProject.ONLINE_PROJECT_ID, ouResource, filter);
try {
// be sure the project was not deleted
CmsProject project = m_driverManager.readProject(dbc, orgUnit.getProjectId());
// maintain the default project synchronized
m_driverManager.getProjectDriver(dbc).deleteProjectResource(
dbc,
orgUnit.getProjectId(),
resource.getRootPath());
OpenCms.fireCmsEvent(
I_CmsEventListener.EVENT_PROJECT_MODIFIED,
Collections. singletonMap("project", project));
} catch (CmsDbEntryNotFoundException e) {
// ignore
} finally {
Map data = new HashMap(2);
data.put(I_CmsEventListener.KEY_RESOURCE, ouResource);
data.put(I_CmsEventListener.KEY_CHANGE, new Integer(CmsDriverManager.CHANGED_RESOURCE));
OpenCms.fireCmsEvent(new CmsEvent(I_CmsEventListener.EVENT_RESOURCE_MODIFIED, data));
}
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#searchUsers(org.opencms.db.CmsDbContext, org.opencms.file.CmsUserSearchParameters)
*/
public List searchUsers(CmsDbContext dbc, CmsUserSearchParameters searchParams)
throws CmsDataAccessException {
List users = new ArrayList();
CmsPair> queryAndParams = createUserQuery(searchParams, false);
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatementForSql(conn, queryAndParams.getFirst());
CmsDbUtil.fillParameters(stmt, queryAndParams.getSecond());
res = stmt.executeQuery();
while (res.next()) {
CmsUser user = internalCreateUser(dbc, res);
users.add(user);
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
for (CmsUser user : users) {
Map info = readUserInfos(dbc, user.getId());
user.setAdditionalInfo(info);
}
return users;
}
/**
* @see org.opencms.db.I_CmsUserDriver#setDriverManager(org.opencms.db.CmsDriverManager)
*/
public void setDriverManager(CmsDriverManager driverManager) {
m_driverManager = driverManager;
}
/**
* @see org.opencms.db.I_CmsUserDriver#setSqlManager(org.opencms.db.CmsSqlManager)
*/
public void setSqlManager(org.opencms.db.CmsSqlManager sqlManager) {
m_sqlManager = (CmsSqlManager)sqlManager;
}
/**
* @see org.opencms.db.I_CmsUserDriver#setUsersOrganizationalUnit(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, org.opencms.file.CmsUser)
*/
public void setUsersOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, CmsUser user)
throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_SET_ORGUNIT_2");
if (orgUnit == null) {
stmt.setString(1, null);
} else {
stmt.setString(1, CmsOrganizationalUnit.SEPARATOR + orgUnit.getName());
}
stmt.setString(2, user.getId().toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#writeAccessControlEntry(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.security.CmsAccessControlEntry)
*/
public void writeAccessControlEntry(CmsDbContext dbc, CmsProject project, CmsAccessControlEntry acEntry)
throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
ResultSet res = null;
CmsAccessControlEntry ace = null;
try {
conn = m_sqlManager.getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_READ_ENTRY_2");
stmt.setString(1, acEntry.getResource().toString());
stmt.setString(2, acEntry.getPrincipal().toString());
res = stmt.executeQuery();
if (res.next()) {
ace = internalCreateAce(res);
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
if (ace == null) {
m_driverManager.getUserDriver(dbc).createAccessControlEntry(
dbc,
project,
acEntry.getResource(),
acEntry.getPrincipal(),
acEntry.getAllowedPermissions(),
acEntry.getDeniedPermissions(),
acEntry.getFlags());
return;
} else {
try {
conn = m_sqlManager.getConnection(dbc);
// otherwise update the already existing entry
stmt = m_sqlManager.getPreparedStatement(conn, project, "C_ACCESS_UPDATE_5");
stmt.setInt(1, acEntry.getAllowedPermissions());
stmt.setInt(2, acEntry.getDeniedPermissions());
stmt.setInt(3, acEntry.getFlags());
stmt.setString(4, acEntry.getResource().toString());
stmt.setString(5, acEntry.getPrincipal().toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#writeGroup(org.opencms.db.CmsDbContext, org.opencms.file.CmsGroup)
*/
public void writeGroup(CmsDbContext dbc, CmsGroup group) throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
if (group != null) {
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_WRITE_GROUP_4");
stmt.setString(1, m_sqlManager.validateEmpty(group.getDescription()));
stmt.setInt(2, group.getFlags());
stmt.setString(3, group.getParentId().toString());
stmt.setString(4, group.getId().toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
} else {
throw new CmsDbEntryNotFoundException(
org.opencms.db.Messages.get().container(org.opencms.db.Messages.ERR_UNKNOWN_GROUP_1, "null"));
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#writeOrganizationalUnit(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit)
*/
public void writeOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit organizationalUnit)
throws CmsDataAccessException {
try {
CmsResource resource = m_driverManager.readResource(
dbc,
organizationalUnit.getId(),
CmsResourceFilter.DEFAULT);
// write the properties
internalWriteOrgUnitProperty(
dbc,
resource,
new CmsProperty(ORGUNIT_PROPERTY_DESCRIPTION, organizationalUnit.getDescription(), null));
CmsUUID projectId = ((dbc.getProjectId() == null) || dbc.getProjectId().isNullUUID())
? dbc.currentProject().getUuid()
: dbc.getProjectId();
// update the resource flags
resource.setFlags(organizationalUnit.getFlags() | CmsResource.FLAG_INTERNAL);
m_driverManager.writeResource(dbc, resource);
resource.setState(CmsResource.STATE_UNCHANGED);
m_driverManager.getVfsDriver(dbc).writeResource(dbc, projectId, resource, CmsDriverManager.NOTHING_CHANGED);
if (!dbc.currentProject().isOnlineProject()) {
// online persistence
CmsProject onlineProject = m_driverManager.readProject(dbc, CmsProject.ONLINE_PROJECT_ID);
resource.setState(CmsResource.STATE_UNCHANGED);
m_driverManager.getVfsDriver(dbc).writeResource(
dbc,
onlineProject.getUuid(),
resource,
CmsDriverManager.NOTHING_CHANGED);
}
OpenCms.fireCmsEvent(I_CmsEventListener.EVENT_CLEAR_ONLINE_CACHES, null);
} catch (CmsException e) {
throw new CmsDataAccessException(e.getMessageContainer(), e);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#writePassword(org.opencms.db.CmsDbContext, java.lang.String, java.lang.String, java.lang.String)
*/
public void writePassword(CmsDbContext dbc, String userFqn, String oldPassword, String newPassword)
throws CmsDataAccessException, CmsPasswordEncryptionException {
PreparedStatement stmt = null;
Connection conn = null;
// check if the old password is valid
if (oldPassword != null) {
readUser(dbc, userFqn, oldPassword, "");
}
String pwd = newPassword;
if (dbc.getRequestContext().getAttribute(REQ_ATTR_DONT_DIGEST_PASSWORD) == null) {
pwd = OpenCms.getPasswordHandler().digest(newPassword);
}
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_SET_PWD_3");
stmt.setString(1, pwd);
stmt.setString(2, CmsOrganizationalUnit.getSimpleName(userFqn));
stmt.setString(3, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn));
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#writeUser(org.opencms.db.CmsDbContext, org.opencms.file.CmsUser)
*/
public void writeUser(CmsDbContext dbc, CmsUser user) throws CmsDataAccessException {
// get the login attribute
String att_login = (String)dbc.getAttribute(CmsDriverManager.ATTRIBUTE_LOGIN);
PreparedStatement stmt = null;
Connection conn = null;
// if the login attribute is set, do only update the last login information of this user
// otherwise write the complete user data
if (CmsStringUtil.isNotEmpty(att_login)) {
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_WRITE_2");
// write data to database
stmt.setLong(1, user.getLastlogin());
stmt.setString(2, user.getId().toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
// store user info values which may have been modified by the login code
internalWriteUserInfos(dbc, user.getId(), user.getAdditionalInfo());
} else {
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_WRITE_6");
// write data to database
stmt.setString(1, m_sqlManager.validateEmpty(user.getFirstname()));
stmt.setString(2, m_sqlManager.validateEmpty(user.getLastname()));
stmt.setString(3, m_sqlManager.validateEmpty(user.getEmail()));
stmt.setLong(4, user.getLastlogin());
stmt.setInt(5, user.getFlags());
stmt.setString(6, user.getId().toString());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
internalWriteUserInfos(dbc, user.getId(), user.getAdditionalInfo());
}
}
/**
* @see org.opencms.db.I_CmsUserDriver#writeUserInfo(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, java.lang.String, java.lang.Object)
*/
public void writeUserInfo(CmsDbContext dbc, CmsUUID userId, String key, Object value)
throws CmsDataAccessException {
// analyse the dbc attribute what to do here
String mode = (String)dbc.getAttribute(ATTRIBUTE_USERADDINFO);
// delete the user info
if (CmsStringUtil.isNotEmpty(mode) && mode.equals(ATTRIBUTE_USERADDINFO_VALUE_DELETE)) {
internalDeleteUserInfo(dbc, userId, key);
} else if (CmsStringUtil.isNotEmpty(mode) && mode.equals(ATTRIBUTE_USERADDINFO_VALUE_UPDATE)) {
internalUpdateUserInfo(dbc, userId, key, value);
} else {
// default is to insert or update a new value
internalWriteUserInfo(dbc, userId, key, value);
}
}
/**
* Returns a sql query to select groups.
*
* @param mainQuery the main select sql query
* @param includeSubOus if groups in sub-ous should be included in the selection
* @param readRoles if groups or roles whould be selected
*
* @return a sql query to select groups
*/
protected String createRoleQuery(String mainQuery, boolean includeSubOus, boolean readRoles) {
String sqlQuery = m_sqlManager.readQuery(mainQuery);
sqlQuery += " ";
if (includeSubOus) {
sqlQuery += m_sqlManager.readQuery("C_GROUPS_GROUP_OU_LIKE_1");
} else {
sqlQuery += m_sqlManager.readQuery("C_GROUPS_GROUP_OU_EQUALS_1");
}
sqlQuery += AND_CONDITION;
if (readRoles) {
sqlQuery += m_sqlManager.readQuery("C_GROUPS_SELECT_ROLES_1");
} else {
sqlQuery += m_sqlManager.readQuery("C_GROUPS_SELECT_GROUPS_1");
}
sqlQuery += " ";
sqlQuery += m_sqlManager.readQuery("C_GROUPS_ORDER_0");
return sqlQuery;
}
/**
* Creates a query for searching users.
*
* @param searchParams the user search criteria
* @param countOnly if true, the query will only count the total number of results instead of returning them
*
* @return a pair consisting of the query string and its parameters
*/
protected CmsPair> createUserQuery(CmsUserSearchParameters searchParams, boolean countOnly) {
CmsUserQueryBuilder queryBuilder = createUserQueryBuilder();
return queryBuilder.createUserQuery(searchParams, countOnly);
}
/**
* Creates a new user query builder.
*
* @return the new user query builder
*/
protected CmsUserQueryBuilder createUserQueryBuilder() {
return new CmsUserQueryBuilder();
}
/**
* Internal helper method to create an access control entry from a database record.
*
* @param res resultset of the current query
*
* @return a new {@link CmsAccessControlEntry} initialized with the values from the current database record
*
* @throws SQLException if something goes wrong
*/
protected CmsAccessControlEntry internalCreateAce(ResultSet res) throws SQLException {
return internalCreateAce(res, new CmsUUID(res.getString(m_sqlManager.readQuery("C_ACCESS_RESOURCE_ID_0"))));
}
/**
* Internal helper method to create an access control entry from a database record.
*
* @param res resultset of the current query
* @param newId the id of the new access control entry
*
* @return a new {@link CmsAccessControlEntry} initialized with the values from the current database record
*
* @throws SQLException if something goes wrong
*/
protected CmsAccessControlEntry internalCreateAce(ResultSet res, CmsUUID newId) throws SQLException {
return new CmsAccessControlEntry(
newId,
new CmsUUID(res.getString(m_sqlManager.readQuery("C_ACCESS_PRINCIPAL_ID_0"))),
res.getInt(m_sqlManager.readQuery("C_ACCESS_ACCESS_ALLOWED_0")),
res.getInt(m_sqlManager.readQuery("C_ACCESS_ACCESS_DENIED_0")),
res.getInt(m_sqlManager.readQuery("C_ACCESS_ACCESS_FLAGS_0")));
}
/**
* Creates the default groups and user for the given organizational unit.
*
* @param dbc the database context
* @param ouFqn the fully qualified name of the organizational unit to create the principals for
* @param ouDescription the description of the given organizational unit
* @param webuser the webuser ou flag
*
* @throws CmsException if something goes wrong
*/
protected void internalCreateDefaultGroups(CmsDbContext dbc, String ouFqn, String ouDescription, boolean webuser)
throws CmsException {
// create roles
String rootAdminRole = CmsRole.ROOT_ADMIN.getGroupName();
boolean isRootOu = CmsOrganizationalUnit.getParentFqn(ouFqn) == null;
try {
for (CmsRole role : CmsRole.getSystemRoles()) {
if (webuser && (role != CmsRole.ACCOUNT_MANAGER)) {
// if webuser ou and not account manager role
continue;
}
if (role.isOrganizationalUnitIndependent() && !isRootOu) {
// if role is ou independent and not in the root ou
continue;
}
String groupName = ouFqn + role.getGroupName();
int flags = I_CmsPrincipal.FLAG_ENABLED | I_CmsPrincipal.FLAG_GROUP_ROLE;
if (!existsGroup(dbc, groupName)) {
createGroup(dbc, CmsUUID.getConstantUUID(groupName), groupName, "A system role group", flags, null);
}
}
if (isRootOu && CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_SYSTEM_ROLES_CREATED_0));
}
} catch (CmsException e) {
if (isRootOu && CmsLog.INIT.isErrorEnabled()) {
CmsLog.INIT.error(Messages.get().getBundle().key(Messages.INIT_SYSTEM_ROLES_CREATION_FAILED_0), e);
}
throw new CmsInitException(Messages.get().container(Messages.ERR_INITIALIZING_USER_DRIVER_0), e);
}
if (dbc.getAttribute(CmsDriverManager.ATTR_INIT_OU) != null) {
return;
}
if (webuser) {
// no default groups for webuser ou
return;
}
// create groups
String administratorsGroup = ouFqn + OpenCms.getDefaultUsers().getGroupAdministrators();
String guestGroup = ouFqn + OpenCms.getDefaultUsers().getGroupGuests();
String usersGroup = ouFqn + OpenCms.getDefaultUsers().getGroupUsers();
String guestUser = ouFqn + OpenCms.getDefaultUsers().getUserGuest();
String adminUser = ouFqn + OpenCms.getDefaultUsers().getUserAdmin();
String exportUser = ouFqn + OpenCms.getDefaultUsers().getUserExport();
String deleteUser = ouFqn + OpenCms.getDefaultUsers().getUserDeletedResource();
if (existsGroup(dbc, administratorsGroup)) {
if (isRootOu) {
// check the flags of existing groups, for compatibility checks
internalUpdateRoleGroup(dbc, administratorsGroup, CmsRole.ROOT_ADMIN);
internalUpdateRoleGroup(dbc, usersGroup, CmsRole.ELEMENT_AUTHOR.forOrgUnit(ouFqn));
}
return;
}
String parentOu = CmsOrganizationalUnit.getParentFqn(ouFqn);
String parentGroup = null;
if (parentOu != null) {
parentGroup = parentOu + OpenCms.getDefaultUsers().getGroupUsers();
}
String groupDescription = (CmsStringUtil.isNotEmptyOrWhitespaceOnly(ouDescription)
? CmsMacroResolver.localizedKeyMacro(
Messages.GUI_DEFAULTGROUP_OU_USERS_DESCRIPTION_1,
new String[] {ouDescription})
: CmsMacroResolver.localizedKeyMacro(Messages.GUI_DEFAULTGROUP_ROOT_USERS_DESCRIPTION_0, null));
createGroup(
dbc,
CmsUUID.getConstantUUID(usersGroup),
usersGroup,
groupDescription,
I_CmsPrincipal.FLAG_ENABLED | CmsRole.ELEMENT_AUTHOR.getVirtualGroupFlags(),
parentGroup);
if (parentOu != null) {
// default users/groups(except the users group) are only for the root ou
return;
}
CmsGroup guests = createGroup(
dbc,
CmsUUID.getConstantUUID(guestGroup),
guestGroup,
CmsMacroResolver.localizedKeyMacro(Messages.GUI_DEFAULTGROUP_ROOT_GUESTS_DESCRIPTION_0, null),
I_CmsPrincipal.FLAG_ENABLED,
null);
int flags = CmsRole.ROOT_ADMIN.getVirtualGroupFlags();
createGroup(
dbc,
CmsUUID.getConstantUUID(administratorsGroup),
administratorsGroup,
CmsMacroResolver.localizedKeyMacro(Messages.GUI_DEFAULTGROUP_ROOT_ADMINS_DESCRIPTION_0, null),
I_CmsPrincipal.FLAG_ENABLED | flags,
null);
CmsUser guest = createUser(
dbc,
CmsUUID.getConstantUUID(guestUser),
guestUser,
OpenCms.getPasswordHandler().digest((new CmsUUID()).toString()),
" ",
" ",
" ",
0,
I_CmsPrincipal.FLAG_ENABLED,
0,
Collections.singletonMap(
CmsUserSettings.ADDITIONAL_INFO_DESCRIPTION,
(Object)CmsMacroResolver.localizedKeyMacro(Messages.GUI_DEFAULTUSER_ROOT_GUEST_DESCRIPTION_0, null)));
createUserInGroup(dbc, guest.getId(), guests.getId());
CmsUser admin = createUser(
dbc,
CmsUUID.getConstantUUID(adminUser),
adminUser,
OpenCms.getPasswordHandler().digest("admin"),
" ",
" ",
" ",
0,
I_CmsPrincipal.FLAG_ENABLED,
0,
Collections.singletonMap(
CmsUserSettings.ADDITIONAL_INFO_DESCRIPTION,
(Object)CmsMacroResolver.localizedKeyMacro(Messages.GUI_DEFAULTUSER_ROOT_ADMIN_DESCRIPTION_0, null)));
createUserInGroup(dbc, admin.getId(), CmsUUID.getConstantUUID(CmsRole.ROOT_ADMIN.getGroupName()));
createUserInGroup(dbc, admin.getId(), CmsUUID.getConstantUUID(administratorsGroup));
if (!OpenCms.getDefaultUsers().getUserExport().equals(OpenCms.getDefaultUsers().getUserAdmin())
&& !OpenCms.getDefaultUsers().getUserExport().equals(OpenCms.getDefaultUsers().getUserGuest())) {
CmsUser export = createUser(
dbc,
CmsUUID.getConstantUUID(exportUser),
exportUser,
OpenCms.getPasswordHandler().digest((new CmsUUID()).toString()),
" ",
" ",
" ",
0,
I_CmsPrincipal.FLAG_ENABLED,
0,
Collections.singletonMap(
CmsUserSettings.ADDITIONAL_INFO_DESCRIPTION,
(Object)CmsMacroResolver.localizedKeyMacro(
Messages.GUI_DEFAULTUSER_ROOT_EXPORT_DESCRIPTION_0,
null)));
createUserInGroup(dbc, export.getId(), guests.getId());
}
if (!OpenCms.getDefaultUsers().getUserDeletedResource().equals(OpenCms.getDefaultUsers().getUserAdmin())
&& !OpenCms.getDefaultUsers().getUserDeletedResource().equals(OpenCms.getDefaultUsers().getUserGuest())
&& !OpenCms.getDefaultUsers().getUserDeletedResource().equals(OpenCms.getDefaultUsers().getUserExport())) {
createUser(
dbc,
CmsUUID.getConstantUUID(deleteUser),
deleteUser,
OpenCms.getPasswordHandler().digest((new CmsUUID()).toString()),
" ",
" ",
" ",
0,
I_CmsPrincipal.FLAG_ENABLED,
0,
Collections.singletonMap(
CmsUserSettings.ADDITIONAL_INFO_DESCRIPTION,
(Object)CmsMacroResolver.localizedKeyMacro(
Messages.GUI_DEFAULTUSER_ROOT_DELETED_DESCRIPTION_0,
null)));
}
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_DEFAULT_USERS_CREATED_0));
}
}
/**
* Semi-constructor to create a {@link CmsGroup} instance from a JDBC result set.
*
* @param res the JDBC ResultSet
* @return CmsGroup the new CmsGroup object
*
* @throws SQLException in case the result set does not include a requested table attribute
*/
protected CmsGroup internalCreateGroup(ResultSet res) throws SQLException {
String ou = CmsOrganizationalUnit.removeLeadingSeparator(
res.getString(m_sqlManager.readQuery("C_GROUPS_GROUP_OU_0")));
String description = res.getString(m_sqlManager.readQuery("C_GROUPS_GROUP_DESCRIPTION_0"));
return new CmsGroup(
new CmsUUID(res.getString(m_sqlManager.readQuery("C_GROUPS_GROUP_ID_0"))),
new CmsUUID(res.getString(m_sqlManager.readQuery("C_GROUPS_PARENT_GROUP_ID_0"))),
ou + res.getString(m_sqlManager.readQuery("C_GROUPS_GROUP_NAME_0")),
description,
res.getInt(m_sqlManager.readQuery("C_GROUPS_GROUP_FLAGS_0")));
}
/**
* Returns the organizational unit represented by the given resource.
*
* @param dbc the current db context
* @param resource the resource that represents an organizational unit
*
* @return the organizational unit represented by the given resource
*
* @throws CmsException if something goes wrong
*/
protected CmsOrganizationalUnit internalCreateOrgUnitFromResource(CmsDbContext dbc, CmsResource resource)
throws CmsException {
if (!resource.getRootPath().startsWith(ORGUNIT_BASE_FOLDER)) {
throw new CmsDataAccessException(
Messages.get().container(Messages.ERR_READ_ORGUNIT_1, resource.getRootPath()));
}
// get the data
String name = resource.getRootPath().substring(ORGUNIT_BASE_FOLDER.length());
if ((name.length() > 0) && !name.endsWith(CmsOrganizationalUnit.SEPARATOR)) {
name += CmsOrganizationalUnit.SEPARATOR;
}
String description = m_driverManager.readPropertyObject(
dbc,
resource,
ORGUNIT_PROPERTY_DESCRIPTION,
false).getStructureValue();
int flags = (resource.getFlags() & ~CmsResource.FLAG_INTERNAL); // remove the internal flag
String projectId = m_driverManager.readPropertyObject(
dbc,
resource,
ORGUNIT_PROPERTY_PROJECTID,
false).getStructureValue();
// create the object
return new CmsOrganizationalUnit(
resource.getStructureId(),
name,
description,
flags,
(projectId == null ? null : new CmsUUID(projectId)));
}
/**
* Creates a folder with the given path an properties, offline AND online.
*
* @param dbc the current database context
* @param path the path to create the folder
* @param flags the resource flags
*
* @return the new created offline folder
*
* @throws CmsException if something goes wrong
*/
protected CmsResource internalCreateResourceForOrgUnit(CmsDbContext dbc, String path, int flags)
throws CmsException {
// create the offline folder
CmsResource resource = new CmsFolder(
new CmsUUID(),
new CmsUUID(),
path,
CmsResourceTypeFolder.RESOURCE_TYPE_ID,
(CmsResource.FLAG_INTERNAL | flags),
dbc.currentProject().getUuid(),
CmsResource.STATE_NEW,
0,
dbc.currentUser().getId(),
0,
dbc.currentUser().getId(),
CmsResource.DATE_RELEASED_DEFAULT,
CmsResource.DATE_EXPIRED_DEFAULT,
0);
CmsUUID projectId = ((dbc.getProjectId() == null) || dbc.getProjectId().isNullUUID())
? dbc.currentProject().getUuid()
: dbc.getProjectId();
m_driverManager.getVfsDriver(dbc).createResource(dbc, projectId, resource, null);
resource.setState(CmsResource.STATE_UNCHANGED);
m_driverManager.getVfsDriver(dbc).writeResource(dbc, projectId, resource, CmsDriverManager.NOTHING_CHANGED);
if (!dbc.currentProject().isOnlineProject() && dbc.getProjectId().isNullUUID()) {
// online persistence
CmsProject onlineProject = m_driverManager.readProject(dbc, CmsProject.ONLINE_PROJECT_ID);
m_driverManager.getVfsDriver(dbc).createResource(dbc, onlineProject.getUuid(), resource, null);
}
// clear the internal caches
OpenCms.getMemoryMonitor().clearAccessControlListCache();
OpenCms.getMemoryMonitor().flushCache(CmsMemoryMonitor.CacheType.PROPERTY);
OpenCms.getMemoryMonitor().flushCache(CmsMemoryMonitor.CacheType.PROPERTY_LIST);
// fire an event that a new resource has been created
OpenCms.fireCmsEvent(
new CmsEvent(
I_CmsEventListener.EVENT_RESOURCE_CREATED,
Collections. singletonMap(I_CmsEventListener.KEY_RESOURCE, resource)));
return resource;
}
/**
* Semi-constructor to create a {@link CmsUser} instance from a JDBC result set.
*
* @param dbc the current database context
* @param res the JDBC ResultSet
*
* @return the new CmsUser object
*
* @throws SQLException in case the result set does not include a requested table attribute
*/
protected CmsUser internalCreateUser(CmsDbContext dbc, ResultSet res) throws SQLException {
String userName = res.getString(m_sqlManager.readQuery("C_USERS_USER_NAME_0"));
String ou = CmsOrganizationalUnit.removeLeadingSeparator(
res.getString(m_sqlManager.readQuery("C_USERS_USER_OU_0")));
CmsUUID userId = new CmsUUID(res.getString(m_sqlManager.readQuery("C_USERS_USER_ID_0")));
if (LOG.isDebugEnabled()) {
LOG.debug(Messages.get().getBundle().key(Messages.LOG_DBG_CREATE_USER_1, userName));
}
return new CmsUser(
userId,
ou + userName,
res.getString(m_sqlManager.readQuery("C_USERS_USER_PASSWORD_0")),
res.getString(m_sqlManager.readQuery("C_USERS_USER_FIRSTNAME_0")),
res.getString(m_sqlManager.readQuery("C_USERS_USER_LASTNAME_0")),
res.getString(m_sqlManager.readQuery("C_USERS_USER_EMAIL_0")),
res.getLong(m_sqlManager.readQuery("C_USERS_USER_LASTLOGIN_0")),
res.getInt(m_sqlManager.readQuery("C_USERS_USER_FLAGS_0")),
res.getLong(m_sqlManager.readQuery("C_USERS_USER_DATECREATED_0")),
null);
}
/**
* Deletes a resource representing a organizational unit, offline AND online.
*
* @param dbc the current database context
* @param resource the resource to delete
*
* @throws CmsException if something goes wrong
*/
protected void internalDeleteOrgUnitResource(CmsDbContext dbc, CmsResource resource) throws CmsException {
CmsRelationFilter filter = CmsRelationFilter.TARGETS;
// first the online version
if (!dbc.currentProject().isOnlineProject()) {
// online persistence
CmsProject project = dbc.currentProject();
dbc.getRequestContext().setCurrentProject(m_driverManager.readProject(dbc, CmsProject.ONLINE_PROJECT_ID));
try {
// delete properties
m_driverManager.getVfsDriver(dbc).deletePropertyObjects(
dbc,
CmsProject.ONLINE_PROJECT_ID,
resource,
CmsProperty.DELETE_OPTION_DELETE_STRUCTURE_AND_RESOURCE_VALUES);
// remove the online folder only if it is really deleted offline
m_driverManager.getVfsDriver(dbc).removeFolder(dbc, dbc.currentProject(), resource);
// remove ACL
m_driverManager.getUserDriver(dbc).removeAccessControlEntries(
dbc,
dbc.currentProject(),
resource.getResourceId());
// delete relations
m_driverManager.getVfsDriver(dbc).deleteRelations(
dbc,
dbc.getRequestContext().getCurrentProject().getUuid(),
resource,
filter);
} finally {
dbc.getRequestContext().setCurrentProject(project);
}
}
// delete properties
m_driverManager.getVfsDriver(dbc).deletePropertyObjects(
dbc,
CmsProject.ONLINE_PROJECT_ID,
resource,
CmsProperty.DELETE_OPTION_DELETE_STRUCTURE_AND_RESOURCE_VALUES);
// remove the online folder only if it is really deleted offline
m_driverManager.getVfsDriver(dbc).removeFolder(dbc, dbc.currentProject(), resource);
// remove ACL
m_driverManager.getUserDriver(dbc).removeAccessControlEntries(
dbc,
dbc.currentProject(),
resource.getResourceId());
// delete relations
m_driverManager.getVfsDriver(dbc).deleteRelations(
dbc,
dbc.getRequestContext().getCurrentProject().getUuid(),
resource,
filter);
// flush all relevant caches
OpenCms.getMemoryMonitor().clearAccessControlListCache();
OpenCms.getMemoryMonitor().flushCache(CmsMemoryMonitor.CacheType.PROPERTY);
OpenCms.getMemoryMonitor().flushCache(CmsMemoryMonitor.CacheType.PROPERTY_LIST);
OpenCms.getMemoryMonitor().flushCache(CmsMemoryMonitor.CacheType.PROJECT_RESOURCES);
// fire events
OpenCms.fireCmsEvent(
new CmsEvent(
I_CmsEventListener.EVENT_RESOURCE_DELETED,
Collections. singletonMap(
I_CmsEventListener.KEY_RESOURCES,
Collections.singletonList(resource))));
OpenCms.fireCmsEvent(
new CmsEvent(
I_CmsEventListener.EVENT_RESOURCE_AND_PROPERTIES_MODIFIED,
Collections. singletonMap(I_CmsEventListener.KEY_RESOURCE, resource)));
}
/**
* Deletes an additional user info.
* @param dbc the current dbc
* @param userId the user to delete additional info from
* @param key the additional info to delete
* @throws CmsDataAccessException if something goes wrong
*/
protected void internalDeleteUserInfo(CmsDbContext dbc, CmsUUID userId, String key) throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERDATA_DELETE_2");
// write data to database
stmt.setString(1, userId.toString());
stmt.setString(2, key);
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* Internal implementation for reading users of an OU, with or without additional infos.
*
* @param dbc the database context
* @param orgUnit the OU
* @param recursive if true, sub-OUs should be searched
* @param readAdditionalInfos if true, additional infos should be read
* @return the users which have been read
* @throws CmsDataAccessException if something goes wrong
*/
protected List internalGetUsers(
CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean recursive,
boolean readAdditionalInfos) throws CmsDataAccessException {
List users = new ArrayList();
ResultSet res = null;
PreparedStatement stmt = null;
Connection conn = null;
try {
// create statement
conn = m_sqlManager.getConnection(dbc);
if (orgUnit.hasFlagWebuser()) {
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_GET_WEBUSERS_FOR_ORGUNIT_1");
} else {
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERS_GET_USERS_FOR_ORGUNIT_1");
}
String param = CmsOrganizationalUnit.SEPARATOR + orgUnit.getName();
if (recursive) {
param += "%";
}
stmt.setString(1, param);
res = stmt.executeQuery();
// create new Cms group objects
while (res.next()) {
users.add(internalCreateUser(dbc, res));
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
if (readAdditionalInfos) {
for (CmsUser user : users) {
Map info = readUserInfos(dbc, user.getId());
user.setAdditionalInfo(info);
}
}
return users;
}
/**
* Returns the folder for the given organizational units, or the base folder if null.
*
* The base folder will be created if it does not exist.
*
* @param dbc the current db context
* @param orgUnit the organizational unit to get the folder for
*
* @return the base folder for organizational units
*
* @throws CmsException if something goes wrong
*/
protected CmsResource internalOrgUnitFolder(CmsDbContext dbc, CmsOrganizationalUnit orgUnit) throws CmsException {
if (orgUnit != null) {
return m_driverManager.readResource(
dbc,
ORGUNIT_BASE_FOLDER + orgUnit.getName(),
CmsResourceFilter.DEFAULT);
} else {
return null;
}
}
/**
* Returns the list of root paths associated to the organizational unit represented by the given resource.
*
* @param dbc the current db context
* @param ouResource the resource that represents the organizational unit to get the resources for
*
* @return the list of associated resource names
*
* @throws CmsException if something goes wrong
*/
protected List internalResourcesForOrgUnit(CmsDbContext dbc, CmsResource ouResource) throws CmsException {
List relations = m_driverManager.getRelationsForResource(
dbc,
ouResource,
CmsRelationFilter.TARGETS);
List paths = new ArrayList();
Iterator it = relations.iterator();
while (it.hasNext()) {
CmsRelation relation = it.next();
paths.add(relation.getTargetPath());
}
return paths;
}
/**
* Updates a group to a virtual group.
*
* @param dbc the database context
* @param groupName the name of the group to update
* @param role the role for this group
*
* @throws CmsDataAccessException if something goes wrong
*/
protected void internalUpdateRoleGroup(CmsDbContext dbc, String groupName, CmsRole role)
throws CmsDataAccessException {
if (LOG.isDebugEnabled()) {
LOG.debug(
Messages.get().getBundle().key(Messages.LOG_DBG_UPDATE_ROLEGROUP_2, role.getRoleName(), groupName));
}
CmsGroup group = readGroup(dbc, groupName);
if ((CmsRole.valueOf(group) == null) || !CmsRole.valueOf(group).equals(role)) {
CmsGroup roleGroup = readGroup(dbc, role.getGroupName());
if (LOG.isDebugEnabled()) {
LOG.debug(Messages.get().getBundle().key(Messages.LOG_DBG_UPDATE_ROLEGROUP_1, roleGroup));
}
// copy all users from the group to the role
Iterator it;
try {
// read all users, also indirect assigned
it = m_driverManager.getUsersOfGroup(dbc, groupName, false, false, false).iterator();
} catch (CmsException e) {
// should never happen
LOG.error(e.getLocalizedMessage(), e);
// read only direct assigned users
it = readUsersOfGroup(dbc, groupName, false).iterator();
}
while (it.hasNext()) {
CmsUser user = it.next();
if (LOG.isDebugEnabled()) {
LOG.debug(Messages.get().getBundle().key(Messages.LOG_DBG_UPDATE_ROLEGROUP_USER_1, user));
}
createUserInGroup(dbc, user.getId(), roleGroup.getId());
}
// set the right flags
group.setFlags(role.getVirtualGroupFlags());
try {
writeGroup(dbc, group);
} catch (Exception e) {
LOG.error("Could not write group flags in internalUpdateRoleGroup: " + e.getLocalizedMessage(), e);
}
}
}
/**
* Updates additional user info.
* @param dbc the current dbc
* @param userId the user id to add the user info for
* @param key the name of the additional user info
* @param value the value of the additional user info
* @throws CmsDataAccessException if something goes wrong
*/
protected void internalUpdateUserInfo(CmsDbContext dbc, CmsUUID userId, String key, Object value)
throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERDATA_UPDATE_4");
// write data to database
m_sqlManager.setBytes(stmt, 1, CmsDataTypeUtil.dataSerialize(value));
stmt.setString(2, value.getClass().getName());
stmt.setString(3, userId.toString());
stmt.setString(4, key);
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} catch (IOException e) {
throw new CmsDbIoException(Messages.get().container(Messages.ERR_SERIALIZING_USER_DATA_1, userId), e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* Validates the given root path to be in the scope of the resources of the given organizational unit.
*
* @param dbc the current db context
* @param orgUnit the organizational unit
* @param rootPath the root path to check
*
* @throws CmsException if something goes wrong
*/
protected void internalValidateResourceForOrgUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, String rootPath)
throws CmsException {
CmsResource parentResource = m_driverManager.readResource(
dbc,
ORGUNIT_BASE_FOLDER + orgUnit.getName(),
CmsResourceFilter.ALL);
// assume not in scope
boolean found = false;
// iterate parent paths
Iterator itParentPaths = internalResourcesForOrgUnit(dbc, parentResource).iterator();
// until the given resource is found in scope
while (!found && itParentPaths.hasNext()) {
String parentPath = itParentPaths.next();
// check the scope
if (rootPath.startsWith(parentPath)) {
found = true;
}
}
// if not in scope throw exception
if (!found) {
throw new CmsException(
Messages.get().container(
Messages.ERR_PATH_NOT_IN_PARENT_ORGUNIT_SCOPE_2,
orgUnit.getName(),
dbc.removeSiteRoot(rootPath)));
}
}
/**
* Checks if a user is member of a group.
*
* @param dbc the database context
* @param userId the id of the user to check
* @param groupId the id of the group to check
*
* @return true if user is member of group
*
* @throws CmsDataAccessException if operation was not succesful
*/
protected boolean internalValidateUserInGroup(CmsDbContext dbc, CmsUUID userId, CmsUUID groupId)
throws CmsDataAccessException {
boolean userInGroup = false;
PreparedStatement stmt = null;
ResultSet res = null;
Connection conn = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_GROUPS_USER_IN_GROUP_2");
stmt.setString(1, groupId.toString());
stmt.setString(2, userId.toString());
res = stmt.executeQuery();
if (res.next()) {
userInGroup = true;
while (res.next()) {
// do nothing only move through all rows because of mssql odbc driver
}
}
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, res);
}
return userInGroup;
}
/**
* Writes a property for an organizational unit resource, online AND offline.
*
* @param dbc the current database context
* @param resource the resource representing the organizational unit
* @param property the property to write
*
* @throws CmsException if something goes wrong
*/
protected void internalWriteOrgUnitProperty(CmsDbContext dbc, CmsResource resource, CmsProperty property)
throws CmsException {
CmsUUID projectId = ((dbc.getProjectId() == null) || dbc.getProjectId().isNullUUID())
? dbc.currentProject().getUuid()
: dbc.getProjectId();
// write the property
m_driverManager.writePropertyObject(dbc, resource, property);
resource.setState(CmsResource.STATE_UNCHANGED);
m_driverManager.getVfsDriver(dbc).writeResource(dbc, projectId, resource, CmsDriverManager.NOTHING_CHANGED);
// online persistence
CmsProject project = dbc.currentProject();
dbc.getRequestContext().setCurrentProject(m_driverManager.readProject(dbc, CmsProject.ONLINE_PROJECT_ID));
try {
m_driverManager.writePropertyObject(dbc, resource, property); // assume the resource is identical in both projects
resource.setState(CmsResource.STATE_UNCHANGED);
m_driverManager.getVfsDriver(dbc).writeResource(
dbc,
dbc.currentProject().getUuid(),
resource,
CmsDriverManager.NOTHING_CHANGED);
} finally {
dbc.getRequestContext().setCurrentProject(project);
}
}
/**
* Writes a new additional user info.
* @param dbc the current dbc
* @param userId the user id to add the user info for
* @param key the name of the additional user info
* @param value the value of the additional user info
* @throws CmsDataAccessException if something goes wrong
*/
protected void internalWriteUserInfo(CmsDbContext dbc, CmsUUID userId, String key, Object value)
throws CmsDataAccessException {
PreparedStatement stmt = null;
Connection conn = null;
try {
conn = getSqlManager().getConnection(dbc);
stmt = m_sqlManager.getPreparedStatement(conn, "C_USERDATA_WRITE_4");
// write data to database
stmt.setString(1, userId.toString());
stmt.setString(2, key);
m_sqlManager.setBytes(stmt, 3, CmsDataTypeUtil.dataSerialize(value));
stmt.setString(4, value.getClass().getName());
stmt.executeUpdate();
} catch (SQLException e) {
throw new CmsDbSqlException(
Messages.get().container(Messages.ERR_GENERIC_SQL_1, CmsDbSqlException.getErrorQuery(stmt)),
e);
} catch (IOException e) {
throw new CmsDbIoException(Messages.get().container(Messages.ERR_SERIALIZING_USER_DATA_1, userId), e);
} finally {
m_sqlManager.closeAll(dbc, conn, stmt, null);
}
}
/**
* Updates the user additional information map.
*
* @param dbc the current database context
* @param userId the id of the user to update
* @param additionalInfo the info to write
*
* @throws CmsDataAccessException if user data could not be written
*/
protected void internalWriteUserInfos(CmsDbContext dbc, CmsUUID userId, Map additionalInfo)
throws CmsDataAccessException {
Lock lock = USER_INFO_LOCKS.get(userId);
try {
lock.lock();
// get the map of existing additional infos to compare it new additional infos
Map existingInfos = readUserInfos(dbc, userId);
// loop over all entries of the existing additional infos
Iterator> itEntries = existingInfos.entrySet().iterator();
while (itEntries.hasNext()) {
Entry entry = itEntries.next();
if ((entry.getKey() != null) && (entry.getValue() != null)) {
// entry does not exist in new additional infos -> delete it
if (!additionalInfo.containsKey(entry.getKey())) {
dbc.setAttribute(ATTRIBUTE_USERADDINFO, ATTRIBUTE_USERADDINFO_VALUE_DELETE);
writeUserInfo(dbc, userId, entry.getKey(), entry.getValue());
} else {
Object newValue = additionalInfo.get(entry.getKey());
// entry does exist but has different value -> update it
if ((newValue != null) && !newValue.equals(entry.getValue())) {
dbc.setAttribute(ATTRIBUTE_USERADDINFO, ATTRIBUTE_USERADDINFO_VALUE_UPDATE);
writeUserInfo(dbc, userId, entry.getKey(), newValue);
}
}
}
}
// loop over all entries of the new additional infos
Iterator> itNewEntries = additionalInfo.entrySet().iterator();
while (itNewEntries.hasNext()) {
Entry entry = itNewEntries.next();
if ((entry.getKey() != null) && (entry.getValue() != null)) {
// entry doews not exist in the existing additional infos -> create a new one
if (!existingInfos.containsKey(entry.getKey())) {
dbc.setAttribute(ATTRIBUTE_USERADDINFO, ATTRIBUTE_USERADDINFO_VALUE_INSERT);
writeUserInfo(dbc, userId, entry.getKey(), entry.getValue());
}
}
}
} finally {
lock.unlock();
}
}
}