ContextualSubscriptionController.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.  
* <p>
*/ 

package org.olat.core.commons.services.notifications.ui;

import org.olat.core.commons.services.notifications.NotificationsManager;
import org.olat.core.commons.services.notifications.PublisherData;
import org.olat.core.commons.services.notifications.SubscriptionContext;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.Component;
import org.olat.core.gui.components.link.Link;
import org.olat.core.gui.components.link.LinkFactory;
import org.olat.core.gui.components.panel.Panel;
import org.olat.core.gui.components.velocity.VelocityContainer;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.controller.BasicController;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * Description: <br>
 * Controller having a subscribe / unsubscribe button for notifications depending on users state
 * 
 * @author Felix Jost
 */
public class ContextualSubscriptionController extends BasicController {

	private VelocityContainer myContent;
	private Link subscribeButton;
	private Link unsubscribeButton;
	private SubscriptionContext subscriptionContext;
	private boolean isSubscribed;
	private final PublisherData publisherData;
	
	@Autowired
	private NotificationsManager notifManager;
	
	/**
	 * @param ureq
	 * @param subscriptionContext
	 * @param publisherData
	 */
	public ContextualSubscriptionController(UserRequest ureq, WindowControl wControl, SubscriptionContext subscriptionContext, PublisherData publisherData) {
		super(ureq, wControl);
		this.subscriptionContext = subscriptionContext;
		this.publisherData = publisherData;
		myContent = createVelocityContainer("consubs");
		myContent.setDomReplacementWrapperRequired(false); // we provide our own DOM replacement ID
		
		if (subscriptionContext == null) {
			putInitialPanel(new Panel("empty:nosubscription"));
			return;
		}

		subscribeButton = LinkFactory.createCustomLink("command.subscribe", "command.subscribe", "off", Link.LINK, myContent, this);
		subscribeButton.setCustomEnabledLinkCSS("o_noti_subscribe_link o_button_toggle");
		subscribeButton.setIconLeftCSS("o_icon o_icon_toggle");
		subscribeButton.setTitle("command.subscribe");
		
		unsubscribeButton = LinkFactory.createCustomLink("command.unsubscribe", "command.unsubscribe", "on", Link.LINK, myContent, this);
		unsubscribeButton.setCustomEnabledLinkCSS("o_noti_unsubscribe_link o_button_toggle o_on");
		unsubscribeButton.setIconRightCSS("o_icon o_icon_toggle");
		unsubscribeButton.setTitle("command.unsubscribe");
		
		// if subscribed, offer a unsubscribe button and vica versa.
		isSubscribed = notifManager.isSubscribed(ureq.getIdentity(), subscriptionContext);

		updateUI();
		putInitialPanel(myContent);
	}
	
	public boolean isSubscribed() {
		return isSubscribed;
	}

	private void updateUI() {
		myContent.contextPut("subscribed", (isSubscribed ? Boolean.TRUE : Boolean.FALSE));
	}

	/**
	 * 
	 * @see org.olat.core.gui.control.DefaultController#event(org.olat.core.gui.UserRequest, org.olat.core.gui.components.Component, org.olat.core.gui.control.Event)
	 */
	public void event(UserRequest ureq, Component source, Event event) {
		if (source == subscribeButton) {
			notifManager.subscribe(ureq.getIdentity(), subscriptionContext, publisherData);
			isSubscribed = true;
			updateUI();
			fireEvent(ureq, event);
		} else if (source == unsubscribeButton) {
			notifManager.unsubscribe(ureq.getIdentity(), subscriptionContext);
			isSubscribed = false;
			updateUI();
			fireEvent(ureq, event);
		} 
	}

	@Override
	protected void doDispose() {
		// nothing to do
	}

}