Viel Spass bei basteln

HINWEIS: Da der Server aktuell ständig weiterentwickelt wird habe ich ein Repository auf Github angelegt. Bitte den jeweils aktuelle Code verwenden: https://github.com/lemmingzshadow/php-websocket

UPDATE: As the project is constantly updated and improved I created a repository on github. Please get the code here: https://github.com/lemmingzshadow/php-websocket

Hier die Klasse + Beispielaufruf:

ACHTUNG: Eine aktuellere Version dieser Klasse gibt es hier: PHP Websocket Server/Client nach Draft hybi-10

/**
 * Very basic websocket client.
 * Supporting handshake from drafts:
 *	draft-hixie-thewebsocketprotocol-76
 *	draft-ietf-hybi-thewebsocketprotocol-00
 * 
 * @author Simon Samtleben <web@lemmingzshadow.net>
 * @version 2011-09-15
 */
 
class WebsocketClient
{
	private $_Socket = null;
 
	public function __construct($host, $port)
	{
		$this->_connect($host, $port);	
	}
 
	public function __destruct()
	{
		$this->_disconnect();
	}
 
	public function sendData($data)
	{
		// send actual data:
		fwrite($this->_Socket, "\x00" . $data . "\xff" ) or die('Error:' . $errno . ':' . $errstr); 
		$wsData = fread($this->_Socket, 2000);
		$retData = trim($wsData,"\x00\xff");        
		return $retData;
	}
 
	private function _connect($host, $port)
	{
		$key1 = $this->_generateRandomString(32);
		$key2 = $this->_generateRandomString(32);
		$key3 = $this->_generateRandomString(8, false, true);		
 
		$header = "GET /echo HTTP/1.1\r\n";
		$header.= "Upgrade: WebSocket\r\n";
		$header.= "Connection: Upgrade\r\n";
		$header.= "Host: ".$host.":".$port."\r\n";
		$header.= "Origin: http://foobar.com\r\n";
		$header.= "Sec-WebSocket-Key1: " . $key1 . "\r\n";
		$header.= "Sec-WebSocket-Key2: " . $key2 . "\r\n";
		$header.= "\r\n";
		$header.= $key3;
 
 
		$this->_Socket = fsockopen($host, $port, $errno, $errstr, 2); 
		fwrite($this->_Socket, $header) or die('Error: ' . $errno . ':' . $errstr); 
		$response = fread($this->_Socket, 2000);
 
		/**
		 * @todo: check response here. Currently not implemented cause "2 key handshake" is already deprecated.
		 * See: http://en.wikipedia.org/wiki/WebSocket#WebSocket_Protocol_Handshake
		 */		
 
		return true;
	}
 
	private function _disconnect()
	{
		fclose($this->_Socket);
	}
 
	private function _generateRandomString($length = 10, $addSpaces = true, $addNumbers = true)
	{  
		$characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"§$%&/()=[]{}';
		$useChars = array();
		// select some random chars:    
		for($i = 0; $i < $length; $i++)
		{
			$useChars[] = $characters[mt_rand(0, strlen($characters)-1)];
		}
		// add spaces and numbers:
		if($addSpaces === true)
		{
			array_push($useChars, ' ', ' ', ' ', ' ', ' ', ' ');
		}
		if($addNumbers === true)
		{
			array_push($useChars, rand(0,9), rand(0,9), rand(0,9));
		}
		shuffle($useChars);
		$randomString = trim(implode('', $useChars));
		$randomString = substr($randomString, 0, $length);
		return $randomString;
	}
}
 
$WebSocketClient = new WebsocketClient('127.0.0.1', 8000);
echo $WebSocketClient->sendData('1337');
unset($WebSocketClient);

Angenommen ich möchte Daten aus verschiedenen Quellen verwenden, dann kann bzw. wird es vorkommen, dass diese Daten unterschiedliche Formate haben. Ein ganz simples Beispiel:

Quelle A: 44793 Bochum – Sonnig – 19 Grad
Quelle B: 44793 Bochum – 19 Grad – Sonnig

Die gleichen Daten, aber ein andere Reihenfolge.
Wenn ich nun für jede Datenquelle einen reguläre Ausdruck verwende um die Daten zu teilen, hatte man früher oft folgendes Problem:

$string = "44793 Bochum - Sonnig - 19 Grad";
preg_match('/(.+)\s-\s(.+)\s-\s(.+)/', $string, $temp);

Bei diesem Code finde ich die Temperatur einmal in $temp[3] und einmal in $temp[2]. Somit müsste ich für jede Datenquelle zusätzlich speichern in welchem Feld welcher Wert liegt. Und genau hier kommen die benannten Suchmuster ins Spiel. Durch eine kleine Modifikation des regulären Ausdrucks kann man den Teilmustern Namen geben:

$string = "44793 Bochum - Sonnig - 19 Grad";
preg_match('/(?<ort>.+)\s-\s(?<descr>.+)\s-\s(?<temperatur>.+)/', $string, $temp);

ergibt dann:

Array
(
    [0] => 44793 Bochum - Sonnig - 19 Grad
    [ort] => 44793 Bochum
    [1] => 44793 Bochum
    [descr] => Sonnig
    [2] => Sonnig
    [temperatur] => 19 Grad
    [3] => 19 Grad
)

Keine Magie, aber ungemein hilfreich wenn man es noch nicht kennt

Vorher:

$iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_DEV_RANDOM);

Nacher:

$iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_DEV_URANDOM);

Gearman ist ein Jobserver und ermöglicht es Aufgaben auf verschiedene Prozesse und/oder Maschinen auszulagern. Dabei arbeitet man mit sogenannten “Workern” die auf einem beliebigen Server darauf warten Aufgaben zu erledigen. Besonders schön ist, dass diese Worker ebenfalls in PHP programmiert werden können. Zunächst jedoch ein paar Worte zur Installation.

Auf einem Debian Squeeze System ist die Installation denkbar einfach. Einfach den Jobserver via Aptitude oder apt-get installieren. Das Paket heisst “gearman”. Im init.d Ordner liegt dann auch direkt ein Script mit dem der Server gestartet werden kann:

/etc/init.d/gearman-job-server start

Um den Gearman Server in PHP “ansprechen” zu können benötigt man nun noch die Gearman-Extension welche über PECL installiert werden kann.
Hinweis: Es wird das Paket “php5-dev” benötigt. Falls dieses noch nicht installiert ist sollte man das an dieser Stelle tun.

Dann die PHP-Extenstion über PECL installieren:

pecl install gearman

Hinweis: Falls das Paket hier nicht installiert werden kann weil es eine Beta Version ist, stattdessen folgenden Befehl verwenden:

pecl install gearman-beta

Damit sollte die Extension erstellt sein und kann in der php.ini geladen werden. Dazu einfache folgendes in der php.ini ergänzen:

extension = gearman.so

Hinweis: Da die Worker normalerweise als CLI-Programme laufen, die entsprechende php.ini nicht vergessen.

Nun sollte alles soweit sein, dass Gearman verwendet werden kann.

Zunächst brauchen wir einen Worker welcher im Hintergrund läuft und darauf wartet Aufgaben zu erledigen. Hier ein Beispiel:

<?php
class WorkerExample
{
	private $_GearmanWorker = null;
 
	public function  __construct()
	{
		$this->_GearmanWorker = new GearmanWorker;
		$this->_GearmanWorker->addServer('127.0.0.1', 4730);
 
		$this->_startupWorker();
	}
 
	private function _startupWorker()
	{
		$this->_GearmanWorker->addFunction('foobar', array($this, 'foobar'));
		while($this->_GearmanWorker->work());
	}
 
	public function foobar($Job)
	{
		$params = array();
		$params = unserialize($Job->workload());
 
		// do some work here...
		var_dump($params);
	}
}
 
$Worker = new WorkerExample;

Diesen Worker kann man nun z.B. als worker.php speichern und dann zum testen in einem Screen laufen lassen:

php worker.php

Nun brauchen wir noch ein Script welches diesen Worker aufruft, der sogenannte Client:

<?php
$Client = new GearmanClient();
$Client->addServer('127.0.0.1', 4730);
 
$data = array(
	'foo' => 42,
	'bar' => 1337
);
$data = serialize($data);
$Client->doBackground('foobar', $data);

Wenn nun dieser Client aufgerufen wird sollte man in dem Screen in dem der Worker läuft eine Ausgabe der übergebenen Parameter sehen.
Im Code sieht man sofort dass die IP des Servers auf dem Gearman läuft angegeben wird. Hier kann natürlich auch ein anderer Server als localhost benutzt werden. Mit “doBackground” wird der Worker aufgerufen und das Script läuft direkt weiter ohne auf irgendeine Antwort des Workers zu warten.

Über die vielen weiteren Möglichkeiten des Gearman-Servers kann man sich am besten informieren wenn man einen Blick auf die Methoden der Gearman-Extension auf php.net wirft. Und nun viel Spass beim experimentieren.

Eine sftp-upload Funktion könnte beispielsweise so aussehen:

public function sftp_putfile($local_file, $remote_file, $mode = 0664)
{
	$remote_file = (substr($remote_file, 0, 1) != '/') ? '/' . $remote_file : $remote_file;
	$sftp_stream = fopen('ssh2.sftp://' . $this->sftp_connection . $remote_file, 'w');
 
	if(!$sftp_stream)
	{
		$this->set_sftp_error(7);
		return false;
	}
 
	$data_to_send = file_get_contents($local_file);
 
	if ($data_to_send === false)
	{
		$this->set_sftp_error(7);
		return false;
	}
 
	if(fwrite($sftp_stream, $data_to_send) === false)
	{
		$this->set_sftp_error(7);
		return false;
	}
	fclose($sftp_stream);
	return true;
}

Diese beispielhafte Methode stammt aus einer SFTP Klasse die ich vor kurzem für eine Projekt geschrieben habe. Die komplette Klasse habe ich hier zum download hinterlegt.

Da es mittlerweile schon einige PHP Klassen gibt welche oAuth unterstützen ist die Umstellung relativ einfach zu bewerkstelligen. Hier ein kleines Tutorial:

Zunächst muss man auf http://dev.twitter.com/ eine neue “App” anlegen. (Vorher einloggen) Der Prozess ist selbsterklärend. Nachdem man die App angelegt hat erhält man einen “Consumer key” und ein “Consumer secret”. Diese beiden Strings benötigen wir später für die Authentifizierung. Weiterhin braucht man den “oAuth Token” und das “oAuth Token Secret”. Um diese zu bekommen oben auf Your apps klicken. Dann auf “Edit Details” der entsprechen App. Nach zwei weiteren Klicks auf “Application detail” (rechts) und “My Access Token” (auch rechts) hat man alle benötigten Tokens und Passwörter zusammen die man in einem PHP-Script benötigt.

Nun kann man entweder selbst damit anfangen eine oAuth Authentifizierung zu coden oder man benutzt eine der fertigen Klassen. Ich habe für dieses Beispiel eine fertige oAuth Klasse von Abraham Williams benutzt.
Hier ein kleines Codebeispiel für die Authentifizierung mit oAuth und dem anschließenden posten eines Tweets:

$consumer_key = 'insert_key';
$consumer_secret = 'insert_secret';
$access_key = 'insert_key';
$access_secret = 'insert_secret';
 
require_once('twitteroauth/twitteroauth.php');
 
$twitter = new TwitterOAuth ($consumer_key, $consumer_secret, $access_key, $access_secret);
$twitter->post('statuses/update', array('status' => 'Testing oAuth. Please ignore...'));

1

echo date(DATE_COOKIE, time());

Alle dieser nützlichen Konstanten sind hier dokumentiert: Datumskonstanten bei php.net

Um zu prüfen ob ein Feld in einem Array existiert ohne dabei Fehlermeldungen zu erzeugen muss vor beiden Funktionen isset und is_array aufgerufen werden.

Beispiel:

1
2
3
4

if(isset($foo) && is_array($foo) && isset($foo['bar']))
{
	$check = true;
}

1
2
3
4

if(isset($foo) && is_array($foo) && array_key_exists('bar', $foo))
{
	$check = true;
}

Der Grund hierfür ist nicht immer direkt ersichtlich, deswegen hier die Erklärung:
isset erzeugt zwar keine Notices oder Warnings falls die Variable $foo nicht gesetzt ist, aber es gibt ein anderes Problem. Wenn die Variable $foo vom Typ String ist würde die Prüfung auf ein Array-Feld mit isset true liefern.

Beispiel:

1
2

$foo = 'bar';
var_dump(isset($foo['bar'])); // true

Dieses Verhalten erklärt die Notwendigkeit von is_array vor dem Prüfen mit isset. Das isset vor dem is_array ist schließlich notwendig weil is_array eine Notice erzeugt wenn die zu prüfende Variable nicht gesetzt ist.

Die Funktion array_key_exists erzeugt ein Warning falls das zu prüfende Array nicht existiert oder die übergebene Variable nicht vom Typ Array ist. Somit ist hier ebenfalls die Nutzung von is_array in Kombination mit isset zu empfehlen.

Mit obiger Syntax lässt sich nun eigentlich in beide Fällen prüfen ob ein Feld im einem Array existiert. Dabei ist jedoch eine Ausnahme zu beachten, und zwar der Wert null in einem Array.

Beispiel:

1
2
3

$foo['bar'] = null;
var_dump(isset($foo['bar'])); // false
var_dump(array_key_exists('bar', $foo)); // true

Damit sollte die Verwendung der beiden Funktionen geklärt sein (falls nicht bitte ich um einen kurzen Kommentar), aber es bleibt die Frage: Welche der beiden Varianten ist schneller, isset oder array_key_exists?
Hier das Ergebnis:

Klare Sache: isset ist wesentlich schneller als array_key_exists, 10000 Prüfungen dauert nur etwa halb so lange.
Zudem fallen zwei weitere Dinge auf: isset taucht nicht in den Xdebug Ergebnissen auf. Die Begründung ist relativ simpel. Da isset keine Funktion ist sondern lediglich ein Sprachkonstrukt, taucht dieses nicht in den Xdebug-Listings auf. Weiterhin fällt auf, dass is_array fast genauso viel Zeit in Anspruch nimmt wie array_key_exists. Hierfür habe ich leider keine Erklärung, denn ich hätte erwarten dass array_key_exists im Gegensatz zu is_array eine Array-Funktion und damit wesentlich langsamer ist. Falls jemand eine Erklärung hat: Immer her damit!

1
2
3
4

if(stripos($haystack, $needle) !== false)
{
	$found = true;
}

1
2
3
4

if(preg_match('/'.$needle.'/is', $haystack) == 1)
{
	$found = true;
}

Hierbei wird eine Sache schnell klar: Bei mehr als einem Suchsting wird das ganze etwas komplizierter. Man muss die strpos Variante für jeden Suchstring einmal laufen lassen, bzw. in der zweiten Variante die Suchstrings mit einem oder verknüpfen.
Die Frage ist nun: Welche der beiden Varianten ist schneller?

Ich habe ein kurzes Testscript gebastelt, und hier ist das Ergebnis:

Die preg_match Varinate ist um einiges schneller. Ausserdem fällt auf das bei 10000 Durchläufen des Testscript die Funktion stripos öfter als 10000 mal ausgeführt wird. Die liegt daran, dass die Funktion so oft aufgerufen werden muss, bis der erste Suchstring gefunden wurde (oder eben keiner der gesuchten Strings im Text vorkommt). Durch die oder-Verknüpfung der einzelnen Strings muss preg_match bei jedem Durchlauf nur einmal ausgeführt werden.
Klar wird also: Je mehr Suchstrings in einem Text gesucht werden sollen, desto langsamer wird die strpos Variante im Vergleich zu preg_match, obwohl natürlich auch der reguläre Ausdruck bei einem längeren Suchstring etwas langsamer wird.

Zum Schluss noch das Script mit dem ich dieses Verhalten getestet habe:
performance_preg_vs_strpos.php