feedcache-config.yml
@@ -1,5 +1,16 @@
== CHANGELOG ==
+1.0.3 - 07/10/2008
+* update WP options to only use 2 option fields via an options array
+
+1.0.2 - 07/09/2008
+* use feed_tools gem for parsing
+* single YAML config file
+* store RSS cache into the WP database
+
+0.9.8 - 05/04/2008
+* allow for up to 99 feed groups now
+
0.9.5 - 12/02/2007
* added option to open feed links in a new browser window
CHANGELOG
@@ -1,9 +0,0 @@
-* update the readme file
-
-* get away from forcing the feedcache plugin directory to be called 'feedcache' - allow users to call it what they want and then just check for the base directory and path via PHP
-
-* switch from using Ruby to using the built-in WP fetch_rss calls that use Magpie and caching
-
-* make Feedity.com feeds work with plugin
-
-* make the feed groups sortable by newest items. If a feed has new items it should be "floated up" to the top of that group
TODO
@@ -6,9 +6,6 @@ FEEDCACHE_DIR = '/path/to/your/wordpress/wp-content/plugins/feedcache'
CHAR_COUNT = 75
# Set to 'true' if you want to receive error emails from the CRON job
CRON_EMAILS = false
-# Run as threaded
-THREADED = false
-
#################################################################
# #
@@ -17,31 +14,45 @@ THREADED = false
#################################################################
$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
-require 'net/http'
-require 'lib/feedparser'
-require 'uri'
+require 'rubygems'
+require 'active_record'
+require 'feed_tools'
require 'yaml'
# Read master config settings
MASTER_CONFIG = "#{FEEDCACHE_DIR}/master-config.txt"
+params = []
cfg = File.open(MASTER_CONFIG, 'r') do |f|
- @params = f.gets.split('~');
+ params = f.gets.split('~');
end
# parse the parameters from the config file
-@groups_num = @params[0].strip.to_i
-@display_num = @params[1].strip
-@title_pre = @params[2].strip
-@title_post = @params[3].strip
-@format_text = @params[4].strip == 'true' ? true : false
-@link_target = @params[5].strip == 'true' ? '_blank' : '_self'
+@groups_num = params[0].strip.to_i
+@display_num = params[1].strip
+@title_pre = params[2].strip
+@title_post = params[3].strip
+@format_text = params[4].strip == 'true' ? true : false
+@link_target = params[5].strip == 'true' ? '_blank' : '_self'
+WPDB_PREFIX = params[6].strip
+@wpdb_host = params[7].strip
+@wpdb_name = params[8].strip
+@wpdb_user = params[9].strip
+@wpdb_pass = params[10].strip
-# Load config and cache file variables
-CONFIG_FILE = "#{FEEDCACHE_DIR}/files/feedcache-config.yml"
-CACHE_FILES = []
-1.upto(@groups_num) do |i|
- CACHE_FILES << "#{FEEDCACHE_DIR}/files/feedcache-cache#{i}.txt"
+ActiveRecord::Base.establish_connection(
+ :adapter => 'mysql',
+ :host => @wpdb_host,
+ :username => @wpdb_user,
+ :password => @wpdb_pass,
+ :database => @wpdb_name
+)
+
+class WPFeed < ActiveRecord::Base
+ set_table_name "#{WPDB_PREFIX}feedcache_data"
end
+# Load config and cache file variables
+CONFIG_FILE = "#{FEEDCACHE_DIR}/feedcache-config.yml"
+
# RSS formatting function
def shorten_text(txt)
if txt.size > CHAR_COUNT
@@ -57,82 +68,68 @@ def shorten_text(txt)
end
end
-if THREADED
- # fork a thread for each config file here
- send_cron_emails = CRON_EMAILS ? '-e' : ''
- @groups_num.each do |group|
- pid = fork {
- # exec scripts here
- system("/usr/bin/env ruby feedcache-lite.rb -p #{CONFIG_FILE} -g #{group} -n #{@display_num.to_i} -f #{@format_text} -l #{@link_target} -c #{CHAR_COUNT.to_i} #{send_cron_emails}")
- }
- Process.detach(pid)
+begin # read the config file settings
+ @all_feeds = {}
+ yaml_config = YAML.load_file(CONFIG_FILE)
+ 1.upto(@groups_num) do |num|
+ feeds = []
+ next if yaml_config["group#{num}"].nil?
+ yaml_config["group#{num}"].each {|x| feeds << x.strip if (!x.nil? && !x.strip.blank?) }
+ @all_feeds[num] = feeds
+ feeds = nil
end
+rescue => e
+ if CRON_EMAILS
+ puts "Error reading YAML configuration file"
+ puts e.inspect
+ puts e.backtrace
+ end
+end
-else
-
- begin # read the config file settings
- @all_feeds = {}
- yaml_config = YAML.load_file(CONFIG_FILE)
- 1.upto(@groups_num) do |num|
- feeds = []
- next if yaml_config["group#{num}"].nil?
- yaml_config["group#{num}"].each {|x| feeds << x.strip if (!x.nil? && !x.strip.empty?) }
- @all_feeds[num] = feeds
- feeds = nil
- end
- rescue => e
- if CRON_EMAILS
- puts "Error reading YAML configuration file"
- puts YAML.dump(e)
- end
- end
-
- @all_feeds.each do |k,v|
- tmp = ''
- @processed = 0
+@all_feeds.each do |k,v|
+ tmp = ''
+ @processed = 0
- # parse the feeds here
- v.each do |feed|
- # puts "Group: #{k}, Feed: #{feed}"
- html_text = ''
- data = feed.split('|')
- feed_url, feed_title, feed_num, feed_format = data[0], data[1], data[2], data[3]
- begin
- source = Net::HTTP::get URI::parse(feed_url)
- fp = FeedParser::Feed::new(source)
- html_text << @title_pre + (feed_title || fp.title || '') + @title_post
- html_text << "<ul>"
- fp.items.each_with_index do |item, idx|
- break if feed_num ? feed_num.to_i == idx.to_i : @display_num.to_i == idx.to_i
- output = ''
- output << "<li><a href='#{item.link}' target='#{@link_target}'>"
- if feed_format && feed_format == 'true'
- txt = "#{item.title.downcase.gsub(/^[a-z]|\s+[a-z]/) {|a| a.upcase}}"
- output << shorten_text(txt)
- elsif @format_text == true
- txt = "#{item.title.downcase.gsub(/^[a-z]|\s+[a-z]/) {|a| a.upcase}}"
- output << shorten_text(txt)
- else
- output << "#{item.title}"
- end
- output << "</a></li>\n"
- html_text << output
- end # end fp.items.each
- html_text << "</ul><br />\n"
- tmp << html_text
- @processed += 1
- rescue => e
+ # parse the feeds here
+ v.each do |feed|
+ html_text = ''
+ data = feed.split('|')
+ feed_url, feed_title, feed_num, feed_format = data[0], data[1], data[2], data[3]
+ begin
+ fp = FeedTools::Feed.open(feed_url)
+ html_text << @title_pre + (feed_title || fp.title || '') + @title_post
+ html_text << "<ul>"
+ fp.items.each_with_index do |item, idx|
+ break if feed_num ? feed_num.to_i == idx.to_i : @display_num.to_i == idx.to_i
+ output = ''
+ output << "<li><a href='#{item.link}' target='#{@link_target}'>"
+ if feed_format && feed_format == 'true'
+ txt = "#{item.title.downcase.gsub(/^[a-z]|\s+[a-z]/) {|a| a.upcase}}"
+ output << shorten_text(txt)
+ elsif @format_text == true
+ txt = "#{item.title.downcase.gsub(/^[a-z]|\s+[a-z]/) {|a| a.upcase}}"
+ output << shorten_text(txt)
+ else
+ output << "#{item.title}"
+ end
+ output << "</a></li>\n"
+ html_text << output
+ end # end fp.items.each
+ html_text << "</ul><br />\n"
+ tmp << html_text
+ @processed += 1
+ rescue => e
+ if CRON_EMAILS
puts "Error processing feed - Group #{k.to_i + 1} - #{feed_url}"
- puts YAML.dump(e)
- end
- end
+ puts e.inspect
+ puts e.backtrace
+ end
+ end
+ end
- # if we had new feeds, move them to the cache file
- if @processed > 0
- cache = File::open(CACHE_FILES[k], "w")
- cache << tmp
- cache.close
- end
- end #--> @all_feeds.each do |k,v|
-
-end # end if THREADED
\ No newline at end of file
+ # if we had new feeds, move them to the cache file
+ if @processed > 0
+ wp_data = WPFeed.find_or_initialize_by_group_id(k)
+ wp_data.update_attributes(:data => tmp, :updated_at => Time.now)
+ end
+end #--> @all_feeds.each do |k,v|
feedcache-cron.rb
@@ -4,14 +4,22 @@ Plugin Name: FeedCache
Plugin URI: http://www.craigjolicoeur.com/feedcache
Description: Caches RSS Feeds for display on WP site sidebar. This prevents multiple HTTP requests with each page load since the feeds can be read from the cache file.
Author: Craig P Jolicoeur
-Version: 0.9.9
+Version: 1.0.3
Author URI: http://www.craigjolicoeur.com/
*/
+// Pre-2.6 compatibility
+if ( !defined('WP_CONTENT_URL') ) {
+ define('WP_CONTENT_URL', get_option('siteurl') . '/wp-content');
+}
+if ( !defined('WP_CONTENT_DIR') ) {
+ define('WP_CONTENT_DIR', ABSPATH . 'wp-content');
+}
+
// Constants
define("MAX_GROUPSIZE", 10);
-define("FEEDCACHE_PATH", ABSPATH . "wp-content/plugins/feedcache");
-define("FEEDCACHE_FILES_PATH", FEEDCACHE_PATH . '/' . "files/");
+define("FEEDCACHE_PATH", WP_CONTENT_DIR.'/plugins/'.plugin_basename(dirname(__FILE__)));
+define("FEEDCACHE_FILES_PATH", FEEDCACHE_PATH . '/');
define("DEFAULT_PRE_TAG", "<h3>");
define("DEFAULT_POST_TAG", "</h3>");
define("DEFAULT_FORMAT_TEXT", "true");
@@ -30,17 +38,76 @@ include_once(FEEDCACHE_PATH . '/lib/spyc/spyc.php');
// Wordpress hooks
add_action('admin_menu', 'feedcache');
+register_activation_hook(__FILE__, 'feedcache_install');
+
+// DB setup
+$feedcache_db_version = "1.0";
+function feedcache_install () {
+ global $wpdb;
+ global $feedcache_db_version;
+
+ // Install DB table if not already installed
+ $table_name = $wpdb->prefix . "feedcache_data";
+ if ($wpdb->get_var("show tables like '$table_name'") != $table_name) {
+ $sql = "CREATE TABLE " . $table_name . " (
+ id mediumint(9) NOT NULL AUTO_INCREMENT,
+ group_id mediumint(9) NOT NULL,
+ data text default NULL,
+ updated_at datetime default NULL,
+ UNIQUE KEY id (id),
+ UNIQUE KEY group_id (group_id)
+ );";
+
+ require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+ dbDelta($sql);
+
+ add_option("feedcache_db_version", $feedcache_db_version);
+ }
+
+ // Check if DB table upgrade is needed
+ $installed_ver = get_option("feedcache_db_version");
+ if ($installed_ver != $feedcache_db_version) {
+ $sql = ""; // New DB schema here
+
+ require_once(ABSPATH . 'wp-admin/inclues/upgrade.php');
+ dbDelta($sql);
+
+ update_option("feedcache_db_version", $feedcache_db_verion);
+ }
+
+ $new_groups = array();
+ $new_options = array(
+ 'group_num' => DEFAULT_GROUP_NUM,
+ 'display_num' => DEFAULT_DISPLAY_NUM,
+ 'title_pre' => DEFAULT_PRE_TAG,
+ 'title_post' => DEFAULT_POST_TAG,
+ 'format_text' => DEFAULT_FORMAT_TEXT,
+ 'target_blank' => false
+ );
+ // if old options exist, update to new system
+ foreach ( $new_options as $key => $value ) {
+ if( $existing = get_option('feedcache_'.$key) ) {
+ $new_options[$key] = $existing;
+ delete_option('feedcache_'.$key);
+ }
+ }
+ // if old groups exist, update to new system
+ for ($i=1; $i<=99; $i++) {
+ if( $existing = get_option("feedcache_rss_list$i") ) {
+ $new_groups["group$i"] = $existing;
+ delete_option("feedcache_rss_list$i");
+ }
+ }
+ add_option('plugin_feedcache_groups', $new_groups);
+ add_option('plugin_feedcache_options', $new_options);
+
+}
// Functions
function feedcache_display_feeds($rss_group = '1', $fname = 'feedcache-cache') {
- $fname = trim($fname.$rss_group);
- if (strlen($fname) > 0) {
- $fname = FEEDCACHE_FILES_PATH . $fname . '.txt';
- if (file_exists($fname)) {
- $file_content = file_get_contents($fname);
- return $file_content;
- }
- }
+ global $wpdb;
+ $feed_data = $wpdb->get_row("SELECT * FROM " . $wpdb->prefix . "feedcache_data WHERE group_id = $rss_group");
+ return $feed_data->data;
}
function fc_build_config_file($group_array, $fname = 'feedcache-config') {
@@ -70,6 +137,7 @@ function fc_build_config_file($group_array, $fname = 'feedcache-config') {
}
function fc_build_master_config($group_num, $display_num, $title_pre, $title_post, $format_text, $target_blank, $fname = 'master-config') {
+ global $wpdb;
$fpath = FEEDCACHE_PATH . "/$fname" . ".txt";
if (is_writable($fpath)) {
@@ -77,7 +145,7 @@ function fc_build_master_config($group_num, $display_num, $title_pre, $title_pos
echo "Cannot open file ($fpath)";
exit;
}
- if (fwrite($handle, "$group_num~$display_num~$title_pre~$title_post~$format_text~$target_blank") === FALSE) {
+ if (fwrite($handle, "$group_num~$display_num~$title_pre~$title_post~$format_text~$target_blank~$wpdb->prefix~".DB_HOST."~".DB_NAME."~".DB_USER."~".DB_PASSWORD) === FALSE) {
echo "Cannot write to file ($fpath)";
exit;
}
@@ -94,51 +162,44 @@ function feedcache() {
}
function feedcache_subpanel() {
- for ($i=1; $i<=MAX_GROUPSIZE; $i++) {
- add_option("feedcache_rss_list$i", '');
- }
- add_option('feedcache_group_num', DEFAULT_GROUP_NUM);
- add_option('feedcache_display_num', DEFAULT_DISPLAY_NUM);
- add_option('feedcache_title_pre', DEFAULT_PRE_TAG);
- add_option('feedcache_title_post', DEFAULT_POST_TAG);
- add_option('feedcache_format_text', DEFAULT_FORMAT_TEXT);
- add_option('feedcache_target_blank', false);
-
- if ($_POST['stage'] == 'prep') {
- update_option('feedcache_group_num', $_POST['feedcache_group_num']);
+
+ if ($_POST['stage'] == 'prep') {
+ $options = get_option('plugin_feedcache_options');
+ $options['group_num'] = $_POST['feedcache_group_num'];
+ update_option('plugin_feedcache_options', $options);
+ }
+
+ $options = get_option('plugin_feedcache_options');
+ $number_of_groups = $options['group_num'];
+
+ if ($_POST['stage'] == 'process' ) {
+ for ($i=1; $i<=$number_of_groups; $i++) {
+ $group_array["group$i"] = $_POST["feedcache_rss_list$i"]; //explode("\n", $_POST["feedcache_rss_list$i"]);
}
-
- $number_of_groups = get_option('feedcache_group_num');
-
- if ($_POST['stage'] == 'process' ) {
- // $group_array = [];
-
- for ($i=1; $i<$number_of_groups; $i++) {
- update_option("feedcache_rss_list$i", $_POST["feedcache_rss_list$i"]);
- $group_array["group$i"] = explode("\n", $_POST["feedcache_rss_list$i"]);
- }
- fc_build_config_file($group_array);
-
- // update other variables and master config
- update_option('feedcache_display_num', $_POST['feedcache_display_num']);
- update_option('feedcache_title_pre', $_POST['feedcache_title_pre']);
- update_option('feedcache_title_post', $_POST['feedcache_title_post']);
- update_option('feedcache_format_text', $_POST['feedcache_format_text']);
- update_option('feedcache_target_blank', $_POST['feedcache_target_blank']);
- fc_build_master_config($number_of_groups, $_POST['feedcache_display_num'], $_POST['feedcache_title_pre'], $_POST['feedcache_title_post'], $_POST['feedcache_format_text'], $_POST['feedcache_target_blank']);
- }
+ update_option('plugin_feedcache_groups', $group_array);
+ fc_build_config_file($group_array);
+
+ // update other variables and master config
+ $new_options = $_POST['feedcache'];
+ $new_options['group_num'] = $number_of_groups;
+ update_option('plugin_feedcache_options', $new_options);
+ fc_build_master_config($new_options['group_num'], $new_options['display_num'], $new_options['title_pre'], $new_options['title_post'], $new_options['format_text'], $new_options['target_blank']);
+ }
+
+ $options = get_option('plugin_feedcache_options');
+ $groups = get_option('plugin_feedcache_groups');
?>
- <div class="wrap">
- <h2 id="write-post">FeedCache…</h2>
- <p>Fill in the list of RSS feeds you want to process and how you want them formatted and displayed on your site. If you notice any bugs or have suggestions please contact the developers at <a href="http://www.craigjolicoeur.com/feedcache" title="Craig Jolicoeurs's Home Page">FeedCache on craigjolicoeur.com</a>.</a></p>
- <form method="post" action="<?php echo $_SERVER['PHP_SELF']; ?>?page=feedcache/feedcache.php" name="prep_form">
- <input type="hidden" name="stage" value="prep" />
- <fieldset class="options">
- <legend>FeedCache Options</legend>
-
- <div>
- How many RSS Groups do you want?
+ <div class="wrap">
+ <h2 id="write-post">FeedCache…</h2>
+ <p>Fill in the list of RSS feeds you want to process and how you want them formatted and displayed on your site. If you notice any bugs or have suggestions please contact the developers at <a href="http://www.craigjolicoeur.com/feedcache" title="Craig Jolicoeurs's Home Page">FeedCache on craigjolicoeur.com</a>.</a></p>
+ <form method="post" action="<?php echo $_SERVER['REQUEST_URI']; ?>" name="prep_form">
+ <table class="form-table">
+ <tbody>
+ <tr valign="top">
+ <th scope="row">How many RSS Groups do you want?</th>
+ <td>
+ <label for="feedcache_group_num">
<select name="feedcache_group_num" onchange="document.prep_form.submit();">
<?php
for($i=1; $i <= MAX_GROUPSIZE; $i++) {
@@ -151,70 +212,88 @@ function feedcache_subpanel() {
}
?>
</select>
- </div>
- </fieldset>
- </form>
-
- <form method="post" action="<?php echo $_SERVER['PHP_SELF']; ?>?page=feedcache/feedcache.php">
- <input type="hidden" name="stage" value="process" />
- <fieldset class="options">
- <div>
- <p>Enter the list of RSS Feeds [1 per line]</p>
- <p>Following the RSS URL, there are up to three (3) additional options you can specify for each feed: 1. Feed title, 2.
- Number of items to display, 3. Option to enable special formatting of feed text (boolean value - true/false)</p>
- <p>If you wish to specify the third option, you MUST also set the first two options. If you wish to set the
- second option, you MUST also specify the first option</p>
- <p>All options should be separated by the pipe ('|') character with no spaces before and after the pipe</p>
- <p>(e.g. http://www.yourfeed.com/feed|Feed Title|4|false)</p>
-
- <?php
- for($i=1; $i<=$number_of_groups; $i++) {
- ?>
- <h3>Group <?php echo $i; ?></h3>
- <textarea name="feedcache_rss_list<?php echo $i; ?>" rows="10" style="width:90%;"><?php echo get_option("feedcache_rss_list$i"); ?></textarea>
- <?php
- }
- ?>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ <input type="hidden" name="stage" value="prep" />
+ </form><!-- end #prep_form -->
+
+ <form method="post" action="<?php echo $_SERVER['REQUEST_URI']; ?>">
+ <div>
+ <p>Enter the list of RSS Feeds [1 per line]</p>
+ <p>Following the RSS URL, there are up to three (3) additional options you can specify for each feed: 1. Feed title, 2.
+ Number of items to display, 3. Option to enable special formatting of feed text (boolean value - true/false)</p>
+ <p>If you wish to specify the third option, you MUST also set the first two options. If you wish to set the
+ second option, you MUST also specify the first option</p>
+ <p>All options should be separated by the pipe ('|') character with no spaces before and after the pipe</p>
+ <p>(e.g. http://www.yourfeed.com/feed|Feed Title|4|false)</p>
+ </div>
+ <table class="form-table">
+ <tbody>
+ <?php
+ for ($i=1; $i<=$number_of_groups; $i++) {
+ ?>
+ <tr valign="top">
+ <th scope="row">Group <?php echo $i; ?></th>
+ <td>
+ <textarea name="feedcache_rss_list<?php echo $i; ?>" rows="10" cols="60" style="width:98%;"><?php echo $groups["group$i"]; ?></textarea>
+ </td>
+ </tr>
+ <?php
+ }
+ ?>
+ <tr valign="top">
+ <th scope="row">Number of articles to display:</th>
+ <td><input type="text" name="feedcache[display_num]" style="width:20px;" value="<?php echo $options['display_num']; ?>" />
+ </td>
+ </tr>
+ <tr valign="top">
+ <th scope="row">Format feed text for capitalization: </th>
+ <td>
+ <label for"feedcache[format_text]">
+ <select name="feedcache[format_text]">
+ <option value='true' <?php if ($options['format_text'] == 'true') { echo 'selected'; } ?> >True</option>
+ <option value='false' <?php if ($options['format_text'] == 'false') { echo 'selected'; } ?> </select>
+ </label>
+ </td>
+ </tr>
+ <tr valign="top">
+ <th scope="row">Open feed links in a new window:</th>
+ <td>
+ <label for"feedcache[target_blank]">
+ <select name="feedcache[target_blank]">
+ <option value='true' <?php if ($options['target_blank'] == 'true') { echo 'selected'; } ?> >True</option>
+ <option value='false' <?php if ($options['target_blank'] == 'false') { echo 'selected'; } ?> </select>
+ </label>
+ </td>
+ </tr>
+ <tr valign="top">
+ <th scope="row">Feed title display pre/post tags:</th>
+ <td>
+ <input type="text" name="feedcache[title_pre]" style="width:50px;" value=<?php echo '\''. $options['title_pre'] . '\''; ?> /> /
+ <input type="text" name="feedcache[title_post]" style="width:50px;" value=<?php echo '\''. $options['title_post'] . '\''; ?> /> <em style="font-size:11px;">e.g <h2> / </h2></em>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="submit">
+ <input type="submit" value="Update FeedCache Preferences »" name="Submit" />
+ </div>
+ <input type="hidden" name="stage" value="process" />
+ </form><!-- end main form -->
- </div>
- <div>
- <p>
- <label for='feedcache_display_num'>Number of articles to display: </label>
- <input type="text" name="feedcache_display_num" style="width: 20px;" value=<?php echo '\'' . get_option('feedcache_display_num') . '\''; ?> />
- </p>
- <p>
- <label for='feedcache_format_text'>Format feed text for proper capitalization: </label>
- <select name="feedcache_format_text">
- <option value='true' <?php if (get_option('feedcache_format_text') == 'true') { echo 'selected'; } ?> >True</option>
- <option value='false' <?php if (get_option('feedcache_format_text') == 'false') { echo 'selected'; } ?> >False</option>
- </select>
- </p>
- <p>
- <label for='feedcache_target_blank'>Open feed links in a new window: </label>
- <select name="feedcache_target_blank">
- <option value='true' <?php if (get_option('feedcache_target_blank') == 'true') { echo 'selected'; } ?> >True</option>
- <option value='false' <?php if (get_option('feedcache_target_blank') == 'false') { echo 'selected'; } ?> >False</option>
- </select>
- </p>
- <p>
- <label for="feedcache_title_pre_post">Feed Title Display Pre/Post Tags: </label>
- <input type="text" name="feedcache_title_pre" style="width:50px;" value=<?php echo '\''. get_option('feedcache_title_pre') . '\''; ?> /> /
- <input type="text" name="feedcache_title_post" style="width:50px;" value=<?php echo '\''. get_option('feedcache_title_post') . '\''; ?> /> <em style="font-size:11px;">e.g <h2> / </h2></em>
- </p>
- </div>
- </fieldset>
-
- <p class="submit"><input type="submit" value="Update FeedCache Preferences »" name="Submit" /></p>
-
- <fieldset id="script-settings" class="options">
- <legend>CRON Script Settings</legend>
- <p>
- Here is the <b>feedcache directory path</b> to use in the CRON script:<br />
- <?php echo FEEDCACHE_PATH . "<br />"; ?>
- </p>
- </fieldset>
- </form>
- </div>
+
+ <div class="options" id="script-settings">
+ <h3>CRON Script Settings</h3>
+ <p>
+ Here is the <b>feedcache directory path</b> to use in the CRON script:<br />
+ <?php echo FEEDCACHE_PATH . "<br />"; ?>
+ </p>
+ </div>
+ </div><!-- end .wrap -->
<?php
}
feedcache.php
@@ -1,16 +1,18 @@
=== FeedCache ===
Contributors: cpjolicoeur
Donate link: http://www.craigjolicoeur.com/feedcache
-Tags: RSS, ATOM, feed, cache
+Tags: RSS, ATOM, feed, cache, Ruby, CRON
Requires at least: 1.5
-Tested up to: 2.5.*
-Stable tag: 0.9.9
+Tested up to: 2.6.*
+Stable tag: 1.0.3
Caches RSS Feeds for display on your WP sidebar.
== Requirements ==
* Ruby
+* Rubygems with the following gems available: active_record, feed_tools
+ (If you are hosted with Dreamhost you have these gems already. If you are hosted elsewhere you will need to check. If you run a VPS or dedicated machine like me, then just install them via `sudo gem install`)
* CRON access
== Description ==
@@ -19,15 +21,14 @@ FeedCache will retrieve, cache and store locally a list of RSS feeds that you ca
== Installation ==
-1. Upload the feedcache directory to your wordpress wp-content/plugins directory.
+1. Upload the feedcache directory to your wordpress wp-content/plugins directory. Make sure the feedcache directory is writeable by the web server (rw-rw-rw 666).
-2a. Change the file permissions on the master-config.txt file to rw-rw-rw- (666)
-2b. Change the file permissions on the files/ directory to rwxrwxrwx (777)
+2. Change the file permissions on the master-config.txt file to rw-rw-rw- (666)
3. Activate the FeedCache plugin through your wordpress plugin menu
4. Setup FeedCache options under the Options -> FeedCache Options menu
- (a) Choose the number of feed groups you want (1 - 10)
+ (a) Choose the number of feed groups you want (1 - 99)
(b) Add your list of RSS feeds 1 per line and set the other options. You can have up to 4 different groupings of RSS feeds to cache.
If you wish to manually override the name of the feed, place a pipe character "|" after the RSS URL and then type the name you want to use (e.g http://www.craigjolicoeur.com|Craig P Jolicoeur)
If you wish to manually override the number of feed items to display, place a pipe character "|" after the feed title and enter the number to display
@@ -60,14 +61,14 @@ FeedCache will retrieve, cache and store locally a list of RSS feeds that you ca
== Upgrading ==
**** IMPORTANT ************************************************************************
- If you are upgrading from a version of FeedCache prior to v0.9, please
+ If you are upgrading from a version of FeedCache prior to v0.9.8, please
deactivate and delete your existing feedcache plugin directory and follow the new
installation steps.
***************************************************************************************
1. Deactivate the previous version of FeedCache through your Wordpress plugins menu
-2. Upload the new feedcache-cron.rb, feedcache.php and complete lib/ directory files to your existing feedcache directory. You do not need to overwrite your existing files/ directory or the master-config.txt file.
+2. Upload the new feedcache-cron.rb, feedcache.php and complete lib/ directory files to your existing feedcache directory. You do not need to overwrite your master-config.txt file.
3. Enter the correct FEEDCACHE_DIR variable in the feedcache-cron.rb script
@@ -78,11 +79,11 @@ FeedCache will retrieve, cache and store locally a list of RSS feeds that you ca
= Why would I need this plugin? =
-If you are using your WP installation to display other website's RSS feeds, this will save HTTP requests and improve page load times for your users.
+If you are using your WP installation to display other website's RSS feeds, this will save HTTP requests and improve page load times for your users. By using a CRON job to fetch and format the feeds, the user will not have to wait during page load for the feed to be updated.
= Will FeedCache work with Atom feeds? =
-Yes! Since version 0.8, FeedCache will work with both RSS and ATOM feeds.
+Yes! FeedCache will work with both RSS and ATOM feeds.
= Can I receive error emails from the CRON process? =
readme.txt
files/README
lib/feedparser.rb
lib/feedparser/.svn/all-wcprops
lib/feedparser/.svn/entries
lib/feedparser/.svn/format
lib/feedparser/.svn/text-base/feedparser.rb.svn-base
lib/feedparser/.svn/text-base/filesizes.rb.svn-base
lib/feedparser/.svn/text-base/html-output.rb.svn-base
lib/feedparser/.svn/text-base/html2text-parser.rb.svn-base
lib/feedparser/.svn/text-base/rexml_patch.rb.svn-base
lib/feedparser/.svn/text-base/sgml-parser.rb.svn-base
lib/feedparser/.svn/text-base/text-output.rb.svn-base
lib/feedparser/.svn/text-base/textconverters.rb.svn-base
lib/feedparser/feedparser.rb
lib/feedparser/filesizes.rb
lib/feedparser/html-output.rb
lib/feedparser/html2text-parser.rb
lib/feedparser/rexml_patch.rb
lib/feedparser/sgml-parser.rb
lib/feedparser/text-output.rb
lib/feedparser/textconverters.rb
fe1b27f7e07d17b62f850c3285f4b1a1870c9f12
Craig P Jolicoeur
cpjolicoeur@gmail.com
http://github.com/cpjolicoeur/feedcache/commit/4f49060a624f824341b49102bd3c82ae1c1362fc
4f49060a624f824341b49102bd3c82ae1c1362fc
2008-07-10T09:16:03-07:00
2008-07-10T09:16:03-07:00
update to version 1.0.3 from wordpress.org
849f13952255761f0b3e50d14c21b07469cdd787
Craig P Jolicoeur
cpjolicoeur@gmail.com