new file mode 100644

@@ -0,0 +1,2 @@

+doc:

+	make -C ../core doc

@@ -1,6 +1,6 @@

-******************************

-* Announcement Server Module *

-******************************

+*******************************************************

+* Pre-Call announcement with B2BUA Application Module *

+*******************************************************

 Description:

 ------------

@@ -11,4 +11,6 @@ It searches for files to play following these rules:

  1) [AnnouncePath]/[Domain]/[User].wav

  2) [AnnouncePath]/[User].wav

-That's it.

+Then it connects the caller to the r_uri in Back-To-Back 

+User Agent (B2BUA) mode, thus staying in the signalling path 

+of the call.

@@ -1,8 +1,8 @@

 Announcement then call transfer 

 This application plays an announcement and then REFERs the caller

-to either the uri configured in P-Refer-To header, or if his is not

-configured, the request URI of the first INVITE.

+to either the uri configured in the Refer-To session parameter, 

+or, if his is not set, the request URI of the first INVITE.

 If refer is not accepted, succeeds, or fails, a BYE is sent.

@@ -10,7 +10,7 @@ Example ser configuration appends:

 #appends: parameter for announce_transfer

 modparam( "tm", "tw_append",

-   "announce_transfer_headers:P-Refer-To=avp[$refer_to]")

+   "announce_transfer_headers:P-Iptel-Param=avp[$refer_to]")

 # appends for REFER NOTIFYs

 modparam( "tm", "tw_append",

@@ -36,7 +36,7 @@ Example of invoking announce_transfer within route:

 	} 

 	if (method == "INVITE") {

-		avp_write("sip:callme@example.com","$refer_to");

+		avp_write("Refer-To=sip:callme@example.com","$refer_to");

 		if (!t_write_unix("/tmp/sems_sock","announce_transfer/announce_transfer_headers")){

 			log("could not contact announce_transfer\n");

 			t_reply("500","could not contact media server");	

@@ -11,9 +11,10 @@ in an early session: it replies to an invite with

 and finally replies the request with a response (by default

 404 Not found ).

-Additional Headers:

-   P-Final-Reply-Code     integer (ex. P-Final-Reply-Code:405 )

-   P-Final-Reply-Reason   string (e.g. P-Final-Reply-Reason:Prohibited)

+Session Parameters:

+   Final-Reply-Code     integer (e.g. Final-Reply-Code=405 )

+   Final-Reply-Reason   string  (e.g. Final-Reply-Reason=Prohibited)

+

 It searches for files to play following these rules:

@@ -61,10 +62,10 @@ loadmodule "modules/avpops/avpops.so"

 # add value to ;lr param to make some broken UAs happy

 modparam("rr", "enable_full_lr", 1)

-modparam( "avpops", "avp_aliases", "early_code=i:66 ; early_reason=i:67" )

+modparam( "avpops", "avp_aliases", "sess_params=i:66" )

 # this is to be appended to the invite

-modparam("tm", "tw_append","early_headers:P-Final-Reply-Code=avp[$early_code];P-Final-Reply-Reason=avp[$early_reason]")

+modparam("tm", "tw_append","early_headers:P-Iptel-Param=avp[$sess_params]")

 # -------------------------  request routing logic -------------------

 # main routing logic

@@ -112,8 +113,8 @@ route{

            	if (method == "INVITE") {

-           		avp_write("405", "$early_code");

-           		avp_write("Prohiboted", "$early_reason");

+           		avp_write("Final-Reply-Code=405;Final-Reply-Reason=Prohiboted", 

+                                  "$sess_param");

             		if(!t_write_unix("/tmp/sems_sock","early_announce/early_headers")){

                 		log("could not contact early_announce\n");

@@ -88,3 +88,99 @@ Troubleshooting:

   Look at the debug information present at start time, some libraries 

   may be missing in which case you should set the proper PYTHONPATH

   before starting SEMS.

+

+

+IVR API quickref:

+-----------------

+

+

+ globals: getHeader(String headers, String name)

+             get header with name from headers

+

+          getSessionParam(String headers, String name)

+            get session parameter with name from headers

+            (parameter from P-Iptel-Param)

+

+          log(String str)

+              log using sems' log facility

+

+          createThread(Callable thread)

+              create a thread. Only to be used on module 

+              initialization code!

+

+class IvrDialogBase:

+

+    # Event handlers

+    def onStart(self): # SIP dialog start

+        pass

+

+    def onBye(self): # SIP dialog is BYEd

+        pass

+    

+    def onSessionStart(self): # audio session start

+        pass

+

+    def onEmptyQueue(self): # audio queue is empty

+        pass

+    

+    def onDtmf(self,key,duration): # received DTMF

+        pass

+

+

+    # Session control

+    def stopSession(self): # stop everything

+        pass

+

+    def bye(self): # BYEs (or CANCELs) the SIP dialog

+        pass

+

+

+    # Media control

+    def enqueue(self,audio_play,audio_rec): # add something to the playlist

+        pass

+

+    def flush(self): # flushes playlist

+        pass

+

+    # Call datas / control

+

+    # get only property wrapping AmSipDialog AmSession::dlg.

+    # only its properties should be exposed.

+    dialog

+

+    # B2BUA

+

+    # if true, traffic will be relayed

+    # transaprently to the other side

+    # if this is 'True' at the beginning 

+    # of the session, the Caller's INVITE

+    # will be relayed to the callee, without

+    # having to use connectCallee()

+    B2BMode = False

+

+    # call given party as (new) callee

+    # if remote_party and remote_uri are empty (None),

+    # we will connect to the callee of the initial caller request

+    def connectCallee(self,remote_party,remote_uri):

+        pass

+

+    # terminate the callee's call

+    def terminateOtherLeg(self):

+        pass

+

+    # terminate our call

+    def terminateLeg(self):

+        pass

+

+    # start a new audio session with the caller

+    # sends a re-INVITE if needed.

+    def connectAudio(self):

+        pass

+

+    # end the audio session

+    # sends a re-INVITE if needed to reconnect to the current callee

+    def disconnectAudio(self):

+    	pass

+

+    # B2BUA Event handlers

+    # some other handlers...

@@ -21,16 +21,16 @@ mailbox_query.conf:

    wav_dir              -    directory which contains wav files for

                              menu

-Invocation Parameters (Headers of the INVITE)

-============================================

+Session Parameters (In P-Iptel-Param headers)

+=============================================

 mailbox:

- P-Mailbox-URL      -  IMAP URL to the mailbox

+ Mailbox-URL      -  IMAP URL to the mailbox

 mailbox_query:

- P-Mailbox-URL      -  IMAP URL to the mailbox

+ Mailbox-URL      -  IMAP URL to the mailbox

@@ -38,13 +38,13 @@ Example for ser.cfg

 ===================

 # appends for INVITE to mailbox

-modparam("tm", "tw_append", "mailbox_headers:P-Mailbox-URL=avp[$mailbox_url]")

+modparam("tm", "tw_append", "mailbox_headers:P-Iptel-Param=avp[$mailbox_url]")

 ...

         # replace this with a function that loads imap url e.g. from DB

         # into $mailbox_url AVP

-		avp_write("imap://user:password@imapserver:143/INBOX",

+		avp_write("Mailbox-URL=imap://user:password@imapserver:143/INBOX",

                       "$mailbox_url");

 		if (!t_write_unix("/tmp/sems_sock","mailbox/mailbox_headers")){

@@ -26,8 +26,8 @@ Authentication Modes:

  properly support re-Invite (updating of contact, and session, as specified 

  in RFC3261).

- The transfer request sent out has two headers, which are needed by the 

- entity taking the call: 

-  P-Transfer-RR  : route set of the call

-  P-Transfer-NH  : next hop 

+ The transfer request sent out has two session parameters (set in

+ P-Iptel-Param header), which are needed by the entity taking the call: 

+  Transfer-RR  : route set of the call

+  Transfer-NH  : next hop 

new file mode 100644

@@ -0,0 +1,26 @@

+py_sems Readme 

+

+  py_sems is aimed at integrating as much functionnalities

+  from the core as possible into python driven applications 

+  (not necessarily IVRs), in a more easy way. The classes can 

+  then just be used as in C++.

+

+  This plug-in uses the sip4 package included in debian.

+  Please refer to http://www.riverbankcomputing.co.uk/sip/

+  for more informations on the binding generator.

+  Please note that you do not need it, if you just want to compile

+  SEMS. You will need it first if you want to generate more classes.

+

+  The version included is 4.1.1. If you generate some files using

+  a new version of sip4, update or remove sip.h in the apps/py_sems/sip 

+  directory.

+

+  Example applications for py_sems can be found in 

+  apps/examples/py_sems_ex.

+

+

+  This py_sems Readme file is a stub. You can help the community by 

+  sending a patch with more information to the semsdev list

+  (semsdev@iptel.org).

+

+

@@ -1,5 +1,5 @@

 /* \file This file generates Doxygen pages from files in the /doc

- directory 

+ *  directory 

  */

 /*! \page index SEMS Documentation 

@@ -38,7 +38,7 @@

  */

 /*! \page changelog Changelog (from 0.10.0-rc1 onwards)

- * CHANGELOG for SEMS which is from 0.10.0-rc1 onwards 

+ * CHANGELOG for SEMS from 0.10.0-rc1 onwards 

  * \verbinclude CHANGELOG

  * 

  */

@@ -68,7 +68,10 @@

  */

 /*! \page sems.conf.sample SEMS core configuration parameters

- * core/sems.conf.sample

+ * <p>The sample configuration file core/sems.conf.sample 

+ * explains all core configuration parameters. </p><p>If there is no 

+ * configuration file present, 'make install' installs this file

+ * into the default location.</p>

  * 

  * \verbinclude sems.conf.sample

  * 

@@ -134,8 +137,11 @@

  * <ul><li>  \ref ModuleDoc_pin_collect </li></ul>

  *

  * 

- * \section IVR: Python Scripting application 

+ * \section Scripting SEMS with Python 

  *

+ * There are two application modules which embed a python interpreted into 

+ * SEMS: the <i>ivr</i> module and the <i>py_sems</i> module.

+ * 

  * The <i>ivr</i> module plugin embeds a python interpreter into SEMS. In it, 

  * applications written in python can be run (<i>mailbox</i>, <i>conf_auth</i>,

  * <i>pin_collect</i> for example) and new applications can be prototyped and 

@@ -143,77 +149,144 @@

  *

  * <ul><li> \ref ModuleDoc_ivr  </li></ul>

  * 

+ * The <i>ivr</i> module has a simple to use, yet limited API, which uses 

+ * hand-written wrappers for the python bindings.

+ *

+ * <i>py_sems</i> uses a binding generator to make python classes from the

+ * SEMS core C++ classes, thus exposing a lot more functionality natively 

+ * to python:

+ *

+ * <ul><li> \ref ModuleDoc_py_sems  </li></ul>

+ * 

  */

 /*! \page ModuleDoc_ann_b2b Module Documentation: ann_b2b Application 

  *  \section Readme_ann_b2b Readme file

  *  \verbinclude Readme.ann_b2b

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_announce_auth Module Documentation: announce_auth Application 

  *  \section Readme_announce_auth Readme file

  *  \verbinclude Readme.announce_auth

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_announce_transfer Module Documentation: announce_transfer Application 

  *  \section Readme_announce_transfer Readme file

  *  \verbinclude Readme.announce_transfer

- */

-/*! \page ModuleDoc_ann_b2b Module Documentation: ann_b2b Application 

- *  \section Readme_ann_b2b Readme file

- *  \verbinclude Readme.ann_b2b

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_announcement Module Documentation: announcement Application 

  *  \section Readme_announcement Readme file

  *  \verbinclude Readme.announcement

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_conference Module Documentation: conference Application 

  *  \section Readme_conference Readme file

  *  \verbinclude Readme.conference

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_early_announce Module Documentation: early_announce Application 

  *  \section Readme_early_announce Readme file

  *  \verbinclude Readme.early_announce

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_voicemail Module Documentation: voicemail Application 

  *  \section Readme_voicemail Readme file

  *  \verbinclude Readme.voicemail

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_mailbox Module Documentation: mailbox Application 

  *  \section Readme_mailbox Readme file

  *  \verbinclude Readme.mailbox

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_ivr Module Documentation: ivr Application 

  *  \section Readme_ivr Readme file

  *  \verbinclude Readme.ivr

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

+ */

+

+/*! \page ModuleDoc_py_sems Module Documentation: py_sems Application 

+ *  \section Readme_py_sems Readme file

+ *  \verbinclude Readme.py_sems

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_uac_auth Module Documentation: uac_auth component 

  *  \section Readme_uac_auth Readme file

  *  \verbinclude Readme.uac_auth

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_registrar_client Module Documentation: registrar_client component 

  *  \section Readme_registrar_client Readme file

  *  \verbinclude Readme.registrar_client

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_mp3plugin Module Documentation: mp3 file writer audio plugin

  *  \section Readme_mp3plugin Readme file

  *  \verbinclude Readme.mp3plugin

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

 /*! \page ModuleDoc_iLBC Module Documentation: iLBC codec plugin

  *  \section Readme_iLBC Readme file

  *  \verbinclude Readme.iLBC

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

  */

+/*! \page ModuleDoc_conf_auth Module Documentation: conf_auth Application

+ *  \section Readme_conf_auth Readme file

+ *  \verbinclude Readme.conf_auth

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

+ */

+

+/*! \page ModuleDoc_pin_collect Module Documentation: pin_collect Application 

+ *  \section Readme_pin_collect Readme file

+ *  \verbinclude Readme.pin_collect

+ *  

+ *  \section Links

+ *  Back to \ref AppDoc

+ */

 /*! \page ComponentDoc Component Modules Documentation