janrain_capture_ui.widget.inc in Janrain Registration 7.4

Admin settings menu for Capture 2.0

File

janrain_capture_ui/janrain_capture_ui.widget.inc

<?php

/**
 * @file
 * Admin settings menu for Capture 2.0
 */

/**
 * Settings for countries configuration.
 */
function janrain_capture_ui_settings() {
  $rows = array();
  $header = array(
    t('ID'),
    t('Name'),
    t('Code'),
    t('Language'),
    t('Operations'),
  );
  $countries = janrain_capture_ui_get_all_countries();
  foreach ($countries as $country) {
    $edit_link = l(t('edit settings'), 'admin/config/people/janrain_capture/settings/' . $country['id'] . '/edit');
    $country['operations'] = $edit_link;
    $rows[] = $country;
  }
  $form['table'] = array(
    '#markup' => theme('table', array(
      'header' => $header,
      'rows' => $rows,
      'empty' => t('No countries available'),
    )),
  );
  return $form;
}

/**
 * Sets up the admin settings form for this module.
 */
function janrain_capture_ui_edit_settings($form, &$form_state, $country_id) {
  global $base_url;
  $janrain_capture_main = variable_get('janrain_capture_main2', array());
  if (array_key_exists($country_id, $janrain_capture_main)) {
    $janrain_capture_main = $janrain_capture_main[$country_id];
  }
  $form['country_id'] = array(
    '#type' => 'hidden',
    '#value' => $country_id,
  );
  $form['janrain_capture_main2'] = array(
    '#type' => 'fieldset',
    '#title' => t('Application Settings'),
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['janrain_capture_main2']['capture_app_id'] = array(
    '#type' => 'textfield',
    '#title' => t('Application ID'),
    '#default_value' => !empty($janrain_capture_main['capture_app_id']) ? $janrain_capture_main['capture_app_id'] : '',
  );
  $form['janrain_capture_main2']['capture_client_id'] = array(
    '#type' => 'textfield',
    '#title' => t('Client ID'),
    '#default_value' => !empty($janrain_capture_main['capture_client_id']) ? $janrain_capture_main['capture_client_id'] : '',
  );
  $form['janrain_capture_main2']['capture_client_secret'] = array(
    '#type' => 'textfield',
    '#title' => t('Client Secret'),
    '#default_value' => !empty($janrain_capture_main['capture_client_secret']) ? $janrain_capture_main['capture_client_secret'] : '',
  );
  $form['janrain_capture_main2']['capture_load_js_default'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use default load.js URL'),
    '#description' => t(_janrain_capture_default_loadjs_url()),
    '#default_value' => isset($janrain_capture_main['capture_load_js_default']) ? $janrain_capture_main['capture_load_js_default'] : 1,
  );
  $form['janrain_capture_main2']['capture_load_js_settings'] = array(
    '#type' => 'container',
    '#states' => array(
      'invisible' => array(
        ':input[name="janrain_capture_main2[capture_load_js_default]"]' => array(
          'checked' => TRUE,
        ),
      ),
    ),
  );
  $form['janrain_capture_main2']['capture_load_js_settings']['load_js'] = array(
    '#type' => 'textfield',
    '#title' => t('Load.js file URL'),
    '#description' => t('URL of the load.js file without the protocol.'),
    '#default_value' => !empty($janrain_capture_main['capture_load_js_settings']['load_js']) ? $janrain_capture_main['capture_load_js_settings']['load_js'] : '',
    '#field_prefix' => 'http://',
  );
  $form['janrain_capture_main2']['capture_address'] = array(
    '#type' => 'textfield',
    '#title' => t('Capture URL'),
    '#default_value' => !empty($janrain_capture_main['capture_address']) ? $janrain_capture_main['capture_address'] : '',
    '#description' => t('For example, https://myapp.janraincapture.com.'),
  );
  $form['janrain_capture_main2']['engage_address'] = array(
    '#type' => 'textfield',
    '#title' => t('Engage URL'),
    '#default_value' => !empty($janrain_capture_main['engage_address']) ? $janrain_capture_main['engage_address'] : '',
    '#description' => t('For example, https://myapp.rpxnow.com.'),
  );
  $janrain_capture_ui = variable_get('janrain_capture_ui2', array());
  if (array_key_exists($country_id, $janrain_capture_ui)) {
    $janrain_capture_ui = $janrain_capture_ui[$country_id];
  }

  //$janrain_capture_ui = $janrain_capture_ui[$country_id];
  $form['janrain_capture_ui2'] = array(
    '#type' => 'fieldset',
    '#title' => t('UI Settings'),
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['janrain_capture_ui2']['profile_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable Capture Profiles'),
    '#default_value' => isset($janrain_capture_ui['profile_enabled']) ? $janrain_capture_ui['profile_enabled'] : 1,
    '#description' => t('Override the standard Drupal profiles and use the Janrain Capture profiles.'),
  );
  $janrain_capture_federate = variable_get('janrain_capture_federate2', array());
  if (array_key_exists($country_id, $janrain_capture_federate)) {
    $janrain_capture_federate = $janrain_capture_federate[$country_id];
  }

  //$janrain_capture_federate = $janrain_capture_federate[$country_id];
  $form['janrain_capture_federate2'] = array(
    '#type' => 'fieldset',
    '#title' => t('Federate Settings (optional)'),
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => isset($janrain_capture_federate['capture_sso_enabled']) ? !$janrain_capture_federate['capture_sso_enabled'] : TRUE,
  );
  $form['janrain_capture_federate2']['capture_sso_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable SSO'),
    '#default_value' => isset($janrain_capture_federate['capture_sso_enabled']) ? $janrain_capture_federate['capture_sso_enabled'] : 0,
    '#description' => t('Enable Single Sign On for Capture 2.0.'),
  );
  $form['janrain_capture_federate2']['capture_sso_address'] = array(
    '#type' => 'textfield',
    '#title' => t('SSO domain'),
    '#default_value' => !empty($janrain_capture_federate['capture_sso_address']) ? $janrain_capture_federate['capture_sso_address'] : '',
    '#description' => t('For example, myapp.janrainsso.com.'),
  );
  $form['janrain_capture_federate2']['capture_sso_segment_name'] = array(
    '#type' => 'textfield',
    '#title' => t('SSO Segment Name'),
    '#default_value' => !empty($janrain_capture_federate['capture_sso_segment_name']) ? $janrain_capture_federate['capture_sso_segment_name'] : '',
    '#description' => t('A segment is used to identify a group of sites within your federated web properties to enable a more granular SSO experience. For more information, see http://developers.janrain.com/documentation/federate/segments/'),
  );
  $form['janrain_capture_federate2']['capture_sso_supported_segment_names'] = array(
    '#type' => 'textarea',
    '#title' => t('SSO Supported Segment Names'),
    '#default_value' => !empty($janrain_capture_federate['capture_sso_supported_segment_names']) ? $janrain_capture_federate['capture_sso_supported_segment_names'] : '',
    '#description' => t('This is a list of segments, outside of the SSO Segment Name, that are permitted to access your site via SSO. Segment names should be separated by commas. Example: one,two,three,four'),
  );
  $janrain_capture_backplane = variable_get('janrain_capture_backplane2', array());
  if (array_key_exists($country_id, $janrain_capture_backplane)) {
    $janrain_capture_backplane = $janrain_capture_backplane[$country_id];
  }

  //$janrain_capture_backplane = $janrain_capture_backplane[$country_id];
  $form['janrain_capture_backplane2'] = array(
    '#type' => 'fieldset',
    '#title' => t('Backplane Settings (optional)'),
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => isset($janrain_capture_backplane['backplane_enabled']) ? !$janrain_capture_backplane['backplane_enabled'] : TRUE,
  );
  $form['janrain_capture_backplane2']['backplane_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable Backplane'),
    '#default_value' => isset($janrain_capture_backplane['backplane_enabled']) ? $janrain_capture_backplane['backplane_enabled'] : 0,
    '#description' => t('Enable Backplane server support for Capture 2.0.'),
  );
  $options = array(
    '1.2' => t('1.2'),
    '2' => t('2.0'),
  );
  $form['janrain_capture_backplane2']['backplane_version'] = array(
    '#type' => 'radios',
    '#title' => t('Backplane Version'),
    '#options' => $options,
    '#default_value' => isset($janrain_capture_backplane['backplane_version']) ? $janrain_capture_backplane['backplane_version'] : $options['2'],
  );
  $form['janrain_capture_backplane2']['backplane_server_base_url'] = array(
    '#type' => 'textfield',
    '#title' => t('Backplane server base URL'),
    '#field_prefix' => 'https://',
    '#default_value' => !empty($janrain_capture_backplane['backplane_server_base_url']) ? $janrain_capture_backplane['backplane_server_base_url'] : '',
    '#description' => t(''),
  );
  $form['janrain_capture_backplane2']['backplane_bus_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Backplane bus name'),
    '#default_value' => !empty($janrain_capture_backplane['backplane_bus_name']) ? $janrain_capture_backplane['backplane_bus_name'] : '',
    '#description' => t('For example, ' . $_SERVER['SERVER_NAME']),
  );
  $janrain_capture_fields = variable_get('janrain_capture_fields2', array());
  if (array_key_exists($country_id, $janrain_capture_fields)) {
    $janrain_capture_fields = $janrain_capture_fields[$country_id];
  }

  //$janrain_capture_fields = $janrain_capture_fields[$country_id];
  $form['janrain_capture_fields2'] = array(
    '#type' => 'fieldset',
    '#title' => t('Field Settings'),
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['janrain_capture_fields2']['capture_no_email'] = array(
    '#type' => 'checkbox',
    '#title' => t('Don\'t store email addresses'),
    '#default_value' => isset($janrain_capture_fields['capture_no_email']) ? $janrain_capture_fields['capture_no_email'] : 0,
    '#description' => t('UUID values will be used instead of email addresses in the Drupal database.'),
  );
  $form['janrain_capture_fields2']['capture_enforce_verification'] = array(
    '#type' => 'checkbox',
    '#title' => t('Require email verification'),
    '#default_value' => isset($janrain_capture_fields['capture_enforce_verification']) ? $janrain_capture_fields['capture_enforce_verification'] : 0,
    '#description' => t('Prompt users who have not verified their email address to do so before completing authentication'),
  );
  $form['janrain_capture_fields2']['capture_match_email'] = array(
    '#type' => 'checkbox',
    '#title' => t('Match users by email address'),
    '#default_value' => isset($janrain_capture_fields['capture_match_email']) ? $janrain_capture_fields['capture_match_email'] : 0,
    '#description' => t('Associate user and Capture accounts if both share the same email address.'),
    '#states' => array(
      'enabled' => array(
        ':input[name="janrain_capture_fields2[capture_enforce_verification]"]' => array(
          'checked' => TRUE,
        ),
        ':input[name="janrain_capture_fields2[capture_no_email]"]' => array(
          'checked' => FALSE,
        ),
      ),
    ),
  );
  $form['janrain_capture_fields2']['capture_map_profile_pic'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use profile avatar'),
    '#default_value' => isset($janrain_capture_fields['capture_map_profile_pic']) ? $janrain_capture_fields['capture_map_profile_pic'] : 1,
    '#description' => t('Automatically apply the Capture profile photo to the Drupal user profile avatar.'),
  );
  $form['janrain_capture_fields2']['capture_preferred_photo_variant'] = array(
    '#type' => 'select',
    '#title' => t('Default avatar size'),
    '#options' => array(
      'small' => t('Small'),
      'normal' => t('Normal'),
      'large' => t('Large'),
      'square_thumbnail' => t('Square Thumbnail'),
      'original' => t('Original'),
    ),
    '#default_value' => isset($janrain_capture_fields['capture_preferred_photo_variant']) ? $janrain_capture_fields['capture_preferred_photo_variant'] : 'small',
    '#description' => t('Select the Capture profile photo size you want to use for the Drupal avatar.'),
  );
  $group = 'janrain_capture_share';
  $conf = variable_get($group, array());
  if (array_key_exists($country_id, $conf)) {
    $conf = $conf[$country_id];
  }

  //$conf = $conf[$country_id];
  $form[$group] = array(
    '#type' => 'fieldset',
    '#title' => t('Social Share Settings (optional)'),
    '#group' => 'settings',
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => isset($conf['enabled']) ? !$conf['enabled'] : TRUE,
    '#description' => t('To configure social sharing providers go to !janrain_dashboard.', array(
      '!janrain_dashboard' => l(t('Janrain dashboard'), 'https://rpxnow.com'),
    )),
  );
  $form[$group]['enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable social share'),
    '#default_value' => isset($conf['enabled']) ? $conf['enabled'] : 0,
    '#description' => t('Don\'t forget to edit the social sharing settings for individual !content_types.', array(
      '!content_types' => l(t('content types'), 'admin/structure/types/'),
    )),
  );
  $sgroup = 'nodes';
  $sconf = isset($conf[$sgroup]) ? $conf[$sgroup] : array();
  $form[$group][$sgroup] = array(
    '#type' => 'fieldset',
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Social sharing settings for content'),
  );
  $form[$group][$sgroup]['default_message'] = array(
    '#type' => 'textfield',
    '#title' => t('Default message for shared content'),
    '#default_value' => isset($sconf['default_message']) ? $sconf['default_message'] : JANRAIN_CAPTURE_SHARE_MESSAGE_NODES,
    '#description' => t('Specify the default message text (including tokens) to be used when sharing content.'),
  );
  $form[$group][$sgroup]['default_linktext'] = array(
    '#type' => 'textfield',
    '#title' => t('Default link text for shared content'),
    '#default_value' => isset($sconf['default_linktext']) ? $sconf['default_linktext'] : JANRAIN_CAPTURE_SHARE_LINKTEXT_NODES,
    '#description' => t('Specify the default action description (including tokens) to be used when sharing content.'),
  );
  $form[$group][$sgroup]['default_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Default title for shared content'),
    '#default_value' => isset($sconf['default_title']) ? $sconf['default_title'] : JANRAIN_CAPTURE_SHARE_TITLE_NODES,
    '#description' => t('Specify the default title (including tokens) to be used when sharing content.'),
  );
  $form[$group][$sgroup]['default_summary'] = array(
    '#type' => 'textfield',
    '#title' => t('Default description for shared content'),
    '#default_value' => isset($sconf['default_summary']) ? $sconf['default_summary'] : JANRAIN_CAPTURE_SHARE_SUMMARY_NODES,
    '#description' => t('Specify the default description (including tokens) to be used when sharing content.'),
  );
  $sgroup = 'comments';
  $sconf = isset($conf[$sgroup]) ? $conf[$sgroup] : array();
  $form[$group][$sgroup] = array(
    '#type' => 'fieldset',
    '#tree' => TRUE,
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Social sharing settings for comments'),
  );
  $form[$group][$sgroup]['default_message'] = array(
    '#type' => 'textfield',
    '#title' => t('Default message for shared comments'),
    '#default_value' => isset($sconf['default_message']) ? $sconf['default_message'] : JANRAIN_CAPTURE_SHARE_MESSAGE_COMMENTS,
    '#description' => t('Specify the default message text (including tokens) to be used when sharing comments.'),
  );
  $form[$group][$sgroup]['default_linktext'] = array(
    '#type' => 'textfield',
    '#title' => t('Default link text for shared comments'),
    '#default_value' => isset($sconf['default_linktext']) ? $sconf['default_linktext'] : JANRAIN_CAPTURE_SHARE_LINKTEXT_COMMENTS,
    '#description' => t('Specify the default action description (including tokens) to be used when sharing comments.'),
  );
  $form[$group][$sgroup]['default_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Default title for shared comments'),
    '#default_value' => isset($sconf['default_title']) ? $sconf['default_title'] : JANRAIN_CAPTURE_SHARE_TITLE_COMMENTS,
    '#description' => t('Specify the default title (including tokens) to be used when sharing comments.'),
  );
  $form[$group][$sgroup]['default_summary'] = array(
    '#type' => 'textfield',
    '#title' => t('Default description for shared comments'),
    '#default_value' => isset($sconf['default_summary']) ? $sconf['default_summary'] : JANRAIN_CAPTURE_SHARE_SUMMARY_COMMENTS,
    '#description' => t('Specify the default description (including tokens) to be used when sharing comments.'),
  );

  // Add the token tree UI.
  if (module_exists('token')) {
    $form[$group]['token_help'] = array(
      '#theme' => 'token_tree',
      '#token_types' => array(
        'user',
        'node',
        'comment',
        'site',
      ),
      '#global_types' => FALSE,
    );
  }
  else {
    $form[$group]['token_help'] = array(
      '#markup' => t('<a href="@token_module_link" target="_blank">Token</a> module is not enabled. Enable it if you want to use the token browser here.', array(
        '@token_module_link' => 'http://drupal.org/project/token',
      )),
    );
  }
  $janrain_capture_enforce = variable_get('janrain_capture_enforce', array());
  if (array_key_exists($country_id, $janrain_capture_enforce)) {
    $janrain_capture_enforce = $janrain_capture_enforce[$country_id];
  }
  else {
    $janrain_capture_enforce = 0;
  }

  //$janrain_capture_enforce = $janrain_capture_enforce[$country_id];
  $form['janrain_capture_enforce'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enforce the use of Janrain Capture.'),
    '#default_value' => isset($janrain_capture_enforce) ? $janrain_capture_enforce : 0,
    '#description' => t('Make it impossible to login to this site outside of Janrain Capture.') . '<br />' . t('WARNING: DO NOT enable this setting until you have made at least one Capture user a Drupal Administrator and all of your user accounts have been migrated to Janrain Capture.'),
  );
  $form['#validate'] = array(
    'janrain_capture_ui_edit_settings_validate2',
  );
  $form['#submit'] = array(
    'janrain_capture_ui_edit_settings_submit2',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );
  $form['cancel'] = array(
    '#markup' => l(t('Cancel'), 'admin/config/people/janrain_capture/settings'),
  );
  return $form;

  //return system_settings_form($form);
}

/**
 * Validate callback for the settings form.
 */
function janrain_capture_ui_edit_settings_validate2($form, &$form_state) {
  if ($form_state['values']['janrain_capture_fields2']['capture_match_email'] && !$form_state['values']['janrain_capture_fields2']['capture_enforce_verification']) {
    form_set_error('janrain_capture_fields2][capture_match_email', t('You must enable the Enforce Email Verification setting in order to enable the Match Users on Email setting.'));
  }

  // Do not allow to enable social share if no engage URL is provided.
  if ($form_state['values']['janrain_capture_share']['enabled'] && empty($form_state['values']['janrain_capture_main2']['engage_address'])) {
    form_set_error('janrain_capture_main2][engage_address', t('You must provide an Engage URL in order to enable social share.'));
  }

  // Remove http:// or https:// from the backplane base server URL textfield
  $form_state['values']['janrain_capture_backplane2']['backplane_server_base_url'] = preg_replace('/http(s)?:\\/\\//i', '', $form_state['values']['janrain_capture_backplane2']['backplane_server_base_url']);
}

/**
 * Submit callback for the settings form.
 */
function janrain_capture_ui_edit_settings_submit2($form, &$form_state) {

  // Check to see if default load.js toggle is set
  if ($form_state['values']['janrain_capture_main2']['capture_load_js_default']) {
    $form_state['values']['janrain_capture_ui2']['load_js'] = _janrain_capture_default_loadjs_url();
  }
  else {
    $form_state['values']['janrain_capture_ui2']['load_js'] = $form_state['values']['janrain_capture_main2']['capture_load_js_settings']['load_js'];
  }
  if ($form_state['values']['janrain_capture_share']['enabled']) {
    $api = new JanrainCaptureApi();
    $providers = $api
      ->getShareProviders();
    if (count($providers)) {
      $form_state['values']['janrain_capture_share']['nodes']['providers'] = $providers;
    }
    else {
      $form_state['values']['janrain_capture_share']['enabled'] = 0;
      $form_state['values']['janrain_capture_share']['nodes']['providers'] = array();
      drupal_set_message(t('Social Sharing has been disabled because no providers were found. Please configure one or more providers in the Engage dashboard and try again.'), 'error');
    }
  }
  else {
    $form_state['values']['janrain_capture_share']['nodes']['providers'] = array();
  }
  janrain_capture_ui_edit_settings_submit3($form, $form_state);

  // Rebuild the menu in case the "enforce" setting changed.
  variable_set('menu_rebuild_needed', TRUE);
  $form_state['redirect'] = 'admin/config/people/janrain_capture/settings';
  drupal_set_message(t('The configurations has been saved successfully.'));
}

/**
 * Submit handler to save the configuration in variables. 
 */
function janrain_capture_ui_edit_settings_submit3($form, $form_state) {
  $country_id = $form_state['values']['country_id'];

  //setting janrain_capture_main2 variable
  $janrain_capture_main2 = variable_get('janrain_capture_main2', array());
  $janrain_capture_main2[$country_id] = $form_state['values']['janrain_capture_main2'];
  variable_set('janrain_capture_main2', $janrain_capture_main2);

  //setting janrain_capture_ui2 variable
  $janrain_capture_ui2 = variable_get('janrain_capture_ui2', array());
  $janrain_capture_ui2[$country_id] = $form_state['values']['janrain_capture_ui2'];
  variable_set('janrain_capture_ui2', $janrain_capture_ui2);

  //setting janrain_capture_federate2 variable
  $janrain_capture_federate2 = variable_get('janrain_capture_federate2', array());
  $janrain_capture_federate2[$country_id] = $form_state['values']['janrain_capture_federate2'];
  variable_set('janrain_capture_federate2', $janrain_capture_federate2);

  //setting janrain_capture_backplane2 variable
  $janrain_capture_backplane2 = variable_get('janrain_capture_backplane2', array());
  $janrain_capture_backplane2[$country_id] = $form_state['values']['janrain_capture_backplane2'];
  variable_set('janrain_capture_backplane2', $janrain_capture_backplane2);

  //setting janrain_capture_fields2 variable
  $janrain_capture_fields2 = variable_get('janrain_capture_fields2', array());
  $janrain_capture_fields2[$country_id] = $form_state['values']['janrain_capture_fields2'];
  variable_set('janrain_capture_fields2', $janrain_capture_fields2);

  //setting janrain_capture_share variable
  $janrain_capture_share = variable_get('janrain_capture_share', array());
  $janrain_capture_share[$country_id] = $form_state['values']['janrain_capture_share'];
  variable_set('janrain_capture_share', $janrain_capture_share);

  //setting janrain_capture_enforce variable
  $janrain_capture_enforce = variable_get('janrain_capture_enforce', array());
  $janrain_capture_enforce[$country_id] = $form_state['values']['janrain_capture_enforce'];
  variable_set('janrain_capture_enforce', $janrain_capture_enforce);
}

Functions

Name	Description
janrain_capture_ui_edit_settings	Sets up the admin settings form for this module.
janrain_capture_ui_edit_settings_submit2	Submit callback for the settings form.
janrain_capture_ui_edit_settings_submit3	Submit handler to save the configuration in variables.
janrain_capture_ui_edit_settings_validate2	Validate callback for the settings form.
janrain_capture_ui_settings	Settings for countries configuration.