info.magnolia.voting.voters.ExtensionVoter.java Source code

Introduction

Here is the source code for info.magnolia.voting.voters.ExtensionVoter.java

Source

/**
 * This file Copyright (c) 2003-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.voting.voters;

import info.magnolia.cms.beans.config.MIMEMapping;
import info.magnolia.context.MgnlContext;

import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;

/**
 * Parameters (as Magnolia's configuration nodes):
 * <ul>
 * <li>allow: comma separated lists of allowed extensions.
 * <li>deny: comma separated lists of denied extensions.
 * </ul>
 *
 * Returns:
 * <ul>
 * <li><code>false</code> if the extension <strong>is not</strong> a valid mimetype (as configured in config:/server/MIMEMapping.
 * <li><code>false</code> if the allow list exists, but the extension <strong>is not</strong> in the allow list.
 * <li><code>false</code> if the deny list exists and the extension <strong>is</strong> in the deny list.
 * <li><code>true</code> in all other cases.
 *</ul>
 * @author fgiust
 * @version $Revision$ ($Author$)
 */
public class ExtensionVoter extends AbstractBoolVoter {

    private String[] allow;

    private String[] deny;

    public void setAllow(String allow) {
        this.allow = StringUtils.split(allow, ',');
    }

    public void setDeny(String deny) {
        this.deny = StringUtils.split(deny, ',');
    }

    @Override
    protected boolean boolVote(Object value) {
        String extension;
        if (value instanceof String) {
            extension = StringUtils.substringAfterLast((String) value, ".");
        } else {
            extension = MgnlContext.getAggregationState().getExtension();
        }

        if (StringUtils.isEmpty(MIMEMapping.getMIMEType(extension))) {
            return false; // check for MIMEMapping, extension must exist
        }

        if (allow != null && allow.length > 0 && !ArrayUtils.contains(allow, extension)) {
            return false;
        }

        if (deny != null && deny.length > 0 && ArrayUtils.contains(deny, extension)) {
            return false;
        }

        return true;
    }

}