add a show-caps command #1873

New issue

Open

opened 2012-11-21 18:41:38 +00:00 by igor · 15 comments

igor commented

2012-11-21 18:41:38 +00:00

Owner

I wanted a way to get the readcap of a directory created with tahoe create-alias without having to resort to the welcome page.
zooko suggested tahoe debug dump-cap and some hand-crafting, which is doable but quite ugly.

Here is a patch against current master to add a tahoe show-caps command which will list whatever capabilities the GET?t=json API gives.

Because I have only superficial knowledge of the software architecture and given that tahoe_showcaps.py is pretty much a modified version of tahoe_ls.py, feel free to criticize and suggest.

I wanted a way to get the readcap of a directory created with `tahoe create-alias` without having to resort to the welcome page. zooko suggested `tahoe debug dump-cap` and some hand-crafting, which is doable but quite ugly. Here is a patch against current master to add a `tahoe show-caps` command which will list whatever capabilities the GET?t=json API gives. Because I have only superficial knowledge of the software architecture and given that tahoe_showcaps.py is pretty much a modified version of tahoe_ls.py, feel free to criticize and suggest.

tahoe-lafs added the

c/unknown

p/normal

t/enhancement

labels 2012-11-21 18:41:38 +00:00

tahoe-lafs added this to the undecided milestone 2012-11-21 18:41:38 +00:00

daira was assigned by tahoe-lafs

2012-11-21 18:41:38 +00:00

igor commented

2012-11-21 18:42:10 +00:00

Author

Owner

Attachment 0001-Add-a-show-caps-command-to-the-CLI.patch (4436 bytes) added

**Attachment** 0001-Add-a-show-caps-command-to-the-CLI.patch (4436 bytes) added

0001-Add-a-show-caps-command-to-the-CLI.patch

4.3 KiB

daira commented

2012-11-22 00:58:23 +00:00

tahoe ls already has --uri and --readonly-uri options. Would adding an option to print the verify cap satisfy your requirement, or is the issue that tahoe ls for a directory will only display caps of children, not the directory itself?

`tahoe ls` already has `--uri` and `--readonly-uri` options. Would adding an option to print the verify cap satisfy your requirement, or is the issue that `tahoe ls` for a directory will only display caps of children, not the directory itself?

daira added

c/code-frontend-cli

v/1.9.2

and removed

c/unknown

labels 2012-11-22 00:59:13 +00:00

zooko commented

2012-11-22 01:45:59 +00:00

Replying to davidsarah:

tahoe ls already has --uri and --readonly-uri options. Would adding an option to print the verify cap satisfy your requirement, or is the issue that tahoe ls for a directory will only display caps of children, not the directory itself?

Speaking for myself, not for igor, that wouldn't suffice, because I sometimes want to diminish a cap that I have that is not the child of any directory.

Replying to [davidsarah](/tahoe-lafs/trac/issues/1873#issuecomment-391941): > `tahoe ls` already has `--uri` and `--readonly-uri` options. Would adding an option to print the verify cap satisfy your requirement, or is the issue that `tahoe ls` for a directory will only display caps of children, not the directory itself? Speaking for myself, not for igor, that wouldn't suffice, because I sometimes want to diminish a cap that I have that is not the child of any directory.

igor commented

2012-11-22 02:11:45 +00:00

Author

Owner

Replying to davidsarah:

tahoe ls already has --uri and --readonly-uri options. Would adding an option to print the verify cap satisfy your requirement, or is the issue that tahoe ls for a directory will only display caps of children, not the directory itself?

Yes, it will only display caps of children.

igor commented

2012-11-22 02:13:02 +00:00

Author

Owner

Also, there is a question in tahoe_showcaps.py:46. I was not sure if that check was still necessary when copying things from tahoe_ls.py.

daira commented

2012-11-22 07:20:22 +00:00

Replying to [zooko]comment:3:

Replying to davidsarah:

tahoe ls already has --uri and --readonly-uri options. Would adding an option to print the verify cap satisfy your requirement, or is the issue that tahoe ls for a directory will only display caps of children, not the directory itself?

Speaking for myself, not for igor, that wouldn't suffice, because I sometimes want to diminish a cap that I have that is not the child of any directory.

If it's a mutable file writecap, then tahoe ls --readonly-uri $CAP will do that. It's just for directory writecaps that tahoe ls will only display the children.

Replying to [zooko]comment:3: > Replying to [davidsarah](/tahoe-lafs/trac/issues/1873#issuecomment-391941): > > `tahoe ls` already has `--uri` and `--readonly-uri` options. Would adding an option to print the verify cap satisfy your requirement, or is the issue that `tahoe ls` for a directory will only display caps of children, not the directory itself? > > Speaking for myself, not for igor, that wouldn't suffice, because I sometimes want to diminish a cap that I have that is not the child of any directory. If it's a mutable file writecap, then `tahoe ls --readonly-uri $CAP` will do that. It's just for directory writecaps that `tahoe ls` will only display the children.

daira commented

2012-11-22 07:21:15 +00:00

Replying to igor:

Also, there is a question in tahoe_showcaps.py:46. I was not sure if that check was still necessary when copying things from tahoe_ls.py.

It's still necessary.

Replying to [igor](/tahoe-lafs/trac/issues/1873#issuecomment-391947): > Also, there is a question in tahoe_showcaps.py:46. I was not sure if that check was still necessary when copying things from tahoe_ls.py. It's still necessary.

zooko commented

2013-01-22 10:57:39 +00:00

There is a patch attached to this ticket! (Thanks, igor.) So, should this ticket be in the review-needed state? Adding the review-needed tag. Someone please review this patch (per wiki/PatchReviewProcess) and update this ticket!

There is a patch attached to this ticket! (Thanks, igor.) So, should this ticket be in the `review-needed` state? Adding the `review-needed` tag. Someone please review this patch (per [wiki/PatchReviewProcess](wiki/PatchReviewProcess)) and update this ticket!

daira commented

2013-03-01 02:38:02 +00:00

My argument was that this should be functionality of tahoe ls rather than a separate command, and I pointed out the existing --uri and --readonly-uri options.

Zooko in comment:3 asked for the ability to diminish a cap that is not the child of any directory, but I pointed out in comment:6 that tahoe ls --readonly-uri $CAP already does this, except for the case of wanting to diminish a writecap to a directory. So, perhaps tahoe ls --readonly-uri $DIRCAP should print the directory readcap as well as listing the children?

My argument was that this should be functionality of `tahoe ls` rather than a separate command, and I pointed out the existing `--uri` and `--readonly-uri` options. Zooko in comment:3 asked for the ability to diminish a cap that is not the child of any directory, but I pointed out in comment:6 that `tahoe ls --readonly-uri $CAP` already does this, *except* for the case of wanting to diminish a writecap to a directory. So, perhaps `tahoe ls --readonly-uri $DIRCAP` should print the directory readcap as well as listing the children?

zooko commented

2013-03-11 05:08:26 +00:00

Replying to davidsarah:

My argument was that this should be functionality of tahoe ls rather than a separate command, and I pointed out the existing --uri and --readonly-uri options.

Zooko in comment:3 asked for the ability to diminish a cap that is not the child of any directory, but I pointed out in comment:6 that tahoe ls --readonly-uri $CAP already does this, except for the case of wanting to diminish a writecap to a directory. So, perhaps tahoe ls --readonly-uri $DIRCAP should print the directory readcap as well as listing the children?

Okay I was confused about this until now. Is it fair to say that the argument to ls is a "rooted path" (ref #1732), which can denote either a file or a directory, and ls shows some facts about the thing (such as the filesize if it is the file, or the names and facts about its children if it is a directory), and with the --uri option it also shows the cap to the thing, and with the --readonly-uri it also shows the read-only cap to the thing?

Okay, that makes sense now. +1

So now this patch is insufficient because in the current version of this patch, it won't show the cap if the rooted path denotes a directory. Is that true?

Removing the "review-needed" tag.

Igor: are you willing to extend this patch so it will show the caps of directories as well? Assigning to Igor.

Replying to [davidsarah](/tahoe-lafs/trac/issues/1873#issuecomment-391951): > My argument was that this should be functionality of `tahoe ls` rather than a separate command, and I pointed out the existing `--uri` and `--readonly-uri` options. > > Zooko in comment:3 asked for the ability to diminish a cap that is not the child of any directory, but I pointed out in comment:6 that `tahoe ls --readonly-uri $CAP` already does this, *except* for the case of wanting to diminish a writecap to a directory. So, perhaps `tahoe ls --readonly-uri $DIRCAP` should print the directory readcap as well as listing the children? Okay I was confused about this until now. Is it fair to say that the argument to `ls` is a "rooted path" (ref #1732), which can denote either a file or a directory, and `ls` shows some facts about the thing (such as the filesize if it is the file, or the names and facts about its children if it is a directory), and with the `--uri` option it *also* shows the cap to the thing, and with the `--readonly-uri` it *also* shows the read-only cap to the thing? Okay, that makes sense now. +1 So now this patch is insufficient because in the current version of this patch, it won't show the cap if the rooted path denotes a directory. Is that true? Removing the "review-needed" tag. Igor: are you willing to extend this patch so it will show the caps of directories as well? Assigning to Igor.

zooko commented

2013-03-11 05:09:05 +00:00

This is almost ready so I'm putting it in the "1.11.0" Milestone.

zooko modified the milestone from undecided to 1.11.0

2013-03-11 05:09:05 +00:00

igor commented

2013-03-12 04:05:57 +00:00

Author

Owner

Replying to [zooko]comment:10:

Igor: are you willing to extend this patch so it will show the caps of directories as well? Assigning to Igor.

I think there is some misunderstanding (and it may very well be on my part), so could you explain what is missing in the following output?

http://www.sebsauvage.net/paste/?0dee6b6fcea97009#9W96Pdr8NFqqF3Ubkon2tDp8Dy659GLeG3nDgCF8SO8=

My motivation for the patch was simply to have the CLI mimic the 'More info' webpage, and to me it seems it would add too much clutter to the listing done by tahoe ls.

Replying to [zooko]comment:10: > Igor: are you willing to extend this patch so it will show the caps of directories as well? Assigning to Igor. I think there is some misunderstanding (and it may very well be on my part), so could you explain what is missing in the following output? <http://www.sebsauvage.net/paste/?0dee6b6fcea97009#9W96Pdr8NFqqF3Ubkon2tDp8Dy659GLeG3nDgCF8SO8>= My motivation for the patch was simply to have the CLI mimic the 'More info' webpage, and to me it seems it would add too much clutter to the listing done by `tahoe ls`.

daira commented

2013-03-15 05:27:38 +00:00

Replying to [zooko]comment:10:

So now this patch is insufficient because in the current version of this patch, it won't show the cap if the rooted path denotes a directory. Is that true?

No. The patch adds a new tahoe show-caps command; I was arguing that that wasn't needed because tahoe ls can almost do the same thing.

Replying to [zooko]comment:10: > So now this patch is insufficient because in the current version of this patch, it won't show the cap if the rooted path denotes a directory. Is that true? No. The patch adds a *new* `tahoe show-caps` command; I was arguing that that wasn't needed because `tahoe ls` can almost do the same thing.

daira commented

2013-03-15 05:28:38 +00:00

... and if we were going to add a show-caps command, its implementation should probably share more code with some existing command.

igor commented

2013-03-17 18:06:51 +00:00

Author

Owner

How about the following 'cap listing mode' for tahoe ls?

$ tahoe ls --show-caps teste:

.:
rw_uri URI:DIR2:cmpj4sqyw5w67cwozpuxy5mjva:idcbiymnzp3dvn6tweva6anzzppl5ryjh7qzdydwmxx3qx3r7lda
ro_uri URI:DIR2-RO:z2dt53oudwthl6l7sf3qrqtgba:idcbiymnzp3dvn6tweva6anzzppl5ryjh7qzdydwmxx3qx3r7lda
verify_uri URI:DIR2-Verifier:tphasacmnjmtdnkgq74i4xmujm:idcbiymnzp3dvn6tweva6anzzppl5ryjh7qzdydwmxx3qx3r7lda

node.url:
ro_uri URI:LIT:nb2hi4b2f4xtcmrxfyyc4mboge5dgnbvgyxqu

daew.xls:
rw_uri URI:SSK:kejpnuetpuc3j2rmtjpwuwwqz4:mhj6t63hv2s6pgjxmp6oceencmp4265jbqegxfuq4koc4lpxujkq
ro_uri URI:SSK-RO:5ksx7c3xhix52yqnipd2yotoue:mhj6t63hv2s6pgjxmp6oceencmp4265jbqegxfuq4koc4lpxujkq
verify_uri URI:SSK-Verifier:sln55mmxjm6p2woafl5i3iojvi:mhj6t63hv2s6pgjxmp6oceencmp4265jbqegxfuq4koc4lpxujkq

Though this could be cumbersome if all you want is the directory's caps and it happens to have too many children.

How about the following 'cap listing mode' for `tahoe ls`? ``` $ tahoe ls --show-caps teste: .: rw_uri URI:DIR2:cmpj4sqyw5w67cwozpuxy5mjva:idcbiymnzp3dvn6tweva6anzzppl5ryjh7qzdydwmxx3qx3r7lda ro_uri URI:DIR2-RO:z2dt53oudwthl6l7sf3qrqtgba:idcbiymnzp3dvn6tweva6anzzppl5ryjh7qzdydwmxx3qx3r7lda verify_uri URI:DIR2-Verifier:tphasacmnjmtdnkgq74i4xmujm:idcbiymnzp3dvn6tweva6anzzppl5ryjh7qzdydwmxx3qx3r7lda node.url: ro_uri URI:LIT:nb2hi4b2f4xtcmrxfyyc4mboge5dgnbvgyxqu daew.xls: rw_uri URI:SSK:kejpnuetpuc3j2rmtjpwuwwqz4:mhj6t63hv2s6pgjxmp6oceencmp4265jbqegxfuq4koc4lpxujkq ro_uri URI:SSK-RO:5ksx7c3xhix52yqnipd2yotoue:mhj6t63hv2s6pgjxmp6oceencmp4265jbqegxfuq4koc4lpxujkq verify_uri URI:SSK-Verifier:sln55mmxjm6p2woafl5i3iojvi:mhj6t63hv2s6pgjxmp6oceencmp4265jbqegxfuq4koc4lpxujkq ``` Though this could be cumbersome if all you want is the directory's caps and it happens to have too many children.