Palasthotel Integration for ProLitteris (WordPress-Plugin)

Counting pixels and automated text reports for "Onlinewerke entschädigen" (Verteilung Online) of ProLitteris, the Swiss collective rights management organization. Until 1.6.4 the plugin was called "ProLitteris" (pro-litteris); see Moving from pro-litteris.

On WordPress.org: palasthotel-integration-for-prolitteris (from 2.0.0).

What it does

• keeps a pool of unassigned counting pixels, refilled hourly from the ProLitteris web service (POST /rest/api/1/pixel)
• assigns a pixel to a post when an editor opens it or the post is read through the REST API, and renders it in wp_footer together with the referrer meta tag ProLitteris requires
• builds the report from title, plain text (via html2text), authors and image originators and sends it (POST /rest/api/1/message) - from the editor sidebar, automatically every hour, or with WP-CLI
• user profile fields for the ProLitteris member number, first and last name; an image originator field on attachments
• a ProLitteris column in the posts list and a dashboard widget for the pixel pool

Configuration

Settings → ProLitteris, or constants in wp-config.php, which win over the settings page:

Nothing is requested from ProLitteris before the integration is enabled and has credentials. The password entered on the settings page is stored in the options table and never sent back to the browser.

REST

pro_litteris on every enabled post type. Users who cannot edit the post - visitors included - get the pixel only:

{ "pixel": { "uid": "…", "domain": "…", "url": "https://…/na/…" } }

Editors additionally get message (the stored report) or messageDraft (title, participants, plain text), and pushError/pushErrorData. Writing {"pro_litteris": {"pushMessage": true}} reports a published or private post; it needs the post type's publish_posts capability.

pro_litteris_author on attachments (editors only): the image originator's user id.

Hooks

The names are constants of Palasthotel\ProLitteris\Plugin.

add_filter( \Palasthotel\ProLitteris\Plugin::FILTER_POST_TYPES, fn( $types ) => [ ...$types, 'news' ] );

WP-CLI

wp pro-litteris refillPool [--to=<size>]
wp pro-litteris reportContents --year=<year>

Moving from pro-litteris

Version 2.0.0 has a new folder (palasthotel-integration-for-prolitteris), main file and text domain. PHP namespace, class names, hooks, REST fields, options, post and user meta and the database tables are unchanged, so pixels, reports and project code keep working.

1. Rename the constants in wp-config.php - the old names are no longer read, so without this the integration stays switched off:

   up to 1.6.4	from 2.0.0
   PH_PRO_LITTERIS	PRO_LITTERIS_ENABLED
   PH_PRO_LITTERIS_SYSTEM	PRO_LITTERIS_SYSTEM
   PH_PRO_LITTERIS_CREDENTIALS	PRO_LITTERIS_CREDENTIALS
   PRO_LITTERIS_AUTO_MESSAGES	unchanged

2. Install the new plugin.

3. Deactivate "ProLitteris", then activate "Palasthotel Integration for ProLitteris". As long as the old one is active, the new one does not load and says so in wp-admin.

4. Delete the old plugin.

Repository layout

public/ is exactly what ships to WordPress.org. Everything outside it is repository-only.

Development

npm ci
npm run build                                   # → public/dist/
(cd public && composer install)                 # → public/vendor/
npx wp-env start                                # http://localhost:8888, admin / password
npm run pack                                    # → build/palasthotel-integration-for-prolitteris/ and the zip

npm run pack runs the shared pack.sh from palasthotel/github-workflows, which has to be checked out next to this repository.

Releasing

Releases are automated with release-please and deployed to the WordPress.org SVN repository. Commit with conventional commits and merge the release PR:

fix: …   → patch    feat: …  → minor    feat!: … → major

What is specific to this plugin is in .github/WORKFLOWS.md, commit conventions in CONTRIBUTING.md.

License

GNU General Public License v3.0 or later - see LICENSE. This plugin is not affiliated with or endorsed by ProLitteris.