Ticket #42: BlockingCookie.php

<?php
/**
 * Piwik - Open source web analytics
 * 
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
 * @version $Id: BlockingCookie.php 9 2009-05-17 19:19:21Z pat $
 * 
 * @package Piwik_BlockingCookie
 */
defined('PIWIK_INCLUDE_PATH') or die('Restricted access');

class Piwik_BlockingCookie extends Piwik_Plugin
{
    
    private $cookieName = 'piwik_exclude';
    
    public function getInformation ()
    {
        return array(
            'name' => 'BlockingCookie',
            'description' => 'This plugin allows to exclude users from tracking by setting a cookie.',
            'author' => 'black silence',
            'homepage' => 'http://www.psycho3d.de/',
            'version' => '0.2',
            'TrackerPlugin' => true,
        );
    }
    
    /**
     * register hooks
     */
    function getListHooksRegistered () {
        return array(
            'Tracker.Visit.isExcluded' => 'isVisitorExcluded',
            'WidgetsList.add' => 'addWidget',
        );
    }
    
    
    public function isVisitorExcluded ($notification) {
        # idsite, NOT idSite
        $idSite = Piwik_Common::getRequestVar('idsite', 1, 'integer');
        #printDebug($idSite);
        
        $excludeCookie = new Piwik_Cookie($this->cookieName);
        if ($excludeCookie->isCookieFound()) {
            # get reference to the value we need to change
            $excluded =& $notification->getNotificationObject();    
            $excluded = $excludeCookie->get($idSite);
        }
    }
    
    
    public function addWidget ()
    {
        Piwik_AddWidget('Special', 'Blocking Cookie', 'BlockingCookie', 'showWidget');
    }
    
}

class Piwik_BlockingCookie_Controller extends Piwik_Controller
{
    private $cookieName = 'piwik_exclude';
    
    public function showWidget () {
        $idSite = Piwik_Common::getRequestVar('idSite', 1, 'integer');
        
        # check if the current user is excluded
        $excludeCookie = new Piwik_Cookie($this->cookieName);
        $excluded = (bool)$excludeCookie->get($idSite);
        
        # prepare params for the link
        $params = array(
            'module=BlockingCookie',
            'action=setTracking',
            'idSite=' . $idSite,
            'exclude=' . (int)(!$excluded)
        );
        # needed for redirecting after changing the exclude state
        $period = Piwik_Common::getRequestVar('period', 0);
        if ($period) $params[] = 'period=' . $period;
        $date = Piwik_Common::getRequestVar('date', 0);
        if ($date) $params[] = 'date=' . $date;
        
        # get the link and text
        $link = 'index.php?' . implode('&', $params);
        
        if ($excluded) {
            $result = 'You will not be tracked.<br/><a href="' . $link . '">Start tracking me!</a>';
        } else {
            $result = 'You will be tracked.<br/><a href="' . $link . '">Stop tracking me!</a>';
        }
        
        echo '<div id="blockingcookie">' . $result . '</div>';
    }
    
    
    /**
     * set the tracking cookie as the user requests, then redirect back to dashboard
     */
    public function setTracking () {
        $idSite = Piwik_Common::getRequestVar('idSite', 1, 'integer');
        $exclude = Piwik_Common::getRequestVar('exclude', 0, 'integer');
        
        # store the value in the cookie
        $excludeCookie = new Piwik_Cookie($this->cookieName);
        $excludeCookie->set($idSite, $exclude);
        
        # check if we can delete the cookie because there are no sites to exclude from tracking
        # I don't use the SitesManager API because the user doesn't need to be superadmin in my case
        $canDeleteCookie = true;
        $siteids = Zend_Registry::get('db')->fetchAll('SELECT idsite FROM ' . Piwik::prefixTable('site'));
        foreach ($siteids as $siteid) {
            if ($excludeCookie->get($siteid['idsite'])) {
                # don't delete cookie if at least one of the sites is excluded from tracking
                $canDeleteCookie = false;
                break;
            }
        }
        # now save the cookie
        if ($canDeleteCookie) {
            $excludeCookie->delete();
        } else {
            $excludeCookie->save();
        }
        
        # build parameters for redirecting back to dashboard
        $params = array(
            'module=CoreHome',
            'action=index',
            'idSite=' . $idSite
        );
        $period = Piwik_Common::getRequestVar('period', 0);
        if ($period) $params[] = 'period=' . $period;
        $date = Piwik_Common::getRequestVar('date', 0);
        if ($date) $params[] = 'date=' . $date;
        
        # send the user back to the dashboard
        Piwik_Url::redirectToUrl('index.php?' . implode('&', $params));
    }

}