IPv6Usage.php

<?php
/**
 * Piwik - Open source web analytics
 *
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 * @category Piwik_Plugins
 * @package Piwik_IPv6Usage
 */
namespace Piwik\Plugins\IPv6Usage;

use Piwik\Piwik;
use Piwik\Menu\MenuMain;
use Piwik\WidgetsList;

/**
 *
 * @package Piwik_IPv6Usage
 */
class IPv6Usage extends \Piwik\Plugin
{

    public function getListHooksRegistered()
    {
        return array(
            'Tracker.newVisitorInformation' => 'logIPv6Info'
        );
    }

    public function install()
    {
        // add column location_ip_protocol in the visit table
        $query = "ALTER IGNORE TABLE `" . \Piwik\Common::prefixTable('log_visit') . "` " .
            "ADD `location_ip_protocol` TINYINT( 1 ) NULL ";

        // if the column already exist do not throw error. Could be installed twice...
        try {
            \Piwik\Db::exec($query);
        } catch (\Exception $e) {
        }
    }

    /**
     * Add report metadata.
     * @param array $reports
     */
    public function getReportMetadata(&$reports)
    {
        $reports[] = array(
            'category' => Piwik::translate('General_Visitors'),
            'name' => Piwik::translate('IPv6Usage_ProtocolUsageEvolution'),
            'module' => 'IPv6Usage',
            'action' => 'get',
            'metrics' => array(
                'IPv6Usage_IPv4' => Piwik::translate('IPv6Usage_IPv4'),
                'IPv6Usage_IPv6' => Piwik::translate('IPv6Usage_IPv6'),
                'IPv6Usage_Teredo' => Piwik::translate('IPv6Usage_Teredo'),
                'IPv6Usage_Tun6to4' => Piwik::translate('IPv6Usage_Tun6to4'),
                'IPv6Usage_IPv4_rate' => Piwik::translate('IPv6Usage_IPv4_rate'),
                'IPv6Usage_IPv6_rate' => Piwik::translate('IPv6Usage_IPv6_rate'),
                'IPv6Usage_Teredo_rate' => Piwik::translate('IPv6Usage_Teredo_rate'),
                'IPv6Usage_Tun6to4_rate' => Piwik::translate('IPv6Usage_Tun6to4_rate')
            ),
            'processedMetrics' => false,
            'order' => 40
        );
    }

    public function uninstall()
    {
        $query = "ALTER TABLE `" . \Piwik\Common::prefixTable('log_visit') . "` DROP `location_ip_protocol`";
        \Piwik\Db::exec($query);
    }

    /**
     * @param array $visitorInfo
     */
    public function logIPv6Info(array &$visitorInfo)
    {
        // Fetch the users ip
        $ip = $visitorInfo['location_ip'];
        // Check the type of the IP (v4 or v6)
        $protocol = 4;
        $ip = \Piwik\Network\IP::fromBinaryIP($ip);
        if ($ip instanceof \Piwik\Network\IPv6 && !$ip->isMappedIPv4()) {
            $protocol = 6;

            #2001::/32	teredo
            $regex_teredo = '/([0-9a-f].){24}0.0.0.0.1.0.0.2.ip6.arpa$/i';

            #2002::/16	6to4
            $regex_6to4 = '/([0-9a-f].){28}2.0.0.2.ip6.arpa$/i';

            $rev_nibbles = $this->reverseIPv6Nibbles($ip);
            if (preg_match($regex_teredo, $rev_nibbles)) {
                $protocol = 101;
            } elseif (preg_match($regex_6to4, $rev_nibbles)) {
                $protocol = 102;
            }
        }
        $visitorInfo['location_ip_protocol'] = $protocol;
    }

    private function reverseIPv6Nibbles($addr)
    {
        #reverse nibbles by Alnitak on http://stackoverflow.com/questions/6619682/convert-ipv6-to-nibble-format-for-ptr-records
        $unpack = unpack('H*hex', $addr);
        $hex = $unpack['hex'];
        $arpa = implode('.', array_reverse(str_split($hex))) . '.ip6.arpa';
        return $arpa;
    }

    private function isIPv6($ip = false)
    {
        $ip = (!$ip) ? getenv("REMOTE_ADDR") : $ip;
        return filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6);
    }
}