hasPermission.js 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. import async from "async";
  2. import config from "config";
  3. // eslint-disable-next-line
  4. import moduleManager from "../../index";
  5. const permissions = {};
  6. permissions.dj = {
  7. "stations.autofill": true,
  8. "stations.blacklist": true,
  9. "stations.index": true,
  10. "stations.playback.toggle": true,
  11. "stations.queue.remove": true,
  12. "stations.queue.reposition": true,
  13. "stations.queue.reset": true,
  14. "stations.request": true,
  15. "stations.skip": true,
  16. "stations.view": true,
  17. "stations.view.manage": true
  18. };
  19. permissions.owner = {
  20. ...permissions.dj,
  21. "stations.djs.add": true,
  22. "stations.djs.remove": true,
  23. "stations.remove": true,
  24. "stations.update": true
  25. };
  26. permissions.moderator = {
  27. ...permissions.owner,
  28. "admin.view": true,
  29. "admin.view.import": true,
  30. "admin.view.news": true,
  31. "admin.view.playlists": true,
  32. "admin.view.punishments": true,
  33. "admin.view.reports": true,
  34. "admin.view.songs": true,
  35. "admin.view.stations": true,
  36. "admin.view.users": true,
  37. "admin.view.youtubeChannels": true,
  38. "admin.view.youtubeVideos": true,
  39. "apis.searchDiscogs": true,
  40. "news.create": true,
  41. "news.update": true,
  42. "playlists.create.admin": true,
  43. "playlists.get": true,
  44. "playlists.update.displayName": true,
  45. "playlists.update.privacy": true,
  46. "playlists.songs.add": true,
  47. "playlists.songs.remove": true,
  48. "playlists.songs.reposition": true,
  49. "playlists.view.others": true,
  50. "punishments.banIP": true,
  51. "punishments.get": true,
  52. "reports.get": true,
  53. "reports.update": true,
  54. "songs.create": true,
  55. "songs.get": true,
  56. "songs.update": true,
  57. "songs.verify": true,
  58. "stations.create.official": true,
  59. "stations.index": false,
  60. "stations.index.other": true,
  61. "stations.remove": false,
  62. "users.get": true,
  63. "users.ban": true,
  64. "users.requestPasswordReset": true,
  65. "users.resendVerifyEmail": true,
  66. "users.update": true,
  67. "youtube.requestSetAdmin": true
  68. };
  69. permissions.admin = {
  70. ...permissions.moderator,
  71. "admin.view.dataRequests": true,
  72. "admin.view.statistics": true,
  73. "admin.view.youtube": true,
  74. "dataRequests.resolve": true,
  75. "media.recalculateAllRatings": true,
  76. "media.removeImportJobs": true,
  77. "news.remove": true,
  78. "playlists.clearAndRefill": true,
  79. "playlists.clearAndRefillAll": true,
  80. "playlists.createMissing": true,
  81. "playlists.deleteOrphaned": true,
  82. "playlists.removeAdmin": true,
  83. "playlists.requestOrphanedPlaylistSongs": true,
  84. "punishments.deactivate": true,
  85. "reports.remove": true,
  86. "songs.remove": true,
  87. "songs.updateAll": true,
  88. "stations.clearEveryStationQueue": true,
  89. "stations.remove": true,
  90. "users.remove": true,
  91. "users.remove.sessions": true,
  92. "users.update.restricted": true,
  93. "utils.getModules": true,
  94. "youtube.getApiRequest": true,
  95. "youtube.getMissingChannels": true,
  96. "youtube.resetStoredApiRequests": true,
  97. "youtube.removeStoredApiRequest": true,
  98. "youtube.removeVideos": true
  99. };
  100. if (config.get("experimental.soundcloud")) {
  101. permissions.moderator["admin.view.soundcloudTracks"] = true;
  102. permissions.admin["admin.view.soundcloudTracks"] = true;
  103. permissions.moderator["admin.view.soundcloud"] = true;
  104. permissions.admin["admin.view.soundcloud"] = true;
  105. permissions.admin["soundcloud.fetchNewApiKey"] = true;
  106. permissions.admin["soundcloud.testApiKey"] = true;
  107. permissions.moderator["soundcloud.getArtist"] = true;
  108. permissions.admin["soundcloud.getArtist"] = true;
  109. }
  110. if (config.get("experimental.spotify")) {
  111. permissions.moderator["admin.view.spotify"] = true;
  112. permissions.admin["admin.view.spotify"] = true;
  113. permissions.moderator["spotify.getTracksFromMediaSources"] = true;
  114. permissions.admin["spotify.getTracksFromMediaSources"] = true;
  115. permissions.moderator["spotify.getAlbumsFromIds"] = true;
  116. permissions.admin["spotify.getAlbumsFromIds"] = true;
  117. permissions.moderator["spotify.getArtistsFromIds"] = true;
  118. permissions.admin["spotify.getArtistsFromIds"] = true;
  119. }
  120. export const hasPermission = async (permission, session, stationId) => {
  121. const CacheModule = moduleManager.modules.cache;
  122. const DBModule = moduleManager.modules.db;
  123. const StationsModule = moduleManager.modules.stations;
  124. const UtilsModule = moduleManager.modules.utils;
  125. const userModel = await DBModule.runJob("GET_MODEL", { modelName: "user" }, this);
  126. return new Promise((resolve, reject) => {
  127. async.waterfall(
  128. [
  129. next => {
  130. let userId;
  131. if (typeof session === "object") {
  132. if (session.userId) userId = session.userId;
  133. else
  134. CacheModule.runJob(
  135. "HGET",
  136. {
  137. table: "sessions",
  138. key: session.sessionId
  139. },
  140. this
  141. )
  142. .then(_session => {
  143. if (_session && _session.userId) userId = _session.userId;
  144. })
  145. .catch(next);
  146. } else userId = session;
  147. if (!userId) return next("User ID required.");
  148. return userModel.findOne({ _id: userId }, next);
  149. },
  150. (user, next) => {
  151. if (!user) return next("Login required.");
  152. if (!stationId) return next(null, [user.role]);
  153. return StationsModule.runJob("GET_STATION", { stationId }, this)
  154. .then(station => {
  155. if (!station) return next("Station not found.");
  156. if (station.type === "community" && station.owner === user._id.toString())
  157. return next(null, [user.role, "owner"]);
  158. if (station.djs.find(dj => dj === user._id.toString()))
  159. return next(null, [user.role, "dj"]);
  160. if (user.role === "admin" || user.role === "moderator") return next(null, [user.role]);
  161. return next("Invalid permissions.");
  162. })
  163. .catch(next);
  164. },
  165. (roles, next) => {
  166. if (!roles) return next("Role required.");
  167. let permissionFound;
  168. roles.forEach(role => {
  169. if (permissions[role] && permissions[role][permission]) permissionFound = true;
  170. });
  171. if (permissionFound) return next();
  172. return next("Insufficient permissions.");
  173. }
  174. ],
  175. async err => {
  176. const userId = typeof session === "object" ? session.userId || session.sessionId : session;
  177. if (err) {
  178. err = await UtilsModule.runJob("GET_ERROR", { error: err }, this);
  179. UtilsModule.log(
  180. "INFO",
  181. "HAS_PERMISSION",
  182. `User "${userId}" does not have required permission "${permission}". "${err}"`
  183. );
  184. return reject(err);
  185. }
  186. UtilsModule.log(
  187. "INFO",
  188. "HAS_PERMISSION",
  189. `User "${userId}" has required permission "${permission}".`,
  190. false
  191. );
  192. return resolve();
  193. }
  194. );
  195. });
  196. };
  197. export const useHasPermission = (options, destination) =>
  198. async function useHasPermission(session, ...args) {
  199. const UtilsModule = moduleManager.modules.utils;
  200. const permission = typeof options === "object" ? options.permission : options;
  201. const cb = args[args.length - 1];
  202. async.waterfall(
  203. [
  204. next => {
  205. if (!session || !session.sessionId) return next("Login required.");
  206. return hasPermission(permission, session)
  207. .then(() => next())
  208. .catch(next);
  209. }
  210. ],
  211. async err => {
  212. if (err) {
  213. err = await UtilsModule.runJob("GET_ERROR", { error: err }, this);
  214. this.log(
  215. "INFO",
  216. "USE_HAS_PERMISSION",
  217. `User "${session.userId}" does not have required permission "${permission}". "${err}"`
  218. );
  219. return cb({ status: "error", message: err });
  220. }
  221. this.log(
  222. "INFO",
  223. "USE_HAS_PERMISSION",
  224. `User "${session.userId}" has required permission "${permission}".`,
  225. false
  226. );
  227. return destination.apply(this, [session].concat(args));
  228. }
  229. );
  230. };
  231. export const getUserPermissions = async (session, stationId) => {
  232. const CacheModule = moduleManager.modules.cache;
  233. const DBModule = moduleManager.modules.db;
  234. const StationsModule = moduleManager.modules.stations;
  235. const UtilsModule = moduleManager.modules.utils;
  236. const userModel = await DBModule.runJob("GET_MODEL", { modelName: "user" }, this);
  237. return new Promise((resolve, reject) => {
  238. async.waterfall(
  239. [
  240. next => {
  241. let userId;
  242. if (typeof session === "object") {
  243. if (session.userId) userId = session.userId;
  244. else
  245. CacheModule.runJob(
  246. "HGET",
  247. {
  248. table: "sessions",
  249. key: session.sessionId
  250. },
  251. this
  252. )
  253. .then(_session => {
  254. if (_session && _session.userId) userId = _session.userId;
  255. })
  256. .catch(next);
  257. } else userId = session;
  258. if (!userId) return next("User ID required.");
  259. return userModel.findOne({ _id: userId }, next);
  260. },
  261. (user, next) => {
  262. if (!user) return next("Login required.");
  263. if (!stationId) return next(null, [user.role]);
  264. return StationsModule.runJob("GET_STATION", { stationId }, this)
  265. .then(station => {
  266. if (!station) return next("Station not found.");
  267. if (station.type === "community" && station.owner === user._id.toString())
  268. return next(null, [user.role, "owner"]);
  269. if (station.djs.find(dj => dj === user._id.toString()))
  270. return next(null, [user.role, "dj"]);
  271. if (user.role === "admin" || user.role === "moderator") return next(null, [user.role]);
  272. return next("Invalid permissions.");
  273. })
  274. .catch(next);
  275. },
  276. (roles, next) => {
  277. if (!roles) return next("Role required.");
  278. let rolePermissions = {};
  279. roles.forEach(role => {
  280. if (permissions[role]) rolePermissions = { ...rolePermissions, ...permissions[role] };
  281. });
  282. return next(null, rolePermissions);
  283. }
  284. ],
  285. async (err, rolePermissions) => {
  286. const userId = typeof session === "object" ? session.userId || session.sessionId : session;
  287. if (err) {
  288. err = await UtilsModule.runJob("GET_ERROR", { error: err }, this);
  289. UtilsModule.log(
  290. "INFO",
  291. "GET_USER_PERMISSIONS",
  292. `Failed to get permissions for user "${userId}". "${err}"`
  293. );
  294. return reject(err);
  295. }
  296. UtilsModule.log("INFO", "GET_USER_PERMISSIONS", `Fetched permissions for user "${userId}".`, false);
  297. return resolve(rolePermissions);
  298. }
  299. );
  300. });
  301. };