<?PHP
/**
* パットサーバー
* PHPソケットサーバー基本クラス
※扱えるイベント:
* * 開始時
* * オンコネクト
* * onConnectionRefused
* * onClose
* * シャットダウン時
* * onReceiveData
*
* @バージョン1.1
* @author Stephan Schmidt < [email protected] >
* @package patServer
*/
クラスパットサーバー{
/**
* プロジェクトに関する情報
* @var 配列 $systemVars
*/
var $systemVars = array(
"appName" => "patServer",
"appVersion" => "1.1",
"著者" => array("ステファン・シュミット < [email protected] >", )
);
/**
* リッスンするポート
* @var integer $port
*/
var $ポート = 10000;
/**
* バインド先のドメイン
* @var 文字列 $domain
*/
var $domain = "ローカルホスト";
/**
* クライアントの最大数
* @var integer $maxClients
*/
var $maxClients = -1;
/**
*socket_readのバッファサイズ
* @var integer $readBufferSize
*/
var $readBufferSize = 128;
/**
*socket_readの終了文字
* @var integer $readEndCharacter
*/
var $readEndCharacter = "n";
/**
* キュー内のバックログの最大数
* @var integer $maxQueue
*/
var $maxQueue = 500;
/**
* デバッグモード
* @var boolean $debug
*/
var $debug = true;
/**
* デバッグモード
* @var string $debugMode
*/
var $debugMode = "テキスト";
/**
* デバッグ先 (ファイル名または標準出力)
* @var string $debugDest
*/
var $debugDest = "標準出力";
/**
* 空の配列、socket_select に使用
* @var 配列 $null
*/
var $null = 配列();
/**
* すべてのファイル記述子はここに保存されます
* @var 配列 $clientFD
*/
var $clientFD = array();
/**
* クライアント情報を保存するために必要です
* @var 配列 $clientInfo
*/
var $clientInfo = array();
/**
* サーバー情報を保存するために必要です
* @var 配列 $serverInfo
*/
var $serverInfo = array();
/**
* クライアントの数
* @var integer $clients
*/
var $clients = 0;
/**
* 新しいソケットサーバーを作成します
*
* @アクセスパブリック
* @param string $domain バインド先のドメイン
* @param integer $port リッスンするポート
*/
function patServer( $domain = "localhost", $port = 10000 ){
$this->ドメイン = $ドメイン;
$this->port = $port;
$this->serverInfo["ドメイン"] = $ドメイン;
$this->serverInfo["ポート"] = $ポート;
$this->serverInfo["サーバー名"] = $this->systemVars["アプリ名"];
$this->serverInfo["serverversion"] = $this->systemVars["appVersion"];
set_time_limit( 0 );
}
/**
* 同時接続の最大数を設定します
*
* @アクセスパブリック
* @param int $maxClients
*/
関数 setMaxClients( $maxClients ){
$this->maxClients = $maxClients;
}
/**
* デバッグモードを設定します
*
* @アクセスパブリック
* @param 混合 $debug [text|htmlfalse]
* @param string $dest デバッグ メッセージの宛先 (出力への stdout、またはログを書き込む必要がある場合はファイル名)
*/
function setDebugMode( $debug, $dest = "stdout" ){
if( $debug === false ){
$this->debug = false;
true を返します。
$
this->debug = true;
$this->debugMode = $debug;
$this->debugDest = $dest;
}
/**
* サーバーを起動します
*
* @アクセスパブリック
* @param int $maxClients
*/
関数 start(){
$this->initFD = @socket_create( AF_INET, SOCK_STREAM, 0 );
if( !$this->initFD )
die( "patServer: ソケットを作成できませんでした。" );
// アドレスは再利用される可能性があります
ソケット_setopt( $this->initFD, SOL_SOCKET, SO_REUSEADDR, 1 );
// ソケットをバインドする
if( !@socket_bind ( $this->initFD, $this->domain, $this->port ) ){
@socket_close( $this->initFD );
die( "patServer: ポート ".$this->port" でソケットを ".$this->domain." にバインドできませんでした。" ( ".$this->getLastSocketError( $this->initFd )." )." );
}
// 選択したポートでリッスンします
if( !@socket_listen ( $this->initFD, $this->maxQueue ) )
die( "patServer: リッスンできませんでした ( ".$this->getLastSocketError( $this->initFd )." )." );
$this->sendDebugMessage( "ポート ".$this->port." でリッスンしています。サーバーは ".date( "H:i:s", time() ) に開始されました );
// これにより、シャットダウン関数がサーバーがすでにシャットダウンされているかどうかを確認できるようになります
$GLOBALS["_patServerStatus"] = "実行中";
// これにより、サーバーが正しくシャットダウンされることが保証されます
register_shutdown_function( array( $this, "shutdown" ) );
if( method_exists( $this, "onStart" ) )
$this->onStart();
$this->serverInfo["started"] = time();
$this->serverInfo["ステータス"] = "実行中";
while( true ){
$readFDs = 配列();
array_push( $readFDs, $this->initFD );
// 接続を待っているすべてのクライアントを取得します
for( $i = 0; $i < count( $this->clientFD ); $i++ )
if( isset( $this->clientFD[$i] ) )
array_push( $readFDs, $this->clientFD[$i] );
// ブロックしてデータまたは新しい接続を待ちます
$ready = @socket_select( $readFDs, $this->null, $this->null, NULL );
if( $ready === false ){
$this->sendDebugMessage( "socket_select に失敗しました。" );
$this->shutdown();
}
// 新しい接続を確認します
if( in_array( $this->initFD, $readFDs ) ){
$newClient = $this->acceptConnection( $this->initFD );
// 最大接続数を確認する
if( $this->maxClients > 0 ){
if( $this->clients > $this->maxClients ){
$this->sendDebugMessage( "接続が多すぎます。" );
if( method_exists( $this, "onConnectionRefused" ) )
$this->onConnectionRefused( $newClient );
$this->closeConnection( $newClient );
}
if
( --$ready <= 0 )
続く;
}
// すべてのクライアントが受信データをチェックする
for( $i = 0; $i < count( $this->clientFD ); $i++ ){
if( !isset( $this->clientFD[$i] ) )
続く;
if( in_array( $this->clientFD[$i], $readFDs ) ){
$data = $this->readFromSocket( $i );
// 空のデータ => 接続が閉じられました
if( !$data ){
$this->sendDebugMessage( "ピアによって接続が閉じられました" );
$this->closeConnection( $i );
}それ以外{
$this->sendDebugMessage( ".$i から ".trim( $data )." を受信しました );
if( method_exists( $this, "onReceiveData" ) )
$this->onReceiveData( $i, $data );
}
}
}
}
}
/**
* ソケットから読み取る
*
* @アクセス非公開
* @param integer $clientId 読み取り元のクライアントの内部 ID
* @return string $data 読み取られたデータ
*/
関数 readFromSocket( $clientId ){
// 空の文字列から始める
$data = "";
// ソケットからデータを読み取ります
while( $buf =ソケット_読み取り( $this->clientFD[$clientId], $this->readBufferSize ) ){
$data .= $buf;
$endString = substr( $buf, - strlen( $this->readEndCharacter ) );
if( $endString == $this->readEndCharacter )
壊す;
if( $buf == NULL )
壊す;
if
( $buf === false )
$this->sendDebugMessage( "クライアント ".$clientId" から読み取れませんでした。" ( ".$this->getLastSocketError( $this->clientFD[$clientId] )." )." );
$data を返します。
}
/**
* 新しい接続を受け入れる
*
* @アクセスパブリック
* @param resource &$socket 新しい接続を受信したソケット
* @return int $clientID クライアントの内部 ID
*/
関数 acceptConnection( &$socket ){
for( $i = 0 ; $i <= count( $this->clientFD ); $i++ ){
if( !isset( $this->clientFD[$i] ) || $this->clientFD[$i] == NULL ){
$this->clientFD[$i] =ソケット_accept( $socket );
ソケット_setopt( $this->clientFD[$i], SOL_SOCKET, SO_REUSEADDR, 1 );
$peer_host = "";
$peer_port = "";
ソケットgetpeername( $this->clientFD[$i], $peer_host, $peer_port );
$this->clientInfo[$i] = array(
"ホスト" => $peer_host,
"ポート" => $peer_port、
"connectOn" => time()
);
$this->client++;
$this->sendDebugMessage( "ポート ".$peer_port" 上の ".$peer_host." からの新しい接続 ( ".$i." );
if( method_exists( $this, "onConnect" ) )
$this->onConnect( $i );
$i を返します。
}
}
}
/**
* クライアントがまだ接続されているかどうかを確認します
*
* @アクセスパブリック
* @param integer $id クライアント ID
* @return boolean $connected クライアントが接続されている場合は true、そうでない場合は false
*/
関数 isConnected( $id ){
if( !isset( $this->clientFD[$id] ) )
false を返します。
true を返します。
}
/**
* クライアントへの接続を閉じる
*
* @アクセスパブリック
* @param int $clientID クライアントの内部 ID
*/
関数 closeConnection( $id ){
if( !isset( $this->clientFD[$id] ) )
false を返します。
if( method_exists( $this, "onClose" ) )
$this->onClose( $id );
$this->sendDebugMessage( "ポート ".$this->clientInfo[$id][ 上の ".$this->clientInfo[$id]["host"] からの接続 ( ".$id." ) が閉じられました。" 「ポート」] );
@socket_close( $this->clientFD[$id] );
$this->clientFD[$id] = NULL;
unset( $this->clientInfo[$id] );
$this->clients--;
}
/**
* サーバーをシャットダウンします
*
* @アクセスパブリック
*/
関数 shutDown(){
if( $GLOBALS["_patServerStatus"] != "実行中" )
出口;
$GLOBALS["_patServerStatus"] = "停止";
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( "サーバーをシャットダウンします。" );
出口;
}
/**
* 現在のクライアント数を取得します
*
* @アクセスパブリック
* @return int $clients クライアントの数
*/
関数 getClients(){
$this->clients を返します。
}
/**
* クライアントにデータを送信する
*
* @アクセスパブリック
* @param int $clientId クライアントのID
* @param string $data 送信するデータ
* @param boolean ソケットに書き込まれるデータをデバッグ メッセージとしても送信する必要があるかどうかを示す $debugData フラグ
*/
function sendData( $clientId, $data, $debugData = true ){
if( !isset( $this->clientFD[$clientId] ) || $this->clientFD[$clientId] == NULL )
false を返します。
if( $debugData )
$this->sendDebugMessage( "送信中: "" . $data . "" 宛先: $clientId" );
if( !@socket_write ( $this->clientFD[$clientId], $data ) )
$this->sendDebugMessage( "「.$data."」クライアント「.$clientId」を書き込めませんでした。" ( ".$this->getLastSocketError( $this->clientFD[$clientId] )." )." ) ;
}
/**
* すべてのクライアントにデータを送信する
*
* @アクセスパブリック
* @param string $data 送信するデータ
* @param array $exclude 除外するクライアント ID
*/
関数ブロードキャストデータ( $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( "送信中: "" . $data . "" から: $i" );
if( !@socket_write ( $this->clientFD[$i], $data ) )
$this->sendDebugMessage( "「.$data."」クライアント ".$i." ( ".$this->getLastSocketError( $this->clientFD[$i] )." )." ) を書き込めませんでした。 ;
}
}
}
/**
* クライアントに関する現在の情報を取得する
*
* @アクセスパブリック
* @param int $clientId クライアントのID
* @return array $info クライアントに関する情報
*/
関数 getClientInfo( $clientId ){
if( !isset( $this->clientFD[$clientId] ) || $this->clientFD[$clientId] == NULL )
false を返します。
$this->clientInfo[$clientId]を返します;
}
/**
* デバッグメッセージを送信する
*
* @アクセス非公開
* @param string $msg デバッグするメッセージ
*/
関数 sendDebugMessage( $msg ){
if( !$this->デバッグ )
false を返します。
$msg = date( "Ymd H:i:s", time() ) . 「」。 $msg;
switch( $this->debugMode ){
「テキスト」の場合:
$msg = $msg."n";
壊す;
ケース「html」:
$msg = htmlspecialchars( $msg ) 。 "<br />n";
壊す;
if( $this->debugDest == "stdout" || empty( $this->debugDest ) )
{
$msg をエコー;
フラッシュ();
true を返します。
error_log( $msg, 3, $this->debugDest )
;
true を返します。
}
/**
* 最後のソケットエラーの文字列を返します
*
* @アクセスパブリック
* @return string $error 最後のエラー
*/
関数 getLastSocketError( &$fd ){
$lastError = ソケット_last_error( $fd );
"msg: " を返します。ソケット_strerror( $lastError ) 。 " / コード: ".$lastError;
}
関数 onReceiveData($ip,$data){
$this->broadcastData( $data,array(), true );
}
}
$patServer = 新しい patServer();
$patServer->start();
?>