{"id":856,"date":"2023-04-05T19:16:50","date_gmt":"2023-04-05T17:16:50","guid":{"rendered":"https:\/\/betalord.com\/code\/?p=856"},"modified":"2023-04-05T20:12:24","modified_gmt":"2023-04-05T18:12:24","slug":"in-app-user-reports","status":"publish","type":"post","link":"https:\/\/betalord.com\/code\/2023\/04\/05\/in-app-user-reports\/","title":{"rendered":"In-app user reports"},"content":{"rendered":"\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\tRecently I had to implement user bug reporting feature. What it does is it makes possible for the user to report bugs (or make suggestions, etc.) from within a java app, which then sends the report over to the web server (via POST data through php script), which in turns sends an email to the developer containing the user report.\n\nThis system is made out of two parts:\n
    \n \t
  1. Java code that sends the data to the server<\/li>\n \t
  2. PHP script that reads sent data via POST and sends an email to local email server<\/li>\n<\/ol>\nThe code presented below was implemented using libGDX framework (plus some my personal stuff), so it won’t compile off the bat, but it should serve as an example on how to solve this problem. Just reimplement the GUI part and the rest that is based off the libGDX library.\n\nNote: Java code was implemented using Apache’s HttpComponents library. I had to add this line to my gradle script in order to include it:\n\nimplementation 'org.apache.httpcomponents.client5:httpclient5:5.2.1'<\/code>\n\nAlso note, that this didn’t work on Android for some reason. It was throwing com.android.builder.merge.DuplicateRelativeFileException: 3 files found with path 'META-INF\/DEPENDENCIES' <\/code>exception. I solved this problem by adding exclude to the Android’s gradle build script:\n
    packagingOptions {\n\tresources {\n\t\texcludes += ['META-INF\/robovm\/ios\/robovm.xml']\n\t\texcludes += ['META-INF\/DEPENDENCIES']\n\t}\n}<\/pre>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t\t
    \n\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t
    Usage demonstration:<\/h6>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t\t
    \n\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t
    \n\t\t\t\t\t\t\t
    \n\t\t\t
    <\/div>\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t\t
    \n\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t
    Java Report class:<\/h6>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t\t
    \n\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t
    \n\t\t\t\t\t
    package com.betalord.sgx.core;\r\n\r\nimport com.badlogic.gdx.Gdx;\r\nimport com.badlogic.gdx.Input;\r\nimport com.badlogic.gdx.scenes.scene2d.ui.Table;\r\nimport com.badlogic.gdx.scenes.scene2d.ui.TextArea;\r\nimport com.betalord.sgx.ui.DialogUtils;\r\nimport com.betalord.sgx.ui.SGXDialog;\r\nimport com.betalord.sgx.ui.SGXLabel;\r\nimport com.betalord.sgx.ui.SGXTextArea;\r\nimport com.betalord.sgx.ui.SGXTextField;\r\nimport com.betalord.sgx.util.ConsistencyResult;\r\nimport com.betalord.sgx.util.SGXCallableObj;\r\n\r\nimport org.apache.hc.client5.http.classic.methods.HttpPost;\r\nimport org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;\r\nimport org.apache.hc.client5.http.entity.mime.StringBody;\r\nimport org.apache.hc.client5.http.impl.classic.CloseableHttpClient;\r\nimport org.apache.hc.client5.http.impl.classic.HttpClients;\r\nimport org.apache.hc.core5.http.ContentType;\r\nimport org.apache.hc.core5.http.HttpEntity;\r\nimport org.apache.hc.core5.http.io.entity.EntityUtils;\r\nimport org.apache.hc.core5.http.message.StatusLine;\r\n\r\nimport java.io.IOException;\r\n\r\n\/**\r\n * Class representing user report (bug report, suggestion or other).\r\n *\r\n * @author Betalord\r\n *\/\r\npublic class Report {\r\n\tprivate final String type;\r\n\t\/**\r\n\t * Dialog that we open which contains edit box and "Send" button, among other things.\r\n\t *\/\r\n\tprivate final SGXDialog reportDialog;\r\n\t\/**\r\n\t * Dialog that we show upon receiving a response from the server. We need a reference to it as we access it from the result() method.\r\n\t *\/\r\n\tprivate SGXDialog resultDialog;\r\n\t\r\n\t\/**\r\n\t * Creates the report widget. Call {@link #show()} to actually open the dialog so that user can fill in the report.\r\n\t *\r\n\t * @param type type of this report (e.g. bug report, suggestion, ...). Will be sent to the server (may be any string really).\r\n\t *\/\r\n\tpublic Report(String type) {\r\n\t\tSGXGame game = SGXGame.get(); \/\/ a shortcut\r\n\t\tthis.type = type;\r\n\t\t\r\n\t\tTable tabEmail = new Table();\r\n\t\ttabEmail.add(new SGXLabel("Contact e-mail:", game.uiSkin5, "small"));\r\n\t\tSGXTextField editEmail = new SGXTextField("", game.uiSkin5, "default");\r\n\t\teditEmail.setMessageText("Click to type...");\r\n\t\ttabEmail.add(editEmail).growX();\r\n\t\t\r\n\t\tTable tab = new Table();\r\n\t\ttab.add(tabEmail).growX();\r\n\t\ttab.row();\r\n\t\tTextArea taReport = new SGXTextArea("", game.uiSkin5);\r\n\t\ttaReport.setMessageText("Enter your report");\r\n\t\ttab.add(taReport).growX().height(350);\r\n\t\ttab.row();\r\n\t\ttab.add(new SGXLabel("Alternatively you can submit your report at https:\/\/sgx.betalord.com site.", game.uiSkin5, "small"));\r\n\t\t\r\n\t\treportDialog = DialogUtils.DialogSetup.setup("Create report")\r\n\t\t\t\t.table(tab)\r\n\t\t\t\t.button("Send", "SEND")\r\n\t\t\t\t.button("Cancel", Input.Keys.ESCAPE, "CANCEL")\r\n\t\t\t\t.addCloseButtonInTitleBar("CANCEL")\r\n\t\t\t\t.width(600)\r\n\t\t\t\t.quick()\r\n\t\t\t\t.result(new SGXCallableObj() {\r\n\t\t\t\t\t@Override\r\n\t\t\t\t\tpublic void call(Object obj) {\r\n\t\t\t\t\t\tif (obj == "SEND") {\r\n\t\t\t\t\t\t\treportDialog.cancel(); \/\/ don't hide the dialog when user presses "SEND" button\r\n\t\t\t\t\t\t\tString reportData = taReport.getText(); \/\/ never null, may be empty ("")\r\n\t\t\t\t\t\t\tString senderEmail = editEmail.getText(); \/\/ never null, may be empty ("")\r\n\t\t\t\t\t\t\tboolean emailValid = Misc.emailPattern.matcher(senderEmail).matches();\r\n\t\t\t\t\t\t\tif (reportData.trim().equals("")) {\r\n\t\t\t\t\t\t\t\t\/\/ report is empty!\r\n\t\t\t\t\t\t\t\tDialogUtils.DialogSetup.setup("Unable to submit the report", "Your report is empty. Please fill it in before sending it.")\r\n\t\t\t\t\t\t\t\t\t\t.quick()\r\n\t\t\t\t\t\t\t\t\t\t.addOKButton()\r\n\t\t\t\t\t\t\t\t\t\t.show();\r\n\t\t\t\t\t\t\t} else if (senderEmail.trim().equals("") || !emailValid) {\r\n\t\t\t\t\t\t\t\t\/\/ sender email is empty!\r\n\t\t\t\t\t\t\t\tDialogUtils.DialogSetup.setup("Unable to submit the report", "Sender e-mail address is empty or invalid. Please fill it in as we need it in case we need to contact you for further info. Thank you!")\r\n\t\t\t\t\t\t\t\t\t\t.quick()\r\n\t\t\t\t\t\t\t\t\t\t.addOKButton()\r\n\t\t\t\t\t\t\t\t\t\t.show();\r\n\t\t\t\t\t\t\t} else {\r\n\t\t\t\t\t\t\t\t\/\/ all OK, file the report!\r\n\t\t\t\t\t\t\t\tfileReport(reportData, senderEmail);\r\n\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\t}\r\n\t\t\t\t})\r\n\t\t\t\t.create();\r\n\t}\r\n\t\r\n\t\/**\r\n\t * Open the report dialog so that the user can fill in the report and send it to the server.\r\n\t *\/\r\n\tpublic void show() {\r\n\t\treportDialog.show();\r\n\t}\r\n\t\r\n\t\/**\r\n\t * Will send what user wrote to the server and show a dialog telling user that we are contacting the server and will also notify user of success or failure.\r\n\t *\/\r\n\tprivate void fileReport(String reportData, String senderEmail) {\r\n\t\tfinal SGXDialog dialog = DialogUtils.DialogSetup.setup("Reporting", "Contacting server and filing the report...")\r\n\t\t\t\t.quick()\r\n\t\t\t\t.show();\r\n\t\t\r\n\t\tfinal Thread thread = new Thread(() -> {\r\n\t\t\tConsistencyResult result = ConsistencyResult.consistent();\r\n\t\t\ttry {\r\n\t\t\t\tString response = sendReportToServer(reportData, senderEmail);\r\n\t\t\t\tif (response == null)\r\n\t\t\t\t\tresult = ConsistencyResult.inconsistent("No response from the server.");\r\n\t\t\t\telse if (response.startsWith("OK")) {\r\n\t\t\t\t\t\/\/ All fine - no need to do anything!\r\n\t\t\t\t} else {\r\n\t\t\t\t\t\/\/ Server response starts with "FAIL" or some other error string that precedes it (e.g. "<b>Warning<\/b>:  mail(): Failed to connect to mailserver...")\r\n\t\t\t\t\tresult = ConsistencyResult.inconsistent("Server responded: '" + response + "'");\r\n\t\t\t\t}\r\n\t\t\t} catch (IOException e) {\r\n\t\t\t\tresult = ConsistencyResult.inconsistent("Unable to contact server.");\r\n\t\t\t\tMisc.err("Error filing report: " + e.getLocalizedMessage());\r\n\t\t\t\te.printStackTrace();\r\n\t\t\t}\r\n\t\t\t\r\n\t\t\tfinal ConsistencyResult finalResult = result;\r\n\t\t\t\r\n\t\t\tGdx.app.postRunnable(() -> {\r\n\t\t\t\tdialog.hide();\r\n\t\t\t\t\r\n\t\t\t\tif (finalResult.isConsistent()) { \/\/ success\r\n\t\t\t\t\treportDialog.hide();\r\n\t\t\t\t\t\r\n\t\t\t\t\tresultDialog = DialogUtils.DialogSetup.setup("Report submitted", "Your report has been successfully filed. Thank you!")\r\n\t\t\t\t\t\t\t.addOKButton("Close")\r\n\t\t\t\t\t\t\t.quick()\r\n\t\t\t\t\t\t\t.create();\r\n\t\t\t\t\tresultDialog.show();\r\n\t\t\t\t} else { \/\/ failed\r\n\t\t\t\t\tresultDialog = DialogUtils.DialogSetup.setup("Report failed", "Unable to submit report: an error occurred. Please try again later or submit your report manually at sgx.betalord.com web site.")\r\n\t\t\t\t\t\t\t.addOKButton("Close")\r\n\t\t\t\t\t\t\t.button("Error log", "LOG")\r\n\t\t\t\t\t\t\t.addCloseButtonInTitleBar()\r\n\t\t\t\t\t\t\t.quick()\r\n\t\t\t\t\t\t\t.result(obj -> {\r\n\t\t\t\t\t\t\t\tif (obj == "LOG") { \/\/ we clicked the "Error log" button\r\n\t\t\t\t\t\t\t\t\tresultDialog.cancel(); \/\/ don't close the dialog upon clicking on "Error log" button\r\n\t\t\t\t\t\t\t\t\tDialogUtils.DialogSetup.setup("Error log", finalResult.getReason())\r\n\t\t\t\t\t\t\t\t\t\t\t.quick()\r\n\t\t\t\t\t\t\t\t\t\t\t.addOKButton()\r\n\t\t\t\t\t\t\t\t\t\t\t.show();\r\n\t\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t\t})\r\n\t\t\t\t\t\t\t.create();\r\n\t\t\t\t\t\r\n\t\t\t\t\tresultDialog.show();\r\n\t\t\t\t}\r\n\t\t\t});\r\n\t\t}, "File Report Thread");\r\n\t\t\r\n\t\t\/\/ start:\r\n\t\tthread.start();\r\n\t}\r\n\t\r\n\t\/**\r\n\t * Low-level method that sends report data to the server.\r\n\t * This method is thread-safe.\r\n\t *\r\n\t * @return response from the server (the generated page), or null in case of an error\r\n\t *\/\r\n\tprivate String sendReportToServer(String reportData, String senderEmail) throws IOException {\r\n\t\t\/\/ Partially based on this example: https:\/\/github.com\/apache\/httpcomponents-client\/blob\/master\/httpclient5\/src\/test\/java\/org\/apache\/hc\/client5\/http\/examples\/ClientMultipartFormPost.java\r\n\t\t\r\n\t\tString result;\r\n\t\ttry (final CloseableHttpClient httpclient = HttpClients.createDefault()) {\r\n\t\t\t\/\/final HttpPost httppost = new HttpPost("http:\/\/localhost:80\/web_reporting\/report.php");\r\n\t\t\tfinal HttpPost httppost = new HttpPost("https:\/\/sgx.betalord.com\/admin\/report.php"); \/\/ note: putting "http:\/\/" instead of "https:\/\/" will cause $_POST to be empty (due to rewrite rules for the apache web server). This was actually a problem I was having (see: https:\/\/stackoverflow.com\/questions\/1282909\/php-post-array-empty-upon-form-submission)\r\n\t\t\t\r\n\t\t\tfinal StringBody type = new StringBody(Report.this.type, ContentType.TEXT_PLAIN);\r\n\t\t\tfinal StringBody sender = new StringBody(senderEmail, ContentType.TEXT_PLAIN);\r\n\t\t\tfinal StringBody contents = new StringBody(reportData, ContentType.TEXT_PLAIN);\r\n\t\t\t\r\n\t\t\tfinal HttpEntity reqEntity = MultipartEntityBuilder.create()\r\n\t\t\t\t\t\/\/.addPart("bin", bin)\r\n\t\t\t\t\t.addPart("type", type)\r\n\t\t\t\t\t.addPart("sender", sender)\r\n\t\t\t\t\t.addPart("report", contents)\r\n\t\t\t\t\t.addPart("auth", new StringBody("password", ContentType.TEXT_PLAIN))\r\n\t\t\t\t\t.build();\r\n\t\t\t\r\n\t\t\thttppost.setEntity(reqEntity);\r\n\t\t\t\r\n\t\t\tresult = httpclient.execute(httppost, response -> {\r\n\t\t\t\tif (Version.areWeDeveloping())\r\n\t\t\t\t\tSystem.out.println(httppost + "->" + new StatusLine(response));\r\n\t\t\t\tfinal HttpEntity resEntity = response.getEntity();\r\n\t\t\t\tString serverResponse = null;\r\n\t\t\t\tif (resEntity != null) {\r\n\t\t\t\t\tserverResponse = EntityUtils.toString(response.getEntity()); \/\/ process response message and convert it into a value object\r\n\t\t\t\t}\r\n\t\t\t\tEntityUtils.consume(response.getEntity());\r\n\t\t\t\treturn serverResponse; \/\/ we must not return "EntityUtils.toString(response.getEntity())" at this point as the stream is already closed (by Entityutils.consume() method), or else we'll get this exception: org.apache.hc.core5.http.StreamClosedException: Stream already closed\r\n\t\t\t});\r\n\t\t}\r\n\t\treturn result;\r\n\t}\r\n}\r\n<\/code><\/pre>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t\t
    \n\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t
    \n\t\t\t\t\t\t\t\t\t
    PHP report.php file:<\/h6>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t\t
    \n\t\t\t
    \n\t\t\t\t\t\t
    \n\t\t\t\t
    \n\t\t\t\t\t
    <?php\r\n\/*\r\nScript that sends an email upon receiving a user report from the SGX application through POST mechanism.\r\n\r\n(c) Betalord 2023\r\n*\/\r\n\r\n\t$AUTH_CODE = "password"; \/\/ some password just to make sure some hacker doesn't abuse of this email sending script\r\n\r\n\tif (!isset($_POST)) die("FAIL (no POST data)");\r\n\t$auth = $_POST["auth"]; \/\/ authentication pass code\r\n\t$type = $_POST["type"];\r\n\t$sender = $_POST["sender"]; \/\/ may be empty string, but not undefined\r\n\t$report = $_POST["report"];\r\n\r\n\tif (!isset($auth) || $auth != $AUTH_CODE)\r\n\t\tdie("FAIL (wrong auth)");\r\n\r\n\tif (!isset($sender) || !isset($type) || empty($type) || !isset($report) || empty($report))\r\n\t\tdie("FAIL (missing POST data)");\r\n\r\n\t$to = "sgx@betalord.com";\r\n\t$subject = "SGX IN-GAME REPORT (" . $type . ")";\r\n\r\n\t$message = "SENDER: " . $sender . "\\r\\n";\r\n\t$message .= "TYPE: " . $type . "\\r\\n";\r\n\t$message .= "\\r\\n";\r\n\t$message .= $report;\r\n\r\n\t$headers = array(\r\n\t\t'From' => 'sgx@betalord.com',\r\n\t\t'Reply-To' => $sender,\r\n\t\t'X-Mailer' => 'PHP\/' . phpversion()\r\n\t);\r\n\t\r\n\t$retval = mail($to, $subject, $message, $headers);\r\n\t\r\n\tif ($retval == true ) {\r\n\t\tdie("OK");\r\n\t} else {\r\n\t\tdie("FAIL (mail function failed)");\r\n\t}\r\n\t\r\n\tdie("OK");\r\n?><\/code><\/pre>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"
    Recently I had to implement user bug reporting feature. What it does is it makes possible for the user to report bugs […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[12,10,13],"class_list":["post-856","post","type-post","status-publish","format-standard","hentry","category-article","tag-java","tag-libgdx","tag-php"],"_links":{"self":[{"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/posts\/856","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/comments?post=856"}],"version-history":[{"count":7,"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/posts\/856\/revisions"}],"predecessor-version":[{"id":871,"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/posts\/856\/revisions\/871"}],"wp:attachment":[{"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/media?parent=856"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/categories?post=856"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/betalord.com\/code\/wp-json\/wp\/v2\/tags?post=856"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}