1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Sparql;
use MediaWiki\Http\HttpRequestFactory;
use Wikimedia\AtEase\AtEase;
/**
* Simple SPARQL client
*
* @author Stas Malyshev
*/
class SparqlClient {
/**
* Limit on how long can be the query to be sent by GET.
*/
public const MAX_GET_SIZE = 2048;
/**
* User agent for HTTP requests.
*/
private string $userAgent;
/**
* Query timeout (seconds)
*/
private int $timeout = 30;
/**
* SPARQL endpoint URL
*/
private string $endpoint;
/**
* Client options
*/
private array $options = [];
private HttpRequestFactory $requestFactory;
/**
* @param string $url SPARQL Endpoint
* @param HttpRequestFactory $requestFactory
*/
public function __construct( string $url, HttpRequestFactory $requestFactory ) {
$this->endpoint = $url;
$this->requestFactory = $requestFactory;
$this->userAgent = $requestFactory->getUserAgent() . " SparqlClient";
}
/**
* Set query timeout (in seconds)
* @param int $timeout
* @return $this
*/
public function setTimeout( int $timeout ): SparqlClient {
if ( $timeout >= 0 ) {
$this->timeout = $timeout;
}
return $this;
}
/**
* @param array $options
* @return $this
*/
public function setClientOptions( array $options ): SparqlClient {
$this->options = $options;
return $this;
}
/**
* Get current user agent.
* @return string
*/
public function getUserAgent(): string {
return $this->userAgent;
}
/**
* Mote it is not recommended to completely override user agent for
* most applications.
* @see appendUserAgent() for recommended way of specifying user agent.
*
* @param string $agent
*/
public function setUserAgent( string $agent ) {
$this->userAgent = $agent;
}
/**
* Append specific string to user agent.
*
* This is the recommended way of specifying the user agent
* for specific applications of the SparqlClient inside MediaWiki
* and extension code.
*
* @param string $agent
*/
public function appendUserAgent( string $agent ) {
$this->userAgent .= ' ' . $agent;
}
/**
* Query SPARQL endpoint
*
* @param string $sparql query
* @param bool $rawData Whether to return only values or full data objects
*
* @return array[] List of results, one row per array element
* Each row will contain fields indexed by variable name.
* @throws SparqlException
*/
public function query( string $sparql, bool $rawData = false ): array {
if ( !$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 );
}
/**
* Extract data from SPARQL response format.
* The response must be in format described in:
* https://www.w3.org/TR/sparql11-results-json/
*
* @param array $data SPARQL result
* @param bool $rawData Whether to return only values or full data objects
*
* @return array[] List of results, one row per element.
*/
private function extractData( array $data, bool $rawData = false ): array {
$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;
}
}
|