View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.tobago.validator;
21  
22  import org.apache.commons.fileupload.FileItem;
23  import org.apache.myfaces.tobago.internal.component.AbstractUIFile;
24  import org.apache.myfaces.tobago.internal.util.ContentType;
25  import org.apache.myfaces.tobago.util.MessageUtils;
26  
27  import javax.faces.application.FacesMessage;
28  import javax.faces.component.StateHolder;
29  import javax.faces.component.UIComponent;
30  import javax.faces.context.FacesContext;
31  import javax.faces.validator.Validator;
32  import javax.faces.validator.ValidatorException;
33  import java.util.Arrays;
34  
35  /**
36   * <p><strong>FileItemValidator</strong> is a {@link Validator} that checks
37   * the FileItem in the value of the associated component.
38   */
39  @org.apache.myfaces.tobago.apt.annotation.Validator(id = FileItemValidator.VALIDATOR_ID)
40  public class FileItemValidator implements Validator, StateHolder {
41    public static final String VALIDATOR_ID = "org.apache.myfaces.tobago.FileItem";
42    public static final String SIZE_LIMIT_MESSAGE_ID = "org.apache.myfaces.tobago.FileItemValidator.SIZE_LIMIT";
43    public static final String CONTENT_TYPE_MESSAGE_ID = "org.apache.myfaces.tobago.FileItemValidator.CONTENT_TYPE";
44    private Integer maxSize = null;
45    private String[] contentType;
46    private boolean transientValue;
47  
48    /**
49     * No-arg constructor used during restoreState
50     */
51    public FileItemValidator() {
52    }
53  
54    public void validate(final FacesContext facesContext, final UIComponent component, final Object value)
55        throws ValidatorException {
56      if (value != null && component instanceof AbstractUIFile) {
57        final FileItem file = (FileItem) value;
58        if (maxSize != null && file.getSize() > maxSize) {
59          final FacesMessage facesMessage = MessageUtils.getMessage(
60              facesContext, facesContext.getViewRoot().getLocale(), FacesMessage.SEVERITY_ERROR,
61              SIZE_LIMIT_MESSAGE_ID, maxSize, component.getId());
62          throw new ValidatorException(facesMessage);
63        }
64        // Check only a valid file
65        if (file.getSize() > 0 && contentType != null && contentType.length > 0) {
66          boolean found = false;
67          for (final String contentTypeStr : contentType) {
68            if (ContentType.valueOf(contentTypeStr).match(ContentType.valueOf(file.getContentType()))) {
69              found = true;
70              break;
71            }
72          }
73          if (!found) {
74            final String message;
75            if (contentType.length == 1) {
76              message = contentType[0];
77            } else {
78              message = Arrays.toString(contentType);
79            }
80            final FacesMessage facesMessage = MessageUtils.getMessage(
81                facesContext, facesContext.getViewRoot().getLocale(), FacesMessage.SEVERITY_ERROR,
82                CONTENT_TYPE_MESSAGE_ID, message, component.getId());
83            throw new ValidatorException(facesMessage);
84          }
85        }
86      }
87    }
88  
89    public int getMaxSize() {
90      return maxSize;
91    }
92  
93    public void setMaxSize(final int maxSize) {
94      if (maxSize > 0) {
95        this.maxSize = maxSize;
96      }
97    }
98  
99    public String[] getContentType() {
100     return contentType;
101   }
102 
103   public void setContentType(final String[] contentType) {
104     this.contentType = contentType;
105   }
106 
107   public Object saveState(final FacesContext context) {
108     final Object[] values = new Object[2];
109     values[0] = maxSize;
110     values[1] = contentType;
111     return values;
112   }
113 
114   public void restoreState(final FacesContext context, final Object state) {
115     final Object[] values = (Object[]) state;
116     maxSize = (Integer) values[0];
117     contentType = (String[]) values[1];
118   }
119 
120   public boolean isTransient() {
121     return transientValue;
122   }
123 
124   public void setTransient(final boolean newTransientValue) {
125     this.transientValue = newTransientValue;
126   }
127 }