8c0601816f
For reference (raised by rozzin in IRC): * http://foldoc.org/module * http://foldoc.org/library * http://foldoc.org/plugin As noted by XRevan86, modules are not necessarily non-essential. As we will keep the modules directory in GS root [therefore, near to plugins/], it is evidenced the difference between both. This is a simple yet fundamental structural change. It doesn't change functionality but makes clearer the way we understand GNU social's internals.
137 lines
3.6 KiB
PHP
137 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* StatusNet, the distributed open-source microblogging tool
|
|
*
|
|
* Show up to 100 favs of a notice
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* LICENCE: This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @category API
|
|
* @package GNUsocial
|
|
* @author Hannes Mannerheim <h@nnesmannerhe.im>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
|
* @link http://www.gnu.org/software/social/
|
|
*/
|
|
|
|
if (!defined('GNUSOCIAL')) { exit(1); }
|
|
|
|
/**
|
|
* Show up to 100 favs of a notice
|
|
*
|
|
*/
|
|
class ApiStatusesFavsAction extends ApiAuthAction
|
|
{
|
|
const MAXCOUNT = 100;
|
|
|
|
var $original = null; // Notice object for which to retrieve favs
|
|
var $cnt = self::MAXCOUNT;
|
|
|
|
/**
|
|
* Take arguments for running
|
|
*
|
|
* @param array $args $_REQUEST args
|
|
*
|
|
* @return boolean success flag
|
|
*/
|
|
protected function prepare(array $args=array())
|
|
{
|
|
parent::prepare($args);
|
|
|
|
if ($this->format !== 'json') {
|
|
$this->clientError('This method currently only serves JSON.', 415);
|
|
}
|
|
|
|
$id = $this->trimmed('id');
|
|
|
|
$this->original = Notice::getKV('id', $id);
|
|
|
|
if (!($this->original instanceof Notice)) {
|
|
// TRANS: Client error displayed trying to display redents of a non-exiting notice.
|
|
$this->clientError(_('No such notice.'), 400);
|
|
}
|
|
|
|
$cnt = $this->trimmed('count');
|
|
|
|
if (empty($cnt) || !is_integer($cnt)) {
|
|
$cnt = 100;
|
|
} else {
|
|
$this->cnt = min((int)$cnt, self::MAXCOUNT);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Handle the request
|
|
*
|
|
* Get favs and return them as json object
|
|
*
|
|
* @param array $args $_REQUEST data (unused)
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function handle()
|
|
{
|
|
parent::handle();
|
|
|
|
$fave = new Fave();
|
|
$fave->selectAdd();
|
|
$fave->selectAdd('user_id');
|
|
$fave->notice_id = $this->original->id;
|
|
$fave->orderBy('modified');
|
|
if (!is_null($this->cnt)) {
|
|
$fave->limit(0, $this->cnt);
|
|
}
|
|
|
|
$ids = $fave->fetchAll('user_id');
|
|
|
|
// get nickname and profile image
|
|
$ids_with_profile_data = array();
|
|
$i=0;
|
|
foreach($ids as $id) {
|
|
$profile = Profile::getKV('id', $id);
|
|
$ids_with_profile_data[$i]['user_id'] = $id;
|
|
$ids_with_profile_data[$i]['nickname'] = $profile->nickname;
|
|
$ids_with_profile_data[$i]['fullname'] = $profile->fullname;
|
|
$ids_with_profile_data[$i]['profileurl'] = $profile->profileurl;
|
|
$profile = new Profile();
|
|
$profile->id = $id;
|
|
$avatarurl = $profile->avatarUrl(24);
|
|
$ids_with_profile_data[$i]['avatarurl'] = $avatarurl;
|
|
$i++;
|
|
}
|
|
|
|
$this->initDocument('json');
|
|
$this->showJsonObjects($ids_with_profile_data);
|
|
$this->endDocument('json');
|
|
}
|
|
|
|
/**
|
|
* Return true if read only.
|
|
*
|
|
* MAY override
|
|
*
|
|
* @param array $args other arguments
|
|
*
|
|
* @return boolean is read only action?
|
|
*/
|
|
|
|
function isReadOnly($args)
|
|
{
|
|
return true;
|
|
}
|
|
}
|