Drupal Day 2023

Francisco Almeida

Definition of Cookies

Introduction to Cookies

What are Cookies?
Purpose of Cookies
Lifecycle of Cookies

Reference: https://httpwg.org/http-extensions/draft-ietf-httpbis-rfc6265bis.html

Check cookies script

 // Function to get all cookies
function listCookies() {
  const cookies = document.cookie.split("; ");
  if (cookies.length === 0) {
    console.log("No cookies found on this page.");
    return;
  }
  console.log("Cookies on this page:");
  for (let i = 0; i < cookies.length; i++) {
    const cookie = cookies[i].split("=");
    const name = decodeURIComponent(cookie[0]);
    const value = decodeURIComponent(cookie[1]);
    console.log(`${name}: ${value}`);
  }
}
// Call the function to list all cookies
listCookies(); // Function to get all cookies
function listCookies() {
  const cookies = document.cookie.split("; ");
  if (cookies.length === 0) {
    console.log("No cookies found on this page.");
    return;
  }
  console.log("Cookies on this page:");
  for (let i = 0; i < cookies.length; i++) {
    const cookie = cookies[i].split("=");
    const name = decodeURIComponent(cookie[0]);
    const value = decodeURIComponent(cookie[1]);
    console.log(`${name}: ${value}`);
  }
}
// Call the function to list all cookies
listCookies();

Delete cookies script

 // Function to delete a cookie
function deleteCookie(name) {
  document.cookie = name + "=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;";
  console.log(`Deleted cookie: ${name}`);
}
// Function to delete all cookies
function deleteAllCookies() {
  const cookies = document.cookie.split("; ");
  for (let i = 0; i < cookies.length; i++) {
    const cookie = cookies[i].split("=");
    deleteCookie(cookie[0]);
  }
  console.log("All cookies deleted.");
}
// Call the function to delete all cookies
deleteAllCookies();

Cookies in Drupal

In the context of Drupal, cookies play a crucial role in various aspects of website functionality. Here's a more detailed exploration of how cookies are used in Drupal:

Custom module (1)

1. Creating a Custom Cookie in a Module: You can create a custom cookie in a Drupal module to store and retrieve specific data. Example:

/**
   * Controller function to set a custom cookie.
   */
  public function setCustomCookie()
  {
    // Define the cookie parameters.
    $cookieName = 'custom_cookie';
    $cookieValue = 'example_value';
    $expiration = time() + 3600; // Cookie will expire in 1 hour (adjust as needed).
    $path = '/';
    $domain = ''; // Use your domain if needed, e.g., 'example.com'
    $secure = TRUE; // Set to TRUE if the cookie should only be sent over HTTPS.
    $httpOnly = TRUE; // Set to TRUE to make the cookie accessible only via HTTP, not JavaScript.

    // Create a new Cookie instance.
    $cookie = new Cookie(
      $cookieName,
      $cookieValue,
      $expiration,
      $path,
      $domain,
      $secure,
      $httpOnly
    );

    // Create a response object and add the cookie to it.
    $response = new Response();
    $response->headers->setCookie($cookie);

    // Return the response.
    return $response;
  }

Custom Module (2)

2. Reading a Custom Cookie: You can read the value of a custom cookie in your module or theme when needed. For example:

// Read the custom cookie.
$cookie_name = 'custom_cookie';
$cookie_value = \Drupal::request()->cookies->get($cookie_name);

// Use the cookie value.
if (!empty($cookie_value)) {
  // Do something with $cookie_value.
}

Custom module (3)

3. Modifying a Custom Cookie: You can modify the value or parameters of a custom cookie during a user's session:

use Symfony\Component\HttpFoundation\Cookie;

// Retrieve the existing cookie value.
$cookie_name = 'custom_cookie';
$cookie_value = \Drupal::request()->cookies->get($cookie_name);

// Modify the value.
$new_value = 'new_example_value';

// Update the existing cookie.
$cookie = new Cookie(
  $cookie_name,
  $new_value,
  $expiration,
  $path,
  $domain,
  $secure,
  $http_only
);

// Add the updated cookie to the response.
\Drupal::response()->headers->setCookie($cookie);

Custom module (4)

4. Deleting a Custom Cookie: You can delete a custom cookie by setting its expiration time to a past date. This effectively removes the cookie from the user's browser:

use Symfony\Component\HttpFoundation\Cookie;

// Expire the custom cookie to delete it.
$cookie_name = 'custom_cookie';
$expiration = time() - 3600; // Set expiration to the past.

// Create an expired cookie.
$cookie = new Cookie(
  $cookie_name,
  '',
  $expiration,
  $path,
  $domain,
  $secure,
  $http_only
);

// Add the expired cookie to the response to delete it.
\Drupal::response()->headers->setCookie($cookie);

	// Function to get all cookies
	function listCookies() {
	const cookies = document.cookie.split("; ");
	if (cookies.length === 0) {
	console.log("No cookies found on this page.");
	return;
	}
	console.log("Cookies on this page:");
	for (let i = 0; i < cookies.length; i++) {
	const cookie = cookies[i].split("=");
	const name = decodeURIComponent(cookie[0]);
	const value = decodeURIComponent(cookie[1]);
	console.log(`${name}: ${value}`);
	}
	}
	// Call the function to list all cookies
	listCookies();

	// Function to delete a cookie
	function deleteCookie(name) {
	document.cookie = name + "=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;";
	console.log(`Deleted cookie: ${name}`);
	}
	// Function to delete all cookies
	function deleteAllCookies() {
	const cookies = document.cookie.split("; ");
	for (let i = 0; i < cookies.length; i++) {
	const cookie = cookies[i].split("=");
	deleteCookie(cookie[0]);
	}
	console.log("All cookies deleted.");
	}
	// Call the function to delete all cookies
	deleteAllCookies();