org.opencms.staticexport.CmsExportFolderMatcher 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 GmbH & Co. KG, 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.staticexport;

import org.opencms.util.CmsStringUtil;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;

/**
 * This class provides a file name matcher to find out those resources which must be part of
 * a static export.
 *
 * @since 6.0.0
 */
public class CmsExportFolderMatcher {

    /** Internal array containing the vfs folders that should be exported. */
    private List m_vfsFolders;

    /**
     * Creates a new CmsExportFolderMatcher.

     *
     * @param vfsFolders array of vfsFolder used for static export
     * @param checkResource additional resource name to be added to the static export
     */
    public CmsExportFolderMatcher(List vfsFolders, String checkResource) {

        m_vfsFolders = new ArrayList();
        for (String patternAsString : vfsFolders) {
            m_vfsFolders.add(Pattern.compile(patternAsString));
        }
        m_vfsFolders.add(Pattern.compile(CmsStringUtil.escapePattern(checkResource)));
    }

    /**
     * Checks if a vfsName matches the given static export folders.
     *
     * @param vfsName the vfs name of a resource to check
     * @return true if the name matches one of the given static export folders
     */
    public boolean match(String vfsName) {

        boolean match = false;

        for (int j = 0; j < m_vfsFolders.size(); j++) {
            Pattern pattern = m_vfsFolders.get(j);
            match = pattern.matcher(vfsName).matches();
            if (match) {
                break;
            }
        }
        return match;
    }
}