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

Support versioned RPC queries

Browse source 
This adds a backwards compatibility mode for the old RPC API. The old
format can be requested by explicitly adding "v=1" to the list of GET
parameters. Note that due to internal changes, the old format only
returns the first license that belongs to a package.

Signed-off-by: Lukas Fleischer <archlinux@cryptocrack.de>
This commit is contained in:
Lukas Fleischer 2014-04-28 16:28:56 +02:00
parent 11a565936e
commit 3447dfcbff
1 changed files with 45 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -11,10 +11,19 @@ include_once("aur.inc.php");
*/ */
class AurJSON { class AurJSON {
private $dbh = false; private $dbh = false;
private $version = 2;
private static $exposed_methods = array( private static $exposed_methods = array(
'search', 'info', 'multiinfo', 'msearch', 'suggest' 'search', 'info', 'multiinfo', 'msearch', 'suggest'
); );
private static $fields = array( private static $fields_v1 = array(
'Packages.ID', 'Packages.Name',
'PackageBases.Name AS PackageBase', 'Version', 'CategoryID',
'Description', 'URL', 'NumVotes', 'OutOfDateTS AS OutOfDate',
'Users.UserName AS Maintainer',
'SubmittedTS AS FirstSubmitted', 'ModifiedTS AS LastModified',
'Licenses.Name AS License'
);
private static $fields_v2 = array(
'Packages.ID', 'Packages.Name', 'Packages.ID', 'Packages.Name',
'PackageBases.Name AS PackageBase', 'Version', 'CategoryID', 'PackageBases.Name AS PackageBase', 'Version', 'CategoryID',
'Description', 'URL', 'NumVotes', 'OutOfDateTS AS OutOfDate', 'Description', 'URL', 'NumVotes', 'OutOfDateTS AS OutOfDate',
@ -47,6 +56,13 @@ class AurJSON {
header('Cache-Control: public, must-revalidate, max-age=0'); header('Cache-Control: public, must-revalidate, max-age=0');
header('Content-Type: application/json, charset=utf-8'); header('Content-Type: application/json, charset=utf-8');
if (isset($http_data['v'])) {
$this->version = intval($http_data['v']);
}
if ($this->version < 1 || $this->version > 2) {
return $this->json_error('Invalid version specified.');
}
if (!isset($http_data['type']) || !isset($http_data['arg'])) { if (!isset($http_data['type']) || !isset($http_data['arg'])) {
return $this->json_error('No request type/data specified.'); return $this->json_error('No request type/data specified.');
} }
@ -104,7 +120,7 @@ class AurJSON {
*/ */
private function json_results($type, $count, $data) { private function json_results($type, $count, $data) {
return json_encode(array( return json_encode(array(
'version' => 2, 'version' => $this->version,
'type' => $type, 'type' => $type,
'resultcount' => $count, 'resultcount' => $count,
'results' => $data 'results' => $data
@ -162,12 +178,31 @@ class AurJSON {
private function process_query($type, $where_condition) { private function process_query($type, $where_condition) {
global $MAX_RPC_RESULTS; global $MAX_RPC_RESULTS;
$fields = implode(',', self::$fields);
if ($this->version == 1) {
$fields = implode(',', self::$fields_v1);
$query = "SELECT {$fields} " . $query = "SELECT {$fields} " .
"FROM Packages LEFT JOIN PackageBases " . "FROM Packages LEFT JOIN PackageBases " .
"ON PackageBases.ID = Packages.PackageBaseID " . "ON PackageBases.ID = Packages.PackageBaseID " .
"LEFT JOIN Users ON PackageBases.MaintainerUID = Users.ID " . "LEFT JOIN Users " .
"WHERE ${where_condition}"; "ON PackageBases.MaintainerUID = Users.ID " .
"LEFT JOIN PackageLicenses " .
"ON PackageLicenses.PackageID = Packages.ID " .
"LEFT JOIN Licenses " .
"ON Licenses.ID = PackageLicenses.LicenseID " .
"WHERE ${where_condition} " .
"GROUP BY Packages.ID " .
"LIMIT $MAX_RPC_RESULTS";
} elseif ($this->version == 2) {
$fields = implode(',', self::$fields_v2);
$query = "SELECT {$fields} " .
"FROM Packages LEFT JOIN PackageBases " .
"ON PackageBases.ID = Packages.PackageBaseID " .
"LEFT JOIN Users " .
"ON PackageBases.MaintainerUID = Users.ID " .
"WHERE ${where_condition} " .
"LIMIT $MAX_RPC_RESULTS";
}
$result = $this->dbh->query($query); $result = $this->dbh->query($query);
if ($result) { if ($result) {
@ -188,7 +223,7 @@ class AurJSON {
$row[$field] = intval($row[$field]); $row[$field] = intval($row[$field]);
} }
if ($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']));
} }
@ -259,7 +294,6 @@ class AurJSON {
$where_condition = "(Packages.Name LIKE $keyword_string OR "; $where_condition = "(Packages.Name LIKE $keyword_string OR ";
$where_condition .= "Description LIKE $keyword_string)"; $where_condition .= "Description LIKE $keyword_string)";
$where_condition .= "LIMIT $MAX_RPC_RESULTS";
return $this->process_query('search', $where_condition); return $this->process_query('search', $where_condition);
} }
@ -289,8 +323,6 @@ class AurJSON {
* @return mixed Returns an array of results containing the package data * @return mixed Returns an array of results containing the package data
*/ */
private function multiinfo($pqdata) { private function multiinfo($pqdata) {
global $MAX_RPC_RESULTS;
$args = $this->parse_multiinfo_args($pqdata); $args = $this->parse_multiinfo_args($pqdata);
$ids = $args['ids']; $ids = $args['ids'];
$names = $args['names']; $names = $args['names'];
@ -315,7 +347,6 @@ class AurJSON {
$names_value = implode(',', $args['names']); $names_value = implode(',', $args['names']);
$where_condition .= "Packages.Name IN ($names_value) "; $where_condition .= "Packages.Name IN ($names_value) ";
} }
$where_condition .= "LIMIT $MAX_RPC_RESULTS";
return $this->process_query('multiinfo', $where_condition); return $this->process_query('multiinfo', $where_condition);
} }
@ -328,12 +359,9 @@ class AurJSON {
* @return mixed Returns an array of value data containing the package data * @return mixed Returns an array of value data containing the package data
*/ */
private function msearch($maintainer) { private function msearch($maintainer) {
global $MAX_RPC_RESULTS;
$maintainer = $this->dbh->quote($maintainer); $maintainer = $this->dbh->quote($maintainer);
$where_condition = "Users.Username = $maintainer "; $where_condition = "Users.Username = $maintainer ";
$where_condition .= "LIMIT $MAX_RPC_RESULTS";
return $this->process_query('msearch', $where_condition); return $this->process_query('msearch', $where_condition);
} }