mirror of
				https://github.com/NginxProxyManager/nginx-proxy-manager.git
				synced 2025-10-31 07:43:33 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			479 lines
		
	
	
		
			12 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			479 lines
		
	
	
		
			12 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
| import _ from "lodash";
 | |
| import errs from "../lib/error.js";
 | |
| import { castJsonIfNeed } from "../lib/helpers.js";
 | |
| import utils from "../lib/utils.js";
 | |
| import redirectionHostModel from "../models/redirection_host.js";
 | |
| import internalAuditLog from "./audit-log.js";
 | |
| import internalCertificate from "./certificate.js";
 | |
| import internalHost from "./host.js";
 | |
| import internalNginx from "./nginx.js";
 | |
| 
 | |
| const omissions = () => {
 | |
| 	return ["is_deleted"];
 | |
| };
 | |
| 
 | |
| const internalRedirectionHost = {
 | |
| 	/**
 | |
| 	 * @param   {Access}  access
 | |
| 	 * @param   {Object}  data
 | |
| 	 * @returns {Promise}
 | |
| 	 */
 | |
| 	create: (access, data) => {
 | |
| 		let thisData = data || {};
 | |
| 		const createCertificate = thisData.certificate_id === "new";
 | |
| 
 | |
| 		if (createCertificate) {
 | |
| 			delete thisData.certificate_id;
 | |
| 		}
 | |
| 
 | |
| 		return access
 | |
| 			.can("redirection_hosts:create", thisData)
 | |
| 			.then((/*access_data*/) => {
 | |
| 				// Get a list of the domain names and check each of them against existing records
 | |
| 				const domain_name_check_promises = [];
 | |
| 
 | |
| 				thisData.domain_names.map((domain_name) => {
 | |
| 					domain_name_check_promises.push(internalHost.isHostnameTaken(domain_name));
 | |
| 					return true;
 | |
| 				});
 | |
| 
 | |
| 				return Promise.all(domain_name_check_promises).then((check_results) => {
 | |
| 					check_results.map((result) => {
 | |
| 						if (result.is_taken) {
 | |
| 							throw new errs.ValidationError(`${result.hostname} is already in use`);
 | |
| 						}
 | |
| 						return true;
 | |
| 					});
 | |
| 				});
 | |
| 			})
 | |
| 			.then(() => {
 | |
| 				// At this point the domains should have been checked
 | |
| 				thisData.owner_user_id = access.token.getUserId(1);
 | |
| 				thisData = internalHost.cleanSslHstsData(thisData);
 | |
| 
 | |
| 				// Fix for db field not having a default value
 | |
| 				// for this optional field.
 | |
| 				if (typeof data.advanced_config === "undefined") {
 | |
| 					data.advanced_config = "";
 | |
| 				}
 | |
| 
 | |
| 				return redirectionHostModel.query().insertAndFetch(thisData).then(utils.omitRow(omissions()));
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				if (createCertificate) {
 | |
| 					return internalCertificate
 | |
| 						.createQuickCertificate(access, thisData)
 | |
| 						.then((cert) => {
 | |
| 							// update host with cert id
 | |
| 							return internalRedirectionHost.update(access, {
 | |
| 								id: row.id,
 | |
| 								certificate_id: cert.id,
 | |
| 							});
 | |
| 						})
 | |
| 						.then(() => {
 | |
| 							return row;
 | |
| 						});
 | |
| 				}
 | |
| 				return row;
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				// re-fetch with cert
 | |
| 				return internalRedirectionHost.get(access, {
 | |
| 					id: row.id,
 | |
| 					expand: ["certificate", "owner"],
 | |
| 				});
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				// Configure nginx
 | |
| 				return internalNginx.configure(redirectionHostModel, "redirection_host", row).then(() => {
 | |
| 					return row;
 | |
| 				});
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				thisData.meta = _.assign({}, thisData.meta || {}, row.meta);
 | |
| 
 | |
| 				// Add to audit log
 | |
| 				return internalAuditLog
 | |
| 					.add(access, {
 | |
| 						action: "created",
 | |
| 						object_type: "redirection-host",
 | |
| 						object_id: row.id,
 | |
| 						meta: thisData,
 | |
| 					})
 | |
| 					.then(() => {
 | |
| 						return row;
 | |
| 					});
 | |
| 			});
 | |
| 	},
 | |
| 
 | |
| 	/**
 | |
| 	 * @param  {Access}  access
 | |
| 	 * @param  {Object}  data
 | |
| 	 * @param  {Number}  data.id
 | |
| 	 * @return {Promise}
 | |
| 	 */
 | |
| 	update: (access, data) => {
 | |
| 		let thisData = data || {};
 | |
| 		const createCertificate = thisData.certificate_id === "new";
 | |
| 
 | |
| 		if (createCertificate) {
 | |
| 			delete thisData.certificate_id;
 | |
| 		}
 | |
| 
 | |
| 		return access
 | |
| 			.can("redirection_hosts:update", thisData.id)
 | |
| 			.then((/*access_data*/) => {
 | |
| 				// Get a list of the domain names and check each of them against existing records
 | |
| 				const domain_name_check_promises = [];
 | |
| 
 | |
| 				if (typeof thisData.domain_names !== "undefined") {
 | |
| 					thisData.domain_names.map((domain_name) => {
 | |
| 						domain_name_check_promises.push(
 | |
| 							internalHost.isHostnameTaken(domain_name, "redirection", thisData.id),
 | |
| 						);
 | |
| 						return true;
 | |
| 					});
 | |
| 
 | |
| 					return Promise.all(domain_name_check_promises).then((check_results) => {
 | |
| 						check_results.map((result) => {
 | |
| 							if (result.is_taken) {
 | |
| 								throw new errs.ValidationError(`${result.hostname} is already in use`);
 | |
| 							}
 | |
| 							return true;
 | |
| 						});
 | |
| 					});
 | |
| 				}
 | |
| 			})
 | |
| 			.then(() => {
 | |
| 				return internalRedirectionHost.get(access, { id: thisData.id });
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				if (row.id !== thisData.id) {
 | |
| 					// Sanity check that something crazy hasn't happened
 | |
| 					throw new errs.InternalValidationError(
 | |
| 						`Redirection Host could not be updated, IDs do not match: ${row.id} !== ${thisData.id}`,
 | |
| 					);
 | |
| 				}
 | |
| 
 | |
| 				if (createCertificate) {
 | |
| 					return internalCertificate
 | |
| 						.createQuickCertificate(access, {
 | |
| 							domain_names: thisData.domain_names || row.domain_names,
 | |
| 							meta: _.assign({}, row.meta, thisData.meta),
 | |
| 						})
 | |
| 						.then((cert) => {
 | |
| 							// update host with cert id
 | |
| 							thisData.certificate_id = cert.id;
 | |
| 						})
 | |
| 						.then(() => {
 | |
| 							return row;
 | |
| 						});
 | |
| 				}
 | |
| 				return row;
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				// Add domain_names to the data in case it isn't there, so that the audit log renders correctly. The order is important here.
 | |
| 				thisData = _.assign(
 | |
| 					{},
 | |
| 					{
 | |
| 						domain_names: row.domain_names,
 | |
| 					},
 | |
| 					thisData,
 | |
| 				);
 | |
| 
 | |
| 				thisData = internalHost.cleanSslHstsData(thisData, row);
 | |
| 
 | |
| 				return redirectionHostModel
 | |
| 					.query()
 | |
| 					.where({ id: thisData.id })
 | |
| 					.patch(thisData)
 | |
| 					.then((saved_row) => {
 | |
| 						// Add to audit log
 | |
| 						return internalAuditLog
 | |
| 							.add(access, {
 | |
| 								action: "updated",
 | |
| 								object_type: "redirection-host",
 | |
| 								object_id: row.id,
 | |
| 								meta: thisData,
 | |
| 							})
 | |
| 							.then(() => {
 | |
| 								return _.omit(saved_row, omissions());
 | |
| 							});
 | |
| 					});
 | |
| 			})
 | |
| 			.then(() => {
 | |
| 				return internalRedirectionHost
 | |
| 					.get(access, {
 | |
| 						id: thisData.id,
 | |
| 						expand: ["owner", "certificate"],
 | |
| 					})
 | |
| 					.then((row) => {
 | |
| 						// Configure nginx
 | |
| 						return internalNginx
 | |
| 							.configure(redirectionHostModel, "redirection_host", row)
 | |
| 							.then((new_meta) => {
 | |
| 								row.meta = new_meta;
 | |
| 								return _.omit(internalHost.cleanRowCertificateMeta(row), omissions());
 | |
| 							});
 | |
| 					});
 | |
| 			});
 | |
| 	},
 | |
| 
 | |
| 	/**
 | |
| 	 * @param  {Access}   access
 | |
| 	 * @param  {Object}   data
 | |
| 	 * @param  {Number}   data.id
 | |
| 	 * @param  {Array}    [data.expand]
 | |
| 	 * @param  {Array}    [data.omit]
 | |
| 	 * @return {Promise}
 | |
| 	 */
 | |
| 	get: (access, data) => {
 | |
| 		const thisData = data || {};
 | |
| 
 | |
| 		return access
 | |
| 			.can("redirection_hosts:get", thisData.id)
 | |
| 			.then((access_data) => {
 | |
| 				const query = redirectionHostModel
 | |
| 					.query()
 | |
| 					.where("is_deleted", 0)
 | |
| 					.andWhere("id", thisData.id)
 | |
| 					.allowGraph("[owner,certificate]")
 | |
| 					.first();
 | |
| 
 | |
| 				if (access_data.permission_visibility !== "all") {
 | |
| 					query.andWhere("owner_user_id", access.token.getUserId(1));
 | |
| 				}
 | |
| 
 | |
| 				if (typeof thisData.expand !== "undefined" && thisData.expand !== null) {
 | |
| 					query.withGraphFetched(`[${thisData.expand.join(", ")}]`);
 | |
| 				}
 | |
| 
 | |
| 				return query.then(utils.omitRow(omissions()));
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				let thisRow = row;
 | |
| 				if (!thisRow || !thisRow.id) {
 | |
| 					throw new errs.ItemNotFoundError(thisData.id);
 | |
| 				}
 | |
| 				thisRow = internalHost.cleanRowCertificateMeta(thisRow);
 | |
| 				// Custom omissions
 | |
| 				if (typeof thisData.omit !== "undefined" && thisData.omit !== null) {
 | |
| 					return _.omit(thisRow, thisData.omit);
 | |
| 				}
 | |
| 				return thisRow;
 | |
| 			});
 | |
| 	},
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {Access}  access
 | |
| 	 * @param {Object}  data
 | |
| 	 * @param {Number}  data.id
 | |
| 	 * @param {String}  [data.reason]
 | |
| 	 * @returns {Promise}
 | |
| 	 */
 | |
| 	delete: (access, data) => {
 | |
| 		return access
 | |
| 			.can("redirection_hosts:delete", data.id)
 | |
| 			.then(() => {
 | |
| 				return internalRedirectionHost.get(access, { id: data.id });
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				if (!row || !row.id) {
 | |
| 					throw new errs.ItemNotFoundError(data.id);
 | |
| 				}
 | |
| 
 | |
| 				return redirectionHostModel
 | |
| 					.query()
 | |
| 					.where("id", row.id)
 | |
| 					.patch({
 | |
| 						is_deleted: 1,
 | |
| 					})
 | |
| 					.then(() => {
 | |
| 						// Delete Nginx Config
 | |
| 						return internalNginx.deleteConfig("redirection_host", row).then(() => {
 | |
| 							return internalNginx.reload();
 | |
| 						});
 | |
| 					})
 | |
| 					.then(() => {
 | |
| 						// Add to audit log
 | |
| 						return internalAuditLog.add(access, {
 | |
| 							action: "deleted",
 | |
| 							object_type: "redirection-host",
 | |
| 							object_id: row.id,
 | |
| 							meta: _.omit(row, omissions()),
 | |
| 						});
 | |
| 					});
 | |
| 			})
 | |
| 			.then(() => {
 | |
| 				return true;
 | |
| 			});
 | |
| 	},
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {Access}  access
 | |
| 	 * @param {Object}  data
 | |
| 	 * @param {Number}  data.id
 | |
| 	 * @param {String}  [data.reason]
 | |
| 	 * @returns {Promise}
 | |
| 	 */
 | |
| 	enable: (access, data) => {
 | |
| 		return access
 | |
| 			.can("redirection_hosts:update", data.id)
 | |
| 			.then(() => {
 | |
| 				return internalRedirectionHost.get(access, {
 | |
| 					id: data.id,
 | |
| 					expand: ["certificate", "owner"],
 | |
| 				});
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				if (!row || !row.id) {
 | |
| 					throw new errs.ItemNotFoundError(data.id);
 | |
| 				}
 | |
| 				if (row.enabled) {
 | |
| 					throw new errs.ValidationError("Host is already enabled");
 | |
| 				}
 | |
| 
 | |
| 				row.enabled = 1;
 | |
| 
 | |
| 				return redirectionHostModel
 | |
| 					.query()
 | |
| 					.where("id", row.id)
 | |
| 					.patch({
 | |
| 						enabled: 1,
 | |
| 					})
 | |
| 					.then(() => {
 | |
| 						// Configure nginx
 | |
| 						return internalNginx.configure(redirectionHostModel, "redirection_host", row);
 | |
| 					})
 | |
| 					.then(() => {
 | |
| 						// Add to audit log
 | |
| 						return internalAuditLog.add(access, {
 | |
| 							action: "enabled",
 | |
| 							object_type: "redirection-host",
 | |
| 							object_id: row.id,
 | |
| 							meta: _.omit(row, omissions()),
 | |
| 						});
 | |
| 					});
 | |
| 			})
 | |
| 			.then(() => {
 | |
| 				return true;
 | |
| 			});
 | |
| 	},
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {Access}  access
 | |
| 	 * @param {Object}  data
 | |
| 	 * @param {Number}  data.id
 | |
| 	 * @param {String}  [data.reason]
 | |
| 	 * @returns {Promise}
 | |
| 	 */
 | |
| 	disable: (access, data) => {
 | |
| 		return access
 | |
| 			.can("redirection_hosts:update", data.id)
 | |
| 			.then(() => {
 | |
| 				return internalRedirectionHost.get(access, { id: data.id });
 | |
| 			})
 | |
| 			.then((row) => {
 | |
| 				if (!row || !row.id) {
 | |
| 					throw new errs.ItemNotFoundError(data.id);
 | |
| 				}
 | |
| 				if (!row.enabled) {
 | |
| 					throw new errs.ValidationError("Host is already disabled");
 | |
| 				}
 | |
| 
 | |
| 				row.enabled = 0;
 | |
| 
 | |
| 				return redirectionHostModel
 | |
| 					.query()
 | |
| 					.where("id", row.id)
 | |
| 					.patch({
 | |
| 						enabled: 0,
 | |
| 					})
 | |
| 					.then(() => {
 | |
| 						// Delete Nginx Config
 | |
| 						return internalNginx.deleteConfig("redirection_host", row).then(() => {
 | |
| 							return internalNginx.reload();
 | |
| 						});
 | |
| 					})
 | |
| 					.then(() => {
 | |
| 						// Add to audit log
 | |
| 						return internalAuditLog.add(access, {
 | |
| 							action: "disabled",
 | |
| 							object_type: "redirection-host",
 | |
| 							object_id: row.id,
 | |
| 							meta: _.omit(row, omissions()),
 | |
| 						});
 | |
| 					});
 | |
| 			})
 | |
| 			.then(() => {
 | |
| 				return true;
 | |
| 			});
 | |
| 	},
 | |
| 
 | |
| 	/**
 | |
| 	 * All Hosts
 | |
| 	 *
 | |
| 	 * @param   {Access}  access
 | |
| 	 * @param   {Array}   [expand]
 | |
| 	 * @param   {String}  [search_query]
 | |
| 	 * @returns {Promise}
 | |
| 	 */
 | |
| 	getAll: (access, expand, search_query) => {
 | |
| 		return access
 | |
| 			.can("redirection_hosts:list")
 | |
| 			.then((access_data) => {
 | |
| 				const query = redirectionHostModel
 | |
| 					.query()
 | |
| 					.where("is_deleted", 0)
 | |
| 					.groupBy("id")
 | |
| 					.allowGraph("[owner,certificate]")
 | |
| 					.orderBy(castJsonIfNeed("domain_names"), "ASC");
 | |
| 
 | |
| 				if (access_data.permission_visibility !== "all") {
 | |
| 					query.andWhere("owner_user_id", access.token.getUserId(1));
 | |
| 				}
 | |
| 
 | |
| 				// Query is used for searching
 | |
| 				if (typeof search_query === "string" && search_query.length > 0) {
 | |
| 					query.where(function () {
 | |
| 						this.where(castJsonIfNeed("domain_names"), "like", `%${search_query}%`);
 | |
| 					});
 | |
| 				}
 | |
| 
 | |
| 				if (typeof expand !== "undefined" && expand !== null) {
 | |
| 					query.withGraphFetched(`[${expand.join(", ")}]`);
 | |
| 				}
 | |
| 
 | |
| 				return query.then(utils.omitRows(omissions()));
 | |
| 			})
 | |
| 			.then((rows) => {
 | |
| 				if (typeof expand !== "undefined" && expand !== null && expand.indexOf("certificate") !== -1) {
 | |
| 					return internalHost.cleanAllRowsCertificateMeta(rows);
 | |
| 				}
 | |
| 
 | |
| 				return rows;
 | |
| 			});
 | |
| 	},
 | |
| 
 | |
| 	/**
 | |
| 	 * Report use
 | |
| 	 *
 | |
| 	 * @param   {Number}  user_id
 | |
| 	 * @param   {String}  visibility
 | |
| 	 * @returns {Promise}
 | |
| 	 */
 | |
| 	getCount: (user_id, visibility) => {
 | |
| 		const query = redirectionHostModel.query().count("id as count").where("is_deleted", 0);
 | |
| 
 | |
| 		if (visibility !== "all") {
 | |
| 			query.andWhere("owner_user_id", user_id);
 | |
| 		}
 | |
| 
 | |
| 		return query.first().then((row) => {
 | |
| 			return Number.parseInt(row.count, 10);
 | |
| 		});
 | |
| 	},
 | |
| };
 | |
| 
 | |
| export default internalRedirectionHost;
 |