class ldap_views_plugin_query_ldap in Lightweight Directory Access Protocol (LDAP) 7

@file Defines the default query object which builds and execute a ldap query

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_query
      • class \ldap_views_plugin_query_ldap

1 string reference to 'ldap_views_plugin_query_ldap'

ldap_views_views_plugins in ldap_views/ldap_views.views.inc

Implements hook_views_plugins().

File

ldap_views/plugins/ldap_views_plugin_query_ldap.inc, line 7

Defines the default query object which builds and execute a ldap query

class ldap_views_plugin_query_ldap extends views_plugin_query {

  /**
   * The base dn for the LDAP search
   */
  private $basedn = '';

  /**
   * A list of filters to apply to the LDAP search
   */
  private $filter = array();

  /**
   * Builds the necessary info to execute the query.
   */
  function build(&$view) {
    $view
      ->init_pager($view);

    // Let the pager modify the query to add limits.
    $this->pager
      ->query();
  }
  function add_field($table, $field, $alias = '', $params = array()) {

    // We check for this specifically because it gets a special alias.
    if ($table == $this->base_table && $field == $this->base_field && empty($alias)) {
      $alias = $this->base_field;
    }
    if (!$alias && $table) {
      $alias = $table . '_' . $field;
    }

    // Make sure an alias is assigned
    $alias = $alias ? $alias : $field;

    // PostgreSQL truncates aliases to 63 characters: http://drupal.org/node/571548
    // We limit the length of the original alias up to 60 characters
    // to get a unique alias later if its have duplicates
    $alias = drupal_substr($alias, 0, 60);

    // Create a field info array.
    $field_info = array(
      'field' => $field,
      'table' => $table,
      'alias' => $alias,
    ) + $params;

    // Test to see if the field is actually the same or not. Due to
    // differing parameters changing the aggregation function, we need
    // to do some automatic alias collision detection:
    $base = $alias;
    $counter = 0;
    while (!empty($this->fields[$alias]) && $this->fields[$alias] != $field_info) {
      $field_info['alias'] = $alias = $base . '_' . ++$counter;
    }
    if (empty($this->fields[$alias])) {
      $this->fields[$alias] = $field_info;
    }
    return $alias;
  }
  function add_orderby($table, $field, $order, $alias = '', $params = array()) {
    $this->orderby[] = array(
      'field' => $field,
      'direction' => drupal_strtoupper($order),
    );
  }
  function add_basedn($basedn) {
    $this->basedn = !empty($this->basedn) ? $this->basedn : $basedn;
  }
  function add_filter($filter) {
    if (empty($filter)) {
      return;
    }
    $this->filter[] = $filter;
  }

  /**
   * Add a simple WHERE clause to the query. The caller is responsible for
   * ensuring that all fields are fully qualified (TABLE.FIELD) and that
   * the table already exists in the query.
   *
   * @param $group
   *   The WHERE group to add these to; groups are used to create AND/OR
   *   sections. Groups cannot be nested. Use 0 as the default group.
   *   If the group does not yet exist it will be created as an AND group.
   * @param $field
   *   The name of the field to check.
   * @param $value
   *   The value to test the field against. In most cases, this is a scalar. For more
   *   complex options, it is an array. The meaning of each element in the array is
   *   dependent on the $operator.
   * @param $operator
   *   The comparison operator, such as =, <, or >=. It also accepts more complex
   *   options such as IN, LIKE, or BETWEEN. Defaults to IN if $value is an array
   *   = otherwise. If $field is a string you have to use 'formula' here.
   *
   * @see QueryConditionInterface::condition()
   */
  function add_where($group, $field, $value = NULL, $operator = NULL) {

    // Ensure all variants of 0 are actually 0. Thus '', 0 and NULL are all
    // the default group.
    if (empty($group)) {
      $group = 0;
    }

    // Check for a group.
    if (!isset($this->where[$group])) {
      $this
        ->set_where_group('AND', $group);
    }
    $this->where[$group]['conditions'][] = array(
      'field' => $field,
      'value' => $value,
      'operator' => ltrim($operator, '!'),
      'negate' => drupal_substr($operator, 0, 1) == '!',
    );
  }

  /**
   * Construct the filter
   *
   * @param $where
   *   'where' or 'having'.
   */
  function build_condition() {
    $operator = array(
      'AND' => '&',
      'OR' => '|',
    );
    $main_group = '';
    if (!isset($this->where)) {
      $this->where = array();

      // Initialize where clause if not set
    }
    foreach ($this->where as $group => $info) {
      if (!empty($info['conditions'])) {
        $sub_group = '';
        foreach ($info['conditions'] as $key => $clause) {
          $item = '(' . $clause['field'] . $clause['operator'] . $clause['value'] . ')';
          $sub_group .= $clause['negate'] ? "(!{$item})" : $item;
        }
        $main_group .= count($info['conditions']) <= 1 ? $sub_group : '(' . $operator[$info['type']] . $sub_group . ')';
      }
    }
    return count($this->where) <= 1 ? $main_group : '(' . $operator[$this->group_operator] . $main_group . ')';
  }
  function build_ldap_basedn($basedn) {
    return !empty($this->basedn) ? array(
      $this->basedn,
    ) : $basedn;
  }
  function build_contextual_filter() {
    $contextual_filter = '';
    foreach ($this->filter as $condition) {
      $contextual_filter .= drupal_substr($condition, 0, 1) != '(' ? "({$condition})" : $condition;
    }
    return $contextual_filter;
  }
  function build_ldap_filter($filter) {
    $condition = $this
      ->build_condition();
    $contextual = $this
      ->build_contextual_filter();
    $search_filter = !empty($contextual) && !empty($condition) ? '(&' . $condition . $contextual . ')' : $condition . $contextual;
    return !empty($search_filter) ? $search_filter : $filter;
  }

  /**
   * Ensure a table exists in the queue; if it already exists it won't
   * do anything, but if it doesn't it will add the table queue. It will ensure
   * a path leads back to the relationship table.
   *
   * @param $table
   *   The unaliased name of the table to ensure.
   * @param $relationship
   *   The relationship to ensure the table links to. Each relationship will
   *   get a unique instance of the table being added. If not specified,
   *   will be the primary table.
   * @param $join
   *   A views_join object (or derived object) to join the alias in.
   *
   * @return
   *   The alias used to refer to this specific table, or NULL if the table
   *   cannot be ensured.
   */
  function ensure_table($table, $relationship = NULL, $join = NULL) {
    return $table;
  }

  /**
   * Executes the query and fills the associated view object with according
   * values.
   *
   * Values to set: $view->result, $view->total_rows, $view->execute_time,
   * $view->pager['current_page'].
   *
   * $view->result should contain an array of objects.
   */
  function execute(&$view) {
    $start = microtime();
    $entries = array();
    $num_entries = 0;
    if (empty($this->options['qid'])) {
      watchdog('ldap_views', 'Query definition is empty');
      return;
    }
    foreach ($this->fields as $field) {
      $attributes[$field['alias']] = $field['field'];
      $field_alias[$field['alias']] = drupal_strtolower($field['field']);
    }
    $ldap_data = new LdapQuery(ldap_views_get_qid($view));
    $ldap_server = new LdapServer($ldap_data->sid);
    $ldap_server
      ->connect();
    $ldap_server
      ->bind();

    // TODO: Can't use sizelimit if it must be ordered || cache?
    // $ldap_server->search() hasn't orderby (ldap_sort)
    // But we can't use ldap_sort because there's no DESC option
    foreach ($this
      ->build_ldap_basedn($ldap_data->baseDn) as $basedn) {
      $result = $ldap_server
        ->search($basedn, $this
        ->build_ldap_filter($ldap_data->filter), array_values($attributes), 0, $ldap_data->sizelimit, $ldap_data->timelimit, $ldap_data->deref, $ldap_data->scope);

      /***
          // ldap_sort can't be used because there's no DESC option
          if (!empty($this->orderby)) {
            // Array reverse, because the most specific are first - PHP works the opposite way of SQL.
            foreach (array_reverse($this->orderby) as $field) {
              @ldap_sort($ldap_server->connection, $result, $field['field']);
            }
          }
       */
      if ($result !== FALSE) {

        // not an error
        $entries = array_merge($entries, $result);
        $num_entries += array_shift($result);
      }
    }
    $limit = $view->query->limit;
    $offset = $view->query->offset;
    $result = array();
    $sort_fields = array();
    if (!empty($this->orderby)) {
      foreach ($this->orderby as $orderby) {
        $sort_fields[drupal_strtolower($orderby['field'])]['direction'] = $orderby['direction'];
        $sort_fields[drupal_strtolower($orderby['field'])]['data'] = array();
      }
    }
    foreach ($entries as $key => &$entry) {
      if (isset($entry['jpegphoto'])) {
        $entry['jpegphoto'][0] = "<img src='data:image/jpeg;base64," . base64_encode($entry['jpegphoto'][0]) . "' alt='photo' />";
      }
      foreach ($view->field as $field) {
        if (!isset($field_alias[$field->field_alias])) {
          continue;
        }
        $alias = $field_alias[$field->field_alias];
        if (is_array($entry) && array_key_exists($alias, $entry)) {
          if (is_array($entry[$alias])) {
            switch ($field->options['multivalue']) {
              case 'v-all':

                // remove 'count' index
                array_shift($entry[$alias]);
                $entry[$alias] = implode($field->options['value_separator'], $entry[$alias]);
                break;
              case 'v-count':
                $entry[$alias] = $entry[$alias]['count'];
                break;
              case 'v-index':
                $index = $field->options['index_value'] >= 0 ? intval($field->options['index_value']) : $entry[$alias]['count'] + $field->options['index_value'];
                $entry[$alias] = array_key_exists($index, $entry[$alias]) ? $entry[$alias][$index] : $entry[$alias][0];
                break;
            }
          }

          // order criteria
          if (array_key_exists($alias, $sort_fields)) {
            $sort_fields[$alias]['data'][$key] = $entry[$alias];
          }
        }
      }
    }
    if (!empty($this->orderby) && !empty($entries)) {
      $params = array();

      // In PHP 5.3 every parameter in the array has to be a reference when calling array_multisort() with call_user_func_array().
      $asc = SORT_ASC;
      $desc = SORT_DESC;
      foreach ($sort_fields as &$field) {
        $params[] =& $field['data'];
        if (drupal_strtoupper($field['direction']) == 'ASC') {
          $params[] =& $asc;
        }
        else {
          $params[] =& $desc;
        }
      }
      $params[] =& $entries;

      // Some LDAP setups output a 'count' variable first in the array, which changes the array size;
      // temporarily remove it, sort the arrays, and then put it back.
      if (array_key_exists('count', $entries)) {
        $countValue = array_shift($entries);

        // remove the count variable
        $params[] =& $entries;
        call_user_func_array('array_multisort', $params);
        array_unshift($params, $countValue);
      }
      else {
        $params[] =& $entries;
        call_user_func_array('array_multisort', $params);
      }
    }
    for ($i = 0; (!isset($limit) || $i < $limit) && $offset + $i < $num_entries; $i++) {
      $row = array();
      $entry =& $entries[$offset + $i];
      foreach ($view->field as $field) {
        if (!isset($field_alias[$field->field_alias])) {
          continue;
        }
        if (array_key_exists($field_alias[$field->field_alias], $entry)) {
          $row[$field->field_alias] = $entry[$field_alias[$field->field_alias]];
        }
      }
      $result[] = $row;
    }
    $view->result = $result;
    $view->total_rows = $num_entries;
    $view->execute_time = microtime() - $start;
    $view->query->pager->total_items = $num_entries;
    $view->query->pager
      ->update_page_info();
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['qid'] = array(
      'default' => '',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {

    /*
        $ldap_data = entity_load('ldap_data', FALSE);
        $options   = array();
        foreach ($ldap_data as $data) {
            $options[$data->qid] = $data->name;
        }
    */
    $queries = array();
    $queries['all'] = LdapQueryAdmin::getLdapQueryObjects();
    foreach ($queries['all'] as $_sid => $ldap_query) {
      if ($ldap_query->status == 1) {

        //$queries['enabled'][$_qid] = $ldap_query;
        $options[$ldap_query->qid] = $ldap_query->name;
      }
    }

    // ******************************************************
    $form['qid'] = array(
      '#type' => 'select',
      '#title' => t('LDAP Search'),
      '#options' => $options,
      '#default_value' => $this->options['qid'],
      '#description' => t("The LDAP server to query."),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ldap_views_plugin_query_ldap::$basedn	private	property	The base dn for the LDAP search
ldap_views_plugin_query_ldap::$filter	private	property	A list of filters to apply to the LDAP search
ldap_views_plugin_query_ldap::add_basedn		function
ldap_views_plugin_query_ldap::add_field		function
ldap_views_plugin_query_ldap::add_filter		function
ldap_views_plugin_query_ldap::add_orderby		function
ldap_views_plugin_query_ldap::add_where		function	Add a simple WHERE clause to the query. The caller is responsible for ensuring that all fields are fully qualified (TABLE.FIELD) and that the table already exists in the query.
ldap_views_plugin_query_ldap::build		function	Builds the necessary info to execute the query. Overrides views_plugin_query::build
ldap_views_plugin_query_ldap::build_condition		function	Construct the filter
ldap_views_plugin_query_ldap::build_contextual_filter		function
ldap_views_plugin_query_ldap::build_ldap_basedn		function
ldap_views_plugin_query_ldap::build_ldap_filter		function
ldap_views_plugin_query_ldap::ensure_table		function	Ensure a table exists in the queue; if it already exists it won't do anything, but if it doesn't it will add the table queue. It will ensure a path leads back to the relationship table.
ldap_views_plugin_query_ldap::execute		function	Executes the query and fills the associated view object with according values. Overrides views_plugin_query::execute
ldap_views_plugin_query_ldap::options_form		function	Add settings for the ui. Overrides views_plugin_query::options_form
ldap_views_plugin_query_ldap::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_query::$pager	public	property	A pager plugin that should be provided by the display.	1
views_plugin_query::add_signature	public	function	Add a signature to the query, if such a thing is feasible.	1
views_plugin_query::alter	public	function	Let modules modify the query just prior to finalizing it.	1
views_plugin_query::get_aggregation_info	public	function	Get aggregation info for group by queries.	1
views_plugin_query::get_result_entities	public	function	Returns the according entity objects for the given query results.	1
views_plugin_query::init	public	function	Constructor; Create the basic query object and fill with default values.	1
views_plugin_query::options_submit	public	function	Handle any special handling on the validate form. Overrides views_plugin::options_submit	1
views_plugin_query::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_query::query	public	function	Generate a query and a countquery from all of the information supplied to the object. Overrides views_plugin::query	1
views_plugin_query::render_pager	public	function	Render the pager, if necessary.
views_plugin_query::set_group_operator	public	function	Control how all WHERE and HAVING groups are put together.
views_plugin_query::set_limit	public	function	Set a LIMIT on the query, specifying a maximum number of results.
views_plugin_query::set_offset	public	function	Set an OFFSET on the query, specifying a number of results to skip
views_plugin_query::set_where_group	public	function	Create a new grouping for the WHERE or HAVING clause.
views_plugin_query::summary_title	public	function	Returns the summary of the settings in the display. Overrides views_plugin::summary_title