lingotek.setup.inc in Lingotek Translation 7.3

Same filename and directory in other branches
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_setup_check_credentials()) {
    drupal_goto('admin/config/lingotek/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('Next'),
  );
  $form['lingotek_back_button'] = lingotek_setup_link('admin/config/lingotek/account-settings', t('Already have an 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_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(
        'admin/config/lingotek/new-account',
      );
      drupal_set_message(t('Your new Lingotek account has been setup.'));
      drupal_goto('admin/config/lingotek/language-settings');
    }
    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(
      'admin/config/lingotek/new-account',
    );
    drupal_set_message(t('Your Lingotek account settings have been saved.'));
    drupal_goto('admin/config/lingotek/language-settings');
  }
}

// END:  New Account - Form Processor

/**
 * Account Settings (for Current Users) - Form
 */
function lingotek_setup_account_settings_form() {
  $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' => 'Account Login',
    '#description' => 'Connect an existing Lingotek account.',
  );
  $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('admin/config/lingotek/new-account', t('Need to create an account?'));
  $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'];

  //debug( $login_id );

  //debug( $password );

  // Validate the Account - Can we Login?
  // These are V4 Basic Auth API Calls for Legacy Users
  $communities = lingotek_get_communities_v4($login_id, $password, LINGOTEK_API_SERVER . '/lingopoint/api/4');
  if ($communities === FALSE) {
    drupal_set_message(t('Invalid login or password.'), 'error');
  }
  else {

    // Login Successful:  Valid Account
    $_SESSION['lingotek_setup_path'] = array(
      'admin/config/lingotek/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('admin/config/lingotek/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();

  // V3 API Calls for Legacy Users
  $communities = lingotek_get_communities_v4($login_id, $password, LINGOTEK_API_SERVER . '/lingopoint/api/4');
  if ($communities === FALSE) {
    drupal_set_message(t('Invalid login or password.'), 'error');
    drupal_goto('admin/config/lingotek/account-settings');

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

      // Just one community, use that.
      $community_keys = array_keys($communities);
      $community_id = array_pop($community_keys);
      variable_set('lingotek_community_identifier', $community_id);
      drupal_goto('admin/config/lingotek/project-select');

      // Default path, if they only have 1 community.
    }
    elseif ($count > 1) {

      // More then 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('Error Accessing Account. Please contact customer service.'), 'error');
      drupal_goto('admin/config/lingotek/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>Which community should we associate your Drupal site with?</p>',
  );
  $form['lingotek_top_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['lingotek_site_community'] = array(
    '#title' => t('Community'),
    '#type' => 'select',
    '#options' => $communities,
    //'#default_value' => ,

    //'#description' => t( '' ),
    '#required' => TRUE,
  );
  $form['lingotek_button_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == 'admin/config/lingotek/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['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_identity = $form_state['values']['lingotek_site_community'];
  variable_set('lingotek_community_identifier', $community_identity);
  $_SESSION['lingotek_setup_path'][] = 'admin/config/lingotek/community-select';
  drupal_set_message(t('Your Lingotek Community Settings have been saved.'));
  drupal_goto('admin/config/lingotek/community-settings-select');

  // Move to Project Select Step.
}

/**
 * Project Select Screen (for Current Users) - Form Layout
 */
function lingotek_community_settings_select_form() {
  $login_id = variable_get('lingotek_login_id', '');
  $password = variable_get('lingotek_password', '');
  $form = array();

  // V3 API Call for Legacy Users
  $community_identity = variable_get('lingotek_community_identifier', NULL);
  $community_settings = lingotek_get_community_settings_v4($login_id, $password, $community_identity, LINGOTEK_API_SERVER . '/lingopoint/api/4');
  if ($community_settings === FALSE) {
    drupal_set_message(t('Error Retrieving Account Information.'), 'error');
    drupal_goto('admin/config/lingotek/account-settings');

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

      // Error geting projects.  Go back.
    }
    else {

      // PROJECTS
      $project_count = count($community_settings['project']);
      if ($project_count == 1) {

        // If there is just 1 Project, Auto-Select it.  Then move on to the next step.
        $project_id = '';
        $project_keys = array_keys($community_settings['project']);
        $project_id = array_pop($project_keys);
        variable_set('lingotek_project', $project_id);
      }

      // WORKFLOWS
      $workflow_count = count($community_settings['workflow']);
      if ($workflow_count == 1) {

        // If there is just 1 Workflow, Auto-Select it.  Then move on to the next step.
        $workflow_keys = array_keys($workflow_settings['workflow']);
        $workflow_string = array_pop($workflow_keys);

        // This can come back as the workflow_id ||| vault_id mashed together, so check it first
        if (strpos($workflow_string, '|||')) {
          $parts = explode('|||', $workflow_string);
          $workflow_id = $parts[0];
          $vault_id = $parts[1];
        }
        else {
          $workflow_id = $workflow_string;
        }
        variable_set('lingotek_workflow', $workflow_id);
        if (isset($vault_id)) {

          // If the vault id is passed back, and there is only one workflow choice, pick the associated vault by default
          variable_set('lingotek_vault', $vault_id);
        }
      }

      // VAULTS
      $vault_count = count($community_settings['vault']);
      if ($vault_count == 1) {

        // If there is just 1 Vault, Auto-Select it.  Then move on to the next step.
        $vault_id = array_keys($community_settings['vault'][0]);
        $current_vault = variable_get('lingotek_vault', NULL);
        if ($current_vault && $current_vault != $vault_id) {

          // Something is wrong here.  The workflow is referencing a vault that the user has no access to.
          // I don't know what to do in this case, however, or if it will ever happen.
        }
        variable_set('lingotek_vault', $vault_id);
      }
      if ($project_count == 1 && $workflow_count == 1 && $vault_count == 1) {
        drupal_goto('admin/config/lingotek/language-settings');

        // Default path, if they only have 1 project, workflow, and vault.
      }
      else {
        if ($project_count < 1 || $workflow_count < 1 || $vault_count < 1) {

          // Something went wrong here, so go back.
          drupal_goto('admin/config/lingotek/new-account');
        }
      }
    }
  }
  $form['lingotek_user_directions'] = array(
    '#markup' => '<p>Your account is associated with multiple projects, workflows, or vaults.</p><p>Select the defaults that you would like to use below</p>',
  );
  if ($project_count > 1) {
    $form['lingotek_site_project'] = array(
      '#title' => t('Project'),
      '#type' => 'select',
      '#options' => $community_settings['project'],
      '#default_value' => variable_get('lingotek_project', NULL),
      '#description' => t('The Lingotek Project with which translations will be associated.'),
      '#required' => TRUE,
    );
  }
  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,
    );
  }
  if ($vault_count > 1) {
    $form['lingotek_site_vault'] = array(
      '#title' => t('Vault'),
      '#type' => 'select',
      '#options' => $community_settings['vault'],
      '#default_value' => variable_get('lingotek_vault', NULL),
      '#description' => t('The Translation Memory Vault where translations are saved.'),
      '#required' => TRUE,
    );
  }
  $form['lingotek_button_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == 'admin/config/lingotek/community-settings-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['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

// END:  Project Select

/**
 * Project Select Screen - Form Submit
 */
function lingotek_community_settings_select_form_submit($form, $form_state) {
  $project_id = $form_state['values']['lingotek_site_project'];
  $workflow_string = $form_state['values']['lingotek_site_workflow'];
  $vault_id = $form_state['values']['lingotek_site_vault'];

  /*  // This can come back as just the ProjectID, OR the ProjectID ||| WorkflowID jammed together, so check the string.
    if (strpos($project_string, '|||')) { // Returns a position or false if not found.
      $parts = explode('|||', $project_string);
      $project_id = $parts[0];
      $workflow_id = $parts[1];
    }
    else {
      $project_id = $project_string;
    }*/

  // This can come back as just the WorkflowID, OR the WorkflowID ||| VaultID jammed together, so check the string.
  // Should the vault ID override what is selected, or vice-versa?  Right now it's vice-versa.
  if (strpos($workflow_string, '|||')) {
    $parts = explode('|||', $workflow_string);
    $workflow_id = $parts[0];
    $vault_id_workflow = $parts[1];
  }
  else {
    $workflow_id = $workflow_string;
  }

  /*if (isset($vault_id_workflow) && $vault_id_workflow != $vault_id)) {
      // do something?
    }*/
  variable_set('lingotek_project', $project_id);
  variable_set('lingotek_workflow', $workflow_id);
  variable_set('lingotek_vault', $vault_id);
  $_SESSION['lingotek_setup_path'][] = 'admin/config/lingotek/community-settings-select';
  drupal_set_message(t('Your Lingotek project, workflow, and vault selections have been saved.'));
  drupal_goto('admin/config/lingotek/language-settings');

  // Move to Source Language Select Step.
}

/**
 * Language Selection - Form Layout
 */
function lingotek_setup_language_settings_form() {
  $languages = array(
    '0' => t('Select a Language...'),
    'ar' => t('Arabic'),
    'zh-hans' => t('Chinese (Simplified)'),
    'nl' => t('Dutch'),
    'en' => t('English'),
    'fr' => t('French'),
    'de' => t('German'),
    'it' => t('Italian'),
    'ja' => t('Japanese'),
    'ko' => t('Korean'),
    'pt-br' => t('Portuguese'),
    'ru' => t('Russian'),
    'es' => t('Spanish'),
  );
  $default_language = language_default();
  $source_language = variable_get('lingotek_source_language', $default_language->language);
  $form['lingotek_current_language'] = array(
    '#type' => 'item',
    '#title' => t('Source language'),
    '#description' => t('To get started, select the source language that the website is written in.'),
  );
  $form['lingotek_install_source_language'] = array(
    //'#title' => t('Source Language'),
    '#type' => 'select',
    '#options' => $languages,
    '#default_value' => $source_language,
    '#description' => t('<br/>In most cases, your source language should be the default language. (The current site default language is: <b>' . $default_language->name . '</b>)'),
    //t('The current language your site is written in.'),
    '#required' => TRUE,
  );
  $form['lingotek_button_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == 'admin/config/lingotek/language-settings') {
      $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['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

/**
 * Language Selection - Form Validation
 * Requires a source and target language to be selected.
 */
function lingotek_setup_language_settings_form_validate($form, &$form_state) {
  if ($form_state['values']['lingotek_install_source_language'] == '0') {
    form_set_error('', t('You must select a valid source language.'));
  }
}

/**
 * Language Selection - Form Submit Processing
 * Save source and target language selections.
 * Activate a source or target language if it isn't currently active.
 */
function lingotek_setup_language_settings_form_submit($form, $form_state) {

  // These are the languages that are currently active in this Drupal installation.
  $active_languages = language_list('enabled');
  $source_language = $form_state['values']['lingotek_install_source_language'];

  // if the Source language is not active, activate it.
  if (!array_key_exists($source_language, $active_languages[1])) {
    locale_add_language($source_language);

    // Function from the Locale module.
  }
  variable_set('lingotek_source_language', $form_state['values']['lingotek_install_source_language']);
  $_SESSION['lingotek_setup_path'][] = 'admin/config/lingotek/language-settings';
  drupal_set_message(t('Your language settings have been saved.'));
  drupal_goto('admin/config/lingotek/setup-language-switcher');
}
function lingotek_setup_language_switcher_form($form, $form_state) {
  $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',
      'submit' => array(
        '#type' => 'submit',
        '#value' => t('Next'),
      ),
      'lingotek_back_button' => lingotek_setup_link('admin/config/lingotek/language-settings', t('Previous Step')),
    ),
  );
  $_SESSION['lingotek_setup_path'][] = 'admin/config/lingotek/setup-language-switcher';
  $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',
    '#title' => 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,
        ),
      ),
    ),
  );

  //  $form['detection'] = array(
  //    '#type' => 'select',
  //    '#description' => t("How to decide which language is used to display pages"),
  //    '#options' => array('Session', 'URL'),
  //    '#states' => array(
  //      'invisible' => array(
  //        ':input[name="enabled"]' => array('checked' => FALSE),
  //      ),
  //    ),
  //  );
  $output = array(
    $form,
  );
  return $output;
}
function lingotek_setup_language_switcher_form_submit($form, $form_state) {
  lingotek_admin_language_switcher_form_submit($form, $form_state);
  drupal_goto('admin/config/lingotek/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) {
  $form = lingotek_admin_node_translation_settings_form($form, $form_state);
  if (is_array($_SESSION['lingotek_setup_path'])) {
    if (end($_SESSION['lingotek_setup_path']) == 'admin/config/lingotek/node-translation-settings') {
      $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['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}

/**
 * Node Translation Settings - Ajax Callback 1 (Primary)
 */
function lingotek_content_type_choose_fields_callback($content_type) {
  $selector = '#content_fields_' . $content_type;
  $commands = array();

  // <span id="showhidelink_' .$value->type .'"><a id="showlink_' .$value->type .'"
  // The CHOOSE FIELDS text is currently shown, switch to HIDE FIELDS
  if (in_array('showlink_' . $content_type, $_REQUEST['ajax_html_ids'])) {
    $link = '<a id="hidelink_' . $content_type . '" href="' . url('admin/config/lingotek/content-type-choose-fields-ajax/' . $content_type) . '" class="use-ajax">hide fields</a>';
    $span_selector = '#showhidelink_' . $content_type;
    $commands[] = ajax_command_html($span_selector, $link);
  }
  if (in_array('hidelink_' . $content_type, $_REQUEST['ajax_html_ids'])) {
    $link = '<a id="showlink_' . $content_type . '" href="' . url('admin/config/lingotek/content-type-choose-fields-ajax/' . $content_type) . '" class="use-ajax">choose fields</a>';
    $span_selector = '#showhidelink_' . $content_type;
    $commands[] = ajax_command_html($span_selector, $link);
  }
  $commands[] = ajax_command_invoke($selector, 'toggle');

  //$commands[] = ajax_command_alert( 'Hiding: ' .$data  );
  return ajax_deliver(array(
    '#type' => 'ajax',
    '#commands' => $commands,
  ));
}

/**
 * Node Translation Settings - Ajax Callback - Checkbox Check/Uncheck
 */
function lingotek_content_type_checkbox_callback($form, &$form_state) {
  $triggered_by = $form_state['input']['_triggering_element_name'];

  // IE:  type_article
  $selected_type = substr($triggered_by, 5);

  // This was the content type that was selected.  IE:  article
  $selector = '#content_fields_' . $selected_type;
  $commands = array();

  // A checkbox was just selected.   If it is checked, its value will be its type name.  If it was unchecked, it will be blank.
  $checkbox_value = $form_state['input'][$triggered_by];

  // If the checkbox was un-checked, deselect child checkboxes.
  if ($checkbox_value == '') {

    // NAME: article_SEPERATOR_body
    // removeAttr('checked')
    // 'td[name^=tcol]'
    $checkbox_selector = ':checkbox[name^=' . $selected_type . '_SEPERATOR_]';
    $link_selector = '#togglelink_' . $selected_type;
    $commands[] = ajax_command_invoke($checkbox_selector, 'removeAttr', array(
      'checked',
    ));
    $checkbox_selector2 = ':checkbox[name=title_swap_' . $selected_type . ']';
    $commands[] = ajax_command_invoke($checkbox_selector2, 'removeAttr', array(
      'checked',
    ));
    $commands[] = ajax_command_invoke($selector, 'hide');
    $link = '<a id="showlink_' . $selected_type . '" href="' . url('admin/config/lingotek/content-type-choose-fields-ajax/' . $selected_type) . '" class="use-ajax">choose fields</a>';
    $span_selector = '#showhidelink_' . $selected_type;
    $commands[] = ajax_command_html($span_selector, $link);
  }
  else {

    // If the checkbox was selected, activate the default fields.

    //$commands[] = ajax_command_invoke( $selector, 'show' );
    $checkbox_selector2 = ':checkbox[name=title_swap_' . $selected_type . ']';
    $commands[] = ajax_command_invoke($checkbox_selector2, 'attr', array(
      'checked',
      'checked',
    ));

    // Grab the fields for this Content Type.
    $fields = field_info_instances('node', $selected_type);

    // Loop the fields, outputting them.
    foreach ($fields as $field) {
      $field_label = $field['label'];

      //  Label: Body
      $field_machine_name = $field['field_name'];
      $field_type = $field['widget']['type'];

      // Type: text_textarea_with_summary
      $field_name = $selected_type . '_SEPERATOR_' . $field_machine_name;

      // Name: article_SEPERATOR_body
      // If this is a text field, include it by default.
      if (strpos($field_type, 'text') !== FALSE) {
        $checkbox_selector = ':checkbox[name=' . $field_name . ']';
        $commands[] = ajax_command_invoke($checkbox_selector, 'attr', array(
          'checked',
          'checked',
        ));
      }
    }

    // END:  foreach  $fields
  }

  // END:  checked

  //$commands[] = ajax_command_invoke( $selector, 'toggle' );

  //$commands[] = ajax_command_alert( 'Info: ' . $link_selector );
  return array(
    '#type' => 'ajax',
    '#commands' => $commands,
  );
}

/**
 * Node Translation Settings - Form Submit
 */
function lingotek_setup_node_translation_settings_form_submit($form, &$form_state) {
  lingotek_admin_node_translation_settings_form_submit($form, $form_state);
  drupal_goto('admin/config/lingotek/additional-translation-settings');
}
function lingotek_setup_additional_translation_settings_form($form, &$form_state) {
  $form = lingotek_admin_additional_translation_settings_form($form, $form_state);
  $form['lingotek_support_footer'] = lingotek_support_footer();
  return $form;
}
function lingotek_setup_additional_translation_settings_form_validate($form, &$form_state) {
  lingotek_admin_additional_translation_settings_form_validate($form, $form_state);
}
function lingotek_setup_additional_translation_settings_form_submit($form, &$form_state) {

  // WTD: process the submitted options
  lingotek_admin_additional_translation_settings_form_submit($form, $form_state);
  $_SESSION['lingotek_setup_path'][] = 'admin/config/lingotek/additional-translation-settings';
  $operations = array();
  $operations[] = array(
    'lingotek_cleanup_utility',
    array(
      FALSE,
    ),
  );
  $batch = array(
    'title' => t('Preparing additional translation settings'),
    'operations' => $operations,
  );
  batch_set($batch);
  drupal_set_message(t('You have completed setup successfully!'));
  $redirect = LINGOTEK_MENU_LANG_BASE_URL;
  batch_process($redirect);
}

/**
 * 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_button_spacer'] = array(
    '#markup' => '<div>&nbsp;</div>',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Next'),
  );
  $form['lingotek_back_button'] = lingotek_setup_link('admin/config/lingotek/language-settings', t('Previous Step'));
  return $form;
}

/**
 * Setup Button
 */
function lingotek_setup_link($path = 'admin/config/lingotek/language-settings', $text = 'Previous Step') {
  return array(
    '#markup' => l($text, $path, array(
      '#attributes' => 'margin-left: 20px;',
    )),
  );
}

/**
 * Future Page - Form Submit
 */
function lingotek_setup_node_updates_form_submit($form, $form_state) {
  $transition_node_titles = $form_state['values']['transition_node_titles'];
  $update_node_language = $form_state['values']['update_node_language'];
  if ($transition_node_titles == 1) {

    //dpm( 'Do the Node Titles' );
  }
  if ($update_node_language == 1) {

    //dpm( 'Update The Node Languages' );
  }

  //drupal_goto( 'admin/config/lingotek/setup-complete' );
}

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

  // API V4 Connection
  $client = new LingotekSession();
  $client->login_id = $login;
  $client->password = $passwd;
  $client->url = $url;
  $options = array();
  if (!$client
    ->canLogIn()) {
    return FALSE;
  }
  $list_communities = $client
    ->request("listCommunities", array());
  if ($list_communities->results == "success") {
    foreach ($list_communities->communities as $community) {
      $options[$community->id] = $community->name;
    }
  }
  return $options;
}

/*
 * Get the Lingotek user's current Projects.  Uses the V4 API with Basic Auth.
 */
function lingotek_get_community_settings_v4($login, $passwd, $community_identity, $url) {

  // API V4 Connection
  $client = new LingotekSession();
  $client->login_id = $login;
  $client->password = $passwd;
  $client->url = $url;
  $client->community = $community_identity;
  if (!$client
    ->canLogIn()) {
    return FALSE;
  }
  $options = array();

  // get projects
  $options['project'] = array();
  $list_projects = $client
    ->request("listProjects", array(
    'community' => $community_identity,
  ));
  if ($list_projects->results == "success") {
    foreach ($list_projects->projects as $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();
  $list_workflows = $client
    ->request("listWorkflows", array(
    'community' => $community_identity,
  ));
  if ($list_workflows->results == "success") {
    foreach ($list_workflows->workflows as $workflow) {
      $workflow_key = $workflow->id;
      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];
        }
      }
      $options['workflow'][$workflow_key] = $workflow->name;
    }
  }

  // get TM vaults
  $options['vault'] = array();
  $list_vaults = $client
    ->request("listTMVaults", array(
    'community' => $community_identity,
  ));
  if ($list_vaults->results == "success") {
    if (isset($list_vaults->personalVaults)) {
      foreach ($list_vaults->personalVaults as $personal_vault) {
        $options['vault']['Personal Vaults'][$personal_vault->id] = $personal_vault->name;
      }
    }
    if (isset($list_vaults->communityVaults)) {
      foreach ($list_vaults->communityVaults as $community_vault) {
        $options['vault']['Community Vaults'][$community_vault->id] = $community_vault->name;
      }
    }
    if (isset($list_vaults->publicVaults)) {
      foreach ($list_vaults->publicVaults as $public_vault) {
        $options['vault']['Public Vaults'][$public_vault->id] = $public_vault->name;
      }
    }
  }
  return $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

Name	Description
lingotek_community_select_form	Community Select Screen (for Current Users) - Form
lingotek_community_select_form_submit	Community Select Screen - Form Submit
lingotek_community_settings_select_form	Project Select Screen (for Current Users) - Form Layout
lingotek_community_settings_select_form_submit	Project Select Screen - Form Submit
lingotek_content_type_checkbox_callback	Node Translation Settings - Ajax Callback - Checkbox Check/Uncheck
lingotek_content_type_choose_fields_callback	Node Translation Settings - Ajax Callback 1 (Primary)
lingotek_get_communities_v4
lingotek_get_community_settings_v4
lingotek_identify_lead	Identify lead details
lingotek_identify_tags	Identify CMS tags (e.g., distribution channel)
lingotek_mail	Implement hook_mail()
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_additional_translation_settings_form_validate
lingotek_setup_language_settings_form	Language Selection - Form Layout
lingotek_setup_language_settings_form_submit	Language Selection - Form Submit Processing Save source and target language selections. Activate a source or target language if it isn't currently active.
lingotek_setup_language_settings_form_validate	Language Selection - Form Validation Requires a source and target language to be selected.
lingotek_setup_language_switcher_form
lingotek_setup_language_switcher_form_submit
lingotek_setup_link	Setup Button
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
lingotek_setup_node_updates_form_submit	Future Page - Form Submit
You are here

lingotek.setup.inc in Lingotek Translation 7.3

File

Functions

API Navigation
