EditUserASSetting.java

Go to the documentation of this file.

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

/**
 * @file EditUserASSetting.java
 *
 * @brief Backbean for pages for adding, editing and deleting of user annotation style settings
 */
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.entity.Settings;
import java.io.Serializable;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.ViewScoped;

/**
 * Backbean for pages for adding, editing and deleting of user annotation style settings
 *
 * @brief Backbean for pages for adding, editing and deleting of user annotation style settings
 * @author Martin Petr (xpetrm05)
 */
@ManagedBean
@ViewScoped
public class EditUserASSetting implements Serializable{
  /**
   * Name of user annotation style setting
   */
  private String annotTypeName = null;
  
  /**
   * Name of annotation type of user annotation style setting
   */
  private String settingName = null;
  
  /**
   * Edited setting or setting to be deleted
   */
  private Settings setting = null;
  
  /**
   * Red component of annotation background color
   */
  private Integer bgRed = 255;
  
  /**
   * Green component of annotation background color
   */
  private Integer bgGreen = 255;
  
  /**
   * Blue component of annotation background color
   */
  private Integer bgBlue = 255;
  
  /**
   * Alpha of annotation background color
   */
  private Float bgAlpha = (float)1;
  
  /**
   * Red component of annotation font color
   */
  private Integer textRed = 0;
  
  /**
   * Green component of annotation font color
   */
  private Integer textGreen = 0;
  
  /**
   * Green component of annotation font color
   */
  private Integer textBlue = 0;
  
  /**
   * Indicates that the text is bold
   */
  private Boolean bold = false;
  
  /**
   * Indicates that the text is italic
   */
  private Boolean italic = false;
  
  /**
   * Indicates that the text is underlined
   */
  private Boolean underlined = false;
  
  /**
   * Error message displayed in form
   */
  private String errorMessage = "";

  /** Index of background color in setting value string*/
  public static final int BACKGROUND_COLOR = 0;
  /** Index of font color in setting value string*/
  public static final int FONT_COLOR = 1;
  /** Index of bold text flag in setting value string*/
  public static final int FONT_BOLD = 2;
  /** Index of italic text flag in setting value string*/
  public static final int FONT_ITALIC = 3;
  /** Index of underlined text flag in setting value string*/
  public static final int FONT_UNDERLINED = 4;
  /** Length of color prefix*/
  public static final int PREFIX_LENGTH = 5;
  /** Index of setting name in name string */
  public static final int SETTING_NAME = 0;
  /** Index of annot type name in name string */
  public static final int ANNOT_NAME = 1;
  /** Index of red content of color in color string*/
  public static final int RED = 0;
  /** Index of green content of color in color string*/
  public static final int GREEN = 1;
  /** Index of blue content of color in color string*/
  public static final int BLUE = 2;
  /** Index of alpha content of color in color string*/
  public static final int ALPHA = 3;
  
  /**
   * Constructor
   */
  public EditUserASSetting() {
    
    Settings backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
      if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("Settings")) {
        backup = (Settings) SessionManager.getSession().getFormBackup();
        setting = backup;
        return;
      }
    }
    
    if(SessionManager.getSession().getSavedValue() != null){
      parseValue(SessionManager.getSession().getSavedValue());
    }else if(SessionManager.getSession().getEditedSetting() != null){
      parseValue(SessionManager.getSession().getEditedSetting().getValue());
    }
    
    if(SessionManager.getSession().getEditedSetting() != null) 
      setting = SessionManager.getSession().getEditedSetting();
    
    if(SessionManager.getSession().getSavedName() != null){
      parseName(SessionManager.getSession().getSavedName());
    }else if(SessionManager.getSession().getEditedSetting() != null){
      parseName(SessionManager.getSession().getEditedSetting().getName());
    }else{
      annotTypeName = "";
      settingName = "";
    }
    
    if(SessionManager.getSession().getAnnotationTypeAddress() != null){
      String[] result = SessionManager.getSession().getAnnotationTypeAddress().split("/");
      annotTypeName = result[result.length-1];
    }
  }

  /**
   * Gets name of user annotation style setting
   *
   * @return Returns name of user annotation style setting
   */
  public String getAnnotTypeName() {
    return annotTypeName;
  }

  /**
   * Sets name of user annotation style setting
   *
   * @param annotTypeName Name of user annotation style setting
   */
  public void setAnnotTypeName(String annotTypeName) {
    this.annotTypeName = annotTypeName;
  }

  /**
   * Gets name of annotation type of user annotation style setting
   *
   * @return Returns name of annotation type of user annotation style setting
   */
  public String getSettingName() {
    return settingName;
  }

  /**
   * Sets name of annotation type of user annotation style setting
   *
   * @param settingName Name of annotation type of user annotation style setting
   */
  public void setSettingName(String settingName) {
    this.settingName = settingName;
  }

  /**
   * Gets red component of annotation background color as string
   *
   * @return Returns red component of annotation background color as string
   */
  public String getBgRed() {
    return bgRed.toString();
  }

  /**
   * Sets red component of annotation background color as string
   *
   * @param bgRed Red component of annotation background color as string
   */
  public void setBgRed(String bgRed) {
    try{
      this.bgRed = Integer.parseInt(bgRed);
    }
    
    catch(Exception e){
      this.bgRed = -1;
    }
  }

  /**
   * Gets green component of annotation background color as string
   *
   * @return Returns green component of annotation background color as string
   */
  public String getBgGreen() {
    return bgGreen.toString();
  }

  /**
   * Sets green component of annotation background color as string
   *
   * @param bgGreen Green component of annotation background color as string
   */
  public void setBgGreen(String bgGreen) {
    this.bgGreen = Integer.parseInt(bgGreen);
  }

  /**
   * Gets blue component of annotation background color as string
   *
   * @return Returns blue component of annotation background color as string
   */
  public String getBgBlue() {
    return bgBlue.toString();
  }

  /**
   * Sets blue component of annotation background color as string
   *
   * @param bgBlue Blue component of annotation background color as string
   */
  public void setBgBlue(String bgBlue) {
    this.bgBlue = Integer.parseInt(bgBlue);
  }

  /**
   * Gets alpha component of annotation background color as string
   *
   * @return Returns alpha component of annotation background color as string
   */
  public String getBgAlpha() {
    Float tmpFloat = bgAlpha*100;
    Integer tmpInt = tmpFloat.intValue();
    return tmpInt.toString();
  }

  /**
   * Sets alpha component of annotation background color as string
   *
   * @param bgAlpha Alpha component of annotation background color as string
   */
  public void setBgAlpha(String bgAlpha) {
    Float tmpFloat = Float.parseFloat(bgAlpha);
    this.bgAlpha = tmpFloat / 100;
  }

  /**
   * Gets red component of annotation font color as string
   *
   * @return Returns red component of annotation font color as string
   */
  public String getTextRed() {
    return textRed.toString();
  }

  /**
   * Sets red component of annotation font color as string
   *
   * @param textRed Red component of annotation font color as string
   */
  public void setTextRed(String textRed) {
    this.textRed = Integer.parseInt(textRed);
  }

  /**
   * Gets green component of annotation font color as string
   *
   * @return Returns green component of annotation font color as string
   */
  public String getTextGreen() {
    return textGreen.toString();
  }

  /**
   * Sets green component of annotation font color as string
   *
   * @param textGreen Green component of annotation font color as string
   */
  public void setTextGreen(String textGreen) {
    this.textGreen = Integer.parseInt(textGreen);
  }

  /**
   * Gets blue component of annotation font color as string
   *
   * @return Returns blue component of annotation font color as string
   */
  public String getTextBlue() {
    return textBlue.toString();
  }

  /**
   * Sets blue component of annotation font color as string
   *
   * @param textBlue Blue component of annotation font color as string
   */
  public void setTextBlue(String textBlue) {
    this.textBlue = Integer.parseInt(textBlue);
  }

  /**
   * Gets flag that indicates the font is bold
   *
   * @return Returns flag that indicates the font is bold
   */
  public Boolean getBold() {
    return bold;
  }

  /**
   * Sets flag that indicates the font is bold
   *
   * @param bold Flag that indicates the font is bold
   */
  public void setBold(Boolean bold) {
    this.bold = bold;
  }

  /**
   * Gets flag that indicates the font is italic
   *
   * @return Returns flag that indicates the font is italic
   */
  public Boolean getItalic() {
    return italic;
  }

  /**
   * Sets flag that indicates the font is italic
   *
   * @param italic Flag that indicates the font is italic
   */
  public void setItalic(Boolean italic) {
    this.italic = italic;
  }

  /**
   * Gets flag that indicates the font is underlined
   *
   * @return Returns flag that indicates the font is underlined
   */
  public Boolean getUnderlined() {
    return underlined;
  }

  /**
   * Sets flag that indicates the font is underlined
   *
   * @param underlined Flag that indicates the font is underlined
   */
  public void setUnderlined(Boolean underlined) {
    this.underlined = underlined;
  }

  /**
   * 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;
  }
  
  /**
   * Action listener for save button in the page for editing of user setting
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveAction(){
    boolean errorOccurred = false;
    errorMessage = "";
    
    if(annotTypeName.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsAnnotError") + " ";
      errorOccurred = true;
    }
    
    if(settingName.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsNameError") + " ";
      errorOccurred = true;
    }
    
    if((bgRed < 0) || (bgRed > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((bgGreen < 0) || (bgGreen > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((bgBlue < 0) || (bgBlue > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((bgAlpha < 0) || (bgAlpha > 100)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsAlphaError") + " ";
      errorOccurred = true;
    }
    
    if((textRed < 0) || (textRed > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((textGreen < 0) || (textGreen > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((textBlue < 0) || (textBlue > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }

    if(errorOccurred){
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
      return null;
    }
    
    setting.setName(makeName());
    setting.setValue(makeValue());
    setting.setUser(SessionManager.getSession().getEditedUser());

    if ((AppBean.getPersistenceManager().saveEntityChanges(setting)) == null) {
      errorMessage = MessageProvider.getMessage("changesNSDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of changes in the user settings failed.";
        Logger.getLogger(EditUser.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    }
    
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSavedValue(null);
    SessionManager.getSession().setSavedName(null);
    SessionManager.getSession().setEditedSetting(null);
    return "saved";
  }
  
  /**
   * Action listener for seve button on page for adding new user setting
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveNewAction(){
    boolean errorOccurred = false;
    errorMessage = "";
    
    if(annotTypeName.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsAnnotError") + " ";
      errorOccurred = true;
    }
    
    if(settingName.isEmpty()){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsNameError") + " ";
      errorOccurred = true;
    }
    
    if((bgRed < 0) || (bgRed > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((bgGreen < 0) || (bgGreen > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((bgBlue < 0) || (bgBlue > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((bgAlpha < 0) || (bgAlpha > 100)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsAlphaError") + " ";
      errorOccurred = true;
    }
    
    if((textRed < 0) || (textRed > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((textGreen < 0) || (textGreen > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }
    
    if((textBlue < 0) || (textBlue > 255)){
      errorMessage = errorMessage + MessageProvider.getMessage("userASSettingsColorError") + " ";
      errorOccurred = true;
    }

    if(errorOccurred){
      errorMessage = MessageProvider.getMessage("error") + " " + errorMessage;
      return null;
    }
    
    setting = new Settings(SessionManager.getSession().getEditedUser(),makeName(),makeValue());
    
    if (AppBean.getPersistenceManager().persistEntity(setting)) {
      errorMessage = 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 null;
    }
    
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSavedValue(null);
    SessionManager.getSession().setSavedName(null);
    SessionManager.getSession().setEditedSetting(null);
    return "saved";
  }
  
  /**
   * Returns "typeSelect"
   * @return 
   */
  public String btnSelectAction() {
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSavedValue(makeValue());
    SessionManager.getSession().setSavedName(makeName());
    return "typeSelect";
  }
  
  /**
   * Action listener for cancel button
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnCancelAction() {
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSavedValue(null);
    SessionManager.getSession().setSavedName(null);
    SessionManager.getSession().setEditedSetting(null);
    return "cancel";
  }
  
  /**
   * Action listener for delete button on deleting page. 
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnDeleteAction(){
    if(AppBean.getPersistenceManager().removeEntity(setting)){
      errorMessage = MessageProvider.getMessage("userSettingsDeleteError");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "DB failure during deleting of user settings.";
        Logger.getLogger(EditSubscriptions.class.getName()).log(Level.SEVERE, msg);
      }
      
      return null;
    }

    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSavedValue(null);
    SessionManager.getSession().setSavedName(null);
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedSetting(null);  // clean up variable in session
    return "cancel";
  }
  
  /**
   * Method parse input value string to element parts and save them to object properties
   *
   * @param value Input value string to parse
   */
  private void parseValue(String value){
    String[] result = value.split(";");
    if(result.length == 5){
      
      String bgColor = result[BACKGROUND_COLOR].substring(PREFIX_LENGTH,result[BACKGROUND_COLOR].indexOf(")"));
      String[] resultBg = bgColor.split(",");
      if(resultBg.length == 4){
        bgRed = Integer.parseInt(resultBg[RED]);
        bgGreen = Integer.parseInt(resultBg[GREEN]);
        bgBlue = Integer.parseInt(resultBg[BLUE]);
        bgAlpha = Float.parseFloat(resultBg[ALPHA]);
      }
      
      String fontColor = result[FONT_COLOR].substring(PREFIX_LENGTH,result[FONT_COLOR].indexOf(")"));
      String[] resultFont = fontColor.split(",");
      if(resultFont.length == 4){
        textRed = Integer.parseInt(resultFont[RED]);
        textGreen = Integer.parseInt(resultFont[GREEN]);
        textBlue = Integer.parseInt(resultFont[BLUE]);
      }
      
      bold = Boolean.valueOf(result[FONT_BOLD]);
      italic = Boolean.valueOf(result[FONT_ITALIC]);
      underlined = Boolean.valueOf(result[FONT_UNDERLINED]);
    }
  }
  
  /**
   * Method parse name value string to element parts and save them to object properties
   *
   * @param name Input name string to parse
   */
  private void parseName(String name){
    String[] result = name.split(":");
    if(result.length == 2){
      settingName = result[SETTING_NAME];
      annotTypeName = result[ANNOT_NAME];
    }else if(result.length == 1){
      settingName = result[SETTING_NAME];
      annotTypeName = "";
    }
  }
  
  /**
   * Method make from objects properties value string
   *
   * @return Returns value string
   */
  private String makeValue(){
    return "rgba(" + bgRed.toString() + "," + bgGreen.toString() + "," + bgBlue.toString() + "," + bgAlpha.toString() + ");" +
                    "rgba(" + textRed.toString() + "," + textGreen.toString() + "," + textBlue.toString() + ",1);" +
                    bold.toString() + ";" + italic.toString() + ";" + underlined.toString();
  }
  
  /**
   * Method make from objects properties name string
   *
   * @return Returns name string
   */
  private String makeName(){
    return settingName + ":" + annotTypeName;
  }

}