{"id":22051,"date":"2022-05-15T20:36:34","date_gmt":"2022-05-15T18:36:34","guid":{"rendered":"https:\/\/notiz.blog\/?p=22051"},"modified":"2024-03-08T16:00:28","modified_gmt":"2024-03-08T15:00:28","slug":"wpsr","status":"publish","type":"post","link":"https:\/\/notiz.blog\/2022\/05\/15\/wpsr\/","title":{"rendered":"WPSR"},"content":{"rendered":"\n

Auf dem CloudFest Hackathon<\/a> im M\u00e4rz, hab‘ ich mich ein wenig mit Alain Schlesser<\/a> \u00fcber WordPress und Plugin-Entwicklung unterhalten. Alain meinte, dass er, wenn es das Plugin hergibt und es zeitlich m\u00f6glich ist, immer zuerst eine generische Library bauen und diese dann \u00fcber ein WordPress-Plugin implementieren w\u00fcrde.<\/p>\n\n\n\n

Vor ein paar Tagen hab ich mich an unser Gespr\u00e4ch erinnert, weil ich mich (aus Gr\u00fcnden) wieder intensiver mit dem ActivityPub-Plugin<\/a> besch\u00e4ftigt habe. Wir hatten schon vor einem Jahr den Plan, eine ActivityPub-Bibliothek<\/a> zu verwenden, um uns nicht mit dem Protokoll besch\u00e4ftigen zu m\u00fcssen, und uns so voll und ganz auf die WordPress Integration konzentrieren k\u00f6nn(t)en. Wir haben die Idee aber erstmal nicht weiter verfolgt, da die Bibliothek eine Reihe von schwergewichtigen Third-Party-Libs<\/a> wie Guzzle (HTTP-Client)<\/a>, Monolog (Logger)<\/a> oder Symfony Cache (Caching)<\/a> mit sich bringt. F\u00fcr all diese Funktionen hat WordPress eigene L\u00f6sungen und wegen der Interoperabilit\u00e4t mit anderen Plugins, sollte man diese auch nutzen.<\/p>\n\n\n\n

Bei der erneuten Evaluierung der ActivityPub-Bibliothek ist mir aufgefallen, dass sich Monolog, durch einen beliebigen PSR-3 kompatiblen Logger ersetzen l\u00e4sst.<\/p>\n\n\n\n

Kurze Erkl\u00e4rung zu PSR<\/a>:<\/p>\n\n\n\n

\n

Eine PHP Standard Recommendation (PSR) ist eine PHP-Spezifikation, welche durch die PHP Framework Interop Group ver\u00f6ffentlicht wird. \u00c4hnlich einem Java Specification Request in Java dient sie der Standardisierung von Programmierkonzepten. Ziel ist es die Interoperabilit\u00e4t von Komponenten zu erm\u00f6glichen und eine gemeinsame technische Basis zu schaffen oder bew\u00e4hrte Konzepte f\u00fcr einen guten Programmierstil sowie eine gute Testbarkeit von Komponenten umzusetzen. Verschiedene Frameworks wie z. B. die der TYPO3-Community, Symfony oder Zend implementieren hierbei PSR-Spezifikationen in einem selbst gew\u00e4hlten Umfang.<\/p>\nhttps:\/\/de.wikipedia.org\/wiki\/PHP_Standard_Recommendation<\/a><\/cite><\/blockquote>\n\n\n\n

PSR-3<\/a> definiert ein standardisiertes Logger-Interface, welches (in unserem Beispiel) durch Monolog implementiert wird. Beim initialisieren des ActivityPub-Servers, l\u00e4sst sich Monolog, durch einen alternativen Logger ersetzen, solange dieser auch PSR-3 konform ist.<\/p>\n\n\n

use<\/span> ActivityPhp<\/span>\\Server<\/span>;\n\n\/\/ Create a server instance with no log output<\/span>\n$server = new<\/span> Server([\n    'logger'<\/span>   => [\n        'driver'<\/span> => '\\Psr\\Log\\NullLogger'<\/span>\n    ],\n]);<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
namespace<\/span> WPPSR<\/span>\\Log<\/span>;\n\nuse<\/span> Psr<\/span>\\Log<\/span>\\AbstractLogger<\/span>;\n\nclass<\/span> ErrorLogLogger<\/span> extends<\/span> AbstractLogger<\/span> <\/span>{\n    public<\/span> function<\/span> log<\/span>( $level, $message, $context = array()<\/span> )<\/span> <\/span>{\n        if<\/span> ( defined( 'WP_DEBUG'<\/span> ) && WP_DEBUG ) {\n            if<\/span> ( defined( 'WP_DEBUG_LOG'<\/span> ) && WP_DEBUG_LOG ) {\n                error_log(\n                    sprintf(\n                        '%s: %s. Details: %s'<\/span>,\n                        $level,\n                        trim( $message, '.'<\/span> ),\n                        json_encode( $context )\n                    )\n                );\n            }\n        }\n    }\n}<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
Leider sind Caching und der HTTP-Client in der ActivityPub-Implementierung noch nicht austauschbar, obwohl beide benutzten Libraries PSR kompatibel sind. Das hei\u00dft ich muss zuerst evaluieren, wie viel Arbeit es ist, die ActivityPub-Lib anzupassen, um dann diverse Wrapper f\u00fcr das WordPress Caching und die Request-\/Response-Classes zu schreiben…<\/p>\n\n\n\n
Bzw. muss ich das wahrscheinlich nicht einmal selbst implementieren, da ich bei weitem nicht der Erste war, der diese Idee hatte:<\/p>\n\n\n\n
PSR definiert passenderweise auch Interfaces f\u00fcr HTTP-Clients, Request-\/Response-Objekte und Caching. F\u00fcr die Request-Library die in WordPress benutzt wird, gibt es sogar schon ein passendes Issue: https:\/\/github.com\/WordPress\/Requests\/issues\/320<\/a><\/p>\n\n\n\n
Also hab ich mir \u00fcberlegt, wie so ein Logger f\u00fcr WordPress aussehen k\u00f6nnte und einen PSR-3 kompatiblen Wrapper gebaut:<\/a><\/p>\n\n\n