jrichardsz/Modules

## Modules
package com.openxava.naviox;

import java.io.*;
import java.util.*;
import java.util.prefs.*;

import javax.servlet.*;
import javax.servlet.http.*;

import org.apache.commons.logging.*;
import org.openxava.application.meta.*;
import org.openxava.util.*;

import com.openxava.naviox.impl.*;
import com.openxava.naviox.util.*;

/**
 *
 * @author Javier Paniza
 */
public class Modules implements Serializable {

	public final static String FIRST_STEPS = "FirstSteps";

	private static Log log = LogFactory.getLog(Modules.class);
	private final static int BOOKMARK_MODULES = 100;
	private final static ModuleComparator comparator = new ModuleComparator();
	private static String preferencesNodeName = null;
	private List<MetaModule> all;
	private List<MetaModule> bookmarkModules = null;
	private List<MetaModule> regularModules;
	private List<MetaModule> fixedModules;

	private MetaModule current;

	public static void init(String applicationName) {
		MetaModuleFactory.setApplication(applicationName);
		DB.init();
		createFirstStepsModule(applicationName);
		ModulesHelper.init(applicationName);
	}

	private static void createFirstStepsModule(String applicationName) {
		MetaApplication app = MetaApplications.getMetaApplication(applicationName);
		MetaModule firstStepsModule = new MetaModule();
		firstStepsModule.setName(FIRST_STEPS);
		firstStepsModule.setModelName("SignIn"); // The model does not matter
		firstStepsModule.setWebViewURL("/naviox/firstSteps.jsp");
		firstStepsModule.setModeControllerName("Void");
		app.addMetaModule(firstStepsModule);
	}

	public void reset() {
		all = null;
		bookmarkModules = null;
		fixedModules = null;
		regularModules = null;
		current = null;
		if (!NaviOXPreferences.getInstance().isStartInLastVisitedModule()) {
			try {
				getPreferences().remove("current");
			} catch (BackingStoreException ex) {
				log.warn(XavaResources.getString("current_module_problem"), ex);
			}
		}
	}

	public boolean hasModules() {
		return (NaviOXPreferences.getInstance().isShowModulesMenuWhenNotLogged() || Users.getCurrent() != null)
				&& !getAll().isEmpty();
	}

	private MetaModule createWelcomeModule(MetaApplication app) {
		MetaModule result = new MetaModule();
		result.setName("Welcome");
		result.setWebViewURL("naviox/welcome");
		return result;
	}

	public void setCurrent(String application, String module) {
		this.current = MetaModuleFactory.create(application, module);
		try {
			Preferences preferences = getPreferences();
			if (!"SignIn".equals(current.getName())) {
				preferences.put("current", current.getName());
			}

			preferences.flush();
		} catch (Exception ex) {
			log.warn(XavaResources.getString("storing_current_module_problem"), ex);
		}
	}

	public boolean showsIndexLink() {
		return ModulesHelper.showsIndexLink();
	}

	public boolean showsSearchModules(HttpServletRequest request) {
		return ModulesHelper.showsSearchModules(request);
	}

	public String getCurrent(HttpServletRequest request) {
		try {
			String current = ModulesHelper.getCurrent(request);
			return current == null ? getPreferences().get("current", FIRST_STEPS) : current;
		} catch (Exception ex) {
			log.warn(XavaResources.getString("current_module_problem"), ex);
			return FIRST_STEPS;
		}
	}

	/** @since 6.0 */
	public String getOrganizationName(HttpServletRequest request) {
		try {
			String organization = Organizations.getCurrentName(request);
			return organization == null ? "" : organization;
		} catch (Exception ex) {
			log.warn(XavaResources.getString("organization_name_problem"), ex);
			return XavaResources.getString("unknow_organization");
		}
	}

	public String getApplicationLabel(HttpServletRequest request) {
		try {
			return NaviOXPreferences.getInstance().isShowApplicationName() ? current.getMetaApplication().getLabel()
					: "";
		} catch (Exception ex) {
			log.warn(XavaResources.getString("application_name_problem"), ex);
			return XavaResources.getString("unknow_application");
		}
	}

	public String getCurrentModuleDescription(HttpServletRequest request) {
		try {
			return Strings.concat(" - ", getOrganizationName(request), getApplicationLabel(request),
					current.getLabel());
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_description_problem"), ex);
			return XavaResources.getString("unknow_module");
		}
	}

	public String getCurrentModuleLabel() {
		return current == null ? XavaResources.getString("unknow_module") : current.getLabel();
	}

	public String getCurrentModuleName() {
		return current == null ? null : current.getName();
	}

	public void bookmarkCurrentModule() {
		if (indexOf(fixedModules, current) >= 0)
			return;
		if (current != null && "Index".equals(current.getName()))
			return;
		if (bookmarkModules == null)
			loadBookmarkModules();
		int idx = indexOf(bookmarkModules, current);
		if (idx < 0) {
			bookmarkModules.add(current);
			if (regularModules != null)
				regularModules.remove(current);
		}
		storeBookmarkModules();
	}

	public void unbookmarkCurrentModule() {
		if (bookmarkModules == null)
			loadBookmarkModules();
		int idx = indexOf(bookmarkModules, current);
		if (idx >= 0) {
			bookmarkModules.remove(idx);
		}
		storeBookmarkModules();
	}

	public boolean isCurrentBookmarked() {
		return isBookmarked(current);
	}

	public boolean isBookmarked(MetaModule module) {
		if (bookmarkModules == null)
			loadBookmarkModules();
		return indexOf(bookmarkModules, module) >= 0;
	}

	private void loadFixedModules() {
		String fixedModulesOnMenu = NaviOXPreferences.getInstance().getFixModulesOnTopMenu();
		fixedModules = new ArrayList();
		if (Is.emptyString(fixedModulesOnMenu))
			return;
		for (String moduleName : Strings.toCollection(fixedModulesOnMenu)) {
			loadModule(fixedModules, moduleName);
		}
	}

	private void loadModule(Collection<MetaModule> modules, String moduleName) {
		try {
			MetaModule module = MetaModuleFactory.create(moduleName);
			if (!modules.contains(module) && isModuleAuthorized(module)) {
				modules.add(module);
			}
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_not_loaded", moduleName, MetaModuleFactory.getApplication()), ex);
		}
	}

	private void loadBookmarkModules() {
		bookmarkModules = new ArrayList<MetaModule>();
		loadModulesFromPreferences(bookmarkModules, "bookmark.", BOOKMARK_MODULES);
		bookmarkModules.removeAll(getFixedModules());
	}

	private void loadModulesFromPreferences(List<MetaModule> modules, String prefix, int limit) {
		try {
			Preferences preferences = getPreferences();
			for (int i = 0; i < limit; i++) {
				String applicationName = preferences.get(prefix + "application." + i, null);
				if (applicationName == null)
					break;
				String moduleName = preferences.get(prefix + "module." + i, null);
				if (moduleName == null)
					break;
				loadModule(modules, moduleName);
			}
		} catch (Exception ex) {
			log.warn(XavaResources.getString("loading_modules_problem"), ex);
		}
	}

	public boolean isModuleAuthorized(HttpServletRequest request) {

		log.info("request.getRequestURI():" + request.getRequestURI());
		log.info("request.getContextPath():" + request.getContextPath());
		log.info("Users.getCurrent():" + Users.getCurrent());

		try {
			if (request.getRequestURI().contains("module.jsp"))
				return false;

			if (Users.getCurrent() == null && request.getRequestURI().contains("/phone/"))
				return false;
			// if does not starts with /m/ is authorized
//			if (!(request.getRequestURI().startsWith(request.getContextPath() + "/m/")
//					|| request.getRequestURI().startsWith(request.getContextPath() + "/p/")
//					|| request.getRequestURI().startsWith(request.getContextPath() + "/modules/")))
//				return true;
//
			if (!(request.getRequestURI().startsWith(request.getContextPath() + "/p/")
					|| request.getRequestURI().startsWith(request.getContextPath() + "/modules/")))
				return true;

			String[] uri = request.getRequestURI().split("/");
			if (uri.length < 4)
				return false;

			log.info("uri[1]:" + uri[1]);
			log.info("uri[3]:" + uri[3]);

			return isModuleAuthorized(request, MetaModuleFactory.create(uri[1], uri[3]));
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_not_authorized"), ex);
			return false;
		}

	}

	/**
	 * @since 5.7
	 */
	public boolean isModuleAuthorized(String module) {
		return isModuleAuthorized(null, module);
	}

	/**
	 * @since 5.7
	 */
	public boolean isModuleAuthorized(HttpServletRequest request, String module) {
		try {
			return isModuleAuthorized(request, MetaModuleFactory.create(module));
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_not_authorized"), ex);
			return false;
		}

	}

	public String getModuleURI(HttpServletRequest request, MetaModule module) {
		String organization = Organizations.getCurrent(request);
		String prefix = organization == null ? "" : "/o/" + organization;

		if (System.getenv("APP_NAME") != null && !System.getenv("APP_NAME").contentEquals("")) {
			return deleteAppliationNameFromUrl(
					"/" + module.getMetaApplication().getName() + prefix + "/m/" + module.getName());
		} else {
			return "/" + module.getMetaApplication().getName() + prefix + "/m/" + module.getName();
		}
	}

	public String deleteAppliationNameFromUrl(String url) {
		return url.replace("/" + System.getenv("APP_NAME"), "");
	}

	boolean isModuleAuthorized(MetaModule module) {
		return isModuleAuthorized(null, module);
	}

	private boolean isModuleAuthorized(HttpServletRequest request, MetaModule module) {
		if (request != null && ModulesHelper.isPublic(request, module.getName()))
			return true;
		return Collections.binarySearch(getAll(), module, comparator) >= 0;
	}

	private void storeBookmarkModules() {
		storeModulesInPreferences(bookmarkModules, "bookmark.", BOOKMARK_MODULES);
	}

	private void storeModulesInPreferences(Collection<MetaModule> modules, String prefix, int limit) {
		try {
			Preferences preferences = getPreferences();
			int i = 0;
			for (MetaModule module : modules) {
				preferences.put(prefix + "application." + i, module.getMetaApplication().getName());
				preferences.put(prefix + "module." + i, module.getName());
				i++;
			}
			for (; i < limit; i++) {
				preferences.remove(prefix + "application." + i);
				preferences.remove(prefix + "module." + i);
			}

			preferences.flush();
		} catch (Exception ex) {
			log.warn(XavaResources.getString("storing_modules_problem"), ex);
		}
	}

	private Preferences getPreferences() throws BackingStoreException {
		return Users.getCurrentPreferences().node(getPreferencesNodeName());
	}

	private static String getPreferencesNodeName() {
		if (preferencesNodeName == null) {
			Collection<MetaApplication> apps = MetaApplications.getMetaApplications();
			for (MetaApplication app : apps) {
				preferencesNodeName = "naviox." + app.getName();
				break;
			}
			if (preferencesNodeName == null)
				preferencesNodeName = "naviox.UNKNOWN";
		}
		return preferencesNodeName;
	}

	public Collection getBookmarkModules() {
		if (bookmarkModules == null)
			loadBookmarkModules();
		return bookmarkModules;
	}

	/** @since 6.0 */
	public Collection getFixedModules() {
		if (fixedModules == null)
			loadFixedModules();
		return fixedModules;
	}

	public List getAll() {
		if (all == null) {
			all = ModulesHelper.getAll();
			Collections.sort(all, comparator);
		}
		return all;
	}

	/** @since 6.0 */
	public List getRegularModules() {
		if (getBookmarkModules().isEmpty() && getFixedModules().isEmpty())
			return getAll();
		if (regularModules == null) {
			regularModules = new ArrayList(getAll());
			regularModules.removeAll(getFixedModules());
			regularModules.removeAll(getBookmarkModules());
		}
		return regularModules;
	}

	public String getUserAccessModule(ServletRequest request) {
		return ModulesHelper.getUserAccessModule(request);
	}

	private int indexOf(Collection<MetaModule> modules, MetaModule current) {
		if (modules == null)
			return -1;
		int idx = 0;
		for (MetaModule module : modules) {
			if (module.getName().equals(current.getName())
					&& module.getMetaApplication().getName().equals(current.getMetaApplication().getName()))
				return idx;
			idx++;
		}
		return -1;
	}

	private static class ModuleComparator implements Comparator<MetaModule> {

		public int compare(MetaModule a, MetaModule b) {
			return a.getName().compareTo(b.getName());
		}

	}

}

## Modules2
package com.openxava.naviox;

import java.io.*;
import java.util.*;
import java.util.prefs.*;

import javax.servlet.*;
import javax.servlet.http.*;

import org.apache.commons.logging.*;
import org.openxava.application.meta.*;
import org.openxava.util.*;

import com.openxava.naviox.impl.*;
import com.openxava.naviox.util.*;

/**
 *
 * @author Javier Paniza
 */
public class Modules implements Serializable {

	public final static String FIRST_STEPS = "FirstSteps";

	private static Log log = LogFactory.getLog(Modules.class);
	private final static int BOOKMARK_MODULES = 100;
	private final static ModuleComparator comparator = new ModuleComparator();
	private static String preferencesNodeName = null;
	private List<MetaModule> all;
	private List<MetaModule> bookmarkModules = null;
	private List<MetaModule> regularModules;
	private List<MetaModule> fixedModules;

	private MetaModule current;

	public static void init(String applicationName) {
		MetaModuleFactory.setApplication(applicationName);
		DB.init();
		createFirstStepsModule(applicationName);
		ModulesHelper.init(applicationName);
	}

	private static void createFirstStepsModule(String applicationName) {
		MetaApplication app = MetaApplications.getMetaApplication(applicationName);
		MetaModule firstStepsModule = new MetaModule();
		firstStepsModule.setName(FIRST_STEPS);
		firstStepsModule.setModelName("SignIn"); // The model does not matter
		firstStepsModule.setWebViewURL("/naviox/firstSteps.jsp");
		firstStepsModule.setModeControllerName("Void");
		app.addMetaModule(firstStepsModule);
	}

	public void reset() {
		all = null;
		bookmarkModules = null;
		fixedModules = null;
		regularModules = null;
		current = null;
		if (!NaviOXPreferences.getInstance().isStartInLastVisitedModule()) {
			try {
				getPreferences().remove("current");
			} catch (BackingStoreException ex) {
				log.warn(XavaResources.getString("current_module_problem"), ex);
			}
		}
	}

	public boolean hasModules() {
		return (NaviOXPreferences.getInstance().isShowModulesMenuWhenNotLogged() || Users.getCurrent() != null)
				&& !getAll().isEmpty();
	}

	private MetaModule createWelcomeModule(MetaApplication app) {
		MetaModule result = new MetaModule();
		result.setName("Welcome");
		result.setWebViewURL("naviox/welcome");
		return result;
	}

	public void setCurrent(String application, String module) {
		this.current = MetaModuleFactory.create(application, module);
		try {
			Preferences preferences = getPreferences();
			if (!"SignIn".equals(current.getName())) {
				preferences.put("current", current.getName());
			}

			preferences.flush();
		} catch (Exception ex) {
			log.warn(XavaResources.getString("storing_current_module_problem"), ex);
		}
	}

	public boolean showsIndexLink() {
		return ModulesHelper.showsIndexLink();
	}

	public boolean showsSearchModules(HttpServletRequest request) {
		return ModulesHelper.showsSearchModules(request);
	}

	public String getCurrent(HttpServletRequest request) {
		try {
			String current = ModulesHelper.getCurrent(request);
			return current == null ? getPreferences().get("current", FIRST_STEPS) : current;
		} catch (Exception ex) {
			log.warn(XavaResources.getString("current_module_problem"), ex);
			return FIRST_STEPS;
		}
	}

	/** @since 6.0 */
	public String getOrganizationName(HttpServletRequest request) {
		try {
			String organization = Organizations.getCurrentName(request);
			return organization == null ? "" : organization;
		} catch (Exception ex) {
			log.warn(XavaResources.getString("organization_name_problem"), ex);
			return XavaResources.getString("unknow_organization");
		}
	}

	public String getApplicationLabel(HttpServletRequest request) {
		try {
			return NaviOXPreferences.getInstance().isShowApplicationName() ? current.getMetaApplication().getLabel()
					: "";
		} catch (Exception ex) {
			log.warn(XavaResources.getString("application_name_problem"), ex);
			return XavaResources.getString("unknow_application");
		}
	}

	public String getCurrentModuleDescription(HttpServletRequest request) {
		try {
			return Strings.concat(" - ", getOrganizationName(request), getApplicationLabel(request),
					current.getLabel());
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_description_problem"), ex);
			return XavaResources.getString("unknow_module");
		}
	}

	public String getCurrentModuleLabel() {
		return current == null ? XavaResources.getString("unknow_module") : current.getLabel();
	}

	public String getCurrentModuleName() {
		return current == null ? null : current.getName();
	}

	public void bookmarkCurrentModule() {
		if (indexOf(fixedModules, current) >= 0)
			return;
		if (current != null && "Index".equals(current.getName()))
			return;
		if (bookmarkModules == null)
			loadBookmarkModules();
		int idx = indexOf(bookmarkModules, current);
		if (idx < 0) {
			bookmarkModules.add(current);
			if (regularModules != null)
				regularModules.remove(current);
		}
		storeBookmarkModules();
	}

	public void unbookmarkCurrentModule() {
		if (bookmarkModules == null)
			loadBookmarkModules();
		int idx = indexOf(bookmarkModules, current);
		if (idx >= 0) {
			bookmarkModules.remove(idx);
		}
		storeBookmarkModules();
	}

	public boolean isCurrentBookmarked() {
		return isBookmarked(current);
	}

	public boolean isBookmarked(MetaModule module) {
		if (bookmarkModules == null)
			loadBookmarkModules();
		return indexOf(bookmarkModules, module) >= 0;
	}

	private void loadFixedModules() {
		String fixedModulesOnMenu = NaviOXPreferences.getInstance().getFixModulesOnTopMenu();
		fixedModules = new ArrayList();
		if (Is.emptyString(fixedModulesOnMenu))
			return;
		for (String moduleName : Strings.toCollection(fixedModulesOnMenu)) {
			loadModule(fixedModules, moduleName);
		}
	}

	private void loadModule(Collection<MetaModule> modules, String moduleName) {
		try {
			MetaModule module = MetaModuleFactory.create(moduleName);
			if (!modules.contains(module) && isModuleAuthorized(module)) {
				modules.add(module);
			}
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_not_loaded", moduleName, MetaModuleFactory.getApplication()), ex);
		}
	}

	private void loadBookmarkModules() {
		bookmarkModules = new ArrayList<MetaModule>();
		loadModulesFromPreferences(bookmarkModules, "bookmark.", BOOKMARK_MODULES);
		bookmarkModules.removeAll(getFixedModules());
	}

	private void loadModulesFromPreferences(List<MetaModule> modules, String prefix, int limit) {
		try {
			Preferences preferences = getPreferences();
			for (int i = 0; i < limit; i++) {
				String applicationName = preferences.get(prefix + "application." + i, null);
				if (applicationName == null)
					break;
				String moduleName = preferences.get(prefix + "module." + i, null);
				if (moduleName == null)
					break;
				loadModule(modules, moduleName);
			}
		} catch (Exception ex) {
			log.warn(XavaResources.getString("loading_modules_problem"), ex);
		}
	}

	public boolean isModuleAuthorized(HttpServletRequest request) {

		log.info("request.getRequestURI():" + request.getRequestURI());
		log.info("request.getContextPath():" + request.getContextPath());
		log.info("Users.getCurrent():" + Users.getCurrent());

		try {
			if (request.getRequestURI().contains("module.jsp"))
				return false;

			if (Users.getCurrent() == null && request.getRequestURI().contains("/phone/"))
				return false;
			// if does not starts with /m/ is authorized
//			if (!(request.getRequestURI().startsWith(request.getContextPath() + "/m/")
//					|| request.getRequestURI().startsWith(request.getContextPath() + "/p/")
//					|| request.getRequestURI().startsWith(request.getContextPath() + "/modules/")))
//				return true;
//
			if (!(request.getRequestURI().startsWith(request.getContextPath() + "/p/")
					|| request.getRequestURI().startsWith(request.getContextPath() + "/modules/")))
				return true;

			String[] uri = request.getRequestURI().split("/");
			if (uri.length < 4)
				return false;

			log.info("uri[1]:" + uri[1]);
			log.info("uri[3]:" + uri[3]);

			return isModuleAuthorized(request, MetaModuleFactory.create(uri[1], uri[3]));
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_not_authorized"), ex);
			return false;
		}

	}

	/**
	 * @since 5.7
	 */
	public boolean isModuleAuthorized(String module) {
		return isModuleAuthorized(null, module);
	}

	/**
	 * @since 5.7
	 */
	public boolean isModuleAuthorized(HttpServletRequest request, String module) {
		try {
			return isModuleAuthorized(request, MetaModuleFactory.create(module));
		} catch (Exception ex) {
			log.warn(XavaResources.getString("module_not_authorized"), ex);
			return false;
		}

	}

	public String getModuleURI(HttpServletRequest request, MetaModule module) {
		String organization = Organizations.getCurrent(request);
		String prefix = organization == null ? "" : "/o/" + organization;

		if (System.getenv("APP_NAME") != null && !System.getenv("APP_NAME").contentEquals("")) {
			return deleteAppliationNameFromUrl(
					"/" + module.getMetaApplication().getName() + prefix + "/m/" + module.getName());
		} else {
			return "/" + module.getMetaApplication().getName() + prefix + "/m/" + module.getName();
		}
	}

	public String deleteAppliationNameFromUrl(String url) {
		return url.replace("/" + System.getenv("APP_NAME"), "");
	}

	boolean isModuleAuthorized(MetaModule module) {
		return isModuleAuthorized(null, module);
	}

	private boolean isModuleAuthorized(HttpServletRequest request, MetaModule module) {
		if (request != null && ModulesHelper.isPublic(request, module.getName()))
			return true;
		return Collections.binarySearch(getAll(), module, comparator) >= 0;
	}

	private void storeBookmarkModules() {
		storeModulesInPreferences(bookmarkModules, "bookmark.", BOOKMARK_MODULES);
	}

	private void storeModulesInPreferences(Collection<MetaModule> modules, String prefix, int limit) {
		try {
			Preferences preferences = getPreferences();
			int i = 0;
			for (MetaModule module : modules) {
				preferences.put(prefix + "application." + i, module.getMetaApplication().getName());
				preferences.put(prefix + "module." + i, module.getName());
				i++;
			}
			for (; i < limit; i++) {
				preferences.remove(prefix + "application." + i);
				preferences.remove(prefix + "module." + i);
			}

			preferences.flush();
		} catch (Exception ex) {
			log.warn(XavaResources.getString("storing_modules_problem"), ex);
		}
	}

	private Preferences getPreferences() throws BackingStoreException {
		return Users.getCurrentPreferences().node(getPreferencesNodeName());
	}

	private static String getPreferencesNodeName() {
		if (preferencesNodeName == null) {
			Collection<MetaApplication> apps = MetaApplications.getMetaApplications();
			for (MetaApplication app : apps) {
				preferencesNodeName = "naviox." + app.getName();
				break;
			}
			if (preferencesNodeName == null)
				preferencesNodeName = "naviox.UNKNOWN";
		}
		return preferencesNodeName;
	}

	public Collection getBookmarkModules() {
		if (bookmarkModules == null)
			loadBookmarkModules();
		return bookmarkModules;
	}

	/** @since 6.0 */
	public Collection getFixedModules() {
		if (fixedModules == null)
			loadFixedModules();
		return fixedModules;
	}

	public List getAll() {
		if (all == null) {
			all = ModulesHelper.getAll();
			Collections.sort(all, comparator);
		}
		return all;
	}

	/** @since 6.0 */
	public List getRegularModules() {
		if (getBookmarkModules().isEmpty() && getFixedModules().isEmpty())
			return getAll();
		if (regularModules == null) {
			regularModules = new ArrayList(getAll());
			regularModules.removeAll(getFixedModules());
			regularModules.removeAll(getBookmarkModules());
		}
		return regularModules;
	}

	public String getUserAccessModule(ServletRequest request) {
		return ModulesHelper.getUserAccessModule(request);
	}

	private int indexOf(Collection<MetaModule> modules, MetaModule current) {
		if (modules == null)
			return -1;
		int idx = 0;
		for (MetaModule module : modules) {
			if (module.getName().equals(current.getName())
					&& module.getMetaApplication().getName().equals(current.getMetaApplication().getName()))
				return idx;
			idx++;
		}
		return -1;
	}

	private static class ModuleComparator implements Comparator<MetaModule> {

		public int compare(MetaModule a, MetaModule b) {
			return a.getName().compareTo(b.getName());
		}

	}

}

## naviox welcome.jsp
<%@include file="../xava/imports.jsp"%>

<%@page import="org.openxava.application.meta.MetaApplications"%>
<%@page import="org.openxava.application.meta.MetaApplication"%>
<%@page import="org.openxava.util.Locales"%>
<%@page import="org.openxava.web.style.XavaStyle"%>
<%@page import="org.openxava.util.XavaPreferences"%>


<%-- To put your own text add entries in the i18n messages files of your project
In MyApplication-labels_en.properties:
MyApplication=My application
MyApplication[description]=My application does this and that

In MyApplication-messages_en.properties:
welcome_point1=This is a additional explanatory line

//@issue #2 : This fix the first acces to http://localhost:8080/

--%>

<%
String applicationName = null;
if(request.getContextPath()!=null && request.getContextPath().length()>0) {
  applicationName = request.getContextPath().substring(1);
}else {
  applicationName = System.getenv("app_name");
}
MetaApplication metaApplication = MetaApplications.getMetaApplication(applicationName);
Locales.setCurrent(request);
String oxVersion = org.openxava.controller.ModuleManager.getVersion();
String title = (String) request.getAttribute("naviox.pageTitle");
if (title == null) title = metaApplication.getLabel();
%>

<!DOCTYPE html>

<head>
	<title><%=title%></title>
	<meta name='viewport' content='width=device-width, initial-scale=1, maximum-scale=1'>
	<link href="<%=request.getContextPath()%>/xava/style/<%=XavaPreferences.getInstance().getStyleCSS()%>?ox=<%=oxVersion%>" rel="stylesheet" type="text/css">
</head>

<body id="welcome" <%=XavaStyle.getBodyClass(request)%>>

<h1><%=metaApplication.getLabel()%></h1>
<p><%=metaApplication.getDescription()%></p>
<p><xava:message key="welcome_point1"/></p>
<p id="signin_tip"><xava:message key="signin_tip"/></p>

<div class="ox-bottom-buttons">
	<input type="hidden">
	<input type="button" tabindex="1" onclick="window.location='m/SignIn'" value="<xava:label key='SignIn'/>">
</div>

</body>


## NaviOXFilter
package com.openxava.naviox.web;

import java.io.*;

import javax.servlet.*;
import javax.servlet.http.*;

import org.openxava.jpa.*;
import org.openxava.util.*;

import com.openxava.naviox.*;
import com.openxava.naviox.impl.*;
import com.openxava.naviox.util.*;

/**
 *
 * @author Javier Paniza
 */
public class NaviOXFilter implements Filter {

	public void init(FilterConfig cfg) throws ServletException {
		//detect app name
		if(cfg.getServletContext().getContextPath()!=null && cfg.getServletContext().getContextPath().length()>0) {
			Modules.init(cfg.getServletContext().getContextPath().substring(1));
		}else {
			Modules.init(System.getenv("APP_NAME"));
		}

	}

## NaviOXServlet
package com.openxava.naviox.web;

import java.io.*;

import javax.servlet.*;
import javax.servlet.http.*;

import org.openxava.util.*;
import org.openxava.web.*;
import org.openxava.web.style.*;

import com.openxava.phone.web.*;

/**
 *
 * @author Javier Paniza
 */
public class NaviOXServlet extends HttpServlet {

	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

		String url;
		String [] uri = request.getRequestURI().split("/");
		if (uri.length == 3) {
			url = Browsers.isMobile(request)?"/p/" + uri[2]:"/naviox/index.jsp?application=" + System.getenv("APP_NAME") + "&module=" + uri[2];
		}else if (uri.length == 4) {
			url = Browsers.isMobile(request)?"/p/" + uri[3]:"/naviox/index.jsp?application=" + uri[1] + "&module=" + uri[3];
		}else {
			response.getWriter().print(XavaResources.getString(request, "module_name_missing"));
			return;
		}

		RequestDispatcher dispatcher = request.getRequestDispatcher(url);

		Style.setPotalInstance(XavaStyle.getInstance()); // We manage style in NaviOX as in the portal case, to override the style defined in xava.properties and by device
		dispatcher.forward(request, response);
	}


	protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		doGet(request, response);
	}


}

## openxava readme.md

      
    Raw
  

              openxava readme.md
            
          
    openxava readme.md
	package com.openxava.naviox;

	import java.io.*;
	import java.util.*;
	import java.util.prefs.*;

	import javax.servlet.*;
	import javax.servlet.http.*;

	import org.apache.commons.logging.*;
	import org.openxava.application.meta.*;
	import org.openxava.util.*;

	import com.openxava.naviox.impl.*;
	import com.openxava.naviox.util.*;

	/**
	*
	* @author Javier Paniza
	*/
	public class Modules implements Serializable {

	public final static String FIRST_STEPS = "FirstSteps";

	private static Log log = LogFactory.getLog(Modules.class);
	private final static int BOOKMARK_MODULES = 100;
	private final static ModuleComparator comparator = new ModuleComparator();
	private static String preferencesNodeName = null;
	private List<MetaModule> all;
	private List<MetaModule> bookmarkModules = null;
	private List<MetaModule> regularModules;
	private List<MetaModule> fixedModules;

	private MetaModule current;

	public static void init(String applicationName) {
	MetaModuleFactory.setApplication(applicationName);
	DB.init();
	createFirstStepsModule(applicationName);
	ModulesHelper.init(applicationName);
	}

	private static void createFirstStepsModule(String applicationName) {
	MetaApplication app = MetaApplications.getMetaApplication(applicationName);
	MetaModule firstStepsModule = new MetaModule();
	firstStepsModule.setName(FIRST_STEPS);
	firstStepsModule.setModelName("SignIn"); // The model does not matter
	firstStepsModule.setWebViewURL("/naviox/firstSteps.jsp");
	firstStepsModule.setModeControllerName("Void");
	app.addMetaModule(firstStepsModule);
	}

	public void reset() {
	all = null;
	bookmarkModules = null;
	fixedModules = null;
	regularModules = null;
	current = null;
	if (!NaviOXPreferences.getInstance().isStartInLastVisitedModule()) {
	try {
	getPreferences().remove("current");
	} catch (BackingStoreException ex) {
	log.warn(XavaResources.getString("current_module_problem"), ex);
	}
	}
	}

	public boolean hasModules() {
	return (NaviOXPreferences.getInstance().isShowModulesMenuWhenNotLogged() \|\| Users.getCurrent() != null)
	&& !getAll().isEmpty();
	}

	private MetaModule createWelcomeModule(MetaApplication app) {
	MetaModule result = new MetaModule();
	result.setName("Welcome");
	result.setWebViewURL("naviox/welcome");
	return result;
	}

	public void setCurrent(String application, String module) {
	this.current = MetaModuleFactory.create(application, module);
	try {
	Preferences preferences = getPreferences();
	if (!"SignIn".equals(current.getName())) {
	preferences.put("current", current.getName());
	}

	preferences.flush();
	} catch (Exception ex) {
	log.warn(XavaResources.getString("storing_current_module_problem"), ex);
	}
	}

	public boolean showsIndexLink() {
	return ModulesHelper.showsIndexLink();
	}

	public boolean showsSearchModules(HttpServletRequest request) {
	return ModulesHelper.showsSearchModules(request);
	}

	public String getCurrent(HttpServletRequest request) {
	try {
	String current = ModulesHelper.getCurrent(request);
	return current == null ? getPreferences().get("current", FIRST_STEPS) : current;
	} catch (Exception ex) {
	log.warn(XavaResources.getString("current_module_problem"), ex);
	return FIRST_STEPS;
	}
	}

	/** @since 6.0 */
	public String getOrganizationName(HttpServletRequest request) {
	try {
	String organization = Organizations.getCurrentName(request);
	return organization == null ? "" : organization;
	} catch (Exception ex) {
	log.warn(XavaResources.getString("organization_name_problem"), ex);
	return XavaResources.getString("unknow_organization");
	}
	}

	public String getApplicationLabel(HttpServletRequest request) {
	try {
	return NaviOXPreferences.getInstance().isShowApplicationName() ? current.getMetaApplication().getLabel()
	: "";
	} catch (Exception ex) {
	log.warn(XavaResources.getString("application_name_problem"), ex);
	return XavaResources.getString("unknow_application");
	}
	}

	public String getCurrentModuleDescription(HttpServletRequest request) {
	try {
	return Strings.concat(" - ", getOrganizationName(request), getApplicationLabel(request),
	current.getLabel());
	} catch (Exception ex) {
	log.warn(XavaResources.getString("module_description_problem"), ex);
	return XavaResources.getString("unknow_module");
	}
	}

	public String getCurrentModuleLabel() {
	return current == null ? XavaResources.getString("unknow_module") : current.getLabel();
	}

	public String getCurrentModuleName() {
	return current == null ? null : current.getName();
	}

	public void bookmarkCurrentModule() {
	if (indexOf(fixedModules, current) >= 0)
	return;
	if (current != null && "Index".equals(current.getName()))
	return;
	if (bookmarkModules == null)
	loadBookmarkModules();
	int idx = indexOf(bookmarkModules, current);
	if (idx < 0) {
	bookmarkModules.add(current);
	if (regularModules != null)
	regularModules.remove(current);
	}
	storeBookmarkModules();
	}

	public void unbookmarkCurrentModule() {
	if (bookmarkModules == null)
	loadBookmarkModules();
	int idx = indexOf(bookmarkModules, current);
	if (idx >= 0) {
	bookmarkModules.remove(idx);
	}
	storeBookmarkModules();
	}

	public boolean isCurrentBookmarked() {
	return isBookmarked(current);
	}

	public boolean isBookmarked(MetaModule module) {
	if (bookmarkModules == null)
	loadBookmarkModules();
	return indexOf(bookmarkModules, module) >= 0;
	}

	private void loadFixedModules() {
	String fixedModulesOnMenu = NaviOXPreferences.getInstance().getFixModulesOnTopMenu();
	fixedModules = new ArrayList();
	if (Is.emptyString(fixedModulesOnMenu))
	return;
	for (String moduleName : Strings.toCollection(fixedModulesOnMenu)) {
	loadModule(fixedModules, moduleName);
	}
	}

	private void loadModule(Collection<MetaModule> modules, String moduleName) {
	try {
	MetaModule module = MetaModuleFactory.create(moduleName);
	if (!modules.contains(module) && isModuleAuthorized(module)) {
	modules.add(module);
	}
	} catch (Exception ex) {
	log.warn(XavaResources.getString("module_not_loaded", moduleName, MetaModuleFactory.getApplication()), ex);
	}
	}

	private void loadBookmarkModules() {
	bookmarkModules = new ArrayList<MetaModule>();
	loadModulesFromPreferences(bookmarkModules, "bookmark.", BOOKMARK_MODULES);
	bookmarkModules.removeAll(getFixedModules());
	}

	private void loadModulesFromPreferences(List<MetaModule> modules, String prefix, int limit) {
	try {
	Preferences preferences = getPreferences();
	for (int i = 0; i < limit; i++) {
	String applicationName = preferences.get(prefix + "application." + i, null);
	if (applicationName == null)
	break;
	String moduleName = preferences.get(prefix + "module." + i, null);
	if (moduleName == null)
	break;
	loadModule(modules, moduleName);
	}
	} catch (Exception ex) {
	log.warn(XavaResources.getString("loading_modules_problem"), ex);
	}
	}

	public boolean isModuleAuthorized(HttpServletRequest request) {

	log.info("request.getRequestURI():" + request.getRequestURI());
	log.info("request.getContextPath():" + request.getContextPath());
	log.info("Users.getCurrent():" + Users.getCurrent());

	try {
	if (request.getRequestURI().contains("module.jsp"))
	return false;

	if (Users.getCurrent() == null && request.getRequestURI().contains("/phone/"))
	return false;
	// if does not starts with /m/ is authorized
	// if (!(request.getRequestURI().startsWith(request.getContextPath() + "/m/")
	// \|\| request.getRequestURI().startsWith(request.getContextPath() + "/p/")
	// \|\| request.getRequestURI().startsWith(request.getContextPath() + "/modules/")))
	// return true;
	//
	if (!(request.getRequestURI().startsWith(request.getContextPath() + "/p/")
	\|\| request.getRequestURI().startsWith(request.getContextPath() + "/modules/")))
	return true;

	String[] uri = request.getRequestURI().split("/");
	if (uri.length < 4)
	return false;

	log.info("uri[1]:" + uri[1]);
	log.info("uri[3]:" + uri[3]);

	return isModuleAuthorized(request, MetaModuleFactory.create(uri[1], uri[3]));
	} catch (Exception ex) {
	log.warn(XavaResources.getString("module_not_authorized"), ex);
	return false;
	}

	}

	/**
	* @since 5.7
	*/
	public boolean isModuleAuthorized(String module) {
	return isModuleAuthorized(null, module);
	}

	/**
	* @since 5.7
	*/
	public boolean isModuleAuthorized(HttpServletRequest request, String module) {
	try {
	return isModuleAuthorized(request, MetaModuleFactory.create(module));
	} catch (Exception ex) {
	log.warn(XavaResources.getString("module_not_authorized"), ex);
	return false;
	}

	}

	public String getModuleURI(HttpServletRequest request, MetaModule module) {
	String organization = Organizations.getCurrent(request);
	String prefix = organization == null ? "" : "/o/" + organization;

	if (System.getenv("APP_NAME") != null && !System.getenv("APP_NAME").contentEquals("")) {
	return deleteAppliationNameFromUrl(
	"/" + module.getMetaApplication().getName() + prefix + "/m/" + module.getName());
	} else {
	return "/" + module.getMetaApplication().getName() + prefix + "/m/" + module.getName();
	}
	}

	public String deleteAppliationNameFromUrl(String url) {
	return url.replace("/" + System.getenv("APP_NAME"), "");
	}

	boolean isModuleAuthorized(MetaModule module) {
	return isModuleAuthorized(null, module);
	}

	private boolean isModuleAuthorized(HttpServletRequest request, MetaModule module) {
	if (request != null && ModulesHelper.isPublic(request, module.getName()))
	return true;
	return Collections.binarySearch(getAll(), module, comparator) >= 0;
	}

	private void storeBookmarkModules() {
	storeModulesInPreferences(bookmarkModules, "bookmark.", BOOKMARK_MODULES);
	}

	private void storeModulesInPreferences(Collection<MetaModule> modules, String prefix, int limit) {
	try {
	Preferences preferences = getPreferences();
	int i = 0;
	for (MetaModule module : modules) {
	preferences.put(prefix + "application." + i, module.getMetaApplication().getName());
	preferences.put(prefix + "module." + i, module.getName());
	i++;
	}
	for (; i < limit; i++) {
	preferences.remove(prefix + "application." + i);
	preferences.remove(prefix + "module." + i);
	}

	preferences.flush();
	} catch (Exception ex) {
	log.warn(XavaResources.getString("storing_modules_problem"), ex);
	}
	}

	private Preferences getPreferences() throws BackingStoreException {
	return Users.getCurrentPreferences().node(getPreferencesNodeName());
	}

	private static String getPreferencesNodeName() {
	if (preferencesNodeName == null) {
	Collection<MetaApplication> apps = MetaApplications.getMetaApplications();
	for (MetaApplication app : apps) {
	preferencesNodeName = "naviox." + app.getName();
	break;
	}
	if (preferencesNodeName == null)
	preferencesNodeName = "naviox.UNKNOWN";
	}
	return preferencesNodeName;
	}

	public Collection getBookmarkModules() {
	if (bookmarkModules == null)
	loadBookmarkModules();
	return bookmarkModules;
	}

	/** @since 6.0 */
	public Collection getFixedModules() {
	if (fixedModules == null)
	loadFixedModules();
	return fixedModules;
	}

	public List getAll() {
	if (all == null) {
	all = ModulesHelper.getAll();
	Collections.sort(all, comparator);
	}
	return all;
	}

	/** @since 6.0 */
	public List getRegularModules() {
	if (getBookmarkModules().isEmpty() && getFixedModules().isEmpty())
	return getAll();
	if (regularModules == null) {
	regularModules = new ArrayList(getAll());
	regularModules.removeAll(getFixedModules());
	regularModules.removeAll(getBookmarkModules());
	}
	return regularModules;
	}

	public String getUserAccessModule(ServletRequest request) {
	return ModulesHelper.getUserAccessModule(request);
	}

	private int indexOf(Collection<MetaModule> modules, MetaModule current) {
	if (modules == null)
	return -1;
	int idx = 0;
	for (MetaModule module : modules) {
	if (module.getName().equals(current.getName())
	&& module.getMetaApplication().getName().equals(current.getMetaApplication().getName()))
	return idx;
	idx++;
	}
	return -1;
	}

	private static class ModuleComparator implements Comparator<MetaModule> {

	public int compare(MetaModule a, MetaModule b) {
	return a.getName().compareTo(b.getName());
	}

	}

	}
	<%@include file="../xava/imports.jsp"%>

	<%@page import="org.openxava.application.meta.MetaApplications"%>
	<%@page import="org.openxava.application.meta.MetaApplication"%>
	<%@page import="org.openxava.util.Locales"%>
	<%@page import="org.openxava.web.style.XavaStyle"%>
	<%@page import="org.openxava.util.XavaPreferences"%>


	<%-- To put your own text add entries in the i18n messages files of your project
	In MyApplication-labels_en.properties:
	MyApplication=My application
	MyApplication[description]=My application does this and that

	In MyApplication-messages_en.properties:
	welcome_point1=This is a additional explanatory line

	//@issue #2 : This fix the first acces to http://localhost:8080/

	--%>

	<%
	String applicationName = null;
	if(request.getContextPath()!=null && request.getContextPath().length()>0) {
	applicationName = request.getContextPath().substring(1);
	}else {
	applicationName = System.getenv("app_name");
	}
	MetaApplication metaApplication = MetaApplications.getMetaApplication(applicationName);
	Locales.setCurrent(request);
	String oxVersion = org.openxava.controller.ModuleManager.getVersion();
	String title = (String) request.getAttribute("naviox.pageTitle");
	if (title == null) title = metaApplication.getLabel();
	%>

	<!DOCTYPE html>

	<head>
	<title><%=title%></title>
	<meta name='viewport' content='width=device-width, initial-scale=1, maximum-scale=1'>
	<link href="<%=request.getContextPath()%>/xava/style/<%=XavaPreferences.getInstance().getStyleCSS()%>?ox=<%=oxVersion%>" rel="stylesheet" type="text/css">
	</head>

	<body id="welcome" <%=XavaStyle.getBodyClass(request)%>>

	<h1><%=metaApplication.getLabel()%></h1>
	<p><%=metaApplication.getDescription()%></p>
	<p><xava:message key="welcome_point1"/></p>
	<p id="signin_tip"><xava:message key="signin_tip"/></p>

	<div class="ox-bottom-buttons">
	<input type="hidden">
	<input type="button" tabindex="1" onclick="window.location='m/SignIn'" value="<xava:label key='SignIn'/>">
	</div>

	</body>
	package com.openxava.naviox.web;

	import java.io.*;

	import javax.servlet.*;
	import javax.servlet.http.*;

	import org.openxava.jpa.*;
	import org.openxava.util.*;

	import com.openxava.naviox.*;
	import com.openxava.naviox.impl.*;
	import com.openxava.naviox.util.*;

	/**
	*
	* @author Javier Paniza
	*/
	public class NaviOXFilter implements Filter {

	public void init(FilterConfig cfg) throws ServletException {
	//detect app name
	if(cfg.getServletContext().getContextPath()!=null && cfg.getServletContext().getContextPath().length()>0) {
	Modules.init(cfg.getServletContext().getContextPath().substring(1));
	}else {
	Modules.init(System.getenv("APP_NAME"));
	}

	}