| @@ -1,358 +1,6 @@ | ||
| 1 | -FeedWordPress Change Log | |
| 2 | -======================== | |
| 3 | - | |
| 4 | -Changes from 0.981 to 0.99 | |
| 5 | -Version 0.99 adds several significant new features, fixes some bugs, and | |
| 6 | -provides compatability with WordPress 2.2.x and 2.3.x. | |
| 7 | - | |
| 8 | -* WORDPRESS 2.2 AND 2.3 COMPATIBILITY: FeedWordPress should now be | |
| 9 | - compatible with WordPress version 2.2 and the upcoming WordPress | |
| 10 | - version 2.3. In particular, it has been tested extensively against | |
| 11 | - WordPress 2.2.3 and WordPress 2.3 Release Candidate 1. | |
| 12 | - | |
| 13 | -* AUTOMATIC UPDATES WITHOUT CRON: FeedWordPress now allows you to | |
| 14 | - automatically schedule checks for new posts without using external task | |
| 15 | - scheduling tools such as cron. In order to enable automatic updates, go | |
| 16 | - to **Syndication --> Options** and set "Check for new posts" to | |
| 17 | - "automatically." For details, see "Automatic Feed Updates" in | |
| 18 | - README.text. | |
| 19 | - | |
| 20 | - An important side-effect of the changes to the update system is that if | |
| 21 | - you were previously using the cron job and the `update-feeds.php` script | |
| 22 | - to schedule updates, you need to change your cron set-up. The old | |
| 23 | - `update-feeds.php` script no longer exists. Instead, if you wish to use | |
| 24 | - a cron job to guarantee updates on a particular schedule, you should | |
| 25 | - have the cron job fetch the front page of your blog (for example, by | |
| 26 | - using `curl http://www.zyx.com/blog/ > /dev/null`) instead of activating | |
| 27 | - the `update-feeds.php` script. If automatic updates have been enabled, | |
| 28 | - fetching the front page will automatically trigger the update process. | |
| 29 | - | |
| 30 | -* INTERFACE REORGANIZATION: All FeedWordPress functions are now located | |
| 31 | - under a top-level "Syndication" menu in the WordPress Dashboard. To | |
| 32 | - manage the list of syndicated sites, manually check for new posts on | |
| 33 | - one or more feeds, or syndicate a new site, you should use the main page | |
| 34 | - under **Syndication**. To change global settings for FeedWordPress, | |
| 35 | - you should use **Syndication --> Options**. | |
| 36 | - | |
| 37 | -* FILE STRUCTURE REORGANIZATION: Due to a combination of changing styles | |
| 38 | - for FeedWordPress plugins and lingering bugs in the FeedWordPress admin | |
| 39 | - menu code, the code for FeedWordPress is now contained in two different | |
| 40 | - PHP files, which should be installed together in a subdirectory of your | |
| 41 | - plugins directory named `feedwordpress`. (See README.text for | |
| 42 | - installation and upgrade instructions relating to the change.) | |
| 43 | - | |
| 44 | -* MULTIPLE CATEGORIES SETTING: Some feeds use non-standard methods to | |
| 45 | - indicate multiple categories within a single category element. (The most | |
| 46 | - popular site to do this is del.icio.us, which separates tags with a | |
| 47 | - space.) FeedWordPress now allows you to set an optional setting, for any | |
| 48 | - feed which does this, indicating the character or characters used to | |
| 49 | - divide multiple categories, using a Perl-compatible regular expression. | |
| 50 | - (In the case of del.icio.us feeds, FeedWordPress will automatically use | |
| 51 | - \s for the pattern without your having to do any further configuration.) | |
| 52 | - To turn this setting on, simply use the "Edit" link for the feed that | |
| 53 | - you want to turn it on for. | |
| 54 | - | |
| 55 | -* REGULAR EXPRESSION BUG FIXED: Eliminated a minor bug in the regular | |
| 56 | - expressions for e-mail addresses (used in parsing RSS `author` | |
| 57 | - elements), which could produce unsightly error messages for some users | |
| 58 | - parsing RSS 2.0 feeds. | |
| 59 | - | |
| 60 | -* DATE / UPDATE BUG FIXED: A bug in date handling was eliminated that may | |
| 61 | - have caused problems if any of (1) WordPress, or (2) PHP, or (3) your | |
| 62 | - web server, or (4) your MySQL server, has been set to use a different | |
| 63 | - time zone from the one that any of the others is set to use. If | |
| 64 | - FeedWordPress has not been properly updating updated posts, or has been | |
| 65 | - updating posts when there shouldn't be any changes for the update, this | |
| 66 | - release may solve that problem. | |
| 67 | - | |
| 68 | -* GOOGLE READER BUGS FIXED: A couple of bugs that made it difficult for | |
| 69 | - FeedWordPress to interact with Google Reader public feeds have been | |
| 70 | - fixed. Firstly, if you encountered an error message reading "There was a | |
| 71 | - problem adding the newsfeed. [SQL: ]" when you tried to add the feed, | |
| 72 | - the cause of this error has been fixed. Secondly, if you succeeded in | |
| 73 | - getting FeedWordPress to check a Google Reader feed, only to find that | |
| 74 | - the title of posts had junk squashed on to the end of them, that bug | |
| 75 | - has been fixed too. To fix this bug, you must install the newest version | |
| 76 | - of the optional MagpieRSS upgrade. | |
| 77 | - | |
| 78 | -* FILTER PARAMETERS: Due to an old, old bug in WordPress 1.5.0 (which was | |
| 79 | - what was available back when I first wrote the filter interface), | |
| 80 | - FeedWordPress has traditionally only passed one parameter to | |
| 81 | - syndicated_item and syndicated_post filters functions -- an array | |
| 82 | - containing either the Magpie representation of a syndicated item from | |
| 83 | - the feed, or the database representation of a post about to be inserted | |
| 84 | - into the WordPress database. If you needed information about the feed | |
| 85 | - that the item came from, this was accessible only through a pair of | |
| 86 | - global variables, $fwp_channel and $fwp_feedmeta. | |
| 87 | - | |
| 88 | - Since it's been a pretty long time since WordPress 1.5.0 was in | |
| 89 | - widespread usage, I have gone ahead and added an optional second | |
| 90 | - parameter to the invocation of the syndicated_item and syndicated_post | |
| 91 | - filters. If you have written a filter for FeedWordPress that uses either | |
| 92 | - of these hooks, you can now register that filter to accept 2 parameters. | |
| 93 | - If you do so, the second parameter will be a SyndicatedPost object, | |
| 94 | - which, among other things, allows you to access information about the | |
| 95 | - feed from which an item is syndicated using the $post->feed and the | |
| 96 | - $post->feedmeta elements (where $post is the name of the second | |
| 97 | - parameter). | |
| 98 | - | |
| 99 | - NOTE THAT THE OLD GLOBAL VARIABLES ARE STILL AVAILABLE, for the time | |
| 100 | - being at least, so existing filters will not break with the upgrade. | |
| 101 | - They should be considered deprecated, however, and may be eliminated in | |
| 102 | - the future. | |
| 103 | - | |
| 104 | -* FILTER CHANGE / BUGFIX: the array that is passed as the first argument | |
| 105 | - syndicated_post filters no longer is no longer backslash-escaped for | |
| 106 | - MySQL when filters are called. This was originally a bug, or an | |
| 107 | - oversight; the contents of the array should only be escaped for the | |
| 108 | - database *after* they have gone through all filters. IF YOU HAVE WRITTEN | |
| 109 | - ANY syndicated_post FILTERS THAT PRESUME THE OLD BEHAVIOR OF PASSING IN | |
| 110 | - STRINGS THAT ARE ALREADY BACKSLASH-ESCAPED, UPDATE YOUR FILTERS | |
| 111 | - ACCORDINGLY. | |
| 112 | - | |
| 113 | -* OTHER MINOR BUGFIXES AND INTERNAL CHANGES: The internal architecture of | |
| 114 | - FeedWordPress has been significantly changed to make the code more | |
| 115 | - modular and clean; hopefully this should help reduce the number of | |
| 116 | - compatibility updates that are needed, and make them easier and quicker | |
| 117 | - when they are needed. | |
| 118 | - | |
| 119 | -Changes from 0.98 to 0.981 | |
| 120 | -Version 0.981 is a narrowly targeted bugfix and compatibility release, whose | |
| 121 | -main purpose is to resolve a major outstanding problem: the incompatibility | |
| 122 | -between version 0.98 of WordPress and the recently released WordPress 2.1. | |
| 123 | - | |
| 124 | -* WORDPRESS 2.1 COMPATIBILITY: FeedWordPress is now compatible with | |
| 125 | - WordPress 2.1, as well as retaining its existing support for WordPress | |
| 126 | - 2.0 and 1.5. Incompatibilities that resulted in database warnings, fatal | |
| 127 | - errors, and which prevented FeedWordPress from syndicating new posts, | |
| 128 | - have been eliminated. | |
| 129 | - | |
| 130 | -* RSS-FUNCTIONS.PHP RENAMED TO RSS.PHP: if you use the upgraded MagpieRSS | |
| 131 | - replacement that's included with FeedWordPress, be sure to note that | |
| 132 | - there are now *two* files to upload from the `OPTIONAL/wp-includes` | |
| 133 | - subdirectory in order to carry out the upgrade: rss-functions.php and | |
| 134 | - rss.php. **It is necessary to upload both files**, due to a change in | |
| 135 | - the file naming scheme in WordPress 2.1, and it is necessary to do so | |
| 136 | - whether you are using WordPress 2.1 or not. If you only upload the | |
| 137 | - `rss-functions.php` file as in previous installations you will not have | |
| 138 | - a working copy of MagpieRSS; the rss.php file contains the actual code. | |
| 139 | - | |
| 140 | -* DATE BUG AFFECTING SOME PHP INSTALLATIONS RESOLVED: due to a subtle bug | |
| 141 | - in parse_w3cdtf(), some installations of PHP encountered problems with | |
| 142 | - FeedWordPress's attempt to date posts, which would cause some new posts | |
| 143 | - on Atom feeds to be dated as if they had apppeared in 1969 or 1970 | |
| 144 | - (thus, effectively, never appearing on front apge at all). This bug in | |
| 145 | - the date handling should now be fixed. | |
| 146 | - | |
| 147 | -* PHP <?=...?> SHORT FORM ELIMINATED: some installations of PHP do not | |
| 148 | - allow the <?=...?> short form for printing PHP values, which was used | |
| 149 | - extensively in the FeedWordPress interface code. Since this could cause | |
| 150 | - fatal errors for users with the wrong installation of PHP, the short | |
| 151 | - form has been replaced with full PHP echo statements, and is no longer | |
| 152 | - used in FeedWordPress. | |
| 153 | - | |
| 154 | -* BETTER USER INTERFACE INTEGRATION WITH WORDPRESS 2.x: Some minor changes | |
| 155 | - have been made to help the FeedWordPress interface pages blend in better | |
| 156 | - with the user interface when running under WordPress 2.x. | |
| 157 | - | |
| 158 | -* GLOBAL CATEGORIES BUG RESOLVED: a bug that prevented some users from | |
| 159 | - setting one or more categories to apply to syndicated posts from all | |
| 160 | - feeds (using the checkbox interface under Options --> Syndication) has | |
| 161 | - been resolved. | |
| 162 | - | |
| 163 | -Changes from 0.97 to 0.98 | |
| 164 | - | |
| 165 | -* WORDPRESS 2.0 COMPATIBILITY: This is a narrowly-targeted release to | |
| 166 | - solve a major outstanding problem. FeedWordPress is now compatible with | |
| 167 | - both WordPress 1.5 and WordPress 2.0. Incompatibilities that caused | |
| 168 | - fatal SQL errors, and a more subtle bug with off-kilter counts of posts | |
| 169 | - under a given category, have been resolved. FeedWordPress tests for | |
| 170 | - database schema using the global $wp_db_version variable (if null, then | |
| 171 | - we presume that we're dealing with WordPress 1.5). | |
| 172 | - | |
| 173 | - NOTE: I have **not** fully tested FeedWordPress with WordPress 2.0. | |
| 174 | - Further testing may reveal more bugs. However, you should now be able | |
| 175 | - to get at least basic FeedWordPress functionality up and running. | |
| 176 | - | |
| 177 | -* AUTHOR MATCHING: FeedWordPress tests several fields to see if it can | |
| 178 | - identify the author of the post as a user already in the WordPress user | |
| 179 | - database. In previous versions, it tested the user login, the nickname, | |
| 180 | - and tested for "aliases" listed in the Profile (see documentation). FWP | |
| 181 | - now also matches authors on the basis of e-mail address (*if* an e-mail | |
| 182 | - address is present). This is particularly helpful for formats such as | |
| 183 | - RSS 2.0, in which authors are primarily identified by e-mail addresses. | |
| 184 | - | |
| 185 | -Changes from 0.96 to 0.97 | |
| 186 | - | |
| 187 | -* INSTALLATION PROCEDURE: Some of the changes between 0.96 and 0.97 | |
| 188 | - require upgrades to the meta-data stored by FeedWordPress to work | |
| 189 | - properly. Thus, if you are upgrading from 0.96 or earlier to 0.97, most | |
| 190 | - FeedWordPress operations (including updates and template functions) | |
| 191 | - WILL BE DISABLED until you run the upgrade procedure. Fortunately, | |
| 192 | - running the upgrade procedure is easy: just go to either Options --> | |
| 193 | - Syndication or Links --> Syndicated in the WordPress Dashboard and press | |
| 194 | - the button. | |
| 195 | - | |
| 196 | -* FEED FORMAT SUPPORT: Support has been added for the Atom 1.0 IETF | |
| 197 | - standard. Several other elements are also newly supported | |
| 198 | - (dcterms:created, dcterms:issued, dcterms:modified, dc:identifier, | |
| 199 | - proper support for the RSS 2.0 guid element, the RSS 2.0 author element, | |
| 200 | - the use of Atom author or Dublin Core dc:creator constructs at the feed | |
| 201 | - level to identify the author of individual items, etc.) | |
| 202 | - | |
| 203 | - N.B.: full support of several Atom 1.0 features, such as categories | |
| 204 | - and enclosures, requires you to install the optional rss-functions.php | |
| 205 | - upgrade in your wp-includes directory. | |
| 206 | - | |
| 207 | -* BUG FIX: Running `update-feeds.php` from command line or crontab | |
| 208 | - returned "I don't syndicate..." errors. It turns out that WordPress | |
| 209 | - sometimes tramples on the internal PHP superglobals that I depended on | |
| 210 | - to determine whether or not the script was being invoked from the | |
| 211 | - command line. This has been fixed (the variables are now checked | |
| 212 | - *before* WordPress can trample them). Note that `update-feeds.php` has | |
| 213 | - been thoroughly overhauled anyway; see below for details. | |
| 214 | - | |
| 215 | -* BUG FIX: Duplicate categories or author names. Fixed two bugs that could | |
| 216 | - create duplicate author and/or category names when the name contained | |
| 217 | - either (a) certain international characters (causing a mismatch between | |
| 218 | - MySQL and PHP's handling of lowercasing text), or (b) characters that | |
| 219 | - have a special meaning in regular expressions (causing MySQL errors when | |
| 220 | - looking for the author or category due to regexp syntax errors). These | |
| 221 | - should now be fixed thanks to careful escaping of names that go into | |
| 222 | - regular expressions and careful matching of lowercasing functions | |
| 223 | - (comparing results from PHP only to other results from PHP, and results | |
| 224 | - from MySQL only to other results from MySQL). | |
| 225 | - | |
| 226 | -* BUG FIX: Items dated Decembr 31, 1969 should appear less often. The | |
| 227 | - function for parsing W3C date-time format dates that ships with | |
| 228 | - MagpieRSS can only correctly parse fully-specified dates with a | |
| 229 | - fully-specified time, but valid W3C date-time format dates may omit the | |
| 230 | - time, the day of the month, or even the month. Some feeds in the wild | |
| 231 | - date their items with coarse-grained dates, so the optional | |
| 232 | - `rss-functions.php` upgrade now includes a more flexible parse_w3cdtf() | |
| 233 | - function that will work with both coarse-grained and fully-specified | |
| 234 | - dates. (If parts of the date or the time are omitted, they are filled in | |
| 235 | - with values based on the current time, so '2005-09-10' will be dated to | |
| 236 | - the current time on that day; '2004' will be dated to this day and time | |
| 237 | - one year ago. | |
| 238 | - | |
| 239 | - N.B.: This fix is only available in the optional `rss-functions.php` | |
| 240 | - upgrade. | |
| 241 | - | |
| 242 | -* BUG FIX: Evil use of HTTP GET has been undone. The WordPress interface | |
| 243 | - is riddled with inappropriate (non-idempotent) uses of HTTP GET queries | |
| 244 | - (ordinary links that make the server do something with significant | |
| 245 | - side-effects, such as deleting a post or a link from the database). | |
| 246 | - FeedWordPress did some of this too, especially in places where it aped | |
| 247 | - the WordPress interface (e.g. the "Delete" links in Links --> | |
| 248 | - Syndicated). That's bad business, though. I've changed the interface so | |
| 249 | - that all the examples of improper side-effects that I can find now | |
| 250 | - require an HTTP POST to take effect. I think I got pretty much | |
| 251 | - everything; if there's anything that I missed, let me know. | |
| 252 | - | |
| 253 | - Further reading: [Sam Ruby 2005-05-06: This Stuff Matters] (http://www.intertwingly.net/blog/2005/05/06/This-Stuff-Matters) | |
| 254 | - | |
| 255 | -* BUG FIX: Categories applied by `cats` setting should no longer prevent | |
| 256 | - category-based filtering from working. In FeedWordPress, you can (1) | |
| 257 | - apply certain categories to all syndicated posts, or all posts from | |
| 258 | - a particular feed; and (2) filter out all posts that don't match one | |
| 259 | - of the categories that are already in the WordPress database (allowing | |
| 260 | - for simple category-based filtering; just load up WordPress with the | |
| 261 | - categories you want to accept, and then tell FeedWordPress not to create | |
| 262 | - new ones). However, the way that (1) and (2) were implemented meant that | |
| 263 | - you couldn't effectively use them together; once you applied a known | |
| 264 | - category to all syndicated posts from a particular feed, it meant that | |
| 265 | - they'd have at least one familiar category (the category or categories | |
| 266 | - you were applying), and that would get all posts past the filter no | |
| 267 | - matter what categories they were originally from. | |
| 268 | - | |
| 269 | - Well, no longer. You can still apply categories to all syndicated posts | |
| 270 | - (using either Syndication --> Options, or the feed-level settings under | |
| 271 | - Links --> Syndicated). But these categories are not applied to the post | |
| 272 | - until *after* it has already passed by the "familiar categories" filter. | |
| 273 | - So now, if you want, you can do category filtering and *then* apply as | |
| 274 | - many categories as you please to all and only posts that pass the filter. | |
| 275 | - | |
| 276 | -* BUG FIX: Other minor typos and HTML gaffes were fixed along the way. | |
| 277 | - | |
| 278 | -* PERFORMANCE: get_feed_meta() no longer hits the database for information | |
| 279 | - on every call; it now caches link data in memory, so FeedWordPress only | |
| 280 | - goes to the database once for each syndicated link. This may | |
| 281 | - substantially improve performance if your database server resources | |
| 282 | - are tight and your templates make a lot of use of custom settings from | |
| 283 | - get_feed_meta(). | |
| 284 | - | |
| 285 | -* API CHANGE: Link ID numbers, rather than RSS URIs, are now used to | |
| 286 | - identify the feed from which a post is syndicated when you use template | |
| 287 | - functions such as get_feed_meta(). The practical upshot of this is you | |
| 288 | - can switch feeds, or change the feed address for a particular syndicated | |
| 289 | - site, without breaking your templates for all the posts that were | |
| 290 | - syndicated from the earlier URI. | |
| 291 | - | |
| 292 | -* API CHANGE: if you have plugins or templates that make use of the | |
| 293 | - get_feed_meta() function or the $fwp_feedmeta global, note that the | |
| 294 | - data formerly located under the `uri` and `name` fields is now located | |
| 295 | - under the `link/uri` field and the `link/name` field, respectively. Note | |
| 296 | - also that you can access the link ID number for any given feed under the | |
| 297 | - global $fwp_feedmeta['link/id'] (in plugins) or | |
| 298 | - get_feed_meta('link/id') (in a template in post contexts). | |
| 299 | - | |
| 300 | -* FEATURE: the settings for individual feeds can now be edited using a | |
| 301 | - humane interface (where formerly you had to tweak key-value pairs in the | |
| 302 | - Link Notes section). To edit settings for a feed, pick the feed that you | |
| 303 | - want under Links --> Syndicated and click the Edit link. | |
| 304 | - | |
| 305 | -* FEATURE: The "Unsubscribe" button (formerly "Delete") in Links --> | |
| 306 | - Syndicated now offers three options for unsubscribing from a feed: (1) | |
| 307 | - turning off the subscription without deleting the feed data or affecting | |
| 308 | - posts that were syndicated from the feed (this works by setting the Link | |
| 309 | - for the feed as "invisible"); (2) deleting the feed data and all of the | |
| 310 | - posts that were syndicated from the feed; or (3) deleting the feed data | |
| 311 | - and *keeping* the posts that were syndicated from the feed | |
| 312 | - setting the Link to "Invisible" (meaning that it will not be displayed | |
| 313 | - in lists of the site links on the front page, and it won't be checked | |
| 314 | - for updates; (2) deleting the Link and all of the posts that were | |
| 315 | - syndicated from its feed; or (3) deleting the feed data but keeping the | |
| 316 | - posts that were syndicated (which will henceforward be treated as if | |
| 317 | - they were local rather than syndicated posts). (Note that (1) is usually | |
| 318 | - the best option for aggregator sites, unless you want to clean up the | |
| 319 | - results of an error or a test.) | |
| 320 | - | |
| 321 | -* FEATURE / BUG FIX: If you have been receiving mysterious "I don't | |
| 322 | - syndicate...", or "(local) HTTP status code was not 200", or "(local) | |
| 323 | - transport error - could not open socket", or "parse error - not well | |
| 324 | - formed" errors, then this update may solve your problems, and if it does | |
| 325 | - *not* solve them, it will at least make the reasons for the problems | |
| 326 | - easier to understand. That's because I've overhauled the way that | |
| 327 | - FeedWordPress goes about updating feeds. | |
| 328 | - | |
| 329 | - If you use the command-line PHP scripting method to run scheduled | |
| 330 | - updates, then not much should change for you, except for fewer | |
| 331 | - mysterious errors. If you have done updates by sending periodic HTTP | |
| 332 | - requests to <http://your-blog.com/path/wp-content/update-feeds.php>, | |
| 333 | - then the details have changed somewhat; mostly in such a way as to make | |
| 334 | - things easier on you. See the README file or online documentation on | |
| 335 | - Staying Current for the details. | |
| 336 | - | |
| 337 | -* FEATURE: FeedWordPress now features a more sophisticated system for | |
| 338 | - timed updates. Instead of polling *every* subscribed feed for updates | |
| 339 | - *each* time `update-feeds.php` is run, FeedWordPress now keeps track of | |
| 340 | - the last time it polled each feed, and only polls them again after a | |
| 341 | - certain period of time has passed. The amount of time is normally set | |
| 342 | - randomly for each feed, in a period between 30 minutes and 2 hours (so | |
| 343 | - as to stagger updates over time rather than polling all of the feeds at once. However, the length of time between updates can also be set | |
| 344 | - directly by the feed, which brings us to ... | |
| 345 | - | |
| 346 | -* FEATURE: FeedWordPress now respects the settings in the `ttl` and | |
| 347 | - Syndication Module RSS elements. Feeds with these elements set will not | |
| 348 | - be polled any more frequently than they indicate with these feeds unless | |
| 349 | - the user manually forces FeedWordPress to poll the feed (see Links --> | |
| 350 | - Syndicated --> Edit settings). | |
| 1 | +Change Log | |
| 2 | +========== | |
| 351 | 3 | |
| 352 | 4 | Changes from 0.95 to 0.96 |
| 353 | 5 | ------------------------- |
| 354 | 6 | |
