gamedemo.cpp

//------------------------------------------------------------------------------
// gamedemo.cpp
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2014 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#include "gamedemo.h"

#include "datapaths.h"
#include "fileutils.h"
#include "ini/ini.h"
#include "ini/settingsproviderqt.h"
#include "ntfsperm.h"
#include "templatedpathresolver.h"
#include "plugins/engineplugin.h"
#include "serverapi/serverstructs.h"
#include <cassert>
#include <QDateTime>
#include <QDir>
#include <QFileInfo>
#include <QMessageBox>

class GameDemoTr : public QObject
{
        Q_OBJECT;

public:
        static QString title()
        {
                return tr("Doomseeker - Record Demo");
        }

        static QString pathDoesntExist(const QString &path, const QString &details)
        {
                QString detailsMsg;
                if (!details.isEmpty())
                {
                        detailsMsg = QString("\n") + tr("Error: %1").arg(details);
                }
                return tr("The demo storage directory doesn't exist "
                        "and cannot be created!%1\n\n%2").arg(detailsMsg).arg(path);
        }

        static QString pathMissingPermissions(const QString &path)
        {
                return tr("The demo storage directory exists but "
                        "lacks the necessary permissions!\n\n%1").arg(path);
        }

private:
        GameDemoTr() = delete;
};

GameDemo::GameDemo()
{
        d.control = NoDemo;
}

GameDemo::GameDemo(Control control)
{
        d.control = control;
}

bool GameDemo::ensureStorageExists(QWidget *parent)
{
        auto popup = [parent](const QString &message) -> bool
        {
                return QMessageBox::Ignore ==
                        QMessageBox::warning(parent, GameDemoTr::title(), message,
                                QMessageBox::Abort | QMessageBox::Ignore);
        };

        QDir demoDir(gDefaultDataPaths->demosDirectoryPath());
        DirErrno mkResult = FileUtils::mkpath(demoDir);
        if (mkResult.isError())
        {
                return popup(GameDemoTr::pathDoesntExist(demoDir.path(), mkResult.errnoString));
        }

        QFileInfo demoDirInfo(demoDir.path());
        ++qt_ntfs_permission_lookup;
        bool permissions = demoDirInfo.isReadable()
                && demoDirInfo.isWritable()
                && demoDirInfo.isExecutable();
        --qt_ntfs_permission_lookup;
        if (!permissions)
        {
                return popup(GameDemoTr::pathMissingPermissions(demoDir.path()));
        }

        return true;
}

QString GameDemo::mkDemoFullPath(Control control, const EnginePlugin &plugin)
{
        switch (control)
        {
        case Managed:
                return QFileInfo(gDoomseekerTemplatedPathResolver().resolve(
                        gDefaultDataPaths->demosDirectoryPath()) + QDir::separator()
                        + mkDemoName(plugin)).absoluteFilePath();
        case Unmanaged:
                return mkDemoName(plugin);
        case NoDemo:
                return QString();
        default:
                assert(0 && "Unknown demo control type");
                return QString();
        }
}

QString GameDemo::mkDemoName(const EnginePlugin &plugin)
{
        QString demoName = "";
        demoName += QString("%1_%2").
                arg(plugin.data()->name).
                arg(QDateTime::currentDateTime().toString("dd.MM.yyyy_hh.mm.ss"));
        if (!plugin.data()->demoExtensionAutomatic)
                demoName += QString(".%1").arg(plugin.data()->demoExtension);
        return demoName;
}

void GameDemo::saveDemoMetaData(const QString &demoName, const EnginePlugin &plugin,
        const QString &iwad, const QList<PWad> &pwads)
{
        QString metaFileName;
        // If the extension is automatic we need to add it here
        if (plugin.data()->demoExtensionAutomatic)
        {
                metaFileName = QString("%1.%2.ini").arg(demoName)
                        .arg(plugin.data()->demoExtension);
        }
        else
                metaFileName = demoName + ".ini";

        QSettings settings(metaFileName, QSettings::IniFormat);
        SettingsProviderQt settingsProvider(&settings);
        Ini metaFile(&settingsProvider);
        IniSection metaSection = metaFile.section("meta");

        QStringList requiredPwads;
        QStringList optionalPwads;

        for (const PWad &wad : pwads)
        {
                if (wad.isOptional())
                        optionalPwads << wad.name();
                else
                        requiredPwads << wad.name();
        }

        metaSection.createSetting("iwad", iwad.toLower());
        metaSection.createSetting("pwads", requiredPwads.join(";"));
        metaSection.createSetting("optionalPwads", optionalPwads);
}

GameDemo::operator GameDemo::Control() const
{
        return d.control;
}

#include "gamedemo.moc"