"Fossies" - the Fresh Open Source Software Archive

Member "opensips-3.0.1/modules/presence_xml/README" (1 Oct 2019, 8708 Bytes) of package /linux/misc/opensips-3.0.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 3.0.0_vs_3.0.1.

    1 Presence_XML Module
    2      __________________________________________________________
    3 
    4    Table of Contents
    5 
    6    1. Admin Guide
    7 
    8         1.1. Overview
    9         1.2. Dependencies
   10 
   11               1.2.1. OpenSIPS Modules
   12               1.2.2. External Libraries or Applications
   13 
   14         1.3. Exported Parameters
   15 
   16               1.3.1. force_active (int)
   17               1.3.2. pidf_manipulation (int)
   18               1.3.3. xcap_server (str)
   19               1.3.4. pres_rules_auid (str)
   20               1.3.5. pres_rules_filename (str)
   21               1.3.6. generate_offline_body (str)
   22 
   23         1.4. Exported Functions
   24         1.5. Installation
   25 
   26    2. Developer Guide
   27    3. Contributors
   28 
   29         3.1. By Commit Statistics
   30         3.2. By Commit Activity
   31 
   32    4. Documentation
   33 
   34         4.1. Contributors
   35 
   36    List of Tables
   37 
   38    3.1. Top contributors by DevScore^(1), authored commits^(2) and
   39           lines added/removed^(3)
   40 
   41    3.2. Most recently active contributors^(1) to this module
   42 
   43    List of Examples
   44 
   45    1.1. Set force_active parameter
   46    1.2. Set pidf_manipulation parameter
   47    1.3. Set xcap_server parameter
   48    1.4. Set pres_rules_auid parameter
   49    1.5. Set pres_rules_filename parameter
   50    1.6. Set generate_offline_body parameter
   51 
   52 Chapter 1. Admin Guide
   53 
   54 1.1. Overview
   55 
   56    The module does specific handling for notify-subscribe events
   57    using xml bodies. It is used with the general event handling
   58    module, presence. It constructs and adds 3 events to it:
   59    presence, presence.winfo, dialog;sla.
   60 
   61    This module takes the xcap permission rule documents from
   62    xcap_table. The presence permission rules are interpreted
   63    according to the specifications in RFC 4745 and RFC 5025.
   64 
   65 1.2. Dependencies
   66 
   67 1.2.1. OpenSIPS Modules
   68 
   69    The following modules must be loaded before this module:
   70      * a database module.
   71      * presence.
   72      * signaling.
   73      * xcap.
   74      * xcap_client.
   75        Only compulsory if not using an integrated xcap server (if
   76        'integrated_xcap_server' parameter is not set).
   77 
   78 1.2.2. External Libraries or Applications
   79 
   80    The following libraries or applications must be installed
   81    before running OpenSIPS with this module loaded:
   82      * libxml-dev.
   83 
   84 1.3. Exported Parameters
   85 
   86 1.3.1. force_active (int)
   87 
   88    This parameter is used for permissions when handling Subscribe
   89    messages. If set to 1, subscription state is considered active
   90    and the presentity is not queried for permissions(should be set
   91    to 1 if not using an xcap server). Otherwise,the xcap server is
   92    queried and the subscription states is according to user
   93    defined permission rules. If no rules are defined for a certain
   94    watcher, the subscriptions remains in pending state and the
   95    Notify sent will have no body.
   96 
   97    Note: When switching from one value to another, the watchers
   98    table must be emptied.
   99 
  100    Default value is “0”.
  101 
  102    Example 1.1. Set force_active parameter
  103 ...
  104 modparam("presence_xml", "force_active", 1)
  105 ...
  106 
  107 1.3.2. pidf_manipulation (int)
  108 
  109    Setting this parameter to 1 enables the features described in
  110    RFC 4827. It gives the possibility to have a permanent state
  111    notified to the users even in the case in which the phone is
  112    not online. The presence document is taken from the xcap server
  113    and aggregated together with the other presence information, if
  114    any exist, for each Notify that is sent to the watchers. It is
  115    also possible to have information notified even if not issuing
  116    any Publish (useful for services such as email, SMS, MMS).
  117 
  118    Default value is “0”.
  119 
  120    Example 1.2. Set pidf_manipulation parameter
  121 ...
  122 modparam("presence_xml", "pidf_manipulation", 1)
  123 ...
  124 
  125 1.3.3. xcap_server (str)
  126 
  127    The address of the xcap servers used for storage. This
  128    parameter is compulsory if the integrated_xcap_server parameter
  129    is not set. It can be set more that once, to construct an
  130    address list of trusted XCAP servers.
  131 
  132    Example 1.3. Set xcap_server parameter
  133 ...
  134 modparam("presence_xml", "xcap_server", "xcap_server.example.org")
  135 modparam("presence_xml", "xcap_server", "xcap_server.ag.org")
  136 ...
  137 
  138 1.3.4. pres_rules_auid (str)
  139 
  140    This parameter should be configured if you are using the non
  141    integrated xcap mode and you need to use another pres-rules
  142    auid than the default 'pres-rules'.
  143 
  144    Example 1.4. Set pres_rules_auid parameter
  145 ...
  146 modparam("presence_xml", "pres_rules_auid", "org.openmobilealliance.pres
  147 -rules")
  148 ...
  149 
  150 1.3.5. pres_rules_filename (str)
  151 
  152    This parameter should be configured if you are using the non
  153    integrated xcap mode and you need to configure another filename
  154    than the default 'index'.
  155 
  156    Example 1.5. Set pres_rules_filename parameter
  157 ...
  158 modparam("presence_xml", "pres_rules_filename", "pres-rules")
  159 ...
  160 
  161 1.3.6. generate_offline_body (str)
  162 
  163    This parameter should be set to 0 if you want to prevent
  164    OpenSIPS from automatically generating a PIDF body when a
  165    publication expires or is explicitly terminated (a PUBLISH
  166    request is received with Expires: 0).
  167 
  168    Example 1.6. Set generate_offline_body parameter
  169 ...
  170 modparam("presence_xml", "generate_offline_body", 0)
  171 ...
  172 
  173 1.4. Exported Functions
  174 
  175    None to be used in configuration file.
  176 
  177 1.5. Installation
  178 
  179    The module requires 1 table in OpenSIPS database: xcap. The SQL
  180    syntax to create it can be found in presence-create.sql script
  181    in the database directories in the opensips/scripts folder. You
  182    can also find the complete database documentation on the
  183    project webpage,
  184    http://www.opensips.org/html/docs/db/db-schema-devel.html.
  185 
  186 Chapter 2. Developer Guide
  187 
  188    The module exports no function to be used in other OpenSIPS
  189    modules.
  190 
  191 Chapter 3. Contributors
  192 
  193 3.1. By Commit Statistics
  194 
  195    Table 3.1. Top contributors by DevScore^(1), authored
  196    commits^(2) and lines added/removed^(3)
  197      Name DevScore Commits Lines ++ Lines --
  198    1. Anca Vamanu 124 54 4745 1776
  199    2. Saúl Ibarra Corretgé (@saghul) 30 9 1499 471
  200    3. Bogdan-Andrei Iancu (@bogdan-iancu) 26 22 78 126
  201    4. Razvan Crainea (@razvancrainea) 14 12 34 32
  202    5. Liviu Chircu (@liviuchircu) 12 9 42 68
  203    6. Daniel-Constantin Mierla (@miconda) 8 6 15 14
  204    7. Henning Westerholt (@henningw) 6 4 45 50
  205    8. Dan Pascu (@danpascu) 4 2 3 3
  206    9. Ovidiu Sas (@ovidiusas) 3 2 6 0
  207    10. Kennard White 3 1 27 11
  208 
  209    All remaining contributors: Vlad Paiu (@vladpaiu), Walter
  210    Doekes (@wdoekes), Konstantin Bokarius, Peter Lemenkov
  211    (@lemenkov), UnixDev, Edson Gellert Schubert, Denis Bilenko,
  212    Vlad Patrascu (@rvlad-patrascu).
  213 
  214    (1) DevScore = author_commits + author_lines_added /
  215    (project_lines_added / project_commits) + author_lines_deleted
  216    / (project_lines_deleted / project_commits)
  217 
  218    (2) including any documentation-related commits, excluding
  219    merge commits. Regarding imported patches/code, we do our best
  220    to count the work on behalf of the proper owner, as per the
  221    "fix_authors" and "mod_renames" arrays in
  222    opensips/doc/build-contrib.sh. If you identify any
  223    patches/commits which do not get properly attributed to you,
  224    please submit a pull request which extends "fix_authors" and/or
  225    "mod_renames".
  226 
  227    (3) ignoring whitespace edits, renamed files and auto-generated
  228    files
  229 
  230 3.2. By Commit Activity
  231 
  232    Table 3.2. Most recently active contributors^(1) to this module
  233                       Name                   Commit Activity
  234    1.  Razvan Crainea (@razvancrainea)     Feb 2012 - Sep 2019
  235    2.  Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2007 - Apr 2019
  236    3.  Dan Pascu (@danpascu)               Oct 2007 - Nov 2018
  237    4.  Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
  238    5.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
  239    6.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - May 2017
  240    7.  Saúl Ibarra Corretgé (@saghul)      May 2012 - Mar 2013
  241    8.  Anca Vamanu                         Apr 2007 - Jun 2012
  242    9.  Vlad Paiu (@vladpaiu)               Oct 2011 - Oct 2011
  243    10. Ovidiu Sas (@ovidiusas)             Oct 2010 - Mar 2011
  244 
  245    All remaining contributors: Kennard White, Walter Doekes
  246    (@wdoekes), UnixDev, Denis Bilenko, Henning Westerholt
  247    (@henningw), Daniel-Constantin Mierla (@miconda), Konstantin
  248    Bokarius, Edson Gellert Schubert.
  249 
  250    (1) including any documentation-related commits, excluding
  251    merge commits
  252 
  253 Chapter 4. Documentation
  254 
  255 4.1. Contributors
  256 
  257    Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu
  258    (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Saúl
  259    Ibarra Corretgé (@saghul), Razvan Crainea (@razvancrainea),
  260    Anca Vamanu, Henning Westerholt (@henningw), Daniel-Constantin
  261    Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert,
  262    Dan Pascu (@danpascu).
  263 
  264    Documentation Copyrights:
  265 
  266    Copyright © 2007 Voice Sistem SRL