diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0acf77785c4bf665f20c69d813703a9e46f1ff45..6764613a890490a51ae7d6ddaa994a9ed0e23e1f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,7 +12,6 @@ Read more about migrating a plugin from Piwik 2.X to Piwik 3 in [our Migration g
### Breaking Changes
* The UserManager API methods do no longer return any `token_auth` properties when requesting a user
-* Reporting API: if you call the Reporting API requesting data in `json` format then you may be affected. The `json` formatting has changed, a bug was fixed so that API methods that return simple associative arrays like `array('name' => 'value', 'name2' => 'value2')` will now appear correctly as `{"name":"value","name2":"value2"}` in JSON API output instead of `[{"name":"value","name2":"value2"}]` (as it used to be in Piwik 2). API methods like **SitesManager.getSiteFromId** & **UsersManager.getUser** and others are affected.
* The menu classes `Piwik\Menu\MenuReporting` and `Piwik\Menu\MenuMain` have been removed
* The class `Piwik\Plugin\Widgets` has been removed and replaced by `Piwik\Widget\Widget`. For each widget one class is needed from now on. You can generate a widget via `./console generate:widget`.
* The class `Piwik\WidgetList` class has been moved to `Piwik\Widget\WidgetsList`.
diff --git a/misc/log-analytics b/misc/log-analytics
index 26049b008b2ce3cbb9e7179a94033db5475ad698..8ec5986b2d4d21af9c9ddaa7c40225e1c8a36180 160000
--- a/misc/log-analytics
+++ b/misc/log-analytics
@@ -1 +1 @@
-Subproject commit 26049b008b2ce3cbb9e7179a94033db5475ad698
+Subproject commit 8ec5986b2d4d21af9c9ddaa7c40225e1c8a36180
diff --git a/plugins/API/Renderer/Json.php b/plugins/API/Renderer/Json.php
index 1f7591370b2471182ffc39dabbe92c4fddce6f95..34b82b9c8a61b32d45cecedcbcd5bca907f95dfa 100644
--- a/plugins/API/Renderer/Json.php
+++ b/plugins/API/Renderer/Json.php
@@ -16,6 +16,8 @@ use Piwik\ProxyHttp;
/**
* API output renderer for JSON.
+ * NOTE: This is the old JSON format. It includes bugs that are fixed in the JSON2 API output format.
+ * Please use json2 format instead of this.
*
* @deprecated
*/
@@ -57,18 +59,7 @@ class Json extends ApiRenderer
$result = $jsonRenderer->render();
return $this->applyJsonpIfNeeded($result);
}
-
- $result = $this->renderDataTable($array);
-
- // if $array is a simple associative array, remove the JSON root array that is added by renderDataTable
- if (!empty($array)
- && Piwik::isAssociativeArray($array)
- && !Piwik::isMultiDimensionalArray($array)
- ) {
- $result = substr($result, 1, strlen($result) - 2);
- }
-
- return $result;
+ return $this->renderDataTable($array);
}
public function sendHeader()
diff --git a/plugins/API/Renderer/Json2.php b/plugins/API/Renderer/Json2.php
index bd27810fb8d893afc441734aa513918b07440b64..23f6effe0b9da5a329e51054e89f34f7e2e919b6 100644
--- a/plugins/API/Renderer/Json2.php
+++ b/plugins/API/Renderer/Json2.php
@@ -11,8 +11,24 @@ namespace Piwik\Plugins\API\Renderer;
use Piwik\Piwik;
/**
- * Left here for Backward compatibility in Piwik 3.X+ for all users who correctly used format=json2 during Piwik 2.X
+ * Correct API output renderer for JSON. Includes bug fixes for bugs in the old JSON API
+ * format.
*/
class Json2 extends Json
{
-}
\ No newline at end of file
+ public function renderArray($array)
+ {
+ $result = parent::renderArray($array);
+
+ // if $array is a simple associative array, remove the JSON root array that is added by renderDataTable
+ if (!empty($array)
+ && Piwik::isAssociativeArray($array)
+ && !Piwik::isMultiDimensionalArray($array)
+ ) {
+ $result = substr($result, 1, strlen($result) - 2);
+ }
+
+ return $result;
+ }
+}
+
diff --git a/plugins/API/tests/Unit/JsonRendererTest.php b/plugins/API/tests/Unit/JsonRendererTest.php
index ea7f5d69d46adbf8a9f168ab75be785c195f4887..d71d7068ef74bc9edc3ed3a7427defa9daa534f6 100644
--- a/plugins/API/tests/Unit/JsonRendererTest.php
+++ b/plugins/API/tests/Unit/JsonRendererTest.php
@@ -356,14 +356,14 @@ class JsonRendererTest extends \PHPUnit_Framework_TestCase
$this->assertNoJsonError($actual);
}
- public function test_json_renderArray_ShouldConvertSingleDimensionalAssociativeArray()
+ public function test_oldJson_renderArray_ShouldConvertSingleDimensionalAssociativeArray()
{
$input = array(
"firstElement" => "isFirst",
"secondElement" => "isSecond"
);
- $expected = '{"firstElement":"isFirst","secondElement":"isSecond"}';
+ $expected = '[{"firstElement":"isFirst","secondElement":"isSecond"}]';
$oldJsonBuilder = new Json($input);
$actual = $oldJsonBuilder->renderArray($input);
@@ -373,7 +373,7 @@ class JsonRendererTest extends \PHPUnit_Framework_TestCase
private function makeBuilder($request)
{
- return new Json($request);
+ return new Json2($request);
}
private function assertNoJsonError($response)
diff --git a/plugins/CoreAdminHome/Controller.php b/plugins/CoreAdminHome/Controller.php
index 3531623eeff33c541f30a92324d0f4b521428fe2..7621aa1f789793130f5de7cb715dde085806b67d 100644
--- a/plugins/CoreAdminHome/Controller.php
+++ b/plugins/CoreAdminHome/Controller.php
@@ -114,7 +114,7 @@ class Controller extends ControllerAdmin
return '';
}
- $response = new ResponseBuilder('json');
+ $response = new ResponseBuilder('json2');
try {
$this->checkTokenInUrl();
diff --git a/plugins/CoreHome/angularjs/common/services/piwik-api.js b/plugins/CoreHome/angularjs/common/services/piwik-api.js
index ab6ee9c30d0056299fbff1ee9e290c828843845c..ab546a7693acdb06efb70eb207a8ee879a7ce528 100644
--- a/plugins/CoreHome/angularjs/common/services/piwik-api.js
+++ b/plugins/CoreHome/angularjs/common/services/piwik-api.js
@@ -249,7 +249,7 @@ var hasBlockedContent = false;
getParams.module = getParams.module || 'API';
if (!getParams.format) {
- getParams.format = 'JSON';
+ getParams.format = 'JSON2';
}
addParams(getParams);
diff --git a/plugins/CoreHome/angularjs/common/services/piwik-api.spec.js b/plugins/CoreHome/angularjs/common/services/piwik-api.spec.js
index a51067ea46899778f94fed04c251d29995cdacf0..1faf387ea389ab8e9360335b51c598c92e952839 100644
--- a/plugins/CoreHome/angularjs/common/services/piwik-api.spec.js
+++ b/plugins/CoreHome/angularjs/common/services/piwik-api.spec.js
@@ -55,7 +55,7 @@
piwikApi.fetch({
method: "SomePlugin.action"
}).then(function (response) {
- expect(response).to.equal("Request url: index.php?date=&format=JSON&idSite=1&method=SomePlugin.action&module=API&period=day");
+ expect(response).to.equal("Request url: index.php?date=&format=JSON2&idSite=1&method=SomePlugin.action&module=API&period=day");
done();
}).catch(function (ex) {
@@ -115,7 +115,7 @@
piwikApi.fetch({
method: "SomePlugin.action"
}).then(function (response) {
- expect(response).to.equal("Request url: index.php?date=&format=JSON&idSite=1&method=SomePlugin.action&module=API&period=day");
+ expect(response).to.equal("Request url: index.php?date=&format=JSON2&idSite=1&method=SomePlugin.action&module=API&period=day");
request1Done = true;
@@ -127,7 +127,7 @@
piwikApi.fetch({
method: "SomeOtherPlugin.action"
}).then(function (response) {
- expect(response).to.equal("Request url: index.php?date=&format=JSON&idSite=1&method=SomeOtherPlugin.action&module=API&period=day");
+ expect(response).to.equal("Request url: index.php?date=&format=JSON2&idSite=1&method=SomeOtherPlugin.action&module=API&period=day");
request2Done = true;
@@ -160,7 +160,7 @@
piwikApi.fetch({
method: "SomeOtherPlugin.action"
}).then(function (response) {
- expect(response).to.equal("Request url: index.php?date=&format=JSON&idSite=1&method=SomeOtherPlugin.action&module=API&period=day");
+ expect(response).to.equal("Request url: index.php?date=&format=JSON2&idSite=1&method=SomeOtherPlugin.action&module=API&period=day");
request2Done = true;
@@ -216,7 +216,7 @@
method: "SomeOtherPlugin.action"
}
]).then(function (response) {
- var restOfExpected = "index.php?date=&format=JSON&idSite=1&method=API.getBulkRequest&" +
+ var restOfExpected = "index.php?date=&format=JSON2&idSite=1&method=API.getBulkRequest&" +
"module=API&period=day - urls%5B%5D=%3Fmethod%3DSomePlugin.action%26param%3D" +
"value&urls%5B%5D=%3Fmethod%3DSomeOtherPlugin.action&token_auth=100bf5eeeed1468f3f9d93750044d3dd";