Skip to content

Commit

Permalink
Some ArchiveExtractor bugs fixed and its code formatted
Browse files Browse the repository at this point in the history
  • Loading branch information
Federico Fissore committed Mar 27, 2015
1 parent 323458c commit 6b5244e
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 72 deletions.
13 changes: 12 additions & 1 deletion app/src/cc/arduino/contributions/libraries/ui/LibraryInstaller.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@

public class LibraryInstaller {

private static final String LIBRARY_INDEX_URL;

static {
String extenalLibraryIndexUrl = System.getProperty("LIBRARY_INDEX_URL");
if (extenalLibraryIndexUrl != null && !"".equals(extenalLibraryIndexUrl)) {
LIBRARY_INDEX_URL = extenalLibraryIndexUrl;
} else {
LIBRARY_INDEX_URL = "http://arduino.cc/download.php?f=/libraries/library_index.json";
}
}

private LibrariesIndexer indexer;
private File stagingFolder;
private DownloadableContributionsDownloader downloader;
Expand All @@ -63,7 +74,7 @@ public void updateIndex() throws Exception {
final MultiStepProgress progress = new MultiStepProgress(2);

// Step 1: Download index
URL url = new URL("http://arduino.cc/download.php?f=/libraries/library_index.json");
URL url = new URL(LIBRARY_INDEX_URL);
File outputFile = indexer.getIndexFile();
File tmpFile = new File(outputFile.getAbsolutePath() + ".tmp");
try {
Expand Down
13 changes: 12 additions & 1 deletion arduino-core/src/cc/arduino/contributions/packages/ContributionInstaller.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@

public class ContributionInstaller {

private static final String PACKAGE_INDEX_URL;

static {
String extenalPackageIndexUrl = System.getProperty("PACKAGE_INDEX_URL");
if (extenalPackageIndexUrl != null && !"".equals(extenalPackageIndexUrl)) {
PACKAGE_INDEX_URL = extenalPackageIndexUrl;
} else {
PACKAGE_INDEX_URL = "http://arduino.cc/download.php?f=/packages/package_index.json";
}
}

private File stagingFolder;
private ContributionsIndexer indexer;
private DownloadableContributionsDownloader downloader;
Expand Down Expand Up @@ -172,7 +183,7 @@ public void updateIndex() throws Exception {
final MultiStepProgress progress = new MultiStepProgress(1);
final String statusText = _("Downloading platforms index...");

URL url = new URL("http://arduino.cc/download.php?f=/packages/package_index.json");
URL url = new URL(PACKAGE_INDEX_URL);
File outputFile = indexer.getIndexFile();
File tmpFile = new File(outputFile.getAbsolutePath() + ".tmp");
downloader.download(url, tmpFile, progress, statusText);
Expand Down
2 changes: 1 addition & 1 deletion arduino-core/src/cc/arduino/os/linux/LinuxFileNativeUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public static void chmod(File file, int mode) throws IOException {
public static void link(File file, File link) throws IOException {
int res = libc.link(file.getAbsolutePath(), link.getAbsolutePath());
if (res == -1)
throw new IOException("Could not create hard link: " + strerror());
throw new IOException("Could not create hard link to " + file + " from " + link + ": " + strerror());
}

public static void symlink(File file, File link) throws IOException {
Expand Down
149 changes: 80 additions & 69 deletions arduino-core/src/cc/arduino/utils/ArchiveExtractor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,7 @@
*/
package cc.arduino.utils;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;

import cc.arduino.os.FileNativeUtils;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveInputStream;
import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
Expand All @@ -45,38 +37,35 @@
import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;
import org.apache.commons.compress.compressors.gzip.GzipCompressorInputStream;

import cc.arduino.os.FileNativeUtils;
import java.io.*;
import java.util.HashMap;
import java.util.Map;

public class ArchiveExtractor {

/**
* Extract <b>source</b> into <b>destFolder</b>. <b>source</b> file archive
* format is autodetected from file extension.
*
*
* @param archiveFile
* @param destFolder
* @throws IOException
*/
public static void extract(File archiveFile, File destFolder)
throws IOException {
public static void extract(File archiveFile, File destFolder) throws IOException {
extract(archiveFile, destFolder, 0);
}

/**
* Extract <b>source</b> into <b>destFolder</b>. <b>source</b> file archive
* format is autodetected from file extension.
*
* @param archiveFile
* Archive file to extract
* @param destFolder
* Destination folder
* @param stripPath
* Number of path elements to strip from the paths contained in the
* archived files
*
* @param archiveFile Archive file to extract
* @param destFolder Destination folder
* @param stripPath Number of path elements to strip from the paths contained in the
* archived files
* @throws IOException
*/
public static void extract(File archiveFile, File destFolder, int stripPath)
throws IOException {
public static void extract(File archiveFile, File destFolder, int stripPath) throws IOException {

// Folders timestamps must be set at the end of archive extraction
// (because creating a file in a folder alters the folder's timestamp)
Expand Down Expand Up @@ -106,11 +95,17 @@ public static void extract(File archiveFile, File destFolder, int stripPath)

String pathPrefix = "";

Map<File, File> hardLinks = new HashMap<File, File>();
Map<File, Integer> hardLinksMode = new HashMap<File, Integer>();
Map<File, File> symLinks = new HashMap<File, File>();
Map<File, Long> symLinksModifiedTimes = new HashMap<File, Long>();

// Cycle through all the archive entries
while (true) {
ArchiveEntry entry = in.getNextEntry();
if (entry == null)
if (entry == null) {
break;
}

// Extract entry info
long size = entry.getSize();
Expand All @@ -127,18 +122,21 @@ public static void extract(File archiveFile, File destFolder, int stripPath)
// http://superuser.com/questions/61185/why-do-i-get-files-like-foo-in-my-tarball-on-os-x
int slash = name.lastIndexOf('/');
if (slash == -1) {
if (name.startsWith("._"))
if (name.startsWith("._")) {
continue;
}
} else {
if (name.substring(slash + 1).startsWith("._"))
if (name.substring(slash + 1).startsWith("._")) {
continue;
}
}
}

// Skip git metadata
// http://www.unix.com/unix-for-dummies-questions-and-answers/124958-file-pax_global_header-means-what.html
if (name.contains("pax_global_header"))
if (name.contains("pax_global_header")) {
continue;
}

if (entry instanceof TarArchiveEntry) {
TarArchiveEntry tarEntry = (TarArchiveEntry) entry;
Expand All @@ -154,84 +152,99 @@ public static void extract(File archiveFile, File destFolder, int stripPath)
int slash = 0;
while (stripPath > 0) {
slash = name.indexOf("/", slash);
if (slash == -1)
throw new IOException(
"Invalid archive: it must contains a single root folder");
if (slash == -1) {
throw new IOException("Invalid archive: it must contains a single root folder");
}
slash++;
stripPath--;
}
pathPrefix = name.substring(0, slash);
}

// Strip the common path prefix when requested
if (!name.startsWith(pathPrefix))
throw new IOException(
"Invalid archive: it must contains a single root folder while file "
+ name + " is outside " + pathPrefix);
if (!name.startsWith(pathPrefix)) {
throw new IOException("Invalid archive: it must contains a single root folder while file " + name + " is outside " + pathPrefix);
}
name = name.substring(pathPrefix.length());
if (name.isEmpty())
if (name.isEmpty()) {
continue;
}
File outputFile = new File(destFolder, name);

File outputLinkFile = null;
if (isLink) {
if (!linkName.startsWith(pathPrefix)) {
throw new IOException(
"Invalid archive: it must contains a single root folder while file "
+ linkName + " is outside " + pathPrefix);
throw new IOException("Invalid archive: it must contains a single root folder while file " + linkName + " is outside " + pathPrefix);
}
linkName = linkName.substring(pathPrefix.length());
outputLinkFile = new File(destFolder, linkName);
}
if (isSymLink) {
// Symbolic links are referenced with relative paths
outputLinkFile = new File(linkName);
if (outputLinkFile.isAbsolute())
throw new IOException(
"Invalid archive: it contains a symbolic link with absolute path '"
+ outputLinkFile + "'");
if (outputLinkFile.isAbsolute()) {
throw new IOException("Invalid archive: it contains a symbolic link with absolute path '" + outputLinkFile + "'");
}
}

// Safety check
if (isDirectory) {
if (outputFile.isFile())
throw new IOException("Can't create folder " + outputFile
+ ", a file with the same name exists!");
if (outputFile.isFile()) {
throw new IOException("Can't create folder " + outputFile + ", a file with the same name exists!");
}
} else {
// - isLink
// - isSymLink
// - anything else
if (outputFile.exists())
throw new IOException("Can't extract file " + outputFile
+ ", file already exists!");
if (outputFile.exists()) {
throw new IOException("Can't extract file " + outputFile + ", file already exists!");
}
}

// Extract the entry
if (isDirectory) {
if (!outputFile.exists())
if (!outputFile.mkdirs())
throw new IOException("Could not create folder: " + outputFile);
if (!outputFile.exists() && !outputFile.mkdirs()) {
throw new IOException("Could not create folder: " + outputFile);
}
foldersTimestamps.put(outputFile, modifiedTime);
} else if (isLink) {
FileNativeUtils.link(outputLinkFile, outputFile);
hardLinks.put(outputLinkFile, outputFile);
hardLinksMode.put(outputFile, mode);
} else if (isSymLink) {
FileNativeUtils.symlink(outputLinkFile, outputFile);
outputFile.setLastModified(modifiedTime);
symLinks.put(outputLinkFile, outputFile);
symLinksModifiedTimes.put(outputFile, modifiedTime);
} else {
// Create the containing folder if not exists
if (!outputFile.getParentFile().isDirectory())
if (!outputFile.getParentFile().isDirectory()) {
outputFile.getParentFile().mkdirs();
}
copyStreamToFile(in, size, outputFile);
outputFile.setLastModified(modifiedTime);
}

// Set file/folder permission
if (mode != null && !isSymLink)
if (mode != null && !isSymLink && outputFile.exists()) {
FileNativeUtils.chmod(outputFile, mode);
}
}

for (Map.Entry<File, File> entry : hardLinks.entrySet()) {
FileNativeUtils.link(entry.getKey(), entry.getValue());
Integer mode = hardLinksMode.get(entry.getValue());
if (mode != null) {
FileNativeUtils.chmod(entry.getValue(), mode);
}
}

for (Map.Entry<File, File> entry : symLinks.entrySet()) {
FileNativeUtils.symlink(entry.getKey(), entry.getValue());
entry.getValue().setLastModified(symLinksModifiedTimes.get(entry.getValue()));
}

} finally {
if (in != null)
if (in != null) {
in.close();
}
}

// Set folders timestamps
Expand All @@ -240,30 +253,28 @@ public static void extract(File archiveFile, File destFolder, int stripPath)
}
}

private static void copyStreamToFile(InputStream in, long size,
File outputFile)
throws FileNotFoundException, IOException {
private static void copyStreamToFile(InputStream in, long size, File outputFile) throws IOException {
FileOutputStream fos = new FileOutputStream(outputFile);
try {
// if size is not available, copy until EOF...
if (size == -1) {
byte buffer[] = new byte[4096];
int l;
while ((l = in.read(buffer)) != -1) {
fos.write(buffer, 0, l);
int length;
while ((length = in.read(buffer)) != -1) {
fos.write(buffer, 0, length);
}
return;
}

// ...else copy just the needed amount of bytes
byte buffer[] = new byte[4096];
while (size > 0) {
int l = in.read(buffer);
if (l <= 0)
throw new IOException("Error while extracting file "
+ outputFile.getAbsolutePath());
fos.write(buffer, 0, l);
size -= l;
int length = in.read(buffer);
if (length <= 0) {
throw new IOException("Error while extracting file " + outputFile.getAbsolutePath());
}
fos.write(buffer, 0, length);
size -= length;
}
} finally {
fos.close();
Expand Down

0 comments on commit 6b5244e

Please sign in to comment.