DesignBuddyList
Version 39 (Adrian Georgescu, 08/04/2009 05:55 pm)
1 | 27 | Adrian Georgescu | = Presence blueprint = |
---|---|---|---|
2 | 2 | Adrian Georgescu | |
3 | 2 | Adrian Georgescu | [[TOC(Design*, depth=1)]] |
4 | 1 | Adrian Georgescu | |
5 | 23 | Adrian Georgescu | This is a high level class that can be used to manage a buddy list driven interface of a SIP client graphical user interface. It implements a combination of SIP SIMPLE standards related to presence event package, its storage and policy. |
6 | 14 | Adrian Georgescu | |
7 | 1 | Adrian Georgescu | * Account |
8 | 39 | Adrian Georgescu | * Buddy list (Contacts) |
9 | 13 | Adrian Georgescu | * Presence watcher list |
10 | 1 | Adrian Georgescu | * Presence rules |
11 | 15 | Adrian Georgescu | * Dialog watcher list |
12 | 1 | Adrian Georgescu | * Dialog rules |
13 | 15 | Adrian Georgescu | * Icon exchange |
14 | 38 | Adrian Georgescu | |
15 | 1 | Adrian Georgescu | == Account == |
16 | 1 | Adrian Georgescu | |
17 | 1 | Adrian Georgescu | This is the same entity that Registers and does other operations in behalf of the SIP account. |
18 | 25 | Adrian Georgescu | |
19 | 1 | Adrian Georgescu | On boot |
20 | 1 | Adrian Georgescu | |
21 | 39 | Adrian Georgescu | * If '''account.presence.xcap_root''' is not defined, locate XCAP root by doing a DNS TXT lookup for xcap.example.com, deal with DNS timeout |
22 | 25 | Adrian Georgescu | * GET XCAP application xcap-caps |
23 | 39 | Adrian Georgescu | * GET the default filename for the applications supported in xcap-caps and cache them locally |
24 | 39 | Adrian Georgescu | * If '''pres-rules''' application is supported by XCAP server, send Subscribe for event presence.info and initialize presence '''watchers''' list |
25 | 39 | Adrian Georgescu | * If '''icon''' application is supported by XCAP server, GET curent icon image from the xcap server |
26 | 39 | Adrian Georgescu | * If '''dialog-rules''' application is supported by XCAP server, send Subscribe for event dialog.info and initialize dialog '''watchers''' list |
27 | 39 | Adrian Georgescu | * if '''pidf-manipulation''' application is supported by XCAP server, update the '''presentity''' with '''pidf-manipulation''' document |
28 | 39 | Adrian Georgescu | * Initialize the '''buddy list''' |
29 | 39 | Adrian Georgescu | * Initialize own '''presentity''' |
30 | 26 | Adrian Georgescu | * Send PUBLISH for '''Event: presence''' |
31 | 26 | Adrian Georgescu | * If '''account.message_summary.enabled''' SUBSCRIBE for '''Event: message-summary''' |
32 | 25 | Adrian Georgescu | * If '''account.presence.subscribe_xcap_diff.enabled''' SUBSCRIBE for '''Event: xcap-diff''' |
33 | 1 | Adrian Georgescu | |
34 | 1 | Adrian Georgescu | While running |
35 | 1 | Adrian Georgescu | |
36 | 25 | Adrian Georgescu | * Refresh XCAP server location based on DNS TTL |
37 | 26 | Adrian Georgescu | * Refresh PUBLISH for event '''presence''' |
38 | 26 | Adrian Georgescu | * Refresh SUBSCRIBE to '''presence.winfo''' |
39 | 26 | Adrian Georgescu | * Refresh SUBSCRIBE to '''dialog.winfo''' |
40 | 29 | Adrian Georgescu | * Refresh SUBSCRIBE to '''xcap-diff''' |
41 | 1 | Adrian Georgescu | * Refresh SUBSCRIBE to '''message-summary''' |
42 | 1 | Adrian Georgescu | * Reload XCAP documents based on '''xcap-diff''' NOTIFYs |
43 | 30 | Adrian Georgescu | * Update '''presentity''' based on GUI actions or automatic sensors and cache it |
44 | 30 | Adrian Georgescu | |
45 | 25 | Adrian Georgescu | Long term state |
46 | 17 | Adrian Georgescu | |
47 | 1 | Adrian Georgescu | * Update '''pidf-manipulation document''' and '''presentity''' |
48 | 28 | Adrian Georgescu | |
49 | 14 | Adrian Georgescu | == Buddy list == |
50 | 1 | Adrian Georgescu | |
51 | 28 | Adrian Georgescu | Contains a list of buddies we SUBSCRIBE to for '''Event: presence'''. The buddy 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 e must musk buddies we want to subscribe to by setting a particular flag for each of them. Additional, one can store full names and other attributes for each buddy by using extensions to pidf for contact information. Based on NOTIFY for Event=presence each buddy has a '''presentity''' attribute that contains its published information. The GUI displays various attributes of each '''presentity'''. |
52 | 17 | Adrian Georgescu | |
53 | 39 | Adrian Georgescu | * The buddy list displayed as Contacts is stored in the main '''resource-lists''' XCAP document '''index''' |
54 | 25 | Adrian Georgescu | * Maintain a '''presentity''' attribute with what is received in the Notify for each buddy |
55 | 25 | 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 buddy for '''Event: presence''' |
56 | 25 | Adrian Georgescu | * On buddy lists change, PUT resource-lists and rls-services documents on the XCAP server and cache them locally |
57 | 25 | Adrian Georgescu | * account.presence.subscribe_rls_services must be normalized when set to '''auto''' |
58 | 37 | Adrian Georgescu | |
59 | 39 | Adrian Georgescu | A buddy has properties related to his device capabilities (e.g. can_chat, can_share, can_talk, can_video). This is conveyed via '''presence caps''' |
60 | 37 | Adrian Georgescu | |
61 | 1 | Adrian Georgescu | == Presence watcher lists == |
62 | 1 | Adrian Georgescu | |
63 | 28 | Adrian Georgescu | Built based on the body of NOTIFY for '''Event=presence.winfo'''. |
64 | 1 | Adrian Georgescu | |
65 | 1 | Adrian Georgescu | == Presence rules == |
66 | 20 | Adrian Georgescu | |
67 | 28 | Adrian Georgescu | * Based on NOTIFY for event '''watcher.info''' we update the policy |
68 | 28 | Adrian Georgescu | * PUT '''pres-rules''' document on the XCAP server and cache locally |
69 | 15 | Adrian Georgescu | |
70 | 15 | Adrian Georgescu | == Dialog watcher lists == |
71 | 1 | Adrian Georgescu | |
72 | 28 | Adrian Georgescu | Built based on the body of NOTIFY for '''event=dialog.winfo'''. To be built in OpenSIPS. |
73 | 1 | Adrian Georgescu | |
74 | 1 | Adrian Georgescu | == Dialog rules == |
75 | 1 | Adrian Georgescu | |
76 | 28 | Adrian Georgescu | Based on NOTIFY for event '''dialog.winfo''' we update the policy and PUT '''dialog-rules''' document on the XCAP server. To be built in OpenXCAP server. |
77 | 1 | Adrian Georgescu | |
78 | 9 | Adrian Georgescu | == Icon exhange == |
79 | 1 | Adrian Georgescu | |
80 | 35 | Adrian Georgescu | There is how OMA has specified such XCAP application: |
81 | 1 | Adrian Georgescu | |
82 | 35 | Adrian Georgescu | '"Presence Content XDM Specification'" |
83 | 36 | Adrian Georgescu | |
84 | 35 | 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 |
85 | 33 | Adrian Georgescu | |
86 | 1 | Adrian Georgescu | Support in OpenXCAP server is necessary, see http://openxcap.org/ticket/100 |
87 | 9 | Adrian Georgescu | |
88 | 26 | Adrian Georgescu | Publishing end-point, on boot: |
89 | 32 | Adrian Georgescu | |
90 | 32 | Adrian Georgescu | 1. HTTP GET for xcap-directory and locate previously uploaded icon (e.g. ABC) |
91 | 26 | Adrian Georgescu | 1. HTTP GET http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/ABC |
92 | 32 | Adrian Georgescu | |
93 | 1 | Adrian Georgescu | Publishing end-point, on change: |
94 | 9 | Adrian Georgescu | |
95 | 1 | Adrian Georgescu | 1. Generate a new random filename: XYZ |
96 | 32 | Adrian Georgescu | 1. Build URL http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/XYZ |
97 | 9 | Adrian Georgescu | 1. HTTP PUT to xcap server |
98 | 1 | Adrian Georgescu | 1. Update <icon> element of pidf and PUBLISH new pidf |
99 | 32 | Adrian Georgescu | 1. HTTP DELETE any previous icon file ABC |
100 | 9 | Adrian Georgescu | |
101 | 9 | Adrian Georgescu | Subscribing end-point: |
102 | 9 | Adrian Georgescu | |
103 | 9 | Adrian Georgescu | 1. Parse <icon> element of pidf received in Notify |
104 | 32 | Adrian Georgescu | 2. HTTP GET http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/XYZ |
105 | 26 | Adrian Georgescu | 3. Cache picture until next NOTIFY with diferent <icon> element is received |