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

   1
   2 /*
   3  * This file is part of DisOrder.
   4  * Copyright (C) 2004-2008 Richard Kettlewell
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19  * USA
  20  */
  21 /** @file lib/configuration.h
  22  * @brief Configuration file support
  23  */
  24
  25 #ifndef CONFIGURATION_H
  26 #define CONFIGURATION_H
  27
  28 #include <pcre.h>
  29
  30 #include "speaker-protocol.h"
  31 #include "rights.h"
  32
  33 /* Configuration is kept in a @struct config@; the live configuration
  34  * is always pointed to by @config@.  Values in @config@ are UTF-8 encoded.
  35  */
  36
  37 /** @brief A list of strings */
  38 struct stringlist {
  39   /** @brief Number of strings */
  40   int n;
  41   /** @brief Array of strings */
  42   char **s;
  43 };
  44
  45 /** @brief A list of list of strings */
  46 struct stringlistlist {
  47   /** @brief Number of string lists */
  48   int n;
  49   /** @brief Array of string lists */
  50   struct stringlist *s;
  51 };
  52
  53 /** @brief A collection of tracks */
  54 struct collection {
  55   /** @brief Module that supports this collection */
  56   char *module;
  57   /** @brief Filename encoding */
  58   char *encoding;
  59   /** @brief Root directory */
  60   char *root;
  61 };
  62
  63 /** @brief A list of collections */
  64 struct collectionlist {
  65   /** @brief Number of collections */
  66   int n;
  67   /** @brief Array of collections */
  68   struct collection *s;
  69 };
  70
  71 struct namepart {
  72   char *part;                           /* part */
  73   pcre *re;                             /* regexp */
  74   char *replace;                        /* replacement string */
  75   char *context;                        /* context glob */
  76   unsigned reflags;                     /* regexp flags */
  77 };
  78
  79 struct namepartlist {
  80   int n;
  81   struct namepart *s;
  82 };
  83
  84 struct transform {
  85   char *type;                           /* track or dir */
  86   char *context;                        /* sort or choose */
  87   char *replace;                        /* substitution string */
  88   pcre *re;                             /* compiled re */
  89   unsigned flags;                       /* regexp flags */
  90 };
  91
  92 struct transformlist {
  93   int n;
  94   struct transform *t;
  95 };
  96
  97 /** @brief System configuration */
  98 struct config {
  99   /* server config */
 100
 101   /** @brief Authorization algorithm */
 102   char *authorization_algorithm;
 103
 104   /** @brief All players */
 105   struct stringlistlist player;
 106
 107   /** @brief All tracklength plugins */
 108   struct stringlistlist tracklength;
 109
 110   /** @brief Allowed users */
 111   struct stringlistlist allow;
 112
 113   /** @brief Scratch tracks */
 114   struct stringlist scratch;
 115
 116   /** @brief Gap between tracks in seconds */
 117   long gap;
 118
 119   /** @brief Maximum number of recent tracks to record in history */
 120   long history;
 121
 122   /** @brief Expiry limit for noticed.db */
 123   long noticed_history;
 124
 125   /** @brief Trusted users */
 126   struct stringlist trust;
 127
 128   /** @brief User for server to run as */
 129   const char *user;
 130
 131   /** @brief Nice value for rescan subprocess */
 132   long nice_rescan;
 133
 134   /** @brief Paths to search for plugins */
 135   struct stringlist plugins;
 136
 137   /** @brief List of stopwords */
 138   struct stringlist stopword;
 139
 140   /** @brief List of collections */
 141   struct collectionlist collection;
 142
 143   /** @brief Database checkpoint byte limit */
 144   long checkpoint_kbyte;
 145
 146   /** @brief Databsase checkpoint minimum */
 147   long checkpoint_min;
 148
 149   /** @brief Path to mixer device */
 150   char *mixer;
 151
 152   /** @brief Mixer channel to use */
 153   char *channel;
 154
 155   long prefsync;                        /* preflog sync interval */
 156
 157   /** @brief Secondary listen address */
 158   struct stringlist listen;
 159
 160   /** @brief Alias format string */
 161   const char *alias;
 162
 163   /** @brief Enable server locking */
 164   int lock;
 165
 166   /** @brief Nice value for server */
 167   long nice_server;
 168
 169   /** @brief Nice value for speaker */
 170   long nice_speaker;
 171
 172   /** @brief Command execute by speaker to play audio */
 173   const char *speaker_command;
 174
 175   /** @brief Target sample format */
 176   struct stream_header sample_format;
 177
 178   /** @brief Sox syntax generation */
 179   long sox_generation;
 180
 181   /** @brief API used to play sound
 182    *
 183    * Choices are @ref BACKEND_ALSA, @ref BACKEND_COMMAND or @ref
 184    * BACKEND_NETWORK.
 185    */
 186   int api;
 187
 188 /* These values had better be non-negative */
 189 #define BACKEND_ALSA 0                  /**< Use ALSA (Linux only) */
 190 #define BACKEND_COMMAND 1               /**< Execute a command */
 191 #define BACKEND_NETWORK 2               /**< Transmit RTP  */
 192 #define BACKEND_COREAUDIO 3             /**< Use Core Audio (Mac only) */
 193 #define BACKEND_OSS 4                   /**< Use OSS */
 194
 195 #if HAVE_ALSA_ASOUNDLIB_H
 196 # define DEFAULT_BACKEND BACKEND_ALSA
 197 #elif HAVE_SYS_SOUNDCARD_H || EMPEG_HOST
 198 # define DEFAULT_BACKEND BACKEND_OSS
 199 #elif HAVE_COREAUDIO_AUDIOHARDWARE_H
 200 # define DEFAULT_BACKEND BACKEND_COREAUDIO
 201 #else
 202 # error Cannot choose a default backend
 203 #endif
 204
 205   /** @brief Home directory for state files */
 206   const char *home;
 207
 208   /** @brief Login username */
 209   const char *username;
 210
 211   /** @brief Login password */
 212   const char *password;
 213
 214   /** @brief Address to connect to */
 215   struct stringlist connect;
 216
 217   /** @brief Directories to search for web templates */
 218   struct stringlist templates;
 219
 220   /** @brief Canonical URL of web interface */
 221   char *url;
 222
 223   /** @brief Short display limit */
 224   long short_display;
 225
 226   /** @brief Maximum refresh interval for web interface (seconds) */
 227   long refresh;
 228
 229   /** @brief Facilities restricted to trusted users
 230    *
 231    * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
 232    * RESTRICT_MOVE.
 233    */
 234   unsigned restrictions;                /* restrictions */
 235 #define RESTRICT_SCRATCH 1              /**< Restrict scratching */
 236 #define RESTRICT_REMOVE 2               /**< Restrict removal */
 237 #define RESTRICT_MOVE 4                 /**< Restrict rearrangement */
 238
 239   /** @brief Target queue length */
 240   long queue_pad;
 241
 242   /** @brief Minimum time between a track being played again */
 243   long replay_min;
 244
 245   struct namepartlist namepart;         /* transformations */
 246
 247   /** @brief Termination signal for subprocesses */
 248   int signal;
 249
 250   /** @brief ALSA output device */
 251   const char *device;
 252   struct transformlist transform;       /* path name transformations */
 253
 254   /** @brief Address to send audio data to */
 255   struct stringlist broadcast;
 256
 257   /** @brief Source address for network audio transmission */
 258   struct stringlist broadcast_from;
 259
 260   /** @brief TTL for multicast packets */
 261   long multicast_ttl;
 262
 263   /** @brief Whether to loop back multicast packets */
 264   int multicast_loop;
 265
 266   /** @brief Login lifetime in seconds */
 267   long cookie_login_lifetime;
 268
 269   /** @brief Signing key lifetime in seconds */
 270   long cookie_key_lifetime;
 271
 272   /** @brief Default rights for a new user */
 273   char *default_rights;
 274
 275   /** @brief Path to sendmail executable */
 276   char *sendmail;
 277
 278   /** @brief SMTP server for sending mail */
 279   char *smtp_server;
 280
 281   /** @brief Origin address for outbound mail */
 282   char *mail_sender;
 283
 284   /** @brief Maximum number of tracks in response to 'new' */
 285   long new_max;
 286
 287   /** @brief Minimum interval between password reminder emails */
 288   long reminder_interval;
 289
 290   /** @brief Whether to allow user management over TCP */
 291   int remote_userman;
 292
 293   /** @brief Maximum age of biased-up tracks */
 294   long new_bias_age;
 295
 296   /** @brief Maximum bias */
 297   long new_bias;
 298
 299   /* derived values: */
 300   int nparts;                           /* number of distinct name parts */
 301   char **parts;                         /* name part list  */
 302
 303   /* undocumented, for testing only */
 304   long dbversion;
 305 };
 306
 307 extern struct config *config;
 308 /* the current configuration */
 309
 310 int config_read(int server);
 311 /* re-read config, return 0 on success or non-0 on error.
 312  * Only updates @config@ if the new configuration is valid. */
 313
 314 char *config_get_file(const char *name);
 315 /* get a filename within the home directory */
 316
 317 struct passwd;
 318
 319 char *config_userconf(const char *home, const struct passwd *pw);
 320 /* get the user's own private conffile, assuming their home dir is
 321  * @home@ if not null and using @pw@ otherwise */
 322
 323 char *config_usersysconf(const struct passwd *pw );
 324 /* get the user's conffile in /etc */
 325
 326 char *config_private(void);
 327 /* get the private config file */
 328
 329 extern char *configfile;
 330 extern int config_per_user;
 331
 332 #endif /* CONFIGURATION_H */
 333
 334 /*
 335 Local Variables:
 336 c-basic-offset:2
 337 comment-column:40
 338 End:
 339 */