Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

#!/usr/bin/env python 

 

""" 

@file ion/integration/ais/validate_data_resource/validate_data_resource.py 

@author Ian Katz 

@brief The worker class that implements data source URL validation 

""" 

 

from ply.lex import lex 

from ply.yacc import yacc 

 

from ion.integration.ais.validate_data_resource.data_resource_parser import Lexer, Parser, ParseException 

 

import ion.util.ionlog 

log = ion.util.ionlog.getLogger(__name__) 

from twisted.internet import defer 

from twisted.web.client import getPage 

 

#from ion.core.messaging.message_client import MessageClient 

#from ion.core.object import object_utils 

from ion.core.exception import ReceivedApplicationError 

 

from ion.integration.eoi.validation.cdm_validation_service import CdmValidationClient 

 

from ion.integration.ais.ais_object_identifiers import AIS_RESPONSE_MSG_TYPE, \ 

                                                       AIS_REQUEST_MSG_TYPE, \ 

                                                       AIS_RESPONSE_ERROR_TYPE, \ 

                                                       VALIDATE_DATASOURCE_REQ, \ 

                                                       VALIDATE_DATASOURCE_RSP 

 

 

class ValidateDataResource(object): 

 

    def __init__(self, ais): 

        log.debug('Validatedataresource.__init__()') 

        self.mc  = ais.mc 

        self.vc  = CdmValidationClient(proc=ais) 

 

    def _equalInputTypes(self, ais_req_msg, some_casref, desired_type): 

        test_msg = ais_req_msg.CreateObject(desired_type) 

        return (type(test_msg) == type(some_casref)) 

 

 

    @defer.inlineCallbacks 

    def validate(self, msg_wrapped): 

        """ 

        @brief update a data resource 

        @param msg GPB, FIXME/1, 

        @GPB{Input,FIXME,1} 

        @GPB{Returns,FIXME,1} 

        @retval success 

        """ 

 

        # check that the GPB is correct type & has a payload 

        result = yield self._CheckRequest(msg_wrapped) 

        if result != None: 

            result.error_str = "AIS.ValidateDataResource.validate: " + result.error_str 

            defer.returnValue(result) 

        msg = msg_wrapped.message_parameters_reference 

        try: 

            # Check only the type received and linked object types. All fields are 

            #strongly typed in google protocol buffers! 

            if not self._equalInputTypes(msg_wrapped, msg, VALIDATE_DATASOURCE_REQ): 

                errtext = "AIS.ValidateDataResource.validate: " + \ 

                    "Expected ValidateDataResourceReqMsg type, got " + str(msg) 

                log.info(errtext) 

                Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE) 

                Response.error_num =  Response.ResponseCodes.BAD_REQUEST 

                Response.error_str =  errtext 

                defer.returnValue(Response) 

 

            if not (msg.IsFieldSet("data_resource_url")): 

 

                errtext = "AIS.ValidateDataResource.validate: " + \ 

                    "required fields not provided (data_resource_url)" 

                log.info(errtext) 

                Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE) 

 

                Response.error_num =  Response.ResponseCodes.BAD_REQUEST 

                Response.error_str =  errtext 

                defer.returnValue(Response) 

 

 

            cdm_result = yield self.vc.validate(msg.data_resource_url) 

 

            if not cdm_result.response_type == cdm_result.ResponseType.PASS: 

                Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE) 

 

                cr = cdm_result.ResponseType 

                why = {cr.NONE: 'No response', 

                       cr.PASS: 'Validation Passed!', 

                       cr.CDM_FAILURE: 'CDM (time-axis) validation failed', 

                       cr.CF_FAILURE: 'CF compliance failed x%d' % cdm_result.cf_error_count, 

                       cr.ERROR: "'Other' error: %s" % cdm_result.err_msg, 

                       }[cdm_result.response_type] 

 

 

                errtext = "AIS.ValidateDataResource.validate: INVALID: %s " % why 

                more_out  = " :: cf_output: %s :: cdm_output: %s :: err_msg: %s " % (cdm_result.cf_output, cdm_result.cdm_output, cdm_result.err_msg) 

 

                errtext = errtext + more_out 

 

                log.info(errtext) 

                Response.error_num =  Response.ResponseCodes.INTERNAL_SERVER_ERROR 

                Response.error_str =  errtext 

                defer.returnValue(Response) 

 

 

            #get metadata! 

            parsed_das = yield self._parseDas(msg.data_resource_url) 

 

 

 

        #url doesn't exist 

        except IOError: 

            my_msg = "AIS.ValidateDataResource.validate(): couldn't fetch DAS for '%s'" % msg.data_resource_url 

            log.info(my_msg) 

            Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE) 

 

            Response.error_num =  Response.ResponseCodes.NOT_FOUND 

            Response.error_str =  my_msg 

 

            defer.returnValue(Response) 

 

        #bad data 

        except ParseException: 

            my_msg = "AIS.ValidateDataResource.validate(): DAS content for '%s' didn't parse" % msg.data_resource_url 

            log.info(my_msg) 

            Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE) 

 

            Response.error_num =  Response.ResponseCodes.INTERNAL_SERVER_ERROR 

            Response.error_str =  my_msg 

 

            defer.returnValue(Response) 

 

        #something else??? 

        except ReceivedApplicationError, ex: 

            log.info('AIS.ValidateDataResource.validate(): Error: %s' %ex) 

 

            Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE) 

 

            Response.error_num =  ex.msg_content.MessageResponseCode 

            Response.error_str =  "AIS.ValidateDataResource.validate(): Error from lower-level service: " + \ 

                ex.msg_content.MessageResponseBody 

 

            defer.returnValue(Response) 

 

        log.info("SUCCESSFUL SO FAR") 

        Response = yield self.mc.create_instance(AIS_RESPONSE_MSG_TYPE) 

        Response.result = 200 

        Response.message_parameters_reference.add() 

        Response.message_parameters_reference[0] = Response.CreateObject(VALIDATE_DATASOURCE_RSP) 

        self._populateResult(Response.message_parameters_reference[0].dataResourceSummary, parsed_das) 

        Response.message_parameters_reference[0].cdmResponse.response_type = cdm_result.response_type 

        Response.message_parameters_reference[0].cdmResponse.cf_output = cdm_result.cf_output 

        Response.message_parameters_reference[0].cdmResponse.cdm_output = cdm_result.cdm_output 

        Response.message_parameters_reference[0].cdmResponse.cf_error_count = cdm_result.cf_error_count 

        Response.message_parameters_reference[0].cdmResponse.cf_warning_count = cdm_result.cf_warning_count 

        Response.message_parameters_reference[0].cdmResponse.cf_info_count = cdm_result.cf_info_count 

        Response.message_parameters_reference[0].cdmResponse.err_msg = cdm_result.err_msg 

        defer.returnValue(Response) 

 

 

    def _populateResult(self, out_msg, das): 

        if das.has_key("NC_GLOBAL"): 

            g = das["NC_GLOBAL"] 

 

            if g.has_key("title"):        out_msg.title = g["title"]["VALUE"] 

            if g.has_key("institution"):  out_msg.institution = g["institution"]["VALUE"] 

            if g.has_key("source_data"):  out_msg.source = g["source_data"]["VALUE"] 

            if g.has_key("references"):   out_msg.references = g["references"]["VALUE"] 

            if g.has_key("conventions"):   out_msg.conventions = g["Conventions"]["VALUE"] 

            if g.has_key("summary"):      out_msg.summary  = g["summary"]["VALUE"] 

            if g.has_key("comment"):      out_msg.comment  = g["comment"]["VALUE"] 

            if g.has_key("time_coverage_start"):      out_msg.ion_time_coverage_start  = g["time_coverage_start"]["VALUE"] 

            if g.has_key("time_coverage_end"):      out_msg.ion_time_coverage_end  = g["time_coverage_end"]["VALUE"] 

            if g.has_key("geospatial_lat_min"):      out_msg.ion_geospatial_lat_min  = float(g["geospatial_lat_min"]["VALUE"]) 

            if g.has_key("geospatial_lat_max"):      out_msg.ion_geospatial_lat_max  = float(g["geospatial_lat_max"]["VALUE"]) 

            if g.has_key("geospatial_lon_min"):      out_msg.ion_geospatial_lon_min  = float(g["geospatial_lon_min"]["VALUE"]) 

            if g.has_key("geospatial_lon_max"):      out_msg.ion_geospatial_lon_max  = float(g["geospatial_lon_max"]["VALUE"]) 

            if g.has_key("geospatial_vertical_min"):      out_msg.ion_geospatial_vertical_min  = float(g["geospatial_vertical_min"]["VALUE"]) 

            if g.has_key("geospatial_vertical_max"):      out_msg.ion_geospatial_vertical_max  = float(g["geospatial_vertical_max"]["VALUE"]) 

            # TODO add algorithm to determine vertical positive value 

            out_msg.ion_geospatial_vertical_positive  = 'True' 

            # TODO add download URL? 

 

    @defer.inlineCallbacks 

    def _parseDas(self, url): 

        #prepare to parse! 

        lexer = lex(module=Lexer()) 

        parser = yacc(module=Parser(), write_tables=0, debug=False) 

 

        #fetch file 

        url = str(url) 

        dasfile = yield getPage(url + ".das") 

 

        #crunch it! 

        defer.returnValue(parser.parse(dasfile, lexer=lexer)) 

 

 

    @defer.inlineCallbacks 

    def _CheckRequest(self, request): 

       # Check for correct request protocol buffer type 

       if request.MessageType != AIS_REQUEST_MSG_TYPE: 

          # build AIS error response 

          Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE, MessageName='AIS error response') 

          Response.error_num = Response.ResponseCodes.BAD_REQUEST 

          Response.error_str = 'Bad message type receieved, ignoring' 

          defer.returnValue(Response) 

 

       # Check payload in message 

       if not request.IsFieldSet('message_parameters_reference'): 

          # build AIS error response 

          Response = yield self.mc.create_instance(AIS_RESPONSE_ERROR_TYPE, MessageName='AIS error response') 

          Response.error_num = Response.ResponseCodes.BAD_REQUEST 

          Response.error_str = "Required field [message_parameters_reference] not found in message" 

          defer.returnValue(Response) 

 

       defer.returnValue(None)