# uname -a - Mot-clé - php

Drupal 8 / 9 / 10 : Programmatically render a view with contextual and exposed filters input

Mathieu — Sun, 10 Mar 2024 19:45:00 +0100

Exposed Input and Contextual Input are two different ways of providing input to Drupal Views.

Contextual filters work with an ordered list of parameters, while Exposed Input works with a form that has a couple name/value for every input parameter.

Contextual Filters

The right way to render a view result with contextual filters is to generate a render array:

$render_array = [
  '#type' => 'view',
  '#name' => 'YOUR_VIEW_NAME',
  '#display_id' => 'YOUR_VIEW_DISPLAY',
  '#arguments' => [CONTEXTUAL_FILTER_1, CONTEXTUAL_FILTER_2, ...],
];

You can then send the render array to a Twig variable, or render it programatically:

$result = \Drupal::service('renderer')->render($render_array);
return $result->__toString();

We are using the __toString() function to get the rendered HTML because the result returned by Drupal Render service is an object containing cache metadata.

Exposed Filters

The right way to render a view result with exposed filters is to generate a render array, and set the '#view#' parameter with a view object where you can initialize the filters:

$view = \Drupal\views\Views::getView('YOUR_VIEW_NAME');
$view->setExposedInput([
    'YOUR_FILTER_NAME' => 'YOUR_FILTER_VALUE',
]);
$render_array = [
  '#type' => 'view',
  '#name' => 'YOUR_VIEW_NAME',
  '#view' => $view,
  '#display_id' => 'YOUR_VIEW_DISPLAY',
  '#arguments' => [CONTEXTUAL_FILTER_1, CONTEXTUAL_FILTER_2, ...],
];

You can then send the render array to a Twig variable, or render it programatically:

$result = \Drupal::service('renderer')->render($render_array);
return $result->__toString();

We are using the __toString() function to get the rendered HTML because the result returned by Drupal Render service is an object containing cache metadata.

Leaked Metadata and Early Rendering

If you render a view while rendering a controller output that is suppose to provide its own cache metadata (CacheableJsonResponse for instance), and run on the error:

LogicException: The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early.

Just wrap the rendering in a render context:

$context = new Drupal\Core\Render\RenderContext\RenderContext();
$html = \Drupal::service('renderer')->executeInRenderContext($context, function () {
  $render_array = [
    '#type' => 'view',
    '#name' => 'YOUR_VIEW_NAME',
    '#display_id' => 'YOUR_VIEW_DISPLAY',
    '#arguments' => [CONTEXTUAL_FILTER_1, CONTEXTUAL_FILTER_2, ...],
  ];
  $result = \Drupal::service('renderer')->render($render_array);
  return $result->__toString();
});

Sources

Drupal 8 : create a custom Rule Action

Mathieu — Wed, 27 Jul 2016 10:56:00 +0200

Warning : the Rule plugin for Drupal 8 was not considered stable when I wrote this post.

1. Drupal 8: the new modules paradigm

Drupal 8 modules structure changed, and many modules are now using the new API.

No more plain old functions name like hook_something, no more obscurous PHP for menu entries. Instead, Object Oriented programming, YAML configuration files, magic comments, and Symfony routing.

Let's give it a try, let's make our first simplest module.

2. Base module configuration

If you already know how to do this, jumb to next section.

Create a directory for your module, for instance mymodule.

Create an info file in YAML format : mymodule/mymodule.info.yaml:

name: 'My Module'
type: module
core: 8.x
package: Custom

You don't need more! You don't need routing as you will plug into Rules.

3. File names and Namespaces

Create the RulesAction directory and its parents: mymodule/src/Plugin/RulesAction/

Create a PHP file for your class: MyAction.php. The class will be loaded with the autoload system.

Edit the file you just created, and specify the namespace at the beginning of the file:

/**
 * @file
 * Contains \Drupal\mymodule\Plugin\RulesAction\MyAction.
 */
namespace Drupal\mymodule\Plugin\RulesAction;
use Drupal\rules\Core\RulesActionBase;

The namespace must correspond to your module name and class name!

4. Rule Action specifications and parameters

Comments are very important as they are also specifications. You will define your Action id, description, and parameters. For instance, here is a copied sample from the predefined action DataSet:

/**
 * Provides a 'My action' action.
 *
 * @RulesAction(
 *   id = "rules_myaction",
 *   label = @Translation("Set a data value"),
 *   category = @Translation("Data"),
 *   context = {
 *     "data" = @ContextDefinition("any",
 *       label = @Translation("Data"),
 *       description = @Translation("Specifies the data to be modified using a data selector, e.g. 'node:author:name'."),
 *       allow_null = TRUE,
 *       assignment_restriction = "selector"
 *     ),
 *     "value" = @ContextDefinition("any",
 *       label = @Translation("Value"),
 *       description = @Translation("The new value to set for the specified data."),
 *       default_value = NULL,
 *       required = FALSE
 *     )
 *   }
 * )
 */

The Rule id is rules_myaction.

The category of the action in the dropdown menu is Data and it will be labeled Set a data value.

The current action will have two parameters : the data that will be changed, and the corresponding value.

5. Rule Action callback

Again, no more plain callback, the function doExecute will be called to execute your Action:

class MyAction extends RulesActionBase {

  /**
   * Executes the Plugin.
   *
   * @param mixed $data
   *   Original value of an element which is being updated.
   * @param mixed $value
   *   A new value which is being set to an element identified by data selector.
   */
  protected function doExecute($data, $value) {
    $typed_data = $this->getContext('data')->getContextData();
    $typed_data->setValue($value);
  }

  /**
   * {@inheritdoc}
   */
  public function autoSaveContext() {
    // Saving is done at the root of the typed data tree, for example on the
    // entity level.
    $typed_data = $this->getContext('data')->getContextData();
    $root = $typed_data->getRoot();
    $value = $root->getValue();
    // Only save things that are objects and have a save() method.
    if (is_object($value) && method_exists($value, 'save')) {
      return ['data'];
    }
    return [];
  }

}

The class name has to correspond to your file name.

In this sample, the parameter $value will be set to $data.

6. Troubleshooting

Uncaught PHP Exception Drupal\\Component\\Plugin\\Exception\\PluginException: "Plugin (rules_myaction) instance class "Drupal\\tbh_system\\Plugin\\RulesAction\\MyAction" does not exist."

Your namespace/classname/filename/directoryname is probably wrong.

Source

Drupal 8 Rules Action documentation

"SQLSTATE[HY000] [2002] No such file or directory" for compiled PHP

Mathieu — Tue, 19 Apr 2016 22:52:00 +0200

Let's say you connect to MySQL using "localhost"

Let's say you compiled PHP

Let's say you didn't specify the --with-mysql-sock= parameter in your configure command when you built mysql

And let's suppose you cannot connect to MySQL using PHP. CLI works fine, but not CGI.

Solution : fix the default sockets in php.ini (use your own working socket paths) :

pdo_mysql.default_socket=/var/run/mysqld/mysqld.sock
mysqli.default_socket = /var/run/mysqld/mysqld.sock

# You shouldn't use mysql_ extension, but if you did:
mysql.default_socket = /var/run/mysqld/mysqld.sock

I suppose that automatically converting "localhost" to an unix socket is done for performance reason on unix systems.

DomPDF : load custom local fonts in you own folder

Mathieu — Fri, 12 Feb 2016 23:28:00 +0100

I needed custom fonts for domPDF, but I didn’t want to use the “remote” capabilities of domPDF, and I didn’t wanted to spoil my “contrib” folder with my own fonts. Dependencies should remain clean.

My domPDF version was 0.6.3.

To use your own “fonts” folder in order to autoload you own fonts, do :

Creates a directory for your fonts and font cache :

mkdir myfonts

Copy your .ttf files in this folder.
Creates a file named dompdf_font_family_cache.php in the myfonts folder, and reference your files. As a sample, you can use the file dompdf/lib/fonts/dompdf_font_family_cache.dist.php
In your configuration (dompdf_config.custom.inc.php), change the DOMPDF_FONT_DIR and DOMPDF_FONT_CACHE to point on your folder myfonts (relative use realpath on relative paths).
Use your fonts like native fonts in font-family declarations.

I hope it will be useful to you.

Drupal 7 : create your own image effect for use in image styles

Mathieu — Wed, 25 Feb 2015 18:56:00 +0100

Drupal comes with many predefined effects, you can combine them in image styles to get the picture you want. But what if you have to make your own effect ? Here is how.

Step 1 : create a module

If you are a drupal developer, you should know how to make a module. Okay, I am lazy too :

myeffect.info :

name = My Effect
description = "My wonderful border effect"
core = 7.x
dependencies[] = image
files[] = myeffect.module
package = Media

Step 2 : declare your effect

Implement hook_image_effect_info :

function myeffect_image_effect_info() {
  $effects = array(
    'myeffect_image_border' => array(
      'label' => t('My Effect - Border'),
      'help' => t('Add border to an image'),
      'effect callback' => '_myeffect_image_border_effect',
// Let's make things simpler...
//      'form callback' => '_myeffect_image_border_form',
//      'summary theme' => '_myeffect_image_border_summary',
    ),
  );
  return $effects;
}

Step 3 : write the callback

function _myeffect_image_border_effect(&$image, $data) {
  if (!_myeffect_image_border($image, $data)) {
    watchdog('image', 'Image add border failed using the %toolkit toolkit on %path (%mimetype)', array(
      '%toolkit' => $image->toolkit,
      '%path' => $image->source,
      '%mimetype' => $image->info['mime_type'],
    ), WATCHDOG_ERROR);
    return FALSE;
  }
  return TRUE;
}

function _myeffect_image_border(stdClass $image, $data) {
  if ($image->toolkit == 'gd') {
    $params = array($image, $data);
    return call_user_func_array('_myeffect_gd_border', $params);
  } else {
    watchdog('image', 'The selected image handling toolkit %toolkit can not correctly process %function.', array(
      '%toolkit' => $image->toolkit,
      '%function' => $function,
    ), WATCHDOG_ERROR);
    return FALSE;
  }
}

Step 4 : make your effect !

function _myeffect_gd_border(stdClass $image, $data) {

  $width = $image->info['width'];
  $height = $image->info['height'];

  // Note : source image is in $image->resource
  $dst = imagecreatetruecolor($width, $height);

...

  // Update image object.
  $image->resource = $dst;
  $image->info['width'] = $width;
  $image->info['height'] = $height;

  return TRUE;
}

Source

The content of this article is widely based on the module Image Effect Kit, you can download and read it for a more complete example.

Drupal 7 : change page title on node form

Mathieu — Mon, 10 Nov 2014 11:19:00 +0100

Every rule has its exceptions, setting drupal_set_title directly on form_alter doesn’t work for node form title. To customize pages like “Add node”, or “Edit node” :

Make a module
Add a function to implement hook_form_alter
Add a form afterbuild in your hook_form_alter implementation: $form['#after_build'][] = '_my_callback_form_set_title'
In '_my_callback_form_set_title', use drupal_set_title to change the form title: drupal_set_title(...)
Update system table to have the weight of your module greater than Node module (on a default install, core modules are weighted 0, so set your module weight to 1).
Rebuild registry, clear caches.

osTicket, wget, crontab and FastCGI

Mathieu — Sat, 29 Jun 2013 23:27:00 +0200

After a long night trying to get HTTP cron for osTickets to work, here is my solution :

Things to know

Rewritting the URLs of a FastCGI-running PHP application, using Apache2 mod_rewrite on PATH_INFO is broken, it does not work. Never.
osTicket needs POST requests to its API.
osTicket uses an unsafe way to get PATH_INFO, obviously it will not work with FastCGI.

How to get it work

Open includes/class.osticket.php

Replace :

//TODO: conruct possible path info.

With :

$path_info = str_replace(BASE_URI."/", "", $_SERVER['REQUEST_URI']); if (!empty($path_info)) return $path_info;

And call the cron like that :

/usr/bin/wget -q --no-cache -O /dev/null --post-data '' --header='X-API-Key:your_api_key_here' 'http://example.com/api/http.php/tasks/cron'

C99Shell et dé-obfuscation

Mathieu — Tue, 06 Apr 2010 18:05:00 +0200

Ayant eu récemment l'occasion de travailler sur un site s'étant fait own3d par un script kiddie via la faille phpMyVisites, j'ai eu l'occasion d'essayer C99Shell, l'outil qui était utilisé par ces derniers pour accéder au backend du site.

C99Shell est un outil pour script kiddie qui permet de faire, entre autre :

BruteForce FTP
Execution de code arbitraire
Upload/Modification/Lecture de fichiers
Recherche automatique de mots de passe phpBB et autres
...

Non je ne fournit pas le code. J'ai pourtant été obligé pour le lancer et pour contourner le mot de passe qui était hardcodé dans le code, de le dé-obfusquer.

Voici donc un petit script pour dé-obfusquer rapidement ce genre de code qui est créé à coup de eval(base64_decode(...)) : decode_eval_base64sh

Pour servir à d'autres, ou à moi comme aide mémoire (nécessite php5-cli).