feat: [#546] artisan command up and down to set website Maintenance mode

errors/list.go

@@ -264,4 +264,6 @@ var (
 	ValidationEmptyRules           = New("rules can't be empty")
 	ValidationFilterRegisterFailed = New("filter register failed: %v")
 	ValidationRuleRegisterFailed   = New("rule register failed: %v")
+
+	ViewTemplateNotExist = New("view template %s does not exist")
 )

foundation/application.go

@@ -116,6 +116,8 @@ func (r *Application) BootServiceProviders() {
 		console.NewPackageInstallCommand(binding.Bindings, r.GetJson()),
 		console.NewPackageUninstallCommand(binding.Bindings, r.GetJson()),
 		console.NewVendorPublishCommand(r.publishes, r.publishGroups),
+		console.NewUpCommand(r),
+		console.NewDownCommand(r),
 	})
 	r.bootArtisan()
 }

foundation/console/down_command.go

@@ -0,0 +1,142 @@
+package console
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/goravel/framework/contracts/console"
+	"github.com/goravel/framework/contracts/console/command"
+	"github.com/goravel/framework/contracts/foundation"
+	"github.com/goravel/framework/contracts/hash"
+	"github.com/goravel/framework/contracts/view"
+	"github.com/goravel/framework/errors"
+	"github.com/goravel/framework/support/file"
+	"github.com/goravel/framework/support/path"
+	"github.com/goravel/framework/support/str"
+)
+
+type DownCommand struct {
+	app  foundation.Application
+	view view.View
+	hash hash.Hash
+}
+
+type MaintenanceOptions struct {
+	Reason   string `json:"reason,omitempty"`
+	Redirect string `json:"redirect,omitempty"`
+	Render   string `json:"render,omitempty"`
+	Secret   string `json:"secret,omitempty"`
+	Status   int    `json:"status"`
+}
+
+func NewDownCommand(app foundation.Application) *DownCommand {
+	return &DownCommand{app, app.MakeView(), app.MakeHash()}
+}
+
+// Signature The name and signature of the console command.
+func (r *DownCommand) Signature() string {
+	return "down"
+}
+
+// Description The console command description.
+func (r *DownCommand) Description() string {
+	return "Put the application into maintenance mode"
+}
+
+// Extend The console command extend.
+func (r *DownCommand) Extend() command.Extend {
+	return command.Extend{
+		Flags: []command.Flag{
+			&command.StringFlag{
+				Name:  "reason",
+				Usage: "The reason for maintenance to show in the response",
+				Value: "The application is under maintenance",
+			},
+			&command.StringFlag{
+				Name:  "redirect",
+				Usage: "The path that the user should be redirected to",
+			},
+			&command.StringFlag{
+				Name:  "render",
+				Usage: "The view should be prerendered for display during maintenance mode",
+			},
+			&command.StringFlag{
+				Name:  "secret",
+				Usage: "The secret phrase that may be used to bypass the maintenance mode",
+			},
+			&command.BoolFlag{
+				Name:  "with-secret",
+				Usage: "Generate a random secret phrase that may be used to bypass the maintenance mode",
+			},
+			&command.IntFlag{
+				Name:  "status",
+				Usage: "The status code that should be used when returning the maintenance mode response",
+				Value: http.StatusServiceUnavailable,
+			},
+		},
+	}
+}
+
+// Handle Execute the console command.
+func (r *DownCommand) Handle(ctx console.Context) error {
+	path := path.Storage("framework/maintenance")
+
+	options := MaintenanceOptions{}
+
+	options.Status = ctx.OptionInt("status")
+
+	options.Redirect = ctx.Option("redirect")
+
+	if render := ctx.Option("render"); render != "" {
+		if r.view.Exists(render) {
+			options.Render = render
+		} else {
+			ctx.Error(errors.ViewTemplateNotExist.Args(render).Error())
+			return nil
+		}
+	}
+
+	if options.Redirect == "" && options.Render == "" {
+		options.Reason = ctx.Option("reason")
+	}
+
+	if secret := ctx.Option("secret"); secret != "" {
+		hash, err := r.hash.Make(secret)
+		if err != nil {
+			ctx.Error(err.Error())
+			return nil
+		} else {
+			options.Secret = hash
+		}
+	}
+
+	if withSecret := ctx.OptionBool("with-secret"); withSecret {
+		secret := str.Random(40)
+		hash, err := r.app.MakeHash().Make(secret)
+
+		if err != nil {
+			ctx.Error(err.Error())
+			return nil
+		} else {
+			options.Secret = hash
+			ctx.Info(fmt.Sprintf("Using secret: %s", secret))
+		}
+	}
+
+	jsonBytes, err := json.Marshal(options)
+
+	if err != nil {
+		ctx.Error(err.Error())
+		return nil
+	}
+
+	if err := file.PutContent(path, string(jsonBytes)); err != nil {
+		ctx.Error(err.Error())
+		return nil
+	}
+
+	ctx.Success("The application is in maintenance mode now")
+
+	return nil
+}