Added some wrappers to speed-up things
[mailer.git] / inc / libs / wernis_functions.php
index c96ac9e968aa1edde34e72b8571a3f1c88be4303..48f3677c9c2a4c0e3efd7061f5c07f39b0dc0bd1 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 10/19/2003 *
- * ===============                              Last change: 08/12/2004 *
+ * Mailer v0.2.1-FINAL                                Start: 10/19/2003 *
+ * ===================                          Last change: 08/12/2004 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : what-points.php                                  *
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Alle Ihrer gesammelten Punkte                    *
  * -------------------------------------------------------------------- *
- *                                                                      *
+ * $Revision::                                                        $ *
+ * $Date::                                                            $ *
+ * $Tag:: 0.2.1-FINAL                                                 $ *
+ * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
- * Copyright (c) 2003 - 2008 by Roland Haeder                           *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
  ************************************************************************/
 
 // Some security stuff...
-if (ereg(basename(__FILE__), $_SERVER['PHP_SELF']))
-{
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
-       require($INC);
+if (!defined('__SECURITY')) {
+       die();
+} // END - if
+
+// Sets a status message and code
+function WERNIS_STATUS_MESSAGE ($message, $status) {
+       $GLOBALS['wernis_data']['message'] = $message;
+       $GLOBALS['wernis_data']['status']  = $status;
+}
+
+// Get the status message
+function GET_WERNIS_ERROR_MESSAGE () {
+       if (isset($GLOBALS['wernis_data']['message'])) {
+               // Use raw message
+               return $GLOBALS['wernis_data']['message'];
+       } elseif (isset($GLOBALS['wernis_data']['status'])) {
+               // Fall-back to status
+               return '{%message,WERNIS_ERROR_STATUS=' . $GLOBALS['wernis_data']['status'] . '%}';
+       } else {
+               // Something bad happend
+               return '{--WERNIS_UNKNOWN_ERROR--}';
+       }
+}
+
+// Get the status code
+function GET_WERNIS_ERROR_CODE () {
+       if (isset($GLOBALS['wernis_data']['status'])) {
+               // Use raw message
+               return $GLOBALS['wernis_data']['status'];
+       } else {
+               // Something bad happend
+               return '{--WERNIS_UNKNOWN_ERROR--}';
+       }
+}
+
+// Sends out a request to the API and returns it's result
+function WERNIS_SEND_REQUEST ($scriptName, $requestData = array()) {
+       // Is the requestData an array?
+       if (!is_array($requestData)) {
+               // Then abort here!
+               return array(
+                       'status'  => 'failed_general',
+                       'message' => '{--WERNIS_API_REQUEST_DATA_INVALID--}'
+               );
+       } // END - if
+
+       // Is the API id and MD5 hash there?
+       if ((getWernisApiId() == '') || (getWernisApiMd5() == '')) {
+               // Abort here...
+               return array(
+                       'status'  => 'failed_general',
+                       'message' => '{--WERNIS_API_REQUEST_DATA_MISSING--}'
+               );
+       } // END - if
+
+       // Add more request data
+       $requestData['api_id']  = getWernisApiId();
+       $requestData['api_key'] = getWernisApiMd5();
+
+       // Is a purpose there?
+       if (isset($requestData['purpose'])) {
+               // Eval the purpose
+               eval('$purpose = "' . doFinalCompilation($requestData['purpose'], FALSE) . '";');
+
+               // Prepare the purpose, it needs encoding
+               $requestData['purpose'] = encodeString($purpose);
+       } // END - if
+
+       // Construct the request string
+       $requestString = getWernisApiUrl() . $scriptName;
+
+       // Get the raw response from the lower function
+       $response = sendHttpPostRequest($requestString, $requestData);
+
+       // Check the response header if all is fine
+       if (!isHttpStatusOkay($response[0])) {
+               // Something bad happend... :(
+               return array(
+                       'status'  => 'request_error',
+                       'message' => '{%message,WERNIS_API_REQUEST_ERROR=' . $response[0] . '%}'
+               );
+       } // END - if
+
+       // All (maybe) fine so remove the response header from server
+       $responseLine = '*INVALID*';
+       for ($idx = (count($response) - 1); $idx > 1; $idx--) {
+               $line = trim($response[$idx]);
+               if (!empty($line)) {
+                       $responseLine = $line;
+                       break;
+               } // END - if
+       } // END - for
+
+       // Is the response leaded by a & symbol?
+       if (substr($responseLine, 0, 1) != '&') {
+               // Something badly happened on server-side
+               return array(
+                       'status'  => 'request_problem',
+                       'message' => sprintf(getMessage('WERNIS_API_REQUEST_PROBLEM'), $response[0], secureString($responseLine))
+               );
+       } // END - if
+
+       // Remove the leading & (which can be used in Flash)
+       $responseLine = substr($responseLine, 1);
+
+       // Bring back the response
+       $data = explode('=', $responseLine);
+
+       // Default return array (should not stay empty)
+       $return = array();
+
+       // We use only the first two entries (which shall be fine)
+       if ($data[0] === 'error') {
+               // The request has failed... :(
+               switch ($data[1]) {
+                       case '404': // Invalid API id
+                       case 'AUTH': // Authorization has failed
+                               $return = array(
+                                       'status'  => 'auth_failed',
+                                       'message' => '{--WERNIS_API_REQUEST_FAILED_AUTH--}'
+                               );
+                               break;
+
+                       case 'LOCKED': // User account is locked!
+                       case 'PASS': // Bad passphrase entered
+                       case 'USER': // Missing account or invalid password
+                               $return = array(
+                                       'status'  => 'user_failed',
+                                       'message' => '{--WERNIS_API_REQUEST_FAILED_USER--}'
+                               );
+                               break;
+
+                       case 'OWN': // Transfer to own account
+                               $return = array(
+                                       'status'  => 'own_failed',
+                                       'message' => '{--WERNIS_API_REQUEST_FAILED_OWN--}'
+                               );
+                               break;
+
+                       case 'AMOUNT': // Amount is depleted
+                               $return = array(
+                                       'status'  => 'amount_failed',
+                                       'message' => '{--WERNIS_API_REQUEST_FAILED_AMOUNT--}'
+                               );
+                               break;
+
+                       case 'AMOUNT-SEND': // API amount is depleted
+                               $return = array(
+                                       'status'  => 'api_amount_failed',
+                                       'message' => '{--WERNIS_API_REQUEST_FAILED_API_AMOUNT--}'
+                               );
+                               break;
+
+                       default: // Unknown error (maybe new?)
+                               logDebugMessage(__FUNCTION__, __LINE__, sprintf('Unknown error %s from WDS66 API received.', $data[1]));
+                               $return = array(
+                                       'status'  => 'request_failed',
+                                       'message' => '{%message,WERNIS_API_REQUEST_FAILED=' . $data[1] . '%}'
+                               );
+                               break;
+               }
+       } else {
+               // All fine here
+               $return = array(
+                       'status'   => 'OK',
+                       'response' => $responseLine
+               );
+       }
+
+       // Return the result
+       return $return;
+}
+
+// Tests the function by calling balance.php on the API
+function WERNIS_TEST_API () {
+       // Only as admin
+       assert(isAdmin());
+
+       // Result is always failed
+       $result = FALSE;
+
+       // Prepare the request data
+       $requestData = array(
+               't_uid'       => getWernisRefid(),
+               't_md5'       => getWernisPassMd5()
+       );
+
+       // Return the result from the lower functions
+       $return = WERNIS_SEND_REQUEST('balance.php', $requestData);
+
+       // Did it went smoothly?
+       if ($return['status'] == 'OK') {
+               // All fine!
+               $result = TRUE;
+       } else {
+               // Status failure text
+               WERNIS_STATUS_MESSAGE($return['message'], $return['status']);
+       }
+
+       // Return result
+       return $result;
+}
+
+// Widthdraw this amount
+function WERNIS_EXECUTE_WITHDRAW ($wdsId, $userMd5, $amount) {
+       // Is the sponsor extension installed?
+       if (!isWernisWithdrawActive()) {
+               if (!isExtensionActive('sponsor')) {
+                       // No, abort here
+                       return FALSE;
+               } elseif (!isSponsor()) {
+                       // No sponsor, not allowed to withdraw!
+                       return FALSE;
+               }
+       } // END - if
+
+       // Default is failed attempt
+       $result = FALSE;
+
+       // Prepare the request data
+       $requestData = array(
+               'sub_request' => 'receive',
+               't_uid'       => bigintval($wdsId),
+               't_md5'       => $userMd5,
+               'r_uid'       => getWernisRefid(),
+               'amount'      => bigintval($amount),
+               'purpose'     => getMaskedMessage('WERNIS_API_PURPOSE_WITHDRAW', getMemberId())
+       );
+
+       // Return the result from the lower functions
+       $return = WERNIS_SEND_REQUEST('book.php', $requestData);
+
+       if ($return['status'] == 'OK') {
+               // All fine!
+               $result = TRUE;
+
+               // Log the transfer
+               WERNIS_LOG_TRANSFER($wdsId, $amount, 'WITHDRAW');
+       } else {
+               // Status failure text
+               WERNIS_STATUS_MESSAGE($return['message'], $return['status']);
+
+               // Log the transfer
+               WERNIS_LOG_TRANSFER($wdsId, $amount, 'FAILED', $return['message'], $return['status']);
+       }
+
+       // Return result
+       return $result;
+}
+
+
+// Payout this amount
+function WERNIS_EXECUTE_PAYOUT ($wdsId, $amount) {
+       // Default is failed attempt
+       $result = FALSE;
+
+       // Prepare the request data
+       $requestData = array(
+               'sub_request' => 'send',
+               't_uid'       => getWernisRefid(),
+               't_md5'       => getWernisPassMd5(),
+               'r_uid'       => bigintval($wdsId),
+               'amount'      => bigintval($amount),
+               'purpose'     => getMaskedMessage('WERNIS_API_PURPOSE_PAYOUT', getMemberId())
+       );
+
+       // Return the result from the lower functions
+       $return = WERNIS_SEND_REQUEST('book.php', $requestData);
+
+       if ($return['status'] == 'OK') {
+               // All fine!
+               $result = TRUE;
+
+               // Log the transfer
+               WERNIS_LOG_TRANSFER($wdsId, $amount, 'PAYOUT');
+       } else {
+               // Status failure text
+               WERNIS_STATUS_MESSAGE($return['message'], $return['status']);
+
+               // Log the transfer
+               WERNIS_LOG_TRANSFER($wdsId, $amount, 'FAILED', $return['message'], $return['status']);
+       }
+
+       // Return result
+       return $result;
+}
+
+// Translate the status IN/OUT
+function translateWernisTransferStatus ($status) {
+       // Default status is unknown
+       $return = '{%message,WERNIS_STATUS_UNKNWOWN=' . $status . '%}';
+
+       // Construct message id
+       $messageId = 'WERNIS_STATUS_' . $status;
+
+       // Is it there?
+       if (isMessageIdValid($messageId)) {
+               // Then use it as message string
+               $return = '{--' . $messageId . '--}';
+       } // END - if
+
+       // Return the status
+       return $return;
+}
+
+// Log the transfer
+function WERNIS_LOG_TRANSFER ($wdsId, $amount, $type = 'FAILED', $message = '', $status = '') {
+       // Register this wernis movement
+       sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_user_wernis` (`userid`, `wernis_account`, `wernis_amount`, `wernis_timestamp`, `wernis_type`, `wernis_api_message`, `wernis_api_status`) VALUES (%s, %s, %s, UNIX_TIMESTAMP(), '%s', '%s', '%s')",
+               array(
+                       getMemberId(),
+                       bigintval($wdsId),
+                       bigintval($amount),
+                       $type,
+                       $message,
+                       $status
+               ), __FUNCTION__, __LINE__);
+}
+
+// Take fees and factor
+function WERNIS_TAKE_FEE ($points, $mode) {
+       // Payout or withdraw are allowed modes!
+       //* DEBUG: */ debugOutput('mode=' . $mode . ',points=' . $points);
+       if (!in_array($mode, array('payout', 'withdraw'))) {
+               // Log error and abort
+               logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . getMemberId() . ',mode=' . $mode . ',points=' . $points . ' - unknown mode detected.');
+               return FALSE;
+       } // END - if
+
+       // Is there a percentage or fixed fee?
+       if (getConfig('wernis_' . $mode . '_fee_percent') > 0) {
+               // Percentage fee
+               $points -= $points * getConfig('wernis_'.$mode.'_fee_percent') / 100;
+       } elseif (getConfig('wernis_' . $mode . '_fee_fix') > 0) {
+               // Fixed fee
+               $points -= getConfig('wernis_' . $mode . '_fee_fix');
+       }
+
+       // Divide/multiply the factor
+       if ($mode == 'payout') {
+               // Divide for payout
+               $points = $points / getWernisPayoutFactor();
+       } else {
+               // Multiply for withdraw
+               $points = $points * getWernisWithdrawFactor();
+       }
+
+       // Return value
+       //* DEBUG: */ debugOutput('mode=' . $mode . ',points=' . $points);
+       return $points;
+}
+
+// Add withdraw fees and factor
+function WERNIS_ADD_WITHDRAW_FEE ($points) {
+       // Is there a percentage or fixed fee?
+       if (getWernisWithdrawFeePercent() > 0) {
+               // Percentage fee
+               $points += $points * getWernisWithdrawFeePercent() / 100;
+       } elseif (getWernisWithdrawFeeFix() > 0) {
+               // Fixed fee
+               $points += getWernisWithdrawFeeFix();
+       }
+
+       // Return value
+       return $points;
+}
+
+//-----------------------------------------------------------------------------
+//                             Wrapper functions
+//-----------------------------------------------------------------------------
+
+// Wrapper function for 'wernis_refid'
+function getWernisRefid () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_refid');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_pass_md5'
+function getWernisPassMd5 () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_pass_md5');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_api_id'
+function getWernisApiId () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_api_id');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_api_md5'
+function getWernisApiMd5 () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_api_md5');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_api_url'
+function getWernisApiUrl () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_api_url');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_withdraw_active'
+function getWernisWithdrawActive () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_active');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_payout_active'
+function getWernisPayoutActive () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_active');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_withdraw_active'
+function isWernisWithdrawActive () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = (getConfig('wernis_withdraw_active') == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_payout_active'
+function isWernisPayoutActive () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = (getConfig('wernis_payout_active') == 'Y');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_withdraw_factor'
+function getWernisWithdrawFactor () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_factor');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_payout_factor'
+function getWernisPayoutFactor () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_factor');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_withdraw_fee_percent'
+function getWernisWithdrawFeePercent () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_fee_percent');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_withdraw_fee_fix'
+function getWernisWithdrawFeeFix () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_fee_fix');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_payout_fee_percent'
+function getWernisPayoutFeePercent () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_fee_percent');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_payout_fee_fix'
+function getWernisPayoutFeeFix () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_fee_fix');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_min_payout'
+function getWernisMinPayout () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_min_payout');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Wrapper function for 'wernis_min_withdraw'
+function getWernisMinWithdraw () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Get config entry
+               $GLOBALS[__FUNCTION__] = getConfig('wernis_min_withdraw');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
 }
 
-//
+// [EOF]
 ?>