2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 10/10/2008 *
4 * =================== Last change: 10/10/2008 *
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 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * For more information visit: http://www.mxchange.org *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program; if not, write to the Free Software *
35 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
44 // Queries the given Yoo!Media API 2.0 script
45 function YOOMEDIA_QUERY_API ($script, $countQuery = true) {
46 // Init response array
49 // Enougth queries left?
50 if ((getConfig('yoomedia_requests_remain') > 0) || ($countQuery === false)) {
51 // Prepare the low-level request
52 $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",
54 getConfig('yoomedia_id'),
55 getConfig('yoomedia_sid'),
56 getConfig('yoomedia_passwd'),
57 getConfig('yoomedia_tm_max_reload'),
58 getConfig('yoomedia_tm_min_wait'),
59 getConfig('yoomedia_tm_clicks_remain'),
60 getConfig('yoomedia_tm_min_pay'),
61 getConfig('yoomedia_erotic_allowed')
65 $response = sendGetRequest($requestString);
67 // Convert from ISO to UTF-8 only if count is > 3 because <= 3 means timeout
68 if (count($response) > 3) {
69 // Convert all lines to UTF-8
70 foreach ($response as $k => $v) {
72 $response[$k] = iconv('windows-1252', 'UTF-8//TRANSLIT', $v);
74 // iconv()-less ISO-8859-1 -> UTF-8
75 $response[$k] = preg_replace(
77 "chr(0xC0|ord('\\1')>>6).chr(0x80|ord('\\1')&0x3F)",
84 // Shall we count the query as used?
85 if ($countQuery === true) {
86 // Then update the config!
87 updateConfiguration('yoomedia_requests_remain', 1, '-');
95 // Test if the extension settings did work
96 function YOOMEDIA_TEST_CONFIG ($data) {
103 // Transfer config data
106 // Temporary allow maximum
107 setConfigEntry('yoomedia_tm_max_reload' , 100000);
108 setConfigEntry('yoomedia_tm_min_wait' , 0);
109 setConfigEntry('yoomedia_tm_clicks_remain', 10);
110 setConfigEntry('yoomedia_tm_min_pay' , 0);
111 setConfigEntry('yoomedia_erotic_allowed' , 1);
113 // Query the API with a test request without couting it
114 // If zero reply comes back the data is invalid!
115 $response = YOOMEDIA_QUERY_API('out_textmail.php', true); // @TODO Ask Yoo!Media for test script
117 // Default error code is 0 = all fine!
118 $errorCode = YOOMEDIA_GET_ERRORCODE_FROM_RESULT($response);
120 // Log the response if failed
121 if (count($response) == '0') {
122 // Queries depleted (as we count here!)
123 logDebugMessage(__FUNCTION__, __LINE__, 'Requested depleted. Maxmimum was: ' . getConfig('yoomedia_requests_total'));
125 } elseif (!isset($response[8])) {
127 logDebugMessage(__FUNCTION__, __LINE__, 'Missing response line [8]. Raw response=' . base64_encode(serialize($response)));
129 } elseif ((($errorCode <= 4) && ($errorCode > 0)) || ($errorCode >= 8)) {
130 // An error has returned from the account
131 logDebugMessage(__FUNCTION__, __LINE__, 'Unexpected error code ' . $errorCode . ' received.');
132 } elseif (count($response) < 9) {
133 // Log serialized raw response
134 logDebugMessage(__FUNCTION__, __LINE__, 'Raw response=' . base64_encode(serialize($response)));
137 // This is fine, because the result array is okay and the response code on element 8 is fine
141 // Do we have some data there?
142 return ($errorCode == '0');
145 // "Getter" for a parsed result for all text mails. This means an array without
146 // the header lines will be returned
147 function YOOMEDIA_GET_PARSED_RESULT_TEXTMAILS () {
148 // Get the raw response
149 $response = YOOMEDIA_QUERY_API('out_textmail.php');
151 // Parse the response
152 $result = YOOMEDIA_PARSE_RESPONSE($response, 'textmail');
158 // Parser function for Yoo!Media API responses
159 function YOOMEDIA_PARSE_RESPONSE ($response, $type) {
163 // Cut off the header
165 foreach ($response as $line) {
169 // Is this line empty?
176 // If we have no result, abort here
177 if (count($dummy) == 0) {
178 // Empty response from API
179 logDebugMessage(__FUNCTION__, __LINE__, 'Empy result from API received.');
183 // The result is now still raw, so we must split it up and trim spaces away
184 $responseLine = trim(implode("\n", $dummy));
186 // Last line should never be a pipe!
187 if (substr($responseLine, -1, 1) == '|') $responseLine = substr($responseLine, 0, -1);
189 // Now, explode all in one array
190 $dataArray = explode('|', $responseLine);
192 // Now make the result array with two dimensions
193 $cnt = '0'; $entry = '0';
194 foreach ($dataArray as $line) {
196 $result[$entry][yoomediaTranslateIndex($type, $cnt)] = $line;
198 // End of data of first entry reached?
200 // Then advance to next entry and reset counter
213 // Prepares a bonus mail for delivery. Works only if extension 'bonus' is active
214 function YOOMEDIA_PREPARE_MAIL_DELIVERY ($data) {
219 } elseif (!isExtensionActive('bonus')) {
224 // Is the waiting time below one second? Then fix it to one (zero seconds are not yet supported!)
225 if ($data['wait'] < 1) $data['wait'] = 1;
227 // Half of waiting time is a good reward!
228 $data['reward'] = round($data['wait'] / 2 + 0.4);
230 // Is the reward below one?
231 if ($data['reward'] < 1) $data['reward'] = 1;
234 $data['sid'] = getConfig('yoomedia_sid');
236 // Add total receivers
237 $data['all'] = translateComma(getTotalReceivers());
240 $data['categories'] = generateCategoryOptionsList('normal');
243 $data['text'] = decodeEntities($data['text']);
246 loadTemplate('admin_send_yoomedia', false, $data);
249 // Adds the mail to the bonus mail pool
250 function YOOMEDIA_SEND_BONUS_MAIL ($data, $mode) {
255 } elseif (!isExtensionActive('bonus')) {
260 // Add dummy receiver to avoid notice
261 $data['receiver'] = '0';
263 // HTML or normal? (normal is default...)
265 if (($mode == 'html') && (isExtensionActive('html_mail'))) $type = 'h';
268 $data['url'] = sprintf("http://www.yoomedia.de/code/%s-mail.php?id=%s&sid=%s",
274 // Lock this mail for new delivery
275 YOOMEDIA_RELOAD_LOCK($data, $mode);
277 // Call the lower function
278 addNewBonusMail($data, $mode);
282 function YOOMEDIA_EXCLUDE_MAIL ($data, $mode) {
283 // Search for the entry
284 if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mode) === false) {
285 // Convert mode for mails
286 $mode = YOOMEDIA_CONVERT_MODE($mode);
289 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`,`y_id`,`y_reload`,`inserted`) VALUES ('%s',%s,%s,'0000-00-00 00:00')",
292 bigintval($data['id']),
293 bigintval($data['reload'])
294 ), __FUNCTION__, __LINE__);
298 // Remove lock of given mail
299 function YOOMEDIA_UNLIST_MAIL ($data, $mode) {
300 // Convert mode for mails
301 $mode = YOOMEDIA_CONVERT_MODE($mode);
304 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_yoomedia_reload` WHERE `type`='%s' AND `y_id`=%s LIMIT 1",
305 array($mode, bigintval($data['id'])), __FUNCTION__, __LINE__);
308 // "Translates" the index number into an assosiative value
309 function yoomediaTranslateIndex ($type, $index) {
310 // Default is the index
313 // Is the element there?
314 if (isset($GLOBALS['translation_tables']['yoomedia'][$type][$index])) {
316 $return = $GLOBALS['translation_tables']['yoomedia'][$type][$index];
319 logDebugMessage(__FUNCTION__, __LINE__, "type={$type},index={$index} not found.");
326 // "Translate" error code
327 function translateYooMediaError ($errorCode) {
328 // Default is 'failed'
329 $return = 'failed (Code: ' . $errorCode . ')';
331 // Is the entry there?
332 if (isset($GLOBALS['translation_tables']['yoomedia']['error_codes'][$errorCode])) {
334 $return = $GLOBALS['translation_tables']['yoomedia']['error_codes'][$errorCode];
336 // Log missing entries
337 debug_report_bug(sprintf("Unknown error code <strong>%s</strong> detected.", $errorCode));
344 // Checks if the mail id is in reload lock
345 function YOOMEDIA_CHECK_RELOAD ($id, $reload, $type) {
346 // Default is not in reload lock
350 $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",
351 array($type, bigintval($id)), __FUNCTION__, __LINE__);
354 if (SQL_NUMROWS($result) == 1) {
356 list($id, $time) = SQL_FETCHROW($result);
358 // Are we ready to sent again?
359 if (((time() - $time) >= ($reload * 60*60)) && ($time > 0)) {
361 SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_yoomedia_reload` WHERE `id`=%s LIMIT 1",
362 array($id), __FUNCTION__, __LINE__);
364 // Dont' sent again this mail
370 SQL_FREERESULT($result);
376 // Lock given mail down for reload lock
377 function YOOMEDIA_RELOAD_LOCK ($data, $mode) {
378 // Search for the entry
379 if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mode) === false) {
380 // Convert mode for mails
381 $mode = YOOMEDIA_CONVERT_MODE($mode);
384 SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`,`y_id`,`y_reload`) VALUES ('%s',%s,%s)",
385 array($mode, bigintval($data['id']), bigintval($data['reload'])), __FUNCTION__, __LINE__);
389 // Convert mode for mails
390 function YOOMEDIA_CONVERT_MODE ($mode) {
391 // Convert mode for normal/html
406 // Extract code from response
407 function YOOMEDIA_GET_ERRORCODE_FROM_RESULT ($response) {
408 // Bad code as default
411 // Which response should we parse?
412 if ((isset($response[8])) && (count($response) == 9)) {
413 // Use error code from element 8 (mostly API errors)
414 $codeArray = explode('<br>', $response[8]);
416 // Use only the first element
417 $code = bigintval($codeArray[0]);
418 } elseif ((is_array($response[0])) && (isset($response[0]['id']))) {
419 // Begin with extraction
420 $codeArray = explode(' ', $response[0]['id']);
421 $code = $codeArray[0];
422 $codeArray = explode('<br />', $code);
423 $code = $codeArray[0];
424 $codeArray = explode('<br>', $code);
425 $code = $codeArray[0];
427 // Remove all new-line characters
428 $codeArray = explode("\n", $code);
429 $code = $codeArray[0];
431 // Remove carrige-return
432 $code = str_replace("\n", '', $code);
434 // Should not happen!
435 debug_report_bug('Cannot parse response. Raw response:<pre>' . print_r($response, true) . '</pre>');