You are here

lingotek.setup.inc in Lingotek Translation 7.7

File

lingotek.setup.inc
View source
<?php

/**
 * @file
 * Lingotek Easy Install Process.
 */
include_once 'lingotek.admin.inc';

/**
 * Routing:  Returning User, New Account or Already Setup
 */
function lingotek_setup() {

  // Does the install already have connection credentials?
  if (lingotek_is_config_missing()) {
    drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/new-account');

    // If something is missing - Go though the Setup Process
  }
  else {
    drupal_goto('admin/settings/lingotek/settings');

    // We already have credentials, goto the Dashboard
  }
}

// END:  Router

/**
 * New Account - Form
 */
function lingotek_setup_new_account_form() {
  $current_login_id = variable_get('lingotek_login_id', '');
  $current_login_key = variable_get('lingotek_login_key', '');
  $current_first_name = variable_get('lingotek_activation_first_name', '');
  $current_last_name = variable_get('lingotek_activation_last_name', '');
  $current_email = variable_get('lingotek_activation_email', '');
  $form = array();
  $form['description'] = array(
    '#type' => 'item',
    '#title' => 'Create Account',
    '#description' => 'New to Lingotek?  Create a free account. <p>A Lingotek account is required to process your language translations.  <strong>All fields are required.</strong></p>',
  );
  $form['first_name'] = array(
    '#type' => 'textfield',
    '#title' => t('First name'),
    '#default_value' => $current_first_name,
    '#size' => 30,
    '#maxlength' => 128,
    '#required' => TRUE,
  );
  $form['last_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Last name'),
    '#default_value' => $current_last_name,
    '#size' => 30,
    '#maxlength' => 128,
    '#required' => TRUE,
  );
  $form['email'] = array(
    '#type' => 'textfield',
    '#title' => t('Email address'),
    '#default_value' => $current_email,
    '#size' => 40,
    '#maxlength' => 128,
    '#required' => TRUE,
  );
  $form['lingotek_button_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Create New Lingotek Account'),
  );
  $form['lingotek_back_button'] = lingotek_connect_account_link('Do you already have a Lingotek account? ', LINGOTEK_MENU_LANG_BASE_URL . '/account-settings', t('Connect Lingotek Account'));
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

// END:  New Account - Form

/**
 * New Account - Form Validator
 */
function lingotek_setup_new_account_form_validate($form, &$form_state) {
  if (!valid_email_address($form_state['values']['email'])) {
    form_set_error('', t('You must enter a valid Email address.'));
  }
}

/**
 * Identify lead details 
 */
function lingotek_identify_lead($data) {
  global $base_url;
  $info = array(
    'first_name' => '',
    'last_name' => '',
    'email' => '',
    'company' => lingotek_get_site_name(),
    // Website name => company
    'website' => $base_url,
    // website url
    'type' => LINGOTEK_DEV ? 'QA' : 'Prospect',
    'cms' => 'Drupal',
    'distribution' => '',
    'lead_source' => '',
    'partner' => '',
  );
  $tags = lingotek_identify_tags();
  $lead = array_merge($info, $tags, $data);
  return $lead;
}

/**
 * Identify CMS tags (e.g., distribution channel)
 */
function lingotek_identify_tags() {
  $tags = array();
  $tags['distribution'] = variable_get('install_profile', 'standard');

  // This should identify the distribution including:  'standard', 'acquia', 'commons', 'commerce_kickstart'
  $tags['lead_source'] = 'Module';
  switch ($tags['distribution']) {
    case 'commerce_kickstart':
      $tags['partner'] = 'Commerce Guys';
      $tags['lead_source'] = 'Distribution';
      break;
    case 'commons':
      $tags['partner'] = 'Acquia';
      $tags['lead_source'] = 'Distribution';
      break;
    default:
      $tags['partner'] = '';
      break;
  }
  return $tags;
}

/**
 * New Account - Form Processor
 * Provisions a Lingotek account and sends activation notice.
 */
function lingotek_setup_new_account_form_submit($form, &$form_state) {
  global $base_url;
  $extras = array();

  // Store the info so users dont have to retype stuff
  $first_name = $form_state['values']['first_name'];
  $last_name = $form_state['values']['last_name'];
  $email = $form_state['values']['email'];
  variable_set('lingotek_activation_first_name', $first_name);
  variable_set('lingotek_activation_last_name', $last_name);
  variable_set('lingotek_activation_email', $email);

  // Check the current settings
  $current_community_identifier = variable_get('lingotek_community_identifier', '');
  $current_oauth_consumer_id = variable_get('lingotek_oauth_consumer_id', '');
  $current_oauth_consumer_secret = variable_get('lingotek_oauth_consumer_secret', '');
  $current_login_id = variable_get('lingotek_login_id', '');
  $current_project = variable_get('lingotek_project', '');
  $current_vault = variable_get('lingotek_vault', '');
  $current_workflow = variable_get('lingotek_workflow', '');

  // Provision a new community if any critical data is missing.
  if ($current_community_identifier == '' || $current_oauth_consumer_id == '' || $current_oauth_consumer_secret == '' || $current_login_id == '' || $current_project == '' || $current_vault == '' || $current_workflow == '') {

    // Provision a new Community & Save the Credentials
    $lead = lingotek_identify_lead(array(
      'first_name' => $first_name,
      'last_name' => $last_name,
      'email' => $email,
    ));
    $notify_url = lingotek_notify_url_generate();
    $parameters = array_merge($lead, array(
      'communityDisplayName' => lingotek_get_site_name(),
      'contactName' => $first_name . ' ' . $last_name,
      'contactEmail' => $email,
      'company' => lingotek_get_site_name(),
      //currently we are not asking for this.
      'website' => $base_url,
      'lead' => json_encode($lead),
    ));
    $api = LingotekApi::instance();
    $response = $api
      ->createCommunity($parameters, $notify_url);
    if ($response && $response->results == "success") {
      $community = $response;

      /*
       stdClass::__set_state(array(
       'results' => 'success',
       'community' => 'EDZDDWXA',
       'oauth_key' => '9a7187ea-fad9-41c0-9c0c-3eedbf9dffd0',
       'oauth_secret' => '58f059b9-d167-4f87-b29a-acbc4e0c67c9',
       'external_id' => 'community_admin',
       'tm_vault_id' => 212,
       'workflow_id' => '22092f38-a1f9-4499-b8d4-9e260e7e5d16',
       'project_id' => 411,
       ))
      */
      variable_set('lingotek_community_identifier', $community->community);
      variable_set('lingotek_oauth_consumer_id', $community->oauth_key);
      variable_set('lingotek_oauth_consumer_secret', $community->oauth_secret);
      variable_set('lingotek_login_id', $community->external_id);

      // Used as the 'External ID'.  For old users, this is their login name / email.
      variable_set('lingotek_project', $community->project_id);
      variable_set('lingotek_vault', $community->tm_vault_id);
      variable_set('lingotek_workflow', $community->workflow_id);
      variable_set('lingotek_translate_comments_workflow_id', $community->workflow_id);
      variable_set('lingotek_translate_config_workflow_id', $community->workflow_id);
      variable_set('lingotek_integration_method', $community->integration_method_id);
      variable_set('lingotek_notify_url', $notify_url);
      variable_set('lingotek_cms_tag', $lead['distribution']);
      $_SESSION['lingotek_setup_path'] = array(
        LINGOTEK_MENU_LANG_BASE_URL . '/new-account',
      );
      drupal_set_message(t('Your new Lingotek account has been setup.'));
      drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/setup-language-switcher');
    }
    else {

      // If there were any setup or communication problems.
      drupal_set_message(t('There was an error contacting the Lingotek servers to create your account.  Please try again later. [Server: @server]', array(
        '@server' => LINGOTEK_API_SERVER,
      )), 'error');
    }

    // END:  if error.
  }
  else {

    // If the user already has all the required community credentials, just direct them to the next step.
    $_SESSION['lingotek_setup_path'] = array(
      LINGOTEK_MENU_LANG_BASE_URL . '/new-account',
    );
    drupal_set_message(t('Your Lingotek account settings have been saved.'));
    drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/setup-language-switcher');
  }
}

// END:  New Account - Form Processor

/**
 * Account Settings (for Current Users) - Form
 */
function lingotek_setup_account_settings_form() {
  $title_message = 'Account Login';
  $current_login_id = variable_get('lingotek_login_id', '');
  $current_password = variable_get('lingotek_password', '');
  $form = array();
  $form['lingotek_user_directions_1'] = array(
    '#type' => 'item',
    '#title' => filter_xss($title_message),
    '#description' => 'Connect an existing Lingotek account. This option is for users with an active paid TMS subscription.',
  );
  $form['lingotek_lid'] = array(
    '#type' => 'textfield',
    '#title' => t('Username'),
    '#default_value' => $current_login_id,
    '#size' => 40,
    '#maxlength' => 128,
    '#required' => TRUE,
    '#attributes' => array(
      'autocomplete' => array(
        'off',
      ),
    ),
  );
  $form['lingotek_pid'] = array(
    '#type' => 'password',
    '#title' => t('Password'),
    '#default_value' => $current_password,
    '#size' => 40,
    '#maxlength' => 128,
    '#required' => TRUE,
    '#attributes' => array(
      'autocomplete' => array(
        'off',
      ),
    ),
  );
  $form['lingotek_button_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['save_settings'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  $form['lingotek_back_button'] = lingotek_setup_link_on_right(LINGOTEK_MENU_LANG_BASE_URL . '/new-account', t('No subscription? Go back and register for free.'));
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

// END:  Account Settings - Form

/**
 * Account Settings (for Current Users) - Form Processing
 */
function lingotek_setup_account_settings_form_submit($form, $form_state) {
  $login_id = $form_state['values']['lingotek_lid'];
  $password = $form_state['values']['lingotek_pid'];

  // Validate the Account
  list($success, $msg) = lingotek_list_community_integrations($login_id, $password);
  if ($success == FALSE) {
    drupal_set_message(check_plain($msg), 'error');
  }
  else {

    // Login Successful:  Valid Account
    $_SESSION['lingotek_setup_path'] = array(
      LINGOTEK_MENU_LANG_BASE_URL . '/account-settings',
    );
    drupal_set_message(t('Your account settings have been saved.'));
    variable_set('lingotek_login_id', $login_id);
    variable_set('lingotek_password', $password);
    drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/community-select');
  }

  // END:  Valid Login
}

// END:  Account Settings - Form Processing

/**
 * Community Select Screen (for Current Users) - Form
 */
function lingotek_community_select_form() {
  $login_id = variable_get('lingotek_login_id', '');
  $password = variable_get('lingotek_password', '');
  $form = array();
  list($success, $msg) = lingotek_list_community_integrations($login_id, $password);
  if ($success == FALSE) {
    drupal_set_message(check_plain($msg), 'error');
    drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/account-settings');

    // Shouldnt be here.  So something messed up.  Go back.
  }
  else {
    $community_integrations = $msg;
    $count = count($community_integrations);
    if ($count == 1) {

      // Just one community, use that.
      $ci = array_pop($community_integrations);
      variable_set('lingotek_community_identifier', $ci->community_id);
      variable_set('lingotek_oauth_consumer_id', $ci->key);
      variable_set('lingotek_oauth_consumer_secret', $ci->secret);
      variable_set('lingotek_community_name', $ci->community_name);
      drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/project-vault-select');

      // Default path, if they belong to one community.
    }
    elseif ($count > 1) {

      // More than 1 community
      // Stay on this page
    }
    else {

      // 0 Results, we have an error.  Or, we should create a community for them.
      drupal_set_message(t('Failed to connect to the Lingotek service: Missing integration method.'), 'error');
      drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/account-settings');

      // Shouldnt be here.  So something messed up.  Go back.
    }
  }

  // END:  Community Select Paths
  $form['lingotek_user_directions_1'] = array(
    '#markup' => '<p>Your account is associated with multiple Lingotek communities.</p>
    <p>Select the community to associate this site with:</p>',
  );
  $community_options = array();
  foreach ($community_integrations as $ci) {
    $community_options[$ci->community_id] = $ci->community_name . ' (' . $ci->community_id . ')';
  }
  $form['lingotek_site_community'] = array(
    '#title' => t('Community'),
    '#type' => 'select',
    '#options' => $community_options,
    //array_combine(array_keys($communities),array_keys($communities)),

    //'#default_value' => ,

    //'#description' => t( '' ),
    '#required' => TRUE,
  );
  $form['lingotek_communities'] = array(
    '#type' => 'hidden',
    '#value' => json_encode($community_integrations),
  );
  $form['lingotek_button_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == LINGOTEK_MENU_LANG_BASE_URL . '/community-select') {
      $null = array_pop($_SESSION['lingotek_setup_path']);
    }

    // if the user went back, remove the last element, which is this page.
    $form['lingotek_back_button'] = lingotek_setup_link(end($_SESSION['lingotek_setup_path']), t('Previous Step'));
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

// END:  Community Select

/**
 * Community Select Screen - Form Submit
 */
function lingotek_community_select_form_submit($form, $form_state) {
  $community_selected = $form_state['values']['lingotek_site_community'];
  variable_set('lingotek_community_identifier', $community_selected);
  $communities = (array) json_decode($form_state['values']['lingotek_communities']);
  $community = $communities[$community_selected];
  variable_set('lingotek_oauth_consumer_id', $community->key);
  variable_set('lingotek_oauth_consumer_secret', $community->secret);
  variable_set('lingotek_community_name', $community->community_name);
  $_SESSION['lingotek_setup_path'][] = LINGOTEK_MENU_LANG_BASE_URL . '/community-select';
  drupal_set_message(t('Your site has been securely connected to your community (@community).', array(
    '@community' => $community_selected,
  )));
  drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/project-vault-select');

  // Move to Project Select Step.
}

/**
 * Edit defaults - Form Layout
 */
function lingotek_edit_defaults_form() {
  $form = array();
  $api = LingotekApi::instance();
  $project_defaults = variable_get('lingotek_project_defaults', array());
  asort($project_defaults);
  $workflow_defaults = variable_get('lingotek_workflow_defaults', array());
  asort($workflow_defaults);
  $vault_defaults = variable_get('lingotek_vaults_defaults', array());
  $default_workflow_id = variable_get('lingotek_workflow', NULL);
  $curr_workflow = $api
    ->getWorkflow($default_workflow_id);
  if (!empty($curr_workflow)) {
    $workflow_defaults = array(
      $default_workflow_id => $curr_workflow->name,
    ) + $workflow_defaults;
  }
  $form['lingotek_project'] = array(
    '#type' => 'select',
    '#title' => t('Default Project'),
    '#options' => $project_defaults,
    '#default_value' => variable_get('lingotek_project', NULL),
    '#required' => TRUE,
  );
  $form['lingotek_workflow'] = array(
    '#type' => 'select',
    '#title' => t('Default Workflow'),
    '#options' => $workflow_defaults,
    '#default_value' => $default_workflow_id,
    '#required' => TRUE,
  );
  $form['lingotek_vault'] = array(
    '#type' => 'select',
    '#title' => t('Default Vault'),
    '#options' => $vault_defaults,
    '#default_value' => variable_get('lingotek_vault', NULL),
    '#required' => TRUE,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  return $form;
}

/**
 * Edit defaults - Form Submit
 */
function lingotek_edit_defaults_form_submit($form, $form_state) {
  $new_project_id = $form_state['values']['lingotek_project'];
  $new_workflow_id = $form_state['values']['lingotek_workflow'];
  $new_vault_id = $form_state['values']['lingotek_vault'];
  variable_set('lingotek_project', $new_project_id);
  variable_set('lingotek_workflow', $new_workflow_id);
  variable_set('lingotek_vault', $new_vault_id);
  drupal_set_message(t('Your Lingotek project, workflow, and vault selections have been saved.'));
  drupal_goto(LINGOTEK_MENU_MAIN_BASE_URL . '/settings');
}

/**
 * Project Select Screen (for Current Users) - Form Layout
 */
function lingotek_project_vault_select_form() {
  $form = array();
  $community_identity = variable_get('lingotek_community_identifier', NULL);
  list($community_settings, $full_community_data) = lingotek_get_community_settings($community_identity, TRUE);
  if ($community_settings === FALSE) {
    drupal_set_message(t('Error Retrieving Account Information.'), 'error');
    drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/account-settings');

    // Error geting projects.  Go back.
  }
  elseif ($community_settings['project'] === FALSE || $community_settings['workflow'] === FALSE || $community_settings['vault'] === FALSE) {
    drupal_set_message(t('Error Retrieving Account Information.'), 'error');
    drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/account-settings');

    // Error geting projects.  Go back.
  }
  $form['lingotek_user_directions'] = array(
    '#markup' => '<p>Select or create the default project and vault that you would like to use.</p>',
  );
  $form['lingotek_community_data'] = array(
    '#type' => 'hidden',
    '#value' => json_encode($full_community_data),
  );

  // Project
  asort($community_settings['project']);
  $project_already_set = !is_null(variable_get('lingotek_project', NULL));
  $projects_count = count($community_settings['project']);
  $project_options = array(
    1 => t('New') . (!$project_already_set ? ' <i>(' . t('recommended') . ')</i>' : ''),
    0 => t('Existing') . ($project_already_set ? ' <i>(' . t('recommended') . ')</i>' : ''),
  );
  if ($projects_count == 0) {
    unset($project_options[0]);
  }
  $form['project_new_or_existing'] = array(
    '#type' => 'radios',
    '#title' => t('Project'),
    '#default_value' => $project_already_set ? 0 : 1,
    '#options' => $project_options,
    '#required' => TRUE,
  );
  $form['project_new'] = array(
    '#type' => 'textfield',
    //'#title' => t('Project Name'),
    '#default_value' => lingotek_get_site_name(),
    '#description' => t('The name of the project where content will be uploaded'),
    '#size' => 20,
    '#states' => array(
      'invisible' => array(
        ':input[name="project_new_or_existing"]' => array(
          'value' => 0,
        ),
      ),
    ),
  );
  $form['project_existing'] = array(
    '#type' => 'select',
    //'#title' => t('Project Selection'),
    '#options' => $community_settings['project'],
    '#default_value' => variable_get('lingotek_project', NULL),
    '#description' => t('Note: ALL documents uploaded to the project, including documents not from this site, will be affected by actions taken on this site (e.g., adding languages)'),
    '#states' => array(
      'invisible' => array(
        ':input[name="project_new_or_existing"]' => array(
          'value' => 1,
        ),
      ),
    ),
  );

  // Workflow (assume project default for workflow)

  /*
  if ($workflow_count > 1) {

    $form['lingotek_site_workflow'] = array(
      '#title' => t('Workflow'),
      '#type' => 'select',
      '#options' => $community_settings['workflow'],
      //'#default_value' => ,
      '#description' => t('The Workflow to use when translating content.'),
      '#required' => TRUE,
    );
  }
  */

  // Vault
  $form['vault_existing_or_new'] = array(
    '#type' => 'radios',
    '#title' => t('Vault'),
    '#default_value' => 0,
    '#options' => array(
      0 => t('Existing') . ' <i>(' . t('recommended') . ')</i>',
      1 => t('New'),
    ),
    //'#description' => t('The Translation Memory (TM) vault where translations are saved.'),
    '#required' => TRUE,
  );
  $form['vault_existing_or_new'][1]['#states'] = array(
    'invisible' => array(
      ':input[name="project_new_or_existing"]' => array(
        'value' => 0,
      ),
    ),
  );
  $form['vault_existing'] = array(
    '#type' => 'select',
    '#options' => $community_settings['vault'],
    '#default_value' => variable_get('lingotek_vault', NULL),
    '#description' => t('Using a shared TM vault allows translations to be re-used.'),
    '#states' => array(
      'invisible' => array(
        ':input[name="vault_existing_or_new"]' => array(
          'value' => 1,
        ),
      ),
    ),
  );
  $form['vault_new'] = array(
    '#type' => 'textfield',
    //'#title' => t('Vault'),
    '#default_value' => lingotek_get_site_name(),
    '#description' => t('The name of the vault where translation memory will be stored'),
    '#size' => 20,
    '#states' => array(
      'invisible' => array(
        ':input[name="vault_existing_or_new"]' => array(
          'value' => 0,
        ),
      ),
    ),
  );

  // submit, etc.
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == LINGOTEK_MENU_LANG_BASE_URL . '/project-vault-select') {
      $null = array_pop($_SESSION['lingotek_setup_path']);
    }

    // if the user went back, remove the last element, which is this page.
    $form['lingotek_back_button'] = lingotek_setup_link(end($_SESSION['lingotek_setup_path']), t('Previous Step'));
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

// END:  Project Select

/**
 * Project Select Screen - Form Submit
 */
function lingotek_project_vault_select_form_submit($form, $form_state) {
  $auto_provision_project = FALSE;
  $params = array();

  // Project
  if ($form_state['values']['project_new_or_existing']) {

    // new
    $auto_provision_project = TRUE;
    $project_name = $form_state['values']['project_new'];
    $params['projectName'] = $project_name;
  }
  else {

    // existing
    $project_id = $form_state['values']['project_existing'];
    $lingotek_community_data = json_decode($form_state['values']['lingotek_community_data']);
    $workflow_id = $lingotek_community_data->project->{$project_id}->workflowId;
    variable_set('lingotek_project', $project_id);
    variable_set('lingotek_workflow', $workflow_id);
    variable_set('lingotek_translate_comments_workflow_id', $workflow_id);
    variable_set('lingotek_translate_config_workflow_id', $workflow_id);
  }

  // Vault
  if ($form_state['values']['vault_existing_or_new']) {

    // new
    $vault_name = $form_state['values']['vault_new'];
    $params['tmVaultName'] = $vault_name;
  }
  else {

    // existing
    $vault_id = $form_state['values']['vault_existing'];
    variable_set('lingotek_vault', $vault_id);
    $params['tmVaultId'] = $vault_id;
  }
  if ($auto_provision_project) {
    $notify_url = lingotek_notify_url_generate();
    $params['callbackUrl'] = $notify_url;
    $api = LingotekApi::instance();
    $response = $api
      ->request('autoProvisionProject', $params);
    if ($response->results == 'success') {
      $project_id = $response->project_id;
      $workflow_id = $response->workflow_id;
      $vault_id = $response->tm_vault_id;
      variable_set('lingotek_project', $project_id);
      variable_set('lingotek_workflow', $workflow_id);
      variable_set('lingotek_translate_comments_workflow_id', $workflow_id);
      variable_set('lingotek_translate_config_workflow_id', $workflow_id);
      variable_set('lingotek_vault', $vault_id);
      variable_set('lingotek_integration_method', $response->integration_method_id);
      variable_set('lingotek_notify_url', $notify_url);
    }
  }
  $_SESSION['lingotek_setup_path'][] = LINGOTEK_MENU_LANG_BASE_URL . '/project-vault-select';
  drupal_set_message(t('Your Lingotek project, workflow, and vault selections have been setup and saved.'));
  drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/setup-language-switcher');
}
function lingotek_setup_language_switcher_form($form, $form_state) {
  drupal_add_js(drupal_get_path('module', 'lingotek') . '/js/lingotek.admin.js');
  $current_theme = variable_get('theme_default', 'none');

  //global $theme_key;
  $query = db_select('block', 'b');
  $query
    ->fields('b');
  $query
    ->condition('module', 'locale');
  $query
    ->condition('delta', 'language');
  $query
    ->condition('theme', $current_theme);
  $result = $query
    ->execute();
  $block = $result
    ->fetchAssoc();
  $block_enabled = $block['status'];
  $block_regions = system_region_list($current_theme, REGIONS_VISIBLE);
  $default_region = "sidebar_first";
  $default_region_value = array_key_exists($block['region'], $block_regions) ? $block['region'] : (array_key_exists($default_region, $block_regions) ? $default_region : NULL);
  $form = array(
    '#type' => 'item',
    '#title' => t('Default Language Switcher'),
    'actions' => array(
      '#type' => 'actions',
    ),
  );
  $form['theme'] = array(
    '#type' => 'hidden',
    '#value' => $current_theme,
  );
  $form['enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the default language switcher'),
    '#default_value' => TRUE,
  );
  $form['region'] = array(
    '#type' => 'select',
    '#description' => t('The region where the switcher will be displayed.'),
    '#options' => $block_regions,
    '#default_value' => $default_region_value,
    '#states' => array(
      'invisible' => array(
        ':input[name="enabled"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == LINGOTEK_MENU_LANG_BASE_URL . '/setup-language-switcher') {
      $null = array_pop($_SESSION['lingotek_setup_path']);
    }

    // if the user went back, remove the last element, which is this page.
    $form['lingotek_back_button'] = lingotek_setup_link(end($_SESSION['lingotek_setup_path']), t('Previous Step'));
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  $output = array(
    $form,
  );
  $output[] = lingotek_support_footer();
  return $output;
}
function lingotek_setup_language_switcher_form_submit($form, $form_state) {
  lingotek_admin_language_switcher_form_submit($form, $form_state);
  $_SESSION['lingotek_setup_path'][] = LINGOTEK_MENU_LANG_BASE_URL . '/setup-language-switcher';
  drupal_goto(LINGOTEK_MENU_LANG_BASE_URL . '/node-translation-settings');
}

/**
 * Entity Translation Settings - Form Layout
 * Select the Content Types and Fields to be Translated.
 */
function lingotek_setup_node_translation_settings_form($form, $form_state) {
  drupal_add_js(drupal_get_path('module', 'lingotek') . '/js/lingotek.admin.js');
  $fs['values'] = lingotek_get_global_profile();
  $fs['values']['profile_id'] = LingotekSync::PROFILE_CUSTOM;
  $form = lingotek_admin_entity_bundle_profiles_form($form, $form_state, 'node');
  $content_defaults = lingotek_admin_profile_form($form, $fs);
  $form['lingotek_nodes_translation_method'] = $content_defaults['defaults']['lingotek_nodes_translation_method'];
  $form['lingotek_nodes_translation_method']['#weight'] = -3;
  $c = db_select('node', 'n')
    ->fields('n', array(
    'tnid',
  ))
    ->condition('n.tnid', 0, '<>')
    ->distinct()
    ->countQuery()
    ->execute()
    ->fetchField();
  if ($c > 0) {
    $form['lingotek_overwrite_note'] = array(
      '#type' => 'item',
      '#title' => t('You have @count nodes with existing translations', array(
        '@count' => $c,
      )),
      '#states' => array(
        'visible' => array(
          ':input[name="lingotek_nodes_translation_method"]' => array(
            'checked' => FALSE,
          ),
        ),
      ),
      '#weight' => -2,
    );
    $form['lingotek_overwrite'] = array(
      '#type' => 'checkbox',
      '#title' => t('Do not allow Lingotek to translate these nodes. <b>NOTE: Unchecking this option will cause Lingotek to overwrite your current translated content.</b>'),
      '#default_value' => TRUE,
      '#states' => array(
        'visible' => array(
          ':input[name="lingotek_nodes_translation_method"]' => array(
            'checked' => FALSE,
          ),
        ),
      ),
      '#weight' => -1,
    );
  }
  if (isset($_SESSION['lingotek_setup_path']) && is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == lingotek_get_entity_setup_path('node')) {
      $null = array_pop($_SESSION['lingotek_setup_path']);
    }

    // if the user went back, remove the last element, which is this page.
    $form['translation_node']['actions']['lingotek_back_button'] = lingotek_setup_link(end($_SESSION['lingotek_setup_path']), t('Previous Step'));
  }
  unset($form['translation_node']['actions']['submit']);
  $form['translation_node']['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

/**
 * Node Translation Settings - Form Submit
 */
function lingotek_setup_node_translation_settings_form_submit($form, &$form_state) {
  lingotek_admin_entity_bundle_profiles_form_submit($form, $form_state);
  if ($form_state['values']['lingotek_nodes_translation_method'] == 'node' && $form_state['values']['lingotek_overwrite']) {
    $nodes = db_select('node', 'n')
      ->fields('n', array(
      'nid',
      'tnid',
    ))
      ->where('n.nid <> n.tnid AND n.tnid <> 0')
      ->execute()
      ->fetchAll();
    $ops = array();
    foreach ($nodes as $row) {
      $ops[] = array(
        'lingotek_keystore',
        array(
          'node',
          $row->nid,
          'profile',
          LingotekSync::PROFILE_DISABLED,
        ),
      );
      $ops[] = array(
        'lingotek_keystore',
        array(
          'node',
          $row->nid,
          'upload_status',
          LingotekSync::STATUS_TARGET,
        ),
      );
    }
    $batch = array(
      'operations' => $ops,
    );
    batch_set($batch);
    batch_process(lingotek_get_entity_setup_path('node', TRUE));
  }
  else {
    drupal_goto(lingotek_get_entity_setup_path('node', TRUE));
  }
}
function lingotek_setup_comment_translation_settings_form($form, &$form_state) {
  $form = lingotek_admin_entity_bundle_profiles_form($form, $form_state, 'comment', FALSE);
  drupal_add_js(drupal_get_path('module', 'lingotek') . '/js/lingotek.admin.js');
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == lingotek_get_entity_setup_path('comment')) {
      $null = array_pop($_SESSION['lingotek_setup_path']);
    }

    // if the user went back, remove the last element, which is this page.
    $form['translation_comment']['actions']['lingotek_back_button'] = lingotek_setup_link(end($_SESSION['lingotek_setup_path']), t('Previous Step'));
  }
  $form['translation_comment']['#submit'] = array(
    'lingotek_setup_comment_translation_settings_form_submit',
  );
  unset($form['translation_comment']['actions']['submit']);
  $form['translation_comment']['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}
function lingotek_setup_comment_translation_settings_form_submit($form, &$form_state) {
  lingotek_admin_entity_bundle_profiles_form_submit($form, $form_state);
  drupal_goto(lingotek_get_entity_setup_path('comment', TRUE));
}
function lingotek_setup_additional_translation_settings_form($form, &$form_state) {
  drupal_add_js(drupal_get_path('module', 'lingotek') . '/js/lingotek.admin.js');
  $form = lingotek_admin_additional_translation_settings_form($form, $form_state);
  if (!empty($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == lingotek_get_entity_setup_path('config')) {
      $null = array_pop($_SESSION['lingotek_setup_path']);
    }

    // if the user went back, remove the last element, which is this page.
    $form['additional_translation']['actions']['lingotek_back_button'] = lingotek_setup_link(end($_SESSION['lingotek_setup_path']), t('Previous Step'));
  }
  $form['additional_translation']['#submit'] = array(
    'lingotek_setup_additional_translation_settings_form_submit',
  );
  unset($form['additional_translation']['actions']['submit']);
  $form['additional_translation']['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Finish'),
  );
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}
function lingotek_setup_additional_translation_settings_form_submit($form, &$form_state) {

  // WTD: process the submitted options
  lingotek_setup_allowed_translation_formats();
  $operations = array();
  $_SESSION['lingotek_setup_path'][] = lingotek_get_entity_setup_path('config');
  lingotek_admin_additional_translation_settings_form_submit($form, $form_state, $additional_operations = $operations);
}

/**
 * Update the formats allowed to be used for saving blocks and strings, etc. to include HTML
 * 
 * Currently, Lingotek will attempt to translate all filter formats
 */
function lingotek_setup_allowed_translation_formats() {
  $filter_formats = filter_formats();
  $lingotek_supported_formats = array();
  foreach ($filter_formats as $key => $format) {
    $lingotek_supported_formats[$key] = $format->format;
  }
  variable_set('i18n_string_allowed_formats', $lingotek_supported_formats);
}

/**
 * Future Page - Form Layout
 */
function lingotek_setup_node_updates_form($form, $form_state) {
  $source_language = lingotek_get_source_language();
  $form['lingotek_header'] = array(
    '#markup' => '<h1>Node Updates</h1>',
  );

  //$form['lingotek_instructions'] = array( '#markup' => '<div>The Lingotek Translation module has be</div>' );
  $form['lingotek_header_line'] = array(
    '#markup' => '<hr />',
  );
  $form['lingotek_top_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['lingotek_message_1a'] = array(
    '#markup' => '<p>To enable full multilingual functionality on your site we recommend the following:</p>',
  );

  //$form['lingotek_message_1b'] = array( '#markup' => '<div>&nbsp;</div>' );
  $form['title_group'] = array(
    '#type' => 'fieldset',
    '#title' => t('Enable Multilingual Node Titles'),
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
  );
  $form['title_group']['lingotek_message_2a'] = array(
    '#markup' => '<p>Drupal\'s default node titles do not support multiple languages and translations.  For this reason Lingotek uses the Title module.</p>',
  );
  $form['title_group']['lingotek_message_2b'] = array(
    '#markup' => '<p>The Title module modifies your content types and adds a new title field, and copies over the current node titles.  The original node titles are left where they are, so you can switch back at any time.</p>',
  );
  $form['title_group']['lingotek_message_2c'] = array(
    '#markup' => '<p>The Title module will then respond to requests for node titles.</p>',
  );

  //$form['title_group']['lingotek_message_2n'] = array( '#markup' => '<div>&nbsp;</div>' );
  $form['title_group']['lingotek_message_2o'] = array(
    '#markup' => '<p style="padding-top: 10px;"><strong>This change will be made to the following content types:</strong></p>',
  );
  $form['title_group']['lingotek_message_2q'] = array(
    '#markup' => '<ul style="padding-left: 0px;">',
  );
  $form['title_group']['lingotek_message_2r'] = array(
    '#markup' => '<li>A Node Name</li>',
  );
  $form['title_group']['lingotek_message_2s'] = array(
    '#markup' => '</ul>',
  );
  $form['title_group']['transition_node_titles'] = array(
    '#type' => 'checkbox',
    '#title' => t('Yes, Enable Multilingual Node Titles'),
    '#prefix' => '<div style="padding-left: 30px; padding-top: 10px;">',
    '#suffix' => '</div>',
  );
  $form['language_group'] = array(
    '#type' => 'fieldset',
    '#title' => t('Update Nodes with Undefined Languages'),
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
  );
  $form['language_group']['lingotek_message_3a'] = array(
    '#markup' => '<p>Currently you have X nodes that do not identify what language their content is in.</p>',
  );
  $form['language_group']['lingotek_message_3b'] = array(
    '#markup' => '<p>To properly translate a node it needs to have a language defined.</p>',
  );
  $form['language_group']['lingotek_message_3c'] = array(
    '#markup' => '<p>To simplify the process, we can set the language setting for any nodes with an undefined language.</p>',
  );
  $form['language_group']['update_node_language'] = array(
    '#type' => 'checkbox',
    '#title' => t('Yes, Set Nodes with no Specified Language to @language.', array(
      '@language' => $source_language,
    )),
    '#prefix' => '<div style="padding-left: 30px; padding-top: 10px;">',
    '#suffix' => '</div>',
  );
  $form['lingotek_middle_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['lingotek_back_button'] = lingotek_setup_link(LINGOTEK_MENU_LANG_BASE_URL . '/new-account', t('Previous Step'));
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  return $form;
}

/**
 * Setup Button
 */
function lingotek_setup_link($path, $text = 'Previous Step') {
  return array(
    '#markup' => '<span style="margin-right: 15px;">' . l($text, $path) . '</span>',
  );
}

//this covers the case of the link being on the right of a non-default theme button
function lingotek_setup_link_on_right($path, $text = 'Previous Step') {
  return array(
    '#markup' => '<span style="margin-left:5px; margin-right: 15px;">' . l($text, $path) . '</span>',
  );
}
function lingotek_connect_account_link($message, $path, $text = 'Previous Step') {
  return array(
    '#markup' => '<br><span style="margin-left:5px; margin-right: 15px;">' . $message . l($text, $path) . '</span>',
  );
}

/*
 * Get the Lingotek user's current Communities.  Use the V3 API.
 */
function lingotek_list_community_integrations($login, $passwd) {

  // API V4 Connection
  $client = new LingotekSession();
  $client->login_id = $login;
  $client->password = $passwd;
  $client->url = LINGOTEK_API_SERVER . '/lingopoint/api/4';
  $options = array();
  if (!$client
    ->canLogIn()) {
    return array(
      FALSE,
      t('Failed to connect to the Lingotek service: @error', array(
        '@error' => $client
          ->getLastLoginMsg(),
      )),
    );
  }
  $list_community_integrations = $client
    ->request("listCommunityIntegrations", array());
  if ($list_community_integrations->results == "success") {
    foreach ($list_community_integrations->communities as $community) {
      foreach ($community->integration_methods as $integration_method) {
        if (!empty($integration_method->key) && !empty($integration_method->secret)) {

          // select first InboundOAuth Integration keys
          $integration_method->community_name = $community->name;
          $integration_method->community_id = isset($community->id) ? $community->id : $community->name;
          $options[$integration_method->community_id] = $integration_method;
          break;
        }
      }
    }
  }
  return array(
    TRUE,
    $options,
  );
}

/*
 * Get the Lingotek user's current Projects.
 */
function lingotek_get_community_settings($community_identity, $return_complete = FALSE) {
  $api = LingotekApi::instance();
  $options = array();
  $complete = array();

  // get projects
  $options['project'] = array();
  $complete['project'] = array();
  $list_projects = $api
    ->request("listProjects", array(
    'community' => $community_identity,
  ));
  if (isset($list_projects->results) && $list_projects->results == "success") {
    foreach ($list_projects->projects as $project) {
      $complete['project'][$project->id] = $project;
      if ($project->state == 'Active') {

        //if (!empty($project->workflowId)) { // Send back the ProjectID AND WorkflowID.  Joined by |||

        //  $options['project'][$project->id . '|||' . $project->workflowId] = $project->name;

        //}

        //else { // Just send back the Project ID
        $options['project'][$project->id] = $project->name;

        //}
      }
    }
  }

  // get workflows
  $options['workflow'] = array();
  $complete['workflow'] = array();
  $list_workflows = $api
    ->request("listWorkflows", array(
    'community' => $community_identity,
  ));
  if ($list_workflows->results == "success") {
    foreach ($list_workflows->workflows as $workflow) {
      $workflow_key = $workflow->id;
      $complete['workflow'][$workflow_key] = $workflow;
      foreach ($workflow->workflow_steps as $step) {
        if (isset($step->save_to_vault)) {
          $vault = array();
          $vault_match = preg_match('/doc_index_id="([0-9]*)"/', $step->save_to_vault, $vault);
          $workflow_key .= '|||' . $vault[1];
        }
      }
      if ($workflow->active && !$workflow->is_public) {
        $options['workflow'][$workflow_key] = $workflow->name;
      }
    }
  }

  // get TM vaults
  $options['vault'] = array();
  $complete['vault'] = array();
  $list_vaults = $api
    ->request("listTMVaults", array(
    'community' => $community_identity,
  ));
  if ($list_vaults->results == "success") {
    if (isset($list_vaults->personalVaults)) {
      foreach ($list_vaults->personalVaults as $personal_vault) {
        $complete['vault']['PersonalVaults'][$personal_vault->id] = $personal_vault;
        $options['vault']['Personal Vaults'][$personal_vault->id] = $personal_vault->name;
      }
    }
    if (isset($list_vaults->communityVaults)) {
      foreach ($list_vaults->communityVaults as $community_vault) {
        $complete['vault']['CommunityVaults'][$community_vault->id] = $community_vault;
        $options['vault']['Community Vaults'][$community_vault->id] = $community_vault->name;
      }
    }
    if (isset($list_vaults->publicVaults)) {
      foreach ($list_vaults->publicVaults as $public_vault) {
        $complete['vault']['PublicVaults'][$public_vault->id] = $public_vault;
        $options['vault']['Public Vaults'][$public_vault->id] = $public_vault->name;
      }
    }
  }
  return $return_complete ? array(
    $options,
    $complete,
  ) : $options;
}

/**
 * Implement hook_mail()
 */
function lingotek_mail($key, &$message, $params) {
  switch ($key) {
    case 'activation':

      // Activation Email
      $date = date('m/d/Y h:i a');
      $message['subject'] = t('New Community Provisioned - @date', array(
        '@date' => $date,
      ));
      $message['body'][] = t('A new community was provisioned on @date.', array(
        '@date' => $date,
      ));
      $message['body'][] = t('First Name: @firstname', array(
        '@firstname' => $params['first_name'],
      ));
      $message['body'][] = t('Last Name: @lastname', array(
        '@lastname' => $params['last_name'],
      ));
      $message['body'][] = t('Email: @email', array(
        '@email' => $params['email'],
      ));
      $message['body'][] = '';
      break;
  }
}

Functions

Namesort descending Description
lingotek_community_select_form Community Select Screen (for Current Users) - Form
lingotek_community_select_form_submit Community Select Screen - Form Submit
lingotek_connect_account_link
lingotek_edit_defaults_form Edit defaults - Form Layout
lingotek_edit_defaults_form_submit Edit defaults - Form Submit
lingotek_get_community_settings
lingotek_identify_lead Identify lead details
lingotek_identify_tags Identify CMS tags (e.g., distribution channel)
lingotek_list_community_integrations
lingotek_mail Implement hook_mail()
lingotek_project_vault_select_form Project Select Screen (for Current Users) - Form Layout
lingotek_project_vault_select_form_submit Project Select Screen - Form Submit
lingotek_setup Routing: Returning User, New Account or Already Setup
lingotek_setup_account_settings_form Account Settings (for Current Users) - Form
lingotek_setup_account_settings_form_submit Account Settings (for Current Users) - Form Processing
lingotek_setup_additional_translation_settings_form
lingotek_setup_additional_translation_settings_form_submit
lingotek_setup_allowed_translation_formats Update the formats allowed to be used for saving blocks and strings, etc. to include HTML
lingotek_setup_comment_translation_settings_form
lingotek_setup_comment_translation_settings_form_submit
lingotek_setup_language_switcher_form
lingotek_setup_language_switcher_form_submit
lingotek_setup_link Setup Button
lingotek_setup_link_on_right
lingotek_setup_new_account_form New Account - Form
lingotek_setup_new_account_form_submit New Account - Form Processor Provisions a Lingotek account and sends activation notice.
lingotek_setup_new_account_form_validate New Account - Form Validator
lingotek_setup_node_translation_settings_form Entity Translation Settings - Form Layout Select the Content Types and Fields to be Translated.
lingotek_setup_node_translation_settings_form_submit Node Translation Settings - Form Submit
lingotek_setup_node_updates_form Future Page - Form Layout