On an intranet project, I need to track all downloads from S3. All users are logged in to access the files and I need to track who downloads what. AWS S3 has a logging feature where I only miss the name of the user. When accessing a file you can add parameters to the url that are ignored by S3 but are logged (see there).
So I added some code to the getExternalUrl() function to push these parameters to AWS. The custom parameters can be inserted by implementing the s3fs_url_settings hook like this:
function mymodule_s3fs_url_settings_alter(&$url_settings, $uri) {
$url_settings['custom'] = array(
'user' => 'my_username'
);
}
This parameter will be appended to the url as as x-user=my_username. This implementation is very generic and can be used for any custom parameter that needs to be passed to AWS S3 log.
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | s3fs-add_custom_GET_arguments-2566391-5.patch | 3.79 KB | coredumperror |
| add_custom_parameters.diff | 1.06 KB | captone |
Comments
Comment #2
captone commentedComment #3
coredumperror commentedSounds like a useful enough feature. I'll go ahead and add it into the next dev build.
Be wary, though: if you're storing the username in the URL like that, page caching will break the logging, as only the first user to load the page will have their username appear in the URL. Every subsequent user will see the exact same URL as the first user does, until the page's cache entry gets reset.
Comment #4
coredumperror commentedAlright, here's my take on your feature request. I generalized it even further, to allow any custom GET argument. And since there are now three places in the code adding optional GET args to the S3 URLs, I refactored them into a function.
Note that you now need to include the "x-" in your hook code, since s3fs won't add it for you.
If this works for you, please let me know so I can push it to git and add it to the dev build.
Comment #5
coredumperror commentedWhoops, that patch has the wrong file paths in it. Here's the corrected patch.
Comment #6
captone commentedThanks for reworking the idea and building cache safe code. It works fine.
I simply wonder if it's reasonnable to accept any parameter instead of forcing the 'x-' prefix. AWS S3 REST interface is not defined as accepting any parameter, so it may break in the future.
Comment #7
coredumperror commentedI made it completely generic so that some other enterprising module author could add support for something that s3fs doesn't currently support. There are plenty of other GET args that can be added to S3 URLs which s3fs doesn't use.