wp-webmention-again.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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 |
<?php
/*
Plugin Name: wp-webmention-again
Plugin URI: https://github.com/petermolnar/wp-webmention-again
Description:
Version: 0.1
Author: Peter Molnar <hello@petermolnar.eu>
Author URI: http://petermolnar.eu/
License: GPLv3
Required minimum PHP version: 5.3
*/
if ( ! class_exists( 'WP_Webmention_Again' ) ):
// global send_webmention function
if ( ! function_exists( 'send_webmention' ) ) {
function send_webmention( $source, $target ) {
return WP_Webmention_Again::send( $source, $target );
}
}
// something else might have loaded this already
if ( ! class_exists( 'Mf2\Parser' ) ) {
require ( __DIR__ . '/vendor/autoload.php' );
}
// if something has loaded Mf2 already, the autoload won't kick in,
// and we need this
if ( ! class_exists( 'EmojiRecognizer' ) ) {
require ( __DIR__ . '/vendor/dissolve/single-emoji-recognizer/src/emoji.php' );
}
class WP_Webmention_Again {
// post meta key for queued incoming mentions
const meta_received = '_webmention_received';
// cron handle for processing incoming
const cron_received = 'webmention_received';
// post meta key for posts marked as outgoing and in need of processing
const meta_send = '_webmention_send';
// cron handle for processing outgoing
const cron_send = 'webmention_send';
// WP cache expiration seconds
const expire = 10;
/**
* 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 remote_timeout () {
return apply_filters( 'wp-webmention-again_remote_timeout', 100 );
}
/**
* 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_received () {
return apply_filters( 'wp-webmention-again_interval_received', 600 );
}
/**
* minimum 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_received_min () {
return apply_filters( 'wp-webmention-again_interval_received_min', 60 );
}
/**
* regular cron interval for processing outgoing
*
* use 'wp-webmention-again_interval_send' to filter this integer
*
* @return int cron interval in seconds
*
*/
protected static function interval_send () {
return apply_filters( 'wp-webmention-again_interval_send', 600 );
}
/**
* minimum cron interval for processing outgoing
*
* use 'wp-webmention-again_interval_send' to filter this integer
*
* @return int cron interval in seconds
*
*/
protected static function interval_send_min () {
return apply_filters( 'wp-webmention-again_interval_send_min', 60 );
}
/**
* 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_retry', 5 );
}
/**
* endpoint for receiving webmentions
*
* use 'wp-webmention-again_endpoint' to filter this string
*
* @return string name of endpoint
*
*/
protected static function endpoint() {
return apply_filters( 'wp-webmention-again_endpoint', 'webmention' );
}
/**
* 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_per_batch', 10 );
}
/**
* mapping for comment types -> mf2 names
*
* use 'wp-webmention-again_mftypes' to filter this array
*
* @return array array of comment_type => mf2_name entries
*
*/
protected static function mftypes () {
$map = array (
// http://indiewebcamp.com/reply
'reply' => 'in-reply-to',
// http://indiewebcamp.com/repost
'repost' => 'repost-of',
// http://indiewebcamp.com/like
'like' => 'like-of',
// http://indiewebcamp.com/favorite
'favorite' => 'favorite-of',
// http://indiewebcamp.com/bookmark
'bookmark' => 'bookmark-of',
// http://indiewebcamp.com/rsvp
'rsvp' => 'rsvp',
// http://indiewebcamp.com/tag
'tag' => 'tag-of',
);
return apply_filters( 'wp-webmention-again_mftypes', $map );
}
/**
* runs on plugin load
*/
public function __construct() {
add_action( 'init', array( &$this, 'init' ) );
add_action( 'parse_query', array( &$this, 'receive' ) );
add_action( 'wp_head', array( &$this, 'html_header' ), 99 );
add_action( 'send_headers', array( &$this, 'http_header' ) );
// this is mostly for debugging reasons
register_activation_hook( __FILE__ , array( 'WP_Webmention_Again', 'plugin_activate' ) );
// clear schedules if there's any on deactivation
register_deactivation_hook( __FILE__ , array( 'WP_Webmention_Again', 'plugin_deactivate' ) );
// extend current cron schedules with our entry
add_filter( 'cron_schedules', array(&$this, 'add_cron_schedule' ) );
// register the action for processing received
add_action( static::cron_received, array( &$this, 'process_received' ) );
// register the action for processing received
add_action( static::cron_send, array( &$this, 'process_send' ) );
// additional comment types
add_action( 'admin_comment_types_dropdown', array( &$this, 'comment_types_dropdown' ) );
// register new posts
add_action( 'transition_post_status', array( &$this, 'queue_send' ), 12, 5 );
}
/**
* runs at WordPress init hook
*
*/
public function init() {
// add webmention endpoint to query vars
add_filter( 'query_vars', array( &$this, 'add_query_var' ) );
// because this needs one more filter
add_filter( 'get_avatar_comment_types', array( &$this, 'add_comment_types' ) );
// additional avatar filter
add_filter( 'get_avatar' , array( &$this, 'get_avatar' ), 1, 5 );
// get_pung is not restrictive enough
add_filter ( 'get_pung', array( &$this, 'get_pung' ) );
if ( ! wp_get_schedule( static::cron_received ) ) {
wp_schedule_event( time(), static::cron_received, static::cron_received );
}
if ( ! wp_get_schedule( static::cron_send ) ) {
wp_schedule_event( time(), static::cron_send, static::cron_send );
}
}
/**
* plugin activation hook
*
* dies if PHP version is too low
*
*/
public static function plugin_activate() {
if ( version_compare( phpversion(), 5.3, '<' ) ) {
die( 'The minimum PHP version required for this plugin is 5.3' );
}
flush_rewrite_rules( true );
}
/**
* plugin deactivation hook
*
* makes sure there are no scheduled cron hooks left
*
*/
public static function plugin_deactivate () {
wp_unschedule_event( time(), static::cron_received );
wp_clear_scheduled_hook( static::cron_received );
wp_unschedule_event( time(), static::cron_send );
wp_clear_scheduled_hook( static::cron_send );
flush_rewrite_rules( true );
}
/**
* add our own schedule
*
* @param array $schedules - current schedules list
*
* @return array $schedules - extended schedules list
*/
public function add_cron_schedule ( $schedules ) {
$schedules[ static::cron_received ] = array (
'interval' => static::interval_received(),
'display' => sprintf(__( 'every %d seconds' ), static::interval_received() )
);
$schedules[ static::cron_send ] = array (
'interval' => static::interval_send(),
'display' => sprintf(__( 'every %d seconds' ), static::interval_send() )
);
return $schedules;
}
/**
* extends HTML header with webmention endpoint
*
* @output string two lines of HTML <link>
*
*/
public function html_header () {
$endpoint = site_url( '?'. static::endpoint() .'=endpoint' );
// backwards compatibility with v0.1
echo '<link rel="http://webmention.org/" href="' . $endpoint . '" />' . "\n";
echo '<link rel="webmention" href="' . $endpoint . '" />' . "\n";
}
/**
* extends HTTP response header with webmention endpoints
*
* @output two lines of Link: in HTTP header
*
*/
public function http_header() {
$endpoint = site_url( '?'. static::endpoint() .'=endpoint' );
// backwards compatibility with v0.1
header( 'Link: <' . $endpoint . '>; rel="http://webmention.org/"', false );
header( 'Link: <' . $endpoint . '>; rel="webmention"', false );
}
/**
* add webmention to accepted query vars
*
* @param array $vars current query vars
*
* @return array extended vars
*/
public function add_query_var( $vars ) {
array_push( $vars, static::endpoint() );
return $vars;
}
/**
* get plugin options
*
* use 'wp-webmention-again_comment_types' to filter registered comment types
* before being applied
*
* @return array plugin options
*
*/
public static function get_options () {
$options = get_option( __CLASS__ );
if ( isset( $options['comment_types'] ) && is_array( $options['comment_types'] ) )
$options['comment_types'] = array_merge($options['comment_types'], static::mftypes());
else
$options['comment_types'] = static::mftypes();
$options['comment_types'] = apply_filters( 'wp-webmention-again_comment_types', $options['comment_types'] );
return $options;
}
/**
* extends the current registered comment types in options to have
* single char emoji as comment type
*
* @param char $reacji single emoticon character to add as comment type
*
*/
public static function register_reacji ( $reacji ) {
$options = static::get_options();
if ( ! in_array( $reacji, $options['comment_types'] ) ) {
$options['comment_types'][ $reacji ] = $reacji;
update_option( __CLASS__ , $options );
}
}
/**
* Extend the "filter by comment type" of in the comments section
* of the admin interface with all of our methods
*
* @param array $types the different comment types
*
* @return array the filtered comment types
*/
public function comment_types_dropdown( $types ) {
$options = static::get_options();
foreach ( $options['comment_types'] as $type => $fancy )
if ( ! isset( $types[ $type ] ) )
$types[ $type ] = ucfirst( $type );
return $types;
}
/**
* extend the abailable comment types in WordPress with the ones recognized
* by the plugin, including reacji
*
* @param array $types current types
*
* @return array extended types
*/
public function add_comment_types ( $types ) {
$options = static::get_options();
foreach ( $options['comment_types'] as $type => $fancy )
if ( ! in_array( $type, $types ) )
array_push( $types, $type );
return $types;
}
/**
* parse & queue incoming webmention endpoint requests
*
* @param mixed $wp WordPress Query
*
*/
public function receive ( $wp ) {
// check if it is a webmention request or not
if ( ! array_key_exists( static::endpoint(), $wp->query_vars ) )
return false;
// plain text header
header( 'Content-Type: text/plain; charset=' . get_option( 'blog_charset' ) );
// check if source url is transmitted
if ( ! isset( $_POST['source'] ) ) {
status_header( 400 );
echo '"source" is missing';
exit;
}
// check if target url is transmitted
if ( ! isset( $_POST['target'] ) ) {
status_header( 400 );
echo '"target" is missing';
exit;
}
$target = filter_var( $_POST['target'], FILTER_SANITIZE_URL );
$source = filter_var( $_POST['source'], FILTER_SANITIZE_URL );
if ( false === filter_var( $target, FILTER_VALIDATE_URL ) ) {
status_header( 400 );
echo '"target" is an invalid URL';
exit;
}
if ( false === filter_var( $source, FILTER_VALIDATE_URL ) ) {
status_header( 400 );
echo '"source" is an invalid URL';
exit;
}
$post_id = static::validate_local( $target );
if (! $post_id || 0 == $post_id ) {
status_header( 404 );
echo '"target" not found.';
exit;
}
// check if pings are allowed
if ( ! pings_open( $post_id ) ) {
status_header( 403 );
echo 'Pings are disabled for this post';
exit;
}
// queue here, the remote check will be async
$r = static::queue_receive( $source, $target, $post_id );
if ( true == $r ) {
status_header( 202 );
echo 'Webmention accepted in the queue.';
}
else {
status_header( 500 );
echo 'Something went wrong; please try again later!';
}
exit;
}
/**
* add post meta for post with about incoming webmention request to be
* processed later
*
* @param string $source source URL
* @param string $target target URL
* @param int $post_id Post ID
*
* @return bool|int result of add_post_meta
*/
protected static function queue_receive ( $source, $target, $post_id ) {
if( empty( $post_id ) || empty( $source ) || empty( $target ) )
return false;
$val = array (
'source' => $source,
'target' => $target
);
static::debug( "queueing {static::meta_received} meta for #{$post_id}; source: {$source}, target: {$target}" );
$r = add_post_meta( $post_id, static::meta_received, $val, false );
if ( false == $r ) {
static::debug( "adding {static::meta_received} meta for #{$post_id} failed" );
}
else {
// fire up a single cron event if the scheduled is too far in the future
if ( wp_next_scheduled( static::cron_received ) > static::interval_received_min() )
wp_schedule_single_event( time() , static::cron_received );
}
return $r;
}
/**
* worker method for doing received webmentions
* triggered by cron
*
*/
public function process_received () {
$posts = static::get_received();
if ( empty( $posts ) )
return true;
foreach ( $posts as $post_id ) {
$received_mentions = get_post_meta ( $post_id, static::meta_received, false );
foreach ( $received_mentions as $m ) {
// $m should not be modified as this is how the current entry can be identified!
$_m = $m;
static::debug( "working on webmention for post #{$post_id}" );
// this really should not happen, but if it does, get rid of this entry immediately
if (! isset( $_m['target'] ) ||
empty( $_m['target'] ) ||
! isset( $_m['source'] ) ||
empty( $_m['source'] )
) {
static::debug( " target or souce empty, aborting" );
continue;
}
static::debug( " target: {$_m['target']}, source: {$_m['source']}" );
// if we'be been here before, we have retried counter already
$retries = isset( $_m['retries'] ) ? intval( $_m['retries'] ) : 0;
// too many retries, drop this mention and walk away
if ( $retries >= static::retry() ) {
static::debug( " this mention was tried earlier and failed too many times, drop it" );
delete_post_meta( $post_id, static::meta_received, $m );
continue;
}
$_m['retries'] = $retries + 1;
// validate target
$remote = static::try_receive_remote( $post_id, $_m['source'], $_m['target'] );
if ( false === $remote || empty( $remote ) ) {
static::debug( " parsing this mention failed, retrying next time" );
update_post_meta( $post_id, static::meta_received, $_m, $m );
continue;
}
// we have remote data !
$c = static::try_parse_remote ( $post_id, $_m['source'], $_m['target'], $remote );
$ins = static::insert_comment ( $post_id, $_m['source'], $_m['target'], $remote, $c );
if ( true === $ins ) {
static::debug( " duplicate (or something similar): this queue element has to be ignored; deleting queue entry" );
delete_post_meta( $post_id, static::meta_received, $m );
}
elseif ( is_numeric( $ins ) ) {
static::debug( " all went well, we have a comment id: {$ins}, deleting queue entry" );
delete_post_meta( $post_id, static::meta_received, $m );
}
else {
static::debug( "This is unexpected. Try again." );
update_post_meta( $post_id, static::meta_received, $_m, $m );
continue;
}
}
}
}
/**
* get posts which have queued incoming requests
*
* @return array array of WP Post objects or empty array
*/
protected static function get_received () {
global $wpdb;
$r = array();
$dbname = "{$wpdb->prefix}postmeta";
$key = static::meta_received;
$limit = static::per_batch();
$db_command = "SELECT DISTINCT `post_id` FROM `{$dbname}` WHERE `meta_key` = '{$key}' LIMIT {$limit}";
try {
$q = $wpdb->get_results( $db_command );
}
catch ( Exception $e ) {
static::debug( "Something went wrong: " . $e->getMessage() );
}
if ( ! empty( $q ) && is_array( $q ) ) {
foreach ( $q as $post ) {
array_push( $r, $post->post_id );
}
}
return $r;
}
/**
* extended wp_remote_get with debugging
*
* @param string $source URL to pull
*
* @return array wp_remote_get array
*/
protected static function _wp_remote_get ( &$source ) {
$content = false;
static::debug( " fetching {$source}" );
$url = htmlspecialchars_decode( $source );
$q = wp_remote_get( $source );
if ( is_wp_error( $q ) ) {
static::debug( " something went wrong: " . $q->get_error_message() );
return false;
}
if ( !is_array( $q ) ) {
static::debug( " $q is not an array. It should be one." );
return false;
}
if ( ! isset( $q['headers'] ) || ! is_array( $q['headers'] ) ) {
static::debug( " missing response headers." );
return false;
}
if ( ! isset( $q['body'] ) || empty( $q['body'] ) ) {
static::debug( " missing body" );
return false;
}
return $q;
}
/**
* try to get contents of webmention originator
*
* @param int $post_id ID of post
* @param string $source Originator URL
* @param string $target Target URL
*
* @return bool|array false on error; plain array or Mf2 parsed (and
* flattened ) array of remote content on success
*/
protected static function try_receive_remote ( &$post_id, &$source, &$target ) {
$content = false;
$q = static::_wp_remote_get( $source );
if ( false === $q )
return false;
$t = $target;
$t = preg_replace( '/https?:\/\/(?:www.)?/', '', $t );
$t = preg_replace( '/#.*/', '', $t );
$t = untrailingslashit( $t );
// check if source really links to target
// this could be a temporary error, so we'll retry later this one as well
if ( ! stristr( $q['body'], $t ) ) {
static::debug( " missing link to {$t} in remote body" );
return false;
}
$ctype = isset( $q['headers']['content-type'] ) ? $q['headers']['content-type'] : 'text/html';
if ( "text/plain" == $ctype ) {
static::debug( " interesting, plain text webmention. I'm not prepared for this yet" );
return false;
}
elseif ( $ctype == "application/json" ) {
static::debug( " content is JSON" );
$content = json_decode( $q['body'], true );
}
else {
static::debug( " content is (probably) html, trying to parse it with MF2" );
try {
$content = Mf2\parse( $q['body'], $source );
}
catch ( Exception $e ) {
static::debug( " parsing MF2 failed: " . $e->getMessage() );
return false;
}
$content = static::flatten_mf2_array( $content );
}
return $content;
}
/**
* try to convert remote content to comment
*
* @param int $post_id ID of post
* @param string $source Originator URL
* @param string $target Target URL
* @param array $content (Mf2) array of remote content
*
* @return bool|int false on error; insterted comment ID on success
*/
protected static function try_parse_remote ( &$post_id, &$source, &$target, &$content ) {
$item = false;
$p_authors = array();
if ( isset( $content['items']['properties'] ) && isset( $content['items']['type'] ) ) {
$item = $content['items'];
}
elseif ( is_array($content['items'] ) && ! empty( $content['items']['type'] ) ) {
foreach ( $content['items'] as $i ) {
if ( 'h-entry' == $i['type'] ) {
$item = $i;
}
elseif ( 'h-card' == $i['type'] ) {
$p_authors[] = $i;
}
}
}
if (! $item || empty( $item )) {
static::debug(' no parseable h-entry found, saving as standard mention comment');
$c = array (
'comment_author' => $source,
'comment_author_url' => $source,
'comment_author_email' => '',
'comment_post_ID' => $post_id,
'comment_type' => 'webmention',
'comment_date' => date("Y-m-d H:i:s"),
'comment_date_gmt' => date("Y-m-d H:i:s"),
'comment_agent' => __CLASS__,
'comment_approved' => 0,
'comment_content' => sprintf( __( 'This entry was webmentioned on <a href="%s">%s</a>.' ), $source, $source ),
);
return $c;
}
// process author
$author_name = $author_url = $avatar = $a = false;
if ( isset( $item['properties']['author'] ) ) {
$a = $item['properties']['author'];
}
elseif ( ! empty( $p_authors ) ) {
$a = array_pop( $p_authors );
}
if ( $a && isset( $a['properties'] ) ) {
$a = $a['properties'];
if ( isset($a['name']) && ! empty( $a['name'] ) )
$author_name = $a['name'];
$try_photos = array ('photo', 'avatar');
$p = false;
foreach ( $try_photos as $photo ) {
if (isset( $a[ $photo ]) && ! empty( $a[ $photo ] ) ) {
$p = $a[ $photo ];
if ( !empty( $p ) ) {
$avatar = $p;
break;
}
}
}
}
// process type
$type = 'webmention';
foreach ( static::mftypes() as $k => $mapped ) {
if ( is_array( $item['properties'] ) && isset( $item['properties'][ $mapped ]) )
$type = $k;
}
//process content
$c = '';
if ( isset( $item['properties']['content'] ) && isset( $item['properties']['content']['html'] ) )
$c = $item['properties']['content']['html'];
if ( isset( $item['properties']['content'] ) && isset( $item['properties']['content']['value'] ) )
$c = wp_filter_kses( $item['properties']['content']['value'] );
// REACJI
$emoji = EmojiRecognizer::isSingleEmoji( $c );
if ( $emoji ) {
static::debug( "wheeeee, reacji!" );
$type = trim( $c );
static::register_reacji( $type );
}
// process date
if ( isset( $item['properties']['modified'] ) )
$date = strtotime( $item['properties']['modified'] );
elseif ( isset( $item['properties']['published'] ) )
$date = strtotime( $item['properties']['published'] );
else
$date = time();
$name = empty( $author_name ) ? $source : $author_name;
$c = array (
'comment_author' => $name,
'comment_author_url' => $source,
'comment_author_email' => '',
'comment_post_ID' => $post_id,
'comment_type' => $type,
'comment_date' => date( "Y-m-d H:i:s", $date ),
'comment_date_gmt' => date( "Y-m-d H:i:s", $date ),
'comment_agent' => __CLASS__,
'comment_approved' => 0,
'comment_content' => $c,
'comment_avatar' => $avatar,
);
return $c;
}
/**
* Comment inserter
*
* @param string &$post_id post ID
* @param string &$source Originator URL
* @param string &$target Target URL
* @param mixed &$raw Raw format of the comment, like JSON response from the provider
* @param array &$comment array formatted to match a WP Comment requirement
*
*/
protected static function insert_comment ( &$post_id, &$source, &$target, &$raw, &$comment ) {
$comment_id = false;
$avatar = false;
if( isset( $comment['comment_avatar'] ) ) {
$avatar = $comment['comment_avatar'];
unset( $comment['comment_avatar'] );
}
// safety first
$comment['comment_author_email'] = filter_var ( $comment['comment_author_email'], FILTER_SANITIZE_EMAIL );
$comment['comment_author_url'] = filter_var ( $comment['comment_author_url'], FILTER_SANITIZE_URL );
$comment['comment_author'] = filter_var ( $comment['comment_author'], FILTER_SANITIZE_STRING);
//test if we already have this imported
$testargs = array(
'author_url' => $comment['comment_author_url'],
'post_id' => $post_id,
);
// so if the type is comment and you add type = 'comment', WP will not return the comments
// such logical!
if ( 'comment' != $comment['comment_type'] )
$testargs['type'] = $comment['comment_type'];
// in case it's a fav or a like, the date field is not always present
// but there should be only one of those, so the lack of a date field indicates
// that we should not look for a date when checking the existence of the
// comment
if ( isset( $comment['comment_date'] ) && ! empty( $comment['comment_date'] ) ) {
// in case you're aware of a nicer way of doing this, please tell me
// or commit a change...
$tmp = explode ( " ", $comment['comment_date'] );
$d = explode( "-", $tmp[0] );
$t = explode ( ':', $tmp[1] );
$testargs['date_query'] = array(
'year' => $d[0],
'monthnum' => $d[1],
'day' => $d[2],
'hour' => $t[0],
'minute' => $t[1],
'second' => $t[2],
);
//test if we already have this imported
static::debug( "checking comment existence (with date) for post #{$post_id}" );
}
else {
// we do need a date
$comment['comment_date'] = date( "Y-m-d H:i:s" );
$comment['comment_date_gmt'] = date( "Y-m-d H:i:s" );
static::debug( "checking comment existence (no date) for post #{$post_id}" );
}
$existing = get_comments( $testargs );
// no matching comment yet, insert it
if ( ! empty( $existing ) ) {
static::debug ( "comment already exists" );
return true;
}
// disable flood control, just in case
remove_filter( 'check_comment_flood', 'check_comment_flood_db', 10, 3 );
$comment = apply_filters( 'preprocess_comment', $comment );
if ( $comment_id = wp_new_comment( $comment ) ) {
// add avatar for later use if present
if ( ! empty( $avatar ) )
update_comment_meta( $comment_id, 'avatar', $avatar );
// full raw response for the vote, just in case
update_comment_meta( $comment_id, 'webmention_source_mf2', $raw );
// original request
update_comment_meta( $comment_id, 'webmention_original', array( 'target' => $target, 'source' => $source) );
// info
$r = "new comment inserted for {$post_id} as #{$comment_id}";
// notify author
// wp_notify_postauthor( $comment_id );
}
else {
$r = "something went wrong when trying to insert comment for post #{$post_id}";
}
// re-add flood control
add_filter( 'check_comment_flood', 'check_comment_flood_db', 10, 3 );
static::debug( $r );
return $comment_id;
}
/**
* 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_send( $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;
}
$r = add_post_meta( $post->ID, static::meta_send, 1, true );
if ( ! $r ) {
static::debug( "Tried adding post #{$post->ID} to mention queue, but it didn't go well" );
}
else {
// fire up a single cron event if the scheduled is too far in the future
if ( wp_next_scheduled( static::cron_send ) > static::interval_send_min() )
wp_schedule_single_event( time() , static::cron_send );
}
return $r;
}
/**
* Main send processor
*
*
*/
public function process_send () {
$posts = static::get_send();
if ( empty( $posts ) )
return false;
foreach ( $posts as $post_id ) {
$post = get_post( $post_id );
if ( ! static::is_post( $post ) ) {
delete_post_meta( $post_id, static::meta_send );
continue;
}
static::debug("Trying to get urls for #{$post->ID}");
// try to avoid redirects, so no shortlink is sent for now
$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 );
$todo = $urls;
$failed = array();
$pung = get_pung( $post->ID );
foreach ( $urls as $target ) {
$target = strtolower( $target );
static::debug(' url to ping: ' . $target );
// already pinged, skip
if ( in_array( $target, $pung ) ) {
static::debug( " already pinged!" );
$todo = array_diff( $todo, array( $target ) );
continue;
}
// tried too many times
$try_key = static::meta_send . '_' . $target;
$tries = intval( get_post_meta( $post->ID, $try_key, true ) );
if ( false != $tries && $tries >= static::retry() ) {
static::debug( " failed too many times; skipping" );
$todo = array_diff( $todo, array( $target ) );
array_push( $failed, $try_key );
continue;
}
// try sending
$s = static::send( $source, $target, $post->ID );
if ( !$s ) {
$tries = $tries + 1;
static::debug( " sending failed; retrying later ({$tries} time)" );
update_post_meta( $post->ID, $try_key, $tries );
continue;
}
else {
static::debug( " sending succeeded!" );
add_ping( $post->ID, $target );
$todo = array_diff( $todo, array( $target ) );
}
}
if ( empty( $todo ) ) {
static::debug( " no more urls to ping or no more tries left, cleaning up" );
foreach ( $failed as $try_key )
delete_post_meta( $post->ID, $try_key );
delete_post_meta( $post->ID, static::meta_send );
}
}
}
/**
* 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;
}
/**
* get all posts that have meta entry for sending
*
* @return array of WP Post objects
*/
protected static function get_send () {
global $wpdb;
$r = array();
$dbname = "{$wpdb->prefix}postmeta";
$key = static::meta_send;
$limit = static::per_batch();
$db_command = "SELECT DISTINCT `post_id` FROM `{$dbname}` WHERE `meta_key` = '{$key}' LIMIT {$limit}";
try {
$q = $wpdb->get_results( $db_command );
}
catch ( Exception $e ) {
static::debug( "Something went wrong: " . $e->getMessage() );
}
if ( ! empty( $q ) && is_array( $q ) ) {
foreach ( $q as $post ) {
array_push( $r, $post->post_id );
}
}
return $r;
}
/**
* 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;
}
/**
* validated a URL that is supposed to be on our site
*
* @param string $url URL to check against
*
* @return bool|int false on not found, int post_id on found
*/
protected static function validate_local ( $url ) {
// normalize url scheme, url_to_postid will take care of it anyway
$url = preg_replace( '/^https?:\/\//i', 'http://', $url );
return url_to_postid( $url );
}
/**
* recursive walker for an mf2 array: if it find an element which has a value
* of a single element array, flatten the array to the element
*
* @param array $mf2 Mf2 array to flatten
*
* @return array flattened Mf2 array
*
*/
protected static function flatten_mf2_array ( $mf2 ) {
if (is_array($mf2) && count($mf2) == 1) {
$mf2 = array_pop($mf2);
}
if (is_array($mf2)) {
foreach($mf2 as $key => $value) {
$mf2[$key] = static::flatten_mf2_array($value);
}
}
return $mf2;
}
/**
* find all urls in a text
*
* @param string $text - text to parse
*
* @return array array of URLS found in the test
*/
protected static function extract_urls( &$text ) {
$matches = array();
preg_match_all("/\b(?:http|https)\:\/\/?[a-zA-Z0-9\.\/\?\:@\-_=#]+\.[a-zA-Z0-9\.\/\?\:@\-_=#]*/i", $text, $matches);
$matches = $matches[0];
$matches = array_unique($matches);
return $matches;
}
/**
* validates a post object if it really is a post
*
* @param $post object Wordpress Post Object to check
*
* @return bool true if it's a post, false if not
*/
protected static function is_post ( &$post ) {
if ( !empty($post) && is_object($post) && isset($post->ID) && !empty($post->ID) )
return true;
return false;
}
/**
* Converts relative to absolute urls
*
* code from [webmention](https://github.com/pfefferle/wordpress-webmention)
* which is based on the code of 99webtools.com
*
* @link http://99webtools.com/relative-path-into-absolute-url.php
*
* @param string $base the base url
* @param string $rel the relative url
*
* @return string the absolute url
*/
protected static function make_url_absolute( $base, $rel ) {
if ( 0 === strpos( $rel, '//' ) ) {
return parse_url( $base, PHP_URL_SCHEME ) . ':' . $rel;
}
// return if already absolute URL
if ( parse_url( $rel, PHP_URL_SCHEME ) != '' ) {
return $rel;
}
// queries and anchors
if ( '#' == $rel[0] || '?' == $rel[0] ) {
return $base . $rel;
}
// parse base URL and convert to local variables:
// $scheme, $host, $path
extract( parse_url( $base ) );
// remove non-directory element from path
$path = preg_replace( '#/[^/]*$#', '', $path );
// destroy path if relative url points to root
if ( '/' == $rel[0] ) {
$path = '';
}
// dirty absolute URL
$abs = "$host";
// check port
if ( isset( $port ) && ! empty( $port ) ) {
$abs .= ":$port";
}
// add path + rel
$abs .= "$path/$rel";
// replace '//' or '/./' or '/foo/../' with '/'
$re = array( '#(/\.?/)#', '#/(?!\.\.)[^/]+/\.\./#' );
for ( $n = 1; $n > 0; $abs = preg_replace( $re, '/', $abs, -1, $n ) ) { }
// absolute URL is ready!
return $scheme . '://' . $abs;
}
/**
* of there is a comment meta 'avatar' field, use that as avatar for the commenter
*
* @param string $avatar the current avatar image string
* @param mixed $id_or_email this could be anything that triggered the avatar all
* @param string $size size for the image to display
* @param string $default optional fallback
* @param string $alt alt text for the avatar image
*/
public function get_avatar( $avatar, $id_or_email, $size, $default = '', $alt = '' ) {
if ( ! is_object( $id_or_email ) || ! isset( $id_or_email->comment_type ) )
return $avatar;
// check if comment has an avatar
$c_avatar = get_comment_meta( $id_or_email->comment_ID, 'avatar', true );
if ( ! $c_avatar )
return $avatar;
if ( false === $alt )
$safe_alt = '';
else
$safe_alt = esc_attr( $alt );
return sprintf( '<img alt="%s" src="%s" class="avatar photo u-photo" style="width: %dpx; height: %dpx;" />', $safe_alt, $c_avatar, $size, $size );
}
/**
* get content like the_content
*
* @param object $post - WP Post object
*
* @return string the_content
*/
protected static function get_the_content( &$post ){
if ( ! static::is_post( $post ) )
return false;
if ( $cached = wp_cache_get ( $post->ID, __CLASS__ . __FUNCTION__ ) )
return $cached;
$r = apply_filters( 'the_content', $post->post_content );
wp_cache_set ( $post->ID, $r, __CLASS__ . __FUNCTION__, static::expire );
return $r;
}
/**
* debug messages; will only work if WP_DEBUG is on
* or if the level is LOG_ERR, but that will kill the process
*
* @param string $message
* @param int $level
*/
protected static function debug( $message, $level = LOG_NOTICE ) {
if ( @is_array( $message ) || @is_object ( $message ) )
$message = json_encode( $message );
switch ( $level ) {
case LOG_ERR :
wp_die( '<h1>Error:</h1>' . '<p>' . $message . '</p>' );
exit;
default:
if ( ! defined( 'WP_DEBUG' ) || true != WP_DEBUG )
return;
break;
}
error_log( __CLASS__ . ": " . $message );
}
}
$WP_Webmention_Again = new WP_Webmention_Again();
endif;
|