$limit, 'reload' => $reload));
}
// Admin unlocked an email so we can migrate the URL
function SURFBAR_ADMIN_MIGRATE_URL ($url, $userid) {
// Do some pre-checks
if (!isAdmin()) {
// Not an admin
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Not admin, url=' . $url . ',userid=' . $userid);
return false;
} elseif (!isUrlValid($url)) {
// URL invalid
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Invalid URL, url=' . $url . ',userid=' . $userid);
return false;
} elseif (SURFBAR_LOOKUP_BY_URL($url, $userid)) {
// URL already found in surfbar!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Already added, url=' . $url . ',userid=' . $userid);
return false;
} elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS($userid)) {
// No more allowed!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot migrate URL: Maximum exceeded, url=' . $url . ',userid=' . $userid);
return false;
}
// Register the new URL
return SURFBAR_REGISTER_URL($url, $userid, 'MIGRATED', 'migrate');
}
// Admin function for unlocking URLs
function SURFBAR_ADMIN_UNLOCK_URL_IDS ($IDs) {
// Is this an admin or invalid array?
if (!isAdmin()) {
// Not admin or invalid ids array
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not admin');
return false;
} elseif (!is_array($IDs)) {
// No array
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs type ' . gettype($IDs) . '!=array');
return false;
} elseif (count($IDs) == 0) {
// Empty array
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs is empty');
return false;
}
// Set to true to make AND expression valid if first URL got unlocked
$done = true;
// Update the status for all ids
foreach ($IDs as $id => $dummy) {
// Test all ids through (ignores failed)
$done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'ACTIVE')));
} // END - if
// Return total status
return $done;
}
// Admin function for rejecting URLs
function SURFBAR_ADMIN_REJECT_URL_IDS ($IDs) {
// Is this an admin or invalid array?
if (!isAdmin()) {
// Not admin or invalid ids array
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not admin');
return false;
} elseif (!is_array($IDs)) {
// No array
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs type ' . gettype($IDs) . '!=array');
return false;
} elseif (count($IDs) == 0) {
// Empty array
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: IDs is empty');
return false;
}
// Set to true to make AND expression valid if first URL got unlocked
$done = true;
// Update the status for all ids
foreach ($IDs as $id => $dummy) {
// Test all ids through (ignores failed)
$done = (($done) && (SURFBAR_CHANGE_STATUS($id, 'PENDING', 'REJECTED')));
} // END - if
// Return total status
return $done;
}
//
//------------------------------------------------------------------------------
// Member functions
//------------------------------------------------------------------------------
//
// Member has added an URL
function SURFBAR_MEMBER_ADD_URL ($url, $limit) {
// Do some pre-checks
if (!isMember()) {
// Not a member
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not member');
return false;
} elseif ((!isUrlValid($url)) && (!isAdmin())) {
// URL invalid
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Invalid, url=' . $url . ',limit=' . $limit);
return false;
} elseif (SURFBAR_LOOKUP_BY_URL($url, getMemberId())) {
// URL already found in surfbar!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Already found, url=' . $url . ',limit=' . $limit);
return false;
} elseif (!SURFBAR_IF_USER_BOOK_MORE_URLS(getMemberId())) {
// No more allowed!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Maximum exceeded, url=' . $url . ',limit=' . $limit);
return false;
} elseif (''.($limit + 0).'' != ''.$limit.'') {
// Invalid amount entered
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Invalid limit, url=' . $url . ',limit=' . $limit);
return false;
}
// Register the new URL
return SURFBAR_REGISTER_URL($url, getMemberId(), 'PENDING', 'reg', array('limit' => $limit));
}
// Create list of actions depending on status for the user
function SURFBAR_MEMBER_ACTIONS ($urlId, $status) {
// Load all actions in an array for given status
$actionArray = SURFBAR_GET_ARRAY_FROM_STATUS($status);
// Init HTML code
$OUT = '
';
// Calculate width
$width = round(100 / count($actionArray));
// "Walk" through all actions and create forms
foreach ($actionArray as $actionId => $action) {
// Add form for this action
$OUT .= loadTemplate('member_list_surfbar_form', true, array(
'width' => $width,
'url_id' => bigintval($urlId),
'action' => strtolower($action)
));
} // END - foreach
// Close table
$OUT .= '
';
// Return code
return $OUT;
}
// Do the member form request
function SURFBAR_MEMBER_DO_FORM ($formData, $urlArray) {
// By default no action is performed
$performed = false;
// Is this a member?
if (!isMember()) {
// No member!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Not member');
return false;
} elseif ((!isset($formData['id'])) || (!isset($formData['action']))) {
// Important form elements are missing!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Invalid form data, required field id/action not found');
return false;
} elseif (!isset($urlArray[$formData['id']])) {
// Id not found in cache
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Field id not found in cache');
return false;
} elseif (!SURFBAR_VALIDATE_MEMBER_ACTION_STATUS($formData['action'], $urlArray[$formData['id']]['url_status'])) {
// Action not allowed for current URL status
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Cannot add URL: Action not allowed to perform. action=' . $formData['action'] . ',url_status=' . $urlArray[$formData['id']]['url_status'] . 'id=' . $formData['id']);
return false;
}
// Secure action
$action = secureString($formData['action']);
// Has it changed?
if ($action != $formData['action']) {
// Invalid data in action found
return false;
} // END - if
// Create the function name for selected action
$functionName = sprintf("SURFBAR_MEMBER_%s_ACTION", strtoupper($action));
// Is the function there?
if (function_exists($functionName)) {
// Add new status
$urlArray[$formData['id']]['new_status'] = SURFBAR_GET_NEW_STATUS('new_status');
// Extract URL data for call-back
$urlData = array(merge_array($urlArray[$formData['id']], array($action => $formData)));
// Action found so execute it
$performed = call_user_func_array($functionName, $urlData);
} else {
// Log invalid request
debug_report_bug(__FUNCTION__, __LINE__, 'Invalid member action! action=' . $formData['action'] . ',id=' . $formData['id'] . ',function=' . $functionName);
}
// Return status
return $performed;
}
// Validate if the requested action can be performed on current URL status
function SURFBAR_VALIDATE_MEMBER_ACTION_STATUS ($action, $status) {
// Search for the requested action/status combination in database
$result = SQL_QUERY_ESC("SELECT `actions_new_status` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_action`='%s' AND `actions_status`='%s' LIMIT 1",
array($action, $status), __FUNCTION__, __LINE__);
// Is the entry there?
$isValid = (SQL_NUMROWS($result) == 1);
// Fetch the new status if found
if ($isValid) {
// Load new status
list($GLOBALS['surfbar_cache']['new_status']) = SQL_FETCHROW($result);
} // END - if
// Free result
SQL_FREERESULT($result);
// Return status
return $isValid;
}
//
//------------------------------------------------------------------------------
// Member actions
//------------------------------------------------------------------------------
//
// Retreat a booked URL
function SURFBAR_MEMBER_RETREAT_ACTION ($urlData) {
// Create the data array for next function call
$data = array(
$urlData['id'] => $urlData
);
// Simply change the status here
return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
}
// Book an URL now (from migration)
function SURFBAR_MEMBER_BOOKNOW_ACTION ($urlData) {
// Create the data array for next function call
$data = array(
$urlData['id'] => $urlData
);
// Simply change the status here
return SURFBAR_CHANGE_STATUS ($urlData['id'], $urlData['url_status'], $urlData['new_status'], $data);
}
// Show edit form or do the changes
function SURFBAR_MEMBER_EDIT_ACTION ($urlData) {
// Is the "execute" flag there?
if (isset($urlData['edit']['execute'])) {
// Execute the changes
return SURFBAR_MEMBER_EXECUTE_ACTION('edit', $urlData);
} // END - if
// Display form
return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('edit', $urlData);
}
// Show delete form or do the changes
function SURFBAR_MEMBER_DELETE_ACTION ($urlData) {
// Is the "execute" flag there?
if (isset($urlData['delete']['execute'])) {
// Execute the changes
return SURFBAR_MEMBER_EXECUTE_ACTION('delete', $urlData);
} // END - if
// Display form
return SURFBAR_MEMBER_DISPLAY_ACTION_FORM('delete', $urlData);
}
// Pause active banner
function SURFBAR_MEMBER_PAUSE_ACTION ($urlData) {
return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
}
// Unpause stopped banner
function SURFBAR_MEMBER_UNPAUSE_ACTION ($urlData) {
// Fix missing entry for template
$urlData['edit'] = $urlData['unpause'];
$urlData['edit']['url'] = $urlData['url'];
$urlData['edit']['limit'] = SURFBAR_GET_VIEWS_MAX();
// Return status change
return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
}
// Resubmit locked URL
function SURFBAR_MEMBER_RESUBMIT_ACTION ($urlData) {
return SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
}
// Display selected "action form"
function SURFBAR_MEMBER_DISPLAY_ACTION_FORM ($action, $urlData) {
// Translate some data if present
$content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
// Include fields only for action 'edit'
if ($action == 'edit') {
// Default is not limited
$urlData['limited_yes'] = '';
$urlData['limited_no'] = ' checked="checked"';
$urlData['limited'] = 'false';
// Is this URL limited?
if (SURFBAR_GET_VIEWS_MAX() > 0) {
// Then rewrite form data
$urlData['limited_yes'] = ' checked="checked"';
$urlData['limited_no'] = '';
$urlData['limited'] = 'true';
} // END - if
} // END - if
// Load the form and display it
loadTemplate(sprintf("member_surfbar_%s_action_form", $action), false, $urlData);
// All fine by default ... ;-)
return true;
}
// Execute choosen action
function SURFBAR_MEMBER_EXECUTE_ACTION ($action, $urlData) {
// By default nothing is executed
$executed = false;
// Is limitation "no" and "limit" is > 0?
if ((isset($urlData[$action]['limited'])) && ($urlData[$action]['limited'] != 'Y') && ((isset($urlData[$action]['limit'])) && ($urlData[$action]['limit'] > 0)) || (!isset($urlData[$action]['limit']))) {
// Set it to unlimited
$urlData[$action]['limit'] = '0';
} // END - if
// Construct function name
$functionName = sprintf("SURFBAR_MEMBER_EXECUTE_%s_ACTION", strtoupper($action));
// Is that function there?
if (function_exists($functionName)) {
// Execute the function
if (call_user_func_array($functionName, array($urlData)) == true) {
// Update status as well
$executed = SURFBAR_CHANGE_STATUS($urlData['id'], $urlData['url_status'], $urlData['new_status'], array($urlData['id'] => $urlData));
} // END - if
} else {
// Not found
debug_report_bug(__FUNCTION__, __LINE__, 'Callback function ' . $functionName . ' not found.');
}
// Return status
return $executed;
}
// "Execute edit" function: Update changed data
function SURFBAR_MEMBER_EXECUTE_EDIT_ACTION ($urlData) {
// Default is nothing done
$status = false;
// Has the URL or limit changed?
if (true) {
//if (($urlData['url_views_allowed'] != $urlData['edit']['limit']) || ($url1 != $url2)) {
// Run the query
SQL_QUERY_ESC("UPDATE
`{?_MYSQL_PREFIX?}_surfbar_urls`
SET
`url`='%s',
`url_views_allowed`=%s,
`url_views_max`=%s
WHERE
`url_id`=%s AND
`status`='%s'
LIMIT 1",
array(
$urlData['url'],
$urlData['edit']['limit'],
$urlData['edit']['limit'],
$urlData['id'],
$urlData['url_status']
), __FUNCTION__, __LINE__);
// All fine
$status = true;
} // END - if
// Return status
return $status;
}
// "Execute delete" function: Does nothing...
function SURFBAR_MEMBER_EXECUTE_DELETE_ACTION ($urlData) {
// Nothing special to do (see above function for such "special actions" to perform)
return true;
}
//
//------------------------------------------------------------------------------
// Self-maintenance functions
//------------------------------------------------------------------------------
//
// Main function
function SURFBAR_HANDLE_SELF_MAINTENANCE () {
// Handle URLs which limit has depleted so we can stop them
SURFBAR_HANDLE_DEPLETED_VIEWS();
// Handle low-points amounts
SURFBAR_HANDLE_LOW_POINTS();
}
// Handle URLs which limit has depleted
function SURFBAR_HANDLE_DEPLETED_VIEWS () {
// Get all URLs
$urlArray = SURFBAR_GET_URL_DATA(0, 'url_views_max', 'url_id', 'ASC', 'url_id', " AND `url_views_allowed` > 0 AND `url_status`='ACTIVE'");
// Do we have some entries?
if (count($urlArray) > 0) {
// Then handle all!
foreach ($urlArray as $id => $urlData) {
// Backup data
$data = $urlData;
// Rewrite array for next call
$urlData = array(
$id => $data
);
// Handle the status
SURFBAR_CHANGE_STATUS($id, 'ACTIVE', 'DEPLETED', $urlData);
} // END - foreach
} // END - if
}
// Alert users which have URLs booked and are low on points amount
function SURFBAR_HANDLE_LOW_POINTS () {
// Get all userids
$userids = SURFBAR_DETERMINE_DEPLETED_USERIDS(getConfig('surfbar_warn_low_points'));
// "Walk" through all URLs
foreach ($userids['url_userid'] as $userid => $dummy) {
// Is the last notification far enougth away to notify again?
if ((time() - $userids['notified'][$userid]) >= getConfig('surfbar_low_interval')) {
// Prepare content
$content = array(
'url_userid' => $userid,
'points' => $userids['points'][$userid],
'notified' => $userids['notified'][$userid]
);
// Notify this user
SURFBAR_NOTIFY_USER('low_points', $content);
// Update last notified
SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_user_data` SET `surfbar_low_notified`=NOW() WHERE `userid`=%s LIMIT 1",
array($userid), __FUNCTION__, __LINE__);
} // END - if
} // END - foreach
}
//
//------------------------------------------------------------------------------
// Generic functions
//------------------------------------------------------------------------------
//
// Looks up by an URL
function SURFBAR_LOOKUP_BY_URL ($url, $userid) {
// Now lookup that given URL by itself
$urlArray = SURFBAR_GET_URL_DATA($url, 'url', 'url_id', 'ASC', 'url_id', sprintf(" AND `url_userid`=%s", bigintval($userid)));
// Was it found?
return (count($urlArray) > 0);
}
// Load URL data by given search term and column
function SURFBAR_GET_URL_DATA ($searchTerm, $column = 'url_id', $order = 'url_id', $sort = 'ASC', $group = 'url_id', $add = '') {
// By default nothing is found
$GLOBALS['last_url_data'] = array();
// Is the column an id number?
if (($column == 'url_id') || ($column == 'url_userid')) {
// Extra secure input
$searchTerm = bigintval($searchTerm);
} // END - if
// If the column is 'id' there can be only one entry
$limit = '';
if ($column == 'id') {
$limit = "LIMIT 1";
} // END - if
// Look up the record
$result = SQL_QUERY_ESC("SELECT
`url_id`,
`url_userid`,
`url`,
`url_views_total`,
`url_views_max`,
`url_views_allowed`,
`url_status`,
UNIX_TIMESTAMP(`url_registered`) AS `url_registered`,
UNIX_TIMESTAMP(`url_last_locked`) AS `url_last_locked`,
`url_lock_reason`,
`url_views_max`,
`url_views_allowed`,
`url_fixed_reload`
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls`
WHERE
`%s`='%s'" . $add . "
ORDER BY
`%s` %s
%s",
array(
$column,
$searchTerm,
$order,
$sort,
$limit
), __FUNCTION__, __LINE__);
// Is there at least one record?
if (!SQL_HASZERONUMS($result)) {
// Then load all!
while ($dataRow = SQL_FETCHARRAY($result)) {
// Shall we group these results?
if ($group == 'url_id') {
// Add the row by id as index
$GLOBALS['last_url_data'][$dataRow['url_id']] = $dataRow;
} else {
// Group entries
$GLOBALS['last_url_data'][$dataRow[$group]][$dataRow['url_id']] = $dataRow;
}
} // END - while
} // END - if
// Free the result
SQL_FREERESULT($result);
// Return the result
return $GLOBALS['last_url_data'];
}
// Registers an URL with the surfbar. You should have called SURFBAR_LOOKUP_BY_URL() first!
function SURFBAR_REGISTER_URL ($url, $userid, $status = 'PENDING', $addMode = 'reg', $extraFields = array()) {
// Make sure by the user registered URLs are always pending
if ($addMode == 'reg') {
$status = 'PENDING';
} // END - if
// Prepare content
$content = merge_array($extraFields, array(
'url' => $url,
'url_userid' => $userid,
'url_status' => $status,
));
// Is limit/reload set?
if (!isset($content['limit'])) {
$content['limit'] = '0';
} // END - if
if (!isset($content['reload'])) {
$content['reload'] = '0';
} // END - if
// Insert the URL into database
$content['insert_id'] = SURFBAR_INSERT_URL_BY_ARRAY($content);
// Is this id valid?
if ($content['insert_id'] == '0') {
// INSERT did not insert any data!
return false;
} // END - if
// If in reg-mode we notify admin
if (($addMode == 'reg') || (getConfig('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) {
// Get userid
$userid = bigintval($urlData['url_userid']);
// Is the id set?
if (empty($userid)) {
$userid = 'NULL';
} // END - if
// Just run the insert query for now
SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_urls` (`url_userid`,`url`,`url_status`,`url_views_max`,`url_views_allowed`,`url_fixed_reload`) VALUES (%s,'%s','%s',%s,%s,%s)",
array(
$userid,
$urlData['url'],
$urlData['url_status'],
$urlData['limit'],
$urlData['limit'],
$urlData['reload']
), __FUNCTION__, __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
$subject = sprintf("{--ADMIN_SURFBAR_NOTIFY_%s_SUBJECT--}",
strtoupper($messageType)
);
// Is the subject line there?
if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
// Set default subject if following eval() wents wrong
$subject = '{%message,ADMIN_SURFBAR_NOTIFY_DEFAULT_SUBJECT=' . strtoupper($messageType) . '%}';
} // END - if
// Translate some data if present
$content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
// Send the notification out
return sendAdminNotification($subject, $templateName, $content, $content['url_userid']);
}
// Notify the user about the performed action
function SURFBAR_NOTIFY_USER ($messageType, $content) {
// Skip notification if userid is zero
if ($content['url_userid'] == '0') {
return false;
} // END - if
// Prepare template name
$templateName = sprintf("member_surfbar_%s", $messageType);
// Prepare subject
$subject = sprintf("{--MEMBER_SURFBAR_NOTIFY_%s_SUBJECT--}",
strtoupper($messageType)
);
// Is the subject line there?
if ((substr($subject, 0, 1) == '!') && (substr($subject, -1, 1) == '!')) {
// Set default subject if following eval() wents wrong
$subject = '{--MEMBER_SURFBAR_NOTIFY_DEFAULT_SUBJECT--}';
} // END - if
// Translate some data if present
$content = SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE($content);
// Load template
$mailText = loadEmailTemplate($templateName, $content, $content['url_userid']);
// Send the email
return sendEmail($content['url_userid'], $subject, $mailText);
}
// Translates some data for template usage
// @TODO Can't we use our new expression language instead of this ugly code?
function SURFBAR_PREPARE_CONTENT_FOR_TEMPLATE ($content) {
// Prepare some code
if (isset($content['url_registered'])) $content['url_registered'] = generateDateTime($content['url_registered'], 2);
if (isset($content['url_last_locked'])) $content['url_last_locked'] = generateDateTime($content['url_last_locked'], 2);
// Return translated content
return $content;
}
// Translates the limit
function translateSurfbarLimit ($limit) {
// Is this zero?
if ($limit == '0') {
// Unlimited!
$return = '{--MEMBER_SURFBAR_UNLIMITED_VIEWS--}';
} else {
// Translate comma
$return = '{%pipe,translateComma=' . $limit . '%}';
}
// Return value
return $return;
}
// Translate the URL status
function translateSurfbarUrlStatus ($status) {
// NULL must be handled carfefully
if ((is_null($status)) || (trim($status) == '')) {
// Is NULL, so return other language string
return '{--SURFBAR_URL_STATUS_NONE--}';
} else {
// Return regular result
return sprintf("{--SURFBAR_URL_STATUS_%s--}", strtoupper($status));
}
}
// Translates the given action into a link title for members
function translateMemberSurfbarActionToTitle ($action) {
// Do we have cache?
if (!isset($GLOBALS[__FUNCTION__][$action])) {
// Construct default return string (unknown
$GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_TITLE=' . $action . '%}';
// ... and the id's name
$messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_TITLE';
// Is the id there?
if (isMessageIdValid($messageId)) {
// Then use it
$GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
} // END - if
} // END - if
// Return cache
return $GLOBALS[__FUNCTION__][$action];
}
// Translates the given action into a submit button for members
function translateMemberSurfbarActionToSubmit ($action) {
// Do we have cache?
if (!isset($GLOBALS[__FUNCTION__][$action])) {
// Construct default return string (unknown
$GLOBALS[__FUNCTION__][$action] = '{%message,MEMBER_SURFBAR_ACTION_UNKNOWN_SUBMIT=' . $action . '%}';
// ... and the id's name
$messageId = 'MEMBER_SURFBAR_ACTION_' . strtoupper($action) . '_SUBMIT';
// Is the id there?
if (isMessageIdValid($messageId)) {
// Then use it
$GLOBALS[__FUNCTION__][$action] = '{--' . $messageId . '--}';
} // END - if
} // END - if
// Return cache
return $GLOBALS[__FUNCTION__][$action];
}
// Determine reward
function SURFBAR_DETERMINE_REWARD ($onlyMin = false) {
// Static values are default
$reward = getConfig('surfbar_static_reward');
// Do we have static or dynamic?
if (getSurfbarPaymentModel() == 'DYNAMIC') {
// "Calculate" dynamic reward
if ($onlyMin === true) {
$reward += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
} else {
$reward += SURFBAR_CALCULATE_DYNAMIC_ADD();
}
} // END - if
// Return reward
return $reward;
}
// Determine costs
function SURFBAR_DETERMINE_COSTS ($onlyMin=false) {
// Static costs is default
$costs = getConfig('surfbar_static_costs');
// Do we have static or dynamic?
if (getSurfbarPaymentModel() == 'DYNAMIC') {
// "Calculate" dynamic costs
if ($onlyMin) {
$costs += SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
} else {
$costs += SURFBAR_CALCULATE_DYNAMIC_ADD();
}
} // END - if
// Return costs
return $costs;
}
// "Calculate" dynamic add
function SURFBAR_CALCULATE_DYNAMIC_ADD () {
// Get min/max values
$min = SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE();
$max = SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE();
// "Calculate" dynamic part and return it
return mt_rand($min, $max);
}
// Determine right template name
function SURFBAR_DETERMINE_TEMPLATE_NAME() {
// Default is the frameset
$templateName = 'surfbar_frameset';
// Any frame set? ;-)
if (isGetRequestElementSet('frame')) {
// Use the frame as a template name part... ;-)
$templateName = sprintf("surfbar_frame_%s",
getRequestElement('frame')
);
} // END - if
// Return result
return $templateName;
}
// Check if the "reload lock" of the current user is full, call this function
// before you call SURFBAR_CHECK_RELOAD_LOCK().
function SURFBAR_CHECK_RELOAD_FULL () {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Fixed surf lock is ' . getConfig('surfbar_static_lock') . ' - ENTERED!');
// Default is full!
$isFull = true;
// Cache static reload lock
$GLOBALS['surfbar_cache']['surf_lock'] = getConfig('surfbar_static_lock');
// Do we have dynamic model?
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'surf_lock=' . $GLOBALS['surfbar_cache']['surf_lock'] . ' - BEFORE');
if (getSurfbarPaymentModel() == 'DYNAMIC') {
// "Calculate" dynamic lock
$GLOBALS['surfbar_cache']['surf_lock'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
} // END - if
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'surf_lock=' . $GLOBALS['surfbar_cache']['surf_lock'] . ' - AFTER');
// Ask the database
$result = SQL_QUERY_ESC("SELECT
COUNT(l.`locks_id`) AS `cnt`
FROM
`{?_MYSQL_PREFIX?}_surfbar_locks` AS l
INNER JOIN
`{?_MYSQL_PREFIX?}_surfbar_urls` AS u
ON
u.`url_id`=l.`locks_url_id`
WHERE
l.`locks_userid`=%s AND
(UNIX_TIMESTAMP() - {%%pipe,SURFBAR_GET_SURF_LOCK%%}) < UNIX_TIMESTAMP(l.`locks_last_surfed`) AND
(
((UNIX_TIMESTAMP(l.`locks_last_surfed`) - u.`url_fixed_reload`) < 0 AND u.`url_fixed_reload` > 0) OR
u.`url_fixed_reload` = 0
)
LIMIT 1",
array(getMemberId()), __FUNCTION__, __LINE__
);
// Fetch row
list($GLOBALS['surfbar_cache']['user_locks']) = SQL_FETCHROW($result);
// Is it null?
if (is_null($GLOBALS['surfbar_cache']['user_locks'])) {
// Then fix it to zero!
$GLOBALS['surfbar_cache']['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_GET_USER_LOCKS() == $total) && ($total > 0));
// Return result
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userLocks=' . SURFBAR_GET_USER_LOCKS() . ',total=' . $total . 'isFull=' . intval($isFull) . ' - EXIT!');
return $isFull;
}
// Get total amount of URLs of given status for current user or of ACTIVE URLs by default
function SURFBAR_GET_TOTAL_URLS ($status = 'ACTIVE', $excludeUserId = NULL) {
// Determine depleted user account
$userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
// If we dont get any user ids back, there are no URLs
if (count($userids['url_userid']) == 0) {
// No user ids found, no URLs!
return 0;
} // END - if
// Is the exlude userid set?
if (isValidUserId($excludeUserId)) {
// Then add it
$userids['url_userid'][$excludeUserId] = $excludeUserId;
} // END - if
// Get amount from database
$result = SQL_QUERY_ESC("SELECT
COUNT(`url_id`) AS cnt
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls`
WHERE
`url_userid` NOT IN (".implode(', ', $userids['url_userid']).") AND
`url_status`='%s'
LIMIT 1",
array($status), __FUNCTION__, __LINE__
);
// Fetch row
list($count) = SQL_FETCHROW($result);
// Free result
SQL_FREERESULT($result);
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'cnt=' . $count);
// Return result
return $count;
}
// Check wether the user is allowed to book more URLs
function SURFBAR_IF_USER_BOOK_MORE_URLS ($userid = NULL) {
// Is this admin and userid is zero or does the user has some URLs left to book?
return (((is_null($userid)) && (isAdmin())) || (SURFBAR_GET_TOTAL_USER_URLS($userid, '', array('REJECTED')) < getSurfbarMaxOrder()));
}
// Get total amount of URLs of given status for current user
function SURFBAR_GET_TOTAL_USER_URLS ($userid = NULL, $status = '', $exclude = '') {
// Is the user 0 and user is logged in?
if ((is_null($userid)) && (isMember())) {
// Then use this userid
$userid = getMemberId();
} elseif (is_null($userid)) {
// Error!
return (getSurfbarMaxOrder() + 1);
}
// Default is all URLs
$add = '';
// Is the status set?
if (is_array($status)) {
// Only URLs with these status
$add = sprintf(" WHERE `url_status` IN('%s')", implode("','", $status));
} elseif (!empty($status)) {
// Only URLs with this status
$add = sprintf(" WHERE `url_status`='%s'", $status);
} elseif (is_array($exclude)) {
// Exclude URLs with these status
$add = sprintf(" WHERE `url_status` NOT IN('%s')", implode("','", $exclude));
} elseif (!empty($exclude)) {
// Exclude URLs with this status
$add = sprintf(" WHERE `url_status` != '%s'", $exclude);
}
// Get amount from database
$count = countSumTotalData($userid, 'surfbar_urls', 'url_id', 'url_userid', true, $add);
// Return result
return $count;
}
// Generate a validation code for the given id number
function SURFBAR_GENERATE_VALIDATION_CODE ($urlId, $salt = '') {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',salt=' . $salt . ' - ENTERED!');
// Init hash with invalid value
if (empty($salt)) {
// Generate random hashed string
$GLOBALS['surfbar_cache']['salt'] = sha1(generatePassword(mt_rand(200, 255)));
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'newSalt='.SURFBAR_GET_SALT().'', false);
} else {
// Use this as salt!
$GLOBALS['surfbar_cache']['salt'] = $salt;
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'oldSalt='.SURFBAR_GET_SALT().'', false);
}
// Hash it with md5() and salt it with the random string
$hashedCode = generateHash(md5($urlId . getEncryptSeparator() . getMemberId()), SURFBAR_GET_SALT());
// Finally encrypt it PGP-like and return it
$valHashedCode = encodeHashForCookie($hashedCode);
// Return hashed value
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',salt=' . $salt . ',urlId=' . $urlId . ',salt=' . $salt . ',valHashedCode=' . $valHashedCode . ' - EXIT!');
return $valHashedCode;
}
// Check validation code
function SURFBAR_CHECK_VALIDATION_CODE ($urlId, $check, $salt) {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',check=' . $check . ',salt=' . $salt . ' - ENTERED!');
// Secure id number
$urlId = bigintval($urlId);
// Now generate the code again
$code = SURFBAR_GENERATE_VALIDATION_CODE($urlId, $salt);
// Return result of checking hashes and salts
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',(code==check)=' . intval($code == $check) . ',(salt==salts_last_salt)=' . intval($salt == SURFBAR_GET_DATA('salts_last_salt')) . ' - EXIT!');
return (($code == $check) && ($salt == SURFBAR_GET_DATA('salts_last_salt')));
}
// Lockdown the userid/id combination (reload lock)
function SURFBAR_LOCKDOWN_ID ($urlId) {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',getMemberId()=' . getMemberId() . ' - ENTERED!');
// Search for an entry
$countLock = countSumTotalData(getMemberId(), 'surfbar_locks', 'locks_id', 'locks_userid', true, ' AND `locks_url_id`=' . bigintval($urlId));
// Do we have no record?
if ($countLock == 0) {
// Just add it to the database
SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_locks` (`locks_userid`,`locks_url_id`) VALUES (%s, %s)',
array(
getMemberId(),
bigintval($urlId)
), __FUNCTION__, __LINE__);
} // END - if
// Remove the salt from database
SQL_QUERY_ESC('DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_surfbar_salts` WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1',
array(
bigintval($urlId),
getMemberId()
), __FUNCTION__, __LINE__);
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',getMemberId()=' . getMemberId() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - EXIT!');
}
// Pay points to the user and remove it from the sender if userid is given else it is a "sponsored surf"
function SURFBAR_PAY_POINTS () {
// Remove it from the URL owner
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS() . ' - ENTERED!');
if (isValidUserId(SURFBAR_GET_USERID())) {
// Subtract points and ignore return status
subtractPoints(sprintf("surfbar_%s", getSurfbarPaymentModel()), SURFBAR_GET_USERID(), SURFBAR_GET_COSTS());
} // END - if
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.getMemberId().',reward='.SURFBAR_GET_REWARD());
// Init referral system here
initReferralSystem();
// Book it to the user and ignore return status
addPointsThroughReferralSystem(sprintf("surfbar:%s", getSurfbarPaymentModel()), getMemberId(), SURFBAR_GET_REWARD());
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid='.SURFBAR_GET_USERID().',costs='.SURFBAR_GET_COSTS() . ' - EXIT!');
}
// Updates the statistics of current URL/userid
function SURFBAR_UPDATE_INSERT_STATS_RECORD () {
// Init add
$add = '';
// Get allowed views
$allowed = SURFBAR_GET_VIEWS_ALLOWED();
// Do we have a limit?
if ($allowed > 0) {
// Then count views_max down!
$add .= ',`url_views_max`=`url_views_max`-1';
} // END - if
// Update URL stats
SQL_QUERY_ESC('UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_views_total`=`url_views_total`+1' . $add . ' WHERE `url_id`=%s LIMIT 1',
array(SURFBAR_GET_ID()), __FUNCTION__, __LINE__);
// Update the stats entry
SQL_QUERY_ESC('UPDATE `{?_MYSQL_PREFIX?}_surfbar_stats` SET `stats_count`=`stats_count`+1 WHERE `stats_userid`=%s AND `stats_url_id`=%s LIMIT 1',
array(
getMemberId(),
SURFBAR_GET_ID()
), __FUNCTION__, __LINE__);
// Was that update okay?
if (SQL_HASZEROAFFECTED()) {
// No, then insert entry
SQL_QUERY_ESC('INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_stats` (`stats_userid`,`stats_url_id`,`stats_count`) VALUES (%s,%s,1)',
array(
getMemberId(),
SURFBAR_GET_ID()
), __FUNCTION__, __LINE__);
} // END - if
// Update total/daily/weekly/monthly counter
incrementConfigEntry('surfbar_total_counter');
incrementConfigEntry('surfbar_daily_counter');
incrementConfigEntry('surfbar_weekly_counter');
incrementConfigEntry('surfbar_monthly_counter');
// Update config as well
updateConfiguration(array('surfbar_total_counter', 'surfbar_daily_counter', 'surfbar_weekly_counter', 'surfbar_monthly_counter'), array(1,1,1,1), '+');
}
// Update the salt for validation and statistics
function SURFBAR_UPDATE_SALT_STATS () {
// Update salt
SURFBAR_GENERATE_VALIDATION_CODE(SURFBAR_GET_ID());
// Make sure only valid salts can pass
if (SURFBAR_GET_SALT() == 'INVALID') {
// Invalid provided
debug_report_bug(__FUNCTION__, __LINE__, 'Invalid salt provided, id=' . SURFBAR_GET_ID() . ',getMemberId()=' . getMemberId());
} // END - if
// Update statistics record
SURFBAR_UPDATE_INSERT_STATS_RECORD();
// Simply store the salt from cache away in database...
SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_salts` SET `salts_last_salt`='%s' WHERE `salts_url_id`=%s AND `salts_userid`=%s LIMIT 1",
array(
SURFBAR_GET_SALT(),
SURFBAR_GET_ID(),
getMemberId()
), __FUNCTION__, __LINE__);
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt=' . SURFBAR_GET_SALT() . ',id=' . SURFBAR_GET_ID() . ',userid=' . getMemberId() . ',SQL_AFFECTEDROWS()=' . SQL_AFFECTEDROWS() . ' - UPDATE!');
// Was that okay?
if (SQL_HASZEROAFFECTED()) {
// Insert missing entry!
SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_surfbar_salts` (`salts_url_id`,`salts_userid`,`salts_last_salt`) VALUES (%s, %s, '%s')",
array(
SURFBAR_GET_ID(),
getMemberId(),
SURFBAR_GET_SALT()
), __FUNCTION__, __LINE__);
} // END - if
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'affectedRows=' . SQL_AFFECTEDROWS() . ' - EXIT!');
// Return if the update was okay
return (!SQL_HASZEROAFFECTED());
}
// Check if the reload lock is active for given id
function SURFBAR_CHECK_RELOAD_LOCK ($urlId) {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $urlId . ' - ENTERED!');
// Ask the database
$result = SQL_QUERY_ESC("SELECT COUNT(`locks_id`) AS cnt
FROM
`{?_MYSQL_PREFIX?}_surfbar_locks`
WHERE
`locks_userid`=%s AND
`locks_url_id`=%s AND
(UNIX_TIMESTAMP() - ".SURFBAR_GET_SURF_LOCK().") < UNIX_TIMESTAMP(`locks_last_surfed`)
ORDER BY
`locks_last_surfed` ASC
LIMIT 1",
array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
);
// Fetch counter
list($count) = SQL_FETCHROW($result);
// Free result
SQL_FREERESULT($result);
// Return check
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',count=' . $count . ',SURFBAR_GET_SURF_LOCK()=' . SURFBAR_GET_SURF_LOCK() . ' - EXIT!');
return ($count == 1);
}
// Determine which user hash no more points left
function SURFBAR_DETERMINE_DEPLETED_USERIDS ($limit=0) {
// Init array
$userids = array(
'url_userid' => array(),
'points' => array(),
'notified' => array(),
);
// Do we have a current user id?
if ((isMember()) && ($limit == '0')) {
// Then add this as well
$userids['url_userid'][getMemberId()] = getMemberId();
$userids['points'][getMemberId()] = getTotalPoints(getMemberId());
$userids['notified'][getMemberId()] = '0';
// Get all userid except logged in one
$result = SQL_QUERY_ESC("SELECT
u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls` AS u
INNER JOIN
`{?_MYSQL_PREFIX?}_user_data` AS d
ON
u.`url_userid`=d.`userid`
WHERE
u.`url_userid` NOT IN (%s,0) AND
u.`url_status`='ACTIVE'
GROUP BY
u.`url_userid`
ORDER BY
u.`url_userid` ASC",
array(getMemberId()), __FUNCTION__, __LINE__);
} else {
// Get all userid
$result = SQL_QUERY("SELECT
u.url_userid, UNIX_TIMESTAMP(d.surfbar_low_notified) AS notified
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls` AS u
INNER JOIN
`{?_MYSQL_PREFIX?}_user_data` AS d
ON
u.`url_userid`=d.`userid`
WHERE
u.`url_userid` > 0 AND
u.`url_status`='ACTIVE'
GROUP BY
u.`url_userid`
ORDER BY
u.`url_userid` ASC", __FUNCTION__, __LINE__);
}
// Load all userid
while ($content = SQL_FETCHARRAY($result)) {
// Get total points
$points = getTotalPoints($content['url_userid']);
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $content['url_userid'] . ',points=' . $points);
// Shall we add this to ignore?
if ($points <= $limit) {
// Ignore this one!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $content['url_userid'] . ' has depleted points amount!');
$userids['url_userid'][$content['url_userid']] = $content['url_userid'];
$userids['points'][$content['url_userid']] = $points;
$userids['notified'][$content['url_userid']] = $content['notified'];
} // END - if
} // END - while
// Free result
SQL_FREERESULT($result);
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'UIDs::count=' . count($userids) . ' (with own userid=' . getMemberId() . ')');
// Return result
return $userids;
}
// Determine how many users are Online in surfbar
function SURFBAR_DETERMINE_TOTAL_ONLINE () {
// Count all users in surfbar modue and return the value
$result = SQL_QUERY('SELECT
`stats_id`
FROM
`{?_MYSQL_PREFIX?}_surfbar_stats`
WHERE
(UNIX_TIMESTAMP() - UNIX_TIMESTAMP(`stats_last_surfed`)) <= {?online_timeout?}
GROUP BY
`stats_userid` ASC', __FUNCTION__, __LINE__);
// Fetch count
$count = SQL_NUMROWS($result);
// Free result
SQL_FREERESULT($result);
// Return result
return $count;
}
// Determine waiting time for one URL
function SURFBAR_DETERMINE_WAIT_TIME () {
// Get fixed reload lock
$fixed = SURFBAR_GET_FIXED_RELOAD();
// Is the fixed reload time set?
if ($fixed > 0) {
// Return it
return $fixed;
} // END - if
// Static time is default
$time = getConfig('surfbar_static_time');
// Which payment model do we have?
if (getSurfbarPaymentModel() == 'DYNAMIC') {
// "Calculate" dynamic time
$time += SURFBAR_CALCULATE_DYNAMIC_ADD();
} // END - if
// Return value
return $time;
}
// Changes the status of an URL from given to other
function SURFBAR_CHANGE_STATUS ($urlId, $prevStatus, $newStatus, $data = array()) {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - ENTERED!');
// Make new status always lower-case
$newStatus = strtolower($newStatus);
// Get URL data for status comparison if missing
if ((!is_array($data)) || (count($data) == 0)) {
// Fetch missing URL data
$data = SURFBAR_GET_URL_DATA($urlId);
} // END - if
// Prepare array
$filterData = array(
'url_id' => $urlId,
'prev_status' => $prevStatus,
'new_status' => $newStatus,
'data' => $data,
'abort' => null
);
// Run pre filter chain
$filterData = runFilterChain('pre_change_surfbar_url_status', $filterData);
// Abort here?
if (!is_null($filterData['abort'])) {
// Abort here
return $filterData['abort'];
}
// Update the status now
// ---------- Comment out for debugging/developing member actions! ---------
SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_surfbar_urls` SET `url_status`='%s' WHERE `url_id`=%s LIMIT 1",
array(
$newStatus,
bigintval($urlId)
), __FUNCTION__, __LINE__);
// ---------- Comment out for debugging/developing member actions! ---------
// Was that fine?
// ---------- Comment out for debugging/developing member actions! ---------
if (SQL_AFFECTEDROWS() != 1) {
// No, something went wrong
return false;
} // END - if
// ---------- Comment out for debugging/developing member actions! ---------
// Run post filter chain
$filterData = runFilterChain('post_change_surfbar_url_status', $filterData);
// Extract data from it again
$data = $filterData['data'];
// All done!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',prevStatus=' . $prevStatus . ',newStatus=' . $newStatus . ' - EXIT!');
return true;
}
// Calculate minimum value for dynamic payment model
function SURFBAR_CALCULATE_DYNAMIC_MIN_VALUE () {
// Addon is zero by default
$addon = '0';
// Percentage part
$percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
// Get total users
$totalUsers = getTotalConfirmedUser();
// Get online users
$onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
// Calculate addon
$addon += abs(log($onlineUsers / $totalUsers + 1) * $percent * $totalUsers);
// Get total URLs
$totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
// Get user's total URLs
$userUrls = SURFBAR_GET_TOTAL_USER_URLS(0, 'ACTIVE');
// Calculate addon
if ($totalUrls > 0) {
$addon += abs(log($userUrls / $totalUrls + 1) * $percent * $totalUrls);
} else {
$addon += abs(log($userUrls / 1 + 1) * $percent * $totalUrls);
}
// Return addon
return $addon;
}
// Calculate maximum value for dynamic payment model
function SURFBAR_CALCULATE_DYNAMIC_MAX_VALUE () {
// Addon is zero by default
$addon = '0';
// Maximum value
$max = log(2);
// Percentage part
$percent = abs(log(getConfig('surfbar_dynamic_percent') / 100 + 1));
// Get total users
$totalUsers = getTotalConfirmedUser();
// Calculate addon
$addon += abs($max * $percent * $totalUsers);
// Get total URLs
$totalUrls = SURFBAR_GET_TOTAL_URLS('ACTIVE', 0);
// Calculate addon
$addon += abs($max * $percent * $totalUrls);
// Return addon
return $addon;
}
// Calculate dynamic lock
function SURFBAR_CALCULATE_DYNAMIC_LOCK () {
// Default lock is 30 seconds
$addon = 30;
// Get online users
$onlineUsers = SURFBAR_DETERMINE_TOTAL_ONLINE();
// Calculate lock
$addon = abs(log($onlineUsers / $addon + 1));
// Return value
return $addon;
}
// "Getter" for lock ids array
function SURFBAR_GET_LOCK_IDS () {
// Prepare some arrays
$IDs = array();
$USE = array();
$ignored = array();
// Get all id from locks within the timestamp
$result = SQL_QUERY_ESC("SELECT
`locks_id`,
`locks_url_id`,
UNIX_TIMESTAMP(`locks_last_surfed`) AS `last_surfed`
FROM
`{?_MYSQL_PREFIX?}_surfbar_locks`
WHERE
`locks_userid`=%s
ORDER BY
`locks_id` ASC", array(getMemberId()),
__FUNCTION__, __LINE__);
// Load all entries
while ($content = SQL_FETCHARRAY($result)) {
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'next - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',rest='.(time() - $content['last_surfed']).'/'.SURFBAR_GET_SURF_LOCK());
// Skip entries that are too old
if (($content['last_surfed'] > (time() - SURFBAR_GET_SURF_LOCK())) && (!in_array($content['locks_url_id'], $ignored))) {
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'okay - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
// Add only if missing or bigger
if ((!isset($IDs[$content['locks_url_id']])) || ($IDs[$content['locks_url_id']] > $content['last_surfed'])) {
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ADD - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
// Add this id
$IDs[$content['locks_url_id']] = $content['last_surfed'];
$USE[$content['locks_url_id']] = $content['locks_id'];
} // END - if
} else {
// Debug message
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ignore - lid='.$content['locks_id'].',url='.$content['locks_url_id'].',last='.$content['last_surfed']);
// Ignore these old entries!
$ignored[] = $content['locks_url_id'];
unset($IDs[$content['locks_url_id']]);
unset($USE[$content['locks_url_id']]);
}
} // END - while
// Free result
SQL_FREERESULT($result);
// Return array
return $USE;
}
// "Getter" for maximum random number
function SURFBAR_GET_MAX_RANDOM ($userids, $add) {
// Count max availabe entries
$result = SQL_QUERY("SELECT
sbu.url_id AS cnt
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
LEFT JOIN
`{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
ON
sbu.url_id=sbs.salts_url_id
LEFT JOIN
`{?_MYSQL_PREFIX?}_surfbar_locks` AS l
ON
sbu.url_id=l.locks_url_id
WHERE
sbu.url_userid NOT IN (" . implode(',', $userids) . ") AND
(sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0)) AND
sbu.url_status='ACTIVE'
" . $add . "
GROUP BY
sbu.url_id ASC", __FUNCTION__, __LINE__);
// Log last query
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS());
// Fetch max rand
$maxRand = SQL_NUMROWS($result);
// Free result
SQL_FREERESULT($result);
// Return value
return $maxRand;
}
// Load all URLs of the current user and return it as an array
function SURFBAR_GET_USER_URLS () {
// Init array
$urlArray = array();
// Begin the query
$result = SQL_QUERY_ESC("SELECT
u.url_id,
u.url_userid,
u.url,
u.url_status,
u.url_views_total,
u.url_views_max,
u.url_views_allowed,
UNIX_TIMESTAMP(u.url_registered) AS `url_registered`,
UNIX_TIMESTAMP(u.`url_last_locked`) AS `url_last_locked`,
u.`url_lock_reason`
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls` AS u
WHERE
u.`url_userid`=%s AND
u.`url_status` != 'DELETED'
ORDER BY
u.url_id ASC",
array(getMemberId()), __FUNCTION__, __LINE__);
// Are there entries?
if (!SQL_HASZERONUMS($result)) {
// Load all rows
while ($row = SQL_FETCHARRAY($result)) {
// Add the row
$urlArray[$row['url_id']] = $row;
} // END - while
} // END - if
// Free result
SQL_FREERESULT($result);
// Return the array
return $urlArray;
}
// "Getter" for member action array for given status
function SURFBAR_GET_ARRAY_FROM_STATUS ($status) {
// Init array
$returnArray = array();
// Get all assigned actions
$result = SQL_QUERY_ESC("SELECT `actions_action` FROM `{?_MYSQL_PREFIX?}_surfbar_actions` WHERE `actions_status`='%s' ORDER BY `actions_id` ASC",
array($status), __FUNCTION__, __LINE__);
// Some entries there?
if (!SQL_HASZERONUMS($result)) {
// Load all actions
// @TODO This can be somehow rewritten
while ($content = SQL_FETCHARRAY($result)) {
$returnArray[] = $content['actions_action'];
} // END - if
} // END - if
// Free result
SQL_FREERESULT($result);
// Return result
return $returnArray;
}
// Reload to configured stop page
function SURFBAR_RELOAD_TO_STOP_PAGE ($page = 'stop') {
// Internal or external?
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'page=' . $page . ' - ENTERED!');
if ((getConfig('surfbar_pause_mode') == 'INTERNAL') || (getConfig('surfbar_pause_url') == '')) {
// Reload to internal page
redirectToUrl('surfbar.php?frame=' . $page);
} else {
// Reload to external page
redirectToConfiguredUrl('surfbar_pause_url');
}
}
// Determine next id for surfbar or get data for given id, always call this before you call other
// getters below this function!
function SURFBAR_DETERMINE_NEXT_ID ($urlId = NULL) {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ' - ENTERED!');
// Default is no id and no random number
$nextId = '0';
$randNum = '0';
// Is the id set?
if (is_null($urlId)) {
// Get array with lock ids
$USE = SURFBAR_GET_LOCK_IDS();
// Shall we add some URL ids to ignore?
$add = '';
if (count($USE) > 0) {
// Ignore some!
$add = " AND sbu.`url_id` NOT IN (";
foreach ($USE as $url_id => $lid) {
// Add URL id
$add .= $url_id.',';
} // END - foreach
// Add closing bracket
$add = substr($add, 0, -1) . ')';
} // END - if
// Determine depleted user account
$userids = SURFBAR_DETERMINE_DEPLETED_USERIDS();
// Get maximum randomness factor
$maxRand = SURFBAR_GET_MAX_RANDOM($userids['url_userid'], $add);
// If more than one URL can be called generate the random number!
if ($maxRand > 1) {
// Generate random number
$randNum = mt_rand(0, ($maxRand - 1));
} // END - if
// And query the database
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'randNum='.$randNum.',maxRand='.$maxRand.',surfLock='.SURFBAR_GET_SURF_LOCK());
$result = SQL_QUERY_ESC("SELECT
sbu.url_id,
sbu.url_userid,
sbu.url,
sbs.salts_last_salt,
sbu.url_views_total,
sbu.url_views_max,
sbu.url_views_allowed,
UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
sbu.url_fixed_reload
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
LEFT JOIN
`{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
ON
sbu.url_id=sbs.salts_url_id
LEFT JOIN
`{?_MYSQL_PREFIX?}_surfbar_locks` AS l
ON
sbu.url_id=l.locks_url_id
WHERE
sbu.`url_userid` NOT IN (".implode(',', $userids['url_userid']).") AND
sbu.url_status='ACTIVE' AND
(sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
".$add."
GROUP BY
sbu.`url_id`
ORDER BY
l.locks_last_surfed ASC,
sbu.url_id ASC
LIMIT %s,1",
array($randNum), __FUNCTION__, __LINE__
);
} else {
// Get data from specified id number
$result = SQL_QUERY_ESC("SELECT
sbu.url_id,
sbu.url_userid,
sbu.url,
sbs.salts_last_salt,
sbu.url_views_total,
sbu.url_views_max,
sbu.url_views_allowed,
UNIX_TIMESTAMP(l.locks_last_surfed) AS last_surfed,
sbu.url_fixed_reload
FROM
`{?_MYSQL_PREFIX?}_surfbar_urls` AS sbu
LEFT JOIN
`{?_MYSQL_PREFIX?}_surfbar_salts` AS sbs
ON
sbu.url_id=sbs.salts_url_id
LEFT JOIN
`{?_MYSQL_PREFIX?}_surfbar_locks` AS l
ON
sbu.url_id=l.locks_url_id
WHERE
sbu.url_userid != %s AND
sbu.url_status='ACTIVE' AND
sbu.url_id=%s AND
(sbu.url_views_allowed=0 OR (sbu.url_views_allowed > 0 AND sbu.url_views_max > 0))
LIMIT 1",
array(getMemberId(), bigintval($urlId)), __FUNCTION__, __LINE__
);
}
// Is there an id number?
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'lastQuery='.getConfig('db_last_query').'|numRows='.SQL_NUMROWS($result).'|Affected='.SQL_AFFECTEDROWS());
if (SQL_NUMROWS($result) == 1) {
// Load/cache data
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - BEFORE', false);
$GLOBALS['surfbar_cache'] = merge_array($GLOBALS['surfbar_cache'], SQL_FETCHARRAY($result));
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count('.count($GLOBALS['surfbar_cache']).') - AFTER', false);
// Determine waiting time
$GLOBALS['surfbar_cache']['time'] = SURFBAR_DETERMINE_WAIT_TIME();
// Is the last salt there?
if (is_null($GLOBALS['surfbar_cache']['salts_last_salt'])) {
// Then repair it wit the static!
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_salt - FIXED!', false);
$GLOBALS['surfbar_cache']['salts_last_salt'] = '';
} // END - if
// Fix missing last_surfed
if ((!isset($GLOBALS['surfbar_cache']['last_surfed'])) || (is_null($GLOBALS['surfbar_cache']['last_surfed']))) {
// Fix it here
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'last_surfed - FIXED!', false);
$GLOBALS['surfbar_cache']['last_surfed'] = '0';
} // END - if
// Get base/fixed reward and costs
$GLOBALS['surfbar_cache']['reward'] = SURFBAR_DETERMINE_REWARD();
$GLOBALS['surfbar_cache']['costs'] = SURFBAR_DETERMINE_COSTS();
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'BASE/STATIC - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS());
// Only in dynamic model add the dynamic bonus!
if (getSurfbarPaymentModel() == 'DYNAMIC') {
// Calculate dynamic reward/costs and add it
$GLOBALS['surfbar_cache']['reward'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
$GLOBALS['surfbar_cache']['costs'] += SURFBAR_CALCULATE_DYNAMIC_ADD();
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'DYNAMIC+ - reward='.SURFBAR_GET_REWARD().'|costs='.SURFBAR_GET_COSTS());
} // END - if
// Now get the id
$nextId = SURFBAR_GET_ID();
} // END - if
// Free result
SQL_FREERESULT($result);
// Return result
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'urlId=' . $urlId . ',nextId=' . $nextId . ' - EXIT!');
return $nextId;
}
//-----------------------------------------------------------------------------
// Wrapper function
//-----------------------------------------------------------------------------
// "Getter" for surfbar_dynamic_percent
function getSurfbarDynamicPercent () {
// Do we have cache?
if (!isset($GLOBALS[__FUNCTION__])) {
// Determine it
$GLOBALS[__FUNCTION__] = getConfig('surfbar_dynamic_percent');
} // END - if
// Return cache
return $GLOBALS[__FUNCTION__];
}
// "Getter" for surfbar_static_reward
function getSurfbarStaticReward () {
// Do we have cache?
if (!isset($GLOBALS[__FUNCTION__])) {
// Determine it
$GLOBALS[__FUNCTION__] = getConfig('surfbar_static_reward');
} // END - if
// Return cache
return $GLOBALS[__FUNCTION__];
}
// "Getter" for surfbar_static_time
function getSurfbarStaticTime () {
// Do we have cache?
if (!isset($GLOBALS[__FUNCTION__])) {
// Determine it
$GLOBALS[__FUNCTION__] = getConfig('surfbar_static_time');
} // END - if
// Return cache
return $GLOBALS[__FUNCTION__];
}
// "Getter" for surfbar_max_order
function getSurfbarMaxOrder () {
// Do we have cache?
if (!isset($GLOBALS[__FUNCTION__])) {
// Determine it
$GLOBALS[__FUNCTION__] = getConfig('surfbar_max_order');
} // END - if
// Return cache
return $GLOBALS[__FUNCTION__];
}
// "Getter" for surfbar_payment_model
function getSurfbarPaymentModel () {
// Do we have cache?
if (!isset($GLOBALS[__FUNCTION__])) {
// Determine it
$GLOBALS[__FUNCTION__] = getConfig('surfbar_payment_model');
} // END - if
// Return cache
return $GLOBALS[__FUNCTION__];
}
//------------------------------------------------------------------------------
// PLEASE DO NOT ADD ANY OTHER FUNCTIONS BELOW THIS LINE IF THEY DON'T "WRAP"
// THE $GLOBALS['surfbar_cache'] ARRAY!
//------------------------------------------------------------------------------
// Initializes the surfbar
function SURFBAR_INIT () {
// Init cache array
$GLOBALS['surfbar_cache'] = array();
}
// Private getter for data elements
function SURFBAR_GET_DATA ($element) {
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element=' . $element . ' - ENTERED!');
// Default is null
$data = NULL;
// Is the entry there?
if (isset($GLOBALS['surfbar_cache'][$element])) {
// Then take it
$data = $GLOBALS['surfbar_cache'][$element];
} else { // END - if
print('');
print_r($GLOBALS['surfbar_cache']);
print('
');
debug_report_bug(__FUNCTION__, __LINE__, 'Element ' . $element . ' not found.');
}
// Return result
/* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . $element . ']=[' . gettype($data) . ']' . $data . ' - EXIT!');
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 costs from cache
function SURFBAR_GET_COSTS () {
// Get data element and return its contents
return SURFBAR_GET_DATA('costs');
}
// Getter for URL from cache
function SURFBAR_GET_URL () {
// Get data element and return its contents
return SURFBAR_GET_DATA('url');
}
// Getter for salt from cache
function SURFBAR_GET_SALT () {
// Get data element and return its contents
return SURFBAR_GET_DATA('salt');
}
// Getter for id from cache
function SURFBAR_GET_ID () {
// Get data element and return its contents
return SURFBAR_GET_DATA('url_id');
}
// Getter for userid from cache
function SURFBAR_GET_USERID () {
// Get data element and return its contents
return SURFBAR_GET_DATA('url_userid');
}
// Getter for user reload locks
function SURFBAR_GET_USER_LOCKS () {
// 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');
}
// Getter for allowed views
function SURFBAR_GET_VIEWS_ALLOWED () {
// Get data element and return its contents
return SURFBAR_GET_DATA('url_views_allowed');
}
// Getter for maximum views
function SURFBAR_GET_VIEWS_MAX () {
// Get data element and return its contents
return SURFBAR_GET_DATA('url_views_max');
}
// Getter for fixed reload
function SURFBAR_GET_FIXED_RELOAD () {
// Get data element and return its contents
return SURFBAR_GET_DATA('url_fixed_reload');
}
// Getter for surf lock
function SURFBAR_GET_SURF_LOCK () {
// Get data element and return its contents
return SURFBAR_GET_DATA('surf_lock');
}
// Getter for new status
function SURFBAR_GET_NEW_STATUS () {
// Get data element and return its contents
return SURFBAR_GET_DATA('new_status');
}
// Getter for last salt
function SURFBAR_GET_LAST_SALT () {
// Get data element and return its contents
return SURFBAR_GET_DATA('salts_last_salt');
}
// [EOF]
?>