[kamailio/kamailio] siptrace: fix tracing messages to database when destination uri not set (#1951)
New additions to siptrace module broke previous functionality. If sip_trace was used with no param and destination uri was not set then the current message would not have been traced to database. The current fix traces always the current message if siptrace function was called.
<!-- Kamailio Pull Request Template -->
<!-- IMPORTANT: - for detailed contributing guidelines, read: https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md - pull requests must be done to master branch, unless they are backports of fixes from master branch to a stable branch - backports to stable branches must be done with 'git cherry-pick -x ...' - code is contributed under BSD for core and main components (tm, sl, auth, tls) - code is contributed GPLv2 or a compatible license for the other components - GPL code is contributed with OpenSSL licensing exception -->
#### Pre-Submission Checklist <!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply --> <!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above--> <!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list --> - [ ] Commit message has the format required by CONTRIBUTING guide - [ ] Commits are split per component (core, individual modules, libs, utils, ...) - [ ] Each component has a single commit (if not, squash them into one commit) - [ ] No commits to README files for modules (changes must be done to docbook files in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change - [ ] Small bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds new functionality) - [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist: <!-- Go over all points below, and after creating the PR, tick the checkboxes that apply --> - [ ] PR should be backported to stable branches - [ ] Tested changes locally - [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description <!-- Describe your changes in detail -->
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/1951
-- Commit Summary --
* siptrace: fix tracing messages to database when destination uri not set
-- File Changes --
M src/modules/siptrace/siptrace.c (4)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/1951.patch https://github.com/kamailio/kamailio/pull/1951.diff
I did the fix but I think the implementation as it was it's a little broken. That is because you can trace only to database using sip_trace with no arguments, but you can't trace only to database if using correlation_id(this was the case in previous versions). With the new additions you can't trace a dialog only to database. I respected previous implementation, that's why duplicate URI was mandatory, but this check is skipped if sip_trace is used with 0 or 1 argument, which I didn't notice.
Ionut Ionita writes:
I did the fix but I think the implementation as it was it's a little broken. That is because you can trace only to database using sip_trace with no arguments, but you can't trace only to database if using correlation_id(this was the case in previous versions). With the new additions you can't trace a dialog only to database. I respected previous implementation, that's why duplicate URI was mandatory, but this check is skipped if sip_trace is used with 0 or 1 argument, which I didn't notice.
I don't understand from the above, if after this fix the very basic existing usage of siptrace module (if flag is set sip_trace(); adds the trace to db) works or not.
I would feel comfortable, if you would leave the 5.2 code of the simple usage untouched and write your extensions in new sections of the code rather than making the simple usage a special case in a more complex implementation.
-- Juha
@ionutionita92 pushed 1 commit.
5b59ef8612ae1944f43216b37ff94b79c1fea642 siptrace: add sip_trace example with trace type set to docs
Yes it works but the code in 5.2 is broken. Here's an example, maybe it's more clear:
sip_trace(); /* traces to database only no db url */ sip_trace("", "$var(correlation_id)"); /* does not work; requires valid duplicate uri */ // with my additions sip_trace("", "$var(correlation_id)", "d"); /* does not work; requires valid duplicate uri */
So there are basically 2 functions: - no arguments - trace to dabase only; - with any kind of arguments - trace to duplicate uri and(if set) to database;
Ionut Ionita writes:
Yes it works but the code in 5.2 is broken. Here's an example, maybe it's more clear:
sip_trace(); /* traces to database only no db url */ sip_trace("", "$var(correlation_id)"); /* does not work; requires valid duplicate uri */ // with my additions sip_trace("", "$var(correlation_id)", "d"); /* does not work; requires valid duplicate uri */
So there are basically 2 functions:
- no arguments - trace to dabase only;
- with any kind of arguments - trace to duplicate uri and(if set) to
database;
Then leave implementation of the working part (sip_trace();) as is and add code to fix the broken part.
-- Juha
That's what this commit does, it fixes sip_trace(). Regarding the other part, it's not that obvious to me because if no one reported this maybe it's not an issue and that's the desired usage, elseway I would have fixed it already.
I am merging, because I want to do some further adjustments.
Merged #1951 into master.
-
Daniel-Constantin Mierla -
Ionut Ionita
-
Juha Heinanen