CAAccountingInstance.hpp

Go to the documentation of this file.

/*
Copyright (c) 2000, The JAP-Team
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

  - Redistributions of source code must retain the above copyright notice,
    this list of conditions and the following disclaimer.

  - Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation and/or
    other materials provided with the distribution.

  - Neither the name of the University of Technology Dresden, Germany nor the names of its contributors
    may be used to endorse or promote products derived from this software without specific
    prior written permission.


THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
*/



#ifndef __CAACCOUNTINGINSTANCE__
#define __CAACCOUNTINGINSTANCE__
#include "doxygen.h"
#ifdef PAYMENT
#include "CAFirstMix.hpp"
#include "CAFirstMixChannelList.hpp"
#include "CASymCipher.hpp"
#include "CAQueue.hpp"
#include "CAThread.hpp"
#include "CATempIPBlockList.hpp"
#include "CAThreadPool.hpp"
#include "CAAccountingDBInterface.hpp"
#include "CAAccountingBIInterface.hpp"
#include "CAAccountingControlChannel.hpp"
#include "CAAccountingSettleThread.hpp"
#include "CACmdLnOptions.hpp"
#include "Hashtable.hpp"
#include "CAMix.hpp"
#include "xml/DOM_Output.hpp"
#include "CAStatusManager.hpp"

// we want a costconfirmation from the user for every megabyte
// after 2megs of unconfirmed traffic we kick the user out
// todo put this in the configfile
//#define HARDLIMIT_UNCONFIRMED_BYTES 1024*1024*2
//#define SOFTLIMIT_UNCONFIRMED_BYTES 1024*512

// the number of seconds that may pass between a pay request
// and the jap sending its answer
#define CHALLENGE_TIMEOUT 15
#define HARD_LIMIT_TIMEOUT 30
#define AUTH_TIMEOUT 15
#define CRITICAL_SUBSEQUENT_BI_CONN_ERRORS 5

#define CLIENT_VERSION_STR_LEN 20
#define PREPAID_PROTO_CLIENT_VERSION "00.10.057"

#define CRITICAL_SETTLE_FLAGS \
  (AUTH_INVALID_ACCOUNT | AUTH_ACCOUNT_EMPTY | AUTH_BLOCKED | AUTH_UNKNOWN)

struct t_fmhashtableentry;

struct AccountLoginHashEntry
{
  UINT64 accountNumber;
  UINT64 confirmedBytes;
  UINT64 userID;
  UINT32 authFlags;
  UINT32 authRemoveFlags;
  UINT32 count;
  CAMutex *ownerLock;
  struct t_fmhashtableentry *ownerRef;
  bool loginOngoing;
};

struct SettleEntry
{
  UINT64 accountNumber;
  UINT32 authFlags;
  UINT32 authRemoveFlags;
  UINT64 confirmedBytes;
  UINT64 diffBytes;
  SettleEntry* nextEntry;
  SINT32 storedStatus;
};

bool testAndSetLoginOwner(struct AccountLoginHashEntry *loginEntry, struct t_fmhashtableentry *ownerRef);
bool resetLoginOngoing(struct AccountLoginHashEntry *loginEntry, struct t_fmhashtableentry *ownerRef);
bool testLoginEntryOwner(struct AccountLoginHashEntry *loginEntry, fmHashTableEntry *ownerRef);
bool isLoginOngoing(struct AccountLoginHashEntry *loginEntry, struct t_fmhashtableentry *ownerRef);
inline bool testLoginEntryOwner_internal(struct AccountLoginHashEntry *loginEntry, struct t_fmhashtableentry *ownerRef);

class CAAccountingInstance
{
  friend class CAFirstMixA;
  friend class CAFirstMix;
public:

  static SINT32 init(CAFirstMix* callingMix)
    {
        ms_pInstance = new CAAccountingInstance(callingMix);
        MONITORING_FIRE_PAY_EVENT(ev_pay_aiInited);
        return E_SUCCESS;
    }

  static SINT32 clean()
    {
      if(ms_pInstance != NULL)
      {
        delete ms_pInstance;
        ms_pInstance=NULL;
      }
      if(m_preparedCCRequest != NULL)
      {
        m_preparedCCRequest->release();
        m_preparedCCRequest = NULL;
      }
      MONITORING_FIRE_PAY_EVENT(ev_pay_aiShutdown);
      return E_SUCCESS;
    }

  static UINT32 getAuthFlags(fmHashTableEntry * pHashEntry);

  static SINT32 cleanupTableEntry(fmHashTableEntry * pHashEntry);
  static SINT32 initTableEntry(fmHashTableEntry * pHashEntry);

  static SINT32 handleJapPacket(fmHashTableEntry *pHashEntry, bool a_bControlMessage, bool a_bMessageToJAP);

  static SINT32 isIPAddressBlocked(const UINT8 ip[4])
  {
    //return ms_pInstance->m_pIPBlockList->checkIP(ip);
    return 0;
  }

  static SINT32 processJapMessage(fmHashTableEntry * pHashEntry,const  XERCES_CPP_NAMESPACE::DOMDocument* a_DomDoc);
  static UINT32 getNrOfUsers();

  static SINT32 loginProcessStatus(fmHashTableEntry *pHashEntry);
  static SINT32 finishLoginProcess(fmHashTableEntry *pHashEntry);
  //static void forcedSettle();

  static SINT32 settlementTransaction();
  static SettleEntry *__handleSettleResult(CAXMLCostConfirmation *pCC, CAXMLErrorMessage *pErrMsg, CAAccountingDBInterface *dbInterface,
    UINT64 a_iSettlementTransactionNr);
  static void __commitSettlementToDatabase(SettleEntry *entryList, CAAccountingDBInterface *dbInterface);
  static void __commitSettlementToLoginTable(SettleEntry *entryList);
  static SINT32 newSettlementTransaction();
  static SINT32 __newSettlementTransaction(UINT32 *nrOfSettledCCs);


  static const SINT32 HANDLE_PACKET_CONNECTION_OK; // this packet has been checked and is OK
  static const SINT32 HANDLE_PACKET_CONNECTION_UNCHECKED; // the packet might be OK (is it not checked)
  static const SINT32 HANDLE_PACKET_HOLD_CONNECTION; // queue packets until JAP has authenticated
  static const SINT32 HANDLE_PACKET_PREPARE_FOR_CLOSING_CONNECTION; // small grace period until kickout
  static const SINT32 HANDLE_PACKET_CLOSE_CONNECTION; // this connection should be closed immediatly


  static const UINT32 MAX_SETTLED_CCS; // do not settle more that X cost confirmations in one settle connection
private:

  CAAccountingInstance(CAFirstMix* callingMix); //Singleton!
  ~CAAccountingInstance();

  struct t_aiqueueitem
  {
    XERCES_CPP_NAMESPACE::DOMDocument*      pDomDoc;
    tAiAccountingInfo*    pAccInfo;
    void (CAAccountingInstance::*handleFunc)(tAiAccountingInfo*,DOMElement*);
  };
  typedef struct t_aiqueueitem aiQueueItem;

  static SINT32 handleJapPacket_internal(fmHashTableEntry *pHashEntry, bool a_bControlMessage, bool a_bMessageToJAP);

  static UINT64 unlockLogin(fmHashTableEntry *ownerRef);
  static void processJapMessageLoginHelper(fmHashTableEntry *pHashEntry,
                       UINT32 handlerReturnvalue,
                       bool finishLogin);
  UINT32 handleCostConfirmation(tAiAccountingInfo* pAccInfo, DOMElement* root );
  UINT32 handleCostConfirmation_internal(tAiAccountingInfo* pAccInfo, DOMElement* root );

  UINT32 handleAccountCertificate(tAiAccountingInfo* pAccInfo, DOMElement* root );
  UINT32 handleAccountCertificate_internal(tAiAccountingInfo* pAccInfo, DOMElement* root );


  UINT32 handleChallengeResponse(tAiAccountingInfo* pAccInfo, DOMElement* root);
  UINT32 handleChallengeResponse_internal(tAiAccountingInfo* pAccInfo, DOMElement* root);

  bool cascadeMatchesCC(CAXMLCostConfirmation *pCC);

  static SINT32 getPrepaidBytes(tAiAccountingInfo* pAccInfos);
  SINT32 prepareCCRequest(CAMix* callingMix, UINT8* a_AiName);
  static SINT32 makeInitialCCRequest(CAXMLCostConfirmation *pCC, XERCES_CPP_NAMESPACE::DOMDocument* & doc, SINT32 prepaidBytes);
  static SINT32 makeCCRequest( const UINT64 accountNumber, const UINT64 transferredBytes,  XERCES_CPP_NAMESPACE::DOMDocument* & doc);
  static SINT32 sendInitialCCRequest(tAiAccountingInfo* pAccInfo, CAXMLCostConfirmation *pCC, SINT32 prepaidBytes);
  static SINT32 sendCCRequest(tAiAccountingInfo* pAccInfo);
  static SINT32 makeAccountRequest( XERCES_CPP_NAMESPACE::DOMDocument* & doc);
  static SINT32 sendAILoginConfirmation(tAiAccountingInfo* pAccInfo, const UINT32 code, UINT8 * message);

  //possible replies to a JAP
  static SINT32 returnKickout(tAiAccountingInfo* pAccInfo);
  static SINT32 returnPrepareKickout(tAiAccountingInfo* pAccInfo, CAXMLErrorMessage* a_error);

  static void setPrepaidBytesToZero(tAiAccountingInfo* pAccInfo);

  static inline void setPrepaidBytesToZero_internal(tAiAccountingInfo* pAccInfo);

  //static THREAD_RETURN aiThreadMainLoop(void *param);

  static THREAD_RETURN processThread(void* a_param);

  static const UINT64 PACKETS_BEFORE_NEXT_CHECK;

  static const UINT32 MAX_TOLERATED_MULTIPLE_LOGINS;

  static XERCES_CPP_NAMESPACE::DOMDocument* m_preparedCCRequest;

  CAThreadPool* m_aiThreadPool;

  CAMutex *m_pMutex;

  Hashtable* m_certHashCC;

  Hashtable* m_currentAccountsHashtable;
  CAFirstMix *m_mix;

  UINT8* m_AiName;

  // (same hash values as in CCs and in the JPI, as taken from the MixInfo)
  // we concatenate price certificates rather than mix-skis because a cascade with changed prices counts as a new/different cascade
  UINT8* m_currentCascade;

  UINT8** m_allHashes;
  UINT32 m_allHashesLen;

  //CAAccountingDBInterface * m_dbInterface;
  CAAccountingBIInterface *m_pPiInterface;

  UINT32 m_iSoftLimitBytes;
  UINT32 m_iHardLimitBytes;

  CATempIPBlockList * m_pIPBlockList;

  static CAAccountingInstance * ms_pInstance;

  //CASignature * m_pJpiVerifyingInstance;

  CAAccountingSettleThread * m_pSettleThread;

  static SINT32 m_prepaidBytesMinimum;

  bool m_bThreadRunning;

  //bool m_loginHashTableChangeInProgress;

  /* For Thread synchronisation can only be set and read when m_pSettlementMutex lock is acquired */
  volatile UINT64 m_nextSettleNr;
  volatile UINT64 m_settleWaitNr;
  CAConditionVariable *m_pSettlementMutex;

  volatile UINT32 m_seqBIConnErrors;

  static volatile UINT64 m_iCurrentSettleTransactionNr;
};


#endif
#endif //Payment