wordpress-activitypub/includes/functions.php

317 lines
8.3 KiB
PHP
Raw Normal View History

2018-09-24 20:47:15 +02:00
<?php
namespace Activitypub;
/**
2018-09-30 22:51:22 +02:00
* Returns the ActivityPub default JSON-context
*
2018-09-30 22:51:22 +02:00
* @return array the activitypub context
*/
function get_context() {
2018-09-30 22:51:22 +02:00
$context = array(
'https://www.w3.org/ns/activitystreams',
'https://w3id.org/security/v1',
array(
'manuallyApprovesFollowers' => 'as:manuallyApprovesFollowers',
'PropertyValue' => 'schema:PropertyValue',
2019-11-18 20:57:00 +01:00
'schema' => 'http://schema.org#',
2021-01-12 12:45:17 +01:00
'pt' => 'https://joinpeertube.org/ns#',
'toot' => 'http://joinmastodon.org/ns#',
2018-09-30 22:51:22 +02:00
'value' => 'schema:value',
2021-01-12 12:45:17 +01:00
'Hashtag' => 'as:Hashtag',
'featured' => array(
'@id' => 'toot:featured',
2021-07-23 15:46:28 +02:00
'@type' => '@id',
2021-01-12 12:45:17 +01:00
),
'featuredTags' => array(
'@id' => 'toot:featuredTags',
2021-07-23 15:46:28 +02:00
'@type' => '@id',
2021-01-12 12:45:17 +01:00
),
2018-09-30 22:51:22 +02:00
),
);
2019-09-27 10:12:59 +02:00
return \apply_filters( 'activitypub_json_context', $context );
}
2018-12-08 00:02:18 +01:00
function safe_remote_post( $url, $body, $user_id ) {
2019-09-27 10:12:59 +02:00
$date = \gmdate( 'D, d M Y H:i:s T' );
2020-12-10 04:23:05 +01:00
$digest = \Activitypub\Signature::generate_digest( $body );
$signature = \Activitypub\Signature::generate_signature( $user_id, 'post', $url, $date, $digest );
2018-12-08 00:02:18 +01:00
2019-09-27 10:12:59 +02:00
$wp_version = \get_bloginfo( 'version' );
$user_agent = \apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . \get_bloginfo( 'url' ) );
2018-12-08 00:02:18 +01:00
$args = array(
'timeout' => 100,
'limit_response_size' => 1048576,
'redirection' => 3,
'user-agent' => "$user_agent; ActivityPub",
'headers' => array(
'Accept' => 'application/activity+json',
'Content-Type' => 'application/activity+json',
2020-12-10 04:23:05 +01:00
'Digest' => "SHA-256=$digest",
2018-12-08 00:02:18 +01:00
'Signature' => $signature,
'Date' => $date,
),
'body' => $body,
);
2019-09-27 10:12:59 +02:00
$response = \wp_safe_remote_post( $url, $args );
2019-03-14 23:10:11 +01:00
2019-09-27 10:12:59 +02:00
\do_action( 'activitypub_safe_remote_post_response', $response, $url, $body, $user_id );
2019-03-14 23:10:11 +01:00
return $response;
}
2020-02-21 11:05:17 +01:00
function safe_remote_get( $url, $user_id ) {
$date = \gmdate( 'D, d M Y H:i:s T' );
$signature = \Activitypub\Signature::generate_signature( $user_id, 'get', $url, $date );
2020-02-21 11:05:17 +01:00
$wp_version = \get_bloginfo( 'version' );
$user_agent = \apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . \get_bloginfo( 'url' ) );
$args = array(
'timeout' => 100,
'limit_response_size' => 1048576,
'redirection' => 3,
'user-agent' => "$user_agent; ActivityPub",
'headers' => array(
'Accept' => 'application/activity+json',
'Content-Type' => 'application/activity+json',
'Signature' => $signature,
'Date' => $date,
),
);
$response = \wp_safe_remote_get( $url, $args );
\do_action( 'activitypub_safe_remote_get_response', $response, $url, $user_id );
return $response;
}
/**
* Returns a users WebFinger "resource"
*
* @param int $user_id
*
* @return string The user-resource
*/
function get_webfinger_resource( $user_id ) {
2022-11-15 20:50:56 +01:00
return \Activitypub\Webfinger::get_user_resource( $user_id );
}
/**
* [get_metadata_by_actor description]
*
2022-11-09 15:08:32 +01:00
* @param string $actor
2019-03-14 23:10:11 +01:00
*
* @return array
*/
function get_remote_metadata_by_actor( $actor ) {
2022-12-02 12:46:42 +01:00
$pre = apply_filters( 'pre_get_remote_metadata_by_actor', false, $actor );
if ( $pre ) {
return $pre;
}
2022-12-09 11:59:24 +01:00
if ( preg_match( '/^@?' . ACTIVITYPUB_USERNAME_REGEXP . '$/i', $actor ) ) {
$actor = Rest\Webfinger::resolve( $actor );
2022-11-09 15:08:32 +01:00
}
if ( ! $actor ) {
return null;
}
if ( is_wp_error( $actor ) ) {
return $actor;
}
2022-12-09 13:39:48 +01:00
$transient_key = 'activitypub_' . $actor;
$metadata = \get_transient( $transient_key );
if ( $metadata ) {
return $metadata;
}
2019-09-27 10:12:59 +02:00
if ( ! \wp_http_validate_url( $actor ) ) {
return new \WP_Error( 'activitypub_no_valid_actor_url', \__( 'The "actor" is no valid URL', 'activitypub' ), $actor );
}
2022-01-27 13:09:11 +01:00
$user = \get_users(
array(
'number' => 1,
2022-12-09 11:59:24 +01:00
'capability__in' => array( 'publish_posts' ),
2022-01-27 13:09:11 +01:00
'fields' => 'ID',
)
);
2020-02-21 11:05:17 +01:00
// we just need any user to generate a request signature
$user_id = \reset( $user );
2020-02-21 11:05:17 +01:00
$response = \Activitypub\safe_remote_get( $actor, $user_id );
2019-09-27 10:12:59 +02:00
if ( \is_wp_error( $response ) ) {
return $response;
}
2019-09-27 10:12:59 +02:00
$metadata = \wp_remote_retrieve_body( $response );
$metadata = \json_decode( $metadata, true );
if ( ! $metadata ) {
2022-12-09 13:39:48 +01:00
$metadata = new \WP_Error( 'activitypub_invalid_json', \__( 'No valid JSON data', 'activitypub' ), $actor );
\set_transient( $transient_key, $metadata, HOUR_IN_SECONDS ); // Cache the error for a shorter period.
return $metadata;
}
2022-12-09 13:39:48 +01:00
\set_transient( $transient_key, $metadata, WEEK_IN_SECONDS );
return $metadata;
}
/**
* [get_inbox_by_actor description]
* @param [type] $actor [description]
* @return [type] [description]
*/
function get_inbox_by_actor( $actor ) {
2019-02-24 12:21:25 +01:00
$metadata = \Activitypub\get_remote_metadata_by_actor( $actor );
2019-09-27 10:12:59 +02:00
if ( \is_wp_error( $metadata ) ) {
return $metadata;
}
if ( isset( $metadata['endpoints'] ) && isset( $metadata['endpoints']['sharedInbox'] ) ) {
return $metadata['endpoints']['sharedInbox'];
}
2019-09-27 10:12:59 +02:00
if ( \array_key_exists( 'inbox', $metadata ) ) {
return $metadata['inbox'];
}
2020-05-12 20:30:06 +02:00
return new \WP_Error( 'activitypub_no_inbox', \__( 'No "Inbox" found', 'activitypub' ), $metadata );
}
/**
* [get_inbox_by_actor description]
* @param [type] $actor [description]
* @return [type] [description]
*/
function get_publickey_by_actor( $actor, $key_id ) {
2019-02-24 12:21:25 +01:00
$metadata = \Activitypub\get_remote_metadata_by_actor( $actor );
2019-09-27 10:12:59 +02:00
if ( \is_wp_error( $metadata ) ) {
return $metadata;
}
if (
isset( $metadata['publicKey'] ) &&
isset( $metadata['publicKey']['id'] ) &&
isset( $metadata['publicKey']['owner'] ) &&
isset( $metadata['publicKey']['publicKeyPem'] ) &&
$key_id === $metadata['publicKey']['id'] &&
$actor === $metadata['publicKey']['owner']
) {
return $metadata['publicKey']['publicKeyPem'];
}
2019-09-27 10:12:59 +02:00
return new \WP_Error( 'activitypub_no_public_key', \__( 'No "Public-Key" found', 'activitypub' ), $metadata );
}
2019-03-14 23:10:11 +01:00
function get_follower_inboxes( $user_id ) {
2019-11-18 20:57:00 +01:00
$followers = \Activitypub\Peer\Followers::get_followers( $user_id );
$inboxes = array();
2019-03-14 23:10:11 +01:00
foreach ( $followers as $follower ) {
2019-03-14 23:10:11 +01:00
$inbox = \Activitypub\get_inbox_by_actor( $follower );
2019-09-27 10:12:59 +02:00
if ( ! $inbox || \is_wp_error( $inbox ) ) {
continue;
}
2019-03-14 23:10:11 +01:00
// init array if empty
if ( ! isset( $inboxes[ $inbox ] ) ) {
2019-03-14 23:10:11 +01:00
$inboxes[ $inbox ] = array();
}
$inboxes[ $inbox ][] = $follower;
}
2019-03-14 23:10:11 +01:00
return $inboxes;
2018-12-08 00:02:18 +01:00
}
function get_identifier_settings( $user_id ) {
?>
<table class="form-table">
<tbody>
<tr>
<th scope="row">
2019-09-27 10:12:59 +02:00
<label><?php \esc_html_e( 'Profile identifier', 'activitypub' ); ?></label>
</th>
<td>
2019-09-27 10:12:59 +02:00
<p><code><?php echo \esc_html( \Activitypub\get_webfinger_resource( $user_id ) ); ?></code> or <code><?php echo \esc_url( \get_author_posts_url( $user_id ) ); ?></code></p>
2019-03-14 23:10:11 +01:00
<?php // translators: the webfinger resource ?>
2022-12-05 17:45:56 +01:00
<p class="description"><?php \printf( \esc_html__( 'Try to follow "@%s" by searching for it on Mastodon,Friendica & Co.', 'activitypub' ), \esc_html( \Activitypub\get_webfinger_resource( $user_id ) ) ); ?></p>
</td>
</tr>
</tbody>
</table>
<?php
}
function get_followers( $user_id ) {
2019-11-18 20:57:00 +01:00
$followers = \Activitypub\Peer\Followers::get_followers( $user_id );
if ( ! $followers ) {
return array();
}
return $followers;
}
function count_followers( $user_id ) {
$followers = \Activitypub\get_followers( $user_id );
2019-09-27 10:12:59 +02:00
return \count( $followers );
}
2019-11-18 20:57:00 +01:00
/**
* Examine a url and try to determine the author ID it represents.
*
* Checks are supposedly from the hosted site blog.
*
* @param string $url Permalink to check.
*
* @return int User ID, or 0 on failure.
*/
function url_to_authorid( $url ) {
global $wp_rewrite;
// check if url hase the same host
2020-05-12 20:30:06 +02:00
if ( \wp_parse_url( \site_url(), \PHP_URL_HOST ) !== \wp_parse_url( $url, \PHP_URL_HOST ) ) {
2019-11-18 20:57:00 +01:00
return 0;
}
// first, check to see if there is a 'author=N' to match against
if ( \preg_match( '/[?&]author=(\d+)/i', $url, $values ) ) {
2020-05-12 20:30:06 +02:00
$id = \absint( $values[1] );
2019-11-18 20:57:00 +01:00
if ( $id ) {
return $id;
}
}
// check to see if we are using rewrite rules
$rewrite = $wp_rewrite->wp_rewrite_rules();
// not using rewrite rules, and 'author=N' method failed, so we're out of options
if ( empty( $rewrite ) ) {
return 0;
}
// generate rewrite rule for the author url
$author_rewrite = $wp_rewrite->get_author_permastruct();
$author_regexp = \str_replace( '%author%', '', $author_rewrite );
2019-11-18 20:57:00 +01:00
// match the rewrite rule with the passed url
if ( \preg_match( '/https?:\/\/(.+)' . \preg_quote( $author_regexp, '/' ) . '([^\/]+)/i', $url, $match ) ) {
2020-05-12 20:30:06 +02:00
$user = \get_user_by( 'slug', $match[2] );
2019-11-18 20:57:00 +01:00
if ( $user ) {
return $user->ID;
}
}
return 0;
}