Updated CookieConsent to version 3.0.0. and some minor updates #4

rahkapetteri · 2024-03-08T13:45:51Z

Hi!

I think Cookie Consent 3.0.0 is working properly now 👨‍💻

Additional changes:

Added the option to declare cookies (even with regex variables) so cookies are getting deleted after changing consent
Fixed issues with embedded content when changing consent. Before the fix, when consent was removed, I could still see the embeds
Updated documentation
Updated Iframe Manager to 1.2.5
Added cc_link CSS-style to assets/cookieconsent.css
Fixes Why send consent POST on each request? #2

If you have any questions about the fixes I’m happy to discuss them 😊

…ckend, function/someway to add cookie table, check config file + test everything

…ending to backend and custom attributes. Updated iFramemanager to 1.2.5.

…t change update

…ytics_storage if google cookies defined

…rrectly

height · 2024-03-08T13:45:55Z

Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").

💡Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.

raikasdev · 2024-05-10T12:50:22Z

air-cookie.php

 /**
- * Github updater.
+ * Github updater. Disabled by commenting out.
 *
 * @since 0.1.0
 */
-require plugin_base_path() . '/plugin-update-checker/plugin-update-checker.php';
-$update_checker = \Puc_v4_Factory::buildUpdateChecker( 'https://github.com/digitoimistodude/air-cookie', __FILE__, 'air-cookie' );
+// require plugin_base_path() . '/plugin-update-checker/plugin-update-checker.php';
+// $update_checker = \Puc_v4_Factory::buildUpdateChecker( 'https://github.com/digitoimistodude/air-cookie', __FILE__, 'air-cookie' );


These kinds of changes shouldn't be included in PRs 😃

Was meant for local only 🤦‍♂️

Haha, happens to the best of us.

raikasdev · 2024-05-10T12:57:01Z

settings.php

-    'cookie_name'       => 'air_cookie',
-    'revision'          => $categories_version, // use version number to invalidate if categories change
-    // 'theme_css'         => plugin_base_url() . '/assets/cookieconsent.css',
-    'cookie_expiration' => 182, // in days, 182 days = 6 months
-    'auto_language'     => false,
-    'current_lang'      => $lang,
-    'autorun'           => true,
-    'page_scripts'      => true,
-    'delay'             => '0',
-    'gui_options'       => [
-      'consent_modal' => [
-        'layout'    => 'box',
-        'position'  => 'bottom left',
+    'revision'              => $categories_version, // use version number to invalidate if categories change
+    'cookie'                => [
+      'name' => 'air_cookie',
+      'expiresAfterDays' => 182, // in days, 182 days = 6 months
+    ],
+
+    'guiOptions'     => [
+      'consentModal' => [
+        'layout'     => 'box wide',
+        'position'   => 'bottom left',
+        'equalWeightButtons' => false,
+        'flipButtons'        => false,
+      ],
+
+      'preferencesModal' => [
+        'layout'             => 'box',
+        'equalWeightButtons' => true,
+        'flipButtons'        => false,
      ],
    ],
+
+    'language'  => [
+      'default' => $lang,
+      'translations'   => [
+        $lang   => []
+      ]
+    ],
+
+    'categories' => [],
  ];


Refactoring the settings object isn't a good practice as this will break backwards compability pretty much just for style points.

We name variables according to the WordPress Coding Standard's Naming Conventions meaning snake_case instead of camelCase.

Changes are from CookieConsent, ahh.

I'd still prefer at least mapping the old keys to the new ones if they are set 🤔

I´ll look into it.

raikasdev · 2024-05-10T12:58:17Z

README.md

@@ -60,13 +61,68 @@ function my_add_cookie_category( $categories ) {
 When adding new categories, the function itself is responsile for handling the translations for title and description.

 There is also `air_cookie\categories\{category-key}` filter available to change the settings of indivual category.
+```php
+add_filter( 'air_cookie\categories\{analytics}', 'my_change_category_analytics' );


It would be air_cookie\categories\analytics, without the braces.

Hmm I can´t get it to work without brackets. Only way to use the filter without brackets would require to change in settings.php:

$categories[ $key ] = apply_filters( "air_cookie\categories\{$category_key}", $category );

to $categories[ $key ] = apply_filters( "air_cookie\categories\\{$category_key}", $category );

Atleast that´s how PHP-docs say to handle backslashed variables 🤔

// Won't work, outputs: C:\folder\{fantastic}.txt
echo "C:\folder\{$great}.txt"

// Works, outputs: C:\folder\fantastic.txt
echo "C:\\folder\\{$great}.txt"

Not in the code, I meant in the example 😄

If user wants to filter analytics they need to create a filter add_filter ( 'air_cookie\categories\analytics', 'my_change_analytics' );, which is then called by apply_filters( "air_cookie\categories\{$category_key}", $category );.

"air_cookie\categories\{$category_key}" gets resolved to "air_cookie\categories\analytics as {$category_key} is a string template.

This is indeed a bug. #10

raikasdev · 2024-05-10T12:59:16Z

script-injection.php

  if ( ! is_array( $settings ) ) {
-    return;
+		return;
  }

  // Cookie Consent javascript base.
-  wp_enqueue_script( 'cookieconsent', plugin_base_url() . '/assets/cookieconsent.js', [], get_script_version(), false );
+  wp_enqueue_script( 'cookieconsent', plugin_base_url() . '/assets/cookieconsent.js', [], get_script_version(),
+  array(
+    'in_footer' => true,
+    'strategy'  => 'defer',
+  )
+);


What is happening here with the whitespace?

Probably VS Code auto indentation with different settings 😅

raikasdev · 2024-05-10T13:00:23Z

script-injection.php

+  array(
+    'in_footer' => true,
+    'strategy'  => 'defer',
+  )
+);


We use the short [] syntax instead of array().

raikasdev · 2024-05-10T13:02:34Z

script-injection.php

+        onFirstConsent: () => {
+          ccOnAccept();
+        },
+
+        onConsent: () => {
+          checkIframeConsent();
+        },
+
+        onModalShow: () => {
+          <?php if ( apply_filters( 'air_cookie\styles\set_max_width', true ) ) : ?>
+            var cookieconsent_element = document.querySelector('div#cc-main div.cm');
+            if( typeof( cookieconsent_element ) != 'undefined' && cookieconsent_element != null ) {
+              cookieconsent_element.style = 'max-width: 40em;';
+            }
+          <?php endif; ?>
+        },
+
+        onChange: () => {
+          ccOnChange();
+        }


onFirstConsent, onConsent and onChange probably don't need to be inside a arrow function and can be passed as arguments.

onChange: ccOnChange.

raikasdev · 2024-05-10T13:05:04Z

script-injection.php

@@ -145,8 +204,7 @@ function do_category_js( $category ) {
  $event_key = "air_cookie_{$category_key}";

  ob_start(); ?>
-
-  if ( cc.allowedCategory( '<?php echo $category_key; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>' ) ) {
+  if ( CookieConsent.getCookie( 'categories' ).includes( '<?php echo $category_key; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>' ) ) {


Why do we have to use this instead of CookieConsent.acceptedCategory()?

Wasn't working correctly in 3.0.0, but I think that´s fixed in 3.0.1 now (PR is 3.0.0).

raikasdev · 2024-05-10T13:08:51Z

rest-api.php

+  // Check if the index exists
+  $index_exists = $wpdb->get_row( "SHOW INDEX FROM {$table_name} WHERE Key_name = 'idx_id_revision_value'" ); // phpcs:ignore
+
+  // CREATE INDEX idx_id_revision_value ON wp_air_cookie (visitor_id, cookie_revision, cookie_value);
+  if ( null === $index_exists ) {
+    $wpdb->query( "CREATE INDEX idx_id_revision_value ON {$table_name} (visitor_id, cookie_revision, cookie_value);" ); // phpcs:ignore
+  }


Does this have to happen on every request or could this just be ran when the plugin is activated or if the version has changed?

rahkapetteri · 2024-05-10T16:53:26Z

Thanks for comments! I´ll look into those.

I was doing some testing with fork repo and didn´t notice latest changes went to PR also.

ronilaukkarinen · 2024-09-27T12:12:22Z

Thanks for comments! I´ll look into those.

I was doing some testing with fork repo and didn´t notice latest changes went to PR also.

What's the status? We are adding this to our roadmap as well, but if you are ahead of us, it all helps. Thanks.

…nd minor formatting

rahkapetteri · 2024-10-02T12:53:50Z

Thanks for comments! I´ll look into those.
I was doing some testing with fork repo and didn´t notice latest changes went to PR also.

What's the status? We are adding this to our roadmap as well, but if you are ahead of us, it all helps. Thanks.

Hello, I pushed latest changes which I have done. Added latest CookieConsent version, fixed #10 (comment), fixed some minor formatting and created function to allow old settings formatting, so old installations shouldn't break (but all old used settings should still be checked).

Hope these help.

rahkapetteri added 22 commits March 1, 2024 17:33

WIP: Migrating to CookieConsent 3. Fix consent data format sent to ba…

b570a9c

…ckend, function/someway to add cookie table, check config file + test everything

WIP: Migrating to CookieConsent 3. Fixed: embed consent state, data s…

0aa85af

…ending to backend and custom attributes. Updated iFramemanager to 1.2.5.

Updated readme, added option to declare cookies, iframemanager consen…

469621a

…t change update

Fixes for embeds consent changing, added google consent mode for anal…

b45e823

…ytics_storage if google cookies defined

Something weird happened

3c3dfb7

Something weird happened

d0feb4d

Documentation fix

3e597cf

Removed GA detection script

57c7029

Changed default style

fba2228

Updated defaults, readme and added cc-link style from 2.9.

39c8744

pref modal default change

3857067

Modal width fix + button default change

470fa0a

Removed button from string

6b33980

fix indentation

ccaa0b3

fix indentation

f289561

Deleted empty file

ce1baad

fix

04e0f78

expire date fix + indendation

ea2c77c

-data-cookiecategory replaces

37ddc11

Iframe Manager required to be run every page load to detect iframe co…

f67e281

…rrectly

Removed miscopy

646a799

removed not needed cookie removal

00b1908

Ciantic mentioned this pull request Mar 15, 2024

Why send consent POST on each request? #2

Closed

rahkapetteri added 2 commits April 22, 2024 16:32

Disable autoupdater and add latest change from source branch

775c95e

Added forgotten edited info

16a517b

raikasdev requested changes May 10, 2024

View reviewed changes

raikasdev mentioned this pull request Jul 10, 2024

Filters for specific keys are string templated incorrectly #10

Open

Added CookieConsent 3.0.1, snake cased settings, fixed filter names a…

88e9c81

…nd minor formatting

3.0.1 js and enabled autoupdated

569ce2f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated CookieConsent to version 3.0.0. and some minor updates #4

Updated CookieConsent to version 3.0.0. and some minor updates #4

rahkapetteri commented Mar 8, 2024 •

edited

Loading

height bot commented Mar 8, 2024

raikasdev May 10, 2024

rahkapetteri May 10, 2024

raikasdev May 10, 2024

raikasdev May 10, 2024

raikasdev May 10, 2024

raikasdev May 10, 2024

rahkapetteri May 10, 2024

raikasdev May 10, 2024

rahkapetteri May 12, 2024 •

edited

Loading

raikasdev May 12, 2024

raikasdev Jul 10, 2024 •

edited

Loading

raikasdev May 10, 2024

rahkapetteri May 10, 2024

raikasdev May 10, 2024

raikasdev May 10, 2024

raikasdev May 10, 2024

rahkapetteri May 10, 2024

raikasdev May 10, 2024

raikasdev May 10, 2024

rahkapetteri commented May 10, 2024

ronilaukkarinen commented Sep 27, 2024

rahkapetteri commented Oct 2, 2024

Updated CookieConsent to version 3.0.0. and some minor updates #4

Are you sure you want to change the base?

Updated CookieConsent to version 3.0.0. and some minor updates #4

Conversation

rahkapetteri commented Mar 8, 2024 • edited Loading

height bot commented Mar 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rahkapetteri May 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raikasdev Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rahkapetteri commented May 10, 2024

ronilaukkarinen commented Sep 27, 2024

rahkapetteri commented Oct 2, 2024

rahkapetteri commented Mar 8, 2024 •

edited

Loading

rahkapetteri May 12, 2024 •

edited

Loading

raikasdev Jul 10, 2024 •

edited

Loading