Various Api Improvements

CHANGELOG.md

@@ -96,6 +96,7 @@ Read more about migrating a plugin from Piwik 2.X to Piwik 3 on our [Migration g
  * `PluginManager.pluginInstalled` triggered after a plugin was installed
  * `PluginManager.pluginUninstalled` triggered after a plugin was uninstalled
 * New HTTP Tracking API parameter `pv_id` which accepts a six character unique ID that identifies which actions were performed on a specific page view. Read more about it in the [HTTP Tracking API](https://developer.piwik.org/api-reference/tracking-api);
+* New event `Segment.addSegments` that lets you add segments.
 
 ### New features
 * New "Sparklines" visualization that lets you create a widget showing multiple sparklines

core/Report/ReportWidgetConfig.php

@@ -7,7 +7,6 @@
  *
  */
 namespace Piwik\Report;
-use Piwik\ViewDataTable\Factory;
 use Piwik\Widget\WidgetConfig;
 
 /**

core/Widget/WidgetConfig.php

@@ -29,6 +29,7 @@ class WidgetConfig
     protected $order  = 99;
     protected $isEnabled = true;
     protected $isWidgetizable = true;
+    protected $isWide = false;
 
     /**
      * Set the id of the category the widget belongs to.
@@ -345,5 +346,24 @@ public function getMiddlewareParameters()
         return $this->middlewareParameters;
     }
 
+    /**
+     * Marks this widget as a "wide" widget that requires the full width.
+     *
+     * @return $this
+     */
+    public function setIsWide()
+    {
+        $this->isWide = true;
+        return $this;
+    }
+
+    /**
+     * Detect whether the widget should be shown wide or not.
+     * @return bool
+     */
+    public function isWide()
+    {
+        return $this->isWide;
+    }
 
 }

plugins/API/SegmentMetadata.php

@@ -10,21 +10,49 @@
 
 use Piwik\Columns\Dimension;
 use Piwik\Piwik;
+use Piwik\Plugin\Segment;
 
 class SegmentMetadata
 {
     public function getSegmentsMetadata($idSites = array(), $_hideImplementationData = true, $isAuthenticatedWithViewAccess)
     {
         $segments = array();
 
+        /**
+         * Triggered to add custom segment definitions.
+         *
+         * **Example**
+         *
+         *     public function addSegments(&$segments)
+         *     {
+         *         $segment = new Segment();
+         *         $segment->setSegment('my_segment_name');
+         *         $segment->setType(Segment::TYPE_DIMENSION);
+         *         $segment->setName('My Segment Name');
+         *         $segment->setSqlSegment('log_table.my_segment_name');
+         *         $segments[] = $segment;
+         *     }
+         *
+         * @param array &$segments An array containing a list of segment entries.
+         */
+        Piwik::postEvent('Segment.addSegments', array(&$segments));
+
         foreach (Dimension::getAllDimensions() as $dimension) {
             foreach ($dimension->getSegments() as $segment) {
-                if ($segment->isRequiresAtLeastViewAccess()) {
-                    $segment->setPermission($isAuthenticatedWithViewAccess);
-                }
+                $segments[] = $segment;
+            }
+        }
 
-                $segments[] = $segment->toArray();
+        /** @var Segment[] $dimensionSegments */
+        $dimensionSegments = $segments;
+        $segments = array();
+
+        foreach ($dimensionSegments as $segment) {
+            if ($segment->isRequiresAtLeastViewAccess()) {
+                $segment->setPermission($isAuthenticatedWithViewAccess);
             }
+
+            $segments[] = $segment->toArray();
         }
 
         foreach ($segments as &$segment) {

plugins/API/WidgetMetadata.php

@@ -82,6 +82,7 @@ public function buildWidgetMetadata(WidgetConfig $widget, $categoryList = null)
         $item['order']       = $widget->getOrder();
         $item['parameters']  = $widget->getParameters();
         $item['uniqueId']    = $widget->getUniqueId();
+        $item['isWide']      = $widget->isWide();
 
         $middleware = $widget->getMiddlewareParameters();
 

plugins/API/tests/Unit/WidgetMetadataTest.php

@@ -63,7 +63,8 @@ public function test_buildWidgetMetadata_ShouldGenerateMetadata()
                 'module' => 'CoreHome',
                 'action' => 'render'
             ),
-            'uniqueId' => 'widgetCoreHomerender'
+            'uniqueId' => 'widgetCoreHomerender',
+            'isWide' => false
         ), $metadata);
     }
 
@@ -154,7 +155,8 @@ public function test_buildWidgetMetadata_ShouldAddContainerInformtion_IfWidgetCo
                 'module' => 'CoreHome',
                 'action' => 'render',
             ),
-            'uniqueId' => 'widgetCoreHomerender'
+            'uniqueId' => 'widgetCoreHomerender',
+            'isWide' => false
         ), $widget1);
         $this->assertSame(array(
             'name' => 'NestedName2',
@@ -176,7 +178,8 @@ public function test_buildWidgetMetadata_ShouldAddContainerInformtion_IfWidgetCo
                 'module' => 'CoreHome',
                 'action' => 'render',
             ),
-            'uniqueId' => 'widgetCoreHomerender'
+            'uniqueId' => 'widgetCoreHomerender',
+            'isWide' => false
         ), $widget2);
     }
 
@@ -219,6 +222,7 @@ public function test_buildPageMetadata_ShouldAddContainerInformtion_IfWidgetCont
                         'action' => 'render',
                     ),
                     'uniqueId' => 'widgetCoreHomerender',
+                    'isWide' => false
                 ), array (
                     'name' => 'NestedName2',
                     'module' => 'CoreHome',
@@ -228,7 +232,8 @@ public function test_buildPageMetadata_ShouldAddContainerInformtion_IfWidgetCont
                         'module' => 'CoreHome',
                         'action' => 'render',
                     ),
-                    'uniqueId' => 'widgetCoreHomerender'
+                    'uniqueId' => 'widgetCoreHomerender',
+                    'isWide' => false
                 )
             )
         ), $metadata);

plugins/CoreAdminHome/templates/home.twig

@@ -19,14 +19,10 @@
     {% if isSuperUser %}
         <div class="row">
             <div class="col s12 {% if isFeedbackEnabled %}m4{% else %}m6{% endif %}">
-                <div piwik-content-block content-title="{{ 'CoreHome_SystemSummaryWidget'|translate }}">
-                    <div piwik-widget-loader='{"module":"CoreHome","action":"getSystemSummary"}'></div>
-                </div>
+                <div piwik-widget-loader='{"module":"CoreHome","action":"getSystemSummary"}'></div>
             </div>
             <div class="col s12 {% if isFeedbackEnabled %}m4{% else %}m6{% endif %}">
-                <div piwik-content-block content-title="{{ 'Installation_SystemCheck'|translate }}">
-                    <div piwik-widget-loader='{"module":"Installation","action":"getSystemCheck"}'></div>
-                </div>
+                <div piwik-widget-loader='{"module":"Installation","action":"getSystemCheck"}'></div>
             </div>
             {% if isFeedbackEnabled %}
                 <div class="col s12 m4">
@@ -39,9 +35,7 @@
     {% endif %}
 
     {% if isMarketplaceEnabled %}
-        <div piwik-content-block content-title="Latest Marketplace Updates">
-            <div piwik-widget-loader='{"module":"CorePluginsAdmin","action":"getNewPlugins", "isAdminPage": "1"}'></div>
-        </div>
+        <div piwik-widget-loader='{"module":"CorePluginsAdmin","action":"getNewPlugins", "isAdminPage": "1"}'></div>
     {% endif %}
 
     {{ postEvent('Template.adminHome') }}
@@ -61,16 +55,12 @@
         <div class="row">
             {% if hasDonateForm %}
                 <div class="col s12 {% if hasPiwikBlog %}m6{% endif %}">
-                    <div piwik-content-block content-title="{{ 'CoreHome_SupportPiwik'|translate }}">
-                        <div piwik-widget-loader='{"module":"CoreHome","action":"getDonateForm","widget": "0"}'></div>
-                    </div>
+                    <div piwik-widget-loader='{"module":"CoreHome","action":"getDonateForm","widget": "0"}'></div>
                 </div>
             {% endif %}
             {% if hasPiwikBlog %}
                 <div class="col s12 {% if hasDonateForm %}m6{% endif %}">
-                    <div piwik-content-block content-title="Piwik.org Blog">
-                        <div piwik-widget-loader='{"module":"RssWidget","action":"rssPiwik"}'></div>
-                    </div>
+                    <div piwik-widget-loader='{"module":"RssWidget","action":"rssPiwik"}'></div>
                 </div>
             {% endif %}
         </div>

plugins/CoreHome/Controller.php

@@ -11,7 +11,6 @@
 use Exception;
 use Piwik\API\Request;
 use Piwik\Common;
-use Piwik\DataTable\Renderer\Json;
 use Piwik\Date;
 use Piwik\FrontController;
 use Piwik\Notification\Manager as NotificationManager;
@@ -29,6 +28,7 @@
 use Piwik\Url;
 use Piwik\View;
 use Piwik\ViewDataTable\Manager as ViewDataTableManager;
+use Piwik\Widget\WidgetConfig;
 
 class Controller extends \Piwik\Plugin\Controller
 {
@@ -86,7 +86,33 @@ public function renderWidget($widget)
     {
         Piwik::checkUserHasSomeViewAccess();
 
-        return $widget->render();
+        $config = new WidgetConfig();
+        $widget::configure($config);
+
+        $content = $widget->render();
+
+        if ($config->getName() && Common::getRequestVar('showtitle', '', 'string') === '1') {
+            if (strpos($content, '<h2') !== false
+                || strpos($content, ' content-title=') !== false
+                || strpos($content, ' piwik-enriched-headline') !== false
+                || strpos($content, '<h1') !== false ) {
+                // already includes title
+                return $content;
+            }
+
+            if (strpos($content, 'piwik-content-block') === false
+                && strpos($content, 'class="card"') === false
+                && strpos($content, "class='card'") === false
+                && strpos($content, 'class="card-content"') === false
+                && strpos($content, "class='card-content'") === false) {
+                $view = new View('@CoreHome/_singleWidget');
+                $view->title = $config->getName();
+                $view->content = $content;
+                return $view->render();
+            }
+        }
+
+        return $content;
     }
 
     function redirectToCoreHomeIndex()

plugins/CoreHome/angularjs/reporting-page/reportingpage-model.js

@@ -47,7 +47,11 @@
                 return true;
             }
 
-            return widget.viewDataTable && widget.viewDataTable === 'tableAllColumns';
+            if ('undefined' !== typeof widget.isWide && widget.isWide) {
+                return true;
+            }
+
+            return widget.viewDataTable && (widget.viewDataTable === 'tableAllColumns' || widget.viewDataTable === 'sparklines' || widget.viewDataTable === 'graphEvolution');
         }
 
         function buildPage(page)
@@ -69,13 +73,7 @@
 
                 reportsToIgnore = reportsToIgnore.concat(getRelatedReports(widget));
 
-                if (widget.viewDataTable && widget.viewDataTable === 'graphEvolution') {
-                    evolutionReports.push(widget);
-                } else if (widget.viewDataTable && widget.viewDataTable === 'sparklines') {
-                    sparklineReports.push(widget);
-                } else {
-                    widgets.push(widget);
-                }
+                widgets.push(widget);
             });
 
             widgets = sortWidgets(widgets);

plugins/CoreHome/angularjs/reporting-page/reportingpage.directive.html

@@ -4,14 +4,6 @@
 
     <div ng-show="hasNoPage">{{ 'CoreHome_NoSuchPage'|translate }}</div>
 
-    <div class="row" ng-repeat="evolutionReport in pageModel.evolutionReports">
-        <div class="col s12 fullWidgetColumn" piwik-widget="evolutionReport"></div>
-    </div>
-
-    <div class="row" ng-repeat="sparklineReport in pageModel.sparklineReports">
-        <div class="col s12 fullWidgetColumn" piwik-widget="sparklineReport"></div>
-    </div>
-
     <div class="row" ng-repeat="widget in pageModel.widgets">
         <div class="col s12 fullWidgetColumn" ng-if="!widget.group" piwik-widget="widget"></div>
 

plugins/CoreHome/angularjs/widget-bydimension-container/widget-bydimension-container.directive.less

@@ -13,52 +13,52 @@
             max-width: 380px;
         }
     }
+}
 
-    .entityList {
+.entityList {
 
-        ul {
-            li {
-                margin: 4px 0;
-                padding: 0 0 0 16px;
-                line-height: 22px;
-                border-left: 2px solid @theme-color-background-base;
+    ul {
+        li {
+            margin: 4px 0;
+            padding: 0 0 0 16px;
+            line-height: 22px;
+            border-left: 2px solid @theme-color-background-base;
 
-                :hover {
-                    opacity: 0.8;
-                }
-                &:hover:not(.activeDimension) {
-                    border-color: @theme-color-header-background;
-                    border-left-width: 1px;
-                    padding-left: 17px;
-                }
-
-                &.activeDimension {
-                    border-color: @theme-color-header-background;
+            :hover {
+                opacity: 0.8;
+            }
+            &:hover:not(.activeDimension) {
+                border-color: @theme-color-header-background;
+                border-left-width: 1px;
+                padding-left: 17px;
+            }
 
-                    .dimension {
-                        font-weight: bold;
-                    }
-                }
+            &.activeDimension {
+                border-color: @theme-color-header-background;
 
                 .dimension {
-                    cursor: pointer;
-                    border-bottom: 1px solid #d0d0d0;
-                    color: @theme-color-text-contrast;
-                    border: 0;
+                    font-weight: bold;
                 }
             }
 
-            &.listCircle {
-                font-weight: normal;
-                list-style: none;
-                padding: 4px 0;
-                margin-top: 8px;
-            }
-            &.listCircle li a {
-                color: #000;
+            .dimension {
+                cursor: pointer;
+                border-bottom: 1px solid #d0d0d0;
+                color: @theme-color-text-contrast;
+                border: 0;
             }
+        }
 
+        &.listCircle {
+            font-weight: normal;
+            list-style: none;
+            padding: 4px 0;
+            margin-top: 8px;
+        }
+        &.listCircle li a {
+            color: #000;
         }
 
     }
+
 }

plugins/CoreHome/stylesheets/zen-mode.less

@@ -64,7 +64,7 @@
   }
 
   .goalEntry {
-    border-bottom: 0px;
+    border-bottom: 0;
   }
 
   .relatedReferrerReports {