friendica-addons/cookienotice/cookienotice.php

<?php

/**
 * Name: Cookie Notice
 * Description: Configure, show and handle a simple cookie notice
 * Version: 1.0
 * Author: Peter Liebetrau <https://socivitas/profile/peerteer>
 */

use Friendica\Core\Hook;
use Friendica\Core\Renderer;
use Friendica\DI;

/**
 * cookienotice_install
 * registers hooks
 *
 * @return void
 */
function cookienotice_install()
{
	Hook::register('page_content_top', __FILE__, 'cookienotice_page_content_top');
	Hook::register('page_end', __FILE__, 'cookienotice_page_end');
}

/**
 * cookienotice_addon_admin
 * creates the admins config panel
 *
 * @param string $s The existing config panel html so far
 *
 * @return void
 */
function cookienotice_addon_admin(&$s)
{
	if (!DI::userSession()->isSiteAdmin()) {
		return;
	}

	$text = DI::config()->get('cookienotice', 'text', DI::l10n()->t('This website uses cookies. If you continue browsing this website, you agree to the usage of cookies.'));
	$oktext = DI::config()->get('cookienotice', 'oktext', DI::l10n()->t('OK'));

	$t = Renderer::getMarkupTemplate('admin.tpl', 'addon/cookienotice/');
	$s .= Renderer::replaceMacros($t, [
		'$description' => DI::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', DI::l10n()->t('Cookie Usage Notice'), $text],
		'$oktext' => ['cookienotice-oktext', DI::l10n()->t('OK Button Text'), $oktext],
		'$submit' => DI::l10n()->t('Save Settings')
	]);

	return;
}

/**
 * cookienotice_addon_admin_post
 * handles the post request from the admin panel
 *
 * @return void
 */
function cookienotice_addon_admin_post()
{
	if (!DI::userSession()->isSiteAdmin()) {
		return;
	}

	if ($_POST['cookienotice-submit']) {
		DI::config()->set('cookienotice', 'text', trim(strip_tags($_POST['cookienotice-text'])));
		DI::config()->set('cookienotice', 'oktext', trim(strip_tags($_POST['cookienotice-oktext'])));
	}
}

/**
 * cookienotice_page_content_top
 * page_content_top hook
 * adds css and scripts to the <head> section of the html
 *
 * @param string $b unused - the header html incl. nav
 *
 * @return void
 */
function cookienotice_page_content_top(string &$b)
{
	DI::page()->registerStylesheet(__DIR__ . '/cookienotice.css');
	DI::page()->registerFooterScript(__DIR__ . '/cookienotice.js');
}

/**
 * cookienotice_page_end
 * page_end hook
 * ads our cookienotice box to the end of the html
 *
 * @param string $b the page html
 *
 * @return void
 */
function cookienotice_page_end(string &$b)
{
	$text = (string)DI::config()->get('cookienotice', 'text', DI::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)DI::config()->get('cookienotice', 'oktext', DI::l10n()->t('OK'));

	$page_end_tpl = Renderer::getMarkupTemplate('cookienotice.tpl', 'addon/cookienotice/');

	$page_end = Renderer::replaceMacros($page_end_tpl, [
		'$text' => $text,
		'$oktext' => $oktext,
	]);

	$b .= $page_end;
}
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`<?php`

			`/**`
			`* Name: Cookie Notice`
			`* Description: Configure, show and handle a simple cookie notice`
			`* Version: 1.0`
			`* Author: Peter Liebetrau <https://socivitas/profile/peerteer>`
			`*/`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00
			`use Friendica\Core\Hook;`
cookienotice addon - fixes for #pullrequestreview-195091211 2019-01-23 09:47:08 +00:00			`use Friendica\Core\Renderer;`
Remove deprecated App::registerStylesheet()/FooterScript() - replace with DI::page()->registerStylesheet()/FooterScript() 2019-12-16 00:08:47 +00:00			`use Friendica\DI;`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`/**`
			`* cookienotice_install`
			`* registers hooks`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`*`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* @return void`
			`*/`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`function cookienotice_install()`
			`{`
cookienotice addon - fixes for changerequest #pullrequestreview-195527901 2019-01-23 15:01:28 +00:00			`Hook::register('page_content_top', __FILE__, 'cookienotice_page_content_top');`
			`Hook::register('page_end', __FILE__, 'cookienotice_page_end');`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`}`

cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`/**`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`* cookienotice_addon_admin`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* creates the admins config panel`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`*`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* @param string $s The existing config panel html so far`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`*`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* @return void`
			`*/`
[various] Remove App dependency from hook functions 2023-01-14 02:16:09 +00:00			`function cookienotice_addon_admin(&$s)`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`{`
[various] Remove App dependency from hook functions 2023-01-14 02:16:09 +00:00			`if (!DI::userSession()->isSiteAdmin()) {`
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00			`return;`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`}`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00
Move Config::get() to DI::config()->get() 2020-01-19 20:21:12 +00:00			`$text = DI::config()->get('cookienotice', 'text', DI::l10n()->t('This website uses cookies. If you continue browsing this website, you agree to the usage of cookies.'));`
			`$oktext = DI::config()->get('cookienotice', 'oktext', DI::l10n()->t('OK'));`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00
Template Engine with Subdirectory - Use explicit root path for template engine - Replace "__DIR__" calls in addons with subdirectories - Fixes local tests, where call is made out of '/' and not '/vagrant/' 2020-04-26 13:45:25 +00:00			`$t = Renderer::getMarkupTemplate('admin.tpl', 'addon/cookienotice/');`
cookienotice addon - fixes for #pullrequestreview-195091211 2019-01-23 09:47:08 +00:00			`$s .= Renderer::replaceMacros($t, [`
Move L10n::t() calls to DI::l10n()->t() calls 2020-01-18 19:52:33 +00:00			`'$description' => DI::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', DI::l10n()->t('Cookie Usage Notice'), $text],`
			`'$oktext' => ['cookienotice-oktext', DI::l10n()->t('OK Button Text'), $oktext],`
			`'$submit' => DI::l10n()->t('Save Settings')`
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00			`]);`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00			`return;`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`}`

cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`/**`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`* cookienotice_addon_admin_post`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* handles the post request from the admin panel`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`*`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* @return void`
			`*/`
[various] Remove App dependency from hook functions 2023-01-14 02:16:09 +00:00			`function cookienotice_addon_admin_post()`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`{`
[various] Remove App dependency from hook functions 2023-01-14 02:16:09 +00:00			`if (!DI::userSession()->isSiteAdmin()) {`
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00			`return;`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`}`
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00
			`if ($_POST['cookienotice-submit']) {`
Move Config::set() to DI::config()->set() 2020-01-19 20:21:52 +00:00			`DI::config()->set('cookienotice', 'text', trim(strip_tags($_POST['cookienotice-text'])));`
			`DI::config()->set('cookienotice', 'oktext', trim(strip_tags($_POST['cookienotice-oktext'])));`
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00			`}`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`}`

			`/**`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* cookienotice_page_content_top`
			`* page_content_top hook`
			`* adds css and scripts to the <head> section of the html`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`*`
			`* @param string $b unused - the header html incl. nav`
			`*`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* @return void`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`*/`
[various] Remove App dependency from hook functions 2023-01-14 02:16:09 +00:00			`function cookienotice_page_content_top(string &$b)`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`{`
[various] Use __DIR__ constant in all Page registerStylesheet and registerFooterScript calls 2021-11-20 09:29:09 +00:00			`DI::page()->registerStylesheet(__DIR__ . '/cookienotice.css');`
			`DI::page()->registerFooterScript(__DIR__ . '/cookienotice.js');`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`}`

			`/**`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* cookienotice_page_end`
			`* page_end hook`
			`* ads our cookienotice box to the end of the html`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`*`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* @param string $b the page html`
[cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks 2019-05-08 04:43:27 +00:00			`*`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`* @return void`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`*/`
[various] Remove App dependency from hook functions 2023-01-14 02:16:09 +00:00			`function cookienotice_page_end(string &$b)`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`{`
Move Config::get() to DI::config()->get() 2020-01-19 20:21:12 +00:00			`$text = (string)DI::config()->get('cookienotice', 'text', DI::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)DI::config()->get('cookienotice', 'oktext', DI::l10n()->t('OK'));`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00
Template Engine with Subdirectory - Use explicit root path for template engine - Replace "__DIR__" calls in addons with subdirectories - Fixes local tests, where call is made out of '/' and not '/vagrant/' 2020-04-26 13:45:25 +00:00			`$page_end_tpl = Renderer::getMarkupTemplate('cookienotice.tpl', 'addon/cookienotice/');`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00
cookienotice addon - fixes for #pullrequestreview-195091211 2019-01-23 09:47:08 +00:00			`$page_end = Renderer::replaceMacros($page_end_tpl, [`
cookienotice addon - fixes from pull request reviews 2019-01-20 19:35:58 +00:00			`'$text' => $text,`
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00			`'$oktext' => $oktext,`
			`]);`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00
convert spaces to tabs, removed netbeans project files 2019-01-20 13:20:20 +00:00			`$b .= $page_end;`
new addon - cookienotice - configure, show and handle a simple cookie usage notice 2019-01-20 09:04:25 +00:00			`}`