DesignBuddyList » History » Version 52
Adrian Georgescu, 10/23/2009 07:15 AM
1 | 27 | Adrian Georgescu | = Presence blueprint = |
---|---|---|---|
2 | 2 | Adrian Georgescu | |
3 | [[TOC(Design*, depth=1)]] |
||
4 | 1 | Adrian Georgescu | |
5 | 46 | Adrian Georgescu | This is a high level representation of a mechanism that maintains a '''Contacts list''' 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 | 1 | Adrian Georgescu | * Account |
8 | 41 | Adrian Georgescu | * Contacts |
9 | 44 | Adrian Georgescu | * Watcher list |
10 | 1 | Adrian Georgescu | * Presence rules |
11 | * Icon exchange |
||
12 | 41 | Adrian Georgescu | * Preferences |
13 | 1 | Adrian Georgescu | |
14 | 50 | Adrian Georgescu | == Design principle == |
15 | 1 | Adrian Georgescu | |
16 | 51 | Adrian Georgescu | The client maintains a '''Contacts list''' that is a concatenated list of resource-lists XCAP documents 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 | |||
20 | 49 | Adrian Georgescu | == Prerequisites == |
21 | |||
22 | 50 | Adrian Georgescu | To implement full presence support the following functionality must be available in the servers side. |
23 | |||
24 | 1. Support in OpenXCAP for '''icon''' application, http://openxcap.org/ticket/100 |
||
25 | 1. Support in OpenXCAP for '''xcap-directory''' application, http://openxcap.org/ticket/101 |
||
26 | 1. OpenSIPS '''xcap-diff''' module to perform refresh_watchers() |
||
27 | 1. OpenSIPS '''dialog-info''' module to use XCAP document dialog-rules for authorization |
||
28 | 1. OpenSIPS '''dialog-info''' module to sent notify for dialog-info.winfo Event |
||
29 | 48 | Adrian Georgescu | 1. OpenXCAP to perform PUBLISH for xcap-diff when any xcap doc changes |
30 | 1. Implement caps payload type in client (device capabilities) |
||
31 | 1. Implement dialog-info event package in client |
||
32 | 47 | Adrian Georgescu | |
33 | 48 | Adrian Georgescu | == Account == |
34 | 1 | Adrian Georgescu | |
35 | 48 | Adrian Georgescu | On boot if presence enabled |
36 | |||
37 | 1 | Adrian Georgescu | * If '''account.presence.xcap_root''' is not defined, locate XCAP root by doing a DNS TXT lookup for xcap.example.com |
38 | * GET XCAP application xcap-caps |
||
39 | * GET the default filename for all applications supported in xcap-caps and cache them locally |
||
40 | 48 | Adrian Georgescu | * Initialize own '''presentity''' |
41 | * Initialize '''watchers list''' for Event presence |
||
42 | * Initialize '''watchers list''' for Event dialog-info |
||
43 | * If '''pidf-manipulation''' application is supported by XCAP server, update the '''presentity''' with the PIDF stored on the XCAP server |
||
44 | 52 | Adrian Georgescu | * Replace OpenXCAP mi command for xcap-diff with a SIP PUBLISH |
45 | 1 | Adrian Georgescu | * Initialize '''Contacts''' using the content of the XCAP document '''resource-lists''' |
46 | 48 | Adrian Georgescu | * If '''account.presence.subscribe_xcap_diff''' is Enabled, SUBSCRIBE for '''Event: xcap-diff''' |
47 | 1 | Adrian Georgescu | |
48 | 48 | Adrian Georgescu | While running |
49 | 1 | Adrian Georgescu | |
50 | * Refresh the XCAP server location based on DNS TTL |
||
51 | * Reload XCAP documents based on '''xcap-diff''' NOTIFYs |
||
52 | 47 | Adrian Georgescu | |
53 | 1 | Adrian Georgescu | == Contacts == |
54 | |||
55 | 48 | Adrian Georgescu | Contains is a list of contacts displayed in a GUI. For some contacts we SUBSCRIBE for '''Event: presence''' and '''Event: dialog-info'''. 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. |
56 | 47 | Adrian Georgescu | |
57 | Additional, one can store full names and other attributes for each contact by using extensions to PIDF for contact information. |
||
58 | |||
59 | 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'''. |
||
60 | 41 | Adrian Georgescu | |
61 | * The contacts list is stored in the main '''resource-lists''' XCAP document '''index''' |
||
62 | 48 | Adrian Georgescu | * Maintain a '''presentity''' attribute with what is received in the Notify for presence for each contact |
63 | * Maintain a '''dialog-info''' attribute with what is received in the Notify for dialog-info event for each contact |
||
64 | * 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''' |
||
65 | 47 | Adrian Georgescu | * On contacts list change, PUT resource-lists and rls-services documents on the XCAP server |
66 | 15 | Adrian Georgescu | |
67 | 28 | 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 |
68 | 1 | Adrian Georgescu | |
69 | == Watcher lists == |
||
70 | |||
71 | 48 | Adrian Georgescu | * Built based on the body of NOTIFY for '''Event=presence.winfo'''. |
72 | * Built based on the body of NOTIFY for '''Event=dialog-info.winfo'''. |
||
73 | 1 | Adrian Georgescu | |
74 | 9 | Adrian Georgescu | == Presence rules == |
75 | 1 | Adrian Georgescu | |
76 | 35 | Adrian Georgescu | * Based on NOTIFY for event '''watcher.info''' we update the policy |
77 | 1 | Adrian Georgescu | * PUT '''pres-rules''' document on the XCAP server and cache locally |
78 | 35 | Adrian Georgescu | |
79 | 36 | Adrian Georgescu | == Icon exhange == |
80 | 35 | Adrian Georgescu | |
81 | 33 | Adrian Georgescu | There is how OMA has specified such XCAP application: |
82 | 9 | Adrian Georgescu | |
83 | 26 | Adrian Georgescu | '"Presence Content XDM Specification'" |
84 | 32 | Adrian Georgescu | |
85 | http://www.openmobilealliance.org/technical/release_program/docs/PresenceSIMPLE/V2_0-20081223-C/OMA-TS-Presence_SIMPLE_Content_XDM-V1_0-20081223-C.pdf |
||
86 | 1 | Adrian Georgescu | |
87 | Publishing end-point, on boot: |
||
88 | 26 | Adrian Georgescu | |
89 | 32 | Adrian Georgescu | 1. HTTP GET for xcap-directory and locate previously uploaded icon (e.g. ABC) |
90 | 1 | Adrian Georgescu | 1. HTTP GET http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/ABC |
91 | |||
92 | 48 | Adrian Georgescu | Publishing end-point, on icon change: |
93 | 1 | Adrian Georgescu | |
94 | 1. Generate a new random filename: XYZ |
||
95 | 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 |
96 | 1 | Adrian Georgescu | 1. HTTP PUT to xcap server |
97 | 32 | Adrian Georgescu | 1. Update <icon> element of pidf and PUBLISH new pidf |
98 | 9 | Adrian Georgescu | 1. HTTP DELETE any previous icon file ABC |
99 | 1 | Adrian Georgescu | |
100 | 32 | Adrian Georgescu | Subscribing end-point: |
101 | 9 | Adrian Georgescu | |
102 | 1. Parse <icon> element of pidf received in Notify |
||
103 | 41 | Adrian Georgescu | 2. HTTP GET http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/XYZ |
104 | 3. Cache picture until next NOTIFY with diferent <icon> element is received |
||
105 | |||
106 | == Preferences == |
||
107 | 1 | Adrian Georgescu | |
108 | 48 | Adrian Georgescu | Manage the '''pres-rules''' and '''dialog-rules''' policy documents on XCAP server |
109 |