IMBuddyListController.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.instantMessaging.ui;

import org.olat.core.CoreSpringFactory;
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.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.olat.core.util.StringHelper;
import org.olat.instantMessaging.InstantMessagingModule;
import org.olat.instantMessaging.InstantMessagingService;
import org.olat.instantMessaging.OpenInstantMessageEvent;
import org.olat.instantMessaging.model.Buddy;
import org.olat.instantMessaging.model.BuddyGroup;

/**
 * 
 * Initial date: 05.12.2012<br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 *
 */
public class IMBuddyListController extends BasicController {
	
	private Link toggleOffline, toggleGroup; 
	private final VelocityContainer mainVC;
	private final VelocityContainer buddiesListContent;

	private Roster buddyList;
	private ViewMode viewMode;
	private boolean viewGroups = true;
	
	private final InstantMessagingModule imModule;
	private final InstantMessagingService imService;
	
	public IMBuddyListController(UserRequest ureq, WindowControl wControl) {
		super(ureq, wControl);
		
		imModule = CoreSpringFactory.getImpl(InstantMessagingModule.class);
		imService = CoreSpringFactory.getImpl(InstantMessagingService.class);
		
		mainVC = createVelocityContainer("buddies");
		buddiesListContent = createVelocityContainer("buddies_content");

		// Show status toggler only when status is visible, otherwise show online and offline users
		if(imModule.isOnlineStatusEnabled()) {
			toggleOffline = LinkFactory.createButton("toggleOnline", mainVC, this);
			toggleOffline.setCustomDisplayText(translate("im.show.offline.buddies"));
			toggleOffline.setIconLeftCSS("o_icon o_icon-fw o_icon_status_unavailable");
			toggleOffline.setElementCssClass("o_im_showofflineswitch");
			viewMode = ViewMode.onlineUsers;
		} else {
			viewMode = ViewMode.offlineUsers;			
		}
		
		toggleGroup = LinkFactory.createButton("toggleGroups", mainVC, this);
		toggleGroup.setCustomDisplayText(translate("im.hide.groups"));
		toggleGroup.setIconLeftCSS("o_icon o_icon-fw o_icon_group");
		toggleGroup.setElementCssClass("o_im_showgroupswitch");

		buddyList = new Roster(getIdentity().getKey());
		mainVC.contextPut("buddyList", buddyList);
		buddiesListContent.contextPut("buddyList", buddyList);
		buddiesListContent.contextPut("viewGroups", Boolean.TRUE);
		loadRoster(viewMode);
		mainVC.put("buddiesListContent", buddiesListContent);
		putInitialPanel(mainVC);
	}

	@Override
	protected void doDispose() {
		//
	}

	@Override
	protected void event(UserRequest ureq, Component source, Event event) {	
		//buddies list
		if (source == toggleOffline) {
			if (viewMode == ViewMode.onlineUsers) {
				toggleOffline.setCustomDisplayText(translate("im.hide.offline.buddies"));
				toggleOffline.setIconLeftCSS("o_icon o_icon-fw o_icon_status_available");
				toggleOffline.setElementCssClass("o_im_hideofflineswitch");
				loadRoster(ViewMode.offlineUsers);
			} else {
				toggleOffline.setCustomDisplayText(translate("im.show.offline.buddies"));
				toggleOffline.setIconLeftCSS("o_icon o_icon-fw o_icon_status_unavailable");
				toggleOffline.setElementCssClass("o_im_showofflineswitch");
				loadRoster(ViewMode.onlineUsers);
			}
		} else if (source == toggleGroup) {
			if (viewGroups) {
				toggleGroup.setCustomDisplayText(translate("im.show.groups"));
				toggleGroup.setElementCssClass("o_im_hidegroupswitch");
				buddiesListContent.contextPut("viewGroups", Boolean.FALSE);
				viewGroups = false;
			} else {
				toggleGroup.setCustomDisplayText(translate("im.hide.groups"));
				toggleGroup.setElementCssClass("o_im_showgroupswitch");
				buddiesListContent.contextPut("viewGroups", Boolean.TRUE);
				viewGroups = true;
			}
		} else if (source instanceof Link) {
			Link link = (Link)source;
			if("cmd.buddy".equals(link.getCommand())) {
				Buddy buddy = (Buddy)link.getUserObject();
				fireEvent(ureq, new OpenInstantMessageEvent(ureq, buddy));
			}
		}
	}
	
	private void loadRoster(ViewMode mode) {
		this.viewMode = mode;

		buddyList.clear();
		buddyList.getGroups().clear();
		boolean offlineUsers = (viewMode == ViewMode.offlineUsers);
		buddyList.getGroups().addAll(imService.getBuddyGroups(getIdentity(), offlineUsers));
		
		for(BuddyGroup group:buddyList.getGroups()) {
			for(Buddy buddy:group.getBuddy()) {
				forgeBuddyLink(group, buddy);
			}
		}
		buddiesListContent.setDirty(true);
	}
	
	private void forgeBuddyLink(BuddyGroup group, Buddy buddy) {
		String linkId = "buddy_" + group.getGroupKey() + "_" + buddy.getIdentityKey();
		if(buddiesListContent.getComponent(linkId) == null) {
			Link buddyLink = LinkFactory.createCustomLink(linkId, "cmd.buddy", "", Link.NONTRANSLATED, buddiesListContent, this);
			buddyLink.setCustomDisplayText(StringHelper.escapeHtml(buddy.getName()));
			String css = getStatusCss(buddy);
			buddyLink.setIconLeftCSS(css);
			buddyLink.setUserObject(buddy);
		}

		String linkIdAlt = "buddy_" + buddy.getIdentityKey();
		if(buddiesListContent.getComponent(linkIdAlt) == null) {
			Link buddyLink = LinkFactory.createCustomLink(linkIdAlt, "cmd.buddy", "", Link.NONTRANSLATED, buddiesListContent, this);
			buddyLink.setCustomDisplayText(StringHelper.escapeHtml(buddy.getName()));
			String css = getStatusCss(buddy);
			buddyLink.setIconLeftCSS(css);
			buddyLink.setUserObject(buddy);
		}
	}
	
	private String getStatusCss(Buddy buddy) {
		StringBuilder sb = new StringBuilder(32);
		sb.append("o_icon ");
		if(imModule.isOnlineStatusEnabled()) {
			sb.append("o_icon_status_").append(buddy.getStatus()).append(" ");
		} else {
			sb.append("o_im_chat_icon ");
		}
		if(buddy.isVip()) {
			sb.append("o_im_vip");
		}
		return sb.toString();
	}
	
	private enum ViewMode {
		onlineUsers,
		offlineUsers,
	}
}