CRM_Utils_File::isAbsolute does not respect PHP stream wrappers

Overview

Given an install with Drupal and CiviCRM, the CRM_Utils_File::isAbsolute method does not respect paths that are prefixed with a stream wrapper. For example, this breaks if using Kernel tests and a mocked file system. Paths are prefixed with vfs://. Also, you may be using AWS to store files and leveraging an s3:// stream wrapper.

Reproduction steps

1. Set file_private_path to a stream wrapper path
2. Install CiviCRM
3. Explodes as CiviCRM prefixes the valid path with the core Drupal path

Here is how I worked around it in a test, in setup, by replicating civicrm.install

    module_load_install('civicrm');
    $setup = _civicrm_setup();
    $installed = $setup->checkInstalled();
    if ($installed->isSettingInstalled() || $installed->isDatabaseInstalled()) {
      throw new \Exception("CiviCRM appears to have already been installed. Skipping full installation.");
    }

    \Civi\Setup::dispatcher()
      ->addListener('civi.setup.installFiles', function (\Civi\Setup\Event\InstallFilesEvent $e) use ($file_private_path) {
        $model = $e->getModel();
        $model->settingsPath = implode(DIRECTORY_SEPARATOR, [$this->siteDirectory, 'civicrm.settings.php']);
        $model->templateCompilePath = implode(DIRECTORY_SEPARATOR, [$file_private_path, 'civicrm', 'templates_c']);
      }, 900);

    $setup->installFiles();
    $setup->installDatabase();

added git:civicrm-drupal git:civicrm-setup sig:unverified-bug labels

Thanks for reporting @mglaman, and for sharing your workaround. Quick question: are you talking about D7 or D8+? (this might be obvious to other people... )

@DaveD, @seamuslee, @KarinG, would you be able to have a look a this?

Sorry, this is for D8. But I have a feeling it could happen in D7 as well where stream wrappers are commonly used to signify paths

It might not be too hard to fix in core, just would want to see how isAbsolute is used elsewhere where it might have some assumptions. Fortunately doesn't look like too many places to check, at least in core:

CRM/Core/Resources.php:      if (CRM_Utils_File::isAbsolute($pattern)) {
CRM/Extension/Upgrader/TasksTrait.php:    $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->getExtensionDir() . DIRECTORY_SEPARATOR . $tplFile;
CRM/Extension/Upgrader/TasksTrait.php:    $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->getExtensionDir() . DIRECTORY_SEPARATOR . $tplFile;
CRM/Utils/File.php:  public static function isAbsolute($path) {
CRM/Utils/File.php:    if (!self::isAbsolute($directory)) {
ext/afform/admin/CRM/AfformAdmin/Upgrader/Base.php:    $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->extensionDir . DIRECTORY_SEPARATOR . $tplFile;
setup/plugins/init/Backdrop.civi-setup.php:  if (!CRM_Utils_File::isAbsolute($filePublicPath)) {
setup/plugins/init/Backdrop.civi-setup.php:  elseif ($filePrivatePath && !CRM_Utils_File::isAbsolute($filePrivatePath)) {
setup/plugins/init/Drupal.civi-setup.php:  if (!CRM_Utils_File::isAbsolute($filePublicPath)) {
setup/plugins/init/Drupal.civi-setup.php:  elseif ($filePrivatePath && !CRM_Utils_File::isAbsolute($filePrivatePath)) {
setup/plugins/init/Drupal8.civi-setup.php:  elseif (!CRM_Utils_File::isAbsolute($filePublicPath)) {
setup/plugins/init/Drupal8.civi-setup.php:  elseif ($filePrivatePath && !CRM_Utils_File::isAbsolute($filePrivatePath)) {

One other note is that DIRECTORY_SEPARATOR gets overused and is often used wrong. When using streams I think that would be yet another scenario where you would not want DIRECTORY_SEPARATOR but just always use '/'.

mentioned in commit 1f7f3464

added triaged label

Hi,

Thank you for raising an issue to help improve CiviCRM. As you may know, this issue has not had any activity for quite some time, so we have closed it.

We would like you to help us to determine if this issue should be re-opened:

• If this issue was reporting a bug, can you attempt to reproduce it on a latest version of CiviCRM?
• If this issue was proposing a new feature, can you verify if the feature proposal is still relevant? Did it get the concept-approved label? Have other people also shown interest? Could it be implemented as an extension?

If the answer to either question is yes, please feel free to comment or re-open the issue. Please also consider:

• Is it something that you could help implement, either by sending a patch or hiring someone who can?
• Would you be willing to fund the work, either through a CiviCRM partner, or the Core Team?

Thank you for your help and contributions to CiviCRM.

P.S. This is an automated message, see infra/gitlab issue 20. We understand that automatic responses are annoying, but given the number of open issues as the project evolves, we need a bit of help to triage and prioritise the most relevant issues.

closed