Stdin

PHP CLI Input/Output de la tastatura, pipe sau argumente

Feb 26, 2011 CLI PHP stderr stdin stdout

Undeva in ghidul de certificare exista un capitol dedicat pentru “streams”.

O mica parte din asta reprezinta stream-ul de input, output si cel de eroare din PHP. In C/C++ este faimoasa biblioteca stdio.h, insa putina lume stie ca se poate realiza input de la tastatura si in PHP.

Pe scurt, acest lucru se realizeaza cu PHP://STDIN, PHP://STDOUT si PHP://STDERR.

Ca sa nu fie confuz termenul de stream, subiect care ii panicheaza pe multi care studiaza pentru ZCE, el reprezinta un flux de informatie, la fel cum citesti un fisier inter sau extern folosind fopen.

Dar cum un programator intelege cel mai bine din cod, sa trecem la lucruri mai concrete.

Input

Pentru input se foloseste PHP://STDIN.

Un script care citeste de la tastatura este urmatorul:

 1#!/usr/bin/php
 2<?php
 3// initializare stream de input
 4$input = fopen('php://stdin', 'r');
 5
 6// mesaj de intampinare
 7echo 'Scrie "exit" si apoi enter pentru a termina' . PHP_EOL;
 8
 9// citire de la stream
10while($line = fgets($input, 1024)) {
11 // conditie de iesire cu tot cu terminator de rand
12 if($line == 'exit' . PHP_EOL) {
13    echo 'bye bye' . PHP_EOL;
14    break;
15 }
16 // afisare input citit de la tastatura
17 echo 'Ai scris: ' . $line . PHP_EOL;
18}
19
20// inchidere stream
21fclose($input);

Prima linie din cod este speciala pentru Linux/Unix iar utilizatorii de Windows o pot scoate.
Codul de mai sus trebuie pus intr-un fisier, de exemplu testStream.php

Fisierul trebuie sa aiba drept de executie care se poate da cu:

1chmod +x testStream.php

Apoi fisierul poate fi rulat in Linux direct cu:

1$./testStream.php

In Windows trebuie sa fie data calea catre PHP daca nu este inclusa in include path:

1>c:\php\php.exe testStream.php

Este de remarcat ca inputul este cu tot cu “\n” sau “\r\n” de asta la “exit” se testreaza cu tot cu terminator de linie (PHP_EOL). Folosesc PHP_EOL ca sa poata functiona atat pe Linux/Unix cat si pe Windows.

Output

Pentru output se foloseste PHP://STDOUT.

Dar fata de Input, output-ul este mult mai putin relevant. Practic output-ul este cel standard, care se poate realiza si cu echo sau print.

Dar in scop educational sa modificam fisierul de mai sus sa foloseasca si PHP://STDOUT.

 1#!/usr/bin/php
 2<?php
 3// initializare stream de input
 4$input = fopen('php://stdin', 'r');
 5
 6// initializare stream de output
 7$output = fopen('php://stdout', 'w');
 8
 9// mesaj de intampinare
10fwrite($output, 'Scrie "exit" si apoi enter pentru a termina' . PHP_EOL);
11
12// citire de la stream
13while($line = fgets($input, 1024)) {
14 // conditie de iesire cu tot cu terminator de rand
15 if($line == 'exit' . PHP_EOL) {
16    fwrite($output, 'bye bye' . PHP_EOL);
17    break;
18 }
19 // afisare input citit de la tastatura
20 fwrite($output, 'Ai scris: ' . $line . PHP_EOL);
21}
22
23// inchidere stream input
24fclose($input);
25
26// inchidere stream output
27fclose($output);

Practic nu este nici o schimbare in script, doar ca output-ul a fost afisat folosind PHP://STDOUT intr-un mod mai explicit.

Eroare

Un subiect mai interesant decat output-ul este stream-ul de eroare.

Practic el este relevant mai mult in mediul linux, probabil este si in windows dar eu nu stiu cum se poate capta. Daca citesti acest blog si sti cum se poate face asta lasa te rog un comentariu.

Si din nou scriptul va fi modificat ca mesajele de eroare sa foloseasca stream-ul corespunzator. Voi face ca de fiecare data cand sunt introduse mai mult de 5 caractere sa fie afisat un mesaj de eroare (imi pare rau dar nu am mai multa inspiratie acum):

 1#!/usr/bin/php
 2<?php
 3// initializare stream de input
 4$input = fopen('php://stdin', 'r');
 5
 6// initializare stream de output
 7$output = fopen('php://stdout', 'w');
 8
 9// initializare stream de eroare
10$err = fopen('php://stderr', 'w');
11
12// mesaj de intampinare
13fwrite($output, 'Scrie "exit" si apoi enter pentru a termina' . PHP_EOL);
14
15// citire de la stream
16while($line = fgets($input, 1024)) {
17 // conditie de iesire cu tot cu terminator de rand
18 if($line == 'exit' . PHP_EOL) {
19    fwrite($output, 'bye bye' . PHP_EOL);
20    break;
21 }
22
23 if(strlen($line) > 5) {
24    fwrite($err, 'ATENTIE! Inputul mai mare de 5 caractere: ' . $line);
25    continue;
26 }
27
28 // afisare input citit de la tastatura
29 fwrite($output, 'Ai scris: ' . $line . PHP_EOL);
30}
31
32// inchidere stream input
33fclose($input);
34
35// inchidere stream output
36fclose($output);
37
38// inchidere stream eroare
39fclose($err);

Implicit in Linux mesajele de eroare sunt afisate pe ecran, dar sunt scenarii cand este mai relevanta trecerea erorilor intr-un log de exemplu.

Pentru ca mesajele de eroare sa fie redirectionate catre fisier log se foloseste 2>> dupa cum urmeaza:

1$./testStream 2>>testStream.log

Input din PIPE (|)

Sa luam urmatorul scenariu: Exista rezultatul unei procesari anterioare, care contine o serie de adrese email valide dar si unele invalide. Ar trebuie facute doua fisiere: valid.txt cu adrese valide si unul invalid.txt cu adrese invalide. Adresele valide si invalide vor fi trimise catre script cu pipe.

Lista de adrese va fi simulata prin fisierul email.txt:

1valid_addres@yahoo.com
2another_valid@yahoo.co.uk
3invalid@y.c
4good@gmail.com
5invalid addres@hotmail.com
6foo

Scriptul de procesare va fi emailTest.php:

 1#!/usr/bin/php
 2<?php
 3
 4// initializare stream de input
 5$input = fopen('php://stdin', 'r');
 6
 7// initializare stream de eroare
 8$err = fopen('php://stderr', 'w');
 9
10// faza de cazurile anterioare, aici se verifica sfarsitul fisierului
11// pentru ca inputul nu se citeste de la tastatura
12while(!feof($input)) {
13 // fac trim la linie pentru a scapa de eventuali terminatoari de linie
14 $line = trim(fgets($input, 1024));
15
16 // testez adresa de email
17 if(filter_var($line, FILTER_VALIDATE_EMAIL)) {
18    // output-ul se face direct pentru ca acesta este echivalent cu
19    // stream de php://stdout
20    echo $line . PHP_EOL;
21 } else {
22    // adresele invalide sunt scrise directionate catre stream-ul de
23    // php://stderr pentru a fi interceptate ulterior
24    fputs($err, $line . PHP_EOL);
25 }
26}
27
28// inchidere stream input
29fclose($input);
30
31// inchidere stream eroare
32fclose($err);

Pentru a testa voi simula output-ul de adrese de email print comanda cat:

1cat email.txt |./emailTest.php >valid.txt 2>invalid.txt

Acum fisierele valid.txt si invalid.txt din directorul curent sunt populate cu adresele corespunzatoare.

Procesarea de acest fel este foarte utila cand exista procesari mai complexe. Practic este o alternativa la Shell Scripting (linux) sau Batch Scripting (windows), limbaje care nu sunt la fel de flexibile.

Argumente catre script

De multe ori este util sa trimitem direct argumente catre script pentru a avea functionalitate diferita de exemplu.

Diferenta fata de scenariul anterior ar fi ca numele fisierului cu adrese de mail trebuie sa vina ca argument la script.

Argumentele sunt preluate automat in variabila $argv. Este de remarcat ca de fapt primul element din array, adica $argv[0] este chiar numele scriptului!

Exemplul anterior modificat este:

 1#!/usr/bin/php
 2<?php
 3
 4// numaratoarea incepe de la 1 pentru a elimina numele scriptului
 5for ($i = 1; $i < count($argv); $i++) {
 6  // initializare stream de input
 7  $input = fopen($argv[$i], 'r');
 8
 9  // initializare stream de eroare
10  $err = fopen('php://stderr', 'w');
11
12  if(!$input) {
13   continue;
14  }
15
16  // faza de cazurile anterioare, aici se verifica sfarsitul fisierului
17  // pentru ca inputul nu se citeste de la tastatura
18  while(!feof($input)) {
19   // fac trim la linie pentru a scapa de eventuali terminatoari de linie
20   $line = trim(fgets($input, 1024));
21
22   // testez adresa de email
23   if(filter_var($line, FILTER_VALIDATE_EMAIL)) {
24     // output-ul se face direct pentru ca acesta este echivalent cu
25     // stream de php://stdout
26     echo $line . PHP_EOL;
27   } else {
28     // adresele invalide sunt scrise directionate catre stream-ul de
29     // php://stderr pentru a fi interceptate ulterior
30     fputs($err, $line . PHP_EOL);
31   }
32  }
33
34  // inchidere stream input
35  fclose($input);
36
37  // inchidere stream eroare
38  fclose($err);
39}

Pentru a rula fisierul cu argumente:

1$./argTest.php email.txt >valid.txt 2>invalid.txt