overleaf/services/docstore/app/coffee/HttpController.js

DocManager = require "./DocManager"
logger = require "logger-sharelatex"
DocArchive = require "./DocArchiveManager"
HealthChecker = require "./HealthChecker"
Settings   = require "settings-sharelatex"


module.exports = HttpController =
	getDoc: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		doc_id     = req.params.doc_id
		include_deleted = req.query?.include_deleted == "true"
		logger.log project_id: project_id, doc_id: doc_id, "getting doc"
		DocManager.getFullDoc project_id, doc_id, (error, doc) ->
			return next(error) if error?
			logger.log {doc_id, project_id}, "got doc"
			if !doc?
				res.send 404
			else if doc.deleted && !include_deleted
				res.send 404
			else
				res.json HttpController._buildDocView(doc)

	getRawDoc: (req, res, next = (error)->)->
		project_id = req.params.project_id
		doc_id     = req.params.doc_id
		logger.log project_id: project_id, doc_id: doc_id, "getting raw doc"
		DocManager.getDocLines project_id, doc_id, (error, doc) ->
			return next(error) if error?
			if !doc?
				res.send 404
			else
				res.setHeader('content-type', 'text/plain')
				res.send HttpController._buildRawDocView(doc)

	getAllDocs: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		logger.log project_id: project_id, "getting all docs"
		DocManager.getAllNonDeletedDocs project_id, {lines: true, rev: true}, (error, docs = []) ->
			return next(error) if error?
			res.json HttpController._buildDocsArrayView(project_id, docs)
	
	getAllRanges: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		logger.log {project_id}, "getting all ranges"
		DocManager.getAllNonDeletedDocs project_id, {ranges: true}, (error, docs = []) ->
			return next(error) if error?
			res.json HttpController._buildDocsArrayView(project_id, docs)

	updateDoc: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		doc_id     = req.params.doc_id
		lines      = req.body?.lines
		version    = req.body?.version
		ranges     = req.body?.ranges

		if !lines? or lines not instanceof Array
			logger.error project_id: project_id, doc_id: doc_id, "no doc lines provided"
			res.send 400 # Bad Request
			return
		
		if !version? or typeof version is not "number"
			logger.error project_id: project_id, doc_id: doc_id, "no doc version provided"
			res.send 400 # Bad Request
			return
		
		if !ranges?
			logger.error project_id: project_id, doc_id: doc_id, "no doc ranges provided"
			res.send 400 # Bad Request
			return

		bodyLength = lines.reduce(
			(len, line) => line.length + len
			0
		)
		if bodyLength > Settings.max_doc_length
			logger.error project_id: project_id, doc_id: doc_id, bodyLength: bodyLength, "document body too large"
			res.status(413).send("document body too large")
			return

		logger.log project_id: project_id, doc_id: doc_id, "got http request to update doc"
		DocManager.updateDoc project_id, doc_id, lines, version, ranges, (error, modified, rev) ->
			return next(error) if error?
			res.json {
				modified: modified
				rev: rev
			}

	deleteDoc: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		doc_id     = req.params.doc_id
		logger.log project_id: project_id, doc_id: doc_id, "deleting doc"
		DocManager.deleteDoc project_id, doc_id, (error) ->
			return next(error) if error?
			res.send 204

	_buildDocView: (doc) -> 
		doc_view = { _id: doc._id?.toString() }
		for attribute in ["lines", "rev", "version", "ranges", "deleted"]
			if doc[attribute]?
				doc_view[attribute] = doc[attribute]
		return doc_view

	_buildRawDocView: (doc)->
		return (doc?.lines or []).join("\n")
	
	_buildDocsArrayView: (project_id, docs) ->
		docViews = []
		for doc in docs
			if doc? # There can end up being null docs for some reason :( (probably a race condition)
				docViews.push HttpController._buildDocView(doc)
			else
				logger.error err: new Error("null doc"), project_id: project_id, "encountered null doc"
		return docViews

	archiveAllDocs: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		logger.log project_id: project_id, "archiving all docs"
		DocArchive.archiveAllDocs project_id, (error) ->
			return next(error) if error?
			res.send 204

	unArchiveAllDocs: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		logger.log project_id: project_id, "unarchiving all docs"
		DocArchive.unArchiveAllDocs project_id, (error) ->
			return next(error) if error?
			res.send 200

	destroyAllDocs: (req, res, next = (error) ->) ->
		project_id = req.params.project_id
		logger.log project_id: project_id, "destroying all docs"
		DocArchive.destroyAllDocs project_id, (error) ->
			return next(error) if error?
			res.send 204

	healthCheck: (req, res)->
		HealthChecker.check (err)->
			if err?
				logger.err err:err, "error performing health check"
				res.send 500
			else
				res.send 200