Kina is simple multithreaded web server with plugin support, which always keep alive tcp connection and wait until client say goodbye.
Best way to use Kina is for fast sending small HTTP response, she now can not send response which is to big for ram, because you have to return response at once and implementation of HTTP protocol is basic.
I try make Kina was for best performence and stable, but she can have some mistakes. I be glad, if someone found bug help me fix it, but if you do not understand multitread programing or socket handling, please do not push fork button.
Development version
git clone git@github.com:Triplkrypl/Kina.gitKina have composer support for instaling plugins, more information here: https://github.com/Triplkrypl/Kina-Base-Vhost. After download Kina you can install test Base Vhost.
composer installPhp thread save interpreter runable as "php" command
Php pthreads extension
Install
pecl install pthreadsInstall on php 5.6 and older
pecl install pthreads-2.0.10./runServer configuration file "config.json" is generated in same folder (for some fanatic "directory") as run file if not exists.
{
"#": "Key start with '#' is comment",
"#ports": "List of listen TCP ports, default value [80]",
"ports": [80],
"#max_connection": "Maximum TCP connection per listen port, default value 100000",
"max_connection": 100000,
"#keep_alive_connection_time_out": "Time for client how long he will keep TCP connection open (in minutes), default value 20",
"keep_alive_connection_time_out": 20,
"#directory_file_list": "If is request for directory default method 'onNoPhpRequest' will return on true value list of file and directory, default value false",
"directory_file_list": true,
"#directory_index": "If is request for directory and directory_file_list is false default method 'onNoPhpRequest' try load content of file directory_index, default value index.html",
"directory_index": "index.html",
"#vhost_select0": "Setup selection method for vhost, values config self auto, default value config",
"#vhost_select1": "config will select vhost by vhost_map kay",
"#vhost_select2": "auto will transform host name on vhost name",
"#vhost_select3": "self will call vhost method 'onVhostChoise' if vhost handle request",
"vhost_select": "config",
"#vhost_map": "Object with regex rules for vhots selection, property name is regex and value is vhost name, default value {}",
"vhost_map": {},
"#console": "Setup loging messages to console and enable or disable console input, default value true",
"#console!": "Setup this option to false if you use './run &' Kina will not try read from broken stream",
"console": true,
"#default_timezone": "You can set value for function: date_default_timezone_set if is not set in php.ini, default value not exists",
"default_timezone": "Europe/Prague"
}All plugins code is loaded from plugin folder and class is loaded by "PSR-0" standart, You can not it change and if you do not use this standart, you dig your grave, kill yourself and bury yourself in afterlife. You can use "require" or "include" but it is much worse!
Example basic plugin
<?php
namespace Test; //Namespace define name of plugin
class Plugin extends \Plugin{ //Main class have to extends "Plugin" class and have to have name "Plugin"
public function onLoad(){
}
public function onExit(){
}
}Example Base vhost
<?php
namespace Base; //Vhost with name "Base" have to be defined!
class Vhost extends \Vhost{ //Main vhost class have same rule as main plugin class, but vhost have more callback and can listen on network
public function onLoad(){
}
public function onExit(){
}
/**
* @param \Client\Client $client
* @param \Server\Request $request
* @return \Server\Response|null
*/
public function onPhpRequest(\Client\Client $client,\Server\Request $request){
return null;
}
}All plugins extends \Threaded class. Method and properties plugin object have diferent behaviors than other objects. If you manipulating with big struture store in property of plugin mainly if you write into property use methods lock and unlock for create transaction on object. Because with plugin objects can working more then one thread if http request is processed. Read documentation about pthread library for more informations http://php.net/manual/en/book.pthreads.php.
Example simple transaction on \Threated object
$this->lock(); //prevent from access to object
$some_object = $this->some_object; //get copy of object into local thread
$some_object->setSomeThing($some_thing);//do some code
$this->some_object = $some_object; //set new data to shared heap for all thread
$this->unlock(); //alow every one read or writeThis methotds alow you change or get some data in aplication. Mainly are final and can not be changed.
/**
* available in \Plugin,\Vhost
* methotd alow you write row in to server log file
*
* @param string $message
* @param string $log_type
*/
final protected function serverLog($message,$log_type = "");/**
* available in \Plugin,\Vhost
* methotd will log exception into server log file as one row, you can add some message before exception message
*
* @param string $add_message
* @param \Exception $e
* @param string $log_type
*/
final protected function serverLogException($add_message,\Exception $e,$log_type = "");/**
* available in \Plugin,\Vhost
* methotd provides object with server configuration
*
* @return \Server\Config
*/
final protected function getServerConfig();/**
* available in \Plugin,\Vhost
* return apsolute path where plugin can store own files, this folder is auto created in data folder
*
* @return string
*/
final protected function getDataDir();/**
* available in \Plugin,\Vhost
* method return instance of loaded plugin in server by name, this method will not return Vhost
*
* @param string $plugin_name
* @return \Plugin|null
*/
final protected function getPlugin($plugin_name);/**
* available in \Plugin,\Vhost
* method set plugins which haveto successfull load before this plugin
* vhost can be dependent on plugin but on vhost no one can be dependent
*
* @return \Plugin\Dependence[]
*/
public function getDependence();/**
* available in \Plugin,\Vhost in vhost is useless, but extends is extends
* you can say server application version of your plugin and version dependence on this plugin will work
* version string example "0.0.0"
*
* @return null|string
*/
public function getVersion();/**
* available in \Vhost
* method format http status code and define how status code look like in http data
*
* @param int $http_code
* @return \Server\Response
*/
public function getResponseError($http_code);/**
* available in \Vhost
* method called in default onNoPhpRequest if requested path is folder
*
* @param \Server\Request $request
* @param string $static_data_dir
* @return null|\Server\Response
*/
protected function getDirectoryContent(\Server\Request $request,$static_data_dir);/**
* available in \Vhost
* method called in default getDirectoryContent return response with formated list of file and folder
*
* @param \Server\Request $request
* @param string $static_data_dir
* @return \Server\Response
*/
protected function getFileInDirectory(\Server\Request $request,$static_data_dir);/**
* available in \Vhost
* metohod called in default getDirectoryContent return response with folder index file
*
* @param string $static_data_dir
* @return null|\Server\Response
*/
protected function getIndexInDirectory($static_data_dir);/**
* available in \Plugin,\Vhost
* if you want use some console comand you have to reqistred it
*
* @param \Console\Command $command
*/
final protected function registerCommand(\Console\Command $command);/**
* available in \Plugin,\Vhost
* method remove command from server application
*
* @param string $command_name
*/
final protected function removeCommand($command_name);/**
* available in \Plugin,\Vhost
* return name of plugin
*
* @return string
*/
final public function getName();If you want catch some callback just override default method in \Plugin or \Vhost.
/**
* called in \Plugin,\Vhost, not multi thread
* callback is called if server starting and loading all plugins in to memory
* you can here inicialized plugin properties, load configuration, ...
*/
public function onLoad();/**
* called in \Plugin,\Vhost, not multi thread (all childres is dead before this call)
* callback is called before plugin dealocation if server stop
* you can here store data into file before server aplication end or clean memory and close open connections
*/
public function onExit();/**
* called in \Plugin,\Vhost, multi thread
* callback is called when registered command is input in console
*
* @param string $command
* @param string[] $params
* @param string $raw_string
*/
public function onConsoleCommand($command,array $params,$raw_string);/**
* called in \Vhost multi thread
* callback is called if new tcp connection is accepted
*
* @param \Client\Client $client
*/
public function onClientConnect(\Client\Client $client);/**
* called in \Vhost multi thread
* callback is called if tcp client disconnet
*
* @param \Client\Client $client
*/
public function onClientDisconnect(\Client\Client $client);/**
* called in \Vhost multi thread
* callback is called if vhost can deside if will handle request or hands over work other vhost
* this callback call depends on server config
*
* @param \Server\Request $request
* @return bool
*/
public function onVhostChoise(\Server\Request $request);/**
* called in \Vhost multi thread
* callback is called before request submitted for processing
* if return true onPhpRequest is called else onNoPhpRequest is called
*
* @param \Server\Request $request
* @return bool
*/
public function onPhpRequestChoice(\Server\Request $request);/**
* called in \Vhost multi thread
* callback is called if Vhost mark request as "php" and vhost code have to handle it
*
* @param \Client\Client $client
* @param \Server\Request $request
* @return \Server\Response|null
*/
public function onPhpRequest(\Client\Client $client,\Server\Request $request);/**
* called in \Vhost multi thread
* callback is called if Vhost mark request as "static" and vhost as default
* return file from plugin base folder."/static" this folder is auto
* created on first try load vhost
* if you do not need change this just put your css, html, js in static folder.
*
* @param \Client\Client $client
* @param \Server\Request $request
* @return null|\Server\Response
*/
public function onNoPhpRequest(\Client\Client $client,\Server\Request $request);