added files for database format-upgrade
[core.git] / inc / main / classes / listener / class_BaseListener.php
1 <?php
2 /**
3  * A general listener class
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24 abstract class BaseListener extends BaseFrameworkSystem implements Visitable {
25         // Exception code constants
26         const EXCEPTION_INVALID_SOCKET                   = 0xa00;
27         const EXCEPTION_SOCKET_ALREADY_REGISTERED        = 0xa01;
28         const EXCEPTION_SOCKET_CREATION_FAILED           = 0xa02;
29         const EXCEPTION_NO_SOCKET_ERROR                  = 0xa03;
30         const EXCEPTION_CONNECTION_ALREADY_REGISTERED    = 0xa04;
31         const EXCEPTION_UNEXPECTED_PACKAGE_STATUS        = 0xa05;
32         const EXCEPTION_UNSUPPORTED_PACKAGE_CODE_HANDLER = 0xa06;
33         const EXCEPTION_FINAL_CHUNK_VERIFICATION         = 0xa07;
34         const EXCEPTION_INVALID_DATA_CHECKSUM            = 0xa08;
35
36         /**
37          * Address (IP mostly) we shall listen on
38          */
39         private $listenAddress = '0.0.0.0'; // This is the default and listens on all interfaces
40
41         /**
42          * Port we shall listen on (or wait for incoming data)
43          */
44         private $listenPort = 0; // This port MUST be changed by your application
45
46         /**
47          * Whether we are in blocking or non-blocking mode (default: non-blocking
48          */
49         private $blockingMode = FALSE;
50
51         /**
52          * A peer pool instance
53          */
54         private $poolInstance = NULL;
55
56         /**
57          * Protected constructor
58          *
59          * @param       $className      Name of the class
60          * @return      void
61          */
62         protected function __construct ($className) {
63                 // Call parent constructor
64                 parent::__construct($className);
65         }
66
67         /**
68          * Checks whether the given socket resource is a server socket
69          *
70          * @param       $socketResource         A valid socket resource
71          * @return      $isServerSocket         Whether the socket resource is a server socket
72          */
73         protected function isServerSocketResource ($socketResource) {
74                 // Check it
75                 $isServerSocket = ((is_resource($socketResource)) && (!@socket_getpeername($socketResource, $peerName)));
76
77                 // We need to clear the error here if it is a resource
78                 if ($isServerSocket === TRUE) {
79                         // Clear the error
80                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('socketResource[]=' . gettype($socketResource));
81                         socket_clear_error($socketResource);
82                 } // END - if
83
84                 // Check peer name, it must be empty
85                 $isServerSocket = (($isServerSocket) && (empty($peerName)));
86
87                 // Return result
88                 return $isServerSocket;
89         }
90
91         /**
92          * Setter for listen address
93          *
94          * @param       $listenAddress  The address this listener should listen on
95          * @return      void
96          */
97         protected final function setListenAddress ($listenAddress) {
98                 $this->listenAddress = (string) $listenAddress;
99         }
100
101         /**
102          * Getter for listen address
103          *
104          * @return      $listenAddress  The address this listener should listen on
105          */
106         public final function getListenAddress () {
107                 return $this->listenAddress;
108         }
109
110         /**
111          * Setter for listen port
112          *
113          * @param       $listenPort             The port this listener should listen on
114          * @return      void
115          */
116         protected final function setListenPort ($listenPort) {
117                 $this->listenPort = (int) $listenPort;
118         }
119
120         /**
121          * Getter for listen port
122          *
123          * @return      $listenPort             The port this listener should listen on
124          */
125         public final function getListenPort () {
126                 return $this->listenPort;
127         }
128
129         /**
130          * "Setter" to set listen address from configuration entry
131          *
132          * @param       $configEntry    The configuration entry holding our listen address
133          * @return      void
134          */
135         public final function setListenAddressByConfiguration ($configEntry) {
136                 $this->setListenAddress($this->getConfigInstance()->getConfigEntry($configEntry));
137         }
138
139         /**
140          * "Setter" to set listen port from configuration entry
141          *
142          * @param       $configEntry    The configuration entry holding our listen port
143          * @return      void
144          */
145         public final function setListenPortByConfiguration ($configEntry) {
146                 $this->setListenPort($this->getConfigInstance()->getConfigEntry($configEntry));
147         }
148
149         /**
150          * Setter for blocking-mode
151          *
152          * @param       $blockingMode   Whether blocking-mode is disabled (default) or enabled
153          * @return      void
154          */
155         protected final function setBlockingMode ($blockingMode) {
156                 $this->blockingMode = (boolean) $blockingMode;
157         }
158
159         /**
160          * Checks whether blocking-mode is enabled or disabled
161          *
162          * @return      $blockingMode   Whether blocking mode is disabled or enabled
163          */
164         public final function isBlockingModeEnabled () {
165                 return $this->blockingMode;
166         }
167
168         /**
169          * Setter for peer pool instance
170          *
171          * @param       $poolInstance   The peer pool instance we shall set
172          * @return      void
173          */
174         protected final function setPoolInstance (PoolablePeer $poolInstance) {
175                 $this->poolInstance = $poolInstance;
176         }
177
178         /**
179          * Getter for peer pool instance
180          *
181          * @return      $poolInstance   The peer pool instance we shall set
182          */
183         public final function getPoolInstance () {
184                 return $this->poolInstance;
185         }
186
187         /**
188          * Getter for connection type
189          *
190          * @return      $connectionType         Connection type for this listener
191          */
192         public final function getConnectionType () {
193                 // Wrap the real getter
194                 return $this->getProtocolName();
195         }
196
197         /**
198          * Registeres the given socket resource for "this" listener instance. This
199          * will be done in a seperate class to allow package writers to use it
200          * again.
201          *
202          * @param       $socketResource         A valid server socket resource
203          * @return      void
204          * @throws      InvalidServerSocketException            If the given resource is no server socket
205          * @throws      SocketAlreadyRegisteredException        If the given resource is already registered
206          */
207         protected function registerServerSocketResource ($socketResource) {
208                 // First check if it is valid
209                 if (!$this->isServerSocketResource($socketResource)) {
210                         // No server socket
211                         throw new InvalidServerSocketException(array($this, $socketResource), self::EXCEPTION_INVALID_SOCKET);
212                 } elseif ($this->isServerSocketRegistered($socketResource)) {
213                         // Already registered
214                         throw new SocketAlreadyRegisteredException($this, self::EXCEPTION_SOCKET_ALREADY_REGISTERED);
215                 }
216
217                 // Get a socket registry instance (singleton)
218                 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
219
220                 // Get a connection info instance
221                 $infoInstance = ConnectionInfoFactory::createConnectionInfoInstance($this->getProtocolName(), 'listener');
222
223                 // Will the info instance with listener data
224                 $infoInstance->fillWithListenerInformation($this);
225
226                 // Register the socket
227                 $registryInstance->registerSocket($infoInstance, $socketResource);
228
229                 // And set it here
230                 $this->setSocketResource($socketResource);
231         }
232
233         /**
234          * Checks whether given socket resource is registered in socket registry
235          *
236          * @param       $socketResource         A valid server socket resource
237          * @return      $isRegistered           Whether given server socket is registered
238          */
239         protected function isServerSocketRegistered ($socketResource) {
240                 // Get a socket registry instance (singleton)
241                 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
242
243                 // Get a connection info instance
244                 $infoInstance = ConnectionInfoFactory::createConnectionInfoInstance($this->getProtocolName(), 'listener');
245
246                 // Will the info instance with listener data
247                 $infoInstance->fillWithListenerInformation($this);
248
249                 // Check it
250                 $isRegistered = $registryInstance->isSocketRegistered($infoInstance, $socketResource);
251
252                 // Return result
253                 return $isRegistered;
254         }
255
256         /**
257          * Accepts the visitor to process the visit "request"
258          *
259          * @param       $visitorInstance        An instance of a Visitor class
260          * @return      void
261          */
262         public function accept (Visitor $visitorInstance) {
263                 // Debug message
264                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($this->getProtocolName()) . '-LISTENER[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited ' . $this->__toString() . ' - CALLED!');
265
266                 // Visit this listener
267                 $visitorInstance->visitListener($this);
268
269                 // Visit the pool if set
270                 if ($this->getPoolInstance() instanceof Poolable) {
271                         $this->getPoolInstance()->accept($visitorInstance);
272                 } // END - if
273
274                 // Debug message
275                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(strtoupper($this->getProtocolName()) . '-LISTENER[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited ' . $this->__toString() . ' - EXIT!');
276         }
277
278         /**
279          * Monitors incoming raw data from the handler and transfers it to the
280          * given receiver instance. This method should not be called, please call
281          * the decorator's version instead to separator node/client traffic.
282          *
283          * @return      void
284          * @throws      UnsupportedOperatorException    If this method is called by a mistake
285          */
286         public function monitorIncomingRawData () {
287                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
288         }
289
290         /**
291          * Constructs a callable method name from given socket error code. If the
292          * method is not found, a generic one is used.
293          *
294          * @param       $errorCode              Error code from socket_last_error()
295          * @return      $handlerName    Call-back method name for the error handler
296          * @throws      UnsupportedSocketErrorHandlerException If the error handler is not implemented
297          */
298         protected function getSocketErrorHandlerFromCode ($errorCode) {
299                 // Create a name from translated error code
300                 $handlerName = 'socketError' . self::convertToClassName($this->translateSocketErrorCodeToName($errorCode)) . 'Handler';
301
302                 // Is the call-back method there?
303                 if (!method_exists($this, $handlerName)) {
304                         // Please implement this
305                         throw new UnsupportedSocketErrorHandlerException(array($this, $handlerName, $errorCode), BaseConnectionHelper::EXCEPTION_UNSUPPORTED_ERROR_HANDLER);
306                 } // END - if
307
308                 // Return it
309                 return $handlerName;
310         }
311
312         /**
313          * Translates socket error codes into our own internal names which can be
314          * used for call-backs.
315          *
316          * @param       $errorCode      The error code from socket_last_error() to be translated
317          * @return      $errorName      The translated name (all lower-case, with underlines)
318          */
319         public function translateSocketErrorCodeToName ($errorCode) {
320                 // Nothing bad happened by default
321                 $errorName = BaseRawDataHandler::SOCKET_CONNECTED;
322
323                 // Is the code a number, then we have to change it
324                 switch ($errorCode) {
325                         case 0: // Silently ignored, the socket is connected
326                                 break;
327
328                         case 11:  // "Resource temporary unavailable"
329                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_RESOURCE_UNAVAILABLE;
330                                 break;
331
332                         case 13:  // "Permission denied"
333                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_PERMISSION_DENIED;
334                                 break;
335
336                         case 32:  // "Broken pipe"
337                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_BROKEN_PIPE;
338                                 break;
339
340                         case 104: // "Connection reset by peer"
341                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_CONNECTION_RESET_BY_PEER;
342                                 break;
343
344                         case 107: // "Transport end-point not connected"
345                         case 134: // On some (?) systems for 'transport end-point not connected'
346                                 // @TODO On some systems it is 134, on some 107?
347                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_TRANSPORT_ENDPOINT;
348                                 break;
349
350                         case 110: // "Connection timed out"
351                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_CONNECTION_TIMED_OUT;
352                                 break;
353
354                         case 111: // "Connection refused"
355                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_CONNECTION_REFUSED;
356                                 break;
357
358                         case 113: // "No route to host"
359                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_NO_ROUTE_TO_HOST;
360                                 break;
361
362                         case 114: // "Operation already in progress"
363                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_OPERATION_ALREADY_PROGRESS;
364                                 break;
365
366                         case 115: // "Operation now in progress"
367                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_OPERATION_IN_PROGRESS;
368                                 break;
369
370                         default: // Everything else <> 0
371                                 // Unhandled error code detected, so first debug it because we may want to handle it like the others
372                                 self::createDebugInstance(__CLASS__)->debugOutput('BASE-HUB[' . __METHOD__ . ':' . __LINE__ . '] UNKNOWN ERROR CODE = ' . $errorCode . ', MESSAGE = ' . socket_strerror($errorCode));
373
374                                 // Change it only in this class
375                                 $errorName = BaseRawDataHandler::SOCKET_ERROR_UNKNOWN;
376                                 break;
377                 }
378
379                 // Return translated name
380                 return $errorName;
381         }
382
383         /**
384          * Shuts down a given socket resource. This method does only ease calling
385          * the right visitor.
386          *
387          * @param       $socketResource         A valid socket resource
388          * @return      void
389          */
390         public function shutdownSocket ($socketResource) {
391                 // Debug message
392                 self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM: Shutting down socket resource ' . $socketResource . ' with state ' . $this->getPrintableState() . ' ...');
393
394                 // Set socket resource
395                 $this->setSocketResource($socketResource);
396
397                 // Get a visitor instance
398                 $visitorInstance = ObjectFactory::createObjectByConfiguredName('shutdown_socket_visitor_class');
399
400                 // Debug output
401                 self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
402
403                 // Call the visitor
404                 $this->accept($visitorInstance);
405         }
406
407         /**
408          * Half-shuts down a given socket resource. This method does only ease calling
409          * an other visitor than shutdownSocket() does.
410          *
411          * @param       $socketResource         A valid socket resource
412          * @return      void
413          */
414         public function halfShutdownSocket ($socketResource) {
415                 // Debug message
416                 self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM: Half-shutting down socket resource ' . $socketResource . ' with state ' . $this->getPrintableState() . ' ...');
417
418                 // Set socket resource
419                 $this->setSocketResource($socketResource);
420
421                 // Get a visitor instance
422                 $visitorInstance = ObjectFactory::createObjectByConfiguredName('half_shutdown_socket_visitor_class');
423
424                 // Debug output
425                 self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
426
427                 // Call the visitor
428                 $this->accept($visitorInstance);
429         }
430
431         // ************************************************************************
432         //                 Socket error handler call-back methods
433         // ************************************************************************
434
435         /**
436          * Handles socket error 'permission denied', but does not clear it for
437          * later debugging purposes.
438          *
439          * @param       $socketResource         A valid socket resource
440          * @param       $socketData                     A valid socket data array (0 = IP/file name, 1 = port)
441          * @return      void
442          * @throws      SocketBindingException  The socket could not be bind to
443          */
444         protected function socketErrorPermissionDeniedHandler ($socketResource, array $socketData) {
445                 // Get socket error code for verification
446                 $socketError = socket_last_error($socketResource);
447
448                 // Get error message
449                 $errorMessage = socket_strerror($socketError);
450
451                 // Shutdown this socket
452                 $this->shutdownSocket($socketResource);
453
454                 // Throw it again
455                 throw new SocketBindingException(array($this, $socketData, $socketResource, $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
456         }
457
458         /**
459          * "Listens" for incoming network packages
460          *
461          * @param       $peerSuffix             Suffix for peer name (e.g. :0 for TCP(/UDP?) connections)
462          * @return      void
463          * @throws      InvalidSocketException  If an invalid socket resource has been found
464          */
465         protected function doListenSocketSelect ($peerSuffix) {
466                 // Check on all instances
467                 assert($this->getPoolInstance() instanceof Poolable);
468                 assert(is_resource($this->getSocketResource()));
469
470                 // Get all readers
471                 $readers = $this->getPoolInstance()->getAllSingleSockets();
472                 $writers = array();
473                 $excepts = array();
474
475                 // Check if we have some peers left
476                 $left = socket_select(
477                         $readers,
478                         $writers,
479                         $excepts,
480                         0,
481                         150
482                 );
483
484                 // Some new peers found?
485                 if ($left < 1) {
486                         // Debug message
487                         //* EXTREME-NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-LISTENER[' . __METHOD__ . ':' . __LINE__ . ']: left=' . $left . ',serverSocket=' . $this->getSocketResource() . ',readers=' . print_r($readers, TRUE));
488
489                         // Nothing new found
490                         return;
491                 } // END - if
492
493                 // Debug message
494                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-LISTENER[' . __METHOD__ . ':' . __LINE__ . ']: serverSocket=' . $this->getSocketResource() . ',readers=' . print_r($readers, TRUE));
495
496                 // Do we have changed peers?
497                 if (in_array($this->getSocketResource(), $readers)) {
498                         /*
499                          * Then accept it, if this socket is set to non-blocking IO and the
500                          * connection is NOT sending any data, socket_read() may throw
501                          * error 11 (Resource temporary unavailable). This really nasty
502                          * because if you have blocking IO socket_read() will wait and wait
503                          * and wait ...
504                          */
505                         $newSocket = socket_accept($this->getSocketResource());
506
507                         // Debug message
508                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-LISTENER[' . __METHOD__ . ':' . __LINE__ . ']: newSocket=' . $newSocket . ',serverSocket=' .$this->getSocketResource());
509
510                         // Array for timeout settings
511                         $options  = array(
512                                 // Seconds
513                                 'sec'  => $this->getConfigInstance()->getConfigEntry('tcp_socket_accept_wait_sec'),
514                                 // Milliseconds
515                                 'usec' => $this->getConfigInstance()->getConfigEntry('tcp_socket_accept_wait_usec')
516                         );
517
518                         // Set timeout to configured seconds
519                         // @TODO Does this work on Windozer boxes???
520                         if (!socket_set_option($newSocket, SOL_SOCKET, SO_RCVTIMEO, $options)) {
521                                 // Handle this socket error with a faked recipientData array
522                                 $this->handleSocketError(__METHOD__, __LINE__, $newSocket, array('0.0.0.0', '0'));
523                         } // END - if
524
525                         // Output result (only for debugging!)
526                         /*
527                         $option = socket_get_option($newSocket, SOL_SOCKET, SO_RCVTIMEO);
528                         self::createDebugInstance(__CLASS__)->debugOutput('SO_RCVTIMEO[' . gettype($option) . ']=' . print_r($option, TRUE));
529                         */
530
531                         // Enable SO_OOBINLINE
532                         if (!socket_set_option($newSocket, SOL_SOCKET, SO_OOBINLINE ,1)) {
533                                 // Handle this socket error with a faked recipientData array
534                                 $this->handleSocketError(__METHOD__, __LINE__, $newSocket, array('0.0.0.0', '0'));
535                         } // END - if
536
537                         // Set non-blocking
538                         if (!socket_set_nonblock($newSocket)) {
539                                 // Handle this socket error with a faked recipientData array
540                                 $this->handleSocketError(__METHOD__, __LINE__, $newSocket, array('0.0.0.0', '0'));
541                         } // END - if
542
543                         // Add it to the peers
544                         $this->getPoolInstance()->addPeer($newSocket, BaseConnectionHelper::CONNECTION_TYPE_INCOMING);
545
546                         // Get peer name
547                         if (!socket_getpeername($newSocket, $peerName)) {
548                                 // Handle this socket error with a faked recipientData array
549                                 $this->handleSocketError(__METHOD__, __LINE__, $newSocket, array('0.0.0.0', '0'));
550                         } // END - if
551
552                         // Get node instance
553                         $nodeInstance = NodeObjectFactory::createNodeInstance();
554
555                         // Create a faked package data array
556                         $packageData = array(
557                                 NetworkPackage::PACKAGE_DATA_SENDER    => $peerName . $peerSuffix,
558                                 NetworkPackage::PACKAGE_DATA_RECIPIENT => $nodeInstance->getSessionId(),
559                                 NetworkPackage::PACKAGE_DATA_STATUS    => NetworkPackage::PACKAGE_STATUS_FAKED
560                         );
561
562                         // Get a connection info instance
563                         $infoInstance = ConnectionInfoFactory::createConnectionInfoInstance($this->getProtocolName(), 'listener');
564
565                         // Will the info instance with listener data
566                         $infoInstance->fillWithListenerInformation($this);
567
568                         // Get a socket registry
569                         $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
570
571                         // Register the socket with the registry and with the faked array
572                         $registryInstance->registerSocket($infoInstance, $newSocket, $packageData);
573                 } // END - if
574
575                 // Do we have to rewind?
576                 if (!$this->getIteratorInstance()->valid()) {
577                         // Rewind the list
578                         $this->getIteratorInstance()->rewind();
579                 } // END - if
580
581                 // Get the current value
582                 $currentSocket = $this->getIteratorInstance()->current();
583
584                 // Handle it here, if not main server socket
585                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('TCP-LISTENER[' . __METHOD__ . ':' . __LINE__ . ']: currentSocket=' . $currentSocket[BasePool::SOCKET_ARRAY_RESOURCE] . ',type=' . $currentSocket[BasePool::SOCKET_ARRAY_CONN_TYPE] . ',serverSocket=' . $this->getSocketResource());
586                 if (($currentSocket[BasePool::SOCKET_ARRAY_CONN_TYPE] != BaseConnectionHelper::CONNECTION_TYPE_SERVER) && ($currentSocket[BasePool::SOCKET_ARRAY_RESOURCE] != $this->getSocketResource())) {
587                         // ... or else it will raise warnings like 'Transport endpoint is not connected'
588                         $this->getHandlerInstance()->processRawDataFromResource($currentSocket);
589                 } // END - if
590
591                 // Advance to next entry. This should be the last line.
592                 $this->getIteratorInstance()->next();
593         }
594
595 }