CLI, the other SAPI - PHP Amersfoort

Slides for my CLI talk at PHP Amersfoort

Transcript

1. php CLI, the other SAPI By Thijs Feryn
2. Hi, I’m Thijs
3. I’m an at Evangelist
4. I’m a at board member
5. I’m @ThijsFeryn on Twitter
6. SAPI?
7. The way you interact with PHP
9. • mod_php • FastCGI • PHP-FPM • CLI • ISAPI • GTK
10. CLI SAPI? PHP script execution via the command line interface
11. When to use
12. • In crons • For batch tasks • For worker processes • Daemons • Process control • Interaction with other binaries
14. CLI 101
15. • The PHP binary • Passing arguments • Reading from STDIN • I/O with pipes
16. php  file.php Invoking a script with the PHP binary
17. php  file.php  arg1  arg2 Passing arguments
18. Interpreting arguments <?php! echo "Number of arguments {$argc}\n";! foreach($argv as $key=>$argument){! echo "Argument # {$key}: {$argument} \n"; ! }
19. Interpreting arguments <?php! echo "Number of arguments {$argc}\n";! foreach($argv as $key=>$argument){! echo "Argument # {$key}: {$argument} \n"; ! } Argument   count Argument   array
20. Interpreting arguments $  php  args.php  arg1  arg2   Number  of  arguments  3   Argument  #  0:  args.php   Argument  #  1:  arg1   Argument  #  2:  arg2   $   The   PHP  file  is  an   argument  too
21. $_SERVER[’argc’] $_SERVER[’argv’] $argc $argv Interpreting arguments register_argc_argv
22. GETOPT
23. <?php! $arguments = getopt('ab:c::');! var_dump($arguments); GETOPT
24. GETOPT <?php! $arguments = getopt('ab:c::');! var_dump($arguments); Op8onal   value Flag   (no  value) Required   value
25. GETOPT php  getopt.php  -­‐a  -­‐b  2  -­‐c3   array(3)  {      ["a"]=>      bool(false)      ["b"]=>      string(1)  "2"      ["c"]=>      string(1)  "3"   }   No   spacing  for   op8onal   arguments
26. GETOPT Long options <?php! $arguments = getopt('',array('a rg1','arg2:','arg3::'));! var_dump($arguments);
27. GETOPT Long options php  getopt2.php  -­‐-­‐arg1  -­‐-­‐arg2  123  -­‐-­‐arg3=x   array(3)  {      ["arg1"]=>      bool(false)      ["arg2"]=>      string(3)  "123"      ["arg3"]=>      string(1)  "x"   }   Mind   the  “=”  
28. Reading from STDIN
29. 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);
30. Reading from STDIN $  cat  test.txt  |  php  stdin.php     enO   owT   eerhT   $
31. Reading from STDIN $  cat  test.txt  |  php  stdin.php     enO   owT   eerhT   $ Output   file Convert   output  to   input  with   pipes
32. Web vs CLI Web! CLI HTTP is a stateless protocol Controlable state Request/response based Controllable script execution Limited interaction Continuous interaction Execution timeouts No sessions required GET/POST/COOKIE/SESSION Arguments, STDIN, STDOUT, STDERR, exit codes
33. The PHP binary
34. 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 The PHP binary
35. Interactive mode $  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  >  
36. Interactive mode $  php  -­‐a   Interactive  shell   ! php  >  stri[TAB][TAB]   strip_tags          stripcslashes     stripslashes      stristr                 stripos                   php  >  stri   ! Tab   comple8on
37. Run code $  php  -­‐r  "echo  date('Y-­‐m-­‐d  H:i:s');"   2011-­‐03-­‐02  22:04:45   $
38. Config directory $  php  -­‐c  /custom/dir/php.ini  script.php
39. Custom ini settings $  php  -­‐d  max_execution_time=20  -­‐r  '$foo  =   ini_get("max_execution_time");   var_dump($foo);'   string(2)  "20"   $
40. Get ini settings $  php  -­‐i  |  grep  “log_”   define_syslog_variables  =>  Off  =>  Off   log_errors  =>  On  =>  On   log_errors_max_len  =>  1024  =>  1024   $ Filtering   items
41. Lint checking $  php  -­‐l  myFile.php   No  syntax  errors  detected  in  myFile.php   $ Only   checks  parse   errors
42. List modules $  php  -­‐m   [PHP  Modules]   bcmath   bz2   calendar   Core   ctype   curl   date   dba   $
43. Syntax highlighting $  php  -­‐s  helloworld.php  >  helloworld.html   $ <?php   echo  "Hello  world";
44. Syntax highlighting <?php! echo "Hello world"; <code><span style="color: #000000">! <span style="color: #0000BB">&lt;?php<br / ></span><span style="color: #007700">echo&nbsp;</span><span style="color: #DD0000">"Hello&nbsp;world"</span><span style="color: #007700">;</span>! </span>!
45. Version $  php  -­‐v   PHP  5.4.17  (cli)  (built:  Aug  25  2013   02:03:38)   Copyright  (c)  1997-­‐2013  The  PHP  Group   Zend  Engine  v2.4.0,  Copyright  (c)  1998-­‐2013   Zend  Technologies   $
46. Function reflection $  php  -­‐-­‐rf  json_encode   Function  [  <internal:json>  function   json_encode  ]  {   !    -­‐  Parameters  [2]  {          Parameter  #0  [  <required>  $value  ]          Parameter  #1  [  <optional>  $options  ]      }   }   $
47. Class reflection $  php  -­‐-­‐rc  stdclass   Class  [  <internal:Core>  class  stdClass  ]  {      -­‐  Constants  [0]  {      }      -­‐  Static  properties  [0]  {      }      -­‐  Static  methods  [0]  {      }      -­‐  Properties  [0]  {      }      -­‐  Methods  [0]  {      }   }   $
48. Extension reflection $  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  ]              }          }   ...   }  
49. Extension information $  php  -­‐-­‐ri  pdo   ! PDO   ! PDO  support  =>  enabled   PDO  drivers  =>  mysql,  sqlite,  sqlite2   $
50. Built-in webserver $  php  -­‐S  0:8080  -­‐t  /var/www  /var/www/index.php   $   PHP  5.4.17  Development  Server  started  at  Mon   Jan  13  15:35:03  2014   Listening  on  http://0:8080   Document  root  is  /var/www   Press  Ctrl-­‐C  to  quit.
51. Built-in webserver $  php  -­‐S  0:8080  -­‐t  /var/www  /var/www/index.php   $   PHP  5.4.17  Development  Server  started  at  Mon   Jan  13  15:35:03  2014   Listening  on  http://0:8080   Document  root  is  /var/www   Press  Ctrl-­‐C  to  quit. Docroot Router IP   &  port
52. <?php! if (php_sapi_name() == 'cli- server' && preg_match('/\.(?:png|jpg|jpeg| gif|css|js|ico|ttf|woff) $/', $_SERVER["REQUEST_URI"])) {! return false;! } Built-in webserver Handling   sta8c  files
53. I/O
54. Change your mindset
55. Don’t use sessions & cookies. ! Just use local variables
56. Don’t use HTTP calls in crons
57. Current directory !== webroot • Use dirname(__FILE__) • Use chdir() • Use getcwd() CLI   scripts  are   executable   everywhere
58. 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);
59. 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);
60. STDIN <?php! ! while(!feof(STDIN)){! $line = trim(fgets(STDIN));! if(strlen($line) > 0){! echo strrev($line).PHP_EOL;! }! }!
61. STDIN <?php! ! while(!feof(STDIN)){! $line = trim(fgets(STDIN));! if(strlen($line) > 0){! echo strrev($line).PHP_EOL;! }! }! Stream   that  is  opened   by  default
62. The proof $  php  -­‐r  "var_dump(STDIN);"   resource(1)  of  type  (stream)   $
63. STDOUT <?php! $handle = fopen('php://stdout','w');! fwrite($handle,'Hello world');! fclose($handle); STDOUT   ==     echo
64. STDOUT <?php! fwrite(STDOUT,'Hello world');
65. STDERR <?php! $handle = fopen('php://stderr','w');! fwrite($handle,'Serious error!');! fclose($handle);
66. STDERR <?php! fwrite(STDERR,'Serious error!');
67. Mixing STDOUT & STDERR <?php! fwrite(STDOUT,'STDOUT output'.PHP_EOL);! fwrite(STDERR,'STDERR output'.PHP_EOL); $  php  stdmix.php     STDOUT  output   STDERR  output   $
68. Mixing STDOUT & STDERR $  php  stdmix.php  >  /dev/null     STDERR  output   $ $  php  stdmix.php  &>    /dev/null   $
69. Alternative output <?php! fclose(STDOUT);! $handle = fopen(realpath(dirname(__FILE__).'/ output.txt'),'a');! echo "Hello world!".PHP_EOL;! fclose($handle); echo   output  is  wriQen   to  file
70. 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   $
71. Readline <?php! $name = readline("What's your name: ");! $location = readline("Where do you live: ");! echo PHP_EOL."Hello $name from $location\n"; $  php  readline.php     What's  your  name:  Thijs   Where  do  you  live:  Belgium   ! Hello  Thijs  from  Belgium   $
72. Symfony\Component\Console
73. Symfony console component <?php! date_default_timezone_set('Europe/Brussels');! set_time_limit(0);! require __DIR__ . ‚/../vendor/autoload.php';! ! use Symfony\Component\Console\Application;! use Symfony\Component\Console\Command\Command;! use Symfony\Component\Console\Input\InputInterface;! use Symfony\Component\Console\Output\OutputInterface;! use Symfony\Component\Console\Input\InputArgument;! use Symfony\Component\Console\Input\InputOption;! ! $app = new Application('My CLI Application', '0.1.0');! $app->addCommands(array(! new Thijs\Console\Command\TestCommand()! ));! $app->run();
74. namespace Thijs\Console\Command;! ! use Symfony\Component\Console\Command\Command;! use Symfony\Component\Console\Input\InputInterface;! use Symfony\Component\Console\Output\OutputInterface;! use Symfony\Component\Console\Input\InputArgument;! use Symfony\Component\Console\Input\InputOption;! use Symfony\Component\Console\Formatter\OutputFormatterStyle;! ! class TestCommand extends Command {! } The command class
75. protected function configure() {! $this->setName("hello")! ->setDescription("Saying hello to the world")! ->addArgument('name',InputArgument::REQUIRED,'Your name')! ->addOption(! 'yell',! null,! InputOption::VALUE_NONE,! 'If set, the task will yell in uppercase letters'! )! ->setHelp('The <info>'.$this- >getName().'<info> command says hello to the world');! } Configure the command
76. protected function execute(InputInterface $input, OutputInterface $output) {! $text = 'Hello '.$input->getArgument('name');! if($input->getOption('yell')){! $text = strtoupper($text);! }! $output->writeln($text);! } Execute the command
77. $dialog = $this->getHelperSet()->get('dialog');! while($dialog->askConfirmation(! $output,! ’<question>Continue with this action? [y/n]: </question>’,! false)){! $text = 'Hello ‚.$dialog->ask($output,! ! ! ! ! ! ! 'Who do you want to say hello to ?: ', 'world');! if($input->getOption('yell')){! $text = strtoupper($text);! }! $this->_hello[] = array($text);! } Adding dialogs
78. $output->writeln('<info>Processing input</info>');! $output->writeln('<comment>Please wait</comment>'); Adding color
79. $progress = $this->getHelperSet()->get('progress');! $progress->start($output, 50);! $i = 0;! while ($i++ < 50) {! ! $progress->advance();! usleep(50000);! }! $progress->finish(); Adding progress
80. $table = $this->getHelperSet()->get('table');! $table! ->setHeaders(array('Hello'))! ->setRows($this->_hello);! $table->render($output); Adding table output
81. Adding table output bin/console.php  hello  Thijs   Continue  with  this  action?  [y/n]:  y   Who  do  you  want  to  say  hello  to  ?:  PHP   Continue  with  this  action?  [y/n]:  y   Who  do  you  want  to  say  hello  to  ?:  ElePHPants   Continue  with  this  action?  [y/n]:  n   Processing  input   Please  wait    50/50  [============================]  100%   +-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐+   |  Hello                        |   +-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐+   |  Hello  Thijs            |   |  Hello  PHP                |   |  Hello  ElePHPants  |   +-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐-­‐+
82. Shebang
83. #!/usr/bin/php! <?php! echo "Hello world".PHP_EOL; $  chmod  +x  shebang.php   $  ./shebang.php   Hello  world   $ Shebang
84. Encore?
85. PCNTL
86. Process Control should not be enabled within a web server environment and unexpected results may happen if any Process Control functions are used within a web server environment.
87. Forking <?php! $pid = pcntl_fork();! if ($pid == -1) {! //Forking failed! } else if ($pid) {! //Parent logic! } else {! //Child logic! }
88. Forking <?php! $pid = pcntl_fork();! if ($pid == -1) {! //Forking failed! } else if ($pid) {! //Parent logic! } else {! //Child logic! } Copy   program   execu8on PID   value  determines   context PID  of  child   process
89. Forking <?php! $pid = pcntl_fork();! if ($pid == -1) {! die('could not fork');! } else if ($pid) {! 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;! }
90. Forking <?php! $pid = pcntl_fork();! if ($pid == -1) {! die('could not fork');! } else if ($pid) {! 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;! } Perform   forking Wait   for  child   termina8on
91. Signals <?php! declare(ticks = 1);! function sig_handler($signo)! {! switch ($signo) {! case SIGTERM:! echo PHP_EOL."SIGTERM".PHP_EOL;! exit();! break;! case SIGINT:! echo PHP_EOL."SIGINT".PHP_EOL;! exit();! break;! }! }! pcntl_signal(SIGTERM, "sig_handler");! pcntl_signal(SIGINT, "sig_handler");! sleep(100);
92. Signals <?php! declare(ticks = 1);! function sig_handler($signo)! {! switch ($signo) {! case SIGTERM:! echo PHP_EOL."SIGTERM".PHP_EOL;! exit();! break;! case SIGINT:! echo PHP_EOL."SIGINT".PHP_EOL;! exit();! break;! }! }! pcntl_signal(SIGTERM, "sig_handler");! pcntl_signal(SIGINT, "sig_handler");! sleep(100); Process   termina8on Process   interrup8on Catch   signals
93. POSIX process control functions
94. POSIX <?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);! }
95. POSIX <?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;! }