CRM/Utils/Check/Component.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2019
  33  */
  34 abstract class CRM_Utils_Check_Component {
  35
  36   /**
  37    * Should these checks be run?
  38    *
  39    * @return bool
  40    */
  41   public function isEnabled() {
  42     return TRUE;
  43   }
  44
  45   /**
  46    * Run all checks in this class.
  47    *
  48    * @return array
  49    *   [CRM_Utils_Check_Message]
  50    */
  51   public function checkAll() {
  52     $messages = [];
  53     foreach (get_class_methods($this) as $method) {
  54       if ($method !== 'checkAll' && strpos($method, 'check') === 0) {
  55         $messages = array_merge($messages, $this->$method());
  56       }
  57     }
  58     return $messages;
  59   }
  60
  61   /**
  62    * Check if file exists on given URL.
  63    *
  64    * @param string $url
  65    * @param float|bool $timeoutOverride
  66    *
  67    * @return bool
  68    */
  69   public function fileExists($url, $timeoutOverride = FALSE) {
  70     // Timeout past in maybe 0 in which case we should still permit it (0 is infinite).
  71     if (!$timeoutOverride && $timeoutOverride !== 0) {
  72       $timeoutOverride = (float) Civi::settings()->get('http_timeout');
  73     }
  74     $fileExists = FALSE;
  75     try {
  76       $guzzleClient = new GuzzleHttp\Client();
  77       $guzzleResponse = $guzzleClient->request('GET', $url, array(
  78         'timeout' => $timeoutOverride,
  79       ));
  80       $fileExists = ($guzzleResponse->getStatusCode() == 200);
  81     }
  82     catch (Exception $e) {
  83       // At this stage we are not checking for variants of not being able to receive it.
  84       // However, we might later enhance this to distinguish forbidden from a 500 error.
  85     }
  86     return $fileExists;
  87   }
  88
  89 }