mpd/src/CommandLine.cxx

407 lines
9.2 KiB
C++
Raw Normal View History

2008-12-27 19:03:33 +01:00
/*
2020-01-18 19:22:19 +01:00
* Copyright 2003-2020 The Music Player Daemon Project
2008-12-27 19:03:33 +01:00
* http://www.musicpd.org
*
* 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
* (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.
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2008-12-27 19:03:33 +01:00
*/
#include "config.h"
2013-01-03 17:31:38 +01:00
#include "CommandLine.hxx"
#include "GitVersion.hxx"
2013-01-03 17:34:51 +01:00
#include "ls.hxx"
#include "LogInit.hxx"
2013-01-09 22:33:06 +01:00
#include "Log.hxx"
2018-08-19 22:47:05 +02:00
#include "config/File.hxx"
2014-01-24 00:02:24 +01:00
#include "decoder/DecoderList.hxx"
#include "decoder/DecoderPlugin.hxx"
2014-01-28 11:42:54 +01:00
#include "output/Registry.hxx"
2014-01-23 23:49:50 +01:00
#include "output/OutputPlugin.hxx"
2014-01-24 16:18:21 +01:00
#include "input/Registry.hxx"
#include "input/InputPlugin.hxx"
2014-01-23 23:30:12 +01:00
#include "playlist/PlaylistRegistry.hxx"
#include "playlist/PlaylistPlugin.hxx"
#include "fs/AllocatedPath.hxx"
#include "fs/NarrowPath.hxx"
#include "fs/Traits.hxx"
#include "fs/FileSystem.hxx"
#include "fs/StandardDirectory.hxx"
#include "util/Domain.hxx"
#include "util/OptionDef.hxx"
#include "util/OptionParser.hxx"
#include "Version.h"
2008-12-27 19:03:33 +01:00
2019-07-05 09:59:00 +02:00
#ifdef _WIN32
#include "system/Error.hxx"
#endif
#ifdef ENABLE_DATABASE
#include "db/Registry.hxx"
#include "db/DatabasePlugin.hxx"
#include "storage/Registry.hxx"
#include "storage/StoragePlugin.hxx"
#endif
#ifdef ENABLE_NEIGHBOR_PLUGINS
#include "neighbor/Registry.hxx"
#include "neighbor/NeighborPlugin.hxx"
#endif
#include "encoder/Features.h"
#ifdef ENABLE_ENCODER
#include "encoder/EncoderList.hxx"
#include "encoder/EncoderPlugin.hxx"
#endif
2008-12-27 19:03:33 +01:00
#ifdef ENABLE_ARCHIVE
2014-01-24 00:09:37 +01:00
#include "archive/ArchiveList.hxx"
#include "archive/ArchivePlugin.hxx"
2008-12-27 19:03:33 +01:00
#endif
namespace {
#ifdef _WIN32
constexpr auto CONFIG_FILE_LOCATION = Path::FromFS(PATH_LITERAL("mpd\\mpd.conf"));
constexpr auto APP_CONFIG_FILE_LOCATION = Path::FromFS(PATH_LITERAL("conf\\mpd.conf"));
2013-10-15 08:33:44 +02:00
#else
constexpr auto USER_CONFIG_FILE_LOCATION1 = Path::FromFS(PATH_LITERAL(".mpdconf"));
constexpr auto USER_CONFIG_FILE_LOCATION2 = Path::FromFS(PATH_LITERAL(".mpd/mpd.conf"));
constexpr auto USER_CONFIG_FILE_LOCATION_XDG = Path::FromFS(PATH_LITERAL("mpd/mpd.conf"));
#endif
} // namespace
2008-12-27 19:03:33 +01:00
enum Option {
OPTION_KILL,
OPTION_NO_CONFIG,
OPTION_NO_DAEMON,
OPTION_STDOUT,
OPTION_STDERR,
OPTION_VERBOSE,
OPTION_VERSION,
OPTION_HELP,
OPTION_HELP2,
};
static constexpr OptionDef option_defs[] = {
{"kill", "kill the currently running mpd session"},
{"no-config", "don't read from config"},
{"no-daemon", "don't detach from console"},
{"stdout", nullptr}, // hidden, compatibility with old versions
{"stderr", "print messages to stderr"},
{"verbose", 'v', "verbose logging"},
{"version", 'V', "print version number"},
{"help", 'h', "show help options"},
{nullptr, '?', nullptr}, // hidden, standard alias for --help
};
static constexpr Domain cmdline_domain("cmdline");
[[noreturn]]
static void version()
2008-12-27 19:03:33 +01:00
{
printf("Music Player Daemon " VERSION " (%s)"
"\n"
2018-10-31 17:54:59 +01:00
"Copyright 2003-2007 Warren Dukes <warren.dukes@gmail.com>\n"
"Copyright 2008-2018 Max Kellermann <max.kellermann@gmail.com>\n"
"This is free software; see the source for copying conditions. There is NO\n"
"warranty; not even MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n",
GIT_VERSION);
#ifdef ENABLE_DATABASE
printf("\n"
"Database plugins:\n");
for (auto i = database_plugins; *i != nullptr; ++i)
printf(" %s", (*i)->name);
printf("\n\n"
"Storage plugins:\n");
for (auto i = storage_plugins; *i != nullptr; ++i)
printf(" %s", (*i)->name);
2014-12-08 18:30:02 +01:00
printf("\n");
#endif
#ifdef ENABLE_NEIGHBOR_PLUGINS
printf("\n"
"Neighbor plugins:\n");
for (auto i = neighbor_plugins; *i != nullptr; ++i)
printf(" %s", (*i)->name);
2014-12-08 18:30:02 +01:00
#endif
printf("\n"
2014-12-08 18:30:02 +01:00
"\n"
"Decoders plugins:\n");
2012-06-12 22:29:04 +02:00
decoder_plugins_for_each([](const DecoderPlugin &plugin){
printf(" [%s]", plugin.name);
2008-12-27 19:03:33 +01:00
const char *const*suffixes = plugin.suffixes;
if (suffixes != nullptr)
for (; *suffixes != nullptr; ++suffixes)
printf(" %s", *suffixes);
2008-12-27 19:03:33 +01:00
printf("\n");
});
2008-12-30 14:08:59 +01:00
printf("\n"
"Filters:\n"
#ifdef ENABLE_LIBSAMPLERATE
" libsamplerate"
#endif
#ifdef ENABLE_SOXR
" soxr"
#endif
"\n\n"
"Tag plugins:\n"
#ifdef ENABLE_ID3TAG
" id3tag"
#endif
"\n\n"
"Output plugins:\n");
2012-06-12 22:29:04 +02:00
audio_output_plugins_for_each(plugin)
printf(" %s", plugin->name);
2014-12-08 18:30:02 +01:00
printf("\n"
2008-12-27 19:03:33 +01:00
#ifdef ENABLE_ENCODER
2014-12-08 18:30:02 +01:00
"\n"
"Encoder plugins:\n");
2012-06-12 22:29:04 +02:00
encoder_plugins_for_each(plugin)
printf(" %s", plugin->name);
2014-12-08 18:30:02 +01:00
printf("\n"
#endif
2008-12-27 19:03:33 +01:00
#ifdef ENABLE_ARCHIVE
2014-12-08 18:30:02 +01:00
"\n"
"Archive plugins:\n");
2012-06-12 22:29:04 +02:00
archive_plugins_for_each(plugin) {
printf(" [%s]", plugin->name);
const char *const*suffixes = plugin->suffixes;
2013-10-19 18:19:03 +02:00
if (suffixes != nullptr)
for (; *suffixes != nullptr; ++suffixes)
2012-06-12 22:29:04 +02:00
printf(" %s", *suffixes);
printf("\n");
2012-06-12 22:29:04 +02:00
}
2014-12-08 18:30:02 +01:00
printf(""
2008-12-27 19:03:33 +01:00
#endif
2014-12-08 18:30:02 +01:00
"\n"
"Input plugins:\n"
" file"
#ifdef ENABLE_ARCHIVE
" archive"
#endif
);
2012-06-12 22:24:42 +02:00
input_plugins_for_each(plugin)
printf(" %s", plugin->name);
printf("\n\n"
"Playlist plugins:\n");
2012-06-12 19:59:03 +02:00
playlist_plugins_for_each(plugin)
printf(" %s", plugin->name);
printf("\n\n"
"Protocols:\n");
print_supported_uri_schemes_to_fp(stdout);
printf("\n"
"Other features:\n"
#ifdef HAVE_AVAHI
" avahi"
#endif
#ifdef ENABLE_DBUS
" dbus"
#endif
#ifdef ENABLE_UDISKS
" udisks"
#endif
#ifdef USE_EPOLL
" epoll"
#endif
#ifdef HAVE_ICONV
" iconv"
#endif
#ifdef HAVE_ICU
" icu"
#endif
#ifdef ENABLE_INOTIFY
" inotify"
#endif
#ifdef HAVE_IPV6
" ipv6"
#endif
#ifdef ENABLE_SYSTEMD_DAEMON
" systemd"
#endif
#ifdef HAVE_TCP
" tcp"
#endif
#ifdef HAVE_UN
" un"
#endif
"\n");
std::exit(EXIT_SUCCESS);
2008-12-27 19:03:33 +01:00
}
static void PrintOption(const OptionDef &opt)
{
if (opt.HasShortOption())
printf(" -%c, --%-12s%s\n",
opt.GetShortOption(),
opt.GetLongOption(),
opt.GetDescription());
else
printf(" --%-16s%s\n",
opt.GetLongOption(),
opt.GetDescription());
}
[[noreturn]]
static void help()
{
printf("Usage:\n"
" mpd [OPTION...] [path/to/mpd.conf]\n"
"\n"
"Music Player Daemon - a daemon for playing music.\n"
"\n"
"Options:\n");
for (const auto &i : option_defs)
if(i.HasDescription()) // hide hidden options from help print
PrintOption(i);
std::exit(EXIT_SUCCESS);
}
class ConfigLoader
{
2018-08-19 22:47:05 +02:00
ConfigData &config;
public:
2018-08-19 22:47:05 +02:00
explicit ConfigLoader(ConfigData &_config) noexcept
:config(_config) {}
bool TryFile(Path path);
bool TryFile(const AllocatedPath &base_path, Path path);
};
bool ConfigLoader::TryFile(Path path)
{
if (FileExists(path)) {
2018-08-19 22:47:05 +02:00
ReadConfigFile(config, path);
return true;
}
return false;
}
bool ConfigLoader::TryFile(const AllocatedPath &base_path, Path path)
{
if (base_path.IsNull())
return false;
auto full_path = base_path / path;
return TryFile(full_path);
}
void
2018-08-19 22:47:05 +02:00
ParseCommandLine(int argc, char **argv, struct options &options,
ConfigData &config)
2008-12-27 19:03:33 +01:00
{
bool use_config_file = true;
2008-12-27 19:03:33 +01:00
// First pass: handle command line options
OptionParser parser(option_defs, argc, argv);
while (auto o = parser.Next()) {
switch (Option(o.index)) {
case OPTION_KILL:
options.kill = true;
break;
case OPTION_NO_CONFIG:
use_config_file = false;
break;
case OPTION_NO_DAEMON:
options.daemon = false;
break;
case OPTION_STDOUT:
case OPTION_STDERR:
options.log_stderr = true;
break;
case OPTION_VERBOSE:
options.verbose = true;
break;
case OPTION_VERSION:
version();
2008-12-27 19:03:33 +01:00
case OPTION_HELP:
case OPTION_HELP2:
help();
}
}
/* initialize the logging library, so the configuration file
parser can use it already */
log_early_init(options.verbose);
if (!use_config_file) {
LogDebug(cmdline_domain,
"Ignoring config, using daemon defaults");
return;
}
// Second pass: find non-option parameters (i.e. config file)
const char *config_file = nullptr;
for (const char *i : parser.GetRemaining()) {
if (config_file == nullptr) {
config_file = i;
continue;
}
throw std::runtime_error("too many arguments");
}
if (config_file != nullptr) {
/* use specified configuration file */
ReadConfigFile(config, FromNarrowPath(config_file));
return;
}
/* use default configuration file path */
2018-08-19 22:47:05 +02:00
ConfigLoader loader(config);
bool found =
#ifdef _WIN32
loader.TryFile(GetUserConfigDir(), CONFIG_FILE_LOCATION) ||
loader.TryFile(GetSystemConfigDir(), CONFIG_FILE_LOCATION) ||
loader.TryFile(GetAppBaseDir(), APP_CONFIG_FILE_LOCATION);
#else
loader.TryFile(GetUserConfigDir(),
USER_CONFIG_FILE_LOCATION_XDG) ||
loader.TryFile(GetHomeDir(), USER_CONFIG_FILE_LOCATION1) ||
loader.TryFile(GetHomeDir(), USER_CONFIG_FILE_LOCATION2) ||
loader.TryFile(Path::FromFS(SYSTEM_CONFIG_FILE_LOCATION));
#endif
if (!found)
throw std::runtime_error("No configuration file found");
2008-12-27 19:03:33 +01:00
}