Project

General

Profile

Download (35.2 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 = cdm_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
      $data = cdm_http_request($uri);
425
      print $data;
426
      exit;
427
    } else {
428
      $obj = cdm_ws_get($uri, null, null, null, TRUE);
429
      array_unshift($args, $theme, $obj);
430
      print call_user_func_array('theme', $args);
431
    }
432
  }
433
}
434

    
435
function setvalue_session(){
436

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

    
445
  // prevent from malicous tags
446
  $val = strip_tags($val);
447

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

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

    
466
function cdm_compose_annotations_url($cdmBase){
467

    
468
    if(!$cdmBase->uuid){
469
        return;
470
    }
471

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

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

    
531
//function cdm_ws_taxonomy_compose_resourcePath($path = null){
532
//  $viewrank =  _cdm_taxonomy_compose_viewrank();
533
//  return CDM_WS_PORTAL_TAXONOMY . '/' . ($viewrank ? $viewrank : '' ) . ($path ? '/' . $path : '') ;
534
//}
535

    
536

    
537
/**
538
 * Enter description here...
539
 *
540
 * @param unknown_type $secUuid
541
 * @param unknown_type $path
542
 * @return unknown
543
 */
544
function cdm_compose_taxonomy_path($taxonUuid = false){
545

    
546
	$viewUuid = get_taxonomictree_uuid_selected();
547
	$rankUuid = variable_get('taxontree_ranklimit', DEFAULT_TAXONTREE_RANKLIMIT);
548

    
549
	if($taxonUuid){
550
		return cdm_compose_url(CDM_WS_PORTAL_TAXONOMY_CHILDNODES_OF_TAXON, array($viewUuid, $taxonUuid));
551
	} else {
552
		if($rankUuid){
553
			return cdm_compose_url(CDM_WS_PORTAL_TAXONOMY_CHILDNODES_AT_RANK, array($viewUuid, $rankUuid));
554
		} else {
555
			return cdm_compose_url(CDM_WS_PORTAL_TAXONOMY, array($viewUuid));
556
		}
557
	}
558
}
559

    
560
function cdm_ws_taxonomy($taxonUuid = null){
561

    
562
    $response = null;
563
    $response = cdm_ws_get(cdm_compose_taxonomy_path($taxonUuid), null, null, null, TRUE);
564

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

    
582
    return $response;
583
}
584

    
585
/**
586
 * Enter description here...
587
 *
588
 * @param UUID $secUuid
589
 * @param String $path
590
 * @return unknown
591
 */
592
function cdm_ws_taxonomy_pathFromRoot($taxonUuid){
593

    
594
  $viewUuid = get_taxonomictree_uuid_selected();
595
  $rankUuid = variable_get('taxontree_ranklimit', DEFAULT_TAXONTREE_RANKLIMIT);
596

    
597
  $response = null;
598
  if($rankUuid){
599
  	$response = cdm_ws_get(CDM_WS_PORTAL_TAXONOMY_PATH_FROM_TO_RANK, array($viewUuid, $taxonUuid, $rankUuid));
600
  } else {
601
    $response = cdm_ws_get(CDM_WS_PORTAL_TAXONOMY_PATH_FROM, array($viewUuid, $taxonUuid));
602
  }
603

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

    
622
  return $response;
623
}
624

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

    
640

    
641
function cdm_ws_descriptions_by_featuretree($featureTree, $descriptions, $isDescriptionsSeparated = false){
642

    
643
  if(!$featureTree){
644
    drupal_set_message('No \'FeatureTree\' has been set so far. '
645
    .'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');
646
    return false;
647
  }
648

    
649
  $mergedTrees = array();
650

    
651
  if($isDescriptionsSeparated){
652
    // merge any description into a sparate feature tree
653
    foreach($descriptions as $desc){
654
      $mergedNodes = _mergeFeatureTreeDesciptions($featureTree->root->children, $desc->elements);
655

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

    
669
  return $mergedTrees;
670
}
671

    
672
function _mergeFeatureTreeDesciptions($featureNodes, $descriptionElements){
673

    
674
  foreach($featureNodes as &$node){
675

    
676
    // append corresponding elements to an additional node field: $node->descriptionElements
677
    foreach($descriptionElements as $element){
678
      if($element->feature->uuid == $node->feature->uuid){
679
        if(!isset($node->descriptionElements)){
680
          $node->descriptionElements = array();
681
        }
682
        $node->descriptionElements[] = $element;
683
      }
684
    }
685

    
686
    // recurse into node children
687
    if(is_array($node->children)){
688
    	/*
689
    	var_dump('++++++++++++++++++++');
690
    	var_dump($node->children);
691
    	var_dump('####################');
692

    
693
      foreach($node->children as $nodes){
694
        $mergedChildNodes = _mergeFeatureTreeDesciptions($nodes, $descriptionElements);
695
        $node->children = $mergedChildNodes;
696
      }
697
      */
698
    	$mergedChildNodes = _mergeFeatureTreeDesciptions($node->children, $descriptionElements);
699
      $node->children = $mergedChildNodes;
700
    }
701

    
702
  }
703
  return $featureNodes;
704
}
705

    
706

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

    
729
  static $cacheL1;
730
  if(!isset($cacheL1)){
731
    $cacheL1 = array();
732
  }
733

    
734
  // transform the given uri path or patthern into a proper webservice uri
735
  if(!$absoluteURI){
736
    $uri = cdm_compose_url($uri, $pathParameters, $query);
737
  }
738

    
739
  $is_cdm_ws_uri = _is_cdm_ws_uri($uri);
740
  $use_cacheL2 = variable_get('cdm_webservice_cache', 1);
741

    
742
  if(array_key_exists($uri, $cacheL1)){
743
    $cacheL1_obj = $cacheL1[$uri];
744
  }
745
  //print $cacheL1_obj;
746
  $set_cacheL1 = false;
747
  if($is_cdm_ws_uri && !$cacheL1_obj){
748
    $set_cacheL1 = true;
749
  }
750

    
751
  // only cache cdm webservice URIs
752
  $set_cacheL2 = $use_cacheL2 && $is_cdm_ws_uri && $set_cacheL1;
753
  $cacheL2_entry = false;
754

    
755
  if($use_cacheL2){
756
    // try to get object from cacheL2
757
    $cacheL2_entry = cache_get($uri, 'cache_cdm_ws');
758
  }
759

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

    
787
      $time_parse_start = microtime(true);
788
      // parse data and create object
789
      $obj = cdm_load_obj($datastr);
790

    
791
      $time_parse = microtime(true) - $time_parse_start;
792
      if(variable_get('cdm_webservice_debug', 1) && user_access('administer')){
793
        $success_msg = $obj || $datastr == "[]" ? 'valid':'invalid';
794
        _add_debugMessage($uri, $time_get, $time_parse, strlen($datastr), $success_msg);
795
      }
796
      if($set_cacheL2) {
797
        // store the object in cacheL2
798
        cache_set($uri, 'cache_cdm_ws', serialize($obj), CACHE_TEMPORARY);
799
      }
800

    
801
  }
802
  if($obj){
803
    // store the object in cacheL1
804
    if($set_cacheL1) {
805
      $cacheL1[$uri] = $obj;
806
    }
807
  }
808

    
809
  return $obj;
810
}
811
function _add_debugMessageStr($message){
812
  _add_status_message_toggler();
813
  drupal_set_message($message, 'debug');
814
}
815

    
816
function _add_debugMessage($uri, $time_get, $time_parse, $datasize, $success_msg){
817

    
818
  static $cummulated_time_parse;
819
  static $cummulated_time_get;
820
  _add_status_message_toggler();
821

    
822
  $cummulated_time_get += $time_get;
823
  $cummulated_time_parse += $time_parse;
824

    
825
  // decompose uri into path and query element
826
  $uri_parts = explode("?", $uri);
827
  if(count($uri_parts) == 2){
828
    $path = $uri_parts[0];
829
    $query = $uri_parts[1];
830
  } else {
831
    $path = $uri;
832
  }
833

    
834
  $message = '<span class="uri">'.$uri.'</span><br />';
835
  $message .= '[fetched in: '.sprintf('%3.3f', $time_get).'s('.sprintf('%3.3f', $cummulated_time_get).'s); ';
836
  $message .= 'parsed in '.sprintf('%3.3f', $time_parse).' s('.sprintf('%3.3f', $cummulated_time_parse).'s); ';
837
  $message .= 'size:'.sprintf('%3.1f', ($datasize / 1024)).' kb of '.$success_msg.' data: ';
838
  if(_is_cdm_ws_uri($path)){
839
	  $message .= '<a href="'.url($path.'.xml', $query).'" target="data" class="'.$success_msg.'">xml</a>,';
840
	  $message .= '<a href="'.url($path.'.json', $query).'" target="data" class="'.$success_msg.'">json</a>';
841
  } else {
842
  	  $message .= '<a href="'.url($path, $query).'" target="data" class="'.$success_msg.'">open</a>';
843
  }
844
  $message .= '] ';
845
  drupal_set_message($message, 'debug');
846

    
847
}
848

    
849

    
850
function cdm_load_obj($datastr){
851

    
852
  $obj = json_decode($datastr);
853

    
854
  if(!(is_object($obj) || is_array($obj)) ){
855
    ob_start();
856
    $obj_dump = ob_get_contents();
857
    ob_clean();
858
    return false;
859
  }
860

    
861
  return $obj;
862
}
863

    
864
/**
865
 *
866
 * @param $uri
867
 * @param $method the HTTP method to use, valuid values are "GET" or "POST"; efaults to "GET" even if null,
868
 *        false or any invalid value is supplied.
869
 * @param $parameters
870
 * @param $header
871
 * @return the response data
872
 */
873
function cdm_http_request($uri, $method="GET", $parameters = array(), $header = false){
874

    
875
  static $acceptLanguage = null;
876

    
877
  if(!$acceptLanguage) {
878
  	if(function_exists('apache_request_headers')){
879
  		$headers = apache_request_headers();
880
	  	if($headers['Accept-Language']){
881
	  		$acceptLanguage = $headers['Accept-Language'];
882
	  	}
883
  	}
884
  	if( !$acceptLanguage ) {
885
  		$acceptLanguage = "en"; // DEFAULT TODO make configurable
886
  	}
887
  }
888

    
889
  if($method != "GET" && $method != "POST"){
890
    $method  = "GET";
891
  }
892

    
893
  $header = array();
894
  if(!$header && _is_cdm_ws_uri($uri)){
895
    $header['Accept'] = (variable_get('cdm_webservice_type', 'json') == 'json' ? 'application/json' : 'text/xml');
896
    $header['Accept-Language'] = $acceptLanguage;
897
    $header['Accept-Charset'] = 'UTF-8';
898
  }
899

    
900
  if(false && function_exists('curl_init')){
901
  	// !!!!! CURL Disabled due to problems with forllowing redirects (CURLOPT_FOLLOWLOCATION=1) and safe_mode = on
902
    // use the CURL lib if installed it is supposed to be 20x faster
903
    return _http_request_using_curl($uri, $header, $method, $parameters);
904
  } else {
905
    return _http_request_using_fsockopen($uri, $header, $method, $parameters);
906
  }
907
}
908

    
909
function _http_request_using_fsockopen($uri, $header = array(), $method = "GET"){
910
 $response = drupal_http_request($uri, $header, $method);
911
 return $response->data;
912
}
913

    
914

    
915
/**
916
 * Return string content from a remote file
917
 *
918
 * @param string $uri
919
 * @return string
920
 *
921
 * @author Luiz Miguel Axcar (lmaxcar@yahoo.com.br)
922
 */
923
function _http_request_using_curl($uri, $headers = array(), $method = "GET", $parameters = array())
924
{
925
  $ch = curl_init();
926

    
927
  curl_setopt ($ch, CURLOPT_URL, $uri);
928
  curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
929
  curl_setopt ($ch, CURLOPT_MAXREDIRS, 5);
930

    
931
  // set proxy settings
932
  if(variable_get('cdm_webservice_proxy_url', false)){
933
    curl_setopt($ch, CURLOPT_PROXY, variable_get('cdm_webservice_proxy_url', ''));
934
    curl_setopt($ch, CURLOPT_PROXYPORT, variable_get('cdm_webservice_proxy_port', '80'));
935
    if(variable_get('cdm_webservice_proxy_usr', false)){
936
      curl_setopt ($ch, CURLOPT_PROXYUSERPWD, variable_get('cdm_webservice_proxy_usr', '').':'.variable_get('cdm_webservice_proxy_pwd', ''));
937
    }
938
  }
939

    
940
  // modify headers array to be used by curl
941
  foreach($headers as $header_key=>$header_val){
942
    $curl_headers[] = $header_key.': '.$header_val;
943
  }
944
  if(isset($curl_headers)){
945
    curl_setopt ($ch, CURLOPT_HTTPHEADER, $curl_headers);
946
  }
947

    
948
  // set method if not default
949
  if($method != "GET"){
950
    if($method == "POST"){
951

    
952
      curl_setopt ($ch, CURLOPT_POST, 1);
953
      curl_setopt ($ch, CURLOPT_POSTFIELDS, $parameters);
954

    
955
    }else{
956
      // other obscure http methods get passed to curl directly
957
      // TODO generic parameter/body handling
958
      curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, $method);
959
    }
960
  }
961

    
962
  ob_start();
963
  curl_exec($ch);
964
  $info = curl_getinfo($ch);
965
  if(curl_errno($ch)){
966
    watchdog('CDM_API', '_http_request_curl() - '.curl_error($ch).'; REQUEST-METHOD:'.$method.' URL: '.substr($uri.' ', 0, 150), WATCHDOG_ERROR);
967
    if(variable_get('cdm_webservice_debug', 1)  && user_access('administer') ){
968
      drupal_set_message('_http_request_curl() - '.curl_error($ch).'; REQUEST-METHOD:'.$method.' URL: '.substr($uri.' ', 0, 150), 'error');
969
    }
970
  }
971
  curl_close ($ch);
972
  $string = ob_get_contents();
973
  ob_end_clean();
974

    
975
  return $string;
976
}
977

    
978
function _featureTree_elements_toString($rootNode, $separator = ', '){
979
	$out = '';
980
	$featureLabels = array();
981
  foreach ($rootNode->children as $featureNode){
982
  	$out .= ($out ? $separator : '');
983
    $out .= $featureNode->feature->representation_L10n;
984
    if (is_array($featureNode->children)){
985
    	$childlabels = '';
986
    	foreach ($featureNode->children as $childNode)
987
    	$childlabels .= ($childlabels ? $separator : '');
988
    	$childlabels .= _featureTree_elements_toString($childNode);
989
    }
990
    if($childlabels){
991
    	$out .= '['.$childlabels.' ]';
992
    }
993
  }
994
  return $out;
995
}
996

    
997
function cdm_get_featureTrees_as_options($addDefaultFeatureTree = false){
998
    $feature_trees = array();
999

    
1000
    // set tree that contains all features
1001
    if($addDefaultFeatureTree){
1002
      $feature_trees[UUID_DEFAULT_FEATURETREE] = t('Default Featuretree (contains all features)');
1003
    }
1004

    
1005
    // get features from database
1006
    $persisted_trees = cdm_ws_get(CDM_WS_FEATURETREES);
1007
    if(is_array($persisted_trees)){
1008

    
1009
        foreach($persisted_trees as $featureTree){
1010
            // do not add the DEFAULT_FEATURETREE again
1011
            if($featureTree->uuid == UUID_DEFAULT_FEATURETREE){
1012
                continue;
1013
            }
1014

    
1015
            $treeRepresentation = $featureTree->titleCache;
1016

    
1017
            if(is_array($featureTree->root->children) && count($featureTree->root->children) > 0){
1018
	            $treeDetails = '<div class="featuretree_structure">'
1019
	              //._featureTree_elements_toString($featureTree->root)
1020
	              .theme('featureTree_hierarchy', $featureTree->uuid)
1021
	              .'</div>';
1022
		          $form = array();
1023
	            $form['featureTree-'.$featureTree->uuid] = array(
1024
	                '#type' => 'fieldset',
1025
						      '#title' => t('Show details'),
1026
						      '#collapsible' => TRUE,
1027
						      '#collapsed' => TRUE,
1028
						  );
1029
						  $form['featureTree-'.$featureTree->uuid]['details'] = array('#value'=>$treeDetails);
1030

    
1031
						  $treeRepresentation .= drupal_render($form);
1032
            }
1033

    
1034
            $feature_trees[$featureTree->uuid] = $treeRepresentation;
1035
        }
1036

    
1037
    }
1038
    return $feature_trees;
1039
}
1040

    
1041
function cdm_get_taxontrees_as_options(){
1042
   $taxonTrees = cdm_ws_get(CDM_WS_PORTAL_TAXONOMY);
1043
   $taxonomicTreeOptions = array();
1044
   if($taxonTrees){
1045
	    foreach($taxonTrees as $tree){
1046
	        $taxonomicTreeOptions[$tree->uuid] = $tree->titleCache;
1047
	    }
1048
   }
1049
   return $taxonomicTreeOptions;
1050
}
1051

    
1052

    
1053
function cdm_api_secref_cache_prefetch(&$secUuids){
1054
  global $secref_cache;
1055
  if(!is_array($secref_cache)){
1056
    $secref_cache = array();
1057
  }
1058
  $uniqueUuids = array_unique($secUuids);
1059
  $i = 0;
1060
  $param = '';
1061
  while($i++ < count($uniqueUuids)){
1062
    $param .= $secUuids[$i].',';
1063
    if(strlen($param) + 37 > 2000){
1064
      _cdm_api_secref_cache_add($param);
1065
      $param = '';
1066
    }
1067
  }
1068
  if($param){
1069
    _cdm_api_secref_cache_add($param);
1070
  }
1071
}
1072

    
1073
function cdm_api_secref_cache_get($secUuid){
1074
  global $secref_cache;
1075
  if(!is_array($secref_cache)){
1076
    $secref_cache = array();
1077
  }
1078
  if(!array_key_exists($secUuid, $secref_cache)){
1079
    _cdm_api_secref_cache_add($secUuid);
1080
  }
1081
  return $secref_cache[$secUuid];
1082
}
1083

    
1084
function cdm_api_secref_cache_clear(){
1085
  global $secref_cache;
1086
  $secref_cache = array();
1087
}
1088

    
1089
function is_uuid($str){
1090
	return is_string($str) && strlen($str) == 36 && strpos($str, '-');
1091
}
1092

    
1093
function _cdm_api_secref_cache_add($secUuidsStr){
1094
  global $secref_cache;
1095
  $ref = cdm_ws_get(CDM_WS_REFERENCE, $secUuidsStr);
1096
  // batch fetching not jet reimplemented thus:
1097
  /*$assocRefSTOs = array();
1098
   if($refSTOs) {
1099
   foreach($refSTOs as $ref){
1100
   $assocRefSTOs[$ref->uuid] = $ref;
1101
   }
1102
   $secref_cache = array_merge($secref_cache, $assocRefSTOs);
1103
   }*/
1104
  $secref_cache[$ref->uuid] = $ref;
1105
}
1106

    
1107
function _is_cdm_ws_uri($uri){
1108
	return str_beginsWith($uri, variable_get('cdm_webservice_url', '#EMPTY#'));
1109
}
1110

    
1111
function queryString($elements) {
1112
  $query = '';
1113
  foreach($elements as $key=>$value){
1114
    if(is_array($value)){
1115
      foreach($value as $v){
1116
        $query .= (strlen($query) > 0 ? '&' : '').$key.'='.urlencode($v);
1117
      }
1118
    } else{
1119
      $query .= (strlen($query) > 0 ? '&' : '').$key.'='.urlencode($value);
1120
    }
1121
  }
1122
  return $query;
1123
}
1124

    
1125
/**
1126
 * implementation of the magic method __clone to allow deep cloning of objects and arrays
1127
 */
1128
function __clone(){
1129
  foreach($this as $name => $value){
1130
    if(gettype($value)=='object' || gettype($value)=='array'){
1131
      $this->$name= clone($this->$name);
1132
    }
1133
  }
1134
}
1135

    
1136
/**
1137
 * Make a complete deep copy of an array replacing
1138
 * references with deep copies until a certain depth is reached
1139
 * ($maxdepth) whereupon references are copied as-is...
1140
 * [From http://us3.php.net/manual/en/ref.array.php]
1141
 * @param $array
1142
 * @param $copy
1143
 * @param $maxdepth
1144
 * @param $depth
1145
 * @return unknown_type
1146
 */
1147
function array_deep_copy (&$array, &$copy, $maxdepth=50, $depth=0) {
1148
  if($depth > $maxdepth) { $copy = $array; return; }
1149
  if(!is_array($copy)) $copy = array();
1150
  foreach($array as $k => &$v) {
1151
    if(is_array($v)) {        array_deep_copy($v,$copy[$k],$maxdepth,++$depth);
1152
    } else {
1153
      $copy[$k] = $v;
1154
    }
1155
  }
1156
}
1157

    
1158
/**
1159
 * Implementation of theme_status_messages($display = NULL)
1160
 * @see includes/theme.inc
1161
 *
1162
 * @param $display
1163
 * @return unknown_type
1164
 */
1165
function _add_status_message_toggler() {
1166
  static $isAdded;
1167
  if(!$isAdded){
1168

    
1169
    drupal_add_js(
1170
          '$(document).ready(function(){
1171

    
1172
            $(\'.messages.debug\').before( \'<h6 class="messages_toggler debug">Debug Messages (klick to toggle)</h6>\' );
1173
            $(\'.messages_toggler\').click(function(){
1174
              $(this).next().slideToggle(\'fast\');
1175
                return false;
1176
            }).next().hide();
1177

    
1178
          });'
1179
          , 'inline');
1180
          $isAdded = TRUE;
1181
  }
1182
}
1183

    
1184
function _no_classfication_uuid_message(){
1185
	return
1186
	t('This DataPortal is not configured properly.')
1187
      . l(t('Please choose a valid classification'), 'admin/settings/cdm_dataportal/general')
1188
      . t(', or contact the maintainer of this DataPortal.');
1189
}
(4-4/9)