Call to template json file broken if site is in sub-directory

Open on Drupal.org →

Created on 5 April 2024, 9 months ago

Updated 29 August 2024, 4 months ago

Problem/Motivation

When a website is not at the root of a domain and is instead nested in a subdirectory the custom template.json file specified in the configuration does not look in the correct place. The base URL of the site is ignored and the module attempts to call the file from the root. Because of the validateConfigurationForm checking the user provided path with DRUPAL_ROOT prepended, the subdirectory can also not be added within the configuration form.

Steps to reproduce

Have a site running out of subdirectory. This could be in a multisite or a standalone site. For example the root of the site is: example.com/site1/
Place a template.json file within the site somewhere. Example: themes/custom/theme1/ckeditor5_template.json This file is now accessible at https://example.com/site1/themes/custom/theme1/ckeditor5_template.json
Edit a text format and configure the Template plugin settings. ex admin/config/content/formats/manage/full_html Set the Template Path to /themes/custom/minst/templates/ckeditor5_template.json The file exists and is validated and configuration is saved.
Create a new page with a CKEditor enabled field. Editor fails to load with a message that the template file is not found. The module attempts to call the file at https://example.com/themes/custom/theme1/ckeditor5_template.json and fails to find the file

Proposed resolution

One possible solution could be to modify the configuration form to take the absolute path to the template.json. In my testing this does work for both sites in subdirectories and at the root but because the full site URL is now stored in configuration, this may now require using config_split with this setup if working with multiple environments. A better solution might be needed.

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report

Status

Needs review

Version

1.0

Component

Code

Created by

🇺🇸United States mrdrewkeller

Live updates comments and jobs are added and updated live.

Sign in to follow issues

Merge Requests

!16Call to template json file broken if site is in sub-directory
Merged
🇺🇸United States bwebster719
updated 2 months ago

Comments & Activities

Issue created by @mrdrewkeller
Status changed to Closed: works as designed 6 months ago11:33am 8 July 2024
Comment 6 months ago →
🇩🇪Germany dbielke1986
I would not take the absolute path to the template.json because it could be a security risk.
We should wait and take care of this issue in the core:

https://www.drupal.org/project/drupal/issues/1792310 🐛 Wrong DRUPAL_ROOT with non-standard code structure RTBC
First commit to issue fork.
Merge request !16Add getBasePath to Template File Path → (Merged) created by bwebster719
Status changed to Needs review 4 months ago3:55pm 28 August 2024
Comment 4 months ago →
🇺🇸United States bwebster719
Assigned to vincent.hoehn
Comment 4 months ago →
🇩🇪Germany dbielke1986
@vincent

Can you take a look at the MR, please?
It makes sense to me if the full path is passed at this point, as this is also checked in validate.

In *.js, only the path is taken from the input, without the Drupal.root.
Can you check again whether this is perhaps the reason why it is not always pulled directly?

But I'm not 100% sure, hence the question.
Comment 2 months ago →
🇩🇪Germany vincent.hoehn Dresden, Germany
Hi @mrdrewkeller, can you please install the dev release and check if this fixes your issue?

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024