135 lines
5.3 KiB
Text
135 lines
5.3 KiB
Text
=== Media Audit (by ROBOTSTXT) ===
|
|
Contributors: javiercasares, robotstxt
|
|
Tags: media, copyright, images, reverse image search, media library
|
|
Requires at least: 6.8
|
|
Tested up to: 7.0
|
|
Requires PHP: 8.2
|
|
Requires Plugins: action-scheduler
|
|
Stable tag: 1.3.0
|
|
License: GPL-3.0-or-later
|
|
License URI: https://www.gnu.org/licenses/gpl-3.0.txt
|
|
|
|
Audit your media library for copyright risks: track internal usage and run reverse image search via Google Vision and TinEye.
|
|
|
|
== Description ==
|
|
|
|
Media Audit helps site owners and editors understand where their media files are used and whether those files appear elsewhere on the internet — a key signal for detecting potential copyright violations.
|
|
|
|
= Features =
|
|
|
|
* **Internal usage scan** — identifies every post, page, and custom post type that references each attachment as featured image, inline content, or post meta.
|
|
* **External reverse image search** — submits images to Google Cloud Vision (Web Detection) and TinEye Commercial API to find matching pages across the web.
|
|
* **Consensus detection** — surfaces domains independently confirmed by multiple providers, providing stronger copyright-risk signals.
|
|
* **Audit list** — filterable admin page showing each attachment's external scan status and top matching domains.
|
|
* **WP-CLI support** — run or schedule scans from the command line.
|
|
* **GDPR compliance** — full WordPress privacy API integration for personal data export and erasure on request.
|
|
* **Async processing** — all scanning runs via Action Scheduler to avoid blocking web requests.
|
|
|
|
= Requirements =
|
|
|
|
* [Action Scheduler](https://actionscheduler.org/) plugin (declared as a required dependency).
|
|
* Google Cloud Vision API key (for Web Detection scanning).
|
|
* TinEye Commercial API key (for reverse image search).
|
|
|
|
== Using the plugin ==
|
|
|
|
= WP-CLI =
|
|
|
|
Install tables manually (normally handled on activation):
|
|
|
|
wp mra install
|
|
|
|
Show current index and scan status:
|
|
|
|
wp mra status
|
|
|
|
Run an internal usage scan (queues a batch):
|
|
|
|
wp mra scan-internal [--batch=<n>]
|
|
|
|
Run an external reverse image search (queues a batch):
|
|
|
|
wp mra scan-external [--batch=<n>]
|
|
|
|
= Extension hooks =
|
|
|
|
* `mra/internal/scanner/post_types` — filter the post types included in the internal usage scan.
|
|
* `mra/internal/scanner/meta_keys` — filter the meta keys inspected during the internal scan.
|
|
* `mra/external/providers` — register additional external scan providers.
|
|
|
|
== Installation ==
|
|
|
|
= Automatic download =
|
|
|
|
Visit the plugin section in your WordPress admin, search for "Media Audit"; download and install the plugin.
|
|
|
|
= Manual download =
|
|
|
|
Extract the contents of the ZIP and upload the folder to `/wp-content/plugins/robotstxt-mediaaudit/`. Once uploaded it will appear in your plugin list.
|
|
|
|
After activation, visit **Media Audit → Settings** to enter your API credentials.
|
|
|
|
== Frequently Asked Questions ==
|
|
|
|
= Do I need both Google Vision and TinEye keys? =
|
|
|
|
No. The plugin works with either provider configured. Results will only be collected from providers with a valid API key.
|
|
|
|
= Will scanning slow down my site? =
|
|
|
|
No. All scans are queued and processed asynchronously by Action Scheduler in small batches.
|
|
|
|
= What is consensus detection? =
|
|
|
|
When the same domain appears independently in both Google Vision and TinEye results for the same image, it is flagged as a consensus match — a stronger copyright-risk signal than a single-provider finding.
|
|
|
|
= Is data deleted when I uninstall? =
|
|
|
|
By default, no. Enable **Settings → Delete data on uninstall** if you want all plugin tables and options removed on uninstall.
|
|
|
|
== Compatibility ==
|
|
|
|
* WordPress: 6.8 - 7.0
|
|
* PHP: 8.2 - 8.4
|
|
* WP-CLI: 2.x
|
|
* Requires Plugins: action-scheduler
|
|
|
|
== Changelog ==
|
|
|
|
Only the 3 latest versions. The full changelog is in [changelog.txt](changelog.txt).
|
|
|
|
= 1.3.0 =
|
|
|
|
* Added per-provider scan tracking table (`mra_provider_status`) so each API is tracked independently.
|
|
* Added "Sync providers" operation: registers newly configured providers for all existing attachments without rescanning already-completed work.
|
|
* Changed `mra_external_results.provider` from a fixed ENUM to `varchar(100)` for extensibility.
|
|
* DB schema bumped to 1.1.0 with an automatic migration on update.
|
|
|
|
= 1.2.0 =
|
|
|
|
* Added browser-based AJAX scan runner in the Tools page (runs without WP-Cron or Action Scheduler).
|
|
* Added "Requeue scan errors" operation to retry failed external scans after fixing API key issues.
|
|
* Added "Last Scanned" column in the audit list, sortable with NULLs-last ordering.
|
|
* Added bulk action to export external scan results as a CSV file.
|
|
|
|
= 1.1.0 =
|
|
|
|
* Updated plugin URI, author, and contributor metadata.
|
|
|
|
= 1.0.0 =
|
|
|
|
* First stable release. Internal usage scanning, external reverse image search (Google Vision + TinEye), consensus detection, WP-CLI commands, GDPR privacy tools, and Spanish/Catalan translations.
|
|
|
|
= Previous versions =
|
|
|
|
See [changelog.txt](changelog.txt) for the full history.
|
|
|
|
== Compliance ==
|
|
|
|
This plugin adheres to the following security measures and review protocols for each version:
|
|
|
|
* [WordPress Plugin Handbook](https://developer.wordpress.org/plugins/)
|
|
* [WordPress Plugin Security](https://developer.wordpress.org/plugins/wordpress-org/plugin-security/)
|
|
* [WordPress APIs Security](https://developer.wordpress.org/apis/security/)
|
|
* [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards)
|
|
* [Plugin Check (PCP)](https://wordpress.org/plugins/plugin-check/)
|