/**
    * Copyright By Grandsoft Company Limited.  
    * 2014年5月19日 下午8:25:56
    */
   package gboat2.base.plugin.struts.freemarker;
   
   import java.io.File;
   import java.io.IOException;
   
  import javax.servlet.ServletContext;
  
  import org.apache.struts2.ServletActionContext;
  import org.apache.struts2.views.freemarker.FreemarkerManager;
  import org.osgi.framework.Bundle;
  import org.osgi.framework.FrameworkUtil;
  
  import com.opensymphony.xwork2.inject.Inject;
  import com.opensymphony.xwork2.util.logging.Logger;
  import com.opensymphony.xwork2.util.logging.LoggerFactory;
  
  import freemarker.cache.ClassTemplateLoader;
  import freemarker.cache.FileTemplateLoader;
  import freemarker.cache.MultiTemplateLoader;
  import freemarker.cache.TemplateLoader;
  import freemarker.cache.WebappTemplateLoader;
  import gboat2.base.bridge.debug.DefaultDebugHook;
  
  /**
   * Gboat2 平台自定义的 Freemarker 模板管理器。
   * 在 struts-plugin.xml 中新增了如下配置，使得该模板管理器生效：
   * <pre>
   * 在 struts-plugin.xml 中添加了如下配置：
   * <code>
   * &lt;!-- 使用自定义 FreeMarker 模板管理器 --&gt;
   * &lt;constant name="struts.freemarker.manager.classname" value="gboat2.base.plugin.struts.freemarker.GboatFreemarkerManager" /&gt;
   * </code>
   * </pre>
   * @date 2014年5月19日
   * @author <a href="mailto:[email protected]">何明旺</a>
   * @since 3.0.0-SNAPSHOT
   */
  public class GboatFreemarkerManager extends FreemarkerManager {
  
      private static final Logger LOG = LoggerFactory.getLogger(GboatFreemarkerManager.class);
      
      private GboatThemeTemplateLoader themeTemplateLoader;
      
      @Inject
      public void setThemeTemplateLoader(GboatThemeTemplateLoader themeTemplateLoader) {
          this.themeTemplateLoader = themeTemplateLoader;
      }
  
      @Override
      protected void configureTemplateLoader(TemplateLoader templateLoader) {
          themeTemplateLoader.init(templateLoader);
          config.setTemplateLoader(themeTemplateLoader);
      }
  
      @Override
      protected TemplateLoader createTemplateLoader(ServletContext servletContext, String templatePath) {
          TemplateLoader templatePathLoader = null;
  
          try {
              if(templatePath!=null){
                  if (templatePath.startsWith("class://")) {
                      // substring(7) is intentional as we "reuse" the last slash
                      templatePathLoader = new ClassTemplateLoader(getClass(), templatePath.substring(7));
                  } else if (templatePath.startsWith("file://")) {
                      templatePathLoader = new FileTemplateLoader(new File(templatePath.substring(7)));
                  } else {
                      Object action = ServletActionContext.getContext().getActionInvocation().getAction();
                      if(action != null) {
                          Bundle bundle = FrameworkUtil.getBundle(action.getClass());
                          DefaultDebugHook debugHook = DefaultDebugHook.getInstance();
                          if(bundle != null && debugHook.isBundleDebugEnabled(bundle.getSymbolicName())) {
                              // 调试环境直接从源代码中获取 FTL 模板文件
                              templatePathLoader = new FileTemplateLoader(new File(debugHook.getSourceFilePath(bundle.getSymbolicName(), templatePath)));
                          }
                      }
                  }
              }
          } catch (IOException e) {
              if (LOG.isErrorEnabled()) {
                 LOG.error("Invalid template path specified: #0", e, e.getMessage());
              }
          }
  
          // presume that most apps will require the class and webapp template loader
          // if people wish to
          return templatePathLoader != null ?
                  new MultiTemplateLoader(new TemplateLoader[]{
                          templatePathLoader,
                          new WebappTemplateLoader(servletContext),
                          new GboatClassTemplateLoader()
                  })
                  : new MultiTemplateLoader(new TemplateLoader[]{
                  new WebappTemplateLoader(servletContext),
                  new GboatClassTemplateLoader()
          });
     }
     
 }