AWebPage.java

package de.cinovo.cloudconductor.server.web.helper;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.annotation.PostConstruct;

import org.apache.cxf.jaxrs.ext.MessageContext;
import org.springframework.beans.factory.annotation.Autowired;

import com.google.common.collect.Sets;

import de.cinovo.cloudconductor.api.model.INamed;
import de.cinovo.cloudconductor.server.comparators.INamedComparator;
import de.cinovo.cloudconductor.server.dao.IServerOptionsDAO;
import de.cinovo.cloudconductor.server.util.exception.FormErrorException;
import de.cinovo.cloudconductor.server.util.exception.FormErrorExceptionHander;
import de.cinovo.cloudconductor.server.web.CSViewModel;
import de.cinovo.cloudconductor.server.web.impl.IndexImpl;
import de.cinovo.cloudconductor.server.web.interfaces.IContextAware;
import de.cinovo.cloudconductor.server.web.interfaces.IWebPath;

/**
 * Copyright 2014 Cinovo AG<br>
 * <br>
 *
 * @author psigloch
 *
 */
public abstract class AWebPage implements IContextAware {
	
	@Autowired
	protected NavbarRegistry navRegistry;
	
	@Autowired
	protected IServerOptionsDAO dServerOptions;

	private LinkedHashMap<String, String> topActions = new LinkedHashMap<>();
	private LinkedHashMap<String, String> breadcrumbs = new LinkedHashMap<>();
	private List<ViewFilter> viewType = new ArrayList<>();
	private List<ViewFilter> filter = new ArrayList<>();
	private Set<String> sidebar = Sets.newTreeSet();
	
	protected MessageContext mc;
	
	
	protected abstract String getTemplateFolder();
	
	@PostConstruct
	protected abstract void init();
	
	@Override
	public void setMessageContext(MessageContext context) {
		this.mc = context;
	}
	
	protected abstract String getNavElementName();
	
	protected SidebarType getSidebarType() {
		return SidebarType.SIMPLE;
	}
	
	protected CSViewModel createView() {
		return this.createView("view");
	}
	
	protected String getCurrentViewType() {
		if (this.viewType.isEmpty()) {
			return null;
		}
		String f = this.mc.getUriInfo().getQueryParameters().getFirst("viewtype");
		if (f != null) {
			for (ViewFilter vf : this.viewType) {
				if (vf.getId().equals(f)) {
					return vf.getName();
				}
			}
		}
		for (ViewFilter vf : this.viewType) {
			if (vf.isDefault()) {
				return vf.getName();
			}
		}
		return this.viewType.iterator().next().getName();
	}
	
	protected void addViewType(String id, String name, boolean isDefault) {
		boolean exists = false;
		for (ViewFilter f : this.viewType) {
			if (f.getName().equals(name) && f.getId().equals(id)) {
				exists = true;
			}
		}
		if (!exists) {
			this.viewType.add(new ViewFilter(id, name, isDefault));
			Collections.sort(this.viewType);
		}
	}
	
	protected void clearViewType() {
		this.viewType.clear();
	}
	
	protected List<ViewFilter> getCurrentFilter() {
		if (this.filter.isEmpty()) {
			return null;
		}
		List<String> f = this.mc.getUriInfo().getQueryParameters().get("filter");
		List<ViewFilter> result = new ArrayList<>();
		if ((f != null) && !f.isEmpty()) {
			for (ViewFilter vf : this.filter) {
				if (f.contains(vf.getId())) {
					result.add(vf);
				}
			}
		}
		return result;
	}
	
	protected void addFilter(String id, String name, boolean isDefault) {
		boolean exists = false;
		for (ViewFilter f : this.filter) {
			if (f.getName().equals(name) && f.getId().equals(id)) {
				exists = true;
			}
		}
		if (!exists) {
			this.filter.add(new ViewFilter(id, name, isDefault));
			Collections.sort(this.filter);
		}
	}
	
	protected void clearFilter() {
		this.filter.clear();
	}
	
	protected CSViewModel createView(String viewname) {
		CSViewModel view = new CSViewModel(this.getTemplateFolder() + "/" + viewname, false, this.dServerOptions.get());
		view.addModel("BREDCRUMBS", this.breadcrumbs.entrySet());
		view.addModel("SIDEBAR", this.sidebar);
		view.addModel("SIDEBARTYPE", this.getSidebarType());
		view.addModel("NAVELEMENT", this.navRegistry);
		view.addModel("CURRENTNAVELEMENT", this.getNavElementName());
		view.addModel("TOPACTIONS", this.topActions.entrySet());
		view.addModel("VIEWTYPE", this.viewType);
		view.addModel("ACTIVEFILTER", this.getCurrentFilter());
		view.addModel("FILTER", this.filter);
		view.addModel("CURRENTVIEWTYPE", this.getCurrentViewType());
		view.addModel(IndexImpl.AUTOREFRESH, this.mc.getHttpServletRequest().getSession().getAttribute(IndexImpl.AUTOREFRESH));
		return view;
	}
	
	protected CSViewModel createModal(String modalName) {
		CSViewModel modal = new CSViewModel(this.getTemplateFolder() + "/" + modalName, true, this.dServerOptions.get());
		if (this.hasError()) {
			FormErrorException error = this.pollError();
			modal.addModel("ERROR", error);
		}
		return modal;
	}
	
	protected void addBreadCrumb(String link, String name) {
		if (this.breadcrumbs.isEmpty()) {
			this.breadcrumbs.put("Home", IWebPath.WEBROOT);
		}
		this.breadcrumbs.put(name, link);
	}
	
	protected void addTopAction(String link, String name) {
		this.topActions.put(name, link);
	}
	
	protected void removeSidebarElement(String element) {
		this.sidebar.remove(element);
	}
	
	protected void addSidebarElement(String element) {
		this.sidebar.add(element);
	}
	
	protected void addSidebarElement(Collection<String> elements) {
		this.sidebar.addAll(elements);
	}
	
	protected void addSidebarElements(Collection<? extends INamed> elements) {
		for (INamed n : elements) {
			this.sidebar.add(n.getName());
		}
	}
	
	protected <K extends Comparable<K>, V> List<Map.Entry<K, V>> sortMap(Map<K, V> map) {
		List<Map.Entry<K, V>> entries = new ArrayList<Map.Entry<K, V>>(map.entrySet());
		Collections.sort(entries, new Comparator<Map.Entry<K, V>>() {
			
			@Override
			public int compare(Map.Entry<K, V> a, Map.Entry<K, V> b) {
				if ((a.getKey() == null) && (b.getKey() == null)) {
					return 0;
				}
				if ((a.getKey() != null) && (b.getKey() == null)) {
					return 1;
				}
				if ((a.getKey() == null) && (b.getKey() != null)) {
					return -1;
				}
				return a.getKey().compareTo(b.getKey());
			}
		});
		return entries;
	}
	
	protected <E extends INamed> void sortNamedList(List<E> list) {
		Collections.sort(list, new INamedComparator());
	}
	
	protected FormErrorException createError(String message) {
		return new FormErrorException(this.getCurrentPath(), message);
	}
	
	protected String getCurrentPath() {
		String path = this.mc.getHttpServletRequest().getPathInfo();
		return path.substring(IWebPath.WEBROOT.length(), path.length());
	}
	
	protected Boolean hasError() {
		if (this.mc.getHttpServletRequest().getParameter(FormErrorExceptionHander.REQUEST_ERROR_PARAM) != null) {
			return this.mc.getHttpServletRequest().getParameter(FormErrorExceptionHander.REQUEST_ERROR_PARAM).equals("true");
		}
		return false;
	}
	
	protected FormErrorException pollError() {
		FormErrorException result = (FormErrorException) this.mc.getHttpServletRequest().getSession(true).getAttribute(FormErrorExceptionHander.FORM_ERROR_DATA);
		this.mc.getHttpServletRequest().getSession().removeAttribute(FormErrorExceptionHander.FORM_ERROR_DATA);
		return result;
	}
	
	protected FormErrorException assertNotEmpty(String variable, FormErrorException error, String formElement) {
		return this.checkForEmpty(variable, null, error, formElement);
	}
	
	protected FormErrorException checkForEmpty(String variable, String errorMessage, FormErrorException error, String formElement) {
		String eMsg = "Please fill in all the information.";
		if ((errorMessage != null) && !errorMessage.isEmpty()) {
			eMsg = errorMessage;
		}
		if ((variable == null) || variable.isEmpty()) {
			FormErrorException anError = error;
			if (error == null) {
				anError = this.createError(eMsg);
			}
			anError.addElementError(formElement, true);
			return anError;
		}
		return error;
	}
	
	protected String auditFormat(String[] str) {
		StringBuilder b = new StringBuilder();
		for (String s : str) {
			b.append(s);
			b.append(",");
		}
		return b.length() > 1 ? b.deleteCharAt(b.length() - 1).toString() : b.toString();
	}
}