File Manager API fixes + Additional Softaculous support

Author: wolveix

file.go

@@ -36,13 +36,11 @@ type FileMetadata struct {
 
 // CreateDirectory (user) creates the given path, including any missing parent directories.
 func (c *UserContext) CreateDirectory(path string) error {
-	var response apiGenericResponseN
-
 	body := map[string]string{
 		"path": path,
 	}
 
-	if _, err := c.makeRequestNew(http.MethodPost, "/api/filemanager-actions/mkdir", body, &response); err != nil {
+	if _, err := c.makeRequestNew(http.MethodPost, "filemanager-actions/mkdir", body, nil); err != nil {
 		return err
 	}
 
@@ -101,31 +99,34 @@ func (c *UserContext) DownloadFileToDisk(filePath string, outputPath string) err
 	return os.WriteFile(outputPath, response, 0o644)
 }
 
-// ExtractFile unzips the given file path on the server.
-func (c *UserContext) ExtractFile(filePath string, file string) error {
-	var response apiGenericResponse
-
-	// Prepend / to the filePath if it doesn't exist.
-	if filePath[0] != '/' {
-		filePath = "/" + filePath
+// ExtractFile (user) unzips the given file path on the server.
+func (c *UserContext) ExtractFile(destinationDir string, source string, mergeAndOverwrite bool) error {
+	if destinationDir == "" || source == "" {
+		return fmt.Errorf("no destination directory or source provided")
 	}
 
-	// Prepend / to the file if it doesn't exist.
-	if file[0] != '/' {
-		file = "/" + file
+	// Prepend / to the filePath if necessary.
+	if destinationDir[0] != '/' {
+		destinationDir = "/" + destinationDir
 	}
 
-	body := url.Values{}
-	body.Set("directory", filePath)
-	body.Set("path", file)
-	body.Set("page", "2")
+	// Prepend / to the file if necessary.
+	if source[0] != '/' {
+		source = "/" + source
+	}
 
-	if _, err := c.makeRequestOld(http.MethodPost, "FILE_MANAGER?action=extract", body, &response); err != nil {
-		return err
+	body := struct {
+		DestinationDir    string `json:"destinationDir"`
+		MergeAndOverwrite bool   `json:"mergeAndOverwrite"`
+		Source            string `json:"source"`
+	}{
+		DestinationDir:    destinationDir,
+		MergeAndOverwrite: mergeAndOverwrite,
+		Source:            source,
 	}
 
-	if response.Success != "File Extracted" {
-		return fmt.Errorf("failed to extract file: %v", response.Result)
+	if _, err := c.makeRequestNew(http.MethodPost, "filemanager-actions/extract-archive", body, nil); err != nil {
+		return err
 	}
 
 	return nil
@@ -135,7 +136,7 @@ func (c *UserContext) ExtractFile(filePath string, file string) error {
 func (c *UserContext) GetFileMetadata(filePath string) (*FileMetadata, error) {
 	var response *FileMetadata
 
-	if _, err := c.makeRequestNew(http.MethodGet, "/api/filemanager/metadata?path="+filePath, nil, &response); err != nil {
+	if _, err := c.makeRequestNew(http.MethodGet, "filemanager/metadata?path="+filePath, nil, &response); err != nil {
 		return nil, err
 	}
 
@@ -144,15 +145,17 @@ func (c *UserContext) GetFileMetadata(filePath string) (*FileMetadata, error) {
 
 // MovePath (user) moves the given file or directory to the new destination.
 func (c *UserContext) MovePath(source string, destination string, overwrite bool) error {
-	var response apiGenericResponseN
-
-	body := map[string]string{
-		"destination": destination,
-		"overwrite":   fmt.Sprintf("%t", overwrite),
-		"source":      source,
+	body := struct {
+		Destination string `json:"destination"`
+		Overwrite   bool   `json:"overwrite"`
+		Source      string `json:"source"`
+	}{
+		Destination: destination,
+		Overwrite:   overwrite,
+		Source:      source,
 	}
 
-	if _, err := c.makeRequestNew(http.MethodPost, "/api/filemanager-actions/move", body, &response); err != nil {
+	if _, err := c.makeRequestNew(http.MethodPost, "filemanager-actions/move", body, nil); err != nil {
 		return err
 	}
 

http.go

@@ -11,20 +11,20 @@ import (
 	"time"
 
 	"github.com/goccy/go-json"
-	"github.com/spf13/cast"
 )
 
 type httpDebug struct {
-	Body     string
-	Code     int
-	Endpoint string
-	Start    time.Time
+	Body          string
+	BodyTruncated bool
+	Code          int
+	Endpoint      string
+	Start         time.Time
 }
 
 // makeRequest is the underlying function for HTTP requests. It handles debugging statements, and simple error handling
 func (c *UserContext) makeRequest(req *http.Request) ([]byte, error) {
 	debug := httpDebug{
-		Endpoint: req.URL.Path,
+		Endpoint: getPathWithQuery(req),
 		Start:    time.Now(),
 	}
 	defer c.api.printDebugHTTP(&debug)
@@ -57,7 +57,8 @@ func (c *UserContext) makeRequest(req *http.Request) ([]byte, error) {
 
 		if c.api.debug {
 			if len(responseBytes) > 32768 {
-				debug.Body = "body too long for debug: " + cast.ToString(len(responseBytes))
+				debug.BodyTruncated = true
+				debug.Body = string(responseBytes[:32768])
 			} else {
 				debug.Body = string(responseBytes)
 			}
@@ -190,6 +191,23 @@ func (c *UserContext) uploadFile(method string, endpoint string, data []byte, ob
 
 func (a *API) printDebugHTTP(debug *httpDebug) {
 	if a.debug {
-		fmt.Printf("\nENDPOINT: %v\nSTATUS CODE: %v\nTIME STARTED: %v\nTIME ENDED: %v\nTIME TAKEN: %v\nBODY: %v\n", debug.Endpoint, debug.Code, debug.Start, time.Now(), time.Since(debug.Start), debug.Body)
+		var bodyTruncated string
+		if debug.BodyTruncated {
+			bodyTruncated = " (truncated)"
+		}
+
+		fmt.Printf("\nENDPOINT: %v\nSTATUS CODE: %v\nTIME STARTED: %v\nTIME ENDED: %v\nTIME TAKEN: %v\nBODY%s: %v\n", debug.Endpoint, debug.Code, debug.Start, time.Now(), time.Since(debug.Start), bodyTruncated, debug.Body)
+	}
+}
+
+func getPathWithQuery(req *http.Request) string {
+	if req == nil {
+		return ""
+	}
+
+	if req.URL.RawQuery != "" {
+		return req.URL.Path + "?" + req.URL.RawQuery
 	}
+
+	return req.URL.Path
 }

plugins_softaculous.go

@@ -18,25 +18,48 @@ const (
 	SoftaculousScriptIDWordPress = 26
 )
 
-type SoftaculousScript struct {
-	AdminEmail         string `url:"admin_email"`
-	AdminPassword      string `url:"admin_pass"`
-	AdminUsername      string `url:"admin_username"`
-	AutoUpgrade        bool   `url:"en_auto_upgrade"`
-	AutoUpgradePlugins bool   `url:"auto_upgrade_plugins"`
-	AutoUpgradeThemes  bool   `url:"auto_upgrade_plugins"`
-	DatabaseName       string `url:"softdb"`
-	DatabasePrefix     string `url:"dbprefix"` // optional
-	Directory          string `url:"softdirectory"`
-	Domain             string `url:"softdomain"`
-	Language           string `url:"language"`
-	NotifyOnInstall    bool   `url:"noemail"`
-	NotifyOnUpdate     bool   `url:"disable_notify_update"`
-	OverwriteExisting  bool   `url:"overwrite_existing"`
-	Protocol           string `url:"softproto"`
-	SiteDescription    string `url:"site_desc"`
-	SiteName           string `json:"site_name"`
-}
+type (
+	SoftaculousInstallation struct {
+		ID                string `json:"insid"`
+		ScriptID          int    `json:"sid"`
+		Ver               string `json:"ver"`
+		ITime             int    `json:"itime"`
+		Path              string `json:"softpath"`
+		URL               string `json:"softurl"`
+		Domain            string `json:"softdomain"`
+		FileIndex         any    `json:"fileindex"` // Sometimes a string slice, other times a map.
+		SiteName          string `json:"site_name"`
+		SoftDB            string `json:"softdb"`
+		SoftDBuser        string `json:"softdbuser"`
+		SoftDBhost        string `json:"softdbhost"`
+		SoftDBpass        string `json:"softdbpass"`
+		DBCreated         bool   `json:"dbcreated"`
+		DBPrefix          string `json:"dbprefix"`
+		ImportSrc         string `json:"import_src"`
+		DisplaySoftDBPass string `json:"display_softdbpass"`
+		ScriptName        string `json:"script_name"`
+	}
+
+	SoftaculousScript struct {
+		AdminEmail         string `url:"admin_email"`
+		AdminPassword      string `url:"admin_pass"`
+		AdminUsername      string `url:"admin_username"`
+		AutoUpgrade        bool   `url:"en_auto_upgrade"`
+		AutoUpgradePlugins bool   `url:"auto_upgrade_plugins"`
+		AutoUpgradeThemes  bool   `url:"auto_upgrade_plugins"`
+		DatabaseName       string `url:"softdb"`
+		DatabasePrefix     string `url:"dbprefix"` // Optional.
+		Directory          string `url:"softdirectory"`
+		Domain             string `url:"softdomain"`
+		Language           string `url:"language"`
+		NotifyOnInstall    bool   `url:"noemail"`
+		NotifyOnUpdate     bool   `url:"disable_notify_update"`
+		OverwriteExisting  bool   `url:"overwrite_existing"`
+		Protocol           string `url:"softproto"`
+		SiteDescription    string `url:"site_desc"`
+		SiteName           string `json:"site_name"`
+	}
+)
 
 func (s *SoftaculousScript) Parse() (url.Values, error) {
 	if err := s.Validate(); err != nil {
@@ -160,7 +183,7 @@ func (c *UserContext) SoftaculousInstallScript(script *SoftaculousScript, script
 
 	body.Set("softsubmit", "1")
 
-	// Softaculous requires a genuine session ID
+	// Softaculous requires a genuine session ID.
 	if c.sessionID == "" {
 		if err = c.CreateSession(); err != nil {
 			return fmt.Errorf("failed to create user session: %w", err)
@@ -177,3 +200,84 @@ func (c *UserContext) SoftaculousInstallScript(script *SoftaculousScript, script
 
 	return nil
 }
+
+// SoftaculousListInstallations lists all installations accessible to the authenticated user.
+func (c *UserContext) SoftaculousListInstallations() ([]*SoftaculousInstallation, error) {
+	response := struct {
+		Error         map[string]string                              `json:"error"`
+		Installations map[string]map[string]*SoftaculousInstallation `json:"installations"`
+	}{
+		Error:         make(map[string]string),
+		Installations: make(map[string]map[string]*SoftaculousInstallation),
+	}
+
+	// Softaculous requires a genuine session ID
+	if c.sessionID == "" {
+		if err := c.CreateSession(); err != nil {
+			return nil, fmt.Errorf("failed to create user session: %w", err)
+		}
+	}
+
+	if _, err := c.makeRequestOld(http.MethodPost, "PLUGINS/softaculous/index.raw?act=installations&api=json", nil, &response); err != nil {
+		return nil, err
+	}
+
+	if len(response.Error) > 0 {
+		return nil, fmt.Errorf("failed to uninstall script: %v", response.Error)
+	}
+
+	installations := make([]*SoftaculousInstallation, 0, len(response.Installations))
+	for _, userInstallations := range response.Installations {
+		for _, installation := range userInstallations {
+			installations = append(installations, installation)
+		}
+	}
+
+	return installations, nil
+}
+
+// SoftaculousUninstallScript calls Softaculous's install script API endpoint.
+//
+// Docs: https://www.softaculous.com/docs/api/remote-api/#remove-an-installed-script
+func (c *UserContext) SoftaculousUninstallScript(installID string, deleteFiles bool, deleteDB bool) error {
+	if installID == "" {
+		return errors.New("missing install id")
+	}
+
+	response := struct {
+		Error map[string]string `json:"error"`
+	}{
+		Error: make(map[string]string),
+	}
+
+	body := url.Values{}
+	body.Set("noemail", "1")
+	body.Set("removeins", "1")
+
+	if deleteFiles {
+		body.Set("remove_dir", "1")
+		body.Set("remove_datadir", "1")
+	}
+
+	if deleteDB {
+		body.Set("remove_db", "1")
+		body.Set("remove_dbuser", "1")
+	}
+
+	// Softaculous requires a genuine session ID
+	if c.sessionID == "" {
+		if err := c.CreateSession(); err != nil {
+			return fmt.Errorf("failed to create user session: %w", err)
+		}
+	}
+
+	if _, err := c.makeRequestOld(http.MethodPost, "PLUGINS/softaculous/index.raw?act=remove&insid="+installID+"&api=json", body, &response); err != nil {
+		return err
+	}
+
+	if len(response.Error) > 0 {
+		return fmt.Errorf("failed to uninstall script: %v", response.Error)
+	}
+
+	return nil
+}

subdomain.go

@@ -56,8 +56,8 @@ func (c *UserContext) DeleteSubdomains(deleteData bool, domain string, subdomain
 		return err
 	}
 
-	if response.Success != "Domain Deletion Results" {
-		return fmt.Errorf("failed to delete domain: %v", response.Result)
+	if response.Success != "Subdomains deleted" {
+		return fmt.Errorf("failed to delete subdomain: %v", response.Result)
 	}
 
 	return nil