inc/libs/yoomedia_functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 10/10/2008 *
   4  * ===================                          Last change: 10/10/2008 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : yoomedia_functions.php                           *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Special functions for yoomedia extension         *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Spezielle Funktion fuer Yoo!Media-Erweiterung    *
  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 - 2011 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 // Queries the given Yoo!Media API 2.0 script
  44 function YOOMEDIA_QUERY_API ($script, $countQuery = true) {
  45         // Init response array
  46         $response = array();
  47
  48         // Enougth queries left?
  49         if ((getConfig('yoomedia_requests_remain') > 0) || ($countQuery === false)) {
  50                 // Prepare request array
  51                 $requestData = array(
  52                         'id'         => getConfig('yoomedia_id'),
  53                         'sid'        => getConfig('yoomedia_sid'),
  54                         'pw'         => getConfig('yoomedia_passwd'),
  55                         'reload'     => getConfig('yoomedia_tm_max_reload'),
  56                         'ma'         => getConfig('yoomedia_tm_min_wait'),
  57                         'uebrig'     => getConfig('yoomedia_tm_clicks_remain'),
  58                         'verguetung' => getConfig('yoomedia_tm_min_pay'),
  59                         'erotik'     => getConfig('yoomedia_erotic_allowed')
  60                 );
  61
  62                 // Run the query
  63                 $response = sendGetRequest('http://www.yoomedia.de/interface_2.0/' . $script, $requestData, true);
  64
  65                 // Convert from ISO to UTF-8 only if count is > 3 because <= 3 means timeout
  66                 if (count($response) > 3) {
  67                         // Convert all lines to UTF-8
  68                         foreach ($response as $k => $v) {
  69                                 // Convert the line
  70                                 $response[$k] = iconv('windows-1252', 'UTF-8//TRANSLIT', $v);
  71                         } // END - foreach
  72                 } // END - if
  73
  74                 // Shall we count the query as used?
  75                 if ($countQuery === true) {
  76                         // Then update the config!
  77                         updateConfiguration('yoomedia_requests_remain', 1, '-');
  78                 } // END - if
  79         } // END - if
  80
  81         // Return the data
  82         return $response;
  83 }
  84
  85 // Test if the extension settings did work
  86 function YOOMEDIA_TEST_CONFIG ($data) {
  87         // Is this admin?
  88         if (!isAdmin()) {
  89                 // No admin!
  90                 return false;
  91         } // END - if
  92
  93         // Remove 'ok'
  94         unset($data['ok']);
  95
  96         // Merge config
  97         mergeConfig($data);
  98
  99         // Temporary allow maximum
 100         setConfigEntry('yoomedia_tm_max_reload'   , '100000');
 101         setConfigEntry('yoomedia_tm_min_wait'     , '1000');
 102         setConfigEntry('yoomedia_tm_clicks_remain', '10');
 103         setConfigEntry('yoomedia_tm_min_pay'      , '0.00001');
 104         setConfigEntry('yoomedia_erotic_allowed'  , '1');
 105
 106         // Query the API with a test request without couting it
 107         // If zero reply comes back the data is invalid!
 108         $response = YOOMEDIA_QUERY_API('out_textmail.php', true); // @TODO Ask Yoo!Media for test script
 109
 110         // Default error code is 0 = all fine!
 111         $errorCode = YOOMEDIA_GET_ERRORCODE_FROM_RESULT($response);
 112
 113         // Log the response if failed
 114         if ((count($response) == 0) && ($errorCode > 0)) {
 115                 // Queries depleted (as we count here!)
 116                 logDebugMessage(__FUNCTION__, __LINE__, 'Requested depleted. Maxmimum was: ' . getConfig('yoomedia_requests_total') . ',errorCode=' . $errorCode);
 117                 $errorCode = -1;
 118         } elseif ((($errorCode <= 4) && ($errorCode > 0)) || ($errorCode >= 8)) {
 119                 // An error has returned from the account
 120                 logDebugMessage(__FUNCTION__, __LINE__, 'Unexpected error code ' . $errorCode . ' received.');
 121         } elseif ((count($response) > 0) && ($errorCode != 0)) {
 122                 // Log serialized raw response
 123                 logDebugMessage(__FUNCTION__, __LINE__, 'errorCode=' . $errorCode . ',response=' . base64_encode(serialize($response)));
 124                 $errorCode = -1;
 125         } else {
 126                 // This is fine, because the result array is okay and the response code on element 8 is fine
 127                 $errorCode = '0';
 128         }
 129
 130         // Do we have some data there?
 131         return ($errorCode == '0');
 132 }
 133
 134 // "Getter" for a parsed result for all text mails. This means an array without
 135 // the header lines will be returned
 136 function YOOMEDIA_GET_PARSED_RESULT_TEXTMAILS () {
 137         // Get the raw response
 138         $response = YOOMEDIA_QUERY_API('out_textmail.php');
 139
 140         // By default an empty result is returned
 141         $result = array();
 142
 143         // Parse the response
 144         if (count($response) > 0) {
 145                 $result = YOOMEDIA_PARSE_RESPONSE($response, 'textmail');
 146         } // END - if
 147
 148         // Return result
 149         return $result;
 150 }
 151
 152 // Parser function for Yoo!Media API responses
 153 function YOOMEDIA_PARSE_RESPONSE ($response, $type) {
 154         // Init result
 155         $result = array();
 156
 157         // Cut off the header
 158         $dummy = removeHttpHeaderFromResponse($response);
 159
 160         // If we have no result, abort here
 161         if (count($dummy) == 0) {
 162                 // Empty response from API
 163                 debug_report_bug(__FUNCTION__, __LINE__, 'Empty result from API received. response()=' . count($response) . ',type=' . $type);
 164                 return array();
 165         } // END - if
 166
 167         // The result is now still raw, so we must split it up and trim spaces away
 168         $responseLine = trim(implode("\n", $dummy));
 169
 170         // Last line should never be a pipe!
 171         if (substr($responseLine, -1, 1) == '|') {
 172                 $responseLine = substr($responseLine, 0, -1);
 173         } // END - if
 174
 175         // Now, explode all in one array
 176         $dataArray = explode('|', $responseLine);
 177
 178         // Now make the result array with two dimensions
 179         $count = '0'; $entry = '0';
 180         foreach ($dataArray as $line) {
 181                 // Add the line
 182                 $result[$entry][yoomediaTranslateIndex($type, $count)] = $line;
 183
 184                 // End of data of first entry reached?
 185                 if ($count == 6) {
 186                         // Then advance to next entry and reset counter
 187                         $entry++;
 188                         $count = '0';
 189                 } else {
 190                         // Count up
 191                         $count++;
 192                 }
 193         } // END - foreach
 194
 195         // Return it
 196         return $result;
 197 }
 198
 199 // Prepares a bonus mail for delivery. Works only if extension 'bonus' is active
 200 function YOOMEDIA_PREPARE_MAIL_DELIVERY ($data) {
 201         // Is this an admin?
 202         if (!isAdmin()) {
 203                 // Abort here
 204                 return false;
 205         } elseif (!isExtensionActive('bonus')) {
 206                 // Abort here
 207                 return false;
 208         }
 209
 210         // Is the waiting time below one second? Then fix it to one (zero seconds are not yet supported!)
 211         if ($data['wait'] < 1) $data['wait'] = 1;
 212
 213         // Half of waiting time is a good reward!
 214         $data['reward'] = round($data['wait'] / 2 + 0.4);
 215
 216         // Is the reward below one?
 217         if ($data['reward'] < 1) $data['reward'] = 1;
 218
 219         // Load template
 220         loadTemplate('admin_send_yoomedia', false, $data);
 221 }
 222
 223 // Adds the mail to the bonus mail pool
 224 function YOOMEDIA_SEND_BONUS_MAIL ($data, $mailMode) {
 225         // Is this an admin?
 226         if (!isAdmin()) {
 227                 // Abort here
 228                 return false;
 229         } elseif (!isExtensionActive('bonus')) {
 230                 // Abort here
 231                 return false;
 232         }
 233
 234         // Add dummy receiver to avoid notice
 235         $data['receiver'] = '0';
 236
 237         // HTML or normal? (normal is default...)
 238         $type = 't';
 239         if (($mailMode == 'html') && (isExtensionActive('html_mail'))) $type = 'h';
 240
 241         // Auto-generate URL
 242         $data['url'] = sprintf("http://www.yoomedia.de/code/%s-mail.php?id=%s&sid=%s",
 243                 $type,
 244                 $data['id'],
 245                 $data['sid']
 246         );
 247
 248         // Lock this mail for new delivery
 249         YOOMEDIA_RELOAD_LOCK($data, $mailMode);
 250
 251         // Call the lower function
 252         addNewBonusMail($data, $mailMode);
 253 }
 254
 255 // Lockdown given id
 256 function YOOMEDIA_EXCLUDE_MAIL ($data, $mailMode) {
 257         // Search for the entry
 258         if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mailMode) === false) {
 259                 // Convert mode for mails
 260                 $mailMode = YOOMEDIA_CONVERT_MODE($mailMode);
 261
 262                 // Add the entry
 263                 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`,`y_id`,`y_reload`,`inserted`) VALUES ('%s',%s,%s,'0000-00-00 00:00')",
 264                         array(
 265                                 $mailMode,
 266                                 bigintval($data['id']),
 267                                 bigintval($data['reload'])
 268                         ), __FUNCTION__, __LINE__);
 269         } // END - if
 270 }
 271
 272 // Remove lock of given mail
 273 function YOOMEDIA_UNLIST_MAIL ($data, $mailMode) {
 274         // Convert mode for mails
 275         $mailMode = YOOMEDIA_CONVERT_MODE($mailMode);
 276
 277         // Add the entry
 278         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_yoomedia_reload` WHERE `type`='%s' AND `y_id`=%s LIMIT 1",
 279                 array($mailMode, bigintval($data['id'])), __FUNCTION__, __LINE__);
 280 }
 281
 282 // "Translates" the index number into an assosiative value
 283 function yoomediaTranslateIndex ($type, $index) {
 284         // Default is the index
 285         $return = $index;
 286
 287         // Is the element there?
 288         if (isset($GLOBALS['translation_tables']['yoomedia'][$type][$index])) {
 289                 // Use this element
 290                 $return = $GLOBALS['translation_tables']['yoomedia'][$type][$index];
 291         } else {
 292                 // Not found
 293                 logDebugMessage(__FUNCTION__, __LINE__, 'type=' . $type . ',index=' . $index . ' not found');
 294         }
 295
 296         // Return value
 297         return $return;
 298 }
 299
 300 // "Translate" error code
 301 function translateYooMediaError ($errorCode) {
 302         // Default is 'failed'
 303         $return = 'failed (Code: ' . $errorCode . ')';
 304
 305         // Is the entry there?
 306         if (isset($GLOBALS['translation_tables']['yoomedia']['error_codes'][$errorCode])) {
 307                 // Entry found
 308                 $return = $GLOBALS['translation_tables']['yoomedia']['error_codes'][$errorCode];
 309         } else {
 310                 // Log missing entries
 311                 debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown error code <strong>%s[%s]</strong> detected.", $errorCode, gettype($errorCode)));
 312         }
 313
 314         // Return value
 315         return $return;
 316 }
 317
 318 // Checks if the mail id is in reload lock
 319 function YOOMEDIA_CHECK_RELOAD ($id, $reload, $type) {
 320         // Default is not in reload lock
 321         $reloaded = false;
 322
 323         // Query database
 324         $result = SQL_QUERY_ESC("SELECT `id`, UNIX_TIMESTAMP(`inserted`) AS inserted FROM `{?_MYSQL_PREFIX?}_yoomedia_reload` WHERE `type`='%s' AND `y_id`=%s LIMIT 1",
 325                 array($type, bigintval($id)), __FUNCTION__, __LINE__);
 326
 327         // Entry found?
 328         if (SQL_NUMROWS($result) == 1) {
 329                 // Load time
 330                 list($id, $time) = SQL_FETCHROW($result);
 331
 332                 // Are we ready to sent again?
 333                 if (((time() - $time) >= ($reload * 60*60)) && ($time > 0)) {
 334                         // Remove entry
 335                         SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_yoomedia_reload` WHERE `id`=%s LIMIT 1",
 336                                 array($id), __FUNCTION__, __LINE__);
 337                 } else {
 338                         // Dont' sent again this mail
 339                         $reloaded = $time;
 340                 }
 341         } // END - if
 342
 343         // Free result
 344         SQL_FREERESULT($result);
 345
 346         // Return result
 347         return $reloaded;
 348 }
 349
 350 // Lock given mail down for reload lock
 351 function YOOMEDIA_RELOAD_LOCK ($data, $mailMode) {
 352         // Search for the entry
 353         if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mailMode) === false) {
 354                 // Convert mode for mails
 355                 $mailMode = YOOMEDIA_CONVERT_MODE($mailMode);
 356
 357                 // Add the entry
 358                 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`,`y_id`,`y_reload`) VALUES ('%s',%s,%s)",
 359                         array($mailMode, bigintval($data['id']), bigintval($data['reload'])), __FUNCTION__, __LINE__);
 360         } // END - if
 361 }
 362
 363 // Convert mode for mails
 364 function YOOMEDIA_CONVERT_MODE ($mailMode) {
 365         // Convert mode for normal/html
 366         switch ($mailMode) {
 367                 case 'normal':
 368                         $mailMode = 'textmail';
 369                         break;
 370
 371                 case 'html':
 372                         $mailMode = 'htmlmail';
 373                         break;
 374         } // END - switch
 375
 376         // Return result
 377         return $mailMode;
 378 }
 379
 380 // Extract code from response
 381 function YOOMEDIA_GET_ERRORCODE_FROM_RESULT ($response) {
 382         // The response must be an array
 383         assert(is_array($response));
 384
 385         // Bad code as default
 386         $code = -999;
 387
 388         // Which response should we parse?
 389         if ((isset($response[8])) && (count($response) == 9)) {
 390                 // Use error code from element 8 (mostly API errors)
 391                 $codeArray = explode('<br>', $response[8]);
 392
 393                 // Use only the first element
 394                 $code = bigintval($codeArray[0]);
 395         } elseif (!empty($response[0])) {
 396                 // Merge response together
 397                 $parts = explode('|', implode('', $response));
 398
 399                 // If we have only one part, we got an error
 400                 if (count($parts) > 1) {
 401                         // All fine
 402                         $code = '0';
 403                 } else {
 404                         // Begin with extraction of error code
 405                         $codeArray = explode(' ', $response[0]);
 406                         $code = $codeArray[0];
 407                         $codeArray = explode('<br />', $code);
 408                         $code = $codeArray[0];
 409                         $codeArray = explode('<br>', $code);
 410                         $code = $codeArray[0];
 411
 412                         // Remove all new-line characters
 413                         $codeArray = explode("\n", $code);
 414                         $code = $codeArray[0];
 415
 416                         // Remove carrige-return
 417                         $code = trim(str_replace("\n", '', $code));
 418
 419                         // Is it still empty?
 420                         if (empty($code)) {
 421                                 // Then fix it
 422                                 $code = -999;
 423                         } // END - if
 424                 }
 425         } elseif (count($response) == 0) {
 426                 // All fine, but empty result
 427                 $code = '0';
 428         } else {
 429                 // Should not happen!
 430                 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot parse response. Raw response:<pre>' . print_r($response, true) . '</pre>');
 431         }
 432
 433         // Return error code
 434         return $code;
 435 }
 436
 437 // [EOF]
 438 ?>