FeedAnnotation.php

<?php
/**
 * Piwik - Open source web analytics
 *
 * @link http://github.com/halfdan/piwik-feedannotation-plugin
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 * @category Piwik_Plugins
 * @package Piwik_FeedAnnotation
 */
namespace Piwik\Plugins\FeedAnnotation;
use Piwik\Common;
use Piwik\Piwik;
use Piwik\Plugin;

/**
 *
 * @package Piwik_FeedAnnotation
 */
class FeedAnnotation extends Plugin
{
	/**
	 * Create required FeedAnnotation database table
	 *
	 * @throws \Exception
	 */
	public function install() {
		$tableFeedAnnotation = "CREATE TABLE " . Common::prefixTable("feedannotation") . " (
			idfeed INT NOT NULL AUTO_INCREMENT,
			idsite INT(11) NOT NULL,
			feed_url VARCHAR(200) NOT NULL,
			last_processed DATETIME,
			PRIMARY KEY (idfeed)
		) DEFAULT CHARSET=utf8;";

		try {

			\Piwik\Db::Exec($tableFeedAnnotation);
		} catch (\Exception $e) {
			// mysql code error 1050:table already exists
			// see bug #153 http://dev.piwik.org/trac/ticket/153
			if (!\Zend_Registry::get('db')->isErrNo($e, '1050')) {
				throw $e;
			}
		}
	}

	/**
	 * Return the registered hooks
	 *
	 * @return array
	 */
	public function getListHooksRegistered()
	{
		return array(
			'Menu.Admin.addItems' => 'addAdminMenu',
			'TaskScheduler.getScheduledTasks' => 'getScheduledTasks',
			'AssetManager.getJavaScriptFiles' => 'getJsFiles'
		);
	}

	/**
	 * Add new "Feed Annotations" admin menu.
	 */
	public function addAdminMenu() {
		Piwik_AddAdminSubMenu('General_Settings', 'FeedAnnotation_MenuGeneralSettings',
			array('module' => 'FeedAnnotation', 'action' => 'index'),
			Piwik::isUserHasSomeAdminAccess(),
			$order = 10);
	}

    /**
     * Add feedannotation.js
     * for the AssetManager.
     */
    public function getJsFiles(&$jsFiles)
    {
        $jsFiles[] = "plugins/FeedAnnotation/templates/feedannotation.js";
    }

	/**
	 * Gets all scheduled tasks executed by this plugin.
	 *
	 * @param \EventNotification $notification  notification object
	 */
	public function getScheduledTasks($notification)
	{
		$tasks = &$notification->getNotificationObject();

		$updateFeedAnnotationsTask = new \Piwik\ScheduledTask(
			$this,
			'updateFeedAnnotations',
			null,
			new \Piwik\ScheduledTime\Daily()
		);
		$tasks[] = $updateFeedAnnotationsTask;
	}

	/**
	 * Fetches configured feeds and creates/updates Annotations.
	 */
	public function updateFeedAnnotations() {
		$feeds = API::getInstance()->getFeeds();

		foreach($feeds as $feed) {
			$processor = new FeedProcessor($feed);
			try {
				$processor->processFeed();
			} catch (\Zend_Feed_Exception $ex) {
				\Piwik\Registry::get('logger_exception')->logEvent( $ex );
			}
		}
	}
}