/*
* Copyright (c) 2002-2010 Gargoyle Software Inc.
*
* 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.gargoylesoftware.htmlunit.html;
import java.io.File;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Map;
import org.apache.commons.lang.StringUtils;
import com.gargoylesoftware.htmlunit.SgmlPage;
import com.gargoylesoftware.htmlunit.util.KeyDataPair;
import com.gargoylesoftware.htmlunit.util.NameValuePair;
/**
* Wrapper for the HTML element "input".
*
* @version $Revision: 5301 $
* @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
* @author <a href="mailto:cse@dynabean.de">Christian Sell</a>
* @author Daniel Gredler
* @author Ahmed Ashour
* @author Marc Guillemot
*/
public class HtmlFileInput extends HtmlInput {
private static final long serialVersionUID = 7925479292349207154L;
private String contentType_;
private byte[] data_;
private String valueAtFocus_;
/**
* Creates an instance.
*
* @param namespaceURI the URI that identifies an XML namespace
* @param qualifiedName the qualified name of the element type to instantiate
* @param page the page that contains this element
* @param attributes the initial attributes
*/
HtmlFileInput(final String namespaceURI, final String qualifiedName, final SgmlPage page,
final Map<String, DomAttr> attributes) {
super(namespaceURI, qualifiedName, page, attributes);
setAttribute("value", "");
if (page.getWebClient().getBrowserVersion().isIE()) {
setDefaultValue("");
}
}
/**
* Returns the in-memory data assigned to this file input element, if any.
* @return <code>null</code> if {@link #setData(byte[])} hasn't be used
*/
public final byte[] getData() {
return data_;
}
/**
* <p>Assigns in-memory data to this file input element. During submission, instead
* of loading data from a file, the data is read from in-memory byte array.</p>
*
* <p>NOTE: Only use this method if you wish to upload in-memory data; if you instead
* wish to upload the contents of an actual file, use {@link #setValueAttribute(String)},
* passing in the path to the file.</p>
*
* @param data the in-memory data assigned to this file input element
*/
public final void setData(final byte[] data) {
data_ = data;
}
/**
* {@inheritDoc}
*/
@Override
public NameValuePair[] getSubmitKeyValuePairs() {
String value = getValueAttribute();
if (StringUtils.isEmpty(value)) {
return new NameValuePair[] {new KeyDataPair(getNameAttribute(), new File(""), null, null)};
}
File file = null;
// to tolerate file://
if (value.startsWith("file:/")) {
if (value.startsWith("file://") && !value.startsWith("file:///")) {
value = "file:///" + value.substring(7);
}
try {
file = new File(new URI(value));
}
catch (final URISyntaxException e) {
// nothing here
}
}
if (file == null) {
file = new File(value);
}
// contentType and charset are determined from browser and page
// perhaps it could be interesting to have setters for it in this class
// to give finer control to user
final String contentType;
if (contentType_ == null) {
contentType = getPage().getWebClient().guessContentType(file);
}
else {
contentType = contentType_;
}
final String charset = getPage().getPageEncoding();
final KeyDataPair keyDataPair = new KeyDataPair(getNameAttribute(), file, contentType, charset);
keyDataPair.setData(data_);
return new NameValuePair[] {keyDataPair};
}
/**
* {@inheritDoc} This method <b>does nothing</b> for file input elements.
* @see SubmittableElement#reset()
*/
@Override
public void reset() {
// Empty.
}
/**
* {@inheritDoc} Overridden so that this does not set the value attribute when emulating
* Netscape browsers.
* @see HtmlInput#setDefaultValue(String)
*/
@Override
public void setDefaultValue(final String defaultValue) {
setDefaultValue(defaultValue, false);
}
/**
* Sets the content type value that should be sent together with the uploaded file.
* If content type is not explicitly set, HtmlUnit will try to guess it from the file content.
* @param contentType the content type (<tt>null</tt> resets it)
*/
public void setContentType(final String contentType) {
contentType_ = contentType;
}
/**
* Gets the content type that should be sent together with the uploaded file.
* @return the content type, or <tt>null</tt> if this has not been explicitly set
* and should be guessed from file content
*/
public String getContentType() {
return contentType_;
}
/**
* {@inheritDoc}
*/
@Override
public void focus() {
super.focus();
// store current value to trigger onchange when needed at focus lost
valueAtFocus_ = getValueAttribute();
}
@Override
void removeFocus() {
super.removeFocus();
if (!valueAtFocus_.equals(getValueAttribute())) {
executeOnChangeHandlerIfAppropriate(this);
}
valueAtFocus_ = null;
}
}