chiark - git - mdw - disorder/blob - lib/configuration.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20 /** @file lib/configuration.h
  21  * @brief Configuration file support
  22  */
  23
  24 #ifndef CONFIGURATION_H
  25 #define CONFIGURATION_H
  26
  27 #include "speaker-protocol.h"
  28
  29 struct real_pcre;
  30
  31 /* Configuration is kept in a @struct config@; the live configuration
  32  * is always pointed to by @config@.  Values in @config@ are UTF-8 encoded.
  33  */
  34
  35 /** @brief A list of strings */
  36 struct stringlist {
  37   /** @brief Number of strings */
  38   int n;
  39   /** @brief Array of strings */
  40   char **s;
  41 };
  42
  43 /** @brief A list of list of strings */
  44 struct stringlistlist {
  45   /** @brief Number of string lists */
  46   int n;
  47   /** @brief Array of string lists */
  48   struct stringlist *s;
  49 };
  50
  51 /** @brief A collection of tracks */
  52 struct collection {
  53   /** @brief Module that supports this collection */
  54   char *module;
  55   /** @brief Filename encoding */
  56   char *encoding;
  57   /** @brief Root directory */
  58   char *root;
  59 };
  60
  61 /** @brief A list of collections */
  62 struct collectionlist {
  63   /** @brief Number of collections */
  64   int n;
  65   /** @brief Array of collections */
  66   struct collection *s;
  67 };
  68
  69 struct namepart {
  70   char *part;                           /* part */
  71   struct real_pcre *re;                 /* regexp */
  72   char *replace;                        /* replacement string */
  73   char *context;                        /* context glob */
  74   unsigned reflags;                     /* regexp flags */
  75 };
  76
  77 struct namepartlist {
  78   int n;
  79   struct namepart *s;
  80 };
  81
  82 struct transform {
  83   char *type;                           /* track or dir */
  84   char *context;                        /* sort or choose */
  85   char *replace;                        /* substitution string */
  86   struct real_pcre *re;                 /* compiled re */
  87   unsigned flags;                       /* regexp flags */
  88 };
  89
  90 struct transformlist {
  91   int n;
  92   struct transform *t;
  93 };
  94
  95 /** @brief System configuration */
  96 struct config {
  97   /* server config */
  98
  99   /** @brief All players */
 100   struct stringlistlist player;
 101
 102   /** @brief Allowed users */
 103   struct stringlistlist allow;
 104
 105   /** @brief Scratch tracks */
 106   struct stringlist scratch;
 107
 108   /** @brief Gap between tracks in seconds */
 109   long gap;
 110
 111   /** @brief Maximum number of recent tracks to record in history */
 112   long history;
 113
 114   /** @brief Trusted users */
 115   struct stringlist trust;
 116
 117   /** @brief User for server to run as */
 118   const char *user;
 119
 120   /** @brief Nice value for rescan subprocess */
 121   long nice_rescan;
 122
 123   /** @brief Paths to search for plugins */
 124   struct stringlist plugins;
 125
 126   /** @brief List of stopwords */
 127   struct stringlist stopword;
 128
 129   /** @brief List of collections */
 130   struct collectionlist collection;
 131
 132   /** @brief Database checkpoint byte limit */
 133   long checkpoint_kbyte;
 134
 135   /** @brief Databsase checkpoint minimum */
 136   long checkpoint_min;
 137
 138   /** @brief Path to mixer device */
 139   char *mixer;
 140
 141   /** @brief Mixer channel to use */
 142   char *channel;
 143
 144   long prefsync;                        /* preflog sync interval */
 145
 146   /** @brief Secondary listen address */
 147   struct stringlist listen;
 148
 149   /** @brief Alias format string */
 150   const char *alias;
 151
 152   /** @brief Enable server locking */
 153   int lock;
 154
 155   /** @brief Nice value for server */
 156   long nice_server;
 157
 158   /** @brief Nice value for speaker */
 159   long nice_speaker;
 160
 161   /** @brief Command execute by speaker to play audio */
 162   const char *speaker_command;
 163
 164   /** @brief Target sample format */
 165   struct stream_header sample_format;
 166
 167   /** @brief Sox syntax generation */
 168   long sox_generation;
 169
 170   /** @brief Speaker backend
 171    *
 172    * Choices are @ref BACKEND_ALSA, @ref BACKEND_COMMAND or @ref
 173    * BACKEND_NETWORK.
 174    */
 175   int speaker_backend;
 176 #define BACKEND_ALSA 0                  /**< Use ALSA (Linux only) */
 177 #define BACKEND_COMMAND 1               /**< Execute a command */
 178 #define BACKEND_NETWORK 2               /**< Transmit RTP  */
 179
 180   /** @brief Home directory for state files */
 181   const char *home;
 182
 183   /** @brief Login username */
 184   const char *username;
 185
 186   /** @brief Login password */
 187   const char *password;
 188
 189   /** @brief Address to connect to */
 190   struct stringlist connect;
 191
 192   /** @brief Directories to search for web templates */
 193   struct stringlist templates;
 194
 195   /** @brief Canonical URL of web interface */
 196   const char *url;
 197
 198   /** @brief Maximum refresh interval for web interface (seconds) */
 199   long refresh;
 200
 201   /** @brief Facilities restricted to trusted users
 202    *
 203    * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
 204    * RESTRICT_MOVE.
 205    */
 206   unsigned restrictions;                /* restrictions */
 207 #define RESTRICT_SCRATCH 1              /**< Restrict scratching */
 208 #define RESTRICT_REMOVE 2               /**< Restrict removal */
 209 #define RESTRICT_MOVE 4                 /**< Restrict rearrangement */
 210
 211   /** @brief Target queue length */
 212   long queue_pad;
 213
 214   struct namepartlist namepart;         /* transformations */
 215
 216   /** @brief Termination signal for subprocesses */
 217   int signal;
 218
 219   /** @brief ALSA output device */
 220   const char *device;
 221   struct transformlist transform;       /* path name transformations */
 222
 223   /** @brief Address to send audio data to */
 224   struct stringlist broadcast;
 225
 226   /** @brief Source address for network audio transmission */
 227   struct stringlist broadcast_from;
 228
 229   /** @brief TTL for multicast packets */
 230   long multicast_ttl;
 231
 232   /* derived values: */
 233   int nparts;                           /* number of distinct name parts */
 234   char **parts;                         /* name part list  */
 235 };
 236
 237 extern struct config *config;
 238 /* the current configuration */
 239
 240 int config_read(void);
 241 /* re-read config, return 0 on success or non-0 on error.
 242  * Only updates @config@ if the new configuration is valid. */
 243
 244 char *config_get_file(const char *name);
 245 /* get a filename within the home directory */
 246
 247 struct passwd;
 248
 249 char *config_userconf(const char *home, const struct passwd *pw);
 250 /* get the user's own private conffile, assuming their home dir is
 251  * @home@ if not null and using @pw@ otherwise */
 252
 253 char *config_usersysconf(const struct passwd *pw );
 254 /* get the user's conffile in /etc */
 255
 256 char *config_private(void);
 257 /* get the private config file */
 258
 259 extern char *configfile;
 260
 261 #endif /* CONFIGURATION_H */
 262
 263 /*
 264 Local Variables:
 265 c-basic-offset:2
 266 comment-column:40
 267 End:
 268 */