Как создать сервер websockets в PHP


есть ли какие-либо учебники или руководства, показывающие, как написать себе простой сервер websockets в PHP? Я пробовал искать его в google, но я не нашел много. Я нашел phpwebsockets, но теперь он устарел и не поддерживает новейший протокол. Я попытался обновить его сам, но это, кажется, не работает.

#!/php -q
<?php  /*  >php -q server.php  */

error_reporting(E_ALL);
set_time_limit(0);
ob_implicit_flush();

$master  = WebSocket("localhost",12345);
$sockets = array($master);
$users   = array();
$debug   = false;

while(true){
  $changed = $sockets;
  socket_select($changed,$write=NULL,$except=NULL,NULL);
  foreach($changed as $socket){
    if($socket==$master){
      $client=socket_accept($master);
      if($client<0){ console("socket_accept() failed"); continue; }
      else{ connect($client); }
    }
    else{
      $bytes = @socket_recv($socket,$buffer,2048,0);
      if($bytes==0){ disconnect($socket); }
      else{
        $user = getuserbysocket($socket);
        if(!$user->handshake){ dohandshake($user,$buffer); }
        else{ process($user,$buffer); }
      }
    }
  }
}

//---------------------------------------------------------------
function process($user,$msg){
  $action = unwrap($msg);
  say("< ".$action);
  switch($action){
    case "hello" : send($user->socket,"hello human");                       break;
    case "hi"    : send($user->socket,"zup human");                         break;
    case "name"  : send($user->socket,"my name is Multivac, silly I know"); break;
    case "age"   : send($user->socket,"I am older than time itself");       break;
    case "date"  : send($user->socket,"today is ".date("Y.m.d"));           break;
    case "time"  : send($user->socket,"server time is ".date("H:i:s"));     break;
    case "thanks": send($user->socket,"you're welcome");                    break;
    case "bye"   : send($user->socket,"bye");                               break;
    default      : send($user->socket,$action." not understood");           break;
  }
}

function send($client,$msg){
  say("> ".$msg);
  $msg = wrap($msg);
  socket_write($client,$msg,strlen($msg));
}

function WebSocket($address,$port){
  $master=socket_create(AF_INET, SOCK_STREAM, SOL_TCP)     or die("socket_create() failed");
  socket_set_option($master, SOL_SOCKET, SO_REUSEADDR, 1)  or die("socket_option() failed");
  socket_bind($master, $address, $port)                    or die("socket_bind() failed");
  socket_listen($master,20)                                or die("socket_listen() failed");
  echo "Server Started : ".date('Y-m-d H:i:s')."n";
  echo "Master socket  : ".$master."n";
  echo "Listening on   : ".$address." port ".$port."nn";
  return $master;
}

function connect($socket){
  global $sockets,$users;
  $user = new User();
  $user->id = uniqid();
  $user->socket = $socket;
  array_push($users,$user);
  array_push($sockets,$socket);
  console($socket." CONNECTED!");
}

function disconnect($socket){
  global $sockets,$users;
  $found=null;
  $n=count($users);
  for($i=0;$i<$n;$i++){
    if($users[$i]->socket==$socket){ $found=$i; break; }
  }
  if(!is_null($found)){ array_splice($users,$found,1); }
  $index = array_search($socket,$sockets);
  socket_close($socket);
  console($socket." DISCONNECTED!");
  if($index>=0){ array_splice($sockets,$index,1); }
}

function dohandshake($user,$buffer){
  console("nRequesting handshake...");
  console($buffer);
  //list($resource,$host,$origin,$strkey1,$strkey2,$data) 
  list($resource,$host,$u,$c,$key,$protocol,$version,$origin,$data) = getheaders($buffer);
  console("Handshaking...");

    $acceptkey = base64_encode(sha1($key . "258EAFA5-E914-47DA-95CA-C5AB0DC85B11",true));
  $upgrade  = "HTTP/1.1 101 Switching ProtocolsrnUpgrade: websocketrnConnection: UpgradernSec-WebSocket-Accept: $acceptkeyrn";

  socket_write($user->socket,$upgrade,strlen($upgrade));
  $user->handshake=true;
  console($upgrade);
  console("Done handshaking...");
  return true;
}

function getheaders($req){
    $r=$h=$u=$c=$key=$protocol=$version=$o=$data=null;
    if(preg_match("/GET (.*) HTTP/"   ,$req,$match)){ $r=$match[1]; }
    if(preg_match("/Host: (.*)rn/"  ,$req,$match)){ $h=$match[1]; }
    if(preg_match("/Upgrade: (.*)rn/",$req,$match)){ $u=$match[1]; }
    if(preg_match("/Connection: (.*)rn/",$req,$match)){ $c=$match[1]; }
    if(preg_match("/Sec-WebSocket-Key: (.*)rn/",$req,$match)){ $key=$match[1]; }
    if(preg_match("/Sec-WebSocket-Protocol: (.*)rn/",$req,$match)){ $protocol=$match[1]; }
    if(preg_match("/Sec-WebSocket-Version: (.*)rn/",$req,$match)){ $version=$match[1]; }
    if(preg_match("/Origin: (.*)rn/",$req,$match)){ $o=$match[1]; }
    if(preg_match("/rn(.*?)$/",$req,$match)){ $data=$match[1]; }
    return array($r,$h,$u,$c,$key,$protocol,$version,$o,$data);
}

function getuserbysocket($socket){
  global $users;
  $found=null;
  foreach($users as $user){
    if($user->socket==$socket){ $found=$user; break; }
  }
  return $found;
}

function     say($msg=""){ echo $msg."n"; }
function    wrap($msg=""){ return chr(0).$msg.chr(255); }
function  unwrap($msg=""){ return substr($msg,1,strlen($msg)-2); }
function console($msg=""){ global $debug; if($debug){ echo $msg."n"; } }

class User{
  var $id;
  var $socket;
  var $handshake;
}

?>

и клиент:

var connection = new WebSocket('ws://localhost:12345');
connection.onopen = function () {
  connection.send('Ping'); // Send the message 'Ping' to the server
};

// Log errors
connection.onerror = function (error) {
  console.log('WebSocket Error ' + error);
};

// Log messages from the server
connection.onmessage = function (e) {
  console.log('Server: ' + e.data);
};

Если есть что-то не так в моем коде вы можете помочь мне это исправить? Конколь в firefox говорит Firefox can't establish a connection to the server at ws://localhost:12345/.

EDIT
Поскольку этот вопрос вызывает большой интерес, я решил предоставить вам то, что я, наконец, придумал. вот мой полный код.

5 63

5 ответов:

Я был в той же лодке, что и вы недавно, и вот что я сделал:

1) я использовал код phpwebsockets в качестве ссылки на то, как структурировать код на стороне сервера. (Вы, кажется, уже делаете это, и, как вы заметили, код на самом деле не работает по разным причинам.)

2) я использовал PHP.net чтобы прочитать подробную информацию о каждой функции сокета, используемой в коде phpwebsockets. Сделав это, я, наконец, смог понять, как вся система работает концептуально. Это было довольно большое препятствие.

3) я прочитал фактический проект WebSocket (пожалуйста, сделайте веб-поиск для него, так как я не могу разместить более двух ссылок на сообщение). Мне пришлось прочитать эту вещь много раз, прежде чем она, наконец, начала впитываться. Вероятно, вам придется возвращаться к этому документу снова и снова на протяжении всего процесса, так как это единственный окончательный ресурс с правильной, актуальной информацией об API WebSocket.

4) я закодировал правильную процедуру рукопожатия на основе инструкции в проекте в #3. Это не так уж плохо.

5) я продолжал получать кучу искаженного текста, отправленного от клиентов на сервер после рукопожатия, и я не мог понять, почему, пока не понял, что данные закодированы и должны быть разоблачены. Следующая ссылка очень помогла мне здесь: http://srchea.com/blog/2011/12/build-a-real-time-application-using-html5-websockets/

обратите внимание, что код доступен по этой ссылке имеет ряд проблемы и не будет работать должным образом без дальнейших изменений.

6) Затем я наткнулся на следующий поток SO, который четко объясняет, как правильно кодировать и декодировать сообщения, отправляемые туда и обратно:как я могу отправлять и получать сообщения WebSocket на стороне сервера?

эта ссылка была очень полезна. Я рекомендую проконсультироваться с ним, глядя на проект WebSocket. Это поможет сделать больше смысла из того, что говорит проект.

7) I на данный момент было почти сделано, но у меня были некоторые проблемы с приложением WebRTC, которое я делал с помощью WebSocket, поэтому я задал свой собственный вопрос о SO, который я в конечном итоге решил. Для ссылки на вопрос и ответ, пожалуйста, выполните веб-поиск "Итак, что это за данные в конце информации о кандидате WebRTC?"(без кавычек).

8) на данный момент, я в значительной степени все это работает. Мне просто нужно было добавить дополнительную логику для обработки закрытия соединений, и я был сделанный.

этот процесс занял у меня около двух недель. Хорошая новость заключается в том, что теперь я очень хорошо понимаю WebSocket, и я смог сделать свои собственные клиентские и серверные скрипты с нуля, которые отлично работают. Надеюсь, кульминация всей этой информации даст вам достаточно указаний и информации для кодирования вашего собственного PHP-скрипта WebSocket. Удачи вам!

Edit: это редактирование через пару лет после моего первоначального ответа, и пока у меня все еще есть работа решение, оно не совсем готово для обмена. К счастью, у кого-то еще на GitHub есть почти идентичный код для моего (но намного чище), поэтому я рекомендую использовать следующий код для рабочего PHP WebSocket solution:
https://github.com/ghedipunk/PHP-Websockets/blob/master/websockets.php

Edit #2: хотя мне все еще нравится использовать PHP для многих связанных с сервером вещей, я должен признать, что я действительно разогрелся до узла.js много в последнее время, и основная причина заключается в том, что он лучше разработан с нуля для обработки WebSocket, чем PHP (или любой другой серверный язык). Таким образом, я недавно обнаружил, что намного проще настроить как Apache/PHP, так и Node.js на вашем сервере и использовать узел.js для запуска сервера WebSocket и Apache / PHP для всего остального. И в случае, когда вы находитесь на общем хостинге, в котором вы не можете установить/использовать узел.js для WebSocket, вы можете использовать бесплатный сервис, как Heroku, чтобы настроить узел.js WebSocket server и сделать междоменные запросы к нему с вашего сервера. Просто убедитесь, что вы это делаете, чтобы настроить сервер WebSocket для обработки запросов кросс-происхождения.

насколько мне известно Храповой это лучшее решение PHP WebSocket, доступное на данный момент. И так как это open source вы можете увидеть, как автор построил это решение WebSocket с помощью PHP.

Почему бы не использовать сокеты http://uk1.php.net/manual/en/book.sockets.php ? Он хорошо документирован (не только в контексте PHP) и имеет хорошие примеры http://uk1.php.net/manual/en/sockets.examples.php

необходимо преобразовать ключ из hex в dec перед base64_encoding, а затем отправить его для рукопожатия.

$hashedKey = sha1($key. "258EAFA5-E914-47DA-95CA-C5AB0DC85B11",true);

$rawToken = "";
    for ($i = 0; $i < 20; $i++) {
      $rawToken .= chr(hexdec(substr($hashedKey,$i*2, 2)));
    }
$handshakeToken = base64_encode($rawToken) . "\r\n";

$handshakeResponse = "HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Accept: $handshakeToken\r\n";

Дайте мне знать, если это помогает.

<?php

// server.php

$server = stream_socket_server("tcp://127.0.0.1:8001", $errno, $errorMessage);

if($server == false) {
    throw new Exception("Could not bind to socket: $errorMessage");

}

for(;;) {
    $client = @stream_socket_accept($server);

    if($client) {
        stream_copy_to_stream($client, $client);
        fclose($client);
    }
}

из одного терминала запустите: php сервер.php

из другого терминала запустите: echo "hello woerld" | nc 127.0.0.1 8002