platform.go

package gocommerce

import (
	"context"
	"errors"
	"fmt"
	"regexp"
	"strings"
)

type (
	DBConfig struct {
		Host   string
		User   string
		Pass   string
		Name   string
		Prefix string
		Port   int
	}

	StoreConfig struct {
		DB        *DBConfig
		AdminSlug string
	}

	Store struct {
		DocRoot  string
		Platform PlatformInterface
		Config   *StoreConfig
	}

	basePlatform struct {
		name       string
		configPath string
		uniquePath string // A relative path that is sufficiently unique to identify a particular platform
	}

	PlatformInterface interface {
		Name() string
		ParseConfig(cfgPath string) (*StoreConfig, error)
		Version(docroot string) (string, error)
		BaseURLs(ctx context.Context, docroot string) ([]string, error)
		ConfigPath() string
		UniquePath() string
	}
)

var AllPlatforms = []PlatformInterface{
	&Magento1{
		basePlatform{
			"Magento 1",
			"app/etc/local.xml",
			"app/etc/local.xml",
		},
		"n98-magerun",
	},
	&Magento2{
		basePlatform{
			"Magento 2",
			"app/etc/env.php",
			"app/etc/env.php",
		},
		"n98-magerun2",
	},
	&Shopware5{
		basePlatform{
			"Shopware 5",
			"config.php",
			"engine/Shopware/Application.php",
		},
	},
	&Shopware6{
		basePlatform{
			"Shopware 6",
			".env",
			"vendor/shopware/core/Framework/ShopwareException.php",
		},
	},
	&Prestashop6{
		basePlatform{
			"Prestashop 6",
			"config/settings.inc.php",
			"config/settings.inc.php",
		},
	},
	&Prestashop7{
		basePlatform{
			"Prestashop 7",
			"app/config/parameters.php",
			"app/config/parameters.php",
		},
	},
	&WooCommerce{
		basePlatform{
			"WooCommerce",
			"wp-config.php",
			"wp-config.php",
		},
	},
	&OpenCart4{
		basePlatform{
			"OpenCart 4",
			"config.php",
			"system/engine/config.php",
		},
	},
}

func (b *basePlatform) Name() string {
	return b.name
}

func (b *basePlatform) ConfigPath() string {
	return b.configPath
}

func (b *basePlatform) UniquePath() string {
	return b.uniquePath
}

func (b *basePlatform) ParseConfig(_ string) (*StoreConfig, error) {
	return nil, errors.New("not implemented")
}

func (b *basePlatform) BaseURLs(_ context.Context, _ string) ([]string, error) {
	return nil, errors.New("not implemented")
}

func (b *basePlatform) Version(_ string) (string, error) {
	return "", errors.New("not implemented")
}

func (c *DBConfig) DSN() string {
	if c.User == "" || c.Name == "" {
		return ""
	}
	host := c.Host
	if host == "" {
		host = "localhost"
	}
	port := c.Port
	if port == 0 {
		port = 3306
	}

	var network, address string
	if strings.Contains(c.Host, "/") {
		network = "unix"
		address = c.Host
	} else {
		network = "tcp"
		address = fmt.Sprintf("%s:%d", host, port)
	}

	// oldpasswords = Required for MySQL 4.0 servers, ugh...
	return fmt.Sprintf("%s:%s@%s(%s)/%s?allowOldPasswords=true",
		c.User,
		c.Pass,
		network,
		address,
		c.Name)
}

func (c *DBConfig) SafePrefix() (string, error) {
	// prefix can only contain alphanum and underscores
	re := regexp.MustCompile(`[^a-zA-Z0-9_]`)
	if len(c.Prefix) > 0 && re.MatchString(c.Prefix) {
		return "", fmt.Errorf("invalid database prefix: %s", c.Prefix)
	}

	return c.Prefix, nil
}