InstitutionsAPI.js 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. const OError = require('@overleaf/o-error')
  2. const logger = require('logger-sharelatex')
  3. const metrics = require('@overleaf/metrics')
  4. const settings = require('settings-sharelatex')
  5. const request = require('request')
  6. const { promisifyAll } = require('../../util/promises')
  7. const NotificationsBuilder = require('../Notifications/NotificationsBuilder')
  8. const {
  9. V1ConnectionError,
  10. InvalidInstitutionalEmailError
  11. } = require('../Errors/Errors')
  12. const InstitutionsAPI = {
  13. getInstitutionAffiliations(institutionId, callback) {
  14. makeAffiliationRequest(
  15. {
  16. method: 'GET',
  17. path: `/api/v2/institutions/${institutionId.toString()}/affiliations`,
  18. defaultErrorMessage: "Couldn't get institution affiliations"
  19. },
  20. (error, body) => callback(error, body || [])
  21. )
  22. },
  23. getLicencesForAnalytics(lag, queryDate, callback) {
  24. makeAffiliationRequest(
  25. {
  26. method: 'GET',
  27. path: `/api/v2/institutions/institutions_licences`,
  28. body: { query_date: queryDate, lag },
  29. defaultErrorMessage: 'Could not get institutions licences'
  30. },
  31. callback
  32. )
  33. },
  34. getInstitutionLicences(institutionId, startDate, endDate, lag, callback) {
  35. makeAffiliationRequest(
  36. {
  37. method: 'GET',
  38. path: `/api/v2/institutions/${institutionId.toString()}/institution_licences`,
  39. body: { start_date: startDate, end_date: endDate, lag },
  40. defaultErrorMessage: "Couldn't get institution licences"
  41. },
  42. callback
  43. )
  44. },
  45. getInstitutionNewLicences(institutionId, startDate, endDate, lag, callback) {
  46. makeAffiliationRequest(
  47. {
  48. method: 'GET',
  49. path: `/api/v2/institutions/${institutionId.toString()}/new_institution_licences`,
  50. body: { start_date: startDate, end_date: endDate, lag },
  51. defaultErrorMessage: "Couldn't get institution new licences"
  52. },
  53. callback
  54. )
  55. },
  56. getUserAffiliations(userId, callback) {
  57. makeAffiliationRequest(
  58. {
  59. method: 'GET',
  60. path: `/api/v2/users/${userId.toString()}/affiliations`,
  61. defaultErrorMessage: "Couldn't get user affiliations"
  62. },
  63. (error, body) => callback(error, body || [])
  64. )
  65. },
  66. addAffiliation(userId, email, affiliationOptions, callback) {
  67. if (!callback) {
  68. // affiliationOptions is optional
  69. callback = affiliationOptions
  70. affiliationOptions = {}
  71. }
  72. const {
  73. university,
  74. department,
  75. role,
  76. confirmedAt,
  77. entitlement,
  78. rejectIfBlocklisted
  79. } = affiliationOptions
  80. makeAffiliationRequest(
  81. {
  82. method: 'POST',
  83. path: `/api/v2/users/${userId.toString()}/affiliations`,
  84. body: {
  85. email,
  86. university,
  87. department,
  88. role,
  89. confirmedAt,
  90. entitlement,
  91. rejectIfBlocklisted
  92. },
  93. defaultErrorMessage: "Couldn't create affiliation"
  94. },
  95. function(error, body) {
  96. if (error) {
  97. if (error.info && error.info.statusCode === 422) {
  98. return callback(
  99. new InvalidInstitutionalEmailError(error.message).withCause(error)
  100. )
  101. }
  102. return callback(error)
  103. }
  104. if (!university) {
  105. return callback(null, body)
  106. }
  107. // have notifications delete any ip matcher notifications for this university
  108. NotificationsBuilder.ipMatcherAffiliation(userId).read(
  109. university.id,
  110. function(err) {
  111. if (err) {
  112. // log and ignore error
  113. logger.err(
  114. { err },
  115. 'Something went wrong marking ip notifications read'
  116. )
  117. }
  118. callback(null, body)
  119. }
  120. )
  121. }
  122. )
  123. },
  124. removeAffiliation(userId, email, callback) {
  125. makeAffiliationRequest(
  126. {
  127. method: 'POST',
  128. path: `/api/v2/users/${userId.toString()}/affiliations/remove`,
  129. body: { email },
  130. extraSuccessStatusCodes: [404], // `Not Found` responses are considered successful
  131. defaultErrorMessage: "Couldn't remove affiliation"
  132. },
  133. callback
  134. )
  135. },
  136. endorseAffiliation(userId, email, role, department, callback) {
  137. makeAffiliationRequest(
  138. {
  139. method: 'POST',
  140. path: `/api/v2/users/${userId.toString()}/affiliations/endorse`,
  141. body: { email, role, department },
  142. defaultErrorMessage: "Couldn't endorse affiliation"
  143. },
  144. callback
  145. )
  146. },
  147. deleteAffiliations(userId, callback) {
  148. makeAffiliationRequest(
  149. {
  150. method: 'DELETE',
  151. path: `/api/v2/users/${userId.toString()}/affiliations`,
  152. defaultErrorMessage: "Couldn't delete affiliations"
  153. },
  154. callback
  155. )
  156. },
  157. addEntitlement(userId, email, callback) {
  158. makeAffiliationRequest(
  159. {
  160. method: 'POST',
  161. path: `/api/v2/users/${userId}/affiliations/add_entitlement`,
  162. body: { email },
  163. defaultErrorMessage: "Couldn't add entitlement"
  164. },
  165. callback
  166. )
  167. },
  168. removeEntitlement(userId, email, callback) {
  169. makeAffiliationRequest(
  170. {
  171. method: 'POST',
  172. path: `/api/v2/users/${userId}/affiliations/remove_entitlement`,
  173. body: { email },
  174. defaultErrorMessage: "Couldn't remove entitlement"
  175. },
  176. callback
  177. )
  178. }
  179. }
  180. var makeAffiliationRequest = function(requestOptions, callback) {
  181. if (!settings.apis.v1.url) {
  182. return callback(null)
  183. } // service is not configured
  184. if (!requestOptions.extraSuccessStatusCodes) {
  185. requestOptions.extraSuccessStatusCodes = []
  186. }
  187. request(
  188. {
  189. method: requestOptions.method,
  190. url: `${settings.apis.v1.url}${requestOptions.path}`,
  191. body: requestOptions.body,
  192. auth: { user: settings.apis.v1.user, pass: settings.apis.v1.pass },
  193. json: true,
  194. timeout: 20 * 1000
  195. },
  196. function(error, response, body) {
  197. if (error) {
  198. return callback(
  199. new V1ConnectionError('error getting affiliations from v1').withCause(
  200. error
  201. )
  202. )
  203. }
  204. if (response && response.statusCode >= 500) {
  205. return callback(
  206. new V1ConnectionError({
  207. message: 'error getting affiliations from v1',
  208. info: {
  209. status: response.statusCode,
  210. body: body
  211. }
  212. })
  213. )
  214. }
  215. let isSuccess = response.statusCode >= 200 && response.statusCode < 300
  216. if (!isSuccess) {
  217. isSuccess = requestOptions.extraSuccessStatusCodes.includes(
  218. response.statusCode
  219. )
  220. }
  221. if (!isSuccess) {
  222. let errorMessage
  223. if (body && body.errors) {
  224. errorMessage = `${response.statusCode}: ${body.errors}`
  225. } else {
  226. errorMessage = `${requestOptions.defaultErrorMessage}: ${response.statusCode}`
  227. }
  228. logger.warn(
  229. { path: requestOptions.path, body: requestOptions.body },
  230. errorMessage
  231. )
  232. return callback(
  233. new OError(errorMessage, { statusCode: response.statusCode })
  234. )
  235. }
  236. callback(null, body)
  237. }
  238. )
  239. }
  240. ;[
  241. 'getInstitutionAffiliations',
  242. 'getUserAffiliations',
  243. 'addAffiliation',
  244. 'removeAffiliation'
  245. ].map(method =>
  246. metrics.timeAsyncMethod(
  247. InstitutionsAPI,
  248. method,
  249. 'mongo.InstitutionsAPI',
  250. logger
  251. )
  252. )
  253. InstitutionsAPI.promises = promisifyAll(InstitutionsAPI)
  254. module.exports = InstitutionsAPI