| @@ -1,6 +1,174 @@ | ||
| 1 | -Change Log | |
| 2 | -========== | |
| 1 | +FeedWordPress Change Log | |
| 2 | +======================== | |
| 3 | + | |
| 4 | +Changes from 0.96 to 0.97 | |
| 5 | +------------------------- | |
| 6 | + | |
| 7 | +* INSTALLATION PROCEDURE: Some of the changes between 0.96 and 0.97 | |
| 8 | + require upgrades to the meta-data stored by FeedWordPress to work | |
| 9 | + properly. Thus, if you are upgrading from 0.96 or earlier to 0.97, most | |
| 10 | + FeedWordPress operations (including updates and template functions) | |
| 11 | + WILL BE DISABLED until you run the upgrade procedure. Fortunately, | |
| 12 | + running the upgrade procedure is easy: just go to either Options --> | |
| 13 | + Syndication or Links --> Syndicated in the WordPress Dashboard and press | |
| 14 | + the button. | |
| 15 | + | |
| 16 | +* FEED FORMAT SUPPORT: Support has been added for the Atom 1.0 IETF | |
| 17 | + standard. Several other elements are also newly supported | |
| 18 | + (dcterms:created, dcterms:issued, dcterms:modified, dc:identifier, | |
| 19 | + proper support for the RSS 2.0 guid element, the RSS 2.0 author element, | |
| 20 | + the use of Atom author or Dublin Core dc:creator constructs at the feed | |
| 21 | + level to identify the author of individual items, etc.) | |
| 22 | + | |
| 23 | + N.B.: full support of several Atom 1.0 features, such as categories | |
| 24 | + and enclosures, requires you to install the optional rss-functions.php | |
| 25 | + upgrade in your wp-includes directory. | |
| 26 | + | |
| 27 | +* BUG FIX: Running `update-feeds.php` from command line or crontab | |
| 28 | + returned "I don't syndicate..." errors. It turns out that WordPress | |
| 29 | + sometimes tramples on the internal PHP superglobals that I depended on | |
| 30 | + to determine whether or not the script was being invoked from the | |
| 31 | + command line. This has been fixed (the variables are now checked | |
| 32 | + *before* WordPress can trample them). Note that `update-feeds.php` has | |
| 33 | + been thoroughly overhauled anyway; see below for details. | |
| 34 | + | |
| 35 | +* BUG FIX: Duplicate categories or author names. Fixed two bugs that could | |
| 36 | + create duplicate author and/or category names when the name contained | |
| 37 | + either (a) certain international characters (causing a mismatch between | |
| 38 | + MySQL and PHP's handling of lowercasing text), or (b) characters that | |
| 39 | + have a special meaning in regular expressions (causing MySQL errors when | |
| 40 | + looking for the author or category due to regexp syntax errors). These | |
| 41 | + should now be fixed thanks to careful escaping of names that go into | |
| 42 | + regular expressions and careful matching of lowercasing functions | |
| 43 | + (comparing results from PHP only to other results from PHP, and results | |
| 44 | + from MySQL only to other results from MySQL). | |
| 45 | + | |
| 46 | +* BUG FIX: Items dated Decembr 31, 1969 should appear less often. The | |
| 47 | + function for parsing W3C date-time format dates that ships with | |
| 48 | + MagpieRSS can only correctly parse fully-specified dates with a | |
| 49 | + fully-specified time, but valid W3C date-time format dates may omit the | |
| 50 | + time, the day of the month, or even the month. Some feeds in the wild | |
| 51 | + date their items with coarse-grained dates, so the optional | |
| 52 | + `rss-functions.php` upgrade now includes a more flexible parse_w3cdtf() | |
| 53 | + function that will work with both coarse-grained and fully-specified | |
| 54 | + dates. (If parts of the date or the time are omitted, they are filled in | |
| 55 | + with values based on the current time, so '2005-09-10' will be dated to | |
| 56 | + the current time on that day; '2004' will be dated to this day and time | |
| 57 | + one year ago. | |
| 58 | + | |
| 59 | + N.B.: This fix is only available in the optional `rss-functions.php` | |
| 60 | + upgrade. | |
| 61 | + | |
| 62 | +* BUG FIX: Evil use of HTTP GET has been undone. The WordPress interface | |
| 63 | + is riddled with inappropriate (non-idempotent) uses of HTTP GET queries | |
| 64 | + (ordinary links that make the server do something with significant | |
| 65 | + side-effects, such as deleting a post or a link from the database). | |
| 66 | + FeedWordPress did some of this too, especially in places where it aped | |
| 67 | + the WordPress interface (e.g. the "Delete" links in Links --> | |
| 68 | + Syndicated). That's bad business, though. I've changed the interface so | |
| 69 | + that all the examples of improper side-effects that I can find now | |
| 70 | + require an HTTP POST to take effect. I think I got pretty much | |
| 71 | + everything; if there's anything that I missed, let me know. | |
| 72 | + | |
| 73 | + Further reading: [Sam Ruby 2005-05-06: This Stuff Matters] (http://www.intertwingly.net/blog/2005/05/06/This-Stuff-Matters) | |
| 74 | + | |
| 75 | +* BUG FIX: Categories applied by `cats` setting should no longer prevent | |
| 76 | + category-based filtering from working. In FeedWordPress, you can (1) | |
| 77 | + apply certain categories to all syndicated posts, or all posts from | |
| 78 | + a particular feed; and (2) filter out all posts that don't match one | |
| 79 | + of the categories that are already in the WordPress database (allowing | |
| 80 | + for simple category-based filtering; just load up WordPress with the | |
| 81 | + categories you want to accept, and then tell FeedWordPress not to create | |
| 82 | + new ones). However, the way that (1) and (2) were implemented meant that | |
| 83 | + you couldn't effectively use them together; once you applied a known | |
| 84 | + category to all syndicated posts from a particular feed, it meant that | |
| 85 | + they'd have at least one familiar category (the category or categories | |
| 86 | + you were applying), and that would get all posts past the filter no | |
| 87 | + matter what categories they were originally from. | |
| 88 | + | |
| 89 | + Well, no longer. You can still apply categories to all syndicated posts | |
| 90 | + (using either Syndication --> Options, or the feed-level settings under | |
| 91 | + Links --> Syndicated). But these categories are not applied to the post | |
| 92 | + until *after* it has already passed by the "familiar categories" filter. | |
| 93 | + So now, if you want, you can do category filtering and *then* apply as | |
| 94 | + many categories as you please to all and only posts that pass the filter. | |
| 95 | + | |
| 96 | +* BUG FIX: Other minor typos and HTML gaffes were fixed along the way. | |
| 97 | + | |
| 98 | +* PERFORMANCE: get_feed_meta() no longer hits the database for information | |
| 99 | + on every call; it now caches link data in memory, so FeedWordPress only | |
| 100 | + goes to the database once for each syndicated link. This may | |
| 101 | + substantially improve performance if your database server resources | |
| 102 | + are tight and your templates make a lot of use of custom settings from | |
| 103 | + get_feed_meta(). | |
| 104 | + | |
| 105 | +* API CHANGE: Link ID numbers, rather than RSS URIs, are now used to | |
| 106 | + identify the feed from which a post is syndicated when you use template | |
| 107 | + functions such as get_feed_meta(). The practical upshot of this is you | |
| 108 | + can switch feeds, or change the feed address for a particular syndicated | |
| 109 | + site, without breaking your templates for all the posts that were | |
| 110 | + syndicated from the earlier URI. | |
| 111 | + | |
| 112 | +* API CHANGE: if you have plugins or templates that make use of the | |
| 113 | + get_feed_meta() function or the $fwp_feedmeta global, note that the | |
| 114 | + data formerly located under the `uri` and `name` fields is now located | |
| 115 | + under the `link/uri` field and the `link/name` field, respectively. Note | |
| 116 | + also that you can access the link ID number for any given feed under the | |
| 117 | + global $fwp_feedmeta['link/id'] (in plugins) or | |
| 118 | + get_feed_meta('link/id') (in a template in post contexts). | |
| 119 | + | |
| 120 | +* FEATURE: the settings for individual feeds can now be edited using a | |
| 121 | + humane interface (where formerly you had to tweak key-value pairs in the | |
| 122 | + Link Notes section). To edit settings for a feed, pick the feed that you | |
| 123 | + want under Links --> Syndicated and click the Edit link. | |
| 124 | + | |
| 125 | +* FEATURE: The "Unsubscribe" button (formerly "Delete") in Links --> | |
| 126 | + Syndicated now offers three options for unsubscribing from a feed: (1) | |
| 127 | + turning off the subscription without deleting the feed data or affecting | |
| 128 | + posts that were syndicated from the feed (this works by setting the Link | |
| 129 | + for the feed as "invisible"); (2) deleting the feed data and all of the | |
| 130 | + posts that were syndicated from the feed; or (3) deleting the feed data | |
| 131 | + and *keeping* the posts that were syndicated from the feed | |
| 132 | + setting the Link to "Invisible" (meaning that it will not be displayed | |
| 133 | + in lists of the site links on the front page, and it won't be checked | |
| 134 | + for updates; (2) deleting the Link and all of the posts that were | |
| 135 | + syndicated from its feed; or (3) deleting the feed data but keeping the | |
| 136 | + posts that were syndicated (which will henceforward be treated as if | |
| 137 | + they were local rather than syndicated posts). (Note that (1) is usually | |
| 138 | + the best option for aggregator sites, unless you want to clean up the | |
| 139 | + results of an error or a test.) | |
| 140 | + | |
| 141 | +* FEATURE / BUG FIX: If you have been receiving mysterious "I don't | |
| 142 | + syndicate...", or "(local) HTTP status code was not 200", or "(local) | |
| 143 | + transport error - could not open socket", or "parse error - not well | |
| 144 | + formed" errors, then this update may solve your problems, and if it does | |
| 145 | + *not* solve them, it will at least make the reasons for the problems | |
| 146 | + easier to understand. That's because I've overhauled the way that | |
| 147 | + FeedWordPress goes about updating feeds. | |
| 148 | + | |
| 149 | + If you use the command-line PHP scripting method to run scheduled | |
| 150 | + updates, then not much should change for you, except for fewer | |
| 151 | + mysterious errors. If you have done updates by sending periodic HTTP | |
| 152 | + requests to <http://your-blog.com/path/wp-content/update-feeds.php>, | |
| 153 | + then the details have changed somewhat; mostly in such a way as to make | |
| 154 | + things easier on you. See the README file or online documentation on | |
| 155 | + Staying Current for the details. | |
| 156 | + | |
| 157 | +* FEATURE: FeedWordPress now features a more sophisticated system for | |
| 158 | + timed updates. Instead of polling *every* subscribed feed for updates | |
| 159 | + *each* time `update-feeds.php` is run, FeedWordPress now keeps track of | |
| 160 | + the last time it polled each feed, and only polls them again after a | |
| 161 | + certain period of time has passed. The amount of time is normally set | |
| 162 | + randomly for each feed, in a period between 30 minutes and 2 hours (so | |
| 163 | + 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 | |
| 164 | + directly by the feed, which brings us to ... | |
| 165 | + | |
| 166 | +* FEATURE: FeedWordPress now respects the settings in the `ttl` and | |
| 167 | + Syndication Module RSS elements. Feeds with these elements set will not | |
| 168 | + be polled any more frequently than they indicate with these feeds unless | |
| 169 | + the user manually forces FeedWordPress to poll the feed (see Links --> | |
| 170 | + Syndicated --> Edit settings). | |
| 3 | 171 | |
| 4 | 172 | Changes from 0.95 to 0.96 |
| 5 | 173 | ------------------------- |
| 6 | 174 | |
