DesignBuddyList
Version 54 (Adrian Georgescu, 01/28/2010 12:43 pm)
1 | 27 | Adrian Georgescu | = Presence blueprint = |
---|---|---|---|
2 | 2 | Adrian Georgescu | |
3 | 2 | Adrian Georgescu | [[TOC(Design*, depth=1)]] |
4 | 1 | Adrian Georgescu | |
5 | 54 | Adrian Georgescu | This is a high level representation of a mechanism that maintains a '''Contacts list''' and handles subscriptions, publications and notifications that can be used by a GUI. It implements a combination of SIP SIMPLE standards related to presence event package, storage and policy. |
6 | 14 | Adrian Georgescu | |
7 | 54 | Adrian Georgescu | * Storage |
8 | 41 | Adrian Georgescu | * Contacts |
9 | 44 | Adrian Georgescu | * Watcher list |
10 | 1 | Adrian Georgescu | * Presence rules |
11 | 1 | Adrian Georgescu | * Icon exchange |
12 | 41 | Adrian Georgescu | * Preferences |
13 | 1 | Adrian Georgescu | |
14 | 53 | Adrian Georgescu | == Storage == |
15 | 1 | Adrian Georgescu | |
16 | 54 | Adrian Georgescu | The client maintains a '''Contacts list''' that is a concatenated list of resource-lists stored on multiple XCAP servers. A Contact is stored on exactly one XCAP server to provide atomic transaction. When a Contact is added/modified/deleted the corespondent remote XCAP storage is accessed. The remote storage is set per Contact in the Add/Edit Contact dialog. |
17 | 50 | Adrian Georgescu | |
18 | 1 | Adrian Georgescu | [[Image(BuddyList-Aggregation.png)]] |
19 | 1 | Adrian Georgescu | |
20 | 49 | Adrian Georgescu | == Prerequisites == |
21 | 49 | Adrian Georgescu | |
22 | 50 | Adrian Georgescu | To implement full presence support the following functionality must be available in the servers side. |
23 | 50 | Adrian Georgescu | |
24 | 53 | Adrian Georgescu | 1. ~~Support in OpenXCAP for '''icon''' application, http://openxcap.org/ticket/100~~ |
25 | 53 | Adrian Georgescu | 1. ~~Support in OpenXCAP for '''xcap-directory''' application, http://openxcap.org/ticket/101~~ |
26 | 1 | Adrian Georgescu | 1. OpenSIPS '''xcap-diff''' module to perform refresh_watchers() |
27 | 53 | Adrian Georgescu | 1. ~~OpenSIPS '''dialog-info''' module to use XCAP document dialog-rules for authorization~~ |
28 | 50 | Adrian Georgescu | 1. OpenSIPS '''dialog-info''' module to sent notify for dialog-info.winfo Event |
29 | 50 | Adrian Georgescu | 1. OpenXCAP to perform PUBLISH for xcap-diff when any xcap doc changes |
30 | 53 | Adrian Georgescu | 1. ~~Implement caps payload type in client (device capabilities)~~ |
31 | 53 | Adrian Georgescu | 1. ~~Implement dialog-info event package in client~~ |
32 | 53 | Adrian Georgescu | 1. Replace OpenXCAP mi command for xcap-diff with a SIP PUBLISH |
33 | 47 | Adrian Georgescu | |
34 | 1 | Adrian Georgescu | == Account == |
35 | 1 | Adrian Georgescu | |
36 | 54 | Adrian Georgescu | On boot: |
37 | 1 | Adrian Georgescu | |
38 | 54 | Adrian Georgescu | If account.xcap is enabled |
39 | 54 | Adrian Georgescu | |
40 | 1 | Adrian Georgescu | * If '''account.xcap.xcap_root''' is not defined, locate XCAP root by doing a DNS TXT lookup for xcap.example.com |
41 | 1 | Adrian Georgescu | * GET XCAP application xcap-caps |
42 | 1 | Adrian Georgescu | * GET the default filename for all applications supported in xcap-caps and cache them locally |
43 | 54 | Adrian Georgescu | * If '''account.xcap.subscribe_xcap_diff''' is enabled, SUBSCRIBE for '''Event: xcap-diff''' |
44 | 54 | Adrian Georgescu | |
45 | 54 | Adrian Georgescu | If account.presence.enable_publish is enabled |
46 | 54 | Adrian Georgescu | |
47 | 54 | Adrian Georgescu | * If '''pidf-manipulation''' application is supported by XCAP server, update the '''presentity''' with the PIDF stored on the XCAP server |
48 | 1 | Adrian Georgescu | * Initialize own '''presentity''' |
49 | 54 | Adrian Georgescu | |
50 | 54 | Adrian Georgescu | If account.presence.subscribe_winfo is enabled |
51 | 54 | Adrian Georgescu | |
52 | 1 | Adrian Georgescu | * Initialize '''watchers list''' for Event presence |
53 | 54 | Adrian Georgescu | * Send Subscribe for ''presence.winfo'' |
54 | 1 | Adrian Georgescu | |
55 | 54 | Adrian Georgescu | If account.presence.resource_lists is enabled |
56 | 54 | Adrian Georgescu | |
57 | 54 | Adrian Georgescu | * Initialize the '''Contact List''' by using the content of the XCAP document '''resource-lists''' |
58 | 54 | Adrian Georgescu | |
59 | 1 | Adrian Georgescu | While running |
60 | 1 | Adrian Georgescu | |
61 | 1 | Adrian Georgescu | * Refresh the XCAP server location based on DNS TTL |
62 | 48 | Adrian Georgescu | * Reload XCAP documents based on '''xcap-diff''' NOTIFYs |
63 | 47 | Adrian Georgescu | |
64 | 54 | Adrian Georgescu | == Contacts List == |
65 | 48 | Adrian Georgescu | |
66 | 54 | Adrian Georgescu | The ''Contacts List'' contains is a list of contacts displayed by the GUI. For some contacts we SUBSCRIBE for '''Event: presence'''. The list is indexed by a unique SIP URI, a random SIP URI must be generated for contacts that do not have a SIP URI and we must mark the contacts that we want to subscribe to. |
67 | 15 | Adrian Georgescu | |
68 | 54 | Adrian Georgescu | Additional, one can store full names and other attributes for each contact by using extensions to PIDF for contact information (cipid extension). |
69 | 1 | Adrian Georgescu | |
70 | 1 | Adrian Georgescu | Based on received NOTIFY messages for Event=presence, each contact has a '''presentity''' attribute that contains its own published information. The GUI can display attributes of each '''presentity'''. |
71 | 1 | Adrian Georgescu | |
72 | 1 | Adrian Georgescu | * The contacts list is stored in the main '''resource-lists''' XCAP document '''index''' |
73 | 1 | Adrian Georgescu | * Maintain a '''presentity''' attribute with what is received in the Notify for presence for each contact |
74 | 1 | Adrian Georgescu | * If '''account.presence.subscribe_rls_services''' is True, a RLS document that contains a list of discrete SIP URIs we subscribe to and PUT it on the server under SIP URI account-buddies@domain. Then a Subscribe is sent with Supported: eventlist for this SIP URI. /otherwise send SUBSCRIBVE to each contact for '''Event: presence''' |
75 | 1 | Adrian Georgescu | * On contacts list change, PUT resource-lists and rls-services documents on the XCAP server |
76 | 1 | Adrian Georgescu | |
77 | 1 | Adrian Georgescu | A contact has properties related to his device capabilities (e.g. can_chat, can_share, can_talk, can_video). This is conveyed via '''presence caps''' and updates the preferences set by the local user |
78 | 1 | Adrian Georgescu | |
79 | 1 | Adrian Georgescu | == Watcher lists == |
80 | 1 | Adrian Georgescu | |
81 | 1 | Adrian Georgescu | * Built based on the body of NOTIFY for '''Event=presence.winfo'''. |
82 | 48 | Adrian Georgescu | |
83 | 53 | Adrian Georgescu | == Presence rules == |
84 | 53 | Adrian Georgescu | |
85 | 54 | Adrian Georgescu | * Based on NOTIFY for event '''watcher.info''' we alert the user about new watchers and we update the policy stored in pres-rules document |
86 | 54 | Adrian Georgescu | * PUT '''pres-rules''' document on the XCAP server and cache it locally |
87 | 53 | Adrian Georgescu | |
88 | 54 | Adrian Georgescu | Transformations are required to support the following functionality: |
89 | 35 | Adrian Georgescu | |
90 | 54 | Adrian Georgescu | 1. First degree watchers - access to entire PIDF |
91 | 54 | Adrian Georgescu | 1. Second degree watchers - access to subset of PIDF |
92 | 54 | Adrian Georgescu | 1. Third degree watchers - access to basic presence online/offline |
93 | 32 | Adrian Georgescu | |
94 | 1 | Adrian Georgescu | == Icon exhange == |
95 | 1 | Adrian Georgescu | |
96 | 26 | Adrian Georgescu | There is how OMA has specified such XCAP application: |
97 | 32 | Adrian Georgescu | |
98 | 1 | Adrian Georgescu | '"Presence Content XDM Specification'" |
99 | 1 | Adrian Georgescu | |
100 | 48 | Adrian Georgescu | http://www.openmobilealliance.org/technical/release_program/docs/PresenceSIMPLE/V2_0-20081223-C/OMA-TS-Presence_SIMPLE_Content_XDM-V1_0-20081223-C.pdf |
101 | 1 | Adrian Georgescu | |
102 | 1 | Adrian Georgescu | Publishing end-point, on boot: |
103 | 9 | Adrian Georgescu | |
104 | 1 | Adrian Georgescu | 1. HTTP GET for xcap-directory and locate previously uploaded icon (e.g. ABC) |
105 | 32 | Adrian Georgescu | 1. HTTP GET http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/ABC |
106 | 9 | Adrian Georgescu | |
107 | 1 | Adrian Georgescu | Publishing end-point, on icon change: |
108 | 32 | Adrian Georgescu | |
109 | 9 | Adrian Georgescu | 1. Generate a new random filename: XYZ |
110 | 9 | Adrian Georgescu | 1. Build URL http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/XYZ |
111 | 41 | Adrian Georgescu | 1. HTTP PUT to xcap server |
112 | 41 | Adrian Georgescu | 1. Update <icon> element of pidf and PUBLISH new pidf |
113 | 41 | Adrian Georgescu | 1. HTTP DELETE any previous icon file ABC |
114 | 41 | Adrian Georgescu | |
115 | 1 | Adrian Georgescu | Subscribing end-point: |
116 | 48 | Adrian Georgescu | |
117 | 48 | Adrian Georgescu | 1. Parse <icon> element of pidf received in Notify |
118 | 1 | Adrian Georgescu | 2. HTTP GET http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/XYZ |
119 | 1 | Adrian Georgescu | 3. Cache picture until next NOTIFY with diferent <icon> element is received |
120 | 1 | Adrian Georgescu | |
121 | 1 | Adrian Georgescu |