src/perlmods/OpenSRF/Transport.pm

   1 package OpenSRF::Transport;
   2 use strict; use warnings;
   3 use base 'OpenSRF';
   4 use Time::HiRes qw/time/;
   5 use OpenSRF::AppSession;
   6 use OpenSRF::Utils::JSON;
   7 use OpenSRF::Utils::Logger qw(:level);
   8 use OpenSRF::DomainObject::oilsResponse qw/:status/;
   9 use OpenSRF::EX qw/:try/;
  10 use OpenSRF::Transport::SlimJabber::MessageWrapper;
  11
  12 #------------------
  13 # --- These must be implemented by all Transport subclasses
  14 # -------------------------------------------
  15
  16 =head2 get_listener
  17
  18 Returns the package name of the package the system will use to
  19 gather incoming requests
  20
  21 =cut
  22
  23 sub get_listener { shift()->alert_abstract(); }
  24
  25 =head2 get_peer_client
  26
  27 Returns the name of the package responsible for client communication
  28
  29 =cut
  30
  31 sub get_peer_client { shift()->alert_abstract(); }
  32
  33 =head2 get_msg_envelope
  34
  35 Returns the name of the package responsible for parsing incoming messages
  36
  37 =cut
  38
  39 sub get_msg_envelope { shift()->alert_abstract(); }
  40
  41 # -------------------------------------------
  42
  43 our $message_envelope;
  44 my $logger = "OpenSRF::Utils::Logger";
  45
  46
  47
  48 =head2 message_envelope( [$envelope] );
  49
  50 Sets the message envelope class that will allow us to extract
  51 information from the messages we receive from the low
  52 level transport
  53
  54 =cut
  55
  56 sub message_envelope {
  57         my( $class, $envelope ) = @_;
  58         if( $envelope ) {
  59                 $message_envelope = $envelope;
  60                 $envelope->use;
  61                 if( $@ ) {
  62                         $logger->error(
  63                                         "Error loading message_envelope: $envelope -> $@", ERROR);
  64                 }
  65         }
  66         return $message_envelope;
  67 }
  68
  69 =head2 handler( $data )
  70
  71 Creates a new MessageWrapper, extracts the remote_id, session_id, and message body
  72 from the message.  Then, creates or retrieves the AppSession object with the session_id and remote_id.
  73 Finally, creates the message document from the body of the message and calls
  74 the handler method on the message document.
  75
  76 =cut
  77
  78 sub handler {
  79         my $start_time = time();
  80         my( $class, $service, $data ) = @_;
  81
  82         $logger->transport( "Transport handler() received $data", INTERNAL );
  83
  84         # pass data to the message envelope
  85         my $helper = OpenSRF::Transport::SlimJabber::MessageWrapper->new( $data );
  86
  87         # Extract message information
  88         my $remote_id   = $helper->get_remote_id();
  89         my $sess_id     = $helper->get_sess_id();
  90         my $body        = $helper->get_body();
  91         my $type        = $helper->get_msg_type();
  92
  93         $logger->set_osrf_xid($helper->get_osrf_xid);
  94
  95         if (defined($type) and $type eq 'error') {
  96                 throw OpenSRF::EX::Session ("$remote_id IS NOT CONNECTED TO THE NETWORK!!!");
  97
  98         }
  99
 100         # See if the app_session already exists.  If so, make
 101         # sure the sender hasn't changed if we're a server
 102         my $app_session = OpenSRF::AppSession->find( $sess_id );
 103         if( $app_session and $app_session->endpoint == $app_session->SERVER() and
 104                         $app_session->remote_id ne $remote_id ) {
 105
 106             my $c = OpenSRF::Utils::SettingsClient->new();
 107         if($c->config_value("apps", $app_session->service, "migratable")) {
 108             $logger->debug("service is migratable, new client is $remote_id");
 109         } else {
 110
 111                     $logger->warn("Backend Gone or invalid sender");
 112                     my $res = OpenSRF::DomainObject::oilsBrokenSession->new();
 113                     $res->status( "Backend Gone or invalid sender, Reconnect" );
 114                     $app_session->status( $res );
 115                     return 1;
 116         }
 117         }
 118
 119         # Retrieve or build the app_session as appropriate (server_build decides which to do)
 120         $logger->transport( "AppSession is valid or does not exist yet", INTERNAL );
 121         $app_session = OpenSRF::AppSession->server_build( $sess_id, $remote_id, $service );
 122
 123         if( ! $app_session ) {
 124                 throw OpenSRF::EX::Session ("Transport::handler(): No AppSession object returned from server_build()");
 125         }
 126
 127         # Create a document from the JSON contained within the message
 128         my $doc;
 129         eval { $doc = OpenSRF::Utils::JSON->JSON2perl($body); };
 130         if( $@ ) {
 131
 132                 $logger->transport( "Received bogus JSON: $@", INFO );
 133                 $logger->transport( "Bogus JSON data: \n $body \n", INTERNAL );
 134                 my $res = OpenSRF::DomainObject::oilsXMLParseError->new( status => "JSON Parse Error --- $body\n\n$@" );
 135
 136                 $app_session->status($res);
 137                 #$app_session->kill_me;
 138                 return 1;
 139         }
 140
 141         $logger->transport( "Transport::handler() creating \n$body", INTERNAL );
 142
 143         # We need to disconnect the session if we got a jabber error on the client side.  For
 144         # server side, we'll just tear down the session and go away.
 145         if (defined($type) and $type eq 'error') {
 146                 # If we're a server
 147                 if( $app_session->endpoint == $app_session->SERVER() ) {
 148                         $app_session->kill_me;
 149                         return 1;
 150                 } else {
 151                         $app_session->reset;
 152                         $app_session->state( $app_session->DISCONNECTED );
 153                         # below will lead to infinite looping, should return an exception
 154                         #$app_session->push_resend( $app_session->app_request(
 155                         #               $doc->documentElement->firstChild->threadTrace ) );
 156                         $logger->debug(
 157                                 "Got Jabber error on client connection $remote_id, nothing we can do..", ERROR );
 158                         return 1;
 159                 }
 160         }
 161
 162         # cycle through and pass each oilsMessage contained in the message
 163         # up to the message layer for processing.
 164         for my $msg (@$doc) {
 165
 166                 next unless (   $msg && UNIVERSAL::isa($msg => 'OpenSRF::DomainObject::oilsMessage'));
 167
 168                 if( $app_session->endpoint == $app_session->SERVER() ) {
 169
 170                         try {
 171
 172                                 if( ! $msg->handler( $app_session ) ) { return 0; }
 173
 174                                 $logger->debug("Successfully handled message", DEBUG);
 175
 176                         } catch Error with {
 177
 178                                 my $e = shift;
 179                                 my $res = OpenSRF::DomainObject::oilsServerError->new();
 180                                 $res->status( $res->status . "\n$e");
 181                                 $app_session->status($res) if $res;
 182                                 $app_session->kill_me;
 183                                 return 0;
 184
 185                         };
 186
 187                 } else {
 188
 189                         if( ! $msg->handler( $app_session ) ) { return 0; }
 190                         $logger->info("Successfully handled message", DEBUG);
 191
 192                 }
 193
 194         }
 195
 196         $logger->debug(sprintf("Message processing duration: %.3fs",(time() - $start_time)), DEBUG);
 197
 198         return $app_session;
 199 }
 200
 201 1;