/* * Copyright (C) 2005 Alfresco, Inc. * * Licensed under the Mozilla Public License version 1.1 * with a permitted attribution clause. You may obtain a * copy of the License at * * http://www.alfresco.org/legal/license.txt * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, * either express or implied. See the License for the specific * language governing permissions and limitations under the * License. */ package org.alfresco.web.bean.wizard; import java.io.Serializable; import java.text.MessageFormat; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.ResourceBundle; import javax.faces.application.FacesMessage; import javax.faces.component.UIComponent; import javax.faces.context.FacesContext; import javax.faces.event.ActionEvent; import javax.faces.validator.ValidatorException; import javax.transaction.UserTransaction; import org.alfresco.config.ConfigService; import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.model.ContentModel; import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.InvalidNodeRefException; import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; import org.alfresco.service.cmr.security.AuthenticationService; import org.alfresco.service.cmr.security.OwnableService; import org.alfresco.service.cmr.security.PermissionService; import org.alfresco.service.cmr.security.PersonService; import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.QName; import org.alfresco.web.app.Application; import org.alfresco.web.app.ContextListener; import org.alfresco.web.app.context.UIContextService; import org.alfresco.web.bean.repository.Node; import org.alfresco.web.bean.repository.Repository; import org.alfresco.web.bean.users.UsersBean; import org.alfresco.web.config.ClientConfigElement; import org.alfresco.web.ui.common.Utils; import org.alfresco.web.ui.common.component.UIActionLink; import org.apache.log4j.Logger; /** * @author Kevin Roast */ public class NewUserWizard extends AbstractWizardBean { private static Logger logger = Logger.getLogger(NewUserWizard.class); private static final String WIZARD_TITLE_NEW_ID = "new_user_title"; private static final String WIZARD_DESC_NEW_ID = "new_user_desc"; private static final String WIZARD_TITLE_EDIT_ID = "new_user_title_edit"; private static final String WIZARD_DESC_EDIT_ID = "new_user_desc_edit"; private static final String STEP1_TITLE_ID = "new_user_step1_title"; private static final String STEP1_DESCRIPTION_ID = "new_user_step1_desc"; private static final String STEP2_TITLE_ID = "new_user_step2_title"; private static final String STEP2_DESCRIPTION_ID = "new_user_step2_desc"; private static final String FINISH_INSTRUCTION_ID = "new_user_finish_instruction"; private static final String ERROR = "error_person"; /** form variables */ private String firstName = null; private String lastName = null; private String userName = null; private String password = null; private String confirm = null; private String email = null; private String companyId = null; private String homeSpaceName = ""; private NodeRef homeSpaceLocation = null; /** AuthenticationService bean reference */ private AuthenticationService authenticationService; /** NamespaceService bean reference */ private NamespaceService namespaceService; /** PermissionService bean reference */ private PermissionService permissionService; /** PersonService bean reference */ private PersonService personService; /** OwnableService bean reference */ private OwnableService ownableService; /** ConfigService bean reference */ private ConfigService configService; /** action context */ private Node person = null; /** ref to system people folder */ private NodeRef peopleRef = null; /** ref to the company home space folder */ private NodeRef companyHomeSpaceRef = null; /** * @param authenticationService The AuthenticationService to set. */ public void setAuthenticationService(AuthenticationService authenticationService) { this.authenticationService = authenticationService; } /** * @param namespaceService The namespaceService to set. */ public void setNamespaceService(NamespaceService namespaceService) { this.namespaceService = namespaceService; } /** * @param permissionService The PermissionService to set. */ public void setPermissionService(PermissionService permissionService) { this.permissionService = permissionService; } /** * @param personService The person service. */ public void setPersonService(PersonService personService) { this.personService = personService; } /** * @param ownableService The ownableService to set. */ public void setOwnableService(OwnableService ownableService) { this.ownableService = ownableService; } /** * @param configService The ConfigService to set. */ public void setConfigService(ConfigService configService) { this.configService = configService; } /** * Initialises the wizard */ public void init() { super.init(); // reset all variables this.firstName = ""; this.lastName = ""; this.userName = ""; this.password = ""; this.confirm = ""; this.email = ""; this.companyId = ""; this.homeSpaceName = ""; this.homeSpaceLocation = getCompanyHomeSpace(); } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#populate() */ public void populate() { // set values for edit mode Map props = getPerson().getProperties(); this.firstName = (String) props.get("firstName"); this.lastName = (String) props.get("lastName"); this.userName = (String) props.get("userName"); this.password = ""; this.confirm = ""; this.email = (String) props.get("email"); this.companyId = (String) props.get("organizationId"); // calculate home space name and parent space Id from homeFolderId this.homeSpaceLocation = null; // default to Company root space this.homeSpaceName = ""; // default to none set below root NodeRef homeFolderRef = (NodeRef) props.get("homeFolder"); if (this.nodeService.exists(homeFolderRef) == true) { ChildAssociationRef childAssocRef = this.nodeService.getPrimaryParent(homeFolderRef); NodeRef parentRef = childAssocRef.getParentRef(); if (this.nodeService.getRootNode(Repository.getStoreRef()).equals(parentRef) == false) { this.homeSpaceLocation = parentRef; this.homeSpaceName = Repository.getNameForNode(nodeService, homeFolderRef); } else { this.homeSpaceLocation = homeFolderRef; } } if (logger.isDebugEnabled()) logger.debug("Edit user home space location: " + homeSpaceLocation + " home space name: " + homeSpaceName); } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#getWizardDescription() */ public String getWizardDescription() { if (this.editMode) { return Application.getMessage(FacesContext.getCurrentInstance(), WIZARD_DESC_EDIT_ID); } else { return Application.getMessage(FacesContext.getCurrentInstance(), WIZARD_DESC_NEW_ID); } } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#getWizardTitle() */ public String getWizardTitle() { if (this.editMode) { return Application.getMessage(FacesContext.getCurrentInstance(), WIZARD_TITLE_EDIT_ID); } else { return Application.getMessage(FacesContext.getCurrentInstance(), WIZARD_TITLE_NEW_ID); } } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#getStepTitle() */ public String getStepTitle() { String stepTitle = null; switch (this.currentStep) { case 1: { stepTitle = Application.getMessage(FacesContext.getCurrentInstance(), STEP1_TITLE_ID); break; } case 2: { stepTitle = Application.getMessage(FacesContext.getCurrentInstance(), STEP2_TITLE_ID); break; } case 3: { stepTitle = Application.getMessage(FacesContext.getCurrentInstance(), SUMMARY_TITLE_ID); break; } default: { stepTitle = ""; } } return stepTitle; } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#getStepDescription() */ public String getStepDescription() { String stepDesc = null; switch (this.currentStep) { case 1: { stepDesc = Application.getMessage(FacesContext.getCurrentInstance(), STEP1_DESCRIPTION_ID); break; } case 2: { stepDesc = Application.getMessage(FacesContext.getCurrentInstance(), STEP2_DESCRIPTION_ID); break; } case 3: { stepDesc = Application.getMessage(FacesContext.getCurrentInstance(), SUMMARY_DESCRIPTION_ID); break; } default: { stepDesc = ""; } } return stepDesc; } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#getStepInstructions() */ public String getStepInstructions() { String stepInstruction = null; switch (this.currentStep) { case 3: { stepInstruction = Application.getMessage(FacesContext.getCurrentInstance(), FINISH_INSTRUCTION_ID); break; } default: { stepInstruction = Application.getMessage(FacesContext.getCurrentInstance(), DEFAULT_INSTRUCTION_ID); } } return stepInstruction; } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#determineOutcomeForStep(int) */ protected String determineOutcomeForStep(int step) { String outcome = null; switch (step) { case 1: { outcome = "person-properties"; break; } case 2: { outcome = "user-properties"; break; } case 3: { outcome = "summary"; break; } default: { outcome = CANCEL_OUTCOME; } } return outcome; } /** * @see org.alfresco.web.bean.wizard.AbstractWizardBean#finish() */ public String finish() { String outcome = FINISH_OUTCOME; // TODO: implement create new Person object from specified details UserTransaction tx = null; try { FacesContext context = FacesContext.getCurrentInstance(); tx = Repository.getUserTransaction(context); tx.begin(); if (this.editMode) { // update the existing node in the repository NodeRef nodeRef = getPerson().getNodeRef(); Map props = this.nodeService.getProperties(nodeRef); props.put(ContentModel.PROP_USERNAME, this.userName); props.put(ContentModel.PROP_FIRSTNAME, this.firstName); props.put(ContentModel.PROP_LASTNAME, this.lastName); // calculate whether we need to move the old home space or create new NodeRef newHomeFolderRef; NodeRef oldHomeFolderRef = (NodeRef)this.nodeService.getProperty(nodeRef, ContentModel.PROP_HOMEFOLDER); boolean moveHomeSpace = false; boolean renameHomeSpace = false; if (oldHomeFolderRef != null && this.nodeService.exists(oldHomeFolderRef) == true) { // the original home folder ref exists so may need moving if it has been changed ChildAssociationRef childAssocRef = this.nodeService.getPrimaryParent(oldHomeFolderRef); NodeRef currentHomeSpaceLocation = childAssocRef.getParentRef(); if (this.homeSpaceName.length() != 0) { if (currentHomeSpaceLocation.equals(this.homeSpaceLocation) == false && oldHomeFolderRef.equals(this.homeSpaceLocation) == false && currentHomeSpaceLocation.equals(getCompanyHomeSpace()) == false) { moveHomeSpace = true; } String oldHomeSpaceName = Repository.getNameForNode(nodeService, oldHomeFolderRef); if (oldHomeSpaceName.equals(this.homeSpaceName) == false && oldHomeFolderRef.equals(this.homeSpaceLocation) == false) { renameHomeSpace = true; } } } if (logger.isDebugEnabled()) logger.debug("Moving space: " + moveHomeSpace + " and renaming space: " + renameHomeSpace); if (moveHomeSpace == false && renameHomeSpace == false) { if (this.homeSpaceLocation != null && this.homeSpaceName.length() != 0) { newHomeFolderRef = createHomeSpace(this.homeSpaceLocation.getId(), this.homeSpaceName, false); } else if (this.homeSpaceLocation != null) { // location selected but no home space name entered, // so the home ref should be set to the newly selected space newHomeFolderRef = this.homeSpaceLocation; // set the permissions for this space so the user can access it } else { // nothing selected - use Company Home by default newHomeFolderRef = getCompanyHomeSpace(); } } else { // either move, rename or both required if (moveHomeSpace == true) { this.nodeService.moveNode( oldHomeFolderRef, this.homeSpaceLocation, ContentModel.ASSOC_CONTAINS, this.nodeService.getPrimaryParent(oldHomeFolderRef).getQName()); } newHomeFolderRef = oldHomeFolderRef; // ref ID doesn't change if (renameHomeSpace == true) { // change HomeSpace node name this.nodeService.setProperty(newHomeFolderRef, ContentModel.PROP_NAME, this.homeSpaceName); } } props.put(ContentModel.PROP_HOMEFOLDER, newHomeFolderRef); props.put(ContentModel.PROP_EMAIL, this.email); props.put(ContentModel.PROP_ORGID, this.companyId); this.nodeService.setProperties(nodeRef, props); // TODO: RESET HomeSpace Ref found in top-level navigation bar! // NOTE: not need cos only admin can do this? } else { if (this.password.equals(this.confirm)) { if (!this.personService.getUserNamesAreCaseSensitive()) { this.userName = this.userName.toLowerCase(); } // create properties for Person type from submitted Form data Map props = new HashMap(7, 1.0f); props.put(ContentModel.PROP_USERNAME, this.userName); props.put(ContentModel.PROP_FIRSTNAME, this.firstName); props.put(ContentModel.PROP_LASTNAME, this.lastName); NodeRef homeSpaceNodeRef; if (this.homeSpaceLocation != null && this.homeSpaceName.length() != 0) { // create new homeSpaceNodeRef = createHomeSpace(this.homeSpaceLocation.getId(), this.homeSpaceName, true); } else if (this.homeSpaceLocation != null) { // set to existing homeSpaceNodeRef = homeSpaceLocation; setupHomeSpacePermissions(homeSpaceNodeRef); } else { // default to Company Home homeSpaceNodeRef = getCompanyHomeSpace(); } props.put(ContentModel.PROP_HOMEFOLDER, homeSpaceNodeRef); props.put(ContentModel.PROP_EMAIL, this.email); props.put(ContentModel.PROP_ORGID, this.companyId); // create the node to represent the Person String assocName = QName.createValidLocalName(this.userName); NodeRef newPerson = this.personService.createPerson(props); // ensure the user can access their own Person object this.permissionService.setPermission(newPerson, this.userName, permissionService.getAllPermission(), true); if (logger.isDebugEnabled()) logger.debug("Created Person node for username: " + this.userName); // create the ACEGI Authentication instance for the new user this.authenticationService.createAuthentication(this.userName, this.password.toCharArray()); if (logger.isDebugEnabled()) logger.debug("Created User Authentication instance for username: " + this.userName); } else { outcome = null; Utils.addErrorMessage(Application.getMessage(context, UsersBean.ERROR_PASSWORD_MATCH)); } } // commit the transaction tx.commit(); // reset the richlist component so it rebinds to the users list invalidateUserList(); } catch (Exception e) { // rollback the transaction try { if (tx != null) {tx.rollback();} } catch (Exception tex) {} Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), ERROR), e .getMessage()), e); outcome = null; } return outcome; } /** * @return Returns the summary data for the wizard. */ public String getSummary() { String homeSpaceLabel = this.homeSpaceName; if (this.homeSpaceName.length() == 0 && this.homeSpaceLocation != null) { homeSpaceLabel = Repository.getNameForNode(this.nodeService, this.homeSpaceLocation); } ResourceBundle bundle = Application.getBundle(FacesContext.getCurrentInstance()); return buildSummary(new String[] { bundle.getString("name"), bundle.getString("username"), bundle.getString("password"), bundle.getString("homespace") }, new String[] { this.firstName + " " + this.lastName, this.userName, "********", homeSpaceLabel }); } /** * Init the users screen */ public void setupUsers(ActionEvent event) { invalidateUserList(); } /** * Action listener called when the wizard is being launched for editing an * existing node. */ public void startWizardForEdit(ActionEvent event) { UIActionLink link = (UIActionLink) event.getComponent(); Map params = link.getParameterMap(); String id = params.get("id"); if (id != null && id.length() != 0) { try { // create the node ref, then our node representation NodeRef ref = new NodeRef(Repository.getStoreRef(), id); Node node = new Node(ref); // remember the Person node setPerson(node); // set the wizard in edit mode this.editMode = true; // populate the wizard's default values with the current value // from the node being edited init(); populate(); // clear the UI state in preparation for finishing the action // and returning to the main page invalidateUserList(); if (logger.isDebugEnabled()) logger.debug("Started wizard : " + getWizardTitle() + " for editing"); } catch (InvalidNodeRefException refErr) { Utils.addErrorMessage(MessageFormat.format(Application.getMessage(FacesContext.getCurrentInstance(), Repository.ERROR_NODEREF), new Object[] { id })); } } else { setPerson(null); } } /** * @return Returns the companyId. */ public String getCompanyId() { return this.companyId; } /** * @param companyId * The companyId to set. */ public void setCompanyId(String companyId) { this.companyId = companyId; } /** * @return Returns the email. */ public String getEmail() { return this.email; } /** * @param email * The email to set. */ public void setEmail(String email) { this.email = email; } /** * @return Returns the firstName. */ public String getFirstName() { return this.firstName; } /** * @param firstName The firstName to set. */ public void setFirstName(String firstName) { this.firstName = firstName; } /** * @return Returns the homeSpaceLocation. */ public NodeRef getHomeSpaceLocation() { return this.homeSpaceLocation; } /** * @param homeSpaceLocation The homeSpaceLocation to set. */ public void setHomeSpaceLocation(NodeRef homeSpaceLocation) { this.homeSpaceLocation = homeSpaceLocation; } /** * @return Returns the homeSpaceName. */ public String getHomeSpaceName() { return this.homeSpaceName; } /** * @param homeSpaceName The homeSpaceName to set. */ public void setHomeSpaceName(String homeSpaceName) { this.homeSpaceName = homeSpaceName; } /** * @return Returns the lastName. */ public String getLastName() { return this.lastName; } /** * @param lastName The lastName to set. */ public void setLastName(String lastName) { this.lastName = lastName; } /** * @return Returns the userName. */ public String getUserName() { return this.userName; } /** * @param userName The userName to set. */ public void setUserName(String userName) { this.userName = userName; } /** * @return Returns the password. */ public String getPassword() { return this.password; } /** * @param password The password to set. */ public void setPassword(String password) { this.password = password; } /** * @return Returns the confirm password. */ public String getConfirm() { return this.confirm; } /** * @param confirm The confirm password to set. */ public void setConfirm(String confirm) { this.confirm = confirm; } /** * @return Returns the person context. */ public Node getPerson() { return this.person; } /** * @param person The person context to set. */ public void setPerson(Node person) { this.person = person; } public boolean getEditMode() { return this.editMode; } // ------------------------------------------------------------------------------ // Validator methods /** * Validate password field data is acceptable */ public void validatePassword(FacesContext context, UIComponent component, Object value) throws ValidatorException { String pass = (String) value; if (pass.length() < 5 || pass.length() > 12) { String err = "Password must be between 5 and 12 characters in length."; throw new ValidatorException(new FacesMessage(err)); } for (int i = 0; i < pass.length(); i++) { if (Character.isLetterOrDigit(pass.charAt(i)) == false) { String err = "Password can only contain characters or digits."; throw new ValidatorException(new FacesMessage(err)); } } } /** * Validate Username field data is acceptable */ public void validateUsername(FacesContext context, UIComponent component, Object value) throws ValidatorException { String pass = (String) value; if (pass.length() < 5 || pass.length() > 12) { String err = "Username must be between 5 and 12 characters in length."; throw new ValidatorException(new FacesMessage(err)); } for (int i = 0; i < pass.length(); i++) { if (Character.isLetterOrDigit(pass.charAt(i)) == false) { String err = "Username can only contain characters or digits."; throw new ValidatorException(new FacesMessage(err)); } } } // ------------------------------------------------------------------------------ // Helper methods /** * Helper to return the company home space * * @return company home space NodeRef */ private NodeRef getCompanyHomeSpace() { if (this.companyHomeSpaceRef == null) { String companyXPath = Application.getRootPath(FacesContext.getCurrentInstance()); NodeRef rootNodeRef = this.nodeService.getRootNode(Repository.getStoreRef()); List nodes = this.searchService.selectNodes(rootNodeRef, companyXPath, null, this.namespaceService, false); if (nodes.size() == 0) { throw new IllegalStateException("Unable to find company home space path: " + companyXPath); } this.companyHomeSpaceRef = nodes.get(0); } return this.companyHomeSpaceRef; } /** * Create the specified home space if it does not exist, and return the ID * * @param locationId * Parent location * @param spaceName * Home space to create, can be null to simply return the parent * @param error * True to throw an error if the space already exists, else * ignore and return * * @return ID of the home space */ private NodeRef createHomeSpace(String locationId, String spaceName, boolean error) { String homeSpaceId = locationId; NodeRef homeSpaceNodeRef = null; if (spaceName != null && spaceName.length() != 0) { NodeRef parentRef = new NodeRef(Repository.getStoreRef(), locationId); // check for existance of home space with same name - return immediately // if it exists or throw an exception an give user chance to enter another name // TODO: this might be better replaced with an XPath query! List children = this.nodeService.getChildAssocs(parentRef); for (ChildAssociationRef ref : children) { String childNodeName = (String) this.nodeService.getProperty(ref.getChildRef(), ContentModel.PROP_NAME); if (spaceName.equals(childNodeName)) { if (error) { throw new AlfrescoRuntimeException("A Home Space with the same name already exists."); } else { return ref.getChildRef(); } } } // space does not exist already, create a new Space under it with // the specified name String qname = QName.createValidLocalName(spaceName); ChildAssociationRef assocRef = this.nodeService.createNode(parentRef, ContentModel.ASSOC_CONTAINS, QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, qname), ContentModel.TYPE_FOLDER); NodeRef nodeRef = assocRef.getChildRef(); // set the name property on the node this.nodeService.setProperty(nodeRef, ContentModel.PROP_NAME, spaceName); if (logger.isDebugEnabled()) logger.debug("Created Home Space for with name: " + spaceName); // apply the uifacets aspect - icon, title and description props Map uiFacetsProps = new HashMap(3); uiFacetsProps.put(ContentModel.PROP_ICON, NewSpaceWizard.SPACE_ICON_DEFAULT); uiFacetsProps.put(ContentModel.PROP_TITLE, spaceName); this.nodeService.addAspect(nodeRef, ContentModel.ASPECT_UIFACETS, uiFacetsProps); setupHomeSpacePermissions(nodeRef); // return the ID of the created space homeSpaceNodeRef = nodeRef; homeSpaceId = nodeRef.getId(); } return homeSpaceNodeRef; } /** * Setup the default permissions for this and other users on the Home Space * * @param homeSpaceRef Home Space reference */ private void setupHomeSpacePermissions(NodeRef homeSpaceRef) { // Admin Authority has full permissions by default (automatic - set in the permission config) // give full permissions to the new user this.permissionService.setPermission(homeSpaceRef, this.userName, permissionService.getAllPermission(), true); // by default other users will only have GUEST access to the space contents // or whatever is configured as the default in the web-client-xml config String permission = getDefaultPermission(); if (permission != null && permission.length() != 0) { this.permissionService.setPermission(homeSpaceRef, permissionService.getAllAuthorities(), permission, true); } // the new user is the OWNER of their own space and always has full permissions this.ownableService.setOwner(homeSpaceRef, this.userName); this.permissionService.setPermission(homeSpaceRef, permissionService.getOwnerAuthority(), permissionService.getAllPermission(), true); // now detach (if we did this first we could not set any permissions!) this.permissionService.setInheritParentPermissions(homeSpaceRef, false); } /** * @return default permission string to set for other users for a new Home Space */ private String getDefaultPermission() { ClientConfigElement config = (ClientConfigElement)this.configService.getGlobalConfig().getConfigElement( ClientConfigElement.CONFIG_ELEMENT_ID); return config.getHomeSpacePermission(); } private void invalidateUserList() { UIContextService.getInstance(FacesContext.getCurrentInstance()).notifyBeans(); } }