* Description: Configure, show and handle a simple cookie notice
* Version: 1.0
* Author: Peter Liebetrau <https://socivitas/profile/peerteer>
- *
*/
-use Friendica\Core\Addon;
+
+use Friendica\App;
use Friendica\Core\Config;
+use Friendica\Core\Hook;
use Friendica\Core\L10n;
+use Friendica\Core\Renderer;
+use Friendica\DI;
+/**
+ * cookienotice_install
+ * registers hooks
+ *
+ * @return void
+ */
function cookienotice_install()
{
- $file = 'addon/cookienotice/cookienotice.php';
- Addon::registerHook('page_content_top', $file, 'cookienotice_page_content_top');
- Addon::registerHook('page_end', $file, 'cookienotice_page_end');
- Addon::registerHook('addon_settings', $file, 'cookienotice_addon_settings');
- Addon::registerHook('addon_settings_post', $file, 'cookienotice_addon_settings_post');
+ Hook::register('page_content_top', __FILE__, 'cookienotice_page_content_top');
+ Hook::register('page_end', __FILE__, 'cookienotice_page_end');
}
-function cookienotice_uninstall()
-{
- $file = 'addon/cookienotice/cookienotice.php';
- Addon::unregisterHook('page_content_top', $file, 'cookienotice_page_content_top');
- Addon::unregisterHook('page_end', $file, 'cookienotice_page_end');
- Addon::unregisterHook('addon_settings', $file, 'cookienotice_addon_settings');
- Addon::unregisterHook('addon_settings_post', $file, 'cookienotice_addon_settings_post');
-}
-
-function cookienotice_addon_settings(&$a, &$s)
+/**
+ * cookienotice_addon_admin
+ * creates the admins config panel
+ *
+ * @param App $a
+ * @param string $s The existing config panel html so far
+ *
+ * @return void
+ */
+function cookienotice_addon_admin(App $a, &$s)
{
- if (!is_site_admin())
+ if (!is_site_admin()) {
return;
-
- /* Add our stylesheet to the page so we can make our settings look nice */
-
- $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="/addon/cookienotice/cookienotice.css" media="all" />' . "\r\n";
-
-
- $text = Config::get('cookienotice', 'text');
- if (!$text) {
- $text = '';
- }
- $oktext = Config::get('cookienotice', 'oktext');
- if (!$oktext) {
- $oktext = '';
}
- $t = get_markup_template("settings.tpl", "addon/cookienotice/");
- $s .= replace_macros($t, [
- '$title' => L10n::t('"cookienotice" Settings'),
+ $text = Config::get('cookienotice', 'text', L10n::t('This website uses cookies. If you continue browsing this website, you agree to the usage of cookies.'));
+ $oktext = Config::get('cookienotice', 'oktext', L10n::t('OK'));
+
+ $t = Renderer::getMarkupTemplate('admin.tpl', __DIR__);
+ $s .= Renderer::replaceMacros($t, [
'$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.'),
- '$text' => ['cookienotice-text', L10n::t('Cookie Usage Notice'), $text, L10n::t('The cookie usage notice')],
- '$oktext' => ['cookienotice-oktext', L10n::t('OK Button Text'), $oktext, L10n::t('The OK Button text')],
- '$submit' => L10n::t('Save Settings')
+ '$text' => ['cookienotice-text', L10n::t('Cookie Usage Notice'), $text],
+ '$oktext' => ['cookienotice-oktext', L10n::t('OK Button Text'), $oktext],
+ '$submit' => L10n::t('Save Settings')
]);
return;
}
-function cookienotice_addon_settings_post(&$a, &$b)
+/**
+ * cookienotice_addon_admin_post
+ * handles the post request from the admin panel
+ *
+ * @param App $a
+ *
+ * @return void
+ */
+function cookienotice_addon_admin_post(App $a)
{
- if (!is_site_admin())
+ if (!is_site_admin()) {
return;
+ }
if ($_POST['cookienotice-submit']) {
Config::set('cookienotice', 'text', trim(strip_tags($_POST['cookienotice-text'])));
Config::set('cookienotice', 'oktext', trim(strip_tags($_POST['cookienotice-oktext'])));
- info(L10n::t('cookienotice Settings saved.') . EOL);
+ info(L10n::t('cookienotice Settings saved.'));
}
}
/**
- * adds the link and script to the page head
- *
- * @param App $a
- * @param string $b - The page html before page_content_top
+ * cookienotice_page_content_top
+ * page_content_top hook
+ * adds css and scripts to the <head> section of the html
+ *
+ * @param App $a
+ * @param string $b unused - the header html incl. nav
+ *
+ * @return void
*/
-function cookienotice_page_content_top($a, &$b)
+function cookienotice_page_content_top(App $a, &$b)
{
- $head = file_get_contents(__DIR__ . '/templates/head.tpl');
- $a->page['htmlhead'] .= $head;
+ $stylesheetPath = __DIR__ . '/cookienotice.css';
+ $footerscriptPath = __DIR__ . '/cookienotice.js';
+
+ DI::page()->registerStylesheet($stylesheetPath);
+ DI::page()->registerFooterScript($footerscriptPath);
}
/**
- * adds the html to page end
- * page_end hook function
- *
- * @param App $a
- * @param string $b - The page html
+ * cookienotice_page_end
+ * page_end hook
+ * ads our cookienotice box to the end of the html
+ *
+ * @param App $a
+ * @param string $b the page html
+ *
+ * @return void
*/
-function cookienotice_page_end($a, &$b)
+function cookienotice_page_end(App $a, &$b)
{
- $text = (string) Config::get('cookienotice', 'text');
- $oktext = (string) Config::get('cookienotice', 'oktext');
+ $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.'));
+ $oktext = (string)Config::get('cookienotice', 'oktext', L10n::t('OK'));
- $page_end_tpl = get_markup_template("cookienotice.tpl", "addon/cookienotice/");
+ $page_end_tpl = Renderer::getMarkupTemplate('cookienotice.tpl', __DIR__);
- $page_end = replace_macros($page_end_tpl, [
- '$text' => $text,
+ $page_end = Renderer::replaceMacros($page_end_tpl, [
+ '$text' => $text,
'$oktext' => $oktext,
]);
projects / friendica-addons.git / blobdiff