DatasetCreate.php

Go to the documentation of this file.

<?php


class DatasetCreate extends WebService
{
  private $db;

  private $conneg;

  private $dtdURL;

  private $requester_ip = "";

  private $datasetUri = "";

  private $datasetTitle = "";

  private $description = "";

  private $creator = "";

  public static $supportedSerializations =
    array ("application/json", "application/rdf+xml", "application/rdf+n3", "application/*", "text/xml", "text/*",
      "*/*");
      
  private $globalPermissions = "False;False;False;False";      

  private $webservices = "all";      

  private $errorMessenger =
    '{
                        "ws": "/ws/dataset/create/",
                        "_200": {
                          "id": "WS-DATASET-CREATE-200",
                          "level": "Warning",
                          "name": "No unique identifier specified for this dataset",
                          "description": "No URI defined for this new dataset"
                        },
                        "_201": {
                          "id": "WS-DATASET-CREATE-201",
                          "level": "Fatal",
                          "name": "Can\'t check if the dataset is already existing",
                          "description": "An error occured when we tried to check if the dataset was already existing in the system"
                        },
                        "_202": {
                          "id": "WS-DATASET-CREATE-202",
                          "level": "Warning",
                          "name": "Dataset already existing",
                          "description": "This dataset is already existing in this web services framework"
                        },
                        "_300": {
                          "id": "WS-DATASET-CREATE-300",
                          "level": "Fatal",
                          "name": "Can\'t create the dataset",
                          "description": "An error occured when we tried to register the new dataset to the web service framework"
                        }  
                      }';


  function __construct($uri, $datasetTitle, $description, $creator, $registered_ip, $requester_ip, 
                       $webservices = "all", $globalPermissions = "False;False;False;False")
  {
    parent::__construct();

    $this->db = new DB_Virtuoso($this->db_username, $this->db_password, $this->db_dsn, $this->db_host);

    $this->datasetUri = $uri;
    $this->datasetTitle = $datasetTitle;
    $this->description = $description;
    $this->creator = $creator;
    $this->requester_ip = $requester_ip;
    $this->globalPermissions = $globalPermissions;
    $this->webservices = $webservices;

    if($registered_ip == "")
    {
      $this->registered_ip = $requester_ip;
    }
    else
    {
      $this->registered_ip = $registered_ip;
    }

    if(strtolower(substr($this->registered_ip, 0, 4)) == "self")
    {
      $pos = strpos($this->registered_ip, "::");

      if($pos !== FALSE)
      {
        $account = substr($this->registered_ip, $pos + 2, strlen($this->registered_ip) - ($pos + 2));

        $this->registered_ip = $requester_ip . "::" . $account;
      }
      else
      {
        $this->registered_ip = $requester_ip;
      }
    }    
    
    $this->uri = $this->wsf_base_url . "/wsf/ws/dataset/create/";
    $this->title = "Dataset Create Web Service";
    $this->crud_usage = new CrudUsage(TRUE, FALSE, FALSE, FALSE);
    $this->endpoint = $this->wsf_base_url . "/ws/dataset/create/";

    $this->dtdURL = "dataset/datasetCreate.dtd";

    $this->errorMessenger = json_decode($this->errorMessenger);
  }

  function __destruct()
  {
    parent::__destruct();

    if(isset($this->db))
    {
      @$this->db->close();
    }
  }

  protected function validateQuery()
  {
    // Only users that have "Create" access to the "http://.../wsf/datasets/" graph can create new dataset
    // in the structWSF instance.
    $ws_av = new AuthValidator($this->requester_ip, $this->wsf_graph . "datasets/", $this->uri);

    $ws_av->pipeline_conneg($this->conneg->getAccept(), $this->conneg->getAcceptCharset(),
      $this->conneg->getAcceptEncoding(), $this->conneg->getAcceptLanguage());

    $ws_av->process();

    if($ws_av->pipeline_getResponseHeaderStatus() != 200)
    {
      $this->conneg->setStatus($ws_av->pipeline_getResponseHeaderStatus());
      $this->conneg->setStatusMsg($ws_av->pipeline_getResponseHeaderStatusMsg());
      $this->conneg->setStatusMsgExt($ws_av->pipeline_getResponseHeaderStatusMsgExt());
      $this->conneg->setError($ws_av->pipeline_getError()->id, $ws_av->pipeline_getError()->webservice,
        $ws_av->pipeline_getError()->name, $ws_av->pipeline_getError()->description,
        $ws_av->pipeline_getError()->debugInfo, $ws_av->pipeline_getError()->level);

      return;
    }
    
    // If the system send a query on the behalf of another user, we validate that other user as well
    if($this->registered_ip != $this->requester_ip)
    {
      $ws_av = new AuthValidator($this->registered_ip, $this->wsf_graph . "datasets/", $this->uri);

      $ws_av->pipeline_conneg($this->conneg->getAccept(), $this->conneg->getAcceptCharset(),
        $this->conneg->getAcceptEncoding(), $this->conneg->getAcceptLanguage());

      $ws_av->process();

      if($ws_av->pipeline_getResponseHeaderStatus() != 200)
      {
        $this->conneg->setStatus($ws_av->pipeline_getResponseHeaderStatus());
        $this->conneg->setStatusMsg($ws_av->pipeline_getResponseHeaderStatusMsg());
        $this->conneg->setStatusMsgExt($ws_av->pipeline_getResponseHeaderStatusMsgExt());
        $this->conneg->setError($ws_av->pipeline_getError()->id, $ws_av->pipeline_getError()->webservice,
          $ws_av->pipeline_getError()->name, $ws_av->pipeline_getError()->description,
          $ws_av->pipeline_getError()->debugInfo, $ws_av->pipeline_getError()->level);

        return;
      }
    }    
  }

  public function pipeline_getError() { return ($this->conneg->error); }


  public function pipeline_getResultset() { return ""; }

  public function injectDoctype($xmlDoc) { return ""; }

  public function ws_conneg($accept, $accept_charset, $accept_encoding, $accept_language)
  {
    $this->conneg =
      new Conneg($accept, $accept_charset, $accept_encoding, $accept_language, DatasetCreate::$supportedSerializations);

    // Validate query
    $this->validateQuery();

    // If the query is still valid
    if($this->conneg->getStatus() == 200)
    {
      // Check for errors
      if($this->datasetUri == "")
      {
        $this->conneg->setStatus(400);
        $this->conneg->setStatusMsg("Bad Request");
        $this->conneg->setStatusMsgExt($this->errorMessenger->_200->name);
        $this->conneg->setError($this->errorMessenger->_200->id, $this->errorMessenger->ws,
          $this->errorMessenger->_200->name, $this->errorMessenger->_200->description, "",
          $this->errorMessenger->_200->level);

        return;
      }

      // Check if the dataset is already existing
      $query .= "  select ?dataset 
                from <" . $this->wsf_graph . "datasets/>
                where
                {
                  <" . $this->datasetUri . "> a ?dataset .
                }";

      $resultset = @$this->db->query($this->db->build_sparql_query(str_replace(array ("\n", "\r", "\t"), " ", $query),
        array( "dataset" ), FALSE));

      if(odbc_error())
      {
        $this->conneg->setStatus(500);
        $this->conneg->setStatusMsg("Internal Error");
        $this->conneg->setStatusMsgExt($this->errorMessenger->_201->name);
        $this->conneg->setError($this->errorMessenger->_201->id, $this->errorMessenger->ws,
          $this->errorMessenger->_201->name, $this->errorMessenger->_201->description, odbc_errormsg(),
          $this->errorMessenger->_201->level);

        return;
      }
      elseif(odbc_fetch_row($resultset) !== FALSE)
      {
        $this->conneg->setStatus(400);
        $this->conneg->setStatusMsg("Bad Request");
        $this->conneg->setStatusMsgExt($this->errorMessenger->_202->name);
        $this->conneg->setError($this->errorMessenger->_202->id, $this->errorMessenger->ws,
          $this->errorMessenger->_202->name, $this->errorMessenger->_202->description, "",
          $this->errorMessenger->_202->level);

        unset($resultset);
        return;
      }

      unset($resultset);
    }
  }

  public function pipeline_conneg($accept, $accept_charset, $accept_encoding, $accept_language)
    { $this->ws_conneg($accept, $accept_charset, $accept_encoding, $accept_language); }

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

  public function pipeline_getResponseHeaderStatusMsg() { return $this->conneg->getStatusMsg(); }

  public function pipeline_getResponseHeaderStatusMsgExt() { return $this->conneg->getStatusMsgExt(); }

  public function pipeline_serialize() { return ""; }

  public function pipeline_serialize_reification() { return ""; }

  public function ws_serialize() { return ""; }

  public function ws_respond($content)
  {
    // First send the header of the request
    $this->conneg->respond();

    // second, send the content of the request

    // Make sure there is no error.
    if($this->conneg->getStatus() == 200)
    {
      echo $content;
    }

    $this->__destruct();
  }


  public function process()
  {
    // Make sure there was no conneg error prior to this process call
    if($this->conneg->getStatus() == 200)
    {
      $query = "insert into <" . $this->wsf_graph . "datasets/>
              {
                <" . $this->datasetUri . "> a <http://rdfs.org/ns/void#Dataset> ;
                " . ($this->datasetTitle != "" ? "<http://purl.org/dc/terms/title> \"\"\"" . str_replace("'", "\'", $this->datasetTitle) . "\"\"\" ; " : "") . "
                " . ($this->description != "" ? "<http://purl.org/dc/terms/description> \"\"\"" . str_replace("'", "\'", $this->description) . "\"\"\" ; " : "") . "
                " . ($this->creator != "" ? "<http://purl.org/dc/terms/creator> <$this->creator> ; " : "") . "
                <http://purl.org/dc/terms/created> \"" . date("Y-m-j") . "\" .
              }";

      @$this->db->query($this->db->build_sparql_query(str_replace(array ("\n", "\r", "\t"), " ", $query), array(),
        FALSE));

      if(odbc_error())
      {
        $this->conneg->setStatus(500);
        $this->conneg->setStatusMsg("Internal Error");
        $this->conneg->setStatusMsgExt($this->errorMessenger->_300->name);
        $this->conneg->setError($this->errorMessenger->_300->id, $this->errorMessenger->ws,
          $this->errorMessenger->_300->name, $this->errorMessenger->_300->description, odbc_errormsg(),
          $this->errorMessenger->_300->level);

        return;
      }

      /* 
        If the dataset has been created, the next step is to create the permissions for this user (full crud)
        and for the public one (no crud).
      */

      /* Get the list of web services registered to this structWSF instance. */
      if(strtolower($this->webservices) == "all")
      {      
        $ws_al = new AuthLister("ws", $this->datasetUri, $this->requester_ip, $this->wsf_local_ip);

        $ws_al->pipeline_conneg($this->conneg->getAccept(), $this->conneg->getAcceptCharset(),
          $this->conneg->getAcceptEncoding(), $this->conneg->getAcceptLanguage());

        $ws_al->process();

        if($ws_al->pipeline_getResponseHeaderStatus() != 200)
        {
          $this->conneg->setStatus($ws_al->pipeline_getResponseHeaderStatus());
          $this->conneg->setStatusMsg($ws_al->pipeline_getResponseHeaderStatusMsg());
          $this->conneg->setStatusMsgExt($ws_al->pipeline_getResponseHeaderStatusMsgExt());
          $this->conneg->setError($ws_al->pipeline_getError()->id, $ws_al->pipeline_getError()->webservice,
            $ws_al->pipeline_getError()->name, $ws_al->pipeline_getError()->description,
            $ws_al->pipeline_getError()->debugInfo, $ws_al->pipeline_getError()->level);

          return;
        }

        /* Get all web services */

        $webservices = "";

        $xml = new ProcessorXML();
        $xml->loadXML($ws_al->pipeline_getResultset());

        $webServiceElements = $xml->getXPath('//predicate/object[attribute::type="wsf:WebService"]');

        foreach($webServiceElements as $element)
        {
          $webservices .= $xml->getURI($element) . ";";
        }

        $webservices = substr($webservices, 0, strlen($webservices) - 1);
        unset($xml);
        unset($ws_al);         
        
        $this->webservices = $webservices;
      }



      /* Register full CRUD for the creator of the dataset, for the dataset's ID */

      $ws_ara = new AuthRegistrarAccess("True;True;True;True", $this->webservices, $this->datasetUri, "create", "",
        $this->requester_ip, $this->wsf_local_ip);

      $ws_ara->pipeline_conneg($this->conneg->getAccept(), $this->conneg->getAcceptCharset(),
        $this->conneg->getAcceptEncoding(), $this->conneg->getAcceptLanguage());

      $ws_ara->process();

      if($ws_ara->pipeline_getResponseHeaderStatus() != 200)
      {
        $this->conneg->setStatus($ws_ara->pipeline_getResponseHeaderStatus());
        $this->conneg->setStatusMsg($ws_ara->pipeline_getResponseHeaderStatusMsg());
        $this->conneg->setStatusMsgExt($ws_ara->pipeline_getResponseHeaderStatusMsgExt());
        $this->conneg->setError($ws_ara->pipeline_getError()->id, $ws_ara->pipeline_getError()->webservice,
          $ws_ara->pipeline_getError()->name, $ws_ara->pipeline_getError()->description,
          $ws_ara->pipeline_getError()->debugInfo, $ws_ara->pipeline_getError()->level);

        return;
      }

      unset($ws_ara);

      /* Register no CRUD for the public user, for the dataset's ID */

      $ws_ara =
        new AuthRegistrarAccess($this->globalPermissions, $this->webservices, $this->datasetUri, "create", "", "0.0.0.0",
          $this->wsf_local_ip);

      $ws_ara->pipeline_conneg($this->conneg->getAccept(), $this->conneg->getAcceptCharset(),
        $this->conneg->getAcceptEncoding(), $this->conneg->getAcceptLanguage());

      $ws_ara->process();

      if($ws_ara->pipeline_getResponseHeaderStatus() != 200)
      {
        $this->conneg->setStatus($ws_ara->pipeline_getResponseHeaderStatus());
        $this->conneg->setStatusMsg($ws_ara->pipeline_getResponseHeaderStatusMsg());
        $this->conneg->setStatusMsgExt($ws_ara->pipeline_getResponseHeaderStatusMsgExt());
        $this->conneg->setError($ws_ara->pipeline_getError()->id, $ws_ara->pipeline_getError()->webservice,
          $ws_ara->pipeline_getError()->name, $ws_ara->pipeline_getError()->description,
          $ws_ara->pipeline_getError()->debugInfo, $ws_ara->pipeline_getError()->level);

        return;
      }

      unset($ws_ara);
    }
  }
}


?>