BaseMenuProvider.java

/*
 * This program is free software; you can redistribute it and/or modify it under the 
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software 
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this 
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html 
 * or from the Free Software Foundation, Inc., 
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright 2008 Pentaho Corporation.  All rights reserved.
 *
 */
package org.pentaho.platform.plugin.services.pluginmgr;

import java.io.InputStream;
import java.util.List;

import org.dom4j.Document;
import org.dom4j.io.SAXReader;
import org.pentaho.platform.api.engine.IPentahoSession;
import org.pentaho.platform.api.engine.IPluginManager;
import org.pentaho.platform.api.repository.ISolutionRepository;
import org.pentaho.platform.api.ui.IMenuProvider;
import org.pentaho.platform.engine.core.system.PentahoSystem;
import org.pentaho.platform.plugin.services.messages.Messages;
import org.pentaho.platform.util.logging.Logger;
import org.pentaho.ui.xul.IMenuCustomization;
import org.pentaho.ui.xul.XulComponent;
import org.pentaho.ui.xul.XulDomContainer;
import org.pentaho.ui.xul.XulLoader;
import org.pentaho.ui.xul.containers.XulMenubar;
import org.pentaho.ui.xul.containers.XulMenupopup;
import org.pentaho.ui.xul.util.MenuUtil;

public abstract class BaseMenuProvider implements IMenuProvider {

	public abstract Object getMenuBar( String id, String documentPath, IPentahoSession session );
	
	public abstract Object getPopupMenu( String id, String documentPath, IPentahoSession session );
	
	protected abstract XulLoader getXulLoader();
	
	protected XulDomContainer getXulContainer( String documentPath, IPentahoSession session) {
		  try {
			  ISolutionRepository repo = PentahoSystem.get( ISolutionRepository.class, session );
			  InputStream in = repo.getResourceInputStream( documentPath, true, ISolutionRepository.ACTION_EXECUTE);
		      SAXReader rdr = new SAXReader();
		      final Document doc = rdr.read(in);
		      
		      XulDomContainer container = getXulLoader().loadXul(doc);
		      
		      return container;
		  } catch (Exception e) {
			  session.error( Messages.getInstance().getErrorString("BaseMenuProvider.ERROR_0001_COULD_NOT_GET_MENU_CONTAINER") , e); //$NON-NLS-1$
		  }
		  return null;
	}
	
	protected XulMenubar getXulMenubar( String id, String documentPath, IPentahoSession session ) {
	      XulDomContainer container = getXulContainer( documentPath, session );
	      if( container == null ) {
	    	  return null;
	      }
	      List<XulComponent> components = container.getDocumentRoot().getElementsByTagName( "menubar" ); //$NON-NLS-1$
	      for( XulComponent component : components ) {
	    	  if( component instanceof XulMenubar && component.getId().equals( id ) ) {
			      XulMenubar menubar = (XulMenubar) component;
			      // now get customizations to it
			      IPluginManager pluginManager = PentahoSystem.get( IPluginManager.class, session ); 
			      List<?> menuCustomizations = pluginManager.getMenuCustomizations();
			      for( Object custom: menuCustomizations) {
			    	  if( custom instanceof IMenuCustomization ) {
		    			  IMenuCustomization item = (IMenuCustomization) custom;
			    		  try {
			    			  // apply each customization and log any failures
			    			  MenuUtil.customizeMenu(menubar, item, getXulLoader());
			    		  } catch (Exception e) {
			    			  session.error( Messages.getInstance().getString("BaseMenuProvider.ERROR_0004_COULD_NOT_CUSTOMIZE_MENU", item.getId(), item.getLabel() ), e); //$NON-NLS-1$
			    		  }
			    	  }
			      }
			      
		    	  return menubar;
		      }		      
	      }
		  Logger.error( getClass().getName(), Messages.getInstance().getErrorString("BaseMenuProvider.ERROR_0002_COULD_NOT_GET_MENUBAR") ); //$NON-NLS-1$
		  return null;
	}
	
	protected XulMenupopup getXulPopupMenu( String id, String documentPath, IPentahoSession session ) {
	      XulDomContainer container = getXulContainer( documentPath, session );
	      if( container != null ) {
		      List<XulComponent> components = container.getDocumentRoot().getElementsByTagName( "menupopup" ); //$NON-NLS-1$
		      for( XulComponent component : components ) {
		    	  if( component.getId().equals(id) && component instanceof XulMenupopup ) {
			    	  return (XulMenupopup) component;
		    	  }
		      }
	      }
		  Logger.error( getClass().getName(), Messages.getInstance().getErrorString("BaseMenuProvider.ERROR_0003_COULD_NOT_GET_POPUP_MENU") ); //$NON-NLS-1$
		  return null;
	}
	
}