strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #10968 from annando/api2

Browse source 
API: some more converted functions
This commit is contained in:
Hypolite Petovan 2021-11-11 13:54:06 -05:00 committed by GitHub
commit 893b8e5df3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 478 additions and 369 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

283
include/api.php
View file

@ -24,7 +24,6 @@
*/ */
use Friendica\App; use Friendica\App;
use Friendica\Collection\Api\Notifications as ApiNotifications;
use Friendica\Content\ContactSelector; use Friendica\Content\ContactSelector;
use Friendica\Content\Text\BBCode; use Friendica\Content\Text\BBCode;
use Friendica\Content\Text\HTML; use Friendica\Content\Text\HTML;
@ -52,7 +51,6 @@ use Friendica\Network\HTTPException\MethodNotAllowedException;
use Friendica\Network\HTTPException\NotFoundException; use Friendica\Network\HTTPException\NotFoundException;
use Friendica\Network\HTTPException\TooManyRequestsException; use Friendica\Network\HTTPException\TooManyRequestsException;
use Friendica\Network\HTTPException\UnauthorizedException; use Friendica\Network\HTTPException\UnauthorizedException;
use Friendica\Object\Api\Friendica\Notification as ApiNotification;
use Friendica\Object\Image; use Friendica\Object\Image;
use Friendica\Protocol\Activity; use Friendica\Protocol\Activity;
use Friendica\Security\BasicAuth; use Friendica\Security\BasicAuth;
@ -3683,95 +3681,6 @@ api_register_func('api/direct_messages/all', 'api_direct_messages_all', true);
api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true); api_register_func('api/direct_messages/sent', 'api_direct_messages_sentbox', true);
api_register_func('api/direct_messages', 'api_direct_messages_inbox', true); api_register_func('api/direct_messages', 'api_direct_messages_inbox', true);
/**
* delete a complete photoalbum with all containing photos from database through api
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
* @throws BadRequestException
* @throws ForbiddenException
* @throws InternalServerErrorException
*/
function api_fr_photoalbum_delete($type)
{
if (api_user() === false) {
throw new ForbiddenException();
}
// input params
$album = $_REQUEST['album'] ?? '';
// we do not allow calls without album string
if ($album == "") {
throw new BadRequestException("no albumname specified");
}
// check if album is existing
$photos = DBA::selectToArray('photo', ['resource-id'], ['uid' => api_user(), 'album' => $album], ['group_by' => ['resource-id']]);
if (!DBA::isResult($photos)) {
throw new BadRequestException("album not available");
}
$resourceIds = array_column($photos, 'resource-id');
// function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
// to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
$condition = ['uid' => api_user(), 'resource-id' => $resourceIds, 'type' => 'photo'];
Item::deleteForUser($condition, api_user());
// now let's delete all photos from the album
$result = Photo::delete(['uid' => api_user(), 'album' => $album]);
// return success of deletion or error message
if ($result) {
$answer = ['result' => 'deleted', 'message' => 'album `' . $album . '` with all containing photos has been deleted.'];
return BaseApi::formatData("photoalbum_delete", $type, ['$result' => $answer]);
} else {
throw new InternalServerErrorException("unknown error - deleting from database failed");
}
}
/**
* update the name of the album for all photos of an album
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
* @throws BadRequestException
* @throws ForbiddenException
* @throws InternalServerErrorException
*/
function api_fr_photoalbum_update($type)
{
if (api_user() === false) {
throw new ForbiddenException();
}
// input params
$album = $_REQUEST['album'] ?? '';
$album_new = $_REQUEST['album_new'] ?? '';
// we do not allow calls without album string
if ($album == "") {
throw new BadRequestException("no albumname specified");
}
if ($album_new == "") {
throw new BadRequestException("no new albumname specified");
}
// check if album is existing
if (!Photo::exists(['uid' => api_user(), 'album' => $album])) {
throw new BadRequestException("album not available");
}
// now let's update all photos to the albumname
$result = Photo::update(['album' => $album_new], ['uid' => api_user(), 'album' => $album]);
// return success of updating or error message
if ($result) {
$answer = ['result' => 'updated', 'message' => 'album `' . $album . '` with all containing photos has been renamed to `' . $album_new . '`.'];
return BaseApi::formatData("photoalbum_update", $type, ['$result' => $answer]);
} else {
throw new InternalServerErrorException("unknown error - updating in database failed");
}
}
/** /**
* list all photos of the authenticated user * list all photos of the authenticated user
* *
@ -3959,53 +3868,6 @@ function api_fr_photo_create_update($type)
throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen"); throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
} }
/**
* delete a single photo from the database through api
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array
* @throws BadRequestException
* @throws ForbiddenException
* @throws InternalServerErrorException
*/
function api_fr_photo_delete($type)
{
if (api_user() === false) {
throw new ForbiddenException();
}
// input params
$photo_id = $_REQUEST['photo_id'] ?? null;
// do several checks on input parameters
// we do not allow calls without photo id
if ($photo_id == null) {
throw new BadRequestException("no photo_id specified");
}
// check if photo is existing in database
if (!Photo::exists(['resource-id' => $photo_id, 'uid' => api_user()])) {
throw new BadRequestException("photo not available");
}
// now we can perform on the deletion of the photo
$result = Photo::delete(['uid' => api_user(), 'resource-id' => $photo_id]);
// return success of deletion or error message
if ($result) {
// function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
// to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
$condition = ['uid' => api_user(), 'resource-id' => $photo_id, 'type' => 'photo'];
Item::deleteForUser($condition, api_user());
$result = ['result' => 'deleted', 'message' => 'photo with id `' . $photo_id . '` has been deleted from server.'];
return BaseApi::formatData("photo_delete", $type, ['$result' => $result]);
} else {
throw new InternalServerErrorException("unknown error on deleting photo from database table");
}
}
/** /**
* returns the details of a specified photo id, if scale is given, returns the photo data in base 64 * returns the details of a specified photo id, if scale is given, returns the photo data in base 64
* *
@ -4122,12 +3984,9 @@ function api_account_update_profile_image($type)
} }
// place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached // place api-register for photoalbum calls before 'api/friendica/photo', otherwise this function is never reached
api_register_func('api/friendica/photoalbum/delete', 'api_fr_photoalbum_delete', true, API_METHOD_DELETE);
api_register_func('api/friendica/photoalbum/update', 'api_fr_photoalbum_update', true, API_METHOD_POST);
api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true); api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST); api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true, API_METHOD_POST);
api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST); api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', true, API_METHOD_POST);
api_register_func('api/friendica/photo/delete', 'api_fr_photo_delete', true, API_METHOD_DELETE);
api_register_func('api/friendica/photo', 'api_fr_photo_detail', true); api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST); api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true, API_METHOD_POST);
@ -5133,96 +4992,6 @@ function api_lists_update($type)
api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST); api_register_func('api/lists/update', 'api_lists_update', true, API_METHOD_POST);
/**
*
* @param string $type Return type (atom, rss, xml, json)
*
* @return array|string
* @throws BadRequestException
* @throws ForbiddenException
* @throws ImagickException
* @throws InternalServerErrorException
*/
function api_friendica_activity($type)
{
$a = DI::app();
if (api_user() === false) {
throw new ForbiddenException();
}
$verb = strtolower(DI::args()->getArgv()[3]);
$verb = preg_replace("|\..*$|", "", $verb);
$id = $_REQUEST['id'] ?? 0;
$res = Item::performActivity($id, $verb, api_user());
if ($res) {
if ($type == "xml") {
$ok = "true";
} else {
$ok = "ok";
}
return BaseApi::formatData('ok', $type, ['ok' => $ok]);
} else {
throw new BadRequestException('Error adding activity');
}
}
/// @TODO move to top of file or somewhere better
api_register_func('api/friendica/activity/like', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/dislike', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/attendyes', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/attendno', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/attendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/unlike', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/undislike', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/unattendyes', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/unattendno', 'api_friendica_activity', true, API_METHOD_POST);
api_register_func('api/friendica/activity/unattendmaybe', 'api_friendica_activity', true, API_METHOD_POST);
/**
* Returns notifications
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
*
* @return string|array
* @throws ForbiddenException
* @throws BadRequestException
* @throws Exception
*/
function api_friendica_notification($type)
{
if (api_user() === false) {
throw new ForbiddenException();
}
if (DI::args()->getArgc()!==3) {
throw new BadRequestException('Invalid argument count');
}
$Notifies = DI::notify()->selectAllForUser(local_user(), 50);
$notifications = new ApiNotifications();
foreach ($Notifies as $Notify) {
$notifications[] = new ApiNotification($Notify);
}
if ($type == 'xml') {
$xmlnotes = [];
foreach ($notifications as $notification) {
$xmlnotes[] = ['@attributes' => $notification->toArray()];
}
$result = $xmlnotes;
} elseif (count($notifications) > 0) {
$result = $notifications->getArrayCopy();
} else {
$result = false;
}
return BaseApi::formatData('notes', $type, ['note' => $result]);
}
/** /**
* Set notification as seen and returns associated item (if possible) * Set notification as seen and returns associated item (if possible)
* *
@ -5284,58 +5053,6 @@ function api_friendica_notification_seen($type)
/// @TODO move to top of file or somewhere better /// @TODO move to top of file or somewhere better
api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST); api_register_func('api/friendica/notification/seen', 'api_friendica_notification_seen', true, API_METHOD_POST);
api_register_func('api/friendica/notification', 'api_friendica_notification', true, API_METHOD_GET);
/**
* update a direct_message to seen state
*
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array (success result=ok, error result=error with error message)
* @throws BadRequestException
* @throws ForbiddenException
* @throws ImagickException
* @throws InternalServerErrorException
* @throws UnauthorizedException
*/
function api_friendica_direct_messages_setseen($type)
{
$a = DI::app();
if (api_user() === false) {
throw new ForbiddenException();
}
// params
$user_info = api_get_user();
$uid = $user_info['uid'];
$id = $_REQUEST['id'] ?? 0;
// return error if id is zero
if ($id == "") {
$answer = ['result' => 'error', 'message' => 'message id not specified'];
return BaseApi::formatData("direct_messages_setseen", $type, ['$result' => $answer]);
}
// error message if specified id is not in database
if (!DBA::exists('mail', ['id' => $id, 'uid' => $uid])) {
$answer = ['result' => 'error', 'message' => 'message id not in database'];
return BaseApi::formatData("direct_messages_setseen", $type, ['$result' => $answer]);
}
// update seen indicator
$result = DBA::update('mail', ['seen' => true], ['id' => $id]);
if ($result) {
// return success
$answer = ['result' => 'ok', 'message' => 'message set to seen'];
return BaseApi::formatData("direct_message_setseen", $type, ['$result' => $answer]);
} else {
$answer = ['result' => 'error', 'message' => 'unknown error'];
return BaseApi::formatData("direct_messages_setseen", $type, ['$result' => $answer]);
}
}
/// @TODO move to top of file or somewhere better
api_register_func('api/friendica/direct_messages_setseen', 'api_friendica_direct_messages_setseen', true);
/** /**
* search for direct_messages containing a searchstring through api * search for direct_messages containing a searchstring through api

64
src/Module/Api/Friendica/Activity.php Normal file
View file

@ -0,0 +1,64 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica;
use Friendica\Model\Item;
use Friendica\Module\BaseApi;
/**
* API endpoints:
* - /api/friendica/activity/like
* - /api/friendica/activity/dislike
* - /api/friendica/activity/attendyes
* - /api/friendica/activity/attendno
* - /api/friendica/activity/attendmaybe
* - /api/friendica/activity/unlike
* - /api/friendica/activity/undislike
* - /api/friendica/activity/unattendyes
* - /api/friendica/activity/unattendno
* - /api/friendica/activity/unattendmaybe
*/
class Activity extends BaseApi
{
public static function rawContent(array $parameters = [])
{
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$request = self::getRequest([
'id' => 0, // Id of the post
]);
$res = Item::performActivity($request['id'], $parameters['verb'], $uid);
if ($res) {
if (!empty($parameters['extension']) && ($parameters['extension'] == 'xml')) {
$ok = 'true';
} else {
$ok = 'ok';
}
self::exit('ok', ['ok' => $ok], $parameters['extension'] ?? null);
} else {
self::error(500, 'Error adding activity', '', $parameters['extension'] ?? null);
}
}
}

62
src/Module/Api/Friendica/DirectMessages/Setseen.php Normal file
View file

@ -0,0 +1,62 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica\DirectMessages;
use Friendica\Database\DBA;
use Friendica\Module\BaseApi;
/**
* API endpoint: /api/friendica/direct_messages_setseen
*/
class Setseen extends BaseApi
{
public static function rawContent(array $parameters = [])
{
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$request = self::getRequest([
'id' => 0, // Id of the direct message
]);
// return error if id is zero
if (empty($request['id'])) {
$answer = ['result' => 'error', 'message' => 'message id not specified'];
self::exit('direct_messages_setseen', ['$result' => $answer], $parameters['extension'] ?? null);
}
// error message if specified id is not in database
if (!DBA::exists('mail', ['id' => $request['id'], 'uid' => $uid])) {
$answer = ['result' => 'error', 'message' => 'message id not in database'];
self::exit('direct_messages_setseen', ['$result' => $answer], $parameters['extension'] ?? null);
}
// update seen indicator
if (DBA::update('mail', ['seen' => true], ['id' => $request['id']])) {
$answer = ['result' => 'ok', 'message' => 'message set to seen'];
} else {
$answer = ['result' => 'error', 'message' => 'unknown error'];
}
self::exit('direct_messages_setseen', ['$result' => $answer], $parameters['extension'] ?? null);
}
}

61
src/Module/Api/Friendica/Notification.php Normal file
View file

@ -0,0 +1,61 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica;
use Friendica\Collection\Api\Notifications as ApiNotifications;
use Friendica\DI;
use Friendica\Module\BaseApi;
use Friendica\Object\Api\Friendica\Notification as ApiNotification;
/**
* API endpoint: /api/friendica/notification
*/
class Notification extends BaseApi
{
public static function rawContent(array $parameters = [])
{
self::checkAllowedScope(self::SCOPE_READ);
$uid = self::getCurrentUserID();
$Notifies = DI::notify()->selectAllForUser($uid, 50);
$notifications = new ApiNotifications();
foreach ($Notifies as $Notify) {
$notifications[] = new ApiNotification($Notify);
}
if (!empty($parameters['extension']) && ($parameters['extension'] == 'xml')) {
$xmlnotes = [];
foreach ($notifications as $notification) {
$xmlnotes[] = ['@attributes' => $notification->toArray()];
}
$result = $xmlnotes;
} elseif (count($notifications) > 0) {
$result = $notifications->getArrayCopy();
} else {
$result = false;
}
self::exit('notes', ['note' => $result], $parameters['extension'] ?? null);
}
}

71
src/Module/Api/Friendica/Photo/Delete.php Normal file
View file

@ -0,0 +1,71 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica\Photo;
use Friendica\Model\Item;
use Friendica\Model\Photo;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException\BadRequestException;
use Friendica\Network\HTTPException\InternalServerErrorException;
/**
* API endpoint: /api/friendica/photo/delete
*/
class Delete extends BaseApi
{
public static function rawContent(array $parameters = [])
{
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$request = self::getRequest([
'photo_id' => null, // Photo id
]);
// do several checks on input parameters
// we do not allow calls without photo id
if ($request['photo_id'] == null) {
throw new BadRequestException("no photo_id specified");
}
// check if photo is existing in database
if (!Photo::exists(['resource-id' => $request['photo_id'], 'uid' => $uid])) {
throw new BadRequestException("photo not available");
}
// now we can perform on the deletion of the photo
$result = Photo::delete(['uid' => $uid, 'resource-id' => $request['photo_id']]);
// return success of deletion or error message
if ($result) {
// function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
// to the user and the contacts of the users (drop_items() do all the necessary magic to avoid orphans in database and federate deletion)
$condition = ['uid' => $uid, 'resource-id' => $request['photo_id'], 'type' => 'photo'];
Item::deleteForUser($condition, $uid);
$result = ['result' => 'deleted', 'message' => 'photo with id `' . $request['photo_id'] . '` has been deleted from server.'];
self::exit('photo_delete', ['$result' => $result], $parameters['extension'] ?? null);
} else {
throw new InternalServerErrorException("unknown error on deleting photo from database table");
}
}
}

74
src/Module/Api/Friendica/Photoalbum/Delete.php Normal file
View file

@ -0,0 +1,74 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica\Photoalbum;
use Friendica\Database\DBA;
use Friendica\Model\Item;
use Friendica\Model\Photo;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException\BadRequestException;
use Friendica\Network\HTTPException\InternalServerErrorException;
/**
* API endpoint: /api/friendica/photoalbum/delete
*/
class Delete extends BaseApi
{
public static function rawContent(array $parameters = [])
{
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$request = self::getRequest([
'album' => '', // Album name
]);
// we do not allow calls without album string
if (empty($request['album'])) {
throw new BadRequestException("no albumname specified");
}
// check if album is existing
$photos = DBA::selectToArray('photo', ['resource-id'], ['uid' => $uid, 'album' => $request['album']], ['group_by' => ['resource-id']]);
if (!DBA::isResult($photos)) {
throw new BadRequestException("album not available");
}
$resourceIds = array_column($photos, 'resource-id');
// function for setting the items to "deleted = 1" which ensures that comments, likes etc. are not shown anymore
// to the user and the contacts of the users (drop_items() performs the federation of the deletion to other networks
$condition = ['uid' => $uid, 'resource-id' => $resourceIds, 'type' => 'photo'];
Item::deleteForUser($condition, $uid);
// now let's delete all photos from the album
$result = Photo::delete(['uid' => $uid, 'album' => $request['album']]);
// return success of deletion or error message
if ($result) {
$answer = ['result' => 'deleted', 'message' => 'album `' . $request['album'] . '` with all containing photos has been deleted.'];
self::exit('photoalbum_delete', ['$result' => $answer], $parameters['extension'] ?? null);
} else {
throw new InternalServerErrorException("unknown error - deleting from database failed");
}
}
}

66
src/Module/Api/Friendica/Photoalbum/Update.php Normal file
View file

@ -0,0 +1,66 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* 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 <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica\Photoalbum;
use Friendica\Model\Photo;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException\BadRequestException;
use Friendica\Network\HTTPException\InternalServerErrorException;
/**
* API endpoint: /api/friendica/photoalbum/update
*/
class Update extends BaseApi
{
public static function rawContent(array $parameters = [])
{
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$request = self::getRequest([
'album' => '', // Current album name
'album_new' => '', // New album name
]);
// we do not allow calls without album string
if ($request['album'] == "") {
throw new BadRequestException("no albumname specified");
}
if ($request['album_new'] == "") {
throw new BadRequestException("no new albumname specified");
}
// check if album is existing
if (!Photo::exists(['uid' => $uid, 'album' => $request['album']])) {
throw new BadRequestException("album not available");
}
// now let's update all photos to the albumname
$result = Photo::update(['album' => $request['album_new']], ['uid' => $uid, 'album' => $request['album']]);
// return success of updating or error message
if ($result) {
$answer = ['result' => 'updated', 'message' => 'album `' . $request['album'] . '` with all containing photos has been renamed to `' . $request['album_new'] . '`.'];
self::exit('photoalbum_update', ['$result' => $answer], $parameters['extension'] ?? null);
} else {
throw new InternalServerErrorException("unknown error - updating in database failed");
}
}
}

20
static/routes.config.php
View file

@ -71,18 +71,10 @@ $apiRoutes = [
'/friendships/incoming[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]], '/friendships/incoming[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/friendica' => [ '/friendica' => [
'/activity/attendmaybe[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], '/activity/{verb:attendmaybe|attendno|attendyes|dislike|like|unattendmaybe|unattendno|unattendyes|undislike|unlike}[.{extension:json|xml|rss|atom}]'
'/activity/attendno[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], => [Module\Api\Friendica\Activity::class, [ R::POST]],
'/activity/attendyes[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/activity/dislike[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/activity/like[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/activity/unattendmaybe[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/activity/unattendno[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/activity/unattendyes[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/activity/undislike[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/activity/unlike[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/notification/seen[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], '/notification/seen[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/notification[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]], '/notification[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Notification::class, [R::GET ]],
'/direct_messages_setseen[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], '/direct_messages_setseen[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/direct_messages_search[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]], '/direct_messages_search[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/events[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Events\Index::class, [R::GET ]], '/events[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Events\Index::class, [R::GET ]],
@ -91,11 +83,11 @@ $apiRoutes = [
'/group_delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::DELETE, R::POST]], '/group_delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::DELETE, R::POST]],
'/group_update[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], '/group_update[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/profile/show[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Profile\Show::class, [R::GET ]], '/profile/show[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Profile\Show::class, [R::GET ]],
'/photoalbum/delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::DELETE, R::POST]], '/photoalbum/delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Photoalbum\Delete::class, [R::DELETE, R::POST]],
'/photoalbum/update[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], '/photoalbum/update[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Photoalbum\Update::class, [ R::POST]],
'/photos/list[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]], '/photos/list[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
'/photo/create[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], '/photo/create[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/photo/delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::DELETE, R::POST]], '/photo/delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Photo\Delete::class, [R::DELETE, R::POST]],
'/photo/update[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]], '/photo/update[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [ R::POST]],
'/photo[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]], '/photo[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Index::class, [R::GET ]],
], ],

76
tests/legacy/ApiTest.php
View file

@ -3184,8 +3184,8 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoalbumDelete() public function testApiFrPhotoalbumDelete()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
api_fr_photoalbum_delete('json'); // api_fr_photoalbum_delete('json');
} }
/** /**
@ -3195,9 +3195,9 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoalbumDeleteWithAlbum() public function testApiFrPhotoalbumDeleteWithAlbum()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
$_REQUEST['album'] = 'album_name'; // $_REQUEST['album'] = 'album_name';
api_fr_photoalbum_delete('json'); // api_fr_photoalbum_delete('json');
} }
/** /**
@ -3217,8 +3217,8 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoalbumUpdate() public function testApiFrPhotoalbumUpdate()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
api_fr_photoalbum_update('json'); // api_fr_photoalbum_update('json');
} }
/** /**
@ -3228,9 +3228,9 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoalbumUpdateWithAlbum() public function testApiFrPhotoalbumUpdateWithAlbum()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
$_REQUEST['album'] = 'album_name'; // $_REQUEST['album'] = 'album_name';
api_fr_photoalbum_update('json'); // api_fr_photoalbum_update('json');
} }
/** /**
@ -3240,10 +3240,10 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoalbumUpdateWithAlbumAndNewAlbum() public function testApiFrPhotoalbumUpdateWithAlbumAndNewAlbum()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
$_REQUEST['album'] = 'album_name'; // $_REQUEST['album'] = 'album_name';
$_REQUEST['album_new'] = 'album_name'; // $_REQUEST['album_new'] = 'album_name';
api_fr_photoalbum_update('json'); // api_fr_photoalbum_update('json');
} }
/** /**
@ -3253,9 +3253,9 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoalbumUpdateWithoutAuthenticatedUser() public function testApiFrPhotoalbumUpdateWithoutAuthenticatedUser()
{ {
$this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class); // $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
$_SESSION['authenticated'] = false; // $_SESSION['authenticated'] = false;
api_fr_photoalbum_update('json'); // api_fr_photoalbum_update('json');
} }
/** /**
@ -3351,8 +3351,8 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoDelete() public function testApiFrPhotoDelete()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
api_fr_photo_delete('json'); // api_fr_photo_delete('json');
} }
/** /**
@ -3362,9 +3362,9 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoDeleteWithoutAuthenticatedUser() public function testApiFrPhotoDeleteWithoutAuthenticatedUser()
{ {
$this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class); // $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
$_SESSION['authenticated'] = false; // $_SESSION['authenticated'] = false;
api_fr_photo_delete('json'); // api_fr_photo_delete('json');
} }
/** /**
@ -3374,9 +3374,9 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFrPhotoDeleteWithPhotoId() public function testApiFrPhotoDeleteWithPhotoId()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
$_REQUEST['photo_id'] = 1; // $_REQUEST['photo_id'] = 1;
api_fr_photo_delete('json'); // api_fr_photo_delete('json');
} }
/** /**
@ -3707,8 +3707,8 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFriendicaNotification() public function testApiFriendicaNotification()
{ {
$this->expectException(\Friendica\Network\HTTPException\BadRequestException::class); // $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
api_friendica_notification('json'); // api_friendica_notification('json');
} }
/** /**
@ -3718,9 +3718,9 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFriendicaNotificationWithoutAuthenticatedUser() public function testApiFriendicaNotificationWithoutAuthenticatedUser()
{ {
$this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class); // $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
$_SESSION['authenticated'] = false; // $_SESSION['authenticated'] = false;
api_friendica_notification('json'); // api_friendica_notification('json');
} }
/** /**
@ -3730,10 +3730,10 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFriendicaNotificationWithEmptyResult() public function testApiFriendicaNotificationWithEmptyResult()
{ {
DI::args()->setArgv(['api', 'friendica', 'notification']); // DI::args()->setArgv(['api', 'friendica', 'notification']);
$_SESSION['uid'] = 41; // $_SESSION['uid'] = 41;
$result = api_friendica_notification('json'); // $result = api_friendica_notification('json');
self::assertEquals(['note' => false], $result); // self::assertEquals(['note' => false], $result);
} }
/** /**
@ -3743,6 +3743,7 @@ class ApiTest extends FixtureTest
*/ */
public function testApiFriendicaNotificationWithXmlResult() public function testApiFriendicaNotificationWithXmlResult()
{ {
/*
DI::args()->setArgv(['api', 'friendica', 'notification']); DI::args()->setArgv(['api', 'friendica', 'notification']);
$result = api_friendica_notification('xml'); $result = api_friendica_notification('xml');
$date = DateTimeFormat::local('2020-01-01 12:12:02'); $date = DateTimeFormat::local('2020-01-01 12:12:02');
@ -3755,6 +3756,7 @@ class ApiTest extends FixtureTest
</notes> </notes>
XML; XML;
self::assertXmlStringEqualsXmlString($assertXml, $result); self::assertXmlStringEqualsXmlString($assertXml, $result);
*/
} }
/** /**
@ -3764,9 +3766,9 @@ XML;
*/ */
public function testApiFriendicaNotificationWithJsonResult() public function testApiFriendicaNotificationWithJsonResult()
{ {
DI::args()->setArgv(['api', 'friendica', 'notification']); // DI::args()->setArgv(['api', 'friendica', 'notification']);
$result = json_encode(api_friendica_notification('json')); // $result = json_encode(api_friendica_notification('json'));
self::assertJson($result); // self::assertJson($result);
} }
/** /**