Ticket #3042: callme.patch

includes/callme.php

@@ +1 @@
+<?php
+
+/* 
+ * Call Me constants
+ */
+define("CALLME_SUCCESS", "The call has been answered.");
+define("CALLME_FAILURE", "The call failed.  Perhaps the line was busy.");
+define("CALLME_ERROR", "System error.");
+
+/*
+ *
+ * Include admin/functions.inc.php for our call to parse_amportal_conf()
+ * Include admin/common/php-asmanager.php to use the AGI_AsteriskManager class for accessing the AMI
+ *
+ */
+require_once('../admin/functions.inc.php');
+require_once('../admin/common/php-asmanager.php');
+
+$amp_conf   = parse_amportal_conf("/etc/amportal.conf");
+$asm    = new AGI_AsteriskManager();
+// attempt to connect to asterisk manager proxy
+if (!isset($amp_conf["ASTMANAGERPROXYPORT"]) || !$res = $asm->connect("127.0.0.1:".$amp_conf["ASTMANAGERPROXYPORT"], $amp_conf["AMPMGRUSER"] , $amp_conf["AMPMGRPASS"], 'off'))
+{
+  // attempt to connect directly to asterisk, if no proxy or if proxy failed
+  if (!$res = $asm->connect("127.0.0.1:".$amp_conf["ASTMANAGERPORT"], $amp_conf["AMPMGRUSER"] , $amp_conf["AMPMGRPASS"], 'off'))
+  {
+    // couldn't connect at all
+    unset( $asm );
+    $_SESSION['ari_error'] =
+    _("ARI does not appear to have access to the Asterisk Manager.") . " ($errno)<br>" .
+    _("Check the ARI 'main.conf.php' configuration file to set the Asterisk Manager Account.") . "<br>" .
+    _("Check /etc/asterisk/manager.conf for a proper Asterisk Manager Account") . "<br>" .
+    _("make sure [general] enabled = yes and a 'permit=' line for localhost or the webserver.");
+  }
+}
+
+function callme_close()
+{
+  global $asm;
+  if (is_object($asm))
+  {
+    $asm->logoff();
+    $asm->disconnect();
+  }
+  unset($asm);
+}
+/*
+ * Call Me functions
+ */
+ /* Return the call me number stored in the database. */
+function callme_getnum($exten)
+{
+        global $asm;
+        $cmd    = "database get AMPUSER $exten/callmenum";
+  $callme_num   = '';
+        $results  = $asm->Command($cmd);
+
+  if (is_array($results))
+  {
+    foreach ($results as $results_elem)
+    {
+      if (preg_match('/Value: [^\s]*/', $results_elem, $matches) != 0)
+      {
+        $parts = split(' ', trim($matches[0]));
+        $callme_num = $parts[1];
+      }
+
+    }
+  }
+
+        return $callme_num;
+}
+
+/* Set the call me number to a new value.  No return value. */
+function callme_setnum($exten, $callme_num)
+{
+        global $asm;
+
+        $cmd = "database put AMPUSER $exten/callmenum $callme_num";
+        $asm->Command($cmd);
+        return;
+}
+
+/* Perform the Originate action to the call me number for message playing. */
+/* Return the result of the call (success/failure/error).                  */
+function callme_startcall($to, $from, $new_path)
+{
+  global $asm;
+  $channel  = "Local/$to@from-internal/n";
+  $context  = "custom-callme";
+  $extension  = "s";
+  $priority = "1";
+  $callerid = "VMAIL/$from";
+  $variable = "MSG=$new_path|MBOX=$from";
+  /* Arguments to Originate: channel, extension, context, priority, timeout, callerid, variable, account, application, data */
+  $status = $asm->Originate($channel, $extension, $context, $priority, NULL, $callerid, $variable, NULL, NULL, NULL);
+  if (is_array($status))
+  {
+    foreach ($status as $status_elem)
+    {
+      if (preg_match('/Originate successfully queued/', $status_elem, $matches) != 0)
+      {
+        return CALLME_SUCCESS;
+      }
+    }
+  } 
+  return CALLME_FAILURE;
+}
+
+function callme_eventsoff()
+{
+  global $asm;
+  $asm->Events("off");
+  return;
+}
+
+/* Returns boolean value for a call's success status. */
+function callme_succeeded($status)
+{
+  if (strcmp($status, CALLME_SUCCESS) == 0)
+    return true;
+  else
+    return false;
+}
+
+/* Hangs up an existing channel $exten is associated with.  No return value. */
+function callme_hangup($exten)
+{
+  global $asm;
+  $cmd    = "local show channels";
+        $chan_pat   = '/[\s]*Local\/' . trim($exten) . '@from\-internal\-[a-zA-Z0-9]*,(1|2)[\s]*/';
+  $matches[0]   = "";
+  $response   = "";
+  $channel  = "";
+  $local_channels = $asm->Command($cmd);
+
+  /* Look for our local channel. */
+  if (is_array($local_channels))
+  {
+    foreach ($local_channels as $local_channels_elem)
+    {
+      preg_match($chan_pat, $local_channels_elem, $matches);
+      if ($matches[0] != "")
+      {
+        $channel = $matches[0];
+        break;
+      }
+    }
+  } else
+  {
+    $channel = "";
+  }
+
+  /* If the channel was still up, hang it up. */ 
+  if ($channel != "")
+  {
+    $asm->Hangup(trim($channel));
+  }
+  return; 
+}
+?>

includes/common.php

@@ -436 +436 @@
-include_once("./includes/database.php");
-include_once("./includes/display.php"); 
-include_once("./includes/ajax.php");
+include_once("./includes/callme.php");
-
-
-?>

misc/callme_page.php

@@ +1 @@
+<?php
+
+/**
+ * @file
+ * for making call to play message
+ */
+
+chdir("..");
+include_once("./includes/bootstrap.php");
+include_once("./includes/common.php");
+
+?>
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <TITLE>Voicemail Message Call Me Control</TITLE>
+    <link rel="stylesheet" href="../theme/main.css" type="text/css">
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  </head>
+
+<?php
+  $path       = $_SESSION['ari_user']['recfiles'][$_REQUEST['recindex']];
+  $pageaction = $_REQUEST['action'];
+  $to         = $_REQUEST['callmenum'];
+  $msgFrom    = $_REQUEST['msgFrom'];
+  $new_path   = substr($path, 0, -4);   /* Without the sound file extension. */
+  $matches[0] = ''; /* init the $matches array. */
+  /* Either start or end the call me call */
+  switch($pageaction)
+  {
+    case "c":
+      /* Call me. */
+      $call_status = callme_startcall($to, $msgFrom, $new_path);
+      echo("<table class='voicemail' style='width: 100%; height: 100%; margin: 0 0 0 0; border: 0px; padding: 0px'><tr><td valign='middle' style='border: 0px'>");
+      /* if successful, display hang-up button */
+      if (callme_succeeded($call_status))
+      {
+        echo("<a href='callme_page.php?action=h&callmenum=" . $to . "'>Click here to hang up.</a>");
+      }
+      echo("</td></tr></table>");
+      echo("<script language='javascript'>parent.document.getElementById('callme_status').innerHTML = '" . _("$call_status") . "';</script>");
+      echo("<script language='javascript'>parent.document.getElementById('pb_load_inprogress').value='false';</script>");
+                  echo("<script language='javascript'>parent.document.getElementById('callme_status').parentNode.style.backgroundColor = 'white';</script>");
+      break;
+    case "h":
+      /* Hang up. */
+      /* Find the channel and hang it up if it still exists. */
+      callme_hangup($to);
+      echo("<script language='javascript'>parent.document.getElementById('callme_status').innerHTML = '" . _("The call was terminated.") . "';</script>");
+      break;
+  }
+?>
+  </body>
+</html>
+

misc/play_page.php

@@ +1 @@
+<?php
+
+/**
+ * @file
+ * page for playing recording
+ */
+
+chdir("..");
+include_once("./includes/bootstrap.php");
+
+?>
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <TITLE>ARI</TITLE>
+    <link rel="stylesheet" href="../theme/main.css" type="text/css">
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  </head>
+  <body>
+
+<?php
+
+  $path = $_SESSION['ari_user']['recfiles'][$_REQUEST['recindex']];
+
+  if (isset($path)) {
+
+    echo("<embed width='100%' src='audio.php?recindex=" . $_REQUEST['recindex'] . "' width=300, height=25 autoplay=true loop=false></embed><br>");
+  }
+  echo("<script language='javascript'>parent.document.getElementById('pb_load_inprogress').value='false';</script>");
+?>
+
+  </body>
+</html>
+

misc/popup.css

@@ -1 @@
-/*
- * popup
- */
-
-.popup_download {
-  color: #105D90; 
-  margin: 250px; 
-  font-size: 12px; 
-  text-align: right;
-}

misc/recording_popup.php

@@ -1 @@
-<?php
-
-/**
- * @file
- * popup window for playing recording
- */
-
-chdir("..");
-include_once("./includes/bootstrap.php");
-
-?>
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <TITLE>ARI</TITLE>
-    <link rel="stylesheet" href="../theme/main.css" type="text/css">
-    <link rel="stylesheet" href="popup.css" type="text/css">
-    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  </head>
-  <body>
-
-<?php
-
-  if (isset($_GET['recindex'])) {
-    $path = $_SESSION['ari_user']['recfiles'][$_GET['recindex']];
-  }
-
-  if (isset($path)) {
-    if (isset($_GET['date'])) {
-      echo("<small>" . $_GET['date'] . "</small><br>");
-    }
-    if (isset($_GET['time'])) {
-      echo("<small>" . $_GET['time'] . "</small><br>");
-    }
-
-    echo("<br>");
-    echo("<embed src='audio.php?recindex=".$_GET['recindex'] . "' width=300, height=25 autoplay=true loop=false></embed><br>");
-    echo("<a class='popup_download' href=/recordings/misc/audio.php?recindex="  . $_GET['recindex'] . ">" . _("download") . "</a><br>");
-  }
-
-?>
-
-  </body>
-</html>
-

modules/callmonitor.module

@@ -67 +67 @@
-    if ($a=='delete') {
-      if (count($files) > 0) {
-        $this->deleteRecData($files);
-
-
+
-        $_SESSION['ari_error']
-          = _("One or more messages must be selected before clicking delete.");
-      }
@@ -214 +214 @@
-
-    // table body
-    unset($_SESSION['ari_user']['recfiles']);
+    // Index to keep track of where playback control rows should be inserted.
+    $playbackRow = 2;
-    if (is_array($data)) foreach($data as $key=>$value) {
-      $i++;
-
@@ -225 +227 @@
-      $date = $buf[0];
-      $time = $buf[1];
-
-
-      $recordingLink = '';
-
+
+
-        $_SESSION['ari_user']['recfiles'][$i] = $recording;
-opUp('misc/recording_popup.php?recindex=" . $i . "&date=" . $date . "&time=" . $time . "'); return false;\">" . _("play") . "
- // recording delete checkbox
+lay($playbackRow, 'misc/play_page.php?recindex=" . $i . "'); return false;\"><img src='theme/images/sound.png' title=" . _("Play") . "></img>
+  $downloadLink = "<a href=/recordings/misc/audio.php?recindex=" . $i . "><img src='theme/images/drive_go.png' title=" . _("Download") . "></img></a>";
-        if ($CALLMONITOR_ALLOW_DELETE) {
-          $recording_delete_checkbox = "<td class='checkbox'><input type=checkbox name='selected" . $i . "' value=" . $i . "></td>";
-        }
@@ -239 +241 @@
-          $recording_delete_checkbox = "<td class='checkbox'></td>";
-        }
-      }
-
+  $playbackRow++;
-      $recording_body .= "<tr>
-                       " . $recording_delete_checkbox . "
-                 <td width=70>" . $date . "</td>
@@ -249 +251 @@
-                 <td>" . $value[dst] . "</td>
-                 <td>" . $value[dcontext] . "</td>
-                 <td width=90>" . $value[duration] . " sec</td>
-               <td>" . $recording
+        <td>" . $recordingLink . "&nbsp;&nbsp;" . $download
-               </tr>";
-    }
-    if (!count($data)) {
@@ -284 +286 @@
-
-      $ret .= "
-        <form  name='callmonitor_form' action='" . $_SESSION['ARI_ROOT'] . "' method='GET'>
+          <input type=hidden id='pb_load_inprogress' value='false'>
-          <input type=hidden name=m value=" . $m . "> 
-          <input type=hidden name=f value=recAction>
-          <input type=hidden name=a value=''>
@@ -296 +299 @@
-
-    $ret .= $display->displayInfoBarBlock($controls,$q,$start,$span,$record_count);
-
-popup and 
+
-    $ret .= "
-      <SCRIPT LANGUAGE='JavaScript'>
-      <!-- Begin
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      }
-
-      function checkAll(form,set) {
-        var elem = 0;
-        var i = 0;
@@ -339 +358 @@
-
-    // table
-    $ret .= "
-
+id='callmonitor_table' 
-        <tr>
-          " . $recording_delete_header . "
-          " . $recording_header . "

modules/settings.module

@@ -89 +89 @@
-    $voicemail_audio_format   = getArgument($args,'voicemail_audio_format');
-    $record_in          = getArgument($args,'record_in');
-    $record_out         = getArgument($args,'record_out');
+    $callme_num     = getArgument($args,'callme_number');
-    
-    if (isset($_SESSION['ari_user']['voicemail_email'])) {
-      foreach (array_keys($_SESSION['ari_user']['voicemail_email']) as $key) {
@@ -100 +101 @@
-    if ($a=='update') {
-
-    $exten = $_SESSION['ari_user']['extension'];
+    $old_callme = callme_getnum($exten);
+    // Update the Call Me number, if necessary.
+    if (strcmp($callme_num, $old_callme) != 0) {
+      callme_setnum($exten, $callme_num);
+    }
+
-    if ($exten!=$ARI_ADMIN_USERNAME) {
-      
-      // Make sure Follow-Me setup has not been deleted for this user since the last refresh
@@ -342 +349 @@
-    // get data
-    $data = $this->getRecordSettings($_SESSION['ari_user']['extension']);
-
+    // get the Call Me number
+    $callme_num = callme_getnum($exten);
+
-    // lang setting options
-    if (extension_loaded('gettext')) { 
-      $setLangText = "<p class='lang'>" . _("Language:") . " " . $language->GetForm() . "</p>";
@@ -473 +483 @@
-      }
-    }
-    
+    $set_voicemail_callme_text = "
+      <tr>
+      <td>" . _("Call Me Number:") . "</td>
+      <td>
+      <input type='text' id='callme_number' name='callme_number'
+      value='" . $callme_num . "'>
+      </input>
+      </td>
+      </tr>";
+
-    $wav_enable = 'selected';
-    if ($_COOKIE['ari_voicemail_audio_format']=='.gsm'|| 
-    ($_COOKIE['ari_voicemail_audio_format']=='' && $ARI_VOICEMAIL_AUDIO_FORMAT_DEFAULT='.gsm')) {
@@ -498 +518 @@
-      </tr>
-      " . $set_voicemail_password_text . "
-      " . $set_voicemail_email_text . "
+      " . $set_voicemail_callme_text . "
-      " . $set_voicemail_audio_format_text . "
-      </table>";
-  }

modules/voicemail.module

@@ -9 +9 @@
-  * Class for voicemail
-  */
-class Voicemail {
+  var $callme_num = "";
-
-  /*
-   * rank (for prioritizing modules)
@@ -23 +24 @@
-   * init
-   */
-  function init() {
+    $extension = $_SESSION['ari_user']['extension'];
+    $this->callme_num = callme_getnum($extension);
+    if (empty($this->callme_num)) {
+  $this->callme_num = $extension;   // callme_num defaults to user's extension.
+  callme_setnum($extension, $extension);
+    }
-  }
-
-  /*
@@ -393 +400 @@
-
-      $i++;
-    }
-Message
+Playback
-
+    // Column to provide a download link for each message in voicemail.
+    $download_header .= "<th>" . _("Download"). "</th>";
-    // table body
-    unset($_SESSION['ari_user']['recfiles']);
-    if (isset($data)) {
+      $playbackRow = 2; // Index for where playback control rows used by javascript playback() should appear in the table.  
+      // First control row would appear below row 1 (hence $playbackRow starts at 2); control rows are inserted/deleted as needed.
-      foreach($data as $file=>$value) {
-        $i++;
-recording popup link
+Playback links
-        $voicemail_audio_format = $voicemail_audio_format=='' ? '.wav' : $voicemail_audio_format;
-        $recording = preg_replace('/.txt/', $voicemail_audio_format, $file);
-        $date = GetDateFormat($value['origtime']);
@@ -411 +422 @@
-        $duration = $value[duration];
-        if (is_file($recording)) {
-          $_SESSION['ari_user']['recfiles'][$i] = $recording;
-
-
-
+
+
+
+
+
-        } 
-        else {
-          $_SESSION['ari_error'] = _("Voicemail recording(s) was not found.") . "<br>" .
-                                   sprintf(_("On settings page, change voicemail audio format.  It is currently set to %s"),$voicemail_audio_format);
-          $recordingLink = "<a href='#' onClick=\"javascript:popUp('misc/recording_popup.php?recindex=$i&date=" . $date . "&time=" . $time . "'); return false;\">
-            " . _("play") . "
-          </a>";
-        }
-
-        $tableText .= "
@@ -432 +442 @@
-            <td>" . $value[priority] . "</td>
-            <td width=90>" . $to . "</td>
-            <td>" . $duration . " sec</td>
-
+
+
-          </tr>";
+
+  $playbackRow++;
-      }
-    } 
+
-    // options
-    $url_opts = array();
-    $url_opts['folder'] = $folder;
@@ -472 +486 @@
-    $ret .= $display->displayHeaderText(sprintf(_("Voicemail for %s (%s)"),$displayname,$extension));
-    $ret .= $display->displaySearchBlock('left',$m,$q,$url_opts,true);
-
+    // pb_load_inprogress is a hidden element that is used by the javascript playback()
+    // as a boolean to keep track of whether or not a Playback (Call Me or Computer Play) from this page is in progress ("loading").
-    // start form
-    $ret .= "
-      <form name='voicemail_form' action='" . $_SESSION['ARI_ROOT'] . "' method='GET'>
+        <input type=hidden id='pb_load_inprogress' value='false'>
-        <input type=hidden name=m value=" . $m . "> 
-        <input type=hidden name=f value=msgAction>
-        <input type=hidden name=a value=''>
@@ -487 +504 @@
-
-    $ret .= $display->displayInfoBarBlock($controls,$q,$start,$span,$record_count);
-
-
+
+
+
+
+
-    $ret .= "
-      <SCRIPT LANGUAGE='JavaScript'>
-      <!-- Begin
-      function popUp(URL) {
-        popup = window.open(URL, 'play', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=1,width=324,height=110');
-      }
-
-      function checkAll(form,set) {
-        var elem = 0;
-        var i = 0;
@@ -508 +525 @@
-        }
-        return true;
-      }
+
+      // Playback function
+      function playback(mode, row_num, link) {
+  var playbackId = \"CURRENT__MSG\";
+  var i = 0;
+  var vmTable = document.getElementById('vmail_table');
+  var inprogress = document.getElementById('pb_load_inprogress').value;
+  // Only start a Playback control if another one is NOT in progress.
+  if (inprogress == \"false\") {
+    // Only one Playback control row can be open at a time.
+    // If one is already open (e.g. a call that is now over or a message already loaded for playback), close it.
+    for (i = 0; i < vmTable.rows.length; i++) {
+      if (vmTable.rows[i].id == playbackId) {
+        // Delete the row; it's a Playback control row.
+        vmTable.deleteRow(vmTable.rows[i].rowIndex);
+      }
+    }
+    // Make our Playback row.
+    playback_src = \"<iframe width='100%' height='25px' marginheight='0' marginwidth='0' frameborder='0' scrolling='no' src=\" + link + \"></iframe>\";
+    document.getElementById('pb_load_inprogress').value = \"true\";
+    newRow = vmTable.insertRow(row_num);
+    newRow.id = playbackId;
+    cell_left = newRow.insertCell(0);
+    if (mode == 'callme') {
+      cell_left.colSpan = 4;
+      cell_left.innerHTML = \"<div id='callme_status'>" . $callme_status_msg0 . $this->callme_num . $callme_status_msg1 . "</div>\";
+      cell_right = newRow.insertCell(1);
+      cell_right.colSpan = 5;
+      cell_right.innerHTML = playback_src;
+    } else {
+      cell_left.colSpan = 9;
+      cell_left.innerHTML = playback_src;
+    }
+  } else {
+    // Change background color of status cell to alert user that the playback is still loading.
+    document.getElementById(\"callme_status\").parentNode.style.backgroundColor = 'yellow';
+  }
+      }
-      // End -->
-      </script>";
-
@@ -525 +580 @@
-
-    // table
-    $ret .= "
-
+id='vmail_table' 
-        <tr>
-           " . $recording_delete_header . "
-           " . $recording_header . "
+           " . $download_header . "
-        </tr>
-        " . $tableText . "
-      </table>";