flickrfeed.php

<?php

/**
 * A simple ZenphotoCMS plugin to display the latest public images from a Flickr account
 * 
 * It does use the public RSS feed and therefore only covers public content.
 * 
 * ## Installation
 * 
 * Place the file `flickrfeed.php` into your `/plugins` folder, enable it and set the plugin options.
 * 
 * Add `flickrFeed::printFeed(4);` to your theme where you want to display the latest images.
 * 
 * Note the plugin does just print an unordered list with linked thumbs and does not provide any default CSS styling. 
 * 
 * @author Malte Müller (acrylian), with additions by kuzzzma (since v1.1.1)
 * @licence GPL v3 or later
 */
$plugin_description = gettext('A simple plugin to display the latest public images from a Flickr account');
$plugin_author = 'Malte Müller (acrylian)';
$plugin_version = '1.1.2';
$plugin_category = gettext('Media');
$option_interface = 'flickrFeedOptions';

class flickrFeedOptions {

	function __construct() {
		setOptionDefault('flickrfeed_cachetime', 86400);
		purgeOption('flickrfeed_cache');
		purgeOption('flickrfeed_lastmod');
	}

	function getOptionsSupported() {
		return array(
				gettext('Flickr User UD') => array(
						'key' => 'flickrfeed_userid',
						'type' => OPTION_TYPE_TEXTBOX,
						'order' => 1,
						'desc' => gettext('The user ID of your Flickr account to fetch. NOTE: Not an username! Flickr ID has a format of "XXXXXXXX@N00".<br>
						To find yours - login into Flickr and check <a href="https://www.flickr.com/services/api/explore/flickr.people.getPublicPhotos">API page</a> - on the right there is a section "Useful Values", at the top your user ID is listed.')),
				gettext('Cache time') => array(
						'key' => 'flickrfeed_cachetime',
						'type' => OPTION_TYPE_TEXTBOX,
						'order' => 1,
						'desc' => gettext('The time the cache is kept until the data is fetched freshly')),
				gettext('Clear cache') => array(
						'key' => 'flickrfeed_cacheclear',
						'type' => OPTION_TYPE_CHECKBOX,
						'order' => 1,
						'desc' => gettext('Check and save options to clear the cache on force.'))
		);
	}
	
	function handleOptionSave($themename, $themealbum) {
		if (isset($_POST['flickrfeed_cacheclear'])) {
			flickrFeed::saveCache('');
			flickrFeed::saveLastmod();
			setOption('flickrfeed_cacheclear', false);
		}
		return false;
	}

}

/**
 * Class to fetch latest images from a Flickr account as rss2
 */
class flickrFeed {
	
	/**
	 * Returns an array with the feed information, either freshly or from cache.
	 * 
	 * @return array
	 */
	static function getFeed() {
		require_once(SERVERPATH . '/' . ZENFOLDER . '/' . PLUGIN_FOLDER . '/zenphoto_news/rsslib.php');
		$userid = trim(getOption('flickrfeed_userid'));
		if ($userid) {
			$feedurl = 'https://www.flickr.com/services/feeds/photos_public.gne?id=' . sanitize($userid) . '&format=rss2';
			$cache = flickrFeed::getCache();
			$lastmod = flickrFeed::getLastMod();
			$cachetime = getOption('flickrfeed_cachetime');
			if (empty($cache) || (time() - $lastmod) > $cachetime) {
				$content = RSS_Retrieve($feedurl);
				flickrFeed::saveCache($content);
				flickrFeed::saveLastMod();
				return $content;
			} else {
				return $cache;
			}
		}
		return array();
	}

	/**
	 * Prints a list of images from a users Flickr public photos RSS feed
	 * 
	 * Notes: 
	 * The feed is always fetched compeltely as Flickr provides no limit here. The $number parameter is used internally only.
	 * Also Flickr provides the images thumbnail size, there is no sizing available other than fake resizing using CSS.
	 * 
	 * @param int $number The number of images to display
	 * @param string $class default "flickrfeed" to use the default styling
	 */
	static function printFeed($number = 4, $class="flickrfeed") {
		$content = flickrFeed::getFeed();
		$count = '';
		if ($content) {
			?>
			<ul class="<?php echo html_encode($class); ?>">
				<?php
				foreach ($content as $item) {
					//echo "<pre>"; print_r($item); echo "</pre>";
					$thumb = flickrFeed::getItemLinkAndThumb($item);
					if ($thumb) {
						$count++;
						echo '<li>' .$thumb . '</li>';
						if ($count == $number) {
							break;
						}
					}
				}
				?>
						</ul>
			<?php
		}
	}

	/**
	 * Returns <a><img></a> HTML of the Image posted with medium thumbnail (max 240x240px)
	 * 
	 * @param array $item The item array 
	 */
	static function getItemLinkAndThumb($item) {
		$expl = explode('<p>', $item['description']);
		if (array_key_exists(2, $expl)) {
			return str_replace('</p>','',$expl[2]);
		}
	}

	/**
	 * Returns the Image Description wrapped in a paragraph.
	 *
	 * @param array $item The item array 
	 */
	static function getItemDescription($item) {
		$expl = explode("<p>", $item['description']);
		if (array_key_exists(3, $expl)) {
			return $expl[3];
		}
	}

	/**
	 * Returns the URL of the Image.
	 *
	 * @param array $item The item array 
	 */
	static function getItemURL($item) {
			return $item['link'];
	}

	/**
	 * Returns the Title of the Image.
	 *
	 * @param array $item The item array 
	 */
	static function getItemTitle($item) {
			return $item['title'];
	}

	/**
	 * Returns the Image Date Published wrapped in a paragraph.
	 * @param array $item The item array 
	 */
	static function getItemDate($item) {
		return zpFormattedDate(DATE_FORMAT, strtotime($item['pubDate']));
	}

	/**
	 * Gets the content from cache if available
	 * @return array
	 */
	static function getCache() {
		global $_zp_db;
		$cache = $_zp_db->querySingleRow('SELECT data FROM ' . $_zp_db->prefix('plugin_storage') . ' WHERE `type` = "flickrfeed" AND `aux` = "flickrfeed_cache"');
		if ($cache) {
			return unserialize($cache['data']);
		}
		return false;
	}

	/**
	 * Stores the content in cache
	 * @param array $content
	 */
	static function saveCache($content) {
		global $_zp_db;
		$hascache = flickrFeed::getCache();
		$cache = serialize($content);
		if ($hascache) {
			$sql = 'UPDATE ' . $_zp_db->prefix('plugin_storage') . ' SET `data`=' . $_zp_db->quote($cache) . ' WHERE `type`="flickrfeed" AND `aux` = "flickrfeed_cache"';
		} else {
			$sql = 'INSERT INTO ' . $_zp_db->prefix('plugin_storage') . ' (`type`,`aux`,`data`) VALUES ("flickrfeed", "flickrfeed_cache",' . $_zp_db->quote($cache) . ')';
		}
		$_zp_db->query($sql);
	}

	/**
	 * Returns the time of the last caching
	 * @return int
	 */
	static function getLastMod() {
		global $_zp_db;
		$lastmod = $_zp_db->querySingleRow('SELECT data FROM ' . $_zp_db->prefix('plugin_storage') . ' WHERE `type`="flickrfeed" AND `aux` = "flickrfeed_lastmod"');
		if ($lastmod) {
			return $lastmod['data'];
		}
		return false;
	}

	/**
	 * Sets the last modification time
	 * 
	 * @param int $lastmod Time (time()) of the last caching
	 */
	static function saveLastmod() { 
		global $_zp_db;
		$haslastmod = flickrFeed::getLastMod();
		$lastmod = time();
		if($haslastmod) {
			$sql = 'UPDATE ' . $_zp_db->prefix('plugin_storage') . ' SET `data` = ' . $lastmod . ' WHERE `type`="flickrfeed" AND `aux` = "flickrfeed_lastmod"';
		} else {
			$sql = 'INSERT INTO ' . $_zp_db->prefix('plugin_storage') . ' (`type`,`aux`,`data`) VALUES ("flickrfeed", "flickrfeed_lastmod",' . $lastmod . ')';
		}
		$_zp_db->query($sql);
	}

}