src/capability.c

   1 /*
   2  * Copyright (c) 2012 William Pitcock <nenolod@dereferenced.org>.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice is present in all copies.
   7  *
   8  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   9  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  10  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  11  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  12  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  13  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  14  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  15  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  16  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  17  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  18  * POSSIBILITY OF SUCH DAMAGE.
  19  */
  20
  21 #include "stdinc.h"
  22 #include "capability.h"
  23 #include "irc_dictionary.h"
  24
  25 struct CapabilityIndex {
  26         struct Dictionary *cap_dict;
  27         unsigned int highest_bit;
  28 };
  29
  30 #define CAP_ORPHANED    0x1
  31 #define CAP_REQUIRED    0x2
  32
  33 struct CapabilityEntry {
  34         char *cap;
  35         unsigned int value;
  36         unsigned int flags;
  37 };
  38
  39 unsigned int
  40 capability_get(struct CapabilityIndex *idx, const char *cap)
  41 {
  42         struct CapabilityEntry *entry;
  43
  44         s_assert(idx != NULL);
  45
  46         entry = irc_dictionary_retrieve(idx->cap_dict, cap);
  47         if (entry != NULL && !(entry->flags & CAP_ORPHANED))
  48                 return (1 << entry->value);
  49
  50         return 0xFFFFFFFF;
  51 }
  52
  53 unsigned int
  54 capability_put(struct CapabilityIndex *idx, const char *cap)
  55 {
  56         struct CapabilityEntry *entry;
  57
  58         s_assert(idx != NULL);
  59         if (!idx->highest_bit)
  60                 return 0xFFFFFFFF;
  61
  62         if ((entry = irc_dictionary_retrieve(idx->cap_dict, cap)) != NULL)
  63         {
  64                 entry->flags &= ~CAP_ORPHANED;
  65                 return (1 << entry->value);
  66         }
  67
  68         entry = rb_malloc(sizeof(struct CapabilityEntry));
  69         entry->cap = rb_strdup(cap);
  70         entry->flags = 0;
  71         entry->value = idx->highest_bit;
  72
  73         irc_dictionary_add(idx->cap_dict, entry->cap, entry);
  74
  75         idx->highest_bit++;
  76         if (idx->highest_bit % (sizeof(unsigned int) * 8) == 0)
  77                 idx->highest_bit = 0;
  78
  79         return (1 << entry->value);
  80 }
  81
  82 void
  83 capability_orphan(struct CapabilityIndex *idx, const char *cap)
  84 {
  85         struct CapabilityEntry *entry;
  86
  87         s_assert(idx != NULL);
  88
  89         entry = irc_dictionary_retrieve(idx->cap_dict, cap);
  90         if (entry != NULL)
  91         {
  92                 entry->flags &= ~CAP_REQUIRED;
  93                 entry->flags |= CAP_ORPHANED;
  94         }
  95 }
  96
  97 void
  98 capability_require(struct CapabilityIndex *idx, const char *cap)
  99 {
 100         struct CapabilityEntry *entry;
 101
 102         s_assert(idx != NULL);
 103
 104         entry = irc_dictionary_retrieve(idx->cap_dict, cap);
 105         if (entry != NULL)
 106                 entry->flags |= CAP_REQUIRED;
 107 }
 108
 109 static void
 110 capability_destroy(struct DictionaryElement *delem, void *privdata)
 111 {
 112         s_assert(delem != NULL);
 113
 114         rb_free(delem->data);
 115 }
 116
 117 struct CapabilityIndex *
 118 capability_index_create(void)
 119 {
 120         struct CapabilityIndex *idx;
 121
 122         idx = rb_malloc(sizeof(struct CapabilityIndex));
 123         idx->cap_dict = irc_dictionary_create(strcasecmp);
 124         idx->highest_bit = 1;
 125
 126         return idx;
 127 }
 128
 129 void
 130 capability_index_destroy(struct CapabilityIndex *idx)
 131 {
 132         s_assert(idx != NULL);
 133
 134         irc_dictionary_destroy(idx->cap_dict, capability_destroy, NULL);
 135         rb_free(idx);
 136 }
 137
 138 const char *
 139 capability_index_list(struct CapabilityIndex *idx, unsigned int cap_mask)
 140 {
 141         struct DictionaryIter iter;
 142         struct CapabilityEntry *entry;
 143         static char buf[BUFSIZE];
 144         char *t = buf;
 145         int tl;
 146
 147         s_assert(idx != NULL);
 148
 149         *t = '\0';
 150
 151         DICTIONARY_FOREACH(entry, &iter, idx->cap_dict)
 152         {
 153                 if (entry->value & cap_mask)
 154                 {
 155                         tl = rb_sprintf(t, "%s ", entry->cap);
 156                         t += tl;
 157                 }
 158         }
 159
 160         t--;
 161         *t = '\0';
 162
 163         return buf;
 164 }
 165
 166 unsigned int
 167 capability_index_mask(struct CapabilityIndex *idx)
 168 {
 169         struct DictionaryIter iter;
 170         struct CapabilityEntry *entry;
 171         unsigned int mask = 0;
 172
 173         s_assert(idx != NULL);
 174
 175         DICTIONARY_FOREACH(entry, &iter, idx->cap_dict)
 176         {
 177                 if (!(entry->flags & CAP_ORPHANED))
 178                         mask |= (1 << entry->value);
 179         }
 180
 181         return mask;
 182 }
 183
 184 unsigned int
 185 capability_index_get_required(struct CapabilityIndex *idx)
 186 {
 187         struct DictionaryIter iter;
 188         struct CapabilityEntry *entry;
 189         unsigned int mask = 0;
 190
 191         s_assert(idx != NULL);
 192
 193         DICTIONARY_FOREACH(entry, &iter, idx->cap_dict)
 194         {
 195                 if (!(entry->flags & CAP_ORPHANED) && (entry->flags & CAP_REQUIRED))
 196                         mask |= (1 << entry->value);
 197         }
 198
 199         return mask;
 200 }