/**
    * copyright by Grandsoft Company Limited.  
    * 2012-1-4
    */
   /**    
    * 文件名：GboatPackageBasedActionConfigBuilder.java    
    *    
    * 版本信息：    
    * 日期：2012-1-4    
   * Copyright 广联达软件股份有限公司 2012     
   * 版权所有    
   *    
   */
  package gboat2.base.plugin.struts.convention;
  
  import java.io.IOException;
  import java.net.URL;
  import java.util.ArrayList;
  import java.util.HashSet;
  import java.util.List;
  import java.util.Set;
  import java.util.regex.Pattern;
  
  import org.apache.commons.lang3.StringUtils;
  import org.apache.struts2.convention.PackageBasedActionConfigBuilder;
  
  import com.opensymphony.xwork2.FileManager;
  import com.opensymphony.xwork2.FileManagerFactory;
  import com.opensymphony.xwork2.ObjectFactory;
  import com.opensymphony.xwork2.config.Configuration;
  import com.opensymphony.xwork2.inject.Container;
  import com.opensymphony.xwork2.inject.Inject;
  import com.opensymphony.xwork2.util.TextParseUtil;
  import com.opensymphony.xwork2.util.finder.ClassFinder;
  import com.opensymphony.xwork2.util.finder.ClassLoaderInterface;
  import com.opensymphony.xwork2.util.finder.ClassLoaderInterfaceDelegate;
  import com.opensymphony.xwork2.util.finder.Test;
  import com.opensymphony.xwork2.util.finder.UrlSet;
  import com.opensymphony.xwork2.util.logging.Logger;
  import com.opensymphony.xwork2.util.logging.LoggerFactory;
  
  /**
   * 重载 Struts2 内置的 {@link PackageBasedActionConfigBuilder#findActions()}，
   * 解决 OSGI bundle 内部 Action 初始化时寻找父类 BaseActionSupport 的问题。<br>
   * 使用方法为在 struts.xml 中加入如下配置：<br><code>
   * &lt;bean name="gboat2" type="org.apache.struts2.convention.ActionConfigBuilder" class="gboat2.base.plugin.struts.GboatPackageBasedActionConfigBuilder" /&gt;<br>
   * &lt;constant name="struts.convention.actionConfigBuilder" value="gboat2" /&gt;</code>
   * @author lysming
   * @since 1.0
   * @see org.apache.struts2.convention.PackageBasedActionConfigBuilder.java
   */
  public class GboatPackageBasedActionConfigBuilder extends PackageBasedActionConfigBuilder {
  
  	private static final Logger LOG = LoggerFactory.getLogger(PackageBasedActionConfigBuilder.class);
  
  	private String[] actionPackages;
  
  	private String[] packageLocators;
  
  	private boolean disablePackageLocatorsScanning = false;
  
  	private Set<String> fileProtocols;
  
  	private boolean excludeParentClassLoader;
  
  	private String[] includeJars;
  
  	private FileManager fileManager;
  
  	/**
  	 * Constructs actions based on a list of packages.
  	 * 
  	 * @param configuration
  	 *            The XWork configuration that the new package configs and
  	 *            action configs are added to.
  	 * @param container
  	 *            Xwork Container
  	 * @param objectFactory
  	 *            The ObjectFactory used to create the actions and such.
  	 * @param redirectToSlash
  	 *            A boolean parameter that controls whether or not this will
  	 *            create an action for indexes. If this is set to true, index
  	 *            actions are not created because the unknown handler will
  	 *            redirect from /foo to /foo/. The only action that is created
  	 *            is to the empty action in the namespace (e.g. the namespace
  	 *            /foo and the action "").
  	 * @param defaultParentPackage
  	 *            The default parent package for all the configuration.
  	 */
  	@Inject
  	public GboatPackageBasedActionConfigBuilder(Configuration configuration,
  	        Container container, ObjectFactory objectFactory,
  			@Inject("struts.convention.redirect.to.slash") String redirectToSlash,
  			@Inject("struts.convention.default.parent.package") String defaultParentPackage) {
  		super(configuration, container, objectFactory, redirectToSlash, defaultParentPackage);
  	}
  
  	@Inject
  	public void setFileManagerFactory(FileManagerFactory fileManagerFactory) {
 		this.fileManager = fileManagerFactory.getFileManager();
 	}
 
 	@SuppressWarnings("rawtypes")
     @Override
     protected Set<Class> findActions() {
         Set<Class> classes = new HashSet<Class>();
         try {
             if (actionPackages != null
                     || (packageLocators != null && !disablePackageLocatorsScanning)) {
                 // 该处传递的 extractBaseInterfaces 为 false
                 Test<String> classPackageTest = getClassPackageTest();
                 ClassFinder finder = new ClassFinder(getClassLoaderInterface(),
                         buildUrlSet().getUrls(), false, this.fileProtocols, classPackageTest);
                 Test<ClassFinder.ClassInfo> test = getActionClassTest();
                 classes.addAll(finder.findClasses(test));
             }
         } catch (Exception ex) {
             if (LOG.isErrorEnabled())
                 LOG.error("Unable to scan named packages", ex);
         }
         return classes;
     }
 
 	/**
 	 * 同PackageBasedActionConfigBuilder的实现一致
 	 * 
 	 * @return UrlSet
 	 * @throws IOException
 	 *             io异常
 	 */
 	private UrlSet buildUrlSet() throws IOException {
 		ClassLoaderInterface classLoaderInterface = getClassLoaderInterface();
 		// 检查是否存在META-INF
 		URL mi = classLoaderInterface.getResource("META-INF");
 		if (mi == null) {
 			LOG.error("META-INF can't be found in {}", classLoaderInterface.toString());
 			return new UrlSet(new ArrayList<URL>());
 		}
 		UrlSet urlSet = new UrlSet(classLoaderInterface, this.fileProtocols);
 
 		// excluding the urls found by the parent class loader is desired, but
 		// fails in JBoss (all urls are removed)
 		if (excludeParentClassLoader) {
 			// exclude parent of classloaders
 			ClassLoaderInterface parent = classLoaderInterface.getParent();
 			// if reload is enabled, we need to step up one level, otherwise the
 			// UrlSet will be empty
 			// this happens because the parent of the realoding class loader is
 			// the web app classloader
 			if (parent != null && isReloadEnabled())
 				parent = parent.getParent();
 
 			if (parent != null)
 				urlSet = urlSet.exclude(parent);
 
 			try {
 				// This may fail in some sandboxes, ie GAE
 				ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
 				urlSet = urlSet.exclude(new ClassLoaderInterfaceDelegate(systemClassLoader.getParent()));
 
 			} catch (SecurityException e) {
 				if (LOG.isWarnEnabled())
 					LOG.warn("Could not get the system classloader due to security constraints, there may be improper urls left to scan");
 			}
 		}
 
 		// try to find classes dirs inside war files
 		urlSet = urlSet.includeClassesUrl(classLoaderInterface, new UrlSet.FileProtocolNormalizer() {
 			public URL normalizeToFileProtocol(URL url) {
 				return fileManager.normalizeToFileProtocol(url);
 			}
 		});
 
 		urlSet = urlSet.excludeJavaExtDirs();
 		urlSet = urlSet.excludeJavaEndorsedDirs();
 		try {
 			urlSet = urlSet.excludeJavaHome();
 		} catch (NullPointerException e) {
 			// This happens in GAE since the sandbox contains no java.home
 			// directory
 			if (LOG.isWarnEnabled())
 				LOG.warn("Could not exclude JAVA_HOME, is this a sandbox jvm?");
 		}
 		urlSet = urlSet.excludePaths(System.getProperty("sun.boot.class.path", ""));
 		urlSet = urlSet.exclude(".*/JavaVM.framework/.*");
 
 		if (includeJars == null) {
 			urlSet = urlSet.exclude(".*?\\.jar(!/|/)?");
 		} else {
 			// jar urls regexes were specified
 			List<URL> rawIncludedUrls = urlSet.getUrls();
 			Set<URL> includeUrls = new HashSet<URL>();
 			boolean[] patternUsed = new boolean[includeJars.length];
 
 			String convertedUrl;
 			for (URL url : rawIncludedUrls) {
 				if (fileProtocols.contains(url.getProtocol())) {
 					// it is a jar file, make sure it macthes at least a url
 					// regex
 					for (int i = 0; i < includeJars.length; i++) {
 						String includeJar = includeJars[i];
 						convertedUrl = url.toExternalForm().replaceAll("\\\\", "/");
 						if (Pattern.matches(includeJar, convertedUrl)) {
 							includeUrls.add(url);
 							patternUsed[i] = true;
 							break;
 						}
 					}
 				} else {
 					// it is not a jar
 					includeUrls.add(url);
 				}
 			}
 
 			if (LOG.isWarnEnabled()) {
 				for (int i = 0; i < patternUsed.length; i++) {
 					if (!patternUsed[i]) {
 						LOG.warn("The includeJars pattern [#0] did not match any jars in the classpath", includeJars[i]);
 					}
 				}
 			}
 			return new UrlSet(includeUrls);
 		}
 
 		return urlSet;
 	}
 
 	/**
 	 * @param actionPackages
 	 *            (Optional) An optional list of action packages that this
 	 *            should create configuration for.
 	 */
 	@Inject(value = "struts.convention.action.packages", required = false)
 	public void setActionPackages(String actionPackages) {
 		super.setActionPackages(actionPackages);
 		if (StringUtils.isNotBlank(actionPackages)) {
 			this.actionPackages = actionPackages.split("\\s*[,]\\s*");
 		}
 	}
 
 	/**
 	 * @param packageLocators
 	 *            (Optional) A list of names used to find action packages.
 	 */
 	@Inject(value = "struts.convention.package.locators", required = false)
 	public void setPackageLocators(String packageLocators) {
 		super.setPackageLocators(packageLocators);
 		this.packageLocators = packageLocators.split("\\s*[,]\\s*");
 	}
 
 	/**
 	 * @param disablePackageLocatorsScanning
 	 *            If set to true, only the named packages will be scanned
 	 */
 	@Inject(value = "struts.convention.package.locators.disable", required = false)
 	public void setDisablePackageLocatorsScanning(String disablePackageLocatorsScanning) {
 		super.setDisablePackageLocatorsScanning(disablePackageLocatorsScanning);
 		this.disablePackageLocatorsScanning = "true".equals(disablePackageLocatorsScanning);
 	}
 
 	/**
 	 * File URLs whose protocol are in these list will be processed as jars
 	 * containing classes
 	 * 
 	 * @param fileProtocols
 	 *            Comma separated list of file protocols that will be considered
 	 *            as jar files and scanned
 	 */
 	@Inject("struts.convention.action.fileProtocols")
 	public void setFileProtocols(String fileProtocols) {
 		super.setFileProtocols(fileProtocols);
 		if (StringUtils.isNotBlank(fileProtocols)) {
 			this.fileProtocols = TextParseUtil.commaDelimitedStringToSet(fileProtocols);
 		}
 	}
 
 	/**
 	 * Exclude URLs found by the parent class loader. Defaults to "true", set to
 	 * true for JBoss
 	 * 
 	 * @see org.apache.struts2.convention.PackageBasedActionConfigBuilder#setExcludeParentClassLoader(java.lang.String)
 	 * @param exclude
 	 *            例外
 	 */
 	@Inject("struts.convention.exclude.parentClassLoader")
 	public void setExcludeParentClassLoader(String exclude) {
 		super.setExcludeParentClassLoader(exclude);
 		this.excludeParentClassLoader = "true".equals(exclude);
 	}
 
 	/**
 	 * @param includeJars
 	 *            Comma separated list of regular expressions of jars to be
 	 *            included.
 	 */
 	@Inject(value = "struts.convention.action.includeJars", required = false)
 	public void setIncludeJars(String includeJars) {
 		super.setIncludeJars(includeJars);
 		if (StringUtils.isNotEmpty(includeJars))
 			this.includeJars = includeJars.split("\\s*[,]\\s*");
 	}
 }