src/utils/unixsock.c

   1 /*
   2  * SysDB - src/utils/unixsock.c
   3  * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
   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  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include "utils/error.h"
  29 #include "utils/unixsock.h"
  30
  31 #include <assert.h>
  32 #include <errno.h>
  33
  34 #include <stdarg.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37
  38 #include <string.h>
  39 #include <strings.h>
  40
  41 #include <unistd.h>
  42
  43 #include <sys/socket.h>
  44 #include <sys/un.h>
  45
  46 /*
  47  * private data types
  48  */
  49
  50 struct sdb_unixsock_client {
  51         char *path;
  52         FILE *fh;
  53
  54         int shutdown;
  55 };
  56
  57 #define SDB_SHUT_RD   (1 << SHUT_RD)
  58 #define SDB_SHUT_WR   (1 << SHUT_WR)
  59 #define SDB_SHUT_RDWR (SDB_SHUT_RD | SDB_SHUT_WR)
  60
  61 /*
  62  * private helper functions
  63  */
  64
  65 static int
  66 sdb_unixsock_get_column_count(const char *string, const char *delim)
  67 {
  68         int count = 1;
  69
  70         assert(string);
  71
  72         if ((! delim) || (*string == '\0'))
  73                 return 1;
  74
  75         if ((delim[0] == '\0') || (delim[1] == '\0')) {
  76                 while ((string = strchr(string, (int)delim[0]))) {
  77                         ++string;
  78                         ++count;
  79                 }
  80         }
  81         else {
  82                 while ((string = strpbrk(string, delim))) {
  83                         ++string;
  84                         ++count;
  85                 }
  86         }
  87         return count;
  88 } /* sdb_unixsock_get_column_count */
  89
  90 static int
  91 sdb_unixsock_parse_cell(char *string, int type, sdb_data_t *data)
  92 {
  93         char *endptr = NULL;
  94
  95         switch (type) {
  96                 case SDB_TYPE_INTEGER:
  97                         errno = 0;
  98                         data->data.integer = strtoll(string, &endptr, 0);
  99                         break;
 100                 case SDB_TYPE_DECIMAL:
 101                         errno = 0;
 102                         data->data.decimal = strtod(string, &endptr);
 103                         break;
 104                 case SDB_TYPE_STRING:
 105                         data->data.string = string;
 106                         break;
 107                 case SDB_TYPE_DATETIME:
 108                         {
 109                                 double datetime = strtod(string, &endptr);
 110                                 data->data.datetime = DOUBLE_TO_SDB_TIME(datetime);
 111                         }
 112                         break;
 113                 case SDB_TYPE_BINARY:
 114                         /* we don't support any binary information containing 0-bytes */
 115                         data->data.binary.length = strlen(string);
 116                         data->data.binary.datum = (const unsigned char *)string;
 117                         break;
 118                 default:
 119                         sdb_log(SDB_LOG_ERR, "unixsock: Unexpected type %i while "
 120                                         "parsing query result.", type);
 121                         return -1;
 122         }
 123
 124         if ((type == SDB_TYPE_INTEGER) || (type == SDB_TYPE_DECIMAL)
 125                         || (type == SDB_TYPE_DATETIME)) {
 126                 if (errno || (string == endptr)) {
 127                         char errbuf[1024];
 128                         sdb_log(SDB_LOG_ERR, "unixsock: Failed to parse string "
 129                                         "'%s' as numeric value (type %i): %s", string, type,
 130                                         sdb_strerror(errno, errbuf, sizeof(errbuf)));
 131                         return -1;
 132                 }
 133                 else if (endptr && (*endptr != '\0'))
 134                         sdb_log(SDB_LOG_WARNING, "unixsock: Ignoring garbage after "
 135                                         "number while parsing numeric value (type %i): %s.",
 136                                         type, endptr);
 137         }
 138
 139         data->type = type;
 140         return 0;
 141 } /* sdb_unixsock_parse_cell */
 142
 143 static int
 144 sdb_unixsock_client_process_one_line(sdb_unixsock_client_t *client,
 145                 char *line, sdb_unixsock_client_data_cb callback,
 146                 sdb_object_t *user_data, const char *delim,
 147                 int column_count, int *types)
 148 {
 149         sdb_data_t data[column_count];
 150         char *orig_line = line;
 151
 152         int i;
 153
 154         assert(column_count > 0);
 155
 156         for (i = 0; i < column_count; ++i) {
 157                 char *next;
 158
 159                 if (! line) { /* this must no happen */
 160                         sdb_log(SDB_LOG_ERR, "unixsock: Unexpected EOL while "
 161                                         "parsing line (expected %i columns delimited by '%s'; "
 162                                         "got %i): %s", column_count, delim,
 163                                         /* last line number */ i, orig_line);
 164                         return -1;
 165                 }
 166
 167                 if ((delim[0] == '\0') || (delim[1] == '\0'))
 168                         next = strchr(line, (int)delim[0]);
 169                 else
 170                         next = strpbrk(line, delim);
 171
 172                 if (next) {
 173                         *next = '\0';
 174                         ++next;
 175                 }
 176
 177                 if (sdb_unixsock_parse_cell(line,
 178                                         types ? types[i] : SDB_TYPE_STRING, &data[i]))
 179                         return -1;
 180
 181                 line = next;
 182         }
 183
 184         if (callback(client, (size_t)column_count, data, user_data))
 185                 return -1;
 186         return 0;
 187 } /* sdb_unixsock_client_process_one_line */
 188
 189 /*
 190  * public API
 191  */
 192
 193 sdb_unixsock_client_t *
 194 sdb_unixsock_client_create(const char *path)
 195 {
 196         sdb_unixsock_client_t *client;
 197
 198         if (! path)
 199                 return NULL;
 200
 201         client = malloc(sizeof(*client));
 202         if (! client)
 203                 return NULL;
 204         memset(client, 0, sizeof(*client));
 205         client->fh = NULL;
 206
 207         client->path = strdup(path);
 208         if (! client->path) {
 209                 sdb_unixsock_client_destroy(client);
 210                 return NULL;
 211         }
 212
 213         client->shutdown = 0;
 214         return client;
 215 } /* sdb_unixsock_client_create */
 216
 217 int
 218 sdb_unixsock_client_connect(sdb_unixsock_client_t *client)
 219 {
 220         struct sockaddr_un sa;
 221         int fd;
 222
 223         if ((! client) || (! client->path))
 224                 return -1;
 225
 226         memset(&sa, 0, sizeof(sa));
 227
 228         if (client->fh)
 229                 fclose(client->fh);
 230
 231         fd = socket(AF_UNIX, SOCK_STREAM, /* protocol = */ 0);
 232         if (fd < 0) {
 233                 char errbuf[1024];
 234                 sdb_log(SDB_LOG_ERR, "unixsock: Failed to open socket: %s",
 235                                 sdb_strerror(errno, errbuf, sizeof(errbuf)));
 236                 return -1;
 237         }
 238
 239         sa.sun_family = AF_UNIX;
 240         strncpy(sa.sun_path, client->path, sizeof(sa.sun_path));
 241         sa.sun_path[sizeof(sa.sun_path) - 1] = '\0';
 242
 243         if (connect(fd, (struct sockaddr *)&sa, sizeof(sa))) {
 244                 char errbuf[1024];
 245                 sdb_log(SDB_LOG_ERR, "unixsock: Failed to connect to %s: %s",
 246                                 sa.sun_path, sdb_strerror(errno, errbuf, sizeof(errbuf)));
 247                 close(fd);
 248                 return -1;
 249         }
 250
 251         client->fh = fdopen(fd, "r+");
 252         if (! client->fh) {
 253                 char errbuf[1024];
 254                 sdb_log(SDB_LOG_ERR, "unixsock: Failed to open I/O "
 255                                 "stream for %s: %s", sa.sun_path,
 256                                 sdb_strerror(errno, errbuf, sizeof(errbuf)));
 257                 close(fd);
 258                 return -1;
 259         }
 260
 261         /* enable line-buffering */
 262         setvbuf(client->fh, NULL, _IOLBF, 0);
 263
 264         client->shutdown = 0;
 265         return 0;
 266 } /* sdb_unixsock_client_connect */
 267
 268 int
 269 sdb_unixsock_client_send(sdb_unixsock_client_t *client,
 270                 const char *msg)
 271 {
 272         int status;
 273
 274         if ((! client) || (! client->fh))
 275                 return -1;
 276
 277         if (client->shutdown & SDB_SHUT_WR) /* reconnect */
 278                 sdb_unixsock_client_connect(client);
 279
 280         status = fprintf(client->fh, "%s\r\n", msg);
 281         if (status < 0) {
 282                 char errbuf[1024];
 283                 sdb_log(SDB_LOG_ERR, "unixsock: Failed to write to "
 284                                 "socket (%s): %s", client->path,
 285                                 sdb_strerror(errno, errbuf, sizeof(errbuf)));
 286                 return status;
 287         }
 288         return status;
 289 } /* sdb_unixsock_client_send */
 290
 291 char *
 292 sdb_unixsock_client_recv(sdb_unixsock_client_t *client,
 293                 char *buffer, size_t buflen)
 294 {
 295         if ((! client) || (! client->fh) || (! buffer))
 296                 return NULL;
 297
 298         if (client->shutdown & SDB_SHUT_RD) /* reconnect */
 299                 sdb_unixsock_client_connect(client);
 300
 301         buffer = fgets(buffer, (int)buflen - 1, client->fh);
 302         if (! buffer) {
 303                 if (! feof(client->fh)) {
 304                         char errbuf[1024];
 305                         sdb_log(SDB_LOG_ERR, "unixsock: Failed to read "
 306                                         "from socket (%s): %s", client->path,
 307                                         sdb_strerror(errno, errbuf, sizeof(errbuf)));
 308                 }
 309                 return buffer;
 310         }
 311         buffer[buflen - 1] = '\0';
 312
 313         buflen = strlen(buffer);
 314         while ((buffer[buflen - 1] == '\n') || (buffer[buflen - 1] == '\r')) {
 315                 buffer[buflen - 1] = '\0';
 316                 --buflen;
 317         }
 318         return buffer;
 319 } /* sdb_unixsock_client_recv */
 320
 321 int
 322 sdb_unixsock_client_process_lines(sdb_unixsock_client_t *client,
 323                 sdb_unixsock_client_data_cb callback, sdb_object_t *user_data,
 324                 long int max_lines, const char *delim, int n_cols, ...)
 325 {
 326         int *types = NULL;
 327         int success = 0;
 328
 329         if ((! client) || (! client->fh) || (! callback))
 330                 return -1;
 331
 332         if (n_cols > 0) {
 333                 va_list ap;
 334                 int i;
 335
 336                 types = calloc((size_t)n_cols, sizeof(*types));
 337                 if (! types)
 338                         return -1;
 339
 340                 va_start(ap, n_cols);
 341
 342                 for (i = 0; i < n_cols; ++i) {
 343                         types[i] = va_arg(ap, int);
 344
 345                         if ((types[i] < 1) || (types[i] > SDB_TYPE_BINARY)) {
 346                                 sdb_log(SDB_LOG_ERR, "unixsock: Unknown column "
 347                                                 "type %i while processing response from the "
 348                                                 "UNIX socket @ %s.", types[i], client->path);
 349                                 va_end(ap);
 350                                 free(types);
 351                                 return -1;
 352                         }
 353                 }
 354
 355                 va_end(ap);
 356         }
 357
 358         while (42) {
 359                 char  buffer[1024];
 360                 char *line;
 361
 362                 int column_count;
 363
 364                 if (! max_lines)
 365                         break;
 366
 367                 if (max_lines > 0)
 368                         --max_lines;
 369
 370                 sdb_unixsock_client_clearerr(client);
 371                 line = sdb_unixsock_client_recv(client, buffer, sizeof(buffer));
 372
 373                 if (! line)
 374                         break;
 375
 376                 column_count = sdb_unixsock_get_column_count(line, delim);
 377
 378                 if ((n_cols >= 0) && (n_cols != column_count)) {
 379                         sdb_log(SDB_LOG_ERR, "unixsock: number of columns (%i) "
 380                                         "does not match the number of requested columns (%i) "
 381                                         "while processing response from the UNIX socket @ %s: %s",
 382                                         column_count, n_cols, client->path, line);
 383                         continue;
 384                 }
 385
 386                 if (column_count <= 0) /* no data */
 387                         continue;
 388
 389                 if (! sdb_unixsock_client_process_one_line(client, line, callback,
 390                                         user_data, delim, column_count, types))
 391                         ++success;
 392         }
 393
 394         free(types);
 395
 396         if ((max_lines > 0)
 397                         || ((max_lines < 0) && (! sdb_unixsock_client_eof(client)))
 398                         || sdb_unixsock_client_error(client)) {
 399                 char errbuf[1024];
 400                 sdb_log(SDB_LOG_ERR, "unixsock: Unexpected end of data while "
 401                                 "reading from socket (%s): %s", client->path,
 402                                 sdb_strerror(errno, errbuf, sizeof(errbuf)));
 403                 return -1;
 404         }
 405         if (! success)
 406                 return -1;
 407         return 0;
 408 } /* sdb_unixsock_client_process_lines */
 409
 410 int
 411 sdb_unixsock_client_shutdown(sdb_unixsock_client_t *client, int how)
 412 {
 413         int status;
 414
 415         if (! client) {
 416                 errno = ENOTSOCK;
 417                 return -1;
 418         }
 419
 420         fflush(client->fh);
 421         status = shutdown(fileno(client->fh), how);
 422
 423         if (! status) {
 424                 if (how == SHUT_RDWR)
 425                         client->shutdown |= SDB_SHUT_RDWR;
 426                 else
 427                         client->shutdown |= 1 << how;
 428         }
 429         return status;
 430 } /* sdb_unixsock_client_shutdown */
 431
 432 void
 433 sdb_unixsock_client_clearerr(sdb_unixsock_client_t *client)
 434 {
 435         if ((! client) || (! client->fh))
 436                 return;
 437         clearerr(client->fh);
 438 } /* sdb_unixsock_client_clearerr */
 439
 440 int
 441 sdb_unixsock_client_eof(sdb_unixsock_client_t *client)
 442 {
 443         if ((! client) || (! client->fh)) {
 444                 errno = EBADF;
 445                 return -1;
 446         }
 447         return feof(client->fh);
 448 } /* sdb_unixsock_client_eof */
 449
 450 int
 451 sdb_unixsock_client_error(sdb_unixsock_client_t *client)
 452 {
 453         if ((! client) || (! client->fh)) {
 454                 errno = EBADF;
 455                 return -1;
 456         }
 457         return ferror(client->fh);
 458 } /* sdb_unixsock_client_error */
 459
 460 void
 461 sdb_unixsock_client_destroy(sdb_unixsock_client_t *client)
 462 {
 463         if (! client)
 464                 return;
 465
 466         if (client->path)
 467                 free(client->path);
 468         client->path = NULL;
 469
 470         if (client->fh)
 471                 fclose(client->fh);
 472         client->fh = NULL;
 473
 474         free(client);
 475 } /* sdb_unixsock_client_destroy */
 476
 477 const char *
 478 sdb_unixsock_client_path(sdb_unixsock_client_t *client)
 479 {
 480         if (! client)
 481                 return NULL;
 482         return client->path;
 483 } /* sdb_unixsock_client_path */
 484
 485 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 486