modules/api.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2014 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 class ApiModule extends PlModule
  23 {
  24     function handlers()
  25     {
  26         return array(
  27             // TODO(vzanotti): Extend the plat/al engine to support placeholders
  28             // in handler urls, for instance "api/1/user/%forlife/isRegistered".
  29             'api/1/user'   => $this->make_api_hook('user',   AUTH_COOKIE, 'api_user_readonly'),
  30             'api/1/search' => $this->make_api_hook('search', AUTH_COOKIE, 'user'),
  31         );
  32     }
  33
  34     // This handler supports the following URL patterns:
  35     //   /api/1/user/{forlife}/isRegistered
  36     function handler_user(PlPage $page, PlUser $authUser, $payload, $user = null, $selector = null)
  37     {
  38         // Retrieve the PlUser referenced in the request. Note that this is the
  39         // target user, not the authenticated user.
  40         $user = PlUser::getSilent($user);
  41         if (empty($user)) {
  42             return PL_NOT_FOUND;
  43         }
  44
  45         if ($selector == 'isRegistered') {
  46             $page->jsonAssign('isRegistered', $user->isActive());
  47             return PL_JSON;
  48         } else {
  49             return PL_NOT_FOUND;
  50         }
  51     }
  52
  53     function handler_search(PlPage $page, PlUser $authUser, $payload, $mode = 'quick')
  54     {
  55         if (!isset($payload['quick'])) {
  56             $page->trigError('Malformed search query');
  57             return PL_BAD_REQUEST;
  58         }
  59
  60         $query = trim($payload['quick']);
  61         if (@$payload['allow_special']) {
  62             if (starts_with($query, 'admin:')) {
  63                 $page->jsonAssign('link_type', 'admin');
  64                 $query = substr($query, 6);
  65             } else if (starts_with($query, 'adm:')) {
  66                 $page->jsonAssign('link_type', 'admin');
  67                 $query = substr($query, 4);
  68             } else if (starts_with('admin', $query) || strpos($query, ':') !== false) {
  69                 $page->jsonAssign('profile_count', -1);
  70                 $page->jsonAssign('profiles', array());
  71                 return PL_JSON;
  72             } else {
  73                 $page->jsonAssign('link_type', 'profile');
  74             }
  75         }
  76         if (strlen($query) < 3) {
  77             $page->jsonAssign('profile_count', -1);
  78             $page->jsonAssign('profiles', array());
  79             return PL_JSON;
  80         }
  81
  82         Env::set('quick', $query);
  83         foreach (array('with_soundex', 'exact') as $key) {
  84             if (isset($payload[$key])) {
  85                 Env::set($key, $payload[$key]);
  86             }
  87         }
  88
  89         require_once 'userset.inc.php';
  90         $view = new QuickSearchSet();
  91         $view->addMod('json', 'JSon', true, $payload);
  92         $view->apply('api/1/search', $page, 'json');
  93         return PL_JSON;
  94     }
  95 }
  96
  97 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
  98 ?>