3) Introducing ConfigFactory
[friendica-addons.git/.git] / piwik / piwik.php
old mode 100755 (executable)
new mode 100644 (file)
index 7a1cb58..2143c33
@@ -1,13 +1,13 @@
 <?php
 /**
  * Name: Piwik Analytics
- * Description: Piwik Analytics Plugin for Friendica
- * Version: 1.2
+ * Description: Piwik Analytics Addon for Friendica
+ * Version: 1.3
  * Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
  * Author: Klaus Weidenbach
  */
 
-/*   Piwik Analytics Plugin for Friendica
+/*   Piwik Analytics Addon for Friendica
  *
  *   Author: Tobias Diekershoff
  *           tobias.diekershoff@gmx.net
  *
  *   Configuration:
  *     Use the administration panel to configure the Piwik tracking addon, or
- *     in case you don't use this add the following lines to your .htconfig.php
+ *     in case you don't use this add the following lines to your config/addon.config.php
  *     file:
  *
- *     $a->config['piwik']['baseurl'] = 'www.example.com/piwik/';
- *     $a->config['piwik']['siteid'] = '1';
- *     $a->config['piwik']['optout'] = true;  // set to false to disable
- *     $a->config['piwik']['async'] = false;  // set to true to enable
+ *     [piwik]
+ *     baseurl = example.com/piwik/
+ *     sideid = 1
+ *     optout = true ;set to false to disable
+ *     async = false ;set to true to enable
  *
  *     Change the siteid to the ID that the Piwik tracker for your Friendica
  *     installation has. Alter the baseurl to fit your needs, don't care
  *     setting.
  */
 
+use Friendica\Core\Config;
+use Friendica\Core\Hook;
+use Friendica\Core\L10n;
+use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\Util\Strings;
+
 function piwik_install() {
-       register_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
+       Hook::register('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
+       Hook::register('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
 
-       logger("installed piwik plugin");
+       Logger::log("installed piwik addon");
 }
 
 function piwik_uninstall() {
-       unregister_hook('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
+       Hook::unregister('load_config', 'addon/piwik/piwik.php', 'piwik_load_config');
+       Hook::unregister('page_end', 'addon/piwik/piwik.php', 'piwik_analytics');
+
+       Logger::log("uninstalled piwik addon");
+}
 
-       logger("uninstalled piwik plugin");
+function piwik_load_config(\Friendica\App $a, Config\ConfigCacheLoader $loader)
+{
+       $a->getConfig()->loadConfigArray($loader->loadConfigFile('piwik'));
 }
 
 function piwik_analytics($a,&$b) {
 
        /*
-        *   styling of every HTML block added by this plugin is done in the
+        *   styling of every HTML block added by this addon is done in the
         *   associated CSS file. We just have to tell Friendica to get it
         *   into the page header.
         */
-       $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->get_baseurl() . '/addon/piwik/piwik.css' . '" media="all" />';
+       $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->getBaseURL() . '/addon/piwik/piwik.css' . '" media="all" />';
 
        /*
-        *   Get the configuration variables from the .htconfig file.
+        *   Get the configuration variables from the config/addon.config.php file.
         */
-       $baseurl = get_config('piwik','baseurl');
-       $siteid  = get_config('piwik','siteid');
-       $optout  = get_config('piwik','optout');
-       $async   = get_config('piwik','async');
+       $baseurl = Config::get('piwik', 'baseurl');
+       $siteid  = Config::get('piwik', 'siteid');
+       $optout  = Config::get('piwik', 'optout');
+       $async   = Config::get('piwik', 'async');
 
        /*
         *   Add the Piwik tracking code for the site.
@@ -76,31 +91,31 @@ function piwik_analytics($a,&$b) {
         */
        if ($optout) {
                $b .= "<div id='piwik-optout-link'>";
-               $b .= t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
+               $b .= L10n::t("This website is tracked using the <a href='http://www.piwik.org'>Piwik</a> analytics tool.");
                $b .= " ";
                $the_url =  "http://".$baseurl ."index.php?module=CoreAdminHome&action=optOut";
-               $b .= sprintf(t("If you do not want that your visits are logged in this way you <a href='%s'>can set a cookie to prevent Piwik from tracking further visits of the site</a> (opt-out)."), $the_url);
+               $b .= L10n::t("If you do not want that your visits are logged in this way you <a href='%s'>can set a cookie to prevent Piwik from tracking further visits of the site</a> (opt-out).", $the_url);
                $b .= "</div>";
        }
 }
-function piwik_plugin_admin (&$a, &$o) {
-       $t = get_markup_template( "admin.tpl", "addon/piwik/" );
-       $o = replace_macros( $t, array(
-               '$submit' => t('Save Settings'),
-               '$baseurl' => array('baseurl', t('Piwik Base URL'), get_config('piwik','baseurl' ), t('Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)')),
-               '$siteid' => array('siteid', t('Site ID'), get_config('piwik','siteid' ), ''),
-               '$optout' => array('optout', t('Show opt-out cookie link?'), get_config('piwik','optout' ), ''),
-               '$async' => array('async', t('Asynchronous tracking'), get_config('piwik','async' ), ''),
-       ));
+function piwik_addon_admin (&$a, &$o) {
+       $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/piwik/" );
+       $o = Renderer::replaceMacros( $t, [
+               '$submit' => L10n::t('Save Settings'),
+               '$piwikbaseurl' => ['baseurl', L10n::t('Piwik Base URL'), Config::get('piwik','baseurl' ), L10n::t('Absolute path to your Piwik installation. (without protocol (http/s), with trailing slash)')],
+               '$siteid' => ['siteid', L10n::t('Site ID'), Config::get('piwik','siteid' ), ''],
+               '$optout' => ['optout', L10n::t('Show opt-out cookie link?'), Config::get('piwik','optout' ), ''],
+               '$async' => ['async', L10n::t('Asynchronous tracking'), Config::get('piwik','async' ), ''],
+       ]);
 }
-function piwik_plugin_admin_post (&$a) {
-       $url = ((x($_POST, 'baseurl')) ? notags(trim($_POST['baseurl'])) : '');
-       $id = ((x($_POST, 'siteid')) ? trim($_POST['siteid']) : '');
-       $optout = ((x($_POST, 'optout')) ? trim($_POST['optout']) : '');
-       $async = ((x($_POST, 'async')) ? trim($_POST['async']) : '');
-       set_config('piwik', 'baseurl', $url);
-       set_config('piwik', 'siteid', $id);
-       set_config('piwik', 'optout', $optout);
-       set_config('piwik', 'async', $async);
-       info( t('Settings updated.'). EOL);
+function piwik_addon_admin_post (&$a) {
+       $url = (!empty($_POST['baseurl']) ? Strings::escapeTags(trim($_POST['baseurl'])) : '');
+       $id = (!empty($_POST['siteid']) ? trim($_POST['siteid']) : '');
+       $optout = (!empty($_POST['optout']) ? trim($_POST['optout']) : '');
+       $async = (!empty($_POST['async']) ? trim($_POST['async']) : '');
+       Config::set('piwik', 'baseurl', $url);
+       Config::set('piwik', 'siteid', $id);
+       Config::set('piwik', 'optout', $optout);
+       Config::set('piwik', 'async', $async);
+       info(L10n::t('Settings updated.'). EOL);
 }