Drupal

Setting Field-level Visibility (Public/Private) in Drupal

Overview In Omeka S, visibility can be set at the field level (public/private). These are notes on how to achieve this in Drupal. Installation composer.phar require 'drupal/field_permissions:^1.4' ./vendor/bin/drush en field_permissions Configuration Navigate to the edit page for a specific field of a content type, such as: /admin/structure/types/manage/bib_1/fields/node.bib_1.field_003_permission_number As shown below, you can configure the field visibility. Programmatic Access Field view permissions can be checked using the access function as follows. ...

August 16, 2024 · Updated: August 16, 2024 · 1 min · Nakamura

Drupal: Troubleshooting Cache Clear Errors

Overview When clearing the cache in Drupal, the following error sometimes occurred. ./vendor/bin/drush cr In CheckExceptionOnInvalidReferenceBehaviorPass.php line 88: The service "access_check.contact_personal" has a dependency on a non-exist ent service "user.data". Here are my notes on how to resolve this error. References The following was helpful. https://www.drupal.org/forum/support/upgrading-drupal/2018-04-26/after-upgrade-to-853-the-service-access_checkcontact Solution A module named user had been created by the Features module. /modules/custom/user Deleting this resolved the error. Additional Note Similarly, a module named comment was also causing issues. Deleting it likewise resolved the error. ...

August 16, 2024 · Updated: August 16, 2024 · 1 min · Nakamura

Bulk Deleting Multiple Content Items Using the Drupal REST API

Overview I had the opportunity to bulk delete multiple content items using the Drupal REST API, so this is a memo of the process. References For a method to bulk delete content without using the REST API, please refer to the following. Preparation First, enable the HTTP Basic Authentication module and the JSON:API module. Additionally, enable DELETE in REST resources. /admin/config/services/rest Execution Example The following custom library is used. ...

July 14, 2024 · Updated: July 14, 2024 · 2 min · Nakamura

Reverse Proxy Settings for Drupal Running with Docker + Traefik

Overview I was running Drupal with HTTPS using Docker + Traefik, as introduced in the following article. At the time, with Drupal’s default settings, URLs were set with http as shown below. The problem with this was that, for example, when setting up Google account login as described in the following article, the redirect URL started with http, while the Google Cloud console requires URLs starting with https. This discrepancy caused authentication to fail in some cases. ...

July 4, 2024 · Updated: July 4, 2024 · 1 min · Nakamura

Drupal: Setting Pre-filled Values Using the Prepopulate Module

Overview When accessing the Drupal content creation screen, I was able to set pre-filled values by specifying query parameters, so this is a memo of the process. The following module is used. https://www.drupal.org/project/prepopulate Usage For example, when adding new content to a content type called “poems,” add query parameters as follows. </node/add/poems?edit[field_spot][widget][0][target_id]=1&edit[title][widget][0][value]=テスト> As a result, the registration screen is displayed with the initial values pre-filled as shown below. Summary I hope this serves as a useful reference. ...

June 12, 2024 · Updated: June 12, 2024 · 1 min · Nakamura

Logging into Drupal Programmatically

This is a personal note on how to log into Drupal programmatically. The following article was helpful: https://drupal.stackexchange.com/questions/185494/how-do-i-programmatically-log-in-a-user-with-a-post-request curl --location 'http://drupal.d8/user/login?_format=json' \ --header 'Content-Type: application/json' \ --data '{ "name": "admin", "pass": "admin" }' By sending a request like the above, I was able to obtain a response like the following: {"current_user":{"uid":"1","roles":["authenticated","administrator"],"name":"admin"},"csrf_token":"wBr9ldleaUhmP4CgVh7PiyyxgNn_ig8GgAan9-Ul3Lg","logout_token":"tEulBvihW1SUkrnbCERWmK2jr1JEN_mRAQIdNNhhIDc"} I hope this serves as a useful reference.

May 31, 2024 · Updated: May 31, 2024 · 1 min · Nakamura

Bulk Exporting Registered Content in CSV Format from Drupal

Overview I had the opportunity to export registered content from Drupal in CSV format, so here are my notes. I used the following module. https://www.drupal.org/project/content_export_csv Installation It could be installed using the standard method. composer require 'drupal/content_export_csv:^4.7' ./vendor/bin/drush en content_export_csv Usage After installation, navigating to Administration > Content > Content displays the “Export Content” button. On the next screen, by selecting the content type you want to export, I was able to export a list of content of the specified content type. ...

May 30, 2024 · Updated: May 30, 2024 · 1 min · Nakamura

Triggering GitHub Actions from Drupal Events

Overview This is a memorandum on how to trigger GitHub Actions from Drupal events. The following site was helpful: https://qiita.com/hmaruyama/items/3d47efde4720d357a39e Pipedream Configuration Create a workflow that includes a trigger and a custom_request. For the trigger, please refer to the following: https://qiita.com/hmaruyama/items/3d47efde4720d357a39e#pipedream側の設定 In custom_request, configure the dispatch settings. https://docs.github.com/ja/rest/repos/repos?apiVersion=2022-11-28#create-a-repository-dispatch-event Configure the settings as follows: curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/dispatches \ -d '{"event_type":"webhook"}' ...

May 28, 2024 · Updated: May 28, 2024 · 1 min · Nakamura

Getting a List of Untranslated Nodes in Drupal

Overview I had the opportunity to get a list of untranslated nodes in Drupal, so this is a personal note for future reference. Method There are various approaches, but this time I use JSON:API. Let’s assume the master language is Japanese (ja) and the translation language to add is English (en). Using JSON:API, for example, for a taxonomy called collection, you can retrieve it with the following: https://xxx/jsonapi/taxonomy_term/collection Additionally, by adding /en as follows, if a translation node exists, that information is returned. ...

May 22, 2024 · Updated: May 22, 2024 · 2 min · Nakamura

Case-Insensitive Search in Drupal's Search API

Overview This is a memo on performing case-insensitive search when using Drupal’s Search API. Method Access the following page and check “Ignore case.” /admin/config/search/search-api/index/<content_type>/processors Furthermore, in the Processor settings at the bottom of the screen, select the fields to which you want to apply this processing. It was also possible to select all fields as shown below. By performing reindexing, the above settings will be reflected. Summary I hope this serves as a helpful reference. ...

May 6, 2024 · Updated: May 6, 2024 · 1 min · Nakamura

Handling the Error: Input value "page" contains a non-scalar value

Overview I addressed the same error in the following article. However, there were cases where the error could not be resolved even after applying the above fix, so I describe additional measures here. Error Details The error details are as follows. In particular, it occurred when jsonapi_search_api_facets was enabled. { "jsonapi": { "version": "1.0", "meta": { "links": { "self": { "href": "http://jsonapi.org/format/1.0/" } } } }, "errors": [ { "title": "Bad Request", "status": "400", "detail": "Input value \"page\" contains a non-scalar value.", "links": { "via": { "href": "http://localhost:61117/web/jsonapi/index/document?page%5Blimit%5D=24&sort=field_id" }, "info": { "href": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1" } }, "source": { "file": "/app/vendor/symfony/http-kernel/HttpKernel.php", "line": 83 }, "meta": { "exception": "Symfony\\Component\\HttpFoundation\\Exception\\BadRequestException: Input value \"page\" contains a non-scalar value. in /app/vendor/symfony/http-foundation/InputBag.php:38\nStack trace:\n#0 /app/web/modules/contrib/facets/src/Plugin/facets/url_processor/QueryString.php(92): Symfony\\Component\\HttpFoundation\\InputBag->get('page')\n#1 /app/web/modules/contrib/facets/src/Plugin/facets/processor/UrlProcessorHandler.php(76): Drupal\\facets\\Plugin\\facets\\url_processor\\QueryString->buildUrls(Object(Drupal\\facets\\Entity\\Facet), Array)\n#2 /app/web/modules/contrib/facets/src/FacetManager/DefaultFacetManager.php(339): ... Solution I modified the buildUrls method in the file mentioned above. ...

April 30, 2024 · Updated: April 30, 2024 · 2 min · Nakamura

Verifying OAuth Authentication Using Drupal's Simple OAuth and Postman

Overview This article verifies OAuth authentication using Drupal’s Simple OAuth and Postman. I previously wrote the following article, but this time I will go into more detail. Setting Up Simple OAuth in Drupal Please refer to the following: https://tech.ldas.jp/en/posts/e4ce978db12227/#Creating an OAuth Client Postman When the grant type is password Send a POST request to /oauth/token with the following specified in Body > x-www-form-urlencoded: Key Value grant_type password client_id {your CLIENT_ID, e.g.: gt8UKlKltI4qs1XP5KLucIXiYw9ulGb0xS4RyO437dc} client_secret {your CLIENT_SECRET, e.g.: test} username {username, e.g.: yamato} password {password, e.g.: yamato} The following JSON was returned: ...

March 2, 2024 · Updated: March 2, 2024 · 5 min · Nakamura

Drupal: Registering Files from URLs Using the Feeds Module

Overview This describes how to register files from URLs using the Feeds module. The following was helpful. https://www.drupal.org/docs/contributed-modules/feeds/feeds-howtos/importing-files Method Find the file field from the dropdown list and create a mapping target for the file or image field. For “File ID,” specify a mapping to the full URL (including the http/https prefix). Select “File ID” under “Reference by.” Configure the action so that the feed processes existing files. After configuring these changes, save the mapping. ...

January 23, 2024 · Updated: January 23, 2024 · 1 min · Nakamura

How to Bulk Delete Files in Drupal

This is a memo on how to bulk delete files in Drupal. The following was helpful. https://www.drush.org/12.x/commands/entity_delete/ drush entity:delete file I hope this serves as a useful reference for situations such as when files can no longer be viewed due to errors like Drupal\Core\File\Exception\InvalidStreamWrapperException.

January 23, 2024 · Updated: January 23, 2024 · 1 min · Nakamura

Handling Private Files in Omeka S

Overview In Omeka S, you can set public/private settings for each resource (item sets, items, media, etc.), but for files such as images associated with media, even if the private setting is applied, anyone who knows the file URL can access it. Typically, the URL follows this pattern: <Omeka installation directory>/files/original/<hash value>.jpg If the private setting is applied to the media, it would be rare for this file URL to be known, but there are cases where you want to avoid a situation where “anyone with the link” can access it. ...

January 14, 2024 · Updated: January 14, 2024 · 4 min · Nakamura

Trying OAuth2 Authentication for REST Resources Using Drupal's simple_oauth Module

Overview Drupal’s Simple OAuth (OAuth2) & OpenID Connect module is described as an implementation of the OAuth 2.0 Authentication Framework RFC. https://www.drupal.org/project/simple_oauth For related articles, please also refer to examples of cookie authentication and JWT authentication. Installation There appear to be version 5.x and 6.x of the simple_oauth module, but this time version 5.x is used. Install with the following: composer.phar require 'drupal/simple_oauth:^5.2' However, when using Sakura Rental Server, the following error occurred. PHP's sodium extension was required. ...

January 2, 2024 · Updated: January 2, 2024 · 5 min · Nakamura

Trying the Drupal Social Auth GitHub Module

Overview I will try the Drupal Social Auth GitHub module. https://www.drupal.org/project/social_auth_github/ This module is described as follows: Social Auth GitHub allows users to register and login to your Drupal site with their GitHub account. The goal is to enable login using a GitHub account as shown below. Installation composer.phar require 'drupal/social_auth_github:^4.0' vendor/bin/drush en social_auth_github The above installation also enables social_auth and social_api. Configuration Follow the configuration instructions on the following page. ...

January 2, 2024 · Updated: January 2, 2024 · 2 min · Nakamura

Testing Drupal REST Resource Cookie Authentication Using Postman

Overview In the following article, I tried JWT authentication using the JWT module. This time, I will try cookie authentication. Installation If the restui module is not installed, install and enable it with a command like the following. composer.phar require 'drupal/restui:^1.21' vendor/bin/drush en restui Configuration This time, I will use cookie authentication as shown below. For details on the configuration method, please refer to the related article at the beginning. ...

January 1, 2024 · Updated: January 1, 2024 · 2 min · Nakamura

Trying the Drupal JSON Web Token Authentication Module

Overview I will try the Drupal JSON Web Token Authentication module. https://www.drupal.org/project/jwt I referenced the following page. https://preston.so/writing/decoupled-drupal-authentication-with-json-web-tokens/ Note that the following is a similar module. https://www.drupal.org/project/rest_api_authentication JWT authentication using the above module is described here. https://www.drupal.org/docs/contributed-modules/api-authentication/jwt-authentication However, as described in the following article, it appears that using JWT authentication with the above module requires a paid plan. Therefore, this time I will try the jwt module instead. Installation and Activation jwt module ...

December 31, 2023 · Updated: December 31, 2023 · 4 min · Nakamura

Investigation of the Drupal REST & JSON API Authentication Module

Overview I will try JWT authentication, referencing the following article. https://www.drupal.org/docs/contributed-modules/api-authentication/jwt-authentication However, after trying it, it appeared that a paid plan subscription was required to use JWT authentication, and the investigation stopped there. Prerequisite: Download and Installation Install and enable the following two modules. https://www.drupal.org/project/rest_api_authentication https://www.drupal.org/project/restui composer.phar require 'drupal/rest_api_authentication:^2.0' composer.phar require 'drupal/restui:^1.21' vendor/bin/drush en rest_api_authentication Steps to Configure JWT-Based API Authentication Follow the instructions below to enable the API and set up JWT-based API authentication. ...

December 31, 2023 · Updated: December 31, 2023 · 1 min · Nakamura