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.setup.comptest;
029
030import org.opencms.main.CmsSystemInfo;
031import org.opencms.setup.CmsSetupBean;
032
033import java.io.File;
034
035/**
036 * Tests if the OpenCms WAR file is unpacked.<p>
037 *
038 * @since 6.1.8
039 */
040public class CmsSetupTestWarFileUnpacked implements I_CmsSetupTest {
041
042    /** The test name. */
043    public static final String TEST_NAME = "Unpacked WAR File";
044
045    /**
046     * @see org.opencms.setup.comptest.I_CmsSetupTest#getName()
047     */
048    public String getName() {
049
050        return TEST_NAME;
051    }
052
053    /**
054     * @see org.opencms.setup.comptest.I_CmsSetupTest#execute(org.opencms.setup.CmsSetupBean)
055     */
056    public CmsSetupTestResult execute(CmsSetupBean setupBean) {
057
058        CmsSetupTestResult testResult = new CmsSetupTestResult(this);
059
060        String basePath = setupBean.getWebAppRfsPath();
061        if (!basePath.endsWith(File.separator)) {
062            basePath += File.separator;
063        }
064        File file = new File(basePath + CmsSystemInfo.FOLDER_WEBINF + CmsSystemInfo.FILE_TLD);
065        if (file.exists() && file.canRead() && file.canWrite()) {
066            testResult.setGreen();
067            testResult.setResult(RESULT_PASSED);
068        } else {
069            testResult.setRed();
070            testResult.setInfo(
071                "OpenCms cannot be installed unless the OpenCms WAR file is unpacked! "
072                    + "Please check the settings of your servlet container or unpack the WAR file manually.");
073            testResult.setHelp("WAR file NOT unpacked");
074            testResult.setResult(RESULT_FAILED);
075        }
076        return testResult;
077    }
078}