Mis apuntes · Aprende awk desde PHP

Se guardan solos en este navegador mientras escribes. Puedes usar Markdown. Al descargarlos, la primera línea es tu enlace personal al curso.

Lección 14 de 31 · Variables y control ✦ WebMCP implementado

-v: pasar datos desde la terminal

7 min de lectura 3 retos

Tu programa saca los errores con estado 400 o más. Mañana quieres solo los de 500. ¿Abres el fichero y cambias el número? No hace falta: con -v le pasas el dato desde la terminal, igual que a un script de PHP le pasas argumentos. El programa no se toca.

¿De dónde vienen los nombres?

-v = inglés variable
La opción de awk para crear una variable antes de que empiece el programa: -v nombre=valor. En gawk también se puede escribir largo, --assign.
ENVIRON = inglés environment (entorno)
Un array que awk rellena solo con las variables de entorno de la terminal. Es el getenv() o el $_ENV de PHP.
umbral = de lumbral, y este del latín liminaris (de limen, el escalón de la puerta)
El valor a partir del cual algo «entra». Aquí, el estado mínimo para que una visita cuente como error.
En 4 ideas
1/4

En PHP pasas un dato al script con php errores.php 400 y lo lees en $argv[1]. En awk es awk -v minimo=400 -f programa.awk access.log y dentro ya existe la variable minimo.

1 · El problema: un número escrito dentro del programa

Este programa lista los errores. El 400 está escrito dentro: es el umbral, el valor a partir del cual una visita cuenta como error.

awkprograma.awk
# En PHP: if ($campos[8] >= 400) { … }
$9 >= 400 { print $1, $7, $9 }
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

Funciona, pero cada vez que quieras otro umbral (solo los 500, o del 300 en adelante) tienes que editar el programa. Es como una receta que dijera «echa 5 gramos de sal» cuando lo que quieres es «sal al gusto»: la cantidad se decide al cocinar, no al escribir la receta.

En PHP lo resolverías con un argumento: php errores.php 500 y dentro $argv[1]. Vamos a hacer lo mismo en awk. Pero antes, el camino que se le ocurre a todo el mundo y que no funciona.

2 · Por qué no vale la variable de la terminal

En la terminal (bash) también hay variables, y se leen con $. La idea natural es crear una y usarla dentro del programa:

awkprograma.awkSolo lectura: necesita la terminal
# en la terminal:  minimo=500
# y despues:       awk '$9 >= $minimo { print $1, $7, $9 }' access.log
$9 >= $minimo { print $1, $7, $9 }
$ minimo=500
$ awk '$9 >= $minimo { print $1, $7, $9 }' access.log
198.51.100.4 /consulta 403
192.0.2.55 /bodega/ropa 200
198.51.100.4 /wp-login.php 404
198.51.100.4 /.env 404
…

Pedías los de 500 o más y salen un 403, un 200, dos 404… Sin ningún error. ¿Qué ha pasado?

¿Por qué? · En PHP no existe

¿Por qué awk no ve la variable $minimo de la terminal?

Por las comillas simples. Las pusiste (lección de ejecutar awk) justo para que bash no tocara los $1 y $9 del programa. Pues tampoco toca $minimo: a awk le llega el texto $minimo, tal cual. Es como en PHP: '$minimo' entre comillas simples no se sustituye.

Y awk lo interpreta a su manera. minimo es una variable de awk, recién nacida y vacía. Con el dólar delante es «el campo número vacío», o sea el campo 0: la línea entera. Has comparado el estado con toda la línea, como texto. Sale un resultado sin sentido y ningún aviso.

Son dos mundos separados: las variables de bash viven en la terminal y las de awk dentro del programa. -v es el puente entre los dos.

3 · -v nombre=valor

La forma buena: -v, el nombre de la variable, un = y el valor. Mira la línea de comando debajo del programa de awk: ahí está el -v minimo=400. Dentro del programa, minimo ya existe y se usa como cualquier variable, sin dólar.

PHP 8.5errores.php
<?php
// se ejecuta con: php errores.php 400
$minimo = (int) $argv[1];
foreach (file("access.log", FILE_IGNORE_NEW_LINES) as $linea) {
    $campos = preg_split('/\s+/', trim($linea));
    if ($campos[8] >= $minimo) {
        echo $campos[0], " ", $campos[6], " ", $campos[8], PHP_EOL;
    }
}
awkprograma.awk
# En PHP: if ($campos[8] >= $minimo) { … }
$9 >= minimo { print $1, $7, $9 }
$ awk -v minimo=400 -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -v minimo=400: v de variable. Crea esa variable antes de leer la primera línea, para pasarle un dato desde fuera sin tocar el programa.
  3. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  4. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

En PHP los argumentos llegan numerados ($argv[1], $argv[2]) y tú les pones nombre. En awk llegan ya con nombre: el que escribes en -v. Las reglas:

  1. -v va antes del programa (antes del -f programa.awk o de las comillas).
  2. Sin espacios alrededor del =: -v minimo=400. Con espacios, awk se para y te dice que el argumento no tiene la forma var=value.
  3. Un -v por cada variable: -v minimo=400 -v maximo=499.
  4. La variable existe desde el principio, también dentro de BEGIN.
  5. Si el valor parece un número, se compara como número; si no, como texto. Igual que un campo del log.
Escribesawk entiende¿Es lo que quieres?
$9 >= minimoEl valor de la variable minimoSí
$9 >= "minimo"La palabra «minimo», como textoNo: las comillas lo convierten en un texto fijo
$9 >= $minimoEl campo cuyo número es minimoNo: es la costumbre de PHP

4 · El mismo programa, distintos valores

Ahora lo bueno. El programa de abajo es el mismo de antes, letra por letra. Solo cambia la línea de comando: -v minimo=500.

awkprograma.awk
# En PHP: php errores.php 500
$9 >= minimo { print $1, $7, $9 }
$ awk -v minimo=500 -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -v minimo=500: v de variable. Crea esa variable antes de leer la primera línea, para pasarle un dato desde fuera sin tocar el programa.
  3. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  4. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

Con dos variables acotas por arriba y por abajo. Aquí, las respuestas de entre 1000 y 20000 bytes:

awkprograma.awk
# En PHP: if ($bytes >= $minimo && $bytes <= $maximo) { … }
$10 >= minimo && $10 <= maximo { print $7, $10 }
$ awk -v minimo=1000 -v maximo=20000 -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -v minimo=1000: v de variable. Crea esa variable antes de leer la primera línea, para pasarle un dato desde fuera sin tocar el programa.
  3. -v maximo=20000: v de variable. Crea esa variable antes de leer la primera línea, para pasarle un dato desde fuera sin tocar el programa.
  4. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  5. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

El valor también puede ser un texto. Este programa cuenta las visitas a una página, la que tú digas:

awkprograma.awk
# En PHP: if ($campos[6] === $url) { $visitas++; }
$7 == url { visitas++ }
END { printf "Visitas a %s: %d\n", url, visitas }
$ awk -v url=/login -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -v url=/login: v de variable. Crea esa variable antes de leer la primera línea, para pasarle un dato desde fuera sin tocar el programa.
  3. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  4. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

¿Y si alguien ejecuta el programa sin el -v? La variable nace vacía, como todas, y $9 >= minimo deja pasar todas las líneas. Para eso se pone un valor por defecto en BEGIN: si la variable está vacía, se le da uno. Este programa se ejecuta sin -v:

awkprograma.awk
BEGIN {
    # En PHP: $minimo = $argv[1] ?? 400;
    if (minimo == "") {
        minimo = 400
    }
}
$9 >= minimo { errores++ }
END { printf "Visitas con estado %d o mas: %d\n", minimo, errores }
$ awk -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  3. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

5 · Otras dos puertas: ENVIRON y nombre=valor

-v es la forma que usarás casi siempre. Hay otras dos que te vas a cruzar en programas de otros; basta con reconocerlas. Las dos necesitan la terminal.

ENVIRON es un array con las variables de entorno, las que en PHP lees con getenv(). Se escribe con el nombre entre corchetes y comillas. Lo que sale de ahí es texto: con + 0 te aseguras de comparar como número.

awkprograma.awkSolo lectura: necesita la terminal
# En PHP: if ($campos[8] >= (int) getenv("MINIMO")) { … }
$9 >= ENVIRON["MINIMO"] + 0 { print $1, $7, $9 }
$ MINIMO=500 awk -f programa.awk access.log
192.0.2.55 /api/ventas 500

nombre=valor entre los ficheros, sin -v. awk hace la asignación cuando llega a ese punto de la lista: después de BEGIN y antes de leer el fichero que viene detrás.

$ awk '$9 >= minimo { print $1, $7, $9 }' minimo=500 access.log
192.0.2.55 /api/ventas 500
$ awk 'BEGIN { print "En BEGIN: [" minimo "]" } END { print "En END: [" minimo "]" }' minimo=500 access.log
En BEGIN: []
En END: [500]

Sirve para dar un valor distinto a cada fichero (minimo=400 hoy.log minimo=500 ayer.log), pero en BEGIN todavía no existe, y eso despista. Por eso -v es la opción segura.

FormaDesde cuándo existeEn PHP
-v minimo=400Desde el principio (BEGIN incluido)$argv[1] o getopt()
ENVIRON["MINIMO"]Desde el principiogetenv("MINIMO")
minimo=400 entre ficherosDesde que awk llega a ese argumento (no en BEGIN)No tiene equivalente directo

La pregunta que te vas a hacer

¿Y si llamo a awk desde PHP con un dato que escribe el usuario?

Es lo que acabarás haciendo: un panel con un formulario («estado mínimo») que lanza awk sobre el log. Hay dos sitios donde ese dato puede hacer daño, y cada uno tiene su protección:

  1. La terminal. El dato va dentro de una línea de comando: escapeshellarg() siempre, para que no pueda colar otro comando.
  2. El programa awk. El dato entra con -v, como valor de una variable. Nunca concatenado dentro del texto del programa.
PHP 8.5panel.php
<?php
// el dato viene de fuera: se valida y nunca se pega dentro del programa
$minimo = $_GET["minimo"] ?? "400";
if (!ctype_digit($minimo)) {
    $minimo = "400";
}
$comando = sprintf(
    "awk -v minimo=%s -f errores.awk /var/log/nginx/access.log",
    escapeshellarg($minimo)
);
echo shell_exec($comando);
awkerrores.awkSolo lectura: lo lanza PHP en el servidor
# errores.awk: el programa no cambia nunca
$9 >= minimo { print $1, $7, $9 }

Es la misma disciplina que con SQL: la consulta (el programa) es fija y los datos viajan aparte, como parámetros.

Hora de practicar

Retos · 0/3 resueltos

Reto 1 de 3

El umbral, desde fuera

Mira la línea de comando: el programa recibe -v minimo=400. Debe imprimir la IP, la página y el estado de las visitas cuyo estado sea minimo o más, por ejemplo 198.51.100.4 /consulta 403. Ahora no imprime nada. Usa la variable, no escribas el 400 dentro. En PHP sería if ($estado >= $minimo) con $minimo = $argv[1];.

Al pulsar Comprobar, tu programa se ejecuta en tu navegador con el fichero que ves y con otro distinto que no ves: tiene que acertar con los dos.

awkprograma.awk · editable
$ awk -v minimo=400 -f programa.awk access.log
¿Qué significa esta línea?
  1. awk: el programa que lee el fichero. En tu servidor puede ser gawk (el de este curso) o mawk (el de Debian y Ubuntu).
  2. -v minimo=400: v de variable. Crea esa variable antes de leer la primera línea, para pasarle un dato desde fuera sin tocar el programa.
  3. -f programa.awk: f de file (fichero). El programa no va escrito en la línea, está guardado en el fichero programa.awk: es lo que ves en la pestaña del mismo nombre. Sin -f, el programa se escribe entre comillas simples: awk '{ print $1 }' access.log.
  4. access.log: los datos, el fichero que awk lee línea a línea. Va siempre al final y puede haber varios: los lee uno detrás de otro.

Las variantes (una línea, varios ficheros, tuberías con |) y qué formatos puede leer awk: lección Una línea o un fichero.

Resumen

Lo que te llevas de esta lección

  1. awk -v minimo=400 -f programa.awk access.log crea la variable minimo antes de empezar. Es el php errores.php 400 con su $argv[1], pero con nombre.
  2. Dentro del programa se usa sin dólar y sin comillas: $9 >= minimo. Con comillas es un texto fijo; con dólar, un campo.
  3. Una variable de bash no entra en un programa entre comillas simples, igual que '$a' no se sustituye en PHP. El puente es -v.
  4. El valor llega como dato, no como código: es el parámetro de una consulta preparada. Pegarlo en el programa es concatenar SQL.
  5. El valor por defecto va en BEGIN { if (minimo == "") { minimo = 400 } }: tu $argv[1] ?? 400.
  6. ENVIRON["NOMBRE"] es el getenv() de PHP; nombre=valor entre ficheros también asigna, pero no existe todavía en BEGIN.

Para recordarlo: «La uve va delante: -v, variable, valor»

V-v
delante del programa
Vvariable
minimo
Vvalor
=400

Tres uves para acordarte del orden: la opción -v, el nombre de la variable y su valor, pegados con un = y antes del programa. Y dentro, la variable va desnuda: ni dólar ni comillas.

Los programas se ejecutan con GNU awk 5.4.1 compilado a WebAssembly, software libre con licencia GPL-3.0. Código fuente: gawk en ftp.gnu.org · receta de compilación.