First batch of removal of the headers needed for revision-functions.php
[mailer.git] / surfbar.php
index e835e927dddf0ed613607da04f8d6fca88c17dc2..d94497b2a06c45529d8d1a78d8665c5cbbd1cd2d 100644 (file)
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team                   *
+ * For more information visit: http://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 *
 require('inc/libs/security_functions.php');
 
 // Init start time
-$GLOBALS['startTime'] = microtime(true);
+$GLOBALS['__start_time'] = microtime(TRUE);
 
-// Set module
-$GLOBALS['module'] = 'surfbar';
-$GLOBALS['output_mode'] = '0';
-$GLOBALS['header_sent'] = 3;
+// Set module output mode
+$GLOBALS['__module']      = 'surfbar';
+$GLOBALS['__output_mode'] = '0';
+$GLOBALS['__header_sent'] = 3;
 
 // Load the required file(s)
 require('inc/config-global.php');
@@ -55,9 +53,9 @@ require('inc/config-global.php');
 setContentType('text/html');
 
 // Is a frame active?
-if (isGetRequestParameterSet('frame')) {
+if (!isFullPage()) {
        // Then we need to set header_sent to 0
-       $GLOBALS['header_sent'] = '0';
+       $GLOBALS['__header_sent'] = '0';
 } // END - if
 
 // Only logged in users may use this surfbar!
@@ -66,29 +64,29 @@ redirectOnUninstalledExtension('surfbar');
 // No member?
 if (!isMember()) {
        // Should we display login window or redirect to main page?
-       if ((getConfig('surfbar_guest_login_form') == 'Y') && (isExtensionActive('user'))) {
+       if ((isSurfbarGuestLoginFormEnabled()) && (isExtensionActive('user'))) {
                // Is the form sent?
-               if ((isFormSent()) && (isPostRequestParameterSet('id')) && (isPostRequestParameterSet('password'))) {
+               if ((isFormSent('login')) && (isPostRequestElementSet('id')) && (isPostRequestElementSet('password'))) {
                        // Do the login procedure
-                       $URL = doUserLogin(postRequestParameter('id'), postRequestParameter('password'), basename(__FILE__), basename(__FILE__) . '?code=');
+                       $url = doUserLogin(postRequestElement('id'), postRequestElement('password'), basename(__FILE__), basename(__FILE__) . '?code=');
 
                        // And redirect to the URL
-                       redirectToUrl($URL);
+                       redirectToUrl($url);
                } else {
                        // Load header
                        loadIncludeOnce('inc/header.php');
 
                        // Is there a 'code' provided?
-                       if (isGetRequestParameterSet('code')) {
+                       if (isGetRequestElementSet('code')) {
                                // Then generate an error message
-                               loadTemplate('admin_settings_saved', false, getMessageFromErrorCode(getRequestParameter('code')));
+                               displayMessage(getMessageFromErrorCode(getRequestElement('code')));
                        } // END - if
 
                        // Display login form
                        loadTemplate('surfbar_login_form');
 
                        // Allow footer here
-                       $GLOBALS['header_sent'] = 2;
+                       $GLOBALS['__header_sent'] = 2;
 
                        // Load footer
                        loadIncludeOnce('inc/footer.php');
@@ -100,19 +98,19 @@ if (!isMember()) {
 } // END - if
 
 // Initialize the surfbar
-SURFBAR_INIT();
+initSurfbar();
 
 // Handle tasks on self-maintenance
-SURFBAR_HANDLE_SELF_MAINTENANCE();
+doSurfbarSelfMaintenance();
 
 // Is there a check value?
-if ((SURFBAR_CHECK_RELOAD_FULL()) || ((isGetRequestParameterSet('frame')) && (in_array(getRequestParameter('frame'), array('stop', 'stop2', 'stats', 'textlinks'))))) {
+if ((isSurfbarReloadFull()) || ((!isFullPage()) && (in_array(getRequestElement('frame'), array('stop', 'stop2', 'stats', 'textlinks'))))) {
        // Reload-lock is full, surfbar stopped so...
        // Load header
        loadIncludeOnce('inc/header.php');
 
        // Load template
-       if (((isGetRequestParameterSet('frame')) && (getRequestParameter('frame') == 'stop2')) || (!isGetRequestParameterSet('frame'))) {
+       if (((!isFullPage()) && (getRequestElement('frame') == 'stop2')) || (isFullPage())) {
                // Load template for "start" page
                loadTemplate('surfbar_frame_start');
 
@@ -120,112 +118,103 @@ if ((SURFBAR_CHECK_RELOAD_FULL()) || ((isGetRequestParameterSet('frame')) && (in
                loadTemplate('surfbar_start_banner');
 
                // This makes the footer appear again
-               unsetGetRequestParameter('frame');
-       } elseif ((isGetRequestParameterSet('frame')) && (getRequestParameter('frame') == 'stats')) {
-               // Get total points amount
-               $points = countSumTotalData(getMemberId(), 'user_points', 'points') - countSumTotalData(getMemberId(), 'user_data', 'used_points');
-
+               unsetGetRequestElement('frame');
+       } elseif ((!isFullPage()) && (getRequestElement('frame') == 'stats')) {
                // Prepare content
                $content = array(
-                       'points' => $points,
-                       'reload' => (getConfig('surfbar_stats_reload') * 1000)
+                       'points' => getTotalPoints(getMemberId()),
+                       'reload' => (getSurfbarStatsReload() * 1000)
                );
 
                // Load template for "stats" page
-               loadTemplate('surfbar_frame_stats', false, $content);
-       } elseif ((isGetRequestParameterSet('frame')) && (getRequestParameter('frame') == 'textlinks')) {
+               loadTemplate('surfbar_frame_stats', FALSE, $content);
+       } elseif ((!isFullPage()) && (getRequestElement('frame') == 'textlinks')) {
                // Prepare content
                $content = array(
-                       'reload' => (getConfig('surfbar_stats_reload') * 1000)
+                       'reload' => (getSurfbarStatsReload() * 1000)
                );
 
                // Load template for "stats" page
-               loadTemplate('surfbar_frame_textlinks', false, $content);
+               loadTemplate('surfbar_frame_textlinks', FALSE, $content);
        } else {
                // Prepare content
                $content = array(
-                       'start'     => str_repeat('X', strlen(getConfig('surfbar_restart_time'))),
-                       'autostart' => (getConfig('surfbar_autostart') == 'Y') ? 'true' : 'false'
+                       'start'     => str_repeat('X', strlen(getSurfbarRestartTime())),
+                       'autostart' => (isSurfbarAutoStartEnabled()) ? 'true' : 'false'
                );
 
                // Load template for stopped surfbar
-               loadTemplate('surfbar_stopped', false, $content);
+               loadTemplate('surfbar_stopped', FALSE, $content);
        }
-} elseif ((isGetRequestParameterSet('check')) && (isGetRequestParameterSet('id')) && (isGetRequestParameterSet('salt'))) {
+} elseif ((isGetRequestElementSet('check')) && (isGetRequestElementSet('id')) && (isGetRequestElementSet('salt'))) {
        // Dummy next id get
-       SURFBAR_DETERMINE_NEXT_ID(getRequestParameter('id'));
+       determineSurfbarNextId(getRequestElement('id'));
 
        // Check reload lock and validation code
-       if ((!SURFBAR_CHECK_RELOAD_LOCK(getRequestParameter('id'))) && (SURFBAR_CHECK_VALIDATION_CODE(getRequestParameter('id'), getRequestParameter('check'), getRequestParameter('salt')))) {
+       if ((!ifSurfbarReloadLock(getRequestElement('id'))) && (isSurfbarValidationCodeValid(getRequestElement('id'), getRequestElement('check'), getRequestElement('salt')))) {
                // Lock the URL (id) down
-               SURFBAR_LOCKDOWN_ID(getRequestParameter('id'));
+               addSurfbarReloadLockById(getRequestElement('id'));
 
                // Code is valid so pay points here
-               SURFBAR_PAY_POINTS();
+               doSurfbarPayPoints();
 
                // Check if reload is full
-               if (SURFBAR_CHECK_RELOAD_FULL()) {
+               if (isSurfbarReloadFull()) {
                        // Then load waiting page
-                       SURFBAR_RELOAD_TO_STOP_PAGE();
+                       redirectToSurfbarStopPage();
                } // END - if
+
+               // Load header to avoid a bug
+               loadIncludeOnce('inc/header.php');
        } else {
                // Reload to stop frame!
-               SURFBAR_RELOAD_TO_STOP_PAGE();
+               redirectToSurfbarStopPage();
        }
 
        // All done, so fix notice for footer.php
-       $GLOBALS['footer_sent'] = 1;
+       $GLOBALS['__footer_sent'] = 1;
 } else {
        // Prepare content
        $content = '';
 
-       // Determine template name
-       $templateName = SURFBAR_DETERMINE_TEMPLATE_NAME();
-
-       // Load header in frameset mode is the default
-       $isFrameset = true;
-
        // Frame "top" set?
-       if ((isGetRequestParameterSet('frame')) && (getRequestParameter('frame') == 'top')) {
+       if ((!isFullPage()) && (getRequestElement('frame') == 'top')) {
                // Determine next id
-               $nextId = SURFBAR_DETERMINE_NEXT_ID();
+               $nextId = determineSurfbarNextId();
+               //* DEBUG: */ exit('nextId='.$nextId);
 
                // Is there a valid id?
-               if ($nextId > 0) {
+               if (isValidId($nextId)) {
                        // Then prepare other content
                        $content = array(
-                               'url_id'      => $nextId,
-                               'check'       => SURFBAR_GENERATE_VALIDATION_CODE($nextId),
-                               'salt'        => SURFBAR_GET_SALT(),
-                               'reward'      => translateComma(SURFBAR_GET_REWARD($nextId)),
-                               'url'         => SURFBAR_GET_URL($nextId),
-                               'curr_reload' => SURFBAR_GET_USER_LOCKS(),
-                               'max_urls'    => SURFBAR_GET_TOTAL_URLS(),
-                               'reload'      => SURFBAR_GET_RELOAD_TIME($nextId),
-                               'xxx'         => str_repeat('X', strlen(SURFBAR_GET_RELOAD_TIME($nextId)))
+                               'url_id' => $nextId,
+                               'xxx'    => str_repeat('X', strlen(getSurfbarWaitingTime($nextId))),
                        );
 
                        // Update salt (double-call lock!) and statistics
-                       SURFBAR_UPDATE_SALT_STATS();
+                       updateSurfbarSaltStatistics();
                } else {
                        // Load new URL
-                       SURFBAR_RELOAD_TO_STOP_PAGE('stop');
+                       redirectToSurfbarStopPage('stop');
                }
-       } elseif ((isGetRequestParameterSet('frame')) && (getRequestParameter('frame') == 'start')) {
+       } elseif ((!isFullPage()) && (getRequestElement('frame') == 'start')) {
                // Starter frame found so let the footer display
-               unsetGetRequestParameter('frame');
+               unsetGetRequestElement('frame');
        }
 
        // Load header
        loadIncludeOnce('inc/header.php');
 
+       // Determine template name
+       $templateName = determineSurfbarTemplateName();
+
        // Load that template
-       //* DEBUG: */ die("templateName={$templateName}<br />\n<strong>content</strong>=<pre>".print_r($content, true)."</pre>");
-       loadTemplate($templateName, false, $content);
+       //* DEBUG: */ exit('templateName=' . $templateName . '<br /><strong>content</strong>=<pre>' . print_r($content, TRUE) . '</pre>');
+       loadTemplate($templateName, FALSE, $content);
 }
 
 // Load footer
-$GLOBALS['footer_sent'] = 3;
+$GLOBALS['__footer_sent'] = 3;
 loadIncludeOnce('inc/footer.php');
 
 // [EOF]