Civi/Core/InstallationCanary.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 namespace Civi\Core;
  29
  30 use Civi\Core\Event\SystemInstallEvent;
  31
  32 /**
  33  * Class InstallationCanary
  34  * @package Civi\Core
  35  */
  36 class InstallationCanary {
  37
  38   /**
  39    * Check whether the install has run before.
  40    *
  41    * Circa v4.7.betaX, we introduced a new mechanism for tracking installation
  42    * and firing a post-install event. However, it's fairly difficult to test the
  43    * edge-cases directly, so this canary should fire if there are any problems
  44    * in the design/implementation of the installation-tracker.
  45    *
  46    * This should not exist. It should be removed in a future version.
  47    *
  48    * @param \Civi\Core\Event\SystemInstallEvent $event
  49    * @throws \CRM_Core_Exception
  50    */
  51   public static function check(SystemInstallEvent $event) {
  52     if (\CRM_Core_DAO::checkTableExists('civicrm_install_canary')) {
  53       throw new \CRM_Core_Exception("Found installation canary. This suggests that something went wrong with tracking installation process. Please post to forum or JIRA.");
  54     }
  55     \Civi::log()->info('Creating canary table');
  56     \CRM_Core_DAO::executeQuery('CREATE TABLE civicrm_install_canary (id int(10) unsigned NOT NULL) ENGINE=InnoDB');
  57   }
  58
  59 }