DesignBuddyList
Version 20 (Adrian Georgescu, 07/13/2009 05:57 pm)
1 | 2 | Adrian Georgescu | = Buddy list = |
---|---|---|---|
2 | 2 | Adrian Georgescu | |
3 | 2 | Adrian Georgescu | [[TOC(Design*, depth=1)]] |
4 | 1 | Adrian Georgescu | |
5 | 14 | 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. |
6 | 14 | Adrian Georgescu | |
7 | 1 | Adrian Georgescu | * Account |
8 | 1 | Adrian Georgescu | * Address-book |
9 | 1 | Adrian Georgescu | * Buddy list |
10 | 13 | Adrian Georgescu | * Presence watcher list |
11 | 1 | Adrian Georgescu | * Presence rules |
12 | 15 | Adrian Georgescu | * Dialog watcher list |
13 | 1 | Adrian Georgescu | * Dialog rules |
14 | 15 | Adrian Georgescu | * Icon exchange |
15 | 1 | Adrian Georgescu | |
16 | 1 | Adrian Georgescu | == Account == |
17 | 1 | Adrian Georgescu | |
18 | 17 | Adrian Georgescu | On boot |
19 | 17 | Adrian Georgescu | |
20 | 19 | Adrian Georgescu | * Locate XCAP server by doing DNS TXT lookup for _xcap._tls.example.com |
21 | 19 | Adrian Georgescu | * GET documents xcap-caps, pres-rules, resource-lists, pidf-manipulation, rls-services, dialog-rules, icon, xcap-directory from XCAP server |
22 | 20 | Adrian Georgescu | * Cache documents |
23 | 1 | Adrian Georgescu | * Send Subscribe for event presence.info |
24 | 1 | Adrian Georgescu | * Send Subscribe for event dialog.info |
25 | 18 | Adrian Georgescu | * Send Subscribe for event message-summary |
26 | 18 | Adrian Georgescu | * Retrieve curent icon image from the xcap server icon auid |
27 | 18 | Adrian Georgescu | * Build presentity based on pidf-manipulation document, if present |
28 | 18 | Adrian Georgescu | * Send Publish for event presence |
29 | 18 | Adrian Georgescu | * If rls-services present in xcap-caps, enable RLS and send Subscribe for event presence with Supported=eventlist |
30 | 1 | Adrian Georgescu | |
31 | 17 | Adrian Georgescu | While running |
32 | 1 | Adrian Georgescu | |
33 | 19 | Adrian Georgescu | * Refresh XCAP server location based on DNS time to live |
34 | 17 | Adrian Georgescu | * Refresh Publish for event presence |
35 | 17 | Adrian Georgescu | * Refresh subscription to presence.info |
36 | 17 | Adrian Georgescu | * Refresh subscription to dialog.info |
37 | 17 | Adrian Georgescu | * Refresh subscription to message-summary |
38 | 17 | Adrian Georgescu | * Maintain a '''Presentity''' attribute received in Notify for each buddy |
39 | 17 | Adrian Georgescu | |
40 | 1 | Adrian Georgescu | == Address book == |
41 | 14 | Adrian Georgescu | |
42 | 14 | Adrian Georgescu | Use the OS standard address book |
43 | 14 | Adrian Georgescu | |
44 | 1 | Adrian Georgescu | == Buddy list == |
45 | 1 | Adrian Georgescu | |
46 | 17 | Adrian Georgescu | Contains list of buddies. The buddylist is indexed by the SIP URI. Additional, one can store full names and other attributes. Based on NOTIFY for event=presence each buddy has a '''Presentity''' attribute that contains published information. GUI displays parts of it. |
47 | 1 | Adrian Georgescu | |
48 | 20 | Adrian Georgescu | * The buddy list is stored in the main resource-lists XCAP document '''index''' |
49 | 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 is PUT on the server under SIP URI account-buddies@domain. Then a Subscribe is sent with Supported: eventlist for this SIP URI. |
50 | 20 | Adrian Georgescu | * On change, PUT resource-lists and rls-services documents on the XCAP server and cache locally |
51 | 13 | Adrian Georgescu | |
52 | 13 | Adrian Georgescu | == Presence watcher lists == |
53 | 1 | Adrian Georgescu | |
54 | 1 | Adrian Georgescu | Built based on the body of NOTIFY for event=presence.winfo. |
55 | 1 | Adrian Georgescu | |
56 | 1 | Adrian Georgescu | == Presence rules == |
57 | 1 | Adrian Georgescu | |
58 | 20 | Adrian Georgescu | * Based on NOTIFY for event watcher.info we update the policy |
59 | 20 | Adrian Georgescu | * PUT pres-rules document on the XCAP server and cache locally |
60 | 15 | Adrian Georgescu | |
61 | 15 | Adrian Georgescu | == Dialog watcher lists == |
62 | 15 | Adrian Georgescu | |
63 | 15 | Adrian Georgescu | Built based on the body of NOTIFY for event=dialog.winfo. To be built in OpenSIPS. |
64 | 12 | Adrian Georgescu | |
65 | 12 | Adrian Georgescu | == Dialog rules == |
66 | 15 | Adrian Georgescu | |
67 | 4 | Adrian Georgescu | Based on NOTIFY for event dialog.info we update the policy and PUT dialog-rules document on the XCAP server. To be built in OpenXCAP server. |
68 | 15 | Adrian Georgescu | |
69 | 4 | Adrian Georgescu | == Icon exhange == |
70 | 11 | Adrian Georgescu | |
71 | 11 | Adrian Georgescu | Support in OpenXCAP server is necessary, see http://openxcap.org/ticket/100 |
72 | 9 | Adrian Georgescu | |
73 | 1 | Adrian Georgescu | Publishing end-point, on change: |
74 | 9 | Adrian Georgescu | |
75 | 9 | Adrian Georgescu | 1. Generate a random filename: XYZ |
76 | 9 | Adrian Georgescu | 1. Build URL http://xcap.example.com/xcap-root/icon/users/sip:alice@example.com/XYZ.png |
77 | 9 | Adrian Georgescu | 1. HTTP PUT to xcap server |
78 | 9 | Adrian Georgescu | 1. Update <icon> element of pidf and PUBLISH new pidf |
79 | 9 | Adrian Georgescu | 1. HTTP GET for xcap-directory and locate previously uploaded icons |
80 | 1 | Adrian Georgescu | 1. HTTP DELETE any previous icon files |
81 | 9 | Adrian Georgescu | |
82 | 1 | Adrian Georgescu | On reboot: |
83 | 9 | Adrian Georgescu | |
84 | 9 | Adrian Georgescu | 1. HTTP GET for xcap-directory and locate previously uploaded icon (e.g. XYZ) |
85 | 1 | Adrian Georgescu | 1. HTTP GET http://xcap.example.com/xcap-root/icon/users/sip:alice@example.com/XYZ.png |
86 | 9 | Adrian Georgescu | |
87 | 9 | Adrian Georgescu | Subscribing end-point: |
88 | 9 | Adrian Georgescu | |
89 | 9 | Adrian Georgescu | 1. Parse <icon> element of pidf received in Notify |
90 | 9 | Adrian Georgescu | 2. HTTP GET http://xcap.example.com/xcap-root/icon/users/sip:alice@example.com/XYZ.png |
91 | 1 | Adrian Georgescu | 3. Cache picture and check periodically |