org.opencms.file.wrapper.CmsResourceWrapperPreventCreateNameCI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.file.wrapper;

import org.opencms.db.Messages;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsProperty;
import org.opencms.file.CmsResource;
import org.opencms.main.CmsException;
import org.opencms.main.CmsIllegalArgumentException;
import org.opencms.security.CmsPermissionViolationException;
import org.opencms.util.CmsStringUtil;

import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * Resource wrapper class which is used to prevent resources with a certain name from being created.
 *
 * This can be used to prevent file browsers accessing the repository from creating thumbnail files.
 * This class does not distinguish between upper case and lower case letters in file names.
 */
public class CmsResourceWrapperPreventCreateNameCI extends A_CmsResourceWrapper {

    /** File name separator. */
    public static final String NAME_SEPARATOR = "|";

    /**
     * The set of illegal file names.
     */
    private Set m_disabledNames = new HashSet();

    /**
     * @see org.opencms.file.wrapper.A_CmsResourceWrapper#configure(java.lang.String)
     */
    @Override
    public void configure(String configString) {

        List tokens = CmsStringUtil.splitAsList(configString, NAME_SEPARATOR);
        for (String token : tokens) {
            m_disabledNames.add(token.trim().toLowerCase());
        }
    }

    /**
     * @see org.opencms.file.wrapper.A_CmsResourceWrapper#createResource(org.opencms.file.CmsObject, java.lang.String, int, byte[], java.util.List)
     */
    @Override
    public CmsResource createResource(
        CmsObject cms,
        String resourcepath,
        int type,
        byte[] content,
        List properties) throws CmsIllegalArgumentException {

        String name = CmsResource.getName(resourcepath);
        if (m_disabledNames.contains(name.toLowerCase())) {
            throw new CmsSilentWrapperException(
                new CmsPermissionViolationException(
                    Messages.get().container(Messages.ERR_PERM_DENIED_2, resourcepath, "+c")));
        } else {
            return null;
        }
    }

    /**
     * @see org.opencms.file.wrapper.I_CmsResourceWrapper#isWrappedResource(org.opencms.file.CmsObject, org.opencms.file.CmsResource)
     */
    public boolean isWrappedResource(CmsObject cms, CmsResource res) {

        return false;
    }

    /**
     * @see org.opencms.file.wrapper.A_CmsResourceWrapper#moveResource(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
     */
    @Override
    public boolean moveResource(CmsObject cms, String source, String destination)
    throws CmsException, CmsIllegalArgumentException {

        String name = CmsResource.getName(destination);

        if (m_disabledNames.contains(name)) {
            throw new CmsPermissionViolationException(
                Messages.get().container(Messages.ERR_PERM_DENIED_2, destination, "+c"));
        } else {
            return false;
        }
    }

}