PluginProbe
FeedWordPress / 2010.0528
FeedWordPress v2010.0528
trunk 0.8 0.9 0.91 0.95 0.96 0.97 0.98 0.981 0.99 0.991 0.992 0.993 2008.1030 2008.1101 2008.1105 2008.1214 2009.0612 2009.0613 2009.0618 2009.0707 2009.1111 2009.1112 2010.0127 2010.0528 All 65 releases
feedwordpress / feedwordpress.php

feedwordpress.php in FeedWordPress 2010.0528, at feedwordpress.php

1,517 lines 52.2 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /*
3 Plugin Name: FeedWordPress
4 Plugin URI: http://feedwordpress.radgeek.com/
5 Description: simple and flexible Atom/RSS syndication for WordPress
6 Version: 2010.0528
7 Author: Charles Johnson
8 Author URI: http://radgeek.com/
9 License: GPL
10 */
11
12 /**
13 * @package FeedWordPress
14 * @version 2010.0528
15 */
16
17 # This uses code derived from:
18 # - wp-rss-aggregate.php by Kellan Elliot-McCrea <kellan@protest.net>
19 # - HTTP Navigator 2 by Keyvan Minoukadeh <keyvan@k1m.com>
20 # - Ultra-Liberal Feed Finder by Mark Pilgrim <mark@diveintomark.org>
21 # according to the terms of the GNU General Public License.
22 #
23 # INSTALLATION: see readme.txt or <http://projects.radgeek.com/install>
24 #
25 # USAGE: once FeedWordPress is installed, you manage just about everything from
26 # the WordPress Dashboard, under the Syndication menu. To ensure that fresh
27 # content is added as it becomes available, you can convince your contributors
28 # to put your XML-RPC URI (if WordPress is installed at
29 # <http://www.zyx.com/blog>, XML-RPC requests should be sent to
30 # <http://www.zyx.com/blog/xmlrpc.php>), or update manually under the
31 # Syndication menu, or set up automatic updates under Syndication --> Settings,
32 # or use a cron job.
33
34 # -- Don't change these unless you know what you're doing...
35
36 define ('FEEDWORDPRESS_VERSION', '2010.0528');
37 define ('FEEDWORDPRESS_AUTHOR_CONTACT', 'http://radgeek.com/contact');
38
39 // Defaults
40 define ('DEFAULT_SYNDICATION_CATEGORY', 'Contributors');
41 define ('DEFAULT_UPDATE_PERIOD', 60); // value in minutes
42
43 if (isset($_REQUEST['feedwordpress_debug'])) :
44 $feedwordpress_debug = $_REQUEST['feedwordpress_debug'];
45 else :
46 $feedwordpress_debug = get_option('feedwordpress_debug');
47 if (is_string($feedwordpress_debug)) :
48 $feedwordpress_debug = ($feedwordpress_debug == 'yes');
49 endif;
50 endif;
51 define ('FEEDWORDPRESS_DEBUG', $feedwordpress_debug);
52
53 define ('FEEDWORDPRESS_CAT_SEPARATOR_PATTERN', '/[:\n]/');
54 define ('FEEDWORDPRESS_CAT_SEPARATOR', "\n");
55
56 define ('FEEDVALIDATOR_URI', 'http://feedvalidator.org/check.cgi');
57
58 define ('FEEDWORDPRESS_FRESHNESS_INTERVAL', 10*60); // Every ten minutes
59
60 define ('FWP_SCHEMA_HAS_USERMETA', 2966);
61 define ('FWP_SCHEMA_20', 3308); // Database schema # for WP 2.0
62 define ('FWP_SCHEMA_21', 4772); // Database schema # for WP 2.1
63 define ('FWP_SCHEMA_23', 5495); // Database schema # for WP 2.3
64 define ('FWP_SCHEMA_25', 7558); // Database schema # for WP 2.5
65 define ('FWP_SCHEMA_26', 8201); // Database schema # for WP 2.6
66 define ('FWP_SCHEMA_27', 9872); // Database schema # for WP 2.7
67 define ('FWP_SCHEMA_28', 11548); // Database schema # for WP 2.8
68 define ('FWP_SCHEMA_29', 12329); // Database schema # for WP 2.9
69
70 if (FEEDWORDPRESS_DEBUG) :
71 // Help us to pick out errors, if any.
72 ini_set('error_reporting', E_ALL & ~E_NOTICE);
73 ini_set('display_errors', true);
74
75 // When testing we don't want cache issues to interfere. But this is
76 // a VERY BAD SETTING for a production server. Webmasters will eat your
77 // face for breakfast if you use it, and the baby Jesus will cry. So
78 // make sure FEEDWORDPRESS_DEBUG is FALSE for any site that will be
79 // used for more than testing purposes!
80 define('FEEDWORDPRESS_CACHE_AGE', 1);
81 define('FEEDWORDPRESS_CACHE_LIFETIME', 1);
82 define('FEEDWORDPRESS_FETCH_TIME_OUT', 60);
83 else :
84 // Hold onto data all day for conditional GET purposes,
85 // but consider it stale after 1 min (requiring a conditional GET)
86 define('FEEDWORDPRESS_CACHE_LIFETIME', 24*60*60);
87 define('FEEDWORDPRESS_CACHE_AGE', 1*60);
88 define('FEEDWORDPRESS_FETCH_TIME_OUT', 10);
89 endif;
90
91 // Use our the cache settings that we want.
92 add_filter('wp_feed_cache_transient_lifetime', array('FeedWordPress', 'cache_lifetime'));
93
94 // Ensure that we have SimplePie loaded up and ready to go.
95 // We no longer need a MagpieRSS upgrade module. Hallelujah!
96 require_once(ABSPATH . WPINC . '/feed.php');
97
98 if (isset($wp_db_version)) :
99 if ($wp_db_version >= FWP_SCHEMA_23) :
100 require_once (ABSPATH . WPINC . '/registration.php'); // for wp_insert_user
101 elseif ($wp_db_version >= FWP_SCHEMA_21) : // WordPress 2.1 and 2.2, but not 2.3
102 require_once (ABSPATH . WPINC . '/registration.php'); // for wp_insert_user
103 require_once (ABSPATH . 'wp-admin/admin-db.php'); // for wp_insert_category
104 elseif ($wp_db_version >= FWP_SCHEMA_20) : // WordPress 2.0
105 require_once (ABSPATH . WPINC . '/registration-functions.php'); // for wp_insert_user
106 require_once (ABSPATH . 'wp-admin/admin-db.php'); // for wp_insert_category
107 endif;
108 endif;
109
110 require_once(dirname(__FILE__) . '/compatability.php'); // LEGACY API: Replicate or mock up functions for legacy support purposes
111 require_once(dirname(__FILE__) . '/feedwordpresshtml.class.php');
112
113 // Magic quotes are just about the stupidest thing ever.
114 if (is_array($_POST)) :
115 $fwp_post = stripslashes_deep($_POST);
116 endif;
117
118 // Get the path relative to the plugins directory in which FWP is stored
119 preg_match (
120 '|/wp-content/plugins/(.+)$|',
121 dirname(__FILE__),
122 $ref
123 );
124
125 if (isset($ref[1])) :
126 $fwp_path = $ref[1];
127 else : // Something went wrong. Let's just guess.
128 $fwp_path = 'feedwordpress';
129 endif;
130
131 function feedwordpress_admin_scripts () {
132 wp_enqueue_script('post'); // for magic tag and category boxes
133 wp_enqueue_script('admin-forms'); // for checkbox selection
134 }
135
136 // If this is a FeedWordPress admin page, queue up scripts for AJAX functions that FWP uses
137 // If it is a display page or a non-FeedWordPress admin page, don't.
138 if (is_admin() and isset($_REQUEST['page']) and preg_match("|^{$fwp_path}/|", $_REQUEST['page'])) :
139 if (function_exists('wp_enqueue_script')) :
140 if (FeedWordPressCompatibility::test_version(FWP_SCHEMA_29)) :
141 add_action('admin_print_scripts', 'feedwordpress_admin_scripts');
142 elseif (FeedWordPressCompatibility::test_version(FWP_SCHEMA_25)) :
143 wp_enqueue_script('post'); // for magic tag and category boxes
144 wp_enqueue_script('thickbox'); // for fold-up boxes
145 wp_enqueue_script('admin-forms'); // for checkbox selection
146 else :
147 wp_enqueue_script( 'ajaxcat' ); // Provides the handy-dandy new category text box
148 endif;
149 endif;
150 if (function_exists('wp_enqueue_style')) :
151 if (fwp_test_wp_version(FWP_SCHEMA_25)) :
152 wp_enqueue_style('dashboard');
153 endif;
154 endif;
155 if (function_exists('wp_admin_css')) :
156 if (fwp_test_wp_version(FWP_SCHEMA_25)) :
157 wp_admin_css('css/dashboard');
158 endif;
159 endif;
160 endif;
161
162 if (!FeedWordPress::needs_upgrade()) : // only work if the conditions are safe!
163
164 # Syndicated items are generally received in output-ready (X)HTML and
165 # should not be folded, crumpled, mutilated, or spindled by WordPress
166 # formatting filters. But we don't want to interfere with filters for
167 # any locally-authored posts, either.
168 #
169 # What WordPress should really have is a way for upstream filters to
170 # stop downstream filters from running at all. Since it doesn't, and
171 # since a downstream filter can't access the original copy of the text
172 # that is being filtered, what we will do here is (1) save a copy of the
173 # original text upstream, before any other filters run, and then (2)
174 # retrieve that copy downstream, after all the other filters run, *if*
175 # this is a syndicated post
176
177 add_filter('the_content', 'feedwordpress_preserve_syndicated_content', -10000);
178 add_filter('the_content', 'feedwordpress_restore_syndicated_content', 10000);
179
180 add_action('atom_entry', 'feedwordpress_item_feed_data');
181
182 # Filter in original permalinks if the user wants that
183 add_filter('post_link', 'syndication_permalink', 1);
184
185 # When foreign URLs are used for permalinks in feeds or display
186 # contexts, they need to be escaped properly.
187 add_filter('the_permalink', 'syndication_permalink_escaped');
188 add_filter('the_permalink_rss', 'syndication_permalink_escaped');
189
190 add_filter('post_comments_feed_link', 'syndication_comments_feed_link');
191
192 # WTF? By default, wp_insert_link runs incoming link_url and link_rss
193 # URIs through default filters that include `wp_kses()`. But `wp_kses()`
194 # just happens to escape any occurrence of & to &amp; -- which just
195 # happens to fuck up any URI with a & to separate GET parameters.
196 remove_filter('pre_link_rss', 'wp_filter_kses');
197 remove_filter('pre_link_url', 'wp_filter_kses');
198
199 # Admin menu
200 add_action('admin_menu', 'fwp_add_pages');
201 add_action('admin_notices', 'fwp_check_debug');
202
203 add_action('admin_menu', 'feedwordpress_add_post_edit_controls');
204 add_action('save_post', 'feedwordpress_save_post_edit_controls');
205
206 # Inbound XML-RPC update methods
207 add_filter('xmlrpc_methods', 'feedwordpress_xmlrpc_hook');
208
209 # Outbound XML-RPC ping reform
210 remove_action('publish_post', 'generic_ping'); // WP 1.5.x
211 remove_action('do_pings', 'do_all_pings', 10, 1); // WP 2.1, 2.2
212 remove_action('publish_post', '_publish_post_hook', 5, 1); // WP 2.3
213
214 add_action('publish_post', 'fwp_publish_post_hook', 5, 1);
215 add_action('do_pings', 'fwp_do_pings', 10, 1);
216 add_action('feedwordpress_update', 'fwp_hold_pings');
217 add_action('feedwordpress_update_complete', 'fwp_release_pings');
218
219 # Hook in logging functions only if the logging option is ON
220 $update_logging = get_option('feedwordpress_update_logging');
221 if ($update_logging == 'yes') :
222 add_action('post_syndicated_item', 'log_feedwordpress_post', 100);
223 add_action('update_syndicated_item', 'log_feedwordpress_update_post', 100);
224 add_action('feedwordpress_update', 'log_feedwordpress_update_feeds', 100);
225 add_action('feedwordpress_check_feed', 'log_feedwordpress_check_feed', 100);
226 add_action('feedwordpress_update_complete', 'log_feedwordpress_update_complete', 100);
227 endif;
228
229 if (FeedWordPress::update_requested()) :
230 if (FEEDWORDPRESS_DEBUG) :
231 add_action('post_syndicated_item', 'debug_out_feedwordpress_post', 100);
232 add_action('update_syndicated_item', 'debug_out_feedwordpress_update_post', 100);
233 add_action('feedwordpress_update', 'debug_out_feedwordpress_update_feeds', 100);
234 add_action('feedwordpress_check_feed', 'debug_out_feedwordpress_check_feed', 100);
235 add_action('feedwordpress_update_complete', 'debug_out_feedwordpress_update_complete', 100);
236 endif;
237
238 add_action('feedwordpress_check_feed_complete', 'debug_out_feedwordpress_feed_error', 100, 3);
239 endif;
240
241 # Cron-less auto-update. Hooray!
242 $autoUpdateHook = get_option('feedwordpress_automatic_updates');
243 if ($autoUpdateHook != 'init') :
244 $autoUpdateHook = 'shutdown';
245 endif;
246 add_action($autoUpdateHook, 'feedwordpress_auto_update');
247
248 add_action('init', 'feedwordpress_update_magic_url');
249
250 # Default sanitizers
251 add_filter('syndicated_item_content', array('SyndicatedPost', 'resolve_relative_uris'), 0, 2);
252 add_filter('syndicated_item_content', array('SyndicatedPost', 'sanitize_content'), 0, 2);
253
254 else :
255 # Hook in the menus, which will just point to the upgrade interface
256 add_action('admin_menu', 'fwp_add_pages');
257 endif; // if (!FeedWordPress::needs_upgrade())
258
259 function feedwordpress_auto_update () {
260 if (FeedWordPress::stale()) :
261 $feedwordpress = new FeedWordPress;
262 $feedwordpress->update();
263 endif;
264 } /* feedwordpress_auto_update () */
265
266 function feedwordpress_update_magic_url () {
267 global $wpdb;
268
269 // Explicit update request in the HTTP request (e.g. from a cron job)
270 if (FeedWordPress::update_requested()) :
271 $feedwordpress = new FeedWordPress;
272 $feedwordpress->update(FeedWordPress::update_requested_url());
273
274 if (FEEDWORDPRESS_DEBUG and count($wpdb->queries) > 0) :
275 $mysqlTime = 0.0;
276 $byTime = array();
277 foreach ($wpdb->queries as $query) :
278 $time = $query[1] * 1000000.0;
279 $mysqlTime += $query[1];
280 if (!isset($byTime[$time])) : $byTime[$time] = array(); endif;
281 $byTime[$time][] = $query[0]. ' // STACK: ' . $query[2];
282 endforeach;
283 krsort($byTime);
284
285 foreach ($byTime as $time => $querySet) :
286 foreach ($querySet as $query) :
287 print "[".(sprintf('%4.4f', $time/1000.0)) . "ms] $query\n";
288 endforeach;
289 endforeach;
290 echo "[feedwordpress] $wpdb->num_queries queries. $mysqlTime seconds in MySQL. Total of "; timer_stop(1); print " seconds.";
291 endif;
292
293
294 // Magic URL should return nothing but a 200 OK header packet
295 // when successful.
296 exit;
297 endif;
298 } /* feedwordpress_magic_update_url () */
299
300 ################################################################################
301 ## LOGGING FUNCTIONS: log status updates to error_log if you want it ###########
302 ################################################################################
303
304 function log_feedwordpress_post ($id) {
305 $post = wp_get_single_post($id);
306 error_log("[".date('Y-m-d H:i:s')."][feedwordpress] posted "
307 ."'{$post->post_title}' ({$post->post_date})");
308 }
309
310 function log_feedwordpress_update_post ($id) {
311 $post = wp_get_single_post($id);
312 error_log("[".date('Y-m-d H:i:s')."][feedwordpress] updated "
313 ."'{$post->post_title}' ({$post->post_date})"
314 ." (as of {$post->post_modified})");
315 }
316
317 function log_feedwordpress_update_feeds ($uri) {
318 error_log("[".date('Y-m-d H:i:s')."][feedwordpress] update('$uri')");
319 }
320
321 function log_feedwordpress_check_feed ($feed) {
322 $uri = $feed['link/uri']; $name = $feed['link/name'];
323 error_log("[".date('Y-m-d H:i:s')."][feedwordpress] Examining $name <$uri>");
324 }
325
326 function log_feedwordpress_update_complete ($delta) {
327 $mesg = array();
328 if (isset($delta['new'])) $mesg[] = 'added '.$delta['new'].' new posts';
329 if (isset($delta['updated'])) $mesg[] = 'updated '.$delta['updated'].' existing posts';
330 if (empty($mesg)) $mesg[] = 'nothing changed';
331
332 error_log("[".date('Y-m-d H:i:s')."][feedwordpress] "
333 .(is_null($delta) ? "Error: I don't syndicate that URI"
334 : implode(' and ', $mesg)));
335 }
336
337 function debug_out_feedwordpress_post ($id) {
338 $post = wp_get_single_post($id);
339 print ("[".date('Y-m-d H:i:s')."][feedwordpress] posted "
340 ."'{$post->post_title}' ({$post->post_date})\n");
341 }
342
343 function debug_out_feedwordpress_update_post ($id) {
344 $post = wp_get_single_post($id);
345 print ("[".date('Y-m-d H:i:s')."][feedwordpress] updated "
346 ."'{$post->post_title}' ({$post->post_date})"
347 ." (as of {$post->post_modified})\n");
348 }
349
350 function debug_out_feedwordpress_update_feeds ($uri) {
351 print ("[".date('Y-m-d H:i:s')."][feedwordpress] update('$uri')\n");
352 }
353
354 function debug_out_feedwordpress_check_feed ($feed) {
355 $uri = $feed['link/uri']; $name = $feed['link/name'];
356 print ("[".date('Y-m-d H:i:s')."][feedwordpress] Examining $name <$uri>\n");
357 }
358
359 function debug_out_feedwordpress_update_complete ($delta) {
360 $mesg = array();
361 if (isset($delta['new'])) $mesg[] = 'added '.$delta['new'].' new posts';
362 if (isset($delta['updated'])) $mesg[] = 'updated '.$delta['updated'].' existing posts';
363 if (empty($mesg)) $mesg[] = 'nothing changed';
364
365 print ("[".date('Y-m-d H:i:s')."][feedwordpress] "
366 .(is_null($delta) ? "Error: I don't syndicate that URI"
367 : implode(' and ', $mesg))."\n");
368 }
369
370 function debug_out_feedwordpress_feed_error ($feed, $added, $dt) {
371 if (is_wp_error($added)) :
372 $mesgs = $added->get_error_messages();
373 foreach ($mesgs as $mesg) :
374 echo "[feedwordpress] Error updating [{$feed['link/uri']}]: $mesg\n";
375 endforeach;
376 endif;
377 }
378
379 ################################################################################
380 ## TEMPLATE API: functions to make your templates syndication-aware ############
381 ################################################################################
382
383 /**
384 * is_syndicated: Tests whether the current post in a Loop context, or a post
385 * given by ID number, was syndicated by FeedWordPress. Useful for templates
386 * to determine whether or not to retrieve syndication-related meta-data in
387 * displaying a post.
388 *
389 * @param int $id The post to check for syndicated status. Defaults to the current post in a Loop context.
390 * @return bool TRUE if the post's meta-data indicates it was syndicated; FALSE otherwise
391 */
392 function is_syndicated ($id = NULL) {
393 return (strlen(get_syndication_feed_id($id)) > 0);
394 } /* function is_syndicated() */
395
396 function get_syndication_source_link ($original = NULL, $id = NULL) {
397 if (is_null($original)) : $original = FeedWordPress::use_aggregator_source_data();
398 endif;
399
400 if ($original) : $vals = get_post_custom_values('syndication_source_uri_original', $id);
401 else : $vals = array();
402 endif;
403
404 if (count($vals) == 0) : $vals = get_post_custom_values('syndication_source_uri', $id);
405 endif;
406
407 if (count($vals) > 0) : $ret = $vals[0]; else : $ret = NULL; endif;
408
409 return $ret;
410 } /* function get_syndication_source_link() */
411
412 function the_syndication_source_link ($original = NULL, $id = NULL) {
413 echo get_syndication_source_link($original, $id);
414 }
415
416 function feedwordpress_display_url ($url, $before = 60, $after = 0) {
417 $bits = parse_url($url);
418
419 // Strip out crufty subdomains
420 $bits['host'] = preg_replace('/^www[0-9]*\./i', '', $bits['host']);
421
422 // Reassemble bit-by-bit with minimum of crufty elements
423 $url = (isset($bits['user'])?$bits['user'].'@':'')
424 .(isset($bits['host'])?$bits['host']:'')
425 .(isset($bits['path'])?$bits['path']:'')
426 .(isset($uri_bits['port'])?':'.$uri_bits['port']:'')
427 .(isset($bits['query'])?'?'.$bits['query']:'');
428
429 if (strlen($url) > ($before+$after)) :
430 $url = substr($url, 0, $before).'…'.substr($url, 0 - $after, $after);
431 endif;
432
433 return $url;
434 }
435
436 function get_syndication_source ($original = NULL, $id = NULL) {
437 if (is_null($original)) :
438 $original = FeedWordPress::use_aggregator_source_data();
439 endif;
440
441 if ($original) :
442 $vals = get_post_custom_values('syndication_source_original', $id);
443 else :
444 $vals = array();
445 endif;
446
447 if (count($vals) == 0) :
448 $vals = get_post_custom_values('syndication_source', $id);
449 endif;
450
451 if (count($vals) > 0) :
452 $ret = $vals[0];
453 else :
454 $ret = NULL;
455 endif;
456
457 if (is_null($ret) or strlen(trim($ret)) == 0) :
458 // Fall back to URL of blog
459 $ret = feedwordpress_display_url(get_syndication_source_link());
460 endif;
461
462 return $ret;
463 } /* function get_syndication_source() */
464
465 function the_syndication_source ($original = NULL, $id = NULL) { echo get_syndication_source($original, $id); }
466
467 function get_syndication_feed ($original = NULL, $id = NULL) {
468 if (is_null($original)) : $original = FeedWordPress::use_aggregator_source_data();
469 endif;
470
471 if ($original) : $vals = get_post_custom_values('syndication_feed_original', $id);
472 else : $vals = array();
473 endif;
474
475 if (count($vals) == 0) : $vals = get_post_custom_values('syndication_feed', $id);
476 endif;
477
478 if (count($vals) > 0) : $ret = $vals[0]; else : $ret = NULL; endif;
479
480 return $ret;
481 } /* function get_syndication_feed() */
482
483 function the_syndication_feed ($original = NULL, $id = NULL) { echo get_syndication_feed($original, $id); }
484
485 function get_syndication_feed_guid ($original = NULL, $id = NULL) {
486 if (is_null($original)) : $original = FeedWordPress::use_aggregator_source_data();
487 endif;
488
489 if ($original) : $vals = get_post_custom_values('syndication_source_id_original', $id);
490 else : $vals = array();
491 endif;
492
493 if (count($vals) == 0) : $vals = array(get_feed_meta('feed/id', $id));
494 endif;
495
496 if (count($vals) > 0) : $ret = $vals[0]; else : $ret = NULL; endif;
497
498 return $ret;
499 } /* function get_syndication_feed_guid () */
500
501 function the_syndication_feed_guid ($original = NULL, $id = NULL) { echo get_syndication_feed_guid($original, $id); }
502
503 function get_syndication_feed_id ($id = NULL) { list($u) = get_post_custom_values('syndication_feed_id', $id); return $u; }
504 function the_syndication_feed_id ($id = NULL) { echo get_syndication_feed_id($id); }
505
506 $feedwordpress_linkcache = array (); // only load links from database once
507 function get_syndication_feed_object ($id = NULL) {
508 global $feedwordpress_linkcache;
509
510 $link = NULL;
511
512 $feed_id = get_syndication_feed_id($id);
513 if (strlen($feed_id) > 0):
514 if (isset($feedwordpress_linkcache[$feed_id])) :
515 $link = $feedwordpress_linkcache[$feed_id];
516 else :
517 $link = new SyndicatedLink($feed_id);
518 $feedwordpress_linkcache[$feed_id] = $link;
519 endif;
520 endif;
521 return $link;
522 }
523
524 function get_feed_meta ($key, $id = NULL) {
525 $ret = NULL;
526
527 $link = get_syndication_feed_object($id);
528 if (is_object($link) and isset($link->settings[$key])) :
529 $ret = $link->settings[$key];
530 endif;
531 return $ret;
532 } /* get_feed_meta() */
533
534 function get_syndication_permalink ($id = NULL) {
535 list($u) = get_post_custom_values('syndication_permalink', $id); return $u;
536 }
537 function the_syndication_permalink ($id = NULL) {
538 echo get_syndication_permalink($id);
539 }
540
541 /**
542 * get_local_permalink: returns a string containing the internal permalink
543 * for a post (whether syndicated or not) on your local WordPress installation.
544 * This may be useful if you want permalinks to point to the original source of
545 * an article for most purposes, but want to retrieve a URL for the local
546 * representation of the post for one or two limited purposes (for example,
547 * linking to a comments page on your local aggregator site).
548 *
549 * @param $id The numerical ID of the post to get the permalink for. If empty,
550 * defaults to the current post in a Loop context.
551 * @return string The URL of the local permalink for this post.
552 *
553 * @uses get_permalink()
554 * @global $feedwordpress_the_original_permalink
555 *
556 * @since 2010.0217
557 */
558 function get_local_permalink ($id = NULL) {
559 global $feedwordpress_the_original_permalink;
560
561 // get permalink, and thus activate filter and force global to be filled
562 // with original URL.
563 $url = get_permalink($id);
564 return $feedwordpress_the_original_permalink;
565 } /* get_local_permalink() */
566
567 /**
568 * the_original_permalink: displays the contents of get_original_permalink()
569 *
570 * @param $id The numerical ID of the post to get the permalink for. If empty,
571 * defaults to the current post in a Loop context.
572 *
573 * @uses get_local_permalinks()
574 * @uses apply_filters
575 *
576 * @since 2010.0217
577 */
578 function the_local_permalink ($id = NULL) {
579 print apply_filters('the_permalink', get_local_permalink($id));
580 } /* function the_local_permalink() */
581
582 ################################################################################
583 ## FILTERS: syndication-aware handling of post data for templates and feeds ####
584 ################################################################################
585
586 $feedwordpress_the_syndicated_content = NULL;
587 $feedwordpress_the_original_permalink = NULL;
588
589 function feedwordpress_preserve_syndicated_content ($text) {
590 global $feedwordpress_the_syndicated_content;
591
592 $globalExpose = (get_option('feedwordpress_formatting_filters') == 'yes');
593 $localExpose = get_post_custom_values('_feedwordpress_formatting_filters');
594 $expose = ($globalExpose or ((count($localExpose) > 0) and $localExpose[0]));
595
596 if ( is_syndicated() and !$expose ) :
597 $feedwordpress_the_syndicated_content = $text;
598 else :
599 $feedwordpress_the_syndicated_content = NULL;
600 endif;
601 return $text;
602 }
603
604 function feedwordpress_restore_syndicated_content ($text) {
605 global $feedwordpress_the_syndicated_content;
606
607 if ( !is_null($feedwordpress_the_syndicated_content) ) :
608 $text = $feedwordpress_the_syndicated_content;
609 endif;
610
611 return $text;
612 }
613
614 function feedwordpress_item_feed_data () {
615 // In a post context....
616 if (is_syndicated()) :
617 ?>
618 <source>
619 <title><?php print htmlspecialchars(get_syndication_source()); ?></title>
620 <link rel="alternate" type="text/html" href="<?php print htmlspecialchars(get_syndication_source_link()); ?>" />
621 <link rel="self" href="<?php print htmlspecialchars(get_syndication_feed()); ?>" />
622 <?php
623 $id = get_syndication_feed_guid();
624 if (strlen($id) > 0) :
625 ?>
626 <id><?php print htmlspecialchars($id); ?></id>
627 <?php
628 endif;
629 $updated = get_feed_meta('feed/updated');
630 if (strlen($updated) > 0) : ?>
631 <updated><?php print $updated; ?></updated>
632 <?php
633 endif;
634 ?>
635 </source>
636 <?php
637 endif;
638 }
639
640 /**
641 * syndication_permalink: Allow WordPress to use the original remote URL of
642 * syndicated posts as their permalink. Can be turned on or off by by setting in
643 * Syndication => Posts & Links. Saves the old internal permalink in a global
644 * variable for later use.
645 *
646 * @param string $permalink The internal permalink
647 * @return string The new permalink. Same as the old if the post is not
648 * syndicated, or if FWP is set to use internal permalinks, or if the post
649 * was syndicated, but didn't have a proper permalink recorded.
650 *
651 * @uses FeedWordPress::munge_permalinks()
652 * @uses get_syndication_permalink()
653 * @global $feedwordpress_the_original_permalink
654 */
655 function syndication_permalink ($permalink = '') {
656 global $feedwordpress_the_original_permalink;
657
658 // Save the local permalink in case we need to retrieve it later.
659 $feedwordpress_the_original_permalink = $permalink;
660
661 // Map this permalink to a post ID so we can get the correct permalink
662 // even outside of the Post Loop. Props Björn.
663 $id = url_to_postid($permalink);
664
665 $munge = false;
666 $link = get_syndication_feed_object($id);
667 if (is_object($link)) :
668 $munge = ($link->setting('munge permalink', 'munge_permalink', 'yes') != 'no');
669 endif;
670
671 if ($munge):
672 $uri = get_syndication_permalink($id);
673 $permalink = ((strlen($uri) > 0) ? $uri : $permalink);
674 endif;
675 return $permalink;
676 } /* function syndication_permalink () */
677
678 /**
679 * syndication_permalink_escaped: Escape XML special characters in syndicated
680 * permalinks when used in feed contexts and HTML display contexts.
681 *
682 * @param string $permalink
683 * @return string
684 *
685 * @uses is_syndicated()
686 * @uses FeedWordPress::munge_permalinks()
687 *
688 */
689 function syndication_permalink_escaped ($permalink) {
690 if (is_syndicated() and FeedWordPress::munge_permalinks()) :
691 // This is a foreign link; WordPress can't vouch for its not
692 // having any entities that need to be &-escaped. So we'll do
693 // it here.
694 $permalink = esc_html($permalink);
695 endif;
696 return $permalink;
697 } /* function syndication_permalink_escaped() */
698
699 /**
700 * syndication_comments_feed_link: Escape XML special characters in comments
701 * feed links
702 *
703 * @param string $link
704 * @return string
705 *
706 * @uses is_syndicated()
707 * @uses FeedWordPress::munge_permalinks()
708 */
709 function syndication_comments_feed_link ($link) {
710 global $feedwordpress_the_original_permalink, $id;
711
712 if (is_syndicated() and FeedWordPress::munge_permalinks()) :
713 // If the source post provided a comment feed URL using
714 // wfw:commentRss or atom:link/@rel="replies" we can make use of
715 // that value here.
716 $source = get_syndication_feed_object();
717 $replacement = NULL;
718 if ($source->setting('munge comments feed links', 'munge_comments_feed_links', 'yes') != 'no') :
719 $commentFeeds = get_post_custom_values('wfw:commentRSS');
720 if (
721 is_array($commentFeeds)
722 and (count($commentFeeds) > 0)
723 and (strlen($commentFeeds[0]) > 0)
724 ) :
725 $replacement = $commentFeeds[0];
726
727 // This is a foreign link; WordPress can't vouch for its not
728 // having any entities that need to be &-escaped. So we'll do it
729 // here.
730 $replacement = esc_html($replacement);
731 endif;
732 endif;
733
734 if (is_null($replacement)) :
735 // Q: How can we get the proper feed format, since the
736 // format is, stupidly, not passed to the filter?
737 // A: Kludge kludge kludge kludge!
738 $fancy_permalinks = ('' != get_option('permalink_structure'));
739 if ($fancy_permalinks) :
740 preg_match('|/feed(/([^/]+))?/?$|', $link, $ref);
741
742 $format = (isset($ref[2]) ? $ref[2] : '');
743 if (strlen($format) == 0) : $format = get_default_feed(); endif;
744
745 $replacement = trailingslashit($feedwordpress_the_original_permalink) . 'feed';
746 if ($format != get_default_feed()) :
747 $replacement .= '/'.$format;
748 endif;
749 $replacement = user_trailingslashit($replacement, 'single_feed');
750 else :
751 // No fancy permalinks = no problem
752 // WordPress doesn't call get_permalink() to
753 // generate the comment feed URL, so the
754 // comments feed link is never munged by FWP.
755 endif;
756 endif;
757
758 if (!is_null($replacement)) : $link = $replacement; endif;
759 endif;
760 return $link;
761 } /* function syndication_comments_feed_link() */
762
763 ################################################################################
764 ## ADMIN MENU ADD-ONS: register Dashboard management pages #####################
765 ################################################################################
766
767 function fwp_add_pages () {
768 global $fwp_capability;
769 global $fwp_path;
770
771 $menu = array('Syndicated Sites', 'Syndication', $fwp_capability['manage_links'], $fwp_path.'/syndication.php', NULL);
772 if (fwp_test_wp_version(FWP_SCHEMA_27)) :
773 // add icon parameter
774 $menu[] = WP_PLUGIN_URL.'/'.$fwp_path.'/feedwordpress-tiny.png';
775 endif;
776
777 call_user_func_array('add_menu_page', $menu);
778 add_submenu_page($fwp_path.'/syndication.php', 'Syndicated Feeds & Updates', 'Feeds & Updates', $fwp_capability['manage_options'], $fwp_path.'/feeds-page.php');
779 add_submenu_page($fwp_path.'/syndication.php', 'Syndicated Posts & Links', 'Posts & Links', $fwp_capability['manage_options'], $fwp_path.'/posts-page.php');
780 add_submenu_page($fwp_path.'/syndication.php', 'Syndicated Authors', 'Authors', $fwp_capability['manage_options'], $fwp_path.'/authors-page.php');
781 add_submenu_page($fwp_path.'/syndication.php', 'Categories'.FEEDWORDPRESS_AND_TAGS, 'Categories'.FEEDWORDPRESS_AND_TAGS, $fwp_capability['manage_options'], $fwp_path.'/categories-page.php');
782 add_submenu_page($fwp_path.'/syndication.php', 'FeedWordPress Back End', 'Back End', $fwp_capability['manage_options'], $fwp_path.'/backend-page.php');
783 } /* function fwp_add_pages () */
784
785 function fwp_check_debug () {
786 // This is a horrible fucking kludge that I have to do because the
787 // admin notice code is triggered before the code that updates the
788 // setting.
789 if (isset($_POST['feedwordpress_debug'])) :
790 $feedwordpress_debug = $_POST['feedwordpress_debug'];
791 else :
792 $feedwordpress_debug = get_option('feedwordpress_debug');
793 endif;
794 if ($feedwordpress_debug==='yes') :
795 ?>
796 <div class="error">
797 <p><strong>FeedWordPress warning.</strong> Debugging mode is <strong>ON</strong>.
798 While it remains on, FeedWordPress displays many diagnostic error messages,
799 warnings, and notices that are ordinarily suppressed, and also turns off all
800 caching of feeds. Use with caution: this setting is absolutely inappropriate
801 for a production server.</p>
802 </div>
803 <?php
804 endif;
805 } /* function fwp_check_debug () */
806
807 ################################################################################
808 ## fwp_hold_pings() and fwp_release_pings(): Outbound XML-RPC ping reform ####
809 ## ... 'coz it's rude to send 500 pings the first time your aggregator runs ####
810 ################################################################################
811
812 $fwp_held_ping = NULL; // NULL: not holding pings yet
813
814 function fwp_hold_pings () {
815 global $fwp_held_ping;
816 if (is_null($fwp_held_ping)):
817 $fwp_held_ping = 0; // 0: ready to hold pings; none yet received
818 endif;
819 }
820
821 function fwp_release_pings () {
822 global $fwp_held_ping;
823 if ($fwp_held_ping):
824 if (function_exists('wp_schedule_single_event')) :
825 wp_schedule_single_event(time(), 'do_pings');
826 else :
827 generic_ping($fwp_held_ping);
828 endif;
829 endif;
830 $fwp_held_ping = NULL; // NULL: not holding pings anymore
831 }
832
833 function fwp_do_pings () {
834 if (!is_null($fwp_held_ping) and $post_id) : // Defer until we're done updating
835 $fwp_held_ping = $post_id;
836 elseif (function_exists('do_all_pings')) :
837 do_all_pings();
838 else :
839 generic_ping($fwp_held_ping);
840 endif;
841 }
842
843 function fwp_publish_post_hook ($post_id) {
844 global $fwp_held_ping;
845
846 if (!is_null($fwp_held_ping)) : // Syndicated post. Don't mark with _pingme
847 if ( defined('XMLRPC_REQUEST') )
848 do_action('xmlrpc_publish_post', $post_id);
849 if ( defined('APP_REQUEST') )
850 do_action('app_publish_post', $post_id);
851
852 if ( defined('WP_IMPORTING') )
853 return;
854
855 // Defer sending out pings until we finish updating
856 $fwp_held_ping = $post_id;
857 else :
858 if (function_exists('_publish_post_hook')) : // WordPress 2.3
859 _publish_post_hook($post_id);
860 endif;
861 endif;
862 }
863
864 function feedwordpress_add_post_edit_controls () {
865 add_meta_box('feedwordpress-post-controls', __('Syndication'), 'feedwordpress_post_edit_controls', 'post', 'side', 'high');
866 } // function FeedWordPress::postEditControls
867
868 function feedwordpress_post_edit_controls () {
869 global $post;
870
871 $frozen_values = get_post_custom_values('_syndication_freeze_updates', $post->ID);
872 $frozen_post = (count($frozen_values) > 0 and 'yes' == $frozen_values[0]);
873
874 if (is_syndicated($post->ID)) :
875 ?>
876 <p>This is a syndicated post, which originally appeared at
877 <cite><?php print esc_html(get_syndication_source(NULL, $post->ID)); ?></cite>.
878 <a href="<?php print esc_html(get_syndication_permalink($post->ID)); ?>">View original post</a>.</p>
879
880 <p><input type="hidden" name="feedwordpress_noncename" id="feedwordpress_noncename" value="<?php print wp_create_nonce(plugin_basename(__FILE__)); ?>" />
881 <label><input type="checkbox" name="freeze_updates" value="yes" <?php if ($frozen_post) : ?>checked="checked"<?php endif; ?> /> <strong>Manual editing.</strong>
882 If set, FeedWordPress will not overwrite the changes you make manually
883 to this post, if the syndicated content is updated on the
884 feed.</label></p>
885 <?php
886 else :
887 ?>
888 <p>This post was created locally at this website.</p>
889 <?php
890 endif;
891 } // function feedwordpress_post_edit_controls () */
892
893 function feedwordpress_save_post_edit_controls ( $post_id ) {
894 global $post;
895
896 if (!isset($_POST['feedwordpress_noncename']) or !wp_verify_nonce($_POST['feedwordpress_noncename'], plugin_basename(__FILE__))) :
897 return $post_id;
898 endif;
899
900 // Verify if this is an auto save routine. If it is our form has
901 // not been submitted, so we don't want to do anything.
902 if ( defined('DOING_AUTOSAVE') and DOING_AUTOSAVE ) :
903 return $post_id;
904 endif;
905
906 // Check permissions
907 if ( !current_user_can( 'edit_'.$_POST['post_type'], $post_id) ) :
908 return $post_id;
909 endif;
910
911 // OK, we're golden. Now let's save some data.
912 if (isset($_POST['freeze_updates'])) :
913 update_post_meta($post_id, '_syndication_freeze_updates', $_POST['freeze_updates']);
914 else :
915 delete_post_meta($post_id, '_syndication_freeze_updates');
916 endif;
917
918 return $_POST['freeze_updates'];
919 } // function feedwordpress_save_edit_controls
920
921 ################################################################################
922 ## class FeedWordPress #########################################################
923 ################################################################################
924
925 // class FeedWordPress: handles feed updates and plugs in to the XML-RPC interface
926 class FeedWordPress {
927 var $strip_attrs = array (
928 array('[a-z]+', 'style'),
929 array('[a-z]+', 'target'),
930 );
931 var $uri_attrs = array (
932 array('a', 'href'),
933 array('applet', 'codebase'),
934 array('area', 'href'),
935 array('blockquote', 'cite'),
936 array('body', 'background'),
937 array('del', 'cite'),
938 array('form', 'action'),
939 array('frame', 'longdesc'),
940 array('frame', 'src'),
941 array('iframe', 'longdesc'),
942 array('iframe', 'src'),
943 array('head', 'profile'),
944 array('img', 'longdesc'),
945 array('img', 'src'),
946 array('img', 'usemap'),
947 array('input', 'src'),
948 array('input', 'usemap'),
949 array('ins', 'cite'),
950 array('link', 'href'),
951 array('object', 'classid'),
952 array('object', 'codebase'),
953 array('object', 'data'),
954 array('object', 'usemap'),
955 array('q', 'cite'),
956 array('script', 'src')
957 );
958
959 var $feeds = NULL;
960
961 # function FeedWordPress (): Contructor; retrieve a list of feeds
962 function FeedWordPress () {
963 $this->feeds = array ();
964 $links = FeedWordPress::syndicated_links();
965 if ($links): foreach ($links as $link):
966 $this->feeds[] = new SyndicatedLink($link);
967 endforeach; endif;
968 } // FeedWordPress::FeedWordPress ()
969
970 # function update (): polls for updates on one or more Contributor feeds
971 #
972 # Arguments:
973 # ----------
974 # * $uri (string): either the URI of the feed to poll, the URI of the
975 # (human-readable) website whose feed you want to poll, or NULL.
976 #
977 # If $uri is NULL, then FeedWordPress will poll any feeds that are
978 # ready for polling. It will not poll feeds that are marked as
979 # "Invisible" Links (signifying that the subscription has been
980 # de-activated), or feeds that are not yet stale according to their
981 # TTL setting (which is either set in the feed, or else set
982 # randomly within a window of 30 minutes - 2 hours).
983 #
984 # Returns:
985 # --------
986 # * Normally returns an associative array, with 'new' => the number
987 # of new posts added during the update, and 'updated' => the number
988 # of old posts that were updated during the update. If both numbers
989 # are zero, there was no change since the last poll on that URI.
990 #
991 # * Returns NULL if URI it was passed was not a URI that this
992 # installation of FeedWordPress syndicates.
993 #
994 # Effects:
995 # --------
996 # * One or more feeds are polled for updates
997 #
998 # * If the feed Link does not have a hardcoded name set, its Link
999 # Name is synchronized with the feed's title element
1000 #
1001 # * If the feed Link does not have a hardcoded URI set, its Link URI
1002 # is synchronized with the feed's human-readable link element
1003 #
1004 # * If the feed Link does not have a hardcoded description set, its
1005 # Link Description is synchronized with the feed's description,
1006 # tagline, or subtitle element.
1007 #
1008 # * The time of polling is recorded in the feed's settings, and the
1009 # TTL (time until the feed is next available for polling) is set
1010 # either from the feed (if it is supplied in the ttl or syndication
1011 # module elements) or else from a randomly-generated time window
1012 # (between 30 minutes and 2 hours).
1013 #
1014 # * New posts from the polled feed are added to the WordPress store.
1015 #
1016 # * Updates to existing posts since the last poll are mirrored in the
1017 # WordPress store.
1018 #
1019 function update ($uri = null, $crash_ts = null) {
1020 global $wpdb;
1021
1022 if (FeedWordPress::needs_upgrade()) : // Will make duplicate posts if we don't hold off
1023 return NULL;
1024 endif;
1025
1026 if (!is_null($uri)) :
1027 $uri = trim($uri);
1028 else : // Update all
1029 update_option('feedwordpress_last_update_all', time());
1030 endif;
1031
1032 do_action('feedwordpress_update', $uri);
1033
1034 if (is_null($crash_ts)) :
1035 $crash_dt = (int) get_option('feedwordpress_update_time_limit');
1036 if ($crash_dt > 0) :
1037 $crash_ts = time() + $crash_dt;
1038 else :
1039 $crash_ts = NULL;
1040 endif;
1041 endif;
1042
1043 // Randomize order for load balancing purposes
1044 $feed_set = $this->feeds;
1045 shuffle($feed_set);
1046
1047 // Loop through and check for new posts
1048 $delta = NULL;
1049 foreach ($feed_set as $feed) :
1050 if (!is_null($crash_ts) and (time() > $crash_ts)) : // Check whether we've exceeded the time limit
1051 break;
1052 endif;
1053
1054 $pinged_that = (is_null($uri) or ($uri=='*') or in_array($uri, array($feed->uri(), $feed->homepage())));
1055
1056 if (!is_null($uri)) : // A site-specific ping always updates
1057 $timely = true;
1058 else :
1059 $timely = $feed->stale();
1060 endif;
1061
1062 if ($pinged_that and is_null($delta)) : // If at least one feed was hit for updating...
1063 $delta = array('new' => 0, 'updated' => 0); // ... don't return error condition
1064 endif;
1065
1066 if ($pinged_that and $timely) :
1067 do_action('feedwordpress_check_feed', $feed->settings);
1068 $start_ts = time();
1069 $added = $feed->poll($crash_ts);
1070 do_action('feedwordpress_check_feed_complete', $feed->settings, $added, time() - $start_ts);
1071
1072 if (is_array($added)) : // Success
1073 if (isset($added['new'])) : $delta['new'] += $added['new']; endif;
1074 if (isset($added['updated'])) : $delta['updated'] += $added['updated']; endif;
1075 endif;
1076 endif;
1077 endforeach;
1078
1079 do_action('feedwordpress_update_complete', $delta);
1080
1081 return $delta;
1082 }
1083
1084 function stale () {
1085 if (get_option('feedwordpress_automatic_updates')) :
1086 // Do our best to avoid possible simultaneous
1087 // updates by getting up-to-the-minute settings.
1088
1089 $last = get_option('feedwordpress_last_update_all');
1090
1091 // If we haven't updated all yet, give it a time window
1092 if (false === $last) :
1093 $ret = false;
1094 update_option('feedwordpress_last_update_all', time());
1095
1096 // Otherwise, check against freshness interval
1097 elseif (is_numeric($last)) : // Expect a timestamp
1098 $freshness = get_option('feedwordpress_freshness');
1099 if (false === $freshness) : // Use default
1100 $freshness = FEEDWORDPRESS_FRESHNESS_INTERVAL;
1101 endif;
1102 $ret = ( (time() - $last) > $freshness);
1103
1104 // This should never happen.
1105 else :
1106 FeedWordPress::critical_bug('FeedWordPress::stale::last', $last, __LINE__);
1107 endif;
1108
1109 else :
1110 $ret = false;
1111 endif;
1112 return $ret;
1113 } // FeedWordPress::stale()
1114
1115 function update_requested () {
1116 return (
1117 isset($_REQUEST['update_feedwordpress'])
1118 and $_REQUEST['update_feedwordpress']
1119 );
1120 } // FeedWordPress::update_requested()
1121
1122 function update_requested_url () {
1123 $ret = null;
1124
1125 if (($_REQUEST['update_feedwordpress']=='*')
1126 or (preg_match('|^http://.*|i', $_REQUEST['update_feedwordpress']))) :
1127 $ret = $_REQUEST['update_feedwordpress'];
1128 endif;
1129
1130 return $ret;
1131 } // FeedWordPress::update_requested_url()
1132
1133 function syndicate_link ($name, $uri, $rss) {
1134 global $wpdb;
1135
1136 // Get the category ID#
1137 $cat_id = FeedWordPress::link_category_id();
1138
1139 // WordPress gets cranky if there's no homepage URI
1140 if (!isset($uri) or strlen($uri)<1) : $uri = $rss; endif;
1141
1142 if (function_exists('wp_insert_link')) : // WordPress 2.x
1143 if (FeedWordPressCompatibility::test_version(0, FWP_SCHEMA_21)) :
1144 // Morons.
1145 $name = $wpdb->escape($name);
1146 $uri = $wpdb->escape($uri);
1147 $rss = $wpdb->escape($rss);
1148
1149 // Comes in as a single category
1150 $linkCats = $cat_id;
1151 else :
1152 // Comes in as an array of categories
1153 $linkCats = array($cat_id);
1154 endif;
1155
1156 $link_id = wp_insert_link(array(
1157 "link_name" => $name,
1158 "link_url" => $uri,
1159 "link_category" => $linkCats,
1160 "link_rss" => $rss
1161 ));
1162 else : // WordPress 1.5.x
1163 $result = $wpdb->query("
1164 INSERT INTO $wpdb->links
1165 SET
1166 link_name = '".$wpdb->escape($name)."',
1167 link_url = '".$wpdb->escape($uri)."',
1168 link_category = '".$wpdb->escape($cat_id)."',
1169 link_rss = '".$wpdb->escape($rss)."'
1170 ");
1171 $link_id = $wpdb->insert_id;
1172 endif;
1173 return $link_id;
1174 } // function FeedWordPress::syndicate_link()
1175
1176 /*static*/ function syndicated_status ($what, $default) {
1177 $ret = get_option("feedwordpress_syndicated_{$what}_status");
1178 if (!$ret) :
1179 $ret = $default;
1180 endif;
1181 return $ret;
1182 } /* FeedWordPress::syndicated_status() */
1183
1184 function on_unfamiliar ($what = 'author', $override = NULL) {
1185 $set = array(
1186 'author' => array('create', 'default', 'filter'),
1187 'category' => array('create', 'tag', 'default', 'filter'),
1188 );
1189
1190 if (is_string($override)) :
1191 $ret = strtolower($override);
1192 else :
1193 $ret = NULL;
1194 endif;
1195
1196 if (!is_numeric($override) and !in_array($ret, $set[$what])) :
1197 $ret = get_option('feedwordpress_unfamiliar_'.$what);
1198 if (!is_numeric($ret) and !in_array($ret, $set[$what])) :
1199 $ret = 'create';
1200 endif;
1201 endif;
1202
1203 return $ret;
1204 } // function FeedWordPress::on_unfamiliar()
1205
1206 function null_email_set () {
1207 $base = get_option('feedwordpress_null_email_set');
1208
1209 if ($base===false) :
1210 $ret = array('noreply@blogger.com'); // default
1211 else :
1212 $ret = array_map('strtolower',
1213 array_map('trim', explode("\n", $base)));
1214 endif;
1215 $ret = apply_filters('syndicated_item_author_null_email_set', $ret);
1216 return $ret;
1217
1218 } /* FeedWordPress::null_email_set () */
1219
1220 function is_null_email ($email) {
1221 $ret = in_array(strtolower(trim($email)), FeedWordPress::null_email_set());
1222 $ret = apply_filters('syndicated_item_author_is_null_email', $ret, $email);
1223 return $ret;
1224 } /* FeedWordPress::is_null_email () */
1225
1226 function use_aggregator_source_data () {
1227 $ret = get_option('feedwordpress_use_aggregator_source_data');
1228 return apply_filters('syndicated_post_use_aggregator_source_data', ($ret=='yes'));
1229 }
1230
1231 /**
1232 * FeedWordPress::munge_permalinks: check whether or not FeedWordPress
1233 * should rewrite permalinks for syndicated items to reflect their
1234 * original location.
1235 *
1236 * @return bool TRUE if FeedWordPress SHOULD rewrite permalinks; FALSE otherwise
1237 */
1238 /*static*/ function munge_permalinks () {
1239 return (get_option('feedwordpress_munge_permalink', /*default=*/ 'yes') != 'no');
1240 } /* FeedWordPress::munge_permalinks() */
1241
1242 function syndicated_links () {
1243 $contributors = FeedWordPress::link_category_id();
1244 if (function_exists('get_bookmarks')) :
1245 $links = get_bookmarks(array("category" => $contributors));
1246 else:
1247 $links = get_linkobjects($contributors); // deprecated as of WP 2.1
1248 endif;
1249 return $links;
1250 } // function FeedWordPress::syndicated_links()
1251
1252 function link_category_id () {
1253 global $wpdb, $wp_db_version;
1254
1255 $cat_id = get_option('feedwordpress_cat_id');
1256
1257 // If we don't yet have the category ID stored, search by name
1258 if (!$cat_id) :
1259 $cat_id = FeedWordPressCompatibility::link_category_id(DEFAULT_SYNDICATION_CATEGORY);
1260
1261 if ($cat_id) :
1262 // We found it; let's stamp it.
1263 update_option('feedwordpress_cat_id', $cat_id);
1264 endif;
1265
1266 // If we *do* have the category ID stored, verify that it exists
1267 else :
1268 $cat_id = FeedWordPressCompatibility::link_category_id((int) $cat_id, 'cat_id');
1269 endif;
1270
1271 // If we could not find an appropriate link category,
1272 // make a new one for ourselves.
1273 if (!$cat_id) :
1274 $cat_id = FeedWordPressCompatibility::insert_link_category(DEFAULT_SYNDICATION_CATEGORY);
1275
1276 // Stamp it
1277 update_option('feedwordpress_cat_id', $cat_id);
1278 endif;
1279
1280 return $cat_id;
1281 } // function FeedWordPress::link_category_id()
1282
1283 # Upgrades and maintenance...
1284 function needs_upgrade () {
1285 global $wpdb;
1286 $fwp_db_version = get_option('feedwordpress_version');
1287 $ret = false; // innocent until proven guilty
1288 if (!$fwp_db_version or $fwp_db_version < FEEDWORDPRESS_VERSION) :
1289 // This is an older version or a fresh install. Does it
1290 // require a database upgrade or database initialization?
1291 if ($fwp_db_version <= 0.96) :
1292 // Yes. Check to see whether this is a fresh install or an upgrade.
1293 $syn = $wpdb->get_col("
1294 SELECT post_id
1295 FROM $wpdb->postmeta
1296 WHERE meta_key = 'syndication_feed'
1297 ");
1298 if (count($syn) > 0) : // contains at least one syndicated post
1299 $ret = true;
1300 else : // fresh install; brand it as ours
1301 update_option('feedwordpress_version', FEEDWORDPRESS_VERSION);
1302 endif;
1303 elseif ($fwp_db_version < 2009.0707) :
1304 // We need to clear out any busted AJAX crap
1305 if (fwp_test_wp_version(FWP_SCHEMA_HAS_USERMETA)) :
1306 $wpdb->query("
1307 DELETE FROM $wpdb->usermeta
1308 WHERE LOCATE('feedwordpress', meta_key)
1309 AND LOCATE('box', meta_key);
1310 ");
1311 endif;
1312 update_option('feedwordpress_version', FEEDWORDPRESS_VERSION);
1313 else :
1314 // No. Just brand it with the new version.
1315 update_option('feedwordpress_version', FEEDWORDPRESS_VERSION);
1316 endif;
1317 endif;
1318 return $ret;
1319 }
1320
1321 function upgrade_database ($from = NULL) {
1322 global $wpdb;
1323
1324 if (is_null($from) or $from <= 0.96) : $from = 0.96; endif;
1325
1326 switch ($from) :
1327 case 0.96:
1328 // Dropping legacy upgrade code. If anyone is still
1329 // using 0.96 and just now decided to upgrade, well, I'm
1330 // sorry about that. You'll just have to cope with a few
1331 // duplicate posts.
1332
1333 // Mark the upgrade as successful.
1334 update_option('feedwordpress_version', FEEDWORDPRESS_VERSION);
1335 endswitch;
1336 echo "<p>Upgrade complete. FeedWordPress is now ready to use again.</p>";
1337 } /* FeedWordPress::upgrade_database() */
1338
1339 function has_guid_index () {
1340 global $wpdb;
1341
1342 $found = false; // Guilty until proven innocent.
1343
1344 $results = $wpdb->get_results("
1345 SHOW INDEXES FROM {$wpdb->posts}
1346 ");
1347 if ($results) :
1348 foreach ($results as $index) :
1349 if (isset($index->Column_name)
1350 and ('guid' == $index->Column_name)) :
1351 $found = true;
1352 endif;
1353 endforeach;
1354 endif;
1355 return $found;
1356 } /* FeedWordPress::has_guid_index () */
1357
1358 function create_guid_index () {
1359 global $wpdb;
1360
1361 $wpdb->query("
1362 CREATE INDEX {$wpdb->posts}_guid_idx ON {$wpdb->posts}(guid)
1363 ");
1364 } /* FeedWordPress::create_guid_index () */
1365
1366 function remove_guid_index () {
1367 global $wpdb;
1368
1369 $wpdb->query("
1370 DROP INDEX {$wpdb->posts}_guid_idx ON {$wpdb->posts}
1371 ");
1372 }
1373
1374 /*static*/ function fetch ($url) {
1375 require_once (ABSPATH . WPINC . '/class-feed.php');
1376 $feed = new SimplePie();
1377 $feed->set_feed_url($url);
1378 $feed->set_cache_class('WP_Feed_Cache');
1379 $feed->set_file_class('WP_SimplePie_File');
1380 $feed->set_cache_duration(FeedWordPress::cache_duration());
1381 $feed->init();
1382 $feed->handle_content_type();
1383
1384 if ($feed->error()) :
1385 $ret = new WP_Error('simplepie-error', $feed->error());
1386 else :
1387 $ret = $feed;
1388 endif;
1389 return $ret;
1390 } /* FeedWordPress::fetch () */
1391
1392 function clear_cache () {
1393 global $wpdb;
1394
1395 // The WordPress SimplePie module stores its cached feeds as
1396 // transient records in the options table. The data itself is
1397 // stored in `_transient_feed_{md5 of url}` and the last-modified
1398 // timestamp in `_transient_feed_mod_{md5 of url}`. Timeouts for
1399 // these records are stored in `_transient_timeout_feed_{md5}`.
1400 // Since the md5 is always 32 characters in length, the
1401 // option_name is always over 32 characters.
1402 $wpdb->query("
1403 DELETE FROM {$wpdb->options}
1404 WHERE option_name LIKE '_transient%_feed_%' AND LENGTH(option_name) > 32
1405 ");
1406 } /* FeedWordPress::clear_cache () */
1407
1408 function cache_duration () {
1409 $duration = NULL;
1410 if (defined('FEEDWORDPRESS_CACHE_AGE')) :
1411 $duration = FEEDWORDPRESS_CACHE_AGE;
1412 endif;
1413 return $duration;
1414 }
1415 function cache_lifetime ($duration) {
1416 // Check for explicit setting of a lifetime duration
1417 if (defined('FEEDWORDPRESS_CACHE_LIFETIME')) :
1418 $duration = FEEDWORDPRESS_CACHE_LIFETIME;
1419
1420 // Fall back to the cache freshness duration
1421 elseif (defined('FEEDWORDPRESS_CACHE_AGE')) :
1422 $duration = FEEDWORDPRESS_CACHE_AGE;
1423 endif;
1424
1425 // Fall back to WordPress default
1426 return $duration;
1427 } /* FeedWordPress::cache_lifetime () */
1428
1429 # Utility functions for handling text settings
1430 function negative ($f, $setting) {
1431 $nego = array ('n', 'no', 'f', 'false');
1432 return (isset($f[$setting]) and in_array(strtolower($f[$setting]), $nego));
1433 }
1434
1435 function affirmative ($f, $setting) {
1436 $affirmo = array ('y', 'yes', 't', 'true', 1);
1437 return (isset($f[$setting]) and in_array(strtolower($f[$setting]), $affirmo));
1438 }
1439
1440
1441 # Internal debugging functions
1442 function critical_bug ($varname, $var, $line) {
1443 global $wp_version;
1444
1445 echo '<p>There may be a bug in FeedWordPress. Please <a href="'.FEEDWORDPRESS_AUTHOR_CONTACT.'">contact the author</a> and paste the following information into your e-mail:</p>';
1446 echo "\n<plaintext>";
1447 echo "Triggered at line # ".$line."\n";
1448 echo "FeedWordPress version: ".FEEDWORDPRESS_VERSION."\n";
1449 echo "WordPress version: {$wp_version}\n";
1450 echo "PHP version: ".phpversion()."\n";
1451 echo "\n";
1452 echo $varname.": "; var_dump($var); echo "\n";
1453 die;
1454 }
1455
1456 function noncritical_bug ($varname, $var, $line) {
1457 if (FEEDWORDPRESS_DEBUG) : // halt only when we are doing debugging
1458 FeedWordPress::critical_bug($varname, $var, $line);
1459 endif;
1460 }
1461 } // class FeedWordPress
1462
1463 require_once(dirname(__FILE__) . '/syndicatedpost.class.php');
1464 require_once(dirname(__FILE__) . '/syndicatedlink.class.php');
1465
1466 ################################################################################
1467 ## XML-RPC HOOKS: accept XML-RPC update pings from Contributors ################
1468 ################################################################################
1469
1470 function feedwordpress_xmlrpc_hook ($args = array ()) {
1471 $args['weblogUpdates.ping'] = 'feedwordpress_pong';
1472 return $args;
1473 }
1474
1475 function feedwordpress_pong ($args) {
1476 $feedwordpress = new FeedWordPress;
1477 $delta = @$feedwordpress->update($args[1]);
1478 if (is_null($delta)):
1479 return array('flerror' => true, 'message' => "Sorry. I don't syndicate <$args[1]>.");
1480 else:
1481 $mesg = array();
1482 if (isset($delta['new'])) { $mesg[] = ' '.$delta['new'].' new posts were syndicated'; }
1483 if (isset($delta['updated'])) { $mesg[] = ' '.$delta['updated'].' existing posts were updated'; }
1484
1485 return array('flerror' => false, 'message' => "Thanks for the ping.".implode(' and', $mesg));
1486 endif;
1487 }
1488
1489 require_once(dirname(__FILE__) . '/relative_uri.class.php');
1490
1491 // take your best guess at the realname and e-mail, given a string
1492 define('FWP_REGEX_EMAIL_ADDY', '([^@"(<\s]+@[^"@(<\s]+\.[^"@(<\s]+)');
1493 define('FWP_REGEX_EMAIL_NAME', '("([^"]*)"|([^"<(]+\S))');
1494 define('FWP_REGEX_EMAIL_POSTFIX_NAME', '/^\s*'.FWP_REGEX_EMAIL_ADDY."\s+\(".FWP_REGEX_EMAIL_NAME.'\)\s*$/');
1495 define('FWP_REGEX_EMAIL_PREFIX_NAME', '/^\s*'.FWP_REGEX_EMAIL_NAME.'\s*<'.FWP_REGEX_EMAIL_ADDY.'>\s*$/');
1496 define('FWP_REGEX_EMAIL_JUST_ADDY', '/^\s*'.FWP_REGEX_EMAIL_ADDY.'\s*$/');
1497 define('FWP_REGEX_EMAIL_JUST_NAME', '/^\s*'.FWP_REGEX_EMAIL_NAME.'\s*$/');
1498
1499 function parse_email_with_realname ($email) {
1500 if (preg_match(FWP_REGEX_EMAIL_POSTFIX_NAME, $email, $matches)) :
1501 ($ret['name'] = $matches[3]) or ($ret['name'] = $matches[2]);
1502 $ret['email'] = $matches[1];
1503 elseif (preg_match(FWP_REGEX_EMAIL_PREFIX_NAME, $email, $matches)) :
1504 ($ret['name'] = $matches[2]) or ($ret['name'] = $matches[3]);
1505 $ret['email'] = $matches[4];
1506 elseif (preg_match(FWP_REGEX_EMAIL_JUST_ADDY, $email, $matches)) :
1507 $ret['name'] = NULL; $ret['email'] = $matches[1];
1508 elseif (preg_match(FWP_REGEX_EMAIL_JUST_NAME, $email, $matches)) :
1509 $ret['email'] = NULL;
1510 ($ret['name'] = $matches[2]) or ($ret['name'] = $matches[3]);
1511 else :
1512 $ret['name'] = NULL; $ret['email'] = NULL;
1513 endif;
1514 return $ret;
1515 }
1516
1517