termly/0000777000000000000000000000000014565772403011111 5ustar rootroottermly/addon.setup.php0000666000000000000000000000077114565772403014053 0ustar rootroot 'Termly', 'author_url' => 'https://termly.io/', 'name' => TERMLY_NAME, 'version' => TERMLY_VERSION, 'description' => 'Easy to use cookie consent plugin can assist in your GDPR and ePrivacy Directive compliance efforts.', 'docs_url' => '', 'namespace' => 'Termly', 'models' => [ 'Config' => 'Model\Config', ], 'settings_exist' => true, ]; termly/javascript/0000777000000000000000000000000014565772403013257 5ustar rootroottermly/javascript/script.js0000666000000000000000000000310514565772403015120 0ustar rootroot$(document).ready(function() { if ($('#enable_consent_banner').is(':checked')) { $('.auto_blocker_section').show(); } $('').insertBefore($('.sidebar__link:last-child')); }).on('click', '#scan_enabled', function () { if ($(this).is(':checked')) { $('#scan_period').prop('disabled', false); } else { $('#scan_period').prop('disabled', true); } }).on('click', '.termly-copy-clipboard', function() { let target = document.getElementById('banner-code'), range = document.createRange(); $(this).data('text', $(this).text()); range.selectNode(target); window.getSelection().removeAllRanges(); window.getSelection().addRange(range); document.execCommand('copy'); window.getSelection().removeAllRanges(); $(this).html('') }).on('mouseleave', '.termly-copy-clipboard', function() { $(this).html($(this).data('text')); }).on('change', '#enable_consent_banner', function() { if ($(this).is(':checked')) { $('.auto_blocker_section').show(); } else { $('.auto_blocker_section').hide(); } });termly/mod.termly.php0000666000000000000000000000136514565772403013721 0ustar rootroot', $uuid, $auto_block ); } } termly/views/0000777000000000000000000000000014565772403012246 5ustar rootroottermly/views/account.php0000666000000000000000000000404514565772403014416 0ustar rootroot

termly/views/policies.php0000666000000000000000000002301414565772403014566 0ustar rootroot

Policies

termly/views/cookie_management.php0000666000000000000000000000510614565772403016426 0ustar rootroot

'search', 'id' => 'search']); ?>
'target', 'id' => 'target']); ?> embed('ee:_shared/table', $table); echo $pagination; ?>
'modal-confirm-delete', 'form_url' => ee('CP/URL')->make('addons/settings/termly/delete_cookies'), 'hidden' => [ 'bulk_action' => 'delete' ] ]; ee()->javascript->set_global( 'lang.remove_confirm', 'Cookie: ### Cookies' ); $modal = $this->make('ee:_shared/modal_confirm_remove')->render($modal_vars); ee('CP/Modal')->addModal('delete', $modal); ?>termly/views/site_scan.php0000666000000000000000000000535314565772403014735 0ustar rootroot

termly/views/signup.php0000666000000000000000000000010414565772403014257 0ustar rootroot
embed('ee:_shared/form')?>
termly/views/banner_settings.php0000666000000000000000000000523714565772403016153 0ustar rootroot

termly/views/setup_wizard.php0000666000000000000000000000253314565772403015502 0ustar rootroot

termly/ext.termly.php0000666000000000000000000000557114565772403013745 0ustar rootroot_setExtensions(); } public function update_extension($current = '') { if ($current == '' OR $current == $this->version) { return false; } $this->_setExtensions(); } public function disable_extension() { ee()->db->where('class', __CLASS__); ee()->db->delete('extensions'); } private function _setExtensions() { $extensions = [ [ // Add this add on to the menu manger 'class' => __CLASS__, 'method' => 'addToMenu', 'hook' => 'cp_custom_menu', 'settings' => '', 'priority' => 10, 'version' => $this->version, 'enabled' => 'y', ] ]; foreach ($extensions as $extension) { // Check if set already if (ee()->db->select('extension_id')->from('extensions')->where(['class' => $extension['class'], 'method' => $extension['method']])->get()->num_rows() > 0) { // Update the extensions ee()->db->update( 'extensions', [ 'hook' => $extension['hook'], 'settings' => $extension['settings'], 'priority' => $extension['priority'], 'version' => $extension['version'], 'enabled' => $extension['enabled'], ], [ 'class' => $extension['class'], 'method' => $extension['method'], ], ); } else { ee()->db->insert('extensions', $extension); } } } public function addToMenu($menu) { ee()->lang->loadfile($this->short_name); $sub = $menu->addSubmenu($this->name); $uuid = TermlyHelper::getSetting('uuid'); foreach(['account', 'site_scan', 'cookie_management', 'banner_settings', 'policies'] as $page) { if ( ! empty($uuid) || $page == 'account') { $sub->addItem( lang($page), ee('CP/URL')->make('addons/settings/termly/' . $page) ); } } $addon_icon_act = ee()->cp->fetch_action_id('File', 'addonIcon'); // For EE6 only if (!empty($addon_icon_act)) { $site_url = site_url(); $addon_icon_url = $site_url . '?ACT=' . $addon_icon_act . '&addon=' . $this->short_name . '&file=icon.svg'; $javascript_addon_name = 'addon_' . $this->short_name; // Replace with our own icon :D ee()->cp->add_to_foot(''); } } } termly/jump.termly.php0000666000000000000000000000265214565772403014115 0ustar rootroot [ 'icon' => 'fa-address-card', 'command' => 'account', 'command_title' => 'Account', 'dynamic' => false, 'requires_keyword' => false, 'target' => 'account', ], 'runSiteScan' => [ 'icon' => 'fa-sync-alt', 'command' => 'run site scan', 'command_title' => 'Run Site Scan', 'dynamic' => false, 'requires_keyword' => false, 'target' => 'site_scan/scan', ], 'siteScan' => [ 'icon' => 'fa-cog', 'command' => 'site scan settings', 'command_title' => 'Site Scan Settings', 'dynamic' => false, 'requires_keyword' => false, 'target' => 'site_scan', ], 'cookieManagement' => [ 'icon' => 'fa-tasks', 'command' => 'cookie management', 'command_title' => 'Cookie Management', 'dynamic' => false, 'requires_keyword' => false, 'target' => 'cookie_management', ], 'bannerSettings' => [ 'icon' => 'fa-tools', 'command' => 'banner settings', 'command_title' => 'Banner Settings', 'dynamic' => false, 'requires_keyword' => false, 'target' => 'banner_settings', ], 'policies' => [ 'icon' => 'fa-feather-alt', 'command' => 'policies', 'command_title' => 'Policies', 'dynamic' => false, 'requires_keyword' => false, 'target' => 'policies', ], ]; } termly/icon.svg0000666000000000000000000000062014565772403012560 0ustar rootroot Termly termly/upd.termly.php0000666000000000000000000000603014565772403013724 0ustar rootroot_initialDbScripts(); $data = [ 'module_name' => $this->class_name, 'module_version' => $this->version, 'has_cp_backend' => 'y', 'has_publish_fields' => 'n' ]; ee()->db->insert('modules', $data); return true; } public function uninstall() { parent::__construct(); $this->_termlyUninstall(); return true; } public function update($current = '') { $this->_initialDbScripts($current); return true; } private function _initialDbScripts($current = null) { $this->_setupConfig(); } private function _termlyUninstall($tables_to_be_removed = []) { ee()->db->select('module_id'); $query = ee()->db->get_where('modules', ['module_name' => $this->class_name]); $module_id = $query->row('module_id'); // Remove from allowed member groups/roles if (version_compare(APP_VER, '6', '<')) { ee()->db->delete('module_member_groups', ['module_id' => $module_id]); } else { ee()->db->delete('module_member_roles', ['module_id' => $module_id]); } // Remove from menu items ee()->db->delete('menu_items', ['name' => $this->name]); // Remove from actions ee()->db->delete('actions', ['class' => $this->class_name]); ee()->load->dbforge(); // Drop the settings table $table_name = $this->short_name . '_settings'; ee()->dbforge->drop_table($table_name); // Delete other tables foreach ($tables_to_be_removed as $remove_table) { ee()->dbforge->drop_table($remove_table); } $cache_key = '/Termly/'; ee()->cache->delete($cache_key, 1); // Remove our module :( ee()->db->delete('modules', ['module_name' => $this->class_name]); } private function _setupConfig() { ee()->load->dbforge(); $table_name = $this->short_name . '_settings'; if (!ee()->db->table_exists($table_name)) { ee()->dbforge->add_field([ 'setting_id' => ['type' => 'int', 'constraint' => 4, 'unsigned' => true, 'auto_increment' => true], 'setting_name' => ['type' => 'varchar', 'constraint' => 32], 'value' => ['type' => 'text'] ]); ee()->dbforge->add_key('setting_id', true); ee()->dbforge->create_table($table_name); } } } termly/README.md0000666000000000000000000000001014565772403012357 0ustar rootroot# Termlytermly/mcp.termly.php0000666000000000000000000012560414565772403013724 0ustar rootrootuuid = TermlyHelper::getSetting('uuid'); $this->active_subscription = TermlyHelper::getActiveSubscription(); ee()->lang->loadfile('admin'); $this->module_name = lang('termly_module_name'); $this->icon = TermlyHelper::getIcon(); // Should we run the setup wizard? $this->setup_wizard = ee('Model')->get($this->short_name . ':Config')->filter('setting_name', 'setup_wizard')->first(); if (empty($this->setup_wizard)) { $this->_promptSetupWizard(); } elseif ($this->setup_wizard->value != 'done') { $uri = explode('/', uri_string()); $current_page = $uri[count($uri) - 1]; if ($current_page != 'setup_wizard') { ee('CP/Alert')->makeInline('setup_wizard') ->asWarning() ->withTitle(lang('setup_wizard')) ->addToBody(sprintf(lang('setup_not_done'), ee('CP/URL')->make('addons/settings/termly/setup_wizard'))) ->now(); } } } private function _buildNav($current_page = '') { $sidebar = ee('CP/Sidebar')->make(); $sd_div = $sidebar->addHeader(lang('settings')); if ($this->setup_wizard->value != 'done') { $sd_div = $sidebar->addItem(lang('setup_wizard'), ee('CP/URL', 'addons/settings/termly/setup_wizard')); } foreach ($this->_allowed_pages as $page) { if (!empty($this->uuid) || $page == 'account') { $sd_div = $sidebar->addItem(lang($page), ee('CP/URL', 'addons/settings/termly/' . $page)); if ($page == $current_page) { $sd_div->isActive(); } } } $sd_div = $sidebar->addItem(lang('go_to_dashboard') . ' ', site_url() . '?URL=' . TermlyUrlHelper::$promo_dashboard_url)->urlIsExternal(); // Do we have an active subscription? $this->active_subscription = TermlyHelper::getActiveSubscription(); if (!$this->active_subscription) { $sd_div = $sidebar->addHeader(lang('learn_more')); $sd_div = $sidebar->addItem(lang('compare_plans'), site_url() . '?URL=' . TermlyUrlHelper::$plans_url)->urlIsExternal(); } } private function _promptSetupWizard() { // We only do this redirection once $setup_wizard = ee('Model')->make($this->short_name . ':Config', [ 'setting_name' => 'setup_wizard', 'value' => 'displayed' ]); $setup_wizard->save(); ee()->functions->redirect(ee('CP/URL')->make('addons/settings/' . $this->short_name . '/setup_wizard')); } /* Currently not in use public function signup() { $action = ee()->input->post('action'); if (!empty($action)) { switch ($action) { case 'create_account': $response = TermlyHelper::signUp(); if (!empty($response['error'])) { ee('CP/Alert')->makeInline('connect-settings') ->asIssue() ->withTitle(lang('alert_error')) ->addToBody('
' . implode('
', $response['error']) . '
') ->defer(); } else { ee('CP/Alert')->makeInline('connect-settings') ->asSuccess() ->withTitle(lang('success')) ->addToBody(lang('alert_connected')) ->defer(); } break; } ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/account')); } $this->_buildNav(); $this->_addCSS(); $vars = [ 'cp_page_title' => lang('signup'), 'base_url' => ee('CP/URL', 'addons/settings/termly/signup')->compile(), 'save_btn_text' => lang('create_account'), 'save_btn_text_working' => lang('save_btn_text_working'), ]; $vars['sections'] = [ [ [ 'title' => 'first_name', 'fields' => [ 'first_name' => ['type' => 'text', 'required' => 'true'] ], ], [ 'title' => 'last_name', 'fields' => [ 'last_name' => ['type' => 'text', 'required' => 'true'] ], ], [ 'title' => 'email', 'fields' => [ 'email' => ['type' => 'text', 'required' => 'true'] ], ], [ 'title' => 'password', 'fields' => [ 'password' => ['type' => 'password', 'required' => 'true'] ], ], [ 'title' => 'password_confirmation', 'fields' => [ 'password_confirmation' => ['type' => 'password', 'required' => 'true'] ], ], [ 'title' => 'website_url', 'fields' => [ 'website_url' => ['type' => 'text', 'required' => 'true', 'value' => site_url()] ], ], [ 'fields' => [ '' => [ 'type' => 'html', 'content' => '' ], 'agree_policy' => [ 'type' => 'html', 'content' => '' ], 'notice' => [ 'type' => 'html', 'content' => '

' . lang('signup_notice') . '

', ], 'action' => ['type' => 'hidden', 'value' => 'create_account'] ], ], ], ]; return [ 'heading' => lang('signup'), 'body' => ee('View')->make('termly:signup')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/termly')->compile() => $this->module_name ] ]; } */ public function setup_wizard($action = '') { // Are we running the wizard? if ($action == 'install') { $templates = ee()->input->post('templates'); if (!empty($templates)) { foreach ($templates as $template) { list($template_group, $template_name) = explode('/', $template); $template = ee('Model')->get('Template')->with('TemplateGroup')->filter('TemplateGroup.group_name', $template_group)->filter('template_name', $template_name)->first(); // Only install if the tempalte doesn't already have the tag if (!empty($template) && strpos($template->template_data, '{exp:termly:banner}') === false) { $template->template_data = str_replace('', '' . NL . '{exp:termly:banner}', $template->template_data); $template->save(); } } } $api_key = ee()->input->post('api_key'); if (!empty($api_key)) { TermlyHelper::connectSite($api_key); } } $this->_buildNav('setup_wizard'); $this->_addCSS(); $settings = TermlyHelper::getSettings(); $vars = []; $vars['signup_url'] = TermlyUrlHelper::$signup_url; $vars['action_url'] = ee('CP/URL', 'addons/settings/termly/setup_wizard/install'); $vars['template_selector'] = ''; $vars['addon_icon_url'] = $this->icon; $vars['api_key'] = $settings['api_key'] ?? ''; $setup_wizard = ee('Model')->get($this->short_name . ':Config')->filter('setting_name', 'setup_wizard')->first(); if ($setup_wizard->value == 'done') { ee('CP/Alert')->makeInline('setup_wizard') ->asSuccess() ->withTitle(lang('setup_wizard')) ->addToBody(lang('setup_all_good')) ->defer(); ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/account')); } else { $templates = ee('Model')->get('Template')->all(); if (empty($templates->count())) { $vars['body'] = ee('CP/Alert')->makeInline('setup_wizard') ->asWarning() ->withTitle(lang('setup_wizard')) ->addToBody(sprintf(lang('setup_no_templates'), ee('CP/URL')->make('design/system'))) ->now(); ee('CP/URL')->make('addons/settings/termly/setup_wizard', ['run' => 'wizard']); } else { $notified = false; $template_selector = ''; foreach ($templates as $template) { // Does it already have the termly banner if (strpos($template->template_data, '{exp:termly:banner}') !== false) { // Only create alert banner once if (!$notified) { if (!empty($settings['api_key'])) { ee('CP/Alert')->makeInline('setup_wizard') ->asSuccess() ->withTitle(lang('setup_wizard')) ->addToBody(lang('setup_all_good')) ->defer(); // All good $setup_wizard->value = 'done'; $setup_wizard->save(); ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/account')); } else { ee('CP/Alert')->makeInline('setup_wizard') ->asWarning() ->withTitle(lang('setup_wizard')) ->addToBody(lang('setup_need_api_key')) ->now(); } } } if (strpos($template->template_data, '') !== false && strpos($template->template_data, '{exp:termly:banner}') === false) { $value = $template->TemplateGroup->group_name . '/' . $template->template_name; $template_selector .= ''; } } if (!empty($template_selector)) { $template_selector = ''; } else { $template_selector = lang('no_head_template'); } $vars['template_selector'] = $template_selector; } } $message = ee('CP/Alert')->getAllInlines(); return [ 'heading' => lang('setup_wizard'), 'body' => $message . ee('View')->make('termly:setup_wizard')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/termly')->compile() => lang('termly_module_name'), ], ]; } public function index() { ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/account')); } public function account($action = '') { $message = ee('CP/Alert')->getAllInlines(); if (!empty($action)) { switch ($action) { case 'save': $api_key = ee()->input->post('api_key'); TermlyHelper::connectSite($api_key); ee('CP/Alert')->makeInline('connect-settings') ->asSuccess() ->withTitle(lang('success')) ->addToBody(lang('alert_connected')) ->defer(); break; case 'disconnect': TermlyHelper::deleteSettings([ 'api_key', 'site_url', 'uuid', 'cookie_preference_button', 'enable_consent_banner', 'enable_auto_blocker', 'active_subscription', 'scan_enabled', 'scan_period', ]); TermlyHelper::flushCache(); ee('CP/Alert')->makeInline('site-disconnected') ->asSuccess() ->withTitle(lang('success')) ->addToBody(lang('alert_disconnected')) ->defer(); break; } ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/account')); } $this->_buildNav('account'); $this->_addCSS(); ee()->cp->load_package_js('script'); $settings = TermlyHelper::getSettings(); $vars = []; $vars['dashboard_url'] = site_url() . '?URL=' . TermlyUrlHelper::$dashboard_url; $vars['action_url'] = ee('CP/URL', 'addons/settings/termly/account/save'); $vars['signup_url'] = site_url() . '?URL=' . TermlyUrlHelper::$signup_url; $vars['disconnect_url'] = ee('CP/URL', 'addons/settings/termly/account/disconnect'); $vars['help_url'] = site_url() . '?URL=' . TermlyUrlHelper::$help_api_url; $vars['site_url'] = $settings['site_url'] ?? ''; $vars['api_key'] = $settings['api_key'] ?? ''; $vars['addon_icon_url'] = $this->icon; return [ 'heading' => lang('account'), 'body' => $message . ee('View')->make('termly:account')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/termly')->compile() => $this->module_name ] ]; } public function site_scan($action = '') { $message = ee('CP/Alert')->getAllInlines(); if (!empty($action)) { switch ($action) { case 'save': $scan_enabled = ee()->input->post('scan_enabled') ?? ''; $scan_period = ee()->input->post('scan_period') ?? ''; if (TermlyHelper::saveScanSettings($scan_enabled, $scan_period)) { ee('CP/Alert')->makeInline('save-settings') ->asSuccess() ->withTitle(lang('success')) ->addToBody(lang('alert_settings_updated')) ->defer(); } else { ee('CP/Alert')->makeInline('save-settings') ->asIssue() ->withTitle(lang('failed')) ->addToBody(lang('alert_scan_settings_not_updated')) ->defer(); } break; case 'scan': $company_email = TermlyHelper::getSetting('company_email'); TermlyHelper::scan(); ee('CP/Alert')->makeInline('save-settings') ->asSuccess() ->withTitle(lang('alert_scan_started')) ->addToBody(sprintf(lang('alert_scan_started_desc'), $company_email)) ->defer(); break; } ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/site_scan')); } $this->_buildNav('site_scan'); $this->_addCSS(); ee()->cp->load_package_js('script'); $api_key = TermlyHelper::getSetting('api_key'); // Refresh scan settings TermlyHelper::connectSite($api_key); $settings = TermlyHelper::getSettings(); $vars = []; $vars['scan_url'] = ee('CP/URL', 'addons/settings/termly/site_scan/scan'); $vars['cookie_management_url'] = ee('CP/URL', 'addons/settings/termly/cookie_management'); $vars['action_url'] = ee('CP/URL', 'addons/settings/termly/site_scan/save'); $vars['last_scanned'] = $settings['last_scanned'] ?? ''; $vars['scan_enabled'] = $settings['scan_enabled'] ?? ''; $vars['scan_period'] = $settings['scan_period'] ?? ''; $vars['active_subscription'] = $this->active_subscription; $vars['addon_icon_url'] = $this->icon; return [ 'heading' => lang('site_scan'), 'body' => $message . ee('View')->make('termly:site_scan')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/termly')->compile() => $this->module_name ] ]; } public function cookie_management() { $message = ee('CP/Alert')->getAllInlines(); $this->_buildNav('cookie_management'); $this->_addCSS(); ee()->cp->load_package_js('script'); ee()->load->library('table'); ee()->load->library('pagination'); ee()->load->library('javascript'); ee()->load->helper('form'); $base_url = ee('CP/URL')->make('addons/settings/termly/cookie_management'); $vars = []; $vars['last_scanned'] = TermlyHelper::getSetting('last_scanned') ?? ''; $vars['add_cookie_url'] = ee('CP/URL')->make('addons/settings/termly/edit_cookie'); $vars['policies_url'] = ee('CP/URL')->make('addons/settings/termly/policies'); $vars['consent_logs_url'] = site_url() . '?URL=' . TermlyUrlHelper::$dashboard_url . '/website/' . $this->uuid . '/consent-logs'; $vars['search_url'] = $this->_createBaseUrlWithExistingParameters($base_url, ['sort_col', 'sort_dir', 'filter_by_category', 'filter_by_domain']); $vars['action_url'] = $base_url; $vars['search_keywords'] = ee()->input->post('search') ?? ''; $current_page = intval(ee()->input->get('page')); if (empty($current_page)) { $current_page = 1; } $category = ee()->input->get('filter_by_category') ?: ''; $domain = ee()->input->get('filter_by_domain') ?: ''; $sort_col = ee()->input->get('sort_col') ?: 'cookie_name'; $sort_dir = ee()->input->get('sort_dir') ?: 'desc'; $page = ee()->input->get('page') ?: 1; $perpage = ee()->input->get_post('perpage') ?: 25; $offset = $perpage * ($current_page - 1); $search = ee()->input->get_post('search') ?: ''; $report = TermlyHelper::getReport(); $cookies = TermlyHelper::getCookies(); $total_count = count($cookies); list($table_data, $domain_list) = $this->_parseCookies($cookies, $search, $category, $domain, $sort_col, $sort_dir, $perpage, $offset); $filters_base_url = $this->_createBaseUrlWithExistingParameters($base_url, ['sort_col', 'sort_dir'], ['search']); $cookie_categories = []; foreach($this->_cookie_categories as $cookie) { $cookie_categories[$cookie] = lang($cookie); } $categories = ee('CP/Filter')->make('filter_by_category', 'filter_category', $cookie_categories); $categories->disableCustomValue(); $domains = ee('CP/Filter')->make('filter_by_domain', 'filter_domain', $domain_list); $domains->disableCustomValue(); $filters = ee('CP/Filter') ->add($categories) ->add($domains) ->add('Perpage', $total_count); $vars['filters'] = $filters->render($filters_base_url); $table = ee('CP/Table', [ 'autosort' => false, 'autosearch' => false, 'limit' => $perpage, 'sort_col' => (ee()->input->get('sort_col') ?: 'cookie_name'), 'sort_dir' => (ee()->input->get('sort_dir') ?: 'desc'), ]); $table->setColumns([ 'cookie_name' => [ 'encode' => false ], 'cookie_purpose', 'category', 'domain', 'manage' => [ 'type' => Table::COL_TOOLBAR, ], [ 'type' => Table::COL_CHECKBOX, ], ]); $table->setData($table_data); $vars['table'] = $table->viewData($this->_createBaseUrlWithExistingParameters($base_url, ['filter_by_category', 'filter_by_domain', 'perpage'], ['search'])); $pagination = ee('CP/Pagination', $total_count); $pagination->perPage($perpage); $pagination->currentPage($current_page); $vars['pagination'] = $pagination->render($base_url); $vars['last_updated'] =!empty($report['updated_at']) ? date('Y-m-d H:i:s', strtotime($report['updated_at'])) : ''; $vars['addon_icon_url'] = $this->icon; return [ 'heading' => lang('cookie_management'), 'body' => $message . ee('View')->make('termly:cookie_management')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/cookie_management')->compile() => $this->module_name, ], ]; } public function delete_cookie($id) { if (empty($id)) { ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/cookie_management')); } TermlyHelper::deleteCookie($id); ee('CP/Alert') ->makeInline('cookie-deleted') ->asSuccess() ->withTitle(lang('success')) ->addToBody(sprintf(lang('alert_cookie_deleted'), 1)) ->defer(); ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/cookie_management')); } public function delete_cookies() { $cookies = ee()->input->post('cookies'); if ($cookies == null || !is_array($cookies)) { ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/cookie_management')); } $count = count($cookies); foreach ($cookies as $id) { TermlyHelper::deleteCookie($id); } ee('CP/Alert') ->makeInline('cookie-deleted') ->asSuccess() ->withTitle(lang('success')) ->addToBody(sprintf(lang('alert_cookie_deleted'), $count)) ->defer(); ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/cookie_management')); } public function banner_settings($action = '') { $message = ee('CP/Alert')->getAllInlines(); TermlyHelper::getPreferenceCenterButton(); if (!empty($action)) { switch ($action) { case 'save': $report = TermlyHelper::getReport(); if (!empty($report)) { $enable_consent_banner = ee()->input->post('enable_consent_banner') ?? ''; $enable_auto_blocker = ee()->input->post('enable_auto_blocker') ?? ''; TermlyHelper::saveSettings(['enable_consent_banner' => $enable_consent_banner, 'enable_auto_blocker' => $enable_auto_blocker]); ee('CP/Alert')->makeInline('save-settings') ->asSuccess() ->withTitle(lang('success')) ->addToBody(lang('alert_settings_updated')) ->defer(); } else { ee('CP/Alert')->makeInline('save-settings') ->asWarning() ->withTitle(lang('settings_not_saved')) ->addToBody(lang('alert_need_report')) ->defer(); } break; } ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/banner_settings')); } $this->_buildNav(); $this->_addCSS(); ee()->cp->load_package_js('script'); $settings = TermlyHelper::getSettings(); $vars = []; $vars['cookie_preference_button'] = $settings['cookie_preference_button']; $vars['enable_consent_banner'] = $settings['enable_consent_banner'] ?? ''; $vars['enable_auto_blocker'] = $settings['enable_auto_blocker'] ?? ''; $vars['customize_banner_url'] = site_url() . '?URL=' . TermlyUrlHelper::$dashboard_url . '/website/' . $this->uuid . '/banner-settings'; $vars['action_url'] = ee('CP/URL', 'addons/settings/termly/banner_settings/save');; $vars['auto_blocker_url'] = TermlyUrlHelper::$help_auto_blocker_url; $vars['manual_blocking_url'] = TermlyUrlHelper::$help_javascript_blocking_url; $vars['addon_icon_url'] = $this->icon; return [ 'heading' => lang('banner_settings'), 'body' => $message . ee('View')->make('termly:banner_settings')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/termly')->compile() => $this->module_name, ], ]; } public function policies() { $message = ee('CP/Alert')->getAllInlines(); $this->_buildNav(); $this->_addCSS(); ee()->cp->load_package_js('script'); $settings = TermlyHelper::getSettings(); $site_url = site_url(); $vars = []; $vars['cookie_policy_url'] = $site_url . '?URL=https://app.termly.io/dashboard/website/' . $this->uuid . '/cookie-policy'; $vars['privacy_policy_url'] = $site_url . '?URL=https://app.termly.io/dashboard/website/' . $this->uuid . '/privacy-policy'; $vars['terms_and_conditions_url'] = $site_url . '?URL=https://app.termly.io/dashboard/website/' . $this->uuid . '/terms-of-service'; $vars['disclaimer_url'] = $site_url . '?URL=https://app.termly.io/dashboard/website/' . $this->uuid . '/disclaimer'; $vars['return_policy_url'] = $site_url . '?URL=https://app.termly.io/dashboard/website/' . $this->uuid . '/refund-policy'; $vars['addon_icon_url'] = $this->icon; return [ 'heading' => lang('policies'), 'body' => ee('View')->make('termly:policies')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/termly')->compile() => $this->module_name, ], ]; } public function edit_cookie($id = null) { $message = ee('CP/Alert')->getAllInlines(); $this->_buildNav('cookie_management'); $this->_addCSS(); if (!empty($id)) { $cookie = TermlyHelper::getCookies($id); } else { $cookie = []; } $description = 'en_us'; $vars = [ 'cp_page_title' =>!empty($id) ? lang('edit_cookie') : lang('add_cookie'), 'base_url' => ee('CP/URL', 'addons/settings/termly/update_cookie/' . $id)->compile(), 'save_btn_text' => lang('save_btn_text'), 'save_btn_text_working' => lang('save_btn_text_working'), ]; $vars['site_url'] = site_url(); $vars['sections'] = [ [ [ 'title' => 'cookie_name', 'desc' => 'cookie_name_desc', 'fields' => [ 'name' => ['type' => 'text', 'required' => true, 'value' => $cookie['name'] ?? ''] ], ], [ 'title' => 'cookie_category', 'desc' => 'cookie_category_desc', 'fields' => [ 'category' => [ 'type' => 'select', 'value' => $cookie['category'] ?? 'essential', 'required' => true, 'choices' => [ 'essential' => lang('essential'), 'performance' => lang('performance'), 'analytics' => lang('analytics'), 'advertising' => lang('advertising'), 'social_networking' => lang('social_networking'), 'unclassified' => lang('unclassified'), ], ], ], ], [ 'title' => 'cookie_expire', 'desc' => 'cookie_expire_desc', 'fields' => [ 'expire' => ['type' => 'text', 'value' => $cookie['expire'] ?? ''] ], ], [ 'title' => 'cookie_tracker_type', 'desc' => 'cookie_tracker_type_desc', 'fields' => [ 'tracker_type' => [ 'type' => 'select', 'value' => $cookie['tracker_type'] ?? 'http_cookie', 'disabled' =>!empty($id) ? true : false, 'choices' => [ 'http_cookie' => lang('http_cookie'), 'html_local_storage' => lang('html_local_storage'), 'html_session_storage' => lang('html_session_storage'), 'server_cookie' => lang('server_cookie'), 'pixel_tracker' => lang('pixel_tracker'), 'indexed_db' => lang('indexed_db'), ], ], ], ], [ 'title' => 'cookie_country', 'desc' => 'cookie_country_desc', 'fields' => [ 'country' => [ 'type' => 'select', 'value' => $cookie['country'] ?? '', 'choices' => TermlyCountries::$countries, ], ], ], [ 'title' => 'cookie_domain', 'desc' => 'cookie_domain_desc', 'fields' => [ 'domain' => ['type' => 'text', 'required' => true, 'value' => $cookie['domain'] ?? ''], ], ], [ 'title' => 'cookie_service', 'desc' => 'cookie_service_desc', 'fields' => [ 'service' => ['type' => 'text', 'value' => $cookie['service'] ?? ''], ], ], [ 'title' => 'cookie_service_policy_link', 'desc' => 'cookie_service_policy_link_desc', 'fields' => [ 'service_policy_link' => ['type' => 'text', 'value' => $cookie['service_policy_link'] ?? ''], ], ], [ 'title' => 'cookie_url', 'desc' => 'cookie_url_desc', 'fields' => [ 'url' => ['type' => 'text', 'value' => $cookie['url'] ?? ''], ], ], [ 'title' => 'cookie_value', 'desc' => 'cookie_value_desc', 'fields' => [ 'value' => ['type' => 'text', 'value' => $cookie['value'] ?? ''], ], ], [ 'title' => 'cookie_purpose', 'desc' => 'cookie_purpose_desc', 'fields' => [ $description => ['type' => 'textarea', 'value' => $cookie[$description] ?? ''], ], ], ], ]; $vars['alert'] = null; return [ 'heading' => $vars['cp_page_title'], 'body' => $message . ee('View')->make('ee:_shared/form')->render($vars), 'breadcrumb' => [ ee('CP/URL', 'addons/settings/termly')->compile() => $this->module_name, ], ]; } public function update_cookie($id = null) { if (!empty($id)) { TermlyHelper::updateCookie($id); } else { if (!TermlyHelper::createCookie()) { ee('CP/Alert')->makeInline('create-cookie') ->asIssue() ->withTitle(lang('alert_error')) ->addToBody(lang('required_field_empty')) ->defer(); } } ee()->functions->redirect(ee('CP/URL')->make('addons/settings/termly/cookie_management')); } private function _parseCookies($cookies, $search, $category, $domain, $sort_col, $sort_dir, $perpage, $offset) { $description = 'en_us'; $domain_list = []; $data = []; $edit_url = ee('CP/URL', 'addons/settings/termly/edit_cookie/%s'); $delete_url = ee('CP/URL', 'addons/settings/termly/delete_cookie/%s'); foreach ($cookies as $cookie_id => $cookie) { if (!in_array($cookie['domain'], $domain_list)) { $domain_list[$cookie['domain']] = $cookie['domain']; } $cookie_description = strval($cookie[$description]); if (empty($search) || (strpos($cookie['name'], $search) !== false || strpos($cookie_description, $search) !== false || strpos($cookie['category'], $search) !== false || strpos($cookie['domain'], $search) !== false)) { $data[] = [ 'cookie_name' => $cookie['name'] . ($cookie['new'] ? ' New' : ''), 'description' => $cookie[$description], 'category' => lang($cookie['category']), 'domain' => $cookie['domain'], ['toolbar_items' => [ 'edit' => [ 'href' => sprintf($edit_url, $cookie_id), 'title' => lang('edit'), ], 'remove' => [ 'href' => sprintf($delete_url, $cookie_id), 'title' => lang('delete'), ], ]], 'checkbox' => [ 'name' => 'cookies[]', 'value' => $cookie['id'], 'data' => [ 'confirm' => lang('cookie') . ': ' . $cookie['name'] . '' ] ], ]; } } if (!empty($category) || !empty($domain)) { $data = array_filter($data, function ($cookie) use ($category, $domain) { return (empty($category) || $cookie['category'] == lang($category)) && (empty($domain) || $cookie['domain'] == $domain); }); } if (!empty($sort_col)) { $columns = array_column($data, $sort_col); $sort_dir = $sort_dir == 'desc' ? SORT_DESC : SORT_ASC; array_multisort($columns, $sort_dir, $data); } $data = array_slice($data, $offset, $perpage); return [$data, $domain_list]; } private function _addCSS() { // Inline CSS for our pages only ee()->cp->add_to_head(' '); if (!$this->active_subscription) { ee()->cp->add_to_head(' '); } } protected function _createBaseUrlWithExistingParameters($base_url, $parameters, $post_parameters = []) { $base_url_with_parameters = $base_url; if (!is_array($parameters)) { return $base_url_with_parameters; } // We prioritize POST data if ($post_parameters != null && count($post_parameters) != 0) { foreach ($post_parameters as $parameter) { if (ee()->input->post($parameter) && $parameter != 'search') { $base_url_with_parameters->setQueryStringVariable($parameter, ee()->input->post($parameter)); // Remove it from GET data unset($parameters[$parameter]); } } } foreach ($parameters as $parameter) { if (ee()->input->get($parameter)) { $base_url_with_parameters->setQueryStringVariable($parameter, ee()->input->get($parameter)); } } return $base_url_with_parameters; } } termly/config.php0000666000000000000000000000033214565772403013065 0ustar rootroot 'Termly', 'termly_module_description' => 'Easy to use cookie consent plugin can assist in your GDPR and ePrivacy Directive compliance efforts.', 'setup_wizard' => 'Setup Wizard', 'setup_no_templates' => 'We didn\'t detect any templates on your system. Please create one before proceeding.', 'setup_need_api_key' => 'Please enter the Termly API Key.', 'setup_all_good' => 'Everything looks good!', 'setup_not_done' => 'Please visit the Setup Wizard to finish the installation.', 'learn_more' => 'Get more with Termly Pro', 'compare_plans' => 'Compare Plans', // Page Headers 'account' => 'Account', 'site_scan' => 'Site Scan', 'cookie_management' => 'Cookie Management', 'banner_settings' => 'Banner Settings', 'policies' => 'Policies', // Options: Cookie Category 'essential' => 'Essential', 'performance' => 'Performance and functionality', 'analytics' => 'Analytics and customization', 'advertising' => 'Advertising', 'social_networking' => 'Social networking', 'unclassified' => 'Unclassified', // Options: Cookie Tracker Type 'http_cookie' => 'Http Cookie', 'html_local_storage' => 'Html Local Storage', 'html_session_storage' => 'Html Session Storage', 'server_cookie' => 'Server Cookie', 'pixel_tracker' => 'Pixel Tracker', 'indexed_db' => 'IndexedDB', // Options: Scan Period 'trimonthly' => 'Every 3 Months', 'monthly' => 'Every Month', 'weekly' => 'Every Week', // Alerts 'success' => 'Success', 'settings_not_saved' => 'Settings not saved', 'failed' => 'Failed', 'alert_connected' => 'Site connected successfully.', 'alert_disconnected' => 'Site disconnected successfully.', 'alert_settings_updated' => 'Settings updated.', 'alert_scan_settings_not_updated' => 'Scan settings not updated. For free accounts you can only select Every 3 Months as the scan period.', 'alert_scan_started' => 'Scan Started', 'alert_scan_started_desc' => 'Your cookie scan is in progress! Most scans take less than five minutes, but scan time depends on the size of your website and subdomains. You\'ll be notified via email at %s when your scan is complete.', 'alert_cookie_deleted' => '%s cookies deleted.', 'alert_need_report' => 'Consent banner can only be enabled if you have run the scan.', 'alert_error' => 'Errors encountered: ', // Page: Cookie Edit Screen 'add_cookie' => 'Add a Cookie', 'edit_cookie' => 'Edit Cookie', 'cookie_name' => 'Name', 'cookie_name_desc' => 'Name of the cookie.', 'cookie_category' => 'Category', 'cookie_category_desc' => 'Category of the cookie. Will display in the cookie policy and consent preference center.', 'cookie_expire' => 'Expires on', 'cookie_expire_desc' => 'Describes at what point the cookie is deleted from the browser.', 'cookie_tracker_type' => 'Type', 'cookie_tracker_type_desc' => 'The type of tracker that is being used.', 'cookie_country' => 'Country', 'cookie_country_desc' => 'The country that sourced the cookie, based on a geoip lookup', 'cookie_domain' => 'Domain', 'cookie_domain_desc' => 'The URL that set the cookie.', 'cookie_service' => 'Service', 'cookie_service_desc' => 'Which service is setting this cookie.', 'cookie_service_policy_link' => 'Service Privacy Policy', 'cookie_service_policy_link_desc' => 'The Privacy Policy of the service that is setting the cookie.', 'cookie_url' => 'Resource URL', 'cookie_url_desc' => 'The source that sets the cookie.', 'cookie_value' => 'Example value', 'cookie_value_Desc' => 'An example of the value that is stored in the cookie.', 'cookie_purpose' => 'Purpose', 'cookie_purpose_desc' => 'Description of what the cookie is used for.', 'cookie_en_us' => 'Purpose', 'cookie_en_uk' => 'Purpose', 'cookie_fr' => 'Purpose', 'cookie_de' => 'Purpose', 'required_field_empty' => 'Cookie not added. Make sure all the required fields are filled out.', // View 'go_to_dashboard' => 'Go to Termly Dashboard', // Page: Setup Wizard 'no_head_template' => 'We couldn\'t find any template with the <head> tag.', 'setup_wizard_message' => 'Copy the Termly banner tag {exp:termly:banner} and paste it into section of your website.
IMPORTANT: This tag must be the first <script> tag on the page.', 'setup_wizard_select_template' => 'Or you can select the template that you would like the tag to be added to. We recommend selecting the base layout that is used for most of the webpages. The listed templates have the <head> element.', 'install' => 'Install', // Page: Signup 'signup' => 'Sign Up', 'create_account' => 'Create Account', 'first_name' => 'First Name', 'last_name' => 'Last Name', 'email' => 'Email', 'website_url' => 'Website URL', 'password_confirmation' => 'Confirm Password', 'accept_marketing_offer' => 'I want to receive news, feature updates, discounts, and offers from Termly.', 'agree_policy' => 'I acknowledge that I have read and agree to the Terms and Conditions and Privacy Policy.', 'signup_notice' => 'Your API key will be inserted automatically after signing up.', // Page: Account 'welcome_header' => 'Welcome to Termly', 'success_connection_message' => 'You have successfully connected your Termly account. You can go to your Termly Dashboard at any time to manage your account and access the full suite of legal and data compliance tools.', 'site_name_url' => 'Site Name / URL', 'api_key' => 'API Key', 'disconnect_site' => 'Disconnect Site', 'sign_up_for_termly' => 'Sign up for Termly', 'sign_up_message' => '

The all-in-one site scanner, cookie management, consent banner and more. Designed to work with WordPress and keep you legally compliant. Create an account to to gain access to:

Sign up & Get API Key', 'or_sign_up' => 'or Sign up & Get API Key', 'enter_api_key_message' => 'Already have a Termly account? Enter your API key below.', 'save_api_key' => 'Save API Key', 'log_in_for_api_key' => 'Log in to the Termly app to retrieve your API key. Learn more', // Page: Site Scan 'scan_now' => 'Scan Now', 'last_scanned' => 'Last Scanned: %s', 'cookie_scan_results_message' => '

Termly can automatically scan your site for cookies. Schedule regular scans to keep your consent banner compliant.


After the scan is complete, you can view your cookie list by going to Cookie Management.

', 'schedule_automatic_scan' => 'Schedule Automatic Scans', 'want_to_scan_automatically' => 'I want to automatically scan my website', // Page: Cookie Management 'new_cookie' => 'New Cookie', 'cookie_policy_message' => 'The Consent Logs can be accessed in the Termly Dashboard. ', 'filter_category' => 'Categories', 'filter_domain' => 'Domains', 'please_select' => 'Please select', 'cookie_name' => 'Cookie Name', 'category' => 'Category', 'domain' => 'Domain', 'clear_search' => 'Clear Search', 'with_selected_option' => '-- With Selected --', 'delete_selected' => 'Delete Selected', // Page: Banner Settings 'consent_banner' => 'Consent Banner', 'consent_banner_desc' => 'The Consent Banner lets you request consent for serving tracking scripts to your site visitors. It automatically adjusts to support the latest international regulation and includes a preference center where visitors can manage their consent preferences.', 'customize_banner' => 'Customize Banner', 'enable_consent_banner' => 'Enable Consent Banner', 'auto_blocker' => 'Auto Blocker', 'auto_blocker_desc' => 'Auto Blocker will automatically prevent scripts from running on your site until a visitor consents to their delivery. If you do not use Auto Blocker, make sure to set up manual blocking to remain compliant.', 'enable_auto_blocker' => 'Enable Auto Blocker', 'preference_center_button' => 'Preference Center Button', 'preference_center_button_desc' => 'Your site visitors must be able to change their cookie preferences at any time. Add the code below to your website to add a button that will open your Cookie Preference Center, where your visitors will be able to easily change their consent settings.', 'copy_to_clipboard' => 'Copy to clipboard', // Page: Policies 'manage' => 'Manage', 'policies_message' => 'Generate free attorney-crafted documents and policies that can easily be revised over time as regulation and your business changes. You can customize the look and feel to match your brand, then immediately embed them on your site.', 'cookie_policy' => 'Cookie Policy', 'cookie_policy_desc' => 'Once your cookies have been categorized, our tool will automatically create a cookie policy perfectly tailored to your business.', 'privacy_policy' => 'Privacy Policy', 'privacy_policy_desc' => 'Fit to meet the requirements of privacy laws and third-party platforms, including: GDPR, CCPA, CalOPPA, Google Analytics, AdSense, ecommerce laws.', 'terms_and_conditions' => 'Terms and Conditions', 'terms_and_conditions_desc' => 'Generate terms and conditions designed for your blog, website, app, SaaS, or ecommerce site. Establish guidelines and rights for your platform.', 'disclaimer' => 'Disclaimer', 'disclaimer_desc' => 'Whatever disclosure policy you need — from a medical or affiliate disclaimer to a basic blog disclaimer — our generator has you covered.', 'return_policy' => 'Return Policy', 'return_policy_desc' => 'Our return policy generator tailors each policy specifically to your platform, no matter the size, type, or location of the business you operate.', // Actions 'save_changes' => 'Save Changes', 'save_btn_text' => 'Save', 'save_btn_text_working' => 'Saving...', ]; termly/Model/0000777000000000000000000000000014565772403012151 5ustar rootroottermly/Model/Config.php0000666000000000000000000000060414565772403014067 0ustar rootroot 'base64Serialized', ]; protected $setting_id; protected $setting_name; protected $value; } termly/Helper/0000777000000000000000000000000014565772403012330 5ustar rootroottermly/Helper/TermlyUrlHelper.php0000666000000000000000000000127614565772403016146 0ustar rootroot 'Please select', 'Afghanistan' => 'Afghanistan', 'Åland' => 'Åland', 'Albania' => 'Albania', 'Algeria' => 'Algeria', 'American Samoa' => 'American Samoa', 'Andorra' => 'Andorra', 'Angola' => 'Angola', 'Anguilla' => 'Anguilla', 'Antarctica' => 'Antarctica', 'Antigua and Barbuda' => 'Antigua and Barbuda', 'Argentina' => 'Argentina', 'Armenia' => 'Armenia', 'Aruba' => 'Aruba', 'Australia' => 'Australia', 'Austria' => 'Austria', 'Azerbaijan' => 'Azerbaijan', 'Bahamas' => 'Bahamas', 'Bahrain' => 'Bahrain', 'Bangladesh' => 'Bangladesh', 'Barbados' => 'Barbados', 'Belarus' => 'Belarus', 'Belgium' => 'Belgium', 'Belize' => 'Belize', 'Benin' => 'Benin', 'Bermuda' => 'Bermuda', 'Bhutan' => 'Bhutan', 'Bolivia' => 'Bolivia', 'Bonaire, Sint Eustatius, and Saba' => 'Bonaire, Sint Eustatius, and Saba', 'Bosnia and Herzegovina' => 'Bosnia and Herzegovina', 'Botswana' => 'Botswana', 'Bouvet Island' => 'Bouvet Island', 'Brazil' => 'Brazil', 'British Indian Ocean Territory' => 'British Indian Ocean Territory', 'British Virgin Islands' => 'British Virgin Islands', 'Brunei' => 'Brunei', 'Bulgaria' => 'Bulgaria', 'Burkina Faso' => 'Burkina Faso', 'Burundi' => 'Burundi', 'Cabo Verde' => 'Cabo Verde', 'Cambodia' => 'Cambodia', 'Cameroon' => 'Cameroon', 'Canada' => 'Canada', 'Cayman Islands' => 'Cayman Islands', 'Central African Republic' => 'Central African Republic', 'Chad' => 'Chad', 'Chile' => 'Chile', 'China' => 'China', 'Christmas Island' => 'Christmas Island', 'Cocos [Keeling] Islands' => 'Cocos [Keeling] Islands', 'Colombia' => 'Colombia', 'Comoros' => 'Comoros', 'Congo' => 'Congo', 'Cook Islands' => 'Cook Islands', 'Costa Rica' => 'Costa Rica', 'Croatia' => 'Croatia', 'Cuba' => 'Cuba', 'Curaçao' => 'Curaçao', 'Cyprus' => 'Cyprus', 'Czechia' => 'Czechia', 'Democratic Republic of Timor-Leste' => 'Democratic Republic of Timor-Leste', 'Denmark' => 'Denmark', 'Djibouti' => 'Djibouti', 'Dominica' => 'Dominica', 'Dominican Republic' => 'Dominican Republic', 'Ecuador' => 'Ecuador', 'Egypt' => 'Egypt', 'El Salvador' => 'El Salvador', 'Equatorial Guinea' => 'Equatorial Guinea', 'Eritrea' => 'Eritrea', 'Estonia' => 'Estonia', 'Eswatini' => 'Eswatini', 'Ethiopia' => 'Ethiopia', 'Falkland Islands' => 'Falkland Islands', 'Faroe Islands' => 'Faroe Islands', 'Federated States of Micronesia' => 'Federated States of Micronesia', 'Fiji' => 'Fiji', 'Finland' => 'Finland', 'France' => 'France', 'French Guiana' => 'French Guiana', 'French Polynesia' => 'French Polynesia', 'French Southern Territories' => 'French Southern Territories', 'Gabon' => 'Gabon', 'Gambia' => 'Gambia', 'Georgia' => 'Georgia', 'Germany' => 'Germany', 'Ghana' => 'Ghana', 'Gibraltar' => 'Gibraltar', 'Greece' => 'Greece', 'Greenland' => 'Greenland', 'Grenada' => 'Grenada', 'Guadeloupe' => 'Guadeloupe', 'Guam' => 'Guam', 'Guatemala' => 'Guatemala', 'Guernsey' => 'Guernsey', 'Guinea' => 'Guinea', 'Guinea-Bissau' => 'Guinea-Bissau', 'Guyana' => 'Guyana', 'Haiti' => 'Haiti', 'Hashemite Kingdom of Jordan' => 'Hashemite Kingdom of Jordan', 'Heard Island and McDonald Islands' => 'Heard Island and McDonald Islands', 'Honduras' => 'Honduras', 'Hong Kong' => 'Hong Kong', 'Hungary' => 'Hungary', 'Iceland' => 'Iceland', 'India' => 'India', 'Indonesia' => 'Indonesia', 'Iran' => 'Iran', 'Iraq' => 'Iraq', 'Ireland' => 'Ireland', 'Isle of Man' => 'Isle of Man', 'Israel' => 'Israel', 'Italy' => 'Italy', 'Ivory Coast' => 'Ivory Coast', 'Jamaica' => 'Jamaica', 'Japan' => 'Japan', 'Jersey' => 'Jersey', 'Kazakhstan' => 'Kazakhstan', 'Kenya' => 'Kenya', 'Kiribati' => 'Kiribati', 'Kosovo' => 'Kosovo', 'Kuwait' => 'Kuwait', 'Kyrgyzstan' => 'Kyrgyzstan', 'Laos' => 'Laos', 'Latvia' => 'Latvia', 'Lebanon' => 'Lebanon', 'Lesotho' => 'Lesotho', 'Liberia' => 'Liberia', 'Libya' => 'Libya', 'Liechtenstein' => 'Liechtenstein', 'Luxembourg' => 'Luxembourg', 'Macao' => 'Macao', 'Macedonia' => 'Macedonia', 'Madagascar' => 'Madagascar', 'Malawi' => 'Malawi', 'Malaysia' => 'Malaysia', 'Maldives' => 'Maldives', 'Mali' => 'Mali', 'Malta' => 'Malta', 'Marshall Islands' => 'Marshall Islands', 'Martinique' => 'Martinique', 'Mauritania' => 'Mauritania', 'Mauritius' => 'Mauritius', 'Mayotte' => 'Mayotte', 'Mexico' => 'Mexico', 'Monaco' => 'Monaco', 'Mongolia' => 'Mongolia', 'Montenegro' => 'Montenegro', 'Montserrat' => 'Montserrat', 'Morocco' => 'Morocco', 'Mozambique' => 'Mozambique', 'Myanmar' => 'Myanmar', 'Namibia' => 'Namibia', 'Nauru' => 'Nauru', 'Nepal' => 'Nepal', 'Netherlands' => 'Netherlands', 'New Caledonia' => 'New Caledonia', 'New Zealand' => 'New Zealand', 'Nicaragua' => 'Nicaragua', 'Niger' => 'Niger', 'Nigeria' => 'Nigeria', 'Niue' => 'Niue', 'Norfolk Island' => 'Norfolk Island', 'North Korea' => 'North Korea', 'Northern Mariana Islands' => 'Northern Mariana Islands', 'Norway' => 'Norway', 'Oman' => 'Oman', 'Pakistan' => 'Pakistan', 'Palau' => 'Palau', 'Palestine' => 'Palestine', 'Panama' => 'Panama', 'Papua New Guinea' => 'Papua New Guinea', 'Paraguay' => 'Paraguay', 'Peru' => 'Peru', 'Philippines' => 'Philippines', 'Pitcairn Islands' => 'Pitcairn Islands', 'Poland' => 'Poland', 'Portugal' => 'Portugal', 'Puerto Rico' => 'Puerto Rico', 'Qatar' => 'Qatar', 'Republic of Korea' => 'Republic of Korea', 'Republic of Lithuania' => 'Republic of Lithuania', 'Republic of Moldova' => 'Republic of Moldova', 'Republic of the Congo' => 'Republic of the Congo', 'Réunion' => 'Réunion', 'Romania' => 'Romania', 'Russia' => 'Russia', 'Rwanda' => 'Rwanda', 'Saint Barthélemy' => 'Saint Barthélemy', 'Saint Helena' => 'Saint Helena', 'Saint Lucia' => 'Saint Lucia', 'Saint Martin' => 'Saint Martin', 'Saint Pierre and Miquelon' => 'Saint Pierre and Miquelon', 'Saint Vincent and the Grenadines' => 'Saint Vincent and the Grenadines', 'Samoa' => 'Samoa', 'San Marino' => 'San Marino', 'São Tomé and Príncipe' => 'São Tomé and Príncipe', 'Saudi Arabia' => 'Saudi Arabia', 'Senegal' => 'Senegal', 'Serbia' => 'Serbia', 'Seychelles' => 'Seychelles', 'Sierra Leone' => 'Sierra Leone', 'Singapore' => 'Singapore', 'Sint Maarten' => 'Sint Maarten', 'Slovakia' => 'Slovakia', 'Slovenia' => 'Slovenia', 'Solomon Islands' => 'Solomon Islands', 'Somalia' => 'Somalia', 'South Africa' => 'South Africa', 'South Georgia and the South Sandwich Islands' => 'South Georgia and the South Sandwich Islands', 'South Sudan' => 'South Sudan', 'Spain' => 'Spain', 'Sri Lanka' => 'Sri Lanka', 'St Kitts and Nevis' => 'St Kitts and Nevis', 'Sudan' => 'Sudan', 'Suriname' => 'Suriname', 'Svalbard and Jan Mayen' => 'Svalbard and Jan Mayen', 'Sweden' => 'Sweden', 'Switzerland' => 'Switzerland', 'Syria' => 'Syria', 'Taiwan' => 'Taiwan', 'Tajikistan' => 'Tajikistan', 'Tanzania' => 'Tanzania', 'Thailand' => 'Thailand', 'Togo' => 'Togo', 'Tokelau' => 'Tokelau', 'Tonga' => 'Tonga', 'Trinidad and Tobago' => 'Trinidad and Tobago', 'Tunisia' => 'Tunisia', 'Turkey' => 'Turkey', 'Turkmenistan' => 'Turkmenistan', 'Turks and Caicos Islands' => 'Turks and Caicos Islands', 'Tuvalu' => 'Tuvalu', 'U.S. Minor Outlying Islands' => 'U.S. Minor Outlying Islands', 'U.S. Virgin Islands' => 'U.S. Virgin Islands', 'Uganda' => 'Uganda', 'Ukraine' => 'Ukraine', 'United Arab Emirates' => 'United Arab Emirates', 'United Kingdom' => 'United Kingdom', 'United States' => 'United States', 'Uruguay' => 'Uruguay', 'Uzbekistan' => 'Uzbekistan', 'Vanuatu' => 'Vanuatu', 'Vatican City' => 'Vatican City', 'Venezuela' => 'Venezuela', 'Vietnam' => 'Vietnam', 'Wallis and Futuna' => 'Wallis and Futuna', 'Western Sahara' => 'Western Sahara', 'Yemen' => 'Yemen', 'Zambia' => 'Zambia', 'Zimbabwe' => 'Zimbabwe', ]; } termly/Helper/TermlyInstallerHelper.php0000666000000000000000000000054214565772403017334 0ustar rootrootget('termly:Config')->filter('setting_name', $setting_name)->first(); if (empty($setting)) { return false; } return $setting->value; } static public function getSettings() { $settings = ee('Model')->get('termly:Config')->all()->getDictionary('setting_name', 'value'); return $settings; } static public function signUp() { $url = self::$url . 'users/sign_up'; $data = [ 'first_name' => trim(ee()->input->post('first_name')), 'last_name' => trim(ee()->input->post('last_name')), 'email' => trim(ee()->input->post('email')), 'password' => trim(ee()->input->post('password')), 'password_confirmation' => trim(ee()->input->post('password_confirmation')), 'website_url' => trim(ee()->input->post('website_url')), 'accept_marketing_offer' => ee()->input->post('accept_marketing_offer') ? 'true' : 'false', 'agree_policy' => ee()->input->post('agree_policy') ? 'true' : 'false', ]; $response = self::_POST($url, $data); if ( ! empty($response)) { $response = json_decode($response, true); if ( ! empty($response['website_token'])) { // website_token is api_key TermlyHelper::connectSite($response['website_token']); } else { return ['error' => $response[0]]; } } } static public function connectSite($api_key) { $url = self::$url . 'website'; $response = self::_GET($url, $api_key); $response = json_decode($response, true); $site_url = $response['url']; $uuid = $response['uuid']; $cookie_preference_button = trim($response['code_snippet']['cookie_preference_button']); $active_subscription = $response['active_subscription']; self::saveSettings(['site_url' => $site_url, 'api_key' => $api_key, 'uuid' => $uuid, 'cookie_preference_button' => $cookie_preference_button, 'scan_period' => $response['scan_period'], 'active_subscription' => $active_subscription, 'company_email' => $response['company_email'], 'last_scanned' => $response['current_report_updated_at']]); if ( ! empty(self::getReport())) { self::saveSettings(['enable_consent_banner' => 'yes']); } } static public function getActiveSubscription() { if (self::getSetting('active_subscription')) { return true; } else { $api_key = self::getSetting('api_key'); if ( ! empty($api_key)) { $url = self::$url . 'website'; $response = self::_GET($url, $api_key); $response = json_decode($response, true); $active_subscription = $response['active_subscription']; self::saveSettings(['active_subscription' => $active_subscription]); return $active_subscription; } } return false; } static public function getPreferenceCenterButton() { $api_key = self::getSetting('api_key'); if ( ! empty($api_key)) { $url = self::$url . 'website'; $response = self::_GET($url, $api_key); $response = json_decode($response, true); $cookie_preference_button = trim($response['code_snippet']['cookie_preference_button']); self::saveSettings(['cookie_preference_button' => $cookie_preference_button]); } } static public function createCookie() { $description = 'en_us'; $api_key = self::getSetting('api_key'); $url = self::$url . 'cookies'; $data = [ 'name' => ee()->input->post('name'), 'category' => ee()->input->post('category'), 'tracker_type' => ee()->input->post('tracker_type'), 'expire' => ee()->input->post('expire'), 'country' => ee()->input->post('country'), 'domain' => ee()->input->post('domain'), 'service' => ee()->input->post('service'), 'service_policy_link' => ee()->input->post('service_policy_link'), 'url' => ee()->input->post('url'), 'value' => ee()->input->post('value'), $description => ee()->input->post($description), ]; if (empty($data['name']) || empty($data['category']) || empty($data['domain'])) { return false; } $response = self::_POST($url, $data, $api_key); if ( ! empty($response)) { $response = json_decode($response, true); if ( ! empty($response['id'])) { self::_updatePolicy(); self::flushCache(); return true; } } return false; } static public function updateCookie($id) { $description = 'en_us'; $api_key = self::getSetting('api_key'); $url = self::$url . 'cookies/' . intval($id); $data = [ 'name' => ee()->input->post('name'), 'category' => ee()->input->post('category'), 'expire' => ee()->input->post('expire'), 'country' => ee()->input->post('country'), 'domain' => ee()->input->post('domain'), 'service' => ee()->input->post('service'), 'service_policy_link' => ee()->input->post('service_policy_link'), 'url' => ee()->input->post('url'), 'value' => ee()->input->post('value'), $description => ee()->input->post($description), ]; $response = self::_PUT($url, $api_key, $data); if ( ! empty($response)) { $response = json_decode($response, true); if ($response['id'] == $id) { self::_updatePolicy(); self::flushCache(); } } } static public function deleteCookie($id) { $api_key = self::getSetting('api_key'); $url = self::$url . 'cookies/' . intval($id); self::_DELETE($url, $api_key); self::_updatePolicy(); self::flushCache(); } static public function scan() { $api_key = self::getSetting('api_key'); $url = self::$url . 'website/scan_cookie'; $response = self::_POST($url, [], $api_key); } static public function saveScanSettings($scan_enabled, $scan_period) { $api_key = self::getSetting('api_key'); $url = self::$url . 'website/scan_settings'; $data = ['scan_enabled' => ($scan_enabled == 'Yes' ? 'true' : 'false'), 'scan_period' => $scan_period]; $response = self::_PUT($url, $api_key, $data); $response = json_decode($response, true); if ( ! empty($response['error'])) { return false; } if ($scan_enabled == 'Yes') { self::saveSettings(['scan_enabled' => $scan_enabled, 'scan_period' => $scan_period]); } else { self::deleteSettings(['scan_enabled', 'scan_period']); } return true; } static private function _GET($url, $api_key) { $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $headers = [ 'Accept: application/vnd.wordpress-v1+json', sprintf('Authorization: Bearer %s', $api_key), ]; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); $err = curl_error($ch); if ($err && self::$debug) { echo 'cURL Error #: ' . $err; echo '
';
            print_r(curl_errno($ch));
            echo '
'; } curl_close($ch); if ($err) { return false; } return $response; } static private function _POST($url, $data, $api_key = '') { $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); if ( ! empty($data)) { curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data)); } $headers = [ 'Content-Type: application/x-www-form-urlencoded', 'Accept: application/vnd.wordpress-v1+json', ]; if ( ! empty($api_key)) { $headers[] = sprintf('Authorization: Bearer %s', $api_key); } curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); $err = curl_error($ch); if ($err && self::$debug) { echo 'cURL Error #: ' . $err; echo '
';
            print_r(curl_errno($ch));
            echo '
'; rewind($verbose); $verboseLog = stream_get_contents($verbose); echo 'Verbose information:
' . htmlspecialchars($verboseLog) . '
'; } curl_close($ch); if ($err) { return false; } return $response; } static private function _PUT($url, $api_key = '', $data = '') { $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); if ( ! empty($data)) { curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data)); } $headers = [ 'Content-Type: application/x-www-form-urlencoded', 'Accept: application/vnd.wordpress-v1+json', ]; if ( ! empty($api_key)) { $headers[] = sprintf('Authorization: Bearer %s', $api_key); } curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); $err = curl_error($ch); if ($err && self::$debug) { echo 'cURL Error #: ' . $err; echo '
';
            print_r(curl_errno($ch));
            echo '
'; rewind($verbose); $verboseLog = stream_get_contents($verbose); echo 'Verbose information:
' . htmlspecialchars($verboseLog) . '
'; } curl_close($ch); if ($err) { return false; } return $response; } static private function _DELETE($url, $api_key) { $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $headers = [ 'Content-Type: application/json', 'Accept: application/vnd.wordpress-v1+json', sprintf('Authorization: Bearer %s', $api_key), ]; curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); if (self::$debug) { curl_setopt($ch, CURLOPT_VERBOSE, true); $verbose = fopen('php://temp', 'w+'); curl_setopt($ch, CURLOPT_STDERR, $verbose); } $response = curl_exec($ch); $err = curl_error($ch); if ($err && self::$debug) { echo 'cURL Error #: ' . $err; echo '
';
            print_r(curl_errno($ch));
            echo '
'; rewind($verbose); $verboseLog = stream_get_contents($verbose); echo 'Verbose information:
' . htmlspecialchars($verboseLog) . '
'; exit; } curl_close($ch); if ($err) { return false; } return $response; } static public function getCookies($id = null) { $report = self::getReport(); if (empty($report['cookies'])) { return []; } $temp_cookies = $report['cookies']; $cookies = []; foreach ($temp_cookies as $cookie) { $cookies[$cookie['id']] = $cookie; } if ( ! empty($id)) { return $cookies[$id]; } return $cookies; } static public function getReport() { $api_key = self::getSetting('api_key'); if (empty($api_key)) { return []; } $url = self::$url . 'report'; $response = self::_GET($url, $api_key); $report = json_decode($response, true); return $report; } static public function saveSettings($settings) { foreach ($settings as $setting_name => $value) { $setting = ee('Model')->get('termly:Config')->filter('setting_name', $setting_name)->first(); if ( ! empty($setting)) { $setting->value = $value; } else { $setting = ee('Model')->make('termly:Config', ['setting_name' => $setting_name, 'value' => $value]);; } $setting->save(); } } static public function deleteSettings($settings) { foreach ($settings as $setting_name) { $setting = ee('Model')->get('termly:Config')->filter('setting_name', $setting_name)->first(); if ( ! empty($setting)) { $setting->delete(); } } } static private function _updatePolicy() { $api_key = self::getSetting('api_key'); $url = self::$url . 'document/publish_cookie_policy'; $response = self::_PUT($url, $api_key); } static public function flushCache($key = '') { $cache_key = '/Termly/' . $key; ee()->cache->delete($cache_key, 1); } static public function getIcon() { $addon_icon_act = ee()->cp->fetch_action_id('File', 'addonIcon'); return site_url() . '?ACT=' . $addon_icon_act . '&addon=termly&file=icon.svg'; } }