<?PHP
/**
* patServer
* Basisklasse des PHP-Socket-Servers
* Ereignisse, die behandelt werden können:
* * onStart
* * onConnect
* * onConnectionRefused
* * onClose
* * onShutdown
* * onReceiveData
*
* @Version 1.1
* @Autor Stephan Schmidt < [email protected] >
* @package patServer
*/
Klasse patServer{
/**
* Informationen zum Projekt
* @var-Array $systemVars
*/
var $systemVars = array(
"appName" => "patServer",
"appVersion" => "1.1",
"author" => array("Stephan Schmidt < [email protected] >", )
);
/**
* Port zum Abhören
* @var integer $port
*/
var $port = 10000;
/**
* Domäne, an die gebunden werden soll
* @var string $domain
*/
var $domain = "localhost";
/**
* maximale Anzahl an Kunden
* @var integer $maxClients
*/
var $maxClients = -1;
/**
* Puffergröße für socket_read
* @var integer $readBufferSize
*/
var $readBufferSize = 128;
/**
* Endzeichen für socket_read
* @var integer $readEndCharacter
*/
var $readEndCharacter = "n";
/**
* Maximaler Rückstand in der Warteschlange
* @var integer $maxQueue
*/
var $maxQueue = 500;
/**
* Debug-Modus
* @var boolean $debug
*/
var $debug = true;
/**
* Debug-Modus
* @var string $debugMode
*/
var $debugMode = "text";
/**
* Debug-Ziel (Dateiname oder Standardausgabe)
* @var string $debugDest
*/
var $debugDest = "stdout";
/**
* leeres Array, verwendet für socket_select
* @var-Array $null
*/
var $null = array();
/**
* Alle Dateideskriptoren werden hier gespeichert
* @var-Array $clientFD
*/
var $clientFD = array();
/**
* wird zum Speichern von Kundeninformationen benötigt
* @var-Array $clientInfo
*/
var $clientInfo = array();
/**
* wird zum Speichern von Serverinformationen benötigt
* @var-Array $serverInfo
*/
var $serverInfo = array();
/**
* Anzahl der Kunden
* @var integer $clients
*/
var $clients = 0;
/**
* Erstellen Sie einen neuen Socket-Server
*
* @access public
* @param string $domain Domäne, an die gebunden werden soll
* @param integer $port Port zum Abhören
*/
Funktion patServer( $domain = "localhost", $port = 10000 ){
$this->domain = $domain;
$this->port = $port;
$this->serverInfo["domain"] = $domain;
$this->serverInfo["port"] = $port;
$this->serverInfo["servername"] = $this->systemVars["appName"];
$this->serverInfo["serverversion"] = $this->systemVars["appVersion"];
set_time_limit( 0 );
}
/**
* Maximale Anzahl gleichzeitiger Verbindungen festlegen
*
* @access public
* @param int $maxClients
*/
Funktion setMaxClients( $maxClients ){
$this->maxClients = $maxClients;
}
/**
* Debug-Modus einstellen
*
* @access public
* @param gemischt $debug [text|htmlfalse]
* @param string $dest Ziel der Debug-Nachricht (Standardausgabe zur Ausgabe oder Dateiname, wenn das Protokoll geschrieben werden soll)
*/
Funktion setDebugMode( $debug, $dest = "stdout" ){
if( $debug === false ){
$this->debug = false;
return true;
}
$this->debug = true;
$this->debugMode = $debug;
$this->debugDest = $dest;
}
/**
* Starten Sie den Server
*
* @access public
* @param int $maxClients
*/
Funktion start(){
$this->initFD = @socket_create( AF_INET, SOCK_STREAM, 0 );
if( !$this->initFD )
die( "patServer: Socket konnte nicht erstellt werden." );
// Adresse darf wiederverwendet werden
socket_setopt( $this->initFD, SOL_SOCKET, SO_REUSEADDR, 1 );
// Den Socket binden
if( !@socket_bind ( $this->initFD, $this->domain, $this->port ) ){
@socket_close( $this->initFD );
die( „patServer: Socket konnte nicht an „.$this->domain.“ an Port „.$this->port.“ gebunden werden ( „.$this->getLastSocketError( $this->initFd ).“ ).“ );
}
// Überwachen Sie den ausgewählten Port
if( !@socket_listen ( $this->initFD, $this->maxQueue ) )
die( "patServer: Konnte nicht abhören ( ".$this->getLastSocketError( $this->initFd )." )." );
$this->sendDebugMessage( "Listening on port ".$this->port.". Server gestartet um ".date( "H:i:s", time() ) );
// Dadurch kann die Shutdown-Funktion prüfen, ob der Server bereits heruntergefahren ist
$GLOBALS["_patServerStatus"] = "running";
// Dadurch wird sichergestellt, dass der Server ordnungsgemäß heruntergefahren wird
register_shutdown_function( array( $this, "shutdown" ) );
if( method_exists( $this, "onStart" ) )
$this->onStart();
$this->serverInfo["started"] = time();
$this->serverInfo["status"] = "running";
while( true ){
$readFDs = array();
array_push( $readFDs, $this->initFD );
// alle Clients abrufen, die auf Verbindungen warten
for( $i = 0; $i < count( $this->clientFD ); $i++ )
if( isset( $this->clientFD[$i] ) )
array_push( $readFDs, $this->clientFD[$i] );
// blockieren und auf Daten oder neue Verbindung warten
$ready = @socket_select( $readFDs, $this->null, $this->null, NULL );
if( $ready === false ){
$this->sendDebugMessage( "socket_select failed." );
$this->shutdown();
}
// Auf neue Verbindung prüfen
if( in_array( $this->initFD, $readFDs ) ){
$newClient = $this->acceptConnection( $this->initFD );
// Auf maximale Anzahl an Verbindungen prüfen
if( $this->maxClients > 0 ){
if( $this->clients > $this->maxClients ){
$this->sendDebugMessage( "Zu viele Verbindungen." );
if( method_exists( $this, "onConnectionRefused" ) )
$this->onConnectionRefused( $newClient );
$this->closeConnection( $newClient );
}
}
if( --$ready <= 0 )
weitermachen;
}
// Alle Clients auf eingehende Daten prüfen
for( $i = 0; $i < count( $this->clientFD ); $i++ ){
if( !isset( $this->clientFD[$i] ) )
weitermachen;
if( in_array( $this->clientFD[$i], $readFDs ) ){
$data = $this->readFromSocket( $i );
// leere Daten => Verbindung wurde geschlossen
if( !$data ){
$this->sendDebugMessage( "Verbindung vom Peer geschlossen" );
$this->closeConnection( $i );
}anders{
$this->sendDebugMessage( "Received ".trim( $data )." from ".$i );
if( method_exists( $this, "onReceiveData" ) )
$this->onReceiveData( $i, $data );
}
}
}
}
}
/**
* Aus einem Socket lesen
*
* @access privat
* @param integer $clientId interne ID des Clients, von dem gelesen werden soll
* @return string $data Daten, die gelesen wurden
*/
Funktion readFromSocket( $clientId ){
// mit leerem String beginnen
$data = "";
// Daten vom Socket lesen
while( $buf = socket_read( $this->clientFD[$clientId], $this->readBufferSize ) ){
$data .= $buf;
$endString = substr( $buf, - strlen( $this->readEndCharacter ) );
if( $endString == $this->readEndCharacter )
brechen;
if( $buf == NULL )
brechen;
}
if( $buf === false )
$this->sendDebugMessage( „Vom Client „.$clientId“ konnte nicht gelesen werden.“ ( „.$this->getLastSocketError( $this->clientFD[$clientId] ).“ ).“ );
$data zurückgeben;
}
/**
* Akzeptieren Sie eine neue Verbindung
*
* @access public
* @param-Ressource &$socket Socket, der die neue Verbindung empfangen hat
* @return int $clientID interne ID des Clients
*/
Funktion AcceptConnection( &$socket ){
for( $i = 0 ; $i <= count( $this->clientFD ); $i++ ){
if( !isset( $this->clientFD[$i] ) || $this->clientFD[$i] == NULL ){
$this->clientFD[$i] = socket_accept( $socket );
socket_setopt( $this->clientFD[$i], SOL_SOCKET, SO_REUSEADDR, 1 );
$peer_host = "";
$peer_port = "";
socket_getpeername( $this->clientFD[$i], $peer_host, $peer_port );
$this->clientInfo[$i] = array(
"host" => $peer_host,
"port" => $peer_port,
"connectOn" => time()
);
$this->clients++;
$this->sendDebugMessage( "Neue Verbindung ( ".$i. ) von ".$peer_host." auf Port ".$peer_port );
if( method_exists( $this, "onConnect" ) )
$this->onConnect( $i );
return $i;
}
}
}
/**
* Überprüfen Sie, ob noch ein Client verbunden ist
*
* @access public
* @param integer $id Client-ID
* @return boolean $connected true, wenn der Client verbunden ist, andernfalls false
*/
Funktion isConnected( $id ){
if( !isset( $this->clientFD[$id] ) )
return false;
return true;
}
/**
* enge Verbindung zu einem Client
*
* @access public
* @param int $clientID interne ID des Clients
*/
Funktion closeConnection( $id ){
if( !isset( $this->clientFD[$id] ) )
return false;
if( method_exists( $this, "onClose" ) )
$this->onClose( $id );
$this->sendDebugMessage( "Geschlossene Verbindung ( ".$id. ) von ".$this->clientInfo[$id]["host"]." am Port ".$this->clientInfo[$id][ "Hafen"] );
@socket_close( $this->clientFD[$id] );
$this->clientFD[$id] = NULL;
unset( $this->clientInfo[$id] );
$this->clients--;
}
/**
* Server herunterfahren
*
* @access public
*/
Funktion ShutDown(){
if( $GLOBALS["_patServerStatus"] != "running" )
Ausfahrt;
$GLOBALS["_patServerStatus"] = "stopped";
if( method_exists( $this, "onShutdown" ) )
$this->onShutdown();
$maxFD = count( $this->clientFD );
for( $i = 0; $i < $maxFD; $i++ )
$this->closeConnection( $i );
@socket_close( $this->initFD );
$this->sendDebugMessage( "Server herunterfahren." );
Ausfahrt;
}
/**
* Aktuelle Anzahl der Kunden abrufen
*
* @access public
* @return int $clients Anzahl der Kunden
*/
Funktion getClients(){
return $this->clients;
}
/**
* Daten an einen Client senden
*
* @access public
* @param int $clientId ID des Clients
* @param string $data Zu sendende Daten
* @param boolean $debugData Flag, um anzugeben, ob Daten, die in den Socket geschrieben werden, auch als Debug-Nachricht gesendet werden sollen
*/
Funktion sendData( $clientId, $data, $debugData = true ){
if( !isset( $this->clientFD[$clientId] ) || $this->clientFD[$clientId] == NULL )
return false;
if( $debugData )
$this->sendDebugMessage( "sending: "" . $data . "" to: $clientId" );
if( !@socket_write ( $this->clientFD[$clientId], $data ) )
$this->sendDebugMessage( „'“.$data.“‘ client „.$clientId.“ ( „.$this->getLastSocketError( $this->clientFD[$clientId] ).“ ).“ ) ;
}
/**
* Daten an alle Kunden senden
*
* @access public
* @param string $data Zu sendende Daten
* @param-Array $exclude auszuschließende Client-IDs
*/
Funktion BroadcastData( $data, $exclude = array(), $debugData = true ){
if( !empty( $exclude ) && !is_array( $exclude ) )
$exclude = array( $exclude );
for( $i = 0; $i < count( $this->clientFD ); $i++ ){
if( isset( $this->clientFD[$i] ) && $this->clientFD[$i] != NULL && !in_array( $i, $exclude ) ){
if( $debugData )
$this->sendDebugMessage( "sending: "" . $data . "" to: $i" );
if( !@socket_write ( $this->clientFD[$i], $data ) )
$this->sendDebugMessage( „'“.$data.“‘ client „.$i.“ ( „.$this->getLastSocketError( $this->clientFD[$i] ).“ ).“ ) ;
}
}
}
/**
* aktuelle Informationen über einen Kunden erhalten
*
* @access public
* @param int $clientId ID des Clients
* @return array $info Informationen über den Client
*/
Funktion getClientInfo( $clientId ){
if( !isset( $this->clientFD[$clientId] ) || $this->clientFD[$clientId] == NULL )
return false;
return $this->clientInfo[$clientId];
}
/**
* Senden Sie eine Debug-Nachricht
*
* @access privat
* @param string $msg Nachricht zum Debuggen
*/
Funktion sendDebugMessage( $msg ){
if( !$this->debug )
return false;
$msg = date( "Ymd H:i:s", time() ) . " " . $msg;
switch( $this->debugMode ){
Fall „Text“:
$msg = $msg."n";
brechen;
Fall „html“:
$msg = htmlspecialchars( $msg ) . "<br />n";
brechen;
}
if( $this->debugDest == "stdout" || empty( $this->debugDest ) ){
echo $msg;
spülen();
return true;
}
error_log( $msg, 3, $this->debugDest );
return true;
}
/**
* Rückgabezeichenfolge für den letzten Socket-Fehler
*
* @access public
* @return string $error letzter Fehler
*/
Funktion getLastSocketError( &$fd ){
$lastError = socket_last_error( $fd );
gib „msg:“ zurück. socket_strerror( $lastError ) . " / Code: ".$lastError;
}
Funktion onReceiveData($ip,$data){
$this->broadcastData( $data,array(), true );
}
}
$patServer = new patServer();
$patServer->start();
?>