Skip to content

Optimize FilePath.readToString #3862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oleg-nenashev merged 5 commits into from
Jan 27, 2019
Merged

Optimize FilePath.readToString #3862

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ea7cade
Optimize FilePath.readToString.
jglick Jan 23, 2019
7090b37
More consistent use of Util.fileToPath from FilePath methods.
jglick Jan 23, 2019
479bf62
Javadoc
jglick Jan 23, 2019
dca272d
Removing gratuitous catch of InvalidPathException.
jglick Jan 24, 2019
ca6361e
Update FilePath.java
oleg-nenashev Jan 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 19 additions & 46 deletions core/src/main/java/hudson/FilePath.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
import hudson.util.io.Archiver;
import hudson.util.io.ArchiverFactory;

import static java.util.logging.Level.FINE;

import java.io.BufferedOutputStream;
import java.io.File;
Expand All @@ -82,11 +81,9 @@
import java.net.URLConnection;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import java.nio.file.LinkOption;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import java.nio.file.attribute.FileAttribute;
import java.nio.file.attribute.PosixFilePermission;
Expand Down Expand Up @@ -137,10 +134,8 @@
import org.kohsuke.stapler.Stapler;

import static hudson.FilePath.TarCompression.GZIP;
import static hudson.Util.deleteFile;
import static hudson.Util.fileToPath;
import static hudson.Util.fixEmpty;
import static hudson.Util.isSymlink;

import java.util.Collections;
import org.apache.tools.ant.BuildException;
Expand Down Expand Up @@ -1600,11 +1595,7 @@ private class Touch extends SecureFileCallable<Void> {
@Override
public Void invoke(File f, VirtualChannel channel) throws IOException {
if(!f.exists()) {
try {
Files.newOutputStream(creating(f).toPath()).close();
} catch (InvalidPathException e) {
throw new IOException(e);
}
Files.newOutputStream(fileToPath(creating(f))).close();
}
if(!stating(f).setLastModified(timestamp))
throw new IOException("Failed to set the timestamp of "+f+" to "+timestamp);
Expand Down Expand Up @@ -1947,11 +1938,7 @@ private static String[] glob(File dir, String includes, String excludes, boolean
*/
public InputStream read() throws IOException, InterruptedException {
if(channel==null) {
try {
return Files.newInputStream(reading(new File(remote)).toPath());
} catch (InvalidPathException e) {
throw new IOException(e);
}
return Files.newInputStream(fileToPath(reading(new File(remote))));
}

final Pipe p = Pipe.createRemoteToLocal();
Expand All @@ -1967,11 +1954,9 @@ private class Read extends SecureFileCallable<Void> {
}
@Override
public Void invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
try (InputStream fis = Files.newInputStream(reading(f).toPath());
try (InputStream fis = Files.newInputStream(fileToPath(reading(f)));
OutputStream out = p.getOut()) {
org.apache.commons.io.IOUtils.copy(fis, out);
} catch (InvalidPathException e) {
p.error(new IOException(e));
} catch (Exception x) {
p.error(x);
}
Expand Down Expand Up @@ -2042,11 +2027,16 @@ public Void invoke(File f, VirtualChannel channel) throws IOException {
}

/**
* Reads this file into a string, by using the current system encoding.
* Reads this file into a string, by using the current system encoding on the remote machine.
*/
public String readToString() throws IOException, InterruptedException {
try (InputStream in = read()) {
return org.apache.commons.io.IOUtils.toString(in);
return act(new ReadToString());
}
private final class ReadToString extends SecureFileCallable<String> {
private static final long serialVersionUID = 1L;
@Override
public String invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
return new String(Files.readAllBytes(fileToPath(reading(f))));
}
}

Expand All @@ -2069,11 +2059,7 @@ public OutputStream write() throws IOException, InterruptedException {
if(channel==null) {
File f = new File(remote).getAbsoluteFile();
mkdirs(f.getParentFile());
try {
return Files.newOutputStream(writing(f).toPath());
} catch (InvalidPathException e) {
throw new IOException(e);
}
return Files.newOutputStream(fileToPath(writing(f)));
}

return act(new WritePipe());
Expand All @@ -2084,20 +2070,15 @@ private class WritePipe extends SecureFileCallable<OutputStream> {
public OutputStream invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
f = f.getAbsoluteFile();
mkdirs(f.getParentFile());
try {
OutputStream fos = Files.newOutputStream(writing(f).toPath());
return new RemoteOutputStream(fos);
} catch (InvalidPathException e) {
throw new IOException(e);
}
return new RemoteOutputStream(Files.newOutputStream(fileToPath(writing(f))));
}
}

/**
* Overwrites this file by placing the given String as the content.
*
* @param encoding
* Null to use the platform default encoding.
* Null to use the platform default encoding on the remote machine.
* @since 1.105
*/
public void write(final String content, final String encoding) throws IOException, InterruptedException {
Expand All @@ -2114,11 +2095,9 @@ private class Write extends SecureFileCallable<Void> {
@Override
public Void invoke(File f, VirtualChannel channel) throws IOException {
mkdirs(f.getParentFile());
try (OutputStream fos = Files.newOutputStream(writing(f).toPath());
try (OutputStream fos = Files.newOutputStream(fileToPath(writing(f)));
Writer w = encoding != null ? new OutputStreamWriter(fos, encoding) : new OutputStreamWriter(fos)) {
w.write(content);
} catch (InvalidPathException e) {
throw new IOException(e);
}
return null;
}
Expand Down Expand Up @@ -2264,11 +2243,9 @@ private class CopyTo extends SecureFileCallable<Void> {
}
@Override
public Void invoke(File f, VirtualChannel channel) throws IOException {
try (InputStream fis = Files.newInputStream(reading(f).toPath())) {
try (InputStream fis = Files.newInputStream(fileToPath(reading(f)))) {
org.apache.commons.io.IOUtils.copy(fis, out);
return null;
} catch (InvalidPathException e) {
throw new IOException(e);
} finally {
out.close();
}
Expand Down Expand Up @@ -3327,13 +3304,9 @@ public Boolean invoke(@Nonnull File parentFile, @Nonnull VirtualChannel channel)
// in case this folder / file will be copied somewhere else,
// it becomes the responsibility of that system to check the isDescendant with the existing links
// we are not taking the parentRealPath to avoid possible problem
try {
Path child = currentFileAbsolutePath.normalize();
Path parent = parentAbsolutePath.normalize();
return child.startsWith(parent);
} catch (InvalidPathException e2) {
throw new IOException(e2);
}
Path child = currentFileAbsolutePath.normalize();
Path parent = parentAbsolutePath.normalize();
return child.startsWith(parent);
}
}

Expand Down