/drupal7/sites/all/modules/captcha/captcha.inc - Diff - Club Drupal - Forge Centrale Marseille

Révision ac1bc5de

Ajouté par Assos Assos il y a plus de 9 ans

ID ac1bc5de3c1dbb439e582632cecfbfef84d14319
Parent 6bd64071
Enfant aceb9ae7

Weekly update of contrib modules

     /**
      * Helper function for adding/updating a CAPTCHA point.
+     *
      * @param $form_id the form ID to configure.
      * @param captcha_type the setting for the given form_id, can be:
      * @param string $form_id
      *   the form ID to configure.
+     *
      * @param string $captcha_type
      *   the setting for the given form_id, can be:
      *   - 'none' to disable CAPTCHA,
      *   - 'default' to use the default challenge type
      *   - NULL to remove the entry for the CAPTCHA type
      *   - something of the form 'image_captcha/Image'
      *   - an object with attributes $captcha_type->module and $captcha_type->captcha_type
      * @return nothing
      */
     function captcha_set_form_id_setting($form_id, $captcha_type) {
       // Handle 'none'.
-...
           ->execute();
+      }
       else {
         drupal_set_message(t('Failed to set a CAPTCHA type for form %form_id: could not interpret value "@captcha_type"',
           array('%form_id' => $form_id, '@captcha_type' => (string)$captcha_type)), 'warning');
         drupal_set_message(
           t('Failed to set a CAPTCHA type for form %form_id: could not interpret value "@captcha_type"',
           array(
             '%form_id' => $form_id,
             '@captcha_type' => (string) $captcha_type,
+          )
           ),
           'warning'
         );
+      }
+    }
     /**
      * Get the CAPTCHA setting for a given form_id.
+     *
      * @param $form_id the form_id to query for
      * @param $symbolic flag to return as (symbolic) strings instead of object.
      * @param string $form_id
      *   the form_id to query for
+     *
      * @param bool $symbolic
      *   flag to return as (symbolic) strings instead of object.
+     *
      * @return NULL if no setting is known
      * @return NULL
      *   if no setting is known
      *   or a captcha_point object with fields 'module' and 'captcha_type'.
      *   If argument $symbolic is true, returns (symbolic) as 'none', 'default'
      *   or in the form 'captcha/Math'.
      */
     function captcha_get_form_id_setting($form_id, $symbolic=FALSE) {
     function captcha_get_form_id_setting($form_id, $symbolic = FALSE) {
       // Fetch setting from database.
       $result = db_query("SELECT module, captcha_type FROM {captcha_points} WHERE form_id = :form_id",
         array(':form_id' =>  $form_id));
       $result = db_query("SELECT module, captcha_type FROM {captcha_points} WHERE form_id = :form_id", array(':form_id' => $form_id));
       $captcha_point = $result->fetchObject();
       // If no setting is available in database for the given form,
       // but 'captcha_default_challenge_on_nonlisted_forms' is enabled, pick the default type anyway
       if (!$captcha_point && variable_get('captcha_default_challenge_on_nonlisted_forms', FALSE))
+      {
       // but 'captcha_default_challenge_on_nonlisted_forms' is enabled, pick the default type anyway.
       if (!$captcha_point && variable_get('captcha_default_challenge_on_nonlisted_forms', FALSE)) {
         $captcha_point = (object) array('captcha_type' => 'default');
+      }
-...
       return $captcha_point;
+    }
     /**
      * Helper function for generating a new CAPTCHA session.
+     *
      * @param $form_id the form_id of the form to add a CAPTCHA to.
      * @param $status the initial status of the CAPTHCA session.
      * @return the session ID of the new CAPTCHA session.
      * @param string $form_id
      *   the form_id of the form to add a CAPTCHA to.
+     *
      * @param int $status
      *   the initial status of the CAPTHCA session.
+     *
      * @return int
      *   the session ID of the new CAPTCHA session.
      */
     function _captcha_generate_captcha_session($form_id=NULL, $status=CAPTCHA_STATUS_UNSOLVED) {
     function _captcha_generate_captcha_session($form_id = NULL, $status = CAPTCHA_STATUS_UNSOLVED) {
       global $user;
       // Initialize solution with random data.
       $solution = md5(mt_rand());
-...
     /**
      * Helper function for updating the solution in the CAPTCHA session table.
+     *
      * @param $captcha_sid the CAPTCHA session ID to update.
      * @param $solution the new solution to associate with the given CAPTCHA session.
      * @param int $captcha_sid
      *   the CAPTCHA session ID to update.
+     *
      * @param string $solution
      *   the new solution to associate with the given CAPTCHA session.
      */
     function _captcha_update_captcha_session($captcha_sid, $solution) {
       db_update('captcha_sessions')
-...
+    }
     /**
      * Helper function for checking if CAPTCHA is required for user,
      * based on the CAPTCHA persistence setting, the CAPTCHA session ID and
      * Helper function for checking if CAPTCHA is required for user.
+     *
      * Based on the CAPTCHA persistence setting, the CAPTCHA session ID and
      * user session info.
      */
     function _captcha_required_for_user($captcha_sid, $form_id) {
-...
         return TRUE;
+      }
       else {
         $captcha_success_form_ids = isset($_SESSION['captcha_success_form_ids']) ? (array)($_SESSION['captcha_success_form_ids']) : array();
         $captcha_success_form_ids = isset($_SESSION['captcha_success_form_ids']) ? (array) ($_SESSION['captcha_success_form_ids']) : array();
         switch ($captcha_persistence) {
           case CAPTCHA_PERSISTENCE_SKIP_ONCE_SUCCESSFUL:
             return (count($captcha_success_form_ids) == 0);
           case CAPTCHA_PERSISTENCE_SKIP_ONCE_SUCCESSFUL_PER_FORM_TYPE:
             return !isset($captcha_success_form_ids[$form_id]);
+        }
-...
     /**
      * Get the CAPTCHA description as configured on the general CAPTCHA
      * settings page.
      * Get the CAPTCHA description as configured on the general CAPTCHA settings page.
+     *
      * If the locale module is enabled, the description will be returned
      * for the current language the page is rendered for. This language
      * can optionally been overriden with the $lang_code argument.
      * can optionally been overridden with the $lang_code argument.
+     *
      * @param $lang_code an optional language code to get the descripion for.
      * @return a string with (localized) CAPTCHA description.
      * @param string|null $lang_code
      *   an optional language code to get the description for.
+     *
      * @return string
      *   String with (localized) CAPTCHA description.
      */
     function _captcha_get_description($lang_code=NULL) {
     function _captcha_get_description($lang_code = NULL) {
       // If no language code is given: use the language of the current page.
       global $language;
       $lang_code = isset($lang_code) ? $lang_code : $language->language;
-...
     /**
      * Parse or interpret the given captcha_type.
      * @param $captcha_type string representation of the CAPTCHA type,
+     *
      * @param string $captcha_type
      *   string representation of the CAPTCHA type,
      *      e.g. 'default', 'none', 'captcha/Math', 'image_captcha/Image'
      * @return list($captcha_module, $captcha_type)
+     *
      * @return array
      *   list($captcha_module, $captcha_type)
      */
     function _captcha_parse_captcha_type($captcha_type) {
       if ($captcha_type == 'none') {
-...
     /**
      * Helper function to get placement information for a given form_id.
      * @param $form_id the form_id to get the placement information for.
      * @param $form if a form corresponding to the given form_id, if there
+     *
      * @param string $form_id
      *   the form_id to get the placement information for.
+     *
      * @param array $form
      *   if a form corresponding to the given form_id, if there
      *   is no placement info for the given form_id, this form is examined to
      *   guess the placement.
      * @return placement info array (@see _captcha_insert_captcha_element() for more
+     *
      * @return array
      *   placement info array (@see _captcha_insert_captcha_element() for more
      *   info about the fields 'path', 'key' and 'weight'.
      */
     function _captcha_get_captcha_placement($form_id, $form) {
-...
     /**
      * Helper function for searching the buttons in a form.
+     *
      * @param $form the form to search button elements in
      * @return an array of paths to the buttons.
      * @param array $form
      *   the form to search button elements in
+     *
      * @return array
      *   an array of paths to the buttons.
      *   A path is an array of keys leading to the button, the last
      *   item in the path is the weight of the button element
      *   (or NULL if undefined).
-...
     /**
      * Helper function to insert a CAPTCHA element in a form before a given form element.
      * @param $form the form to add the CAPTCHA element to.
      * @param $placement information where the CAPTCHA element should be inserted.
+     *
      * @param array $form
      *   the form to add the CAPTCHA element to.
+     *
      * @param array $placement
      *   information where the CAPTCHA element should be inserted.
      *   $placement should be an associative array with fields:
      *     - 'path': path (array of path items) of the container in the form where the
      *       CAPTCHA element should be inserted.
-...
      *     - 'weight': if 'key' is not NULL: should be the weight of the element defined by 'key'.
      *       If 'key' is NULL and weight is not NULL: set the weight property of the CAPTCHA element
      *       to this value.
      * @param $captcha_element the CAPTCHA element to insert.
+     *
      * @param array $captcha_element
      *   the CAPTCHA element to insert.
      */
     function _captcha_insert_captcha_element(&$form, $placement, $captcha_element) {
       // Get path, target and target weight or use defaults if not available.
-...
         if ($target_weight != NULL) {
           $captcha_element['#weight'] = $target_weight;
+        }
         $form_stepper['captcha'] =  $captcha_element;
         $form_stepper['captcha'] = $captcha_element;
+      }
       // If there is a target available: make sure the CAPTCHA element comes right before it.
       else {
-...
         // and just append the CAPTCHA: sorting will fix the ordering anyway.
         if ($target_weight != NULL) {
           $captcha_element['#weight'] = $target_weight - .1;
           $form_stepper['captcha'] =  $captcha_element;
           $form_stepper['captcha'] = $captcha_element;
+        }
         else {
           // If we can't play with weights: insert the CAPTCHA element at the right position.
-...
           // chop of the end, append the CAPTCHA element and put the end back.
           $offset = array_search($target_key, array_keys($form_stepper));
           $end = array_splice($form_stepper, $offset);
           $form_stepper['captcha'] =  $captcha_element;
           $form_stepper['captcha'] = $captcha_element;
           foreach ($end as $k => $v) {
             $form_stepper[$k] = $v;
+          }
+        }
+      }
+    }

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision ac1bc5de

Ajouté par Assos Assos il y a plus de 9 ans