' . - form::field( - 'disclaimer_title', - 30, - 255, - html::escapeHTML((string) $s->get('disclaimer_title')) - ) . - '
' . - - '' . - form::field( - 'disclaimer_redir', - 30, - 255, - html::escapeHTML((string) $s->get('disclaimer_redir')) - ) . '
' . - '' . __('Leave blank to redirect to the site Dotclear') . '
' . - - '' . - form::textarea( - 'disclaimer_text', - 60, - 5, - [ - 'default' => html::escapeHTML((string) $s->get('disclaimer_text')), - 'extra_html' => 'lang="' . dcCore::app()->blog->settings->get('system')->get('lang') . '" spellcheck="true"', - ] - ) . '
' . - - '' . - form::field( - 'disclaimer_bots_agents', - 120, - 255, - html::escapeHTML($disclaimer_bots_agents) - ) . '
' . - - '' . - - 'You must accept this term before entering
'), - //'You must accept this term before entering', - 'string', - ], - [ - 'disclaimer_bots_unactive', - 'Bypass disclaimer for bots', - false, - 'boolean', - ], - [ - 'disclaimer_bots_agents', - 'List of know bots', - implode(';', [ - 'bot', - 'Scooter', - 'Slurp', - 'Voila', - 'WiseNut', - 'Fast', - 'Index', - 'Teoma', - 'Mirago', - 'search', - 'find', - 'loader', - 'archive', - 'Spider', - 'Crawler', - ]), - 'string', - ], -]; +namespace Dotclear\Plugin\disclaimer; -// Nothing to change below -try { - // Version - if (!dcCore::app()->newVersion( - basename(__DIR__), - dcCore::app()->plugins->moduleInfo(basename(__DIR__), 'version') - )) { - return null; +use dcCore; +use dcNsProcess; +use Exception; + +class Install extends dcNsProcess +{ + public static function init(): bool + { + static::$init = defined('DC_CONTEXT_ADMIN') + && My::phpCompliant() + && dcCore::app()->newVersion(My::id(), dcCore::app()->plugins->moduleInfo(My::id(), 'version')); + + return static::$init; } - // Settings - dcCore::app()->blog->settings->addNamespace(basename(__DIR__)); - foreach ($mod_conf as $v) { - dcCore::app()->blog->settings->get(basename(__DIR__))->put( - $v[0], - $v[2], - $v[3], - $v[1], - false, - true - ); + public static function process(): bool + { + if (!static::$init) { + return false; + } + + // Module specs + $mod_conf = [ + [ + 'disclaimer_active', + 'Enable disclaimer plugin', + false, + 'boolean', + ], + [ + 'disclaimer_remember', + 'Remember the visitor who has already accepted the terms', + false, + 'boolean', + ], + [ + 'disclaimer_redir', + 'Redirection if disclaimer is refused', + 'https://www.google.fr', + 'string', + ], + [ + 'disclaimer_title', + 'Title for disclaimer', + 'Disclaimer', + 'string', + ], + [ + 'disclaimer_text', + 'Description for disclaimer', + __('You must accept this term before entering
'), + //'You must accept this term before entering', + 'string', + ], + [ + 'disclaimer_bots_unactive', + 'Bypass disclaimer for bots', + false, + 'boolean', + ], + [ + 'disclaimer_bots_agents', + 'List of know bots', + implode(';', [ + 'bot', + 'Scooter', + 'Slurp', + 'Voila', + 'WiseNut', + 'Fast', + 'Index', + 'Teoma', + 'Mirago', + 'search', + 'find', + 'loader', + 'archive', + 'Spider', + 'Crawler', + ]), + 'string', + ], + ]; + + try { + // Settings + foreach ($mod_conf as $v) { + dcCore::app()->blog->settings->get(My::id())->put( + $v[0], + $v[2], + $v[3], + $v[1], + false, + true + ); + } + + return true; + } catch (Exception $e) { + dcCore::app()->error->add($e->getMessage()); + } + + return true; } - - return true; -} catch (Exception $e) { - dcCore::app()->error->add($e->getMessage()); } - -return false; diff --git a/src/My.php b/src/My.php new file mode 100644 index 0000000..d246b92 --- /dev/null +++ b/src/My.php @@ -0,0 +1,83 @@ +plugins->moduleInfo(self::id(), 'name')); + } + + /** + * This mdoule directory + */ + public static function root(): string + { + return dirname(__DIR__); + } + + /** + * Check php version + */ + public static function phpCompliant(): bool + { + return version_compare(phpversion(), self::PHP_MIN, '>='); + } +} diff --git a/src/Uninstall.php b/src/Uninstall.php index bbff3f5..d19efc9 100644 --- a/src/Uninstall.php +++ b/src/Uninstall.php @@ -10,72 +10,93 @@ * @copyright Jean-Christian Denis * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html */ -if (!defined('DC_CONTEXT_ADMIN')) { - return null; +declare(strict_types=1); + +namespace Dotclear\Plugin\disclaimer; + +class Uninstall +{ + protected static bool $init = false; + + public static function init(): bool + { + self::$init = defined('DC_RC_PATH'); + + return self::$init; + } + + public static function process($uninstaller): ?bool + { + if (!self::$init) { + return false; + } + + $uninstaller->addUserAction( + /* type */ + 'settings', + /* action */ + 'delete_all', + /* ns */ + My::id(), + /* desc */ + __('delete all settings') + ); + + $uninstaller->addUserAction( + /* type */ + 'plugins', + /* action */ + 'delete', + /* ns */ + My::id(), + /* desc */ + __('delete plugin files') + ); + + $uninstaller->addUserAction( + /* type */ + 'versions', + /* action */ + 'delete', + /* ns */ + My::id(), + /* desc */ + __('delete the version number') + ); + + $uninstaller->addDirectAction( + /* type */ + 'settings', + /* action */ + 'delete_all', + /* ns */ + My::id(), + /* desc */ + sprintf(__('delete all %s settings'), My::id()) + ); + + $uninstaller->addDirectAction( + /* type */ + 'plugins', + /* action */ + 'delete', + /* ns */ + My::id(), + /* desc */ + sprintf(__('delete %s plugin files'), My::id()) + ); + + $uninstaller->addDirectAction( + /* type */ + 'versions', + /* action */ + 'delete', + /* ns */ + My::id(), + /* desc */ + sprintf(__('delete %s version number'), My::id()) + ); + + return true; + } } - -$this->addUserAction( - /* type */ - 'settings', - /* action */ - 'delete_all', - /* ns */ - basename(__DIR__), - /* desc */ - __('delete all settings') -); - -$this->addUserAction( - /* type */ - 'plugins', - /* action */ - 'delete', - /* ns */ - basename(__DIR__), - /* desc */ - __('delete plugin files') -); - -$this->addUserAction( - /* type */ - 'versions', - /* action */ - 'delete', - /* ns */ - basename(__DIR__), - /* desc */ - __('delete the version number') -); - -$this->addDirectAction( - /* type */ - 'settings', - /* action */ - 'delete_all', - /* ns */ - basename(__DIR__), - /* desc */ - sprintf(__('delete all %s settings'), basename(__DIR__)) -); - -$this->addDirectAction( - /* type */ - 'plugins', - /* action */ - 'delete', - /* ns */ - basename(__DIR__), - /* desc */ - sprintf(__('delete %s plugin files'), basename(__DIR__)) -); - -$this->addDirectAction( - /* type */ - 'versions', - /* action */ - 'delete', - /* ns */ - basename(__DIR__), - /* desc */ - sprintf(__('delete %s version number'), basename(__DIR__)) -); diff --git a/src/UrlHandler.php b/src/UrlHandler.php new file mode 100644 index 0000000..e3cd2d1 --- /dev/null +++ b/src/UrlHandler.php @@ -0,0 +1,152 @@ +blog->settings->get(My::id()); + + # Test user-agent to see if it is a bot + if (!$s->get('disclaimer_bots_unactive')) { + $bots_agents = $s->get('diclaimer_bots_agents'); + $bots_agents = !$bots_agents ? My::DEFAULT_BOTS_AGENTS : explode(';', $bots_agents); + + $is_bot = false; + foreach ($bots_agents as $bot) { + if (stristr($_SERVER['HTTP_USER_AGENT'], $bot)) { + $is_bot = true; + } + } + + if ($is_bot) { + return; + } + } + + # Set default-templates path for disclaimer files + $tplset = dcCore::app()->themes->moduleInfo(dcCore::app()->blog->settings->get('system')->get('theme'), 'tplset'); + if (!empty($tplset) && is_dir(My::root() . '/default-templates/' . $tplset)) { + dcCore::app()->tpl->setPath(dcCore::app()->tpl->getPath(), My::root() . '/default-templates/' . $tplset); + } else { + dcCore::app()->tpl->setPath(dcCore::app()->tpl->getPath(), My::root() . '/default-templates/' . DC_DEFAULT_TPLSET); + } + + # New URL handler + $urlHandler = new HelperHandler(); + $urlHandler->mode = dcCore::app()->url->mode; + $urlHandler->registerDefault([ + self::class, + 'overwriteCallbacks', + ]); + + # Create session + $session = new sessionDB( + dcCore::app()->con, + dcCore::app()->prefix . 'session', + My::SESSION_PREFIX . dcCore::app()->blog->id, + '/' + ); + $session->start(); + + # Remove all URLs representations + foreach (dcCore::app()->url->getTypes() as $k => $v) { + $urlHandler->register( + $k, + $v['url'], + $v['representation'], + [self::class, 'overwriteCallbacks'] + ); + } + + # Get type + $urlHandler->getDocument(); + $type = $urlHandler->type; + unset($urlHandler); + + # Test cookie + $cookie_name = My::COOKIE_PREFIX . dcCore::app()->blog->id; + $cookie_value = empty($_COOKIE[$cookie_name]) || !$s->get('disclaimer_remember') ? + false : ($_COOKIE[$cookie_name]) == 1; + + # User say "disagree" so go away + if (isset($_POST['disclaimerdisagree'])) { + $session->destroy(); + if ($s->get('disclaimer_remember')) { + setcookie($cookie_name, '0', time() - 86400, '/'); + } + $redir = $s->get('disclaimer_redir'); + if (!$redir) { + $redir = 'http://www.dotclear.org'; + } + Http::redirect($redir); + exit; + } + + # Check if user say yes before + elseif (!isset($_SESSION['sess_blog_disclaimer']) + || $_SESSION['sess_blog_disclaimer'] != 1 + ) { + if ($s->get('disclaimer_remember') + && $cookie_value != false + ) { + $_SESSION['sess_blog_disclaimer'] = 1; + + return; + } + if (!empty($_POST['disclaimeragree'])) { + $_SESSION['sess_blog_disclaimer'] = 1; + + if ($s->get('disclaimer_remember')) { + setcookie($cookie_name, '1', time() + 31536000, '/'); + } + + return; + } + + $session->destroy(); + self::serveDocument('disclaimer.html', 'text/html', false); + exit; + } + } +}