Java tutorial
/* * This library is part of OpenCms - * the Open Source Content Management System * * Copyright (c) Alkacon Software GmbH (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, 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.jpa; 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.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.db.generic.CmsUserQueryBuilder; import org.opencms.db.jpa.persistence.CmsDAOGroupUsers; import org.opencms.db.jpa.persistence.CmsDAOGroupUsers.CmsDAOGroupUsersPK; import org.opencms.db.jpa.persistence.CmsDAOGroups; import org.opencms.db.jpa.persistence.CmsDAOOfflineAccessControl; import org.opencms.db.jpa.persistence.CmsDAOOnlineAccessControl; import org.opencms.db.jpa.persistence.CmsDAOUserData; import org.opencms.db.jpa.persistence.CmsDAOUsers; import org.opencms.db.jpa.persistence.I_CmsDAOAccessControl; 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.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 javax.persistence.NoResultException; import javax.persistence.PersistenceException; import javax.persistence.Query; import org.apache.commons.logging.Log; /** * JPA database server implementation of the user driver methods.<p> * * @since 8.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"; /** Query key. */ private static final String C_ACCESS_READ_ENTRIES_1 = "C_ACCESS_READ_ENTRIES_1"; /** Query key. */ private static final String C_ACCESS_READ_ENTRY_2 = "C_ACCESS_READ_ENTRY_2"; /** Query key. */ private static final String C_ACCESS_REMOVE_2 = "C_ACCESS_REMOVE_2"; /** Query key. */ private static final String C_ACCESS_REMOVE_ALL_1 = "C_ACCESS_REMOVE_ALL_1"; /** Query key. */ private static final String C_ACCESS_REMOVE_ALL_FOR_PRINCIPAL_1 = "C_ACCESS_REMOVE_ALL_FOR_PRINCIPAL_1"; /** Query key. */ private static final String C_ACCESS_UPDATE_5 = "C_ACCESS_UPDATE_5"; /** Query key. */ private static final String C_GROUPS_CHECK_BY_NAME_2 = "C_GROUPS_CHECK_BY_NAME_2"; /** Query key. */ private static final String C_GROUPS_DELETE_GROUP_2 = "C_GROUPS_DELETE_GROUP_2"; /** Query key. */ private static final String C_GROUPS_GET_ALL_USERS_OF_GROUP_2 = "C_GROUPS_GET_ALL_USERS_OF_GROUP_2"; /** Query key. */ private static final String C_GROUPS_GET_CHILD_1 = "C_GROUPS_GET_CHILD_1"; /** Query key. */ private static final String C_GROUPS_GET_GROUPS_0 = "C_GROUPS_GET_GROUPS_0"; /** Query key. */ private static final String C_GROUPS_GET_GROUPS_OF_USER_1 = "C_GROUPS_GET_GROUPS_OF_USER_1"; /** Query key. */ private static final String C_GROUPS_GET_USERS_OF_GROUP_2 = "C_GROUPS_GET_USERS_OF_GROUP_2"; /** Query key. */ private static final String C_GROUPS_GROUP_OU_EQUALS_1 = "C_GROUPS_GROUP_OU_EQUALS_1"; /** Query key. */ private static final String C_GROUPS_GROUP_OU_LIKE_1 = "C_GROUPS_GROUP_OU_LIKE_1"; /** Query key. */ private static final String C_GROUPS_ORDER_0 = "C_GROUPS_ORDER_0"; /** Query key. */ private static final String C_GROUPS_READ_BY_NAME_2 = "C_GROUPS_READ_BY_NAME_2"; /** Query key. */ private static final String C_GROUPS_SELECT_GROUPS_1 = "C_GROUPS_SELECT_GROUPS_1"; /** Query key. */ private static final String C_GROUPS_SELECT_ROLES_1 = "C_GROUPS_SELECT_ROLES_1"; /** Query key. */ private static final String C_GROUPS_USER_IN_GROUP_2 = "C_GROUPS_USER_IN_GROUP_2"; /** Query key. */ private static final String C_GROUPS_WRITE_GROUP_4 = "C_GROUPS_WRITE_GROUP_4"; /** Query key. */ private static final String C_USERDATA_DELETE_2 = "C_USERDATA_DELETE_2"; /** Query key. */ private static final String C_USERDATA_READ_1 = "C_USERDATA_READ_1"; /** Query key. */ private static final String C_USERDATA_UPDATE_4 = "C_USERDATA_UPDATE_4"; /** Query key. */ private static final String C_USERS_CHECK_BY_NAME_2 = "C_USERS_CHECK_BY_NAME_2"; /** Query key. */ private static final String C_USERS_DELETE_2 = "C_USERS_DELETE_2"; /** Query key. */ private static final String C_USERS_GET_USERS_FOR_ORGUNIT_1 = "C_USERS_GET_USERS_FOR_ORGUNIT_1"; /** Query key. */ private static final String C_USERS_GET_WEBUSERS_FOR_ORGUNIT_1 = "C_USERS_GET_WEBUSERS_FOR_ORGUNIT_1"; /** Query key. */ private static final String C_USERS_READ_BY_NAME_2 = "C_USERS_READ_BY_NAME_2"; /** Query key. */ private static final String C_USERS_READ_WITH_PWD_3 = "C_USERS_READ_WITH_PWD_3"; /** Query key. */ private static final String C_USERS_SET_ORGUNIT_2 = "C_USERS_SET_ORGUNIT_2"; /** Query key. */ private static final String C_USERS_SET_PWD_3 = "C_USERS_SET_PWD_3"; /** Query key. */ private static final String C_USERS_WRITE_2 = "C_USERS_WRITE_2"; /** Query key. */ private static final String C_USERS_WRITE_6 = "C_USERS_WRITE_6"; /** The log object for this class. */ private static final Log LOG = CmsLog.getLog(org.opencms.db.jpa.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; /** 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<String> vfsPaths = new ArrayList<String>(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.<String, Object>singletonMap("project", project)); } catch (CmsDbEntryNotFoundException e) { // ignore } finally { // fire a resource modification event Map<String, Object> data = new HashMap<String, Object>(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 { long userCount = -1; try { CmsUserQueryBuilder builder = new CmsJpaUserQueryBuilder(); CmsPair<String, List<Object>> queryData = builder.createUserQuery(searchParams, true); Query q = m_sqlManager.createQueryWithParametersFromJPQL(dbc, queryData.getFirst(), queryData.getSecond()); Number number = (Number) q.getSingleResult(); userCount = number.intValue(); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } return userCount; } /** * @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 { try { I_CmsDAOAccessControl pac = CmsProject.isOnlineProject(project.getUuid()) ? new CmsDAOOnlineAccessControl() : new CmsDAOOfflineAccessControl(); pac.setResourceId(resource.toString()); pac.setPrincipalId(principal.toString()); pac.setAccessAllowed(allowed); pac.setAccessDenied(denied); pac.setAccessFlags(flags); m_sqlManager.persist(dbc, pac); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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; 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(); } CmsDAOGroups g = new CmsDAOGroups(); g.setGroupId(groupId.toString()); g.setParentGroupId(parentId.toString()); g.setGroupName(CmsOrganizationalUnit.getSimpleName(groupFqn)); g.setGroupDescription(m_sqlManager.validateEmpty(description)); g.setGroupFlags(flags); g.setGroupOu(CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn)); m_sqlManager.persist(dbc, g); group = new CmsGroup(groupId, parentId, groupFqn, description, flags); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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<String, Object> additionalInfos) throws CmsDataAccessException { 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 { CmsDAOUsers u = new CmsDAOUsers(); u.setUserId(id.toString()); u.setUserName(CmsOrganizationalUnit.getSimpleName(userFqn)); u.setUserPassword(password); u.setUserFirstName(m_sqlManager.validateEmpty(firstname)); u.setUserLastName(m_sqlManager.validateEmpty(lastname)); u.setUserEmail(m_sqlManager.validateEmpty(email)); u.setUserLastLogin(lastlogin); u.setUserFlags(flags); u.setUserOu(CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn)); u.setUserDateCreated((dateCreated == 0 ? System.currentTimeMillis() : dateCreated)); m_sqlManager.persist(dbc, u); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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 { // check if user is already in group if (!internalValidateUserInGroup(dbc, userId, groupId)) { // if not, add this user to the group try { CmsDAOGroupUsers gu = new CmsDAOGroupUsers(); gu.setGroupId(groupId.toString()); gu.setUserId(userId.toString()); // flag field is not used yet gu.setGroupUserFlags(0); m_sqlManager.persist(dbc, gu); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } } /** * Possibly there is no need for this method.<p> * * TODO: check if this method is used somewhere * TODO: remove this method * * @param dbc the db context * @param project the project * @param resource the resource's UUID * * @throws CmsDataAccessException if something goes wrong */ public void deleteAccessControlEntries(CmsDbContext dbc, CmsProject project, CmsUUID resource) throws CmsDataAccessException { removeAccessControlEntries(dbc, project, resource); } /** * @see org.opencms.db.I_CmsUserDriver#deleteGroup(org.opencms.db.CmsDbContext, java.lang.String) */ public void deleteGroup(CmsDbContext dbc, String groupFqn) throws CmsDataAccessException { try { Query q = m_sqlManager.createQuery(dbc, C_GROUPS_DELETE_GROUP_2); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(groupFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn)); @SuppressWarnings("unchecked") List<CmsDAOGroups> res = q.getResultList(); for (CmsDAOGroups g : res) { m_sqlManager.remove(dbc, g); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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())); } 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); try { Query q = m_sqlManager.createQuery(dbc, C_USERS_DELETE_2); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(userFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn)); @SuppressWarnings("unchecked") List<CmsDAOUsers> res = q.getResultList(); for (CmsDAOUsers u : res) { m_sqlManager.remove(dbc, u); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } // 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 { try { Query q = m_sqlManager.createQuery(dbc, C_USERDATA_READ_1); q.setParameter(1, userId.toString()); @SuppressWarnings("unchecked") List<CmsDAOUserData> res = q.getResultList(); for (CmsDAOUserData ud : res) { m_sqlManager.remove(dbc, ud); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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 { try { CmsDAOGroupUsersPK pk = new CmsDAOGroupUsersPK(); pk.setGroupId(groupId.toString()); pk.setUserId(userId.toString()); CmsDAOGroupUsers gu = m_sqlManager.find(dbc, CmsDAOGroupUsers.class, pk); if (gu != null) { m_sqlManager.remove(dbc, gu); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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 { boolean result = false; try { Query q = m_sqlManager.createQuery(dbc, C_GROUPS_CHECK_BY_NAME_2); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(groupFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn)); int count = CmsDataTypeUtil.numberToInt((Number) q.getSingleResult()); if (count > 0) { result = true; } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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 { boolean result = false; try { Query q = m_sqlManager.createQuery(dbc, C_USERS_CHECK_BY_NAME_2); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(userFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn)); int count = CmsDataTypeUtil.numberToInt((Number) q.getSingleResult()); if (count > 0) { result = true; } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } return result; } /** * @see org.opencms.db.I_CmsUserDriver#fillDefaults(org.opencms.db.CmsDbContext) */ public void fillDefaults(CmsDbContext dbc) throws CmsInitException { try { internalCreateDefaultGroups(dbc, "", "", false); } 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<CmsGroup> 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<CmsGroup> groups = new ArrayList<CmsGroup>(); try { // create query Query q = m_sqlManager.createQueryFromJPQL(dbc, sqlQuery); q.setParameter(1, ouFqn); q.setParameter(2, Integer.valueOf(I_CmsPrincipal.FLAG_GROUP_ROLE)); @SuppressWarnings("unchecked") List<CmsDAOGroups> res = q.getResultList(); // create new Cms group objects for (CmsDAOGroups g : res) { groups.add(internalCreateGroup(g)); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } return groups; } /** * @see org.opencms.db.I_CmsUserDriver#getOrganizationalUnits(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, boolean) */ public List<CmsOrganizationalUnit> getOrganizationalUnits(CmsDbContext dbc, CmsOrganizationalUnit parent, boolean includeChildren) throws CmsDataAccessException { List<CmsOrganizationalUnit> orgUnits = new ArrayList<CmsOrganizationalUnit>(); try { CmsResource parentFolder = internalOrgUnitFolder(dbc, parent); Iterator<CmsResource> 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<CmsResource> getResourcesForOrganizationalUnit(CmsDbContext dbc, CmsOrganizationalUnit orgUnit) throws CmsDataAccessException { List<CmsResource> result = new ArrayList<CmsResource>(); try { CmsResource ouResource = m_driverManager.readResource(dbc, ORGUNIT_BASE_FOLDER + orgUnit.getName(), CmsResourceFilter.ALL); Iterator<String> 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<CmsUser> getUsers(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, boolean recursive) throws CmsDataAccessException { List<CmsUser> users = new ArrayList<CmsUser>(); try { Query q; // create statement if (orgUnit.hasFlagWebuser()) { q = m_sqlManager.createQuery(dbc, C_USERS_GET_WEBUSERS_FOR_ORGUNIT_1); } else { q = m_sqlManager.createQuery(dbc, C_USERS_GET_USERS_FOR_ORGUNIT_1); } String param = CmsOrganizationalUnit.SEPARATOR + orgUnit.getName(); if (recursive) { param += "%"; } q.setParameter(1, param); @SuppressWarnings("unchecked") List<CmsDAOUsers> res = q.getResultList(); // create new Cms group objects for (CmsDAOUsers u : res) { users.add(internalCreateUser(dbc, u)); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } return users; } /** * @see org.opencms.db.I_CmsUserDriver#getUsersWithoutAdditionalInfo(org.opencms.db.CmsDbContext, org.opencms.security.CmsOrganizationalUnit, boolean) */ public List<CmsUser> getUsersWithoutAdditionalInfo(CmsDbContext dbc, CmsOrganizationalUnit orgUnit, boolean recursive) throws CmsDataAccessException { //TODO: disable fetching of additional infos return getUsers(dbc, orgUnit, recursive); } /** * @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<String> 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_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 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<CmsAccessControlEntry> 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<CmsAccessControlEntry> readAccessControlEntries(CmsDbContext dbc, CmsProject project, CmsUUID resource, boolean inheritedOnly) throws CmsDataAccessException { List<CmsAccessControlEntry> aceList = new ArrayList<CmsAccessControlEntry>(); try { Query q = m_sqlManager.createQuery(dbc, project, C_ACCESS_READ_ENTRIES_1); String resId = resource.toString(); q.setParameter(1, resId); @SuppressWarnings("unchecked") List<I_CmsDAOAccessControl> res = q.getResultList(); // create new CmsAccessControlEntry and add to list for (I_CmsDAOAccessControl ac : res) { CmsAccessControlEntry ace = internalCreateAce(ac); if (inheritedOnly && !ace.isInheriting()) { continue; } if (inheritedOnly && ace.isInheriting()) { ace.setFlags(CmsAccessControlEntry.ACCESS_FLAGS_INHERITED); } aceList.add(ace); } return aceList; } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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; try { Query q = m_sqlManager.createQuery(dbc, project, C_ACCESS_READ_ENTRY_2); q.setParameter(1, resource.toString()); q.setParameter(2, principal.toString()); try { I_CmsDAOAccessControl ac = (I_CmsDAOAccessControl) q.getSingleResult(); ace = internalCreateAce(ac); } catch (NoResultException e) { throw new CmsDbEntryNotFoundException( Messages.get().container(Messages.ERR_NO_ACE_FOUND_2, resource, principal)); } return ace; } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @see org.opencms.db.I_CmsUserDriver#readChildGroups(org.opencms.db.CmsDbContext, java.lang.String) */ public List<CmsGroup> readChildGroups(CmsDbContext dbc, String parentGroupFqn) throws CmsDataAccessException { List<CmsGroup> children = new ArrayList<CmsGroup>(); 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 Query q = m_sqlManager.createQuery(dbc, C_GROUPS_GET_CHILD_1); q.setParameter(1, parent.getId().toString()); @SuppressWarnings("unchecked") List<CmsDAOGroups> res = q.getResultList(); // create new Cms group objects for (CmsDAOGroups g : res) { children.add(internalCreateGroup(g)); } } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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; try { CmsDAOGroups g = m_sqlManager.find(dbc, CmsDAOGroups.class, groupId.toString()); if (g != null) { group = internalCreateGroup(g); } 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 (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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; try { Query q = m_sqlManager.createQuery(dbc, C_GROUPS_READ_BY_NAME_2); // read the group from the database q.setParameter(1, CmsOrganizationalUnit.getSimpleName(groupFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn)); try { CmsDAOGroups g = (CmsDAOGroups) q.getSingleResult(); group = internalCreateGroup(g); } catch (NoResultException e) { 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 (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } return group; } /** * @see org.opencms.db.I_CmsUserDriver#readGroupsOfUser(CmsDbContext, CmsUUID, String, boolean, String, boolean) */ public List<CmsGroup> 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<CmsGroup> groups = new ArrayList<CmsGroup>(); try { Query q = m_sqlManager.createQueryFromJPQL(dbc, sqlQuery); // get all all groups of the user q.setParameter(1, userId.toString()); q.setParameter(2, ouFqnParam); q.setParameter(3, Integer.valueOf(I_CmsPrincipal.FLAG_GROUP_ROLE)); @SuppressWarnings("unchecked") List<Object[]> res = q.getResultList(); for (Object[] o : res) { groups.add(internalCreateGroup(((CmsDAOGroups) o[0]))); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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 { CmsUser user = null; try { CmsDAOUsers u = m_sqlManager.find(dbc, CmsDAOUsers.class, id.toString()); if (u != null) { user = internalCreateUser(dbc, u); } 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); } return user; } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @see org.opencms.db.I_CmsUserDriver#readUser(org.opencms.db.CmsDbContext, java.lang.String) */ public CmsUser readUser(CmsDbContext dbc, String userFqn) throws CmsDataAccessException { CmsUser user = null; try { Query q = m_sqlManager.createQuery(dbc, C_USERS_READ_BY_NAME_2); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(userFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn)); try { CmsDAOUsers u = (CmsDAOUsers) q.getSingleResult(); user = internalCreateUser(dbc, u); } catch (NoResultException e) { 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 (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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, CmsPasswordEncryptionException { CmsUser user = null; try { Query q = m_sqlManager.createQuery(dbc, C_USERS_READ_WITH_PWD_3); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(userFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn)); q.setParameter(3, OpenCms.getPasswordHandler().digest(password)); try { CmsDAOUsers u = (CmsDAOUsers) q.getSingleResult(); user = internalCreateUser(dbc, u); } catch (NoResultException e) { 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); } return user; } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @see org.opencms.db.I_CmsUserDriver#readUserInfos(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID) */ public Map<String, Object> readUserInfos(CmsDbContext dbc, CmsUUID userId) throws CmsDataAccessException { Map<String, Object> infos = new HashMap<String, Object>(); try { Query q = m_sqlManager.createQuery(dbc, C_USERDATA_READ_1); q.setParameter(1, userId.toString()); @SuppressWarnings("unchecked") List<CmsDAOUserData> res = q.getResultList(); // read the infos for (CmsDAOUserData ud : res) { String key = ud.getDataKey(); String type = ud.getDataType(); byte[] value = ud.getDataValue(); // deserialize Object data = null; try { if (LOG.isDebugEnabled()) { LOG.debug(org.opencms.db.generic.Messages.get().getBundle() .key(org.opencms.db.generic.Messages.LOG_DBG_READUSERINFO_2, key, type)); if (value != null) { try { LOG.debug(org.opencms.db.generic.Messages.get().getBundle().key( org.opencms.db.generic.Messages.LOG_DBG_READUSERINFO_VALUE_1, new String(value))); } catch (Exception e) { // noop } } else { LOG.debug(org.opencms.db.generic.Messages.get().getBundle() .key(org.opencms.db.generic.Messages.LOG_DBG_READUSERINFO_VALUE_1, null)); } } data = CmsDataTypeUtil.dataDeserialize(value, type); } catch (Exception e) { LOG.warn(Messages.get().container(Messages.ERR_READING_ADDITIONAL_INFO_1, userId.toString()) .key(), e); } if (key != null) { infos.put(key, data); } } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } return infos; } /** * @see org.opencms.db.I_CmsUserDriver#readUsersOfGroup(CmsDbContext, String, boolean) */ public List<CmsUser> 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<CmsUser> users = new ArrayList<CmsUser>(); try { Query q = m_sqlManager.createQuery(dbc, sqlQuery); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(groupFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(groupFqn)); @SuppressWarnings("unchecked") List<CmsDAOUsers> res = q.getResultList(); for (CmsDAOUsers u : res) { users.add(internalCreateUser(dbc, u)); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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 { try { Query q = m_sqlManager.createQuery(dbc, project, C_ACCESS_REMOVE_ALL_1); q.setParameter(1, resource.toString()); @SuppressWarnings("unchecked") List<I_CmsDAOAccessControl> res = q.getResultList(); for (I_CmsDAOAccessControl ac : res) { m_sqlManager.remove(dbc, ac); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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 { try { Query q = m_sqlManager.createQuery(dbc, onlineProject, C_ACCESS_REMOVE_ALL_FOR_PRINCIPAL_1); q.setParameter(1, principal.toString()); @SuppressWarnings("unchecked") List<I_CmsDAOAccessControl> res = q.getResultList(); for (I_CmsDAOAccessControl ac : res) { m_sqlManager.remove(dbc, ac); } q = m_sqlManager.createQuery(dbc, project, C_ACCESS_REMOVE_ALL_FOR_PRINCIPAL_1); q.setParameter(1, principal.toString()); @SuppressWarnings("unchecked") List<I_CmsDAOAccessControl> res1 = q.getResultList(); for (I_CmsDAOAccessControl ac : res1) { m_sqlManager.remove(dbc, ac); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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 { try { Query q = m_sqlManager.createQuery(dbc, project, C_ACCESS_REMOVE_2); q.setParameter(1, resource.toString()); q.setParameter(2, principal.toString()); @SuppressWarnings("unchecked") List<I_CmsDAOAccessControl> res = q.getResultList(); for (I_CmsDAOAccessControl ac : res) { m_sqlManager.remove(dbc, ac); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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<String> vfsPaths = new ArrayList<String>(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.<String, Object>singletonMap("project", project)); } catch (CmsDbEntryNotFoundException e) { // ignore } finally { Map<String, Object> data = new HashMap<String, Object>(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<CmsUser> searchUsers(CmsDbContext dbc, CmsUserSearchParameters searchParams) throws CmsDataAccessException { List<CmsUser> users = new ArrayList<CmsUser>(); try { CmsUserQueryBuilder builder = new CmsJpaUserQueryBuilder(); CmsPair<String, List<Object>> queryData = builder.createUserQuery(searchParams, false); Query q = m_sqlManager.createQueryWithParametersFromJPQL(dbc, queryData.getFirst(), queryData.getSecond()); // paging is done here, not in the query string q.setMaxResults(searchParams.getPageSize()); q.setFirstResult(searchParams.getPageSize() * (searchParams.getPage() - 1)); List<?> res = q.getResultList(); // create new Cms group objects for (Object singleRes : res) { CmsDAOUsers daoUser = null; if (singleRes instanceof Object[]) { Object[] resArray = (Object[]) singleRes; daoUser = (CmsDAOUsers) resArray[0]; } else { daoUser = (CmsDAOUsers) singleRes; } users.add(internalCreateUser(dbc, daoUser)); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } 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 { try { Query q = m_sqlManager.createQuery(dbc, C_USERS_SET_ORGUNIT_2); q.setParameter(1, user.getId().toString()); @SuppressWarnings("unchecked") List<CmsDAOUsers> res = q.getResultList(); for (CmsDAOUsers u : res) { u.setUserOu((orgUnit == null ? null : CmsOrganizationalUnit.SEPARATOR + orgUnit.getName())); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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 { try { Query q = m_sqlManager.createQuery(dbc, project, C_ACCESS_READ_ENTRY_2); q.setParameter(1, acEntry.getResource().toString()); q.setParameter(2, acEntry.getPrincipal().toString()); try { @SuppressWarnings("unused") I_CmsDAOAccessControl ac = (I_CmsDAOAccessControl) q.getSingleResult(); // otherwise update the already existing entry q = m_sqlManager.createQuery(dbc, project, C_ACCESS_UPDATE_5); q.setParameter(1, acEntry.getResource().toString()); q.setParameter(2, acEntry.getPrincipal().toString()); @SuppressWarnings("unchecked") List<I_CmsDAOAccessControl> res = q.getResultList(); for (I_CmsDAOAccessControl a : res) { a.setAccessAllowed(acEntry.getAllowedPermissions()); a.setAccessDenied(acEntry.getDeniedPermissions()); a.setAccessFlags(acEntry.getFlags()); } } catch (NoResultException e) { m_driverManager.getUserDriver(dbc).createAccessControlEntry(dbc, project, acEntry.getResource(), acEntry.getPrincipal(), acEntry.getAllowedPermissions(), acEntry.getDeniedPermissions(), acEntry.getFlags()); return; } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @see org.opencms.db.I_CmsUserDriver#writeGroup(org.opencms.db.CmsDbContext, org.opencms.file.CmsGroup) */ public void writeGroup(CmsDbContext dbc, CmsGroup group) throws CmsDataAccessException { if (group != null) { try { Query q = m_sqlManager.createQuery(dbc, C_GROUPS_WRITE_GROUP_4); q.setParameter(1, group.getId().toString()); @SuppressWarnings("unchecked") List<CmsDAOGroups> res = q.getResultList(); for (CmsDAOGroups g : res) { g.setGroupDescription(m_sqlManager.validateEmpty(group.getDescription())); g.setGroupFlags(group.getFlags()); g.setParentGroupId(group.getParentId().toString()); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } 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().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 { // 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 { Query q = m_sqlManager.createQuery(dbc, C_USERS_SET_PWD_3); q.setParameter(1, CmsOrganizationalUnit.getSimpleName(userFqn)); q.setParameter(2, CmsOrganizationalUnit.SEPARATOR + CmsOrganizationalUnit.getParentFqn(userFqn)); @SuppressWarnings("unchecked") List<CmsDAOUsers> res = q.getResultList(); for (CmsDAOUsers u : res) { u.setUserPassword(pwd); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * @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); // if the login attribute is set, do only update the last login information of this user // otherweise write the complete user data if (CmsStringUtil.isNotEmpty(att_login)) { try { Query q = m_sqlManager.createQuery(dbc, C_USERS_WRITE_2); // write data to database q.setParameter(1, Long.valueOf(user.getLastlogin())); q.setParameter(2, String.valueOf(user.getId().toString())); q.executeUpdate(); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } else { try { Query q = m_sqlManager.createQuery(dbc, C_USERS_WRITE_6); // write data to database q.setParameter(1, user.getId().toString()); @SuppressWarnings("unchecked") List<CmsDAOUsers> res = q.getResultList(); for (CmsDAOUsers u : res) { u.setUserFirstName(m_sqlManager.validateEmpty(user.getFirstname())); u.setUserLastName(m_sqlManager.validateEmpty(user.getLastname())); u.setUserEmail(m_sqlManager.validateEmpty(user.getEmail())); u.setUserLastLogin(user.getLastlogin()); u.setUserFlags(user.getFlags()); } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } 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); } } protected Query createQueryFromStringAndParams(String queryString, List<Object> queryParams) { return null; } /** * Returns a sql query to select groups.<p> * * @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; } /** * Internal helper method to create an access control entry from a database record.<p> * * @param ac the access control * * @return a new {@link CmsAccessControlEntry} initialized with the values from the current database record */ protected CmsAccessControlEntry internalCreateAce(I_CmsDAOAccessControl ac) { return internalCreateAce(ac, new CmsUUID(ac.getResourceId())); } /** * Internal helper method to create an access control entry from a database record.<p> * * @param ac the access control * @param newId the id of the new access control entry * * @return a new {@link CmsAccessControlEntry} initialized with the values from the current database record */ protected CmsAccessControlEntry internalCreateAce(I_CmsDAOAccessControl ac, CmsUUID newId) { return new CmsAccessControlEntry(newId, new CmsUUID(ac.getPrincipalId()), ac.getAccessAllowed(), ac.getAccessDenied(), ac.getAccessFlags()); } /** * Creates the default groups and user for the given organizational unit.<p> * * @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(); try { // only do something if really needed if ((CmsOrganizationalUnit.getParentFqn(ouFqn) != null) || ((CmsOrganizationalUnit.getParentFqn(ouFqn) == null) && !existsGroup(dbc, rootAdminRole))) { // create the roles in the given ou Iterator<CmsRole> itRoles = CmsRole.getSystemRoles().iterator(); while (itRoles.hasNext()) { CmsRole role = itRoles.next(); if (webuser && (role != CmsRole.ACCOUNT_MANAGER)) { // if webuser ou and not account manager role continue; } if (role.isOrganizationalUnitIndependent() && (CmsOrganizationalUnit.getParentFqn(ouFqn) != null)) { // 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 ((role == CmsRole.WORKPLACE_USER) || (role == CmsRole.PROJECT_MANAGER)) { flags |= I_CmsPrincipal.FLAG_GROUP_PROJECT_USER; } if (role == CmsRole.PROJECT_MANAGER) { flags |= I_CmsPrincipal.FLAG_GROUP_PROJECT_MANAGER; } createGroup(dbc, CmsUUID.getConstantUUID(groupName), groupName, "A system role group", flags, null); } if ((CmsOrganizationalUnit.getParentFqn(ouFqn) == null) && CmsLog.INIT.isInfoEnabled()) { CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_SYSTEM_ROLES_CREATED_0)); } } } catch (CmsException e) { if ((CmsOrganizationalUnit.getParentFqn(ouFqn) == null) && 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 (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 projectmanagersGroup = ouFqn + OpenCms.getDefaultUsers().getGroupProjectmanagers(); 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 (CmsOrganizationalUnit.getParentFqn(ouFqn) == null) { // check the flags of existing groups, for compatibility checks internalUpdateRoleGroup(dbc, administratorsGroup, CmsRole.ROOT_ADMIN); internalUpdateRoleGroup(dbc, usersGroup, CmsRole.WORKPLACE_USER.forOrgUnit(ouFqn)); internalUpdateRoleGroup(dbc, projectmanagersGroup, CmsRole.PROJECT_MANAGER.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 | I_CmsPrincipal.FLAG_GROUP_PROJECT_USER | CmsRole.WORKPLACE_USER.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 | I_CmsPrincipal.FLAG_GROUP_PROJECT_MANAGER | flags, null); parentGroup = ouFqn + OpenCms.getDefaultUsers().getGroupUsers(); createGroup(dbc, CmsUUID.getConstantUUID(projectmanagersGroup), projectmanagersGroup, CmsMacroResolver.localizedKeyMacro(Messages.GUI_DEFAULTGROUP_ROOT_PROJMANS_DESCRIPTION_0, null), I_CmsPrincipal.FLAG_ENABLED | I_CmsPrincipal.FLAG_GROUP_PROJECT_MANAGER | I_CmsPrincipal.FLAG_GROUP_PROJECT_USER | CmsRole.PROJECT_MANAGER.getVirtualGroupFlags(), parentGroup); CmsUser guest = createUser(dbc, CmsUUID.getConstantUUID(guestUser), guestUser, OpenCms.getPasswordHandler().digest(""), " ", " ", " ", 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 g the group * * @return CmsGroup the new CmsGroup object */ protected CmsGroup internalCreateGroup(CmsDAOGroups g) { String ou = CmsOrganizationalUnit.removeLeadingSeparator(g.getGroupOu()); String description = g.getGroupDescription(); return new CmsGroup(new CmsUUID(g.getGroupId()), new CmsUUID(g.getParentGroupId()), ou + g.getGroupName(), description, g.getGroupFlags()); } /** * Returns the organizational unit represented by the given resource.<p> * * @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.<p> * * @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.<String, Object>singletonMap(I_CmsEventListener.KEY_RESOURCE, resource))); return resource; } /** * Semi-constructor to create a {@link CmsUser} instance from a JDBC result set.<p> * * @param dbc the current database context * @param u the user * * @return the new CmsUser object * * @throws CmsDataAccessException if there is an error in de-serializing the user info */ protected CmsUser internalCreateUser(CmsDbContext dbc, CmsDAOUsers u) throws CmsDataAccessException { String userName = u.getUserName(); String ou = CmsOrganizationalUnit.removeLeadingSeparator(u.getUserOu()); CmsUUID userId = new CmsUUID(u.getUserId()); if (LOG.isDebugEnabled()) { LOG.debug(Messages.get().getBundle().key(Messages.LOG_DBG_CREATE_USER_1, userName)); } Map<String, Object> info = readUserInfos(dbc, userId); return new CmsUser(userId, ou + userName, u.getUserPassword(), u.getUserFirstName(), u.getUserLastName(), u.getUserEmail(), u.getUserLastLogin(), u.getUserFlags(), u.getUserDateCreated(), info); } /** * Deletes a resource representing a organizational unit, offline AND online.<p> * * @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.<String, Object>singletonMap( I_CmsEventListener.KEY_RESOURCES, Collections.singletonList(resource)))); OpenCms.fireCmsEvent(new CmsEvent(I_CmsEventListener.EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, Collections.<String, Object>singletonMap(I_CmsEventListener.KEY_RESOURCE, resource))); } /** * Deletes an additional user info.<p> * @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 { try { Query q = m_sqlManager.createQuery(dbc, C_USERDATA_DELETE_2); // write data to database q.setParameter(1, userId.toString()); q.setParameter(2, key); q.executeUpdate(); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } } /** * Returns the folder for the given organizational units, or the base folder if <code>null</code>.<p> * * The base folder will be created if it does not exist.<p> * * @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.<p> * * @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<String> internalResourcesForOrgUnit(CmsDbContext dbc, CmsResource ouResource) throws CmsException { List<CmsRelation> relations = m_driverManager.getRelationsForResource(dbc, ouResource, CmsRelationFilter.TARGETS); List<String> paths = new ArrayList<String>(); Iterator<CmsRelation> it = relations.iterator(); while (it.hasNext()) { CmsRelation relation = it.next(); paths.add(relation.getTargetPath()); } return paths; } /** * Updates a group to a virtual group.<p> * * @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<CmsUser> 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()); } } /** * Updates additional user info.<p> * @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 { try { Query q = m_sqlManager.createQuery(dbc, C_USERDATA_UPDATE_4); // write data to database q.setParameter(1, CmsDataTypeUtil.dataSerialize(value)); q.setParameter(2, value.getClass().getName()); q.setParameter(3, userId.toString()); q.setParameter(4, key); q.executeUpdate(); } catch (PersistenceException e) { throw new CmsDbSqlException(Messages.get().container(Messages.ERR_GENERIC_SQL_1, C_USERDATA_UPDATE_4), e); } catch (IOException e) { throw new CmsDbIoException(Messages.get().container(Messages.ERR_SERIALIZING_USER_DATA_1, userId), e); } } /** * Validates the given root path to be in the scope of the resources of the given organizational unit.<p> * * @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<String> 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.<p> * * @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; try { Query q = m_sqlManager.createQuery(dbc, C_GROUPS_USER_IN_GROUP_2); q.setParameter(1, groupId.toString()); q.setParameter(2, userId.toString()); try { @SuppressWarnings("unused") CmsDAOGroupUsers gu = (CmsDAOGroupUsers) q.getSingleResult(); userInGroup = true; } catch (NoResultException e) { // do nothing } } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } return userInGroup; } /** * Writes a property for an organizational unit resource, online AND offline.<p> * * @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.<p> * @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 { try { CmsDAOUserData u = new CmsDAOUserData(); u.setUserId(userId.toString()); u.setDataKey(key); u.setDataValue(CmsDataTypeUtil.dataSerialize(value)); u.setDataType(value.getClass().getName()); m_sqlManager.persist(dbc, u); } catch (PersistenceException e) { throw new CmsDataAccessException(Messages.get().container(Messages.ERR_JPA_PERSITENCE, e), e); } catch (IOException e) { throw new CmsDbIoException(Messages.get().container(Messages.ERR_SERIALIZING_USER_DATA_1, userId), e); } } /** * Updates the user additional information map.<p> * * @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<String, Object> additionalInfo) throws CmsDataAccessException { // get the map of existing additional infos to compare it new additional infos Map<String, Object> existingInfos = readUserInfos(dbc, userId); // loop over all entries of the existing additional infos for (Map.Entry<String, Object> entry : existingInfos.entrySet()) { 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 for (Map.Entry<String, Object> entry : additionalInfo.entrySet()) { if ((entry.getKey() != null) && (entry.getValue() != null)) { // entry does 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()); } } } } }