rpc: introduce multiinfo query (fixes FS#17583)

The majority of "real world" info requests [1] come in hefty batches. We
would be better served to handle these in one request rather than
multiple by allowing AUR clients to send multiple arguments.

This enables things like this to work:
    http://aur.test/rpc.php?type=multiinfo&arg[]=cups-xerox&arg[]=cups-mc2430dl&arg[]=10673

Note to RPC users: unfortunately due to the asinine design of PHP, you
unfortunately have to use the 'arg[]' syntax if you want more than one
query argument, or you will only get the package satisfying the last arg
you pass.

[1] Rough data from April 11, 2011, with a total hit count of 1,109,163:
     12 /login.php
     13 /rpc.php?type=sarch
     15 /rpc.php?type=msearch
     16 /pingserver.php
     16 /rpc.php
     22 /logout.php
    163 /passreset.php
    335 /account.php
    530 /pkgsubmit.php
    916 /rss2.php
   3838 /index.php
   6752 /rss.php
   9699 /
  42478 /rpc.php?type=search
 184737 /packages.php
 681725 /rpc.php?type=info

That means a whopping 61.5% of our requests were for info over the RPC
interface; package pages are a distant second at only 16.7%.

Lukas: Introduce "multiinfo" query instead of extending "info" (for the
sake of backward compatibility).

Signed-off-by: Dan McGee <dan@archlinux.org>
Signed-off-by: Lukas Fleischer <archlinux@cryptocrack.de>

1 files changed, 66 insertions, 1 deletions

diff --git a/web/lib/aurjson.class.php b/web/lib/aurjson.class.php
index 25219485..bb7344ab 100644
--- a/web/lib/aurjson.class.php
+++ b/web/lib/aurjson.class.php
@@ -14,7 +14,9 @@ include_once("aur.inc");
  **/
 class AurJSON {
     private $dbh = false;
-    private static $exposed_methods = array('search', 'info', 'msearch');
+    private static $exposed_methods = array(
+        'search', 'info', 'multiinfo', 'msearch'
+    );
     private static $fields = array(
         'Packages.ID', 'Name', 'Version', 'CategoryID',
         'Description', 'URL', 'License',
@@ -108,6 +110,36 @@ class AurJSON {
     }
 
     /**
+     * Parse the args to the multiinfo function. We may have a string or an 
+     * array, so do the appropriate thing. Within the elements, both * package 
+     * IDs and package names are valid; sort them into the relevant arrays and
+     * escape/quote the names.
+     * @param $args the arg string or array to parse.
+     * @return mixed An array containing 'ids' and 'names'.
+     **/
+    private function parse_multiinfo_args($args) {
+        if (!is_array($args)) {
+            $args = array($args);
+        }
+
+        $id_args = array();
+        $name_args = array();
+        foreach ($args as $arg) {
+            if (!$arg) {
+                continue;
+            }
+            if (is_numeric($arg)) {
+                $id_args[] = intval($arg);
+            } else {
+                $escaped = mysql_real_escape_string($arg, $this->dbh);
+                $name_args[] = "'" . $escaped . "'";
+            }
+        }
+
+        return array('ids' => $id_args, 'names' => $name_args);
+    }
+
+    /**
      * Performs a fulltext mysql search of the package database.
      * @param $keyword_string A string of keywords to search with.
      * @return mixed Returns an array of package matches.
@@ -156,6 +188,39 @@ class AurJSON {
     }
 
     /**
+     * Returns the info on multiple packages.
+     * @param $pqdata A comma-separated list of IDs or names of the packages.
+     * @return mixed Returns an array of results containing the package data
+     **/
+    private function multiinfo($pqdata) {
+        $fields = implode(',', self::$fields);
+        $args = $this->parse_multiinfo_args($pqdata);
+        $ids = $args['ids'];
+        $names = $args['names'];
+
+        if (!$ids && !$names) {
+            return $this->json_error('Invalid query arguments');
+        }
+
+        $query = "SELECT {$fields} " .
+            " FROM Packages WHERE ";
+        if ($ids) {
+            $ids_value = implode(',', $args['ids']);
+            $query .= "ID IN ({$ids_value})";
+        }
+        if ($ids && $names) {
+            $query .= " OR ";
+        }
+        if ($names) {
+            // individual names were quoted in parse_multiinfo_args()
+            $names_value = implode(',', $args['names']);
+            $query .= "Name IN ({$names_value})";
+        }
+
+        return $this->process_query('multiinfo', $query);
+    }
+
+    /**
      * Returns all the packages for a specific maintainer.
      * @param $maintainer The name of the maintainer.
      * @return mixed Returns an array of value data containing the package data