gathercontent.import.inc in GatherContent 7.3

File

gathercontent.import.inc

<?php

/**
 * @file
 * Content importing for GatherContent module.
 */
include_once 'includes/Project.inc';
include_once 'includes/Content.inc';
include_once 'includes/Template.inc';
use GatherContent\Content;
use GatherContent\Project;
use GatherContent\Template;

/**
 * Multistep form function.
 *
 * @inheritdoc
 */
function gathercontent_import_form($step = NULL) {

  // Define array for ctools multistep wizard.
  $form_info = array(
    'id' => 'gathercontent_import',
    'path' => "admin/config/gathercontent/import/%step",
    'show trail' => FALSE,
    'show back' => TRUE,
    'show cancel' => FALSE,
    'show return' => FALSE,
    'next callback' => 'gathercontent_import_wizard_next',
    'finish callback' => 'gathercontent_import_wizard_finish',
    'finish text' => t('Import'),
    'back text' => t('Back'),
    'no back validate' => TRUE,
    // Define forms order.
    'order' => array(
      'select-project' => t('Select project'),
      'select-content' => t('Select content'),
      'confirm' => t('Confirmation'),
    ),
    // Define forms.
    'forms' => array(
      'select-project' => array(
        'form id' => 'gathercontent_import_form_project_select',
      ),
      'select-content' => array(
        'form id' => 'gathercontent_import_form_content_select',
      ),
      'confirm' => array(
        'form id' => 'gathercontent_import_form_confirm',
      ),
    ),
  );
  $object_id = 1;
  if (empty($step) || $step === 'select-project') {

    // We reset the form when $step is NULL because that means they have
    // for whatever reason started over.
    gathercontent_import_cache_clear($object_id);
    $step = 'select-project';
  }

  // This automatically gets defaults if there wasn't anything saved.
  $object = gathercontent_import_cache_get($object_id);

  // Live $form_state changes.
  $form_state = array(
    // Put our object and ID into the form state cache so we can easily find it.
    'object_id' => $object_id,
    'object' => &$object,
  );

  // Send this all off to our form. This is like drupal_get_form only wizardy.
  ctools_include('wizard');
  $form = ctools_wizard_multistep_form($form_info, $step, $form_state);
  $output = drupal_render($form);
  if ($output === FALSE || !empty($form_state['complete'])) {
    drupal_set_message(t('New mapping has been saved.'));
    drupal_goto("admin/config/gathercontent/mapping");
  }
  return $output;
}

/**
 * Clears the wizard cache.
 *
 * @param int $id
 *   Cache ID.
 */
function gathercontent_import_cache_clear($id) {
  ctools_include('object-cache');
  ctools_object_cache_clear('gathercontent_import', $id);
}

/**
 * Stores our little cache so that we can retain data from form to form.
 *
 * @param int $id
 *   Cache ID.
 * @param object $object
 *   Object with form values.
 */
function gathercontent_import_cache_set($id, $object) {
  ctools_include('object-cache');
  ctools_object_cache_set('gathercontent_import', $id, $object);
}

/**
 * Gets the current object from the cache, or default.
 *
 * @param int $id
 *   Cache ID.
 *
 * @return object
 *   Cache with stored stuff.
 */
function gathercontent_import_cache_get($id) {
  ctools_include('object-cache');
  $object = ctools_object_cache_get('gathercontent_import', $id);
  if (!$object) {

    // Create a default object.
    $object = new stdClass();
  }
  return $object;
}

/**
 * Handles the 'next' click on the add/edit pane form wizard.
 *
 * All we need to do is store the updated pane in the cache.
 */
function gathercontent_import_wizard_next(&$form_state) {
  gathercontent_import_cache_set($form_state['object_id'], $form_state['object']);
}

/**
 * Project select form.
 *
 * @inheritdoc
 */
function gathercontent_import_form_project_select($form, &$form_state) {
  $gathercontent_module_path = drupal_get_path('module', 'gathercontent');
  $query = db_select('gathercontent_mapping', 'm')
    ->distinct()
    ->fields('m', array(
    'gathercontent_project',
    'gathercontent_project_id',
  ))
    ->isNotNull('data')
    ->execute();
  $projects = $query
    ->fetchAllKeyed(1, 0);
  $form['project'] = array(
    '#type' => 'select',
    '#title' => t('Select project'),
    '#options' => $projects,
    '#empty_option' => t('- Select -'),
    '#empty_value' => 0,
    '#required' => TRUE,
    '#default_value' => isset($form_state['object']->project_id) ? $form_state['object']->project_id : '',
    '#description' => t('You can only see projects with mapped templates in the dropdown.'),
    '#attributes' => array(
      'class' => array(
        'gathercontent-autosubmit',
      ),
    ),
    '#attached' => array(
      'js' => array(
        $gathercontent_module_path . '/js/gathercontent-autosubmit.js',
      ),
    ),
  );
  return $form;
}

/**
 * Content select import form.
 *
 * @inheritdoc
 */
function gathercontent_import_form_content_select($form, &$form_state) {
  $gathercontent_module_path = drupal_get_path('module', 'gathercontent');
  $query = db_select('gathercontent_mapping', 'm')
    ->distinct()
    ->fields('m', array(
    'gathercontent_project',
    'gathercontent_project_id',
  ))
    ->isNotNull('data')
    ->execute();
  $projects = $query
    ->fetchAllKeyed(1, 0);
  $form['project_wrapper'] = array(
    '#type' => 'container',
  );
  $form['project_wrapper']['project'] = array(
    '#type' => 'select',
    '#title' => t('Select project'),
    '#options' => $projects,
    '#required' => TRUE,
    '#ajax' => array(
      'callback' => 'gathercontent_import_form_content_select_fetch_content',
      'wrapper' => 'edit-import',
      'method' => 'replace',
      'effect' => 'fade',
    ),
    '#default_value' => isset($form_state['object']->project_id) ? $form_state['object']->project_id : 0,
    '#description' => t('You can only see projects with mapped templates in the dropdown.'),
  );
  $form['project_wrapper']['fetch_content'] = array(
    '#type' => 'button',
    '#executes_submit_callback' => FALSE,
    '#value' => t('Fetch contents of the selected project'),
    '#name' => 'fetch_content',
    '#attributes' => array(
      'class' => array(
        'js-hide',
      ),
    ),
  );
  $form['import'] = array(
    '#prefix' => '<div id="edit-import">',
    '#suffix' => '</div>',
    '#attached' => array(
      'js' => array(
        $gathercontent_module_path . '/js/gathercontent-filter.js',
      ),
    ),
  );
  if (isset($form_state['values']['project']) || isset($form_state['object']->project_id)) {
    $project_id = isset($form_state['values']['project']) ? $form_state['values']['project'] : $form_state['object']->project_id;
    $content_obj = new Content();
    $content = $content_obj
      ->getContents($project_id);
    $query = new EntityFieldQuery();
    $result = $query
      ->entityCondition('entity_type', 'gathercontent_mapping')
      ->propertyCondition('gathercontent_project_id', $project_id)
      ->execute();
    if (isset($result['gathercontent_mapping'])) {
      $mapping_ids = array_keys($result['gathercontent_mapping']);
      $mappings = entity_load('gathercontent_mapping', $mapping_ids);
      $mapping_array = array();
      $content_types = [];
      foreach ($mappings as $mapping) {
        if (!empty($mapping->data)) {
          if (!array_key_exists($mapping->gathercontent_template_id, $content_types)) {
            $content_types[$mapping->gathercontent_template_id] = $mapping->content_type;
          }
          $mapping_array[$mapping->gathercontent_template_id] = array(
            'gathercontent_template' => $mapping->gathercontent_template,
            'ct' => $mapping->content_type,
          );
        }
      }
      $form['import']['content'] = array(
        '#tree' => TRUE,
        '#theme' => 'gathercontent_tableselect',
        '#js_select' => TRUE,
        '#header' => array(
          'selected' => array(
            'class' => array(
              'select-all',
            ),
            'data' => '',
          ),
          'status' => t('Status'),
          'title' => t('Item Name'),
          'updated' => t('Last updated in GatherContent'),
          'template' => t('GatherContent Template Name'),
          'drupal_status' => t('Import published'),
          'menu' => t('Menu'),
        ),
        '#empty' => t('No content available.'),
        '#filterwrapper' => array(
          'filter_wrapper' => array(
            'gathercontent-table--filter-wrapper',
            'clearfix',
          ),
          'counter_wrapper' => array(
            'gathercontent-table--counter',
            'clearfix',
          ),
        ),
        '#filterdescription' => t('You can only see items with mapped templates in the table.'),
      );
      foreach ($content as $item) {

        // If template is not empty, we have mapped template and item
        // isn't synced yet.
        if (!is_null($item->template_id) && $item->template_id != 'null' && isset($mapping_array[$item->template_id])) {
          $form['import']['content'][$item->id] = array(
            '#tree' => TRUE,
            'selected' => array(
              '#type' => 'checkbox',
              '#attributes' => array(
                'class' => array(
                  'gathercontent-select-import-items',
                ),
              ),
            ),
            'status' => array(
              '#markup' => '<div class="gathercontent-item--status--color" style="background: ' . $item->status->data->color . ';"></div>' . $item->status->data->name,
              '#attributes' => array(
                'class' => array(
                  'gathercontent-item',
                  'status-item',
                ),
              ),
            ),
            'title' => array(
              '#markup' => $item->name,
              '#attributes' => array(
                'class' => array(
                  'gathercontent-item',
                  'gathercontent-item--name',
                ),
              ),
            ),
            'updated' => array(
              '#markup' => date('F d, Y - H:i', strtotime($item->updated_at->date)),
              '#attributes' => array(
                'class' => array(
                  'gathercontent-item',
                  'gathercontent-item-date',
                ),
                'data-date' => date('Y-m-d.H:i:s', strtotime($item->updated_at->date)),
              ),
            ),
            'template' => array(
              '#markup' => $mapping_array[$item->template_id]['gathercontent_template'],
              '#attributes' => array(
                'class' => array(
                  'template-name-item',
                ),
              ),
            ),
            'drupal_status' => array(
              '#type' => 'checkbox',
              '#title' => t('Publish'),
              '#title_display' => 'invisible',
              '#checked' => isset($form_state['object']->drupal_status) ? $form_state['object']->drupal_status : variable_get('node_default_status', 1),
            ),
            'menu' => array(
              '#type' => 'select',
              '#options' => array(
                -1 => t("Parent being imported"),
              ) + menu_parent_options(menu_get_menus(), $mapping_array[$item->template_id]['ct']),
              '#empty_option' => t("- Don't create menu item -"),
              '#empty_value' => 0,
              '#default_value' => variable_get('menu_parent_' . $content_types[$item->template_id], 'main-menu:0'),
              '#title' => t('Menu'),
              '#title_display' => 'invisible',
            ),
          );
        }
      }
    }
  }
  return $form;
}

/**
 * AJAX callback for fetching content from GatherContent.
 *
 * @inheritdoc
 */
function gathercontent_import_form_content_select_fetch_content($form, &$form_state) {
  return $form['import'];
}

/**
 * Validation function for import select screen.
 *
 * We are validating, if every item with "parent being imported" menu has
 * parent in current import selection.
 *
 * @inheritdoc
 */
function gathercontent_import_form_content_select_validate($form, &$form_state) {
  if ($form_state['triggering_element']['#type'] === 'submit') {
    $stack = array();
    $content = array_filter($form_state['values']['content']);
    $import_content = [];
    $menu = [];
    foreach ($content as $item_id => $item) {
      if ($item['selected'] === 1) {
        $import_content[$item_id] = $item_id;
        $menu[$item_id] = $item['menu'];
      }
    }
    if (!empty($import_content) && !empty($menu)) {
      foreach ($import_content as $k => $value) {
        if (isset($menu[$value]) && $menu[$value] != -1 || !isset($menu[$value])) {
          $stack[] = $value;
          unset($import_content[$k]);
        }
      }
      if (!empty($import_content)) {

        // Load all by project_id.
        $first = reset($import_content);
        $content_obj = new Content();
        $content = $content_obj
          ->getContent($first);
        $contents_source = $content_obj
          ->getContents($content->project_id);
        $content = array();
        foreach ($contents_source as $value) {
          $content[$value->id] = $value;
        }
        $num_of_repeats = 0;
        $size = count($import_content);
        while (!empty($import_content)) {
          $current = reset($import_content);
          if (in_array($content[$current]->parent_id, $stack)) {
            $stack[] = $current;
            array_shift($import_content);
          }
          else {
            array_shift($import_content);
            array_push($import_content, $current);
            $num_of_repeats++;
            if ($num_of_repeats >= $size * $size) {
              form_set_error('form', t("Please check your menu selection, some of items don't have parent in import."));
              $import_content = array();
            }
          }
        }
      }
    }
  }
}

/**
 * Submit handler for `gathercontent_import` form.
 *
 * @inheritdoc
 */
function gathercontent_import_form_content_select_submit($form, &$form_state) {
  $form_state['object']->project_id = $form_state['values']['project'];
  $content = array_filter($form_state['values']['content']);
  $import_content = array();
  $menu = array();
  $drupal_status = array();
  foreach ($content as $item_id => $item) {
    if ($item['selected'] === 1) {
      $import_content[$item_id] = $item_id;
      $menu[$item_id] = $item['menu'];
      $drupal_status[$item_id] = $item['drupal_status'];
    }
  }
  $form_state['object']->nodes = $import_content;
  $form_state['object']->menu = $menu;
  $form_state['object']->drupal_status = $drupal_status;
}

/**
 * Submit handler for `gathercontent_import` form.
 *
 * @inheritdoc
 */
function gathercontent_import_form_project_select_submit($form, &$form_state) {
  $form_state['object']->project_id = $form_state['values']['project'];
}

/**
 * Smg.
 *
 * @inheritdoc
 */
function gathercontent_import_form_confirm($form, &$form_state) {
  $form['title'] = array(
    'form_title' => array(
      '#type' => 'html_tag',
      '#tag' => 'h2',
      '#value' => format_plural(count($form_state['object']->nodes), 'Confirm import selection (@count item)', 'Confirm import selection (@count items)'),
    ),
    'form_description' => array(
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => t('Please review your import selection before importing.'),
    ),
  );
  $header = array(
    'status' => t('Status'),
    'title' => t('Item name'),
    'template' => t('GatherContent Template'),
  );
  $options = array();
  $tmp_obj = new Template();
  $templates = $tmp_obj
    ->getTemplates($form_state['object']->project_id);
  foreach ($form_state['object']->nodes as $node) {
    $content_obj = new Content();
    $content = $content_obj
      ->getContent($node);
    $options[$content->id] = array(
      'status' => '<div style="width:20px; height: 20px; float: left; margin-right: 5px; background: ' . $content->status->data->color . ';"></div>' . $content->status->data->name,
      'title' => $content->name,
      'template' => $templates[$content->template_id],
    );
  }
  $table = theme('table', array(
    'header' => $header,
    'rows' => $options,
  ));
  $form['table'] = array(
    '#markup' => render($table),
  );
  $options = array();
  $project_obj = new Project();
  $statuses = $project_obj
    ->getStatuses($form_state['object']->project_id);
  foreach ($statuses as $status) {
    $options[$status->id] = $status->name;
  }
  $form['node_update_method'] = [
    '#type' => 'radios',
    '#required' => TRUE,
    '#title' => t('Content update method'),
    '#default_value' => variable_get('gathercontent_node_update_method', 'always_update'),
    '#options' => [
      'always_create' => t('Always create new Content'),
      'update_if_not_changed' => t('Create new Content if it has changed since the last import'),
      'always_update' => t('Always update existing Content'),
    ],
  ];
  $form['status'] = array(
    '#type' => 'select',
    '#options' => $options,
    '#title' => t('After successful import change status to:'),
    '#empty_option' => t("- Don't change status -"),
  );
  return $form;
}

/**
 * Grdg.
 *
 * @inheritdoc
 */
function gathercontent_import_form_confirm_submit($form, &$form_state) {
  $form_state['object']->status = $form_state['values']['status'];
  $uuid = _gathercontent_uuid_generate();
  $operation = entity_create('gathercontent_operation', array(
    'uuid' => $uuid,
    'type' => 'import',
  ));
  entity_save('gathercontent_operation', $operation);
  $operations = array();
  $stack = array();
  $import_content = $form_state['object']->nodes;
  foreach ($import_content as $k => $value) {
    if (isset($form_state['object']->menu[$value]) && $form_state['object']->menu[$value] != -1 || !isset($form_state['object']->menu[$value])) {
      $parent_menu_item = isset($form_state['object']->menu[$value]) ? $form_state['object']->menu[$value] : NULL;
      $drupalStatus = isset($form_state['object']->drupal_status[$value]) ? $form_state['object']->drupal_status[$value] : 0;
      $operations[] = array(
        'gathercontent_import_process',
        array(
          $value,
          $form_state['object']->status,
          $uuid,
          $drupalStatus,
          $parent_menu_item,
          $form_state['values']['node_update_method'],
        ),
      );
      $stack[] = $value;
      unset($import_content[$k]);
    }
  }

  // If there are any items.
  if (!empty($import_content)) {

    // Load all by project_id.
    $first = reset($import_content);
    $content_obj = new Content();
    $content = $content_obj
      ->getContent($first);
    $contents_source = $content_obj
      ->getContents($content->project_id);
    $content = array();
    foreach ($contents_source as $value) {
      $content[$value->id] = $value;
    }
    while (!empty($import_content)) {
      $current = reset($import_content);
      if (in_array($content[$current]->parent_id, $stack)) {
        $parent_menu_item = 'node:' . $content[$current]->parent_id;
        $drupalStatus = isset($form_state['object']->drupal_status[$current]) ? $form_state['object']->drupal_status[$current] : 0;
        $operations[] = array(
          'gathercontent_import_process',
          array(
            $current,
            $form_state['object']->status,
            $uuid,
            $drupalStatus,
            $parent_menu_item,
            $form_state['values']['node_update_method'],
          ),
        );
        $stack[] = $current;
        array_shift($import_content);
      }
      else {
        array_shift($import_content);
        array_push($import_content, $current);
      }
    }
  }
  $batch = array(
    'title' => t('Importing content ...'),
    'operations' => $operations,
    'finished' => 'gathercontent_import_finished',
    'file' => drupal_get_path('module', 'gathercontent') . '/gathercontent.import.inc',
    'init_message' => t('Import is starting ...'),
    'progress_message' => t('Processed @current out of @total.'),
    'error_message' => t('An error occurred during processing'),
  );
  batch_set($batch);
}

/**
 * Finish callback for multistep form.
 *
 * This is never going to be called because we are redirecting after batch.
 *
 * @inheritdoc
 */
function gathercontent_import_wizard_finish($form, &$form_state) {
}

/**
 * Batch operation callback.
 *
 * We are doing real import thing here.
 *
 * @param int $content_id
 *   ID of content we want to import.
 * @param int $status_id
 *   ID of status, if 0 then we don't want to change status.
 * @param string $uuid
 *   UUID of operation.
 * @param bool $drupal_status
 *   Status on node in Drupal - published/unpublished.
 * @param int|null $parent_menu_item
 * @param string $node_update_method
 *   Name of the node update method.
 * @param array $context
 *   Context of operation.
 */
function gathercontent_import_process($content_id, $status_id, $uuid, $drupal_status, $parent_menu_item = NULL, $node_update_method, &$context) {
  if (($nid = _gathercontent_fetcher($content_id, $uuid, $drupal_status, $status_id, NULL, $parent_menu_item, $node_update_method)) !== FALSE) {
    if ($status_id != 0) {

      // Change status.
      $content_obj = new Content();
      $content_obj
        ->updateStatus($content_id, $status_id);
    }
  }
  $context['results']['uuid'] = $uuid;
}

/**
 * Finished callback.
 *
 * @inheritdoc
 */
function gathercontent_import_finished($success, $results, $operations) {
  if ($success) {

    // Select all items with uuid.
    $query = new EntityFieldQuery();
    $result = $query
      ->entityCondition('entity_type', 'gathercontent_operation_item')
      ->propertyCondition('operation_uuid', $results['uuid'])
      ->execute();
    if (isset($result['gathercontent_operation_item'])) {
      $operation_items = entity_load('gathercontent_operation_item', array_keys($result['gathercontent_operation_item']));
      $success_counter = 0;
      $nids = array(
        'success' => array(),
        'failed' => array(),
      );
      foreach ($operation_items as $operation_item) {
        if ($operation_item->status === 'Success') {
          $success_counter++;
          $nids['success'][] = array(
            'nid' => $operation_item->nid,
            'gathercontent_id' => $operation_item->gathercontent_id,
          );
        }
        else {
          $nids['failed'][] = array(
            'nid' => $operation_item->nid,
            'gathercontent_id' => $operation_item->gathercontent_id,
          );
        }
      }
      $unsuccessful = count($result['gathercontent_operation_item']) - $success_counter;
      drupal_set_message(format_plural($success_counter, '1 item was imported successfully.', '@count items were imported successfully.'));
      if ($unsuccessful > 0) {
        drupal_set_message(format_plural($unsuccessful, '1 item was not imported. Check errors below.', '@count items were not imported. Check errors below.'), 'error');
      }
      module_invoke_all('gathercontent_post_import', $nids['success'], $nids['failed'], $results['uuid']);
    }
    drupal_goto('admin/config/gathercontent/import/result/' . $results['uuid']);
  }
  else {
    $error_operation = reset($operations);
    drupal_set_message(t('An error occurred while processing @operation with arguments : @args', array(
      '@operation' => $error_operation[0],
      '@args' => print_r($error_operation[0], TRUE),
    )), 'error');
  }
}

Functions

Name	Description
gathercontent_import_cache_clear	Clears the wizard cache.
gathercontent_import_cache_get	Gets the current object from the cache, or default.
gathercontent_import_cache_set	Stores our little cache so that we can retain data from form to form.
gathercontent_import_finished	Finished callback.
gathercontent_import_form	Multistep form function.
gathercontent_import_form_confirm	Smg.
gathercontent_import_form_confirm_submit	Grdg.
gathercontent_import_form_content_select	Content select import form.
gathercontent_import_form_content_select_fetch_content	AJAX callback for fetching content from GatherContent.
gathercontent_import_form_content_select_submit	Submit handler for `gathercontent_import` form.
gathercontent_import_form_content_select_validate	Validation function for import select screen.
gathercontent_import_form_project_select	Project select form.
gathercontent_import_form_project_select_submit	Submit handler for `gathercontent_import` form.
gathercontent_import_process	Batch operation callback.
gathercontent_import_wizard_finish	Finish callback for multistep form.
gathercontent_import_wizard_next	Handles the 'next' click on the add/edit pane form wizard.