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, 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.pdftools;
029
030import org.opencms.cache.CmsVfsNameBasedDiskCache;
031import org.opencms.file.CmsResource;
032import org.opencms.file.wrapper.CmsWrappedResource;
033import org.opencms.main.OpenCms;
034
035/**
036 * Cache class for storing generated PDFs in the RFS.<p>
037 *
038 * This class stores all cached files in a single folder.
039 */
040public class CmsPdfCache extends CmsVfsNameBasedDiskCache {
041
042    /** The folder name for the cache folder. */
043    public static final String PDF_CACHE_FOLDER = "pdfcache";
044
045    /**
046     * Creates a new cache instance.<p>
047     */
048    public CmsPdfCache() {
049
050        super(OpenCms.getSystemInfo().getWebInfRfsPath(), PDF_CACHE_FOLDER);
051    }
052
053    /**
054     * @see org.opencms.cache.CmsVfsNameBasedDiskCache#getCacheName(org.opencms.file.CmsResource, java.lang.String)
055     */
056    @Override
057    public String getCacheName(CmsResource resource, String parameters) {
058
059        // we want a 'flat' folder structure, so we create a fake resource with a path in which the slashes
060        // from the original path have been transformed to underscores
061        CmsWrappedResource wrapper = new CmsWrappedResource(resource);
062        String fakePath = "/" + resource.getRootPath().replaceAll("/", "_");
063        // the extension doesn't really matter for the caching, but with an extension of PDF it's easier to look at the files in the cache folder with
064        // file managers, so we replace the extension
065        fakePath = fakePath.replaceFirst("\\.(?:html|xml)$", ".pdf");
066        wrapper.setRootPath(fakePath);
067        CmsResource fakeResource = wrapper.getResource();
068        return super.getCacheName(fakeResource, parameters);
069    }
070
071}