refs #2465

 * Renaming Insight to Overlay
 * Includes a new minified piwik.js, generated as described in js/README. Please double-check whether the file is OK.
 * Servers that had the Insight plugin installed will need to delete it manually, right?

git-svn-id: http://dev.piwik.org/svn/trunk@7445 59fd770c-687e-43c8-a1e3-f5a4ff64c105

1 files changed, 129 insertions, 0 deletions

diff --git a/plugins/Overlay/API.php b/plugins/Overlay/API.php
new file mode 100644
index 0000000000..94ca119fe2
--- /dev/null
+++ b/plugins/Overlay/API.php
@@ -0,0 +1,129 @@
+<?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$
+ *
+ * @category Piwik_Plugins
+ * @package Piwik_Insight
+ */
+
+class Piwik_Insight_API
+{
+	
+	private static $instance = null;
+	
+	/**
+	 * Get Singleton instance
+	 * @return Piwik_Insight_API
+	 */
+	public static function getInstance()
+	{
+		if (self::$instance == null)
+		{
+			self::$instance = new self;
+		}
+		return self::$instance;
+	}
+	
+	/**
+	 * Get translation strings
+	 */
+	public function getTranslations($idSite)
+	{
+		$this->authenticate($idSite);
+		
+		$translations = array(
+			'oneClick' => 'Insight_OneClick',
+			'clicks' => 'Insight_Clicks',
+			'clicksFromXLinks' => 'Insight_ClicksFromXLinks',
+			'link' => 'Insight_Link'
+		);
+		
+		return array_map('Piwik_Translate', $translations);
+	}
+
+	/**
+	 * Get excluded query parameters for a site.
+	 * This information is used for client side url normalization.
+	 */
+	public function getExcludedQueryParameters($idSite)
+	{
+		$this->authenticate($idSite);
+		
+		$sitesManager = Piwik_SitesManager_API::getInstance();
+		$site = $sitesManager->getSiteFromId($idSite);
+		
+		try {
+			return Piwik_SitesManager::getTrackerExcludedQueryParameters($site);
+		} catch(Exception $e) {
+			// an exception is thrown when the user has no view access.
+			// do not throw the exception to the outside.
+			return array();
+		}
+	}
+
+	/**
+	 * Get following pages of a url.
+	 * This is done on the logs - not the archives!
+	 * 
+	 * Note: if you use this method via the regular API, the number of results will be limited.
+	 * Make sure, you set filter_limit=-1 in the request.
+	 */
+	public function getFollowingPages($url, $idSite, $period, $date, $segment = false)
+	{
+		$this->authenticate($idSite);
+		
+		$url = Piwik_Tracker_Action::excludeQueryParametersFromUrl($url, $idSite);
+		$url = Piwik_Common::unsanitizeInputValue($url);
+		
+		$resultDataTable = new Piwik_DataTable;
+		
+		try
+		{
+			$limitBeforeGrouping = Piwik_Config::getInstance()->General['insight_limit'];
+			$transitionsReport = Piwik_Transitions_API::getInstance()->getTransitionsForAction(
+					$url, $type = 'url', $idSite, $period, $date, $segment, $limitBeforeGrouping, 
+					$part = 'followingActions', $returnNormalizedUrls = true);
+		}
+		catch(Exception $e)
+		{
+			return $resultDataTable;
+		}
+		
+		$reports = array('followingPages', 'outlinks', 'downloads');
+		foreach ($reports as $reportName)
+		{
+			if (!isset($transitionsReport[$reportName]))
+			{
+				continue;
+			}
+			foreach ($transitionsReport[$reportName]->getRows() as $row)
+			{
+				// don't touch the row at all for performance reasons
+				$resultDataTable->addRow($row);
+			}
+		}
+		
+		return $resultDataTable;
+	}
+	
+	/** Do cookie authentication. This way, the token can remain secret. */
+	private function authenticate($idSite)
+	{
+		Piwik_PostEvent('FrontController.initAuthenticationObject', $notification = null,
+				$allowCookieAuthentication = true);
+				
+		$auth = Zend_Registry::get('auth');
+		$success = Zend_Registry::get('access')->reloadAccess($auth);
+		
+		if (!$success) {
+			throw new Exception('Authentication failed');
+		}
+		
+		Piwik::checkUserHasViewAccess($idSite);
+	}
+
+}