← All changes | includes/class-activitypub.php +309 -240 1.2.0 → 9.2.1 View file →

		@@ -1,12 +1,20 @@
1	1	<?php
	2	+/**
	3	+ * ActivityPub Class.
	4	+ *
	5	+ * @package Activitypub
	6	+ */
	7	+
2	8	namespace Activitypub;
3	9
4		-use Activitypub\Signature;
5		-use Activitypub\Collection\Users;
	10	+use Activitypub\Collection\Followers;
	11	+use Activitypub\Collection\Following;
	12	+use Activitypub\Collection\Remote_Posts;
	13	+use Activitypub\OAuth\Client;
6	14
7	15	/**
8		- * ActivityPub Class
	16	+ * ActivityPub Class.
9	17	*
10	18	* @author Matthias Pfefferle
11	19	*/
12	20	class Activitypub {
		@@ -13,319 +21,380 @@
13	21	/**
14	22	* Initialize the class, registering WordPress hooks.
15	23	*/
16	24	public static function init() {
17		- \add_filter( 'template_include', array( self::class, 'render_json_template' ), 99 );
18		- \add_filter( 'query_vars', array( self::class, 'add_query_vars' ) );
19		- \add_filter( 'pre_get_avatar_data', array( self::class, 'pre_get_avatar_data' ), 11, 2 );
20		- \add_filter( 'get_comment_link', array( self::class, 'remote_comment_link' ), 11, 3 );
	25	+ \add_action( 'init', array( self::class, 'theme_compat' ), 11 );
	26	+ \add_action( 'init', array( self::class, 'register_user_meta' ), 11 );
21	27
22		- // Add support for ActivityPub to custom post types
23		- $post_types = \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) ) ? \get_option( 'activitypub_support_post_types', array( 'post', 'page' ) ) : array();
24		-
25		- foreach ( $post_types as $post_type ) {
26		- \add_post_type_support( $post_type, 'activitypub' );
27		- }
28		-
29	28	\add_action( 'wp_trash_post', array( self::class, 'trash_post' ), 1 );
30	29	\add_action( 'untrash_post', array( self::class, 'untrash_post' ), 1 );
31	30
32		- \add_action( 'init', array( self::class, 'add_rewrite_rules' ), 11 );
	31	+ \add_action( 'user_register', array( self::class, 'user_register' ) );
33	32
34		- \add_action( 'after_setup_theme', array( self::class, 'theme_compat' ), 99 );
35		-
36		- \add_action( 'in_plugin_update_message-' . ACTIVITYPUB_PLUGIN_BASENAME, array( self::class, 'plugin_update_message' ) );
	33	+ \add_action( 'activitypub_add_user_block', array( Followers::class, 'remove_blocked_actors' ), 10, 3 );
	34	+ \add_action( 'activitypub_add_user_block', array( Following::class, 'remove_blocked_actors' ), 10, 3 );
37	35	}
38	36
39	37	/**
40		- * Activation Hook
	38	+ * Activation Hook.
41	39	*
42		- * @return void
	40	+ * @param bool $network_wide Whether to activate the plugin for all sites in the network or just the current site.
43	41	*/
44		- public static function activate() {
	42	+ public static function activate( $network_wide ) {
45	43	self::flush_rewrite_rules();
	44	+ Scheduler::register_schedules();
46	45
47		- Scheduler::register_schedules();
	46	+ \add_filter( 'pre_wp_update_comment_count_now', array( Comment::class, 'pre_wp_update_comment_count_now' ), 5, 3 );
	47	+ Migration::update_comment_counts();
	48	+
	49	+ if ( \is_multisite() && $network_wide && ! \wp_is_large_network() ) {
	50	+ $sites = \get_sites( array( 'fields' => 'ids' ) );
	51	+ foreach ( $sites as $site ) {
	52	+ \switch_to_blog( $site );
	53	+ self::flush_rewrite_rules();
	54	+ \restore_current_blog();
	55	+ }
	56	+ }
48	57	}
49	58
50	59	/**
51		- * Deactivation Hook
	60	+ * Deactivation Hook.
52	61	*
53		- * @return void
	62	+ * @param bool $network_wide Whether to deactivate the plugin for all sites in the network or just the current site.
54	63	*/
55		- public static function deactivate() {
	64	+ public static function deactivate( $network_wide ) {
56	65	self::flush_rewrite_rules();
	66	+ Scheduler::deregister_schedules();
57	67
58		- Scheduler::deregister_schedules();
	68	+ \remove_filter( 'pre_wp_update_comment_count_now', array( Comment::class, 'pre_wp_update_comment_count_now' ), 5 );
	69	+ Migration::update_comment_counts( 2000 );
	70	+
	71	+ if ( \is_multisite() && $network_wide && ! \wp_is_large_network() ) {
	72	+ $sites = \get_sites( array( 'fields' => 'ids' ) );
	73	+ foreach ( $sites as $site ) {
	74	+ \switch_to_blog( $site );
	75	+ self::flush_rewrite_rules();
	76	+ \restore_current_blog();
	77	+ }
	78	+ }
59	79	}
60	80
61	81	/**
62		- * Uninstall Hook
63		- *
64		- * @return void
	82	+ * Uninstall Hook.
65	83	*/
66	84	public static function uninstall() {
67	85	Scheduler::deregister_schedules();
	86	+
	87	+ \remove_filter( 'pre_wp_update_comment_count_now', array( Comment::class, 'pre_wp_update_comment_count_now' ), 5 );
	88	+ Migration::update_comment_counts( 2000 );
	89	+
	90	+ Remote_Posts::delete_all();
	91	+ Tombstone::delete_all();
	92	+ Client::delete_all();
	93	+
	94	+ Options::delete();
68	95	}
69	96
70	97	/**
71		- * Return a AS2 JSON version of an author, post or page.
	98	+ * Store permalink in meta, to send delete Activity.
72	99	*
73		- * @param string $template The path to the template object.
	100	+ * @param string $post_id The Post ID.
	101	+ */
	102	+ public static function trash_post( $post_id ) {
	103	+ \add_post_meta(
	104	+ $post_id,
	105	+ '_activitypub_canonical_url',
	106	+ \get_permalink( $post_id ),
	107	+ true
	108	+ );
	109	+ }
	110	+
	111	+ /**
	112	+ * Delete permalink from meta.
74	113	*
75		- * @return string The new path to the JSON template.
	114	+ * @param string $post_id The Post ID.
76	115	*/
77		- public static function render_json_template( $template ) {
78		- if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
79		- return $template;
80		- }
81		-
82		- if ( ! is_activitypub_request() ) {
83		- return $template;
84		- }
85		-
86		- $json_template = false;
87		-
88		- // check if user can publish posts
89		- if ( \is_author() && is_wp_error( Users::get_by_id( \get_the_author_meta( 'ID' ) ) ) ) {
90		- return $template;
91		- }
92		-
93		- if ( \is_author() ) {
94		- $json_template = ACTIVITYPUB_PLUGIN_DIR . '/templates/author-json.php';
95		- } elseif ( \is_singular() ) {
96		- $json_template = ACTIVITYPUB_PLUGIN_DIR . '/templates/post-json.php';
97		- } elseif ( \is_home() ) {
98		- $json_template = ACTIVITYPUB_PLUGIN_DIR . '/templates/blog-json.php';
99		- }
100		-
101		- if ( ACTIVITYPUB_AUTHORIZED_FETCH ) {
102		- $verification = Signature::verify_http_signature( $_SERVER );
103		- if ( \is_wp_error( $verification ) ) {
104		- // fallback as template_loader can't return http headers
105		- return $template;
106		- }
107		- }
108		-
109		- return $json_template;
	116	+ public static function untrash_post( $post_id ) {
	117	+ \delete_post_meta( $post_id, '_activitypub_canonical_url' );
110	118	}
111	119
112	120	/**
113		- * Add the 'activitypub' query variable so WordPress won't mangle it.
	121	+ * Flush rewrite rules.
114	122	*/
115		- public static function add_query_vars( $vars ) {
116		- $vars[] = 'activitypub';
117		-
118		- return $vars;
	123	+ public static function flush_rewrite_rules() {
	124	+ Router::add_rewrite_rules();
	125	+ \flush_rewrite_rules();
119	126	}
120	127
121	128	/**
122		- * Replaces the default avatar.
	129	+ * Add rewrite rules.
123	130	*
124		- * @param array $args Arguments passed to get_avatar_data(), after processing.
125		- * @param int|string|object $id_or_email A user ID, email address, or comment object.
126		- *
127		- * @return array $args
	131	+ * @deprecated 7.5.0 Use {@see Router::add_rewrite_rules()}.
128	132	*/
129		- public static function pre_get_avatar_data( $args, $id_or_email ) {
130		- if (
131		- ! $id_or_email instanceof \WP_Comment ||
132		- ! isset( $id_or_email->comment_type ) ||
133		- $id_or_email->user_id
134		- ) {
135		- return $args;
136		- }
	133	+ public static function add_rewrite_rules() {
	134	+ \_deprecated_function( __FUNCTION__, '7.5.0', '\Activitypub\Router::add_rewrite_rules()' );
137	135
138		- $allowed_comment_types = \apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
139		- if (
140		- ! empty( $id_or_email->comment_type ) &&
141		- ! \in_array(
142		- $id_or_email->comment_type,
143		- (array) $allowed_comment_types,
144		- true
145		- )
146		- ) {
147		- $args['url'] = false;
148		- /** This filter is documented in wp-includes/link-template.php */
149		- return \apply_filters( 'get_avatar_data', $args, $id_or_email );
150		- }
151		-
152		- // Check if comment has an avatar.
153		- $avatar = self::get_avatar_url( $id_or_email->comment_ID );
154		-
155		- if ( $avatar ) {
156		- if ( ! isset( $args['class'] ) || ! \is_array( $args['class'] ) ) {
157		- $args['class'] = array( 'u-photo' );
158		- } else {
159		- $args['class'][] = 'u-photo';
160		- $args['class'] = \array_unique( $args['class'] );
161		- }
162		- $args['url'] = $avatar;
163		- $args['class'][] = 'avatar-activitypub';
164		- }
165		-
166		- return $args;
	136	+ Router::add_rewrite_rules();
167	137	}
168	138
169	139	/**
170		- * Function to retrieve Avatar URL if stored in meta.
171		- *
172		- * @param int|WP_Comment $comment
173		- *
174		- * @return string $url
	140	+ * Theme compatibility stuff.
175	141	*/
176		- public static function get_avatar_url( $comment ) {
177		- if ( \is_numeric( $comment ) ) {
178		- $comment = \get_comment( $comment );
	142	+ public static function theme_compat() {
	143	+ // We assume that you want to use Post-Formats when enabling the setting.
	144	+ if ( 'wordpress-post-format' === \get_option( 'activitypub_object_type', ACTIVITYPUB_DEFAULT_OBJECT_TYPE ) ) {
	145	+ if ( ! \get_theme_support( 'post-formats' ) ) {
	146	+ // Add support for the Aside, Gallery Post Formats...
	147	+ \add_theme_support(
	148	+ 'post-formats',
	149	+ array(
	150	+ 'gallery',
	151	+ 'status',
	152	+ 'image',
	153	+ 'video',
	154	+ 'audio',
	155	+ )
	156	+ );
	157	+ }
179	158	}
180		- return \get_comment_meta( $comment->comment_ID, 'avatar_url', true );
181	159	}
182	160
183	161	/**
184		- * Link remote comments to source url.
	162	+ * Add the 'activitypub' capability to users who can publish posts.
185	163	*
186		- * @param string $comment_link
187		- * @param object|WP_Comment $comment
188		- *
189		- * @return string $url
	164	+ * @param int $user_id User ID.
190	165	*/
191		- public static function remote_comment_link( $comment_link, $comment ) {
192		- $remote_comment_link = get_comment_meta( $comment->comment_ID, 'source_url', true );
193		- if ( $remote_comment_link ) {
194		- $comment_link = esc_url( $remote_comment_link );
	166	+ public static function user_register( $user_id ) {
	167	+ if ( \user_can( $user_id, 'publish_posts' ) ) {
	168	+ $user = \get_user_by( 'id', $user_id );
	169	+ $user->add_cap( 'activitypub' );
195	170	}
196		- return $comment_link;
197	171	}
198	172
199	173	/**
200		- * Store permalink in meta, to send delete Activity.
201		- *
202		- * @param string $post_id The Post ID.
203		- *
204		- * @return void
	174	+ * Register user meta.
205	175	*/
206		- public static function trash_post( $post_id ) {
207		- \add_post_meta(
208		- $post_id,
209		- 'activitypub_canonical_url',
210		- \get_permalink( $post_id ),
211		- true
	176	+ public static function register_user_meta() {
	177	+ $blog_prefix = $GLOBALS['wpdb']->get_blog_prefix();
	178	+
	179	+ \register_meta(
	180	+ 'user',
	181	+ $blog_prefix . 'activitypub_also_known_as',
	182	+ array(
	183	+ 'type' => 'array',
	184	+ 'description' => 'An array of URLs that the user is known by.',
	185	+ 'single' => true,
	186	+ 'default' => array(),
	187	+ 'sanitize_callback' => array( Sanitize::class, 'identifier_list' ),
	188	+ )
212	189	);
213		- }
214	190
215		- /**
216		- * Delete permalink from meta
217		- *
218		- * @param string $post_id The Post ID
219		- *
220		- * @return void
221		- */
222		- public static function untrash_post( $post_id ) {
223		- \delete_post_meta( $post_id, 'activitypub_canonical_url' );
224		- }
	191	+ \register_meta(
	192	+ 'user',
	193	+ $blog_prefix . 'activitypub_hide_social_graph',
	194	+ array(
	195	+ 'type' => 'integer',
	196	+ 'description' => 'Hide Followers and Followings on Profile.',
	197	+ 'single' => true,
	198	+ 'default' => 0,
	199	+ 'sanitize_callback' => 'absint',
	200	+ 'show_in_rest' => true,
	201	+ )
	202	+ );
225	203
226		- /**
227		- * Add rewrite rules
228		- */
229		- public static function add_rewrite_rules() {
230		- // If another system needs to take precedence over the ActivityPub rewrite rules,
231		- // they can define their own and will manually call the appropriate functions as required.
232		- if ( ACTIVITYPUB_DISABLE_REWRITES ) {
233		- return;
234		- }
	204	+ \register_meta(
	205	+ 'user',
	206	+ $blog_prefix . 'activitypub_old_host_data',
	207	+ array(
	208	+ 'description' => 'Actor object for the user on the old host.',
	209	+ 'single' => true,
	210	+ )
	211	+ );
235	212
236		- if ( ! \class_exists( 'Webfinger' ) ) {
237		- \add_rewrite_rule(
238		- '^.well-known/webfinger',
239		- 'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/webfinger',
240		- 'top'
241		- );
242		- }
	213	+ \register_meta(
	214	+ 'user',
	215	+ $blog_prefix . 'activitypub_moved_to',
	216	+ array(
	217	+ 'type' => 'string',
	218	+ 'description' => 'The new URL of the user.',
	219	+ 'single' => true,
	220	+ 'sanitize_callback' => 'sanitize_url',
	221	+ )
	222	+ );
243	223
244		- if ( ! \class_exists( 'Nodeinfo_Endpoint' ) && true === (bool) \get_option( 'blog_public', 1 ) ) {
245		- \add_rewrite_rule(
246		- '^.well-known/nodeinfo',
247		- 'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/nodeinfo/discovery',
248		- 'top'
249		- );
250		- \add_rewrite_rule(
251		- '^.well-known/x-nodeinfo2',
252		- 'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/nodeinfo2',
253		- 'top'
254		- );
255		- }
	224	+ \register_meta(
	225	+ 'user',
	226	+ $blog_prefix . 'activitypub_description',
	227	+ array(
	228	+ 'type' => 'string',
	229	+ 'description' => 'The user description.',
	230	+ 'single' => true,
	231	+ 'default' => '',
	232	+ 'sanitize_callback' => static function ( $value ) {
	233	+ return \wp_kses( $value, 'user_description' );
	234	+ },
	235	+ )
	236	+ );
256	237
257		- \add_rewrite_rule(
258		- '^@([\w\-\.]+)',
259		- 'index.php?rest_route=/' . ACTIVITYPUB_REST_NAMESPACE . '/users/$matches[1]',
260		- 'top'
	238	+ \register_meta(
	239	+ 'user',
	240	+ $blog_prefix . 'activitypub_icon',
	241	+ array(
	242	+ 'type' => 'integer',
	243	+ 'description' => 'The attachment ID for user profile image.',
	244	+ 'single' => true,
	245	+ 'default' => 0,
	246	+ 'sanitize_callback' => 'absint',
	247	+ )
261	248	);
262	249
263		- \add_rewrite_endpoint( 'activitypub', EP_AUTHORS | EP_PERMALINK | EP_PAGES );
264		- }
	250	+ \register_meta(
	251	+ 'user',
	252	+ $blog_prefix . 'activitypub_header_image',
	253	+ array(
	254	+ 'type' => 'integer',
	255	+ 'description' => 'The attachment ID for the user header image.',
	256	+ 'single' => true,
	257	+ 'default' => 0,
	258	+ 'sanitize_callback' => 'absint',
	259	+ )
	260	+ );
265	261
266		- /**
267		- * Flush rewrite rules;
268		- */
269		- public static function flush_rewrite_rules() {
270		- self::add_rewrite_rules();
271		- \flush_rewrite_rules();
272		- }
	262	+ \register_meta(
	263	+ 'user',
	264	+ $blog_prefix . 'activitypub_mailer_new_dm',
	265	+ array(
	266	+ 'type' => 'integer',
	267	+ 'description' => 'Send a notification when someone sends this user a direct message.',
	268	+ 'single' => true,
	269	+ 'sanitize_callback' => 'absint',
	270	+ )
	271	+ );
	272	+ \add_filter( 'get_user_option_activitypub_mailer_new_dm', array( self::class, 'user_options_default' ) );
273	273
274		- /**
275		- * Theme compatibility stuff
276		- *
277		- * @return void
278		- */
279		- public static function theme_compat() {
280		- $site_icon = get_theme_support( 'custom-logo' );
	274	+ \register_meta(
	275	+ 'user',
	276	+ $blog_prefix . 'activitypub_mailer_new_follower',
	277	+ array(
	278	+ 'type' => 'integer',
	279	+ 'description' => 'Send a notification when someone starts to follow this user.',
	280	+ 'single' => true,
	281	+ 'sanitize_callback' => 'absint',
	282	+ )
	283	+ );
	284	+ \add_filter( 'get_user_option_activitypub_mailer_new_follower', array( self::class, 'user_options_default' ) );
281	285
282		- if ( ! $site_icon ) {
283		- // custom logo support
284		- add_theme_support(
285		- 'custom-logo',
286		- array(
287		- 'height' => 80,
288		- 'width' => 80,
289		- )
290		- );
291		- }
	286	+ \register_meta(
	287	+ 'user',
	288	+ $blog_prefix . 'activitypub_mailer_new_mention',
	289	+ array(
	290	+ 'type' => 'integer',
	291	+ 'description' => 'Send a notification when someone mentions this user.',
	292	+ 'single' => true,
	293	+ 'sanitize_callback' => 'absint',
	294	+ )
	295	+ );
	296	+ \add_filter( 'get_user_option_activitypub_mailer_new_mention', array( self::class, 'user_options_default' ) );
292	297
293		- $custom_header = get_theme_support( 'custom-header' );
	298	+ \register_meta(
	299	+ 'user',
	300	+ $blog_prefix . 'activitypub_mailer_annual_report',
	301	+ array(
	302	+ 'type' => 'integer',
	303	+ 'description' => 'Send the annual Fediverse Year in Review email.',
	304	+ 'single' => true,
	305	+ 'sanitize_callback' => 'absint',
	306	+ )
	307	+ );
	308	+ \add_filter( 'get_user_option_activitypub_mailer_annual_report', array( self::class, 'user_options_default' ) );
294	309
295		- if ( ! $custom_header ) {
296		- // This theme supports a custom header
297		- $custom_header_args = array(
298		- 'width' => 1250,
299		- 'height' => 600,
300		- 'header-text' => true,
301		- );
302		- add_theme_support( 'custom-header', $custom_header_args );
303		- }
	310	+ \register_meta(
	311	+ 'user',
	312	+ $blog_prefix . 'activitypub_mailer_monthly_report',
	313	+ array(
	314	+ 'type' => 'integer',
	315	+ 'description' => 'Send a monthly Fediverse stats report email.',
	316	+ 'single' => true,
	317	+ 'sanitize_callback' => 'absint',
	318	+ )
	319	+ );
	320	+
	321	+ \register_meta(
	322	+ 'user',
	323	+ 'activitypub_show_welcome_tab',
	324	+ array(
	325	+ 'type' => 'integer',
	326	+ 'description' => 'Whether to show the welcome tab.',
	327	+ 'single' => true,
	328	+ 'default' => 1,
	329	+ 'sanitize_callback' => 'absint',
	330	+ )
	331	+ );
	332	+
	333	+ \register_meta(
	334	+ 'user',
	335	+ 'activitypub_show_advanced_tab',
	336	+ array(
	337	+ 'type' => 'integer',
	338	+ 'description' => 'Whether to show the advanced tab.',
	339	+ 'single' => true,
	340	+ 'default' => 0,
	341	+ 'sanitize_callback' => 'absint',
	342	+ )
	343	+ );
	344	+
	345	+ // Moderation user meta.
	346	+ \register_meta(
	347	+ 'user',
	348	+ 'activitypub_blocked_actors',
	349	+ array(
	350	+ 'type' => 'array',
	351	+ 'description' => 'User-specific blocked ActivityPub actors.',
	352	+ 'single' => true,
	353	+ 'default' => array(),
	354	+ 'sanitize_callback' => array( Sanitize::class, 'identifier_list' ),
	355	+ )
	356	+ );
	357	+
	358	+ \register_meta(
	359	+ 'user',
	360	+ 'activitypub_blocked_domains',
	361	+ array(
	362	+ 'type' => 'array',
	363	+ 'description' => 'User-specific blocked ActivityPub domains.',
	364	+ 'single' => true,
	365	+ 'default' => array(),
	366	+ 'sanitize_callback' => static function ( $value ) {
	367	+ return \array_unique( \array_map( array( Sanitize::class, 'host_list' ), $value ) );
	368	+ },
	369	+ )
	370	+ );
	371	+
	372	+ \register_meta(
	373	+ 'user',
	374	+ 'activitypub_blocked_keywords',
	375	+ array(
	376	+ 'type' => 'array',
	377	+ 'description' => 'User-specific blocked ActivityPub keywords.',
	378	+ 'single' => true,
	379	+ 'default' => array(),
	380	+ 'sanitize_callback' => static function ( $value ) {
	381	+ return \array_map( 'sanitize_text_field', $value );
	382	+ },
	383	+ )
	384	+ );
304	385	}
305	386
306	387	/**
307		- * Display plugin upgrade notice to users
	388	+ * Set default values for user options.
308	389	*
309		- * @param array $data The plugin data
310		- *
311		- * @return void
	390	+ * @param bool|string $value Option value.
	391	+ * @return bool|string
312	392	*/
313		- public static function plugin_update_message( $data ) {
314		- if ( ! isset( $data['upgrade_notice'] ) ) {
315		- return;
	393	+ public static function user_options_default( $value ) {
	394	+ if ( false === $value ) {
	395	+ return '1';
316	396	}
317	397
318		- printf(
319		- '<div class="update-message">%s</div>',
320		- wp_kses(
321		- wpautop( $data['upgrade_notice '] ),
322		- array(
323		- 'p' => array(),
324		- 'a' => array( 'href', 'title' ),
325		- 'strong' => array(),
326		- 'em' => array(),
327		- )
328		- )
329		- );
	398	+ return $value;
330	399	}
331	400	}