From 9367571927b632f8fb2b0730ceaef7b036bfc0e3 Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Sun, 1 Nov 2020 19:42:14 +0530 Subject: [PATCH 01/12] backend: update readme, reponse to return url, permissions --- backend/readme.md | 8 ++++++++ .../gov/govtech/covid19/controller/ImageController.java | 9 ++++++--- .../lk/gov/govtech/covid19/dto/StoredImageResponse.java | 3 +-- .../govtech/covid19/security/SecurityConfiguration.java | 4 ++++ .../lk/gov/govtech/covid19/service/ImageService.java | 7 ++++++- .../main/java/lk/gov/govtech/covid19/util/Constants.java | 4 ++++ 6 files changed, 29 insertions(+), 6 deletions(-) diff --git a/backend/readme.md b/backend/readme.md index 6b0a320..df8192f 100644 --- a/backend/readme.md +++ b/backend/readme.md @@ -10,6 +10,12 @@ mvn clean package cd target java -jar backend.jar ``` +## Context of the Backend +The context of the backend is `/api`. This is set at `server.servlet.context-path` in +the application.yaml. Since we serve the backend at `/api`, every controller context +path is appended after `/api`. eg: `https://host/api/notification`. +The admin portal ui to the backend is served at `/` as a seperate web app. +Similarly, backend is another webapp served at `/api` in the same tomcat. ## How the Portal Webapp is Served in the Tomcat Server - pom.xml in `portal/` will build the vue app and will create a war, by including everything inside `dist` @@ -19,4 +25,6 @@ java -jar backend.jar - if none of them exists, backend will start without the webapp - For more info: `lk.gov.govtech.covid19.config.WebappConfiguration` - Content in the war will appear at localhost:8000/ + + \ No newline at end of file diff --git a/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java b/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java index f3b4dc8..10005a2 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java @@ -4,6 +4,7 @@ import lk.gov.govtech.covid19.dto.StoredImageResponse; import lk.gov.govtech.covid19.service.ImageService; import lk.gov.govtech.covid19.util.Constants; +import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; @@ -11,22 +12,24 @@ import org.springframework.web.multipart.MultipartFile; @RestController +@Slf4j @RequestMapping(Constants.IMAGE_API_CONTEXT) public class ImageController { @Autowired ImageService imageService; - @PostMapping(path = "/add") + @PostMapping public ResponseEntity uploadImage(@RequestParam("image") MultipartFile image){ StoredImageResponse response = null; if (image.isEmpty()){ - System.out.println("empty file"); + log.info("Request does not contain an image"); }else { + log.info("Image {} of size:{} being added", image.getOriginalFilename(), image.getSize()); response = imageService.addImage(image); } System.gc(); - return ResponseEntity.ok().body(response); + return ResponseEntity.accepted().body(response); } @GetMapping(value = "/image/{imageId}", produces = MediaType.IMAGE_JPEG_VALUE) diff --git a/backend/src/main/java/lk/gov/govtech/covid19/dto/StoredImageResponse.java b/backend/src/main/java/lk/gov/govtech/covid19/dto/StoredImageResponse.java index ed9fa02..2959857 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/dto/StoredImageResponse.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/dto/StoredImageResponse.java @@ -1,11 +1,10 @@ package lk.gov.govtech.covid19.dto; -import lombok.AllArgsConstructor; import lombok.Data; @Data -@AllArgsConstructor public class StoredImageResponse { private int id; + private String url; private String name; } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java b/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java index b7134ec..4336d91 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java @@ -31,6 +31,8 @@ public class SecurityConfiguration { /* * Endpoints with auth (either http basic auth or login based can be used) * - /notification + * - /application PUT + * - /images POST * * */ @@ -102,6 +104,8 @@ protected void configure(final HttpSecurity http) throws Exception { .hasAuthority(AUTHORITY_NOTIFICATION) .antMatchers(HttpMethod.PUT, APPLICATION_API_CONTEXT + "/dashboard/status") .hasAuthority(AUTHORITY_NOTIFICATION) + .antMatchers(HttpMethod.POST, IMAGE_API_CONTEXT) + .hasAuthority(AUTHORITY_NOTIFICATION) .and() .addFilter(getPasswordFilter()) .requestCache() // avoid saving anonymous requests in sessions diff --git a/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java b/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java index 0d9d758..7348913 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java @@ -3,6 +3,7 @@ import lk.gov.govtech.covid19.dto.StoredImage; import lk.gov.govtech.covid19.dto.StoredImageResponse; import lk.gov.govtech.covid19.repository.CovidRepository; +import lk.gov.govtech.covid19.util.Constants; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import org.springframework.web.multipart.MultipartFile; @@ -28,7 +29,11 @@ public StoredImageResponse addImage(MultipartFile file){ byte[] bArray = imageCompressionService.compressImage(file); InputStream is = new ByteArrayInputStream(bArray); int id = repository.addImage(is,file.getOriginalFilename(),file.getSize()); - storedImageResponse = new StoredImageResponse(id,file.getOriginalFilename()); + storedImageResponse = new StoredImageResponse(); + storedImageResponse.setId(id); + storedImageResponse.setUrl(Constants.BACKEND_CONTEXT + + Constants.IMAGE_API_CONTEXT + "/image/" + id); + storedImageResponse.setName(file.getOriginalFilename()); return storedImageResponse; } catch (FileNotFoundException e) { e.printStackTrace(); diff --git a/backend/src/main/java/lk/gov/govtech/covid19/util/Constants.java b/backend/src/main/java/lk/gov/govtech/covid19/util/Constants.java index 2f824a4..298b9e4 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/util/Constants.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/util/Constants.java @@ -2,6 +2,10 @@ public class Constants { + //although defined here, actually set at `server.servlet.context-path` in + //the application.yaml file. Refer to backend/readme for more info + public static final String BACKEND_CONTEXT = "/api"; + //context for all calls related to task force ap public static final String TF_API_CONTEXT = "/taskforce"; //context for all calls related to dhis service integration From 81d4ed3728c6cc8c3457673eb1dbc9aceb5fdf9a Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Sun, 1 Nov 2020 19:43:43 +0530 Subject: [PATCH 02/12] portal: update editor to upload and preview image --- portal/src/api/index.js | 11 +++++++++ portal/src/components/views/news/News.vue | 29 ++++++++++++++++++++++ portal/src/components/views/news/news.js | 30 ++++++++++++++++++++++- 3 files changed, 69 insertions(+), 1 deletion(-) diff --git a/portal/src/api/index.js b/portal/src/api/index.js index 76bd873..2983ea1 100644 --- a/portal/src/api/index.js +++ b/portal/src/api/index.js @@ -44,4 +44,15 @@ export default { } }) }, + postMultipartFDWithToken(url, data) { + return axios({ + method: 'post', + url: '/api' + url, + data: data, + headers: { + 'content-type': 'multipart/form-data', + 'x-auth-token': store.getters['user/getToken'] + } + }) + }, } \ No newline at end of file diff --git a/portal/src/components/views/news/News.vue b/portal/src/components/views/news/News.vue index d4d39f3..52a1b68 100644 --- a/portal/src/components/views/news/News.vue +++ b/portal/src/components/views/news/News.vue @@ -184,6 +184,16 @@ + + @@ -356,6 +366,15 @@ + @@ -521,6 +540,16 @@ + + diff --git a/portal/src/components/views/news/news.js b/portal/src/components/views/news/news.js index 0dd38ec..d672fb7 100644 --- a/portal/src/components/views/news/news.js +++ b/portal/src/components/views/news/news.js @@ -15,6 +15,7 @@ import { Strike, Underline, History, + Image, } from 'tiptap-extensions' import api from '../../../api' @@ -43,6 +44,7 @@ export default { new Strike(), new Underline(), new History(), + new Image(), ], onUpdate: ({getHTML}) => { this.message.english = getHTML(); @@ -65,6 +67,7 @@ export default { new Strike(), new Underline(), new History(), + new Image(), ], onUpdate: ({getHTML}) => { this.message.sinhala = getHTML(); @@ -87,6 +90,7 @@ export default { new Strike(), new Underline(), new History(), + new Image(), ], onUpdate: ({getHTML}) => { this.message.tamil = getHTML(); @@ -107,6 +111,7 @@ export default { "bullet_list":"Bullet List", "redo":"Redo", "undo":"UnDo", + "image":"Image", }, "source":'', @@ -215,6 +220,7 @@ export default { new Strike(), new Underline(), new History(), + new Image(), ], onUpdate: ({getHTML}) => { this.message.english = getHTML(); @@ -236,6 +242,7 @@ export default { new Strike(), new Underline(), new History(), + new Image(), ], onUpdate: ({getHTML}) => { this.message.english = getHTML(); @@ -257,6 +264,7 @@ export default { new Strike(), new Underline(), new History(), + new Image(), ], onUpdate: ({getHTML}) => { this.message.english = getHTML(); @@ -289,6 +297,26 @@ export default { tamilChar() { this.charcount.tamilChar = (this.message.tamil.length)-7; - } + }, + showImagePrompt(commands) { + let inputElement = document.createElement("input"); + inputElement.setAttribute("type", "file"); + inputElement.addEventListener('change', (e) => { + if (e.target.files && e.target.files[0]) { + let anImage = e.target.files[0]; // file from input + + let formData = new FormData(); + formData.append("image", anImage, anImage.name); + api.postMultipartFDWithToken('/images', formData) + .then(response=>{ + if(response.status == 202 && response.data.url.length>0){ + const src = response.data.url; + commands.image({ src }); + } + }); + } + }) + inputElement.click(); + }, } } From b7ccce0953cf5b2d494f8d80b74c8096fd0390cf Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Mon, 2 Nov 2020 19:48:26 +0530 Subject: [PATCH 03/12] portal: new component NewsEditor --- portal/public/index.html | 1 - portal/src/components/views/news/News.vue | 31 +-- .../src/components/views/news/NewsEditor.vue | 261 ++++++++++++++++++ portal/src/components/views/news/news.js | 102 ++++--- 4 files changed, 322 insertions(+), 73 deletions(-) create mode 100644 portal/src/components/views/news/NewsEditor.vue diff --git a/portal/public/index.html b/portal/public/index.html index af3e6c5..928948b 100644 --- a/portal/public/index.html +++ b/portal/public/index.html @@ -22,7 +22,6 @@ MyHealth Sri Lanka Management Portal-login - diff --git a/portal/src/components/views/news/News.vue b/portal/src/components/views/news/News.vue index 52a1b68..cae83eb 100644 --- a/portal/src/components/views/news/News.vue +++ b/portal/src/components/views/news/News.vue @@ -44,10 +44,10 @@
- -
+ +
@@ -229,7 +222,7 @@
-
+
- @@ -403,7 +396,7 @@
-
+
- @@ -565,7 +558,7 @@
-
diff --git a/portal/src/components/views/news/NewsEditor.vue b/portal/src/components/views/news/NewsEditor.vue new file mode 100644 index 0000000..d6e4b87 --- /dev/null +++ b/portal/src/components/views/news/NewsEditor.vue @@ -0,0 +1,261 @@ + + + \ No newline at end of file diff --git a/portal/src/components/views/news/news.js b/portal/src/components/views/news/news.js index d672fb7..9616709 100644 --- a/portal/src/components/views/news/news.js +++ b/portal/src/components/views/news/news.js @@ -1,6 +1,7 @@ import Vue from 'vue' +import NewsEditor from './NewsEditor' import { required, maxLength } from 'vuelidate/lib/validators'; -import { Editor, EditorContent ,EditorMenuBar } from 'tiptap'; +import { Editor, EditorContent, EditorMenuBar } from 'tiptap'; import { Blockquote, HardBreak, @@ -25,10 +26,12 @@ export default { components: { EditorContent, EditorMenuBar, + NewsEditor }, data() { return { - submitStatus: false, + submitBtnDisable: false, + imageBtnDisable: false, english: new Editor({ extensions: [ new Blockquote(), @@ -151,10 +154,10 @@ export default { }, }, message:{ - english:{ - required, - maxLength: maxLength(2500) - }, + // english:{ + // required, + // maxLength: maxLength(2500) + // }, sinhala:{ maxLength: maxLength(2500) }, @@ -167,10 +170,10 @@ export default { methods:{ saveAlerts(){ this.$v.$touch(); - if (this.$v.$invalid){ + if (this.$v.$invalid || this.$refs.englishEditor.invalid()){ return }else{ - this.submitStatus = true; + this.submitBtnDisable = true; api.postJsonWithToken('/notification/alert/add',{ "source":this.source, title:{ @@ -179,7 +182,7 @@ export default { "tamil":this.title.tamil, }, message:{ - "english":this.message.english, + "english":this.$refs.englishEditor.message, "sinhala":this.message.sinhala, "tamil":this.message.tamil, } @@ -200,33 +203,10 @@ export default { this.charcount.sinhalaChar =0; this.charcount.englishChar =0; this.charcount.tamilChar =0; - this.submitStatus = false; this.$v.$reset(); - this.english.destroy(); + this.$refs.englishEditor.clearContent(); this.sinhala.destroy(); this.tamil.destroy(); - this.english =new Editor({ - extensions: [ - new Blockquote(), - new BulletList(), - new HardBreak(), - new Heading({levels: [1, 2, 3]}), - new HorizontalRule(), - new ListItem(), - new OrderedList(), - new Link(), - new Bold(), - new Italic(), - new Strike(), - new Underline(), - new History(), - new Image(), - ], - onUpdate: ({getHTML}) => { - this.message.english = getHTML(); - this.englishChar(); - }, - }); this.sinhala =new Editor({ extensions: [ new Blockquote(), @@ -273,6 +253,7 @@ export default { }); } + this.submitBtnDisable = false; }).catch(error =>{ Vue.swal({ title: 'Something Went Wrong!', @@ -281,8 +262,8 @@ export default { if (error.response) { console.log(error.response.status); } - this.submitStatus =false; - }) + this.submitBtnDisable =false; + }); } }, @@ -298,25 +279,40 @@ export default { { this.charcount.tamilChar = (this.message.tamil.length)-7; }, - showImagePrompt(commands) { + showImagePrompt(commands) { + this.imageBtnDisable = true; let inputElement = document.createElement("input"); - inputElement.setAttribute("type", "file"); - inputElement.addEventListener('change', (e) => { - if (e.target.files && e.target.files[0]) { - let anImage = e.target.files[0]; // file from input - - let formData = new FormData(); - formData.append("image", anImage, anImage.name); - api.postMultipartFDWithToken('/images', formData) - .then(response=>{ - if(response.status == 202 && response.data.url.length>0){ - const src = response.data.url; - commands.image({ src }); - } - }); - } - }) - inputElement.click(); + inputElement.setAttribute("type", "file"); + inputElement.addEventListener('change', (e) => { + if (e.target.files && e.target.files[0]) { + let anImage = e.target.files[0]; // file from input + + let formData = new FormData(); + formData.append("image", anImage, anImage.name); + api.postMultipartFDWithToken( + '/images', + formData + ).then(response=>{ + if(response.status == 202 && response.data.url.length>0){ + const src = response.data.url; + commands.image({ src }); + } + this.imageBtnDisable = false; + }).catch(()=>{ + Vue.swal.mixin({ + toast: true, + position: 'top-end', + showConfirmButton: false, + timer: 2000 + }).fire({ + title: 'Error uploading image', + icon: 'error' + }); + this.submitBtnDisable = false; + }); + } + }) + inputElement.click(); }, } } From f10aa7bae59a09b6a3565d73fc4b6f1b95d24ac6 Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Tue, 3 Nov 2020 19:37:07 +0530 Subject: [PATCH 04/12] portal: replace sinhala and tamil editors with new component, update validations --- portal/src/components/views/news/News.vue | 492 +----------------- .../src/components/views/news/NewsEditor.vue | 147 +----- portal/src/components/views/news/news.js | 283 ++-------- .../src/components/views/news/newsEditor.js | 140 +++++ 4 files changed, 201 insertions(+), 861 deletions(-) create mode 100644 portal/src/components/views/news/newsEditor.js diff --git a/portal/src/components/views/news/News.vue b/portal/src/components/views/news/News.vue index cae83eb..69ccecc 100644 --- a/portal/src/components/views/news/News.vue +++ b/portal/src/components/views/news/News.vue @@ -28,11 +28,11 @@
- +
-

Title is required

@@ -41,169 +41,20 @@
+
- - + +
-
+
@@ -220,166 +71,14 @@
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
-

{{ charcount.sinhalaChar }} characters

-
+ +
-
+
@@ -395,174 +94,19 @@
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
-

{{ charcount.tamilChar }} characters

-
-
-

Tamil Alerts must have at most 2500 characters

-
+ +
-
+ +
-
diff --git a/portal/src/components/views/news/NewsEditor.vue b/portal/src/components/views/news/NewsEditor.vue index d6e4b87..6f2a4fc 100644 --- a/portal/src/components/views/news/NewsEditor.vue +++ b/portal/src/components/views/news/NewsEditor.vue @@ -118,144 +118,17 @@
+ -
-

{{ charcount }} html characters

+
+
-
-

English Alerts is required

-

English Alerts must have at most 2500 characters

-
-
+
+

{{ requiredErrorMessage }}

+

{{ maxLengthErrorMessage }}

+

{{ message.length }} html characters

+
+
- \ No newline at end of file + \ No newline at end of file diff --git a/portal/src/components/views/news/news.js b/portal/src/components/views/news/news.js index 9616709..2d88f62 100644 --- a/portal/src/components/views/news/news.js +++ b/portal/src/components/views/news/news.js @@ -1,138 +1,22 @@ import Vue from 'vue' import NewsEditor from './NewsEditor' import { required, maxLength } from 'vuelidate/lib/validators'; -import { Editor, EditorContent, EditorMenuBar } from 'tiptap'; -import { - Blockquote, - HardBreak, - Heading, - HorizontalRule, - OrderedList, - BulletList, - ListItem, - Bold, - Italic, - Link, - Strike, - Underline, - History, - Image, -} from 'tiptap-extensions' import api from '../../../api' export default { name: 'News', components: { - EditorContent, - EditorMenuBar, NewsEditor }, data() { return { submitBtnDisable: false, - imageBtnDisable: false, - english: new Editor({ - extensions: [ - new Blockquote(), - new BulletList(), - new HardBreak(), - new Heading({levels: [1, 2, 3]}), - new HorizontalRule(), - new ListItem(), - new OrderedList(), - new Link(), - new Bold(), - new Italic(), - new Strike(), - new Underline(), - new History(), - new Image(), - ], - onUpdate: ({getHTML}) => { - this.message.english = getHTML(); - this.englishChar(); - }, - }), - - sinhala: new Editor({ - extensions: [ - new Blockquote(), - new BulletList(), - new HardBreak(), - new Heading({levels: [1, 2, 3]}), - new HorizontalRule(), - new ListItem(), - new OrderedList(), - new Link(), - new Bold(), - new Italic(), - new Strike(), - new Underline(), - new History(), - new Image(), - ], - onUpdate: ({getHTML}) => { - this.message.sinhala = getHTML(); - this.sinhalaChar(); - }, - }), - - tamil: new Editor({ - extensions: [ - new Blockquote(), - new BulletList(), - new HardBreak(), - new Heading({levels: [1, 2, 3]}), - new HorizontalRule(), - new ListItem(), - new OrderedList(), - new Link(), - new Bold(), - new Italic(), - new Strike(), - new Underline(), - new History(), - new Image(), - ], - onUpdate: ({getHTML}) => { - this.message.tamil = getHTML(); - this.tamilChar(); - }, - }), - - buttons:{ - "bold":"Bold", - "italic":"Italic", - "strike":"Strike", - "underline":"Underline", - "paragraph":"Paragraph", - "H1":"H1", - "H2":"H2", - "H3":"H3", - "order_list":"Order List", - "bullet_list":"Bullet List", - "redo":"Redo", - "undo":"UnDo", - "image":"Image", - }, - "source":'', - - title:{ - "english":"", - "sinhala":"", - "tamil":"", - }, - - message:{ - "english":"", - "sinhala":"", - "tamil":"", - }, - charcount:{ - "englishChar":0, - "sinhalaChar":0, - "tamilChar":0, + source: "", + title: { + english: "", + sinhala: "", + tamil: "", }, } }, @@ -153,38 +37,36 @@ export default { maxLength: maxLength(100) }, }, - message:{ - // english:{ - // required, - // maxLength: maxLength(2500) - // }, - sinhala:{ - maxLength: maxLength(2500) - }, - tamil:{ - maxLength: maxLength(2500) - }, - }, }, methods:{ saveAlerts(){ this.$v.$touch(); - if (this.$v.$invalid || this.$refs.englishEditor.invalid()){ + if (this.$v.$invalid + || this.$refs.englishEditor.isInvalid() + || this.$refs.sinhalaEditor.isInvalid() + || this.$refs.tamilEditor.isInvalid()) { + if(this.$refs.sinhalaEditor.isInvalid()) console.log("sinhala"); return - }else{ + } else { this.submitBtnDisable = true; + + let sinhalaMessageLength = this.$refs.sinhalaEditor.message.length; + let sinhalaMessage = sinhalaMessageLength>7? this.$refs.sinhalaEditor.message : ""; //avoid empty paragraph + let tamilMessageLength = this.$refs.tamilEditor.message.length; + let tamilMessage = tamilMessageLength>7? this.$refs.tamilEditor.message : ""; //avoid empty paragraph + api.postJsonWithToken('/notification/alert/add',{ - "source":this.source, - title:{ - "english":this.title.english, - "sinhala":this.title.sinhala, - "tamil":this.title.tamil, + source: this.source, + title: { + english: this.title.english, + sinhala: this.title.sinhala, + tamil: this.title.tamil, }, message:{ - "english":this.$refs.englishEditor.message, - "sinhala":this.message.sinhala, - "tamil":this.message.tamil, + english: this.$refs.englishEditor.message, + sinhala: sinhalaMessage, + tamil: tamilMessage, } } ).then(response=>{ @@ -193,65 +75,14 @@ export default { title: 'New Alert Was Created', icon: 'success' }); - this.source =''; - this.title.english=''; - this.title.sinhala=''; - this.title.tamil=''; - this.message.english=''; - this.message.sinhala=''; - this.message.tamil=''; - this.charcount.sinhalaChar =0; - this.charcount.englishChar =0; - this.charcount.tamilChar =0; - this.$v.$reset(); - this.$refs.englishEditor.clearContent(); - this.sinhala.destroy(); - this.tamil.destroy(); - this.sinhala =new Editor({ - extensions: [ - new Blockquote(), - new BulletList(), - new HardBreak(), - new Heading({levels: [1, 2, 3]}), - new HorizontalRule(), - new ListItem(), - new OrderedList(), - new Link(), - new Bold(), - new Italic(), - new Strike(), - new Underline(), - new History(), - new Image(), - ], - onUpdate: ({getHTML}) => { - this.message.english = getHTML(); - this.englishChar(); - }, - }); - this.tamil =new Editor({ - extensions: [ - new Blockquote(), - new BulletList(), - new HardBreak(), - new Heading({levels: [1, 2, 3]}), - new HorizontalRule(), - new ListItem(), - new OrderedList(), - new Link(), - new Bold(), - new Italic(), - new Strike(), - new Underline(), - new History(), - new Image(), - ], - onUpdate: ({getHTML}) => { - this.message.english = getHTML(); - this.englishChar(); - }, - }); - + this.source =''; + this.title.english=''; + this.title.sinhala=''; + this.title.tamil=''; + this.$v.$reset(); + this.$refs.englishEditor.clearContent(); + this.$refs.sinhalaEditor.clearContent(); + this.$refs.tamilEditor.clearContent(); } this.submitBtnDisable = false; }).catch(error =>{ @@ -265,54 +96,6 @@ export default { this.submitBtnDisable =false; }); } - - }, - sinhalaChar() - { - this.charcount.sinhalaChar = (this.message.sinhala.length)-7; - }, - englishChar() - { - this.charcount.englishChar = (this.message.english.length)-7; - }, - tamilChar() - { - this.charcount.tamilChar = (this.message.tamil.length)-7; - }, - showImagePrompt(commands) { - this.imageBtnDisable = true; - let inputElement = document.createElement("input"); - inputElement.setAttribute("type", "file"); - inputElement.addEventListener('change', (e) => { - if (e.target.files && e.target.files[0]) { - let anImage = e.target.files[0]; // file from input - - let formData = new FormData(); - formData.append("image", anImage, anImage.name); - api.postMultipartFDWithToken( - '/images', - formData - ).then(response=>{ - if(response.status == 202 && response.data.url.length>0){ - const src = response.data.url; - commands.image({ src }); - } - this.imageBtnDisable = false; - }).catch(()=>{ - Vue.swal.mixin({ - toast: true, - position: 'top-end', - showConfirmButton: false, - timer: 2000 - }).fire({ - title: 'Error uploading image', - icon: 'error' - }); - this.submitBtnDisable = false; - }); - } - }) - inputElement.click(); }, } } diff --git a/portal/src/components/views/news/newsEditor.js b/portal/src/components/views/news/newsEditor.js new file mode 100644 index 0000000..c64edc1 --- /dev/null +++ b/portal/src/components/views/news/newsEditor.js @@ -0,0 +1,140 @@ +import Vue from 'vue'; +import { maxLength } from 'vuelidate/lib/validators'; +import { Editor, EditorContent, EditorMenuBar } from 'tiptap'; +import { + Blockquote, + HardBreak, + Heading, + HorizontalRule, + OrderedList, + BulletList, + ListItem, + Bold, + Italic, + Link, + Strike, + Underline, + History, + Image, +} from 'tiptap-extensions' +import api from '../../../api'; + +export default { + name: 'NewsEditor', + components: { + EditorContent, + EditorMenuBar, + }, + props: ['isEnglish','requiredErrorMessage', 'maxLengthErrorMessage'], + computed: { + isRequired: function () { + return this.isEnglish==""; + } + }, + data() { + return { + imageBtnDisable: false, + message: "", + newsEditor: new Editor({ + extensions: [ + new Blockquote(), + new BulletList(), + new HardBreak(), + new Heading({ levels: [1, 2, 3] }), + new HorizontalRule(), + new ListItem(), + new OrderedList(), + new Link(), + new Bold(), + new Italic(), + new Strike(), + new Underline(), + new History(), + new Image(), + ], + onUpdate: ({ getHTML }) => { + this.message = getHTML(); + this.$v.message.$touch(); + }, + }), + buttons: { + bold: "Bold", + italic: "Italic", + strike: "Strike", + underline: "Underline", + paragraph: "Paragraph", + H1: "H1", + H2: "H2", + H3: "H3", + order_list: "Numbered List", + bullet_list: "Bullet List", + redo: "Redo", + undo: "UnDo", + image: "Image", + }, + } + }, + validations: { + message: { + required: (function () { + if(this.isRequired) { + return this.message.length > 7; // atleast one letter -->

a

+ } else { + return true; // no validations here + } + }), + maxLength: maxLength(2500) + }, + }, + methods: { + clearContent() { + this.newsEditor.clearContent(true); + this.$v.$reset(); + }, + isInvalid() { + if (this.isRequired) { + this.$v.$touch(); //sets $dirty in vualidate even if the field is not touched by the user + } + return this.$v.$invalid; + }, + showImagePrompt(commands) { + this.imageBtnDisable = true; + let inputElement = document.createElement("input"); + inputElement.setAttribute("type", "file"); + inputElement.addEventListener("change", (e) => { + if (e.target.files && e.target.files[0]) { + let anImage = e.target.files[0]; // file from input + + let formData = new FormData(); + formData.append("image", anImage, anImage.name); + api.postMultipartFDWithToken( + '/images', + formData + ).then(response => { + if (response.status == 202 && response.data.url.length > 0) { + const src = response.data.url; + commands.image({ src }); + this.imageBtnDisable = false; + } + }).catch(() => { + Vue.swal.mixin({ + toast: true, + position: 'top-end', + showConfirmButton: false, + timer: 2000, + }) + .fire({ + title: "Error uploading image", + icon: "error", + }); + this.submitBtnDisable = false; + }); + } + }) + inputElement.click(); + }, + beforeDestroy() { + this.editor.destroy(); + }, + } +}; \ No newline at end of file From c47e57d4d1b335b79a640af1253bd2c76d8d01a4 Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Thu, 5 Nov 2020 20:50:12 +0530 Subject: [PATCH 05/12] backend: add dependencies, validation to dashboard status update, its testing, an error handler --- backend/pom.xml | 25 +++++ .../controller/ApplicationController.java | 30 ++++-- .../covid19/dto/AlertNotificationRequest.java | 10 ++ .../govtech/covid19/dto/ErrorResponse.java | 11 ++ .../covid19/dto/UpdateStatusRequest.java | 19 +++- .../exceptions/CustomExceptionHandler.java | 29 +++++ .../controller/ApplicationControllerTest.java | 102 ++++++++++++++++++ 7 files changed, 211 insertions(+), 15 deletions(-) create mode 100644 backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java create mode 100644 backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java create mode 100644 backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java diff --git a/backend/pom.xml b/backend/pom.xml index 9c87602..75bf092 100644 --- a/backend/pom.xml +++ b/backend/pom.xml @@ -131,6 +131,31 @@ org.springframework.session spring-session-jdbc + + org.springframework.boot + spring-boot-starter-validation + + + com.googlecode.owasp-java-html-sanitizer + owasp-java-html-sanitizer + 20200713.1 + + + org.springframework.boot + spring-boot-starter-test + test + + + org.junit.vintage + junit-vintage-engine + + + + + org.springframework.security + spring-security-test + test + diff --git a/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java b/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java index b9c3dd5..66c589d 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java @@ -1,16 +1,17 @@ package lk.gov.govtech.covid19.controller; -import lk.gov.govtech.covid19.dto.AlertNotificationResponse; -import lk.gov.govtech.covid19.dto.CaseNotificationResponse; -import lk.gov.govtech.covid19.dto.StatusResponse; -import lk.gov.govtech.covid19.dto.UpdateStatusRequest; +import lk.gov.govtech.covid19.dto.*; import lk.gov.govtech.covid19.service.ApplicationService; import lk.gov.govtech.covid19.util.Constants; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; +import org.springframework.validation.BindingResult; import org.springframework.web.bind.annotation.*; +import javax.validation.Valid; + /** * Controller class for all task force application related apis */ @@ -81,16 +82,23 @@ public ResponseEntity getSatus() { //Update Covid-19 Status @PutMapping(path = "/dashboard/status", consumes = "application/json", produces = "application/json") - public ResponseEntity updateStatus(@RequestBody UpdateStatusRequest request){ - - if(request==null){ - log.error("Empty request found"); - return ResponseEntity.noContent().build(); - }else { + public ResponseEntity updateStatus(@RequestBody @Valid UpdateStatusRequest request){//, + //BindingResult bindingResult){ + +// if(bindingResult.hasErrors()){ +// log.error("Error while updating dashboard status. {} validation error(s)", +// bindingResult.getErrorCount()); +// +// ErrorResponse errorResponse = new ErrorResponse(); +// errorResponse.setMessage("Invalid values provided"); +// return ResponseEntity.badRequest() +// .contentType(MediaType.APPLICATION_JSON) +// .body(errorResponse); +// }else { log.info("Dashboard status updated"); applicationService.updateStatus(request); return ResponseEntity.accepted().build(); - } +// } } } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java b/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java index 10fd9a6..d74ad50 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java @@ -2,23 +2,33 @@ import lombok.Data; +import javax.validation.constraints.NotBlank; +import javax.validation.constraints.Size; + @Data public class AlertNotificationRequest { + @NotBlank @Size(max=45) private String source; private Title title; private Message message; @Data public static class Title { + @NotBlank @Size(max=100) private String english; + @Size(max=100) private String sinhala; + @Size(max=100) private String tamil; } @Data public static class Message { + @NotBlank @Size(min=8, max=2500) private String english; + @Size(min=8, max=2500) private String sinhala; + @Size(min=8, max=2500) private String tamil; } } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java b/backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java new file mode 100644 index 0000000..d986e22 --- /dev/null +++ b/backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java @@ -0,0 +1,11 @@ +package lk.gov.govtech.covid19.dto; + +import lombok.Data; +import org.springframework.http.HttpStatus; + +@Data +public class ErrorResponse { + private HttpStatus status; + private String error; + private String message; +} diff --git a/backend/src/main/java/lk/gov/govtech/covid19/dto/UpdateStatusRequest.java b/backend/src/main/java/lk/gov/govtech/covid19/dto/UpdateStatusRequest.java index 1e7f78b..a0f2478 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/dto/UpdateStatusRequest.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/dto/UpdateStatusRequest.java @@ -2,10 +2,21 @@ import lombok.Data; +import javax.validation.constraints.Max; +import javax.validation.constraints.Min; +import javax.validation.constraints.NotNull; + @Data public class UpdateStatusRequest { - private int lk_total_case; - private int lk_recovered_case; - private int lk_total_deaths; - private int lk_total_suspect; + @NotNull @Min(0) @Max(22000000) + private Integer lk_total_case; + + @NotNull @Min(0) @Max(22000000) + private Integer lk_recovered_case; + + @NotNull @Min(0) @Max(22000000) + private Integer lk_total_deaths; + + @NotNull @Min(0) @Max(22000000) + private Integer lk_total_suspect; } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java new file mode 100644 index 0000000..115d60a --- /dev/null +++ b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java @@ -0,0 +1,29 @@ +package lk.gov.govtech.covid19.exceptions; + +import lk.gov.govtech.covid19.dto.ErrorResponse; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.http.converter.HttpMessageNotReadableException; +import org.springframework.web.bind.annotation.ControllerAdvice; +import org.springframework.web.context.request.WebRequest; +import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; + +@ControllerAdvice +public class CustomExceptionHandler extends ResponseEntityExceptionHandler { + + @Override + protected ResponseEntity handleHttpMessageNotReadable(HttpMessageNotReadableException ex, + HttpHeaders headers, HttpStatus status, WebRequest request) { + String message = "Malformed JSON request"; + return buildResponseEntity(HttpStatus.BAD_REQUEST, message); + } + + private ResponseEntity buildResponseEntity(HttpStatus status, String message){ + ErrorResponse errorResponse = new ErrorResponse(); + errorResponse.setStatus(status); + errorResponse.setMessage(message); + return new ResponseEntity<>(errorResponse, status); + } +} diff --git a/backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java b/backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java new file mode 100644 index 0000000..3882855 --- /dev/null +++ b/backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java @@ -0,0 +1,102 @@ +package lk.gov.govtech.covid19.controller; + +import lk.gov.govtech.covid19.dto.UpdateStatusRequest; +import lk.gov.govtech.covid19.service.ApplicationService; +import org.json.JSONObject; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.http.MediaType; +import org.springframework.security.test.context.support.WithMockUser; +import org.springframework.test.web.servlet.MockMvc; + +import static lk.gov.govtech.covid19.util.Constants.APPLICATION_API_CONTEXT; +import static lk.gov.govtech.covid19.util.Constants.AUTHORITY_NOTIFICATION; +import static org.hamcrest.Matchers.containsString; +import static org.mockito.Mockito.doNothing; +import static org.mockito.Mockito.when; +import static org.springframework.test.web.client.match.MockRestRequestMatchers.content; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@SpringBootTest +@AutoConfigureMockMvc +public class ApplicationControllerTest { + + @Autowired + private MockMvc mockMvc; + + @MockBean + private ApplicationService applicationService; + + @Test + @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) + public void put_dashboardStatus_success() throws Exception { + JSONObject json = new JSONObject(); + json.put("lk_total_case", 85); + json.put("lk_recovered_case", 85); + json.put("lk_total_deaths", 85); + json.put("lk_total_suspect", 85); + + UpdateStatusRequest dummy = new UpdateStatusRequest(); + doNothing().when(applicationService).updateStatus(dummy); + + this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isAccepted()); + } + + @Test + @WithMockUser + public void put_dashboardStatus_unauthorized() throws Exception { + JSONObject json = new JSONObject(); + json.put("lk_total_case", 85); + json.put("lk_recovered_case", 85); + json.put("lk_total_deaths", 85); + json.put("lk_total_suspect", 85); + + UpdateStatusRequest dummy = new UpdateStatusRequest(); + doNothing().when(applicationService).updateStatus(dummy); + + this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isForbidden()); + } + + @Test + @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) + public void put_dashboardStatus_noContent() throws Exception { + UpdateStatusRequest dummy = new UpdateStatusRequest(); + doNothing().when(applicationService).updateStatus(dummy); + + this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isBadRequest()); + this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") + .contentType(MediaType.APPLICATION_JSON) + .content("")) + .andExpect(status().isBadRequest()); + } + + @Test + @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) + public void put_dashboardStatus_missingField() throws Exception { + JSONObject json = new JSONObject(); + //missing field lk_total_case + json.put("lk_recovered_case", 85); + json.put("lk_total_deaths", 85); + json.put("lk_total_suspect", 85); + + UpdateStatusRequest dummy = new UpdateStatusRequest(); + doNothing().when(applicationService).updateStatus(dummy); + + this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isBadRequest()); + } +} From d595ed545c4b5798b485f2294de07d8d1109af88 Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Fri, 6 Nov 2020 13:49:38 +0530 Subject: [PATCH 06/12] backend: update exception handler, application controller tests --- .../controller/ApplicationController.java | 22 ++-------- .../govtech/covid19/dto/ErrorResponse.java | 11 ----- .../exceptions/CustomExceptionHandler.java | 41 +++++++++++-------- .../controller/ApplicationControllerTest.java | 41 ++++++++++++------- 4 files changed, 54 insertions(+), 61 deletions(-) delete mode 100644 backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java diff --git a/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java b/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java index 66c589d..4596c94 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/controller/ApplicationController.java @@ -82,23 +82,9 @@ public ResponseEntity getSatus() { //Update Covid-19 Status @PutMapping(path = "/dashboard/status", consumes = "application/json", produces = "application/json") - public ResponseEntity updateStatus(@RequestBody @Valid UpdateStatusRequest request){//, - //BindingResult bindingResult){ - -// if(bindingResult.hasErrors()){ -// log.error("Error while updating dashboard status. {} validation error(s)", -// bindingResult.getErrorCount()); -// -// ErrorResponse errorResponse = new ErrorResponse(); -// errorResponse.setMessage("Invalid values provided"); -// return ResponseEntity.badRequest() -// .contentType(MediaType.APPLICATION_JSON) -// .body(errorResponse); -// }else { - log.info("Dashboard status updated"); - applicationService.updateStatus(request); - return ResponseEntity.accepted().build(); -// } - + public ResponseEntity updateStatus(@RequestBody @Valid UpdateStatusRequest request){ + log.info("Dashboard status updated"); + applicationService.updateStatus(request); + return ResponseEntity.accepted().build(); } } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java b/backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java deleted file mode 100644 index d986e22..0000000 --- a/backend/src/main/java/lk/gov/govtech/covid19/dto/ErrorResponse.java +++ /dev/null @@ -1,11 +0,0 @@ -package lk.gov.govtech.covid19.dto; - -import lombok.Data; -import org.springframework.http.HttpStatus; - -@Data -public class ErrorResponse { - private HttpStatus status; - private String error; - private String message; -} diff --git a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java index 115d60a..f1b30e5 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java @@ -1,29 +1,36 @@ package lk.gov.govtech.covid19.exceptions; -import lk.gov.govtech.covid19.dto.ErrorResponse; -import org.springframework.http.HttpHeaders; +import lombok.extern.slf4j.Slf4j; import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; +import org.springframework.http.converter.HttpMessageConversionException; import org.springframework.http.converter.HttpMessageNotReadableException; +import org.springframework.web.bind.MethodArgumentNotValidException; import org.springframework.web.bind.annotation.ControllerAdvice; -import org.springframework.web.context.request.WebRequest; -import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; +import javax.servlet.http.HttpServletRequest; + +@Slf4j @ControllerAdvice -public class CustomExceptionHandler extends ResponseEntityExceptionHandler { +public class CustomExceptionHandler { + + @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Malformed JSON request") + @ExceptionHandler(value = {HttpMessageNotReadableException.class}) + public void handleMalformedRequestRelatedExceptions(HttpServletRequest request, Exception e) { + log.warn("Malformed JSON request"); + } - @Override - protected ResponseEntity handleHttpMessageNotReadable(HttpMessageNotReadableException ex, - HttpHeaders headers, HttpStatus status, WebRequest request) { - String message = "Malformed JSON request"; - return buildResponseEntity(HttpStatus.BAD_REQUEST, message); + @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Invalid request. Value missing or invalid.") + @ExceptionHandler(value = {MethodArgumentNotValidException.class, HttpMessageConversionException.class}) + public void handleValidationException(HttpServletRequest request, Exception e) { + log.warn("Invalid request. Value missing or invalid."); } - private ResponseEntity buildResponseEntity(HttpStatus status, String message){ - ErrorResponse errorResponse = new ErrorResponse(); - errorResponse.setStatus(status); - errorResponse.setMessage(message); - return new ResponseEntity<>(errorResponse, status); + @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "Unknown error state of server") + @ExceptionHandler(value = { Exception.class }) + public void defaultErrorHandler(HttpServletRequest request, Exception e) throws Exception { + log.error("Exception mapping failure" + e.getClass().getName() + + ", message: " + e.getMessage()); } } diff --git a/backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java b/backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java index 3882855..78ebc24 100644 --- a/backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java +++ b/backend/src/test/java/lk/gov/govtech/covid19/controller/ApplicationControllerTest.java @@ -14,10 +14,7 @@ import static lk.gov.govtech.covid19.util.Constants.APPLICATION_API_CONTEXT; import static lk.gov.govtech.covid19.util.Constants.AUTHORITY_NOTIFICATION; -import static org.hamcrest.Matchers.containsString; import static org.mockito.Mockito.doNothing; -import static org.mockito.Mockito.when; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.content; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; @@ -40,8 +37,7 @@ public void put_dashboardStatus_success() throws Exception { json.put("lk_total_deaths", 85); json.put("lk_total_suspect", 85); - UpdateStatusRequest dummy = new UpdateStatusRequest(); - doNothing().when(applicationService).updateStatus(dummy); + doNothing().when(applicationService).updateStatus(new UpdateStatusRequest()); this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") .contentType(MediaType.APPLICATION_JSON) @@ -58,20 +54,18 @@ public void put_dashboardStatus_unauthorized() throws Exception { json.put("lk_total_deaths", 85); json.put("lk_total_suspect", 85); - UpdateStatusRequest dummy = new UpdateStatusRequest(); - doNothing().when(applicationService).updateStatus(dummy); + doNothing().when(applicationService).updateStatus(new UpdateStatusRequest()); this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") - .contentType(MediaType.APPLICATION_JSON) - .content(json.toString())) + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) .andExpect(status().isForbidden()); } @Test @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) public void put_dashboardStatus_noContent() throws Exception { - UpdateStatusRequest dummy = new UpdateStatusRequest(); - doNothing().when(applicationService).updateStatus(dummy); + doNothing().when(applicationService).updateStatus(new UpdateStatusRequest()); this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") .contentType(MediaType.APPLICATION_JSON)) @@ -91,12 +85,29 @@ public void put_dashboardStatus_missingField() throws Exception { json.put("lk_total_deaths", 85); json.put("lk_total_suspect", 85); - UpdateStatusRequest dummy = new UpdateStatusRequest(); - doNothing().when(applicationService).updateStatus(dummy); + doNothing().when(applicationService).updateStatus(new UpdateStatusRequest()); this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") - .contentType(MediaType.APPLICATION_JSON) - .content(json.toString())) + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) .andExpect(status().isBadRequest()); } + + @Test + @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) + public void put_dashboardStatus_invalidField() throws Exception { + JSONObject json = new JSONObject(); + json.put("lk_total_case", 1000000000); + json.put("lk_recovered_case", 85); + json.put("lk_total_deaths", 85); + json.put("lk_total_suspect", 85); + + doNothing().when(applicationService).updateStatus(new UpdateStatusRequest()); + + this.mockMvc.perform(put(APPLICATION_API_CONTEXT + "/dashboard/status") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isBadRequest()); + } + } From c2eb5c532185ef5ba944905f744f048fee5dae37 Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Fri, 6 Nov 2020 20:26:52 +0530 Subject: [PATCH 07/12] backend: add notification controller validations and tests --- .../controller/NotificationController.java | 6 +- .../covid19/dto/AlertNotificationRequest.java | 6 +- .../exceptions/CustomExceptionHandler.java | 4 +- .../NotificationControllerTest.java | 107 ++++++++++++++++++ 4 files changed, 118 insertions(+), 5 deletions(-) create mode 100644 backend/src/test/java/lk/gov/govtech/covid19/controller/NotificationControllerTest.java diff --git a/backend/src/main/java/lk/gov/govtech/covid19/controller/NotificationController.java b/backend/src/main/java/lk/gov/govtech/covid19/controller/NotificationController.java index 87837af..fbc7031 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/controller/NotificationController.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/controller/NotificationController.java @@ -9,6 +9,8 @@ import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.*; +import javax.validation.Valid; + @Slf4j @RestController @RequestMapping(value = Constants.NOTIFICATION_API_CONTEXT) @@ -18,7 +20,7 @@ public class NotificationController { NotificationService notificationService; @PostMapping(path = "/alert/add", consumes = "application/json", produces = "application/json") - public ResponseEntity addNewAlert(@RequestBody AlertNotificationRequest request){ + public ResponseEntity addNewAlert(@RequestBody @Valid AlertNotificationRequest request){ log.info("New alert added with title {}", request.getTitle().getEnglish()); notificationService.addAlertNotificaiton(request); @@ -26,7 +28,7 @@ public ResponseEntity addNewAlert(@RequestBody AlertNotificationRequest request) } @PutMapping(path = "/alert/{alertId}", consumes = "application/json") - public ResponseEntity addNewAlert(@PathVariable("alertId") String alertId, @RequestBody AlertNotificationRequest request){ + public ResponseEntity addNewAlert(@PathVariable("alertId") String alertId, @RequestBody @Valid AlertNotificationRequest request){ boolean success = notificationService.updateAlertNotification(alertId, request); if (success) { log.info("Update alert with id:{} title:{}", alertId, request.getTitle().getEnglish()); diff --git a/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java b/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java index d74ad50..4746502 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java @@ -2,14 +2,16 @@ import lombok.Data; -import javax.validation.constraints.NotBlank; -import javax.validation.constraints.Size; +import javax.validation.Valid; +import javax.validation.constraints.*; @Data public class AlertNotificationRequest { @NotBlank @Size(max=45) private String source; + @NotNull @Valid private Title title; + @NotNull @Valid private Message message; @Data diff --git a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java index f1b30e5..301f04b 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java @@ -1,6 +1,7 @@ package lk.gov.govtech.covid19.exceptions; import lombok.extern.slf4j.Slf4j; +import org.springframework.dao.DataIntegrityViolationException; import org.springframework.http.HttpStatus; import org.springframework.http.converter.HttpMessageConversionException; import org.springframework.http.converter.HttpMessageNotReadableException; @@ -22,7 +23,8 @@ public void handleMalformedRequestRelatedExceptions(HttpServletRequest request, } @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Invalid request. Value missing or invalid.") - @ExceptionHandler(value = {MethodArgumentNotValidException.class, HttpMessageConversionException.class}) + @ExceptionHandler(value = {MethodArgumentNotValidException.class, HttpMessageConversionException.class, + DataIntegrityViolationException.class}) public void handleValidationException(HttpServletRequest request, Exception e) { log.warn("Invalid request. Value missing or invalid."); } diff --git a/backend/src/test/java/lk/gov/govtech/covid19/controller/NotificationControllerTest.java b/backend/src/test/java/lk/gov/govtech/covid19/controller/NotificationControllerTest.java new file mode 100644 index 0000000..61aa830 --- /dev/null +++ b/backend/src/test/java/lk/gov/govtech/covid19/controller/NotificationControllerTest.java @@ -0,0 +1,107 @@ +package lk.gov.govtech.covid19.controller; + +import lk.gov.govtech.covid19.dto.AlertNotificationRequest; +import lk.gov.govtech.covid19.service.NotificationService; +import org.json.JSONObject; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.http.MediaType; +import org.springframework.security.test.context.support.WithMockUser; +import org.springframework.test.web.servlet.MockMvc; + +import static lk.gov.govtech.covid19.util.Constants.*; +import static org.mockito.Mockito.doNothing; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +@SpringBootTest +@AutoConfigureMockMvc +public class NotificationControllerTest { + @Autowired + private MockMvc mockMvc; + + @MockBean + NotificationService notificationService; + + @Test + @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) + public void post_notificationAlert_success() throws Exception { + JSONObject json = new JSONObject(); + JSONObject title = new JSONObject(); + JSONObject message = new JSONObject(); + + title.put("english", "english title"); + message.put("english", "english message"); + + json.put("source", "the source"); + json.put("title", title); + json.put("message", message); + + doNothing().when(notificationService).addAlertNotificaiton(new AlertNotificationRequest()); + + this.mockMvc.perform(post(NOTIFICATION_API_CONTEXT + "/alert/add") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isAccepted()); + } + + @Test + @WithMockUser + public void post_notificationAlert_unauthorized() throws Exception { + JSONObject json = new JSONObject(); + JSONObject title = new JSONObject(); + JSONObject message = new JSONObject(); + + title.put("english", "english title"); + message.put("english", "english message"); + + json.put("source", "the source"); + json.put("title", title); + json.put("message", message); + + doNothing().when(notificationService).addAlertNotificaiton(new AlertNotificationRequest()); + + this.mockMvc.perform(post(NOTIFICATION_API_CONTEXT + "/alert/add") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isForbidden()); + } + + @Test + @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) + public void post_notificationAlert_noContent() throws Exception { + doNothing().when(notificationService).addAlertNotificaiton(new AlertNotificationRequest()); + + this.mockMvc.perform(post(NOTIFICATION_API_CONTEXT + "/alert/add") + .contentType(MediaType.APPLICATION_JSON)) + .andExpect(status().isBadRequest()); + } + + @Test + @WithMockUser(authorities = { AUTHORITY_NOTIFICATION }) + public void post_notificationAlert_missingField() throws Exception { + JSONObject json = new JSONObject(); + JSONObject title = new JSONObject(); + JSONObject message = new JSONObject(); + + doNothing().when(notificationService).addAlertNotificaiton(new AlertNotificationRequest()); + + message.put("english", "english message"); + json.put("source", "the source"); + //missing field - title + json.put("message", message); + this.mockMvc.perform(post(NOTIFICATION_API_CONTEXT + "/alert/add") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isBadRequest()); + + json.put("title", title); //title is an empty json + this.mockMvc.perform(post(NOTIFICATION_API_CONTEXT + "/alert/add") + .contentType(MediaType.APPLICATION_JSON) + .content(json.toString())) + .andExpect(status().isBadRequest()); + } +} From 175ca9ca5002d32b3c39e73f59f63b6a1d13372c Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Sat, 7 Nov 2020 13:59:16 +0530 Subject: [PATCH 08/12] backend: image service and compression updated, image validations added --- .../covid19/controller/ImageController.java | 6 +- .../exceptions/ImageHandlingException.java | 11 ++++ .../model/mapper/StoredImageMapper.java | 1 - .../covid19/repository/CovidRepository.java | 6 +- .../service/ImageCompressionService.java | 61 ++++++++++++------- .../govtech/covid19/service/ImageService.java | 27 +++----- .../covid19/validation/AcceptableImage.java | 19 ++++++ .../covid19/validation/ImageValidator.java | 53 ++++++++++++++++ 8 files changed, 142 insertions(+), 42 deletions(-) create mode 100644 backend/src/main/java/lk/gov/govtech/covid19/exceptions/ImageHandlingException.java create mode 100644 backend/src/main/java/lk/gov/govtech/covid19/validation/AcceptableImage.java create mode 100644 backend/src/main/java/lk/gov/govtech/covid19/validation/ImageValidator.java diff --git a/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java b/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java index 10005a2..8635d29 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java @@ -4,6 +4,7 @@ import lk.gov.govtech.covid19.dto.StoredImageResponse; import lk.gov.govtech.covid19.service.ImageService; import lk.gov.govtech.covid19.util.Constants; +import lk.gov.govtech.covid19.validation.AcceptableImage; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.MediaType; @@ -11,6 +12,8 @@ import org.springframework.web.bind.annotation.*; import org.springframework.web.multipart.MultipartFile; +import javax.validation.Valid; + @RestController @Slf4j @RequestMapping(Constants.IMAGE_API_CONTEXT) @@ -18,9 +21,10 @@ public class ImageController { @Autowired ImageService imageService; + private MultipartFile image; @PostMapping - public ResponseEntity uploadImage(@RequestParam("image") MultipartFile image){ + public ResponseEntity uploadImage(@RequestParam("image") @AcceptableImage MultipartFile image){ StoredImageResponse response = null; if (image.isEmpty()){ log.info("Request does not contain an image"); diff --git a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/ImageHandlingException.java b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/ImageHandlingException.java new file mode 100644 index 0000000..cd52b99 --- /dev/null +++ b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/ImageHandlingException.java @@ -0,0 +1,11 @@ +package lk.gov.govtech.covid19.exceptions; + +public class ImageHandlingException extends Exception { + public ImageHandlingException(String message) { + super(message); + } + + public ImageHandlingException(String message, Throwable cause) { + super(message, cause); + } +} diff --git a/backend/src/main/java/lk/gov/govtech/covid19/model/mapper/StoredImageMapper.java b/backend/src/main/java/lk/gov/govtech/covid19/model/mapper/StoredImageMapper.java index 6132baf..b64223a 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/model/mapper/StoredImageMapper.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/model/mapper/StoredImageMapper.java @@ -12,7 +12,6 @@ public class StoredImageMapper implements RowMapper { @Override public StoredImage mapRow(ResultSet resultSet, int i) throws SQLException { StoredImage si = new StoredImage(); - System.out.println(resultSet.toString()); si.setName(resultSet.getString("name")); Blob blob = resultSet.getBlob("image"); si.setImage(blob.getBytes(1, (int) blob.length())); diff --git a/backend/src/main/java/lk/gov/govtech/covid19/repository/CovidRepository.java b/backend/src/main/java/lk/gov/govtech/covid19/repository/CovidRepository.java index 93956b7..3ecb465 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/repository/CovidRepository.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/repository/CovidRepository.java @@ -6,12 +6,14 @@ import lk.gov.govtech.covid19.model.StatusEntity; import lk.gov.govtech.covid19.model.mapper.*; import lombok.extern.slf4j.Slf4j; +import org.apache.tomcat.util.http.fileupload.IOUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.jdbc.support.GeneratedKeyHolder; import org.springframework.jdbc.support.KeyHolder; import org.springframework.stereotype.Repository; +import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; import java.sql.PreparedStatement; @@ -145,8 +147,9 @@ public void updateStatus(UpdateStatusRequest request) { request.getLk_total_case() , request.getLk_recovered_case(), request.getLk_total_deaths(), request.getLk_total_suspect(), 1); } - public int addImage(InputStream is, String name, long size) throws IOException { + public int addImage(byte[] bArray, String name, long size) { KeyHolder holder = new GeneratedKeyHolder(); + InputStream is = new ByteArrayInputStream(bArray); jdbcTemplate.update(connection -> { PreparedStatement ps = connection.prepareStatement("insert into images(name, image) " + "values(?,?)", Statement.RETURN_GENERATED_KEYS); @@ -155,6 +158,7 @@ public int addImage(InputStream is, String name, long size) throws IOException { return ps; },holder ); + IOUtils.closeQuietly(is); return holder.getKey().intValue(); } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/service/ImageCompressionService.java b/backend/src/main/java/lk/gov/govtech/covid19/service/ImageCompressionService.java index c52c10c..24ccaed 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/service/ImageCompressionService.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/service/ImageCompressionService.java @@ -1,5 +1,8 @@ package lk.gov.govtech.covid19.service; +import lk.gov.govtech.covid19.exceptions.ImageHandlingException; +import lombok.extern.slf4j.Slf4j; +import org.apache.tomcat.util.http.fileupload.IOUtils; import org.springframework.stereotype.Service; import org.springframework.web.multipart.MultipartFile; @@ -10,32 +13,48 @@ import javax.imageio.stream.ImageOutputStream; import java.awt.image.BufferedImage; import java.io.ByteArrayOutputStream; -import java.io.File; import java.io.IOException; +import java.io.InputStream; import java.util.Iterator; +@Slf4j @Service public class ImageCompressionService { - public byte[] compressImage(MultipartFile file) throws IOException { - BufferedImage image = ImageIO.read(file.getInputStream()); - File compressedFile = new File("compressed_"+file.getOriginalFilename()); -// OutputStream os = new FileOutputStream(compressedFile); - ByteArrayOutputStream baos = new ByteArrayOutputStream(); - float imageQ = 0.5f; - Iterator imageWriters = ImageIO.getImageWritersByFormatName("jpg"); - if (!imageWriters.hasNext()){ - throw new IllegalStateException("Writers not found"); + public byte[] compressImage(MultipartFile file) throws ImageHandlingException { + InputStream is = null; + BufferedImage bufferedImage; + ByteArrayOutputStream baos = null; + ImageOutputStream imageOutputStream = null; + ImageWriter imageWriter = null; + + try { + is = file.getInputStream(); + baos = new ByteArrayOutputStream(); + bufferedImage = ImageIO.read(is); + + float imageQ = 0.5f; + Iterator imageWriters = ImageIO.getImageWritersByFormatName("jpg"); + if (!imageWriters.hasNext()) { + throw new IllegalStateException("Writers not found"); + } + imageWriter = imageWriters.next(); + imageOutputStream = ImageIO.createImageOutputStream(baos); + imageWriter.setOutput(imageOutputStream); + ImageWriteParam imageWriteParam = imageWriter.getDefaultWriteParam(); + imageWriteParam.setCompressionMode(ImageWriteParam.MODE_EXPLICIT); + imageWriteParam.setCompressionQuality(imageQ); + imageWriter.write(null, new IIOImage(bufferedImage, null, null), imageWriteParam); + return baos.toByteArray(); + } catch (IOException e) { + log.warn("Error while loading or compressing image"); + throw new ImageHandlingException("Error while loading or compressing image", e); + } finally { + IOUtils.closeQuietly(is); + IOUtils.closeQuietly(baos); + IOUtils.closeQuietly(imageOutputStream); + if (imageWriter != null) { + imageWriter.dispose(); + } } - ImageWriter iw = (ImageWriter)imageWriters.next(); - ImageOutputStream imageOutputStream = ImageIO.createImageOutputStream(baos); - iw.setOutput(imageOutputStream); - ImageWriteParam imageWriteParam = iw.getDefaultWriteParam(); - imageWriteParam.setCompressionMode(ImageWriteParam.MODE_EXPLICIT); - imageWriteParam.setCompressionQuality(imageQ); - iw.write(null, new IIOImage(image, null, null), imageWriteParam); - baos.close(); - imageOutputStream.close(); - iw.dispose(); - return baos.toByteArray(); } } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java b/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java index 7348913..6eb7591 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/service/ImageService.java @@ -2,6 +2,7 @@ import lk.gov.govtech.covid19.dto.StoredImage; import lk.gov.govtech.covid19.dto.StoredImageResponse; +import lk.gov.govtech.covid19.exceptions.ImageHandlingException; import lk.gov.govtech.covid19.repository.CovidRepository; import lk.gov.govtech.covid19.util.Constants; import org.springframework.beans.factory.annotation.Autowired; @@ -22,25 +23,15 @@ public class ImageService { @Autowired ImageCompressionService imageCompressionService; - public StoredImageResponse addImage(MultipartFile file){ - StoredImageResponse storedImageResponse = null; - - try { - byte[] bArray = imageCompressionService.compressImage(file); - InputStream is = new ByteArrayInputStream(bArray); - int id = repository.addImage(is,file.getOriginalFilename(),file.getSize()); - storedImageResponse = new StoredImageResponse(); - storedImageResponse.setId(id); - storedImageResponse.setUrl(Constants.BACKEND_CONTEXT - + Constants.IMAGE_API_CONTEXT + "/image/" + id); - storedImageResponse.setName(file.getOriginalFilename()); - return storedImageResponse; - } catch (FileNotFoundException e) { - e.printStackTrace(); - } catch (IOException e) { - e.printStackTrace(); - } + public StoredImageResponse addImage(MultipartFile file) throws ImageHandlingException { + byte[] bArray = imageCompressionService.compressImage(file); + int id = repository.addImage(bArray,file.getOriginalFilename(),file.getSize()); + StoredImageResponse storedImageResponse = new StoredImageResponse(); + storedImageResponse.setId(id); + storedImageResponse.setUrl(Constants.BACKEND_CONTEXT + + Constants.IMAGE_API_CONTEXT + "/image/" + id); + storedImageResponse.setName(file.getOriginalFilename()); return storedImageResponse; } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/validation/AcceptableImage.java b/backend/src/main/java/lk/gov/govtech/covid19/validation/AcceptableImage.java new file mode 100644 index 0000000..f52e57a --- /dev/null +++ b/backend/src/main/java/lk/gov/govtech/covid19/validation/AcceptableImage.java @@ -0,0 +1,19 @@ +package lk.gov.govtech.covid19.validation; + +import javax.validation.Constraint; +import javax.validation.Payload; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import static java.lang.annotation.ElementType.PARAMETER; +import static java.lang.annotation.ElementType.TYPE; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +@Target({TYPE, PARAMETER}) +@Retention(RUNTIME) +@Constraint(validatedBy = ImageValidator.class) +public @interface AcceptableImage { + String message() default "Insupportable type of image"; + Class[] groups() default {}; + Class[] payload() default {}; +} diff --git a/backend/src/main/java/lk/gov/govtech/covid19/validation/ImageValidator.java b/backend/src/main/java/lk/gov/govtech/covid19/validation/ImageValidator.java new file mode 100644 index 0000000..855e635 --- /dev/null +++ b/backend/src/main/java/lk/gov/govtech/covid19/validation/ImageValidator.java @@ -0,0 +1,53 @@ +package lk.gov.govtech.covid19.validation; + +import org.springframework.util.StringUtils; +import org.springframework.web.multipart.MultipartFile; + +import javax.validation.ConstraintValidator; +import javax.validation.ConstraintValidatorContext; + +public class ImageValidator implements ConstraintValidator { + + @Override + public boolean isValid(MultipartFile multipartFile, ConstraintValidatorContext constraintValidatorContext) { + try { + if(multipartFile.isEmpty()) { + return false; + } else if(multipartFile.getSize() > 200000) { + return false; + } else if (isInvalidFileName(multipartFile.getOriginalFilename())) { + return false; + } else if (isInvalidFileExtension(multipartFile.getOriginalFilename())) { + return false; + } else { + return true; + } + } catch (Exception e) { + return false; + } + } + + private boolean isInvalidFileName(String filename) { + if (filename == null) { + return true; + } else if(filename.length()>100) { + return true; + } else if(hasInvalidChars(filename)) { + return true; + } else if (StringUtils.countOccurrencesOf(filename, ".") != 1) { + return true; + } else { + return false; + } + } + + private boolean hasInvalidChars(String filename) { + boolean isMatching = filename.matches("^[a-zA-Z0-9 ._-]+$"); + return !isMatching; + } + + private boolean isInvalidFileExtension(String originalFilename) { + String extension = originalFilename.split("\\.")[1]; //split by dot + return !extension.equals("jpg"); + } +} From 0c45f38c9abab99d11c7cb61e94fde12c2e46b9d Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Sat, 7 Nov 2020 16:15:21 +0530 Subject: [PATCH 09/12] backend: update exception handler, image controller, postman file --- backend/pom.xml | 5 ----- .../covid19/controller/ImageController.java | 19 +++++++------------ .../covid19/dto/AlertNotificationRequest.java | 4 ++-- .../exceptions/CustomExceptionHandler.java | 18 +++++++++++++++--- postman/COVID-19.postman_collection.json | 16 ++++++++-------- 5 files changed, 32 insertions(+), 30 deletions(-) diff --git a/backend/pom.xml b/backend/pom.xml index 75bf092..8946ba2 100644 --- a/backend/pom.xml +++ b/backend/pom.xml @@ -135,11 +135,6 @@ org.springframework.boot spring-boot-starter-validation - - com.googlecode.owasp-java-html-sanitizer - owasp-java-html-sanitizer - 20200713.1 - org.springframework.boot spring-boot-starter-test diff --git a/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java b/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java index 8635d29..e921d1e 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/controller/ImageController.java @@ -2,6 +2,7 @@ import lk.gov.govtech.covid19.dto.StoredImage; import lk.gov.govtech.covid19.dto.StoredImageResponse; +import lk.gov.govtech.covid19.exceptions.ImageHandlingException; import lk.gov.govtech.covid19.service.ImageService; import lk.gov.govtech.covid19.util.Constants; import lk.gov.govtech.covid19.validation.AcceptableImage; @@ -12,8 +13,6 @@ import org.springframework.web.bind.annotation.*; import org.springframework.web.multipart.MultipartFile; -import javax.validation.Valid; - @RestController @Slf4j @RequestMapping(Constants.IMAGE_API_CONTEXT) @@ -24,21 +23,17 @@ public class ImageController { private MultipartFile image; @PostMapping - public ResponseEntity uploadImage(@RequestParam("image") @AcceptableImage MultipartFile image){ - StoredImageResponse response = null; - if (image.isEmpty()){ - log.info("Request does not contain an image"); - }else { - log.info("Image {} of size:{} being added", image.getOriginalFilename(), image.getSize()); - response = imageService.addImage(image); - } + public ResponseEntity uploadImage(@RequestParam("image") @AcceptableImage MultipartFile image) + throws ImageHandlingException { + StoredImageResponse response = imageService.addImage(image); + log.info("Image {} of size:{} added", image.getOriginalFilename(), image.getSize()); System.gc(); return ResponseEntity.accepted().body(response); } @GetMapping(value = "/image/{imageId}", produces = MediaType.IMAGE_JPEG_VALUE) public @ResponseBody byte[] getFiles(@PathVariable("imageId") int imageId){ - StoredImage si = imageService.getImage(imageId); - return si.getImage(); + StoredImage storedImage = imageService.getImage(imageId); + return storedImage.getImage(); } } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java b/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java index 4746502..996edbf 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/dto/AlertNotificationRequest.java @@ -28,9 +28,9 @@ public static class Title { public static class Message { @NotBlank @Size(min=8, max=2500) private String english; - @Size(min=8, max=2500) + @Size(max=2500) private String sinhala; - @Size(min=8, max=2500) + @Size(max=2500) private String tamil; } } diff --git a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java index 301f04b..3b7cdce 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/exceptions/CustomExceptionHandler.java @@ -24,15 +24,27 @@ public void handleMalformedRequestRelatedExceptions(HttpServletRequest request, @ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Invalid request. Value missing or invalid.") @ExceptionHandler(value = {MethodArgumentNotValidException.class, HttpMessageConversionException.class, - DataIntegrityViolationException.class}) + DataIntegrityViolationException.class, IllegalArgumentException.class}) public void handleValidationException(HttpServletRequest request, Exception e) { log.warn("Invalid request. Value missing or invalid."); } + @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "Error while processing image") + @ExceptionHandler(value = {ImageHandlingException.class}) + public void handleValidationException(HttpServletRequest request, ImageHandlingException e) { + log.warn("Error while processing image"); + } + + @ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "Resource not found") + @ExceptionHandler(value = {IndexOutOfBoundsException.class}) + public void handleExceptionsLeadingToNotFound(HttpServletRequest request, IndexOutOfBoundsException e) { + log.warn("Resource not found"); + } + @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR, reason = "Unknown error state of server") @ExceptionHandler(value = { Exception.class }) public void defaultErrorHandler(HttpServletRequest request, Exception e) throws Exception { - log.error("Exception mapping failure" + e.getClass().getName() - + ", message: " + e.getMessage()); + log.error("Exception mapping failure. Exception: {}, message: {}", + e.getClass().getName(), e.getMessage()); } } diff --git a/postman/COVID-19.postman_collection.json b/postman/COVID-19.postman_collection.json index d4c88b4..3cdbf13 100644 --- a/postman/COVID-19.postman_collection.json +++ b/postman/COVID-19.postman_collection.json @@ -331,15 +331,15 @@ "value": "attachment.jpg" }, "url": { - "raw": "http://localhost:8000/images/add", + "raw": "http://localhost:8000/api/images", "protocol": "http", "host": [ "localhost" ], "port": "8000", "path": [ - "images", - "add" + "api", + "images" ] } }, @@ -351,22 +351,22 @@ "method": "GET", "header": [], "url": { - "raw": "http://localhost:8000/images/image/4", + "raw": "http://localhost:8000/api/images/image/4", "protocol": "http", "host": [ "localhost" ], "port": "8000", "path": [ + "api", "images", "image", - 4 + "4" ] }, - "description": "GET http://localhost:8000/images/image/" + "description": "GET http://localhost:8000/api/images/image/" }, "response": [] } - ], - "protocolProfileBehavior": {} + ] } \ No newline at end of file From ac2f172aec4e8a6bfb82d075df24047689fca546 Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Sat, 7 Nov 2020 16:46:22 +0530 Subject: [PATCH 10/12] portal: add image validations --- portal/src/components/views/news/news.js | 1 - .../src/components/views/news/newsEditor.js | 29 +++++++++++++------ 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/portal/src/components/views/news/news.js b/portal/src/components/views/news/news.js index 2d88f62..6520911 100644 --- a/portal/src/components/views/news/news.js +++ b/portal/src/components/views/news/news.js @@ -46,7 +46,6 @@ export default { || this.$refs.englishEditor.isInvalid() || this.$refs.sinhalaEditor.isInvalid() || this.$refs.tamilEditor.isInvalid()) { - if(this.$refs.sinhalaEditor.isInvalid()) console.log("sinhala"); return } else { this.submitBtnDisable = true; diff --git a/portal/src/components/views/news/newsEditor.js b/portal/src/components/views/news/newsEditor.js index c64edc1..1a59ddf 100644 --- a/portal/src/components/views/news/newsEditor.js +++ b/portal/src/components/views/news/newsEditor.js @@ -116,17 +116,28 @@ export default { commands.image({ src }); this.imageBtnDisable = false; } - }).catch(() => { - Vue.swal.mixin({ - toast: true, - position: 'top-end', - showConfirmButton: false, - timer: 2000, - }) - .fire({ - title: "Error uploading image", + }).catch(error => { + if (error.response.status == 400) { + Vue.swal.mixin({ + position: 'top-end', + showConfirmButton: false, + showCancelButton:true, + }).fire({ + title: "Invalid image type, size or name", + text: "Image must be of type jpg. Image size must be smaller than 200KB. Image name can only contain letters, numbers, dashes, underscores and spaces", icon: "error", }); + } else { + Vue.swal.mixin({ + toast: true, + position: 'top-end', + showConfirmButton: false, + timer: 2000, + }).fire({ + title: "Error uploading image", + icon: "error", + }); + } this.submitBtnDisable = false; }); } From 9b94d7205fc1566358ed91aac210827dea4b4c4a Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Sat, 7 Nov 2020 16:52:20 +0530 Subject: [PATCH 11/12] auth to dhis --- .../lk/gov/govtech/covid19/security/SecurityConfiguration.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java b/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java index 4336d91..64d6d27 100644 --- a/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java +++ b/backend/src/main/java/lk/gov/govtech/covid19/security/SecurityConfiguration.java @@ -106,6 +106,8 @@ protected void configure(final HttpSecurity http) throws Exception { .hasAuthority(AUTHORITY_NOTIFICATION) .antMatchers(HttpMethod.POST, IMAGE_API_CONTEXT) .hasAuthority(AUTHORITY_NOTIFICATION) + .antMatchers(DHIS_API_CONTEXT + "/**") + .hasAuthority(AUTHORITY_NOTIFICATION) .and() .addFilter(getPasswordFilter()) .requestCache() // avoid saving anonymous requests in sessions From af6dc352aabb77c0432f095e203944aa0ce07df7 Mon Sep 17 00:00:00 2001 From: Subhashinie Koshalya Date: Sat, 7 Nov 2020 17:26:57 +0530 Subject: [PATCH 12/12] portal: bug fix --- portal/src/components/views/news/newsEditor.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/portal/src/components/views/news/newsEditor.js b/portal/src/components/views/news/newsEditor.js index 1a59ddf..378c263 100644 --- a/portal/src/components/views/news/newsEditor.js +++ b/portal/src/components/views/news/newsEditor.js @@ -145,7 +145,7 @@ export default { inputElement.click(); }, beforeDestroy() { - this.editor.destroy(); + this.newsEditor.destroy(); }, } }; \ No newline at end of file