Manipulation : Notifications PUSH.

Transcription

1 Objectif : Manipulation : Notifications PUSH. Cette manipulation (incompatible avec le simulateur) a pour but d utiliser les notifications PUSH pour transmettre des messages à une application ipx depuis un serveur Web via les serveurs de push APNS de développement Apple. Principe du service de notifications Push d Apple Apple Push Notification Services «APNS» a pour objectif de transporter et router des notifications depuis un fournisseur donné vers un périphérique donné. Une notification est un court message (256 octets au maximum de charge utile) composé de deux éléments principaux de données : le jeton de l appareil ou «device token», la charge utile ou «payload». Le jeton est analogue à un numéro de téléphone; il permet aux serveurs APN de localiser le périphérique. La charge utile est une liste de propriétés encodées JSON (JavaScript Object Notation) qui paramètre la façon dont l'utilisateur d'une application sur un périphérique doit être alerté. Cycle de vie simplifié d une notification : Le service de Retour d'information «Feedback Service» Les serveurs APN peuvent être amenés à livrer des notifications vers un dispositif qui peut à plusieurs reprises refuser la livraison parce que l application cible a été désinstallée. Dans ce cas, le provider peut interroger le service de retour d'information des serveurs APN. Le service de retour d'information entretient une liste de dispositifs pour lesquels il y a eu des tentatives échouées récentes et répétées. La qualité de service APNS comprend une qualité de service (QoS) par défaut qui assure la fonction de sauvegarde puis de transfert différé. Si le serveur APN tente de remettre une notification alors que l'appareil est déconnecté, celle-ci est sauvegardée pour transfert lorsqu il sera de nouveau joignable. APNS ne conserve qu une seule notification par application pour un périphérique donné, la dernière reçue. L architecture de sécurité APNS établit l'identité d'un idevice en utilisant l'authentification TLS. De la même façon la connexion entre le provider et APNS est sécurisée par ce même procédé. Cette authentification réciproque se fait par un jeu de certificats. Le développement d une application mettant en œuvre les notifications PUSH débutera donc par la création de ces certificats et l'association de ceux-ci avec votre application via son appid à partir du portail d enrôlement d Apple. Page 1

2 La génération et le transfert du jeton Une application IOS doit s inscrire auprès du serveur APN pour recevoir des notifications. APNS génère un jeton à l aide des informations reçues lors de la demande du idevice (qui identifient le device), du certificat associé à l application et d une clé privée. Le jeton ainsi produit est alors retourné au idevice, charge à l application du idevice de retourner celui-ci au provider. L envoi d une notification Lorsque le provider veut envoyer une notification à un idevice pour une application donnée il doit constituer un message JSON avec le jeton spécifique du couple idevice-application. Le serveur APN décrypte le jeton afin de le valider. Il répond alors positivement (ou négativement en cas de jeton incorrect) en transmettant la notification (payload) au idevice. Page 2

3 La constitution du message de notification Push «Token + payload» Le message est constitué de deux parties principales, le jeton sur 32 octets et la charge utile ou payload qui ne doit pas dépasser la taille de 256 octets. La livraison d un message utilise un mode de transport de type "best effort", sa livraison n est donc pas garantie. Le payload doit respecter le format JSON qui adhère strictement à la RFC Outre les clés obligatoires du payload JSON les fournisseurs (providers) peuvent spécifier des clés personnalisées à l'extérieur du dictionnaire de clé obligatoire «aps». Les valeurs personnalisées doivent se limiter aux types JSON dictionnary(objet), array, string, number et boolean. Les différentes clés du payload sont précisées plus loin. Les messages utilisent deux formats, un format simple et un format amélioré. Format du message de notification simple Format du message de notification améliorée Page 3

4 Le message de format «amélioré» apporte les compléments suivants : une valeur d expiration : avec un message simple, si le idevice est hors ligne lors des notifications, seule la dernière notification est mémorisée puis transmisse lorsque le idevice redevient accessible. Le format amélioré inclut une valeur d'expiration qui indique la période de validité pour une notification au-delà de laquelle il n est plus nécessaire de délivrer le message. une valeur d identification (identifier) qui sera utilisée par le message de réponse en cas d erreur pour associer le message et sa réponse. Un message de réponse en cas d erreur : avec un message simple, si le message est mal formé aucune indication n est retournée au fournisseur, tandis qu avec un message amélioré, le serveur APN retourne un message d erreur contenant un code d erreur spécifique. Format du message de réponse en cas d erreur Status code Description 0 No errors encountered 1 Processing error 2 Missing device token 3 Missing topic 4 Missing payload 5 Invalid token size 6 Invalid topic size 7 Invalid payload size 8 Invalid token 255 None (unknown) Les clés de la charge utile «payload» La clé de dictionnaire «racine» aps est obligatoire. Elle peut contenir les couples clés-valeurs décrites dans le tableau suivant : Clé Type de valeur Commentaire alert chaîne ou dictionnaire Si vous spécifiez une chaîne de caractères, cela devient le texte du message d'une alerte avec deux boutons, fermer et voir. Si le bouton voir est cliqué l application est activée. Alternativement, vous pouvez spécifier un dictionnaire comme la valeur d'alerte, la table ci-après décrit les clés de ce dictionnaire. badge nombre Le numéro à afficher en tant que badge associé à l application. Si cette propriété est absente aucun badge ne sera affiché et l éventuel précédent badge sera supprimé. sound chaîne Le nom d un fichier son dans le «bundle» de l application qui sera joué comme alerte. Mettre «default» pour le son d alerte par défaut. Page 4

5 Les clés «filles» de la clé alert : Clé Type de valeur Commentaire body chaîne Le texte du message d alerte action-loc-key Chaîne ou null Si une chaîne est spécifiée le message d alerte est affiché avec deux boutons (comme pour alert), le idevice utilise celle-ci comme clé de localisation pour trouver le texte à afficher comme titre du bouton «voir». Les chaînes clés-valeurs de localisation doivent-être écrites dans le fichier Localizable.strings du «bundle» de l application. Si la clé est à null l alerte est affichée avec un simple bouton OK. loc-key chaîne Clé vers un message d alerte à trouver dans le fichier Localizable.strings et pouvant être formaté à l aide des variables spécifiées dans le tableau loc-args. loc-args Tableau de Variables utilisées pour le message localisé par loc-key. chaînes launch-image chaîne Le nom d un fichier image du «bundle». Cette image est utilisée comme image de chargement de l application si l on demande à charger l application suite à une alerte. Exemples de «payload» JSON : Exemple 1 : Message d alerte simple avec un badge =2 et le son d alerte par défaut. { "aps" : { "alert" : "Vous avez reçu un message.", "badge" : 2, "sound" : "default" Exemple 2 : Message 1 avec en plus deux clés personnalisées, une chaîne et un tableau { "aps" : { "alert" : "Vous avez reçu un message.", "badge" : 2, "sound" : "default", "date" : "2 juillet 2013", destinataires : [ "joseph", "yann" ] Exemple 3 : Message avec titre localisé et clés personnalisées. { "aps" : { "alert" : { "body" : "Joseph organise un poker ","action-loc-key" : "JEUX", "badge" : 5, "sound" : "blingbling.aiff", "Lieu" : "bar de nuit Les pochtrons", "Invités" : [ "Yann", "Michel" ] Exemple 4 : Message localisé avec une chaîne formatée. { "aps" : { "alert" : { "loc-key" : "CHAINE-ANNONCE", "loc-args" : [ "urgent", "Michel" ], "badge" : 5, "sound" : "alarme.aiff" Lorsque le idevice reçoit cette notification il va : rechercher la langue courante, rechercher le fichier Localizable.strings situé dans le bundle de l application pour la langue courante (dans le dossier /fr.lproj pour le français, /en.lproj pour l anglais, etc ), lire la chaîne associée à la clé loc-key soit CHAINE-ANNONCE pour cet exemple, formater la chaîne obtenue avec les arguments loc-args, et enfin afficher le message d alerte avec le texte ainsi formaté. Exemple d association clé-valeur à placer dans le fichier Localizable.strings : "CHAINE-ANNONCE" = "Vous avez reçu un message de type %@ de la part de Ce qui pour notre exemple affichera le message d alerte : "Vous avez reçu un message de type urgent de la part de Michel." %@."; Page 5

6 Préparer une application pour le PUSH, génération de l appid, des certificats et du profil d approvisionnement Les premières choses à faire vont consister à créer l appid et les certificats nécessaires au Push sur le site de provisioning d Apple. 1) Créer un nouvel identifiant d application. Attention, le «bundle identifier» doit-être explicite, i.e sans *. 2) Ensuite il faut configurer votre appid afin de l autoriser pour le PUSH puis configurer les certificats de production et de développement. Pour générer les certificats il faut réaliser en parallèle de cette configuration : a. depuis le trousseau : aller dans ->assistant de certification->demander un certificat à une autorité de certificat, b. remplir tous les champs sauf «adresse électronique de l AC» puis enregistrer la demande sur le disque, prenons comme exemple certifrequestdev.certsigningrequest. On revient alors sur le site Apple, on clique sur continuer puis on sélectionne le fichier de demande de certificat que l on vient de créer. c. Cliquer sur «generate» puis «continue». Lorsque le certificat est prêt, télécharger le certificat de développement afin de le garder précieusement... Procéder de la même manière pour le certificat de production en nommant la demande certifrequestprod.certsigningrequest par exemple. 3) Enfin il faut créer un nouveau profil de provisionnement pour l application de Push. Toujours depuis le site d Apple, dans la rubrique «Provisioning» onglet «Development», choisir «New Profile» puis : a. renseigner le champ «Profile name» et le certificat «Ad Hoc», b. renseigner l appid configuré en 2), c. soumettre la demande de provisioning puis la télécharger précieusement avec les certificats précédents. Procéder de la même manière pour le second certificat. Préparer les certificats pour utilisation par l applicatif «Provider» Le provider a besoin des certificats pour communiquer avec le serveur APNS. Dans cet exemple le provider communique avec le serveur APNS via du code PHP nécessitant que les certificats soient au format.pem, il va donc falloir convertir les certificats préalablement téléchargés. Page 6

7 1) Les certificats de production et de développement étant supposés téléchargés sur un poste MacOSX il faut : a. les installer en cliquant deux fois sur les fichiers.cer, b. depuis le trousseau : sélectionner le certificat et sa clé puis cliquer bouton droit puis exporter 2 éléments vers un fichier au format.p12, c. il est alors demandé de protéger le fichier par un mot de passe à ne pas oublier Procéder de la même manière pour le second certificat. 2) Convertir les fichiers de certificat signés.p12 vers des certificats.pem pour une utilisation avec un serveur Web provider Apache-php par exemple. Sous macos X les commandes shell suivantes permettent de réaliser cette opération : # conversion du certificat de dev openssl pkcs12 -clcerts -nokeys -out CertificatsPushDev.pem -in CertificatsPushDev.p12 openssl pkcs12 -nocerts -out cledev.pem -in CertificatsPushDev.p12 cat CertificatsPushDev.pem cledev.pem > apns-dev-testpush.pem # conversion du certificat de Prod openssl pkcs12 -clcerts -nokeys -out CertificatsPushProd.pem -in CertificatsPushProd.p12 openssl pkcs12 -nocerts -out cledev.pem -in CertificatsPushProd.p12 cat CertificatsPushProd.pem cledev.pem > apns-prod-testprod.pem # vérification de l accès au serveur push de Apple openssl s_client -connect gateway.sandbox.push.apple.com:2195 -cert apns-dev-testpush.pem Les serveurs de PUSH d Apple sont accessibles aux URI suivantes : Serveur de production : gateway.push.apple.com port 2195 Serveur de développement : gateway.sandbox.push.apple.com port 2195 Page 7

8 L architecture mise en œuvre dans cette manipulation Client du Provider «Emetteur de messages» 1 /apns/pagepushmessage.php Requêtes GET PHP * réponses Provider «serveur PUSH» Apache- PHP 3 BDD MySQL 2 apns.devices apns.messages idevice 4 enregistrement jeton notification Serveur Apple APNS Gateway.sandbox.push.apple.com Port 2195 * Les requêtes sont décrites au paragraphe «Description des requêtes PHP du Provider» La base de données pushbdd (BDD du provider) Elle est constituée de 2 tables : une table apns_devices : où s enregistrent les idevices avec leurs caractéristiques et en particulier le deviceuid (numéro unique d identification du idevice) et le devicetoken (jeton attribué à une application donnée du idevice par le serveur APN). une table apns_messages : où sont enregistrés les messages des clients du provider à destination finale des idevices. Le message est identifié par le champ pid et le idevice destinataire par le champ deviceuid. Page 8

9 Les scripts de création de ces tables sont disponibles dans les ressources associées à cette manipulation. Description des requêtes PHP du provider Les clients «émetteurs de messages» utilisent la page /apns/pagepushmessage.php pour émettre un message de notification à un idevice. Cette page interroge la base de données pour trouver le jeton «devicetoken» associé au idevice «devicename» spécifié afin de générer le message de notification à envoyer au serveur APN de développement (nous ne sortirons pas du bac à sable ). Remarque : si la valeur du badge est 0, la notification générée par le serveur APN spécifiera le nombre de messages disponibles comme valeur de badge pour le idevice spécifié. Le payload généré aura la signature suivante (avec les valeurs éditées dans la page précédente) : {"aps":{"alert":{"loc-key":"alert_format","loc-args":["urgent","michel"], "badge":2,"sound":"default","mess":"une question pour toi..." Du côté idevice, les pages PHP suivantes seront utilisées avec des requêtes de type GET pour enregistrer le idevice, récupérer la liste des messages disponibles, marquer un message comme lu et supprimer un message. Page /apns/apns.php?task=register&. : page permettant d enregistrer le idevice et de l associer à son jeton dans la table apns_devices. Cette requête attend les paramètres suivants : o task = register pour l enregistrement du idevice, Page 9

10 o appname = le nom de l application enregistrée pour le Push, o appversion = la version de l application, o deviceuid = le numéro unique identifiant le idevice, o devicetoken = le jeton transmis par le serveur APN lors de l enregistrement du idevice, o devicename = le nom du idevice, o devicemodel = le modèle de idevice, o deviceversion = la version du idevice, o pushbadge = l information comme quoi le idevice gère le badge ou non, o pushalert = l information comme quoi le idevice gère l alerte par notification ou non, o pushsound = l information comme quoi le idevice gère l alerte sonore ou non. Page /apns/getpushbddmessages.php?deviceuid=. : page permettant de récupérer la liste des messages de la table apns-messages attribués au idevice dont le deviceuid est passé en paramètre. o deviceuid = le GUID du idevice. Page /apns/insertpushbddmessagesdelivered.php?pid=. : page permettant de marquer un message identifié par le pid passé en paramètre comme délivré, signalant par ce fait que le message a été lu par son destinataire. o pid = le numéro unique du message à marquer comme délivré. Page /apns/deletepushbddmessagesbypid.php?pid=. : page permettant de supprimer un message identifié par le pid passé en paramètre. o pid = le numéro unique du message à supprimer. L ensemble de ces pages PHP et des classes PHP utilisées par celles-ci sont disponibles dans les ressources associées à cette manipulation. Elles s appuient sur l utilisation de classe PHP fournies par le site Easy APNS : Exemples de méthodes Objective-C pour accéder aux provider Ces méthodes sont disponibles dans les ressources fournies associées à cette manipulation. La méthode suivante sera utile pour générer un UDID spécifique du idevice. Il sera stocké dans la base de données par défaut de l application sous la clé «generatedudid» et servira de deviceuid. - (NSString *)deviceudid { NSString *udid = [[NSUserDefaults standarduserdefaults] objectforkey:@"generatedudid"]; if (udid == nil) { CFUUIDRef udidref = CFUUIDCreate(NULL); udid = ( bridge NSString *)CFUUIDCreateString(NULL, udidref); CFRelease(udidref); [[NSUserDefaults standarduserdefaults] setobject:udid forkey:@"generatedudid"]; return udid; La méthode suivante utilise la page /apns/apns.php afin d enregistrer le idevice auprès du provider (elle reçoit en paramètres l adresse IP du serveur de PUSH et le code du jeton reçu et mis en forme), elle ajoute un enregistrement à la table apns-devices avec toutes les caractéristiques de celui-ci et retourne au format JSON une valeur associée à la clé valid avec pour valeur 1 si tout c est bien passé et 0 en cas d echec : Page 10

11 Page 11

12 - (BOOL)postTokenValueForDeviceGUUIDatServer:(NSString*)serveurPush devtoken:(nsstring *)devtoken{ NSString *appname = [[[NSBundle mainbundle] infodictionary objectforkey:@"cfbundledisplayname"]; NSString *appversion = [[[NSBundle mainbundle] infodictionary] objectforkey:@"cfbundleversion"]; NSUInteger rntypes = [[UIApplication sharedapplication] enabledremotenotificationtypes]; NSString *pushbadge NSString *pushalert NSString *pushsound if((rntypes & UIRemoteNotificationTypeBadge) == UIRemoteNotificationTypeBadge){ pushbadge if((rntypes & UIRemoteNotificationTypeAlert) == UIRemoteNotificationTypeAlert){ pushalert if((rntypes & UIRemoteNotificationTypeSound) == UIRemoteNotificationTypeSound){ pushsound #if LOG NSLog(@"Notifications Badge = %@ ; Alerte = %@ ; Son = %@",pushbadge,pushalert,pushsound); # endif UIDevice *dev = [UIDevice currentdevice]; NSString *deviceuuid = [self deviceudid]; NSString *devicename = dev.name; NSString *devicemodel = dev.model; NSString *devicesystemversion = dev.systemversion; NSString *urlstring = [@"/apns/apns.php" stringbyappendingstring:@"?task=register"]; urlstring = [urlstring stringbyappendingstring:@"&appname="]; urlstring = [urlstring stringbyappendingstring:appname]; urlstring = [urlstring stringbyappendingstring:@"&appversion="]; urlstring = [urlstring stringbyappendingstring:appversion]; urlstring = [urlstring stringbyappendingstring:@"&deviceuid="]; urlstring = [urlstring stringbyappendingstring:deviceuuid]; urlstring = [urlstring stringbyappendingstring:@"&devicetoken="]; urlstring = [urlstring stringbyappendingstring:devtoken]; urlstring = [urlstring stringbyappendingstring:@"&devicename="]; urlstring = [urlstring stringbyappendingstring:devicename]; urlstring = [urlstring stringbyappendingstring:@"&devicemodel="]; urlstring = [urlstring stringbyappendingstring:devicemodel]; urlstring = [urlstring stringbyappendingstring:@"&deviceversion="]; urlstring = [urlstring stringbyappendingstring:devicesystemversion]; urlstring = [urlstring stringbyappendingstring:@"&pushbadge="]; urlstring = [urlstring stringbyappendingstring:pushbadge]; urlstring = [urlstring stringbyappendingstring:@"&pushalert="]; urlstring = [urlstring stringbyappendingstring:pushalert]; urlstring = [urlstring stringbyappendingstring:@"&pushsound="]; urlstring = [urlstring stringbyappendingstring:pushsound]; NSURL *url = [[NSURL alloc] initwithscheme:@"http" host:serveurpush path:urlstring]; NSURLRequest* request =[[NSURLRequest alloc] initwithurl:url cachepolicy:nsurlrequestuseprotocolcachepolicy timeoutinterval:5]; NSData *returndata = [NSURLConnection sendsynchronousrequest:request returningresponse:nil error:nil]; #if LOG NSLog(@"Register URL: %@", url); NSLog(@"Return Data: %@", returndata); #endif if(returndata==nil) return NO; Page 12

13 else { NSError* erreur; NSDictionary *diclignes = [NSJSONSerialization JSONObjectWithData:returnData options:nsjsonreadingmutableleaves error:&erreur]; #if LOG NSLog(@"Return Data JSON dict: %@", [diclignes description]); #endif id result = [diclignes valueforkey:@"valid"]; if( [result intvalue]==1) return YES; return NO; Page 13

14 La conception de l application ipad, enfin Partie 1 : s enregistrer auprès du serveur APN et recevoir le jeton. 1) Créer un projet Xcode de type «Single View Application» et choisir une cible de type ipad. Cocher les options «Use Storyboard» et «use ARC». Nommer le projet applitestpush et mettre net.michel-marie comme company identifier, c est important car c est la chaîne «nomdelapplication.compagnyidentifier» qui sert de clé pour rechercher la présence d un profil de provisionnement ayant cette clé comme appid. 2) Installer le «provisioning de développement» pour votre application, utiliser le fichier de provisionnement profiltestpush.mobileprovision fourni. 3) Vérifier et corriger si nécessaire l identificateur de l application dans le fichier.plist. 4) Construire le projet pour vérifier que le profil est compatible avec l application. L application va avoir besoin de connaître l adresse du «provider», nous allons donc ajouter ce paramètre aux réglages généraux de l application. 5) Ajouter un nouveau fichier ressource du type «Settings.bundle» à votre projet (sans modifier son nom) et visualiser son contenu, vous devez trouver : un fichier Root.plist obligatoire qui contient la description des rubriques de réglages associées à votre application (4 exemples dans le fichier par défaut), 6) Éditer le fichier Root.plist afin de le modifier de la façon suivante : modifier le titre du groupe pour lui donner le nom de l application, modifier l item de type «Text Field» pour éditer l url du provider, on identifiera cet item avec un identificateur nommé adrserveurpush, Choisissez l adresse ou serveurpush.michel-marie.net par défaut, supprimer les autres items non utiles à notre application. Pour plus d informations sur les balises spécifiques aux réglages généraux, consulter le document suivant : tingsapplicationschemareference.pdf Vous pouvez d ores et déjà exécuter votre application et constater l existence du menu de réglages pour votre application. Nous allons maintenant faire en sorte que l application s enregistre auprès du serveur APN et reçoive le jeton. Pour cela nous allons coder ou compléter les méthodes suivantes de la classe AppDelegate : didfinishlaunchingwithoptions: : méthode appelée au chargement de l application qui devra enregistrer celle-ci auprès du serveur APN, didregisterforremotenotificationswithdevicetoken: : méthode appelée lorsque l application est enregistrée avec succès auprès du serveur APN, didfailtoregisterforremotenotificationswitherror: : méthode appelée lorsque l application n a pas pu s enregistrer correctement auprès du serveur APN, didreceiveremotenotification: : méthode appelée lorsque l application active reçoit une notification Push. Rappel : les paramètres de réglages sont stockés dans une base de données par défaut de d application accessible via la classe NSUserDefaults. Les informations de la base sont mises en cache pour éviter une ouverture de la base à chaque accès et la méthode synchronize permet de mettre à jour la base. Vous pouvez appeler cette méthode explicitement mais elle est périodiquement appelée par le système. Page 14

15 Il est nécessaire d écrire au moins une fois dans chaque paramètre de réglage afin de créer le cache d application. Ceci est généralement fait dans la méthode didfinishlaunchingwithoptions de la classe AppDelegate. Exemple : Vous avez défini dans le fichier des paramètres Root.plist un dictionnaire pour un item de type «Text Field» de titre ayant pour clé «adrserveurpush» et de clé ayant pour clé «URI», cette clé permettant de récupérer la valeur configurée pour ce paramètre. Le dictionnaire correspondant est décrit comme ci-dessous : <dict> <key>autocapitalizationtype</key> <string>none</string> <key>autocorrectiontype</key> <string>no</string> <key>defaultvalue</key> <string> </string> <key>issecure</key> <false/> <key>key</key> <string>uri</string> <key>keyboardtype</key> <string>alphabet</string> <key>title</key> <string>adrserveurpush</string> <key>type</key> <string>pstextfieldspecifier</string> </dict> Le titre de ce paramètre de réglage est défini par la clé «adrserveurpush» et vous souhaitez localiser celui-ci afin qu il s adapte à la langue sélectionnée au niveau de l IOS, du moins pour l anglais et le français. Vous devez donc associer à cette clé de titre une valeur dans chaque fichier de langue du package Settings.bundle comme ci-dessous : Fichier en.lproj/root.strings "adrserveurpush" = "Address IP or DNS name of the Push server"; Fichier fr.lproj/root.strings "adrserveurpush" = "Addresse IP ou nom DNS du serveur PUSH"; Ce qui donnera l affichage ci-dessous au niveau des réglages spécifiques de l application : Page 15

16 La création du cache se fait en écrivant dans la clé URI du dictionnaire des paramètres, pour cela il est possible d écrire directement la valeur associée à la clé comme ci-dessous : NSUserDefaults *defaults = [NSUserDefaults standarduserdefaults]; NSDictionary *appdefaults = [NSDictionary dictionarywithobject:@" " forkey:@"uri"]; [defaults synchronize]; Mais il est également possible d utiliser une fonction générique qui lit les valeurs par défaut de chaque clé du fichier Root.plist pour les recopier dans le cache comme dans l exemple ci-dessous : + (void)initializensuserdefault { NSString *path = [[NSBundle mainbundle] pathforresource:@"root" oftype:@"plist" indirectory:@"settings.bundle"]; NSDictionary *dico = [NSDictionary dictionarywithcontentsoffile:path]; NSArray *prefspecifiers = [dico objectforkey:@"preferencespecifiers"]; NSMutableDictionary *defaults = [NSMutableDictionary dictionarywithcapacity:[dico count]]; for (NSDictionary *item in prefspecifiers) { NSString *key = [item objectforkey:@"key"]; NSString *value = [item objectforkey:@"defaultvalue"]; if (key!=nil) [defaults setobject:value forkey:key]; [[NSUserDefaults standarduserdefaults] registerdefaults:defaults]; [[NSUserDefaults standarduserdefaults] synchronize]; Et la lecture du paramètre de clé URI se fait, par exemple, à l aide de la méthode suivante : + (NSString*)getServerAdress { NSUserDefaults *defaults = [NSUserDefaults standarduserdefaults]; return [defaults stringforkey:@"uri"]; 7) Compléter la méthode didfinishlaunchingwithoptions: pour qu elle charge le paramètre de réglage adrserveurpush dans le «cache» de l application puis enregistre l application auprès du serveur APN avec l autorisation des notifications par alertes, avec son et badge, vous utiliserez pour cela la méthode registerforremotenotificationtypes: de la classe UIApplication. 8) Coder la méthode didfailtoregisterforremotenotificationswitherror: du protocole UIApplicationDelegate afin qu elle affiche un message d alerte (classe UIAlertView) signalant le problème. Page 16

17 Si l enregistrement de l application se passe correctement la méthode didregisterforremotenotificationswithdevicetoken: est appelée et reçoit le jeton en paramètre. Le jeton reçu présente un format décrit par l exemple suivant : <bcac921a 026ab df 1b4d37bc 51d7c218 42e6917d 763a7068 c0e019a7> Le jeton sera sauvegardé dans la base de données par défaut de l application (classe NSUserDefaults) avec pour clé «thepushtoken». Il faudra au préalable supprimer l encadrement par les caractères < > et les espaces afin d être compatible avec la base de données du provider. La classe NSString dispose pour cela des méthodes suivantes : stringbytrimmingcharactersinset: stringbyreplacingoccurrencesofstring: 9) Coder la méthode didregisterforremotenotificationswithdevicetoken: afin : de lire le jeton sauvegardé dans la base de données par défaut de l application, de le comparer au jeton reçu et s ils sont différents : i. de sauvegarder le nouveau jeton dans la base de données par défaut de l application, ii. d enregistrer ce nouveau jeton associé au idevice dans la base de données du provider, vous disposez pour cela de la méthode posttokenvaluefordeviceguuidatserver (méthode d accès au provider), iii. de tester la valeur de retour de la précédente méthode et si elle est à NO (échec de l accès provider) d afficher un message d alerte significatif. Vous pouvez dès à présent tester votre application afin de vérifier la réception du jeton associé à votre couple (device/application) ainsi que sa sauvegarde au sein de l application et de la base de données du provider. Vous pouvez également «fermer» votre application et lui envoyer une notification à l aide de la page «pagepushmessage.php» du provider, votre idevice devrait vous signaler cette notification même si pour le moment vous n en faîtes rien. Partie 2 : Décodage des notifications reçues. Plusieurs cas sont à considérer selon l état de l application lors de la réception d une notification : l application est inactive, c est alors la méthode didfinishlaunchingwithoptions: qui est appelée avec pour paramètre launchoptions : un dictionnaire contenant entre autre le payload du message de notification associé à la clé UIApplicationLaunchOptionsRemoteNotificationKey, l application est active, c est alors la méthode didreceiveremotenotification: qui est appelée avec pour paramètre userinfo : un dictionnaire contenant le payload du message de notification. La notification contient le payload rappelé ci-dessous : {"aps":{"alert":{"loc-key":"alert_format","loc-args":["urgent","michel"], "badge":2,"sound":"default","mess":"une question pour toi..." La notification utilisant l attribut localisé loc-args, il va falloir formater le message à partir d une chaîne identifié par la clé ALERT_FORMAT. 1) Ajouter à votre projet un fichier de type «strings file» nommé Localizable.strings et lui ajouter la clé ALERT_FORMAT associée à la chaîne de formatage de la notification comme cidessous : Page 17

18 "ALERT_FORMAT" = "Message de type %@ de la part de %@"; Vous pouvez d ores et déjà vérifier que le titre affiché lors de la réception d une notification avec l application inactive est correctement formaté. 2) Ajouter à votre classe AppDelegate la méthode suivante : - (void)addmessagefromremotenotification:(nsdictionary*)userinfo Coder cette méthode afin qu elle décode le dictionnaire userinfo pour qu elle affiche : à l aide de la fonction d affichage des logs NSLog : un premier message avec le texte du titre formaté de la notification, un second avec le texte du message associé à la clé «mess». Vous pouvez également signaler l arrivée d une notification en précisant l émetteur dans une «alertview». Appeler cette méthode partout où c est nécessaire. Vérifier l affichage dans les logs des notifications reçues. Page 18

19 Partie 3 : Lire les messages notifiés dans une fenêtre «popover». Les messages gérés par le provider sont stockés dans la table apns-messages. Nous allons utiliser une vue de type «popover» pour lister les messages disponibles dans des cellules (UITableViewCell) de la table (UITableView) affichée par le «popover». La sélection d un message (cellule) provoquera son affichage dans la vue de l application ainsi que le marquage du message comme délivré au sein de la base de données, table apns-messages. 1) Ajouter une «toolbar» (UIToolbar) en haut de la vue avec un «bar button item» de titre «Lire ses messages Push». 2) Ajouter 3 labels à la vue, un pour afficher l auteur et le type du message, un pour afficher le message et un pour afficher la date de création du message. Associer des attributs et propriétés à ces labels et nommez-les labelauteur, labelmessage et labeldate respectivement. 3) Ajouter un bouton avec le titre «remise à zéro du badge» et associer le clic sur ce bouton à une méthode que vous nommerez clicboutonrazbadge. Il servira à supprimer l affichage du badge associé à l application. La fenêtre devrait ressembler à ceci : La suppression du badge associé à l application se fait en affectant 0 à la propriété applicationiconbadgenumber de l objet UIApplication. L accès à l objet singleton de la classe application (UIApplication) courante se fait en utilisant la méthode statique sharedapplication de la classe UIApplication. 4) Coder en conséquence la méthode clicboutonrazbadge. Le clic sur le bouton «Lire ses messages Push» doit afficher les messages dans une vue popover comme dans l exemple ci-dessous : Page 19

20 La requête employée pour obtenir la liste des messages du provider /apns/getpushbddmessages.php?deviceuid=xxx retourne les données au format JSON comme présenté dans l exemple ci-dessous correspondant à la copie d écran précédente : {"ligne0":{"pid":"169","message":"elle est quand la formation d\u00e9veloppement Ipad?", "auteur":"joseph","type":"urgent","createdate":" :36:24", "ligne1":{"pid":"170","message":"une formation ipad ou aie pad? ", "auteur":"yann","type":"blague","createdate":" :42:18" Les messages seront représentés par la classe datamessage suivante (fichier header) datamessage : (strong,nonatomic) NSString* (strong,nonatomic) NSString* (strong,nonatomic) NSString* (strong,nonatomic) id (strong,nonatomic) NSDate* 5) Ajouter cette classe (modèle) à votre projet et «synthétiser» ses propriétés. 6) Ajouter une nouvelle classe «Objective-C» à votre projet que nommerez ViewControllerMessagePopover héritant de UITableViewController avec fichier xib. 7) Ajouter l attribut listemessages suivant à cette classe et lui associer une propriété. Il servira à stocker la liste des messages téléchargés par l application et rendus visualisables par le «popover». NSMutableArray *listemessages; La vue «popover» doit s afficher lorsque l on clique sur le bouton de la «toolbar». 8) Compléter la classe contrôleur de la vue (ViewController) des attributs tels que décrit ci-dessous, à savoir : a. une propriété viewpopovercontrollermessages pour la classe contrôleur de vue du «popover», ViewControllerMessagePopover, b. un propriété popovercontrollermessages de la classe UIPopoverController qui permet d afficher une vue de type «popover» en surimpression d une vue existante sans prendre l intégralité de la vue, 9) Coder la méthode associée au bouton de la «toolbar» afin qu elle affiche la vue «popover» audessous du bouton, vous pouvez pour cela vous inspirer de l exemple de code ci-dessous : -(IBAction)clicBarBoutonMessages:(id) sender { if([popovercontrollermessages ispopovervisible]==yes) return; viewpopovercontrollermessages = [[ViewControllerMessagePopover alloc] initwithnibname:@"viewcontrollermessagepopover" bundle:[nsbundle mainbundle]]; popovercontrollermessages = [[UIPopoverController alloc] initwithcontentviewcontroller:viewpopovercontrollermessages]; // Affiche le popover [self.popovercontrollermessages presentpopoverfrombarbuttonitem:sender permittedarrowdirections:uipopoverarrowdirectionany (NSException *exception) { UIAlertView* alertview = [[UIAlertView alloc] initwithtitle:nslocalizedstringfromtable(@"clicbarboutonmessages_m1",@"infoplist",@"") message:exception.reason delegate:self cancelbuttontitle:@"ok" otherbuttontitles:nil]; [alertview show]; Page 20

21 10) Coder les méthodes suivantes de la classe ViewControllerMessagePopover : a. viewdidload : méthode appelée au chargement de la vue qui doit, si listemessages == nil : i. interroger le provider pour récupérer la liste des messages associés au deviceuid en utilisant la requête /apns/getpushbddmessages.php?deviceuid, ii. stocker chaque message dans un objet datamessage que l on ajoutera au tableau listemessages. Il est également souhaitable d alerter l utilisateur au cas où l accès au provider est impossible. L accès à la méthode deviceudid de la classe AppDelegate pourra se faire selon le principe exposé à la question 5, soit depuis le cache. [(AppDelegate*)([UIApplication sharedapplication].delegate) deviceudid]; ou en ajoutant une méthode statique comme ci-dessous à la classe AppDelegate, ce qui sera sans doute plus simple pour la suite : + (AppDelegate *)sharedappdelegate { return (AppDelegate *) [UIApplication sharedapplication].delegate; La requête getpushbddmessages retourne la réponse au format JSON dans un tableau de bytes de type NSData. Cette réponse contient les lignes de la table apns_messages encodées JSON répondant à la requête. Les clés et données JSON peuvent être «déserialisées» dans un dictionnaire (classe NSDictionary) en utilisant la classe NSJSONSerialization, méthode JSONObjectWithData. Chaque ligne est identifiée par une clé «lignen» N étant l indice de la ligne débutant à 0. La valeur associée aux différentes colonnes de la table apns_messages est identifiée par une clé du nom de la colonne dans la table apns_messages. Ci-dessous un exemple d affichage de la description du dictionnaire obtenu après désérialisation des données JSON : Printing description of diclignes: { ligne0 = { auteur = Joseph; createdate = " :27:10"; message = "Une autre question pour toi..."; pid = 180; type = "Trés Urgent"; ; ligne1 = { auteur = Michel; createdate = " :41:22"; message = "Une question pour toi..."; pid = 179; type = Urgent; ; L exemple «incomplet» ci-dessous montre comment extraire les données issues de la requête pour récupérer l auteur et la date de chaque message à destination du matériel courant : // du serveur PUSH NSUserDefaults *defaults = [NSUserDefaults standarduserdefaults]; NSString* host = [defaults stringforkey:@"adrserveurpush"]; Page 21

22 // Formation de la requête pour les messages du device courant NSString *urlstring = [@"/apns/getpushbddmessages.php?deviceuid=" stringbyappendingstring:[(appdelegate*)([uiapplication sharedapplication].delegate) deviceudid]]; NSURL *url = [[NSURL alloc] initwithscheme:@"http" host:host path:urlstring]; NSURLRequest* request =[[NSURLRequest alloc] initwithurl:url cachepolicy:nsurlrequestuseprotocolcachepolicy timeoutinterval:5]; NSError *erreur = nil; NSURLResponse *reponse = nil; // Exécution de la requête NSData *returndata = [NSURLConnection sendsynchronousrequest:request returningresponse:&reponse error:&erreur]; if(erreur!= nil) { // Signaler l erreur par message UIAlertView return; // Si pas d erreur extraire les données JSON NSDictionary *diclignes = [NSJSONSerialization JSONObjectWithData:returnData options:nsjsonreadingmutableleaves error:&erreur]; // Balayer toutes les lignes du dictionnaire for(int i=0;i<[diclignes count];i++) { datamessage* donnees = [[datamessage alloc]init]; // Extraire les données du dictionnaire de clé lignen NSString* idligne= [NSString stringwithformat:@"ligne%d",i]; id ligne = [diclignes valueforkey:idligne]; // Extraire les données de la colonne de clé auteur du dictionnaire lignen donnees.auteur = [ligne valueforkey:@"auteur"]; // Extraire les données de la colonne de clé createdate du dictionnaire lignen NSString* date = [ligne valueforkey:@"createdate"]; NSDateFormatter *dateformatter = [[NSDateFormatter alloc] init]; [dateformatter setdateformat:@"yyyy-mm-dd HH:mm:ss"]; NSDate *datefromstring = [[NSDate alloc] init]; datefromstring = [dateformatter datefromstring:date]; donnees.datecreation=datefromstring; // etc [listemessages addobject:donnees]; b. tableview:numberofsectionsintableview: : méthode d initialisation du nombre de sections de la table affichée dans le «popover», dans notre cas 1 seule section, c. tableview:numberofrowsinsection: : méthode d initialisation du nombre de lignes pour chaque section, dans notre cas cela correspond au nombre d éléments du tableau listemessages, d. tableview:cellforrowatindexpath: méthode d initialisation de la cellule dont l index est passé en paramètre. Initialiser les cellules avec le nom de l auteur et la date de création dans le champ texte de la cellule et le type de message dans le champ «texte détaillé» de la cellule. Vous pouvez agrémenter la cellule d une image (image Envelope.png fournie) Vous pouvez dès à présent tester cette partie en vérifiant que les messages reçus sont bien affichés dans le «popover». Nous allons à présent compléter la classe ViewControllerMessagePopover afin d afficher dans la vue les informations du message sélectionné dans la table du «popover» puis permettre la suppression d un message. 11) Coder les méthodes suivantes de la classe ViewControllerMessagePopover : Page 22

23 a. tableview:didselectrowatindexpath: méthode appelée lorsqu une cellule est sélectionnée, codez cette méthode afin : i. d afficher dans les labels de la vue les informations du message associé à la cellule sélectionnée, ii. de signaler le message comme délivré au provider, iii. d afficher une alerte si le provider n est pas joignable. Pour atteindre les propriétés «labels» du ViewController depuis la classe ViewControllerMessagePopover un moyen consiste à passer par la classe AppDelegate. En effet cette classe dispose d une propriété window (imposée par le délégué UIApplicationDelegate) objet de la classe UIWindow qui sert à définir une surface d affichage des vues et à distribuer les événements aux vues. Cette classe UIWindow dispose d une propriété rootviewcontroller qui référence le contrôleur de la vue «principale» en cours d affichage, dans notre cas il s agit donc d une référence à l objet de la classe ViewController. b. tableview:commiteditingstyle:forrowatindexpath: méthode appelée lorsque la cellule entre en mode d édition, nous allons l utiliser pour supprimer la cellule, pour cela vérifier que le mode d édition correspond à une suppression puis si c est le cas : i. supprimer le message au niveau du provider, ii. afficher une alerte si le provider n est pas joignable. iii. puis si la suppression auprès du provider s est faite sans erreur : 1. supprimer le message du tableau listemessages, 2. supprimer la cellule du «popover», Vérifier ces nouvelles fonctionnalités. 12) Enfin, vous constaterez que la valeur du badge n est pas gérée automatiquement lorsque la notification survient alors que l application est active. Compléter à nouveau la méthode addmessagefromremotenotification pour ajouter +1 au badge de l application si la notification est reçue alors que l application est active. Pour ceci l objet singleton de la classe application dispose d une propriété applicationstate permettant de savoir si l application est active. Parties optionnelles mais cependant utiles Ajouter la gestion de la localisation à votre projet pour la langue anglaise (ou toute autre langue à votre choix). Faire en sorte que tous les messages affichés et les titres des contrôles graphiques prennent en compte la localisation pour les langues gérées. Localiser également les réglages généraux de l application. Ajouter la prise en compte de la notification associée à une modification des réglages de l application (notification NSUserDefaultsDidChangeNotification). Ajouter la possibilité d envoyer un message push vers un périphérique enregistré auprès du serveur PUSH, pour ceci vous disposez de deux pages PHP supplémentaires : o getpushbdddevices, qui retourne la liste des devices enregistrés (devicename), o insertpushmessage, qui attend les paramètres ci-dessous et enregistre puis transmet le message PUSH associé, ipad = le nom du idevice de destination du message, auteur = l auteur à l origine du message, type = le type de message (urgent, normal, etc ), message = le message. Page 23