src/channel.c

   1 /* Copyright (C) 2009-2010, Martin Johansson <martin@fatbob.nu>
   2    Copyright (C) 2005-2010, Thorvald Natvig <thorvald@natvig.com>
   3
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    - Redistributions of source code must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    - Redistributions in binary form must reproduce the above copyright notice,
  13      this list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15    - Neither the name of the Developers nor the names of its contributors may
  16      be used to endorse or promote products derived from this software without
  17      specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 */
  31 #include <limits.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include "log.h"
  35 #include "list.h"
  36 #include "client.h"
  37 #include "channel.h"
  38 #include "conf.h"
  39
  40
  41 static channel_t *rootChan;
  42 channel_t *defaultChan;
  43 declare_list(channels); /* A flat list of the channels */
  44
  45 static channel_t *createChannel(int id, const char *name, const char *desc)
  46 {
  47         channel_t *ch;
  48
  49         ch = malloc(sizeof(channel_t));
  50         if (ch == NULL)
  51                 Log_fatal("out of memory");
  52         memset(ch, 0, sizeof(channel_t));
  53         ch->id = id;
  54         ch->name = strdup(name);
  55         if (desc)
  56                 ch->desc = strdup(desc);
  57         init_list_entry(&ch->subs);
  58         init_list_entry(&ch->node);
  59         init_list_entry(&ch->clients);
  60         init_list_entry(&ch->flatlist_node);
  61         init_list_entry(&ch->channel_links);
  62         return ch;
  63 }
  64
  65 static int findFreeId()
  66 {
  67         int id = 0;
  68         channel_t *ch_itr = NULL;
  69         for (id = 0; id < INT_MAX; id++) {
  70                 ch_itr = NULL;
  71                 while ((ch_itr = Chan_iterate(&ch_itr)) != NULL) {
  72                         if (ch_itr->id == id)
  73                                 break;
  74                 }
  75                 if (ch_itr == NULL) /* Found free id */
  76                         return id;
  77         }
  78         return -1;
  79 }
  80
  81 #if 0
  82 /* Might be used when tree traversal becomes neccessary */
  83 static channel_t *first_subchannel(channel_t *ch)
  84 {
  85         if (list_empty(&ch->subs))
  86                 return NULL;
  87         else
  88                 return list_get_entry(list_get_first(&ch->subs), channel_t, node);
  89 }
  90
  91 static channel_t *next_channel(channel_t *ch)
  92 {
  93         if (list_get_next(&ch->node) == &list_get_entry(&ch->node, channel_t, node)->parent->subs)
  94                 return NULL;
  95         else
  96                 return list_get_entry(list_get_next(&ch->node), channel_t, node);
  97 }
  98 #endif
  99
 100 channel_t *Chan_iterate(channel_t **channelpptr)
 101 {
 102         channel_t *ch = *channelpptr;
 103
 104         if (!list_empty(&channels)) {
 105                 if (ch == NULL)
 106                         ch = list_get_entry(list_get_first(&channels), channel_t, flatlist_node);
 107                 else {
 108                         if (list_get_next(&ch->flatlist_node) == &channels)
 109                                 ch = NULL;
 110                         else
 111                                 ch = list_get_entry(list_get_next(&ch->flatlist_node), channel_t, flatlist_node);
 112                 }
 113         }
 114
 115         *channelpptr = ch;
 116         return ch;
 117 }
 118
 119 channel_t *Chan_iterate_siblings(channel_t *parent, channel_t **channelpptr)
 120 {
 121         channel_t *ch = *channelpptr;
 122
 123         if (!list_empty(&parent->subs)) {
 124                 if (ch == NULL)
 125                         ch = list_get_entry(list_get_first(&parent->subs), channel_t, node);
 126                 else {
 127                         if (list_get_next(&ch->node) == &parent->subs)
 128                                 ch = NULL;
 129                         else
 130                                 ch = list_get_entry(list_get_next(&ch->node), channel_t, node);
 131                 }
 132         }
 133
 134         *channelpptr = ch;
 135         return ch;
 136 }
 137
 138 void Chan_init()
 139 {
 140         int i;
 141         conf_channel_t chdesc;
 142         conf_channel_link_t chlink;
 143         const char *defaultChannelName;
 144
 145         defaultChannelName = getStrConf(DEFAULT_CHANNEL);
 146
 147         for (i = 0; ; i++) {
 148                 if (Conf_getNextChannel(&chdesc, i) < 0) {
 149                         if (i == 0)
 150                                 Log_fatal("No valid channels found in configuration file. Exiting.");
 151                         break;
 152                 }
 153                 if (i == 0) {
 154                         rootChan = createChannel(0, chdesc.name, chdesc.description);
 155                         rootChan->noenter = chdesc.noenter;
 156                         list_add_tail(&rootChan->flatlist_node, &channels);
 157                         if (strcmp(defaultChannelName, chdesc.name) == 0)
 158                                 defaultChan = rootChan;
 159                 }
 160                 else {
 161                         channel_t *ch, *ch_itr = NULL;
 162                         ch = Chan_createChannel(chdesc.name, chdesc.description);
 163                         ch->noenter = chdesc.noenter;
 164
 165                         if (strcmp(defaultChannelName, chdesc.name) == 0) {
 166                                 Log_info("Setting default channel %s", ch->name);
 167                                 defaultChan = ch;
 168                         }
 169
 170                         do {
 171                                 Chan_iterate(&ch_itr);
 172                         } while (ch_itr != NULL && strcmp(ch_itr->name, chdesc.parent) != 0);
 173
 174                         if (ch_itr == NULL)
 175                                 Log_fatal("Error in channel configuration: parent not found");
 176                         else {
 177                                 Chan_addChannel(ch_itr, ch);
 178                                 Log_info("Adding channel '%s' parent '%s'", ch->name, chdesc.parent);
 179                         }
 180                 }
 181         }
 182         if (defaultChan == NULL)
 183                 defaultChan = rootChan;
 184
 185         if (defaultChan->noenter)
 186                 Log_fatal("Error in channel configuration: default channel is marked as noenter");
 187
 188         /* Channel links */
 189         for (i = 0; ; i++) {
 190                 channel_t *ch_src, *ch_dst, *ch_itr = NULL;
 191                 if (Conf_getNextChannelLink(&chlink, i) < 0) {
 192                         if (i == 0)
 193                                 Log_info("No channel links found in configuration file.");
 194                         break;
 195                 }
 196                 ch_itr = NULL;
 197                 do {
 198                         Chan_iterate(&ch_itr);
 199                 } while (ch_itr != NULL && strcmp(ch_itr->name, chlink.source) != 0);
 200                 if (ch_itr == NULL)
 201                         Log_fatal("Error in channel link configuration: source channel '%s' not found.",
 202                                           chlink.source);
 203                 else
 204                         ch_src = ch_itr;
 205
 206                 ch_itr = NULL;
 207                 do {
 208                         Chan_iterate(&ch_itr);
 209                 } while (ch_itr != NULL && strcmp(ch_itr->name, chlink.destination) != 0);
 210                 if (ch_itr == NULL)
 211                         Log_fatal("Error in channel link configuration: destination channel '%s' not found",
 212                                           chlink.destination);
 213                 else
 214                         ch_dst = ch_itr;
 215
 216                 list_add_tail(&ch_dst->link_node, &ch_src->channel_links);
 217                 ch_src->linkcount++;
 218                 Log_info("Adding channel link '%s' -> '%s'", ch_src->name, ch_dst->name);
 219         }
 220 }
 221
 222 void Chan_free()
 223 {
 224         struct dlist *itr, *save;
 225         channel_t *ch;
 226
 227         list_iterate_safe(itr, save, &channels) {
 228                 ch = list_get_entry(itr, channel_t, flatlist_node);
 229                 Log_debug("Free channel '%s'", ch->name);
 230                 free(ch->name);
 231                 if (ch->desc)
 232                         free(ch->desc);
 233                 free(ch);
 234         }
 235 }
 236
 237 channel_t *Chan_createChannel(const char *name, const char *desc)
 238 {
 239         int id = findFreeId();
 240         if (id < 0)
 241                 Log_fatal("No free channel ID found");
 242         return createChannel(id, name, desc);
 243 }
 244
 245 void Chan_freeChannel(channel_t *ch)
 246 {
 247         list_del(&ch->node);
 248         list_del(&ch->flatlist_node);
 249         free(ch);
 250 }
 251
 252 void Chan_addChannel(channel_t *parent, channel_t *ch)
 253 {
 254         list_add_tail(&ch->node, &parent->subs);
 255         ch->parent = parent;
 256         list_add_tail(&ch->flatlist_node, &channels);
 257 }
 258
 259
 260 int Chan_userLeave(client_t *client)
 261 {
 262         channel_t *leaving = NULL;
 263         int leaving_id = -1;
 264
 265         if (client->channel) {
 266                 list_del(&client->chan_node);
 267                 leaving = (channel_t *)client->channel;
 268                 if (leaving->temporary && list_empty(&leaving->clients)) {
 269                         leaving_id = leaving->id;
 270                         Chan_freeChannel(leaving);
 271                 }
 272         }
 273         return leaving_id;
 274 }
 275
 276 int Chan_userJoin(channel_t *ch, client_t *client)
 277 {
 278         int leaving_id;
 279
 280         /* Do nothing if user already is in this channel */
 281         if ((channel_t *)client->channel == ch)
 282                 return 0;
 283
 284         Log_debug("Add user %s to channel %s", client->username, ch->name);
 285         /* Only allowed in one channel at a time */
 286         leaving_id = Chan_userLeave(client);
 287         list_add_tail(&client->chan_node, &ch->clients);
 288         client->channel = (void *)ch;
 289         return leaving_id;
 290 }
 291
 292 int Chan_userJoin_id(int channelid, client_t *client)
 293 {
 294         channel_t *ch_itr = NULL;
 295         do {
 296                 Chan_iterate(&ch_itr);
 297         } while (ch_itr != NULL && ch_itr->id != channelid);
 298         if (ch_itr == NULL) {
 299                 Log_warn("Channel id %d not found - ignoring.", channelid);
 300                 return -1;
 301         }
 302         else
 303                 return Chan_userJoin(ch_itr, client);
 304 }
 305
 306 bool_t Chan_userJoin_id_test(int channelid)
 307 {
 308         channel_t *ch_itr = NULL;
 309         do {
 310                 Chan_iterate(&ch_itr);
 311         } while (ch_itr != NULL && ch_itr->id != channelid);
 312         if (ch_itr == NULL) {
 313                 Log_warn("Channel id %d not found - ignoring.", channelid);
 314                 return false;
 315         }
 316         if (ch_itr->noenter)
 317                 return false;
 318         else
 319                 return true;
 320 }
 321
 322 #if 0
 323 void Chan_addChannel_id(int parentId, channel_t *ch)
 324 {
 325         channel_t *ch_itr = NULL;
 326         do {
 327                 Chan_iterate(&ch_itr);
 328         } while (ch_itr != NULL && ch_itr->id != parentId);
 329         if (ch_itr == NULL)
 330                 Log_warn("Chan_addChannel_id: Channel id %d not found - ignoring.", parentId);
 331         else
 332                 list_add_tail(&ch->node, &ch_itr->subs);
 333 }
 334 #endif
 335
 336 channel_t *Chan_fromId(int channelid)
 337 {
 338         channel_t *ch_itr = NULL;
 339         do {
 340                 Chan_iterate(&ch_itr);
 341         } while (ch_itr != NULL && ch_itr->id != channelid);
 342         if (ch_itr == NULL)
 343                 Log_warn("Chan_fromId: Channel id %d not found.", channelid);
 344         return ch_itr;
 345 }
 346
 347 void Chan_removeChannel(channel_t *ch)
 348 {
 349         list_del(&ch->node);
 350 }
 351
 352 void Chan_buildTreeList(channel_t *ch, struct dlist *head)
 353 {
 354         channellist_t *chl;
 355         struct dlist *itr;
 356         channel_t *sub;
 357
 358         chl = malloc(sizeof(channellist_t));
 359         chl->chan = ch;
 360         init_list_entry(&chl->node);
 361         list_add_tail(&chl->node, head);
 362
 363         list_iterate(itr, &ch->subs) {
 364                 sub = list_get_entry(itr, channel_t, node);
 365                 Chan_buildTreeList(sub, head);
 366         }
 367 }
 368
 369 void Chan_freeTreeList(struct dlist *head)
 370 {
 371         struct dlist *itr, *save;
 372         list_iterate_safe(itr, save, head) {
 373                 free(list_get_entry(itr, channellist_t, node));
 374         }
 375 }