Changeset 11497

Timestamp:

02/20/11 02:08:04 (2 years ago)

Author:

escape2mtns

Message:

added pulldown to select pre-configured odbc dsn's from Asterisk's res_odbc.conf, allow SmartRoutes? to be primary processor for trunk calls, allow override extension/context for destinations other than trunks, allow standard FreePBX inbound routes as a SmartRoutes? destination (with override extension), minor bug fixes

Files:

• contributed_modules/modules/smartroutes/CHANGES (added)
• contributed_modules/modules/smartroutes/functions.inc.php (modified) (19 diffs)
• contributed_modules/modules/smartroutes/install.sql (modified) (2 diffs)
• contributed_modules/modules/smartroutes/module.xml (modified) (2 diffs)
• contributed_modules/modules/smartroutes/page.smartroutes.php (modified) (8 diffs)

contributed_modules/modules/smartroutes/functions.inc.php

@@ -20 +20 @@
-include '../fax/functions.inc.php';  // so we can include the same fax hook code that the standard inbound route includes (if available)
-
-
+
-function smartroutes_list() {
-  global $db;
@@ -32 +32 @@
-
-
+// return the asterisk dialplan goto destination for a specific smartroute
-function smartroutes_getdest($id) {
-  return array('smartroute-'.$id.',s,1');
-  }
-
-
+
+
+
-function smartroutes_get_route($id) {
-  global $db;
@@ -49 +51 @@
-  }
-
+
+// return the queries for a given route 
-function smartroutes_get_queries($id) {
-  global $db;
@@ -58 +62 @@
-  }
-
+  
+// return the destinations for a given route  
-function smartroutes_get_dests($id) {
-  global $db;
@@ -68 +74 @@
-  
-  
+// return the name of the smartroute marked as trunk default  
+function smartroutes_get_trunkdefault() {
+  global $db;
+  
+  $route = $db->getRow("SELECT name FROM smartroute where trunkdefault=1");
+  
+  if(DB::IsError($route) || count($route) == 0) {
+    return null;
+    }
+    
+  if(!empty($route[0]) && !DB::IsError($route) && isset($route[0])) return $route[0];
+  
+  return null;
+  }
+
+  
+// return the dialplan destination for the smartroute marked as trunk default 
+function smartroutes_get_trunkdefault_gotoroute() {
+  global $db;
+  
+  $route = $db->getRow("SELECT id FROM smartroute where trunkdefault=1");
+  
+  if(DB::IsError($route) || count($route) == 0) {
+    return null;
+    }
+    
+  if(!empty($route[0]) && !DB::IsError($route) && isset($route[0])) return smartroutes_getdest($route[0]);
+  
+  return null;
+  }
+  
+
+// return a list of the Asterisk odbc resources defined 
+function smartroutes_get_dsns() {
+  $ret_dsns = array();
+  
+  $asterisk_dsns = smartroutes_read_config('/etc/asterisk/res_odbc.conf');  
+  if(count($asterisk_dsns)) {
+    $ret_dsns = array_keys($asterisk_dsns);
+    }
+  return $ret_dsns;
+  }
+  
+
+// add a smartroute entry 
-function smartroutes_add_route($name) {
-  global $db;
@@ -86 +137 @@
-  }
-
+  
+// delete a smartroute entry  
-function smartroutes_del($id) {
-  global $db;
@@ -96 +149 @@
-}
-
+
+// save a smartroute entry
-function smartroutes_save($id) {
-  global $db; 
@@ -113 +168 @@
-  
-  foreach ($_POST as $key => $value) {
+    if($key == 'trunkdefault' && $value == '1') {
+      // only one smartroute can be the trunk default so disable all 
+      sql("UPDATE `smartroute` SET `trunkdefault` = '0'");      
+      }
+    
-    switch ($key) {
-      case 'faxenabled':
@@ -146 +206 @@
-      case 'faxdetection':
-      case 'legacy_email':
+      case 'trunkdefault':
-      case 'faxdetectionwait':
-        $sql_value = $db->escapeSimple($value);
@@ -293 +354 @@
-
-  
+// return an array of smartroute destinations 
-function smartroutes_destinations() {
-  $destinations = array();
-  $smartroutes = smartroutes_list();
-
+  // first destination is static inbound routes
+  // 
+  // ** in case we translated a DID and want to process based on static inbound routes)
+  // ** or if a smartroute is set for default trunk call processing but we want to hand off to static inbound routes
+  $destinations[] = array('destination' => 'from-pstn,${EXTEN},1','description' => '* FreePBX Std Inbound Routes *');
+  
-  if(isset($smartroutes)) {
-    foreach($smartroutes as $route){
@@ -315 +383 @@
-}
-
+
+// write the dialplan for smartroutes
-function smartroutes_get_config($engine) {
-  global $ext;
@@ -344 +414 @@
-//  $ob_file = fopen('/tmp/smartroute.log','w');
-//  ob_start('ob_file_callback');
+
+    // do we need to configure smartroutes to handle all trunk calls (before static inbound routes)     
+    $trunk_default_gotoroute = smartroutes_get_trunkdefault_gotoroute();
+    if($trunk_default_gotoroute != null) {
+      // smartroutes are taking point on inbound trunk calls
+      // create a new from-trunk context
+      $ext->add('from-trunk', '_.', '', new ext_setvar('__FROM_DID','${EXTEN}'));
+      $ext->add('from-trunk', '_.', '', new ext_setvar('__CATCHALL_DID','${EXTEN}'));
+      $ext->add('from-trunk', '_.', '', new ext_goto($trunk_default_gotoroute[0]));   
+      $ext->add('from-trunk', 'i', '', new ext_setvar('__CATCHALL_DID','${INVALID_EXTEN}'));
+      $ext->add('from-trunk', 'i', '', new ext_goto($trunk_default_gotoroute[0]));
+
+      // to get to the original static "inbound routes" we go to "from-pstn" (which is the sole inclusion of the existing from-trunk)   
+      }   
+    
-
-  // *** FIRST FIX CATCHALL TO SET FROM_DID  (we need this when the catch-all is routed to smartroutes for processing - that way we can search on FROM_DID)
@@ -726 +811 @@
-            $macrodestination = true;
-            }
+            
+          // also exchange EXTEN for SR_OR_EXTVAR if set FOR ANY PRIMARY DESTINATION
+          // also set the actual context for any destination with an ,s, extension FOR ANY PRIMARY DESTINATION
+          $dest['extvar'] = trim($dest['extvar']);
+          if(!empty($dest['extvar'])) {
+            $dest['destination'] = str_replace('${EXTEN}',$dest['extvar'],$dest['destination']);
+            $dest_str_part_pos = strpos($dest['destination'], ',s,');
+            if(is_numeric($dest_str_part_pos) ) {
+              $dest['destination'] = $dest['extvar'].substr($dest['destination'],$dest_str_part_pos);
+              }
+            }           
-          
-          // set processing vars
@@ -739 +835 @@
-            // clear these
-            $ext->add($context, $extension, '', new ext_setvar('SR_MACRO', ""));
-
+           
-            }
-          $ext->add($context, $extension, '', new ext_goto("process_match_found"));
@@ -862 +958 @@
-//  fclose($ob_file);   
-  }
-
-
-
+
+
+// helper function for the dialplan generation code - process an individual odbc query
-function smartroutes_create_odbc_query($smartroute, $query) {
-  $odbc_query = array();
@@ -916 +1012 @@
-
-  
+// read an asterisk config file into an array 
-function smartroutes_read_config($config_file) {
-  $config = array();
@@ -968 +1065 @@
-  
-
-
+// save the Asterisk odbc queries/funcs file /etc/asterisk/func_odbc.conf 
-function smartroutes_save_odbc_funcs($odbc_queries) {
-  global $version;
@@ -1026 +1123 @@
-  
-}
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function smartroutes_fax_hook_core($viewing_itemid, $target_menuid, $smartroute){  // ejr 2-31-11 modified to pass smartroute array
-  //hmm, not sure why engine_getinfo() isnt being called here?! should probobly read: $info=engine_getinfo();
@@ -1148 +1263 @@
-
-}
-    
-  
-  
-

contributed_modules/modules/smartroutes/install.sql

@@ -13 +13 @@
-  `id` int unsigned NOT NULL PRIMARY KEY auto_increment,
-  `name` varchar(40) NOT NULL,  
-
+
+
-  `faxenabled` tinyint(1) default NULL,  
-  `faxdetection` varchar(20) default NULL,
@@ -39 +40 @@
-  `search-type` varchar(20) default 'EXACT'
-);
+
+--
+-- Upgrade existing tables with a new field for version 1.1
+--
+ALTER TABLE `smartroute` ADD `trunkdefault` TINYINT(1) default '0';
-
---

contributed_modules/modules/smartroutes/module.xml

@@ -2 +2 @@
-  <rawname>smartroutes</rawname>
-  <name>SmartRoutes</name>
-
-
+
+
+
+
-  <type>setup</type>
-  <category>Addons</category>
@@ -9 +11 @@
-    <smartroutes category="Inbound Call Control">SmartRoutes</smartroutes>
-  </menuitems>
-release/smartroutes-1.0
+contributed_modules/release/smartroutes-1.1
-  <info>http://www.qualityansweringservice.com/anatomy-oscc/freepbx/smartroutes</info>
+    <changelog>
+          *1.1* added pulldown to select pre-configured odbc dsn's from Asterisk's res_odbc.conf, allow SmartRoutes to be primary processor for trunk calls, allow override extension/context for destinations other than trunks, allow standard FreePBX inbound routes as a SmartRoutes destination (with override extension), minor bug fixes, new database field value trunkdefault in table smartroute  
+          *1.0* initial commit  
+    </changelog>
+  <depends>
+    <version>2.7.0beta1</version>
+    <phpversion>5.1.0</phpversion>
+  </depends>
-</module>

contributed_modules/modules/smartroutes/page.smartroutes.php

@@ -97 +97 @@
-    <h2><?php echo _("SmartRoutes"); ?></h2>
-    <!--  Splash Screen / Instructions here -->
-
+
+
+
+
+
+
+
+
+
+
-    <b>Notes:</b>
-    <ul>
@@ -111 +120 @@
-    <?php } ?>
-    
-e
+
-    <li>To access multiple databases, or for more advanced call routing you can have smartroutes that route to other smartroutes.  Setting the variables in the dialplan will allow database lookup values to persist from one Smartroute to the next.</li>
-    <li>This module will set the FROM_DID variable in the catch-all section for inbound routes.</li>
@@ -171 +180 @@
-        
-    echo('</table>'."\n");  
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  
-  echo('<table>'."\n");
@@ -258 +284 @@
-    
-    echo('<tr><td colspan="2"><div class="smartroutes_dest"><table>'."\n");
-Trunk Extension").'<span><br>'._("(optional) When sending to a trunk, allow specifing new destination DID value or variable.  This feature only works for the primary destination as a trunk and requires FreePBX version 2.8 or higher.  To use this capability for failover, have failover go to another smartroute where the primary destination trunk is the failover trunk with an override extension.<br><br>Note that any Asterisk vars used here need to be indicated as they are in Asterisk with '\${asteriskvar}'.").'<br></span></a></td><td><a href=# class="info">'._("Destination").'<span><br>'._("Primary destination for this route.").'<br></span></a></td><td><a href=# class="info">'._("Failover").'<span><br>'._("When primary destination is a *trunk* that is unable to connect, use this destination.
+Override Primary<br>Extension/Context").'<span><br>'._("(optional) When destination normally passes '\${EXTEN}' in the Asterisk dialplan goto call, allow specifing new destination DID value or variable.  If the destination normally passes the 's' extension then we will replace the primary context with this variable or value (the specific target of the type selected is irrelevant because we'll override it).  This feature only applies to the primary destination.  To use this capability for failover, have failover go to another smartroute where the primary destination is the failover destination with a primary override extension/context.<br><br>Note that any Asterisk vars used here need to be indicated in Asterisk value notation with '\${asteriskvar}'.<br><br>Example extension translation uses: Custom Contexts, Smartroutes, Trunks (FreePBX 2.8+), and the FreePBX Std Inbound Routes.<br><br>Example context translation uses: IVR, and Announcements.").'<br></span></a></td><td><a href=# class="info">'._("Destination").'<span><br>'._("Primary destination for this route.").'<br></span></a></td><td><a href=# class="info">'._("Failover").'<span><br>'._("When primary destination is a *trunk* that is unable to connect, use this destination.  Note: This feature requires FreePBX version 2.8 or higher. 
-  
-  // get freepbx version
@@ -344 +370 @@
-    
-    echo('<tr><td><a href="#" class="info">'._("Database Type").'<span>'._("Select the database type to use.").'</span></a>:</td>'."\n");
-
-
-
+ (Deprecated)
+
+ DEPRECATED
-  echo('<td><input type="text" name="mysql-host" value="'.$smartroute_route['mysql-host'].'" tabindex="'.$tabindex++.'"></td></tr>'."\n");
-  
@@ -360 +386 @@
-  echo('<br>'."\n");
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    
-    echo('</table>'."\n");  
@@ -649 +689 @@
-      // *** NOTE THAT WE USE THE SAME FORM FIELD LINES AS ABOVE EXCEPT THAT THE ++ IS REMOVED FROM tabindex AND WE ADJUST THE VAL BEFORE EACH LINE
-      // we also modified the $destSetNum value to support dynamic creation
+      
+      // get freepbx version
+      $installed_ver = getversion();    
-       
-      // fix for our .js here from loop above
@@ -670 +713 @@
-      $tabindex = "'+tabindex1+'";    
-      echo('<td><input type="text" class="smartroute_dest_extvar" id="smartroute_dest_extvar_'.$destRowsUsed.'" name="smartroute_dest_extvar['.$destRowsUsed.']" value="'.$dest['extvar'].'" tabindex="'.$tabindex.'" /></td>');
-
-      // get freepbx version
-      $installed_ver = getversion();
-      
-      //removed the ++ from $destSetNum and hard-coded the destSet numbers (from original code in form above)