<?PHP
/**
* patServeur
* Classe de base du serveur socket PHP
* Événements pouvant être gérés :
* * au démarrage
* * surConnect
* * onConnectionRefused
* * surFermer
* * surArrêt
* * onReceiveData
*
* @version 1.1
* @auteur Stephan Schmidt < [email protected] >
* @package patServer
*/
classe patServer{
/**
* informations sur le projet
* @var tableau $systemVars
*/
var $systemVars = array(
"appName" => "patServer",
"Versionapplication" => "1.1",
"auteur" => array("Stephan Schmidt < [email protected] >", )
);
/**
* port pour écouter
* @var entier $port
*/
var $port = 10000 ;
/**
* domaine auquel se lier
* @var chaîne $domaine
*/
var $domain = "localhost";
/**
* nombre maximum de clients
* @var entier $maxClients
*/
var $maxClients = -1;
/**
* taille du tampon pour socket_read
* @var entier $readBufferSize
*/
var $readBufferSize = 128;
/**
* caractère de fin pour socket_read
* @var entier $readEndCharacter
*/
var $readEndCharacter = "n";
/**
* maximum de retard dans la file d'attente
* @var entier $maxQueue
*/
var $maxQueue = 500 ;
/**
* mode débogage
* @var booléen $debug
*/
var $debug = vrai;
/**
* mode débogage
* @var chaîne $debugMode
*/
var $debugMode = "texte";
/**
* destination du débogage (nom de fichier ou sortie standard)
* @var chaîne $debugDest
*/
var $debugDest = "stdout";
/**
* tableau vide, utilisé pour socket_select
* @var tableau $null
*/
var $null = tableau();
/**
* tous les descripteurs de fichiers sont stockés ici
* @var tableau $clientFD
*/
var $clientFD = tableau();
/**
* nécessaire pour stocker les informations du client
* @var tableau $clientInfo
*/
var $clientInfo = tableau();
/**
* nécessaire pour stocker les informations du serveur
* @var tableau $serverInfo
*/
var $serverInfo = tableau();
/**
* nombre de clients
* @var entier $clients
*/
var $clients = 0;
/**
* créer un nouveau serveur socket
*
* @accès public
* @param string $domain domaine auquel se lier
* @param entier $port port à écouter
*/
function 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 );
}
/**
* définir le nombre maximum de connexions simultanées
*
* @accès public
* @param int $maxClients
*/
fonction setMaxClients( $maxClients ){
$this->maxClients = $maxClients ;
}
/**
* définir le mode de débogage
*
* @accès public
* @param mixte $debug [texte|htmlfalse]
* @param string $dest destination du message de débogage (stdout vers la sortie ou nom de fichier si le journal doit être écrit)
*/
fonction setDebugMode( $debug, $dest = "stdout" ){
si( $debug === false ){
$this->debug = faux ;
renvoie vrai ;
}
$this->debug = true;
$this->debugMode = $debug;
$this->debugDest = $dest;
}
/**
* démarrer le serveur
*
* @accès public
* @param int $maxClients
*/
fonction start(){
$this->initFD = @socket_create( AF_INET, SOCK_STREAM, 0 );
si( !$this->initFD )
die( "patServer : Impossible de créer le socket." );
// l'adresse peut être réutilisée
socket_setopt( $this->initFD, SOL_SOCKET, SO_REUSEADDR, 1 );
// lie la socket
if( !@socket_bind ( $this->initFD, $this->domain, $this->port ) ){
@socket_close( $this->initFD );
die( "patServer : Impossible de lier le socket à ".$this->domain." sur le port ".$this->port." ( ".$this->getLastSocketError( $this->initFd )." )." );
}
// écoute sur le port sélectionné
if( !@socket_listen ( $this->initFD, $this->maxQueue ) )
die( "patServer : Impossible d'écouter ( ".$this->getLastSocketError( $this->initFd )." )." );
$this->sendDebugMessage( "Écoute sur le port ".$this->port.". Le serveur a démarré à ".date( "H:i:s", time() ) );
// cela permet à la fonction shutdown de vérifier si le serveur est déjà arrêté
$GLOBALS["_patServerStatus"] = "en cours d'exécution";
// cela garantit que le serveur sera arrêté correctement
register_shutdown_function( array( $this, "shutdown" ) );
if( method_exists( $this, "onStart" ) )
$this->onStart();
$this->serverInfo["started"] = time();
$this->serverInfo["status"] = "en cours d'exécution";
tandis que( vrai ){
$readFDs = tableau();
array_push( $readFDs, $this->initFD );
// récupère tous les clients en attente de connexion
pour( $i = 0; $i < count( $this->clientFD ); $i++ )
si( isset( $this->clientFD[$i] ) )
array_push( $readFDs, $this->clientFD[$i] );
// bloque et attend les données ou une nouvelle connexion
$ready = @socket_select( $readFDs, $this->null, $this->null, NULL );
si( $prêt === faux ){
$this->sendDebugMessage( "socket_select a échoué." );
$this->shutdown();
}
// recherche une nouvelle connexion
if( in_array( $this->initFD, $readFDs ) ){
$newClient = $this->acceptConnection( $this->initFD );
// vérifie le nombre maximum de connexions
si( $this->maxClients > 0 ){
if( $this->clients > $this->maxClients ){
$this->sendDebugMessage( "Trop de connexions." );
if( method_exists( $this, "onConnectionRefused" ) )
$this->onConnectionRefused( $newClient );
$this->closeConnection( $newClient );
}
}
si( --$prêt <= 0 )
continuer;
}
// vérifie tous les clients pour les données entrantes
pour( $i = 0; $i < count( $this->clientFD ); $i++ ){
if( !isset( $this->clientFD[$i] ) )
continuer;
if( in_array( $this->clientFD[$i], $readFDs ) ){
$data = $this->readFromSocket( $i );
// données vides => la connexion a été fermée
si( !$données ){
$this->sendDebugMessage( "Connexion fermée par un homologue" );
$this->closeConnection( $i );
}autre{
$this->sendDebugMessage( "Reçu ".trim( $data )." de ".$i );
if( method_exists( $this, "onReceiveData" ) )
$this->onReceiveData( $i, $data );
}
}
}
}
}
/**
* lire depuis une socket
*
* @accès privé
* @param entier $clientId identifiant interne du client à partir duquel lire
* @return string $data données lues
*/
fonction readFromSocket( $clientId ){
// commence par une chaîne vide
$données = "";
// lit les données du socket
while( $buf = socket_read( $this->clientFD[$clientId], $this->readBufferSize ) ){
$données .= $buff;
$endString = substr( $buf, - strlen( $this->readEndCharacter ) );
si( $endString == $this->readEndCharacter )
casser;
si( $buf == NULL )
casser;
}
si( $buf === faux )
$this->sendDebugMessage( "Impossible de lire à partir du client ".$clientId." ( ".$this->getLastSocketError( $this->clientFD[$clientId] )." )." );
renvoyer $données ;
}
/**
* accepter une nouvelle connexion
*
* @accès public
* Ressource @param &$socket socket qui a reçu la nouvelle connexion
* @return int $clientID ID interne du client
*/
fonction acceptConnection( &$socket ){
pour( $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] = tableau(
"hôte" => $peer_host,
"port" => $peer_port,
"connectOn" => heure()
);
$this->clients++;
$this->sendDebugMessage( "Nouvelle connexion ( ".$i." ) depuis ".$peer_host." sur le port ".$peer_port );
if( method_exists( $this, "onConnect" ) )
$this->onConnect( $i );
retourner $i ;
}
}
}
/**
* vérifier si un client est toujours connecté
*
* @accès public
* @param entier $id identifiant client
* @return boolean $connected true si le client est connecté, false sinon
*/
la fonction estConnectée( $id ){
if( !isset( $this->clientFD[$id] ) )
renvoie faux ;
renvoie vrai ;
}
/**
* connexion étroite avec un client
*
* @accès public
* @param int $clientID ID interne du client
*/
fonction closeConnection( $id ){
if( !isset( $this->clientFD[$id] ) )
renvoie faux ;
if( method_exists( $this, "onClose" ) )
$this->onClose( $id );
$this->sendDebugMessage( "Connexion fermée ( ".$id." ) depuis ".$this->clientInfo[$id]["host"]." sur le port ".$this->clientInfo[$id][ "port"] );
@socket_close( $this->clientFD[$id] );
$this->clientFD[$id] = NULL ;
unset( $this->clientInfo[$id] );
$this->clients--;
}
/**
* serveur d'arrêt
*
* @accès public
*/
fonction shutdown(){
if( $GLOBALS["_patServerStatus"] != "en cours d'exécution" )
sortie;
$GLOBALS["_patServerStatus"] = "arrêté";
if( method_exists( $this, "onShutdown" ) )
$this->onShutdown();
$maxFD = count( $this->clientFD );
pour( $i = 0; $i < $maxFD; $i++ )
$this->closeConnection( $i );
@socket_close( $this->initFD );
$this->sendDebugMessage( "Arrêter le serveur." );
sortie;
}
/**
* obtenir le nombre actuel de clients
*
* @accès public
* @return int $clients montant des clients
*/
fonction getClients(){
retourner $this->clients ;
}
/**
* envoyer des données à un client
*
* @accès public
* @param int $clientId ID du client
* @param string $data données à envoyer
* @param boolean $debugData indicateur pour indiquer si les données écrites sur le socket doivent également être envoyées en tant que message de débogage
*/
fonction sendData( $clientId, $data, $debugData = true ){
if( !isset( $this->clientFD[$clientId] ) || $this->clientFD[$clientId] == NULL )
renvoie faux ;
si( $debugData )
$this->sendDebugMessage( "envoi : "" . $data . "" à : $clientId" );
if( !@socket_write ( $this->clientFD[$clientId], $data ) )
$this->sendDebugMessage( "Impossible d'écrire '".$data."' client ".$clientId." ( ".$this->getLastSocketError( $this->clientFD[$clientId] )." )." ) ;
}
/**
* envoyer des données à tous les clients
*
* @accès public
* @param string $data données à envoyer
* @param array $exclude identifiants client à exclure
*/
function BroadcastData( $data, $exclude = array(), $debugData = true ){
if( !empty( $exclude ) && !is_array( $exclude ) )
$exclure = tableau( $exclure );
pour( $i = 0; $i < count( $this->clientFD ); $i++ ){
if( isset( $this->clientFD[$i] ) && $this->clientFD[$i] != NULL && !in_array( $i, $exclude ) ){
si( $debugData )
$this->sendDebugMessage( "envoi : "" . $data . "" à : $i" );
if( !@socket_write ( $this->clientFD[$i], $data ) )
$this->sendDebugMessage( "Impossible d'écrire '".$data."' client ".$i." ( ".$this->getLastSocketError( $this->clientFD[$i] )." )." ) ;
}
}
}
/**
* obtenir des informations actuelles sur un client
*
* @accès public
* @param int $clientId ID du client
* @return array $info informations sur le client
*/
fonction getClientInfo( $clientId ){
if( !isset( $this->clientFD[$clientId] ) || $this->clientFD[$clientId] == NULL )
renvoie faux ;
return $this->clientInfo[$clientId];
}
/**
* envoyer un message de débogage
*
* @accès privé
* @param string $msg message à déboguer
*/
fonction sendDebugMessage( $msg ){
si( !$this->debug )
renvoie faux ;
$msg = date( "Ymd H:i:s", time() ) . " " . $msg;
switch( $this->debugMode ){
cas "texte":
$msg = $msg."n";
casser;
cas "html":
$msg = htmlspecialchars( $msg ) . "<br />n" ;
casser;
}
if( $this->debugDest == "stdout" || vide( $this->debugDest ) ){
écho $msg;
flush();
renvoie vrai ;
}
error_log( $msg, 3, $this->debugDest );
renvoie vrai ;
}
/**
* chaîne de retour pour la dernière erreur de socket
*
* @accès public
* @return string $error dernière erreur
*/
fonction getLastSocketError( &$fd ){
$lastError = socket_last_error( $fd );
renvoie "msg: " . socket_strerror( $lastError ) . " / Code : ".$lastError;
}
fonction onReceiveData($ip,$data){
$this->broadcastData( $data,array(), true );
}
}
$patServer = nouveau patServer();
$patServer->start();
?>