X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/bd8895a87731c72190ea2012f36583f796d4181a..53a4a6fdcc52280765216ff019cf77b85ec48c18:/lib/configuration.h diff --git a/lib/configuration.h b/lib/configuration.h index f965bbd..284ae7a 100644 --- a/lib/configuration.h +++ b/lib/configuration.h @@ -1,21 +1,19 @@ /* * This file is part of DisOrder. - * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell + * Copyright (C) 2004-2011, 2013 Richard Kettlewell * - * This program is free software; you can redistribute it and/or modify + * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 - * USA + * along with this program. If not, see . */ /** @file lib/configuration.h * @brief Configuration file support @@ -25,9 +23,11 @@ #define CONFIGURATION_H #include "speaker-protocol.h" +#include "regexp.h" #include "rights.h" +#include "addr.h" -struct real_pcre; +struct uaudio; /* Configuration is kept in a @struct config@; the live configuration * is always pointed to by @config@. Values in @config@ are UTF-8 encoded. @@ -67,27 +67,32 @@ struct collectionlist { struct collection *s; }; +/** @brief A track name part */ struct namepart { char *part; /* part */ - struct real_pcre *re; /* regexp */ + regexp *re; /* compiled regexp */ + char *res; /* regexp as a string */ char *replace; /* replacement string */ char *context; /* context glob */ unsigned reflags; /* regexp flags */ }; +/** @brief A list of track name parts */ struct namepartlist { int n; struct namepart *s; }; +/** @brief A track name transform */ struct transform { char *type; /* track or dir */ char *context; /* sort or choose */ char *replace; /* substitution string */ - struct real_pcre *re; /* compiled re */ + regexp *re; /* compiled re */ unsigned flags; /* regexp flags */ }; +/** @brief A list of track name transforms */ struct transformlist { int n; struct transform *t; @@ -106,24 +111,15 @@ struct config { /** @brief All tracklength plugins */ struct stringlistlist tracklength; - /** @brief Allowed users */ - struct stringlistlist allow; - /** @brief Scratch tracks */ struct stringlist scratch; - /** @brief Gap between tracks in seconds */ - long gap; - /** @brief Maximum number of recent tracks to record in history */ long history; /** @brief Expiry limit for noticed.db */ long noticed_history; - /** @brief Trusted users */ - struct stringlist trust; - /** @brief User for server to run as */ const char *user; @@ -151,17 +147,12 @@ struct config { /** @brief Mixer channel to use */ char *channel; - long prefsync; /* preflog sync interval */ - /** @brief Secondary listen address */ - struct stringlist listen; + struct netaddress listen; /** @brief Alias format string */ const char *alias; - /** @brief Enable server locking */ - int lock; - /** @brief Nice value for server */ long nice_server; @@ -171,35 +162,37 @@ struct config { /** @brief Command execute by speaker to play audio */ const char *speaker_command; + /** @brief Pause mode for command backend */ + const char *pause_mode; + /** @brief Target sample format */ struct stream_header sample_format; /** @brief Sox syntax generation */ long sox_generation; - /** @brief API used to play sound - * - * Choices are @ref BACKEND_ALSA, @ref BACKEND_COMMAND or @ref - * BACKEND_NETWORK. - */ - int api; -#define BACKEND_ALSA 0 /**< Use ALSA (Linux only) */ -#define BACKEND_COMMAND 1 /**< Execute a command */ -#define BACKEND_NETWORK 2 /**< Transmit RTP */ -#define BACKEND_COREAUDIO 3 /**< Use Core Audio (Mac only) */ -#define BACKEND_OSS 4 /**< Use OSS */ + /** @brief API used to play sound */ + const char *api; + + /** @brief Maximum size of a playlist */ + long playlist_max; + /** @brief Maximum lifetime of a playlist lock */ + long playlist_lock_timeout; + +#if !_WIN32 /** @brief Home directory for state files */ const char *home; +#endif /** @brief Login username */ - const char *username; + char *username; /** @brief Login password */ - const char *password; + char *password; /** @brief Address to connect to */ - struct stringlist connect; + struct netaddress connect; /** @brief Directories to search for web templates */ struct stringlist templates; @@ -213,19 +206,15 @@ struct config { /** @brief Maximum refresh interval for web interface (seconds) */ long refresh; - /** @brief Facilities restricted to trusted users - * - * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref - * RESTRICT_MOVE. - */ - unsigned restrictions; /* restrictions */ -#define RESTRICT_SCRATCH 1 /**< Restrict scratching */ -#define RESTRICT_REMOVE 2 /**< Restrict removal */ -#define RESTRICT_MOVE 4 /**< Restrict rearrangement */ + /** @brief Minimum refresh interval for web interface (seconds) */ + long refresh_min; /** @brief Target queue length */ long queue_pad; + /** @brief Minimum time between a track being played again */ + long replay_min; + struct namepartlist namepart; /* transformations */ /** @brief Termination signal for subprocesses */ @@ -233,20 +222,65 @@ struct config { /** @brief ALSA output device */ const char *device; + struct transformlist transform; /* path name transformations */ /** @brief Address to send audio data to */ - struct stringlist broadcast; + struct netaddress broadcast; /** @brief Source address for network audio transmission */ - struct stringlist broadcast_from; + struct netaddress broadcast_from; + + /** @brief RTP delay threshold */ + long rtp_delay_threshold; + + /** @brief Whether to ignore the server's suggested RTP arrangement and + * always request a unicast stream */ + int rtp_always_request; + + /** @brief RTP buffer low-water mark */ + long rtp_minbuffer; + + /** @brief RTP buffer maximum size */ + long rtp_maxbuffer; + + /** @brief RTP receive buffer size */ + long rtp_rcvbuf; + + /** @brief Fixed RTP listening address */ + struct netaddress rtp_request_address; + /** @brief @c disorder-playrtp instance name (for naming sockets etc.) */ + char *rtp_instance_name; + + /** @brief Verbose RTP transmission logging */ + int rtp_verbose; + /** @brief TTL for multicast packets */ long multicast_ttl; /** @brief Whether to loop back multicast packets */ int multicast_loop; + /** @brief Maximum size of RTP payload to send + * + * This is the maximum number of bytes we pass to write(2); to determine + * actual packet sizes, add a UDP header and an IP header (and a link layer + * header if it's the link layer size you care about). + * + * Don't make this too big or arithmetic will start to overflow. + */ + long rtp_max_payload; + + /** @brief Whether to allow MTU discovery + * + * This is `yes' to force it on, `no' to force it off, or `default' to do + * whatever the system is configured to do. Note that this only has a + * useful effect in IPv4, since IPv6 doesn't permit hop-by-hop + * fragmentation. + */ + char *rtp_mtu_discovery; + /** @brief Login lifetime in seconds */ long cookie_login_lifetime; @@ -256,12 +290,36 @@ struct config { /** @brief Default rights for a new user */ char *default_rights; + /** @brief Path to sendmail executable */ + char *sendmail; + /** @brief SMTP server for sending mail */ char *smtp_server; /** @brief Origin address for outbound mail */ char *mail_sender; - + + /** @brief Maximum number of tracks in response to 'new' */ + long new_max; + + /** @brief Minimum interval between password reminder emails */ + long reminder_interval; + + /** @brief Whether to allow user management over TCP */ + int remote_userman; + + /** @brief Maximum age of biased-up tracks */ + long new_bias_age; + + /** @brief Maximum bias */ + long new_bias; + + /** @brief Rescan on (un)mount */ + int mount_rescan; + + /** @brief RTP mode */ + const char *rtp_mode; + /* derived values: */ int nparts; /* number of distinct name parts */ char **parts; /* name part list */ @@ -273,10 +331,12 @@ struct config { extern struct config *config; /* the current configuration */ -int config_read(int server); +int config_read(int server, + const struct config *oldconfig); /* re-read config, return 0 on success or non-0 on error. * Only updates @config@ if the new configuration is valid. */ +char *config_get_file2(struct config *c, const char *name); char *config_get_file(const char *name); /* get a filename within the home directory */ @@ -292,9 +352,15 @@ char *config_usersysconf(const struct passwd *pw ); char *config_private(void); /* get the private config file */ +int config_verify(void); + +void config_free(struct config *c); + extern char *configfile; extern int config_per_user; +extern const struct uaudio *const *config_uaudio_apis; + #endif /* CONFIGURATION_H */ /*