/* * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * "The contents of this file are subject to the Mozilla Public License * Version 1.1 (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.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the * License for the specific language governing rights and limitations under * the License. * * The Original Code is ICEfaces 1.5 open source software code, released * November 5, 2006. The Initial Developer of the Original Code is ICEsoft * Technologies Canada, Corp. Portions created by ICEsoft are Copyright (C) * 2004-2006 ICEsoft Technologies Canada, Corp. All Rights Reserved. * * Contributor(s): _____________________. * * Alternatively, the contents of this file may be used under the terms of * the GNU Lesser General Public License Version 2.1 or later (the "LGPL" * License), in which case the provisions of the LGPL License are * applicable instead of those above. If you wish to allow use of your * version of this file only under the terms of the LGPL License and not to * allow others to use your version of this file under the MPL, indicate * your decision by deleting the provisions above and replace them with * the notice and other provisions required by the LGPL License. If you do * not delete the provisions above, a recipient may use your version of * this file under either the MPL or the LGPL License." * */ package com.icesoft.faces.component.inputfile; import com.icesoft.faces.component.CSS_DEFAULT; import com.icesoft.faces.component.ext.taglib.Util; import com.icesoft.faces.component.style.OutputStyle; import com.icesoft.faces.context.BridgeFacesContext; import com.icesoft.faces.renderkit.dom_html_basic.DomBasicRenderer; import com.icesoft.faces.utils.MessageUtils; import com.icesoft.faces.webapp.http.servlet.FileUploadComponent; import com.icesoft.faces.webapp.xmlhttp.PersistentFacesState; import java.util.ArrayList; import org.apache.commons.fileupload.FileItemStream; import org.apache.commons.fileupload.FileUploadBase; import org.apache.commons.fileupload.util.Streams; import javax.faces.component.UICommand; import javax.faces.component.UIComponent; import javax.faces.context.FacesContext; import javax.faces.context.ExternalContext; import javax.faces.el.MethodBinding; import javax.faces.el.ValueBinding; import javax.faces.event.ActionEvent; import javax.faces.event.ActionListener; import javax.faces.event.FacesListener; import javax.servlet.http.HttpServletRequest; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; import java.io.Serializable; import java.io.Writer; import java.util.EventObject; import java.util.Iterator; /** * InputFile is a JSF component class representing an ICEfaces inputFile. */ public class InputFile extends UICommand implements Serializable, FileUploadComponent { public static final int DEFAULT = 0; public static final int UPLOADING = 1; public static final int SAVED = 2; public static final int INVALID = 3; public static final int SIZE_LIMIT_EXCEEDED = 4; public static final int UNKNOWN_SIZE = 5; public static final int INVALID_NAME_PATTERN = 6; public static final String INVALID_FILE_MESSAGE_ID = "com.icesoft.faces.component.inputfile.INVALID_FILE"; public static final String INVALID_NAME_PATTERN_MESSAGE_ID = "com.icesoft.faces.component.inputfile.INVALID_NAME_PATTERN"; public static final String SIZE_LIMIT_EXCEEDED_MESSAGE_ID = "com.icesoft.faces.component.inputfile.SIZE_LIMIT_EXCEEDED"; public static final String UNKNOWN_SIZE_MESSAGE_ID = "com.icesoft.faces.component.inputfile.UNKNOWN_SIZE"; public static final String FILE_UPLOAD_PREFIX = "fileUpload"; private Boolean disabled; private String style; private String styleClass; private String label; private String enabledOnUserRole; private String renderedOnUserRole; private String title; private int height = 30; private int width = 500; private int inputTextSize = 35; private String inputTextClass; private String fileNamePattern; private boolean uniqueFolder = true; private String downloadFolder; private Throwable uploadException; private int status = DEFAULT; private FileInfo fileInfo = new FileInfo(); private int progress = 0; private File file; private long sizeMax; private MethodBinding progressListener; /** *

Return the value of the COMPONENT_TYPE of this * component.

*/ public String getComponentType() { return "com.icesoft.faces.File"; } /** *

Return the value of the RENDERER_TYPE of this * component.

*/ public String getRendererType() { return "com.icesoft.faces.Upload"; } /** *

Return the value of the COMPONENT_FAMILY of this * component.

*/ public String getFamily() { return "com.icesoft.faces.File"; } public void upload(FileItemStream stream, String defaultFolder, long maxSize, BridgeFacesContext bfc) throws IOException { this.uploadException = null; this.status = UPLOADING; this.sizeMax = maxSize; FacesContext context = FacesContext.getCurrentInstance(); String folder = getDownloadFolder(); folder = folder == null ? defaultFolder : folder; String namePattern = getFileNamePattern().trim(); String fileName = stream.getName(); // IE gives us the whole path on the client, but we just // want the client end file name, not the path if(fileName != null && fileName.length() > 0) { File tempFileName = new File(fileName); fileName = tempFileName.getName(); } fileInfo.setFileName(fileName); fileInfo.setContentType(stream.getContentType()); try { if (fileName != null && fileName.trim().matches(namePattern)) { File folderFile = new File(folder); if(!folderFile.exists()) folderFile.mkdirs(); // ngriffin@liferay.com: Partial fix for http://jira.icefaces.org/browse/ICE-1601 this.file = new File(folder, fileName); ValueBinding vb = getValueBinding("file"); if (vb != null) { try { vb.setValue(context, getFile()); } catch (Exception exception) { exception.printStackTrace(); throw new IOException(exception.getMessage()); } } OutputStream output = new FileOutputStream(file); Streams.copy(stream.openStream(), output, true); status = SAVED; fileInfo.setPhysicalPath(file.getAbsolutePath()); notifyDone(bfc); } else { fileInfo.reset(); file = null; status = INVALID_NAME_PATTERN; context.addMessage(null, MessageUtils.getMessage(context, INVALID_NAME_PATTERN_MESSAGE_ID, new Object[] { fileName, namePattern })); notifyDone(bfc); } } catch (FileUploadBase.FileUploadIOException uploadException) { this.uploadException = uploadException.getCause(); try { throw this.uploadException; } catch (FileUploadBase.FileSizeLimitExceededException e) { status = SIZE_LIMIT_EXCEEDED; } catch (FileUploadBase.UnknownSizeException e) { status = UNKNOWN_SIZE; } catch (FileUploadBase.InvalidContentTypeException e) { status = INVALID; } catch (Throwable t) { status = INVALID; } fileInfo.setException(uploadException); file.delete(); notifyDone(bfc); throw uploadException; } catch(IOException e) { // Eg: If creating the saved file fails this.uploadException = e; status = INVALID; fileInfo.setException(e); file.delete(); notifyDone(bfc); throw e; } PersistentFacesState.getInstance().renderLater(); } protected void notifyDone(BridgeFacesContext bfc) { ActionEvent event = new ActionEvent(this); bfc.setCurrentInstance(); // ngriffin@liferay.com: Action binding not being called without this... queueEvent(event); //this is true for JSF 1.1 only MethodBinding actionListener = getActionListener(); if(actionListener != null) { System.err.println("!@#$ JSF 1.1 actionListener=" + actionListener.toString()); actionListener.invoke( FacesContext.getCurrentInstance(), new Object[] {event} ); } //this is true for JSF 1.2 only ActionListener[] actionListeners = getActionListeners(); for (int i=0; i< actionListeners.length; i++) { System.err.println("!@#$ JSF 1.2"); actionListeners[i].processAction(event); } // Execute the action listener method binding (if one exists) MethodBinding action = getAction(); if(action != null) { action.invoke(FacesContext.getCurrentInstance(), null); } if(fileInfo != null) fileInfo.reset(); } // ngriffin@liferay.com: http://jira.icefaces.org/browse/ICE-1605 private static ArrayList findOutputStyleComponents(UIComponent parent) { ArrayList returnValue = null; Iterator children = parent.getChildren().iterator(); UIComponent childComponent = null; while (children.hasNext()) { childComponent = (UIComponent) children.next(); if (childComponent instanceof OutputStyle) { if (returnValue == null) { returnValue = new ArrayList(); } returnValue.add(childComponent); } else { ArrayList outputStyleComponents = findOutputStyleComponents(childComponent); if (outputStyleComponents != null) { if (returnValue == null) { returnValue = outputStyleComponents; } else { returnValue.add(outputStyleComponents); } } } } return returnValue; } public void renderIFrame(Writer writer, BridgeFacesContext context) throws IOException { String srv = getUploadServletPath(context); // ngriffin@liferay.com: http://jira.icefaces.org/browse/ICE-1603 writer.write(""); // ngriffin@liferay.com: http://jira.icefaces.org/browse/ICE-1605 ArrayList outputStyleComponents = findOutputStyleComponents(context.getViewRoot()); if (outputStyleComponents != null) { writer.write(""); for (int i = 0; i < outputStyleComponents.size(); i++) { OutputStyle outputStyle = (OutputStyle) outputStyleComponents.get(i); String href = outputStyle.getHref(); if ((href != null) && (href.length() > 0)) { href = DomBasicRenderer.getResourceURL(context, href); Object requestObject = context.getExternalContext().getRequest(); if ((requestObject != null) && (requestObject instanceof HttpServletRequest)) { HttpServletRequest httpServletRequest = (HttpServletRequest) requestObject; String scheme = httpServletRequest.getScheme(); String hostName = httpServletRequest.getServerName(); int port = httpServletRequest.getServerPort(); // Because this is rendered in a
layer, portlets for some reason // need the scheme://hostname:port part of the URL prepended. href = scheme + "://" + hostName + ":" + port + href; } writer.write(""); } } writer.write(""); } writer.write("
"); writer.write(""); writer.write(""); writer.write(""); writer.write(""); writer.write("
"); writer.write(""); } private String getUploadServletPath(BridgeFacesContext context) { String requestContextPath = null; if(context != null) { ExternalContext externalContext = context.getExternalContext(); if(externalContext != null) { requestContextPath = externalContext.getRequestContextPath(); } } if(requestContextPath == null || requestContextPath.length() == 0) return "./uploadHtml"; else return requestContextPath + "/uploadHtml"; } public Throwable getUploadException() { return uploadException; } /** *

* Set the value of the label property.

*/ public void setLabel(String label) { this.label = label; } /** *

* Set the value of the uniqueFolder property.

*/ public void setUniqueFolder(boolean uniqueFolder) { if (uniqueFolder != this.uniqueFolder) { this.uniqueFolder = uniqueFolder; } } /** *

* Return the value of the uniqueFolder property.

*/ public boolean isUniqueFolder() { ValueBinding vb = getValueBinding("uniqueFolder"); if (vb != null) { return (Boolean.TRUE.equals(vb.getValue(getFacesContext()))); } return true; } /** *

* Return the value of the label property.

*/ public String getLabel() { if (label != null) { return label; } ValueBinding vb = getValueBinding("label"); return vb != null ? (String) vb.getValue(getFacesContext()) : "Upload"; } /** *

Return the value of the disabled property.

*/ public boolean isDisabled() { if (!Util.isEnabledOnUserRole(this)) { return true; } else { if (disabled != null) { return disabled.booleanValue(); } ValueBinding vb = getValueBinding("disabled"); Boolean boolVal = vb != null ? (Boolean) vb.getValue(getFacesContext()) : null; return boolVal != null ? boolVal.booleanValue() : false; } } /** *

Set the value of the disabled property.

*/ public void setDisabled(boolean disabled) { this.disabled = Boolean.valueOf(disabled); } /** *

Set the value of the enabledOnUserRole property.

*/ public void setEnabledOnUserRole(String enabledOnUserRole) { this.enabledOnUserRole = enabledOnUserRole; } /** *

Return the value of the enabledOnUserRole property.

*/ public String getEnabledOnUserRole() { if (enabledOnUserRole != null) { return enabledOnUserRole; } ValueBinding vb = getValueBinding("enabledOnUserRole"); return vb != null ? (String) vb.getValue(getFacesContext()) : null; } public void setDownloadFolder(String downloadFolder) { this.downloadFolder = downloadFolder; } public String getDownloadFolder() { if (downloadFolder != null) { return downloadFolder; } ValueBinding vb = getValueBinding("downloadFolder"); return vb != null ? (String) vb.getValue(getFacesContext()) : null; } /** *

Set the value of the renderedOnUserRole property.

*/ public void setRenderedOnUserRole(String renderedOnUserRole) { this.renderedOnUserRole = renderedOnUserRole; } /** *

Return the value of the renderedOnUserRole property.

*/ public String getRenderedOnUserRole() { if (renderedOnUserRole != null) { return renderedOnUserRole; } ValueBinding vb = getValueBinding("renderedOnUserRole"); return vb != null ? (String) vb.getValue(getFacesContext()) : null; } /** *

Return the value of the rendered property.

*/ public boolean isRendered() { if (!Util.isRenderedOnUserRole(this)) { return false; } return super.isRendered(); } /** *

Set the value of the style property.

*/ public void setStyle(String style) { this.style = style; } /** *

Return the value of the style property.

*/ public String getStyle() { if (style != null) { return style; } ValueBinding vb = getValueBinding("style"); // ngriffin@liferay.com: partial fix for http://jira.icefaces.org/browse/ICE-1604 return vb != null ? (String) vb.getValue(getFacesContext()) : "border-collapse:collapse; border-spacing:0px; width:" + width + "px; height:" + height + "px; padding:0px;"; } /** *

Set the value of the styleClass property.

*/ public void setStyleClass(String styleClass) { this.styleClass = styleClass; } /** *

Return the value of the styleClass property.

*/ public String getStyleClass() { return Util.getDisaledOREnabledClass(this, isDisabled(), styleClass, "styleClass", CSS_DEFAULT.ICE_FILE_UPLOAD_BASE_CLASS); } /** *

Gets the state of the instance as a Serializable * Object.

*/ public Object saveState(FacesContext context) { Object values[] = new Object[26]; values[0] = super.saveState(context); values[6] = disabled; values[8] = style; values[9] = styleClass; values[10] = label; values[13] = enabledOnUserRole; values[14] = renderedOnUserRole; return ((Object) (values)); } /** *

Perform any processing required to restore the state from the entries * in the state Object.

*/ public void restoreState(FacesContext context, Object state) { Object values[] = (Object[]) state; super.restoreState(context, values[0]); disabled = (Boolean) values[6]; style = (String) values[8]; styleClass = (String) values[9]; label = (String) values[10]; enabledOnUserRole = (String) values[13]; renderedOnUserRole = (String) values[14]; } /** *

Set the value of the title property.

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

Return the value of the title property.

*/ public String getTitle() { if (title != null) { return title; } ValueBinding vb = getValueBinding("title"); return vb != null ? (String) vb.getValue(getFacesContext()) : null; } // size private String size = null; /** *

Set the value of the size property.

*/ public void setSize(String size) { this.size = size; } /** *

Return the value of the size property.

*/ public String getSize() { if (size != null) { return size; } ValueBinding vb = getValueBinding("size"); return vb != null ? (String) vb.getValue(getFacesContext()) : null; } public int getHeight() { ValueBinding vb = getValueBinding("height"); if (vb != null) { Integer value = (Integer) vb.getValue(getFacesContext()); if (null == value) { return height; } return (value.intValue()); } else { return (this.height); } } public void setHeight(int height) { this.height = height; } public int getWidth() { ValueBinding vb = getValueBinding("width"); if (vb != null) { Integer value = (Integer) vb.getValue(getFacesContext()); if (null == value) { return width; } return (value.intValue()); } else { return (this.width); } } public void setWidth(int width) { this.width = width; } public int getInputTextSize() { ValueBinding vb = getValueBinding("inputTextSize"); if (vb != null) { Integer value = (Integer) vb.getValue(getFacesContext()); if (null == value) { return inputTextSize; } return (value.intValue()); } else { return (this.inputTextSize); } } public void setInputTextSize(int inputTextSize) { this.inputTextSize = inputTextSize; } public String getFileNamePattern() { if (fileNamePattern != null) { return fileNamePattern; } ValueBinding vb = getValueBinding("fileNamePattern"); return vb != null ? (String) vb.getValue(getFacesContext()) : ".+"; } public void setFileNamePattern(String fileNamePattern) { this.fileNamePattern = fileNamePattern; } public void setInputTextClass(String inputTextClass) { this.inputTextClass = inputTextClass; } public String getInputTextClass() { String result = CSS_DEFAULT.ICE_FILE_UPLOAD_DEFAULT_INPUT_TEXT_CLASS; if (inputTextClass != null) { result = inputTextClass; } if (isDisabled()) { result += "-dis"; } // Append the style if it is still the default if (result.equals(CSS_DEFAULT.ICE_FILE_UPLOAD_DEFAULT_INPUT_TEXT_CLASS)) { return Util.appendNewStyleClass( CSS_DEFAULT.ICE_FILE_UPLOAD_BASE_CLASS, styleClass, result); } // Otherwise return the user specified override class return result; } private String buttonClass = null; public void setButtonClass(String buttonClass) { this.buttonClass = buttonClass; } public String getButtonClass() { String result = CSS_DEFAULT.ICE_FILE_UPLOAD_DEFAULT_BUTTON_CLASS; if (buttonClass != null) { result = buttonClass; } if (isDisabled()) { result += "-dis"; } // Append the style if it is still the default if (result.equals(CSS_DEFAULT.ICE_FILE_UPLOAD_DEFAULT_BUTTON_CLASS)) { return Util.appendNewStyleClass( CSS_DEFAULT.ICE_FILE_UPLOAD_BASE_CLASS, styleClass, result); } // Otherwise return the user specified override class return result; } boolean isRegister() { return false; } public void setRegister(FacesContext facesContext) { //do nothing } /** *

* Return the value of the fileInfo property.

*/ public FileInfo getFileInfo() { return fileInfo; } void setFileInfo(FileInfo fileInfo) { //do nothing } /** *

* Return the value of the file property.

*/ public File getFile() { return file; } /** *

* Set the value of the file property.

*/ public void setFile(File file) { //do nothing } public int getStatus() { return status; } /** *

Return the value of the fileName property.

* * @deprecated use getFileInfo().getFileName() instead. */ public String getFilename() { return fileInfo.getFileName(); } /** *

Set the value of the fileName property.

* * @deprecated use getFileInfo().setFileName() instead. */ public void setFilename(String filename) { fileInfo.setFileName(filename); } /** *

Return the value of the size property.

* * @deprecated use getFileInfo().getSize() instead. */ public long getFilesize() { return fileInfo.getSize(); } /** *

Set the value of the size property.

* */ public void setFilesize(long filesize) { fileInfo.setSize(filesize); } public long getSizeMax() { return sizeMax; } public MethodBinding getProgressListener() { return progressListener; } public void setProgressListener(MethodBinding binding) { progressListener = binding; } public int getProgress(){ return progress; } public void setProgress(int i){ progress = i; fileInfo.setPercent(i); if( getProgressListener() != null ) getProgressListener().invoke(FacesContext.getCurrentInstance(), new Object[] {new EventObject(this)}); } public String getCssFile() { return null; } private String getDisabled() { return null; } private String getStyleClassString() { return null; } private String getStyleString() { return null; } private String getStyleInfo() { return null; } private String getInputTextClassString() { return null; } private String getButtonClassString() { return null; } private String getTitleAsString(){ return null; } }