io.wcm.handler.mediasource.dam.DamMediaSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io.wcm.handler.media Show documentation
Media resolving, processing and markup generation.
There is a newer version: 2.3.0
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2014 wcm.io
 * %%
 * Licensed 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.
 * #L%
 */
package io.wcm.handler.mediasource.dam;

import io.wcm.handler.commons.dom.HtmlElement;
import io.wcm.handler.commons.editcontext.DropTargetImpl;
import io.wcm.handler.media.Asset;
import io.wcm.handler.media.Media;
import io.wcm.handler.media.MediaArgs;
import io.wcm.handler.media.MediaInvalidReason;
import io.wcm.handler.media.MediaNameConstants;
import io.wcm.handler.media.MediaRequest;
import io.wcm.handler.media.markup.MediaMarkupBuilderUtil;
import io.wcm.handler.media.spi.helpers.AbstractMediaSource;
import io.wcm.handler.mediasource.dam.impl.DamAsset;
import io.wcm.sling.models.annotations.AemObject;

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.lang3.StringUtils;
import org.apache.jackrabbit.util.Text;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.adapter.Adaptable;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;
import org.osgi.annotation.versioning.ProviderType;

import com.day.cq.wcm.api.WCMMode;
import com.day.cq.wcm.api.components.Component;
import com.day.cq.wcm.api.components.ComponentContext;
import com.day.cq.wcm.api.components.DropTarget;
import com.day.cq.wcm.commons.WCMUtils;

/**
 * Default implementation for media requests to media items stored in CQ5 DAM.
 */
@Model(adaptables = {
    SlingHttpServletRequest.class, Resource.class
})
@ProviderType
public final class DamMediaSource extends AbstractMediaSource {

  @Self
  private Adaptable adaptable;
  @SlingObject
  private ResourceResolver resourceResolver;
  @SlingObject
  private Resource resource;
  @AemObject(optional = true)
  private WCMMode wcmMode;
  @AemObject(optional = true)
  private ComponentContext componentContext;

  /**
   * Media source ID
   */
  public static final String ID = "dam";

  @Override
  public String getId() {
    return ID;
  }

  @Override
  public boolean accepts(String mediaRef) {
    return StringUtils.startsWith(mediaRef, "/content/dam/");
  }

  @Override
  public String getPrimaryMediaRefProperty() {
    return MediaNameConstants.PN_MEDIA_REF;
  }

  @Override
  public Media resolveMedia(Media media) {
    String mediaRef = getMediaRef(media.getMediaRequest());
    MediaArgs mediaArgs = media.getMediaRequest().getMediaArgs();

    boolean renditionsResolved = false;
    if (StringUtils.isNotBlank(mediaRef)) {

      // Check if there is a custom altText specified in the component's properties
      if (StringUtils.isEmpty(mediaArgs.getAltText())
          && media.getMediaRequest().getResource() != null) {
        ValueMap props = media.getMediaRequest().getResource().getValueMap();
        mediaArgs.altText(props.get(MediaNameConstants.PN_MEDIA_ALTTEXT, String.class));
      }

      // Check for crop dimensions
      media.setCropDimension(getMediaCropDimension(media.getMediaRequest()));

      // get DAM Asset to check for available renditions
      com.day.cq.dam.api.Asset damAsset = null;
      Resource assetResource = resourceResolver.getResource(mediaRef);
      if (assetResource != null) {
        damAsset = assetResource.adaptTo(com.day.cq.dam.api.Asset.class);
      }
      if (damAsset != null) {
        Asset asset = new DamAsset(damAsset, media, adaptable);
        media.setAsset(asset);

        // resolve rendition(s)
        renditionsResolved = resolveRenditions(media, asset, mediaArgs);
      }

    }

    // set media invalid reason
    if (!renditionsResolved) {
      if (media.getAsset() != null) {
        if (media.getRenditions().isEmpty()) {
          media.setMediaInvalidReason(MediaInvalidReason.NO_MATCHING_RENDITION);
        }
        else {
          media.setMediaInvalidReason(MediaInvalidReason.NOT_ENOUGH_MATCHING_RENDITIONS);
        }
      }
      else if (StringUtils.isNotEmpty(mediaRef)) {
        media.setMediaInvalidReason(MediaInvalidReason.MEDIA_REFERENCE_INVALID);
      }
      else {
        media.setMediaInvalidReason(MediaInvalidReason.MEDIA_REFERENCE_MISSING);
      }
    }

    return media;
  }

  @Override
  public void enableMediaDrop(HtmlElement element, MediaRequest mediaRequest) {
    if (wcmMode == WCMMode.DISABLED || wcmMode == null) {
      return;
    }

    String refProperty = getMediaRefProperty(mediaRequest);
    if (!StringUtils.startsWith(refProperty, "./")) {
      refProperty = "./" + refProperty; //NOPMD
    }

    String cropProperty = getMediaCropProperty(mediaRequest);
    if (!StringUtils.startsWith(cropProperty, "./")) {
      cropProperty = "./" + cropProperty; //NOPMD
    }

    String name = refProperty;
    if (StringUtils.contains(name, "/")) {
      name = Text.getName(name);
    }

    if (componentContext != null && componentContext.getEditContext() != null
        && MediaMarkupBuilderUtil.canApplyDragDropSupport(mediaRequest, componentContext)) {
      Component componentDefinition = WCMUtils.getComponent(resource);

      // set drop target - with path of current component as default resource type
      Map params = new HashMap();
      if (componentDefinition != null) {
        params.put("./" + ResourceResolver.PROPERTY_RESOURCE_TYPE, componentDefinition.getPath());

        // clear cropping parameters if a new image is inserted via drag&drop
        params.put(cropProperty, "");
      }

      DropTarget dropTarget = new DropTargetImpl(name, refProperty).setAccept(new String[] {
          "image/.*" // allow all image mime types
      }).setGroups(new String[] {
          "media" // allow drop from DAM contentfinder tab
      }).setParameters(params);

      componentContext.getEditContext().getEditConfig().getDropTargets().put(dropTarget.getId(), dropTarget);

      if (element != null) {
        element.addCssClass(DropTarget.CSS_CLASS_PREFIX + name);
      }
    }
  }

  @Override
  public String toString() {
    return ID;
  }

}