En los títulos y los textos vais a encontrar unas cuantas citaciones cinematográficas (y si, soy un cinéfilo). Si no os interesan podéis fingir no verlas, ya que no son fundamentales para la comprensión de los post...

Este blog es la versión en Español de mi blog en Italiano L'arte della programmazione in C. Espero que mis traducciones sean comprensibles...

domingo, 6 de noviembre de 2016

El gran lighttpd
cómo escribir un módulo lighttpd en C - pt.3

    El Nota: ¿Seguro que no le importará? 
    Bunny: A él no le importa nada. Es un nihilista.     
    El Nota: Eso debe ser agotador.

, un poco agotados hemos llegado al último capítulo, hoy vamos a escribir el código de nuestro mini módulo lighttpd. Vaya, muy agotador para El Nota...
...estoy agotado...
Pero antes veamos un momento cómo está estructurado un módulo. Aquí hay una pequeño esquema descriptivo (extracto de nuestro mod_helloworld.c creado en el post anterior: ¡volver inmediatamente a leer el post anterior!):
// init the plugin data
INIT_FUNC(mod_helloworld_init) {
    ...
}

// destroy the plugin data
FREE_FUNC(mod_helloworld_free) {
    ...
}

// handle plugin config and check values
SETDEFAULTS_FUNC(mod_helloworld_set_defaults) {
    ...
}

// handle uri
URIHANDLER_FUNC(mod_helloworld_uri_handler) {
    ...
}

// this function is called at dlopen() time and inits the callbacks
int mod_helloworld_plugin_init(plugin *p) {
    p->version          = LIGHTTPD_VERSION_ID;
    p->name             = buffer_init_string("helloworld");
    p->init             = mod_helloworld_init;
    p->handle_uri_clean = mod_helloworld_uri_handler;
    p->set_defaults     = mod_helloworld_set_defaults;
    p->cleanup          = mod_helloworld_free;
    p->data             = NULL;
    return 0;
}
Se puede notar el uso de unas macros (amablemente proporcionadas por el entorno de desarrollo lighttpd) para crear unas callback con las que inicializar una estructura plugin que luego lighttpd utilizará para gestionar el nuestro módulo cada vez que una petición HTTP pida de usarlo. Para aquellos que quieran profundizar el argumento callback ya ha sido ampliamente descrito aquí y aquí (supongo que ya habéis leído esos post... ¿o no?).

Entonces, ¿qué partes de nuestro módulo tenemos que cambiar para que, usándolo, nos escriba "Hello, world!" en el navegador? Dado que el problema es bastante simple, también el código no será muy largo y complejo: sólo tendremos que cambiar la callback mod_helloworld_uri_handler  de la siguiente manera:
URIHANDLER_FUNC(mod_helloworld_uri_handler)
{
    plugin_data *p = p_d;
    UNUSED(srv);

    // test modo (return si error)
    if (con->mode != DIRECT)
        return HANDLER_GO_ON;

    // test uri path (return si error)
    if (con->uri.path->used == 0)
        return HANDLER_GO_ON;

    mod_helloworld_patch_connection(srv, con, p);

    // test handler (return si error)
    if (con->uri.path->ptr && strstr(con->uri.path->ptr, "helloworld")) {
        // escribe buffer
        buffer *b = chunkqueue_get_append_buffer(con->write_queue);
        BUFFER_APPEND_STRING_CONST(b, "<big>Hello, world!</big>");

        // send header
        response_header_overwrite(srv, con, CONST_STR_LEN("Content-Type"), CONST_STR_LEN("text/html"));
        con->http_status = 200;
        con->file_finished = 1;

        // handling terminado
        return HANDLER_FINISHED;
    }
    else
        return HANDLER_GO_ON;
}
Ok, como se nota es ampliamente comentado y así se auto-explica, por lo cual no voy a detenerme sobre las instrucciones y/o grupos de instrucciones (¡leer los comentarios! ¡Están ahí para eso!), pero voy a añadir, solamente, algunos detalles estructurales.

Algunas partes están idénticas a la callback original (pero he añadido algunos comentarios), y son típicas de la estructura del código lighttpd: por no complicar el asunto no hablaré de estas partes. Sin embargo, podéis confiar en ellas porque lighttpd está escrito y funciona como debería.

La parte realmente nueva che he escrito es la que empieza con el comentario "test handler (return si error)", donde se testea si el URI pasado al navegador contiene el nombre del módulo y, en ese caso, ejecuta lo que queremos: copia en un buffer el texto "Hello, world!" y lo envía como respuesta a la petición. Así que si escribimos en la barra de direcciones de Firefox, Chrome, Opera (o cualquier otro navegador menos IE, por favor...)
http://127.0.0.1/helloworld
tendremo como respuesta en el browser:
Hello, world!
He escrito 127.0.0.1 (y se hubiera podido escribir localhost) porque, por supuesto, la primera prueba la haremos de forma local. Si luego queréis abrir vuestro equipo hacia el mundo exterior y utilizarlo como un Web Server real (en una red local o Internet) podéis repetir el test usando la vuestra dirección IP pública y obtendréis el mismo resultado. ¡El módulo funciona!

El código que acabo de enseñar lo he escrito y probado con lighttpd 1.4.33. Si utilizáis una versión más reciente (de la 1.4.36 en adelante) descubriréis que algo ha cambiado a nivel de gestión de buffer, por lo que, por ejemplo, las líneas:  
if (con->uri.path->used == 0)
...
buffer *buf = chunkqueue_get_append_buffer(con->write_queue);
tienen que cambiar en:   
if (buffer_is_empty(con->uri.path))
...
buffer *buf = buffer_init();
pero estos son detalles. En futuro, según lo prometido, os propondré algún módulo más sofisticado, con cambios también en las otras callback, pero esto es suficiente por el momento, no quiero decir más de la cuenta, si no nos cansaremos como El Nota...

¡Hasta el próximo post!

martes, 11 de octubre de 2016

El gran lighttpd
cómo escribir un módulo lighttpd en C - pt.2

El Nota: Sabes, esto... esto es un caso muy, muy complicado, Maude. Un montón de input y de output. Afortunadamente estoy siguiendo un régimen de drogas bastante estricto para mantener la mente..., ya sabes...: ágil.
Entonces: la buena noticia es que para escribir un módulo lighttpd no estáis obligados a seguir el mismo régimen de El Nota... la mala noticia es que se necesita un poco de esfuerzo, pero será mucho más fácil después de leer este post (y el anterior, por supuesto... ¿que no lo habéis leído? ¡Pero esta es la segunda parte!).
cara de "¡Ahora se cómo se escribe un módulo lighttpd!"
Entonces, ¿dónde estábamos? Hemos instalado lighttpd en nuestro sistema, hemos creado un entorno de desarrollo descargando y descomprimiendo el tar de instalación encontrado en la web oficial de lighttpd (acordarse de crear el entorno utilizando la misma versión de la que ya está instalada en el sistema). La compilación y la instalación de la versión descargada ha dado (espero) buenos resultados, así que estamos listos para escribir el nuestro módulo.

En primer lugar elegimos un nombre y una acción... va a ser un clásico: le llamaremos mod_helloworld y el módulo escribirá en el browser la frase "Hello, world!" (¡Muy, pero muy, original!).

Abrimos un terminal de Linux, entramos en la
root-directory del entorno de desarrollo y ejecutamos los siguientes comandos (que he enumerado para describirlos uno por uno):
 1. sudo gedit /etc/lighttpd/lighttpd.conf
 2. gedit src/Makefile.am     
 3. cp src/mod_skeleton.c src/mod_helloworld.c 
 4. gedit src/mod_helloworld.c    
 5. ./autogen.sh
 6. ./configure
 7. make
 8. sudo make install
 9. sudo cp /usr/local/lib/mod_helloworld.so /usr/lib/lighttpd
10. sudo /etc/init.d/lighttpd restart
Entonces: con 1. editamos (con gedit, pluma, vim, geany... o con lo que os gusta más), el file de configuración lighttpd para añadir a la lista de módulos instalados el nuestro nuevo módulo: buscad la lista "server.modules" y insertad después de el último módulo, el nuevo. Una vez echo esto el aspecto de la lista será así
server.modules = (
    "mod_access",
    "mod_alias",
    "mod_compress",
    "mod_redirect",
    "mod_helloworld",
)
Con 2. editamos el file Makefile.am del package. En comparación con el package original estamos añadiendo un módulo, por lo que hay que buscar el último módulo estándar presente (normalmente es mod_accesslog). Nos encontraremos con cuatro líneas de este tipo:
lib_LTLIBRARIES += mod_accesslog.la
mod_accesslog_la_SOURCES = mod_accesslog.c
mod_accesslog_la_LDFLAGS = -module -export-dynamic -avoid-version -no-undefined
mod_accesslog_la_LIBADD = $(common_libadd) 
Copiamos estas líneas y las pegamos inmediatamente a continuación, sustituiendo en las NUEVAS cuatro lineas mod_accesslog con mod_helloworld. Guardamos y salimos: ahora el nuestro Makefile.am está listo para manejar también el nuevo módulo. Las líneas añadidas serán estas:
lib_LTLIBRARIES += mod_helloworld.la
mod_helloworld_la_SOURCES = mod_helloworld.c
mod_helloworld_la_LDFLAGS = -module -export-dynamic -avoid-version -no-undefined
mod_helloworld_la_LIBADD = $(common_libadd)
Con 3. copiamos el file mod_skeleton.c en un nuevo file che llamaremos mod_helloworld.c: mod_skeleton.c es untemplate file que contiene el esqueleto básico de un módulo: este file nos lo proporcionan amablemente los excelentes desarrolladores de lighttpd para facilitarnos el desarrollo de nuevos módulos.

Con 4. editamos mod_helloworld.c y, con un comando de sustitución global,  cambiamos todas las recurrencias de la palabra skeleton en helloworld. Por el momento guardamos el file así como está y salimos del editor.

Con la secuencia 5.6.7.8. (¿ya vista en el post anterior, os acordáis?) compilamos e instalamos el nuevo módulo. Es posible que en el paso 6. (la configuración) el proceso os diga dice que no encontra algunas librerias: normalmente el error se resuelve usando:
sudo apt-get install libpcre3-dev libbz2-dev
y repitiendo, luego, el punto 6.

Con 9. copiamo el nuevo módulo generado (que tiene la forma de una librería dinámica, una .so) en la directory de sistema que contiene los módulos lighttpd.
Con 10., finalmente, reiniciamos lighttpd y, si no aparece ningún error, el nuestro Web Server ya está listo para utilizar el nuevo módulo (que, por el momento, está medio vacío: como se ha mencionado anteriormente es sólo el esqueleto de un módulo).

¿Que nos falta en este punto? Bueno, obviamente, tenemos que añadir un poco de código al nuestro módulo para que él haga algo (en este caso, mostrarnos un bonito
"Hello, world!"). Pero esto lo veremos en el próximo episodio, y, como siempre, no contengáis la respiración esperando...

¡Hasta el próximo post!

domingo, 18 de septiembre de 2016

El gran lighttpd
cómo escribir un módulo lighttpd en C - pt.1

Policía: ¿Y qué había en su maletín?
El Nota: Eh, papeles, solo papeles. Ya saben, solo mis papeles. Papeles del trabajo.
Policía: ¿Y a qué se dedica, señor?
El Nota: Estoy desempleado.
Vale, a menos que no os interese hacer el mismo trabajo del legendario El Nota (The Dude), es una buena idea tener un know-how valioso. Este es un post de alto valor añadido, y lo es simplemente considerando la ley de la oferta y la demanda: vamos a hablar de un tema que no dispone de una base de conocimientos amplia, entonces esto es un post valioso.
...me gustaría escribir un módulo, pero estoy un poco cansado...
Aquí ya habíamos visto hace tiempo (y os invito a releerlo) cómo escribir un módulo para Apache. Apache es un Web Server un súper popular (el más popular) y tiene una gran base de desarrolladores internos (Apache Software Foundation) y externos (profesionales y aficionados que escriben los más variados tipos de módulos). Gracias a esto se encuentra en la red una gran cantidad de documentación y guías, tanto oficiales (de nuevo la Apache Software Foundation) que no (sitios técnicos, bloggers como yo, etc.). Escribir un módulo Apache no es fácil, pero, con todo el apoyo disponible, no es una misión imposible.

Y llegamos a lighttpd: es un Web Server popular (pero mucho menos que Apache) y con características técnicas de primera clase: tiene un rendimiento comparable al de Apache, pero es mucho más ligero: poca carga de la CPU, bajo uso de memoria, etc. Prácticamente es un must para sistemas embeddeded o, más en general, para sistemas que necesitan alto rendimiento utilizando pocos recursos. Desafortunadamente lighttpd no tiene detrás una grande organización de desarrollo, y, en proporción a la menor popularidad, ni siquiera tiene un gran ejército de profesionales y aficionados que trabajan en ello. Gracias a esto NO se encuentra en la red una gran cantidad de documentación y guías, tanto oficiales que no. Escribir un módulo lighttpd no es fácil, y, con el escaso apoyo disponible, es una misión complicada.

En concreto: lighttpd es un gran producto escrito y mantenido por una pequeña comunidad de excelentes programadores, pero, al no tener detrás de una gran organización, se pierde un poco en los detalles: con más documentación y guías oficiales aumentaría la popularidad, lo que aumentaría también la comunidad de usuarios/desarrolladores (y por lo tanto la documentación no oficial), y, en definitiva, aumentaría el éxito del producto. Pero esto no pasa y entonces nos enfrentamos a un caso clásico de síndrome del perro que se muerde la cola.

lighttpd está en constante evolución, con rendimiento y fiabilidad en aumento, pero, por la falta de detalles mencionada antes, puede pasar que, entre una release y la otra, se olvide la retrocompatibilidad y se introduzcan cambios en la API de programación que invalidan muchos de los módulos (laboriosamente) escritos por desarrolladores externos (¡me pasó a mí con un módulo que escribí para la rel.1.4.33 y que con la rel.1.4.36 dejó de funcionar!).

Bueno, sin hablar más: vamos a escribir un módulo elemental para lighttpd, que será una buena base para escribir módulos más complejos (sobre los cuales os daré algunos consejos en futuros post). La primera actividad es, por supuesto, instalar lighttpd en el PC (y, si estaba instalado, quitar primero Apache). Buscando, con nuestro amigo Google, una de las muchas guías (como esta) para convertir un PC en un server LLMP (o WLMP) (no voy a describir el procedimiento para no alargar demasiado el discurso, pero, os lo garantizo, es bastante simple). Obviamente, al final del procedimiento hay que comprobar si el servidor Web funciona correctamente (por lo general las guías te dicen cómo hacerlo).

A continuación, hay que instalar lo necesario para desarrollar nuestro módulo. Las siguientes instrucciones son (por supuesto) para Linux. Para otros sistemas de la familia UNIX (BSD, OS X, etc.) el procedimiento se adapta de forma intuitiva, mientras que, por ese otro sistema que ni siquiera quiero mencionar (comienza en W...), lo siento pero tendréis que valeros vosotros mismos (si lo conoces lo evitas, y yo, os lo aseguro, lo conozco bien).

Entonces: descargaros de la Web oficial de lighttpd el tar de desarrollo correspondiente a la versión que acabais de instalar en el sistema (están disponibles también los tar de versiones anteriores a la última). Este tar sirve para crear en el sistema un entorno adecuado para el desarrollo y la instalación de nuevos módulos. Descomprimid (donde quieran) el tar, entren en la directory creada y intentad compilar e instalar la release (lo sé, es la misma versión que acabáis de instalar el sistema, pero este paso sirve para determinar si el sistema de desarrollo funciona correctamente). Suponiendo de utilizar la versión 1.4.33 escribiremos:
    tar zxvf lighttpd-1.4.33.tar.gz
    cd lighttpd-1.4.33
    ./autogen.sh
    ./configure
    make
    sudo make install
    sudo /etc/init.d/lighttpd restart
Comprueben si el Web Server sigue funcionando (de la misma manera utilizada en la primera instalación) y, si todo está bien, estamos listos para escribir/compilar/instalar el nuestro nuevo módulo. Pero esto lo veremos en el próximo episodio...

¡Hasta el próximo post!