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

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