dshoreman / nextshot Goto Github PK

If yad isn't available and there's no config file, NextShot should generate one automatically after prompting the user. Once created, it should then open it for editing in the default editor.

Something like this:

if $userSaidYes; then
    echo "$theConfig" > "$_CONFIG_FILE" && $EDITOR "$_CONFIG_FILE"
else
    exit 1
fi

They're much more configurable than ImageMagick's import command, and they look nicer.

Should also fix issues where sometimes the selection lines glitch out and end up part of the screenshot.

While storing screenshots temporarily at /tmp/nextshot.png isn't an issue as such, it doesn't provide any redundancy if anything ever went wrong.

Store images in $XDG_CACHE_HOME/nextshot instead. Preferably using the "real" saved filename, although this might need a rename after the zenity dialog has been displayed. Unless files are named by date (#2), in which case it can be written directly to its actual name without need for mv after.

Goes without saying, really. We don't want to be blindly uploading a massive .tar.gz (for example) and disguising it as a png when it's clearly not.

At least until the main pipeline's been rewritten for better error handling, it'd be best to add the check within parse_opts(). We can use file --mime-type <FILEPATH> to check. Add the -b flag and it'll suppress the filename too, which we don't particularly need.

While Yad works for setting a custom filename, it shouldn't be required if Nextshot is being run directly in a terminal window.

Code to detect whether or not we're in a terminal will be required for #42, so build on that and use read -p instead of Yad when Nextshot is called interactively.

In Wayland, nextshot -w works great when you're running it from a terminal, but not so much if it's bound to a keyboard shortcut.

Figure out some way to detect when running from a terminal so that we can offer an alternative (likely via Yad).

If Nextshot is started from ~/.xinitrc or with an exec line in the i3 config, the icon uses Yad's default:

Quitting the menu and manually running nextshot -t in a terminal will fix it, but only until logout/reboot.

If you run nextshot -p to paste from clipboard, it calls check_clipboard to check there's an image to paste.

This function relies on is_wayland which is only set in parse_environment after options are parsed. This is a problem here because check_clipboard is called during arg-parsing, thus NEXTSHOT_ENV isn't set yet (if autodetection is being relied on).

Nextshot will not work correctly on Nextcloud instances without pretty URLs. For example - enabling these short URLs is still not possible on snap Nextcloud installations. Right now Nextshot use share links like this:
https://example.org/s/string

Without pretty URLs we need also "index.php" in URL, so like this:
https://example.org/index.php/s/string

For now, I just slightly changed the part of the script responsible for the URL, but it would be great if option for change this were also in the configuration. :)

Currently NextShot only checks for the existence of the config file. As long as it's there, it could be completely empty and NextShot will happily try to run with it.

Add checks using parameter substitution with error messages to make sure required options are indeed set before attempting to do anything else.

Tray menu works great in i3, less so on Sway. That is, nothing shows up at all.

Menus aren't supported just yet but theoretically tray icons by themselves should work.

Possible Causes

• Yad may or may not use KDE's SNI interface which Sway implements
• I haven't configured my Sway correctly:
  
  

Worth Trying

• Waybar which has a beta Tray module

Running on Wayland results in attempting to copy via xclip.

The is_wayland() check returns 1 when it's not Wayland, but fails to return anything when it is. As a result, even on a Wayland machine the script thinks it's running on X11.

When uploading an image that already exists in Nextcloud, either by renaming a screenshot or by using the --file option, Nextcloud returns a 204 response code.

Need to do some more testing to see whether this overwrites or simply fails without doing anything. If it does overwrite it could simply be a matter of adding 204 to the checked responses and sharing anyway.

If it fails, we should rename the file (e.g. append -1, -2 etc.) and retry. That said, it may be better to check if the file exists first and automatically rename regardless of whether it overwrites or not.

While NextShot is able to copy share links via wl-copy, it is highly likely that import is either only capable of capturing XWayland windows or simply won't work at all.

We'd probably need to use a different tool depending on the WM/DE being used, because each compositor has their own way of doing things. Or so I gather...

• For GNOME(-Shell), there's gnome-screenshot.
• Sway used to have swaygrab built in, but that got removed. The wiki suggests using grim.
• For Sway, slurp can replace slop/maim. gnome-screenshot has the -a flag to select an area

Now that #50 is fixed so that duplicate uploads return a link, we could really do with a way of preventing Nextshot from overwriting existing files.

Nextcloud automatically overwrites, so we would need to ping the webdav API prior to sending the upload request. If a file exists with the same name, the user should be able to decide how to proceed.

Rename/overwrite/abort prompt is taken care of with #83, leaving only config/runtime args:

Config Option

There should be an option in nextshot.conf to define the default behaviour.
Something like overwrite=<action> could work, with possible values of:

• overwrite=always - overwrite automatically without asking (previous behaviour)
• overwrite=append - automatically append iterator/timestamp to the filename
• overwrite=rename - never overwrite, ask for a new filename each time
• overwrite=prompt - ask whether to overwrite or rename at runtime (current behaviour)
• overwrite=cancel - always abort the upload(?)

The best option to set by default if the config isn't set would probably be prompt. The idea of Nextshot is to minimise interaction though, so perhaps always would be the better default here.

Runtime Args

While a config option should cover most cases, there should also be ways of overriding it on a case-by-case basis.

• --no-overwrite would be useful if config is set to always
• --overwrite could likewise be handy for bypassing prompts occasionally

How useful these would be though is questionable. Maybe skip them unless someone really wants it - the config option is still better than always overwriting without any choice in the matter.

Caveats

• Appending to the filename automatically is good in theory, but in practice it's not so easy to implement. Extra care would need to be taken to avoid somefile-1-1-1-1-1.png or bumping to somefile-2.png only to find that also exists. Possibly leave this option for a later release.
• Aborting upload really isn't the most useful option, so that can probably be ignored.

Output a list of dependencies and whether or not they're installed, similar to :call phpactor#Status() in vim. Option should be something like --status or --deps.

It could also show output of $(nextshot --version), but dependencies should be limited to the detected environment. In other words, don't show Wayland deps if X is detected, and vice versa.

Example Output

Current version: NextShot v1.2.3
Detected environment: Wayland

Dependencies
------------
✔ curl
✘ grim
✔ jq
✔ slurp
✔ wl-clipboard
✘ yad (optional)

Add a --clipboard option to enable uploading to Nextcloud directly from the system clipboard. Would likely use xclip -selection c -o for X11, or wl-paste (provided by wl-clipboard) for Wayland.

Would be even better if we could simply use STDIN:

# On X11
alias pbpaste="xclip -selection c -o"
pbpaste | nextshot

# On Wayland
wl-paste | nextshot

If the entered filename is not ending in dot+format (so .png by default), the ext should be appended, because unrecognized images will not get displayed in the webview, nor do they get a preview (/preview in this case just renders []).

PR incoming...

We can use Yad's --notification option to add a tray icon, in conjunction with --listen in order to send menu items to its STDIN.

For the icon itself, the easiest option would be camera-photo-symbolic. While a png could be used, I'm not the most decisive person in the world so picking one is easier said than done. camera-photo is the same icon, but in "wireframe" format so it doesn't really show that well on a dark background.

The menu should contain at least the following options:

• Capture selection
• Capture window
• Capture full screen

It could also be nice to have a menu item that opens the target folder in Nextcloud's files app using the default browser (xdg-open). Example link would be $server/apps/files/?dir=/$savedir

Nextcloud offers a /preview suffix on URLs which loads the raw image in the browser without any JS/UI cruft. Nextshot should have an option that appends this automatically for faster pasting.

Gotta make them configurable somehow.

Probably enough to add a selectColour option to config and use that in place of the current hard-coded values.

$ nextshot -ac
Waiting for selection...
Copying image to clipboard...
xclip: -t: No such file or directory

Aborted due to error

Manjaro KDE

what could be the problem?

Could also affect other GUI file managers, no idea.

When you copy an image in Nautilus/GNOME Files, the result of xclip -selection c -o is something like this:

x-special/nautilus-clipboard
copy
file:///run/media/dshoreman/data/pictures/foo.jpg

To be able to paste from Nautilus we'd need some way of detecting and parsing that syntax. xclip doesn't seem to offer any image targets, and none of the given options are obviously distinct:

$ xclip -selection clipboard -o -t TARGETS
TIMESTAMP
TARGETS
MULTIPLE
text/uri-list
UTF8_STRING
COMPOUND_TEXT
TEXT
STRING
text/plain;charset=utf-8
text/plain

We really need to add arrows to the screenshot. Also, when creating a menu, fill or copy to the clipboard

Originally part of #5, most of which was added for 0.2.

Currently we can only capture the entire display. We could select one screen in --selection mode, but that's prone to errors. We should add an argument such as --only OUTPUT to enable specifying the output.

May be able to query Xrandr to get the screen's dimensions and offset in order to crop the full screen image, but that doesn't help with identifying the active output. Nor does it help in Wayland.

While a window can currently be captured by clicking instead of dragging in --selection mode, the slightest movement could result in a selection screenshot.

Once we're using slop (#10) we'll be able to (and should) add a separate window mode. I forget the flag, but it has the option to set a tolerance of the drag to the point where it's essentially disabled.

If you fill out the Yad config form and get to the confirmation, there's no way to cancel. Even if you press escape, config will be written by NextShot.

Instead, output should be saved to a variable so that the exit status can be checked and NextShot can bail if needed. Much like the initial config form.

The current $WAYLAND_DISPLAY check should work in most cases, there is at least one where it will fail.

If you attempt to start Nextshot from within a tmux session that was started in X, the WAYLAND_DISPLAY environment variable will not be set regardless of whether you're currently using X or Wayland.

It may be possible to check the output of tty (which will either be /dev/ttyX or /dev/pts/X), but there's a good chance that could have the same issues as the env var.

Currently the --file mode checks for the given file relative to $PWD. This is fine when the image is in the same directory, and probably even up a level or two.

However, issues start to arise when passing root-relative paths or paths that go via a symlink. For instance, the following fails:

nextshot --file ~/pictures/kitten.jpg

because it's looking for /home/$USER/pictures/kitten.jpg when actually pictures is a symlink to /var/run/media/$USER/data/pictures.

This could either be a runtime argument or an option in the config file.

Runtime would make more sense, but it might also be a good idea to have an option for setting the default in config. This could then be overridden by the runtime argument.

It would be nice if you could use NextShot to upload an existing image/screenshot:

# Upload existing file
nextshot -f ~/Pictures/kittens.png
nextshot --file ~/Pictures/memes/doge.jpg

Add an option (as default?) to have names auto-generated, eg by date

Hello,

I can't take a screenshot of an area or window if the numeric location isn't set to en_US.UTF-8 because BC doesn't seem to be able to do the calculation in a correct way:

$ nextshot -t
/usr/bin/nextshot: Line 343: printf: 1.00000000000000000000: Invalid Number.
/usr/bin/nextshot: Line 343: printf: .39215686274509803921: Invalid Number.
/usr/bin/nextshot: Line 343: printf: .70588235294117647058: Invalid Number.
Starting Nextshot tray menu...

If I start Nextshot using LC_NUMERIC="en_US.UTF-8" /usr/bin/nextshot -t everything works perfectly fine.

Where Slop takes one colour option, Slurp takes three and they're in a different format too.

Slop uses decimal RGBA whereas Slurp uses Hex, so we'll need to add some translation layer (or duplicate the config option) to allow for a different selection colour in Wayland.

While not documented in slurp -h, Slurp has the following defaults:

    RRGGBBAA
-b #FFFFFF40    Background colour
-c #000000FF    Border colour
-s #00000000    Selection colour

Hey,

if you could change the filename convention to:

filename="$(date "+%Y-%m-%d-%H-%M-%S").png"

by default, it would prevent issues caused by the backspace while uploading to NextCloud.

Kind regards,

vanBonzen

To capture screenshots with context menus etc we need to add a delay. An option in config might be nice to have, but probably unnecessary.

For now, we can just add a --delay argument that takes an integer (or maybe decimal) value, defaulting to 0. Then we can do something like

sleep $(( delay * 1000 )); import ...

I tried to take a screenshot but got "jq not found". Installing it fixes the error but it doesnt show in --deps

Would be nice if - instead of just getting the link - you could avoid Nextcloud and copy the screenshot directly to clipboard instead.

Useful for pasting in chat apps like Telegram, Twitter etc or even sites like StackOverflow that have "paste to upload image" functionality.

All it takes is adding -t image/png to the copy command so that xclip knows it's an image, but we'll also need an extra runtime arg to toggle between copying the link or image.

Currently it can only capture a selected area using import from ImageMagick. It would be much nicer if it could capture the full screen or a selected window - similar to shotty but without the UI to get in the way.

Perhaps add command line flags to set the mode, eg:

• --selection to select an area (current default)
• --window to capture a selected window (implicitly supported by import)
• --full-screen to capture all displays
• --only-screen <display> to capture the entire output of a single monitor

Not sure if the last one is even possible, but it'd be nice.

It's bad. Very bad. No idea if Nextcloud has an API Key of sorts.

At the very least, README should suggest creating/using an App Password (/settings/user/security) instead of the real account one.

$ nextshot -t
Starting Nextshot tray menu...
$ Waiting for selection...
/usr/bin/nextshot: строка 621: slop: команда не найдена

Aborted due to error

The error occurs when you are asked to take a screenshot

Not everybody uses Nextcloud. If the respective config options aren't specified, we should default to -c, --clipboard mode so that getting started is easier.

This will likely require a slight reworking of the Yad config UI, or at the very least some added text stating that it's safe to leave certain things blank.

In an ideal world, you should be prompted as to whether you have or want to use Nextcloud before even given the option to configure it. That will also affect more generic options though (such as rename, which is currently the only one).

When running NextShot through a keybind, it's impossible to know when the link is ready to be pasted.

Notifications should be added through libnotify. A simple "Link copied to clipboard" should be enough.

Could probably use the insert-link icon from the spec, but will need to try it out first as there are no examples given.

Related

• Notifications Spec
• Icon Naming Spec

NextShot uses some expansions and other syntax (such as ${rename,,} to lowercase the boolean rename option) that is only available as of Bash v4.

You'd think most systems would be on Bash 4 already, but it might not always be the case. For instance OSX - while not (yet) supported by NextShot - is still running v3 out of the box.

If we detect a system running Bash < 4, NextShot should exit with an error message stating that fact.

...but it does have some formatting options. Gotta play about with some colours and see what makes it stand out. In particular, the window mode's selection border could be made much more obvious as the default is rather faint.

Instead of --file etc, it'd be nice to have short versions like -f for added flexibility.

Should make use of getopt[s] which will also make it easier to add extra options later on.

If you kill the script with ^C during the upload to Nextcloud, it only exits that function.

Instead of NextShot exiting entirely, it continues to attempt sharing even though there's nothing there to share.

To fix this, we need to rework the main pipeline which will also make it easier to abort at other stages earlier in the process.

There's no handling for --window in the shoot_wayland function, so it's currently defaulting to full screen.

There's no support for window selection in Slurp, but that could soon change if emersion/slurp#28 gets merged. Even then, it doesn't seem there'll be a way of specifically requiring "click" vs "drag" (like Slop's --tolerance 999999) in order to support dedicated window/selection modes in NextShot.

Falling back to --selection mode (as it did for X before --window was supported) isn't the best idea, as Slurp will exit if a user simply clicks in a window. Until Slurp gets window support, it may be worth seeing if we can parse a list of windows from swaymsg instead.

When running import from an interactive terminal, it can be aborted the usual way (i.e. ^C) just fine.

That doesn't work when it's running in the background though, such as when it's triggered by a keybinding in i3wm. As a result, you must take a screenshot once triggered, which isn't ideal if you hit it too soon.

Will either need to find another way of selecting an area of the screen, or simply prompt to confirm/retry before uploading to Nextcloud. A preview window could also be useful, but probably not necessary.

Move it to ~/.config