source: cowsclient/trunk/cowsclient/controllers/wmsviz.py @ 6119

# Copyright (C) 2007 STFC & NERC (Science and Technology Facilities Council).
# This software may be distributed under the terms of the
# Q Public License, version 1.0 or later.
# http://ndg.nerc.ac.uk/public_docs/QPublic_license.txt
#
"""
 Controller for the 'View' tab - allowing the display of WMC map layers

 @author C Byrom Feb 08, Modified D Lowe, May 09
"""

import logging
import urllib2
import urlparse
from cStringIO import StringIO

#from ows_server.models import Utilities
from paste.request import parse_querystring
import cowsclient.lib.utils as utils

# cowsclient imports
from cowsclient.model import selectedItem
from cowsclient.lib.base import BaseController, g, response, config, request, c, session, render, abort
from cowsclient.lib.wmc_util import GetWebMapContext, GetWebMapCapabilities, GetLegend, openURL, GetResponse, parseEndpointString
from cowsclient.lib.build_figure import build_figure
from cowsclient.lib.status_builder import StatusBuilder

from cowsclient.lib.base import request

log = logging.getLogger(__name__)

class WmsvizController(BaseController):
    
    _pilImageFormats = {
        'image/png': 'PNG',
        'image/jpg': 'JPEG',
        'image/jpeg': 'JPEG',
        'image/gif': 'GIF',
        'image/tiff': 'TIFF'
    }
    
    def index(self):
        """
        Default controller method to handle the initial requests to the page
        """
        log.debug('endtered wmsviz controller index action')
        
        g.helpIcon='layout/icons/help.png'  #needs to go in config
        
        self.inputs=dict(parse_querystring(request.environ))
        log.info(self.inputs)
        c.wmcURL = ""
        
        # check if all we're doing is removing a view item
        if 'removeItem' in self.inputs:
            return self.removeViewItem(self.inputs['removeItem'])
        
        
        # check if we're doing an AJAX callback to get some WMC data
        if 'REQUEST' in self.inputs:
                        
            if self.inputs['REQUEST'] == 'GetWebMapContext':
                wmc= GetWebMapContext(self)
                log.debug("finished wmsviz controller index action, req = GetWebMapContext")
                return wmc
           
            if self.inputs['REQUEST'] == 'GetWebMapCapabilities':
                wmcDoc = GetWebMapCapabilities(self.inputs['ENDPOINT'])
                
                response.headers['Content-Type'] = 'text/xml'
                response.write(wmcDoc)
                log.debug("finished wmsviz controller index action, req = GetWebMapCapabilities")
                return           
            
            elif self.inputs['REQUEST'] == 'GetLegend':
                resp = GetLegend(self)
                log.debug("finished wmsviz controller index action, req = GetLegend")
                return resp
            
            if self.inputs['REQUEST'] == 'GetDisplayOptions':
                
                jsonTxt = GetResponse(self.inputs['URL'])
                
                response.headers['Content-Type'] = 'application/json'
                response.write(jsonTxt)
                log.debug("finished wmsviz controller index action, req = GetDisplayOptions")
                return
            
            if self.inputs['REQUEST'] == 'GetAxisConfig':
                
                respText = GetResponse(self.inputs['URL'])
                
                response.headers['Content-Type'] = 'text/xml'
                response.write(respText)
                return            
                

        
        #get server information from config file
        g.server=config['app_conf']['serverurl']
    
        statusBuilder = StatusBuilder()
        
        status = statusBuilder.getCurrentStatus('wmsviz')

        initialSetup = self._buildInitialSetup(self.inputs.get('ENDPOINT'))
        
        #TODO: WORK OUT HOW TO COUPLE THIS TO BROWSE
        # otherwise, we can get here by two routes:
        # i) either by clicking on the WMC icon in the details view - if so, get passed endpoint and add to
        #    selected items;
        # ii) or from the selections tab - which will already have set up the correct selected items
            
        # if ENDPOINT specified, we've reached the page via the WMC icon
        
        #This will ensure that NDG security is triggered if a secured dataset is in Endpoint
        if 'ENDPOINT' in self.inputs:
        #clear out old endpoints NOTE. this means only one endpoint at a time can be viewed. May want to
        #rethink this to enable 'shopping cart' type selection.
#        self.removeAllViewItems()
            for endpoint in initialSetup:
                urlstring=endpoint['url']+'?request=GetCapabilities&Service=WMS'
                urlstring = parseEndpointString(endpoint['url'], 
                                {'REQUEST':'GetCapabilities', 'SERVICE':'WMS'})
                #urlstring=str(self.inputs['ENDPOINT'])
                req = urllib2.Request(urlstring)
                req.add_header('Cookie', request.headers.get('Cookie', ''))
                try:
                    filehandle = openURL(req)
                    filehandle.close()
                except urllib2.HTTPError, e:            
                    log.exception("exception occurred")
                    if e.code == 401:
                        log.info ('401 unauthorized error in cowsclient')
                        return abort(401) #triggers ndg security framework
                    elif e.code == 403:  #TODO: 403 response is UNTESTED.
                        # User is authenticated but doesn't have the required permissions
                        # or an error occurred in the authorization process
                        # Read response                   
                        xresponse = e.read()
                        # Send response to user
                        self.start_response("%d %s" % (e.code, e.msg), e.headers.dict.items())
                         
                        return xresponse
                
        
        # avoid page crashing if we come here without view items defined
#        if 'viewItems' not in session:
#            h.redirect_to(h.url_for(controller='discovery'))

        session.save()  
        log.info('SAVED SESSION')
        
        # check if page has been visited before; if not display tab
#        if (Utilities.isTabRequired(c.pageTabs, 'View')):
#            c.pageTabs.append(('View', h.url_for(controller='viewItems',action='index')))

        c.initialSetupJSON = utils.toJSON(initialSetup) 
        c.initialStatus = utils.toJSON(status)
        
        
        log.debug("request.params = %s" % (request.params,))
        log.debug("request.headers = %s" % (request.headers,))
        
        log.debug("finished wmsviz controller index action")
        
        return render('wmsviz')

    def _buildInitialSetup(self, endpointParam):
        initialSetup = []
        
        if endpointParam != None:
            
            for ep in self.inputs['ENDPOINT'].split(','):
                endpoint = {}
                o = urlparse.urlparse(ep)
                
                if o.path.find(':') > 0:
                    path = o.path[:o.path.find(':')]

                    url = "%(scheme)s://%(hostname)s%(port)s%(path)s" % {
                        'scheme' : o.scheme if o.scheme != None else '',
                        'hostname' : o.hostname if o.hostname != None else '',
                        'port' : ':' + str(o.port) if o.port != None else '',
                        'path': path,
                    }
                    layers = o.path[o.path.find(':')+1:].split('|')
                    
                    endpoint['layers'] = layers
                else:
                    url = ep
                    layers = ""
                
                endpoint['url'] = url

                initialSetup.append(endpoint)
                
        return initialSetup       

    def addViewItem(self,endpoint):
        """
        Add a selected item to the session
         - if this is the first item, then display the selections tab
         @param endpoint: WMC endpoint 
        """
        
        item = selectedItem.SelectedItem(None, None, None, endpoint)
        
        selections = [item,]
        # avoid duplicates
        if 'viewItems' in session:
            for selection in session['viewItems']:
                if selection.wmcURL != endpoint:
                    selections.append(selection)
                    
        session['viewItems'] = selections
        session.save()  
        
    
    def removeViewItem(self,endpoint):
        """
        Remove view item from session data 
        - NB, do this by rebuilding the session data without the input data included
        @param endpoint: The WMC endpoint of the view item to remove 
        """
        selections = []
        for selection in session['viewItems']:
            if selection.wmcURL != endpoint:
                selections.append(selection)
                
        # if the new list is empty, remove the session variable
        if len(selections) == 0:
            del session['viewItems']
            c.UpdatePageTabs=1
        else:
            session['viewItems'] = selections
        session.save()
        
    def removeAllViewItems(self):
        """
        Remove all old view items - clears out old endpoints 
        """
        session['viewItems']=[]
        session.save()
        


    
    def get_figure(self):
        log.debug("running wmsvis.get_figure")
        
        params = request.params
        
        log.debug("params = %s" % (params,))
        
        format = params.pop('figFormat', 'image/png')
        
        finalImage = build_figure(params)
        
        response.headers['content-type'] = format
        
        buffer = StringIO()
        finalImage.save(buffer, self._pilImageFormats[format])
        
        response.headers['Content-Type'] = format
        response.write(buffer.getvalue())