diff --git a/GUIDE.md b/GUIDE.md index 24f5e26..848e060 100644 --- a/GUIDE.md +++ b/GUIDE.md @@ -1,148 +1,153 @@ # Write.as CLI User Guide The Write.as Command-Line Interface (CLI) is a cross-platform tool for publishing text to [Write.as](https://write.as) and its other sites, like [Paste.as](https://paste.as). It is designed to be simple, scriptable, do one job (publishing) well, and work as you'd expect with other command-line tools. Write.as is a text-publishing service that protects your privacy. There's no sign up required to publish, but if you do sign up, you can access posts across devices and compile collections of them in what most people would call a "blog". ## Uses These are a few common uses for `writeas`. If you get stuck or want to know more, run `writeas [command] --help`. If you still have questions, [ask us](https://write.as/contact). ### Overview ``` writeas [global options] command [command options] [arguments...] COMMANDS: post Alias for default action: create post from stdin new Compose a new post from the command-line and publish publish Publish a file to Write.as delete Delete a post update Update (overwrite) a post get Read a raw post add Add an existing post locally posts List all of your posts claim Claim local unsynced posts blogs List blogs claim Claim local unsynced posts auth Authenticate with Write.as logout Log out of Write.as help, h Shows a list of commands or help for one command GLOBAL OPTIONS: -c value, -b value Optional blog to post to --tor, -t Perform action on Tor hidden service --tor-port value Use a different port to connect to Tor (default: 9150) --code Specifies this post is code --md Returns post URL with Markdown enabled --verbose, -v Make the operation more talkative --font value Sets post font to given value (default: "mono") --lang value Sets post language to given ISO 639-1 language code --user-agent value Sets the User-Agent for API requests --host value, -H value Operate against a custom hostname --user value, -u value Use authenticated user, other than default --help, -h show help --version, -V print the version ``` > Note: the host and user flags are only available in `wf` the community edition #### Share something By default, `writeas` creates a post with a `monospace` typeface that doesn't word wrap (scrolls horizontally). It will return a single line with a URL, and automatically copy that URL to the clipboard: ```bash $ echo "Hello world!" | writeas https://write.as/aaaazzzzzzzza ``` This is generally more useful for posting terminal output or code, like so (the `--code` flag turns on syntax highlighting): macOS / Linux: `cat writeas/cli.go | writeas --code` Windows: `type writeas/cli.go | writeas.exe --code` #### Output a post This outputs any Write.as post with the given ID. ```bash $ writeas get aaaazzzzzzzza Hello world! ``` #### Authenticate This will authenticate with write.as and store the user access token locally, until you explicitly logout. ```bash $ writeas auth username Password: ************ ``` #### List all blogs This will output a list of the authenticated user's blogs. ```bash $ writeas blogs Alias Title user An Example Blog dev My Dev Log ``` -#### List all published posts +#### List posts -This lists all posts you've published from your device, as well as any published by the authenticated user. +This lists all posts you've published from your device Pass the `--url` flag to show the list with full post URLs, and the `--md` flag to return URLs with Markdown enabled. +To see post IDs with their Edit Tokens pass the `--v` flag. + ```bash $ writeas posts -Local ID Token -unsynced aaaazzzzzzzza dhuieoj23894jhf984hdfs9834hdf84j +aaaazzzzzzzza + +$ writeas posts -url +https://write.as/aaaazzzzzzzza -Account ID Title -synced mmmmmmmm33333333 This is a post +$ writeas posts -v +ID Token +aaaazzzzzzzza dhuieoj23894jhf984hdfs9834hdf84j ``` #### Delete a post This permanently deletes a post you own. ```bash $ writeas delete aaaazzzzzzzza ``` #### Update a post This completely overwrites an existing post you own. ```bash $ echo "See you later!" | writeas update aaaazzzzzzzza ``` #### Claim a post This moves an unsynced local post to a draft on your account. You will need to authenticate first. ```bash $ writeas claim aaaazzzzzzzza ``` ### Composing posts If you simply have a penchant for never leaving your keyboard, `writeas` is great for composing new posts from the command-line. Just use the `new` subcommand. `writeas new` will open your favorite command-line editor, as specified by your `WRITEAS_EDITOR` or `EDITOR` environment variables (in that order), falling back to `vim` on OS X / *nix. Customize your post's appearance with the `--font` flag: | Argument | Appearance (Typeface) | Word Wrap? | | -------- | --------------------- | ---------- | | `sans` | Sans-serif (Open Sans) | Yes | | `serif` | Serif (Lora) | Yes | | `wrap` | Monospace | Yes | | `mono` | Monospace | No | | `code` | Syntax-highlighted monospace | No | Put it all together, e.g. publish with a sans-serif font: `writeas new --font sans` If you're publishing Markdown, supply the `--md` flag to get a URL back that will render Markdown, e.g.: `writeas new --font sans --md` diff --git a/api/api.go b/api/api.go index f4999b1..eaffaca 100644 --- a/api/api.go +++ b/api/api.go @@ -1,296 +1,267 @@ package api import ( "fmt" "github.com/atotto/clipboard" writeas "github.com/writeas/go-writeas/v2" "github.com/writeas/web-core/posts" "github.com/writeas/writeas-cli/config" "github.com/writeas/writeas-cli/log" cli "gopkg.in/urfave/cli.v1" ) -func client(c *cli.Context, userAgent string, tor bool) (*writeas.Client, error) { - var client *writeas.Client - var clientConfig writeas.Config - cfg, err := config.LoadConfig(config.UserDataDir(c.App.ExtraInfo()["configDir"])) - if err != nil { - return nil, fmt.Errorf("Failed to load configuration file: %v", err) - } - if c.GlobalString("host") != "" { - clientConfig.URL = c.GlobalString("host") + "/api" - } else if cfg.Default.Host != "" { - clientConfig.URL = cfg.Default.Host + "/api" - } else if config.IsDev() { - clientConfig.URL = config.DevBaseURL + "/api" - } else { - clientConfig.URL = config.WriteasBaseURL + "/api" - } - if tor { - clientConfig.URL = config.TorBaseURL - clientConfig.TorPort = TorPort - } - - client = writeas.NewClientWith(clientConfig) - client.UserAgent = userAgent - - return client, nil -} - -func NewClient(c *cli.Context, authRequired bool) (*writeas.Client, error) { +func newClient(c *cli.Context, authRequired bool) (*writeas.Client, error) { var client *writeas.Client var clientConfig writeas.Config cfg, err := config.LoadConfig(config.UserDataDir(c.App.ExtraInfo()["configDir"])) if err != nil { return nil, fmt.Errorf("Failed to load configuration file: %v", err) } if c.GlobalString("host") != "" { clientConfig.URL = c.GlobalString("host") + "/api" } else if cfg.Default.Host != "" { clientConfig.URL = cfg.Default.Host + "/api" } else if config.IsDev() { clientConfig.URL = config.DevBaseURL + "/api" } else { clientConfig.URL = config.WriteasBaseURL + "/api" } if config.IsTor(c) { clientConfig.URL = config.TorBaseURL - clientConfig.TorPort = TorPort + clientConfig.TorPort = config.TorPort(c) } client = writeas.NewClientWith(clientConfig) client.UserAgent = config.UserAgent(c) // TODO: load user into var shared across the app u, _ := config.LoadUser(c) 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(c *cli.Context, friendlyID, ua string, tor bool) error { - cl, err := client(c, ua, tor) +func DoFetch(c *cli.Context, friendlyID string) error { + cl, err := newClient(c, false) if err != nil { return err } 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 } // DoFetchPosts retrieves all remote posts for the // authenticated user func DoFetchPosts(c *cli.Context) ([]writeas.Post, error) { - cl, err := NewClient(c, true) + cl, err := newClient(c, true) if err != nil { - return nil, err + return nil, fmt.Errorf("Unable to create client: %v", err) } posts, err := cl.GetUserPosts() if err != nil { return nil, err } return *posts, 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) +func DoPost(c *cli.Context, post []byte, font string, encrypt, code bool) (*writeas.Post, error) { + cl, err := newClient(c, false) + if err != nil { + return nil, fmt.Errorf("Unable to create client: %v", err) + } pp := &writeas.PostParams{ Font: config.GetFont(code, font), Collection: config.Collection(c), } pp.Title, pp.Content = posts.ExtractTitle(string(post)) if lang := config.Language(c, true); lang != "" { pp.Language = &lang } p, err := cl.CreatePost(pp) if err != nil { return nil, fmt.Errorf("Unable to post: %v", err) } cfg, err := config.LoadConfig(config.UserDataDir(c.App.ExtraInfo()["configDir"])) if err != nil { return nil, fmt.Errorf("Couldn't check for config file: %v", err) } var url string if p.Collection != nil { url = p.Collection.URL + p.Slug } else { if c.GlobalString("host") != "" { url = c.GlobalString("host") } else if cfg.Default.Host != "" { url = cfg.Default.Host } else if config.IsDev() { url = config.DevBaseURL - } else if tor { + } else if config.IsTor(c) { url = config.TorBaseURL } else { url = config.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(c, p.ID, p.Token) } // Copy URL to clipboard err = clipboard.WriteAll(string(url)) if err != nil { log.Errorln("writeas: Didn't copy to clipboard: %s", err) } else { log.Info(c, "Copied to clipboard.") } // Output URL fmt.Printf("%s\n", url) return p, nil } // DoFetchCollections retrieves a list of the currently logged in users // collections. func DoFetchCollections(c *cli.Context) ([]RemoteColl, error) { - cl, err := NewClient(c, true) + cl, err := newClient(c, true) if err != nil { if config.Debug() { - log.ErrorlnQuit("could not create new client: %v", err) + log.ErrorlnQuit("could not create client: %v", err) } return nil, fmt.Errorf("Couldn't create new client") } colls, err := cl.GetUserCollections() if err != nil { if config.Debug() { log.ErrorlnQuit("failed fetching user collections: %v", err) } - return nil, fmt.Errorf("Couldn't get user collections") + return nil, fmt.Errorf("Couldn't get user blogs") } out := make([]RemoteColl, len(*colls)) for i, c := range *colls { coll := RemoteColl{ Alias: c.Alias, Title: c.Title, URL: c.URL, } out[i] = coll } return out, 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) +func DoUpdate(c *cli.Context, post []byte, friendlyID, token, font string, code bool) error { + cl, err := newClient(c, false) + if err != nil { + return fmt.Errorf("Unable to create client: %v", err) + } params := writeas.PostParams{} params.Title, params.Content = posts.ExtractTitle(string(post)) if lang := config.Language(c, false); lang != "" { params.Language = &lang } if code || font != "" { params.Font = config.GetFont(code, font) } - _, err := cl.UpdatePost(friendlyID, token, ¶ms) + _, err = cl.UpdatePost(friendlyID, token, ¶ms) if err != nil { if config.Debug() { log.ErrorlnQuit("Problem updating: %v", err) } return fmt.Errorf("Post doesn't exist, or bad edit token given.") } - - if tor { - log.Info(c, "Post updated via hidden service.") - } else { - log.Info(c, "Post updated.") - } return nil } // DoDelete deletes the given post on Write.as, and removes any local references -func DoDelete(c *cli.Context, friendlyID, token string, tor bool) error { - cl, _ := NewClient(c, false) +func DoDelete(c *cli.Context, friendlyID, token string) error { + cl, err := newClient(c, false) + if err != nil { + return fmt.Errorf("Unable to create client: %v", err) + } - err := cl.DeletePost(friendlyID, token) + err = cl.DeletePost(friendlyID, token) if err != nil { if config.Debug() { log.ErrorlnQuit("Problem deleting: %v", err) } return fmt.Errorf("Post doesn't exist, or bad edit token given.") } - if tor { - log.Info(c, "Post deleted from hidden service.") - } else { - log.Info(c, "Post deleted.") - } RemovePost(c, friendlyID) return nil } func DoLogIn(c *cli.Context, username, password string) error { - cl, err := client(c, config.UserAgent(c), config.IsTor(c)) + cl, err := newClient(c, false) if err != nil { - return err + return fmt.Errorf("Unable to create client: %v", err) } u, err := cl.LogIn(username, password) if err != nil { if config.Debug() { log.ErrorlnQuit("Problem logging in: %v", err) } return err } err = config.SaveUser(c, u) if err != nil { return err } log.Info(c, "Logged in as %s.\n", u.User.Username) return nil } func DoLogOut(c *cli.Context) error { - cl, err := NewClient(c, true) + cl, err := newClient(c, true) if err != nil { - return err + return fmt.Errorf("Unable to create client: %v", err) } err = cl.LogOut() if err != nil { if config.Debug() { log.ErrorlnQuit("Problem logging out: %v", err) } return err } // delete local user file return config.DeleteUser(c) } diff --git a/api/posts.go b/api/posts.go index cef808f..fc1e799 100644 --- a/api/posts.go +++ b/api/posts.go @@ -1,312 +1,298 @@ package api import ( "bufio" "fmt" "io" "io/ioutil" "os" "path/filepath" "strings" "time" writeas "github.com/writeas/go-writeas/v2" "github.com/writeas/writeas-cli/config" "github.com/writeas/writeas-cli/fileutils" "github.com/writeas/writeas-cli/log" cli "gopkg.in/urfave/cli.v1" ) const ( postsFile = "posts.psv" separator = `|` ) // Post holds the basic authentication information for a Write.as post. type Post struct { ID string EditToken string } // RemotePost holds addition information about published // posts type RemotePost struct { Post Title, Excerpt, Slug, Collection, EditToken string Synced bool Updated time.Time } func AddPost(c *cli.Context, id, token string) error { hostDir, err := config.HostDirectory(c) if err != nil { return fmt.Errorf("Error checking for host directory: %v", err) } f, err := os.OpenFile(filepath.Join(config.UserDataDir(c.App.ExtraInfo()["configDir"]), hostDir, 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 } // ClaimPost adds a local post to the authenticated user's account and deletes // the local reference func ClaimPosts(c *cli.Context, localPosts *[]Post) (*[]writeas.ClaimPostResult, error) { - cl, err := NewClient(c, true) + cl, err := newClient(c, true) if err != nil { return nil, err } postsToClaim := make([]writeas.OwnedPostParams, len(*localPosts)) for i, post := range *localPosts { postsToClaim[i] = writeas.OwnedPostParams{ ID: post.ID, Token: post.EditToken, } } return cl.ClaimPosts(&postsToClaim) } func TokenFromID(c *cli.Context, id string) string { hostDir, _ := config.HostDirectory(c) post := fileutils.FindLine(filepath.Join(config.UserDataDir(c.App.ExtraInfo()["configDir"]), hostDir, postsFile), id) if post == "" { return "" } parts := strings.Split(post, separator) if len(parts) < 2 { return "" } return parts[1] } func RemovePost(c *cli.Context, id string) { hostDir, _ := config.HostDirectory(c) fullPath := filepath.Join(config.UserDataDir(c.App.ExtraInfo()["configDir"]), hostDir, postsFile) fileutils.RemoveLine(fullPath, id) } func GetPosts(c *cli.Context) *[]Post { hostDir, _ := config.HostDirectory(c) lines := fileutils.ReadData(filepath.Join(config.UserDataDir(c.App.ExtraInfo()["configDir"]), hostDir, 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 GetUserPosts(c *cli.Context) ([]RemotePost, error) { waposts, err := DoFetchPosts(c) if err != nil { return nil, err } if len(waposts) == 0 { return nil, nil } posts := []RemotePost{} for _, p := range waposts { post := RemotePost{ Post: Post{ ID: p.ID, EditToken: p.Token, }, Title: p.Title, Excerpt: getExcerpt(p.Content), Slug: p.Slug, Synced: p.Slug != "", Updated: p.Updated, } if p.Collection != nil { post.Collection = p.Collection.Alias } posts = append(posts, post) } return posts, nil } // getExcerpt takes in a content string and returns // a concatenated version. limited to no more than // two lines of 80 chars each. delimited by '...' func getExcerpt(input string) string { length := len(input) if length <= 80 { return input } else if length < 160 { ln1, idx := trimToLength(input, 80) if idx == -1 { idx = 80 } ln2, _ := trimToLength(input[idx:], 80) return ln1 + "\n" + ln2 } else { excerpt := input[:158] ln1, idx := trimToLength(excerpt, 80) if idx == -1 { idx = 80 } ln2, _ := trimToLength(excerpt[idx:], 80) return ln1 + "\n" + ln2 + "..." } } func trimToLength(in string, l int) (string, int) { c := []rune(in) spaceIdx := -1 length := len(c) if length <= l { return in, spaceIdx } for i := l; i > 0; i-- { if c[i] == ' ' { spaceIdx = i break } } if spaceIdx > -1 { c = c[:spaceIdx] } return string(c), spaceIdx } func ComposeNewPost() (string, *[]byte) { f, err := fileutils.TempFile(os.TempDir(), "WApost", "txt") if err != nil { if config.Debug() { panic(err) } else { log.Errorln("Error creating temp file: %s", err) return "", nil } } f.Close() cmd := config.EditPostCmd(f.Name()) if cmd == nil { os.Remove(f.Name()) fmt.Println(config.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 config.Debug() { panic(err) } else { log.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 config.Debug() { panic(err) } else { log.Errorln("Editor finished with error: %s", err) return "", nil } } post, err := ioutil.ReadFile(f.Name()) if err != nil { if config.Debug() { panic(err) } else { log.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) } -func HandlePost(fullPost []byte, c *cli.Context) (*writeas.Post, error) { - tor := config.IsTor(c) - if c.Int("tor-port") != 0 { - TorPort = c.Int("tor-port") - } - if tor { - log.Info(c, "Posting to hidden service...") - } else { - log.Info(c, "Posting...") - } - - return DoPost(c, fullPost, c.String("font"), false, tor, c.Bool("code")) -} - 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.ErrorlnQuit("Error reading from stdin: %v", err) } numChunks++ numBytes += int64(len(buf)) fullPost = append(fullPost, buf...) if err != nil && err != io.EOF { log.ErrorlnQuit("Error appending to end of post: %v", err) } } return fullPost } diff --git a/api/sync.go b/api/sync.go index dec2794..b025608 100644 --- a/api/sync.go +++ b/api/sync.go @@ -1,131 +1,131 @@ package api import ( //"github.com/writeas/writeas-cli/sync" "fmt" "io/ioutil" "os" "path/filepath" "github.com/writeas/writeas-cli/config" "github.com/writeas/writeas-cli/fileutils" "github.com/writeas/writeas-cli/log" cli "gopkg.in/urfave/cli.v1" ) const ( PostFileExt = ".txt" userFilename = "writeas_user" ) func CmdPull(c *cli.Context) error { cfg, err := config.LoadConfig(config.UserDataDir(c.App.ExtraInfo()["configDir"])) if err != nil { return err } // Create posts directory if needed if cfg.Posts.Directory == "" { syncSetUp(c, cfg) } - // Fetch posts - cl, err := NewClient(c, true) + cl, err := newClient(c, true) if err != nil { return err } + // Fetch posts 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)) { log.Info(c, "Creating folder "+collDir) err = os.Mkdir(filepath.Join(cfg.Posts.Directory, collDir), 0755) if err != nil { log.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 { log.Errorln("Error creating file %s: %s", postFilename, err) } log.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 { log.Errorln("Error setting time on %s: %s", postFilename, err) } } return nil } func syncSetUp(c *cli.Context, cfg *config.Config) error { // Get user information and fail early (before we make the user do // anything), if we're going to u, err := config.LoadUser(c) 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 config.Debug() { log.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 = config.SaveConfig(config.UserDataDir(c.App.ExtraInfo()["configDir"]), cfg) if err != nil { if config.Debug() { log.Errorln("Unable to save config: %s", err) } return err } fmt.Println("Saved config.") return nil } diff --git a/api/tor.go b/api/tor.go deleted file mode 100644 index d181b7f..0000000 --- a/api/tor.go +++ /dev/null @@ -1,19 +0,0 @@ -package api - -import ( - "fmt" - "net/http" - - "code.as/core/socks" -) - -var ( - TorPort = 9150 -) - -// TODO: never used? -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/main.go b/cmd/writeas/main.go index d94dfca..6753bc1 100644 --- a/cmd/writeas/main.go +++ b/cmd/writeas/main.go @@ -1,253 +1,275 @@ package main import ( "os" "github.com/writeas/writeas-cli/commands" "github.com/writeas/writeas-cli/config" cli "gopkg.in/urfave/cli.v1" ) func main() { appInfo := map[string]string{ "configDir": configDir, "version": "2.0", } config.DirMustExist(config.UserDataDir(appInfo["configDir"])) cli.VersionFlag = cli.BoolFlag{ Name: "version, V", Usage: "print the version", } // Run the app app := cli.NewApp() app.Name = "writeas" app.Version = appInfo["version"] app.Usage = "Publish text quickly" app.Authors = []cli.Author{ { Name: "Write.as", Email: "hello@write.as", }, } app.ExtraInfo = func() map[string]string { return appInfo } app.Action = commands.CmdPost app.Flags = append(config.PostFlags, flags...) app.Commands = []cli.Command{ { Name: "post", Usage: "Alias for default action: create post from stdin", Action: commands.CmdPost, Flags: config.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 WRITEAS_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: commands.CmdNew, Flags: config.PostFlags, }, { Name: "publish", Usage: "Publish a file to Write.as", Action: commands.CmdPublish, Flags: config.PostFlags, }, { Name: "delete", Usage: "Delete a post", Action: commands.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: commands.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: commands.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: commands.CmdAdd, }, { Name: "posts", Usage: "List all of your posts", - Description: "This will list only local posts when not currently authenticated. To list remote posts as well, first run: writeas auth .", + Description: "This will list only local posts.", Action: commands.CmdListPosts, 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", }, + cli.BoolFlag{ + Name: "verbose, v", + Usage: "Show verbose post listing, including Edit Tokens", + }, }, }, { Name: "blogs", Usage: "List blogs", Action: commands.CmdCollections, 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: "url", Usage: "Show list with URLs", }, }, }, { Name: "claim", Usage: "Claim local unsynced posts", Action: commands.CmdClaim, Description: "This will claim any unsynced posts local to this machine. To see which posts these are run: writeas posts.", 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: commands.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: commands.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) } diff --git a/commands/commands.go b/commands/commands.go index dff931b..2bda8c8 100644 --- a/commands/commands.go +++ b/commands/commands.go @@ -1,343 +1,374 @@ package commands import ( "fmt" "io/ioutil" "os" "text/tabwriter" "github.com/howeyc/gopass" "github.com/writeas/writeas-cli/api" "github.com/writeas/writeas-cli/config" "github.com/writeas/writeas-cli/log" cli "gopkg.in/urfave/cli.v1" ) func CmdPost(c *cli.Context) error { - _, err := api.HandlePost(api.ReadStdIn(), c) + if config.IsTor(c) { + log.Info(c, "Publishing via hidden service...") + } else { + log.Info(c, "Publishing...") + } + + _, err := api.DoPost(c, api.ReadStdIn(), c.String("font"), false, c.Bool("code")) if err != nil { - cli.NewExitError(fmt.Sprintf("Could not post: %v", err), 1) + return cli.NewExitError(err.Error(), 1) } return nil } func CmdNew(c *cli.Context) error { fname, p := api.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) } log.InfolnQuit("Empty post. Bye!") } - _, err := api.HandlePost(*p, c) + if config.IsTor(c) { + log.Info(c, "Publishing via hidden service...") + } else { + log.Info(c, "Publishing...") + } + + _, err := api.DoPost(c, *p, c.String("font"), false, c.Bool("code")) if err != nil { log.Errorln("Error posting: %s\n%s", err, config.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 } - _, err = api.HandlePost(content, c) + + if config.IsTor(c) { + log.Info(c, "Publishing via hidden service...") + } else { + log.Info(c, "Publishing...") + } + _, err = api.DoPost(c, content, c.String("font"), false, c.Bool("code")) + if err != nil { + return cli.NewExitError(err.Error(), 1) + } // TODO: write local file if directory is set - 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, _ := config.LoadUser(c) if token == "" { // Search for the token locally token = api.TokenFromID(c, friendlyID) if token == "" && u == nil { log.Errorln("Couldn't find an edit token locally. Did you create this post here?") log.ErrorlnQuit("If you have an edit token, use: writeas delete %s ", friendlyID) } } - tor := config.IsTor(c) - if c.Int("tor-port") != 0 { - api.TorPort = c.Int("tor-port") - } - if tor { + if config.IsTor(c) { log.Info(c, "Deleting via hidden service...") } else { log.Info(c, "Deleting...") } - err := api.DoDelete(c, friendlyID, token, tor) + err := api.DoDelete(c, friendlyID, token) if err != nil { return cli.NewExitError(fmt.Sprintf("Couldn't delete remote copy: %v", err), 1) } // TODO: Delete local file, if necessary 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, _ := config.LoadUser(c) if token == "" { // Search for the token locally token = api.TokenFromID(c, friendlyID) if token == "" && u == nil { log.Errorln("Couldn't find an edit token locally. Did you create this post here?") log.ErrorlnQuit("If you have an edit token, use: writeas update %s ", friendlyID) } } // Read post body fullPost := api.ReadStdIn() - tor := config.IsTor(c) - if c.Int("tor-port") != 0 { - api.TorPort = c.Int("tor-port") - } - if tor { + if config.IsTor(c) { log.Info(c, "Updating via hidden service...") } else { log.Info(c, "Updating...") } - - return api.DoUpdate(c, fullPost, friendlyID, token, c.String("font"), tor, c.Bool("code")) + err := api.DoUpdate(c, fullPost, friendlyID, token, c.String("font"), c.Bool("code")) + if err != nil { + return cli.NewExitError(fmt.Sprintf("%v", err), 1) + } + return nil } func CmdGet(c *cli.Context) error { friendlyID := c.Args().Get(0) if friendlyID == "" { return cli.NewExitError("usage: writeas get ", 1) } - tor := config.IsTor(c) - if c.Int("tor-port") != 0 { - api.TorPort = c.Int("tor-port") - } - if tor { + if config.IsTor(c) { log.Info(c, "Getting via hidden service...") } else { log.Info(c, "Getting...") } - return api.DoFetch(c, friendlyID, config.UserAgent(c), tor) + err := api.DoFetch(c, friendlyID) + if err != nil { + return cli.NewExitError(fmt.Sprintf("%v", err), 1) + } + return nil } 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 := api.AddPost(c, friendlyID, token) - return err + if err != nil { + return cli.NewExitError(fmt.Sprintf("%v", err), 1) + } + return nil } func CmdListPosts(c *cli.Context) error { urls := c.Bool("url") ids := c.Bool("id") + details := c.Bool("v") - var p api.Post posts := api.GetPosts(c) - tw := tabwriter.NewWriter(os.Stdout, 10, 0, 2, ' ', tabwriter.TabIndent) - numPosts := len(*posts) - if ids || !urls && numPosts != 0 { - fmt.Fprintf(tw, "Local\t%s\t%s\t\n", "ID", "Token") - } else if numPosts != 0 { - fmt.Fprintf(tw, "Local\t%s\t%s\t\n", "URL", "Token") - } else { - fmt.Fprintf(tw, "No local posts found\n") - } - for i := range *posts { - p = (*posts)[numPosts-1-i] - if ids || !urls { - fmt.Fprintf(tw, "unsynced\t%s\t%s\t\n", p.ID, p.EditToken) + + if details { + var p api.Post + tw := tabwriter.NewWriter(os.Stdout, 10, 0, 2, ' ', tabwriter.TabIndent) + numPosts := len(*posts) + if ids || !urls && numPosts != 0 { + fmt.Fprintf(tw, "%s\t%s\t\n", "ID", "Token") + } else if numPosts != 0 { + fmt.Fprintf(tw, "%s\t%s\t\n", "URL", "Token") } else { - fmt.Fprintf(tw, "unsynced\t%s\t%s\t\n", getPostURL(c, p.ID), p.EditToken) + fmt.Fprintf(tw, "No local posts found\n") } - } - u, _ := config.LoadUser(c) - if u != nil { - remotePosts, err := api.GetUserPosts(c) - if err != nil { - fmt.Println(err) - } - - if len(remotePosts) > 0 { - identifier := "URL" + for i := range *posts { + p = (*posts)[numPosts-1-i] if ids || !urls { - identifier = "ID" + fmt.Fprintf(tw, "%s\t%s\t\n", p.ID, p.EditToken) + } else { + fmt.Fprintf(tw, "%s\t%s\t\n", getPostURL(c, p.ID), p.EditToken) } - fmt.Fprintf(tw, "\nAccount\t%s\t%s\t\n", identifier, "Title") } - for _, p := range remotePosts { - identifier := getPostURL(c, p.ID) - if ids || !urls { - identifier = p.ID - } - synced := "unsynced" - if p.Synced { - synced = "synced" - } - fmt.Fprintf(tw, "%s\t%s\t%s\t\n", synced, identifier, p.Title) + return tw.Flush() + } + + for _, p := range *posts { + if ids || !urls { + fmt.Printf("%s\n", p.ID) + } else { + fmt.Printf("%s\n", getPostURL(c, p.ID)) } } - return tw.Flush() + return nil } func getPostURL(c *cli.Context, slug string) string { base := config.WriteasBaseURL if config.IsDev() { base = config.DevBaseURL } ext := "" // Output URL in requested format if c.Bool("md") { ext = ".md" } return fmt.Sprintf("%s/%s%s", base, slug, ext) } func CmdCollections(c *cli.Context) error { u, err := config.LoadUser(c) if err != nil { return cli.NewExitError(fmt.Sprintf("couldn't load config: %v", err), 1) } if u == nil { return cli.NewExitError("You must be authenticated to view collections.\nLog in first with: writeas auth ", 1) } + if config.IsTor(c) { + log.Info(c, "Getting blogs via hidden service...") + } else { + log.Info(c, "Getting blogs...") + } colls, err := api.DoFetchCollections(c) if err != nil { return cli.NewExitError(fmt.Sprintf("Couldn't get collections for user %s: %v", u.User.Username, err), 1) } urls := c.Bool("url") tw := tabwriter.NewWriter(os.Stdout, 8, 0, 2, ' ', tabwriter.TabIndent) detail := "Title" if urls { detail = "URL" } fmt.Fprintf(tw, "%s\t%s\t\n", "Alias", detail) for _, c := range colls { dData := c.Title if urls { dData = c.URL } fmt.Fprintf(tw, "%s\t%s\t\n", c.Alias, dData) } tw.Flush() return nil } func CmdClaim(c *cli.Context) error { u, err := config.LoadUser(c) if err != nil { return cli.NewExitError(fmt.Sprintf("couldn't load config: %v", err), 1) } if u == nil { return cli.NewExitError("You must be authenticated to claim local posts.\nLog in first with: writeas auth ", 1) } localPosts := api.GetPosts(c) if len(*localPosts) == 0 { return nil } - log.Info(c, "Claiming %d post(s) for %s...", len(*localPosts), u.User.Username) + if config.IsTor(c) { + log.Info(c, "Claiming %d post(s) for %s via hidden service...", len(*localPosts), u.User.Username) + } else { + log.Info(c, "Claiming %d post(s) for %s...", len(*localPosts), u.User.Username) + } + results, err := api.ClaimPosts(c, localPosts) if err != nil { return cli.NewExitError(fmt.Sprintf("Failed to claim posts: %v", err), 1) } var okCount, errCount int for _, r := range *results { id := r.ID if id == "" { // No top-level ID, so the claim was successful id = r.Post.ID } status := fmt.Sprintf("Post %s...", id) if r.ErrorMessage != "" { log.Errorln("%serror: %v", status, r.ErrorMessage) errCount++ } else { log.Info(c, "%sOK", status) okCount++ // only delete local if successful api.RemovePost(c, id) } } log.Info(c, "%d claimed, %d failed", okCount, errCount) return nil } func CmdAuth(c *cli.Context) error { // Check configuration u, err := config.LoadUser(c) 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 // TODO: after global config, check for default user 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) } + + if config.IsTor(c) { + log.Info(c, "Logging in via hidden service...") + } else { + log.Info(c, "Logging in...") + } err = api.DoLogIn(c, username, string(pass)) if err != nil { return cli.NewExitError(fmt.Sprintf("error logging in: %v", err), 1) } return nil } func CmdLogOut(c *cli.Context) error { - return api.DoLogOut(c) + if config.IsTor(c) { + log.Info(c, "Logging out via hidden service...") + } else { + log.Info(c, "Logging out...") + } + err := api.DoLogOut(c) + if err != nil { + return cli.NewExitError(fmt.Sprintf("error logging out: %v", err), 1) + } + return nil } diff --git a/config/options.go b/config/options.go index aed4c9a..fc7813f 100644 --- a/config/options.go +++ b/config/options.go @@ -1,84 +1,92 @@ package config import ( "net/url" "github.com/cloudfoundry/jibber_jabber" "github.com/writeas/writeas-cli/log" cli "gopkg.in/urfave/cli.v1" ) // Application constants. const ( defaultUserAgent = "writeas-cli v" // Defaults for posts on Write.as. DefaultFont = PostFontMono WriteasBaseURL = "https://write.as" DevBaseURL = "https://development.write.as" TorBaseURL = "http://writeas7pm7rcdqg.onion" + torPort = 9150 ) func UserAgent(c *cli.Context) string { ua := c.String("user-agent") if ua == "" { return defaultUserAgent + c.App.ExtraInfo()["version"] } return ua + " (" + defaultUserAgent + c.App.ExtraInfo()["version"] + ")" } func IsTor(c *cli.Context) bool { return c.Bool("tor") || c.Bool("t") } +func TorPort(c *cli.Context) int { + if c.IsSet("tor-port") && c.Int("tor-port") != 0 { + return c.Int("tor-port") + } + return torPort +} + 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 { log.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 } u, _ := LoadUser(c) if u != nil { return u.User.Username } return "" } // HostDirectory returns the sub directory string for the host. Order of // precedence is a host flag if any, then the configured default, if any func HostDirectory(c *cli.Context) (string, error) { cfg, err := LoadConfig(UserDataDir(c.App.ExtraInfo()["configDir"])) if err != nil { return "", err } // flag takes precedence over defaults if hostFlag := c.GlobalString("host"); hostFlag != "" { u, err := url.Parse(hostFlag) if err != nil { return "", err } return u.Hostname(), nil } u, err := url.Parse(cfg.Default.Host) if err != nil { return "", err } return u.Hostname(), nil }