keith/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

API: Functionality moved to new places

Browse source
This commit is contained in:
Michael 2022-01-06 07:34:16 +00:00
parent 2b74e41312
commit 9414edd64a
4 changed files with 375 additions and 483 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

582
include/api.php
View file

@ -24,26 +24,16 @@
*/ */
use Friendica\App; use Friendica\App;
use Friendica\Core\ACL;
use Friendica\Core\Logger; use Friendica\Core\Logger;
use Friendica\Core\System;
use Friendica\Database\DBA; use Friendica\Database\DBA;
use Friendica\DI; use Friendica\DI;
use Friendica\Model\Contact; use Friendica\Model\Contact;
use Friendica\Model\Group; use Friendica\Model\Group;
use Friendica\Model\Item;
use Friendica\Model\Photo; use Friendica\Model\Photo;
use Friendica\Model\Post; use Friendica\Model\Post;
use Friendica\Model\Profile;
use Friendica\Module\BaseApi; use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException; use Friendica\Network\HTTPException;
use Friendica\Network\HTTPException\BadRequestException;
use Friendica\Network\HTTPException\ForbiddenException;
use Friendica\Network\HTTPException\InternalServerErrorException;
use Friendica\Network\HTTPException\NotFoundException;
use Friendica\Network\HTTPException\UnauthorizedException;
use Friendica\Object\Image;
use Friendica\Util\Images;
use Friendica\Util\Strings;
$API = []; $API = [];
@ -102,7 +92,7 @@ function api_call($command, $extension)
* api function returned false withour throw an * api function returned false withour throw an
* exception. This should not happend, throw a 500 * exception. This should not happend, throw a 500
*/ */
throw new InternalServerErrorException(); throw new HTTPException\InternalServerErrorException();
} }
switch ($extension) { switch ($extension) {
@ -133,254 +123,13 @@ function api_call($command, $extension)
} }
Logger::warning(BaseApi::LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]); Logger::warning(BaseApi::LOG_PREFIX . 'not implemented', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString()]);
throw new NotFoundException(); throw new HTTPException\NotFoundException();
} catch (HTTPException $e) { } catch (HTTPException $e) {
Logger::notice(BaseApi::LOG_PREFIX . 'got exception', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString(), 'error' => $e]); Logger::notice(BaseApi::LOG_PREFIX . 'got exception', ['module' => 'api', 'action' => 'call', 'query' => DI::args()->getQueryString(), 'error' => $e]);
DI::apiResponse()->error($e->getCode(), $e->getDescription(), $e->getMessage(), $extension); DI::apiResponse()->error($e->getCode(), $e->getDescription(), $e->getMessage(), $extension);
} }
} }
/**
*
* @param string $acl_string
* @param int $uid
* @return bool
* @throws Exception
*/
function check_acl_input($acl_string, $uid)
{
if (empty($acl_string)) {
return false;
}
$contact_not_found = false;
// split <x><y><z> into array of cid's
preg_match_all("/<[A-Za-z0-9]+>/", $acl_string, $array);
// check for each cid if it is available on server
$cid_array = $array[0];
foreach ($cid_array as $cid) {
$cid = str_replace("<", "", $cid);
$cid = str_replace(">", "", $cid);
$condition = ['id' => $cid, 'uid' => $uid];
$contact_not_found |= !DBA::exists('contact', $condition);
}
return $contact_not_found;
}
/**
* @param string $mediatype
* @param array $media
* @param string $type
* @param string $album
* @param string $allow_cid
* @param string $deny_cid
* @param string $allow_gid
* @param string $deny_gid
* @param string $desc
* @param integer $phototype
* @param boolean $visibility
* @param string $photo_id
* @param int $uid
* @return array
* @throws BadRequestException
* @throws ForbiddenException
* @throws ImagickException
* @throws InternalServerErrorException
* @throws NotFoundException
* @throws UnauthorizedException
*/
function save_media_to_database($mediatype, $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, $phototype, $visibility, $photo_id, $uid)
{
$visitor = 0;
$src = "";
$filetype = "";
$filename = "";
$filesize = 0;
if (is_array($media)) {
if (is_array($media['tmp_name'])) {
$src = $media['tmp_name'][0];
} else {
$src = $media['tmp_name'];
}
if (is_array($media['name'])) {
$filename = basename($media['name'][0]);
} else {
$filename = basename($media['name']);
}
if (is_array($media['size'])) {
$filesize = intval($media['size'][0]);
} else {
$filesize = intval($media['size']);
}
if (is_array($media['type'])) {
$filetype = $media['type'][0];
} else {
$filetype = $media['type'];
}
}
$filetype = Images::getMimeTypeBySource($src, $filename, $filetype);
logger::info(
"File upload src: " . $src . " - filename: " . $filename .
" - size: " . $filesize . " - type: " . $filetype);
// check if there was a php upload error
if ($filesize == 0 && $media['error'] == 1) {
throw new InternalServerErrorException("image size exceeds PHP config settings, file was rejected by server");
}
// check against max upload size within Friendica instance
$maximagesize = DI::config()->get('system', 'maximagesize');
if ($maximagesize && ($filesize > $maximagesize)) {
$formattedBytes = Strings::formatBytes($maximagesize);
throw new InternalServerErrorException("image size exceeds Friendica config setting (uploaded size: $formattedBytes)");
}
// create Photo instance with the data of the image
$imagedata = @file_get_contents($src);
$Image = new Image($imagedata, $filetype);
if (!$Image->isValid()) {
throw new InternalServerErrorException("unable to process image data");
}
// check orientation of image
$Image->orient($src);
@unlink($src);
// check max length of images on server
$max_length = DI::config()->get('system', 'max_image_length');
if ($max_length > 0) {
$Image->scaleDown($max_length);
logger::info("File upload: Scaling picture to new size " . $max_length);
}
$width = $Image->getWidth();
$height = $Image->getHeight();
// create a new resource-id if not already provided
$resource_id = ($photo_id == null) ? Photo::newResource() : $photo_id;
if ($mediatype == "photo") {
// upload normal image (scales 0, 1, 2)
logger::info("photo upload: starting new photo upload");
$r = Photo::store($Image, $uid, $visitor, $resource_id, $filename, $album, 0, Photo::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if (!$r) {
logger::notice("photo upload: image upload with scale 0 (original size) failed");
}
if ($width > 640 || $height > 640) {
$Image->scaleDown(640);
$r = Photo::store($Image, $uid, $visitor, $resource_id, $filename, $album, 1, Photo::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if (!$r) {
logger::notice("photo upload: image upload with scale 1 (640x640) failed");
}
}
if ($width > 320 || $height > 320) {
$Image->scaleDown(320);
$r = Photo::store($Image, $uid, $visitor, $resource_id, $filename, $album, 2, Photo::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if (!$r) {
logger::notice("photo upload: image upload with scale 2 (320x320) failed");
}
}
logger::info("photo upload: new photo upload ended");
} elseif ($mediatype == "profileimage") {
// upload profile image (scales 4, 5, 6)
logger::info("photo upload: starting new profile image upload");
if ($width > 300 || $height > 300) {
$Image->scaleDown(300);
$r = Photo::store($Image, $uid, $visitor, $resource_id, $filename, $album, 4, $phototype, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if (!$r) {
logger::notice("photo upload: profile image upload with scale 4 (300x300) failed");
}
}
if ($width > 80 || $height > 80) {
$Image->scaleDown(80);
$r = Photo::store($Image, $uid, $visitor, $resource_id, $filename, $album, 5, $phototype, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if (!$r) {
logger::notice("photo upload: profile image upload with scale 5 (80x80) failed");
}
}
if ($width > 48 || $height > 48) {
$Image->scaleDown(48);
$r = Photo::store($Image, $uid, $visitor, $resource_id, $filename, $album, 6, $phototype, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if (!$r) {
logger::notice("photo upload: profile image upload with scale 6 (48x48) failed");
}
}
$Image->__destruct();
logger::info("photo upload: new profile image upload ended");
}
if (!empty($r)) {
// create entry in 'item'-table on new uploads to enable users to comment/like/dislike the photo
if ($photo_id == null && $mediatype == "photo") {
post_photo_item($resource_id, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility, $uid);
}
// on success return image data in json/xml format (like /api/friendica/photo does when no scale is given)
return prepare_photo_data($type, false, $resource_id, $uid);
} else {
throw new InternalServerErrorException("image upload failed");
DI::page()->exit(DI::apiResponse());
}
}
/**
*
* @param string $hash
* @param string $allow_cid
* @param string $deny_cid
* @param string $allow_gid
* @param string $deny_gid
* @param string $filetype
* @param boolean $visibility
* @param int $uid
* @throws InternalServerErrorException
*/
function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $filetype, $visibility, $uid)
{
// get data about the api authenticated user
$uri = Item::newURI(intval($uid));
$owner_record = DBA::selectFirst('contact', [], ['uid' => $uid, 'self' => true]);
$arr = [];
$arr['guid'] = System::createUUID();
$arr['uid'] = $uid;
$arr['uri'] = $uri;
$arr['post-type'] = Item::PT_IMAGE;
$arr['wall'] = 1;
$arr['resource-id'] = $hash;
$arr['contact-id'] = $owner_record['id'];
$arr['owner-name'] = $owner_record['name'];
$arr['owner-link'] = $owner_record['url'];
$arr['owner-avatar'] = $owner_record['thumb'];
$arr['author-name'] = $owner_record['name'];
$arr['author-link'] = $owner_record['url'];
$arr['author-avatar'] = $owner_record['thumb'];
$arr['title'] = '';
$arr['allow_cid'] = $allow_cid;
$arr['allow_gid'] = $allow_gid;
$arr['deny_cid'] = $deny_cid;
$arr['deny_gid'] = $deny_gid;
$arr['visible'] = $visibility;
$arr['origin'] = 1;
$typetoext = Images::supportedTypes();
// adds link to the thumbnail scale photo
$arr['body'] = '[url=' . DI::baseUrl() . '/photos/' . $owner_record['nick'] . '/image/' . $hash . ']'
. '[img]' . DI::baseUrl() . '/photo/' . $hash . '-' . "2" . '.'. $typetoext[$filetype] . '[/img]'
. '[/url]';
// do the magic for storing the item in the database and trigger the federation to other contacts
Item::insert($arr);
}
/** /**
* *
* @param string $type * @param string $type
@ -388,12 +137,12 @@ function post_photo_item($hash, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $f
* @param string $photo_id * @param string $photo_id
* *
* @return array * @return array
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws NotFoundException * @throws HTTPException\NotFoundException
* @throws UnauthorizedException * @throws HTTPException\UnauthorizedException
*/ */
function prepare_photo_data($type, $scale, $photo_id, $uid) function prepare_photo_data($type, $scale, $photo_id, $uid)
{ {
@ -448,14 +197,14 @@ function prepare_photo_data($type, $scale, $photo_id, $uid)
unset($data['photo']['minscale']); unset($data['photo']['minscale']);
unset($data['photo']['maxscale']); unset($data['photo']['maxscale']);
} else { } else {
throw new NotFoundException(); throw new HTTPException\NotFoundException();
} }
// retrieve item element for getting activities (like, dislike etc.) related to photo // retrieve item element for getting activities (like, dislike etc.) related to photo
$condition = ['uid' => $uid, 'resource-id' => $photo_id]; $condition = ['uid' => $uid, 'resource-id' => $photo_id];
$item = Post::selectFirst(['id', 'uid', 'uri', 'uri-id', 'parent', 'allow_cid', 'deny_cid', 'allow_gid', 'deny_gid'], $condition); $item = Post::selectFirst(['id', 'uid', 'uri', 'uri-id', 'parent', 'allow_cid', 'deny_cid', 'allow_gid', 'deny_gid'], $condition);
if (!DBA::isResult($item)) { if (!DBA::isResult($item)) {
throw new NotFoundException('Photo-related item not found.'); throw new HTTPException\NotFoundException('Photo-related item not found.');
} }
$data['photo']['friendica_activities'] = DI::friendicaActivities()->createFromUriId($item['uri-id'], $item['uid'], $type); $data['photo']['friendica_activities'] = DI::friendicaActivities()->createFromUriId($item['uri-id'], $item['uid'], $type);
@ -496,60 +245,6 @@ function prepare_photo_data($type, $scale, $photo_id, $uid)
return $data; return $data;
} }
/**
* Add a new group to the database.
*
* @param string $name Group name
* @param int $uid User ID
* @param array $users List of users to add to the group
*
* @return array
* @throws BadRequestException
*/
function group_create($name, $uid, $users = [])
{
// error if no name specified
if ($name == "") {
throw new BadRequestException('group name not specified');
}
// error message if specified group name already exists
if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => false])) {
throw new BadRequestException('group name already exists');
}
// Check if the group needs to be reactivated
if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => true])) {
$reactivate_group = true;
}
// create group
$ret = Group::create($uid, $name);
if ($ret) {
$gid = Group::getIdByName($uid, $name);
} else {
throw new BadRequestException('other API error');
}
// add members
$erroraddinguser = false;
$errorusers = [];
foreach ($users as $user) {
$cid = $user['cid'];
if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) {
Group::addMember($gid, $cid);
} else {
$erroraddinguser = true;
$errorusers[] = $cid;
}
}
// return success message incl. missing users in array
$status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
return ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
}
/** /**
* TWITTER API * TWITTER API
*/ */
@ -579,11 +274,11 @@ api_register_func('api/lists/subscriptions', 'api_lists_list', true);
* @param string $type Return type (atom, rss, xml, json) * @param string $type Return type (atom, rss, xml, json)
* *
* @return array|string * @return array|string
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws UnauthorizedException * @throws HTTPException\UnauthorizedException
* @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-ownerships
*/ */
function api_lists_ownerships($type) function api_lists_ownerships($type)
@ -622,8 +317,8 @@ api_register_func('api/lists/ownerships', 'api_lists_ownerships', true);
* *
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @return string|array
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
*/ */
function api_fr_photos_list($type) function api_fr_photos_list($type)
{ {
@ -672,11 +367,11 @@ api_register_func('api/friendica/photos/list', 'api_fr_photos_list', true);
* *
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @return string|array
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws NotFoundException * @throws HTTPException\NotFoundException
*/ */
function api_fr_photo_create_update($type) function api_fr_photo_create_update($type)
{ {
@ -692,14 +387,11 @@ function api_fr_photo_create_update($type)
$deny_cid = $_REQUEST['deny_cid' ] ?? null; $deny_cid = $_REQUEST['deny_cid' ] ?? null;
$allow_gid = $_REQUEST['allow_gid'] ?? null; $allow_gid = $_REQUEST['allow_gid'] ?? null;
$deny_gid = $_REQUEST['deny_gid' ] ?? null; $deny_gid = $_REQUEST['deny_gid' ] ?? null;
// Pictures uploaded via API never get posted as a visible status
// See https://github.com/friendica/friendica/issues/10990
$visibility = false;
// do several checks on input parameters // do several checks on input parameters
// we do not allow calls without album string // we do not allow calls without album string
if ($album == null) { if ($album == null) {
throw new BadRequestException("no albumname specified"); throw new HTTPException\BadRequestException("no albumname specified");
} }
// if photo_id == null --> we are uploading a new photo // if photo_id == null --> we are uploading a new photo
if ($photo_id == null) { if ($photo_id == null) {
@ -708,7 +400,7 @@ function api_fr_photo_create_update($type)
// error if no media posted in create-mode // error if no media posted in create-mode
if (empty($_FILES['media'])) { if (empty($_FILES['media'])) {
// Output error // Output error
throw new BadRequestException("no media data submitted"); throw new HTTPException\BadRequestException("no media data submitted");
} }
// album_new will be ignored in create-mode // album_new will be ignored in create-mode
@ -718,29 +410,29 @@ function api_fr_photo_create_update($type)
// check if photo is existing in databasei // check if photo is existing in databasei
if (!Photo::exists(['resource-id' => $photo_id, 'uid' => $uid, 'album' => $album])) { if (!Photo::exists(['resource-id' => $photo_id, 'uid' => $uid, 'album' => $album])) {
throw new BadRequestException("photo not available"); throw new HTTPException\BadRequestException("photo not available");
} }
} }
// checks on acl strings provided by clients // checks on acl strings provided by clients
$acl_input_error = false; $acl_input_error = false;
$acl_input_error |= check_acl_input($allow_cid, $uid); $acl_input_error |= !ACL::isValidContact($allow_cid, $uid);
$acl_input_error |= check_acl_input($deny_cid, $uid); $acl_input_error |= !ACL::isValidContact($deny_cid, $uid);
$acl_input_error |= check_acl_input($allow_gid, $uid); $acl_input_error |= !ACL::isValidGroup($allow_gid, $uid);
$acl_input_error |= check_acl_input($deny_gid, $uid); $acl_input_error |= !ACL::isValidGroup($deny_gid, $uid);
if ($acl_input_error) { if ($acl_input_error) {
throw new BadRequestException("acl data invalid"); throw new HTTPException\BadRequestException("acl data invalid");
} }
// now let's upload the new media in create-mode // now let's upload the new media in create-mode
if ($mode == "create") { if ($mode == "create") {
$media = $_FILES['media']; $photo = Photo::upload($uid, $_FILES['media'], $album, trim($allow_cid), trim($allow_gid), trim($deny_cid), trim($deny_gid), $desc);
$data = save_media_to_database("photo", $media, $type, $album, trim($allow_cid), trim($deny_cid), trim($allow_gid), trim($deny_gid), $desc, Photo::DEFAULT, $visibility, null, $uid);
// return success of updating or error message // return success of updating or error message
if (!is_null($data)) { if (!empty($photo)) {
$data = prepare_photo_data($type, false, $photo['resource_id'], $uid);
return DI::apiResponse()->formatData("photo_create", $type, $data); return DI::apiResponse()->formatData("photo_create", $type, $data);
} else { } else {
throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information"); throw new HTTPException\InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
} }
} }
@ -786,9 +478,9 @@ function api_fr_photo_create_update($type)
if (!empty($_FILES['media'])) { if (!empty($_FILES['media'])) {
$nothingtodo = false; $nothingtodo = false;
$media = $_FILES['media']; $photo = Photo::upload($uid, $_FILES['media'], $album, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc, $photo_id);
$data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, Photo::DEFAULT, $visibility, $photo_id, $uid); if (!empty($photo)) {
if (!is_null($data)) { $data = prepare_photo_data($type, false, $photo['resource_id'], $uid);
return DI::apiResponse()->formatData("photo_update", $type, $data); return DI::apiResponse()->formatData("photo_update", $type, $data);
} }
} }
@ -802,10 +494,10 @@ function api_fr_photo_create_update($type)
$answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.']; $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
return DI::apiResponse()->formatData("photo_update", $type, ['$result' => $answer]); return DI::apiResponse()->formatData("photo_update", $type, ['$result' => $answer]);
} }
throw new InternalServerErrorException("unknown error - update photo entry in database failed"); throw new HTTPException\InternalServerErrorException("unknown error - update photo entry in database failed");
} }
} }
throw new InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen"); throw new HTTPException\InternalServerErrorException("unknown error - this error on uploading or updating a photo should never happen");
} }
api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true); api_register_func('api/friendica/photo/create', 'api_fr_photo_create_update', true);
@ -816,10 +508,10 @@ api_register_func('api/friendica/photo/update', 'api_fr_photo_create_update', tr
* *
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* @return string|array * @return string|array
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws NotFoundException * @throws HTTPException\NotFoundException
*/ */
function api_fr_photo_detail($type) function api_fr_photo_detail($type)
{ {
@ -827,7 +519,7 @@ function api_fr_photo_detail($type)
$uid = BaseApi::getCurrentUserID(); $uid = BaseApi::getCurrentUserID();
if (empty($_REQUEST['photo_id'])) { if (empty($_REQUEST['photo_id'])) {
throw new BadRequestException("No photo id."); throw new HTTPException\BadRequestException("No photo id.");
} }
$scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false); $scale = (!empty($_REQUEST['scale']) ? intval($_REQUEST['scale']) : false);
@ -847,11 +539,11 @@ api_register_func('api/friendica/photo', 'api_fr_photo_detail', true);
* @param string $type Known types are 'atom', 'rss', 'xml' and 'json' * @param string $type Known types are 'atom', 'rss', 'xml' and 'json'
* *
* @return string|array * @return string|array
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws NotFoundException * @throws HTTPException\NotFoundException
* @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image * @see https://developer.twitter.com/en/docs/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_image
*/ */
function api_account_update_profile_image($type) function api_account_update_profile_image($type)
@ -859,67 +551,25 @@ function api_account_update_profile_image($type)
BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE); BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
$uid = BaseApi::getCurrentUserID(); $uid = BaseApi::getCurrentUserID();
// input params
$profile_id = $_REQUEST['profile_id'] ?? 0;
// error if image data is missing
if (empty($_FILES['image'])) {
throw new BadRequestException("no media data submitted");
}
// check if specified profile id is valid
if ($profile_id != 0) {
$profile = DBA::selectFirst('profile', ['is-default'], ['uid' => $uid, 'id' => $profile_id]);
// error message if specified profile id is not in database
if (!DBA::isResult($profile)) {
throw new BadRequestException("profile_id not available");
}
$is_default_profile = $profile['is-default'];
} else {
$is_default_profile = 1;
}
// get mediadata from image or media (Twitter call api/account/update_profile_image provides image) // get mediadata from image or media (Twitter call api/account/update_profile_image provides image)
$media = null;
if (!empty($_FILES['image'])) { if (!empty($_FILES['image'])) {
$media = $_FILES['image']; $media = $_FILES['image'];
} elseif (!empty($_FILES['media'])) { } elseif (!empty($_FILES['media'])) {
$media = $_FILES['media']; $media = $_FILES['media'];
} }
// error if image data is missing
if (empty($media)) {
throw new HTTPException\BadRequestException("no media data submitted");
}
// save new profile image // save new profile image
$data = save_media_to_database("profileimage", $media, $type, DI::l10n()->t(Photo::PROFILE_PHOTOS), "", "", "", "", "", Photo::USER_AVATAR, false, null, $uid); $resource_id = Photo::uploadAvatar($uid, $media);
if (empty($resource_id)) {
// get filetype throw new HTTPException\InternalServerErrorException("image upload failed");
if (is_array($media['type'])) {
$filetype = $media['type'][0];
} else {
$filetype = $media['type'];
} }
if ($filetype == "image/jpeg") {
$fileext = "jpg";
} elseif ($filetype == "image/png") {
$fileext = "png";
} else {
throw new InternalServerErrorException('Unsupported filetype');
}
// change specified profile or all profiles to the new resource-id
if ($is_default_profile) {
$condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $data['photo']['id'], $uid];
Photo::update(['profile' => false, 'photo-type' => Photo::DEFAULT], $condition);
} else {
$fields = ['photo' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-4.' . $fileext,
'thumb' => DI::baseUrl() . '/photo/' . $data['photo']['id'] . '-5.' . $fileext];
DBA::update('profile', $fields, ['id' => $_REQUEST['profile'], 'uid' => $uid]);
}
Contact::updateSelfFromUserID($uid, true);
// Update global directory in background
Profile::publishUpdate($uid);
// output for client // output for client
if ($data) {
$skip_status = $_REQUEST['skip_status'] ?? false; $skip_status = $_REQUEST['skip_status'] ?? false;
$user_info = DI::twitterUser()->createFromUserId($uid, $skip_status)->toArray(); $user_info = DI::twitterUser()->createFromUserId($uid, $skip_status)->toArray();
@ -931,10 +581,6 @@ function api_account_update_profile_image($type)
unset($user_info['uid']); unset($user_info['uid']);
return DI::apiResponse()->formatData("user", $type, ['user' => $user_info]); return DI::apiResponse()->formatData("user", $type, ['user' => $user_info]);
} else {
// SaveMediaToDatabase failed for some reason
throw new InternalServerErrorException("image upload failed");
}
} }
api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true); api_register_func('api/account/update_profile_image', 'api_account_update_profile_image', true);
@ -945,11 +591,11 @@ api_register_func('api/account/update_profile_image', 'api_account_update_profil
* @param string $type Return type (atom, rss, xml, json) * @param string $type Return type (atom, rss, xml, json)
* *
* @return array|string * @return array|string
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws UnauthorizedException * @throws HTTPException\UnauthorizedException
*/ */
function api_friendica_group_show($type) function api_friendica_group_show($type)
{ {
@ -965,7 +611,7 @@ function api_friendica_group_show($type)
// error message if specified gid is not in database // error message if specified gid is not in database
if (!DBA::isResult($groups)) { if (!DBA::isResult($groups)) {
throw new BadRequestException("gid not available"); throw new HTTPException\BadRequestException("gid not available");
} }
} else { } else {
$groups = DBA::selectToArray('group', [], ['deleted' => false, 'uid' => $uid]); $groups = DBA::selectToArray('group', [], ['deleted' => false, 'uid' => $uid]);
@ -1004,11 +650,11 @@ api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
* @param string $type Return type (atom, rss, xml, json) * @param string $type Return type (atom, rss, xml, json)
* *
* @return array|string * @return array|string
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws UnauthorizedException * @throws HTTPException\UnauthorizedException
* @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-destroy
*/ */
function api_lists_destroy($type) function api_lists_destroy($type)
@ -1021,14 +667,14 @@ function api_lists_destroy($type)
// error if no gid specified // error if no gid specified
if ($gid == 0) { if ($gid == 0) {
throw new BadRequestException('gid not specified'); throw new HTTPException\BadRequestException('gid not specified');
} }
// get data of the specified group id // get data of the specified group id
$group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]); $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
// error message if specified gid is not in database // error message if specified gid is not in database
if (!$group) { if (!$group) {
throw new BadRequestException('gid not available'); throw new HTTPException\BadRequestException('gid not available');
} }
if (Group::remove($gid)) { if (Group::remove($gid)) {
@ -1051,11 +697,11 @@ api_register_func('api/lists/destroy', 'api_lists_destroy', true);
* @param string $type Return type (atom, rss, xml, json) * @param string $type Return type (atom, rss, xml, json)
* *
* @return array|string * @return array|string
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws UnauthorizedException * @throws HTTPException\UnauthorizedException
*/ */
function api_friendica_group_create($type) function api_friendica_group_create($type)
{ {
@ -1067,9 +713,48 @@ function api_friendica_group_create($type)
$json = json_decode($_POST['json'], true); $json = json_decode($_POST['json'], true);
$users = $json['user']; $users = $json['user'];
$success = group_create($name, $uid, $users); // error if no name specified
if ($name == "") {
throw new HTTPException\BadRequestException('group name not specified');
}
return DI::apiResponse()->formatData("group_create", $type, ['result' => $success]); // error message if specified group name already exists
if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => false])) {
throw new HTTPException\BadRequestException('group name already exists');
}
// Check if the group needs to be reactivated
if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => true])) {
$reactivate_group = true;
}
// create group
$ret = Group::create($uid, $name);
if ($ret) {
$gid = Group::getIdByName($uid, $name);
} else {
throw new HTTPException\BadRequestException('other API error');
}
// add members
$erroraddinguser = false;
$errorusers = [];
foreach ($users as $user) {
$cid = $user['cid'];
if (DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) {
Group::addMember($gid, $cid);
} else {
$erroraddinguser = true;
$errorusers[] = $cid;
}
}
// return success message incl. missing users in array
$status = ($erroraddinguser ? "missing user" : ((isset($reactivate_group) && $reactivate_group) ? "reactivated" : "ok"));
$result = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
return DI::apiResponse()->formatData("group_create", $type, ['result' => $result]);
} }
api_register_func('api/friendica/group_create', 'api_friendica_group_create', true); api_register_func('api/friendica/group_create', 'api_friendica_group_create', true);
@ -1080,11 +765,11 @@ api_register_func('api/friendica/group_create', 'api_friendica_group_create', tr
* @param string $type Return type (atom, rss, xml, json) * @param string $type Return type (atom, rss, xml, json)
* *
* @return array|string * @return array|string
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws UnauthorizedException * @throws HTTPException\UnauthorizedException
* @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-create
*/ */
function api_lists_create($type) function api_lists_create($type)
@ -1095,17 +780,30 @@ function api_lists_create($type)
// params // params
$name = $_REQUEST['name'] ?? ''; $name = $_REQUEST['name'] ?? '';
$success = group_create($name, $uid); if ($name == "") {
if ($success['success']) { throw new HTTPException\BadRequestException('group name not specified');
}
// error message if specified group name already exists
if (DBA::exists('group', ['uid' => $uid, 'name' => $name, 'deleted' => false])) {
throw new HTTPException\BadRequestException('group name already exists');
}
$ret = Group::create($uid, $name);
if ($ret) {
$gid = Group::getIdByName($uid, $name);
} else {
throw new HTTPException\BadRequestException('other API error');
}
$grp = [ $grp = [
'name' => $success['name'], 'name' => $name,
'id' => intval($success['gid']), 'id' => intval($gid),
'id_str' => (string) $success['gid'], 'id_str' => (string) $gid,
'user' => DI::twitterUser()->createFromUserId($uid, true)->toArray() 'user' => DI::twitterUser()->createFromUserId($uid, true)->toArray()
]; ];
return DI::apiResponse()->formatData("lists", $type, ['lists' => $grp]); return DI::apiResponse()->formatData("lists", $type, ['lists' => $grp]);
}
} }
api_register_func('api/lists/create', 'api_lists_create', true); api_register_func('api/lists/create', 'api_lists_create', true);
@ -1116,11 +814,11 @@ api_register_func('api/lists/create', 'api_lists_create', true);
* @param string $type Return type (atom, rss, xml, json) * @param string $type Return type (atom, rss, xml, json)
* *
* @return array|string * @return array|string
* @throws BadRequestException * @throws HTTPException\BadRequestException
* @throws ForbiddenException * @throws HTTPException\ForbiddenException
* @throws ImagickException * @throws ImagickException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws UnauthorizedException * @throws HTTPException\UnauthorizedException
* @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update * @see https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/post-lists-update
*/ */
function api_lists_update($type) function api_lists_update($type)
@ -1134,14 +832,14 @@ function api_lists_update($type)
// error if no gid specified // error if no gid specified
if ($gid == 0) { if ($gid == 0) {
throw new BadRequestException('gid not specified'); throw new HTTPException\BadRequestException('gid not specified');
} }
// get data of the specified group id // get data of the specified group id
$group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]); $group = DBA::selectFirst('group', [], ['uid' => $uid, 'id' => $gid]);
// error message if specified gid is not in database // error message if specified gid is not in database
if (!$group) { if (!$group) {
throw new BadRequestException('gid not available'); throw new HTTPException\BadRequestException('gid not available');
} }
if (Group::update($gid, $name)) { if (Group::update($gid, $name)) {

58
src/Core/ACL.php
View file

@ -341,4 +341,62 @@ class ACL
return $o; return $o;
} }
/**
* Checks the validity of the given ACL string
*
* @param string $acl_string
* @param int $uid
* @return bool
* @throws Exception
*/
public static function isValidContact($acl_string, $uid)
{
if (empty($acl_string)) {
return true;
}
// split <x><y><z> into array of cids
preg_match_all('/<[A-Za-z0-9]+>/', $acl_string, $array);
// check for each cid if the contact is valid for the given user
$cid_array = $array[0];
foreach ($cid_array as $cid) {
$cid = str_replace(['<', '>'], ['', ''], $cid);
if (!DBA::exists('contact', ['id' => $cid, 'uid' => $uid])) {
return false;
}
}
return true;
}
/**
* Checks the validity of the given ACL string
*
* @param string $acl_string
* @param int $uid
* @return bool
* @throws Exception
*/
public static function isValidGroup($acl_string, $uid)
{
if (empty($acl_string)) {
return true;
}
// split <x><y><z> into array of cids
preg_match_all('/<[A-Za-z0-9]+>/', $acl_string, $array);
// check for each cid if the contact is valid for the given user
$gid_array = $array[0];
foreach ($gid_array as $gid) {
$gid = str_replace(['<', '>'], ['', ''], $gid);
if (!DBA::exists('group', ['id' => $gid, 'uid' => $uid, 'deleted' => false])) {
return false;
}
}
return true;
}
} }

176
src/Model/Photo.php
View file

@ -46,6 +46,7 @@ class Photo
{ {
const CONTACT_PHOTOS = 'Contact Photos'; const CONTACT_PHOTOS = 'Contact Photos';
const PROFILE_PHOTOS = 'Profile Photos'; const PROFILE_PHOTOS = 'Profile Photos';
const BANNER_PHOTOS = 'Banner Photos';
const DEFAULT = 0; const DEFAULT = 0;
const USER_AVATAR = 10; const USER_AVATAR = 10;
@ -870,22 +871,10 @@ class Photo
return DBA::exists('photo', ['resource-id' => $guid]); return DBA::exists('photo', ['resource-id' => $guid]);
} }
/** private static function uploadImage(array $files)
*
* @param int $uid User ID
* @param array $files uploaded file array
* @return array photo record
*/
public static function upload(int $uid, array $files)
{ {
Logger::info('starting new upload'); Logger::info('starting new upload');
$user = User::getOwnerDataById($uid);
if (empty($user)) {
Logger::notice('User not found', ['uid' => $uid]);
return [];
}
if (empty($files)) { if (empty($files)) {
Logger::notice('Empty upload file'); Logger::notice('Empty upload file');
return []; return [];
@ -932,7 +921,7 @@ class Photo
} }
if (empty($src)) { if (empty($src)) {
Logger::notice('No source file name', ['uid' => $uid, 'files' => $files]); Logger::notice('No source file name', ['files' => $files]);
return []; return [];
} }
@ -943,7 +932,7 @@ class Photo
$imagedata = @file_get_contents($src); $imagedata = @file_get_contents($src);
$Image = new Image($imagedata, $filetype); $Image = new Image($imagedata, $filetype);
if (!$Image->isValid()) { if (!$Image->isValid()) {
Logger::notice('Image is unvalid', ['uid' => $uid, 'files' => $files]); Logger::notice('Image is unvalid', ['files' => $files]);
return []; return [];
} }
@ -980,13 +969,45 @@ class Photo
} }
} }
$resource_id = Photo::newResource(); return ['image' => $Image, 'filename' => $filename, 'width' => $width, 'height' => $height];
$album = DI::l10n()->t('Wall Photos'); }
$defperm = '<' . $user['id'] . '>';
/**
*
* @param int $uid User ID
* @param array $files uploaded file array
* @return array photo record
*/
public static function upload(int $uid, array $files, string $album = '', string $allow_cid = null, string $allow_gid = null, string $deny_cid = '', string $deny_gid = '', string $desc = '', string $resource_id = '')
{
$user = User::getOwnerDataById($uid);
if (empty($user)) {
Logger::notice('User not found', ['uid' => $uid]);
return [];
}
$data = self::uploadImage($files);
if (empty($data)) {
Logger::info('upload failed');
return [];
}
$Image = $data['image'];
$filename = $data['filename'];
$width = $data['width'];
$height = $data['height'];
$resource_id = $resource_id ?: Photo::newResource();
$album = $album ?: DI::l10n()->t('Wall Photos');
if (is_null($allow_cid) && is_null($allow_gid)) {
$allow_cid = '<' . $user['id'] . '>';
$allow_gid = '';
}
$smallest = 0; $smallest = 0;
$r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 0, self::DEFAULT, $defperm); $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 0, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if (!$r) { if (!$r) {
Logger::notice('Photo could not be stored'); Logger::notice('Photo could not be stored');
return []; return [];
@ -994,7 +1015,7 @@ class Photo
if ($width > 640 || $height > 640) { if ($width > 640 || $height > 640) {
$Image->scaleDown(640); $Image->scaleDown(640);
$r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 1, self::DEFAULT, $defperm); $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 1, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if ($r) { if ($r) {
$smallest = 1; $smallest = 1;
} }
@ -1002,7 +1023,7 @@ class Photo
if ($width > 320 || $height > 320) { if ($width > 320 || $height > 320) {
$Image->scaleDown(320); $Image->scaleDown(320);
$r = Photo::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 2, self::DEFAULT, $defperm); $r = self::store($Image, $user['uid'], 0, $resource_id, $filename, $album, 2, self::DEFAULT, $allow_cid, $allow_gid, $deny_cid, $deny_gid, $desc);
if ($r && ($smallest == 0)) { if ($r && ($smallest == 0)) {
$smallest = 2; $smallest = 2;
} }
@ -1018,6 +1039,7 @@ class Photo
$picture = []; $picture = [];
$picture['id'] = $photo['id']; $picture['id'] = $photo['id'];
$picture['resource_id'] = $resource_id;
$picture['size'] = $photo['datasize']; $picture['size'] = $photo['datasize'];
$picture['width'] = $photo['width']; $picture['width'] = $photo['width'];
$picture['height'] = $photo['height']; $picture['height'] = $photo['height'];
@ -1026,7 +1048,119 @@ class Photo
$picture['picture'] = DI::baseUrl() . '/photo/{$resource_id}-0.' . $Image->getExt(); $picture['picture'] = DI::baseUrl() . '/photo/{$resource_id}-0.' . $Image->getExt();
$picture['preview'] = DI::baseUrl() . '/photo/{$resource_id}-{$smallest}.' . $Image->getExt(); $picture['preview'] = DI::baseUrl() . '/photo/{$resource_id}-{$smallest}.' . $Image->getExt();
$Image->__destruct();
Logger::info('upload done', ['picture' => $picture]); Logger::info('upload done', ['picture' => $picture]);
return $picture; return $picture;
} }
/**
*
* @param int $uid User ID
* @param array $files uploaded file array
* @return string avatar resource
*/
public static function uploadAvatar(int $uid, array $files)
{
$data = self::uploadImage($files);
if (empty($data)) {
return [];
}
$Image = $data['image'];
$filename = $data['filename'];
$width = $data['width'];
$height = $data['height'];
$resource_id = Photo::newResource();
$album = DI::l10n()->t(Photo::PROFILE_PHOTOS);
// upload profile image (scales 4, 5, 6)
logger::info('starting new profile image upload');
if ($width > 300 || $height > 300) {
$Image->scaleDown(300);
}
$r = Photo::store($Image, $uid, 0, $resource_id, $filename, $album, 4, Photo::USER_AVATAR);
if (!$r) {
logger::notice('profile image upload with scale 4 (300) failed');
}
if ($width > 80 || $height > 80) {
$Image->scaleDown(80);
}
$r = Photo::store($Image, $uid, 0, $resource_id, $filename, $album, 5, Photo::USER_AVATAR);
if (!$r) {
logger::notice('profile image upload with scale 5 (80) failed');
}
if ($width > 48 || $height > 48) {
$Image->scaleDown(48);
}
$r = Photo::store($Image, $uid, 0, $resource_id, $filename, $album, 6, Photo::USER_AVATAR);
if (!$r) {
logger::notice('profile image upload with scale 6 (48) failed');
}
$Image->__destruct();
logger::info('new profile image upload ended');
$condition = ["`profile` AND `resource-id` != ? AND `uid` = ?", $resource_id, $uid];
Photo::update(['profile' => false, 'photo-type' => Photo::DEFAULT], $condition);
Contact::updateSelfFromUserID($uid, true);
// Update global directory in background
Profile::publishUpdate($uid);
return $resource_id;
}
/**
*
* @param int $uid User ID
* @param array $files uploaded file array
* @return string avatar resource
*/
public static function uploadBanner(int $uid, array $files)
{
$data = self::uploadImage($files);
if (empty($data)) {
Logger::info('upload failed');
return [];
}
$Image = $data['image'];
$filename = $data['filename'];
$width = $data['width'];
$height = $data['height'];
$resource_id = Photo::newResource();
$album = DI::l10n()->t(Photo::BANNER_PHOTOS);
if ($width > 960) {
$Image->scaleDown(960);
}
$r = self::store($Image, $uid, 0, $resource_id, $filename, $album, 3, self::USER_BANNER);
if (!$r) {
logger::notice('profile banner upload with scale 3 (960) failed');
}
$Image->__destruct();
logger::info('new profile banner upload ended');
$condition = ["`photo-type` = ? AND `resource-id` != ? AND `uid` = ?", self::USER_BANNER, $resource_id, $uid];
Photo::update(['photo-type' => Photo::DEFAULT], $condition);
Contact::updateSelfFromUserID($uid, true);
// Update global directory in background
Profile::publishUpdate($uid);
return $resource_id;
}
} }

2
src/Module/Api/Twitter/Account/UpdateProfile.php
View file

@ -52,6 +52,8 @@ class UpdateProfile extends BaseApi
Contact::update(['about' => $request['description']], ['id' => $api_user['id']]); Contact::update(['about' => $request['description']], ['id' => $api_user['id']]);
} }
Contact::updateSelfFromUserID($uid, true);
Profile::publishUpdate($uid); Profile::publishUpdate($uid);
$skip_status = $request['skip_status'] ?? false; $skip_status = $request['skip_status'] ?? false;