NotificationSubscriptionAndNewsFormatter.java

/**
* 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) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/
package org.olat.core.commons.services.notifications.ui;

import java.util.Map;

import org.olat.NewControllerFactory;
import org.olat.core.commons.services.notifications.NotificationsManager;
import org.olat.core.commons.services.notifications.Publisher;
import org.olat.core.commons.services.notifications.Subscriber;
import org.olat.core.commons.services.notifications.SubscriptionInfo;
import org.olat.core.commons.services.notifications.SubscriptionItem;
import org.olat.core.gui.translator.Translator;
import org.olat.core.util.filter.impl.OWASPAntiSamyXSSFilter;

/**
 * Description:<br>
 * This class provides helper methods to render notification news details
 * 
 * <P>
 * Initial Date: 22.12.2009 <br>
 * 
 * @author gnaegi
 */
public class NotificationSubscriptionAndNewsFormatter {

	private Translator translator;
	private Map<Subscriber, SubscriptionInfo> subsInfoMap;

	NotificationSubscriptionAndNewsFormatter(Translator translator, Map<Subscriber, SubscriptionInfo> subsInfoMap) {
		this.translator = translator;
		this.subsInfoMap = subsInfoMap;
	}

	public String getType(Subscriber sub) {
		Publisher pub = sub.getPublisher();
		String innerType = pub.getType();
		return NewControllerFactory.translateResourceableTypeName(innerType, translator.getLocale());
	}

	public String getContainerType(Subscriber sub) {
		Publisher pub = sub.getPublisher();
		String containerType = pub.getResName();
		return NewControllerFactory.translateResourceableTypeName(containerType, translator.getLocale());
	}

	public boolean hasNews(Subscriber sub) {
		return subsInfoMap.containsKey(sub);
	}
	
	public String getNewsAsHTML(Subscriber sub) {
		String news = getNews(sub, SubscriptionInfo.MIME_HTML);
		return news;
	}

	public String getNewsAsTxt(Subscriber sub) {
		return getNews(sub, SubscriptionInfo.MIME_PLAIN);
	}

	private String getNews(Subscriber sub, String mimeType) {
		SubscriptionInfo subsInfo = subsInfoMap.get(sub);
		if (subsInfo == null || !subsInfo.hasNews()) return translator.translate("news.no.news");
		return subsInfo.getSpecificInfo(mimeType, translator.getLocale());
	}

	public String getTitleAsHTML(Subscriber sub) {
		String htmlTitle = getTitle(sub, SubscriptionInfo.MIME_HTML);
		return new OWASPAntiSamyXSSFilter().filter(htmlTitle);
	}

	public String getTitleAsTxt(Subscriber sub) {
		String textTitle = getTitle(sub, SubscriptionInfo.MIME_PLAIN);
		return textTitle;
	}

	private String getTitle(Subscriber sub, String mimeType) {
		SubscriptionInfo subsInfo = subsInfoMap.get(sub);
		if (subsInfo == null) return "";
		String title = subsInfo.getTitle(mimeType);
		return title;
	}
	
	public String getCustomUrl(Subscriber sub) {
		SubscriptionInfo subsInfo = subsInfoMap.get(sub);
		return subsInfo.getCustomUrl();
	}

	public SubscriptionItem getSubscriptionItem(Subscriber sub) {
		SubscriptionInfo subsInfo = subsInfoMap.get(sub);
		NotificationsManager notiMgr = NotificationsManager.getInstance();
		SubscriptionItem subscrItem = notiMgr.createSubscriptionItem(subsInfo, sub, translator.getLocale(), SubscriptionInfo.MIME_HTML, SubscriptionInfo.MIME_HTML);
		return subscrItem;		
	}
}