sender.php (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
<?php
class WP_Webmention_Again_Sender extends WP_Webmention_Again {
// cron handle for processing outgoing
const cron = 'webmention_send';
/**
* regular cron interval for processing incoming
*
* use 'wp-webmention-again_interval_received' to filter this integer
*
* @return int cron interval in seconds
*
*/
protected static function interval () {
return apply_filters( 'wp-webmention-again-sender_interval', 90 );
}
/**
* maximum amount of posts per batch to be processed
*
* use 'wp-webmention-again_per_batch' to filter this int
*
* @return int posts per batch
*
*/
protected static function per_batch () {
return apply_filters( 'wp-webmention-again-sender_per_batch', 42 );
}
/**
* max number of retries ( both for outgoing and incoming )
*
* use 'wp-webmention-again_retry' to filter this integer
*
* @return int cron interval in seconds
*
*/
protected static function retry () {
return apply_filters( 'wp-webmention-again-sender_retry', 5 );
}
public function __construct() {
parent::__construct();
// extend current cron schedules with our entry
//add_filter( 'cron_schedules', array(&$this, 'add_cron_schedule' ) );
// this is mostly for debugging reasons
// register_activation_hook( __FILE__ , array( __CLASS__ , 'plugin_activate' ) );
// clear schedules if there's any on deactivation
register_deactivation_hook( __FILE__ , array( __CLASS__ , 'plugin_deactivate' ) );
// register the action for processing received
add_action( static::cron, array( &$this, 'process' ) );
// register new posts
add_action( 'transition_post_status', array( &$this, 'queue' ), 12, 5 );
}
public function init () {
// get_pung is not restrictive enough
add_filter ( 'get_pung', array( &$this, 'get_pung' ) );
if ( ! wp_get_schedule( static::cron ) )
wp_schedule_event( time(), static::cron, static::cron );
}
/**
* plugin deactivation hook
*
* makes sure there are no scheduled cron hooks left
*
*/
public static function plugin_deactivate () {
wp_unschedule_event( time(), static::cron );
wp_clear_scheduled_hook( static::cron );
}
/**
* make pung stricter
*
* @param array $pung array of pinged urls
*
* @return array a better array of pinged urls
*
*/
public function get_pung ( $pung ) {
foreach ($pung as $k => $e )
$pung[ $k ] = strtolower( $e );
$pung = array_unique($pung);
return $pung;
}
/**
* triggered on post transition, applied when new status is publish, therefore
* applied on edit of published posts as well
* add a post meta to the post to be processed by the send processor
*
* @param string $new_status New post status
* @param string $old_status Previous post status
* @param object $post WP Post object
*/
public function queue( $new_status, $old_status, $post ) {
if ( ! static::is_post( $post ) ) {
static::debug( "Whoops, this is not a post." );
return false;
}
if ( 'publish' != $new_status ) {
static::debug( "Not adding {$post->ID} to mention queue yet; not published" );
return false;
}
static::debug("Trying to get urls for #{$post->ID}");
// try to avoid redirects, so no shortlink is sent for now as source
$source = get_permalink( $post->ID );
// process the content as if it was the_content()
$content = static::get_the_content( $post );
// get all urls in content
$urls = static::extract_urls( $content );
// for special ocasions when someone wants to add to this list
$urls = apply_filters( 'webmention_links', $urls, $post->ID );
// lowercase url is good for your mental health
foreach ( $urls as $k => $url )
$urls[ $k ] = strtolower( $url );
// remove all already pinged urls
$pung = get_pung( $post->ID );
$urls = array_diff ( $urls, $pung );
foreach ( $urls as $target ) {
$s_domain = parse_url( $source, PHP_URL_HOST);
$t_domain = parse_url( $target, PHP_URL_HOST);
// skip self-pings
if ( $s_domain == $t_domain )
continue;
$r = static::queue_add ( 'out', $source, $target, $post->post_type, $post->ID );
if ( !$r )
static::debug( " tried adding post #{$post->ID}, url: {$target} to mention queue, but it didn't go well" );
}
}
/**
* worker method for doing received webmentions
* triggered by cron
*
*/
public function process () {
$outgoing = static::queue_get ( 'out', static::per_batch() );
if ( empty( $outgoing ) )
return true;
foreach ( (array)$outgoing as $send ) {
// this really should not happen, but if it does, get rid of this entry immediately
if (! isset( $send->target ) ||
empty( $send->target ) ||
! isset( $send->source ) ||
empty( $send->source )
) {
static::debug( " target or souce empty, aborting" );
static::queue_del ( $send->id );
continue;
}
static::debug( "processing webmention: target -> {$send->target}, source -> {$send->source}" );
// too many retries, drop this mention and walk away
if ( $send->tries >= static::retry() ) {
static::debug( " this mention was tried earlier and failed too many times, drop it" );
static::queue_done ( $send->id );
continue;
}
// increment retries
static::queue_inc ( $send->id );
// try sending
$s = static::send( $send->source, $send->target );
if ( is_wp_error ( $s ) ) {
static::debug( " sending failed: " . $s->get_error_message() );
}
else {
static::debug( " sending succeeded!" );
$post_types = get_post_types( '', 'names' );
if ( in_array( $send->object_type, $post_types ) && 0 != $send->object_id )
add_ping( $send->object_id, $send->target );
static::queue_done ( $send->id, $s );
}
}
}
/**
* send a single webmention
* based on [webmention](https://github.com/pfefferle/wordpress-webmention)
*
*/
public static function send ( $source, $target, $post_id = false ) {
$options = static::get_options();
// stop selfpings on the same URL
if ( isset( $options['disable_selfpings_same_url'] ) &&
$options['disable_selfpings_same_url'] == '1' &&
$source === $target
)
return false;
// stop selfpings on the same domain
if ( isset( $options['disable_selfpings_same_domain'] ) &&
$options['disable_selfpings_same_domain'] == '1' &&
parse_url( $source, PHP_URL_HOST ) == parse_url( $target, PHP_URL_HOST )
)
return false;
// discover the webmention endpoint
$webmention_server_url = static::discover_endpoint( $target );
// if I can't find an endpoint, perhaps you can!
$webmention_server_url = apply_filters( 'webmention_server_url', $webmention_server_url, $target );
if ( $webmention_server_url ) {
$args = array(
'body' => 'source=' . urlencode( $source ) . '&target=' . urlencode( $target ),
'timeout' => static::remote_timeout(),
);
static::debug( "Sending webmention to: " .$webmention_server_url . " as: " . $args['body'] );
$response = wp_remote_post( $webmention_server_url, $args );
// use the response to do something usefull
// do_action( 'webmention_post_send', $response, $source, $target, $post_ID );
return $response;
}
return false;
}
/**
* Finds a WebMention server URI based on the given URL
*
* code from [webmention](https://github.com/pfefferle/wordpress-webmention)
*
* Checks the HTML for the rel="http://webmention.org/" link and http://webmention.org/ headers. It does
* a check for the http://webmention.org/ headers first and returns that, if available. The
* check for the rel="http://webmention.org/" has more overhead than just the header.
*
* @param string $url URL to ping
*
* @return bool|string False on failure, string containing URI on success
*/
protected static function discover_endpoint( $url ) {
// Not an URL. This should never happen.
if ( false === filter_var( $url, FILTER_VALIDATE_URL ) )
return false;
// do not search for a WebMention server on our own uploads
$uploads_dir = wp_upload_dir();
if ( 0 === strpos( $url, $uploads_dir['baseurl'] ) )
return false;
$response = wp_remote_head( $url, array( 'timeout' => static::remote_timeout(), 'httpversion' => '1.0' ) );
if ( is_wp_error( $response ) ) {
static::debug( "Something went wrong: " . $response->get_error_message() );
return false;
}
// check link header
if ( $links = wp_remote_retrieve_header( $response, 'link' ) ) {
if ( is_array( $links ) ) {
foreach ( $links as $link ) {
if ( preg_match( '/<(.[^>]+)>;\s+rel\s?=\s?[\"\']?(http:\/\/)?webmention(.org)?\/?[\"\']?/i', $link, $result ) ) {
return self::make_url_absolute( $url, $result[1] );
}
}
} else {
if ( preg_match( '/<(.[^>]+)>;\s+rel\s?=\s?[\"\']?(http:\/\/)?webmention(.org)?\/?[\"\']?/i', $links, $result ) ) {
return self::make_url_absolute( $url, $result[1] );
}
}
}
// not an (x)html, sgml, or xml page, no use going further
if ( preg_match( '#(image|audio|video|model)/#is', wp_remote_retrieve_header( $response, 'content-type' ) ) ) {
return false;
}
// now do a GET since we're going to look in the html headers (and we're sure its not a binary file)
$response = wp_remote_get( $url, array( 'timeout' => static::remote_timeout(), 'httpversion' => '1.0' ) );
if ( is_wp_error( $response ) ) {
return false;
}
$contents = wp_remote_retrieve_body( $response );
// boost performance and use alreade the header
$header = substr( $contents, 0, stripos( $contents, '</head>' ) );
// unicode to HTML entities
$contents = mb_convert_encoding( $contents, 'HTML-ENTITIES', mb_detect_encoding( $contents ) );
libxml_use_internal_errors( true );
$doc = new DOMDocument();
$doc->loadHTML( $contents );
$xpath = new DOMXPath( $doc );
// check <link> elements
// checks only head-links
foreach ( $xpath->query( '//head/link[contains(concat(" ", @rel, " "), " webmention ") or contains(@rel, "webmention.org")]/@href' ) as $result ) {
return self::make_url_absolute( $url, $result->value );
}
// check <a> elements
// checks only body>a-links
foreach ( $xpath->query( '//body//a[contains(concat(" ", @rel, " "), " webmention ") or contains(@rel, "webmention.org")]/@href' ) as $result ) {
return self::make_url_absolute( $url, $result->value );
}
return false;
}
}
|