main.go

//
// Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
//
// MIT Licence. See http://opensource.org/licenses/MIT
//
// Created on 2016-05-30
//

// TODO: iCloud tabs (~/Library/SyncedPreferences/com.apple.Safari.plist)

// Command alsf is an Alfred 3 workflow for interacting with Safari bookmarks and tabs.
//
// With it, you can filter and perform actions on Safari tabs, bookmarks
// (incl. bookmarklets) and reading list entries. There are several
// built-in and bundled actions, but you can add more of your own via
// scripts. Both action scripts and bookmarklets can be assigned to
// alternative actions (^↩, ⌥↩ etc.) in Alfred's UI by editing the
// ALSF_TAB_* and ALSF_URL_* variables in the workflow's configuration
// sheet in Alfred Preferences.
//
// See https://github.com/deanishe/alfred-safari-assistant for usage instructions.
package main // import "github.com/deanishe/alfred-safari-assistant"

import (
	"fmt"
	"log"
	"net/url"
	"path/filepath"
	"strings"

	aw "github.com/deanishe/awgo"
	"github.com/deanishe/awgo/update"
	"github.com/deanishe/awgo/util"
	safari "github.com/deanishe/go-safari"
	"github.com/pkg/errors"
	kingpin "gopkg.in/alecthomas/kingpin.v2"
)

// Defaults for Kingpin flags
const (
	defaultMaxResults = "100"
)

// Icons
var (
	IconActions         = &aw.Icon{Value: "icons/actions.png"}
	IconActive          = &aw.Icon{Value: "icons/tab-active.png"}
	IconBlacklist       = &aw.Icon{Value: "icons/blacklist.png"}
	IconBookmark        = &aw.Icon{Value: "icons/bookmark.png"}
	IconBookmarklet     = &aw.Icon{Value: "icons/bookmarklet.png"}
	IconCloud           = &aw.Icon{Value: "icons/cloud.png"}
	IconDefault         = &aw.Icon{Value: "icon.png"}
	IconError           = &aw.Icon{Value: "icons/error.png"}
	IconFolder          = &aw.Icon{Value: "icons/folder.png"}
	IconHelp            = &aw.Icon{Value: "icons/help.png"}
	IconHistory         = &aw.Icon{Value: "icons/history.png"}
	IconHome            = &aw.Icon{Value: "icons/home.png"}
	IconIssue           = &aw.Icon{Value: "icons/issue.png"}
	IconReadingList     = &aw.Icon{Value: "icons/reading-list.png"}
	IconTab             = &aw.Icon{Value: "icons/tab.png"}
	IconUp              = &aw.Icon{Value: "icons/up.png"}
	IconUpdateAvailable = &aw.Icon{Value: "icons/update-available.png"}
	IconUpdateCheck     = &aw.Icon{Value: "icons/update-check.png"}
	IconURL             = &aw.Icon{Value: "icons/url.png"}
	IconWarning         = &aw.Icon{Value: "icons/warning.png"}
)

var (
	// Kingpin and script options
	app *kingpin.Application

	// Application commands
	activateCmd, filterBookmarksCmd           *kingpin.CmdClause
	filterBookmarkletsCmd, filterFolderCmd    *kingpin.CmdClause
	filterAllFoldersCmd, filterReadingListCmd *kingpin.CmdClause
	openCmd, closeCmd, filterTabsCmd          *kingpin.CmdClause
	filterCloudTabsCmd                        *kingpin.CmdClause
	distnameCmd, runActionCmd, searchCmd      *kingpin.CmdClause
	runTabActionCmd, runURLActionCmd          *kingpin.CmdClause
	filterActionsCmd, filterTabActionsCmd     *kingpin.CmdClause
	filterURLActionsCmd, activeTabCmd         *kingpin.CmdClause
	filterHistoryCmd, updateCmd, blacklistCmd *kingpin.CmdClause
	configCmd                                 *kingpin.CmdClause

	// Script options (populated by Kingpin application)
	query                       string
	left, right                 bool
	winIdx, tabIdx              int
	action, actionType, uid     string
	includeBookmarklets         bool
	searchHostnames             bool
	actionURL                   *url.URL
	maxResults                  int
	recentHistoryEntries        int
	scriptNames                 []string
	tabActionOpt, tabActionCtrl string
	tabActionFn, tabActionShift string
	urlActionOpt, urlActionCtrl string
	urlActionFn, urlActionShift string
	urlActionDefault            string

	// Workflow stuff
	wf         *aw.Workflow
	scriptDirs []string

	urlKillWords = []string{"www.", ".com", ".net", ".org", ".co.uk"}
)

// Mostly sets up kingpin commands
func init() {

	// Override default icons
	aw.IconError = IconError
	aw.IconWarning = IconWarning

	wf = aw.New(update.GitHub("deanishe/alfred-safari-assistant"),
		aw.HelpURL("https://github.com/deanishe/alfred-safari-assistant/issues"))

	scriptDirs = []string{
		filepath.Join(wf.Dir(), "scripts", "tab"),
		filepath.Join(wf.Dir(), "scripts", "url"),
		filepath.Join(wf.DataDir(), "scripts", "tab"),
		filepath.Join(wf.DataDir(), "scripts", "url"),
	}

	app = kingpin.New("alsf", "Safari bookmarks, windows and tabs in Alfred.")
	app.HelpFlag.Short('h')
	app.Version(wf.Version())

	// ---------------------------------------------------------------
	// Global flags

	// URL actions
	app.Flag("url-ctrl", "Action to run for CTRL key.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&urlActionCtrl)
	app.Flag("url-opt", "Action to run for OPT (ALT) key.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&urlActionOpt)
	app.Flag("url-fn", "Action to run for FN key.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&urlActionFn)
	app.Flag("url-shift", "Action to run for SHIFT key.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&urlActionShift)
	app.Flag("url-default", "Default action for opening URLs.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&urlActionDefault)
	// Tab actions
	app.Flag("tab-ctrl", "Action/bookmarklet to run for CTRL key.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&tabActionCtrl)
	app.Flag("tab-opt", "Action/bookmarklet to run for OPT (ALT) key.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&tabActionOpt)
	app.Flag("tab-fn", "Action/bookmarklet to run for FN key").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&tabActionFn)
	app.Flag("tab-shift", "Action/bookmarklet to run for SHIFT key.").
		PlaceHolder("SCRIPT_NAME").
		StringVar(&tabActionShift)

	// ---------------------------------------------------------------
	// List action commands
	filterActionsCmd = app.Command("actions", "List actions.").Alias("la")
	filterTabActionsCmd = filterActionsCmd.Command("tab", "List tab actions.").Alias("lta")
	filterURLActionsCmd = filterActionsCmd.Command("url", "List URL actions.").Alias("lua")

	// ---------------------------------------------------------------
	// Action commands
	runActionCmd = app.Command("action", "Run an action.").Alias("A")
	runTabActionCmd = runActionCmd.Command("tab", "Run a tab action.").Alias("t")
	runURLActionCmd = runActionCmd.Command("url", "Run a URL action.").Alias("u")
	// Common URL options
	for _, cmd := range []*kingpin.CmdClause{runURLActionCmd, filterURLActionsCmd, filterTabActionsCmd} {
		cmd.Flag("url", "URL to action.").Short('u').Required().URLVar(&actionURL)
	}

	runTabActionCmd.Flag("action-type", "Action type.").PlaceHolder("TYPE").Required().StringVar(&actionType)

	// ---------------------------------------------------------------
	// Commands using window and tab
	activateCmd = app.Command("activate", "Active a specific window or tab.").Alias("a")
	closeCmd = app.Command("close", "Close tab(s).").Alias("c")

	// Common options
	for _, cmd := range []*kingpin.CmdClause{activateCmd, closeCmd, runTabActionCmd, filterTabActionsCmd} {
		cmd.Flag("window", "Window number.").
			Short('w').Default("1").IntVar(&winIdx)
		cmd.Flag("tab", "Tab number.").
			Short('t').Required().IntVar(&tabIdx)
	}
	closeCmd.Flag("left", "Close tab(s) to left of specified tab.").
		Short('l').BoolVar(&left)
	closeCmd.Flag("right", "Close tab(s) to right of specified tab.").
		Short('r').BoolVar(&right)

	// ---------------------------------------------------------------
	// Commands using UID
	filterFolderCmd = app.Command("browse", "Filter the contents of a bookmark folder.").Alias("B")
	openCmd = app.Command("open", "Open bookmark(s) or folder(s).").Alias("o")
	// Common options
	for _, cmd := range []*kingpin.CmdClause{filterFolderCmd, openCmd} {
		cmd.Flag("uid", "Bookmark/folder UID.").Short('u').StringVar(&uid)
	}

	// ---------------------------------------------------------------
	// Commands using query etc.
	searchCmd = app.Command("search", "Filter your bookmarks and recent history.").Alias("s")
	filterBookmarksCmd = app.Command("bookmarks", "Filter your bookmarks.").Alias("b")
	filterBookmarkletsCmd = app.Command("bookmarklets", "Filter your bookmarklets.").Alias("B")
	filterAllFoldersCmd = app.Command("folders", "Filter your bookmark folders.").Alias("f")
	filterReadingListCmd = app.Command("reading-list", "Filter your Reading List.").Alias("r")
	filterTabsCmd = app.Command("tabs", "Filter your tabs.").Alias("t")
	filterCloudTabsCmd = app.Command("icloud", "Filter your cloud tabs.").Alias("i")
	filterHistoryCmd = app.Command("history", "Filter your history.").Alias("h")
	configCmd = app.Command("config", "View configuration options.").Alias("c")

	// Common options
	for _, cmd := range []*kingpin.CmdClause{
		filterBookmarksCmd, filterBookmarkletsCmd, filterFolderCmd,
		filterAllFoldersCmd, filterReadingListCmd, filterTabsCmd,
		filterTabActionsCmd, filterURLActionsCmd, filterHistoryCmd,
		filterCloudTabsCmd, searchCmd, configCmd,
	} {
		cmd.Flag("query", "Search query.").Short('q').StringVar(&query)
		cmd.Flag("max-results", "Maximum number of results to send to Alfred.").
			Short('r').Default(defaultMaxResults).IntVar(&maxResults)
		cmd.Flag("search-hostnames", "Also search hostnames as well as titles.").
			Default("0").BoolVar(&searchHostnames)
	}

	// ---------------------------------------------------------------
	// Options set via workflow configuration sheet
	filterBookmarksCmd.Flag("include-bookmarklets", "Include bookmarklets with bookmarks.").
		BoolVar(&includeBookmarklets)

	searchCmd.Flag("history-entries", "Number of recent history entries to load.").
		IntVar(&recentHistoryEntries)

	// Commands that require an action
	for _, cmd := range []*kingpin.CmdClause{
		openCmd, runTabActionCmd, runURLActionCmd,
	} {

		cmd.Flag("action", "Action name.").Short('a').PlaceHolder("NAME").Required().StringVar(&action)
	}

	// ---------------------------------------------------------------
	// Other commands
	activeTabCmd = app.Command("active-tab", "Generate workflow variables for active tab.").Alias("at")
	distnameCmd = app.Command("distname", "Print name for .alfredworkflow file.").Alias("dn")
	updateCmd = app.Command("update", "Check for new workflow version.").Alias("u")
	blacklistCmd = app.Command("blacklist", "Add script name(s) to blacklist").Alias("b")
	blacklistCmd.Arg("scripts", "Names of scripts (without extensions).").
		StringsVar(&scriptNames)

	app.PreAction(func(ctx *kingpin.ParseContext) error {
		if err := LoadScripts(scriptDirs...); err != nil {
			return errors.Wrap(err, "load scripts")
		}
		return nil
	})
	app.DefaultEnvars()
}

// --------------------------------------------------------------------
// Actions

func doFilterURLActions() error {
	log.Printf("URL=%s", actionURL)
	ua := URLActions()
	acts := make([]Actionable, len(ua))
	for i, a := range ua {
		acts[i] = a
	}
	return listActions(acts)
}

// doURLAction performs an action on a URL.
func doURLAction() error {
	wf.Configure(aw.TextErrors(true))

	log.Printf("URL=%s, action=%s", actionURL, action)

	a := URLAction(action)
	if a == nil {
		return fmt.Errorf("Unknown action : %s", action)
	}
	return a.Run(actionURL)
}

// doDistname prints the filename of the .alfredworkflow file to STDOUT.
func doDistname() error {
	fmt.Print(strings.Replace(
		fmt.Sprintf("%s %s.alfredworkflow", wf.Name(), wf.Version()),
		" ", "-", -1))
	return nil
}

// --------------------------------------------------------------------
// Helpers

// urlKeywords returns fuzzy keywords for URL.
func urlKeywords(URL string) string {
	u, err := url.Parse(URL)
	if err != nil {
		return ""
	}
	h := u.Host
	for _, s := range urlKillWords {
		h = strings.Replace(h, s, "", -1)
	}
	return h
}

// loadWindows returns a list of Safari windows and caches them for the duration of the session.
func loadWindows() ([]*safari.Window, error) {

	var wins []*safari.Window

	getWins := func() (interface{}, error) {
		return safari.Windows()
	}

	if err := wf.Session.LoadOrStoreJSON("windows", getWins, &wins); err != nil {
		return nil, err
	}
	return wins, nil
}

// listActions sends a list of actions to Alfred.
func listActions(actions []Actionable) error {
	log.Printf("query=%s", query)

	for _, a := range actions {
		it := wf.NewItem(a.Title()).
			Arg(a.Title()).
			Icon(a.Icon()).
			Copytext(a.Title()).
			UID(a.Title()).
			Valid(true).
			Var("ALSF_ACTION", a.Title())

		it.NewModifier("cmd").
			Subtitle("Blacklist action").
			Arg(a.Title()).
			Valid(true).
			Icon(IconBlacklist).
			Var("action", "blacklist")

		if _, ok := a.(TabActionable); ok {
			it.Var("ALSF_ACTION_TYPE", "tab").
				Var("action", "tab-action")
		} else if _, ok := a.(URLActionable); ok {
			it.Var("ALSF_ACTION_TYPE", "url").
				Var("action", "url-action")
		}
	}

	if query != "" {
		res := wf.Filter(query)
		log.Printf("%d action(s) for %q", len(res), query)
	}
	wf.WarnEmpty("No actions found", "Try a different query?")
	wf.SendFeedback()
	return nil
}

// run is the main script entry point. It's called from main.
func run() {

	wf.Configure(aw.MaxResults(maxResults))

	var (
		cmd string
		err error
	)

	if cmd, err = app.Parse(wf.Args()); err != nil {
		wf.FatalError(err)
	}

	// Create user script directories
	util.MustExist(filepath.Join(wf.DataDir(), "scripts", "tab"))
	util.MustExist(filepath.Join(wf.DataDir(), "scripts", "url"))

	switch cmd {

	case activateCmd.FullCommand():
		err = doActivate()

	case filterBookmarksCmd.FullCommand():
		err = doFilterBookmarks()

	case filterBookmarkletsCmd.FullCommand():
		err = doFilterBookmarklets()

	case filterFolderCmd.FullCommand():
		err = doFilterFolder()

	case filterAllFoldersCmd.FullCommand():
		err = doFilterAllFolders()

	case filterHistoryCmd.FullCommand():
		err = doFilterHistory()

	case filterReadingListCmd.FullCommand():
		err = doFilterReadingList()

	case filterTabsCmd.FullCommand():
		err = doFilterTabs()

	case filterTabActionsCmd.FullCommand():
		err = doFilterTabActions()

	case filterURLActionsCmd.FullCommand():
		err = doFilterURLActions()

	case filterCloudTabsCmd.FullCommand():
		err = doFilterCloudTabs()

	case searchCmd.FullCommand():
		err = doSearch()

	case closeCmd.FullCommand():
		err = doClose()

	case openCmd.FullCommand():
		err = doOpen()

	case distnameCmd.FullCommand():
		err = doDistname()

	case runURLActionCmd.FullCommand():
		err = doURLAction()

	case runTabActionCmd.FullCommand():
		wf.Configure(aw.TextErrors(true))
		err = doTabAction()

	case activeTabCmd.FullCommand():
		err = doCurrentTab()

	case updateCmd.FullCommand():
		err = doUpdate()

	case blacklistCmd.FullCommand():
		err = doBlacklist()

	case configCmd.FullCommand():
		err = doConfig()

	default:
		err = fmt.Errorf("unknown command: %s", cmd)

	}

	// Check for update
	if err == nil && cmd != updateCmd.FullCommand() {
		err = checkForUpdate()
	}

	if err != nil {
		wf.FatalError(err)
	}
}

// main wraps run() (the actual entry point) to catch errors.
func main() {
	wf.Run(run)
}