EditUser.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: EditUser.java
 * Description: Backbean for pages for adding, editing and deleting of users
 */

/**
 * @file EditUser.java
 *
 * @brief Backbean for adding, editing and deleting of users
 */

package cz.vutbr.fit.knot.annotations.web;

import cz.vutbr.fit.knot.annotations.app.AppBean;
import cz.vutbr.fit.knot.annotations.app.Constants;
import cz.vutbr.fit.knot.annotations.comet.MessageProcessor;
import cz.vutbr.fit.knot.annotations.entity.DefaultSettings;
import cz.vutbr.fit.knot.annotations.entity.Settings;
import cz.vutbr.fit.knot.annotations.entity.User;
import cz.vutbr.fit.knot.annotations.entity.UserGroup;
import java.io.Serializable;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.ViewScoped;
import javax.faces.component.html.HtmlDataTable;
import javax.persistence.EntityManager;
import javax.persistence.EntityTransaction;

/**
 * Backbean for pages for adding, editing and deleting of users
 *
 * @brief Backbean for adding, editing and deleting of users
 * @author idytrych
 */
@ManagedBean
@ViewScoped
public class EditUser implements Serializable {
  /**
   * Value of login field in form
   */
  private String login = null;
  /**
   * Value of password field in form
   */
  private String password = null;
  /**
   * Value of password control field in form
   */
  private String passwordControl = null;
  /**
   * Value of user full name field in form
   */
  private String name = null;
  /**
   * Value of email field in form
   */
  private String email = null;
  /**
   * External system from which user come
   */
  private String comeFrom = null;
  /**
   * Error message displayed in form
   */
  private String errorMessage = "";
  /**
   * Table with user groups of given user
   */
  private HtmlDataTable listTable;
  /**
   * User group selected in the table
   */
  private UserGroup userGroup;
  /**
   * Edited user or user to be deleted
   */
  private User user = null;

  /**
   * Constructor
   */
  public EditUser() {
  }

  /**
   * Action listener for save button in the page for editing of the user
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveAction() {
    if(!SessionManager.getSession().isLoggedIn()){
      SessionManager.getSession().setFormBackup(null);
      SessionManager.getSession().setEditedUser(null);
      return "login";
    }
    
    boolean errorOccurred = false;
    errorMessage = "";
    if (login.isEmpty()) {
      errorMessage = errorMessage + MessageProvider.getMessage("loginCantBeEmpty") + " ";
      errorOccurred = true;
    }
    if (!(password == null ? passwordControl == null : password.equals(passwordControl))) {
      errorMessage = errorMessage + MessageProvider.getMessage("passwordsMustMatch") + " ";
      errorOccurred = true;
    }
    if (name.isEmpty()) {  // if name is empty
      errorMessage = errorMessage + MessageProvider.getMessage("fullNameCantBeEmpty") + " ";
      errorOccurred = true;
    }
    if (errorOccurred) {
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
      return null;
    }

    // update user data
    user.setLogin(login);
    user.setName(name);
    user.setEmail(email);
    user.setComeFrom(comeFrom);
    if (!password.isEmpty()) {
      String hash = null;
      try {
        MessageDigest md5 = MessageDigest.getInstance("MD5");
        md5.update(password.getBytes());
        hash = MessageProcessor.getHexString(md5.digest());
      } catch (NoSuchAlgorithmException ex) {
        hash = password;
      }
      user.setPassword(hash);
    }
    // persist changes
    User saved = (User) AppBean.getPersistenceManager().saveEntityChanges(user);
    if (saved == null) {
      errorMessage = MessageProvider.getMessage("changesNSDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of changes in the user account failed.";
        Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    } else {  // if changes was successfully saved
      user = saved;
    }

    AppBean.refreshUsersInSessions(user);  // refreshes data in sessions
    
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedUser(null);
    return "users";
  }  // btnSaveAction()

  /**
   * Action listener for seve button on page for adding new users
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveNewAction() {
    if(!SessionManager.getSession().isLoggedIn()){
      SessionManager.getSession().setFormBackup(null);
      SessionManager.getSession().setEditedUser(null);
      return "login";
    }
    
    boolean errorOccurred = false;
    errorMessage = "";
    if (login.isEmpty()) {
      errorMessage = errorMessage + MessageProvider.getMessage("loginCantBeEmpty") + " ";
      errorOccurred = true;
    }
    if (password.isEmpty()) {
      errorMessage = errorMessage + MessageProvider.getMessage("passwordCantBeEmpty") + " ";
      errorOccurred = true;
    }
    if (!(password == null ? passwordControl == null : password.equals(passwordControl))) {
      errorMessage = errorMessage + MessageProvider.getMessage("passwordsMustMatch") + " ";
      errorOccurred = true;
    }
    if (name.isEmpty()) {  // if name is empty
      errorMessage = errorMessage + MessageProvider.getMessage("fullNameCantBeEmpty") + " ";
      errorOccurred = true;
    }
    if (errorOccurred) {
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
      return null;
    }

    // create hash of password
    String hash = null;
    try {
      MessageDigest md5 = MessageDigest.getInstance("MD5");
      md5.update(password.getBytes());
      hash = MessageProcessor.getHexString(md5.digest());
    } catch (NoSuchAlgorithmException ex) {
      hash = password;
    }

    user = new User(login, name, email, hash);  // create new user
    user.setComeFrom(comeFrom);

    // persist new user
    if (AppBean.getPersistenceManager().persistEntity(user)) {
      errorMessage = MessageProvider.getMessage("newuserNSDatabaseFailure");
            if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of new user account failed.";
        Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    }
    
    Object[] params = {"login",login};
    @SuppressWarnings("unchecked")
    List<User> userList = AppBean.getPersistenceManager().queryDB("User.findByLogin",params);
    if(userList != null) {
      String resultError = loadDefaultSettings(userList.get(0));

      if(resultError != null){
        errorMessage = resultError;
        return null;
      }
    }
    
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedUser(null);
    return "users";
  }  // btnSaveNewAction()

  /**
   * Action listener for cancel button
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnCancelAction() {
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedUser(null);  // clean up variable in session
    if(!SessionManager.getSession().isLoggedIn()){
      return "login";
    }else return "users";
  }

  /**
   * Action listener for delete button on deleting page
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnDeleteAction() {
    // find annotations from this user
    if(!SessionManager.getSession().isLoggedIn()){
      SessionManager.getSession().setFormBackup(null);
      SessionManager.getSession().setEditedUser(null);
      return "login";
    }
    
    Object[] params = new Object[2];
    params[0] = "id";
    params[1] = user.getId();
    List gList = AppBean.getPersistenceManager().queryDB("Annotation.findByAuthor", params);
    if (gList != null && !gList.isEmpty()) {  // if annotation was found
      errorMessage = MessageProvider.getMessage("ifAnnotationsExistsUserCantBeDeleted");
      return null;
    }

    // Is it last administrator?
    for (Iterator<UserGroup> gIt = user.getGroups().iterator(); gIt.hasNext();) {
      UserGroup ug = gIt.next();
      if (ug.getName().equalsIgnoreCase(Constants.ADMIN_GROUP) && ug.getUsers().size() < 2) {
        errorMessage = MessageProvider.getMessage("removeLastAdmin");
        return null;
      }
    }

    //get all user settings
    params[0] = "userId";
    params[1] = user.getId();
    @SuppressWarnings("unchecked")
    List<Settings> settingsList = AppBean.getPersistenceManager().queryDB("Settings.findByUser",params);
    if(settingsList != null && !settingsList.isEmpty()){
      Iterator<Settings> settingsIt = settingsList.iterator();
      while(settingsIt.hasNext()){
        Settings actualSetting = settingsIt.next();
        if (AppBean.getPersistenceManager().removeEntity(actualSetting)) {
          errorMessage = MessageProvider.getMessage("userSettingsDeleteError");
          if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
            String msg = "DB failure during deleting of user settings.";
            Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
          }
          return null;
        }
      }
    }
    
    if (AppBean.getPersistenceManager().removeEntity(user)) {
      errorMessage = MessageProvider.getMessage("userCantBeDeletedDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "DB failure during deleting of user account.";
        Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    }
    
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedUser(null);
    return "users";
  }  // btnDeleteAction()

  /**
   * Gets edited user
   * If user not set yet, pick up it from session
   *
   * @return Returns edited user
   */
  public User getUser() {
    if (user == null) {
      user = SessionManager.getSession().getEditedUser();
    }
    return user;
  }

  /**
   * Sets edited user
   *
   * @param user Edited user
   */
  public void setUser(User user) {
    this.user = user;
  }

  /**
   * Gets value of user full name field in form
   * If user not set yet, pick up it from session
   *
   * @return Returns value of user full name field in form
   */
  public String getName() {
    if (user == null) {
      user = SessionManager.getSession().getEditedUser();
    }
    User backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
      if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("User")) {
        backup = (User) SessionManager.getSession().getFormBackup();
        if (backup.getId() != user.getId()) {
          backup = null;
        }
      }
    }
    if (name == null && backup != null) {
      name = backup.getName();
    } else if (name == null && user != null) {
      name = user.getName();
    } else if (name == null) {
      name = "";
    }
    return name;
  }  // getName()

  /**
   * Sets value of user full name field in form
   *
   * @param name Value of user full name field in form
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * Gets value of user login field in form
   * If user not set yet, pick up it from session
   *
   * @return Returns value of user login field in form
   */
  public String getLogin() {
    if (user == null) {
      user = SessionManager.getSession().getEditedUser();
    }
    User backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
      if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("User")) {
        backup = (User) SessionManager.getSession().getFormBackup();
        if (backup.getId() != user.getId()) {
          backup = null;
        }
      }
    }
    if (login == null && backup != null) {
      login = backup.getLogin();
    } else if (login == null && user != null) {
      login = user.getLogin();
    } else if (login == null) {
      login = "";
    }
    return login;
  }  // getLogin()

  /**
   * Sets value of user login field in form
   *
   * @param login Value of user login field in form
   */
  public void setLogin(String login) {
    this.login = login;
  }
  
  /**
   * Gets value of come from field in form
   * If user not set yet, pick up it from session
   *
   * @return Returns value of come from field in form
   */
  public String getComeFrom() {
    if (user == null) {
      user = SessionManager.getSession().getEditedUser();
    }
    User backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
      if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("User")) {
        backup = (User) SessionManager.getSession().getFormBackup();
        if (backup.getId() != user.getId()) {
          backup = null;
        }
      }
    }
    if (comeFrom == null && backup != null) {
      comeFrom = backup.getComeFrom();
    } else if (comeFrom == null && user != null) {
      comeFrom = user.getComeFrom();
    } else if (comeFrom == null) {
      comeFrom = "";
    }
    return comeFrom;
  }  // getComeFrom()

  /**
   * Sets value of come from field in form
   *
   * @param comeFrom Value of come from field in form
   */
  public void setComeFrom(String comeFrom) {
    this.comeFrom = comeFrom;
  }
  
  /**
   * Gets value of user email field in form
   * If user not set yet, pick up it from session
   *
   * @return Returns value of user email field in form
   */
  public String getEmail() {
    if (user == null) {
      user = SessionManager.getSession().getEditedUser();
    }
    User backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
      if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("User")) {
        backup = (User) SessionManager.getSession().getFormBackup();
        if (backup.getId() != user.getId()) {
          backup = null;
        }
      }
    }
    if (email == null && backup != null) {
      email = backup.getEmail();
    } else if (email == null && user != null) {
      email = user.getEmail();
    } else if (email == null) {
      email = "";
    }
    return email;
  }  // getEmail()

  /**
   * Sets value of user email field in form
   *
   * @param email Value of user email field in form
   */
  public void setEmail(String email) {
    this.email = email;
  }
  
  /**
   * Gets value of user password field in form
   *
   * @return Returns empty string (password can't be decoded from MD5)
   */
  public String getPassword() {
    return "";
  }

  /**
   * Sets value of user password field in form
   *
   * @param password Value of user password field in form
   */
  public void setPassword(String password) {
    this.password = password;
  }

  /**
   * Gets value of user password control field in form
   *
   * @return Returns empty string (password can't be decoded from MD5)
   */
  public String getPasswordControl() {
    return "";
  }

  /**
   * Sets value of user password control field in form
   *
   * @param passwordControl Value of user password control field in form
   */
  public void setPasswordControl(String passwordControl) {
    this.passwordControl = passwordControl;
  }
  /**
   * Gets error message displayed in form
   *
   * @return Returns error message displayed in form
   */
  public String getErrorMessage() {
    return errorMessage;
  }

  /**
   * Sets error message to be displayed in form
   *
   * @param errorMessage Error message to be displayed in form
   */
  public void setErrorMessage(String errorMessage) {
    this.errorMessage = errorMessage;
  }

  /**
   * Gets table with user groups of given user
   *
   * @return Returns table with user groups of given user
   */
  public HtmlDataTable getListTable() {
    return listTable;
  }

  /**
   * Sets table with user groups of given user
   *
   * @param listTable Table with user groups of given user
   */
  public void setListTable(HtmlDataTable listTable) {
    this.listTable = listTable;
  }

  /**
   * Gets list of all user groups of given user
   *
   * @return List of all user groups of given user
   */
  public List<UserGroup> getUserGroupsList() {
    if (user == null) {
      user = SessionManager.getSession().getEditedUser();
      if(user == null) return null;
    }
    return user.getGroups();
  }

  /**
   * Gets user group selected in the table
   *
   * @return Returns user group selected in the table
   */
  public UserGroup getUserGroup() {
    return userGroup;
  }

  /**
   * Sets user group selected in the table
   *
   * @param userGroup User group selected in the table
   */
  public void setUserGroup(UserGroup userGroup) {
    this.userGroup = userGroup;
  }

  /**
   * Action listener for remove link in the table. Removes user from user group
   *
   * @return Returns null to stay in this page
   */
  public String actionRemoveUserFromGroup(Integer id) {
    // Commented out row can be used only in session context. This is reason
    // for my workaround.
    // userGroup = (UserGroup) listTable.getRowData();

    // Get selected row data
    if(!SessionManager.getSession().isLoggedIn()){
      SessionManager.getSession().setFormBackup(null);
      SessionManager.getSession().setEditedUser(null);
      return "login";
    }
    
    UserGroup refUG = new UserGroup(id);
    int index = getUserGroupsList().indexOf(refUG);
    userGroup = getUserGroupsList().get(index);
    if (userGroup.getName().equalsIgnoreCase(Constants.ADMIN_GROUP) && userGroup.getUsers().size() < 2) {
      // the last administrator can't be removed
      errorMessage = MessageProvider.getMessage("removeLastAdmin");
      return null;
    }
    try {
      EntityManager em = AppBean.getPersistenceManager().getEM();
      EntityTransaction transaction = em.getTransaction();
      transaction.begin();
      user = em.merge(user);
      userGroup = em.merge(userGroup);
      userGroup.getUsers().remove(user);  // remove user from group
      user.getGroups().remove(userGroup);
      em.flush();
      transaction.commit();
    } catch (Exception e) {
      errorMessage = MessageProvider.getMessage("userCantBeREmovedDFromGroup");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Removing of user from the user group failed.";
        Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg, e);
      }
      return null;
    }
    
    AppBean.refreshUsersInSessions(user);  // refreshes data in sessions
    
    return null;
  }  // actionRemoveUserFromGroup()

  /**
   * Action listener for link for join user to group
   *
   * @return GEturns page outcome (identificator of transition)
   */
  public String actionAddUserGroup() {
    // backup form data
    if(!SessionManager.getSession().isLoggedIn()){
      SessionManager.getSession().setFormBackup(null);
      SessionManager.getSession().setEditedUser(null);
      return "login";
    }
    User backup = new User(user.getId(), login, name, email, password);
    backup.setComeFrom(comeFrom);
    SessionManager.getSession().setFormBackup(backup);
    // pass edited user through the session
    SessionManager.getSession().setEditedUser(user);
    return "selectUserGroup";
  }
  
  private String loadDefaultSettings(User user){
    if(!SessionManager.getSession().isLoggedIn()){
      SessionManager.getSession().setFormBackup(null);
      SessionManager.getSession().setEditedUser(null);
      return "login";
    }
    @SuppressWarnings("unchecked")
    List<DefaultSettings> settingsList = AppBean.getPersistenceManager().queryDB("DefaultSettings.findAll");
    if(settingsList != null){
      String errorMessageOut;
      ListIterator<DefaultSettings> resultIt = settingsList.listIterator();
      while(resultIt.hasNext()){
        DefaultSettings actualDefaultSetting = resultIt.next();
        Settings newUserSetting = new Settings(user,actualDefaultSetting.getName(),actualDefaultSetting.getValue(),actualDefaultSetting.getDescription());
        
        if (AppBean.getPersistenceManager().persistEntity(newUserSetting)) {
          errorMessageOut = MessageProvider.getMessage("newUserSettingDBFailure");
          if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
            String msg = "Persisting of new user settings failed.";
            Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
          }
          return errorMessageOut;
        }
      }
    }
    
    return null;
  }

}  // public class EditUser