modules/validation_api/validation_api.module

<?php
// $Id: validation_api.module,v 1.24 2008/07/24 22:29:03 tapocol Exp $

/**
 * @file
 */

define('HOOK_ADD_VALIDATOR', 'add_validator');

/**
 * Implementation of hook_help().
 */
function validation_api_help($path, $arg) {
  switch ($path) {
    case 'admin/help#validation_api':
      $output = '<p>'. t('Validation API offers the ability to create a validation PHP script or Regular-Expression script to validate any field on the site.') .'</p>';
      $output .= '<p>'. t('Validators are the scripts that are run to test if the field is valid. Fields are representatives of any form field on the site that you want to assign a validator to test.') .'</p>';
      return $output;
    case 'admin/build/validation_api':
      $output = '<p>'. t('Validators are the scripts that are run to test if the field is valid. Fields are representatives of any form field on the site that you want to assign a validator to test.') .'</p>';
      return $output;
    case 'admin/build/validation_api/validators':
      $output = '<p>'. t('This page contains all of the validators in the database. You can add/edit your own validators, import validators from other modules, import validators with code, export code for a validator, and clone validators. The update link under Ops (You may or may not see this link) is for imported validators from other modules that are now different from the one in the database.');
      return $output;
    case 'admin/build/validation_api/validators/add':
      $output = '<p>'. t('The rule is the script that is run to validate the value passed to this validator. The code is ran in either PHP or RegEx (depending on the language type you select).') .'</p>';
      $output .= '<p>'. t('If you choose PHP, you need to use $value as the value and (if applicable) use $arg as the argument in the rule. If you choose RegEx, the value will automatically be used and (if applicable) just use %arg as the argument in the rule (e.g. "/^((.)|(\s)){%arg,}$/").') .'</p>';
      $output .= '<p>'. t('Messages may use placeholders to further describe the error. You need to use %field as the placeholder for the name of the field and use %arg as the placeholder for the argument.') .'</p>';
      return $output;
    case 'admin/build/validation_api/validators/edit/%':
      $output = '<p>'. t('The rule is the script that is run to validate the value passed to this validator. The code is ran in either PHP or RegEx (depending on the language type you select).') .'</p>';
      $output .= '<p>'. t('If you choose PHP, you need to use $value as the value and (if applicable) use $arg as the argument in the rule. If you choose RegEx, the value will automatically be used and (if applicable) just use %arg as the argument in the rule (e.g. "/^((.)|(\s)){%arg,}$/").') .'</p>';
      $output .= '<p>'. t('Messages may use placeholders to further describe the error. You need to use %field as the placeholder for the name of the field and use %arg as the placeholder for the argument.') .'</p>';
      return $output;
    case 'admin/build/validation_api/validators/import':
      $output = '<p>'. t('You can check any validator(s) you want imported from modules, and/or you can put code from an export into the text-area.') .'</p>';
      return $output;
    case 'admin/build/validation_api/validators/export':
      $output = '<p>'. t('Check which validators you would like to export. After exporting, copy the code in the text-area and paste into the import text-area to import these validators on other systems.') .'</p>';
      return $output;
    case 'admin/build/validation_api/validators/clone':
      $output = '<p>'. t('Check which validators you would like to clone. This will create a copy of that validator to the database with a number added to the end of the name.') .'</p>';
      return $output;
    case 'admin/build/validation_api/fields':
      $output = '<p>'. t('This page contains all of the fields in the database that have been associated with a validator. You can add/edit your own fields, or you can go to the field you want to add a validator to, and click the link below to add a validator.');
      return $output;
    case 'admin/build/validation_api/fields/add':
      $output = '<p>'. t('The Form ID is the ID of the form the field is located in. The Field Name is the name of the field you want to validate. You can get both of the fields by going to the field and using the link directly below the field.') .'</p>';
      $output .= '<p>'. t('Field Name\'s can have several actual fields grouped together. You can validate all fields by just using the field name. However, if you want to validate each field below it separately, you can use indexes (e.g. field_name[0]).') .'</p>';
      $output .= '<p>'. t('The Argument is an option available if you want to have one validator serve a general purpose, and each field will send an argument for the validation. For example, if you make a validator that tests the minimum-length of the field, you can use the argument to tell the validator the minimum-length of this particular field. Make sure you set-up the validator to accept these arguments, or they will not be applied properly. If you are not using an argument, you can just leave the field blank.') .'</p>';
      return $output;
    case 'admin/build/validation_api/fields/edit/%':
      $output = '<p>'. t('The Form ID is the ID of the form the field is located in. The Field Name is the name of the field you want to validate. You can get both of the fields by going to the field and using the link directly below the field.') .'</p>';
      $output .= '<p>'. t('Field Name\'s can have several actual fields grouped together. You can validate all fields by just using the field name. However, if you want to validate each field below it separately, you can use indexes (e.g. field_name[0]).') .'</p>';
      $output .= '<p>'. t('The Argument is an option available if you want to have one validator serve a general purpose, and each field will send an argument for the validation. For example, if you make a validator that tests the minimum-length of the field, you can use the argument to tell the validator the minimum-length of this particular field. Make sure you set-up the validator to accept these arguments, or they will not be applied properly. If you are not using an argument, you can just leave the field blank.') .'</p>';
      return $output;
  }
}

/**
 * Implementation of hook_form_alter().
 */
function validation_api_form_alter(&$form, $form_state, $form_id) {
  $form = _validation_api_form_fields($form, _validation_api_fields($form_id, TRUE), $form_id, array('password', 'textarea', 'textfield'));
  if (variable_get('ajax_submission', 1) == 1) {
    drupal_add_js(drupal_get_path('module', 'validation_api') .'/validation_api.js');
  }
}

/**
 * Implementation of hook_menu().
 */
function validation_api_menu() {
  $items['admin/build/validation_api'] = array(
    'title' => 'Validation API',
    'description' => t('Create and manage validators and a form field\'s relationship with a validator.'),
    'page callback' => 'validation_api_admin',
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
  );
  $items['admin/build/validation_api/settings'] = array(
    'title' => 'Settings',
    'description' => t('Modify settings for the Validation API system.'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_settings_form'),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'weight' => 2,
  );
  $items['admin/build/validation_api/validators'] = array(
    'title' => 'Validators',
    'description' => t('Create and manage validator rules, messages, etc.'),
    'page callback' => 'validation_api_admin_validators',
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
  );
  $items['admin/build/validation_api/validators/list'] = array(
    'title' => 'List',
    'type' => MENU_DEFAULT_LOCAL_TASK
  );
  $items['admin/build/validation_api/validators/add'] = array(
    'title' => 'Add',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_validators_form'),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_LOCAL_TASK,
    'weight' => 1,
  );
  $items['admin/build/validation_api/validators/import'] = array(
    'title' => 'Import',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_import_form'),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_LOCAL_TASK,
    'weight' => 4,
  );
  $items['admin/build/validation_api/validators/export'] = array(
    'title' => 'Export',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_export_form'),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_LOCAL_TASK,
    'weight' => 5,
  );
  $items['admin/build/validation_api/validators/clone'] = array(
    'title' => 'Clone',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_clone_form'),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_LOCAL_TASK,
    'weight' => 6,
  );
  $items['admin/build/validation_api/validators/edit/%'] = array(
    'title' => 'Edit',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_validators_form', 5),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/validation_api/validators/update/%'] = array(
    'title' => 'Update',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_update_form', 5),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/validation_api/validators/delete/%'] = array(
    'title' => 'Delete',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_validators_delete', 5),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/validation_api/fields'] = array(
    'title' => 'Fields',
    'description' => t('Create and manage a form field\'s validator, argument, etc.'),
    'page callback' => 'validation_api_admin_fields',
    'access callback' => 'user_access',
    'access arguments' => array('administer fields'),
    'file' => 'validation_api.admin.inc',
    'weight' => 1,
  );
  $items['admin/build/validation_api/fields/list'] = array(
    'title' => 'List',
    'type' => MENU_DEFAULT_LOCAL_TASK
  );
  $items['admin/build/validation_api/fields/add'] = array(
    'title' => 'Add',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_fields_form'),
    'access callback' => 'user_access',
    'access arguments' => array('administer fields'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/build/validation_api/fields/edit/%'] = array(
    'title' => 'Edit',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_fields_form', 5),
    'access callback' => 'user_access',
    'access arguments' => array('administer fields'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_CALLBACK,
  );
  $items['admin/build/validation_api/fields/delete/%'] = array(
    'title' => 'Delete',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_admin_fields_delete', 5),
    'access callback' => 'user_access',
    'access arguments' => array('administer validators'),
    'file' => 'validation_api.admin.inc',
    'type' => MENU_CALLBACK,
  );
  $items['validation_api'] = array(
    'page callback' => 'validation_api_ajax_page',
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );
  $items['validation_api_test'] = array(
    'title' => 'Validation API Test',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('validation_api_test_form'),
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
  );

  return $items;
}

function validation_api_test_form () {
  $form['text_test'] = array(
    '#type' => 'textfield',
    '#title' => t('Test Text'),
    '#required' => TRUE,
  );
  $form['checkboxes_test'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Test Boxes'),
    '#options' => array(1 => 'One', 2 => 'Two', 3 => 'Three'),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => 'Test Submit',
  );

  return $form;
}

/**
 * Implementation of hook_perm().
 */
function validation_api_perm() {
  return array('administer validators');
}

/**
 * Helper function to incorporate the elements that need validation into the structured form array.
 * Also, adds a 'Add a validator to this field' link to the #suffix of core text-like elements.
 *
 * @param $elements
 *   Structured section of a form array.
 * @param $va_fields
 *   A keyed array of field objects.
 * @param $form_id
 *   Form ID.
 * @param $field_types
 *   An array of field types that allow links to be added to the suffix.
 *
 * @return
 *   Returns the element with possible changes.
 */
function _validation_api_form_fields($elements, $validation_api_fields, $form_id, $field_types) {
  foreach (element_children($elements) as $key) {
    if (isset($validation_api_fields[$key])) {
      $elements[$key]['#element_validate'][] = '_validation_api_validator';
    }
    if (!is_int($key) && isset($elements[$key]['#type']) && user_access('administer validators') && in_array($elements[$key]['#type'], $field_types)) {
      $elements[$key]['#suffix'] = (isset($elements[$key]['#suffix']) ? $elements[$key]['#suffix'] : '') .'<div class="va_link">'. l(t('Add a validator to this field'), 'admin/build/validation_api/fields/add', array('query' => array('form_id' => $form_id, 'form_field' => $key))) .'</div>';
    }
    if (is_array($elements[$key])) {
      $elements[$key] = _validation_api_form_fields($elements[$key], $validation_api_fields, $form_id, $field_types);
    }
  }

  return $elements;
}

/**
 * Helper function to get each field that needs validation from the form ID.
 *
 * @param $form_id
 *   Form ID.
 *
 * @return
 *   Returns a keyed array of field validator objects.
 *
 * array(
 *   $field1_name => array(
 *     $field1_validator1->obj,
 *     $field1_validator2->obj,
 *     ...
 *   ),
 *   $field2_name => array(
 *     $field2_validator1->obj,
 *     $field2_validator2->obj,
 *     ...
 *   ),
 *   ...
 * );
 */
function _validation_api_fields($form_id, $unique = FALSE) {
  $result = db_query('SELECT * FROM {validation_api_fields} WHERE form_id = "%s"', $form_id);
  $fields = array();
  while ($obj = db_fetch_object($result)) {
    $fields[$obj->form_field][] = $obj;
  }

  if ($unique) {
    foreach ($fields as $name => $field) {
      $pos = strpos($name, '[');
      if ($pos !== FALSE) {
        $new_name = substr($name, 0, $pos);
        if (isset($fields[$new_name])) {
          $fields[$new_name] = array_merge($fields[$new_name], $field);
        }
        else {
          $fields[$new_name] = $field;
        }
        unset($fields[$name]);
      }
    }
  }

  return $fields;
}

/**
 * Get an object for every validator in the database.
 *
 * @return
 *   Returns a keyed array of validator objects.
 *
 * array(
 *   $validator1_id => $validator1->obj,
 *   $validator2_id => $validator2->obj,
 *   ...
 * );
 */
function _validation_api_validators() {
  $validators = array();
  $result = db_query('SELECT * FROM {validation_api_validators}');
  while ($obj = db_fetch_object($result)) {
    $validators[$obj->vavid] = $obj;
  }

  return $validators;
}

/**
 * Get an object for every validator in hooks.
 *
 * @return
 *   Returns a keyed array of validator objects.
 *
 * array(
 *   $validator1_id => $validator1->obj,
 *   $validator2_id => $validator2->obj,
 *   ...
 * );
 */
function _validation_api_validators_from_hook() {
  $validators = array();
  foreach (module_implements(HOOK_ADD_VALIDATOR) as $module) {
    $hook_return = call_user_func($module .'_'. HOOK_ADD_VALIDATOR);
    foreach ($hook_return as $delta => $validator) {
      $validators[$module .'-'. $delta] = $validator;
      $validators[$module .'-'. $delta]->module = $module;
      $validators[$module .'-'. $delta]->delta = $delta;
    }
  }

  return $validators;
}

/**
 * Function that is used in a form element's #element_validate property.
 * This will run the element through the validation process, and set an error if there are any incorrect submissions.
 *
 * @param $element
 *   A form element's keyed array.
 * @param &$form_state
 *   The state of the form.
 *
 * @return
 *   Nothing is returned.
 */
function _validation_api_validator($element, &$form_state) {
  static $validators;
  static $validation_api_fields;

  if (!isset($validators)) {
    $validators = _validation_api_validators();
  }
  if (!isset($validation_api_fields)) {
    $validation_api_fields = _validation_api_fields($form_state['values']['form_id']);
  }

  if (isset($element['#tree']) && $element['#tree']) {
    foreach ($element as $field) {
      if (isset($field['#name'])) {
        if (isset($validation_api_fields[$field['#name']])) {
          unset($field['#tree']);
          _validation_api_validator($field, $form_state);
        }
        $pos = strpos($field['#name'], '[');
        if ($pos !== FALSE && isset($validation_api_fields[substr($field['#name'], 0, $pos)])) {
          $field['#name'] = substr($field['#name'], 0, $pos);
          unset($field['#tree']);
          _validation_api_validator($field, $form_state);
        }
      }
    }
  }
  else {
    foreach ($validation_api_fields[$element['#name']] as $validation_api_field) {
      $value = (is_array($element['#value']) ? $element['#value']['value'] : $element['#value']);
      if (!(is_null($value) || $value == '') || !$validation_api_field->allow_empty) {
        if (isset($validation_api_field->arg)) {
          $arg = $validation_api_field->arg;
        }

        $validator = $validators[$validation_api_field->vavid];

        switch ($validator->type) {
          case 'php':
            // Run the PHP code validation.
            if (!eval($validator->rule)) {
              $message = $validation_api_field->message;
              // Set up the substitution strings for the message.
              $substitutes['%field'] = $element['#name'];
              if (isset($arg)) {
                $substitutes['%arg'] = $arg;
              }

              form_set_error($element['#name'], t($message, $substitutes));
            }
          break;
          case 'regex':
            // Make argument change, if applicable, in regex code.
            $rule = (isset($arg) ? str_replace('%arg', $arg, $validator->rule) : $validator->rule);

            // Run the regular expression validation.
            if (!preg_match($rule, $value)) {
              $message = $validation_api_field->message;
              // Set up the substitution strings for the message.
              $substitutes['%field'] = $element['#name'];
              if (isset($arg)) {
                $substitutes['%arg'] = $arg;
              }

              // Validator rule is in this message just for testing purposes.
              form_set_error($element['#name'], t($message, $substitutes));
            }
          break;
        }
      }
    }
  }
}

/**
 * This function is only here for testing purposes. This will be deprecated, when testing is finished.
 * Implementation of hook_add_validator().
 */
function validation_api_add_validator() {
  $validators[0]->name = 'length';
  $validators[0]->type = 'regex';
  $validators[0]->rule = '/^((.)|(\s)){%arg,}$/';
  $validators[0]->message = '%field must be at least %arg characters.';

  return $validators;
}

/**
 * This is a page callback that is called for running AJAX submissions
 */
function validation_api_ajax_page() {
  // This is just for testing purposes. This will be cleared.
  $obj->test = '';
  foreach ($_POST as $key => $value) {
    $obj->test .= "$key = $value\n";
  }

  // Inside this if statement is revised code from drupal_get_form and drupal_process_form
  if (!empty($_POST['form_id']) && !empty($_POST['form_build_id'])) {
    $form_id = $_POST['form_id'];

    $form_state = array('storage' => NULL, 'submitted' => FALSE);

    // Prepare arguments for drupal_retrieve call later on
    $menu_item = menu_get_item($_GET['action']);
    $args = $menu_item['page_arguments'];
    foreach ($args as $key => $arg) {
      $args[$key] = (array) $arg;
    }
    array_unshift($args, NULL);

    $cacheable = FALSE;

    // If the incoming $_POST contains a form_build_id, we'll check the
    // cache for a copy of the form in question. If it's there, we don't
    // have to rebuild the form to proceed. In addition, if there is stored
    // form_state data from a previous step, we'll retrieve it so it can
    // be passed on to the form processing code.
    if (isset($_POST['form_id']) && $_POST['form_id'] == $form_id && !empty($_POST['form_build_id'])) {
      $form = form_get_cache($_POST['form_build_id'], $form_state);
    }

    // If the previous bit of code didn't result in a populated $form
    // object, we're hitting the form for the first time and we need
    // to build it from scratch.
    if (!isset($form)) {
      $form_state['post'] = $_POST;
      // Use a copy of the function's arguments for manipulation
      $args_temp = $args;
      $args_temp[0] = &$form_state;
      array_unshift($args_temp, $form_id);
      $form = call_user_func_array('drupal_retrieve_form', $args_temp);
      $form_build_id = 'form-'. md5(mt_rand());
      $form['#build_id'] = $form_build_id;
      drupal_prepare_form($form_id, $form, $form_state);
      // Store a copy of the unprocessed form for caching and indicate that it
      // is cacheable if #cache will be set.
      $original_form = $form;
      $cacheable = TRUE;
      unset($form_state['post']);
    }
    $form['#post'] = $_POST;
    $form_state['values'] = array();

    $form = form_builder($form_id, $form, $form_state);
    // Only process the form if it is programmed or the form_id coming
    // from the POST data is set and matches the current form_id.
    if ((!empty($form['#programmed'])) || (!empty($form['#post']) && (isset($form['#post']['form_id']) && ($form['#post']['form_id'] == $form_id)))) {
      drupal_validate_form($form['#post']['form_id'], $form, $form_state);
    }

    $obj->success = is_null(form_get_errors());
    if (!$obj->success) {
      $obj->errors->elements = array_keys(form_get_errors());
      $obj->errors->messages = array_values(form_get_errors());
    }
  }
  // If it is not a valid submission, then return an error.
  else {
    $obj->success = FALSE;
    $obj->errors->elements = array('form');
    $obj->errors->messages = array('There is a problem with validating this form. You may need to reload the page.');
  }

  //header('Content-Type: application/json; charset=UTF-8');
  //echo json_encode($obj);
  drupal_json($obj);
  unset($_SESSION['messages']); // Clears messages, so errors do not show up on the next page

  exit;
}