inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-07 17:49:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge from BRANCHES/DEV/CLOUD1_SPRINT1 to HEAD:

Browse Source 
40238: CLOUD-37 - Initial Commit to test
        Merged BRANCHES/DEV/AMILLER/CLOUD1_SPRINT1 to BRANCHES/DEV/CLOUD1_SPRINT1:
           40077: CLOUD-37: Initial commit.
           40101: CLOUD-37: Fix build error.
           40114: CLOUD-37: Fix path names and missing files.
           40122: CLOUD-37: Initial drop of UI code for investigation of progress issues
           40124: CLOUD-37: A couple of minor UI tweaks (set icon and hide panel before archive download)
           40125: CLOUD-37: Download files and folders as zip
           40134: CLOUD-37: Updates to UI (javascript doc, CSS tweaks, intervals for requests, labels, etc).
           40143: CLOUD-37: Error messages for failures, more JavaScript doc, archive naming, code tidy   40157: CLOUD-37 - Download files and folders as zip
           40202: CLOUD-37: UI tweaks following UX review
           40217: CLOUD-37: Add file count to status reports.
           40222: CLOUD-37: Added information to download dialog to report on the number of files added to the zip 
   40240: CLOUD-37: Remove extraneous file, breaking build
   40513: CLOUD-37: Add Action Service Metrics
        Merged BRANCHES/DEV/AMILLER/CLOUD1_SPRINT1 to BRANCHES/DEV/CLOUD1_SPRINT1:
           40260: CLOUD-37: Add action service metrics
           40309: CLOUD-37: Fix JMX configuration, pointing at renamed class.
   40514: CLOUD-37: Enable the execution of the zip creation process on a remote transformation node
        Merged BRANCHES/DEV/AMILLER/CLOUD1_SPRINT1 to BRANCHES/DEV/CLOUD1_SPRINT1:
           40369: CLOUD-37: Enable the execution of the zip creation process on a remote transformation node   
   40516: CLOUD-37: Implement clean up job.
        Merged BRANCHES/DEV/AMILLER/CLOUD1_SPRINT1 to BRANCHES/DEV/CLOUD1_SPRINT1:
           40462: CLOUD-37: Implement clean up job.
   40517: CLOUD-505: Add entries for folders.
        Merged BRANCHES/DEV/AMILLER/CLOUD1_SPRINT1 to BRANCHES/DEV/CLOUD1_SPRINT1:
           40493: CLOUD-505: Add entries for folders.
   40547: CLOUD-37: Fix broken test
   40595: CLOUD-518: Add working copy/locked file filtering
   40642: CLOUD-508: Prevent problems occurring when cancelling and restarting the same download
   40643: CLOUD-507: When a single item is selected for download it the item name gets used for the archive name
   41442: CLOUD-590: Limit the total size of the content which can be downloaded. This can be set via the property, download.maxContentSize. The default is 2GB.
   41472: CLOUD-589: Added cancelled flag to download type and added checks in Zip creation action to act upon the setting of this flag. Also added webscript for canceling the download.
   41692: Adds support to Alfresco.util.formatFileSize for file sizes with commas (as needed by zip download)
   41693: Zip Download enhancements:
       CLOUD-590: Notifies the user when they've exceeded the maximum file size limit.
       CLOUD-626: Better handling when there are errors during zipping. (WIP)
   41713: Zip Download Updates:
        CLOUD-589: A cancel download UI action now triggers a delete of the archive on the server.
        CLOUD-626: The UI now triggers a full download cancel (with node delete) in event of an error.
   41737: Updates Alfresco.util.formatFileSize to support an optional decimal places param. (For CLOUD-685)
   41739: CLOUD-685: Display total file size of files for download to two decimal places when there is an error.
   41832: Fixes: CLOUD-704: new CANCELLED status is now handled correctly.
   41887: CLOUD-686: Updated maximum download content size to 2152852358 bytes (2.005GB)
   41965: CLOUD-703: Upload content now runs as system user, and Quota Service returns unlimited quota for system user.
   42025: CLOUD-703: Fix test failures and ensure S3 content store works in the clustered and non-clustered environments

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@42146 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
David Draper
2012-09-28 13:26:36 +00:00
parent ed48e2c4c9
commit 642d332d24
43 changed files with 3561 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

300
source/java/org/alfresco/repo/download/ZipDownloadExporter.java Normal file
View File

@@ -0,0 +1,300 @@
/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.download;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Deque;
import java.util.Iterator;
import java.util.LinkedList;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.transaction.RetryingTransactionHelper;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.cmr.coci.CheckOutCheckInService;
import org.alfresco.service.cmr.download.DownloadStatus;
import org.alfresco.service.cmr.download.DownloadStatus.Status;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.view.ExporterContext;
import org.alfresco.service.cmr.view.ExporterException;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.Pair;
import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream.UnicodeExtraFieldPolicy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Handler for exporting node content to a ZIP file
*
* @author Alex Miller
*/
public class ZipDownloadExporter extends BaseExporter
{
private static Logger log = LoggerFactory.getLogger(ZipDownloadExporter.class);
private static final String PATH_SEPARATOR = "/";
protected ZipArchiveOutputStream zipStream;
private NodeRef downloadNodeRef;
private int sequenceNumber = 1;
private long total;
private long done;
private long totalFileCount;
private long filesAddedCount;
private RetryingTransactionHelper transactionHelper;
private DownloadStorage downloadStorage;
private DownloadStatusUpdateService updateService;
private Deque<Pair<String, NodeRef>> path = new LinkedList<Pair<String, NodeRef>>();
private String currentName;
private OutputStream outputStream;
/**
* Construct
*
* @param destDir
* @param zipFile
* @param transactionHelper
* @param l
* @param actionedUponNodeRef
* @param dataFile
* @param contentDir
*/
public ZipDownloadExporter(File zipFile, CheckOutCheckInService checkOutCheckInService, NodeService nodeService, RetryingTransactionHelper transactionHelper, DownloadStatusUpdateService updateService, DownloadStorage downloadStorage, NodeRef downloadNodeRef, long total, long totalFileCount)
{
super(checkOutCheckInService, nodeService);
try
{
this.outputStream = new FileOutputStream(zipFile);
this.updateService = updateService;
this.transactionHelper = transactionHelper;
this.downloadStorage = downloadStorage;
this.downloadNodeRef = downloadNodeRef;
this.total = total;
this.totalFileCount = totalFileCount;
}
catch (FileNotFoundException e)
{
throw new ExporterException("Failed to create zip file", e);
}
}
@Override
public void start(final ExporterContext context)
{
zipStream = new ZipArchiveOutputStream(outputStream);
// NOTE: This encoding allows us to workaround bug...
// http://bugs.sun.com/bugdatabase/view_bug.do;:WuuT?bug_id=4820807
zipStream.setEncoding("UTF-8");
zipStream.setCreateUnicodeExtraFields(UnicodeExtraFieldPolicy.ALWAYS);
zipStream.setUseLanguageEncodingFlag(true);
zipStream.setFallbackToUTF8(true);
}
@Override
public void startNode(NodeRef nodeRef)
{
this.currentName = (String)nodeService.getProperty(nodeRef, ContentModel.PROP_NAME);
path.push(new Pair<String, NodeRef>(currentName, nodeRef));
if (ContentModel.TYPE_FOLDER.equals(nodeService.getType(nodeRef)))
{
String path = getPath() + PATH_SEPARATOR;
ZipArchiveEntry archiveEntry = new ZipArchiveEntry(path);
try
{
zipStream.putArchiveEntry(archiveEntry);
zipStream.closeArchiveEntry();
}
catch (IOException e)
{
throw new ExporterException("Unexpected IOException adding folder entry", e);
}
}
}
@Override
public void contentImpl(NodeRef nodeRef, QName property, InputStream content, ContentData contentData, int index)
{
// if the content stream to output is empty, then just return content descriptor as is
if (content == null)
{
return;
}
try
{
// ALF-2016
ZipArchiveEntry zipEntry=new ZipArchiveEntry(getPath());
zipStream.putArchiveEntry(zipEntry);
// copy export stream to zip
copyStream(zipStream, content);
zipStream.closeArchiveEntry();
filesAddedCount = filesAddedCount + 1;
}
catch (IOException e)
{
throw new ExporterException("Failed to zip export stream", e);
}
}
@Override
public void endNode(NodeRef nodeRef)
{
path.pop();
}
@Override
public void end()
{
try
{
zipStream.close();
}
catch (IOException error)
{
throw new ExporterException("Unexpected error closing zip stream!", error);
}
}
private String getPath()
{
if (path.size() < 1)
{
throw new IllegalStateException("No elements in path!");
}
Iterator<Pair<String, NodeRef>> iter = path.descendingIterator();
StringBuilder pathBuilder = new StringBuilder();
while (iter.hasNext())
{
Pair<String, NodeRef> element = iter.next();
pathBuilder.append(element.getFirst());
if (iter.hasNext())
{
pathBuilder.append(PATH_SEPARATOR);
}
}
return pathBuilder.toString();
}
/**
* Copy input stream to output stream
*
* @param output output stream
* @param in input stream
* @throws IOException
*/
private void copyStream(OutputStream output, InputStream in)
throws IOException
{
byte[] buffer = new byte[2048 * 10];
int read = in.read(buffer, 0, 2048 *10);
while (read != -1)
{
output.write(buffer, 0, read);
done = done + read;
updateStatus();
checkCancelled();
read = in.read(buffer, 0, 2048 *10);
}
}
private void checkCancelled()
{
boolean downloadCancelled = transactionHelper.doInTransaction(new RetryingTransactionCallback<Boolean>()
{
@Override
public Boolean execute() throws Throwable
{
return downloadStorage.isCancelled(downloadNodeRef);
}
}, true, true);
if ( downloadCancelled == true)
{
log.debug("Download cancelled");
throw new DownloadCancelledException();
}
}
private void updateStatus()
{
transactionHelper.doInTransaction(new RetryingTransactionCallback<Object>()
{
@Override
public Object execute() throws Throwable
{
DownloadStatus status = new DownloadStatus(Status.IN_PROGRESS, done, total, filesAddedCount, totalFileCount);
updateService.update(downloadNodeRef, status, getNextSequenceNumber());
return null;
}
}, false, true);
}
public int getNextSequenceNumber()
{
return sequenceNumber++;
}
public long getDone()
{
return done;
}
public long getTotal()
{
return total;
}
public long getFilesAdded()
{
return filesAddedCount;
}
public long getTotalFiles()
{
return totalFileCount;
}
}