spicetify.go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"os"
	"runtime"

	"github.com/khanhas/spicetify-cli/src/cmd"
	"github.com/khanhas/spicetify-cli/src/utils"
	colorable "github.com/mattn/go-colorable"
)

const (
	version = "1.0.2"
)

var (
	flags          = []string{}
	commands       = []string{}
	quiet          = false
	extensionFocus = false
	appFocus       = false
	noRestart      = false
	liveUpdate     = false
)

func init() {
	if runtime.GOOS != "windows" &&
		runtime.GOOS != "darwin" &&
		runtime.GOOS != "linux" {
		utils.PrintError("Unsupported OS.")
		os.Exit(1)
	}

	log.SetFlags(0)
	// Supports print color output for Windows
	log.SetOutput(colorable.NewColorableStdout())

	// Separates flags and commands
	for _, v := range os.Args[1:] {
		if v[0] == '-' && v != "-1" {
			if v[1] != '-' && len(v) > 2 {
				for _, char := range v[1:] {
					flags = append(flags, "-"+string(char))
				}
			} else {
				flags = append(flags, v)
			}
		} else {
			commands = append(commands, v)
		}
	}

	for _, v := range flags {
		switch v {
		case "-c", "--config":
			fmt.Println(cmd.GetConfigPath())
			os.Exit(0)
		case "-h", "--help":
			kind := ""
			if len(commands) > 0 {
				kind = commands[0]
			}
			if kind == "config" {
				helpConfig()
			} else {
				help()
			}

			os.Exit(0)
		case "-v", "--version":
			fmt.Println(version)
			os.Exit(0)
		case "-e", "--extension":
			extensionFocus = true
		case "-a", "--app":
			appFocus = true
		case "-q", "--quiet":
			quiet = true
		case "-n", "--no-restart":
			noRestart = true
		case "-l", "--live-update":
			liveUpdate = true
		}
	}

	if quiet {
		log.SetOutput(ioutil.Discard)
		os.Stdout = nil
	}

	cmd.InitConfig(quiet)
	cmd.CheckUpgrade(version)

	if len(commands) < 1 {
		utils.PrintInfo(`Run "spicetify -h" for commands list.`)
		os.Exit(0)
	}
}

func main() {
	// Non-chainable commands
	switch commands[0] {
	case "config":
		commands = commands[1:]
		if len(commands) == 0 {
			cmd.DisplayAllConfig()
		} else if len(commands) == 1 {
			cmd.DisplayConfig(commands[0])
		} else {
			cmd.EditConfig(commands)
		}
		return
	case "color":
		commands = commands[1:]
		if len(commands) == 0 {
			cmd.DisplayColors()
		} else {
			cmd.EditColor(commands)
		}
		return

	case "path":
		commands = commands[1:]
		path, err := (func() (string, error) {
			if extensionFocus {
				if len(commands) == 0 {
					return cmd.ExtensionAllPath()
				}
				return cmd.ExtensionPath(commands[0])
			} else if appFocus {
				if len(commands) == 0 {
					return cmd.AppAllPath()
				}
				return cmd.AppPath(commands[0])
			} else {
				if len(commands) == 0 {
					return cmd.ThemeAllAssetsPath()
				}
				return cmd.ThemeAssetPath(commands[0])
			}
		})()

		if err != nil {
			utils.Fatal(err)
		}

		log.Println(path)
		return

	case "upgrade":
		cmd.Upgrade(version)
		return
	}

	utils.PrintBold("spicetify v" + version)

	cmd.InitPaths()

	// Chainable commands
	for _, v := range commands {
		switch v {
		case "backup":
			cmd.Backup()

		case "clear":
			cmd.Clear()

		case "apply":
			cmd.Apply()
			restartSpotify()

		case "update":
			if extensionFocus {
				cmd.UpdateAllExtension()
			} else {
				cmd.UpdateTheme()
			}

		case "restore":
			cmd.Restore()
			restartSpotify()

		case "enable-devtool":
			cmd.SetDevTool(true)
			restartSpotify()

		case "disable-devtool":
			cmd.SetDevTool(false)
			restartSpotify()

		case "watch":
			if extensionFocus {
				cmd.WatchExtensions(liveUpdate)
			} else {
				cmd.Watch(liveUpdate)
			}

		case "restart":
			cmd.RestartSpotify()

		case "auto":
			cmd.Auto()
			restartSpotify()

		default:
			utils.PrintError(`Command "` + v + `" not found.`)
			utils.PrintInfo(`Run "spicetify -h" for list of valid commands.`)
			os.Exit(1)
		}
	}
}

func restartSpotify() {
	if !noRestart {
		cmd.RestartSpotify()
	}
}

func help() {
	utils.PrintBold("spicetify v" + version)
	log.Println(utils.Bold("USAGE") + "\n" +
		"spicetify [-q] [-e] [-a] \x1B[4mcommand\033[0m...\n" +
		"spicetify {-c | --config} | {-v | --version} | {-h | --help}\n\n" +
		utils.Bold("DESCRIPTION") + "\n" +
		"Customize Spotify client UI and functionality\n\n" +
		utils.Bold("CHAINABLE COMMANDS") + `
backup              Start backup and preprocessing app files.

apply               Apply customization.

update              On default, update theme CSS and colors.
                    Use with flag "-e" to update extensions.

restore             Restore Spotify to original state.

clear               Clear current backup files.

enable-devtool      Enable Spotify's developer tools.
                    Hit Ctrl + Shift + I in the client to start using.

disable-devtool     Disable Spotify's developer tools.

watch               Enter watch mode.
                    On default, update CSS on color.ini or user.css's changes.
                    Use with flag "-e" to update extensions on changes.

restart             Restart Spotify client.

` + utils.Bold("NON-CHAINABLE COMMANDS") + `
path                Print path of color, css, extension file or
                    custom app directory and quit.
                    1. Print all theme's assests:
                    spicetify path
                    2. Print theme's color.ini path:
                    spicetify path color
                    3. Print theme's user.css path:
                    spicetify path css
                    4. Print theme's assets path:
                    spicetify path assets
                    5. Print all extensions path:
                    spicetify -e path
                    6. Print extension <name> path:
                    spicetify -e path <name>
                    7. Print all custom apps path:
                    spicetify -a path
                    8. Print custom app <name> path:
                    spicetify -a path <name>

config              1. Print all config fields and values:
                    spicetify config
                    
                    2. Print one config field's value:
                    spicetify config <field>

                    Example usage:
                    spicetify config color_scheme
                    spicetify config custom_apps
                    
                    3. Change value of one or multiple config fields.
                    spicetify config <field> <value> [<field> <value> ...]

                    "extensions" and "custom_apps" fields are arrays of values,
                    so <value> will be appended to those fields' current value.
                    To remove one of array's values, postfix "-" to <value>.

                    Example usage:
                    - Enable "disable_sentry" preprocess:
                    spicetify config disable_sentry 1
                    - Add extension "myFakeExt.js" to current extensions list:
                    spicetify config extensions myFakeExt.js
                    - Remove extension "wrongname.js" from extensions list:
                    spicetify config extensions wrongname.js-
                    - Disable "inject_css" and enable "song_page"
                    spicetify config inject_css 0 song_page 1

color               1. Print all color fields and values. 
                    spicetify color

                    Color boxes require 24-bit color (True color) supported 
                    terminal to show colors correctly.

                    2. Change theme's one or multiple color values.
                    spicetify color <field> <value> [<field> <value> ...]

                    <value> can be in hex or decimal (rrr,ggg,bbb) format.

                    Example usage:
                    - Change main_bg to ff0000
                    spicetify color main_bg ff0000
                    - Change slider_bg to 00ff00 and pressing_fg to 0000ff
                    spicetify color slider_bg 00ff00 pressing_fg 0000ff

` + utils.Bold("FLAGS") + `
-q, --quiet         Quiet mode (no output). Be careful, dangerous operations
                    like clear backup, restore will proceed without prompting
                    permission.

-e, --extension     Use with "update", "watch" or "path" command to
                    focus on extensions.

-a, --app           Use with "path" to focus on custom apps.

-n, --no-restart    Do not restart Spotify after running command(s), except
                    "restart" command.

-l, --live-update   Use with "watch" command to auto-reload Spotify on change

-c, --config        Print config file path and quit

-h, --help          Print this help text and quit

-v, --version       Print version number and quit

For config information, run "spicetify -h config".
For more information and bug report: https://github.com/khanhas/spicetify-cli/`)
}

func helpConfig() {
	utils.PrintBold("CONFIG MEANING")
	log.Println(utils.Bold("[Setting]") + `
spotify_path
    Path to Spotify directory

prefs_path
    Path to Spotify's "prefs" file

current_theme
    Name of folder of your theme

color_scheme
    Color config section name in color.ini file.
    If color_scheme is blank, first section in color.ini file would be used.

inject_css <0 | 1>
    Whether custom css from user.css in theme folder is applied

replace_colors <0 | 1>
    Whether custom colors is applied

spotify_launch_flags
    Command-line flags used when launching/restarting Spotify.
    Separate each flag with "|".
    List of valid flags: https://github.com/khanhas/spicetify-cli/wiki/Spotify-Commandline-Flags

` + utils.Bold("[Preprocesses]") + `
disable_sentry <0 | 1>
    Prevents Sentry and Amazon Qualaroo to send console log/error/warning to Spotify developers.
    Enable if you don't want to catch their attention when developing extension or app.

disable_ui_logging <0 | 1>
    Various elements logs every user clicks, scrolls.
    Enable to stop logging and improve user experience.

remove_rtl_rule <0 | 1>
    To support Arabic and other Right-To-Left language, Spotify added a lot of
    CSS rules that are obsoleted to Left-To-Right users.
    Enable to remove all of them and improve render speed.

expose_apis <0 | 1>
    Leaks some Spotify's API, functions, objects to Spicetify global object that
    are useful for making extensions to extend Spotify functionality.

disable_upgrade_check <0 | 1>
    Prevent Spotify checking new version and visually notifying user.
    [Windows] Note: Automatic update still works if you don't manually delete "SpotifyMigrator.exe" and "SpotifyUpdate.exe".

` + utils.Bold("[AdditionalOptions]") + `
custom_apps <string>
    List of custom apps. Separate each app with "|".

extensions <string>
    List of Javascript files to be executed along with Spotify main script.
    Separate each extension with "|".

experimental_features <-1 | 0 | 1>
    Enable/Disable ability access to Experimental Features of Spotify.
    Open it in profile menu (top right corner).

fastUser_switching <-1 | 0 | 1>
    Enable/Disable ability to quickly change account. Open it in profile menu.

home <-1 | 0 | 1>
    Enable/Disable Home page. Access it in left sidebar.

lyric_always_show <-1 | 0 | 1>
    Force Lyrics button to show all the time in player bar.
    Useful for who want to watch visualization page.

lyric_force_no_sync <-1 | 0 | 1>
    Force displaying all of lyrics.

radio
    Enable/Disable Radio page. Access it in left sidebar.

song_page <-1 | 0 | 1>
    Enable/Disable ability to click at song name in player bar will access that
    song page (instead of its album page) to discover playlists it appearing on.

visualization_high_framerate <-1 | 0 | 1>
    Force Visualization in Lyrics app to render in 60fps.`)
}