plugins/Autocomplete/actions/autocomplete.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * List users for autocompletion
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @copyright 2008-2009 StatusNet, Inc.
  26  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * List users for autocompletion
  37  *
  38  * This is the form for adding a new g
  39  *
  40  * @category Plugin
  41  * @package  StatusNet
  42  * @author   Craig Andrews <candrews@integralblue.com>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46 class AutocompleteAction extends Action
  47 {
  48     private $result;
  49
  50     /**
  51      * Last-modified date for page
  52      *
  53      * When was the content of this page last modified? Based on notice,
  54      * profile, avatar.
  55      *
  56      * @return int last-modified date as unix timestamp
  57      */
  58     function lastModified()
  59     {
  60         $max=0;
  61         foreach($this->users as $user){
  62             $max = max($max,strtotime($user->modified),strtotime($user->getProfile()->modified));
  63         }
  64         foreach($this->groups as $group){
  65             $max = max($max,strtotime($group->modified));
  66         }
  67         return $max;
  68     }
  69
  70     /**
  71      * An entity tag for this page
  72      *
  73      * Shows the ETag for the page, based on the notice ID and timestamps
  74      * for the notice, profile, and avatar. It's weak, since we change
  75      * the date text "one hour ago", etc.
  76      *
  77      * @return string etag
  78      */
  79     function etag()
  80     {
  81         return '"' . implode(':', array($this->arg('action'),
  82             common_user_cache_hash(),
  83             crc32($this->arg('q')), //the actual string can have funny characters in we don't want showing up in the etag
  84             $this->arg('limit'),
  85             $this->lastModified())) . '"';
  86     }
  87
  88     function prepare($args)
  89     {
  90         // If we die, show short error messages.
  91         StatusNet::setApi(true);
  92
  93         parent::prepare($args);
  94
  95         $cur = common_current_user();
  96         if (!$cur) {
  97             // TRANS: Client exception in autocomplete plugin.
  98             throw new ClientException(_m('Access forbidden.'), true);
  99         }
 100         $this->groups=array();
 101         $this->users=array();
 102         $q = $this->arg('q');
 103         $limit = $this->arg('limit');
 104         if($limit > 200) $limit=200; //prevent DOS attacks
 105         if(substr($q,0,1)=='@'){
 106             //user search
 107             $q=substr($q,1);
 108             $user = new User();
 109             $user->limit($limit);
 110             $user->whereAdd('nickname like \'' . trim($user->escape($q), '\'') . '%\'');
 111             if($user->find()){
 112                 while($user->fetch()) {
 113                     $this->users[]=clone($user);
 114                 }
 115             }
 116         }
 117         if(substr($q,0,1)=='!'){
 118             //group search
 119             $q=substr($q,1);
 120             $group = new User_group();
 121             $group->limit($limit);
 122             $group->whereAdd('nickname like \'' . trim($group->escape($q), '\'') . '%\'');
 123             if($group->find()){
 124                 while($group->fetch()) {
 125                     $this->groups[]=clone($group);
 126                 }
 127             }
 128         }
 129         return true;
 130     }
 131
 132     function handle($args)
 133     {
 134         parent::handle($args);
 135         $results = array();
 136         foreach($this->users as $user){
 137             $profile = $user->getProfile();
 138             $avatar = $profile->getAvatar(AVATAR_MINI_SIZE);
 139             // sigh.... encapsulate this upstream!
 140             if ($avatar) {
 141                 $avatar = $avatar->displayUrl();
 142             } else {
 143                 $avatar = Avatar::defaultImage(AVATAR_MINI_SIZE);
 144             }
 145             $results[] = array(
 146                 'nickname' => $user->nickname,
 147                 'fullname'=> $profile->fullname,
 148                 'avatar' => $avatar,
 149                 'type' => 'user'
 150             );
 151         }
 152         foreach($this->groups as $group){
 153             // sigh.... encapsulate this upstream!
 154             if ($group->mini_logo) {
 155                 $avatar = $group->mini_logo;
 156             } else {
 157                 $avatar = User_group::defaultLogo(AVATAR_MINI_SIZE);
 158             }
 159             $results[] = array(
 160                 'nickname' => $group->nickname,
 161                 'fullname'=> $group->fullname,
 162                 'avatar' => $avatar,
 163                 'type' => 'group');
 164         }
 165         foreach($results as $result) {
 166             print json_encode($result) . "\n";
 167         }
 168     }
 169
 170     /**
 171      * Is this action read-only?
 172      *
 173      * @param array $args other arguments
 174      *
 175      * @return boolean is read only action?
 176      */
 177     function isReadOnly($args)
 178     {
 179         return true;
 180     }
 181 }