modules/asterisk/asterisk.module

<?php
// $Id: asterisk.module,v 1.107 2008/06/02 03:01:33 thehunmonkgroup Exp $

/**
 * @file
 * Enables integratation of Drupal and asterisk
 */

define('DEBUG', FALSE);

/*
 * Core drupal hooks.
 */

/**
 * Implementation of hook_block
 */
function asterisk_block($op = 'list', $delta = 0, $edit = array()) {
  if ($op == 'list') {
    $blocks[0]['info'] = t('Displays a listing of recent audio files. Users can click to hear the file via phone');
    $blocks[0]['cache'] = BLOCK_CACHE_PER_USER;
    $blocks[1]['info'] = t('Display a simple text entry to originate calls');
    $blocks[1]['cache'] = BLOCK_CACHE_PER_USER;
    return $blocks;
  }
  else if ($op == 'configure') {
      switch ($delta) {
        case 0:
          $form['asterisk_audio_block_items'] = array('#type' => 'select',
                             '#title' => t('Number of audio files to show'),
                             '#options' => array('3', '4', '5', '6', '7', '8'),
                             '#default_value' => variable_get('asterisk_audio_block_items', 5),
                           );
          break;
        case 1:
          $form['asterisk_call_number_help'] = array('#type' => 'textarea',
                                                 '#title' => t('Call number instructions'),
                                                 '#default_value' => variable_get('asterisk_call_number_help', t('You can dial Free World Dialup numbers as fwd://')),
                                               );
          break;
      }
    return $form;
  }
  else if ($op == 'save') {
    switch($delta) {
      case 0:
        variable_set('asterisk_audio_block_items', $edit['asterisk_audio_block_items']);
        break;
      case 1:
        variable_set('asterisk_call_number_help', $edit['asterisk_call_number_help']);
        break;
    }
  }
  else if ($op == 'view') {
    switch($delta) {
      case 0:
        $block['subject'] = t('Recent audio files');
        $block['content'] = asterisk_audio_file_block();
        break;
      case 1:
        $block['subject'] = t('Make call');
        $block['content'] = drupal_get_form('asterisk_make_call_block_form');
        break;
    }
    return $block;
  }
}

/**
 * Implementation of hook_cron()
 */
function asterisk_cron() {
  // check for queued messages needs to go here.
}

function asterisk_form_alter(&$form, $form_state, $form_id) {

  switch ($form_id) {
    // node settings form
    case 'node_type_form':
      $type = $form['old_type']['#value'];
      $form['workflow']['asterisk_node'] = array(
        '#type' => 'checkbox',
        '#title' => t('Allow telephone recordings'),
        '#default_value' => variable_get('asterisk_node_'. $type, 0),
        '#description' => t('Enabling will allow users with the appropriate permissions to record attachments by telephone.'),
      );
      break;
  }
}

/**
 * Implementation of hook_help().
 */
function asterisk_help($path, $arg) {
  switch ($path) {
    case 'admin/help#asterisk':
      global $user;

      return t("<p>The Asterisk integration project seeks to add a rich telephony feature set to Drupal. This module maintains a call queue in your local drupal database.</p>

<p>In order for these calls to be actually made, you must either configure your own asterisk or use an asterisk server that has already been set up to provide drupal services. </p>

<p>You can view the !site-logs. Each user will have access to their own call logs. This is accessed by clicking the 'My calls' tab while under 'My account'. For example, here are your !user-logs</p>", array('!site-logs' => l(t('site wide call logs'), 'admin/asterisk/calls'), '!user-logs' => l(t('personal call logs'), 'user/'.$user->uid.'/calls')));
  }
}

/**
 * Implementation of hook_menu()
 */
function asterisk_menu() {

  global $user;

  $make_calls = array('make calls');
  $admin_calls = array('administer calls');
  $admin_asterisk = array('administer asterisk configuration');

  $items = array();

  $items['asterisk/callnumber'] = array(
    'title' => 'Call number',
    'page callback' => 'asterisk_page',
    'access callback' => 'user_access',
    'access arguments' => $make_calls,
    'type' => MENU_CALLBACK,
  );
  $items['asterisk/calluser'] = array(
    'title' => 'Call user',
    'page callback' => 'asterisk_page',
    'access callback' => 'asterisk_calluser_access',
    'type' => MENU_CALLBACK,
  );
  $items['asterisk/callme'] = array(
    'title' => 'Call me',
    'page callback' => 'asterisk_page',
    'access callback' => 'user_access',
    'access arguments' => $make_calls,
    'type' => MENU_CALLBACK,
  );
  $items['asterisk/play'] = array(
    'title' => 'Play me',
    'page callback' => 'asterisk_page',
    'access callback' => 'user_access',
    'access arguments' => $make_calls,
    'type' => MENU_CALLBACK,
  );
  // Admin menu items.
  $items['admin/asterisk'] = array(
    'title' => 'Asterisk integration',
    'description' => 'Manage integration with an Asterisk server.',
    'page callback' => 'system_admin_menu_block_page',
    'access callback' => 'user_access',
    'access arguments' => $admin_asterisk,
  );
  $items['admin/asterisk/settings'] = array(
    'title' => 'Settings',
    'description' => 'Set up a connection with an Asterisk server. ',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('asterisk_settings_form'),
    'access callback' => 'user_access',
    'access arguments' => $admin_asterisk,
   );
  $items['admin/asterisk/server_test'] = array(
    'title' => 'Test XML-RPC connection',
    'page callback' => 'asterisk_server_test',
    'access callback' => 'user_access',
    'access arguments' => $admin_asterisk,
    'type' => MENU_CALLBACK,
  );
  $items['admin/asterisk/calls'] = array(
    'title' => 'Call logs',
    'description' => 'View logs of all placed calls.',
    'page callback' => 'asterisk_call_log',
    'access callback' => 'user_access',
    'access arguments' => $admin_calls,
  );

  $items['user/%user/calls'] = array(
    'title' => 'My calls',
    'page callback' => 'asterisk_call_log',
    'page arguments' => array(1),
    'access callback' => 'asterisk_call_log_access',
    'access arguments' => array(1),
    'type' => MENU_LOCAL_TASK,
    'weight' => 4,
  );

  return $items;
}

/**
 * Access callback for asterisk/calluser.
 */
function asterisk_calluser_access() {
  return user_access('make calls') && user_access('access user profiles');
}

/**
 * Access callback for user/%user/calls.
 */
function asterisk_call_log_access($account) {
  global $user;
  return ($account->uid == $user->uid && user_access('make calls')) || user_access('administer calls');
}

/*
 * Implementation of hook_nodeapi
 */
function asterisk_nodeapi(&$node, $op) {
  global $user;
  switch ($op) {
    case 'view':
      if ((($node->uid == $user->uid && user_access('make calls') && user_access('upload recordings')) || user_access('administer calls')) && variable_get('asterisk_node_'. $node->type, 0)) {
        $node->content['asterisk_record_form'] = array(
          '#value' => drupal_get_form('asterisk_record_form', $node),
          '#weight' => 10,
        );
      }
      break;
  }
}

function asterisk_record_form(&$form_state, $node) {
  $form = array();
  $form['asterisk_record'] = array('#type' => 'fieldset',
                               '#title' => t('Record attachment'),
                               '#collapsible' => TRUE,
                               '#collapsed' => TRUE,
                               '#description' => t('Note: once you click \'Record file\', you will receive a call to the telephone number you have listed on your user page. Wait for the beep and record your message. Hang up when finished, and the message will be uploaded to %title shortly thereafter.', array('%title' => $node->title)),
                             );
  $form['asterisk_record']['asterisk_record_nid'] = array('#type' => 'value',
                                                      '#value' => $node->nid,
                                                    );
  $form['asterisk_record']['asterisk_record_file'] = array('#type' => 'textfield',
                                                       '#title' => t('Filename'),
                                                       '#description' => t('A name for your audio file.  Please use only letters, numbers, dashes, and underscores--no spaces, and no file extension.'),
                                                       '#required' => TRUE,
                                                     );
  $form['asterisk_record']['asterisk_record_list_file'] = array('#type' => 'checkbox',
                                                       '#title' => t('List file immediately'),
                                                       '#description' => t('If checked, the file will be listed for viewing immediately upon upload--otherwise it must specifically enabled for viewing at a later time.'),
                                                     );
/*  $form['asterisk_record']['callee_number'] = array('#type' => 'textfield',
                                                       '#title' => t('Second Party Number'),
                                                       '#description' => t('If you\'d like to connect to another party first before beginning the recording, enter the party\'s number here.  Leave blank if you just want to record yourself.  <em>Note: once you are connected to the other party, you can start and stop recording by pressing *1</em>'),
                                                     );*/
  $form['asterisk_record']['submit'] = array('#type' => 'submit',
                                         '#value' => t('Record file'),
                                       );
  return $form;
}

/**
 * Implementation of hook_perm()
 */
function asterisk_perm() {
  return array(
    'make calls',
    'upload recordings',
    'administer calls',
    'administer asterisk configuration',
  );
}

/**
 * Implementation of hook_settings()
 */
function asterisk_settings_form(&$form_state) {
  global $base_url;

  $form = array();
  $form['asterisk_phone_number_message'] = array('#type' => 'textarea',
                                             '#title' => t('Profile page text'),
                                             '#default_value' => variable_get('asterisk_phone_number_message', t('Your phone number of course. You must put your country code, eg 1 for USA. An example would be 13213210123 for a US (NANPA) number')),
                                             '#description' => t('Help text for the user profile page. You should state which types of numbers are allowed by your drupal site'),
                                             '#cols' => 50,
                                             '#rows' => 4,
                                           );

  // Asterisk XML-RPC server settings.
  $form['asterisk_instant_notification'] = array('#type' => 'fieldset',
                                             '#title' => t('Asterisk server connection parameters'),
                                             '#description' => t('<em>Warning: It is highly recommended that you connect to an Asterisk server that has set up a secure XML-RPC server via SSL, otherwise your credentials and data will be transmitted unencrypted.  If another party were to successfully intercept them, they might be able to make calls through the Asterisk server as you!</em>'),
                                           );
  $form['asterisk_instant_notification']['asterisk_server_url'] = array('#type' => 'textfield',
                                                                    '#title' => t('Asterisk XML-RPC URL'),
                                                                    '#default_value' => variable_get('asterisk_server_url', ''),
                                                                    '#maxlength' => 255,
                                                                    '#description' => t('The URL of the XML-RPC server on your Asterisk installation (ex: https://example.com/asterisk_xmlrpc.php). The client end of this module supports both http and https connections.'),
                                                                  );
  $form['asterisk_instant_notification']['asterisk_server_user'] = array(
    '#type' => 'item',
    '#title' => t('Asterisk username: %username', array('%username' => _asterisk_create_username())),
    '#description' => '<em>'. t('Set automatically by the system.') .'</em>',
  );

  $form['asterisk_instant_notification']['asterisk_server_pass'] = array('#type' => 'textfield',
                                                                     '#title' => t('Asterisk server password'),
                                                                     '#default_value' => variable_get('asterisk_server_pass', ''),
                                                                     '#size' => 30,
                                                                     '#maxlength' => 30,
                                                                     '#description' => t('The password that you have configured on the Asterisk server for this website.'),
                                                                   );
  $drupal_url = $base_url .'/xmlrpc.php';
  $form['asterisk_instant_notification']['asterisk_drupal_url'] = array('#type' => 'textfield',
                                                                    '#title' => t('Drupal XML-RPC URL'),
                                                                    '#default_value' => variable_get('asterisk_drupal_url', $drupal_url),
                                                                    '#maxlength' => 255,
                                                                    '#description' => t('The URL of the XML-RPC server on your Drupal installation. This is most probably %drupal_url', array('%drupal_url' => $drupal_url)),
                                                                  );
  $form['asterisk_instant_notification']['asterisk_drupal_server_test'] = array('#value' => '<div>'. l(t('Test connection'), 'admin/asterisk/server_test') .' -- use this only after you have saved the settings!</div>');

  return system_settings_form($form);
}

/**
 * Implementation of hook_user()
 */
function asterisk_user($op, &$edit, &$account) {

  switch($op) {
    case 'load':
      asterisk_user_load($account);
      break;
    case 'insert':
      asterisk_user_insert($edit, $account);
      break;
    case 'update':
      asterisk_user_update($edit, $account);
      break;
    case 'delete':
      asterisk_user_delete($edit, $account);
      break;
    case 'form':
      return asterisk_user_form($edit, $account);
    case 'view':

      /*
       * Adds a telephone number to the users profile.
       * Users with telephone numbers can click to call other users
       */
      if (user_access('make calls') && isset($account->number) && $account->number != '') {
        if (_asterisk_is_same_user($account)) {
          $output = l(t('Call me'), 'asterisk/callme', array('query' => drupal_get_destination()));
        }
        else {
          $output = l(t('Call user'), "asterisk/calluser/$account->uid", array('query' => drupal_get_destination()));
        }

        if (!isset($account->content['telephone'])) {
          $account->content['telephone'] = array();
        }
        $account->content['telephone'] += array(
          '#type' => 'user_profile_category',
          '#attributes' => array('class' => 'user-member'),
          '#weight' => 10,
          '#title' => t('Telephone'),
        );
        $account->content['telephone']['call_link'] =  array(
          '#type' => 'user_profile_item',
          '#title' => t('Place calls'),
          '#value' => $output,
        );
      }
      break;
  }
}

/**
 * Implementation of hook_xmlrpc()
 */
function asterisk_xmlrpc() {
  return array(
    array(
      'asterisk.notify.NewMessages',
      'asterisk_check_messages',
      array('boolean', 'array'),
      t('receives a list of new messages from the Asterisk server')
    ),
  );
}

/**
 * @defgroup Asterisk call API
 * @{
 * Functions to make calls using Asterisk.
 *
 * These functions can connect two users, playback a message to a single user
 * and record a message over the phone.
 */

/**
 * Builds a call array, adding defaults if necessary
 *
 * @param $call
 * An associative array of call parameters, key = parameter name, value = value.
 * The following parameters are valid:
 *
 *    'caller_number' => Phone number to call first. When answered the caller will
 *      hear ringing until the 'callee' answers. The phone number types supported depend
 *      on the configuration of the Asterisk server. The default configuration
 *      allows calls to SIP, IAX(2), and FWD (http://fwdnet.net) numbers. PSTN
 *      calling can be enabled by configuring a VoIP provider or PSTN connection
 *      with Asterisk.
 *
 *      Number formats are as follows:
 *        IAX: iax://username          user is registered to your asterisk server
 *        SIP: sip://username
 *        FWD: fwd://fwd_number
 *
 *      Numbers can also be regular Asterisk extensions. These extensions must be
 *      in the context that the call goes to. The default context is drupal. Extensions
 *      are more useful when used as 'callee' numbers.
 *
 *    'callee_number' => Phone number to connect the first number to. This is usually an Asterisk
 *      extension. This parameter follows the same rules as 'caller_number'.
 *
 *    'module' => The module that originated the call. This is also useful for tracking
 *      purposes.
 *
 *    'uid' => The user ID to log as the originator of the call. Useful for tracking. Default is 0.
 *
 *    'dispatch_time' => Earliest time that the call should be made (and hopefully not too long
 *      after!). This should be a Unix timestamp. Drupal won't deliver the call
 *      to Asterisk until this time. The time the call will actually be made will
 *      depend on:
 *        1. How frequently the Drupal site checks for queued calls to send
 *        2. How long the Asterisk server takes to make the call. This is usually
 *           a fraction of a second, depending on load.
 *      Default is immediately.
 *
 *    'caller_id' => Caller ID to set for the call. Not all providers allow setting the caller
 *      ID. Generally VoIP providers will allow this for most calls, digital TDM
 *      (T1, E1, etc.) allows this if you have the feature from your provider,
 *      analog lines do not support this (regular phone lines). Default is no caller ID
 *
 *      Note:  Most providers require this to be a numeric string! VoIP endpoints
 *      SIP, IAX, FWD(uses SIP), etc. will accept strings as well.
 *
 *    'vars' => An array of variables to pass to Asterisk. These variables can then be
 *      used in your dialplan or AGI script.
 *
 *    'max_retries' => Number of retries before failing (not including the initial attempt, e.g.
 *      0 = total of 1 attempt to make the call).  Default is 2.
 *
 *    'retry_time' => Seconds between retries, don't hammer an unavailable phone. Default is 60 seconds
 *
 *    'wait_time' => Seconds to wait for an answer. Default is 30 seconds.
 *
 *    'context' => Context that the callee call will be made in. Default is 'drupal'.
 *
 *    'priority' => The priority of the extension for the call part of the call. Default is 1.
 *
 *    'call_status' => Whether the call has been sent to the Asterisk server. This is set to 'dipatched'
 *      by default. If you're not dispatching a call immediately, set to 'uncalled', and set the
 *      'dispatch_time' parameter appropriately.
 *
 *    'drupal_filename' => Name of a file to be recorded. This is only valid if a recording call
 *      is being passed.
 *
 * @return
 *   Returns the full calll array with defaults added if necessary.
 */
function asterisk_call($call) {

  // Set defaults if necessary.
  $call['module'] = isset($call['module']) ? $call['module'] : '';
  $call['uid'] = isset($call['uid']) ? $call['uid'] : 0;
  $call['dispatch_time'] = isset($call['dispatch_time']) ? $call['dispatch_time'] : time();
  $call['vars'] = isset($call['vars']) ? $call['vars'] : array();
  $call['caller_id'] = isset($call['caller_id']) ? $call['caller_id'] : '';
  $call['max_retries'] = isset($call['max_retries']) ? $call['max_retries'] : 2;
  $call['retry_time'] = isset($call['retry_time']) ? $call['retry_time'] : 60;
  $call['wait_time'] = isset($call['wait_time']) ? $call['wait_time'] : 30;
  $call['context'] = isset($call['context']) ? $call['context'] : 'drupal';
  $call['priority'] = isset($call['priority']) ? $call['priority'] : 1;
  $call['call_status'] = isset($call['call_status']) ? $call['call_status']: 'dispatched';

  return $call;
}

/**
 * Sends calls to the Asterisk server.
 *
 * @param $calls An array of calls, each elment of which is an associative array
 * describing a call, based on the parameters listed in function asterisk_call.
 */
function asterisk_send_calls($calls) {

  // Get server data.
  $server = _asterisk_instant_notification();

  // Since we want playback files to be processed before callfiles, we set the
  // order here.
  $outgoing = array();
  $outgoing['playback_file'] = array();
  $outgoing['callfile'] = array();

  foreach ($calls as $key => $call) {

    // Only allow calls that have both a caller and callee number.
    if ($call['caller_number'] && $call['callee_number']) {
      // Prepare the arguments for later insertion into the database.
      $arguments[$key] = array($call['caller_number'],
                           $call['callee_number'],
                           $call['module'],
                           $call['uid'],
                           $call['dispatch_time'],
                           serialize($call['vars']),
                           $call['caller_id'],
                           $call['max_retries'],
                           $call['retry_time'],
                           $call['wait_time'],
                           $call['context'],
                           $call['priority'],
                           $call['call_status'],
                           time()
                         );

      // calls marked dispatched are sent to the Asterisk server immediately, and only entered in the database
      // if the XML-RPC call is successful.
      if ($call['call_status'] == 'dispatched') {
          $outgoing['callfile'][$key] = asterisk_create_call_file($call);
          // The call has an uncached playback file associated with it--load it to the call array.
          if (isset($call['playback_file'])) {
            $outgoing['playback_file'][$key] = $call['playback_file'];
          }
      }
      // While calls marked uncalled are entered into the db immediately.
      else {
        asterisk_add_call_to_db($arguments[$key]);
        unset($arguments[$key]);
        unset($calls[$key]);
      }
    }
  }

  // Send the dispatched calls to the Asterisk server, and get back an array of completed call information.
  // NOTE: A successfully completed call only means that the call was successfully queued to Asterisk's
  // outgoing call spool.
  $completed_calls = xmlrpc($server['url'], 'asterisk.send.NewCalls', $server['user'], $server['pass'], $outgoing);

  foreach ($calls as $key => $call) {
    $message_args = array('%caller_number' => $call['caller_number'], '%callee_number' => $call['callee_number']);
    // Check for server errors.
    if (!isset($completed_calls['callfile'][$key]['error']) && !isset($completed_calls['playback_file'][$key]['error'])) {
      // Mark the call as completed successfully if it was returned in the completed calls array, with an
      // additional check for a successfully processed playback messagee if one was sent.
      if (isset($completed_calls['callfile'][$key]) && (!isset($outgoing['playback_file'][$key]) || $completed_calls['playback_file'][$key])) {
        asterisk_add_call_to_db($arguments[$key]);
        watchdog('asterisk', 'Queued call to %callee_number, from %caller_number', $message_args, WATCHDOG_NOTICE);
        drupal_set_message(t('Placed call to %callee_number, from %caller_number', $message_args));
      }
      // Call did not complete successfully.
      else {
        watchdog('asterisk', 'Call to %callee_number, from %caller_number failed', $message_args, WATCHDOG_ERROR);
        drupal_set_message(t('Call to %callee_number, from %caller_number failed', $message_args), 'error');
      }
    }
    else {
      $type = isset($call['playback_file']) ? 'playback_file' : 'callfile';
      watchdog('asterisk', 'Call to %callee_number, from %caller_number failed: '. $completed_calls[$type][$key]['error'], $message_args, WATCHDOG_ERROR);
      drupal_set_message(t('Call to %callee_number, from %caller_number failed: '. $completed_calls[$type][$key]['error'], $message_args), 'error');
    }
    unset($arguments[$key]);
    unset($calls[$key]);
  }
}

/**
 * Call a number and play a message. The file to be played must be in the
 * {files} table, and the file must be either in wav or mp3 format.
 * When the call is dispatched this file is converted to an Asterisk compatible wav file.
 * (8kHz mono PCM). Files are cached on the Asterisk server, matched by file ID, node ID,
 * and filename.
 * @param $fid
 *   The fid identifier for the file to be played back to the callee.
 * @param $callee_number
 *   The number of the user being called (see asterisk_call()).
 * @param $module
 *   Module making the call (see asterisk_call()).
 * @param $uid
 *   uid of user making the call (see asterisk_call()).
 * @param $dispatch_time
 *   Time that call should occur (see asterisk_call()).
 * @param $playback_file
 *   A playback file to upload--necessary if the file is not already cached on the
 *   Asterisk server.
 */
function asterisk_playback_message($fid, $callee_number, $module = '', $uid = 0, $dispatch_time = NULL, $playback_file = NULL) {
  $call = array();
  $call['caller_number'] = $callee_number;
  $call['callee_number'] = 'playback';
  $call['module'] = $module;
  $call['uid'] = $uid;
  $call['dispatch_time'] = $dispatch_time;
  $call['vars'] = array('drupal_fid' => $fid);
  if (isset($playback_file)) {
    $call['playback_file'] = $playback_file;
  }
  $calls[1] = asterisk_call($call);
  asterisk_send_calls($calls);
}

/**
 *  Call a number and record a message.
 * @param $filename
 *   The desired filename of the future recording.
 * @param $callee_number
 *   The number of the user being called (see asterisk_call()).
 * @param $nid
 *   Identifier of the node to which the recorded message should be attached.
 * @param $module
 *   Module making the call (see asterisk_call()).
 * @param $uid
 *   uid of user making the call (see asterisk_call()).
 * @param dispatch_time
 *   Time that call should occur (see asterisk_call()).
 * @param $list
 *   Boolean which determines if the file will be listed in the node as soon as it's created.  Default is FALSE.
 */
function asterisk_record_message($filename, $callee_number, $nid = 0, $module = '', $uid = 0, $dispatch_time = NULL, $list = 0) {

  // Get a file ID.
  $fid = asterisk_get_file_id($uid);

  $call = array();
  $calls = array();
  $call['caller_number'] = $callee_number;
  $call['callee_number'] = 'record';
  $call['module'] = $module;
  $call['uid'] = $uid;
  $call['dispatch_time'] = $dispatch_time;
  $call['vars'] = array('drupal_fid' => $fid, 'drupal_nid' => $nid, 'drupal_filename' => $filename, 'drupal_list_file' => $list);

  $calls[1] = asterisk_call($call);
  asterisk_send_calls($calls);

  $node = node_load($nid);
  drupal_set_message(t('Your message will be uploaded to %title shortly after you hang up.', array('%title' => $node->title)));
}

/**
 * Gets a file ID for a file recording.
 *
 * @param $uid
 *   The user submitting the record request.
 * @return
 *   The file ID.
 */
function asterisk_get_file_id($uid) {
  // Enter a temporary file into the files table -- placeholder.
  $query = "INSERT INTO {files}
              (uid, filename, filepath, filemime, filesize, status, timestamp)
            VALUES
              (%d, '%s', '%s', '%s', %d, %d, %d)";

  $args = array(
    $uid,
    '',
    '',
    '',
    0,
    FILE_STATUS_TEMPORARY,
    time(),
  );

  db_query($query, $args);
  $fid = db_last_insert_id('files', 'fid');

  return $fid;
}

/**
 * Use the generic call function to call given a user (the callee). The caller is made
 * the callee so that the user can hear anything that the IVR might play
 * @param $callee
 *   User object of the user to be called.
 * @param $number
 *   Number that the callee user will be connected to.
 * @param $module
 *   Module making the call (see asterisk_call()).
 * @param $uid
 *   uid of user making the call (see asterisk_call()).
 * @param dispatch_time
 *   Time that call should occur (see asterisk_call()).
 */
function asterisk_call_number($callee, $number, $module ='', $uid = 0, $dispatch_time = NULL, $call = array()) {
  $calls = array();
  $call['caller_number'] = $callee->number;
  $call['callee_number'] = $number;
  $call['module'] = $module;
  $call['uid'] = $uid;
  $call['dispatch_time'] = $dispatch_time;
  $calls[1] = asterisk_call($call);
  asterisk_send_calls($calls);
}

/**
 * @} End of "defgroup Asterisk call API".
 */

/**
 * Adds a successful call or a successfully queued call to the call queue database table.
 *
 * @param $args An array of call data to enter into the database.
 */
function asterisk_add_call_to_db($args) {
  $query = "INSERT INTO {asterisk_call_queue}
              (caller_number, callee_number, module, uid, dispatch_time, vars, caller_id, max_retries, retry_time, wait_time, context, priority, call_status, queuetime)
            VALUES
              ('%s', '%s', '%s', %d, %d, '%s', '%s', %d, %d, %d, '%s', %d, '%s', %d)
           ";
  db_query($query, $args);
}

/**
 * Checks files for existence on the Asterisk server.
 *
 * @param $fids An array of file ID's to check (fid in the files table).
 *
 * @return An array of all file ID's that exist on the Asterisk server.
 */
function asterisk_validate_playback_files($fids) {

  $files_array = array();
  $return = array();
  $server = _asterisk_instant_notification();

  // Prepare each file for checking on the server--we need to get the file name as it
  // appears on the server to do that.
  foreach ($fids as $key => $fid) {
    $file = asterisk_get_file_info($fid);
  	$files_array['playback_file'][$key] = $file['server_file_name'];
  }

  // Get the results from the server.
  $result = xmlrpc($server['url'], 'asterisk.check.Files', $server['user'], $server['pass'], $files_array);

  // Build the array of found files.
  foreach ($result['playback_file'] as $key => $value) {
    $return[] = $fids[$key];
  }

  return $return;
}

/**
 * Validates the call for recording.
 */
function asterisk_record_form_validate($form, &$form_state) {

    // Check to make sure the current user has a valid callback number.
    asterisk_user_has_number();

    // Replace all characters that aren't numbers, letters, dashes, or underscores with underscores
    $filename = preg_replace('/[^\d\w\-]/', '_', $form_state['values']['asterisk_record_file']);
    form_set_value($form['asterisk_record']['asterisk_record_file'], $filename, $form_state);
}

/**
 * Submits the call for recording.
 */
function asterisk_record_form_submit($form, &$form_state) {
  global $user;

  // This call is a bridged call with optional recording
  if ($callee_number = format_number($form_state['values']['callee_number'])) {
    // Get a file ID.
    $fid = asterisk_get_file_id($uid);
    $call['vars'] = array(
      'drupal_fid' => $fid,
      'drupal_nid' => $form_state['values']['asterisk_record_nid'],
      'drupal_filename' => $form_state['values']['asterisk_record_file'],
      'drupal_list_file' => $form_state['values']['asterisk_record_list_file'],
      'drupal_callee_number' => $callee_number,
    );
    asterisk_call_number($user, 'bridge', 'asterisk', $user->uid, NULL, $call);
  }
  // This is a call just to the user.
  else {
    asterisk_record_message($form_state['values']['asterisk_record_file'], $user->number, $form_state['values']['asterisk_record_nid'], 'asterisk', $user->uid, NULL, $form_state['values']['asterisk_record_list_file']);
  }
}

function asterisk_check_messages($messages) {

  if (!($server = _asterisk_instant_notification())) {
    return FALSE;
  }
  foreach ($messages as $message_key) {
  	$message = xmlrpc($server['url'], 'asterisk.get.Message', $server['user'], $server['pass'], $message_key);
  	asterisk_process_new_message($message);
  }

  return TRUE;
}

function asterisk_process_new_message($message) {

  switch ($message['type']) {
    case 'recording':
      _asterisk_save_file($message);
      break;
  }
}

/**
 * Saves an uploaded file to the files directory, and records it properly
 * in the files tables.
 */
function _asterisk_save_file($file) {

  $node = node_load($file['nid']);
  $file['vid'] = $node->vid ? $node->vid : 0;
  $data = $file['bits'];

  $name = $file['filename'] ? $file['filename'] : t('unknown');

  $t_args = array('%file' => $name, '%title' => $node->title);


  if(!$data) {
    watchdog('asterisk', 'File upload failed. No file sent for %file.', $t_args, WATCHDOG_ERROR);
    return;
  }
  if (!$filepath = file_save_data($data, $name)) {
    watchdog('asterisk', 'File upload failed. Error storing %file.', $t_args, WATCHDOG_ERROR);
    return;
  }

  $query = "UPDATE {files} SET filename = '%s', filepath = '%s', filemime = '%s', filesize = %d, status = %d, timestamp = %d WHERE fid = %d";

  $args = array(
    $name,
    $filepath,
    $file['filemime'],
    $file['filesize'],
    FILE_STATUS_PERMANENT,
    time(),
    $file['fid'],
  );

  db_query($query, $args);

  $query = "INSERT INTO {upload}
              (fid, nid, vid, description, list)
            VALUES
              (%d, %d, %d, '%s', %d)";

  $args = array($file['fid'],
                $file['nid'],
                $file['vid'],
                $name,
                (integer) $file['list']
               );

  db_query($query, $args);
  watchdog('asterisk', '%file uploaded successfully to %title.', $t_args);
}

/**
 * Generates file information about a file to be passed to the Asterisk server.
 *
 * @param $fid The file ID.
 * @return An associative array of information about the file.
 */
function asterisk_get_file_info($fid) {
  global $base_url;

  $nid = db_result(db_query('SELECT n.nid FROM {upload} u INNER JOIN {node} n ON n.nid = u.nid WHERE n.status = 1 AND n.vid = u.vid AND fid = %d', $fid));
  $node = node_load($nid);

  // Make sure the file is still active on the node.
  if ($node) {
    $file = (array) $node->files[$fid];

    // more unique name for the file on the asterisk server
    $file['server_file_name'] = $file['fid'] .'_'. $file['nid'] .'_'. $file['filename'];

    if (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC) == FILE_DOWNLOADS_PUBLIC) {
      $file['is_public'] = TRUE;
    }

    // get rid of this variable--replaced with the channel variable below
    unset($file['filename']);

    // We use the FILENAME variable in our dialplan.  strip the file extension--Asterisk doesn't need it.
    $filename_stripped_ext = substr($file['server_file_name'], 0, strrpos($file['server_file_name'], '.'));
    $file['FILENAME'] = $filename_stripped_ext;

    return $file;
  }
  else {
    return FALSE;
  }
}

/**
 * Load the user's information
 */
function asterisk_user_load(&$user) {
  $query = "SELECT * FROM {asterisk_users} WHERE uid = %d";
  if ($additions = db_fetch_object(db_query($query, $user->uid))) {
    foreach ($additions as $key => $value) {
      $user->$key = $value;
    }
  }
}

/**
 * Inserts the user's information
 */
function asterisk_user_insert(&$edit, &$user) {
  // save the main details to the database
  $query = "INSERT INTO {asterisk_users} (pin, number, uid) VALUES ('%s', '%s', %d)";
  db_query($query, $edit['asterisk_pin'], $edit['asterisk_number'], $user->uid);


/* Disabled for now...

  // create the user on the asterisk server
  $vars = array('op' => 'create-user', 'user' => $user);
  asterisk_call('system', 'system', 'asterisk', $user->uid, FALSE, $vars);

*/

  $edit['asterisk_number'] = NULL;
  $edit['asterisk_pin'] = NULL;

}

/**
 * Updates the user's information
 */
function asterisk_user_update(&$edit, &$user) {

  // update the PIN and telephone number information
  $query = "UPDATE {asterisk_users} SET pin = '%s', number = '%s' WHERE uid = %d";
  db_query($query, $edit['asterisk_pin'], $edit['asterisk_number'], $user->uid);
  if (db_affected_rows() == 0) {
    $query = "INSERT INTO {asterisk_users} (pin, number, uid) VALUES ('%s', '%s', %d)";
    db_query($query, $edit['asterisk_pin'], $edit['asterisk_number'], $user->uid);
  }

/* Disabled for now...
  // update the user information on the asterisk server
  $vars = array('op' => 'update-user', 'user' => $user);
  asterisk_call('system', 'system', 'asterisk', $user->uid, FALSE, $vars);
  $edit['direct_leap_account_number'] = NULL;
*/

  $edit['asterisk_number'] = NULL;
  $edit['asterisk_pin'] = NULL;
}

/**
 * Deletes the user's information
 */
function asterisk_user_delete(&$edit, &$user) {

  // delete the user's info from our database
  db_query("DELETE FROM {asterisk_users} WHERE uid = %d", $user->uid);

/* Disabled for now...
  // remove the user from our asterisk server as well
  $vars = array('op' => 'delete-user', 'user' => $user);
  asterisk_call('system', 'system', 'asterisk', $user->uid, FALSE, $vars);
*/
}

/**
 * Generates additions for the user edit form
 */
function asterisk_user_form($edit, $user) {

  $form = array();

  // User asterisk account info
  $form['asterisk_telephone_information'] = array(
    '#type' => 'fieldset',
    '#title' => t('Telephone information'),
    '#collapsible' => TRUE,
    '#weight' => 1,
  );
  $form['asterisk_telephone_information']['asterisk_number'] = array(
    '#type' => 'textfield',
    '#title' => t('Phone number'),
    '#default_value' => isset($user->number) ?$user->number : '',
    '#maxlength' => 255,
    '#description' => variable_get('asterisk_phone_number_message', t('Your phone number of course. You must put your country code, eg 1 for USA. An example would be 13213210123 for a US (NANPA) number')),
    );
  $form['asterisk_telephone_information']['asterisk_pin'] = array(
    '#type' => 'textfield',
    '#title' => t('Telephone PIN'),
    '#default_value' => isset($user->pin) ? $user->pin : '',
    '#size' => 30,
    '#maxlength' => 30,
    '#description' => t('This is your password for telephony features. It should consist of just digits (eg 1542). If you are going to connect your softphone or hardphone to our asterisk servers, this will be the password. Additionally, this PIN will be used to access your voicemail.'),
    );

  return $form;
}

/**
 * Helper function that checks if a user object is the same as that of the user
 * currently viewing the page.
 */
function _asterisk_is_same_user($callee) {
  global $user;
  if ($callee->uid == $user->uid) {
    return TRUE;
  }
  else {
    return FALSE;
  }
}

function asterisk_audio_file_block() {
  $query = "SELECT DISTINCT f.fid, f.filename FROM {files} f INNER JOIN {upload} u ON f.fid = u.fid INNER JOIN {node} n ON n.nid = u.nid WHERE n.status = 1 AND n.vid = u.vid AND (f.filemime LIKE '%audio%wav%' OR f.filemime LIKE '%audio%mpeg%') AND u.list = 1 ORDER BY f.fid DESC";
  $result = db_query_range($query, 0, variable_get('asterisk_audio_block_items', 5));

  $links = array();
  while ($file = db_fetch_object($result)) {
    $links[] = l($file->filename, 'asterisk/play/'. $file->fid,
                 array('title' => t('listen to this file by phone'), 'query' => drupal_get_destination()));
  }

  $output = '';
  if (!empty($links)) {
    $output .= '<strong>'. t('Click to listen by phone:') .'</strong>';
    $output .= theme('item_list', $links);
  }

  return $output;
}

function asterisk_make_call_block_form(&$form_state) {
  $form = array();
  $form['asterisk_number'] = array('#type' => 'textfield',
                               '#title' => t('Number'),
                               '#size' => 15,
                               '#maxlength' => 64,
                               '#description' => variable_get('asterisk_call_number_help', 'You can call Free World Dialup numbers as fwd://username'),
                             );
  $form['submit'] = array('#type' => 'submit',
                           '#value' => t('Call now'),
                         );
  return $form;
}

/**
 * Page callback
 */
function asterisk_page() {
  global $user;

  // Check to make sure the current user has a valid callback number.
  asterisk_user_has_number();

  $op = arg(1);
  switch ($op) {
    case 'calluser':
      asterisk_call_user_page($user);
      break;
    case 'callme':
      asterisk_call_number($user, 'demo', 'asterisk', $user->uid);
      break;
    case 'play':
      $fid = explode('?', arg(2));
      $fid = $fid[0];
      // Validate that the user can listen to this file.
      $nid = db_result(db_query('SELECT nid FROM {upload} WHERE fid = %d', $fid));
      if (!node_access('view', node_load($nid))) {
        return drupal_access_denied();;
      }
      // Check for existence of file on Asterisk server.
      $file_on_server = asterisk_validate_playback_files(array($fid));
      // File is not on server, so generate a playback_file element.
      if (!in_array($fid, $file_on_server)) {
        $file = asterisk_get_file_info($fid);
        $playback_file = asterisk_generate_playback_file($file);
      }
      $uids = array($user->uid);
      foreach ($uids as $uid) {
        $u = user_load(array('uid' => $uid));
        if ($u->number) {
          // Only send the playfile with the first call--saves bandwidth.
          if (isset($playback_file)) {
            asterisk_playback_message($fid, $u->number, 'asterisk', $user->uid, NULL, $playback_file);
            unset($playback_file);
          }
          else {
            asterisk_playback_message($fid, $u->number, 'asterisk', $user->uid);
          }
        }
      }
      break;
  }

  drupal_goto();
}

/**
 * Validates that the current user has a callback number, and displays a warning message
 * with an edit link if not.
 */
function asterisk_user_has_number() {
  global $user;

  asterisk_user_load($user);

  // We don't have a phone number for this user--send them an appropriate message.
  if ($user->number == '') {
    drupal_set_message(t('You need to configure your phone number in the \'Telephone information\' section below so that we can connect the call to you'), 'error');
    drupal_goto('user/'. $user->uid .'/edit');
  }
}

function asterisk_generate_playback_file($file) {

  $return = NULL;

  if (file_exists($file['filepath'])) {
    if ($fh = fopen($file['filepath'], 'r')) {
      $playback_file['bits'] = '';
      while (!feof($fh)) {
        $playback_file['bits'] .= fread($fh, 8192);
      }
      fclose($fh);

      $return['bits'] = xmlrpc_base64($playback_file['bits']);
      $return['filemime'] = $file['filemime'];
      $return['server_file_name'] = $file['server_file_name'];
    }
  }

  return $return;
}

/**
 * Validates the number in the submitted call block.
 */
function asterisk_make_call_block_form_validate($form, &$form_state) {

  // Check that user has correct permissions
  if (!user_access('make calls')) {
    form_set_error('asterisk_number', t('You do not have the required permissions to make a call.'));
  }
  else {
    // Check to make sure the current user has a valid callback number.
    asterisk_user_has_number();

    // Check to make sure the user entered a number in the call block.
    if ($form_state['values']['asterisk_number'] == '') {
      form_set_error('asterisk_number', t('You need to supply a valid number'));
    }
  }
}

/**
 * Calls the number in the submitted call block.
 *
 * @param $form_id The form ID.
 * @param $form_values An array of submitted form values.
 */
function asterisk_make_call_block_form_submit($form, &$form_state) {
  global $user;

  $call['vars'] = array('drupal_callee_number' => $form_state['values']['asterisk_number']);
  asterisk_call_number($user, 'bridge', 'asterisk', $user->uid, NULL, $call);
}

/**
 * Processes the call user callback
 */
function asterisk_call_user_page($user) {

  $callee = user_load(array('uid' => arg(2)));

  if ($user->uid == $callee->uid) {
    drupal_set_message(t('You cannot call yourself'));
  }
  elseif ($callee->number == '') {
    drupal_set_message(t('You cannot call this user--their phone number has not been configured.'));
  }
  else {
    $call['vars'] = array('drupal_callee_number' => $callee->number);
    return asterisk_call_number($user, 'bridge', 'asterisk', $user->uid, NULL, $call);
  }

  return FALSE;
}

function asterisk_call_log($account = NULL) {
  $user_log = is_object($account) && isset($account->uid);

  $sql  = "SELECT a.*, u.name FROM {asterisk_call_queue} a INNER JOIN {users} u ON u.uid = a.uid WHERE caller_number
  != 'system' AND callee_number != 'system'";

  $header = array(
    array('data' => t('Time'), 'field' => 'dispatch_time', 'sort' => 'desc'),
    array('data' => t('Caller'), 'field' => 'caller_number'),
    array('data' => t('Callee'), 'field' => 'callee_number')
  );

  if ($user_log) {
    $sql .= " AND u.uid = %d";
    $sql .= tablesort_sql($header);<