Project

General

Profile

Download (36 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
// $Id$
3

    
4
/**
5
 * @file
6
 * Functions which are required or useful when accessing and processing CDM Data Store Webservices
7
 *
8
 * Naming conventions:
9
 * ----------------------
10
 *
11
 *  - all webservice access methods are prefixed with cdm_ws
12
 *
13
 *
14
 * Copyright (C) 2007 EDIT
15
 * European Distributed Institute of Taxonomy
16
 * http://www.e-taxonomy.eu
17
 */
18
require_once ('xml2json.php');
19
require_once ('commons.php');
20
require_once ('uuids.php');
21
require_once ('webservice_uris.php');
22
require_once ('cdm_node.php');
23

    
24
/**
25
 * Implementation of hook_requirements()
26
 */
27
function cdm_api_requirements() {
28

    
29
  $requirements['cdm_api'] = array(
30
    'title' => t('CDM API')
31
  );
32

    
33
  if( function_exists('curl_init') ){
34
    $requirements['cdm_api']['description'] = ''; // description below title is not jet in use
35
    $requirements['cdm_api']['value'] =  'CURL php extension is available and will be used by the cdm api. HTTP requests thus will be up to 20x faster';
36
  } else {
37
    $requirements['cdm_api']['value'] =  'CURL php extension is missing. If CURL lib is installed HTTP requests will be up to 20x faster';
38
  }
39

    
40
  //FIXME: once _get_content_fsockopen is implemented change  severity to  REQUIREMENT_WARNING,
41
  $requirements['cdm_api']['severity'] =  (function_exists('curl_init') ? REQUIREMENT_OK : REQUIREMENT_INFO);
42

    
43
  return $requirements;
44
}
45

    
46

    
47
/**
48
 * Implementation of hook_menu()
49
 */
50
function cdm_api_menu($may_cache) {
51
  $items = array();
52
  if ($may_cache) {
53
    $items[] = array(
54
    // usage: url('cdm_api/proxy/'.urlencode($content_url)."/$theme");
55
      'path' => 'cdm_api/proxy',
56
      'callback' => 'proxy_content',
57
      'access' => true,
58
      'type' => MENU_CALLBACK,
59
    );
60

    
61
    $items[] = array(
62
    // usage: url('cdm_api/proxy/'.urlencode($content_url)."/$theme");
63
      'path' => 'cdm_api/setvalue/session',
64
      'callback' => 'setvalue_session',
65
      'access' => true,
66
      'type' => MENU_CALLBACK,
67
    );
68

    
69
  }
70

    
71
  return $items;
72
}
73

    
74

    
75
/**
76
 * Implementation of hook_cron().
77
 *
78
 * Expire outdated cache entries
79
 */
80
function cdm_api_cron() {
81
  cache_clear_all(NULL, 'cache_cdm_ws');
82
}
83

    
84
function cdm_api_perm() {
85
  return array(
86
      'administer cdm_api'
87
      );
88
}
89

    
90
// ----------------------------------------------------------- //
91

    
92

    
93
/**
94
 * Converts an array of TagedText items into a sequence of corresponding html tags whereas
95
 * each item will provided with a class attribute which set to the key of the TaggedText item.
96
 *
97
 * @param array $taggedtxt
98
 * @param String $tag
99
 * @param String $glue the string by which the chained text tokens are concatenated together.
100
 *       Default is a blank character
101
 * @return String of HTML
102
 */
103
function cdm_taggedtext2html(array &$taggedtxt, $tag = 'span', $glue = ' ', $skiptags = array()){
104
  $out = '';
105
  $i = 0;
106
  foreach($taggedtxt as $tt){
107
    if(!in_array($tt->type, $skiptags) && strlen($tt->text) > 0){
108
      $out .= (strlen($out) > 0 && ++$i < count($taggedtxt)? $glue : '').'<'.$tag.' class="'.$tt->type.'">'.t($tt->text).'</'.$tag.'>';
109
    }
110
  }
111
  return $out;
112
}
113

    
114
/**
115
 * Finds the text tagged with $tag_type in an array of taggedText instances
116
 *
117
 * @param array $taggedtxt
118
 * @param string $tag_type
119
 * @return an array with the texts mapped by $tag_type
120
 */
121
function cdm_taggedtext_values(array &$taggedtxt = array(), $tag_type){
122
  $tokens = array();
123
  foreach($taggedtxt as $tagtxt){
124
    if($tagtxt->type == $tag_type)
125
    $tokens[] = $tagtxt->text;
126
  }
127
  return $tokens;
128
}
129

    
130
/**
131
 * Returns the currently classification tree in use
132
 */
133
function get_taxonomictree_uuid_selected(){
134
  if(is_uuid($_SESSION['cdm']['taxonomictree_uuid']) ){
135
    return $_SESSION['cdm']['taxonomictree_uuid'];
136
  } else {
137
    return variable_get(CDM_TAXONOMICTREE_UUID, false);
138
  }
139
}
140

    
141
function switch_to_taxonomictree_uuid($taxonomictree_uuid){
142
  $_SESSION['cdm']['taxonomictree_uuid'] = $taxonomictree_uuid;
143
}
144

    
145
function reset_taxonomictree_uuid($taxonomictree_uuid){
146
  unset($_SESSION['cdm']['taxonomictree_uuid']);
147
}
148

    
149
function set_last_taxon_page_tab($taxonPageTab){
150
  $_SESSION['cdm']['taxon_page_tab'] = $taxonPageTab;
151
}
152

    
153
function get_last_taxon_page_tab(){
154
  if(isset($_SESSION['cdm']['taxon_page_tab'])){
155
    return $_SESSION['cdm']['taxon_page_tab'];
156
  } else {
157
    return false;
158
  }
159
}
160

    
161

    
162
/**
163
 * media Array [4]
164
 *   representations Array [3]
165
 *       mimeType  image/jpeg
166
 *       representationParts Array [1]
167
 *           duration  0
168
 *           heigth  0
169
 *           size  0
170
 *           uri http://wp5.e-taxonomy.eu/dataportal/cichorieae/media/protolog/jpeg/Acanthocephalus_p1.jpg
171
 *           uuid  15c687f1-f79d-4b79-992f-7ba0f55e610b
172
 *           width 0
173
 *       suffix  jpg
174
 *       uuid  930b7d51-e7b6-4350-b21e-8124b14fe29b
175
 *   title
176
 *   uuid  17e514f1-7a8e-4daa-87ea-8f13f8742cf9
177
 *
178
 * @param unknown_type $media
179
 * @param array $mimeTypes
180
 * @param unknown_type $width
181
 * @param unknown_type $height
182
 * @return unknown
183
 */
184
function cdm_preferred_media_representations($media, array $mimeTypes, $width = 400, $height = 300){
185

    
186
  $prefRepr = array();
187
  if(!isset($media->representations[0])){
188
    return $prefRepr;
189
  }
190

    
191
  while(count($mimeTypes) > 0){
192
    // getRepresentationByMimeType
193
    $mimeType = array_shift($mimeTypes);
194

    
195
    foreach($media->representations as &$representation){
196

    
197
      //if the mimetype is not known, try inferring it
198
      if(!$representation->mimeType){
199
        if(isset($representation->parts[0])){
200
          $representation->mimeType = infer_mime_type($representation->parts[0]->uri);
201
        }
202
      }
203

    
204
      if($representation->mimeType == $mimeType){
205
        // preffered mimetype found -> erase all remaining mimetypes to end loop
206
        $mimeTypes = array();
207
        $dwa = 0;
208
        // look for part with the best matching size
209
        foreach($representation->parts as $part){
210
          $dw = $part->width * $part->height - $height * $width;
211
          if($dw < 0){
212
            $dw *= -1;
213
          }
214
          $dwa+= $dw;
215
        }
216
        $dwa = (count($representation->parts)>0) ? $dwa / count($representation->parts) : 0;
217
        $prefRepr[$dwa.'_'.$mimeTypeKey] = $representation;
218
      }
219

    
220
    }
221

    
222
  }
223
  // sort
224
  krsort($prefRepr);
225
  // return
226
  return $prefRepr;
227
}
228

    
229
/**
230
 * Infers the mime type of a file using the filename extension.
231
 * @param $filepath the path to the respective file.
232
 *        The filename extension will be used to infer the mime type.
233
 * @return the mimetype to the file or false if the according mime type could not be found
234
 */
235
function infer_mime_type($filepath){
236
  static $mimemap = null;
237
  if(!$mimemap){
238
    $mimemap = array(
239
      'jpg'=>'image/jpeg',
240
      'jpeg'=>'image/jpeg',
241
      'png'=>'image/png',
242
      'gif'=>'image/gif',
243
      'giff'=>'image/gif',
244
      'tif'=>'image/tif',
245
      'tiff'=>'image/tif',
246
      'pdf'=>'application/pdf',
247
      'html'=>'text/html',
248
      'htm'=>'text/html'
249
    );
250
  }
251
  $extension = substr($filepath, strrpos($filepath, '.') + 1);
252
  if(isset($mimemap[$extension])){
253
    return $mimemap[$extension];
254
  } else {
255
    return 'text/html'; //FIXME remove this hack just return false;
256
  }
257
}
258

    
259
/**
260
 * expects an ISO 8601 time representations of a org.joda.time.Partial
261
 * of the form yyyy-MM-dd and returns the year as String.
262
 * In case the year is unknown (= ????) null is returned.
263
 *
264
 * @param ISO 8601 time representations of a org.joda.time.Partial
265
 * @return String
266
 */
267
function partialToYear($partial){
268
  if(is_string($partial)){
269
    $year = substr($partial, 0, 4);
270
    if($year != '??'){
271
      return $year;
272
    }
273
  }
274
  return;
275
}
276
/**
277
 * expects an ISO 8601 time representations of a org.joda.time.Partial
278
 * of the form yyyy-MM-dd and returns the month as String.
279
 * In case the month is unknown (= ???) null is returned.
280
 *
281
 * @param ISO 8601 time representations of a org.joda.time.Partial
282
 * @return String
283
 */
284
function partialToMonth($partial){
285
  if(is_string($partial)){
286
    $month = substr($partial, 5, 2);
287
    if($month != '??'){
288
      return $month;
289
    }
290
  }
291
  return;
292
}
293
/**
294
 * expects an ISO 8601 time representations of a org.joda.time.Partial
295
 * of the form yyyy-MM-dd and returns the day as String.
296
 * In case the day is unknown (= ???) null is returned.
297
 *
298
 * @param ISO 8601 time representations of a org.joda.time.Partial
299
 * @return String
300
 */
301
function partialToDay($partial){
302
  if(is_string($partial)){
303
    $day = substr($partial, 7, 2);
304
    if($day != '??'){
305
      return $day;
306
    }
307
  }
308
  return;
309
}
310

    
311
/**
312
 *
313
 * @param $uri_pattern
314
 * @param $pathParameters an array of path elements, or a single element
315
 * @param $query  A query string to append to the URL.
316
 * @return unknown_type
317
 */
318
function cdm_compose_url($uri_pattern, $pathParameters = array(), $query = NULL ){
319

    
320
  if(!isset($pathParameters)){
321
    $pathParameters = array();
322
  }
323

    
324
  $request_params = '';
325
  $path_params = '';
326

    
327
  /* (1)
328
   * substitute all place holders ($0, $1, ..) in the
329
   * $uri_pattern by the according element of the $pathParameters array
330
   */
331
  static $helperArray = array();
332
  if($pathParameters && !is_array($pathParameters)){
333
    $helperArray[0] = $pathParameters;
334
    $pathParameters = $helperArray;
335
  }
336

    
337
  $i = 0;
338
  while(strpos($uri_pattern, "$".$i) !== FALSE){
339
    if(count($pathParameters) <= $i){
340
      if(user_access('administer')){
341
        drupal_set_message('cdm_compose_url(): missing pathParameters', 'debug');
342
      }
343
      break;
344
    }
345
    $uri_pattern = str_replace("$".$i, rawurlencode($pathParameters[$i]), $uri_pattern);
346
    ++$i;
347
  }
348

    
349
  /* (2)
350
   * Append all remaining element of the $pathParameters array as path elements
351
   */
352
  if(count($pathParameters) > $i){
353
    // strip trailing slashes
354
    if(strrchr($uri_pattern, '/') == strlen($uri_pattern)){
355
      $uri_pattern = substr($uri_pattern, 0, strlen($uri_pattern) - 1);
356
    }
357
    while(count($pathParameters) > $i){
358
      $uri_pattern .= '/' . rawurlencode($pathParameters[$i]);
359
      ++$i;
360
    }
361
  }
362

    
363
  /* (3)
364
   * Append the query string supplied by $query
365
   */
366
  if (isset($query)) {
367
    $uri_pattern .= (strpos($uri_pattern, '?') !== FALSE ? '&' : '?') . $query;
368
  }
369

    
370
  $path = $ws_name.$uri_pattern;
371

    
372
  $uri = variable_get('cdm_webservice_url', '').$path;
373
  return $uri;
374
}
375

    
376

    
377
function proxy_content($uri, $theme = null){
378

    
379
  $args = func_get_args();
380

    
381
  $uriEncoded = array_shift($args);
382
  $uri = urldecode($uriEncoded);
383
  $theme = array_shift($args);
384

    
385
  // find and deserialize arrays
386
    foreach($args as &$arg){
387
      if( strpos($arg, "a:") === 0){ //FIXME use regex to find serialized arrays
388
        $arg = unserialize($arg);
389
      }
390
      //find comma sepatated string in all args
391
//  	if(strpos($arg, ',')){
392
//  		$arg = explode(',', $arg);
393
//  	}
394
  }
395

    
396

    
397
  $request_method = strtoupper($_SERVER["REQUEST_METHOD"]);
398

    
399
  if($request_method == "POST"){
400

    
401
    $parameters = $_POST;
402

    
403
    $post_data = array();
404
    foreach ($parameters as $k=>$v)
405
    {
406
      $post_data[] = "$k=".utf8_encode($v);
407
    }
408
    $post_data = implode(',', $post_data);
409

    
410
    // testing
411
    $data = drupal_http_request($uri, "POST", $post_data);
412
    print $data;
413

    
414
  }else if(strpos($theme, '/') > 0){ // must be a mimetype
415
    header('Content-Type: '.$theme);
416
    $data = _http_request_binary($uri);
417
    print $data;
418
    exit;
419
  } else {
420
    // in all other cases perform a simple get request
421
    //TODO reconsider caching logic in this function
422
    if(!$theme){
423
      // print out JSON, the cache cannot be used since it contains objects
424
      $http_response = drupal_http_request($uri);
425
      foreach($http_response->headers as $hname=>$hvalue) {
426
        drupal_set_header($hname . ":" . $hvalue);
427
      }
428
      print $http_response->data;
429
      exit;
430
    } else {
431
      $obj = cdm_ws_get($uri, null, null, null, TRUE);
432
      array_unshift($args, $theme, $obj);
433
      print call_user_func_array('theme', $args);
434
    }
435
  }
436
}
437

    
438
function setvalue_session(){
439

    
440
  if( $_REQUEST['var'] && strlen( $_REQUEST['var']) > 4){
441
    $keys = substr( $_REQUEST['var'], 1, strlen( $_REQUEST['var']) - 2);
442
    $keys = explode('][', $keys);
443
  } else {
444
    return;
445
  }
446
  $val =  $_REQUEST['val'] ?  $_REQUEST['val'] : null;
447

    
448
  // prevent from malicous tags
449
  $val = strip_tags($val);
450

    
451
  $var = &$_SESSION;
452
  $i = 0;
453
  foreach($keys as $key){
454
    $hasMoreKeys = ++$i < count($var);
455
    if($hasMoreKeys && (!isset($var[$key]) || !is_array($var[$key]))){
456
      $var[$key] = array();
457
    }
458
    $var = &$var[$key];
459
  }
460
  $var = $val;
461
  drupal_goto($_REQUEST['destination']);
462
}
463

    
464
function uri_uriByProxy($uri, $theme = false){
465
  // usage: url('cdm_api/proxy/'.urlencode($content_url)."/$theme");)
466
  return url('cdm_api/proxy/'.urlencode($uri).($theme?"/$theme":''));
467
}
468

    
469
function cdm_compose_annotations_url($cdmBase){
470

    
471
    if(!$cdmBase->uuid){
472
        return;
473
    }
474

    
475
  $ws_base_uri = null;
476
    switch($cdmBase->class){
477
        case 'TaxonBase':
478
        case 'Taxon':
479
        case 'Synonym':
480
            $ws_base_uri = CDM_WS_TAXON;
481
            break;
482
        case 'TaxonNameBase':
483
        case 'NonViralName':
484
        case 'BacterialName':
485
        case 'BotanicalName':
486
        case 'CultivarPlantName':
487
        case 'ZoologicalName':
488
        case 'ViralName':
489
            $ws_base_uri = CDM_WS_NAME;
490
            break;
491
        case 'Media':
492
            $ws_base_uri = CDM_WS_MEDIA;
493
            break;
494
        case 'ReferenceBase':
495
            $ws_base_uri = CDM_WS_REFERENCE;
496
            break;
497
        case 'Distribution':
498
        case 'TextData':
499
        case 'TaxonInteraction':
500
        case 'QuantitativeData':
501
        case 'IndividualsAssociation':
502
        case 'Distribution':
503
        case 'CommonTaxonName':
504
        case 'CategoricalData':
505
          $ws_base_uri = CDM_WS_DESCRIPTIONELEMENT;
506
          break;
507
        case 'PolytomousKey':
508
        case 'MediaKey':
509
        case 'MultiAccessKey':
510
          $ws_base_uri = $cdmBase->class;
511
          $ws_base_uri{0} = strtolower($ws_base_uri{0});
512
          break;
513
        default:  trigger_error('Unsupported CDM Class - no annotations available for ' . $cdmBase->class, E_USER_ERROR);
514
            return;
515
    }
516
    return  cdm_compose_url($ws_base_uri, array($cdmBase->uuid, 'annotations'));
517
}
518

    
519
/**
520
 * Enter description here...
521
 *
522
 * @param String $resourceURI
523
 * @param pageSize
524
 *            the maximum number of entities returned per page (can be null
525
 *            to return all entities in a single page)
526
 * @param pageNumber
527
 *            the number of the page to be returned, the first page has the
528
 *            pageNumber = 1
529
 * @return unknown
530
 */
531
function cdm_ws_page($resourceURI, $pageSize, $pageNumber){
532
  return cdm_ws_get($resourceURI, null, queryString(array("page" => $pageNumber, 'pageSize'=>$pageSize)));
533
}
534

    
535
//function cdm_ws_taxonomy_compose_resourcePath($path = null){
536
//  $viewrank =  _cdm_taxonomy_compose_viewrank();
537
//  return CDM_WS_PORTAL_TAXONOMY . '/' . ($viewrank ? $viewrank : '' ) . ($path ? '/' . $path : '') ;
538
//}
539

    
540

    
541
/**
542
 * Enter description here...
543
 *
544
 * @param unknown_type $secUuid
545
 * @param unknown_type $path
546
 * @return unknown
547
 */
548
function cdm_compose_taxonomy_path($taxonUuid = false){
549

    
550
  $viewUuid = get_taxonomictree_uuid_selected();
551
  $rankUuid = variable_get('taxontree_ranklimit', DEFAULT_TAXONTREE_RANKLIMIT);
552

    
553
  if($taxonUuid){
554
    return cdm_compose_url(CDM_WS_PORTAL_TAXONOMY_CHILDNODES_OF_TAXON, array($viewUuid, $taxonUuid));
555
  } else {
556
    if($rankUuid){
557
      return cdm_compose_url(CDM_WS_PORTAL_TAXONOMY_CHILDNODES_AT_RANK, array($viewUuid, $rankUuid));
558
    } else {
559
      return cdm_compose_url(CDM_WS_PORTAL_TAXONOMY, array($viewUuid));
560
    }
561
  }
562
}
563

    
564
function cdm_ws_taxonomy($taxonUuid = null){
565

    
566
    $response = null;
567
    $response = cdm_ws_get(cdm_compose_taxonomy_path($taxonUuid), null, null, null, TRUE);
568

    
569
    if($response == null){
570
      // error handing
571
      if(is_uuid($_SESSION['cdm']['taxonomictree_uuid'])) {
572
        // delete the session value and try again with the default
573
        unset($_SESSION['cdm']['taxonomictree_uuid']);
574
        return cdm_ws_taxonomy($taxonUuid);
575
      } else {
576
        // check if taxonomictree_uuid is valid
577
        $test = cdm_ws_get(cdm_compose_taxonomy_path(), null, null, null, TRUE);
578
        if($test == null){
579
          print ($_SESSION['cdm']['taxonomictree_uuid']);
580
          // the default set by the admin seems to be invalid or is not even set
581
          drupal_set_message(_no_classfication_uuid_message(), 'warning');
582
        }
583
      }
584
    }
585

    
586
    return $response;
587
}
588

    
589
/**
590
 * Enter description here...
591
 *
592
 * @param UUID $secUuid
593
 * @param String $path
594
 * @return unknown
595
 */
596
function cdm_ws_taxonomy_pathFromRoot($taxonUuid){
597

    
598
  $viewUuid = get_taxonomictree_uuid_selected();
599
  $rankUuid = variable_get('taxontree_ranklimit', DEFAULT_TAXONTREE_RANKLIMIT);
600

    
601
  $response = null;
602
  if($rankUuid){
603
    $response = cdm_ws_get(CDM_WS_PORTAL_TAXONOMY_PATH_FROM_TO_RANK, array($viewUuid, $taxonUuid, $rankUuid));
604
  } else {
605
    $response = cdm_ws_get(CDM_WS_PORTAL_TAXONOMY_PATH_FROM, array($viewUuid, $taxonUuid));
606
  }
607

    
608
  if($response == null){
609
    // error handing
610
    if(is_uuid($_SESSION['cdm']['taxonomictree_uuid'])) {
611
      // delete the session value and try again with the default
612
      unset($_SESSION['cdm']['taxonomictree_uuid']);
613
      return cdm_ws_taxonomy_pathFromRoot($taxonUuid);
614
    } else {
615
        // check if taxonomictree_uuid is valid
616
        $test = cdm_ws_get(cdm_compose_taxonomy_path(), null, null, null, TRUE);
617
        if($test == null){
618
          // the default set by the admin seems to be invalid or is not even set
619
          print ($_SESSION['cdm']['taxonomictree_uuid']);
620
          // the default set by the admin seems to be invalid or is not even set
621
          drupal_set_message(_no_classfication_uuid_message(), 'warning');
622
        }
623
    }
624
  }
625

    
626
  return $response;
627
}
628

    
629
function cdm_rankVocabulary_as_option(){
630
  global $rankVocabularyOptions;
631
  if(!$rankVocabularyOptions){
632
    $vocab = cdm_ws_get(CDM_WS_TERMVOCABULARY, UUID_RANK);
633
    $rankVocabularyOptions = array();
634
    if($vocab){
635
      foreach($vocab->terms as $term){
636
        $rankVocabularyOptions[$term->uuid] = t($term->representation_L10n);
637
      }
638
      array_reverse($rankVocabularyOptions);
639
    }
640
  }
641
  return $rankVocabularyOptions;
642
}
643

    
644

    
645
function cdm_ws_descriptions_by_featuretree($featureTree, $descriptions, $isDescriptionsSeparated = false){
646

    
647
  if(!$featureTree){
648
    drupal_set_message('No \'FeatureTree\' has been set so far. '
649
    .'In order to see the species profiles of your taxa, please select a \'FeatureTree\' in the '.l('CDM Dataportal Settings', 'admin/settings/cdm_dataportal/layout'), 'warning');
650
    return false;
651
  }
652

    
653
  $mergedTrees = array();
654

    
655
  if($isDescriptionsSeparated){
656
    // merge any description into a sparate feature tree
657
    foreach($descriptions as $desc){
658
      $mergedNodes = _mergeFeatureTreeDescriptions($featureTree->root->children, $desc->elements);
659

    
660
      $mergedTree = clone $featureTree;
661
      $mergedTree->root->children = $mergedNodes;
662
      $mergedTrees[] = $mergedTree;
663
    }
664
  } else {
665
    // combine all descripions into one feature tree
666
    foreach($descriptions as $desc){
667
      $mergedNodes = _mergeFeatureTreeDescriptions($featureTree->root->children, $desc->elements);
668
      $featureTree->root->children = $mergedNodes;
669
    }
670
    $mergedTrees[] = $featureTree;
671
  }
672

    
673
  return $mergedTrees;
674
}
675

    
676
/**
677
 * @param $cdmBase
678
 * @return an array or empty
679
 */
680
function cdm_ws_getAnnotationsFor($cdmBase){
681
    $annotationUrl = cdm_compose_annotations_url($cdmBase);
682
    if($annotationUrl){
683
      $annotationPager = cdm_ws_get($annotationUrl, null, null, null, true);
684
      if(is_array($annotationPager->records)){
685
        return $annotationPager->records;
686
      }
687
    }
688
}
689

    
690
function _mergeFeatureTreeDescriptions($featureNodes, $descriptionElements){
691

    
692
  foreach($featureNodes as &$node){
693

    
694
    // append corresponding elements to an additional node field: $node->descriptionElements
695
    foreach($descriptionElements as $element) {
696
      if($element->feature->uuid == $node->feature->uuid) {
697
        if(!isset($node->descriptionElements)) {
698
          $node->descriptionElements = array();
699
        }
700
        $node->descriptionElements[] = $element;
701
      }
702
    }
703

    
704
    // recurse into node children
705
    if(is_array($node->children)){
706
      $mergedChildNodes = _mergeFeatureTreeDescriptions($node->children, $descriptionElements);
707
      $node->children = $mergedChildNodes;
708
    }
709

    
710
  }
711
  return $featureNodes;
712
}
713

    
714

    
715
/**
716
 * Send a HTTP GET request to the RESTService and deserializes
717
 * and returns the response as object.
718
 * The response objects coming from the webservice configured in the 'cdm_webservice_url' variable
719
 * are beeing cached in a level 1 (L1) and or in a level 2 (L2) cache.
720
 *
721
 * Since the L1 cache is implemented as static variable of the cdm_ws_get() function,
722
 * this cache persists only per each single page executiuon. Any object coming from the webservice is stored into it by default.
723
 * Incontrast to this default cacheich mechanism the L2 cache only is used if the 'cdm_webservice_cache' varialby is set to TRUE
724
 * which can be set using the modules administrative settings section. Object stored in this L2 cache are serialized and stored
725
 * using the drupal cache in the '{prefix}cache_cdm_ws' cache table. So the objects are sored in a database will persist as
726
 * log as the drupal cache is not beeing cleared and are availabel across multiple sript executions.
727
 *
728
 * @param $uri
729
 * @param $pathParameters an array of path parameters
730
 * @param $query  A query string to be appended to the URL.
731
 * @param $method the HTTP method to use, valuid values are "GET" or "POST";
732
 * @param $absoluteURI
733
 * @return unknown_type
734
 */
735
function cdm_ws_get($uri, $pathParameters = array(), $query = null, $method="GET", $absoluteURI = false){
736

    
737
  static $cacheL1;
738
  if(!isset($cacheL1)){
739
    $cacheL1 = array();
740
  }
741

    
742
  // transform the given uri path or patthern into a proper webservice uri
743
  if(!$absoluteURI){
744
    $uri = cdm_compose_url($uri, $pathParameters, $query);
745
  }
746

    
747
  $is_cdm_ws_uri = _is_cdm_ws_uri($uri);
748
  $use_cacheL2 = variable_get('cdm_webservice_cache', 1);
749

    
750
  if(array_key_exists($uri, $cacheL1)){
751
    $cacheL1_obj = $cacheL1[$uri];
752
  }
753
  //print $cacheL1_obj;
754
  $set_cacheL1 = false;
755
  if($is_cdm_ws_uri && !$cacheL1_obj){
756
    $set_cacheL1 = true;
757
  }
758

    
759
  // only cache cdm webservice URIs
760
  $set_cacheL2 = $use_cacheL2 && $is_cdm_ws_uri && $set_cacheL1;
761
  $cacheL2_entry = false;
762

    
763
  if($use_cacheL2){
764
    // try to get object from cacheL2
765
    $cacheL2_entry = cache_get($uri, 'cache_cdm_ws');
766
  }
767

    
768
  if($cacheL1_obj){
769
      //
770
      // The object has been found in the L1 cache
771
      //
772
      $obj = $cacheL1_obj;
773
      if(variable_get('cdm_webservice_debug', 1) && user_access('administer')){
774
        _add_status_message_toggler();
775
        _add_debugMessageStr('Using cacheL1 for: '.$uri);
776
      }
777
    } else if($cacheL2_entry) {
778
      //
779
      // The object has been found in the L2 cache
780
      //
781
      $obj = unserialize($cacheL2_entry->data);
782
      if(variable_get('cdm_webservice_debug', 1) && user_access('administer')){
783
        _add_status_message_toggler();
784
        _add_debugMessageStr('Using cacheL2 for: '.$uri);
785
      }
786
    } else {
787
      //
788
      // Get the object from the webservice and cache it
789
      //
790
      $time_get_start = microtime(true);
791
      // request data from webservice JSON or XML
792
      $datastr = cdm_http_request($uri, $method);
793
      $time_get = microtime(true) - $time_get_start;
794

    
795
      $time_parse_start = microtime(true);
796
      // parse data and create object
797
      $obj = cdm_load_obj($datastr);
798

    
799
      $time_parse = microtime(true) - $time_parse_start;
800
      if(variable_get('cdm_webservice_debug', 1) && user_access('administer')){
801
        $success_msg = $obj || $datastr == "[]" ? 'valid':'invalid';
802
        _add_debugMessage($uri, $time_get, $time_parse, strlen($datastr), $success_msg);
803
      }
804
      if($set_cacheL2) {
805
        // store the object in cacheL2
806
        cache_set($uri, 'cache_cdm_ws', serialize($obj), CACHE_TEMPORARY);
807
      }
808

    
809
  }
810
  if($obj){
811
    // store the object in cacheL1
812
    if($set_cacheL1) {
813
      $cacheL1[$uri] = $obj;
814
    }
815
  }
816

    
817
  return $obj;
818
}
819
function _add_debugMessageStr($message){
820
  _add_status_message_toggler();
821
  drupal_set_message($message, 'debug');
822
}
823

    
824
function _add_debugMessage($uri, $time_get, $time_parse, $datasize, $success_msg){
825

    
826
  static $cummulated_time_parse;
827
  static $cummulated_time_get;
828
  _add_status_message_toggler();
829

    
830
  $cummulated_time_get += $time_get;
831
  $cummulated_time_parse += $time_parse;
832

    
833
  // decompose uri into path and query element
834
  $uri_parts = explode("?", $uri);
835
  if(count($uri_parts) == 2){
836
    $path = $uri_parts[0];
837
    $query = $uri_parts[1];
838
  } else {
839
    $path = $uri;
840
  }
841

    
842
  $message = '<span class="uri">'.$uri.'</span><br />';
843
  $message .= '[fetched in: '.sprintf('%3.3f', $time_get).'s('.sprintf('%3.3f', $cummulated_time_get).'s); ';
844
  $message .= 'parsed in '.sprintf('%3.3f', $time_parse).' s('.sprintf('%3.3f', $cummulated_time_parse).'s); ';
845
  $message .= 'size:'.sprintf('%3.1f', ($datasize / 1024)).' kb of '.$success_msg.' data: ';
846
  if(_is_cdm_ws_uri($path)){
847
    $message .= '<a href="'.url($path.'.xml', $query).'" target="data" class="'.$success_msg.'">xml</a>-';
848
    $message .= '<a href="'.url('cdm_api/proxy/'.urlencode(url($path.'.xml', $query))).'" target="data" class="'.$success_msg.'">proxied</a>,';
849
    $message .= '<a href="'.url($path.'.json', $query).'" target="data" class="'.$success_msg.'">json</a>-';
850
    $message .= '<a href="'.url('cdm_api/proxy/'.urlencode(url($path.'.json', $query))).'" target="data" class="'.$success_msg.'">proxied</a>';
851
  } else {
852
      $message .= '<a href="'.url($path, $query).'" target="data" class="'.$success_msg.'">open</a>';
853
  }
854
  $message .= '] ';
855
  drupal_set_message($message, 'debug');
856

    
857
}
858

    
859

    
860
function cdm_load_obj($datastr){
861

    
862
  $obj = json_decode($datastr);
863

    
864
  if(!(is_object($obj) || is_array($obj)) ){
865
    ob_start();
866
    $obj_dump = ob_get_contents();
867
    ob_clean();
868
    return false;
869
  }
870

    
871
  return $obj;
872
}
873

    
874
/**
875
 *
876
 * @param $uri
877
 * @param $method the HTTP method to use, valuid values are "GET" or "POST"; efaults to "GET" even if null,
878
 *        false or any invalid value is supplied.
879
 * @param $parameters
880
 * @param $header
881
 * @return the response data
882
 */
883
function cdm_http_request($uri, $method="GET", $parameters = array(), $header = false){
884

    
885
  static $acceptLanguage = null;
886

    
887
  if(!$acceptLanguage) {
888
    if(function_exists('apache_request_headers')){
889
      $headers = apache_request_headers();
890
      if($headers['Accept-Language']){
891
        $acceptLanguage = $headers['Accept-Language'];
892
      }
893
    }
894
    if( !$acceptLanguage ) {
895
      $acceptLanguage = "en"; // DEFAULT TODO make configurable
896
    }
897
  }
898

    
899
  if($method != "GET" && $method != "POST"){
900
    $method  = "GET";
901
  }
902

    
903
  $header = array();
904
  if(!$header && _is_cdm_ws_uri($uri)){
905
    $header['Accept'] = (variable_get('cdm_webservice_type', 'json') == 'json' ? 'application/json' : 'text/xml');
906
    $header['Accept-Language'] = $acceptLanguage;
907
    $header['Accept-Charset'] = 'UTF-8';
908
  }
909

    
910
  if(false && function_exists('curl_init')){
911
    // !!!!! CURL Disabled due to problems with forllowing redirects (CURLOPT_FOLLOWLOCATION=1) and safe_mode = on
912
    // use the CURL lib if installed it is supposed to be 20x faster
913
    return _http_request_using_curl($uri, $header, $method, $parameters);
914
  } else {
915
    return _http_request_using_fsockopen($uri, $header, $method, $parameters);
916
  }
917
}
918

    
919
function _http_request_using_fsockopen($uri, $header = array(), $method = "GET"){
920
 $response = drupal_http_request($uri, $header, $method);
921
 return $response->data;
922
}
923

    
924

    
925
/**
926
 * Return string content from a remote file
927
 *
928
 * @param string $uri
929
 * @return string
930
 *
931
 * @author Luiz Miguel Axcar (lmaxcar@yahoo.com.br)
932
 */
933
function _http_request_using_curl($uri, $headers = array(), $method = "GET", $parameters = array())
934
{
935
  $ch = curl_init();
936

    
937
  curl_setopt ($ch, CURLOPT_URL, $uri);
938
  curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
939
  curl_setopt ($ch, CURLOPT_MAXREDIRS, 5);
940

    
941
  // set proxy settings
942
  if(variable_get('cdm_webservice_proxy_url', false)){
943
    curl_setopt($ch, CURLOPT_PROXY, variable_get('cdm_webservice_proxy_url', ''));
944
    curl_setopt($ch, CURLOPT_PROXYPORT, variable_get('cdm_webservice_proxy_port', '80'));
945
    if(variable_get('cdm_webservice_proxy_usr', false)){
946
      curl_setopt ($ch, CURLOPT_PROXYUSERPWD, variable_get('cdm_webservice_proxy_usr', '').':'.variable_get('cdm_webservice_proxy_pwd', ''));
947
    }
948
  }
949

    
950
  // modify headers array to be used by curl
951
  foreach($headers as $header_key=>$header_val){
952
    $curl_headers[] = $header_key.': '.$header_val;
953
  }
954
  if(isset($curl_headers)){
955
    curl_setopt ($ch, CURLOPT_HTTPHEADER, $curl_headers);
956
  }
957

    
958
  // set method if not default
959
  if($method != "GET"){
960
    if($method == "POST"){
961

    
962
      curl_setopt ($ch, CURLOPT_POST, 1);
963
      curl_setopt ($ch, CURLOPT_POSTFIELDS, $parameters);
964

    
965
    }else{
966
      // other obscure http methods get passed to curl directly
967
      // TODO generic parameter/body handling
968
      curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, $method);
969
    }
970
  }
971

    
972
  ob_start();
973
  curl_exec($ch);
974
  $info = curl_getinfo($ch);
975
  if(curl_errno($ch)){
976
    watchdog('CDM_API', '_http_request_curl() - '.curl_error($ch).'; REQUEST-METHOD:'.$method.' URL: '.substr($uri.' ', 0, 150), WATCHDOG_ERROR);
977
    if(variable_get('cdm_webservice_debug', 1)  && user_access('administer') ){
978
      drupal_set_message('_http_request_curl() - '.curl_error($ch).'; REQUEST-METHOD:'.$method.' URL: '.substr($uri.' ', 0, 150), 'error');
979
    }
980
  }
981
  curl_close ($ch);
982
  $string = ob_get_contents();
983
  ob_end_clean();
984

    
985
  return $string;
986
}
987

    
988
function _featureTree_elements_toString($rootNode, $separator = ', '){
989
  $out = '';
990
  $featureLabels = array();
991
  foreach ($rootNode->children as $featureNode){
992
    $out .= ($out ? $separator : '');
993
    $out .= $featureNode->feature->representation_L10n;
994
    if (is_array($featureNode->children)){
995
      $childlabels = '';
996
      foreach ($featureNode->children as $childNode)
997
      $childlabels .= ($childlabels ? $separator : '');
998
      $childlabels .= _featureTree_elements_toString($childNode);
999
    }
1000
    if($childlabels){
1001
      $out .= '['.$childlabels.' ]';
1002
    }
1003
  }
1004
  return $out;
1005
}
1006

    
1007
function cdm_get_featureTrees_as_options($addDefaultFeatureTree = false){
1008
    $feature_trees = array();
1009

    
1010
    // set tree that contains all features
1011
    if($addDefaultFeatureTree){
1012
      $feature_trees[UUID_DEFAULT_FEATURETREE] = t('Default Featuretree (contains all features)');
1013
    }
1014

    
1015
    // get features from database
1016
    $persisted_trees = cdm_ws_get(CDM_WS_FEATURETREES);
1017
    if(is_array($persisted_trees)){
1018

    
1019
        foreach($persisted_trees as $featureTree){
1020
            // do not add the DEFAULT_FEATURETREE again
1021
            if($featureTree->uuid == UUID_DEFAULT_FEATURETREE){
1022
                continue;
1023
            }
1024

    
1025
            $treeRepresentation = $featureTree->titleCache;
1026

    
1027
            if(is_array($featureTree->root->children) && count($featureTree->root->children) > 0){
1028

    
1029
              // render the hierarchic tree structure
1030
              $treeDetails = '<div class="featuretree_structure">'
1031
                //._featureTree_elements_toString($featureTree->root)
1032
                .theme('featureTree_hierarchy', $featureTree->uuid)
1033
                .'</div>';
1034

    
1035
              $form = array();
1036
              $form['featureTree-'.$featureTree->uuid] = array(
1037
                  '#type' => 'fieldset',
1038
                  '#title' => t('Show details'),
1039
                  '#collapsible' => TRUE,
1040
                  '#collapsed' => TRUE,
1041
              );
1042
              $form['featureTree-'.$featureTree->uuid]['details'] = array('#value'=>$treeDetails);
1043

    
1044
              $treeRepresentation .= drupal_render($form);
1045
            }
1046

    
1047
            $feature_trees[$featureTree->uuid] = $treeRepresentation;
1048
        }
1049

    
1050
    }
1051
    return $feature_trees;
1052
}
1053

    
1054
function cdm_get_taxontrees_as_options(){
1055
   $taxonTrees = cdm_ws_get(CDM_WS_PORTAL_TAXONOMY);
1056
   $taxonomicTreeOptions = array();
1057
   if($taxonTrees){
1058
      foreach($taxonTrees as $tree){
1059
          $taxonomicTreeOptions[$tree->uuid] = $tree->titleCache;
1060
      }
1061
   }
1062
   return $taxonomicTreeOptions;
1063
}
1064

    
1065

    
1066
function cdm_api_secref_cache_prefetch(&$secUuids){
1067
  global $secref_cache;
1068
  if(!is_array($secref_cache)){
1069
    $secref_cache = array();
1070
  }
1071
  $uniqueUuids = array_unique($secUuids);
1072
  $i = 0;
1073
  $param = '';
1074
  while($i++ < count($uniqueUuids)){
1075
    $param .= $secUuids[$i].',';
1076
    if(strlen($param) + 37 > 2000){
1077
      _cdm_api_secref_cache_add($param);
1078
      $param = '';
1079
    }
1080
  }
1081
  if($param){
1082
    _cdm_api_secref_cache_add($param);
1083
  }
1084
}
1085

    
1086
function cdm_api_secref_cache_get($secUuid){
1087
  global $secref_cache;
1088
  if(!is_array($secref_cache)){
1089
    $secref_cache = array();
1090
  }
1091
  if(!array_key_exists($secUuid, $secref_cache)){
1092
    _cdm_api_secref_cache_add($secUuid);
1093
  }
1094
  return $secref_cache[$secUuid];
1095
}
1096

    
1097
function cdm_api_secref_cache_clear(){
1098
  global $secref_cache;
1099
  $secref_cache = array();
1100
}
1101

    
1102
function is_uuid($str){
1103
  return is_string($str) && strlen($str) == 36 && strpos($str, '-');
1104
}
1105

    
1106
function _cdm_api_secref_cache_add($secUuidsStr){
1107
  global $secref_cache;
1108
  $ref = cdm_ws_get(CDM_WS_REFERENCE, $secUuidsStr);
1109
  // batch fetching not jet reimplemented thus:
1110
  /*$assocRefSTOs = array();
1111
   if($refSTOs) {
1112
   foreach($refSTOs as $ref){
1113
   $assocRefSTOs[$ref->uuid] = $ref;
1114
   }
1115
   $secref_cache = array_merge($secref_cache, $assocRefSTOs);
1116
   }*/
1117
  $secref_cache[$ref->uuid] = $ref;
1118
}
1119

    
1120
function _is_cdm_ws_uri($uri){
1121
  return str_beginsWith($uri, variable_get('cdm_webservice_url', '#EMPTY#'));
1122
}
1123

    
1124
function queryString($elements) {
1125
  $query = '';
1126
  foreach($elements as $key=>$value){
1127
    if(is_array($value)){
1128
      foreach($value as $v){
1129
        $query .= (strlen($query) > 0 ? '&' : '').$key.'='.urlencode($v);
1130
      }
1131
    } else{
1132
      $query .= (strlen($query) > 0 ? '&' : '').$key.'='.urlencode($value);
1133
    }
1134
  }
1135
  return $query;
1136
}
1137

    
1138
/**
1139
 * implementation of the magic method __clone to allow deep cloning of objects and arrays
1140
 */
1141
function __clone(){
1142
  foreach($this as $name => $value){
1143
    if(gettype($value)=='object' || gettype($value)=='array'){
1144
      $this->$name= clone($this->$name);
1145
    }
1146
  }
1147
}
1148

    
1149
/**
1150
 * Make a complete deep copy of an array replacing
1151
 * references with deep copies until a certain depth is reached
1152
 * ($maxdepth) whereupon references are copied as-is...
1153
 * [From http://us3.php.net/manual/en/ref.array.php]
1154
 * @param $array
1155
 * @param $copy
1156
 * @param $maxdepth
1157
 * @param $depth
1158
 * @return unknown_type
1159
 */
1160
function array_deep_copy (&$array, &$copy, $maxdepth=50, $depth=0) {
1161
  if($depth > $maxdepth) { $copy = $array; return; }
1162
  if(!is_array($copy)) $copy = array();
1163
  foreach($array as $k => &$v) {
1164
    if(is_array($v)) {        array_deep_copy($v,$copy[$k],$maxdepth,++$depth);
1165
    } else {
1166
      $copy[$k] = $v;
1167
    }
1168
  }
1169
}
1170

    
1171
/**
1172
 * Implementation of theme_status_messages($display = NULL)
1173
 * @see includes/theme.inc
1174
 *
1175
 * @param $display
1176
 * @return unknown_type
1177
 */
1178
function _add_status_message_toggler() {
1179
  static $isAdded;
1180
  if(!$isAdded){
1181

    
1182
    drupal_add_js(
1183
          '$(document).ready(function(){
1184

    
1185
            $(\'.messages.debug\').before( \'<h6 class="messages_toggler debug">Debug Messages (klick to toggle)</h6>\' );
1186
            $(\'.messages_toggler\').click(function(){
1187
              $(this).next().slideToggle(\'fast\');
1188
                return false;
1189
            }).next().hide();
1190

    
1191
          });'
1192
          , 'inline');
1193
          $isAdded = TRUE;
1194
  }
1195
}
1196

    
1197
function _no_classfication_uuid_message(){
1198
  return
1199
  t('This DataPortal is not configured properly.')
1200
      . l(t('Please choose a valid classification'), 'admin/settings/cdm_dataportal/general')
1201
      . t(', or contact the maintainer of this DataPortal.');
1202
}
(4-4/9)