cp_messages.cpp

Go to the documentation of this file.

/*
Copyright (C) 2002-2023 UFO: Alien Invasion.

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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#include "../../DateTime.h"
#include "../../cl_shared.h"
#include "cp_campaign.h"
#include "cp_popup.h"
#include "cp_messages.h"
#include "cp_time.h"
#include "save/save_messages.h"

char cp_messageBuffer[MAX_MESSAGE_TEXT];

static void MS_TimestampedText (char* text, uiMessageListNodeMessage_t* message, size_t textsize)
{
    dateLong_t date;
    CP_DateConvertLong(message->date, &date);
    Com_sprintf(text, textsize, _("%i %s %02i, %02i:%02i: "), date.year,
        Date_GetMonthName(date.month - 1), date.day, date.hour, date.min);
}

uiMessageListNodeMessage_t* MS_AddNewMessage (const char* title, const char* text, messageType_t type, technology_t* pedia, bool popup, bool playSound)
{
    assert(type < MSG_MAX);

    /* allocate memory for new message - delete this with every new game */
    uiMessageListNodeMessage_t* const mess = Mem_PoolAllocType(uiMessageListNodeMessage_t, cp_campaignPool);

    switch (type) {
    case MSG_DEBUG: 
        mess->iconName = "icons/message_debug";
        break;
    case MSG_INFO: 
        mess->iconName = "icons/message_info";
        break;
    case MSG_STANDARD:
        mess->iconName = "icons/message_info";
        break;
    case MSG_RESEARCH_PROPOSAL:
        mess->iconName = "icons/message_research";
        break;
    case MSG_RESEARCH_HALTED:
        mess->iconName = "icons/message_research";
        break;
    case MSG_RESEARCH_FINISHED:
        mess->iconName = "icons/message_research";
        break;
    case MSG_CONSTRUCTION:
        mess->iconName = "icons/message_construction";
        break;
    case MSG_UFOSPOTTED:
        mess->iconName = "icons/message_ufo";
        break;
    case MSG_TERRORSITE:
        mess->iconName = "icons/message_ufo";
        break;
    case MSG_BASEATTACK:
        mess->iconName = "icons/message_ufo";
        break;
    case MSG_TRANSFERFINISHED:
        mess->iconName = "icons/message_transfer";
        break;
    case MSG_PROMOTION:
        mess->iconName = "icons/message_promotion";
        break;
    case MSG_PRODUCTION:
        mess->iconName = "icons/message_production";
        break;
    case MSG_DEATH:
        mess->iconName = "icons/message_death";
        break;
    case MSG_CRASHSITE:
        mess->iconName = "icons/message_ufo";
        break;
    case MSG_EVENT:
        mess->iconName = "icons/message_info";
        break;
    default:
        mess->iconName = "icons/message_info";
        break;
    }

    /* push the new message at the beginning of the stack */
    cgi->UI_MessageAddStack(mess);

    mess->type = type;
    mess->pedia = pedia;        /* pointer to UFOpaedia entry */

    mess->date = ccs.date;

    Q_strncpyz(mess->title, title, sizeof(mess->title));
    mess->text = cgi->PoolStrDup(text, cp_campaignPool, 0);

    /* get formatted date text */
    MS_TimestampedText(mess->timestamp, mess, sizeof(mess->timestamp));

    /* they need to be translated already */
    if (popup) {
        CP_GameTimeStop();
        CP_Popup(mess->title, "%s", mess->text);
    }

    if (playSound) {
        const char* sound = nullptr;
        switch (type) {
        case MSG_DEBUG:
            break;
        case MSG_STANDARD:
            sound = "geoscape/standard";
            break;
        case MSG_INFO:
        case MSG_TRANSFERFINISHED:
        case MSG_DEATH:
        case MSG_CONSTRUCTION:
        case MSG_PRODUCTION:
            sound = "geoscape/info";
            break;
        case MSG_RESEARCH_PROPOSAL:
        case MSG_RESEARCH_FINISHED:
            assert(pedia);
        case MSG_RESEARCH_HALTED:
        case MSG_EVENT:
        case MSG_NEWS:
            /* reread the new mails in UP_GetUnreadMails */
            ccs.numUnreadMails = -1;
            sound = "geoscape/mail";
            break;
        case MSG_UFOLOST:
            sound = "geoscape/ufolost";
            break;
        case MSG_UFOSPOTTED:
            sound = "geoscape/ufospotted";
            break;
        case MSG_BASEATTACK:
            sound = "geoscape/basealert";
            break;
        case MSG_TERRORSITE:
            sound = "geoscape/alien-activity";
            break;
        case MSG_CRASHSITE:
            sound = "geoscape/newmission";
            break;
        case MSG_PROMOTION:
            sound = "geoscape/promotion";
            break;
        case MSG_MAX:
            break;
        }

        cgi->S_StartLocalSample(sound, 1.0f);
    }

    return mess;
}

static void MS_MessageSaveXML (xmlNode_t* p, uiMessageListNodeMessage_t* message)
{
    xmlNode_t* n;

    if (!message)
        return;

    /* bottom up */
    MS_MessageSaveXML(p, message->next);

    /* don't save these message types */
    if (message->type == MSG_INFO)
        return;

    cgi->Com_RegisterConstList(saveMessageConstants);
    n = cgi->XML_AddNode(p, SAVE_MESSAGES_MESSAGE);
    cgi->XML_AddString(n, SAVE_MESSAGES_TYPE, cgi->Com_GetConstVariable(SAVE_MESSAGETYPE_NAMESPACE, message->type));
    cgi->XML_AddStringValue(n, SAVE_MESSAGES_TITLE, message->title);
    cgi->XML_AddStringValue(n, SAVE_MESSAGES_TEXT, message->text);
    /* store script id of event mail */
    if (message->type == MSG_EVENT) {
        cgi->XML_AddString(n, SAVE_MESSAGES_EVENTMAILID, message->eventMail->id);
        cgi->XML_AddBoolValue(n, SAVE_MESSAGES_EVENTMAILREAD, message->eventMail->read);
    }
    if (message->pedia)
        cgi->XML_AddString(n, SAVE_MESSAGES_PEDIAID, message->pedia->id);
    cgi->XML_AddDate(n, SAVE_MESSAGES_DATE, message->date.getDateAsDays(), message->date.getTimeAsSeconds());
    cgi->Com_UnregisterConstList(saveMessageConstants);
}

bool MS_SaveXML (xmlNode_t* p)
{
    xmlNode_t* n = cgi->XML_AddNode(p, SAVE_MESSAGES_MESSAGES);

    /* store message system items */
    MS_MessageSaveXML(n, cgi->UI_MessageGetStack());
    return true;
}

bool MS_LoadXML (xmlNode_t* p)
{
    int i;
    xmlNode_t* n, *sn;
    n = cgi->XML_GetNode(p, SAVE_MESSAGES_MESSAGES);

    if (!n)
        return false;

    /* we have to set this a little bit higher here, otherwise the samples that are played when adding
     * a message to the stack would all played a few milliseconds after each other - that doesn't sound
     * nice */
    cgi->S_SetSampleRepeatRate(500);

    cgi->Com_RegisterConstList(saveMessageConstants);
    for (sn = cgi->XML_GetNode(n, SAVE_MESSAGES_MESSAGE), i = 0; sn; sn = cgi->XML_GetNextNode(sn, n, SAVE_MESSAGES_MESSAGE), i++) {
        eventMail_t* mail;
        const char* type = cgi->XML_GetString(sn, SAVE_MESSAGES_TYPE);
        int mtype;
        char title[MAX_VAR];
        char text[MAX_MESSAGE_TEXT];
        char id[MAX_VAR];
        technology_t* tech = nullptr;
        uiMessageListNodeMessage_t* mess;

        if (!cgi->Com_GetConstIntFromNamespace(SAVE_MESSAGETYPE_NAMESPACE, type, (int*) &mtype)) {
            cgi->Com_Printf("Invalid message type '%s'\n", type);
            continue;
        }

        /* can contain high bits due to utf8 */
        Q_strncpyz(title, cgi->XML_GetString(sn, SAVE_MESSAGES_TITLE), sizeof(title));
        Q_strncpyz(text,  cgi->XML_GetString(sn, SAVE_MESSAGES_TEXT),  sizeof(text));

        if (mtype == MSG_EVENT) {
            mail = CL_GetEventMail(cgi->XML_GetString(sn, SAVE_MESSAGES_EVENTMAILID));
            if (mail)
                mail->read = cgi->XML_GetBool(sn, SAVE_MESSAGES_EVENTMAILREAD, false);
        } else
            mail = nullptr;

        /* event and not mail means, dynamic mail - we don't save or load them */
        if (mtype == MSG_EVENT && !mail)
            continue;
        if (mtype == MSG_DEBUG && cgi->Cvar_GetInteger("developer") == 0)
            continue;

        Q_strncpyz(id, cgi->XML_GetString(sn, SAVE_MESSAGES_PEDIAID), sizeof(id));
        if (id[0] != '\0')
            tech = RS_GetTechByID(id);
        if (!tech && (mtype == MSG_RESEARCH_PROPOSAL || mtype == MSG_RESEARCH_FINISHED)) {
            continue;
        }
        mess = MS_AddNewMessage(title, text, (messageType_t)mtype, tech, false, false);
        mess->eventMail = mail;
        int date;
        int time;
        cgi->XML_GetDate(sn, SAVE_MESSAGES_DATE, &date, &time);
        mess->date = DateTime(date, time);
        /* redo timestamp text after setting date */
        MS_TimestampedText(mess->timestamp, mess, sizeof(mess->timestamp));

        if (mail) {
            dateLong_t date;
            char dateBuf[MAX_VAR] = "";

            CP_DateConvertLong(mess->date, &date);
            Com_sprintf(dateBuf, sizeof(dateBuf), _("%i %s %02i"),
                date.year, Date_GetMonthName(date.month - 1), date.day);
            mail->date = cgi->PoolStrDup(dateBuf, cp_campaignPool, 0);
        }
    }
    cgi->Com_UnregisterConstList(saveMessageConstants);

    /* reset the sample repeat rate */
    cgi->S_SetSampleRepeatRate(0);

    return true;
}

void MS_MessageInit (void)
{
    MSO_Init();
}