danielebarchiesi@0: array( danielebarchiesi@0: 'id' => array( danielebarchiesi@0: 'type' => 'serial', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'description' => 'The primary identifier for a field', danielebarchiesi@0: ), danielebarchiesi@0: 'field_name' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 32, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'description' => 'The name of this field. Non-deleted field names are unique, but multiple deleted fields can have the same name.', danielebarchiesi@0: ), danielebarchiesi@0: 'type' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 128, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'description' => 'The type of this field.', danielebarchiesi@0: ), danielebarchiesi@0: 'module' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 128, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => '', danielebarchiesi@0: 'description' => 'The module that implements the field type.', danielebarchiesi@0: ), danielebarchiesi@0: 'active' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'size' => 'tiny', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => 0, danielebarchiesi@0: 'description' => 'Boolean indicating whether the module that implements the field type is enabled.', danielebarchiesi@0: ), danielebarchiesi@0: 'storage_type' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 128, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'description' => 'The storage backend for the field.', danielebarchiesi@0: ), danielebarchiesi@0: 'storage_module' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 128, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => '', danielebarchiesi@0: 'description' => 'The module that implements the storage backend.', danielebarchiesi@0: ), danielebarchiesi@0: 'storage_active' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'size' => 'tiny', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => 0, danielebarchiesi@0: 'description' => 'Boolean indicating whether the module that implements the storage backend is enabled.', danielebarchiesi@0: ), danielebarchiesi@0: 'locked' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'size' => 'tiny', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => 0, danielebarchiesi@0: 'description' => '@TODO', danielebarchiesi@0: ), danielebarchiesi@0: 'data' => array( danielebarchiesi@0: 'type' => 'blob', danielebarchiesi@0: 'size' => 'big', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'serialize' => TRUE, danielebarchiesi@0: 'description' => 'Serialized data containing the field properties that do not warrant a dedicated column.', danielebarchiesi@0: ), danielebarchiesi@0: 'cardinality' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'size' => 'tiny', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => 0, danielebarchiesi@0: ), danielebarchiesi@0: 'translatable' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'size' => 'tiny', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => 0, danielebarchiesi@0: ), danielebarchiesi@0: 'deleted' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'size' => 'tiny', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => 0, danielebarchiesi@0: ), danielebarchiesi@0: ), danielebarchiesi@0: 'primary key' => array('id'), danielebarchiesi@0: 'indexes' => array( danielebarchiesi@0: 'field_name' => array('field_name'), danielebarchiesi@0: // Used by field_sync_field_status(). danielebarchiesi@0: 'active' => array('active'), danielebarchiesi@0: 'storage_active' => array('storage_active'), danielebarchiesi@0: 'deleted' => array('deleted'), danielebarchiesi@0: // Used by field_modules_disabled(). danielebarchiesi@0: 'module' => array('module'), danielebarchiesi@0: 'storage_module' => array('storage_module'), danielebarchiesi@0: 'type' => array('type'), danielebarchiesi@0: 'storage_type' => array('storage_type'), danielebarchiesi@0: ), danielebarchiesi@0: ); danielebarchiesi@0: $schema['field_config_instance'] = array( danielebarchiesi@0: 'fields' => array( danielebarchiesi@0: 'id' => array( danielebarchiesi@0: 'type' => 'serial', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'description' => 'The primary identifier for a field instance', danielebarchiesi@0: ), danielebarchiesi@0: 'field_id' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'description' => 'The identifier of the field attached by this instance', danielebarchiesi@0: ), danielebarchiesi@0: 'field_name' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 32, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => '' danielebarchiesi@0: ), danielebarchiesi@0: 'entity_type' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 32, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => '' danielebarchiesi@0: ), danielebarchiesi@0: 'bundle' => array( danielebarchiesi@0: 'type' => 'varchar', danielebarchiesi@0: 'length' => 128, danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => '' danielebarchiesi@0: ), danielebarchiesi@0: 'data' => array( danielebarchiesi@0: 'type' => 'blob', danielebarchiesi@0: 'size' => 'big', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'serialize' => TRUE, danielebarchiesi@0: ), danielebarchiesi@0: 'deleted' => array( danielebarchiesi@0: 'type' => 'int', danielebarchiesi@0: 'size' => 'tiny', danielebarchiesi@0: 'not null' => TRUE, danielebarchiesi@0: 'default' => 0, danielebarchiesi@0: ), danielebarchiesi@0: ), danielebarchiesi@0: 'primary key' => array('id'), danielebarchiesi@0: 'indexes' => array( danielebarchiesi@0: // Used by field_delete_instance(). danielebarchiesi@0: 'field_name_bundle' => array('field_name', 'entity_type', 'bundle'), danielebarchiesi@0: // Used by field_read_instances(). danielebarchiesi@0: 'deleted' => array('deleted'), danielebarchiesi@0: ), danielebarchiesi@0: ); danielebarchiesi@0: $schema['cache_field'] = drupal_get_schema_unprocessed('system', 'cache'); danielebarchiesi@0: danielebarchiesi@0: return $schema; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Utility function: create a field by writing directly to the database. danielebarchiesi@0: * danielebarchiesi@0: * This function can be used for databases whose schema is at field module danielebarchiesi@0: * version 7000 or higher. danielebarchiesi@0: * danielebarchiesi@0: * @ingroup update_api danielebarchiesi@0: */ danielebarchiesi@0: function _update_7000_field_create_field(&$field) { danielebarchiesi@0: // Merge in default values.` danielebarchiesi@0: $field += array( danielebarchiesi@0: 'entity_types' => array(), danielebarchiesi@0: 'cardinality' => 1, danielebarchiesi@0: 'translatable' => FALSE, danielebarchiesi@0: 'locked' => FALSE, danielebarchiesi@0: 'settings' => array(), danielebarchiesi@0: 'indexes' => array(), danielebarchiesi@0: 'deleted' => 0, danielebarchiesi@0: 'active' => 1, danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: // Set storage. danielebarchiesi@0: $field['storage'] = array( danielebarchiesi@0: 'type' => 'field_sql_storage', danielebarchiesi@0: 'settings' => array(), danielebarchiesi@0: 'module' => 'field_sql_storage', danielebarchiesi@0: 'active' => 1, danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: // Fetch the field schema to initialize columns and indexes. The field module danielebarchiesi@0: // is not guaranteed to be loaded at this point. danielebarchiesi@0: module_load_install($field['module']); danielebarchiesi@0: $schema = (array) module_invoke($field['module'], 'field_schema', $field); danielebarchiesi@0: $schema += array('columns' => array(), 'indexes' => array()); danielebarchiesi@0: // 'columns' are hardcoded in the field type. danielebarchiesi@0: $field['columns'] = $schema['columns']; danielebarchiesi@0: // 'indexes' can be both hardcoded in the field type, and specified in the danielebarchiesi@0: // incoming $field definition. danielebarchiesi@0: $field['indexes'] += $schema['indexes']; danielebarchiesi@0: danielebarchiesi@0: // The serialized 'data' column contains everything from $field that does not danielebarchiesi@0: // have its own column and is not automatically populated when the field is danielebarchiesi@0: // read. danielebarchiesi@0: $data = $field; danielebarchiesi@0: unset($data['columns'], $data['field_name'], $data['type'], $data['active'], $data['module'], $data['storage_type'], $data['storage_active'], $data['storage_module'], $data['locked'], $data['cardinality'], $data['deleted']); danielebarchiesi@0: // Additionally, do not save the 'bundles' property populated by danielebarchiesi@0: // field_info_field(). danielebarchiesi@0: unset($data['bundles']); danielebarchiesi@0: danielebarchiesi@0: // Write the field to the database. danielebarchiesi@0: $record = array( danielebarchiesi@0: 'field_name' => $field['field_name'], danielebarchiesi@0: 'type' => $field['type'], danielebarchiesi@0: 'module' => $field['module'], danielebarchiesi@0: 'active' => (int) $field['active'], danielebarchiesi@0: 'storage_type' => $field['storage']['type'], danielebarchiesi@0: 'storage_module' => $field['storage']['module'], danielebarchiesi@0: 'storage_active' => (int) $field['storage']['active'], danielebarchiesi@0: 'locked' => (int) $field['locked'], danielebarchiesi@0: 'data' => serialize($data), danielebarchiesi@0: 'cardinality' => $field['cardinality'], danielebarchiesi@0: 'translatable' => (int) $field['translatable'], danielebarchiesi@0: 'deleted' => (int) $field['deleted'], danielebarchiesi@0: ); danielebarchiesi@0: // We don't use drupal_write_record() here because it depends on the schema. danielebarchiesi@0: $field['id'] = db_insert('field_config') danielebarchiesi@0: ->fields($record) danielebarchiesi@0: ->execute(); danielebarchiesi@0: danielebarchiesi@0: // Create storage for the field. danielebarchiesi@0: field_sql_storage_field_storage_create_field($field); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Utility function: delete a field stored in SQL storage directly from the database. danielebarchiesi@0: * danielebarchiesi@0: * To protect user data, this function can only be used to delete fields once danielebarchiesi@0: * all information it stored is gone. Delete all data from the danielebarchiesi@0: * field_data_$field_name table before calling by either manually issuing danielebarchiesi@0: * delete queries against it or using _update_7000_field_delete_instance(). danielebarchiesi@0: * danielebarchiesi@0: * This function can be used for databases whose schema is at field module danielebarchiesi@0: * version 7000 or higher. danielebarchiesi@0: * danielebarchiesi@0: * @param $field_name danielebarchiesi@0: * The field name to delete. danielebarchiesi@0: * danielebarchiesi@0: * @ingroup update_api danielebarchiesi@0: */ danielebarchiesi@0: function _update_7000_field_delete_field($field_name) { danielebarchiesi@0: $table_name = 'field_data_' . $field_name; danielebarchiesi@0: if (db_select($table_name)->range(0, 1)->countQuery()->execute()->fetchField()) { danielebarchiesi@0: $t = get_t(); danielebarchiesi@0: throw new Exception($t('This function can only be used to delete fields without data')); danielebarchiesi@0: } danielebarchiesi@0: // Delete all instances. danielebarchiesi@0: db_delete('field_config_instance') danielebarchiesi@0: ->condition('field_name', $field_name) danielebarchiesi@0: ->execute(); danielebarchiesi@0: danielebarchiesi@0: // Nuke field data and revision tables. danielebarchiesi@0: db_drop_table($table_name); danielebarchiesi@0: db_drop_table('field_revision_' . $field_name); danielebarchiesi@0: danielebarchiesi@0: // Delete the field. danielebarchiesi@0: db_delete('field_config') danielebarchiesi@0: ->condition('field_name', $field_name) danielebarchiesi@0: ->execute(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Utility function: delete an instance and all its data of a field stored in SQL Storage. danielebarchiesi@0: * danielebarchiesi@0: * BEWARE: this function deletes user data from the field storage tables. danielebarchiesi@0: * danielebarchiesi@0: * This function is valid for a database schema version 7000. danielebarchiesi@0: * danielebarchiesi@0: * @ingroup update_api danielebarchiesi@0: */ danielebarchiesi@0: function _update_7000_field_delete_instance($field_name, $entity_type, $bundle) { danielebarchiesi@0: // Delete field instance configuration data. danielebarchiesi@0: db_delete('field_config_instance') danielebarchiesi@0: ->condition('field_name', $field_name) danielebarchiesi@0: ->condition('entity_type', $entity_type) danielebarchiesi@0: ->condition('bundle', $bundle) danielebarchiesi@0: ->execute(); danielebarchiesi@0: danielebarchiesi@0: // Nuke data. danielebarchiesi@0: db_delete('field_data_' . $field_name) danielebarchiesi@0: ->condition('entity_type', $entity_type) danielebarchiesi@0: ->condition('bundle', $bundle) danielebarchiesi@0: ->execute(); danielebarchiesi@0: db_delete('field_revision_' . $field_name) danielebarchiesi@0: ->condition('entity_type', $entity_type) danielebarchiesi@0: ->condition('bundle', $bundle) danielebarchiesi@0: ->execute(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Utility function: fetch all the field definitions from the database. danielebarchiesi@0: * danielebarchiesi@0: * Warning: unlike the field_read_fields() API function, this function returns danielebarchiesi@0: * all fields by default, including deleted and inactive fields, unless danielebarchiesi@0: * specified otherwise in the $conditions parameter. danielebarchiesi@0: * danielebarchiesi@0: * @param $conditions danielebarchiesi@0: * An array of conditions to limit the select query to. danielebarchiesi@0: * @param $key danielebarchiesi@0: * The name of the field property the return array is indexed by. Using danielebarchiesi@0: * anything else than 'id' might cause incomplete results if the $conditions danielebarchiesi@0: * do not filter out deleted fields. danielebarchiesi@0: * danielebarchiesi@0: * @return danielebarchiesi@0: * An array of fields matching $conditions, keyed by the property specified danielebarchiesi@0: * by the $key parameter. danielebarchiesi@0: * danielebarchiesi@0: * @ingroup update_api danielebarchiesi@0: */ danielebarchiesi@0: function _update_7000_field_read_fields(array $conditions = array(), $key = 'id') { danielebarchiesi@0: $fields = array(); danielebarchiesi@0: $query = db_select('field_config', 'fc', array('fetch' => PDO::FETCH_ASSOC)) danielebarchiesi@0: ->fields('fc'); danielebarchiesi@0: foreach ($conditions as $column => $value) { danielebarchiesi@0: $query->condition($column, $value); danielebarchiesi@0: } danielebarchiesi@0: foreach ($query->execute() as $record) { danielebarchiesi@0: $field = unserialize($record['data']); danielebarchiesi@0: $field['id'] = $record['id']; danielebarchiesi@0: $field['field_name'] = $record['field_name']; danielebarchiesi@0: $field['type'] = $record['type']; danielebarchiesi@0: $field['module'] = $record['module']; danielebarchiesi@0: $field['active'] = $record['active']; danielebarchiesi@0: $field['storage']['type'] = $record['storage_type']; danielebarchiesi@0: $field['storage']['module'] = $record['storage_module']; danielebarchiesi@0: $field['storage']['active'] = $record['storage_active']; danielebarchiesi@0: $field['locked'] = $record['locked']; danielebarchiesi@0: $field['cardinality'] = $record['cardinality']; danielebarchiesi@0: $field['translatable'] = $record['translatable']; danielebarchiesi@0: $field['deleted'] = $record['deleted']; danielebarchiesi@0: danielebarchiesi@0: $fields[$field[$key]] = $field; danielebarchiesi@0: } danielebarchiesi@0: return $fields; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Utility function: write a field instance directly to the database. danielebarchiesi@0: * danielebarchiesi@0: * This function can be used for databases whose schema is at field module danielebarchiesi@0: * version 7000 or higher. danielebarchiesi@0: * danielebarchiesi@0: * @ingroup update_api danielebarchiesi@0: */ danielebarchiesi@0: function _update_7000_field_create_instance($field, &$instance) { danielebarchiesi@0: // Merge in defaults. danielebarchiesi@0: $instance += array( danielebarchiesi@0: 'field_id' => $field['id'], danielebarchiesi@0: 'field_name' => $field['field_name'], danielebarchiesi@0: 'deleted' => 0, danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: // The serialized 'data' column contains everything from $instance that does danielebarchiesi@0: // not have its own column and is not automatically populated when the danielebarchiesi@0: // instance is read. danielebarchiesi@0: $data = $instance; danielebarchiesi@0: unset($data['id'], $data['field_id'], $data['field_name'], $data['entity_type'], $data['bundle'], $data['deleted']); danielebarchiesi@0: danielebarchiesi@0: $record = array( danielebarchiesi@0: 'field_id' => $instance['field_id'], danielebarchiesi@0: 'field_name' => $instance['field_name'], danielebarchiesi@0: 'entity_type' => $instance['entity_type'], danielebarchiesi@0: 'bundle' => $instance['bundle'], danielebarchiesi@0: 'data' => serialize($data), danielebarchiesi@0: 'deleted' => (int) $instance['deleted'], danielebarchiesi@0: ); danielebarchiesi@0: $instance['id'] = db_insert('field_config_instance') danielebarchiesi@0: ->fields($record) danielebarchiesi@0: ->execute(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * @addtogroup updates-6.x-to-7.x danielebarchiesi@0: * @{ danielebarchiesi@0: */ danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Field update version placeholder. danielebarchiesi@0: */ danielebarchiesi@0: function field_update_7000() { danielebarchiesi@0: // Some update helper functions (such as _update_7000_field_create_field()) danielebarchiesi@0: // modify the database directly. They can be used safely only if the database danielebarchiesi@0: // schema matches the field module schema established for Drupal 7.0 (i.e. danielebarchiesi@0: // version 7000). This function exists solely to set the schema version to danielebarchiesi@0: // 7000, so that update functions calling those helpers can do so safely danielebarchiesi@0: // by declaring a dependency on field_update_7000(). danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Fix fields definitions created during the d6 to d7 upgrade path. danielebarchiesi@0: */ danielebarchiesi@0: function field_update_7001() { danielebarchiesi@0: $fields = _update_7000_field_read_fields(); danielebarchiesi@0: foreach ($fields as $field) { danielebarchiesi@0: // _update_7000_field_create_field() was broken in d7 RC2, and the fields danielebarchiesi@0: // created during a d6 to d7 upgrade do not correcly store the 'index' danielebarchiesi@0: // entry. See http://drupal.org/node/996160. danielebarchiesi@0: danielebarchiesi@0: module_load_install($field['module']); danielebarchiesi@0: $schema = (array) module_invoke($field['module'], 'field_schema', $field); danielebarchiesi@0: $schema += array('indexes' => array()); danielebarchiesi@0: // 'indexes' can be both hardcoded in the field type, and specified in the danielebarchiesi@0: // incoming $field definition. danielebarchiesi@0: $field['indexes'] += $schema['indexes']; danielebarchiesi@0: danielebarchiesi@0: // Place the updated entries in the existing serialized 'data' column. danielebarchiesi@0: $data = db_query("SELECT data FROM {field_config} WHERE id = :id", array(':id' => $field['id']))->fetchField(); danielebarchiesi@0: $data = unserialize($data); danielebarchiesi@0: $data['columns'] = $field['columns']; danielebarchiesi@0: $data['indexes'] = $field['indexes']; danielebarchiesi@0: danielebarchiesi@0: // Save the new data. danielebarchiesi@0: $query = db_update('field_config') danielebarchiesi@0: ->condition('id', $field['id']) danielebarchiesi@0: ->fields(array('data' => serialize($data))) danielebarchiesi@0: ->execute(); danielebarchiesi@0: } danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * @} End of "addtogroup updates-6.x-to-7.x". danielebarchiesi@0: */ danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * @addtogroup updates-7.x-extra danielebarchiesi@0: * @{ danielebarchiesi@0: */ danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Split the all-inclusive field_bundle_settings variable per bundle. danielebarchiesi@0: */ danielebarchiesi@0: function field_update_7002() { danielebarchiesi@0: $settings = variable_get('field_bundle_settings', array()); danielebarchiesi@0: if ($settings) { danielebarchiesi@0: foreach ($settings as $entity_type => $entity_type_settings) { danielebarchiesi@0: foreach ($entity_type_settings as $bundle => $bundle_settings) { danielebarchiesi@0: variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $bundle_settings); danielebarchiesi@0: } danielebarchiesi@0: } danielebarchiesi@0: variable_del('field_bundle_settings'); danielebarchiesi@0: } danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Add the FieldInfo class to the class registry. danielebarchiesi@0: */ danielebarchiesi@0: function field_update_7003() { danielebarchiesi@0: // Empty update to force a rebuild of the registry. danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * @} End of "addtogroup updates-7.x-extra". danielebarchiesi@0: */