migrate to ts

.gitlab-ci.yml

@@ -3,6 +3,10 @@ pages-testing:
   script:
     - cat $configfiledev > ./config/config.js
     - npm install
+    - [npm run clean]
+    - [npm run build]
+    - [copy views/ dir to built/]
+    - [cd built]
     - "pm2 delete --silent project || :"
     - pm2 start ./app.js --name=project
     - pm2 save

app.js → app.ts

-const express = require('express')
-const path = require('path')
-const passport = require('passport')
-const morgan = require('morgan')
-const cookieParser = require('cookie-parser')
-const bodyParser = require('body-parser')
-const session = require('express-session')
-const flash = require('express-flash')
-const fileUpload = require('express-fileupload')
-const helmet = require('helmet')
-const compression = require('compression')
+import express from 'express'
+import path from 'path'
+//import passport from 'passport'
+import morgan from 'morgan'
+import cookieParser from 'cookie-parser'
+import bodyParser from 'body-parser'
+//import session from 'express-session'
+//import flash from 'express-flash'
+//import fileUpload from 'express-fileupload'
+import helmet from 'helmet'
+import compression from 'compression'
 
 var env = process.env.NODE_ENV || 'testing'
 const config = require('./config/config')[env]
+const lang = 'DE';
 
 var app = express()
-
 app.set('port', config.app.port)
 app.set('views', __dirname + '/views')
 app.set('view engine', 'pug')
@@ -26,7 +26,7 @@ app.use(cookieParser())
 app.use(bodyParser.json())
 app.use(bodyParser.urlencoded({extended: false}))
 app.use(express.static(path.join(__dirname, 'public')))
-app.use(session(
+/*app.use(session(
     {
         resave: true,
         saveUninitialized: true,
@@ -35,20 +35,20 @@ app.use(session(
     }
 ))
 app.use(passport.initialize())
-app.use(passport.session())
-app.use(flash())
+app.use(passport.session()) */
+/*app.use(flash())
 app.use((req, res, next) => {
     res.locals.errors = req.flash("error")
     res.locals.successes = req.flash("success")
     next()
-})
+}) */
 // enable files upload
-app.use(fileUpload({
+/*app.use(fileUpload({
     createParentPath: true,
     limits: { 
       fileSize: 1000000 // 1 MB max. file size
     }
-}))
+})) */
 // caching disabled for every route
 // NOTE: Works in Firefox and Opera. Does not work in Edge
 app.use(function(req, res, next) {
@@ -56,17 +56,17 @@ app.use(function(req, res, next) {
     next()
 })
   
-require('./routes/project')(app, config, passport)
+require('./routes/project')(app, lang)
   
 // Handle 404
-app.use(function (req, res, next) {
-    res.status(404).render('./DE/404')
+app.use(function (req:any, res:any) {
+    res.status(404).render(lang+'/404')
 })
   
 // Handle 500 - any server error
-app.use(function (err, req, res, next) {
+app.use(function (err:any, req:any, res:any, next:any) {
     console.error(err.stack)
-    res.status(500).render('./DE/500', {
+    res.status(500).render(lang+'/500', {
       error: err
     })
 })

config/config.js → config/config.ts

@@ -2,17 +2,7 @@ module.exports = {
   development: {
     app: {
       name: 'Project Page Manager',
-      port: process.env.PORT || 8888,
-      sessionSecret: 'thisisasecret-thisisasecret-thisisasecret'
-    },
-    passport: {
-      strategy: 'saml',
-      saml: {
-        path: process.env.SAML_PATH || '/saml/SSO',
-        entryPoint: process.env.SAML_ENTRY_POINT || 'saml entry URL',
-        issuer: 'saml issuer URL',
-        logoutUrl: 'saml Logout URL'
-      }
+      port: process.env.PORT || 8888
     },
     database: {
       user: 'usernamedb',          // DB username
@@ -22,15 +12,6 @@ module.exports = {
       host_project: 'localhost', // local
       dbProject: 'projectdb'     // Project DB
     },
-    mailer: {
-      host: 'mailhost',  // hostname
-      secureConnection: false,        // TLS requires secureConnection to be false
-      port: 587,                      // port for secure SMTP
-      authUser: 'usernamemail',
-      authPass: 'passwordmail',
-      tlsCiphers: 'SSLv3',
-      from: 'email_from',
-    },
     gitlab: {
       token_readWriteProjects: 'putyourtokenhere'
     }
@@ -38,17 +19,7 @@ module.exports = {
   testing: {
     app: {
       name: 'Project Page Manager',
-      port: process.env.PORT || 8888,
-      sessionSecret: 'thisisasecret-thisisasecret-thisisasecret'
-    },
-    passport: {
-      strategy: 'saml',
-      saml: {
-        path: process.env.SAML_PATH || '/saml/SSO',
-        entryPoint: process.env.SAML_ENTRY_POINT || 'saml entry URL',
-        issuer: 'saml issuer URL',
-        logoutUrl: 'saml Logout URL'
-      }
+      port: process.env.PORT || 8888
     },
     database: {
       user: 'usernamedb',          // DB username
@@ -58,15 +29,6 @@ module.exports = {
       host_project: 'localhost', // local
       dbProject: 'projectdb'     // Project DB
     },
-    mailer: {
-      host: 'mailhost',  // hostname
-      secureConnection: false,        // TLS requires secureConnection to be false
-      port: 587,                      // port for secure SMTP
-      authUser: 'usernamemail',
-      authPass: 'passwordmail',
-      tlsCiphers: 'SSLv3',
-      from: 'email_from',
-    },
     gitlab: {
       token_readWriteProjects: 'putyourtokenhere'
     }

config/dbconn.js → config/dbconn.ts

-const mysql = require('mysql')
+import mysql from 'mysql'
 
-var env = process.env.NODE_ENV || 'testing';
+var env = process.env.NODE_ENV || 'development';
 const config = require('./config')[env]
 
 // ==== USER ACOOUNT DB CONNECTION ====
@@ -51,4 +51,4 @@ var connection = {
     project: projectConnection
 }
 
-module.exports = connection
\ No newline at end of file
+export = connection
\ No newline at end of file

config/mailer.js

-const nodemailer = require('nodemailer')
-
-var env = process.env.NODE_ENV || 'testing';
-const config = require('./config')[env]
-
-var smtpTransport = nodemailer.createTransport({
-    host: config.mailer.host,
-    secureConnection: config.mailer.secureConnection,
-    port: config.mailer.port,
-    auth: {
-      user: config.mailer.authUser,
-      pass: config.mailer.authPass
-    },
-    tls: {
-        ciphers: config.mailer.tlsCiphers
-    } 
-});
-  
-var mailOptions = {
-    to: "",
-    from: config.mailer.from,
-    subject: "",
-    text: ""
-};
-
-var mailer = {
-    transport: smtpTransport,
-    options: mailOptions
-}
-
-module.exports = mailer
\ No newline at end of file

functions/gitlab.js → functions/gitlab.ts

-const axios = require('axios')
+import axios from 'axios'
 
 var gitlab = {
-    getProjects: async function(perPage, idAfter) {
+    getProjects: async function(perPage:number, idAfter:number) {
         try {
             let projects = await axios({
                 method: 'get',
@@ -30,7 +30,7 @@ var gitlab = {
                 data: err}
         }
     },
-    getLatestPipelineStatus: async function(projectId) {
+    getLatestPipelineStatus: async function(projectId:number) {
         return axios({
             method: 'get',
             url: 'https://transfer.hft-stuttgart.de/gitlab/api/v4/projects/'+projectId+'/pipelines'
@@ -40,4 +40,4 @@ var gitlab = {
     }
 }
 
-module.exports = gitlab
\ No newline at end of file
+export = gitlab
\ No newline at end of file

functions/helpers.js → functions/helpers.ts

 var helpers = {
-    stringToArray: function (input){
+    stringToArray: function (input:string){
         if(input != null){
             return input.split(',');
         }else{
@@ -8,4 +8,4 @@ var helpers = {
     }
 };
 
-module.exports = helpers;
\ No newline at end of file
+export = helpers;
\ No newline at end of file

functions/methods.js

-const dbconn = require('../config/dbconn');
-
-var methods = {
-    // test method
-	currentDate: function() {
-		console.log('Current Date is: ' + new Date().toISOString().slice(0, 10));
-    },
-    // ===================== user db =====================
-    getUserIdByEmail: function(email, callback) {
-        var userId
-        dbconn.user.query('SELECT id FROM user WHERE email = "' +email+'"', function (err, rows, fields) {
-            if (err) {
-                throw err;
-            }
-            else {
-                if ( rows.length > 0) {
-                    userId = rows[0].id;
-                }
-            }
-            callback(userId, err);
-        });
-    },
-/*
-    getUserProjectRole: function(userId, callback) {
-        dbconn.user.query('SELECT project_id, role_id FROM user_project_role WHERE user_id = "' +userId+'"', function (err, rows, fields) {
-            if (err) throw err;
-            callback(rows, err);
-        });
-    },
-    */
-    addUserProjectRole: function(data, callback) {
-        dbconn.user.query('INSERT INTO user_project_role SET ?', data, function (err, results, fields){
-            if (err) throw err;
-            callback(err);
-        })
-    },
-    // ======================= project db =======================
-    getAllProjects: function(callback) {
-        dbconn.project.query('CALL getAllprojects', function (err, rows, fields){
-            if (err) throw err;
-            callback(rows[0], err);
-        })
-    },
-    getAllMailinglists: function(callback) {
-        dbconn.project.query('CALL getAllLists', function (err, rows, fields){
-            if (err) throw err;
-            callback(rows[0], err);
-	    })
-    },
-    getProjectOverviewById: function(projectId, callback) {
-        dbconn.project.query('CALL GetProjectInformationByProjectID(' + projectId+ ')', function (err, rows, fields){
-            if (err) throw err;
-            callback(rows[0], err);
-    	})
-    },
-    getProjectImagesById: function(projectId, callback) {
-        dbconn.project.query('CALL getImagesByProjectID(' + projectId+ ')', function (err, rows, fields){
-            if (err) throw err;
-            callback(rows[0], err);
-        })
-    },
-    addProjectOverview: function(data, callback) {
-        dbconn.project.query('INSERT INTO project_overview SET ?', data, function (err, results, fields){
-            if (err) {
-                console.error(err);
-            }
-            callback(results, err);
-        })
-    }
-};
-
-module.exports = methods;
\ No newline at end of file

functions/methods.ts

+const dbconn = require('../config/dbconn');
+
+var methods = {
+    getAllMailinglists: function(callback:any) {
+        dbconn.project.query('CALL getAllLists', function (err:any, rows:any){
+            if (err) throw err;
+            callback(rows[0], err);
+	    })
+    },
+    getProjectOverviewById: function(projectId:number, callback:any) {
+        dbconn.project.query('CALL GetProjectInformationByProjectID(' + projectId+ ')', function (err:any, rows:any){
+            if (err) throw err;
+            callback(rows[0], err);
+    	})
+    },
+    getProjectImagesById: function(projectId:number, callback:any) {
+        dbconn.project.query('CALL getImagesByProjectID(' + projectId+ ')', function (err:any, rows:any){
+            if (err) throw err;
+            callback(rows[0], err);
+        })
+    }
+};
+
+export = methods;
\ No newline at end of file

package.json

@@ -14,7 +14,9 @@
     "url": "https://transfer.hft-stuttgart.de/gitlab/m4lab_tv1/project-page.git"
   },
   "scripts": {
-    "start": "nodemon app.js",
+    "start": "nodemon app.ts",
+    "build": "tsc --build",
+    "clean": "tsc --build --clean",
     "test": ""
   },
   "dependencies": {
@@ -23,17 +25,10 @@
     "body-parser": "^1.19.0",
     "compression": "^1.7.4",
     "cookie-parser": "1.4.3",
-    "errorhandler": "1.4.3",
     "express": "^4.17.1",
-    "express-fileupload": "^1.1.7-alpha.2",
-    "express-flash": "0.0.2",
-    "express-session": "^1.17.1",
-    "fs": "0.0.1-security",
-    "helmet": "^3.23.3",
+    "helmet": "^4.6.0",
     "morgan": "^1.10.0",
     "mysql": "^2.18.1",
-    "passport": "0.3.2",
-    "passport-saml": "^2.0.6",
     "pug": "^3.0.2"
   },
   "engines": {
@@ -41,6 +36,18 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "nodemon": "^2.0.9"
+    "@types/async": "^3.2.6",
+    "@types/compression": "^1.7.0",
+    "@types/cookie-parser": "^1.4.2",
+    "@types/express": "^4.17.12",
+    "@types/express-fileupload": "^1.1.6",
+    "@types/express-flash": "^0.0.2",
+    "@types/express-session": "^1.17.3",
+    "@types/morgan": "^1.9.2",
+    "@types/mysql": "^2.15.18",
+    "@types/passport": "^1.0.6",
+    "nodemon": "^2.0.9",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.3.5"
   }
 }

routes/project.js → routes/project.ts

 //const SamlStrategy = require('passport-saml').Strategy
-const methods = require('../functions/methods')
-const gitlab = require('../functions/gitlab')
-// pwd encryption
-//const bcrypt = require('bcryptjs');
-//const saltRounds = 10;
-//const salt = 64; // salt length
-// forgot pwd
-const async = require('async')
-//const crypto = require('crypto')
-//const mailer = require('./mailer')
-const helpers = require('../functions/helpers')
-const pictSizeLimit = 1000000 // 1 MB
+import async from 'async'
+import methods from '../functions/methods'
+import gitlab from '../functions/gitlab'
+import helpers from '../functions/helpers'
 
-module.exports = function (app) {
+module.exports = function (app:any, lang:string) {
  
   // ======== APP ROUTES - PROJECT ====================
-  var lang = 'DE'
+  
+  app.get('/', function (req:any, res:any) {
+    res.render(lang+'/project/project-simplified')
+  })
 
-  app.get('/mailinglists', function (req, res) {
+  app.get('/mailinglists', function (req:any, res:any) {
     async.waterfall([
-        function(done) {
-            methods.getAllMailinglists(function(mailinglistOverview, err) {
-                if (!err) {
-                    done(err, mailinglistOverview)
-                }
-            })
-        },
-        // create JSON object of mailinglists for front-end
-        function(mailinglistOverview, done) {
-            var allMailingLists = []  // JSON object
-            for (let i = 0; i < mailinglistOverview.length; i++) {
-                // add data to JSON object
-                allMailingLists.push({
-                    id: mailinglistOverview[i].id,
-                    name: mailinglistOverview[i].name,
-                    src: mailinglistOverview[i].src,
-                    projectstatus: mailinglistOverview[i].projectstatus,
-                    project_title: mailinglistOverview[i].project_title,
-                    keywords: mailinglistOverview[i].keywords
-                });
-            }
-
-            res.render(lang+'/project/mailinglists', {
-                isUserAuthenticated: req.isAuthenticated(),
-                user: req.user,
-                mailinglists: allMailingLists
-            });
+      function(done:any) {
+        methods.getAllMailinglists(function(mailinglistOverview:any, err:any) {
+          if (!err) {
+            done(err, mailinglistOverview)
+          }
+        })
+      },
+      // create JSON object of mailinglists for front-end
+      function(mailinglistOverview:any) {
+        var allMailingLists = []  // JSON object
+        for (let i = 0; i < mailinglistOverview.length; i++) {
+          // add data to JSON object
+          allMailingLists.push({
+            id: mailinglistOverview[i].id,
+            name: mailinglistOverview[i].name,
+            src: mailinglistOverview[i].src,
+            projectstatus: mailinglistOverview[i].projectstatus,
+            project_title: mailinglistOverview[i].project_title,
+            keywords: mailinglistOverview[i].keywords
+          });
         }
-    ])
-  })
-
-  app.get('/', function (req, res) {
-    res.render(lang+'/project/project-simplified', {
-       isUserAuthenticated: req.isAuthenticated(),
-       user: req.user
-    });
-  })
 
-  app.get('/addprojectoverview', function (req, res) {
-    if (req.isAuthenticated()) {
-      res.render(lang+'/project/addProjectOverview')
-    }
-    else {
-      res.redirect('/login')
-    }
-  })
-
-  app.post('/addprojectoverview', function (req, res) {
-    if (req.isAuthenticated()) {
-      var wiki = 0
-      if (req.body.wiki)
-        wiki = 1
-
-      var projectLogo = req.files.logo
-      var projectPicture = req.files.src
-      var projectLogoPath, projectPicturePath
-      
-      if (projectLogo) {
-        // raise error if size limit is exceeded
-        if (projectLogo.size === pictSizeLimit) {
-          req.flash('error', 'Projektlogo exceeds 1 MB');
-          res.redirect('/addprojectoverview');
-        }
-        else {
-          // TEST PATH FOR DEVELOPMENT (LOCALHOST)
-          projectLogoPath = './folder-in-server-to-save-projektlogo/'+req.body.pname+'/'+projectLogo.name
-          // PATH FOR TEST/LIVE SERVER
-          // var projectLogoPath = to-be-defined
-        }
-      }
-      if (projectPicture) {
-        // raise error if size limit is exceeded
-        if (projectPicture.size === pictSizeLimit) {
-          req.flash('error', 'Projektbild exceeds 1 MB');
-          res.redirect('/addprojectoverview');
-        }
-        else {
-          // TEST PATH FOR DEVELOPMENT (LOCALHOST)
-          projectPicturePath = './folder-in-server-to-save-projektbild/'+req.body.pname+'/'+projectPicture.name
-          // PATH FOR TEST/LIVE SERVER
-          // var projectPicturePath = to-be-defined
-        }
-        
-      }
-      
-      var projectTerm = req.body.termForm + " - " + req.body.termTo
-      var projectOverviewData = {
-        pname: req.body.pname,
-        title: req.body.title,
-        onelinesummary: req.body.summary,
-        category: req.body.category,
-        logo: projectLogoPath,
-        gitlab: req.body.gitlabURL,
-        wiki: wiki,
-        overview: req.body.overview,
-        question: req.body.question,
-        approach: req.body.approach,
-        result: req.body.result,
-        keywords: req.body.keywords,
-        announcement: req.body.announcement,
-        term: projectTerm,
-        further_details: req.body.furtherDetails,
-        website: req.body.website,
-        src: projectPicturePath,
-        caption: req.body.caption,
-        contact_lastname: req.body.contactName,
-        contact_email: req.body.contactEmail,
-        leader_lastname: req.body.leaderName,
-        leader_email: req.body.leaderEmail
-      }
-      
-      // save pictures
-      if (projectLogo) {
-        projectLogo.mv(projectLogoPath, function(err) {
-          if (err) {
-            console.error(err)
-            res.status(500).render(lang+'/500', {
-              error: err
-            })
-          }
-        });
-      }
-      if (projectPicture) {
-        projectPicture.mv(projectPicturePath, function(err) {
-          if (err) {
-            console.error(err)
-            res.status(500).render(lang+'/500', {
-              error: err
-            })
-          }
+        res.render(lang+'/project/mailinglists', {
+          //isUserAuthenticated: req.isAuthenticated(),
+          //user: req.user,
+          mailinglists: allMailingLists
         });
       }
-
-      /* RS: Temporary solution while Project DB is still in early phase.
-              When User DB and Project DB are integrated and quite stabil, this operation should be done in 1 transaction.
-      */
-      var userId // todo: make this global variable?
-      async.waterfall([
-        // get userId by email from userdb
-        function(done) {
-          methods.getUserIdByEmail(req.user.email, function(id, err) {
-            if (!err) {
-              userId = id
-              done(err)
-            }
-          })
-        },
-        // add project overview
-        function(done) {
-          methods.addProjectOverview(projectOverviewData, function(data, err){
-            if (err) {
-              res.status(500).render(lang+'/500', {
-                error: err
-              })
-            }
-            else {
-              done(err, data.insertId)
-            }
-          })
-        },
-        // assign the created overview to logged-in user
-        function(projectOverviewId, done) {
-          var userProjectRoleData = {
-            project_id: projectOverviewId,
-            user_id: userId,
-            role_id: 3 // OVERVIEW_CREATOR
-          }
-          methods.addUserProjectRole(userProjectRoleData, function(userProjects, err) {
-            if (err) {
-              //req.flash('error', "Failed")
-              req.flash('error', "Fehlgeschlagen")
-              res.redirect('/addProjectOverview');
-            }
-            else {
-              req.flash('success', 'Your project has been created.')
-              res.redirect('/project');
-            }
-          })
-        }
-      ])
-    }
-  })
-
-  app.post('/updateprojectoverview', function (req, res) {
-    // only their own project
+    ])
   })
 
-  app.get('/projectoverview', function(req, res){
+  app.get('/projectoverview', function(req:any, res:any){
     async.waterfall([
-      function(done) {
-        methods.getProjectOverviewById(req.query.projectID, function(projectOverview, err) {
+      function(done:any) {
+        methods.getProjectOverviewById(req.query.projectID, function(projectOverview:any, err:any) {
           if (!err) {
             done(err, projectOverview)
           }
         })
       },
-      function(projectOverview,done){
-        methods.getProjectImagesById(req.query.projectID, function(projectImages, err) {
+      function(projectOverview:any, done:any){
+        methods.getProjectImagesById(req.query.projectID, function(projectImages:any, err:any) {
           if (!err) {
             done(err, projectImages, projectOverview)
           }
         })
       },
       // render projectOverview page
-      function(projectImages, projectOverview, done) {
-        console.log(projectImages)
-        partnerWebsites = helpers.stringToArray(projectOverview[0].partner_website)
-        partnerNames = helpers.stringToArray(projectOverview[0].partner_name)
-        awardSites = helpers.stringToArray(projectOverview[0].award_website)
-        awardNames = helpers.stringToArray(projectOverview[0].award_name)
-        sponsorWebsites = helpers.stringToArray(projectOverview[0].sponsor_website)
-        sponsorImgs = helpers.stringToArray(projectOverview[0].sponsor_img)
-        sponsorNames = helpers.stringToArray(projectOverview[0].sponsor_name)
+      function(projectImages:any, projectOverview:any) {
+        //console.log(projectImages)
+        let partnerWebsites = helpers.stringToArray(projectOverview[0].partner_website)
+        let partnerNames = helpers.stringToArray(projectOverview[0].partner_name)
+        let awardSites = helpers.stringToArray(projectOverview[0].award_website)
+        let awardNames = helpers.stringToArray(projectOverview[0].award_name)
+        let sponsorWebsites = helpers.stringToArray(projectOverview[0].sponsor_website)
+        let sponsorImgs = helpers.stringToArray(projectOverview[0].sponsor_img)
+        let sponsorNames = helpers.stringToArray(projectOverview[0].sponsor_name)
 
         res.render(lang+'/project/projectOverview', {
-          isUserAuthenticated: req.isAuthenticated(),
-          user: req.user,
+          //isUserAuthenticated: req.isAuthenticated(),
+          //user: req.user,
           projectOV: projectOverview,
           projectImgs: projectImages,
           partnerWS: partnerWebsites,
@@ -251,7 +90,7 @@ module.exports = function (app) {
   })
 
   // Projektdaten
-  app.get('/projektdaten', async function(req, res){
+  app.get('/projektdaten', async function(req:any, res:any){
     let projectArr = []
     let isProject = true
     let firstId = 0
@@ -293,7 +132,7 @@ module.exports = function (app) {
   })
 
   // Projektinformationen
-  app.get('/projektinformationen', async function(req, res){
+  app.get('/projektinformationen', async function(req:any, res:any){
     let pagesArr = []
     let isProject = true
     let firstId = 0

tsconfig.json

+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "rootDir": "./",
+    "outDir": "./built",
+    "esModuleInterop": true,
+    "strict": true,
+    "allowJs": true
+  }
+}
\ No newline at end of file