friendica
/
friendica-addons
mirror of https://git.friendi.ca/friendica/friendica-addons.git
1
0
Fork 0
Code Issues Releases Wiki Activity

fix errors in pnut addon, add support for PHP 7.4

develop^2
Art4 2024-11-27 22:55:15 +00:00 committed by Hypolite Petovan
parent 1bd7cd6e71
commit b5c647bd5d
1 changed files with 92 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
pnut/lib/phpnut.php
View File

@ -2,6 +2,8 @@
namespace phpnut; namespace phpnut;
use CURLFile;
/** /**
* phpnut.php * phpnut.php
* pnut.io PHP library * pnut.io PHP library
@ -99,6 +101,10 @@ class phpnut
// if processing stream_markers or any fast stream, decrease $sleepFor // if processing stream_markers or any fast stream, decrease $sleepFor
public $streamingSleepFor = 20000; public $streamingSleepFor = 20000;
private $_clientId;
private $_clientSecret;
/** /**
* Constructs an phpnut PHP object with the specified client ID and * Constructs an phpnut PHP object with the specified client ID and
* client secret. * client secret.
@ -162,7 +168,7 @@ class phpnut
* from the user. If you don't specify anything, you'll only receive * from the user. If you don't specify anything, you'll only receive
* access to the user's basic profile (the default). * access to the user's basic profile (the default).
*/ */
public function getAuthUrl(?string $callback_uri=null, array|string|null $scope=null): string public function getAuthUrl(?string $callback_uri=null, array $scope=null): string
{ {
if (empty($this->_clientId)) { if (empty($this->_clientId)) {
throw new phpnutException('You must specify your pnut client ID'); throw new phpnutException('You must specify your pnut client ID');
@ -256,8 +262,10 @@ class phpnut
/** /**
* Check the scope of current token to see if it has required scopes * Check the scope of current token to see if it has required scopes
* has to be done after a check * has to be done after a check
*
* @return int|array
*/ */
public function checkScopes(array $app_scopes): int|array public function checkScopes(array $app_scopes)
{ {
if (count($this->_scopes) === 0) { if (count($this->_scopes) === 0) {
return -1; // _scope is empty return -1; // _scope is empty
@ -450,8 +458,10 @@ class phpnut
/** /**
* Internal function to handle all * Internal function to handle all
* HTTP requests (POST,PUT,GET,DELETE) * HTTP requests (POST,PUT,GET,DELETE)
*
* @param string|array $params
*/ */
protected function httpReq(string $act, string $req, string|array $params=[], string $contentType='application/x-www-form-urlencoded') protected function httpReq(string $act, string $req, $params = [], string $contentType='application/x-www-form-urlencoded')
{ {
$ch = curl_init($req); $ch = curl_init($req);
$headers = []; $headers = [];
@ -752,7 +762,7 @@ class phpnut
* Retrieve the Posts that are 'in reply to' a specific Post. * Retrieve the Posts that are 'in reply to' a specific Post.
* @param integer $post_id The ID of the post you want to retrieve replies for. * @param integer $post_id The ID of the post you want to retrieve replies for.
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getPostThread(int $post_id, array $params=[]) public function getPostThread(int $post_id, array $params=[])
{ {
@ -767,7 +777,7 @@ class phpnut
* Retrieve revisions of a post. Currently only one can be created. * Retrieve revisions of a post. Currently only one can be created.
* @param integer $post_id The ID of the post you want to retrieve previous revisions of. * @param integer $post_id The ID of the post you want to retrieve previous revisions of.
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getPostRevisions(int $post_id, array $params=[]) public function getPostRevisions(int $post_id, array $params=[])
{ {
@ -781,13 +791,13 @@ class phpnut
/** /**
* Get the most recent Posts created by a specific User in reverse * Get the most recent Posts created by a specific User in reverse
* chronological order (most recent first). * chronological order (most recent first).
* @param mixed $user_id Either the ID of the user you wish to retrieve posts by, * @param string|int $user_id $user_id Either the ID of the user you wish to retrieve posts by,
* or the string "me", which will retrieve posts for the user you're authenticated * or the string "me", which will retrieve posts for the user you're authenticated
* as. * as.
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getUserPosts(string|int $user_id='me', array $params=[]) public function getUserPosts($user_id = 'me', array $params=[])
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -799,13 +809,13 @@ class phpnut
/** /**
* Get the most recent Posts mentioning by a specific User in reverse * Get the most recent Posts mentioning by a specific User in reverse
* chronological order (newest first). * chronological order (newest first).
* @param mixed $user_id Either the ID of the user who is being mentioned, or * @param string|int $user_id Either the ID of the user who is being mentioned, or
* the string "me", which will retrieve posts for the user you're authenticated * the string "me", which will retrieve posts for the user you're authenticated
* as. * as.
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getUserMentions(string|int $user_id='me', array $params=[]) public function getUserMentions($user_id='me', array $params=[])
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -817,7 +827,7 @@ class phpnut
/** /**
* Get the currently authenticated user's recent messages * Get the currently authenticated user's recent messages
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getUserMessages(array $params=[]) public function getUserMessages(array $params=[])
{ {
@ -832,7 +842,7 @@ class phpnut
* Return the 20 most recent posts from the current User and * Return the 20 most recent posts from the current User and
* the Users they follow. * the Users they follow.
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getUserStream(array $params=[]) public function getUserStream(array $params=[])
{ {
@ -847,7 +857,7 @@ class phpnut
* Retrieve a list of all public Posts on pnut.io, often referred to as the * Retrieve a list of all public Posts on pnut.io, often referred to as the
* global stream. * global stream.
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getPublicPosts(array $params=[]) public function getPublicPosts(array $params=[])
{ {
@ -860,7 +870,7 @@ class phpnut
/** /**
* Retrieve a list of "explore" streams * Retrieve a list of "explore" streams
* @return An array of associative arrays, each representing a single explore stream. * @return array An array of associative arrays, each representing a single explore stream.
*/ */
public function getPostExploreStreams() public function getPostExploreStreams()
{ {
@ -874,7 +884,7 @@ class phpnut
* Retrieve a list of posts from an "explore" stream on pnut.io. * Retrieve a list of posts from an "explore" stream on pnut.io.
* @param string $slug [<description>] * @param string $slug [<description>]
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getPostExploreStream(string $slug, array $params=[]) public function getPostExploreStream(string $slug, array $params=[])
{ {
@ -916,10 +926,11 @@ class phpnut
* are: count, before_id, since_id, include_muted, include_deleted, * are: count, before_id, since_id, include_muted, include_deleted,
* and include_post_raw. * and include_post_raw.
* See https://github.com/phpnut/api-spec/blob/master/resources/posts.md#general-parameters * See https://github.com/phpnut/api-spec/blob/master/resources/posts.md#general-parameters
* @param string|int $user_id
* @return array An array of associative arrays, each representing a single * @return array An array of associative arrays, each representing a single
* user who has bookmarked a post * user who has bookmarked a post
*/ */
public function getBookmarked(string|int $user_id='me', array $params=[]) public function getBookmarked($user_id='me', array $params=[])
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -967,7 +978,7 @@ class phpnut
/** /**
* Repost an existing Post object. * Repost an existing Post object.
* @param integer $post_id The id of the post * @param integer $post_id The id of the post
* @return the reposted post * @return mixed the reposted post
*/ */
public function repost(int $post_id) public function repost(int $post_id)
{ {
@ -980,7 +991,7 @@ class phpnut
/** /**
* Delete a post that the user has reposted. * Delete a post that the user has reposted.
* @param integer $post_id The id of the post * @param integer $post_id The id of the post
* @return the un-reposted post * @return mixed the un-reposted post
*/ */
public function deleteRepost(int $post_id) public function deleteRepost(int $post_id)
{ {
@ -997,7 +1008,7 @@ class phpnut
* This will likely change as the API evolves, as of this writing allowed keys * This will likely change as the API evolves, as of this writing allowed keys
* are: count, before_id, since_id, include_muted, include_deleted, * are: count, before_id, since_id, include_muted, include_deleted,
* include_directed_posts, and include_raw. * include_directed_posts, and include_raw.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function searchHashtags(string $hashtag, array $params=[]) public function searchHashtags(string $hashtag, array $params=[])
{ {
@ -1044,7 +1055,7 @@ class phpnut
* This will likely change as the API evolves, as of this writing allowed keys * This will likely change as the API evolves, as of this writing allowed keys
* are: count, before_id, since_id, include_muted, include_deleted, * are: count, before_id, since_id, include_muted, include_deleted,
* and include_post_raw. * and include_post_raw.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getUserPersonalStream(array $params=[]) public function getUserPersonalStream(array $params=[])
{ {
@ -1071,7 +1082,7 @@ class phpnut
* This will likely change as the API evolves, as of this writing allowed keys * This will likely change as the API evolves, as of this writing allowed keys
* are: count, before_id, since_id, include_muted, include_deleted, * are: count, before_id, since_id, include_muted, include_deleted,
* include_directed_posts, and include_raw. * include_directed_posts, and include_raw.
* @return An array of associative arrays, each representing a single post. * @return array An array of associative arrays, each representing a single post.
*/ */
public function getUserUnifiedStream(array $params=[]) public function getUserUnifiedStream(array $params=[])
{ {
@ -1096,14 +1107,14 @@ class phpnut
/** /**
* Returns a specific user object. * Returns a specific user object.
* @param mixed $user_id The ID of the user you want to retrieve, or the string "@-username", or the string * @param string|int $user_id The ID of the user you want to retrieve, or the string "@-username", or the string
* "me" to retrieve data for the users you're currently authenticated as. * "me" to retrieve data for the users you're currently authenticated as.
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* This will likely change as the API evolves, as of this writing allowed keys * This will likely change as the API evolves, as of this writing allowed keys
* are: include_raw|include_user_raw. * are: include_raw|include_user_raw.
* @return array An associative array representing the user data. * @return array An associative array representing the user data.
*/ */
public function getUser(string|int $user_id='me', array $params=[]) public function getUser($user_id='me', array $params=[])
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -1131,10 +1142,10 @@ class phpnut
/** /**
* Add the specified user ID to the list of users followed. * Add the specified user ID to the list of users followed.
* Returns the User object of the user being followed. * Returns the User object of the user being followed.
* @param integer $user_id The user ID of the user to follow. * @param string|int $user_id The user ID of the user to follow.
* @return array An associative array representing the user you just followed. * @return array An associative array representing the user you just followed.
*/ */
public function followUser(string|int $user_id) public function followUser($user_id)
{ {
return $this->httpReq( return $this->httpReq(
'put', 'put',
@ -1145,10 +1156,10 @@ class phpnut
/** /**
* Removes the specified user ID to the list of users followed. * Removes the specified user ID to the list of users followed.
* Returns the User object of the user being unfollowed. * Returns the User object of the user being unfollowed.
* @param integer $user_id The user ID of the user to unfollow. * @param string|int $user_id The user ID of the user to unfollow.
* @return array An associative array representing the user you just unfollowed. * @return array An associative array representing the user you just unfollowed.
*/ */
public function unfollowUser(string|int $user_id) public function unfollowUser($user_id)
{ {
return $this->httpReq( return $this->httpReq(
'delete', 'delete',
@ -1158,13 +1169,13 @@ class phpnut
/** /**
* Returns an array of User objects the specified user is following. * Returns an array of User objects the specified user is following.
* @param mixed $user_id Either the ID of the user being followed, or * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated * the string "me", which will retrieve posts for the user you're authenticated
* as. * as.
* @return array An array of associative arrays, each representing a single * @return array An array of associative arrays, each representing a single
* user following $user_id * user following $user_id
*/ */
public function getFollowing(string|int $user_id='me', array $params=[]) public function getFollowing($user_id='me', array $params=[])
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -1175,12 +1186,12 @@ class phpnut
/** /**
* Returns an array of User ids the specified user is following. * Returns an array of User ids the specified user is following.
* @param mixed $user_id Either the ID of the user being followed, or * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated * the string "me", which will retrieve posts for the user you're authenticated
* as. * as.
* @return array user ids the specified user is following. * @return array user ids the specified user is following.
*/ */
public function getFollowingIDs(string|int $user_id='me') public function getFollowingIDs($user_id='me')
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -1190,13 +1201,13 @@ class phpnut
/** /**
* Returns an array of User objects for users following the specified user. * Returns an array of User objects for users following the specified user.
* @param mixed $user_id Either the ID of the user being followed, or * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated * the string "me", which will retrieve posts for the user you're authenticated
* as. * as.
* @return array An array of associative arrays, each representing a single * @return array An array of associative arrays, each representing a single
* user following $user_id * user following $user_id
*/ */
public function getFollowers(string|int $user_id='me', array $params=[]) public function getFollowers($user_id='me', array $params=[])
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -1207,12 +1218,12 @@ class phpnut
/** /**
* Returns an array of User ids for users following the specified user. * Returns an array of User ids for users following the specified user.
* @param mixed $user_id Either the ID of the user being followed, or * @param string|int $user_id Either the ID of the user being followed, or
* the string "me", which will retrieve posts for the user you're authenticated * the string "me", which will retrieve posts for the user you're authenticated
* as. * as.
* @return array user ids for users following the specified user * @return array user ids for users following the specified user
*/ */
public function getFollowersIDs(string|int $user_id='me') public function getFollowersIDs($user_id='me')
{ {
return $this->httpReq( return $this->httpReq(
'get', 'get',
@ -1236,9 +1247,9 @@ class phpnut
/** /**
* Mute a user * Mute a user
* @param integer $user_id The user ID to mute * @param string|int $user_id The user ID to mute
*/ */
public function muteUser(string|int $user_id) public function muteUser($user_id)
{ {
return $this->httpReq( return $this->httpReq(
'put', 'put',
@ -1248,9 +1259,9 @@ class phpnut
/** /**
* Unmute a user * Unmute a user
* @param integer $user_id The user ID to unmute * @param string|int $user_id The user ID to unmute
*/ */
public function unmuteUser(string|int $user_id) public function unmuteUser($user_id)
{ {
return $this->httpReq( return $this->httpReq(
'delete', 'delete',
@ -1288,7 +1299,7 @@ class phpnut
* @param string $search The search query. Supports @username or #tag searches as * @param string $search The search query. Supports @username or #tag searches as
* well as normal search terms. Searches username, display name, bio information. * well as normal search terms. Searches username, display name, bio information.
* Does not search posts. * Does not search posts.
* @return array An array of associative arrays, each representing one user. * @return array|false An array of associative arrays, each representing one user.
*/ */
public function searchUsers(array $params=[], string $query='') public function searchUsers(array $params=[], string $query='')
{ {
@ -1333,7 +1344,7 @@ class phpnut
$mimeType = $test['mime']; $mimeType = $test['mime'];
} }
$data = [ $data = [
$which => new CurlFile($image, $mimeType) $which => new CURLFile($image, $mimeType)
]; ];
return $this->httpReq( return $this->httpReq(
'post-raw', 'post-raw',
@ -1445,10 +1456,10 @@ class phpnut
/** /**
* get an existing private message channel between multiple users * get an existing private message channel between multiple users
* @param mixed $users Can be a comma- or space-separated string, or an array. * @param string|array $users Can be a comma- or space-separated string, or an array.
* Usernames with @-symbol, or user ids. * Usernames with @-symbol, or user ids.
*/ */
public function getExistingPM(string|array $users, array $params=[]) public function getExistingPM($users, array $params=[])
{ {
if (is_string($users)) { if (is_string($users)) {
$users = explode(',', str_replace(' ', ',', $users)); $users = explode(',', str_replace(' ', ',', $users));
@ -1561,7 +1572,7 @@ class phpnut
/** /**
* Retrieve a list of "explore" streams * Retrieve a list of "explore" streams
* @return An array of associative arrays, each representing a single explore stream. * @return array An array of associative arrays, each representing a single explore stream.
*/ */
public function getChannelExploreStreams() public function getChannelExploreStreams()
{ {
@ -1575,7 +1586,7 @@ class phpnut
* Retrieve a list of channels from an "explore" stream on pnut.io. * Retrieve a list of channels from an "explore" stream on pnut.io.
* @param string $slug [<description>] * @param string $slug [<description>]
* @param array $params An associative array of optional general parameters. * @param array $params An associative array of optional general parameters.
* @return An array of associative arrays, each representing a single channel. * @return array An array of associative arrays, each representing a single channel.
*/ */
public function getChannelExploreStream(string $slug, array $params=[]) public function getChannelExploreStream(string $slug, array $params=[])
{ {
@ -1685,11 +1696,11 @@ class phpnut
/** /**
* create message * create message
* @param $channelid numeric or "pm" for auto-channel (type=io.pnut.core.pm) * @param string|int $channelid numeric or "pm" for auto-channel (type=io.pnut.core.pm)
* @param array $data array('text'=>'YOUR_MESSAGE') If a type=io.pnut.core.pm, then "destinations" key can be set to address as an array of people to send this PM too * @param array $data array('text'=>'YOUR_MESSAGE') If a type=io.pnut.core.pm, then "destinations" key can be set to address as an array of people to send this PM too
* @param array $params query parameters * @param array $params query parameters
*/ */
public function createMessage(string|int $channelid, array $data, array $params=[]) public function createMessage($channelid, array $data, array $params=[])
{ {
if (isset($data['destinations'])) { if (isset($data['destinations'])) {
if (is_string($data['destinations'])) { if (is_string($data['destinations'])) {
@ -1802,16 +1813,16 @@ class phpnut
public function createFile($file, array $data, array $params=[]) public function createFile($file, array $data, array $params=[])
{ {
if (!$file) { if (!$file) {
throw new PhpnutException('You must specify a path to a file'); throw new phpnutException('You must specify a path to a file');
} }
if (!file_exists($file)) { if (!file_exists($file)) {
throw new PhpnutException('File path specified does not exist'); throw new phpnutException('File path specified does not exist');
} }
if (!is_readable($file)) { if (!is_readable($file)) {
throw new PhpnutException('File path specified is not readable'); throw new phpnutException('File path specified is not readable');
} }
if (!array_key_exists('type', $data) || !$data['type']) { if (!array_key_exists('type', $data) || !$data['type']) {
throw new PhpnutException('Type is required when creating a file'); throw new phpnutException('Type is required when creating a file');
} }
if (!array_key_exists('name', $data)) { if (!array_key_exists('name', $data)) {
$data['name'] = basename($file); $data['name'] = basename($file);
@ -1823,7 +1834,7 @@ class phpnut
$mimeType = null; $mimeType = null;
} }
if (!array_key_exists('kind', $data)) { if (!array_key_exists('kind', $data)) {
$test = @getimagesize($path); $test = @getimagesize($file);
if ($test && array_key_exists('mime', $test)) { if ($test && array_key_exists('mime', $test)) {
$data['kind'] = 'image'; $data['kind'] = 'image';
if (!$mimeType) { if (!$mimeType) {
@ -1840,7 +1851,7 @@ class phpnut
finfo_close($finfo); finfo_close($finfo);
} }
if (!$mimeType) { if (!$mimeType) {
throw new PhpnutException('Unable to determine mime type of file, try specifying it explicitly'); throw new phpnutException('Unable to determine mime type of file, try specifying it explicitly');
} }
$data['content'] = new \CurlFile($file, $mimeType); $data['content'] = new \CurlFile($file, $mimeType);
return $this->httpReq( return $this->httpReq(