/**
    * This file Copyright (c) 2014-2016 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.dam.app.setup.for2_0;
  
  import info.magnolia.dam.jcr.AssetNodeTypes;
  import info.magnolia.dam.jcr.DamConstants;
  import info.magnolia.jcr.util.NodeUtil;
  import info.magnolia.jcr.util.NodeVisitor;
  import info.magnolia.jcr.util.PropertyUtil;
  import info.magnolia.module.InstallContext;
  import info.magnolia.module.delta.AbstractTask;
  import info.magnolia.module.delta.TaskExecutionException;
  
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  import javax.jcr.Session;
  
  import org.apache.commons.lang3.StringUtils;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Dam 1.x had a property for filename (myFileName) and extension (pdf).<br>
   * Dam 2.0 use only one property containing both values (myFileName.pdf). <br>
   * This task take care migrating (aggregating) those property for the complete dam workspace.
   */
  public class UpdateDamAssetFileNamePropertiesTask extends AbstractTask {
      private static final Logger log = LoggerFactory.getLogger(UpdateDamAssetFileNamePropertiesTask.class);
      private Session damSession;
  
      public UpdateDamAssetFileNamePropertiesTask(String taskName, String taskDescription) {
          super(taskName, taskDescription);
      }
  
      @Override
      public void execute(InstallContext ctx) throws TaskExecutionException {
          try {
              damSession = ctx.getJCRSession(DamConstants.WORKSPACE);
              NodeUtil.visit(damSession.getRootNode(), new DamFileNamePropertyVisitor());
          } catch (RepositoryException re) {
              ctx.error("Could not update the dam filename properties ", re);
          }
      }
  
      /**
       * Aggregate filename and extension.
       */
      private class DamFileNamePropertyVisitor implements NodeVisitor {
          @Override
          public void visit(Node asset) throws RepositoryException {
              if (!StringUtils.equals(asset.getPrimaryNodeType().getName(), AssetNodeTypes.Asset.NAME)) {
                  return;
              }
              if(AssetNodeTypes.AssetResource.getResourceNodeFromAsset(asset) == null) {
                  log.info("Skipping asset {} without a resource node", asset.getPath());
                  return;
              }
              String extension = StringUtils.removeStart(getExtensionProperty(asset), ".");
              String fileName = PropertyUtil.getString(AssetNodeTypes.AssetResource.getResourceNodeFromAsset(asset), AssetNodeTypes.AssetResource.FILENAME, "");
              if(StringUtils.endsWith(fileName, "." + extension)) {
                  log.debug("Asset '{}' has already a well formed fileName property '{}'. Nothing to do.", asset.getPath(), fileName);
                  return;
              }
              fileName = fileName + "." + extension;
              log.debug("Set asset fileName property to '{}'", fileName);
              AssetNodeTypes.AssetResource.getResourceNodeFromAsset(asset).getProperty(AssetNodeTypes.AssetResource.FILENAME).setValue(fileName);
          }
      }
 
     /**
      * @return {@link Asset#TYPE} property of asset {@link Node}. If this property is not define return {@link AssetResource#EXTENSION} or null if this property is not defined.
      */
     private String getExtensionProperty(Node asset) throws RepositoryException {
         String extension = PropertyUtil.getString(asset, AssetNodeTypes.Asset.TYPE);
         if(StringUtils.isBlank(extension)) {
             log.debug("Asset '{}' has an empty property '{}'. Asset.resource node property '{}' will be used", asset.getPath(), AssetNodeTypes.Asset.TYPE, AssetNodeTypes.AssetResource.EXTENSION);
             extension = PropertyUtil.getString(AssetNodeTypes.AssetResource.getResourceNodeFromAsset(asset), AssetNodeTypes.AssetResource.EXTENSION);
             if(StringUtils.isBlank(extension)){
                 log.warn("Asset '{}' has no extension defined.", asset.getPath());
             }
         }
         return extension;
     }
 
 }