tripal/tripal_ws/includes/TripalFields/remote__data/remote__data.inc

<?php
/**
 * @class
 * Purpose:
 *
 * Data:
 * Assumptions:
 */
class remote__data extends WebServicesField {

  // --------------------------------------------------------------------------
  //                     EDITABLE STATIC CONSTANTS
  //
  // The following constants SHOULD be set for each descendant class.  They are
  // used by the static functions to provide information to Drupal about
  // the field and it's default widget and formatter.
  // --------------------------------------------------------------------------
  // The default label for this field.
  public static $default_label = 'Remote Data';

  // The default description for this field.
  public static $default_description = 'remote data';

  // The default widget for this field.
  public static $default_widget = 'remote__data_widget';
  // The default formatter for this field.
  public static $default_formatter = 'remote__data_formatter';
  // The module that manages this field.
  public static $module = 'tripal_ws';
  // A list of global settings. These can be accessed within the
  // globalSettingsForm.  When the globalSettingsForm is submitted then
  // Drupal will automatically change these settings for all fields.
  // Once instances exist for a field type then these settings cannot be
  // changed.
  public static $default_settings = array(
    'storage' => 'field_tripal_ws_storage',
    // It is expected that all fields set a 'value' in the load() function.
    // In many cases, the value may be an associative array of key/value pairs.
    // In order for Tripal to provide context for all data, the keys should
    // be a controlled vocabulary term (e.g. rdfs:type). Keys in the load()
    // function that are supported by the query() function should be
    // listed here.
    'searchable_keys' => array(),
  );

  // Provide a list of instance specific settings. These can be access within
  // the instanceSettingsForm.  When the instanceSettingsForm is submitted
  // then Drupal with automatically change these settings for the instance.
  // It is recommended to put settings at the instance level whenever possible.
  // If you override this variable in a child class be sure to replicate the
  // term_name, term_vocab, term_accession and term_fixed keys as these are
  // required for all TripalFields.
  public static $default_instance_settings = array(
    // The short name for the vocabulary (e.g. schema, SO, GO, PATO, etc.).
    'term_vocabulary' => 'schema',
    // The name of the term.
    'term_name' => 'Thing',
    // The unique ID (i.e. accession) of the term.
    'term_accession' => 'property',
    // Set to TRUE if the site admin is not allowed to change the term
    // type, otherwise the admin can change the term mapped to a field.
    'term_fixed' => FALSE,
    // Indicates if this field should be automatically attached to display
    // or web services or if this field should be loaded separately. This
    // is convenient for speed.  Fields that are slow should for loading
    // should have auto_attach set to FALSE so tha their values can be
    // attached asynchronously.
    'auto_attach' => FALSE,
    // Settings to allow the site admin to set the remote data source info.
			'data_info' => array(
				'query' => '',
				'remote_site' => '',
        'description' => '',
        'rd_field_name' => '',
			),
  );
  // A boolean specifying that users should not be allowed to create
  // fields and instances of this field type through the UI. Such
  // fields can only be created programmatically with field_create_field()
  // and field_create_instance().
  public static $no_ui = FALSE;
  // A boolean specifying that the field will not contain any data. This
  // should exclude the field from web services or downloads.  An example
  // could be a quick search field that appears on the page that redirects
  // the user but otherwise provides no data.
  public static $no_data = FALSE;

  /**
   * @see WebServicesField::load()
   */
  public function load($entity) {
    $site_id_ws = $this->instance['settings']['data_info']['remote_site'];
    $query = $this->instance['settings']['data_info']['query'];
    $rd_field_name = $this->instance['settings']['data_info']['rd_field_name'];
    $options = array();
    $field_name = $this->field['field_name'];
    // Check for tripal tokens and replace if present.
    $bundle_entity = tripal_load_bundle_entity(array('name' => $entity->bundle));
    $query = tripal_replace_entity_tokens($query, $entity, $bundle_entity);

     // Get the site url from the tripal_sites table.
     $site_url_ws = db_select('tripal_sites', 's')
       ->fields('s',array('url'))
       ->condition('s.id', $site_id_ws, '=')
       ->execute()->fetchAll();

     $full_url = $site_url_ws[0]->url . '/web-services/content/v0.1/';

     //Remove trailing slash if one is included.$_COOKIE
     $full_url = trim($full_url, '/');
     $full_url = $full_url . '/' . $query;

     //Make the call and pull the data down.
     $data = drupal_http_request($full_url, $options);

    //Check the returned data is not an error.
    if(property_exists($data, 'error')){
      watchdog('Tripal WS', '<pre>Web Services data unavailable because site is returning error: '. print_r($data->error, TRUE) .'</pre>');
      $data = '';
    }
     if($data){
       $data = drupal_json_decode($data->data);
       //Check the returned data is not an error.
       if(array_key_exists('error', $data)){
          watchdog('Tripal WS', '<pre>Web Services data unavailable because site is returning error: '. print_r($data['error'], TRUE) .'</pre>');
          $data = '';
       }

       // Check if the returned results are paged, if so iterate through all pages.
       //$paged_data = array();
       if(array_key_exists('next', $data['view'])){
          //First page of results.
          foreach($data['members'] as $member){
            $value = tripal_ws_remote_data_single_field_pull($rd_field_name, $member['@id']);
            $entity->{$field_name}['und'][$member['label']]['value'] = $value;
            $entity->{$field_name}['und'][$member['label']]['remote_entity'] = $member;
            //array_push($paged_data, $member);
          }
          //'next' pages.
          $next_page = $data['view']['next'];
            while(!empty($next_page)){
              $data = drupal_http_request($next_page, $options);
              if(!empty($data)){
                $data = drupal_json_decode($data->data);
                foreach($data['members'] as $member){
                  $value = tripal_ws_remote_data_single_field_pull($rd_field_name, $member['@id']);
                  $entity->{$field_name}['und'][$member['label']]['value'] = $value;
                  $entity->{$field_name}['und'][$member['label']]['remote_entity'] = $member;
                  //array_push($paged_data, $member);
                }
                if(array_key_exists('next', $data['view'])){
                  $next_page = $data['view']['next'];
                }
                else {
                  $next_page = NULL;
                }
              }
          }
          //'last' page.
          $last_page = $data['view']['last'];
          $data = drupal_http_request($last_page, $options);
          if(!empty($data)){
            $data = drupal_json_decode($data->data);
            foreach($data['members'] as $member){
              $value = tripal_ws_remote_data_single_field_pull($rd_field_name, $member['@id']);
              $entity->{$field_name}['und'][$member['label']]['value'] = $value;
              $entity->{$field_name}['und'][$member['label']]['remote_entity'] = $member;
              //array_push($paged_data, $member);
            }
          }
       }
       else {
        //Check the returned data isn't empty.
        if(!empty($data['members'])){
          //If multiple records, if single follow @id and pull down data
          /*if(array_key_exists('value', $data)){
            $members = $data['value'][0]['members'];
            if($members){
              if(count($members) > 1){
                  $data = $data;
              }
              else {
                $single_record_url = $data['members'][0]['@id'];
                $data = drupal_http_request($single_record_url, $options);
                if(!empty($data)){
                  $data = drupal_json_decode($data->data);
                  if(array_key_exists('error', $data)){
                    watchdog('Tripal WS', '<pre>Web Services data unavailable because site is returning error: '. print_r($data['error'], TRUE) .'</pre>');
                    $data = '';
                  }
                }
              }
            }
          }
          else */
          if(count($data['members']) > 1) {
            foreach($data['members'] as $member){
              $value = tripal_ws_remote_data_single_field_pull($rd_field_name, $member['@id']);
              $entity->{$field_name}['und'][$member['label']]['value'] = $value;
              $entity->{$field_name}['und'][$member['label']]['remote_entity'] = $member;
              //array_push($paged_data, $member);
            }
          }
          else {
              $member = $data['members'][0];
              $single_record_url = $member['@id'];
              $value = tripal_ws_remote_data_single_field_pull($rd_field_name, $single_record_url);
              if(!empty($data)){
                $entity->{$field_name}['und'][$member['label']]['value'] = $value;
                $entity->{$field_name}['und'][$member['label']]['remote_entity'] = $member;
                if(array_key_exists('error', $data)){
                  watchdog('Tripal WS', '<pre>Web Services data unavailable because site is returning error: '. print_r($data['error'], TRUE) .'</pre>');
                  $data = '';
                }
              }
          }
        }
      }
      $field_name = $this->field['field_name'];
      $entity->{$field_name}['und'][0]['value'] = $data;
    }
   }
   /**
	 *
	 * @see TripalField::settingsForm()
   */
	public function instanceSettingsForm() {
		$element = parent::instanceSettingsForm();
    // Get the setting for the option for how this widget.
    $instance = $this->instance;
    $settings = '';
    $site_list = '';

    $tokens = array();
    // Get the form info from the bundle about to be saved.
    $bundle_info = tripal_load_bundle_entity(array($instance['bundle']));
    // Retrieve all available tokens.
    $tokens = tripal_get_entity_tokens($bundle_info);

    $element['data_info'] = array(
      '#type' => 'fieldset',
      '#title' => 'Remote Data Settings',
      '#description' => 'Provide the site name, query and description for the remote data source.',
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#prefix' => "<div id='set_titles-fieldset'>",
      '#suffix' => '</div>',
    );

    // Get the site info from the tripal_sites table.
    $sites = db_select('tripal_sites', 's')
      ->fields('s')
      ->execute()->fetchAll();

    foreach ($sites as $site) {
      $rows[$site->id] =$site->name;
    }

    $element['data_info']['remote_site'] = array(
      '#type' => 'select',
      '#title' => t('Site'),
      '#options' => $rows,
      '#default_value' => $this->instance['settings']['data_info']['remote_site'],
    );

    $element['data_info']['query'] = array(
      '#type' => 'textarea',
      '#title' => 'Query',
      '#description' => 'Build the query string that should be appended after the url. The tokens
      listed below may be used in your query build.',
      '#default_value' => $this->instance['settings']['data_info']['query'],
      '#rows' => 5,
      '#required' => TRUE
    );
    $element['data_info']['rd_field_name'] = array(
      '#type' => 'textfield',
      '#title' => 'Field',
      '#description' => 'Name of the field you would like to display.',
      '#default_value' => $this->instance['settings']['data_info']['rd_field_name'],
      '#required' => TRUE
    );
    $element['data_info']['token_display']['tokens'] = array(
      '#type' => 'hidden',
      '#value' => serialize($tokens)
    );

    $element['data_info']['token_display'] = array(
      '#type' => 'fieldset',
      '#title' => 'Available Tokens',
      '#description' => 'Copy the token and paste it into the "Query" text field above.',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE
    );

    $element['data_info']['token_display']['content'] = array(
      '#type' => 'item',
      '#markup' => theme_token_list($tokens),
    );

    $element['data_info']['description'] = array(
      '#type' => 'textarea',
      '#title' => 'Description',
      '#description' => 'Describe the data being pulled in.',
      '#default_value' =>  $this->instance['settings']['data_info']['description'],
      '#rows' => 1
    );
    /*$element['test_button']['data'] = array(
      '#prefix' => '<div class="returned-data">',
      '#suffix' => '</div>',
      '#type' => 'container',
        //…
    );

    $element['test_button'] = array(
      '#type' => 'button',
      '#value' => t('Test Query'),
      '#ajax' => array(
        'wrapper' => 'data-id',
        'callback' => 'tripal_ws_url_query_test',
      ),
        //…
    );*/

			return $element;
  }

 /**
   *
   * @param unknown $form
   * @param unknown $form_state
   */
  public function instanceSettingsFormValidate($form, &$form_state) {
  }


}