-
Couldn't load subscription status.
- Fork 84
Add Attachments processor class for handling ActivityPub media #2314
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: trunk
Are you sure you want to change the base?
Conversation
Introduces a new 'ap_object' post type and related taxonomies for handling ActivityPub objects, including registration, CRUD operations, and taxonomy management. Updates create and update handlers to process non-interaction objects using the new Objects collection. Enhances debug functionality to support the new post type and taxonomies.
Introduced Sanitize::content() to process and format content for ActivityPub, including block support and HTML sanitization. Updated Objects class to use the new sanitizer for post content.
Introduces a new Blocks::html_to_blocks() method to convert HTML content into block format using DOMDocument parsing and block mapping. Refactors Sanitize to use this new method, replacing the previous regex-based paragraph splitting logic for improved accuracy and maintainability.
The get_node_attributes private method was removed and the logic for setting the 'ordered' attribute on 'ol' nodes is now handled inline. This simplifies the code by reducing indirection and focusing only on the required attribute for ordered lists.
Refactored the Blocks class by renaming the html_to_blocks method to convert_from_html for improved clarity. Updated all references to use the new method name.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Introduces new PHPUnit tests for content sanitization in Sanitize::content, covering scenarios such as block support, malicious content, URLs, empty content, and safe HTML preservation. Also adds a test for Blocks::convert_from_html to verify HTML-to-block conversion when blocks are supported.
Introduces tests to verify content sanitization in Create handler, handling of private activities, and behavior with malformed object data. Also ensures required post types are registered during test setup.
Introduces a comprehensive PHPUnit test suite for the Activitypub\Collection\Objects class, covering object addition, updating, retrieval by GUID, and activity-to-post conversion, including edge cases and error handling. Mocks HTTP requests for remote actor fetching and ensures correct post type registration for test isolation.
Renamed update_actor and update_object to handle_actor_update and handle_object_update for improved clarity and consistency. Combined logic for handling object and interaction updates into handle_object_update. Updated corresponding test method names to match the new handler method names.
Changed the PHPUnit @Covers annotation from ::update_actor to ::handle_actor_update in Test_Update to accurately reflect the method being tested.
Changed the post type labels in the registration array from 'Posts'/'Post' to 'Objects'/'Object' to better reflect the content type.
Inserted a blank line after the use statements in class-update.php to improve code readability and adhere to coding standards.
Deleted the Blocks::convert_from_html method and its related test, and updated the Sanitize class to no longer convert HTML content to blocks. This simplifies content sanitization by removing automatic block conversion.
Refactored the Objects collection to Posts, updating class names, constants, and references in all relevant files. Adjusted post type from 'ap_object' to 'ap_post' and updated related taxonomy registrations, handlers, and tests to reflect the new naming convention. This improves clarity and consistency in the codebase.
Refactored the method name from create_object to create_post to better reflect its purpose of handling post creation. Updated all relevant references and docblocks for clarity.
Changed the @Covers annotation from ::create_object to ::create_post in the test_handle_create_object_with_sanitization method to accurately reflect the method being tested.
Adds registration of the '_activitypub_remote_actor_id' post meta for the custom post type, storing the local ID of the remote actor that created the object. This includes type enforcement, a description, and a sanitize callback.
The 'ap_object_type' taxonomy has been added to the registered taxonomies array for the relevant post type, allowing posts to be associated with both 'ap_tag' and 'ap_object_type'.
Deleted the 'labels' arrays from the registration of 'ap_tag' and 'ap_object_type' taxonomies. This will cause WordPress to use default labels for these taxonomies.
Eliminated the 'rewrite' arguments for 'ap_tag' and 'ap_object_type' taxonomies, reverting to default rewrite behavior. This may affect the URLs generated for these taxonomies.
Refactors the method name from handle_actor_update to update_actor for clarity and updates all references accordingly.
Renamed the test method from test_handle_actor_update to test_update_actor and updated the @Covers annotation and method calls to reference update_actor instead of handle_actor_update. This aligns the test with the updated function name.
Initializes $result as WP_Error by default and updates the docblock for the 'activitypub_handled_update' action to specify more precise types for the $result parameter. Removes unreachable assignment in the comment update branch.
Adds explicit WP_Error objects when Create or Update operations fail, ensuring consistent error reporting. Also updates the docblock for the Create handler to reflect possible result types.
Moved the default WP_Error assignment to the start of handle_object_update, ensuring $result is always initialized. Removed redundant error assignment after update attempts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
For example, if the hosting policy offers unlimited databases but only 1 GB of storage space, would that still be sufficient for normal use? |
|
Pardon me! This works like a charm and I simply messed up my test! |
The previous method name 'process' was too vague and didn't clearly convey what the method does. The new name 'import' better reflects that the method downloads and imports external attachments from ActivityPub objects into the WordPress media library. Updates all method calls and @Covers annotations in tests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Refactored Attachments class to rename the private method process_inline_images to import_inline_images for clarity. Updated all references and related test to use the new method name.
Replaces the use of the short ternary operator with the get() method's default value parameter for retrieving 'meta_query' in the Attachments class. This improves code clarity and consistency.
|
I haven't reviewed that, but just by reading the title and desc, does this also target #1914 ? |
|
@Menrath Personally, I think it’s better to handle post-type objects like
However, I’m not entirely sure whether it’s truly necessary to parse the That’s why I suggested that direct file links should be treated as hotlinks, In any case, implementing remote media local caching now could still be useful later, I wanted to suggest that WordPress could independently implement a |
|
@pfefferle This should be ready for another look when you get a chance |
|
I discovered something quite shocking: you should never use an |
|
Why do you use the word "shocking" in this regards! I can't see why this is shocking! |
|
@Jiwoon-Kim can you please stop using clickbaity titles/wordings like that! |
|
I’m sorry about that. I had just finished reviewing all the related object types, properties, and endpoints, and the conclusion I reached was honestly quite shocking to me personally. I wrote the post before I had fully calmed down from that excitement. |
|
If you think there is something wrong with the implementation, please file a bug! Explain the issue, be precise and link to the relevant code/documentation! |
|
@obenland What about hooking the Attachment importer into Not every user has enough storage or maybe uses a different form of caching, so it might be nice to be able to unhook the caching mechanism!? |
|
I will make my final statement regarding this PR. I believe the media upload mechanism should be perfectly symmetrical with the remote media object/file caching process.
|
|
@Jiwoon-Kim as I already tried to explain to you multiple times: this is not about "uploading" data! we are working on S2S communication, not on C2S! this is a simple local caching of remote images that are part of a post ( |
Fixes #2277
Proposed changes:
This PR introduces a new
Attachmentsprocessor class that provides unified handling of ActivityPub attachments (images, videos, audio, documents) for both remote URLs and local files.Attachmentsclass centralizes all attachment handling logic previously scattered across multiple classesmedia_handle_sideload()Other information:
Testing instructions:
Test remote attachments (ActivityPub network):
namefield is preserved as image alt textTest local attachments (Mastodon import):
Test Classic Editor integration:
activitypub_attachments_media_markupfilter for custom markupRun automated tests:
All tests should pass, including the 14 new tests in
class-test-attachments.php.Changelog entry
Changelog Entry Details
Significance
Type
Message
Add unified attachment processor for handling ActivityPub media imports from both remote URLs and local files, with automatic media block generation and Classic Editor support.