Package org.olat.core.commons.services.commentAndRating.impl

Source Code of org.olat.core.commons.services.commentAndRating.impl.UserCommentsManagerImpl

/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) frentix GmbH<br>
* http://www.frentix.com<br>
* <p>
*/
package org.olat.core.commons.services.commentAndRating.impl;

import java.util.List;

import org.hibernate.Hibernate;
import org.hibernate.type.Type;
import org.olat.core.commons.persistence.DB;
import org.olat.core.commons.persistence.DBFactory;
import org.olat.core.commons.persistence.DBQuery;
import org.olat.core.commons.services.commentAndRating.UserCommentsManager;
import org.olat.core.commons.services.commentAndRating.model.UserComment;
import org.olat.core.id.Identity;
import org.olat.core.id.OLATResourceable;
import org.olat.core.logging.AssertException;

/**
* Description:<br>
* This implementation of the user comments manager is database based.
*
* <P>
* Initial Date: 23.11.2009 <br>
*
* @author gnaegi
*/
public class UserCommentsManagerImpl extends UserCommentsManager {

  /**
   * Spring constructor. Use the getInstance method instead of calling this
   * constructor directly.
   */
  public UserCommentsManagerImpl() {
    // nothing to do
  }

  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#createCommentManager(org.olat.core.id.OLATResourceable,
   *      java.lang.String)
   */
  @Override
  protected UserCommentsManager createCommentManager(OLATResourceable ores,
      String subpath) {
    UserCommentsManager manager = new UserCommentsManagerImpl();
    manager.init(ores, subpath);
    return manager;
  }

  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#countComments()
   */
  @Override
  public Long countComments() {
    DBQuery query;
    if (getOLATResourceableSubPath() == null) {
      // special query when sub path is null
      query = DBFactory
          .getInstance()
          .createQuery(
              "select count(*) from UserCommentImpl where resName=:resname AND resId=:resId AND resSubPath is NULL");
    } else {
      query = DBFactory
          .getInstance()
          .createQuery(
              "select count(*) from UserCommentImpl where resName=:resname AND resId=:resId AND resSubPath=:resSubPath");
      query.setString("resSubPath", getOLATResourceableSubPath());
    }
    query.setString("resname", getOLATResourceable()
        .getResourceableTypeName());
    query.setLong("resId", getOLATResourceable().getResourceableId());
    query.setCacheable(true);
    //
    Long count = (Long) query.list().get(0);
    return count;
  }

  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#createComment(org.olat.core.id.Identity,
   *      java.lang.String)
   */
  @Override
  public UserComment createComment(Identity creator, String commentText) {
    UserComment comment = new UserCommentImpl(getOLATResourceable(),
        getOLATResourceableSubPath(), creator, commentText);
    DBFactory.getInstance().saveObject(comment);
    return comment;
  }
 
  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#reloadComment(org.olat.core.commons.services.commentAndRating.model.UserComment)
   */
  public UserComment reloadComment(UserComment comment) {
    try {
      DB db = DBFactory.getInstance();
      return (UserComment) db.loadObject(comment);     
    } catch (Exception e) {
      // Huh, most likely the given object does not exist anymore on the
      // db, probably deleted by someone else
      logWarn("Tried to reload a user comment but got an exception. Probably deleted in the meantime", e);
      return null;
    }   
  }


  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#replyTo(org.olat.core.commons.services.commentAndRating.model.UserComment,
   *      org.olat.core.id.Identity, java.lang.String)
   */
  @Override
  public UserComment replyTo(UserComment originalComment, Identity creator,
      String replyCommentText) {
    if (!isCommentOfResource(originalComment)) {
      throw new AssertException(
          "This user comment manager is initialized for another resource than the given comment.");
    }
    // First reload parent from cache to prevent stale object or cache issues
    originalComment = reloadComment(originalComment);
    if (originalComment == null) {
      // Original comment has been deleted in the meantime. Don't create a reply
      return null;
    }
    UserCommentImpl reply = new UserCommentImpl(getOLATResourceable(),
        getOLATResourceableSubPath(), creator, replyCommentText);
    reply.setParent(originalComment);
    DBFactory.getInstance().saveObject(reply);
    return reply;
  }

  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#getComments()
   */
  @Override
  public List<UserComment> getComments() {
    DBQuery query;
    if (getOLATResourceableSubPath() == null) {
      // special query when sub path is null
      query = DBFactory
          .getInstance()
          .createQuery(
              "select comment from UserCommentImpl as comment where resName=:resname AND resId=:resId AND resSubPath is NULL");
    } else {
      query = DBFactory
          .getInstance()
          .createQuery(
              "select comment from UserCommentImpl as comment where resName=:resname AND resId=:resId AND resSubPath=:resSubPath");
      query.setString("resSubPath", getOLATResourceableSubPath());
    }
    query.setString("resname", getOLATResourceable()
        .getResourceableTypeName());
    query.setLong("resId", getOLATResourceable().getResourceableId());
    query.setCacheable(true);
    //
    List<UserComment> results = query.list();
    return results;
  }

  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#updateComment(org.olat.core.commons.services.commentAndRating.model.UserComment)
   */
  @Override
  public UserComment updateComment(UserComment comment, String newCommentText) {
    if (!isCommentOfResource(comment)) {
      throw new AssertException(
          "This user comment manager is initialized for another resource than the given comment.");
    }
    // First reload parent from cache to prevent stale object or cache issues
    comment = reloadComment(comment);
    if (comment == null) {
      // Original comment has been deleted in the meantime. Don't update it
      return null;
    }
    // Update DB entry
    comment.setComment(newCommentText);
    DB db = DBFactory.getInstance();
    db.updateObject(comment);
    return comment;
  }

  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#deleteComment(org.olat.core.commons.services.commentAndRating.model.UserComment, boolean)
   */
  @Override
  public int deleteComment(UserComment comment, boolean deleteReplies) {
    if (!isCommentOfResource(comment)) {
      throw new AssertException(
          "This user comment manager is initialized for another resource than the given comment.");
    }
    int counter = 0;
    // First reload parent from cache to prevent stale object or cache issues
    comment = reloadComment(comment);
    if (comment == null) {
      // Original comment has been deleted in the meantime. Don't delete it again.
      return 0;
    }
    DB db = DBFactory.getInstance();
    // First deal with all direct replies
    DBQuery query = db.createQuery("select comment from UserCommentImpl as comment where parent=:parent");
    query.setEntity("parent", comment);
    List<UserComment> replies = query.list();
    if (deleteReplies) {
      // Since we have a many-to-one we first have to recursively delete
      // the replies to prevent foreign key constraints
      for (UserComment reply : replies) {
        counter += deleteComment(reply, true);
      }
    } else {
      // To not delete the replies we have to set the parent to the parent
      // of the original comment for each reply
      for (UserComment reply : replies) {
        reply.setParent(comment.getParent());
        db.updateObject(reply);
      }
    }
    // Now delete this comment and finish
    db.deleteObject(comment);
    return counter+1;
  }
 
  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#deleteAllComments()
   */
  public int deleteAllComments() {
    DB db = DBFactory.getInstance();
    String query;
    Object[] values;
    Type[] types;
    // special query when sub path is null
    if (getOLATResourceableSubPath() == null) {
      query = "from UserCommentImpl where resName=? AND resId=? AND resSubPath is NULL";
      values = new Object[] { getOLATResourceable().getResourceableTypeName(),  getOLATResourceable().getResourceableId() };
      types = new Type[] {Hibernate.STRING, Hibernate.LONG};
    } else {
      query = "from UserCommentImpl where resName=? AND resId=? AND resSubPath=?";
      values = new Object[] { getOLATResourceable().getResourceableTypeName(),  getOLATResourceable().getResourceableId(), getOLATResourceableSubPath() };
      types = new Type[] {Hibernate.STRING, Hibernate.LONG, Hibernate.STRING};
    }
    return db.delete(query, values, types);
  }

  /**
   * @see org.olat.core.commons.services.commentAndRating.UserCommentsManager#deleteAllCommentsIgnoringSubPath()
   */
  public int deleteAllCommentsIgnoringSubPath() {
    // Don't limit to subpath. Ignore if null or not, just delete on the resource
    String query = "from UserCommentImpl where resName=? AND resId=?";
    Object[] values = new Object[] { getOLATResourceable().getResourceableTypeName(),  getOLATResourceable().getResourceableId() };
    Type[] types = new Type[] {Hibernate.STRING, Hibernate.LONG};
    DB db = DBFactory.getInstance();
    return db.delete(query, values, types);   
  }

 
  /**
   * Helper method to check if the given comment has the same resource and
   * path as configured for this manager
   *
   * @param originalComment
   * @return
   */
  private boolean isCommentOfResource(UserComment originalComment) {
    if (this.getOLATResourceable().getResourceableId().equals(
        originalComment.getResId())
        && this.getOLATResourceable().getResourceableTypeName().equals(
            originalComment.getResName())) {
      // check on resource subpath: can be null
      if (this.getOLATResourceableSubPath() == null) {
        return (originalComment.getResSubPath() == null);
      } else {
        return this.getOLATResourceableSubPath().equals(
            originalComment.getResSubPath());
      }
    }
    return false;
  }

}
TOP

Related Classes of org.olat.core.commons.services.commentAndRating.impl.UserCommentsManagerImpl

TOP
Copyright © 2015 www.massapi.com. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.