Price Database

The PriceDB is intended to be a database of price quotes, or more specifically, a database of GNCPrices. More...

Files
file	gnc-pricedb.h
	a simple price database for gnucash

Typedefs
typedef gboolean(*	GncPriceForeachFunc) (GNCPrice *p, gpointer user_data)

Enumerations
enum	PriceRemoveSourceFlags { PRICE_REMOVE_SOURCE_FQ = 1 , PRICE_REMOVE_SOURCE_USER = 2 , PRICE_REMOVE_SOURCE_APP = 4 , PRICE_REMOVE_SOURCE_COMM = 8 }
enum	PriceRemoveKeepOptions {   PRICE_REMOVE_KEEP_NONE , PRICE_REMOVE_KEEP_LAST_WEEKLY , PRICE_REMOVE_KEEP_LAST_MONTHLY , PRICE_REMOVE_KEEP_LAST_QUARTERLY ,   PRICE_REMOVE_KEEP_LAST_PERIOD , PRICE_REMOVE_KEEP_SCALED }

Functions
GNCPriceDB *	gnc_pricedb_get_db (QofBook *book)
	Return the pricedb associated with the book.
GNCPriceDB *	gnc_collection_get_pricedb (QofCollection *col)
	Return the pricedb via the Book's collection.
void	gnc_pricedb_destroy (GNCPriceDB *db)
	Destroy the given pricedb and unref all of the prices it contains.
void	gnc_pricedb_begin_edit (GNCPriceDB *)
	Begin an edit.
void	gnc_pricedb_commit_edit (GNCPriceDB *)
	Commit an edit.
void	gnc_pricedb_set_bulk_update (GNCPriceDB *db, gboolean bulk_update)
	Set flag to indicate whether duplication checks should be performed.
gboolean	gnc_pricedb_add_price (GNCPriceDB *db, GNCPrice *p)
	Add a price to the pricedb.
gboolean	gnc_pricedb_remove_price (GNCPriceDB *db, GNCPrice *p)
	Remove a price from the pricedb and unref the price.
gboolean	gnc_pricedb_remove_old_prices (GNCPriceDB *db, GList *comm_list, GDate *fiscal_end_date, time64 cutoff, PriceRemoveSourceFlags source, PriceRemoveKeepOptions keep)
	Remove and unref prices older than a certain time.
GNCPrice *	gnc_pricedb_lookup_latest (GNCPriceDB *db, const gnc_commodity *commodity, const gnc_commodity *currency)
	Find the most recent price between the two commodities.
PriceList *	gnc_pricedb_lookup_latest_any_currency (GNCPriceDB *db, const gnc_commodity *commodity)
	Find the most recent price between a commodity and all other commodities.
gboolean	gnc_pricedb_has_prices (GNCPriceDB *db, const gnc_commodity *commodity, const gnc_commodity *currency)
	Report whether the pricedb contains prices for one commodity in another.
PriceList *	gnc_pricedb_get_prices (GNCPriceDB *db, const gnc_commodity *commodity, const gnc_commodity *currency)
	Return all the prices for a given commodity in another.
GNCPrice *	gnc_pricedb_lookup_day_t64 (GNCPriceDB *db, const gnc_commodity *commodity, const gnc_commodity *currency, time64 t)
	Return the price between the two commodities on the indicated day.
GNCPrice *	gnc_pricedb_lookup_nearest_in_time64 (GNCPriceDB *db, const gnc_commodity *c, const gnc_commodity *currency, time64 t)
	Return the price between the two commoditiesz nearest to the given time.
PriceList *	gnc_pricedb_lookup_nearest_in_time_any_currency_t64 (GNCPriceDB *db, const gnc_commodity *c, time64 t)
	Return the price nearest in time to that given between the given commodity and every other.
GNCPrice *	gnc_pricedb_lookup_nearest_before_t64 (GNCPriceDB *db, const gnc_commodity *c, const gnc_commodity *currency, time64 t)
	Return the nearest price between the given commodities before the given time.
PriceList *	gnc_pricedb_lookup_nearest_before_any_currency_t64 (GNCPriceDB *db, const gnc_commodity *c, time64 t)
	Return the nearest price between the given commodity and any other before the given time.
gnc_numeric	gnc_pricedb_get_nearest_before_price (GNCPriceDB *pdb, const gnc_commodity *orig_currency, const gnc_commodity *new_currency, const time64 t)
	Retrieve the price one currency to another using the price nearest to before the given time.
gnc_numeric	gnc_pricedb_get_nearest_price (GNCPriceDB *pdb, const gnc_commodity *orig_currency, const gnc_commodity *new_currency, const time64 t)
	Retrieve the price one currency to another using the price nearest to the given time.
gnc_numeric	gnc_pricedb_get_latest_price (GNCPriceDB *pdb, const gnc_commodity *orig_currency, const gnc_commodity *new_currency)
	Retrieve the price one currency to another using the latest price.
gnc_numeric	gnc_pricedb_convert_balance_latest_price (GNCPriceDB *pdb, gnc_numeric balance, const gnc_commodity *balance_currency, const gnc_commodity *new_currency)
	Convert a balance from one currency to another using the most recent price between the two.
gnc_numeric	gnc_pricedb_convert_balance_nearest_price_t64 (GNCPriceDB *pdb, gnc_numeric balance, const gnc_commodity *balance_currency, const gnc_commodity *new_currency, time64 t)
	Convert a balance from one currency to another using the price nearest to the given time.
gnc_numeric	gnc_pricedb_convert_balance_nearest_before_price_t64 (GNCPriceDB *pdb, gnc_numeric balance, const gnc_commodity *balance_currency, const gnc_commodity *new_currency, time64 t)
	Convert a balance from one currency to another using the price nearest to before the given time.
gboolean	gnc_pricedb_foreach_price (GNCPriceDB *db, GncPriceForeachFunc f, gpointer user_data, gboolean stable_order)
	Call a GncPriceForeachFunction once for each price in db, until the function returns FALSE.
int	gnc_pricedb_num_prices (GNCPriceDB *db, const gnc_commodity *c)
	Get the number of prices, in any currency, for a given commodity.
GNCPrice *	gnc_pricedb_nth_price (GNCPriceDB *db, const gnc_commodity *c, const int n)
	Get the nth price for the given commodity in reverse date order.
void	gnc_pricedb_nth_price_reset_cache (GNCPriceDB *db)
guint	gnc_pricedb_get_num_prices (GNCPriceDB *db)
	Return the number of prices in the database.
gboolean	gnc_pricedb_equal (GNCPriceDB *db1, GNCPriceDB *db2)
	Test equality of two pricedbs.

Internal/Debugging
void	gnc_pricedb_print_contents (GNCPriceDB *db, FILE *f)
	This simple function can be useful for debugging the pricedb code.

Price Parameter Names
For use with QofQuery
#define	PRICE_COMMODITY   "price-commodity"
#define	PRICE_CURRENCY   "price-currency"
#define	PRICE_DATE   "price-date"
#define	PRICE_SOURCE   "price-source"
#define	PRICE_TYPE   "price-type"
#define	PRICE_VALUE   "price-value"

Detailed Description

The PriceDB is intended to be a database of price quotes, or more specifically, a database of GNCPrices.

Whenever a you store a price in the pricedb, the pricedb adds its own reference to the price, so you can safely unref that price after inserting it into the DB if you're finished with it otherwise.

For the time being, it is still a fairly simple database supporting only fairly simple queries. It is expected that new queries will be added as needed, and that there is some advantage to delaying complex queries for now in the hope that we get a real DB implementation before they're really needed.

Every QofBook contains a GNCPriceDB, accessible via gnc_pricedb_get_db.

Warning

The PriceDB does not currently use the object system used elsewhere in the GnuCash Engine, i.e. it does not use GUISD's, Entities and Collections. It should. In particular, this means that currently prices cannot be queried with the same mechanism as everything else.

Similarly, when the pricedb returns a price to you, either singly, or in a price list, the price will have had a ref added for you, so you only need to unref the price(s) when you're finished with it/them.

Macro Definition Documentation

PRICE_COMMODITY

#define PRICE_COMMODITY   "price-commodity"

Definition at line 700 of file gnc-pricedb.h.

PRICE_CURRENCY

#define PRICE_CURRENCY   "price-currency"

Definition at line 701 of file gnc-pricedb.h.

PRICE_DATE

#define PRICE_DATE   "price-date"

Definition at line 702 of file gnc-pricedb.h.

PRICE_SOURCE

#define PRICE_SOURCE   "price-source"

Definition at line 703 of file gnc-pricedb.h.

PRICE_TYPE

#define PRICE_TYPE   "price-type"

Definition at line 704 of file gnc-pricedb.h.

PRICE_VALUE

#define PRICE_VALUE   "price-value"

Definition at line 705 of file gnc-pricedb.h.

Typedef Documentation

GncPriceForeachFunc

typedef gboolean(* GncPriceForeachFunc) (GNCPrice *p, gpointer user_data)

Definition at line 634 of file gnc-pricedb.h.

Enumeration Type Documentation

PriceRemoveKeepOptions

enum PriceRemoveKeepOptions

Definition at line 389 of file gnc-pricedb.h.

{
    PRICE_REMOVE_KEEP_NONE,           // keep none
    PRICE_REMOVE_KEEP_LAST_WEEKLY,    // leave last one of every week
    PRICE_REMOVE_KEEP_LAST_MONTHLY,   // leave last one of every month
    PRICE_REMOVE_KEEP_LAST_QUARTERLY, // leave last one of every quarter
    PRICE_REMOVE_KEEP_LAST_PERIOD,    // leave last one of every annual period
    PRICE_REMOVE_KEEP_SCALED,         // leave one every week then one a month
} PriceRemoveKeepOptions;

PriceRemoveSourceFlags

enum PriceRemoveSourceFlags

Definition at line 381 of file gnc-pricedb.h.

{
    PRICE_REMOVE_SOURCE_FQ = 1,   // this flag is set when added by F:Q checked
    PRICE_REMOVE_SOURCE_USER = 2, // this flag is set when added by the user checked
    PRICE_REMOVE_SOURCE_APP = 4,  // this flag is set when added by the app checked
    PRICE_REMOVE_SOURCE_COMM = 8, // this flag is set when we have commodities selected
} PriceRemoveSourceFlags;

Function Documentation

gnc_collection_get_pricedb()

GNCPriceDB * gnc_collection_get_pricedb

(

QofCollection *

col

)

Return the pricedb via the Book's collection.

Parameters

col	The QofCollection holding the pricedb

Returns

The GNCPriceDB in the QofCollection

Todo:

Collections of prices are not destroyed fully.

gnc_pricedb_destroy does not clean up properly because gnc_pricedb_create reports an existing PriceDB after running gnc_pricedb_destroy. To change the pricedb, we need to destroy and recreate the book. Yuk.

Definition at line 918 of file gnc-pricedb.cpp.

{
    if (!col) return nullptr;
    return static_cast<GNCPriceDB*>(qof_collection_get_data (col));
}

gnc_pricedb_add_price()

gboolean gnc_pricedb_add_price	(	GNCPriceDB *	db,
		GNCPrice *	p
	)

Add a price to the pricedb.

You may drop your reference to the price (i.e. call unref) after this succeeds, whenever you're finished with the price.

Parameters

db	The pricedb
p	The GNCPrice to add.

Returns

TRUE if the price was added, FALSE otherwise.

Definition at line 1126 of file gnc-pricedb.cpp.

{
    if (!db || !p) return FALSE;
 
    ENTER ("db=%p, pr=%p dirty=%d destroying=%d",
           db, p, qof_instance_get_dirty_flag(p),
           qof_instance_get_destroying(p));
 
    if (FALSE == add_price(db, p))
    {
        LEAVE (" failed to add price");
        return FALSE;
    }
 
    gnc_pricedb_begin_edit(db);
    qof_instance_set_dirty(&db->inst);
    gnc_pricedb_commit_edit(db);
 
    LEAVE ("db=%p, pr=%p dirty=%d destroying=%d",
           db, p, qof_instance_get_dirty_flag(p),
           qof_instance_get_destroying(p));
 
    return TRUE;
}

gnc_pricedb_begin_edit()

void gnc_pricedb_begin_edit

(

GNCPriceDB *

pdb

)

Begin an edit.

Definition at line 434 of file gnc-pricedb.cpp.

{
    qof_begin_edit(&pdb->inst);
}

gnc_pricedb_commit_edit()

void gnc_pricedb_commit_edit

(

GNCPriceDB *

pdb

)

Commit an edit.

Definition at line 440 of file gnc-pricedb.cpp.

{
    if (!qof_commit_edit (QOF_INSTANCE(pdb))) return;
    qof_commit_edit_part2 (&pdb->inst, commit_err, noop, noop);
}

gnc_pricedb_convert_balance_latest_price()

gnc_numeric gnc_pricedb_convert_balance_latest_price	(	GNCPriceDB *	pdb,
		gnc_numeric	balance,
		const gnc_commodity *	balance_currency,
		const gnc_commodity *	new_currency
	)

Convert a balance from one currency to another using the most recent price between the two.

Parameters

pdb	The pricedb
balance	The balance to be converted
balance_currency	The commodity in which the balance is currently expressed
new_currency	The commodity to which the balance should be converted

Returns

A new balance or gnc_numeric_zero if no price is available.

Definition at line 2571 of file gnc-pricedb.cpp.

{
    return convert_amount_at_date
        (pdb, balance, balance_currency, new_currency, INT64_MAX, FALSE);
}

gnc_pricedb_convert_balance_nearest_before_price_t64()

gnc_numeric gnc_pricedb_convert_balance_nearest_before_price_t64	(	GNCPriceDB *	pdb,
		gnc_numeric	balance,
		const gnc_commodity *	balance_currency,
		const gnc_commodity *	new_currency,
		time64	t
	)

Convert a balance from one currency to another using the price nearest to before the given time.

Parameters

pdb	The pricedb
balance	The balance to be converted
balance_currency	The commodity in which the balance is currently expressed
new_currency	The commodity to which the balance should be converted
t	The time in which the last price before it should be used.

Returns

A new balance or gnc_numeric_zero if no price is available.

Definition at line 2592 of file gnc-pricedb.cpp.

{
    return convert_amount_at_date
        (pdb, balance, balance_currency, new_currency, t, TRUE);
}

gnc_pricedb_convert_balance_nearest_price_t64()

gnc_numeric gnc_pricedb_convert_balance_nearest_price_t64	(	GNCPriceDB *	pdb,
		gnc_numeric	balance,
		const gnc_commodity *	balance_currency,
		const gnc_commodity *	new_currency,
		time64	t
	)

Convert a balance from one currency to another using the price nearest to the given time.

Parameters

pdb	The pricedb
balance	The balance to be converted
balance_currency	The commodity in which the balance is currently expressed
new_currency	The commodity to which the balance should be converted
t	The time nearest to which price should be used.

Returns

A new balance or gnc_numeric_zero if no price is available.

Definition at line 2581 of file gnc-pricedb.cpp.

{
    return convert_amount_at_date
        (pdb, balance, balance_currency, new_currency, t, FALSE);
}

gnc_pricedb_destroy()

void gnc_pricedb_destroy

(

GNCPriceDB *

db

)

Destroy the given pricedb and unref all of the prices it contains.

This may not deallocate all of those prices. Other code may still be holding references to them.

Parameters

db	The pricedb to destroy.

Definition at line 881 of file gnc-pricedb.cpp.

{
    if (!db) return;
    if (db->commodity_hash)
    {
        g_hash_table_foreach (db->commodity_hash,
                              destroy_pricedb_commodity_hash_data,
                              nullptr);
    }
    g_hash_table_destroy (db->commodity_hash);
    db->commodity_hash = nullptr;
    /* qof_instance_release (&db->inst); */
    g_object_unref(db);
}

gnc_pricedb_equal()

gboolean gnc_pricedb_equal	(	GNCPriceDB *	db1,
		GNCPriceDB *	db2
	)

Test equality of two pricedbs.

For XML Backend Testing

Definition at line 1000 of file gnc-pricedb.cpp.

{
    GNCPriceDBEqualData equal_data;
 
    if (db1 == db2) return TRUE;
 
    if (!db1 || !db2)
    {
        PWARN ("one is nullptr");
        return FALSE;
    }
 
    equal_data.equal = TRUE;
    equal_data.db2 = db2;
 
    g_hash_table_foreach (db1->commodity_hash,
                          pricedb_equal_foreach_currencies_hash,
                          &equal_data);
 
    return equal_data.equal;
}

gnc_pricedb_foreach_price()

gboolean gnc_pricedb_foreach_price	(	GNCPriceDB *	db,
		GncPriceForeachFunc	f,
		gpointer	user_data,
		gboolean	stable_order
	)

Call a GncPriceForeachFunction once for each price in db, until the function returns FALSE.

If stable_order is not FALSE, make sure the ordering of the traversal is stable (i.e. the same order every time given the same db contents – stable traversals may be less efficient).

Parameters

db	The pricedb
f	The function to call
user_data	A data to pass to each invocation of f
stable_order	Ensure that the traversal is performed in the same order each time.

Returns

TRUE if all calls to f succeeded (unstable) or if the order of processing was the same as the previous invocation (stable), FALSE otherwise.

Definition at line 2745 of file gnc-pricedb.cpp.

{
    ENTER ("db=%p f=%p", db, f);
    if (stable_order)
    {
        LEAVE (" stable order found");
        return stable_price_traversal(db, f, user_data);
    }
    LEAVE (" use unstable order");
    return unstable_price_traversal(db, f, user_data);
}

gnc_pricedb_get_db()

GNCPriceDB * gnc_pricedb_get_db

(

QofBook *

book

)

Return the pricedb associated with the book.

Parameters

book	The QofBook holding the pricedb

Returns

The GNCPriceDB associated with the book.

Definition at line 925 of file gnc-pricedb.cpp.

{
    QofCollection *col;
 
    if (!book) return nullptr;
    col = qof_book_get_collection (book, GNC_ID_PRICEDB);
    return gnc_collection_get_pricedb (col);
}

gnc_pricedb_get_latest_price()

gnc_numeric gnc_pricedb_get_latest_price	(	GNCPriceDB *	pdb,
		const gnc_commodity *	orig_currency,
		const gnc_commodity *	new_currency
	)

Retrieve the price one currency to another using the latest price.

Parameters

pdb	The pricedb
orig_currency	The commodity in which the balance is currently expressed
new_currency	The commodity to which the balance should be converted

Returns

A price, or gnc_numeric_zero if no price is available.

Definition at line 2536 of file gnc-pricedb.cpp.

{
    return get_nearest_price (pdb, orig_currency, new_currency, INT64_MAX, FALSE);
}

gnc_pricedb_get_nearest_before_price()

gnc_numeric gnc_pricedb_get_nearest_before_price	(	GNCPriceDB *	pdb,
		const gnc_commodity *	orig_currency,
		const gnc_commodity *	new_currency,
		const time64	t
	)

Retrieve the price one currency to another using the price nearest to before the given time.

Parameters

pdb	The pricedb
orig_currency	The commodity in which the balance is currently expressed
new_currency	The commodity to which the balance should be converted
t	The time to be used for for comparison

Returns

A price, or gnc_numeric_zero if no price is available.

Definition at line 2518 of file gnc-pricedb.cpp.

{
    return get_nearest_price (pdb, orig_currency, new_currency, t, TRUE);
}

gnc_pricedb_get_nearest_price()

gnc_numeric gnc_pricedb_get_nearest_price	(	GNCPriceDB *	pdb,
		const gnc_commodity *	orig_currency,
		const gnc_commodity *	new_currency,
		const time64	t
	)

Retrieve the price one currency to another using the price nearest to the given time.

Parameters

pdb	The pricedb
orig_currency	The commodity in which the balance is currently expressed
new_currency	The commodity to which the balance should be converted
t	The time in which the nearest price should be used.

Returns

A price, or gnc_numeric_zero if no price is available.

Definition at line 2527 of file gnc-pricedb.cpp.

{
    return get_nearest_price (pdb, orig_currency, new_currency, t, FALSE);
}

gnc_pricedb_get_num_prices()

guint gnc_pricedb_get_num_prices

(

GNCPriceDB *

db

)

Return the number of prices in the database.

For XML Backend Testing

Definition at line 947 of file gnc-pricedb.cpp.

{
    guint count;
 
    if (!db) return 0;
 
    count = 0;
 
    gnc_pricedb_foreach_price(db, num_prices_helper, &count, FALSE);
 
    return count;
}

gnc_pricedb_get_prices()

PriceList * gnc_pricedb_get_prices	(	GNCPriceDB *	db,
		const gnc_commodity *	commodity,
		const gnc_commodity *	currency
	)

Return all the prices for a given commodity in another.

Does not retrieve reverse prices, i.e. prices of the second commodity in the first.

Parameters

db	The pricedb from which to retrieve prices.
commodity	The commodity for which prices should be retrieved.
currency	The commodity in which prices should be quoted. If NULL, all prices in any commodity are included.

Returns

A PriceList of matching prices or NULL if none were found.

Definition at line 2061 of file gnc-pricedb.cpp.

{
    if (!db || !commodity) return nullptr;
    ENTER ("db=%p commodity=%p currency=%p", db, commodity, currency);
    auto result = pricedb_get_prices_internal (db, commodity, currency, FALSE);
    if (!result) return nullptr;
    g_list_foreach (result, (GFunc)gnc_price_ref, nullptr);
    LEAVE (" ");
    return result;
}

gnc_pricedb_has_prices()

gboolean gnc_pricedb_has_prices	(	GNCPriceDB *	db,
		const gnc_commodity *	commodity,
		const gnc_commodity *	currency
	)

Report whether the pricedb contains prices for one commodity in another.

Does not check the reverse direction.

Parameters

db	The pricedb to check
commodity	The commodity to check for the existence of prices
currency	The commodity in which prices are sought. If NULL reports all commodities.

Returns

TRUE if matching prices are found, FALSE otherwise.

Definition at line 2022 of file gnc-pricedb.cpp.

{
    GList *price_list;
    GHashTable *currency_hash;
    gint size;
 
    if (!db || !commodity) return FALSE;
    ENTER ("db=%p commodity=%p currency=%p", db, commodity, currency);
    currency_hash = static_cast<GHashTable*>(g_hash_table_lookup(db->commodity_hash, commodity));
    if (!currency_hash)
    {
        LEAVE("no, no currency_hash table");
        return FALSE;
    }
 
    if (currency)
    {
        price_list = static_cast<GList*>(g_hash_table_lookup(currency_hash, currency));
        if (price_list)
        {
            LEAVE("yes");
            return TRUE;
        }
        LEAVE("no, no price list");
        return FALSE;
    }
 
    size = g_hash_table_size (currency_hash);
    LEAVE("%s", size > 0 ? "yes" : "no");
    return size > 0;
}

gnc_pricedb_lookup_day_t64()

GNCPrice * gnc_pricedb_lookup_day_t64	(	GNCPriceDB *	db,
		const gnc_commodity *	commodity,
		const gnc_commodity *	currency,
		time64	t
	)

Return the price between the two commodities on the indicated day.

Note that the notion of day might be distorted by changes in timezone.

The returned GNCPrice may be in either direction so check to ensure that its value is correctly applied.

Parameters

db	The pricedb
commodity	The first commodity
currency	The second commodity
t	A time. The price returned will be in the same day as this time according to the local timezone.

Returns

A GNCPrice or NULL on failure.

Definition at line 2185 of file gnc-pricedb.cpp.

{
    return lookup_nearest_in_time(db, c, currency, t, TRUE);
}

gnc_pricedb_lookup_latest()

GNCPrice * gnc_pricedb_lookup_latest	(	GNCPriceDB *	db,
		const gnc_commodity *	commodity,
		const gnc_commodity *	currency
	)

Find the most recent price between the two commodities.

The returned GNCPrice may be in either direction so check to ensure that its value is correctly applied.

Parameters

db	The pricedb
commodity	The first commodity
currency	The second commodity

Returns

A GNCPrice or NULL if no price exists.

Definition at line 1745 of file gnc-pricedb.cpp.

{
    GList *price_list;
    GNCPrice *result;
 
    if (!db || !commodity || !currency) return nullptr;
    ENTER ("db=%p commodity=%p currency=%p", db, commodity, currency);
 
    price_list = pricedb_get_prices_internal(db, commodity, currency, TRUE);
    if (!price_list) return nullptr;
    /* This works magically because prices are inserted in date-sorted
     * order, and the latest date always comes first. So return the
     * first in the list.  */
    result = static_cast<GNCPrice*>(price_list->data);
    gnc_price_ref(result);
    g_list_free (price_list);
    LEAVE("price is %p", result);
    return result;
}

gnc_pricedb_lookup_latest_any_currency()

PriceList * gnc_pricedb_lookup_latest_any_currency	(	GNCPriceDB *	db,
		const gnc_commodity *	commodity
	)

Find the most recent price between a commodity and all other commodities.

The returned GNCPrices may be in either direction so check to ensure that their values are correctly applied.

Parameters

db	The pricedb
commodity	The commodity for which to obtain prices

Returns

A PriceList of prices found, or NULL if none found.

Definition at line 1969 of file gnc-pricedb.cpp.

{
    return gnc_pricedb_lookup_nearest_before_any_currency_t64(db, commodity,
                                                              gnc_time(nullptr));
}

gnc_pricedb_lookup_nearest_before_any_currency_t64()

PriceList * gnc_pricedb_lookup_nearest_before_any_currency_t64	(	GNCPriceDB *	db,
		const gnc_commodity *	c,
		time64	t
	)

Return the nearest price between the given commodity and any other before the given time.

The returned GNCPrice may be in either direction so check to ensure that its value is correctly applied.

Parameters

db	The pricedb
c	The commodity
t	The time before which to find prices

Returns

A PriceList of prices for each commodity found or NULL if none are.

Definition at line 1997 of file gnc-pricedb.cpp.

{
    GList *prices = nullptr, *result;
    UsesCommodity helper = {&prices, commodity, t};
    result = nullptr;
 
    if (!db || !commodity) return nullptr;
    ENTER ("db=%p commodity=%p", db, commodity);
 
    pricedb_pricelist_traversal(db, price_list_scan_any_currency,
                                       &helper);
    prices = g_list_sort(prices, compare_prices_by_date);
    result = latest_before(prices, commodity, t);
    gnc_price_list_destroy(prices);
    LEAVE(" ");
    return result;
}

gnc_pricedb_lookup_nearest_before_t64()

GNCPrice * gnc_pricedb_lookup_nearest_before_t64	(	GNCPriceDB *	db,
		const gnc_commodity *	c,
		const gnc_commodity *	currency,
		time64	t
	)

Return the nearest price between the given commodities before the given time.

The returned GNCPrice may be in either direction so check to ensure that its value is correctly applied.

Parameters

db	The pricedb
c	The first commodity
currency	The second commodity
t	The time before which to find the price

Returns

A GNCPrice or NULL if no prices are found before t.

Definition at line 2319 of file gnc-pricedb.cpp.

{
    GNCPrice *current_price = nullptr;
    if (!db || !c || !currency) return nullptr;
    ENTER ("db=%p commodity=%p currency=%p", db, c, currency);
    auto price_list = pricedb_get_prices_internal (db, c, currency, TRUE);
    if (!price_list) return nullptr;
    auto p = g_list_find_custom (price_list, &t, (GCompareFunc)price_time64_less_or_equal);
    if (p)
    {
        current_price = GNC_PRICE (p->data);
        gnc_price_ref (current_price);
    }
    g_list_free (price_list);
    LEAVE (" ");
    return current_price;
}

gnc_pricedb_lookup_nearest_in_time64()

GNCPrice * gnc_pricedb_lookup_nearest_in_time64	(	GNCPriceDB *	db,
		const gnc_commodity *	c,
		const gnc_commodity *	currency,
		time64	t
	)

Return the price between the two commoditiesz nearest to the given time.

The returned GNCPrice may be in either direction so check to ensure that its value is correctly applied.

Parameters

db	The pricedb
c	The first commodity
currency	The second commodity
t	The time nearest to which the returned price should be.

Returns

A GNCPrice or NULL if no prices exist between the two commodities.

Definition at line 2304 of file gnc-pricedb.cpp.

{
    return lookup_nearest_in_time(db, c, currency, t, FALSE);
}

gnc_pricedb_lookup_nearest_in_time_any_currency_t64()

PriceList * gnc_pricedb_lookup_nearest_in_time_any_currency_t64	(	GNCPriceDB *	db,
		const gnc_commodity *	c,
		time64	t
	)

Return the price nearest in time to that given between the given commodity and every other.

The returned GNCPrices may be in either direction so check to ensure that their values are correctly applied.

Parameters

db,The	pricedb
c,The	commodity for which prices should be obtained.
t,The	time nearest to which the prices should be obtained.

Returns

A PriceList of prices for each commodity pair found or NULL if none are.

Definition at line 1977 of file gnc-pricedb.cpp.

{
    GList *prices = nullptr, *result;
    UsesCommodity helper = {&prices, commodity, t};
    result = nullptr;
 
    if (!db || !commodity) return nullptr;
    ENTER ("db=%p commodity=%p", db, commodity);
 
    pricedb_pricelist_traversal(db, price_list_scan_any_currency, &helper);
    prices = g_list_sort(prices, compare_prices_by_date);
    result = nearest_to(prices, commodity, t);
    gnc_price_list_destroy(prices);
    LEAVE(" ");
    return result;
}

gnc_pricedb_nth_price()

GNCPrice * gnc_pricedb_nth_price	(	GNCPriceDB *	db,
		const gnc_commodity *	c,
		const int	n
	)

Get the nth price for the given commodity in reverse date order.

Parameters

db	The pricedb
c	The commodity whose nth price is needed
n	Zero based index of the price wanted

Returns

The nth price for this commodity in reverse chronological order, without regard for what currency the price is in

Definition at line 2133 of file gnc-pricedb.cpp.

{
    static const gnc_commodity *last_c = nullptr;
    static GList *prices = nullptr;
 
    GNCPrice *result = nullptr;
    GHashTable *currency_hash;
    g_return_val_if_fail (GNC_IS_COMMODITY (c), nullptr);
 
    if (!db || !c || n < 0) return nullptr;
    ENTER ("db=%p commodity=%s index=%d", db, gnc_commodity_get_mnemonic(c), n);
 
    if (last_c && prices && last_c == c && db->reset_nth_price_cache == FALSE)
    {
        result = static_cast<GNCPrice*>(g_list_nth_data (prices, n));
        LEAVE ("price=%p", result);
        return result;
    }
 
    last_c = c;
 
    if (prices)
    {
        g_list_free (prices);
        prices = nullptr;
    }
 
    db->reset_nth_price_cache = FALSE;
 
    currency_hash = static_cast<GHashTable*>(g_hash_table_lookup (db->commodity_hash, c));
    if (currency_hash)
    {
        GList *currencies = g_hash_table_get_values (currency_hash);
        g_list_foreach (currencies, list_combine, &prices);
        result = static_cast<GNCPrice*>(g_list_nth_data (prices, n));
        g_list_free (currencies);
    }
 
    LEAVE ("price=%p", result);
    return result;
}

gnc_pricedb_nth_price_reset_cache()

void gnc_pricedb_nth_price_reset_cache

(

GNCPriceDB *

db

)

Definition at line 2178 of file gnc-pricedb.cpp.

{
    if (db)
        db->reset_nth_price_cache = TRUE;
}

gnc_pricedb_num_prices()

int gnc_pricedb_num_prices	(	GNCPriceDB *	db,
		const gnc_commodity *	c
	)

Get the number of prices, in any currency, for a given commodity.

Parameters

db	The pricedb
c	The commodity

Returns

The number of prices in the database for this commody, zero if none

Definition at line 2086 of file gnc-pricedb.cpp.

{
    int result = 0;
    GHashTable *currency_hash;
 
    if (!db || !c) return 0;
    ENTER ("db=%p commodity=%p", db, c);
 
    currency_hash = static_cast<GHashTable*>(g_hash_table_lookup(db->commodity_hash, c));
    if (currency_hash)
    {
        g_hash_table_foreach(currency_hash, price_count_helper,  (gpointer)&result);
    }
 
    LEAVE ("count=%d", result);
    return result;
}

gnc_pricedb_print_contents()

void gnc_pricedb_print_contents	(	GNCPriceDB *	db,
		FILE *	f
	)

This simple function can be useful for debugging the pricedb code.

Definition at line 2821 of file gnc-pricedb.cpp.

{
    if (!db)
    {
        PERR("nullptr PriceDB\n");
        return;
    }
    if (!f)
    {
        PERR("nullptr FILE*\n");
        return;
    }
 
    fprintf(f, "<gnc:pricedb>\n");
    gnc_pricedb_foreach_price(db, print_pricedb_adapter, f, FALSE);
    fprintf(f, "</gnc:pricedb>\n");
}

gnc_pricedb_remove_old_prices()

gboolean gnc_pricedb_remove_old_prices	(	GNCPriceDB *	db,
		GList *	comm_list,
		GDate *	fiscal_end_date,
		time64	cutoff,
		PriceRemoveSourceFlags	source,
		PriceRemoveKeepOptions	keep
	)

Remove and unref prices older than a certain time.

Parameters

db	The pricedb
comm_list	A list of commodities
fiscal_end_date	the end date of the current accounting period
cutoff	The time before which prices should be deleted.
source	Whether Finance::Quote, user or all prices should be deleted.
keep	Whether scaled, monthly, weekly or no prices should be left.

Returns

True if there were prices to process, False if not.

Definition at line 1563 of file gnc-pricedb.cpp.

{
    remove_info data;
    GList *node;
    char datebuff[MAX_DATE_LENGTH + 1];
    memset (datebuff, 0, sizeof(datebuff));
 
    data.db = db;
    data.cutoff = cutoff;
    data.list = nullptr;
    data.delete_fq = FALSE;
    data.delete_user = FALSE;
    data.delete_app = FALSE;
 
    ENTER("Remove Prices for Source %d, keeping %d", source, keep);
 
    // setup the source options
    if (source & PRICE_REMOVE_SOURCE_APP)
        data.delete_app = TRUE;
 
    if (source & PRICE_REMOVE_SOURCE_FQ)
        data.delete_fq = TRUE;
 
    if (source & PRICE_REMOVE_SOURCE_USER)
        data.delete_user = TRUE;
 
    // Walk the list of commodities
    for (node = g_list_first (comm_list); node; node = g_list_next (node))
    {
        auto currencies_hash = static_cast<GHashTable*>(g_hash_table_lookup (db->commodity_hash, node->data));
        g_hash_table_foreach (currencies_hash, pricedb_remove_foreach_pricelist, &data);
    }
 
    if (data.list == nullptr)
    {
        LEAVE("Empty price list");
        return FALSE;
    }
    qof_print_date_buff (datebuff, sizeof(datebuff), cutoff);
    DEBUG("Number of Prices in list is %d, Cutoff date is %s",
          g_slist_length (data.list), datebuff);
 
    // Check for a valid fiscal end of year date
    if (fiscal_end_date == nullptr || !g_date_valid (fiscal_end_date))
    {
        auto ymd = GncDate().year_month_day();
        GDate end_this_year;
        g_date_set_dmy (&end_this_year, 31, GDateMonth(12), ymd.year);
        gnc_pricedb_process_removal_list (db, &end_this_year, data, keep);
    }
    else
        gnc_pricedb_process_removal_list (db, fiscal_end_date, data, keep);
 
    g_slist_free (data.list);
    LEAVE(" ");
    return TRUE;
}

gnc_pricedb_remove_price()

gboolean gnc_pricedb_remove_price	(	GNCPriceDB *	db,
		GNCPrice *	p
	)

Remove a price from the pricedb and unref the price.

Parameters

db	The Pricedb
p	The price to remove.

Definition at line 1233 of file gnc-pricedb.cpp.

{
    gboolean rc;
    char datebuff[MAX_DATE_LENGTH + 1];
    memset(datebuff, 0, sizeof(datebuff));
    if (!db || !p) return FALSE;
    ENTER ("db=%p, pr=%p dirty=%d destroying=%d",
           db, p, qof_instance_get_dirty_flag(p),
           qof_instance_get_destroying(p));
 
    gnc_price_ref(p);
    qof_print_date_buff(datebuff, sizeof(datebuff), gnc_price_get_time64 (p));
    DEBUG("Remove Date is %s, Commodity is %s, Source is %s", datebuff,
          gnc_commodity_get_fullname (gnc_price_get_commodity (p)),
          gnc_price_get_source_string (p));
 
    rc = remove_price (db, p, TRUE);
    gnc_pricedb_begin_edit(db);
    qof_instance_set_dirty(&db->inst);
    gnc_pricedb_commit_edit(db);
 
    /* invoke the backend to delete this price */
    gnc_price_begin_edit (p);
    qof_instance_set_destroying(p, TRUE);
    gnc_price_commit_edit (p);
    p->db = nullptr;
    gnc_price_unref(p);
    LEAVE ("db=%p, pr=%p", db, p);
    return rc;
}

gnc_pricedb_set_bulk_update()

void gnc_pricedb_set_bulk_update	(	GNCPriceDB *	db,
		gboolean	bulk_update
	)

Set flag to indicate whether duplication checks should be performed.

Normally used at load time to speed up loading the pricedb.

Parameters

db	The pricedb
bulk_update	TRUE to disable duplication checks, FALSE to enable them.

Definition at line 897 of file gnc-pricedb.cpp.

{
    db->bulk_update = bulk_update;
}