modules/server/output.c File Reference

#include "server.h"

Go to the source code of this file.

Functions
static void	queue_server (int priority, char *text, int len)
static void	do_output (const char *text, int len)
int	printserv (int priority, const char *format,...)
queue_entry_t *	queue_new (char *text)
void	queue_append (queue_t *queue, queue_entry_t *q)
void	queue_unlink (queue_t *queue, queue_entry_t *q)
void	queue_entry_from_text (queue_entry_t *q, char *text)
void	queue_entry_cleanup (queue_entry_t *q)
void	queue_entry_to_text (queue_entry_t *q, char *text, int *remaining)
queue_t *	queue_get_by_priority (int priority)
void	dequeue_messages ()
Variables
static const char	rcsid [] = "$Id: output.c,v 1.13 2004-06-07 23:14:48 stdarg Exp $"
char *	global_output_string = NULL
static queue_t	output_queues [6] = {{0}, {0}, {0}, {0}, {0}, {0}}
static queue_t	unused_queue = {0}

---

Function Documentation

void dequeue_messages

(

)

Definition at line 213 of file output.c.

References do_output(), NULL, queue_append, queue_entry_cleanup, queue_entry_to_text, queue_t::queue_head, and queue_unlink.

{
  queue_entry_t *q;
  queue_t *queue = NULL;
  int i, remaining, len;
  char *text, buf[1024];

  /* Choose which queue to select from. */
  for (i = 0; i < 3; i++) {
    if (output_queues[i+3].queue_head) {
      queue = output_queues+i+3;
      break;
    }
    if (output_queues[i].queue_head) {
      queue = output_queues+i;
      break;
    }
  }

  /* No messages to dequeue? */
  if (!queue) return;

  q = queue->queue_head;

  /* Remove it from the queue. */
  queue_unlink(queue, q);

  /* Construct an irc message out of it. */
  text = buf;
  remaining = sizeof(buf);
  queue_entry_to_text(q, text, &remaining);

  /* Now we're done with q, so free anything we need to free and store it
   * in the unused queue. */
  queue_entry_cleanup(q);
  queue_append(&unused_queue, q);

  /* Make sure last 2 chars are \r\n and there's a space left for \0. */
  if (remaining < 3) remaining = 3;
  len = sizeof(buf) - remaining;
  buf[len++] = '\r';
  buf[len++] = '\n';
  buf[len] = 0;

  do_output(buf, len);
}

static void do_output	(	const char *	text,
		int	len
	)			[static]

Definition at line 36 of file output.c.

References bind_check(), BIND_RET_BREAK, BT_server_output, current_server, global_output_string, NULL, and sockbuf_write().

Referenced by dequeue_messages(), and printserv().

{
  int r;

  if (global_output_string) {
    free(global_output_string);
    global_output_string = NULL;
  }
  r = bind_check(BT_server_output, NULL, text, text);
  if (r & BIND_RET_BREAK) return;

  if (global_output_string) {
    len = strlen(global_output_string);
    if (len > 0) sockbuf_write(current_server.idx, global_output_string, len);
  }
  else sockbuf_write(current_server.idx, text, len);
}

int printserv	(	int	priority,
		const char *	format,
			...
	)

Definition at line 55 of file output.c.

References do_output(), egg_mvsprintf(), queue_server(), server_config, SERVER_NEXT, and SERVER_NOQUEUE.

{
  char buf[1024], *ptr;
  int len;
  va_list args;

  va_start(args, format);
  ptr = egg_mvsprintf(buf, sizeof(buf), &len, format, args);
  va_end(args);

  if (server_config.max_line_len != -1 && len > server_config.max_line_len) len = server_config.max_line_len;

  if (len < 2 || ptr[len-1] != '\n') {
    ptr[len++] = '\r';
    ptr[len++] = '\n';
  }
  ptr[len] = 0;

  if ((priority & (~SERVER_NEXT)) == SERVER_NOQUEUE) {
    do_output(ptr, len);
  }
  else {
    queue_server(priority, ptr, len);
  }

  if (ptr != buf) free(ptr);
  return(len);
}

void queue_append	(	queue_t *	queue,
		queue_entry_t *	q
	)

Definition at line 103 of file output.c.

References queue_t::len, queue_entry::next, NULL, queue_entry::prev, queue_t::queue_head, and queue_t::queue_tail.

{
  q->next = NULL;
  q->prev = queue->queue_tail;
  if (queue->queue_tail) queue->queue_tail->next = q;
  else queue->queue_head = q;
  queue->queue_tail = q;

  queue->len++;
}

void queue_entry_cleanup

(

queue_entry_t *

q

)

Definition at line 142 of file output.c.

References irc_msg::args, irc_msg::cmd, queue_entry::msg, irc_msg::nargs, and irc_msg::prefix.

{
  irc_msg_t *msg;
  int i;

  msg = &q->msg;
  if (msg->prefix) free(msg->prefix);
  if (msg->cmd) free(msg->cmd);

  for (i = 0; i < msg->nargs; i++) {
    free(msg->args[i]);
  }
  memset(msg, 0, sizeof(*msg));
}

void queue_entry_from_text	(	queue_entry_t *	q,
		char *	text
	)

Definition at line 125 of file output.c.

References irc_msg::args, irc_msg::cmd, irc_msg_parse(), queue_entry::msg, irc_msg::nargs, and irc_msg::prefix.

{
  irc_msg_t *msg;
  int i;

  /* Parse the irc message. */
  msg = &q->msg;
  irc_msg_parse(text, msg);

  /* Copy each item ('text' param belongs to caller). */
  if (msg->prefix) msg->prefix = strdup(msg->prefix);
  if (msg->cmd) msg->cmd = strdup(msg->cmd);
  for (i = 0; i < msg->nargs; i++) {
    msg->args[i] = strdup(msg->args[i]);
  }
}

void queue_entry_to_text	(	queue_entry_t *	q,
		char *	text,
		int *	remaining
	)

Definition at line 157 of file output.c.

References irc_msg::args, irc_msg::cmd, egg_append_static_str(), queue_entry::msg, irc_msg::nargs, and irc_msg::prefix.

{
  irc_msg_t *msg;
  int i;

  msg = &q->msg;
  if (msg->prefix) {
    egg_append_static_str(&text, remaining, msg->prefix);
    egg_append_static_str(&text, remaining, " ");
  }
  if (msg->cmd) {
    egg_append_static_str(&text, remaining, msg->cmd);
  }

  /* Add the args (except for last one). */
  msg->nargs--;
  for (i = 0; i < msg->nargs; i++) {
    egg_append_static_str(&text, remaining, " ");
    egg_append_static_str(&text, remaining, msg->args[i]);
  }
  msg->nargs++;

  /* If the last arg has a space in it, put a : before it. */
  if (i < msg->nargs) {
    if (strchr(msg->args[i], ' ')) egg_append_static_str(&text, remaining, " :");
    else egg_append_static_str(&text, remaining, " ");
    egg_append_static_str(&text, remaining, msg->args[i]);
  }
}

queue_t* queue_get_by_priority

(

int

priority

)

Definition at line 187 of file output.c.

References SERVER_NEXT, SERVER_QUICK, and SERVER_SLOW.

{
  int qnum;

  qnum = priority & (~SERVER_NEXT);
  if (qnum < SERVER_QUICK || qnum > SERVER_SLOW) qnum = SERVER_SLOW;
  qnum -= SERVER_QUICK;
  if (priority & SERVER_NEXT) qnum += 3;

  return output_queues+qnum;
}

queue_entry_t* queue_new

(

char *

text

)

Definition at line 84 of file output.c.

References queue_entry_from_text, queue_t::queue_head, and queue_unlink.

{
  queue_entry_t *q;

  /* Either get one from the unused_queue, or allocate a new one. */
  if (unused_queue.queue_head) {
    q = unused_queue.queue_head;
    queue_unlink(&unused_queue, q);
  }
  else {
    q = calloc(1, sizeof(*q));
  }

  /* Parse the text into the queue entry. */
  queue_entry_from_text(q, text);

  return(q);
}

static void queue_server	(	int	priority,
		char *	text,
		int	len
	)			[static]

Definition at line 199 of file output.c.

References queue_entry::id, queue_t::next_id, queue_append, queue_get_by_priority, and queue_new.

Referenced by printserv().

{
  queue_t *queue;
  queue_entry_t *q;

  queue = queue_get_by_priority(priority);

  q = queue_new(text);

  /* Ok, put it in the queue. */
  q->id = queue->next_id++;
  queue_append(queue, q);
}

void queue_unlink	(	queue_t *	queue,
		queue_entry_t *	q
	)

Definition at line 114 of file output.c.

References queue_t::len, queue_entry::next, queue_entry::prev, queue_t::queue_head, and queue_t::queue_tail.

{
  if (q->next) q->next->prev = q->prev;
  else queue->queue_tail = q->prev;

  if (q->prev) q->prev->next = q->next;
  else queue->queue_head = q->next;

  queue->len--;
}

---

Variable Documentation

char* global_output_string = NULL

Definition at line 26 of file output.c.

queue_t output_queues[6] = {{0}, {0}, {0}, {0}, {0}, {0}} [static]

Definition at line 29 of file output.c.

const char rcsid[] = "$Id: output.c,v 1.13 2004-06-07 23:14:48 stdarg Exp $" [static]

Definition at line 21 of file output.c.

queue_t unused_queue = {0} [static]

Definition at line 32 of file output.c.