Cli the other SAPI confoo11
•
1 gostou•1,560 visualizações
Thijs Feryn gave a presentation on the CLI (command line interface) SAPI for PHP. The CLI SAPI allows PHP scripts to be run from the command line/terminal instead of through a web server. Some key points of the CLI SAPI include reading arguments from $argv, reading input from STDIN, writing output to STDOUT, and having full control over script execution without timeouts. The CLI SAPI is useful for tasks like cronjobs, batch processing, and applications without a web frontend.
Recomendados
Mais conteúdo relacionado
Mais procurados
Mais procurados (20)
Destaque
Destaque (20)
Semelhante a Cli the other SAPI confoo11
Semelhante a Cli the other SAPI confoo11 (20)
Mais de Combell NV
Mais de Combell NV (20)
Último
Último (20)
Cli the other SAPI confoo11
- 1. CLI, the other SAPI Confoo Thursday March 10th 2011 Montreal, Canada php Thijs Feryn Evangelist +32 (0)9 218 79 06 thijs@combellgroup.com
- 2. About me I’m an Evangelist at Combell
- 3. About me I’m a board member at PHPBenelux
- 4. I live in the wonderful city of Bruges MPBecker -‐ Bruges by Night hWp://www.flickr.com/photos/galverson2/3715965933
- 5. Follow me on Twi+er: @ThijsFeryn Give me feedback: h+p://joind.in/2852 Read my blog: h+p://blog.feryn.eu
- 7. SAPI according to Wikipedia “The Server Applica^on Programming Interface (SAPI) is the generic term used to designate direct module interfaces to web server applica^ons”
- 8. SAPI according to Wikipedia The way you interact with PHP
- 9. Common SAPIs • Apache/Apache 2 • CGI • FastCGI • ISAPI • CLI • GTK
- 10. The CLI SAPI according to php.net As of version 4.3.0, PHP supports a new SAPI type (Server Applica^on Programming Interface) named CLI which means Command Line Interface. As the name implies, this SAPI type main focus is on developing shell (or desktop as well) applica^ons with PHP
- 11. The CLI SAPI according to php.net PHP script execu^on via the command line interface
- 12. When to use • In crons • For batch tasks • For worker processes • Daemons • Process control • Interac^on with other binaries
- 13. CLI 101
- 14. CLI 101 The PHP binary Passing arguments Reading from STDIN I/O with pipes
- 15. CLI 101 Invoking a script with the PHP binary php file.php
- 16. CLI 101 Passing arguments php file.php arg1 arg2
- 17. CLI 101 interpreting arguments <?php echo "Number of arguments {$argc}n"; foreach($argv as $key=>$argument){ echo "Argument # {$key}: {$argument}n"; }
- 18. CLI 101 interpreting arguments Argument Argument count array <?php echo "Number of arguments {$argc}n"; foreach($argv as $key=>$argument){ echo "Argument # {$key}: {$argument}n"; }
- 19. CLI 101 The PHP file is an interpreting arguments argument too $ php args.php arg1 arg2 Number of arguments 3 Argument # 0: args.php Argument # 1: arg1 Argument # 2: arg2 $
- 20. CLI 101 interpreting arguments $_SERVER[‘argc’] $argc $_SERVER[‘argv’] $argv !!! register_argc_argv !!!
- 21. CLI 101 getopt <?php $arguments = getopt('ab:c::'); var_dump($arguments);
- 22. CLI 101 getopt Op^onal Flag (no value) value <?php $arguments = getopt('ab:c::'); var_dump($arguments); Required value
- 23. CLI 101 php getopt.php -‐a -‐b 2 -‐c3 array(3) { ["a"]=> No bool(false) ["b"]=> spacing for string(1) "2" op^onal ["c"]=> arguments string(1) "3" }
- 24. CLI 101 getopt: longopts <?php $arguments = getopt('',array ('arg1','arg2:','arg3::')); var_dump($arguments);
- 25. CLI 101 php getopt2.php -‐-‐arg1 -‐-‐arg2 123 -‐-‐arg3=x array(3) { ["arg1"]=> bool(false) Mind ["arg2"]=> the “=” sign string(3) "123" ["arg3"]=> string(1) "x" }
- 26. CLI 101 REading From STDIN <?php $handle = fopen('php://stdin','r'); while(!feof($handle)){ $line = trim(fgets($handle)); if(strlen($line) > 0){ echo strrev($line).PHP_EOL; } } fclose($handle);
- 27. CLI 101 $ cat test.txt | php stdin.php enO owT eerhT $
- 28. CLI 101 $ cat test.txt | php stdin.php enO owT Output Convert eerhT $ file output to input with pipes
- 29. Comparing the Apache & CLI SAPI
- 30. Comparing the Apache & CLI SAPI Web based SAPI’s • HTTP is a stateless protocol • Request/response based • Limited interac^on • Sessions & cookies as workaround • Execu^on ^meouts • Limited request/response size
- 31. Comparing the Apache & CLI SAPI CLI SAPI • Controlable state • Controlable script execu^on • Con^nuous interac^on • No need for sessions • No execu^on ^meouts
- 33. Input & output
- 34. Input & output Web CLI • $_SERVER • $_SERVER • $_GET • $argc/$argv • $_POST • $_ENV • $_COOKIE • getopt() • $_SESSION • STDIN/STDOUT/ STDERR • $_ENV
- 36. Change your mindset Don’t use sessions & cookies Just use local variables
- 37. Change your mindset Don’t “get” your input Just “read” it
- 38. Change your mindset Don’t bundle your output You can use distributed output
- 39. Change your mindset If you don’t need HTTP, use CLI E.g. cronjobs Avoid overhead
- 40. Change your mindset Current directory != webroot CLI scripts are ➡Use dirname(__FILE__) executable everywhere ➡Use chdir() ➡Use getcwd()
- 41. The PHP binary php
- 42. The PHP binary Usage: php [options] [-‐f] <file> [-‐-‐] [args...] php [options] -‐r <code> [-‐-‐] [args...] php [options] [-‐B <begin_code>] -‐R <code> [-‐E <end_code>] [-‐-‐] [args...] php [options] [-‐B <begin_code>] -‐F <file> [-‐E <end_code>] [-‐-‐] [args...] php [options] -‐-‐ [args...] php [options] -‐a
- 43. InteracOve mode (-‐a) $ php -‐a Interactive shell php > echo 5+8; 13 php > function addTwo($n) php > { php { return $n + 2; php { } php > var_dump(addtwo(2)); int(4) php >
- 44. InteracOve mode (-‐a) $ php -‐a Tab Interactive shell comple^on php > stri[TAB][TAB] strip_tags stripcslashes stripslashes stristr stripos php > stri
- 45. Run code (-‐r) $ php -‐r "echo date('Y-‐m-‐d H:i:s');" 2011-‐03-‐02 22:04:45 $
- 46. Config directory (-‐c) $ php -‐c /custom/dir/php.ini script.php
- 47. Define custom INI seSng (-‐d) $ php -‐d max_execution_time=20 -‐r '$foo = ini_get("max_execution_time"); var_dump ($foo);' string(2) "20" $
- 48. Get INI informaOon (-‐i) Filtering items $ php -‐i | grep “log_” define_syslog_variables => Off => Off log_errors => On => On log_errors_max_len => 1024 => 1024 $
- 49. Syntax/lint check (-‐l) Only checks parse errors $ php -‐l myFile.php No syntax errors detected in myFile.php $
- 50. Module list (-‐m) $ php -‐m [PHP Modules] bcmath bz2 calendar Core ctype curl date dba $
- 51. Syntax highlighOng (-‐s) <?php echo "Hello world"; $ php -‐s helloworld.php > helloworld.html $
- 52. Syntax highlighOng (-‐s) <code><span style="color: #000000"> <span style="color: #0000BB"><?php<br / ></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Hello world"</span><span style="color: #007700">;</span> </span> <?php echo "Hello world";
- 53. Version info (-‐v) $ php -‐v PHP 5.3.3-‐1ubuntu9.3 with Suhosin-‐Patch (cli) (built: Jan 12 2011 16:07:38) Copyright (c) 1997-‐2009 The PHP Group Zend Engine v2.3.0, Copyright (c) 1998-‐2010 Zend Technologies $
- 54. FuncOon reflecOon (-‐-‐rf) $ php -‐-‐rf json_encode Function [ <internal:json> function json_encode ] { -‐ Parameters [2] { Parameter #0 [ <required> $value ] Parameter #1 [ <optional> $options ] } } $
- 55. Class reflecOon (-‐-‐rf) $ php -‐-‐rc stdclass Class [ <internal:Core> class stdClass ] { -‐ Constants [0] { } -‐ Static properties [0] { } -‐ Static methods [0] { } -‐ Properties [0] { } -‐ Methods [0] { } } $
- 56. Extension reflecOon (-‐-‐re) $ php -‐-‐re json Extension [ <persistent> extension #20 json version 1.2.1 ] { ... -‐ Functions { Function [ <internal:json> function json_encode ] { -‐ Parameters [2] { Parameter #0 [ <required> $value ] Parameter #1 [ <optional> $options ] } } ... }
- 57. Extension INI informaOon (-‐-‐ri) $ php -‐-‐ri pdo PDO PDO support => enabled PDO drivers => mysql, sqlite, sqlite2 $
- 58. Back on track
- 59. Back to I/O
- 60. STDIN <?php $handle = fopen('php://stdin','r'); while(!feof($handle)){ $line = trim(fgets($handle)); if(strlen($line) > 0){ echo strrev($line).PHP_EOL; } } fclose($handle);
- 61. STDIN <?php $handle = fopen('php://stdin','r'); while(!feof($handle)){ $line = trim(fgets($handle)); if(strlen($line) > 0){ echo strrev($line).PHP_EOL; } } fclose($handle);
- 62. STDIN <?php while(!feof(STDIN)){ $line = trim(fgets(STDIN)); if(strlen($line) > 0){ echo strrev($line).PHP_EOL; } }
- 63. STDIN Stream that is opened <?php by default while(!feof(STDIN)){ $line = trim(fgets(STDIN)); if(strlen($line) > 0){ echo strrev($line).PHP_EOL; } }
- 64. STDIN The Stream that is opened proof ! by default $ php -‐r "var_dump(STDIN);" resource(1) of type (stream) $
- 66. Wordcount example $ cat wordcount.txt Canada Thijs Canada Thijs Thijs Confoo $ cat wordcount.txt | php wordcount.php Canada: 2 Confoo: 1 Thijs: 3 $
- 67. STDOUT STDOUT == echo <?php $handle = fopen('php://stdout','w'); fwrite($handle,'Hello world'); fclose($handle);
- 69. STDERR <?php $handle = fopen('php://stderr','w'); fwrite($handle,'Serious error!'); fclose($handle);
- 71. Mixing STDOUT & STDERR <?php fwrite(STDOUT,'STDOUT output'.PHP_EOL); fwrite(STDERR,'STDERR output'.PHP_EOL); $ php stdmix.php STDOUT output STDERR output $
- 72. Mixing STDOUT & STDERR <?php Looks fwrite(STDOUT,'STDOUT output'.PHP_EOL); the same fwrite(STDERR,'STDERR output'.PHP_EOL); $ php stdmix.php STDOUT output STDERR output $
- 73. Mixing STDOUT & STDERR $ php stdmix.php > /dev/null STDERR output $ $ php stdmix.php &> /dev/null $
- 74. Mixing STDOUT & STDERR STDOUT is caught $ php stdmix.php > /dev/null STDOUT STDERR output $ & STDERR are caught $ php stdmix.php &> /dev/null $
- 76. AlternaOve output <?php fclose(STDOUT); $handle = fopen(realpath(dirname(__FILE__).'/ output.txt'),'a'); echo "Hello world!".PHP_EOL; fclose($handle); echo output is wriWen to file
- 77. Piping $ php -‐r 'for($i=0;$i<10;$i++) echo $i.PHP_EOL;' 0 1 2 3 4 5 6 7 8 9 $ php -‐r 'for($i=0;$i<10;$i++) echo $i.PHP_EOL;' | wc -‐l 10 $
- 78. Readline <?php $name = readline("What's your name: "); $location = readline("Where do you live: "); echo PHP_EOL."Hello $name from $locationn"; $ php readline.php What's your name: Thijs Where do you live: Belgium Hello Thijs from Belgium $
- 79. Shebang ! #!/usr/bin/php <?php echo "Hello world".PHP_EOL; $ chmod +x shebang.php $ ./shebang.php Hello world $
- 80. Encore
- 81. PCNTL according to php.net Process Control support in PHP implements the Unix style of process crea^on, program execu^on, signal handling and process termina^on.
- 82. Process Control should not be enabled within a web server environment and unexpected results may happen if any Process Control func^ons are used within a web server environment.
- 83. Forking according to Wikipedia In compu^ng, when a process forks, it creates a copy of itself
- 84. Forking PID value determines context Copy <?php program $pid = pcntl_fork(); if ($pid == -1) { execu^on //Forking failed } else if ($pid) { //Parent logic } else { PID of child //Child logic } process
- 86. Forking Perform forking <?php $pid = pcntl_fork(); if ($pid == -1) { die('could not fork'); Wait for child } else if ($pid) { termina^on echo "[parent] Starting".PHP_EOL; pcntl_wait($status); echo "[parent] Exiting".PHP_EOL; } else { echo "[child] Starting".PHP_EOL; for($i=0;$i<3;$i++){ echo "[child] Loop $i".PHP_EOL; sleep(1); } echo "[child] Exiting".PHP_EOL; exit; }
- 87. Signals A signal is a limited form of inter-‐process communica^on used in Unix, Unix-‐like, and other POSIX-‐compliant opera^ng systems. Essen^ally it is an asynchronous no^fica^on sent to a process in order to no^fy it of an event that occurred.
- 89. Signals <?php declare(ticks = 1); Process termina^on function sig_handler($signo) { switch ($signo) { case SIGTERM: Process echo PHP_EOL."SIGTERM".PHP_EOL; exit(); break; case SIGINT: interrup^on echo PHP_EOL."SIGINT".PHP_EOL; exit(); break; Catch signals } } pcntl_signal(SIGTERM, "sig_handler"); pcntl_signal(SIGINT, "sig_handler"); sleep(100);
- 90. POSIX process control funcOons <?php echo "[prefork] PID: ".posix_getpid ().", parent PID: ".posix_getppid().PHP_EOL; $pid = pcntl_fork(); if ($pid == -1) { die('could not fork'); } else if ($pid == 0) { echo "[child] PID: ".posix_getpid ().", parent PID: ".posix_getppid().PHP_EOL; exit; } else { echo "[parent] PID: ".posix_getpid ().", parent PID: ".posix_getppid().PHP_EOL; pcntl_wait($status); }
- 91. Parent PID Prefork PID POSIX process c== funcOons of parent ontrol == <?php session PID parent PID echo "[prefork] PID: ".posix_getpid ().", parent PID: ".posix_getppid().PHP_EOL; $pid = pcntl_fork(); if ($pid == -1) { die('could not fork'); child PID } else if ($pid == 0) { child PID echo "[child] PID: ".posix_getpid ().", parent PID: ".posix_getppid().PHP_EOL; exit; parent } else { PID echo "[parent] PID: ".posix_getpid ().", parent PID: ".posix_getppid().PHP_EOL; pcntl_wait($status); }
- 92. POSIX process control funcOons <?php $pid=pcntl_fork(); if ($pid == -1) { die("could not fork"); } else if ($pid) { $exists = posix_kill($pid,0)?'still':'no longer'; echo "[parent] Child process $pid $exists exists".PHP_EOL; echo "[parent] Killing child process $pid".PHP_EOL; posix_kill($pid,SIGTERM); echo "[parent] Child process $pid killed".PHP_EOL; pcntl_wait($status); $exists = posix_kill($pid,0)?'still':'no longer'; echo "[parent] Child process $pid $exists exists".PHP_EOL; } else { while(true){ sleep(100); } exit; }
- 93. POSIX process control funcOons “KILL 0” checks <?php $pid=pcntl_fork(); existence if ($pid == -1) { die("could not fork"); } else if ($pid) { Send SIGTERM $exists = posix_kill($pid,0)?'still':'no longer'; echo "[parent] Child process $pid $exists exists".PHP_EOL; signal echo "[parent] Killing child process $pid".PHP_EOL; posix_kill($pid,SIGTERM); echo "[parent] Child process $pid killed".PHP_EOL; pcntl_wait($status); $exists = posix_kill($pid,0)?'still':'no longer'; echo "[parent] Child process $pid $exists exists".PHP_EOL; } else { while(true){ Child process sleep(100); } is dead exit; }
- 94. Some PCNTL guidelines ✓Detect your CWD ✓Use PID files ✓Control you file privileges ✓Detach you session ✓Avoid rogue child processes ✓Cleanup your garbage
- 95. Talk dedicated to process control Check this guy out ! in PHP Jeroen Keppens: @jkeppens http://www.slideshare.net/jkeppens/php-‐in-‐the-‐dark
- 97. Q&A
- 98. Thanks !