[asterisk-dev] [Code Review] 4033: manager/config: Enhancements to support templates and non-unique category names via AMI

George Joseph reviewboard at asterisk.org
Sat Oct 11 16:34:12 CDT 2014


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/4033/
-----------------------------------------------------------

(Updated Oct. 11, 2014, 3:34 p.m.)


Review request for Asterisk Developers.


Changes
-------

Fixed 2 bugs I found while working on the Testsuite test.


Repository: Asterisk


Description
-------

This patch provides the capability to manipulate templates and categories with non-unique names via AMI.

Summary of changes:

GetConfig and GetConfigJSON:
Added "Filter" parameter:  A comma separated list of name_regex=value_regex expressions which will cause only categories whose variables match all expressions to be considered.  The special variable name TEMPLATES can be used to control whether templates are included.  Passing 'include' as the value will include templates along with normal categories. Passing 'restrict' as the value will restrict the operation to ONLY templates.  Not specifying a TEMPLATES expression results in the current default behavior which is to not include templates.

Examples:
"GetConfig?Filename=pjsip.conf&Category=myitsp&Filter=type=aor" would return only 'myitsp' categories with a type of 'aor'.

"GetConfig?Filename=pjsip.conf&Category=itsp-template&Filter=TEMPLATES=restrict,type=aor" would return only 'itsp-template' categories that are actually templates with a type of 'aor'.

"GetConfig?Filename=pjsip.conf&Filter=type=registration,endpoint=myitsp" would return only registrations whose corresponding endpoint is 'myitsp'.

The output from GetConfig and GetConfigJSON also includes variables indicating if the returned category is a template and the template names a category inherits from if any.

UpdateConfig:
NewCat now includes options for allowing duplicate category names, indicating if the category should be created as a template, and specifying templates the category should inherit from.  The rest of the actions now accept a filter string as defined above.  If there are non-unique category names, you can now update specific ones based on variable values.

To facilitate the new capabilities in manager, corresponding changes had to be made to config, most notably the addition of filter criteria to many of the APIs.  In some cases it was easy to change the references to use the new prototype but others would have required touching too many files for this patch so a wrapper with the original prototype was created.  Macros couldn't be used in this case because it would break binary compatibility with modules such as res_digium_phone that are linked to real symbols.


Diffs (updated)
-----

  branches/12/tests/test_sorcery_realtime.c 425285 
  branches/12/tests/test_sorcery.c 425285 
  branches/12/tests/test_config.c 425285 
  branches/12/res/res_sorcery_realtime.c 425285 
  branches/12/res/res_sorcery_config.c 425285 
  branches/12/pbx/pbx_realtime.c 425285 
  branches/12/main/manager.c 425285 
  branches/12/main/config.c 425285 
  branches/12/include/asterisk/config.h 425285 
  branches/12/apps/app_voicemail.c 425285 
  branches/12/apps/app_directory.c 425285 

Diff: https://reviewboard.asterisk.org/r/4033/diff/


Testing
-------

Testsuite before and after runs gave the same results.
A set of unit tests for config was added to test_config.  They test basic, filtered and template operations.


Thanks,

George Joseph

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20141011/7bdc6a42/attachment.html>


More information about the asterisk-dev mailing list