Transaction Logging

The transaction logging mechanism provides a very simple, low-level logging of user input to a file. More...

Files
file	TransLog.h
	API for the transaction logger.

Functions
void	xaccOpenLog (void)
void	xaccCloseLog (void)
void	xaccReopenLog (void)
void	xaccTransWriteLog (Transaction *trans, char flag)
void	xaccLogEnable (void)
	document me
void	xaccLogDisable (void)
	document me
void	xaccLogSetBaseName (const char *)
	The xaccLogSetBaseName() method sets the base filepath and the root part of the journal file name.
gboolean	xaccFileIsCurrentLog (const gchar *name)
	Test a filename to see if it is the name of the current logfile.

Detailed Description

The transaction logging mechanism provides a very simple, low-level logging of user input to a file.

The goal of the transaction logger is to provide mechanism of last resort for recovering lost user data in the event of a crash.

Ideally, the storage backends should provide a robust journaling, logging and crash-recovery mechanism. But just in case they don't, or it didn't work, this mechanism provides a "Plan B" by providing a low-tech, fool-proof, simple logging system that can be used to recover user input. There are some simple command-line tools that will read a log and replay it.

Function Documentation

xaccCloseLog()

void xaccCloseLog

(

void

)

Definition at line 211 of file TransLog.cpp.

{
    if (!trans_log_stream.is_open()) return;
    trans_log_stream.flush();
    trans_log_stream.close();
}

xaccFileIsCurrentLog()

gboolean xaccFileIsCurrentLog

(

const gchar *

name

)

Test a filename to see if it is the name of the current logfile.

Definition at line 141 of file TransLog.cpp.

{
    gchar *base;
 
    if (!name || trans_log_name.empty())
        return FALSE;
 
    base = g_path_get_basename(name);
    bool result = trans_log_name.compare(base) == 0;
    g_free(base);
    return result;
}

xaccLogDisable()

void xaccLogDisable

(

void

)

document me

Definition at line 96 of file TransLog.cpp.

{
    gen_logs = 0;
}

xaccLogEnable()

void xaccLogEnable

(

void

)

document me

Definition at line 100 of file TransLog.cpp.

{
    gen_logs = 1;
}

xaccLogSetBaseName()

void xaccLogSetBaseName

(

const char *

basepath

)

The xaccLogSetBaseName() method sets the base filepath and the root part of the journal file name.

If the journal file is already open, it will close it and reopen it with the new base name.

Definition at line 120 of file TransLog.cpp.

{
    if (!basepath) return;
 
    log_base_name = basepath;
 
    if (trans_log_stream.is_open())
    {
        xaccCloseLog();
        xaccOpenLog();
    }
}

xaccOpenLog()

void xaccOpenLog

(

void

)

Definition at line 158 of file TransLog.cpp.

{
    char * filename;
    char * timestamp;
 
    if (!gen_logs)
    {
     PINFO ("Attempt to open disabled transaction log");
     return;
    }
    if (trans_log_stream.is_open()) return;
 
    if (log_base_name.empty())
        log_base_name = "translog";
 
    /* tag each filename with a timestamp */
    timestamp = gnc_date_timestamp ();
 
    filename = g_strconcat (log_base_name.c_str(), ".", timestamp, ".log", nullptr);
 
    trans_log_stream.open(filename, std::ios::app);
    if (!trans_log_stream.is_open())
    {
        int norr = errno;
        printf ("Error: xaccOpenLog(): cannot open journal\n"
                "\t %d %s\n", norr, g_strerror (norr) ? g_strerror (norr) : "");
 
        g_free (filename);
        g_free (timestamp);
        return;
    }
 
    /* Save the log file name */
    auto tmpstr = g_path_get_basename(filename);
    trans_log_name = tmpstr;
    g_free (tmpstr);
 
    g_free (filename);
    g_free (timestamp);
 
    /*  Note: this must match src/import-export/log-replay/gnc-log-replay.c */
    trans_log_stream << "mod\ttrans_guid\tsplit_guid\ttime_now\t"
                     << "date_entered\tdate_posted\t"
                     << "acc_guid\tacc_name\tnum\tdescription\t"
                     << "notes\tmemo\taction\treconciled\t"
                     << "amount\tvalue\tdate_reconciled\n"
                     << "-----------------\n";
}

xaccReopenLog()

void xaccReopenLog

(

void

)

Definition at line 109 of file TransLog.cpp.

{
    if (trans_log_stream.is_open())
    {
        xaccCloseLog();
        xaccOpenLog();
    }
}

xaccTransWriteLog()

void xaccTransWriteLog	(	Transaction *	trans,
		char	flag
	)

Parameters

trans

The transaction to write out to the log

flag

The engine currently uses the log mechanism with flag char set as follows: 'B' for 'begin edit' (followed by the transaction as it looks before any changes, i.e. the 'old value') 'D' for delete (i.e. delete the previous B; echoes the data in the 'old B') 'C' for commit (i.e. accept a previous B; data that follows is the 'new value') 'R' for rollback (i.e. revert to previous B; data that follows should be identical to old B)

Definition at line 222 of file TransLog.cpp.

{
    GList *node;
    char trans_guid_str[GUID_ENCODING_LENGTH + 1];
    char split_guid_str[GUID_ENCODING_LENGTH + 1];
    const char *trans_notes;
    char dnow[100], dent[100], dpost[100], drecn[100];
 
    if (!gen_logs)
    {
         PINFO ("Attempt to write disabled transaction log");
     return;
    }
    if (!trans_log_stream.is_open()) return;
 
    gnc_time64_to_iso8601_buff (gnc_time(nullptr), dnow);
    gnc_time64_to_iso8601_buff (trans->date_entered, dent);
    gnc_time64_to_iso8601_buff (trans->date_posted, dpost);
    guid_to_string_buff (xaccTransGetGUID(trans), trans_guid_str);
    trans_notes = xaccTransGetNotes(trans);
    trans_log_stream << "===== START\n";
 
    for (node = trans->splits; node; node = node->next)
    {
        Split *split = GNC_SPLIT(node->data);
        const char * accname = "";
        char acc_guid_str[GUID_ENCODING_LENGTH + 1];
        gnc_numeric amt, val;
 
        if (xaccSplitGetAccount(split))
        {
            accname = xaccAccountGetName (xaccSplitGetAccount(split));
            guid_to_string_buff(xaccAccountGetGUID(xaccSplitGetAccount(split)),
                                acc_guid_str);
        }
        else
        {
            acc_guid_str[0] = '\0';
        }
 
        gnc_time64_to_iso8601_buff (split->date_reconciled, drecn);
 
        guid_to_string_buff (xaccSplitGetGUID(split), split_guid_str);
        amt = xaccSplitGetAmount (split);
        val = xaccSplitGetValue (split);
 
        trans_log_stream << flag << '\t'
                         << trans_guid_str << '\t'
                         << split_guid_str << '\t'
                         << dnow << '\t'
                         << dent << '\t'
                         << dpost << '\t'
                         << acc_guid_str << '\t'
                         << (accname ? accname : "") << '\t'
                         << (trans->num ? trans->num : "") << '\t'
                         << (trans->description ? trans->description : "") << '\t'
                         << (trans_notes ? trans_notes : "") << '\t'
                         << (split->memo ? split->memo : "") << '\t'
                         << (split->action ? split->action : "") << '\t'
                         << split->reconciled << '\t'
                         << gnc_numeric_num(amt) << '/' << gnc_numeric_denom(amt) << '\t'
                         << gnc_numeric_num(val) << '/' << gnc_numeric_denom(val) << '\t'
                         << drecn << '\n';
    }
 
    trans_log_stream << "===== END" << std::endl;
}