Java tutorial
/* * Copyright (c) 2002-2013, Mairie de Paris * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright notice * and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright notice * and the following disclaimer in the documentation and/or other materials * provided with the distribution. * * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * * License 1.0 */ package fr.paris.lutece.portal.service.admin; import fr.paris.lutece.portal.business.user.AdminUser; import fr.paris.lutece.portal.business.user.AdminUserHome; import fr.paris.lutece.portal.business.user.attribute.AdminUserField; import fr.paris.lutece.portal.business.user.attribute.AdminUserFieldFilter; import fr.paris.lutece.portal.business.user.attribute.AdminUserFieldHome; import fr.paris.lutece.portal.business.user.attribute.IAttribute; import fr.paris.lutece.portal.business.user.attribute.ISimpleValuesAttributes; import fr.paris.lutece.portal.business.user.authentication.LuteceDefaultAdminUser; import fr.paris.lutece.portal.business.workgroup.AdminWorkgroupHome; import fr.paris.lutece.portal.service.csv.CSVMessageDescriptor; import fr.paris.lutece.portal.service.csv.CSVMessageLevel; import fr.paris.lutece.portal.service.csv.CSVReaderService; import fr.paris.lutece.portal.service.i18n.I18nService; import fr.paris.lutece.portal.service.plugin.Plugin; import fr.paris.lutece.portal.service.plugin.PluginService; import fr.paris.lutece.portal.service.spring.SpringContextService; import fr.paris.lutece.portal.service.user.attribute.AdminUserFieldListenerService; import fr.paris.lutece.portal.service.user.attribute.AttributeService; import fr.paris.lutece.portal.service.util.AppLogService; import fr.paris.lutece.portal.service.util.AppPathService; import fr.paris.lutece.portal.service.util.AppPropertiesService; import fr.paris.lutece.util.password.PasswordUtil; import org.apache.commons.lang.StringUtils; import java.sql.Timestamp; import java.text.DateFormat; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; /** * Class to import Admin Users from CSV files. */ public class ImportAdminUserService extends CSVReaderService { private static final String MESSAGE_NO_LEVEL = "portal.users.import_users_from_file.importNoLevel"; private static final String MESSAGE_NO_STATUS = "portal.users.import_users_from_file.importNoStatus"; private static final String MESSAGE_ACCESS_CODE_ALREADY_USED = "portal.users.message.user.accessCodeAlreadyUsed"; private static final String MESSAGE_EMAIL_ALREADY_USED = "portal.users.message.user.accessEmailUsed"; private static final String MESSAGE_USERS_IMPORTED = "portal.users.import_users_from_file.usersImported"; private static final String MESSAGE_ERROR_MIN_NUMBER_COLUMNS = "portal.users.import_users_from_file.messageErrorMinColumnNumber"; private static final String MESSAGE_ERROR_IMPORTING_ATTRIBUTES = "portal.users.import_users_from_file.errorImportingAttributes"; private static final String PROPERTY_IMPORT_EXPORT_USER_SEPARATOR = "lutece.importExportUser.defaultSeparator"; private static final String PROPERTY_MESSAGE_EMAIL_SUBJECT_NOTIFY_USER = "portal.users.notify_user.email.subject"; private static final String TEMPLATE_NOTIFY_USER = "admin/user/notify_user_account_created.html"; private static final String CONSTANT_DEFAULT_IMPORT_EXPORT_USER_SEPARATOR = ":"; private static final String CONSTANT_RIGHT = "right"; private static final String CONSTANT_ROLE = "role"; private static final String CONSTANT_WORKGROUP = "workgroup"; private static final int CONSTANT_MINIMUM_COLUMNS_PER_LINE = 12; private static final AttributeService _attributeService = AttributeService.getInstance(); private Character _strAttributesSeparator; private boolean _bUpdateExistingUsers; /** * {@inheritDoc} */ @Override protected List<CSVMessageDescriptor> readLineOfCSVFile(String[] strLineDataArray, int nLineNumber, Locale locale, String strBaseUrl) { List<CSVMessageDescriptor> listMessages = new ArrayList<CSVMessageDescriptor>(); int nIndex = 0; String strAccessCode = strLineDataArray[nIndex++]; String strLastName = strLineDataArray[nIndex++]; String strFirstName = strLineDataArray[nIndex++]; String strEmail = strLineDataArray[nIndex++]; boolean bUpdateUser = getUpdateExistingUsers(); int nUserId = 0; if (bUpdateUser) { int nAccessCodeUserId = AdminUserHome.checkAccessCodeAlreadyInUse(strAccessCode); int nEmailUserId = AdminUserHome.checkEmailAlreadyInUse(strEmail); if (nAccessCodeUserId > 0) { nUserId = nAccessCodeUserId; } else if (nEmailUserId > 0) { nUserId = nEmailUserId; } bUpdateUser = nUserId > 0; } String strStatus = strLineDataArray[nIndex++]; int nStatus = 0; if (StringUtils.isNotEmpty(strStatus) && StringUtils.isNumeric(strStatus)) { nStatus = Integer.parseInt(strStatus); } else { Object[] args = { strLastName, strFirstName, nStatus }; String strMessage = I18nService.getLocalizedString(MESSAGE_NO_STATUS, args, locale); CSVMessageDescriptor message = new CSVMessageDescriptor(CSVMessageLevel.INFO, nLineNumber, strMessage); listMessages.add(message); } String strLocale = strLineDataArray[nIndex++]; String strLevelUser = strLineDataArray[nIndex++]; int nLevelUser = 3; if (StringUtils.isNotEmpty(strLevelUser) && StringUtils.isNumeric(strLevelUser)) { nLevelUser = Integer.parseInt(strLevelUser); } else { Object[] args = { strLastName, strFirstName, nLevelUser }; String strMessage = I18nService.getLocalizedString(MESSAGE_NO_LEVEL, args, locale); CSVMessageDescriptor message = new CSVMessageDescriptor(CSVMessageLevel.INFO, nLineNumber, strMessage); listMessages.add(message); } // We ignore the rest password attribute because we set it to true anyway. // String strResetPassword = strLineDataArray[nIndex++]; nIndex++; boolean bResetPassword = true; String strAccessibilityMode = strLineDataArray[nIndex++]; boolean bAccessibilityMode = Boolean.parseBoolean(strAccessibilityMode); // We ignore the password max valid date attribute because we changed the password. // String strPasswordMaxValidDate = strLineDataArray[nIndex++]; nIndex++; Timestamp passwordMaxValidDate = null; // We ignore the account max valid date attribute // String strAccountMaxValidDate = strLineDataArray[nIndex++]; nIndex++; Timestamp accountMaxValidDate = AdminUserService.getAccountMaxValidDate(); String strDateLastLogin = strLineDataArray[nIndex++]; Timestamp dateLastLogin = new Timestamp(AdminUser.DEFAULT_DATE_LAST_LOGIN.getTime()); if (StringUtils.isNotBlank(strDateLastLogin)) { DateFormat dateFormat = new SimpleDateFormat(); Date dateParsed; try { dateParsed = dateFormat.parse(strDateLastLogin); } catch (ParseException e) { AppLogService.error(e.getMessage(), e); dateParsed = null; } if (dateParsed != null) { dateLastLogin = new Timestamp(dateParsed.getTime()); } } AdminUser user = null; if (bUpdateUser) { user = AdminUserHome.findByPrimaryKey(nUserId); } else { user = new LuteceDefaultAdminUser(); } user.setAccessCode(strAccessCode); user.setLastName(strLastName); user.setFirstName(strFirstName); user.setEmail(strEmail); user.setStatus(nStatus); user.setUserLevel(nLevelUser); user.setLocale(new Locale(strLocale)); user.setAccessibilityMode(bAccessibilityMode); if (bUpdateUser) { user.setUserId(nUserId); // We update the user AdminUserHome.update(user); } else { // We create the user user.setPasswordReset(bResetPassword); user.setPasswordMaxValidDate(passwordMaxValidDate); user.setAccountMaxValidDate(accountMaxValidDate); user.setDateLastLogin(dateLastLogin); if (AdminAuthenticationService.getInstance().isDefaultModuleUsed()) { LuteceDefaultAdminUser defaultAdminUser = (LuteceDefaultAdminUser) user; String strPassword = AdminUserService.makePassword(); String strEncryptedPassword = AdminUserService.encryptPassword(strPassword); defaultAdminUser.setPassword(strEncryptedPassword); AdminUserHome.create(defaultAdminUser); // We un-encrypt the password to send it in an email defaultAdminUser.setPassword(strPassword); AdminUserService.notifyUser(AppPathService.getProdUrl(strBaseUrl), user, PROPERTY_MESSAGE_EMAIL_SUBJECT_NOTIFY_USER, TEMPLATE_NOTIFY_USER); } else { AdminUserHome.create(user); } } // We remove any previous right, roles, workgroup adn attributes of the user AdminUserHome.removeAllRightsForUser(user.getUserId()); AdminUserHome.removeAllRolesForUser(user.getUserId()); AdminUserFieldFilter auFieldFilter = new AdminUserFieldFilter(); auFieldFilter.setIdUser(user.getUserId()); AdminUserFieldHome.removeByFilter(auFieldFilter); // We get every attribute, role, right and workgroup of the user Map<Integer, List<String>> mapAttributesValues = new HashMap<Integer, List<String>>(); List<String> listAdminRights = new ArrayList<String>(); List<String> listAdminRoles = new ArrayList<String>(); List<String> listAdminWorkgroups = new ArrayList<String>(); while (nIndex < strLineDataArray.length) { String strValue = strLineDataArray[nIndex]; if (StringUtils.isNotBlank(strValue) && (strValue.indexOf(getAttributesSeparator()) > 0)) { int nSeparatorIndex = strValue.indexOf(getAttributesSeparator()); String strLineId = strValue.substring(0, nSeparatorIndex); if (StringUtils.isNotBlank(strLineId)) { if (StringUtils.equalsIgnoreCase(strLineId, CONSTANT_RIGHT)) { listAdminRights.add(strValue.substring(nSeparatorIndex + 1)); } else if (StringUtils.equalsIgnoreCase(strLineId, CONSTANT_ROLE)) { listAdminRoles.add(strValue.substring(nSeparatorIndex + 1)); } else if (StringUtils.equalsIgnoreCase(strLineId, CONSTANT_WORKGROUP)) { listAdminWorkgroups.add(strValue.substring(nSeparatorIndex + 1)); } else { int nAttributeId = Integer.parseInt(strLineId); String strAttributeValue = strValue.substring(nSeparatorIndex + 1); List<String> listValues = mapAttributesValues.get(nAttributeId); if (listValues == null) { listValues = new ArrayList<String>(); } listValues.add(strAttributeValue); mapAttributesValues.put(nAttributeId, listValues); } } } nIndex++; } // We create rights for (String strRight : listAdminRights) { AdminUserHome.createRightForUser(user.getUserId(), strRight); } // We create roles for (String strRole : listAdminRoles) { AdminUserHome.createRoleForUser(user.getUserId(), strRole); } // We create workgroups for (String strWorkgoup : listAdminWorkgroups) { AdminWorkgroupHome.addUserForWorkgroup(user, strWorkgoup); } List<IAttribute> listAttributes = _attributeService.getAllAttributesWithoutFields(locale); Plugin pluginCore = PluginService.getCore(); // We save the attributes found for (IAttribute attribute : listAttributes) { if (attribute instanceof ISimpleValuesAttributes) { List<String> listValues = mapAttributesValues.get(attribute.getIdAttribute()); if ((listValues != null) && (listValues.size() > 0)) { int nIdField = 0; boolean bCoreAttribute = (attribute.getPlugin() == null) || StringUtils.equals(pluginCore.getName(), attribute.getPlugin().getName()); for (String strValue : listValues) { int nSeparatorIndex = strValue.indexOf(getAttributesSeparator()); if (nSeparatorIndex >= 0) { nIdField = 0; try { nIdField = Integer.parseInt(strValue.substring(0, nSeparatorIndex)); } catch (NumberFormatException e) { nIdField = 0; } strValue = strValue.substring(nSeparatorIndex + 1); } else { nIdField = 0; } String[] strValues = { strValue }; try { List<AdminUserField> listUserFields = ((ISimpleValuesAttributes) attribute) .getUserFieldsData(strValues, user); for (AdminUserField userField : listUserFields) { if (userField != null) { userField.getAttributeField().setIdField(nIdField); AdminUserFieldHome.create(userField); } } if (!bCoreAttribute) { for (AdminUserFieldListenerService adminUserFieldListenerService : SpringContextService .getBeansOfType(AdminUserFieldListenerService.class)) { adminUserFieldListenerService.doCreateUserFields(user, listUserFields, locale); } } } catch (Exception e) { AppLogService.error(e.getMessage(), e); String strErrorMessage = I18nService .getLocalizedString(MESSAGE_ERROR_IMPORTING_ATTRIBUTES, locale); CSVMessageDescriptor error = new CSVMessageDescriptor(CSVMessageLevel.ERROR, nLineNumber, strErrorMessage); listMessages.add(error); } } } } } return listMessages; } /** * {@inheritDoc} */ @Override protected List<CSVMessageDescriptor> checkLineOfCSVFile(String[] strLineDataArray, int nLineNumber, Locale locale) { int nMinColumnNumber = CONSTANT_MINIMUM_COLUMNS_PER_LINE; List<CSVMessageDescriptor> listMessages = new ArrayList<CSVMessageDescriptor>(); if ((strLineDataArray == null) || (strLineDataArray.length < nMinColumnNumber)) { int nNbCol; if (strLineDataArray == null) { nNbCol = 0; } else { nNbCol = strLineDataArray.length; } Object[] args = { nNbCol, nMinColumnNumber }; String strErrorMessage = I18nService.getLocalizedString(MESSAGE_ERROR_MIN_NUMBER_COLUMNS, args, locale); CSVMessageDescriptor error = new CSVMessageDescriptor(CSVMessageLevel.ERROR, nLineNumber, strErrorMessage); listMessages.add(error); return listMessages; } if (!getUpdateExistingUsers()) { String strAccessCode = strLineDataArray[0]; String strEmail = strLineDataArray[3]; if (AdminUserHome.checkAccessCodeAlreadyInUse(strAccessCode) > 0) { String strMessage = I18nService.getLocalizedString(MESSAGE_ACCESS_CODE_ALREADY_USED, locale); CSVMessageDescriptor error = new CSVMessageDescriptor(CSVMessageLevel.ERROR, nLineNumber, strMessage); listMessages.add(error); } else { if (AdminUserHome.checkEmailAlreadyInUse(strEmail) > 0) { String strMessage = I18nService.getLocalizedString(MESSAGE_EMAIL_ALREADY_USED, locale); CSVMessageDescriptor error = new CSVMessageDescriptor(CSVMessageLevel.ERROR, nLineNumber, strMessage); listMessages.add(error); } } } return listMessages; } /** * {@inheritDoc} */ @Override protected List<CSVMessageDescriptor> getEndOfProcessMessages(int nNbLineParses, int nNbLinesWithoutErrors, Locale locale) { List<CSVMessageDescriptor> listMessages = new ArrayList<CSVMessageDescriptor>(); Object[] args = { nNbLineParses, nNbLinesWithoutErrors }; String strMessageContent = I18nService.getLocalizedString(MESSAGE_USERS_IMPORTED, args, locale); CSVMessageDescriptor message = new CSVMessageDescriptor(CSVMessageLevel.INFO, 0, strMessageContent); listMessages.add(message); return listMessages; } /** * Get the separator used for attributes of admin users. * @return The separator */ public Character getAttributesSeparator() { if (_strAttributesSeparator == null) { _strAttributesSeparator = AppPropertiesService.getProperty(PROPERTY_IMPORT_EXPORT_USER_SEPARATOR, CONSTANT_DEFAULT_IMPORT_EXPORT_USER_SEPARATOR).charAt(0); } return _strAttributesSeparator; } /** * Get the update users flag * @return True if existing users should be updated, false if they should be * ignored. */ public boolean getUpdateExistingUsers() { return _bUpdateExistingUsers; } /** * Set the update users flag * @param bUpdateExistingUsers True if existing users should be updated, * false if they should be ignored. */ public void setUpdateExistingUsers(boolean bUpdateExistingUsers) { this._bUpdateExistingUsers = bUpdateExistingUsers; } }