Inheriting domain settings for terms created programmatically using taxonomy_save_term()

Hi garywiz,

I'm a newcomer to Drupal and PHP. I have a problem which I *think* might be related to what you describe.

I'm using Domain Access to create multiple sites from a single Drupal instance and codebase. The sites have different content and I use Domain Taxonomy to categorise content. So on the form to create a new page on site X, I have a "category" input field which dynamically shows me terms already in the taxonomy for that site, e.g. I type "S" and it prefills "Schools". However, when I type a new value (e.g "Churches") although this gets added to the taxonomy, the domain access isn't set. So if I added pages for three "Churches", I'd end up with three "Church" categories, none of which is assigned to any domain. I can get around this by setting the domain manually for each new term as I add a page, but it's cumbersome.

I'm not sure if this is the same issue as yours...?

Hi garywiz,

Thanks for taking the time and trouble to reply. I've just added your function to my taxnonomy_domain.module, wrapping the body in
if ($type == 'term'){}

It's not working for me as it stands, but I suspect that may be because my vocabulary is top level, so no parent to inherit from (so covered by your caveat in #1 above). I'm still getting to grips with Taxonomy, and it had occurred to me that perhaps my categories shouldn't be top level terms, so possibly I'd kill two birds with one stone if I go down that route.

You mention above you've changed the module quite a bit. If you could post your latest version, that would be great. I'll keep you posted when I've had a chance to investigate. (I'm tied up in an important doll's house project for Santa Claus at the moment.)

Happy holiday!

+1 #8 tested, seems ok

Well, if I had just read a bit further into the issue queue, I would have found this patch and saved myself 4 hours of useless coding! Doh! I have tested this on a tags vocab and it works perfectly. Thanks very much, garywiz.

I just did a brief test of #8 and it seems to work in my use case as well.

I applied the patch to the last 6.x-1.x-dev from 2011-Oct-06 (patches should always be against the latest dev) and it worked fine.

Upgrading to major since this bug seriously affects the expected behaviour.

Does this effect 7.x branches too?

Thanks Garywiz, and sorry for the delay everyone. Committed to 6.x.1.x dev.
@Alan D. - no this patch won't work with D7, as hook_taxonomy disappeared. This bug is still active (as far as I know) in D7.

Currently our local system is a mess, but we can not pin-point the cause (I have yet to investigate).

We had a junior programmer import the terms, about 6000, 8 months back, and he managed to break about everything he touched. Then we have had constant data entity by multiple users. Six months ago we added Domain Access, followed by Domain Taxonomy about 1 month ago and haven't really though about it since till today. Now we wondering how / where duplicates are being generated, issues with merging / editing these, lack of domain settings, .... So just trying to track the status of potential causes :)

If I find anything specific to DA Taxonomy, I will report back.

Some progress - starting with the duplicate terms that arise if tagging with a term that exists but is not accessible due to DA restrictions, then move it into existing terms that are not currently tagged to the domain.

I have really no idea of the options of this module, so these will need check and modified. For the widget to work, the term must be accessible on the domain that it is being added to BEFORE field validation.

During validation, Taxonomy does this if the term can not be loaded:

        $vocabulary = reset($vocabularies);
        $term = array(
          'tid' => 'autocreate',
          'vid' => $vocabulary->vid,
          'name' => $typed_term,
          'vocabulary_machine_name' => $vocabulary->machine_name,
        );

And this gets processed in taxonomy_term_save().

function taxonomy_term_save($term) {
  .....
  field_attach_presave('taxonomy_term', $term); // << I think processing of autocreate is done here
  module_invoke_all('taxonomy_term_presave', $term);
  module_invoke_all('entity_presave', $term, 'taxonomy_term');
  ..... save
  // Reset the taxonomy term static variables.
  taxonomy_terms_static_reset();

  // Invoke the taxonomy hooks.
  module_invoke_all("taxonomy_term_$op", $term);
  module_invoke_all("entity_$op", $term, 'taxonomy_term');

I could not get PHP 5.2 to update the term object from any of these hooks. So I could not update 'autocreate' term id here. This is kinda bung as it means we loss a global location for doing this.

Stepping back from the save & presave hooks, the next (almost) global location was the widget itself. So I have added a new #element_validate that checks for duplicates before 'autocreate' is appended. If found, these are shared to the current domain and any entity domains.

Data is saved using HOOK_taxonomy_term_ACTION() hooks.

Cons: Only targets this widget and if the form doesn't validate and the term is latter removed, the term is added to this domain.

function domain_taxonomy_field_widget_form_alter(&$element, &$form_state, $context) {
  if ($context['field']['type'] == 'taxonomy_term_reference'
      && $context['instance']['widget']['type'] == 'taxonomy_autocomplete') {
    // Update the validate function to set domain access options on validation.
    $index = array_search('taxonomy_autocomplete_validate', $element['#element_validate']);
    $element['#element_validate'][$index] = 'domain_taxonomy_autocomplete_validate';
  }
}

/**
 * Form element validate handler for taxonomy term autocomplete element.
 */
function domain_taxonomy_autocomplete_validate($element, &$form_state) {
  // Autocomplete widgets do not send their tids in the form, so we must detect
  // them here and process them independently.
  $value = array();

  if ($tags = $element['#value']) {
    list($id) = entity_extract_ids($element['#entity_type'], $element['#entity']);

    // Collect candidate vocabularies.
    $field = field_widget_field($element, $form_state);
    $vocabularies = array();
    foreach ($field['settings']['allowed_values'] as $tree) {
      if ($vocabulary = taxonomy_vocabulary_machine_name_load($tree['vocabulary'])) {
        $vocabularies[$vocabulary->vid] = $vocabulary;
      }
    }

    $domain = domain_get_domain();

    // Translate term names into actual terms.
    $typed_terms = drupal_explode_tags($tags);
    foreach ($typed_terms as $typed_term) {
      // See if the term exists in the chosen vocabulary and return the tid;
      // otherwise, create a new 'autocreate' term for insert/update.
      if ($possibilities = taxonomy_term_load_multiple(array(), array('name' => trim($typed_term), 'vid' => array_keys($vocabularies)))) {
        $term = array_pop($possibilities);
      }
      else {
        // See if the term really exists but is not belonging to this domain.
        $vocabulary = reset($vocabularies);
        $term = db_select('taxonomy_term_data', 't')
            ->fields('t')
            ->condition('name', $typed_term)
            ->condition('vid', $vocabulary->vid)
            ->execute()
            ->fetch();
        // Register this term and entity for processing during entity save.
        if (!$term) {
          $term = array(
            'tid' => 'autocreate',
            'vid' => $vocabulary->vid,
            'name' => $typed_term,
            'vocabulary_machine_name' => $vocabulary->machine_name,
          );
        }
      }

      // Load domains and append the current domain to this term.
      // @todo: Not really sure on all of the options here?
      $term = (object) $term;
      if ($term->tid !== 'autocreate') {
        domain_taxonomy_load_term($term);
      }
      if (!isset($term->domain_source)) {
        $term->domain_source = 0;
      }
      // We need this to pass validation taxonomy_field_validate().
      if (empty($term->domains[$domain['domain_id']])) {
        $term->domains[$domain['domain_id']] = $domain['domain_id'];
        if ($term->tid !== 'autocreate') {
          domain_taxonomy_save_term($term);
        }
      }

      // Give the term the same domains as the parent, otherwise it would be
      // restricted to only some domains and the widget would not work.
      if (isset($entity->domains)) {
        foreach (array_filter($entity->domains) as $domain_id) {
          $term->domains[$domain_id] = $domain_id;
        }
      }

      $value[] = (array) $term;
    }
  }
  form_set_value($element, $value, $form_state);
}

function domain_taxonomy_taxonomy_term_insert($term) {
  $update = TRUE;
  // Attempt to reload domains from another operation.
  if (!isset($term->domains)) {
    domain_taxonomy_load_term($term);
    $update = FALSE;
  }
  // We must have at least one domain.
  if (empty($term->domains)) {
    $domain = domain_get_domain();
    $term->domains[$domain['domain_id']] = $domain['domain_id'];
    $update = TRUE;
  }
  if (!isset($term->domain_source)) {
    $term->domain_source = 0;
  }
  if ($update) {
    domain_taxonomy_save_term($term);
  }
}
function domain_taxonomy_taxonomy_term_update($term) {
  if (isset($term->domains)) {
    // Safely check to enforce at least one domain.
    if (empty($term->domains)) {
      $domain = domain_get_domain();
      $term->domains[$domain['domain_id']] = $domain['domain_id'];
    }
    // Assume that is a custom callback as domains was set.
    if (!isset($term->domain_source)) {
      $term->domain_source = 0;
    }
    domain_taxonomy_save_term($term);
  }
}
function domain_taxonomy_taxonomy_term_delete($term) {
  // Should there be a clean up hook?
}

I was so expecting a 2 or 3 LOC for this, this is a nightmare!

Alan,
I feel your pain. It's not going to be a 2 or 3 lines of code change. Most of this module's weirdness seems to be a byproduct of how we Drupaled in 2006. It's telling the only patches I've applied since maintaining this module have been to 6.x versions...

You are touching a much larger issue, imo. This module simply isn't built or Drupal 7. Sure, it doesn't whitescreen, and sort of works, but its ways of doing things are old enough to be in kindergarden by now.

If you make a patch that I can apply to 7.x-3.x dev geared towards the sensible goal of using Drupal's "modern" API, I'll release a 7.x-4.x dev version for the purpose of moving it forward. Be sure to mark the issue as critical if you do, of course.

To date, no issues. This is a fairly independent piece of code to tack into the module. (The missing delete is simply an oversight and has no bearing on this issue at hand, couple mis-placed int's in a table isn't going to hurt).

Since there are really no other front end field types, this resolves the front end issues afaict, but my knowledge is limited to - "somethings broke, shit cores f'ed - saving early in presave, how to bypass core without disabling query access, eureka validation, shit core validation kicked into action, validation plan two, assign domains during validation".

I guess if someone tries to commit a term, then there is no reason not to add it. I think that this is cleaner than starting to tag globals or hidden form elements.

Guessing admin related task should be much easier, move away from the additional submission handlers and just let the above code do its thing (if I have the constants, defaults, etc right)

Alright, could you send me a zip of your version? Happy to make a diff myself.
email is nick (at) chapterthree.com

This really is not in a state to commit - the entity hooks will be run twice (but that was a sacrifice that we were willing to undertake on this project due to time restrictions).

This looks like a great start. Just curious: what's with all the checking for domains being set? (shouldn't at least one always be set?)

Answered my own question after submitting (the disable domain rules per vocab rule....)

Remember I was guessing at some of the functionality here.

After skimming the start of this thread, have I hijacked the general issue here by extending the scope past programmatically created terms to include free tagged terms. Guessing that this is going to be the most complex use-case, so why not start with the hardest bit :)

I think that domain_taxonomy_taxonomy_term_insert / update() need the most work, so if the domain options are not present, and that these can not be loaded, then to update the term with the modules default DA options.

In D7, would "Domain Access Taxonomy" be better in this respect?
Should the two modules be unified?
Please consider http://drupal.org/node/1520062

#21 works for me, thx !