com.adobe.acs.commons.remoteassets.impl.RemoteAssetsBinarySyncImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation
Main ACS AEM Commons OSGi Bundle. Includes commons utilities.
There is a newer version: 6.9.4
Show newest version
/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 Adobe
 *
 * 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.
 */
package com.adobe.acs.commons.remoteassets.impl;

import static java.net.HttpURLConnection.HTTP_NOT_FOUND;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.Calendar;
import java.util.Iterator;

import org.apache.commons.lang3.StringUtils;
import org.apache.http.client.HttpResponseException;
import org.apache.http.client.fluent.Executor;
import org.apache.http.client.fluent.Request;
import org.apache.sling.api.resource.ModifiableValueMap;
import org.apache.sling.api.resource.PersistenceException;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.adobe.acs.commons.remoteassets.RemoteAssetsBinarySync;
import com.day.cq.dam.api.Asset;
import com.day.cq.dam.api.DamConstants;
import com.day.cq.dam.api.Rendition;
import com.day.cq.dam.commons.util.DamUtil;

/**
 * Service to sync a remote asset's binaries a from remote server.
 *
 * Pulls the binaries for a remote asset in order to make it a true local asset.
 */
@Component(service=RemoteAssetsBinarySync.class)
public class RemoteAssetsBinarySyncImpl implements RemoteAssetsBinarySync {

    private static final Logger LOG = LoggerFactory.getLogger(RemoteAssetsBinarySyncImpl.class);

    @Reference
    private RemoteAssetsConfigImpl remoteAssetsConfig;

    /**
     * @see RemoteAssetsBinarySync#syncAsset(Resource)
     * @param resource Resource
     * @return boolean true if sync successful, else false
     */
    @Override
    public boolean syncAsset(Resource resource) {
        
        try (ResourceResolver remoteAssetsResolver = this.remoteAssetsConfig.getResourceResolver()){
            
            try {
                Resource localRes = remoteAssetsResolver.getResource(resource.getPath());
                Asset asset = DamUtil.resolveToAsset(localRes);
                URI pathUri = new URI(null, null, asset.getPath(), null);
                String baseUrl = this.remoteAssetsConfig.getServer().concat(pathUri.toString()).concat("/_jcr_content/renditions/");

                Iterator renditions = asset.listRenditions();
                while (renditions.hasNext()) {
                    Rendition assetRendition = renditions.next();
                    if (StringUtils.isEmpty(assetRendition.getMimeType())) {
                        continue;
                    }
                    String renditionName = assetRendition.getName();
                    String remoteUrl = String.format("%s%s", baseUrl, renditionName);
                    setRenditionOnAsset(remoteUrl, assetRendition, asset, renditionName);
                }

                ModifiableValueMap localResProps = localRes.adaptTo(ModifiableValueMap.class);
                localResProps.remove(RemoteAssets.IS_REMOTE_ASSET);
                localResProps.remove(RemoteAssets.REMOTE_SYNC_FAILED);
                remoteAssetsResolver.commit();
                return true;
            } catch (Exception e) {
                LOG.error("Error transferring remote asset '{}' to local server", resource.getPath(), e);
                try {
                    remoteAssetsResolver.revert();
                    flagAssetAsFailedSync(remoteAssetsResolver, resource.getPath());
                } catch (Exception re) {
                    LOG.error("Failed to mark sync of {} as failed", resource.getPath(),re);
                }
            } 
        }
        return false;
    }

    /**
     * Fetch binary from URL and set into the asset rendition.
     * @param remoteUrl String
     * @param assetRendition Rendition
     * @param asset Asset
     * @param renditionName String
     * @throws FileNotFoundException exception
     */
    private void setRenditionOnAsset(String remoteUrl, Rendition assetRendition, Asset asset, String renditionName)
            throws IOException {

        LOG.debug("Syncing from remote asset url: {}", remoteUrl);
        Executor executor = this.remoteAssetsConfig.getRemoteAssetsHttpExecutor();
        try (InputStream inputStream = executor.execute(Request.Get(remoteUrl)).returnContent().asStream()) {
            asset.addRendition(renditionName, inputStream, assetRendition.getMimeType());
        } catch (HttpResponseException fne) {
            if (DamConstants.ORIGINAL_FILE.equals(renditionName) || fne.getStatusCode() != HTTP_NOT_FOUND) {
                throw fne;
            }

            asset.removeRendition(renditionName);
            LOG.warn("Rendition '{}' not found on remote environment. Removing local rendition.", renditionName);
        }
    }

    /**
     * Sets a property on the resource if the asset sync failed.
     * @param remoteAssetsResolver a resolver to change the resource
     * @param path describes the resource to change
     * 
     * @throws PersistenceException 
     */
    private void flagAssetAsFailedSync(ResourceResolver remoteAssetsResolver, String path) throws PersistenceException {
        Resource localRes = remoteAssetsResolver.getResource(path);
        ModifiableValueMap localResProps = localRes.adaptTo(ModifiableValueMap.class);
        localResProps.put(RemoteAssets.REMOTE_SYNC_FAILED, Calendar.getInstance());
        remoteAssetsResolver.commit();

    }
}