First commit for open-source Ġabra API

Author: johnjcamilleri

.gitignore

@@ -0,0 +1,33 @@
+# Server config is private
+server-config.js
+
+# Data dumps
+public/data/*
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
+node_modules

README.md

@@ -0,0 +1,23 @@
+API for Ġabra
+-------------
+
+Ġabra is an open lexicon for Maltese.
+
+## Installation
+
+### Web app
+
+- You need NodeJS. After cloning the repo run `npm install` to install Node packages locally.
+
+- You will need a file `server-config.js` with relevant details for your host.
+  Start by copying `server-config.sample.js`.
+
+### Database
+
+- You will need a MongoDB installation.
+  See <http://mlrs.research.um.edu.mt/resources/gabra-api/download> for data dumps you can use to get started.
+  TODO: non-data tables
+
+## Running
+
+Use PM2: `pm2 start processes.json` or just run the file `start.sh`.

app.js

@@ -0,0 +1,156 @@
+var express = require('express')
+var path = require('path')
+var logger = require('morgan')
+var cookieParser = require('cookie-parser')
+var bodyParser = require('body-parser')
+var compression = require('compression')
+
+var app = express()
+
+app.use(compression()) // compress all requests
+
+// view engine setup
+app.set('views', path.join(__dirname, 'views'))
+app.set('view engine', 'jade')
+app.locals.pretty = true
+
+app.use(logger('dev'))
+app.use(bodyParser.json())
+app.use(bodyParser.urlencoded({ extended: false }))
+app.use(cookieParser())
+var cache_static = '7 days'
+app.use(express.static(path.join(__dirname, 'public'), {maxAge: cache_static}))
+
+// CORS
+app.use(function (req, res, next) {
+  // var allowed = [
+  //   'http://localhost',
+  //   'http://mlrs.research.um.edu.mt'
+  // ]
+  // var origin = req.headers.origin
+  // if (allowed.indexOf(origin) !== -1) {
+  //   res.header('Access-Control-Allow-Origin', origin)
+  // }
+  res.header('Access-Control-Allow-Origin', '*')
+  next()
+})
+
+// Load server-specific config
+var config = require('./server-config')
+app.use(function (req, res, next) {
+  res.locals = config
+  next()
+})
+
+// Stop if maintenance mode
+app.use(function (req, res, next) {
+  if (res.locals.maintenanceMode) {
+    res.status('503')
+    res.header('Retry-After', 120) // two minutes
+    res.send('Down for maintenance')
+    res.end()
+  } else {
+    next()
+  }
+})
+
+// Database
+var monk = require('monkii')
+var db = monk(config.dbUrl, config.dbOptions)
+// Make our db accessible to our router
+app.use(function (req, res, next) {
+  req.db = db
+  next()
+})
+
+// Authentication
+var passport = require('passport')
+var BasicStrategy = require('passport-http').BasicStrategy
+passport.use(new BasicStrategy(
+  function (username, password, done) {
+    db.get('users').findOne({username: username}, function (err, user) {
+      var salted = config.salt + password
+      var shasum = require('crypto').createHash('sha1')
+      var hashed = shasum.update(salted).digest('hex')
+      if (err) { return done(err) }
+      if (!user) { return done(null, false, {message: 'Unknown user.'}) }
+      if (user.password !== hashed) { return done(null, false, {message: 'Incorrect password.'}) }
+      return done(null, user)
+    })
+  }
+))
+app.use(passport.initialize())
+
+// Analytics
+if (config.analyticsCode) {
+  app.set('trust proxy', 'loopback')
+  var ua = require('universal-analytics')
+  var visitor = ua(config.analyticsCode)
+  var pageview = function (req, res, next) {
+    var params = {
+      'dp': req.originalUrl,
+      'uip': req.ip
+    }
+    visitor.pageview(params, function (err) {
+      if (err) {
+        console.log(err)
+      }
+    })
+    next()
+  }
+  if (!config.developmentMode) {
+    app.use('/lexemes', pageview)
+    app.use('/wordforms', pageview)
+    app.use('/roots', pageview)
+  }
+}
+
+// Routing
+app.use('/', require('./routes/index'))
+app.use('/lexemes', require('./routes/lexemes'))
+app.use('/wordforms', require('./routes/wordforms'))
+app.use('/roots', require('./routes/roots'))
+app.use('/sources', require('./routes/sources'))
+app.use('/feedback', require('./routes/feedback'))
+app.use('/logs', require('./routes/logs'))
+app.use('/i18n', require('./routes/i18n'))
+app.use('/morpho', require('./routes/morpho'))
+
+// http://stackoverflow.com/a/27464258/98600
+// app.use('/json-editor', express.static(__dirname + '/node_modules/json-editor/dist/'))
+// app.use('/bootstrap', express.static(__dirname + '/node_modules/bootstrap/dist/'))
+// app.use('/ladda', express.static(__dirname + '/node_modules/ladda/dist/'))
+app.use('/module', express.static(path.join(__dirname, '/node_modules/'), {maxAge: cache_static}))
+
+// catch 404 and forward to error handler
+app.use(function (req, res, next) {
+  var err = new Error('Not Found')
+  err.status = 404
+  next(err)
+})
+
+// error handlers
+
+// development error handler
+// will print stacktrace
+if (app.get('env') === 'development') {
+  app.use(function (err, req, res, next) {
+    res.status(err.status || 500)
+    res.render('error', {
+      message: err.message,
+      error: err
+    })
+  })
+}
+
+// production error handler
+// no stacktraces leaked to user
+app.use(function (err, req, res, next) {
+  res.status(err.status || 500)
+  res.render('error', {
+    message: err.message,
+    error: {}
+  })
+})
+
+module.exports = app

bin/www

@@ -0,0 +1,92 @@
+#!/usr/bin/env node
+
+// process.env.DEBUG = 'monk:queries'
+
+/**
+ * Module dependencies.
+ */
+
+var app = require('../app');
+var debug = require('debug')('api:server');
+var http = require('http');
+
+/**
+ * Get port from environment and store in Express.
+ */
+
+var port = normalizePort(process.env.PORT || '3000');
+app.set('port', port);
+
+/**
+ * Create HTTP server.
+ */
+
+var server = http.createServer(app);
+
+/**
+ * Listen on provided port, on all network interfaces.
+ */
+
+server.listen(port);
+server.on('error', onError);
+server.on('listening', onListening);
+
+/**
+ * Normalize a port into a number, string, or false.
+ */
+
+function normalizePort(val) {
+  var port = parseInt(val, 10);
+
+  if (isNaN(port)) {
+    // named pipe
+    return val;
+  }
+
+  if (port >= 0) {
+    // port number
+    return port;
+  }
+
+  return false;
+}
+
+/**
+ * Event listener for HTTP server "error" event.
+ */
+
+function onError(error) {
+  if (error.syscall !== 'listen') {
+    throw error;
+  }
+
+  var bind = typeof port === 'string'
+    ? 'Pipe ' + port
+    : 'Port ' + port;
+
+  // handle specific listen errors with friendly messages
+  switch (error.code) {
+    case 'EACCES':
+      console.error(bind + ' requires elevated privileges');
+      process.exit(1);
+      break;
+    case 'EADDRINUSE':
+      console.error(bind + ' is already in use');
+      process.exit(1);
+      break;
+    default:
+      throw error;
+  }
+}
+
+/**
+ * Event listener for HTTP server "listening" event.
+ */
+
+function onListening() {
+  var addr = server.address();
+  var bind = typeof addr === 'string'
+    ? 'pipe ' + addr
+    : 'port ' + addr.port;
+  debug('Listening on ' + bind);
+}

logger.js

@@ -0,0 +1,24 @@
+// for logging changes to Gabra
+module.exports = {
+
+  // Make a logger: a function which asynchronously adds update to log
+  // ObjectID can be either object or string
+  makeLogger: function (collection_name) {
+    return function (req, object_id, new_val) {
+      var coll = req.db.get('logs')
+      var user = req.user ? req.user.username : ''
+      if (typeof object_id !== 'object') {
+        object_id = coll.id(object_id)
+      }
+      var obj = {
+        'collection': collection_name,
+        'object_id': object_id,
+        'date': new Date(),
+        'new_value': new_val,
+        'username': user
+      }
+      coll.insert(obj)
+    }
+  }
+
+}

morpho/adjective.js

@@ -0,0 +1,61 @@
+var extend = require('extend')
+module.exports = {
+
+  inflect: function (body, callback) {
+    var lemma = body.lemma // 'bravu'
+    if (!lemma) {
+      return callback('No lemma provided', null)
+    }
+
+    var infs = inflections(lemma)
+    var forms = [
+      {
+        'surface_form': infs.m,
+        'number': 'sg',
+        'gender': 'm'
+      },
+      {
+        'surface_form': infs.f,
+        'number': 'sg',
+        'gender': 'f'
+      },
+      {
+        'surface_form': infs.pl,
+        'number': 'pl',
+        'gender': 'mf'
+      }
+    ]
+    var extras = {
+      'sources': [sourceKey]
+    }
+    for (var f in forms) {
+      extend(true, forms[f], extras)
+    }
+
+    callback(null, forms)
+  }
+}
+
+const sourceKey = 'Camilleri2015'
+
+function inflections (lemma) {
+  var m = lemma
+  var f
+  var pl
+  if (lemma.match(/u$/)) { // bravu
+    var stem = lemma.slice(0, -1)
+    f = stem + 'a' // brava
+    pl = stem + 'i' // bravi
+  } else if (lemma.match(/i$/)) { // mimli
+    f = lemma + 'ja' // mimlija
+    pl = lemma + 'jin' // mimlijin
+  } else {
+    f = lemma + 'a' // maħmuġa
+    pl = lemma + 'in' // maħmuġin
+  }
+  return {
+    m: m,
+    f: f,
+    pl: pl
+  }
+}