rls

Minimal subscription expiration timeout in seconds.

If client supplies value, which is less than value of min_expiration, the server returns response "423 Interval too small" as described in [events].

Default value is 60.

Maximal subscription expiration timeout in seconds.

If client supplies value, which is more than value of max_expiration, the server shortens this value to value of this variable as described in [events].

Default value is 7200.

Default subscription expiration timeout in seconds.

If client doesn't supply subscription expiration timeout this value is used.

Default value is 3761.

This variable specifies authorization type for list watchers. Value can be one of:

Default value is empty. In this case “implict” authorization is used with an error message.

If set to 1 the module tries to do simplify XCAP queries - queries will be done for whole documents, not partial, thus the XCAP server may be simulated using standard web server. It has influence only on querying resource lists and it will work correctly only if there are no links to resource lists containg partial documents URIs (lists should be contained directly in main rls-services document).

Default value is 0.

If set to 1, RLS module stores all subscription data into database and reloads them on startup. Requires db_url to be set.

Default value is 0.

Database connection URL. It has to be specified if db_mode is set.

Default value is empty.

...
modparam("rls", "db_mode", 1)
modparam("rls", "db_url", "mysql://seri:heslo@127.0.0.1:3306/ser")
...

Max. number of notifications sent within one timer tick (experimental). It might be used to reduce SER's machine load if there are lots of changes in presence status.

Default value is 1000000. (Too high number which in praxis means unlimited.)

Interval in seconds when are processed internal notifications and sent NOTIFYs to subscribers.

Maximum number of nested lists. For example if set to 2, it it possible to use "list nested in list nested in root list".

Default value is -1 what means “unlimited”.

It is possible to use this for speedup - if you know, that you will need only “flat” lists (no nested lists), you can set this to 0. In this case RLS doesn't try to query XCAP server for “possibly netsted list URIs” and directly creates subscription to URIs in list like if they are URIs of standalone users.

Interval in seconds of timer which removes expired subscriptions.

If set to 1 and 408 response to NOTIFY arrives, the dialog is NOT destroyed like in the case of other non-2xx responses. Use for testing only. Default value is 0.

Delay in seconds of timer which triggers loading data from database after startup. This is needed due to dependencies on other modules (pa/presence_b2b) - we need that these modules will be successfully initialised before reading data from DB and querying these modules.

Default value is 3.

Handle subscription to resource list uri.

This function handles resource list subscription. XCAP document containing the list must be loaded before using one of query function (query_rls_services, query_resource_list).

...
if (method=="SUBSCRIBE") {
	if (!t_newtran()) {
		sl_reply_error();
	};
	
	if (query_rls_services()) {
		handle_rls_subscription("1");
	}
	else {
		# no such list exists -> process it with PA module
		handle_subscription("registrar");
	}
	break;
};
...

Test uri according to given template.

Function tries to compare username in To URI with given template. If there are different domains in To and From URIs, the function fails. There can be used "$uid" in template and it is replaced by value returned by get_from_uid.

In the future should be this function replaced by AVP operations but I was not able to do it with them now...

...	
if (method=="SUBSCRIBE") {
	if (!t_newtran()) {
		sl_reply_error();
		break;
	};
	
	if (lookup_domain("From")) {
		if (lookup_user("From")) {
			if (is_simple_rls_target("$uid-list")) {
				# takes From UID and makes XCAP query
				# for user's list named "default"
				if (!query_resource_list("default")) {
					t_reply("500", "XCAP query error");
					break;
				}
				handle_rls_subscription("1");
				break;
			}
		}
	}
}
...

Get list from global rls-services document.

Function loads "global resource list" from XCAP server. This list is then processed by RLS module using handle_rls_subscription.

Get user's resource list.

Function loads "user's resource list" from XCAP server. This list is then processed by RLS module using handle_rls_subscription.

Test if a resource list is loaded.

Function tests if a list was loaded using one of query functions (query_resource_list or query_rls_services) and returns 1 if yes and -1 otherwise.