GnuCash  4.8a-132-gcdaeb421d+
Files | Typedefs | Enumerations | Functions

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. More...
 
GNCPriceDB * gnc_collection_get_pricedb (QofCollection *col)
 Return the pricedb via the Book's collection. More...
 
void gnc_pricedb_destroy (GNCPriceDB *db)
 Destroy the given pricedb and unref all of the prices it contains. More...
 
void gnc_pricedb_begin_edit (GNCPriceDB *)
 Begin an edit. More...
 
void gnc_pricedb_commit_edit (GNCPriceDB *)
 Commit an edit. More...
 
void gnc_pricedb_set_bulk_update (GNCPriceDB *db, gboolean bulk_update)
 Set flag to indicate whether duplication checks should be performed. More...
 
gboolean gnc_pricedb_add_price (GNCPriceDB *db, GNCPrice *p)
 Add a price to the pricedb. More...
 
gboolean gnc_pricedb_remove_price (GNCPriceDB *db, GNCPrice *p)
 Remove a price from the pricedb and unref the price. More...
 
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. More...
 
GNCPrice * gnc_pricedb_lookup_latest (GNCPriceDB *db, const gnc_commodity *commodity, const gnc_commodity *currency)
 Find the most recent price between the two commodities. More...
 
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. More...
 
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. More...
 
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. More...
 
GNCPrice * gnc_pricedb_lookup_at_time64 (GNCPriceDB *db, const gnc_commodity *commodity, const gnc_commodity *currency, time64 t)
 Find the price between two commodities at a time64. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
int gnc_pricedb_num_prices (GNCPriceDB *db, const gnc_commodity *c)
 Get the number of prices, in any currency, for a given commodity. More...
 
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. More...
 
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. More...
 
gboolean gnc_pricedb_equal (GNCPriceDB *db1, GNCPriceDB *db2)
 Test equality of two pricedbs. More...
 

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.

Function Documentation

◆ gnc_collection_get_pricedb()

GNCPriceDB* gnc_collection_get_pricedb ( QofCollection *  col)

Return the pricedb via the Book's collection.

Parameters
colThe 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 959 of file gnc-pricedb.c.

960 {
961  if (!col) return NULL;
962  return qof_collection_get_data (col);
963 }
gpointer qof_collection_get_data(const QofCollection *col)
Store and retrieve arbitrary object-defined data.
Definition: qofid.cpp:291

◆ 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
dbThe pricedb
pThe GNCPrice to add.
Returns
TRUE if the price was added, FALSE otherwise.

Definition at line 1169 of file gnc-pricedb.c.

1170 {
1171  if (!db || !p) return FALSE;
1172 
1173  ENTER ("db=%p, pr=%p dirty=%d destroying=%d",
1174  db, p, qof_instance_get_dirty_flag(p),
1176 
1177  if (FALSE == add_price(db, p))
1178  {
1179  LEAVE (" failed to add price");
1180  return FALSE;
1181  }
1182 
1184  qof_instance_set_dirty(&db->inst);
1186 
1187  LEAVE ("db=%p, pr=%p dirty=%d destroying=%d",
1188  db, p, qof_instance_get_dirty_flag(p),
1190 
1191  return TRUE;
1192 }
gboolean qof_instance_get_destroying(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object is about to be destroyed.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
gboolean qof_instance_get_dirty_flag(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object has been modified.
void gnc_pricedb_begin_edit(GNCPriceDB *pdb)
Begin an edit.
Definition: gnc-pricedb.c:446
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
void gnc_pricedb_commit_edit(GNCPriceDB *pdb)
Commit an edit.
Definition: gnc-pricedb.c:452

◆ gnc_pricedb_begin_edit()

void gnc_pricedb_begin_edit ( GNCPriceDB *  )

Begin an edit.

Definition at line 446 of file gnc-pricedb.c.

447 {
448  qof_begin_edit(&pdb->inst);
449 }
gboolean qof_begin_edit(QofInstance *inst)
begin_edit

◆ gnc_pricedb_commit_edit()

void gnc_pricedb_commit_edit ( GNCPriceDB *  )

Commit an edit.

Definition at line 452 of file gnc-pricedb.c.

453 {
454  if (!qof_commit_edit (QOF_INSTANCE(pdb))) return;
455  qof_commit_edit_part2 (&pdb->inst, commit_err, noop, noop);
456 }
gboolean qof_commit_edit(QofInstance *inst)
commit_edit helpers
gboolean qof_commit_edit_part2(QofInstance *inst, void(*on_error)(QofInstance *, QofBackendError), void(*on_done)(QofInstance *), void(*on_free)(QofInstance *))
part2 – deal with the backend

◆ 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
pdbThe pricedb
balanceThe balance to be converted
balance_currencyThe commodity in which the balance is currently expressed
new_currencyThe commodity to which the balance should be converted
Returns
A new balance or gnc_numeric_zero if no price is available.

Definition at line 2658 of file gnc-pricedb.c.

2662 {
2663  return convert_amount_at_date
2664  (pdb, balance, balance_currency, new_currency, INT64_MAX, FALSE);
2665 }

◆ 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
pdbThe pricedb
balanceThe balance to be converted
balance_currencyThe commodity in which the balance is currently expressed
new_currencyThe commodity to which the balance should be converted
tThe 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 2679 of file gnc-pricedb.c.

2684 {
2685  return convert_amount_at_date
2686  (pdb, balance, balance_currency, new_currency, t, TRUE);
2687 }

◆ 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
pdbThe pricedb
balanceThe balance to be converted
balance_currencyThe commodity in which the balance is currently expressed
new_currencyThe commodity to which the balance should be converted
tThe time nearest to which price should be used.
Returns
A new balance or gnc_numeric_zero if no price is available.

Definition at line 2668 of file gnc-pricedb.c.

2673 {
2674  return convert_amount_at_date
2675  (pdb, balance, balance_currency, new_currency, t, FALSE);
2676 }

◆ 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
dbThe pricedb to destroy.

Definition at line 922 of file gnc-pricedb.c.

923 {
924  if (!db) return;
925  if (db->commodity_hash)
926  {
927  g_hash_table_foreach (db->commodity_hash,
928  destroy_pricedb_commodity_hash_data,
929  NULL);
930  }
931  g_hash_table_destroy (db->commodity_hash);
932  db->commodity_hash = NULL;
933  /* qof_instance_release (&db->inst); */
934  g_object_unref(db);
935 }

◆ gnc_pricedb_equal()

gboolean gnc_pricedb_equal ( GNCPriceDB *  db1,
GNCPriceDB *  db2 
)

Test equality of two pricedbs.

For XML Backend Testing

Definition at line 1043 of file gnc-pricedb.c.

1044 {
1045  GNCPriceDBEqualData equal_data;
1046 
1047  if (db1 == db2) return TRUE;
1048 
1049  if (!db1 || !db2)
1050  {
1051  PWARN ("one is NULL");
1052  return FALSE;
1053  }
1054 
1055  equal_data.equal = TRUE;
1056  equal_data.db2 = db2;
1057 
1058  g_hash_table_foreach (db1->commodity_hash,
1059  pricedb_equal_foreach_currencies_hash,
1060  &equal_data);
1061 
1062  return equal_data.equal;
1063 }
#define PWARN(format, args...)
Log a warning.
Definition: qoflog.h:250

◆ 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
dbThe pricedb
fThe function to call
user_dataA data to pass to each invocation of f
stable_orderEnsure 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 2874 of file gnc-pricedb.c.

2878 {
2879  ENTER ("db=%p f=%p", db, f);
2880  if (stable_order)
2881  {
2882  LEAVE (" stable order found");
2883  return stable_price_traversal(db, f, user_data);
2884  }
2885  LEAVE (" use unstable order");
2886  return unstable_price_traversal(db, f, user_data);
2887 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ gnc_pricedb_get_db()

GNCPriceDB* gnc_pricedb_get_db ( QofBook *  book)

Return the pricedb associated with the book.

Parameters
bookThe QofBook holding the pricedb
Returns
The GNCPriceDB associated with the book.

Definition at line 966 of file gnc-pricedb.c.

967 {
968  QofCollection *col;
969 
970  if (!book) return NULL;
971  col = qof_book_get_collection (book, GNC_ID_PRICEDB);
972  return gnc_collection_get_pricedb (col);
973 }
GNCPriceDB * gnc_collection_get_pricedb(QofCollection *col)
Return the pricedb via the Book's collection.
Definition: gnc-pricedb.c:959
QofCollection * qof_book_get_collection(const QofBook *book, QofIdType entity_type)
Return The table of entities of the given type.
Definition: qofbook.cpp:604

◆ 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
pdbThe pricedb
orig_currencyThe commodity in which the balance is currently expressed
new_currencyThe commodity to which the balance should be converted
Returns
A price, or gnc_numeric_zero if no price is available.

Definition at line 2623 of file gnc-pricedb.c.

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

◆ 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
pdbThe pricedb
orig_currencyThe commodity in which the balance is currently expressed
new_currencyThe commodity to which the balance should be converted
tThe time to be used for for comparison
Returns
A price, or gnc_numeric_zero if no price is available.

Definition at line 2605 of file gnc-pricedb.c.

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

◆ 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
pdbThe pricedb
orig_currencyThe commodity in which the balance is currently expressed
new_currencyThe commodity to which the balance should be converted
tThe time in which the nearest price should be used.
Returns
A price, or gnc_numeric_zero if no price is available.

Definition at line 2614 of file gnc-pricedb.c.

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

◆ 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 988 of file gnc-pricedb.c.

989 {
990  guint count;
991 
992  if (!db) return 0;
993 
994  count = 0;
995 
996  gnc_pricedb_foreach_price(db, num_prices_helper, &count, FALSE);
997 
998  return count;
999 }
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...
Definition: gnc-pricedb.c:2874

◆ 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
dbThe pricedb from which to retrieve prices.
commodityThe commodity for which prices should be retrieved.
currencyThe 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 2108 of file gnc-pricedb.c.

2111 {
2112  GList *result;
2113  GList *node;
2114 
2115 
2116  if (!db || !commodity) return NULL;
2117  ENTER ("db=%p commodity=%p currency=%p", db, commodity, currency);
2118  result = pricedb_get_prices_internal (db, commodity, currency, FALSE);
2119  if (!result) return NULL;
2120  for (node = result; node; node = node->next)
2121  gnc_price_ref (node->data);
2122 
2123  LEAVE (" ");
2124  return result;
2125 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
void gnc_price_ref(GNCPrice *p)
gnc_price_ref - indicate your need for a given price to stick around (i.e.
Definition: gnc-pricedb.c:336

◆ 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
dbThe pricedb to check
commodityThe commodity to check for the existence of prices
currencyThe commodity in which prices are sought. If NULL reports all commodities.
Returns
TRUE if matching prices are found, FALSE otherwise.

Definition at line 2069 of file gnc-pricedb.c.

2072 {
2073  GList *price_list;
2074  GHashTable *currency_hash;
2075  gint size;
2076 
2077  if (!db || !commodity) return FALSE;
2078  ENTER ("db=%p commodity=%p currency=%p", db, commodity, currency);
2079  currency_hash = g_hash_table_lookup(db->commodity_hash, commodity);
2080  if (!currency_hash)
2081  {
2082  LEAVE("no, no currency_hash table");
2083  return FALSE;
2084  }
2085 
2086  if (currency)
2087  {
2088  price_list = g_hash_table_lookup(currency_hash, currency);
2089  if (price_list)
2090  {
2091  LEAVE("yes");
2092  return TRUE;
2093  }
2094  LEAVE("no, no price list");
2095  return FALSE;
2096  }
2097 
2098  size = g_hash_table_size (currency_hash);
2099  LEAVE("%s", size > 0 ? "yes" : "no");
2100  return size > 0;
2101 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ gnc_pricedb_lookup_at_time64()

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

Find the price between two commodities at a time64.

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

Parameters
dbThe pricedb
commodityThe first commodity
currencyThe second commodity
tThe time64 at which to retrieve the price.
Returns
A GNCPrice or NULL if none matches.

Definition at line 2246 of file gnc-pricedb.c.

2250 {
2251  GList *price_list;
2252  GList *item = NULL;
2253 
2254  if (!db || !c || !currency) return NULL;
2255  ENTER ("db=%p commodity=%p currency=%p", db, c, currency);
2256  price_list = pricedb_get_prices_internal (db, c, currency, TRUE);
2257  item = price_list;
2258  while (item)
2259  {
2260  GNCPrice *p = item->data;
2261  time64 price_time = gnc_price_get_time64(p);
2262  if (price_time == t)
2263  {
2264  gnc_price_ref(p);
2265  g_list_free (price_list);
2266  LEAVE("price is %p", p);
2267  return p;
2268  }
2269  item = item->next;
2270  }
2271  g_list_free (price_list);
2272  LEAVE (" ");
2273  return NULL;
2274 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
gint64 time64
Many systems, including Microsoft Windows and BSD-derived Unixes like Darwin, are retaining the int-3...
Definition: gnc-date.h:93
void gnc_price_ref(GNCPrice *p)
gnc_price_ref - indicate your need for a given price to stick around (i.e.
Definition: gnc-pricedb.c:336

◆ 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
dbThe pricedb
commodityThe first commodity
currencyThe second commodity
tA 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 2237 of file gnc-pricedb.c.

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

◆ 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
dbThe pricedb
commodityThe first commodity
currencyThe second commodity
Returns
A GNCPrice or NULL if no price exists.

Definition at line 1791 of file gnc-pricedb.c.

1794 {
1795  GList *price_list;
1796  GNCPrice *result;
1797 
1798  if (!db || !commodity || !currency) return NULL;
1799  ENTER ("db=%p commodity=%p currency=%p", db, commodity, currency);
1800 
1801  price_list = pricedb_get_prices_internal(db, commodity, currency, TRUE);
1802  if (!price_list) return NULL;
1803  /* This works magically because prices are inserted in date-sorted
1804  * order, and the latest date always comes first. So return the
1805  * first in the list. */
1806  result = price_list->data;
1807  gnc_price_ref(result);
1808  g_list_free (price_list);
1809  LEAVE("price is %p", result);
1810  return result;
1811 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
void gnc_price_ref(GNCPrice *p)
gnc_price_ref - indicate your need for a given price to stick around (i.e.
Definition: gnc-pricedb.c:336

◆ 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
dbThe pricedb
commodityThe commodity for which to obtain prices
Returns
A PriceList of prices found, or NULL if none found.

Definition at line 2016 of file gnc-pricedb.c.

2018 {
2020  gnc_time(NULL));
2021 }
time64 gnc_time(time64 *tbuf)
get the current local time
Definition: gnc-date.cpp:273
PriceList * gnc_pricedb_lookup_nearest_before_any_currency_t64(GNCPriceDB *db, const gnc_commodity *commodity, time64 t)
Return the nearest price between the given commodity and any other before the given time...
Definition: gnc-pricedb.c:2044

◆ 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
dbThe pricedb
cThe commodity
tThe time before which to find prices
Returns
A PriceList of prices for each commodity found or NULL if none are.

Definition at line 2044 of file gnc-pricedb.c.

2047 {
2048  GList *prices = NULL, *result;
2049  UsesCommodity helper = {&prices, commodity, t};
2050  result = NULL;
2051 
2052  if (!db || !commodity) return NULL;
2053  ENTER ("db=%p commodity=%p", db, commodity);
2054 
2055  pricedb_pricelist_traversal(db, price_list_scan_any_currency,
2056  &helper);
2057  prices = g_list_sort(prices, compare_prices_by_date);
2058  result = latest_before(prices, commodity, t);
2059  gnc_price_list_destroy(prices);
2060  LEAVE(" ");
2061  return result;
2062 }
void gnc_price_list_destroy(PriceList *prices)
gnc_price_list_destroy - destroy the given price list, calling gnc_price_unref on all the prices incl...
Definition: gnc-pricedb.c:790
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ 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
dbThe pricedb
cThe first commodity
currencyThe second commodity
tThe time before which to find the price
Returns
A GNCPrice or NULL if no prices are found before t.

Definition at line 2400 of file gnc-pricedb.c.

2404 {
2405  GList *price_list;
2406  GNCPrice *current_price = NULL;
2407  /* GNCPrice *next_price = NULL;
2408  GNCPrice *result = NULL;*/
2409  GList *item = NULL;
2410  time64 price_time;
2411 
2412  if (!db || !c || !currency) return NULL;
2413  ENTER ("db=%p commodity=%p currency=%p", db, c, currency);
2414  price_list = pricedb_get_prices_internal (db, c, currency, TRUE);
2415  if (!price_list) return NULL;
2416  item = price_list;
2417  do
2418  {
2419  price_time = gnc_price_get_time64 (item->data);
2420  if (price_time <= t)
2421  current_price = item->data;
2422  item = item->next;
2423  }
2424  while (price_time > t && item);
2425  gnc_price_ref(current_price);
2426  g_list_free (price_list);
2427  LEAVE (" ");
2428  return current_price;
2429 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
gint64 time64
Many systems, including Microsoft Windows and BSD-derived Unixes like Darwin, are retaining the int-3...
Definition: gnc-date.h:93
void gnc_price_ref(GNCPrice *p)
gnc_price_ref - indicate your need for a given price to stick around (i.e.
Definition: gnc-pricedb.c:336

◆ 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
dbThe pricedb
cThe first commodity
currencyThe second commodity
tThe 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 2390 of file gnc-pricedb.c.

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

◆ 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,Thepricedb
c,Thecommodity for which prices should be obtained.
t,Thetime 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 2024 of file gnc-pricedb.c.

2027 {
2028  GList *prices = NULL, *result;
2029  UsesCommodity helper = {&prices, commodity, t};
2030  result = NULL;
2031 
2032  if (!db || !commodity) return NULL;
2033  ENTER ("db=%p commodity=%p", db, commodity);
2034 
2035  pricedb_pricelist_traversal(db, price_list_scan_any_currency, &helper);
2036  prices = g_list_sort(prices, compare_prices_by_date);
2037  result = nearest_to(prices, commodity, t);
2038  gnc_price_list_destroy(prices);
2039  LEAVE(" ");
2040  return result;
2041 }
void gnc_price_list_destroy(PriceList *prices)
gnc_price_list_destroy - destroy the given price list, calling gnc_price_unref on all the prices incl...
Definition: gnc-pricedb.c:790
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ 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
dbThe pricedb
cThe commodity whose nth price is needed
nZero 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 2185 of file gnc-pricedb.c.

2188 {
2189  static const gnc_commodity *last_c = NULL;
2190  static GList *prices = NULL;
2191 
2192  GNCPrice *result = NULL;
2193  GHashTable *currency_hash;
2194  g_return_val_if_fail (GNC_IS_COMMODITY (c), NULL);
2195 
2196  if (!db || !c || n < 0) return NULL;
2197  ENTER ("db=%p commodity=%s index=%d", db, gnc_commodity_get_mnemonic(c), n);
2198 
2199  if (last_c && prices && last_c == c && db->reset_nth_price_cache == FALSE)
2200  {
2201  result = g_list_nth_data (prices, n);
2202  LEAVE ("price=%p", result);
2203  return result;
2204  }
2205 
2206  last_c = c;
2207 
2208  if (prices)
2209  {
2210  g_list_free (prices);
2211  prices = NULL;
2212  }
2213 
2214  db->reset_nth_price_cache = FALSE;
2215 
2216  currency_hash = g_hash_table_lookup (db->commodity_hash, c);
2217  if (currency_hash)
2218  {
2219  GList *currencies = g_hash_table_get_values (currency_hash);
2220  g_list_foreach (currencies, list_combine, &prices);
2221  result = g_list_nth_data (prices, n);
2222  g_list_free (currencies);
2223  }
2224 
2225  LEAVE ("price=%p", result);
2226  return result;
2227 }
const char * gnc_commodity_get_mnemonic(const gnc_commodity *cm)
Retrieve the mnemonic for the specified commodity.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ 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
dbThe pricedb
cThe commodity
Returns
The number of prices in the database for this commody, zero if none

Definition at line 2139 of file gnc-pricedb.c.

2141 {
2142  int result = 0;
2143  GHashTable *currency_hash;
2144 
2145  if (!db || !c) return 0;
2146  ENTER ("db=%p commodity=%p", db, c);
2147 
2148  currency_hash = g_hash_table_lookup(db->commodity_hash, c);
2149  if (currency_hash)
2150  {
2151  g_hash_table_foreach(currency_hash, price_count_helper, (gpointer)&result);
2152  }
2153 
2154  LEAVE ("count=%d", result);
2155  return result;
2156 }
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282

◆ 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
dbThe pricedb
comm_listA list of commodities
fiscal_end_datethe end date of the current accounting period
cutoffThe time before which prices should be deleted.
sourceWhether Finance::Quote, user or all prices should be deleted.
keepWhether scaled, monthly, weekly or no prices should be left.
Returns
True if there were prices to process, False if not.

Definition at line 1605 of file gnc-pricedb.c.

1609 {
1610  remove_info data;
1611  GList *node;
1612  char datebuff[MAX_DATE_LENGTH + 1];
1613  memset (datebuff, 0, sizeof(datebuff));
1614 
1615  data.db = db;
1616  data.cutoff = cutoff;
1617  data.list = NULL;
1618  data.delete_fq = FALSE;
1619  data.delete_user = FALSE;
1620  data.delete_app = FALSE;
1621 
1622  ENTER("Remove Prices for Source %d, keeping %d", source, keep);
1623 
1624  // setup the source options
1625  if (source & PRICE_REMOVE_SOURCE_APP)
1626  data.delete_app = TRUE;
1627 
1628  if (source & PRICE_REMOVE_SOURCE_FQ)
1629  data.delete_fq = TRUE;
1630 
1631  if (source & PRICE_REMOVE_SOURCE_USER)
1632  data.delete_user = TRUE;
1633 
1634  // Walk the list of commodities
1635  for (node = g_list_first (comm_list); node; node = g_list_next (node))
1636  {
1637  GHashTable *currencies_hash = g_hash_table_lookup (db->commodity_hash, node->data);
1638  g_hash_table_foreach (currencies_hash, pricedb_remove_foreach_pricelist, &data);
1639  }
1640 
1641  if (data.list == NULL)
1642  {
1643  LEAVE("Empty price list");
1644  return FALSE;
1645  }
1646  qof_print_date_buff (datebuff, sizeof(datebuff), cutoff);
1647  DEBUG("Number of Prices in list is %d, Cutoff date is %s",
1648  g_slist_length (data.list), datebuff);
1649 
1650  // Check for a valid fiscal end of year date
1651  if (fiscal_end_date == NULL)
1652  {
1653  GDateYear year_now = g_date_get_year (gnc_g_date_new_today ());
1654  fiscal_end_date = g_date_new ();
1655  g_date_set_dmy (fiscal_end_date, 31, 12, year_now);
1656  }
1657  else if (g_date_valid (fiscal_end_date) == FALSE)
1658  {
1659  GDateYear year_now = g_date_get_year (gnc_g_date_new_today ());
1660  g_date_clear (fiscal_end_date, 1);
1661  g_date_set_dmy (fiscal_end_date, 31, 12, year_now);
1662  }
1663  gnc_pricedb_process_removal_list (db, fiscal_end_date, data, keep);
1664 
1665  g_slist_free (data.list);
1666  LEAVE(" ");
1667  return TRUE;
1668 }
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:264
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
#define MAX_DATE_LENGTH
The maximum length of a string created by the date printers.
Definition: gnc-date.h:114
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
size_t qof_print_date_buff(char *buff, size_t buflen, time64 secs)
Convenience: calls through to qof_print_date_dmy_buff().
Definition: gnc-date.cpp:581
GDate * gnc_g_date_new_today()
Returns a newly allocated date of the current clock time, taken from time(2).
Definition: gnc-date.cpp:1229

◆ gnc_pricedb_remove_price()

gboolean gnc_pricedb_remove_price ( GNCPriceDB *  db,
GNCPrice *  p 
)

Remove a price from the pricedb and unref the price.

Parameters
dbThe Pricedb
pThe price to remove.

Definition at line 1276 of file gnc-pricedb.c.

1277 {
1278  gboolean rc;
1279  char datebuff[MAX_DATE_LENGTH + 1];
1280  memset(datebuff, 0, sizeof(datebuff));
1281  if (!db || !p) return FALSE;
1282  ENTER ("db=%p, pr=%p dirty=%d destroying=%d",
1283  db, p, qof_instance_get_dirty_flag(p),
1285 
1286  gnc_price_ref(p);
1287  qof_print_date_buff(datebuff, sizeof(datebuff), gnc_price_get_time64 (p));
1288  DEBUG("Remove Date is %s, Commodity is %s, Source is %s", datebuff,
1289  gnc_commodity_get_fullname (gnc_price_get_commodity (p)),
1290  gnc_price_get_source_string (p));
1291 
1292  rc = remove_price (db, p, TRUE);
1294  qof_instance_set_dirty(&db->inst);
1296 
1297  /* invoke the backend to delete this price */
1298  gnc_price_begin_edit (p);
1299  qof_instance_set_destroying(p, TRUE);
1300  gnc_price_commit_edit (p);
1301  p->db = NULL;
1302  gnc_price_unref(p);
1303  LEAVE ("db=%p, pr=%p", db, p);
1304  return rc;
1305 }
void gnc_price_unref(GNCPrice *p)
gnc_price_unref - indicate you&#39;re finished with a price (i.e.
Definition: gnc-pricedb.c:343
#define DEBUG(format, args...)
Print a debugging message.
Definition: qoflog.h:264
gboolean qof_instance_get_destroying(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object is about to be destroyed.
#define ENTER(format, args...)
Print a function entry debugging message.
Definition: qoflog.h:272
gboolean qof_instance_get_dirty_flag(gconstpointer ptr)
Retrieve the flag that indicates whether or not this object has been modified.
const char * gnc_commodity_get_fullname(const gnc_commodity *cm)
Retrieve the full name for the specified commodity.
void gnc_pricedb_begin_edit(GNCPriceDB *pdb)
Begin an edit.
Definition: gnc-pricedb.c:446
#define MAX_DATE_LENGTH
The maximum length of a string created by the date printers.
Definition: gnc-date.h:114
#define LEAVE(format, args...)
Print a function exit debugging message.
Definition: qoflog.h:282
void gnc_price_ref(GNCPrice *p)
gnc_price_ref - indicate your need for a given price to stick around (i.e.
Definition: gnc-pricedb.c:336
size_t qof_print_date_buff(char *buff, size_t buflen, time64 secs)
Convenience: calls through to qof_print_date_dmy_buff().
Definition: gnc-date.cpp:581
void gnc_pricedb_commit_edit(GNCPriceDB *pdb)
Commit an edit.
Definition: gnc-pricedb.c:452

◆ 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
dbThe pricedb
bulk_updateTRUE to disable duplication checks, FALSE to enable them.

Definition at line 938 of file gnc-pricedb.c.

939 {
940  db->bulk_update = bulk_update;
941 }