Skip to content

Commit

Permalink
Merge pull request #1119 from tripal/1118-tv3-ws_bugs
Browse files Browse the repository at this point in the history 
Fixes for web services bugs
  • Loading branch information
@laceysanderson
laceysanderson committed Nov 9, 2020
2 parents e2b5386 + 260bae3 commit 48f098f
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 27 deletions.
82 changes: 56 additions & 26 deletions tripal_ws/includes/TripalWebService/TripalContentService_v0_1.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,8 @@ class TripalContentService_v0_1 extends TripalWebService {
FIELD_LOAD_CURRENT, ['field_id' => $field['id']]);
}

$this->addEntityField($this->resource, $term, $entity, $bundle, $field, $instance, $service_path, $expfield);
$field_service_path = $service_path . '/' . urlencode($term['name']);
$this->addEntityField($this->resource, $term, $entity, $bundle, $field, $instance, $field_service_path, $expfield);
}

/**
Expand Down Expand Up @@ -319,35 +320,23 @@ class TripalContentService_v0_1 extends TripalWebService {
$instance_settings = $instance['settings'];
if (array_key_exists('auto_attach', $instance['settings']) and
$instance_settings['auto_attach'] == FALSE) {
// Add a URL only if there are values. If there are no values then
// don't add a URL which would make the end-user think they can get
// that information.
$items = field_get_items('TripalEntity', $entity, $field_name);
$term_key = $this->getContextTerm($term, ['lowercase', 'spacing']);
$resource->addContextItem($term_key, $vocabulary . ':' . $accession);
$resource->addContextItem($vocabulary . ':' . $accession, [
'@id' => $term['url'],
'@type' => '@id',
]);
if ($items and count($items) > 0 and $items[0]['value']) {
$this->addResourceProperty($resource, $term, $service_path . '/' . $entity->id . '/' . urlencode($term['name']), [
'lowercase',
'spacing',
]);
}
else {
if ($hide_fields == FALSE) {
$this->addResourceProperty($resource, $term, NULL, [
'lowercase',
'spacing',
]);
}
}
$this->addResourceProperty($resource, $term, $service_path . '/' . $entity->id . '/' . urlencode($term['name']), [
'lowercase',
'spacing',
]);
continue;
}

// Get the details for this field for the JSON-LD response.
$this->addEntityField($resource, $term, $entity, $bundle, $field, $instance, $service_path);
$field_service_path = $service_path . '/' . $entity->id . '/' . urlencode($term['name']);
$this->addEntityField($resource, $term, $entity, $bundle, $field, $instance, $field_service_path);
}
}

Expand Down Expand Up @@ -419,12 +408,25 @@ class TripalContentService_v0_1 extends TripalWebService {
// If the value is an array and this is the field page then all of those
// key/value pairs should be added directly to the response.
if (is_array($values[0])) {
if (array_key_exists('@type', $values[0])) {
[$vocabulary, $accession] = explode(':', $values[0]['@type']);
$term = tripal_get_term_details($vocabulary, $accession);
$resource->addContextItem($term['vocabulary']['short_name'], $term['vocabulary']['sw_url']);
$resource->addContextItem($values[0]['@type'], $term['url']);
$resource->addContextItem($term['name'], $values[0]['@type']);
$values[0]['@type'] = $term['name'];
}

if ($expfield) {
foreach ($values[0] as $k => $v) {
if ($k == '@type') {
continue;
}
$resource->addProperty($k, $v);
}
}
else {

$this->addResourceProperty($resource, $term, $values[0], [
'lowercase',
'spacing',
Expand All @@ -446,28 +448,54 @@ class TripalContentService_v0_1 extends TripalWebService {

// If this is the expanded field page then we need to swap out
// the resource for a collection.
$response = new TripalWebServiceCollection($service_path . '/' . urlencode($expfield), $this->params);
$response = new TripalWebServiceCollection($service_path, $this->params);
$label = tripal_get_term_details('rdfs', 'label');
$this->addResourceProperty($response, $label, $instance['label']);
$i = 0;

foreach ($values as $delta => $element) {
$member = new TripalWebServiceResource($service_path . '/' . urlencode($expfield));
$member = new TripalWebServiceResource($service_path);
$member->setID($i);

// Turn off the @id and @type keys unless the element has these.
$member->disableID();
$member->disbleType();

// Add the context of the parent resource because all of the keys
// were santizied and set to match the proper context.
$member->setContext($resource);
$this->setResourceType($member, $term);

// Iterate through the key/value pairs of the list.
foreach ($element as $key => $value) {
// If this element has an '@id' then replace the generic
// service path that each member element automatically gets
// with this value.
if ($key == '@id') {
$member->setServicePath($value);
$member->enableID();
continue;
}
if ($key == '@type') {
[$vocabulary, $accession] = explode(':', $value);
$tterm = tripal_get_term_details($vocabulary, $accession);
$member->addContextItem($tterm['vocabulary']['short_name'], $tterm['vocabulary']['sw_url']);
$member->addContextItem($value, $tterm['url']);
$member->addContextItem($tterm['name'], $value);
$member->setType($tterm['name']);
$member->enableType();
continue;
}
$member->addProperty($key, $value);
}
$response->addMember($member);
$i++;
if (!empty($element)) {
$response->addMember($member);
$i++;
}
}
if ($expfield) {
$this->resource = $response;
}
else {
//$this->resource->addProperty($key, $response);
$this->addResourceProperty($resource, $term, $response, [
'lowercase',
'spacing',
Expand Down Expand Up @@ -563,6 +591,7 @@ class TripalContentService_v0_1 extends TripalWebService {
$item_entity = reset($item_entity);
$bundle = tripal_load_bundle_entity(['name' => $item_entity->bundle]);
$items['@id'] = $this->getServicePath() . '/' . urlencode($bundle->label) . '/' . $item_eid;
$items['@type'] = $bundle->accession;
}
unset($items['entity']);
}
Expand Down Expand Up @@ -1026,9 +1055,10 @@ class TripalContentService_v0_1 extends TripalWebService {

// Add in any requested fields
foreach ($add_fields as $expfield => $expfield_details) {
$field_service_path = $service_path . '/' . $entity->id . '/' . urlencode($expfield);
$this->addEntityField($member, $expfield_details['term'], $entity,
$bundle, $expfield_details['field'], $expfield_details['instance'],
$service_path);
$field_service_path);
}
$this->resource->addMember($member);
}
Expand Down
61 changes: 60 additions & 1 deletion tripal_ws/includes/TripalWebServiceResource.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,44 @@ class TripalWebServiceResource {
protected $service_path;


/**
* All resources should have a @type and an @id. But, there
* are times when we don't want any, such as an array of unpblished
* properties (e.g. featureloc elements). These can be set to
* TRUE to disable.
*/
protected $disable_type = FALSE;
protected $disable_id = FALSE;


/**
* Exclude the @type element form the data of this resource.
*/
public function disbleType() {
$this->disable_type = TRUE;
}

/**
* Include the @type element form the data of this resource.
*/
public function enableType() {
$this->disable_type = FALSE;
}

/**
* Exclude the @id element form the data of this resource.
*/
public function disableID() {
$this->disable_id = TRUE;
}

/**
* Include the @id element form the data of this resource.
*/
public function enableID() {
$this->disable_id = FALSE;
}

/**
* Implements the constructor.
*
Expand Down Expand Up @@ -113,6 +151,20 @@ class TripalWebServiceResource {
$this->data['@type'] = $type;
}

/**
* Sets the service path for this resource.
*
* By default, the service path is provided to the constructor, but
* this function will allow it to be changed if needed.
*
* @param $service_path
* The URL for the service path.
*/
public function setServicePath($service_path) {
$this->service_path = $service_path;
$this->data['@id'] = $service_path;
}

/**
* Checks a key to ensure it is in the Context before being used.
*
Expand Down Expand Up @@ -341,7 +393,14 @@ class TripalWebServiceResource {
* An associative array containing the data section of the response.
*/
public function getData() {
return $this->data;
$data = $this->data;
if ($this->disable_id) {
unset($data['@id']);
}
if ($this->disable_type) {
unset($data['@type']);
}
return $data;
}

/**
Expand Down

0 comments on commit 48f098f

Please sign in to comment.