CRM/Utils/Network.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2018
  31  */
  32
  33 /**
  34  * Simple static helpers for network operations
  35  */
  36 class CRM_Utils_Network {
  37   /**
  38    * Try connecting to a TCP service; if it fails, retry. Repeat until serverStartupTimeOut elapses.
  39    *
  40    * @param $host
  41    * @param $port
  42    * @param int $serverStartupTimeOut
  43    *   Seconds.
  44    * @param float $interval
  45    *   Seconds to wait in between pollings.
  46    *
  47    * @return bool
  48    *   TRUE if service is online
  49    */
  50   public static function waitForServiceStartup($host, $port, $serverStartupTimeOut, $interval = 0.333) {
  51     $start = time();
  52     $end = $start + $serverStartupTimeOut;
  53     $found = FALSE;
  54     $interval_usec = (int) 1000000 * $interval;
  55
  56     while (!$found && $end >= time()) {
  57       $found = self::checkService($host, $port, $end - time());
  58       if ($found) {
  59         return TRUE;
  60       }
  61       usleep($interval_usec);
  62     }
  63     return FALSE;
  64   }
  65
  66   /**
  67    * Check whether a TCP service is available on $host and $port.
  68    *
  69    * @param string $host
  70    * @param string $port
  71    * @param string $serverConnectionTimeOut
  72    *
  73    * @return bool
  74    */
  75   public static function checkService($host, $port, $serverConnectionTimeOut) {
  76     $old_error_reporting = error_reporting();
  77     error_reporting($old_error_reporting & ~E_WARNING);
  78     try {
  79       $fh = fsockopen($host, $port, $errno, $errstr, $serverConnectionTimeOut);
  80       if ($fh) {
  81         fclose($fh);
  82         error_reporting($old_error_reporting);
  83         return TRUE;
  84       }
  85     }
  86     catch (Exception $e) {
  87     }
  88     error_reporting($old_error_reporting);
  89     return FALSE;
  90   }
  91
  92 }