akonadictl/main.cpp

/***************************************************************************
 *   SPDX-FileCopyrightText: 2007 Tobias Koenig <tokoe@kde.org>            *
 *                                                                         *
 *   SPDX-License-Identifier: LGPL-2.0-or-later                            *
 ***************************************************************************/
 
#include <QCoreApplication>
#include <QDBusConnection>
#include <QDir>
#include <QPluginLoader>
#include <QSettings>
#include <QString>
#include <QStringList>
 
#include <KAboutData>
#include <KLocalizedString>
 
#include "shared/akapplication.h"
 
#include "akonadifull-version.h"
#include "akonadistarter.h"
#include "controlmanagerinterface.h"
#include "janitorinterface.h"
 
#include "private/dbus_p.h"
#include "private/instance_p.h"
#include "private/protocol_p.h"
#include "private/standarddirs_p.h"
 
#include <chrono>
#include <iostream>
#include <thread>
 
using namespace Qt::Literals;
 
static bool startServer(bool verbose)
{
    if (QDBusConnection::sessionBus().interface()->isServiceRegistered(Akonadi::DBus::serviceName(Akonadi::DBus::Control))
        || QDBusConnection::sessionBus().interface()->isServiceRegistered(Akonadi::DBus::serviceName(Akonadi::DBus::Server))) {
        std::cerr << "Akonadi is already running." << std::endl;
        return false;
    }
    AkonadiStarter starter;
    return starter.start(verbose);
}
 
static bool stopServer()
{
    org::freedesktop::Akonadi::ControlManager iface(Akonadi::DBus::serviceName(Akonadi::DBus::Control),
                                                    QStringLiteral("/ControlManager"),
                                                    QDBusConnection::sessionBus(),
                                                    nullptr);
    if (!iface.isValid()) {
        std::cerr << "Akonadi is not running." << std::endl;
        return false;
    }
 
    iface.shutdown();
 
    return true;
}
 
static bool isAkonadiServerRunning()
{
    return QDBusConnection::sessionBus().interface()->isServiceRegistered(Akonadi::DBus::serviceName(Akonadi::DBus::Server));
}
 
static bool checkAkonadiControlStatus()
{
    const bool registered = QDBusConnection::sessionBus().interface()->isServiceRegistered(Akonadi::DBus::serviceName(Akonadi::DBus::Control));
    std::cerr << "Akonadi Control: " << (registered ? "running" : "stopped") << std::endl;
    return registered;
}
 
static bool checkAkonadiServerStatus()
{
    const bool registered = isAkonadiServerRunning();
    std::cerr << "Akonadi Server: " << (registered ? "running" : "stopped") << std::endl;
    return registered;
}
 
static bool checkSearchSupportStatus()
{
    QStringList searchMethods{QStringLiteral("Remote Search")};
 
    const QString pluginOverride = QString::fromLatin1(qgetenv("AKONADI_OVERRIDE_SEARCHPLUGIN"));
    if (!pluginOverride.isEmpty()) {
        searchMethods << pluginOverride;
    } else {
        const QStringList dirs = QCoreApplication::libraryPaths();
        for (const QString &pluginDir : dirs) {
            const QDir dir(pluginDir + QLatin1StringView("/akonadi/"));
            const QStringList pluginFiles = dir.entryList(QDir::Files);
            for (const QString &pluginFileName : pluginFiles) {
                QPluginLoader loader(dir.absolutePath() + QLatin1Char('/') + pluginFileName);
                const QVariantMap metadata = loader.metaData().value(QStringLiteral("MetaData")).toVariant().toMap();
                if (metadata.value(QStringLiteral("X-Akonadi-PluginType")).toString() != QLatin1StringView("SearchPlugin")) {
                    continue;
                }
                if (!metadata.value(QStringLiteral("X-Akonadi-LoadByDefault"), true).toBool()) {
                    continue;
                }
                searchMethods << metadata.value(QStringLiteral("X-Akonadi-PluginName")).toString();
            }
        }
    }
 
    // There's always at least server-search available
    std::cerr << "Akonadi Server Search Support: available (" << searchMethods.join(QLatin1StringView(", ")).toStdString() << ")" << std::endl;
    return true;
}
 
static bool checkAvailableAgentTypes()
{
    const auto dirs = Akonadi::StandardDirs::locateAllResourceDirs(QStringLiteral("akonadi/agents"));
    QStringList types;
    for (const QString &pluginDir : dirs) {
        const QDir dir(pluginDir);
        const QStringList plugins = dir.entryList(QStringList() << QStringLiteral("*.desktop"), QDir::Files);
        for (const QString &plugin : plugins) {
            QSettings pluginInfo(pluginDir + QLatin1Char('/') + plugin, QSettings::IniFormat);
            pluginInfo.beginGroup(QStringLiteral("Desktop Entry"));
            types << pluginInfo.value(QStringLiteral("X-Akonadi-Identifier")).toString();
        }
    }
 
    // Remove duplicates from multiple pluginDirs
    types.removeDuplicates();
    types.sort();
 
    std::cerr << "Available Agent Types: ";
    if (types.isEmpty()) {
        std::cerr << "No agent types found!" << std::endl;
    } else {
        std::cerr << types.join(QLatin1StringView(", ")).toStdString() << std::endl;
    }
 
    return true;
}
 
static bool instanceRunning(const QString &instanceName = {})
{
    const auto oldInstance = Akonadi::Instance::identifier();
    Akonadi::Instance::setIdentifier(instanceName);
    const auto service = Akonadi::DBus::serviceName(Akonadi::DBus::Control);
    Akonadi::Instance::setIdentifier(oldInstance);
 
    return QDBusConnection::sessionBus().interface()->isServiceRegistered(service);
}
 
static void listInstances()
{
    struct Instance {
        QString name;
        bool running;
    };
    QList<Instance> instances{{QStringLiteral("(default)"), instanceRunning()}};
#ifdef Q_OS_WIN
    const QDir instanceDir(QStandardPaths::writableLocation(QStandardPaths::GenericConfigLocation) + QStringLiteral("/akonadi/config/instance"));
#else
    const QDir instanceDir(QStandardPaths::writableLocation(QStandardPaths::ConfigLocation) + QStringLiteral("/akonadi/instance"));
#endif
    if (instanceDir.exists()) {
        const auto list = instanceDir.entryList(QDir::Dirs | QDir::NoDotAndDotDot);
        for (const auto &e : list) {
            instances.push_back({e, instanceRunning(e)});
        }
    }
 
    for (const auto &i : std::as_const(instances)) {
        std::cout << i.name.toStdString();
        if (i.running) {
            std::cout << " (running)";
        }
        std::cout << std::endl;
    }
}
 
static bool statusServer()
{
    checkAkonadiControlStatus();
    checkAkonadiServerStatus();
    checkSearchSupportStatus();
    checkAvailableAgentTypes();
    return true;
}
 
static void runJanitor(const QString &operation)
{
    if (!isAkonadiServerRunning()) {
        std::cerr << "Akonadi Server is not running, " << operation.toStdString() << " will not run" << std::endl;
        return;
    }
 
    org::freedesktop::Akonadi::Janitor janitor(Akonadi::DBus::serviceName(Akonadi::DBus::StorageJanitor),
                                               QStringLiteral(AKONADI_DBUS_STORAGEJANITOR_PATH),
                                               QDBusConnection::sessionBus());
    QObject::connect(&janitor, &org::freedesktop::Akonadi::Janitor::information, &janitor, [](const QString &msg) {
        std::cout << msg.toStdString() << std::endl;
    });
    QObject::connect(&janitor, &org::freedesktop::Akonadi::Janitor::done, &janitor, []() {
        qApp->exit();
    });
    janitor.asyncCall(operation);
    qApp->exec();
}
 
static void waitForShutdown()
{
    do {
        std::this_thread::sleep_for(std::chrono::milliseconds(100));
    } while (QDBusConnection::sessionBus().interface()->isServiceRegistered(Akonadi::DBus::serviceName(Akonadi::DBus::Control)));
}
 
int main(int argc, char **argv)
{
    AkCoreApplication app(argc, argv);
 
    app.setDescription(
        i18n("Akonadi server manipulation tool\n\n"
             "Commands:\n"
             "  start          Starts the Akonadi server with all its processes\n"
             "  stop           Stops the Akonadi server and all its processes cleanly\n"
             "  restart        Restart Akonadi server with all its processes\n"
             "  status         Shows a status overview of the Akonadi server\n"
             "  instances      List all existing Akonadi instances\n"
             "  vacuum         Vacuum internal storage (WARNING: needs a lot of time and disk\n"
             "                 space!)\n"
             "  fsck           Check (and attempt to fix) consistency of the internal storage\n"
             "                 (can take some time)"));
 
    KAboutData aboutData(QStringLiteral("akonadictl"),
                         QStringLiteral("akonadictl"),
                         QStringLiteral(AKONADI_FULL_VERSION),
                         QStringLiteral("akonadictl"),
                         KAboutLicense::LGPL_V2);
    KAboutData::setApplicationData(aboutData);
 
    app.addCommandLineOptions({u"wait"_s, i18n("Wait for server shutdown to complete.")});
    app.addPositionalCommandLineOption(QStringLiteral("command"),
                                       i18n("Command to execute"),
                                       QStringLiteral("start|stop|restart|status|vacuum|fsck|instances"));
 
    app.parseCommandLine();
 
    const auto &cmdArgs = app.commandLineArguments();
    const QStringList commands = cmdArgs.positionalArguments();
    if (commands.size() != 1) {
        app.printUsage();
        return -1;
    }
    const bool verbose = cmdArgs.isSet(QStringLiteral("verbose"));
 
    const QString command = commands[0];
    if (command == QLatin1StringView("start")) {
        if (!startServer(verbose)) {
            return 3;
        }
    } else if (command == QLatin1StringView("stop")) {
        if (!stopServer()) {
            return 4;
        }
        if (cmdArgs.isSet(u"wait"_s)) {
            waitForShutdown();
        }
    } else if (command == QLatin1StringView("status")) {
        if (!statusServer()) {
            return 5;
        }
    } else if (command == QLatin1StringView("restart")) {
        if (!stopServer()) {
            return 4;
        } else {
            waitForShutdown();
            if (!startServer(verbose)) {
                return 3;
            }
        }
    } else if (command == QLatin1StringView("vacuum")) {
        runJanitor(QStringLiteral("vacuum"));
    } else if (command == QLatin1StringView("fsck")) {
        runJanitor(QStringLiteral("check"));
    } else if (command == QLatin1StringView("instances")) {
        listInstances();
    } else {
        app.printUsage();
        return -1;
    }
    return 0;
}