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