View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.setup;
35  
36  import info.magnolia.module.InstallContext;
37  import info.magnolia.module.delta.AbstractCondition;
38  
39  import java.io.File;
40  import java.io.IOException;
41  
42  /**
43   * A {@link info.magnolia.module.delta.Condition} which checks the system temporary folder (as per the java.io.tmpdir property) exists and is writable.
44   * It can happen that users accidentally delete the temp folder, which can cause all sorts of trouble. (JackRabbit uses it while importing files, for example)
45   */
46  public class SystemTmpDirCondition extends AbstractCondition {
47      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(SystemTmpDirCondition.class);
48  
49      public SystemTmpDirCondition() {
50          super("System temporary folder check", "Ensures the system temporary folder exists and is usable by the current process.");
51      }
52  
53      @Override
54      public boolean check(InstallContext installContext) {
55          try {
56              final File f = File.createTempFile("magnolia.core.check", "tmp");
57              log.debug("Temp file was successfully created as {}, we can delete it and proceed.", f.getAbsolutePath());
58              f.delete();
59              return true;
60          } catch (IOException e) {
61              final String tmpDirProperty = System.getProperty("java.io.tmpdir");
62              log.error("The system could not create a temporary file: {}. Please check if {} exists and is writable by the current process. {}", e.getMessage(), tmpDirProperty, e);
63              installContext.error("The system could not create a temporary file: " + e.getMessage() + ". Please check if " + tmpDirProperty + " exists and is writable by the current process.", e);
64              return false;
65          }
66  
67      }
68  }