modules/carto/carto.module

<?php
// $Id: carto.module,v 1.21 2006/10/15 22:37:26 openwereld Exp $

define( 'DEFAULT_WMS_SEARCH_FIELDS', 'name,title,keywords,abstract' );
define( 'DEFAULT_CARTO_WMS_TEASER_MAP', 1 );
define( "DEFAULT_GOOGLEMAP_KEY", "ABQIAAAAaypyu9OS8HKVoRqCx3wW2BT2yXp_ZAY8_ufC3CFXhHIE1NvwkxQWOIyCzqRypc-sQQZGpc-Mp-Jf7g" );

/**                                  
 * Implementation of hook_help().
 *
 * @param $section
 *      A string containing the path info.
 * @return
 *      The output string which may contain html tags.
 */
function carto_help( $section )
{
    $output = '';
//print 'carto_help:' . $section . '<br />';
    switch( $section )
    {
    case 'carto':
        $output = '<p>... help for carto menu item ...</p>';
        break;
    case 'carto/maps':
        $output = '<p>Nodes that contain mapping objects.</p>';
        break;
    case 'carto/wms':
        $output = '<p>Web mapping services.</p>';
        break;
        
    // following texts are shown in /admin/help/carto (in 2 parts)
    //case 'admin/help/carto': // 1st part
    //    break;
    case 'admin/help#carto': // 2nd part
        // return something to prevent message "No help is available for module carto."
        $output .= '<p>' . t('The Carto module uses mappingwidgets for web mapping functionality.') . '</p>';
        $output .= '<p>' . t('For more help on mappingwidgets see <a href="http://mappingtools.org/manual/">http://mappingtools.org/manual/</a>.') . '</p>';
        break;
        
    case 'admin/modules#description':
        // description of this module in administer/modules
        $output = t( "Cartography module; web mapping according to <a href=\"http://www.opengis.org\">OpenGIS</a> standards using the <a href=\"http://mappingwidgets.sourceforge.net\" target=\"_blank\">mappingwidgets</a> package." );
        break;

    case 'admin/settings/carto':
        // visible for administer/settings/carto
        $output = t("Settings for the carto module and for the external packages it requires.");
        break;
/* commented out
    case 'node/add#carto':
        // for carto item in 'create content'
        $output = t( "TODO: something about creating content in the carto module" );
        break;
*/
    case 'admin/block/configure/carto/1':
        // no help for the configuration of the overview block
        break;
    case 'admin/block/configure/carto/2':
        // no help for the configuration of the legend block
        break;
    
    case 'node/add#cartowms':
//print 'carto_help:' . $section . '<br />';
        $output = t('Add a Opengis web mapping service.');
        break;
    
    case 'node/add#carto-wfs':
        $output = t('Add a Opengis web feature service.');
        break;
    }
    
    if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == 'layers') {
        return t('Select the layers to be visible in the wms node. At leas one layer is required, and the selected layers must have a SRS in common.');
    }

    return $output;
}

/**
 * Module initialization
 * 
 * Initialize carto system.
 */
function carto_init( )
{
    // If not in bootstrap, include hooks
    if( ! _carto_is_bootstrap( ) )
    {
        include drupal_get_path('module','carto') . '/carto.inc';    
    }
}   

/**
 * Implementation of hook_exit()
 */
function carto_exit( $destination = NULL )
{
    // cleanup tasks
}

/**
 * Check whether we are in bootstrap mode
 */  
function _carto_is_bootstrap( )
{
    return ! function_exists('drupal_get_headers');
}

function carto_wms_access( $op, $node )
{
    global $user;
    
    drupal_set_message( 'carto_wms_access: ' . $op );
    switch( $op )
    {
        case 'view':
            return user_access( 'view wms nodes' );
        case 'create':
            return user_access( 'create wms nodes' ) && $user->uid;
        case 'delete': // own nodes only!
            return user_access( 'create wms nodes' ) && $user->uid == $node->uid;
    }
    
    drupal_set_message( 'carto_wms_access: ' . var_export(func_get_args(),true) );
}

/**
 * Implementation of hook_perm().
 */
function carto_perm( )
{
    // user permissions
    return array( 
        'administer carto'
        , 'create wms nodes' // create or edit wms nodes
        , 'view wms nodes' // view wms nodes
        , 'query wms nodes' // query wms nodes
        , 'select wms layers' // select wms layers (select layers)
//        , 'create wfs nodes'
//        , 'access wfs nodes'
        );
}

/**
 * Implementation of hook_menu().
 */
function carto_menu( $may_cache )
{
    global $user;
    $items = array();
    
    if( $may_cache )
    {
        $items[] = array( 'path' => 'node/add/cartowms'
                , 'title' => t('wms node')
                , 'access' => user_access('create wms nodes')
                );
                
        $items[] = array( 'path' => 'carto'
                , 'title' => t('carto')
                , 'access' => user_access('access content')
                , 'callback' => 'carto_all'
                , 'type' => MENU_NORMAL_ITEM
                );

        // nodes with carto-filters
        $items[] = array( 'path' => 'carto/maps'
                , 'title' => t('maps')
                , 'callback' => 'carto_page'
                , 'access' => user_access('access content')
                , 'type' => MENU_NORMAL_ITEM
                );
        $items[] = array( 'path' => 'carto/maps/' . $user->uid
                , 'title' => t('my maps')
                , 'access' => $user->uid > 0 && user_access('access content')
                , 'type' => MENU_NORMAL_ITEM
                );
        
        // nodes of web mapping servers
        $items[] = array( 'path' => 'carto/wms'
                , 'title' => t('wms')
                , 'callback' => 'carto_wms_all'
                , 'access' => user_access('view wms nodes')
                , 'type' => MENU_NORMAL_ITEM
                );
        
        $items[] = array( 'path' => 'carto/wms/node'
                //, 'callback' => 'carto_wms_query'
                , 'access' => user_access('query wms nodes')
                , 'type' => MENU_CALLBACK
                );
        
        $items[] = array( 'path' => 'carto/wms/user/' . $user->uid
                , 'title' => t('my wms')
                , 'access' => $user->uid > 0 && user_access('view wms nodes')
                , 'type' => MENU_NORMAL_ITEM
                );
        
        $items[] = array( 'path' => 'carto/feed'
                , 'title' => t('RSS feed')
                , 'callback' => 'carto_feed'
                , 'access' => user_access('access content')
                , 'type' => MENU_CALLBACK
                );
        $items[] = array( 'path' => 'carto/wms/feed'
                , 'title' => t('RSS feed')
                , 'callback' => 'carto_feed_wms'
                , 'access' => user_access('access content')
                , 'type' => MENU_CALLBACK
                );
        
        // settings
        $items[] = array( 'path' => 'admin/settings/carto'
                , 'title' => t('carto')
                , 'callback' => 'drupal_get_form'
                , 'callback arguments' => 'carto_admin_settings'
                , 'access' => user_access('administer site configuration')
                , 'type' => MENU_NORMAL_ITEM
                );
        
        // used for ajax functionality?
        $items[] = array( 'path' => 'carto/action/simple'
                , 'callback' => 'carto_action_simple'
                , 'type' => MENU_CALLBACK
                , 'access' => user_access('access content')
                );
        $items[] = array( 'path' => 'carto/action/gpx'
                , 'callback' => 'carto_action_gpx'
                , 'type' => MENU_CALLBACK
                , 'access' => user_access('access content')
                );
    }
    else
    {
        if( arg(0) == 'node' && is_numeric(arg(1)) && user_access('select wms layers')) 
        {
            // Only add the 'select layers'-tab for cartowms pages:
            $result = db_query(db_rewrite_sql("SELECT n.nid FROM {node} n WHERE n.nid = %d AND n.type = 'cartowms'"), arg(1));
            if (db_num_rows($result) > 0)
            {
                $items[] = array( 'path' => 'node/' . arg(1) . '/layers'
                    , 'title' => t('select layers')
                    , 'callback' => 'drupal_get_form'
                    , 'callback arguments' => array('carto_wms_select_layers', intval(arg(1)))
                    , 'access' => user_access('select wms layers')
                    , 'type' => MENU_LOCAL_TASK
                    );
            }
        }
        //drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'core');
    }
    return $items;
}


/**
 * Implementation of hook_settings().
 *
 * After a submit, this function is called by the system module after the 
 * variables have been saved.
 */
function carto_admin_settings( )
{
    $sql = "select count(*) as count from {carto_filter_blocks}";
    $result = db_query( $sql );
    $item = db_fetch_object( $result );
    
    // carto group
    $form['carto'] = array( 
        '#type' => 'fieldset'
        , '#title' => t('Carto')
        , '#collapsible' => TRUE
        , '#tree' => TRUE
        );
    // checkbox to empty cached carto-filters
    $form['carto']['carto_empty_cache'] = array( 
        '#type' => 'checkbox'
        , '#title' => t('Empty cached carto-filters (' . $item->count  . ').')
        , '#default_value' => variable_get('carto_empty_cache','0') != '0'
        , '#description' => t("Check this box to empty the '%table' table"
            , array('%table' => 'carto_filter_blocks'))
        );
    $form['carto']['carto_wms_teaser_map'] = array(
        '#type' => 'checkbox'
        , '#title' => t('Show map in teaser of web mapping service')
        , '#default_value' => variable_get('carto_wms_teaser_map',DEFAULT_CARTO_WMS_TEASER_MAP) != 0
        , '#description' => t('Check to show map in teaser of web mapping service')
        );
        
    // mappingwidgets group
    $form['mappingwidgets'] = array( 
        '#type' => 'fieldset'
        , '#title' => t('Mappingwidgets')
        , '#tree' => TRUE
        , '#collapsible' => TRUE
        );
    $value = variable_get('carto_mappingwidgets_dir',MAPPINGWIDGETS_DIR);
    $form['mappingwidgets']['carto_mappingwidgets_dir'] = array( 
        '#type' => 'textfield'
        , '#title' => t('Installation folder')
        , '#default_value' => $value
        , '#size' => 80
        , '#maxlength' => 255
        , '#description' => t('Location of MappingWidgets package.')
        );
    $value = variable_get('carto_mappingwidgets_base_uri','modules/carto/lib/mappingwidgets/htdocs/');
    $form['mappingwidgets']['carto_mappingwidgets_base_uri'] = array( 
        '#type' => 'textfield'
        , '#title' => t('Base URI')
        , '#default_value' => $value
        , '#size' => 80
        , '#maxlength' => 255
        , '#description' => t('URI to base of MappingWidgets package (relative to %host).', array('%host' => $_SERVER['HTTP_HOST']) )
        );
    
    // show googlmap api key here only if gmap is not enabled
    if( ! module_exists('gmap') )
    {
        $value = variable_get( 'googlemap_api_key', DEFAULT_GOOGLEMAP_KEY );
        $form['mappingwidgets']['googlemap_api_key'] = array(
            '#type' => 'textfield'
            , '#title' => t('Google map API key')
            , '#default_value' => $value
            , '#size' => 108
            , '#maxlength' => 255
            );
    }
    
    $form['mappingwidgets']['info'] = array(
        '#type' => 'markup'
        , '#value' => 
            'Current values for constant settings in MappingWidgets'
            . '<br /><strong>MAPPINGWIDGETS_BASE_URI</strong> = ' . MAPPINGWIDGETS_BASE_URI
            . '<br /><strong>MAPPINGWIDGETS_WIDGETS_URI</strong> = ' . MAPPINGWIDGETS_WIDGETS_URI
            . '<br /><strong>MAPPINGWIDGETS_TMP_DIR</strong> = ' . MAPPINGWIDGETS_TMP_DIR
//                . '<br />MAPPINGWIDGETS_ = ' . MAPPINGWIDGETS_
        );
    
    // smarty group
    $value = variable_get('carto_smarty_dir',SMARTY_DIR);
    $form['smarty'] = array(
        '#type' => 'fieldset'
        , '#title' => t('Smarty')
        , '#tree' => TRUE
        , '#collapsible' => TRUE
        );
    $form['smarty']['carto_smarty_dir'] = array( 
        '#type' => 'textfield'
        , '#title' => t('Installation folder')
        , '#default_value' => $value
        , '#size' => 80
        , '#maxlength' => 255
        , '#description' => t('Directory that contains the Smarty.class.php file.')
        );
    $form['smarty']['carto_enable_smarty_caching'] = array( 
        '#type' => 'checkbox'
        , '#title' => t('Enable Smarty caching.')
        , '#default_value' => variable_get('carto_enable_smarty_caching','1') == '1'
        , '#description' => t('Check this box to enable Smarty caching.')
        );
    $form['smarty']['carto_smarty_force_compile'] = array( 
        '#type' => 'checkbox'
        , '#title' => t('Force Smarty to compile templates.')
        , '#default_value' => variable_get('carto_smarty_force_compile','0') == '1'
        , '#description' => t('Check this box to force Smarty to compile the templates each time.')
        );
    $form['smarty']['carto_empty_smarty_cache'] = array( 
        '#type' => 'checkbox'
        , '#title' => t('Empty Smarty cache.')
        , '#default_value' => variable_get('carto_empty_smarty_cache','0') != '0'
        , '#description' => t('Check this box to empty the Smarty cache.')
        );

    $contribs = array( 'mapscript', 'postgis' );
    foreach( $contribs as $contrib )
    {
        $func = "carto_{$contrib}_get_settings_form";
        if( function_exists($func) )
        {
            $form = array_merge( $form, call_user_func($func) );
        }
    }
    return system_settings_form($form);
}

/**
 * (drupal 4.7.x)
 * Validate function for 'carto_settings_form'.
 */
function carto_admin_settings_validate( $form_id, &$form )
{
    if( ! file_exists( $form['mappingwidgets']['carto_mappingwidgets_dir'] . 'MappingWidgets.php' ) )
    {
        form_set_error( 'mappingwidgets][carto_mappingwidgets_dir', t('Wrong installation folder. The folder must end with a / and must contain MappingWidgets.php.') );
    }
    
    // check relative to $base_url defined in drupal's settings.php
    global $base_url;
    $path = $base_url . '/' . $form['mappingwidgets']['carto_mappingwidgets_base_uri'] . 'scripts/MappingWidgets.js';
    $result = drupal_http_request( $path );
    if( $result->code != 200 )
    {
        global $conf;
//        form_set_error( '', var_export($conf,true) );
        drupal_set_message( t("The URI is not correct. A check for '%path' did not return OK.", array('%path' => $path)));
//        form_set_error( 'mappingwidgets][carto_mappingwidgets_base_uri', t("The URI is not correct. A check for '%path' did not return OK.", array('%path' => $path)) );
    }
    
    if( ! file_exists( $form['smarty']['carto_smarty_dir'] . 'Smarty.class.php' ) )
    {
        form_set_error( 'smarty][carto_smarty_dir', t('Wrong installation folder. The folder must end with a / and must contain Smarty.class.php.') );
    }
    //drupal_set_message( t("carto_settings_form_validate $form_id: " . var_export($form,true)) );
}

/**
 * (drupal 4.7.x)
 * Submit function for 'carto_settings_form'.
 */
function carto_admin_settings_submit( $form_id, $values ) 
{
    if( $values['op'] == t('Reset to defaults') )
    {
        variable_del( 'carto_wms_teaser_map' );
    }
    else if( $values['op'] == t('Save configuration') )
    {
        variable_set( 'carto_wms_teaser_map', $values['carto']['carto_wms_teaser_map'] );
    }
    
    if( $values['carto']['carto_empty_cache'] == 1 )
    {
        // empty carto_filter_blocks table
        $sql = "delete from {carto_filter_blocks}";
        $result = db_query( $sql );
        
        // set carto_empty_cache to 0 (off)
        drupal_set_message( t('The carto_filter_blocks table is emptied.') );
    }

    if( $values['smarty']['carto_empty_smarty_cache'] == 1 )
    {
        if( function_exists('get_carto_mapper') )
        {
            $cartoSmarty = get_carto_mapper( );
            
            // clear all cache files
            $cartoSmarty->clear_all_cache();
            drupal_set_message( t("The Smarty cache at '%dir' is cleared.", array( '%dir' => $cartoSmarty->cache_dir)) );

            variable_set( 'carto_empty_smarty_cache', '0' );
        }
    }
    
    // keep googlemap_api_key
    if( $values['mappingwidgets']['googlemap_api_key'] != '' )
    {
        variable_set( 'googlemap_api_key', $values['mappingwidgets']['googlemap_api_key'] );
    }
    
    variable_set( 'carto_mappingwidgets_dir', $values['mappingwidgets']['carto_mappingwidgets_dir'] );
    variable_set( 'carto_mappingwidgets_base_uri', $values['mappingwidgets']['carto_mappingwidgets_base_uri'] );
    variable_set( 'carto_smarty_dir', $values['smarty']['carto_smarty_dir'] );
    variable_set( 'carto_enable_smarty_caching', $values['smarty']['carto_enable_smarty_caching'] );
    variable_set( 'carto_smarty_force_compile', $values['smarty']['carto_smarty_force_compile'] );
    
//    drupal_set_message( 'carto_settings_form_submit( ' . $form_id . '): ' . var_export($values,true) );
}

/**
 *
 */
function carto_all( )
{
    $output = 'Statistics on maps/wms for user/general. Not implemented yet';
    
    print theme('page', $output);
}

/**
 * Menu callback; displays a Drupal page containing recent carto entries.
 */
function carto_page( $uid = 0 )
{
    if( $uid )
    {
        carto_page_user($uid);
    }
    else
    {
        carto_page_last();
    }
}

/**
 * Displays a Drupal page containing recent nodes with carto-filter entries of a 
 * given user.
 */
function carto_page_user( $uid )
{
    $user = user_load( array((is_numeric($uid) ? 'uid' : 'name') => $uid, 'status' => 1) );

    if( $user->uid )
    {
        drupal_set_title($title = t("%name's maps", array('%name' => $user->name)));

        $output = '';
        
        $result = pager_query(db_rewrite_sql(
            "SELECT n.nid, n.sticky, n.created FROM {node} n "
            . "INNER JOIN {carto_filter_nodes} c ON n.nid = c.nid "
            . "WHERE n.uid = %d AND n.status = 1 ORDER BY n.sticky DESC, n.created DESC")
            , variable_get('default_nodes_main', 10), 0, NULL
            , $user->uid
            );
        while( $node = db_fetch_object($result) )
        {
            $output .= node_view( node_load( array('nid' => $node->nid)), 1);
        }
        $output .= theme('pager', NULL, variable_get('default_nodes_main', 10));
        $output .= theme('xml_icon', url("carto/feed/$user->uid"));

        drupal_set_html_head('<link rel="alternate" type="application/rss+xml" title="RSS - '. $title .'" href="'. url("carto/feed/$user->uid") .'" />');
        print theme('page', $output, $title);
    }
    else
    {
        drupal_not_found();
    }
}

/**
 * Displays a Drupal page containing recent carto entries of all users.
 */
function carto_page_last() 
{
    global $user;

    $output = '';

    // SELECT n.nid, n.sticky, n.created FROM node n INNER JOIN carto_filter_nodes c ON n.nid = c.nid WHERE n.status = 1 ORDER BY n.sticky DESC, n.created DESC
    $result = pager_query(db_rewrite_sql(
        "SELECT n.nid, n.sticky, n.created FROM {node} n "
        . "INNER JOIN {carto_filter_nodes} c ON n.nid = c.nid "
        . "WHERE n.status = 1 ORDER BY n.sticky DESC, n.created DESC")
        , variable_get('default_nodes_main', 10), 0, NULL
        );
    while( $node = db_fetch_object($result) )
    {
//        $output .= node_view(node_load(array('nid' => $node->nid)), 1);
        $output .= node_view(node_load($node->nid), 1);
    }
    $output .= theme('pager', NULL, variable_get('default_nodes_main', 10));
    $output .= theme('xml_icon', url('carto/feed'));

    drupal_set_html_head('<link rel="alternate" type="application/rss+xml" title="RSS - maps" href="'. url('carto/feed') .'" />');
    print theme('page', $output);
}


/**
 * Menu callback; displays an RSS feed containing recent carto entries.
 */
function carto_feed( $uid = 0 )
{
    if( $uid )
    {
        carto_feed_user( $uid );
    }
    else
    {
        carto_feed_last( );
    }
}

/**
 * Displays an RSS feed containing recent carto entries of a given user.
 */
function carto_feed_user( $uid = 0 )
{
    global $user;

    if ($uid) {
        $account = user_load( array('uid' => $uid, 'status' => 1) );
    }
    else {
        $account = $user;
    }

    $result = db_query_range(db_rewrite_sql(
        "SELECT n.nid, n.title, n.teaser, n.created, u.name, u.uid FROM {node} n"
        . " INNER JOIN {carto_filter_nodes} c ON n.nid = c.nid"
        . " INNER JOIN {users} u ON n.uid = u.uid"
        . " WHERE n.uid = %d AND n.status = 1"
        . " ORDER BY n.created DESC")
        , $uid, 0, 15
        );
    $channel['title'] = $account->name ."'s maps";
    $channel['link'] = url("carto/maps/$uid", NULL, NULL, TRUE);
    $channel['description'] = $term->description;
    node_feed( $result, $channel );
}

/**
 * Displays an RSS feed containing recent carto entries of all users.
 */
function carto_feed_last( )
{
    $result = db_query_range(db_rewrite_sql(
        "SELECT n.nid, n.title, n.teaser, n.created, u.name, u.uid FROM {node} n"
        . " INNER JOIN {carto_filter_nodes} c ON n.nid = c.nid"
        . " INNER JOIN {users} u ON n.uid = u.uid"
        . " WHERE n.status = 1 ORDER BY n.created DESC")
        , 0, 15);
    $channel['title'] = variable_get('site_name', 'drupal') .' maps';
    $channel['link'] = url('carto/maps', NULL, NULL, TRUE);
    $channel['description'] = $term->description;
    node_feed($result, $channel);
}

/**
 * Implementation of hook_block().
 *
 * Displays the most recent 10 carto titles.
 */
function carto_block( $op = 'list', $delta = 0 )
{
    global $user;
    
    if( $op == 'list' )
    {
        $block[0]['info'] = t('Carto - Recent maps');
        $block[1]['info'] = t('Carto - Overview');
        $block[2]['info'] = t('Carto - Legend');
        $block[3]['info'] = t('Carto - Recent WMS');
        return $block;
    }
    else if( $op == 'configure' )
    {
        // drupal >= 4.7
        $form = array();
        switch( $delta )
        {
        case 0:
            $form['carto_recent_maps'] = array( 
                '#type' => 'textfield'
                , '#title' => t('Number of maps')
                , '#default_value' => variable_get('carto_recent_maps',10)
                , '#size' => 5
                , '#maxlength' => 5
                , '#description' => t('Maximum number of recent maps to show.')
                );
            break;
        case 1:
            $form['carto_overview_width'] = array( 
                '#type' => 'textfield'
                , '#title' => t('Width')
                , '#default_value' => variable_get('carto_overview_width',160)
                , '#size' => 5
                , '#maxlength' => 5
                , '#description' => t('Width of the overview block.')
                );
            $form['carto_overview_height'] = array( 
                '#type' => 'textfield'
                , '#title' => t('Height')
                , '#default_value' => variable_get('carto_overview_height',80)
                , '#size' => 5
                , '#maxlength' => 5
                , '#description' => t('Height of the overview block.')
                );
            break;
        case 2:
            break;
        }
        return $form;
    }
    else if( $op == 'save' )
    {
        $edit = func_get_arg( 2 );
        if( $edit )
        {
            if( $delta == 0 )
            {
                variable_set( 'carto_recent_maps', $edit['carto_recent_maps'] );
            }
            else if( $delta == 1 )
            {
                variable_set( 'carto_overview_width', $edit['carto_overview_width'] );
                variable_set( 'carto_overview_height', $edit['carto_overview_height'] );
            }
            else if( $delta == 2 )
            {
                variable_set( 'carto_legend_width', $edit['carto_legend_width'] );
                variable_set( 'carto_legend_height', $edit['carto_legend_height'] );
            }
        }
    }
    else
    {
//print 'op/delta = ' . $op . '/' . $delta . '<br />';
        if( user_access('access content') )
        {
            switch( $delta )
            {
            case 0:
                $block['subject'] = t('Recent maps');
                $block['content'] = node_title_list(db_query_range(db_rewrite_sql(
                    "SELECT n.nid, n.title, n.created FROM {node} n"
                    . " INNER JOIN {carto_filter_nodes} c ON n.nid = c.nid"
                    . " WHERE n.status = 1 ORDER BY n.created DESC"), 0, variable_get('carto_recent_maps',10)));
                $block['content'] .= '<div class="more-link">'. l(t('more'), 'carto/maps', array('title' => t('Look at the latest maps.'))) .'</div>';
                break;
            
            case 1:
                // id of this block will be block-carto-1
                $block['subject'] = t('Overview');
                $block['content'] = fetch_overview( );
                break;
            
            case 2:
                // id of this block will be block-carto-2
                $block['subject'] = t('Legend');
                $block['content'] = fetch_legend( );
                break;
            
            case 3:
                $block['subject'] = t('Recent WMS');
                $block['content'] = node_title_list(db_query_range(db_rewrite_sql(
                    "SELECT n.nid, n.title, n.created FROM {node} n"
                    . " INNER JOIN {carto_wms_node} c ON n.nid = c.nid"
                    . " WHERE n.status = 1 ORDER BY n.created DESC"), 0, variable_get('carto_recent_maps',10)));
                $block['content'] .= '<div class="more-link">'. l(t('more'), 'carto/wms', array('title' => t('Look at the latest wms.'))) .'</div>';
                break;
            }
        }
        return $block;
    }
}

/**
 * Implementation of hook_onload().
 */
function carto_onload( )
{
    // return array met string waarin javascript functie aanroepen staan
    // zoals 'my_javascript_function()'
    return array( );//"carto_init()" );
}

/**
 * Implementation of filter
 * @todo: bedenken hoe een carto node inline gespecificeerd kan worden?
 * waarschijnlijk: kaart widget met attributen, en standaard knoppenbalk erbij?
 * Blok wordt aangegeven door: <div ...class="carto-section">???</div>
 * @todo: change settings in bracket_type ({} or <> or []), tag (default: carto-filter)
 */
function carto_filter( $op, $delta = 0, $format = -1, $text = '' )
{
    if( $op == 'list' )
    {
        return array(
            0 => t('Expand mappingwidgets inside carto filter blocks')
            );
    }
    
    if( $delta == 0 )
    {
        switch( $op )
        {
        case 'settings':
            $form['carto_filter'] = array(
                '#type' => 'fieldset'
                , '#title' => t('Carto filter')
                );
            $form['carto_filter']['carto_filter_expr'] = array(
                '#type' => 'textfield'
                , '#title' => t('Filter block expression')
                , '#default_value' => variable_get('carto_filter_expr', "/\{carto-filter\}(.*)\{\/carto-filter\}/Us" )
                , '#size' => 60
                , '#maxlength' => 255
                , '#description' => t('Enter the regular expression for the carto filter blocks.') 
                );
            return $form;
            
        case 'description':
            return t('Mappingwidgets within carto-filter blocks are expanded to dynamic maps.');
            
        case 'no cache':
            // Return true if caching should be disabled for this filter.
            return TRUE;
            
        case 'prepare':
            // unescape here?
            return $text;
            
        case 'process':
            if( ! function_exists('get_carto_mapper') )
            {
                trigger_error( t('Carto module is not configured correctly. Check your \'config.inc\' file.'), E_USER_ERROR );
                return "";
            }
            $cartoSmarty = get_carto_mapper( );
            
            $output = "";
            $output .= preg_replace_callback( variable_get('carto_filter_expr',"/\{carto-filter\}(.*)\{\/carto-filter\}/Us"), "fetch_widgets", $text );

            return $output;
        }
    }
}


/**
 *
 */
function carto_filter_tips( $delta, $format, $long = false )
{
    if( $long )
    {
        return t('<p>Between a starting {carto-filter} tag and an ending {/carto-filter} tag, 
{mappingwidgets ..} can be defined. For more examples see 
<a href="http://mappingwidgets.sourceforge.net" target="_blank">mappingwidgets</a>.
</p>
');
    }
    else
    {
        return t("You can define {mappingwidget}'s in between {carto-filter} and {/carto-filter} tags.");
    }
}


/**
 * Insert html/javascript code just before the closing body tag.
 */
function carto_footer( )
{
    global $base_url;
    
    if( ! function_exists('get_carto_mapper') ) return NULL;
    $cartoSmarty = get_carto_mapper( );
    
    $output = "\n<!-- carto_footer output -->\n";
    // define drupal base_url and 'base href' in javascript
    $output .= "<script type=\"text/javascript\">
//<!--
var drupal_base_url = '{$base_url}';
var drupal_base_href = '{$base_url}/';
//-->
</script>
";
    
    if( $cartoSmarty->get_widget_count('BaseMap') - $cartoSmarty->get_widget_count('OverviewMap') > 0 )
    {
        // target map present
        if( $cartoSmarty->get_widget_count("OverviewMap") > 0 )
        {
            // get overviewmap widget(s)
            $ow = $cartoSmarty->get_widgets( "OverviewMap" );
            if( ! is_array( $ow ) )
                $ows = array( $ow );
            else
                $ows = $ow;
            
            foreach( $ows as $ow )
            {
/* */
                // adapt overviewmap widget definition for target map
                $mapwidget = $cartoSmarty->find_map_widget( );
                if( $mapwidget )
                {
                    if( isset($ow->extent) )
                        $extent = $ow->extent;
                    else if( isset($mapwidget->fullextent) )
                        $extent = $mapwidget->fullextent;
                    else
                        $extent = $mapwidget->extent;
                    
                    $output .= $cartoSmarty->fetch( "text:" . "{mappingwidget type=\"OverviewMap\""
                        . " id=\"{$ow->id}\""
                        . " extent=\"" . $extent . "\""
                        . " image=\"" . $mapwidget->overview . "\""
                        . " nohtml=\"true\"}" );
                }
                else // defaults
                {
                    if( isset($ow->extent) )
                        $extent = $ow->extent;
                    else
                        $extent = "-180,-90,180,90";
                    
                    $output .= $cartoSmarty->fetch( "text:" . "{mappingwidget type=\"OverviewMap\""
                        . " id=\"{$ow->id}\""
                        . " extent=\"$extent\""
                        . " image=\"images/world.png\""
                        . " nohtml=\"true\"}" );
                }
                // @todo: use wms request for maxextent (for overviewlayers)??
/* */
            }
        }
        
        // get the final code (3 ways)
//        $output .= $cartoSmarty->get_final_code( );
        $output .= get_carto_filter_html( 'final_code', "{\$mappingWidgetManager->get_final_code()}" );
//        $output .= get_carto_filter_html( 'final_code', "{mappingwidgets_javascript_includes}{mappingwidgets_javascript_objects}" );
    }
    else
    {
        if( $cartoSmarty->caching )
        {
            // When using the cache, the widget count equals 0!! Check if the
            
            // check if resource is available in carto_filter_blocks table?
//            $cfid = drupal_get_path_alias($_GET['q']) . ":" . $cartoSmarty->language->_currentLocale . ':final_code';
            $cfid = drupal_get_normal_path($_GET['q']) . ":" . $cartoSmarty->language->_currentLocale . ':final_code';
    
            $sql = "select 'x' from {carto_filter_blocks} where cfid = '%s'";
            $result = db_query( $sql, $cfid );
            if( db_num_rows( $result ) > 0 )
            {
                $output .= $cartoSmarty->fetch( 'carto:' . $cfid ); 
            }
        }

        // no target maps present -> don't show overview/legend blocks
        if( $cartoSmarty->get_widget_count("OverviewMap") + $cartoSmarty->get_widget_count('SimpleLegend') != 0 )
        {
        // if only overview/legend block(s) -> hide it
        $output .= <<<EOT
<script type="text/javascript">
//<!--
function trimString (str) {
  str = this != window ? this : str;
  return str.replace(/^\s+/g, '').replace(/\s+\$/g, '');
}
String.prototype.trim = trimString;

for( i = 1; i <= 2; i++ )
{
    var blk = document.getElementById( 'block-carto-' + i );
    if( blk && blk.parentNode )
    {
        var par = blk.parentNode;
        // remove block
        blk.parentNode.removeChild( blk );
        if( par.id == 'sidebar-left' || par.id == 'sidebar-right' )
        {
            /* if no content is left in sidebar, remove it */
            if( trimString(par.innerHTML) == '' )
            {
                par.parentNode.removeChild( par );
            }
        }
    }
}
//-->
</script>
EOT;
        }
    }
    return $output;
}


/**
 * fetch_widgets gets the html for the current carto filter block
 */
function fetch_widgets( $matches )
{
    static $count = 0;
    
    $output = get_carto_filter_html( "carto-filter-{$count}", $matches[1] );
    
    $count += 1;
    return $output;
}


/**
 * Get html for the standard overview block.
 */
function fetch_overview( )
{
    return get_carto_filter_html( "overview"
        , "{mappingwidget type=\"OverviewMap\""
        . " id=\"carto_overview\""
        . " width=\"" . variable_get('carto_overview_width',160) 
        . "\" height=\"" . variable_get('carto_overview_height',80) 
        . "\" target=\"default\"}" 
        );
}


/**
 * Get html for the standard legend block.
 */
function fetch_legend( )
{
    return get_carto_filter_html( "legend"
        , "{mappingwidget type=\"SimpleLegend\""
        . " id=\"carto_legend\""
        . " width=\"" . variable_get('carto_legend_width',160) 
        . "\" height=\"" . variable_get('carto_legend_height',240) 
        . "\" target=\"default\"}" 
        );
}


function get_carto_filter_html( $id, $text )
{
    static $calls = 0;
    
    if( ! function_exists('get_carto_mapper') ) return NULL;
    $cartoSmarty = get_carto_mapper( );

    $output = "";
    if( $calls++ == 0 )
    {
        $first = false;
        
        // drupal < 4.7
//        $output = $cartoSmarty->get_first_code();

        // add javascript files to head (drupal >= 4.7)
        $js_files = $cartoSmarty->get_javascript_includes();
        foreach( $js_files as $file )
        {
            // remove base_path from file path because drupal_add_js function
            // will preprend it again
            if( strpos( $file, base_path() ) === 0 )
                $file = substr( $file, strlen(base_path()) );
            drupal_add_js( $file );
        }
    }
/* *
    if( drupal_get_path_alias($_GET['q']) != $_REQUEST['q'] )
    {
        // @todo: not clear why this needed to prevent multiple entries in table
        // e.g. for path 'node/1' an extra 'node'/'' would have been made??!
        return;
    }
/* */
    
//    $cfid = $_REQUEST['q'] . ':' . $id;

    // determine carto filter id (cfid) from (normal) path, locale, and filter id
    $cfid = drupal_get_normal_path($_GET['q']) . ':' 
        . $cartoSmarty->language->_currentLocale . ':' . $id;
    
    // Replace html characters placed e.g. by htmlarea module
    // See htmlEncode function in htmlarea.js: &amp; &lt; &gt; &nbsp; &quot;
    $text = str_replace( '&quot;', '"', $text );
    $text = str_replace( '&nbsp;', ' ', $text );
    $text = str_replace( '&amp;', '&', $text );
    $crc = crc32( $text );
    
    $sql = "select crc, content from {carto_filter_blocks} where cfid = '%s'";
    $result = db_query( $sql, $cfid );
    if( db_num_rows( $result ) == 0 )
    {
        /* if cfid is not found -> insert new record */
        $sql = "insert into {carto_filter_blocks}( cfid, crc, time, content ) values( '%s', %d, %d, '%s' )";
        db_query( $sql, $cfid, $crc, time(), $text );
    }
    else
    {
        $item = db_fetch_object( $result );
        if( $crc != $item->crc )
        {
            // update crc/content
            $sql = "update {carto_filter_blocks} set crc = %d, time = %d, content = '%s' where cfid = '%s'";
            db_query( $sql, $crc, time(), $text, $cfid );
        }
    }
    $content = $cartoSmarty->fetch( "carto:" . $cfid );
    
    if( $id == 'final_code' )
        $output .= $content;
    else
        $output .= "<div id=\"{$id}\" class=\"block-carto-filter\">\n" . $content . "</div>\n";
    
    return $output;
}

/**
 * Implementation of hook_nodeapi().
 *
 * Allows modules to react to actions affecting all kinds of nodes.
 */
function carto_nodeapi( &$node, $op, $teaser, $page )
{
    switch( $op )
    {
    case 'load':
        // additional data to load?
        break;
        
    case 'insert':
        // insert record into carto_filter_nodes
        $count = preg_match_all( variable_get('carto_filter_expr',"/\{carto-filter\}(.*)\{\/carto-filter\}/Us"), $node->body, $matches );
        if( $count > 0 )
        {
            db_query( "INSERT INTO {carto_filter_nodes} (nid,numblocks) VALUES (%d,%d)", $node->nid, $count );
        }
        break;
        
    case 'update':
        // check if in db (NULL when not found)
        $previous = db_fetch_object(db_query('SELECT numblocks FROM {carto_filter_nodes} WHERE nid = %d', $node->nid));
        // determine if node contains carto-filter blocks
        
        // @todo: AND that the carto filter is active!! ($node->format)
        $hasFilter = db_fetch_object(db_query("SELECT format FROM filters WHERE format = %d AND module = 'carto'", $node->format ));
        if( ! $hasFilter )
        {
            // no carto filter -> remove from carto_filter_nodes
            if( $previous )
            {
                db_query( 'DELETE FROM {carto_filter_nodes} WHERE nid = %d', $node->nid );
            }
        }
        else
        {
            $count = preg_match_all( variable_get('carto_filter_expr',"/\{carto-filter\}(.*)\{\/carto-filter\}/Us"), $node->body, $matches );
            if( $count > 0 )
            {
                if( ! $previous )
                    db_query( "INSERT INTO {carto_filter_nodes} (nid,numblocks) VALUES (%d,%d)", $node->nid, $count );
                else if( $previous->numblocks != $count )
                    db_query( "UPDATE {carto_filter_nodes} set numblocks = %d where nid = %d", $count, $node->nid );
            }
            else if( $previous )
            {
                db_query( 'DELETE FROM {carto_filter_nodes} WHERE nid = %d', $node->nid );
            }
        }
        break;
        
    case 'delete':
        // check for $node->format?!
        $previous = db_fetch_object(db_query('SELECT numblocks FROM {carto_filter_nodes} WHERE nid = %d', $node->nid));
        if( $previous )
        {
            // remove record from carto_filter_nodes
            db_query( 'DELETE FROM {carto_filter_nodes} WHERE nid = %d', $node->nid );
        }
        break;
        
    case 'view':
        // @todo: actions to take when viewing nodes with carto filters?
        // executed on view and preview of a node (but at new preview not yet 
        // present in database!)
        $previous = db_fetch_object(db_query('SELECT numblocks FROM {carto_filter_nodes} WHERE nid = %d', $node->nid));
        if( $previous )
        {
            // if node has latitude and longitude properties, do something with it
//            print 'this node contains carto filter blocks: ' . var_export($previous,true);
        }
        else
        {
//            print 'this node contains NO carto filter blocks: ' . var_export($previous,true);
        }
        break;
    }
}

/**
 * Implementation of hook_node_info (drupal 4.7). 
 * This function replaces hook_node_name() and hook_node_types() from 4.6.
 */
function carto_node_info()
{
    return array( 
        'cartowms' => array( 'name' => t('web mapping service')
                            , 'module' => 'carto_wms'
                            , 'description' => t('A web mapping service is a page that displays selected layers of an OpenGIS web mapping service. The node can also be used as a proxy to make e.g. map requests to that service.')
                            //, 'has_body' => TRUE
                            //, 'body_label' => t('Capabilities')
                            )
    );
}

function carto_wms_form( &$node )
{
//    print 'carto_wms_form: ' . var_export(array('POST'=>$_POST,'capabilities.len'=>strlen($_SESSION['capabilities'])),true) . '<hr>';
    $type = node_get_types('type', $node);
    
    $form['title'] = array( '#type' => 'textfield'
        , '#title' => check_plain($type->title_label)//t('Title')
        , '#required' =>