From e0c115db329a1069283e9df56df67df2ac64b97f Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Mon, 10 Dec 2012 21:02:50 -0800 Subject: [PATCH 1/8] Refactor forking code into Resque_JobStrategy_Interface --- lib/Resque/JobStrategy/Fork.php | 106 +++++++++++++++++++++++++++ lib/Resque/JobStrategy/InProcess.php | 48 ++++++++++++ lib/Resque/JobStrategy/Interface.php | 31 ++++++++ lib/Resque/Worker.php | 70 +++++------------- 4 files changed, 205 insertions(+), 50 deletions(-) create mode 100644 lib/Resque/JobStrategy/Fork.php create mode 100644 lib/Resque/JobStrategy/InProcess.php create mode 100644 lib/Resque/JobStrategy/Interface.php diff --git a/lib/Resque/JobStrategy/Fork.php b/lib/Resque/JobStrategy/Fork.php new file mode 100644 index 00000000..a2143765 --- /dev/null +++ b/lib/Resque/JobStrategy/Fork.php @@ -0,0 +1,106 @@ + + * @author Erik Bernharsdon + * @license http://www.opensource.org/licenses/mit-license.php + */ +class Resque_JobStrategy_Fork extends Resque_JobStrategy_InProcess +{ + /** + * @param int|null 0 for the forked child, the PID of the child for the parent, or null if no child. + */ + protected $child; + + /** + * @param Resque_Worker Instance of Resque_Worker that is starting jobs + */ + protected $worker; + + /** + * Set the Resque_Worker instance + * + * @param Resque_Worker $worker + */ + public function setWorker(Resque_Worker $worker) + { + $this->worker = $worker; + } + + /** + * Seperate the job from the worker via pcntl_fork + * + * @param Resque_Job $job + */ + public function perform(Resque_Job $job) + { + $this->child = $this->fork(); + + // Forked and we're the child. Run the job. + if ($this->child === 0) { + parent::perform($job); + exit(0); + } + + // Parent process, sit and wait + if($this->child > 0) { + $status = 'Forked ' . $this->child . ' at ' . strftime('%F %T'); + $this->worker->updateProcLine($status); + $this->worker->log($status, Resque_Worker::LOG_VERBOSE); + + // Wait until the child process finishes before continuing + pcntl_wait($status); + $exitStatus = pcntl_wexitstatus($status); + if($exitStatus !== 0) { + $job->fail(new Resque_Job_DirtyExitException( + 'Job exited with exit code ' . $exitStatus + )); + } + } + + $this->child = null; + } + + /** + * Force an immediate shutdown of the worker, killing any child jobs + * currently working + */ + public function shutdown() + { + if (!$this->child) { + $this->worker->log('No child to kill.', Resque_Worker::LOG_VERBOSE); + return; + } + + $this->worker->log('Killing child at '.$this->child, Resque_Worker::LOG_VERBOSE); + if(exec('ps -o pid,state -p ' . $this->child, $output, $returnCode) && $returnCode != 1) { + $this->worker->log('Killing child at ' . $this->child, Resque_Worker::LOG_VERBOSE); + posix_kill($this->child, SIGKILL); + $this->child = null; + } + else { + $this->worker->log('Child ' . $this->child . ' not found, restarting.', Resque_Worker::LOG_VERBOSE); + $this->worker->shutdown(); + } + } + + /** + * Attempt to fork a child process from the parent to run a job in. + * + * Return values are those of pcntl_fork(). + * + * @return int 0 for the forked child, or the PID of the child for the parent. + * @throws RuntimeException When pcntl_fork returns -1 + */ + private function fork() + { + $pid = pcntl_fork(); + if($pid === -1) { + throw new RuntimeException('Unable to fork child worker.'); + } + + return $pid; + } +} diff --git a/lib/Resque/JobStrategy/InProcess.php b/lib/Resque/JobStrategy/InProcess.php new file mode 100644 index 00000000..68bbe740 --- /dev/null +++ b/lib/Resque/JobStrategy/InProcess.php @@ -0,0 +1,48 @@ + + * @author Erik Bernharsdon + * @license http://www.opensource.org/licenses/mit-license.php + */ +class Resque_JobStrategy_InProcess implements Resque_JobStrategy_Interface +{ + /** + * @param Resque_Worker Instance of Resque_Worker that is starting jobs + */ + protected $worker; + + /** + * Set the Resque_Worker instance + * + * @param Resque_Worker $worker + */ + public function setWorker(Resque_Worker $worker) + { + $this->worker = $worker; + } + + /** + * Run the job in the worker process + * + * @param Resque_Job $job + */ + public function perform(Resque_Job $job) + { + $status = 'Processing ' . $job->queue . ' since ' . strftime('%F %T'); + $this->worker->updateProcLine($status); + $this->worker->log($status, Resque_Worker::LOG_VERBOSE); + $this->worker->perform($job); + } + + /** + * Force an immediate shutdown of the worker, killing any child jobs + * currently working + */ + public function shutdown() + { + $this->worker->log('No child to kill.', Resque_Worker::LOG_VERBOSE); + } +} diff --git a/lib/Resque/JobStrategy/Interface.php b/lib/Resque/JobStrategy/Interface.php new file mode 100644 index 00000000..aa547363 --- /dev/null +++ b/lib/Resque/JobStrategy/Interface.php @@ -0,0 +1,31 @@ + + * @author Erik Bernharsdon + * @license http://www.opensource.org/licenses/mit-license.php + */ +interface Resque_JobStrategy_Interface +{ + /** + * Set the Resque_Worker instance + * + * @param Resque_Worker $worker + */ + function setWorker(Resque_Worker $worker); + + /** + * Seperates the job execution context from the worker and calls $worker->perform($job). + * + * @param Resque_Job $job + */ + function perform(Resque_Job $job); + + /** + * Force an immediate shutdown of the worker, killing any child jobs + * currently working + */ + function shutdown(); +} diff --git a/lib/Resque/Worker.php b/lib/Resque/Worker.php index 5dc678df..9edbf2c9 100644 --- a/lib/Resque/Worker.php +++ b/lib/Resque/Worker.php @@ -48,11 +48,6 @@ class Resque_Worker */ private $currentJob = null; - /** - * @var int Process ID of child worker processes. - */ - private $child = null; - /** * Return all workers known to Resque as instantiated instances. * @return array @@ -137,6 +132,23 @@ public function __construct($queues) } $this->hostname = $hostname; $this->id = $this->hostname . ':'.getmypid() . ':' . implode(',', $this->queues); + + if (function_exists('pcntl_fork')) { + $this->setJobStrategy(new Resque_JobStrategy_Fork); + } else { + $this->setJobStrategy(new Resque_JobStrategy_InProcess); + } + } + + /** + * Set the JobStrategy used to seperate the job execution context from the worker + * + * @param Resque_JobStrategy_Interface + */ + public function setJobStrategy(Resque_JobStrategy_Interface $jobStrategy) + { + $this->jobStrategy = $jobStrategy; + $this->jobStrategy->setWorker($this); } /** @@ -184,36 +196,8 @@ public function work($interval = 5) Resque_Event::trigger('beforeFork', $job); $this->workingOn($job); - $this->child = Resque::fork(); + $this->jobStrategy->perform($job); - // Forked and we're the child. Run the job. - if ($this->child === 0 || $this->child === false) { - $status = 'Processing ' . $job->queue . ' since ' . strftime('%F %T'); - $this->updateProcLine($status); - $this->log($status, self::LOG_VERBOSE); - $this->perform($job); - if ($this->child === 0) { - exit(0); - } - } - - if($this->child > 0) { - // Parent process, sit and wait - $status = 'Forked ' . $this->child . ' at ' . strftime('%F %T'); - $this->updateProcLine($status); - $this->log($status, self::LOG_VERBOSE); - - // Wait until the child process finishes before continuing - pcntl_wait($status); - $exitStatus = pcntl_wexitstatus($status); - if($exitStatus !== 0) { - $job->fail(new Resque_Job_DirtyExitException( - 'Job exited with exit code ' . $exitStatus - )); - } - } - - $this->child = null; $this->doneWorking(); } @@ -304,7 +288,7 @@ private function startup() * * @param string $status The updated process title. */ - private function updateProcLine($status) + public function updateProcLine($status) { if(function_exists('setproctitle')) { setproctitle('resque-' . Resque::VERSION . ': ' . $status); @@ -391,21 +375,7 @@ public function shutdownNow() */ public function killChild() { - if(!$this->child) { - $this->log('No child to kill.', self::LOG_VERBOSE); - return; - } - - $this->log('Killing child at ' . $this->child, self::LOG_VERBOSE); - if(exec('ps -o pid,state -p ' . $this->child, $output, $returnCode) && $returnCode != 1) { - $this->log('Killing child at ' . $this->child, self::LOG_VERBOSE); - posix_kill($this->child, SIGKILL); - $this->child = null; - } - else { - $this->log('Child ' . $this->child . ' not found, restarting.', self::LOG_VERBOSE); - $this->shutdown(); - } + $this->jobStrategy->shutdown(); } /** From 39cd229f3450acce92e3d7e37bd11a32d7c2d2a7 Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Sat, 12 Jan 2013 22:56:21 -0800 Subject: [PATCH 2/8] Import FCGIClient by Preetam Jinka https://github.com/PreetamJinka/BitTP/blob/master/src/FCGIClient.php --- lib/BitTP/FCGIClient.php | 428 +++++++++++++++++++++++++++++++++ lib/BitTP/LICENSE | 502 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 930 insertions(+) create mode 100644 lib/BitTP/FCGIClient.php create mode 100644 lib/BitTP/LICENSE diff --git a/lib/BitTP/FCGIClient.php b/lib/BitTP/FCGIClient.php new file mode 100644 index 00000000..ccea8c54 --- /dev/null +++ b/lib/BitTP/FCGIClient.php @@ -0,0 +1,428 @@ + + * @author Daniel Aharon + * @version 2.0 + */ + class FCGIClient + { + const VERSION_1 = 1; + + const BEGIN_REQUEST = 1; + const ABORT_REQUEST = 2; + const END_REQUEST = 3; + const PARAMS = 4; + const STDIN = 5; + const STDOUT = 6; + const STDERR = 7; + const DATA = 8; + const GET_VALUES = 9; + const GET_VALUES_RESULT = 10; + const UNKNOWN_TYPE = 11; + const MAXTYPE = self::UNKNOWN_TYPE; + + const RESPONDER = 1; + const AUTHORIZER = 2; + const FILTER = 3; + + const REQUEST_COMPLETE = 0; + const CANT_MPX_CONN = 1; + const OVERLOADED = 2; + const UNKNOWN_ROLE = 3; + + const MAX_CONNS = 'MAX_CONNS'; + const MAX_REQS = 'MAX_REQS'; + const MPXS_CONNS = 'MPXS_CONNS'; + + const HEADER_LEN = 8; + + /** + * Socket + * @var Resource + */ + private $_sock = null; + + /** + * Host + * @var String + */ + private $_host = null; + + /** + * Port + * @var Integer + */ + private $_port = null; + + /** + * Keep Alive + * @var Boolean + */ + private $_keepAlive = false; + + /** + * A request has been sent. + * @var Boolean + */ + private $_awaitingResponse = false; + + /** + * Constructor + * + * @param String $host Host of the FastCGI application + * @param Integer $port Port of the FastCGI application + */ + public function __construct($host, $port) + { + $this->_host = $host; + $this->_port = $port; + } + + /** + * Destructor + */ + public function __destruct() { + socket_close($this->_sock); + } + + /** + * Define whether or not the FastCGI application should keep the connection + * alive at the end of a request + * + * @param Boolean $b true if the connection should stay alive, false otherwise + */ + public function setKeepAlive($b) + { + $this->_keepAlive = (boolean)$b; + if (!$this->_keepAlive && $this->_sock) { + socket_close($this->_sock); + } + } + + /** + * Get the keep alive status + * + * @return Boolean true if the connection should stay alive, false otherwise + */ + public function getKeepAlive() + { + return $this->_keepAlive; + } + + /** + * Create a connection to the FastCGI application + */ + private function connect() + { + if (!$this->_sock) { + + $this->_sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); + socket_set_nonblock($this->_sock); + @socket_connect($this->_sock, $this->_host, $this->_port); // Block the "Operation now in progress" warning. + + if (!$this->_sock) { + throw new \Exception( + 'Unable to connect to FastCGI application - ' . + socket_strerror(socket_last_error($this->_sock)) + ); + } + } + } + + /** + * Build a FastCGI packet + * + * @param Integer $type Type of the packet + * @param String $content Content of the packet + * @param Integer $requestId RequestId + */ + private function buildPacket($type, $content, $requestId = 1) + { + $clen = strlen($content); + return chr(self::VERSION_1) /* version */ + . chr($type) /* type */ + . chr(($requestId >> 8) & 0xFF) /* requestIdB1 */ + . chr($requestId & 0xFF) /* requestIdB0 */ + . chr(($clen >> 8 ) & 0xFF) /* contentLengthB1 */ + . chr($clen & 0xFF) /* contentLengthB0 */ + . chr(0) /* paddingLength */ + . chr(0) /* reserved */ + . $content; /* content */ + } + + /** + * Build an FastCGI Name value pair + * + * @param String $name Name + * @param String $value Value + * @return String FastCGI Name value pair + */ + private function buildNvpair($name, $value) + { + $nlen = strlen($name); + $vlen = strlen($value); + if ($nlen < 128) { + /* nameLengthB0 */ + $nvpair = chr($nlen); + } else { + /* nameLengthB3 & nameLengthB2 & nameLengthB1 & nameLengthB0 */ + $nvpair = chr(($nlen >> 24) | 0x80) . chr(($nlen >> 16) & 0xFF) . chr(($nlen >> 8) & 0xFF) . chr($nlen & 0xFF); + } + if ($vlen < 128) { + /* valueLengthB0 */ + $nvpair .= chr($vlen); + } else { + /* valueLengthB3 & valueLengthB2 & valueLengthB1 & valueLengthB0 */ + $nvpair .= chr(($vlen >> 24) | 0x80) . chr(($vlen >> 16) & 0xFF) . chr(($vlen >> 8) & 0xFF) . chr($vlen & 0xFF); + } + /* nameData & valueData */ + return $nvpair . $name . $value; + } + + /** + * Read a set of FastCGI Name value pairs + * + * @param String $data Data containing the set of FastCGI NVPair + * @return array of NVPair + */ + private function readNvpair($data, $length = null) + { + $array = array(); + + if ($length === null) { + $length = strlen($data); + } + + $p = 0; + + while ($p != $length) { + + $nlen = ord($data{$p++}); + if ($nlen >= 128) { + $nlen = ($nlen & 0x7F << 24); + $nlen |= (ord($data{$p++}) << 16); + $nlen |= (ord($data{$p++}) << 8); + $nlen |= (ord($data{$p++})); + } + $vlen = ord($data{$p++}); + if ($vlen >= 128) { + $vlen = ($nlen & 0x7F << 24); + $vlen |= (ord($data{$p++}) << 16); + $vlen |= (ord($data{$p++}) << 8); + $vlen |= (ord($data{$p++})); + } + $array[substr($data, $p, $nlen)] = substr($data, $p+$nlen, $vlen); + $p += ($nlen + $vlen); + } + + return $array; + } + + /** + * Decode a FastCGI Packet + * + * @param String $data String containing all the packet + * @return array + */ + private function decodePacketHeader($data) + { + $ret = array(); + $ret['version'] = ord($data{0}); + $ret['type'] = ord($data{1}); + $ret['requestId'] = (ord($data{2}) << 8) + ord($data{3}); + $ret['contentLength'] = (ord($data{4}) << 8) + ord($data{5}); + $ret['paddingLength'] = ord($data{6}); + $ret['reserved'] = ord($data{7}); + return $ret; + } + + /** + * Read a FastCGI Packet + * + * @return array + */ + private function readPacket() + { + if ($packet = socket_read($this->_sock, self::HEADER_LEN)) { + + $resp = $this->decodePacketHeader($packet); + + if ($len = $resp['contentLength'] + $resp['paddingLength']) { + $resp['content'] = substr(socket_read($this->_sock, $len), 0, $resp['contentLength']); + } else { + $resp['content'] = ''; + } + return $resp; + } else { + return false; + } + } + + /** + * Get Informations on the FastCGI application + * + * @param array $requestedInfo information to retrieve + * @return array + */ + public function getValues(array $requestedInfo) + { + $this->connect(); + + $request = ''; + foreach ($requestedInfo as $info) { + $request .= $this->buildNvpair($info, ''); + } + + socket_write($this->_sock, $this->buildPacket(self::GET_VALUES, $request, 0)); + $this->_awaitingResponse = true; + + // Block on this call. + while ($this->_awaitingResponse) { + + $resp = $this->readPacket(); + + if ($resp) { + $this->_awaitingResponse = false; + } else { + usleep(10); + } + } + + if ($resp['type'] == self::GET_VALUES_RESULT) { + return $this->readNvpair($resp['content'], $resp['length']); + } else { + throw new \Exception('Unexpected response type, expecting GET_VALUES_RESULT'); + } + } + + /** + * Execute a request to the FastCGI application + * + * @param array $params Array of parameters + * @param String $stdin Content + * @return Boolean Return true on success, false on failure. + */ + public function request(array $params, $stdin) + { + $this->connect(); + + $request = $this->buildPacket(self::BEGIN_REQUEST, chr(0) . chr(self::RESPONDER) . chr((int) $this->_keepAlive) . str_repeat(chr(0), 5)); + + $paramsRequest = ''; + foreach ($params as $key => $value) { + $paramsRequest .= $this->buildNvpair($key, $value); + } + if ($paramsRequest) { + $request .= $this->buildPacket(self::PARAMS, $paramsRequest); + } + $request .= $this->buildPacket(self::PARAMS, ''); + + if ($stdin) { + $request .= $this->buildPacket(self::STDIN, $stdin); + } + $request .= $this->buildPacket(self::STDIN, ''); + + // Write the request and break. + $this->_awaitingResponse = (boolean) socket_write($this->_sock, $request); + return $this->_awaitingResponse; + + } + + /** + * FCGIClient::formatResponse() + * + * Format the response into an array with separate headers and body. + * + * @param $response The plain, unformatted response. + * + * @return array An array containing the headers and body content. + */ + private static function formatResponse($response) { + + // Split the header from the body. Split on \n\n. + $doubleCr = strpos($response, "\r\n\r\n"); + $rawHeader = substr($response, 0, $doubleCr); + $rawBody = substr($response, $doubleCr, strlen($response)); + + // Format the header. + $header = array(); + $headerLines = explode("\n", $rawHeader); + + foreach ($headerLines as $line) { + if (preg_match('/([\w-]+):\s*(.*)$/', $line, $matches)) { + // ['Content-type'] => 'text/plain' + $header[$matches[1]] = $matches[2]; + } + } + + return array( + 'headers' => $header, + 'body' => trim($rawBody) + ); + } + + /** + * Collect the response from a FastCGI request. + * + * @return String Return response. + */ + public function response() { + + $response = ''; + + while ($this->_awaitingResponse) { + + $resp = $this->readPacket(); + + if ($resp) { + // Check for the end of the response. + if ($resp['type'] == self::END_REQUEST) { + $this->_awaitingResponse = false; + // Check for response content. + } elseif ($resp['type'] == self::STDOUT || $resp['type'] == self::STDERR) { + $response .= $resp['content']; + } + } else { + usleep(10); + } + } + + if (!is_array($resp)) { + throw new \Exception('Bad request'); + } + + switch (ord($resp['content']{4})) { + case self::CANT_MPX_CONN: + throw new \Exception('This app can\'t multiplex [CANT_MPX_CONN]'); + break; + case self::OVERLOADED: + throw new \Exception('New request rejected; too busy [OVERLOADED]'); + break; + case self::UNKNOWN_ROLE: + throw new \Exception('Role value not known [UNKNOWN_ROLE]'); + break; + case self::REQUEST_COMPLETE: + return static::formatResponse($response); + } + } + } +} diff --git a/lib/BitTP/LICENSE b/lib/BitTP/LICENSE new file mode 100644 index 00000000..4362b491 --- /dev/null +++ b/lib/BitTP/LICENSE @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! From 6e4fb3242841fc246548d753c31d032abb4aed87 Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Sat, 12 Jan 2013 23:00:38 -0800 Subject: [PATCH 3/8] Removing namespacing for 5.2+ compatibility --- lib/BitTP/FCGIClient.php | 711 +++++++++++++++++++-------------------- 1 file changed, 354 insertions(+), 357 deletions(-) diff --git a/lib/BitTP/FCGIClient.php b/lib/BitTP/FCGIClient.php index ccea8c54..ba87dd01 100644 --- a/lib/BitTP/FCGIClient.php +++ b/lib/BitTP/FCGIClient.php @@ -14,415 +14,412 @@ * See the GNU Lesser General Public License for more details. */ -namespace framework { +/** + * Handles communication with a FastCGI application + * + * @author Pierrick Charron + * @author Daniel Aharon + * @version 2.0 + */ +class FCGIClient +{ + const VERSION_1 = 1; + + const BEGIN_REQUEST = 1; + const ABORT_REQUEST = 2; + const END_REQUEST = 3; + const PARAMS = 4; + const STDIN = 5; + const STDOUT = 6; + const STDERR = 7; + const DATA = 8; + const GET_VALUES = 9; + const GET_VALUES_RESULT = 10; + const UNKNOWN_TYPE = 11; + const MAXTYPE = self::UNKNOWN_TYPE; + + const RESPONDER = 1; + const AUTHORIZER = 2; + const FILTER = 3; + + const REQUEST_COMPLETE = 0; + const CANT_MPX_CONN = 1; + const OVERLOADED = 2; + const UNKNOWN_ROLE = 3; + + const MAX_CONNS = 'MAX_CONNS'; + const MAX_REQS = 'MAX_REQS'; + const MPXS_CONNS = 'MPXS_CONNS'; + + const HEADER_LEN = 8; + + /** + * Socket + * @var Resource + */ + private $_sock = null; + + /** + * Host + * @var String + */ + private $_host = null; + + /** + * Port + * @var Integer + */ + private $_port = null; + + /** + * Keep Alive + * @var Boolean + */ + private $_keepAlive = false; + + /** + * A request has been sent. + * @var Boolean + */ + private $_awaitingResponse = false; /** - * Handles communication with a FastCGI application + * Constructor * - * @author Pierrick Charron - * @author Daniel Aharon - * @version 2.0 + * @param String $host Host of the FastCGI application + * @param Integer $port Port of the FastCGI application */ - class FCGIClient + public function __construct($host, $port) { - const VERSION_1 = 1; - - const BEGIN_REQUEST = 1; - const ABORT_REQUEST = 2; - const END_REQUEST = 3; - const PARAMS = 4; - const STDIN = 5; - const STDOUT = 6; - const STDERR = 7; - const DATA = 8; - const GET_VALUES = 9; - const GET_VALUES_RESULT = 10; - const UNKNOWN_TYPE = 11; - const MAXTYPE = self::UNKNOWN_TYPE; - - const RESPONDER = 1; - const AUTHORIZER = 2; - const FILTER = 3; - - const REQUEST_COMPLETE = 0; - const CANT_MPX_CONN = 1; - const OVERLOADED = 2; - const UNKNOWN_ROLE = 3; - - const MAX_CONNS = 'MAX_CONNS'; - const MAX_REQS = 'MAX_REQS'; - const MPXS_CONNS = 'MPXS_CONNS'; - - const HEADER_LEN = 8; - - /** - * Socket - * @var Resource - */ - private $_sock = null; - - /** - * Host - * @var String - */ - private $_host = null; - - /** - * Port - * @var Integer - */ - private $_port = null; - - /** - * Keep Alive - * @var Boolean - */ - private $_keepAlive = false; - - /** - * A request has been sent. - * @var Boolean - */ - private $_awaitingResponse = false; - - /** - * Constructor - * - * @param String $host Host of the FastCGI application - * @param Integer $port Port of the FastCGI application - */ - public function __construct($host, $port) - { - $this->_host = $host; - $this->_port = $port; - } + $this->_host = $host; + $this->_port = $port; + } - /** - * Destructor - */ - public function __destruct() { + /** + * Destructor + */ + public function __destruct() { + socket_close($this->_sock); + } + + /** + * Define whether or not the FastCGI application should keep the connection + * alive at the end of a request + * + * @param Boolean $b true if the connection should stay alive, false otherwise + */ + public function setKeepAlive($b) + { + $this->_keepAlive = (boolean)$b; + if (!$this->_keepAlive && $this->_sock) { socket_close($this->_sock); } + } - /** - * Define whether or not the FastCGI application should keep the connection - * alive at the end of a request - * - * @param Boolean $b true if the connection should stay alive, false otherwise - */ - public function setKeepAlive($b) - { - $this->_keepAlive = (boolean)$b; - if (!$this->_keepAlive && $this->_sock) { - socket_close($this->_sock); + /** + * Get the keep alive status + * + * @return Boolean true if the connection should stay alive, false otherwise + */ + public function getKeepAlive() + { + return $this->_keepAlive; + } + + /** + * Create a connection to the FastCGI application + */ + private function connect() + { + if (!$this->_sock) { + + $this->_sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); + socket_set_nonblock($this->_sock); + @socket_connect($this->_sock, $this->_host, $this->_port); // Block the "Operation now in progress" warning. + + if (!$this->_sock) { + throw new Exception( + 'Unable to connect to FastCGI application - ' . + socket_strerror(socket_last_error($this->_sock)) + ); } } + } - /** - * Get the keep alive status - * - * @return Boolean true if the connection should stay alive, false otherwise - */ - public function getKeepAlive() - { - return $this->_keepAlive; + /** + * Build a FastCGI packet + * + * @param Integer $type Type of the packet + * @param String $content Content of the packet + * @param Integer $requestId RequestId + */ + private function buildPacket($type, $content, $requestId = 1) + { + $clen = strlen($content); + return chr(self::VERSION_1) /* version */ + . chr($type) /* type */ + . chr(($requestId >> 8) & 0xFF) /* requestIdB1 */ + . chr($requestId & 0xFF) /* requestIdB0 */ + . chr(($clen >> 8 ) & 0xFF) /* contentLengthB1 */ + . chr($clen & 0xFF) /* contentLengthB0 */ + . chr(0) /* paddingLength */ + . chr(0) /* reserved */ + . $content; /* content */ + } + + /** + * Build an FastCGI Name value pair + * + * @param String $name Name + * @param String $value Value + * @return String FastCGI Name value pair + */ + private function buildNvpair($name, $value) + { + $nlen = strlen($name); + $vlen = strlen($value); + if ($nlen < 128) { + /* nameLengthB0 */ + $nvpair = chr($nlen); + } else { + /* nameLengthB3 & nameLengthB2 & nameLengthB1 & nameLengthB0 */ + $nvpair = chr(($nlen >> 24) | 0x80) . chr(($nlen >> 16) & 0xFF) . chr(($nlen >> 8) & 0xFF) . chr($nlen & 0xFF); + } + if ($vlen < 128) { + /* valueLengthB0 */ + $nvpair .= chr($vlen); + } else { + /* valueLengthB3 & valueLengthB2 & valueLengthB1 & valueLengthB0 */ + $nvpair .= chr(($vlen >> 24) | 0x80) . chr(($vlen >> 16) & 0xFF) . chr(($vlen >> 8) & 0xFF) . chr($vlen & 0xFF); } + /* nameData & valueData */ + return $nvpair . $name . $value; + } - /** - * Create a connection to the FastCGI application - */ - private function connect() - { - if (!$this->_sock) { + /** + * Read a set of FastCGI Name value pairs + * + * @param String $data Data containing the set of FastCGI NVPair + * @return array of NVPair + */ + private function readNvpair($data, $length = null) + { + $array = array(); - $this->_sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - socket_set_nonblock($this->_sock); - @socket_connect($this->_sock, $this->_host, $this->_port); // Block the "Operation now in progress" warning. + if ($length === null) { + $length = strlen($data); + } - if (!$this->_sock) { - throw new \Exception( - 'Unable to connect to FastCGI application - ' . - socket_strerror(socket_last_error($this->_sock)) - ); - } + $p = 0; + + while ($p != $length) { + + $nlen = ord($data{$p++}); + if ($nlen >= 128) { + $nlen = ($nlen & 0x7F << 24); + $nlen |= (ord($data{$p++}) << 16); + $nlen |= (ord($data{$p++}) << 8); + $nlen |= (ord($data{$p++})); } + $vlen = ord($data{$p++}); + if ($vlen >= 128) { + $vlen = ($nlen & 0x7F << 24); + $vlen |= (ord($data{$p++}) << 16); + $vlen |= (ord($data{$p++}) << 8); + $vlen |= (ord($data{$p++})); + } + $array[substr($data, $p, $nlen)] = substr($data, $p+$nlen, $vlen); + $p += ($nlen + $vlen); } - /** - * Build a FastCGI packet - * - * @param Integer $type Type of the packet - * @param String $content Content of the packet - * @param Integer $requestId RequestId - */ - private function buildPacket($type, $content, $requestId = 1) - { - $clen = strlen($content); - return chr(self::VERSION_1) /* version */ - . chr($type) /* type */ - . chr(($requestId >> 8) & 0xFF) /* requestIdB1 */ - . chr($requestId & 0xFF) /* requestIdB0 */ - . chr(($clen >> 8 ) & 0xFF) /* contentLengthB1 */ - . chr($clen & 0xFF) /* contentLengthB0 */ - . chr(0) /* paddingLength */ - . chr(0) /* reserved */ - . $content; /* content */ - } + return $array; + } - /** - * Build an FastCGI Name value pair - * - * @param String $name Name - * @param String $value Value - * @return String FastCGI Name value pair - */ - private function buildNvpair($name, $value) - { - $nlen = strlen($name); - $vlen = strlen($value); - if ($nlen < 128) { - /* nameLengthB0 */ - $nvpair = chr($nlen); - } else { - /* nameLengthB3 & nameLengthB2 & nameLengthB1 & nameLengthB0 */ - $nvpair = chr(($nlen >> 24) | 0x80) . chr(($nlen >> 16) & 0xFF) . chr(($nlen >> 8) & 0xFF) . chr($nlen & 0xFF); - } - if ($vlen < 128) { - /* valueLengthB0 */ - $nvpair .= chr($vlen); + /** + * Decode a FastCGI Packet + * + * @param String $data String containing all the packet + * @return array + */ + private function decodePacketHeader($data) + { + $ret = array(); + $ret['version'] = ord($data{0}); + $ret['type'] = ord($data{1}); + $ret['requestId'] = (ord($data{2}) << 8) + ord($data{3}); + $ret['contentLength'] = (ord($data{4}) << 8) + ord($data{5}); + $ret['paddingLength'] = ord($data{6}); + $ret['reserved'] = ord($data{7}); + return $ret; + } + + /** + * Read a FastCGI Packet + * + * @return array + */ + private function readPacket() + { + if ($packet = socket_read($this->_sock, self::HEADER_LEN)) { + + $resp = $this->decodePacketHeader($packet); + + if ($len = $resp['contentLength'] + $resp['paddingLength']) { + $resp['content'] = substr(socket_read($this->_sock, $len), 0, $resp['contentLength']); } else { - /* valueLengthB3 & valueLengthB2 & valueLengthB1 & valueLengthB0 */ - $nvpair .= chr(($vlen >> 24) | 0x80) . chr(($vlen >> 16) & 0xFF) . chr(($vlen >> 8) & 0xFF) . chr($vlen & 0xFF); + $resp['content'] = ''; } - /* nameData & valueData */ - return $nvpair . $name . $value; + return $resp; + } else { + return false; } + } - /** - * Read a set of FastCGI Name value pairs - * - * @param String $data Data containing the set of FastCGI NVPair - * @return array of NVPair - */ - private function readNvpair($data, $length = null) - { - $array = array(); - - if ($length === null) { - $length = strlen($data); - } + /** + * Get Informations on the FastCGI application + * + * @param array $requestedInfo information to retrieve + * @return array + */ + public function getValues(array $requestedInfo) + { + $this->connect(); - $p = 0; + $request = ''; + foreach ($requestedInfo as $info) { + $request .= $this->buildNvpair($info, ''); + } - while ($p != $length) { + socket_write($this->_sock, $this->buildPacket(self::GET_VALUES, $request, 0)); + $this->_awaitingResponse = true; - $nlen = ord($data{$p++}); - if ($nlen >= 128) { - $nlen = ($nlen & 0x7F << 24); - $nlen |= (ord($data{$p++}) << 16); - $nlen |= (ord($data{$p++}) << 8); - $nlen |= (ord($data{$p++})); - } - $vlen = ord($data{$p++}); - if ($vlen >= 128) { - $vlen = ($nlen & 0x7F << 24); - $vlen |= (ord($data{$p++}) << 16); - $vlen |= (ord($data{$p++}) << 8); - $vlen |= (ord($data{$p++})); - } - $array[substr($data, $p, $nlen)] = substr($data, $p+$nlen, $vlen); - $p += ($nlen + $vlen); + // Block on this call. + while ($this->_awaitingResponse) { + + $resp = $this->readPacket(); + + if ($resp) { + $this->_awaitingResponse = false; + } else { + usleep(10); } + } - return $array; + if ($resp['type'] == self::GET_VALUES_RESULT) { + return $this->readNvpair($resp['content'], $resp['length']); + } else { + throw new Exception('Unexpected response type, expecting GET_VALUES_RESULT'); } + } + + /** + * Execute a request to the FastCGI application + * + * @param array $params Array of parameters + * @param String $stdin Content + * @return Boolean Return true on success, false on failure. + */ + public function request(array $params, $stdin) + { + $this->connect(); + + $request = $this->buildPacket(self::BEGIN_REQUEST, chr(0) . chr(self::RESPONDER) . chr((int) $this->_keepAlive) . str_repeat(chr(0), 5)); - /** - * Decode a FastCGI Packet - * - * @param String $data String containing all the packet - * @return array - */ - private function decodePacketHeader($data) - { - $ret = array(); - $ret['version'] = ord($data{0}); - $ret['type'] = ord($data{1}); - $ret['requestId'] = (ord($data{2}) << 8) + ord($data{3}); - $ret['contentLength'] = (ord($data{4}) << 8) + ord($data{5}); - $ret['paddingLength'] = ord($data{6}); - $ret['reserved'] = ord($data{7}); - return $ret; + $paramsRequest = ''; + foreach ($params as $key => $value) { + $paramsRequest .= $this->buildNvpair($key, $value); } + if ($paramsRequest) { + $request .= $this->buildPacket(self::PARAMS, $paramsRequest); + } + $request .= $this->buildPacket(self::PARAMS, ''); - /** - * Read a FastCGI Packet - * - * @return array - */ - private function readPacket() - { - if ($packet = socket_read($this->_sock, self::HEADER_LEN)) { - - $resp = $this->decodePacketHeader($packet); - - if ($len = $resp['contentLength'] + $resp['paddingLength']) { - $resp['content'] = substr(socket_read($this->_sock, $len), 0, $resp['contentLength']); - } else { - $resp['content'] = ''; - } - return $resp; - } else { - return false; - } + if ($stdin) { + $request .= $this->buildPacket(self::STDIN, $stdin); } + $request .= $this->buildPacket(self::STDIN, ''); - /** - * Get Informations on the FastCGI application - * - * @param array $requestedInfo information to retrieve - * @return array - */ - public function getValues(array $requestedInfo) - { - $this->connect(); - - $request = ''; - foreach ($requestedInfo as $info) { - $request .= $this->buildNvpair($info, ''); - } + // Write the request and break. + $this->_awaitingResponse = (boolean) socket_write($this->_sock, $request); + return $this->_awaitingResponse; - socket_write($this->_sock, $this->buildPacket(self::GET_VALUES, $request, 0)); - $this->_awaitingResponse = true; + } - // Block on this call. - while ($this->_awaitingResponse) { + /** + * FCGIClient::formatResponse() + * + * Format the response into an array with separate headers and body. + * + * @param $response The plain, unformatted response. + * + * @return array An array containing the headers and body content. + */ + private static function formatResponse($response) { - $resp = $this->readPacket(); + // Split the header from the body. Split on \n\n. + $doubleCr = strpos($response, "\r\n\r\n"); + $rawHeader = substr($response, 0, $doubleCr); + $rawBody = substr($response, $doubleCr, strlen($response)); - if ($resp) { - $this->_awaitingResponse = false; - } else { - usleep(10); - } - } + // Format the header. + $header = array(); + $headerLines = explode("\n", $rawHeader); - if ($resp['type'] == self::GET_VALUES_RESULT) { - return $this->readNvpair($resp['content'], $resp['length']); - } else { - throw new \Exception('Unexpected response type, expecting GET_VALUES_RESULT'); + foreach ($headerLines as $line) { + if (preg_match('/([\w-]+):\s*(.*)$/', $line, $matches)) { + // ['Content-type'] => 'text/plain' + $header[$matches[1]] = $matches[2]; } } - /** - * Execute a request to the FastCGI application - * - * @param array $params Array of parameters - * @param String $stdin Content - * @return Boolean Return true on success, false on failure. - */ - public function request(array $params, $stdin) - { - $this->connect(); - - $request = $this->buildPacket(self::BEGIN_REQUEST, chr(0) . chr(self::RESPONDER) . chr((int) $this->_keepAlive) . str_repeat(chr(0), 5)); - - $paramsRequest = ''; - foreach ($params as $key => $value) { - $paramsRequest .= $this->buildNvpair($key, $value); - } - if ($paramsRequest) { - $request .= $this->buildPacket(self::PARAMS, $paramsRequest); - } - $request .= $this->buildPacket(self::PARAMS, ''); - - if ($stdin) { - $request .= $this->buildPacket(self::STDIN, $stdin); - } - $request .= $this->buildPacket(self::STDIN, ''); + return array( + 'headers' => $header, + 'body' => trim($rawBody) + ); + } - // Write the request and break. - $this->_awaitingResponse = (boolean) socket_write($this->_sock, $request); - return $this->_awaitingResponse; + /** + * Collect the response from a FastCGI request. + * + * @return String Return response. + */ + public function response() { - } + $response = ''; - /** - * FCGIClient::formatResponse() - * - * Format the response into an array with separate headers and body. - * - * @param $response The plain, unformatted response. - * - * @return array An array containing the headers and body content. - */ - private static function formatResponse($response) { - - // Split the header from the body. Split on \n\n. - $doubleCr = strpos($response, "\r\n\r\n"); - $rawHeader = substr($response, 0, $doubleCr); - $rawBody = substr($response, $doubleCr, strlen($response)); - - // Format the header. - $header = array(); - $headerLines = explode("\n", $rawHeader); - - foreach ($headerLines as $line) { - if (preg_match('/([\w-]+):\s*(.*)$/', $line, $matches)) { - // ['Content-type'] => 'text/plain' - $header[$matches[1]] = $matches[2]; - } - } + while ($this->_awaitingResponse) { - return array( - 'headers' => $header, - 'body' => trim($rawBody) - ); - } + $resp = $this->readPacket(); - /** - * Collect the response from a FastCGI request. - * - * @return String Return response. - */ - public function response() { - - $response = ''; - - while ($this->_awaitingResponse) { - - $resp = $this->readPacket(); - - if ($resp) { - // Check for the end of the response. - if ($resp['type'] == self::END_REQUEST) { - $this->_awaitingResponse = false; - // Check for response content. - } elseif ($resp['type'] == self::STDOUT || $resp['type'] == self::STDERR) { - $response .= $resp['content']; - } - } else { - usleep(10); + if ($resp) { + // Check for the end of the response. + if ($resp['type'] == self::END_REQUEST) { + $this->_awaitingResponse = false; + // Check for response content. + } elseif ($resp['type'] == self::STDOUT || $resp['type'] == self::STDERR) { + $response .= $resp['content']; } + } else { + usleep(10); } + } - if (!is_array($resp)) { - throw new \Exception('Bad request'); - } + if (!is_array($resp)) { + throw new Exception('Bad request'); + } - switch (ord($resp['content']{4})) { - case self::CANT_MPX_CONN: - throw new \Exception('This app can\'t multiplex [CANT_MPX_CONN]'); - break; - case self::OVERLOADED: - throw new \Exception('New request rejected; too busy [OVERLOADED]'); - break; - case self::UNKNOWN_ROLE: - throw new \Exception('Role value not known [UNKNOWN_ROLE]'); - break; - case self::REQUEST_COMPLETE: - return static::formatResponse($response); - } + switch (ord($resp['content']{4})) { + case self::CANT_MPX_CONN: + throw new Exception('This app can\'t multiplex [CANT_MPX_CONN]'); + break; + case self::OVERLOADED: + throw new Exception('New request rejected; too busy [OVERLOADED]'); + break; + case self::UNKNOWN_ROLE: + throw new Exception('Role value not known [UNKNOWN_ROLE]'); + break; + case self::REQUEST_COMPLETE: + return static::formatResponse($response); } } } From b365d8094b92e2720757040bbd350b0410e7d2b0 Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Sat, 12 Jan 2013 23:27:20 -0800 Subject: [PATCH 4/8] convert fcgi to exceptions and blocking sockets --- lib/BitTP/Exception.php | 64 ++++++++++++++++ lib/BitTP/FCGIClient.php | 161 ++++++++++++++++++++++++++------------- 2 files changed, 173 insertions(+), 52 deletions(-) create mode 100644 lib/BitTP/Exception.php diff --git a/lib/BitTP/Exception.php b/lib/BitTP/Exception.php new file mode 100644 index 00000000..d39e3741 --- /dev/null +++ b/lib/BitTP/Exception.php @@ -0,0 +1,64 @@ + + * @version 2.0 + */ +class BitTP_Exception +{ + static public function socketCreate() + { + $err = socket_last_error(); + return new self("Couldn't create socket - $err - ".socket_strerror($err)); + } + + static public function socketConnect($socket, $host, $port) + { + if ($port) { + $host .= ":$port"; + } + return self::socketError("Failure connecting to $host", $socket); + } + + static public function socketRead($socket) + { + if ($socket === null) { + return self::requestAborted(); + } + + return self::socketError('Failure reading socket', $socket); + } + + static public function socketWrite($socket) + { + if ($socket === null) { + return self::requestAborted(); + } + + return self::socketError('Failure writing socket', $socket); + } + + static public function socketError($message, $socket) + { + $err = socket_last_error($socket); + return new self("$message - $err - ".socket_strerror($err)); + } +} diff --git a/lib/BitTP/FCGIClient.php b/lib/BitTP/FCGIClient.php index ba87dd01..c86cd3fe 100644 --- a/lib/BitTP/FCGIClient.php +++ b/lib/BitTP/FCGIClient.php @@ -14,14 +14,17 @@ * See the GNU Lesser General Public License for more details. */ +require_once dirname(__FILE__).'/Exception.php'; + /** * Handles communication with a FastCGI application * * @author Pierrick Charron * @author Daniel Aharon + * @author Erik Bernhardson * @version 2.0 */ -class FCGIClient +class BitTP_FCGIClient { const VERSION_1 = 1; @@ -98,8 +101,11 @@ public function __construct($host, $port) /** * Destructor */ - public function __destruct() { - socket_close($this->_sock); + public function __destruct() + { + if ($this->_sock) { + socket_close($this->_sock); + } } /** @@ -112,7 +118,7 @@ public function setKeepAlive($b) { $this->_keepAlive = (boolean)$b; if (!$this->_keepAlive && $this->_sock) { - socket_close($this->_sock); + $this->close(); } } @@ -126,6 +132,17 @@ public function getKeepAlive() return $this->_keepAlive; } + /** + * Close the fastcgi connection + */ + public function close() + { + if ($this->_sock) { + socket_close($this->_sock); + $this->_sock = null; + } + } + /** * Create a connection to the FastCGI application */ @@ -133,16 +150,14 @@ private function connect() { if (!$this->_sock) { - $this->_sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - socket_set_nonblock($this->_sock); - @socket_connect($this->_sock, $this->_host, $this->_port); // Block the "Operation now in progress" warning. - + $this->_sock = @socket_create(AF_INET, SOCK_STREAM, SOL_TCP); if (!$this->_sock) { - throw new Exception( - 'Unable to connect to FastCGI application - ' . - socket_strerror(socket_last_error($this->_sock)) - ); + throw BitTP_Exception::socketCreate(); } + if (false === @socket_connect($this->_sock, $this->_host, $this->_port)) { + throw BitTP_Exception::socketConnect($this->_sock, $this->_host, $this->_port); + } + } } @@ -260,19 +275,24 @@ private function decodePacketHeader($data) */ private function readPacket() { - if ($packet = socket_read($this->_sock, self::HEADER_LEN)) { + $packet = @socket_read($this->_sock, self::HEADER_LEN); + if ($packet === false) { + throw BitTP_Exception::socketRead($this->_sock); + } - $resp = $this->decodePacketHeader($packet); + $resp = $this->decodePacketHeader($packet); - if ($len = $resp['contentLength'] + $resp['paddingLength']) { - $resp['content'] = substr(socket_read($this->_sock, $len), 0, $resp['contentLength']); - } else { - $resp['content'] = ''; + if ($len = $resp['contentLength'] + $resp['paddingLength']) { + $content = @socket_read($this->_sock, $len); + if ($content === false) { + throw BitTP_Exception::socketRead($this->_sock); } - return $resp; + $resp['content'] = substr($content, 0, $resp['contentLength']); } else { - return false; + $resp['content'] = ''; } + + return $resp; } /** @@ -282,6 +302,22 @@ private function readPacket() * @return array */ public function getValues(array $requestedInfo) + { + try { + return $this->doGetValues($requestedInfo); + } catch (BitTP_Exception $e) { + $this->close(); + throw $e; + } + } + + /** + * Get Informations on the FastCGI application + * + * @param array $requestedInfo information to retrieve + * @return array + */ + protected function doGetValues(array $requestedInfo) { $this->connect(); @@ -290,25 +326,18 @@ public function getValues(array $requestedInfo) $request .= $this->buildNvpair($info, ''); } - socket_write($this->_sock, $this->buildPacket(self::GET_VALUES, $request, 0)); - $this->_awaitingResponse = true; - - // Block on this call. - while ($this->_awaitingResponse) { - - $resp = $this->readPacket(); - - if ($resp) { - $this->_awaitingResponse = false; - } else { - usleep(10); - } + if (false === @socket_write($this->_sock, $this->buildPacket(self::GET_VALUES, $request, 0))) { + throw BitTP_Exception::socketWrite($this->_sock); } + $this->_awaitingResponse = true; + $resp = $this->readPacket(); + $this->_awaitingResponse = false; + if ($resp['type'] == self::GET_VALUES_RESULT) { return $this->readNvpair($resp['content'], $resp['length']); } else { - throw new Exception('Unexpected response type, expecting GET_VALUES_RESULT'); + throw new BitTP_Exception('Unexpected response type, expecting GET_VALUES_RESULT'); } } @@ -317,9 +346,24 @@ public function getValues(array $requestedInfo) * * @param array $params Array of parameters * @param String $stdin Content - * @return Boolean Return true on success, false on failure. */ public function request(array $params, $stdin) + { + try { + $this->doRequest($params, $stdin); + } catch (BitTP_Exception $e) { + $this->close(); + throw $e; + } + } + + /** + * Execute a request to the FastCGI application + * + * @param array $params Array of parameters + * @param String $stdin Content + */ + protected function doRequest(array $params, $stdin) { $this->connect(); @@ -340,9 +384,11 @@ public function request(array $params, $stdin) $request .= $this->buildPacket(self::STDIN, ''); // Write the request and break. - $this->_awaitingResponse = (boolean) socket_write($this->_sock, $request); - return $this->_awaitingResponse; + if (false === @socket_write($this->_sock, $request)) { + throw BitTP_Exception::socketWrite($this->_sock); + } + $this->_awaitingResponse = true; } /** @@ -383,40 +429,51 @@ private static function formatResponse($response) { * * @return String Return response. */ - public function response() { + public function response() + { + try { + return $this->doResponse(); + } catch (BitTP_Exception $e) { + $this->close(); + throw $e; + } + } + /** + * Collect the response from a FastCGI request. + * + * @return String Return response. + */ + protected function doResponse() + { $response = ''; while ($this->_awaitingResponse) { $resp = $this->readPacket(); - if ($resp) { - // Check for the end of the response. - if ($resp['type'] == self::END_REQUEST) { - $this->_awaitingResponse = false; - // Check for response content. - } elseif ($resp['type'] == self::STDOUT || $resp['type'] == self::STDERR) { - $response .= $resp['content']; - } - } else { - usleep(10); + // Check for the end of the response. + if ($resp['type'] == self::END_REQUEST) { + $this->_awaitingResponse = false; + // Check for response content. + } elseif ($resp['type'] == self::STDOUT || $resp['type'] == self::STDERR) { + $response .= $resp['content']; } } if (!is_array($resp)) { - throw new Exception('Bad request'); + throw new BitTP_Exception("Bad Request"); } switch (ord($resp['content']{4})) { case self::CANT_MPX_CONN: - throw new Exception('This app can\'t multiplex [CANT_MPX_CONN]'); + throw new BitTP_Exception('This app can\'t multiplex [CANT_MPX_CONN]'); break; case self::OVERLOADED: - throw new Exception('New request rejected; too busy [OVERLOADED]'); + throw new BitTP_Exception('New request rejected; too busy [OVERLOADED]'); break; case self::UNKNOWN_ROLE: - throw new Exception('Role value not known [UNKNOWN_ROLE]'); + throw new BitTP_Exception('Role value not known [UNKNOWN_ROLE]'); break; case self::REQUEST_COMPLETE: return static::formatResponse($response); From 9ad10a3a63fef1453e2ac963619e101f230560ce Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Sat, 12 Jan 2013 23:52:14 -0800 Subject: [PATCH 5/8] seperate fcgi response from error output --- lib/BitTP/FCGIClient.php | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/lib/BitTP/FCGIClient.php b/lib/BitTP/FCGIClient.php index c86cd3fe..fe2f4fd0 100644 --- a/lib/BitTP/FCGIClient.php +++ b/lib/BitTP/FCGIClient.php @@ -396,16 +396,17 @@ protected function doRequest(array $params, $stdin) * * Format the response into an array with separate headers and body. * - * @param $response The plain, unformatted response. + * @param $stdout The plain, unformatted response. + * @param $stderr The plain, unformatted error output. * * @return array An array containing the headers and body content. */ - private static function formatResponse($response) { + private static function formatResponse($stdout, $stderr) { // Split the header from the body. Split on \n\n. - $doubleCr = strpos($response, "\r\n\r\n"); - $rawHeader = substr($response, 0, $doubleCr); - $rawBody = substr($response, $doubleCr, strlen($response)); + $doubleCr = strpos($stdout, "\r\n\r\n"); + $rawHeader = substr($stdout, 0, $doubleCr); + $rawBody = substr($stdout, $doubleCr, strlen($stdout)); // Format the header. $header = array(); @@ -420,7 +421,8 @@ private static function formatResponse($response) { return array( 'headers' => $header, - 'body' => trim($rawBody) + 'body' => trim($rawBody), + 'stderr' => $stderr, ); } @@ -446,7 +448,7 @@ public function response() */ protected function doResponse() { - $response = ''; + $stdout = $stderr = ''; while ($this->_awaitingResponse) { @@ -456,8 +458,10 @@ protected function doResponse() if ($resp['type'] == self::END_REQUEST) { $this->_awaitingResponse = false; // Check for response content. - } elseif ($resp['type'] == self::STDOUT || $resp['type'] == self::STDERR) { - $response .= $resp['content']; + } elseif ($resp['type'] == self::STDOUT) { + $stdout .= $resp['content']; + } elseif ($resp['type'] == self::STDERR) { + $stderr .= $resp['content']; } } @@ -476,7 +480,7 @@ protected function doResponse() throw new BitTP_Exception('Role value not known [UNKNOWN_ROLE]'); break; case self::REQUEST_COMPLETE: - return static::formatResponse($response); + return static::formatResponse($stdout, $stderr); } } } From ecdc2ff40d20f97b55cae45cae5819bd8fc19e26 Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Sat, 12 Jan 2013 23:52:43 -0800 Subject: [PATCH 6/8] calculate status code for fcgi responses --- lib/BitTP/FCGIClient.php | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/lib/BitTP/FCGIClient.php b/lib/BitTP/FCGIClient.php index fe2f4fd0..9626585c 100644 --- a/lib/BitTP/FCGIClient.php +++ b/lib/BitTP/FCGIClient.php @@ -394,7 +394,7 @@ protected function doRequest(array $params, $stdin) /** * FCGIClient::formatResponse() * - * Format the response into an array with separate headers and body. + * Format the response into an array with separate statusCode, headers, body, and error output. * * @param $stdout The plain, unformatted response. * @param $stderr The plain, unformatted error output. @@ -415,14 +415,33 @@ private static function formatResponse($stdout, $stderr) { foreach ($headerLines as $line) { if (preg_match('/([\w-]+):\s*(.*)$/', $line, $matches)) { // ['Content-type'] => 'text/plain' - $header[$matches[1]] = $matches[2]; + $header[strtolower($matches[1])] = $matches[2]; } } + if (isset($header['status'])) { + $code = $header['status']; + if (false !== ($pos = strpos($code, ' '))) { + $code = substr($code, 0, $pos); + } + } else { + if (isset($header['location'])) { + $header['status'] = '302 Moved Temporarily'; + $code = '302'; + } else { + $header['status'] = '200 OK'; + $code = '200'; + } + } + + if (false === ctype_digit($code)) { + throw new BitTP_Exception("Unrecognizable status code returned from fastcgi: $code"); + } return array( - 'headers' => $header, - 'body' => trim($rawBody), - 'stderr' => $stderr, + 'statusCode' => (int) $code, + 'headers' => $header, + 'body' => trim($rawBody), + 'stderr' => $stderr, ); } From 2c8aa11bbf555576d5d97c69e673fa01374ff8c7 Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Sun, 13 Jan 2013 00:15:58 -0800 Subject: [PATCH 7/8] Fastcgi job strategy implementation --- README.md | 35 ++++++++- bin/resque | 40 +++++++++++ extras/fastcgi_worker.php | 30 ++++++++ lib/Resque/JobStrategy/Fastcgi.php | 112 +++++++++++++++++++++++++++++ 4 files changed, 215 insertions(+), 2 deletions(-) create mode 100644 extras/fastcgi_worker.php create mode 100644 lib/Resque/JobStrategy/Fastcgi.php diff --git a/README.md b/README.md index 2b94eac9..6bca6697 100644 --- a/README.md +++ b/README.md @@ -223,7 +223,15 @@ the `COUNT` environment variable: $ COUNT=5 bin/resque -### Forking ### +### Job Srategys ### + +Php-resque implements multiple ways to seperate the worker process +from the job process to improce resilience. Supported platforms +default to the fork strategy, falling back to in-process execution. +Specific strategys can be chosen by supplyingthe `JOB_STRATEGY` +environment variable. + +#### Forking #### Similarly to the Ruby versions, supported platforms will immediately fork after picking up a job. The forked child will exit as soon as @@ -233,6 +241,29 @@ The difference with php-resque is that if a forked child does not exit nicely (PHP error or such), php-resque will automatically fail the job. + $ JOB_STRATEGY=fork php resque.php + +#### Fastcgi #### + +The fastcgi strategy executes jobs over a fastcgi connection to php-fpm. +It may offer a lower overhead per job in environments with lots of very short +jobs. + + $ JOB_STRATEGY=fastcgi php resque.php + +Fastcgi accepts two additional parameters. `FASTCGI_LOCATION` sets the +location of the php-fpm server. This can either be a host:port combination +or a path to a unix socket. `FASTCGI_SCRIPT` sets the path to the script used +to receive and run the job in the php-fpm process. + +#### In Process #### + +For cases when the other two strategys are not available the in-process +strategy will run jobs in the same process as the worker. This is not +recommended as failures in the job may turn into failures in the worker. + + $ JOB_STRATEGY=inprocess php resque.php + ### Signals ### Signals also work on supported platforms exactly as in the Ruby @@ -370,4 +401,4 @@ Called after a job has been queued using the `Resque::enqueue` method. Arguments * maetl * Matt Heath * jjfrey -* scragg0x \ No newline at end of file +* scragg0x diff --git a/bin/resque b/bin/resque index 186e1eef..a848d170 100644 --- a/bin/resque +++ b/bin/resque @@ -66,6 +66,40 @@ if(!empty($COUNT) && $COUNT > 1) { $count = $COUNT; } +$jobStrategy=null; +$JOB_STRATEGY = getenv('JOB_STRATEGY'); +switch($JOB_STRATEGY) { + case 'inprocess': + $jobStrategy = new Resque_JobStrategy_InProcess; + break; + case 'fork': + $jobStrategy = new Resque_JobStrategy_Fork; + break; + case 'fastcgi': + $fastcgiLocation = '127.0.0.1:9000'; + $FASTCGI_LOCATION = getenv('FASTCGI_LOCATION'); + if (!empty($FASTCGI_LOCATION)) { + $fastcgiLocation = $FASTCGI_LOCATION; + } + + $fastcgiScript = dirname(__FILE__).'/extras/fastcgi_worker.php'; + $FASTCGI_SCRIPT = getenv('FASTCGI_SCRIPT'); + if (!empty($FASTCGI_SCRIPT)) { + $fastcgiScript = $FASTCGI_SCRIPT; + } + + require_once dirname(__FILE__).'/lib/Resque/JobStrategy/Fastcgi.php'; + $jobStrategy = new Resque_JobStrategy_Fastcgi( + $fastcgiLocation, + $fastcgiScript, + array( + 'APP_INCLUDE' => $APP_INCLUDE, + 'REDIS_BACKEND' => $REDIS_BACKEND, + ) + ); + break; +} + if($count > 1) { for($i = 0; $i < $count; ++$i) { $pid = Resque::fork(); @@ -77,6 +111,9 @@ if($count > 1) { $queues = explode(',', $QUEUE); $worker = new Resque_Worker($queues); $worker->logLevel = $logLevel; + if ($jobStrategy) { + $worker->setJobStrategy($jobStrategy); + } fwrite(STDOUT, '*** Starting worker '.$worker."\n"); $worker->work($interval); break; @@ -88,6 +125,9 @@ else { $queues = explode(',', $QUEUE); $worker = new Resque_Worker($queues); $worker->logLevel = $logLevel; + if ($jobStrategy) { + $worker->setJobStrategy($jobStrategy); + } $PIDFILE = getenv('PIDFILE'); if ($PIDFILE) { diff --git a/extras/fastcgi_worker.php b/extras/fastcgi_worker.php new file mode 100644 index 00000000..7910ea7d --- /dev/null +++ b/extras/fastcgi_worker.php @@ -0,0 +1,30 @@ +worker->perform($job); +} catch (\Exception $e) { + if (isset($job)) { + $job->fail($e); + } else { + header('Status: 500'); + } +} + +?> diff --git a/lib/Resque/JobStrategy/Fastcgi.php b/lib/Resque/JobStrategy/Fastcgi.php new file mode 100644 index 00000000..cf92e05f --- /dev/null +++ b/lib/Resque/JobStrategy/Fastcgi.php @@ -0,0 +1,112 @@ + + * @license http://www.opensource.org/licenses/mit-license.php + */ +class Resque_JobStrategy_Fastcgi implements Resque_JobStrategy_Interface +{ + /** + * @var bool True when waiting for a response from fcgi server + */ + private $waiting = false; + + /** + * @var array Default enironment for FCGI requests + */ + protected $requestData = array( + 'GATEWAY_INTERFACE' => 'FastCGI/1.0', + 'REQUEST_METHOD' => 'GET', + 'SERVER_SOFTWARE' => 'php-resque-fastcgi/1.3-dev', + 'REMOTE_ADDR' => '127.0.0.1', + 'REMOTE_PORT' => 8888, + 'SERVER_ADDR' => '127.0.0.1', + 'SERVER_PORT' => 8888, + 'SERVER_PROTOCOL' => 'HTTP/1.1' + ); + + /** + * @param string $location When the location contains a `:` it will be considered a host/port pair + * otherwise a unix socket path + * @param string $script Absolute path to the script that will load resque and perform the job + * @param array $environment Additional environment variables available in $_SERVER to the fcgi script + */ + public function __construct($location, $script, $environment = array()) + { + $this->location = $location; + + $port = false; + if (false !== strpos($location, ':')) { + list($location, $port) = explode(':', $location, 2); + } + + $this->fcgi = new BitTP_FCGIClient($location, $port); + $this->fcgi->setKeepAlive(true); + + $this->requestData = $environment + $this->requestData + array( + 'SCRIPT_FILENAME' => $script, + 'SERVER_NAME' => php_uname('n'), + 'RESQUE_DIR' => __DIR__.'/../../../', + ); + } + + /** + * @param Resque_Worker $worker + */ + public function setWorker(Resque_Worker $worker) + { + $this->worker = $worker; + } + + /** + * Executes the provided job over a fastcgi connection + * + * @param Resque_Job $job + */ + public function perform(Resque_Job $job) + { + $status = 'Requested fcgi job execution from ' . $this->location . ' at ' . strftime('%F %T'); + $this->worker->updateProcLine($status); + $this->worker->log($status, Resque_Worker::LOG_VERBOSE); + + $this->waiting = true; + + try { + $this->fcgi->request(array( + 'RESQUE_JOB' => urlencode(serialize($job)), + ) + $this->requestData, ''); + + $response = $this->fcgi->response(); + $this->waiting = false; + } catch (BitTP_Exception $e) { + $this->waiting = false; + $job->fail($e); + return; + } + + if ($response['statusCode'] !== 200) { + $job->fail(new Exception(sprintf( + 'FastCGI job returned non-200 status code: %s Stdout: %s Stderr: %s', + $response['headers']['status'], + $response['body'], + $response['stderr'] + ))); + } + } + + /** + * Shutdown the worker process. + */ + public function shutdown() + { + if ($this->waiting === false) { + $this->worker->log('No child to kill.', Resque_Worker::LOG_VERBOSE); + } else { + $this->worker->log('Closing fcgi connection with job in progress.', Resque_Worker::LOG_VERBOSE); + } + $this->fcgi->close(); + } +} From 4b05078a936bf1388dd6919e5032efc36342a7ba Mon Sep 17 00:00:00 2001 From: ebernhardson Date: Fri, 1 Feb 2013 20:38:06 -0800 Subject: [PATCH 8/8] move fastcgi client to external composer package --- README.md | 3 +- composer.json | 5 +- lib/BitTP/Exception.php | 64 ---- lib/BitTP/FCGIClient.php | 505 ----------------------------- lib/BitTP/LICENSE | 502 ---------------------------- lib/Resque/JobStrategy/Fastcgi.php | 7 +- 6 files changed, 9 insertions(+), 1077 deletions(-) delete mode 100644 lib/BitTP/Exception.php delete mode 100644 lib/BitTP/FCGIClient.php delete mode 100644 lib/BitTP/LICENSE diff --git a/README.md b/README.md index 6bca6697..bc346f1e 100644 --- a/README.md +++ b/README.md @@ -247,7 +247,8 @@ the job. The fastcgi strategy executes jobs over a fastcgi connection to php-fpm. It may offer a lower overhead per job in environments with lots of very short -jobs. +jobs. To use fastcgi you must install the suggested composer package +`ebernhardson/fastcgi` $ JOB_STRATEGY=fastcgi php resque.php diff --git a/composer.json b/composer.json index 32f92ad9..7a842cb3 100644 --- a/composer.json +++ b/composer.json @@ -23,7 +23,8 @@ }, "suggest": { "ext-proctitle": "Allows php-resque to rename the title of UNIX processes to show the status of a worker.", - "ext-redis": "Native PHP extension for Redis connectivity. Credis will automatically utilize when available." + "ext-redis": "Native PHP extension for Redis connectivity. Credis will automatically utilize when available.", + "ebernhardson/fastcgi": "Allows php-resque to execute jobs via php-fpm." }, "require-dev": { "phpunit/phpunit": "3.7.*" @@ -36,4 +37,4 @@ "Resque": "lib" } } -} \ No newline at end of file +} diff --git a/lib/BitTP/Exception.php b/lib/BitTP/Exception.php deleted file mode 100644 index d39e3741..00000000 --- a/lib/BitTP/Exception.php +++ /dev/null @@ -1,64 +0,0 @@ - - * @version 2.0 - */ -class BitTP_Exception -{ - static public function socketCreate() - { - $err = socket_last_error(); - return new self("Couldn't create socket - $err - ".socket_strerror($err)); - } - - static public function socketConnect($socket, $host, $port) - { - if ($port) { - $host .= ":$port"; - } - return self::socketError("Failure connecting to $host", $socket); - } - - static public function socketRead($socket) - { - if ($socket === null) { - return self::requestAborted(); - } - - return self::socketError('Failure reading socket', $socket); - } - - static public function socketWrite($socket) - { - if ($socket === null) { - return self::requestAborted(); - } - - return self::socketError('Failure writing socket', $socket); - } - - static public function socketError($message, $socket) - { - $err = socket_last_error($socket); - return new self("$message - $err - ".socket_strerror($err)); - } -} diff --git a/lib/BitTP/FCGIClient.php b/lib/BitTP/FCGIClient.php deleted file mode 100644 index 9626585c..00000000 --- a/lib/BitTP/FCGIClient.php +++ /dev/null @@ -1,505 +0,0 @@ - - * @author Daniel Aharon - * @author Erik Bernhardson - * @version 2.0 - */ -class BitTP_FCGIClient -{ - const VERSION_1 = 1; - - const BEGIN_REQUEST = 1; - const ABORT_REQUEST = 2; - const END_REQUEST = 3; - const PARAMS = 4; - const STDIN = 5; - const STDOUT = 6; - const STDERR = 7; - const DATA = 8; - const GET_VALUES = 9; - const GET_VALUES_RESULT = 10; - const UNKNOWN_TYPE = 11; - const MAXTYPE = self::UNKNOWN_TYPE; - - const RESPONDER = 1; - const AUTHORIZER = 2; - const FILTER = 3; - - const REQUEST_COMPLETE = 0; - const CANT_MPX_CONN = 1; - const OVERLOADED = 2; - const UNKNOWN_ROLE = 3; - - const MAX_CONNS = 'MAX_CONNS'; - const MAX_REQS = 'MAX_REQS'; - const MPXS_CONNS = 'MPXS_CONNS'; - - const HEADER_LEN = 8; - - /** - * Socket - * @var Resource - */ - private $_sock = null; - - /** - * Host - * @var String - */ - private $_host = null; - - /** - * Port - * @var Integer - */ - private $_port = null; - - /** - * Keep Alive - * @var Boolean - */ - private $_keepAlive = false; - - /** - * A request has been sent. - * @var Boolean - */ - private $_awaitingResponse = false; - - /** - * Constructor - * - * @param String $host Host of the FastCGI application - * @param Integer $port Port of the FastCGI application - */ - public function __construct($host, $port) - { - $this->_host = $host; - $this->_port = $port; - } - - /** - * Destructor - */ - public function __destruct() - { - if ($this->_sock) { - socket_close($this->_sock); - } - } - - /** - * Define whether or not the FastCGI application should keep the connection - * alive at the end of a request - * - * @param Boolean $b true if the connection should stay alive, false otherwise - */ - public function setKeepAlive($b) - { - $this->_keepAlive = (boolean)$b; - if (!$this->_keepAlive && $this->_sock) { - $this->close(); - } - } - - /** - * Get the keep alive status - * - * @return Boolean true if the connection should stay alive, false otherwise - */ - public function getKeepAlive() - { - return $this->_keepAlive; - } - - /** - * Close the fastcgi connection - */ - public function close() - { - if ($this->_sock) { - socket_close($this->_sock); - $this->_sock = null; - } - } - - /** - * Create a connection to the FastCGI application - */ - private function connect() - { - if (!$this->_sock) { - - $this->_sock = @socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - if (!$this->_sock) { - throw BitTP_Exception::socketCreate(); - } - if (false === @socket_connect($this->_sock, $this->_host, $this->_port)) { - throw BitTP_Exception::socketConnect($this->_sock, $this->_host, $this->_port); - } - - } - } - - /** - * Build a FastCGI packet - * - * @param Integer $type Type of the packet - * @param String $content Content of the packet - * @param Integer $requestId RequestId - */ - private function buildPacket($type, $content, $requestId = 1) - { - $clen = strlen($content); - return chr(self::VERSION_1) /* version */ - . chr($type) /* type */ - . chr(($requestId >> 8) & 0xFF) /* requestIdB1 */ - . chr($requestId & 0xFF) /* requestIdB0 */ - . chr(($clen >> 8 ) & 0xFF) /* contentLengthB1 */ - . chr($clen & 0xFF) /* contentLengthB0 */ - . chr(0) /* paddingLength */ - . chr(0) /* reserved */ - . $content; /* content */ - } - - /** - * Build an FastCGI Name value pair - * - * @param String $name Name - * @param String $value Value - * @return String FastCGI Name value pair - */ - private function buildNvpair($name, $value) - { - $nlen = strlen($name); - $vlen = strlen($value); - if ($nlen < 128) { - /* nameLengthB0 */ - $nvpair = chr($nlen); - } else { - /* nameLengthB3 & nameLengthB2 & nameLengthB1 & nameLengthB0 */ - $nvpair = chr(($nlen >> 24) | 0x80) . chr(($nlen >> 16) & 0xFF) . chr(($nlen >> 8) & 0xFF) . chr($nlen & 0xFF); - } - if ($vlen < 128) { - /* valueLengthB0 */ - $nvpair .= chr($vlen); - } else { - /* valueLengthB3 & valueLengthB2 & valueLengthB1 & valueLengthB0 */ - $nvpair .= chr(($vlen >> 24) | 0x80) . chr(($vlen >> 16) & 0xFF) . chr(($vlen >> 8) & 0xFF) . chr($vlen & 0xFF); - } - /* nameData & valueData */ - return $nvpair . $name . $value; - } - - /** - * Read a set of FastCGI Name value pairs - * - * @param String $data Data containing the set of FastCGI NVPair - * @return array of NVPair - */ - private function readNvpair($data, $length = null) - { - $array = array(); - - if ($length === null) { - $length = strlen($data); - } - - $p = 0; - - while ($p != $length) { - - $nlen = ord($data{$p++}); - if ($nlen >= 128) { - $nlen = ($nlen & 0x7F << 24); - $nlen |= (ord($data{$p++}) << 16); - $nlen |= (ord($data{$p++}) << 8); - $nlen |= (ord($data{$p++})); - } - $vlen = ord($data{$p++}); - if ($vlen >= 128) { - $vlen = ($nlen & 0x7F << 24); - $vlen |= (ord($data{$p++}) << 16); - $vlen |= (ord($data{$p++}) << 8); - $vlen |= (ord($data{$p++})); - } - $array[substr($data, $p, $nlen)] = substr($data, $p+$nlen, $vlen); - $p += ($nlen + $vlen); - } - - return $array; - } - - /** - * Decode a FastCGI Packet - * - * @param String $data String containing all the packet - * @return array - */ - private function decodePacketHeader($data) - { - $ret = array(); - $ret['version'] = ord($data{0}); - $ret['type'] = ord($data{1}); - $ret['requestId'] = (ord($data{2}) << 8) + ord($data{3}); - $ret['contentLength'] = (ord($data{4}) << 8) + ord($data{5}); - $ret['paddingLength'] = ord($data{6}); - $ret['reserved'] = ord($data{7}); - return $ret; - } - - /** - * Read a FastCGI Packet - * - * @return array - */ - private function readPacket() - { - $packet = @socket_read($this->_sock, self::HEADER_LEN); - if ($packet === false) { - throw BitTP_Exception::socketRead($this->_sock); - } - - $resp = $this->decodePacketHeader($packet); - - if ($len = $resp['contentLength'] + $resp['paddingLength']) { - $content = @socket_read($this->_sock, $len); - if ($content === false) { - throw BitTP_Exception::socketRead($this->_sock); - } - $resp['content'] = substr($content, 0, $resp['contentLength']); - } else { - $resp['content'] = ''; - } - - return $resp; - } - - /** - * Get Informations on the FastCGI application - * - * @param array $requestedInfo information to retrieve - * @return array - */ - public function getValues(array $requestedInfo) - { - try { - return $this->doGetValues($requestedInfo); - } catch (BitTP_Exception $e) { - $this->close(); - throw $e; - } - } - - /** - * Get Informations on the FastCGI application - * - * @param array $requestedInfo information to retrieve - * @return array - */ - protected function doGetValues(array $requestedInfo) - { - $this->connect(); - - $request = ''; - foreach ($requestedInfo as $info) { - $request .= $this->buildNvpair($info, ''); - } - - if (false === @socket_write($this->_sock, $this->buildPacket(self::GET_VALUES, $request, 0))) { - throw BitTP_Exception::socketWrite($this->_sock); - } - - $this->_awaitingResponse = true; - $resp = $this->readPacket(); - $this->_awaitingResponse = false; - - if ($resp['type'] == self::GET_VALUES_RESULT) { - return $this->readNvpair($resp['content'], $resp['length']); - } else { - throw new BitTP_Exception('Unexpected response type, expecting GET_VALUES_RESULT'); - } - } - - /** - * Execute a request to the FastCGI application - * - * @param array $params Array of parameters - * @param String $stdin Content - */ - public function request(array $params, $stdin) - { - try { - $this->doRequest($params, $stdin); - } catch (BitTP_Exception $e) { - $this->close(); - throw $e; - } - } - - /** - * Execute a request to the FastCGI application - * - * @param array $params Array of parameters - * @param String $stdin Content - */ - protected function doRequest(array $params, $stdin) - { - $this->connect(); - - $request = $this->buildPacket(self::BEGIN_REQUEST, chr(0) . chr(self::RESPONDER) . chr((int) $this->_keepAlive) . str_repeat(chr(0), 5)); - - $paramsRequest = ''; - foreach ($params as $key => $value) { - $paramsRequest .= $this->buildNvpair($key, $value); - } - if ($paramsRequest) { - $request .= $this->buildPacket(self::PARAMS, $paramsRequest); - } - $request .= $this->buildPacket(self::PARAMS, ''); - - if ($stdin) { - $request .= $this->buildPacket(self::STDIN, $stdin); - } - $request .= $this->buildPacket(self::STDIN, ''); - - // Write the request and break. - if (false === @socket_write($this->_sock, $request)) { - throw BitTP_Exception::socketWrite($this->_sock); - } - - $this->_awaitingResponse = true; - } - - /** - * FCGIClient::formatResponse() - * - * Format the response into an array with separate statusCode, headers, body, and error output. - * - * @param $stdout The plain, unformatted response. - * @param $stderr The plain, unformatted error output. - * - * @return array An array containing the headers and body content. - */ - private static function formatResponse($stdout, $stderr) { - - // Split the header from the body. Split on \n\n. - $doubleCr = strpos($stdout, "\r\n\r\n"); - $rawHeader = substr($stdout, 0, $doubleCr); - $rawBody = substr($stdout, $doubleCr, strlen($stdout)); - - // Format the header. - $header = array(); - $headerLines = explode("\n", $rawHeader); - - foreach ($headerLines as $line) { - if (preg_match('/([\w-]+):\s*(.*)$/', $line, $matches)) { - // ['Content-type'] => 'text/plain' - $header[strtolower($matches[1])] = $matches[2]; - } - } - if (isset($header['status'])) { - $code = $header['status']; - if (false !== ($pos = strpos($code, ' '))) { - $code = substr($code, 0, $pos); - } - } else { - if (isset($header['location'])) { - $header['status'] = '302 Moved Temporarily'; - $code = '302'; - } else { - $header['status'] = '200 OK'; - $code = '200'; - } - } - - if (false === ctype_digit($code)) { - throw new BitTP_Exception("Unrecognizable status code returned from fastcgi: $code"); - } - - return array( - 'statusCode' => (int) $code, - 'headers' => $header, - 'body' => trim($rawBody), - 'stderr' => $stderr, - ); - } - - /** - * Collect the response from a FastCGI request. - * - * @return String Return response. - */ - public function response() - { - try { - return $this->doResponse(); - } catch (BitTP_Exception $e) { - $this->close(); - throw $e; - } - } - - /** - * Collect the response from a FastCGI request. - * - * @return String Return response. - */ - protected function doResponse() - { - $stdout = $stderr = ''; - - while ($this->_awaitingResponse) { - - $resp = $this->readPacket(); - - // Check for the end of the response. - if ($resp['type'] == self::END_REQUEST) { - $this->_awaitingResponse = false; - // Check for response content. - } elseif ($resp['type'] == self::STDOUT) { - $stdout .= $resp['content']; - } elseif ($resp['type'] == self::STDERR) { - $stderr .= $resp['content']; - } - } - - if (!is_array($resp)) { - throw new BitTP_Exception("Bad Request"); - } - - switch (ord($resp['content']{4})) { - case self::CANT_MPX_CONN: - throw new BitTP_Exception('This app can\'t multiplex [CANT_MPX_CONN]'); - break; - case self::OVERLOADED: - throw new BitTP_Exception('New request rejected; too busy [OVERLOADED]'); - break; - case self::UNKNOWN_ROLE: - throw new BitTP_Exception('Role value not known [UNKNOWN_ROLE]'); - break; - case self::REQUEST_COMPLETE: - return static::formatResponse($stdout, $stderr); - } - } -} diff --git a/lib/BitTP/LICENSE b/lib/BitTP/LICENSE deleted file mode 100644 index 4362b491..00000000 --- a/lib/BitTP/LICENSE +++ /dev/null @@ -1,502 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! diff --git a/lib/Resque/JobStrategy/Fastcgi.php b/lib/Resque/JobStrategy/Fastcgi.php index cf92e05f..535a9620 100644 --- a/lib/Resque/JobStrategy/Fastcgi.php +++ b/lib/Resque/JobStrategy/Fastcgi.php @@ -1,6 +1,7 @@ fcgi = new BitTP_FCGIClient($location, $port); + $this->fcgi = new Client($location, $port); $this->fcgi->setKeepAlive(true); $this->requestData = $environment + $this->requestData + array( @@ -81,7 +82,7 @@ public function perform(Resque_Job $job) $response = $this->fcgi->response(); $this->waiting = false; - } catch (BitTP_Exception $e) { + } catch (CommunicationException $e) { $this->waiting = false; $job->fail($e); return;