CUNY Academic Commons

Does "folder" mean the folderish tags that appear in the Files subsection of a group?

Dom, will you look into this? A link that assembles a zip file on the fly from the files currently displayed, and forces a download for the user.

Dom, can you please give us an update on this by next Friday, May 2? Thank you

Reassigning this over to Dan for the time being. Dan, the plugin that we use for group files is wp-content/plugins/buddypress-group-documents. That plugin is an old fork of an abandoned plugin. So, when you're exploring how to do this, if you need to make mods to the plugin itself, you may. Though, in general, we do try to avoid that; it's likely that for this kind of standalone functionality, you'll be able to manage with a couple of add_action() calls. For these kinds of things, check out the file wp-content/plugins/cac-bp-custom-includes/group-documents.php, where there are other miscellaneous mods to the way the plugin works.

Basically, your strategy will be http://redmine.gc.cuny.edu/issues/2757#note-3. More specifically, you'll probably need two different functions:

1. Something that creates the necessary markup for the link in the interface. Use whatever format for the link you want; something like <a href="http://commons.gc.cuny.edu/groups/groupname/files?download=all"> makes sense to me (use bp_get_group_permalink() to get a group URL dynamically).
2. A request catcher. I suggest the following format. Hooking to the 'bp_actions' hook will let you send content to the browser (ie, the zip file) before WP sends any other headers.

function cac_group_files_download_all_request() {
    // Make sure that this is a download=all request
    if ( empty( $_GET['download'] ) || 'all' !== $_GET['download'] ) {
        return;
    }

    // Probably also wise to do a permissions check - make sure the user is a member of the group for non-public groups
    // A nonce check is probably also a good idea. 
    // do your magic - Check out http://davidwalsh.name/create-zip-php for a simple tutorial on creating zips, and check out the buddypress-group-documents source to see how to pull up a list of documents for the group
}
add_action( 'bp_actions', 'cac_group_files_download_all_request' );

Hopefully that's enough to get you started. Please let me know if you hit snags or need more direction.

Thanks, Dan! This is looking great.

I've pulled the changes to cdev for testing. Chris, please have a look at button placement here: http://cdev.gc.cuny.edu/groups/cac-community-team-project-planning/documents/ Let me know whether you think this is the right UI for the job. (Never mind the fact that the zip doesn't contain all the files - the group document directory on cdev is out of date, and I'm having a hard time running an update script at the moment because of permissions issues).

The placement is OK but I overlooked it at first. A couple of suggestions that could be made independently or together:

1. Icons
Now that we have more than one button it would be nice to do something to visually separate them. Up and down arrow icons seem appropriate. I don't know if we have these in our current icon set (do we have a defined set?). I'm attaching a couple of examples (file names with arrow or icon).

2. Change Placement
Another idea is to move the download button to where we say how many files there are. On a related note I noticed that on the main files page it doesn't give a list of the number of files, but when you go into a folder it does list the number of files.

I have attached a few screenshots:
download-all-button.png shows the download for the main files page. I had to add in the text "Viewing item 1 to 20 (of 25 items)."

I also added in text below it "Click on a filename to download it." That was added just because I realized that not everyone might understand you just have to click the filename to download it (and because that same action produces a different result in the docs area).

Question: are you able to "download all" for folders too or just all files? The button wasn't working for me on cdev.

The other two images are if we have a download button for the folder files as well.

folder-download-v1.png this has basically the same interface as the download-all-button.png and is done to keep them consistent.

folder-download-v2.png In this case I moved the button to be close to the name of the folder. The reasoning here would be that being next to the name of the folder it is clear what it is for.

Dan, reassigning to you to implement what I've laid out here: http://redmine.gc.cuny.edu/issues/2757#note-18

Sorry for the delay on this - I made the changes you laid out, Boone, but I did run into one problem so I havent committed them and pushed them up yet. The version of Group Files I have doesn't look exactly like what you have in your screen shot - mine doesn't have the information about how many files there are and how many are being viewed, or the message about clicking on a file name to download. I've attached a screenshot of what the section of the page looks like for me, with the changes made as best as I could. What do you think I should do next?

Thanks, Dan! Implementation of Genericons looks just fine for the time being. (If we start using them more, we should have drop-in class names for them.)

Your fix for the pagination bug looks good too. Thanks!

Styling on the link feels a little off to me. I feel like it should be a bit closer to the size of the pagination, and ideally the text would be vertically centered on the icon. I think this is hard to do given that you've put the genericon on the :before of the link itself - it'd be easier if you put it on a separate element that could be positioned separately. (In the past, I've used something like:

<i class="genericon genericon-cloud" />

For now, in the interest of moving on with our lives, I'm going to reassign this to Chris for some visual feedback. Chris, this is ready to have a look at on cdev. If you have any suggestions for final visual tweaks, that'd be great - or give us the go-ahead to close this ticket. Thanks!

Boone, I agree that it would be nice to have the download link be aligned with the "viewing item.." and pagination link. As for putting it in a separate element or the :before pseudo it can work either way. If you change the :before to a block then it can be easier to position it around (http://www.smashingmagazine.com/2011/07/13/learning-to-use-the-before-and-after-pseudo-elements-in-css/ ).

I do have a question and one more possible change to the positioning depending on the answer. When you're in a folder does the link just download the files in the folder or still all of the files? If it is all of the files then we might want to move the link under Show All Files (attache image). The reason is that it might be confusing to see "Viewing item 1 to 9 (of 9 items)" and then the download link right next to it downloads more than those 9 files. The link does say "all group files" but I'm wondering if people won't really read that or understand it. Placing the link next to Show All Files may be clearer (I moved the icon to the right just because it seemed to look better with the text aligned on the left).

Dan, I forgot to add at the end that in the interest of getting this out I'm OK with leaving the final visual tweaks and placement up to you (based on the feedback). If you have any questions, I'm happy to answer, if you want to get this done and out that's fine. Giving it back to you.

In the interest of our upcoming deadline, I've decided to do some cleanup here myself. https://github.com/cuny-academic-commons/cac/commit/b7b6f10024edecbcd89fe4c7d5d8da65bb1a1c3f

1. I moved the link to the upper right, where it's set apart from other stuff http://cdev.gc.cuny.edu/groups/cac-community-team-project-planning/documents/
2. Added the ability to download folder-specific stuff. When viewing a specific folder, you'll see a "This folder" link http://cdev.gc.cuny.edu/groups/cac-community-team-project-planning/documents/?category=52260
3. Downloading "all files" will create a zip with folder organization

Ready to test on cdev

Thanks for all your work on it, Dan! Together we built something kinda neat :)

I showed the latest UI to Matt in person during a meeting today. He gave us the green light with the current implementation (though he's still not a huge fan of the icon, it's less prominent now, and it's good enough for 1.7). If there are issues that block 1.7, feel free to reopen this ticket, or open a new one against the milestone. Other enhancements should go into new tickets. Thanks!

I just tried to download all the files from our community team group and it wouldn't work for me, it just refreshes the page.

Thanks, Sarah. Turns out this is not due to a problem with the new functionality, but with cdev - the list of files you were seeing on this page http://cdev.gc.cuny.edu/groups/cac-community-team-project-planning/documents/ didn't actually reflect the files in the relevant upload folder on the server. I spent a bunch of time today doing a full sync of bp-group-documents content from commons to cdev, but I hit some lame technical snags, so I've given up. For the time being, I have manually moved over the files for http://cdev.gc.cuny.edu/groups/cac-community-team-project-planning/documents/, so at least you can test the zip download now. (It will also work with any new documents you upload to any group.) Please test and report back.

Hi Sarah - Going to close this one as resolved, to clear the milestone. If you continue to see issues, please let me know.