updated serial field

This commit is contained in:
Bachir Soussi Chiadmi
2016-11-05 17:58:43 +01:00
parent 252abe9b0e
commit c70a4bed11
6 changed files with 570 additions and 184 deletions

View File

@@ -41,29 +41,31 @@ function _serial_drop_table(array $field, array $instance) {
}
/**
* Renames serial table(s) when a content type us renamed.
* Renames serial table(s) when a entity bundle us renamed.
*
* @param string $old_type
* An old node type machine name.
* @param string $new_type
* A new node type machine name.
* @param string $entity_type
* Type of entity.
* @param string $bundle_old
* An old entity bundle machine name.
* @param string $bundle_new
* A new entity bundle machine name.
*/
function _serial_rename_tables($old_type, $new_type) {
function _serial_rename_tables($entity_type, $bundle_old, $bundle_new) {
// Build the query to find all affected tables.
$query = db_select('field_config', 'f')
->fields('f', array('field_name'));
$query->join(
'field_config_instance',
'i',
"f.field_name = i.field_name AND f.type = 'serial' AND i.bundle = '$new_type'"
);
$query->join('field_config_instance', 'i', '(f.field_name = i.field_name)');
$query->condition('f.type', SERIAL_FIELD_TYPE);
$query->condition('i.entity_type', $entity_type);
$query->condition('i.bundle', $bundle_new);
// Rename each affected table.
foreach ($query->addTag('node_access')->execute() as $record) {
db_rename_table(
_serial_get_table_name($old_type, $record->field_name),
_serial_get_table_name($new_type, $record->field_name)
_serial_get_table_name($entity_type, $bundle_old, $record->field_name),
_serial_get_table_name($entity_type, $bundle_new, $record->field_name)
);
}
}
@@ -80,22 +82,26 @@ function _serial_rename_tables($old_type, $new_type) {
* The name of the assistant table of the specified field instance.
*/
function _serial_get_field_table_name(array $field, array $instance) {
return _serial_get_table_name($instance['bundle'], $field['field_name']);
return _serial_get_table_name($instance['entity_type'], $instance['bundle'], $field['field_name']);
}
/**
* Gets the name of the assistant table for a specific field.
*
* @param string $entity_type
* Type of entity (e.g. node)
* @param string $bundle
* The name of the entity type that contains the field.
* The name of the entity type that contains the field (e.g. content type)
* @param string $field_name
* The name of the field.
*
* @return string
* the name of the assistant table of the specified field.
* The name of the assistant table of the specified field.
*/
function _serial_get_table_name($bundle, $field_name) {
return db_escape_table('serial_' . $bundle . '_' . $field_name);
function _serial_get_table_name($entity_type, $bundle, $field_name) {
// Remember about max length of MySQL tables - 64 symbols.
// @todo Think about improvement for this.
return db_escape_table('serial_' . md5("{$entity_type}_{$bundle}_{$field_name}"));
}
/**
@@ -108,17 +114,18 @@ function _serial_get_table_schema() {
return array(
'fields' => array(
'sid' => array(
'type' => 'serial',
'unsigned' => TRUE,
'type' => SERIAL_FIELD_TYPE,
'not null' => TRUE,
'unsigned' => TRUE,
'description' => 'The atomic serial field.',
),
'uniqid' => array(
'description' => 'Unique temporary allocation Id.',
'type' => 'varchar',
'length' => 23,
'default' => '',
'not null' => TRUE,
'default' => ''),
'description' => 'Unique temporary allocation Id.',
),
),
'primary key' => array('sid'),
'unique keys' => array(
@@ -128,8 +135,10 @@ function _serial_get_table_schema() {
}
/**
* Generates a unique serial value (unique per node type).
* Generates a unique serial value (unique per entity bundle).
*
* @param string $entity_type
* Type of entity (e.g. node)
* @param string $bundle
* Containing bundle (e.g. content type).
* @param string $field_name
@@ -139,76 +148,102 @@ function _serial_get_table_schema() {
*
* @return int
* the unique serial value number.
*
* @throws \Exception
*/
function _serial_generate_value($bundle, $field_name, $delete = TRUE) {
// Get the name of the relevant table.
$table = _serial_get_table_name($bundle, $field_name);
function _serial_generate_value($entity_type, $bundle, $field_name, $delete = TRUE) {
$transaction = db_transaction();
// Insert a temporary record to get a new unique serial value.
$uniqid = uniqid('', TRUE);
$sid = db_insert($table)
->fields(array('uniqid' => $uniqid))
->execute();
// If there's a reason why it's come back undefined, reset it.
$sid = isset($sid) ? $sid : 0;
// Delete the temporary record.
if ($delete && ($sid % 10) == 0) {
db_delete($table)
->condition('uniqid', $uniqid)
try {
// Get the name of the relevant table.
$table = _serial_get_table_name($entity_type, $bundle, $field_name);
// Insert a temporary record to get a new unique serial value.
$uniqid = uniqid('', TRUE);
$sid = db_insert($table)
->fields(array('uniqid' => $uniqid))
->execute();
}
// Return the new unique serial value.
return $sid;
// If there's a reason why it's come back undefined, reset it.
$sid = isset($sid) ? $sid : 0;
// Delete the temporary record.
if ($delete && $sid && ($sid % 10) == 0) {
db_delete($table)
->condition('sid', $sid, '<')
->execute();
}
// Return the new unique serial value.
return $sid;
}
catch (Exception $e) {
$transaction->rollback();
watchdog_exception('serial', $e);
throw $e;
}
}
/**
* Initializes the value of a new serial field in existing nodes.
*
* @todo Currently works only for nodes - should support comments and users.
* Initializes the value of a new serial field in existing entities.
*
* @param string $entity_type
* Type of entity (e.g. node)
* @param string $bundle
* Containing bundle (e.g. content type).
* @param string $field_name
* The field name.
*
* @return int
* Number of existing nodes that have been initialized.
* Number of existing entities that have been initialized.
*/
function _serial_init_old_nodes($bundle, $field_name) {
$nodes = node_load_multiple(array(), array('type' => $bundle));
function _serial_init_old_entities($entity_type, $bundle, $field_name) {
$query = new EntityFieldQuery();
$query->entityCondition('entity_type', $entity_type)
->fieldCondition($field_name);
// Allocate a serial number for every old node.
foreach ($nodes as $node) {
$node->{$field_name} = array(
LANGUAGE_NONE => array(
array(
'value' => _serial_generate_value($bundle, $field_name, FALSE),
),
),
);
node_save($node);
// The "comment" entity type does not support bundle conditions.
// @see https://api.drupal.org/api/drupal/includes!entity.inc/function/EntityFieldQuery%3A%3AentityCondition/7
if ('comment' !== $entity_type) {
$query->entityCondition('bundle', $bundle);
}
// Return the number of existing nodes that have been initialized.
return count($nodes);
$results = $query->execute();
if (!empty($results[$entity_type])) {
foreach ($results[$entity_type] as $entity) {
list($id, , $bundle) = entity_extract_ids($entity_type, $entity);
$entity = entity_load_unchanged($entity_type, $id);
$entity->{$field_name} = array(
LANGUAGE_NONE => array(
array(
'value' => _serial_generate_value($entity_type, $bundle, $field_name, FALSE),
),
),
);
field_attach_insert($entity_type, $entity);
}
return count($results[$entity_type]);
}
return 0;
}
/**
* Retrieves all the managed serial fields.
*
* @return array
* Pairs of node type name, field name.
* @return string[]
* Result set containing entity type, entity bundle, field name.
*/
function _serial_get_all_fields() {
$query = db_select('field_config', 'f');
$query->join('field_config_instance', 'i', 'i.field_name = f.field_name');
return $query->fields('i', array('bundle', 'field_name'))
->condition('f.type', 'serial')
return $query
->fields('i', array('entity_type', 'bundle', 'field_name'))
->condition('f.type', SERIAL_FIELD_TYPE)
->condition('i.deleted', 0)
->execute()
->fetchAll();