invite.admin.inc in Invite 7.4

File

includes/invite.admin.inc

<?php

/**
 * @file
 */

/**
 * Generates the invite type editing form.
 *
 * @param $form
 * @param $form_state
 * @param InviteType $invite_type
 * @param string $op
 *
 * @return array
 */
function invite_type_form($form, &$form_state, $invite_type, $op = 'edit') {
  if ($op == 'clone') {
    $invite_type->label .= ' (cloned)';
    $invite_type->type = '';
  }
  $form['#invite_type'] = $invite_type;
  $invite_sending_controllers = array();
  foreach (module_implements('invite_sending_controller') as $module) {
    $sending_controller = module_invoke($module, 'invite_sending_controller');
    $invite_sending_controllers[$module] = $sending_controller['label'];
  }
  if (empty($invite_sending_controllers)) {
    $form['message'] = array(
      '#markup' => t('Sorry no Invitation Type modules available in the system.'),
    );
    return $form;
  }
  $form['label'] = array(
    '#title' => t('Label'),
    '#type' => 'textfield',
    '#default_value' => $invite_type->label,
    '#description' => t('The human-readable name of this invite type.'),
    '#required' => TRUE,
    '#size' => 30,
  );

  // Machine-readable type name.
  $form['type'] = array(
    '#type' => 'machine_name',
    '#default_value' => isset($invite_type->type) ? $invite_type->type : '',
    '#maxlength' => 32,
    '#disabled' => $invite_type
      ->isLocked() && $op != 'clone',
    '#machine_name' => array(
      'exists' => 'invite_get_types',
      'source' => array(
        'label',
      ),
    ),
    '#description' => t('A unique machine-readable name for this invite type. It must only contain lowercase letters, numbers, and underscores.'),
  );
  $form['description'] = array(
    '#type' => 'textarea',
    '#default_value' => isset($invite_type->description) ? $invite_type->description : '',
    '#description' => t('Description about the invite type.'),
  );
  $form['invite_sending_controller'] = array(
    '#title' => t('Sending method'),
    '#type' => 'checkboxes',
    '#default_value' => $invite_type->invite_sending_controller,
    '#description' => t('Invitation processing plugin.'),
    '#options' => $invite_sending_controllers,
    '#required' => TRUE,
  );
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save invite type'),
    '#weight' => 40,
  );
  if (!$invite_type
    ->isLocked() && $op != 'add' && $op != 'clone') {
    $form['actions']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete invite type'),
      '#weight' => 45,
      '#limit_validation_errors' => array(),
      '#submit' => array(
        'invite_type_form_submit_delete',
      ),
    );
  }
  return $form;
}

/**
 * Submit handler for creating/editing invite_type.
 *
 * @param $form
 * @param $form_state
 */
function invite_type_form_submit(&$form, &$form_state) {
  $invite_type = entity_ui_form_submit_build_entity($form, $form_state);
  foreach ($form_state['values']['invite_sending_controller'] as $controller) {
    if (!empty($controller)) {
      $invite_type->invite_sending_controller[] = $controller;
    }
  }

  // Save and go back.
  invite_type_save($invite_type);

  // Redirect user back to list of invite types.
  $form_state['redirect'] = 'admin/structure/invite-types';
}

/**
 * @param $form
 * @param $form_state
 */
function invite_type_form_submit_delete(&$form, &$form_state) {
  $form_state['redirect'] = 'admin/structure/invite-types/manage/' . $form_state['invite_type']->type . '/delete';
}

/**
 * Page to select invite Type to add new invite.
 *
 * @return array
 *   Renderable array
 */
function invite_admin_add_page() {
  $items = array();
  foreach (invite_get_types() as $invite_type_key => $invite_type) {
    $items[] = l(entity_label('invite_type', $invite_type), 'invite/add/' . $invite_type_key);
  }
  if (sizeof($items) < 1) {
    $form_element = array(
      'list' => array(
        '#markup' => '<h3>No invite types have been enabled.</h3><br /><p>To create invites at least one invite type must be enabled.</p>',
      ),
    );
  }
  else {
    $form_element = array(
      'list' => array(
        '#theme' => 'item_list',
        '#items' => $items,
        '#title' => t('Select type of invite to create.'),
      ),
    );
  }
  return $form_element;
}

/**
 * Add new invite page callback.
 *
 * @param string $type
 *
 * @return array|mixed
 */
function invite_add($type) {
  $invite_type = invite_get_types($type);
  $invite = entity_create('invite', array(
    'type' => $type,
  ));
  drupal_set_title(t('Create @name', array(
    '@name' => entity_label('invite_type', $invite_type),
  )));
  $output = drupal_get_form('invite_form', $invite);
  return $output;
}

/**
 * Invite Form.
 *
 * @param $form
 * @param $form_state
 * @param Invite $invite
 *
 * @return array
 */
function invite_form($form, &$form_state, $invite) {
  $form['#entity'] = $form_state['invite'] = $invite;
  $form['uid'] = array(
    '#type' => 'value',
    '#value' => $invite->uid,
  );
  field_attach_form('invite', $invite, $form, $form_state);
  $submit = array();
  if (!empty($form['#submit'])) {
    $submit += $form['#submit'];
  }
  $form['actions'] = array(
    '#weight' => 100,
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save invite'),
    '#submit' => $submit + array(
      'invite_form_submit',
    ),
  );

  // Show Delete button if we edit invite.
  $invite_id = entity_id('invite', $invite);
  if (!empty($invite_id) && invite_access('edit', $invite)) {
    $form['actions']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete'),
      '#submit' => array(
        'invite_form_submit_delete',
      ),
    );
  }
  $form['#validate'][] = 'invite_form_validate';
  return $form;
}

/**
 * Validates invitation form.
 *
 * @param $form
 * @param $form_state
 */
function invite_form_validate($form, &$form_state) {
}

/**
 * Invite creation submit handler.
 *
 * @param $form
 * @param $form_state
 */
function invite_form_submit($form, &$form_state) {
  global $user;
  $invite = $form_state['invite'];
  $token_data = array(
    'invite' => $invite,
    'user' => $user,
    'profile' => user_load($user->uid),
  );
  entity_form_submit_build_entity('invite', $invite, $form, $form_state);
  if (invite_save($invite)) {
    $invite_uri = entity_uri('invite', $invite);
    $invite_redirect = token_replace(variable_get('invite_redirect_upon_create', NULL), $token_data);
    $form_state['redirect'] = $invite_redirect ? $invite_redirect : $invite_uri;
  }
}

/**
 * Invite delete form handler.
 *
 * @param $form
 * @param $form_state
 */
function invite_form_submit_delete($form, &$form_state) {
  $invite = $form_state['invite'];
  $invite_uri = entity_uri('invite', $invite);
  $form_state['redirect'] = $invite_uri['path'] . '/delete';
}

/**
 * Delete confirmation form.
 *
 * @param $form
 * @param $form_state
 * @param Invite $invite
 *
 * @return array
 */
function invite_delete_form($form, &$form_state, $invite) {
  $form_state['invite'] = $invite;

  // Always provide entity id in the same form key as in the entity edit form.
  $form['invite_type_id'] = array(
    '#type' => 'value',
    '#value' => entity_id('invite', $invite),
  );
  $invite_uri = entity_uri('invite', $invite);
  return confirm_form($form, t('Are you sure you want to delete %title?', array(
    '%title' => entity_label('invite', $invite),
  )), $invite_uri['path'], t('This action cannot be undone.'), t('Delete'), t('Cancel'));
}

/**
 * Delete form submit handler.
 *
 * @param $form
 * @param $form_state
 */
function invite_delete_form_submit($form, &$form_state) {
  $invite = $form_state['invite'];
  invite_delete($invite);
  drupal_set_message(t('%title deleted.', array(
    '%title' => entity_label('invite', $invite),
  )));
  $form_state['redirect'] = '<front>';
}

/**
 * Invite module settings form.
 *
 * @return array
 */
function invite_settings_form() {
  $form = array();
  $form['invite_default_expiry_time'] = array(
    '#type' => 'select',
    '#title' => t('Invitation expiry'),
    '#default_value' => variable_get('invite_default_expiry_time', 30),
    '#options' => drupal_map_assoc(array(
      1,
      3,
      7,
      14,
      30,
      60,
      365,
    )),
    '#description' => t('Set the expiry period for user invitations, in days.'),
    '#multiple' => FALSE,
    '#required' => TRUE,
  );
  $form['invite_registration_path'] = array(
    '#type' => 'textfield',
    '#title' => t('Path to registration page'),
    '#default_value' => variable_get('invite_registration_path', 'user/register'),
    '#description' => t('Path to the registration page for invited users. Useful when using the <em>Assign from Path</em> option of <a href="@url" target="blank">Auto Assign Roles</a> module.', array(
      '@url' => 'http://drupal.org/project/autoassignrole',
    )),
  );
  $form['invite_require_approval'] = array(
    '#type' => 'checkbox',
    '#title' => t('Require administrator approval for invitees'),
    '#default_value' => variable_get('invite_require_approval', FALSE),
    '#description' => t('Accounts that have been created with an invitation will require administrator approval.'),
  );
  $form['invite_redirect_upon_create'] = array(
    '#type' => 'textfield',
    '#title' => t('Redirect to path after invite created.'),
    '#default_value' => variable_get('invite_redirect_upon_create', '[invite:url]'),
    '#description' => t('Optional redirect path after creation of invite. <a></a>'),
  );
  if (module_exists('token')) {
    $form['token_help'] = array(
      '#title' => t('Replacement patterns'),
      '#type' => 'fieldset',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['token_help']['help'] = array(
      '#markup' => theme('token_tree', array(
        'token_types' => array(
          'user',
          'profile',
          'invite',
        ),
      )),
    );
  }
  return system_settings_form($form);
}

/**
 * Implements hook_validate().
 */
function invite_settings_form_validate($form, &$form_state) {
  $invite_registration_path = $form_state['values']['invite_registration_path'];
  $is_valid_path = drupal_valid_path($invite_registration_path);
  if (!$is_valid_path) {
    form_set_error('invite_registration_path', t('This path is invalid.'));
  }
}

/**
 * Migration form.
 *
 * @return array
 */
function invite_migrate_form() {
  $form = array();
  $migration_possible = TRUE;

  // Check prerequisites.
  $available_types = array(
    'none' => '- Please select -',
  );
  $invite_types = invite_get_types();
  foreach ($invite_types as $name => $type) {
    if ($type->invite_sending_controller == 'invite_by_email') {
      $available_types[$name] = $type->label;
    }
  }
  if (!module_exists('invite_by_email')) {
    drupal_set_message(t('You should enable Invite by e-mail module.'), 'error');
    $migration_possible = FALSE;
  }
  if (!module_exists('invite_notifications')) {
    drupal_set_message(t('You should enable Invite Notifications module.'), 'error');
    $migration_possible = FALSE;
  }
  if ($migration_possible) {
    $form['type'] = array(
      '#title' => t('Choose type'),
      '#description' => t('Select an Invite type which will be used to import old invites.'),
      '#type' => 'select',
      '#options' => $available_types,
      '#default_value' => 'none',
    );
    $form['drop_old_tables'] = array(
      '#title' => t('Drop old tables'),
      '#description' => t('Drop tables from Invite 2.x module after migration is completed.'),
      '#type' => 'checkbox',
      '#default_value' => TRUE,
    );
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Migrate'),
    );
  }
  else {
    $form['message'] = array(
      '#markup' => t('Migration is impossible, please fix errors mentioned above.'),
    );
  }
  return $form;
}

/**
 * Implements validation for migration form.
 *
 * @param $form
 * @param $form_state
 */
function invite_migrate_form_validate($form, &$form_state) {
  if ($form_state['values']['type'] == 'none') {
    form_set_error('type', t('Please choose an Invite type.'));
  }
  else {

    // TODO: add field mapping to the form.
    $needed_fields = array(
      'field_invitation_email_address',
      'field_invitation_email_subject',
      'field_invitation_email_body',
    );
    $verified_fields = 0;
    foreach (field_info_instances('invite', 'invite_by_email') as $field_name => $field) {
      if (in_array($field_name, $needed_fields)) {
        $verified_fields++;
      }
    }
    if ($verified_fields != count($needed_fields)) {
      form_set_error('type', t('This content type couldn\'t be used.'));
    }
  }
}

/**
 * Implements submit handler for migration.
 *
 * @param $form
 * @param $form_state
 */
function invite_migrate_form_submit($form, &$form_state) {
  if ($form_state['values']['submit'] == t('Migrate')) {
    $batch = array(
      'title' => t('Migrating'),
      'operations' => array(
        array(
          'invite_migrate_process',
          array(
            $form_state['values'],
          ),
        ),
      ),
      'file' => drupal_get_path('module', 'invite') . '/includes/invite.admin.inc',
    );
    batch_set($batch);
    batch_process();
  }
}

/**
 *
 */
function invite_migrate_process($values, &$context) {
  $query = db_select('invite_2x', 'i2x')
    ->fields('i2x');
  if (empty($context['sandbox'])) {
    $context['sandbox']['progress'] = 0;
    $context['sandbox']['max'] = $query
      ->countQuery()
      ->execute()
      ->fetchField();
  }
  $limit = 20;
  variable_set('invite_migration_in_progress', TRUE);
  $result = $query
    ->range($context['sandbox']['progress'], $limit)
    ->execute();
  foreach ($result as $record) {
    $invite_data = array(
      'type' => $values['type'],
      'reg_code' => $record->reg_code,
      'uid' => $record->uid,
      'invitee' => $record->invitee,
      'created' => $record->created,
      'expiry' => $record->expiry,
      'joined' => $record->joined,
      'canceled' => $record->canceled,
      'data' => $record->data,
    );

    // Default to Valid.
    $status = INVITE_VALID;

    // Withdrawn.
    if ($record->canceled != 0) {
      $status = INVITE_WITHDRAWN;
    }
    elseif ($record->joined != 0) {
      $status = INVITE_USED;
    }
    elseif ($record->expiry < REQUEST_TIME) {
      $status = INVITE_EXPIRED;
    }
    $invite_data['status'] = $status;
    $invite = new Invite($invite_data);
    $invite->field_invitation_email_address[LANGUAGE_NONE][0]['value'] = $record->email;
    $data = unserialize($record->data);
    $invite->field_invitation_email_subject[LANGUAGE_NONE][0]['value'] = $data['subject'];
    $invite->field_invitation_email_body[LANGUAGE_NONE][0]['value'] = $data['message'];
    $invite->sendNotification = FALSE;
    $invite
      ->save();
    $context['sandbox']['progress']++;
  }
  variable_del('invite_migration_in_progress');
  if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
    $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
  }
  else {
    if ($values['drop_old_tables']) {
      db_drop_table('invite_2x');
      db_drop_table('invite_notifications_2x');
    }
  }
}

Functions

Name	Description
invite_add	Add new invite page callback.
invite_admin_add_page	Page to select invite Type to add new invite.
invite_delete_form	Delete confirmation form.
invite_delete_form_submit	Delete form submit handler.
invite_form	Invite Form.
invite_form_submit	Invite creation submit handler.
invite_form_submit_delete	Invite delete form handler.
invite_form_validate	Validates invitation form.
invite_migrate_form	Migration form.
invite_migrate_form_submit	Implements submit handler for migration.
invite_migrate_form_validate	Implements validation for migration form.
invite_migrate_process
invite_settings_form	Invite module settings form.
invite_settings_form_validate	Implements hook_validate().
invite_type_form	Generates the invite type editing form.
invite_type_form_submit	Submit handler for creating/editing invite_type.
invite_type_form_submit_delete	_state