class FrxDrupal in Forena Reports 7.4

Same name and namespace in other branches

@file Provides data blocks for native drupal connections using the default drupal connections.

Hierarchy

class \FrxDataSource
- class \FrxDrupal

Expanded class hierarchy of FrxDrupal

3 string references to 'FrxDrupal'

forena_data_settings_edit in ./forena.admin.inc
forena_forena_plugins in ./forena.module: Self register plugins with forena.
settings.php in repos/drupal/settings.php

File

plugins/FrxDrupal.inc, line 8: Provides data blocks for native drupal connections using the default drupal connections.

View source

class FrxDrupal extends FrxDataSource {

  /**
   * Implements hooks into the drupal applications
   */
  private $database = 'default';

  /**
   * Object constructor
   *
   * @param array $conf Configuration key value pairs.
   * @param string $repos_path Path to location of data block definitions
   * @param string $name Name of data provider
   */
  public function __construct($conf, $repos_path, $name) {
    parent::__construct($conf, $repos_path, $name);
    if (@$conf['database'] && @$conf['database'] != 'default') {
      $this->database = $conf['database'];
    }
    $target = $this->database ? $this->database : 'default';
    $this->db_type = Database::getConnection($target)
      ->databaseType();

    // Set up the stuff required to translate.
    $this->te = new FrxSyntaxEngine(FRX_SQL_TOKEN, ':', $this);
  }
  public function searchTables($str) {
    $str .= '%';
    $rs = db_query($this
      ->searchTablesSQL(), array(
      ':str' => $str,
    ));
    if ($rs) {
      return $rs
        ->fetchCol();
    }
  }

  /**
   * Generate a list of columns for a table.
   * @param unknown $table
   * @param unknown $str
   * @return An
   */
  public function searchTableColumns($table, $str) {
    $str .= '%';
    $table = trim($table, '{} ');
    $key = $this->database ? $this->database : 'default';
    $info = Database::getConnectionInfo($key);
    $database = $info[$key]['database'];
    $rs = db_query($this
      ->searchTableColumnsSQL(), array(
      ':str' => $str,
      ':database' => $database,
      ':table' => $table,
    ));
    if ($rs) {
      return $rs
        ->fetchCol();
    }
  }
  public function query($sql, $options = array()) {
    if ($this->database != 'default') {
      db_set_active($this->database);
    }

    // Load the types array based on data
    $this->types = isset($options['type']) ? $options['type'] : array();

    // Load the block from the file
    $xml = '';
    $sql = $this->te
      ->replace($sql);
    try {
      if (@(int) $options['limit']) {
        $rs = db_query_range($sql, 0, (int) $options['limit']);
      }
      else {
        $rs = db_query($sql);
      }
    } catch (PDOException $e) {
      watchdog_exception('error', $e);
      $line = $e
        ->getLine();
      $text = $e
        ->getMessage();

      //if (user_access('build forena sql blocks')) {
      if (!$this->block_name) {
        $short = t('%e', array(
          '%e' => $text,
          '%l' => $line,
        ));
      }
      else {
        $short = t('SQL Error in %b.sql', array(
          '%b' => $this->block_name,
        ));
      }
      drupal_set_message($short, 'error', FALSE);
      if ($this->database != 'default') {
        db_set_active();
      }
      return;
    }
    if ($this->database != 'default') {
      db_set_active();
    }
    return $rs;
  }

  /**
   * Get data based on file data block in the repository.
   *
   * @param String $block_name
   * @param Array $parm_data
   * @param Query $subQuery
   */
  public function sqlData($sql, $options = array()) {
    $rs = $this
      ->query($sql, $options);
    $entity_map = array();
    $select_fields = array();
    $rownum = 0;
    if (!$rs) {
      return;
    }
    if (@$options['return_type'] == 'raw') {
      return $rs;
    }
    $xml = new SimpleXMLElement('<table/>');
    if ($rs && $rs
      ->columnCount()) {
      foreach ($rs as $data) {
        $rownum++;
        $row_node = $xml
          ->addChild('row');
        $row_node['num'] = $rownum;
        foreach ($data as $key => $value) {
          $row_node
            ->addChild($key, htmlspecialchars($value));
        }

        /* If we are querying entities, we will store away IDs
         * for later querying and XML processing in the
         * loadEntitys method
         */
        if (@$options['entity_type'] && @$options['entity_id']) {
          $display = @$options['entity_display'];
          $id_key = $options['entity_id'];
          $type = $options['entity_type'];
          $id = $data->{$id_key};
          if ($id) {
            $entity_map[$id][] = $row_node;
            $select_fields[$id] = $data;
          }
        }
      }
    }
    if ($entity_map) {
      $this
        ->loadEntities($type, $entity_map, $select_fields, $display);
    }
    if ($this->debug) {
      $d = $xml ? htmlspecialchars($xml
        ->asXML()) : '';
      $this
        ->debug('SQL: ' . $sql, '<pre> SQL:' . $sql . "\n XML: " . $d . "\n</pre>");
    }
    return $xml;
  }

  /**
   * Perform a bulk load of entities 100 at a time and then join data back onto the simplexml already created.
   * @param $type Type of entity being loaded.
   * @param $entity_map Map of entity ids to nodes.
   */
  private function loadEntities($type, $entity_map, $select_fields, $display = array()) {

    // Do these 100 at a time for performance reasons
    $chunks = array_chunk($entity_map, 100, TRUE);
    foreach ($chunks as $chunk) {
      $ids = array_keys($chunk);
      $data = entity_load($type, $ids);
      if ($data) {
        foreach ($data as $id => $e) {

          // Get node permissions
          $access = $type == 'node' ? node_access('view', $e) : TRUE;
          if (isset($entity_map[$id])) {
            foreach ($entity_map[$id] as $entry) {
              $row_node = $entry;
              $lang = isset($e->language) ? $e->language : 'und';

              // remove elements we don't have access to
              if (!$access) {
                unset($row_node[0]);
              }
              else {
                foreach ($e as $key => $val) {
                  if ($val && !isset($row_node->{$key})) {
                    if (strpos($key, 'field_') === 0) {

                      //$fields = field_get_items('node', $node, $key);
                      if (!$display) {
                        $display = 'default';
                      }
                      $field = field_view_field($type, $e, $key, $display);
                      $field['#theme'] = array(
                        'forena_inline_field',
                      );
                      $value = drupal_render($field);
                      $f = $row_node
                        ->addChild($key, htmlspecialchars($value));
                      if (isset($field['#field_type'])) {
                        $f['type'] = $field['#field_type'];
                      }
                      if (isset($field['#field_name'])) {
                        $f['name'] = $field['#field_name'];
                      }
                    }
                    else {
                      if (is_array($val) && isset($val[$lang])) {
                        $tmp = reset($val[$lang]);
                        if (isset($tmp['safe_value'])) {
                          $row_node
                            ->addChild($key, htmlspecialchars($tmp['safe_value']));
                        }
                        else {
                          if (isset($tmp['value']) && !is_array($tmp['value'])) {
                            $row_node
                              ->addChild($key, htmlspecialchars($tmp['value']));
                          }
                        }
                      }
                      else {
                        if (is_array($val) && isset($val['und'])) {
                          $tmp = $val['und'][0];
                          if (isset($tmp['safe_value'])) {
                            $row_node
                              ->addChild($key, htmlspecialchars($tmp['safe_value']));
                          }
                          else {
                            if (isset($tmp['value'])) {
                              $row_node
                                ->addChild($key, htmlspecialchars($tmp['value']));
                            }
                          }
                        }
                        else {
                          if (is_scalar($val)) {
                            $row_node
                              ->addChild($key, htmlspecialchars($val));
                          }
                        }
                      }
                    }
                  }
                }

                // Now add on select fields
                if ($select_fields[$id]) {
                  foreach ($select_fields[$id] as $key => $val) {
                    if (!isset($row_node->{$key})) {
                      $row_node
                        ->addChild($key, htmlspecialchars($val));
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }

  /**
   * Implement custom SQL formatter to make sure that strings are properly escaped.
   * Ideally we'd replace this with something that handles prepared statements, but it
   * wouldn't work for
   *
   * @param unknown_type $value
   * @param unknown_type $key
   * @param unknown_type $data
   */
  public function format($value, $key, $raw = FALSE) {
    if ($raw) {
      return $value;
    }
    $db = Database::getConnection('default');
    $value = $this
      ->parmConvert($key, $value);
    if ($db) {
      if ($value === '' || $value === NULL) {
        $value = 'NULL';
      }
      else {
        if (is_array($value)) {
          if ($value == array()) {
            $value = 'NULL';
          }
          else {

            // Build a array of values string
            $i = 0;
            $val = '';
            foreach ($value as $v) {
              $i++;
              if ($i > 1) {
                $val .= ',';
              }
              $val .= $db
                ->quote($v);
            }
            $value = $val;
          }
        }
        elseif (is_int($value)) {
          $value = (int) $value;
          $value = (string) $value;
        }
        elseif (is_float($value)) {
          $value = (double) $value;
          $value = (string) $value;
        }
        else {
          $value = trim($value);
          $value = $db
            ->quote($value);
        }
      }
    }
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FrxDataSource::$block_ext	public	property
FrxDataSource::$block_extensions	public	property
FrxDataSource::$block_name	public	property
FrxDataSource::$block_path	public	property
FrxDataSource::$comment_prefix	public	property
FrxDataSource::$comment_suffix	public	property
FrxDataSource::$conf	public	property
FrxDataSource::$db_type	public	property
FrxDataSource::$debug	public	property		1
FrxDataSource::$name	public	property
FrxDataSource::$te	protected	property
FrxDataSource::$types	public	property
FrxDataSource::access	public	function	Implements the basic default security check of calling an access method.
FrxDataSource::buildFilterSQL	public	function	Build the SQL clause based on builder data.
FrxDataSource::debug	public	function		1
FrxDataSource::error	public	function
FrxDataSource::getSQLInclude	public	function
FrxDataSource::listDBBlocks	public	function
FrxDataSource::list_blocks	public	function	Find all the blocks matching a provided search string
FrxDataSource::loadBlock		function	Load blcok data from filesystem
FrxDataSource::loadBlockFromFile	protected	function
FrxDataSource::parmConvert	public	function	Perform generic type conversion based on attributes.
FrxDataSource::parseSQLFile	public	function
FrxDataSource::parseXMLFile	public	function
FrxDataSource::phpData	public	function
FrxDataSource::searchTableColumnsSQL	public	function
FrxDataSource::searchTablesSQL	public	function
FrxDataSource::tokens	public	function	Load tokens from block source
FrxDataSource::xmlData	public	function	Implement static XML functioin
FrxDrupal::$database	private	property	Implements hooks into the drupal applications
FrxDrupal::format	public	function	Implement custom SQL formatter to make sure that strings are properly escaped. Ideally we'd replace this with something that handles prepared statements, but it wouldn't work for
FrxDrupal::loadEntities	private	function	Perform a bulk load of entities 100 at a time and then join data back onto the simplexml already created.
FrxDrupal::query	public	function
FrxDrupal::searchTableColumns	public	function	Generate a list of columns for a table. Overrides FrxDataSource::searchTableColumns
FrxDrupal::searchTables	public	function	Method to return an array of tables that start with the string indicated in $str Overrides FrxDataSource::searchTables
FrxDrupal::sqlData	public	function	Get data based on file data block in the repository. Overrides FrxDataSource::sqlData
FrxDrupal::__construct	public	function	Object constructor Overrides FrxDataSource::__construct

You are here

class FrxDrupal in Forena Reports 7.4

Hierarchy

File

Members

API Navigation