domain module steals custom_url_rewrite [#450344]

custom_url_rewrite is not a hook. By defining it, you prevent sites from defining their own behavior for this function.

Attached patch will not break existing sites, but will make it possible to override domain's url rewrites as needed.

Comment	File	Size	Author
	domain_custom_rewrite.diff	812 bytes	Dave Cohen

Comments

Comment #1

agentrickard

he/him

English

Georgia (US)

commented 1 May 2009 at 13:39

Status:

Active

» Needs work

I don't think 'steals' is correct. It implements the function, which 99% of site do not use.

This is a well-documented issue. Most sites do not use custom_url_rewrite_outbound(). Using that function requires that you add custom code to your site, so we can safely assume that people using the function will understand the error.

Section 3 of INSTALL_QUICKSTART.txt: (there is also a note in 4.5 of INSTALL.txt)

3. Check for existing custom_url_rewrite_outbound().

    custom_url_rewrite_outbound() is a special function that you
    can add to settings.php to alter how Drupal writes links to content.
    
    If your site already uses this function -- it is not in core -- then
    you will receive a PHP fatal error. This is because Domain Access
    uses a version of this function as well.
    
    If you encounter this conflict, you need to merge the logic of the
    two functions into a single function.

The patch may prevent an unexpected error, but it doesn't work, because what we need to do in those cases is merge the two functions.

Is there a way to make domain_url_rewrite_outbound() run and then call the other function? (Or vice versa?) Even so, I don't think that will work, since the business logic of the function probably needs examining in all cases.

Comment #2

Dave Cohen commented 1 May 2009 at 18:21

i18n and Drupal for Facebook also implement these functions. In both, there is logic similar to whats in the patch.

Here's an example of custom url rewrites which is possible with the patch I supplied, but not possible without it. This would be in someone's settings.php, for example...

/**
 * Both Drupal for Facebook and domain module use the custom_url_rewrite feature.  We have to define our own functions which call the others in the proper order.
 * Note our version of domain module must be patched to support this.
 */
function custom_url_rewrite_inbound(&$result, $path, $path_language) {
  // Call fb module first
  if (function_exists('fb_settings_url_rewrite_inbound')) {
    fb_settings_url_rewrite_inbound($result, $path, $path_language);
  }
  if (function_exists('domain_url_rewrite_inbound')) {
    domain_url_rewrite_inbound($result, $path, $path_language);
  }
}
function custom_url_rewrite_outbound(&$path, &$options, $original_path) {
  // call fb module last
  if (function_exists('domain_url_rewrite_outbound')) {
    domain_url_rewrite_outbound($path, $options, $original_path);
  }
  if (function_exists('fb_settings_url_rewrite_outbound')) {
    fb_settings_url_rewrite_outbound($path, $options, $original_path);
  }
}

Sure, the custom url rewrite function leave something to be desired. And there are patches to make them hooks instead of single functions. But in my opinion a module should be written in a way that makes it easy for people to build their sites. Is your idea is that if someone needs a customized url rewrite, they should change the logic in sites/all/modules/domain/settings_custom_url.inc? Sounds like a big headache if you ever make a change to that same file.