InfoMessageManagerImpl.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <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 the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <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>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */

package org.olat.commons.info.manager;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.StringTokenizer;

import org.olat.basesecurity.IdentityRef;
import org.olat.commons.info.model.InfoMessage;
import org.olat.commons.info.model.InfoMessageImpl;
import org.olat.core.commons.persistence.DB;
import org.olat.core.commons.persistence.DBQuery;
import org.olat.core.id.Identity;
import org.olat.core.id.OLATResourceable;
import org.olat.core.util.StringHelper;
import org.olat.group.BusinessGroupRef;

/**
 * 
 * Description:<br>
 * The manager for info messages
 * 
 * <P>
 * Initial Date:  26 jul. 2010 <br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 */
public class InfoMessageManagerImpl extends InfoMessageManager {
	
	private DB dbInstance;
	
	/**
	 * [used by Spring]
	 */
	private InfoMessageManagerImpl() {
		INSTANCE = this;
	}
	
	/**
	 * [used by Spring]
	 * @param dbInstance
	 */
	public void setDbInstance(DB dbInstance) {
		this.dbInstance = dbInstance;
	}

	@Override
	public InfoMessage createInfoMessage(OLATResourceable ores, String subPath, String businessPath, Identity author) {
		if(ores == null) throw new NullPointerException("OLAT Resourceable cannot be null");
		
		InfoMessageImpl info = new InfoMessageImpl();
		info.setResId(ores.getResourceableId());
		info.setResName(ores.getResourceableTypeName());
		info.setResSubPath(subPath);
		info.setBusinessPath(normalizeBusinessPath(businessPath));
		info.setAuthor(author);
		return info;
	}

	@Override
	public void saveInfoMessage(InfoMessage infoMessage) {
		if(infoMessage instanceof InfoMessageImpl) {
			InfoMessageImpl impl = (InfoMessageImpl)infoMessage;
			if(impl.getKey() == null) {
				dbInstance.saveObject(impl);
			} else {
				dbInstance.updateObject(impl);
			}
		}
	}

	@Override
	public void deleteInfoMessage(InfoMessage infoMessage) {
		if(infoMessage instanceof InfoMessageImpl) {
			InfoMessageImpl impl = (InfoMessageImpl)infoMessage;
			if(impl.getKey() != null) {
				dbInstance.deleteObject(impl);
			}
		}
	}
	

	@Override
	public List<InfoMessage> loadInfoMessagesOfIdentity(BusinessGroupRef businessGroup, IdentityRef identity) {
		StringBuilder sb = new StringBuilder();
		sb.append("select msg from ").append(InfoMessageImpl.class.getName()).append(" msg")
			.append(" left join fetch msg.author author")
			.append(" left join fetch author.user")
			.append(" left join fetch msg.modifier modifier")
			.append(" left join fetch modifier.user")
			.append(" where (author.key=:authorKey")
			.append(" or modifier.key=:authorKey)")
			.append(" and msg.resId=:groupKey");
		return dbInstance.getCurrentEntityManager()
				.createQuery(sb.toString(), InfoMessage.class)
				.setParameter("authorKey",identity.getKey())
				.setParameter("groupKey", businessGroup.getKey())
				.getResultList();
	}

	@Override
	public InfoMessage loadInfoMessageByKey(Long key) {
		StringBuilder sb = new StringBuilder();
		sb.append("select msg from ").append(InfoMessageImpl.class.getName()).append(" msg")
			.append(" left join fetch msg.author author")
			.append(" left join fetch author.user")
			.append(" left join fetch msg.modifier modifier")
			.append(" left join fetch modifier.user")
			.append(" where msg.key=:key");
		
		List<InfoMessage> infoMessages = dbInstance.getCurrentEntityManager()
				.createQuery(sb.toString(), InfoMessage.class)
				.setParameter("key", key)
				.getResultList();
		if (infoMessages.size() == 0) {
			return null;
		}
		return infoMessages.get(0);
	}

	@Override
	public List<InfoMessage> loadInfoMessageByResource(OLATResourceable ores, String subPath, String businessPath,
			Date after, Date before, int firstResult, int maxResults) {
		
		DBQuery query = queryInfoMessageByResource(ores, subPath, businessPath, after, before, false);
		if(firstResult >= 0) {
			query.setFirstResult(firstResult);
		}
		if(maxResults > 0) {
			query.setMaxResults(maxResults);
		}
		
		@SuppressWarnings("unchecked")
		List<InfoMessage> msgs = query.list();
		return msgs;
	}
	
	@Override
	public int countInfoMessageByResource(OLATResourceable ores, String subPath, String businessPath,
			Date after, Date before) {
		
		DBQuery query = queryInfoMessageByResource(ores, subPath, businessPath, after, before, true);
		Number count = (Number)query.uniqueResult();
		return count.intValue();
	}
	
	private DBQuery queryInfoMessageByResource(OLATResourceable ores, String subPath, String businessPath,
			Date after, Date before, boolean count) {
		
		StringBuilder sb = new StringBuilder();
		sb.append("select ");
		if(count)
			sb.append("count(msg.key)");
		else
			sb.append("msg");
		
		sb.append(" from ").append(InfoMessageImpl.class.getName()).append(" msg");
		
		if (!count) {
			sb.append(" left join fetch msg.author author")
			.append(" left join fetch author.user")
			.append(" left join fetch msg.modifier modifier")
			.append(" left join fetch modifier.user");
		}
		
		if(ores != null) {
			appendAnd(sb, "msg.resId=:resId and msg.resName=:resName ");
		}
		if(StringHelper.containsNonWhitespace(subPath)) {
			appendAnd(sb, "msg.resSubPath=:subPath");
		}
		if(StringHelper.containsNonWhitespace(businessPath)) {
			appendAnd(sb, "msg.businessPath=:businessPath");
		}
		if(after != null) {
			appendAnd(sb, "msg.creationDate>=:after");
		}
		if(before != null) {
			appendAnd(sb, "msg.creationDate<=:before");
		}
		if(!count) {
			sb.append(" order by msg.creationDate desc");
		}
		
		DBQuery query = dbInstance.createQuery(sb.toString());
		if(ores != null) {
			query.setLong("resId", ores.getResourceableId());
			query.setString("resName", ores.getResourceableTypeName());
		}
		if(StringHelper.containsNonWhitespace(subPath)) {
			query.setString("subPath", subPath);
		}
		if(StringHelper.containsNonWhitespace(businessPath)) {
			query.setString("businessPath", normalizeBusinessPath(businessPath));
		}
		if(after != null) {
			query.setTimestamp("after", after);
		}
		if(before != null) {
			query.setTimestamp("before", before);
		}
		
		return query;
	}
	
	private StringBuilder appendAnd(StringBuilder sb, String query) {
		if(sb.indexOf("where") > 0) sb.append(" and ");
		else sb.append(" where ");
		sb.append(query);
		return sb;
	}
	
	private String normalizeBusinessPath(String url) {
		if (url == null) return null;
		if (url.startsWith("ROOT")) {
			url = url.substring(4, url.length());
		}
		List<String> tokens = new ArrayList<String>();
		for(StringTokenizer tokenizer = new StringTokenizer(url, "[]"); tokenizer.hasMoreTokens(); ) {
			String token = tokenizer.nextToken();
			if(!tokens.contains(token)) {
				tokens.add(token);
			}
		}
		
		StringBuilder sb = new StringBuilder();
		for(String token:tokens) {
			sb.append('[').append(token).append(']');
		}
		return sb.toString();
	}
}