diff --git a/modules/mediafield/mediafield.module b/modules/mediafield/mediafield.module index dbd4a28..828afcc 100644 --- a/modules/mediafield/mediafield.module +++ b/modules/mediafield/mediafield.module @@ -329,3 +329,108 @@ function mediafield_views_api() { 'api' => 3, ); } + +/** + * Implements hook_form_FORM_ID_alter() for field_ui_field_overview_form(). + */ +function mediafield_form_field_ui_field_overview_form_alter(&$form, &$form_state) { + $form['fields']['#header'][6]['colspan']++; + + $fields = field_info_fields(); + + foreach ($form['fields'] as $field_name => &$row) { + if ($field_name[0] == '#') { + continue; + } + + if (isset($row['delete']['#href']) && $fields[$field_name]['type'] == 'media') { + $row['mediafield_upgrade'] = array( + '#type' => 'link', + '#title' => t('upgrade'), + '#href' => drupal_substr($row['delete']['#href'], 0, -6) . 'mediafield_upgrade', + '#options' => array( + 'attributes' => array( + 'title' => t('Copy this to a file field.'), + ), + ), + ); + } + elseif (is_array($row)) { + $row['mediafield_upgrade'] = array(); + } + } +} + +/** + * Implements hook_menu(). + * + * @see field_ui_menu() + */ +function mediafield_menu() { + $items = array(); + + foreach (entity_get_info() as $entity_type => $entity_info) { + if ($entity_info['fieldable']) { + foreach ($entity_info['bundles'] as $bundle_name => $bundle_info) { + if (isset($bundle_info['admin'])) { + $access_args = array_intersect_key($bundle_info['admin'], drupal_map_assoc(array('access callback', 'access arguments'))); + $access_args += array( + 'access callback' => 'user_access', + 'access arguments' => array('administer site configuration'), + ); + + $path = $bundle_info['admin']['path']; + + if (isset($bundle_info['admin']['bundle argument'])) { + $bundle_arg = $bundle_info['admin']['bundle argument']; + $bundle_pos = (string) $bundle_arg; + } + else { + $bundle_arg = $bundle_name; + $bundle_pos = '0'; + } + + $field_position = count(explode('/', $path)) + 1; + + $items[$path . '/fields/%field_ui_menu/mediafield_upgrade'] = array( + 'load arguments' => array($entity_type, $bundle_arg, $bundle_pos, '%map'), + 'title' => 'Upgrade', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('mediafield_upgrade_form', $field_position), + 'type' => MENU_LOCAL_TASK, + 'file' => 'mediafield.upgrade.inc', + 'access callback' => 'mediafield_upgrade_access', + 'access arguments' => array($field_position, $access_args), + ); + } + } + } + } + + return $items; +} + +/** + * Access calback: Checks if the user can access the mediafield upgrade form. + * + * This access callback ensures that the upgrade form can only be fisplayed for + * media fields. If a field is a media field, it does the usual access checks. + * + * @param $instance + * The field instance. + * @param $access_args + * An associative array with 'access callback' and 'access arguments' set. + * + * @return + * TRUE, if the user can access the mediafield upgrade form for the given + * field. + */ +function mediafield_upgrade_access($instance, $access_args) { + $field = field_info_field_by_id($instance['field_id']); + if ($field['type'] != 'media') { + return FALSE; + } + + $access_callback = $access_args['access callback']; + return call_user_func_array($access_callback, $access_args['access arguments']); +} diff --git a/modules/mediafield/mediafield.upgrade.inc b/modules/mediafield/mediafield.upgrade.inc new file mode 100644 index 0000000..cf45e09 --- /dev/null +++ b/modules/mediafield/mediafield.upgrade.inc @@ -0,0 +1,260 @@ + 'select', + '#title' => t('Target'), + '#empty_option' => t('- Create a new field -'), + '#options' => _mediafield_upgrade_target_field_options($form_state), + '#description' => t('Only target fields with same or greater cardinality are available. The field can\'t have any data, yet.'), + ); + + $form['field_label'] = array( + '#type' => 'textfield', + '#title' => t('Field label'), + '#description' => t('The user-visible label of the new field that will be created.'), + '#size' => 26, + '#maxlength' => 128, + '#states' => array( + 'visible' => array( + ':input[name=existing_field]' => array('value' => ''), + ), + ), + ); + + $form['field_name'] = array( + '#type' => 'machine_name', + '#title' => t('Field name'), + '#description' => t('The name of the new field, that will be created.') . ' ' . t('A unique machine-readable name containing letters, numbers, and underscores.'), + '#field_prefix' => 'field_', + '#prefix' => '
 
', + '#size' => 26, + '#maxlength' => 26, + '#states' => array( + 'visible' => array( + ':input[name=existing_field]' => array('value' => ''), + ), + ), + '#machine_name' => array( + 'source' => array('field_label'), + 'exists' => '_field_ui_field_name_exists', + 'standalone' => TRUE, + 'label' => '', + ), + '#required' => FALSE, + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Copy field data'), + '#suffix' => t('Be careful. Backup your database. Revisions are not copied.'), + ); + + return $form; +} + +/** + * Creates an associative array of available target file fields. + * + * @param $form_state + * An associative array with 'field_instance' and 'field' set the field API + * structures of the source field. + * + * @return + * An array of fields, keyed by field names. + */ +function _mediafield_upgrade_target_field_options($form_state) { + $options = array(); + + foreach (field_info_fields() as $field_name => $field) { + // Skip fields that are not file fields. + if ($field['type'] != 'file') { + continue; + } + + // If the field already has data, it can't be on the bundle. + if (field_has_data($field)) { + $entity_type = $form_state['field_instance']['entity_type']; + if (!empty($field['bundles'][$entity_type])) { + if (in_array($form_state['field_instance']['bundle'], $field['bundles'][$entity_type])) { + continue; + } + } + } + + // Skip fields with smaller cardinality. + $cardinality = $form_state['field']['cardinality']; + if ($field['cardinality'] < $cardinality && $field['cardinality'] != -1) { + continue; + } + + $options[$field['field_name']] = $field['field_name']; + } + + return $options; +} + +/** + * Form validation handler for mediafield_upgrade_form(). + * + * @see mediafield_upgrade_form_submit() + */ +function mediafield_upgrade_form_validate($form, &$form_state) { + if ($existing_field = $form_state['values']['existing_field']) { + if (array_key_exists($existing_field, _mediafield_upgrade_target_field_options($form_state))) { + $form_state['existing_field'] = $existing_field; + } + else { + form_set_error('existing_field', t('The target field is no longer available.')); + } + } + else { + $field_name = 'field_' . $form_state['values']['field_name']; + + if (!preg_match('!^field_[a-z0-9_]+$!', $field_name)) { + form_set_error('field_name', t('The field name %field_name is invalid. The name must include only lowercase unaccentuated letters, numbers and underscores.', array('%field_name' => $field_name))); + } + + if (strlen($field_name) > 32) { + form_set_error('field_name', t('The field name can be at most 32 characters long.')); + } + + if (field_read_fields(array('field_name' => $field_name), array('include_inactive', TRUE))) { + form_set_error('field_name', t('The field name %field_name already exists.', array('%field_name' => $field_name))); + } + } +} + +/** + * Form submission handler for mediafield_upgrade_form(). + * + * @see mediafield_upgrade_form_validate() + */ +function mediafield_upgrade_form_submit($form, &$form_state) { + $field_type = 'file'; + $widget_type = 'media_generic'; + + if (!empty($form_state['existing_field'])) { + $target_field = field_info_field($form_state['existing_field']); + } + else { + // Create the new field. + $target_field = field_create_field(array( + 'field_name' => 'field_' . $form_state['values']['field_name'], + 'type' => 'file', + 'cardinality' => $form_state['field']['cardinality'], + )); + } + + // Prepare and create the target field instance. + $old_field_instance = field_info_instance($form_state['field_instance']['entity_type'], $form_state['field_instance']['field_name'], $form_state['field_instance']['bundle']); + $target_field_instance = field_info_instance($form_state['field_instance']['entity_type'], $target_field['field_name'], $form_state['field_instance']['bundle']); + + if (!$target_field_instance) { + $instance = array( + 'field_name' => $target_field['field_name'], + 'label' => $form_state['values']['field_label'], + ) + $old_field_instance; + $instance['widget']['type'] = $widget_type; + $target_field_instance = field_create_instance($instance); + } + + // Create a batch process for updating the entities. + batch_set(array( + 'title' => t('Copying field values'), + 'operations' => array( + array('mediafield_upgrade_batch_step', array($form_state['field_instance'], $target_field_instance)), + ), + 'finished' => 'mediafield_upgrade_batch_finished', + 'file' => drupal_get_path('module', 'mediafield') . '/mediafield.upgrade.inc', + )); + + // Redirect to the field overview. + $entity_info = entity_get_info($target_field_instance['entity_type']); + $form_state['redirect'] = $entity_info['bundles'][$target_field_instance['bundle']]['admin']['real path'] . '/fields'; +} + +/** + * Batch API operation callback for mediafield_upgrade_form_submit(). + */ +function mediafield_upgrade_batch_step($source_instance, $target_instance, &$context) { + // Prepare an entity query. + $query = new EntityFieldQuery(); + $query + ->entityCondition('entity_type', $target_instance['entity_type']) + ->entityCondition('bundle', $target_instance['bundle']); + + // Initialize batch process. + if (empty($context['sandbox'])) { + $count_query = clone $query; + $context['sandbox']['max'] = $count_query->count()->execute(); + $context['sandbox']['current_entity'] = -1; + $context['sandbox']['progress'] = 0; + $context['results'] = array(); + } + + // Get an array of entities. + $entities = (array) $query + ->range($context['results'][0], 10) + ->execute(); + $entities = reset($entities); + + // Load field data on the entities. + field_attach_load($target_instance['entity_type'], $entities); + + foreach ($entities as $id => $entity) { + // Update each entity. + if (!empty($entity->{$source_instance['field_name']})) { + foreach ($entity->{$source_instance['field_name']} as $lang => $values) { + foreach ($values as $key => $value) { + $entity->{$target_instance['field_name']}[LANGUAGE_NONE][$key] = $value + array( + 'description' => '', + 'display' => 1, + ); + } + } + field_attach_presave($target_instance['entity_type'], $entity); + field_attach_update($target_instance['entity_type'], $entity); + } + + $context['sandbox']['current_entity'] = $id; + $context['sandbox']['progress']++; + $context['results'][0]++; + } + + if (count($entities) && $context['sandbox']['max']) { + $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max']; + } +} + +/** + * Batch API finished callback for mediafield_upgrade_form_submit(). + */ +function mediafield_upgrade_batch_finished($success, $results, $operations) { + if ($success) { + drupal_set_message(format_plural($results[0], 'One entity updated.', '@count entities updated.')); + } + else { + drupal_set_message(t('Finished with an error.'), 'error'); + } +}