| 1 | #/usr/bin/env perl | ||
| 2 | ############################################################################### | ||
| 3 | # | ||
| 4 | # @file Thin.pm | ||
| 5 | # | ||
| 6 | # @brief Eulerian Data Warehouse Thin Peer Module definition. | ||
| 7 | # | ||
| 8 | # This module is aimed to provide access to Eulerian Data Warehouse | ||
| 9 | # Analytics Analysis Through Websocket Protocol. | ||
| 10 | # | ||
| 11 | # @author Thorillon Xavier:x.thorillon@eulerian.com | ||
| 12 | # | ||
| 13 | # @date 26/11/2021 | ||
| 14 | # | ||
| 15 | # @version 1.0 | ||
| 16 | # | ||
| 17 | ############################################################################### | ||
| 18 | # | ||
| 19 | # Setup module name | ||
| 20 | # | ||
| 21 | package API::Eulerian::EDW::Peer::Thin; | ||
| 22 | # | ||
| 23 | # Enforce compilor rules | ||
| 24 | # | ||
| 25 | use strict; use warnings; | ||
| 26 | # | ||
| 27 | # Inherited interface from API::Eulerian::EDW::Peer | ||
| 28 | # | ||
| 29 | use API::Eulerian::EDW::Peer; | ||
| 30 | # | ||
| 31 | # Import API::Eulerian::EDW::WebSocket | ||
| 32 | # | ||
| 33 | use API::Eulerian::EDW::WebSocket; | ||
| 34 | # | ||
| 35 | # Import API::Eulerian::EDW::Bench | ||
| 36 | # | ||
| 37 | use API::Eulerian::EDW::Bench; | ||
| 38 | # | ||
| 39 | # Import Switch | ||
| 40 | # | ||
| 41 | use Switch; | ||
| 42 | # | ||
| 43 | # Import JSON | ||
| 44 | # | ||
| 45 | use JSON; | ||
| 46 | # | ||
| 47 | # | ||
| 48 | # | ||
| 49 | use API::Eulerian::EDW::Authority(); | ||
| 50 | # | ||
| 51 | # | ||
| 52 | # | ||
| 53 | use Encode; | ||
| 54 | # | ||
| 55 | # | ||
| 56 | # | ||
| 57 | our @ISA = qw/ API::Eulerian::EDW::Peer /; | ||
| 58 | # | ||
| 59 | # @brief Allocate and initialize a new Eulerian Data Warehouse Thin Peer. | ||
| 60 | # | ||
| 61 | # @param $class - Eulerian Data Warehouse Thin Peer class. | ||
| 62 | # @param $setup - Setup attributes. | ||
| 63 | # | ||
| 64 | # @return Eulerian Data Warehouse Peer. | ||
| 65 | # | ||
| 66 | sub new | ||
| 67 | { | ||
| 68 | my $proto = shift; | ||
| 69 | my $class = ref( $proto ) || $proto; | ||
| 70 | my $setup = shift() || {}; | ||
| 71 | my $self = $class->SUPER::new(); | ||
| 72 | |||
| 73 | # Setup Default host value | ||
| 74 | $self->host( 'edwaro' ); | ||
| 75 | |||
| 76 | # Setup Default ports value | ||
| 77 | $self->ports( [ 8080, 8080 ] ); | ||
| 78 | |||
| 79 | # Setup Rest Peer Attributes | ||
| 80 | $self->setup( $setup ); | ||
| 81 | |||
| 82 | return bless( $self, $class ); | ||
| 83 | } | ||
| 84 | # | ||
| 85 | # @brief Setup Eulerian Data Warehouse Peer. | ||
| 86 | # | ||
| 87 | # @param $self - Eulerian Data Warehouse Peer. | ||
| 88 | # @param $setup - Setup entries. | ||
| 89 | # | ||
| 90 | sub setup | ||
| 91 | { | ||
| 92 | my ( $self, $setup ) = @_; | ||
| 93 | |||
| 94 | # Setup base interface values | ||
| 95 | $self->SUPER::setup( $setup ); | ||
| 96 | |||
| 97 | # Setup Thin Peer specifics options | ||
| 98 | |||
| 99 | } | ||
| 100 | # | ||
| 101 | # @brief Dump Eulerian Data Warehouse Peer setup. | ||
| 102 | # | ||
| 103 | # @param $self - Eulerian Data Warehouse Peer. | ||
| 104 | # | ||
| 105 | sub dump | ||
| 106 | { | ||
| 107 | my $self = shift; | ||
| 108 | my $dump = "\n"; | ||
| 109 | $self->SUPER::dump(); | ||
| 110 | print( $dump ); | ||
| 111 | } | ||
| 112 | # | ||
| 113 | # @brief Get remote URL to Eulerian Data Warehouse Platform. | ||
| 114 | # | ||
| 115 | # @param $self - Eulerian Data Warehouse Peer. | ||
| 116 | # | ||
| 117 | # @return Remote URL to Eulerian Data Warehouse Platform. | ||
| 118 | # | ||
| 119 | sub url | ||
| 120 | { | ||
| 121 | my $self = shift; | ||
| 122 | my $aes = shift; | ||
| 123 | my $secure = $self->secure(); | ||
| 124 | my $ports = $self->ports(); | ||
| 125 | my $url; | ||
| 126 | |||
| 127 | $url = defined( $aes ) ? | ||
| 128 | $secure ? 'wss://' : 'ws://' : | ||
| 129 | $secure ? 'https://' : 'http://'; | ||
| 130 | $url .= $self->host() . ':'; | ||
| 131 | $url .= $ports->[ $secure ] . '/edwreader/'; | ||
| 132 | $url .= $aes if( defined( $aes ) ); | ||
| 133 | |||
| 134 | return $url; | ||
| 135 | } | ||
| 136 | # | ||
| 137 | # @brief Create a new JOB on Eulerian Data Warehouse Rest Platform. | ||
| 138 | # | ||
| 139 | # @param $self - Eulerian Data Warehouse Peer. | ||
| 140 | # @param $command - Eulerian Data Warehouse Command. | ||
| 141 | # | ||
| 142 | # @return Reply context. | ||
| 143 | # | ||
| 144 | use Data::Dumper; | ||
| 145 | sub create | ||
| 146 | { | ||
| 147 | my ( $self, $command ) = @_; | ||
| 148 | my $response; | ||
| 149 | my $status; | ||
| 150 | |||
| 151 | # Get Valid Headers | ||
| 152 | $status = $self->headers(); | ||
| 153 | if( ! $status->error() ) { | ||
| 154 | # Post new JOB to Eulerian Data Warehouse Platform | ||
| 155 | $status = API::Eulerian::EDW::Request->post( | ||
| 156 | $self->url(), $status->{ headers }, $command, 'text/plain' | ||
| 157 | ); | ||
| 158 | if( ! $status->error() ) { | ||
| 159 | my $json = API::Eulerian::EDW::Request->json( $status->{ response } ); | ||
| 160 | if( defined( $json ) && $json->{ status }->[ 1 ] != 0 ) { | ||
| 161 | $status = API::Eulerian::EDW::Status->new(); | ||
| 162 | $status->error( 1 ); | ||
| 163 | $status->msg( $json->{ status }->[ 0 ] ); | ||
| 164 | $status->code( $json->{ status }->[ 1 ] ); | ||
| 165 | } | ||
| 166 | } | ||
| 167 | } | ||
| 168 | |||
| 169 | return $status; | ||
| 170 | } | ||
| 171 | # | ||
| 172 | # @brief Dispatch Eulerian Data Warehouse Analytics Analysis result messages to | ||
| 173 | # their matching callback hook. | ||
| 174 | # | ||
| 175 | # @param $ws - Eulerian WebSocket. | ||
| 176 | # @param $buf - Received buffer. | ||
| 177 | # | ||
| 178 | sub dispatcher | ||
| 179 | { | ||
| 180 | my ( $ws, $buf ) = @_; | ||
| 181 | $buf = encode( 'utf-8', $buf ); | ||
| 182 | my $json = decode_json( $buf ); | ||
| 183 | my $type = $json->{ message }; | ||
| 184 | my $uuid = $json->{ uuid }; | ||
| 185 | my $self = $ws->{ _THIN }; | ||
| 186 | my $hook = $self->hook(); | ||
| 187 | my $rows = $json->{ rows }; | ||
| 188 | |||
| 189 | switch( $type ) { | ||
| 190 | case 'add' { | ||
| 191 | $hook->on_add( $json->{ uuid }, $json->{ rows } ); | ||
| 192 | } | ||
| 193 | case 'replace' { | ||
| 194 | $hook->on_replace( $json->{ uuid }, $json->{ rows } ); | ||
| 195 | } | ||
| 196 | case 'headers' { | ||
| 197 | #print Dumper( $json ) . "\n"; | ||
| 198 | $self->{ uuid } = $uuid; | ||
| 199 | $hook->on_headers( | ||
| 200 | $json->{ uuid }, $json->{ timerange }->[ 0 ], | ||
| 201 | $json->{ timerange }->[ 1 ], $json->{ columns } | ||
| 202 | ); | ||
| 203 | } | ||
| 204 | case 'progress' { | ||
| 205 | $hook->on_progress( | ||
| 206 | $json->{ uuid }, $json->{ progress } | ||
| 207 | ); | ||
| 208 | } | ||
| 209 | case 'status' { | ||
| 210 | $hook->on_status( | ||
| 211 | $json->{ uuid }, $json->{ aes }, $json->{ status }->[ 1 ], | ||
| 212 | $json->{ status }->[ 0 ], $json->{ status }->[ 2 ] | ||
| 213 | ); | ||
| 214 | } | ||
| 215 | else {} | ||
| 216 | } | ||
| 217 | |||
| 218 | } | ||
| 219 | # | ||
| 220 | # @brief Join Websocket stream, raise callback hook accordingly to received | ||
| 221 | # messages types. | ||
| 222 | # | ||
| 223 | # @param $self - API::Eulerian::EDW::Peer:Thin instance. | ||
| 224 | # @param $rc - Reply context of JOB creation. | ||
| 225 | # | ||
| 226 | # @return Reply context. | ||
| 227 | # | ||
| 228 | sub join | ||
| 229 | { | ||
| 230 | my ( $self, $status ) = @_; | ||
| 231 | my $json = API::Eulerian::EDW::Request->json( $status->{ response } ); | ||
| 232 | my $ws = API::Eulerian::EDW::WebSocket->new( | ||
| 233 | $self->host(), $self->ports()->[ $self->secure() ] | ||
| 234 | ); | ||
| 235 | my $url = $self->url( $json->{ aes } ); | ||
| 236 | $ws->{ _THIN } = $self; | ||
| 237 | return $ws->join( $url, \&dispatcher ); | ||
| 238 | } | ||
| 239 | # | ||
| 240 | # @brief Do Request on Eulerian Data Warehouse Platform. | ||
| 241 | # | ||
| 242 | # @param $self - Eulerian Data Warehouse Peer. | ||
| 243 | # @param $command - Eulerian Data Warehouse Command. | ||
| 244 | # | ||
| 245 | sub request | ||
| 246 | { | ||
| 247 | my ( $self, $command ) = @_; | ||
| 248 | my $bench = new API::Eulerian::EDW::Bench(); | ||
| 249 | my $response; | ||
| 250 | my $status; | ||
| 251 | my $json; | ||
| 252 | |||
| 253 | # Create Job on Eulerian Data Warehouse Platform | ||
| 254 | $bench->start(); | ||
| 255 | $status = $self->create( $command ); | ||
| 256 | $bench->stage( 'create' ); | ||
| 257 | |||
| 258 | if( ! $status->error() ) { | ||
| 259 | # Join Websocket call user specific callback hook | ||
| 260 | $bench->start(); | ||
| 261 | $status = $self->join( $status ); | ||
| 262 | $bench->stage( 'join' ); | ||
| 263 | $status->{ bench } = $bench; | ||
| 264 | } | ||
| 265 | |||
| 266 | return $status; | ||
| 267 | } | ||
| 268 | # | ||
| 269 | # @brief Cancel Job on Eulerian Data Warehouse Platform. | ||
| 270 | # | ||
| 271 | # @param $self - API::Eulerian::EDW::Peer::Rest instance. | ||
| 272 | # @param $rc - Reply context. | ||
| 273 | # | ||
| 274 | sub cancel | ||
| 275 | { | ||
| 276 | my ( $self ) = @_; | ||
| 277 | my $status; | ||
| 278 | |||
| 279 | # Get Valid Headers | ||
| 280 | $status = $self->headers(); | ||
| 281 | if( ! $status->error() && exists( $self->{ uuid } ) ) { | ||
| 282 | my $uuid = $self->{ uuid }; | ||
| 283 | my $command = "KILL $uuid;"; | ||
| 284 | |||
| 285 | # Post new JOB to Eulerian Data Warehouse Platform | ||
| 286 | $status = API::Eulerian::EDW::Request->post( | ||
| 287 | $self->url(), $status->{ headers }, $command, 'text/plain' | ||
| 288 | ); | ||
| 289 | |||
| 290 | } | ||
| 291 | |||
| 292 | return $status; | ||
| 293 | } | ||
| 294 | # | ||
| 295 | # End Up module properly | ||
| 296 | # | ||
| 297 | 1; |