external/aurweb
0
0
Fork 0
mirror of https://gitlab.archlinux.org/archlinux/aurweb.git synced 2025-02-03 10:43:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make results consistent in RPC replies

Browse source 
Add RPC v3 which always returns a list of objects in RPC responses,
regardless of the request type. An empty list is returned when an error
occurs. The error message is moved to a separate "error" field.

Fixes FS#40963.

Signed-off-by: Lukas Fleischer <archlinux@cryptocrack.de>
This commit is contained in:
Lukas Fleischer 2014-06-25 12:10:15 +02:00
parent 91e6b5cb2f
commit 65129ce9c3
1 changed files with 28 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
web/lib/aurjson.class.php
View file

@ -61,7 +61,7 @@ class AurJSON {
if (isset($http_data['v'])) { if (isset($http_data['v'])) {
$this->version = intval($http_data['v']); $this->version = intval($http_data['v']);
} }
if ($this->version < 1 || $this->version > 2) { if ($this->version < 1 || $this->version > 3) {
return $this->json_error('Invalid version specified.'); return $this->json_error('Invalid version specified.');
} }
@ -109,7 +109,11 @@ class AurJSON {
*/ */
private function json_error($msg) { private function json_error($msg) {
header('content-type: application/json'); header('content-type: application/json');
return $this->json_results('error', 0, $msg); if ($this->version < 3) {
return $this->json_results('error', 0, $msg, NULL);
} elseif ($this->version >= 3) {
return $this->json_results('error', 0, array(), $msg);
}
} }
/* /*
@ -117,16 +121,23 @@ class AurJSON {
* *
* @param $type The response method type. * @param $type The response method type.
* @param $data The result data to return * @param $data The result data to return
* @param $error An error message to include in the response
* *
* @return mixed A json formatted result response. * @return mixed A json formatted result response.
*/ */
private function json_results($type, $count, $data) { private function json_results($type, $count, $data, $error) {
return json_encode(array( $json_array = array(
'version' => $this->version, 'version' => $this->version,
'type' => $type, 'type' => $type,
'resultcount' => $count, 'resultcount' => $count,
'results' => $data 'results' => $data
)); );
if ($error) {
$json_array['error'] = $error;
}
return json_encode($json_array);
} }
private function get_extended_fields($pkgid) { private function get_extended_fields($pkgid) {
@ -195,7 +206,7 @@ class AurJSON {
"WHERE ${where_condition} " . "WHERE ${where_condition} " .
"GROUP BY Packages.ID " . "GROUP BY Packages.ID " .
"LIMIT $MAX_RPC_RESULTS"; "LIMIT $MAX_RPC_RESULTS";
} elseif ($this->version == 2) { } elseif ($this->version >= 2) {
$fields = implode(',', self::$fields_v2); $fields = implode(',', self::$fields_v2);
$query = "SELECT {$fields} " . $query = "SELECT {$fields} " .
"FROM Packages LEFT JOIN PackageBases " . "FROM Packages LEFT JOIN PackageBases " .
@ -225,14 +236,18 @@ class AurJSON {
$row[$field] = intval($row[$field]); $row[$field] = intval($row[$field]);
} }
if ($this->version == 2 && ($type == 'info' || $type == 'multiinfo')) { if ($this->version >= 2 && ($type == 'info' || $type == 'multiinfo')) {
$row = array_merge($row, $this->get_extended_fields($row['ID'])); $row = array_merge($row, $this->get_extended_fields($row['ID']));
} }
if ($type == 'info') { if ($this->version < 3) {
$search_data = $row; if ($type == 'info') {
break; $search_data = $row;
} else { break;
} else {
array_push($search_data, $row);
}
} elseif ($this->version >= 3) {
array_push($search_data, $row); array_push($search_data, $row);
} }
} }
@ -241,9 +256,9 @@ class AurJSON {
return $this->json_error('Too many package results.'); return $this->json_error('Too many package results.');
} }
return $this->json_results($type, $resultcount, $search_data); return $this->json_results($type, $resultcount, $search_data, NULL);
} else { } else {
return $this->json_results($type, 0, array()); return $this->json_results($type, 0, array(), NULL);
} }
} }