cookienotice/cookienotice.php

   1 <?php
   2
   3 /**
   4  * Name: Cookie Notice
   5  * Description: Configure, show and handle a simple cookie notice
   6  * Version: 1.0
   7  * Author: Peter Liebetrau <https://socivitas/profile/peerteer>
   8  *
   9  */
  10 use Friendica\Core\Hook;
  11 use Friendica\Core\Config;
  12 use Friendica\Core\L10n;
  13 use Friendica\Core\Renderer;
  14
  15 /**
  16  * cookienotice_install
  17  * registers hooks
  18  *
  19  * @return void
  20  */
  21 function cookienotice_install()
  22 {
  23         $file = 'addon/cookienotice/cookienotice.php';
  24         Hook::register('page_content_top', $file, 'cookienotice_page_content_top');
  25         Hook::register('page_end', $file, 'cookienotice_page_end');
  26         Hook::register('addon_settings', $file, 'cookienotice_addon_settings');
  27         Hook::register('addon_settings_post', $file, 'cookienotice_addon_settings_post');
  28 }
  29
  30 /**
  31  * cookienotice_uninstall
  32  * unregisters hooks
  33  *
  34  * @return void
  35 */
  36 function cookienotice_uninstall()
  37 {
  38         $file = 'addon/cookienotice/cookienotice.php';
  39         Hook::unregister('page_content_top', $file, 'cookienotice_page_content_top');
  40         Hook::unregister('page_end', $file, 'cookienotice_page_end');
  41         Hook::unregister('addon_settings', $file, 'cookienotice_addon_settings');
  42         Hook::unregister('addon_settings_post', $file, 'cookienotice_addon_settings_post');
  43 }
  44
  45 /**
  46  * cookienotice_addon_settings
  47  * addon_settings hook
  48  * creates the admins config panel
  49  *
  50  * @param \Friendica\App $a
  51  * @param string $s The existing config panel html so far
  52  *
  53  * @return void
  54  */
  55 function cookienotice_addon_settings(\Friendica\App $a, &$s)
  56 {
  57         if (!is_site_admin()) {
  58                 return;
  59         }
  60
  61         /* Add our stylesheet to the page so we can make our settings look nice */
  62     $stylesheetPath = 'addon/cookienotice/cookienotice.css';
  63     $a->registerStylesheet($stylesheetPath);
  64
  65         $text = Config::get('cookienotice', 'text');
  66         if (!$text) {
  67                 $text = '';
  68         }
  69         $oktext = Config::get('cookienotice', 'oktext');
  70         if (!$oktext) {
  71                 $oktext = '';
  72         }
  73
  74         $t = Renderer::getMarkupTemplate("settings.tpl", "addon/cookienotice/");
  75         $s .= Renderer::replaceMacros($t, [
  76                 '$title' => L10n::t('"cookienotice" Settings'),
  77                 '$description' => L10n::t('<b>Configure your cookie usage notice.</b> It should just be a notice, saying that the website uses cookies. It is shown as long as a user didnt confirm clicking the OK button.'),
  78                 '$text' => ['cookienotice-text', L10n::t('Cookie Usage Notice'), $text, L10n::t('The cookie usage notice')],
  79                 '$oktext' => ['cookienotice-oktext', L10n::t('OK Button Text'), $oktext, L10n::t('The OK Button text')],
  80                 '$submit' => L10n::t('Save Settings')
  81         ]);
  82
  83         return;
  84 }
  85
  86 /**
  87  * cookienotice_addon_settings_post
  88  * addon_settings_post hook
  89  * handles the post request from the admin panel
  90  *
  91  * @param \Friendica\App $a
  92  * @param string $b
  93  *
  94  * @return void
  95  */
  96 function cookienotice_addon_settings_post(\Friendica\App $a, &$b)
  97 {
  98         if (!is_site_admin()) {
  99                 return;
 100         }
 101
 102         if ($_POST['cookienotice-submit']) {
 103                 Config::set('cookienotice', 'text', trim(strip_tags($_POST['cookienotice-text'])));
 104                 Config::set('cookienotice', 'oktext', trim(strip_tags($_POST['cookienotice-oktext'])));
 105                 info(L10n::t('cookienotice Settings saved.') . EOL);
 106         }
 107 }
 108
 109 /**
 110  * cookienotice_page_content_top
 111  * page_content_top hook
 112  * adds css and scripts to the <head> section of the html
 113  *
 114  * @param \Friendica\App $a
 115  * @param string $b unnused - the header html incl. nav
 116  *
 117  * @return void
 118  */
 119 function cookienotice_page_content_top(\Friendica\App $a, &$b)
 120 {
 121     $stylesheetPath = 'addon/cookienotice/cookienotice.css';
 122     $footerscriptPath = 'addon/cookienotice/cookienotice.js';
 123
 124     $a->registerStylesheet($stylesheetPath);
 125     $a->registerFooterScript($footerscriptPath);
 126 }
 127
 128 /**
 129  * cookienotice_page_end
 130  * page_end hook
 131  * ads our cookienotice box to the end of the html
 132  *
 133  * @param \Friendica\App $a
 134  * @param string $b the page html
 135  *
 136  * @return void
 137  */
 138 function cookienotice_page_end(\Friendica\App $a, &$b)
 139 {
 140         $text = (string) Config::get('cookienotice', 'text', L10n::t('This website uses cookies to recognize revisiting and logged in users. You accept the usage of these cookies by continue browsing this website.'));
 141         $oktext = (string) Config::get('cookienotice', 'oktext', L10n::t('OK'));
 142
 143         $page_end_tpl = Renderer::getMarkupTemplate("cookienotice.tpl", "addon/cookienotice/");
 144
 145         $page_end = Renderer::replaceMacros($page_end_tpl, [
 146                 '$text' => $text,
 147                 '$oktext' => $oktext,
 148         ]);
 149
 150         $b .= $page_end;
 151 }