orcid-functions.php

<?php
// for testing
//$orcidID = "0000-0003-0265-9119"; // Alan Munn
//$orcidID = "0000-0003-1822-3109";  // Bronson Hui
//$orcidID = "0000-0002-8143-2408"; // Scott Schopieray
//$orcidID = "0000-0003-3953-7940"; // Chris Long (U of CO at Boulder)
//$orcidID = "0000-0002-5251-0307"; // Kathleen Fitzpatrick

include_once(plugin_dir_path(__FILE__) . 'config.php');

/**
 * download data from orcid.org
 *
 * @param string $orcid_id - ORCiD ID
 *
 * @return string $orcid_xml
 */
function orcid_download_data($orcid_id)
{
  $orcid_link = ORCID_URL . $orcid_id;

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_URL, $orcid_link);

  try {
    $orcid_xml = curl_exec($ch);
  } catch (Exception $e) {
    throw new Exception($e);
  }
  curl_close($ch);

  return $orcid_xml;
}

/**
 * format the orcid XML into HTML with XSLT
 *
 * parameters:
 *
 * @param string $orcid_xml - XML as string
 * @param array $display_parameters - which sections of orcid data to display
 *
 * @return string orcid_html
 */
function orcid_format_data_as_html($orcid_xml, $display_parameters)
{
  $xml_doc = new DOMDocument();
  $xml_doc->loadXML($orcid_xml);

  $xsl_doc = new DOMDocument();
  $xsl_doc->load(ORCID_XSLT);

  $html_doc = new XSLTProcessor();

  //
  // control which sections are displayed
  $html_doc->setParameter('', 'display_header', $display_parameters['display_header']);
  // $html_doc->setParameter('', 'display_header', 'yes');
  $html_doc->setParameter('', 'display_personal', $display_parameters['display_personal']);
  $html_doc->setParameter('', 'display_education', $display_parameters['display_education']);
  $html_doc->setParameter('', 'display_employment', $display_parameters['display_employment']);
  //
  $html_doc->setParameter('', 'display_works', $display_parameters['display_works']);
  $html_doc->setParameter('', 'works_type', $display_parameters['works_type']);
  $html_doc->setParameter('', 'works_start_year', $display_parameters['works_start_year']);
  //
  $html_doc->setParameter('', 'display_fundings', $display_parameters['display_fundings']);
  $html_doc->setParameter('', 'display_peer_reviews', $display_parameters['display_peer_reviews']);
  $html_doc->setParameter('', 'display_invited_positions', $display_parameters['display_invited_positions']);
  $html_doc->setParameter('', 'display_memberships', $display_parameters['display_memberships']);
  $html_doc->setParameter('', 'display_qualifications', $display_parameters['display_qualifications']);
  $html_doc->setParameter('', 'display_research_resources', $display_parameters['display_research_resources']);
  $html_doc->setParameter('', 'display_services', $display_parameters['display_services']);

  $html_doc->importStylesheet($xsl_doc);
  $orcid_html = $html_doc->transformToXML($xml_doc);

  return $orcid_html;
}

/**
 * Call back function for shortword [orcid-data section="section_name"]
 *
 * parameters:
 *
 * @param array $atts - contains the display configuration parameters
 *
 * @return string shortcode value
 *
 */
function orcid_data_function($atts = [], $content = null, $tag = '')
{
  // normalize attribute keys, lowercase
  $atts = array_change_key_case((array) $atts, CASE_LOWER);

  //
  // override default attributes with user attributes
  // extract() converts a dictionary to a set of variables
  //
  // section: which section of the orcid data to display.
  // if no section is specified display the header by default
  extract(shortcode_atts(
    array(
      'section'          => 'header',
      'works_type'       => 'all',
      'works_start_year' => '1900',
    ),
    $atts
  ));
  //
  // now we want to display the *AUTHOR's* (NOT the viewer's) data

  //
  // get the author's WordPress user id
  $author = get_the_author_meta('ID', false);

  //
  // get orcid data
  //
  // we can either download the data from orcid.org OR use the cached value
  // we download the data IFF ($download_from_orcid_flag = TRUE)
  // 1) there is no cached xml data
  // 2) the cached value is older than ORCID_CACHE_TIMEOUT (in seconds)
  //
  $download_from_orcid_flag = false;
  //
  // 2) there is no cached xml data
  if (empty(get_user_meta($author, '_orcid_xml', true))) {
    $download_from_orcid_flag = true;
  }
  //
  // 3) the cached value is older than ORCID_CACHE_TIMEOUT (in seconds)
  $current_time = time();
  // last download time
  $orcid_xml_download_time = intval(get_user_meta($author, '_orcid_xml_download_time', true));
  //
  $time_diff = $current_time - $orcid_xml_download_time;
  if ($time_diff >= ORCID_CACHE_TIMEOUT) {
    $download_from_orcid_flag = true;
  }

  if ($download_from_orcid_flag) {
    // return '<p>Downloading XML data from orcid.org</p>' . PHP_EOL;
    $orcid_id  = get_user_meta($author, '_orcid_id', true);
    $orcid_xml = orcid_download_data($orcid_id);
    update_user_meta($author, '_orcid_xml', $orcid_xml);
    //
    // keep track of when download occurred
    update_user_meta($author, '_orcid_xml_download_time', strval(time()));
  } else {
    // return '<p>Using cached XML data</p>' . PHP_EOL;
    // return '<p>author WP id = ' . intval($author) . '</p>';
    // +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    $orcid_xml = get_user_meta($author, '_orcid_xml', true);
  }
  // $orcid_xml = get_user_meta($author, '_orcid_xml', TRUE);


  //
  // determine which section to display
  if ($section == 'header') {
    $display_parameters['display_header'] = 'yes';
  } else {
    $display_parameters['display_header'] = 'no';
  }
  if ($section == 'personal') {
    $display_parameters['display_personal'] = 'yes';
  } else {
    $display_parameters['display_personal'] = 'no';
  }
  if ($section == 'education') {
    $display_parameters['display_education'] = 'yes';
  } else {
    $display_parameters['display_education'] = 'no';
  }
  if ($section == 'employment') {
    $display_parameters['display_employment'] = 'yes';
  } else {
    $display_parameters['display_employment'] = 'no';
  }
  if ($section == 'works') {
    $display_parameters['display_works']    = 'yes';
    $display_parameters['works_type']       = $works_type;
    $display_parameters['works_start_year'] = $works_start_year;
  } else {
    $display_parameters['display_works']    = 'no';
    $display_parameters['works_type']       = 'none';
    $display_parameters['works_start_year'] = '3000';
  }
  if ($section == 'fundings') {
    $display_parameters['display_fundings'] = 'yes';
  } else {
    $display_parameters['display_fundings'] = 'no';
  }
  if ($section == 'peer_reviews') {
    $display_parameters['display_peer_reviews'] = 'yes';
  } else {
    $display_parameters['display_peer_reviews'] = 'no';
  }
  if ($section == 'invited_positions') {
    $display_parameters['display_invited_positions'] = 'yes';
  } else {
    $display_parameters['display_invited_positions'] = 'no';
  }
  if ($section == 'memberships') {
    $display_parameters['display_memberships'] = 'yes';
  } else {
    $display_parameters['display_memberships'] = 'no';
  }
  if ($section == 'qualifications') {
    $display_parameters['display_qualifications'] = 'yes';
  } else {
    $display_parameters['display_qualifications'] = 'no';
  }
  if ($section == 'research_resources') {
    $display_parameters['display_research_resources'] = 'yes';
  } else {
    $display_parameters['display_research_resources'] = 'no';
  }
  if ($section == 'services') {
    $display_parameters['display_services'] = 'yes';
  } else {
    $display_parameters['display_services'] = 'no';
  }
  //
  // format as HTML
  $orcid_html    = orcid_format_data_as_html($orcid_xml, $display_parameters);
  $return_string = $orcid_html;

  return $return_string;
}

/**
 * Return data from ORCiD for a section
 * Call back function for shortword [orcid-data section="section_name"]
 *
 * parameters:
 *
 * @param string $section - ORCiD section
 * @return string ORCiD data as html
 *
 */
function orcid_data_block_function($section = "", $works_type = "all", $works_start_year = "3000")
{

  //return "<div>the way is void</div>";
  // 
  // convert to lower case
  $section = strtolower($section);

  //
  // we want to display the *AUTHOR's* (NOT the viewer's) data

  //
  // get the author's WordPress user id
  $author = get_the_author_meta('ID', false);

  //
  // get orcid data
  //
  // we can either download the data from orcid.org OR use the cached value
  // we download the data IFF ($download_from_orcid_flag = TRUE)
  // 1) there is no cached xml data
  // 2) the cached value is older than ORCID_CACHE_TIMEOUT (in seconds)
  //
  $download_from_orcid_flag = false;
  //
  // 2) there is no cached xml data
  if (empty(get_user_meta($author, '_orcid_xml', true))) {
    $download_from_orcid_flag = true;
  }
  //
  // 3) the cached value is older than ORCID_CACHE_TIMEOUT (in seconds)
  $current_time = time();
  // last download time
  $orcid_xml_download_time = intval(get_user_meta($author, '_orcid_xml_download_time', true));
  //
  $time_diff = $current_time - $orcid_xml_download_time;
  if ($time_diff >= ORCID_CACHE_TIMEOUT) {
    $download_from_orcid_flag = true;
  }

  if ($download_from_orcid_flag) {
    // return '<p>Downloading XML data from orcid.org</p>' . PHP_EOL;
    $orcid_id  = get_user_meta($author, '_orcid_id', true);
    $orcid_xml = orcid_download_data($orcid_id);
    update_user_meta($author, '_orcid_xml', $orcid_xml);
    //
    // keep track of when download occurred
    update_user_meta($author, '_orcid_xml_download_time', strval(time()));
  } else {
    // return '<p>Using cached XML data</p>' . PHP_EOL;
    // return '<p>author WP id = ' . intval($author) . '</p>';
    // +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    $orcid_xml = get_user_meta($author, '_orcid_xml', true);
  }
  // $orcid_xml = get_user_meta($author, '_orcid_xml', TRUE);


  //
  // determine which section to display
  if ($section == 'header') {
    $display_parameters['display_header'] = 'yes';
  } else {
    $display_parameters['display_header'] = 'no';
  }
  if ($section == 'personal') {
    $display_parameters['display_personal'] = 'yes';
  } else {
    $display_parameters['display_personal'] = 'no';
  }
  if ($section == 'education') {
    $display_parameters['display_education'] = 'yes';
  } else {
    $display_parameters['display_education'] = 'no';
  }
  if ($section == 'employment') {
    $display_parameters['display_employment'] = 'yes';
  } else {
    $display_parameters['display_employment'] = 'no';
  }
  if ($section == 'works') {
    $display_parameters['display_works']    = 'yes';
    $display_parameters['works_type']       = $works_type;
    $display_parameters['works_start_year'] = $works_start_year;
  } else {
    $display_parameters['display_works']    = 'no';
    $display_parameters['works_type']       = 'none';
    $display_parameters['works_start_year'] = '3000';
  }
  if ($section == 'fundings') {
    $display_parameters['display_fundings'] = 'yes';
  } else {
    $display_parameters['display_fundings'] = 'no';
  }
  if ($section == 'peer_reviews') {
    $display_parameters['display_peer_reviews'] = 'yes';
  } else {
    $display_parameters['display_peer_reviews'] = 'no';
  }
  if ($section == 'invited_positions') {
    $display_parameters['display_invited_positions'] = 'yes';
  } else {
    $display_parameters['display_invited_positions'] = 'no';
  }
  if ($section == 'memberships') {
    $display_parameters['display_memberships'] = 'yes';
  } else {
    $display_parameters['display_memberships'] = 'no';
  }
  if ($section == 'qualifications') {
    $display_parameters['display_qualifications'] = 'yes';
  } else {
    $display_parameters['display_qualifications'] = 'no';
  }
  if ($section == 'research_resources') {
    $display_parameters['display_research_resources'] = 'yes';
  } else {
    $display_parameters['display_research_resources'] = 'no';
  }
  if ($section == 'services') {
    $display_parameters['display_services'] = 'yes';
  } else {
    $display_parameters['display_services'] = 'no';
  }
  //
  // format as HTML
  $orcid_html    = orcid_format_data_as_html($orcid_xml, $display_parameters);
  $return_string = $orcid_html;

  return $return_string;
}