more module updates

This commit is contained in:
Bachir Soussi Chiadmi
2015-04-20 18:02:17 +02:00
parent 37fbabab56
commit 7c85261e56
100 changed files with 6518 additions and 913 deletions

View File

@@ -0,0 +1,289 @@
<?php
/**
* @file
* Menu page callbacks of Synonyms module.
*/
/**
* Page callback: Outputs JSON for taxonomy autocomplete suggestions.
*
* This callback outputs term name suggestions in response to Ajax requests
* made by the synonyms autocomplete widget for taxonomy term reference
* fields. The output is a JSON object of plain-text term suggestions,
* keyed by the user-entered value with the completed term name appended.
* Term names containing commas are wrapped in quotes. The search is made
* with consideration of synonyms.
*
* @param string $field_name
* The name of the term reference field.
* @param string $entity_type
* Entity type to which the supplied $field_name is attached to
* @param string $bundle
* Bundle name to which the supplied $field_name is attached to
* @param string $tags_typed
* (optional) A comma-separated list of term names entered in the
* autocomplete form element. Only the last term is used for autocompletion.
* Defaults to '' (an empty string).
*/
function synonyms_autocomplete($field_name, $entity_type, $bundle, $tags_typed = '') {
// If the request has a '/' in the search text, then the menu system will have
// split it into multiple arguments, recover the intended $tags_typed.
$args = func_get_args();
// Shift off the $field_name argument.
array_shift($args);
// Shift off the $entity_type argument.
array_shift($args);
// Shift off the $bundle argument.
array_shift($args);
$tags_typed = implode('/', $args);
// Make sure the field exists and is a taxonomy field.
if (!($field = field_info_field($field_name)) || $field['type'] != 'taxonomy_term_reference') {
// Error string. The JavaScript handler will realize this is not JSON and
// will display it as debugging information.
print t('Taxonomy field @field_name not found.', array('@field_name' => $field_name));
exit;
}
if (!($instance = field_info_instance($entity_type, $field['field_name'], $bundle))) {
// Error string. The JavaScript handler will realize this is not JSON and
// will display it as debugging information.
print t('There was not found an instance of @field_name in @entity_type.', array(
'@field_name' => $field_name,
'@entity_type' => $entity_type,
));
exit;
}
// How many suggestions maximum we are able to output.
$max_suggestions = $instance['widget']['settings']['suggestion_size'];
// Whether we are allowed to suggest more than one entry per term, shall that
// entry be either term name itself or one of its synonyms.
$suggest_only_unique = $instance['widget']['settings']['suggest_only_unique'];
// The user enters a comma-separated list of tags. We only autocomplete the
// last tag.
$tags_typed = drupal_explode_tags($tags_typed);
$tag_last = drupal_strtolower(array_pop($tags_typed));
$term_matches = array();
if ($tag_last != '') {
// Part of the criteria for the query come from the field's own settings.
$vocabularies = array();
$tmp = taxonomy_vocabulary_get_names();
foreach ($field['settings']['allowed_values'] as $tree) {
$vocabularies[$tmp[$tree['vocabulary']]->vid] = $tree['vocabulary'];
}
$vocabularies = taxonomy_vocabulary_load_multiple(array_keys($vocabularies));
// Array of found suggestions. Each subarray of this array will represent
// a single suggestion entry. The sub array must at least contain the
// following keys:
// tid - tid of the suggested term
// name - name of the suggested term
// And optionally, if the term is suggested based on its synonym, the sub
// array should also include the additional key:
// synonym - string representation of the synonym based on which the
// suggested term was included.
$tags_return = array();
// Firstly getting a list of tids that match by $term->name.
$query = db_select('taxonomy_term_data', 't');
$query->addTag('translatable');
$query->addTag('term_access');
// Do not select already entered terms.
if (!empty($tags_typed)) {
$query->condition('t.name', $tags_typed, 'NOT IN');
}
// Select rows that match by term name.
$result = $query
->fields('t', array('tid', 'name'))
->condition('t.vid', array_keys($vocabularies))
->condition('t.name', '%' . db_like($tag_last) . '%', 'LIKE')
->range(0, $max_suggestions)
->execute()
->fetchAllKeyed();
// Converting results into another format.
foreach ($result as $tid => $name) {
$tags_return[] = array(
'name' => $name,
'tid' => $tid,
);
}
$synonym_tids = array();
// Now we go vocabulary by vocabulary looking through synonym fields.
foreach ($vocabularies as $vocabulary) {
// Now we go a synonym field by synonym field gathering suggestions.
// Since officially EntityFieldQuery doesn't support OR conditions
// we are enforced to go a field by field querying multiple times the DB.
$bundle = field_extract_bundle('taxonomy_term', $vocabulary);
foreach (synonyms_synonyms_fields($vocabulary) as $field) {
$field = field_info_field($field);
$instance = field_info_instance('taxonomy_term', $field['field_name'], $bundle);
$query = new EntityFieldQuery();
$query->entityCondition('entity_type', 'taxonomy_term')
->entityCondition('bundle', $bundle);
// We let the class that defines this field type as a source of synonyms
// filter out and provide its suggestions based on this field.
$class = synonyms_extractor_info($field['type']);
call_user_func(array($class, 'processEntityFieldQuery'), $tag_last, $query, $field, $instance);
if (!empty($tags_typed)) {
$query->propertyCondition('name', $tags_typed, 'NOT IN');
}
if ($suggest_only_unique && !empty($tags_return)) {
$tmp = array();
foreach ($tags_return as $tag_return) {
$tmp[] = $tag_return['tid'];
}
// We don't want to search among the terms already found by term name.
$query->entityCondition('entity_id', $tmp, 'NOT IN');
}
if ($suggest_only_unique && !empty($synonym_tids)) {
// We also don't want to search among the terms already matched by
// previous synonym fields.
$query->entityCondition('entity_id', $synonym_tids, 'NOT IN');
}
$tmp = $query->execute();
if (!empty($tmp)) {
// Merging the results.
$tmp = array_keys($tmp['taxonomy_term']);
$synonym_tids = array_merge($synonym_tids, $tmp);
}
}
}
if (!empty($synonym_tids)) {
foreach (taxonomy_term_load_multiple($synonym_tids) as $synonym_term) {
$tmp = array(
'name' => $synonym_term->name,
'tid' => $synonym_term->tid,
);
// Additionally we have to find out which synonym triggered inclusion of
// this term.
foreach (synonyms_get_sanitized($synonym_term) as $item) {
if (strpos(mb_strtoupper($item, 'UTF-8'), mb_strtoupper($tag_last, 'UTF-8')) !== FALSE) {
$tags_return[] = array('synonym' => $item) + $tmp;
if ($suggest_only_unique) {
// We just want to output 1 single suggestion entry per term, so
// one synonym is enough.
break;
}
}
}
}
}
$prefix = empty($tags_typed) ? '' : drupal_implode_tags($tags_typed) . ', ';
if (count($tags_return) > $max_suggestions) {
$tags_return = array_slice($tags_return, 0, $max_suggestions);
}
// Now formatting the results.
foreach ($tags_return as $info) {
$n = $info['name'];
// Term names containing commas or quotes must be wrapped in quotes.
if (strpos($info['name'], ',') !== FALSE || strpos($info['name'], '"') !== FALSE) {
$n = '"' . str_replace('"', '""', $info['name']) . '"';
}
if (isset($info['synonym'])) {
$display_name = t('@synonym, synonym of %term', array('@synonym' => $info['synonym'], '%term' => $info['name']));
}
else {
$display_name = check_plain($info['name']);
}
while (isset($term_matches[$prefix . $n])) {
$n .= ' ';
}
$term_matches[$prefix . $n] = $display_name;
}
}
drupal_json_output($term_matches);
}
/**
* Mark nodes that reference specific terms for search re-indexing.
*
* This is particularly useful, when the terms in question have been changed.
*
* @param $tids array
* Array of tids of the terms
*/
function synonyms_reindex_nodes_by_terms($tids) {
// In order to speed up the process, we will query DB for nid's that reference
// handled to us tids, and at the end we'll trigger their re-indexing in just
// a single SQL query. Probably it is better to use search_touch_node(), but
// that would imply a big amount of SQL queries on some websites.
$found_nids = array();
foreach (field_info_field_map() as $field_name => $v) {
if ($v['type'] == 'taxonomy_term_reference' && isset($v['bundles']['node'])) {
// This field is taxonomy term reference and it is attached to nodes, so
// we will run EntityFieldQuery on it.
$query = new EntityFieldQuery();
$result = $query->entityCondition('entity_type', 'node')
->fieldCondition($field_name, 'tid', $tids, 'IN')
->execute();
if (isset($result['node'])) {
$found_nids = array_merge($found_nids, array_keys($result['node']));
}
}
}
if (!empty($found_nids)) {
db_update('search_dataset')
->fields(array('reindex' => REQUEST_TIME))
->condition('type', 'node')
->condition('sid', $found_nids, 'IN')
->execute();
}
}
/**
* Mark nodes that reference terms from a vocabulary for search re-indexing.
*
* @param $vocabulary object
* Fully loaded vocabulary object
*/
function synonyms_reindex_nodes_by_vocabulary($vocabulary) {
$tids = db_select('taxonomy_term_data', 't')
->fields('t', array('tid'))
->condition('vid', $vocabulary->vid)
->execute()
->fetchCol();
if (!empty($tids)) {
synonyms_reindex_nodes_by_terms($tids);
}
}
/**
* Submit handler for Taxonomy vocabulary edit form.
*
* Store extra values attached to form in this module.
*/
function synonyms_taxonomy_form_vocabulary_submit($form, &$form_state) {
$values = $form_state['values'];
if ($values['op'] == $form['actions']['submit']['#value']) {
if (isset($form['#vocabulary']->vid)) {
$vocabulary = taxonomy_vocabulary_load($form['#vocabulary']->vid);
}
else {
// As a fallback, if this is a just created vocabulary, we try to pull it
// up by the just submitted machine name.
$vocabulary = taxonomy_vocabulary_machine_name_load($values['machine_name']);
}
// Preprocessing values keeping only field names of the checked fields.
$values['synonyms']['synonyms'] = array_values(array_filter($values['synonyms']['synonyms']));
$settings = synonyms_vocabulary_settings($vocabulary);
$settings = $values['synonyms'] + $settings;
synonyms_vocabulary_settings_save($vocabulary, $settings);
}
}

View File

@@ -0,0 +1,17 @@
<?php
/**
* @file
* Views integration of Synonyms module.
*/
/**
* Implements hook_views_plugins_alter().
*
* @see hook_views_plugins_alter()
*/
function synonyms_views_plugins_alter(&$plugins) {
// Replace default taxonomy term argument validator with our extended version,
// which can also handle a term synonym as an argument.
$plugins['argument validator']['taxonomy_term']['handler'] = 'synonyms_views_plugin_argument_validate_taxonomy_term';
}

View File

@@ -0,0 +1,163 @@
<?php
/**
* @file
* An extended version of the 'taxonomy term' argument validator plugin, which
* supports synonyms as arguments.
*/
/**
* Validate whether an argument is an acceptable taxonomy term.
*/
class synonyms_views_plugin_argument_validate_taxonomy_term extends views_plugin_argument_validate_taxonomy_term {
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
// We just want to add yet another way of validation - synonyms friendly
// validation.
$form['type']['#options']['synonym'] = t('Term name or synonym');
$form['type']['#options']['synonym_tid'] = t('Term name or synonym converted to Term ID');
}
function validate_argument($argument) {
$vocabularies = array_filter($this->options['vocabularies']);
$type = $this->options['type'];
$transform = $this->options['transform'];
switch ($type) {
case 'synonym':
case 'synonym_tid':
// We are requested to do synonyms friendly validation. We will have to
// go through each of allowed vocabularies, collecting terms whose
// synonyms might look like the argument we have. However, it is not
// that easy to achieve due to the fact that synonyms may be kept in
// whatever format in whatever column and only corresponding Synonyms
// extractor class has the knowledge how it is organized. Firstly we are
// going to query database trying to find a term with our argument's
// name. If we find one, it is great and we stop right there. Otherwise,
// the nightmare starts: we are going to use
// AbstractSynonymsExtractor::processEntityFieldQuery() method to find
// synonyms that are similar to our argument. Then we will load those
// terms and manually in PHP will determine whether it is a match.
$query = db_select('taxonomy_term_data', 't')
->fields('t', array('tid', 'name'));
if (!empty($vocabularies)) {
$query->innerJoin('taxonomy_vocabulary', 'v', 't.vid = v.vid');
$query->condition('v.machine_name', $vocabularies);
}
if ($transform) {
$query->where("replace(t.name, ' ', '-') = :name", array(':name' => $argument));
}
else {
$query->condition('t.name', $argument, '=');
}
$result = $query->range(0, 1)
->execute();
if ($result->rowCount()) {
// We have found a term, we are going to use it.
$term = taxonomy_term_load($result->fetchField(0));
$this->argument->argument = $this->synonyms_get_term_property($term);
$this->argument->validated_title = check_plain(entity_label('taxonomy_term', $term));
return TRUE;
}
if (empty($vocabularies)) {
// At this point we want to convert an empty $vocabulary (implicitly
// meaning "all") into actually a list of all fully loaded
// vocabularies.
$vocabularies = taxonomy_vocabulary_load_multiple(FALSE);
}
else {
// We need to load the filtered vocabularies based on their machine
// names.
foreach ($vocabularies as $v) {
$vocabularies[$v] = taxonomy_vocabulary_machine_name_load($v);
}
}
// We haven't had much luck, seems like we have to do the hard part. We
// will pull up terms that are similar to our argument using the same
// functionality as for synonyms friendly autocomplete widget and then
// will find those who actually match among this narrowed set of terms.
// Since $match will be use as value for LIKE SQL operator, we are not
// sure whether we need to substitute dash (-) with spacebar, or keep
// the dash, to match both we will use underscore (_) since this symbol
// matches one symbol in LIKE operator.
$match = $transform ? str_replace('-', '_', $argument) : $argument;
$tids = array();
// Unfortunately we have to query multiple times the database for each
// vocabulary for each synonyms-source field.
foreach ($vocabularies as $vocabulary) {
$bundle = field_extract_bundle('taxonomy_term', $vocabulary);
foreach (synonyms_synonyms_fields($vocabulary) as $field) {
$field = field_info_field($field);
$instance = field_info_instance('taxonomy_term', $field['field_name'], $bundle);
$query = new EntityFieldQuery();
$query->entityCondition('entity_type', 'taxonomy_term')
->entityCondition('bundle', $vocabulary->machine_name);
// We let the class that defines this field type as a source of
// synonyms filter out and provide its suggestions based on this
// field.
$class = synonyms_extractor_info($field['type']);
call_user_func(array($class, 'processEntityFieldQuery'), $match, $query, $field, $instance);
if (!empty($tids)) {
$query->entityCondition('entity_id', $tids, 'NOT IN');
}
$result = $query->execute();
if (isset($result['taxonomy_term'])) {
$tids = array_merge($tids, array_keys($result['taxonomy_term']));
}
}
}
$terms = taxonomy_term_load_multiple($tids);
// We have an array of terms whose synonyms look like they could be
// equal to our argument, let us iterate over each term's synonyms to
// actually see if they match.
$argument = mb_strtoupper($argument, 'UTF-8');
foreach ($terms as $term) {
foreach (synonyms_get_term_synonyms($term) as $synonym) {
$synonym = mb_strtoupper($synonym['safe_value'], 'UTF-8');
if ($transform) {
$synonym = str_replace(' ', '-', $synonym);
}
if ($synonym == $argument) {
// Finally we found a synonym that matches our argument. We are
// going to use the corresponding term and there is no point to
// continue searching.
$this->argument->argument = $this->synonyms_get_term_property($term);
$this->argument->validated_title = check_plain(entity_label('taxonomy_term', $term));
return TRUE;
}
}
}
// We haven't found any synonym that matched our argument, so there is
// no term to return.
return FALSE;
default:
return parent::validate_argument($argument);
}
}
/**
* Return necessary property (per chosen validator) of encountered term.
*
* @param $term object
* Fully loaded taxonomy term from which necessary property should be
* returned
*
* @return mixed
* Necessary property (per chosen validator) of the provided term
*/
function synonyms_get_term_property($term) {
switch ($this->options['type']) {
case 'synonym':
return $term->name;
case 'synonym_tid':
return $term->tid;
}
return NULL;
}
}