DesignBuddyList

Version 94 (Adrian Georgescu, 01/31/2010 12:27 am)

1 82 Adrian Georgescu
= Presence Functionality =
2 2 Adrian Georgescu
3 55 Adrian Georgescu
[[TOC(DesignBuddyList, depth=2)]]
4 1 Adrian Georgescu
5 88 Adrian Georgescu
This is a high level design for implementing the SIP SIMPLE standards related to ''presence'' and ''presence.winfo'' event packages into the ''SIP SIMPLE client'' that achieves the following goals:
6 1 Adrian Georgescu
7 94 Adrian Georgescu
 1. Manages a ''Contacts List''
8 94 Adrian Georgescu
 1. Controls the presence information published by a ''SIP account'', handles the Subscriptions and Notifications for the ''Contacts''
9 94 Adrian Georgescu
 1. Manages an ''Icon'' (a small size picture of the end user using the client)
10 1 Adrian Georgescu
11 86 Adrian Georgescu
The design requires a ''Presence Agent'' and an ''XCAP server'' serving the domain of the SIP account for which this functionality is desired.
12 86 Adrian Georgescu
13 1 Adrian Georgescu
== Contacts List ==
14 1 Adrian Georgescu
15 86 Adrian Georgescu
''Contacts List'' contains is a list of discrete contacts displayed by the GUI. It must be managed by the SIP client at a global level above the individual SIP account level.
16 59 Adrian Georgescu
17 86 Adrian Georgescu
The ''Contacts List'' is organized into ''Groups''. The ''SIP client'' maintains this central ''Groups List'' by merging all found groups on local and remote storage(s) and populates each group with all contacts found for them.
18 70 Adrian Georgescu
19 86 Adrian Georgescu
Some contacts are marked to Subscribe to them for ''Event: presence''. Based on received Notify messages for ''Event: presence'', each Contact has a ''presentity'' attribute that contains its own published information as pidf xml payload, the GUI can display attributes of it.
20 1 Adrian Georgescu
21 78 Adrian Georgescu
The following presence related payloads as used to generate the presentity payload used for publish:
22 78 Adrian Georgescu
23 78 Adrian Georgescu
 * Presence Data Model RFC4479
24 78 Adrian Georgescu
 * Rich Presence Extensions RFC4480
25 78 Adrian Georgescu
 * Contact Information for the Presence Information Data Format RFC4482
26 78 Adrian Georgescu
 * User Agent Capability Extension to Presence Information Data Format RFC5196
27 78 Adrian Georgescu
28 78 Adrian Georgescu
> Same Contact may end up belonging to different Groups if the same SIP address is stored on multiple XCAP servers in different groups.
29 1 Adrian Georgescu
 
30 1 Adrian Georgescu
=== Storage ===
31 76 Adrian Georgescu
32 79 Adrian Georgescu
The ''SIP client'' builds the ''Contacts List'' by concatenating the individual lists stored locally or on the ''resource-lists'' documents stored on the XCAP server corespondent to each SIP account. 
33 1 Adrian Georgescu
34 79 Adrian Georgescu
When a Contact is added/modified/deleted the corespondent remote XCAP storage documents are also updated. The remote storage is set per Contact in the Add/Edit Contact dialog of the SIP client. This remote server storage is used for initializing the locally cached Contacts List between restarts and to synchronize changes between multiple SIP UAs configured for the same SIP account.
35 79 Adrian Georgescu
36 1 Adrian Georgescu
[[Image(BuddyList-Aggregation.png)]]
37 1 Adrian Georgescu
38 78 Adrian Georgescu
== Account ==
39 1 Adrian Georgescu
40 79 Adrian Georgescu
Each SIP Account has settings in the middleware that affect the way it interacts with its correspondent Contacts
41 78 Adrian Georgescu
42 79 Adrian Georgescu
 * Subscribes to information related to who has subscribed to its own presence information and generate a policy document that is used for subsequent subscriptions and notifications by the Presence Agent
43 79 Adrian Georgescu
 * Stores its data into the XCAP server corespondent with the SIP account or locally if no XCAP server is available
44 1 Adrian Georgescu
45 87 Adrian Georgescu
=== Storage ===
46 78 Adrian Georgescu
47 1 Adrian Georgescu
If ''account.xcap'' is enabled
48 1 Adrian Georgescu
49 60 Adrian Georgescu
 * If ''account.xcap.xcap_root'' is not set, locate XCAP root by doing a DNS TXT lookup for xcap.example.com
50 1 Adrian Georgescu
 * GET XCAP application xcap-caps
51 1 Adrian Georgescu
 * GET XCAP application xcap-directory
52 1 Adrian Georgescu
 * For all supported applications returned by above step, GET their files and cache them locally
53 78 Adrian Georgescu
54 57 Adrian Georgescu
If ''Icon'' application is enabled
55 78 Adrian Georgescu
56 78 Adrian Georgescu
 * GET the previous icon using HTTP request
57 87 Adrian Georgescu
 * Refresh the location of the XCAP server based on DNS TTL
58 78 Adrian Georgescu
59 87 Adrian Georgescu
=== Publish  ===
60 78 Adrian Georgescu
61 61 Adrian Georgescu
If ''account.presence.enable_publish'' is enabled
62 78 Adrian Georgescu
63 78 Adrian Georgescu
  * If ''pidf-manipulation'' application is supported by the XCAP server, update the pidf with its content and update GUI with the fact that we have server based PIDF set  
64 1 Adrian Georgescu
  * Send Publish with the current pidf if pidf_manipulation is not set, let the user change his state manually if pidf_manipulation is set
65 78 Adrian Georgescu
66 87 Adrian Georgescu
If ''account.xcap'' is enabled and ''account.presence.resource_lists'' is enabled
67 1 Adrian Georgescu
68 54 Adrian Georgescu
 * Initialize the ''Contacts List'' by using the content of the XCAP document ''resource-lists'', filename ''index''. Initialize the ''Subscriptions List'' using the Contacts marked for ''Subscribe to Presence''
69 1 Adrian Georgescu
70 87 Adrian Georgescu
If ''account.xcap'' is enabled and  ''account.presence.rls_services'' is enabled
71 1 Adrian Georgescu
72 1 Adrian Georgescu
 * Put the content of ''Subscription List'' initialized above to the XCAP document ''rls-services'' identified by SIP URI account-buddies@domain.
73 54 Adrian Georgescu
74 78 Adrian Georgescu
=== Subscribe ===
75 1 Adrian Georgescu
76 87 Adrian Georgescu
If ''account.xcap'' is enabled and ''account.xcap.subscribe_xcap_diff'' is enabled
77 78 Adrian Georgescu
78 90 Adrian Georgescu
 * Sent Subscribe for ''Event: xcap-diff'' to the account own SIP address
79 1 Adrian Georgescu
80 87 Adrian Georgescu
If ''account.presence.subscribe_winfo'' is enabled
81 1 Adrian Georgescu
82 90 Adrian Georgescu
  * Send Subscribe for ''presence.winfo'' to the account own SIP address
83 62 Adrian Georgescu
84 87 Adrian Georgescu
If ''account.presence.subscribe_presence'' is enabled
85 87 Adrian Georgescu
86 90 Adrian Georgescu
 * If ''account.xcap'' is enabled and ''account.presence.subscribe_rls_services'' is True send one Subscribe for ''Event: presence'', and header ''Supported: eventlist'' to sip:account-buddies@domain
87 87 Adrian Georgescu
 * Else for each contact in the ''Subscriptions List'' send individual Subscribe for ''Event: presence''
88 87 Adrian Georgescu
89 78 Adrian Georgescu
=== Notify ===
90 78 Adrian Georgescu
91 78 Adrian Georgescu
 * On Notify for ''Event: xcap-diff'' that a supported XCAP document has been changed by other SIP UA GET the new document
92 78 Adrian Georgescu
 * On Notify for ''Event: presence'' update the presentity of affected Contacts
93 87 Adrian Georgescu
 * On Notify for ''Event: presence.winfo'' trigger notifications end user to update its policy
94 1 Adrian Georgescu
95 59 Adrian Georgescu
> Each individual contact list stored in a resource-lists document is indexed by a unique SIP URI, a random SIP URI must be generated for Contacts that do not have a real SIP URI and we must mark the contacts that we want to Subscribe to for presence information. Additional, one can store full names and other attributes related to remote recipient by using extensions to PIDF for contact information (cipid extension). 
96 54 Adrian Georgescu
97 91 Adrian Georgescu
=== Policy change ===
98 62 Adrian Georgescu
99 87 Adrian Georgescu
 * Based on Notify for ''Event: presence.winfo'' alert the user about new watchers
100 87 Adrian Georgescu
 * If ''account.xcap'' is enabled PUT ''pres-rules'' document on the XCAP server
101 32 Adrian Georgescu
102 1 Adrian Georgescu
Transformations are required to support the following functionality:
103 56 Adrian Georgescu
104 1 Adrian Georgescu
 1.  First degree watchers - access to entire PIDF
105 1 Adrian Georgescu
 1.  Second degree watchers - access to subset of PIDF
106 59 Adrian Georgescu
 1.  Third degree watchers - access to basic presence online/offline
107 32 Adrian Georgescu
108 94 Adrian Georgescu
== Icon ==
109 1 Adrian Georgescu
110 9 Adrian Georgescu
Publishing end-point:
111 41 Adrian Georgescu
112 59 Adrian Georgescu
 1. Generate a new random filename: XYZ
113 41 Adrian Georgescu
 1. Build URL http://xcap.example.com/xcap-root/org.openmobilealliance.pres-content/users/sip:alice@example.com/oma_status-icon/XYZ
114 59 Adrian Georgescu
 1. PUT the new icon document to XCAP server
115 48 Adrian Georgescu
 1. Update <icon> element of pidf and PUBLISH new pidf
116 56 Adrian Georgescu
 1. DELETE any previously uploaded icon file
117 1 Adrian Georgescu
118 69 Adrian Georgescu
Subscribing end-point:
119 1 Adrian Georgescu
120 69 Adrian Georgescu
 1. Parse <icon> element of pidf cipid extension received in Notify
121 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
122 1 Adrian Georgescu
 3. Cache picture until next Notify with diferent <icon> element is received
123 1 Adrian Georgescu
124 91 Adrian Georgescu
The icon is common across all accounts, it must be put on all XCAP servers for all active accounts.
125 91 Adrian Georgescu
126 92 Adrian Georgescu
== Notifications ==
127 84 Adrian Georgescu
128 92 Adrian Georgescu
The SIP client must be notified by the middleware when a network event related to Presence occurs:
129 1 Adrian Georgescu
130 91 Adrian Georgescu
 1. ''Watcher list'' has changed
131 91 Adrian Georgescu
 1. Account has activated/deactivated to update the ''Contacts List''
132 84 Adrian Georgescu
 1. Presence information of a Contact has changed
133 84 Adrian Georgescu
 1. A conflict exists between the server version and the local version of an XCAP document
134 1 Adrian Georgescu
 
135 84 Adrian Georgescu
Each ''Contact'' can publish properties related to his device capabilities (e.g. chat, audio, video). This is conveyed via ''caps'' extension to ''pidf'' and can be used to drive the contextual menu presented for each Contact related to what kind of action can be initiated to it.
136 84 Adrian Georgescu
137 92 Adrian Georgescu
== Actions ==
138 84 Adrian Georgescu
139 84 Adrian Georgescu
 1. Display and manages the ''Contacts List''
140 91 Adrian Georgescu
 1. Display attributes of the Presence information of each Contact 
141 84 Adrian Georgescu
 1. Manage the content of the ''Policy'' document
142 84 Adrian Georgescu
 1. Update the ''Icon'' of the SIP account