Dbo/Accounts/Accounts.cpp

Go to the documentation of this file.

#line 2 "src/Dbo/Accounts/Accounts.cpp"
 
#include "../../Glb/Core.h"
#include "../../App.h"
#include "Accounts.h"
 
const char * GCW::Dbo::Accounts::s_tableName = "accounts";
 
/*!
** \code
** ;   type               drcr            name           colAccount   colDr        colCr           parentType
** \endcode
**
** These are the account-types, debit/credit types, and register column labels for said accounts.
**
** \sa \ref GCW::Eng::AccountRegisterModel::refreshFromDisk() "refreshFromDisk()"
**
** \sa \ref account_type_labels "Account Type Labels"
*/
const std::vector< GCW::Dbo::Accounts::AccountDef_t > GCW::Dbo::Accounts::s_accountDefs =
{// type               drcr            backendName    colAccount   colDr        colCr           parentType
  { Type::INVALID    , DrCr::NONE   ,  "INVALID"    , "account"  , "fundsin"  , "fundsout"    ,                 },
  { Type::NONE       , DrCr::NONE   ,  "NONE"       , "account"  , "fundsin"  , "fundsout"    ,                 },
  { Type::ROOT       , DrCr::NONE   ,  "ROOT"       , "account"  , "debit"    , "credit"      ,                 },
  { Type::BANK       , DrCr::DEBIT  ,  "BANK"       , "transfer" , "deposit"  , "withdrawal"  , Type::ASSET     },
  { Type::CASH       , DrCr::DEBIT  ,  "CASH"       , "transfer" , "receive"  , "spend"       , Type::ASSET     },
  { Type::CREDIT     , DrCr::CREDIT ,  "CREDIT"     , "blank"    , "payment"  , "charge"      , Type::LIABILITY },
  { Type::ASSET      , DrCr::DEBIT  ,  "ASSET"      , "transfer" , "increase" , "decrease"    , Type::ASSET     },
  { Type::LIABILITY  , DrCr::CREDIT ,  "LIABILITY"  , "account"  , "decrease" , "increase"    , Type::LIABILITY },
  { Type::STOCK      , DrCr::DEBIT  ,  "STOCK"      , "account"  , "buy"      , "sell"        , Type::ASSET     },
  { Type::MUTUAL     , DrCr::DEBIT  ,  "MUTUAL"     , "account"  , "buy"      , "sell"        , Type::ASSET     },
  { Type::CURRENCY   , DrCr::DEBIT  ,  "CURRENCY"   , "account"  , "buy"      , "sell"        , Type::ASSET     },
  { Type::INCOME     , DrCr::CREDIT ,  "INCOME"     , "account"  , "charge"   , "income"      , Type::INCOME    },
  { Type::EXPENSE    , DrCr::DEBIT  ,  "EXPENSE"    , "transfer" , "expense"  , "rebate"      , Type::EXPENSE   },
  { Type::EQUITY     , DrCr::CREDIT ,  "EQUITY"     , "transfer" , "decrease" , "increase"    , Type::EQUITY    },
  { Type::RECEIVABLE , DrCr::DEBIT  ,  "RECEIVABLE" , "transfer" , "invoice"  , "payment"     , Type::ASSET     },
  { Type::PAYABLE    , DrCr::CREDIT ,  "PAYABLE"    , "account"  , "payment"  , "bill"        , Type::LIABILITY },
  { Type::TRADING    , DrCr::DEBIT  ,  "TRADING"    , "account"  , "decrease" , "increase"    , Type::ASSET     },
  { Type::CHECKING   , DrCr::DEBIT  ,  "CHECKING"   , "account"  , "debit"    , "credit"      , Type::ASSET     },
  { Type::SAVINGS    , DrCr::DEBIT  ,  "SAVINGS"    , "account"  , "debit"    , "credit"      , Type::ASSET     },
  { Type::MONEYMRKT  , DrCr::DEBIT  ,  "MONEYMRKT"  , "account"  , "debit"    , "credit"      , Type::ASSET     },
  { Type::CREDITLINE , DrCr::CREDIT ,  "CREDITLINE" , "account"  , "decrease" , "increase"    , Type::LIABILITY },
 
}; /// endGCW::Dbo::Accounts::s_accountDefs
 
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::guid             = "guid"           ; // text(32) PRIMARY KEY NOT NULL
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::name             = "name"           ; // text(2048) NOT NULL
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::account_typeName = "account_type"   ; // text(2048) NOT NULL
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::commodity_guid   = "commodity_guid" ; // text(32)
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::commodity_scu    = "commodity_scu"  ; // integer NOT NULL
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::non_std_scu      = "non_std_scu"    ; // integer NOT NULL
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::parent_guid      = "parent_guid"    ; // text(32)
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::code             = "code"           ; // text(2048)
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::description      = "description"    ; // text(2048)
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::hidden           = "hidden"         ; // integer
const Wt::WFormModel::Field GCW::Dbo::Accounts::Field::placeHolder      = "placeholder"    ; // integer
 
namespace {
 
/*!
** \brief Accounts Sorter
**
**
*/
auto sort( GCW::Dbo::Accounts::Item::Vector & _accountItems )-> void
{
  /*!
  ** Sort the vector of accounts by fullname so that they can be loaded
  **  in to the model in proper sequential order.
  **
  */
  std::sort
  (
   _accountItems.begin(),
   _accountItems.end(),
   []( const GCW::Dbo::Accounts::Item::Ptr item1,
       const GCW::Dbo::Accounts::Item::Ptr item2
     )
     {
       auto fullName1 = GCW::Dbo::Accounts::fullName( item1-> guid() );
       auto fullName2 = GCW::Dbo::Accounts::fullName( item2-> guid() );
 
       /*
       ** return .bool. if the .fullName1. is .less than. the .fullName2. date
       **
       */
       return fullName1
            < fullName2;
     }
  );
 
} // endvoid sort( GCW::Dbo::Splits::Item::Vector & _splitItems )
 
auto
rootSql( const std::string & _key )-> GCW::Dbo::Accounts::Item::Ptr
{
  GCW::Dbo::Accounts::Item::Ptr retVal;
 
  Wt::Dbo::Transaction t( GCW::app()-> gnucashew_session() );
 
  /*
  ** Get a handle on the root account.  The root account is the only
  **  account that has no parent, and has a name == "Root Account".
  **  There should only be one of these.
  **
  */
  auto results =
    GCW::app()-> gnucashew_session().find< GCW::Dbo::Accounts::Item >()
    .where( "(parent_guid = '' OR parent_guid IS NULL) AND name = ?" )
    .bind( _key )
    .resultList()
    ;
 
  if( results.size() == 1 )
  {
    retVal = *results.begin();
  }
 
  return retVal;
 
} // endrootSql()-> GCW::Dbo::Accounts::Item::Ptr
 
} // endnamespace {
 
auto
GCW::Dbo::Accounts::
rootAccount()-> GCW::Dbo::Accounts::Item::Ptr
{
  return rootSql( "Root Account" );
//  return rootGnc();
 
} // endroot()-> GCW::Dbo::Accounts::Item::Ptr
 
auto
GCW::Dbo::Accounts::
templateRootAccount()-> GCW::Dbo::Accounts::Item::Ptr
{
  return rootSql( "Template Root" );
//  return rootGnc();
 
} // endroot()-> GCW::Dbo::Accounts::Item::Ptr
 
auto
GCW::Dbo::Accounts::
load( const std::string & _guid )-> GCW::Dbo::Accounts::Item::Ptr
{
  GCW::Dbo::Accounts::Item::Ptr retVal;
 
  if( _guid != "" )
  {
 
    Wt::Dbo::Transaction t( GCW::app()-> gnucashew_session() );
 
    try
    {
      retVal =
        GCW::app()-> gnucashew_session().load< GCW::Dbo::Accounts::Item >( _guid )
        ;
    }
 
    /*
    ** It is possible to provide a guid that doesn't exist.  This can happen
    **  in the bill-pay modules, since the bill-pay is somewhat loosely linked
    **  to the actual gnucash items, if a gnucash account gets deleted and the
    **  bill pay doesn't know about it, it can have a bad guid.
    **
    ** We don't care, we just return an .empty. item.
    */
    catch( std::exception & e )
    {
//      std::cout << __FILE__ << ":" << __LINE__ << " " << e.what() << std::endl;
    }
 
  } // endif( _guid != "" )
 
  return retVal;
 
} // endload( const std::string & _guid )-> GCW::Dbo::Accounts::Item::Ptr
 
auto
GCW::Dbo::Accounts::
byGuid( const std::string & _guid )-> GCW::Dbo::Accounts::Item::Ptr
{
  return load( _guid );
 
} // endbyGuid( const std::string & _guid )-> GCW::Dbo::Accounts::Item::Ptr
 
auto
GCW::Dbo::Accounts::
byChildName( const std::string & _parentGuid, const std::string & _childName )-> GCW::Dbo::Accounts::Item::Ptr
{
  GCW::Dbo::Accounts::Item::Ptr retVal;
 
  /*
  ** find an account matching the parent_guid and the child account name
  */
  retVal =
    GCW::app()-> gnucashew_session().find< GCW::Dbo::Accounts::Item >()
    .where( "parent_guid = ? AND name = ?" )
    .bind( _parentGuid )
    .bind( _childName )
    .resultValue()
    ;
 
  return retVal;
 
} // endbyChildName( const std::string & _parentGuid, const std::string & _childName )-> GCW::Dbo::Accounts::Item::Ptr
 
auto
GCW::Dbo::Accounts::
byFullName( const std::string & _fullName )-> GCW::Dbo::Accounts::Item::Ptr
{
  GCW::Dbo::Accounts::Item::Ptr retVal;
 
  /*
  ** Here we split the account full-name, so we can dive in
  **  to the accounts table and lope our way up to this
  **  account.
  **
  */
  auto split = GCW::Core::split( _fullName, ':' );
 
  /*
  ** Start at the root and lope on up.  The return value
  **  will be set accordingly as we go.  We should end on
  **  the final account, which is the one we wanted.
  **
  */
  Wt::Dbo::Transaction t( GCW::app()-> gnucashew_session() );
  retVal = rootAccount();
  for( int i=0; i< split.size(); i++ )
    retVal = byChildName( retVal-> guid(), split.at(i) );
 
  return retVal;
 
} // endbyFullName( const std::string & _fullName )-> GCW::Dbo::Accounts::Item::Ptr
 
auto
GCW::Dbo::Accounts::
byFullName( const char * _fullName )-> GCW::Dbo::Accounts::Item::Ptr
{
  return byFullName( std::string( _fullName ) );
}
 
auto
GCW::Dbo::Accounts::
byFullName( const Wt::WString & _fullName )-> GCW::Dbo::Accounts::Item::Ptr
{
  return byFullName( _fullName.toUTF8() );
}
 
auto
GCW::Dbo::Accounts::
allAccounts()-> GCW::Dbo::Accounts::Item::Vector
{
  GCW::Dbo::Accounts::Item::Vector retVal;
 
  auto results =
    GCW::app()-> gnucashew_session().find< GCW::Dbo::Accounts::Item >()
    .resultList()
    ;
 
  for( auto result : results )
    retVal.push_back( result );
 
  sort( retVal );
 
  return retVal;
 
} // endallAccounts()-> GCW::Dbo::Accounts::Item::Vector
 
auto
GCW::Dbo::Accounts::
activeAccounts()-> GCW::Dbo::Accounts::Item::Vector
{
  GCW::Dbo::Accounts::Item::Vector retVal;
 
  Wt::Dbo::Transaction t( GCW::app()-> gnucashew_session() );
  auto results =
    GCW::app()-> gnucashew_session().find< GCW::Dbo::Accounts::Item >()
    .resultList()
    ;
 
  /*
  ** push back all accounts that are
  **  _not_ hidden, and
  **  _not_ placeholder
  **
  */
  for( auto & result : results )
    if( !result-> hidden()
     && !result-> placeHolder()
      )
    retVal.push_back( result );
 
  sort( retVal );
 
  return retVal;
 
} // endactiveAccounts()-> GCW::Dbo::Accounts::Item::Vector
 
auto
GCW::Dbo::Accounts::
activeAccountsAnd( const std::string & _guid )-> GCW::Dbo::Accounts::Item::Vector
{
  GCW::Dbo::Accounts::Item::Vector retVal;
 
  Wt::Dbo::Transaction t( GCW::app()-> gnucashew_session() );
  auto results =
    GCW::app()-> gnucashew_session().find< GCW::Dbo::Accounts::Item >()
    .resultList()
    ;
 
  auto root = rootAccount();
  auto tmpl = templateRootAccount();
 
  /*
  ** push back all accounts that are
  **  this _guid match or
  **  _not_ hidden, and
  **  _not_ placeholder
  **
  */
  for( auto & result : results )
    if( result-> guid() == _guid
     || (  result != root
       &&  result != tmpl
       && !result-> hidden()
       && !result-> placeHolder()
        )
      )
    retVal.push_back( result );
 
  sort( retVal );
 
  return retVal;
 
} // endactiveAccountsAnd( const std::string & _guid )-> GCW::Dbo::Accounts::Item::Vector
 
auto
GCW::Dbo::Accounts::Children::
byParent( const std::string & _parentGuid )-> GCW::Dbo::Accounts::Item::Vector
{
  GCW::Dbo::Accounts::Item::Vector retVal;
 
#warning finish me
 
  return retVal;
 
} // endvector( const std::string & _parentGuid )-> GCW::Dbo::Accounts::Item::Vector
 
/*!
** \brief Compute Account Full-Name from Heirarchy
**
** This function will calculate the "full account name" from
**  the accountGuid up to the root parent.
**
*/
auto
GCW::Dbo::Accounts::
fullName( const std::string & _accountGuid )-> std::string
{
  /*!
  ** If the provided account guid is blank, then just return
  **  an empty string.
  **
  */
  if( _accountGuid == "" )
    return "";
 
  std::string retVal;
 
  /*
  ** Fetch the account by Guid
  **
  */
  auto accountItem = byGuid( _accountGuid );
 
  if( accountItem )
  {
    /*!
    ** During the building process, even though the "root account"
    **  is a valid account, it is ignored and not included in the
    **  results.
    **
    */
    if( accountItem == rootAccount() )
      return "";
 
    /*
    ** This is a recursive function that extracts the portions of
    **  the account names and assembles them in to a contiguous
    **  string with ':' colon separator.
    **
    */
    retVal = fullName( accountItem-> parent_guid() );
 
    /*
    ** If we got anything then we need a separator
    **
    */
    if( retVal != "" )
        retVal += ":";
 
    /*
    ** And, finally the name of our account.
    **
    */
    retVal += accountItem-> name();
 
  } // endif( accountItem )
 
  /*!
  ** Recursively, this should generate a name such as;
  **   "Assets:2023:Cash:FGB:OLB:2300-LSI"
  **
  */
  return retVal;
 
} // endfullName( const std::string & _accountGuid )-> std::string
 
auto
GCW::Dbo::Accounts::
fullName( Item::Ptr _item )-> std::string
{
  return fullName( _item-> guid() );
 
} // endfullName( Item::Ptr _item )-> std::string
 
 
auto
GCW::Dbo::Accounts::
isType( const Item::Ptr _acctItem, GCW::Dbo::Accounts::Type _type )-> bool
{
  /*
  ** if there is no account item, return false
  */
  if( !_acctItem )
    return false;
 
  /*
  ** if the account item is an ~type~, return true
  */
  if( _acctItem-> accountType() == _type )
    return true;
 
  /*
  ** poke in to the parent account, see if it's an ~type~
  */
  return isType( _acctItem-> parent_guid(), _type );
 
} // endisType( const Item::Ptr _acctItem, GCW::Dbo::Accounts::Type _type )-> bool
 
auto
GCW::Dbo::Accounts::
isType( const std::string & _guid, GCW::Dbo::Accounts::Type _type )-> bool
{
  /*
  ** if there is no guid, return false
  */
  if( _guid == "" )
    return false;
 
  /*
  ** make query
  */
  return isType( byGuid( _guid ), _type );
 
} // endisType( const std::string & _guid, GCW::Dbo::Accounts::Type _type )-> bool