<?php
// $Id: mollom_test.module,v 1.15 2010-10-09 23:13:01 dries Exp $

/**
 * @file
 * Testing functionality for Mollom module.
 */

/**
 * Implements hook_xmlrpc().
 */
function mollom_test_xmlrpc() {
  return array(
    // $data contains a variable amount of properties, so we cannot specify a
    // signature.
    'mollom.getServerList' => 'mollom_test_get_server_list',
    'mollom.verifyKey' => 'mollom_test_verify_key',
    'mollom.checkContent' => 'mollom_test_check_content',
    'mollom.getImageCaptcha' => 'mollom_test_get_captcha',
    'mollom.checkCaptcha' => 'mollom_test_check_captcha',
    'mollom.sendFeedback' => 'mollom_test_send_feedback',
 );
}

/**
 * XML-RPC callback for mollom.getServerList to retrieve new server list.
 */
function mollom_test_get_server_list($data) {
  $storage = variable_get(__FUNCTION__, array());
  $storage[] = $data;
  variable_set(__FUNCTION__, $storage);

  return array($GLOBALS['base_url'] . '/xmlrpc.php?version=');
}

/**
 * XML-RPC callback for mollom.verifyKey to validate API keys.
 */
function mollom_test_verify_key($data) {
  $storage = variable_get(__FUNCTION__, array());
  $storage[] = $data;
  variable_set(__FUNCTION__, $storage);

  module_load_include('inc', 'mollom');
  module_load_include('php', 'simpletest', 'drupal_web_test_case');
  module_load_include('test', 'mollom', 'tests/mollom');

  if ($data['public_key'] === MOLLOM_TEST_PUBLIC_KEY) {
    return TRUE;
  }
  xmlrpc_error(MOLLOM_ERROR);
}

/**
 * XML-RPC callback for mollom.checkContent to perform textual analysis.
 *
 * @todo Add support for 'redirect' and 'refresh' values.
 */
function mollom_test_check_content($data) {
  $storage = variable_get(__FUNCTION__, array());
  $storage[] = $data;
  variable_set(__FUNCTION__, $storage);

  $response = array();

  // Spam filter: Check post_title and post_body for ham, spam, or unsure.
  if (!isset($data['checks']) || strpos($data['checks'], 'spam') !== FALSE) {
    $spam = FALSE;
    $ham = FALSE;
    foreach (array('post_title', 'post_body') as $key) {
      if (!isset($data[$key])) {
        continue;
      }
      // 'spam' always has precedence.
      if (strpos($data[$key], 'spam') !== FALSE) {
        $spam = TRUE;
      }
      // Otherwise, check for 'ham'.
      elseif (strpos($data[$key], 'ham') !== FALSE) {
        $ham = TRUE;
      }
      // Lastly, take a forced 'unsure' into account.
      elseif (strpos($data[$key], 'unsure') !== FALSE) {
        $spam = TRUE;
        $ham = TRUE;
      }
    }
    if ($spam && $ham) {
      $response['spam'] = MOLLOM_ANALYSIS_UNSURE;
      $quality = 0.5;
    }
    elseif ($spam) {
      $response['spam'] = MOLLOM_ANALYSIS_SPAM;
      $quality = 0;
    }
    elseif ($ham) {
      $response['spam'] = MOLLOM_ANALYSIS_HAM;
      $quality = 1;
    }
    else {
      $response['spam'] = MOLLOM_ANALYSIS_UNKNOWN;
      $quality = NULL;
    }
  }

  // Quality filter.
  if (!isset($data['checks']) || strpos($data['checks'], 'quality') !== FALSE) {
    if (isset($quality)) {
      $response['quality'] = $quality;
    }
    // @todo No idea how quality is calculated during testing without spam
    //   results above.
    else {
      $response['quality'] = 0;
    }
  }

  // Profanity filter.
  if (isset($data['checks']) && strpos($data['checks'], 'profanity') !== FALSE) {
    $profanity = 0.0;
    foreach (array('post_title', 'post_body') as $key) {
      if (isset($data[$key]) && strpos($data[$key], 'profanity') !== FALSE) {
        $profanity = 1.0;
      }
    }
    $response['profanity'] = $profanity;
  }

  if (!empty($data['session_id'])) {
    $response['session_id'] = $data['session_id'];
  }
  else {
    drupal_session_start();
    $response['session_id'] = session_id();
  }

  return $response;
}

/**
 * XML-RPC callback for mollom.getImageCaptcha to fetch a CATPCHA image.
 */
function mollom_test_get_captcha($data) {
  $storage = variable_get(__FUNCTION__, array());
  $storage[] = $data;
  variable_set(__FUNCTION__, $storage);

  drupal_session_start();
  return array(
    'session_id' => !empty($data['session_id']) ? $data['session_id'] : session_id(),
    'url' => $GLOBALS['base_url'] . '/' . drupal_get_path('module', 'mollom') . '/images/powered-by-mollom-2.gif',
  );
}

/**
 * XML-RPC callback for mollom.checkCaptcha to validate a CAPTCHA response.
 *
 * @todo Add support for 'redirect' and 'refresh' values.
 */
function mollom_test_check_captcha($data) {
  $storage = variable_get(__FUNCTION__, array());
  $storage[] = $data;
  variable_set(__FUNCTION__, $storage);

  if ($data['captcha_result'] == 'correct') {
    return TRUE;
  }
  if ($data['captcha_result'] == 'incorrect') {
    return FALSE;
  }
}

/**
 * XML-RPC callback for mollom.sendFeedback to send feedback for a moderated post.
 */
function mollom_test_send_feedback($data) {
  $storage = variable_get(__FUNCTION__, array());
  $storage[] = $data;
  variable_set(__FUNCTION__, $storage);

  if (in_array($data['feedback'], array('spam', 'profanity', 'low-quality', 'unwanted', 'ham'))) {
    return TRUE;
  }
  xmlrpc_error(MOLLOM_ERROR);
}

/**
 * Implements hook_menu().
 */
function mollom_test_menu() {
  $items['mollom-test/form'] = array(
    'title' => 'Mollom test form',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('mollom_test_form'),
    'access callback' => TRUE,
  );
  return $items;
}

/**
 * Implements hook_forms().
 */
function mollom_forms() {
  $forms['mollom_basic_test_form'] = array(
    'callback' => 'mollom_test_form',
  );
  return $forms;
}

/**
 * Implements hook_mollom_form_list().
 */
function mollom_test_mollom_form_list() {
  $forms['mollom_test_form'] = array(
    'title' => 'Mollom test form',
    'entity' => 'mollom_test',
    'entity delete multiple callback' => 'mollom_test_delete_multiple',
    'moderation callback' => 'mollom_test_mollom_form_moderation',
  );
  // The basic test form is identical to the mollom_test_form, but only
  // registers minimal information (e.g., no entity or moderation callback) to
  // integrate with Mollom.
  $forms['mollom_basic_test_form'] = array(
    'title' => 'Mollom basic test form',
  );
  // Same as above, but supports elements for text analysis.
  $forms['mollom_basic_elements_test_form'] = array(
    'title' => 'Mollom basic elements test form',
  );
  return $forms;
}

/**
 * Implements hook_mollom_form_info().
 */
function mollom_test_mollom_form_info($form_id) {
  if ($form_id == 'mollom_basic_test_form') {
    return array();
  }
  $form_info = array(
    'bypass access' => array('administer mollom'),
    'elements' => array(
      'title' => 'Title',
      'body' => 'Body',
      'exclude' => 'Some other field',
      'parent][child' => 'Nested element',
      'field' => 'Multiple value field',
    ),
    'mapping' => array(
      'post_id' => 'mid',
      'post_title' => 'title',
      'author_name' => 'name',
    ),
  );
  return $form_info;
}

/**
 * Form builder for Mollom test form.
 */
function mollom_test_form($form, &$form_state, $mid = NULL) {
  // Due to #limit_validation_errors, submitting the form with the "Add" button
  // will only expose validated values in the submit handler, so our storage may
  // be incomplete. Therefore, the default values always have to be overloaded.
  $form_state += array('storage' => array());
  if (isset($mid) && ($record = mollom_test_load($mid))) {
    $form_state['storage'] = $record;
  }
  $form_state['storage'] += array(
    'mid' => $mid,
    'title' => '',
    'body' => '',
    'exclude' => '',
    'parent' => array('child' => ''),
    'field' => array(),
    'status' => 1,
  );
  // Always add an empty field the user can submit.
  $form_state['storage']['field']['new'] = '';

  $form['#tree'] = TRUE;
  $form['mid'] = array(
    '#type' => 'hidden',
    '#value' => $form_state['storage']['mid'],
  );
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => 'Title',
    '#default_value' => $form_state['storage']['title'],
    '#required' => TRUE,
  );
  $form['body'] = array(
    '#type' => 'textfield',
    '#title' => 'Body',
    '#default_value' => $form_state['storage']['body'],
  );
  $form['exclude'] = array(
    '#type' => 'textfield',
    '#title' => 'Some other field',
    '#default_value' => $form_state['storage']['exclude'],
  );
  $form['parent']['child'] = array(
    '#type' => 'textfield',
    '#title' => 'Nested element',
    '#default_value' => $form_state['storage']['parent']['child'],
  );

  $form['field'] = array(
    '#type' => 'fieldset',
    '#title' => 'Field',
  );
  $weight = 0;
  foreach ($form_state['storage']['field'] as $delta => $value) {
    $form['field'][$delta] = array(
      '#type' => 'textfield',
      '#title' => 'Field ' . $delta,
      '#default_value' => $value,
      '#weight' => $weight++,
    );
  }
  $form['field']['new']['#weight'] = 999;
  $form['field']['submit'] = array(
    '#type' => 'submit',
    '#value' => 'Add',
    '#limit_validation_errors' => array(array('field')),
    '#submit' => array('mollom_test_form_field_submit'),
    '#weight' => 1000,
  );

  $form['status'] = array(
    '#type' => 'checkbox',
    '#title' => 'Published',
    '#default_value' => $form_state['storage']['status'],
    // For simplicity, re-use Mollom module's administration permission.
    '#access' => user_access('administer mollom'),
  );

  $form['actions'] = array('#type' => 'actions');
  $form['actions']['submit'] = array('#type' => 'submit', '#value' => 'Submit');

  return $form;
}

/**
 * Form element submit handler for mollom_test_form().
 */
function mollom_test_form_field_submit($form, &$form_state) {
  // Remove internal Form API values.
  form_state_values_clean($form_state);
  // Remove all empty values of the multiple value field.
  $form_state['values']['field'] = array_filter($form_state['values']['field']);
  // Update the storage with submitted values.
  $form_state['storage'] = $form_state['values'];
  // Store the new value and clear out the 'new' field.
  if (isset($form_state['values']['field']['new'])) {
    $form_state['storage']['field'][] = $form_state['values']['field']['new'];
  }
  unset($form_state['input']['field']['new']);

  $form_state['rebuild'] = TRUE;
}

/**
 * Form submit handler for mollom_test_form().
 */
function mollom_test_form_submit($form, &$form_state) {
  $form_state['values']['field'][] = $form_state['values']['field']['new'];
  unset($form_state['values']['field']['new']);

  // Allow modules to alter the record before saving. This is done for code
  // consistency only.
  // @see mollom_mollom_test_presave()
  form_state_values_clean($form_state);
  module_invoke_all('mollom_test_presave', $form_state['values']);

  // Store submission.
  $update = !empty($form_state['values']['mid']) ? 'mid' : array();
  drupal_write_record('mollom_test', $form_state['values'], $update);

  // Redirect to stored entry.
  $form_state['redirect'] = 'mollom-test/form/' . $form_state['values']['mid'];

  drupal_set_message('Successful form submission.');
  drupal_set_message('<pre>' . var_export($form_state['values'], TRUE) . '</pre>');
}

/**
 * Implements hook_form_alter().
 */
function mollom_test_form_alter(&$form, &$form_state, $form_id) {
  if (variable_get('mollom_test_disable_mollom', FALSE)) {
    $form_state['mollom']['require_analysis'] = FALSE;
    $form_state['mollom']['require_captcha'] = FALSE;
  }
}

/**
 * Mollom form moderation callback for a mollom_test record.
 */
function mollom_test_mollom_form_moderation(&$form, &$form_state) {
  $form_state['values']['status'] = 0;
}

/**
 * Implements hook_mollom_test_presave() on behalf of mollom.module.
 */
function mollom_mollom_test_presave($record) {
  // If an existing record is published and we have session data stored for it,
  // mark the data as moderated.
  if (!empty($record['mid']) && $record['status']) {
    mollom_data_moderate('mollom_test', $record['mid']);
  }
}

/**
 * Loads a {mollom_test} data record by id.
 */
function mollom_test_load($mid) {
  return db_query('SELECT * FROM {mollom_test} WHERE mid = :mid', array(':mid' => $mid))->fetchAssoc();
}

/**
 * Deletes multiple stored {mollom_test} data records.
 *
 * @param $mids
 *   The mids to delete.
 */
function mollom_test_delete_multiple(array $mids) {
  db_delete('mollom_test')
    ->condition('mid', $mids)
    ->execute();
}