/**
    * 
    */
   package sf.net.kayestry.components.menu;
   
   import java.io.IOException;
   import java.util.ArrayList;
   import java.util.Collection;
   import java.util.HashSet;
  import java.util.List;
  import java.util.Set;
  
  import org.apache.commons.digester.Digester;
  import org.springframework.core.io.ClassPathResource;
  import org.xml.sax.SAXException;
  
  import sf.net.kayestry.Globals;
  import sf.net.kayestry.KayaBaseComponent;
  import sf.net.kayestry.Visit;
  
  import ar.com.jiji.kaya.KayaRuntimeException;
  import ar.com.jiji.kaya.model.Role;
  import ar.com.jiji.kaya.model.User;
  
  /**
   * Genera un menu con JavaScript. El menu esta compuesto de items, que pueden
   * tener items hijos (submenues) o no. Soporta control de acceso en cada item. Y
   * el menu se lee desde menu.xml, desde el raiz del classpath.<br/> Un menu de
   * ejemplo para ver la estructura del xml es el siguiente:
   * 
   * <pre>
   *       
   *          &lt;?xml version=&quot;1.0&quot;?&gt;
   *          &lt;root&gt;
   *              &lt;item id=&quot;0&quot; name=&quot;Inicio&quot; pageName=&quot;Home&quot;/&gt;
   *              &lt;item id=&quot;1&quot; name=&quot;Administracion&quot;&gt;
   *                  &lt;item name=&quot;Beneficiarios&quot; pageName=&quot;BeneficiarioBrowse&quot;&gt;
   *                      &lt;allowed-roles&gt;
   *                          &lt;role&gt;admin&lt;/role&gt;
   *                      &lt;/allowed-roles&gt;
   *                  &lt;/item&gt;
   *              &lt;/item&gt;
   *              &lt;item id=&quot;2&quot; name=&quot;Reportes&quot;&gt;
   *                  &lt;allowed-roles&gt;
   *                      &lt;role&gt;usuario&lt;/role&gt;
   *                  &lt;/allowed-roles&gt;
   *              &lt;/item&gt;
   *              ...
   *          &lt;/root&gt;
   *        
   * </pre>
   * 
   * Los roles permitidos son los que existan en la aplicacion, utilizando el
   * esquema de seguridad que ofrece kommons. Estos roles no se heredan en los
   * subitems. El id del menu debe ser unico en toda la definicion. Este id es
   * utilizado para establecer el nombre del elemento <SPAN> que contiene el item.
   * 
   * 
   * @author jmile
   * @author lparra
   * 
   */
  public abstract class MenuComponent extends KayaBaseComponent {
  
  	private static final String DEFAULT_MENU = "menu.xml";
  
  	protected abstract String getDefinition();
  
  	protected abstract boolean getShowLogin();
  
  	private MenuItem currItem;
  
  	private MenuItem currSubItem;
  
  	public Collection getMenu() {
  		List<MenuItem> menu = loadMenu();
  		User usr = getLoggedUser();
  
  		List<MenuItem> tmpmenu = filterMenu(menu, usr);
  
  		if (getShowLogin()) {
  			MenuItem auxItem;
  			if (usr != null)
  				auxItem = new MenuItem("Logout", Globals.LOGOUT_PAGE);
  			else
  				auxItem = new MenuItem("Login", Globals.LOGIN_PAGE);
  			tmpmenu.add(auxItem);
  		}
  
  		return tmpmenu;
  	}
  
  	private User getLoggedUser() {
  		Visit visit = getVisit();
  		User usr = null;
  
  		if (visit != null)
  			usr = visit.getLoggedUser();
  
 		return usr;
 	}
 
 	private List<MenuItem> filterMenu(List<MenuItem> menu, User usr) {
 		// TODO: hacerlo solo una vez
 		Set<String> roles;
 		if (usr == null)
 			roles = new HashSet<String>();
 		else
 			roles = getRoleNames(usr.getRoles());
 		return filterMenu(menu, roles);
 	}
 
 	private List<MenuItem> filterMenu(List<MenuItem> menu, Set<String> roles) {
 		if (menu == null)
 			return null;
 		List<MenuItem> result = new ArrayList<MenuItem>();
 		for (MenuItem item : menu) {
 			Set<String> allowed = item.getAllowedRoles();
 			boolean add = (allowed == null);
 			if (!add)
 				for (String aux : roles)
 					if (allowed.contains(aux)) {
 						add = true;
 						break;
 					}
 			if (add) {
 				List<MenuItem> items = item.getSubItems();
 				List<MenuItem> filtered = filterMenu(items, roles);
 				item.setSubItems(filtered);
 				result.add(item);
 			}
 		}
 		return result;
 	}
 
 	private Set<String> getRoleNames(Set<Role> roles) {
 		Set<String> rolesNames = new HashSet<String>();
 		for (Role r : roles)
 			rolesNames.add(r.getName());
 		return rolesNames;
 	}
 
 	@SuppressWarnings("unchecked")
 	private List<MenuItem> loadMenu() {
 		String menuDef = getDefinition();
 		if (menuDef == null)
 			menuDef = DEFAULT_MENU;
 
 		// TODO: hacer esto una sola vez y no por cada llamado.
 		Digester digester = new Digester();
 		digester.setValidating(false);
 		digester.addObjectCreate("root", ArrayList.class);
 		digester.addObjectCreate("root/item", MenuItem.class);
 		digester.addSetProperties("root/item");
 		digester.addCallMethod("root/item/allowed-roles/role",
 				"addAllowedRole", 0);
 		digester.addSetNext("root/item", "add");
 		digester.addObjectCreate("*/item", MenuItem.class);
 		digester.addSetProperties("*/item");
 		digester.addSetNext("*/item", "addSubItem");
 		digester
 				.addCallMethod("*/item/allowed-roles/role", "addAllowedRole", 0);
 		try {
 			//FIXME: esta es la unica dependencia de spring en kayestry. hay algun problema con los classloaders. si uso getClass().getResource.... no anda cuando corre con la webapp. sacar la dependencia a spring.
 			return (List<MenuItem>) digester.parse(new ClassPathResource(
 					menuDef).getInputStream());
 		} catch (IOException e) {
 			throw new KayaRuntimeException(e);
 		} catch (SAXException e) {
 			throw new KayaRuntimeException(e);
 		}
 	}
 
 	public void setCurrentMenuItem(MenuItem value) {
 		currItem = value;
 	}
 
 	public void setCurrentMenuSubItem(MenuItem value) {
 		currSubItem = value;
 	}
 
 	public MenuItem getMenuSubItem() {
 		return currSubItem;
 	}
 
 	public MenuItem getMenuItem() {
 		return currItem;
 	}
 }