CRM-20780 Add drupal option to define CMS_ROOT

[eileenmcnaughton]

• CRM-20780: Add drupal option to define CMS_ROOT

[seamuslee001]

I'm ok with it

[totten]

Why does this need a new constant? In civicrm.settings.php, can't one now say:

global $civicrm_paths;
$civicrm_paths['cms.root']['path'] = '/var/ww/foo';

[eileenmcnaughton]

I can try that

[totten]

Erm, responding to my own comment a bit...

1. I do think it'll be long-term more coherent to handle path/url overrides through $civicrm_paths array.

2. There are a few older bits of code which explicitly call cmsRootPath(), eg here or here. These call-paths don't currently respect the global $civicrm_paths. Either of these should solve that:

   • Search/replace. Most places currently calling cmsRootPath() should instead call Civi::paths()->getVariable('cms.root', 'path') or Civi::paths->getPath('[cms.root]/foo/bar')
   • Hotwire. Use a patch just like this one you wrote, but -- instead of reading CMS_ROOT -- read $GLOBALS['civicrm_paths']['cms.root']['path']. (Preferrably, reproduce this in each variant of CRM_Utils_System_*::cmsRootPath().)

[eileenmcnaughton]

@totten kinda snap - I tried it & this worked find - so I'll swap to that

    global $civicrm_paths;
    if (!empty($civicrm_paths['cms.root']['path'])) {
      return $civicrm_paths['cms.root']['path'];
    }

[eileenmcnaughton]

I have merged @totten addition & I'm taking that plus previous discussion as approval & adding merge-on-pass