Mes: marzo 2015

Terry Pratchett ha sido uno de los grandes escritores de novelas de fantasía. Su serie más conocida Mundodisco, cuenta con 41 libros escritos en un estilo desenfadado y humorístico que parodian el género fantástico pero que a la vez encierran durísimas y mordaces críticas contra muchos aspectos de nuestra sociedad. El humor de Pratchett es reconocido como uno de los más ácidos e inteligentes a la vez que absurdos y esta mezcla es explosiva: sus libros te hacen estallar en carcajadas a la vez que reflexionar. Para mi ha sido uno de los escritores que más me ha impactado.

Son muy conocidas sus frases, sacadas tanto de sus libros como de sus charlas y hay webs que se dedican a recopilarlas. Algunas hacen gracia por si mismas, otras hacen mucha más gracia dentro del contexto del libro. En inglés, la página “L-Space Web” contiene probablemente la mayor recopilación de frases de Pratchett. En castellano es “la concha de gran A’Tuin” quien contiene otra buena colección.

Ahora que Terry Pratchett ha muerto he pensado que es el momento de hacerle un pequeño (pequeñísimo) homenaje, similar a otros que se están haciendo al estilo de “GNU Terry Pratchett”.

En mi caso he dedicido crear un middlewarwe OWIN que añade una cabecera HTTP con una cita de Terry Pratchett al azar. Las citas están extraídas de la lista contenida en L-Space Web, aunque el middleware es configurable para que puedas usar tus propias citas si lo prefieres.

El código principal del middleware es muy sencillo:

public class PratchettOwinMiddleware
{
    private readonly AppFunc _next;
    private readonly PratchettQuotesFactory _quotesFactory;
    private readonly Random _random;
    public PratchettOwinMiddleware(AppFunc next, PratchettQuotesFactory quotesFactory)
    {
        _next = next;
        _quotesFactory = quotesFactory;
        _random = new Random();
    }
 
    public async Task Invoke(IDictionary<string, object> environment)
    {
        await _next.Invoke(environment);
        var headers = environment["owin.ResponseHeaders"] as IDictionary<string, string[]>;
        var quotes = _quotesFactory.GetQuotes();
        var quote = quotes[_random.Next(0, quotes.Length)];
        headers.Add("X-Pratchett-Quote", new string[] { quote});
    }
}

Básicamente se dedica a añadir la cabecera X-Pratchett-Quote a cualquier petición que sea procesada. Para registrarlo en el pipeline de OWIN se usa un método de extensión sobre IAppBuilder definido en la clase PratchettAppBuilderExtensions:

  public static class PratchettAppBuilderExtensions
  {
      public static void UseTerryPratchett(this IAppBuilder app)
      {
          app.Use(typeof(PratchettOwinMiddleware), 
              new PratchettQuotesFactory(
                  new InternalFileQuoteParser(),
                    () =>Assembly.GetExecutingAssembly().GetManifestResourceStream("PratchettQuotes.terry_quotes.txt")));
      }
 
      public static void UseTerryPratchett(this IAppBuilder app, IQuoteParser quoteParser, string filename)
      {
          app.Use(typeof(PratchettOwinMiddleware),
              new PratchettQuotesFactory(quoteParser, () => new FileStream(filename, FileMode.Open, FileAccess.Read)));
      }
 
      public static void UseTerryPratchett(this IAppBuilder app, IQuoteParser quoteParser, Func<Stream> quotesProvider)
      {
          app.Use(typeof(PratchettOwinMiddleware), new PratchettQuotesFactory(quoteParser, quotesProvider));
      }
  }

El método está sobrecargado para admitir tus propias citas. En este caso debes pasar también una clase que implemente la interfaz IQuoteParser que indique como leer los datos del stream que contiene las citas. No se incluye ninguna implementación de dicha interfaz (bueno, se incluye una pero es interna ya que se usa para parsear los datos del fichero de citas, que está sacado literalmente de L-Space Web).

Si llamas simplemente a UseTerryPratchett() se usará el fichero de citas que está incrustado dentro del ensamblado.

El resultado lo puedes ver en esta captura de la pestaña red de Chrome:

El código fuente del proyecto lo teneis en github: https://github.com/eiximenis/PratchettQuotes

Saludos!:D

El modelo de binding que tiene WebApi es bastante más simple que el de MVC y por ello algunas tareas que en MVC eran más simples en WebApi pasan a ser un poco más complejas. Una de esas tareas es la subida de ficheros y de datos adicionales.

A diferencia de MVC donde el contenido del cuerpo de la petición puede ser inspeccionado numerosas veces (según los value providers que tengamos configurados) en WebApi el cuerpo de la petición es un stream que puede ser leído una sola vez. A nivel práctico eso implica que de todos los parámetros que pueda recibir el controlador tan solo uno puede ser puede ser enlazado con los datos del cuerpo de la petición. El resto deben ser enlazados desde otros sitios (usualmente la URL).

Así imagina que tienes el siguiente formulario que quieres enviar a un controlador:

<form method=«post» action=«@Url.Action(«Index», «Upload»)« enctype=«multipart/form-data»>
    <p>
        Name: <input type=«text» name=«Beer.Name» /> <br />
        Rating: <input type=«number» name=«Beer.Rating» /><br />
        Image: <input type=«file» name=«image» /><br />
        <input type=«submit» value=«send!» />
    </p>
</form>

En MVC te bastará con declarar un parámetro de tipo HttpPostedFileBase para el fichero y otro para el resto de valores (name y rating). El framework se encargará del resto:

En WebApi eso no es posible, ya que aquí tenemos dos parámetros (image y beer) enlazados con datos provenientes del cuerpo de la petición. Por lo tanto, en WebApi tanto los datos del fichero subido como el resto de valores deberán venir juntos (asumiendo que están todos en el cuerpo de la petición como es este ejemplo).

Además la subida de ficheros en WebApi no se gestiona enlanzando ningún parámetro del controlador, si no instanciando y usando un objeto del tipo MultipartFileStreamProvider. Esta clase lee el cuerpo de la petición y guarda el fichero en disco. Pero claro, si este objeto lee el cuerpo de la petición ya nadie más puede hacerlo en WebApi, lo que implica que los datos asociados también debe leerlos. Por suerte existe la clase derivada MultiPartFormDataStreamProvider que almacena los datos adicionales en la propiedad FormData. Así podemos tener el siguiente código en un ApiController:

[HttpPost]
[Route(«api/upload»)]
public async Task<IHttpActionResult> Upload()
{
    var folder = HostingEnvironment.MapPath(«~/Uploads»);
    var provider = new MultipartFormDataStreamProvider(folder);
    var data = await Request.Content.ReadAsMultipartAsync(provider);
    return Ok();
}

Y podemos ver como en data tenemos tanto la ubicación del fichero en disco (del servidor) puesto que ya ha sido guardado, así como una propiedad llamada FormData que es un NameValueCollection con los datos adicionales:

A partir de aquí, convertir esta NameValueCollection en un objeto tipado, ya depende de tí. P. ej. puedes usar este método de extensión:

static class NameValueCollectionExtensions
{
    public static T AsObject<T>(this NameValueCollection source, string prefix)
        where T : class, new()
    {
        var result = new T();
        string fullPrefix = string.IsNullOrEmpty(prefix) ? prefix : prefix + «.»;
        foreach (var key in source.AllKeys.Where(k => k.StartsWith(fullPrefix)).
            Select(kwp => kwp.Substring(fullPrefix.Length)))
        {
            var prop = typeof(T).GetProperty(key);
            if (prop != null && prop.CanWrite)
            {
                prop.SetValue(result, Convert.ChangeType(source[fullPrefix + key], prop.PropertyType));
            }
        }
 
 
        return result;
    }

Este método es muy limitado (no admite propiedades complejas) pero si los datos que envías junto a los ficheros son simples, te puede servir. En este caso se usaría de la siguiente manera:

var beer = data.FormData.AsObject<Beer>(«Beer»);

Y por supuesto, si necesitas soluciones más complejas que esas evalúa soluciones como Slapper.AutoMapper o similares que ya te lo dan todo hecho… no vayas por ahí reinventando la rueda (o si, vamos… eso ya es cosa tuya :P)!

Saludos!

Mes: marzo 2015

Mi (pequeño) homenaje al gran, genial e irrepetible Terry Pratchett

WebApi: Subir un fichero y datos adicionales