<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[13022] sites/trunk/api.wordpress.org/public_html/dotorg/matrix/poster.php: [matrix] reduce Poster class to be standalone, free of WordPress related functions</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/13022">13022</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/13022","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ashfame</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-12-07 08:18:15 +0000 (Thu, 07 Dec 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>[matrix] reduce Poster class to be standalone, free of WordPress related functions</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorgmatrixposterphp">sites/trunk/api.wordpress.org/public_html/dotorg/matrix/poster.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmldotorgmatrixposterphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/dotorg/matrix/poster.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/dotorg/matrix/poster.php 2023-12-07 08:16:08 UTC (rev 13021)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/matrix/poster.php 2023-12-07 08:18:15 UTC (rev 13022)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,7 +2,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> namespace Dotorg\Matrix;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-const MATRIX_INTEGRATIONS_ENABLED = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+const TEST_MODE = true; // used to post everything to #matrix-testing room instead
+const MATRIX_INTEGRATIONS_ENABLED = true;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> class Poster {
</span><span class="cx" style="display: block; padding: 0 10px"> const HOMESERVER_NAME = 'community.wordpress.org';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,12 +12,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Function to send a message to a matrix room, respecting the MATRIX_INTEGRATIONS_ENABLED constant
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Wrapper for _send() which actually does the sending
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Wrapper for _send()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $where Room ID or Room alias reference (full or local part).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $message Text message to post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $message Text/Markdown message to post.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $who Bot account that should post this message.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void|bool Returns null on bad input, true on success, false on failure
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return void|bool Returns null on bad input, true on success, false on failure
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function send( string $where, string $message, string $who = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! MATRIX_INTEGRATIONS_ENABLED ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,12 +30,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Function to send a message to a matrix room, regardless of MATRIX_INTEGRATIONS_ENABLED constant
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Blind wrapper for _send() which actually does the sending
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Blind wrapper for _send()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $where Room ID or Room alias reference (full or local part).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $message Text message to post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $message Text/Markdown message to post.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $who Bot account that should post this message.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void|bool Returns null on bad input, true on success, false on failure
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return void|bool Returns null on bad input, true on success, false on failure
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function force_send( string $where, string $message, string $who = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return self::_send( $where, $message, $who );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,9 +45,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Function that figures out the room id & endpoint that would be used to post the message
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $where Room ID or Room alias reference (full or local part).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $message Text message to post.
- * @param string|null $who Bot account that should post this message.
- * @return void|bool Returns null on bad input, true on success, false on failure
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $message Text/Markdown message to post.
+ * @param string|null $who Bot account that should post this message (eg: polyglotsbot).
+ * @return void|bool Returns null on bad input, true on success, false on failure
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private static function _send( string $where, string $message, string $who = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $where ) || empty( trim( $message ) ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,151 +54,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $room_id = self::get_room_id( $where );
- if ( false === $room_id ) {
- return;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // which HTTP endpoint to use?
</span><span class="cx" style="display: block; padding: 0 10px"> // constants defined in "secrets.php".
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch ( $who ) {
- // case 'specificbot':
- // $http_endpoint = MATRIX_INTEGRATIONS_SPECIFICBOT_POSTING_ENDPOINT;
- // break;
- default:
- $http_endpoint = MATRIX_INTEGRATIONS_MATRIXBOT_POSTING_ENDPOINT;
- }
-
- return self::post_message( $room_id, $message, $http_endpoint );
- }
-
- /**
- * Returns a room id from one of the acceptable values supplied for room:
- * room alias part such as "core", "#core"
- * room alias such as "#core:community.wordpress.org"
- * room ID "!cHPvPsHiObbVCkAdiy:community.wordpress.org"
- *
- * @param string $where Room ID or Room alias reference (full or local part).
- * @return string|bool Room ID or false upon error.
- */
- private static function get_room_id( string $where ) {
- if ( '!' === $where[0] ) {
- return $where;
- }
-
- if ( '#' !== $where[0] ) {
- $room_alias = '#' . explode( ':', $where )[0] . ':' . self::HOMESERVER_NAME;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $constant_name = 'MATRIX_INTEGRATIONS_' . strtoupper( $who ) . '_POSTING_ENDPOINT';
+ if ( defined( $constant_name ) ) {
+ $http_endpoint = constant( $constant_name ); // get constant's value
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $room_alias = explode( ':', $where )[0] . ':' . self::HOMESERVER_NAME;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $http_endpoint = MATRIX_INTEGRATIONS_MATRIXBOT_POSTING_ENDPOINT;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $resolved_room_id = self::resolve_room_alias( $room_alias );
- if ( false === $resolved_room_id ) {
- return false;
- }
-
- return $resolved_room_id;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return self::post_message( $where, $message, $http_endpoint );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Resolves matrix room alias "#core:community.wordpress.org" into
- * room id "!cHPvPsHiObbVCkAdiy:community.wordpress.org"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Posts the message by sending a POST request to maubot's HTTP endpoint.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $room_alias Room alias example: "#orbit:community.wordpress.org".
- * @return string|bool room id on success and false on error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $room_id_or_alias Room ID or Room alias reference (full or local part) where the message needs to be posted.
+ * @param string $message Text/Markdown message to post.
+ * @param string $http_endpoint What HTTP endpoint should the request be sent to.
+ * @return bool Returns true on success, false on failure
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function resolve_room_alias( string $room_alias ) {
- $cache_key = "matrix_room_alias_$room_alias";
- $room_id = wp_cache_get( $cache_key, 'matrix' );
-
- if ( false === $room_id ) {
- $response = wp_remote_post(
- self::HOMESERVER_URL . '/_matrix/client/v3/directory/room/' . rawurlencode( $room_alias ),
- array(
- 'method' => 'GET',
- 'timeout' => 120,
- )
- );
-
- if ( is_wp_error( $response ) ) {
- $error_message = $response->get_error_message();
- error_log( __FUNCTION__ . "() error resolving room alias '$room_alias' - $error_message" );
- return false;
- }
- $status_code = wp_remote_retrieve_response_code( $response );
- if ( 200 !== $status_code ) {
- error_log( __FUNCTION__ . "() HTTP Error: $status_code" );
- return false;
- }
-
- $decoded = json_decode( $response['body'], true );
- if ( is_null( $decoded ) ) {
- error_log( __FUNCTION__ . '() empty body returned' );
- return false;
- }
-
- if ( isset( $decoded['room_id'] ) ) {
- $room_id = $decoded['room_id'];
- wp_cache_set( $cache_key, $room_id, 'matrix', DAY_IN_SECONDS );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private static function post_message( string $room_id_or_alias, string $message, string $http_endpoint ): bool {
+ if ( TEST_MODE ) {
+ $room_id_or_alias = "#matrix-testing:community.wordpress.org";
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $room_id;
- }
-
- /**
- * Posts the message by sending a POST request to maubot's HTTP endpoint.
- *
- * @param string $room_id RoomID to post to.
- * @param string $message Text message to post.
- * @param string $access_token Bot user account access token.
- * @return bool true on success, false on failure
- */
- private static function post_message( string $room_id, string $message, string $http_endpoint ): bool {
- // allow short-circuit via filter.
- $filtered_args = apply_filters(
- 'dotorg_matrix_poster_post_message',
- array(
- 'room_id' => $room_id,
- 'message' => $message,
- 'http_endpoint' => $http_endpoint,
- )
- );
- $room_id = $filtered_args['room_id'];
- $message = $filtered_args['message'];
- $http_endpoint = $filtered_args['http_endpoint'];
-
- if ( empty( $room_id ) || empty( $message ) || empty( $http_endpoint ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $room_id_or_alias ) || empty( $message ) || empty( $http_endpoint ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = wp_remote_post(
- $http_endpoint,
- array(
- 'method' => 'POST',
- 'timeout' => 120,
- 'headers' => array(
- 'Content-Type' => 'application/json',
- ),
- 'body' => wp_json_encode(
- array(
- 'room' => $room_id,
- 'message' => $message,
- )
- ),
- )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $context = stream_context_create( [
+ 'http' => [
+ 'header' => "Content-type: application/json\r\n",
+ 'method' => 'POST',
+ 'content' => json_encode( [
+ 'room' => $room_id_or_alias,
+ 'message' => $message,
+ ] ),
+ ],
+ ] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_wp_error( $response ) ) {
- $error_message = $response->get_error_message();
- error_log( __FUNCTION__ . "() error posting to matrix homeserver using thin client - $error_message" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false === file_get_contents( $http_endpoint, false, $context ) ) {
+ error_log( __NAMESPACE__ . '\\' . __FUNCTION__ . "() error posting message to matrix homeserver - " . error_get_last()['message'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $status_code = wp_remote_retrieve_response_code( $response );
- if ( 200 !== $status_code ) {
- error_log( __FUNCTION__ . "() HTTP Error: $status_code - " . wp_remote_retrieve_body( $response ) );
- return false;
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>