app/controllers/survey-controller.js

  1. /**
  2.  * @module survey-controller
  3.  */
  5. const utils = require('../lib/utils');
  6. const TError = require('../lib/custom-error').TranslatedError;
  7. const communicator = require('../lib/communicator');
  8. const surveyModel = require('../models/survey-model');
  9. const userModel = require('../models/user-model');
  10. const config = require('../models/config-model').server;
  11. const express = require('express');
  13. const router = express.Router();
  14. const routerUtils = require('../lib/router-utils');
  15. // var debug = require( 'debug' )( 'survey-controller' );
  17. module.exports = (app) => {
  18.     app.use(`${app.get('base path')}/`, router);
  19. };
  21. router.param('enketo_id', routerUtils.enketoId);
  22. router.param('encrypted_enketo_id_single', routerUtils.encryptedEnketoIdSingle);
  23. router.param('encrypted_enketo_id_view', routerUtils.encryptedEnketoIdView);
  25. router.param('mod', (req, rex, next, mod) => {
  26.     if (mod === 'i') {
  27.         req.iframe = true;
  28.         next();
  29.     } else {
  30.         req.iframe = false;
  31.         next('route');
  32.     }
  33. });
  35. router
  36.     // .get( '*', loggedInCheck )
  37.     .get(`${config['offline path']}/:enketo_id`, offlineWebform)
  38.     .get(`${config['offline path']}/`, redirect)
  39.     .get('/connection', (req, res) => {
  40.         res.status = 200;
  41.         res.send(`connected ${Math.random()}`);
  42.     })
  43.     .get('/preview', preview)
  44.     .get('/preview/:mod', preview)
  45.     .get('/preview/:enketo_id', preview)
  46.     .get('/preview/:mod/:enketo_id', preview)
  47.     .get('/:enketo_id', webform)
  48.     .get('/:mod/:enketo_id', webform)
  49.     .get('/single/:enketo_id', single)
  50.     .get('/single/:encrypted_enketo_id_single', single)
  51.     .get('/single/:mod/:enketo_id', single)
  52.     .get('/single/:mod/:encrypted_enketo_id_single', single)
  53.     .get('/view/:encrypted_enketo_id_view', view)
  54.     .get('/view/:mod/:encrypted_enketo_id_view', view)
  55.     .get('/edit/:enketo_id', edit)
  56.     .get('/edit/:mod/:enketo_id', edit)
  57.     .get('/xform/:enketo_id', xform)
  58.     .get('/xform/:encrypted_enketo_id_single', xform)
  59.     .get('/xform/:encrypted_enketo_id_view', xform)
  60.     .get(/.*\/::[A-z0-9]{4,8}/, redirect);
  62. // TODO: I suspect this check is no longer used and can be removed
  63. // function loggedInCheck( req, res, next ) {
  64. //    req.logout = !!userModel.getCredentials( req );
  65. //    next();
  66. // }
  68. /**
  69.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  70.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  71.  * @param {Function} next - Express callback
  72.  */
  73. function offlineWebform(req, res, next) {
  74.     if (!req.app.get('offline enabled')) {
  75.         const error = new Error(
  76.             'Offline functionality has not been enabled for this application.'
  77.         );
  78.         error.status = 405;
  79.         next(error);
  80.     } else {
  81.         req.offlinePath = config['offline path'];
  82.         webform(req, res, next);
  83.     }
  84. }
  86. /**
  87.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  88.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  89.  * @param {Function} next - Express callback
  90.  */
  91. function webform(req, res, next) {
  92.     const options = {
  93.         offlinePath: req.offlinePath,
  94.         iframe: req.iframe,
  95.         print: req.query.print === 'true',
  96.         desktop: req.query.desktop === 'true',
  97.     };
  99.     _renderWebform(req, res, next, options);
  100. }
  102. /**
  103.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  104.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  105.  * @param {Function} next - Express callback
  106.  */
  107. function single(req, res, next) {
  108.     const options = {
  109.         type: 'single',
  110.         iframe: req.iframe,
  111.     };
  112.     if (req.encryptedEnketoId && req.cookies[req.encryptedEnketoId]) {
  113.         res.redirect(
  114.             `${req.baseUrl}/thanks?taken=${req.cookies[req.encryptedEnketoId]}`
  115.         );
  116.     } else {
  117.         _renderWebform(req, res, next, options);
  118.     }
  119. }
  121. /**
  122.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  123.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  124.  * @param {Function} next - Express callback
  125.  */
  126. function view(req, res, next) {
  127.     const options = {
  128.         type: 'view',
  129.         iframe: req.iframe,
  130.         print: req.query.print === 'true',
  131.     };
  133.     _renderWebform(req, res, next, options);
  134. }
  136. /**
  137.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  138.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  139.  * @param {Function} next - Express callback
  140.  */
  141. function preview(req, res, next) {
  142.     const options = {
  143.         type: 'preview',
  144.         iframe: req.iframe || !!req.query.iframe,
  145.         notification: utils.pickRandomItemFromArray(config.notifications),
  146.     };
  148.     _renderWebform(req, res, next, options);
  149. }
  151. /**
  152.  * This serves a page that redirects old pre-2.0.0 urls into new urls.
  153.  * The reason this on the client-side is to cache the redirect itself which is important
  154.  * in case people have bookmarked an offline-capable old-style url and go into the field without Internet.
  155.  *
  156.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  157.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  158.  */
  159. function redirect(req, res) {
  160.     res.render('surveys/webform-redirect');
  161. }
  163. /**
  164.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  165.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  166.  * @param {Function} next - Express callback
  167.  */
  168. function edit(req, res, next) {
  169.     const options = {
  170.         type: 'edit',
  171.         iframe: req.iframe,
  172.     };
  174.     if (req.query.instance_id) {
  175.         _renderWebform(req, res, next, options);
  176.     } else {
  177.         const error = new TError('error.invalidediturl');
  178.         error.status = 400;
  179.         next(error);
  180.     }
  181. }
  183. /**
  184.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  185.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  186.  * @param {Function} next - Express callback
  187.  * @param { object } options - Options passed to render
  188.  */
  189. function _renderWebform(req, res, next, options) {
  190.     const deviceId =
  191.         req.signedCookies.__enketo_meta_deviceid ||
  192.         `${req.hostname}:${utils.randomString(16)}`;
  193.     const cookieOptions = {
  194.         signed: true,
  195.         maxAge: 10 * 365 * 24 * 60 * 60 * 1000,
  196.     };
  198.     res.cookie('__enketo_meta_deviceid', deviceId, cookieOptions).render(
  199.         'surveys/webform',
  200.         options
  201.     );
  202. }
  204. /**
  205.  * Debugging view that shows underlying XForm
  206.  *
  207.  * @param {module:api-controller~ExpressRequest} req - HTTP request
  208.  * @param {module:api-controller~ExpressResponse} res - HTTP response
  209.  * @param {Function} next - Express callback
  210.  */
  211. function xform(req, res, next) {
  212.     return surveyModel
  213.         .get(req.enketoId)
  214.         .then((survey) => {
  215.             survey.credentials = userModel.getCredentials(req);
  217.             return survey;
  218.         })
  219.         .then(communicator.getXFormInfo)
  220.         .then(communicator.getXForm)
  221.         .then((survey) => {
  222.             res.set('Content-Type', 'text/xml').send(survey.xform);
  223.         })
  224.         .catch(next);
  225. }