Moved v3 code from NginxProxyManager/nginx-proxy-manager-3 to NginxProxyManager/nginx-proxy-manager

backend/internal/entity/host/filters.go

@@ -0,0 +1,25 @@
+package host
+
+import (
+	"npm/internal/entity"
+)
+
+var filterMapFunctions = make(map[string]entity.FilterMapFunction)
+
+// getFilterMapFunctions is a map of functions that should be executed
+// during the filtering process, if a field is defined here then the value in
+// the filter will be given to the defined function and it will return a new
+// value for use in the sql query.
+func getFilterMapFunctions() map[string]entity.FilterMapFunction {
+	// if len(filterMapFunctions) == 0 {
+	// TODO: See internal/model/file_item.go:620 for an example
+	// }
+
+	return filterMapFunctions
+}
+
+// GetFilterSchema returns filter schema
+func GetFilterSchema() string {
+	var m Model
+	return entity.GetFilterSchema(m)
+}

backend/internal/entity/host/methods.go

@@ -0,0 +1,183 @@
+package host
+
+import (
+	"database/sql"
+	goerrors "errors"
+	"fmt"
+
+	"npm/internal/database"
+	"npm/internal/entity"
+	"npm/internal/errors"
+	"npm/internal/logger"
+	"npm/internal/model"
+)
+
+// GetByID finds a Host by ID
+func GetByID(id int) (Model, error) {
+	var m Model
+	err := m.LoadByID(id)
+	return m, err
+}
+
+// create will create a Host from this model
+func create(host *Model) (int, error) {
+	if host.ID != 0 {
+		return 0, goerrors.New("Cannot create host when model already has an ID")
+	}
+
+	host.Touch(true)
+
+	db := database.GetInstance()
+	// nolint: gosec
+	result, err := db.NamedExec(`INSERT INTO `+fmt.Sprintf("`%s`", tableName)+` (
+		created_on,
+		modified_on,
+		user_id,
+		type,
+		host_template_id,
+		listen_interface,
+		domain_names,
+		upstream_id,
+		certificate_id,
+		access_list_id,
+		ssl_forced,
+		caching_enabled,
+		block_exploits,
+		allow_websocket_upgrade,
+		http2_support,
+		hsts_enabled,
+		hsts_subdomains,
+		paths,
+		upstream_options,
+		advanced_config,
+		is_disabled,
+		is_deleted
+	) VALUES (
+		:created_on,
+		:modified_on,
+		:user_id,
+		:type,
+		:host_template_id,
+		:listen_interface,
+		:domain_names,
+		:upstream_id,
+		:certificate_id,
+		:access_list_id,
+		:ssl_forced,
+		:caching_enabled,
+		:block_exploits,
+		:allow_websocket_upgrade,
+		:http2_support,
+		:hsts_enabled,
+		:hsts_subdomains,
+		:paths,
+		:upstream_options,
+		:advanced_config,
+		:is_disabled,
+		:is_deleted
+	)`, host)
+
+	if err != nil {
+		return 0, err
+	}
+
+	last, lastErr := result.LastInsertId()
+	if lastErr != nil {
+		return 0, lastErr
+	}
+
+	return int(last), nil
+}
+
+// update will Update a Host from this model
+func update(host *Model) error {
+	if host.ID == 0 {
+		return goerrors.New("Cannot update host when model doesn't have an ID")
+	}
+
+	host.Touch(false)
+
+	db := database.GetInstance()
+	// nolint: gosec
+	_, err := db.NamedExec(`UPDATE `+fmt.Sprintf("`%s`", tableName)+` SET
+		created_on = :created_on,
+		modified_on = :modified_on,
+		user_id = :user_id,
+		type = :type,
+		host_template_id = :host_template_id,
+		listen_interface = :listen_interface,
+		domain_names = :domain_names,
+		upstream_id = :upstream_id,
+		certificate_id = :certificate_id,
+		access_list_id = :access_list_id,
+		ssl_forced = :ssl_forced,
+		caching_enabled = :caching_enabled,
+		block_exploits = :block_exploits,
+		allow_websocket_upgrade = :allow_websocket_upgrade,
+		http2_support = :http2_support,
+		hsts_enabled = :hsts_enabled,
+		hsts_subdomains = :hsts_subdomains,
+		paths = :paths,
+		upstream_options = :upstream_options,
+		advanced_config = :advanced_config,
+		is_disabled = :is_disabled,
+		is_deleted = :is_deleted
+	WHERE id = :id`, host)
+
+	return err
+}
+
+// List will return a list of hosts
+func List(pageInfo model.PageInfo, filters []model.Filter, expand []string) (ListResponse, error) {
+	var result ListResponse
+	var exampleModel Model
+
+	defaultSort := model.Sort{
+		Field:     "domain_names",
+		Direction: "ASC",
+	}
+
+	db := database.GetInstance()
+	if db == nil {
+		return result, errors.ErrDatabaseUnavailable
+	}
+
+	// Get count of items in this search
+	query, params := entity.ListQueryBuilder(exampleModel, tableName, &pageInfo, defaultSort, filters, getFilterMapFunctions(), true)
+	countRow := db.QueryRowx(query, params...)
+	var totalRows int
+	queryErr := countRow.Scan(&totalRows)
+	if queryErr != nil && queryErr != sql.ErrNoRows {
+		logger.Debug("%s -- %+v", query, params)
+		return result, queryErr
+	}
+
+	// Get rows
+	var items []Model
+	query, params = entity.ListQueryBuilder(exampleModel, tableName, &pageInfo, defaultSort, filters, getFilterMapFunctions(), false)
+	err := db.Select(&items, query, params...)
+	if err != nil {
+		logger.Debug("%s -- %+v", query, params)
+		return result, err
+	}
+
+	if expand != nil {
+		for idx := range items {
+			expandErr := items[idx].Expand(expand)
+			if expandErr != nil {
+				logger.Error("HostsExpansionError", expandErr)
+			}
+		}
+	}
+
+	result = ListResponse{
+		Items:  items,
+		Total:  totalRows,
+		Limit:  pageInfo.Limit,
+		Offset: pageInfo.Offset,
+		Sort:   pageInfo.Sort,
+		Filter: filters,
+	}
+
+	return result, nil
+}

backend/internal/entity/host/model.go

@@ -0,0 +1,120 @@
+package host
+
+import (
+	"fmt"
+	"time"
+
+	"npm/internal/database"
+	"npm/internal/entity/certificate"
+	"npm/internal/entity/user"
+	"npm/internal/types"
+	"npm/internal/util"
+)
+
+const (
+	tableName = "host"
+
+	// ProxyHostType is self explanatory
+	ProxyHostType = "proxy"
+	// RedirectionHostType is self explanatory
+	RedirectionHostType = "redirection"
+	// DeadHostType is self explanatory
+	DeadHostType = "dead"
+)
+
+// Model is the user model
+type Model struct {
+	ID                    int          `json:"id" db:"id" filter:"id,integer"`
+	CreatedOn             types.DBDate `json:"created_on" db:"created_on" filter:"created_on,integer"`
+	ModifiedOn            types.DBDate `json:"modified_on" db:"modified_on" filter:"modified_on,integer"`
+	UserID                int          `json:"user_id" db:"user_id" filter:"user_id,integer"`
+	Type                  string       `json:"type" db:"type" filter:"type,string"`
+	HostTemplateID        int          `json:"host_template_id" db:"host_template_id" filter:"host_template_id,integer"`
+	ListenInterface       string       `json:"listen_interface" db:"listen_interface" filter:"listen_interface,string"`
+	DomainNames           types.JSONB  `json:"domain_names" db:"domain_names" filter:"domain_names,string"`
+	UpstreamID            int          `json:"upstream_id" db:"upstream_id" filter:"upstream_id,integer"`
+	CertificateID         int          `json:"certificate_id" db:"certificate_id" filter:"certificate_id,integer"`
+	AccessListID          int          `json:"access_list_id" db:"access_list_id" filter:"access_list_id,integer"`
+	SSLForced             bool         `json:"ssl_forced" db:"ssl_forced" filter:"ssl_forced,boolean"`
+	CachingEnabled        bool         `json:"caching_enabled" db:"caching_enabled" filter:"caching_enabled,boolean"`
+	BlockExploits         bool         `json:"block_exploits" db:"block_exploits" filter:"block_exploits,boolean"`
+	AllowWebsocketUpgrade bool         `json:"allow_websocket_upgrade" db:"allow_websocket_upgrade" filter:"allow_websocket_upgrade,boolean"`
+	HTTP2Support          bool         `json:"http2_support" db:"http2_support" filter:"http2_support,boolean"`
+	HSTSEnabled           bool         `json:"hsts_enabled" db:"hsts_enabled" filter:"hsts_enabled,boolean"`
+	HSTSSubdomains        bool         `json:"hsts_subdomains" db:"hsts_subdomains" filter:"hsts_subdomains,boolean"`
+	Paths                 string       `json:"paths" db:"paths" filter:"paths,string"`
+	UpstreamOptions       string       `json:"upstream_options" db:"upstream_options" filter:"upstream_options,string"`
+	AdvancedConfig        string       `json:"advanced_config" db:"advanced_config" filter:"advanced_config,string"`
+	IsDisabled            bool         `json:"is_disabled" db:"is_disabled" filter:"is_disabled,boolean"`
+	IsDeleted             bool         `json:"is_deleted,omitempty" db:"is_deleted"`
+	// Expansions
+	Certificate *certificate.Model `json:"certificate,omitempty"`
+	User        *user.Model        `json:"user,omitempty"`
+}
+
+func (m *Model) getByQuery(query string, params []interface{}) error {
+	return database.GetByQuery(m, query, params)
+}
+
+// LoadByID will load from an ID
+func (m *Model) LoadByID(id int) error {
+	query := fmt.Sprintf("SELECT * FROM `%s` WHERE id = ? AND is_deleted = ? LIMIT 1", tableName)
+	params := []interface{}{id, 0}
+	return m.getByQuery(query, params)
+}
+
+// Touch will update model's timestamp(s)
+func (m *Model) Touch(created bool) {
+	var d types.DBDate
+	d.Time = time.Now()
+	if created {
+		m.CreatedOn = d
+	}
+	m.ModifiedOn = d
+}
+
+// Save will save this model to the DB
+func (m *Model) Save() error {
+	var err error
+
+	if m.UserID == 0 {
+		return fmt.Errorf("User ID must be specified")
+	}
+
+	if m.ID == 0 {
+		m.ID, err = create(m)
+	} else {
+		err = update(m)
+	}
+
+	return err
+}
+
+// Delete will mark a host as deleted
+func (m *Model) Delete() bool {
+	m.Touch(false)
+	m.IsDeleted = true
+	if err := m.Save(); err != nil {
+		return false
+	}
+	return true
+}
+
+// Expand will fill in more properties
+func (m *Model) Expand(items []string) error {
+	var err error
+
+	if util.SliceContainsItem(items, "user") && m.ID > 0 {
+		var usr user.Model
+		usr, err = user.GetByID(m.UserID)
+		m.User = &usr
+	}
+
+	if util.SliceContainsItem(items, "certificate") && m.CertificateID > 0 {
+		var cert certificate.Model
+		cert, err = certificate.GetByID(m.CertificateID)
+		m.Certificate = &cert
+	}
+
+	return err
+}

backend/internal/entity/host/structs.go

@@ -0,0 +1,15 @@
+package host
+
+import (
+	"npm/internal/model"
+)
+
+// ListResponse is the JSON response for this list
+type ListResponse struct {
+	Total  int            `json:"total"`
+	Offset int            `json:"offset"`
+	Limit  int            `json:"limit"`
+	Sort   []model.Sort   `json:"sort"`
+	Filter []model.Filter `json:"filter,omitempty"`
+	Items  []Model        `json:"items,omitempty"`
+}