chan_websocket.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 2025, Sangoma Technologies Corporation
 *
 * George Joseph <gjoseph@sangoma.com>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */
 
/*! \file
 *
 * \author George Joseph <gjoseph@sangoma.com>
 *
 * \brief Websocket Media Channel
 *
 * \ingroup channel_drivers
 */
 
/*** MODULEINFO
    <depend>res_http_websocket</depend>
    <depend>res_websocket_client</depend>
    <support_level>core</support_level>
 ***/
 
#include "asterisk.h"
 
#include "asterisk/app.h"
#include "asterisk/causes.h"
#include "asterisk/channel.h"
#include "asterisk/codec.h"
#include "asterisk/http_websocket.h"
#include "asterisk/format_cache.h"
#include "asterisk/frame.h"
#include "asterisk/json.h"
#include "asterisk/lock.h"
#include "asterisk/mod_format.h"
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/uuid.h"
#include "asterisk/timing.h"
#include "asterisk/translate.h"
#include "asterisk/websocket_client.h"
#include "asterisk/sorcery.h"
 
static struct ast_sorcery *sorcery = NULL;
 
enum webchan_control_msg_format {
    WEBCHAN_CONTROL_MSG_FORMAT_PLAIN = 0,
    WEBCHAN_CONTROL_MSG_FORMAT_JSON,
    WEBCHAN_CONTROL_MSG_FORMAT_INVALID,
};
 
static const char *msg_format_map[] = {
    [WEBCHAN_CONTROL_MSG_FORMAT_PLAIN] = "plain-text",
    [WEBCHAN_CONTROL_MSG_FORMAT_JSON] = "json",
    [WEBCHAN_CONTROL_MSG_FORMAT_INVALID] = "invalid",
};
 
struct webchan_conf_global {
    SORCERY_OBJECT(details);
    enum webchan_control_msg_format control_msg_format;
    int write_timeout;
};
 
/* This is from the perspective of the app, NOT Asterisk */
enum webchan_media_direction {
    WEBCHAN_MEDIA_DIRECTION_BOTH,
    WEBCHAN_MEDIA_DIRECTION_OUT,
    WEBCHAN_MEDIA_DIRECTION_IN,
};
 
static const char *websocket_media_direction_map[] = {
    [WEBCHAN_MEDIA_DIRECTION_BOTH] = "both",
    [WEBCHAN_MEDIA_DIRECTION_OUT] = "out",
    [WEBCHAN_MEDIA_DIRECTION_IN] = "in",
};
 
static struct ast_websocket_server *ast_ws_server;
 
static struct ao2_container *instances = NULL;
 
struct websocket_pvt {
    enum ast_websocket_type type;
    struct ast_websocket_client *client;
    struct ast_websocket *websocket;
    struct ast_format *native_format;
    struct ast_codec *native_codec;
    struct ast_channel *channel;
    struct ast_timer *timer;
    AST_LIST_HEAD(, ast_frame) frame_queue;
    pthread_t outbound_read_thread;
    size_t bytes_read;
    size_t leftover_len;
    char *remote_addr;
    char *uri_params;
    char *leftover_data;
    enum webchan_control_msg_format control_msg_format;
    int no_auto_answer;
    int passthrough;
    int unbuffered;
    int last_unbuffered;
    int optimal_frame_size;
    int bulk_media_in_progress;
    int report_queue_drained;
    int frame_queue_length;
    int queue_full;
    int queue_paused;
    int media_direction;
    char connection_id[0];
};
 
/*
 * These are the indexes in the channel's file descriptor array
 * not the file descriptors themselves.
 */
#define WS_TIMER_FDNO (AST_EXTENDED_FDS + 1)
#define WS_WEBSOCKET_FDNO (AST_EXTENDED_FDS + 2)
 
#define MEDIA_WEBSOCKET_OPTIMAL_FRAME_SIZE "MEDIA_WEBSOCKET_OPTIMAL_FRAME_SIZE"
#define MEDIA_WEBSOCKET_CONNECTION_ID "MEDIA_WEBSOCKET_CONNECTION_ID"
#define INCOMING_CONNECTION_ID "INCOMING"
 
#define ANSWER_CHANNEL "ANSWER"
#define HANGUP_CHANNEL "HANGUP"
#define START_MEDIA_BUFFERING "START_MEDIA_BUFFERING"
#define STOP_MEDIA_BUFFERING "STOP_MEDIA_BUFFERING"
#define MARK_MEDIA "MARK_MEDIA"
#define FLUSH_MEDIA "FLUSH_MEDIA"
#define GET_DRIVER_STATUS "GET_STATUS"
#define REPORT_QUEUE_DRAINED "REPORT_QUEUE_DRAINED"
#define PAUSE_MEDIA "PAUSE_MEDIA"
#define CONTINUE_MEDIA "CONTINUE_MEDIA"
#define SET_MEDIA_DIRECTION "SET_MEDIA_DIRECTION"
 
#define QUEUE_LENGTH_MAX 1000
#define QUEUE_LENGTH_XOFF_LEVEL 900
#define QUEUE_LENGTH_XON_LEVEL 800
#define MAX_TEXT_MESSAGE_LEN MIN(128, (AST_WEBSOCKET_MAX_RX_PAYLOAD_SIZE - 1))
 
/* Forward declarations */
static int read_from_ws_and_queue(struct websocket_pvt *instance);
static void _websocket_request_hangup(struct websocket_pvt *instance, int ast_cause,
    enum ast_websocket_status_code tech_cause, int line, const char *function);
static struct ast_channel *webchan_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause);
static int webchan_call(struct ast_channel *ast, const char *dest, int timeout);
static struct ast_frame *webchan_read(struct ast_channel *ast);
static int webchan_write(struct ast_channel *ast, struct ast_frame *f);
static int webchan_hangup(struct ast_channel *ast);
static int webchan_send_dtmf_text(struct ast_channel *ast, char digit, unsigned int duration);
static int set_channel_timer(struct websocket_pvt *instance);
 
#define websocket_request_hangup(_instance, _cause, _tech) \
    _websocket_request_hangup(_instance, _cause, _tech, __LINE__, __FUNCTION__)
 
static struct ast_channel_tech websocket_tech = {
    .type = "WebSocket",
    .description = "Media over WebSocket Channel Driver",
    .requester = webchan_request,
    .call = webchan_call,
    .read = webchan_read,
    .write = webchan_write,
    .hangup = webchan_hangup,
    .send_digit_end = webchan_send_dtmf_text,
};
 
static enum webchan_control_msg_format control_msg_format_from_str(const char *value)
{
    if (ast_strlen_zero(value)) {
        return WEBCHAN_CONTROL_MSG_FORMAT_INVALID;
    } else if (strcasecmp(value, msg_format_map[WEBCHAN_CONTROL_MSG_FORMAT_PLAIN]) == 0) {
        return WEBCHAN_CONTROL_MSG_FORMAT_PLAIN;
    } else if (strcasecmp(value, msg_format_map[WEBCHAN_CONTROL_MSG_FORMAT_JSON]) == 0) {
        return WEBCHAN_CONTROL_MSG_FORMAT_JSON;
    } else {
        return WEBCHAN_CONTROL_MSG_FORMAT_INVALID;
    }
}
 
static const char *control_msg_format_to_str(enum webchan_control_msg_format value)
{
    if (!ARRAY_IN_BOUNDS(value, msg_format_map)) {
        return NULL;
    }
    return msg_format_map[value];
}
 
/*!
 * \internal
 * \brief Catch-all to print events that don't have any data.
 * \warning Do not call directly.
 */
static char *_create_event_nodata(struct websocket_pvt *instance, char *event)
{
    char *payload = NULL;
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json * msg = ast_json_pack("{ s:s s:s }",
            "event", event,
            "channel_id", ast_channel_uniqueid(instance->channel));
        if (!msg) {
            return NULL;
        }
        payload = ast_json_dump_string_format(msg, AST_JSON_COMPACT);
        ast_json_unref(msg);
    } else {
        payload = ast_strdup(event);
    }
 
    return payload;
}
 
#define _create_event_MEDIA_XON(_instance) _create_event_nodata(_instance, "MEDIA_XON");
#define _create_event_MEDIA_XOFF(_instance) _create_event_nodata(_instance, "MEDIA_XOFF");
#define _create_event_QUEUE_DRAINED(_instance) _create_event_nodata(_instance, "QUEUE_DRAINED");
 
/*!
 * \internal
 * \brief Print the MEDIA_START event.
 * \warning Do not call directly.
 */
static char *_create_event_MEDIA_START(struct websocket_pvt *instance)
{
    char *payload = NULL;
 
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json *msg = ast_json_pack("{s:s, s:s, s:s, s:s, s:s, s:i, s:i, s:b, s:b, s:o }",
            "event", "MEDIA_START",
            "connection_id", instance->connection_id,
            "channel", ast_channel_name(instance->channel),
            "channel_id", ast_channel_uniqueid(instance->channel),
            "format", ast_format_get_name(instance->native_format),
            "optimal_frame_size", instance->optimal_frame_size,
            "ptime", instance->native_codec->default_ms,
            "passthrough", instance->passthrough,
            "unbuffered", instance->unbuffered,
            "channel_variables", ast_json_channel_vars(ast_channel_varshead(
                        instance->channel))
            );
        if (!msg) {
            return NULL;
        }
        payload = ast_json_dump_string_format(msg, AST_JSON_COMPACT);
        ast_json_unref(msg);
    } else {
        ast_asprintf(&payload, "%s %s:%s %s:%s %s:%s %s:%s %s:%d %s:%d %s:%s %s:%s",
            "MEDIA_START",
            "connection_id", instance->connection_id,
            "channel", ast_channel_name(instance->channel),
            "channel_id", ast_channel_uniqueid(instance->channel),
            "format", ast_format_get_name(instance->native_format),
            "optimal_frame_size", instance->optimal_frame_size,
            "ptime", instance->native_codec->default_ms,
            "passthrough", instance->passthrough ? "true" : "false",
            "unbuffered", instance->unbuffered ? "true" : "false"
            );
    }
 
    return payload;
}
 
/*!
 * \internal
 * \brief Print the MEDIA_BUFFERING_COMPLETED event.
 * \warning Do not call directly.
 */
static char *_create_event_MEDIA_BUFFERING_COMPLETED(struct websocket_pvt *instance,
    const char *id)
{
    char *payload = NULL;
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json *msg = ast_json_pack("{s:s, s:s, s:s}",
            "event", "MEDIA_BUFFERING_COMPLETED",
            "channel_id", ast_channel_uniqueid(instance->channel),
            "correlation_id", S_OR(id, "")
            );
        if (!msg) {
            return NULL;
        }
        payload = ast_json_dump_string_format(msg, AST_JSON_COMPACT);
        ast_json_unref(msg);
    } else {
        ast_asprintf(&payload, "%s%s%s",
            "MEDIA_BUFFERING_COMPLETED",
            S_COR(id, " ",""), S_OR(id, ""));
 
    }
 
    return payload;
}
 
/*!
 * \internal
 * \brief Print the MEDIA_MARK_PROCESSED event.
 * \warning Do not call directly.
 */
static char *_create_event_MEDIA_MARK_PROCESSED(struct websocket_pvt *instance,
    const char *id)
{
    char *payload = NULL;
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json *msg = ast_json_pack("{s:s, s:s, s:s}",
            "event", "MEDIA_MARK_PROCESSED",
            "channel_id", ast_channel_uniqueid(instance->channel),
            "correlation_id", S_OR(id, "")
            );
        if (!msg) {
            return NULL;
        }
        payload = ast_json_dump_string_format(msg, AST_JSON_COMPACT);
        ast_json_unref(msg);
    } else {
        ast_asprintf(&payload, "%s%s%s",
            "MEDIA_MARK_PROCESSED",
            S_COR(id, " ",""), S_OR(id, ""));
 
    }
 
    return payload;
}
 
/*!
 * \internal
 * \brief Print the DTMF_END event.
 * \warning Do not call directly.
 */
static char *_create_event_DTMF_END(struct websocket_pvt *instance,
    const char digit)
{
    char *payload = NULL;
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json *msg = ast_json_pack("{s:s, s:s, s:s#}",
            "event", "DTMF_END",
            "channel_id", ast_channel_uniqueid(instance->channel),
            "digit", &digit, 1
            );
        if (!msg) {
            return NULL;
        }
        payload = ast_json_dump_string_format(msg, AST_JSON_COMPACT);
        ast_json_unref(msg);
    } else {
        ast_asprintf(&payload, "%s digit:%c channel_id:%s",
            "DTMF_END", digit, ast_channel_uniqueid(instance->channel));
    }
 
    return payload;
}
 
/*!
 * \internal
 * \brief Print the STATUS event.
 * \warning Do not call directly.
 */
static char *_create_event_STATUS(struct websocket_pvt *instance)
{
    char *payload = NULL;
 
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json *msg = ast_json_pack("{s:s, s:s, s:i, s:i, s:i, s:b, s:b, s:b }",
            "event", "STATUS",
            "channel_id", ast_channel_uniqueid(instance->channel),
            "queue_length", instance->frame_queue_length,
            "xon_level", QUEUE_LENGTH_XON_LEVEL,
            "xoff_level", QUEUE_LENGTH_XOFF_LEVEL,
            "queue_full", instance->queue_full,
            "bulk_media", instance->bulk_media_in_progress,
            "media_paused", instance->queue_paused
            );
        if (!msg) {
            return NULL;
        }
        payload = ast_json_dump_string_format(msg, AST_JSON_COMPACT);
        ast_json_unref(msg);
    } else {
        ast_asprintf(&payload, "%s channel_id:%s queue_length:%d xon_level:%d xoff_level:%d queue_full:%s bulk_media:%s media_paused:%s",
            "STATUS",
            ast_channel_uniqueid(instance->channel),
            instance->frame_queue_length, QUEUE_LENGTH_XON_LEVEL,
            QUEUE_LENGTH_XOFF_LEVEL,
            S_COR(instance->queue_full, "true", "false"),
            S_COR(instance->bulk_media_in_progress, "true", "false"),
            S_COR(instance->queue_paused, "true", "false")
            );
    }
 
    return payload;
}
 
/*!
 * \internal
 * \brief Print the ERROR event.
 * \warning Do not call directly.
 */
static __attribute__ ((format (gnu_printf, 2, 3))) char *_create_event_ERROR(
    struct websocket_pvt *instance, const char *format, ...)
{
    char *payload = NULL;
    char *error_text = NULL;
    va_list ap;
    int res = 0;
 
    va_start(ap, format);
    res = ast_vasprintf(&error_text, format, ap);
    va_end(ap);
    if (res < 0 || !error_text) {
        return NULL;
    }
 
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json *msg = ast_json_pack("{s:s, s:s, s:s}",
            "event", "ERROR",
            "channel_id", ast_channel_uniqueid(instance->channel),
            "error_text", error_text);
        ast_free(error_text);
        if (!msg) {
            return NULL;
        }
        payload = ast_json_dump_string_format(msg, AST_JSON_COMPACT);
        ast_json_unref(msg);
    } else {
        ast_asprintf(&payload, "%s channel_id:%s error_text:%s",
            "ERROR", ast_channel_uniqueid(instance->channel), error_text);
        ast_free(error_text);
    }
 
    return payload;
}
 
/*!
 * \def create_event
 * \brief Use this macro to create events passing in any event-specific parameters.
 */
#define create_event(_instance, _event, ...) \
    _create_event_ ## _event(_instance, ##__VA_ARGS__)
 
/*!
 * \def send_event
 * \brief Use this macro to create and send events passing in any event-specific parameters.
 */
#define send_event(_instance, _event, ...) \
({ \
    int _res = -1; \
    char *_payload = _create_event_ ## _event(_instance, ##__VA_ARGS__); \
    if (_payload && _instance->websocket) { \
        _res = ast_websocket_write_string(_instance->websocket, _payload); \
        if (_res != 0) { \
            ast_log(LOG_ERROR, "%s: Unable to send event %s\n", \
                ast_channel_name(instance->channel), _payload); \
        } else { \
            ast_debug(3, "%s: Sent %s\n", \
                ast_channel_name(instance->channel), _payload); \
        }\
        ast_free(_payload); \
    } \
    (_res); \
})
 
/*!
 * \internal
 *
 * This function gets called by webchan_read which is triggered by the channel
 * timer firing or by a websocket frame being received while in unbuffered mode.
 * It always gets called at least every 20ms (or whatever the timer is set to)
 * even if there are no frames in the queue.
 */
static struct ast_frame *dequeue_frame(struct websocket_pvt *instance)
{
    struct ast_frame *queued_frame = NULL;
    SCOPED_LOCK(frame_queue_lock, &instance->frame_queue, AST_LIST_LOCK,
        AST_LIST_UNLOCK);
 
    /*
     * If the queue is paused, don't read a frame.
     */
    if (instance->queue_paused) {
        return NULL;
    }
 
    /*
     * We need to check if we need to send an XON before anything
     * else because there are multiple escape paths in this function
     * and we don't want to accidentally keep the queue in a "full"
     * state.
     */
    if (instance->queue_full && instance->frame_queue_length < QUEUE_LENGTH_XON_LEVEL) {
        instance->queue_full = 0;
        ast_debug(4, "%s: WebSocket sending MEDIA_XON\n",
            ast_channel_name(instance->channel));
        send_event(instance, MEDIA_XON);
    }
 
    queued_frame = AST_LIST_REMOVE_HEAD(&instance->frame_queue, frame_list);
 
    /*
     * If there are no frames in the queue, we need to return NULL.
     * We also need to send the QUEUE_DRAINED notification if we
     * were requested to do so.
     */
    if (!queued_frame) {
        if (instance->report_queue_drained) {
            instance->report_queue_drained = 0;
            ast_debug(4, "%s: WebSocket sending QUEUE_DRAINED\n",
                ast_channel_name(instance->channel));
            send_event(instance, QUEUE_DRAINED);
        }
        return NULL;
    }
 
    /*
     * The only way a control frame could be present here is as
     * a result of us calling queue_option_frame() in response
     * to an incoming TEXT command from the websocket.
     * We'll be safe and make sure it's a AST_CONTROL_OPTION
     * frame anyway.
     *
     * It's quite possible that there are multiple control frames
     * in a row in the queue so we need to process consecutive ones
     * immediately.
     *
     * In any case, processing a control frame MUST not use up
     * a media timeslot so after all control frames have been
     * processed, we need to read an audio frame and process it.
     */
    while (queued_frame && queued_frame->frametype == AST_FRAME_CONTROL) {
        if (queued_frame->subclass.integer == AST_CONTROL_OPTION) {
            /*
             * We just need to send the data to the websocket.
             * The data should already be NULL terminated.
             */
            int res = ast_websocket_write_string(instance->websocket,
                queued_frame->data.ptr);
            if (res != 0) {
                ast_log(LOG_ERROR, "%s: Unable to send event %s\n",
                    ast_channel_name(instance->channel), (char *)queued_frame->data.ptr);
            } else {
                ast_debug(4, "%s: Sent %s\n",
                    ast_channel_name(instance->channel), (char *)queued_frame->data.ptr);
            }
        }
        /*
         * We do NOT send these to the core so we need to free
         * the frame and grab the next one.  If it's also a
         * control frame, we need to process it otherwise
         * continue down in the function.
         */
        ast_frame_free(queued_frame, 0);
        queued_frame = AST_LIST_REMOVE_HEAD(&instance->frame_queue, frame_list);
        /*
         * Jut FYI... We didn't bump the queue length when we added the control
         * frames so we don't need to decrement it here.
         */
    }
 
    /*
     * If, after reading all control frames,  there are no frames
     * left in the queue, we need to return NULL.
     */
    if (!queued_frame) {
        return NULL;
    }
 
    instance->frame_queue_length--;
 
    return queued_frame;
}
 
static struct ast_frame *create_frame_from_buffer(struct websocket_pvt *instance,
    char *buffer, size_t len)
{
    struct ast_frame fr = { 0, };
    struct ast_frame *duped_frame = NULL;
 
    AST_FRAME_SET_BUFFER(&fr, buffer, 0, len);
    fr.frametype = AST_FRAME_VOICE;
    fr.subclass.format = instance->native_format;
    if (instance->native_codec->samples_count) {
        fr.samples = instance->native_codec->samples_count(&fr);
    }
 
    duped_frame = ast_frisolate(&fr);
    if (!duped_frame) {
        ast_log(LOG_WARNING, "%s: Failed to isolate frame\n",
            ast_channel_name(instance->channel));
        return NULL;
    }
 
    return duped_frame;
}
 
/*!
 * \internal
 *
 * There are two file descriptors on this channel that can trigger
 * this function...
 *
 *   The timer fd (WS_TIMER_FDNO) which gets triggered at a constant
 *   rate determined by the format.  In this case, we need to pull a
 *   frame OFF the queue and return it to the core.
 *
 *   The websocket fd (WS_WEBSOCKET_FDNO) which gets triggered when
 *   there's incoming data to read from the websocket.  In this case,
 *   we read the data and put it ON the queue.  If in unbuffered mode,
 *   we'll read it off the queue immediately and return it.  If not in
 *   unbuffered mode, we'll return a null frame now and the frame read
 *   will be processed by the timer tick when it comes to the head
 *   of the queue.
 *
 *   The reason for queueing and dequeueing immediately in unbuffered
 *   mode is that read_from_ws_and_queue does a lot of work before adding
 *   a frame to the frame queue, if it even needs to.  It's much simpler
 *   to just queue and dequeue, both from a code organization standpoint
 *   as well as an instruction-path-length standpoint, than it would be
 *   refactor that code so it can return a frame directly.
 */
static struct ast_frame *webchan_read(struct ast_channel *ast)
{
    struct websocket_pvt *instance = NULL;
    struct ast_frame *native_frame = NULL;
    int fdno = ast_channel_fdno(ast);
 
    instance = ast_channel_tech_pvt(ast);
    if (!instance) {
        return NULL;
    }
 
    if (fdno != WS_TIMER_FDNO && fdno != WS_WEBSOCKET_FDNO) {
        return &ast_null_frame;
    }
 
    if (fdno == WS_WEBSOCKET_FDNO) {
        read_from_ws_and_queue(instance);
        if (!instance->unbuffered) {
            return &ast_null_frame;
        }
    } else {
        if (ast_timer_get_event(instance->timer) == AST_TIMING_EVENT_EXPIRED) {
            ast_timer_ack(instance->timer, 1);
        }
    }
 
    native_frame = dequeue_frame(instance);
    if (!native_frame) {
        if (instance->leftover_len > 0) {
            native_frame = create_frame_from_buffer(instance, instance->leftover_data, instance->leftover_len);
            if (native_frame) {
                ast_debug(4, "%s: Triggered with no frame available but with %d bytes in leftover_data.  Returning partial frame.\n",
                    ast_channel_name(ast), (int)instance->leftover_len);
                instance->leftover_len = 0;
                return native_frame;
            }
        }
        ast_debug(4, "%s: Triggered with no frame available and no data in leftover_data.  Returning NULL frame.\n",
            ast_channel_name(ast));
        return &ast_null_frame;
    }
 
    ast_debug(5, "%s: Dequeued %d byte frame.  Left in buffer: %d\n",
        ast_channel_name(ast), native_frame->datalen, (int)instance->leftover_len);
 
    return native_frame;
}
 
static int queue_frame_from_buffer(struct websocket_pvt *instance,
    char *buffer, size_t len)
{
    struct ast_frame *duped_frame = NULL;
 
    duped_frame = create_frame_from_buffer(instance, buffer, len);
    if (!duped_frame) {
        return -1;
    }
 
    {
        SCOPED_LOCK(frame_queue_lock, &instance->frame_queue, AST_LIST_LOCK,
            AST_LIST_UNLOCK);
        AST_LIST_INSERT_TAIL(&instance->frame_queue, duped_frame, frame_list);
        instance->frame_queue_length++;
        if (!instance->queue_full && instance->frame_queue_length >= QUEUE_LENGTH_XOFF_LEVEL) {
            instance->queue_full = 1;
            send_event(instance, MEDIA_XOFF);
        }
    }
 
    ast_debug(5, "%s: Queued %d byte frame\n", ast_channel_name(instance->channel),
        duped_frame->datalen);
 
    return 0;
}
 
static int queue_option_frame(struct websocket_pvt *instance,
    char *buffer)
{
    struct ast_frame fr = { 0, };
    struct ast_frame *duped_frame = NULL;
 
    AST_FRAME_SET_BUFFER(&fr, buffer, 0, strlen(buffer) + 1);
    fr.frametype = AST_FRAME_CONTROL;
    fr.subclass.integer = AST_CONTROL_OPTION;
 
    duped_frame = ast_frisolate(&fr);
    if (!duped_frame) {
        ast_log(LOG_WARNING, "%s: Failed to isolate frame\n",
            ast_channel_name(instance->channel));
        return -1;
    }
 
    AST_LIST_LOCK(&instance->frame_queue);
    AST_LIST_INSERT_TAIL(&instance->frame_queue, duped_frame, frame_list);
    AST_LIST_UNLOCK(&instance->frame_queue);
 
    ast_debug(4, "%s: Queued '%s' option frame\n",
        ast_channel_name(instance->channel), buffer);
 
    return 0;
}
 
#define ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command) \
({ \
    if (instance->passthrough) { \
        send_event(instance, ERROR, "%s not supported in passthrough mode", command); \
        ast_debug(4, "%s: WebSocket in passthrough mode. Ignoring %s command.\n", \
            ast_channel_name(instance->channel), command); \
        return 0; \
    } \
})
 
#define ERROR_ON_UNBUFFERED_MODE_RTN(instance, command) \
({ \
    if (instance->unbuffered) { \
        send_event(instance, ERROR, "%s not supported in unbuffered mode", command); \
        ast_debug(4, "%s: WebSocket in unbuffered mode. Ignoring %s command.\n", \
            ast_channel_name(instance->channel), command); \
        return 0; \
    } \
})
 
#define ERROR_ON_INVALID_MEDIA_DIRECTION_RTN(instance, command, direction) \
({ \
    if (instance->media_direction == direction) { \
        send_event(instance, ERROR, "%s not supported while media direction " \
            "is '%s'", command, websocket_media_direction_map[direction]); \
        ast_debug(4, "%s: WebSocket media direction is '%s'. Ignoring %s command.\n", \
            ast_channel_name(instance->channel), websocket_media_direction_map[direction], command); \
        return 0; \
    } \
})
 
/*!
 * \internal
 * \brief Handle commands from the websocket
 *
 * \param instance
 * \param buffer Allocated by caller so don't free.
 * \retval 0 Success
 * \retval -1 Failure
 */
static int handle_command(struct websocket_pvt *instance, char *buffer)
{
    int res = 0;
    RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
    const char *command = NULL;
    char *data = NULL;
 
    if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
        struct ast_json_error json_error;
 
        json = ast_json_load_buf(buffer, strlen(buffer), &json_error);
        if (!json) {
            send_event(instance, ERROR, "Unable to parse JSON command");
            return -1;
        }
        command = ast_json_object_string_get(json, "command");
    } else {
        command = buffer;
        data = strchr(buffer, ' ');
        if (data) {
            *data = '\0';
            data++;
        }
    }
 
    if (ast_strings_equal(command, ANSWER_CHANNEL)) {
        ast_queue_control(instance->channel, AST_CONTROL_ANSWER);
 
    } else if (ast_strings_equal(command, HANGUP_CHANNEL)) {
        websocket_request_hangup(instance, AST_CAUSE_NORMAL, AST_WEBSOCKET_STATUS_NORMAL);
 
    } else if (ast_strings_equal(command, START_MEDIA_BUFFERING)) {
        ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command);
        ERROR_ON_INVALID_MEDIA_DIRECTION_RTN(instance, command, WEBCHAN_MEDIA_DIRECTION_IN);
        if (instance->bulk_media_in_progress) {
            send_event(instance, ERROR, "START_MEDIA_BUFFERING can't be called when media buffering is already active.\n");
            return 0;
        }
 
        AST_LIST_LOCK(&instance->frame_queue);
        instance->bulk_media_in_progress = 1;
        instance->last_unbuffered = instance->unbuffered;
        instance->unbuffered = 0;
        AST_LIST_UNLOCK(&instance->frame_queue);
 
    } else if (ast_strings_equal(command, STOP_MEDIA_BUFFERING)) {
        const char *id;
        char *option;
        SCOPED_LOCK(frame_queue_lock, &instance->frame_queue, AST_LIST_LOCK,
            AST_LIST_UNLOCK);
 
        if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
            id = ast_json_object_string_get(json, "correlation_id");
        } else {
            id = data;
        }
 
        ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command);
        ERROR_ON_INVALID_MEDIA_DIRECTION_RTN(instance, command, WEBCHAN_MEDIA_DIRECTION_IN);
 
        if (!instance->bulk_media_in_progress) {
            send_event(instance, ERROR, "STOP_MEDIA_BUFFERING can't be called when media buffering isn't active.\n");
            return 0;
        }
 
        ast_debug(4, "%s: WebSocket %s '%s' with %d bytes in leftover_data.\n",
            ast_channel_name(instance->channel), STOP_MEDIA_BUFFERING, id,
            (int)instance->leftover_len);
 
        instance->bulk_media_in_progress = 0;
        instance->unbuffered = instance->last_unbuffered;
        if (instance->leftover_len > 0) {
            res = queue_frame_from_buffer(instance, instance->leftover_data, instance->leftover_len);
            if (res != 0) {
                return res;
            }
        }
        instance->leftover_len = 0;
        option = create_event(instance, MEDIA_BUFFERING_COMPLETED, id);
        if (!option) {
            return -1;
        }
        res = queue_option_frame(instance, option);
        ast_free(option);
 
    } else if (ast_strings_equal(command, MARK_MEDIA)) {
        const char *id;
        char *option;
        SCOPED_LOCK(frame_queue_lock, &instance->frame_queue, AST_LIST_LOCK,
            AST_LIST_UNLOCK);
 
        ERROR_ON_INVALID_MEDIA_DIRECTION_RTN(instance, command, WEBCHAN_MEDIA_DIRECTION_IN);
 
        if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
            id = ast_json_object_string_get(json, "correlation_id");
        } else {
            id = data;
        }
 
        ast_debug(4, "%s: %s %s\n",
            ast_channel_name(instance->channel), MARK_MEDIA, id);
 
        option = create_event(instance, MEDIA_MARK_PROCESSED, id);
        if (!option) {
            return -1;
        }
        res = queue_option_frame(instance, option);
        ast_free(option);
 
    } else if (ast_strings_equal(command, FLUSH_MEDIA)) {
        struct ast_frame *frame = NULL;
 
        ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command);
        ERROR_ON_UNBUFFERED_MODE_RTN(instance, command);
 
        AST_LIST_LOCK(&instance->frame_queue);
        while ((frame = AST_LIST_REMOVE_HEAD(&instance->frame_queue, frame_list))) {
            ast_frfree(frame);
        }
        instance->frame_queue_length = 0;
        instance->bulk_media_in_progress = 0;
        instance->leftover_len = 0;
        instance->unbuffered = instance->last_unbuffered;
        AST_LIST_UNLOCK(&instance->frame_queue);
 
    } else if (ast_strings_equal(command, REPORT_QUEUE_DRAINED)) {
        ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command);
 
        AST_LIST_LOCK(&instance->frame_queue);
        instance->report_queue_drained = 1;
        AST_LIST_UNLOCK(&instance->frame_queue);
 
    } else if (ast_strings_equal(command, GET_DRIVER_STATUS)) {
        return send_event(instance, STATUS);
 
    } else if (ast_strings_equal(command, PAUSE_MEDIA)) {
        ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command);
        ERROR_ON_UNBUFFERED_MODE_RTN(instance, command);
        ERROR_ON_INVALID_MEDIA_DIRECTION_RTN(instance, command, WEBCHAN_MEDIA_DIRECTION_IN);
        AST_LIST_LOCK(&instance->frame_queue);
        instance->queue_paused = 1;
        AST_LIST_UNLOCK(&instance->frame_queue);
 
    } else if (ast_strings_equal(command, CONTINUE_MEDIA)) {
        ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command);
        ERROR_ON_UNBUFFERED_MODE_RTN(instance, command);
        ERROR_ON_INVALID_MEDIA_DIRECTION_RTN(instance, command, WEBCHAN_MEDIA_DIRECTION_IN);
        AST_LIST_LOCK(&instance->frame_queue);
        instance->queue_paused = 0;
        AST_LIST_UNLOCK(&instance->frame_queue);
 
    } else if (ast_strings_equal(command, SET_MEDIA_DIRECTION)) {
        const char *direction;
 
        ERROR_ON_PASSTHROUGH_MODE_RTN(instance, command);
 
        if (instance->control_msg_format != WEBCHAN_CONTROL_MSG_FORMAT_JSON) {
            send_event(instance, ERROR, "%s only supports JSON format.\n", command);
            return 0;
        }
 
        direction = ast_json_object_string_get(json, "direction");
        if (!direction) {
            send_event(instance, ERROR, "%s requires a 'direction' parameter.\n", command);
            return 0;
        }
 
        if (!strcmp("both", direction)) {
            if (instance->media_direction == WEBCHAN_MEDIA_DIRECTION_BOTH) {
                return 0;
            }
 
            if (!instance->timer) {
                set_channel_timer(instance);
                ast_queue_frame(instance->channel, &ast_null_frame);
            }
 
            instance->media_direction = WEBCHAN_MEDIA_DIRECTION_BOTH;
 
        } else if (!strcmp("out", direction)) {
            if (instance->media_direction == WEBCHAN_MEDIA_DIRECTION_OUT) {
                return 0;
            }
 
            if (!instance->timer) {
                set_channel_timer(instance);
                ast_queue_frame(instance->channel, &ast_null_frame);
            }
 
            instance->media_direction = WEBCHAN_MEDIA_DIRECTION_OUT;
 
        } else if (!strcmp("in", direction)) {
            if (instance->media_direction == WEBCHAN_MEDIA_DIRECTION_IN) {
                return 0;
            }
 
            if (instance->timer) {
                ast_channel_internal_fd_clear(instance->channel, WS_TIMER_FDNO);
                ast_timer_close(instance->timer);
                instance->timer = NULL;
                ast_queue_frame(instance->channel, &ast_null_frame);
            }
 
            instance->media_direction = WEBCHAN_MEDIA_DIRECTION_IN;
 
        } else {
            send_event(instance, ERROR, "'%s' is not a valid direction for %s.\n",
                direction, command);
            return 0;
        }
 
    } else {
        ast_log(LOG_WARNING, "%s: WebSocket %s command unknown\n",
            ast_channel_name(instance->channel), command);
    }
 
    return res;
}
 
static int process_text_message(struct websocket_pvt *instance,
    char *payload, uint64_t payload_len)
{
    char *command;
 
    if (payload_len == 0) {
        ast_log(LOG_WARNING, "%s: WebSocket TEXT message has 0 length\n",
            ast_channel_name(instance->channel));
        return 0;
    }
 
    if (payload_len > MAX_TEXT_MESSAGE_LEN) {
        ast_log(LOG_WARNING, "%s: WebSocket TEXT message of length %d exceeds maximum length of %d\n",
            ast_channel_name(instance->channel), (int)payload_len, MAX_TEXT_MESSAGE_LEN);
        return 0;
    }
 
    /*
     * Unfortunately, payload is not NULL terminated even when it's
     * a TEXT frame so we need to allocate a new buffer, copy
     * the data into it, and NULL terminate it.
     */
    command = ast_alloca(payload_len + 1);
    memcpy(command, payload, payload_len); /* Safe */
    command[payload_len] = '\0';
    command = ast_strip(command);
 
    ast_debug(4, "%s: Received: %s\n",
        ast_channel_name(instance->channel), command);
 
    return handle_command(instance, command);
}
 
static int process_binary_message(struct websocket_pvt *instance,
    char *payload, uint64_t payload_len)
{
    char *next_frame_ptr = NULL;
    size_t bytes_read = 0;
    int res = 0;
    size_t bytes_left = 0;
 
    {
        SCOPED_LOCK(frame_queue_lock, &instance->frame_queue, AST_LIST_LOCK,
            AST_LIST_UNLOCK);
        if (instance->frame_queue_length >= QUEUE_LENGTH_MAX) {
            ast_debug(4, "%s: WebSocket queue is full. Ignoring incoming binary message.\n",
                ast_channel_name(instance->channel));
            return 0;
        }
    }
 
    next_frame_ptr = payload;
    instance->bytes_read += payload_len;
 
    if (instance->unbuffered) {
        res = queue_frame_from_buffer(instance, payload, payload_len);
        return res;
    }
 
    if (instance->bulk_media_in_progress && instance->leftover_len > 0) {
        /*
         * We have leftover data from a previous websocket message.
         * Try to make a complete frame by appending data from
         * the current message to the leftover data.
         */
        char *append_ptr = instance->leftover_data + instance->leftover_len;
        size_t bytes_needed_for_frame = instance->optimal_frame_size - instance->leftover_len;
        /*
         * It's possible that even the current message doesn't have enough
         * data to make a complete frame.
         */
        size_t bytes_avail_to_copy = MIN(bytes_needed_for_frame, payload_len);
 
        /*
         * Append whatever we can to the end of the leftover data
         * even if it's not enough to make a complete frame.
         */
        memcpy(append_ptr, payload, bytes_avail_to_copy);
 
        /*
         * If leftover data is still short, just return and wait for the
         * next websocket message.
         */
        if (bytes_avail_to_copy < bytes_needed_for_frame) {
            ast_debug(4, "%s: Leftover data %d bytes but only %d new bytes available of %d needed. Appending and waiting for next message.\n",
                ast_channel_name(instance->channel), (int)instance->leftover_len, (int)bytes_avail_to_copy, (int)bytes_needed_for_frame);
            instance->leftover_len += bytes_avail_to_copy;
            return 0;
        }
 
        res = queue_frame_from_buffer(instance, instance->leftover_data, instance->optimal_frame_size);
        if (res < 0) {
            return -1;
        }
 
        /*
         * We stole data from the current payload so decrement payload_len
         * and set the next frame pointer after the data in payload
         * we just copied.
         */
        payload_len -= bytes_avail_to_copy;
        next_frame_ptr = payload + bytes_avail_to_copy;
 
        ast_debug(5, "%s: --- BR: %4d  FQ: %4d  PL: %4d  LOL: %3d  P: %p  NFP: %p  OFF: %4d  NPL: %4d  BAC: %3d\n",
            ast_channel_name(instance->channel),
            instance->frame_queue_length,
            (int)instance->bytes_read,
            (int)(payload_len + bytes_avail_to_copy),
            (int)instance->leftover_len,
            payload,
            next_frame_ptr,
            (int)(next_frame_ptr - payload),
            (int)payload_len,
            (int)bytes_avail_to_copy
            );
 
 
        instance->leftover_len = 0;
    }
 
    if (!instance->bulk_media_in_progress && instance->leftover_len > 0) {
        instance->leftover_len = 0;
    }
 
    bytes_left = payload_len;
    while (bytes_read < payload_len && bytes_left >= instance->optimal_frame_size) {
        res = queue_frame_from_buffer(instance, next_frame_ptr,
            instance->optimal_frame_size);
        if (res < 0) {
            break;
        }
        bytes_read += instance->optimal_frame_size;
        next_frame_ptr += instance->optimal_frame_size;
        bytes_left -= instance->optimal_frame_size;
    }
 
    if (instance->bulk_media_in_progress && bytes_left > 0) {
        /*
         * We have a partial frame.  Save the leftover data.
         */
        ast_debug(5, "%s: +++ BR: %4d  FQ: %4d  PL: %4d  LOL: %3d  P: %p  NFP: %p  OFF: %4d  BL: %4d\n",
            ast_channel_name(instance->channel),
            (int)instance->bytes_read,
            instance->frame_queue_length,
            (int)payload_len,
            (int)instance->leftover_len,
            payload,
            next_frame_ptr,
            (int)(next_frame_ptr - payload),
            (int)bytes_left
            );
        memcpy(instance->leftover_data, next_frame_ptr, bytes_left);
        instance->leftover_len = bytes_left;
    }
 
    return 0;
}
 
static int read_from_ws_and_queue(struct websocket_pvt *instance)
{
    uint64_t payload_len = 0;
    char *payload = NULL;
    enum ast_websocket_opcode opcode;
    int fragmented = 0;
    int res = 0;
 
    if (!instance->websocket) {
        ast_log(LOG_WARNING, "%s: WebSocket session not found\n",
            ast_channel_name(instance->channel));
        return -1;
    }
 
    res = ast_websocket_read(instance->websocket, &payload, &payload_len,
        &opcode, &fragmented);
 
    if (res) {
        ast_debug(3, "%s: WebSocket read error\n",
            ast_channel_name(instance->channel));
        websocket_request_hangup(instance, AST_CAUSE_NETWORK_OUT_OF_ORDER, AST_WEBSOCKET_STATUS_GOING_AWAY);
        return -1;
    }
    ast_debug(5, "%s: WebSocket read %d bytes\n", ast_channel_name(instance->channel),
        (int)payload_len);
 
    if (opcode == AST_WEBSOCKET_OPCODE_TEXT) {
        return process_text_message(instance, payload, payload_len);
    }
 
    /*
     * PINGs and PONGs will have been handled by res_http_websocket.
     * We also need to ignore CONTINUATION frames as they will be accumulated
     * by res_http_websocket until the threshold set in websocket_handoff_to_channel()
     * is reached, then it will send us a TEXT or BINARY frame.
     */
    if (opcode == AST_WEBSOCKET_OPCODE_PING || opcode == AST_WEBSOCKET_OPCODE_PONG
        || opcode == AST_WEBSOCKET_OPCODE_CONTINUATION) {
        return 0;
    }
 
    if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
        ast_debug(3, "%s: WebSocket closed by remote\n",
            ast_channel_name(instance->channel));
        websocket_request_hangup(instance, AST_CAUSE_NORMAL, AST_WEBSOCKET_STATUS_GOING_AWAY);
        return -1;
    }
 
    if (opcode == AST_WEBSOCKET_OPCODE_BINARY) {
        /* If the application's media direction is 'in', drop any media we receive from it */
        if (instance->media_direction == WEBCHAN_MEDIA_DIRECTION_IN) {
            ast_debug(5, "%s: WebSocket dropped frame (application media direction is 'in')\n",
                ast_channel_name(instance->channel));
            return 0;
        }
    } else {
        ast_log(LOG_WARNING, "%s: WebSocket frame type %d not supported\n",
            ast_channel_name(instance->channel), (int)opcode);
        websocket_request_hangup(instance, AST_CAUSE_FAILURE, AST_WEBSOCKET_STATUS_UNSUPPORTED_DATA);
        return 0;
    }
 
    return process_binary_message(instance, payload, payload_len);
}
 
static int websocket_handoff_to_channel(struct websocket_pvt *instance)
{
    int res = 0;
    int nodelay = 1;
    struct ast_sockaddr *remote_addr = ast_websocket_remote_address(instance->websocket);
 
    instance->remote_addr = ast_strdup(ast_sockaddr_stringify(remote_addr));
    ast_debug(3, "%s: WebSocket connection with %s established\n",
        ast_channel_name(instance->channel), instance->remote_addr);
 
    if (setsockopt(ast_websocket_fd(instance->websocket),
        IPPROTO_TCP, TCP_NODELAY, (char *) &nodelay, sizeof(nodelay)) < 0) {
        ast_log(LOG_WARNING, "Failed to set TCP_NODELAY on websocket connection: %s\n", strerror(errno));
    }
 
    /*
     * The way write timeouts are handled in iostream requires the socket to be
     * in non-blocking mode.  This is fine for reads as well because we already
     * set the websocket file descriptor on the channel and let it call
     * webchan_read() when data is available.
     */
    ast_websocket_set_nonblock(instance->websocket);
 
    /*
     * Tell res_http_websocket to accumulate incoming WebSocket CONTINUATION frames
     * into chunks of 1024 bytes and send us a TEXT or BINARY frame when the threshold
     * is reached.
     */
    ast_websocket_reconstruct_enable(instance->websocket, 1024);
 
    ast_channel_set_fd(instance->channel, WS_WEBSOCKET_FDNO, ast_websocket_fd(instance->websocket));
 
    res = send_event(instance, MEDIA_START);
    if (res != 0 ) {
        if (instance->type == AST_WS_TYPE_SERVER) {
            websocket_request_hangup(instance, AST_CAUSE_NETWORK_OUT_OF_ORDER, AST_WEBSOCKET_STATUS_GOING_AWAY);
        } else {
            /*
             * We were called by webchan_call so just need to set causes.
             * The core will hangup the channel.
             */
            ast_channel_tech_hangupcause_set(instance->channel, AST_WEBSOCKET_STATUS_GOING_AWAY);
            ast_channel_hangupcause_set(instance->channel, AST_CAUSE_NETWORK_OUT_OF_ORDER);
        }
        return -1;
    }
 
    if (!instance->no_auto_answer) {
        ast_debug(3, "%s: ANSWER by auto_answer\n", ast_channel_name(instance->channel));
        ast_queue_control(instance->channel, AST_CONTROL_ANSWER);
    }
 
    return 0;
}
 
static void _websocket_request_hangup(struct websocket_pvt *instance, int ast_cause,
    enum ast_websocket_status_code tech_cause, int line, const char *function)
{
    if (!instance || !instance->channel) {
        return;
    }
    ast_debug(3, "%s:%s: Hangup requested from %s line %d.  cause: %s(%d)  tech_cause: %s(%d)",
        ast_channel_name(instance->channel), instance->remote_addr,
        function, line,
        ast_cause2str(ast_cause), ast_cause, ast_websocket_status_to_str(tech_cause), tech_cause);
 
    if (tech_cause) {
        ast_channel_tech_hangupcause_set(instance->channel, tech_cause);
    }
    ast_queue_hangup_with_cause(instance->channel, ast_cause);
}
 
/*! \brief Function called when we should write a frame to the channel */
static int webchan_write(struct ast_channel *ast, struct ast_frame *f)
{
    struct websocket_pvt *instance = ast_channel_tech_pvt(ast);
    int res = 0;
 
    if (!instance || !instance->websocket) {
        ast_log(LOG_WARNING, "%s: WebSocket instance or client not found\n",
            ast_channel_name(ast));
        return -1;
    }
 
    /* The app doesn't want media right now */
    if (instance->media_direction == WEBCHAN_MEDIA_DIRECTION_OUT) {
        return 0;
    }
 
    if (f->frametype == AST_FRAME_CNG) {
        return 0;
    }
 
    if (f->frametype != AST_FRAME_VOICE) {
        ast_log(LOG_WARNING, "%s: This WebSocket channel only supports AST_FRAME_VOICE frames\n",
            ast_channel_name(ast));
        return 0;
    }
 
    if (ast_format_cmp(f->subclass.format, instance->native_format) == AST_FORMAT_CMP_NOT_EQUAL) {
        ast_log(LOG_WARNING, "%s: This WebSocket channel only supports the '%s' format, not '%s'\n",
            ast_channel_name(ast), ast_format_get_name(instance->native_format),
            ast_format_get_name(f->subclass.format));
        return -1;
    }
 
    res = ast_websocket_write(instance->websocket, AST_WEBSOCKET_OPCODE_BINARY,
        (char *)f->data.ptr, (uint64_t)f->datalen);
    if (res != 0) {
        ast_log(LOG_WARNING, "%s: WebSocket write failure\n", ast_channel_name(ast));
    }
 
    return res;
}
 
/*!
 * \internal
 *
 * Called by the core to actually call the remote.
 * The core will hang up the channel if a non-zero  is returned.
 * We just need to set hangup causes if appropriate.
 */
static int webchan_call(struct ast_channel *ast, const char *dest,
    int timeout)
{
    struct websocket_pvt *instance = ast_channel_tech_pvt(ast);
    enum ast_websocket_result result;
    struct webchan_conf_global *global_cfg = ast_sorcery_retrieve_by_id(sorcery, "global", "global");
    int global_write_timeout = global_cfg ? global_cfg->write_timeout : AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT;
 
    ao2_cleanup(global_cfg);
 
    if (!instance) {
        ast_log(LOG_WARNING, "%s: WebSocket instance not found\n",
            ast_channel_name(ast));
        ast_channel_hangupcause_set(ast, AST_CAUSE_FAILURE);
        return -1;
    }
 
    if (instance->type == AST_WS_TYPE_SERVER) {
        ast_debug(3, "%s: Websocket call incoming\n", ast_channel_name(instance->channel));
        return 0;
    }
    ast_debug(3, "%s: Websocket call outgoing\n", ast_channel_name(instance->channel));
 
    if (!instance->client) {
        ast_log(LOG_WARNING, "%s: WebSocket client not found\n",
            ast_channel_name(ast));
        ast_channel_hangupcause_set(ast, AST_CAUSE_FAILURE);
        return -1;
    }
 
    ast_debug(3, "%s: WebSocket call requested to %s. cid: %s\n",
        ast_channel_name(ast), dest, instance->connection_id);
 
    if (!ast_strlen_zero(instance->uri_params)) {
        ast_websocket_client_add_uri_params(instance->client, instance->uri_params);
    }
 
    instance->websocket = ast_websocket_client_connect(instance->client,
        instance, ast_channel_name(ast), &result);
    if (!instance->websocket || result != WS_OK) {
        ast_log(LOG_WARNING, "%s: WebSocket connection failed to %s: %s\n",
            ast_channel_name(ast), dest, ast_websocket_result_to_str(result));
        ast_channel_hangupcause_set(ast, AST_CAUSE_NO_ROUTE_DESTINATION);
        return -1;
    }
 
    /*
     * If websocket_client->write_timeout was set in websocket_client.conf, it will
     * have been applied to the websocket by ast_websocket_client_connect() above.
     * If it wasn't set in websocket_client.conf, the value will be INT_MAX and
     * and ast_websocket_client_connect() will have set AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT
     * on the websocket.  However, the user may have set write_timeout in the global section
     * of chan_websocket.conf so if it wasn't set in websocket_client.conf, we'll now set
     * the websocket timeout to that.  If they  haven't set it in chan_websocket.conf either,
     * it'll default to AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT as well so the call below will
     * basically become a no-op.
     */
    if (instance->client->write_timeout == INT_MAX) {
        ast_websocket_set_timeout(instance->websocket, global_write_timeout);
    }
 
    return websocket_handoff_to_channel(instance);
}
 
static void websocket_destructor(void *data)
{
    struct websocket_pvt *instance = data;
    struct ast_frame *frame = NULL;
    ast_debug(3, "%s: WebSocket instance freed\n", instance->connection_id);
 
    AST_LIST_LOCK(&instance->frame_queue);
    while ((frame = AST_LIST_REMOVE_HEAD(&instance->frame_queue, frame_list))) {
        ast_frfree(frame);
    }
    AST_LIST_UNLOCK(&instance->frame_queue);
 
    if (instance->timer) {
        ast_timer_close(instance->timer);
        instance->timer = NULL;
    }
 
    if (instance->channel) {
        ast_channel_unref(instance->channel);
        instance->channel = NULL;
    }
    if (instance->websocket) {
        ast_websocket_unref(instance->websocket);
        instance->websocket = NULL;
    }
 
    ao2_cleanup(instance->client);
    instance->client = NULL;
 
    ao2_cleanup(instance->native_codec);
    instance->native_codec = NULL;
 
    ao2_cleanup(instance->native_format);
    instance->native_format = NULL;
 
    if (instance->leftover_data) {
        ast_free(instance->leftover_data);
        instance->leftover_data = NULL;
    }
 
    ast_free(instance->uri_params);
    ast_free(instance->remote_addr);
}
 
struct instance_proxy {
    AO2_WEAKPROXY();
    /*! \brief The name of the module owning this sorcery instance */
    char connection_id[0];
};
 
static void instance_proxy_cb(void *weakproxy, void *data)
{
    struct instance_proxy *proxy = weakproxy;
    ast_debug(3, "%s: WebSocket instance removed from instances\n", proxy->connection_id);
    ao2_unlink(instances, weakproxy);
}
 
static struct websocket_pvt* websocket_new(const char *chan_name,
    const char *connection_id, struct ast_format *fmt)
{
    RAII_VAR(struct instance_proxy *, proxy, NULL, ao2_cleanup);
    RAII_VAR(struct websocket_pvt *, instance, NULL, ao2_cleanup);
    char uuid[AST_UUID_STR_LEN];
    enum ast_websocket_type ws_type;
 
    SCOPED_AO2WRLOCK(locker, instances);
 
    if (ast_strings_equal(connection_id, INCOMING_CONNECTION_ID)) {
        connection_id = ast_uuid_generate_str(uuid, sizeof(uuid));
        ws_type = AST_WS_TYPE_SERVER;
    } else {
        ws_type = AST_WS_TYPE_CLIENT;
    }
 
    proxy = ao2_weakproxy_alloc(sizeof(*proxy) + strlen(connection_id) + 1, NULL);
    if (!proxy) {
        return NULL;
    }
    strcpy(proxy->connection_id, connection_id); /* Safe */
 
    instance = ao2_alloc(sizeof(*instance) + strlen(connection_id) + 1,
        websocket_destructor);
    if (!instance) {
        return NULL;
    }
    strcpy(instance->connection_id, connection_id); /* Safe */
 
    instance->type = ws_type;
    if (ws_type == AST_WS_TYPE_CLIENT) {
        instance->client = ast_websocket_client_retrieve_by_id(instance->connection_id);
        if (!instance->client) {
            ast_log(LOG_ERROR, "%s: WebSocket client connection '%s' not found\n",
                chan_name, instance->connection_id);
            return NULL;
        }
    }
 
    AST_LIST_HEAD_INIT(&instance->frame_queue);
 
    /*
     * We need the codec to calculate the number of samples in a frame
     * so we'll get it once and store it in the instance.
     *
     * References for native_format and native_codec are now held by the
     * instance and will be released when the instance is destroyed.
     */
    instance->native_format = fmt;
    instance->native_codec = ast_format_get_codec(instance->native_format);
    /*
     * References for native_format and native_codec are now held by the
     * instance and will be released when the instance is destroyed.
     */
 
    /*
     * It's not possible for us to re-time or re-frame media if the data
     * stream can't be broken up on arbitrary byte boundaries.  This is usually
     * indicated by the codec's minimum_bytes being small (10 bytes or less).
     * We need to force the passthrough and unbuffered modes in this case.
     */
    if (instance->native_codec->minimum_bytes <= 10) {
        instance->passthrough = 1;
        instance->unbuffered = 1;
        instance->optimal_frame_size = 0;
    } else {
        instance->optimal_frame_size =
            (instance->native_codec->default_ms * instance->native_codec->minimum_bytes)
                / instance->native_codec->minimum_ms;
        instance->leftover_data = ast_calloc(1, instance->optimal_frame_size);
        if (!instance->leftover_data) {
            return NULL;
        }
    }
 
    ast_debug(3,
        "%s: WebSocket channel native format '%s' Sample rate: %d ptime: %dms minms: %u  minbytes: %u passthrough: %d optimal_frame_size: %d\n",
        chan_name, ast_format_get_name(instance->native_format),
        ast_format_get_sample_rate(instance->native_format),
        ast_format_get_default_ms(instance->native_format),
        ast_format_get_minimum_ms(instance->native_format),
        ast_format_get_minimum_bytes(instance->native_format),
        instance->passthrough,
        instance->optimal_frame_size);
 
    /* We have exclusive access to proxy and sorcery, no need for locking here. */
    if (ao2_weakproxy_set_object(proxy, instance, OBJ_NOLOCK)) {
        return NULL;
    }
 
    if (ao2_weakproxy_subscribe(proxy, instance_proxy_cb, NULL, OBJ_NOLOCK)) {
        return NULL;
    }
 
    if (!ao2_link_flags(instances, proxy, OBJ_NOLOCK)) {
        ast_log(LOG_ERROR, "%s: Unable to link WebSocket instance to instances\n",
            proxy->connection_id);
        return NULL;
    }
    ast_debug(3, "%s: WebSocket instance created and linked\n", proxy->connection_id);
 
    return ao2_bump(instance);
}
 
static int set_channel_timer(struct websocket_pvt *instance)
{
    int rate = 0;
    instance->timer = ast_timer_open();
    if (!instance->timer) {
        return -1;
    }
    /* Rate is the number of ticks per second, not the interval. */
    rate = 1000 / ast_format_get_default_ms(instance->native_format);
    ast_debug(3, "%s: WebSocket timer rate %d\n",
        ast_channel_name(instance->channel), rate);
    ast_timer_set_rate(instance->timer, rate);
    /*
     * Calling ast_channel_set_fd will cause the channel thread to call
     * webchan_read at 'rate' times per second.
     */
    ast_channel_set_fd(instance->channel, WS_TIMER_FDNO, ast_timer_fd(instance->timer));
 
    return 0;
}
 
static int set_channel_variables(struct websocket_pvt *instance)
{
    char *pkt_size = NULL;
    int res = ast_asprintf(&pkt_size, "%d", instance->optimal_frame_size);
    if (res <= 0) {
        return -1;
    }
 
    pbx_builtin_setvar_helper(instance->channel, MEDIA_WEBSOCKET_OPTIMAL_FRAME_SIZE,
        pkt_size);
    ast_free(pkt_size);
    pbx_builtin_setvar_helper(instance->channel, MEDIA_WEBSOCKET_CONNECTION_ID,
        instance->connection_id);
 
    return 0;
}
 
static int validate_uri_parameters(const char *uri_params)
{
    char *params = ast_strdupa(uri_params);
    char *nvp = NULL;
    char *nv = NULL;
 
    /*
     * uri_params should be a comma-separated list of key=value pairs.
     * For example:
     * name1=value1,name2=value2
     * We're verifying that each name and value either doesn't need
     * to be encoded or that it already is.
     */
 
    while((nvp = ast_strsep(&params, ',', 0))) {
        /* nvp will be name1=value1 */
        while((nv = ast_strsep(&nvp, '=', 0))) {
            /* nv will be either name1 or value1 */
            if (!ast_uri_verify_encoded(nv)) {
                return 0;
            }
        }
    }
 
    return 1;
}
 
enum {
    OPT_WS_CODEC =  (1 << 0),
    OPT_WS_NO_AUTO_ANSWER =  (1 << 1),
    OPT_WS_URI_PARAM =  (1 << 2),
    OPT_WS_PASSTHROUGH =  (1 << 3),
    OPT_WS_MSG_FORMAT =  (1 << 4),
    OPT_WS_MEDIA_DIRECTION = (1 << 5),
    OPT_WS_UNBUFFERED = (1 << 6),
};
 
enum {
    OPT_ARG_WS_CODEC,
    OPT_ARG_WS_NO_AUTO_ANSWER,
    OPT_ARG_WS_URI_PARAM,
    OPT_ARG_WS_PASSTHROUGH,
    OPT_ARG_WS_MSG_FORMAT,
    OPT_ARG_WS_MEDIA_DIRECTION,
    OPT_ARG_WS_UNBUFFERED,
    OPT_ARG_ARRAY_SIZE
};
 
AST_APP_OPTIONS(websocket_options, BEGIN_OPTIONS
    AST_APP_OPTION_ARG('c', OPT_WS_CODEC, OPT_ARG_WS_CODEC),
    AST_APP_OPTION('n', OPT_WS_NO_AUTO_ANSWER),
    AST_APP_OPTION_ARG('v', OPT_WS_URI_PARAM, OPT_ARG_WS_URI_PARAM),
    AST_APP_OPTION('p', OPT_WS_PASSTHROUGH),
    AST_APP_OPTION_ARG('f', OPT_WS_MSG_FORMAT, OPT_ARG_WS_MSG_FORMAT),
    AST_APP_OPTION_ARG('d', OPT_WS_MEDIA_DIRECTION, OPT_ARG_WS_MEDIA_DIRECTION),
    AST_APP_OPTION('u', OPT_WS_UNBUFFERED),
    END_OPTIONS );
 
static struct ast_channel *webchan_request(const char *type,
    struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids,
    const struct ast_channel *requestor, const char *data, int *cause)
{
    char *parse;
    RAII_VAR(struct websocket_pvt *, instance, NULL, ao2_cleanup);
    struct ast_channel *chan = NULL;
    struct ast_format *fmt = NULL;
    struct ast_format_cap *caps = NULL;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(connection_id);
        AST_APP_ARG(options);
    );
    struct ast_flags opts = { 0, };
    char *opt_args[OPT_ARG_ARRAY_SIZE];
    const char *requestor_name = requestor ? ast_channel_name(requestor) :
        (assignedids && !ast_strlen_zero(assignedids->uniqueid) ? assignedids->uniqueid : "<unknown>");
    RAII_VAR(struct webchan_conf_global *, global_cfg, NULL, ao2_cleanup);
 
    global_cfg = ast_sorcery_retrieve_by_id(sorcery, "global", "global");
 
    ast_debug(3, "%s: WebSocket channel requested\n",
        requestor_name);
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_ERROR, "%s: A connection id is required for the 'WebSocket' channel\n",
            requestor_name);
        goto failure;
    }
    parse = ast_strdupa(data);
    AST_NONSTANDARD_APP_ARGS(args, parse, '/');
 
    if (ast_strlen_zero(args.connection_id)) {
        ast_log(LOG_ERROR, "%s: connection_id is required for the 'WebSocket' channel\n",
            requestor_name);
        goto failure;
    }
 
    if (!ast_strlen_zero(args.options)
        && ast_app_parse_options(websocket_options, &opts, opt_args,
            ast_strdupa(args.options))) {
        ast_log(LOG_ERROR, "%s: 'WebSocket' channel options '%s' parse error\n",
            requestor_name, args.options);
        goto failure;
    }
 
    if (ast_test_flag(&opts, OPT_WS_CODEC)
        && !ast_strlen_zero(opt_args[OPT_ARG_WS_CODEC])) {
        fmt = ast_format_cache_get(opt_args[OPT_ARG_WS_CODEC]);
    } else {
        /*
         * If codec wasn't specified in the dial string,
         * use the first format in the capabilities.
         */
        fmt = ast_format_cap_get_format(cap, 0);
    }
 
    if (!fmt) {
        ast_log(LOG_WARNING, "%s: No codec found for sending media to connection '%s'\n",
            requestor_name, args.connection_id);
        goto failure;
    }
 
    ast_debug(3, "%s: Using format %s from %s\n",
        requestor_name, ast_format_get_name(fmt),
        ast_test_flag(&opts, OPT_WS_CODEC) ? "dialstring" : "requester");
 
    instance = websocket_new(requestor_name, args.connection_id, fmt);
    if (!instance) {
        ast_log(LOG_ERROR, "%s: Failed to allocate WebSocket channel pvt\n",
            requestor_name);
        goto failure;
    }
 
    instance->media_direction = WEBCHAN_MEDIA_DIRECTION_BOTH;
    if (ast_test_flag(&opts, OPT_WS_MEDIA_DIRECTION)) {
        if (!strcmp("both", opt_args[OPT_ARG_WS_MEDIA_DIRECTION])) {
            /* The default. Don't need to do anything here other than
             * ensure it is an allowed value. */
        } else if (!strcmp("out", opt_args[OPT_ARG_WS_MEDIA_DIRECTION])) {
            instance->media_direction = WEBCHAN_MEDIA_DIRECTION_OUT;
        } else if (!strcmp("in", opt_args[OPT_ARG_WS_MEDIA_DIRECTION])) {
            instance->media_direction = WEBCHAN_MEDIA_DIRECTION_IN;
        } else {
            ast_log(LOG_ERROR, "Unrecognized option for media direction: '%s'.\n",
                opt_args[OPT_ARG_WS_MEDIA_DIRECTION]);
            goto failure;
        }
    }
 
    instance->no_auto_answer = ast_test_flag(&opts, OPT_WS_NO_AUTO_ANSWER);
 
    /*
     * Passthrough requires unbuffered.  If passthrough was forced by choice of
     * codec, unbuffered will already have been set.  If passthrough was set by
     * the dialstring option, we need to force unbuffered.
     */
    if (!instance->passthrough) {
        instance->passthrough = ast_test_flag(&opts, OPT_WS_PASSTHROUGH);
        instance->unbuffered = instance->passthrough;
    }
    /*
     * If unbuffered hasn't been forced by passthrough, set it according to the
     * dialstring "u" option.
     */
    if (!instance->unbuffered) {
        instance->unbuffered = ast_test_flag(&opts, OPT_WS_UNBUFFERED);
    }
 
    if (ast_test_flag(&opts, OPT_WS_URI_PARAM)
        && !ast_strlen_zero(opt_args[OPT_ARG_WS_URI_PARAM])) {
        char *comma;
 
        if (ast_strings_equal(args.connection_id, INCOMING_CONNECTION_ID)) {
            ast_log(LOG_ERROR,
                "%s: URI parameters are not allowed for 'WebSocket/INCOMING' channels\n",
                requestor_name);
            goto failure;
        }
 
        ast_debug(3, "%s: Using URI parameters '%s'\n",
            requestor_name, opt_args[OPT_ARG_WS_URI_PARAM]);
 
        if (!validate_uri_parameters(opt_args[OPT_ARG_WS_URI_PARAM])) {
            ast_log(LOG_ERROR, "%s: Invalid URI parameters '%s' in WebSocket/%s dial string\n",
                requestor_name, opt_args[OPT_ARG_WS_URI_PARAM],
                args.connection_id);
            goto failure;
        }
 
        instance->uri_params = ast_strdup(opt_args[OPT_ARG_WS_URI_PARAM]);
        comma = instance->uri_params;
        /*
         * The normal separator for query string components is an
         * ampersand ('&') but the Dial app interprets them as additional
         * channels to dial in parallel so we instruct users to separate
         * the parameters with commas (',') instead.  We now have to
         * convert those commas back to ampersands.
         */
        while ((comma = strchr(comma,','))) {
            *comma = '&';
        }
        ast_debug(3, "%s: Using final URI '%s'\n", requestor_name, instance->uri_params);
    }
 
    if (ast_test_flag(&opts, OPT_WS_MSG_FORMAT)) {
        instance->control_msg_format = control_msg_format_from_str(opt_args[OPT_ARG_WS_MSG_FORMAT]);
 
        if (instance->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_INVALID) {
            ast_log(LOG_WARNING, "%s: 'f/control message format' dialstring parameter value missing or invalid. "
                "Defaulting to 'plain-text'\n",
                requestor_name);
            instance->control_msg_format = WEBCHAN_CONTROL_MSG_FORMAT_PLAIN;
        }
    } else if (global_cfg) {
        instance->control_msg_format = global_cfg->control_msg_format;
    }
 
    chan = ast_channel_alloc(1, AST_STATE_DOWN, "", "", "", "", "", assignedids,
        requestor, 0, "WebSocket/%s/%p", args.connection_id, instance);
    if (!chan) {
        ast_log(LOG_ERROR, "%s: Unable to alloc channel\n", requestor_name);
        goto failure;
    }
 
    /* Prevent device state caching as this channel involves ephemeral destinations or sources */
    ast_set_flag(ast_channel_flags(chan), AST_FLAG_DISABLE_DEVSTATE_CACHE);
    ast_debug(3, "%s: WebSocket channel %s allocated for connection %s\n",
        ast_channel_name(chan), requestor_name,
        instance->connection_id);
 
    instance->channel = ao2_bump(chan);
    ast_channel_tech_set(instance->channel, &websocket_tech);
 
    /* If the application's media direction is 'both' or 'out', we need the channel timer. */
    if (instance->media_direction != WEBCHAN_MEDIA_DIRECTION_IN
        && set_channel_timer(instance) != 0) {
        goto failure;
    }
 
    if (set_channel_variables(instance) != 0) {
        goto failure;
    }
 
    caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
    if (!caps) {
        ast_log(LOG_ERROR, "%s: Unable to alloc caps\n", requestor_name);
        goto failure;
    }
 
    ast_format_cap_append(caps, instance->native_format, 0);
    ast_channel_nativeformats_set(instance->channel, caps);
    ast_channel_set_writeformat(instance->channel, instance->native_format);
    ast_channel_set_rawwriteformat(instance->channel, instance->native_format);
    ast_channel_set_readformat(instance->channel, instance->native_format);
    ast_channel_set_rawreadformat(instance->channel, instance->native_format);
    ast_channel_tech_pvt_set(chan, ao2_bump(instance));
    ast_channel_unlock(chan);
    ao2_cleanup(caps);
 
    ast_debug(3, "%s: WebSocket channel created to %s\n",
        ast_channel_name(chan), args.connection_id);
 
    return chan;
 
failure:
    if (chan) {
        ast_channel_unlock(chan);
    }
    *cause = AST_CAUSE_FAILURE;
    return NULL;
}
 
/*!
 * \internal
 *
 * Called by the core to hang up the channel.
 */
static int webchan_hangup(struct ast_channel *ast)
{
    struct websocket_pvt *instance = ast_channel_tech_pvt(ast);
 
    if (!instance) {
        return -1;
    }
    ast_debug(3, "%s: WebSocket call hangup. cid: %s\n",
        ast_channel_name(ast), instance->connection_id);
 
    if (instance->websocket) {
        ast_websocket_close(instance->websocket, ast_channel_tech_hangupcause(ast) ?: 1000);
        ast_websocket_unref(instance->websocket);
        instance->websocket = NULL;
    }
    ast_channel_tech_pvt_set(ast, NULL);
 
    /* Clean up the reference from adding the instance to the channel */
    ao2_cleanup(instance);
 
    return 0;
}
 
static int webchan_send_dtmf_text(struct ast_channel *ast, char digit, unsigned int duration)
{
    struct websocket_pvt *instance = ast_channel_tech_pvt(ast);
 
    if (!instance) {
        return -1;
    }
 
    return send_event(instance, DTMF_END, digit);
}
 
/*!
 * \internal
 *
 * Called by res_http_websocket after a client has connected and
 * successfully upgraded from HTTP to WebSocket.
 *
 * Depends on incoming_ws_http_callback parsing the connection_id from
 * the HTTP request and storing it in get_params.
 */
static void incoming_ws_established_cb(struct ast_websocket *ast_ws_session,
    struct ast_variable *get_params, struct ast_variable *upgrade_headers)
{
    RAII_VAR(struct ast_websocket *, s, ast_ws_session, ast_websocket_unref);
    struct ast_variable *v;
    const char *connection_id = NULL;
    struct websocket_pvt *instance = NULL;
    struct webchan_conf_global *global_cfg = ast_sorcery_retrieve_by_id(sorcery, "global", "global");
    int global_write_timeout = global_cfg ? global_cfg->write_timeout : AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT;
 
    ao2_cleanup(global_cfg);
 
    ast_debug(3, "WebSocket established\n");
 
    for (v = upgrade_headers; v; v = v->next) {
        ast_debug(4, "Header-> %s: %s\n", v->name, v->value);
    }
    for (v = get_params; v; v = v->next) {
        ast_debug(4, " Param-> %s: %s\n", v->name, v->value);
    }
 
    connection_id = ast_variable_find_in_list(get_params, "CONNECTION_ID");
    if (!connection_id) {
        /*
         * This can't really happen because websocket_http_callback won't
         * let it get this far if it can't add the connection_id to the
         * get_params.
         * Just in case though...
         */
        ast_log(LOG_WARNING, "WebSocket connection id not found\n");
        websocket_request_hangup(instance, AST_CAUSE_FAILURE, AST_WEBSOCKET_STATUS_INTERNAL_ERROR);
        ast_websocket_close(ast_ws_session, AST_WEBSOCKET_STATUS_INTERNAL_ERROR);
        return;
    }
 
    instance = ao2_weakproxy_find(instances, connection_id, OBJ_SEARCH_KEY | OBJ_NOLOCK, "");
    if (!instance) {
        /*
         * This also can't really happen because websocket_http_callback won't
         * let it get this far if it can't find the instance.
         * Just in case though...
         */
        ast_log(LOG_WARNING, "%s: WebSocket instance not found\n", connection_id);
        websocket_request_hangup(instance, AST_CAUSE_FAILURE, AST_WEBSOCKET_STATUS_INTERNAL_ERROR);
        ast_websocket_close(ast_ws_session, AST_WEBSOCKET_STATUS_INTERNAL_ERROR);
        return;
    }
    instance->websocket = ao2_bump(ast_ws_session);
 
    ast_websocket_set_timeout(instance->websocket, global_write_timeout);
 
    websocket_handoff_to_channel(instance);
    ao2_cleanup(instance);
    /*
     * The instance is the channel's responsibility now.
     * We just return here.
     */
}
 
/*!
 * \internal
 *
 * Called by the core http server after a client connects but before
 * the upgrade from HTTP to Websocket.  We need to save the URI in
 * the CONNECTION_ID in a get_param because it contains the connection UUID
 * we gave to the client when they used externalMedia to create the channel.
 * incoming_ws_established_cb() will use this to retrieve the chan_websocket
 * instance.
 */
static int incoming_ws_http_callback(struct ast_tcptls_session_instance *ser,
    const struct ast_http_uri *urih, const char *uri,
    enum ast_http_method method, struct ast_variable *get_params,
    struct ast_variable *headers)
{
    struct ast_http_uri fake_urih = {
        .data = ast_ws_server,
    };
    int res = 0;
    /*
     * Normally the http server will destroy the get_params
     * when the session ends but if there weren't any initially
     * and we create some and add them to the list, the http server
     * won't know about it so we have to destroy it ourselves.
     */
    int destroy_get_params = (get_params == NULL);
    struct ast_variable *v = NULL;
    RAII_VAR(struct websocket_pvt *, instance, NULL, ao2_cleanup);
 
    ast_debug(2, "URI: %s Starting\n", uri);
 
    /*
     * The client will have issued the GET request with a URI of
     * /media/<connection_id>
     *
     * Since this callback is registered for the /media URI prefix the
     * http server will strip that off the front of the URI passing in
     * only the path components after that in the 'uri' parameter.
     * This should leave only the connection id without a leading '/'.
     */
    instance = ao2_weakproxy_find(instances, uri, OBJ_SEARCH_KEY | OBJ_NOLOCK, "");
    if (!instance) {
        ast_log(LOG_WARNING, "%s: WebSocket instance not found\n", uri);
        ast_http_error(ser, 404, "Not found", "WebSocket instance not found");
        return -1;
    }
 
    /*
     * We don't allow additional connections using the same connection id.
     */
    if (instance->websocket) {
        ast_log(LOG_WARNING, "%s: Websocket already connected for channel '%s'\n",
            uri, instance->channel ? ast_channel_name(instance->channel) : "unknown");
        ast_http_error(ser, 409, "Conflict", "Another websocket connection exists for this connection id");
        return -1;
    }
 
    v = ast_variable_new("CONNECTION_ID", uri, "");
    if (!v) {
        ast_http_error(ser, 500, "Server error", "");
        return -1;
    }
    ast_variable_list_append(&get_params, v);
 
    for (v = get_params; v; v = v->next) {
        ast_debug(4, " Param-> %s: %s\n", v->name, v->value);
    }
 
    /*
     * This will ultimately call internal_ws_established_cb() so
     * this function will block until the websocket is closed and
     * internal_ws_established_cb() returns;
     */
    res = ast_websocket_uri_cb(ser, &fake_urih, uri, method,
        get_params, headers);
    if (destroy_get_params) {
        ast_variables_destroy(get_params);
    }
 
    ast_debug(2, "URI: %s DONE\n", uri);
 
    return res;
}
 
static struct ast_http_uri http_uri = {
    .callback = incoming_ws_http_callback,
    .description = "Media over Websocket",
    .uri = "media",
    .has_subtree = 1,
    .data = NULL,
    .key = __FILE__,
    .no_decode_uri = 1,
};
 
AO2_STRING_FIELD_HASH_FN(instance_proxy, connection_id)
AO2_STRING_FIELD_CMP_FN(instance_proxy, connection_id)
AO2_STRING_FIELD_SORT_FN(instance_proxy, connection_id)
 
static int global_control_message_format_from_str(const struct aco_option *opt,
    struct ast_variable *var, void *obj)
{
    struct webchan_conf_global *cfg = obj;
 
    cfg->control_msg_format = control_msg_format_from_str(var->value);
 
    if (cfg->control_msg_format == WEBCHAN_CONTROL_MSG_FORMAT_INVALID) {
        ast_log(LOG_ERROR, "chan_websocket.conf: Invalid value '%s' for "
            "control_mesage_format. Must be 'plain-text' or 'json'\n",
            var->value);
        return -1;
    }
 
    return 0;
}
 
static int global_control_message_format_to_str(const void *obj, const intptr_t *args, char **buf)
{
    const struct webchan_conf_global *cfg = obj;
 
    *buf = ast_strdup(control_msg_format_to_str(cfg->control_msg_format));
 
    return 0;
}
 
static void *global_alloc(const char *name)
{
    struct webchan_conf_global *cfg = ast_sorcery_generic_alloc(
        sizeof(*cfg), NULL);
 
    if (!cfg) {
        return NULL;
    }
 
    return cfg;
}
 
static int global_apply(const struct ast_sorcery *sorcery, void *obj)
{
    struct webchan_conf_global *cfg = obj;
 
    ast_debug(1, "control_msg_format: %s\n",
        control_msg_format_to_str(cfg->control_msg_format));
 
    if (cfg->write_timeout <= 0) {
        ast_log(LOG_WARNING, "The write_timeout parameter must be > 0\n");
        return -1;
    }
 
    return 0;
}
 
static int load_config(void)
{
    ast_debug(2, "Initializing Websocket Client Configuration\n");
    sorcery = ast_sorcery_open();
    if (!sorcery) {
        ast_log(LOG_ERROR, "Failed to open sorcery\n");
        return -1;
    }
 
    ast_sorcery_apply_default(sorcery, "global", "config",
        "chan_websocket.conf,criteria=type=global,single_object=yes,explicit_name=global");
 
    if (ast_sorcery_object_register(sorcery, "global", global_alloc, NULL, global_apply)) {
        ast_log(LOG_ERROR, "Failed to register chan_websocket global object with sorcery\n");
        ast_sorcery_unref(sorcery);
        sorcery = NULL;
        return -1;
    }
 
    ast_sorcery_object_field_register_nodoc(sorcery, "global", "type", "", OPT_NOOP_T, 0, 0);
    ast_sorcery_register_cust(global, control_message_format, "plain-text");
    ast_sorcery_register_int(global, webchan_conf_global, write_timeout, write_timeout,
        AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT);
 
    ast_sorcery_load(sorcery);
 
    return 0;
}
 
/*! \brief Function called when our module is unloaded */
static int unload_module(void)
{
    ast_http_uri_unlink(&http_uri);
    ao2_cleanup(ast_ws_server);
    ast_ws_server = NULL;
 
    ast_channel_unregister(&websocket_tech);
    ao2_cleanup(websocket_tech.capabilities);
    websocket_tech.capabilities = NULL;
 
    ao2_cleanup(instances);
    instances = NULL;
 
    ast_sorcery_unref(sorcery);
    sorcery = NULL;
 
    return 0;
}
 
static int reload_module(void)
{
    ast_debug(2, "Reloading chan_websocket configuration\n");
    ast_sorcery_reload(sorcery);
 
    return 0;
}
 
/*! \brief Function called when our module is loaded */
static int load_module(void)
{
    int res = 0;
    struct ast_websocket_protocol *protocol;
 
    res = load_config();
    if (res != 0) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (!(websocket_tech.capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_format_cap_append_by_type(websocket_tech.capabilities, AST_MEDIA_TYPE_UNKNOWN);
    if (ast_channel_register(&websocket_tech)) {
        ast_log(LOG_ERROR, "Unable to register channel class 'WebSocket'\n");
        unload_module();
        return AST_MODULE_LOAD_DECLINE;
    }
 
    instances = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_RWLOCK,
        AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, 17, instance_proxy_hash_fn,
        instance_proxy_sort_fn, instance_proxy_cmp_fn);
    if (!instances) {
        ast_log(LOG_WARNING,
            "Failed to allocate the chan_websocket instance registry\n");
        unload_module();
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_ws_server = ast_websocket_server_create();
    if (!ast_ws_server) {
        unload_module();
        return AST_MODULE_LOAD_DECLINE;
    }
 
    protocol = ast_websocket_sub_protocol_alloc("media");
    if (!protocol) {
        unload_module();
        return AST_MODULE_LOAD_DECLINE;
    }
    protocol->session_established = incoming_ws_established_cb;
    res = ast_websocket_server_add_protocol2(ast_ws_server, protocol);
 
    ast_http_uri_link(&http_uri);
 
    return res == 0 ? AST_MODULE_LOAD_SUCCESS : AST_MODULE_LOAD_DECLINE;
}
 
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Websocket Media Channel",
    .support_level = AST_MODULE_SUPPORT_CORE,
    .load = load_module,
    .unload = unload_module,
    .reload = reload_module,
    .load_pri = AST_MODPRI_CHANNEL_DRIVER,
    .requires = "res_http_websocket,res_websocket_client",
);