restructure application classes
This commit is contained in:
coderkun
commit
a6d9bf653a
3220 changed files with 597952 additions and 0 deletions
8
www/.htaccess
Normal file
8
www/.htaccess
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<IfModule mod_rewrite.c>
|
||||
RewriteEngine On
|
||||
|
||||
RewriteBase /
|
||||
RewriteCond %{REQUEST_FILENAME} !-d
|
||||
RewriteCond %{REQUEST_FILENAME} !-f
|
||||
RewriteRule ^(.*)$ index.php?url=$1 [QSA,L,NE]
|
||||
</IfModule>
|
||||
265
www/analytics/LEGALNOTICE
Normal file
265
www/analytics/LEGALNOTICE
Normal file
|
|
@ -0,0 +1,265 @@
|
|||
COPYRIGHT
|
||||
|
||||
Piwik - Open Source Web Analytics
|
||||
|
||||
The software package is:
|
||||
|
||||
Copyright (C) 2013 Matthieu Aubry
|
||||
|
||||
Individual contributions, components, and libraries are copyright
|
||||
of their respective authors.
|
||||
|
||||
|
||||
SOFTWARE LICENSE
|
||||
|
||||
The free software license of Piwik is GNU General Public License v3
|
||||
or later. A copy of GNU GPL v3 should have been included in this
|
||||
software package in misc/gpl-3.0.txt.
|
||||
|
||||
|
||||
TRADEMARK
|
||||
|
||||
Piwik (TM) is an internationally registered trademark.
|
||||
|
||||
The software license does not grant any rights under trademark
|
||||
law for use of the trademark. Refer to http://piwik.org/trademark/
|
||||
for up-to-date trademark licensing information.
|
||||
|
||||
*
|
||||
* The software license applies to both the aggregate software and
|
||||
* application-specific portions of the software.
|
||||
*
|
||||
* You may not remove this legal notice or modify the software
|
||||
* in such a way that misrepresents the origin of the software.
|
||||
*
|
||||
|
||||
CREDITS
|
||||
|
||||
The software consists of contributions made by many individuals.
|
||||
Major contributors are listed in http://piwik.org/the-piwik-team/.
|
||||
|
||||
For detailed contribution history, refer to the source, tickets,
|
||||
patches, and Git revision history, available at
|
||||
http://dev.piwik.org/trac/
|
||||
https://github.com/piwik/piwik
|
||||
|
||||
|
||||
SEPARATELY LICENSED COMPONENTS AND LIBRARIES
|
||||
|
||||
The following components/libraries are distributed in this package,
|
||||
and subject to their respective licenses.
|
||||
|
||||
Name: javascriptCode.tpl - tracking tag to embed in your web pages
|
||||
Link: https://github.com/piwik/piwik/blob/master/core/Tracker/javascriptTag.tpl
|
||||
License: Public Domain
|
||||
|
||||
Name: jquery.truncate
|
||||
Link: https://github.com/piwik/piwik/blob/master/libs/jquery/truncate/
|
||||
License: New BSD
|
||||
|
||||
Name: piwik.js - JavaScript tracker
|
||||
Link: https://github.com/piwik/piwik/blob/master/js/piwik.js
|
||||
License: New BSD
|
||||
|
||||
Name: PiwikTracker - server-side tracker (PHP)
|
||||
Link: https://github.com/piwik/piwik/blob/master/libs/PiwikTracker/
|
||||
License: New BSD
|
||||
|
||||
Name: UserAgentParser
|
||||
Link: https://github.com/piwik/piwik/blob/master/libs/UserAgentParser/
|
||||
License: New BSD
|
||||
|
||||
|
||||
THIRD-PARTY COMPONENTS AND LIBRARIES
|
||||
|
||||
The following components/libraries are redistributed in this package,
|
||||
and subject to their respective licenses.
|
||||
|
||||
Name: jqPlot
|
||||
Link: http://www.jqplot.com/
|
||||
License: Dual-licensed: MIT or GPL v2
|
||||
|
||||
Name: jQuery
|
||||
Link: http://jquery.com/
|
||||
License: Dual-licensed: MIT or GPL
|
||||
Notes:
|
||||
- GPL version not explicitly stated in source but GPL v2 is in git
|
||||
- includes Sizzle.js - multi-licensed: MIT, New BSD, or GPL [v2]
|
||||
|
||||
Name: jQuery UI
|
||||
Link: http://jqueryui.com/
|
||||
License: Dual-licensed: MIT or GPL
|
||||
Notes:
|
||||
- GPL version not explicitly stated in source but GPL v2 is in git
|
||||
|
||||
Name: jquery.history
|
||||
Link: http://tkyk.github.com/jquery-history-plugin/
|
||||
License: MIT
|
||||
|
||||
Name: jquery.scrollTo
|
||||
Link: http://plugins.jquery.com/project/ScrollTo
|
||||
License: Dual licensed: MIT or GPL
|
||||
|
||||
Name: jquery Tooltip
|
||||
Link: http://bassistance.de/jquery-plugins/jquery-plugin-tooltip/
|
||||
License: Dual licensed: MIT or GPL
|
||||
|
||||
Name: jquery placeholder
|
||||
Link: http://mths.be/placeholder
|
||||
License: Dual licensed: MIT or GPL
|
||||
|
||||
Name: jquery smartbanner
|
||||
Link: https://github.com/jasny/jquery.smartbanner
|
||||
License: Dual licensed: MIT
|
||||
|
||||
Name: json2.js
|
||||
Link: http://json.org/
|
||||
License: Public domain
|
||||
Notes:
|
||||
- reference implementation
|
||||
|
||||
Name: jshrink
|
||||
Link: https://github.com/tedivm/jshrink
|
||||
License: BSD-3-Clause
|
||||
|
||||
Name: sparkline
|
||||
Link: https//sourceforge.net/projects/sparkline/
|
||||
License: Dual-licensed: New BSD or GPL v2
|
||||
|
||||
Name: sprintf
|
||||
Link: http://www.diveintojavascript.com/projects/javascript-sprintf
|
||||
License: New BSD
|
||||
|
||||
Name: upgrade.php
|
||||
Link: http://upgradephp.berlios.de/
|
||||
License: Public domain
|
||||
|
||||
Name: Archive Tar
|
||||
Link: http://pear.php.net/package/Archive_Tar
|
||||
License: New BSD
|
||||
|
||||
Name: Event Dispatcher (and Notification)
|
||||
Link: http://pear.php.net/package/Event_Dispatcher/
|
||||
License: New BSD
|
||||
|
||||
Name: HTML Common2
|
||||
Link: http://pear.php.net/package/HTML_Common2/
|
||||
License: New BSD
|
||||
|
||||
Name: HTML QuickForm2
|
||||
Link: http://pear.php.net/package/HTML_QuickForm2/
|
||||
License: New BSD
|
||||
|
||||
Name: HTML QuickForm2_Renderer_Smarty
|
||||
Link: http://www.phcomp.co.uk/tmp/Smarty.phps
|
||||
License: New BSD
|
||||
|
||||
Name: MaxMindGeoIP
|
||||
Link: http://dev.maxmind.com/geoip/downloadable#PHP-7
|
||||
License: LGPL
|
||||
|
||||
Name: PclZip
|
||||
Link: http://www.phpconcept.net/pclzip/
|
||||
License: LGPL
|
||||
Notes:
|
||||
- GPL version not explicitly stated but tarball contains LGPL v2.1
|
||||
|
||||
Name: PEAR (base system)
|
||||
Link: http://pear.php.net/package/PEAR
|
||||
License: New BSD
|
||||
|
||||
Name: PhpSecInfo
|
||||
Link: http://phpsec.org/projects/phpsecinfo/
|
||||
License: New BSD
|
||||
|
||||
Name: RankChecker
|
||||
Link: http://www.getrank.org/free-pagerank-script
|
||||
License: GPL
|
||||
|
||||
Name: Twig
|
||||
Link: http://twig.sensiolabs.org/
|
||||
License: BSD
|
||||
|
||||
Name: TCPDF
|
||||
Link: http://sourceforge.net/projects/tcpdf
|
||||
License: LGPL v3 or later
|
||||
|
||||
Name: Zend Framework
|
||||
Link: http://www.zendframework.com/
|
||||
License: New BSD
|
||||
|
||||
Name: pChart 2.1.3
|
||||
Link: http://www.pchart.net
|
||||
License: GPL v3
|
||||
|
||||
Name: Chroma.js
|
||||
Link: https://github.com/gka/chroma.js
|
||||
License: GPL v3
|
||||
|
||||
Name: qTip2 - Pretty powerful tooltips
|
||||
Link: http://craigsworks.com/projects/qtip2/
|
||||
License: GPL
|
||||
|
||||
Name: Kartograph.js
|
||||
Link: http://kartograph.org/
|
||||
License: LGPL v3 or later
|
||||
|
||||
Name: Raphaël - JavaScript Vector Library
|
||||
Link: http://raphaeljs.com/
|
||||
License: MIT
|
||||
|
||||
Name: lessphp
|
||||
Link: http://leafo.net/lessphp
|
||||
License: GPL3/MIT
|
||||
|
||||
Name: Symfony Console Component
|
||||
Link: https://github.com/symfony/Console
|
||||
License: MIT
|
||||
|
||||
|
||||
THIRD-PARTY CONTENT
|
||||
|
||||
Name: FamFamFam icons - Mark James
|
||||
Link: http://www.famfamfam.com/lab/icons/
|
||||
License: CC BY 3.0
|
||||
|
||||
Name: Solar System icons - Dan Wiersema
|
||||
Link: http://www.iconspedia.com/icon/neptune-4672.html
|
||||
License: Free for non-commercial use
|
||||
Notes:
|
||||
- used in Piwik's ExampleUI plugin
|
||||
|
||||
Name: Wine project - tahoma.ttf font
|
||||
Link: http://source.winehq.org/git/wine.git/blob_plain/HEAD:/fonts/tahoma.ttf
|
||||
License: LGPL v2.1
|
||||
Notes:
|
||||
- used in ImageGraph plugin
|
||||
|
||||
Name: plugins/CorePluginsAdmin/images/themes.png
|
||||
Link: https://www.iconfinder.com/icons/17022/colors_draw_paint_icon
|
||||
License: Free for commercial use
|
||||
|
||||
Name: plugins/Feedback/angularjs/ratefeature/thumbs-down.png
|
||||
Link: https://www.iconfinder.com/icons/216428/down_thumbs_icon
|
||||
License: Creative Commons (Attribution-Share Alike 3.0 Unported)
|
||||
|
||||
Name: plugins/Feedback/angularjs/ratefeature/thumbs-up.png
|
||||
Link: https://www.iconfinder.com/icons/216429/thumbs_up_icon
|
||||
License: Creative Commons (Attribution-Share Alike 3.0 Unported)
|
||||
|
||||
Name: plugins/CorePluginsAdmin/images/plugins.png
|
||||
Link: http://findicons.com/icon/94051/tools_wizard?id=396912
|
||||
License: GNU/GPL
|
||||
|
||||
Name: plugins/Insights/images/idea.png
|
||||
Link: https://www.iconfinder.com/icons/6074/brainstorm_bulb_idea_jabber_light_icon
|
||||
License: GPL
|
||||
By: Alessandro Rei - http://www.kde-look.org/usermanager/search.php?username=mentalrey
|
||||
|
||||
Notes:
|
||||
- the "New BSD" license refers to either the "Modified BSD" and "Simplified BSD"
|
||||
licenses (2- or 3-clause), which are GPL compatible.
|
||||
- the "MIT" license is also referred to as the "X11" license
|
||||
- icons for browsers, operating systems, browser plugins, search engines, and
|
||||
and flags of countries are nominative use of third-party trademarks when
|
||||
referring to the corresponding product or entity
|
||||
92
www/analytics/README.md
Normal file
92
www/analytics/README.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# Piwik - piwik.org
|
||||
|
||||
## Description
|
||||
|
||||
Piwik is the leading Free/Libre open source Web Analytics platform.
|
||||
|
||||
Piwik is a full featured PHP MySQL software program that you download and install on your own webserver.
|
||||
At the end of the five minute installation process you will be given a JavaScript code.
|
||||
Simply copy and paste this tag on websites you wish to track and access your analytics reports in real time.
|
||||
|
||||
Piwik aims to be a Free software alternative to Google Analytics, and is already used on more than 1,000,000 websites.
|
||||
|
||||
## Mission Statement
|
||||
|
||||
> « To create, as a community, the leading international Free/Libre web analytics platform, providing access to all functionality through open components and open APIs. »
|
||||
|
||||
Or in short:
|
||||
> « Liberate Web Analytics »
|
||||
|
||||
## License
|
||||
|
||||
Piwik is released under the GPL v3 (or later) license, see [misc/gpl-3.0.txt](misc/gpl-3.0.txt)
|
||||
|
||||
## Requirements
|
||||
|
||||
* PHP 5.3.2 or greater
|
||||
* MySQL 4.1 or greater, and either MySQLi or PDO library must be enabled
|
||||
* Piwik is OS / server independent
|
||||
|
||||
See http://piwik.org/docs/requirements/
|
||||
|
||||
## Install
|
||||
|
||||
* Upload piwik to your webserver
|
||||
* Point your browser to the directory
|
||||
* Follow the steps
|
||||
* Add the given javascript code to your pages
|
||||
* (You may also generate fake data to experiment, by enabling the plugin VisitorGenerator)
|
||||
|
||||
See http://piwik.org/docs/installation/
|
||||
|
||||
If you do not have a server, consider our Piwik Hosting partner: http://piwik.org/hosting/
|
||||
|
||||
## Changelog
|
||||
|
||||
For the list of all tickets closed in the current and past releases, see http://piwik.org/changelog/
|
||||
|
||||
## Participate!
|
||||
|
||||
We believe in liberating Web Analytics, providing a free platform for simple and advanced analytics. Piwik was built by dozens of people like you,
|
||||
and we need your help to make Piwik better… Why not participate in a useful project today?
|
||||
|
||||
You will find pointers on how you can participate in Piwik at http://piwik.org/get-involved/
|
||||
|
||||
## Contact
|
||||
|
||||
http://piwik.org
|
||||
|
||||
hello@piwik.org
|
||||
|
||||
About us: http://piwik.org/the-piwik-team/
|
||||
|
||||
## More information
|
||||
|
||||
What makes Piwik unique from the competition:
|
||||
|
||||
* Real time web analytics reports: in Piwik, reports are by default generated in real time.
|
||||
For high traffic websites, you can choose the frequency for reports to be processed.
|
||||
|
||||
* You own your web analytics data: since Piwik is installed on your server, the data is stored in your own database and you can get all the statistics
|
||||
using the powerful Piwik Analytics API.
|
||||
|
||||
* Piwik is a Free Software which can easily be configured to respect your visitors privacy.
|
||||
|
||||
* Modern, easy to use User Interface: you can fully customize your dashboard, drag and drop widgets and more.
|
||||
|
||||
* Piwik features are built inside plugins: you can add new features and remove the ones you don’t need.
|
||||
You can build your own web analytics plugins or hire a consultant to have your custom feature built in Piwik
|
||||
|
||||
* Vibrant international Open community of more than 200,000 active users (tracking even more websites!)
|
||||
|
||||
* Advanced Web Analytics capabilities such as Ecommerce Tracking, Goal tracking, Campaign tracking,
|
||||
Custom Variables, Email Reports, Custom Segment Editor, Geo Location, Real time maps, and more!
|
||||
|
||||
Documentation and more info on http://piwik.org
|
||||
|
||||
## Code Status
|
||||
The Piwik project uses an ever-expanding comprehensive set of thousands of unit tests and dozens of integration [tests](https://github.com/piwik/piwik/tree/master/tests),
|
||||
running on the hosted distributed continuous integration platform Travis-CI.
|
||||
|
||||
Build status (master branch) [](https://travis-ci.org/piwik/piwik) - Screenshot tests Build [](https://travis-ci.org/piwik/piwik-ui-tests)
|
||||
|
||||
30
www/analytics/composer.json
Normal file
30
www/analytics/composer.json
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
{
|
||||
"name": "piwik/piwik",
|
||||
"type": "application",
|
||||
"description": "Open Source Real Time Web Analytics Platform",
|
||||
"keywords": ["piwik","web","analytics"],
|
||||
"homepage": "http://piwik.org",
|
||||
"license": "GPL-3.0+",
|
||||
"authors": [
|
||||
{
|
||||
"name": "The Piwik Team",
|
||||
"email": "hello@piwik.org",
|
||||
"homepage": "http://piwik.org/the-piwik-team/"
|
||||
}
|
||||
],
|
||||
"support": {
|
||||
"forum": "http://forum.piwik.org/",
|
||||
"issues": "http://dev.piwik.org/trac/roadmap",
|
||||
"wiki": "http://dev.piwik.org/",
|
||||
"source": "https://github.com/piwik/piwik"
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.2",
|
||||
"twig/twig": "1.*",
|
||||
"leafo/lessphp": "~0.3",
|
||||
"symfony/console": ">=v2.3.5",
|
||||
"tedivm/jshrink": "v0.5.1",
|
||||
"mustangostang/spyc": "0.5.*",
|
||||
"piwik/device-detector": "*"
|
||||
}
|
||||
}
|
||||
310
www/analytics/composer.lock
generated
Normal file
310
www/analytics/composer.lock
generated
Normal file
|
|
@ -0,0 +1,310 @@
|
|||
{
|
||||
"_readme": [
|
||||
"This file locks the dependencies of your project to a known state",
|
||||
"Read more about it at http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file"
|
||||
],
|
||||
"hash": "69246584e6b57bfbc8d39799cd3b9213",
|
||||
"packages": [
|
||||
{
|
||||
"name": "leafo/lessphp",
|
||||
"version": "v0.4.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/leafo/lessphp.git",
|
||||
"reference": "51f3f06f0fe78a722dabfd14578444bdd078d9de"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/leafo/lessphp/zipball/51f3f06f0fe78a722dabfd14578444bdd078d9de",
|
||||
"reference": "51f3f06f0fe78a722dabfd14578444bdd078d9de",
|
||||
"shasum": ""
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "0.3-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"classmap": [
|
||||
"lessc.inc.php"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT",
|
||||
"GPL-3.0"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Leaf Corcoran",
|
||||
"email": "leafot@gmail.com",
|
||||
"homepage": "http://leafo.net"
|
||||
}
|
||||
],
|
||||
"description": "lessphp is a compiler for LESS written in PHP.",
|
||||
"homepage": "http://leafo.net/lessphp/",
|
||||
"time": "2013-08-09 17:09:19"
|
||||
},
|
||||
{
|
||||
"name": "mustangostang/spyc",
|
||||
"version": "0.5.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/mustangostang/spyc.git",
|
||||
"reference": "dc4785b4d7227fd9905e086d499fb8abfadf9977"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/mustangostang/spyc/zipball/dc4785b4d7227fd9905e086d499fb8abfadf9977",
|
||||
"reference": "dc4785b4d7227fd9905e086d499fb8abfadf9977",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.1"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "0.5.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"files": [
|
||||
"Spyc.php"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT License"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "mustangostang",
|
||||
"email": "vlad.andersen@gmail.com"
|
||||
}
|
||||
],
|
||||
"description": "A simple YAML loader/dumper class for PHP",
|
||||
"homepage": "https://github.com/mustangostang/spyc/",
|
||||
"keywords": [
|
||||
"spyc",
|
||||
"yaml",
|
||||
"yml"
|
||||
],
|
||||
"time": "2013-02-21 10:52:01"
|
||||
},
|
||||
{
|
||||
"name": "piwik/device-detector",
|
||||
"version": "1.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/piwik/device-detector.git",
|
||||
"reference": "ea7c5d8b76def0d8345a4eba59c5f98ec0109de6"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/piwik/device-detector/zipball/ea7c5d8b76def0d8345a4eba59c5f98ec0109de6",
|
||||
"reference": "ea7c5d8b76def0d8345a4eba59c5f98ec0109de6",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"mustangostang/spyc": "*",
|
||||
"php": ">=5.3.1"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"files": [
|
||||
"DeviceDetector.php"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"GPL-3.0+"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "The Piwik Team",
|
||||
"email": "hello@piwik.org",
|
||||
"homepage": "http://piwik.org/the-piwik-team/"
|
||||
}
|
||||
],
|
||||
"description": "The Universal Device Detection library, that parses User Agents and detects devices (desktop, tablet, mobile, tv, cars, console, etc.), and detects browsers, operating systems, devices, brands and models.",
|
||||
"homepage": "http://piwik.org",
|
||||
"keywords": [
|
||||
"devicedetection",
|
||||
"parser",
|
||||
"useragent"
|
||||
],
|
||||
"time": "2014-04-03 08:59:48"
|
||||
},
|
||||
{
|
||||
"name": "symfony/console",
|
||||
"version": "v2.4.3",
|
||||
"target-dir": "Symfony/Component/Console",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/Console.git",
|
||||
"reference": "ef20f1f58d7f693ee888353962bd2db336e3bbcb"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/Console/zipball/ef20f1f58d7f693ee888353962bd2db336e3bbcb",
|
||||
"reference": "ef20f1f58d7f693ee888353962bd2db336e3bbcb",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.3"
|
||||
},
|
||||
"require-dev": {
|
||||
"symfony/event-dispatcher": "~2.1"
|
||||
},
|
||||
"suggest": {
|
||||
"symfony/event-dispatcher": ""
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.4-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"Symfony\\Component\\Console\\": ""
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Fabien Potencier",
|
||||
"email": "fabien@symfony.com",
|
||||
"homepage": "http://fabien.potencier.org",
|
||||
"role": "Lead Developer"
|
||||
},
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "http://symfony.com/contributors"
|
||||
}
|
||||
],
|
||||
"description": "Symfony Console Component",
|
||||
"homepage": "http://symfony.com",
|
||||
"time": "2014-03-01 17:35:04"
|
||||
},
|
||||
{
|
||||
"name": "tedivm/jshrink",
|
||||
"version": "v0.5.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/tedivm/JShrink.git",
|
||||
"reference": "2d3f1a7d336ad54bdf2180732b806c768a791cbf"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/tedivm/JShrink/zipball/2d3f1a7d336ad54bdf2180732b806c768a791cbf",
|
||||
"reference": "2d3f1a7d336ad54bdf2180732b806c768a791cbf",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.0"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"JShrink": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"BSD-3-Clause"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Robert Hafner",
|
||||
"email": "tedivm@tedivm.com"
|
||||
}
|
||||
],
|
||||
"description": "Javascript Minifier built in PHP",
|
||||
"homepage": "http://github.com/tedivm/JShrink",
|
||||
"keywords": [
|
||||
"javascript",
|
||||
"minifier"
|
||||
],
|
||||
"time": "2012-11-26 04:48:55"
|
||||
},
|
||||
{
|
||||
"name": "twig/twig",
|
||||
"version": "v1.15.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/fabpot/Twig.git",
|
||||
"reference": "1fb5784662f438d7d96a541e305e28b812e2eeed"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/fabpot/Twig/zipball/1fb5784662f438d7d96a541e305e28b812e2eeed",
|
||||
"reference": "1fb5784662f438d7d96a541e305e28b812e2eeed",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.2.4"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.15-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"Twig_": "lib/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"BSD-3-Clause"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Fabien Potencier",
|
||||
"email": "fabien@symfony.com",
|
||||
"homepage": "http://fabien.potencier.org",
|
||||
"role": "Lead Developer"
|
||||
},
|
||||
{
|
||||
"name": "Armin Ronacher",
|
||||
"email": "armin.ronacher@active-4.com",
|
||||
"role": "Project Founder"
|
||||
},
|
||||
{
|
||||
"name": "Twig Team",
|
||||
"homepage": "https://github.com/fabpot/Twig/graphs/contributors",
|
||||
"role": "Contributors"
|
||||
}
|
||||
],
|
||||
"description": "Twig, the flexible, fast, and secure template language for PHP",
|
||||
"homepage": "http://twig.sensiolabs.org",
|
||||
"keywords": [
|
||||
"templating"
|
||||
],
|
||||
"time": "2014-02-13 10:19:29"
|
||||
}
|
||||
],
|
||||
"packages-dev": [
|
||||
|
||||
],
|
||||
"aliases": [
|
||||
|
||||
],
|
||||
"minimum-stability": "stable",
|
||||
"stability-flags": [
|
||||
|
||||
],
|
||||
"platform": {
|
||||
"php": ">=5.3.2"
|
||||
},
|
||||
"platform-dev": [
|
||||
|
||||
]
|
||||
}
|
||||
13
www/analytics/config/.htaccess
Normal file
13
www/analytics/config/.htaccess
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<Files "*">
|
||||
<IfModule mod_access.c>
|
||||
Deny from all
|
||||
</IfModule>
|
||||
<IfModule !mod_access_compat>
|
||||
<IfModule mod_authz_host.c>
|
||||
Deny from all
|
||||
</IfModule>
|
||||
</IfModule>
|
||||
<IfModule mod_access_compat>
|
||||
Deny from all
|
||||
</IfModule>
|
||||
</Files>
|
||||
627
www/analytics/config/global.ini.php
Normal file
627
www/analytics/config/global.ini.php
Normal file
|
|
@ -0,0 +1,627 @@
|
|||
; <?php exit; ?> DO NOT REMOVE THIS LINE
|
||||
; If you want to change some of these default values, the best practise is to override
|
||||
; them in your configuration file in config/config.ini.php. If you directly edit this file,
|
||||
; you will lose your changes when you upgrade Piwik.
|
||||
; For example if you want to override action_title_category_delimiter,
|
||||
; edit config/config.ini.php and add the following:
|
||||
; [General]
|
||||
; action_title_category_delimiter = "-"
|
||||
|
||||
;--------
|
||||
; WARNING - YOU SHOULD NOT EDIT THIS FILE DIRECTLY - Edit config.ini.php instead.
|
||||
;--------
|
||||
|
||||
[database]
|
||||
host =
|
||||
username =
|
||||
password =
|
||||
dbname =
|
||||
tables_prefix =
|
||||
port = 3306
|
||||
adapter = PDO_MYSQL
|
||||
type = InnoDB
|
||||
schema = Mysql
|
||||
|
||||
; if charset is set to utf8, Piwik will ensure that it is storing its data using UTF8 charset.
|
||||
; it will add a sql query SET at each page view.
|
||||
; Piwik should work correctly without this setting.
|
||||
;charset = utf8
|
||||
|
||||
[database_tests]
|
||||
host = localhost
|
||||
username = root
|
||||
password =
|
||||
dbname = piwik_tests
|
||||
tables_prefix = piwiktests_
|
||||
port = 3306
|
||||
adapter = PDO_MYSQL
|
||||
type = InnoDB
|
||||
schema = Mysql
|
||||
|
||||
[log]
|
||||
; possible values for log: screen, database, file
|
||||
log_writers[] = screen
|
||||
|
||||
; log level, everything logged w/ this level or one of greater severity
|
||||
; will be logged. everything else will be ignored. possible values are:
|
||||
; NONE, ERROR, WARN, INFO, DEBUG, VERBOSE
|
||||
log_level = WARN
|
||||
|
||||
; if set to 1, only requests done in CLI mode (eg. the archive.php cron run) will be logged
|
||||
; NOTE: log_only_when_debug_parameter will also be checked for
|
||||
log_only_when_cli = 0
|
||||
|
||||
; if set to 1, only requests with "&debug" parameter will be logged
|
||||
; NOTE: log_only_when_cli will also be checked for
|
||||
log_only_when_debug_parameter = 0
|
||||
|
||||
; if configured to log in a file, log entries will be made to this file
|
||||
logger_file_path = tmp/logs/piwik.log
|
||||
|
||||
|
||||
[Debug]
|
||||
; if set to 1, the archiving process will always be triggered, even if the archive has already been computed
|
||||
; this is useful when making changes to the archiving code so we can force the archiving process
|
||||
always_archive_data_period = 0;
|
||||
always_archive_data_day = 0;
|
||||
; Force archiving Custom date range (without re-archiving sub-periods used to process this date range)
|
||||
always_archive_data_range = 0;
|
||||
|
||||
; if set to 1, all the SQL queries will be recorded by the profiler
|
||||
; and a profiling summary will be printed at the end of the request
|
||||
; NOTE: you must also set [log] log_writers[] = "screen" to enable the profiler to print on screen
|
||||
enable_sql_profiler = 0
|
||||
|
||||
; if set to 1, a Piwik tracking code will be included in the Piwik UI footer and will track visits, pages, etc. to idsite = 1
|
||||
; this is useful for Piwik developers as an easy way to create data in their local Piwik
|
||||
track_visits_inside_piwik_ui = 0
|
||||
|
||||
; if set to 1, javascript files will be included individually and neither merged nor minified.
|
||||
; this option must be set to 1 when adding, removing or modifying javascript files
|
||||
disable_merged_assets = 0
|
||||
|
||||
; If set to 1, all requests to piwik.php will be forced to be 'new visitors'
|
||||
tracker_always_new_visitor = 0
|
||||
|
||||
; Allow automatic upgrades to Beta or RC releases
|
||||
allow_upgrades_to_beta = 0
|
||||
|
||||
[DebugTests]
|
||||
; Set to 1 by default. If you set to 0, the standalone plugins (with their own git repositories)
|
||||
; will not be loaded when executing tests.
|
||||
enable_load_standalone_plugins_during_tests = 1
|
||||
|
||||
[General]
|
||||
; the following settings control whether Unique Visitors will be processed for different period types.
|
||||
; year and range periods are disabled by default, to ensure optimal performance for high traffic Piwik instances
|
||||
; if you set it to 1 and want the Unique Visitors to be re-processed for reports in the past, drop all piwik_archive_* tables
|
||||
; it is recommended to always enable Unique Visitors processing for 'day' periods
|
||||
enable_processing_unique_visitors_day = 1
|
||||
enable_processing_unique_visitors_week = 1
|
||||
enable_processing_unique_visitors_month = 1
|
||||
enable_processing_unique_visitors_year = 0
|
||||
enable_processing_unique_visitors_range = 0
|
||||
|
||||
; when set to 1, all requests to Piwik will return a maintenance message without connecting to the DB
|
||||
; this is useful when upgrading using the shell command, to prevent other users from accessing the UI while Upgrade is in progress
|
||||
maintenance_mode = 0
|
||||
|
||||
; character used to automatically create categories in the Actions > Pages, Outlinks and Downloads reports
|
||||
; for example a URL like "example.com/blog/development/first-post" will create
|
||||
; the page first-post in the subcategory development which belongs to the blog category
|
||||
action_url_category_delimiter = /
|
||||
|
||||
; similar to above, but this delimiter is only used for page titles in the Actions > Page titles report
|
||||
action_title_category_delimiter = /
|
||||
|
||||
; the maximum url category depth to track. if this is set to 2, then a url such as
|
||||
; "example.com/blog/development/first-post" would be treated as "example.com/blog/development".
|
||||
; this setting is used mainly to limit the amount of data that is stored by Piwik.
|
||||
action_category_level_limit = 10
|
||||
|
||||
; minimum number of websites to run autocompleter
|
||||
autocomplete_min_sites = 5
|
||||
|
||||
; maximum number of websites showed in search results in autocompleter
|
||||
site_selector_max_sites = 15
|
||||
|
||||
; if set to 1, shows sparklines (evolution graph) in 'All Websites' report (MultiSites plugin)
|
||||
show_multisites_sparklines = 1
|
||||
|
||||
; number of websites to display per page in the All Websites dashboard
|
||||
all_websites_website_per_page = 50
|
||||
|
||||
; if set to 0, the anonymous user will not be able to use the 'segments' parameter in the API request
|
||||
; this is useful to prevent full DB access to the anonymous user, or to limit performance usage
|
||||
anonymous_user_enable_use_segments_API = 1
|
||||
|
||||
; if browser trigger archiving is disabled, API requests with a &segment= parameter will still trigger archiving.
|
||||
; You can force the browser archiving to be disabled in most cases by setting this setting to 1
|
||||
; The only time that the browser will still trigger archiving is when requesting a custom date range that is not pre-processed yet
|
||||
browser_archiving_disabled_enforce = 0
|
||||
|
||||
; By default, users can create Segments which are to be processed in Real-time.
|
||||
; Setting this to 0 will force all newly created Custom Segments to be "Pre-processed (faster, requires archive.php cron)"
|
||||
; This can be useful if you want to prevent users from adding much load on the server.
|
||||
; Note: any existing Segment set to "processed in Real time", will still be set to Real-time.
|
||||
; this will only affect custom segments added or modified after this setting is changed.
|
||||
enable_create_realtime_segments = 1
|
||||
|
||||
; this action name is used when the URL ends with a slash /
|
||||
; it is useful to have an actual string to write in the UI
|
||||
action_default_name = index
|
||||
|
||||
; if you want all your users to use Piwik in only one language, disable the LanguagesManager
|
||||
; plugin, and set this default_language (users won't see the language drop down)
|
||||
default_language = en
|
||||
|
||||
; default number of elements in the datatable
|
||||
datatable_default_limit = 10
|
||||
|
||||
; default number of rows returned in API responses
|
||||
; this value is overwritten by the '# Rows to display' selector.
|
||||
; if set to -1, a click on 'Export as' will export all rows independently of the current '# Rows to display'.
|
||||
API_datatable_default_limit = 100
|
||||
|
||||
; When period=range, below the datatables, when user clicks on "export", the data will be aggregate of the range.
|
||||
; Here you can specify the comma separated list of formats for which the data will be exported aggregated by day
|
||||
; (ie. there will be a new "date" column). For example set to: "rss,tsv,csv"
|
||||
datatable_export_range_as_day = "rss"
|
||||
|
||||
; This setting is overriden in the UI, under "User Settings".
|
||||
; The date and period loaded by Piwik uses the defaults below. Possible values: yesterday, today.
|
||||
default_day = yesterday
|
||||
; Possible values: day, week, month, year.
|
||||
default_period = day
|
||||
|
||||
; Time in seconds after which an archive will be computed again. This setting is used only for today's statistics.
|
||||
; Defaults to 10 seconds so that by default, Piwik provides real time reporting.
|
||||
; This setting is overriden in the UI, under "General Settings".
|
||||
; This setting is only used if it hasn't been overriden via the UI yet, or if enable_general_settings_admin=0
|
||||
time_before_today_archive_considered_outdated = 10
|
||||
|
||||
; This setting is overriden in the UI, under "General Settings".
|
||||
; The default value is to allow browsers to trigger the Piwik archiving process.
|
||||
; This setting is only used if it hasn't been overriden via the UI yet, or if enable_general_settings_admin=0
|
||||
enable_browser_archiving_triggering = 1
|
||||
|
||||
; By default Piwik runs OPTIMIZE TABLE SQL queries to free spaces after deleting some data.
|
||||
; If your Piwik tracks millions of pages, the OPTIMIZE TABLE queries might run for hours (seen in "SHOW FULL PROCESSLIST \g")
|
||||
; so you can disable these special queries here:
|
||||
enable_sql_optimize_queries = 1
|
||||
|
||||
; MySQL minimum required version
|
||||
; note: timezone support added in 4.1.3
|
||||
minimum_mysql_version = 4.1
|
||||
|
||||
; PostgreSQL minimum required version
|
||||
minimum_pgsql_version = 8.3
|
||||
|
||||
; Minimum adviced memory limit in php.ini file (see memory_limit value)
|
||||
minimum_memory_limit = 128
|
||||
|
||||
; Minimum memory limit enforced when archived via misc/cron/archive.php
|
||||
minimum_memory_limit_when_archiving = 768
|
||||
|
||||
; Piwik will check that usernames and password have a minimum length, and will check that characters are "allowed"
|
||||
; This can be disabled, if for example you wish to import an existing User database in Piwik and your rules are less restrictive
|
||||
disable_checks_usernames_attributes = 0
|
||||
|
||||
; Piwik will use the configured hash algorithm where possible.
|
||||
; For legacy data, fallback or non-security scenarios, we use md5.
|
||||
hash_algorithm = whirlpool
|
||||
|
||||
; by default, Piwik uses PHP's built-in file-based session save handler with lock files.
|
||||
; For clusters, use dbtable.
|
||||
session_save_handler = files
|
||||
|
||||
; If set to 1, Piwik will automatically redirect all http:// requests to https://
|
||||
; If SSL / https is not correctly configured on the server, this will break Piwik
|
||||
; If you set this to 1, and your SSL configuration breaks later on, you can always edit this back to 0
|
||||
; it is recommended for security reasons to always use Piwik over https
|
||||
force_ssl = 0
|
||||
|
||||
; login cookie name
|
||||
login_cookie_name = piwik_auth
|
||||
|
||||
; login cookie expiration (14 days)
|
||||
login_cookie_expire = 1209600
|
||||
|
||||
; The path on the server in which the cookie will be available on.
|
||||
; Defaults to empty. See spec in http://curl.haxx.se/rfc/cookie_spec.html
|
||||
login_cookie_path =
|
||||
|
||||
; email address that appears as a Sender in the password recovery email
|
||||
; if specified, {DOMAIN} will be replaced by the current Piwik domain
|
||||
login_password_recovery_email_address = "password-recovery@{DOMAIN}"
|
||||
; name that appears as a Sender in the password recovery email
|
||||
login_password_recovery_email_name = Piwik
|
||||
|
||||
; By default when user logs out he is redirected to Piwik "homepage" usually the Login form.
|
||||
; Uncomment the next line to set a URL to redirect the user to after he logs out of Piwik.
|
||||
; login_logout_url = http://...
|
||||
|
||||
; Set to 1 to disable the framebuster on standard Non-widgets pages (a click-jacking countermeasure).
|
||||
; Default is 0 (i.e., bust frames on all non Widget pages such as Login, API, Widgets, Email reports, etc.).
|
||||
enable_framed_pages = 0
|
||||
|
||||
; Set to 1 to disable the framebuster on Admin pages (a click-jacking countermeasure).
|
||||
; Default is 0 (i.e., bust frames on the Settings forms).
|
||||
enable_framed_settings = 0
|
||||
|
||||
; language cookie name for session
|
||||
language_cookie_name = piwik_lang
|
||||
|
||||
; standard email address displayed when sending emails
|
||||
noreply_email_address = "noreply@{DOMAIN}"
|
||||
|
||||
; feedback email address;
|
||||
; when testing, use your own email address or "nobody"
|
||||
feedback_email_address = "feedback@piwik.org"
|
||||
|
||||
; during archiving, Piwik will limit the number of results recorded, for performance reasons
|
||||
; maximum number of rows for any of the Referrers tables (keywords, search engines, campaigns, etc.)
|
||||
datatable_archiving_maximum_rows_referrers = 1000
|
||||
; maximum number of rows for any of the Referrers subtable (search engines by keyword, keyword by campaign, etc.)
|
||||
datatable_archiving_maximum_rows_subtable_referrers = 50
|
||||
|
||||
; maximum number of rows for the Custom Variables names report
|
||||
; Note: if the website is Ecommerce enabled, the two values below will be automatically set to 50000
|
||||
datatable_archiving_maximum_rows_custom_variables = 1000
|
||||
; maximum number of rows for the Custom Variables values reports
|
||||
datatable_archiving_maximum_rows_subtable_custom_variables = 1000
|
||||
|
||||
; maximum number of rows for any of the Actions tables (pages, downloads, outlinks)
|
||||
datatable_archiving_maximum_rows_actions = 500
|
||||
; maximum number of rows for pages in categories (sub pages, when clicking on the + for a page category)
|
||||
; note: should not exceed the display limit in Piwik\Actions\Controller::ACTIONS_REPORT_ROWS_DISPLAY
|
||||
; because each subdirectory doesn't have paging at the bottom, so all data should be displayed if possible.
|
||||
datatable_archiving_maximum_rows_subtable_actions = 100
|
||||
|
||||
; maximum number of rows for any of the Events tables (Categories, Actions, Names)
|
||||
datatable_archiving_maximum_rows_events = 500
|
||||
; maximum number of rows for sub-tables of the Events tables (eg. for the subtables Categories>Actions or Categories>Names).
|
||||
datatable_archiving_maximum_rows_subtable_events = 100
|
||||
|
||||
; maximum number of rows for other tables (Providers, User settings configurations)
|
||||
datatable_archiving_maximum_rows_standard = 500
|
||||
|
||||
; maximum number of rows to fetch from the database when archiving. if set to 0, no limit is used.
|
||||
; this can be used to speed up the archiving process, but is only useful if you're site has a large
|
||||
; amount of actions, referrers or custom variable name/value pairs.
|
||||
archiving_ranking_query_row_limit = 50000
|
||||
|
||||
; maximum number of actions that is shown in the visitor log for each visitor
|
||||
visitor_log_maximum_actions_per_visit = 500
|
||||
|
||||
; by default, the real time Live! widget will update every 5 seconds and refresh with new visits/actions/etc.
|
||||
; you can change the timeout so the widget refreshes more often, or not as frequently
|
||||
live_widget_refresh_after_seconds = 5
|
||||
|
||||
; by default, the Live! real time visitor count widget will check to see how many visitors your
|
||||
; website received in the last 3 minutes. changing this value will change the number of minutes
|
||||
; the widget looks in.
|
||||
live_widget_visitor_count_last_minutes = 3
|
||||
|
||||
; In "All Websites" dashboard, when looking at today's reports (or a date range including today),
|
||||
; the page will automatically refresh every 5 minutes. Set to 0 to disable automatic refresh
|
||||
multisites_refresh_after_seconds = 300
|
||||
|
||||
; Set to 1 if you're using https on your Piwik server and Piwik can't detect it,
|
||||
; e.g., a reverse proxy using https-to-http, or a web server that doesn't
|
||||
; set the HTTPS environment variable.
|
||||
assume_secure_protocol = 0
|
||||
|
||||
; List of proxy headers for client IP addresses
|
||||
;
|
||||
; CloudFlare (CF-Connecting-IP)
|
||||
;proxy_client_headers[] = HTTP_CF_CONNECTING_IP
|
||||
;
|
||||
; ISP proxy (Client-IP)
|
||||
;proxy_client_headers[] = HTTP_CLIENT_IP
|
||||
;
|
||||
; de facto standard (X-Forwarded-For)
|
||||
;proxy_client_headers[] = HTTP_X_FORWARDED_FOR
|
||||
|
||||
; List of proxy headers for host IP addresses
|
||||
;
|
||||
; de facto standard (X-Forwarded-Host)
|
||||
;proxy_host_headers[] = HTTP_X_FORWARDED_HOST
|
||||
|
||||
; List of proxy IP addresses (or IP address ranges) to skip (if present in the above headers).
|
||||
; Generally, only required if there's more than one proxy between the visitor and the backend web server.
|
||||
;
|
||||
; Examples:
|
||||
;proxy_ips[] = 204.93.240.*
|
||||
;proxy_ips[] = 204.93.177.0/24
|
||||
;proxy_ips[] = 199.27.128.0/21
|
||||
;proxy_ips[] = 173.245.48.0/20
|
||||
|
||||
; Whether to enable trusted host checking. This can be disabled if you're running Piwik
|
||||
; on several URLs and do not wish to constantly edit the trusted host list.
|
||||
enable_trusted_host_check = 1
|
||||
|
||||
; List of trusted hosts (eg domain or subdomain names) when generating absolute URLs.
|
||||
;
|
||||
; Examples:
|
||||
;trusted_hosts[] = example.com
|
||||
;trusted_hosts[] = stats.example.com
|
||||
|
||||
; The release server is an essential part of the Piwik infrastructure/ecosystem
|
||||
; to provide the latest software version.
|
||||
latest_version_url = http://builds.piwik.org/latest.zip
|
||||
|
||||
; The API server is an essential part of the Piwik infrastructure/ecosystem to
|
||||
; provide services to Piwik installations, e.g., getLatestVersion and
|
||||
; subscribeNewsletter.
|
||||
api_service_url = http://api.piwik.org
|
||||
|
||||
; When the ImageGraph plugin is activated, report metadata have an additional entry : 'imageGraphUrl'.
|
||||
; This entry can be used to request a static graph for the requested report.
|
||||
; When requesting report metadata with $period=range, Piwik needs to translate it to multiple periods for evolution graphs.
|
||||
; eg. $period=range&date=previous10 becomes $period=day&date=previous10. Use this setting to override the $period value.
|
||||
graphs_default_period_to_plot_when_period_range = day
|
||||
|
||||
; The Overlay plugin shows the Top X following pages, Top X downloads and Top X outlinks which followed
|
||||
; a view of the current page. The value X can be set here.
|
||||
overlay_following_pages_limit = 300
|
||||
|
||||
; With this option, you can disable the framed mode of the Overlay plugin. Use it if your website contains a framebuster.
|
||||
overlay_disable_framed_mode = 0
|
||||
|
||||
; By default we check whether the Custom logo is writable or not, before we display the Custom logo file uploader
|
||||
enable_custom_logo_check = 1
|
||||
|
||||
; If php is running in a chroot environment, when trying to import CSV files with createTableFromCSVFile(),
|
||||
; Mysql will try to load the chrooted path (which is imcomplete). To prevent an error, here you can specify the
|
||||
; absolute path to the chroot environment. eg. '/path/to/piwik/chrooted/'
|
||||
absolute_chroot_path =
|
||||
|
||||
; In some rare cases it may be useful to explicitely tell Piwik not to use LOAD DATA INFILE
|
||||
; This may for example be useful when doing Mysql AWS replication
|
||||
enable_load_data_infile = 1
|
||||
|
||||
; By setting this option to 0, you can disable the Piwik marketplace. This is useful to prevent giving the Super user
|
||||
; the access to disk and install custom PHP code (Piwik plugins).
|
||||
enable_marketplace = 1
|
||||
|
||||
; By setting this option to 0:
|
||||
; - links to Enable/Disable/Uninstall plugins will be hidden and disabled
|
||||
; - links to Uninstall themes will be disabled (but user can still enable/disable themes)
|
||||
; - as well as disabling plugins admin actions (such as "Upload new plugin"), setting this to 1 will have same effect as setting enable_marketplace=1
|
||||
enable_plugins_admin = 1
|
||||
|
||||
; By setting this option to 0, you can prevent Super User from editing the Geolocation settings.
|
||||
enable_geolocation_admin = 1
|
||||
|
||||
; By setting this option to 0, the old log data and old report data features will be hidden from the UI
|
||||
; Note: log purging and old data purging still occurs, just the Super User cannot change the settings.
|
||||
enable_delete_old_data_settings_admin = 1
|
||||
|
||||
; By setting this option to 0, the following settings will be hidden and disabled from being set in the UI:
|
||||
; - "Archiving Settings"
|
||||
; - "Update settings"
|
||||
; - "Email server settings"
|
||||
enable_general_settings_admin = 1
|
||||
|
||||
; By setting this option to 0, it will disable the "Auto update" feature
|
||||
enable_auto_update = 1
|
||||
|
||||
; By setting this option to 0, no emails will be sent in case of an available core.
|
||||
; If set to 0 it also disables the "sent plugin update emails" feature in general and the related setting in the UI.
|
||||
enable_update_communication = 1
|
||||
|
||||
[Tracker]
|
||||
; Piwik uses first party cookies by default. If set to 1,
|
||||
; the visit ID cookie will be set on the Piwik server domain as well
|
||||
; this is useful when you want to do cross websites analysis
|
||||
use_third_party_id_cookie = 0
|
||||
|
||||
; If tracking does not work for you or you are stuck finding an issue, you might want to enable the tracker debug mode.
|
||||
; Once enabled (set to 1) messages will be logged to all loggers defined in "[log] log_writers" config.
|
||||
debug = 0
|
||||
|
||||
; There is a feature in the Tracking API that lets you create new visit at any given time, for example if you know that a different user/customer is using
|
||||
; the app then you would want to tell Piwik to create a new visit (even though both users are using the same browser/computer).
|
||||
; To prevent abuse and easy creation of fake visits, this feature requires admin token_auth by default
|
||||
; If you wish to use this feature using the Javascript tracker, you can set the setting new_visit_api_requires_admin=0, and in Javascript write:
|
||||
; _paq.push(['appendToTrackingUrl', 'new_visit=1']);
|
||||
new_visit_api_requires_admin = 1
|
||||
|
||||
; This setting should only be set to 1 in an intranet setting, where most users have the same configuration (browsers, OS)
|
||||
; and the same IP. If left to 0 in this setting, all visitors will be counted as one single visitor.
|
||||
trust_visitors_cookies = 0
|
||||
|
||||
; name of the cookie used to store the visitor information
|
||||
; This is used only if use_third_party_id_cookie = 1
|
||||
cookie_name = _pk_uid
|
||||
|
||||
; by default, the Piwik tracking cookie expires in 2 years
|
||||
; This is used only if use_third_party_id_cookie = 1
|
||||
cookie_expire = 63072000
|
||||
|
||||
; The path on the server in which the cookie will be available on.
|
||||
; Defaults to empty. See spec in http://curl.haxx.se/rfc/cookie_spec.html
|
||||
; This is used for the Ignore cookie, and the third party cookie if use_third_party_id_cookie = 1
|
||||
cookie_path =
|
||||
|
||||
; set to 0 if you want to stop tracking the visitors. Useful if you need to stop all the connections on the DB.
|
||||
record_statistics = 1
|
||||
|
||||
; length of a visit in seconds. If a visitor comes back on the website visit_standard_length seconds
|
||||
; after his last page view, it will be recorded as a new visit
|
||||
visit_standard_length = 1800
|
||||
|
||||
; The window to look back for a previous visit by this current visitor. Defaults to visit_standard_length.
|
||||
; If you are looking for higher accuracy of "returning visitors" metrics, you may set this value to 86400 or more.
|
||||
; This is especially useful when you use the Tracking API where tracking Returning Visitors often depends on this setting.
|
||||
; The value window_look_back_for_visitor is used only if it is set to greater than visit_standard_length
|
||||
window_look_back_for_visitor = 0
|
||||
|
||||
; visitors that stay on the website and view only one page will be considered as time on site of 0 second
|
||||
default_time_one_page_visit = 0
|
||||
|
||||
; if set to 1, Piwik attempts a "best guess" at the visitor's country of
|
||||
; origin when the preferred language tag omits region information.
|
||||
; The mapping is defined in core/DataFiles/LanguageToCountry.php,
|
||||
enable_language_to_country_guess = 1
|
||||
|
||||
; When the misc/cron/archive.php cron hasn't been setup, we still need to regularly run some maintenance tasks.
|
||||
; Visits to the Tracker will try to trigger Scheduled Tasks (eg. scheduled PDF/HTML reports by email).
|
||||
; Scheduled tasks will only run if 'Enable Piwik Archiving from Browser' is enabled in the General Settings.
|
||||
; Tasks run once every hour maximum, they might not run every hour if traffic is low.
|
||||
; Set to 0 to disable Scheduled tasks completely.
|
||||
scheduled_tasks_min_interval = 3600
|
||||
|
||||
; name of the cookie to ignore visits
|
||||
ignore_visits_cookie_name = piwik_ignore
|
||||
|
||||
; Comma separated list of variable names that will be read to define a Campaign name, for example CPC campaign
|
||||
; Example: If a visitor first visits 'index.php?piwik_campaign=Adwords-CPC' then it will be counted as a campaign referrer named 'Adwords-CPC'
|
||||
; Includes by default the GA style campaign parameters
|
||||
campaign_var_name = "pk_campaign,piwik_campaign,utm_campaign,utm_source,utm_medium"
|
||||
|
||||
; Comma separated list of variable names that will be read to track a Campaign Keyword
|
||||
; Example: If a visitor first visits 'index.php?piwik_campaign=Adwords-CPC&piwik_kwd=My killer keyword' ;
|
||||
; then it will be counted as a campaign referrer named 'Adwords-CPC' with the keyword 'My killer keyword'
|
||||
; Includes by default the GA style campaign keyword parameter utm_term
|
||||
campaign_keyword_var_name = "pk_kwd,piwik_kwd,pk_keyword,utm_term"
|
||||
|
||||
; maximum length of a Page Title or a Page URL recorded in the log_action.name table
|
||||
page_maximum_length = 1024;
|
||||
|
||||
; Tracker cache files are the simple caching layer for Tracking.
|
||||
; TTL: Time to live for cache files, in seconds. Default to 5 minutes.
|
||||
tracker_cache_file_ttl = 300
|
||||
|
||||
; DO NOT USE THIS SETTING ON PUBLICLY AVAILABLE PIWIK SERVER
|
||||
; !!! Security risk: if set to 0, it would allow anyone to push data to Piwik with custom dates in the past/future and even with fake IPs!
|
||||
; When using the Tracking API, to override either the datetime and/or the visitor IP,
|
||||
; token_auth with an "admin" access is required. If you set this setting to 0, the token_auth will not be required anymore.
|
||||
; DO NOT USE THIS SETTING ON PUBLIC PIWIK SERVERS
|
||||
tracking_requests_require_authentication = 1
|
||||
|
||||
[Segments]
|
||||
; Reports with segmentation in API requests are processed in real time.
|
||||
; On high traffic websites it is recommended to pre-process the data
|
||||
; so that the analytics reports are always fast to load.
|
||||
; You can define below the list of Segments strings
|
||||
; for which all reports should be Archived during the cron execution
|
||||
; All segment values MUST be URL encoded.
|
||||
;Segments[]="visitorType==new"
|
||||
;Segments[]="visitorType==returning"
|
||||
|
||||
; If you define Custom Variables for your visitor, for example set the visit type
|
||||
;Segments[]="customVariableName1==VisitType;customVariableValue1==Customer"
|
||||
|
||||
[Deletelogs]
|
||||
; delete_logs_enable - enable (1) or disable (0) delete log feature. Make sure that all archives for the given period have been processed (setup a cronjob!),
|
||||
; otherwise you may lose tracking data.
|
||||
; delete_logs_schedule_lowest_interval - lowest possible interval between two table deletes (in days, 1|7|30). Default: 7.
|
||||
; delete_logs_older_than - delete data older than XX (days). Default: 180
|
||||
delete_logs_enable = 0
|
||||
delete_logs_schedule_lowest_interval = 7
|
||||
delete_logs_older_than = 180
|
||||
delete_logs_max_rows_per_query = 100000
|
||||
enable_auto_database_size_estimate = 1
|
||||
|
||||
[Deletereports]
|
||||
delete_reports_enable = 0
|
||||
delete_reports_older_than = 12
|
||||
delete_reports_keep_basic_metrics = 1
|
||||
delete_reports_keep_day_reports = 0
|
||||
delete_reports_keep_week_reports = 0
|
||||
delete_reports_keep_month_reports = 1
|
||||
delete_reports_keep_year_reports = 1
|
||||
delete_reports_keep_range_reports = 0
|
||||
delete_reports_keep_segment_reports = 0
|
||||
|
||||
[mail]
|
||||
defaultHostnameIfEmpty = defaultHostnameIfEmpty.example.org ; default Email @hostname, if current host can't be read from system variables
|
||||
transport = ; smtp (using the configuration below) or empty (using built-in mail() function)
|
||||
port = ; optional; defaults to 25 when security is none or tls; 465 for ssl
|
||||
host = ; SMTP server address
|
||||
type = ; SMTP Auth type. By default: NONE. For example: LOGIN
|
||||
username = ; SMTP username
|
||||
password = ; SMTP password
|
||||
encryption = ; SMTP transport-layer encryption, either 'ssl', 'tls', or empty (i.e., none).
|
||||
|
||||
[proxy]
|
||||
type = BASIC ; proxy type for outbound/outgoing connections; currently, only BASIC is supported
|
||||
host = ; Proxy host: the host name of your proxy server (mandatory)
|
||||
port = ; Proxy port: the port that the proxy server listens to. There is no standard default, but 80, 1080, 3128, and 8080 are popular
|
||||
username = ; Proxy username: optional; if specified, password is mandatory
|
||||
password = ; Proxy password: optional; if specified, username is mandatory
|
||||
|
||||
[Plugins]
|
||||
Plugins[] = CorePluginsAdmin
|
||||
Plugins[] = CoreAdminHome
|
||||
Plugins[] = CoreHome
|
||||
Plugins[] = CoreVisualizations
|
||||
Plugins[] = Proxy
|
||||
Plugins[] = API
|
||||
Plugins[] = ExamplePlugin
|
||||
Plugins[] = Widgetize
|
||||
Plugins[] = Transitions
|
||||
Plugins[] = LanguagesManager
|
||||
Plugins[] = Actions
|
||||
Plugins[] = Dashboard
|
||||
Plugins[] = MultiSites
|
||||
Plugins[] = Referrers
|
||||
Plugins[] = UserSettings
|
||||
Plugins[] = Goals
|
||||
Plugins[] = SEO
|
||||
Plugins[] = Events
|
||||
Plugins[] = UserCountry
|
||||
Plugins[] = VisitsSummary
|
||||
Plugins[] = VisitFrequency
|
||||
Plugins[] = VisitTime
|
||||
Plugins[] = VisitorInterest
|
||||
Plugins[] = ExampleAPI
|
||||
Plugins[] = ExampleRssWidget
|
||||
Plugins[] = Provider
|
||||
Plugins[] = Feedback
|
||||
|
||||
Plugins[] = Login
|
||||
Plugins[] = UsersManager
|
||||
Plugins[] = SitesManager
|
||||
Plugins[] = Installation
|
||||
Plugins[] = CoreUpdater
|
||||
Plugins[] = CoreConsole
|
||||
Plugins[] = ScheduledReports
|
||||
Plugins[] = UserCountryMap
|
||||
Plugins[] = Live
|
||||
Plugins[] = CustomVariables
|
||||
Plugins[] = PrivacyManager
|
||||
Plugins[] = ImageGraph
|
||||
Plugins[] = Annotations
|
||||
Plugins[] = MobileMessaging
|
||||
Plugins[] = Overlay
|
||||
Plugins[] = SegmentEditor
|
||||
Plugins[] = Insights
|
||||
|
||||
Plugins[] = Morpheus
|
||||
|
||||
[PluginsInstalled]
|
||||
PluginsInstalled[] = Login
|
||||
PluginsInstalled[] = CoreAdminHome
|
||||
PluginsInstalled[] = UsersManager
|
||||
PluginsInstalled[] = SitesManager
|
||||
PluginsInstalled[] = Installation
|
||||
|
||||
[Plugins_Tracker]
|
||||
Plugins_Tracker[] = Provider
|
||||
Plugins_Tracker[] = Goals
|
||||
Plugins_Tracker[] = PrivacyManager
|
||||
Plugins_Tracker[] = UserCountry
|
||||
Plugins_Tracker[] = Login
|
||||
|
||||
[APISettings]
|
||||
; Any key/value pair can be added in this section, they will be available via the REST call
|
||||
; index.php?module=API&method=API.getSettings
|
||||
; This can be used to expose values from Piwik, to control for example a Mobile app tracking
|
||||
SDK_batch_size = 10
|
||||
SDK_interval_value = 30
|
||||
|
||||
; NOTE: do not directly edit this file! See notice at the top
|
||||
|
||||
3200
www/analytics/config/manifest.inc.php
Normal file
3200
www/analytics/config/manifest.inc.php
Normal file
File diff suppressed because it is too large
Load diff
28
www/analytics/console
Executable file
28
www/analytics/console
Executable file
|
|
@ -0,0 +1,28 @@
|
|||
#!/usr/bin/env php
|
||||
<?php
|
||||
if (!defined('PIWIK_DOCUMENT_ROOT')) {
|
||||
define('PIWIK_DOCUMENT_ROOT', dirname(__FILE__) == '/' ? '' : dirname(__FILE__));
|
||||
}
|
||||
if (!defined('PIWIK_INCLUDE_PATH')) {
|
||||
define('PIWIK_INCLUDE_PATH', PIWIK_DOCUMENT_ROOT);
|
||||
}
|
||||
if (!defined('PIWIK_USER_PATH')) {
|
||||
define('PIWIK_USER_PATH', PIWIK_DOCUMENT_ROOT);
|
||||
}
|
||||
|
||||
require_once PIWIK_INCLUDE_PATH . '/core/testMinimumPhpVersion.php';
|
||||
require_once file_exists(PIWIK_INCLUDE_PATH . '/vendor/autoload.php')
|
||||
? PIWIK_INCLUDE_PATH . '/vendor/autoload.php' // Piwik is the main project
|
||||
: PIWIK_INCLUDE_PATH . '/../../autoload.php'; // Piwik is installed as a dependency
|
||||
require_once PIWIK_INCLUDE_PATH . '/core/Loader.php';
|
||||
require_once PIWIK_INCLUDE_PATH . '/libs/upgradephp/upgrade.php';
|
||||
|
||||
Piwik\Translate::loadEnglishTranslation();
|
||||
|
||||
if (!Piwik\Common::isPhpCliMode()) {
|
||||
exit;
|
||||
}
|
||||
|
||||
$console = new Piwik\Console();
|
||||
$console->init();
|
||||
$console->run();
|
||||
13
www/analytics/core/.htaccess
Normal file
13
www/analytics/core/.htaccess
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<Files "*">
|
||||
<IfModule mod_access.c>
|
||||
Deny from all
|
||||
</IfModule>
|
||||
<IfModule !mod_access_compat>
|
||||
<IfModule mod_authz_host.c>
|
||||
Deny from all
|
||||
</IfModule>
|
||||
</IfModule>
|
||||
<IfModule mod_access_compat>
|
||||
Deny from all
|
||||
</IfModule>
|
||||
</Files>
|
||||
149
www/analytics/core/API/DataTableGenericFilter.php
Normal file
149
www/analytics/core/API/DataTableGenericFilter.php
Normal file
|
|
@ -0,0 +1,149 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API;
|
||||
|
||||
use Exception;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable;
|
||||
use Piwik\DataTable\Filter\AddColumnsProcessedMetricsGoal;
|
||||
|
||||
class DataTableGenericFilter
|
||||
{
|
||||
private static $genericFiltersInfo = null;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param $request
|
||||
*/
|
||||
function __construct($request)
|
||||
{
|
||||
$this->request = $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters the given data table
|
||||
*
|
||||
* @param DataTable $table
|
||||
*/
|
||||
public function filter($table)
|
||||
{
|
||||
$this->applyGenericFilters($table);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array containing the information of the generic Filter
|
||||
* to be applied automatically to the data resulting from the API calls.
|
||||
*
|
||||
* Order to apply the filters:
|
||||
* 1 - Filter that remove filtered rows
|
||||
* 2 - Filter that sort the remaining rows
|
||||
* 3 - Filter that keep only a subset of the results
|
||||
* 4 - Presentation filters
|
||||
*
|
||||
* @return array See the code for spec
|
||||
*/
|
||||
public static function getGenericFiltersInformation()
|
||||
{
|
||||
if (is_null(self::$genericFiltersInfo)) {
|
||||
self::$genericFiltersInfo = array(
|
||||
'Pattern' => array(
|
||||
'filter_column' => array('string', 'label'),
|
||||
'filter_pattern' => array('string'),
|
||||
),
|
||||
'PatternRecursive' => array(
|
||||
'filter_column_recursive' => array('string', 'label'),
|
||||
'filter_pattern_recursive' => array('string'),
|
||||
),
|
||||
'ExcludeLowPopulation' => array(
|
||||
'filter_excludelowpop' => array('string'),
|
||||
'filter_excludelowpop_value' => array('float', '0'),
|
||||
),
|
||||
'AddColumnsProcessedMetrics' => array(
|
||||
'filter_add_columns_when_show_all_columns' => array('integer')
|
||||
),
|
||||
'AddColumnsProcessedMetricsGoal' => array(
|
||||
'filter_update_columns_when_show_all_goals' => array('integer'),
|
||||
'idGoal' => array('string', AddColumnsProcessedMetricsGoal::GOALS_OVERVIEW),
|
||||
),
|
||||
'Sort' => array(
|
||||
'filter_sort_column' => array('string'),
|
||||
'filter_sort_order' => array('string', 'desc'),
|
||||
),
|
||||
'Truncate' => array(
|
||||
'filter_truncate' => array('integer'),
|
||||
),
|
||||
'Limit' => array(
|
||||
'filter_offset' => array('integer', '0'),
|
||||
'filter_limit' => array('integer'),
|
||||
'keep_summary_row' => array('integer', '0'),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
return self::$genericFiltersInfo;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply generic filters to the DataTable object resulting from the API Call.
|
||||
* Disable this feature by setting the parameter disable_generic_filters to 1 in the API call request.
|
||||
*
|
||||
* @param DataTable $datatable
|
||||
* @return bool
|
||||
*/
|
||||
protected function applyGenericFilters($datatable)
|
||||
{
|
||||
if ($datatable instanceof DataTable\Map) {
|
||||
$tables = $datatable->getDataTables();
|
||||
foreach ($tables as $table) {
|
||||
$this->applyGenericFilters($table);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
$genericFilters = self::getGenericFiltersInformation();
|
||||
|
||||
$filterApplied = false;
|
||||
foreach ($genericFilters as $filterName => $parameters) {
|
||||
$filterParameters = array();
|
||||
$exceptionRaised = false;
|
||||
foreach ($parameters as $name => $info) {
|
||||
// parameter type to cast to
|
||||
$type = $info[0];
|
||||
|
||||
// default value if specified, when the parameter doesn't have a value
|
||||
$defaultValue = null;
|
||||
if (isset($info[1])) {
|
||||
$defaultValue = $info[1];
|
||||
}
|
||||
|
||||
// third element in the array, if it exists, overrides the name of the request variable
|
||||
$varName = $name;
|
||||
if (isset($info[2])) {
|
||||
$varName = $info[2];
|
||||
}
|
||||
|
||||
try {
|
||||
$value = Common::getRequestVar($name, $defaultValue, $type, $this->request);
|
||||
settype($value, $type);
|
||||
$filterParameters[] = $value;
|
||||
} catch (Exception $e) {
|
||||
$exceptionRaised = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!$exceptionRaised) {
|
||||
$datatable->filter($filterName, $filterParameters);
|
||||
$filterApplied = true;
|
||||
}
|
||||
}
|
||||
return $filterApplied;
|
||||
}
|
||||
}
|
||||
192
www/analytics/core/API/DataTableManipulator.php
Normal file
192
www/analytics/core/API/DataTableManipulator.php
Normal file
|
|
@ -0,0 +1,192 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API;
|
||||
|
||||
use Exception;
|
||||
use Piwik\Archive\DataTableFactory;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable\Row;
|
||||
use Piwik\DataTable;
|
||||
use Piwik\Period\Range;
|
||||
use Piwik\Plugins\API\API;
|
||||
|
||||
/**
|
||||
* Base class for manipulating data tables.
|
||||
* It provides generic mechanisms like iteration and loading subtables.
|
||||
*
|
||||
* The manipulators are used in ResponseBuilder and are triggered by
|
||||
* API parameters. They are not filters because they don't work on the pre-
|
||||
* fetched nested data tables. Instead, they load subtables using this base
|
||||
* class. This way, they can only load the tables they really need instead
|
||||
* of using expanded=1. Another difference between manipulators and filters
|
||||
* is that filters keep the overall structure of the table intact while
|
||||
* manipulators can change the entire thing.
|
||||
*/
|
||||
abstract class DataTableManipulator
|
||||
{
|
||||
protected $apiModule;
|
||||
protected $apiMethod;
|
||||
protected $request;
|
||||
|
||||
private $apiMethodForSubtable;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param bool $apiModule
|
||||
* @param bool $apiMethod
|
||||
* @param array $request
|
||||
*/
|
||||
public function __construct($apiModule = false, $apiMethod = false, $request = array())
|
||||
{
|
||||
$this->apiModule = $apiModule;
|
||||
$this->apiMethod = $apiMethod;
|
||||
$this->request = $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method can be used by subclasses to iterate over data tables that might be
|
||||
* data table maps. It calls back the template method self::doManipulate for each table.
|
||||
* This way, data table arrays can be handled in a transparent fashion.
|
||||
*
|
||||
* @param DataTable\Map|DataTable $dataTable
|
||||
* @throws Exception
|
||||
* @return DataTable\Map|DataTable
|
||||
*/
|
||||
protected function manipulate($dataTable)
|
||||
{
|
||||
if ($dataTable instanceof DataTable\Map) {
|
||||
return $this->manipulateDataTableMap($dataTable);
|
||||
} else if ($dataTable instanceof DataTable) {
|
||||
return $this->manipulateDataTable($dataTable);
|
||||
} else {
|
||||
return $dataTable;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Manipulates child DataTables of a DataTable\Map. See @manipulate for more info.
|
||||
*
|
||||
* @param DataTable\Map $dataTable
|
||||
* @return DataTable\Map
|
||||
*/
|
||||
protected function manipulateDataTableMap($dataTable)
|
||||
{
|
||||
$result = $dataTable->getEmptyClone();
|
||||
foreach ($dataTable->getDataTables() as $tableLabel => $childTable) {
|
||||
$newTable = $this->manipulate($childTable);
|
||||
$result->addTable($newTable, $tableLabel);
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Manipulates a single DataTable instance. Derived classes must define
|
||||
* this function.
|
||||
*/
|
||||
protected abstract function manipulateDataTable($dataTable);
|
||||
|
||||
/**
|
||||
* Load the subtable for a row.
|
||||
* Returns null if none is found.
|
||||
*
|
||||
* @param DataTable $dataTable
|
||||
* @param Row $row
|
||||
*
|
||||
* @return DataTable
|
||||
*/
|
||||
protected function loadSubtable($dataTable, $row)
|
||||
{
|
||||
if (!($this->apiModule && $this->apiMethod && count($this->request))) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$request = $this->request;
|
||||
|
||||
$idSubTable = $row->getIdSubDataTable();
|
||||
if ($idSubTable === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$request['idSubtable'] = $idSubTable;
|
||||
if ($dataTable) {
|
||||
$period = $dataTable->getMetadata(DataTableFactory::TABLE_METADATA_PERIOD_INDEX);
|
||||
if ($period instanceof Range) {
|
||||
$request['date'] = $period->getDateStart() . ',' . $period->getDateEnd();
|
||||
} else {
|
||||
$request['date'] = $period->getDateStart()->toString();
|
||||
}
|
||||
}
|
||||
|
||||
$method = $this->getApiMethodForSubtable();
|
||||
return $this->callApiAndReturnDataTable($this->apiModule, $method, $request);
|
||||
}
|
||||
|
||||
/**
|
||||
* In this method, subclasses can clean up the request array for loading subtables
|
||||
* in order to make ResponseBuilder behave correctly (e.g. not trigger the
|
||||
* manipulator again).
|
||||
*
|
||||
* @param $request
|
||||
* @return
|
||||
*/
|
||||
protected abstract function manipulateSubtableRequest($request);
|
||||
|
||||
/**
|
||||
* Extract the API method for loading subtables from the meta data
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function getApiMethodForSubtable()
|
||||
{
|
||||
if (!$this->apiMethodForSubtable) {
|
||||
$meta = API::getInstance()->getMetadata('all', $this->apiModule, $this->apiMethod);
|
||||
|
||||
if(empty($meta)) {
|
||||
throw new Exception(sprintf(
|
||||
"The DataTable cannot be manipulated: Metadata for report %s.%s could not be found. You can define the metadata in a hook, see example at: http://developer.piwik.org/api-reference/events#apigetreportmetadata",
|
||||
$this->apiModule, $this->apiMethod
|
||||
));
|
||||
}
|
||||
|
||||
if (isset($meta[0]['actionToLoadSubTables'])) {
|
||||
$this->apiMethodForSubtable = $meta[0]['actionToLoadSubTables'];
|
||||
} else {
|
||||
$this->apiMethodForSubtable = $this->apiMethod;
|
||||
}
|
||||
}
|
||||
return $this->apiMethodForSubtable;
|
||||
}
|
||||
|
||||
protected function callApiAndReturnDataTable($apiModule, $method, $request)
|
||||
{
|
||||
$class = Request::getClassNameAPI($apiModule);
|
||||
|
||||
$request = $this->manipulateSubtableRequest($request);
|
||||
$request['serialize'] = 0;
|
||||
$request['expanded'] = 0;
|
||||
|
||||
// don't want to run recursive filters on the subtables as they are loaded,
|
||||
// otherwise the result will be empty in places (or everywhere). instead we
|
||||
// run it on the flattened table.
|
||||
unset($request['filter_pattern_recursive']);
|
||||
|
||||
$dataTable = Proxy::getInstance()->call($class, $method, $request);
|
||||
$response = new ResponseBuilder($format = 'original', $request);
|
||||
$dataTable = $response->getResponse($dataTable);
|
||||
|
||||
if (Common::getRequestVar('disable_queued_filters', 0, 'int', $request) == 0) {
|
||||
if (method_exists($dataTable, 'applyQueuedFilters')) {
|
||||
$dataTable->applyQueuedFilters();
|
||||
}
|
||||
}
|
||||
|
||||
return $dataTable;
|
||||
}
|
||||
}
|
||||
137
www/analytics/core/API/DataTableManipulator/Flattener.php
Normal file
137
www/analytics/core/API/DataTableManipulator/Flattener.php
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API\DataTableManipulator;
|
||||
|
||||
use Piwik\API\DataTableManipulator;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable;
|
||||
use Piwik\DataTable\Row;
|
||||
|
||||
/**
|
||||
* This class is responsible for flattening data tables.
|
||||
*
|
||||
* It loads subtables and combines them into a single table by concatenating the labels.
|
||||
* This manipulator is triggered by using flat=1 in the API request.
|
||||
*/
|
||||
class Flattener extends DataTableManipulator
|
||||
{
|
||||
|
||||
private $includeAggregateRows = false;
|
||||
|
||||
/**
|
||||
* If the flattener is used after calling this method, aggregate rows will
|
||||
* be included in the result. This can be useful when they contain data that
|
||||
* the leafs don't have (e.g. conversion stats in some cases).
|
||||
*/
|
||||
public function includeAggregateRows()
|
||||
{
|
||||
$this->includeAggregateRows = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Separator for building recursive labels (or paths)
|
||||
* @var string
|
||||
*/
|
||||
public $recursiveLabelSeparator = ' - ';
|
||||
|
||||
/**
|
||||
* @param DataTable $dataTable
|
||||
* @return DataTable|DataTable\Map
|
||||
*/
|
||||
public function flatten($dataTable)
|
||||
{
|
||||
if ($this->apiModule == 'Actions' || $this->apiMethod == 'getWebsites') {
|
||||
$this->recursiveLabelSeparator = '/';
|
||||
}
|
||||
|
||||
return $this->manipulate($dataTable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Template method called from self::manipulate.
|
||||
* Flatten each data table.
|
||||
*
|
||||
* @param DataTable $dataTable
|
||||
* @return DataTable
|
||||
*/
|
||||
protected function manipulateDataTable($dataTable)
|
||||
{
|
||||
// apply filters now since subtables have their filters applied before generic filters. if we don't do this
|
||||
// now, we'll try to apply filters to rows that have already been manipulated. this results in errors like
|
||||
// 'column ... already exists'.
|
||||
$keepFilters = true;
|
||||
if (Common::getRequestVar('disable_queued_filters', 0, 'int', $this->request) == 0) {
|
||||
$dataTable->applyQueuedFilters();
|
||||
$keepFilters = false;
|
||||
}
|
||||
|
||||
$newDataTable = $dataTable->getEmptyClone($keepFilters);
|
||||
foreach ($dataTable->getRows() as $row) {
|
||||
$this->flattenRow($row, $newDataTable);
|
||||
}
|
||||
return $newDataTable;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Row $row
|
||||
* @param DataTable $dataTable
|
||||
* @param string $labelPrefix
|
||||
* @param bool $parentLogo
|
||||
*/
|
||||
private function flattenRow(Row $row, DataTable $dataTable,
|
||||
$labelPrefix = '', $parentLogo = false)
|
||||
{
|
||||
$label = $row->getColumn('label');
|
||||
if ($label !== false) {
|
||||
$label = trim($label);
|
||||
if (substr($label, 0, 1) == '/' && $this->recursiveLabelSeparator == '/') {
|
||||
$label = substr($label, 1);
|
||||
}
|
||||
$label = $labelPrefix . $label;
|
||||
$row->setColumn('label', $label);
|
||||
}
|
||||
|
||||
$logo = $row->getMetadata('logo');
|
||||
if ($logo === false && $parentLogo !== false) {
|
||||
$logo = $parentLogo;
|
||||
$row->setMetadata('logo', $logo);
|
||||
}
|
||||
|
||||
$subTable = $this->loadSubtable($dataTable, $row);
|
||||
$row->removeSubtable();
|
||||
|
||||
if ($subTable === null) {
|
||||
if ($this->includeAggregateRows) {
|
||||
$row->setMetadata('is_aggregate', 0);
|
||||
}
|
||||
$dataTable->addRow($row);
|
||||
} else {
|
||||
if ($this->includeAggregateRows) {
|
||||
$row->setMetadata('is_aggregate', 1);
|
||||
$dataTable->addRow($row);
|
||||
}
|
||||
$prefix = $label . $this->recursiveLabelSeparator;
|
||||
foreach ($subTable->getRows() as $row) {
|
||||
$this->flattenRow($row, $dataTable, $prefix, $logo);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the flat parameter from the subtable request
|
||||
*
|
||||
* @param array $request
|
||||
*/
|
||||
protected function manipulateSubtableRequest($request)
|
||||
{
|
||||
unset($request['flat']);
|
||||
|
||||
return $request;
|
||||
}
|
||||
}
|
||||
167
www/analytics/core/API/DataTableManipulator/LabelFilter.php
Normal file
167
www/analytics/core/API/DataTableManipulator/LabelFilter.php
Normal file
|
|
@ -0,0 +1,167 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API\DataTableManipulator;
|
||||
|
||||
use Piwik\API\DataTableManipulator;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable;
|
||||
use Piwik\DataTable\Row;
|
||||
|
||||
/**
|
||||
* This class is responsible for handling the label parameter that can be
|
||||
* added to every API call. If the parameter is set, only the row with the matching
|
||||
* label is returned.
|
||||
*
|
||||
* The labels passed to this class should be urlencoded.
|
||||
* Some reports use recursive labels (e.g. action reports). Use > to join them.
|
||||
*/
|
||||
class LabelFilter extends DataTableManipulator
|
||||
{
|
||||
const SEPARATOR_RECURSIVE_LABEL = '>';
|
||||
|
||||
private $labels;
|
||||
private $addLabelIndex;
|
||||
const FLAG_IS_ROW_EVOLUTION = 'label_index';
|
||||
|
||||
/**
|
||||
* Filter a data table by label.
|
||||
* The filtered table is returned, which might be a new instance.
|
||||
*
|
||||
* $apiModule, $apiMethod and $request are needed load sub-datatables
|
||||
* for the recursive search. If the label is not recursive, these parameters
|
||||
* are not needed.
|
||||
*
|
||||
* @param string $labels the labels to search for
|
||||
* @param DataTable $dataTable the data table to be filtered
|
||||
* @param bool $addLabelIndex Whether to add label_index metadata describing which
|
||||
* label a row corresponds to.
|
||||
* @return DataTable
|
||||
*/
|
||||
public function filter($labels, $dataTable, $addLabelIndex = false)
|
||||
{
|
||||
if (!is_array($labels)) {
|
||||
$labels = array($labels);
|
||||
}
|
||||
|
||||
$this->labels = $labels;
|
||||
$this->addLabelIndex = (bool)$addLabelIndex;
|
||||
return $this->manipulate($dataTable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Method for the recursive descend
|
||||
*
|
||||
* @param array $labelParts
|
||||
* @param DataTable $dataTable
|
||||
* @return Row|bool
|
||||
*/
|
||||
private function doFilterRecursiveDescend($labelParts, $dataTable)
|
||||
{
|
||||
// search for the first part of the tree search
|
||||
$labelPart = array_shift($labelParts);
|
||||
|
||||
$row = false;
|
||||
foreach ($this->getLabelVariations($labelPart) as $labelPart) {
|
||||
$row = $dataTable->getRowFromLabel($labelPart);
|
||||
if ($row !== false) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($row === false) {
|
||||
// not found
|
||||
return false;
|
||||
}
|
||||
|
||||
// end of tree search reached
|
||||
if (count($labelParts) == 0) {
|
||||
return $row;
|
||||
}
|
||||
|
||||
$subTable = $this->loadSubtable($dataTable, $row);
|
||||
if ($subTable === null) {
|
||||
// no more subtables but label parts left => no match found
|
||||
return false;
|
||||
}
|
||||
|
||||
return $this->doFilterRecursiveDescend($labelParts, $subTable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up request for ResponseBuilder to behave correctly
|
||||
*
|
||||
* @param $request
|
||||
*/
|
||||
protected function manipulateSubtableRequest($request)
|
||||
{
|
||||
unset($request['label']);
|
||||
|
||||
return $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* Use variations of the label to make it easier to specify the desired label
|
||||
*
|
||||
* Note: The HTML Encoded version must be tried first, since in ResponseBuilder the $label is unsanitized
|
||||
* via Common::unsanitizeLabelParameter.
|
||||
*
|
||||
* @param string $label
|
||||
* @return array
|
||||
*/
|
||||
private function getLabelVariations($label)
|
||||
{
|
||||
static $pageTitleReports = array('getPageTitles', 'getEntryPageTitles', 'getExitPageTitles');
|
||||
|
||||
$variations = array();
|
||||
$label = urldecode($label);
|
||||
$label = trim($label);
|
||||
|
||||
$sanitizedLabel = Common::sanitizeInputValue($label);
|
||||
$variations[] = $sanitizedLabel;
|
||||
|
||||
if ($this->apiModule == 'Actions'
|
||||
&& in_array($this->apiMethod, $pageTitleReports)
|
||||
) {
|
||||
// special case: the Actions.getPageTitles report prefixes some labels with a blank.
|
||||
// the blank might be passed by the user but is removed in Request::getRequestArrayFromString.
|
||||
$variations[] = ' ' . $sanitizedLabel;
|
||||
$variations[] = ' ' . $label;
|
||||
}
|
||||
$variations[] = $label;
|
||||
|
||||
return $variations;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter a DataTable instance. See @filter for more info.
|
||||
*
|
||||
* @param DataTable\Simple|DataTable\Map $dataTable
|
||||
* @return mixed
|
||||
*/
|
||||
protected function manipulateDataTable($dataTable)
|
||||
{
|
||||
$result = $dataTable->getEmptyClone();
|
||||
foreach ($this->labels as $labelIndex => $label) {
|
||||
$row = null;
|
||||
foreach ($this->getLabelVariations($label) as $labelVariation) {
|
||||
$labelVariation = explode(self::SEPARATOR_RECURSIVE_LABEL, $labelVariation);
|
||||
|
||||
$row = $this->doFilterRecursiveDescend($labelVariation, $dataTable);
|
||||
if ($row) {
|
||||
if ($this->addLabelIndex) {
|
||||
$row->setMetadata(self::FLAG_IS_ROW_EVOLUTION, $labelIndex);
|
||||
}
|
||||
$result->addRow($row);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,250 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API\DataTableManipulator;
|
||||
|
||||
use Piwik\API\DataTableManipulator;
|
||||
use Piwik\DataTable;
|
||||
use Piwik\DataTable\Row;
|
||||
use Piwik\DataTable\BaseFilter;
|
||||
use Piwik\Period\Range;
|
||||
use Piwik\Period;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\Metrics;
|
||||
use Piwik\Plugins\API\API;
|
||||
|
||||
/**
|
||||
* This class is responsible for setting the metadata property 'totals' on each dataTable if the report
|
||||
* has a dimension. 'Totals' means it tries to calculate the total report value for each metric. For each
|
||||
* the total number of visits, actions, ... for a given report / dataTable.
|
||||
*/
|
||||
class ReportTotalsCalculator extends DataTableManipulator
|
||||
{
|
||||
/**
|
||||
* Cached report metadata array.
|
||||
* @var array
|
||||
*/
|
||||
private static $reportMetadata = array();
|
||||
|
||||
/**
|
||||
* @param DataTable $table
|
||||
* @return \Piwik\DataTable|\Piwik\DataTable\Map
|
||||
*/
|
||||
public function calculate($table)
|
||||
{
|
||||
// apiModule and/or apiMethod is empty for instance in case when flat=1 is called. Basically whenever a
|
||||
// datamanipulator calls the API and wants the dataTable in return, see callApiAndReturnDataTable().
|
||||
// it is also not set for some settings API request etc.
|
||||
if (empty($this->apiModule) || empty($this->apiMethod)) {
|
||||
return $table;
|
||||
}
|
||||
|
||||
try {
|
||||
return $this->manipulate($table);
|
||||
} catch(\Exception $e) {
|
||||
// eg. requests with idSubtable may trigger this exception
|
||||
// (where idSubtable was removed in
|
||||
// ?module=API&method=Events.getNameFromCategoryId&idSubtable=1&secondaryDimension=eventName&format=XML&idSite=1&period=day&date=yesterday&flat=0
|
||||
return $table;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds ratio metrics if possible.
|
||||
*
|
||||
* @param DataTable $dataTable
|
||||
* @return DataTable
|
||||
*/
|
||||
protected function manipulateDataTable($dataTable)
|
||||
{
|
||||
$report = $this->findCurrentReport();
|
||||
|
||||
if (!empty($report) && empty($report['dimension'])) {
|
||||
// we currently do not calculate the total value for reports having no dimension
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
// Array [readableMetric] => [summed value]
|
||||
$totalValues = array();
|
||||
|
||||
$firstLevelTable = $this->makeSureToWorkOnFirstLevelDataTable($dataTable);
|
||||
$metricsToCalculate = Metrics::getMetricIdsToProcessReportTotal();
|
||||
|
||||
foreach ($metricsToCalculate as $metricId) {
|
||||
if (!$this->hasDataTableMetric($firstLevelTable, $metricId)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($firstLevelTable->getRows() as $row) {
|
||||
$totalValues = $this->sumColumnValueToTotal($row, $metricId, $totalValues);
|
||||
}
|
||||
}
|
||||
|
||||
$dataTable->setMetadata('totals', $totalValues);
|
||||
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
private function hasDataTableMetric(DataTable $dataTable, $metricId)
|
||||
{
|
||||
$firstRow = $dataTable->getFirstRow();
|
||||
|
||||
if (empty($firstRow)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (false === $this->getColumn($firstRow, $metricId)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns column from a given row.
|
||||
* Will work with 2 types of datatable
|
||||
* - raw datatables coming from the archive DB, which columns are int indexed
|
||||
* - datatables processed resulting of API calls, which columns have human readable english names
|
||||
*
|
||||
* @param Row|array $row
|
||||
* @param int $columnIdRaw see consts in Metrics::
|
||||
* @return mixed Value of column, false if not found
|
||||
*/
|
||||
private function getColumn($row, $columnIdRaw)
|
||||
{
|
||||
$columnIdReadable = Metrics::getReadableColumnName($columnIdRaw);
|
||||
|
||||
if ($row instanceof Row) {
|
||||
$raw = $row->getColumn($columnIdRaw);
|
||||
if ($raw !== false) {
|
||||
return $raw;
|
||||
}
|
||||
|
||||
return $row->getColumn($columnIdReadable);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private function makeSureToWorkOnFirstLevelDataTable($table)
|
||||
{
|
||||
if (!array_key_exists('idSubtable', $this->request)) {
|
||||
return $table;
|
||||
}
|
||||
|
||||
$firstLevelReport = $this->findFirstLevelReport();
|
||||
|
||||
if (empty($firstLevelReport)) {
|
||||
// it is not a subtable report
|
||||
$module = $this->apiModule;
|
||||
$action = $this->apiMethod;
|
||||
} else {
|
||||
$module = $firstLevelReport['module'];
|
||||
$action = $firstLevelReport['action'];
|
||||
}
|
||||
|
||||
$request = $this->request;
|
||||
|
||||
/** @var \Piwik\Period $period */
|
||||
$period = $table->getMetadata('period');
|
||||
|
||||
if (!empty($period)) {
|
||||
// we want a dataTable, not a dataTable\map
|
||||
if (Period::isMultiplePeriod($request['date'], $request['period']) || 'range' == $period->getLabel()) {
|
||||
$request['date'] = $period->getRangeString();
|
||||
$request['period'] = 'range';
|
||||
} else {
|
||||
$request['date'] = $period->getDateStart()->toString();
|
||||
$request['period'] = $period->getLabel();
|
||||
}
|
||||
}
|
||||
|
||||
return $this->callApiAndReturnDataTable($module, $action, $request);
|
||||
}
|
||||
|
||||
private function sumColumnValueToTotal(Row $row, $metricId, $totalValues)
|
||||
{
|
||||
$value = $this->getColumn($row, $metricId);
|
||||
|
||||
if (false === $value) {
|
||||
|
||||
return $totalValues;
|
||||
}
|
||||
|
||||
$metricName = Metrics::getReadableColumnName($metricId);
|
||||
|
||||
if (array_key_exists($metricName, $totalValues)) {
|
||||
$totalValues[$metricName] += $value;
|
||||
} else {
|
||||
$totalValues[$metricName] = $value;
|
||||
}
|
||||
|
||||
return $totalValues;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure to get all rows of the first level table.
|
||||
*
|
||||
* @param array $request
|
||||
*/
|
||||
protected function manipulateSubtableRequest($request)
|
||||
{
|
||||
$request['totals'] = 0;
|
||||
$request['expanded'] = 0;
|
||||
$request['filter_limit'] = -1;
|
||||
$request['filter_offset'] = 0;
|
||||
|
||||
$parametersToRemove = array('flat');
|
||||
|
||||
if (!array_key_exists('idSubtable', $this->request)) {
|
||||
$parametersToRemove[] = 'idSubtable';
|
||||
}
|
||||
|
||||
foreach ($parametersToRemove as $param) {
|
||||
if (array_key_exists($param, $request)) {
|
||||
unset($request[$param]);
|
||||
}
|
||||
}
|
||||
return $request;
|
||||
}
|
||||
|
||||
private function getReportMetadata()
|
||||
{
|
||||
if (!empty(static::$reportMetadata)) {
|
||||
return static::$reportMetadata;
|
||||
}
|
||||
|
||||
static::$reportMetadata = API::getInstance()->getReportMetadata();
|
||||
|
||||
return static::$reportMetadata;
|
||||
}
|
||||
|
||||
private function findCurrentReport()
|
||||
{
|
||||
foreach ($this->getReportMetadata() as $report) {
|
||||
if ($this->apiMethod == $report['action']
|
||||
&& $this->apiModule == $report['module']) {
|
||||
|
||||
return $report;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private function findFirstLevelReport()
|
||||
{
|
||||
foreach ($this->getReportMetadata() as $report) {
|
||||
if (!empty($report['actionToLoadSubTables'])
|
||||
&& $this->apiMethod == $report['actionToLoadSubTables']
|
||||
&& $this->apiModule == $report['module']
|
||||
) {
|
||||
|
||||
return $report;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
238
www/analytics/core/API/DocumentationGenerator.php
Normal file
238
www/analytics/core/API/DocumentationGenerator.php
Normal file
|
|
@ -0,0 +1,238 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API;
|
||||
|
||||
use Exception;
|
||||
use Piwik\Common;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\Url;
|
||||
|
||||
class DocumentationGenerator
|
||||
{
|
||||
protected $modulesToHide = array('CoreAdminHome', 'DBStats');
|
||||
protected $countPluginsLoaded = 0;
|
||||
|
||||
/**
|
||||
* trigger loading all plugins with an API.php file in the Proxy
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
$plugins = \Piwik\Plugin\Manager::getInstance()->getLoadedPluginsName();
|
||||
foreach ($plugins as $plugin) {
|
||||
try {
|
||||
$className = Request::getClassNameAPI($plugin);
|
||||
Proxy::getInstance()->registerClass($className);
|
||||
} catch (Exception $e) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a HTML page containing help for all the successfully loaded APIs.
|
||||
* For each module it will return a mini help with the method names, parameters to give,
|
||||
* links to get the result in Xml/Csv/etc
|
||||
*
|
||||
* @param bool $outputExampleUrls
|
||||
* @param string $prefixUrls
|
||||
* @return string
|
||||
*/
|
||||
public function getAllInterfaceString($outputExampleUrls = true, $prefixUrls = '')
|
||||
{
|
||||
if (!empty($prefixUrls)) {
|
||||
$prefixUrls = 'http://demo.piwik.org/';
|
||||
}
|
||||
$str = $toc = '';
|
||||
$token_auth = "&token_auth=" . Piwik::getCurrentUserTokenAuth();
|
||||
$parametersToSet = array(
|
||||
'idSite' => Common::getRequestVar('idSite', 1, 'int'),
|
||||
'period' => Common::getRequestVar('period', 'day', 'string'),
|
||||
'date' => Common::getRequestVar('date', 'today', 'string')
|
||||
);
|
||||
|
||||
foreach (Proxy::getInstance()->getMetadata() as $class => $info) {
|
||||
$moduleName = Proxy::getInstance()->getModuleNameFromClassName($class);
|
||||
if (in_array($moduleName, $this->modulesToHide)) {
|
||||
continue;
|
||||
}
|
||||
$toc .= "<a href='#$moduleName'>$moduleName</a><br/>";
|
||||
$str .= "\n<a name='$moduleName' id='$moduleName'></a><h2>Module " . $moduleName . "</h2>";
|
||||
$str .= "<div class='apiDescription'> " . $info['__documentation'] . " </div>";
|
||||
foreach ($info as $methodName => $infoMethod) {
|
||||
if ($methodName == '__documentation') {
|
||||
continue;
|
||||
}
|
||||
$params = $this->getParametersString($class, $methodName);
|
||||
$str .= "\n <div class='apiMethod'>- <b>$moduleName.$methodName </b>" . $params . "";
|
||||
$str .= '<small>';
|
||||
|
||||
if ($outputExampleUrls) {
|
||||
// we prefix all URLs with $prefixUrls
|
||||
// used when we include this output in the Piwik official documentation for example
|
||||
$str .= "<span class=\"example\">";
|
||||
$exampleUrl = $this->getExampleUrl($class, $methodName, $parametersToSet);
|
||||
if ($exampleUrl !== false) {
|
||||
$lastNUrls = '';
|
||||
if (preg_match('/(&period)|(&date)/', $exampleUrl)) {
|
||||
$exampleUrlRss1 = $prefixUrls . $this->getExampleUrl($class, $methodName, array('date' => 'last10', 'period' => 'day') + $parametersToSet);
|
||||
$exampleUrlRss2 = $prefixUrls . $this->getExampleUrl($class, $methodName, array('date' => 'last5', 'period' => 'week',) + $parametersToSet);
|
||||
$lastNUrls = ", RSS of the last <a target=_blank href='$exampleUrlRss1&format=rss$token_auth&translateColumnNames=1'>10 days</a>";
|
||||
}
|
||||
$exampleUrl = $prefixUrls . $exampleUrl;
|
||||
$str .= " [ Example in
|
||||
<a target=_blank href='$exampleUrl&format=xml$token_auth'>XML</a>,
|
||||
<a target=_blank href='$exampleUrl&format=JSON$token_auth'>Json</a>,
|
||||
<a target=_blank href='$exampleUrl&format=Tsv$token_auth&translateColumnNames=1'>Tsv (Excel)</a>
|
||||
$lastNUrls
|
||||
]";
|
||||
} else {
|
||||
$str .= " [ No example available ]";
|
||||
}
|
||||
$str .= "</span>";
|
||||
}
|
||||
$str .= '</small>';
|
||||
$str .= "</div>\n";
|
||||
}
|
||||
$str .= '<div style="margin:15px;"><a href="#topApiRef">↑ Back to top</a></div>';
|
||||
}
|
||||
|
||||
$str = "<h2 id='topApiRef' name='topApiRef'>Quick access to APIs</h2>
|
||||
$toc
|
||||
$str";
|
||||
return $str;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string containing links to examples on how to call a given method on a given API
|
||||
* It will export links to XML, CSV, HTML, JSON, PHP, etc.
|
||||
* It will not export links for methods such as deleteSite or deleteUser
|
||||
*
|
||||
* @param string $class the class
|
||||
* @param string $methodName the method
|
||||
* @param array $parametersToSet parameters to set
|
||||
* @return string|bool when not possible
|
||||
*/
|
||||
public function getExampleUrl($class, $methodName, $parametersToSet = array())
|
||||
{
|
||||
$knowExampleDefaultParametersValues = array(
|
||||
'access' => 'view',
|
||||
'userLogin' => 'test',
|
||||
'passwordMd5ied' => 'passwordExample',
|
||||
'email' => 'test@example.org',
|
||||
|
||||
'languageCode' => 'fr',
|
||||
'url' => 'http://forum.piwik.org/',
|
||||
'pageUrl' => 'http://forum.piwik.org/',
|
||||
'apiModule' => 'UserCountry',
|
||||
'apiAction' => 'getCountry',
|
||||
'lastMinutes' => '30',
|
||||
'abandonedCarts' => '0',
|
||||
'segmentName' => 'pageTitle',
|
||||
'ip' => '194.57.91.215',
|
||||
'idSites' => '1,2',
|
||||
'idAlert' => '1',
|
||||
// 'segmentName' => 'browserCode',
|
||||
);
|
||||
|
||||
foreach ($parametersToSet as $name => $value) {
|
||||
$knowExampleDefaultParametersValues[$name] = $value;
|
||||
}
|
||||
|
||||
// no links for these method names
|
||||
$doNotPrintExampleForTheseMethods = array(
|
||||
//Sites
|
||||
'deleteSite',
|
||||
'addSite',
|
||||
'updateSite',
|
||||
'addSiteAliasUrls',
|
||||
//Users
|
||||
'deleteUser',
|
||||
'addUser',
|
||||
'updateUser',
|
||||
'setUserAccess',
|
||||
//Goals
|
||||
'addGoal',
|
||||
'updateGoal',
|
||||
'deleteGoal',
|
||||
);
|
||||
|
||||
if (in_array($methodName, $doNotPrintExampleForTheseMethods)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// we try to give an URL example to call the API
|
||||
$aParameters = Proxy::getInstance()->getParametersList($class, $methodName);
|
||||
// Kindly force some known generic parameters to appear in the final list
|
||||
// the parameter 'format' can be set to all API methods (used in tests)
|
||||
// the parameter 'hideIdSubDatable' is used for integration tests only
|
||||
// the parameter 'serialize' sets php outputs human readable, used in integration tests and debug
|
||||
// the parameter 'language' sets the language for the response (eg. country names)
|
||||
// the parameter 'flat' reduces a hierarchical table to a single level by concatenating labels
|
||||
// the parameter 'include_aggregate_rows' can be set to include inner nodes in flat reports
|
||||
// the parameter 'translateColumnNames' can be set to translate metric names in csv/tsv exports
|
||||
$aParameters['format'] = false;
|
||||
$aParameters['hideIdSubDatable'] = false;
|
||||
$aParameters['serialize'] = false;
|
||||
$aParameters['language'] = false;
|
||||
$aParameters['translateColumnNames'] = false;
|
||||
$aParameters['label'] = false;
|
||||
$aParameters['flat'] = false;
|
||||
$aParameters['include_aggregate_rows'] = false;
|
||||
$aParameters['filter_limit'] = false; //@review without adding this, I can not set filter_limit in $otherRequestParameters integration tests
|
||||
$aParameters['filter_sort_column'] = false; //@review without adding this, I can not set filter_sort_column in $otherRequestParameters integration tests
|
||||
$aParameters['filter_truncate'] = false;
|
||||
$aParameters['hideColumns'] = false;
|
||||
$aParameters['showColumns'] = false;
|
||||
$aParameters['filter_pattern_recursive'] = false;
|
||||
|
||||
$moduleName = Proxy::getInstance()->getModuleNameFromClassName($class);
|
||||
$aParameters = array_merge(array('module' => 'API', 'method' => $moduleName . '.' . $methodName), $aParameters);
|
||||
|
||||
foreach ($aParameters as $nameVariable => &$defaultValue) {
|
||||
if (isset($knowExampleDefaultParametersValues[$nameVariable])) {
|
||||
$defaultValue = $knowExampleDefaultParametersValues[$nameVariable];
|
||||
} // if there isn't a default value for a given parameter,
|
||||
// we need a 'know default value' or we can't generate the link
|
||||
elseif ($defaultValue instanceof NoDefaultValue) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return '?' . Url::getQueryStringFromParameters($aParameters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the methods $class.$name parameters (and default value if provided) as a string.
|
||||
*
|
||||
* @param string $class The class name
|
||||
* @param string $name The method name
|
||||
* @return string For example "(idSite, period, date = 'today')"
|
||||
*/
|
||||
public function getParametersString($class, $name)
|
||||
{
|
||||
$aParameters = Proxy::getInstance()->getParametersList($class, $name);
|
||||
$asParameters = array();
|
||||
foreach ($aParameters as $nameVariable => $defaultValue) {
|
||||
// Do not show API parameters starting with _
|
||||
// They are supposed to be used only in internal API calls
|
||||
if (strpos($nameVariable, '_') === 0) {
|
||||
continue;
|
||||
}
|
||||
$str = $nameVariable;
|
||||
if (!($defaultValue instanceof NoDefaultValue)) {
|
||||
if (is_array($defaultValue)) {
|
||||
$str .= " = 'Array'";
|
||||
} else {
|
||||
$str .= " = '$defaultValue'";
|
||||
}
|
||||
}
|
||||
$asParameters[] = $str;
|
||||
}
|
||||
$sParameters = implode(", ", $asParameters);
|
||||
return "($sParameters)";
|
||||
}
|
||||
}
|
||||
514
www/analytics/core/API/Proxy.php
Normal file
514
www/analytics/core/API/Proxy.php
Normal file
|
|
@ -0,0 +1,514 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
|
||||
namespace Piwik\API;
|
||||
|
||||
use Exception;
|
||||
use Piwik\Common;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\Singleton;
|
||||
use ReflectionClass;
|
||||
use ReflectionMethod;
|
||||
|
||||
/**
|
||||
* Proxy is a singleton that has the knowledge of every method available, their parameters
|
||||
* and default values.
|
||||
* Proxy receives all the API calls requests via call() and forwards them to the right
|
||||
* object, with the parameters in the right order.
|
||||
*
|
||||
* It will also log the performance of API calls (time spent, parameter values, etc.) if logger available
|
||||
*
|
||||
* @method static \Piwik\API\Proxy getInstance()
|
||||
*/
|
||||
class Proxy extends Singleton
|
||||
{
|
||||
// array of already registered plugins names
|
||||
protected $alreadyRegistered = array();
|
||||
|
||||
private $metadataArray = array();
|
||||
private $hideIgnoredFunctions = true;
|
||||
|
||||
// when a parameter doesn't have a default value we use this
|
||||
private $noDefaultValue;
|
||||
|
||||
/**
|
||||
* protected constructor
|
||||
*/
|
||||
protected function __construct()
|
||||
{
|
||||
$this->noDefaultValue = new NoDefaultValue();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns array containing reflection meta data for all the loaded classes
|
||||
* eg. number of parameters, method names, etc.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getMetadata()
|
||||
{
|
||||
ksort($this->metadataArray);
|
||||
return $this->metadataArray;
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers the API information of a given module.
|
||||
*
|
||||
* The module to be registered must be
|
||||
* - a singleton (providing a getInstance() method)
|
||||
* - the API file must be located in plugins/ModuleName/API.php
|
||||
* for example plugins/Referrers/API.php
|
||||
*
|
||||
* The method will introspect the methods, their parameters, etc.
|
||||
*
|
||||
* @param string $className ModuleName eg. "API"
|
||||
*/
|
||||
public function registerClass($className)
|
||||
{
|
||||
if (isset($this->alreadyRegistered[$className])) {
|
||||
return;
|
||||
}
|
||||
$this->includeApiFile($className);
|
||||
$this->checkClassIsSingleton($className);
|
||||
|
||||
$rClass = new ReflectionClass($className);
|
||||
foreach ($rClass->getMethods() as $method) {
|
||||
$this->loadMethodMetadata($className, $method);
|
||||
}
|
||||
|
||||
$this->setDocumentation($rClass, $className);
|
||||
$this->alreadyRegistered[$className] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Will be displayed in the API page
|
||||
*
|
||||
* @param ReflectionClass $rClass Instance of ReflectionClass
|
||||
* @param string $className Name of the class
|
||||
*/
|
||||
private function setDocumentation($rClass, $className)
|
||||
{
|
||||
// Doc comment
|
||||
$doc = $rClass->getDocComment();
|
||||
$doc = str_replace(" * " . PHP_EOL, "<br>", $doc);
|
||||
|
||||
// boldify the first line only if there is more than one line, otherwise too much bold
|
||||
if (substr_count($doc, '<br>') > 1) {
|
||||
$firstLineBreak = strpos($doc, "<br>");
|
||||
$doc = "<div class='apiFirstLine'>" . substr($doc, 0, $firstLineBreak) . "</div>" . substr($doc, $firstLineBreak + strlen("<br>"));
|
||||
}
|
||||
$doc = preg_replace("/(@package)[a-z _A-Z]*/", "", $doc);
|
||||
$doc = preg_replace("/(@method).*/", "", $doc);
|
||||
$doc = str_replace(array("\t", "\n", "/**", "*/", " * ", " *", " ", "\t*", " * @package"), " ", $doc);
|
||||
$this->metadataArray[$className]['__documentation'] = $doc;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns number of classes already loaded
|
||||
* @return int
|
||||
*/
|
||||
public function getCountRegisteredClasses()
|
||||
{
|
||||
return count($this->alreadyRegistered);
|
||||
}
|
||||
|
||||
/**
|
||||
* Will execute $className->$methodName($parametersValues)
|
||||
* If any error is detected (wrong number of parameters, method not found, class not found, etc.)
|
||||
* it will throw an exception
|
||||
*
|
||||
* It also logs the API calls, with the parameters values, the returned value, the performance, etc.
|
||||
* You can enable logging in config/global.ini.php (log_api_call)
|
||||
*
|
||||
* @param string $className The class name (eg. API)
|
||||
* @param string $methodName The method name
|
||||
* @param array $parametersRequest The parameters pairs (name=>value)
|
||||
*
|
||||
* @return mixed|null
|
||||
* @throws Exception|\Piwik\NoAccessException
|
||||
*/
|
||||
public function call($className, $methodName, $parametersRequest)
|
||||
{
|
||||
$returnedValue = null;
|
||||
|
||||
// Temporarily sets the Request array to this API call context
|
||||
$saveGET = $_GET;
|
||||
$saveQUERY_STRING = @$_SERVER['QUERY_STRING'];
|
||||
foreach ($parametersRequest as $param => $value) {
|
||||
$_GET[$param] = $value;
|
||||
}
|
||||
|
||||
try {
|
||||
$this->registerClass($className);
|
||||
|
||||
// instanciate the object
|
||||
$object = $className::getInstance();
|
||||
|
||||
// check method exists
|
||||
$this->checkMethodExists($className, $methodName);
|
||||
|
||||
// get the list of parameters required by the method
|
||||
$parameterNamesDefaultValues = $this->getParametersList($className, $methodName);
|
||||
|
||||
// load parameters in the right order, etc.
|
||||
$finalParameters = $this->getRequestParametersArray($parameterNamesDefaultValues, $parametersRequest);
|
||||
|
||||
// allow plugins to manipulate the value
|
||||
$pluginName = $this->getModuleNameFromClassName($className);
|
||||
|
||||
/**
|
||||
* Triggered before an API request is dispatched.
|
||||
*
|
||||
* This event can be used to modify the arguments passed to one or more API methods.
|
||||
*
|
||||
* **Example**
|
||||
*
|
||||
* Piwik::addAction('API.Request.dispatch', function (&$parameters, $pluginName, $methodName) {
|
||||
* if ($pluginName == 'Actions') {
|
||||
* if ($methodName == 'getPageUrls') {
|
||||
* // ... do something ...
|
||||
* } else {
|
||||
* // ... do something else ...
|
||||
* }
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* @param array &$finalParameters List of parameters that will be passed to the API method.
|
||||
* @param string $pluginName The name of the plugin the API method belongs to.
|
||||
* @param string $methodName The name of the API method that will be called.
|
||||
*/
|
||||
Piwik::postEvent('API.Request.dispatch', array(&$finalParameters, $pluginName, $methodName));
|
||||
|
||||
/**
|
||||
* Triggered before an API request is dispatched.
|
||||
*
|
||||
* This event exists for convenience and is triggered directly after the {@hook API.Request.dispatch}
|
||||
* event is triggered. It can be used to modify the arguments passed to a **single** API method.
|
||||
*
|
||||
* _Note: This is can be accomplished with the {@hook API.Request.dispatch} event as well, however
|
||||
* event handlers for that event will have to do more work._
|
||||
*
|
||||
* **Example**
|
||||
*
|
||||
* Piwik::addAction('API.Actions.getPageUrls', function (&$parameters) {
|
||||
* // force use of a single website. for some reason.
|
||||
* $parameters['idSite'] = 1;
|
||||
* });
|
||||
*
|
||||
* @param array &$finalParameters List of parameters that will be passed to the API method.
|
||||
*/
|
||||
Piwik::postEvent(sprintf('API.%s.%s', $pluginName, $methodName), array(&$finalParameters));
|
||||
|
||||
// call the method
|
||||
$returnedValue = call_user_func_array(array($object, $methodName), $finalParameters);
|
||||
|
||||
$endHookParams = array(
|
||||
&$returnedValue,
|
||||
array('className' => $className,
|
||||
'module' => $pluginName,
|
||||
'action' => $methodName,
|
||||
'parameters' => $finalParameters)
|
||||
);
|
||||
|
||||
/**
|
||||
* Triggered directly after an API request is dispatched.
|
||||
*
|
||||
* This event exists for convenience and is triggered immediately before the
|
||||
* {@hook API.Request.dispatch.end} event. It can be used to modify the output of a **single**
|
||||
* API method.
|
||||
*
|
||||
* _Note: This can be accomplished with the {@hook API.Request.dispatch.end} event as well,
|
||||
* however event handlers for that event will have to do more work._
|
||||
*
|
||||
* **Example**
|
||||
*
|
||||
* // append (0 hits) to the end of row labels whose row has 0 hits
|
||||
* Piwik::addAction('API.Actions.getPageUrls', function (&$returnValue, $info)) {
|
||||
* $returnValue->filter('ColumnCallbackReplace', 'label', function ($label, $hits) {
|
||||
* if ($hits === 0) {
|
||||
* return $label . " (0 hits)";
|
||||
* } else {
|
||||
* return $label;
|
||||
* }
|
||||
* }, null, array('nb_hits'));
|
||||
* }
|
||||
*
|
||||
* @param mixed &$returnedValue The API method's return value. Can be an object, such as a
|
||||
* {@link Piwik\DataTable DataTable} instance.
|
||||
* could be a {@link Piwik\DataTable DataTable}.
|
||||
* @param array $extraInfo An array holding information regarding the API request. Will
|
||||
* contain the following data:
|
||||
*
|
||||
* - **className**: The namespace-d class name of the API instance
|
||||
* that's being called.
|
||||
* - **module**: The name of the plugin the API request was
|
||||
* dispatched to.
|
||||
* - **action**: The name of the API method that was executed.
|
||||
* - **parameters**: The array of parameters passed to the API
|
||||
* method.
|
||||
*/
|
||||
Piwik::postEvent(sprintf('API.%s.%s.end', $pluginName, $methodName), $endHookParams);
|
||||
|
||||
/**
|
||||
* Triggered directly after an API request is dispatched.
|
||||
*
|
||||
* This event can be used to modify the output of any API method.
|
||||
*
|
||||
* **Example**
|
||||
*
|
||||
* // append (0 hits) to the end of row labels whose row has 0 hits for any report that has the 'nb_hits' metric
|
||||
* Piwik::addAction('API.Actions.getPageUrls', function (&$returnValue, $info)) {
|
||||
* // don't process non-DataTable reports and reports that don't have the nb_hits column
|
||||
* if (!($returnValue instanceof DataTableInterface)
|
||||
* || in_array('nb_hits', $returnValue->getColumns())
|
||||
* ) {
|
||||
* return;
|
||||
* }
|
||||
*
|
||||
* $returnValue->filter('ColumnCallbackReplace', 'label', function ($label, $hits) {
|
||||
* if ($hits === 0) {
|
||||
* return $label . " (0 hits)";
|
||||
* } else {
|
||||
* return $label;
|
||||
* }
|
||||
* }, null, array('nb_hits'));
|
||||
* }
|
||||
*
|
||||
* @param mixed &$returnedValue The API method's return value. Can be an object, such as a
|
||||
* {@link Piwik\DataTable DataTable} instance.
|
||||
* @param array $extraInfo An array holding information regarding the API request. Will
|
||||
* contain the following data:
|
||||
*
|
||||
* - **className**: The namespace-d class name of the API instance
|
||||
* that's being called.
|
||||
* - **module**: The name of the plugin the API request was
|
||||
* dispatched to.
|
||||
* - **action**: The name of the API method that was executed.
|
||||
* - **parameters**: The array of parameters passed to the API
|
||||
* method.
|
||||
*/
|
||||
Piwik::postEvent('API.Request.dispatch.end', $endHookParams);
|
||||
|
||||
// Restore the request
|
||||
$_GET = $saveGET;
|
||||
$_SERVER['QUERY_STRING'] = $saveQUERY_STRING;
|
||||
} catch (Exception $e) {
|
||||
$_GET = $saveGET;
|
||||
throw $e;
|
||||
}
|
||||
|
||||
return $returnedValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the parameters names and default values for the method $name
|
||||
* of the class $class
|
||||
*
|
||||
* @param string $class The class name
|
||||
* @param string $name The method name
|
||||
* @return array Format array(
|
||||
* 'testParameter' => null, // no default value
|
||||
* 'life' => 42, // default value = 42
|
||||
* 'date' => 'yesterday',
|
||||
* );
|
||||
*/
|
||||
public function getParametersList($class, $name)
|
||||
{
|
||||
return $this->metadataArray[$class][$name]['parameters'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the 'moduleName' part of '\\Piwik\\Plugins\\moduleName\\API'
|
||||
*
|
||||
* @param string $className "API"
|
||||
* @return string "Referrers"
|
||||
*/
|
||||
public function getModuleNameFromClassName($className)
|
||||
{
|
||||
return str_replace(array('\\Piwik\\Plugins\\', '\\API'), '', $className);
|
||||
}
|
||||
|
||||
public function isExistingApiAction($pluginName, $apiAction)
|
||||
{
|
||||
$namespacedApiClassName = "\\Piwik\\Plugins\\$pluginName\\API";
|
||||
$api = $namespacedApiClassName::getInstance();
|
||||
|
||||
return method_exists($api, $apiAction);
|
||||
}
|
||||
|
||||
public function buildApiActionName($pluginName, $apiAction)
|
||||
{
|
||||
return sprintf("%s.%s", $pluginName, $apiAction);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets whether to hide '@ignore'd functions from method metadata or not.
|
||||
*
|
||||
* @param bool $hideIgnoredFunctions
|
||||
*/
|
||||
public function setHideIgnoredFunctions($hideIgnoredFunctions)
|
||||
{
|
||||
$this->hideIgnoredFunctions = $hideIgnoredFunctions;
|
||||
|
||||
// make sure metadata gets reloaded
|
||||
$this->alreadyRegistered = array();
|
||||
$this->metadataArray = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array containing the values of the parameters to pass to the method to call
|
||||
*
|
||||
* @param array $requiredParameters array of (parameter name, default value)
|
||||
* @param array $parametersRequest
|
||||
* @throws Exception
|
||||
* @return array values to pass to the function call
|
||||
*/
|
||||
private function getRequestParametersArray($requiredParameters, $parametersRequest)
|
||||
{
|
||||
$finalParameters = array();
|
||||
foreach ($requiredParameters as $name => $defaultValue) {
|
||||
try {
|
||||
if ($defaultValue instanceof NoDefaultValue) {
|
||||
$requestValue = Common::getRequestVar($name, null, null, $parametersRequest);
|
||||
} else {
|
||||
try {
|
||||
|
||||
if ($name == 'segment' && !empty($parametersRequest['segment'])) {
|
||||
// segment parameter is an exception: we do not want to sanitize user input or it would break the segment encoding
|
||||
$requestValue = ($parametersRequest['segment']);
|
||||
} else {
|
||||
$requestValue = Common::getRequestVar($name, $defaultValue, null, $parametersRequest);
|
||||
}
|
||||
} catch (Exception $e) {
|
||||
// Special case: empty parameter in the URL, should return the empty string
|
||||
if (isset($parametersRequest[$name])
|
||||
&& $parametersRequest[$name] === ''
|
||||
) {
|
||||
$requestValue = '';
|
||||
} else {
|
||||
$requestValue = $defaultValue;
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (Exception $e) {
|
||||
throw new Exception(Piwik::translate('General_PleaseSpecifyValue', array($name)));
|
||||
}
|
||||
$finalParameters[] = $requestValue;
|
||||
}
|
||||
return $finalParameters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Includes the class API by looking up plugins/UserSettings/API.php
|
||||
*
|
||||
* @param string $fileName api class name eg. "API"
|
||||
* @throws Exception
|
||||
*/
|
||||
private function includeApiFile($fileName)
|
||||
{
|
||||
$module = self::getModuleNameFromClassName($fileName);
|
||||
$path = PIWIK_INCLUDE_PATH . '/plugins/' . $module . '/API.php';
|
||||
|
||||
if (is_readable($path)) {
|
||||
require_once $path; // prefixed by PIWIK_INCLUDE_PATH
|
||||
} else {
|
||||
throw new Exception("API module $module not found.");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $class name of a class
|
||||
* @param ReflectionMethod $method instance of ReflectionMethod
|
||||
*/
|
||||
private function loadMethodMetadata($class, $method)
|
||||
{
|
||||
if ($method->isPublic()
|
||||
&& !$method->isConstructor()
|
||||
&& $method->getName() != 'getInstance'
|
||||
&& false === strstr($method->getDocComment(), '@deprecated')
|
||||
&& (!$this->hideIgnoredFunctions || false === strstr($method->getDocComment(), '@ignore'))
|
||||
) {
|
||||
$name = $method->getName();
|
||||
$parameters = $method->getParameters();
|
||||
|
||||
$aParameters = array();
|
||||
foreach ($parameters as $parameter) {
|
||||
$nameVariable = $parameter->getName();
|
||||
|
||||
$defaultValue = $this->noDefaultValue;
|
||||
if ($parameter->isDefaultValueAvailable()) {
|
||||
$defaultValue = $parameter->getDefaultValue();
|
||||
}
|
||||
|
||||
$aParameters[$nameVariable] = $defaultValue;
|
||||
}
|
||||
$this->metadataArray[$class][$name]['parameters'] = $aParameters;
|
||||
$this->metadataArray[$class][$name]['numberOfRequiredParameters'] = $method->getNumberOfRequiredParameters();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks that the method exists in the class
|
||||
*
|
||||
* @param string $className The class name
|
||||
* @param string $methodName The method name
|
||||
* @throws Exception If the method is not found
|
||||
*/
|
||||
private function checkMethodExists($className, $methodName)
|
||||
{
|
||||
if (!$this->isMethodAvailable($className, $methodName)) {
|
||||
throw new Exception(Piwik::translate('General_ExceptionMethodNotFound', array($methodName, $className)));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of required parameters (parameters without default values).
|
||||
*
|
||||
* @param string $class The class name
|
||||
* @param string $name The method name
|
||||
* @return int The number of required parameters
|
||||
*/
|
||||
private function getNumberOfRequiredParameters($class, $name)
|
||||
{
|
||||
return $this->metadataArray[$class][$name]['numberOfRequiredParameters'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the method is found in the API of the given class name.
|
||||
*
|
||||
* @param string $className The class name
|
||||
* @param string $methodName The method name
|
||||
* @return bool
|
||||
*/
|
||||
private function isMethodAvailable($className, $methodName)
|
||||
{
|
||||
return isset($this->metadataArray[$className][$methodName]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks that the class is a Singleton (presence of the getInstance() method)
|
||||
*
|
||||
* @param string $className The class name
|
||||
* @throws Exception If the class is not a Singleton
|
||||
*/
|
||||
private function checkClassIsSingleton($className)
|
||||
{
|
||||
if (!method_exists($className, "getInstance")) {
|
||||
throw new Exception("$className that provide an API must be Singleton and have a 'static public function getInstance()' method.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* To differentiate between "no value" and default value of null
|
||||
*
|
||||
*/
|
||||
class NoDefaultValue
|
||||
{
|
||||
}
|
||||
398
www/analytics/core/API/Request.php
Normal file
398
www/analytics/core/API/Request.php
Normal file
|
|
@ -0,0 +1,398 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API;
|
||||
|
||||
use Exception;
|
||||
use Piwik\Access;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable;
|
||||
use Piwik\Piwik;
|
||||
use Piwik\PluginDeactivatedException;
|
||||
use Piwik\SettingsServer;
|
||||
use Piwik\Url;
|
||||
use Piwik\UrlHelper;
|
||||
|
||||
/**
|
||||
* Dispatches API requests to the appropriate API method.
|
||||
*
|
||||
* The Request class is used throughout Piwik to call API methods. The difference
|
||||
* between using Request and calling API methods directly is that Request
|
||||
* will do more after calling the API including: applying generic filters, applying queued filters,
|
||||
* and handling the **flat** and **label** query parameters.
|
||||
*
|
||||
* Additionally, the Request class will **forward current query parameters** to the request
|
||||
* which is more convenient than calling {@link Piwik\Common::getRequestVar()} many times over.
|
||||
*
|
||||
* In most cases, using a Request object to query the API is the correct approach.
|
||||
*
|
||||
* ### Post-processing
|
||||
*
|
||||
* The return value of API methods undergo some extra processing before being returned by Request.
|
||||
* To learn more about what happens to API results, read [this](/guides/piwiks-web-api#extra-report-processing).
|
||||
*
|
||||
* ### Output Formats
|
||||
*
|
||||
* The value returned by Request will be serialized to a certain format before being returned.
|
||||
* To see the list of supported output formats, read [this](/guides/piwiks-web-api#output-formats).
|
||||
*
|
||||
* ### Examples
|
||||
*
|
||||
* **Basic Usage**
|
||||
*
|
||||
* $request = new Request('method=UserSettings.getWideScreen&idSite=1&date=yesterday&period=week'
|
||||
* . '&format=xml&filter_limit=5&filter_offset=0')
|
||||
* $result = $request->process();
|
||||
* echo $result;
|
||||
*
|
||||
* **Getting a unrendered DataTable**
|
||||
*
|
||||
* // use the convenience method 'processRequest'
|
||||
* $dataTable = Request::processRequest('UserSettings.getWideScreen', array(
|
||||
* 'idSite' => 1,
|
||||
* 'date' => 'yesterday',
|
||||
* 'period' => 'week',
|
||||
* 'filter_limit' => 5,
|
||||
* 'filter_offset' => 0
|
||||
*
|
||||
* 'format' => 'original', // this is the important bit
|
||||
* ));
|
||||
* echo "This DataTable has " . $dataTable->getRowsCount() . " rows.";
|
||||
*
|
||||
* @see http://piwik.org/docs/analytics-api
|
||||
* @api
|
||||
*/
|
||||
class Request
|
||||
{
|
||||
protected $request = null;
|
||||
|
||||
/**
|
||||
* Converts the supplied request string into an array of query paramater name/value
|
||||
* mappings. The current query parameters (everything in `$_GET` and `$_POST`) are
|
||||
* forwarded to request array before it is returned.
|
||||
*
|
||||
* @param string|array $request The base request string or array, eg,
|
||||
* `'module=UserSettings&action=getWidescreen'`.
|
||||
* @return array
|
||||
*/
|
||||
static public function getRequestArrayFromString($request)
|
||||
{
|
||||
$defaultRequest = $_GET + $_POST;
|
||||
|
||||
$requestRaw = self::getRequestParametersGET();
|
||||
if (!empty($requestRaw['segment'])) {
|
||||
$defaultRequest['segment'] = $requestRaw['segment'];
|
||||
}
|
||||
|
||||
$requestArray = $defaultRequest;
|
||||
|
||||
if (!is_null($request)) {
|
||||
if (is_array($request)) {
|
||||
$url = array();
|
||||
foreach ($request as $key => $value) {
|
||||
$url[] = $key . "=" . $value;
|
||||
}
|
||||
$request = implode("&", $url);
|
||||
}
|
||||
|
||||
$request = trim($request);
|
||||
$request = str_replace(array("\n", "\t"), '', $request);
|
||||
|
||||
$requestParsed = UrlHelper::getArrayFromQueryString($request);
|
||||
$requestArray = $requestParsed + $defaultRequest;
|
||||
}
|
||||
|
||||
foreach ($requestArray as &$element) {
|
||||
if (!is_array($element)) {
|
||||
$element = trim($element);
|
||||
}
|
||||
}
|
||||
return $requestArray;
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string|array $request Query string that defines the API call (must at least contain a **method** parameter),
|
||||
* eg, `'method=UserSettings.getWideScreen&idSite=1&date=yesterday&period=week&format=xml'`
|
||||
* If a request is not provided, then we use the values in the `$_GET` and `$_POST`
|
||||
* superglobals.
|
||||
*/
|
||||
public function __construct($request = null)
|
||||
{
|
||||
$this->request = self::getRequestArrayFromString($request);
|
||||
$this->sanitizeRequest();
|
||||
}
|
||||
|
||||
/**
|
||||
* For backward compatibility: Piwik API still works if module=Referers,
|
||||
* we rewrite to correct renamed plugin: Referrers
|
||||
*
|
||||
* @param $module
|
||||
* @return string
|
||||
* @ignore
|
||||
*/
|
||||
public static function renameModule($module)
|
||||
{
|
||||
$moduleToRedirect = array(
|
||||
'Referers' => 'Referrers',
|
||||
'PDFReports' => 'ScheduledReports',
|
||||
);
|
||||
if (isset($moduleToRedirect[$module])) {
|
||||
return $moduleToRedirect[$module];
|
||||
}
|
||||
return $module;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure that the request contains no logical errors
|
||||
*/
|
||||
private function sanitizeRequest()
|
||||
{
|
||||
// The label filter does not work with expanded=1 because the data table IDs have a different meaning
|
||||
// depending on whether the table has been loaded yet. expanded=1 causes all tables to be loaded, which
|
||||
// is why the label filter can't descend when a recursive label has been requested.
|
||||
// To fix this, we remove the expanded parameter if a label parameter is set.
|
||||
if (isset($this->request['label']) && !empty($this->request['label'])
|
||||
&& isset($this->request['expanded']) && $this->request['expanded']
|
||||
) {
|
||||
unset($this->request['expanded']);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatches the API request to the appropriate API method and returns the result
|
||||
* after post-processing.
|
||||
*
|
||||
* Post-processing includes:
|
||||
*
|
||||
* - flattening if **flat** is 0
|
||||
* - running generic filters unless **disable_generic_filters** is set to 1
|
||||
* - URL decoding label column values
|
||||
* - running queued filters unless **disable_queued_filters** is set to 1
|
||||
* - removing columns based on the values of the **hideColumns** and **showColumns** query parameters
|
||||
* - filtering rows if the **label** query parameter is set
|
||||
* - converting the result to the appropriate format (ie, XML, JSON, etc.)
|
||||
*
|
||||
* If `'original'` is supplied for the output format, the result is returned as a PHP
|
||||
* object.
|
||||
*
|
||||
* @throws PluginDeactivatedException if the module plugin is not activated.
|
||||
* @throws Exception if the requested API method cannot be called, if required parameters for the
|
||||
* API method are missing or if the API method throws an exception and the **format**
|
||||
* query parameter is **original**.
|
||||
* @return DataTable|Map|string The data resulting from the API call.
|
||||
*/
|
||||
public function process()
|
||||
{
|
||||
// read the format requested for the output data
|
||||
$outputFormat = strtolower(Common::getRequestVar('format', 'xml', 'string', $this->request));
|
||||
|
||||
// create the response
|
||||
$response = new ResponseBuilder($outputFormat, $this->request);
|
||||
|
||||
try {
|
||||
// read parameters
|
||||
$moduleMethod = Common::getRequestVar('method', null, 'string', $this->request);
|
||||
|
||||
list($module, $method) = $this->extractModuleAndMethod($moduleMethod);
|
||||
|
||||
$module = $this->renameModule($module);
|
||||
|
||||
if (!\Piwik\Plugin\Manager::getInstance()->isPluginActivated($module)) {
|
||||
throw new PluginDeactivatedException($module);
|
||||
}
|
||||
$apiClassName = $this->getClassNameAPI($module);
|
||||
|
||||
self::reloadAuthUsingTokenAuth($this->request);
|
||||
|
||||
// call the method
|
||||
$returnedValue = Proxy::getInstance()->call($apiClassName, $method, $this->request);
|
||||
|
||||
$toReturn = $response->getResponse($returnedValue, $module, $method);
|
||||
} catch (Exception $e) {
|
||||
$toReturn = $response->getResponseException($e);
|
||||
}
|
||||
return $toReturn;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the name of a plugin's API class by plugin name.
|
||||
*
|
||||
* @param string $plugin The plugin name, eg, `'Referrers'`.
|
||||
* @return string The fully qualified API class name, eg, `'\Piwik\Plugins\Referrers\API'`.
|
||||
*/
|
||||
static public function getClassNameAPI($plugin)
|
||||
{
|
||||
return sprintf('\Piwik\Plugins\%s\API', $plugin);
|
||||
}
|
||||
|
||||
/**
|
||||
* If the token_auth is found in the $request parameter,
|
||||
* the current session will be authenticated using this token_auth.
|
||||
* It will overwrite the previous Auth object.
|
||||
*
|
||||
* @param array $request If null, uses the default request ($_GET)
|
||||
* @return void
|
||||
* @ignore
|
||||
*/
|
||||
static public function reloadAuthUsingTokenAuth($request = null)
|
||||
{
|
||||
// if a token_auth is specified in the API request, we load the right permissions
|
||||
$token_auth = Common::getRequestVar('token_auth', '', 'string', $request);
|
||||
if ($token_auth) {
|
||||
|
||||
/**
|
||||
* Triggered when authenticating an API request, but only if the **token_auth**
|
||||
* query parameter is found in the request.
|
||||
*
|
||||
* Plugins that provide authentication capabilities should subscribe to this event
|
||||
* and make sure the global authentication object (the object returned by `Registry::get('auth')`)
|
||||
* is setup to use `$token_auth` when its `authenticate()` method is executed.
|
||||
*
|
||||
* @param string $token_auth The value of the **token_auth** query parameter.
|
||||
*/
|
||||
Piwik::postEvent('API.Request.authenticate', array($token_auth));
|
||||
Access::getInstance()->reloadAccess();
|
||||
SettingsServer::raiseMemoryLimitIfNecessary();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns array($class, $method) from the given string $class.$method
|
||||
*
|
||||
* @param string $parameter
|
||||
* @throws Exception
|
||||
* @return array
|
||||
*/
|
||||
private function extractModuleAndMethod($parameter)
|
||||
{
|
||||
$a = explode('.', $parameter);
|
||||
if (count($a) != 2) {
|
||||
throw new Exception("The method name is invalid. Expected 'module.methodName'");
|
||||
}
|
||||
return $a;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method that processes an API request in one line using the variables in `$_GET`
|
||||
* and `$_POST`.
|
||||
*
|
||||
* @param string $method The API method to call, ie, `'Actions.getPageTitles'`.
|
||||
* @param array $paramOverride The parameter name-value pairs to use instead of what's
|
||||
* in `$_GET` & `$_POST`.
|
||||
* @return mixed The result of the API request. See {@link process()}.
|
||||
*/
|
||||
public static function processRequest($method, $paramOverride = array())
|
||||
{
|
||||
$params = array();
|
||||
$params['format'] = 'original';
|
||||
$params['module'] = 'API';
|
||||
$params['method'] = $method;
|
||||
$params = $paramOverride + $params;
|
||||
|
||||
// process request
|
||||
$request = new Request($params);
|
||||
return $request->process();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the original request parameters in the current query string as an array mapping
|
||||
* query parameter names with values. The result of this function will not be affected
|
||||
* by any modifications to `$_GET` and will not include parameters in `$_POST`.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public static function getRequestParametersGET()
|
||||
{
|
||||
if (empty($_SERVER['QUERY_STRING'])) {
|
||||
return array();
|
||||
}
|
||||
$GET = UrlHelper::getArrayFromQueryString($_SERVER['QUERY_STRING']);
|
||||
return $GET;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URL for the current requested report w/o any filter parameters.
|
||||
*
|
||||
* @param string $module The API module.
|
||||
* @param string $action The API action.
|
||||
* @param array $queryParams Query parameter overrides.
|
||||
* @return string
|
||||
*/
|
||||
public static function getBaseReportUrl($module, $action, $queryParams = array())
|
||||
{
|
||||
$params = array_merge($queryParams, array('module' => $module, 'action' => $action));
|
||||
return Request::getCurrentUrlWithoutGenericFilters($params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current URL without generic filter query parameters.
|
||||
*
|
||||
* @param array $params Query parameter values to override in the new URL.
|
||||
* @return string
|
||||
*/
|
||||
public static function getCurrentUrlWithoutGenericFilters($params)
|
||||
{
|
||||
// unset all filter query params so the related report will show up in its default state,
|
||||
// unless the filter param was in $queryParams
|
||||
$genericFiltersInfo = DataTableGenericFilter::getGenericFiltersInformation();
|
||||
foreach ($genericFiltersInfo as $filter) {
|
||||
foreach ($filter as $queryParamName => $queryParamInfo) {
|
||||
if (!isset($params[$queryParamName])) {
|
||||
$params[$queryParamName] = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return Url::getCurrentQueryStringWithParametersModified($params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the DataTable result will have to be expanded for the
|
||||
* current request before rendering.
|
||||
*
|
||||
* @return bool
|
||||
* @ignore
|
||||
*/
|
||||
public static function shouldLoadExpanded()
|
||||
{
|
||||
// if filter_column_recursive & filter_pattern_recursive are supplied, and flat isn't supplied
|
||||
// we have to load all the child subtables.
|
||||
return Common::getRequestVar('filter_column_recursive', false) !== false
|
||||
&& Common::getRequestVar('filter_pattern_recursive', false) !== false
|
||||
&& !self::shouldLoadFlatten();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public static function shouldLoadFlatten()
|
||||
{
|
||||
return Common::getRequestVar('flat', false) == 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the segment query parameter from the original request, without modifications.
|
||||
*
|
||||
* @return array|bool
|
||||
*/
|
||||
static public function getRawSegmentFromRequest()
|
||||
{
|
||||
// we need the URL encoded segment parameter, we fetch it from _SERVER['QUERY_STRING'] instead of default URL decoded _GET
|
||||
$segmentRaw = false;
|
||||
$segment = Common::getRequestVar('segment', '', 'string');
|
||||
if (!empty($segment)) {
|
||||
$request = Request::getRequestParametersGET();
|
||||
if (!empty($request['segment'])) {
|
||||
$segmentRaw = $request['segment'];
|
||||
}
|
||||
}
|
||||
return $segmentRaw;
|
||||
}
|
||||
}
|
||||
478
www/analytics/core/API/ResponseBuilder.php
Normal file
478
www/analytics/core/API/ResponseBuilder.php
Normal file
|
|
@ -0,0 +1,478 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik\API;
|
||||
|
||||
use Exception;
|
||||
use Piwik\API\DataTableManipulator\Flattener;
|
||||
use Piwik\API\DataTableManipulator\LabelFilter;
|
||||
use Piwik\API\DataTableManipulator\ReportTotalsCalculator;
|
||||
use Piwik\Common;
|
||||
use Piwik\DataTable\Renderer\Json;
|
||||
use Piwik\DataTable\Renderer;
|
||||
use Piwik\DataTable\Simple;
|
||||
use Piwik\DataTable;
|
||||
|
||||
/**
|
||||
*/
|
||||
class ResponseBuilder
|
||||
{
|
||||
private $request = null;
|
||||
private $outputFormat = null;
|
||||
|
||||
private $apiModule = false;
|
||||
private $apiMethod = false;
|
||||
|
||||
/**
|
||||
* @param string $outputFormat
|
||||
* @param array $request
|
||||
*/
|
||||
public function __construct($outputFormat, $request = array())
|
||||
{
|
||||
$this->request = $request;
|
||||
$this->outputFormat = $outputFormat;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method processes the data resulting from the API call.
|
||||
*
|
||||
* - If the data resulted from the API call is a DataTable then
|
||||
* - we apply the standard filters if the parameters have been found
|
||||
* in the URL. For example to offset,limit the Table you can add the following parameters to any API
|
||||
* call that returns a DataTable: filter_limit=10&filter_offset=20
|
||||
* - we apply the filters that have been previously queued on the DataTable
|
||||
* @see DataTable::queueFilter()
|
||||
* - we apply the renderer that generate the DataTable in a given format (XML, PHP, HTML, JSON, etc.)
|
||||
* the format can be changed using the 'format' parameter in the request.
|
||||
* Example: format=xml
|
||||
*
|
||||
* - If there is nothing returned (void) we display a standard success message
|
||||
*
|
||||
* - If there is a PHP array returned, we try to convert it to a dataTable
|
||||
* It is then possible to convert this datatable to any requested format (xml/etc)
|
||||
*
|
||||
* - If a bool is returned we convert to a string (true is displayed as 'true' false as 'false')
|
||||
*
|
||||
* - If an integer / float is returned, we simply return it
|
||||
*
|
||||
* @param mixed $value The initial returned value, before post process. If set to null, success response is returned.
|
||||
* @param bool|string $apiModule The API module that was called
|
||||
* @param bool|string $apiMethod The API method that was called
|
||||
* @return mixed Usually a string, but can still be a PHP data structure if the format requested is 'original'
|
||||
*/
|
||||
public function getResponse($value = null, $apiModule = false, $apiMethod = false)
|
||||
{
|
||||
$this->apiModule = $apiModule;
|
||||
$this->apiMethod = $apiMethod;
|
||||
|
||||
if($this->outputFormat == 'original') {
|
||||
@header('Content-Type: text/plain; charset=utf-8');
|
||||
}
|
||||
return $this->renderValue($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an error $message in the requested $format
|
||||
*
|
||||
* @param Exception $e
|
||||
* @throws Exception
|
||||
* @return string
|
||||
*/
|
||||
public function getResponseException(Exception $e)
|
||||
{
|
||||
$format = strtolower($this->outputFormat);
|
||||
|
||||
if ($format == 'original') {
|
||||
throw $e;
|
||||
}
|
||||
|
||||
try {
|
||||
$renderer = Renderer::factory($format);
|
||||
} catch (Exception $exceptionRenderer) {
|
||||
return "Error: " . $e->getMessage() . " and: " . $exceptionRenderer->getMessage();
|
||||
}
|
||||
|
||||
$e = $this->decorateExceptionWithDebugTrace($e);
|
||||
|
||||
$renderer->setException($e);
|
||||
|
||||
if ($format == 'php') {
|
||||
$renderer->setSerialize($this->caseRendererPHPSerialize());
|
||||
}
|
||||
|
||||
return $renderer->renderException();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $value
|
||||
* @return string
|
||||
*/
|
||||
protected function renderValue($value)
|
||||
{
|
||||
// when null or void is returned from the api call, we handle it as a successful operation
|
||||
if (!isset($value)) {
|
||||
return $this->handleSuccess();
|
||||
}
|
||||
|
||||
// If the returned value is an object DataTable we
|
||||
// apply the set of generic filters if asked in the URL
|
||||
// and we render the DataTable according to the format specified in the URL
|
||||
if ($value instanceof DataTable
|
||||
|| $value instanceof DataTable\Map
|
||||
) {
|
||||
return $this->handleDataTable($value);
|
||||
}
|
||||
|
||||
// Case an array is returned from the API call, we convert it to the requested format
|
||||
// - if calling from inside the application (format = original)
|
||||
// => the data stays unchanged (ie. a standard php array or whatever data structure)
|
||||
// - if any other format is requested, we have to convert this data structure (which we assume
|
||||
// to be an array) to a DataTable in order to apply the requested DataTable_Renderer (for example XML)
|
||||
if (is_array($value)) {
|
||||
return $this->handleArray($value);
|
||||
}
|
||||
|
||||
// original data structure requested, we return without process
|
||||
if ($this->outputFormat == 'original') {
|
||||
return $value;
|
||||
}
|
||||
|
||||
if (is_object($value)
|
||||
|| is_resource($value)
|
||||
) {
|
||||
return $this->getResponseException(new Exception('The API cannot handle this data structure.'));
|
||||
}
|
||||
|
||||
// bool // integer // float // serialized object
|
||||
return $this->handleScalar($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Exception $e
|
||||
* @return Exception
|
||||
*/
|
||||
protected function decorateExceptionWithDebugTrace(Exception $e)
|
||||
{
|
||||
// If we are in tests, show full backtrace
|
||||
if (defined('PIWIK_PATH_TEST_TO_ROOT')) {
|
||||
if (\Piwik_ShouldPrintBackTraceWithMessage()) {
|
||||
$message = $e->getMessage() . " in \n " . $e->getFile() . ":" . $e->getLine() . " \n " . $e->getTraceAsString();
|
||||
} else {
|
||||
$message = $e->getMessage() . "\n \n --> To temporarily debug this error further, set const PIWIK_PRINT_ERROR_BACKTRACE=true; in index.php";
|
||||
}
|
||||
return new Exception($message);
|
||||
}
|
||||
return $e;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the user requested to serialize the output data (&serialize=1 in the request)
|
||||
*
|
||||
* @param mixed $defaultSerializeValue Default value in case the user hasn't specified a value
|
||||
* @return bool
|
||||
*/
|
||||
protected function caseRendererPHPSerialize($defaultSerializeValue = 1)
|
||||
{
|
||||
$serialize = Common::getRequestVar('serialize', $defaultSerializeValue, 'int', $this->request);
|
||||
if ($serialize) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply the specified renderer to the DataTable
|
||||
*
|
||||
* @param DataTable|array $dataTable
|
||||
* @return string
|
||||
*/
|
||||
protected function getRenderedDataTable($dataTable)
|
||||
{
|
||||
$format = strtolower($this->outputFormat);
|
||||
|
||||
// if asked for original dataStructure
|
||||
if ($format == 'original') {
|
||||
// by default "original" data is not serialized
|
||||
if ($this->caseRendererPHPSerialize($defaultSerialize = 0)) {
|
||||
$dataTable = serialize($dataTable);
|
||||
}
|
||||
return $dataTable;
|
||||
}
|
||||
|
||||
$method = Common::getRequestVar('method', '', 'string', $this->request);
|
||||
|
||||
$renderer = Renderer::factory($format);
|
||||
$renderer->setTable($dataTable);
|
||||
$renderer->setRenderSubTables(Common::getRequestVar('expanded', false, 'int', $this->request));
|
||||
$renderer->setHideIdSubDatableFromResponse(Common::getRequestVar('hideIdSubDatable', false, 'int', $this->request));
|
||||
|
||||
if ($format == 'php') {
|
||||
$renderer->setSerialize($this->caseRendererPHPSerialize());
|
||||
$renderer->setPrettyDisplay(Common::getRequestVar('prettyDisplay', false, 'int', $this->request));
|
||||
} else if ($format == 'html') {
|
||||
$renderer->setTableId($this->request['method']);
|
||||
} else if ($format == 'csv' || $format == 'tsv') {
|
||||
$renderer->setConvertToUnicode(Common::getRequestVar('convertToUnicode', true, 'int', $this->request));
|
||||
}
|
||||
|
||||
// prepare translation of column names
|
||||
if ($format == 'html' || $format == 'csv' || $format == 'tsv' || $format = 'rss') {
|
||||
$renderer->setApiMethod($method);
|
||||
$renderer->setIdSite(Common::getRequestVar('idSite', false, 'int', $this->request));
|
||||
$renderer->setTranslateColumnNames(Common::getRequestVar('translateColumnNames', false, 'int', $this->request));
|
||||
}
|
||||
|
||||
return $renderer->render();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a success $message in the requested $format
|
||||
*
|
||||
* @param string $message
|
||||
* @return string
|
||||
*/
|
||||
protected function handleSuccess($message = 'ok')
|
||||
{
|
||||
// return a success message only if no content has already been buffered, useful when APIs return raw text or html content to the browser
|
||||
if (!ob_get_contents()) {
|
||||
switch ($this->outputFormat) {
|
||||
case 'xml':
|
||||
@header("Content-Type: text/xml;charset=utf-8");
|
||||
$return =
|
||||
"<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n" .
|
||||
"<result>\n" .
|
||||
"\t<success message=\"" . $message . "\" />\n" .
|
||||
"</result>";
|
||||
break;
|
||||
case 'json':
|
||||
@header("Content-Type: application/json");
|
||||
$return = '{"result":"success", "message":"' . $message . '"}';
|
||||
break;
|
||||
case 'php':
|
||||
$return = array('result' => 'success', 'message' => $message);
|
||||
if ($this->caseRendererPHPSerialize()) {
|
||||
$return = serialize($return);
|
||||
}
|
||||
break;
|
||||
|
||||
case 'csv':
|
||||
@header("Content-Type: application/vnd.ms-excel");
|
||||
@header("Content-Disposition: attachment; filename=piwik-report-export.csv");
|
||||
$return = "message\n" . $message;
|
||||
break;
|
||||
|
||||
default:
|
||||
$return = 'Success:' . $message;
|
||||
break;
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the given scalar to an data table
|
||||
*
|
||||
* @param mixed $scalar
|
||||
* @return string
|
||||
*/
|
||||
protected function handleScalar($scalar)
|
||||
{
|
||||
$dataTable = new Simple();
|
||||
$dataTable->addRowsFromArray(array($scalar));
|
||||
return $this->getRenderedDataTable($dataTable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles the given data table
|
||||
*
|
||||
* @param DataTable $datatable
|
||||
* @return string
|
||||
*/
|
||||
protected function handleDataTable($datatable)
|
||||
{
|
||||
// if requested, flatten nested tables
|
||||
if (Common::getRequestVar('flat', '0', 'string', $this->request) == '1') {
|
||||
$flattener = new Flattener($this->apiModule, $this->apiMethod, $this->request);
|
||||
if (Common::getRequestVar('include_aggregate_rows', '0', 'string', $this->request) == '1') {
|
||||
$flattener->includeAggregateRows();
|
||||
}
|
||||
$datatable = $flattener->flatten($datatable);
|
||||
}
|
||||
|
||||
if (1 == Common::getRequestVar('totals', '1', 'integer', $this->request)) {
|
||||
$genericFilter = new ReportTotalsCalculator($this->apiModule, $this->apiMethod, $this->request);
|
||||
$datatable = $genericFilter->calculate($datatable);
|
||||
}
|
||||
|
||||
// if the flag disable_generic_filters is defined we skip the generic filters
|
||||
if (0 == Common::getRequestVar('disable_generic_filters', '0', 'string', $this->request)) {
|
||||
$genericFilter = new DataTableGenericFilter($this->request);
|
||||
$genericFilter->filter($datatable);
|
||||
}
|
||||
|
||||
// we automatically safe decode all datatable labels (against xss)
|
||||
$datatable->queueFilter('SafeDecodeLabel');
|
||||
|
||||
// if the flag disable_queued_filters is defined we skip the filters that were queued
|
||||
if (Common::getRequestVar('disable_queued_filters', 0, 'int', $this->request) == 0) {
|
||||
$datatable->applyQueuedFilters();
|
||||
}
|
||||
|
||||
// use the ColumnDelete filter if hideColumns/showColumns is provided (must be done
|
||||
// after queued filters are run so processed metrics can be removed, too)
|
||||
$hideColumns = Common::getRequestVar('hideColumns', '', 'string', $this->request);
|
||||
$showColumns = Common::getRequestVar('showColumns', '', 'string', $this->request);
|
||||
if ($hideColumns !== '' || $showColumns !== '') {
|
||||
$datatable->filter('ColumnDelete', array($hideColumns, $showColumns));
|
||||
}
|
||||
|
||||
// apply label filter: only return rows matching the label parameter (more than one if more than one label)
|
||||
$label = $this->getLabelFromRequest($this->request);
|
||||
if (!empty($label)) {
|
||||
$addLabelIndex = Common::getRequestVar('labelFilterAddLabelIndex', 0, 'int', $this->request) == 1;
|
||||
|
||||
$filter = new LabelFilter($this->apiModule, $this->apiMethod, $this->request);
|
||||
$datatable = $filter->filter($label, $datatable, $addLabelIndex);
|
||||
}
|
||||
return $this->getRenderedDataTable($datatable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the given simple array to a data table
|
||||
*
|
||||
* @param array $array
|
||||
* @return string
|
||||
*/
|
||||
protected function handleArray($array)
|
||||
{
|
||||
if ($this->outputFormat == 'original') {
|
||||
// we handle the serialization. Because some php array have a very special structure that
|
||||
// couldn't be converted with the automatic DataTable->addRowsFromSimpleArray
|
||||
// the user may want to request the original PHP data structure serialized by the API
|
||||
// in case he has to setup serialize=1 in the URL
|
||||
if ($this->caseRendererPHPSerialize($defaultSerialize = 0)) {
|
||||
return serialize($array);
|
||||
}
|
||||
return $array;
|
||||
}
|
||||
|
||||
$multiDimensional = $this->handleMultiDimensionalArray($array);
|
||||
if ($multiDimensional !== false) {
|
||||
return $multiDimensional;
|
||||
}
|
||||
|
||||
return $this->getRenderedDataTable($array);
|
||||
}
|
||||
|
||||
/**
|
||||
* Is this a multi dimensional array?
|
||||
* Multi dim arrays are not supported by the Datatable renderer.
|
||||
* We manually render these.
|
||||
*
|
||||
* array(
|
||||
* array(
|
||||
* 1,
|
||||
* 2 => array( 1,
|
||||
* 2
|
||||
* )
|
||||
* ),
|
||||
* array( 2,
|
||||
* 3
|
||||
* )
|
||||
* );
|
||||
*
|
||||
* @param array $array
|
||||
* @return string|bool false if it isn't a multidim array
|
||||
*/
|
||||
protected function handleMultiDimensionalArray($array)
|
||||
{
|
||||
$first = reset($array);
|
||||
foreach ($array as $first) {
|
||||
if (is_array($first)) {
|
||||
foreach ($first as $key => $value) {
|
||||
// Yes, this is a multi dim array
|
||||
if (is_array($value)) {
|
||||
switch ($this->outputFormat) {
|
||||
case 'json':
|
||||
@header("Content-Type: application/json");
|
||||
return self::convertMultiDimensionalArrayToJson($array);
|
||||
break;
|
||||
|
||||
case 'php':
|
||||
if ($this->caseRendererPHPSerialize($defaultSerialize = 0)) {
|
||||
return serialize($array);
|
||||
}
|
||||
return $array;
|
||||
|
||||
case 'xml':
|
||||
@header("Content-Type: text/xml;charset=utf-8");
|
||||
return $this->getRenderedDataTable($array);
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a multidimensional array to Json
|
||||
* Handle DataTable|Set elements in the first dimension only, following case does not work:
|
||||
* array(
|
||||
* array(
|
||||
* DataTable,
|
||||
* 2 => array(
|
||||
* 1,
|
||||
* 2
|
||||
* ),
|
||||
* ),
|
||||
* );
|
||||
*
|
||||
* @param array $array can contain scalar, arrays, DataTable and Set
|
||||
* @return string
|
||||
*/
|
||||
public static function convertMultiDimensionalArrayToJson($array)
|
||||
{
|
||||
$jsonRenderer = new Json();
|
||||
$jsonRenderer->setTable($array);
|
||||
$renderedReport = $jsonRenderer->render();
|
||||
return $renderedReport;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the value for the label query parameter which can be either a string
|
||||
* (ie, label=...) or array (ie, label[]=...).
|
||||
*
|
||||
* @param array $request
|
||||
* @return array
|
||||
*/
|
||||
static public function getLabelFromRequest($request)
|
||||
{
|
||||
$label = Common::getRequestVar('label', array(), 'array', $request);
|
||||
if (empty($label)) {
|
||||
$label = Common::getRequestVar('label', '', 'string', $request);
|
||||
if (!empty($label)) {
|
||||
$label = array($label);
|
||||
}
|
||||
}
|
||||
|
||||
$label = self::unsanitizeLabelParameter($label);
|
||||
return $label;
|
||||
}
|
||||
|
||||
static public function unsanitizeLabelParameter($label)
|
||||
{
|
||||
// this is needed because Proxy uses Common::getRequestVar which in turn
|
||||
// uses Common::sanitizeInputValue. This causes the > that separates recursive labels
|
||||
// to become > and we need to undo that here.
|
||||
$label = Common::unsanitizeInputValues($label);
|
||||
return $label;
|
||||
}
|
||||
}
|
||||
418
www/analytics/core/Access.php
Normal file
418
www/analytics/core/Access.php
Normal file
|
|
@ -0,0 +1,418 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik;
|
||||
|
||||
use Piwik\Db;
|
||||
use Piwik\Plugins\UsersManager\API as APIUsersManager;
|
||||
|
||||
/**
|
||||
* Singleton that manages user access to Piwik resources.
|
||||
*
|
||||
* To check whether a user has access to a resource, use one of the {@link Piwik Piwik::checkUser...}
|
||||
* methods.
|
||||
*
|
||||
* In Piwik there are four different access levels:
|
||||
*
|
||||
* - **no access**: Users with this access level cannot view the resource.
|
||||
* - **view access**: Users with this access level can view the resource, but cannot modify it.
|
||||
* - **admin access**: Users with this access level can view and modify the resource.
|
||||
* - **Super User access**: Only the Super User has this access level. It means the user can do
|
||||
* whatever he/she wants.
|
||||
*
|
||||
* Super user access is required to set some configuration options.
|
||||
* All other options are specific to the user or to a website.
|
||||
*
|
||||
* Access is granted per website. Uses with access for a website can view all
|
||||
* data associated with that website.
|
||||
*
|
||||
*/
|
||||
class Access
|
||||
{
|
||||
private static $instance = null;
|
||||
|
||||
/**
|
||||
* Gets the singleton instance. Creates it if necessary.
|
||||
*/
|
||||
public static function getInstance()
|
||||
{
|
||||
if (self::$instance == null) {
|
||||
self::$instance = new self;
|
||||
|
||||
Piwik::postEvent('Access.createAccessSingleton', array(&self::$instance));
|
||||
}
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the singleton instance. For testing purposes.
|
||||
*/
|
||||
public static function setSingletonInstance($instance)
|
||||
{
|
||||
self::$instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Array of idsites available to the current user, indexed by permission level
|
||||
* @see getSitesIdWith*()
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $idsitesByAccess = null;
|
||||
|
||||
/**
|
||||
* Login of the current user
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $login = null;
|
||||
|
||||
/**
|
||||
* token_auth of the current user
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $token_auth = null;
|
||||
|
||||
/**
|
||||
* Defines if the current user is the Super User
|
||||
* @see hasSuperUserAccess()
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $hasSuperUserAccess = false;
|
||||
|
||||
/**
|
||||
* List of available permissions in Piwik
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private static $availableAccess = array('noaccess', 'view', 'admin', 'superuser');
|
||||
|
||||
/**
|
||||
* Authentification object (see Auth)
|
||||
*
|
||||
* @var Auth
|
||||
*/
|
||||
private $auth = null;
|
||||
|
||||
/**
|
||||
* Returns the list of the existing Access level.
|
||||
* Useful when a given API method requests a given acccess Level.
|
||||
* We first check that the required access level exists.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public static function getListAccess()
|
||||
{
|
||||
return self::$availableAccess;
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
$this->idsitesByAccess = array(
|
||||
'view' => array(),
|
||||
'admin' => array(),
|
||||
'superuser' => array()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the access levels for the current user.
|
||||
*
|
||||
* Calls the authentication method to try to log the user in the system.
|
||||
* If the user credentials are not correct we don't load anything.
|
||||
* If the login/password is correct the user is either the SuperUser or a normal user.
|
||||
* We load the access levels for this user for all the websites.
|
||||
*
|
||||
* @param null|Auth $auth Auth adapter
|
||||
* @return bool true on success, false if reloading access failed (when auth object wasn't specified and user is not enforced to be Super User)
|
||||
*/
|
||||
public function reloadAccess(Auth $auth = null)
|
||||
{
|
||||
if (!is_null($auth)) {
|
||||
$this->auth = $auth;
|
||||
}
|
||||
|
||||
// if the Auth wasn't set, we may be in the special case of setSuperUser(), otherwise we fail
|
||||
if (is_null($this->auth)) {
|
||||
if ($this->hasSuperUserAccess()) {
|
||||
return $this->reloadAccessSuperUser();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// access = array ( idsite => accessIdSite, idsite2 => accessIdSite2)
|
||||
$result = $this->auth->authenticate();
|
||||
|
||||
if (!$result->wasAuthenticationSuccessful()) {
|
||||
return false;
|
||||
}
|
||||
$this->login = $result->getIdentity();
|
||||
$this->token_auth = $result->getTokenAuth();
|
||||
|
||||
// case the superUser is logged in
|
||||
if ($result->hasSuperUserAccess()) {
|
||||
return $this->reloadAccessSuperUser();
|
||||
}
|
||||
// in case multiple calls to API using different tokens, we ensure we reset it as not SU
|
||||
$this->setSuperUserAccess(false);
|
||||
|
||||
// we join with site in case there are rows in access for an idsite that doesn't exist anymore
|
||||
// (backward compatibility ; before we deleted the site without deleting rows in _access table)
|
||||
$accessRaw = $this->getRawSitesWithSomeViewAccess($this->login);
|
||||
foreach ($accessRaw as $access) {
|
||||
$this->idsitesByAccess[$access['access']][] = $access['idsite'];
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public function getRawSitesWithSomeViewAccess($login)
|
||||
{
|
||||
return Db::fetchAll(self::getSqlAccessSite("access, t2.idsite"), $login);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the SQL query joining sites and access table for a given login
|
||||
*
|
||||
* @param string $select Columns or expression to SELECT FROM table, eg. "MIN(ts_created)"
|
||||
* @return string SQL query
|
||||
*/
|
||||
public static function getSqlAccessSite($select)
|
||||
{
|
||||
return "SELECT " . $select . "
|
||||
FROM " . Common::prefixTable('access') . " as t1
|
||||
JOIN " . Common::prefixTable('site') . " as t2 USING (idsite) " .
|
||||
" WHERE login = ?";
|
||||
}
|
||||
|
||||
/**
|
||||
* Reload Super User access
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function reloadAccessSuperUser()
|
||||
{
|
||||
$this->hasSuperUserAccess = true;
|
||||
|
||||
try {
|
||||
$allSitesId = Plugins\SitesManager\API::getInstance()->getAllSitesId();
|
||||
} catch (\Exception $e) {
|
||||
$allSitesId = array();
|
||||
}
|
||||
$this->idsitesByAccess['superuser'] = $allSitesId;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* We bypass the normal auth method and give the current user Super User rights.
|
||||
* This should be very carefully used.
|
||||
*
|
||||
* @param bool $bool
|
||||
*/
|
||||
public function setSuperUserAccess($bool = true)
|
||||
{
|
||||
if ($bool) {
|
||||
$this->reloadAccessSuperUser();
|
||||
} else {
|
||||
$this->hasSuperUserAccess = false;
|
||||
$this->idsitesByAccess['superuser'] = array();
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the current user is logged in as the Super User
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function hasSuperUserAccess()
|
||||
{
|
||||
return $this->hasSuperUserAccess;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current user login
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getLogin()
|
||||
{
|
||||
return $this->login;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the token_auth used to authenticate this user in the API
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getTokenAuth()
|
||||
{
|
||||
return $this->token_auth;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of ID sites for which the user has at least a VIEW access.
|
||||
* Which means VIEW or ADMIN or SUPERUSER.
|
||||
*
|
||||
* @return array Example if the user is ADMIN for 4
|
||||
* and has VIEW access for 1 and 7, it returns array(1, 4, 7);
|
||||
*/
|
||||
public function getSitesIdWithAtLeastViewAccess()
|
||||
{
|
||||
return array_unique(array_merge(
|
||||
$this->idsitesByAccess['view'],
|
||||
$this->idsitesByAccess['admin'],
|
||||
$this->idsitesByAccess['superuser'])
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of ID sites for which the user has an ADMIN access.
|
||||
*
|
||||
* @return array Example if the user is ADMIN for 4 and 8
|
||||
* and has VIEW access for 1 and 7, it returns array(4, 8);
|
||||
*/
|
||||
public function getSitesIdWithAdminAccess()
|
||||
{
|
||||
return array_unique(array_merge(
|
||||
$this->idsitesByAccess['admin'],
|
||||
$this->idsitesByAccess['superuser'])
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns an array of ID sites for which the user has a VIEW access only.
|
||||
*
|
||||
* @return array Example if the user is ADMIN for 4
|
||||
* and has VIEW access for 1 and 7, it returns array(1, 7);
|
||||
* @see getSitesIdWithAtLeastViewAccess()
|
||||
*/
|
||||
public function getSitesIdWithViewAccess()
|
||||
{
|
||||
return $this->idsitesByAccess['view'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Throws an exception if the user is not the SuperUser
|
||||
*
|
||||
* @throws \Piwik\NoAccessException
|
||||
*/
|
||||
public function checkUserHasSuperUserAccess()
|
||||
{
|
||||
if (!$this->hasSuperUserAccess()) {
|
||||
throw new NoAccessException(Piwik::translate('General_ExceptionPrivilege', array("'superuser'")));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* If the user doesn't have an ADMIN access for at least one website, throws an exception
|
||||
*
|
||||
* @throws \Piwik\NoAccessException
|
||||
*/
|
||||
public function checkUserHasSomeAdminAccess()
|
||||
{
|
||||
if ($this->hasSuperUserAccess()) {
|
||||
return;
|
||||
}
|
||||
$idSitesAccessible = $this->getSitesIdWithAdminAccess();
|
||||
if (count($idSitesAccessible) == 0) {
|
||||
throw new NoAccessException(Piwik::translate('General_ExceptionPrivilegeAtLeastOneWebsite', array('admin')));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* If the user doesn't have any view permission, throw exception
|
||||
*
|
||||
* @throws \Piwik\NoAccessException
|
||||
*/
|
||||
public function checkUserHasSomeViewAccess()
|
||||
{
|
||||
if ($this->hasSuperUserAccess()) {
|
||||
return;
|
||||
}
|
||||
$idSitesAccessible = $this->getSitesIdWithAtLeastViewAccess();
|
||||
if (count($idSitesAccessible) == 0) {
|
||||
throw new NoAccessException(Piwik::translate('General_ExceptionPrivilegeAtLeastOneWebsite', array('view')));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This method checks that the user has ADMIN access for the given list of websites.
|
||||
* If the user doesn't have ADMIN access for at least one website of the list, we throw an exception.
|
||||
*
|
||||
* @param int|array $idSites List of ID sites to check
|
||||
* @throws \Piwik\NoAccessException If for any of the websites the user doesn't have an ADMIN access
|
||||
*/
|
||||
public function checkUserHasAdminAccess($idSites)
|
||||
{
|
||||
if ($this->hasSuperUserAccess()) {
|
||||
return;
|
||||
}
|
||||
$idSites = $this->getIdSites($idSites);
|
||||
$idSitesAccessible = $this->getSitesIdWithAdminAccess();
|
||||
foreach ($idSites as $idsite) {
|
||||
if (!in_array($idsite, $idSitesAccessible)) {
|
||||
throw new NoAccessException(Piwik::translate('General_ExceptionPrivilegeAccessWebsite', array("'admin'", $idsite)));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This method checks that the user has VIEW or ADMIN access for the given list of websites.
|
||||
* If the user doesn't have VIEW or ADMIN access for at least one website of the list, we throw an exception.
|
||||
*
|
||||
* @param int|array|string $idSites List of ID sites to check (integer, array of integers, string comma separated list of integers)
|
||||
* @throws \Piwik\NoAccessException If for any of the websites the user doesn't have an VIEW or ADMIN access
|
||||
*/
|
||||
public function checkUserHasViewAccess($idSites)
|
||||
{
|
||||
if ($this->hasSuperUserAccess()) {
|
||||
return;
|
||||
}
|
||||
$idSites = $this->getIdSites($idSites);
|
||||
$idSitesAccessible = $this->getSitesIdWithAtLeastViewAccess();
|
||||
foreach ($idSites as $idsite) {
|
||||
if (!in_array($idsite, $idSitesAccessible)) {
|
||||
throw new NoAccessException(Piwik::translate('General_ExceptionPrivilegeAccessWebsite', array("'view'", $idsite)));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int|array|string $idSites
|
||||
* @return array
|
||||
* @throws \Piwik\NoAccessException
|
||||
*/
|
||||
protected function getIdSites($idSites)
|
||||
{
|
||||
if ($idSites === 'all') {
|
||||
$idSites = $this->getSitesIdWithAtLeastViewAccess();
|
||||
}
|
||||
|
||||
$idSites = Site::getIdSitesFromIdSitesString($idSites);
|
||||
if (empty($idSites)) {
|
||||
throw new NoAccessException("The parameter 'idSite=' is missing from the request.");
|
||||
}
|
||||
return $idSites;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Exception thrown when a user doesn't have sufficient access to a resource.
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
class NoAccessException extends \Exception
|
||||
{
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue