CompileController.js 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. /*
  2. * decaffeinate suggestions:
  3. * DS101: Remove unnecessary use of Array.from
  4. * DS102: Remove unnecessary code created because of implicit returns
  5. * DS207: Consider shorter variations of null checks
  6. * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
  7. */
  8. let CompileController;
  9. const RequestParser = require("./RequestParser");
  10. const CompileManager = require("./CompileManager");
  11. const Settings = require("settings-sharelatex");
  12. const Metrics = require("./Metrics");
  13. const ProjectPersistenceManager = require("./ProjectPersistenceManager");
  14. const logger = require("logger-sharelatex");
  15. const Errors = require("./Errors");
  16. module.exports = (CompileController = {
  17. compile(req, res, next) {
  18. if (next == null) { next = function(error) {}; }
  19. const timer = new Metrics.Timer("compile-request");
  20. return RequestParser.parse(req.body, function(error, request) {
  21. if (error != null) { return next(error); }
  22. request.project_id = req.params.project_id;
  23. if (req.params.user_id != null) { request.user_id = req.params.user_id; }
  24. return ProjectPersistenceManager.markProjectAsJustAccessed(request.project_id, function(error) {
  25. if (error != null) { return next(error); }
  26. return CompileManager.doCompileWithLock(request, function(error, outputFiles) {
  27. let code, status;
  28. if (outputFiles == null) { outputFiles = []; }
  29. if (error instanceof Errors.AlreadyCompilingError) {
  30. code = 423; // Http 423 Locked
  31. status = "compile-in-progress";
  32. } else if (error instanceof Errors.FilesOutOfSyncError) {
  33. code = 409; // Http 409 Conflict
  34. status = "retry";
  35. } else if (error != null ? error.terminated : undefined) {
  36. status = "terminated";
  37. } else if (error != null ? error.validate : undefined) {
  38. status = `validation-${error.validate}`;
  39. } else if (error != null ? error.timedout : undefined) {
  40. status = "timedout";
  41. logger.log({err: error, project_id: request.project_id}, "timeout running compile");
  42. } else if (error != null) {
  43. status = "error";
  44. code = 500;
  45. logger.warn({err: error, project_id: request.project_id}, "error running compile");
  46. } else {
  47. let file;
  48. status = "failure";
  49. for (file of Array.from(outputFiles)) {
  50. if (file.path != null ? file.path.match(/output\.pdf$/) : undefined) {
  51. status = "success";
  52. }
  53. }
  54. if (status === "failure") {
  55. logger.warn({project_id: request.project_id, outputFiles}, "project failed to compile successfully, no output.pdf generated");
  56. }
  57. // log an error if any core files are found
  58. for (file of Array.from(outputFiles)) {
  59. if (file.path === "core") {
  60. logger.error({project_id:request.project_id, req, outputFiles}, "core file found in output");
  61. }
  62. }
  63. }
  64. if (error != null) {
  65. outputFiles = error.outputFiles || [];
  66. }
  67. timer.done();
  68. return res.status(code || 200).send({
  69. compile: {
  70. status,
  71. error: (error != null ? error.message : undefined) || error,
  72. outputFiles: outputFiles.map(file =>
  73. ({
  74. url:
  75. `${Settings.apis.clsi.url}/project/${request.project_id}` +
  76. ((request.user_id != null) ? `/user/${request.user_id}` : "") +
  77. ((file.build != null) ? `/build/${file.build}` : "") +
  78. `/output/${file.path}`,
  79. path: file.path,
  80. type: file.type,
  81. build: file.build
  82. })
  83. )
  84. }
  85. });
  86. });
  87. });
  88. });
  89. },
  90. stopCompile(req, res, next) {
  91. const {project_id, user_id} = req.params;
  92. return CompileManager.stopCompile(project_id, user_id, function(error) {
  93. if (error != null) { return next(error); }
  94. return res.sendStatus(204);
  95. });
  96. },
  97. clearCache(req, res, next) {
  98. if (next == null) { next = function(error) {}; }
  99. return ProjectPersistenceManager.clearProject(req.params.project_id, req.params.user_id, function(error) {
  100. if (error != null) { return next(error); }
  101. return res.sendStatus(204);
  102. });
  103. }, // No content
  104. syncFromCode(req, res, next) {
  105. if (next == null) { next = function(error) {}; }
  106. const { file } = req.query;
  107. const line = parseInt(req.query.line, 10);
  108. const column = parseInt(req.query.column, 10);
  109. const { project_id } = req.params;
  110. const { user_id } = req.params;
  111. return CompileManager.syncFromCode(project_id, user_id, file, line, column, function(error, pdfPositions) {
  112. if (error != null) { return next(error); }
  113. return res.json({
  114. pdf: pdfPositions
  115. });
  116. });
  117. },
  118. syncFromPdf(req, res, next) {
  119. if (next == null) { next = function(error) {}; }
  120. const page = parseInt(req.query.page, 10);
  121. const h = parseFloat(req.query.h);
  122. const v = parseFloat(req.query.v);
  123. const { project_id } = req.params;
  124. const { user_id } = req.params;
  125. return CompileManager.syncFromPdf(project_id, user_id, page, h, v, function(error, codePositions) {
  126. if (error != null) { return next(error); }
  127. return res.json({
  128. code: codePositions
  129. });
  130. });
  131. },
  132. wordcount(req, res, next) {
  133. if (next == null) { next = function(error) {}; }
  134. const file = req.query.file || "main.tex";
  135. const { project_id } = req.params;
  136. const { user_id } = req.params;
  137. const { image } = req.query;
  138. logger.log({image, file, project_id}, "word count request");
  139. return CompileManager.wordcount(project_id, user_id, file, image, function(error, result) {
  140. if (error != null) { return next(error); }
  141. return res.json({
  142. texcount: result
  143. });
  144. });
  145. },
  146. status(req, res, next ){
  147. if (next == null) { next = function(error){}; }
  148. return res.send("OK");
  149. }
  150. });