QTfrontend/campaign.cpp
author nemo
Tue, 13 Apr 2021 15:40:11 -0400
changeset 15782 6409d756e9da
parent 15506 f315bb93db1f
permissions -rw-r--r--
bug #823 missing nil checks crasher introduced in r4aa19b21707d

/*
 * Hedgewars, a free turn based strategy game
 * Copyright (c) 2004-2015 Andrey Korotaev <unC0Rr@gmail.com>
 *
 * 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; version 2 of the License
 *
 * 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 St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#include "campaign.h"
#include "hwconsts.h"
#include "DataManager.h"
#include <QSettings>
#include <QObject>
#include <QLocale>

QSettings* getCampTeamFile(QString & campaignName, QString & teamName)
{
    QSettings* teamfile = new QSettings(cfgdir->absolutePath() + "/Teams/" + teamName + ".hwt", QSettings::IniFormat, 0);
    teamfile->setIniCodec("UTF-8");
    // if entry not found check if there is written without _
    // if then is found rename it to use _
    QString spaceCampName = campaignName;
    spaceCampName = spaceCampName.replace(QString("_"),QString(" "));
    if (!teamfile->childGroups().contains("Campaign " + campaignName) &&
            teamfile->childGroups().contains("Campaign " + spaceCampName)){
        teamfile->beginGroup("Campaign " + spaceCampName);
        QStringList keys = teamfile->childKeys();
        teamfile->endGroup();
        for (int i=0;i<keys.size();i++) {
            QVariant value = teamfile->value("Campaign " + spaceCampName + "/" + keys[i]);
            teamfile->setValue("Campaign " + campaignName + "/" + keys[i], value);
        }
        teamfile->remove("Campaign " + spaceCampName);
    }

    return teamfile;
}

/**
    Returns true if the specified mission has been completed
    campaignName: Name of the campaign in question
    missionInList: QComboBox index of the mission as selected in the mission widget
    teamName: Name of the playing team
*/
bool isCampMissionWon(QString & campaignName, int missionInList, QString & teamName)
{
    QSettings* teamfile = getCampTeamFile(campaignName, teamName);
    int progress = teamfile->value("Campaign " + campaignName + "/Progress", 0).toInt();
    int unlockedMissions = teamfile->value("Campaign " + campaignName + "/UnlockedMissions", 0).toInt();
    QSettings campfile("physfs://Missions/Campaign/" + campaignName + "/campaign.ini", QSettings::IniFormat, 0);
    campfile.setIniCodec("UTF-8");
    int totalMissions = campfile.value("MissionNum", 1).toInt();
    // The CowardMode cheat unlocks all campaign missions.
    // Added to make it easier to test campaigns.
    bool cheat = teamfile->value("Team/CowardMode", false).toBool();
    if(progress>0 && unlockedMissions==0)
    {
        int maxMission;
        if(cheat)
            maxMission = totalMissions - (missionInList + 1);
        else
            maxMission = progress - missionInList;
        return (progress > maxMission) || (progress >= totalMissions);
    }
    else if(unlockedMissions>0)
    {
        int fileMissionId = missionInList + 1;
        int actualMissionId;
        if(cheat)
            actualMissionId = totalMissions - missionInList;
        else
            actualMissionId = teamfile->value(QString("Campaign %1/Mission%2").arg(campaignName, QString::number(fileMissionId)), false).toInt();
        return teamfile->value(QString("Campaign %1/Mission%2Won").arg(campaignName, QString::number(actualMissionId)), false).toBool();
    }
    else
        return false;
}

/** Returns true if the campaign has been won by the team */
bool isCampWon(QString & campaignName, QString & teamName)
{
    QSettings* teamfile = getCampTeamFile(campaignName, teamName);
    bool won = teamfile->value("Campaign " + campaignName + "/Won", false).toBool();
    return won;
}

QSettings* getCampMetaInfo()
{
    DataManager & dataMgr = DataManager::instance();
    // get locale
    QSettings settings(dataMgr.settingsFileName(),
    QSettings::IniFormat);
    QString loc = QLocale().name();
    QString campaignDescFile = QString("physfs://Locale/campaigns_" + loc + ".txt");
    // if file is non-existant try with language only
    if (!QFile::exists(campaignDescFile))
    campaignDescFile = QString("physfs://Locale/campaigns_" + loc.remove(QRegExp("_.*$")) + ".txt");

    // fallback if file for current locale is non-existant
    if (!QFile::exists(campaignDescFile))
        campaignDescFile = QString("physfs://Locale/campaigns_en.txt");

    QSettings* m_info = new QSettings(campaignDescFile, QSettings::IniFormat, 0);
    m_info->setIniCodec("UTF-8");

    return m_info;
}

/** Returns the localized campaign name */
QString getRealCampName(const QString & campaignName)
{
    QString campaignNameSpaces = QString(campaignName).replace(QString("_"), QString(" "));
    return getCampMetaInfo()->value(campaignName+".name", campaignNameSpaces).toString();
}

QList<MissionInfo> getCampMissionList(QString & campaignName, QString & teamName)
{
    QList<MissionInfo> missionInfoList;
    QSettings* teamfile = getCampTeamFile(campaignName, teamName);

    int progress = teamfile->value("Campaign " + campaignName + "/Progress", 0).toInt();
    int unlockedMissions = teamfile->value("Campaign " + campaignName + "/UnlockedMissions", 0).toInt();
    bool cheat = teamfile->value("Team/CowardMode", false).toBool();

    QSettings campfile("physfs://Missions/Campaign/" + campaignName + "/campaign.ini", QSettings::IniFormat, 0);
    campfile.setIniCodec("UTF-8");

    QSettings* m_info = getCampMetaInfo();

    if(cheat)
    {
        progress = campfile.value("MissionNum", 1).toInt();
    }
    if((progress >= 0 && unlockedMissions == 0) || cheat)
    {
        for(unsigned int i = progress + 1; i > 0; i--)
        {
            MissionInfo missionInfo;
            QString script = campfile.value(QString("Mission %1/Script").arg(i)).toString();
            if(!script.isNull()) {
                missionInfo.script = script;
                missionInfo.name = campfile.value(QString("Mission %1/Name").arg(i)).toString();
                QString scriptPrefix = campaignName+"-"+ script.replace(QString(".lua"),QString(""));
                missionInfo.realName = m_info->value(scriptPrefix+".name", missionInfo.name).toString();
                missionInfo.description = m_info->value(scriptPrefix + ".desc",
                                            QObject::tr("No description available")).toString();
                QString image = campfile.value(QString("Mission %1/Script").arg(i)).toString().replace(QString(".lua"),QString("@2x.png"));
                missionInfo.image = "physfs://Graphics/Missions/Campaign/"+campaignName+"/"+image;
                if (!QFile::exists(missionInfo.image))
                    missionInfo.image = ":/res/CampaignDefault.png";
                missionInfoList.append(missionInfo);
            }
        }
    }
    else if(unlockedMissions>0)
    {
        for(int i=1;i<=unlockedMissions;i++)
        {
            QString missionNum = QString("%1").arg(i);
            int missionNumber = teamfile->value("Campaign " + campaignName + "/Mission"+missionNum, -1).toInt();
            MissionInfo missionInfo;
            QString script = campfile.value(QString("Mission %1/Script").arg(missionNumber)).toString();
            missionInfo.script = script;
            missionInfo.name = campfile.value(QString("Mission %1/Name").arg(missionNumber)).toString();
            QString scriptPrefix = campaignName+"-"+ script.replace(QString(".lua"),QString(""));
            missionInfo.realName = m_info->value(scriptPrefix+".name", missionInfo.name).toString();
            missionInfo.description = m_info->value(scriptPrefix + ".desc",
                                            QObject::tr("No description available")).toString();
            QString image = campfile.value(QString("Mission %1/Script").arg(missionNumber)).toString().replace(QString(".lua"),QString("@2x.png"));
            missionInfo.image = "physfs://Graphics/Missions/Campaign/"+campaignName+"/"+image;
            if (!QFile::exists(missionInfo.image))
                missionInfo.image = ":/res/CampaignDefault.png";
            missionInfoList.append(missionInfo);
        }
    }
    return missionInfoList;
}