field.module 14.7 KB
Newer Older
1 2 3
<?php
/**
 * @file
4
 * Attach custom data fields to Drupal entities.
5 6
 */

7
use Drupal\Component\Utility\Html;
8
use Drupal\Component\Utility\SafeMarkup;
9
use Drupal\Component\Utility\Xss;
10
use Drupal\Core\Config\ConfigImporter;
11
use Drupal\Core\Entity\EntityTypeInterface;
12
use Drupal\Core\Extension\Extension;
13
use Drupal\Core\Routing\RouteMatchInterface;
14

15
/*
16 17 18
 * Load all public Field API functions. Drupal currently has no
 * mechanism for auto-loading core APIs, so we have to load them on
 * every page request.
19
 */
20
require_once __DIR__ . '/field.purge.inc';
21

22 23 24
/**
 * @defgroup field Field API
 * @{
25 26 27 28 29 30 31 32
 * Attaches custom data fields to Drupal entities.
 *
 * The Field API allows custom data fields to be attached to Drupal entities and
 * takes care of storing, loading, editing, and rendering field data. Any entity
 * type (node, user, etc.) can use the Field API to make itself "fieldable" and
 * thus allow fields to be attached to it. Other modules can provide a user
 * interface for managing custom fields via a web browser as well as a wide and
 * flexible variety of data type, form element, and display format capabilities.
33
 *
34 35 36 37 38 39 40 41 42 43 44 45
 * The Field API defines two primary data structures, Field and Instance, and
 * the concept of a Bundle. A Field defines a particular type of data that can
 * be attached to entities. A Field Instance is a Field attached to a single
 * Bundle. A Bundle is a set of fields that are treated as a group by the Field
 * Attach API and is related to a single fieldable entity type.
 *
 * For example, suppose a site administrator wants Article nodes to have a
 * subtitle and photo. Using the Field API or Field UI module, the administrator
 * creates a field named 'subtitle' of type 'text' and a field named 'photo' of
 * type 'image'. The administrator (again, via a UI) creates two Field
 * Instances, one attaching the field 'subtitle' to the 'node' bundle 'article'
 * and one attaching the field 'photo' to the 'node' bundle 'article'. When the
46
 * node storage loads an Article node, it loads the values of the
47 48
 * 'subtitle' and 'photo' fields because they are both attached to the 'node'
 * bundle 'article'.
49
 *
50 51 52 53 54 55
 * - @link field_types Field Types API @endlink: Defines field types, widget
 *   types, and display formatters. Field modules use this API to provide field
 *   types like Text and Node Reference along with the associated form elements
 *   and display formatters.
 *
 * - @link field_purge Field API bulk data deletion @endlink: Cleans up after
56
 *   bulk deletion operations such as deletion of field or field_instance.
57 58 59
 */

/**
60
 * Implements hook_help().
61
 */
62
function field_help($route_name, RouteMatchInterface $route_match) {
63 64
  switch ($route_name) {
    case 'help.page.field':
65 66
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
67
      $output .= '<p>' . t('The Field module allows custom data fields to be defined for <a href="!entity-help"><em>entity</em></a> types (entities include content items, comments, user accounts, and taxonomy terms). The Field module takes care of storing, loading, editing, and rendering field data. Most users will not interact with the Field module directly, but will instead use the <a href="!field-ui-help">Field UI module</a> user interface. Module developers can use the Field API to make new entity types "fieldable" and thus allow fields to be attached to them. For more information, see the <a href="!field">online documentation for the Field module</a>.', array('!entity-help' => \Drupal::url('help.page', array('name' => 'entity')), '!field-ui-help' => \Drupal::url('help.page', array('name' => 'field_ui')), '!field' => 'https://drupal.org/documentation/modules/field')) . '</p>';
68 69 70
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
71
      $output .= '<dd>' . t('The Field module provides the infrastructure for fields and field attachment; the field types and input widgets themselves are provided by additional modules. Some of the modules are required; the optional modules can be enabled from the <a href="!modules">Extend administration page</a>. Additional fields and widgets may be provided by contributed modules, which you can find in the <a href="!contrib">contributed module section of Drupal.org</a>.', array('!modules' => \Drupal::url('system.modules_list'), '!contrib' => 'https://drupal.org/project/modules'));
72

73 74
      // Make a list of all widget and field modules currently enabled, ordered
      // by displayed module name (module names are not translated).
75 76
      $items = array();
      $info = system_get_info('module');
77
      $field_widgets = \Drupal::service('plugin.manager.field.widget')->getDefinitions();
78
      $field_types = \Drupal::service('plugin.manager.field.field_type')->getUiDefinitions();
79
      $providers = array();
80 81
      foreach (array_merge($field_types, $field_widgets) as $plugin) {
        $providers[] = $plugin['provider'];
82
      }
83 84 85 86 87 88 89 90 91 92 93 94 95
      $providers = array_unique($providers);
      sort($providers);
      foreach ($providers as $provider) {
        // Skip plugins provided by core components as they do not implement
        // hook_help().
        if (isset($info[$provider]['name'])) {
          $display = $info[$provider]['name'];
          if (\Drupal::moduleHandler()->implementsHook($provider, 'help')) {
            $items[] = l($display, 'admin/help/' . $provider);
          }
          else {
            $items[] = $display;
          }
96 97
        }
      }
98 99 100 101 102 103 104 105
      if ($items) {
        $output .= ' ' . t('Currently enabled field and input widget modules:');
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $items,
        );
        $output .= drupal_render($item_list);
      }
106 107 108 109
      return $output;
  }
}

110
/**
111
 * Implements hook_cron().
112 113
 */
function field_cron() {
114
  // Do a pass of purging on deleted Field API data, if any exists.
115
  $limit = \Drupal::config('field.settings')->get('purge_batch_size');
116 117 118
  field_purge_batch($limit);
}

119
/**
120 121
 * Implements hook_system_info_alter().
 *
122
 * Goes through a list of all modules that provide a field type and makes them
123
 * required if there are any active fields of that type.
124
 */
125
function field_system_info_alter(&$info, Extension $file, $type) {
126 127
  // It is not safe to call entity_load_multiple_by_properties() during
  // maintenance mode.
128
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
129
    $fields = entity_load_multiple_by_properties('field_storage_config', array('module' => $file->getName(), 'include_deleted' => TRUE));
130 131 132 133 134 135 136
    if ($fields) {
      $info['required'] = TRUE;

      // Provide an explanation message (only mention pending deletions if there
      // remains no actual, non-deleted fields)
      $non_deleted = FALSE;
      foreach ($fields as $field) {
137
        if (empty($field->deleted)) {
138 139 140 141 142
          $non_deleted = TRUE;
          break;
        }
      }
      if ($non_deleted) {
143
        if (\Drupal::moduleHandler()->moduleExists('field_ui')) {
144
          $explanation = t('Field type(s) in use - see <a href="@fields-page">Field list</a>', array('@fields-page' => url('admin/reports/fields')));
145 146 147 148 149 150 151 152 153 154
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
155 156 157
  }
}

158 159 160 161 162 163 164 165
/**
 * Implements hook_entity_field_storage_info().
 */
function field_entity_field_storage_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type) {
  // Expose storage definitions for all exposed bundle fields.
  if ($entity_type->isFieldable()) {
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
166
    $ids = \Drupal::entityQuery('field_storage_config')
167 168 169 170
      ->condition('id', $entity_type->id() . '.', 'STARTS_WITH')
      ->execute();

    // Fetch all fields and key them by field name.
171
    $field_storages = entity_load_multiple('field_storage_config', $ids);
172
    $result = array();
173 174
    foreach ($field_storages as $field_storage) {
      $result[$field_storage->getName()] = $field_storage;
175 176 177 178 179
    }
    return $result;
  }
}

180
/**
181
 * Implements hook_entity_bundle_field_info().
182
 */
183 184
function field_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
  if ($entity_type->isFieldable()) {
185 186 187 188 189 190 191 192 193 194 195 196 197
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
    $ids = \Drupal::entityQuery('field_instance_config')
      ->condition('id', $entity_type->id() . '.' . $bundle . '.', 'STARTS_WITH')
      ->execute();

    // Fetch all fields and key them by field name.
    $field_instance_configs = entity_load_multiple('field_instance_config', $ids);
    $result = array();
    foreach ($field_instance_configs as $field_instance) {
      $result[$field_instance->getName()] = $field_instance;
    }
    return $result;
198 199 200
  }
}

201 202 203 204
/**
 * Implements hook_entity_bundle_rename().
 */
function field_entity_bundle_rename($entity_type, $bundle_old, $bundle_new) {
205
  $instances = entity_load_multiple_by_properties('field_instance_config', array('entity_type' => $entity_type, 'bundle' => $bundle_old, 'include_deleted' => TRUE));
206
  foreach ($instances as $instance) {
207 208 209 210 211
    $id_new = $instance->entity_type . '.' . $bundle_new . '.' . $instance->field_name;
    $instance->set('id', $id_new);
    $instance->bundle = $bundle_new;
    // Save non-deleted instances.
    if (!$instance->isDeleted()) {
212 213
      $instance->allowBundleRename();
      $instance->save();
214
    }
215 216 217 218 219 220 221
    // Update deleted instances directly in the state storage.
    else {
      $state = \Drupal::state();
      $deleted_instances = $state->get('field.instance.deleted') ?: array();
      $deleted_instances[$instance->uuid] = $instance->toArray();
      $state->set('field.instance.deleted', $deleted_instances);
    }
222
  }
223 224 225 226 227 228 229 230 231 232 233 234 235
}

/**
 * Implements hook_entity_bundle_delete().
 *
 * This deletes the data for the field instances as well as the field instances
 * themselves. This function actually just marks the data and field instances as
 * deleted, leaving the garbage collection for a separate process, because it is
 * not always possible to delete this much data in a single page request
 * (particularly since for some field types, the deletion is more than just a
 * simple DELETE query).
 */
function field_entity_bundle_delete($entity_type, $bundle) {
236 237 238
  // Get the instances on the bundle. entity_load_multiple_by_properties() must
  // be used here since field_info_instances() does not return instances for
  // disabled entity types or bundles.
239
  $instances = entity_load_multiple_by_properties('field_instance_config', array('entity_type' => $entity_type, 'bundle' => $bundle));
240 241 242
  foreach ($instances as $instance) {
    $instance->delete();
  }
243 244 245
}

/**
246 247
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
248 249
 * Like \Drupal\Component\Utility\Xss::filterAdmin(), but with a shorter list
 * of allowed tags.
250
 *
251 252 253 254 255 256 257 258 259 260
 * Used for items entered by administrators, like field descriptions, allowed
 * values, where some (mainly inline) mark-up may be desired (so
 * drupal_htmlspecialchars() is not acceptable).
 *
 * @param $string
 *   The string with raw HTML in it.
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not valid
 *   UTF-8.
261 262
 */
function field_filter_xss($string) {
263
  return SafeMarkup::set(Html::normalize(Xss::filter($string, _field_filter_xss_allowed_tags())));
264 265 266
}

/**
267
 * Returns a list of tags allowed by field_filter_xss().
268 269 270 271 272 273
 */
function _field_filter_xss_allowed_tags() {
  return array('a', 'b', 'big',  'code', 'del', 'em', 'i', 'ins',  'pre', 'q', 'small', 'span', 'strong', 'sub', 'sup', 'tt', 'ol', 'ul', 'li', 'p', 'br', 'img');
}

/**
274
 * Returns a human-readable list of allowed tags for display in help texts.
275 276 277 278 279 280
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
281
 * @} End of "defgroup field".
282
 */
283

284 285 286
/**
 * Assembles a partial entity structure with initial IDs.
 *
287
 * @param object $ids
288 289 290
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
291
 * @return \Drupal\Core\Entity\EntityInterface
292 293 294 295
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
296 297
  $entity_type = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $entity_type->getKey('id')) {
298
    $id_properties[$id_key] = $ids->entity_id;
299
  }
300
  if (isset($ids->revision_id) && $revision_key = $entity_type->getKey('revision')) {
301
    $id_properties[$revision_key] = $ids->revision_id;
302
  }
303
  if (isset($ids->bundle) && $bundle_key = $entity_type->getKey('bundle')) {
304
    $id_properties[$bundle_key] = $ids->bundle;
305 306
  }
  return entity_create($ids->entity_type, $id_properties);
307 308
}

309 310 311 312 313 314 315 316 317 318 319 320 321
/**
 * Implements hook_hook_info().
 */
function field_hook_info() {
  $hooks['field_views_data'] = array(
    'group' => 'views',
  );
  $hooks['field_views_data_alter'] = array(
    'group' => 'views',
  );

  return $hooks;
}
322 323 324 325 326

/**
 * Implements hook_config_import_steps_alter().
 */
function field_config_import_steps_alter(&$sync_steps, ConfigImporter $config_importer) {
327
  $field_storages = \Drupal\field\ConfigImporterFieldPurger::getFieldStoragesToPurge(
328 329 330
    $config_importer->getStorageComparer()->getSourceStorage()->read('core.extension'),
    $config_importer->getStorageComparer()->getChangelist('delete')
  );
331
  if ($field_storages) {
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
    // Add a step to the beginning of the configuration synchronization process
    // to purge field data where the module that provides the field is being
    // uninstalled.
    array_unshift($sync_steps, array('\Drupal\field\ConfigImporterFieldPurger', 'process'));
  };
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Adds a warning if field data will be permanently removed by the configuration
 * synchronization.
 *
 * @see \Drupal\field\ConfigImporterFieldPurger
 */
function field_form_config_admin_import_form_alter(&$form, &$form_state) {
  // Only display the message when there is a storage comparer available and the
  // form is not submitted.
  if (isset($form_state['storage_comparer']) && empty($form_state['input'])) {
351
    $field_storages = \Drupal\field\ConfigImporterFieldPurger::getFieldStoragesToPurge(
352 353 354
      $form_state['storage_comparer']->getSourceStorage()->read('core.extension'),
      $form_state['storage_comparer']->getChangelist('delete')
    );
355 356
    if ($field_storages) {
      foreach ($field_storages as $field) {
357 358 359
        $field_labels[] = $field->label();
      }
      drupal_set_message(\Drupal::translation()->formatPlural(
360
        count($field_storages),
361 362 363 364 365 366 367
        'This synchronization will delete data from the field %fields.',
        'This synchronization will delete data from the fields: %fields.',
        array('%fields' => implode(', ', $field_labels))
      ), 'warning');
    }
  }
}