diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8c14a19..997f669 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,37 +1,46 @@ # How to contribute We're happy you're considering contributing to the Write.as command-line client! It won't take long to get up to speed on this. Here are our development resources: * We do our project management in [Phabricator](https://phabricator.write.as/tag/write.as_cli/). * We accept and respond to bugs here on [GitHub](https://github.com/writeas/writeas-cli/issues). * We're usually in #writeas on freenode, but if not, find us on our [Slack channel](http://slack.write.as). ## Testing We try to write tests for all parts of the CLI, but aren't there yet. While not required, including tests with your new code will bring us closer to where we want to be and speed up our review. ## Submitting changes Please send a [pull request](https://github.com/writeas/writeas-cli/compare) with a clear list of what you've done. Please follow our coding conventions below and make sure all of your commits are atomic. Larger changes should have commits with more detailed information on what changed, any impact on existing code, rationales, etc. ## Coding conventions We strive for consistency above all. Reading the small codebase should give you a good idea of the conventions we follow. -* We use `go fmt` before committing anything +* We use `goimports` before committing anything * We aim to document all exported entities * Go files are broken up into logical functional components * General functions are extracted into modules when possible +### Import Groups + +We aim for two import groups: + +* Standard library imports +* Everything else + +`goimports` already does this for you along with running `go fmt`. + ## Design conventions We maintain a few high-level design principles in all decisions we make. Keep these in mind while devising new functionality: * Updates should be backwards compatible or provide a seamless migration path from *any* previous version * Each subcommand should perform one action and do it well * Each subcommand will ideally work well in a script * Avoid clever functionality and assume each function will be used in ways we didn't imagine diff --git a/cmd/writeas/api.go b/cmd/writeas/api.go index 670dba2..b46c022 100644 --- a/cmd/writeas/api.go +++ b/cmd/writeas/api.go @@ -1,219 +1,220 @@ package main import ( "fmt" + "path/filepath" + "github.com/atotto/clipboard" "github.com/writeas/web-core/posts" "github.com/writeas/writeas-cli/fileutils" - "go.code.as/writeas.v2" - "gopkg.in/urfave/cli.v1" - "path/filepath" + writeas "go.code.as/writeas.v2" + cli "gopkg.in/urfave/cli.v1" ) const ( defaultUserAgent = "writeas-cli v" + version ) func client(userAgent string, tor bool) *writeas.Client { var client *writeas.Client if tor { client = writeas.NewTorClient(torPort) } else { if isDev() { client = writeas.NewDevClient() } else { client = writeas.NewClient() } } client.UserAgent = userAgent return client } func newClient(c *cli.Context, authRequired bool) (*writeas.Client, error) { var client *writeas.Client if isTor(c) { client = writeas.NewTorClient(torPort) } else { if isDev() { client = writeas.NewDevClient() } else { client = writeas.NewClient() } } client.UserAgent = userAgent(c) // TODO: load user into var shared across the app u, _ := loadUser() if u != nil { client.SetToken(u.AccessToken) } else if authRequired { return nil, fmt.Errorf("Not currently logged in. Authenticate with: writeas auth ") } return client, nil } // DoFetch retrieves the Write.as post with the given friendlyID, // optionally via the Tor hidden service. func DoFetch(friendlyID, ua string, tor bool) error { cl := client(ua, tor) p, err := cl.GetPost(friendlyID) if err != nil { return err } if p.Title != "" { fmt.Printf("# %s\n\n", string(p.Title)) } fmt.Printf("%s\n", string(p.Content)) return nil } // DoPost creates a Write.as post, returning an error if it was // unsuccessful. func DoPost(c *cli.Context, post []byte, font string, encrypt, tor, code bool) (*writeas.Post, error) { cl, _ := newClient(c, false) pp := &writeas.PostParams{ Font: getFont(code, font), Collection: collection(c), } pp.Title, pp.Content = posts.ExtractTitle(string(post)) if lang := language(c, true); lang != "" { pp.Language = &lang } p, err := cl.CreatePost(pp) if err != nil { return nil, fmt.Errorf("Unable to post: %v", err) } var url string if p.Collection != nil { url = p.Collection.URL + p.Slug } else { if tor { url = torBaseURL } else if isDev() { url = devBaseURL } else { url = writeasBaseURL } url += "/" + p.ID // Output URL in requested format if c.Bool("md") { url += ".md" } } if cl.Token() == "" { // Store post locally, since we're not authenticated addPost(p.ID, p.Token) } // Copy URL to clipboard err = clipboard.WriteAll(string(url)) if err != nil { Errorln("writeas: Didn't copy to clipboard: %s", err) } else { Info(c, "Copied to clipboard.") } // Output URL fmt.Printf("%s\n", url) return p, nil } // DoUpdate updates the given post on Write.as. func DoUpdate(c *cli.Context, post []byte, friendlyID, token, font string, tor, code bool) error { cl, _ := newClient(c, false) params := writeas.PostParams{} params.Title, params.Content = posts.ExtractTitle(string(post)) if lang := language(c, false); lang != "" { params.Language = &lang } if code || font != "" { params.Font = getFont(code, font) } _, err := cl.UpdatePost(friendlyID, token, ¶ms) if err != nil { if debug { ErrorlnQuit("Problem updating: %v", err) } return fmt.Errorf("Post doesn't exist, or bad edit token given.") } if tor { Info(c, "Post updated via hidden service.") } else { Info(c, "Post updated.") } return nil } // DoDelete deletes the given post on Write.as. func DoDelete(c *cli.Context, friendlyID, token string, tor bool) error { cl, _ := newClient(c, false) err := cl.DeletePost(friendlyID, token) if err != nil { if debug { ErrorlnQuit("Problem deleting: %v", err) } return fmt.Errorf("Post doesn't exist, or bad edit token given.") } if tor { Info(c, "Post deleted from hidden service.") } else { Info(c, "Post deleted.") } removePost(friendlyID) return nil } func DoLogIn(c *cli.Context, username, password string) error { cl := client(userAgent(c), isTor(c)) u, err := cl.LogIn(username, password) if err != nil { if debug { ErrorlnQuit("Problem logging in: %v", err) } return err } err = saveUser(u) if err != nil { return err } fmt.Printf("Logged in as %s.\n", u.User.Username) return nil } func DoLogOut(c *cli.Context) error { cl, err := newClient(c, true) if err != nil { return err } err = cl.LogOut() if err != nil { if debug { ErrorlnQuit("Problem logging out: %v", err) } return err } // Delete local user data err = fileutils.DeleteFile(filepath.Join(userDataDir(), userFile)) if err != nil { return err } return nil } diff --git a/cmd/writeas/cli.go b/cmd/writeas/cli.go index 6092688..8e0c548 100644 --- a/cmd/writeas/cli.go +++ b/cmd/writeas/cli.go @@ -1,359 +1,360 @@ package main import ( "bufio" - "go.code.as/writeas.v2" - "gopkg.in/urfave/cli.v1" "io" "log" "os" + + writeas "go.code.as/writeas.v2" + cli "gopkg.in/urfave/cli.v1" ) // API constants for communicating with Write.as. const ( writeasBaseURL = "https://write.as" devBaseURL = "https://development.write.as" torBaseURL = "http://writeas7pm7rcdqg.onion" ) // Application constants. const ( version = "1.99-dev" ) // Defaults for posts on Write.as. const ( defaultFont = PostFontMono ) // Available flags for creating posts var postFlags = []cli.Flag{ cli.StringFlag{ Name: "c, b", Usage: "Optional blog to post to", Value: "", }, cli.BoolFlag{ Name: "tor, t", Usage: "Perform action on Tor hidden service", }, cli.IntFlag{ Name: "tor-port", Usage: "Use a different port to connect to Tor", Value: 9150, }, cli.BoolFlag{ Name: "code", Usage: "Specifies this post is code", }, cli.BoolFlag{ Name: "md", Usage: "Returns post URL with Markdown enabled", }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, cli.StringFlag{ Name: "font", Usage: "Sets post font to given value", Value: defaultFont, }, cli.StringFlag{ Name: "lang", Usage: "Sets post language to given ISO 639-1 language code", Value: "", }, cli.StringFlag{ Name: "user-agent", Usage: "Sets the User-Agent for API requests", Value: "", }, } func main() { initialize() cli.VersionFlag = cli.BoolFlag{ Name: "version, V", Usage: "print the version", } // Run the app app := cli.NewApp() app.Name = "writeas" app.Version = version app.Usage = "Publish text quickly" app.Authors = []cli.Author{ { Name: "Write.as", Email: "hello@write.as", }, } app.Action = cmdPost app.Flags = postFlags app.Commands = []cli.Command{ { Name: "post", Usage: "Alias for default action: create post from stdin", Action: cmdPost, Flags: postFlags, Description: `Create a new post on Write.as from stdin. Use the --code flag to indicate that the post should use syntax highlighting. Or use the --font [value] argument to set the post's appearance, where [value] is mono, monospace (default), wrap (monospace font with word wrapping), serif, or sans.`, }, { Name: "new", Usage: "Compose a new post from the command-line and publish", Description: `An alternative to piping data to the program. On Windows, this will use 'copy con' to start reading what you input from the prompt. Press F6 or Ctrl-Z then Enter to end input. On *nix, this will use the best available text editor, starting with the value set to the WRITAS_EDITOR or EDITOR environment variable, or vim, or finally nano. Use the --code flag to indicate that the post should use syntax highlighting. Or use the --font [value] argument to set the post's appearance, where [value] is mono, monospace (default), wrap (monospace font with word wrapping), serif, or sans. If posting fails for any reason, 'writeas' will show you the temporary file location and how to pipe it to 'writeas' to retry.`, Action: cmdNew, Flags: postFlags, }, { Name: "publish", Usage: "Publish a file to Write.as", Action: cmdPublish, Flags: postFlags, }, { Name: "delete", Usage: "Delete a post", Action: cmdDelete, Flags: []cli.Flag{ cli.BoolFlag{ Name: "tor, t", Usage: "Delete via Tor hidden service", }, cli.IntFlag{ Name: "tor-port", Usage: "Use a different port to connect to Tor", Value: 9150, }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, }, }, { Name: "update", Usage: "Update (overwrite) a post", Action: cmdUpdate, Flags: []cli.Flag{ cli.BoolFlag{ Name: "tor, t", Usage: "Update via Tor hidden service", }, cli.IntFlag{ Name: "tor-port", Usage: "Use a different port to connect to Tor", Value: 9150, }, cli.BoolFlag{ Name: "code", Usage: "Specifies this post is code", }, cli.StringFlag{ Name: "font", Usage: "Sets post font to given value", }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, }, }, { Name: "get", Usage: "Read a raw post", Action: cmdGet, Flags: []cli.Flag{ cli.BoolFlag{ Name: "tor, t", Usage: "Get from Tor hidden service", }, cli.IntFlag{ Name: "tor-port", Usage: "Use a different port to connect to Tor", Value: 9150, }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, }, }, { Name: "add", Usage: "Add an existing post locally", Description: `A way to add an existing post to your local store for easy editing later. This requires a post ID (from https://write.as/[ID]) and an Edit Token (exported from another Write.as client, such as the Android app). `, Action: cmdAdd, }, { Name: "list", Usage: "List local posts", Action: cmdList, Flags: []cli.Flag{ cli.BoolFlag{ Name: "id", Usage: "Show list with post IDs (default)", }, cli.BoolFlag{ Name: "md", Usage: "Use with --url to return URLs with Markdown enabled", }, cli.BoolFlag{ Name: "url", Usage: "Show list with URLs", }, }, }, { Name: "fetch", Usage: "Fetch authenticated user's Write.as posts", Action: cmdPull, Flags: []cli.Flag{ cli.BoolFlag{ Name: "tor, t", Usage: "Authenticate via Tor hidden service", }, cli.IntFlag{ Name: "tor-port", Usage: "Use a different port to connect to Tor", Value: 9150, }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, }, }, { Name: "auth", Usage: "Authenticate with Write.as", Action: cmdAuth, Flags: []cli.Flag{ cli.BoolFlag{ Name: "tor, t", Usage: "Authenticate via Tor hidden service", }, cli.IntFlag{ Name: "tor-port", Usage: "Use a different port to connect to Tor", Value: 9150, }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, }, }, { Name: "logout", Usage: "Log out of Write.as", Action: cmdLogOut, Flags: []cli.Flag{ cli.BoolFlag{ Name: "tor, t", Usage: "Authenticate via Tor hidden service", }, cli.IntFlag{ Name: "tor-port", Usage: "Use a different port to connect to Tor", Value: 9150, }, cli.BoolFlag{ Name: "verbose, v", Usage: "Make the operation more talkative", }, }, }, } cli.CommandHelpTemplate = `NAME: {{.Name}} - {{.Usage}} USAGE: writeas {{.Name}}{{if .Flags}} [command options]{{end}} [arguments...]{{if .Description}} DESCRIPTION: {{.Description}}{{end}}{{if .Flags}} OPTIONS: {{range .Flags}}{{.}} {{end}}{{ end }} ` app.Run(os.Args) } func initialize() { // Ensure we have a data directory to use if !dataDirExists() { createDataDir() } } func readStdIn() []byte { numBytes, numChunks := int64(0), int64(0) r := bufio.NewReader(os.Stdin) fullPost := []byte{} buf := make([]byte, 0, 1024) for { n, err := r.Read(buf[:cap(buf)]) buf = buf[:n] if n == 0 { if err == nil { continue } if err == io.EOF { break } log.Fatal(err) } numChunks++ numBytes += int64(len(buf)) fullPost = append(fullPost, buf...) if err != nil && err != io.EOF { log.Fatal(err) } } return fullPost } func handlePost(fullPost []byte, c *cli.Context) (*writeas.Post, error) { tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Posting to hidden service...") } else { Info(c, "Posting...") } return DoPost(c, fullPost, c.String("font"), false, tor, c.Bool("code")) } diff --git a/cmd/writeas/commands.go b/cmd/writeas/commands.go index 20e2b7c..a2d0eb1 100644 --- a/cmd/writeas/commands.go +++ b/cmd/writeas/commands.go @@ -1,242 +1,243 @@ package main import ( "fmt" - "github.com/howeyc/gopass" - "github.com/writeas/writeas-cli/fileutils" - "gopkg.in/urfave/cli.v1" "io/ioutil" "os" "path/filepath" + + "github.com/howeyc/gopass" + "github.com/writeas/writeas-cli/fileutils" + cli "gopkg.in/urfave/cli.v1" ) func cmdPost(c *cli.Context) error { _, err := handlePost(readStdIn(), c) return err } func cmdNew(c *cli.Context) error { fname, p := composeNewPost() if p == nil { // Assume composeNewPost already told us what the error was. Abort now. os.Exit(1) } // Ensure we have something to post if len(*p) == 0 { // Clean up temporary post if fname != "" { os.Remove(fname) } InfolnQuit("Empty post. Bye!") } _, err := handlePost(*p, c) if err != nil { Errorln("Error posting: %s", err) Errorln(messageRetryCompose(fname)) return cli.NewExitError("", 1) } // Clean up temporary post if fname != "" { os.Remove(fname) } return nil } func cmdPublish(c *cli.Context) error { filename := c.Args().Get(0) if filename == "" { return cli.NewExitError("usage: writeas publish ", 1) } content, err := ioutil.ReadFile(filename) if err != nil { return err } p, err := handlePost(content, c) if err != nil { return err } // Save post to posts folder cfg, err := loadConfig() if cfg.Posts.Directory != "" { err = WritePost(cfg.Posts.Directory, p) if err != nil { return err } } return nil } func cmdDelete(c *cli.Context) error { friendlyID := c.Args().Get(0) token := c.Args().Get(1) if friendlyID == "" { return cli.NewExitError("usage: writeas delete []", 1) } u, _ := loadUser() if token == "" { // Search for the token locally token = tokenFromID(friendlyID) if token == "" && u == nil { Errorln("Couldn't find an edit token locally. Did you create this post here?") ErrorlnQuit("If you have an edit token, use: writeas delete %s ", friendlyID) } } tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Deleting via hidden service...") } else { Info(c, "Deleting...") } err := DoDelete(c, friendlyID, token, tor) if err != nil { return err } // Delete local file, if necessary cfg, err := loadConfig() if cfg.Posts.Directory != "" { // TODO: handle deleting blog posts err = fileutils.DeleteFile(filepath.Join(cfg.Posts.Directory, friendlyID+postFileExt)) if err != nil { return err } } return nil } func cmdUpdate(c *cli.Context) error { friendlyID := c.Args().Get(0) token := c.Args().Get(1) if friendlyID == "" { return cli.NewExitError("usage: writeas update []", 1) } u, _ := loadUser() if token == "" { // Search for the token locally token = tokenFromID(friendlyID) if token == "" && u == nil { Errorln("Couldn't find an edit token locally. Did you create this post here?") ErrorlnQuit("If you have an edit token, use: writeas update %s ", friendlyID) } } // Read post body fullPost := readStdIn() tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Updating via hidden service...") } else { Info(c, "Updating...") } return DoUpdate(c, fullPost, friendlyID, token, c.String("font"), tor, c.Bool("code")) } func cmdGet(c *cli.Context) error { friendlyID := c.Args().Get(0) if friendlyID == "" { return cli.NewExitError("usage: writeas get ", 1) } tor := isTor(c) if c.Int("tor-port") != 0 { torPort = c.Int("tor-port") } if tor { Info(c, "Getting via hidden service...") } else { Info(c, "Getting...") } return DoFetch(friendlyID, userAgent(c), tor) } func cmdAdd(c *cli.Context) error { friendlyID := c.Args().Get(0) token := c.Args().Get(1) if friendlyID == "" || token == "" { return cli.NewExitError("usage: writeas add ", 1) } err := addPost(friendlyID, token) return err } func cmdList(c *cli.Context) error { urls := c.Bool("url") ids := c.Bool("id") var p Post posts := getPosts() for i := range *posts { p = (*posts)[len(*posts)-1-i] if ids || !urls { fmt.Printf("%s ", p.ID) } if urls { base := writeasBaseURL if isDev() { base = devBaseURL } ext := "" // Output URL in requested format if c.Bool("md") { ext = ".md" } fmt.Printf("%s/%s%s ", base, p.ID, ext) } fmt.Print("\n") } return nil } func cmdAuth(c *cli.Context) error { // Check configuration u, err := loadUser() if err != nil { return cli.NewExitError(fmt.Sprintf("couldn't load config: %v", err), 1) } if u != nil && u.AccessToken != "" { return cli.NewExitError("You're already authenticated as "+u.User.Username+". Log out with: writeas logout", 1) } // Validate arguments and get password username := c.Args().Get(0) if username == "" { return cli.NewExitError("usage: writeas auth ", 1) } fmt.Print("Password: ") pass, err := gopass.GetPasswdMasked() if err != nil { return cli.NewExitError(fmt.Sprintf("error reading password: %v", err), 1) } // Validate password if len(pass) == 0 { return cli.NewExitError("Please enter your password.", 1) } return DoLogIn(c, username, string(pass)) } func cmdLogOut(c *cli.Context) error { return DoLogOut(c) } diff --git a/cmd/writeas/logging.go b/cmd/writeas/logging.go index 98fb5ec..988209c 100644 --- a/cmd/writeas/logging.go +++ b/cmd/writeas/logging.go @@ -1,32 +1,33 @@ package main import ( "fmt" - "gopkg.in/urfave/cli.v1" "os" + + cli "gopkg.in/urfave/cli.v1" ) // Info logs general diagnostic messages, shown only when the -v or --verbose // flag is provided. func Info(c *cli.Context, s string, p ...interface{}) { if c.Bool("v") || c.Bool("verbose") { fmt.Fprintf(os.Stderr, s+"\n", p...) } } // InfolnQuit logs the message to stderr and exits normally (without an error). func InfolnQuit(s string, p ...interface{}) { fmt.Fprintf(os.Stderr, s+"\n", p...) os.Exit(0) } // Error func Errorln(s string, p ...interface{}) { fmt.Fprintf(os.Stderr, s+"\n", p...) } // ErrorlnQuit logs the message to stderr and exits with an error code. func ErrorlnQuit(s string, p ...interface{}) { fmt.Fprintf(os.Stderr, s+"\n", p...) os.Exit(1) } diff --git a/cmd/writeas/options.go b/cmd/writeas/options.go index 30222cd..1b0e065 100644 --- a/cmd/writeas/options.go +++ b/cmd/writeas/options.go @@ -1,44 +1,44 @@ package main import ( "github.com/cloudfoundry/jibber_jabber" - "gopkg.in/urfave/cli.v1" + cli "gopkg.in/urfave/cli.v1" ) func userAgent(c *cli.Context) string { ua := c.String("user-agent") if ua == "" { return defaultUserAgent } return ua + " (" + defaultUserAgent + ")" } func isTor(c *cli.Context) bool { return c.Bool("tor") || c.Bool("t") } func language(c *cli.Context, auto bool) string { if l := c.String("lang"); l != "" { return l } if !auto { return "" } // Automatically detect language l, err := jibber_jabber.DetectLanguage() if err != nil { Info(c, "Language detection failed: %s", err) return "" } return l } func collection(c *cli.Context) string { if coll := c.String("c"); coll != "" { return coll } if coll := c.String("b"); coll != "" { return coll } return "" } diff --git a/cmd/writeas/posts.go b/cmd/writeas/posts.go index 175341a..180693b 100644 --- a/cmd/writeas/posts.go +++ b/cmd/writeas/posts.go @@ -1,165 +1,166 @@ package main import ( "fmt" - "github.com/writeas/writeas-cli/fileutils" - "go.code.as/writeas.v2" "io/ioutil" "os" "path/filepath" "strings" + + "github.com/writeas/writeas-cli/fileutils" + writeas "go.code.as/writeas.v2" ) const ( postsFile = "posts.psv" separator = `|` ) // Post holds the basic authentication information for a Write.as post. type Post struct { ID string EditToken string } func userDataDir() string { return filepath.Join(parentDataDir(), dataDirName) } func dataDirExists() bool { return fileutils.Exists(userDataDir()) } func createDataDir() { err := os.Mkdir(userDataDir(), 0700) if err != nil { if debug { panic(err) } else { Errorln("Error creating data directory: %s", err) return } } } func addPost(id, token string) error { f, err := os.OpenFile(filepath.Join(userDataDir(), postsFile), os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0600) if err != nil { return fmt.Errorf("Error creating local posts list: %s", err) } defer f.Close() l := fmt.Sprintf("%s%s%s\n", id, separator, token) if _, err = f.WriteString(l); err != nil { return fmt.Errorf("Error writing to local posts list: %s", err) } return nil } func tokenFromID(id string) string { post := fileutils.FindLine(filepath.Join(userDataDir(), postsFile), id) if post == "" { return "" } parts := strings.Split(post, separator) if len(parts) < 2 { return "" } return parts[1] } func removePost(id string) { fileutils.RemoveLine(filepath.Join(userDataDir(), postsFile), id) } func getPosts() *[]Post { lines := fileutils.ReadData(filepath.Join(userDataDir(), postsFile)) posts := []Post{} if lines != nil && len(*lines) > 0 { parts := make([]string, 2) for _, l := range *lines { parts = strings.Split(l, separator) if len(parts) < 2 { continue } posts = append(posts, Post{ID: parts[0], EditToken: parts[1]}) } } return &posts } func composeNewPost() (string, *[]byte) { f, err := fileutils.TempFile(os.TempDir(), "WApost", "txt") if err != nil { if debug { panic(err) } else { Errorln("Error creating temp file: %s", err) return "", nil } } f.Close() cmd := editPostCmd(f.Name()) if cmd == nil { os.Remove(f.Name()) fmt.Println(noEditorErr) return "", nil } cmd.Stdin, cmd.Stdout, cmd.Stderr = os.Stdin, os.Stdout, os.Stderr if err := cmd.Start(); err != nil { os.Remove(f.Name()) if debug { panic(err) } else { Errorln("Error starting editor: %s", err) return "", nil } } // If something fails past this point, the temporary post file won't be // removed automatically. Calling function should handle this. if err := cmd.Wait(); err != nil { if debug { panic(err) } else { Errorln("Editor finished with error: %s", err) return "", nil } } post, err := ioutil.ReadFile(f.Name()) if err != nil { if debug { panic(err) } else { Errorln("Error reading post: %s", err) return "", nil } } return f.Name(), &post } func WritePost(postsDir string, p *writeas.Post) error { postFilename := p.ID collDir := "" if p.Collection != nil { postFilename = p.Slug collDir = p.Collection.Alias } postFilename += postFileExt txtFile := p.Content if p.Title != "" { txtFile = "# " + p.Title + "\n\n" + txtFile } return ioutil.WriteFile(filepath.Join(postsDir, collDir, postFilename), []byte(txtFile), 0644) } diff --git a/cmd/writeas/posts_nix.go b/cmd/writeas/posts_nix.go index ee4d78b..52fbae5 100644 --- a/cmd/writeas/posts_nix.go +++ b/cmd/writeas/posts_nix.go @@ -1,43 +1,44 @@ // +build !windows package main import ( "fmt" - "github.com/mitchellh/go-homedir" "os/exec" + + homedir "github.com/mitchellh/go-homedir" ) const ( dataDirName = ".writeas" noEditorErr = "Couldn't find default editor. Try setting $EDITOR environment variable in ~/.profile" ) func parentDataDir() string { dir, err := homedir.Dir() if err != nil { panic(err) } return dir } func editPostCmd(fname string) *exec.Cmd { editor := getConfiguredEditor() if editor == "" { // Fall back to default editor path, err := exec.LookPath("vim") if err != nil { path, err = exec.LookPath("nano") if err != nil { return nil } } editor = path } return exec.Command(editor, fname) } func messageRetryCompose(fname string) string { return fmt.Sprintf("To retry this post, run:\n cat %s | writeas", fname) } diff --git a/cmd/writeas/sync.go b/cmd/writeas/sync.go index 110befa..c14a8f5 100644 --- a/cmd/writeas/sync.go +++ b/cmd/writeas/sync.go @@ -1,129 +1,130 @@ package main import ( //"github.com/writeas/writeas-cli/sync" "fmt" - "github.com/writeas/writeas-cli/fileutils" - "gopkg.in/urfave/cli.v1" "io/ioutil" "os" "path/filepath" + + "github.com/writeas/writeas-cli/fileutils" + cli "gopkg.in/urfave/cli.v1" ) const ( postFileExt = ".txt" userFilename = "writeas_user" ) func cmdPull(c *cli.Context) error { cfg, err := loadConfig() if err != nil { return err } // Create posts directory if needed if cfg.Posts.Directory == "" { syncSetUp(cfg) } // Fetch posts cl, err := newClient(c, true) if err != nil { return err } posts, err := cl.GetUserPosts() if err != nil { return err } for _, p := range *posts { postFilename := p.ID collDir := "" if p.Collection != nil { postFilename = p.Slug // Create directory for collection collDir = p.Collection.Alias if !fileutils.Exists(filepath.Join(cfg.Posts.Directory, collDir)) { Info(c, "Creating folder "+collDir) err = os.Mkdir(filepath.Join(cfg.Posts.Directory, collDir), 0755) if err != nil { Errorln("Error creating blog directory %s: %s. Skipping post %s.", collDir, err, postFilename) continue } } } postFilename += postFileExt // Write file txtFile := p.Content if p.Title != "" { txtFile = "# " + p.Title + "\n\n" + txtFile } err = ioutil.WriteFile(filepath.Join(cfg.Posts.Directory, collDir, postFilename), []byte(txtFile), 0644) if err != nil { Errorln("Error creating file %s: %s", postFilename, err) } Info(c, "Saved post "+postFilename) // Update mtime and atime on files modTime := p.Updated.Local() err = os.Chtimes(filepath.Join(cfg.Posts.Directory, collDir, postFilename), modTime, modTime) if err != nil { Errorln("Error setting time on %s: %s", postFilename, err) } } return nil } // TODO: move UserConfig to its own package, and this to sync package func syncSetUp(cfg *UserConfig) error { // Get user information and fail early (before we make the user do // anything), if we're going to u, err := loadUser() if err != nil { return err } // Prompt for posts directory defaultDir, err := os.Getwd() if err != nil { return err } var dir string fmt.Printf("Posts directory? [%s]: ", defaultDir) fmt.Scanln(&dir) if dir == "" { dir = defaultDir } // FIXME: This only works on non-Windows OSes (fix: https://www.reddit.com/r/golang/comments/5t3ezd/hidden_files_directories/) userFilepath := filepath.Join(dir, "."+userFilename) // Create directory if needed if !fileutils.Exists(dir) { err = os.MkdirAll(dir, 0700) if err != nil { if debug { Errorln("Error creating data directory: %s", err) } return err } // Create username file in directory err = ioutil.WriteFile(userFilepath, []byte(u.User.Username), 0644) fmt.Println("Created posts directory.") } // Save preference cfg.Posts.Directory = dir err = saveConfig(cfg) if err != nil { if debug { Errorln("Unable to save config: %s", err) } return err } fmt.Println("Saved config.") return nil } diff --git a/cmd/writeas/tor.go b/cmd/writeas/tor.go index 00f1821..d4dc585 100644 --- a/cmd/writeas/tor.go +++ b/cmd/writeas/tor.go @@ -1,17 +1,18 @@ package main import ( - "code.as/core/socks" "fmt" "net/http" + + "code.as/core/socks" ) var ( torPort = 9150 ) func torClient() *http.Client { dialSocksProxy := socks.DialSocksProxy(socks.SOCKS5, fmt.Sprintf("127.0.0.1:%d", torPort)) transport := &http.Transport{Dial: dialSocksProxy} return &http.Client{Transport: transport} } diff --git a/cmd/writeas/userconfig.go b/cmd/writeas/userconfig.go index e904dff..66a48e7 100644 --- a/cmd/writeas/userconfig.go +++ b/cmd/writeas/userconfig.go @@ -1,90 +1,91 @@ package main import ( "encoding/json" - "github.com/writeas/writeas-cli/fileutils" - "go.code.as/writeas.v2" - "gopkg.in/ini.v1" "io/ioutil" "path/filepath" + + "github.com/writeas/writeas-cli/fileutils" + writeas "go.code.as/writeas.v2" + ini "gopkg.in/ini.v1" ) const ( userConfigFile = "config.ini" userFile = "user.json" ) type ( APIConfig struct { } PostsConfig struct { Directory string `ini:"directory"` } UserConfig struct { API APIConfig `ini:"api"` Posts PostsConfig `ini:"posts"` } ) func loadConfig() (*UserConfig, error) { // TODO: load config to var shared across app cfg, err := ini.LooseLoad(filepath.Join(userDataDir(), userConfigFile)) if err != nil { return nil, err } // Parse INI file uc := &UserConfig{} err = cfg.MapTo(uc) if err != nil { return nil, err } return uc, nil } func saveConfig(uc *UserConfig) error { cfg := ini.Empty() err := ini.ReflectFrom(cfg, uc) if err != nil { return err } return cfg.SaveTo(filepath.Join(userDataDir(), userConfigFile)) } func loadUser() (*writeas.AuthUser, error) { fname := filepath.Join(userDataDir(), userFile) userJSON, err := ioutil.ReadFile(fname) if err != nil { if !fileutils.Exists(fname) { // Don't return a file-not-found error return nil, nil } return nil, err } // Parse JSON file u := &writeas.AuthUser{} err = json.Unmarshal(userJSON, u) if err != nil { return nil, err } return u, nil } func saveUser(u *writeas.AuthUser) error { // Marshal struct into pretty-printed JSON userJSON, err := json.MarshalIndent(u, "", " ") if err != nil { return err } // Save file err = ioutil.WriteFile(filepath.Join(userDataDir(), userFile), userJSON, 0600) if err != nil { return err } return nil }