| @@ -1,7 +1,191 @@ | ||
| 1 | 1 | FeedWordPress Change Log |
| 2 | 2 | ======================== |
| 3 | 3 | |
| 4 | +Changes from 0.981 to 0.99 | |
| 5 | +-------------------------- | |
| 6 | +Version 0.99 adds several significant new features, fixes some bugs, and | |
| 7 | +provides compatability with WordPress 2.2.x and 2.3.x. | |
| 8 | + | |
| 9 | +* WORDPRESS 2.2 AND 2.3 COMPATIBILITY: FeedWordPress should now be | |
| 10 | + compatible with WordPress version 2.2 and the upcoming WordPress | |
| 11 | + version 2.3. In particular, it has been tested extensively against | |
| 12 | + WordPress 2.2.3 and WordPress 2.3 Release Candidate 1. | |
| 13 | + | |
| 14 | +* AUTOMATIC UPDATES WITHOUT CRON: FeedWordPress now allows you to | |
| 15 | + automatically schedule checks for new posts without using external task | |
| 16 | + scheduling tools such as cron. In order to enable automatic updates, go | |
| 17 | + to **Syndication --> Options** and set "Check for new posts" to | |
| 18 | + "automatically." For details, see "Automatic Feed Updates" in | |
| 19 | + README.text. | |
| 20 | + | |
| 21 | + An important side-effect of the changes to the update system is that if | |
| 22 | + you were previously using the cron job and the `update-feeds.php` script | |
| 23 | + to schedule updates, you need to change your cron set-up. The old | |
| 24 | + `update-feeds.php` script no longer exists. Instead, if you wish to use | |
| 25 | + a cron job to guarantee updates on a particular schedule, you should | |
| 26 | + have the cron job fetch the front page of your blog (for example, by | |
| 27 | + using `curl http://www.zyx.com/blog/ > /dev/null`) instead of activating | |
| 28 | + the `update-feeds.php` script. If automatic updates have been enabled, | |
| 29 | + fetching the front page will automatically trigger the update process. | |
| 30 | + | |
| 31 | +* INTERFACE REORGANIZATION: All FeedWordPress functions are now located | |
| 32 | + under a top-level "Syndication" menu in the WordPress Dashboard. To | |
| 33 | + manage the list of syndicated sites, manually check for new posts on | |
| 34 | + one or more feeds, or syndicate a new site, you should use the main page | |
| 35 | + under **Syndication**. To change global settings for FeedWordPress, | |
| 36 | + you should use **Syndication --> Options**. | |
| 37 | + | |
| 38 | +* FILE STRUCTURE REORGANIZATION: Due to a combination of changing styles | |
| 39 | + for FeedWordPress plugins and lingering bugs in the FeedWordPress admin | |
| 40 | + menu code, the code for FeedWordPress is now contained in two different | |
| 41 | + PHP files, which should be installed together in a subdirectory of your | |
| 42 | + plugins directory named `feedwordpress`. (See README.text for | |
| 43 | + installation and upgrade instructions relating to the change.) | |
| 44 | + | |
| 45 | +* MULTIPLE CATEGORIES SETTING: Some feeds use non-standard methods to | |
| 46 | + indicate multiple categories within a single category element. (The most | |
| 47 | + popular site to do this is del.icio.us, which separates tags with a | |
| 48 | + space.) FeedWordPress now allows you to set an optional setting, for any | |
| 49 | + feed which does this, indicating the character or characters used to | |
| 50 | + divide multiple categories, using a Perl-compatible regular expression. | |
| 51 | + (In the case of del.icio.us feeds, FeedWordPress will automatically use | |
| 52 | + \s for the pattern without your having to do any further configuration.) | |
| 53 | + To turn this setting on, simply use the "Edit" link for the feed that | |
| 54 | + you want to turn it on for. | |
| 55 | + | |
| 56 | +* REGULAR EXPRESSION BUG FIXED: Eliminated a minor bug in the regular | |
| 57 | + expressions for e-mail addresses (used in parsing RSS `author` | |
| 58 | + elements), which could produce unsightly error messages for some users | |
| 59 | + parsing RSS 2.0 feeds. | |
| 60 | + | |
| 61 | +* DATE / UPDATE BUG FIXED: A bug in date handling was eliminated that may | |
| 62 | + have caused problems if any of (1) WordPress, or (2) PHP, or (3) your | |
| 63 | + web server, or (4) your MySQL server, has been set to use a different | |
| 64 | + time zone from the one that any of the others is set to use. If | |
| 65 | + FeedWordPress has not been properly updating updated posts, or has been | |
| 66 | + updating posts when there shouldn't be any changes for the update, this | |
| 67 | + release may solve that problem. | |
| 68 | + | |
| 69 | +* GOOGLE READER BUGS FIXED: A couple of bugs that made it difficult for | |
| 70 | + FeedWordPress to interact with Google Reader public feeds have been | |
| 71 | + fixed. Firstly, if you encountered an error message reading "There was a | |
| 72 | + problem adding the newsfeed. [SQL: ]" when you tried to add the feed, | |
| 73 | + the cause of this error has been fixed. Secondly, if you succeeded in | |
| 74 | + getting FeedWordPress to check a Google Reader feed, only to find that | |
| 75 | + the title of posts had junk squashed on to the end of them, that bug | |
| 76 | + has been fixed too. To fix this bug, you must install the newest version | |
| 77 | + of the optional MagpieRSS upgrade. | |
| 78 | + | |
| 79 | +* FILTER PARAMETERS: Due to an old, old bug in WordPress 1.5.0 (which was | |
| 80 | + what was available back when I first wrote the filter interface), | |
| 81 | + FeedWordPress has traditionally only passed one parameter to | |
| 82 | + syndicated_item and syndicated_post filters functions -- an array | |
| 83 | + containing either the Magpie representation of a syndicated item from | |
| 84 | + the feed, or the database representation of a post about to be inserted | |
| 85 | + into the WordPress database. If you needed information about the feed | |
| 86 | + that the item came from, this was accessible only through a pair of | |
| 87 | + global variables, $fwp_channel and $fwp_feedmeta. | |
| 88 | + | |
| 89 | + Since it's been a pretty long time since WordPress 1.5.0 was in | |
| 90 | + widespread usage, I have gone ahead and added an optional second | |
| 91 | + parameter to the invocation of the syndicated_item and syndicated_post | |
| 92 | + filters. If you have written a filter for FeedWordPress that uses either | |
| 93 | + of these hooks, you can now register that filter to accept 2 parameters. | |
| 94 | + If you do so, the second parameter will be a SyndicatedPost object, | |
| 95 | + which, among other things, allows you to access information about the | |
| 96 | + feed from which an item is syndicated using the $post->feed and the | |
| 97 | + $post->feedmeta elements (where $post is the name of the second | |
| 98 | + parameter). | |
| 99 | + | |
| 100 | + NOTE THAT THE OLD GLOBAL VARIABLES ARE STILL AVAILABLE, for the time | |
| 101 | + being at least, so existing filters will not break with the upgrade. | |
| 102 | + They should be considered deprecated, however, and may be eliminated in | |
| 103 | + the future. | |
| 104 | + | |
| 105 | +* FILTER CHANGE / BUGFIX: the array that is passed as the first argument | |
| 106 | + syndicated_post filters no longer is no longer backslash-escaped for | |
| 107 | + MySQL when filters are called. This was originally a bug, or an | |
| 108 | + oversight; the contents of the array should only be escaped for the | |
| 109 | + database *after* they have gone through all filters. IF YOU HAVE WRITTEN | |
| 110 | + ANY syndicated_post FILTERS THAT PRESUME THE OLD BEHAVIOR OF PASSING IN | |
| 111 | + STRINGS THAT ARE ALREADY BACKSLASH-ESCAPED, UPDATE YOUR FILTERS | |
| 112 | + ACCORDINGLY. | |
| 113 | + | |
| 114 | +* OTHER MINOR BUGFIXES AND INTERNAL CHANGES: The internal architecture of | |
| 115 | + FeedWordPress has been significantly changed to make the code more | |
| 116 | + modular and clean; hopefully this should help reduce the number of | |
| 117 | + compatibility updates that are needed, and make them easier and quicker | |
| 118 | + when they are needed. | |
| 119 | + | |
| 120 | +Changes from 0.98 to 0.981 | |
| 121 | +-------------------------- | |
| 122 | +Version 0.981 is a narrowly targeted bugfix and compatibility release, whose | |
| 123 | +main purpose is to resolve a major outstanding problem: the incompatibility | |
| 124 | +between version 0.98 of WordPress and the recently released WordPress 2.1. | |
| 125 | + | |
| 126 | +* WORDPRESS 2.1 COMPATIBILITY: FeedWordPress is now compatible with | |
| 127 | + WordPress 2.1, as well as retaining its existing support for WordPress | |
| 128 | + 2.0 and 1.5. Incompatibilities that resulted in database warnings, fatal | |
| 129 | + errors, and which prevented FeedWordPress from syndicating new posts, | |
| 130 | + have been eliminated. | |
| 131 | + | |
| 132 | +* RSS-FUNCTIONS.PHP RENAMED TO RSS.PHP: if you use the upgraded MagpieRSS | |
| 133 | + replacement that's included with FeedWordPress, be sure to note that | |
| 134 | + there are now *two* files to upload from the `OPTIONAL/wp-includes` | |
| 135 | + subdirectory in order to carry out the upgrade: rss-functions.php and | |
| 136 | + rss.php. **It is necessary to upload both files**, due to a change in | |
| 137 | + the file naming scheme in WordPress 2.1, and it is necessary to do so | |
| 138 | + whether you are using WordPress 2.1 or not. If you only upload the | |
| 139 | + `rss-functions.php` file as in previous installations you will not have | |
| 140 | + a working copy of MagpieRSS; the rss.php file contains the actual code. | |
| 141 | + | |
| 142 | +* DATE BUG AFFECTING SOME PHP INSTALLATIONS RESOLVED: due to a subtle bug | |
| 143 | + in parse_w3cdtf(), some installations of PHP encountered problems with | |
| 144 | + FeedWordPress's attempt to date posts, which would cause some new posts | |
| 145 | + on Atom feeds to be dated as if they had apppeared in 1969 or 1970 | |
| 146 | + (thus, effectively, never appearing on front apge at all). This bug in | |
| 147 | + the date handling should now be fixed. | |
| 148 | + | |
| 149 | +* PHP <?=...?> SHORT FORM ELIMINATED: some installations of PHP do not | |
| 150 | + allow the <?=...?> short form for printing PHP values, which was used | |
| 151 | + extensively in the FeedWordPress interface code. Since this could cause | |
| 152 | + fatal errors for users with the wrong installation of PHP, the short | |
| 153 | + form has been replaced with full PHP echo statements, and is no longer | |
| 154 | + used in FeedWordPress. | |
| 155 | + | |
| 156 | +* BETTER USER INTERFACE INTEGRATION WITH WORDPRESS 2.x: Some minor changes | |
| 157 | + have been made to help the FeedWordPress interface pages blend in better | |
| 158 | + with the user interface when running under WordPress 2.x. | |
| 159 | + | |
| 160 | +* GLOBAL CATEGORIES BUG RESOLVED: a bug that prevented some users from | |
| 161 | + setting one or more categories to apply to syndicated posts from all | |
| 162 | + feeds (using the checkbox interface under Options --> Syndication) has | |
| 163 | + been resolved. | |
| 164 | + | |
| 165 | +Changes from 0.97 to 0.98 | |
| 166 | +-------------------------- | |
| 167 | + | |
| 168 | +* WORDPRESS 2.0 COMPATIBILITY: This is a narrowly-targeted release to | |
| 169 | + solve a major outstanding problem. FeedWordPress is now compatible with | |
| 170 | + both WordPress 1.5 and WordPress 2.0. Incompatibilities that caused | |
| 171 | + fatal SQL errors, and a more subtle bug with off-kilter counts of posts | |
| 172 | + under a given category, have been resolved. FeedWordPress tests for | |
| 173 | + database schema using the global $wp_db_version variable (if null, then | |
| 174 | + we presume that we're dealing with WordPress 1.5). | |
| 175 | + | |
| 176 | + NOTE: I have **not** fully tested FeedWordPress with WordPress 2.0. | |
| 177 | + Further testing may reveal more bugs. However, you should now be able | |
| 178 | + to get at least basic FeedWordPress functionality up and running. | |
| 179 | + | |
| 180 | +* AUTHOR MATCHING: FeedWordPress tests several fields to see if it can | |
| 181 | + identify the author of the post as a user already in the WordPress user | |
| 182 | + database. In previous versions, it tested the user login, the nickname, | |
| 183 | + and tested for "aliases" listed in the Profile (see documentation). FWP | |
| 184 | + now also matches authors on the basis of e-mail address (*if* an e-mail | |
| 185 | + address is present). This is particularly helpful for formats such as | |
| 186 | + RSS 2.0, in which authors are primarily identified by e-mail addresses. | |
| 187 | + | |
| 4 | 188 | Changes from 0.96 to 0.97 |
| 5 | 189 | ------------------------- |
| 6 | 190 | |
| 7 | 191 | * INSTALLATION PROCEDURE: Some of the changes between 0.96 and 0.97 |
