001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.staticexport;
029
030import org.opencms.util.CmsStringUtil;
031
032import java.util.ArrayList;
033import java.util.List;
034import java.util.regex.Pattern;
035
036/**
037 * This class provides a file name matcher to find out those resources which must be part of
038 * a static export.<p>
039 *
040 * @since 6.0.0
041 */
042public class CmsExportFolderMatcher {
043
044    /** Internal array containing the vfs folders that should be exported. */
045    private List<Pattern> m_vfsFolders;
046
047    /**
048     * Creates a new CmsExportFolderMatcher.<p>
049     *
050     * @param vfsFolders array of vfsFolder used for static export
051     * @param checkResource additional resource name to be added to the static export
052     */
053    public CmsExportFolderMatcher(List<String> vfsFolders, String checkResource) {
054
055        m_vfsFolders = new ArrayList<Pattern>();
056        for (String patternAsString : vfsFolders) {
057            m_vfsFolders.add(Pattern.compile(patternAsString));
058        }
059        m_vfsFolders.add(Pattern.compile(CmsStringUtil.escapePattern(checkResource)));
060    }
061
062    /**
063     * Checks if a vfsName matches the given static export folders.<p>
064     *
065     * @param vfsName the vfs name of a resource to check
066     * @return true if the name matches one of the given static export folders
067     */
068    public boolean match(String vfsName) {
069
070        boolean match = false;
071
072        for (int j = 0; j < m_vfsFolders.size(); j++) {
073            Pattern pattern = m_vfsFolders.get(j);
074            match = pattern.matcher(vfsName).matches();
075            if (match) {
076                break;
077            }
078        }
079        return match;
080    }
081}