migrate plugin from angularjs to vuejs

sgiehl · Jun 6, 2023 · 1468151 · 1468151
1 parent 7cddd92
commit 1468151
Show file tree

Hide file tree

Showing 39 changed files with 1,941 additions and 739 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -2,4 +2,7 @@ config/test.php export-ignore
 tests/ export-ignore
 .gitignore export-ignore
 .gitattributes export-ignore
-.travis.yml export-ignore
+.travis.yml export-ignore
+
+# + generated code: exclude and suppress in diffs
+vue/dist/** linguist-generated
diff --git a/API.php b/API.php
@@ -2,13 +2,15 @@
 /**
  * Matomo - free/libre analytics platform
  *
- * @link https://matomo.org
+ * @link    https://matomo.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  *
  */
 
 namespace Piwik\Plugins\ReferrersManager;
 
+use Piwik\Piwik;
+
 class API extends \Piwik\Plugin\API
 {
     /** @var Model */
@@ -91,25 +93,32 @@ public function getSocialLogos()
      * @param string $charset
      * @return bool
      */
-    public function addSearchEngine($name, $host, $parameters = '', $backlink = '', $charset = '')
-    {
+    public function addSearchEngine(
+        string $name,
+        string $host,
+        $parameters = '',
+        string $backlink = '',
+        string $charset = ''
+    ) {
+        Piwik::checkUserHasSuperUserAccess();
+
         if (empty($host) || empty($name)) {
             return false;
         }
 
         if (!empty($parameters)) {
             $parameters = explode(',', $parameters);
         } else {
-            $parameters = array();
+            $parameters = [];
         }
 
         $engines        = $this->model->getUserDefinedSearchEngines();
-        $engines[$host] = array(
-            'name' => $name,
-            'params' => $parameters,
+        $engines[$host] = [
+            'name'     => $name,
+            'params'   => $parameters,
             'backlink' => $backlink,
-            'chartset' => $charset
-        );
+            'charsets' => explode(',', $charset),
+        ];
         $this->model->setUserDefinedSearchEngines($engines);
         return true;
     }
@@ -120,8 +129,10 @@ public function addSearchEngine($name, $host, $parameters = '', $backlink = '',
      * @param string $host
      * @return bool
      */
-    public function removeSearchEngine($host)
+    public function removeSearchEngine(string $host)
     {
+        Piwik::checkUserHasSuperUserAccess();
+
         if (empty($host)) {
             return false;
         }
@@ -144,13 +155,14 @@ public function removeSearchEngine($host)
      * @param string $host
      * @return bool
      */
-    public function addSocial($name, $host)
+    public function addSocial(string $name, string $host)
     {
+        Piwik::checkUserHasSuperUserAccess();
+
         if (empty($host) || empty($name)) {
             return false;
         }
 
-
         $socials        = $this->model->getUserDefinedSocials();
         $socials[$host] = $name;
         $this->model->setUserDefinedSocials($socials);
@@ -159,11 +171,14 @@ public function addSocial($name, $host)
 
     /**
      * Removes a user defined social network
+     *
      * @param $host
      * @return bool
      */
-    public function removeSocial($host)
+    public function removeSocial(string $host)
     {
+        Piwik::checkUserHasSuperUserAccess();
+
         if (empty($host)) {
             return false;
         }
@@ -178,4 +193,18 @@ public function removeSocial($host)
         $this->model->setUserDefinedSocials($socials);
         return true;
     }
+
+    /**
+     * Sets if default socials should be used or not
+     *
+     * @param bool $state
+     * @return bool
+     */
+    public function setDefaultSocialsDisabled(bool $state = false): bool
+    {
+        Piwik::checkUserHasSuperUserAccess();
+
+        Model::getInstance()->setDefaultSocialsDisabled((bool)$state);
+        return true;
+    }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,13 +1,20 @@
 ## Changelog
 
+__5.0.0__
+
+* Migrate AngularJS components to Vue.js
+* Compatibility with Matomo 5
+
 __4.0.4__
+
 * Minor code improvements
 * Translation updates
 
 __4.0.3__
+
 * Small UI/UX improvements
 * Translation updates
-* 
+
 __4.0.2__
 
 * Translation updates

diff --git a/Controller.php b/Controller.php
@@ -2,16 +2,16 @@
 /**
  * Matomo - free/libre analytics platform
  *
- * @link https://matomo.org
+ * @link    https://matomo.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
 
 namespace Piwik\Plugins\ReferrersManager;
 
-use Piwik\Common;
 use Piwik\DataTable\Renderer\Json;
 use Piwik\Piwik;
 use Piwik\Plugin\ControllerAdmin;
+use Piwik\Request;
 use Piwik\View;
 
 /**
@@ -21,6 +21,7 @@ class Controller extends ControllerAdmin
 {
     /**
      * Index action
+     *
      * @return string
      */
     public function index()
@@ -35,19 +36,6 @@ public function index()
         return $view->render();
     }
 
-    /**
-     * Sets if default socials should be used or not
-     */
-    public function setDefaultSocialsDisabled()
-    {
-        Piwik::checkUserHasSuperUserAccess();
-
-        $state = Common::getRequestVar('state', 0, 'int');
-        Model::getInstance()->setDefaultSocialsDisabled((bool) $state);
-        Json::sendHeaderJSON();
-        return 1;
-    }
-
     /**
      * Ajax action to check an url for search engine information that can be extracted
      *
@@ -57,13 +45,13 @@ public function checkUrl()
     {
         Piwik::checkUserHasSuperUserAccess();
 
-        $urlToCheck = trim(Common::unsanitizeInputValue(Common::getRequestVar('url', null, 'string')));
+        $urlToCheck = trim(Request::fromRequest()->getStringParameter('url', ''));
 
         Json::sendHeaderJSON();
         return json_encode([
-            'searchengine' => Model::getInstance()->detectSearchEngine($urlToCheck),
-            'social'       => Model::getInstance()->detectSocial($urlToCheck)
-        ]);
+                               'searchengine' => Model::getInstance()->detectSearchEngine($urlToCheck),
+                               'social'       => Model::getInstance()->detectSocial($urlToCheck),
+                           ]);
     }
 
     public function refresh()
@@ -72,11 +60,11 @@ public function refresh()
 
         Json::sendHeaderJSON();
 
-        $type = Common::getRequestVar('type', '', 'string');
+        $type = Request::fromRequest()->getStringParameter('type', '');
 
-        if ($type == 'socials') {
+        if ($type === 'socials') {
             Model::getInstance()->clearSocialCache();
-        } else if ($type == 'searchengines') {
+        } else if ($type === 'searchengines') {
             Model::getInstance()->clearSearchEngineCache();
         }
 

diff --git a/Model.php b/Model.php
@@ -30,17 +30,17 @@ public static function getInstance()
     }
 
     /**
-     * Returns if Piwik's built-in social list is used or not
+     * Returns if Matomo's built-in social list is used or not
      *
-     * @return false|string
+     * @return bool
      */
     public function areDefaultSocialsDisabled()
     {
-        return Option::get(self::OPTION_KEY_DISABLE_DEFAULT_SOCIALS);
+        return !!Option::get(self::OPTION_KEY_DISABLE_DEFAULT_SOCIALS);
     }
 
     /**
-     * Sets if Piwik's built-in social list should be used or not
+     * Sets if Matomo's built-in social list should be used or not
      *
      * @param bool $disabled
      */
@@ -145,7 +145,7 @@ public function clearSearchEngineCache()
     }
 
     /**
-     * Wrapper method to Piwiks internal method to return search engine data
+     * Wrapper method to Matomo's internal method to return search engine data
      * @return array
      */
     public function getSearchEngines()
@@ -154,7 +154,7 @@ public function getSearchEngines()
     }
 
     /**
-     * Returns all search engine informations known to piwik
+     * Returns all search engine information known to Matomo
      *
      * @return array
      */
@@ -201,7 +201,7 @@ public function getSearchEngineLogos()
     }
 
     /**
-     * Wrapper method to Piwiks internal method to return search engine data
+     * Wrapper method to Matomo' internal method to return search engine data
      * @return array
      */
     public function getSocials()
@@ -210,7 +210,7 @@ public function getSocials()
     }
 
     /**
-     * Returns all social informations known to piwik
+     * Returns all social informations known to Matomo
      *
      * @return array
      */

diff --git a/README.md b/README.md
@@ -9,17 +9,17 @@ Note: You can find the configuration panel for this plugin within the global adm
 
 ### Requirements
 
-[Matomo](https://github.com/matomo-org/matomo) 4.0.0-b1 or higher is required.
+[Matomo](https://github.com/matomo-org/matomo) 5.0.0-b1 or higher is required.
 
 ### Features
 
 - Shows a list of all search engines and social networks defined in Matomo core.
-- Abillity to manage custom search engines and social networks
-- Abillity to disable/enable Matomo's default social network list
+- Ability to manage custom search engines and social networks
+- Ability to disable/enable Matomo's default social network list
 
 ## Support
 
-Please direct any feedback to [[email protected]](mailto:matomo@piwik.org)
+Please direct any feedback to [[email protected]](mailto:matomo@matomo.org)
 
 ## Contribute
 

diff --git a/ReferrersManager.php b/ReferrersManager.php
@@ -23,24 +23,11 @@ public function registerEvents()
         return array(
             'Referrer.addSearchEngineUrls'     => 'addSearchEngineUrls',
             'Referrer.addSocialUrls'           => 'addSocialUrls',
-            'AssetManager.getJavaScriptFiles'  => 'getJsFiles',
             'AssetManager.getStylesheetFiles'  => 'getStylesheetFiles',
             'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
         );
     }
 
-    /**
-     * Adds required JS files
-     * @param $jsFiles
-     */
-    public function getJsFiles(&$jsFiles)
-    {
-        $jsFiles[] = "plugins/ReferrersManager/javascripts/checkreferrerurl.controller.js";
-        $jsFiles[] = "plugins/ReferrersManager/javascripts/searchengines.controller.js";
-        $jsFiles[] = "plugins/ReferrersManager/javascripts/socials.controller.js";
-        $jsFiles[] = "plugins/ReferrersManager/javascripts/referrersmanager-tabs.directive.js";
-    }
-
     /**
      * Adds required CSS files
      * @param $stylesheets

diff --git a/config/test.php b/config/test.php
@@ -1,5 +1,5 @@
 <?php
 
 return array(
-    'Piwik\Plugins\ReferrersManager\Model'   => DI\autowire('Piwik\Plugins\ReferrersManager\tests\Mocks\Model'),
+    'Piwik\Plugins\ReferrersManager\Model'   => \Piwik\DI::autowire('Piwik\Plugins\ReferrersManager\tests\Mocks\Model'),
 );