SparqlClient.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Sparql;
 
use MediaWiki\Http\HttpRequestFactory;
use Wikimedia\AtEase\AtEase;
 
class SparqlClient {
 
    public const MAX_GET_SIZE = 2048;
 
    private $userAgent;
 
    private $timeout = 30;
 
    private $endpoint;
 
    private $options = [];
 
    private $requestFactory;
 
    public function __construct( $url, HttpRequestFactory $requestFactory ) {
        $this->endpoint = $url;
        $this->requestFactory = $requestFactory;
        $this->userAgent = $requestFactory->getUserAgent() . " SparqlClient";
    }
 
    public function setTimeout( $timeout ) {
        if ( $timeout >= 0 ) {
            $this->timeout = $timeout;
        }
        return $this;
    }
 
    public function setClientOptions( $options ) {
        $this->options = $options;
        return $this;
    }
 
    public function getUserAgent() {
        return $this->userAgent;
    }
 
    public function setUserAgent( $agent ) {
        $this->userAgent = $agent;
    }
 
    public function appendUserAgent( $agent ) {
        $this->userAgent .= ' ' . $agent;
    }
 
    public function query( $sparql, $rawData = false ) {
        if ( empty( $this->endpoint ) ) {
            throw new SparqlException( 'Endpoint URL can not be empty' );
        }
        $queryData = [ "query" => $sparql, "format" => "json" ];
        $options = array_merge( [ 'method' => 'GET' ], $this->options );
 
        if ( empty( $options['userAgent'] ) ) {
            $options['userAgent'] = $this->userAgent;
        }
 
        if ( $this->timeout >= 0 ) {
            // Blazegraph setting, see https://wiki.blazegraph.com/wiki/index.php/REST_API
            $queryData['maxQueryTimeMillis'] = $this->timeout * 1000;
            $options['timeout'] = $this->timeout;
        }
 
        if ( strlen( $sparql ) > self::MAX_GET_SIZE ) {
            // big requests go to POST
            $options['method'] = 'POST';
            $options['postData'] = 'query=' . urlencode( $sparql );
            unset( $queryData['query'] );
        }
 
        $url = wfAppendQuery( $this->endpoint, $queryData );
        $request = $this->requestFactory->create( $url, $options, __METHOD__ );
 
        $status = $request->execute();
 
        if ( !$status->isOK() ) {
            throw new SparqlException( 'HTTP error: ' . $status->getWikiText( false, false, 'en' ) );
        }
        $result = $request->getContent();
        AtEase::suppressWarnings();
        $data = json_decode( $result, true );
        AtEase::restoreWarnings();
        if ( $data === null || $data === false ) {
            throw new SparqlException( "HTTP request failed, response:\n" .
                substr( $result, 1024 ) );
        }
 
        return $this->extractData( $data, $rawData );
    }
 
    private function extractData( $data, $rawData = false ) {
        $result = [];
        if ( $data && !empty( $data['results'] ) ) {
            $vars = $data['head']['vars'];
            $resrow = [];
            foreach ( $data['results']['bindings'] as $row ) {
                foreach ( $vars as $var ) {
                    if ( !isset( $row[$var] ) ) {
                        $resrow[$var] = null;
                        continue;
                    }
                    if ( $rawData ) {
                        $resrow[$var] = $row[$var];
                    } else {
                        $resrow[$var] = $row[$var]['value'];
                    }
                }
                $result[] = $resrow;
            }
        }
        return $result;
    }
 
}