├── .State
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── Documentation
    ├── En
    │   └── Index.xyl
    └── Fr
    │   └── Index.xyl
├── Exception.php
├── README.md
├── Test
    └── Unit
    │   └── Zombie.php
├── Zombie.php
├── bors.toml
└── composer.json


/.State:
--------------------------------------------------------------------------------
1 | finalized
2 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | /composer.lock
3 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: php
 2 | 
 3 | branches:
 4 |   only:
 5 |     - staging
 6 |     - trying
 7 |     - master
 8 | 
 9 | matrix:
10 |   include:
11 |     - php: 5.5
12 |     - php: 5.6
13 |     - php: 7.0
14 |     - php: 7.1
15 |       env:
16 |         - ENABLE_XDEBUG=true
17 |     - php: 7.1
18 |       env:
19 |         - ENABLE_DEVTOOLS=true
20 |     - php: nightly
21 |   allow_failures:
22 |     - php: nightly
23 |   fast_finish: true
24 | 
25 | os:
26 |   - linux
27 | 
28 | notifications:
29 |   irc: "chat.freenode.net#hoaproject"
30 | 
31 | sudo: false
32 | 
33 | env:
34 |   global:
35 |     - secure: "AAAAB3NzaC1yc2EAAAADAQABAAAAgQC8pyH+AhD98yAuYJPLqhJbutiqsOmlXmsZ8c3i0/ck4a709Dgn8FjlzpUdbauLAkiXyoD7byp8UxAwkZU24KLDEmFbhJ1oR7JNvbWiFnKgHthfFKa/TyfxLT7Z/1/K9H7pmdziiwwDBJNyQKgD0uWSToZv8rnyldYndBB1FtcRvw=="
36 | 
37 | cache:
38 |   directories:
39 |     - vendor/
40 | 
41 | before_script:
42 |   - export PATH="$PATH:$HOME/.composer/vendor/bin"
43 |   - if [[ ! $ENABLE_XDEBUG ]]; then
44 |       phpenv config-rm xdebug.ini || echo "ext-xdebug is not available, cannot remove it.";
45 |     fi
46 | 
47 | script:
48 |   - composer install
49 |   - vendor/bin/hoa test:run
50 |   - if [[ $ENABLE_DEVTOOLS ]]; then
51 |       composer global require friendsofphp/php-cs-fixer;
52 |       vendor/bin/hoa devtools:cs --diff --dry-run .;
53 |     fi
54 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # 3.17.01.16
 2 | 
 3 |   * Quality: Happy new year! (Alexis von Glasow, 2017-01-09T21:36:59+01:00)
 4 |   * Documentation: New `README.md` file. (Ivan Enderlin, 2016-10-21T17:18:29+02:00)
 5 |   * Documentation: Update `support` properties. (Ivan Enderlin, 2016-10-11T11:44:15+02:00)
 6 | 
 7 | # 3.16.01.11
 8 | 
 9 |   * Quality: Drop PHP5.4. (Ivan Enderlin, 2016-01-11T09:15:27+01:00)
10 |   * Quality: Run devtools:cs. (Ivan Enderlin, 2016-01-09T09:12:59+01:00)
11 |   * Core: Remove `Hoa\Core`. (Ivan Enderlin, 2016-01-09T08:35:32+01:00)
12 |   * Consistency: Use `Hoa\Consistency`. (Ivan Enderlin, 2015-12-08T22:22:44+01:00)
13 |   * Exception: Use `Hoa\Exception`. (Ivan Enderlin, 2015-11-20T20:30:20+01:00)
14 | 
15 | # 2.15.08.17
16 | 
17 |   * Add a `.gitignore` file. (Stéphane HULARD, 2015-08-03T11:52:31+02:00)
18 | 
19 | # 2.15.05.29
20 | 
21 |   * Move to PSR-1 and PSR-2. (Ivan Enderlin, 2015-05-22T08:58:37+02:00)
22 | 
23 | # 2.15.02.16
24 | 
25 |   * Add the CHANGELOG.md file. (Ivan Enderlin, 2015-02-16T14:47:03+01:00)
26 |   * Fix documentation links. (Ivan Enderlin, 2015-01-23T19:29:32+01:00)
27 |   * Happy new year! (Ivan Enderlin, 2015-01-05T15:00:45+01:00)
28 | 
29 | # 2.14.12.10
30 | 
31 |   * Move to PSR-4. (Ivan Enderlin, 2014-12-09T18:57:09+01:00)
32 |   * Require `hoa/test`. (Alexis von Glasow, 2014-11-26T13:30:04+01:00)
33 | 
34 | # 2.14.11.09
35 | 
36 |   * Fix API documentation. (Ivan Enderlin, 2014-10-06T15:56:11+02:00)
37 |   * Add tests. (Ivan Enderlin, 2014-10-06T15:37:28+02:00)
38 |   * `Zombie::fork` returns true on success. (Ivan Enderlin, 2014-10-06T15:37:01+02:00)
39 |   * Remove `from`/`import` and update to PHP5.4. (Ivan Enderlin, 2014-10-06T11:38:00+02:00)
40 | 
41 | # 2.14.09.23
42 | 
43 |   * Add `branch-alias` (Stéphane PY, 2014-09-23T12:00:52+02:00)
44 | 
45 | # 2.14.09.17
46 | 
47 |   * Drop PHP5.3. (Ivan Enderlin, 2014-09-17T17:58:46+02:00)
48 |   * Add the installation section. (Ivan Enderlin, 2014-09-17T17:58:33+02:00)
49 | 
50 | (first snapshot)
51 | 


--------------------------------------------------------------------------------
/Documentation/En/Index.xyl:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | 
  3 | <overlay xmlns="http://hoa-project.net/xyl/xylophone">
  4 | <yield id="chapter">
  5 | 
  6 |   <p>A zombie is a processus which is neither active, nor finished: between
  7 |   <strong>life</strong> and <strong>death</strong>. <code>Hoa\Zombie</code>
  8 |   allows to turn a PHP execution into a <strong>zombie</strong>!</p>
  9 | 
 10 |   <h2 id="Table_of_contents">Table of contents</h2>
 11 | 
 12 |   <tableofcontents id="main-toc" />
 13 | 
 14 |   <h2 id="Introduction" for="main-toc">Introduction</h2>
 15 | 
 16 |   <p>Putting a processus between life and death should be, in general, avoided,
 17 |   because it is often synonym of a <strong>dysfunction</strong>. However, it
 18 |   might happen to be shrewd, notably in the case of a <strong>demon</strong>
 19 |   (see <a href="@hack:chapter=Worker">the <code>Hoa\Worker</code> library</a>).
 20 |   It is important to notice that a zombie is also mute: it can no longer write
 21 |   on its standard output because it is theorically no longer attached to a
 22 |   parent processus.</p>
 23 |   <p>For now, <code>Hoa\Zombie</code> is able to create zombies only if it runs
 24 |   behind <a href="http://php.net/install.fpm">PHP FPM</a>. Remind us how PHP
 25 |   works: a <a href="http://fastcgi.com/">FastCGI</a> server (such as PHP FastCGI
 26 |   or PHP FPM) will start a PHP processus when a <strong>request</strong> is
 27 |   received and will stop it when a <strong>response</strong> is sent. Somehow,
 28 |   the PHP processus is <strong>synchronized</strong> on the FastCGI protocol.
 29 |   Fortunately, when we use PHP FPM, we are able to
 30 |   <strong>desynchronize</strong> this protocol, and thus, to create zombies,
 31 |   while delegating <a href="http://php.net/install.fpm.configuration">the
 32 |   processus management to PHP FPM</a>!</p>
 33 | 
 34 |   <h2 id="Manipulate_zombies" for="main-toc">Manipulate zombies</h2>
 35 | 
 36 |   <p>Creating a zombie is very simple: we only need to call the
 37 |   <code>Hoa\Zombie\Zombie::fork</code> method.</p>
 38 |   <p>It is common knowledge that killing a zombie is a very
 39 |   <strong>attractive</strong> activity, even more if we have the choice of
 40 |   <strong>weapons</strong>! That's why <code>Hoa\Zombie\Zombie</code> provides
 41 |   the following methods:</p>
 42 |   <ul>
 43 |     <li><code>Hoa\Zombie\Zombie::decapitate</code>, to
 44 |     <strong>decapitate</strong> a zombie,</li>
 45 |     <li><code>Hoa\Zombie\Zombie::bludgeon</code>, to <strong>cosh</strong> a
 46 |     zombie,</li>
 47 |     <li><code>Hoa\Zombie\Zombie::burn</code>, to <strong>burn</strong> a
 48 |     zombie,</li>
 49 |     <li><code>Hoa\Zombie\Zombie::explode</code>, to <strong>explode</strong> a
 50 |     zombie,</li>
 51 |     <li><code>Hoa\Zombie\Zombie::cutOff</code>, to <strong>slice</strong>
 52 |     a zombie.</li>
 53 |   </ul>
 54 |   <p>All these methods have been proven. Thus:</p>
 55 |   <pre><code class="language-php">// I'm alive!
 56 | Hoa\Zombie\Zombie::fork();
 57 | // I'm a zombie!
 58 | Hoa\Zombie\Zombie::decapitate();
 59 | // I'm dead…</code></pre>
 60 |   <p><code>Hoa\Zombie\Zombie</code> is also able to get the
 61 |   <strong>identifier</strong> of the processus, which can be useful sometimes,
 62 |   through the <code>Hoa\Zombie\Zombie::getPid</code> method. Finally, the
 63 |   <code>Hoa\Zombie\Zombie::test</code> method allows to know whether we can
 64 |   create a zombie or not.</p>
 65 | 
 66 |   <h2 id="Example" for="main-toc">Example</h2>
 67 | 
 68 |   <p>To create a zombie, we said we need to use PHP FPM. Next, there is
 69 |   different ways to execute our PHP program, which will be our future zombie:
 70 |   either through HTTP (which will automatically create a FastCGI request to
 71 |   PHP FPM) or directly by <strong>sending</strong> a FastCGI request to PHP FPM.
 72 |   We will choose this latter.</p>
 73 |   <p>We start with the <code>Zombie.php</code> file:</p>
 74 |   <pre><code class="language-php">echo 'I guess I am sick…', "\n";
 75 | Hoa\Zombie\Zombie::fork();
 76 | 
 77 | // Do whatever you want here, e.g.:
 78 | sleep(10);
 79 | file_put_contents(
 80 |     __DIR__ . DS . 'AMessage',
 81 |     'Hello from after-life… or somewhere about!'
 82 | );
 83 | </code></pre>
 84 |   <p>Next, we continue with the <code>Run.php</code> file which will execute
 85 |   <code>Zombie.php</code> thanks to
 86 |   <a href="@hack:chapter=Fastcgi"><code>Hoa\Fastcgi</code></a>:</p>
 87 |   <pre><code class="language-php">$fastcgi = new Hoa\Fastcgi\Responder(
 88 |     new Hoa\Socket\Client('tcp://127.0.0.1:9000')
 89 | );
 90 | 
 91 | // Start Zombie.php and print the response before it becomes undead.
 92 | echo $fastcgi->send([
 93 |     'GATEWAY_INTERFACE' => 'FastCGI/1.0',
 94 |     'REQUEST_METHOD'    => 'GET',
 95 |     'SCRIPT_FILENAME'   => __DIR__ . DS . 'Zombie.php'
 96 | ]);</code></pre>
 97 |   <p>And finally, we test:</p>
 98 |   <pre><code class="language-shell">$ php-fpm -d listen=127.0.0.1:9000
 99 | $ php Run.php
100 | I guess I am sick…</code></pre>
101 |   <p>After 10 seconds, we will see the <code>AMessage</code> file appears,
102 |   containing <em>Hello from after-life… or somewhere about!</em>.</p>
103 |   <p>We can create a zombie <strong>at any moment</strong> and kill it as we
104 |   want. If the end of the program is reached, the zombie will kill
105 |   <strong>itself</strong>. We will anticipate that a demon is just a zombie that
106 |   starts a server.</p>
107 | 
108 |   <h2 id="Conclusion" for="main-toc">Conclusion</h2>
109 | 
110 |   <p><code>Hoa\Zombie</code> allows to turn a processus into a
111 |   <strong>zombie</strong> only when it is used with PHP FPM. We invite you to
112 |   take a look at <a href="@hack:chapter=Worker"><code>Hoa\Worker</code></a> for
113 |   a <strong>complete</strong> example.</p>
114 | 
115 | </yield>
116 | </overlay>
117 | 


--------------------------------------------------------------------------------
/Documentation/Fr/Index.xyl:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | 
  3 | <overlay xmlns="http://hoa-project.net/xyl/xylophone">
  4 | <yield id="chapter">
  5 | 
  6 |   <p>Un zombie est un processus qui n'est ni actif, ni terminé : il est entre la
  7 |   <strong>vie</strong> et la <strong>mort</strong>. <code>Hoa\Zombie</code>
  8 |   permet de transformer une exécution PHP en <strong>zombie</strong> !</p>
  9 | 
 10 |   <h2 id="Table_of_contents">Table des matières</h2>
 11 | 
 12 |   <tableofcontents id="main-toc" />
 13 | 
 14 |   <h2 id="Introduction" for="main-toc">Introduction</h2>
 15 | 
 16 |   <p>Placer un processus entre la vie et la mort est en général à éviter car
 17 |   cela est souvent synonyme de <strong>dysfonctionnement</strong>. Toutefois, il
 18 |   peut arriver que ce soit astucieux de le faire, notamment dans le cas de
 19 |   <strong>démons</strong> (voir
 20 |   <a href="@hack:chapter=Worker"><code>Hoa\Worker</code></a>). Il est à noter
 21 |   qu'un zombie est également <strong>muet</strong> : il ne peut plus écrire sur
 22 |   la sortie standard puisqu'il n'est théoriquement plus attaché à aucun
 23 |   processus parent.</p>
 24 |   <p>Actuellement, <code>Hoa\Zombie</code> ne permet de créer des zombies que
 25 |   s'il est utilisé derrière
 26 |   <a href="http://php.net/install.fpm">PHP FPM</a>. Rappelons-nous du
 27 |   fonctionnement de PHP : un serveur <a href="http://fastcgi.com/">FastCGI</a>
 28 |   (comme PHP FastCGI ou PHP FPM) va démarrer un processus PHP quand une
 29 |   <strong>requête</strong> arrive et la terminer quand la
 30 |   <strong>réponse</strong> est envoyée. D'une certaine manière, le processus PHP
 31 |   est <strong>synchronisé</strong> sur le protocole FastCGI. Heureusement, quand
 32 |   nous utilisons PHP FPM, nous pouvons <strong>désynchroniser</strong> ce
 33 |   protocole, et ainsi créer des zombies tout en <strong>délégant</strong>
 34 |   <a href="http://php.net/install.fpm.configuration">la gestion des processus à
 35 |   PHP FPM</a> !</p>
 36 | 
 37 |   <h2 id="Manipulate_zombies" for="main-toc">Manipuler des
 38 |   zombies</h2>
 39 | 
 40 |   <p>Créer un zombie est très <strong>simple</strong> : il suffit d'appeler la
 41 |   méthode <code>Hoa\Zombie\Zombie::fork()</code>.</p>
 42 |   <p>Il est de notoriété publique que tuer un zombie est une activité
 43 |   <strong>amusante</strong>, d'autant plus si nous avons le choix des
 44 |   <strong>armes</strong> ! C'est pourquoi <code>Hoa\Zombie\Zombie</code> propose
 45 |   les méthodes suivantes :</p>
 46 |   <ul>
 47 |     <li><code>Hoa\Zombie\Zombie::decapitate</code>, pour
 48 |     <strong>décapiter</strong> un zombie ;</li>
 49 |     <li><code>Hoa\Zombie\Zombie::bludgeon</code>, pour
 50 |     <strong>matraquer</strong> un zombie ;</li>
 51 |     <li><code>Hoa\Zombie\Zombie::burn</code>, pour <strong>brûler</strong> un
 52 |     zombie ;</li>
 53 |     <li><code>Hoa\Zombie\Zombie::explode</code>, pour faire
 54 |     <strong>exploser</strong> un zombie ;</li>
 55 |     <li><code>Hoa\Zombie\Zombie::cutOff</code>, pour <strong>découper</strong>
 56 |     un zombie en rondelles.</li>
 57 |   </ul>
 58 |   <p>Toutes ces méthodes ont fait leurs preuves. Ainsi :</p>
 59 |   <pre><code class="language-php">// I'm alive!
 60 | Hoa\Zombie\Zombie::fork();
 61 | // I'm a zombie!
 62 | Hoa\Zombie\Zombie::decapitate();
 63 | // I'm dead…</code></pre>
 64 |   <p><code>Hoa\Zombie\Zombie</code> propose également d'obtenir
 65 |   l'<strong>identifiant</strong> du processus, ce qui peut parfois être utile, à
 66 |   travers la méthode <code>Hoa\Zombie\Zombie::getPid</code>. Enfin, il existe la
 67 |   méthode <code>Hoa\Zombie\Zombie::test</code> qui permet de savoir si nous
 68 |   pouvons créer un zombie ou pas.</p>
 69 | 
 70 |   <h2 id="Example" for="main-toc">Exemple</h2>
 71 | 
 72 |   <p>Pour créer un zombie, nous avons dit qu'il fallait utiliser PHP FPM.
 73 |   Ensuite, nous avons plusieurs possibilités pour exécuter notre programme PHP
 74 |   qui sera notre futur zombie : soit à travers HTTP (qui fera automatiquement
 75 |   une requête FastCGI vers PHP FPM) ou alors directement en
 76 |   <strong>émettant</strong> une requête FastCGI vers PHP FPM. C'est ce dernier
 77 |   choix que nous allons retenir.</p>
 78 |   <p>Nous commençons avec le fichier <code>Zombie.php</code> :</p>
 79 |   <pre><code class="language-php">echo 'I guess I am sick…', "\n";
 80 | Hoa\Zombie\Zombie::fork();
 81 | 
 82 | // Do whatever you want here, e.g.:
 83 | sleep(10);
 84 | file_put_contents(
 85 |     __DIR__ . DS . 'AMessage',
 86 |     'Hello from after-life… or somewhere about!'
 87 | );
 88 | </code></pre>
 89 |   <p>Ensuite, nous continuons avec le fichier <code>Run.php</code> qui va
 90 |   exécuter <code>Zombie.php</code> grâce à
 91 |   <a href="@hack:chapter=Fastcgi"><code>Hoa\Fastcgi</code></a> :</p>
 92 |   <pre><code class="language-php">$fastcgi = new Hoa\Fastcgi\Responder(
 93 |     new Hoa\Socket\Client('tcp://127.0.0.1:9000')
 94 | );
 95 | 
 96 | // Start Zombie.php and print the response before it becomes undead.
 97 | echo $fastcgi->send([
 98 |     'GATEWAY_INTERFACE' => 'FastCGI/1.0',
 99 |     'REQUEST_METHOD'    => 'GET',
100 |     'SCRIPT_FILENAME'   => __DIR__ . DS . 'Zombie.php'
101 | ]);</code></pre>
102 |   <p>Et enfin, nous testons :</p>
103 |   <pre><code class="language-shell">$ php-fpm -d listen=127.0.0.1:9000
104 | $ php Run.php
105 | I guess I am sick…</code></pre>
106 |   <p>Et après 10 secondes, nous verrons le fichier <code>AMessage</code>
107 |   apparaître et contenant <em lang="en">Hello from after-life… or somewhere
108 |   about!</em>.</p>
109 |   <p>Nous pouvons créer un zombie <strong>à tout moment</strong> et le tuer
110 |   comme nous le voulons. Si la fin du programme est atteinte, le zombie se tuera
111 |   de <strong>lui-même</strong>. Nous anticiperons qu'un démon n'est finalement
112 |   rien d'autre qu'un zombie qui démarre un serveur.</p>
113 | 
114 |   <h2 id="Conclusion" for="main-toc">Conclusion</h2>
115 | 
116 |   <p><code>Hoa\Zombie</code> permet de transformer un processus en
117 |   <strong>zombie</strong> uniquement lorsqu'il est utilisé avec PHP FPM. Nous
118 |   vous invitons à regarder
119 |   <a href="@hack:chapter=Worker"><code>Hoa\Worker</code></a> pour un exemple
120 |   d'utilisation plus <strong>complet</strong>.</p>
121 | 
122 | </yield>
123 | </overlay>
124 | 


--------------------------------------------------------------------------------
/Exception.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Hoa
 5 |  *
 6 |  *
 7 |  * @license
 8 |  *
 9 |  * New BSD License
10 |  *
11 |  * Copyright © 2007-2017, Hoa community. All rights reserved.
12 |  *
13 |  * Redistribution and use in source and binary forms, with or without
14 |  * modification, are permitted provided that the following conditions are met:
15 |  *     * Redistributions of source code must retain the above copyright
16 |  *       notice, this list of conditions and the following disclaimer.
17 |  *     * Redistributions in binary form must reproduce the above copyright
18 |  *       notice, this list of conditions and the following disclaimer in the
19 |  *       documentation and/or other materials provided with the distribution.
20 |  *     * Neither the name of the Hoa nor the names of its contributors may be
21 |  *       used to endorse or promote products derived from this software without
22 |  *       specific prior written permission.
23 |  *
24 |  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 |  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 |  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 |  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 |  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 |  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 |  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 |  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 |  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 |  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 |  * POSSIBILITY OF SUCH DAMAGE.
35 |  */
36 | 
37 | namespace Hoa\Zombie;
38 | 
39 | use Hoa\Exception as HoaException;
40 | 
41 | /**
42 |  * Class \Hoa\Zombie\Exception.
43 |  *
44 |  * Extending the \Hoa\Exception\Exception class.
45 |  *
46 |  * @copyright  Copyright © 2007-2017 Hoa community
47 |  * @license    New BSD License
48 |  */
49 | class Exception extends HoaException
50 | {
51 | }
52 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <p align="center">
  2 |   <img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" />
  3 | </p>
  4 | 
  5 | ---
  6 | 
  7 | <p align="center">
  8 |   <a href="https://travis-ci.org/hoaproject/Zombie"><img src="https://img.shields.io/travis/hoaproject/Zombie/master.svg" alt="Build status" /></a>
  9 |   <a href="https://coveralls.io/github/hoaproject/Zombie?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/Zombie/master.svg" alt="Code coverage" /></a>
 10 |   <a href="https://packagist.org/packages/hoa/zombie"><img src="https://img.shields.io/packagist/dt/hoa/zombie.svg" alt="Packagist" /></a>
 11 |   <a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/zombie.svg" alt="License" /></a>
 12 | </p>
 13 | <p align="center">
 14 |   Hoa is a <strong>modular</strong>, <strong>extensible</strong> and
 15 |   <strong>structured</strong> set of PHP libraries.<br />
 16 |   Moreover, Hoa aims at being a bridge between industrial and research worlds.
 17 | </p>
 18 | 
 19 | # Hoa\Zombie
 20 | 
 21 | [![Help on IRC](https://img.shields.io/badge/help-%23hoaproject-ff0066.svg)](https://webchat.freenode.net/?channels=#hoaproject)
 22 | [![Help on Gitter](https://img.shields.io/badge/help-gitter-ff0066.svg)](https://gitter.im/hoaproject/central)
 23 | [![Documentation](https://img.shields.io/badge/documentation-hack_book-ff0066.svg)](https://central.hoa-project.net/Documentation/Library/Zombie)
 24 | [![Board](https://img.shields.io/badge/organisation-board-ff0066.svg)](https://waffle.io/hoaproject/zombie)
 25 | 
 26 | This library allows to transform a process into a zombie: not alive, nor dead!
 27 | 
 28 | This is possible only if the program is running behind
 29 | [PHP-FPM](http://php.net/install.fpm) (which manages processes for us).
 30 | 
 31 | [Learn more](https://central.hoa-project.net/Documentation/Library/Zombie).
 32 | 
 33 | ## Installation
 34 | 
 35 | With [Composer](https://getcomposer.org/), to include this library into
 36 | your dependencies, you need to
 37 | require [`hoa/zombie`](https://packagist.org/packages/hoa/zombie):
 38 | 
 39 | ```sh
 40 | $ composer require hoa/zombie '~3.0'
 41 | ```
 42 | 
 43 | For more installation procedures, please read [the Source
 44 | page](https://hoa-project.net/Source.html).
 45 | 
 46 | ## Testing
 47 | 
 48 | Before running the test suites, the development dependencies must be installed:
 49 | 
 50 | ```sh
 51 | $ composer install
 52 | ```
 53 | 
 54 | Then, to run all the test suites:
 55 | 
 56 | ```sh
 57 | $ vendor/bin/hoa test:run
 58 | ```
 59 | 
 60 | For more information, please read the [contributor
 61 | guide](https://hoa-project.net/Literature/Contributor/Guide.html).
 62 | 
 63 | ## Quick usage
 64 | 
 65 | To create a zombie, all we have to do is to call the `Hoa\Zombie\Zombie::fork`
 66 | method. To kill a zombie, we have the choice between different weapons:
 67 | 
 68 |   * `Hoa\Zombie\Zombie::decapitate`, *ziip*;
 69 |   * `Hoa\Zombie\Zombie::bludgeon`, *tap tap*;
 70 |   * `Hoa\Zombie\Zombie::burn`, if you are cold;
 71 |   * `Hoa\Zombie\Zombie::explode`, *boom*;
 72 |   * `Hoa\Zombie\Zombie::cutOff`, sausage?
 73 | 
 74 | All these methods have been proven. Thus:
 75 | 
 76 | ```php
 77 | // I'm alive!
 78 | Hoa\Zombie\Zombie::fork();
 79 | // I'm a zombie!
 80 | Hoa\Zombie\Zombie::decapitate();
 81 | // I'm dead…
 82 | ```
 83 | 
 84 | But we have to run the script behind FastCGI, that is why we will use the
 85 | [`Hoa\Fastcgi` library](https://central.hoa-project.net/Resource/Library/Fastcgi) in the
 86 | following example.
 87 | 
 88 | In the `Zombie.php` file, we write the following instructions:
 89 | 
 90 | ```php
 91 | echo 'I guess I am sick…', "\n";
 92 | Hoa\Zombie\Zombie::fork();
 93 | 
 94 | // Do whatever you want here, e.g.:
 95 | sleep(10);
 96 | file_put_contents(
 97 |     __DIR__ . DS . 'AMessage',
 98 |     'Hello from after-life… or somewhere about!'
 99 | );
100 | Hoa\Zombie\Zombie::decapitate();
101 | ```
102 | 
103 | Then, in the `Run.php` file, we write:
104 | 
105 | ```php
106 | $fastcgi = new Hoa\Fastcgi\Responder(
107 |     new Hoa\Socket\Client('tcp://127.0.0.1:9000')
108 | );
109 | echo $fastcgi->send([
110 |     'GATEWAY_INTERFACE' => 'FastCGI/1.0',
111 |     'REQUEST_METHOD'    => 'GET',
112 |     'SCRIPT_FILENAME'   => __DIR__ . DS . 'Zombie.php'
113 | ]);
114 | ```
115 | 
116 | And finally, we can test:
117 | 
118 | ```sh
119 | $ php-fpm -d listen=127.0.0.1:9000
120 | $ php Run.php
121 | I guess I am sick…
122 | ```
123 | 
124 | And 10 seconds after, we will see the `AMessage` file appear with the content:
125 | *Hello from after-life… or somewhere about!*.
126 | 
127 | ## Documentation
128 | 
129 | The
130 | [hack book of `Hoa\Zombie`](https://central.hoa-project.net/Documentation/Library/Zombie)
131 | contains detailed information about how to use this library and how it works.
132 | 
133 | To generate the documentation locally, execute the following commands:
134 | 
135 | ```sh
136 | $ composer require --dev hoa/devtools
137 | $ vendor/bin/hoa devtools:documentation --open
138 | ```
139 | 
140 | More documentation can be found on the project's website:
141 | [hoa-project.net](https://hoa-project.net/).
142 | 
143 | ## Getting help
144 | 
145 | There are mainly two ways to get help:
146 | 
147 |   * On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject)
148 |     IRC channel,
149 |   * On the forum at [users.hoa-project.net](https://users.hoa-project.net).
150 | 
151 | ## Contribution
152 | 
153 | Do you want to contribute? Thanks! A detailed [contributor
154 | guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains
155 | everything you need to know.
156 | 
157 | ## License
158 | 
159 | Hoa is under the New BSD License (BSD-3-Clause). Please, see
160 | [`LICENSE`](https://hoa-project.net/LICENSE) for details.
161 | 


--------------------------------------------------------------------------------
/Test/Unit/Zombie.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Hoa
 5 |  *
 6 |  *
 7 |  * @license
 8 |  *
 9 |  * New BSD License
10 |  *
11 |  * Copyright © 2007-2017, Hoa community. All rights reserved.
12 |  *
13 |  * Redistribution and use in source and binary forms, with or without
14 |  * modification, are permitted provided that the following conditions are met:
15 |  *     * Redistributions of source code must retain the above copyright
16 |  *       notice, this list of conditions and the following disclaimer.
17 |  *     * Redistributions in binary form must reproduce the above copyright
18 |  *       notice, this list of conditions and the following disclaimer in the
19 |  *       documentation and/or other materials provided with the distribution.
20 |  *     * Neither the name of the Hoa nor the names of its contributors may be
21 |  *       used to endorse or promote products derived from this software without
22 |  *       specific prior written permission.
23 |  *
24 |  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 |  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 |  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 |  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 |  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 |  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 |  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 |  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 |  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 |  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 |  * POSSIBILITY OF SUCH DAMAGE.
35 |  */
36 | 
37 | namespace Hoa\Zombie\Test\Unit;
38 | 
39 | use Hoa\Test;
40 | use Hoa\Zombie as LUT;
41 | 
42 | /**
43 |  * Class \Hoa\Zombie\Test\Unit\Documentation.
44 |  *
45 |  * Test suite of the zombie class.
46 |  *
47 |  * @copyright  Copyright © 2007-2017 Hoa community
48 |  * @license    New BSD License
49 |  */
50 | class Zombie extends Test\Unit\Suite
51 | {
52 |     public function case_without_fpm()
53 |     {
54 |         $this
55 |             ->given(
56 |                 $this->function->function_exists = function ($name) {
57 |                     if ('fastcgi_finish_request' === $name) {
58 |                         return false;
59 |                     }
60 | 
61 |                     return true;
62 |                 }
63 |             )
64 |             ->exception(function () {
65 |                 LUT::fork();
66 |             })
67 |                 ->isInstanceOf('Hoa\Zombie\Exception');
68 |     }
69 | 
70 |     public function case_with_fpm()
71 |     {
72 |         $this
73 |             ->given(
74 |                 $this->function->function_exists = function ($name) {
75 |                     return true;
76 |                 },
77 |                 $this->function->fastcgi_finish_request = true
78 |             )
79 |             ->when($result = LUT::fork())
80 |                 ->boolean($result)
81 |                     ->isTrue();
82 |     }
83 | }
84 | 


--------------------------------------------------------------------------------
/Zombie.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Hoa
  5 |  *
  6 |  *
  7 |  * @license
  8 |  *
  9 |  * New BSD License
 10 |  *
 11 |  * Copyright © 2007-2017, Hoa community. All rights reserved.
 12 |  *
 13 |  * Redistribution and use in source and binary forms, with or without
 14 |  * modification, are permitted provided that the following conditions are met:
 15 |  *     * Redistributions of source code must retain the above copyright
 16 |  *       notice, this list of conditions and the following disclaimer.
 17 |  *     * Redistributions in binary form must reproduce the above copyright
 18 |  *       notice, this list of conditions and the following disclaimer in the
 19 |  *       documentation and/or other materials provided with the distribution.
 20 |  *     * Neither the name of the Hoa nor the names of its contributors may be
 21 |  *       used to endorse or promote products derived from this software without
 22 |  *       specific prior written permission.
 23 |  *
 24 |  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 25 |  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 26 |  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 27 |  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
 28 |  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 29 |  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 30 |  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 31 |  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 32 |  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 33 |  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 34 |  * POSSIBILITY OF SUCH DAMAGE.
 35 |  */
 36 | 
 37 | namespace Hoa\Zombie;
 38 | 
 39 | use Hoa\Consistency;
 40 | 
 41 | /**
 42 |  * Class \Hoa\Zombie.
 43 |  *
 44 |  * Zombie!
 45 |  *
 46 |  * @copyright  Copyright © 2007-2017 Hoa community
 47 |  * @license    New BSD License
 48 |  */
 49 | class Zombie
 50 | {
 51 |     /**
 52 |      * Test if we can start a zombie.
 53 |      *
 54 |      * @return  bool
 55 |      */
 56 |     public static function test()
 57 |     {
 58 |         return true === function_exists('fastcgi_finish_request');
 59 |     }
 60 | 
 61 |     /**
 62 |      * Try to create a zombie.
 63 |      *
 64 |      * @return  bool
 65 |      */
 66 |     public static function fork()
 67 |     {
 68 |         if (true !== static::test()) {
 69 |             throw new Exception(
 70 |                 'This program must run behind PHP-FPM to create a zombie.', 0);
 71 |         }
 72 | 
 73 |         fastcgi_finish_request();
 74 | 
 75 |         return true;
 76 |     }
 77 | 
 78 |     /**
 79 |      * Oh, why not decapitate?
 80 |      *
 81 |      * @return  void
 82 |      */
 83 |     public static function decapitate()
 84 |     {
 85 |         static::_kill();
 86 | 
 87 |         return;
 88 |     }
 89 | 
 90 |     /**
 91 |      * Maybe, we can bludgeon the zombie?
 92 |      *
 93 |      * @return  void
 94 |      */
 95 |     public static function bludgeon()
 96 |     {
 97 |         static::_kill();
 98 | 
 99 |         return;
100 |     }
101 | 
102 |     /**
103 |      * Grilled zombies, hummm!
104 |      *
105 |      * @return  void
106 |      */
107 |     public static function burn()
108 |     {
109 |         static::_kill();
110 | 
111 |         return;
112 |     }
113 | 
114 |     /**
115 |      * One… two… three… … splash!
116 |      *
117 |      * @return  void
118 |      */
119 |     public static function explode()
120 |     {
121 |         static::_kill();
122 | 
123 |         return;
124 |     }
125 | 
126 |     /**
127 |      * Would like a slice?
128 |      *
129 |      * @return  void
130 |      */
131 |     public static function cutOff()
132 |     {
133 |         static::_kill();
134 | 
135 |         return;
136 |     }
137 | 
138 |     /**
139 |      * Whatever, really kill the zombie.
140 |      *
141 |      * @return  void
142 |      */
143 |     protected static function _kill()
144 |     {
145 |         exit;
146 |     }
147 | 
148 |     /**
149 |      * Get PHP's process ID.
150 |      *
151 |      * @return  int
152 |      */
153 |     public static function getPid()
154 |     {
155 |         return getmypid();
156 |     }
157 | }
158 | 
159 | /**
160 |  * Flex entity.
161 |  */
162 | Consistency::flexEntity('Hoa\Zombie\Zombie');
163 | 


--------------------------------------------------------------------------------
/bors.toml:
--------------------------------------------------------------------------------
1 | status = [
2 |   "continuous-integration/travis-ci/push"
3 | ]
4 | timeout_sec = 1800
5 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name"       : "hoa/zombie",
 3 |     "description": "The Hoa\\Zombie library.",
 4 |     "type"       : "library",
 5 |     "keywords"   : ["library", "zombie", "processus"],
 6 |     "homepage"   : "https://hoa-project.net/",
 7 |     "license"    : "BSD-3-Clause",
 8 |     "authors"    : [
 9 |         {
10 |             "name" : "Ivan Enderlin",
11 |             "email": "ivan.enderlin@hoa-project.net"
12 |         },
13 |         {
14 |             "name"    : "Hoa community",
15 |             "homepage": "https://hoa-project.net/"
16 |         }
17 |     ],
18 |     "support": {
19 |         "email" : "support@hoa-project.net",
20 |         "irc"   : "irc://chat.freenode.net/hoaproject",
21 |         "forum" : "https://users.hoa-project.net/",
22 |         "docs"  : "https://central.hoa-project.net/Documentation/Library/Zombie",
23 |         "source": "https://central.hoa-project.net/Resource/Library/Zombie"
24 |     },
25 |     "require": {
26 |         "php"            : ">=5.5.0",
27 |         "hoa/consistency": "~1.0",
28 |         "hoa/exception"  : "~1.0"
29 |     },
30 |     "require-dev": {
31 |         "hoa/test": "~2.0"
32 |     },
33 |     "autoload": {
34 |         "psr-4": {
35 |             "Hoa\\Zombie\\": "."
36 |         }
37 |     },
38 |     "extra": {
39 |         "branch-alias": {
40 |             "dev-master": "3.x-dev"
41 |         }
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------