URI personalizado en Apps Xojo Desktop OS X

¿Te has preguntado alguna vez cómo funciona la magia que existe tras “mailto:…” o cualquier otro URI (Uniform Resource Identifier) similar? Ya sabes, se trata del modo en el que utilizas este tipo elementos desde el campo de URL del navegador web o, desde la perspectiva Xojo, en combinación con la función ShowURL. Una vez que se ejecutan estas URL especiales, se abre la aplicación registrada reaccionando a los parámetros pasados (en el caso de Mail, componiendo un nuevo mensaje con la información recibida para los campos ‘Para’, ‘Asunto’ o cuerpo del mensaje, por ejemplo).

Lo cierto es que implementar este tipo de comportamiento en tus apps OS X con Xojo ¡no es nada complicado! Solo has de seguir estos sencillos pasos para registrar el URI personalizado de tu app. Este es el modo que tiene la app de indicar al Sistema Operativo que se encargará de responder cada vez que cualquier usuario (o aplicación) utilice dicha URI.

Registrar la URI personalizada que quieres gestionar

Esto es algo que se hace modificando el archivo “info.plist” generado por Xojo cada vez que se compila la app, de modo que involucra necesariamente el uso de los potentes pasos de Compilación disponibles en Xojo (Build Step). Para allanar el camino:

1.  Haz Control + clic en el item OS X disponible en la sección Build Settings del Navegador de Proyectos (la columna situada más a la izquierda en el IDE de Xojo).
2. Selecciona la opción Add to “Build Settings” > Build Step > Script.
3. Pega el siguiente código (¡asegúrate de que PlistBuddy está instalado en tu Mac!):

Dim App As String = CurrentBuildLocation + "/" + CurrentBuildAppName +".app"
call DoShellCommand("/usr/libexec/PlistBuddy -c ""add :CFBundleURLTypes array"" " + App + "/Contents/Info.plist" )
call DoShellCommand("/usr/libexec/PlistBuddy -c ""add :CFBundleURLTypes:0 dict"" " + App + "/Contents/Info.plist" )
call DoShellCommand("/usr/libexec/PlistBuddy -c ""add :CFBundleURLTypes:0:CFBundleURLName string 'Demo'"" " + App + "/Contents/Info.plist" )
call DoShellCommand("/usr/libexec/PlistBuddy -c ""add :CFBundleURLTypes:0:CFBundleURLSchemes array"" " + App + "/Contents/Info.plist" )
call DoShellCommand("/usr/libexec/PlistBuddy -c ""add :CFBundleURLTypes:0:CFBundleURLSchemes:0 string 'demo'"" " + App + "/Contents/Info.plist" )

Presta atención al uso de las cadenas ‘Demo’ y ‘demo’ para las claves CFBundleURLName y CFBundleURLSchemes, respectivamente. La segunda, CFBundleURLSchemes, es la correspondiente al URI personalizado que podrá utilizar cualquiera para pasar información a nuestra aplicación.

Asegúrate de seleccionar la opción “Both” en el Inspector para este Paso de Compilación, y escribe un nombre que permita identificar el script (por ejemplo “Insertar URI en Plist”). De este modo, el URI se registrará tanto cada vez que se ejecute la app desde el Depurador de Xojo como cuando se compile para su despliege (como aplicación independiente o standalone).

Permite que tu app reaccione al URI

El segundo paso principal consiste en permitir que tu app Xojo reaccione al URI, y esto se logra añadiendo el evento HandleAppleEvent al Objeto App de tu aplicación.

En cuanto al código que probablemente quieras utilizar como parte de este Evento, el propósito principal consiste en identificar el Evento recibido y compararlo con la cadena “GURL”, dado que este es el identificador utilizado por OS X para enviar un evento URI:

if eventClass = "GURL" then

//do your thing

return true
end

return false

De esta forma la app no interfiere con la gestión del resto de eventos recibidos y en los que no estamos interesados.

¡Es muy importante señalar que el evento HandleAppleEvent debe devolver False para los Eventos ignorados! De otro modo, el usuario de tu app probablemente experiencie problemas de funcionamiento en el uso de determinados atajos de teclado sobre los TextField, TextArea u otros controles, entre otros problemas.

Acceder a la información

El paso final consiste en extraer la información recibida junto con el evento “GURL”. Xojo proporciona varios métodos que nos permiten realizar dicha acción (e incluso responder a los eventos); pero para este ejemplo vamos a proporcionar el código para el más común de los usos: obtener la información enviada como una cadena de texto.

dim s() as string = DecodeURLComponent(theEvent.StringParam("----")).DefineEncoding(encodings.UTF8).Split(":")

s.Remove(0)

La clave en este caso se encuentra en el código ‘theEvent.StringParam(“—-“)’. Este obtiene la cadena disponible y que está asociada con la lcave keyDirectObject del Diccionario (el valor de dicha constante es la cadena “—-” utilizada aquí.)

El segundo punto a destacar es que debes de asignar una codificación de texto a la cadena recibida, y utilizar la función DecodeURLComponent para restaurar el texto original enviado junto con el URI (“demo:”, en este ejemplo).

Por último, puedes utilizar la función Split para obtener un Array de cadenas de modo que puedas descartar el primer componente recivido (el URI propiamente dicho), uniendo el resto de elementos para obtener la cadena final.

Descubre como puedes crear apps multiplataforma con mi libro electrónico “Programación Multiplataforma Xojo“.