Club Drupal

<?php

/**

 * @file

 * Contains the flaggability validator handler.

 */

/**

 * Validates whether an argument is a flaggable/flagged object.

 *

 * @ingroup views

 */

class flag_plugin_argument_validate_flaggability extends views_plugin_argument_validate {

  function construct() {

    parent::construct();

    $this->flag_type = $this->definition['flag type'];

  }

  function option_definition() {

    $options = parent::option_definition();

    $options['flag_name'] = array('default' => '*relationship*');

    $options['flag_test'] = array('default' => 'flaggable');

    $options['flag_id_type'] = array('default' => 'id');

    return $options;

  }

  function options_form(&$form, &$form_state) {

    // If there are no flag relationships set, skip this form of validation.

    $flags = flag_get_flags($this->flag_type);

    if (!$flags) {

      return array();

    }

    $options = $this->flags_options();

    $form['flag_name'] = array(

      '#type' => 'radios',

      '#title' => t('Flag'),

      '#options' => $options,

      '#default_value' => $this->options['flag_name'],

      '#description' => t('Select the flag to validate against.'),

    );

    if (!$options) {

      $form['flag_name']['#description'] = '<p class="warning">' . t('No %type flags exist. You must first <a href="@create-url">create a %type flag</a> before being able to use one.', array('%type' => $this->flag_type, '@create-url' => FLAG_ADMIN_PATH)) . '</p>';

    }

    $form['flag_test'] = array(

      '#type' => 'select',

      '#title' => t('Validate the @type only if', array('@type' => $this->flag_type)),

      '#options' => $this->tests_options(),

      '#default_value' => $this->options['flag_test'],

    );

    // This validator supports the "multiple IDs" syntax. It may not be

    // extremely useful, but similar validators do support this and it's a good

    // thing to be compatible.

    $form['flag_id_type'] = array(

      '#type' => 'select',

      '#title' => t('Argument type'),

      '#options' => array(

        'id' => t('ID'),

        'ids' => t('IDs separated by , or +'),

      ),

      '#default_value' => $this->options['flag_id_type'],

    );

  }

  /**

   * Returns form #options for the flags. Returns empty array if no flags were

   * found.

   */

  function flags_options() {

    $flags = flag_get_flags($this->flag_type);

    if (!$flags) {

      return array();

    }

    else {

      foreach ($flags as $flag) {

        $options[$flag->name] = $flag->get_title();

      }

      $options['*relationship*'] = t('<em>Pick the first flag mentioned in the relationships.</em>');

      return $options;

    }

  }

  /**

   * Migrate existing Views 2 options to Views 3.

   */

  function convert_options(&$options) {

    $prefix = 'validate_argument_' . $this->flag_type . '_';

    if (!isset($options['flag_name']) && !empty($this->argument->options[$prefix . 'flag_name'])) {

      $options['flag_name'] = $this->argument->options[$prefix . 'flag_name'];

      $options['flag_test'] = $this->argument->options[$prefix . 'flag_test'];

      $options['flag_id_type'] = $this->argument->options[$prefix . 'flag_id_type'];

    }

  }

  /**

   * Declares all tests. This scheme makes it easy for derived classes to add

   * and remove tests.

   */

  function tests_info($which = NULL) {

    return array(

      'flaggable' => array(

        'title' => t('It is flaggable'),

        'callback' => 'test_flaggable',

      ),

      'flagged' => array(

        'title' => t('It is flagged at least once'),

        'callback' => 'test_flagged',

      ),

      'flagged_by_current_user' => array(

        'title' => t('It is flagged by the current user'),

        'callback' => 'test_flagged_by_current_user',

      ),

    );

  }

  function tests_options() {

    $options = array();

    foreach ($this->tests_info() as $id => $info) {

      $options[$id] = $info['title'];

    }

    return $options;

  }

  function get_flag() {

    $flag_name = $this->options['flag_name'];

    if ($flag_name == '*relationship*') {

      // Pick the first flag mentioned in the relationships.

      foreach ($this->view->relationship as $id => $handler) {

        // Note: we can't do $handler->field, because the relationship handler's init() may overwrite it.

        if (strpos($handler->options['field'], 'flag') !== FALSE && !empty($handler->options['flag'])) {

          $flag = flag_get_flag($handler->options['flag']);

          if ($flag && $flag->entity_type == $this->flag_type) {

            return $flag;

          }

        }

      }

    }

    return flag_get_flag($flag_name);

  }

  /**

   * Tests whether the argument is flaggable, or flagged, or flagged by current

   * user. These are three possible tests, and which of the three to actually

   * carry out is determined by 'flag_test'.

   */

  function validate_argument($argument) {

    $flag_test = $this->options['flag_test'];

    $id_type   = $this->options['flag_id_type'];

    $flag = $this->get_flag();

    if (!$flag) {

      // Validator is misconfigured somehow.

      return TRUE;

    }

    if ($id_type == 'id') {

      if (!is_numeric($argument)) {

        // If a user is being smart and types several IDs where only one is

        // expected, we invalidate this.

        return FALSE;

      }

    }

    $ids = views_break_phrase($argument, $this);

    if ($ids->value == array(-1)) {

      // Malformed argument syntax. Invalidate.

      return FALSE;

    }

    $ids = $ids->value;

    // Delegate the testing to the particual test method. $passed then

    // holds the IDs that passed the test.

    $tests_info = $this->tests_info();

    $method = $tests_info[$flag_test]['callback'];

    if (method_exists($this, $method)) {

      $passed = $this->$method($ids, $flag);

    }

    else {

      $passed = array();

    }

    // If some IDs exist that haven't $passed our test then validation fails.

    $failed = array_diff($ids, $passed);

    return empty($failed);

  }

  //

  // The actual tests. They return the IDs that passed.

  //

  function test_flaggable($ids, $flag) {

    return array_filter($ids, array($flag, 'applies_to_entity_id'));

  }

  function test_flagged($ids, $flag) {

    // view_break_phrase() is guaranteed to return only integers, so this is SQL safe.

    $flattened_ids = implode(',', $ids);

    return $this->_test_by_sql("SELECT entity_id FROM {flag_counts} WHERE fid = :fid AND entity_id IN ($flattened_ids) AND count > 0", array(':fid' => $flag->fid));

  }

  function test_flagged_by_current_user($ids, $flag) {

    global $user;

    if (!$user->uid) {

      // Anonymous user

      return array();

    }

    $flattened_ids = implode(',', $ids);

    return $this->_test_by_sql("SELECT entity_id FROM {flagging} WHERE fid = :fid AND entity_id IN ($flattened_ids) AND uid = :uid", array(':fid' => $flag->fid, ':uid' => $user->uid));

  }

  // Helper: executes an SQL query and returns all the entity_id's.

  function _test_by_sql($sql, $args) {

    $passed = array();

    $result = db_query($sql, $args);

    foreach ($result as $row) {

      $passed[] = $row->entity_id;

    }

    return $passed;

  }

}