show users more informative information on error (#17900)

* show users more informative information on error

fixes #15135

* add rel="noreferrer noopener" #15135

* show faq section only outside of cloud #15036

* privatise variables

contributing to View::showMoreFaqInfo #15135

Co-authored-by: Stefan Giehl <stefan@matomo.org>

5 files changed, 12 insertions, 2 deletions

diff --git a/plugins/CoreHome/CoreHome.php b/plugins/CoreHome/CoreHome.php
index 332538fcff..120ecf5b3c 100644
--- a/plugins/CoreHome/CoreHome.php
+++ b/plugins/CoreHome/CoreHome.php
@@ -438,6 +438,7 @@ class CoreHome extends \Piwik\Plugin
         $translationKeys[] = 'General_LoadingData';
         $translationKeys[] = 'General_Error';
         $translationKeys[] = 'General_ErrorRequest';
+        $translationKeys[] = 'General_ErrorRequestFaqLink';
         $translationKeys[] = 'General_YourChangesHaveBeenSaved';
         $translationKeys[] = 'General_LearnMore';
         $translationKeys[] = 'General_ChooseDate';
diff --git a/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.html b/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.html
index 0146d0fb56..c29f0bbbd1 100644
--- a/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.html
+++ b/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.html
@@ -6,6 +6,7 @@
 
         <div class="notification system notification-error">
             {{ 'General_ErrorRequest'|translate:(''):('') }}
+            <ng-bind-html ng-bind-html="errorFaqLink"></ng-bind-html>
         </div>
     </div>
 
diff --git a/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.js b/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.js
index 4614f01bbf..a9812701bc 100644
--- a/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.js
+++ b/plugins/CoreHome/angularjs/widget-loader/widgetloader.directive.js
@@ -22,6 +22,8 @@
     piwikWidgetLoader.$inject = ['piwik', 'piwikUrl', '$http', '$compile', '$q', '$location', 'notifications', '$rootScope', '$timeout', 'piwikComparisonsService'];
 
     function piwikWidgetLoader(piwik, piwikUrl, $http, $compile, $q, $location, notifications, $rootScope, $timeout, piwikComparisonsService){
+        var isGeneralSettingsAdminEnabled = piwik.config['enable_general_settings_admin'];
+        var isPluginsAdminEnabled = piwik.config['enable_plugins_admin'];
         return {
             restrict: 'A',
             transclude: true,
@@ -35,6 +37,12 @@
 
                 return function (scope, element, attrs, ngModel) {
                     scope.widgetName = attrs.widgetName;
+                    if (piwik.hasSuperUserAccess && (isGeneralSettingsAdminEnabled || isPluginsAdminEnabled)) {
+                        scope.errorFaqLink = '<a rel="noreferrer noopener" target="_blank" href="https://matomo.org/faq/troubleshooting/faq_19489/">' +
+                            _pk_translate('General_ErrorRequestFaqLink') + '</a>';
+                    } else {
+                        scope.errorFaqLink = '';
+                    }
 
                     if (!attrs.widgetName) {
                         scope.loadingMessage = _pk_translate('General_LoadingData');
diff --git a/plugins/CoreHome/templates/_indexContent.twig b/plugins/CoreHome/templates/_indexContent.twig
index 671c26e782..34ec6d0d7f 100644
--- a/plugins/CoreHome/templates/_indexContent.twig
+++ b/plugins/CoreHome/templates/_indexContent.twig
@@ -7,7 +7,7 @@
         {{ postEvent("Template.nextToCalendar") }}
         {% render dashboardSettingsControl %}
         {% include "@CoreHome/_headerMessage.twig" %}
-        {{ ajax.requestErrorDiv(emailSuperUser|default('')) }}
+        {{ ajax.requestErrorDiv(emailSuperUser|default(''), false, '', showMoreFaqInfo) }}
     </div>
 
     {{ ajax.loadingDiv() }}
diff --git a/plugins/CoreHome/templates/getDefaultIndexView.twig b/plugins/CoreHome/templates/getDefaultIndexView.twig
index f5626eeda2..8d61b91b96 100644
--- a/plugins/CoreHome/templates/getDefaultIndexView.twig
+++ b/plugins/CoreHome/templates/getDefaultIndexView.twig
@@ -10,7 +10,7 @@
 {% endblock %}
 
 {% block content %}
-    {{ ajax.requestErrorDiv(emailSuperUser|default(''), areAdsForProfessionalServicesEnabled, currentModule) }}
+    {{ ajax.requestErrorDiv(emailSuperUser|default(''), areAdsForProfessionalServicesEnabled, currentModule, showMoreFaqInfo) }}
     {{ ajax.loadingDiv() }}
 
     <div id="content" class="home">