Merge branch 'dev' into interface-changes-cite

Author: Konstiman

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 2022-01-20
+
+### New features
+
+- backend data sanitization
+- pdfs searchable by the searchbox
+
+### Changes
+
+- data preprocessing refactoring
+
+### Bug fixes
+
+- footer size on narrow screens
+
+### Internal
+
+- test database update
+
+## 2021-12-22
+
+### Changes
+
+- unified HTML & CSS of various paper tags (access tags, dataset tag, custom tags)
+
 ## 2021-12-09
 
 ### New features

server/storage/test.sqlite

@@ -7,7 +7,24 @@ import {
   stringArrayValidator,
 } from "../utils/data";
 
-// name; required?; type?; protected?; validator?; sanitizer?; fallback?;
+/**
+ * Scheme object based on the metadata spreadsheet.
+ *
+ * https://docs.google.com/spreadsheets/d/112Anbf-sJYkehyFvjuxr1DuMih-fPB9nt3E8ll19Iyc/edit#gid=0
+ *
+ * It's an array of objects, each object describes a paper property.
+ *
+ * It has the following properties:
+ *
+ * - name: string - the paper property's name
+ * - required?: boolean - true for mandatory properties
+ * - type?: string[] - list of allowed js types
+ * - protected?: boolean - true for properties that shouldn't be escaped
+ * - validator?: (value: any) => boolean - validator function that receives the property value and returns true if the value is valid
+ * - sanitizer?: (value: any) => any - sanitizer function that sanitizes the property value
+ * - fallback?: (localization?: object, paper?: object) => any - fallback function that returns a fallback value
+ *
+ */
 const DEFAULT_SCHEME = [
   {
     name: "id",
@@ -57,6 +74,7 @@ const DEFAULT_SCHEME = [
     name: "subject_orig",
     required: true,
     type: ["string"],
+    validator: (val) => val !== "",
     fallback: (loc) => loc.no_keywords,
   },
   { name: "subject_cleaned", required: true, type: ["string"] },

vis/js/dataschemes/defaultScheme.js

@@ -4,6 +4,7 @@ import { connect } from "react-redux";
 import useMatomo from "../../utils/useMatomo";
 import { getPaperPDFClickHandler } from "../../utils/data";
 import { mapDispatchToListEntriesProps } from "../../utils/eventhandlers";
+import Highlight from "../../components/Highlight";
 
 const PaperButtons = ({
   paper,
@@ -30,7 +31,7 @@ const PaperButtons = ({
     <div className="paper_buttons_row">
       {!!onPDFClick && (
         <button className="paper_button main" onClick={handlePDFButtonClick}>
-          <i className="fa fa-eye"></i>&nbsp;&nbsp;PDF
+          <i className="fa fa-eye"></i>&nbsp;&nbsp;<Highlight>PDF</Highlight>
         </button>
       )}
       {showCiteButton && (

vis/js/templates/listentry/PaperButtons.jsx

@@ -83,54 +83,48 @@ const getParamFilterFunction = (param, field) => {
   };
 };
 
+const SEARCHED_PROPS = [
+  "title",
+  "authors_string",
+  "published_in",
+  "year",
+  "subject_orig",
+  "tags",
+  "comments_for_filtering",
+  "resulttype",
+  "paper_abstract",
+];
+
 /**
  * Creates a paper filtering function from the search words.
  *
- * Function taken from legacy list.js
- * @param {Array} search_words array of search words (plaintext strings)
+ * @param {Array} searchedKeywords array of search keywords (plaintext strings)
  *
- * @returns {Function} filtering function
+ * @returns {Function} filtering function that returns true if paper contains all the searched keywords
  */
-const getWordFilterFunction = (search_words) => {
-  return (d) => {
-    const abstract = getPropertyOrEmptyString(d, "paper_abstract");
-    const title = getPropertyOrEmptyString(d, "title");
-    const authors = getPropertyOrEmptyString(d, "authors_string");
-    const journals = getPropertyOrEmptyString(d, "published_in");
-    const year = getPropertyOrEmptyString(d, "year");
-    const keywords = getPropertyOrEmptyString(d, "subject_orig");
-    const tags = getPropertyOrEmptyString(d, "tags");
-    const comments = getPropertyOrEmptyString(d, "comments_for_filtering");
-    const resulttype = getPropertyOrEmptyString(d, "resulttype");
-    // TODO: make these two properties language-aware
-    const open_access = d.oa ? "open access" : "";
-    const free_access = d.free_access ? "free access" : "";
-
-    let i = 0;
-    let word_found = true;
-    while (word_found && i < search_words.length) {
-      word_found =
-        abstract.indexOf(search_words[i]) !== -1 ||
-        title.indexOf(search_words[i]) !== -1 ||
-        authors.indexOf(search_words[i]) !== -1 ||
-        journals.indexOf(search_words[i]) !== -1 ||
-        year.indexOf(search_words[i]) !== -1 ||
-        keywords.indexOf(search_words[i]) !== -1 ||
-        tags.indexOf(search_words[i]) !== -1 ||
-        comments.indexOf(search_words[i]) !== -1 ||
-        resulttype.indexOf(search_words[i]) !== -1 ||
-        open_access.indexOf(search_words[i]) !== -1 ||
-        free_access.indexOf(search_words[i]) !== -1;
-      i++;
+const getWordFilterFunction = (searchedKeywords) => {
+  return (paper) => {
+    const paperKeywords = SEARCHED_PROPS.map((prop) =>
+      getPropertyOrEmptyString(paper, prop)
+    );
+
+    if (paper.oa) {
+      paperKeywords.push("open access");
+      paperKeywords.push("pdf");
     }
+    if (paper.free_access) {
+      paperKeywords.push("free access");
+    }
+
+    const paperString = paperKeywords.join(" ");
 
-    return word_found;
+    return !searchedKeywords.some((keyword) => !paperString.includes(keyword));
   };
 };
 
 const getPropertyOrEmptyString = (object, property) => {
   if (Object.prototype.hasOwnProperty.call(object, property)) {
-    return object[property].toString().toLowerCase();
+    return object[property].toString().toLowerCase().trim();
   }
 
   return "";

vis/js/utils/data.js

@@ -180,6 +180,10 @@ img#close-button {
     -moz-border-radius: 14px;
     -webkit-border-radius: 14px;
 
+    .highlighted {
+        color: $okm-red;
+    }
+
     &:hover {
         color: $okm-modal-btn;
         background-color: white;

vis/stylesheets/components/_buttons.scss

@@ -1,7 +1,6 @@
 .builtwith {
   margin: 15px 10px 15px 50px;
   font-size: 12px;
-  // TODO this doesn't work on mobile (footer is unreadable)
   height: 20px;
 }
 
@@ -15,7 +14,31 @@
   }
 }
 
-@media screen and (max-width: 640px) {
+@media screen and (max-width: 1210px) {
+  .builtwith {
+    font-size: 11px;
+  }
+}
+
+@media screen and (max-width: 1120px) {
+  .builtwith {
+    font-size: 10px;
+  }
+}
+
+@media screen and (max-width: 1030px) {
+  .builtwith {
+    font-size: 9px;
+  }
+}
+
+@media screen and (max-width: 1000px) {
+  .builtwith {
+    font-size: 10px;
+  }
+}
+
+@media screen and (max-width: 900px) {
   .builtwith {
     margin: 10px 0px 10px 20px;
     font-size: 11px;

vis/stylesheets/modules/_footer.scss

@@ -430,7 +430,8 @@ exports[`List entries component snapshot (BASE) matches a snapshot (zoomed-in, p
                   <i
                     className="fa fa-eye"
                   />
-                    PDF
+                    
+                  PDF
                 </button>
                 <button
                   className="paper_button"
@@ -864,7 +865,8 @@ exports[`List entries component snapshot (BASE) matches a snapshot (zoomed-out)
                   <i
                     className="fa fa-eye"
                   />
-                    PDF
+                    
+                  PDF
                 </button>
                 <button
                   className="paper_button"
@@ -1158,7 +1160,8 @@ exports[`List entries component snapshot (BASE) matches a snapshot (zoomed-out)
                   <i
                     className="fa fa-eye"
                   />
-                    PDF
+                    
+                  PDF
                 </button>
                 <button
                   className="paper_button"
@@ -1589,7 +1592,8 @@ exports[`List entries component snapshot (BASE) matches a snapshot (zoomed-out)
                   <i
                     className="fa fa-eye"
                   />
-                    PDF
+                    
+                  PDF
                 </button>
                 <button
                   className="paper_button"
@@ -2842,7 +2846,8 @@ exports[`List entries component snapshot (BASE) matches a snapshot (zoomed-out)
                   <i
                     className="fa fa-eye"
                   />
-                    PDF
+                    
+                  PDF
                 </button>
                 <button
                   className="paper_button"
@@ -3121,7 +3126,8 @@ exports[`List entries component snapshot (BASE) matches a snapshot (zoomed-out)
                   <i
                     className="fa fa-eye"
                   />
-                    PDF
+                    
+                  PDF
                 </button>
                 <button
                   className="paper_button"
@@ -3411,7 +3417,8 @@ exports[`List entries component snapshot (BASE) matches a snapshot (zoomed-out)
                   <i
                     className="fa fa-eye"
                   />
-                    PDF
+                    
+                  PDF
                 </button>
                 <button
                   className="paper_button"