ThymeleafMetadataProviderImpl.java

package org.springframework.roo.addon.web.mvc.thymeleaf.addon;

import static org.springframework.roo.model.RooJavaType.ROO_THYMELEAF;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.osgi.service.component.ComponentContext;
import org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata;
import org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata.RelationInfo;
import org.springframework.roo.addon.jpa.annotations.entity.JpaRelationType;
import org.springframework.roo.addon.layers.service.addon.ServiceMetadata;
import org.springframework.roo.addon.web.mvc.controller.addon.ControllerAnnotationValues;
import org.springframework.roo.addon.web.mvc.controller.addon.ControllerMetadata;
import org.springframework.roo.addon.web.mvc.controller.addon.RelationInfoExtended;
import org.springframework.roo.addon.web.mvc.controller.annotations.ControllerType;
import org.springframework.roo.addon.web.mvc.thymeleaf.addon.link.factory.LinkFactoryAnnotationValues;
import org.springframework.roo.addon.web.mvc.views.AbstractViewGeneratorMetadataProvider;
import org.springframework.roo.addon.web.mvc.views.MVCViewGenerationService;
import org.springframework.roo.classpath.PhysicalTypeIdentifier;
import org.springframework.roo.classpath.PhysicalTypeMetadata;
import org.springframework.roo.classpath.customdata.taggers.CustomDataKeyDecorator;
import org.springframework.roo.classpath.customdata.taggers.CustomDataKeyDecoratorTracker;
import org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails;
import org.springframework.roo.classpath.details.FieldMetadata;
import org.springframework.roo.classpath.details.ItdTypeDetails;
import org.springframework.roo.classpath.details.MemberHoldingTypeDetails;
import org.springframework.roo.classpath.details.MethodMetadata;
import org.springframework.roo.metadata.MetadataDependencyRegistry;
import org.springframework.roo.metadata.internal.MetadataDependencyRegistryTracker;
import org.springframework.roo.model.JavaType;
import org.springframework.roo.model.JpaJavaType;
import org.springframework.roo.model.RooJavaType;
import org.springframework.roo.project.LogicalPath;
import org.springframework.roo.project.maven.Pom;
import org.springframework.roo.support.logging.HandlerUtils;

import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Logger;

/**
 * Implementation of {@link ThymeleafMetadataProvider}.
 *
 * @author Juan Carlos García
 * @since 2.0
 */
@Component
@Service
public class ThymeleafMetadataProviderImpl extends
    AbstractViewGeneratorMetadataProvider<ThymeleafMetadata> implements ThymeleafMetadataProvider {

  protected final static Logger LOGGER = HandlerUtils
      .getLogger(ThymeleafMetadataProviderImpl.class);

  private final Map<JavaType, String> domainTypeToServiceMidMap =
      new LinkedHashMap<JavaType, String>();

  protected MetadataDependencyRegistryTracker registryTracker = null;
  protected CustomDataKeyDecoratorTracker keyDecoratorTracker = null;

  private Map<String, JavaType> jasperReportsExporterMap;

  /**
   * This service is being activated so setup it:
   * <ul>
   * <li>Create and open the {@link MetadataDependencyRegistryTracker}.</li>
   * <li>Create and open the {@link CustomDataKeyDecoratorTracker}.</li>
   * <li>Registers {@link RooJavaType#ROO_THYMELEAF} as additional JavaType
   * that will trigger metadata registration.</li>
   * <li>Set ensure the governor type details represent a class.</li>
   * </ul>
   */
  @Override
  protected void activate(final ComponentContext cContext) {
    context = cContext.getBundleContext();
    serviceInstaceManager.activate(this.context);
    this.registryTracker =
        new MetadataDependencyRegistryTracker(context, this,
            PhysicalTypeIdentifier.getMetadataIdentiferType(), getProvidesType());
    this.registryTracker.open();

    addMetadataTrigger(ROO_THYMELEAF);
  }

  /**
   * This service is being deactivated so unregister upstream-downstream
   * dependencies, triggers, matchers and listeners.
   *
   * @param context
   */
  protected void deactivate(final ComponentContext context) {
    MetadataDependencyRegistry registry = this.registryTracker.getService();
    registry.removeNotificationListener(this);
    registry.deregisterDependency(PhysicalTypeIdentifier.getMetadataIdentiferType(),
        getProvidesType());
    this.registryTracker.close();

    removeMetadataTrigger(ROO_THYMELEAF);

    CustomDataKeyDecorator keyDecorator = this.keyDecoratorTracker.getService();
    keyDecorator.unregisterMatchers(getClass());
    this.keyDecoratorTracker.close();
  }

  @Override
  protected String createLocalIdentifier(final JavaType javaType, final LogicalPath path) {
    return ThymeleafMetadata.createIdentifier(javaType, path);
  }

  @Override
  protected String getGovernorPhysicalTypeIdentifier(final String metadataIdentificationString) {
    final JavaType javaType = ThymeleafMetadata.getJavaType(metadataIdentificationString);
    final LogicalPath path = ThymeleafMetadata.getPath(metadataIdentificationString);
    return PhysicalTypeIdentifier.createIdentifier(javaType, path);
  }

  public String getItdUniquenessFilenameSuffix() {
    return "Thymeleaf";
  }

  @Override
  protected String getLocalMidToRequest(final ItdTypeDetails itdTypeDetails) {
    // Determine the governor for this ITD, and whether any metadata is even
    // hoping to hear about changes to that JavaType and its ITDs
    final JavaType governor = itdTypeDetails.getName();
    final String localMid = domainTypeToServiceMidMap.get(governor);
    if (localMid != null) {
      return localMid;
    }

    final MemberHoldingTypeDetails memberHoldingTypeDetails =
        getTypeLocationService().getTypeDetails(governor);
    if (memberHoldingTypeDetails != null) {
      for (final JavaType type : memberHoldingTypeDetails.getLayerEntities()) {
        final String localMidType = domainTypeToServiceMidMap.get(type);
        if (localMidType != null) {
          return localMidType;
        }
      }
    }
    return null;
  }

  @Override
  protected MVCViewGenerationService getViewGenerationService() {
    return getServiceManager().getServiceInstance(this, MVCViewGenerationService.class);
  }

  @Override
  protected ThymeleafMetadata createMetadataInstance(final String metadataIdentificationString,
      final JavaType aspectName, final PhysicalTypeMetadata governorPhysicalTypeMetadata,
      final ControllerMetadata controllerMetadata, final ServiceMetadata serviceMetadata,
      final JpaEntityMetadata entityMetadata, final String entityPlural,
      final String entityIdentifierPlural,
      final List<Pair<RelationInfo, JpaEntityMetadata>> compositionRelationOneToOne,
      final JavaType itemController, final JavaType collectionController,
      final List<FieldMetadata> dateTimeFields, final List<FieldMetadata> enumFields,
      final Map<String, MethodMetadata> findersToAdd,
      final Map<JavaType, List<FieldMetadata>> formBeansDateTimeFields,
      final Map<JavaType, List<FieldMetadata>> formBeansEnumFields,
      final JavaType detailsItemController, final JavaType detailsCollectionController) {


    // Get related controller for select2 request
    JavaType relatedCollectionController = null;
    JavaType relatedItemController = null;
    RelationInfoExtended info = controllerMetadata.getLastDetailsInfo();
    if (controllerMetadata.getType() == ControllerType.DETAIL
        && info.type == JpaRelationType.AGGREGATION) {

      Collection<ClassOrInterfaceTypeDetails> controllers =
          getControllerLocator().getControllers(info.childType, ControllerType.COLLECTION,
              RooJavaType.ROO_THYMELEAF);
      final String prefix = controllerMetadata.getAnnotationValues().getPathPrefix();
      for (ClassOrInterfaceTypeDetails controller : controllers) {
        // use annotation values to avoid cyclic dependencies
        ControllerAnnotationValues valuesToCheck = new ControllerAnnotationValues(controller);
        if (StringUtils.equals(prefix, valuesToCheck.getPathPrefix())) {
          relatedCollectionController = controller.getType();
          break;
        }
      }
      Validate
          .notNull(
              relatedCollectionController,
              "Can't found Collection-type controller of entity '%s' and pathPrefix '%s' required by '%s' controller",
              info.childType, prefix, controllerMetadata.getDestination());
      controllers =
          getControllerLocator().getControllers(info.childType, ControllerType.ITEM,
              RooJavaType.ROO_THYMELEAF);
      for (ClassOrInterfaceTypeDetails controller : controllers) {
        // use annotation values to avoid cyclic dependencies
        ControllerAnnotationValues valuesToCheck = new ControllerAnnotationValues(controller);
        if (StringUtils.equals(prefix, valuesToCheck.getPathPrefix())) {
          relatedItemController = controller.getType();
          break;
        }
      }
      Validate
          .notNull(
              relatedItemController,
              "Can't found Item-type controller of entity '%s' and pathPrefix '%s' required by '%s' controller",
              info.childType, prefix, controllerMetadata.getDestination());
    }

    Validate.notNull(getJasperReportsMap(),
        "Couldn't find class `JasperReportsExporter` in project.");

    // Get valid entity fields (those suitable for reports)
    JavaType defaultReturnType =
        serviceMetadata.getCurrentFindAllWithGlobalSearchMethod().getReturnType().getParameters()
            .get(0);
    List<FieldMetadata> entityFields =
        getReturnTypeValidFields(getMemberDetailsScanner().getMemberDetails(
            this.getClass().getName(), getTypeLocationService().getTypeDetails(defaultReturnType))
            .getFields());

    // Getting the related linkFactory for this controller
    Set<ClassOrInterfaceTypeDetails> linkFactories =
        getTypeLocationService().findClassesOrInterfaceDetailsWithAnnotation(
            RooJavaType.ROO_LINK_FACTORY);

    JavaType relatedCollectionLinkFactory = null;
    JavaType relatedItemLinkFactory = null;
    JavaType collectionControllerToCheck = collectionController;
    if (collectionControllerToCheck == null) {
      collectionControllerToCheck = governorPhysicalTypeMetadata.getType();
    }

    JavaType itemControllerToCheck = itemController;
    if (itemControllerToCheck == null) {
      itemControllerToCheck = governorPhysicalTypeMetadata.getType();
    }

    for (ClassOrInterfaceTypeDetails linkFactory : linkFactories) {
      LinkFactoryAnnotationValues annotationValues = new LinkFactoryAnnotationValues(linkFactory);
      // Getting link factory of the collection controller
      if (annotationValues.getController().equals(collectionControllerToCheck)) {
        relatedCollectionLinkFactory = linkFactory.getType();
      } else if (annotationValues.getController().equals(itemControllerToCheck)) {
        relatedItemLinkFactory = linkFactory.getType();
      }


    }

    final ThymeleafMetadata metadata =
        new ThymeleafMetadata(metadataIdentificationString, aspectName,
            governorPhysicalTypeMetadata, controllerMetadata, serviceMetadata, entityMetadata,
            entityPlural, entityIdentifierPlural, compositionRelationOneToOne, itemController,
            collectionController, dateTimeFields, enumFields, findersToAdd,
            formBeansDateTimeFields, formBeansEnumFields, detailsItemController,
            detailsCollectionController, relatedCollectionController, relatedItemController,
            entityFields, getJasperReportsMap(), relatedCollectionLinkFactory,
            relatedItemLinkFactory);

    return metadata;
  }

  public String getProvidesType() {
    return ThymeleafMetadata.getMetadataIdentiferType();
  }

  /**
   * Finds `JasperReportsExporter` for providing Metadata with its package.
   * This method is temporal as `JasperReportsExporter` should be moved to 
   * other support project.
   * 
   */
  public Map<String, JavaType> getJasperReportsMap() {
    if (this.jasperReportsExporterMap == null) {
      Map<String, JavaType> jasperReportsExporterMap = new HashMap<String, JavaType>();
      Collection<Pom> modules = getProjectOperations().getPoms();
      for (Pom module : modules) {
        Collection<JavaType> typesForModule = getTypeLocationService().getTypesForModule(module);
        for (JavaType type : typesForModule) {
          if (type.getSimpleTypeName().equals("JasperReportsExporter")) {
            jasperReportsExporterMap.put("JasperReportsExporter", type);
          } else if (type.getSimpleTypeName().equals("JasperReportsCsvExporter")) {
            jasperReportsExporterMap.put("JasperReportsCsvExporter", type);
          } else if (type.getSimpleTypeName().equals("JasperReportsPdfExporter")) {
            jasperReportsExporterMap.put("JasperReportsPdfExporter", type);
          } else if (type.getSimpleTypeName().equals("JasperReportsXlsExporter")) {
            jasperReportsExporterMap.put("JasperReportsXlsExporter", type);
          } else if (type.getSimpleTypeName().equals("ExportingErrorException")) {
            // Get ExportingErrorException
            jasperReportsExporterMap.put("ExportingErrorException", type);
          }
        }
      }
      this.jasperReportsExporterMap = new HashMap<String, JavaType>();
      this.jasperReportsExporterMap.putAll(jasperReportsExporterMap);
    }

    return this.jasperReportsExporterMap;
  }

  /**
   * Return the entity list of valid fields. Static and referenced fields 
   * are excluded.
   * 
   * @return a List<FieldMetadata>
   * 
   */
  private List<FieldMetadata> getReturnTypeValidFields(List<FieldMetadata> fields) {

    // Iterate over entity fields
    List<FieldMetadata> validFields = new ArrayList<FieldMetadata>();
    for (FieldMetadata field : fields) {

      // Exclude non-simple fields. This also exclude relation fields which 
      // return a collection @OneToMany and @ManyToMany
      if (field.getFieldType().isMultiValued()) {
        continue;
      }

      // Exclude static fields
      int staticFinal = Modifier.STATIC + Modifier.FINAL;
      int publicStatic = Modifier.PUBLIC + Modifier.STATIC;
      int publicStaticFinal = Modifier.PUBLIC + Modifier.STATIC + Modifier.FINAL;
      int privateStatic = Modifier.PRIVATE + Modifier.STATIC;
      int privateStaticFinal = Modifier.PRIVATE + Modifier.STATIC + Modifier.FINAL;

      if (field.getModifier() == Modifier.STATIC || field.getModifier() == staticFinal
          || field.getModifier() == publicStatic || field.getModifier() == publicStaticFinal
          || field.getModifier() == privateStatic || field.getModifier() == privateStaticFinal) {
        continue;
      }

      // Exclude relation fields
      if (field.getAnnotation(JpaJavaType.ONE_TO_ONE) != null) {
        continue;
      }
      if (field.getAnnotation(JpaJavaType.MANY_TO_ONE) != null) {
        continue;
      }

      // Exclude embedded fields
      if (field.getAnnotation(JpaJavaType.EMBEDDED) != null
          || field.getAnnotation(JpaJavaType.EMBEDDED_ID) != null) {
        continue;
      }

      validFields.add(field);
    }
    return validFields;
  }

}