WebService.php

Go to the documentation of this file.

<?php

abstract class WebService
{
  public static $data_ini = "/data/";

  public static $network_ini = "/usr/share/structwsf/";

  protected $db_username = "";

  protected $db_password = "";

  protected $db_dsn = "";

  protected $db_host = "localhost";

  protected $dtdBaseURL = "";

  protected $wsf_graph = "";

  protected $wsf_base_url = "";

  protected $wsf_base_path = "";

  protected $wsf_local_ip = "";

  protected $wsf_solr_core = "";

  protected $ontologies_files_folder = "";

  protected $solr_host = "localhost";

  protected $ontological_structure_folder = "";
  
  protected $track_create = FALSE;

  protected $track_update = FALSE;

  protected $track_delete = FALSE;

  protected $tracking_endpoint = "";

  protected $triplestore_port = "8890";

  protected $solr_port = "8983";

  
  protected $log_table = "SD.WSF.ws_queries_log";

  protected $solr_auto_commit = FALSE;
  
  protected $fields_index_folder = "/tmp/";

  protected $uri;

  protected $title;

  protected $crud_usage;

  protected $endpoint;
  
  protected $owlapiNbSessions;
  
  protected $owlapiBridgeURI;
  
  protected $geoEnabled = FALSE;

  function __construct()
  {
    // Load INI settings
    $data_ini = parse_ini_file(self::$data_ini . "data.ini", TRUE);
    $network_ini = parse_ini_file(self::$network_ini . "network.ini", TRUE);
    
    // Check if we can read the files
    if($data_ini === FALSE || $network_ini === FALSE)
    {
      // Get the web service reference
      $webservice = substr($_SERVER["SCRIPT_NAME"], 0, strrpos($_SERVER["SCRIPT_NAME"], "/") + 1);
      
      // Get the query MIME
      $mimes = array();

      $header = $_SERVER['HTTP_ACCEPT'];

      if(strlen($header) > 0)
      {
        // break up string into pieces (languages and q factors)
        preg_match_all('/([^,]+)/', $header, $accepts);

        foreach($accepts[0] as $accept)
        {
          $foo = explode(";", str_replace(" ", "", $accept));

          if(isset($foo[1]))
          {
            if(stripos($foo[1], "q=") !== FALSE)
            {
              $foo[1] = str_replace("q=", "", $foo[1]);
            }
            else
            {
              $foo[1] = "1";
            }
          }
          else
          {
            array_push($foo, "1");
          }

          $mimes[$foo[0]] = $foo[1];
        }

        // In the case that there is a Accept: header, but that it is empty. We set it to: anything.
        if(count($mimes) <= 0)
        {
          $mimes["*/*"] = 1;
        }

        arsort($mimes, SORT_NUMERIC);
      }

      $errorMime = "";

      foreach($mimes as $mime => $q)
      {
        $mime = strtolower($mime);

        switch($mime)
        {
          case "application/rdf+xml":
          case "text/xml":
          case "application/sparql-results+xml":
          case "application/xhtml+rdfa":
          case "text/html":
            $errorMime = "text/xml";
          break;

          case "application/sparql-results+json":
          case "application/iron+json":
          case "application/json":
          case "application/bib+json":
            $errorMime = "application/json";
          break;
        }

        if($errorMime != "")
        {
          break;
        }
      }
      
      // Create the error object
      include_once("Error.php"); 
      
      $error = new Error("HTTP-500", $webservice, "Error", 
                         "Can't read the data.ini and/or the network.ini configuration files on the server.",
                         "", $errorMime, "Fatal");

      // Return the error according to the requested mime.
      header("HTTP/1.1 500 Internal Server Error");
      header("Content-Type: $errorMime");

      echo $error->getError();

      die;      
    }
    
    if(isset($data_ini["triplestore"]["username"]))
    {
      $this->db_username = $data_ini["triplestore"]["username"];
    }
    
    if(isset($data_ini["triplestore"]["password"]))
    {
      $this->db_password = $data_ini["triplestore"]["password"];
    }
    if(isset($data_ini["triplestore"]["dsn"]))
    {
      $this->db_dsn = $data_ini["triplestore"]["dsn"];
    }
    if(isset($data_ini["triplestore"]["host"]))
    {
      $this->db_host = $data_ini["triplestore"]["host"];
    }
    if(isset($data_ini["triplestore"]["log_table"]))
    {
      $this->log_table = $data_ini["triplestore"]["log_table"];
    }
    
    if(isset($data_ini["datasets"]["dtd_base"]))
    {
      $this->dtdBaseUrl = $data_ini["datasets"]["dtd_base"];
    }
    if(isset($data_ini["datasets"]["wsf_graph"]))
    {
      $this->wsf_graph = $data_ini["datasets"]["wsf_graph"];
    }
    
    if(isset($network_ini["network"]["wsf_base_url"]))
    {
      $this->wsf_base_url = $network_ini["network"]["wsf_base_url"];
    }
    if(isset($network_ini["network"]["wsf_base_path"]))
    {
      $this->wsf_base_path = $network_ini["network"]["wsf_base_path"];
    }
    if(isset($network_ini["network"]["wsf_local_ip"]))
    {
      $this->wsf_local_ip = $network_ini["network"]["wsf_local_ip"];
    }

    
    if(isset($network_ini["tracking"]["track_create"]))
    {
      if(strtolower($network_ini["tracking"]["track_create"]) == "true" || $network_ini["tracking"]["track_create"] == "1")
      {
        $this->track_create = TRUE;
      }
    }
    if(isset($network_ini["tracking"]["track_update"]))
    {
      if(strtolower($network_ini["tracking"]["track_update"]) == "true" || $network_ini["tracking"]["track_update"] == "1")
      {
        $this->track_update = TRUE;
      }
    }
    if(isset($network_ini["tracking"]["track_delete"]))
    {
      if(strtolower($network_ini["tracking"]["track_delete"]) == "true" || $network_ini["tracking"]["track_delete"] == "1")
      {
        $this->track_delete = TRUE;
      }
    }
    if(isset($network_ini["tracking"]["tracking_endpoint"]))
    {
      $this->tracking_endpoint = $network_ini["tracking"]["tracking_endpoint"];
    } 
    
    
    if(isset($network_ini["owlapi"]["nb_sessions"]))
    {
      $this->owlapiNbSessions = $network_ini["owlapi"]["nb_sessions"];
    } 
    if(isset($network_ini["owlapi"]["bridge_uri"]))
    {
      $this->owlapiBridgeURI = $network_ini["owlapi"]["bridge_uri"];
    } 

    if(isset($network_ini["geo"]["geoenabled"]))
    {
      if(strtolower($network_ini["geo"]["geoenabled"]) == "true" || $network_ini["geo"]["geoenabled"] == "1")
      {
        $this->geoEnabled = TRUE;
      }      
    }   
    
    
    if(isset($data_ini["solr"]["wsf_solr_core"]))
    {
      $this->wsf_solr_core = $data_ini["solr"]["wsf_solr_core"];
    }
    
    if(isset($data_ini["solr"]["host"]))
    {
      $this->solr_host = $data_ini["solr"]["host"];
    }

    if(isset($data_ini["ontologies"]["ontologies_files_folder"]))
    {
      $this->ontologies_files_folder = $data_ini["ontologies"]["ontologies_files_folder"];
    }
    if(isset($data_ini["ontologies"]["ontological_structure_folder"]))
    {
      $this->ontological_structure_folder = $data_ini["ontologies"]["ontological_structure_folder"];
    }
    if(isset($data_ini["triplestore"]["port"]))
    {
      $this->triplestore_port = $data_ini["triplestore"]["port"];
    }
    if(isset($data_ini["solr"]["port"]))
    {
      $this->solr_port = $data_ini["solr"]["port"];
    }
    if(isset($data_ini["solr"]["fields_index_folder"]))
    {
      $this->fields_index_folder = $data_ini["solr"]["fields_index_folder"];
    }
    if(strtolower($data_ini["solr"]["solr_auto_commit"]) == "true" || $data_ini["solr"]["solr_auto_commit"] == "1")
    {
      $this->solr_auto_commit = TRUE;
    }

    // This handler is defined for the fatal script errors. If a script can't be finished because a fatal error
    // occured, then the handleFatalPhpError function is used to return the error message to the requester.
    register_shutdown_function("handleFatalPhpError");
  }

  function __destruct() { }


  abstract public function ws_conneg($accept, $accept_charset, $accept_encoding, $accept_language);

  abstract public function ws_serialize();

  abstract public function ws_respond($content);

  abstract public function process();


  abstract public function pipeline_conneg($accept, $accept_charset, $accept_encoding, $accept_language);

  abstract public function pipeline_getResponseHeaderStatus();

  abstract public function pipeline_getError();


  abstract public function pipeline_getResponseHeaderStatusMsg();

  abstract public function pipeline_getResponseHeaderStatusMsgExt();


  abstract public function pipeline_getResultset();

  abstract public function pipeline_serialize();

  abstract public function pipeline_serialize_reification();

  abstract public function injectDoctype($xmlDoc);

  abstract protected function validateQuery();

  public function xmlEncode($string)
  { 
    // Replace all the possible entities by their character. That way, we won't "double encode" 
    // these entities. Otherwise, we can endup with things such as "&amp;amp;" which some
    // XML parsers doesn't seem to like (and throws errors).
    $string = str_replace(array ("%5C", "&amp;", "&lt;", "&gt;"), array ("\\", "&", "<", ">"), $string);
    
    return str_replace(array ("\\", "&", "<", ">"), array ("%5C", "&amp;", "&lt;", "&gt;"), $string); 
  }

  public function jsonEncode($string) { return str_replace(array ('\\', '"', "\n", "\r"), array ('\\\\', '\\"', "\\n", "\\r"), $string); }
}

class CrudUsage
{
  public $create;

  public $read;

  public $update;

  public $delete;

  function __construct($create, $read, $update, $delete)
  {
    $this->create = $create;
    $this->read = $read;
    $this->update = $update;
    $this->delete = $delete;
  }
}

function handleFatalPhpError()
{
  include_once("Error.php");

  $last_error = error_get_last();

  if($last_error['type'] === E_ERROR || $last_error['type'] === E_CORE_ERROR || $last_error['type'] === E_COMPILE_ERROR
    || $last_error['type'] === E_RECOVERABLE_ERROR || $last_error['type'] === E_USER_ERROR)
  {
    // Check accept parameter
    $mimes = array();

    $header = $_SERVER['HTTP_ACCEPT'];

    if(strlen($header) > 0)
    {
      // break up string into pieces (languages and q factors)
      preg_match_all('/([^,]+)/', $header, $accepts);

      foreach($accepts[0] as $accept)
      {
        $foo = explode(";", str_replace(" ", "", $accept));

        if(isset($foo[1]))
        {
          if(stripos($foo[1], "q=") !== FALSE)
          {
            $foo[1] = str_replace("q=", "", $foo[1]);
          }
          else
          {
            $foo[1] = "1";
          }
        }
        else
        {
          array_push($foo, "1");
        }

        $mimes[$foo[0]] = $foo[1];
      }

      // In the case that there is a Accept: header, but that it is empty. We set it to: anything.
      if(count($mimes) <= 0)
      {
        $mimes["*/*"] = 1;
      }

      arsort($mimes, SORT_NUMERIC);
    }

    $errorMime = "";

    foreach($mimes as $mime => $q)
    {
      $mime = strtolower($mime);

      switch($mime)
      {
        case "application/rdf+xml":
        case "text/xml":
        case "application/sparql-results+xml":
        case "application/xhtml+rdfa":
        case "text/html":
          $errorMime = "text/xml";
        break;

        case "application/sparql-results+json":
        case "application/iron+json":
        case "application/json":
        case "application/bib+json":
          $errorMime = "application/json";
        break;
      }

      if($errorMime != "")
      {
        break;
      }
    }

    // Check what web service returned the error
    $webservice = substr($_SERVER["SCRIPT_NAME"], 0, strrpos($_SERVER["SCRIPT_NAME"], "/") + 1);

    $errorName = "";

    switch($last_error['type'])
    {
      case E_ERROR;
        $errorName = "Error";
      break;

      case E_CORE_ERROR;
        $errorName = "Core Error";
      break;

      case E_COMPILE_ERROR;
        $errorName = "Compile Error";
      break;

      case E_RECOVERABLE_ERROR;
        $errorName = "Recoverable Error";
      break;

      case E_USER_ERROR;
        $errorName = "User Error";
      break;
    }

    // Create the error object
    $error = new Error("HTTP-500", $webservice, $errorName, $last_error['message'],
      "[file]: " . $last_error['file'] . "[line]:" . $last_error['line'], $errorMime, "Fatal");

    // Return the error according to the requested mime.
    header("HTTP/1.1 500 Internal Server Error");
    header("Content-Type: $errorMime");

    echo $error->getError();

    die;
  }
}


?>