EditSubscriptions.java

Go to the documentation of this file.

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

/**
 * @file EditSubscriptions.java
 *
 * @brief Backbean for pages for adding, editing and deleting of StoryScope's subscriptions
 */

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.AnnotType;
import cz.vutbr.fit.knot.annotations.entity.User;
import cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.StoryScope;
import cz.vutbr.fit.knot.annotations.modules.StoryscopeInterface.SubscribedItem;
import java.io.Serializable;
import java.util.List;
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 StoryScope's subscriptions
 *
 * @brief Backbean for pages for adding, editing and deleting of StoryScope's subscriptions
 * @author Martin Petr (xpetrm05)
 */
@ManagedBean
@ViewScoped
public class EditSubscriptions implements Serializable{
  /**
   * Value represent URI of annotation's type
   */
  private String annotURI = null;
  /**
   * Value represent login of user
   */
  private String userLogin = null;
  /**
   * Value represent URI of source (StoryScope, Group, etc..)
   */
  private String sourceURI = null;
  /**
   * Value represent type of subscription (subscribe or unsubscribe)
   */
  private Integer subscriptionType = null;
  /**
   * Object of edited subscription
   */
  private SubscribedItem subscribedItem = null;
  /**
   * Error message displayed in form
   */
  private String errorMessage = null;
  /**
   * StorySapce which subscription belongs
   */
  private StoryScope editedStoryScope = null;
  
  
  /**
   * Constructor
   */
  public EditSubscriptions() {
  }

  /**
   * Gets value that represent type of subscription (subscribe or unsubscribe)
   * 
   * @return Returns value that represent type of subscription (subscribe or unsubscribe)
   */
  public Integer getSubscriptionType(){
    if(subscribedItem == null){
      subscribedItem = SessionManager.getSession().getEditedSubscription();
      if(subscribedItem == null){
        subscribedItem = new SubscribedItem();
        subscribedItem.setStoryScopeId(SessionManager.getSession().getEditedStoryScope().getId());
      }
    }
    
    SubscribedItem backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
       if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("SubscribedItem")) {
         backup = (SubscribedItem) SessionManager.getSession().getFormBackup();
         if (backup.getId() != subscribedItem.getId()) {
          backup = null;
        }
       }
    }
    
    subscriptionType = SessionManager.getSession().getSaveSubscriptionType();
    
    if(subscriptionType == null && backup != null) {
      subscriptionType = backup.getType();
    } else if(subscriptionType == null && subscribedItem != null) {
      subscriptionType = subscribedItem.getType();
    } else if(subscriptionType == null) {
      subscriptionType = 0;
    }
    return subscriptionType;
  }

  /**
   * Sets value that represent type of subscription (subscribe or unsubscribe)
   *
   * @param annotType value that represent type of subscription (subscribe or unsubscribe)
   */
  public void setSubscriptionType(Integer annotType){
    this.subscriptionType = annotType;
  }
  
  /**
   * Gets edited subscription annotation type URI field in form
   * If StoryScope not set yet, pick up it from session
   *
   * @return Returns subscription annotation type URI
   */
  public String getAnnotURI(){
    if(subscribedItem == null){
      subscribedItem = SessionManager.getSession().getEditedSubscription();
      if(subscribedItem == null){
        subscribedItem = new SubscribedItem();
        subscribedItem.setStoryScopeId(SessionManager.getSession().getEditedStoryScope().getId());
      }
    }
    
    SubscribedItem backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
       if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("SubscribedItem")) {
         backup = (SubscribedItem) SessionManager.getSession().getFormBackup();
         if (backup.getId() != subscribedItem.getId()) {
          backup = null;
        }
       }
    }
    
    SubscribedItem tempItem = null;
    
    annotURI = SessionManager.getSession().getAnnotationTypeAddress();
    
    if(annotURI == null && backup != null) {
      tempItem = backup;
    } else if(annotURI == null && subscribedItem != null) {
      tempItem = subscribedItem;
    } else if(annotURI == null) {
      annotURI = "";
      return annotURI;
    }
    
    if(tempItem != null)
    {
      if(tempItem.getAnnotationType() == null){
        annotURI = "";
        return annotURI;
      }
      
      Object[] params = {"id",tempItem.getAnnotationType().getId()};
      @SuppressWarnings("unchecked")
      List<AnnotType> list = AppBean.getPersistenceManager().queryDB("AnnotType.findById",params);
      if(list == null){
        errorMessage = MessageProvider.getMessage("ssSubsEditTypeNotFound");
        return null;
      }

      annotURI = list.get(0).getUri();
    }
    return annotURI;
  }

  /**
   * Sets value that represent edited subscription annotation type URI field in form
   *
   * @param annotURI value that represent edited subscription annotation type URI field in form
   */
  public void setAnnotURI(String annotURI){
    this.annotURI = annotURI;
  }
  
  /**
   * Gets value that represent URI of source (StoryScope, Group, etc..)
   * 
   * @return Returns value that represent URI of source (StoryScope, Group, etc..)
   */
  public String getSourceURI(){
    if(subscribedItem == null){
      subscribedItem = SessionManager.getSession().getEditedSubscription();
      if(subscribedItem == null){
        subscribedItem = new SubscribedItem();
        subscribedItem.setStoryScopeId(SessionManager.getSession().getEditedStoryScope().getId());
      }
    }
    
    SubscribedItem backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
       if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("SubscribedItem")) {
         backup = (SubscribedItem) SessionManager.getSession().getFormBackup();
         if (backup.getId() != subscribedItem.getId()) {
          backup = null;
        }
       }
    }
    
    sourceURI = SessionManager.getSession().getSaveSourceUri();
    
    if(sourceURI == null && backup != null) {
      sourceURI = backup.getSource();
    } else if(sourceURI == null && subscribedItem != null) {
      sourceURI = subscribedItem.getSource();
    } else if(sourceURI == null) {
      sourceURI = "";
    }
    
    return sourceURI;
  }
  
  /**
   * Sets value that represent URI of source (StoryScope, Group, etc..)
   *
   * @param sourceURI value that represent URI of source (StoryScope, Group, etc..)
   */
  public void setSourceURI(String sourceURI){
    this.sourceURI = sourceURI;
  }

  /**
   * Gets login of user that is subscribed (or unsubscribed)
   * 
   * @return Returns login of user that is subscribed (or unsubscribed)
   */
  public String getUserLogin(){
    if(subscribedItem == null){
      subscribedItem = SessionManager.getSession().getEditedSubscription();
    }
    
    SubscribedItem backup = null;
    if (SessionManager.getSession().getFormBackup() != null) {
       if (SessionManager.getSession().getFormBackup().getClass().getName().endsWith("SubscribedItem")) {
         backup = (SubscribedItem) SessionManager.getSession().getFormBackup();
         if (backup.getId() != subscribedItem.getId()) {
          backup = null;
        }
       }
    }
    
    SubscribedItem tempItem = null;
    
    userLogin = SessionManager.getSession().getSaveUserLogin();

    if(userLogin == null && backup != null) {
      tempItem = backup;
    } else if(userLogin == null && subscribedItem != null) {
      tempItem = subscribedItem;
    } else if(userLogin == null) {
      userLogin = "";
      return userLogin;
    }
    
    if(tempItem != null)
    {
      if(tempItem.getUser() == null){
        userLogin = "";
        return userLogin;
      }
      
      Object[] params = {"id",tempItem.getUser().getId()};
      @SuppressWarnings("unchecked")
      List<User> list = AppBean.getPersistenceManager().queryDB("User.findById",params);
      if(list == null){
        errorMessage = MessageProvider.getMessage("ssSubsEditUserNotFound");
        return null;
      }

      userLogin = list.get(0).getLogin();
    }
    return userLogin;
  }

  /**
   * Sets login of user that will be subscribed (or unsubscribed)
   *
   * @param userURI login of user that will be subscribed (or unsubscribed)
   */
  public void setUserLogin(String userURI){
    this.userLogin = userURI;
  }
  
  /**
   * Gets object of edited subscription
   * 
   * @return Returns object of edited subscription
   */
  public SubscribedItem getSubscribedItem() {
    return subscribedItem;
  }

  /**
   * Sets object of edited subscription
   *
   * @param subscribedItem object of edited subscription
   */
  public void setSubscribedItem(SubscribedItem subscribedItem) {
    this.subscribedItem = subscribedItem;
  }
  
  /**
   * 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 the Subscription
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnSaveAction(){
    boolean isErrorOccured = false;
    errorMessage = "";

    if(!annotURI.isEmpty() && annotURI != null){
      Object[] params = {"uri",annotURI};
      @SuppressWarnings("unchecked")
      List<AnnotType> list = AppBean.getPersistenceManager().queryDB("AnnotType.findByUri",params);
      if(list == null || list.isEmpty()){
        errorMessage += MessageProvider.getMessage("ssSubsCantFindType");
        isErrorOccured = true;
      }else{
        subscribedItem.setAnnotationType(list.get(0));
      }  
    }else{
      subscribedItem.setAnnotationType(null);
    }
    
    if(!userLogin.isEmpty() && userLogin != null){
      Object[] params = {"login",userLogin};
      @SuppressWarnings("unchecked")
      List<User> list = AppBean.getPersistenceManager().queryDB("User.findByLogin",params);
      if(list == null || list.isEmpty()){
        errorMessage += MessageProvider.getMessage("ssSubsCantFindUser");
        isErrorOccured = true;
      }else{
        subscribedItem.setUser(list.get(0));
      }   
    }else{
      subscribedItem.setUser(null);
    }
    
    if(!sourceURI.isEmpty() && sourceURI != null){
      subscribedItem.setSource(sourceURI);
    }else{
      subscribedItem.setSource(null);
    }
    
    if(subscriptionType != null && !(subscriptionType == SubscribedItem.SUBSCRIBED || subscriptionType == SubscribedItem.UNSUBSCRIBED)){
      errorMessage += MessageProvider.getMessage("ssSubsTypeIncorrect");
      isErrorOccured = true;
    }else{
      subscribedItem.setType(subscriptionType);
    }
    
    if(isErrorOccured){
      return null;
    }
    
    subscribedItem.setType(subscriptionType);
    

    editedStoryScope = SessionManager.getSession().getEditedStoryScope();
    if(editedStoryScope == null){
      errorMessage = MessageProvider.getMessage("ssSubsCantReachSS");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Can't reach edited StoryScope.";
        Logger.getLogger(EditSubscriptions.class.getName()).log(Level.SEVERE, msg);
      }

      return null;
    }
    
    
    subscribedItem.setStoryScopeId(editedStoryScope.getId());
    
    SubscribedItem saved = (SubscribedItem) AppBean.getPersistenceManager().saveEntityChanges(subscribedItem);
    if (saved == null) {
      errorMessage = MessageProvider.getMessage("ssSubsEditDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of changes in subscribed item for StoryScope account failed.";
        Logger.getLogger(EditSubscriptions.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    } else {  // if changes was successfully saved
      subscribedItem = saved;
    }
    
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSaveUserLogin(null);
    SessionManager.getSession().setSaveSubscriptionType(null);
    SessionManager.getSession().setSaveSourceUri(null);
    SessionManager.getSession().setEditedSubscription(null);
    return "subscribed";
  }
  
  /**
   * Action listener for save button on page for adding new Subscription
   *
   * @return Returns page outcome (identificator of next page or null to stay here)
   */
  public String btnNewAction(){
    boolean isErrorOccured = false;
    subscribedItem = new SubscribedItem();
    errorMessage = "";
    
    // test if uri of annotation type is fill
    if(!annotURI.isEmpty() && annotURI != null){
      // if URI si fill then try to find type in database
      Object[] params = {"uri",annotURI};
      @SuppressWarnings("unchecked")
      List<AnnotType> list = AppBean.getPersistenceManager().queryDB("AnnotType.findByUri",params);
      if(list == null || list.isEmpty()){
        // type not found, print error
        errorMessage += MessageProvider.getMessage("ssSubsCantFindType");
        isErrorOccured = true;
      }else{
        //when is URI correct save it
        subscribedItem.setAnnotationType(list.get(0));
      }
    }
    
    // test if user login is fill
    if(!userLogin.isEmpty() && userLogin != null){
      // if is login fill try to find user in database
      Object[] params = {"login",userLogin};
      @SuppressWarnings("unchecked")
      List<User> list = AppBean.getPersistenceManager().queryDB("User.findByLogin",params);
      if(list == null || list.isEmpty()){
        // user not found, print error
        errorMessage += MessageProvider.getMessage("ssSubsCantFindUser");
        isErrorOccured = true;
      }else{
        //when is user correct save it
        subscribedItem.setUser(list.get(0));
      }      
    }
    
    // if source uri is fill
    if(!sourceURI.isEmpty() && sourceURI != null){
      // save source uri
      subscribedItem.setSource(sourceURI);
    }
    
    // subscription type must be fill and must have correct value
    if(subscriptionType != null && !(subscriptionType == SubscribedItem.SUBSCRIBED || subscriptionType == SubscribedItem.UNSUBSCRIBED)){
      errorMessage += MessageProvider.getMessage("ssSubsTypeIncorrect");
      isErrorOccured = true;
    }else{
      subscribedItem.setType(subscriptionType);
    }
    
    if(isErrorOccured){
      return null;
    }
    
    subscribedItem.setType(subscriptionType);
    
    editedStoryScope = SessionManager.getSession().getEditedStoryScope();
    if(editedStoryScope == null){
      errorMessage = MessageProvider.getMessage("ssSubsCantReachSS");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Can't reach edited StoryScope.";
        Logger.getLogger(EditSubscriptions.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    }
    
    
    subscribedItem.setStoryScopeId(editedStoryScope.getId());
    //try to save into DB
    if(AppBean.getPersistenceManager().persistEntity(subscribedItem)){
      errorMessage = MessageProvider.getMessage("ssSubsAddDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "Persisting of new subscription for StoryScope account failed.";
        Logger.getLogger(EditSubscriptions.class.getName()).log(Level.SEVERE, msg);
      }
      return null;
    }
    
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSaveUserLogin(null);
    SessionManager.getSession().setSaveSubscriptionType(null);
    SessionManager.getSession().setSaveSourceUri(null);
    SessionManager.getSession().setEditedSubscription(null);
    return "subscribed";
  }
  
  /**
   * 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(subscribedItem)){
      errorMessage = MessageProvider.getMessage("ssSubsDeleteDatabaseFailure");
      if (Constants.LOG_LEVEL >= Constants.LOG_LEVEL_SERVER_ERRORS) {
        String msg = "DB failure during deleting of Subscribtion form StoryScope account.";
        Logger.getLogger(EditSubscriptions.class.getName()).log(Level.SEVERE, msg);
      }
      
      return null;
    }
    
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSaveUserLogin(null);
    SessionManager.getSession().setSaveSubscriptionType(null);
    SessionManager.getSession().setSaveSourceUri(null);
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedSubscription(null);  // clean up variable in session
    return "subscribed";
  }
  
  /**
   * Action listener for select button
   *
   * @return Returns page outcome
   */
  public String btnSelectAction() {
    SessionManager.getSession().setAnnotationTypeAddress(null);
    if(subscribedItem == null) SessionManager.getSession().setComeFrom("editSubscription");
    else SessionManager.getSession().setComeFrom("addSubscription");
    SessionManager.getSession().setSaveUserLogin(userLogin);
    SessionManager.getSession().setSaveSubscriptionType(subscriptionType);
    SessionManager.getSession().setSaveSourceUri(sourceURI);
    return "typeSelect";
  }
  
  /**
   * Action listener for cancel button
   *
   * @return Returns page outcome
   */
  public String btnCancelAction() {
    SessionManager.getSession().setAnnotationTypeAddress(null);
    SessionManager.getSession().setSaveUserLogin(null);
    SessionManager.getSession().setSaveSubscriptionType(null);
    SessionManager.getSession().setSaveSourceUri(null);
    SessionManager.getSession().setFormBackup(null);
    SessionManager.getSession().setEditedSubscription(null);  // clean up variable in session
    return "subscribed";
  }
}