EDIT

<?php

// $Id$

/*

 * @file

 * cdm_dataportal

 * 

 * Copyright (C) 2007 EDIT

 * European Distributed Institute of Taxonomy 

 * http://www.e-taxonomy.eu

 * 

 * The contents of this file are subject to the Mozilla Public License Version 1.1

 * See LICENSE.TXT at the top of this package for the full license terms.

 */

require_once('cdm_dataportal.theme.php');

/* ====================== hook implementations ====================== */ 

/**

 * Implementation of hook_help()

 * 

 * Display help and module information

 * @param section which section of the site we're displaying help

 * @return help text for section

 */

function cdm_dataportal_help($section='') {

    $out = '';

    switch ($section) {

        case "admin/modules#description":

            $out = t("The dataportal publishes CDM data hosted in a CommunityStore on the web.");

            break;

    }

    return $out;

}

/**

 * Implementation of hook_perm()

 * 

 * Valid permissions for this module

 * @return array An array of valid permissions for the portfolio module

 */

function cdm_dataportal_perm() {

    return array(

    	'administer cdm_dataportal',

        'cdm_dataportal view notes',

        //TODO which else permission are required? -> check the WP6 requirements document

	);

}

/**

 * Implementation of hook_menu()

 */

function cdm_dataportal_menu($may_cache) {

  $items = array();

  if ($may_cache) {

    $items[] = array(

      'path' => 'admin/settings/cdm_dataportal',

      'title' => t('CDM Dataportal'),

      'description' => t('Setting for the CDM Dataportal'),

      'access' => user_access('administer cdm_dataportal'),

      'callback' => 'drupal_get_form',

      'callback arguments' => 'cdm_dataportal_settings',

      'type' => MENU_NORMAL_ITEM,

    );

    $items[] = array(

	    'path' => 'cdm_dataportal/names',

	    'callback' => 'cdm_dataportal_view_names',

	    'access' => true,

	    'type' => MENU_CALLBACK, 

	    );

	    // optional callback arguments: page 

	$items[] = array(

	    'path' => 'cdm_dataportal/taxon',

	    'callback' => 'cdm_dataportal_view_taxon',

	    'access' => true,

	    'type' => MENU_CALLBACK, 

	    // expected callback arguments: name_uuid

	    );

	$items[] = array(

      'path' => 'cdm/xml2json',

      'callback' => 'cdm_view_xml2json',

      'access' => true,

      'type' => MENU_CALLBACK, 

      );

  }

  return $items;

}

/**

 * Implementation of hook_block()

 * 

 * Provides the following blocks:

 *  0: list of links useful during development

 *

 * @param String $op

 * @param int $delta

 */

function cdm_dataportal_block($op='list', $delta=0) {

  // listing of blocks, such as on the admin/block page

  if ($op == "list") {

    $block[0]["info"] = t("CDM DataPortal DevLinks");

    return $block;

  }

  else if ($op == 'view') {

    switch($delta){

      case 0:

        $block['subject'] = t('CDM DataPortal DevLinks');

        $block['content'] = '<ul>

        <li>'.l('A Taxon Page', cdm_dataportal_taxon_path('5000001-stub')).'</li>

        <li>'.l('Name List - page1 of A', 'cdm_dataportal/names/A/1').'</li>

        <li>'.l('xml2json', 'cdm/xml2json/namelist;startwith=A.xml').'</li>

        </ul>';

        return $block;

    }

  }

}

/**

 * Implementation of hook_validate()

 *

 * @param $element

 */

function cdm_dataportal_settings_validate($form_id, $form_values){

  if (!str_endsWith($form_values['cdm_webservice_url'], '/')) {

      form_set_error('cdm_webservice_url', t("The URL to the CDM Web Service must end with a slash: '/'."));

    }

}

/* ====================== menu callback functions ====================== */

/**

 * Generate main administration form.

 *

 * @return

 *   An array containing form items to place on the module settings page.

 */

function cdm_dataportal_settings(){

   //TODO: settings are still incomplete, compare with trunk/dataportal/inc/config_default.php.inc

    $form['cdm_webservice'] = array(

      '#type' => 'fieldset',

      '#title' => t('CDM Web Servic'),

      '#collapsible' => FALSE,

      '#collapsed' => TRUE,

    );

   $form['cdm_webservice']['cdm_webservice_url'] =  array(

    '#type' => 'textfield',

    '#title'         => t('CDM Web Service URL'),

    '#description'   => t('The URL of CDM Webservice which delivers the data to be published.'),

    '#default_value' => variable_get('cdm_webservice_url', 'http://dev.e-taxonomy.eu/svn/trunk/drupal/modules/cdm_dataportal/cdm_api/ws_stub/'),

    );

    $form['cdm_webservice']['cdm_webservice_isStub'] =  array(

    '#type' => 'checkbox',

    '#title'         => t('Use Web Service Stub'),

    '#default_value' => variable_get('cdm_webservice_isStub', 1),

    '#description'   => t('Use a static web service stub. Only for development. For further information please refer to the ')

                      .l('ws_stub/README.txt', 'http://dev.e-taxonomy.eu/svn/trunk/drupal/modules/cdm_dataportal/cdm/ws_stub/README.txt', array('target'=>'_blank')),

    );

    $form['cdm_webservice']['cdm_webservice_type'] =  array(

    '#type' => 'select',

    '#title'         => t('Web Service Type'),

    '#default_value' => variable_get('cdm_webservice_type', 'json'),

    '#options' => array(

        'xml' => t('XML'),

        'json' => t('JSON'),

      ),

    '#description'   => t('The response data type of the web service.'),

     );

   return system_settings_form($form);

}

/**

 * Displays a list of the known taxonomic names. Long lists are split up into multiple pages

 *

 * TODO: parameters are still preliminar

 * @param String $page page number to diplay defaults to page 1

 * @param boolean $hide_unaccepted whether to hide nams which are not accepted by the current view

 */

function cdm_dataportal_view_names($beginsWith = 'A', $page = 1, $onlyAccepted = false ){

    $taxonSTOs = cdm_ws_name_list($beginsWith, $page, $onlyAccepted, $_SESSION['cdm']['namelist_pagesize']);

    /*   

     * FIXME the filter for accepted names will be form element, thus this widget 

     * should be generated via form api!

     */

    //$out  = theme('cdm_dataportal_widget_filter_accepted', $onlyAccepted);

    //$out .= theme('cdm_dataportal_widget_names_list', $names, $page);

    $out .= theme('cdm_dataportal_names_list', $taxonSTOs);

    return $out;

}

/**

 * The taxon page gives detailed information on a taxon, it shows:

 *  - Taxon name

 *  - Full list of synonyms homotypic synonyms on top, followed by the 

 *    heterotypic and finally followed by misapplied names. 

 *    The list is ordered historically.

 *  - All facts associated with the very taxon concept and taxon name. 

 *

 * @param String $uuid the UUID of the taxon  

 */

function cdm_dataportal_view_taxon($uuid){

  $taxon = cdm_ws_get_taxon($uuid);

  drupal_set_title($taxon->name->fullname.' '.theme('cdm_nomenclaturalReferenceSTO', $taxon->nomenclaturalReference));

  //TODO retrieve complete synonymy and other data 

  $out = theme('cdm_taxon', $taxon); 

  return $out;

}

function cdm_view_xml2json(){

  $file = arg(2);

  $datastr = get_content(variable_get('cdm_webservice_url', '').$file);

  return  xml2json::transformXmlStringToJson($datastr);

}

/* ====================== other functions ====================== */

/**

 * Enter description here...

 *

 * @param String $uuid the UUID of the taxon

 * @return the URL

 */

function cdm_dataportal_taxon_path($uuid){

  return 'cdm_dataportal/taxon/'.$uuid;

}

/**

 * Creates a short taxonname by using the taggename field of NameSTO or NameTO instances.

 * If the taggename if empty the fullname will be returned.

 *

 * @param unknown_type $NameSTO a NameSTO or NameTO instance

 * @return string 

 */

function cdm_dataportal_shortname_of($NameSTO){

  $name = trim(cdm_taggedtext_value($NameSTO->taggedName, 'name'));

  if($name){

    if( $pos = stripos($name, ' ')){

      return substr($name, 0, 1).'. '.substr($name, $pos);

    } else {

      return $name;

    }

  } else {

    return $NameSTO->fullname;

  }

}

/**

 * @param $str the string to truncate

 * @param $len the maximun length

 * @param $appendix an optional appendix.

 *

 * @return the string truncated to the specified length or the original string as given as parameter.

 * if an appendix has been defined the resulting string

 * will have the specified length inculding the the appendix.

 */

function str_trunk(&$str, $len, $appendix=''){

    if(strlen($str) >= $len )

    return  substr($str, 0, $len - strlen($appendix)).$appendix;

    else

    return $str;

}

/**

 * @param string $str

 * @param string $sub

 * @return boolean

 */

function str_beginsWith( $str, $sub ) {

    return ( substr( $str, 0, strlen( $sub ) ) === $sub );

}

/**

 * 

 * @param string $str

 * @param string $sub

 * @return boolean

 */

function str_endsWith( $str, $sub ) {

    return ( substr( $str, strlen( $str ) - strlen( $sub ) ) === $sub );

}