[sr-dev] [kamailio/kamailio] pv_headers: Add support to remove a specific value from a header (PR #3070)

[Tomohare]

- To be used with headers containing values separated by commas
- pvh_header_param_exists() check if the value is present to a given header
- pvh_remove_header_param() remove the value from the given header or the entire header if no other value is present

<!-- 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 -->
- [X] Commit message has the format required by CONTRIBUTING guide
- [X] Commits are split per component (core, individual modules, libs, utils, ...)
- [X] Each component has a single commit (if not, squash them into one commit)
- [X] 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)
- [X] 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
- [X] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)

#### Description
<!-- Describe your changes in detail -->
Previously, to remove a parameter from a header it was needed to create a complex method on the configuration file for each header/parameter. This modification moves this complexity to the 'pv_headers' module.

Two new functions:
  * pvh_header_param_exists
  * pvh_remove_header_param

Both functions take as parameters the name of the header and the name of the parameter.

It returns '-1' if the combination header/parameter:
  - is not found (pvh_header_param_exists)
  - couldn't be removed (pvh_remove_header_param).

Examples (proxy configuration):

if (pvh_header_param_exists("Supported", "100rel"))
{
  // "100rel" is present on the "Supported" header
}

if (pvh_remove_header_param("Supported", "100rel"))
{
  // "100rel" removed from header "Supported"
}
You can view, comment on, or merge this pull request online at:

  https://github.com/kamailio/kamailio/pull/3070

-- Commit Summary --

  * pv_headers: Add support to remove a specific value from a header

-- File Changes --

    M src/modules/pv_headers/doc/functions.xml (35)
    M src/modules/pv_headers/doc/pv_headers.xml (6)
    M src/modules/pv_headers/pv_headers.c (61)
    M src/modules/pv_headers/pvh_func.c (87)
    M src/modules/pv_headers/pvh_func.h (2)

-- Patch Links --

https://github.com/kamailio/kamailio/pull/3070.patch
https://github.com/kamailio/kamailio/pull/3070.diff

-- 
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/3070
You are receiving this because you are subscribed to this thread.

Message ID: <kamailio/kamailio/pull/3070 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.kamailio.org/pipermail/sr-dev/attachments/20220331/eff6f66c/attachment-0001.htm>