<?php
/************************************************************************
 * MXChange v0.2.1                                    Start: 08/31/2008 *
 * ===============                              Last change: 08/31/2008 *
 *                                                                      *
 * -------------------------------------------------------------------- *
 * File              : surfbar_functions.php                            *
 * -------------------------------------------------------------------- *
 * Short description : Functions for surfbar                            *
 * -------------------------------------------------------------------- *
 * Kurzbeschreibung  : Funktionen fuer die Surfbar                      *
 * -------------------------------------------------------------------- *
 *                                                                      *
 * -------------------------------------------------------------------- *
 * Copyright (c) 2003 - 2008 by Roland Haeder                           *
 * For more information visit: http://www.mxchange.org                  *
 *                                                                      *
 * This program is free software; you can redistribute it and/or modify *
 * it under the terms of the GNU General Public License as published by *
 * the Free Software Foundation; either version 2 of the License, or    *
 * (at your option) any later version.                                  *
 *                                                                      *
 * This program is distributed in the hope that it will be useful,      *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
 * GNU General Public License for more details.                         *
 *                                                                      *
 * You should have received a copy of the GNU General Public License    *
 * along with this program; if not, write to the Free Software          *
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
 * MA  02110-1301  USA                                                  *
 ************************************************************************/

// Some security stuff...
if (ereg(basename(__FILE__), $_SERVER['PHP_SELF'])) {
	$INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
	require($INC);
}

// Admin has added an URL with given user id
function SURFBAR_ADMIN_ADD_URL ($url, $uid, $reward, $paymentId) {
	// Is this really an admin?
	if (!IS_ADMIN()) {
		// Then leave here
		return false;
	} // END - if

	// Check if that URL does not exist
	if (SURFBAR_LOOKUP_BY_URL($url, $uid)) {
		// Already found!
		return false;
	} // END - if

	// Register the new URL
	return SURFBAR_REGISTER_URL($url, $uid, $reward, $paymentId, "CONFIRMED", "unlock");
}
// Looks up by an URL
function SURFBAR_LOOKUP_BY_URL ($url) {
	// Now lookup that given URL by itself
	$urlArray = SURFBAR_GET_URL_DATA($url, "url");

	// Was it found?
	return (count($urlArray) > 0);
}
// Load URL data by given search term and column
function SURFBAR_GET_URL_DATA ($searchTerm, $column="id", $order="id", $sort="ASC", $group="id") {
	global $lastUrlData;

	// By default nothing is found
	$lastUrlData = array();

	// Is the column an id number?
	if (($column == "id") || ($column == "userid")) {
		// Extra secure input
		$searchTerm = bigintval($searchTerm);
	} // END - if

	// Look up the record
	$result = SQL_QUERY_ESC("SELECT id, userid, url, reward, views_total, status, registered, last_locked, lock_reason
FROM "._MYSQL_PREFIX."_surfbar_urls
WHERE %s='%s'
ORDER BY %s %s",
		array($column, $searchTerm, $order, $sort), __FILE__, __LINE__);

	// Is there at least one record?
	if (SQL_NUMROWS($result) > 0) {
		// Then load all!
		while ($dataRow = SQL_FETCHARRAY($result)) {
			// Shall we group these results?
			if ($group == "id") {
				// Add the row by id as index
				$lastUrlData[$dataRow['id']] = $dataRow;
			} else {
				// Group entries
				$lastUrlData[$dataRow[$group]][$dataRow['id']] = $dataRow;
			}
		} // END - while
	} // END - if

	// Free the result
	SQL_FREERESULT($result);

	// Return the result
	return $lastUrlData;
}
// Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
function SURFBAR_REGISTER_URL ($url, $uid, $reward, $paymentId, $status="PENDING", $addMode="reg") {
	global $_CONFIG;

	// Make sure by the user registered URLs are always pending
	if ($addMode == "reg") $status = "PENDING";

	// Prepare content
	$content = array(
		'url'         => $url,
		'frametester' => FRAMETESTER($url),
		'uid'         => $uid,
		'reward'      => $reward,
		'payment_id'  => $paymentId,
		'status'      => $status
	);

	// Insert the URL into database
	$content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);

	// Translate status and reward
	$content['status'] = SURFBAR_TRANSLATE_STATUS($content['status']);
	$content['reward'] = TRANSLATE_COMMA($content['reward']);

	// If in reg-mode we notify admin
	if (($addMode == "reg") || ($_CONFIG['surfbar_notify_admin_unlock'] == "Y")) {
		// Notify admin even when he as unlocked an email
		SURFBAR_NOTIFY_ADMIN("url_{$addMode}", $content);
	} // END - if

	// Send mail to user
	SURFBAR_NOTIFY_USER("url_{$addMode}", $content);

	// Return the insert id
	return $content['insert_id'];
}
// Inserts an url by given data array and return the insert id
function SURFBAR_INSERT_URL_BY_ARRAY ($urlData) {
	// Just run the insert query for now
	SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_urls (userid, url, reward, payment_id, status) VALUES(%s, '%s', %s, %s, '%s')",
		array(
			bigintval($urlData['uid']),
			$urlData['url'],
			(float)$urlData['reward'],
			bigintval($urlData['payment_id']),
			$urlData['status']
		), __FILE__, __LINE__
	);

	// Return insert id
	return SQL_INSERTID();
}
// Notify admin(s) with a selected message and content
function SURFBAR_NOTIFY_ADMIN ($messageType, $content) {
	// Prepare template name
	$templateName = sprintf("admin_surfbar_%s", $messageType);

	// Prepare subject
	$eval = sprintf("\$subject = ADMIN_SURFBAR_NOTIFY_%s_SUBJECT;",
		strtoupper($messageType)
	);
	eval($eval);

	// Send the notification out
	SEND_ADMIN_NOTIFICATION($subject, $templateName, $content, $content['uid']);
}
// Notify the user about the performed action
function SURFBAR_NOTIFY_USER ($messageType, $content) {
	// Prepare template name
	$templateName = sprintf("member_surfbar_%s", $messageType);

	// Prepare subject
	$eval = sprintf("\$subject = MEMBER_SURFBAR_NOTIFY_%s_SUBJECT;",
		strtoupper($messageType)
	);
	eval($eval);

	// Load template
	$mailText = LOAD_EMAIL_TEMPLATE($templateName, $content);

	// Send the email
	SEND_EMAIL($content['uid'], $subject, $mailText);
}
// Translate the URL status
function SURFBAR_TRANSLATE_STATUS ($status) {
	// Create constant name
	$constantName = sprintf("SURFBAR_URL_STATUS_%s", strtoupper($status));

	// Set default translated status
	$statusTranslated = "!".$constantName."!";

	// Generate eval() command
	if (defined($constantName)) {
		$eval = "\$statusTranslated = ".$constantName.";";
		eval($eval);
	} // END - if

	// Return result
	return $statusTranslated;
}
// Determine right template name
function SURFBAR_DETERMINE_TEMPLATE_NAME() {
	// Default is the frameset
	$templateName = "surfbar_frameset";

	// Any frame set? ;-)
	if (isset($_GET['frame'])) {
		// Use the frame as a template name part... ;-)
		$templateName = sprintf("surfbar_frame_%s",
			SQL_ESCAPE($_GET['frame'])
		);
	} // END - if

	// Return result
	return $templateName;
}
// Check if the "reload lock" of the current user is full
function SURFBAR_CHECK_RELOAD_FULL() {
	global $SURFBAR_DATA, $_CONFIG;

	// Default is full!
	$isFull = true;

	// Do we have static or dynamic mode?
	if ($_CONFIG['surfbar_pay_model'] == "STATIC") {
		// Cache static reload lock
		$SURFBAR_DATA['surf_lock'] = $_CONFIG['surfbar_static_lock'];

		// Ask the database
		$result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt FROM "._MYSQL_PREFIX."_surfbar_locks
WHERE userid=%s AND (UNIX_TIMESTAMP() - ".SURFBAR_GET_DATA('surf_lock').") < UNIX_TIMESTAMP(last_surfed)
LIMIT 1",
			array($GLOBALS['userid']), __FILE__, __LINE__
		);

		// Fetch row
		list($SURFBAR_DATA['user_locks']) = SQL_FETCHROW($result);

		// Is it null?
		if (is_null($SURFBAR_DATA['user_locks'])) {
			// Then fix it to zero!
			$SURFBAR_DATA['user_locks'] = 0;
		} // END - if

		// Free result
		SQL_FREERESULT($result);

		// Get total URLs
		$total = SURFBAR_GET_TOTAL_URLS();

		// Do we have some URLs in lock? Admins can always surf on own URLs!
		$isFull = (($SURFBAR_DATA['user_locks'] == $total) && ($total > 0));
	} else {
		// Dynamic model...
		die("DYNAMIC not yet implemented!");
	}

	// Return result
	return $isFull;
}
// Get total amount of URLs of given status for current user or of CONFIRMED URLs by default
function SURFBAR_GET_TOTAL_URLS ($status="CONFIRMED") {
	// Get amount from database
	$result = SQL_QUERY_ESC("SELECT COUNT(id) AS cnt
FROM "._MYSQL_PREFIX."_surfbar_urls
WHERE userid != %d AND status='%s'",
		array($GLOBALS['userid'], $status), __FILE__, __LINE__
	);

	// Fetch row
	list($cnt) = SQL_FETCHROW($result);

	// Free result
	SQL_FREERESULT($result);

	// Return result
	return $cnt;
}
// Generate a validation code for the given id number
function SURFBAR_GENERATE_VALIDATION_CODE ($id, $salt="") {
	global $_CONFIG, $SURFBAR_DATA;

	// Generate a code until the length matches
	$valCode = "";
	while (strlen($valCode) != $_CONFIG['code_length']) {
		// Is the salt set?
		if (empty($salt)) {
			// Generate random hashed string
			$SURFBAR_DATA['salt'] = sha1(GEN_PASS(255));
		} else {
			// Use this as salt!
			$SURFBAR_DATA['salt'] = $salt;
		}
		//* DEBUG: */ echo "*".$SURFBAR_DATA['salt']."*<br />\n";

		// ... and now the validation code
		$valCode = GEN_RANDOM_CODE($_CONFIG['code_length'], sha1(SURFBAR_GET_DATA('salt').":".$id), $GLOBALS['userid']);
		//* DEBUG: */ echo "valCode={$valCode}<br />\n";
	} // END - while

	// Hash it with md5() and salt it with the random string
	$hashedCode = generateHash(md5($valCode), SURFBAR_GET_DATA('salt'));

	// Finally encrypt it PGP-like and return it
	return generatePassString($hashedCode);
}
// Check validation code
function SURFBAR_CHECK_VALIDATION_CODE ($id, $check, $salt) {
	global $SURFBAR_DATA;

	// Secure id number
	$id = bigintval($id);

	// Now generate the code again
	$code = SURFBAR_GENERATE_VALIDATION_CODE($id, $salt);

	// Return result of checking hashes and salts
	//* DEBUG: */ echo "--- ".$code."<br />\n--- ".$check."<br />\n";
	//* DEBUG: */ echo "+++ ".$salt."<br />\n+++ ".SURFBAR_GET_DATA('last_salt')."<br />\n";
	return (($code == $check) && ($salt == SURFBAR_GET_DATA('last_salt')));
}
// Lockdown the userid/id combination (reload lock)
function SURFBAR_LOCKDOWN_ID ($id) {
	// Just add it to the database
	SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_surfbar_locks (userid, url_id) VALUES(%s, %s)",
		array($GLOBALS['userid'], bigintval($id)), __FILE__, __LINE__);
}
// Pay points to the user and remove it from the sender
function SURFBAR_PAY_POINTS ($id) {
	global $SURFBAR_DATA, $_CONFIG;

	// Re-configure ref-system to surfbar levels
	$_CONFIG['db_percents'] = "percent";
	$_CONFIG['db_table']    = "surfbar_reflevels";

	// Book it to the user
	ADD_POINTS_REFSYSTEM($GLOBALS['userid'], $SURFBAR_DATA['reward']);

	// Remove it from the URL owner
	SUB_POINTS($SURFBAR_DATA['userid'], $SURFBAR_DATA['reward']);
}
// Update the salt for validation
function SURFBAR_UPDATE_SALT() {
	global $SURFBAR_DATA;

	// Simply store the salt from cache away in database...
	SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_surfbar_urls SET last_salt='%s', views_total=views_total+1 WHERE id=%s LIMIT 1",
		array(SURFBAR_GET_DATA('salt'), SURFBAR_GET_DATA('id')), __FILE__, __LINE__);

	// Return if the update was okay
	return (SQL_AFFECTEDROWS() == 1);
}
// Determine next id for surfbar view, always call this before you call other
// getters below this function!!!
function SURFBAR_GET_NEXT_ID ($id = 0) {
	global $SURFBAR_DATA, $_CONFIG;

	// Default is no id!
	$nextId = 0;

	// Is the ID set?
	if ($id == 0) {
		// Set max random factor to total URLs minus 1
		$maxRand = SURFBAR_GET_TOTAL_URLS() - 1;

		// Generate random number
		$randNum = mt_rand(0, $maxRand);

		// And query the database
		$result = SQL_QUERY_ESC("SELECT sb.id, sb.userid, sb.url, sb.last_salt, sb.reward, sb.views_total, p.time, UNIX_TIMESTAMP(l.last_surfed) AS last_surfed
FROM "._MYSQL_PREFIX."_surfbar_urls AS sb
LEFT JOIN "._MYSQL_PREFIX."_payments AS p
ON sb.payment_id=p.id
LEFT JOIN "._MYSQL_PREFIX."_surfbar_locks AS l
ON sb.id=l.url_id
WHERE sb.userid != %d AND sb.status='CONFIRMED' AND (l.last_surfed IS NULL OR (UNIX_TIMESTAMP() - ".SURFBAR_GET_DATA('surf_lock').") >= UNIX_TIMESTAMP(l.last_surfed))
ORDER BY l.last_surfed DESC, sb.last_salt ASC, sb.id ASC
LIMIT %d,1",
			array($GLOBALS['userid'], $randNum), __FILE__, __LINE__
		);
	} else {
		// Get data from specified id number
		$result = SQL_QUERY_ESC("SELECT sb.id, sb.userid, sb.url, sb.last_salt, sb.reward, sb.views_total, p.time
FROM "._MYSQL_PREFIX."_surfbar_urls AS sb
LEFT JOIN "._MYSQL_PREFIX."_payments AS p
ON sb.payment_id=p.id
WHERE sb.userid != %s AND sb.status='CONFIRMED' AND sb.id=%s
LIMIT 1",
			array($GLOBALS['userid'], bigintval($id)), __FILE__, __LINE__
		);
	}

	// Is there an id number?
	if (SQL_NUMROWS($result) == 1) {
		// Load/cache data
		//* DEBUG: */ echo "*".count($SURFBAR_DATA)."*<br />\n";
		$SURFBAR_DATA = merge_array($SURFBAR_DATA, SQL_FETCHARRAY($result));
		//* DEBUG: */ echo "*".count($SURFBAR_DATA)."*<br />\n";

		// Is the time there?
		if (is_null($SURFBAR_DATA['time'])) {
			// Then repair it wit the static!
			$SURFBAR_DATA['time'] = $_CONFIG['surfbar_static_time'];
		} // END - if

		// Fix missing last_surfed
		if ((!isset($SURFBAR_DATA['last_surfed'])) || (is_null($SURFBAR_DATA['last_surfed']))) {
			// Fix it here
			$SURFBAR_DATA['last_surfed'] = "0";
		} // END - if

		// Are we in static mode?
		if ($_CONFIG['surfbar_pay_model'] == "STATIC") {
			// Then use static reward!
			$SURFBAR_DATA['reward'] = $_CONFIG['surfbar_static_reward'];
		} else {
			// Calculate dynamic reward and add it
			$SURFBAR_DATA['reward'] += SURFBAR_CALCULATE_DYNAMIC_REWARD_ADD();
		}

		// Now get the id
		$nextId = SURFBAR_GET_DATA('id');
	} // END - if

	// Free result
	SQL_FREERESULT($result);

	// Return result
	//* DEBUG: */ echo "nextId={$nextId}<br />\n";
	return $nextId;
}
// ----------------------------------------------------------------------------
// PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE ELSE THEY "WRAP" THE
// $SURFBAR_DATA ARRAY!
// ----------------------------------------------------------------------------
// Private getter for data elements
function SURFBAR_GET_DATA ($element) {
	global $SURFBAR_DATA;

	// Default is null
	$data = null;

	// Is the entry there?
	if (isset($SURFBAR_DATA[$element])) {
		// Then take it
		$data = $SURFBAR_DATA[$element];
	} else { // END - if
		print("<pre>");
		print_r($SURFBAR_DATA);
		debug_print_backtrace();
		die("</pre>");
	}

	// Return result
	return $data;
}
// Getter for reward from cache
function SURFBAR_GET_REWARD () {
	// Get data element and return its contents
	return SURFBAR_GET_DATA('reward');
}
// Getter for URL from cache
function SURFBAR_GET_URL () {
	// Get data element and return its contents
	return SURFBAR_GET_DATA('url');
}
// Getter for user reload locks
function SURFBAR_GET_USER_RELOAD_LOCK () {
	// Get data element and return its contents
	return SURFBAR_GET_DATA('user_locks');
}
// Getter for reload time
function SURFBAR_GET_RELOAD_TIME () {
	// Get data element and return its contents
	return SURFBAR_GET_DATA('time');
}
//
?>