Domain tokens do not work when a node is first saved

This is the workaround I had to implement for now:

/**
 * Implements hook_tokens().
 */
function custom_tokens($type, $tokens, array $data = array(), array $options = array()) {
  $sanitize = !empty($options['sanitize']);
  $replacements = array();

  // Workaround for http://drupal.org/node/1336698 to return valid tokens for
  // a new node being inserted.
  if ($type == 'node' && !empty($data['node'])) {
    $node = $data['node'];

    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'domain':
          if ($domain = custom_domain_get_node_match($node)) {
            $replacements[$original] = $sanitize ? check_plain($domain['subdomain']) : $domain['subdomain'];
          }
          break;
      }
    }

    if ($domain_tokens = token_find_with_prefix($tokens, 'domain')) {
      if ($domain = custom_domain_get_node_match($node)) {
        $replacements += token_generate('domain', $domain_tokens, array('domain' => $domain), $options);
      }
    }
  }

  return $replacements;
}

/**
 * Workaround for http://drupal.org/node/1336698 to return a new node's domain.
 */
function custom_domain_get_node_match($node) {
  $domain = domain_get_node_match($node->nid);
  if (is_array($domain)) {
    // If domain_get_node_match() return a valid domain, then we do not want
    // to continue.
    return FALSE;
  }
  elseif (isset($node->domains) && is_array($node->domains)) {
    $domains = array_filter($node->domains);
    if (!empty($domains) && $domain = domain_lookup(reset($domains))) {
      drupal_alter('domain_source', $domain, $node->nid);
    }
  }
  return is_array($domain) ? $domain : FALSE;
}

Here's the patch I had locally which also seemed to address it by writing the domain access records from within hook_node_insert() and hook_node_update(). Although this approach will be fragile if a module that also implements either hook runs *before* domain.module.

Working on the tests...

Here is a patch with tests based off patch #8. It also fixes an error that allowed the [node:domain:*] tokens to work because domain_get_node_match() returned NULL, which doesn't match the condition if ($domain == -1) in domain_tokens(). The sub-tokens would then erroneously use replace tokens with the default domain values because of the following code in domain_tokens():

    // Get the active domain context.
    if (!empty($data['domain'])) {
      $domain = $data['domain'];
    }
    else {
      $domain = domain_get_domain(); // NOTE: This domain data 'fallback' should be removed. People should be using the [default-domain:*] tokens instead since this can cause false positives in token replacement.
    }

Also the [node:domain] token should be returning the sitename and not the subdomain as the 'name' of the domain should be the default token.

I'm going to add some more test coverage for the tokens as well since this really should be covered prior to 3.0.

Here's a final patch with full test coverage for the domain tokens.

Summary of changes

• Includes changes in patch #8.
• Does not fall back to the default domain in domain_tokens if $type is 'domain' and $data['domain'] is empty. This is what the [current-domain:*] tokens are for. Does not need to be backported as this is actually how the tokens in 7.x-2.x work.
• Changes the [node:domain] token to output the site name rather than the sub-domain. The domain site name is a much better 'default' token to use - think of this like the [node:author] token. 'author' is a user object in this case, and it gets output as the user's formatted name. Does not need to be backported as there is no [node:domain] token in 7.x-2.x.
• Renames the [domain:machine_name] token to [domain:machine-name] as dashes are what should be used if possible in token names. Does not need to be backported to 7.x-2.x as there is no machine name in that branch.
• Test coverage for the domain, current-domain, and default-domain tokens, as well as a regression test specifically for this issue. Ideally some of these tests should be backported to 7.x-2.x. I can help with that post-commit.

Revised patch that allows the [node:machine_name] token to still work with existing token replacement, but essentially deprecates it.

Revised patch should fix failures in folder based install.