/* * Presence Agent, subscribe handling * * $Id: subscribe.c,v 1.24 2004/08/24 09:00:33 janakj Exp $ * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of ser, a free SIP server. * * ser is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version * * For a license to use the ser software under conditions * other than those described here, or to purchase support for this * software, please contact iptel.org by e-mail at the following addresses: * info@iptel.org * * ser is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * History: * --------- * 2003-02-29 scratchpad compatibility abandoned * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri) */ #include #include "../../str.h" #include "../../dprint.h" #include "../../mem/mem.h" #include "../../parser/parse_uri.h" #include "../../parser/parse_from.h" #include "../../parser/parse_expires.h" #include "../../parser/parse_event.h" #include "presentity.h" #include "watcher.h" #include "pstate.h" #include "notify.h" #include "paerrno.h" #include "pdomain.h" #include "pa_mod.h" #include "ptime.h" #include "reply.h" #include "subscribe.h" #define DOCUMENT_TYPE "application/cpim-pidf+xml" #define DOCUMENT_TYPE_L (sizeof(DOCUMENT_TYPE) - 1) static int accepts_to_event_package[N_DOCTYPES] = { [DOC_XPIDF] = EVENT_PRESENCE, [DOC_LPIDF] = EVENT_PRESENCE, [DOC_PIDF] = EVENT_PRESENCE, [DOC_WINFO] = EVENT_PRESENCE_WINFO, [DOC_XCAP_CHANGE] = EVENT_XCAP_CHANGE, [DOC_LOCATION] = EVENT_LOCATION, }; /* * A static variable holding document type accepted * by the watcher's user agent */ static doctype_t acc; /* * contact will be NULL if user is offline * fixme:locking */ void callback(str* _user, str *_contact, int state, void* data) { presentity_t *presentity; get_act_time(); presentity = (struct presentity*)data; if (presentity && callback_update_db) { presence_tuple_t *tuple = NULL; int orig; LOG(L_ERR, "callback: uri=%.*s contact=%.*s state=%d\n", presentity->uri.len, presentity->uri.s, (_contact ? _contact->len : 0), (_contact ? _contact->s : ""), state); if (_contact) { if (callback_lock_pdomain) lock_pdomain(presentity->pdomain); find_presence_tuple(_contact, presentity, &tuple); if (!tuple) { new_presence_tuple(_contact, act_time + default_expires, presentity, &tuple); add_presence_tuple(presentity, tuple); }; orig = tuple->state; if (state == 0) { tuple->state = PS_OFFLINE; } else { tuple->state = PS_ONLINE; } tuple->expires = act_time + default_expires; db_update_presentity(presentity); if (orig != state) { presentity->flags |= PFLAG_PRESENCE_CHANGED; } if (callback_lock_pdomain) unlock_pdomain(presentity->pdomain); } } } /* * Extract plain uri -- return URI without parameters * The uri will be in form username@domain * */ static int extract_plain_uri(str* _uri) { struct sip_uri puri; if (parse_uri(_uri->s, _uri->len, &puri) < 0) { paerrno = PA_URI_PARSE; LOG(L_ERR, "extract_plain_uri(): Error while parsing URI\n"); return -1; } _uri->s = puri.user.s; _uri->len = puri.host.s + puri.host.len - _uri->s; return 0; } /* * Get presentity URI, which is stored in R-URI */ int get_pres_uri(struct sip_msg* _m, str* _puri) { if (_m->new_uri.s) { _puri->s = _m->new_uri.s; _puri->len = _m->new_uri.len; } else { _puri->s = _m->first_line.u.request.uri.s; _puri->len = _m->first_line.u.request.uri.len; } LOG(L_ERR, "get_pres_uri: _puri=%.*s\n", _puri->len, _puri->s); if (extract_plain_uri(_puri) < 0) { LOG(L_ERR, "get_pres_uri(): Error while extracting plain URI\n"); return -1; } return 0; } static int get_watch_uri(struct sip_msg* _m, str* _wuri, str *_dn) { _wuri->s = get_from(_m)->uri.s; _wuri->len = get_from(_m)->uri.len; _dn->s = get_from(_m)->body.s; _dn->len = get_from(_m)->body.len; if (extract_plain_uri(_wuri) < 0) { LOG(L_ERR, "get_watch_uri(): Error while extracting plain URI\n"); return -1; } return 0; } /* * Parse Accept header field body * FIXME: This is ugly parser, write something more clean */ int parse_accept(struct hdr_field* _h, doctype_t* _a) { if (_h) { char* buffer; /* * All implementation must support xpidf so make * it the default */ *_a = DOC_XPIDF; buffer = pkg_malloc(_h->body.len + 1); if (!buffer) { paerrno = PA_NO_MEMORY; LOG(L_ERR, "parse_accept(): No memory left\n"); return -1; } memcpy(buffer, _h->body.s, _h->body.len); buffer[_h->body.len] = '\0'; if (strstr(buffer, "application/cpim-pidf+xml") || strstr(buffer, "application/pidf+xml")) { *_a = DOC_PIDF; } else if (strstr(buffer, "application/xpidf+xml")) { *_a = DOC_XPIDF; } else if (strstr(buffer, "text/lpidf")) { *_a = DOC_LPIDF; } else if (strstr(buffer, "application/watcherinfo+xml")) { *_a = DOC_WINFO; } else if (strstr(buffer, "application/xcap-change+xml")) { *_a = DOC_XCAP_CHANGE; } else if (strstr(buffer, "application/location+xml")) { *_a = DOC_LOCATION; } else { *_a = DOC_XPIDF; } pkg_free(buffer); return 0; } else { /* XP messenger is not giving an accept field, so default to lpidf */ *_a = DOC_XPIDF; return 0; } } /* * Parse all header fields that will be needed * to handle a SUBSCRIBE request */ static int parse_hfs(struct sip_msg* _m, int accept_header_required) { if ( (parse_headers(_m, HDR_FROM | HDR_EVENT | HDR_EXPIRES | HDR_ACCEPT, 0) == -1) || (_m->from==0)||(_m->event==0)||(_m->expires==0) || (_m->accept==0) ) { paerrno = PA_PARSE_ERR; LOG(L_ERR, "parse_hfs(): Error while parsing headers\n"); return -1; } if (parse_from_header(_m) < 0) { paerrno = PA_FROM_ERR; LOG(L_ERR, "parse_hfs(): From malformed or missing\n"); return -6; } if (_m->event) { if (parse_event(_m->event) < 0) { paerrno = PA_EVENT_PARSE; LOG(L_ERR, "parse_hfs(): Error while parsing Event header field\n"); return -8; } } if (_m->expires) { if (parse_expires(_m->expires) < 0) { paerrno = PA_EXPIRES_PARSE; LOG(L_ERR, "parse_hfs(): Error while parsing Expires header field\n"); return -9; } } if (_m->accept) { if (parse_accept(_m->accept, &acc) < 0) { paerrno = PA_ACCEPT_PARSE; LOG(L_ERR, "parse_hfs(): Error while parsing Accept header field\n"); return -10; } } else if (accept_header_required) { LOG(L_ERR, "no accept header\n"); acc = DOC_XPIDF; } return 0; } /* * Check if a message received has been constructed properly */ int check_message(struct sip_msg* _m) { if (_m->event) { event_t *event; if (!_m->event->parsed) parse_event(_m->event); event = (event_t*)(_m->event->parsed); if (event && (event->parsed != accepts_to_event_package[acc])) { char *accept_s = NULL; int accept_len = 0; if (_m->accept && _m->accept->body.len) { accept_s = _m->accept->body.s; accept_len = _m->accept->body.len; } LOG(L_ERR, "check_message(): Accepts %.*s not valid for event package et=%.*s\n", _m->accept->body.len, _m->accept->body.s, event->text.len, event->text.s); return -1; } } return 0; } /* * Create a new presentity and corresponding watcher list */ int create_presentity(struct sip_msg* _m, struct pdomain* _d, str* _puri, struct presentity** _p, struct watcher** _w) { time_t e; dlg_t* dialog; str watch_uri; str watch_dn; event_t *event = NULL; int et = 0; if (_m->event) { event = (event_t*)(_m->event->parsed); et = event->parsed; } else { et = EVENT_PRESENCE; } if (_m->expires) { e = ((exp_body_t*)_m->expires->parsed)->val; } else { e = default_expires; } if (e == 0) { *_p = 0; *_w = 0; DBG("create_presentity(): expires = 0\n"); return 0; } /* Convert to absolute time */ e += act_time; if (get_watch_uri(_m, &watch_uri, &watch_dn) < 0) { LOG(L_ERR, "create_presentity(): Error while extracting watcher URI\n"); return -1; } if (new_presentity(_d, _puri, _p) < 0) { LOG(L_ERR, "create_presentity(): Error while creating presentity\n"); return -2; } if (tmb.new_dlg_uas(_m, 200, &dialog) < 0) { paerrno = PA_DIALOG_ERR; LOG(L_ERR, "create_presentity(): Error while creating dialog state\n"); free_presentity(*_p); return -3; } if (et != EVENT_PRESENCE_WINFO) { if (add_watcher(*_p, &watch_uri, e, et, acc, dialog, &watch_dn, _w) < 0) { LOG(L_ERR, "create_presentity(): Error while adding a watcher\n"); tmb.free_dlg(dialog); free_presentity(*_p); return -4; } } else if (et == EVENT_PRESENCE_WINFO) { if (add_winfo_watcher(*_p, &watch_uri, e, et, acc, dialog, &watch_dn, _w) < 0) { LOG(L_ERR, "create_presentity(): Error while adding a winfo watcher\n"); tmb.free_dlg(dialog); free_presentity(*_p); return -5; } } add_presentity(_d, *_p); _d->reg(&watch_uri, _puri, (void*)callback, *_p); return 0; } /* * Update existing presentity and watcher list */ static int update_presentity(struct sip_msg* _m, struct pdomain* _d, struct presentity* _p, struct watcher** _w) { time_t e; dlg_t* dialog; str watch_uri; str watch_dn; event_t *event = NULL; int et = 0; if (_m->event) { event = (event_t*)(_m->event->parsed); et = event->parsed; } else { LOG(L_ERR, "update_presentity defaulting to EVENT_PRESENCE\n"); et = EVENT_PRESENCE; } if (_m->expires) { e = ((exp_body_t*)_m->expires->parsed)->val; } else { e = default_expires; } if (get_watch_uri(_m, &watch_uri, &watch_dn) < 0) { LOG(L_ERR, "update_presentity(): Error while extracting watcher URI\n"); return -1; } if (find_watcher(_p, &watch_uri, et, _w) == 0) { LOG(L_ERR, "update_presentity() found watcher\n"); if (e == 0) { if (et != EVENT_PRESENCE_WINFO) { if (remove_watcher(_p, *_w) < 0) { LOG(L_ERR, "update_presentity(): Error while deleting winfo watcher\n"); return -2; } } else { if (remove_winfo_watcher(_p, *_w) < 0) { LOG(L_ERR, "update_presentity(): Error while deleting winfo watcher\n"); return -2; } } (*_w)->expires = 0; /* The watcher will be freed after NOTIFY is sent */ if (!_p->watchers && !_p->winfo_watchers) { remove_presentity(_d, _p); } } else { e += act_time; if (update_watcher(*_w, e) < 0) { LOG(L_ERR, "update_presentity(): Error while updating watcher\n"); return -3; } } } else { if (e) { e += act_time; if (tmb.new_dlg_uas(_m, 200, &dialog) < 0) { paerrno = PA_DIALOG_ERR; LOG(L_ERR, "update_presentity(): Error while creating dialog state\n"); return -4; } if (et != EVENT_PRESENCE_WINFO) { if (add_watcher(_p, &watch_uri, e, et, acc, dialog, &watch_dn, _w) < 0) { LOG(L_ERR, "update_presentity(): Error while creating presentity\n"); tmb.free_dlg(dialog); return -5; } } else { if (add_winfo_watcher(_p, &watch_uri, e, et, acc, dialog, &watch_dn, _w) < 0) { LOG(L_ERR, "update_presentity(): Error while creating winfo watcher\n"); tmb.free_dlg(dialog); return -5; } } } else { DBG("update_presentity(): expires = 0 but no watcher found\n"); *_w = 0; } } return 0; } /* * Handle a registration request -- make sure aor exists in presentity table */ /* * Extract Address of Record */ #define MAX_AOR_LEN 256 int pa_extract_aor(str* _uri, str* _a) { static char aor_buf[MAX_AOR_LEN]; struct sip_uri puri; int user_len; if (parse_uri(_uri->s, _uri->len, &puri) < 0) { LOG(L_ERR, "pa_extract_aor(): Error while parsing Address of Record\n"); return -1; } if ((puri.user.len + puri.host.len + 1) > MAX_AOR_LEN) { LOG(L_ERR, "pa_extract_aor(): Address Of Record too long\n"); return -2; } _a->s = aor_buf; _a->len = puri.user.len; user_len = _a->len; memcpy(aor_buf, puri.user.s, puri.user.len); aor_buf[_a->len] = '@'; memcpy(aor_buf + _a->len + 1, puri.host.s, puri.host.len); _a->len += 1 + puri.host.len; #if 0 if (case_sensitive) { tmp.s = _a->s + user_len + 1; tmp.len = puri.host.len; strlower(&tmp); } else { strlower(_a); } #endif return 0; } int pa_handle_registration(struct sip_msg* _m, char* _domain, char* _s2) { struct pdomain* d = (struct pdomain*)_domain; struct presentity *presentity; str p_uri; struct to_body *from = NULL; int e = 0; // LOG(L_ERR, "pa_handle_registration() entered\n"); paerrno = PA_OK; d = (struct pdomain*)_domain; if (parse_hfs(_m, 0) < 0) { paerrno = PA_PARSE_ERR; LOG(L_ERR, "pa_handle_registration(): Error while parsing headers\n"); return -1; } from = get_from(_m); if (!from || (pa_extract_aor(&from->uri, &p_uri) < 0)) { LOG(L_ERR, "pa_handle_registration(): Error while extracting Address Of Record\n"); goto error; } if (_m->expires) { e = ((exp_body_t*)_m->expires->parsed)->val; } if (from) LOG(L_ERR, "pa_handle_registration: from=%.*s p_uri=%.*s expires=%d\n", from->uri.len, from->uri.s, p_uri.len, p_uri.s, e); lock_pdomain(d); if (find_presentity(d, &p_uri, &presentity) > 0) { LOG(L_ERR, "pa_handle_registration: find_presentity did not find presentity\n"); if (e > 0) { if (create_presentity_only(_m, d, &p_uri, &presentity) < 0) { LOG(L_ERR, "pa_handle_registration(): Error while creating new presentity\n"); goto error2; } } #if 0 else { presence_tuple_t *tuple = NULL; if (_m->contact) { struct hdr_field* ptr = _m->contact; while (ptr) { if (ptr->type == HDR_CONTACT) { if (!ptr->parsed && (parse_contact(ptr) < 0)) { goto next; } } if (find_presence_tuple(contact, presentity, &tuple) == 0) { tuple->state = PS_OFFLINE; } next: ptr = ptr->next; } } db_update_presentity(presentity); } #endif } if (presentity && e > 0) { LOG(L_ERR, "pa_handle_registration about to call d->reg p=%p expires=%d", presentity, e); d->reg(&presentity->uri, &presentity->uri, (void*)callback, presentity); } LOG(L_ERR, "pa_handle_registration about to return 1"); unlock_pdomain(d); return 1; error2: LOG(L_ERR, "pa_handle_registration about to return -1\n"); unlock_pdomain(d); return -1; error: LOG(L_ERR, "pa_handle_registration about to return -2\n"); return -1; } /* * Handle a subscribe Request */ int handle_subscription(struct sip_msg* _m, char* _domain, char* _s2) { struct pdomain* d; struct presentity *p; struct watcher* w; str p_uri; LOG(L_ERR, "handle_subscription() entered\n"); get_act_time(); paerrno = PA_OK; if (parse_hfs(_m, 1) < 0) { LOG(L_ERR, "handle_subscription(): Error while parsing message header\n"); goto error; } if (check_message(_m) < 0) { LOG(L_ERR, "handle_subscription(): Error while checking message\n"); goto error; } d = (struct pdomain*)_domain; if (get_pres_uri(_m, &p_uri) < 0) { LOG(L_ERR, "handle_subscription(): Error while extracting presentity URI\n"); goto error; } lock_pdomain(d); if (find_presentity(d, &p_uri, &p) > 0) { if (create_presentity(_m, d, &p_uri, &p, &w) < 0) { LOG(L_ERR, "handle_subscription(): Error while creating new presentity\n"); goto error2; } } else { if (update_presentity(_m, d, p, &w) < 0) { LOG(L_ERR, "handle_subscription(): Error while updating presentity\n"); goto error2; } } if (send_reply(_m) < 0) { LOG(L_ERR, "handle_subscription(): Error while sending reply\n"); goto error2; } if (p) { p->flags |= PFLAG_WATCHERINFO_CHANGED; } if (w) { w->flags |= WFLAG_SUBSCRIPTION_CHANGED; } LOG(L_ERR, "handle_subscription about to return 1: w->event_package=%d w->accept=%d p->flags=%x w->flags=%x w=%p\n", (w ? w->event_package : -1), (w ? w->accept : -1), (p ? p->flags : -1), (w ? w->flags : -1), w); unlock_pdomain(d); return 1; error2: LOG(L_ERR, "handle_subscription about to return -1\n"); unlock_pdomain(d); return -1; error: LOG(L_ERR, "handle_subscription about to send_reply and return -2\n"); send_reply(_m); return -1; } /* * Returns 1 if subscription exists and -1 if not */ int existing_subscription(struct sip_msg* _m, char* _domain, char* _s2) { struct pdomain* d; struct presentity* p; struct watcher* w; str p_uri, w_uri; str w_dn; int et = 0; if (_m->event) { event_t *event = (event_t*)(_m->event->parsed); et = event->parsed; } else { LOG(L_ERR, "existing_subscription defaulting to EVENT_PRESENCE\n"); et = EVENT_PRESENCE; } paerrno = PA_OK; if (parse_from_header(_m) < 0) { paerrno = PA_PARSE_ERR; LOG(L_ERR, "existing_subscription(): Error while parsing From header field\n"); goto error; } d = (struct pdomain*)_domain; if (get_pres_uri(_m, &p_uri) < 0) { LOG(L_ERR, "existing_subscription(): Error while extracting presentity URI\n"); goto error; } if (get_watch_uri(_m, &w_uri, &w_dn) < 0) { LOG(L_ERR, "existing_subscription(): Error while extracting watcher URI\n"); goto error; } lock_pdomain(d); if (find_presentity(d, &p_uri, &p) == 0) { if (find_watcher(p, &w_uri, et, &w) == 0) { LOG(L_ERR, "existing_subscription() found watcher\n"); unlock_pdomain(d); return 1; } } unlock_pdomain(d); return -1; error: send_reply(_m); return 0; } /* * Returns 1 if possibly a user agent can handle SUBSCRIBE * itself, 0 if it cannot for sure */ int pua_exists(struct sip_msg* _m, char* _domain, char* _s2) { return 0; }