Merge pull request #32 from kartikeysemwal/exportFeatureV1

Enhance Export Functionality: Add JSON and CSV Support (Fixes #27)

Author: TheYahya

cmd/enola/enola.go

@@ -8,6 +8,12 @@ import (
 	"github.com/spf13/cobra"
 )
 
+type cmdOptions struct {
+	username   string
+	site       string
+	outputPath string
+}
+
 var rootCmd = &cobra.Command{
 	Use:   "enola {username}",
 	Short: "A command-line tool to find username on websites",
@@ -25,7 +31,15 @@ func validateArgs(cmd *cobra.Command, args []string) error {
 func runCommand(cmd *cobra.Command, args []string) {
 	username := args[0]
 	siteFlag := cmd.Flag("site")
-	findAndShowResult(username, siteFlag.Value.String())
+	outputPath := cmd.Flag("output")
+
+	options := cmdOptions{
+		username:   username,
+		site:       siteFlag.Value.String(),
+		outputPath: outputPath.Value.String(),
+	}
+
+	findAndShowResult(options)
 }
 
 func main() {
@@ -46,4 +60,10 @@ func init() {
 		"",
 		"to only search an specific site",
 	)
+	rootCmd.Flags().StringP(
+		"output",
+		"o",
+		"",
+		"output path, supports json and csv, eg: C:\\test\\test.json",
+	)
 }

cmd/enola/find.go

@@ -8,18 +8,19 @@ import (
 	"github.com/charmbracelet/bubbles/list"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/theyahya/enola"
+	"github.com/theyahya/enola/cmd/exporter"
 )
 
 type responseMsg enola.Result
 
-func findAndShowResult(username, site string) {
+func findAndShowResult(options cmdOptions) {
 	ctx := context.Background()
 	sh, err := enola.New(ctx)
 	if err != nil {
 		panic(err)
 	}
 
-	resChan, err := sh.SetSite(site).Check(username)
+	resChan, err := sh.SetSite(options.site).Check(options.username)
 	if err != nil {
 		fmt.Println("Error running program: ", err)
 		os.Exit(1)
@@ -42,4 +43,39 @@ func findAndShowResult(username, site string) {
 		fmt.Println("Error running program: ", err)
 		os.Exit(1)
 	}
+
+	defer func() {
+		if options.outputPath != "" {
+			exportType := exporter.CheckExportType(options.outputPath)
+
+			var writer exporter.Writer = nil
+			if exporter.JSON == exportType {
+				writer = exporter.JsonWriter{
+					OutputPath: options.outputPath,
+					Items:      prepareItemsForExport(m.list.Items()),
+				}
+			} else if exporter.CSV == exportType {
+				writer = exporter.CsvWriter{
+					OutputPath: options.outputPath,
+					Items:      prepareItemsForExport(m.list.Items()),
+				}
+			}
+
+			if writer != nil {
+				writer.Write()
+			}
+		}
+	}()
+}
+
+func prepareItemsForExport(items []list.Item) []exporter.Item {
+	var ret []exporter.Item
+
+	for _, value := range items {
+		if itemValue, ok := value.(item); ok {
+			ret = append(ret, exporter.Item{Title: itemValue.title, URL: itemValue.desc, Found: itemValue.found})
+		}
+	}
+
+	return ret
 }

cmd/exporter/csvWriter.go

@@ -0,0 +1,38 @@
+package exporter
+
+import (
+	"encoding/csv"
+	"fmt"
+	"strconv"
+)
+
+type CsvWriter struct {
+	OutputPath string
+	Items      []Item
+}
+
+func (writer CsvWriter) Write() {
+	file, err := OpenOrCreateFile(writer.OutputPath)
+	if err != nil {
+		return
+	}
+	defer file.Close()
+
+	csvWriter := csv.NewWriter(file)
+	defer csvWriter.Flush()
+
+	err = csvWriter.Write([]string{"title", "url", "found"})
+	if err != nil {
+		fmt.Println("Error while saving content to csv file")
+		return
+	}
+
+	for _, item := range writer.Items {
+		row := []string{item.Title, item.URL, strconv.FormatBool(item.Found)}
+		err = csvWriter.Write(row)
+		if err != nil {
+			fmt.Println("Error while saving content to csv file")
+			return
+		}
+	}
+}

cmd/exporter/jsonWriter.go

@@ -0,0 +1,26 @@
+package exporter
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+type JsonWriter struct {
+	OutputPath string
+	Items      []Item
+}
+
+func (writer JsonWriter) Write() {
+	file, err := OpenOrCreateFile(writer.OutputPath)
+	if err != nil {
+		return
+	}
+	defer file.Close()
+
+	encoder := json.NewEncoder(file)
+	encoder.SetIndent("", "  ")
+
+	if err := encoder.Encode(writer.Items); err != nil {
+		fmt.Println("Error while saving items to JSON file", err)
+	}
+}

cmd/exporter/utils.go

@@ -0,0 +1,38 @@
+package exporter
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+func OpenOrCreateFile(filename string) (*os.File, error) {
+	dir := filepath.Dir(filename)
+	// 0755 permissions: the owner can read, write, and execute, everyone else can only read and execute.
+	err := os.MkdirAll(dir, 0755)
+
+	if err != nil {
+		fmt.Println("Error creating directory:", err)
+		return nil, err
+	}
+
+	// Open the file with read and write permissions
+	file, err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE, 0644)
+	if err != nil {
+		fmt.Println(err)
+		return nil, err
+	}
+	return file, nil
+}
+
+func CheckExportType(filename string) ExportType {
+	lowerFileName := strings.ToLower(filename)
+	if strings.HasSuffix(strings.ToLower(lowerFileName), string(JSON)) {
+		return JSON
+	} else if strings.HasSuffix(strings.ToLower(lowerFileName), string(CSV)) {
+		return CSV
+	}
+
+	return NOTSUPPORTED
+}

cmd/exporter/writer.go

@@ -0,0 +1,19 @@
+package exporter
+
+type ExportType string
+
+const (
+	JSON         ExportType = "json"
+	CSV          ExportType = "csv"
+	NOTSUPPORTED ExportType = "notsupported"
+)
+
+type Item struct {
+	Title string `json:"title"`
+	URL   string `json:"url"`
+	Found bool   `json:"found"`
+}
+
+type Writer interface {
+	Write()
+}