Commits for review: Add php Error Reporting Functionality to PMA

browse_foreigners.php

@@ -63,4 +63,5 @@
 );
 
 $response->addHtml($html);
+
 ?>

db_create.php

@@ -133,4 +133,5 @@
         include_once '' . $cfg['DefaultTabDatabase'];
     }
 }
+
 ?>

db_printview.php

@@ -177,4 +177,5 @@
 echo PMA_Util::getButton();
 
 echo "<div id='PMA_disable_floating_menubar'></div>\n";
+
 ?>

db_qbe.php

@@ -129,4 +129,5 @@
 }
 
 $response->addHTML($db_qbe->getSelectionForm($cfgRelation));
+
 ?>

db_search.php

@@ -60,4 +60,5 @@
 );
 $response->addHTML($db_search->getSelectionForm($url_params));
 $response->addHTML($db_search->getResultDivs());
+
 ?>

error_report.php

@@ -10,86 +10,184 @@
 
 $response = PMA_Response::getInstance();
 
-if (isset($_REQUEST['send_error_report'])
-    && $_REQUEST['send_error_report'] == true
+if (isset($_REQUEST['exception_type'])
+    && $_REQUEST['exception_type'] == 'js'
 ) {
-    $server_response = PMA_sendErrorReport(PMA_getReportData(false));
+    if (isset($_REQUEST['send_error_report'])
+        && $_REQUEST['send_error_report'] == true
+    ) {
+        $server_response = PMA_sendErrorReport(PMA_getReportData(false, 'js'));
 
-    if ($server_response === false) {
-        $success = false;
-    } else {
-        $decoded_response = json_decode($server_response, true);
-        $success = !empty($decoded_response) ? $decoded_response["success"] : false;
-    }
+        if ($server_response === false) {
+            $success = false;
+        } else {
+            $decoded_response = json_decode($server_response, true);
+            $success = !empty($decoded_response) ? $decoded_response["success"] : false;
+        }
 
-    if (isset($_REQUEST['automatic'])
-        && $_REQUEST['automatic'] === "true"
-    ) {
-        if ($success) {
-            $response->addJSON(
-                'message',
-                PMA_Message::error(
-                    __(
-                        'An error has been detected and an error report has been '
-                        . 'automatically submitted based on your settings.'
+        if (isset($_REQUEST['automatic'])
+            && $_REQUEST['automatic'] === "true"
+        ) {
+            if ($success) {
+                $response->addJSON(
+                    'message',
+                    PMA_Message::error(
+                        __(
+                            'An error has been detected and an error report has been '
+                            . 'automatically submitted based on your settings.'
+                        )
+                        . '<br />'
+                        . __('You may want to refresh the page.')
                     )
-                    . '<br />'
-                    . __('You may want to refresh the page.')
-                )
-            );
+                );
+            } else {
+                $response->addJSON(
+                    'message',
+                    PMA_Message::error(
+                        __(
+                            'An error has been detected and an error report has been '
+                            . 'generated but failed to be sent.'
+                        )
+                        . ' '
+                        . __(
+                            'If you experience any '
+                            . 'problems please submit a bug report manually.'
+                        )
+                        . '<br />'
+                        . __('You may want to refresh the page.')
+                    )
+                );
+            }
         } else {
-            $response->addJSON(
-                'message',
-                PMA_Message::error(
-                    __(
-                        'An error has been detected and an error report has been '
-                        . 'generated but failed to be sent.'
+            if ($success) {
+                $response->addJSON(
+                    'message',
+                    PMA_Message::success(
+                        __('Thank you for submitting this report.')
+                        . '<br />'
+                        . __('You may want to refresh the page.')
                     )
-                    . ' '
-                    . __(
-                        'If you experience any '
-                        . 'problems please submit a bug report manually.'
+                );
+            } else {
+                $response->addJSON(
+                    'message',
+                    PMA_Message::error(
+                        __('Thank you for submitting this report.')
+                        . ' '
+                        . __('Unfortunately the submission failed.')
+                        . ' '
+                        . __(
+                            'If you experience any '
+                            . 'problems please submit a bug report manually.'
+                        )
+                        . '<br />'
+                        . __('You may want to refresh the page.')
                     )
-                    . '<br />'
-                    . __('You may want to refresh the page.')
-                )
-            );
+                );
+            }
+            if (isset($_REQUEST['always_send'])
+                && $_REQUEST['always_send'] === "true"
+            ) {
+                PMA_persistOption("SendErrorReports", "always", "ask");
+            }
         }
+    } elseif (! empty($_REQUEST['get_settings'])) {
+        $response->addJSON('report_setting', $GLOBALS['cfg']['SendErrorReports']);
     } else {
-        if ($success) {
-            $response->addJSON(
-                'message',
-                PMA_Message::success(
-                    __('Thank you for submitting this report.')
-                    . '<br />'
-                    . __('You may want to refresh the page.')
-                )
-            );
+        $response->addHTML(PMA_getErrorReportForm());
+    }
+} elseif (isset($_REQUEST['exception_type'])
+    && $_REQUEST['exception_type'] == 'php'
+) {
+    if (isset($_REQUEST['send_error_report'])
+        && $_REQUEST['send_error_report'] == '1'
+    ) {
+        /**
+         * Prevent inifnite error submission.
+         * Happens in case error submissions fails.
+         * If reporting is done in some time interval,
+         * just clear them & clear json data too.
+         */
+        if (isset($_SESSION['prev_error_subm_time'])
+            && isset($_SESSION['error_subm_count'])
+            && $_SESSION['error_subm_count'] >= 3                  // max 4 attempts
+            && ($_SESSION['prev_error_subm_time']-time()) <= 3000  // in 3 seconds
+        ) {
+            $_SESSION['error_subm_count'] = 0;
+            $_SESSION['prev_errors'] = '';
+             $response = PMA_Response::getInstance();
+            $response->addJSON('_stopErrorReportLoop', '1');
         } else {
-            $response->addJSON(
-                'message',
-                PMA_Message::error(
-                    __('Thank you for submitting this report.')
-                    . ' '
-                    . __('Unfortunately the submission failed.')
-                    . ' '
-                    . __(
-                        'If you experience any '
-                        . 'problems please submit a bug report manually.'
-                    )
-                    . '<br />'
-                    . __('You may want to refresh the page.')
-                )
+            $_SESSION['prev_error_subm_time'] = time();
+            $_SESSION['error_subm_count'] = (
+                (isset($_SESSION['error_subm_count']))
+                    ? ($_SESSION['error_subm_count']+1)
+                    : (0)
             );
         }
-        if (isset($_REQUEST['always_send'])
-            && $_REQUEST['always_send'] === "true"
-        ) {
-            PMA_persistOption("SendErrorReports", "always", "ask");
+
+        $reportData = PMA_getReportData(false, 'php');
+        // report if and only if there were 'actual' errors.
+        if ($reportData) {
+            $server_response = PMA_sendErrorReport($reportData);
+            if ($server_response === false) {
+                $success = false;
+            } else {
+                $decoded_response = json_decode($server_response, true);
+                $success = !empty($decoded_response) ? $decoded_response["success"] : false;
+            }
+
+            if ($GLOBALS['cfg']['SendErrorReports'] == 'ask') {
+                if ($success) {
+                    $errSubmitMsg = PMA_Message::error(
+                        __('Thank You for subitting error report!!')
+                        . '<br/>'
+                        . __('Report has been succesfully submitted.')
+                    );
+                } else {
+                    $errSubmitMsg = PMA_Message::error(
+                        __('Thank You for subitting error report!!')
+                        . '<br/>'
+                        . __(' Unfortunately submission failed.')
+                        . '<br/>'
+                        . __(' If you experience any problems please submit a bug report manually.')
+                    );
+                }
+            } elseif ($GLOBALS['cfg']['SendErrorReports'] == 'always') {
+                if ($success) {
+                    $errSubmitMsg = PMA_Message::error(
+                        __(
+                            'An error has been detected on the server'
+                            . ' and an error report has been '
+                            . 'automatically submitted based on your settings.'
+                        )
+                    );
+                } else {
+                    $errSubmitMsg = PMA_Message::error(
+                        __(
+                            'An error has been detected and an error report has been '
+                            . 'generated but failed to be sent.'
+                        )
+                        . '<br/>'
+                        . __('If you experience any problems please submit a bug report manually.')
+                    );
+                }
+            }
+
+            if ($response->isAjax()) {
+                $response->addJSON('_errSubmitMsg', $errSubmitMsg);
+            } else {
+                $jsCode = 'PMA_ajaxShowMessage("<div class=\"error\">'
+                        . $errSubmitMsg
+                        . '</div>", false);';
+                $response->getFooter()->getScripts()->addCode($jsCode);
+            }
         }
     }
-} elseif (! empty($_REQUEST['get_settings'])) {
-    $response->addJSON('report_setting', $GLOBALS['cfg']['SendErrorReports']);
+    // clear previous errors & save new ones.
+    $GLOBALS['error_handler']->savePreviousErrors();
 } else {
-    $response->addHTML(PMA_getErrorReportForm());
+    die('Oops, something went wrong!!');
 }
+
+?>

file_echo.php

@@ -68,4 +68,5 @@
     }
     echo file_get_contents($_FILES['file']['tmp_name']);
 }
+
 ?>

gis_data_editor.php

@@ -421,4 +421,5 @@ function escape($variable)
 
 PMA_Response::getInstance()->addJSON('gis_editor', ob_get_contents());
 ob_end_clean();
+
 ?>

import.php

@@ -665,4 +665,5 @@
     $active_page = $goto;
     include '' . $goto;
 }
+
 ?>

import_status.php

@@ -98,4 +98,5 @@
 } else {
     PMA_importAjaxStatus($_GET["id"]);
 }
+
 ?>

index.php

@@ -662,4 +662,5 @@ function PMA_printListItem($name, $listId = null, $url = null,
     }
     echo '</li>';
 }
+
 ?>

js/ajax.js

@@ -325,11 +325,30 @@ var AJAX = {
                 }
 
                 $('#pma_errors').remove();
+
+                var msg = '';
+                if(data._errSubmitMsg){
+                    msg = data._errSubmitMsg;
+                }
                 if (data._errors) {
                     $('<div/>', {id : 'pma_errors'})
                         .insertAfter('#selflink')
                         .append(data._errors);
+                        // In case of 'sendErrorReport'='always'
+                        // submit the hidden error reporting form.
+                        if (data._sendErrorAlways == '1'
+                            && data._stopErrorReportLoop != '1'
+                        ) {
+                            $("#pma_report_errors_form").submit();
+                            PMA_ajaxShowMessage(PMA_messages['phpErrorsBeingSubmitted'], false);
+                        } else if (data._promptPhpErrors) {
+                            // otherwise just prompt user if it is set so.
+                            msg = msg + PMA_messages['phpErrorsFound'];
+                            // scroll to bottom where all the erros are displayed.
+                            $('html, body').animate({scrollTop:$(document).height()}, 'slow');
+                        }
                 }
+                PMA_ajaxShowMessage(msg, false);
 
                 if (typeof AJAX._callback === 'function') {
                     AJAX._callback.call();

js/error_report.js

@@ -22,7 +22,8 @@ var ErrorReport = {
         $.get("error_report.php", {
             ajax_request: true,
             token: PMA_commonParams.get('token'),
-            get_settings: true
+            get_settings: true,
+            exception_type: 'js'
         }, function (data) {
             if (!data.success === true) {
                 PMA_ajaxShowMessage(data.error, false);
@@ -226,7 +227,8 @@ var ErrorReport = {
             "token": PMA_commonParams.get('token'),
             "exception": exception,
             "current_url": window.location.href,
-            "microhistory": ErrorReport._get_microhistory()
+            "microhistory": ErrorReport._get_microhistory(),
+            "exception_type": 'js'
         };
         if (typeof AJAX.cache.pages[AJAX.cache.current - 1] !== 'undefined') {
            report_data.scripts = AJAX.cache.pages[AJAX.cache.current - 1].scripts.map(

js/functions.js

@@ -4160,3 +4160,24 @@ function checkNumberOfFields() {
 
     return true;
 }
+
+/**
+ * Ignore the displayed php errors.
+ * Simply removes the displayed errors.
+ *
+ */
+ function PMA_ignorePhpErrors(clearPrevErrors){
+    if (typeof clearPrevErrors === "undefined" || clearPrevErrors === null) { 
+        str = false; 
+    }
+    // send AJAX request to error_report.php with send_error_report=0, exception_type=php & token.
+    // It clears the prev_errors stored in session.
+    if(clearPrevErrors){
+        $('#pma_report_errors_form input[name="send_error_report"]').val(0); // change send_error_report to '0'
+        $('#pma_report_errors_form').submit();
+    }
+
+    // remove dislayed errors
+    $('#pma_errors').fadeOut( "slow");
+    $('#pma_errors').remove();
+ }