# Guía de implementación del complemento Pipes de &kopete;

A partir de &kopete; 1.0, el complemento Pipes forma parte de &kopete;. Pipes permite redireccionar mensajes entrantes o salientes a través de un script o ejecutable externo. Los mensajes entrantes se redireccionarán a través del ejecutable antes de que lleguen a su ventana de charla, mientras que los mensajes salientes se redireccionarán a través del ejecutable antes de que se envíen por Internet. Pipes puede recibir texto de cualquiera de las siguientes formas:

Cuerpo en texto sin formato

  cuerpo del mensaje en texto &ascii; sin formato

cuerpo en &html;

  cuerpo del mensaje en &html;, como si su interlocutor le hubiera enviado HTML, el cual se procesará en la ventana de charla

mensaje completo en &xml;

  Documento &xml; que describe todas las características del mensaje, incluido el cuerpo, en &html;.

Dicho documento describe las características específicas del formato &xml; y cómo escribir un programa que pueda manejarlo.

## Salida &xml;

Este es un ejemplo de lo que recibirá un programa en su flujo de entrada estándar:

    <?xml version="1.0" encoding="ISO-8859-1"?>
    <message subject=""
            route="outbound"
            importance="1"
            formattedTimestamp="11:06:46 am"
            timestamp="Sat Dec 1 11:06:46 2007"
            type="normal"
            mainContactId="spacemonkey1234"
            time="11:06 am" >
            <from>
                    <contact contactId="tdurden"
                            protocolIcon="aim_protocol"
                            userPhoto="/home/kde-devel/.kde4/share/apps/kopete/oscarpictures/tdurden.jpg" >
                            <contactDisplayName dir="ltr" text="tdurden" />
                            <metaContactDisplayName dir="ltr"
                                    text="Tyler" />
                    </contact>
            </from>
            <to>
                    <contact contactId="spacemonkey1234"
                            protocolIcon="aim_protocol"
                            userPhoto="/home/kde-devel/.kde4/share/apps/kopete/avatars/User/7e542903e0ac7519a7496e85f5a5b99d.png" >
                            <contactDisplayName dir="ltr" text="spacemonkey1234" />
                            <metaContactDisplayName dir="ltr" text="Robert Paulson" />
                    </contact>
                    </to>
            <body dir="ltr"
                    bgcolor="#000000"
                    color="#000000" >
                    &lt;span style=" color:#000000;"
    >hey&lt;/span
    ></body>
    </message>

Este &xml; se basa ligeramente en el XSD utilizado para los estilos de charla que se encuentran en la página web de Kopete. Este código representa un mensaje. Cabe destacar varias cuestiones:

- El atributo «timestamp» del elemento «message» está en el formato estándar ISO 8601.

- El atributo «protocolIcon» del elemento «contact» se selecciona así:

  1. Si el objeto Contacto tiene determinada la propiedad de foto, se utiliza esa ruta.

  2. En caso contrario, se solicita al meta-contacto del contacto una ruta para la imagen y esa será la que se utilice independientemente de si es nula o no.

- En caso de que no se hayan determinado en Kopete, los atributos «color» y «bgcolor» del elemento «body» serán cadenas vacías. Están en formato de color web.

- El contenido del elemento «body» presenta el código de escape para "<" así que no se confunde con la estructura &xml; real. Evidentemente, para interpretar de forma correcta el cuerpo como HTML, habría que convertir los "&lt;"s en "<"s.

## Entrada &xml;

Su programa recibirá &xml; en su flujo de entrada estándar, tendrá la posibilidad de modificarlo y después debe devolverlo a &kopete; por medio de su flujo de salida estándar. Si su programa modifica los siguientes elementos, el conocimiento interno que tiene &kopete; sobre el mensaje se modificará para reflejar sus cambios.

- el atributo «timestamp» de «message», pero no otros atributos de tiempo

- el atributo «subject» de «message»

- el atributo «type» de «message»

- el atributo «importance» de «message»

- el atributo «color» de «body». A este se le suele asignar un número de color web, pero se le puede asignar un nombre. QColor en Qt 4 acepta los nombres definidos por SVG, así que son los únicos nombres que se pueden utilizar.

- el atributo «bgcolor» de «body»: mismo comportamiento que «color»

- contenido del elemento «body»

Si modifica algún elemento, o sus atributos, que no se haya mencionado anteriormente, los cambios que realice en dicho elemento no tendrán efecto.

## Valores posibles

Algunos atributos tienen ciertos valores posibles. La salida del complemento Pipes siempre tendrá valores válidos. Si su programa decide modificar dichos atributos, deben seguir siendo válidos. En caso contrario, el comportamiento de &kopete; será indefinido.

El atributo «route» del elemento «message»

  debe ser «inbound», «outbound», or «internal».

El atributo «type» del elemento «message»

  debe ser «action» o «normal».

El atributo «importance» del elemento «message»

  debe ser «0» para «bajo», «1» para «normal» y «2» para «alto».

El atributo «dir» de muchos elementos

  debe ser «ltr» para «de izquierda a derecha» o «rtl» para «de derecha a izquierda».