inc/libs/wernis_functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 10/19/2003 *
   4  * ===================                          Last change: 08/12/2004 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : what-points.php                                  *
   8  * -------------------------------------------------------------------- *
   9  * Short description : All your collected points...                     *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Alle Ihrer gesammelten Punkte                    *
  12  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  17  * -------------------------------------------------------------------- *
  18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  19  * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
  20  * For more information visit: http://mxchange.org                      *
  21  *                                                                      *
  22  * This program is free software; you can redistribute it and/or modify *
  23  * it under the terms of the GNU General Public License as published by *
  24  * the Free Software Foundation; either version 2 of the License, or    *
  25  * (at your option) any later version.                                  *
  26  *                                                                      *
  27  * This program is distributed in the hope that it will be useful,      *
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  30  * GNU General Public License for more details.                         *
  31  *                                                                      *
  32  * You should have received a copy of the GNU General Public License    *
  33  * along with this program; if not, write to the Free Software          *
  34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  35  * MA  02110-1301  USA                                                  *
  36  ************************************************************************/
  37
  38 // Some security stuff...
  39 if (!defined('__SECURITY')) {
  40         die();
  41 } // END - if
  42
  43 // Sets a status message and code
  44 function setWernisStatusMessage ($message, $status) {
  45         $GLOBALS['wernis_data']['message'] = $message;
  46         $GLOBALS['wernis_data']['status']  = $status;
  47 }
  48
  49 // Get the status message
  50 function getWernisErrorMessage () {
  51         if (isset($GLOBALS['wernis_data']['message'])) {
  52                 // Use raw message
  53                 return $GLOBALS['wernis_data']['message'];
  54         } elseif (isset($GLOBALS['wernis_data']['status'])) {
  55                 // Fall-back to status
  56                 return '{%message,WERNIS_ERROR_STATUS=' . $GLOBALS['wernis_data']['status'] . '%}';
  57         } else {
  58                 // Something bad happend
  59                 return '{--WERNIS_UNKNOWN_ERROR--}';
  60         }
  61 }
  62
  63 // Get the status code
  64 function getWernisErrorCode () {
  65         if (isset($GLOBALS['wernis_data']['status'])) {
  66                 // Use raw message
  67                 return $GLOBALS['wernis_data']['status'];
  68         } else {
  69                 // Something bad happend
  70                 return '{--WERNIS_UNKNOWN_ERROR--}';
  71         }
  72 }
  73
  74 // Sends out a request to the API and returns it's result
  75 function sendWernisApiRequest ($scriptName, $requestData = array()) {
  76         // Is the requestData an array?
  77         if (!is_array($requestData)) {
  78                 // Then abort here!
  79                 return array(
  80                         'status'  => 'failed_general',
  81                         'message' => '{--WERNIS_API_REQUEST_DATA_INVALID--}'
  82                 );
  83         } // END - if
  84
  85         // Is the API id and MD5 hash there?
  86         if ((getWernisApiId() == '') || (getWernisApiMd5() == '')) {
  87                 // Abort here...
  88                 return array(
  89                         'status'  => 'failed_general',
  90                         'message' => '{--WERNIS_API_REQUEST_DATA_MISSING--}'
  91                 );
  92         } // END - if
  93
  94         // Add more request data
  95         $requestData['api_id']  = getWernisApiId();
  96         $requestData['api_key'] = getWernisApiMd5();
  97
  98         // Is a purpose there?
  99         if (!empty($requestData['purpose'])) {
 100                 // Eval the purpose
 101                 eval('$purpose = "' . doFinalCompilation($requestData['purpose'], FALSE) . '";');
 102
 103                 // Prepare the purpose, it needs encoding
 104                 $requestData['purpose'] = encodeString($purpose);
 105         } // END - if
 106
 107         // Construct the request string
 108         $requestString = getWernisApiUrl() . $scriptName;
 109
 110         // Get the raw response from the lower function
 111         $response = sendHttpPostRequest($requestString, $requestData);
 112
 113         // Check the response header if all is fine
 114         if (!isHttpStatusOkay($response[0])) {
 115                 // Something bad happend... :(
 116                 return array(
 117                         'status'  => 'request_error',
 118                         'message' => '{%message,WERNIS_API_REQUEST_ERROR=' . $response[0] . '%}'
 119                 );
 120         } // END - if
 121
 122         // All (maybe) fine so remove the response header from server
 123         $responseLine = '*INVALID*';
 124         for ($idx = (count($response) - 1); $idx > 1; $idx--) {
 125                 $line = trim($response[$idx]);
 126                 if (!empty($line)) {
 127                         $responseLine = $line;
 128                         break;
 129                 } // END - if
 130         } // END - for
 131
 132         // Is the response leaded by a & symbol?
 133         if (substr($responseLine, 0, 1) != '&') {
 134                 // Something badly happened on server-side
 135                 return array(
 136                         'status'  => 'request_problem',
 137                         'message' => sprintf(getMessage('WERNIS_API_REQUEST_PROBLEM'), $response[0], secureString($responseLine))
 138                 );
 139         } // END - if
 140
 141         // Remove the leading & (which can be used in Flash)
 142         $responseLine = substr($responseLine, 1);
 143
 144         // Bring back the response
 145         $data = explode('=', $responseLine);
 146
 147         // Default return array (should not stay empty)
 148         $return = array();
 149
 150         // We use only the first two entries (which shall be fine)
 151         if ($data[0] === 'error') {
 152                 // The request has failed... :(
 153                 switch ($data[1]) {
 154                         case '404': // Invalid API id
 155                         case 'AUTH': // Authorization has failed
 156                                 $return = array(
 157                                         'status'  => 'auth_failed',
 158                                         'message' => '{--WERNIS_API_REQUEST_FAILED_AUTH--}'
 159                                 );
 160                                 break;
 161
 162                         case 'LOCKED': // User account is locked!
 163                         case 'PASS': // Bad passphrase entered
 164                         case 'USER': // Missing account or invalid password
 165                                 $return = array(
 166                                         'status'  => 'user_failed',
 167                                         'message' => '{--WERNIS_API_REQUEST_FAILED_USER--}'
 168                                 );
 169                                 break;
 170
 171                         case 'OWN': // Transfer to own account
 172                                 $return = array(
 173                                         'status'  => 'own_failed',
 174                                         'message' => '{--WERNIS_API_REQUEST_FAILED_OWN--}'
 175                                 );
 176                                 break;
 177
 178                         case 'AMOUNT': // Amount is depleted
 179                                 $return = array(
 180                                         'status'  => 'amount_failed',
 181                                         'message' => '{--WERNIS_API_REQUEST_FAILED_AMOUNT--}'
 182                                 );
 183                                 break;
 184
 185                         case 'AMOUNT-SEND': // API amount is depleted
 186                                 $return = array(
 187                                         'status'  => 'api_amount_failed',
 188                                         'message' => '{--WERNIS_API_REQUEST_FAILED_API_AMOUNT--}'
 189                                 );
 190                                 break;
 191
 192                         default: // Unknown error (maybe new?)
 193                                 logDebugMessage(__FUNCTION__, __LINE__, sprintf('Unknown error %s from WDS66 API received.', $data[1]));
 194                                 $return = array(
 195                                         'status'  => 'request_failed',
 196                                         'message' => '{%message,WERNIS_API_REQUEST_FAILED=' . $data[1] . '%}'
 197                                 );
 198                                 break;
 199                 }
 200         } else {
 201                 // All fine here
 202                 $return = array(
 203                         'status'   => 'OK',
 204                         'response' => $responseLine
 205                 );
 206         }
 207
 208         // Return the result
 209         return $return;
 210 }
 211
 212 // Tests the function by calling balance.php on the API
 213 function doAdminTestWernisApi () {
 214         // Only as admin
 215         assert(isAdmin());
 216
 217         // Result is always failed
 218         $result = FALSE;
 219
 220         // Prepare the request data
 221         $requestData = array(
 222                 't_uid' => getWernisRefid(),
 223                 't_md5' => getWernisPassMd5()
 224         );
 225
 226         // Return the result from the lower functions
 227         $return = sendWernisApiRequest('balance.php', $requestData);
 228
 229         // Did it went smoothly?
 230         if (isHttpResponseStatusOkay($return)) {
 231                 // All fine!
 232                 $result = TRUE;
 233         } else {
 234                 // Status failure text
 235                 setWernisStatusMessage($return['message'], $return['status']);
 236         }
 237
 238         // Return result
 239         return $result;
 240 }
 241
 242 // Widthdraw this amount
 243 function executeWernisApiWithdraw ($wdsId, $userMd5, $amount) {
 244         // Is the sponsor extension installed?
 245         if (!isWernisWithdrawActive()) {
 246                 if (!isExtensionActive('sponsor')) {
 247                         // No, abort here
 248                         return FALSE;
 249                 } elseif (!isSponsor()) {
 250                         // No sponsor, not allowed to withdraw!
 251                         return FALSE;
 252                 }
 253         } // END - if
 254
 255         // Default is failed attempt
 256         $result = FALSE;
 257
 258         // Prepare the request data
 259         $requestData = array(
 260                 'sub_request' => 'receive',
 261                 't_uid'       => bigintval($wdsId),
 262                 't_md5'       => $userMd5,
 263                 'r_uid'       => getWernisRefid(),
 264                 'amount'      => bigintval($amount),
 265                 'purpose'     => getMaskedMessage('WERNIS_API_PURPOSE_WITHDRAW', getMemberId())
 266         );
 267
 268         // Return the result from the lower functions
 269         $return = sendWernisApiRequest('book.php', $requestData);
 270
 271         // Did it went smoothly?
 272         if (isHttpResponseStatusOkay($return)) {
 273                 // All fine!
 274                 $result = TRUE;
 275
 276                 // Log the transfer
 277                 logWernisTransfer($wdsId, $amount, 'WITHDRAW');
 278         } else {
 279                 // Status failure text
 280                 setWernisStatusMessage($return['message'], $return['status']);
 281
 282                 // Log the transfer
 283                 logWernisTransfer($wdsId, $amount, 'FAILED', $return['message'], $return['status']);
 284         }
 285
 286         // Return result
 287         return $result;
 288 }
 289
 290 // Payout this amount
 291 function executeWernisApiPayout ($wdsId, $amount) {
 292         // Default is failed attempt
 293         $result = FALSE;
 294
 295         // Prepare the request data
 296         $requestData = array(
 297                 'sub_request' => 'send',
 298                 't_uid'       => getWernisRefid(),
 299                 't_md5'       => getWernisPassMd5(),
 300                 'r_uid'       => bigintval($wdsId),
 301                 'amount'      => bigintval($amount),
 302                 'purpose'     => getMaskedMessage('WERNIS_API_PURPOSE_PAYOUT', getMemberId())
 303         );
 304
 305         // Return the result from the lower functions
 306         $return = sendWernisApiRequest('book.php', $requestData);
 307
 308         if (isHttpResponseStatusOkay($return)) {
 309                 // All fine!
 310                 $result = TRUE;
 311
 312                 // Log the transfer
 313                 logWernisTransfer($wdsId, $amount, 'PAYOUT');
 314         } else {
 315                 // Status failure text
 316                 setWernisStatusMessage($return['message'], $return['status']);
 317
 318                 // Log the transfer
 319                 logWernisTransfer($wdsId, $amount, 'FAILED', $return['message'], $return['status']);
 320         }
 321
 322         // Return result
 323         return $result;
 324 }
 325
 326 // Execute auth.php request
 327 function executeWernisApiAuth ($wernisId, $wernisPassword) {
 328         // Prepare request data
 329         $requestData = array(
 330                 't_uid'       => bigintval($wernisId),
 331                 't_md5'       => hashSha256($wernisPassword),
 332         );
 333
 334         // Call auth.php
 335         $return = sendWernisApiRequest('auth.php', $requestData);
 336
 337         // Return full array
 338         return $return;
 339 }
 340
 341 // Execute get.php reguest with given auth data (not all are used)
 342 function executeWernisApiGet ($authData, $subRequest, $fields) {
 343         // It must be an array
 344         assert(is_array($authData));
 345
 346         // Check required array elements
 347         assert(isset($authData['wernis_userid']));
 348         assert(isset($authData['api_auth_key']));
 349         assert(isset($authData['api_redirect_challenge']));
 350
 351         // Then create request array
 352         $requestData = array(
 353                 'sub_request' => $subRequest,
 354                 'fields'      => $fields,
 355                 't_uid'       => bigintval($authData['wernis_userid']),
 356                 'auth_key'    => $authData['api_auth_key'],
 357                 'challenge'   => $authData['api_redirect_challenge']
 358         );
 359
 360         // Call get.php
 361         $return = sendWernisApiRequest('get.php', $requestData);
 362
 363         // Return full array
 364         return $return;
 365 }
 366
 367 // Translate the status IN/OUT
 368 function translateWernisTransferStatus ($status) {
 369         // Default status is unknown
 370         $return = '{%message,WERNIS_STATUS_UNKNWOWN=' . $status . '%}';
 371
 372         // Construct message id
 373         $messageId = 'WERNIS_STATUS_' . $status;
 374
 375         // Is it there?
 376         if (isMessageIdValid($messageId)) {
 377                 // Then use it as message string
 378                 $return = '{--' . $messageId . '--}';
 379         } // END - if
 380
 381         // Return the status
 382         return $return;
 383 }
 384
 385 // Log the transfer
 386 function logWernisTransfer ($wdsId, $amount, $type = 'FAILED', $message = '', $status = '') {
 387         // Register this wernis movement
 388         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')",
 389                 array(
 390                         getMemberId(),
 391                         bigintval($wdsId),
 392                         bigintval($amount),
 393                         $type,
 394                         $message,
 395                         $status
 396                 ), __FUNCTION__, __LINE__);
 397 }
 398
 399 // Calulcate fees and factor
 400 function calculateWernisFee ($points, $mode) {
 401         // Payout or withdraw are allowed modes!
 402         //* DEBUG: */ debugOutput('mode=' . $mode . ',points=' . $points);
 403         if (!in_array($mode, array('payout', 'withdraw'))) {
 404                 // Log error and abort
 405                 logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . getMemberId() . ',mode=' . $mode . ',points=' . $points . ' - unknown mode detected.');
 406                 return FALSE;
 407         } // END - if
 408
 409         // Is there a percentage or fixed fee?
 410         if (getConfig('wernis_' . $mode . '_fee_percent') > 0) {
 411                 // Percentage fee
 412                 $points -= $points * getConfig('wernis_'.$mode.'_fee_percent') / 100;
 413         } elseif (getConfig('wernis_' . $mode . '_fee_fix') > 0) {
 414                 // Fixed fee
 415                 $points -= getConfig('wernis_' . $mode . '_fee_fix');
 416         }
 417
 418         // Divide/multiply the factor
 419         if ($mode == 'payout') {
 420                 // Divide for payout
 421                 $points = $points / getWernisPayoutFactor();
 422         } else {
 423                 // Multiply for withdraw
 424                 $points = $points * getWernisWithdrawFactor();
 425         }
 426
 427         // Return value
 428         //* DEBUG: */ debugOutput('mode=' . $mode . ',points=' . $points);
 429         return $points;
 430 }
 431
 432 // Add withdraw fees and factor
 433 // @TODO Unused?
 434 function calulcateWernisWithdrawFee ($points) {
 435         // Is there a percentage or fixed fee?
 436         if (getWernisWithdrawFeePercent() > 0) {
 437                 // Percentage fee
 438                 $points += $points * getWernisWithdrawFeePercent() / 100;
 439         } elseif (getWernisWithdrawFeeFix() > 0) {
 440                 // Fixed fee
 441                 $points += getWernisWithdrawFeeFix();
 442         }
 443
 444         // Return value
 445         return $points;
 446 }
 447
 448 // Displays registration form for WDS66 registration
 449 function doDisplayWernisUserRegistrationForm () {
 450         // Is the form sent?
 451         if (isFormSent('register')) {
 452                 // Is wernis_id set?
 453                 if (!isPostRequestElementSet('wernis_id')) {
 454                         // Id not set
 455                         displayMessage('{--GUEST_WERNIS_REGISTRATION_ID_NOT_SET--}');
 456                 } elseif (!isPostRequestElementSet('wernis_password')) {
 457                         // Password not set
 458                         displayMessage('{--GUEST_WERNIS_REGISTRATION_PASSWORD_NOT_SET--}');
 459                 } else {
 460                         // So far, all fine, then let's do the call-back on auth.php ...
 461                         $response = executeWernisApiAuth(postRequestElement('wernis_id'), postRequestElement('wernis_password'));
 462
 463                         // Was the status okay?
 464                         if (isHttpResponseStatusOkay($response)) {
 465                                 // All fine, then analyze API response
 466                                 $args = convertApiResponseToArray($response['response'], '&', '=');
 467
 468                                 // Is status set?
 469                                 assert(isset($args['auth_status']));
 470
 471                                 // Add WDS66 userid
 472                                 $args['wernis_userid'] = postRequestElement('wernis_id');
 473
 474                                 // "Detect" auth status
 475                                 $callbackFunction = 'doWernisAuth' . capitalizeUnderscoreString($args['auth_status']);
 476
 477                                 // Is the call-back there?
 478                                 if (!is_callable($callbackFunction, FALSE, $callableName)) {
 479                                         // Not there, could be bad. :(
 480                                         reportBug(__FUNCTION__, __LINE__, 'Unsupported auth_status=' . $args['auth_status'] . ',args()=' . count($args) . ',callbackFunction=' . $callbackFunction . ' detected.');
 481                                 } // END - if
 482
 483                                 // Then call it
 484                                 $status = call_user_func($callbackFunction, $args);
 485
 486                                 // @TODO Something more to do here?
 487                                 die(__FUNCTION__ . ':' . __LINE__ . ': status[' . gettype($status) . ']=' . $status . ' - Unfinished.');
 488                         } else {
 489                                 // Something bad happened
 490                                 displayMessage($response['message']);
 491                         }
 492                 }
 493         } // END - if
 494
 495         // Is there a challenge + response?
 496         if ((isGetRequestElementSet('status')) && (isGetRequestElementSet('challenge')) && (isGetRequestElementSet('__challenge_response'))) {
 497                 // Redirect from modules.php?module=auth, so validate challenge response ...
 498                 // 1) Get first 24 characters = salt
 499                 $salt = substr(getRequestElement('__challenge_response'), 0, 24);
 500
 501                 // 2) Generate hash for challenge response
 502                 $challengeResponse = $salt . hashSha256($salt . getWernisApiMd5() . getRequestElement('challenge'));
 503
 504                 // Is the response valid?
 505                 if ($challengeResponse != getRequestElement('__challenge_response')) {
 506                         // Not valid
 507                         displayMessage('{--GUEST_WERNIS_REGISTRATION_INVALID_CHALLENGE_RESPONSE--}');
 508                         return;
 509                 } // END - if
 510
 511                 /*
 512                  * Now, that the challenge-response is the same, the challenge itself
 513                  * is also the same. Next get the data from wernis_regs table by
 514                  * challenge. There is currently no other way to get the data as there
 515                  * is no Wernis user id provided. Later on the stored challenge response
 516                  * can be compared with provided.
 517                  */
 518                 $return = doWernisFinishUserRegistration(getRequestElement('challenge'), getRequestElement('__challenge_response'), getRequestElement('status'));
 519
 520                 // Is the registration finished?
 521                 if ($return === FALSE) {
 522                         // No, then abort here silently as the function should have already displayed a message
 523                         return;
 524                 } // END - if
 525         } elseif (!isFormSent('register')) {
 526                 // Form not send, so load form template
 527                 loadTemplate('guest_wernis_registration_rpc_form');
 528         }
 529 }
 530
 531 // Finish user registration with WDS66 API
 532 function doWernisFinishUserRegistration ($challenge, $challengeResponse, $status) {
 533         // Is the status 1? (= all fine with API call)
 534         if ($status == '1') {
 535                 // Get mapped data based on challenge
 536                 $return = getWernisMappedDataFromApiByChallenge($challenge, $status);
 537
 538                 // Is the array filled?
 539                 if ((count($return['mapped_data']) > 0) && (empty($return['message']))) {
 540                         // Set must-fillout fields
 541                         $return['mapped_data'] = runFilterChain('register_must_fillout', $return['mapped_data']);
 542
 543                         // Add missing elements
 544                         $return['mapped_data']['gender']               = NULL;
 545                         $return['mapped_data']['birthday_selection']   = generateDayMonthYearSelectionBox($return['mapped_data']['birth_day'], $return['mapped_data']['birth_month'], $return['mapped_data']['birth_year']);
 546                         $return['mapped_data']['challenge']            = getRequestElement('challenge');
 547                         $return['mapped_data']['__challenge_response'] = getRequestElement('__challenge_response');
 548
 549                         // Display form
 550                         loadTemplate('guest_wernis_registration_form', FALSE, $return['mapped_data']);
 551
 552                         // All fine
 553                         return TRUE;
 554                 } else {
 555                         // Something unexpected happened (e.g. no API requests left)
 556                         displayMessage($return['message']);
 557                         return FALSE;
 558                 }
 559         } else {
 560                 // Status does not need to be changed
 561                 die(__FUNCTION__ . ':' . __LINE__ . ': Reached!');
 562         }
 563 }
 564
 565 // "Getter" for mapped data by calling the API and given challenge and status
 566 function getWernisMappedDataFromApiByChallenge ($challenge, $status) {
 567         // Get stored registration data
 568         $rows = getWernisRegistrationDataByKey('api_redirect_challenge', $challenge);
 569
 570         // Zero result found?
 571         if (count($rows) == 0) {
 572                 // Nothing found
 573                 displayMessage('{--GUEST_WERNIS_REGISTRATION_ZERO_ROWS_FOUND--}');
 574
 575                 // Display form
 576                 loadTemplate('guest_wernis_registration_rpc_form');
 577                 return array();
 578         } // END - if
 579
 580         // Init array
 581         $return = array(
 582                 // Mapped data
 583                 'mapped_data' => array(),
 584                 // Any error message from API
 585                 'message'     => ''
 586         );
 587
 588         // Has the auth status changed?
 589         if ($rows[0]['api_auth_status'] != 'ACCEPTED') {
 590                 /*
 591                  * The authorization of this application has been accepted, so
 592                  * update it and ignore result from function because the update
 593                  * will always run.
 594                  */
 595                 updateWernisRegistrationDataByKey('api_auth_status', 'api_redirect_challenge', $challenge, 'ACCEPTED');
 596         } // END - if
 597
 598         // Now call "get.php"
 599         $response = executeWernisApiGet($rows[0], 'data', 'vorname|name|strasse|plz|ort|birth_day|birth_month|birth_year|email|werber');
 600
 601         // Was the status okay?
 602         if (isHttpResponseStatusOkay($response)) {
 603                 // API returned non-errous response, 'data=' must be found
 604                 assert(substr($response['response'], 0, 5) == 'data=');
 605
 606                 // And remove it, this is now BASE64-encoded
 607                 $encodedData = urldecode(substr($response['response'], 5));
 608
 609                 // And decode it (all steps separated to later "easily" debug them)
 610                 $decodedData = base64_decode($encodedData);
 611
 612                 /*
 613                  * Do some checks on the decoded string, it should be a
 614                  * serialized array with 10 entries (see above
 615                  * executeWernisApiGet() call).
 616                  */
 617                 assert(substr($decodedData, 0, 6) == 'a:10:{');
 618                 assert(substr($decodedData, -1, 1) == '}');
 619
 620                 // The array seems to be fine, unserialize it
 621                 $userData = unserialize($decodedData);
 622
 623                 // All mappings WDS66->mailer
 624                 $mappings = array(
 625                         'vorname'     => 'surname',
 626                         'name'        => 'family',
 627                         'strasse'     => 'street_nr',
 628                         'plz'         => 'zip',
 629                         'ort'         => 'city',
 630                         'email'       => 'email',
 631                         'birth_day'   => 'birth_day',
 632                         'birth_month' => 'birth_month',
 633                         'birth_year'  => 'birth_year',
 634                         'werber'      => 'wernis_refid'
 635                 );
 636
 637                 // Map all WDS66 entries into mailer entries
 638                 foreach ($mappings as $from => $to) {
 639                         // All must exist
 640                         if (!isset($userData[$from])) {
 641                                 // Element $from does not exist
 642                                 reportBug(__FUNCTION__, __LINE__, 'Cannot map from=' . $from . ' -> to=' . $to . ': element does not exist.');
 643                         } // END - if
 644
 645                         // "Map" all
 646                         $return['mapped_data'][$to] = convertEmptyToNull($userData[$from]);
 647                 } // END - foreach
 648
 649                 // Both arrays must have same size
 650                 assert(count($userData) == count($return['mapped_data']));
 651
 652                 // Now add userid from WDS66
 653                 $return['mapped_data']['wernis_userid'] = bigintval($rows[0]['wernis_userid']);
 654         } else {
 655                 // Something bad happened so copy the message
 656                 $return['message'] = $response['message'];
 657         }
 658
 659         // Return mapped data array
 660         return $return;
 661 }
 662
 663 // Updates auth status by given key/value pair
 664 function updateWernisRegistrationDataByKey ($updatedColumn, $key, $oldValue, $newValue) {
 665         // Run the update
 666         sqlQueryEscaped("UPDATE
 667         `{?_MYSQL_PREFIX?}_wernis_regs`
 668 SET
 669         `%s`='%s'
 670 WHERE
 671         `%s`='%s' AND
 672         `%s` != '%s'
 673 LIMIT 1",
 674                 array(
 675                         $updatedColumn,
 676                         $newValue,
 677                         $key,
 678                         $updatedColumn,
 679                         $oldValue
 680                 ), __FUNCTION__, __LINE__
 681         );
 682
 683         // Check if rows as been affected
 684         return ifSqlHasZeroAffectedRows();
 685 }
 686
 687 // "Getter" for Wernis registration data by given key and value
 688 function getWernisRegistrationDataByKey ($key, $value, $limit = 1) {
 689         // Init array
 690         $rows = array();
 691
 692         // Now search for it
 693         $result = sqlQueryEscaped("SELECT
 694         `local_userid`,
 695         `wernis_userid`,
 696         `api_auth_status`,
 697         `api_auth_key`,
 698         `api_redirect_challenge`,
 699         UNIX_TIMESTAMP(`record_inserted`) AS `record_inserted`
 700 FROM
 701         `{?_MYSQL_PREFIX?}_wernis_regs`
 702 WHERE
 703         `%s`='%s'
 704 ORDER BY
 705         `id`
 706 LIMIT %d",
 707                 array(
 708                         $key,
 709                         $value,
 710                         $limit
 711                 ), __FUNCTION__, __LINE__
 712         );
 713
 714         // Is there an entry?
 715         if (sqlNumRows($result) > 0) {
 716                 // At least one entry has been found, so loop through all
 717                 while ($row = sqlFetchArray($result)) {
 718                         // Add it
 719                         array_push($rows, $row);
 720                 } // END - while
 721         } // END - if
 722
 723         // Free result
 724         sqlFreeResult($result);
 725
 726         // Return found entries
 727         return $rows;
 728 }
 729
 730 // Do local user registration with data from WDS66 API
 731 function doWernisUserRegistration () {
 732         // Call generic registration function
 733         $status = doGenericUserRegistration();
 734
 735         // Does this went fine?
 736         if ($status === FALSE) {
 737                 // No, then abort here silently
 738                 return FALSE;
 739         } // END - if
 740
 741         // Make sure the user id is valid
 742         assert(isset($GLOBALS['register_userid']));
 743         assert(isValidId($GLOBALS['register_userid']));
 744
 745         // Generic registration is finished, so add more data:
 746 }
 747
 748 //-----------------------------------------------------------------------------
 749 //                      Auth status callback functions
 750 //-----------------------------------------------------------------------------
 751
 752 // Handler for auth_status=PENDING
 753 function doWernisAuthPending ($args) {
 754         // $args must always be an array
 755         assert(is_array($args));
 756
 757         // auth_key and wernis_userid must be set
 758         assert(isset($args['auth_key']));
 759         assert(isset($args['wernis_userid']));
 760
 761         // Generate a challenge that will be added to the URL
 762         $challenge = hashSha256(generatePassword(128));
 763
 764         // Search entry in database by auth_key
 765         if (countSumTotalData($args['auth_key'], 'wernis_regs', 'id', 'api_auth_key', TRUE) == 0) {
 766                 // "Register" this call
 767                 sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_wernis_regs` (
 768         `wernis_userid`,
 769         `api_auth_status`,
 770         `api_auth_key`,
 771         `api_redirect_challenge`
 772 ) VALUES (
 773         %s,
 774         'PENDING',
 775         '%s',
 776         '%s'
 777 )",
 778                         array(
 779                                 bigintval($args['wernis_userid']),
 780                                 $args['auth_key'],
 781                                 $challenge
 782                         ), __FUNCTION__, __LINE__
 783                 );
 784         } else {
 785                 // Update challenge
 786                 sqlQueryEscaped("UPDATE
 787         `{?_MYSQL_PREFIX?}_wernis_regs`
 788 SET
 789         `api_redirect_challenge`='%s'
 790 WHERE
 791         `api_auth_key`='%s' AND
 792         `wernis_userid`=%s
 793         `api_auth_status`='PENDING'
 794 LIMIT 1",
 795                         array(
 796                                 $challenge,
 797                                 $args['auth_key'],
 798                                 bigintval($args['wernis_userid'])
 799                         ), __FUNCTION__, __LINE__
 800                 );
 801         }
 802
 803         // Should always update/insert
 804         assert(sqlAffectedRows() == 1);
 805
 806         // Redirect to WDS66 module=auth ...
 807         redirectToUrl(getWernisBaseUrl() . '/modules.php?module=auth&amp;auth_key=' . $args['auth_key'] . '&amp;params=' . urlencode(base64_encode('&module=' . getModule() . '&what=' . getWhat())) . '&amp;challenge=' . $challenge);
 808 }
 809
 810 // Handler for auth_status=ACCEPTED
 811 function doWernisAuthAccepted ($args) {
 812         // $args must always be an array
 813         assert(is_array($args));
 814
 815         // auth_key and wernis_userid must be set
 816         assert(isset($args['auth_key']));
 817         assert(isset($args['wernis_userid']));
 818         die(__FUNCTION__ . ':' . __LINE__ . '<pre>' . print_r($args, TRUE) . '</pre>');
 819 }
 820
 821 //-----------------------------------------------------------------------------
 822 //                             Wrapper functions
 823 //-----------------------------------------------------------------------------
 824
 825 // Wrapper function for 'wernis_refid'
 826 function getWernisRefid () {
 827         // Is there cache?
 828         if (!isset($GLOBALS[__FUNCTION__])) {
 829                 // Get config entry
 830                 $GLOBALS[__FUNCTION__] = getConfig('wernis_refid');
 831         } // END - if
 832
 833         // Return cache
 834         return $GLOBALS[__FUNCTION__];
 835 }
 836
 837 // Wrapper function for 'wernis_pass_md5'
 838 function getWernisPassMd5 () {
 839         // Is there cache?
 840         if (!isset($GLOBALS[__FUNCTION__])) {
 841                 // Get config entry
 842                 $GLOBALS[__FUNCTION__] = getConfig('wernis_pass_md5');
 843         } // END - if
 844
 845         // Return cache
 846         return $GLOBALS[__FUNCTION__];
 847 }
 848
 849 // Wrapper function for 'wernis_api_id'
 850 function getWernisApiId () {
 851         // Is there cache?
 852         if (!isset($GLOBALS[__FUNCTION__])) {
 853                 // Get config entry
 854                 $GLOBALS[__FUNCTION__] = getConfig('wernis_api_id');
 855         } // END - if
 856
 857         // Return cache
 858         return $GLOBALS[__FUNCTION__];
 859 }
 860
 861 // Wrapper function for 'wernis_api_md5'
 862 function getWernisApiMd5 () {
 863         // Is there cache?
 864         if (!isset($GLOBALS[__FUNCTION__])) {
 865                 // Get config entry
 866                 $GLOBALS[__FUNCTION__] = getConfig('wernis_api_md5');
 867         } // END - if
 868
 869         // Return cache
 870         return $GLOBALS[__FUNCTION__];
 871 }
 872
 873 // Wrapper function for 'wernis_api_url'
 874 function getWernisApiUrl () {
 875         // Is there cache?
 876         if (!isset($GLOBALS[__FUNCTION__])) {
 877                 // Get config entry
 878                 $GLOBALS[__FUNCTION__] = getConfig('wernis_api_url');
 879         } // END - if
 880
 881         // Return cache
 882         return $GLOBALS[__FUNCTION__];
 883 }
 884
 885 // Wrapper function for 'wernis_withdraw_active'
 886 function getWernisWithdrawActive () {
 887         // Is there cache?
 888         if (!isset($GLOBALS[__FUNCTION__])) {
 889                 // Get config entry
 890                 $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_active');
 891         } // END - if
 892
 893         // Return cache
 894         return $GLOBALS[__FUNCTION__];
 895 }
 896
 897 // Wrapper function for 'wernis_payout_active'
 898 function getWernisPayoutActive () {
 899         // Is there cache?
 900         if (!isset($GLOBALS[__FUNCTION__])) {
 901                 // Get config entry
 902                 $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_active');
 903         } // END - if
 904
 905         // Return cache
 906         return $GLOBALS[__FUNCTION__];
 907 }
 908
 909 // Wrapper function for 'wernis_withdraw_active'
 910 function isWernisWithdrawActive () {
 911         // Is there cache?
 912         if (!isset($GLOBALS[__FUNCTION__])) {
 913                 // Get config entry
 914                 $GLOBALS[__FUNCTION__] = (getConfig('wernis_withdraw_active') == 'Y');
 915         } // END - if
 916
 917         // Return cache
 918         return $GLOBALS[__FUNCTION__];
 919 }
 920
 921 // Wrapper function for 'wernis_payout_active'
 922 function isWernisPayoutActive () {
 923         // Is there cache?
 924         if (!isset($GLOBALS[__FUNCTION__])) {
 925                 // Get config entry
 926                 $GLOBALS[__FUNCTION__] = (getConfig('wernis_payout_active') == 'Y');
 927         } // END - if
 928
 929         // Return cache
 930         return $GLOBALS[__FUNCTION__];
 931 }
 932
 933 // Wrapper function for 'wernis_withdraw_factor'
 934 function getWernisWithdrawFactor () {
 935         // Is there cache?
 936         if (!isset($GLOBALS[__FUNCTION__])) {
 937                 // Get config entry
 938                 $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_factor');
 939         } // END - if
 940
 941         // Return cache
 942         return $GLOBALS[__FUNCTION__];
 943 }
 944
 945 // Wrapper function for 'wernis_payout_factor'
 946 function getWernisPayoutFactor () {
 947         // Is there cache?
 948         if (!isset($GLOBALS[__FUNCTION__])) {
 949                 // Get config entry
 950                 $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_factor');
 951         } // END - if
 952
 953         // Return cache
 954         return $GLOBALS[__FUNCTION__];
 955 }
 956
 957 // Wrapper function for 'wernis_withdraw_fee_percent'
 958 function getWernisWithdrawFeePercent () {
 959         // Is there cache?
 960         if (!isset($GLOBALS[__FUNCTION__])) {
 961                 // Get config entry
 962                 $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_fee_percent');
 963         } // END - if
 964
 965         // Return cache
 966         return $GLOBALS[__FUNCTION__];
 967 }
 968
 969 // Wrapper function for 'wernis_withdraw_fee_fix'
 970 function getWernisWithdrawFeeFix () {
 971         // Is there cache?
 972         if (!isset($GLOBALS[__FUNCTION__])) {
 973                 // Get config entry
 974                 $GLOBALS[__FUNCTION__] = getConfig('wernis_withdraw_fee_fix');
 975         } // END - if
 976
 977         // Return cache
 978         return $GLOBALS[__FUNCTION__];
 979 }
 980
 981 // Wrapper function for 'wernis_payout_fee_percent'
 982 function getWernisPayoutFeePercent () {
 983         // Is there cache?
 984         if (!isset($GLOBALS[__FUNCTION__])) {
 985                 // Get config entry
 986                 $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_fee_percent');
 987         } // END - if
 988
 989         // Return cache
 990         return $GLOBALS[__FUNCTION__];
 991 }
 992
 993 // Wrapper function for 'wernis_payout_fee_fix'
 994 function getWernisPayoutFeeFix () {
 995         // Is there cache?
 996         if (!isset($GLOBALS[__FUNCTION__])) {
 997                 // Get config entry
 998                 $GLOBALS[__FUNCTION__] = getConfig('wernis_payout_fee_fix');
 999         } // END - if
1000
1001         // Return cache
1002         return $GLOBALS[__FUNCTION__];
1003 }
1004
1005 // Wrapper function for 'wernis_min_payout'
1006 function getWernisMinPayout () {
1007         // Is there cache?
1008         if (!isset($GLOBALS[__FUNCTION__])) {
1009                 // Get config entry
1010                 $GLOBALS[__FUNCTION__] = getConfig('wernis_min_payout');
1011         } // END - if
1012
1013         // Return cache
1014         return $GLOBALS[__FUNCTION__];
1015 }
1016
1017 // Wrapper function for 'wernis_min_withdraw'
1018 function getWernisMinWithdraw () {
1019         // Is there cache?
1020         if (!isset($GLOBALS[__FUNCTION__])) {
1021                 // Get config entry
1022                 $GLOBALS[__FUNCTION__] = getConfig('wernis_min_withdraw');
1023         } // END - if
1024
1025         // Return cache
1026         return $GLOBALS[__FUNCTION__];
1027 }
1028
1029 // Wrapper function for 'wernis_base_url'
1030 function getWernisBaseUrl () {
1031         // Is there cache?
1032         if (!isset($GLOBALS[__FUNCTION__])) {
1033                 // Get config entry
1034                 $GLOBALS[__FUNCTION__] = getConfig('wernis_base_url');
1035         } // END - if
1036
1037         // Return cache
1038         return $GLOBALS[__FUNCTION__];
1039 }
1040
1041 // [EOF]
1042 ?>