source: roaraudio/roard/clients.c @ 5804:8321b4018c95

//clients.c:

/*
 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012
 *
 *  This file is part of roard a part of RoarAudio,
 *  a cross-platform sound system for both, home and professional use.
 *  See README for details.
 *
 *  This file is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 3
 *  as published by the Free Software Foundation.
 *
 *  RoarAudio is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this software; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 *
 */

/* ckport options:
 * ckport: ignore-symbol: roar_event_to_blob of target libroar0
 */

#include "roard.h"

// declared 'extern'
struct roar_client_server * g_clients[ROAR_CLIENTS_MAX];

static struct roard_proto_handle __protos[MAX_PROTOS] = {
 {.proto = ROAR_PROTO_ROARAUDIO, .lhandle = NULL, .type = ROARD_PROTO_TYPE_BUILDIN,
 .impl = {.buildin = 0}},
 {.proto = -1}
};

#define _CHECK_CID_RET(id,ret) if ( (id) < 0 || (id) > ROAR_CLIENTS_MAX || g_clients[(id)] == NULL ) return (ret)
#define _CHECK_CID(id)         _CHECK_CID_RET((id), -1)

int clients_init (void) {
 int i;

 for (i = 0; i < ROAR_CLIENTS_MAX; i++)
  g_clients[i] = NULL;

 for (i = 0; __protos[i].proto != -1; i++);

 for (; i < MAX_PROTOS; i++)
  __protos[i].proto = -1;

 return 0;
}

int clients_free (void) {
 int i;

 for (i = 0; i < ROAR_CLIENTS_MAX; i++)
  if ( g_clients[i] != NULL )
   clients_delete(i);

 return 0;
}

int clients_new (void) {
 int i;
 int s;
 struct roar_client_server * ns;
 struct roar_client * n;

 for (i = 0; i < ROAR_CLIENTS_MAX; i++) {
  if ( g_clients[i] == NULL ) {
   ns = roar_mm_malloc(sizeof(struct roar_client_server));
   n = ROAR_CLIENT(ns);

   memset(ns, 0, sizeof(struct roar_client_server));

   if ( n != NULL ) {
    n->pid    = -1;
    n->uid    = -1;
    n->gid    = -1;
    n->fh     = -1;

    *n->name = 0;

    n->proto     = ROAR_PROTO_ROARAUDIO;
    n->byteorder = ROAR_BYTEORDER_NETWORK;

    n->acl   = NULL;

    n->execed = -1;
    for (s = 0; s < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; s++)
     n->streams[s] = -1;

    if ( roar_nnode_new(&(n->nnode), ROAR_SOCKET_TYPE_UNKNOWN) == -1 ) {
     roar_mm_free(n);
     return -1;
    }

    ns->blockc   = 0;
    ns->waits    = NULL;
    ns->acclev   = ACCLEV_NONE;

    g_clients[i] = ns;

    counters_inc(clients, 1);
    roar_notify_core_emit_snoargs(ROAR_OE_BASICS_NEW, -1, i, ROAR_OT_CLIENT);
    ROAR_DBG("clients_new(void) = %i", i);
    return i;
   } else {
    ROAR_ERR("clients_new(void): Can not alloc memory for new client: %s", strerror(errno));
    ROAR_ERR("clients_new(void) = -1");
    return -1;
   }
  }
 }

 return -1;
}

int clients_new_from_fh(int fh, int proto, int byteorder, int update_nnode) {
 return clients_new_from_fh2(fh, proto, byteorder, update_nnode, NULL, NULL, 0);
}

int clients_new_from_fh2(int fh, int proto, int byteorder,
                         int update_nnode,
                         struct roard_listen * lsock, struct sockaddr * sockaddr, socklen_t addrlen) {
 const struct roard_proto_handle * protohandle;
 struct roar_dl_librarypara * pluginpara;
 struct roar_vio_calls    vio;
 struct roar_client_server * cs;
 int supported = 0;
 int client;

 if ( fh == -1 ) {
  roar_err_set(ROAR_ERROR_BADFH);
  return -1;
 }

 if ( lsock == NULL ) {
  switch (proto) {
   case ROAR_PROTO_RSOUND:
   case ROAR_PROTO_SIMPLE:
     roar_err_set(ROAR_ERROR_FAULT);
     return -1;
    break;
  }
 }

 if ( byteorder != ROAR_BYTEORDER_NETWORK )
  return -1;


 if ( proto == ROAR_PROTO_RSOUND ) {
#ifndef ROAR_WITHOUT_DCOMP_EMUL_RSOUND
  client = emul_rsound_on_connect(fh, lsock);
  switch (client) {
   case -1: return -1; break;
   case -2: return  0; break;
   default: // TODO: write error handling
     fh = ROAR_CLIENT(cs)->fh;
    break;
  }
#else
  roar_err_set(ROAR_ERROR_PROTONOSUP);
  return -1;
#endif
 } else {
  client = clients_new();

  if ( client == -1 ) {
   ROAR_DBG("clients_new_from_fh2(*) = -1 // can not create new client");
   return -1;
  }

  if ( clients_set_fh(client, fh) == -1 ) {
   ROAR_ERR("clients_new_from_fh2(*): Can not set client's fh");

   clients_delete(client);

   ROAR_DBG("clients_new_from_fh2(*) = -1");
   return -1;
  }
 }

 if ( clients_get_server(client, &cs) == -1 ) {
  clients_delete(client);
  return -1;
 }

 if ( update_nnode ) {
  if ( roar_nnode_free(&(ROAR_CLIENT(cs)->nnode)) != -1 ) {
   if ( sockaddr != NULL && addrlen != 0 ) {
    roar_nnode_new_from_sockaddr(&(ROAR_CLIENT(cs)->nnode), sockaddr, addrlen);
   } else {
    roar_nnode_new_from_fh(&(ROAR_CLIENT(cs)->nnode), fh, 1);
   }
  }
 }

 if ( clients_set_proto(client, proto) == -1 ) {
  ROAR_WARN("clients_new_from_fh2(*): Setting proto(0x%.4x) of client %i failed.", proto, client);
  clients_delete(client);
  return -1;
 }

 switch (proto) {
  case ROAR_PROTO_ROARAUDIO:
    // nothing needed to be done here
   break;
#ifndef ROAR_WITHOUT_DCOMP_EMUL_SIMPLE
  case ROAR_PROTO_SIMPLE:
    if ( emul_simple_on_connect(client, lsock) == -1 )
     return -1;
   break;
#endif
#ifndef ROAR_WITHOUT_DCOMP_EMUL_RSOUND
  case ROAR_PROTO_RSOUND: // nothing to do here.
   break;
#endif
  default:
    // OS independiend code to close the socket:
    if ( roar_vio_open_fh_socket(&vio, fh) == -1 )
     return -1;

    protohandle = clients_get_protohandle(proto);
    supported = 0;
    if ( protohandle != NULL ) {
     if ( protohandle->lhandle != NULL )
      roar_dl_context_restore(protohandle->lhandle);
     switch (protohandle->type) {
      case ROARD_PROTO_TYPE_BUILDIN:
        //this should not end up here.
        ROAR_WARN("net_get_new_client(lsock=%p): proto(%i) marked as buildin but isn't. BAD.", lsock, proto);
        supported = 0;
       break;
      case ROARD_PROTO_TYPE_COMMON:
        supported = 1;
        if ( protohandle->impl.common->set_proto != NULL ) {
         pluginpara = roar_dl_getpara(protohandle->lhandle); // will return NULL in case protohandle->lhandle is NULL.
         if ( protohandle->impl.common->set_proto(client, &vio, &(cs->outbuf), &(cs->protoinst), protohandle->para, protohandle->paralen, pluginpara) == -1 ) {
          supported = 0;
         }
         if ( pluginpara != NULL )
          roar_dl_para_unref(pluginpara);
        }
       break;
     }
     if ( protohandle->lhandle != NULL )
      roar_dl_context_store(protohandle->lhandle);
    }

    if ( !supported ) {
     clients_delete(client);
     //roar_vio_close(&vio);
     return -1;
    }
   break;
 }


 return 0;
}

int clients_delete (int id) {
 struct roar_client_server * cs;
 const struct roard_proto_handle * proto;
 struct roar_dl_librarypara * pluginpara;
 struct roar_vio_calls vio;
 int i;
 int close_client_fh = 1;

 ROAR_DBG("clients_delete(id=%i) = ?", id);

 _CHECK_CID(id);

 cs = g_clients[id];

 proto = clients_get_protohandle(ROAR_CLIENT(cs)->proto);
 if ( proto != NULL ) {
  if ( proto->lhandle != NULL )
   roar_dl_context_restore(proto->lhandle);
  switch (proto->type) {
   case ROARD_PROTO_TYPE_BUILDIN:
     /* noop */
    break;
   case ROARD_PROTO_TYPE_COMMON:
     if ( proto->impl.common->unset_proto != NULL ) {
      roar_vio_open_fh_socket(&vio, clients_get_fh(id));
      pluginpara = roar_dl_getpara(proto->lhandle); // will return NULL in case protohandle->lhandle is NULL.
      proto->impl.common->unset_proto(id, &vio, &(cs->outbuf), &(cs->protoinst), proto->para, proto->paralen, pluginpara);
      if ( pluginpara != NULL )
       roar_dl_para_unref(pluginpara);
     }
    break;
  }
  if ( proto->lhandle != NULL )
   roar_dl_context_store(proto->lhandle);
 }

 if ( cs->waits != NULL ) {
  for (i = 0; cs->waits[i] != NULL; i++)
   roar_notify_core_unsubscribe(NULL, cs->waits[i]);

  roar_mm_free(cs->waits);
  cs->waits = NULL;
 }

 roar_notify_core_emit_snoargs(ROAR_OE_BASICS_DELETE, -1, id, ROAR_OT_CLIENT);

 counters_inc(clients, -1);

 if (ROAR_CLIENT(cs)->execed != -1) {
//  return streams_delete(g_clients[id]->execed);
  ROAR_CLIENT(cs)->execed = -1;
  close_client_fh = 0;
 }

 for (i = 0; i < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; i++) {
  streams_delete(ROAR_CLIENT(cs)->streams[i]);
 }

 if ( ROAR_CLIENT(cs)->fh != -1 && close_client_fh )
  close(ROAR_CLIENT(cs)->fh);

 roar_nnode_free(&(ROAR_CLIENT(cs)->nnode));

 if ( cs->inbuf != NULL )
  roar_buffer_free(cs->inbuf);

 if ( cs->outbuf != NULL )
  roar_buffer_free(cs->outbuf);

 if ( cs->protoinst != NULL )
  roar_mm_free(cs->protoinst);

 roar_mm_free(cs);
 g_clients[id] = NULL;

 ROAR_DBG("clients_delete(id=%i) = 0", id);
 return 0;
}

int clients_close      (int id, int nocheck_exec) {
 struct roar_client * c;

 ROAR_DBG("clients_close(id=%i) = ?", id);

 _CHECK_CID(id);

 c = ROAR_CLIENT(g_clients[id]);

 if ( c->fh == -1 ) {
  ROAR_DBG("clients_delete(id=%i) = 0", id);
  return 0;
 }

 if (nocheck_exec || c->execed != -1) {
  close(c->fh);
  c->fh = -1;
 }

 ROAR_DBG("clients_delete(id=%i) = 0", id);
 return 0;
}

int clients_get       (int id, struct roar_client ** client) {
 _CHECK_CID(id);

 *client = ROAR_CLIENT(g_clients[id]);

 if ( *client == NULL )
  return -1;

 return 0;
}

int clients_get_server (int id, struct roar_client_server ** client) {
 _CHECK_CID(id);

 *client = g_clients[id];

 if ( *client == NULL )
  return -1;

 return 0;
}

int clients_set_fh    (int id, int    fh) {
 struct roar_client * c;
#if defined(SO_PEERCRED) && !defined(ROAR_BROKEN_PEERCRED)
 struct ucred cred;
 socklen_t cred_len = sizeof(cred);
#endif

 _CHECK_CID(id);

 if ( (c = ROAR_CLIENT(g_clients[id])) == NULL )
  return -1;

 c->fh = fh;

 if ( fh == -1 )
  return 0;

#if defined(SO_PEERCRED) && !defined(ROAR_BROKEN_PEERCRED)
 if (getsockopt(fh, SOL_SOCKET, SO_PEERCRED, &cred, &cred_len) != -1) {
  if ( cred.pid != 0 ) {
   c->pid = cred.pid;
   c->uid = cred.uid;
   c->gid = cred.gid;
  }
 } else {
  ROAR_DBG("req_on_identify(): Can't get creds via SO_PEERCRED: %s", strerror(errno));
 }
#elif defined(ROAR_HAVE_GETPEEREID)
 if (getpeereid(fh, &(c->uid), &(c->gid)) == -1) {
  ROAR_DBG("req_on_identify(): Can't get creds via getpeereid(): %s", strerror(errno));
 }
#endif

 return 0;
}

int clients_get_fh    (int id) {
 _CHECK_CID(id);

 return ROAR_CLIENT(g_clients[id])->fh;
}

int clients_set_pid   (int id, int    pid) {
 _CHECK_CID(id);

 ROAR_CLIENT(g_clients[id])->pid = pid;

 return 0;
}

int clients_set_uid   (int id, int    uid) {
 _CHECK_CID(id);

 ROAR_CLIENT(g_clients[id])->uid = uid;

 return 0;
}

int clients_set_gid   (int id, int    gid) {
 _CHECK_CID(id);

 ROAR_CLIENT(g_clients[id])->gid = gid;

 return 0;
}

int clients_set_name   (int id, const char * name) {
 _CHECK_CID(id);

 strncpy(ROAR_CLIENT(g_clients[id])->name, name, ROAR_BUFFER_NAME-1);
 ROAR_CLIENT(g_clients[id])->name[ROAR_BUFFER_NAME-1] = 0;

 return 0;
}

int clients_set_proto (int id, int    proto) {
 int byteorder = ROAR_BYTEORDER_UNKNOWN;

 _CHECK_CID(id);

 switch (proto) {
  case ROAR_PROTO_ROARAUDIO:
  case ROAR_PROTO_ESOUND:
  case ROAR_PROTO_RPLAY:
  case ROAR_PROTO_SIMPLE:
    byteorder = ROAR_BYTEORDER_NETWORK;
   break;
 }

 ROAR_CLIENT(g_clients[id])->proto     = proto;
 ROAR_CLIENT(g_clients[id])->byteorder = byteorder;

 return 0;
}

int clients_block      (int id, int unblock) {
 _CHECK_CID(id);

 if ( unblock ) {
  g_clients[id]->blockc--;
 } else {
  g_clients[id]->blockc++;
 }

 return 0;
}


#define MAX_STREAMLESS 8

int clients_check_all (void) {
#ifdef ROAR_HAVE_SELECT
 struct roar_client * c;
 struct timeval tv;
 fd_set r, w, e;
 int i, j;
 int ret;
 int fh;
 int max_fh = -1;
 int have = 0;
 struct {
  int id;
  int fh;
 } streamless[MAX_STREAMLESS];
 int have_streamless = 0;
 int have_stream;

 ROAR_DBG("clients_check_all(void) = ?");

 FD_ZERO(&r);
 FD_ZERO(&w);
 FD_ZERO(&e);

 tv.tv_sec  = 0;
 tv.tv_usec = 1;

 for (i = 0; i < ROAR_CLIENTS_MAX; i++) {
  if ( (c = ROAR_CLIENT(g_clients[i])) == NULL )
   continue;

  ROAR_DBG("clients_check_all(void): i(client)=%i", i);

  if ( (fh = c->fh) != -1 ) {
   have++;

   ROAR_DBG("clients_check_all(*): fh=%i", fh);

   FD_SET(fh, &r);
   FD_SET(fh, &e);

   if ( g_clients[i]->outbuf != NULL ) {
    FD_SET(fh, &w);
   }

   if ( fh > max_fh )
    max_fh = fh;
  }

  have_stream = 0;

  for (j = 0; j < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; j++) {
   ROAR_DBG("clients_check_all(void): i(client)=%i, j(stream)=%i", i, j);
   if ( (fh = streams_get_fh(c->streams[j])) != -1 ) {
    ROAR_DBG("clients_check_all(*): g_clients[i=%i]->streams[j=%i] = %i, fh = %i", i, j, c->streams[j], fh);
    if ( fh > -1 ) {
     FD_SET(fh, &r);

     if ( fh > max_fh )
      max_fh = fh;
    } else if ( fh == -2 ) {
     streams_check(c->streams[j]);
    }

    have_stream = 1;
   }
   //printf("D: client=%i, stream=%i, fh=%i\n", i, j, fh);
  }

  if ( !have_stream && have_streamless < MAX_STREAMLESS ) {
   streamless[have_streamless  ].id = i;
   if ( (streamless[have_streamless++].fh = c->fh) == -1 )
    have_streamless--;
  }
 }

 ROAR_DBG("clients_check_all(void): max_fh=%i", max_fh);

 if ( max_fh == -1 )
  return 0;

 if ( (ret = select(max_fh + 1, &r, &w, &e, &tv)) < 1 ) {
  return ret < 0 ? ret : have;
 }

 for (i = 0; i < ROAR_CLIENTS_MAX; i++) {
  if ( (c = ROAR_CLIENT(g_clients[i])) == NULL )
   continue;

  if ( (fh = c->fh) != -1 ) {
   if ( FD_ISSET(fh, &r) ) {
    if ( c->execed == -1 ) {
     clients_check(i);
     if ( g_clients[i] != NULL && ROAR_CLIENT(g_clients[i])->execed != -1 ) {
      FD_CLR(fh, &r);
     }
/*
    } else {
     streams_check(g_clients[i]->execed);
*/
    }
   }
   if ( FD_ISSET(fh, &w) ) {
    clients_flush(i);
   }

   if ( FD_ISSET(fh, &e) ) {
    clients_delete(i);
    continue;
   }
  }

  if ( (c = ROAR_CLIENT(g_clients[i])) == NULL )
   continue;

  for (j = 0; j < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; j++) {
   ROAR_DBG("clients_check_all(*): D: client=%i, stream=%i, g_clients[i=%i] = %p", i, j, i, g_clients[i]);
   if ( g_clients[i] == NULL ) // streams_check() bellow can delete our client (why?)
    break;

   //ROAR_WARN("clients_check_all(*): client=%i: client exists", i);
   ROAR_DBG("clients_check_all(*): client=%i, stream=%i: id=%i", i, j, c->streams[j]);

   if ( (fh = streams_get_fh(c->streams[j])) != -1 ) {
    ROAR_DBG("clients_check_all(*): client=%i, stream=%i: fh=%i", i, j, fh);
    if ( fh > -1 && FD_ISSET(fh, &r) ) {
     streams_check(c->streams[j]);
    }
   }
  }
 }

 if ( have_streamless ) {
   FD_ZERO(&r);
   FD_ZERO(&w);

   tv.tv_sec  = 0;
   tv.tv_usec = 1;

   max_fh = -1;

   for (i = 0; i < have_streamless; i++) {
    if ( g_clients[j = streamless[i].id] == NULL )
     continue;

    if ( ROAR_CLIENT(g_clients[j])->execed != -1 )
     continue;

    fh = streamless[i].fh;

    ROAR_DBG("clients_check_all(void): fh=%i", fh);
    FD_SET(fh, &r);

    if ( g_clients[j]->outbuf != NULL ) {
     FD_SET(fh, &w);
    }

    if ( fh > max_fh )
     max_fh = fh;
   }

   if ( (ret = select(max_fh + 1, &r, &w, NULL, &tv)) < 0 ) {
    return ret;
   }

   for (i = 0; i < have_streamless; i++) {
    if ( FD_ISSET(streamless[i].fh, &r) ) {
     clients_check(streamless[i].id);
    }
    if ( FD_ISSET(streamless[i].fh, &w) ) {
     clients_flush(streamless[i].id);
    }
   }
 }

 ROAR_DBG("clients_check_all(void) = %i // have value", have);
 return have;
#else
 ROAR_DBG("clients_check_all(void) = -1");
 return -1;
#endif
}

int clients_check     (int id) {
 struct roar_client_server * cs;
 struct roar_message    m;
 struct roar_connection con;
 struct roar_vio_calls  vio;
 struct roar_error_state errstate;
 const struct roard_proto_handle * proto;
 struct roar_dl_librarypara * pluginpara;
 int command_error;
 char * data = NULL;
 int oldcmd;
 int r;
 int rv = 0;
 uint32_t flags[2] = {COMMAND_FLAG_NONE, COMMAND_FLAG_NONE};
 uint32_t event;

 ROAR_DBG("clients_check(id=%i) = ?", id);

 _CHECK_CID(id);

 cs = g_clients[id];

 if ( ROAR_CLIENT(cs)->fh == -1 )
  return -1;

 if ( roar_connect_fh(&con, ROAR_CLIENT(cs)->fh) == -1 ) {
  ROAR_WARN("clients_check(id=%i): Can not create con object for client: %s", id, roar_errorstring);
 }

 ROAR_DBG("clients_check(id=%i): c->proto=%i", id, ROAR_CLIENT(cs)->proto);

 switch (ROAR_CLIENT(cs)->proto) {
  case ROAR_PROTO_ROARAUDIO:
    r = roar_recv_message(&con, &m, &data);

    if ( r == -1 ) { // should we drop the client?
     clients_delete(id);
     return -1;
    }

    event = ROAR_NOTIFY_CMD2EVENT(m.cmd);

    oldcmd = m.cmd;

    roar_err_store(&errstate);
    roar_err_clear_all();
    r = command_exec(id, &m, &data, flags);
    roar_err_update();
    command_error = roar_error;
    roar_err_restore(&errstate);

    if ( r == -1 ) {
     // use command_error to create an error frame here as soon as this is supported.
     m.cmd     = ROAR_CMD_ERROR;
     m.datalen = 0;
     ROAR_DBG("clients_check(*): Exec of command faild!");
    } else {
     if ( m.cmd == oldcmd ) {
      m.cmd     = ROAR_CMD_OK;
      m.datalen = 0;
     } else if ( m.cmd == ROAR_CMD_OK_STOP ) {
      m.cmd     = ROAR_CMD_OK;
      rv        = 1;
     }
    }
    ROAR_DBG("clients_check(*): data=%p", data);

    if ( flags[1] & COMMAND_FLAG_OUT_NOSEND ) {
     roar_notify_core_emit_simple(event, id, -1, -1, -1, -1, NULL, 0);
    } else {
     roar_notify_core_emit_simple(event, id, -1, -1, m.cmd, -1, NULL, 0);
     if ( roar_send_message(&con, &m, flags[1] & COMMAND_FLAG_OUT_LONGDATA ? data : NULL) == -1 ) {
      ROAR_WARN("clients_check(id=%i): Can not send answer to client: %s", id, roar_errorstring);
     }
    }

    if ( flags[1] & COMMAND_FLAG_OUT_CLOSECON )
     clients_close(id, 1);

    if ( flags[1] & COMMAND_FLAG_OUT_DELETE )
     clients_delete(id);

   break;
#ifndef ROAR_WITHOUT_DCOMP_EMUL_RSOUND
  case ROAR_PROTO_RSOUND:
    rv = emul_rsound_check_client(id, NULL);
    if ( rv == 0 ) { // loop as long as we don't get an error.
     while (rv == 0)
      rv = emul_rsound_check_client(id, NULL);
     rv = 0; // restore
    } else { // in case of error delete the client
     if (
#ifdef EAGAIN
          errno != EAGAIN      &&
#endif
#ifdef EWOULDBLOCK
          errno != EWOULDBLOCK &&
#endif
#ifdef EINTR
          errno != EINTR       &&
#endif
          1 ) {
      rv = clients_delete(id);
     } else {
      rv = 0;
     }
    }
   break;
#endif
  default:
    rv = -1;
    proto = clients_get_protohandle(ROAR_CLIENT(cs)->proto);
    if ( proto != NULL ) {
     roar_vio_open_fh_socket(&vio, clients_get_fh(id));
     if ( proto->lhandle != NULL )
      roar_dl_context_restore(proto->lhandle);

     switch (proto->type) {
      case ROARD_PROTO_TYPE_BUILDIN:
        ROAR_WARN("clients_check(id=%i): proto(%i) marked as buildin but isn't. BAD.", id, proto->proto);
       break;
      case ROARD_PROTO_TYPE_COMMON:
        if ( proto->impl.common->handle != NULL ) {
         pluginpara = roar_dl_getpara(proto->lhandle); // will return NULL in case protohandle->lhandle is NULL.
         rv = proto->impl.common->handle(id, &vio, &(cs->outbuf), &(cs->protoinst), proto->para, proto->paralen, pluginpara);
         if ( pluginpara != NULL )
          roar_dl_para_unref(pluginpara);
        }
        if ( rv == -1 )
         rv = clients_delete(id);
       break;
     }

     if ( proto->lhandle != NULL )
      roar_dl_context_store(proto->lhandle);
    }
 }

 if ( data != NULL )
  roar_mm_free(data);

 ROAR_DBG("clients_check(id=%i) = %i", id, rv);
 return rv;
}

int clients_flush      (int id) {
 struct roar_vio_calls             vio;
 struct roar_client_server       * cs;
 struct roar_client              * c;
 const struct roard_proto_handle * p;
 struct roar_dl_librarypara * pluginpara;
 size_t len;
 ssize_t ret;
 void * buf;
 int rv;

 _CHECK_CID(id);

 c = ROAR_CLIENT(cs = g_clients[id]);

 p = clients_get_protohandle(c->proto);

 if ( p == NULL )
  return -1;

 roar_vio_open_fh_socket(&vio, clients_get_fh(id));

 switch (p->type) {
  case ROARD_PROTO_TYPE_BUILDIN:
    /* noop */
   break;
  case ROARD_PROTO_TYPE_COMMON:
    if ( p->impl.common->flush != NULL ) {
     if ( p->lhandle != NULL )
      roar_dl_context_restore(p->lhandle);
     pluginpara = roar_dl_getpara(p->lhandle); // will return NULL in case protohandle->lhandle is NULL.
     rv = p->impl.common->flush(id, &vio, &(cs->outbuf), &(cs->protoinst), p->para, p->paralen, pluginpara);
     if ( p->lhandle != NULL )
      roar_dl_context_store(p->lhandle);
     if ( pluginpara != NULL )
      roar_dl_para_unref(pluginpara);
     if ( rv == -1 )
      rv = clients_delete(id);
     return rv;
    }
   break;
 }

 if ( roar_buffer_get_len(cs->outbuf, &len) == -1 )
  return -1;

 if ( roar_buffer_get_data(cs->outbuf, &buf) == -1 )
  return -1;

 ret = roar_vio_write(&vio, buf, len);

 if ( ret < 1 ) {
  clients_delete(id);
  return -1;
 }

 if ( ret == (ssize_t)len ) {
  if ( roar_buffer_next(&(cs->outbuf)) == -1 ) {
   clients_delete(id);
   return -1;
  }
 } else {
  if ( roar_buffer_set_offset(cs->outbuf, ret) == -1 ) {
   clients_delete(id);
   return -1;
  }
 }

 if ( cs->outbuf == NULL ) {
  switch (p->type) {
   case ROARD_PROTO_TYPE_BUILDIN:
     /* noop */
    break;
   case ROARD_PROTO_TYPE_COMMON:
     if ( p->impl.common->flushed != NULL ) {
      if ( p->lhandle != NULL )
       roar_dl_context_restore(p->lhandle);
      pluginpara = roar_dl_getpara(p->lhandle); // will return NULL in case protohandle->lhandle is NULL.
      rv = p->impl.common->flushed(id, &vio, &(cs->outbuf), &(cs->protoinst), p->para, p->paralen, pluginpara);
      if ( p->lhandle != NULL )
       roar_dl_context_store(p->lhandle);
      if ( pluginpara != NULL )
       roar_dl_para_unref(pluginpara);
      if ( rv == -1 )
       rv = clients_delete(id);
      return rv;
     }
    break;
  }
 }

 return 0;
}

int clients_send_mon  (struct roar_audio_info * sa) {
 int i;
// int fh;
 int j;
 int keep_going;

 for (i = 0; i < ROAR_CLIENTS_MAX; i++) {
  if ( g_clients[i] == NULL )
   continue;

  keep_going = 1;

/*
  if ( (fh = g_clients[i]->fh) == -1 )
   continue;
*/

  ROAR_DBG("clients_send_mon(*): client=%i, execed=%i", i, ROAR_CLIENT(g_clients[i])->execed);

/*
  if ( g_clients[i]->execed == -1 ) {
   // TODO: add some code to send a message to the client insetd of the raw data.
*/
   for (j = 0; keep_going && j < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; j++) {
    //if ( (fh = streams_get_fh(g_clients[i]->streams[j])) != -1 ) {
    ROAR_DBG("clients_send_mon(*): client=%i, stream=%i -> ?", i, j);
    if ( ROAR_CLIENT(g_clients[i])->streams[j] != -1 ) {
     ROAR_DBG("clients_send_mon(*): client=%i, stream=%i -> %i", i, j, ROAR_CLIENT(g_clients[i])->streams[j]);
     streams_send_mon(ROAR_CLIENT(g_clients[i])->streams[j]);

     // the client may be deleted here, check if it still exists:
     if ( g_clients[i] == NULL )
      keep_going = 0;
    }
   }
/*
  } else {
//   streams_check(g_clients[i]->execed);
   streams_send_mon(g_clients[i]->execed);
//   if ( streams_send_mon(g_clients[i]->execed) == -1 )
//    clients_delete(i); // delete client in case we could not write
  } 
*/
 }

 // TODO: FIXME: should this really be -1?
 return -1;
}

int clients_send_filter(struct roar_audio_info * sa) {
 struct roar_client * c;
 int i;
 int fh;

 for (i = 0; i < ROAR_CLIENTS_MAX; i++) {
  if ( (c = ROAR_CLIENT(g_clients[i])) == NULL )
   continue;

  if ( (fh = c->fh) == -1 )
   continue;

  if ( c->execed == -1 ) {
   // TODO: add some code to send a message to the client insetd of the raw data.
  } else {
//   streams_check(g_clients[i]->execed);
   streams_send_filter(c->execed);
//   if ( streams_send_mon(g_clients[i]->execed) == -1 )
//    clients_delete(i); // delete client in case we could not write
  }
 }

 return -1;
}

int clients_add_output (int id, struct roar_buffer ** buf) {
 struct roar_client_server   * cs;

 _CHECK_CID(id);
 cs = g_clients[id];

 if ( cs->outbuf == NULL ) {
  cs->outbuf = *buf;
 } else {
  return roar_buffer_moveinto(cs->outbuf, buf);
 }

 return 0;
}

// proto support
const struct roard_proto_handle * clients_get_protohandle(const int proto) {
 size_t i;

 if ( proto < 0 ) {
  roar_err_set(ROAR_ERROR_INVAL);
  return NULL;
 }

 for (i = 0; i < (sizeof(__protos)/sizeof(*__protos)); i++)
  if ( __protos[i].proto == proto )
   return &(__protos[i]);

 roar_err_set(ROAR_ERROR_NOENT);
 return NULL;
}

int clients_register_proto_common(const struct roar_dl_proto * proto, struct roar_dl_lhandle * lhandle) {
 const size_t len = sizeof(__protos)/sizeof(*__protos);
 size_t i;

 ROAR_DBG("clients_register_proto_common(proto=%p, lhandle=%p) = ?", proto, lhandle);

 if ( proto == NULL )
  return -1;

 for (i = 0; __protos[i].proto != -1; i++);

 // i is now at pos of current EOS entry.

 // test if we have space for one more entry:
 if ( (i+1) >= len )
  return -1;

 __protos[i].impl.common = proto;

 __protos[i].proto   = proto->proto;
 __protos[i].type    = ROARD_PROTO_TYPE_COMMON;
 __protos[i].lhandle = lhandle;

 return 0;
}

int clients_unregister_proto(int proto) {
 size_t i;

 if ( proto < 0 ) {
  roar_err_set(ROAR_ERROR_RANGE);
  return -1;
 }

 for (i = 0; i < (sizeof(__protos)/sizeof(*__protos)); i++) {
  if ( __protos[i].proto == proto ) {
   memset(&(__protos[i]), 0, sizeof(*__protos));
   __protos[i].proto = -1;
   return 0;
  }
 }

 roar_err_set(ROAR_ERROR_NOENT);
 return -1;
}

void print_protolist        (enum output_format format) {
 struct roard_proto_handle * p;
 char flags[5] = "    ";
 char subsys[7] = "      ";
 const char * description;
 size_t i;

 switch (format) {
  case FORMAT_NATIVE:
    printf("  Protocol Flag Subsys - Description\n");
    printf("------------------------------------------------------\n");
    printf("  roar     bb   WM LRX - RoarAudio native protocol\n");
#ifndef ROAR_WITHOUT_DCOMP_EMUL_SIMPLE
    printf("  simple   bb   WM LRX - PulseAudio simple protocol\n");
#endif
#ifndef ROAR_WITHOUT_DCOMP_EMUL_RSOUND
    printf("  rsound   bb   W      - RSound emulation\n");
#endif
   break;
  case FORMAT_WIKI:
    printf("||=Protocol =||=Flag =||=Subsys =||=Description              =||\n");
    printf("||roar       ||bb     ||WM LRX   ||RoarAudio native protocol  ||\n");
#ifndef ROAR_WITHOUT_DCOMP_EMUL_SIMPLE
    printf("||simple     ||bb     ||WM LRX   ||PulseAudio simple protocol ||\n");
#endif
#ifndef ROAR_WITHOUT_DCOMP_EMUL_RSOUND
    printf("||rsound     ||bb     ||W        ||RSound emulation           ||\n");
#endif
   break;
  case FORMAT_CSV:
    printf("Protocol,Flag,Subsys,Description\n");
    printf("roar,bb,WM LRX,RoarAudio native protocol\n");
#ifndef ROAR_WITHOUT_DCOMP_EMUL_SIMPLE
    printf("simple,bb,WM LRX,PulseAudio simple protocol\n");
#endif
#ifndef ROAR_WITHOUT_DCOMP_EMUL_RSOUND
    printf("rsound,bb,W,RSound emulation\n");
#endif
   break;
  default:
    roar_err_set(ROAR_ERROR_NOTSUP);
    return;
 }

 for (i = 0; i < (sizeof(__protos)/sizeof(*__protos)); i++) {
  p = &(__protos[i]);
  if ( p->proto == -1 )
   continue;

  strncpy(flags, "    ", 4);
  strncpy(subsys, "      ", 6);
  description = "(none)";

  if ( p->lhandle != NULL ) {
   flags[0] = 'P';
  } else {
   flags[0] = 'b';
  }

  switch (p->type) {
   case ROARD_PROTO_TYPE_BUILDIN:
     continue;
    break;
   case ROARD_PROTO_TYPE_COMMON:
     flags[1] = 'C';
     description = p->impl.common->description;
    break;
  }

  switch (format) {
   case FORMAT_NATIVE:
     printf("  %-8s %s %s - %s\n", roar_proto2str(p->proto), flags, subsys, description);
    break;
   case FORMAT_WIKI:
     printf("||%s ||%s ||%s ||%s ||\n", roar_proto2str(p->proto), flags, subsys, description);
    break;
   case FORMAT_CSV:
     printf("%s,%s,%s,%s\n", roar_proto2str(p->proto), flags, subsys, description);
    break;
  }
 }
}

int client_stream_exec   (int client, int stream) {
 struct roar_client * c;
 int i;
 int fh;

 _CHECK_CID(client);

#if 0
 if ( g_clients[client] == NULL ) {
  ROAR_WARN("client_stream_exec(client=%i, stream=%i) = -1 // client does not exist", client, stream);
  return -1;
 }
#endif

 c = ROAR_CLIENT(g_clients[client]);

 for (i = 0; i < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; i++) {
  if ( c->streams[i] == stream ) {
   c->execed = stream;
   if ( streams_is_ready(stream) == 0 ) {
    streams_set_fh(stream, c->fh);
    streams_set_socktype(stream, ROAR_SOCKET_TYPE_GENSTR);
   } else {
    ROAR_DBG("client_stream_exec(client=%i, stream=%i): fh=?", client, stream);
    if ( (fh = c->fh) != -1 ) {
     close(fh);
     c->fh = -1;
    }
   }
   ROAR_DBG("client_stream_exec(client=%i, stream=%i) = 0", client, stream);
   return 0;
  }
 }

 ROAR_WARN("client_stream_exec(client=%i, stream=%i) = -1 // client does not own stream", client, stream);
 return -1;
}

int client_stream_set_fh (int client, int stream, int fh) {
 int i;

 ROAR_DBG("client_stream_set_fh(client=%i, stream=%i, fh=%i) = ?", client, stream, fh);

 _CHECK_CID(client);

 for (i = 0; i < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; i++) {
  if ( ROAR_CLIENT(g_clients[client])->streams[i] == stream ) {
   ROAR_DBG("client_stream_set_fh(client=%i, stream=%i, fh=%i): stream found, index %i", client, stream, fh, i);
   return streams_set_fh(stream, fh);
  }
 }

 ROAR_WARN("client_stream_set_fh(client=%i, stream=%i, fh=%i) = -1 // client does not own stream", client, stream, fh);
 return -1;
}

int client_stream_add    (int client, int stream) {
 int i;

 _CHECK_CID(client);

 for (i = 0; i < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; i++) {
  if ( ROAR_CLIENT(g_clients[client])->streams[i] == -1 ) {
   ROAR_CLIENT(g_clients[client])->streams[i] = stream;
   streams_set_client(stream, client);
   return 0;
  }
 }

 return -1;
}

int client_stream_delete (int client, int stream) {
 int i;

 _CHECK_CID(client);

 for (i = 0; i < ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT; i++) {
  if ( ROAR_CLIENT(g_clients[client])->streams[i] == stream ) {
   ROAR_CLIENT(g_clients[client])->streams[i] = -1;

   if ( stream == ROAR_CLIENT(g_clients[client])->execed ) {
    ROAR_DBG("client_stream_delete(client=%i, stream=%i): stream is execed one, deleting client!", client, stream);
    clients_delete(client);
   }

   ROAR_DBG("client_stream_delete(client=%i, stream=%i) = 0", client, stream);
   return 0;
  }
 }

 ROAR_DBG("client_stream_delete(client=%i, stream=%i) = -1", client, stream);
 return -1;
}

int client_stream_move   (int client, int stream) {
 int old_client = streams_get_client(stream);

 ROAR_DBG("client_stream_move(client=%i, stream=%i): old_client = %i", client, stream, old_client);

 if ( old_client != -1 )
  if ( client_stream_delete(old_client, stream) == -1 )
   return -1;

 return client_stream_add(client, stream); 
}


// notify thingys
int clients_wait    (int client, struct roar_event * events, size_t num) {
 struct roar_client_server * cs;
 size_t i, c;

 ROAR_DBG("clients_wait(client=%i, events=%p, num=%llu) = ?", client, events, (long long unsigned int)num);

 _CHECK_CID(client);

 cs = g_clients[client];

 if ( cs->waits != NULL )
  return -1;

 cs->waits = roar_mm_malloc((num+1) * sizeof(struct roar_subscriber *));

 if ( cs->waits == NULL )
  return -1;

 if ( clients_block(client, 0) != 0 )
  return -1;

 for (i = 0; i < num; i++) {
#if defined(DEBUG) && 0
  dbg_notify_cb(NULL, &(events[i]), cs);
#endif
  cs->waits[i] = roar_notify_core_subscribe(NULL, &(events[i]), clients_ncb_wait, cs);
  if ( cs->waits[i] == NULL ) {
   for (c = 0; c < i; c++)
    roar_notify_core_unsubscribe(NULL, cs->waits[c]);
   roar_mm_free(cs->waits);
   cs->waits = NULL;
   clients_block(client, 1);
   return -1;
  }
 }

 cs->waits[num] = NULL;

 ROAR_DBG("clients_wait(client=%i, events=%p, num=%llu) = 0", client, events, (long long unsigned int)num);
 return 0;
}

void clients_ncb_wait(struct roar_notify_core * core, struct roar_event * event, void * userdata) {
 struct roar_client_server * cs = userdata;
 struct roar_message m;
 struct roar_connection con;
 uint16_t * u16 = (uint16_t *) m.data;
 size_t tmp;
 size_t i;

 ROAR_DBG("clients_ncb_wait(core=%p, event=%p, userdata=%p) = ?", core, event, userdata);

 for (i = 0; cs->waits[i] != NULL; i++)
  roar_notify_core_unsubscribe(NULL, cs->waits[i]);

 roar_mm_free(cs->waits);
 cs->waits = NULL;

 // protocol depended handling...
 memset(&m, 0, sizeof(m));
 m.cmd = ROAR_CMD_OK;
 u16[0] = ROAR_HOST2NET16(0); // Version
 u16[1] = ROAR_HOST2NET16(0); // flags

 tmp = sizeof(m.data) - 4;

 roar_event_to_blob(event, m.data + 4, &tmp);

 m.datalen = tmp + 4;

 roar_connect_fh(&con, ROAR_CLIENT(cs)->fh);
 roar_send_message(&con, &m, NULL);
 // ...end of protocol depended handling.

// clients_block(, 1);
 // TODO: FIXME: bad hack...
 cs->blockc--;
}


// acclev:
static struct {
 const enum roard_client_acclev acclev;
 const char *                   name;
} _g_acclevs[] = {
 {ACCLEV_NONE,    "none"   },
 {ACCLEV_IDENTED, "idented"},
 {ACCLEV_CONCTL,  "conctl" },
 {ACCLEV_GUEST,   "guest"  },
 {ACCLEV_USER,    "user"   },
 {ACCLEV_PWRUSER, "pwruser"},
 {ACCLEV_ALL,     "all"    },
 {-1, NULL}
};

enum roard_client_acclev clients_str2acclev(const char * acclev) {
 int i;

 for (i = 0; _g_acclevs[i].name != NULL; i++)
  if ( !strcasecmp(_g_acclevs[i].name, acclev) )
   return _g_acclevs[i].acclev;

 return ACCLEV_ERROR;
}

const char * clients_acclev2str(const enum roard_client_acclev acclev) {
 int i;

 for (i = 0; _g_acclevs[i].name != NULL; i++)
  if ( _g_acclevs[i].acclev == acclev )
   return _g_acclevs[i].name;

 return NULL;
}

//ll