WebServiceQuerier.php

Go to the documentation of this file.

<?php

  // $Id$


class WebServiceQuerier
{
  private $url;

  private $method;

  private $parameters;

  private $mime;

  private $queryStatus = ""; // The HTTP query status code returned by the server (ex: 200)

  private $queryStatusMessage = ""; // The HTTP query status message returned by the server (ex: OK)

  private $queryStatusMessageDescription =
    ""; // The HTTP query status message description returned by the server (ex: No subject concept)

  private $queryResultset = "";

  private $errorId = "";

  private $errorName = "";

  private $errorDescription = "";

  private $errorDebugInfo = "";

  public $error;

  function __construct($url, $method, $mime, $parameters, $timeout = 0)
  {
    $this->url = $url;
    $this->method = $method;
    $this->parameters = $parameters;
    $this->mime = $mime;
    $this->timeout = $timeout;

    $this->queryWebService();
  }

  function __destruct(){}

  function queryWebService()
  {
    $ch = curl_init();

    switch ($this->method)
    {
      case "get":
        curl_setopt($ch, CURLOPT_URL, $this->url . "?" . $this->parameters);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: $this->mime"));
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        
        if ($this->timeout > 0)
        {
          curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
        }
        curl_setopt($ch, CURLOPT_HEADER, TRUE);
      break;

      case "post":
        // Check if the size of the converted file is bigger than the maximum file size
        // we can upload via Curl.
        $uploadMaxFileSize = ini_get("post_max_size");
        $uploadMaxFileSize = str_replace("M", "000000", $uploadMaxFileSize);
        
        if($uploadMaxFileSize > strlen($this->parameters))
        {
          curl_setopt($ch, CURLOPT_URL, $this->url);
          curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: $this->mime"));
          curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
          curl_setopt($ch, CURLOPT_POST, 1);
          curl_setopt($ch, CURLOPT_POSTFIELDS, $this->parameters);
          
          if ($this->timeout > 0)
          {
            curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
          }
          curl_setopt($ch, CURLOPT_HEADER, TRUE);
        }
        else
        {
          $this->error = new QuerierError("WSF-600", "Fatal", $ws, "Query too big", 
                                   "The query sent to the structWSF endpoint is too big given
                                    the current settings of the instance. The size of the
                                    query is ".number_format(strlen($this->parameters), 0, " ", " ")." bytes, 
                                    and the autorized size of the query is ".$uploadMaxFileSize." bytes", $data);
          
          return(FALSE);
        }
      break;

      default:
        return FALSE;
      break;
    }

    $xml_data = curl_exec($ch);

    if ($xml_data === FALSE)
    {
      $data =
      substr($xml_data, strpos($xml_data, "\r\n\r\n") + 4, strlen($xml_data) - (strpos($xml_data, "\r\n\r\n") - 4));      
      
      // Can't reach the remote server
      $this->queryStatus = "503";
      $this->queryStatusMessage = "Service Unavailable";
      $this->queryStatusMessageDescription = "Can't reach remote server (" . curl_error($ch) . ")";
      $this->queryResultset = $data;

      $this->error = new QuerierError("HTTP-500", "Warning", $this->url, "Can't reach remote server",
        "Can't reach remote server (" . curl_error($ch) . ")", $data);

      return;
    }

    // Remove any possible "HTTP/1.1 100 Continue" message from the web server
    $xml_data = str_replace("HTTP/1.1 100 Continue\r\n\r\n", "", $xml_data);

    $header = substr($xml_data, 0, strpos($xml_data, "\r\n\r\n"));

    $data =
      substr($xml_data, strpos($xml_data, "\r\n\r\n") + 4, strlen($xml_data) - (strpos($xml_data, "\r\n\r\n") - 4));

    curl_close($ch);

    // check returned message
    $this->queryStatus = substr($header, 9, 3);
    $this->queryStatusMessage = substr($header, 13, strpos($header, "\r\n") - 13);

    // Make sure that we don't have a PHP Parsing error in the resultset. If it is the case, we have to return an error
    if (stripos($data, "<b>Parse error</b>") !== false)
    {
      $this->queryStatus = "500";
      $this->queryStatusMessage = "Internal Server Error";
      $this->queryStatusMessageDescription = "Parsing Error";
      $this->queryResultset = $data;

      preg_match("/\/ws\/(.*)\/.*\.php/Uim", $data, $ws);

      $ws = $ws[0];
      $ws = substr($ws, 0, strrpos($ws, "/") + 1);

      $this->error = new QuerierError("HTTP-500", "Fatal", $ws, "Parsing Error", "PHP Parsing Error", $data);

      return;
    }

    // Make sure that we don't have any rogue PHP uncatched fatal error in the resultset. If it is the case, 
    // we have to return an error
    if (stripos($data, "<b>Fatal error</b>") !== false)
    {
      $this->queryStatus = "500";
      $this->queryStatusMessage = "Internal Server Error";
      $this->queryStatusMessageDescription = "Fatal Error";
      $this->queryResultset = $data;

      preg_match("/\/ws\/(.*)\/.*\.php/Uim", $data, $ws);

      $ws = $ws[0];
      $ws = substr($ws, 0, strrpos($ws, "/") + 1);

      $this->error = new QuerierError("HTTP-500", "Fatal", $ws, "Fatal Error", "PHP uncatched Fatal Error", $data);
    }

    // We have to continue. Let fix this to 200 OK so that this never raise errors within the WSF
    if ($this->queryStatus == "100")
    {
      $this->queryStatus = "200";
      $this->queryStatusMessage = "OK";
      $this->queryStatusMessageDescription = "";
      $this->queryResultset = $data;
      return;
    }

    if ($this->queryStatus != "200")
    {
      $this->queryStatusMessageDescription = str_replace(array(
        "\r",
        "\n"
      ), "", $data);

      // XML error messages
      if (strpos($this->queryStatusMessageDescription, "<error>"))
      {
        preg_match("/.*<id>(.*)<\/id>.*/Uim", $this->queryStatusMessageDescription, $errorId);
        $errorId = $errorId[1];

        preg_match("/.*<level>(.*)<\/level>.*/Uim", $this->queryStatusMessageDescription, $errorLevel);
        $errorLevel = $errorLevel[1];

        preg_match("/.*<webservice>(.*)<\/webservice>.*/Uim", $this->queryStatusMessageDescription, $errorWS);
        $errorWS = $errorWS[1];

        preg_match("/.*<name>(.*)<\/name>.*/Uim", $this->queryStatusMessageDescription, $errorName);
        $errorName = $errorName[1];

        preg_match("/.*<description>(.*)<\/description>.*/Uim", $this->queryStatusMessageDescription,
          $errorDescription);
        $errorDescription = $errorDescription[1];

        preg_match("/.*<debugInformation>(.*)<\/debugInformation>.*/Uim", $this->queryStatusMessageDescription,
          $errorDebugInfo);
        $errorDebugInfo = $errorDebugInfo[1];

        $this->error = new QuerierError($errorId, $errorLevel, $errorWS, $errorName, $errorDescription, $errorDebugInfo);

        return;
      }

    // JSON error messages
    }
    else
    {
      $this->queryResultset = $data;
    }

    return;
  }

  public function getStatus()
  {
    return $this->queryStatus;
  }

  public function getStatusMessage()
  {
    return $this->queryStatusMessage;
  }

  public function getStatusMessageDescription()
  {
    return $this->queryStatusMessageDescription;
  }

  public function getResultset()
  {
    return $this->queryResultset;
  }
}



class QuerierError
{
  public $id = 0;

  public $level = 0;

  public $webservice = "";

  public $name = "";

  public $description = "";

  public $debugInfo = "";

  function __construct($id, $level, $webservice, $name, $description, $debugInfo)
  {
    $this->id = $id;
    $this->level = strtolower($level);
    $this->webservice = $webservice;
    $this->name = $name;
    $this->description = $description;
    $this->debugInfo = $debugInfo;
  }
  

  function __destruct(){}
}

?>