ledger/reports.cc
John Wiegley 03b05b44c2 changes
2004-04-10 08:33:15 +00:00

740 lines
19 KiB
C++

#include "ledger.h"
#define LEDGER_VERSION "1.3"
#include <fstream>
#include <unistd.h>
namespace ledger {
static bool cleared_only = false;
static bool show_virtual = true;
static bool get_quotes = false;
static bool show_children = false;
static bool show_sorted = false;
static bool show_empty = false;
static bool show_subtotals = true;
static bool full_names = false;
static std::time_t begin_date;
static bool have_beginning = false;
static std::time_t end_date;
static bool have_ending = false;
static struct std::tm date_mask;
static bool have_date_mask = false;
static bool matches_date_range(entry * ent)
{
if (have_beginning && difftime(ent->date, begin_date) < 0)
return false;
if (have_ending && difftime(ent->date, end_date) >= 0)
return false;
if (have_date_mask) {
struct std::tm * then = std::localtime(&ent->date);
if (date_mask.tm_mon != -1 &&
date_mask.tm_mon != then->tm_mon)
return false;
if (date_mask.tm_mday != -1 &&
date_mask.tm_mday != then->tm_mday)
return false;
#if 0
// jww (2003-10-10): This causes only certain days of the week to
// print, even when it was not included in the mask.
if (date_mask.tm_wday != -1 &&
date_mask.tm_wday != then->tm_wday)
return false;
#endif
if (date_mask.tm_year != -1 &&
date_mask.tm_year != then->tm_year)
return false;
}
return true;
}
//////////////////////////////////////////////////////////////////////
//
// Balance reporting code
//
static void display_total(std::ostream& out, totals& balance,
account * acct, bool top_level,
int * headlines)
{
bool displayed = false;
if (acct->checked == 1 &&
(show_empty || ! acct->balance.is_zero())) {
displayed = true;
acct->balance.print(out, 20);
if (show_subtotals && top_level)
balance.credit(acct->balance);
if (acct->parent && ! full_names && ! top_level) {
for (const account * a = acct; a; a = a->parent)
out << " ";
out << acct->name << std::endl;
} else {
out << " " << acct->as_str() << std::endl;
(*headlines)++;
}
}
// Display balances for all child accounts
for (accounts_map_iterator i = acct->children.begin();
i != acct->children.end();
i++)
display_total(out, balance, (*i).second, ! displayed, headlines);
}
void report_balances(std::ostream& out, regexps_map& regexps)
{
// Walk through all of the ledger entries, computing the account
// totals
for (entries_list_iterator i = main_ledger->entries.begin();
i != main_ledger->entries.end();
i++) {
if ((cleared_only && ! (*i)->cleared) || ! matches_date_range(*i))
continue;
for (std::list<transaction *>::iterator x = (*i)->xacts.begin();
x != (*i)->xacts.end();
x++) {
if (! show_virtual && (*x)->is_virtual)
continue;
for (account * acct = (*x)->acct;
acct;
acct = show_subtotals ? acct->parent : NULL) {
if (acct->checked == 0) {
if (regexps.empty()) {
if (! (show_children || ! acct->parent))
acct->checked = 2;
else
acct->checked = 1;
}
else {
bool by_exclusion = false;
bool match = matches(regexps, acct->as_str(),
&by_exclusion);
if (! match) {
acct->checked = 2;
}
else if (by_exclusion) {
if (! (show_children || ! acct->parent))
acct->checked = 2;
else
acct->checked = 1;
}
else {
acct->checked = 1;
}
}
}
if (acct->checked == 1) {
amount * street = (*x)->cost->street(get_quotes);
acct->balance.credit(street);
delete street;
}
}
}
}
// Walk through all the top-level accounts, giving the balance
// report for each, and then for each of their children.
totals balance;
int headlines = 0;
for (accounts_map_iterator i = main_ledger->accounts.begin();
i != main_ledger->accounts.end();
i++)
display_total(out, balance, (*i).second, true, &headlines);
// Print the total of all the balances shown
if (show_subtotals && headlines > 1) {
out << "--------------------" << std::endl;
balance.print(out, 20);
out << std::endl;
}
}
//////////////////////////////////////////////////////////////////////
//
// Register printing code
//
static std::string truncated(const std::string& str, int width)
{
char buf[256];
memset(buf, '\0', 255);
std::strncpy(buf, str.c_str(), width);
if (buf[width - 1])
std::strcpy(&buf[width - 3], "...");
else
buf[width] = '\0';
return buf;
}
void print_register(const std::string& acct_name, std::ostream& out,
regexps_map& regexps)
{
mask acct_regex(acct_name);
// Walk through all of the ledger entries, printing their register
// formatted equivalent
totals balance;
for (entries_list_iterator i = main_ledger->entries.begin();
i != main_ledger->entries.end();
i++) {
if ((! have_beginning && ! have_ending && ! have_date_mask &&
! (cleared_only ? (*i)->cleared : ! (*i)->cleared)) ||
! matches_date_range(*i) || ! (*i)->matches(regexps))
continue;
for (std::list<transaction *>::iterator x = (*i)->xacts.begin();
x != (*i)->xacts.end();
x++) {
if (! acct_regex.match((*x)->acct->as_str()))
continue;
char buf[32];
std::strftime(buf, 31, "%m.%d ", std::localtime(&(*i)->date));
out << buf;
#if 0
if ((*i)->cleared)
out << "* ";
else
out << " ";
out.width(4);
if ((*i)->code.empty())
out << " ";
else
out << std::left << (*i)->code;
#endif
out << " ";
out.width(25);
if ((*i)->desc.empty())
out << " ";
else
out << std::left << truncated((*i)->desc, 25);
out << " ";
// Always display the street value, if prices have been
// specified
amount * street = (*x)->cost->street(get_quotes);
balance.credit(street);
// If there are two transactions, use the one which does not
// refer to this account. If there are more than two, we will
// just have to print all of the splits, like gnucash does.
transaction * xact;
if ((*i)->xacts.size() == 2) {
if (*x == (*i)->xacts.front())
xact = (*i)->xacts.back();
else
xact = (*i)->xacts.front();
} else {
xact = *x;
}
std::string xact_str = xact->acct_as_str();
if (xact == *x && ! show_subtotals)
xact_str = "<Splits...>";
out.width(22);
out << std::left << truncated(xact_str, 22) << " ";
out.width(12);
out << std::right << street->as_str(true);
delete street;
balance.print(out, 12);
out << std::endl;
if (! show_subtotals || xact != *x)
continue;
for (std::list<transaction *>::iterator y = (*i)->xacts.begin();
y != (*i)->xacts.end();
y++) {
if (*x == *y)
continue;
out << " ";
out.width(22);
out << std::left << truncated((*y)->acct_as_str(), 22) << " ";
out.width(12);
street = (*y)->cost->street(get_quotes);
out << std::right << street->as_str(true) << std::endl;
delete street;
}
}
}
}
//////////////////////////////////////////////////////////////////////
//
// Create an Equity file based on a ledger. This is used for
// archiving past years, and starting out a new year with compiled
// balances.
//
static void equity_entry(account * acct, regexps_map& regexps,
std::ostream& out)
{
if (! acct->balance.is_zero() &&
(regexps.empty() || matches(regexps, acct->as_str()))) {
entry opening(main_ledger);
opening.date = std::time(NULL);
opening.cleared = true;
opening.desc = "Opening Balance";
transaction * xact;
for (totals::const_iterator i = acct->balance.amounts.begin();
i != acct->balance.amounts.end();
i++) {
// Skip it, if there is a zero balance for the commodity
if ((*i).second->is_zero())
continue;
xact = new transaction();
xact->acct = const_cast<account *>(acct);
xact->cost = (*i).second->street(get_quotes);
opening.xacts.push_back(xact);
xact = new transaction();
xact->acct = main_ledger->find_account("Equity:Opening Balances");
xact->cost = (*i).second->street(get_quotes);
xact->cost->negate();
opening.xacts.push_back(xact);
}
opening.print(out);
}
// Display balances for all child accounts
for (accounts_map_iterator i = acct->children.begin();
i != acct->children.end();
i++)
equity_entry((*i).second, regexps, out);
}
void equity_ledger(std::ostream& out, regexps_map& regexps)
{
// The account have their current totals already generated as a
// result of parsing. We just have to output those values.
// totals
for (accounts_map_iterator i = main_ledger->accounts.begin();
i != main_ledger->accounts.end();
i++)
equity_entry((*i).second, regexps, out);
}
// Add a new entry, using hueristic logic to simplify the entry
// requirements
void add_new_entry(int index, int argc, char **argv)
{
regexps_map regexps;
entry added(main_ledger);
entry * matching = NULL;
assert(index < argc);
if (! parse_date(argv[index++], &added.date)) {
std::cerr << "Error: Bad entry date: " << argv[index - 1]
<< std::endl;
std::exit(1);
}
added.cleared = cleared_only;
if (index == argc) {
std::cerr << "Error: Too few arguments to 'entry'." << std::endl;
std::exit(1);
}
regexps.clear();
regexps.push_back(mask(argv[index++]));
for (entries_list_reverse_iterator i = main_ledger->entries.rbegin();
i != main_ledger->entries.rend();
i++) {
if ((*i)->matches(regexps)) {
matching = *i;
break;
}
}
added.desc = matching ? matching->desc : regexps.front().pattern;
if (index == argc) {
std::cerr << "Error: Too few arguments to 'entry'." << std::endl;
std::exit(1);
}
if (argv[index][0] == '-' || std::isdigit(argv[index][0])) {
if (! matching) {
std::cerr << "Error: Missing account name for non-matching entry."
<< std::endl;
std::exit(1);
}
transaction * m_xact, * xact, * first;
m_xact = matching->xacts.front();
first = xact = new transaction();
xact->acct = m_xact->acct;
xact->cost = create_amount(argv[index++]);
xact->cost->set_commdty(m_xact->cost->commdty());
added.xacts.push_back(xact);
m_xact = matching->xacts.back();
xact = new transaction();
xact->acct = m_xact->acct;
xact->cost = first->cost->copy();
xact->cost->negate();
added.xacts.push_back(xact);
if ((index + 1) < argc && std::string(argv[index]) == "-from")
if (account * acct = main_ledger->re_find_account(argv[++index]))
added.xacts.back()->acct = acct;
} else {
while (index < argc && std::string(argv[index]) != "-from") {
transaction * xact = new transaction();
mask acct_regex(argv[index++]);
account * acct = NULL;
commodity * cmdty = NULL;
for (std::list<transaction *>::iterator x = matching->xacts.begin();
x != matching->xacts.end();
x++) {
if (acct_regex.match((*x)->acct->as_str())) {
acct = (*x)->acct;
cmdty = (*x)->cost->commdty();
break;
}
}
if (acct)
xact->acct = acct;
else
xact->acct = main_ledger->re_find_account(acct_regex.pattern);
if (! xact->acct) {
std::cerr << "Error: Could not find account name '"
<< acct_regex.pattern << "'." << std::endl;
std::exit(1);
}
if (index == argc) {
std::cerr << "Error: Too few arguments to 'entry'." << std::endl;
std::exit(1);
}
xact->cost = create_amount(argv[index++]);
if (! xact->cost->commdty())
xact->cost->set_commdty(cmdty);
added.xacts.push_back(xact);
}
if ((index + 1) < argc && std::string(argv[index]) == "-from") {
if (account * acct = main_ledger->re_find_account(argv[++index])) {
transaction * xact = new transaction();
xact->acct = acct;
xact->cost = NULL;
added.xacts.push_back(xact);
}
} else {
transaction * xact = new transaction();
xact->acct = matching->xacts.back()->acct;
xact->cost = NULL;
added.xacts.push_back(xact);
}
}
if (added.finalize())
added.print(std::cout);
}
// Print out the entire ledger that was read in. This can be used to
// "wash" ugly ledger files. It's written here, instead of ledger.cc,
// in order to access the static globals above.
void book::print(std::ostream& out, regexps_map& regexps,
bool shortcut) const
{
for (entries_list_const_iterator i = entries.begin();
i != entries.end();
i++) {
if (! matches_date_range(*i) || ! (*i)->matches(regexps))
continue;
(*i)->print(out, shortcut);
}
}
} // namespace ledger
using namespace ledger;
static void show_help(std::ostream& out)
{
std::cerr
<< "usage: ledger [options] COMMAND [options] [REGEXPS]" << std::endl
<< std::endl
<< "ledger options:" << std::endl
<< " -b DATE specify a beginning date" << std::endl
<< " -e DATE specify an ending date" << std::endl
<< " -c do not show future entries (same as -e TODAY)" << std::endl
<< " -C also show cleared transactions" << std::endl
<< " -d DATE specify a date mask ('-d mon', for all mondays)" << std::endl
<< " -f FILE specify pathname of ledger data file" << std::endl
<< " -F print each account's full name" << std::endl
<< " -h display this help text" << std::endl
<< " -i FILE read the list of inclusion regexps from FILE" << std::endl
<< " -n do not generate totals for parent accounts" << std::endl
<< " -p ARG set a price, or read prices from a file" << std::endl
<< " -P download price quotes from the Internet" << std::endl
<< " (works by running the command \"getquote SYMBOL\")" << std::endl
<< " -R do not factor in virtual transactions" << std::endl
<< " -s show sub-accounts in balance totals" << std::endl
<< " -S show empty accounts in balance totals" << std::endl
<< " -v display version information" << std::endl << std::endl
<< "commands:" << std::endl
<< " balance show balance totals" << std::endl
<< " register display a register for ACCOUNT" << std::endl
<< " print print all ledger entries" << std::endl
<< " equity generate equity ledger for all entries" << std::endl;
}
//////////////////////////////////////////////////////////////////////
//
// Command-line parser and top-level logic.
//
int main(int argc, char * argv[])
{
std::istream * file = NULL;
std::string prices;
regexps_map regexps;
int index;
// Parse the command-line options
int c;
while (-1 != (c = getopt(argc, argv, "+b:e:d:cChRV:f:i:p:PvsSEnF"))) {
switch (char(c)) {
case 'b':
have_beginning = true;
if (! parse_date(optarg, &begin_date)) {
std::cerr << "Error: Bad begin date: " << optarg << std::endl;
std::exit(1);
}
break;
case 'e':
have_ending = true;
if (! parse_date(optarg, &end_date)) {
std::cerr << "Error: Bad end date: " << optarg << std::endl;
std::exit(1);
}
break;
case 'c':
end_date = std::time(NULL);
have_ending = true;
break;
case 'd':
have_date_mask = true;
if (! parse_date_mask(optarg, &date_mask)) {
std::cerr << "Error: Bad date mask: " << optarg << std::endl;
std::exit(1);
}
break;
case 'h': show_help(std::cout); break;
case 'f': file = new std::ifstream(optarg); break;
case 'C': cleared_only = true; break;
case 'R': show_virtual = false; break;
case 's': show_children = true; break;
case 'S': show_sorted = true; break;
case 'E': show_empty = true; break;
case 'n': show_subtotals = false; break;
case 'F': full_names = true; break;
// -i path-to-file-of-regexps
case 'i':
read_regexps(optarg, regexps);
break;
// -p "COMMODITY=PRICE"
// -p path-to-price-database
case 'p':
prices = optarg;
break;
case 'P':
get_quotes = true;
break;
case 'v':
std::cout
<< "Ledger Accouting Tool " LEDGER_VERSION << std::endl
<< " Copyright (c) 2003 John Wiegley <johnw@newartisans.com>"
<< std::endl << std::endl
<< "This program is made available under the terms of the BSD"
<< std::endl
<< "Public License. See the LICENSE file included with the"
<< std::endl
<< "distribution for details and disclaimer." << std::endl;
return 0;
}
}
if (optind == argc) {
show_help(std::cout);
std::exit(1);
}
index = optind;
// A ledger data file must be specified
if (! file) {
const char * p = std::getenv("LEDGER");
if (p)
file = new std::ifstream(p);
if (! file || ! *file) {
std::cerr << ("Please specify ledger file using -f option "
"or LEDGER environment variable.")
<< std::endl;
std::exit(1);
}
}
// Read the command word
const std::string command = argv[index++];
int name_index = index;
if (command == "register" || command == "reg") {
if (optind == argc) {
std::cerr << ("Error: Must specify an account name "
"after the 'register' command.") << std::endl;
std::exit(1);
}
index++;
}
// Compile the list of specified regular expressions, which can be
// specified after the command, or using the '-i FILE' option
if (command != "entry")
for (; index < argc; index++)
regexps.push_back(mask(argv[index]));
// Parse the ledger
#ifdef READ_GNUCASH
char buf[32];
file->get(buf, 31);
file->seekg(0);
if (std::strncmp(buf, "<?xml version=\"1.0\"?>", 21) == 0)
main_ledger = parse_gnucash(*file, command == "equity");
else
#endif
main_ledger = parse_ledger(*file, regexps, command == "equity");
delete file;
if (! main_ledger)
std::exit(1);
// Record any prices specified by the user
if (! prices.empty()) {
if (access(prices.c_str(), R_OK) != -1) {
std::ifstream pricedb(prices.c_str());
while (! pricedb.eof()) {
char buf[80];
pricedb.getline(buf, 79);
if (*buf && ! std::isspace(*buf))
parse_price_setting(buf);
}
} else {
parse_price_setting(prices);
}
}
// Process the command
if (command == "balance" || command == "bal") {
report_balances(std::cout, regexps);
}
else if (command == "register" || command == "reg") {
if (show_sorted)
main_ledger->sort(cmp_entry_date());
print_register(argv[name_index], std::cout, regexps);
}
else if (command == "print") {
if (show_sorted)
main_ledger->sort(cmp_entry_date());
main_ledger->print(std::cout, regexps, ! full_names);
}
else if (command == "equity") {
equity_ledger(std::cout, regexps);
}
else if (command == "entry") {
add_new_entry(index, argc, argv);
}
#ifdef DEBUG
// Ordinarily, deleting the main ledger isn't necessary, since the
// process is about to give back its heap to the OS.
delete main_ledger;
#endif
return 0;
}
// reports.cc ends here.