Html5SmartImageWidget.java

/**
 *    Copyright 2017 ICF Olson
 *
 *    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.citytechinc.cq.component.dialog.html5smartimage;

import org.codehaus.plexus.util.StringUtils;

import com.citytechinc.cq.component.annotations.config.Widget;
import com.citytechinc.cq.component.annotations.widgets.Html5SmartImage;
import com.citytechinc.cq.component.dialog.AbstractWidget;
import com.citytechinc.cq.component.dialog.TabbableDialogElement;

@Widget(annotationClass = Html5SmartImage.class, makerClass = Html5SmartImageWidgetMaker.class,
	xtype = Html5SmartImageWidget.XTYPE)
public class Html5SmartImageWidget extends AbstractWidget implements TabbableDialogElement {

	public static final String XTYPE = "html5smartimage";
	public static final String NAME_SUFFIX = "file";

	private String originalName;
	private final boolean disableFlush;
	private final boolean disableInfo;
	private final boolean disableZoom;
	private final String cropParameter;
	private final String fileNameParameter;
	private final String fileReferenceParameter;
	private final String mapParameter;
	private final String rotateParameter;
	private final String uploadUrl;
	private final String ddGroups;
	private final boolean allowUpload;
	private final Integer height;
	private final boolean tab;
	private String title;

	public Html5SmartImageWidget(Html5SmartImageWidgetParameters parameters) {
		super(parameters);
		originalName = parameters.getName();
		this.disableFlush = parameters.isDisableFlush();
		this.disableInfo = parameters.isDisableInfo();
		this.disableZoom = parameters.isDisableZoom();
		this.cropParameter = parameters.getCropParameter();
		this.fileNameParameter = parameters.getFileNameParameter();
		this.fileReferenceParameter = parameters.getFileReferenceParameter();
		this.mapParameter = parameters.getMapParameter();
		this.rotateParameter = parameters.getRotateParameter();
		this.uploadUrl = parameters.getUploadUrl();
		this.ddGroups = parameters.getDdGroups();
		this.allowUpload = parameters.isAllowUpload();
		this.height = parameters.getHeight();
		this.tab = parameters.isTab();
	}

	private static String getNameAsPrefix(String name) {
		if (!name.endsWith("/")) {
			return name + "/";
		}
        return name;
	}

    private static String getSanitizedName(String name) {
        String sanitizedName = name;
        if (sanitizedName.startsWith("./")) {
            sanitizedName = sanitizedName.substring(2);
        }
        if (sanitizedName.endsWith("/")) {
            sanitizedName = sanitizedName.substring(0, sanitizedName.length() - 1);
        }

        return sanitizedName;
    }

	public String getTitle() {
		return title;
	}

	public void setTitle(String title) {
		this.title = title;
	}

	public boolean isDisableFlush() {
		return disableFlush;
	}

	public boolean isDisableInfo() {
		return disableInfo;
	}

	public boolean isDisableZoom() {
		return disableZoom;
	}

	public String getCropParameter() {
		if (!StringUtils.isEmpty(cropParameter)) {
			return getNameAsPrefix(originalName) + cropParameter;
		}
		return cropParameter;
	}

	public String getFileNameParameter() {
		if (!StringUtils.isEmpty(fileNameParameter)) {
			return getNameAsPrefix(originalName) + fileNameParameter;
		}
		return fileNameParameter;
	}

	public String getFileReferenceParameter() {
		if (!StringUtils.isEmpty(fileReferenceParameter)) {
			return getNameAsPrefix(originalName) + fileReferenceParameter;
		}
		return fileReferenceParameter;
	}

	public String getMapParameter() {
		if (!StringUtils.isEmpty(mapParameter)) {
			return getNameAsPrefix(originalName) + mapParameter;
		}
		return mapParameter;
	}

	public String getRotateParameter() {
		if (!StringUtils.isEmpty(rotateParameter)) {
			return getNameAsPrefix(originalName) + rotateParameter;
		}
		return rotateParameter;
	}

	public String getUploadUrl() {
		return uploadUrl;
	}

	public String getDdGroups() {
		return ddGroups;
	}

	public boolean isAllowUpload() {
		return allowUpload;
	}

	public Boolean isTab() {
		return tab;
	}

	public String getLabel() {
		return getFieldLabel();
	}

	public Integer getHeight() {
		return height;
	}

    //NTS: using the oob naming stuff we are adding ./ to the original name --- historically we were not using this which was the purpose of the getasprefix methods.  Now what we need is a sanatize method which removes the ./ if it is there
	public String getRequestSuffix() {
		if (StringUtils.isEmpty(originalName) || "./".equals(originalName)) {
			return ".img.png";
		}
        else {
			return "/" + getSanitizedName(originalName) + ".img.png";
		}
	}

	@Override
	public String getName() {
		return getNameAsPrefix(originalName) + NAME_SUFFIX;
	}

	@Override
	public void setName(String name) {
		String newName = name;
		if (name.endsWith("/")) {
			newName = newName.substring(0, newName.length() - 1);
		}
		originalName = newName;
	}

}