content: /*
   *  Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you under the Apache License, Version 2.0 (the
   *  "License"); you may not use this file except in compliance
   *  with the License.  You may obtain a copy of the License at
   *
   *        http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   */
  package org.apache.causeway.applib.mixins.metamodel;
  
  import java.util.Objects;
  import java.util.Optional;
  
  import jakarta.inject.Inject;
  
  import org.apache.causeway.applib.annotation.Action;
  import org.apache.causeway.applib.annotation.ActionLayout;
  import org.apache.causeway.applib.annotation.MemberSupport;
  import org.apache.causeway.applib.annotation.ParameterLayout;
  import org.apache.causeway.applib.annotation.Publishing;
  import org.apache.causeway.applib.annotation.RestrictTo;
  import org.apache.causeway.applib.annotation.SemanticsOf;
  import org.apache.causeway.applib.id.LogicalType;
  import org.apache.causeway.applib.layout.LayoutConstants;
  import org.apache.causeway.applib.mixins.dto.DtoMixinConstants;
  import org.apache.causeway.applib.services.jaxb.JaxbService;
  import org.apache.causeway.applib.services.message.MessageService;
  import org.apache.causeway.applib.services.metamodel.Config;
  import org.apache.causeway.applib.services.metamodel.MetaModelService;
  import org.apache.causeway.applib.value.Clob;
  import org.apache.causeway.applib.value.NamedWithMimeType.CommonMimeType;
  
  import lombok.RequiredArgsConstructor;
  
  /**
   * Provides the ability to download the framework's internal
   * metamodel for any domain entity or view model, in XML format.
   *
   * @since 1.x {@index}
   */
  @Action(
          commandPublishing = Publishing.DISABLED,
          domainEvent = Object_downloadMetamodelXml.ActionDomainEvent.class,
          executionPublishing = Publishing.DISABLED,
          restrictTo = RestrictTo.PROTOTYPING,
          semantics = SemanticsOf.SAFE
  )
  @ActionLayout(
          cssClassFa = "fa-download",
          describedAs = "Downloads a representation of the framework's internal metamodel for this object's domain class",
          fieldSetId = LayoutConstants.FieldSetId.METADATA,
          position = ActionLayout.Position.PANEL_DROPDOWN,
          sequence = "700.2"
  )
  //mixin's don't need a logicalTypeName
  @RequiredArgsConstructor
  public class Object_downloadMetamodelXml {
  
      private final Object holder;
  
      public static class ActionDomainEvent
      extends org.apache.causeway.applib.CausewayModuleApplib.ActionDomainEvent<Object_downloadMetamodelXml> {}
  
      @MemberSupport public Object act(
              @ParameterLayout(
                      named = DtoMixinConstants.FILENAME_PROPERTY_NAME,
                      describedAs = DtoMixinConstants.FILENAME_PROPERTY_DESCRIPTION)
              final String fileName) {
  
          final Optional<LogicalType> logicalTypeIfAny = metaModelService.lookupLogicalTypeByClass(holder.getClass());
          if(!logicalTypeIfAny.isPresent()) {
              messageService.warnUser("Unknown class, unable to export");
              return null;
          }
          final String namespace = logicalTypeIfAny.get().namespace();
  
          var config = Config.builder()
                  .ignoreFallbackFacets(true)
                  .ignoreAbstractClasses(true)
                  .ignoreInterfaces(true)
                  .ignoreBuiltInValueTypes(true)
                  .build()
                  .withNamespacePrefix(namespace);
  
          var metamodelDto = metaModelService.exportMetaModel(config);
  
          var className = holder.getClass().getName();
  
          var domainClassDtos = metamodelDto.getDomainClassDto();
          domainClassDtos.removeIf(classDto->!Objects.equals(classDto.getId(), className));
  
          var xmlString = jaxbService.toXml(metamodelDto);
  
          return Clob.of(fileName, CommonMimeType.XML, xmlString);
      }
  
      /**
       * Defaults to the simple name of the domain object's class.
       */
      @MemberSupport public String default0Act() {
          return holder.getClass().getSimpleName();
      }
  
      @Inject MetaModelService metaModelService;
      @Inject MessageService messageService;
      @Inject JaxbService jaxbService;
  
  }
  