Changeset 7772 for contributed_modules/modules/isymphony/functions.inc.php

Timestamp:

05/29/09 14:01:54 (3 years ago)

Author:

seanmh

Message:

1.0.0 Added backward compatibility support for 2.0 rev 1104.

Fixed bug in which a flawed context would prevent orphaned parked calls from ringing back to the parking extension if parked via the panel.
Made debug menu always visible.
Added server debug menu.
Debug logs now show on main module page.
Multiple debug options can now be set at once.
Added database column checks in installation script to handle module upgrades.
Added default FreePBX page context to configuration.
Added admin username and password fields to the main module page.
Added originate timeout field to main module page.
Added auto reload and enable page status checkboxes to main module page.
Added global Jabber connection configuration fields on main module page.
Added email and cell phone fields to extension page.
Added Jabber connection configuration override fields to extension page.
Added Jabber username and password fields to extension page.
Added auto answer checkbox to extension page.
Modified database debug tables to account for new tables and columns.

Files:

• contributed_modules/modules/isymphony/functions.inc.php (modified) (16 diffs)

contributed_modules/modules/isymphony/functions.inc.php

@@ -4 +4 @@
- *Author       : Michael Yara
- *Created      : June 27, 2008
-September 17, 2008
-0.7
+May 27, 2009
+1.1
- *Purpose      : FreePBX module that automatically updates the iSymphony configuration from the FreePBX configuration.
- *Copyright    : 2008 HEHE Enterprises, LLC
@@ -37 +37 @@
-}
-
+//Control
+class ext_isymphony_controlplayback {
+  var $fileName;
+  var $skipMinutes;
+  var $ff;
+  var $rew;
+  var $stop;
+  var $pause;
+  var $restart;
+    
+  function ext_isymphony_controlplayback($fileName, $skipMinutes, $ff, $rew, $stop, $pause, $restart) {
+    $this->fileName = $fileName;
+    $this->skipMinutes = $skipMinutes;
+    $this->ff = $ff;
+    $this->rew = $rew;
+    $this->stop = $stop;
+    $this->pause = $pause;
+    $this->restart = $restart;
+  }
+  
+  function output() {
+    return "ControlPlayback(" . $this->fileName . "," . $this->skipMinutes . "," . $this->ff . "," . $this->rew . "," . $this->stop . "," . $this->pause . "," . $this->restart . ")";
+  }
+}
+
-//If check box GUI element does not exist add it
-if(!class_exists("gui_checkbox")) {
@@ -53 +78 @@
-  }
-}
-
-
-//Main contributing module function------------------------------------------------------------------------------------------------------------------
@@ -94 +118 @@
-      }
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-      //Connect to iSymphony server to query and submit information
-      if(iSymphonyConnect()) {
-      
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            } else {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            }
-          } else {
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                  
-$object->asterisk_host = "localhost
-$object->asterisk_port = "5038
-$object->asterisk_login = "isymphony"
-$object->asterisk_password = "ismanager*con
-$object->device_user_mode = $deviceUserMode;
-
-if($object->update()) {
-isymphony_write_to_file($debugLogFile, "Updated location default\n");
-} else {
-isymphony_write_to_file($errorLogFile, "(Update location)" . $ISERROR. "\n");
+ $object->originating_context = "from-internal
+ $object->redirecting_context = "from-internal
+ $object->page_status_enabled = $maskedPagedStatusEnabledFlag
+ $object->page_context = "ext-paging
+ 
+ if($object->update()) {
+   isymphony_write_to_file($debugLogFile, "Updated tenant default\n");
+} else {
+   isymphony_write_to_file($errorLogFile, "(Update tenant)" . $ISERROR. "\n"); 
+}
-                }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-            }
-          } else {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-          }
-        } else {
-(List tenants)" . $ISERROR
+Failed to grab location information"
-        }
-  
@@ -262 +381 @@
-          //Add and update extensions
-          foreach($freePBXUsers as $freePBXUser) {
+
+            //Mask auto answer flag
+            $maskedAutoAnswerFlag = ($freePBXUser["auto_answer"] == 1) ? "true" : "false";
-            
-            //If extension does not exist add it else update it
@@ -273 +395 @@
-              $object->alt_origination_method = "";
-              $object->voice_mail = $freePBXUser["user_id"];
+              $object->cell_phone = $freePBXUser["cell_phone"];
+              $object->email = $freePBXUser["email"];
+              $object->auto_answer = $maskedAutoAnswerFlag;
-              
-              if($object->add("default","default")) {
@@ -285 +410 @@
-                          
-                //Check if update needs to occur
-($object->name != $freePBXUser["display_name"]) || ($object->voice_mail != $freePBXUser["user_id"]) || ($object->peer != $freePBXUser["peer"]
+isymphony_extension_update_check($serverRevision, $freePBXUser, $maskedAutoAnswerFlag, $object
-                      
-                  $object->name = $freePBXUser["display_name"];
-                  $object->voice_mail = $freePBXUser["user_id"];
-                  $object->peer = $freePBXUser["peer"];
+                  $object->cell_phone = $freePBXUser["cell_phone"];
+                  $object->email = $freePBXUser["email"];
+                  $object->auto_answer = $maskedAutoAnswerFlag;
-                  
-                  if($object->update()) {
@@ -322 +450 @@
-          //Add and update profiles
-          foreach($freePBXProfiles as $freePBXProfile) {
-
+     
-            //If profile does not exist add it else update it
-            if(!in_array($freePBXProfile["user_id"], $iSymphonyProfiles)) {
@@ -331 +459 @@
-              $object->password = $freePBXProfile["password"];
-              $object->can_view_everyone_directory = "true";
+              $object->jabber_host = $freePBXProfile["jabber_host"];
+              $object->jabber_domain = $freePBXProfile["jabber_domain"];     
+              $object->jabber_resource = $freePBXProfile["jabber_resource"];        
+              $object->jabber_port = $freePBXProfile["jabber_port"]; 
+              $object->jabber_user_name = $freePBXProfile["jabber_user_name"];
+              $object->jabber_password = $freePBXProfile["jabber_password"];  
-              
-              if($object->add("default","default")) {
@@ -348 +482 @@
-              //Query profile configuration and update values
-              if(($object = getISymphonyProfile("default", "default", $freePBXProfile["user_id"])) !== false) {   
-
-
-
-
+
+
+
+
+
+
+
-                  $object->password = $freePBXProfile["password"];
+                  $object->jabber_host = $freePBXProfile["jabber_host"];
+                  $object->jabber_domain = $freePBXProfile["jabber_domain"];     
+                  $object->jabber_resource = $freePBXProfile["jabber_resource"];        
+                  $object->jabber_port = $freePBXProfile["jabber_port"]; 
+                  $object->jabber_user_name = $freePBXProfile["jabber_user_name"];
+                  $object->jabber_password = $freePBXProfile["jabber_password"];  
-                  
-                  if($object->update()) {
@@ -360 +503 @@
-                  } 
-                }
+                
+                //Attempt to add relative extension to profile
+                if(addISymphonyProfileManagedExtension("default","default",$freePBXProfile["user_id"],$freePBXProfile["user_id"])) {
+                  isymphony_write_to_file($debugLogFile, "Added profile managed extension {$freePBXProfile['user_id']}\n");
+                }
+
-              } else {
-                isymphony_write_to_file($errorLogFile, "(Query profile)" . $ISERROR. "\n"); 
@@ -555 +704 @@
-}
-
+
+
+//iSymphony module API location functions------------------------------------------------------------------------------------------------------------
+function isymphony_location_update($adminUserName, $adminPassword, $originateTimeout, $autoReload, $pageStatusEnabled, $jabberHost, $jabberDomain, $jabberResource, $jabberPort) {
+  global $db; 
+  $autoReload = $autoReload ? "1" : "0";
+  $pageStatusEnabled = $pageStatusEnabled ? "1" : "0";
+  $prepStatement = $db->prepare("UPDATE isymphony_location SET admin_user_name = ?, admin_password = ?, originate_timeout = ?, auto_reload = ?, page_status_enabled = ?, jabber_host = ?, jabber_domain = ?, jabber_resource = ?, jabber_port = ?");
+  $values = array($adminUserName, $adminPassword, $originateTimeout, $autoReload, $pageStatusEnabled, $jabberHost, $jabberDomain, $jabberResource, $jabberPort);
+  $db->execute($prepStatement, $values);
+}
+
+function isymphony_location_get() {
+  global $db; 
+  $query = "SELECT * FROM isymphony_location";
+  $results = sql($query, "getRow", DB_FETCHMODE_ASSOC);
+  if((DB::IsError($results)) || (empty($results))) {
+    return null;
+  } else {
+    return $results;
+  }
+}
+
-//iSymphony module API user functions----------------------------------------------------------------------------------------------------------------
-
+, $cell_phone, $email, $autoAnswer, $jabberHost, $jabberDomain, $jabberResource, $jabberPort, $jabberUserName, $jabberPassword
-  global $db; 
-  $addProfile = $addProfile ? "1" : "0";
-  $addExtension = $addExtension ? "1" : "0";
-
-
+
+
+
-  $db->execute($prepStatement, $values);
-}
-
-
+, $cell_phone, $email, $autoAnswer, $jabberHost, $jabberDomain, $jabberResource, $jabberPort, $jabberUserName, $jabberPassword
-  global $db; 
-  $addProfile = $addProfile ? "1" : "0";
-  $addExtension = $addExtension ? "1" : "0";
-
-
+
+
+
-  $db->execute($prepStatement, $values);
-}
@@ -734 +908 @@
-    $userProfile = ($iSymphonyUser["add_profile"] == "1");
-    $password = $iSymphonyUser["password"];
+    $email  = $iSymphonyUser["email"];
+    $cell_phone = $iSymphonyUser["cell_phone"];
+    $autoAnswer = $iSymphonyUser["auto_answer"];
+    $jabberHost = $iSymphonyUser["jabber_host"];
+    $jabberDomain = $iSymphonyUser["jabber_domain"];
+    $jabberResource = $iSymphonyUser["jabber_resource"];
+    $jabberPort = $iSymphonyUser["jabber_port"];
+    $jabberUserName = $iSymphonyUser["jabber_user_name"];
+    $jabberPassword = $iSymphonyUser["jabber_password"];
-  
-  } else {
-    $added = true;
-    $userProfile = true;
-
+
+
+
+
+
+
+
+
+
+
-  }
-  
-  //Create GIU elements if not on delete page
-  if ($action != "del") {
-
-
+
-    $currentcomponent->addguielem($section, new gui_checkbox("isymphony_add_profile", $userProfile, "Create Profile", "Creates an iSymphony login profile which is associated with this extension.", "on", "", "", false));
-    $currentcomponent->addguielem($section, new gui_textbox("isymphony_profile_password", $password, "Profile Password", "Specifies the password to be used for this profile.", "", "", true, "100", false)); 
+    
+    $section = _("iSymphony Extension Settings");
+    $currentcomponent->addguielem($section, new gui_checkbox("isymphony_add_extension", $added, "Add to iSymphony", "Makes this Extension/User available in iSymphony.", "on", "", "", false));
+    $currentcomponent->addguielem($section, new gui_checkbox("isymphony_auto_answer", $autoAnswer, "Auto Answer", "Makes this extension automatically answer the initial call received from the system when performing an origination within the panel. Only works with Aastra, Grandstream, Linksys, Polycom, and Snom phones.", "on", "", "", false));
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_add_email", $email, "Email Address", "The email address entered here will be used whenever someone clicks the email icon for this extension.", "", "", true, "100"));
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_add_cell_phone", $cell_phone, "Cell Phone", "The number entered here will be used whenever someone clicks the cell phone icon for this extension.", "", "", true, "100"));
+
+    $section = _("iSymphony Jabber Settings");
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_jabber_host", $jabberHost, "Host", "Host or IP of jabber server this extension will connect to.", "", "", true, "100"));
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_jabber_domain", $jabberDomain, "Domain", "Domain this extension will connect to the jabber server with.", "", "", true, "100"));
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_jabber_resource", $jabberResource, "Resource", "Resource this extension will connect to the jabber server with.", "", "", true, "100"));
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_jabber_port", $jabberPort, "Port", "Port this extension will connect to the jabber server with.", "", "", true, "100"));
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_jabber_user_name", $jabberUserName, "UserName", "UserName this extension will connect to the jabber server with.", "", "", true, "100"));
+    $currentcomponent->addguielem($section, new gui_textbox("isymphony_jabber_password", $jabberPassword, "Password", "Password this extension will connect to the jabber server with.", "", "", true, "100"));
-  }
-}
@@ -771 +976 @@
-  $addExtension = isset($_REQUEST["isymphony_add_extension"]);
-  $addProfile = isset($_REQUEST["isymphony_add_profile"]);
+  $autoAnswer = isset($_REQUEST["isymphony_auto_answer"]);
-  $password = isset($_REQUEST["isymphony_profile_password"]) ? $_REQUEST["isymphony_profile_password"]: null;
-  $password = (($password === null) || (trim($password) == "")) ? "secret" : trim($password);
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  //Modify DB
-  if(($extension !== null) && ($extension != "") && ($action !== null)) {
@@ -782 +1002 @@
-    } else if(($action == "add") || ($action == "edit") && ($name !== null)) {
-      if(isymphony_user_get($extension) === null) {
-
+, $cell_phone, $email, $autoAnswer, $jabberHost, $jabberDomain, $jabberResource, $jabberPort, $jabberUserName, $jabberPassword
-      } else {
-
+, $cell_phone, $email, $autoAnswer, $jabberHost, $jabberDomain, $jabberResource, $jabberPort, $jabberUserName, $jabberPassword
-      }
-    }
@@ -902 +1122 @@
-}
-
+//Update checks--------------------------------------------------------------------------------------------------------------------------------------
+function isymphony_location_update_check($serverRevision, $databaseValues, $maskedAutoReloadFlag, $object) {
+  
+  //Checks for revision 1489 and up
+  if($serverRevision >= 1489) {
+    return (($object->asterisk_host != "localhost") || 
+        ($object->asterisk_port != "5038") || 
+        ($object->asterisk_login != "isymphony") || 
+        ($object->asterisk_password != "ismanager*con") || 
+        ($object->originate_timeout != $databaseValues["originate_timeout"]) ||
+        ($object->reload_on_dial_plan_reload != $maskedAutoReloadFlag) ||
+        ($object->jabber_host != $databaseValues["jabber_host"]) ||
+        ($object->jabber_domain != $databaseValues["jabber_domain"]) ||
+        ($object->jabber_resource != $databaseValues["jabber_resource"]) ||
+        ($object->jabber_port != $databaseValues["jabber_port"]) ||
+        ($object->device_user_mode != "true"));
+        
+  //Checks for 1105-1488      
+  } else if($serverRevision > 1104) {
+    return (($object->asterisk_host != "localhost") || 
+        ($object->asterisk_port != "5038") || 
+        ($object->asterisk_login != "isymphony") || 
+        ($object->asterisk_password != "ismanager*con") || 
+        ($object->originate_timeout != $databaseValues["originate_timeout"]) ||
+        ($object->jabber_host != $databaseValues["jabber_host"]) ||
+        ($object->jabber_port != $databaseValues["jabber_port"]) ||
+        ($object->device_user_mode != "true"));
+  
+  //Checks for rev 1104 and below
+  } else {
+    
+    return  (($object->asterisk_host != "localhost") || 
+        ($object->asterisk_port != "5038") || 
+        ($object->asterisk_login != "isymphony") || 
+        ($object->asterisk_password != "ismanager*con") || 
+        ($object->originate_timeout != $databaseValues["originate_timeout"]) ||
+        ($object->jabber_host != $databaseValues["jabber_host"]) ||
+        ($object->jabber_port != $databaseValues["jabber_port"]));
+  } 
+}
+
+function isymphony_tenant_update_check($serverRevision, $databaseValues, $maskedPagedStatusEnabledFlag, $object) {
+  
+  //Checks for 1105 and above
+  if($serverRevision > 1104) {
+    return (($object->originating_context != "from-internal") || 
+        ($object->redirecting_context != "from-internal") ||
+        ($object->page_status_enabled != $maskedPagedStatusEnabledFlag) ||
+        ($object->page_context != "ext-paging"));
+    
+  //Checks for 1104 and below 
+  } else {
+    return ($object->originating_context != "from-internal") || ($object->redirecting_context != "from-internal");
+  }                           
+}
+
+function isymphony_extension_update_check($serverRevision, $databaseValues, $maskedAutoAnswerFlag, $object) {
+  
+  //Checks for 1493 and above
+  if($serverRevision >= 1493) {
+    return (($object->cell_phone != $databaseValues["cell_phone"]) || 
+        ($object->email != $databaseValues["email"]) || 
+        ($object->name != $databaseValues["display_name"]) || 
+        ($object->voice_mail != $databaseValues["user_id"]) || 
+        ($object->peer != $databaseValues["peer"]) ||
+        ($object->auto_answer != $maskedAutoAnswerFlag));
+        
+  //Checks for 1492 and below 
+  } else {
+    return (($object->cell_phone != $databaseValues["cell_phone"]) || 
+        ($object->email != $databaseValues["email"]) || 
+        ($object->name != $databaseValues["display_name"]) || 
+        ($object->voice_mail != $databaseValues["user_id"]) || 
+        ($object->peer != $databaseValues["peer"]));
+  }
+}
+
+function isymphony_profile_update_check($serverRevision, $databaseValues, $maskedJabberPort, $object) {
+  
+  //Checks for revision 1489 and up
+  if($serverRevision >= 1489) {
+    return (($object->password != $databaseValues["password"]) ||         
+          ($object->jabber_host != $databaseValues["jabber_host"]) || 
+        ($object->jabber_domain != $databaseValues["jabber_domain"]) ||     
+        ($object->jabber_resource != $databaseValues["jabber_resource"]) ||  
+        ($maskedJabberPort != $databaseValues["jabber_port"]) || 
+        ($object->jabber_user_name != $databaseValues["jabber_user_name"]) || 
+        ($object->jabber_password != $databaseValues["jabber_password"]));
+        
+  //Checks for revision 1488 and below  
+  } else {
+    return (($object->password != $databaseValues["password"]) ||         
+        ($object->jabber_user_name != $databaseValues["jabber_user_name"]) || 
+        ($object->jabber_password != $databaseValues["jabber_password"]));    
+  }
+}
+
-//Helper functions-----------------------------------------------------------------------------------------------------------------------------------
-function isymphony_write_to_file($file, $content) {