();
diff --git a/core/src/main/java/hudson/CopyOnWrite.java b/core/src/main/java/hudson/CopyOnWrite.java
index efe21357c4405e122651a284c0cb4c30157fce62..891cbf04bb9ffef6d6f657d05eb4708d94fa0f5e 100644
--- a/core/src/main/java/hudson/CopyOnWrite.java
+++ b/core/src/main/java/hudson/CopyOnWrite.java
@@ -43,7 +43,7 @@ import java.lang.annotation.Target;
*
*
* The field marked with this annotation usually needs to be marked as
- * volatile.
+ * {@code volatile}.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/EnvVars.java b/core/src/main/java/hudson/EnvVars.java
index 1849ecbf66aebaf6ca6a4df5ce197b5b825c8b36..cd553f3aba01ea325c58912b990d88aab9cb5e66 100644
--- a/core/src/main/java/hudson/EnvVars.java
+++ b/core/src/main/java/hudson/EnvVars.java
@@ -44,6 +44,7 @@ import java.util.TreeSet;
import java.util.UUID;
import java.util.logging.Logger;
import javax.annotation.Nonnull;
+import javax.annotation.CheckForNull;
/**
* Environment variables.
@@ -54,7 +55,7 @@ import javax.annotation.Nonnull;
* but case insensitive way (that is, cmd.exe can get both FOO and foo as environment variables
* when it's launched, and the "set" command will display it accordingly, but "echo %foo%" results in
* echoing the value of "FOO", not "foo" — this is presumably caused by the behavior of the underlying
- * Win32 API GetEnvironmentVariable acting in case insensitive way.) Windows users are also
+ * Win32 API {@code GetEnvironmentVariable} acting in case insensitive way.) Windows users are also
* used to write environment variable case-insensitively (like %Path% vs %PATH%), and you can see many
* documents on the web that claims Windows environment variables are case insensitive.
*
@@ -65,10 +66,10 @@ import javax.annotation.Nonnull;
*
* In Jenkins, often we need to build up "environment variable overrides"
* on master, then to execute the process on agents. This causes a problem
- * when working with variables like PATH. So to make this work,
- * we introduce a special convention PATH+FOO — all entries
- * that starts with PATH+ are merged and prepended to the inherited
- * PATH variable, on the process where a new process is executed.
+ * when working with variables like {@code PATH}. So to make this work,
+ * we introduce a special convention {@code PATH+FOO} — all entries
+ * that starts with {@code PATH+} are merged and prepended to the inherited
+ * {@code PATH} variable, on the process where a new process is executed.
*
* @author Kohsuke Kawaguchi
*/
@@ -84,7 +85,24 @@ public class EnvVars extends TreeMap {
* So this property remembers that information.
*/
private Platform platform;
+
+ /**
+ * Gets the platform for which these env vars targeted.
+ * @since TODO
+ * @return The platform.
+ */
+ public @CheckForNull Platform getPlatform() {
+ return platform;
+ }
+ /**
+ * Sets the platform for which these env vars target.
+ * @since TODO
+ * @param platform the platform to set.
+ */
+ public void setPlatform(@Nonnull Platform platform) {
+ this.platform = platform;
+ }
public EnvVars() {
super(CaseInsensitiveComparator.INSTANCE);
}
@@ -107,7 +125,7 @@ public class EnvVars extends TreeMap {
}
/**
- * Builds an environment variables from an array of the form "key","value","key","value"...
+ * Builds an environment variables from an array of the form {@code "key","value","key","value"...}
*/
public EnvVars(String... keyValuePairs) {
this();
@@ -121,7 +139,7 @@ public class EnvVars extends TreeMap {
* Overrides the current entry by the given entry.
*
*
- * Handles PATH+XYZ notation.
+ * Handles {@code PATH+XYZ} notation.
*/
public void override(String key, String value) {
if(value==null || value.length()==0) {
@@ -425,7 +443,7 @@ public class EnvVars extends TreeMap {
*
*
* If you access this field from agents, then this is the environment
- * variable of the agent agent.
+ * variable of the agent.
*/
public static final Map masterEnvVars = initMaster();
diff --git a/core/src/main/java/hudson/ExtensionFinder.java b/core/src/main/java/hudson/ExtensionFinder.java
index 6208f6cec8322a0145f2fc4436519000d07e0ce6..1ff0638c10d6b578927ea90757d5acb8bdbeff6b 100644
--- a/core/src/main/java/hudson/ExtensionFinder.java
+++ b/core/src/main/java/hudson/ExtensionFinder.java
@@ -23,6 +23,7 @@
*/
package hudson;
+import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
@@ -35,11 +36,13 @@ import com.google.inject.Module;
import com.google.inject.Provider;
import com.google.inject.Scope;
import com.google.inject.Scopes;
+import com.google.inject.matcher.Matchers;
import com.google.inject.name.Names;
-import com.google.common.collect.ImmutableList;
+import com.google.inject.spi.ProvisionListener;
import hudson.init.InitMilestone;
import hudson.model.Descriptor;
import hudson.model.Hudson;
+import hudson.util.ReflectionUtils;
import jenkins.ExtensionComponentSet;
import jenkins.ExtensionFilter;
import jenkins.ExtensionRefreshException;
@@ -49,20 +52,25 @@ import net.java.sezpoz.Index;
import net.java.sezpoz.IndexItem;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.springframework.util.ClassUtils;
+import javax.annotation.PostConstruct;
import java.lang.annotation.Annotation;
+import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
-import java.util.logging.Logger;
+import java.util.Set;
import java.util.logging.Level;
-import java.util.List;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.lang.reflect.AnnotatedElement;
-import java.lang.reflect.Field;
-import java.lang.reflect.Method;
+import java.util.logging.Logger;
/**
* Discovers the implementations of an extension point.
@@ -254,12 +262,9 @@ public abstract class ExtensionFinder implements ExtensionPoint {
private Map,GuiceExtensionAnnotation> extensionAnnotations = Maps.newHashMap();
public GuiceFinder() {
- for (ExtensionComponent ec : moduleFinder.find(GuiceExtensionAnnotation.class, Hudson.getInstance())) {
- GuiceExtensionAnnotation gea = ec.getInstance();
- extensionAnnotations.put(gea.annotationType,gea);
- }
+ refreshExtensionAnnotations();
- sezpozIndex = loadSezpozIndices(Jenkins.getInstance().getPluginManager().uberClassLoader);
+ SezpozModule extensions = new SezpozModule(loadSezpozIndices(Jenkins.getInstance().getPluginManager().uberClassLoader));
List modules = new ArrayList<>();
modules.add(new AbstractModule() {
@@ -270,7 +275,7 @@ public abstract class ExtensionFinder implements ExtensionPoint {
bind(PluginManager.class).toInstance(j.getPluginManager());
}
});
- modules.add(new SezpozModule(sezpozIndex));
+ modules.add(extensions);
for (ExtensionComponent ec : moduleFinder.find(Module.class, Hudson.getInstance())) {
modules.add(ec.getInstance());
@@ -278,6 +283,7 @@ public abstract class ExtensionFinder implements ExtensionPoint {
try {
container = Guice.createInjector(modules);
+ sezpozIndex = extensions.getLoadedIndex();
} catch (Throwable e) {
LOGGER.log(Level.SEVERE, "Failed to create Guice container from all the plugins",e);
// failing to load all bindings are disastrous, so recover by creating minimum that works
@@ -293,6 +299,13 @@ public abstract class ExtensionFinder implements ExtensionPoint {
});
}
+ private void refreshExtensionAnnotations() {
+ for (ExtensionComponent ec : moduleFinder.find(GuiceExtensionAnnotation.class, Hudson.getInstance())) {
+ GuiceExtensionAnnotation gea = ec.getInstance();
+ extensionAnnotations.put(gea.annotationType,gea);
+ }
+ }
+
private ImmutableList> loadSezpozIndices(ClassLoader classLoader) {
List> indices = Lists.newArrayList();
for (GuiceExtensionAnnotation gea : extensionAnnotations.values()) {
@@ -315,17 +328,17 @@ public abstract class ExtensionFinder implements ExtensionPoint {
*/
@Override
public synchronized ExtensionComponentSet refresh() throws ExtensionRefreshException {
+ refreshExtensionAnnotations();
// figure out newly discovered sezpoz components
List> delta = Lists.newArrayList();
for (Class annotationType : extensionAnnotations.keySet()) {
delta.addAll(Sezpoz.listDelta(annotationType,sezpozIndex));
}
- List> l = Lists.newArrayList(sezpozIndex);
- l.addAll(delta);
- sezpozIndex = l;
+
+ SezpozModule deltaExtensions = new SezpozModule(delta);
List modules = new ArrayList<>();
- modules.add(new SezpozModule(delta));
+ modules.add(deltaExtensions);
for (ExtensionComponent ec : moduleFinder.refresh().find(Module.class)) {
modules.add(ec.getInstance());
}
@@ -333,6 +346,9 @@ public abstract class ExtensionFinder implements ExtensionPoint {
try {
final Injector child = container.createChildInjector(modules);
container = child;
+ List> l = Lists.newArrayList(sezpozIndex);
+ l.addAll(deltaExtensions.getLoadedIndex());
+ sezpozIndex = l;
return new ExtensionComponentSet() {
@Override
@@ -446,11 +462,13 @@ public abstract class ExtensionFinder implements ExtensionPoint {
* Instead of using SezPoz to instantiate, we'll instantiate them by using Guice,
* so that we can take advantage of dependency injection.
*/
- private class SezpozModule extends AbstractModule {
+ private class SezpozModule extends AbstractModule implements ProvisionListener {
private final List> index;
+ private final List> loadedIndex;
public SezpozModule(List> index) {
this.index = index;
+ this.loadedIndex = new ArrayList<>();
}
/**
@@ -493,6 +511,9 @@ public abstract class ExtensionFinder implements ExtensionPoint {
@SuppressWarnings({"unchecked", "ChainOfInstanceofChecks"})
@Override
protected void configure() {
+
+ bindListener(Matchers.any(), this);
+
for (final IndexItem item : index) {
boolean optional = isOptional(item.annotation());
try {
@@ -527,6 +548,7 @@ public abstract class ExtensionFinder implements ExtensionPoint {
}
}).in(scope);
}
+ loadedIndex.add(item);
} catch (Exception|LinkageError e) {
// sometimes the instantiation fails in an indirect classloading failure,
// which results in a LinkageError
@@ -535,9 +557,68 @@ public abstract class ExtensionFinder implements ExtensionPoint {
}
}
}
+
+ public List> getLoadedIndex() {
+ return Collections.unmodifiableList(loadedIndex);
+ }
+
+ @Override
+ public void onProvision(ProvisionInvocation provision) {
+ final T instance = provision.provision();
+ if (instance == null) return;
+ List methods = new LinkedList<>();
+ Class c = instance.getClass();
+
+ // find PostConstruct methods in class hierarchy, the one from parent class being first in list
+ // so that we invoke them before derived class one. This isn't specified in JSR-250 but implemented
+ // this way in Spring and what most developers would expect to happen.
+
+ final Set interfaces = ClassUtils.getAllInterfacesAsSet(instance);
+
+ while (c != Object.class) {
+ Arrays.stream(c.getDeclaredMethods())
+ .map(m -> getMethodAndInterfaceDeclarations(m, interfaces))
+ .flatMap(Collection::stream)
+ .filter(m -> m.getAnnotation(PostConstruct.class) != null)
+ .findFirst()
+ .ifPresent(method -> methods.add(0, method));
+ c = c.getSuperclass();
+ }
+
+ for (Method postConstruct : methods) {
+ try {
+ postConstruct.setAccessible(true);
+ postConstruct.invoke(instance);
+ } catch (final Exception e) {
+ throw new RuntimeException(String.format("@PostConstruct %s", postConstruct), e);
+ }
+ }
+ }
}
}
+ /**
+ * Returns initial {@link Method} as well as all matching ones found in interfaces.
+ * This allows to introspect metadata for a method which is both declared in parent class and in implemented
+ * interface(s). interfaces typically is obtained by {@link ClassUtils#getAllInterfacesAsSet}
+ */
+ Collection getMethodAndInterfaceDeclarations(Method method, Collection interfaces) {
+ final List methods = new ArrayList<>();
+ methods.add(method);
+
+ // we search for matching method by iteration and comparison vs getMethod to avoid repeated NoSuchMethodException
+ // being thrown, while interface typically only define a few set of methods to check.
+ interfaces.stream()
+ .map(Class::getMethods)
+ .flatMap(Arrays::stream)
+ .filter(m -> m.getName().equals(method.getName()) && Arrays.equals(m.getParameterTypes(), method.getParameterTypes()))
+ .findFirst()
+ .ifPresent(methods::add);
+
+ return methods;
+ }
+
+
/**
* The bootstrap implementation that looks for the {@link Extension} marker.
*
diff --git a/core/src/main/java/hudson/ExtensionList.java b/core/src/main/java/hudson/ExtensionList.java
index 9a4c77d2f5f5db24c736c6f58433737505f9a4c6..566e3de404911db2fbc418bab933a4bdd8261c79 100644
--- a/core/src/main/java/hudson/ExtensionList.java
+++ b/core/src/main/java/hudson/ExtensionList.java
@@ -145,15 +145,29 @@ public class ExtensionList extends AbstractList implements OnMaster {
* Looks for the extension instance of the given type (subclasses excluded),
* or return null.
*/
- public @CheckForNull U get(Class type) {
+ public @CheckForNull U get(@Nonnull Class type) {
for (T ext : this)
if(ext.getClass()==type)
return type.cast(ext);
return null;
}
+ /**
+ * Looks for the extension instance of the given type (subclasses excluded),
+ * or throws an IllegalStateException.
+ *
+ * Meant to simplify call inside @Extension annotated class to retrieve their own instance.
+ */
+ public @Nonnull U getInstance(@Nonnull Class type) throws IllegalStateException {
+ for (T ext : this)
+ if(ext.getClass()==type)
+ return type.cast(ext);
+
+ throw new IllegalStateException("The class " + type.getName() + " was not found, potentially not yet loaded");
+ }
+
@Override
- public Iterator iterator() {
+ public @Nonnull Iterator iterator() {
// we need to intercept mutation, so for now don't allow Iterator.remove
return new AdaptedIterator,T>(Iterators.readOnly(ensureLoaded().iterator())) {
protected T adapt(ExtensionComponent item) {
diff --git a/core/src/main/java/hudson/FilePath.java b/core/src/main/java/hudson/FilePath.java
index b7b5b2d79d3a14090cf421c583d7265afbf2b360..9452064e8105e124c0e62328f3310c03765b4ff7 100644
--- a/core/src/main/java/hudson/FilePath.java
+++ b/core/src/main/java/hudson/FilePath.java
@@ -58,6 +58,9 @@ import hudson.util.IOUtils;
import hudson.util.NamingThreadFactory;
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;
import java.io.FileFilter;
@@ -88,7 +91,6 @@ import java.nio.file.attribute.PosixFilePermission;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.ArrayList;
import java.util.Arrays;
-import java.util.Collections;
import java.util.Comparator;
import java.util.EnumSet;
import java.util.Enumeration;
@@ -139,6 +141,7 @@ import static hudson.Util.fixEmpty;
import static hudson.Util.isSymlink;
import java.util.Collections;
+import org.apache.tools.ant.BuildException;
/**
* {@link File} like object with remoting support.
@@ -225,9 +228,14 @@ public final class FilePath implements Serializable {
* This is used to determine whether we are running on the master or the agent.
*/
private transient VirtualChannel channel;
-
- // since the platform of the agent might be different, can't use java.io.File
- private final String remote;
+
+ /**
+ * Represent the path to the file in the master or the agent
+ * Since the platform of the agent might be different, can't use java.io.File
+ *
+ * The field could not be final since it's modified in {@link #readResolve()}
+ */
+ private /*final*/ String remote;
/**
* If this {@link FilePath} is deserialized to handle file access request from a remote computer,
@@ -275,6 +283,11 @@ public final class FilePath implements Serializable {
this.remote = normalize(resolvePathIfRelative(base, rel));
}
+ private Object readResolve() {
+ this.remote = normalize(this.remote);
+ return this;
+ }
+
private String resolvePathIfRelative(@Nonnull FilePath base, @Nonnull String rel) {
if(isAbsolute(rel)) return rel;
if(base.isUnix()) {
@@ -302,7 +315,8 @@ public final class FilePath implements Serializable {
* {@link File#getParent()} etc cannot handle ".." and "." in the path component very well,
* so remove them.
*/
- private static String normalize(@Nonnull String path) {
+ @Restricted(NoExternalUse.class)
+ public static String normalize(@Nonnull String path) {
StringBuilder buf = new StringBuilder();
// Check for prefix designating absolute path
Matcher m = ABSOLUTE_PREFIX_PATTERN.matcher(path);
@@ -466,7 +480,18 @@ public final class FilePath implements Serializable {
*/
public int archive(final ArchiverFactory factory, OutputStream os, final DirScanner scanner) throws IOException, InterruptedException {
final OutputStream out = (channel!=null)?new RemoteOutputStream(os):os;
- return act(new SecureFileCallable() {
+ return act(new Archive(factory, out, scanner));
+ }
+ private class Archive extends SecureFileCallable {
+ private final ArchiverFactory factory;
+ private final OutputStream out;
+ private final DirScanner scanner;
+ Archive(ArchiverFactory factory, OutputStream out, DirScanner scanner) {
+ this.factory = factory;
+ this.out = out;
+ this.scanner = scanner;
+ }
+ @Override
public Integer invoke(File f, VirtualChannel channel) throws IOException {
Archiver a = factory.create(out);
try {
@@ -478,7 +503,6 @@ public final class FilePath implements Serializable {
}
private static final long serialVersionUID = 1L;
- });
}
public int archive(final ArchiverFactory factory, OutputStream os, final FileFilter filter) throws IOException, InterruptedException {
@@ -501,27 +525,32 @@ public final class FilePath implements Serializable {
// TODO: post release, re-unite two branches by introducing FileStreamCallable that resolves InputStream
if (this.channel!=target.channel) {// local -> remote or remote->local
final RemoteInputStream in = new RemoteInputStream(read(), Flag.GREEDY);
- target.act(new SecureFileCallable() {
- public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
- unzip(dir, in);
- return null;
- }
-
- private static final long serialVersionUID = 1L;
- });
+ target.act(new UnzipRemote(in));
} else {// local -> local or remote->remote
- target.act(new SecureFileCallable() {
-
- public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
- assert !FilePath.this.isRemote(); // this.channel==target.channel above
- unzip(dir, reading(new File(FilePath.this.getRemote()))); // shortcut to local file
- return null;
- }
-
- private static final long serialVersionUID = 1L;
- });
+ target.act(new UnzipLocal());
}
}
+ private class UnzipRemote extends SecureFileCallable {
+ private final RemoteInputStream in;
+ UnzipRemote(RemoteInputStream in) {
+ this.in = in;
+ }
+ @Override
+ public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
+ unzip(dir, in);
+ return null;
+ }
+ private static final long serialVersionUID = 1L;
+ }
+ private class UnzipLocal extends SecureFileCallable {
+ @Override
+ public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
+ assert !FilePath.this.isRemote(); // this.channel==target.channel above
+ unzip(dir, reading(new File(FilePath.this.getRemote()))); // shortcut to local file
+ return null;
+ }
+ private static final long serialVersionUID = 1L;
+ }
/**
* When this {@link FilePath} represents a tar file, extracts that tar file.
@@ -537,24 +566,37 @@ public final class FilePath implements Serializable {
// TODO: post release, re-unite two branches by introducing FileStreamCallable that resolves InputStream
if (this.channel!=target.channel) {// local -> remote or remote->local
final RemoteInputStream in = new RemoteInputStream(read(), Flag.GREEDY);
- target.act(new SecureFileCallable() {
- public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
- readFromTar(FilePath.this.getName(),dir,compression.extract(in));
- return null;
- }
-
- private static final long serialVersionUID = 1L;
- });
+ target.act(new UntarRemote(compression, in));
} else {// local -> local or remote->remote
- target.act(new SecureFileCallable() {
- public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
- readFromTar(FilePath.this.getName(),dir,compression.extract(FilePath.this.read()));
- return null;
- }
- private static final long serialVersionUID = 1L;
- });
+ target.act(new UntarLocal(compression));
}
}
+ private class UntarRemote extends SecureFileCallable {
+ private final TarCompression compression;
+ private final RemoteInputStream in;
+ UntarRemote(TarCompression compression, RemoteInputStream in) {
+ this.compression = compression;
+ this.in = in;
+ }
+ @Override
+ public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
+ readFromTar(FilePath.this.getName(), dir, compression.extract(in));
+ return null;
+ }
+ private static final long serialVersionUID = 1L;
+ }
+ private class UntarLocal extends SecureFileCallable {
+ private final TarCompression compression;
+ UntarLocal(TarCompression compression) {
+ this.compression = compression;
+ }
+ @Override
+ public Void invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
+ readFromTar(FilePath.this.getName(), dir, compression.extract(FilePath.this.read()));
+ return null;
+ }
+ private static final long serialVersionUID = 1L;
+ }
/**
* Reads the given InputStream as a zip file and extracts it into this directory.
@@ -566,13 +608,19 @@ public final class FilePath implements Serializable {
*/
public void unzipFrom(InputStream _in) throws IOException, InterruptedException {
final InputStream in = new RemoteInputStream(_in, Flag.GREEDY);
- act(new SecureFileCallable() {
- public Void invoke(File dir, VirtualChannel channel) throws IOException {
- unzip(dir, in);
- return null;
- }
- private static final long serialVersionUID = 1L;
- });
+ act(new UnzipFrom(in));
+ }
+ private class UnzipFrom extends SecureFileCallable {
+ private final InputStream in;
+ UnzipFrom(InputStream in) {
+ this.in = in;
+ }
+ @Override
+ public Void invoke(File dir, VirtualChannel channel) throws IOException {
+ unzip(dir, in);
+ return null;
+ }
+ private static final long serialVersionUID = 1L;
}
private void unzip(File dir, InputStream in) throws IOException {
@@ -597,6 +645,10 @@ public final class FilePath implements Serializable {
while (entries.hasMoreElements()) {
ZipEntry e = entries.nextElement();
File f = new File(dir, e.getName());
+ if (!f.toPath().normalize().startsWith(dir.toPath())) {
+ throw new IOException(
+ "Zip " + zipFile.getPath() + " contains illegal file name that breaks out of the target directory: " + e.getName());
+ }
if (e.isDirectory()) {
mkdirs(f);
} else {
@@ -627,12 +679,13 @@ public final class FilePath implements Serializable {
* Absolutizes this {@link FilePath} and returns the new one.
*/
public FilePath absolutize() throws IOException, InterruptedException {
- return new FilePath(channel,act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public String invoke(File f, VirtualChannel channel) throws IOException {
- return f.getAbsolutePath();
- }
- }));
+ return new FilePath(channel, act(new Absolutize()));
+ }
+ private static class Absolutize extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ public String invoke(File f, VirtualChannel channel) throws IOException {
+ return f.getAbsolutePath();
+ }
}
/**
@@ -645,14 +698,22 @@ public final class FilePath implements Serializable {
* @since 1.456
*/
public void symlinkTo(final String target, final TaskListener listener) throws IOException, InterruptedException {
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
- symlinking(f);
- Util.createSymlink(f.getParentFile(),target,f.getName(),listener);
- return null;
- }
- });
+ act(new SymlinkTo(target, listener));
+ }
+ private class SymlinkTo extends SecureFileCallable {
+ private final String target;
+ private final TaskListener listener;
+ SymlinkTo(String target, TaskListener listener) {
+ this.target = target;
+ this.listener = listener;
+ }
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
+ symlinking(f);
+ Util.createSymlink(f.getParentFile(), target, f.getName(), listener);
+ return null;
+ }
}
/**
@@ -663,12 +724,14 @@ public final class FilePath implements Serializable {
* @since 1.456
*/
public String readLink() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public String invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
- return Util.resolveSymlink(reading(f));
- }
- });
+ return act(new ReadLink());
+ }
+ private class ReadLink extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public String invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
+ return Util.resolveSymlink(reading(f));
+ }
}
@Override
@@ -732,17 +795,25 @@ public final class FilePath implements Serializable {
public void untarFrom(InputStream _in, final TarCompression compression) throws IOException, InterruptedException {
try {
final InputStream in = new RemoteInputStream(_in, Flag.GREEDY);
- act(new SecureFileCallable() {
- public Void invoke(File dir, VirtualChannel channel) throws IOException {
- readFromTar("input stream",dir, compression.extract(in));
- return null;
- }
- private static final long serialVersionUID = 1L;
- });
+ act(new UntarFrom(compression, in));
} finally {
_in.close();
}
}
+ private class UntarFrom extends SecureFileCallable {
+ private final TarCompression compression;
+ private final InputStream in;
+ UntarFrom(TarCompression compression, InputStream in) {
+ this.compression = compression;
+ this.in = in;
+ }
+ @Override
+ public Void invoke(File dir, VirtualChannel channel) throws IOException {
+ readFromTar("input stream",dir, compression.extract(in));
+ return null;
+ }
+ private static final long serialVersionUID = 1L;
+ }
/**
* Given a tgz/zip file, extracts it to the given target directory, if necessary.
@@ -892,9 +963,10 @@ public final class FilePath implements Serializable {
}
/**
- * Reads the URL on the current VM, and writes all the data to this {@link FilePath}
- * (this is different from resolving URL remotely.)
- *
+ * Reads the URL on the current VM, and streams the data to this file using the Remoting channel.
+ * This is different from resolving URL remotely.
+ * If you instead wished to open an HTTP(S) URL on the remote side,
+ * prefer {@code RobustHTTPClient.copyFromRemotely}.
* @since 1.293
*/
public void copyFrom(URL url) throws IOException, InterruptedException {
@@ -998,11 +1070,6 @@ public final class FilePath implements Serializable {
return channel.call(wrapper);
} catch (TunneledInterruptedException e) {
throw (InterruptedException)new InterruptedException(e.getMessage()).initCause(e);
- } catch (AbortException e) {
- throw e; // pass through so that the caller can catch it as AbortException
- } catch (IOException e) {
- // wrap it into a new IOException so that we get the caller's stack trace as well.
- throw new IOException("remote file operation failed: " + remote + " at " + channel + ": " + e, e);
}
} else {
// the file is on the local machine.
@@ -1105,23 +1172,28 @@ public final class FilePath implements Serializable {
* @since 1.522
*/
public Callable asCallableWith(final FileCallable task) {
- return new Callable() {
- @Override
- public V call() throws IOException {
- try {
- return act(task);
- } catch (InterruptedException e) {
- throw (IOException)new InterruptedIOException().initCause(e);
- }
+ return new CallableWith<>(task);
+ }
+ private class CallableWith implements Callable {
+ private final FileCallable task;
+ CallableWith(FileCallable task) {
+ this.task = task;
+ }
+ @Override
+ public V call() throws IOException {
+ try {
+ return act(task);
+ } catch (InterruptedException e) {
+ throw (IOException)new InterruptedIOException().initCause(e);
}
+ }
- @Override
- public void checkRoles(RoleChecker checker) throws SecurityException {
- task.checkRoles(checker);
- }
+ @Override
+ public void checkRoles(RoleChecker checker) throws SecurityException {
+ task.checkRoles(checker);
+ }
- private static final long serialVersionUID = 1L;
- };
+ private static final long serialVersionUID = 1L;
}
/**
@@ -1129,12 +1201,14 @@ public final class FilePath implements Serializable {
* on which this file is available.
*/
public URI toURI() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public URI invoke(File f, VirtualChannel channel) {
- return f.toURI();
- }
- });
+ return act(new ToURI());
+ }
+ private static class ToURI extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public URI invoke(File f, VirtualChannel channel) {
+ return f.toURI();
+ }
}
/**
@@ -1167,45 +1241,52 @@ public final class FilePath implements Serializable {
* Creates this directory.
*/
public void mkdirs() throws IOException, InterruptedException {
- if(!act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Boolean invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
- if(mkdirs(f) || f.exists())
- return true; // OK
+ if (!act(new Mkdirs())) {
+ throw new IOException("Failed to mkdirs: " + remote);
+ }
+ }
+ private class Mkdirs extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Boolean invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
+ if(mkdirs(f) || f.exists())
+ return true; // OK
- // following Ant task to avoid possible race condition.
- Thread.sleep(10);
+ // following Ant task to avoid possible race condition.
+ Thread.sleep(10);
- return mkdirs(f) || f.exists();
- }
- }))
- throw new IOException("Failed to mkdirs: "+remote);
+ return mkdirs(f) || f.exists();
+ }
}
/**
* Deletes this directory, including all its contents recursively.
*/
public void deleteRecursive() throws IOException, InterruptedException {
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- deleteRecursive(deleting(f));
- return null;
- }
- });
+ act(new DeleteRecursive());
+ }
+ private class DeleteRecursive extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ deleteRecursive(deleting(f));
+ return null;
+ }
}
/**
* Deletes all the contents of this directory, but not the directory itself
*/
public void deleteContents() throws IOException, InterruptedException {
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- deleteContentsRecursive(f);
- return null;
- }
- });
+ act(new DeleteContents());
+ }
+ private class DeleteContents extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ deleteContentsRecursive(f);
+ return null;
+ }
}
private void deleteRecursive(File dir) throws IOException {
@@ -1316,17 +1397,25 @@ public final class FilePath implements Serializable {
*/
public FilePath createTempFile(final String prefix, final String suffix) throws IOException, InterruptedException {
try {
- return new FilePath(this,act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public String invoke(File dir, VirtualChannel channel) throws IOException {
- File f = writing(File.createTempFile(prefix, suffix, dir));
- return f.getName();
- }
- }));
+ return new FilePath(this, act(new CreateTempFile(prefix, suffix)));
} catch (IOException e) {
throw new IOException("Failed to create a temp file on "+remote,e);
}
}
+ private class CreateTempFile extends SecureFileCallable {
+ private final String prefix;
+ private final String suffix;
+ CreateTempFile(String prefix, String suffix) {
+ this.prefix = prefix;
+ this.suffix = suffix;
+ }
+ private static final long serialVersionUID = 1L;
+ @Override
+ public String invoke(File dir, VirtualChannel channel) throws IOException {
+ File f = writing(File.createTempFile(prefix, suffix, dir));
+ return f.getName();
+ }
+ }
/**
* Creates a temporary file in this directory and set the contents to the
@@ -1372,30 +1461,42 @@ public final class FilePath implements Serializable {
*/
public FilePath createTextTempFile(final String prefix, final String suffix, final String contents, final boolean inThisDirectory) throws IOException, InterruptedException {
try {
- return new FilePath(channel,act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public String invoke(File dir, VirtualChannel channel) throws IOException {
- if(!inThisDirectory)
- dir = new File(System.getProperty("java.io.tmpdir"));
- else
- mkdirs(dir);
+ return new FilePath(channel, act(new CreateTextTempFile(inThisDirectory, prefix, suffix, contents)));
+ } catch (IOException e) {
+ throw new IOException("Failed to create a temp file on "+remote,e);
+ }
+ }
+ private final class CreateTextTempFile extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ private final boolean inThisDirectory;
+ private final String prefix;
+ private final String suffix;
+ private final String contents;
+ CreateTextTempFile(boolean inThisDirectory, String prefix, String suffix, String contents) {
+ this.inThisDirectory = inThisDirectory;
+ this.prefix = prefix;
+ this.suffix = suffix;
+ this.contents = contents;
+ }
+ @Override
+ public String invoke(File dir, VirtualChannel channel) throws IOException {
+ if(!inThisDirectory)
+ dir = new File(System.getProperty("java.io.tmpdir"));
+ else
+ mkdirs(dir);
- File f;
- try {
- f = creating(File.createTempFile(prefix, suffix, dir));
- } catch (IOException e) {
- throw new IOException("Failed to create a temporary directory in "+dir,e);
- }
+ File f;
+ try {
+ f = creating(File.createTempFile(prefix, suffix, dir));
+ } catch (IOException e) {
+ throw new IOException("Failed to create a temporary directory in "+dir,e);
+ }
- try (Writer w = new FileWriter(writing(f))) {
- w.write(contents);
- }
+ try (Writer w = new FileWriter(writing(f))) {
+ w.write(contents);
+ }
- return f.getAbsolutePath();
- }
- }));
- } catch (IOException e) {
- throw new IOException("Failed to create a temp file on "+remote,e);
+ return f.getAbsolutePath();
}
}
@@ -1422,29 +1523,35 @@ public final class FilePath implements Serializable {
s = new String[]{prefix, suffix};
}
String name = StringUtils.join(s, ".");
- return new FilePath(this,act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public String invoke(File dir, VirtualChannel channel) throws IOException {
+ return new FilePath(this, act(new CreateTempDir(name)));
+ } catch (IOException e) {
+ throw new IOException("Failed to create a temp directory on "+remote,e);
+ }
+ }
+ private class CreateTempDir extends SecureFileCallable {
+ private final String name;
+ CreateTempDir(String name) {
+ this.name = name;
+ }
+ private static final long serialVersionUID = 1L;
+ @Override
+ public String invoke(File dir, VirtualChannel channel) throws IOException {
- Path tempPath;
- final boolean isPosix = FileSystems.getDefault().supportedFileAttributeViews().contains("posix");
+ Path tempPath;
+ final boolean isPosix = FileSystems.getDefault().supportedFileAttributeViews().contains("posix");
- if (isPosix) {
- tempPath = Files.createTempDirectory(Util.fileToPath(dir), name,
- PosixFilePermissions.asFileAttribute(EnumSet.allOf(PosixFilePermission.class)));
- } else {
- tempPath = Files.createTempDirectory(Util.fileToPath(dir), name, new FileAttribute[] {});
- }
+ if (isPosix) {
+ tempPath = Files.createTempDirectory(Util.fileToPath(dir), name,
+ PosixFilePermissions.asFileAttribute(EnumSet.allOf(PosixFilePermission.class)));
+ } else {
+ tempPath = Files.createTempDirectory(Util.fileToPath(dir), name, new FileAttribute[] {});
+ }
- if (tempPath.toFile() == null) {
- throw new IOException("Failed to obtain file from path " + dir + " on " + remote);
- }
- return tempPath.toFile().getName();
+ if (tempPath.toFile() == null) {
+ throw new IOException("Failed to obtain file from path " + dir + " on " + remote);
}
- }));
- } catch (IOException e) {
- throw new IOException("Failed to create a temp directory on "+remote,e);
- }
+ return tempPath.toFile().getName();
+ }
}
/**
@@ -1453,26 +1560,30 @@ public final class FilePath implements Serializable {
* @return true, for a modicum of compatibility
*/
public boolean delete() throws IOException, InterruptedException {
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- Util.deleteFile(deleting(f));
- return null;
- }
- });
+ act(new Delete());
return true;
}
+ private class Delete extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ Util.deleteFile(deleting(f));
+ return null;
+ }
+ }
/**
* Checks if the file exists.
*/
public boolean exists() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Boolean invoke(File f, VirtualChannel channel) throws IOException {
- return stating(f).exists();
- }
- });
+ return act(new Exists());
+ }
+ private class Exists extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Boolean invoke(File f, VirtualChannel channel) throws IOException {
+ return stating(f).exists();
+ }
}
/**
@@ -1483,12 +1594,14 @@ public final class FilePath implements Serializable {
* @see #touch(long)
*/
public long lastModified() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Long invoke(File f, VirtualChannel channel) throws IOException {
- return stating(f).lastModified();
- }
- });
+ return act(new LastModified());
+ }
+ private class LastModified extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Long invoke(File f, VirtualChannel channel) throws IOException {
+ return stating(f).lastModified();
+ }
}
/**
@@ -1497,8 +1610,15 @@ public final class FilePath implements Serializable {
* @since 1.299
*/
public void touch(final long timestamp) throws IOException, InterruptedException {
- act(new SecureFileCallable() {
+ act(new Touch(timestamp));
+ }
+ private class Touch extends SecureFileCallable {
+ private final long timestamp;
+ Touch(long timestamp) {
+ this.timestamp = timestamp;
+ }
private static final long serialVersionUID = -5094638816500738429L;
+ @Override
public Void invoke(File f, VirtualChannel channel) throws IOException {
if(!f.exists()) {
try {
@@ -1511,12 +1631,22 @@ public final class FilePath implements Serializable {
throw new IOException("Failed to set the timestamp of "+f+" to "+timestamp);
return null;
}
- });
}
private void setLastModifiedIfPossible(final long timestamp) throws IOException, InterruptedException {
- String message = act(new SecureFileCallable() {
+ String message = act(new SetLastModified(timestamp));
+
+ if (message!=null) {
+ LOGGER.warning(message);
+ }
+ }
+ private class SetLastModified extends SecureFileCallable {
+ private final long timestamp;
+ SetLastModified(long timestamp) {
+ this.timestamp = timestamp;
+ }
private static final long serialVersionUID = -828220335793641630L;
+ @Override
public String invoke(File f, VirtualChannel channel) throws IOException {
if(!writing(f).setLastModified(timestamp)) {
if (Functions.isWindows()) {
@@ -1529,23 +1659,20 @@ public final class FilePath implements Serializable {
}
return null;
}
- });
-
- if (message!=null) {
- LOGGER.warning(message);
- }
}
/**
* Checks if the file is a directory.
*/
public boolean isDirectory() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Boolean invoke(File f, VirtualChannel channel) throws IOException {
- return stating(f).isDirectory();
- }
- });
+ return act(new IsDirectory());
+ }
+ private final class IsDirectory extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Boolean invoke(File f, VirtualChannel channel) throws IOException {
+ return stating(f).isDirectory();
+ }
}
/**
@@ -1554,12 +1681,14 @@ public final class FilePath implements Serializable {
* @since 1.129
*/
public long length() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Long invoke(File f, VirtualChannel channel) throws IOException {
- return stating(f).length();
- }
- });
+ return act(new Length());
+ }
+ private class Length extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Long invoke(File f, VirtualChannel channel) throws IOException {
+ return stating(f).length();
+ }
}
/**
@@ -1567,12 +1696,14 @@ public final class FilePath implements Serializable {
* @since 1.542
*/
public long getFreeDiskSpace() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- @Override public Long invoke(File f, VirtualChannel channel) throws IOException {
- return f.getFreeSpace();
- }
- });
+ return act(new GetFreeDiskSpace());
+ }
+ private static class GetFreeDiskSpace extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Long invoke(File f, VirtualChannel channel) throws IOException {
+ return f.getFreeSpace();
+ }
}
/**
@@ -1580,12 +1711,14 @@ public final class FilePath implements Serializable {
* @since 1.542
*/
public long getTotalDiskSpace() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- @Override public Long invoke(File f, VirtualChannel channel) throws IOException {
- return f.getTotalSpace();
- }
- });
+ return act(new GetTotalDiskSpace());
+ }
+ private static class GetTotalDiskSpace extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Long invoke(File f, VirtualChannel channel) throws IOException {
+ return f.getTotalSpace();
+ }
}
/**
@@ -1593,12 +1726,14 @@ public final class FilePath implements Serializable {
* @since 1.542
*/
public long getUsableDiskSpace() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- @Override public Long invoke(File f, VirtualChannel channel) throws IOException {
- return f.getUsableSpace();
- }
- });
+ return act(new GetUsableDiskSpace());
+ }
+ private static class GetUsableDiskSpace extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Long invoke(File f, VirtualChannel channel) throws IOException {
+ return f.getUsableSpace();
+ }
}
/**
@@ -1623,14 +1758,20 @@ public final class FilePath implements Serializable {
*/
public void chmod(final int mask) throws IOException, InterruptedException {
if(!isUnix() || mask==-1) return;
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- _chmod(writing(f), mask);
+ act(new Chmod(mask));
+ }
+ private class Chmod extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ private final int mask;
+ Chmod(int mask) {
+ this.mask = mask;
+ }
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ _chmod(writing(f), mask);
- return null;
- }
- });
+ return null;
+ }
}
/**
@@ -1660,12 +1801,14 @@ public final class FilePath implements Serializable {
*/
public int mode() throws IOException, InterruptedException, PosixException {
if(!isUnix()) return -1;
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Integer invoke(File f, VirtualChannel channel) throws IOException {
- return IOUtils.mode(stating(f));
- }
- });
+ return act(new Mode());
+ }
+ private class Mode extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Integer invoke(File f, VirtualChannel channel) throws IOException {
+ return IOUtils.mode(stating(f));
+ }
}
/**
@@ -1710,8 +1853,15 @@ public final class FilePath implements Serializable {
if (filter != null && !(filter instanceof Serializable)) {
throw new IllegalArgumentException("Non-serializable filter of " + filter.getClass());
}
- return act(new SecureFileCallable>() {
+ return act(new ListFilter(filter), (filter != null ? filter : this).getClass().getClassLoader());
+ }
+ private class ListFilter extends SecureFileCallable> {
+ private final FileFilter filter;
+ ListFilter(FileFilter filter) {
+ this.filter = filter;
+ }
private static final long serialVersionUID = 1L;
+ @Override
public List invoke(File f, VirtualChannel channel) throws IOException {
File[] children = reading(f).listFiles(filter);
if (children == null) {
@@ -1724,7 +1874,6 @@ public final class FilePath implements Serializable {
return r;
}
- }, (filter!=null?filter:this).getClass().getClassLoader());
}
/**
@@ -1768,8 +1917,19 @@ public final class FilePath implements Serializable {
*/
@Nonnull
public FilePath[] list(final String includes, final String excludes, final boolean defaultExcludes) throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
+ return act(new ListGlob(includes, excludes, defaultExcludes));
+ }
+ private class ListGlob extends SecureFileCallable {
+ private final String includes;
+ private final String excludes;
+ private final boolean defaultExcludes;
+ ListGlob(String includes, String excludes, boolean defaultExcludes) {
+ this.includes = includes;
+ this.excludes = excludes;
+ this.defaultExcludes = defaultExcludes;
+ }
private static final long serialVersionUID = 1L;
+ @Override
public FilePath[] invoke(File f, VirtualChannel channel) throws IOException {
String[] files = glob(reading(f), includes, excludes, defaultExcludes);
@@ -1779,7 +1939,6 @@ public final class FilePath implements Serializable {
return r;
}
- });
}
/**
@@ -1794,7 +1953,12 @@ public final class FilePath implements Serializable {
throw new IOException("Expecting Ant GLOB pattern, but saw '"+includes+"'. See http://ant.apache.org/manual/Types/fileset.html for syntax");
FileSet fs = Util.createFileSet(dir,includes,excludes);
fs.setDefaultexcludes(defaultExcludes);
- DirectoryScanner ds = fs.getDirectoryScanner(new Project());
+ DirectoryScanner ds;
+ try {
+ ds = fs.getDirectoryScanner(new Project());
+ } catch (BuildException x) {
+ throw new IOException(x.getMessage());
+ }
String[] files = ds.getIncludedFiles();
return files;
}
@@ -1812,25 +1976,29 @@ public final class FilePath implements Serializable {
}
final Pipe p = Pipe.createRemoteToLocal();
- actAsync(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
-
- @Override
- public Void invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
- try (InputStream fis = Files.newInputStream(reading(f).toPath());
- 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);
- }
- return null;
- }
- });
+ actAsync(new Read(p));
return p.getIn();
}
+ private class Read extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ private final Pipe p;
+ Read(Pipe p) {
+ this.p = p;
+ }
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
+ try (InputStream fis = Files.newInputStream(reading(f).toPath());
+ 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);
+ }
+ return null;
+ }
+ }
/**
* Reads this file from the specific offset.
@@ -1929,8 +2097,11 @@ public final class FilePath implements Serializable {
}
}
- return act(new SecureFileCallable() {
+ return act(new WritePipe());
+ }
+ private class WritePipe extends SecureFileCallable {
private static final long serialVersionUID = 1L;
+ @Override
public OutputStream invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
f = f.getAbsoluteFile();
mkdirs(f.getParentFile());
@@ -1941,7 +2112,6 @@ public final class FilePath implements Serializable {
throw new IOException(e);
}
}
- });
}
/**
@@ -1952,19 +2122,27 @@ public final class FilePath implements Serializable {
* @since 1.105
*/
public void write(final String content, final String encoding) throws IOException, InterruptedException {
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- mkdirs(f.getParentFile());
- try (OutputStream fos = Files.newOutputStream(writing(f).toPath());
- Writer w = encoding != null ? new OutputStreamWriter(fos, encoding) : new OutputStreamWriter(fos)) {
- w.write(content);
- } catch (InvalidPathException e) {
- throw new IOException(e);
- }
- return null;
+ act(new Write(encoding, content));
+ }
+ private class Write extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ private final String encoding;
+ private final String content;
+ Write(String encoding, String content) {
+ this.encoding = encoding;
+ this.content = content;
+ }
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ mkdirs(f.getParentFile());
+ try (OutputStream fos = Files.newOutputStream(writing(f).toPath());
+ Writer w = encoding != null ? new OutputStreamWriter(fos, encoding) : new OutputStreamWriter(fos)) {
+ w.write(content);
+ } catch (InvalidPathException e) {
+ throw new IOException(e);
}
- });
+ return null;
+ }
}
/**
@@ -1972,12 +2150,14 @@ public final class FilePath implements Serializable {
* @see Util#getDigestOf(File)
*/
public String digest() throws IOException, InterruptedException {
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public String invoke(File f, VirtualChannel channel) throws IOException {
- return Util.getDigestOf(reading(f));
- }
- });
+ return act(new Digest());
+ }
+ private class Digest extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ @Override
+ public String invoke(File f, VirtualChannel channel) throws IOException {
+ return Util.getDigestOf(reading(f));
+ }
}
/**
@@ -1988,13 +2168,19 @@ public final class FilePath implements Serializable {
if(this.channel != target.channel) {
throw new IOException("renameTo target must be on the same host");
}
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- Files.move(fileToPath(reading(f)), fileToPath(creating(new File(target.remote))), LinkOption.NOFOLLOW_LINKS);
- return null;
- }
- });
+ act(new RenameTo(target));
+ }
+ private class RenameTo extends SecureFileCallable {
+ private final FilePath target;
+ RenameTo(FilePath target) {
+ this.target = target;
+ }
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ Files.move(fileToPath(reading(f)), fileToPath(creating(new File(target.remote))), LinkOption.NOFOLLOW_LINKS);
+ return null;
+ }
}
/**
@@ -2006,8 +2192,15 @@ public final class FilePath implements Serializable {
if(this.channel != target.channel) {
throw new IOException("pullUpTo target must be on the same host");
}
- act(new SecureFileCallable() {
+ act(new MoveAllChildrenTo(target));
+ }
+ private class MoveAllChildrenTo extends SecureFileCallable {
+ private final FilePath target;
+ MoveAllChildrenTo(FilePath target) {
+ this.target = target;
+ }
private static final long serialVersionUID = 1L;
+ @Override
public Void invoke(File f, VirtualChannel channel) throws IOException {
// JENKINS-16846: if f.getName() is the same as one of the files/directories in f,
// then the rename op will fail
@@ -2016,7 +2209,7 @@ public final class FilePath implements Serializable {
throw new IOException("Failed to rename "+f+" to "+tmp);
File t = new File(target.getRemote());
-
+
for(File child : reading(tmp).listFiles()) {
File target = new File(t, child.getName());
if(!stating(child).renameTo(creating(target)))
@@ -2025,7 +2218,6 @@ public final class FilePath implements Serializable {
deleting(tmp).delete();
return null;
}
- });
}
/**
@@ -2048,16 +2240,7 @@ public final class FilePath implements Serializable {
public void copyToWithPermission(FilePath target) throws IOException, InterruptedException {
// Use NIO copy with StandardCopyOption.COPY_ATTRIBUTES when copying on the same machine.
if (this.channel == target.channel) {
- act(new SecureFileCallable() {
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- File targetFile = new File(target.remote);
- File targetDir = targetFile.getParentFile();
- filterNonNull().mkdirs(targetDir);
- Files.createDirectories(fileToPath(targetDir));
- Files.copy(fileToPath(reading(f)), fileToPath(writing(targetFile)), StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
- return null;
- }
- });
+ act(new CopyToWithPermission(target));
return;
}
@@ -2066,6 +2249,21 @@ public final class FilePath implements Serializable {
target.chmod(mode());
target.setLastModifiedIfPossible(lastModified());
}
+ private class CopyToWithPermission extends SecureFileCallable {
+ private final FilePath target;
+ CopyToWithPermission(FilePath target) {
+ this.target = target;
+ }
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ File targetFile = new File(target.remote);
+ File targetDir = targetFile.getParentFile();
+ filterNonNull().mkdirs(targetDir);
+ Files.createDirectories(fileToPath(targetDir));
+ Files.copy(fileToPath(reading(f)), fileToPath(writing(targetFile)), StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
+ return null;
+ }
+ }
/**
* Sends the contents of this file into the given {@link OutputStream}.
@@ -2073,24 +2271,30 @@ public final class FilePath implements Serializable {
public void copyTo(OutputStream os) throws IOException, InterruptedException {
final OutputStream out = new RemoteOutputStream(os);
- act(new SecureFileCallable() {
- private static final long serialVersionUID = 4088559042349254141L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- try (InputStream fis = Files.newInputStream(reading(f).toPath())) {
- org.apache.commons.io.IOUtils.copy(fis, out);
- return null;
- } catch (InvalidPathException e) {
- throw new IOException(e);
- } finally {
- out.close();
- }
- }
- });
+ act(new CopyTo(out));
// make sure the writes fully got delivered to 'os' before we return.
// this is needed because I/O operation is asynchronous
syncIO();
}
+ private class CopyTo extends SecureFileCallable {
+ private static final long serialVersionUID = 4088559042349254141L;
+ private final OutputStream out;
+ CopyTo(OutputStream out) {
+ this.out = out;
+ }
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ try (InputStream fis = Files.newInputStream(reading(f).toPath())) {
+ org.apache.commons.io.IOUtils.copy(fis, out);
+ return null;
+ } catch (InvalidPathException e) {
+ throw new IOException(e);
+ } finally {
+ out.close();
+ }
+ }
+ }
/**
* With fix to JENKINS-11251 (remoting 2.15), this is no longer necessary.
@@ -2105,7 +2309,7 @@ public final class FilePath implements Serializable {
// legacy agent.jar. Handle this gracefully
try {
LOGGER.log(Level.WARNING,"Looks like an old agent.jar. Please update "+ Which.jarFile(Channel.class)+" to the new version",e);
- } catch (IOException _) {
+ } catch (IOException ignored) {
// really ignore this time
}
}
@@ -2188,64 +2392,14 @@ public final class FilePath implements Serializable {
public int copyRecursiveTo(final DirScanner scanner, final FilePath target, final String description) throws IOException, InterruptedException {
if(this.channel==target.channel) {
// local to local copy.
- return act(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Integer invoke(File base, VirtualChannel channel) throws IOException {
- if(!base.exists()) return 0;
- assert target.channel==null;
- final File dest = new File(target.remote);
- final AtomicInteger count = new AtomicInteger();
- scanner.scan(base, reading(new FileVisitor() {
- @Override
- public void visit(File f, String relativePath) throws IOException {
- if (f.isFile()) {
- File target = new File(dest, relativePath);
- mkdirsE(target.getParentFile());
- Util.copyFile(f, writing(target));
- count.incrementAndGet();
- }
- }
-
- @Override
- public boolean understandsSymlink() {
- return true;
- }
-
- @Override
- public void visitSymlink(File link, String target, String relativePath) throws IOException {
- try {
- mkdirsE(new File(dest, relativePath).getParentFile());
- writing(new File(dest, target));
- Util.createSymlink(dest, target, relativePath, TaskListener.NULL);
- } catch (InterruptedException x) {
- throw new IOException(x);
- }
- count.incrementAndGet();
- }
- }));
- return count.get();
- }
- });
+ return act(new CopyRecursiveLocal(target, scanner));
} else
if(this.channel==null) {
// local -> remote copy
final Pipe pipe = Pipe.createLocalToRemote();
- Future future = target.actAsync(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Void invoke(File f, VirtualChannel channel) throws IOException {
- try (InputStream in = pipe.getIn()) {
- readFromTar(remote + '/' + description, f,TarCompression.GZIP.extract(in));
- return null;
- }
- }
- });
- Future future2 = actAsync(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- @Override public Integer invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
- return writeToTar(new File(remote), scanner, TarCompression.GZIP.compress(pipe.getOut()));
- }
- });
+ Future future = target.actAsync(new ReadToTar(pipe, description));
+ Future future2 = actAsync(new WriteToTar(scanner, pipe));
try {
// JENKINS-9540 in case the reading side failed, report that error first
future.get();
@@ -2262,14 +2416,7 @@ public final class FilePath implements Serializable {
// remote -> local copy
final Pipe pipe = Pipe.createRemoteToLocal();
- Future future = actAsync(new SecureFileCallable() {
- private static final long serialVersionUID = 1L;
- public Integer invoke(File f, VirtualChannel channel) throws IOException {
- try (OutputStream out = pipe.getOut()) {
- return writeToTar(f, scanner, TarCompression.GZIP.compress(out));
- }
- }
- });
+ Future future = actAsync(new CopyRecursiveRemoteToLocal(pipe, scanner));
try {
readFromTar(remote + '/' + description,new File(target.remote),TarCompression.GZIP.extract(pipe.getIn()));
} catch (IOException e) {// BuildException or IOException
@@ -2280,8 +2427,8 @@ public final class FilePath implements Serializable {
// report both errors
e.addSuppressed(x);
throw e;
- } catch (TimeoutException _) {
- // remote is hanging
+ } catch (TimeoutException ignored) {
+ // remote is hanging, just throw the original exception
throw e;
}
}
@@ -2297,7 +2444,117 @@ public final class FilePath implements Serializable {
}
}
}
-
+ private class CopyRecursiveLocal extends SecureFileCallable {
+ private final FilePath target;
+ private final DirScanner scanner;
+ CopyRecursiveLocal(FilePath target, DirScanner scanner) {
+ this.target = target;
+ this.scanner = scanner;
+ }
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Integer invoke(File base, VirtualChannel channel) throws IOException {
+ if (!base.exists()) {
+ return 0;
+ }
+ assert target.channel == null;
+ final File dest = new File(target.remote);
+ final AtomicInteger count = new AtomicInteger();
+ scanner.scan(base, reading(new FileVisitor() {
+ private boolean exceptionEncountered;
+ private boolean logMessageShown;
+ @Override
+ public void visit(File f, String relativePath) throws IOException {
+ if (f.isFile()) {
+ File target = new File(dest, relativePath);
+ mkdirsE(target.getParentFile());
+ Path targetPath = fileToPath(writing(target));
+ exceptionEncountered = exceptionEncountered || !tryCopyWithAttributes(f, targetPath);
+ if (exceptionEncountered) {
+ Files.copy(fileToPath(f), targetPath, StandardCopyOption.REPLACE_EXISTING);
+ if (!logMessageShown) {
+ LOGGER.log(Level.INFO,
+ "JENKINS-52325: Jenkins failed to retain attributes when copying to {0}, so proceeding without attributes.",
+ dest.getAbsolutePath());
+ logMessageShown = true;
+ }
+ }
+ count.incrementAndGet();
+ }
+ }
+ private boolean tryCopyWithAttributes(File f, Path targetPath) {
+ try {
+ Files.copy(fileToPath(f), targetPath,
+ StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
+ } catch (IOException e) {
+ LOGGER.log(Level.FINE, "Unable to copy: {0}", e.getMessage());
+ return false;
+ }
+ return true;
+ }
+ @Override
+ public boolean understandsSymlink() {
+ return true;
+ }
+ @Override
+ public void visitSymlink(File link, String target, String relativePath) throws IOException {
+ try {
+ mkdirsE(new File(dest, relativePath).getParentFile());
+ writing(new File(dest, target));
+ Util.createSymlink(dest, target, relativePath, TaskListener.NULL);
+ } catch (InterruptedException x) {
+ throw new IOException(x);
+ }
+ count.incrementAndGet();
+ }
+ }));
+ return count.get();
+ }
+ }
+ private class ReadToTar extends SecureFileCallable {
+ private final Pipe pipe;
+ private final String description;
+ ReadToTar(Pipe pipe, String description) {
+ this.pipe = pipe;
+ this.description = description;
+ }
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Void invoke(File f, VirtualChannel channel) throws IOException {
+ try (InputStream in = pipe.getIn()) {
+ readFromTar(remote + '/' + description, f, TarCompression.GZIP.extract(in));
+ return null;
+ }
+ }
+ }
+ private class WriteToTar extends SecureFileCallable {
+ private final DirScanner scanner;
+ private final Pipe pipe;
+ WriteToTar(DirScanner scanner, Pipe pipe) {
+ this.scanner = scanner;
+ this.pipe = pipe;
+ }
+ private static final long serialVersionUID = 1L;
+ @Override
+ public Integer invoke(File f, VirtualChannel channel) throws IOException, InterruptedException {
+ return writeToTar(new File(remote), scanner, TarCompression.GZIP.compress(pipe.getOut()));
+ }
+ }
+ private class CopyRecursiveRemoteToLocal extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ private final Pipe pipe;
+ private final DirScanner scanner;
+ CopyRecursiveRemoteToLocal(Pipe pipe, DirScanner scanner) {
+ this.pipe = pipe;
+ this.scanner = scanner;
+ }
+ @Override
+ public Integer invoke(File f, VirtualChannel channel) throws IOException {
+ try (OutputStream out = pipe.getOut()) {
+ return writeToTar(f, scanner, TarCompression.GZIP.compress(out));
+ }
+ }
+ }
/**
* Writes files in 'this' directory to a tar stream.
@@ -2347,6 +2604,10 @@ public final class FilePath implements Serializable {
TarArchiveEntry te;
while ((te = t.getNextTarEntry()) != null) {
File f = new File(baseDir, te.getName());
+ if (!f.toPath().normalize().startsWith(baseDir.toPath())) {
+ throw new IOException(
+ "Tar " + name + " contains illegal file name that breaks out of the target directory: " + te.getName());
+ }
if (te.isDirectory()) {
mkdirs(f);
} else {
@@ -2438,9 +2699,20 @@ public final class FilePath implements Serializable {
* @throws InterruptedException not only in case of a channel failure, but also if too many operations were performed without finding any matches
* @since 1.484
*/
- public String validateAntFileMask(final String fileMasks, final int bound, final boolean caseSensitive) throws IOException, InterruptedException {
- return act(new MasterToSlaveFileCallable() {
+ public @CheckForNull String validateAntFileMask(final String fileMasks, final int bound, final boolean caseSensitive) throws IOException, InterruptedException {
+ return act(new ValidateAntFileMask(fileMasks, caseSensitive, bound));
+ }
+ private class ValidateAntFileMask extends MasterToSlaveFileCallable {
+ private final String fileMasks;
+ private final boolean caseSensitive;
+ private final int bound;
+ ValidateAntFileMask(String fileMasks, boolean caseSensitive, int bound) {
+ this.fileMasks = fileMasks;
+ this.caseSensitive = caseSensitive;
+ this.bound = bound;
+ }
private static final long serialVersionUID = 1;
+ @Override
public String invoke(File dir, VirtualChannel channel) throws IOException, InterruptedException {
if(fileMasks.startsWith("~"))
return Messages.FilePath_TildaDoesntWork();
@@ -2586,7 +2858,6 @@ public final class FilePath implements Serializable {
if(idx2==-1) return idx1;
return Math.min(idx1,idx2);
}
- });
}
private static final UrlFactory DEFAULT_URL_FACTORY = new UrlFactory();
@@ -2828,6 +3099,11 @@ public final class FilePath implements Serializable {
return classLoader;
}
+ @Override
+ public String toString() {
+ return callable.toString();
+ }
+
private static final long serialVersionUID = 1L;
}
@@ -2852,11 +3128,13 @@ public final class FilePath implements Serializable {
* (User's home directory in the Unix sense) of the given channel.
*/
public static FilePath getHomeDirectory(VirtualChannel ch) throws InterruptedException, IOException {
- return ch.call(new MasterToSlaveCallable() {
- public FilePath call() throws IOException {
- return new FilePath(new File(System.getProperty("user.home")));
- }
- });
+ return ch.call(new GetHomeDirectory());
+ }
+ private static class GetHomeDirectory extends MasterToSlaveCallable {
+ @Override
+ public FilePath call() throws IOException {
+ return new FilePath(new File(System.getProperty("user.home")));
+ }
}
/**
@@ -3002,5 +3280,60 @@ public final class FilePath implements Serializable {
return IOUtils.mkdirs(dir);
}
+ /**
+ * Check if the relative child is really a descendant after symlink resolution if any.
+ *
+ * TODO un-restrict it in a weekly after the patch
+ */
+ @Restricted(NoExternalUse.class)
+ public boolean isDescendant(@Nonnull String potentialChildRelativePath) throws IOException, InterruptedException {
+ return act(new IsDescendant(potentialChildRelativePath));
+ }
+
+ private class IsDescendant extends SecureFileCallable {
+ private static final long serialVersionUID = 1L;
+ private String potentialChildRelativePath;
+
+ private IsDescendant(@Nonnull String potentialChildRelativePath){
+ this.potentialChildRelativePath = potentialChildRelativePath;
+ }
+
+ @Override
+ public Boolean invoke(@Nonnull File parentFile, @Nonnull VirtualChannel channel) throws IOException, InterruptedException {
+ if (new File(potentialChildRelativePath).isAbsolute()) {
+ throw new IllegalArgumentException("Only a relative path is supported, the given path is absolute: " + potentialChildRelativePath);
+ }
+
+ Path parent = parentFile.getAbsoluteFile().toPath().normalize();
+
+ String remainingPath = potentialChildRelativePath;
+ File currentFile = parentFile;
+ while (!remainingPath.isEmpty()) {
+ File directChild = this.getDirectChild(currentFile, remainingPath);
+ File childUsingFullPath = new File(currentFile, remainingPath);
+ remainingPath = childUsingFullPath.getAbsolutePath().substring(directChild.getAbsolutePath().length());
+
+ File childFileSymbolic = Util.resolveSymlinkToFile(directChild);
+ if (childFileSymbolic == null) {
+ currentFile = directChild;
+ } else {
+ currentFile = childFileSymbolic;
+ }
+ }
+
+ //TODO could be refactored using Util#isDescendant(File, File) from 2.80+
+ Path child = currentFile.getAbsoluteFile().toPath().normalize();
+ return child.startsWith(parent);
+ }
+
+ private @CheckForNull File getDirectChild(File parentFile, String childPath){
+ File current = new File(parentFile, childPath);
+ while (current != null && !parentFile.equals(current.getParentFile())) {
+ current = current.getParentFile();
+ }
+ return current;
+ }
+ }
+
private static final SoloFilePathFilter UNRESTRICTED = SoloFilePathFilter.wrap(FilePathFilter.UNRESTRICTED);
}
diff --git a/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java b/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java
index 1e02e11f7f4dfdbedf2f00b853535725c1d43f86..9e162d666feb466d4487911fb4b2b2cdbd81a99a 100644
--- a/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java
+++ b/core/src/main/java/hudson/FileSystemProvisionerDescriptor.java
@@ -50,12 +50,12 @@ public abstract class FileSystemProvisionerDescriptor extends Descriptortrue.
+ * perform the necessary deletion operation, and return {@code true}.
*
*
* If the workspace isn't the one created by this {@link FileSystemProvisioner}, or if the
* workspace can be simply deleted by {@link FilePath#deleteRecursive()}, then simply
- * return false to give other {@link FileSystemProvisionerDescriptor}s a chance to
+ * return {@code false} to give other {@link FileSystemProvisionerDescriptor}s a chance to
* discard them.
*
* @param ws
diff --git a/core/src/main/java/hudson/Functions.java b/core/src/main/java/hudson/Functions.java
index 8462b889946e8facd489ca242f940d754aa63afe..5e2ab71644b933ba7424afd14268e11a2e339b9b 100644
--- a/core/src/main/java/hudson/Functions.java
+++ b/core/src/main/java/hudson/Functions.java
@@ -47,6 +47,7 @@ import hudson.model.JobPropertyDescriptor;
import hudson.model.ModelObject;
import hudson.model.Node;
import hudson.model.PageDecorator;
+import jenkins.model.SimplePageDecorator;
import hudson.model.PaneStatusProperties;
import hudson.model.ParameterDefinition;
import hudson.model.ParameterDefinition.ParameterDescriptor;
@@ -133,8 +134,6 @@ import jenkins.model.Jenkins;
import jenkins.model.ModelObjectWithChildren;
import jenkins.model.ModelObjectWithContextMenu;
-import org.acegisecurity.Authentication;
-import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
import org.apache.commons.jelly.JellyContext;
import org.apache.commons.jelly.JellyTagException;
import org.apache.commons.jelly.Script;
@@ -397,11 +396,11 @@ public class Functions {
* is chosen, this part remains intact.
*
*
- * The 524 is the path from {@link Job} to {@link Run}.
+ * The {@code 524} is the path from {@link Job} to {@link Run}.
*
*
- * The bbb portion is the path after that till the last
- * {@link Run} subtype. The ccc portion is the part
+ * The {@code bbb} portion is the path after that till the last
+ * {@link Run} subtype. The {@code ccc} portion is the part
* after that.
*/
public static final class RunUrl {
@@ -619,7 +618,7 @@ public class Functions {
private static final SimpleFormatter formatter = new SimpleFormatter();
/**
- * Used by layout.jelly to control the auto refresh behavior.
+ * Used by {@code layout.jelly} to control the auto refresh behavior.
*
* @param noAutoRefresh
* On certain pages, like a page with forms, will have annoying interference
@@ -773,7 +772,7 @@ public class Functions {
}
/**
- * This version is so that the 'checkPermission' on layout.jelly
+ * This version is so that the 'checkPermission' on {@code layout.jelly}
* degrades gracefully if "it" is not an {@link AccessControlled} object.
* Otherwise it will perform no check and that problem is hard to notice.
*/
@@ -1379,6 +1378,7 @@ public class Functions {
}
public static String jsStringEscape(String s) {
+ if (s == null) return null;
StringBuilder buf = new StringBuilder();
for( int i=0; i
- * This is primarily used in slave-agent.jnlp.jelly to specify the destination
+ * This is primarily used in {@code slave-agent.jnlp.jelly} to specify the destination
* that the agents talk to.
*/
public String getServerName() {
@@ -1746,7 +1746,7 @@ public class Functions {
/**
* If the given href link is matching the current page, return true.
*
- * Used in task.jelly to decide if the page should be highlighted.
+ * Used in {@code task.jelly} to decide if the page should be highlighted.
*/
public boolean hyperlinkMatchesCurrentPage(String href) throws UnsupportedEncodingException {
String url = Stapler.getCurrentRequest().getRequestURL().toString();
@@ -1771,7 +1771,14 @@ public class Functions {
if(Jenkins.getInstanceOrNull()==null) return Collections.emptyList();
return PageDecorator.all();
}
-
+ /**
+ * Gets only one {@link SimplePageDecorator}.
+ * @since 2.128
+ */
+ public static SimplePageDecorator getSimplePageDecorator() {
+ return SimplePageDecorator.first();
+ }
+
public static List> getCloudDescriptors() {
return Cloud.all();
}
@@ -1820,7 +1827,7 @@ public class Functions {
* from {@link ConsoleAnnotatorFactory}s and {@link ConsoleAnnotationDescriptor}s.
*/
public static String generateConsoleAnnotationScriptAndStylesheet() {
- String cp = Stapler.getCurrentRequest().getContextPath();
+ String cp = Stapler.getCurrentRequest().getContextPath() + Jenkins.RESOURCE_PATH;
StringBuilder buf = new StringBuilder();
for (ConsoleAnnotatorFactory f : ConsoleAnnotatorFactory.all()) {
String path = cp + "/extensionList/" + ConsoleAnnotatorFactory.class.getName() + "/" + f.getClass().getName();
diff --git a/core/src/main/java/hudson/Indenter.java b/core/src/main/java/hudson/Indenter.java
index c1f6971b6540a6b66c36f34e0378b605835bd290..aa4348b57a9bbc54b2a5b89fe272e4ed663562c5 100644
--- a/core/src/main/java/hudson/Indenter.java
+++ b/core/src/main/java/hudson/Indenter.java
@@ -26,7 +26,7 @@ package hudson;
import hudson.model.Job;
/**
- * Used by projectView.jelly to indent modules.
+ * Used by {@code projectView.jelly} to indent modules.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/Launcher.java b/core/src/main/java/hudson/Launcher.java
index 432a5afe249c7bee7e68c11d2a9ec0be490cb8b8..f0f18b4f81df12bb56440e68872bf0871fca1a55 100644
--- a/core/src/main/java/hudson/Launcher.java
+++ b/core/src/main/java/hudson/Launcher.java
@@ -26,6 +26,7 @@ package hudson;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import hudson.Proc.LocalProc;
import hudson.model.Computer;
+import jenkins.util.MemoryReductionUtil;
import hudson.util.QuotedStringTokenizer;
import jenkins.model.Jenkins;
import hudson.model.TaskListener;
@@ -166,6 +167,8 @@ public abstract class Launcher {
@CheckForNull
protected OutputStream stdout = NULL_OUTPUT_STREAM, stderr;
@CheckForNull
+ private TaskListener stdoutListener;
+ @CheckForNull
protected InputStream stdin = NULL_INPUT_STREAM;
@CheckForNull
protected String[] envs = null;
@@ -280,22 +283,25 @@ public abstract class Launcher {
* Sets STDOUT destination.
*
* @param out Output stream.
- * Use {@code null} to send STDOUT to /dev/null.
+ * Use {@code null} to send STDOUT to {@code /dev/null}.
* @return {@code this}
*/
public ProcStarter stdout(@CheckForNull OutputStream out) {
this.stdout = out;
+ stdoutListener = null;
return this;
}
/**
* Sends the stdout to the given {@link TaskListener}.
*
- * @param out Task listener
+ * @param out Task listener (must be safely remotable)
* @return {@code this}
*/
public ProcStarter stdout(@Nonnull TaskListener out) {
- return stdout(out.getLogger());
+ stdout = out.getLogger();
+ stdoutListener = out;
+ return this;
}
/**
@@ -329,7 +335,7 @@ public abstract class Launcher {
/**
* Controls where the stdin of the process comes from.
- * By default, /dev/null.
+ * By default, {@code /dev/null}.
*
* @return {@code this}
*/
@@ -391,7 +397,7 @@ public abstract class Launcher {
*/
@Nonnull
public String[] envs() {
- return envs != null ? envs.clone() : new String[0];
+ return envs != null ? envs.clone() : MemoryReductionUtil.EMPTY_STRING_ARRAY;
}
/**
@@ -490,6 +496,7 @@ public abstract class Launcher {
@Nonnull
public ProcStarter copy() {
ProcStarter rhs = new ProcStarter().cmds(commands).pwd(pwd).masks(masks).stdin(stdin).stdout(stdout).stderr(stderr).envs(envs).quiet(quiet);
+ rhs.stdoutListener = stdoutListener;
rhs.reverseStdin = this.reverseStdin;
rhs.reverseStderr = this.reverseStderr;
rhs.reverseStdout = this.reverseStdout;
@@ -1041,7 +1048,7 @@ public abstract class Launcher {
}
public Proc launch(ProcStarter ps) throws IOException {
- final OutputStream out = ps.stdout == null ? null : new RemoteOutputStream(new CloseProofOutputStream(ps.stdout));
+ final OutputStream out = ps.stdout == null || ps.stdoutListener != null ? null : new RemoteOutputStream(new CloseProofOutputStream(ps.stdout));
final OutputStream err = ps.stderr==null ? null : new RemoteOutputStream(new CloseProofOutputStream(ps.stderr));
final InputStream in = (ps.stdin==null || ps.stdin==NULL_INPUT_STREAM) ? null : new RemoteInputStream(ps.stdin,false);
@@ -1049,7 +1056,7 @@ public abstract class Launcher {
final String workDir = psPwd==null ? null : psPwd.getRemote();
try {
- return new ProcImpl(getChannel().call(new RemoteLaunchCallable(ps.commands, ps.masks, ps.envs, in, ps.reverseStdin, out, ps.reverseStdout, err, ps.reverseStderr, ps.quiet, workDir, listener)));
+ return new ProcImpl(getChannel().call(new RemoteLaunchCallable(ps.commands, ps.masks, ps.envs, in, ps.reverseStdin, out, ps.reverseStdout, err, ps.reverseStderr, ps.quiet, workDir, listener, ps.stdoutListener)));
} catch (InterruptedException e) {
throw (IOException)new InterruptedIOException().initCause(e);
}
@@ -1265,6 +1272,7 @@ public abstract class Launcher {
private final @CheckForNull OutputStream err;
private final @CheckForNull String workDir;
private final @Nonnull TaskListener listener;
+ private final @CheckForNull TaskListener stdoutListener;
private final boolean reverseStdin, reverseStdout, reverseStderr;
private final boolean quiet;
@@ -1272,7 +1280,7 @@ public abstract class Launcher {
@CheckForNull InputStream in, boolean reverseStdin,
@CheckForNull OutputStream out, boolean reverseStdout,
@CheckForNull OutputStream err, boolean reverseStderr,
- boolean quiet, @CheckForNull String workDir, @Nonnull TaskListener listener) {
+ boolean quiet, @CheckForNull String workDir, @Nonnull TaskListener listener, @CheckForNull TaskListener stdoutListener) {
this.cmd = new ArrayList<>(cmd);
this.masks = masks;
this.env = env;
@@ -1281,6 +1289,7 @@ public abstract class Launcher {
this.err = err;
this.workDir = workDir;
this.listener = listener;
+ this.stdoutListener = stdoutListener;
this.reverseStdin = reverseStdin;
this.reverseStdout = reverseStdout;
this.reverseStderr = reverseStderr;
@@ -1290,7 +1299,12 @@ public abstract class Launcher {
public RemoteProcess call() throws IOException {
final Channel channel = getOpenChannelOrFail();
Launcher.ProcStarter ps = new LocalLauncher(listener).launch();
- ps.cmds(cmd).masks(masks).envs(env).stdin(in).stdout(out).stderr(err).quiet(quiet);
+ ps.cmds(cmd).masks(masks).envs(env).stdin(in).stderr(err).quiet(quiet);
+ if (stdoutListener != null) {
+ ps.stdout(stdoutListener.getLogger());
+ } else {
+ ps.stdout(out);
+ }
if(workDir!=null) ps.pwd(workDir);
if (reverseStdin) ps.writeStdin();
if (reverseStdout) ps.readStdout();
diff --git a/core/src/main/java/hudson/Main.java b/core/src/main/java/hudson/Main.java
index 896ae4dd53398525db56af00f19aeec7c40dde05..11cb516cee31be90a3f118b308f27179083f9d5a 100644
--- a/core/src/main/java/hudson/Main.java
+++ b/core/src/main/java/hudson/Main.java
@@ -144,7 +144,7 @@ public class Main {
int ret;
try (OutputStream os = Files.newOutputStream(tmpFile.toPath());
Writer w = new OutputStreamWriter(os,"UTF-8")) {
- w.write("");
+ w.write("");
w.write("");
w.flush();
diff --git a/core/src/main/java/hudson/Plugin.java b/core/src/main/java/hudson/Plugin.java
index 9539737878719eb636c01d89acb8a9b8fcdc2314..2f065102becc4c8a3a247a9869a6ebb8a0150844 100644
--- a/core/src/main/java/hudson/Plugin.java
+++ b/core/src/main/java/hudson/Plugin.java
@@ -35,6 +35,7 @@ import org.kohsuke.stapler.StaplerResponse;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.File;
@@ -42,10 +43,10 @@ import net.sf.json.JSONObject;
import com.thoughtworks.xstream.XStream;
import hudson.init.Initializer;
import hudson.init.Terminator;
-import java.net.URI;
-import java.net.URISyntaxException;
+import java.net.URL;
+import java.util.Locale;
+import java.util.logging.Logger;
import jenkins.model.GlobalConfiguration;
-import org.kohsuke.stapler.HttpResponses;
/**
* Base class of Hudson plugin.
@@ -61,26 +62,28 @@ import org.kohsuke.stapler.HttpResponses;
* to plugin functionality.
*
*
- * A plugin is bound to URL space of Hudson as ${rootURL}/plugin/foo/,
+ * A plugin is bound to URL space of Hudson as {@code ${rootURL}/plugin/foo/},
* where "foo" is taken from your plugin name "foo.jpi". All your web resources
* in src/main/webapp are visible from this URL, and you can also define Jelly
* views against your Plugin class, and those are visible in this URL, too.
*
*
- * {@link Plugin} can have an optional config.jelly page. If present,
+ * {@link Plugin} can have an optional {@code config.jelly} page. If present,
* it will become a part of the system configuration page (http://server/hudson/configure).
* This is convenient for exposing/maintaining configuration that doesn't
* fit any {@link Descriptor}s.
*
*
* Up until Hudson 1.150 or something, subclasses of {@link Plugin} required
- * @plugin javadoc annotation, but that is no longer a requirement.
+ * {@code @plugin} javadoc annotation, but that is no longer a requirement.
*
* @author Kohsuke Kawaguchi
* @since 1.42
*/
public abstract class Plugin implements Saveable {
+ private static final Logger LOGGER = Logger.getLogger(Plugin.class.getName());
+
/**
* You do not need to create custom subtypes:
*
@@ -191,11 +194,11 @@ public abstract class Plugin implements Saveable {
* Handles the submission for the system configuration.
*
*
- * If this class defines config.jelly view, be sure to
+ * If this class defines {@code config.jelly} view, be sure to
* override this method and persists the submitted values accordingly.
*
*
- * The following is a sample config.jelly that you can start yours with:
+ * The following is a sample {@code config.jelly} that you can start yours with:
*
{@code <![CDATA[
* <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
* <f:section title="Locale">
@@ -219,18 +222,22 @@ public abstract class Plugin implements Saveable {
}
/**
- * This method serves static resources in the plugin under <tt>hudson/plugin/SHORTNAME</tt>.
+ * This method serves static resources in the plugin under {@code hudson/plugin/SHORTNAME}.
*/
public void doDynamic(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
String path = req.getRestOfPath();
- if (path.startsWith("/META-INF/") || path.startsWith("/WEB-INF/")) {
- throw HttpResponses.notFound();
+ String pathUC = path.toUpperCase(Locale.ENGLISH);
+ if (path.isEmpty() || path.contains("..") || path.startsWith(".") || path.contains("%")
+ || pathUC.contains("META-INF") || pathUC.contains("WEB-INF")
+ // ClassicPluginStrategy#explode produce that file to know if a new explosion is required or not
+ || pathUC.equals("/.TIMESTAMP2")
+ ) {
+ LOGGER.warning("rejecting possibly malicious " + req.getRequestURIWithQueryString());
+ rsp.sendError(HttpServletResponse.SC_BAD_REQUEST);
+ return;
}
- if(path.length()==0)
- path = "/";
-
// Stapler routes requests like the "/static/.../foo/bar/zot" to be treated like "/foo/bar/zot"
// and this is used to serve long expiration header, by using Jenkins.VERSION_HASH as "..."
// to create unique URLs. Recognize that and set a long expiration header.
@@ -240,11 +247,7 @@ public abstract class Plugin implements Saveable {
long expires = staticLink ? TimeUnit.DAYS.toMillis(365) : -1;
// use serveLocalizedFile to support automatic locale selection
- try {
- rsp.serveLocalizedFile(req, wrapper.baseResourceURL.toURI().resolve(new URI(null, '.' + path, null)).toURL(), expires);
- } catch (URISyntaxException x) {
- throw new IOException(x);
- }
+ rsp.serveLocalizedFile(req, new URL(wrapper.baseResourceURL, '.' + path), expires);
}
//
diff --git a/core/src/main/java/hudson/PluginManager.java b/core/src/main/java/hudson/PluginManager.java
index a7971ca33c7701b1b11a8866227fe21f2566d72e..8e2c5fd400e7dc1b3b38f249dd26a4c08101414c 100644
--- a/core/src/main/java/hudson/PluginManager.java
+++ b/core/src/main/java/hudson/PluginManager.java
@@ -25,8 +25,6 @@ package hudson;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import hudson.security.ACLContext;
-import jenkins.util.SystemProperties;
import hudson.PluginWrapper.Dependency;
import hudson.init.InitMilestone;
import hudson.init.InitStrategy;
@@ -36,22 +34,26 @@ import hudson.model.AbstractModelObject;
import hudson.model.AdministrativeMonitor;
import hudson.model.Api;
import hudson.model.Descriptor;
+import hudson.model.DownloadService;
import hudson.model.Failure;
import hudson.model.ItemGroupMixIn;
import hudson.model.UpdateCenter;
-import hudson.model.UpdateSite;
import hudson.model.UpdateCenter.DownloadJob;
import hudson.model.UpdateCenter.InstallationJob;
+import hudson.model.UpdateSite;
import hudson.security.ACL;
+import hudson.security.ACLContext;
import hudson.security.Permission;
import hudson.security.PermissionScope;
import hudson.util.CyclicGraphDetector;
import hudson.util.CyclicGraphDetector.CycleDetectedException;
+import hudson.util.FormValidation;
import hudson.util.PersistedList;
import hudson.util.Service;
import hudson.util.VersionNumber;
import hudson.util.XStream2;
import jenkins.ClassLoaderReflectionToolkit;
+import jenkins.ExtensionRefreshException;
import jenkins.InitReactorRunner;
import jenkins.MissingDependencyException;
import jenkins.RestartRequiredException;
@@ -59,12 +61,12 @@ import jenkins.YesNoMaybe;
import jenkins.install.InstallState;
import jenkins.install.InstallUtil;
import jenkins.model.Jenkins;
+import jenkins.security.CustomClassFilter;
+import jenkins.util.SystemProperties;
import jenkins.util.io.OnMaster;
import jenkins.util.xml.RestrictiveEntityResolver;
-
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
-
import org.acegisecurity.Authentication;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
@@ -82,17 +84,24 @@ import org.jvnet.hudson.reactor.Reactor;
import org.jvnet.hudson.reactor.ReactorException;
import org.jvnet.hudson.reactor.TaskBuilder;
import org.jvnet.hudson.reactor.TaskGraphBuilder;
+import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.DoNotUse;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerOverridable;
+import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.interceptor.RequirePOST;
+import org.xml.sax.Attributes;
+import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
@@ -100,6 +109,7 @@ import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;
+import java.io.ByteArrayInputStream;
import java.io.Closeable;
import java.io.File;
import java.io.FilenameFilter;
@@ -107,10 +117,12 @@ import java.io.IOException;
import java.io.InputStream;
import java.lang.ref.WeakReference;
import java.lang.reflect.Method;
+import java.net.JarURLConnection;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
+import java.net.URLConnection;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
@@ -121,6 +133,7 @@ import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
+import java.util.ServiceLoader;
import java.util.Set;
import java.util.TreeMap;
import java.util.UUID;
@@ -128,31 +141,15 @@ import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.Future;
+import java.util.function.Supplier;
+import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.logging.Level;
import java.util.logging.Logger;
-import org.xml.sax.Attributes;
-import org.xml.sax.InputSource;
-import org.xml.sax.SAXException;
-import org.xml.sax.helpers.DefaultHandler;
import static hudson.init.InitMilestone.*;
-import hudson.model.DownloadService;
-import hudson.util.FormValidation;
-import java.io.ByteArrayInputStream;
-import java.net.JarURLConnection;
-import java.net.URLConnection;
-import java.util.ServiceLoader;
-import java.util.jar.JarEntry;
-
-import static java.util.logging.Level.FINE;
-import static java.util.logging.Level.INFO;
-import static java.util.logging.Level.SEVERE;
-import static java.util.logging.Level.WARNING;
-import jenkins.security.CustomClassFilter;
-import org.kohsuke.accmod.Restricted;
-import org.kohsuke.accmod.restrictions.NoExternalUse;
+import static java.util.logging.Level.*;
/**
* Manages {@link PluginWrapper}s.
@@ -176,7 +173,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* @author Kohsuke Kawaguchi
*/
@ExportedBean
-public abstract class PluginManager extends AbstractModelObject implements OnMaster, StaplerOverridable {
+public abstract class PluginManager extends AbstractModelObject implements OnMaster, StaplerOverridable, StaplerProxy {
/** Custom plugin manager system property or context param. */
public static final String CUSTOM_PLUGIN_MANAGER = PluginManager.class.getName() + ".className";
@@ -920,6 +917,11 @@ public abstract class PluginManager extends AbstractModelObject implements OnMas
// Redo who depends on who.
resolveDependantPlugins();
+ try {
+ Jenkins.get().refreshExtensions();
+ } catch (ExtensionRefreshException e) {
+ throw new IOException("Failed to refresh extensions after installing " + sn + " plugin", e);
+ }
LOGGER.info("Plugin " + p.getShortName()+":"+p.getVersion() + " dynamically installed");
}
}
@@ -927,8 +929,15 @@ public abstract class PluginManager extends AbstractModelObject implements OnMas
@Restricted(NoExternalUse.class)
public synchronized void resolveDependantPlugins() {
for (PluginWrapper plugin : plugins) {
+ // Set of optional dependants plugins of plugin
+ Set<String> optionalDependants = new HashSet<>();
Set<String> dependants = new HashSet<>();
for (PluginWrapper possibleDependant : plugins) {
+ // No need to check if plugin is dependant of itself
+ if(possibleDependant.getShortName().equals(plugin.getShortName())) {
+ continue;
+ }
+
// The plugin could have just been deleted. If so, it doesn't
// count as a dependant.
if (possibleDependant.isDeleted()) {
@@ -938,10 +947,20 @@ public abstract class PluginManager extends AbstractModelObject implements OnMas
for (Dependency dependency : dependencies) {
if (dependency.shortName.equals(plugin.getShortName())) {
dependants.add(possibleDependant.getShortName());
+
+ // If, in addition, the dependency is optional, add to the optionalDependants list
+ if (dependency.optional) {
+ optionalDependants.add(possibleDependant.getShortName());
+ }
+
+ // already know possibleDependant depends on plugin, no need to continue with the rest of
+ // dependencies. We continue with the next possibleDependant
+ break;
}
}
}
plugin.setDependants(dependants);
+ plugin.setOptionalDependants(optionalDependants);
}
}
@@ -1208,7 +1227,7 @@ public abstract class PluginManager extends AbstractModelObject implements OnMas
/**
* Discover all the service provider implementations of the given class,
- * via <tt>META-INF/services</tt>.
+ * via {@code META-INF/services}.
* @deprecated Use {@link ServiceLoader} instead, or (more commonly) {@link ExtensionList}.
*/
@Deprecated
@@ -1485,7 +1504,7 @@ public abstract class PluginManager extends AbstractModelObject implements OnMas
}
updateCenter.persistInstallStatus();
if(!failures) {
- try (ACLContext _ = ACL.as(currentAuth)) {
+ try (ACLContext acl = ACL.as(currentAuth)) {
InstallUtil.proceedToNextStateFrom(InstallState.INITIAL_PLUGINS_INSTALLING);
}
}
@@ -1816,6 +1835,44 @@ public abstract class PluginManager extends AbstractModelObject implements OnMas
return requestedPlugins;
}
+ @Restricted(DoNotUse.class) // table.jelly
+ public MetadataCache createCache() {
+ return new MetadataCache();
+ }
+
+ /**
+ * Disable a list of plugins using a strategy for their dependants plugins.
+ * @param strategy the strategy regarding how the dependant plugins are processed
+ * @param plugins the list of plugins
+ * @return the list of results for every plugin and their dependant plugins.
+ * @throws IOException see {@link PluginWrapper#disable()}
+ */
+ public @NonNull List<PluginWrapper.PluginDisableResult> disablePlugins(@NonNull PluginWrapper.PluginDisableStrategy strategy, @NonNull List<String> plugins) throws IOException {
+ // Where we store the results of each plugin disablement
+ List<PluginWrapper.PluginDisableResult> results = new ArrayList<>(plugins.size());
+
+ // Disable all plugins passed
+ for (String pluginName : plugins) {
+ PluginWrapper plugin = this.getPlugin(pluginName);
+
+ if (plugin == null) {
+ results.add(new PluginWrapper.PluginDisableResult(pluginName, PluginWrapper.PluginDisableStatus.NO_SUCH_PLUGIN, Messages.PluginWrapper_NoSuchPlugin(pluginName)));
+ } else {
+ results.add(plugin.disable(strategy));
+ }
+ }
+
+ return results;
+ }
+
+ @Restricted(NoExternalUse.class) // table.jelly
+ public static final class MetadataCache {
+ private final Map<String, Object> data = new HashMap<>();
+ public <T> T of(String key, Class<T> type, Supplier<T> func) {
+ return type.cast(data.computeIfAbsent(key, _ignored -> func.get()));
+ }
+ }
+
/**
* {@link ClassLoader} that can see all plugins.
*/
@@ -2063,4 +2120,19 @@ public abstract class PluginManager extends AbstractModelObject implements OnMas
}
}
+
+ @Override
+ @Restricted(NoExternalUse.class)
+ public Object getTarget() {
+ if (!SKIP_PERMISSION_CHECK) {
+ Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
+ }
+ return this;
+ }
+
+ /**
+ * Escape hatch for StaplerProxy-based access control
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean SKIP_PERMISSION_CHECK = Boolean.getBoolean(PluginManager.class.getName() + ".skipPermissionCheck");
}
diff --git a/core/src/main/java/hudson/PluginWrapper.java b/core/src/main/java/hudson/PluginWrapper.java
index 75e358a81193d1b45212fe0f06b7af16a93e1111..16f0fcc63f48fa2e0eee5cd1f40adc792fccf7b7 100644
--- a/core/src/main/java/hudson/PluginWrapper.java
+++ b/core/src/main/java/hudson/PluginWrapper.java
@@ -25,18 +25,21 @@
package hudson;
import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Sets;
import hudson.PluginManager.PluginInstanceStore;
import hudson.model.AdministrativeMonitor;
import hudson.model.Api;
import hudson.model.ModelObject;
-import java.nio.file.Files;
-import java.nio.file.InvalidPathException;
-import jenkins.YesNoMaybe;
-import jenkins.model.Jenkins;
import hudson.model.UpdateCenter;
import hudson.model.UpdateSite;
import hudson.util.VersionNumber;
-import org.jvnet.localizer.ResourceBundleHolder;
+import jenkins.YesNoMaybe;
+import jenkins.model.Jenkins;
+import org.apache.commons.lang.StringUtils;
+import org.apache.commons.logging.LogFactory;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.DoNotUse;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.StaplerRequest;
@@ -45,16 +48,15 @@ import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.interceptor.RequirePOST;
-import org.apache.commons.lang.StringUtils;
-import org.apache.commons.logging.LogFactory;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import java.io.Closeable;
import java.io.File;
-import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.InvalidPathException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
@@ -65,12 +67,20 @@ import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
+import java.util.function.Predicate;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.logging.Level;
import java.util.logging.Logger;
+import java.util.stream.Collectors;
+import static hudson.PluginWrapper.PluginDisableStatus.ALREADY_DISABLED;
+import static hudson.PluginWrapper.PluginDisableStatus.DISABLED;
+import static hudson.PluginWrapper.PluginDisableStatus.ERROR_DISABLING;
+import static hudson.PluginWrapper.PluginDisableStatus.NOT_DISABLED_DEPENDANTS;
+import static hudson.PluginWrapper.PluginDisableStatus.NO_SUCH_PLUGIN;
import static java.util.logging.Level.WARNING;
import static org.apache.commons.io.FilenameUtils.getBaseName;
@@ -79,7 +89,7 @@ import static org.apache.commons.io.FilenameUtils.getBaseName;
* for Jenkins to control {@link Plugin}.
*
* <p>
- * A plug-in is packaged into a jar file whose extension is <tt>".jpi"</tt> (or <tt>".hpi"</tt> for backward compatibility),
+ * A plug-in is packaged into a jar file whose extension is {@code ".jpi"} (or {@code ".hpi"} for backward compatibility),
* A plugin needs to have a special manifest entry to identify what it is.
*
* <p>
@@ -124,7 +134,7 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
/**
* Base URL for loading static resources from this plugin.
* Null if disabled. The static resources are mapped under
- * <tt>CONTEXTPATH/plugin/SHORTNAME/</tt>.
+ * {@code CONTEXTPATH/plugin/SHORTNAME/}.
*/
public final URL baseResourceURL;
@@ -149,7 +159,7 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
/**
* True if this plugin is activated for this session.
- * The snapshot of <tt>disableFile.exists()</tt> as of the start up.
+ * The snapshot of {@code disableFile.exists()} as of the start up.
*/
private final boolean active;
@@ -159,10 +169,34 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
private final List<Dependency> optionalDependencies;
public List<String> getDependencyErrors() {
- return Collections.unmodifiableList(dependencyErrors);
+ return Collections.unmodifiableList(new ArrayList<>(dependencyErrors.keySet()));
}
- private final transient List<String> dependencyErrors = new ArrayList<>();
+ @Restricted(NoExternalUse.class) // Jelly use
+ public List<String> getOriginalDependencyErrors() {
+ Predicate<Map.Entry<String, Boolean>> p = Map.Entry::getValue;
+ return dependencyErrors.entrySet().stream().filter(p.negate()).map(Map.Entry::getKey).collect(Collectors.toList());
+ }
+
+ @Restricted(NoExternalUse.class) // Jelly use
+ public boolean hasOriginalDependencyErrors() {
+ return !getOriginalDependencyErrors().isEmpty();
+ }
+
+ @Restricted(NoExternalUse.class) // Jelly use
+ public List<String> getDerivedDependencyErrors() {
+ return dependencyErrors.entrySet().stream().filter(Map.Entry::getValue).map(Map.Entry::getKey).collect(Collectors.toList());
+ }
+
+ @Restricted(NoExternalUse.class) // Jelly use
+ public boolean hasDerivedDependencyErrors() {
+ return !getDerivedDependencyErrors().isEmpty();
+ }
+
+ /**
+ * A String error message, and a boolean indicating whether it's an original error (false) or downstream from an original one (true)
+ */
+ private final transient Map<String, Boolean> dependencyErrors = new HashMap<>(0);
/**
* Is this plugin bundled in jenkins.war?
@@ -174,6 +208,11 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
*/
private Set<String> dependants = Collections.emptySet();
+ /**
+ * List of plugins that depend optionally on this plugin.
+ */
+ private Set<String> optionalDependants = Collections.emptySet();
+
/**
* The core can depend on a plugin if it is bundled. Sometimes it's the only thing that
* depends on the plugin e.g. UI support library bundle plugin.
@@ -188,6 +227,14 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
this.dependants = dependants;
}
+ /**
+ * Set the list of components that depend optionally on this plugin.
+ * @param optionalDependants The list of components that depend optionally on this plugin.
+ */
+ public void setOptionalDependants(@Nonnull Set<String> optionalDependants) {
+ this.optionalDependants = optionalDependants;
+ }
+
/**
* Get the list of components that depend on this plugin.
* @return The list of components that depend on this plugin.
@@ -200,6 +247,13 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
}
}
+ /**
+ * @return The list of components that depend optionally on this plugin.
+ */
+ public @Nonnull Set<String> getOptionalDependants() {
+ return optionalDependants;
+ }
+
/**
* Does this plugin have anything that depends on it.
* @return {@code true} if something (Jenkins core, or another plugin) depends on this
@@ -208,7 +262,17 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
public boolean hasDependants() {
return (isBundled || !dependants.isEmpty());
}
-
+
+ /**
+ * Does this plugin have anything that depends optionally on it.
+ * @return {@code true} if something (Jenkins core, or another plugin) depends optionally on this
+ * plugin, otherwise {@code false}.
+ */
+ public boolean hasOptionalDependants() {
+ return !optionalDependants.isEmpty();
+ }
+
+
/**
* Does this plugin depend on any other plugins.
* @return {@code true} if this plugin depends on other plugins, otherwise {@code false}.
@@ -230,8 +294,8 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
int idx = s.indexOf(':');
if(idx==-1)
throw new IllegalArgumentException("Illegal dependency specifier "+s);
- this.shortName = s.substring(0,idx);
- String version = s.substring(idx+1);
+ this.shortName = Util.intern(s.substring(0,idx));
+ String version = Util.intern(s.substring(idx+1));
boolean isOptional = false;
String[] osgiProperties = version.split("[;]");
@@ -274,7 +338,7 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
List<Dependency> dependencies, List<Dependency> optionalDependencies) {
this.parent = parent;
this.manifest = manifest;
- this.shortName = computeShortName(manifest, archive.getName());
+ this.shortName = Util.intern(computeShortName(manifest, archive.getName()));
this.baseResourceURL = baseResourceURL;
this.classLoader = classLoader;
this.disableFile = disableFile;
@@ -493,9 +557,19 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
}
/**
- * Disables this plugin next time Jenkins runs.
+ * Disables this plugin next time Jenkins runs. As it doesn't check anything, it's recommended to use the method
+ * {@link #disable(PluginDisableStrategy)}
*/
+ @Deprecated //see https://issues.jenkins-ci.org/browse/JENKINS-27177
public void disable() throws IOException {
+ disableWithoutCheck();
+ }
+
+ /**
+ * Disable a plugin wihout checking any dependency. Only add the disable file.
+ * @throws IOException
+ */
+ private void disableWithoutCheck() throws IOException {
// creates an empty file
try (OutputStream os = Files.newOutputStream(disableFile.toPath())) {
os.close();
@@ -504,6 +578,103 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
}
}
+ /**
+ * Disable this plugin using a strategy.
+ * @param strategy strategy to use
+ * @return an object representing the result of the disablement of this plugin and its dependants plugins.
+ */
+ public @Nonnull PluginDisableResult disable(@Nonnull PluginDisableStrategy strategy) {
+ PluginDisableResult result = new PluginDisableResult(shortName);
+
+ if (!this.isEnabled()) {
+ result.setMessage(Messages.PluginWrapper_Already_Disabled(shortName));
+ result.setStatus(ALREADY_DISABLED);
+ return result;
+ }
+
+ // Act as a flag indicating if this plugin, finally, can be disabled. If there is a not-disabled-dependant
+ // plugin, this one couldn't be disabled.
+ String aDependantNotDisabled = null;
+
+ // List of dependants plugins to 'check'. 'Check' means disable for mandatory or all strategies, or review if
+ // this dependant-mandatory plugin is enabled in order to return an error for the NONE strategy.
+ Set<String> dependantsToCheck = dependantsToCheck(strategy);
+
+ // Review all the dependants and add to the plugin result what happened with its dependants
+ for (String dependant : dependantsToCheck) {
+ PluginWrapper dependantPlugin = parent.getPlugin(dependant);
+
+ // The dependant plugin doesn't exist, add an error to the report
+ if (dependantPlugin == null) {
+ PluginDisableResult dependantStatus = new PluginDisableResult(dependant, NO_SUCH_PLUGIN, Messages.PluginWrapper_NoSuchPlugin(dependant));
+ result.addDependantDisableStatus(dependantStatus);
+
+ // If the strategy is none and there is some enabled dependant plugin, the plugin cannot be disabled. If
+ // this dependant plugin is not enabled, continue searching for one enabled.
+ } else if (strategy.equals(PluginDisableStrategy.NONE)) {
+ if (dependantPlugin.isEnabled()) {
+ aDependantNotDisabled = dependant;
+ break; // in this case, we don't need to continue with the rest of its dependants
+ }
+
+ // If the strategy is not none and this dependant plugin is not enabled, add it as already disabled
+ } else if (!dependantPlugin.isEnabled()) {
+ PluginDisableResult dependantStatus = new PluginDisableResult(dependant, ALREADY_DISABLED, Messages.PluginWrapper_Already_Disabled(dependant));
+ result.addDependantDisableStatus(dependantStatus);
+
+ // If the strategy is not none and this dependant plugin is enabled, disable it
+ } else {
+ // As there is no cycles in the plugin dependencies, the recursion shouldn't be infinite. The
+ // strategy used is the same for its dependants plugins
+ PluginDisableResult dependantResult = dependantPlugin.disable(strategy);
+ PluginDisableStatus dependantStatus = dependantResult.status;
+
+ // If something wrong happened, flag this dependant plugin to set the plugin later as not-disabled due
+ // to its dependants plugins.
+ if (ERROR_DISABLING.equals(dependantStatus) || NOT_DISABLED_DEPENDANTS.equals(dependantStatus)) {
+ aDependantNotDisabled = dependant;
+ break; // we found a dependant plugin enabled, stop looking for dependant plugins to disable.
+ }
+ result.addDependantDisableStatus(dependantResult);
+ }
+ }
+
+ // If there is no enabled-dependant plugin, disable this plugin and add it to the result
+ if (aDependantNotDisabled == null) {
+ try {
+ this.disableWithoutCheck();
+ result.setMessage(Messages.PluginWrapper_Plugin_Disabled(shortName));
+ result.setStatus(DISABLED);
+ } catch (IOException io) {
+ result.setMessage(Messages.PluginWrapper_Error_Disabling(shortName, io.toString()));
+ result.setStatus(ERROR_DISABLING);
+ }
+ // if there is yet some not disabled dependant plugin (only possible with none strategy), this plugin cannot
+ // be disabled.
+ } else {
+ result.setMessage(Messages.PluginWrapper_Plugin_Has_Dependant(shortName, aDependantNotDisabled, strategy));
+ result.setStatus(NOT_DISABLED_DEPENDANTS);
+ }
+
+ return result;
+ }
+
+ private Set<String> dependantsToCheck(PluginDisableStrategy strategy) {
+ Set<String> dependantsToCheck;
+ switch (strategy) {
+ case ALL:
+ // getDependants returns all the dependant plugins, mandatory or optional.
+ dependantsToCheck = this.getDependants();
+ break;
+ default:
+ // It includes MANDATORY, NONE:
+ // with NONE, the process only fail if mandatory dependant plugins exists
+ // As of getDependants has all the dependants, we get the difference between them and only the optionals
+ dependantsToCheck = Sets.difference(this.getDependants(), this.getOptionalDependants());
+ }
+ return dependantsToCheck;
+ }
+
/**
* Returns true if this plugin is enabled for this session.
*/
@@ -571,7 +742,7 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
} else {
VersionNumber actualVersion = Jenkins.getVersion();
if (actualVersion.isOlderThan(new VersionNumber(requiredCoreVersion))) {
- dependencyErrors.add(Messages.PluginWrapper_obsoleteCore(Jenkins.getVersion().toString(), requiredCoreVersion));
+ versionDependencyError(Messages.PluginWrapper_obsoleteCore(Jenkins.getVersion().toString(), requiredCoreVersion), Jenkins.getVersion().toString(), requiredCoreVersion);
}
}
}
@@ -581,21 +752,21 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
if (dependency == null) {
PluginWrapper failedDependency = NOTICE.getPlugin(d.shortName);
if (failedDependency != null) {
- dependencyErrors.add(Messages.PluginWrapper_failed_to_load_dependency(failedDependency.getLongName(), failedDependency.getVersion()));
+ dependencyErrors.put(Messages.PluginWrapper_failed_to_load_dependency(failedDependency.getLongName(), failedDependency.getVersion()), true);
break;
} else {
- dependencyErrors.add(Messages.PluginWrapper_missing(d.shortName, d.version));
+ dependencyErrors.put(Messages.PluginWrapper_missing(d.shortName, d.version), false);
}
} else {
if (dependency.isActive()) {
if (isDependencyObsolete(d, dependency)) {
- dependencyErrors.add(Messages.PluginWrapper_obsolete(dependency.getLongName(), dependency.getVersion(), d.version));
+ versionDependencyError(Messages.PluginWrapper_obsolete(dependency.getLongName(), dependency.getVersion(), d.version), dependency.getVersion(), d.version);
}
} else {
if (isDependencyObsolete(d, dependency)) {
- dependencyErrors.add(Messages.PluginWrapper_disabledAndObsolete(dependency.getLongName(), dependency.getVersion(), d.version));
+ versionDependencyError(Messages.PluginWrapper_disabledAndObsolete(dependency.getLongName(), dependency.getVersion(), d.version), dependency.getVersion(), d.version);
} else {
- dependencyErrors.add(Messages.PluginWrapper_disabled(dependency.getLongName()));
+ dependencyErrors.put(Messages.PluginWrapper_disabled(dependency.getLongName()), false);
}
}
@@ -606,7 +777,7 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
PluginWrapper dependency = parent.getPlugin(d.shortName);
if (dependency != null && dependency.isActive()) {
if (isDependencyObsolete(d, dependency)) {
- dependencyErrors.add(Messages.PluginWrapper_obsolete(dependency.getLongName(), dependency.getVersion(), d.version));
+ versionDependencyError(Messages.PluginWrapper_obsolete(dependency.getLongName(), dependency.getVersion(), d.version), dependency.getVersion(), d.version);
} else {
dependencies.add(d);
}
@@ -616,7 +787,7 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
NOTICE.addPlugin(this);
StringBuilder messageBuilder = new StringBuilder();
messageBuilder.append(Messages.PluginWrapper_failed_to_load_plugin(getLongName(), getVersion())).append(System.lineSeparator());
- for (Iterator<String> iterator = dependencyErrors.iterator(); iterator.hasNext(); ) {
+ for (Iterator<String> iterator = dependencyErrors.keySet().iterator(); iterator.hasNext(); ) {
String dependencyError = iterator.next();
messageBuilder.append(" - ").append(dependencyError);
if (iterator.hasNext()) {
@@ -631,6 +802,26 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
return ENABLE_PLUGIN_DEPENDENCIES_VERSION_CHECK && dependency.getVersionNumber().isOlderThan(new VersionNumber(d.version));
}
+ /**
+ * Called when there appears to be a core or plugin version which is too old for a stated dependency.
+ * Normally records an error in {@link #dependencyErrors}.
+ * But if one or both versions {@link #isSnapshot}, just issue a warning (JENKINS-52665).
+ */
+ private void versionDependencyError(String message, String actual, String minimum) {
+ if (isSnapshot(actual) || isSnapshot(minimum)) {
+ LOGGER.log(WARNING, "Suppressing dependency error in {0} v{1}: {2}", new Object[] {getLongName(), getVersion(), message});
+ } else {
+ dependencyErrors.put(message, false);
+ }
+ }
+
+ /**
+ * Similar to {@code org.apache.maven.artifact.ArtifactUtils.isSnapshot}.
+ */
+ static boolean isSnapshot(@Nonnull String version) {
+ return version.contains("-SNAPSHOT") || version.matches(".+-[0-9]{8}.[0-9]{6}-[0-9]+");
+ }
+
/**
* If the plugin has {@link #getUpdateInfo() an update},
* returns the {@link hudson.model.UpdateSite.Plugin} object.
@@ -752,6 +943,11 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
return !plugins.isEmpty();
}
+ @Restricted(DoNotUse.class) // Jelly
+ public boolean hasAnyDerivedDependencyErrors() {
+ return plugins.values().stream().anyMatch(PluginWrapper::hasDerivedDependencyErrors);
+ }
+
@Override
public String getDisplayName() {
return Messages.PluginWrapper_PluginWrapperAdministrativeMonitor_DisplayName();
@@ -780,6 +976,93 @@ public class PluginWrapper implements Comparable<PluginWrapper>, ModelObject {
}
}
+ /**
+ * The result of the disablement of a plugin and its dependants plugins.
+ */
+ public static class PluginDisableResult {
+ private String plugin;
+ private PluginDisableStatus status;
+ private String message;
+ private Set<PluginDisableResult> dependantsDisableStatus = new HashSet<>();
+
+ public PluginDisableResult(String plugin) {
+ this.plugin = plugin;
+ }
+
+ public PluginDisableResult(String plugin, PluginDisableStatus status, String message) {
+ this.plugin = plugin;
+ this.status = status;
+ this.message = message;
+ }
+
+ public String getPlugin() {
+ return plugin;
+ }
+
+ public PluginDisableStatus getStatus() {
+ return status;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ PluginDisableResult that = (PluginDisableResult) o;
+ return Objects.equals(plugin, that.plugin);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(plugin);
+ }
+
+ public void setStatus(PluginDisableStatus status) {
+ this.status = status;
+ }
+
+ public String getMessage() {
+ return message;
+ }
+
+ public void setMessage(String message) {
+ this.message = message;
+ }
+
+ public Set<PluginDisableResult> getDependantsDisableStatus() {
+ return dependantsDisableStatus;
+ }
+
+ public void addDependantDisableStatus(PluginDisableResult dependantDisableStatus) {
+ dependantsDisableStatus.add(dependantDisableStatus);
+ }
+
+ }
+
+ /**
+ * An enum to hold the status of a disabling action against a plugin. To do it more reader-friendly.
+ */
+ public enum PluginDisableStatus {
+ NO_SUCH_PLUGIN,
+ DISABLED,
+ ALREADY_DISABLED,
+ NOT_DISABLED_DEPENDANTS,
+ ERROR_DISABLING
+ }
+
+ /**
+ * The strategies defined for disabling a plugin.
+ */
+ public enum PluginDisableStrategy {
+ NONE,
+ MANDATORY,
+ ALL;
+
+ @Override
+ public String toString() {
+ return this.name().toLowerCase();
+ }
+ }
+
//
//
// Action methods
diff --git a/core/src/main/java/hudson/ProxyConfiguration.java b/core/src/main/java/hudson/ProxyConfiguration.java
index 3baea805d42d341ae5b37cc6e43469dde3e39070..3f2cfe6f0af3f1260ae21c3d9a4b6d027f0104ee 100644
--- a/core/src/main/java/hudson/ProxyConfiguration.java
+++ b/core/src/main/java/hudson/ProxyConfiguration.java
@@ -110,6 +110,10 @@ public final class ProxyConfiguration extends AbstractDescribableImpl<ProxyConfi
private String testUrl;
+ private transient Authenticator authenticator;
+
+ private transient boolean authCacheSeeded;
+
public ProxyConfiguration(String name, int port) {
this(name,port,null,null);
}
@@ -129,7 +133,17 @@ public final class ProxyConfiguration extends AbstractDescribableImpl<ProxyConfi
this.userName = Util.fixEmptyAndTrim(userName);
this.secretPassword = Secret.fromString(password);
this.noProxyHost = Util.fixEmptyAndTrim(noProxyHost);
- this.testUrl =Util.fixEmptyAndTrim(testUrl);
+ this.testUrl = Util.fixEmptyAndTrim(testUrl);
+ authenticator = new Authenticator() {
+ @Override
+ public PasswordAuthentication getPasswordAuthentication() {
+ String userName = getUserName();
+ if (getRequestorType() == RequestorType.PROXY && userName != null) {
+ return new PasswordAuthentication(userName, getPassword().toCharArray());
+ }
+ return null;
+ }
+ };
}
public String getUserName() {
@@ -204,7 +218,7 @@ public final class ProxyConfiguration extends AbstractDescribableImpl<ProxyConfi
SaveableListener.fireOnChange(this, config);
}
- public Object readResolve() {
+ private Object readResolve() {
if (secretPassword == null)
// backward compatibility : get scrambled password and store it encrypted
secretPassword = Secret.fromString(Scrambler.descramble(password));
@@ -234,17 +248,12 @@ public final class ProxyConfiguration extends AbstractDescribableImpl<ProxyConfi
if(p==null) {
con = url.openConnection();
} else {
- con = url.openConnection(p.createProxy(url.getHost()));
+ Proxy proxy = p.createProxy(url.getHost());
+ con = url.openConnection(proxy);
if(p.getUserName()!=null) {
// Add an authenticator which provides the credentials for proxy authentication
- Authenticator.setDefault(new Authenticator() {
- @Override
- public PasswordAuthentication getPasswordAuthentication() {
- if (getRequestorType()!=RequestorType.PROXY) return null;
- return new PasswordAuthentication(p.getUserName(),
- p.getPassword().toCharArray());
- }
- });
+ Authenticator.setDefault(p.authenticator);
+ p.jenkins48775workaround(proxy, url);
}
}
@@ -261,27 +270,48 @@ public final class ProxyConfiguration extends AbstractDescribableImpl<ProxyConfi
public static InputStream getInputStream(URL url) throws IOException {
final ProxyConfiguration p = get();
- if (p == null)
+ if (p == null)
return new RetryableHttpStream(url);
- InputStream is = new RetryableHttpStream(url, p.createProxy(url.getHost()));
+ Proxy proxy = p.createProxy(url.getHost());
+ InputStream is = new RetryableHttpStream(url, proxy);
if (p.getUserName() != null) {
// Add an authenticator which provides the credentials for proxy authentication
- Authenticator.setDefault(new Authenticator() {
-
- @Override
- public PasswordAuthentication getPasswordAuthentication() {
- if (getRequestorType() != RequestorType.PROXY) {
- return null;
- }
- return new PasswordAuthentication(p.getUserName(), p.getPassword().toCharArray());
- }
- });
+ Authenticator.setDefault(p.authenticator);
+ p.jenkins48775workaround(proxy, url);
}
return is;
}
+ /**
+ * If the first URL we try to access with a HTTP proxy is HTTPS then the authentication cache will not have been
+ * pre-populated, so we try to access at least one HTTP URL before the very first HTTPS url.
+ * @param proxy
+ * @param url the actual URL being opened.
+ */
+ private void jenkins48775workaround(Proxy proxy, URL url) {
+ if ("https".equals(url.getProtocol()) && !authCacheSeeded && proxy != Proxy.NO_PROXY) {
+ HttpURLConnection preAuth = null;
+ try {
+ // We do not care if there is anything at this URL, all we care is that it is using the proxy
+ preAuth = (HttpURLConnection) new URL("http", url.getHost(), -1, "/").openConnection(proxy);
+ preAuth.setRequestMethod("HEAD");
+ preAuth.connect();
+ } catch (IOException e) {
+ // ignore, this is just a probe we don't care at all
+ } finally {
+ if (preAuth != null) {
+ preAuth.disconnect();
+ }
+ }
+ authCacheSeeded = true;
+ } else if ("https".equals(url.getProtocol())){
+ // if we access any http url using a proxy then the auth cache will have been seeded
+ authCacheSeeded = authCacheSeeded || proxy != Proxy.NO_PROXY;
+ }
+ }
+
@CheckForNull
private static ProxyConfiguration get() {
if (JenkinsJVM.isJenkinsJVM()) {
@@ -341,6 +371,8 @@ public final class ProxyConfiguration extends AbstractDescribableImpl<ProxyConfi
@QueryParameter("userName") String userName, @QueryParameter("password") String password,
@QueryParameter("noProxyHost") String noProxyHost) {
+ Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
+
if (Util.fixEmptyAndTrim(testUrl) == null) {
return FormValidation.error(Messages.ProxyConfiguration_TestUrlRequired());
}
diff --git a/core/src/main/java/hudson/TcpSlaveAgentListener.java b/core/src/main/java/hudson/TcpSlaveAgentListener.java
index 03455a77532745be3c8767af13c87e416c13d8b4..f0a9c037002dbbce2b2dabfaaf7ae07283b032e6 100644
--- a/core/src/main/java/hudson/TcpSlaveAgentListener.java
+++ b/core/src/main/java/hudson/TcpSlaveAgentListener.java
@@ -34,6 +34,7 @@ import javax.annotation.Nullable;
import hudson.model.AperiodicWork;
import jenkins.model.Jenkins;
import jenkins.model.identity.InstanceIdentityProvider;
+import jenkins.slaves.RemotingVersionInfo;
import jenkins.util.SystemProperties;
import hudson.slaves.OfflineCause;
import java.io.DataOutputStream;
@@ -300,6 +301,7 @@ public final class TcpSlaveAgentListener extends Thread {
o.write("Jenkins-Session: " + Jenkins.SESSION_HASH + "\r\n");
o.write("Client: " + s.getInetAddress().getHostAddress() + "\r\n");
o.write("Server: " + s.getLocalAddress().getHostAddress() + "\r\n");
+ o.write("Remoting-Minimum-Version: " + RemotingVersionInfo.getMinimumSupportedVersion() + "\r\n");
o.flush();
s.shutdownOutput();
} else {
diff --git a/core/src/main/java/hudson/Util.java b/core/src/main/java/hudson/Util.java
index f2f242a4a16ff534114beb040f0dabb11caf9e85..8007200a6293ead38d91608592412fe13cae2d9c 100644
--- a/core/src/main/java/hudson/Util.java
+++ b/core/src/main/java/hudson/Util.java
@@ -23,15 +23,17 @@
*/
package hudson;
-import java.nio.file.InvalidPathException;
-import jenkins.util.SystemProperties;
-
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
import hudson.model.TaskListener;
+import jenkins.util.MemoryReductionUtil;
import hudson.util.QuotedStringTokenizer;
import hudson.util.VariableResolver;
+import jenkins.util.SystemProperties;
+import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.output.NullOutputStream;
import org.apache.commons.lang.time.FastDateFormat;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
@@ -41,9 +43,6 @@ import org.apache.tools.ant.types.FileSet;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
-import javax.crypto.SecretKey;
-import javax.crypto.spec.SecretKeySpec;
-
import java.io.*;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
@@ -56,9 +55,12 @@ import java.nio.CharBuffer;
import java.nio.charset.CharacterCodingException;
import java.nio.charset.Charset;
import java.nio.charset.CharsetEncoder;
+import java.nio.charset.StandardCharsets;
import java.nio.file.FileAlreadyExistsException;
import java.nio.file.FileSystemException;
+import java.nio.file.FileSystems;
import java.nio.file.Files;
+import java.nio.file.InvalidPathException;
import java.nio.file.LinkOption;
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
@@ -67,25 +69,31 @@ import java.nio.file.attribute.PosixFilePermission;
import java.nio.file.attribute.BasicFileAttributes;
import java.nio.file.attribute.PosixFileAttributes;
import java.nio.file.attribute.DosFileAttributes;
+import java.nio.file.attribute.PosixFilePermissions;
+import java.security.DigestInputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.NumberFormat;
import java.text.ParseException;
+import java.time.LocalDate;
+import java.time.ZoneId;
+import java.time.temporal.ChronoUnit;
import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.logging.Level;
+import java.util.logging.LogRecord;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
-import java.security.DigestInputStream;
-
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
+import javax.crypto.SecretKey;
+import javax.crypto.spec.SecretKeySpec;
-import org.apache.commons.codec.digest.DigestUtils;
+import org.apache.commons.io.FileUtils;
/**
* Various utility methods that don't have more proper home.
@@ -130,7 +138,7 @@ public class Util {
private static final Pattern VARIABLE = Pattern.compile("\\$([A-Za-z0-9_]+|\\{[A-Za-z0-9_.]+\\}|\\$)");
/**
- * Replaces the occurrence of '$key' by <tt>properties.get('key')</tt>.
+ * Replaces the occurrence of '$key' by {@code properties.get('key')}.
*
* <p>
* Unlike shell, undefined variables are left as-is (this behavior is the same as Ant.)
@@ -142,7 +150,7 @@ public class Util {
}
/**
- * Replaces the occurrence of '$key' by <tt>resolver.get('key')</tt>.
+ * Replaces the occurrence of '$key' by {@code resolver.get('key')}.
*
* <p>
* Unlike shell, undefined variables are left as-is (this behavior is the same as Ant.)
@@ -179,28 +187,54 @@ public class Util {
}
/**
- * Loads the contents of a file into a string.
+ * Reads the entire contents of the text file at <code>logfile</code> into a
+ * string using the {@link Charset#defaultCharset() default charset} for
+ * decoding. If no such file exists, an empty string is returned.
+ * @param logfile The text file to read in its entirety.
+ * @return The entire text content of <code>logfile</code>.
+ * @throws IOException If an error occurs while reading the file.
+ * @deprecated call {@link #loadFile(java.io.File, java.nio.charset.Charset)}
+ * instead to specify the charset to use for decoding (preferably
+ * {@link java.nio.charset.StandardCharsets#UTF_8}).
*/
@Nonnull
+ @Deprecated
public static String loadFile(@Nonnull File logfile) throws IOException {
return loadFile(logfile, Charset.defaultCharset());
}
+ /**
+ * Reads the entire contents of the text file at <code>logfile</code> into a
+ * string using <code>charset</code> for decoding. If no such file exists,
+ * an empty string is returned.
+ * @param logfile The text file to read in its entirety.
+ * @param charset The charset to use for decoding the bytes in <code>logfile</code>.
+ * @return The entire text content of <code>logfile</code>.
+ * @throws IOException If an error occurs while reading the file.
+ */
@Nonnull
public static String loadFile(@Nonnull File logfile, @Nonnull Charset charset) throws IOException {
- if(!logfile.exists())
+ // Note: Until charset handling is resolved (e.g. by implementing
+ // https://issues.jenkins-ci.org/browse/JENKINS-48923 ), this method
+ // must be able to handle character encoding errors. As reported at
+ // https://issues.jenkins-ci.org/browse/JENKINS-49112 Run.getLog() calls
+ // loadFile() to fully read the generated log file. This file might
+ // contain unmappable and/or malformed byte sequences. We need to make
+ // sure that in such cases, no CharacterCodingException is thrown.
+ //
+ // One approach that cannot be used is to call Files.newBufferedReader()
+ // because there is a difference in how an InputStreamReader constructed
+ // from a Charset and the reader returned by Files.newBufferedReader()
+ // handle malformed and unmappable byte sequences for the specified
+ // encoding; the latter is more picky and will throw an exception.
+ // See: https://issues.jenkins-ci.org/browse/JENKINS-49060?focusedCommentId=325989&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-325989
+ try {
+ return FileUtils.readFileToString(logfile, charset);
+ } catch (FileNotFoundException e) {
return "";
-
- StringBuilder str = new StringBuilder((int)logfile.length());
-
- try (BufferedReader r = Files.newBufferedReader(fileToPath(logfile), charset)) {
- char[] buf = new char[1024];
- int len;
- while ((len = r.read(buf, 0, buf.length)) > 0)
- str.append(buf, 0, len);
+ } catch (Exception e) {
+ throw new IOException("Failed to fully read " + logfile, e);
}
-
- return str.toString();
}
/**
@@ -298,7 +332,7 @@ public class Util {
if (!Functions.isWindows()) {
try {
PosixFileAttributes attrs = Files.readAttributes(path, PosixFileAttributes.class);
- Set<PosixFilePermission> newPermissions = ((PosixFileAttributes)attrs).permissions();
+ Set<PosixFilePermission> newPermissions = attrs.permissions();
newPermissions.add(PosixFilePermission.OWNER_WRITE);
Files.setPosixFilePermissions(path, newPermissions);
return;
@@ -491,7 +525,7 @@ public class Util {
* calling readAttributes.
*/
try {
- Path path = file.toPath();
+ Path path = fileToPath(file);
BasicFileAttributes attrs = Files.readAttributes(path, BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS);
if (attrs.isSymbolicLink()) {
return true;
@@ -504,8 +538,6 @@ public class Util {
} else {
return false;
}
- } catch (InvalidPathException e) {
- throw new IOException(e);
} catch (NoSuchFileException e) {
return false;
}
@@ -545,25 +577,35 @@ public class Util {
* @see InvalidPathException
*/
public static boolean isDescendant(File forParent, File potentialChild) throws IOException {
- try {
- Path child = potentialChild.getAbsoluteFile().toPath().normalize();
- Path parent = forParent.getAbsoluteFile().toPath().normalize();
- return child.startsWith(parent);
- } catch (InvalidPathException e) {
- throw new IOException(e);
- }
+ Path child = fileToPath(potentialChild.getAbsoluteFile()).normalize();
+ Path parent = fileToPath(forParent.getAbsoluteFile()).normalize();
+ return child.startsWith(parent);
}
/**
* Creates a new temporary directory.
*/
public static File createTempDir() throws IOException {
- File tmp = File.createTempFile("jenkins", "tmp");
- if(!tmp.delete())
- throw new IOException("Failed to delete "+tmp);
- if(!tmp.mkdirs())
- throw new IOException("Failed to create a new directory "+tmp);
- return tmp;
+ // The previously used approach of creating a temporary file, deleting
+ // it, and making a new directory having the same name in its place is
+ // potentially problematic:
+ // https://stackoverflow.com/questions/617414/how-to-create-a-temporary-directory-folder-in-java
+ // We can use the Java 7 Files.createTempDirectory() API, but note that
+ // by default, the permissions of the created directory are 0700&(~umask)
+ // whereas the old approach created a temporary directory with permissions
+ // 0777&(~umask).
+ // To avoid permissions problems like https://issues.jenkins-ci.org/browse/JENKINS-48407
+ // we can pass POSIX file permissions as an attribute (see, for example,
+ // https://github.com/jenkinsci/jenkins/pull/3161 )
+ final Path tempPath;
+ final String tempDirNamePrefix = "jenkins";
+ if (FileSystems.getDefault().supportedFileAttributeViews().contains("posix")) {
+ tempPath = Files.createTempDirectory(tempDirNamePrefix,
+ PosixFilePermissions.asFileAttribute(EnumSet.allOf(PosixFilePermission.class)));
+ } else {
+ tempPath = Files.createTempDirectory(tempDirNamePrefix);
+ }
+ return tempPath.toFile();
}
private static final Pattern errorCodeParser = Pattern.compile(".*CreateProcess.*error=([0-9]+).*");
@@ -598,7 +640,7 @@ public class Util {
try {
ResourceBundle rb = ResourceBundle.getBundle("/hudson/win32errors");
return rb.getString("error"+m.group(1));
- } catch (Exception _) {
+ } catch (Exception ignored) {
// silently recover from resource related failures
}
}
@@ -643,10 +685,7 @@ public class Util {
*/
@Deprecated
public static void copyStream(@Nonnull InputStream in,@Nonnull OutputStream out) throws IOException {
- byte[] buf = new byte[8192];
- int len;
- while((len=in.read(buf))>=0)
- out.write(buf,0,len);
+ IOUtils.copy(in, out);
}
/**
@@ -654,10 +693,7 @@ public class Util {
*/
@Deprecated
public static void copyStream(@Nonnull Reader in, @Nonnull Writer out) throws IOException {
- char[] buf = new char[8192];
- int len;
- while((len=in.read(buf))>0)
- out.write(buf,0,len);
+ IOUtils.copy(in, out);
}
/**
@@ -666,7 +702,7 @@ public class Util {
@Deprecated
public static void copyStreamAndClose(@Nonnull InputStream in, @Nonnull OutputStream out) throws IOException {
try (InputStream _in = in; OutputStream _out = out) { // make sure both are closed, and use Throwable.addSuppressed
- copyStream(in,out);
+ IOUtils.copy(_in, _out);
}
}
@@ -676,7 +712,7 @@ public class Util {
@Deprecated
public static void copyStreamAndClose(@Nonnull Reader in, @Nonnull Writer out) throws IOException {
try (Reader _in = in; Writer _out = out) {
- copyStream(in,out);
+ IOUtils.copy(_in, _out);
}
}
@@ -766,15 +802,15 @@ public class Util {
public static String getDigestOf(@Nonnull InputStream source) throws IOException {
try {
MessageDigest md5 = MessageDigest.getInstance("MD5");
-
- byte[] buffer = new byte[1024];
- try (DigestInputStream in = new DigestInputStream(source, md5)) {
- while (in.read(buffer) >= 0)
- ; // simply discard the input
- }
+ DigestInputStream in = new DigestInputStream(source, md5);
+ // Note: IOUtils.copy() buffers the input internally, so there is no
+ // need to use a BufferedInputStream.
+ IOUtils.copy(in, NullOutputStream.NULL_OUTPUT_STREAM);
return toHexString(md5.digest());
} catch (NoSuchAlgorithmException e) {
throw new IOException("MD5 not installed",e); // impossible
+ } finally {
+ source.close();
}
/* JENKINS-18178: confuses Maven 2 runner
try {
@@ -788,7 +824,7 @@ public class Util {
@Nonnull
public static String getDigestOf(@Nonnull String text) {
try {
- return getDigestOf(new ByteArrayInputStream(text.getBytes("UTF-8")));
+ return getDigestOf(new ByteArrayInputStream(text.getBytes(StandardCharsets.UTF_8)));
} catch (IOException e) {
throw new Error(e);
}
@@ -803,11 +839,8 @@ public class Util {
*/
@Nonnull
public static String getDigestOf(@Nonnull File file) throws IOException {
- try (InputStream is = Files.newInputStream(file.toPath())) {
- return getDigestOf(new BufferedInputStream(is));
- } catch (InvalidPathException e) {
- throw new IOException(e);
- }
+ // Note: getDigestOf() closes the input stream.
+ return getDigestOf(Files.newInputStream(fileToPath(file)));
}
/**
@@ -820,14 +853,12 @@ public class Util {
// turn secretKey into 256 bit hash
MessageDigest digest = MessageDigest.getInstance("SHA-256");
digest.reset();
- digest.update(s.getBytes("UTF-8"));
+ digest.update(s.getBytes(StandardCharsets.UTF_8));
// Due to the stupid US export restriction JDK only ships 128bit version.
return new SecretKeySpec(digest.digest(),0,128/8, "AES");
} catch (NoSuchAlgorithmException e) {
throw new Error(e);
- } catch (UnsupportedEncodingException e) {
- throw new Error(e);
}
}
@@ -849,6 +880,8 @@ public class Util {
@Nonnull
public static byte[] fromHexString(@Nonnull String data) {
+ if (data.length() % 2 != 0)
+ throw new IllegalArgumentException("data must have an even number of hexadecimal digits");
byte[] r = new byte[data.length() / 2];
for (int i = 0; i < data.length(); i += 2)
r[i / 2] = (byte) Integer.parseInt(data.substring(i, i + 2), 16);
@@ -979,7 +1012,7 @@ public class Util {
StringBuilder out = new StringBuilder(s.length());
ByteArrayOutputStream buf = new ByteArrayOutputStream();
- OutputStreamWriter w = new OutputStreamWriter(buf,"UTF-8");
+ OutputStreamWriter w = new OutputStreamWriter(buf, StandardCharsets.UTF_8);
for (int i = 0; i < s.length(); i++) {
int c = s.charAt(i);
@@ -1042,7 +1075,7 @@ public class Util {
if (!escaped) {
out = new StringBuilder(i + (m - i) * 3);
out.append(s.substring(0, i));
- enc = Charset.forName("UTF-8").newEncoder();
+ enc = StandardCharsets.UTF_8.newEncoder();
buf = CharBuffer.allocate(1);
escaped = true;
}
@@ -1079,8 +1112,8 @@ public class Util {
/**
* Escapes HTML unsafe characters like <, & to the respective character entities.
*/
- @Nonnull
- public static String escape(@Nonnull String text) {
+ @Nullable
+ public static String escape(@CheckForNull String text) {
if (text==null) return null;
StringBuilder buf = new StringBuilder(text.length()+64);
for( int i=0; i<text.length(); i++ ) {
@@ -1136,14 +1169,13 @@ public class Util {
}
/**
- * Creates an empty file.
+ * Creates an empty file if nonexistent or truncates the existing file.
+ * Note: The behavior of this method in the case where the file already
+ * exists is unlike the POSIX <code>touch</code> utility which merely
+ * updates the file's access and/or modification time.
*/
public static void touch(@Nonnull File file) throws IOException {
- try {
- Files.newOutputStream(file.toPath()).close();
- } catch (InvalidPathException e) {
- throw new IOException(e);
- }
+ Files.newOutputStream(fileToPath(file)).close();
}
/**
@@ -1163,8 +1195,17 @@ public class Util {
*/
@Nonnull
public static String fixNull(@CheckForNull String s) {
- if(s==null) return "";
- else return s;
+ return fixNull(s, "");
+ }
+
+ /**
+ * Convert {@code null} to a default value.
+ * @param defaultValue Default value. It may be immutable or not, depending on the implementation.
+ * @since TODO
+ */
+ @Nonnull
+ public static <T> T fixNull(@CheckForNull T s, @Nonnull T defaultValue) {
+ return s != null ? s : defaultValue;
}
/**
@@ -1187,24 +1228,60 @@ public class Util {
return fixEmpty(s.trim());
}
+ /**
+ *
+ * @param l list to check.
+ * @param <T>
+ * Type of the list.
+ * @return
+ * {@code l} if l is not {@code null}.
+ * An empty <b>immutable list</b> if l is {@code null}.
+ */
@Nonnull
public static <T> List<T> fixNull(@CheckForNull List<T> l) {
- return l!=null ? l : Collections.<T>emptyList();
+ return fixNull(l, Collections.<T>emptyList());
}
+ /**
+ *
+ * @param l set to check.
+ * @param <T>
+ * Type of the set.
+ * @return
+ * {@code l} if l is not {@code null}.
+ * An empty <b>immutable set</b> if l is {@code null}.
+ */
@Nonnull
public static <T> Set<T> fixNull(@CheckForNull Set<T> l) {
- return l!=null ? l : Collections.<T>emptySet();
+ return fixNull(l, Collections.<T>emptySet());
}
+ /**
+ *
+ * @param l collection to check.
+ * @param <T>
+ * Type of the collection.
+ * @return
+ * {@code l} if l is not {@code null}.
+ * An empty <b>immutable set</b> if l is {@code null}.
+ */
@Nonnull
public static <T> Collection<T> fixNull(@CheckForNull Collection<T> l) {
- return l!=null ? l : Collections.<T>emptySet();
+ return fixNull(l, Collections.<T>emptySet());
}
+ /**
+ *
+ * @param l iterable to check.
+ * @param <T>
+ * Type of the iterable.
+ * @return
+ * {@code l} if l is not {@code null}.
+ * An empty <b>immutable set</b> if l is {@code null}.
+ */
@Nonnull
public static <T> Iterable<T> fixNull(@CheckForNull Iterable<T> l) {
- return l!=null ? l : Collections.<T>emptySet();
+ return fixNull(l, Collections.<T>emptySet());
}
/**
@@ -1310,8 +1387,8 @@ public class Util {
public static void createSymlink(@Nonnull File baseDir, @Nonnull String targetPath,
@Nonnull String symlinkPath, @Nonnull TaskListener listener) throws InterruptedException {
try {
- Path path = new File(baseDir, symlinkPath).toPath();
- Path target = Paths.get(targetPath, new String[0]);
+ Path path = fileToPath(new File(baseDir, symlinkPath));
+ Path target = Paths.get(targetPath, MemoryReductionUtil.EMPTY_STRING_ARRAY);
final int maxNumberOfTries = 4;
final int timeInMillis = 100;
@@ -1325,7 +1402,7 @@ public class Util {
TimeUnit.MILLISECONDS.sleep(timeInMillis); //trying to defeat likely ongoing race condition
continue;
}
- LOGGER.warning("symlink FileAlreadyExistsException thrown " + maxNumberOfTries + " times => cannot createSymbolicLink");
+ LOGGER.log(Level.WARNING, "symlink FileAlreadyExistsException thrown {0} times => cannot createSymbolicLink", maxNumberOfTries);
throw fileAlreadyExistsException;
}
}
@@ -1333,7 +1410,7 @@ public class Util {
PrintStream log = listener.getLogger();
log.print("Symbolic links are not supported on this platform");
Functions.printStackTrace(e, log);
- } catch (InvalidPathException | IOException e) {
+ } catch (IOException e) {
if (Functions.isWindows() && e instanceof FileSystemException) {
warnWindowsSymlink();
return;
@@ -1388,9 +1465,9 @@ public class Util {
* The relative path is meant to be resolved from the location of the symlink.
*/
@CheckForNull
- public static String resolveSymlink(@Nonnull File link) throws InterruptedException, IOException {
+ public static String resolveSymlink(@Nonnull File link) throws IOException {
try {
- Path path = link.toPath();
+ Path path = fileToPath(link);
return Files.readSymbolicLink(path).toString();
} catch (UnsupportedOperationException | FileSystemException x) {
// no symlinks on this platform (windows?),
@@ -1400,7 +1477,7 @@ public class Util {
} catch (IOException x) {
throw x;
} catch (Exception x) {
- throw (IOException) new IOException(x.toString()).initCause(x);
+ throw new IOException(x);
}
}
@@ -1421,7 +1498,7 @@ public class Util {
try {
return new URI(null,url,null).toASCIIString();
} catch (URISyntaxException e) {
- LOGGER.warning("Failed to encode "+url); // could this ever happen?
+ LOGGER.log(Level.WARNING, "Failed to encode {0}", url); // could this ever happen?
return url;
}
}
@@ -1579,7 +1656,10 @@ public class Util {
try {
toClose.close();
} catch(IOException ex) {
- logger.log(Level.WARNING, String.format("Failed to close %s of %s", closeableName, closeableOwner), ex);
+ LogRecord record = new LogRecord(Level.WARNING, "Failed to close {0} of {1}");
+ record.setParameters(new Object[] { closeableName, closeableOwner });
+ record.setThrown(ex);
+ logger.log(record);
}
}
@@ -1627,7 +1707,28 @@ public class Util {
throw new IOException(e);
}
}
-
+
+ /**
+ * Compute the number of calendar days elapsed since the given date.
+ * As it's only the calendar days difference that matter, "11.00pm" to "2.00am the day after" returns 1,
+ * even if there are only 3 hours between. As well as "10am" to "2pm" both on the same day, returns 0.
+ */
+ @Restricted(NoExternalUse.class)
+ public static long daysBetween(@Nonnull Date a, @Nonnull Date b){
+ LocalDate aLocal = a.toInstant().atZone(ZoneId.systemDefault()).toLocalDate();
+ LocalDate bLocal = b.toInstant().atZone(ZoneId.systemDefault()).toLocalDate();
+ return ChronoUnit.DAYS.between(aLocal, bLocal);
+ }
+
+ /**
+ * @return positive number of days between the given date and now
+ * @see #daysBetween(Date, Date)
+ */
+ @Restricted(NoExternalUse.class)
+ public static long daysElapsedSince(@Nonnull Date date){
+ return Math.max(0, daysBetween(date, new Date()));
+ }
+
public static final FastDateFormat XS_DATETIME_FORMATTER = FastDateFormat.getInstance("yyyy-MM-dd'T'HH:mm:ss'Z'",new SimpleTimeZone(0,"GMT"));
// Note: RFC822 dates must not be localized!
diff --git a/core/src/main/java/hudson/XmlFile.java b/core/src/main/java/hudson/XmlFile.java
index 243318e2296a44e91547cf16c2332f3c840c67dd..7f630dfb33dc23bf1021ae16f0a0cfd081a82f7a 100644
--- a/core/src/main/java/hudson/XmlFile.java
+++ b/core/src/main/java/hudson/XmlFile.java
@@ -26,7 +26,7 @@ package hudson;
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.converters.Converter;
import com.thoughtworks.xstream.converters.UnmarshallingContext;
-import com.thoughtworks.xstream.io.xml.Xpp3Driver;
+import com.thoughtworks.xstream.io.HierarchicalStreamDriver;
import hudson.diagnosis.OldDataMonitor;
import hudson.model.Descriptor;
import hudson.util.AtomicFileWriter;
@@ -39,7 +39,6 @@ import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.ext.Locator2;
import org.xml.sax.helpers.DefaultHandler;
-
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;
import java.io.BufferedInputStream;
@@ -73,12 +72,12 @@ import org.apache.commons.io.IOUtils;
* not have any data, the newly added field is left to the VM-default
* value (if you let XStream create the object, such as
* {@link #read()} — which is the majority), or to the value initialized by the
- * constructor (if the object is created via <tt>new</tt> and then its
+ * constructor (if the object is created via {@code new} and then its
* value filled by XStream, such as {@link #unmarshal(Object)}.)
*
* <p>
* Removing a field requires that you actually leave the field with
- * <tt>transient</tt> keyword. When you read the old XML, XStream
+ * {@code transient} keyword. When you read the old XML, XStream
* will set the value to this field. But when the data is saved,
* the field will no longer will be written back to XML.
* (It might be possible to tweak XStream so that we can simply
@@ -86,13 +85,13 @@ import org.apache.commons.io.IOUtils;
*
* <p>
* Changing the data structure is usually a combination of the two
- * above. You'd leave the old data store with <tt>transient</tt>,
+ * above. You'd leave the old data store with {@code transient},
* and then add the new data. When you are reading the old XML,
* only the old field will be set. When you are reading the new XML,
* only the new field will be set. You'll then need to alter the code
* so that it will be able to correctly handle both situations,
* and that as soon as you see data in the old field, you'll have to convert
- * that into the new data structure, so that the next <tt>save</tt> operation
+ * that into the new data structure, so that the next {@code save} operation
* will write the new data (otherwise you'll end up losing the data, because
* old fields will be never written back.)
*
@@ -155,7 +154,7 @@ public final class XmlFile {
* Loads the contents of this file into an existing object.
*
* @return
- * The unmarshalled object. Usually the same as <tt>o</tt>, but would be different
+ * The unmarshalled object. Usually the same as {@code o}, but would be different
* if the XML representation is completely new.
*/
public Object unmarshal( Object o ) throws IOException {
@@ -187,7 +186,7 @@ public final class XmlFile {
mkdirs();
AtomicFileWriter w = new AtomicFileWriter(file);
try {
- w.write("<?xml version='1.0' encoding='UTF-8'?>\n");
+ w.write("<?xml version='1.1' encoding='UTF-8'?>\n");
beingWritten.put(o, null);
writing.set(file);
try {
@@ -352,13 +351,14 @@ public final class XmlFile {
/**
* {@link XStream} instance is supposed to be thread-safe.
*/
- private static final XStream DEFAULT_XSTREAM = new XStream2();
private static final Logger LOGGER = Logger.getLogger(XmlFile.class.getName());
private static final SAXParserFactory JAXP = SAXParserFactory.newInstance();
- private static final Xpp3Driver DEFAULT_DRIVER = new Xpp3Driver();
+ private static final HierarchicalStreamDriver DEFAULT_DRIVER = XStream2.getDefaultDriver();
+
+ private static final XStream DEFAULT_XSTREAM = new XStream2(DEFAULT_DRIVER);
static {
JAXP.setNamespaceAware(true);
diff --git a/core/src/main/java/hudson/cli/CLICommand.java b/core/src/main/java/hudson/cli/CLICommand.java
index 5efbaf3a33edc915cb5d7f89f0ffe6408339c2f8..91d88118d1dcf99ca57a3bdc407c010e509b3d74 100644
--- a/core/src/main/java/hudson/cli/CLICommand.java
+++ b/core/src/main/java/hudson/cli/CLICommand.java
@@ -84,7 +84,7 @@ import javax.annotation.Nonnull;
* <h2>How does a CLI command work</h2>
* <p>
* The users starts {@linkplain CLI the "CLI agent"} on a remote system, by specifying arguments, like
- * <tt>"java -jar jenkins-cli.jar command arg1 arg2 arg3"</tt>. The CLI agent creates
+ * {@code "java -jar jenkins-cli.jar command arg1 arg2 arg3"}. The CLI agent creates
* a remoting channel with the server, and it sends the entire arguments to the server, along with
* the remoted stdin/out/err.
*
@@ -183,7 +183,7 @@ public abstract class CLICommand implements ExtensionPoint, Cloneable {
* Gets the command name.
*
* <p>
- * For example, if the CLI is invoked as <tt>java -jar cli.jar foo arg1 arg2 arg4</tt>,
+ * For example, if the CLI is invoked as {@code java -jar cli.jar foo arg1 arg2 arg4},
* on the server side {@link CLICommand} that returns "foo" from {@link #getName()}
* will be invoked.
*
@@ -260,6 +260,7 @@ public abstract class CLICommand implements ExtensionPoint, Cloneable {
// add options from the authenticator
SecurityContext sc = null;
Authentication old = null;
+ Authentication auth = null;
try {
sc = SecurityContextHolder.getContext();
old = sc.getAuthentication();
@@ -268,33 +269,50 @@ public abstract class CLICommand implements ExtensionPoint, Cloneable {
sc.setAuthentication(getTransportAuthentication());
new ClassParser().parse(authenticator,p);
+ if (!(this instanceof LoginCommand || this instanceof LogoutCommand || this instanceof HelpCommand || this instanceof WhoAmICommand))
+ Jenkins.getActiveInstance().checkPermission(Jenkins.READ);
p.parseArgument(args.toArray(new String[args.size()]));
- Authentication auth = authenticator.authenticate();
+ auth = authenticator.authenticate();
if (auth==Jenkins.ANONYMOUS)
auth = loadStoredAuthentication();
sc.setAuthentication(auth); // run the CLI with the right credential
- if (!(this instanceof LoginCommand || this instanceof HelpCommand))
+ if (!(this instanceof LoginCommand || this instanceof LogoutCommand || this instanceof HelpCommand || this instanceof WhoAmICommand))
Jenkins.getActiveInstance().checkPermission(Jenkins.READ);
- return run();
+ LOGGER.log(Level.FINE, "Invoking CLI command {0}, with {1} arguments, as user {2}.",
+ new Object[] {getName(), args.size(), auth.getName()});
+ int res = run();
+ LOGGER.log(Level.FINE, "Executed CLI command {0}, with {1} arguments, as user {2}, return code {3}",
+ new Object[] {getName(), args.size(), auth.getName(), res});
+ return res;
} catch (CmdLineException e) {
+ LOGGER.log(Level.FINE, String.format("Failed call to CLI command %s, with %d arguments, as user %s.",
+ getName(), args.size(), auth != null ? auth.getName() : "<unknown>"), e);
stderr.println("");
stderr.println("ERROR: " + e.getMessage());
printUsage(stderr, p);
return 2;
} catch (IllegalStateException e) {
+ LOGGER.log(Level.FINE, String.format("Failed call to CLI command %s, with %d arguments, as user %s.",
+ getName(), args.size(), auth != null ? auth.getName() : "<unknown>"), e);
stderr.println("");
stderr.println("ERROR: " + e.getMessage());
return 4;
} catch (IllegalArgumentException e) {
+ LOGGER.log(Level.FINE, String.format("Failed call to CLI command %s, with %d arguments, as user %s.",
+ getName(), args.size(), auth != null ? auth.getName() : "<unknown>"), e);
stderr.println("");
stderr.println("ERROR: " + e.getMessage());
return 3;
} catch (AbortException e) {
+ LOGGER.log(Level.FINE, String.format("Failed call to CLI command %s, with %d arguments, as user %s.",
+ getName(), args.size(), auth != null ? auth.getName() : "<unknown>"), e);
// signals an error without stack trace
stderr.println("");
stderr.println("ERROR: " + e.getMessage());
return 5;
} catch (AccessDeniedException e) {
+ LOGGER.log(Level.FINE, String.format("Failed call to CLI command %s, with %d arguments, as user %s.",
+ getName(), args.size(), auth != null ? auth.getName() : "<unknown>"), e);
stderr.println("");
stderr.println("ERROR: " + e.getMessage());
return 6;
diff --git a/core/src/main/java/hudson/cli/CliProtocol.java b/core/src/main/java/hudson/cli/CliProtocol.java
index 58b5c95a6438fb31266bf61f4c765241379957c9..30e18b9cb0efd5b92d24b294e1f843c6009994f8 100644
--- a/core/src/main/java/hudson/cli/CliProtocol.java
+++ b/core/src/main/java/hudson/cli/CliProtocol.java
@@ -39,7 +39,7 @@ public class CliProtocol extends AgentProtocol {
*/
@Override
public boolean isOptIn() {
- return OPT_IN;
+ return true;
}
@Override
@@ -109,14 +109,4 @@ public class CliProtocol extends AgentProtocol {
channel.join();
}
}
-
- /**
- * A/B test turning off this protocol by default.
- */
- private static final boolean OPT_IN;
-
- static {
- byte hash = Util.fromHexString(Jenkins.getInstance().getLegacyInstanceId())[0];
- OPT_IN = (hash % 10) == 0;
- }
}
diff --git a/core/src/main/java/hudson/cli/CliProtocol2.java b/core/src/main/java/hudson/cli/CliProtocol2.java
index 9fca4055fb10e67295186fc80c43b7fc89a27c2b..6e181714bb93b88640b06d728ce6cefa1ac2ab38 100644
--- a/core/src/main/java/hudson/cli/CliProtocol2.java
+++ b/core/src/main/java/hudson/cli/CliProtocol2.java
@@ -35,7 +35,7 @@ public class CliProtocol2 extends CliProtocol {
*/
@Override
public boolean isOptIn() {
- return false;
+ return true;
}
@Override
diff --git a/core/src/main/java/hudson/cli/ClientAuthenticationCache.java b/core/src/main/java/hudson/cli/ClientAuthenticationCache.java
index 48b96f46864f5ccf191eabe66658dec7d7024114..2cd45a77766f373035938f234f3ec47215114b84 100644
--- a/core/src/main/java/hudson/cli/ClientAuthenticationCache.java
+++ b/core/src/main/java/hudson/cli/ClientAuthenticationCache.java
@@ -53,16 +53,7 @@ public class ClientAuthenticationCache implements Serializable {
final Properties props = new Properties();
public ClientAuthenticationCache(Channel channel) throws IOException, InterruptedException {
- store = (channel==null ? FilePath.localChannel : channel).call(new MasterToSlaveCallable<FilePath, IOException>() {
- public FilePath call() throws IOException {
- File home = new File(System.getProperty("user.home"));
- File hudsonHome = new File(home, ".hudson");
- if (hudsonHome.exists()) {
- return new FilePath(new File(hudsonHome, "cli-credentials"));
- }
- return new FilePath(new File(home, ".jenkins/cli-credentials"));
- }
- });
+ store = (channel==null ? FilePath.localChannel : channel).call(new CredentialsFilePathMasterToSlaveCallable());
if (store.exists()) {
try (InputStream istream = store.read()) {
props.load(istream);
@@ -151,4 +142,15 @@ public class ClientAuthenticationCache implements Serializable {
// try to protect this file from other users, if we can.
store.chmod(0600);
}
+
+ private static class CredentialsFilePathMasterToSlaveCallable extends MasterToSlaveCallable<FilePath, IOException> {
+ public FilePath call() throws IOException {
+ File home = new File(System.getProperty("user.home"));
+ File hudsonHome = new File(home, ".hudson");
+ if (hudsonHome.exists()) {
+ return new FilePath(new File(hudsonHome, "cli-credentials"));
+ }
+ return new FilePath(new File(home, ".jenkins/cli-credentials"));
+ }
+ }
}
diff --git a/core/src/main/java/hudson/cli/ConsoleCommand.java b/core/src/main/java/hudson/cli/ConsoleCommand.java
index f98fdc95a29594a98fb4da2f0d81bb3aeac36215..8965af0fe6957553ebae2bc57c7fd2aa1d8d4a66 100644
--- a/core/src/main/java/hudson/cli/ConsoleCommand.java
+++ b/core/src/main/java/hudson/cli/ConsoleCommand.java
@@ -41,7 +41,7 @@ public class ConsoleCommand extends CLICommand {
public int n = -1;
protected int run() throws Exception {
- job.checkPermission(Item.BUILD);
+ job.checkPermission(Item.READ);
Run<?,?> run;
diff --git a/core/src/main/java/hudson/cli/DeleteBuildsCommand.java b/core/src/main/java/hudson/cli/DeleteBuildsCommand.java
index db86c433ab538a8317058766afdc4f4d39dd93b5..bd1768786cd4c5bfd6e9df37547eda439b6a8632 100644
--- a/core/src/main/java/hudson/cli/DeleteBuildsCommand.java
+++ b/core/src/main/java/hudson/cli/DeleteBuildsCommand.java
@@ -31,14 +31,14 @@ import java.io.PrintStream;
import java.util.HashSet;
import java.util.List;
import org.kohsuke.accmod.Restricted;
-import org.kohsuke.accmod.restrictions.DoNotUse;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
/**
* Deletes builds records in a bulk.
*
* @author Kohsuke Kawaguchi
*/
-@Restricted(DoNotUse.class) // command implementation only
+@Restricted(NoExternalUse.class) // command implementation only
@Extension
public class DeleteBuildsCommand extends RunRangeCommand {
@Override
diff --git a/core/src/main/java/hudson/cli/DisablePluginCommand.java b/core/src/main/java/hudson/cli/DisablePluginCommand.java
new file mode 100644
index 0000000000000000000000000000000000000000..36d4b6bd8ca4b0ec0e60cfe1d66bd49bbc3afbeb
--- /dev/null
+++ b/core/src/main/java/hudson/cli/DisablePluginCommand.java
@@ -0,0 +1,236 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2018 CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package hudson.cli;
+
+import hudson.Extension;
+import hudson.PluginWrapper;
+import hudson.lifecycle.RestartNotSupportedException;
+import jenkins.model.Jenkins;
+import org.kohsuke.args4j.Argument;
+import org.kohsuke.args4j.Option;
+
+import java.io.PrintStream;
+import java.util.List;
+
+/**
+ * Disable one or more installed plugins.
+ * @since TODO
+ */
+@Extension
+public class DisablePluginCommand extends CLICommand {
+
+ @Argument(metaVar = "plugin1 plugin2 plugin3", required = true, usage = "Plugins to be disabled.")
+ private List<String> pluginNames;
+
+ @Option(name = "-restart", aliases = "-r", usage = "Restart Jenkins after disabling plugins.")
+ private boolean restart;
+
+ @Option(name = "-strategy", aliases = "-s", metaVar = "strategy", usage = "How to process the dependant plugins. \n" +
+ "- none: if a mandatory dependant plugin exists and it is enabled, the plugin cannot be disabled (default value).\n" +
+ "- mandatory: all mandatory dependant plugins are also disabled, optional dependant plugins remain enabled.\n" +
+ "- all: all dependant plugins are also disabled, no matter if its dependency is optional or mandatory.")
+ private String strategy = PluginWrapper.PluginDisableStrategy.NONE.toString();
+
+ @Option(name = "-quiet", aliases = "-q", usage = "Be quiet, print only the error messages")
+ private boolean quiet;
+
+ private static final int INDENT_SPACE = 3;
+
+ @Override
+ public String getShortDescription() {
+ return Messages.DisablePluginCommand_ShortDescription();
+ }
+
+ // package-private access to be able to use it in the tests
+ static final int RETURN_CODE_NOT_DISABLED_DEPENDANTS = 16;
+ static final int RETURN_CODE_NO_SUCH_PLUGIN = 17;
+
+ @Override
+ protected void printUsageSummary(PrintStream stderr) {
+ super.printUsageSummary(stderr);
+ stderr.println(Messages.DisablePluginCommand_PrintUsageSummary());
+ }
+
+ @Override
+ protected int run() throws Exception {
+ Jenkins jenkins = Jenkins.get();
+ jenkins.checkPermission(Jenkins.ADMINISTER);
+
+ // get the strategy as an enum
+ PluginWrapper.PluginDisableStrategy strategyToUse;
+ try {
+ strategyToUse = PluginWrapper.PluginDisableStrategy.valueOf(strategy.toUpperCase());
+ } catch (IllegalArgumentException iae) {
+ throw new IllegalArgumentException(hudson.cli.Messages.DisablePluginCommand_NoSuchStrategy(strategy, String.format("%s, %s, %s", PluginWrapper.PluginDisableStrategy.NONE, PluginWrapper.PluginDisableStrategy.MANDATORY, PluginWrapper.PluginDisableStrategy.ALL)));
+ }
+
+ // disable...
+ List<PluginWrapper.PluginDisableResult> results = jenkins.pluginManager.disablePlugins(strategyToUse, pluginNames);
+
+ // print results ...
+ printResults(results);
+
+ // restart if it was required and it's necessary (at least one plugin was disabled in this execution)
+ restartIfNecessary(results);
+
+ // return the appropriate error code
+ return getResultCode(results);
+ }
+
+ /**
+ * Print the result of all the process
+ * @param results the list of results for the disablement of each plugin
+ */
+ private void printResults(List<PluginWrapper.PluginDisableResult> results) {
+ for (PluginWrapper.PluginDisableResult oneResult : results) {
+ printResult(oneResult, 0);
+ }
+ }
+
+ /**
+ * Print indented the arguments with the format passed beginning with the indent passed.
+ * @param indent number of spaces at the beginning.
+ * @param format format as in {@link String#format(String, Object...)}
+ * @param arguments arguments to print as in {@link String#format(String, Object...)}
+ */
+ private void printIndented(int indent, String format, String... arguments) {
+ if (indent == 0) {
+ stdout.format(format + "%n", (Object[]) arguments);
+ } else {
+ String[] newArgs = new String[arguments.length + 1];
+ newArgs[0] = " ";
+ System.arraycopy(arguments, 0, newArgs, 1, arguments.length);
+
+ String f = "%" + indent + "s" + format + "%n";
+ stdout.format(f, newArgs);
+ }
+ }
+
+ /**
+ * Print the result of a plugin disablement with the indent passed.
+ * @param oneResult the result of the disablement of a plugin.
+ * @param indent the initial indent.
+ */
+ private void printResult(PluginWrapper.PluginDisableResult oneResult, int indent) {
+ PluginWrapper.PluginDisableStatus status = oneResult.getStatus();
+ if (quiet && (PluginWrapper.PluginDisableStatus.DISABLED.equals(status) || PluginWrapper.PluginDisableStatus.ALREADY_DISABLED.equals(status))) {
+ return;
+ }
+
+ printIndented(indent, Messages.DisablePluginCommand_StatusMessage(oneResult.getPlugin(), oneResult.getStatus(), oneResult.getMessage()));
+ if (oneResult.getDependantsDisableStatus().size() > 0) {
+ indent += INDENT_SPACE;
+ for (PluginWrapper.PluginDisableResult oneDependantResult : oneResult.getDependantsDisableStatus()) {
+ printResult(oneDependantResult, indent);
+ }
+ }
+ }
+
+ /**
+ * Restart if at least one plugin was disabled in this process.
+ * @param results the list of results after the disablement of the plugins.
+ */
+ private void restartIfNecessary(List<PluginWrapper.PluginDisableResult> results) throws RestartNotSupportedException {
+ if (restart) {
+ for (PluginWrapper.PluginDisableResult oneResult : results) {
+ if (restartIfNecessary(oneResult)) {
+ break;
+ }
+ }
+ }
+ }
+
+ /**
+ * Restart if this particular result of the disablement of a plugin and its dependant plugins (depending on the
+ * strategy used) has a plugin disablexd.
+ * @param oneResult the result of a plugin (and its dependants).
+ * @return true if it end up in restarting jenkins.
+ */
+ private boolean restartIfNecessary(PluginWrapper.PluginDisableResult oneResult) throws RestartNotSupportedException {
+ PluginWrapper.PluginDisableStatus status = oneResult.getStatus();
+ if (PluginWrapper.PluginDisableStatus.DISABLED.equals(status)) {
+ Jenkins.get().safeRestart();
+ return true;
+ }
+
+ if (oneResult.getDependantsDisableStatus().size() > 0) {
+ for (PluginWrapper.PluginDisableResult oneDependantResult : oneResult.getDependantsDisableStatus()) {
+ if (restartIfNecessary(oneDependantResult)) {
+ return true;
+ }
+ }
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Calculate the result code of the full process based in what went on during the process
+ * @param results he list of results for the disablement of each plugin
+ * @return the status code. 0 if all plugins disabled. {@link #RETURN_CODE_NOT_DISABLED_DEPENDANTS} if some
+ * dependant plugin is not disabled (with strategy NONE), {@link #RETURN_CODE_NO_SUCH_PLUGIN} if some passed
+ * plugin doesn't exist. Whatever happens first.
+ */
+ private int getResultCode(List<PluginWrapper.PluginDisableResult> results) {
+ int result = 0;
+ for (PluginWrapper.PluginDisableResult oneResult : results) {
+ result = getResultCode(oneResult);
+ if (result != 0) {
+ break;
+ }
+ }
+
+ return result;
+ }
+
+ /**
+ * Calculate the result code of the disablement of one plugin based in what went on during the process of this one
+ * and its dependant plugins.
+ * @param result the result of the disablement of this plugin
+ * @return the status code
+ */
+ private int getResultCode(PluginWrapper.PluginDisableResult result) {
+ int returnCode = 0;
+ switch (result.getStatus()){
+ case NOT_DISABLED_DEPENDANTS:
+ returnCode = RETURN_CODE_NOT_DISABLED_DEPENDANTS;
+ break;
+ case NO_SUCH_PLUGIN:
+ returnCode = RETURN_CODE_NO_SUCH_PLUGIN;
+ }
+
+ if (returnCode == 0) {
+ for (PluginWrapper.PluginDisableResult oneDependantResult : result.getDependantsDisableStatus()) {
+ returnCode = getResultCode(oneDependantResult);
+ if (returnCode != 0) {
+ break;
+ }
+ }
+ }
+
+ return returnCode;
+ }
+}
diff --git a/core/src/main/java/hudson/cli/EnablePluginCommand.java b/core/src/main/java/hudson/cli/EnablePluginCommand.java
new file mode 100644
index 0000000000000000000000000000000000000000..fcee649c03d8d1d4ad605a656d835296a2e16b04
--- /dev/null
+++ b/core/src/main/java/hudson/cli/EnablePluginCommand.java
@@ -0,0 +1,102 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2018 CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package hudson.cli;
+
+import hudson.Extension;
+import hudson.PluginManager;
+import hudson.PluginWrapper;
+import jenkins.model.Jenkins;
+import org.kohsuke.args4j.Argument;
+import org.kohsuke.args4j.Option;
+
+import java.io.IOException;
+import java.util.List;
+
+/**
+ * Enables one or more installed plugins. The listed plugins must already be installed along with its dependencies.
+ * Any listed plugin with disabled dependencies will have its dependencies enabled transitively. Note that enabling an
+ * already enabled plugin does nothing.
+ *
+ * @since 2.136
+ */
+@Extension
+public class EnablePluginCommand extends CLICommand {
+
+ @Argument(required = true, usage = "Enables the plugins with the given short names and their dependencies.")
+ private List<String> pluginNames;
+
+ @Option(name = "-restart", usage = "Restart Jenkins after enabling plugins.")
+ private boolean restart;
+
+ @Override
+ public String getShortDescription() {
+ return Messages.EnablePluginCommand_ShortDescription();
+ }
+
+ @Override
+ protected int run() throws Exception {
+ Jenkins jenkins = Jenkins.get();
+ jenkins.checkPermission(Jenkins.ADMINISTER);
+ PluginManager manager = jenkins.getPluginManager();
+ boolean enabledAnyPlugins = false;
+ for (String pluginName : pluginNames) {
+ enabledAnyPlugins |= enablePlugin(manager, pluginName);
+ }
+ if (restart && enabledAnyPlugins) {
+ jenkins.safeRestart();
+ }
+ return 0;
+ }
+
+ private boolean enablePlugin(PluginManager manager, String shortName) throws IOException {
+ PluginWrapper plugin = manager.getPlugin(shortName);
+ if (plugin == null) {
+ throw new IllegalArgumentException(Messages.EnablePluginCommand_NoSuchPlugin(shortName));
+ }
+ if (plugin.isEnabled()) {
+ return false;
+ }
+ stdout.println(String.format("Enabling plugin `%s' (%s)", plugin.getShortName(), plugin.getVersion()));
+ enableDependencies(manager, plugin);
+ plugin.enable();
+ stdout.println(String.format("Plugin `%s' was enabled.", plugin.getShortName()));
+ return true;
+ }
+
+ private void enableDependencies(PluginManager manager, PluginWrapper plugin) throws IOException {
+ for (PluginWrapper.Dependency dep : plugin.getDependencies()) {
+ PluginWrapper dependency = manager.getPlugin(dep.shortName);
+ if (dependency == null) {
+ throw new IllegalArgumentException(Messages.EnablePluginCommand_MissingDependencies(plugin.getShortName(), dep));
+ }
+ if (!dependency.isEnabled()) {
+ enableDependencies(manager, dependency);
+ stdout.println(String.format("Enabling plugin dependency `%s' (%s) for `%s'", dependency.getShortName(), dependency.getVersion(), plugin.getShortName()));
+ dependency.enable();
+ }
+ }
+ }
+
+}
diff --git a/core/src/main/java/hudson/cli/HelpCommand.java b/core/src/main/java/hudson/cli/HelpCommand.java
index 60fcc0970be1f6faa8badffcdfa0b1dde132a42c..7b73c0b31dfef2993e39d773cfc47ad959cc3b06 100644
--- a/core/src/main/java/hudson/cli/HelpCommand.java
+++ b/core/src/main/java/hudson/cli/HelpCommand.java
@@ -53,7 +53,7 @@ public class HelpCommand extends CLICommand {
protected int run() throws Exception {
if (!Jenkins.getActiveInstance().hasPermission(Jenkins.READ)) {
throw new AccessDeniedException("You must authenticate to access this Jenkins.\n"
- + hudson.cli.client.Messages.CLI_Usage());
+ + CLI.usage());
}
if (command != null)
diff --git a/core/src/main/java/hudson/cli/ListChangesCommand.java b/core/src/main/java/hudson/cli/ListChangesCommand.java
index 8da20000734b65a56ab7eb9b6c326a85e443cf2e..1b398bddad9582c0bf01e94721eae9766213e21c 100644
--- a/core/src/main/java/hudson/cli/ListChangesCommand.java
+++ b/core/src/main/java/hudson/cli/ListChangesCommand.java
@@ -15,14 +15,14 @@ import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;
import org.kohsuke.accmod.Restricted;
-import org.kohsuke.accmod.restrictions.DoNotUse;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
/**
* Retrieves a change list for the specified builds.
*
* @author Kohsuke Kawaguchi
*/
-@Restricted(DoNotUse.class) // command implementation only
+@Restricted(NoExternalUse.class) // command implementation only
@Extension
public class ListChangesCommand extends RunRangeCommand {
@Override
diff --git a/core/src/main/java/hudson/cli/ListPluginsCommand.java b/core/src/main/java/hudson/cli/ListPluginsCommand.java
index 99c926cdaf1ef8c648ff1a339b6fdf61314497f2..faa35dfa678897d72a0ed5306d419dadfaf0e296 100644
--- a/core/src/main/java/hudson/cli/ListPluginsCommand.java
+++ b/core/src/main/java/hudson/cli/ListPluginsCommand.java
@@ -47,7 +47,9 @@ public class ListPluginsCommand extends CLICommand {
public String name;
protected int run() {
- Jenkins h = Jenkins.getActiveInstance();
+ Jenkins h = Jenkins.getInstance();
+ h.checkPermission(Jenkins.ADMINISTER);
+
PluginManager pluginManager = h.getPluginManager();
if (this.name != null) {
diff --git a/core/src/main/java/hudson/cli/declarative/CLIMethod.java b/core/src/main/java/hudson/cli/declarative/CLIMethod.java
index d4e6c96ed4c2bf762a415b15297d9e764a7038ce..6366e4409ed667f116f64c06af8f37e9fd38d230 100644
--- a/core/src/main/java/hudson/cli/declarative/CLIMethod.java
+++ b/core/src/main/java/hudson/cli/declarative/CLIMethod.java
@@ -38,8 +38,8 @@ import java.lang.annotation.Target;
* Annotates methods on model objects to expose them as CLI commands.
*
* <p>
- * You need to have <tt>Messages.properties</tt> in the same package with the
- * <tt>CLI.<i>command-name</i>.shortDescription</tt> key to describe the command.
+ * You need to have {@code Messages.properties} in the same package with the
+ * {@code CLI.<i>command-name</i>.shortDescription} key to describe the command.
* This is used for the same purpose as {@link CLICommand#getShortDescription()}.
*
* <p>
diff --git a/core/src/main/java/hudson/cli/declarative/CLIResolver.java b/core/src/main/java/hudson/cli/declarative/CLIResolver.java
index 2b31b47f2790f61d9c4b93ec142a0e6611b53967..5c4b93444e8e27f5ece3869135317d5b97a3616c 100644
--- a/core/src/main/java/hudson/cli/declarative/CLIResolver.java
+++ b/core/src/main/java/hudson/cli/declarative/CLIResolver.java
@@ -40,12 +40,12 @@ import java.lang.annotation.Target;
* <p>
* Hudson uses the return type of the resolver method
* to pick the resolver method to use, of all the resolver methods it discovers. That is,
- * if Hudson is looking to find an instance of type <tt>T</tt> for the current command, it first
- * looks for the resolver method whose return type is <tt>T</tt>, then it checks for the base type of <tt>T</tt>,
+ * if Hudson is looking to find an instance of type {@code T} for the current command, it first
+ * looks for the resolver method whose return type is {@code T}, then it checks for the base type of {@code T},
* and so on.
*
* <p>
- * If the chosen resolver method is an instance method on type <tt>S</tt>, the "parent resolver" is then
+ * If the chosen resolver method is an instance method on type {@code S}, the "parent resolver" is then
* located to resolve an instance of type 'S'. This process repeats until a static resolver method is discovered
* (since most of Hudson's model objects are anchored to the root {@link jenkins.model.Jenkins} object, normally that would become
* the top-most resolver method.)
diff --git a/core/src/main/java/hudson/cli/handlers/GenericItemOptionHandler.java b/core/src/main/java/hudson/cli/handlers/GenericItemOptionHandler.java
index 6cd1d86eba57141695824a9ec52c22a8cad074f7..0648f057a04b28ab7aff06b283e6159b36a93054 100644
--- a/core/src/main/java/hudson/cli/handlers/GenericItemOptionHandler.java
+++ b/core/src/main/java/hudson/cli/handlers/GenericItemOptionHandler.java
@@ -62,7 +62,7 @@ public abstract class GenericItemOptionHandler<T extends Item> extends OptionHan
T s = j.getItemByFullName(src, type());
if (s == null) {
final Authentication who = Jenkins.getAuthentication();
- try (ACLContext _ = ACL.as(ACL.SYSTEM)) {
+ try (ACLContext acl = ACL.as(ACL.SYSTEM)) {
Item actual = j.getItemByFullName(src);
if (actual == null) {
LOGGER.log(Level.FINE, "really no item exists named {0}", src);
diff --git a/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java b/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java
index 729d6f571b2ed1cca2fd7707c14993577458764e..6107855812c3de7b8b16c35dd1fd8f6b1c836b2f 100644
--- a/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java
+++ b/core/src/main/java/hudson/cli/handlers/ViewOptionHandler.java
@@ -48,7 +48,7 @@ import javax.annotation.CheckForNull;
* For example:
* <dl>
* <dt>my_view_name</dt><dd>refers to a top level view with given name.</dd>
- * <dt>nested/inner</dt><dd>refers to a view named <tt>inner</tt> inside of a top level view group named <tt>nested</tt>.</dd>
+ * <dt>nested/inner</dt><dd>refers to a view named {@code inner} inside of a top level view group named {@code nested}.</dd>
* </dl>
*
* <p>
@@ -103,12 +103,13 @@ public class ViewOptionHandler extends OptionHandler<View> {
String viewName = tok.nextToken();
view = group.getView(viewName);
- if (view == null)
+ if (view == null) {
+ group.checkPermission(View.READ);
throw new IllegalArgumentException(String.format(
"No view named %s inside view %s",
viewName, group.getDisplayName()
));
-
+ }
view.checkPermission(View.READ);
if (view instanceof ViewGroup) {
group = (ViewGroup) view;
diff --git a/core/src/main/java/hudson/console/AnnotatedLargeText.java b/core/src/main/java/hudson/console/AnnotatedLargeText.java
index 897661329cc1b6e4b0b2dad80c08f3a8ac08920c..6acbdeff6e78e90b0ccbd0529e9bcd19e2b8bbec 100644
--- a/core/src/main/java/hudson/console/AnnotatedLargeText.java
+++ b/core/src/main/java/hudson/console/AnnotatedLargeText.java
@@ -52,6 +52,7 @@ import com.jcraft.jzlib.GZIPInputStream;
import com.jcraft.jzlib.GZIPOutputStream;
import static java.lang.Math.abs;
+import org.jenkinsci.remoting.util.AnonymousClassWarnings;
/**
* Extension to {@link LargeText} that handles annotations by {@link ConsoleAnnotator}.
@@ -112,7 +113,7 @@ public class AnnotatedLargeText<T> extends LargeText {
rsp.setContentType(isHtml() ? "text/html;charset=UTF-8" : "text/plain;charset=UTF-8");
}
- private ConsoleAnnotator createAnnotator(StaplerRequest req) throws IOException {
+ private ConsoleAnnotator<T> createAnnotator(StaplerRequest req) throws IOException {
try {
String base64 = req!=null ? req.getHeader("X-ConsoleAnnotator") : null;
if (base64!=null) {
@@ -134,7 +135,7 @@ public class AnnotatedLargeText<T> extends LargeText {
throw new IOException(e);
}
// start from scratch
- return ConsoleAnnotator.initial(context==null ? null : context.getClass());
+ return ConsoleAnnotator.initial(context);
}
@Override
@@ -163,13 +164,13 @@ public class AnnotatedLargeText<T> extends LargeText {
}
public long writeHtmlTo(long start, Writer w) throws IOException {
- ConsoleAnnotationOutputStream caw = new ConsoleAnnotationOutputStream(
+ ConsoleAnnotationOutputStream<T> caw = new ConsoleAnnotationOutputStream<>(
w, createAnnotator(Stapler.getCurrentRequest()), context, charset);
long r = super.writeLogTo(start,caw);
ByteArrayOutputStream baos = new ByteArrayOutputStream();
Cipher sym = PASSING_ANNOTATOR.encrypt();
- ObjectOutputStream oos = new ObjectOutputStream(new GZIPOutputStream(new CipherOutputStream(baos,sym)));
+ ObjectOutputStream oos = AnonymousClassWarnings.checkingObjectOutputStream(new GZIPOutputStream(new CipherOutputStream(baos,sym)));
oos.writeLong(System.currentTimeMillis()); // send timestamp to prevent a replay attack
oos.writeObject(caw.getConsoleAnnotator());
oos.close();
diff --git a/core/src/main/java/hudson/console/ConsoleAnnotationOutputStream.java b/core/src/main/java/hudson/console/ConsoleAnnotationOutputStream.java
index 919e3af0117fb48e9a9788e85dc2ce07d0fbcf36..f3a22c875cbdc9041424a7ab71070c9e5d8c5472 100644
--- a/core/src/main/java/hudson/console/ConsoleAnnotationOutputStream.java
+++ b/core/src/main/java/hudson/console/ConsoleAnnotationOutputStream.java
@@ -72,7 +72,7 @@ public class ConsoleAnnotationOutputStream<T> extends LineTransformationOutputSt
this.lineOut = new WriterOutputStream(line,charset);
}
- public ConsoleAnnotator getConsoleAnnotator() {
+ public ConsoleAnnotator<T> getConsoleAnnotator() {
return ann;
}
@@ -80,6 +80,8 @@ public class ConsoleAnnotationOutputStream<T> extends LineTransformationOutputSt
* Called after we read the whole line of plain text, which is stored in {@link #buf}.
* This method performs annotations and send the result to {@link #out}.
*/
+ @SuppressWarnings({"unchecked", "rawtypes"}) // appears to be unsound
+ @Override
protected void eol(byte[] in, int sz) throws IOException {
line.reset();
final StringBuffer strBuf = line.getStringBuffer();
@@ -109,9 +111,10 @@ public class ConsoleAnnotationOutputStream<T> extends LineTransformationOutputSt
final ConsoleNote a = ConsoleNote.readFrom(new DataInputStream(b));
if (a!=null) {
if (annotators==null)
- annotators = new ArrayList<ConsoleAnnotator<T>>();
+ annotators = new ArrayList<>();
annotators.add(new ConsoleAnnotator<T>() {
- public ConsoleAnnotator annotate(T context, MarkupText text) {
+ @Override
+ public ConsoleAnnotator<T> annotate(T context, MarkupText text) {
return a.annotate(context,text,charPos);
}
});
diff --git a/core/src/main/java/hudson/console/ConsoleAnnotator.java b/core/src/main/java/hudson/console/ConsoleAnnotator.java
index c19ac974b686064cd0adb7767065c7d04a6a3af4..9701eb302f04d54476154473e0b8bc85aa5fe346 100644
--- a/core/src/main/java/hudson/console/ConsoleAnnotator.java
+++ b/core/src/main/java/hudson/console/ConsoleAnnotator.java
@@ -82,50 +82,54 @@ public abstract class ConsoleAnnotator<T> implements Serializable {
* To indicate that you are not interested in the following lines, return {@code null}.
*/
@CheckForNull
- public abstract ConsoleAnnotator annotate(@Nonnull T context, @Nonnull MarkupText text );
+ public abstract ConsoleAnnotator<T> annotate(@Nonnull T context, @Nonnull MarkupText text );
/**
* Cast operation that restricts T.
*/
+ @SuppressWarnings("unchecked")
public static <T> ConsoleAnnotator<T> cast(ConsoleAnnotator<? super T> a) {
return (ConsoleAnnotator)a;
}
- /**
- * Bundles all the given {@link ConsoleAnnotator} into a single annotator.
- */
- public static <T> ConsoleAnnotator<T> combine(Collection<? extends ConsoleAnnotator<? super T>> all) {
- switch (all.size()) {
- case 0: return null; // none
- case 1: return cast(all.iterator().next()); // just one
- }
-
- class Aggregator extends ConsoleAnnotator<T> {
- List<ConsoleAnnotator<T>> list;
+ @SuppressWarnings({"unchecked", "rawtypes"}) // unclear to jglick what is going on here
+ private static final class ConsoleAnnotatorAggregator<T> extends ConsoleAnnotator<T> {
+ List<ConsoleAnnotator<T>> list;
- Aggregator(Collection list) {
- this.list = new ArrayList<ConsoleAnnotator<T>>(list);
- }
+ ConsoleAnnotatorAggregator(Collection list) {
+ this.list = new ArrayList<>(list);
+ }
- public ConsoleAnnotator annotate(T context, MarkupText text) {
- ListIterator<ConsoleAnnotator<T>> itr = list.listIterator();
- while (itr.hasNext()) {
- ConsoleAnnotator a = itr.next();
- ConsoleAnnotator b = a.annotate(context,text);
- if (a!=b) {
- if (b==null) itr.remove();
- else itr.set(b);
- }
+ @Override
+ public ConsoleAnnotator annotate(T context, MarkupText text) {
+ ListIterator<ConsoleAnnotator<T>> itr = list.listIterator();
+ while (itr.hasNext()) {
+ ConsoleAnnotator a = itr.next();
+ ConsoleAnnotator b = a.annotate(context,text);
+ if (a!=b) {
+ if (b==null) itr.remove();
+ else itr.set(b);
}
+ }
- switch (list.size()) {
+ switch (list.size()) {
case 0: return null; // no more annotator left
case 1: return list.get(0); // no point in aggregating
default: return this;
- }
}
}
- return new Aggregator(all);
+ }
+
+ /**
+ * Bundles all the given {@link ConsoleAnnotator} into a single annotator.
+ */
+ public static <T> ConsoleAnnotator<T> combine(Collection<? extends ConsoleAnnotator<? super T>> all) {
+ switch (all.size()) {
+ case 0: return null; // none
+ case 1: return cast(all.iterator().next()); // just one
+ }
+
+ return new ConsoleAnnotatorAggregator<>(all);
}
/**
@@ -139,8 +143,9 @@ public abstract class ConsoleAnnotator<T> implements Serializable {
/**
* List all the console annotators that can work for the specified context type.
*/
+ @SuppressWarnings({"unchecked", "rawtypes"}) // reflective
public static <T> List<ConsoleAnnotator<T>> _for(T context) {
- List<ConsoleAnnotator<T>> r = new ArrayList<ConsoleAnnotator<T>>();
+ List<ConsoleAnnotator<T>> r = new ArrayList<>();
for (ConsoleAnnotatorFactory f : ConsoleAnnotatorFactory.all()) {
if (f.type().isInstance(context)) {
ConsoleAnnotator ca = f.newInstance(context);
diff --git a/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java b/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java
index f71b25e53edccf2497f08da4ef06a3779b243c2c..409ee59c67f4c531996b33b20e9a6f33bb6b14f0 100644
--- a/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java
+++ b/core/src/main/java/hudson/console/ConsoleAnnotatorFactory.java
@@ -58,7 +58,7 @@ import java.net.URL;
*
* <h2>Behaviour, JavaScript, and CSS</h2>
* <p>
- * {@link ConsoleNote} can have associated <tt>script.js</tt> and <tt>style.css</tt> (put them
+ * {@link ConsoleNote} can have associated {@code script.js} and {@code style.css} (put them
* in the same resource directory that you normally put Jelly scripts), which will be loaded into
* the HTML page whenever the console notes are used. This allows you to use minimal markup in
* code generation, and do the styling in CSS and perform the rest of the interesting work as a CSS behaviour/JavaScript.
@@ -80,13 +80,13 @@ public abstract class ConsoleAnnotatorFactory<T> implements ExtensionPoint {
* @return
* null if this factory is not going to participate in the annotation of this console.
*/
- public abstract ConsoleAnnotator newInstance(T context);
+ public abstract ConsoleAnnotator<T> newInstance(T context);
/**
* For which context type does this annotator work?
*/
- public Class type() {
- Type type = Types.getBaseClass(getClass(), ConsoleAnnotator.class);
+ public Class<?> type() {
+ Type type = Types.getBaseClass(getClass(), ConsoleAnnotatorFactory.class);
if (type instanceof ParameterizedType)
return Types.erasure(Types.getTypeArgument(type,0));
else
@@ -105,7 +105,7 @@ public abstract class ConsoleAnnotatorFactory<T> implements ExtensionPoint {
}
private URL getResource(String fileName) {
- Class c = getClass();
+ Class<?> c = getClass();
return c.getClassLoader().getResource(c.getName().replace('.','/').replace('$','/')+ fileName);
}
@@ -125,6 +125,7 @@ public abstract class ConsoleAnnotatorFactory<T> implements ExtensionPoint {
/**
* All the registered instances.
*/
+ @SuppressWarnings("rawtypes")
public static ExtensionList<ConsoleAnnotatorFactory> all() {
return ExtensionList.lookup(ConsoleAnnotatorFactory.class);
}
diff --git a/core/src/main/java/hudson/console/ConsoleNote.java b/core/src/main/java/hudson/console/ConsoleNote.java
index c0b281c6ca9bce6cfda181c35b98aca9ae8dbe45..a572a966b614a2b8f10b451ecd8ae696eab6cbc2 100644
--- a/core/src/main/java/hudson/console/ConsoleNote.java
+++ b/core/src/main/java/hudson/console/ConsoleNote.java
@@ -54,6 +54,7 @@ import com.jcraft.jzlib.GZIPOutputStream;
import hudson.remoting.ClassFilter;
import jenkins.security.HMACConfidentialKey;
import jenkins.util.SystemProperties;
+import org.jenkinsci.remoting.util.AnonymousClassWarnings;
/**
* Data that hangs off from a console output.
@@ -108,7 +109,7 @@ import jenkins.util.SystemProperties;
*
* <h2>Behaviour, JavaScript, and CSS</h2>
* <p>
- * {@link ConsoleNote} can have associated <tt>script.js</tt> and <tt>style.css</tt> (put them
+ * {@link ConsoleNote} can have associated {@code script.js} and {@code style.css} (put them
* in the same resource directory that you normally put Jelly scripts), which will be loaded into
* the HTML page whenever the console notes are used. This allows you to use minimal markup in
* code generation, and do the styling in CSS and perform the rest of the interesting work as a CSS behaviour/JavaScript.
@@ -180,7 +181,7 @@ public abstract class ConsoleNote<T> implements Serializable, Describable<Consol
private ByteArrayOutputStream encodeToBytes() throws IOException {
ByteArrayOutputStream buf = new ByteArrayOutputStream();
- try (ObjectOutputStream oos = new ObjectOutputStream(new GZIPOutputStream(buf))) {
+ try (ObjectOutputStream oos = AnonymousClassWarnings.checkingObjectOutputStream(new GZIPOutputStream(buf))) {
oos.writeObject(this);
}
diff --git a/core/src/main/java/hudson/console/HyperlinkNote.java b/core/src/main/java/hudson/console/HyperlinkNote.java
index 79fbbffc70ec1284d530da6b7eeec284e4b195d7..3f8ccfda1d89ab00a50e809cafb4b443c31d8e76 100644
--- a/core/src/main/java/hudson/console/HyperlinkNote.java
+++ b/core/src/main/java/hudson/console/HyperlinkNote.java
@@ -27,10 +27,13 @@ import hudson.Extension;
import hudson.MarkupText;
import jenkins.model.Jenkins;
import org.jenkinsci.Symbol;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerRequest;
import java.io.IOException;
+import java.util.function.BiFunction;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -75,8 +78,20 @@ public class HyperlinkNote extends ConsoleNote {
}
public static String encodeTo(String url, String text) {
+ return encodeTo(url, text, HyperlinkNote::new);
+ }
+
+ @Restricted(NoExternalUse.class)
+ static String encodeTo(String url, String text, BiFunction<String, Integer, ConsoleNote> constructor) {
+ // If text contains newlines, then its stored length will not match its length when being
+ // displayed, since the display length will only include text up to the first newline,
+ // which will cause an IndexOutOfBoundsException in MarkupText#rangeCheck when
+ // ConsoleAnnotationOutputStream converts the note into markup. That stream treats '\n' as
+ // the sole end-of-line marker on all platforms, so we ignore '\r' because it will not
+ // break the conversion.
+ text = text.replace('\n', ' ');
try {
- return new HyperlinkNote(url,text.length()).encode()+text;
+ return constructor.apply(url,text.length()).encode()+text;
} catch (IOException e) {
// impossible, but don't make this a fatal problem
LOGGER.log(Level.WARNING, "Failed to serialize "+HyperlinkNote.class,e);
@@ -92,4 +107,5 @@ public class HyperlinkNote extends ConsoleNote {
}
private static final Logger LOGGER = Logger.getLogger(HyperlinkNote.class.getName());
+ private static final long serialVersionUID = 3908468829358026949L;
}
diff --git a/core/src/main/java/hudson/console/ModelHyperlinkNote.java b/core/src/main/java/hudson/console/ModelHyperlinkNote.java
index 784934708d62dc95389f0877fd571601d865e61c..127911cc76fa848ac5dee822634739d815960c65 100644
--- a/core/src/main/java/hudson/console/ModelHyperlinkNote.java
+++ b/core/src/main/java/hudson/console/ModelHyperlinkNote.java
@@ -5,8 +5,6 @@ import hudson.model.*;
import jenkins.model.Jenkins;
import org.jenkinsci.Symbol;
-import java.io.IOException;
-import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nonnull;
@@ -57,13 +55,7 @@ public class ModelHyperlinkNote extends HyperlinkNote {
}
public static String encodeTo(String url, String text) {
- try {
- return new ModelHyperlinkNote(url,text.length()).encode()+text;
- } catch (IOException e) {
- // impossible, but don't make this a fatal problem
- LOGGER.log(Level.WARNING, "Failed to serialize "+ModelHyperlinkNote.class,e);
- return text;
- }
+ return HyperlinkNote.encodeTo(url, text, ModelHyperlinkNote::new);
}
@Extension @Symbol("hyperlinkToModels")
diff --git a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java
index 3d842e1d79c5b9bf9535339a4952abd5876c3ee2..56eaf7d941a0f281dd45a3f219204fce04719353 100644
--- a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java
+++ b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java
@@ -31,7 +31,7 @@ import org.jenkinsci.Symbol;
import java.util.logging.Logger;
/**
- * Periodically checks the disk usage of <tt>JENKINS_HOME</tt>,
+ * Periodically checks the disk usage of {@code JENKINS_HOME},
* and activate {@link HudsonHomeDiskUsageMonitor} if necessary.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java
index 337f739dcb827d0d718d83208ff47cc909bf6b00..177141f746fa872774cc63aa1adea6d8fd52cd1b 100644
--- a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java
+++ b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java
@@ -38,7 +38,7 @@ import java.io.IOException;
import java.util.List;
/**
- * Monitors the disk usage of <tt>JENKINS_HOME</tt>, and if it's almost filled up, warn the user.
+ * Monitors the disk usage of {@code JENKINS_HOME}, and if it's almost filled up, warn the user.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/diagnosis/ReverseProxySetupMonitor.java b/core/src/main/java/hudson/diagnosis/ReverseProxySetupMonitor.java
index 38a9215c22aebd50389331a6ac5a6b6685f6b5fe..5e3563f3a4461fb57b60dd0f9a1b7e83bd9487d9 100644
--- a/core/src/main/java/hudson/diagnosis/ReverseProxySetupMonitor.java
+++ b/core/src/main/java/hudson/diagnosis/ReverseProxySetupMonitor.java
@@ -92,7 +92,7 @@ public class ReverseProxySetupMonitor extends AdministrativeMonitor {
// of course the irony is that this redirect won't work
return HttpResponses.redirectViaContextPath("/manage");
} else {
- return new HttpRedirect("https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+says+my+reverse+proxy+setup+is+broken");
+ return new HttpRedirect("https://jenkins.io/redirect/troubleshooting/broken-reverse-proxy");
}
}
diff --git a/core/src/main/java/hudson/init/Initializer.java b/core/src/main/java/hudson/init/Initializer.java
index d41f45da52edba6cc1637d7c33f0bfb4eee50c29..d24a412ae8a30e5d6dacd61f56924e6646aeabd2 100644
--- a/core/src/main/java/hudson/init/Initializer.java
+++ b/core/src/main/java/hudson/init/Initializer.java
@@ -92,7 +92,7 @@ public @interface Initializer {
String[] attains() default {};
/**
- * Key in <tt>Messages.properties</tt> that represents what this task is about. Used for rendering the progress.
+ * Key in {@code Messages.properties} that represents what this task is about. Used for rendering the progress.
* Defaults to "${short class name}.${method Name}".
*/
String displayName() default "";
diff --git a/core/src/main/java/hudson/init/Terminator.java b/core/src/main/java/hudson/init/Terminator.java
index 3e1155babdcfee7954b507a33d93d81fd4a24be9..24bc781fb10a1d5ef8f2a037a8c5b2ef9eb51202 100644
--- a/core/src/main/java/hudson/init/Terminator.java
+++ b/core/src/main/java/hudson/init/Terminator.java
@@ -52,7 +52,7 @@ public @interface Terminator {
String[] attains() default {};
/**
- * Key in <tt>Messages.properties</tt> that represents what this task is about. Used for rendering the progress.
+ * Key in {@code Messages.properties} that represents what this task is about. Used for rendering the progress.
* Defaults to "${short class name}.${method Name}".
*/
String displayName() default "";
diff --git a/core/src/main/java/hudson/init/package-info.java b/core/src/main/java/hudson/init/package-info.java
index 9833d2090ec5adc3f1444d1a8828a2a9f1f519c9..5f66063ca3b2ef245b9491cdf4488513d8421b9d 100644
--- a/core/src/main/java/hudson/init/package-info.java
+++ b/core/src/main/java/hudson/init/package-info.java
@@ -33,7 +33,7 @@
*
* <p>
* Such micro-scopic dependencies are organized into a bigger directed acyclic graph, which is then executed
- * via <tt>Session</tt>. During execution of the reactor, additional tasks can be discovered and added to
+ * via {@code Session}. During execution of the reactor, additional tasks can be discovered and added to
* the DAG. We use this additional indirection to:
*
* <ol>
diff --git a/core/src/main/java/hudson/lifecycle/Lifecycle.java b/core/src/main/java/hudson/lifecycle/Lifecycle.java
index 34915da0de1beab1dbd7c085506d8bb51aab2644..4c52cdd87877e8e91f588831cdfbb244dba9c2d4 100644
--- a/core/src/main/java/hudson/lifecycle/Lifecycle.java
+++ b/core/src/main/java/hudson/lifecycle/Lifecycle.java
@@ -112,7 +112,7 @@ public abstract class Lifecycle implements ExtensionPoint {
}
/**
- * If the location of <tt>jenkins.war</tt> is known in this life cycle,
+ * If the location of {@code jenkins.war} is known in this life cycle,
* return it location. Otherwise return null to indicate that it is unknown.
*
* <p>
@@ -131,7 +131,7 @@ public abstract class Lifecycle implements ExtensionPoint {
*
* <p>
* On some system, most notably Windows, a file being in use cannot be changed,
- * so rewriting <tt>jenkins.war</tt> requires some special trick. Override this method
+ * so rewriting {@code jenkins.war} requires some special trick. Override this method
* to do so.
*/
public void rewriteHudsonWar(File by) throws IOException {
diff --git a/core/src/main/java/hudson/lifecycle/WindowsInstallerLink.java b/core/src/main/java/hudson/lifecycle/WindowsInstallerLink.java
index 14bbb60584bca38a207ca23e8d52c5c8f4a72874..b218d5964077bb45df6909a644e0892276561b18 100644
--- a/core/src/main/java/hudson/lifecycle/WindowsInstallerLink.java
+++ b/core/src/main/java/hudson/lifecycle/WindowsInstallerLink.java
@@ -112,6 +112,8 @@ public class WindowsInstallerLink extends ManagementLink {
*/
@RequirePOST
public void doDoInstall(StaplerRequest req, StaplerResponse rsp, @QueryParameter("dir") String _dir) throws IOException, ServletException {
+ Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
+
if(installationDir!=null) {
// installation already complete
sendError("Installation is already complete",req,rsp);
@@ -121,8 +123,6 @@ public class WindowsInstallerLink extends ManagementLink {
sendError(".NET Framework 2.0 or later is required for this feature",req,rsp);
return;
}
-
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
File dir = new File(_dir).getAbsoluteFile();
dir.mkdirs();
@@ -174,6 +174,8 @@ public class WindowsInstallerLink extends ManagementLink {
@RequirePOST
public void doRestart(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
+ Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
+
if(installationDir==null) {
// if the user reloads the page after Hudson has restarted,
// it comes back here. In such a case, don't let this restart Hudson.
@@ -181,7 +183,6 @@ public class WindowsInstallerLink extends ManagementLink {
rsp.sendRedirect(req.getContextPath()+"/");
return;
}
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
rsp.forward(this,"_restart",req);
final File oldRoot = Jenkins.getInstance().getRootDir();
diff --git a/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java b/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java
index 42519eb21b0b2dc090df02b2331cc928b1e0af61..ad3940b4a4feab58375654f6a0f0bb870c18ad1b 100644
--- a/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java
+++ b/core/src/main/java/hudson/lifecycle/WindowsServiceLifecycle.java
@@ -54,7 +54,7 @@ public class WindowsServiceLifecycle extends Lifecycle {
}
/**
- * If <tt>jenkins.exe</tt> is old compared to our copy,
+ * If {@code jenkins.exe} is old compared to our copy,
* schedule an overwrite (except that since it's currently running,
* we can only do it when Jenkins restarts next time.)
*/
diff --git a/core/src/main/java/hudson/logging/LogRecorder.java b/core/src/main/java/hudson/logging/LogRecorder.java
index 7313778df04399340fc09ac394bee6a6195bb4e7..51549a3bd34d8453945b08d344ed40b2f930239b 100644
--- a/core/src/main/java/hudson/logging/LogRecorder.java
+++ b/core/src/main/java/hudson/logging/LogRecorder.java
@@ -23,6 +23,7 @@
*/
package hudson.logging;
+import com.google.common.annotations.VisibleForTesting;
import com.thoughtworks.xstream.XStream;
import hudson.BulkChange;
import hudson.Extension;
@@ -31,6 +32,7 @@ import hudson.Util;
import hudson.XmlFile;
import hudson.model.*;
import hudson.util.HttpResponses;
+import jenkins.util.MemoryReductionUtil;
import jenkins.model.Jenkins;
import hudson.model.listeners.SaveableListener;
import hudson.remoting.Channel;
@@ -41,6 +43,7 @@ import hudson.util.RingBufferLogHandler;
import hudson.util.XStream2;
import jenkins.security.MasterToSlaveCallable;
import net.sf.json.JSONObject;
+import org.apache.commons.lang.StringUtils;
import org.kohsuke.stapler.*;
import org.kohsuke.stapler.interceptor.RequirePOST;
@@ -85,16 +88,60 @@ public class LogRecorder extends AbstractModelObject implements Saveable {
return ts;
}
+ @Restricted(NoExternalUse.class)
+ @VisibleForTesting
+ public static Set<String> getAutoCompletionCandidates(List<String> loggerNamesList) {
+ Set<String> loggerNames = new HashSet<>(loggerNamesList);
+
+ // now look for package prefixes that make sense to offer for autocompletion:
+ // Only prefixes that match multiple loggers will be shown.
+ // Example: 'org' will show 'org', because there's org.apache, org.jenkinsci, etc.
+ // 'io' might only show 'io.jenkins.plugins' rather than 'io' if all loggers starting with 'io' start with 'io.jenkins.plugins'.
+ HashMap<String, Integer> seenPrefixes = new HashMap<>();
+ SortedSet<String> relevantPrefixes = new TreeSet<>();
+ for (String loggerName : loggerNames) {
+ String[] loggerNameParts = loggerName.split("[.]");
+
+ String longerPrefix = null;
+ for (int i = loggerNameParts.length; i > 0; i--) {
+ String loggerNamePrefix = StringUtils.join(Arrays.copyOf(loggerNameParts, i), ".");
+ seenPrefixes.put(loggerNamePrefix, seenPrefixes.getOrDefault(loggerNamePrefix, 0) + 1);
+ if (longerPrefix == null) {
+ relevantPrefixes.add(loggerNamePrefix); // actual logger name
+ longerPrefix = loggerNamePrefix;
+ continue;
+ }
+
+ if (seenPrefixes.get(loggerNamePrefix) > seenPrefixes.get(longerPrefix)) {
+ relevantPrefixes.add(loggerNamePrefix);
+ }
+ longerPrefix = loggerNamePrefix;
+ }
+ }
+ return relevantPrefixes;
+ }
+
@Restricted(NoExternalUse.class)
public AutoCompletionCandidates doAutoCompleteLoggerName(@QueryParameter String value) {
- AutoCompletionCandidates candidates = new AutoCompletionCandidates();
- Enumeration<String> loggerNames = LogManager.getLogManager().getLoggerNames();
- while (loggerNames.hasMoreElements()) {
- String loggerName = loggerNames.nextElement();
- if (loggerName.toLowerCase(Locale.ENGLISH).contains(value.toLowerCase(Locale.ENGLISH))) {
- candidates.add(loggerName);
+ if (value == null) {
+ return new AutoCompletionCandidates();
+ }
+
+ // get names of all actual loggers known to Jenkins
+ Set<String> candidateNames = new LinkedHashSet<>(getAutoCompletionCandidates(Collections.list(LogManager.getLogManager().getLoggerNames())));
+
+ for (String part : value.split("[ ]+")) {
+ HashSet<String> partCandidates = new HashSet<>();
+ String lowercaseValue = part.toLowerCase(Locale.ENGLISH);
+ for (String loggerName : candidateNames) {
+ if (loggerName.toLowerCase(Locale.ENGLISH).contains(lowercaseValue)) {
+ partCandidates.add(loggerName);
+ }
}
+ candidateNames.retainAll(partCandidates);
}
+ AutoCompletionCandidates candidates = new AutoCompletionCandidates();
+ candidates.add(candidateNames.toArray(MemoryReductionUtil.EMPTY_STRING_ARRAY));
return candidates;
}
diff --git a/core/src/main/java/hudson/logging/LogRecorderManager.java b/core/src/main/java/hudson/logging/LogRecorderManager.java
index bac8c8b6859a644119397b7b4fc8b2004d53a4d9..765253341bc13b4d9fb501320ddf32bb7db82e20 100644
--- a/core/src/main/java/hudson/logging/LogRecorderManager.java
+++ b/core/src/main/java/hudson/logging/LogRecorderManager.java
@@ -25,6 +25,7 @@ package hudson.logging;
import hudson.FeedAdapter;
import hudson.Functions;
+import hudson.PluginManager;
import hudson.init.Initializer;
import static hudson.init.InitMilestone.PLUGINS_PREPARED;
import hudson.model.AbstractModelObject;
@@ -35,7 +36,10 @@ import jenkins.model.JenkinsLocationConfiguration;
import jenkins.model.ModelObjectWithChildren;
import jenkins.model.ModelObjectWithContextMenu.ContextMenu;
import org.apache.commons.io.filefilter.WildcardFileFilter;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.QueryParameter;
+import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.HttpResponse;
@@ -61,7 +65,7 @@ import java.util.logging.Logger;
*
* @author Kohsuke Kawaguchi
*/
-public class LogRecorderManager extends AbstractModelObject implements ModelObjectWithChildren {
+public class LogRecorderManager extends AbstractModelObject implements ModelObjectWithChildren, StaplerProxy {
/**
* {@link LogRecorder}s keyed by their {@linkplain LogRecorder#name name}.
*/
@@ -198,4 +202,19 @@ public class LogRecorderManager extends AbstractModelObject implements ModelObje
public static void init(Jenkins h) throws IOException {
h.getLog().load();
}
+
+ @Override
+ @Restricted(NoExternalUse.class)
+ public Object getTarget() {
+ if (!SKIP_PERMISSION_CHECK) {
+ Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
+ }
+ return this;
+ }
+
+ /**
+ * Escape hatch for StaplerProxy-based access control
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean SKIP_PERMISSION_CHECK = Boolean.getBoolean(LogRecorderManager.class.getName() + ".skipPermissionCheck");
}
diff --git a/core/src/main/java/hudson/markup/MarkupFormatter.java b/core/src/main/java/hudson/markup/MarkupFormatter.java
index d722fb6aa248854296df770cdfb58f0af6e9e425..be8004136ab2646a9ea2c7627643ebd778404548 100644
--- a/core/src/main/java/hudson/markup/MarkupFormatter.java
+++ b/core/src/main/java/hudson/markup/MarkupFormatter.java
@@ -51,7 +51,7 @@ import org.kohsuke.stapler.QueryParameter;
*
* <h2>Views</h2>
* <p>
- * This extension point must have a valid <tt>config.jelly</tt> that feeds the constructor.
+ * This extension point must have a valid {@code config.jelly} that feeds the constructor.
*
* TODO: allow {@link MarkupFormatter} to control the UI that the user uses to edit.
*
diff --git a/core/src/main/java/hudson/model/AbstractBuild.java b/core/src/main/java/hudson/model/AbstractBuild.java
index 5e66617e27087c13ad453a3b3de0087ed78a2921..2268f3dd9967c69df673fede3e6bf159c59a28dd 100644
--- a/core/src/main/java/hudson/model/AbstractBuild.java
+++ b/core/src/main/java/hudson/model/AbstractBuild.java
@@ -297,7 +297,7 @@ public abstract class AbstractBuild<P extends AbstractProject<P,R>,R extends Abs
/**
* Returns the root directory of the checked-out module.
* <p>
- * This is usually where <tt>pom.xml</tt>, <tt>build.xml</tt>
+ * This is usually where {@code pom.xml}, {@code build.xml}
* and so on exists.
*/
public final FilePath getModuleRoot() {
@@ -803,20 +803,6 @@ public abstract class AbstractBuild<P extends AbstractProject<P,R>,R extends Abs
}
}
- /**
- * get the fingerprints associated with this build
- *
- * @return never null
- */
- @Exported(name = "fingerprint", inline = true, visibility = -1)
- public Collection<Fingerprint> getBuildFingerprints() {
- FingerprintAction fingerprintAction = getAction(FingerprintAction.class);
- if (fingerprintAction != null) {
- return fingerprintAction.getFingerprints().values();
- }
- return Collections.<Fingerprint>emptyList();
- }
-
/*
* No need to lock the entire AbstractBuild on change set calculation
*/
diff --git a/core/src/main/java/hudson/model/AbstractCIBase.java b/core/src/main/java/hudson/model/AbstractCIBase.java
index 1b79051178cfb7a9a4ab5acb562a9c6f6b4eb254..d82afd6488d03d5e52f48abc3347332106d7f3b8 100644
--- a/core/src/main/java/hudson/model/AbstractCIBase.java
+++ b/core/src/main/java/hudson/model/AbstractCIBase.java
@@ -227,8 +227,13 @@ public abstract class AbstractCIBase extends Node implements ItemGroup<TopLevelI
killComputer(c);
}
getQueue().scheduleMaintenance();
- for (ComputerListener cl : ComputerListener.all())
- cl.onConfigurationChange();
+ for (ComputerListener cl : ComputerListener.all()) {
+ try {
+ cl.onConfigurationChange();
+ } catch (Throwable t) {
+ LOGGER.log(Level.WARNING, null, t);
+ }
+ }
}
}
diff --git a/core/src/main/java/hudson/model/AbstractItem.java b/core/src/main/java/hudson/model/AbstractItem.java
index e06a3f1988c0b0de87d857c545c7662438641ae5..1374429381f550e0e8bddfa991431c794eb4d56b 100644
--- a/core/src/main/java/hudson/model/AbstractItem.java
+++ b/core/src/main/java/hudson/model/AbstractItem.java
@@ -36,12 +36,14 @@ import hudson.model.listeners.ItemListener;
import hudson.model.listeners.SaveableListener;
import hudson.model.queue.Tasks;
import hudson.model.queue.WorkUnit;
+import hudson.security.ACLContext;
import hudson.security.AccessControlled;
import hudson.security.Permission;
import hudson.security.ACL;
import hudson.util.AlternativeUiTextProvider;
import hudson.util.AlternativeUiTextProvider.Message;
import hudson.util.AtomicFileWriter;
+import hudson.util.FormValidation;
import hudson.util.IOUtils;
import hudson.util.Secret;
import java.util.Iterator;
@@ -56,6 +58,8 @@ import jenkins.util.xml.XMLUtils;
import org.apache.tools.ant.taskdefs.Copy;
import org.apache.tools.ant.types.FileSet;
+import org.kohsuke.stapler.HttpResponses;
+import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.WebMethod;
import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.export.ExportedBean;
@@ -72,12 +76,16 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nonnull;
+import org.acegisecurity.AccessDeniedException;
+import org.kohsuke.stapler.HttpResponse;
+import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.HttpDeletable;
import org.kohsuke.args4j.Argument;
import org.kohsuke.args4j.CmdLineException;
+import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.interceptor.RequirePOST;
import org.xml.sax.SAXException;
@@ -90,6 +98,8 @@ import javax.xml.transform.stream.StreamSource;
import static hudson.model.queue.Executables.getParentOf;
import hudson.model.queue.SubTask;
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
+import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
+
import org.apache.commons.io.FileUtils;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
@@ -103,7 +113,7 @@ import org.kohsuke.stapler.Ancestor;
// Item doesn't necessarily have to be Actionable, but
// Java doesn't let multiple inheritance.
@ExportedBean
-public abstract class AbstractItem extends Actionable implements Item, HttpDeletable, AccessControlled, DescriptorByNameOwner {
+public abstract class AbstractItem extends Actionable implements Item, HttpDeletable, AccessControlled, DescriptorByNameOwner, StaplerProxy {
private static final Logger LOGGER = Logger.getLogger(AbstractItem.class.getName());
@@ -228,6 +238,114 @@ public abstract class AbstractItem extends Actionable implements Item, HttpDelet
this.name = name;
}
+ /**
+ * Controls whether the default rename action is available for this item.
+ *
+ * @return whether {@link #name} can be modified by a user
+ * @see #checkRename
+ * @see #renameTo
+ * @since 2.110
+ */
+ public boolean isNameEditable() {
+ return false;
+ }
+
+ /**
+ * Renames this item
+ */
+ @RequirePOST
+ @Restricted(NoExternalUse.class)
+ public HttpResponse doConfirmRename(@QueryParameter String newName) throws IOException {
+ newName = newName == null ? null : newName.trim();
+ FormValidation validationError = doCheckNewName(newName);
+ if (validationError.kind != FormValidation.Kind.OK) {
+ throw new Failure(validationError.getMessage());
+ }
+
+ renameTo(newName);
+ // send to the new job page
+ // note we can't use getUrl() because that would pick up old name in the
+ // Ancestor.getUrl()
+ return HttpResponses.redirectTo("../" + newName);
+ }
+
+ /**
+ * Called by {@link #doConfirmRename} and {@code rename.jelly} to validate renames.
+ * @return {@link FormValidation#ok} if this item can be renamed as specified, otherwise
+ * {@link FormValidation#error} with a message explaining the problem.
+ */
+ @Restricted(NoExternalUse.class)
+ public @Nonnull FormValidation doCheckNewName(@QueryParameter String newName) {
+ // TODO: Create an Item.RENAME permission to use here, see JENKINS-18649.
+ if (!hasPermission(Item.CONFIGURE)) {
+ if (parent instanceof AccessControlled) {
+ ((AccessControlled)parent).checkPermission(Item.CREATE);
+ }
+ checkPermission(Item.DELETE);
+ }
+
+ newName = newName == null ? null : newName.trim();
+ try {
+ Jenkins.checkGoodName(newName);
+ assert newName != null; // Would have thrown Failure
+ if (newName.equals(name)) {
+ return FormValidation.warning(Messages.AbstractItem_NewNameUnchanged());
+ }
+ Jenkins.get().getProjectNamingStrategy().checkName(newName);
+ checkIfNameIsUsed(newName);
+ checkRename(newName);
+ } catch (Failure e) {
+ return FormValidation.error(e.getMessage());
+ }
+ return FormValidation.ok();
+ }
+
+ /**
+ * Check new name for job
+ * @param newName - New name for job.
+ */
+ private void checkIfNameIsUsed(@Nonnull String newName) throws Failure {
+ try {
+ Item item = getParent().getItem(newName);
+ if (item != null) {
+ throw new Failure(Messages.AbstractItem_NewNameInUse(newName));
+ }
+ try (ACLContext ctx = ACL.as(ACL.SYSTEM)) {
+ item = getParent().getItem(newName);
+ if (item != null) {
+ if (LOGGER.isLoggable(Level.FINE)) {
+ LOGGER.log(Level.FINE, "Unable to rename the job {0}: name {1} is already in use. " +
+ "User {2} has no {3} permission for existing job with the same name",
+ new Object[] {this.getFullName(), newName, ctx.getPreviousContext().getAuthentication().getName(), Item.DISCOVER.name} );
+ }
+ // Don't explicitly mention that there is another item with the same name.
+ throw new Failure(Messages.Jenkins_NotAllowedName(newName));
+ }
+ }
+ } catch(AccessDeniedException ex) {
+ if (LOGGER.isLoggable(Level.FINE)) {
+ LOGGER.log(Level.FINE, "Unable to rename the job {0}: name {1} is already in use. " +
+ "User {2} has {3} permission, but no {4} for existing job with the same name",
+ new Object[] {this.getFullName(), newName, User.current(), Item.DISCOVER.name, Item.READ.name} );
+ }
+ throw new Failure(Messages.AbstractItem_NewNameInUse(newName));
+ }
+ }
+
+ /**
+ * Allows subclasses to block renames for domain-specific reasons. Generic validation of the new name
+ * (e.g., null checking, checking for illegal characters, and checking that the name is not in use)
+ * always happens prior to calling this method.
+ *
+ * @param newName the new name for the item
+ * @throws Failure if the rename should be blocked
+ * @since 2.110
+ * @see Job#checkRename
+ */
+ protected void checkRename(@Nonnull String newName) throws Failure {
+
+ }
+
/**
* Renames this item.
* Not all the Items need to support this operation, but if you decide to do so,
@@ -675,7 +793,7 @@ public abstract class AbstractItem extends Actionable implements Item, HttpDelet
}
/**
- * Accepts <tt>config.xml</tt> submission, as well as serve it.
+ * Accepts {@code config.xml} submission, as well as serve it.
*/
@WebMethod(name = "config.xml")
public void doConfigDotXml(StaplerRequest req, StaplerResponse rsp)
@@ -819,6 +937,24 @@ public abstract class AbstractItem extends Actionable implements Item, HttpDelet
return super.toString() + '[' + (parent != null ? getFullName() : "?/" + name) + ']';
}
+ @Override
+ @Restricted(NoExternalUse.class)
+ public Object getTarget() {
+ if (!SKIP_PERMISSION_CHECK) {
+ if (!getACL().hasPermission(Item.DISCOVER)) {
+ return null;
+ }
+ getACL().checkPermission(Item.READ);
+ }
+ return this;
+ }
+
+ /**
+ * Escape hatch for StaplerProxy-based access control
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean SKIP_PERMISSION_CHECK = Boolean.getBoolean(AbstractItem.class.getName() + ".skipPermissionCheck");
+
/**
* Used for CLI binding.
*/
diff --git a/core/src/main/java/hudson/model/AbstractProject.java b/core/src/main/java/hudson/model/AbstractProject.java
index cbade0ebac492f76833ae1dce0c7117eb7bbe736..3b60e8618519d41c5dc5b6a23a357377296d1d6a 100644
--- a/core/src/main/java/hudson/model/AbstractProject.java
+++ b/core/src/main/java/hudson/model/AbstractProject.java
@@ -573,7 +573,7 @@ public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends A
/**
* Returns the root directory of the checked-out module.
* <p>
- * This is usually where <tt>pom.xml</tt>, <tt>build.xml</tt>
+ * This is usually where {@code pom.xml}, {@code build.xml}
* and so on exists.
*
* @deprecated as of 1.319
@@ -642,7 +642,7 @@ public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends A
}
/**
- * Used in <tt>sidepanel.jelly</tt> to decide whether to display
+ * Used in {@code sidepanel.jelly} to decide whether to display
* the config/delete/build links.
*/
public boolean isConfigurable() {
@@ -751,7 +751,7 @@ public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends A
* Returns the live list of all {@link Publisher}s configured for this project.
*
* <p>
- * This method couldn't be called <tt>getPublishers()</tt> because existing methods
+ * This method couldn't be called {@code getPublishers()} because existing methods
* in sub-classes return different inconsistent types.
*/
public abstract DescribableList<Publisher,Descriptor<Publisher>> getPublishersList();
@@ -1198,7 +1198,12 @@ public abstract class AbstractProject<P extends AbstractProject<P,R>,R extends A
return true; // no SCM
FilePath workspace = build.getWorkspace();
- workspace.mkdirs();
+ if(workspace!=null){
+ workspace.mkdirs();
+ } else {
+ throw new AbortException("Cannot checkout SCM, workspace is not defined");
+ }
+
boolean r = scm.checkout(build, launcher, workspace, listener, changelogFile);
if (r) {
diff --git a/core/src/main/java/hudson/model/Action.java b/core/src/main/java/hudson/model/Action.java
index ac7be33a6091c7f9c14d3a02bab31ce7f88c0b45..72d2f84e065afe93aaefceb0f93b530f960c95f3 100644
--- a/core/src/main/java/hudson/model/Action.java
+++ b/core/src/main/java/hudson/model/Action.java
@@ -38,12 +38,12 @@ import javax.annotation.CheckForNull;
*
* <p>
* Some actions use the latter without the former (for example, to add a link to an external website),
- * while others do the former without the latter (for example, to just draw some graphs in <tt>floatingBox.jelly</tt>),
+ * while others do the former without the latter (for example, to just draw some graphs in {@code floatingBox.jelly}),
* and still some others do both.
*
* <h2>Views</h2>
* <p>
- * If an action has a view named <tt>floatingBox.jelly</tt>,
+ * If an action has a view named {@code floatingBox.jelly},
* it will be displayed as a floating box on the top page of
* the target {@link ModelObject}. (For example, this is how
* the JUnit test result trend shows up in the project top page.
@@ -82,7 +82,7 @@ public interface Action extends ModelObject {
*
* @return
* If just a file name (like "abc.gif") is returned, it will be
- * interpreted as a file name inside <tt>/images/24x24</tt>.
+ * interpreted as a file name inside {@code /images/24x24}.
* This is useful for using one of the stock images.
* <p>
* If an absolute file name that starts from '/' is returned (like
@@ -91,7 +91,7 @@ public interface Action extends ModelObject {
* image files from a plugin.
* <p>
* Finally, return null to hide it from the task list. This is normally not very useful,
- * but this can be used for actions that only contribute <tt>floatBox.jelly</tt>
+ * but this can be used for actions that only contribute {@code floatBox.jelly}
* and no task list item. The other case where this is useful is
* to avoid showing links that require a privilege when the user is anonymous.
* @see Functions#isAnonymous()
diff --git a/core/src/main/java/hudson/model/AdministrativeMonitor.java b/core/src/main/java/hudson/model/AdministrativeMonitor.java
index 537f6d092ce63dd90cac459c1efb2da031ca2f71..16b3fbb69774c938aaf531c3d3cc53df353d5ab3 100644
--- a/core/src/main/java/hudson/model/AdministrativeMonitor.java
+++ b/core/src/main/java/hudson/model/AdministrativeMonitor.java
@@ -65,10 +65,10 @@ import org.kohsuke.stapler.interceptor.RequirePOST;
* <dl>
* <dt>message.jelly</dt>
* <dd>
- * If {@link #isActivated()} returns true, Jenkins will use the <tt>message.jelly</tt>
+ * If {@link #isActivated()} returns true, Jenkins will use the {@code message.jelly}
* view of this object to render the warning text. This happens in the
- * <tt>http://SERVER/jenkins/manage</tt> page. This view should typically render
- * a DIV box with class='error' or class='warning' with a human-readable text
+ * {@code http://SERVER/jenkins/manage} page. This view should typically render
+ * a DIV box with class='alert alert-error' or class='alert alert-warning' with a human-readable text
* inside it. It often also contains a link to a page that provides more details
* about the problem.
* </dd>
diff --git a/core/src/main/java/hudson/model/AperiodicWork.java b/core/src/main/java/hudson/model/AperiodicWork.java
index fbd4f2c4f7a3da987d57e4f61168d453647ff667..3c5385c07791a0c547edd8611c3038014763f137 100644
--- a/core/src/main/java/hudson/model/AperiodicWork.java
+++ b/core/src/main/java/hudson/model/AperiodicWork.java
@@ -24,12 +24,15 @@
package hudson.model;
import hudson.ExtensionList;
+import hudson.ExtensionListListener;
import hudson.ExtensionPoint;
import hudson.init.Initializer;
import hudson.triggers.SafeTimerTask;
import jenkins.util.Timer;
+import java.util.HashSet;
import java.util.Random;
+import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.logging.Logger;
@@ -92,11 +95,17 @@ public abstract class AperiodicWork extends SafeTimerTask implements ExtensionPo
@Initializer(after= JOB_LOADED)
public static void init() {
// start all AperidocWorks
+ ExtensionList<AperiodicWork> extensionList = all();
+ extensionList.addListener(new AperiodicWorkExtensionListListener(extensionList));
for (AperiodicWork p : AperiodicWork.all()) {
- Timer.get().schedule(p, p.getInitialDelay(), TimeUnit.MILLISECONDS);
+ scheduleAperiodWork(p);
}
}
+ private static void scheduleAperiodWork(AperiodicWork ap) {
+ Timer.get().schedule(ap, ap.getInitialDelay(), TimeUnit.MILLISECONDS);
+ }
+
protected abstract void doAperiodicRun();
/**
@@ -107,4 +116,31 @@ public abstract class AperiodicWork extends SafeTimerTask implements ExtensionPo
}
private static final Random RANDOM = new Random();
+
+ /**
+ * ExtensionListener that will kick off any new AperiodWork extensions from plugins that are dynamically
+ * loaded.
+ */
+ private static class AperiodicWorkExtensionListListener extends ExtensionListListener {
+
+ private final Set<AperiodicWork> registered = new HashSet<>();
+
+ AperiodicWorkExtensionListListener(ExtensionList<AperiodicWork> initiallyRegistered) {
+ for (AperiodicWork p : initiallyRegistered) {
+ registered.add(p);
+ }
+ }
+
+ @Override
+ public void onChange() {
+ synchronized (registered) {
+ for (AperiodicWork p : AperiodicWork.all()) {
+ if (!registered.contains(p)) {
+ scheduleAperiodWork(p);
+ registered.add(p);
+ }
+ }
+ }
+ }
+ }
}
diff --git a/core/src/main/java/hudson/model/Api.java b/core/src/main/java/hudson/model/Api.java
index eef109f92f41e6087842a2a4b3e4964a9406cd2d..024d66869d4591afe4d28a31c5294e00b2fa8032 100644
--- a/core/src/main/java/hudson/model/Api.java
+++ b/core/src/main/java/hudson/model/Api.java
@@ -60,7 +60,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* Used to expose remote access API for ".../api/"
*
* <p>
- * If the parent object has a <tt>_api.jelly</tt> view, it will be included
+ * If the parent object has a {@code _api.jelly} view, it will be included
* in the api index page.
*
* @author Kohsuke Kawaguchi
@@ -135,7 +135,19 @@ public class Api extends AbstractModelObject {
XPath comp = dom.createXPath(xpath);
comp.setFunctionContext(functionContext);
List list = comp.selectNodes(dom);
+
if (wrapper!=null) {
+ // check if the wrapper is a valid entity name
+ // First position: letter or underscore
+ // Other positions: \w (letter, number, underscore), dash or dot
+ String validNameRE = "^[a-zA-Z_][\\w-\\.]*$";
+
+ if(!wrapper.matches(validNameRE)) {
+ rsp.setStatus(HttpServletResponse.SC_BAD_REQUEST);
+ rsp.getWriter().print(Messages.Api_WrapperParamInvalid());
+ return;
+ }
+
Element root = DocumentFactory.getInstance().createElement(wrapper);
for (Object o : list) {
if (o instanceof String) {
diff --git a/core/src/main/java/hudson/model/AsyncAperiodicWork.java b/core/src/main/java/hudson/model/AsyncAperiodicWork.java
index 1d295fa7161db0abcdaffbb957773954b2ec7307..6e720c1419da95663cc16512711c35d6e9ee0486 100644
--- a/core/src/main/java/hudson/model/AsyncAperiodicWork.java
+++ b/core/src/main/java/hudson/model/AsyncAperiodicWork.java
@@ -200,7 +200,7 @@ public abstract class AsyncAperiodicWork extends AperiodicWork {
* Determines the log file that records the result of this task.
*/
protected File getLogFile() {
- return new File(Jenkins.getActiveInstance().getRootDir(),"logs/tasks/"+name+".log");
+ return new File(getLogsRoot(), "/tasks/" + name + ".log");
}
/**
diff --git a/core/src/main/java/hudson/model/AsyncPeriodicWork.java b/core/src/main/java/hudson/model/AsyncPeriodicWork.java
index f3ffcc64976a4fa0cbe9892f8c19a3d21a364c1b..324d1853eedc66e2b7425204d1d8b8c0f6630e3d 100644
--- a/core/src/main/java/hudson/model/AsyncPeriodicWork.java
+++ b/core/src/main/java/hudson/model/AsyncPeriodicWork.java
@@ -183,7 +183,7 @@ public abstract class AsyncPeriodicWork extends PeriodicWork {
* Determines the log file that records the result of this task.
*/
protected File getLogFile() {
- return new File(Jenkins.getActiveInstance().getRootDir(),"logs/tasks/"+name+".log");
+ return new File(getLogsRoot(), "/tasks/" + name + ".log");
}
/**
diff --git a/core/src/main/java/hudson/model/AutoCompletionCandidates.java b/core/src/main/java/hudson/model/AutoCompletionCandidates.java
index 0373b552bb007f560a566f63573db9ce683296b2..29ce16f4ca59e486771629b9ac0f82b9064d5ab7 100644
--- a/core/src/main/java/hudson/model/AutoCompletionCandidates.java
+++ b/core/src/main/java/hudson/model/AutoCompletionCandidates.java
@@ -25,6 +25,7 @@
package hudson.model;
import hudson.search.Search;
+import hudson.search.UserSearchProperty;
import jenkins.model.Jenkins;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.StaplerRequest;
@@ -37,6 +38,7 @@ import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.annotation.CheckForNull;
+import org.apache.commons.lang.StringUtils;
/**
* Data representation of the auto-completion candidates.
@@ -117,22 +119,28 @@ public class AutoCompletionCandidates implements HttpResponse {
@Override
public void onItem(Item i) {
- String n = contextualNameOf(i);
- if ((n.startsWith(value) || value.startsWith(n))
+ String itemName = contextualNameOf(i);
+
+ //Check user's setting on whether to do case sensitive comparison, configured in user -> configure
+ //This is the same setting that is used by the global search field, should be consistent throughout
+ //the whole application.
+ boolean caseInsensitive = UserSearchProperty.isCaseInsensitive();
+
+ if ((startsWithImpl(itemName, value, caseInsensitive) || startsWithImpl(value, itemName, caseInsensitive))
// 'foobar' is a valid candidate if the current value is 'foo'.
// Also, we need to visit 'foo' if the current value is 'foo/bar'
- && (value.length()>n.length() || !n.substring(value.length()).contains("/"))
+ && (value.length()> itemName.length() || !itemName.substring(value.length()).contains("/"))
// but 'foobar/zot' isn't if the current value is 'foo'
// we'll first show 'foobar' and then wait for the user to type '/' to show the rest
&& i.hasPermission(Item.READ)
// and read permission required
) {
- if (type.isInstance(i) && n.startsWith(value))
- candidates.add(n);
+ if (type.isInstance(i) && startsWithImpl(itemName, value, caseInsensitive))
+ candidates.add(itemName);
// recurse
String oldPrefix = prefix;
- prefix = n;
+ prefix = itemName;
super.onItem(i);
prefix = oldPrefix;
}
@@ -161,4 +169,8 @@ public class AutoCompletionCandidates implements HttpResponse {
return candidates;
}
+
+ private static boolean startsWithImpl(String str, String prefix, boolean ignoreCase) {
+ return ignoreCase ? StringUtils.startsWithIgnoreCase(str, prefix) : str.startsWith(prefix);
+ }
}
diff --git a/core/src/main/java/hudson/model/BuildBadgeAction.java b/core/src/main/java/hudson/model/BuildBadgeAction.java
index fe35eddd6052cea7c00489eea24e502c4a78378d..3a673f95583521e29e904342ca2a09c148e55cd2 100644
--- a/core/src/main/java/hudson/model/BuildBadgeAction.java
+++ b/core/src/main/java/hudson/model/BuildBadgeAction.java
@@ -32,7 +32,7 @@ package hudson.model;
* with {@link Run}.
*
* <p>
- * Actions with this marker should have a view <tt>badge.jelly</tt>,
+ * Actions with this marker should have a view {@code badge.jelly},
* which will be called to render the badges. The expected visual appearance
* of a badge is a 16x16 icon.
*
diff --git a/core/src/main/java/hudson/model/BuildTimelineWidget.java b/core/src/main/java/hudson/model/BuildTimelineWidget.java
index 31810b5f5e939e8409eb12422b150b3bffb2d91b..717052e5bf9e17d746b63ed15100478c97c35c5c 100644
--- a/core/src/main/java/hudson/model/BuildTimelineWidget.java
+++ b/core/src/main/java/hudson/model/BuildTimelineWidget.java
@@ -23,6 +23,7 @@
*/
package hudson.model;
+import hudson.Util;
import hudson.util.RunList;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
@@ -64,7 +65,9 @@ public class BuildTimelineWidget {
Event e = new Event();
e.start = new Date(r.getStartTimeInMillis());
e.end = new Date(r.getStartTimeInMillis()+r.getDuration());
- e.title = r.getFullDisplayName();
+ // due to SimileAjax.HTML.deEntify (in simile-ajax-bundle.js), "<" are transformed back to "<", but not the "<";
+ // to protect against XSS
+ e.title = Util.escape(r.getFullDisplayName()).replace("<", "<");
// what to put in the description?
// e.description = "Longish description of event "+r.getFullDisplayName();
// e.durationEvent = true;
diff --git a/core/src/main/java/hudson/model/Cause.java b/core/src/main/java/hudson/model/Cause.java
index bdac357b6b45231e238277ebec36420cd2fb02ed..c0286bc55a8556d88df25c7db3e968938c2ce292 100644
--- a/core/src/main/java/hudson/model/Cause.java
+++ b/core/src/main/java/hudson/model/Cause.java
@@ -453,9 +453,14 @@ public abstract class Cause {
@Override
public void print(TaskListener listener) {
- listener.getLogger().println(Messages.Cause_UserIdCause_ShortDescription(
- // TODO JENKINS-48467 - better to use ModelHyperlinkNote.encodeTo(User), or User.getUrl, since it handles URL escaping
- ModelHyperlinkNote.encodeTo("/user/"+getUserIdOrUnknown(), getUserName())));
+ User user = getUserId() == null ? null : User.getById(getUserId(), false);
+ if (user != null) {
+ listener.getLogger().println(Messages.Cause_UserIdCause_ShortDescription(
+ ModelHyperlinkNote.encodeTo(user)));
+ } else {
+ listener.getLogger().println(Messages.Cause_UserIdCause_ShortDescription(
+ "unknown or anonymous"));
+ }
}
@Override
diff --git a/core/src/main/java/hudson/model/ChoiceParameterDefinition.java b/core/src/main/java/hudson/model/ChoiceParameterDefinition.java
index f175bd001bd0fe08228eb0266fd764c3e4702f32..9ea14153624d8aa3d1d13b2728dec4ccd274a2d6 100644
--- a/core/src/main/java/hudson/model/ChoiceParameterDefinition.java
+++ b/core/src/main/java/hudson/model/ChoiceParameterDefinition.java
@@ -2,6 +2,9 @@ package hudson.model;
import hudson.util.FormValidation;
import org.jenkinsci.Symbol;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.DataBoundSetter;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.DataBoundConstructor;
@@ -10,6 +13,8 @@ import org.apache.commons.lang.StringUtils;
import net.sf.json.JSONObject;
import hudson.Extension;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.Arrays;
@@ -24,7 +29,7 @@ public class ChoiceParameterDefinition extends SimpleParameterDefinition {
public static final String CHOICES_DELIMETER = CHOICES_DELIMITER;
- private final List<String> choices;
+ private /* quasi-final */ List<String> choices;
private final String defaultValue;
public static boolean areValidChoices(String choices) {
@@ -32,10 +37,9 @@ public class ChoiceParameterDefinition extends SimpleParameterDefinition {
return !StringUtils.isEmpty(strippedChoices) && strippedChoices.split(CHOICES_DELIMITER).length > 0;
}
- @DataBoundConstructor
public ChoiceParameterDefinition(String name, String choices, String description) {
super(name, description);
- this.choices = Arrays.asList(choices.split(CHOICES_DELIMITER));
+ setChoicesText(choices);
defaultValue = null;
}
@@ -51,6 +55,60 @@ public class ChoiceParameterDefinition extends SimpleParameterDefinition {
this.defaultValue = defaultValue;
}
+ /**
+ * Databound constructor for reflective instantiation.
+ *
+ * @param name parameter name
+ * @param description parameter description
+ *
+ * @since 2.112
+ */
+ @DataBoundConstructor
+ @Restricted(NoExternalUse.class) // there are specific constructors with String and List arguments for 'choices'
+ public ChoiceParameterDefinition(String name, String description) {
+ super(name, description);
+ this.choices = new ArrayList<>();
+ this.defaultValue = null;
+ }
+
+ /**
+ * Set the list of choices. Legal arguments are String (in which case the arguments gets split into lines) and Collection
+ * which sets the list of legal parameters to the String representations of the argument's non-null entries.
+ *
+ * See JENKINS-26143 for background.
+ *
+ * This retains the compatibility with the legacy String 'choices' parameter, while supporting the list type as generated
+ * by the snippet generator.
+ *
+ * @param choices String or Collection representing this parameter definition's possible values.
+ *
+ * @since 2.112
+ *
+ */
+ @DataBoundSetter
+ @Restricted(NoExternalUse.class) // this is terrible enough without being used anywhere
+ public void setChoices(Object choices) {
+ if (choices instanceof String) {
+ setChoicesText((String) choices);
+ return;
+ }
+ if (choices instanceof List) {
+ ArrayList<String> newChoices = new ArrayList<>();
+ for (Object o : (List) choices) {
+ if (o != null) {
+ newChoices.add(o.toString());
+ }
+ }
+ this.choices = newChoices;
+ return;
+ }
+ throw new IllegalArgumentException("expected String or List, but got " + choices.getClass().getName());
+ }
+
+ private void setChoicesText(String choices) {
+ this.choices = Arrays.asList(choices.split(CHOICES_DELIMITER));
+ }
+
@Override
public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue) {
if (defaultValue instanceof StringParameterValue) {
@@ -104,6 +162,17 @@ public class ChoiceParameterDefinition extends SimpleParameterDefinition {
return "/help/parameter/choice.html";
}
+ @Override
+ /*
+ * We need this for JENKINS-26143 -- reflective creation cannot handle setChoices(Object). See that method for context.
+ */
+ public ParameterDefinition newInstance(@Nullable StaplerRequest req, @Nonnull JSONObject formData) throws FormException {
+ String name = formData.getString("name");
+ String desc = formData.getString("description");
+ String choiceText = formData.getString("choices");
+ return new ChoiceParameterDefinition(name, choiceText, desc);
+ }
+
/**
* Checks if parameterized build choices are valid.
*/
diff --git a/core/src/main/java/hudson/model/Computer.java b/core/src/main/java/hudson/model/Computer.java
index 43fa2d31d707140d8cfdd5d3ecfcbaae99e84b3c..641d82fc27ea758fd2087abd86a19205adff31f7 100644
--- a/core/src/main/java/hudson/model/Computer.java
+++ b/core/src/main/java/hudson/model/Computer.java
@@ -30,7 +30,6 @@ import hudson.EnvVars;
import hudson.Extension;
import hudson.Launcher.ProcStarter;
import hudson.slaves.Cloud;
-import jenkins.util.SystemProperties;
import hudson.Util;
import hudson.cli.declarative.CLIResolver;
import hudson.console.AnnotatedLargeText;
@@ -65,8 +64,11 @@ import hudson.util.Futures;
import hudson.util.NamingThreadFactory;
import jenkins.model.Jenkins;
import jenkins.util.ContextResettingExecutorService;
+import jenkins.util.SystemProperties;
import jenkins.security.MasterToSlaveCallable;
+import jenkins.security.ImpersonatingExecutorService;
+import org.apache.commons.lang.StringUtils;
import org.jenkins.ui.icon.Icon;
import org.jenkins.ui.icon.IconSet;
import org.kohsuke.accmod.Restricted;
@@ -323,6 +325,7 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
* Used to URL-bind {@link AnnotatedLargeText}.
*/
public AnnotatedLargeText<Computer> getLogText() {
+ checkPermission(CONNECT);
return new AnnotatedLargeText<Computer>(getLogFile(), Charset.defaultCharset(), false, this);
}
@@ -903,6 +906,9 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
}
private void addNewExecutorIfNecessary() {
+ if (Jenkins.getInstanceOrNull() == null) {
+ return;
+ }
Set<Integer> availableNumbers = new HashSet<Integer>();
for (int i = 0; i < numExecutors; i++)
availableNumbers.add(i);
@@ -1351,9 +1357,11 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
}
public static final ExecutorService threadPoolForRemoting = new ContextResettingExecutorService(
+ new ImpersonatingExecutorService(
Executors.newCachedThreadPool(
- new ExceptionCatchingThreadFactory(
- new NamingThreadFactory(new DaemonThreadFactory(), "Computer.threadPoolForRemoting"))));
+ new ExceptionCatchingThreadFactory(
+ new NamingThreadFactory(
+ new DaemonThreadFactory(), "Computer.threadPoolForRemoting"))), ACL.SYSTEM));
//
//
@@ -1472,6 +1480,11 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
throw new FormException(Messages.ComputerSet_SlaveAlreadyExists(proposedName), "name");
}
+ String nExecutors = req.getSubmittedForm().getString("numExecutors");
+ if (StringUtils.isBlank(nExecutors) || Integer.parseInt(nExecutors)<=0) {
+ throw new FormException(Messages.Slave_InvalidConfig_Executors(nodeName), "numExecutors");
+ }
+
Node result = node.reconfigure(req, req.getSubmittedForm());
Jenkins.getInstance().getNodesObject().replaceNode(this.getNode(), result);
@@ -1480,7 +1493,7 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
}
/**
- * Accepts <tt>config.xml</tt> submission, as well as serve it.
+ * Accepts {@code config.xml} submission, as well as serve it.
*/
@WebMethod(name = "config.xml")
public void doConfigDotXml(StaplerRequest req, StaplerResponse rsp)
diff --git a/core/src/main/java/hudson/model/Descriptor.java b/core/src/main/java/hudson/model/Descriptor.java
index fa3511a5f68a18b9b63f4f5377c9ea8c0536bfb1..b7fc8097e8950523b3bd10cced0d698a5aea7dd4 100644
--- a/core/src/main/java/hudson/model/Descriptor.java
+++ b/core/src/main/java/hudson/model/Descriptor.java
@@ -39,6 +39,7 @@ import hudson.views.ListViewColumn;
import jenkins.model.GlobalConfiguration;
import jenkins.model.GlobalConfigurationCategory;
import jenkins.model.Jenkins;
+import jenkins.security.RedactSecretJsonInErrorMessageSanitizer;
import jenkins.util.io.OnMaster;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
@@ -51,6 +52,8 @@ import org.apache.commons.io.IOUtils;
import static hudson.util.QuotedStringTokenizer.*;
import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
+
+import javax.annotation.PostConstruct;
import javax.servlet.ServletException;
import javax.servlet.RequestDispatcher;
import java.io.File;
@@ -117,6 +120,8 @@ import javax.annotation.Nullable;
* {@link Descriptor} can persist data just by storing them in fields.
* However, it is the responsibility of the derived type to properly
* invoke {@link #save()} and {@link #load()}.
+ * {@link #load()} is automatically invoked as a JSR-250 lifecycle method if derived class
+ * do implement {@link PersistentDescriptor}.
*
* <h2>Reflection Enhancement</h2>
* {@link Descriptor} defines addition to the standard Java reflection
@@ -133,7 +138,7 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable,
*/
public transient final Class<? extends T> clazz;
- private transient final Map<String,CheckMethod> checkMethods = new ConcurrentHashMap<String,CheckMethod>();
+ private transient final Map<String,CheckMethod> checkMethods = new ConcurrentHashMap<String,CheckMethod>(2);
/**
* Lazily computed list of properties on {@link #clazz} and on the descriptor itself.
@@ -229,7 +234,7 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable,
*
* @see #getHelpFile(String)
*/
- private transient final Map<String,HelpRedirect> helpRedirect = new HashMap<String,HelpRedirect>();
+ private transient final Map<String,HelpRedirect> helpRedirect = new HashMap<String,HelpRedirect>(2);
private static class HelpRedirect {
private final Class<? extends Describable> owner;
@@ -534,7 +539,7 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable,
* Creates a configured instance from the submitted form.
*
* <p>
- * Hudson only invokes this method when the user wants an instance of <tt>T</tt>.
+ * Hudson only invokes this method when the user wants an instance of {@code T}.
* So there's no need to check that in the implementation.
*
* <p>
@@ -597,7 +602,7 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable,
} catch (NoSuchMethodException e) {
throw new AssertionError(e); // impossible
} catch (InstantiationException | IllegalAccessException | RuntimeException e) {
- throw new Error("Failed to instantiate "+clazz+" from "+formData,e);
+ throw new Error("Failed to instantiate "+clazz+" from "+RedactSecretJsonInErrorMessageSanitizer.INSTANCE.sanitize(formData),e);
}
}
@@ -710,9 +715,9 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable,
*
* <p>
* This value is relative to the context root of Hudson, so normally
- * the values are something like <tt>"/plugin/emma/help.html"</tt> to
- * refer to static resource files in a plugin, or <tt>"/publisher/EmmaPublisher/abc"</tt>
- * to refer to Jelly script <tt>abc.jelly</tt> or a method <tt>EmmaPublisher.doAbc()</tt>.
+ * the values are something like {@code "/plugin/emma/help.html"} to
+ * refer to static resource files in a plugin, or {@code "/publisher/EmmaPublisher/abc"}
+ * to refer to Jelly script {@code abc.jelly} or a method {@code EmmaPublisher.doAbc()}.
*
* @return
* null to indicate that there's no help.
@@ -821,7 +826,7 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable,
*
* @since 2.0, used to be in {@link GlobalConfiguration} before that.
*/
- public GlobalConfigurationCategory getCategory() {
+ public @Nonnull GlobalConfigurationCategory getCategory() {
return GlobalConfigurationCategory.get(GlobalConfigurationCategory.Unclassified.class);
}
@@ -911,7 +916,7 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable,
}
/**
- * Serves <tt>help.html</tt> from the resource of {@link #clazz}.
+ * Serves {@code help.html} from the resource of {@link #clazz}.
*/
public void doHelp(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
String path = req.getRestOfPath();
diff --git a/core/src/main/java/hudson/model/DirectoryBrowserSupport.java b/core/src/main/java/hudson/model/DirectoryBrowserSupport.java
index 5426c7842e115bc9e947c1c243b849412ae6ff6a..e89f28c8a5785c38230cf04b03fb1c0df701566d 100644
--- a/core/src/main/java/hudson/model/DirectoryBrowserSupport.java
+++ b/core/src/main/java/hudson/model/DirectoryBrowserSupport.java
@@ -29,11 +29,15 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
+import java.net.URL;
import java.text.Collator;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Calendar;
+import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
+import java.util.GregorianCalendar;
import java.util.List;
import java.util.Locale;
import java.util.StringTokenizer;
@@ -51,6 +55,7 @@ import org.apache.tools.zip.ZipOutputStream;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.HttpResponse;
+import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
@@ -213,7 +218,7 @@ public final class DirectoryBrowserSupport implements HttpResponse {
String rest = _rest.toString();
// this is the base file/directory
- VirtualFile baseFile = root.child(base);
+ VirtualFile baseFile = base.isEmpty() ? root : root.child(base);
if(baseFile.isDirectory()) {
if(zip) {
@@ -295,6 +300,14 @@ public final class DirectoryBrowserSupport implements HttpResponse {
return;
}
+ URL external = baseFile.toExternalURL();
+ if (external != null) {
+ // or this URL could be emitted directly from dir.jelly
+ // though we would prefer to delay toExternalURL calls unless and until needed
+ rsp.sendRedirect2(external.toExternalForm());
+ return;
+ }
+
long lastModified = baseFile.lastModified();
long length = baseFile.length();
@@ -338,7 +351,7 @@ public final class DirectoryBrowserSupport implements HttpResponse {
int current=1;
while(tokens.hasMoreTokens()) {
String token = tokens.nextToken();
- r.add(new Path(createBackRef(total-current+restSize),token,true,0, true));
+ r.add(new Path(createBackRef(total-current+restSize),token,true,0, true,0));
current++;
}
return r;
@@ -355,7 +368,8 @@ public final class DirectoryBrowserSupport implements HttpResponse {
private static void zip(OutputStream outputStream, VirtualFile dir, String glob) throws IOException {
try (ZipOutputStream zos = new ZipOutputStream(outputStream)) {
zos.setEncoding(System.getProperty("file.encoding")); // TODO JENKINS-20663 make this overridable via query parameter
- for (String n : dir.list(glob.length() == 0 ? "**" : glob)) {
+ // TODO consider using run(Callable) here
+ for (String n : dir.list(glob.isEmpty() ? "**" : glob, null, /* TODO what is the user expectation? */true)) {
String relativePath;
if (glob.length() == 0) {
// JENKINS-19947: traditional behavior is to prepend the directory name
@@ -404,12 +418,26 @@ public final class DirectoryBrowserSupport implements HttpResponse {
*/
private final boolean isReadable;
+ /**
+ * For a file, the last modified timestamp.
+ */
+ private final long lastModified;
+
+ /**
+ * @deprecated Use {@link #Path(String, String, boolean, long, boolean, long)}
+ */
+ @Deprecated
public Path(String href, String title, boolean isFolder, long size, boolean isReadable) {
+ this(href, title, isFolder, size, isReadable, 0L);
+ }
+
+ public Path(String href, String title, boolean isFolder, long size, boolean isReadable, long lastModified) {
this.href = href;
this.title = title;
this.isFolder = isFolder;
this.size = size;
this.isReadable = isReadable;
+ this.lastModified = lastModified;
}
public boolean isFolder() {
@@ -446,6 +474,29 @@ public final class DirectoryBrowserSupport implements HttpResponse {
return size;
}
+ /**
+ *
+ * @return A long value representing the time the file was last modified, measured in milliseconds since
+ * the epoch (00:00:00 GMT, January 1, 1970), or 0L if is not possible to obtain the times.
+ * @since 2.127
+ */
+ public long getLastModified() {
+ return lastModified;
+ }
+
+ /**
+ *
+ * @return A Calendar representing the time the file was last modified, it lastModified is 0L
+ * it will return 00:00:00 GMT, January 1, 1970.
+ * @since 2.127
+ */
+ @Restricted(NoExternalUse.class)
+ public Calendar getLastModifiedAsCalendar() {
+ final Calendar cal = new GregorianCalendar();
+ cal.setTimeInMillis(lastModified);
+ return cal;
+ }
+
private static final long serialVersionUID = 1L;
}
@@ -499,7 +550,7 @@ public final class DirectoryBrowserSupport implements HttpResponse {
Arrays.sort(files,new FileComparator(locale));
for( VirtualFile f : files ) {
- Path p = new Path(Util.rawEncode(f.getName()), f.getName(), f.isDirectory(), f.length(), f.canRead());
+ Path p = new Path(Util.rawEncode(f.getName()), f.getName(), f.isDirectory(), f.length(), f.canRead(), f.lastModified());
if(!f.isDirectory()) {
r.add(Collections.singletonList(p));
} else {
@@ -520,7 +571,7 @@ public final class DirectoryBrowserSupport implements HttpResponse {
break;
f = sub.get(0);
relPath += '/'+Util.rawEncode(f.getName());
- l.add(new Path(relPath,f.getName(),true,0, f.canRead()));
+ l.add(new Path(relPath,f.getName(),true, f.length(), f.canRead(), f.lastModified()));
}
r.add(l);
}
@@ -535,10 +586,10 @@ public final class DirectoryBrowserSupport implements HttpResponse {
* @param baseRef String like "../../../" that cancels the 'rest' portion. Can be "./"
*/
private static List<List<Path>> patternScan(VirtualFile baseDir, String pattern, String baseRef) throws IOException {
- String[] files = baseDir.list(pattern);
+ Collection<String> files = baseDir.list(pattern, null, /* TODO what is the user expectation? */true);
- if (files.length > 0) {
- List<List<Path>> r = new ArrayList<List<Path>>(files.length);
+ if (!files.isEmpty()) {
+ List<List<Path>> r = new ArrayList<List<Path>>(files.size());
for (String match : files) {
List<Path> file = buildPathList(baseDir, baseDir.child(match), baseRef);
r.add(file);
@@ -574,7 +625,7 @@ public final class DirectoryBrowserSupport implements HttpResponse {
href.append("/");
}
- Path path = new Path(href.toString(), filePath.getName(), filePath.isDirectory(), filePath.length(), filePath.canRead());
+ Path path = new Path(href.toString(), filePath.getName(), filePath.isDirectory(), filePath.length(), filePath.canRead(), filePath.lastModified());
pathList.add(path);
}
diff --git a/core/src/main/java/hudson/model/Executor.java b/core/src/main/java/hudson/model/Executor.java
index e20f9a1eeec69b4d3fd45c9b1a5c519cae2f92ee..5f90ad1bfcf37b9db0046b5be6f48f453052fa92 100644
--- a/core/src/main/java/hudson/model/Executor.java
+++ b/core/src/main/java/hudson/model/Executor.java
@@ -144,7 +144,7 @@ public class Executor extends Thread implements ModelObject {
public Executor(@Nonnull Computer owner, int n) {
super("Executor #"+n+" for "+owner.getDisplayName());
this.owner = owner;
- this.queue = Jenkins.getInstance().getQueue();
+ this.queue = Jenkins.get().getQueue();
this.number = n;
}
@@ -431,11 +431,12 @@ public class Executor extends Thread implements ModelObject {
} catch (AsynchronousExecution x) {
lock.writeLock().lock();
try {
- x.setExecutor(this);
+ x.setExecutorWithoutCompleting(this);
this.asynchronousExecution = x;
} finally {
lock.writeLock().unlock();
}
+ x.maybeComplete();
} catch (Throwable e) {
problems = e;
} finally {
@@ -459,7 +460,6 @@ public class Executor extends Thread implements ModelObject {
if (asynchronousExecution == null) {
finish2();
}
- executableEstimatedDuration = DEFAULT_ESTIMATED_DURATION;
}
}
@@ -490,6 +490,7 @@ public class Executor extends Thread implements ModelObject {
if (this instanceof OneOffExecutor) {
owner.remove((OneOffExecutor) this);
}
+ executableEstimatedDuration = DEFAULT_ESTIMATED_DURATION;
queue.scheduleMaintenance();
}
@@ -577,7 +578,7 @@ public class Executor extends Thread implements ModelObject {
}
/**
- * Same as {@link #getName()}.
+ * Human readable name of the Jenkins executor. For the Java thread name use {@link #getName()}.
*/
public String getDisplayName() {
return "Executor #"+getNumber();
diff --git a/core/src/main/java/hudson/model/FileParameterValue.java b/core/src/main/java/hudson/model/FileParameterValue.java
index 85bfb043874998fc2e743a8019a4a062e186e599..f911927285ae55af04f93d234a7d2e709de54a6f 100644
--- a/core/src/main/java/hudson/model/FileParameterValue.java
+++ b/core/src/main/java/hudson/model/FileParameterValue.java
@@ -36,6 +36,7 @@ import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
+import java.nio.file.Path;
import javax.servlet.ServletException;
import org.apache.commons.fileupload.FileItem;
@@ -45,6 +46,8 @@ import org.apache.commons.fileupload.util.FileItemHeadersImpl;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
@@ -61,6 +64,16 @@ import org.kohsuke.stapler.StaplerResponse;
* @author Kohsuke Kawaguchi
*/
public class FileParameterValue extends ParameterValue {
+ private static final String FOLDER_NAME = "fileParameters";
+
+ /**
+ * Escape hatch for SECURITY-1074, fileParameter used to escape their expected folder.
+ * It's not recommended to enable for security reasons. That option is only present for backward compatibility.
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE =
+ Boolean.getBoolean(FileParameterValue.class.getName() + ".allowFolderTraversalOutsideWorkspace");
+
private transient final FileItem file;
/**
@@ -70,6 +83,9 @@ public class FileParameterValue extends ParameterValue {
/**
* Overrides the location in the build to place this file. Initially set to {@link #getName()}
+ * The location could be directly the filename or also a hierarchical path.
+ * The intermediate folders will be created automatically.
+ * Take care that no escape from the current directory is allowed and will result in the failure of the build.
*/
private String location;
@@ -142,7 +158,16 @@ public class FileParameterValue extends ParameterValue {
public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener listener) throws IOException, InterruptedException {
if (!StringUtils.isEmpty(location) && !StringUtils.isEmpty(file.getName())) {
listener.getLogger().println("Copying file to "+location);
- FilePath locationFilePath = build.getWorkspace().child(location);
+ FilePath ws = build.getWorkspace();
+ if (ws == null) {
+ throw new IllegalStateException("The workspace should be created when setUp method is called");
+ }
+ if (!ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE && !ws.isDescendant(location)) {
+ listener.error("Rejecting file path escaping base directory with relative path: " + location);
+ // force the build to fail
+ return null;
+ }
+ FilePath locationFilePath = ws.child(location);
locationFilePath.getParent().mkdirs();
locationFilePath.copyFrom(file);
locationFilePath.copyTo(new FilePath(getLocationUnderBuild(build)));
@@ -204,6 +229,18 @@ public class FileParameterValue extends ParameterValue {
if (("/" + originalFileName).equals(request.getRestOfPath())) {
AbstractBuild build = (AbstractBuild)request.findAncestor(AbstractBuild.class).getObject();
File fileParameter = getLocationUnderBuild(build);
+
+ if (!ALLOW_FOLDER_TRAVERSAL_OUTSIDE_WORKSPACE) {
+ File fileParameterFolder = getFileParameterFolderUnderBuild(build);
+
+ //TODO can be replaced by Util#isDescendant in 2.80+
+ Path child = fileParameter.getAbsoluteFile().toPath().normalize();
+ Path parent = fileParameterFolder.getAbsoluteFile().toPath().normalize();
+ if (!child.startsWith(parent)) {
+ throw new IllegalStateException("The fileParameter tried to escape the expected folder: " + location);
+ }
+ }
+
if (fileParameter.isFile()) {
try (InputStream data = Files.newInputStream(fileParameter.toPath())) {
long lastModified = fileParameter.lastModified();
@@ -227,7 +264,11 @@ public class FileParameterValue extends ParameterValue {
* @return the location to store the file parameter
*/
private File getLocationUnderBuild(AbstractBuild build) {
- return new File(build.getRootDir(), "fileParameters/" + location);
+ return new File(getFileParameterFolderUnderBuild(build), location);
+ }
+
+ private File getFileParameterFolderUnderBuild(AbstractBuild<?, ?> build){
+ return new File(build.getRootDir(), FOLDER_NAME);
}
/**
diff --git a/core/src/main/java/hudson/model/Fingerprint.java b/core/src/main/java/hudson/model/Fingerprint.java
index b2fcc6c5d6ca5729d623325a5abb381193fff72b..e94790857676e28cca1c6def7f4b0d7f1ad30ca3 100644
--- a/core/src/main/java/hudson/model/Fingerprint.java
+++ b/core/src/main/java/hudson/model/Fingerprint.java
@@ -822,24 +822,22 @@ public class Fingerprint implements ModelObject, Saveable {
public static final class ProjectRenameListener extends ItemListener {
@Override
public void onLocationChanged(final Item item, final String oldName, final String newName) {
- try (ACLContext _ = ACL.as(ACL.SYSTEM)) {
+ try (ACLContext acl = ACL.as(ACL.SYSTEM)) {
locationChanged(item, oldName, newName);
}
}
private void locationChanged(Item item, String oldName, String newName) {
- if (item instanceof AbstractProject) {
- AbstractProject p = Jenkins.getInstance().getItemByFullName(newName, AbstractProject.class);
+ if (item instanceof Job) {
+ Job p = Jenkins.getInstance().getItemByFullName(newName, Job.class);
if (p != null) {
- RunList builds = p.getBuilds();
- for (Object build : builds) {
- if (build instanceof AbstractBuild) {
- Collection<Fingerprint> fingerprints = ((AbstractBuild)build).getBuildFingerprints();
- for (Fingerprint f : fingerprints) {
- try {
- f.rename(oldName, newName);
- } catch (IOException e) {
- logger.log(Level.WARNING, "Failed to update fingerprint record " + f.getFileName() + " when " + oldName + " was renamed to " + newName, e);
- }
+ RunList<? extends Run> builds = p.getBuilds();
+ for (Run build : builds) {
+ Collection<Fingerprint> fingerprints = build.getBuildFingerprints();
+ for (Fingerprint f : fingerprints) {
+ try {
+ f.rename(oldName, newName);
+ } catch (IOException e) {
+ logger.log(Level.WARNING, "Failed to update fingerprint record " + f.getFileName() + " when " + oldName + " was renamed to " + newName, e);
}
}
}
@@ -1256,7 +1254,7 @@ public class Fingerprint implements ModelObject, Saveable {
AtomicFileWriter afw = new AtomicFileWriter(file);
try {
PrintWriter w = new PrintWriter(afw);
- w.println("<?xml version='1.0' encoding='UTF-8'?>");
+ w.println("<?xml version='1.1' encoding='UTF-8'?>");
w.println("<fingerprint>");
w.print(" <timestamp>");
w.print(DATE_CONVERTER.toString(timestamp));
@@ -1366,7 +1364,12 @@ public class Fingerprint implements ModelObject, Saveable {
start = System.currentTimeMillis();
try {
- Fingerprint f = (Fingerprint) configFile.read();
+ Object loaded = configFile.read();
+ if (!(loaded instanceof Fingerprint)) {
+ throw new IOException("Unexpected Fingerprint type. Expected " + Fingerprint.class + " or subclass but got "
+ + (loaded != null ? loaded.getClass() : "null"));
+ }
+ Fingerprint f = (Fingerprint) loaded;
if(logger.isLoggable(Level.FINE))
logger.fine("Loading fingerprint "+file+" took "+(System.currentTimeMillis()-start)+"ms");
if (f.facets==null)
@@ -1435,7 +1438,7 @@ public class Fingerprint implements ModelObject, Saveable {
// Probably it failed due to the missing Item.DISCOVER
// We try to retrieve the job using SYSTEM user and to check permissions manually.
final Authentication userAuth = Jenkins.getAuthentication();
- try (ACLContext _ = ACL.as(ACL.SYSTEM)) {
+ try (ACLContext acl = ACL.as(ACL.SYSTEM)) {
final Item itemBySystemUser = jenkins.getItemByFullName(fullName);
if (itemBySystemUser == null) {
return false;
diff --git a/core/src/main/java/hudson/model/FingerprintCleanupThread.java b/core/src/main/java/hudson/model/FingerprintCleanupThread.java
index 59187a3a400630e63968c886541652f8c439e7b4..292248ed528336439dc96c1cef7306b9881cd6ff 100644
--- a/core/src/main/java/hudson/model/FingerprintCleanupThread.java
+++ b/core/src/main/java/hudson/model/FingerprintCleanupThread.java
@@ -28,9 +28,10 @@ import hudson.ExtensionList;
import hudson.Functions;
import jenkins.model.Jenkins;
import org.jenkinsci.Symbol;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import java.io.File;
-import java.io.FileFilter;
import java.io.IOException;
import java.util.regex.Pattern;
@@ -45,7 +46,11 @@ import java.util.regex.Pattern;
* @author Kohsuke Kawaguchi
*/
@Extension @Symbol("fingerprintCleanup")
-public final class FingerprintCleanupThread extends AsyncPeriodicWork {
+@Restricted(NoExternalUse.class)
+public class FingerprintCleanupThread extends AsyncPeriodicWork {
+
+ static final String FINGERPRINTS_DIR_NAME = "fingerprints";
+ private static final Pattern FINGERPRINT_FILE_PATTERN = Pattern.compile("[0-9a-f]{28}\\.xml");
public FingerprintCleanupThread() {
super("Fingerprint cleanup");
@@ -66,13 +71,13 @@ public final class FingerprintCleanupThread extends AsyncPeriodicWork {
public void execute(TaskListener listener) {
int numFiles = 0;
- File root = new File(Jenkins.getInstance().getRootDir(),"fingerprints");
- File[] files1 = root.listFiles(LENGTH2DIR_FILTER);
+ File root = new File(getRootDir(), FINGERPRINTS_DIR_NAME);
+ File[] files1 = root.listFiles(f -> f.isDirectory() && f.getName().length()==2);
if(files1!=null) {
for (File file1 : files1) {
- File[] files2 = file1.listFiles(LENGTH2DIR_FILTER);
+ File[] files2 = file1.listFiles(f -> f.isDirectory() && f.getName().length()==2);
for(File file2 : files2) {
- File[] files3 = file2.listFiles(FINGERPRINTFILE_FILTER);
+ File[] files3 = file2.listFiles(f -> f.isFile() && FINGERPRINT_FILE_PATTERN.matcher(f.getName()).matches());
for(File file3 : files3) {
if(check(file3, listener))
numFiles++;
@@ -101,7 +106,7 @@ public final class FingerprintCleanupThread extends AsyncPeriodicWork {
*/
private boolean check(File fingerprintFile, TaskListener listener) {
try {
- Fingerprint fp = Fingerprint.load(fingerprintFile);
+ Fingerprint fp = loadFingerprint(fingerprintFile);
if (fp == null || !fp.isAlive()) {
listener.getLogger().println("deleting obsolete " + fingerprintFile);
fingerprintFile.delete();
@@ -109,8 +114,7 @@ public final class FingerprintCleanupThread extends AsyncPeriodicWork {
} else {
// get the fingerprint in the official map so have the changes visible to Jenkins
// otherwise the mutation made in FingerprintMap can override our trimming.
- listener.getLogger().println("possibly trimming " + fingerprintFile);
- fp = Jenkins.getInstance()._getFingerprint(fp.getHashString());
+ fp = getFingerprint(fp);
return fp.trim();
}
} catch (IOException e) {
@@ -119,17 +123,16 @@ public final class FingerprintCleanupThread extends AsyncPeriodicWork {
}
}
- private static final FileFilter LENGTH2DIR_FILTER = new FileFilter() {
- public boolean accept(File f) {
- return f.isDirectory() && f.getName().length()==2;
- }
- };
+ protected Fingerprint loadFingerprint(File fingerprintFile) throws IOException {
+ return Fingerprint.load(fingerprintFile);
+ }
- private static final FileFilter FINGERPRINTFILE_FILTER = new FileFilter() {
- private final Pattern PATTERN = Pattern.compile("[0-9a-f]{28}\\.xml");
+ protected Fingerprint getFingerprint(Fingerprint fp) throws IOException {
+ return Jenkins.get()._getFingerprint(fp.getHashString());
+ }
+
+ protected File getRootDir() {
+ return Jenkins.get().getRootDir();
+ }
- public boolean accept(File f) {
- return f.isFile() && PATTERN.matcher(f.getName()).matches();
- }
- };
}
diff --git a/core/src/main/java/hudson/model/Item.java b/core/src/main/java/hudson/model/Item.java
index 8187d608bd8923851cf945f0c6db09971b7836d1..be8a5495e16d886a8d543f4caf9f0951955bb05e 100644
--- a/core/src/main/java/hudson/model/Item.java
+++ b/core/src/main/java/hudson/model/Item.java
@@ -266,5 +266,5 @@ public interface Item extends PersistenceRoot, SearchableModelObject, AccessCont
Permission BUILD = new Permission(PERMISSIONS, "Build", Messages._AbstractProject_BuildPermission_Description(), Permission.UPDATE, PermissionScope.ITEM);
Permission WORKSPACE = new Permission(PERMISSIONS, "Workspace", Messages._AbstractProject_WorkspacePermission_Description(), Permission.READ, PermissionScope.ITEM);
Permission WIPEOUT = new Permission(PERMISSIONS, "WipeOut", Messages._AbstractProject_WipeOutPermission_Description(), null, Functions.isWipeOutPermissionEnabled(), new PermissionScope[]{PermissionScope.ITEM});
- Permission CANCEL = new Permission(PERMISSIONS, "Cancel", Messages._AbstractProject_CancelPermission_Description(), BUILD, PermissionScope.ITEM);
+ Permission CANCEL = new Permission(PERMISSIONS, "Cancel", Messages._AbstractProject_CancelPermission_Description(), Permission.UPDATE, PermissionScope.ITEM);
}
diff --git a/core/src/main/java/hudson/model/ItemGroupMixIn.java b/core/src/main/java/hudson/model/ItemGroupMixIn.java
index 13f72c3f079219432ed98748324b9ed3d6aa7d44..195d4d8c0ce95322284d279d8b6176286cd24958 100644
--- a/core/src/main/java/hudson/model/ItemGroupMixIn.java
+++ b/core/src/main/java/hudson/model/ItemGroupMixIn.java
@@ -45,6 +45,8 @@ import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.StandardCopyOption;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -239,7 +241,8 @@ public abstract class ItemGroupMixIn {
T result = (T)createProject(src.getDescriptor(),name,false);
// copy config
- Util.copyFile(srcConfigFile.getFile(), Items.getConfigFile(result).getFile());
+ Files.copy(Util.fileToPath(srcConfigFile.getFile()), Util.fileToPath(Items.getConfigFile(result).getFile()),
+ StandardCopyOption.COPY_ATTRIBUTES, StandardCopyOption.REPLACE_EXISTING);
// reload from the new config
final File rootDir = result.getRootDir();
diff --git a/core/src/main/java/hudson/model/Items.java b/core/src/main/java/hudson/model/Items.java
index 927abc72e0bbe5e658d85c3eb14214b90fcbfbf6..d0a26238a3d3f71a650c631ab5ca2caec3a901b3 100644
--- a/core/src/main/java/hudson/model/Items.java
+++ b/core/src/main/java/hudson/model/Items.java
@@ -35,6 +35,7 @@ import hudson.security.AccessControlled;
import hudson.triggers.Trigger;
import hudson.util.DescriptorList;
import hudson.util.EditDistance;
+import jenkins.util.MemoryReductionUtil;
import hudson.util.XStream2;
import java.io.File;
import java.io.IOException;
@@ -313,8 +314,8 @@ public class Items {
// Had difficulty adapting the version in Functions to use no live items, so rewrote it:
static String getRelativeNameFrom(String itemFullName, String groupFullName) {
- String[] itemFullNameA = itemFullName.isEmpty() ? new String[0] : itemFullName.split("/");
- String[] groupFullNameA = groupFullName.isEmpty() ? new String[0] : groupFullName.split("/");
+ String[] itemFullNameA = itemFullName.isEmpty() ? MemoryReductionUtil.EMPTY_STRING_ARRAY : itemFullName.split("/");
+ String[] groupFullNameA = groupFullName.isEmpty() ? MemoryReductionUtil.EMPTY_STRING_ARRAY : groupFullName.split("/");
for (int i = 0; ; i++) {
if (i == itemFullNameA.length) {
if (i == groupFullNameA.length) {
diff --git a/core/src/main/java/hudson/model/JDK.java b/core/src/main/java/hudson/model/JDK.java
index b04376eb74aead7cde5dc2bac587aa49bf3a30b2..abcb1a9f74d039af0fce62acac8e52b89da2effe 100644
--- a/core/src/main/java/hudson/model/JDK.java
+++ b/core/src/main/java/hudson/model/JDK.java
@@ -32,16 +32,20 @@ import hudson.EnvVars;
import hudson.slaves.NodeSpecific;
import hudson.tools.ToolInstallation;
import hudson.tools.ToolDescriptor;
+import hudson.tools.ToolInstaller;
import hudson.tools.ToolProperty;
-import hudson.tools.JDKInstaller;
import hudson.util.XStream2;
import java.io.File;
import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
import java.util.Map;
import java.util.List;
import java.util.Arrays;
import java.util.Collections;
+import java.util.logging.Level;
+import java.util.logging.Logger;
import jenkins.model.Jenkins;
import org.jenkinsci.Symbol;
@@ -183,8 +187,18 @@ public final class JDK extends ToolInstallation implements NodeSpecific<JDK>, En
}
@Override
- public List<JDKInstaller> getDefaultInstallers() {
- return Collections.singletonList(new JDKInstaller(null,false));
+ public List<? extends ToolInstaller> getDefaultInstallers() {
+ try {
+ Class<? extends ToolInstaller> jdkInstallerClass = Jenkins.getInstance().getPluginManager()
+ .uberClassLoader.loadClass("hudson.tools.JDKInstaller").asSubclass(ToolInstaller.class);
+ Constructor<? extends ToolInstaller> constructor = jdkInstallerClass.getConstructor(String.class, boolean.class);
+ return Collections.singletonList(constructor.newInstance(null, false));
+ } catch (ClassNotFoundException e) {
+ return Collections.emptyList();
+ } catch (Exception e) {
+ LOGGER.log(Level.WARNING, "Unable to get default installer", e);
+ return Collections.emptyList();
+ }
}
/**
@@ -211,4 +225,6 @@ public final class JDK extends ToolInstallation implements NodeSpecific<JDK>, En
return ((JDK)obj).javaHome;
}
}
+
+ private static final Logger LOGGER = Logger.getLogger(JDK.class.getName());
}
diff --git a/core/src/main/java/hudson/model/Job.java b/core/src/main/java/hudson/model/Job.java
index a5e477ede90d2f24591296cb24a1f852244ed64d..4b149034bd825bf448e8b6aad5416a8afd748b12 100644
--- a/core/src/main/java/hudson/model/Job.java
+++ b/core/src/main/java/hudson/model/Job.java
@@ -56,7 +56,6 @@ import hudson.util.DescribableList;
import hudson.util.FormApply;
import hudson.util.Graph;
import hudson.util.ProcessTree;
-import hudson.util.QuotedStringTokenizer;
import hudson.util.RunList;
import hudson.util.ShiftedCategoryAxis;
import hudson.util.StackedAreaRenderer2;
@@ -68,7 +67,6 @@ import java.awt.Color;
import java.awt.Paint;
import java.io.File;
import java.io.IOException;
-import java.net.URLEncoder;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Calendar;
@@ -122,9 +120,6 @@ import org.kohsuke.stapler.interceptor.RequirePOST;
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
import static javax.servlet.http.HttpServletResponse.SC_NO_CONTENT;
-import org.acegisecurity.AccessDeniedException;
-import org.acegisecurity.context.SecurityContext;
-import org.acegisecurity.context.SecurityContextHolder;
/**
* A job is an runnable entity under the monitoring of Hudson.
@@ -324,6 +319,7 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
/**
* Returns whether the name of this job can be changed by user.
*/
+ @Override
public boolean isNameEditable() {
return true;
}
@@ -815,7 +811,7 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
}
/**
- * Gets the youngest build #m that satisfies <tt>n<=m</tt>.
+ * Gets the youngest build #m that satisfies {@code n<=m}.
*
* This is useful when you'd like to fetch a build but the exact build might
* be already gone (deleted, rotated, etc.)
@@ -830,7 +826,7 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
}
/**
- * Gets the latest build #m that satisfies <tt>m<=n</tt>.
+ * Gets the latest build #m that satisfies {@code m<=n}.
*
* This is useful when you'd like to fetch a build but the exact build might
* be already gone (deleted, rotated, etc.)
@@ -1356,39 +1352,17 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
}
ItemListener.fireOnUpdated(this);
- String newName = req.getParameter("name");
final ProjectNamingStrategy namingStrategy = Jenkins.getInstance().getProjectNamingStrategy();
- if (validRename(name, newName)) {
- newName = newName.trim();
- // check this error early to avoid HTTP response splitting.
- Jenkins.checkGoodName(newName);
- namingStrategy.checkName(newName);
- if (FormApply.isApply(req)) {
- FormApply.applyResponse("notificationBar.show(" + QuotedStringTokenizer.quote(Messages.Job_you_must_use_the_save_button_if_you_wish()) + ",notificationBar.WARNING)").generateResponse(req, rsp, null);
- } else {
- rsp.sendRedirect("rename?newName=" + URLEncoder.encode(newName, "UTF-8"));
- }
- } else {
if(namingStrategy.isForceExistingJobs()){
namingStrategy.checkName(name);
}
FormApply.success(".").generateResponse(req, rsp, null);
- }
} catch (JSONException e) {
LOGGER.log(Level.WARNING, "failed to parse " + json, e);
sendError(e, req, rsp);
}
}
- private boolean validRename(String oldName, String newName) {
- if (newName == null) {
- return false;
- }
- boolean noChange = oldName.equals(newName);
- boolean spaceAdded = oldName.equals(newName.trim());
- return !noChange && !spaceAdded;
- }
-
/**
* Derived class can override this to perform additional config submission
* work.
@@ -1586,32 +1560,25 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
/**
* Renames this job.
+ * @deprecated Exists for backwards compatibility, use {@link #doConfirmRename} instead.
*/
+ @Deprecated
@RequirePOST
public/* not synchronized. see renameTo() */void doDoRename(
StaplerRequest req, StaplerResponse rsp) throws IOException,
ServletException {
-
- if (!hasPermission(CONFIGURE)) {
- // rename is essentially delete followed by a create
- checkPermission(CREATE);
- checkPermission(DELETE);
- }
-
String newName = req.getParameter("newName");
- Jenkins.checkGoodName(newName);
+ doConfirmRename(newName).generateResponse(req, rsp, null);
+ }
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected void checkRename(String newName) throws Failure {
if (isBuilding()) {
- // redirect to page explaining that we can't rename now
- rsp.sendRedirect("rename?newName=" + URLEncoder.encode(newName, "UTF-8"));
- return;
+ throw new Failure(Messages.Job_NoRenameWhileBuilding());
}
-
- renameTo(newName);
- // send to the new job page
- // note we can't use getUrl() because that would pick up old name in the
- // Ancestor.getUrl()
- rsp.sendRedirect2("../" + newName);
}
public void doRssAll(StaplerRequest req, StaplerResponse rsp)
@@ -1645,58 +1612,4 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
}
private final static HexStringConfidentialKey SERVER_COOKIE = new HexStringConfidentialKey(Job.class,"serverCookie",16);
-
- /**
- * Check new name for job
- * @param newName - New name for job
- * @return {@code true} - if newName occupied and user has permissions for this job
- * {@code false} - if newName occupied and user hasn't permissions for this job
- * {@code null} - if newName didn't occupied
- *
- * @throws Failure if the given name is not good
- */
- @CheckForNull
- @Restricted(NoExternalUse.class)
- public Boolean checkIfNameIsUsed(@Nonnull String newName) throws Failure{
-
- Item item = null;
- Jenkins.checkGoodName(newName);
-
- try {
- item = getParent().getItem(newName);
- } catch(AccessDeniedException ex) {
- if (LOGGER.isLoggable(Level.FINE)) {
- LOGGER.log(Level.FINE, "Unable to rename the job {0}: name {1} is already in use. " +
- "User {2} has {3} permission, but no {4} for existing job with the same name",
- new Object[] {this.getFullName(), newName, User.current().getFullName(), Item.DISCOVER.name, Item.READ.name} );
- }
- return true;
- }
-
- if (item != null) {
- // User has Read permissions for existing job with the same name
- return true;
- } else {
- SecurityContext initialContext = null;
- try {
- initialContext = hudson.security.ACL.impersonate(ACL.SYSTEM);
- item = getParent().getItem(newName);
-
- if (item != null) {
- if (LOGGER.isLoggable(Level.FINE)) {
- LOGGER.log(Level.FINE, "Unable to rename the job {0}: name {1} is already in use. " +
- "User {2} has no {3} permission for existing job with the same name",
- new Object[] {this.getFullName(), newName, initialContext.getAuthentication().getName(), Item.DISCOVER.name} );
- }
- return false;
- }
-
- } finally {
- if (initialContext != null) {
- SecurityContextHolder.setContext(initialContext);
- }
- }
- }
- return null;
- }
}
diff --git a/core/src/main/java/hudson/model/JobProperty.java b/core/src/main/java/hudson/model/JobProperty.java
index 2c982286e41a57b62344d93d10f7e8c3b07ad46a..a16c685ec73a000018e0d48d51f6e132abe017c7 100644
--- a/core/src/main/java/hudson/model/JobProperty.java
+++ b/core/src/main/java/hudson/model/JobProperty.java
@@ -53,9 +53,9 @@ import javax.annotation.Nonnull;
* configuration screen, and they are persisted with the job object.
*
* <p>
- * Configuration screen should be defined in <tt>config.jelly</tt>.
+ * Configuration screen should be defined in {@code config.jelly}.
* Within this page, the {@link JobProperty} instance is available
- * as <tt>instance</tt> variable (while <tt>it</tt> refers to {@link Job}.
+ * as {@code instance} variable (while {@code it} refers to {@link Job}.
*
* <p>
* Starting 1.150, {@link JobProperty} implements {@link BuildStep},
diff --git a/core/src/main/java/hudson/model/Label.java b/core/src/main/java/hudson/model/Label.java
index 0c2605776593e3ccd5daa8d6cee068c51118fc11..606068104e3f3ecf925343c70973908d0183eb53 100644
--- a/core/src/main/java/hudson/model/Label.java
+++ b/core/src/main/java/hudson/model/Label.java
@@ -49,6 +49,8 @@ import jenkins.model.Jenkins;
import jenkins.model.ModelObjectWithChildren;
import org.acegisecurity.context.SecurityContext;
import org.acegisecurity.context.SecurityContextHolder;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
@@ -58,6 +60,7 @@ import java.io.StringReader;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
+import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
@@ -196,6 +199,16 @@ public abstract class Label extends Actionable implements Comparable<Label>, Mod
return nodes.size() == 1 && nodes.iterator().next().getSelfLabel() == this;
}
+ private static class NodeSorter implements Comparator<Node> {
+ @Override
+ public int compare(Node o1, Node o2) {
+ if (o1 == o2) {
+ return 0;
+ }
+ return o1 instanceof Jenkins ? -1 : (o2 instanceof Jenkins ? 1 : o1.getNodeName().compareTo(o2.getNodeName()));
+ }
+ }
+
/**
* Gets all {@link Node}s that belong to this label.
*/
@@ -204,7 +217,7 @@ public abstract class Label extends Actionable implements Comparable<Label>, Mod
Set<Node> nodes = this.nodes;
if(nodes!=null) return nodes;
- Set<Node> r = new HashSet<Node>();
+ Set<Node> r = new HashSet<>();
Jenkins h = Jenkins.getInstance();
if(this.matches(h))
r.add(h);
@@ -215,6 +228,13 @@ public abstract class Label extends Actionable implements Comparable<Label>, Mod
return this.nodes = Collections.unmodifiableSet(r);
}
+ @Restricted(DoNotUse.class) // Jelly
+ public Set<Node> getSortedNodes() {
+ Set<Node> r = new TreeSet<>(new NodeSorter());
+ r.addAll(getNodes());
+ return r;
+ }
+
/**
* Gets all {@link Cloud}s that can launch for this label.
*/
diff --git a/core/src/main/java/hudson/model/ListView.java b/core/src/main/java/hudson/model/ListView.java
index 002646e10d0bec0e225361dbfb07a6b069436471..9d84eb32cebb49ea99f06ffb7f57fc1e8b688d41 100644
--- a/core/src/main/java/hudson/model/ListView.java
+++ b/core/src/main/java/hudson/model/ListView.java
@@ -518,7 +518,7 @@ public class ListView extends View implements DirectlyModifiableView {
public static final class Listener extends ItemListener {
@Override
public void onLocationChanged(final Item item, final String oldFullName, final String newFullName) {
- try (ACLContext _ = ACL.as(ACL.SYSTEM)) {
+ try (ACLContext acl = ACL.as(ACL.SYSTEM)) {
locationChanged(oldFullName, newFullName);
}
}
@@ -563,7 +563,7 @@ public class ListView extends View implements DirectlyModifiableView {
@Override
public void onDeleted(final Item item) {
- try (ACLContext _ = ACL.as(ACL.SYSTEM)) {
+ try (ACLContext acl = ACL.as(ACL.SYSTEM)) {
deleted(item);
}
}
diff --git a/core/src/main/java/hudson/model/LoadBalancer.java b/core/src/main/java/hudson/model/LoadBalancer.java
index a0403e1b974f957c45e882fc9aa190783be99c68..ce69e89779309af042019fdd4365734f977e8d7e 100644
--- a/core/src/main/java/hudson/model/LoadBalancer.java
+++ b/core/src/main/java/hudson/model/LoadBalancer.java
@@ -112,7 +112,7 @@ public abstract class LoadBalancer implements ExtensionPoint {
private boolean assignGreedily(Mapping m, Task task, List<ConsistentHash<ExecutorChunk>> hashes, int i) {
if (i==hashes.size()) return true; // fully assigned
- String key = task.getFullDisplayName() + (i>0 ? String.valueOf(i) : "");
+ String key = task.getAffinityKey() + (i>0 ? String.valueOf(i) : "");
for (ExecutorChunk ec : hashes.get(i).list(key)) {
// let's attempt this assignment
diff --git a/core/src/main/java/hudson/model/ManagementLink.java b/core/src/main/java/hudson/model/ManagementLink.java
index 041fda35d05ef0b18b8405a21701236517205813..00d6871097cc66730ad6a50caa3bb3d3bf15b67a 100644
--- a/core/src/main/java/hudson/model/ManagementLink.java
+++ b/core/src/main/java/hudson/model/ManagementLink.java
@@ -37,7 +37,7 @@ import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
/**
- * Extension point to add icon to <tt>http://server/hudson/manage</tt> page.
+ * Extension point to add icon to {@code http://server/hudson/manage} page.
*
* <p>
* This is a place for exposing features that are only meant for system admins
diff --git a/core/src/main/java/hudson/model/ModelObject.java b/core/src/main/java/hudson/model/ModelObject.java
index 5467b2a7a77e6e02ec2b073148d670ce55a92f3f..166a2cbcf2f20cf0469a77d602d15226e677e7fd 100644
--- a/core/src/main/java/hudson/model/ModelObject.java
+++ b/core/src/main/java/hudson/model/ModelObject.java
@@ -27,7 +27,7 @@ package hudson.model;
* A model object has a human readable name.
*
* And it normally has URL, but this interface doesn't define one.
- * (Since there're so many classes that define the <tt>getUrl</tt> method
+ * (Since there're so many classes that define the {@code getUrl} method
* we should have such one.)
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/model/MyViewsProperty.java b/core/src/main/java/hudson/model/MyViewsProperty.java
index 379b37d15dbecacca90e13de6126601731870c13..c7852d926d82b5379a5482dc27fcba04751996e7 100644
--- a/core/src/main/java/hudson/model/MyViewsProperty.java
+++ b/core/src/main/java/hudson/model/MyViewsProperty.java
@@ -47,6 +47,8 @@ import net.sf.json.JSONObject;
import org.acegisecurity.AccessDeniedException;
import org.jenkinsci.Symbol;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
@@ -87,6 +89,7 @@ public class MyViewsProperty extends UserProperty implements ModifiableViewGroup
this(null);
}
+ @Restricted(NoExternalUse.class)
public Object readResolve() {
if (views == null)
// this shouldn't happen, but an error in 1.319 meant the last view could be deleted
diff --git a/core/src/main/java/hudson/model/Node.java b/core/src/main/java/hudson/model/Node.java
index bcf81c19ad5c7b9e8f941d4c57d5ae3aff8387f6..c61ee7abc138a0dc824f2ae1c76abf916d30e3a7 100644
--- a/core/src/main/java/hudson/model/Node.java
+++ b/core/src/main/java/hudson/model/Node.java
@@ -62,6 +62,7 @@ import java.util.logging.Logger;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import jenkins.model.Jenkins;
+import jenkins.util.SystemProperties;
import jenkins.util.io.OnMaster;
import net.sf.json.JSONObject;
import org.acegisecurity.Authentication;
@@ -97,6 +98,9 @@ public abstract class Node extends AbstractModelObject implements Reconfigurable
private static final Logger LOGGER = Logger.getLogger(Node.class.getName());
+ /** @see <a href="https://issues.jenkins-ci.org/browse/JENKINS-46652">JENKINS-46652</a> */
+ public static /* not final */ boolean SKIP_BUILD_CHECK_ON_FLYWEIGHTS = SystemProperties.getBoolean(Node.class.getName() + ".SKIP_BUILD_CHECK_ON_FLYWEIGHTS", true);
+
/**
* Newly copied agents get this flag set, so that Jenkins doesn't try to start/remove this node until its configuration
* is saved once.
@@ -345,6 +349,7 @@ public abstract class Node extends AbstractModelObject implements Reconfigurable
/**
* Gets the special label that represents this node itself.
*/
+ @Nonnull
@WithBridgeMethods(Label.class)
public LabelAtom getSelfLabel() {
return LabelAtom.get(getNodeName());
@@ -394,7 +399,7 @@ public abstract class Node extends AbstractModelObject implements Reconfigurable
}
Authentication identity = item.authenticate();
- if (!hasPermission(identity,Computer.BUILD)) {
+ if (!(SKIP_BUILD_CHECK_ON_FLYWEIGHTS && item.task instanceof Queue.FlyweightTask) && !hasPermission(identity, Computer.BUILD)) {
// doesn't have a permission
return CauseOfBlockage.fromMessage(Messages._Node_LackingBuildPermission(identity.getName(), getDisplayName()));
}
diff --git a/core/src/main/java/hudson/model/ParameterDefinition.java b/core/src/main/java/hudson/model/ParameterDefinition.java
index fa08b2f0f24ddd71bdb1ac1bcc3d5c8481f0dbe6..d535a90a051433cb5050b96730e05404a1a0f1e4 100644
--- a/core/src/main/java/hudson/model/ParameterDefinition.java
+++ b/core/src/main/java/hudson/model/ParameterDefinition.java
@@ -75,18 +75,18 @@ import org.kohsuke.stapler.export.ExportedBean;
*
* <h2>Persistence</h2>
* <p>
- * Instances of {@link ParameterDefinition}s are persisted into job <tt>config.xml</tt>
+ * Instances of {@link ParameterDefinition}s are persisted into job {@code config.xml}
* through XStream.
*
*
* <h2>Associated Views</h2>
* <h3>config.jelly</h3>
- * {@link ParameterDefinition} class uses <tt>config.jelly</tt> to contribute a form
+ * {@link ParameterDefinition} class uses {@code config.jelly} to contribute a form
* fragment in the job configuration screen. Values entered there are fed back to
* {@link ParameterDescriptor#newInstance(StaplerRequest, JSONObject)} to create {@link ParameterDefinition}s.
*
* <h3>index.jelly</h3>
- * The <tt>index.jelly</tt> view contributes a form fragment in the page where the user
+ * The {@code index.jelly} view contributes a form fragment in the page where the user
* enters actual values of parameters for a build. The result of this form submission
* is then fed to {@link ParameterDefinition#createValue(StaplerRequest, JSONObject)} to
* create {@link ParameterValue}s.
diff --git a/core/src/main/java/hudson/model/ParameterValue.java b/core/src/main/java/hudson/model/ParameterValue.java
index 6cd1f46a190d322cb7cf8fbe0cbf6ccba4e3a66a..64fc925a8ec8a76cd27e1ba96056b97a5daa95eb 100644
--- a/core/src/main/java/hudson/model/ParameterValue.java
+++ b/core/src/main/java/hudson/model/ParameterValue.java
@@ -56,12 +56,12 @@ import org.kohsuke.stapler.export.ExportedBean;
*
* <h2>Persistence</h2>
* <p>
- * Instances of {@link ParameterValue}s are persisted into build's <tt>build.xml</tt>
+ * Instances of {@link ParameterValue}s are persisted into build's {@code build.xml}
* through XStream (via {@link ParametersAction}), so instances need to be persistable.
*
* <h2>Associated Views</h2>
* <h3>value.jelly</h3>
- * The <tt>value.jelly</tt> view contributes a UI fragment to display the parameter
+ * The {@code value.jelly} view contributes a UI fragment to display the parameter
* values used for a build.
*
* <h2>Notes</h2>
diff --git a/core/src/main/java/hudson/model/ParametersAction.java b/core/src/main/java/hudson/model/ParametersAction.java
index a262ae6adbe12c811300774645eba374c01175f4..9de8ef8dcd00e9f390cf59ee2b5d269ce7019e13 100644
--- a/core/src/main/java/hudson/model/ParametersAction.java
+++ b/core/src/main/java/hudson/model/ParametersAction.java
@@ -87,7 +87,7 @@ public class ParametersAction implements RunAction2, Iterable<ParameterValue>, Q
private Set<String> safeParameters;
- private final List<ParameterValue> parameters;
+ private @Nonnull List<ParameterValue> parameters;
private List<String> parameterDefinitionNames;
@@ -99,7 +99,7 @@ public class ParametersAction implements RunAction2, Iterable<ParameterValue>, Q
private transient Run<?, ?> run;
- public ParametersAction(List<ParameterValue> parameters) {
+ public ParametersAction(@Nonnull List<ParameterValue> parameters) {
this.parameters = new ArrayList<>(parameters);
String paramNames = SystemProperties.getString(SAFE_PARAMETERS_SYSTEM_PROPERTY_NAME);
safeParameters = new TreeSet<>();
@@ -284,6 +284,9 @@ public class ParametersAction implements RunAction2, Iterable<ParameterValue>, Q
}
private Object readResolve() {
+ if (parameters == null) { // JENKINS-39495
+ parameters = Collections.emptyList();
+ }
if (build != null)
OldDataMonitor.report(build, "1.283");
if (safeParameters == null) {
@@ -296,7 +299,7 @@ public class ParametersAction implements RunAction2, Iterable<ParameterValue>, Q
public void onAttached(Run<?, ?> r) {
ParametersDefinitionProperty p = r.getParent().getProperty(ParametersDefinitionProperty.class);
if (p != null) {
- this.parameterDefinitionNames = p.getParameterDefinitionNames();
+ this.parameterDefinitionNames = new ArrayList<>(p.getParameterDefinitionNames());
} else {
this.parameterDefinitionNames = Collections.emptyList();
}
diff --git a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java
index f256e68ddc5a86c7e6bbf7d3e056053bbeed4bfc..1fa26ed3720af73f034e3325cc80bd5db293e76d 100644
--- a/core/src/main/java/hudson/model/ParametersDefinitionProperty.java
+++ b/core/src/main/java/hudson/model/ParametersDefinitionProperty.java
@@ -34,6 +34,7 @@ import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
+import java.util.concurrent.TimeUnit;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.servlet.ServletException;
@@ -58,7 +59,7 @@ import org.kohsuke.stapler.export.ExportedBean;
* Keeps a list of the parameters defined for a project.
*
* <p>
- * This class also implements {@link Action} so that <tt>index.jelly</tt> provides
+ * This class also implements {@link Action} so that {@code index.jelly} provides
* a form to enter build parameters.
* <p>The owning job needs a {@code sidepanel.jelly} and should have web methods delegating to {@link ParameterizedJobMixIn#doBuild} and {@link ParameterizedJobMixIn#doBuildWithParameters}.
* The builds also need a {@code sidepanel.jelly}.
@@ -71,17 +72,11 @@ public class ParametersDefinitionProperty extends OptionalJobProperty<Job<?, ?>>
@DataBoundConstructor
public ParametersDefinitionProperty(@Nonnull List<ParameterDefinition> parameterDefinitions) {
- if (parameterDefinitions == null) {
- throw new NullPointerException("ParameterDefinitions is null when this is a not valid value");
- }
- this.parameterDefinitions = parameterDefinitions;
+ this.parameterDefinitions = parameterDefinitions != null ? parameterDefinitions : new ArrayList<>();
}
public ParametersDefinitionProperty(@Nonnull ParameterDefinition... parameterDefinitions) {
- if (parameterDefinitions == null) {
- throw new NullPointerException("ParameterDefinitions is null when this is a not valid value");
- }
- this.parameterDefinitions = Arrays.asList(parameterDefinitions) ;
+ this.parameterDefinitions = parameterDefinitions != null ? Arrays.asList(parameterDefinitions) : new ArrayList<>();
}
private Object readResolve() {
@@ -107,15 +102,7 @@ public class ParametersDefinitionProperty extends OptionalJobProperty<Job<?, ?>>
* Gets the names of all the parameter definitions.
*/
public List<String> getParameterDefinitionNames() {
- return new AbstractList<String>() {
- public String get(int index) {
- return parameterDefinitions.get(index).getName();
- }
-
- public int size() {
- return parameterDefinitions.size();
- }
- };
+ return new DefinitionsAbstractList(this.parameterDefinitions);
}
@Nonnull
@@ -147,7 +134,8 @@ public class ParametersDefinitionProperty extends OptionalJobProperty<Job<?, ?>>
* This method is supposed to be invoked from {@link ParameterizedJobMixIn#doBuild(StaplerRequest, StaplerResponse, TimeDuration)}.
*/
public void _doBuild(StaplerRequest req, StaplerResponse rsp, @QueryParameter TimeDuration delay) throws IOException, ServletException {
- if (delay==null) delay=new TimeDuration(getJob().getQuietPeriod());
+ if (delay==null)
+ delay=new TimeDuration(TimeUnit.MILLISECONDS.convert(getJob().getQuietPeriod(), TimeUnit.SECONDS));
List<ParameterValue> values = new ArrayList<ParameterValue>();
@@ -196,7 +184,8 @@ public class ParametersDefinitionProperty extends OptionalJobProperty<Job<?, ?>>
values.add(value);
}
}
- if (delay==null) delay=new TimeDuration(getJob().getQuietPeriod());
+ if (delay==null)
+ delay=new TimeDuration(TimeUnit.MILLISECONDS.convert(getJob().getQuietPeriod(), TimeUnit.SECONDS));
Queue.Item item = Jenkins.getInstance().getQueue().schedule2(
getJob(), delay.getTimeInSeconds(), new ParametersAction(values), ParameterizedJobMixIn.getBuildCause(getJob(), req)).getItem();
@@ -252,4 +241,20 @@ public class ParametersDefinitionProperty extends OptionalJobProperty<Job<?, ?>>
public String getUrlName() {
return null;
}
+
+ private static class DefinitionsAbstractList extends AbstractList<String> {
+ private final List<ParameterDefinition> parameterDefinitions;
+
+ public DefinitionsAbstractList(List<ParameterDefinition> parameterDefinitions) {
+ this.parameterDefinitions = parameterDefinitions;
+ }
+
+ public String get(int index) {
+ return this.parameterDefinitions.get(index).getName();
+ }
+
+ public int size() {
+ return this.parameterDefinitions.size();
+ }
+ }
}
diff --git a/core/src/main/java/hudson/model/PeriodicWork.java b/core/src/main/java/hudson/model/PeriodicWork.java
index aab83426723546989179c0401803d845cfceccdc..1079553551bf02620ca92ba89ce80444d556a7d7 100644
--- a/core/src/main/java/hudson/model/PeriodicWork.java
+++ b/core/src/main/java/hudson/model/PeriodicWork.java
@@ -23,6 +23,7 @@
*/
package hudson.model;
+import hudson.ExtensionListListener;
import hudson.init.Initializer;
import hudson.triggers.SafeTimerTask;
import hudson.ExtensionPoint;
@@ -30,6 +31,8 @@ import hudson.Extension;
import hudson.ExtensionList;
import jenkins.util.Timer;
+import java.util.HashSet;
+import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.logging.Logger;
import java.util.Random;
@@ -99,15 +102,49 @@ public abstract class PeriodicWork extends SafeTimerTask implements ExtensionPoi
@Initializer(after= JOB_LOADED)
public static void init() {
// start all PeriodicWorks
- for (PeriodicWork p : PeriodicWork.all()) {
- Timer.get().scheduleAtFixedRate(p, p.getInitialDelay(), p.getRecurrencePeriod(), TimeUnit.MILLISECONDS);
+ ExtensionList<PeriodicWork> extensionList = all();
+ extensionList.addListener(new PeriodicWorkExtensionListListener(extensionList));
+ for (PeriodicWork p : extensionList) {
+ schedulePeriodicWork(p);
}
}
+ private static void schedulePeriodicWork(PeriodicWork p) {
+ Timer.get().scheduleAtFixedRate(p, p.getInitialDelay(), p.getRecurrencePeriod(), TimeUnit.MILLISECONDS);
+ }
+
// time constants
protected static final long MIN = 1000*60;
protected static final long HOUR =60*MIN;
protected static final long DAY = 24*HOUR;
private static final Random RANDOM = new Random();
+
+ /**
+ * ExtensionListener that will kick off any new AperiodWork extensions from plugins that are dynamically
+ * loaded.
+ */
+ private static class PeriodicWorkExtensionListListener extends ExtensionListListener {
+
+ private final Set<PeriodicWork> registered = new HashSet<>();
+
+ PeriodicWorkExtensionListListener(ExtensionList<PeriodicWork> initiallyRegistered) {
+ for (PeriodicWork p : initiallyRegistered) {
+ registered.add(p);
+ }
+ }
+
+ @Override
+ public void onChange() {
+ synchronized (registered) {
+ for (PeriodicWork p : PeriodicWork.all()) {
+ // it is possibly to programatically remove Extensions but that is rarely used.
+ if (!registered.contains(p)) {
+ schedulePeriodicWork(p);
+ registered.add(p);
+ }
+ }
+ }
+ }
+ }
}
diff --git a/core/src/main/java/hudson/model/PersistentDescriptor.java b/core/src/main/java/hudson/model/PersistentDescriptor.java
new file mode 100644
index 0000000000000000000000000000000000000000..837d154cfb51be87f96d5a40fefa846714ee8d96
--- /dev/null
+++ b/core/src/main/java/hudson/model/PersistentDescriptor.java
@@ -0,0 +1,16 @@
+package hudson.model;
+
+import javax.annotation.PostConstruct;
+
+/**
+ * Marker interface for Descriptors which use xml persistent data, and as such need to load from disk when instantiated.
+ * <p>
+ * {@link Descriptor#load()} method is annotated as {@link PostConstruct} so it get automatically invoked after
+ * constructor and field injection.
+ * @author <a href="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a>
+ */
+public interface PersistentDescriptor extends Saveable {
+
+ @PostConstruct
+ void load();
+}
diff --git a/core/src/main/java/hudson/model/ProxyView.java b/core/src/main/java/hudson/model/ProxyView.java
index 795b94ba8635d64757a30386b35afaca22308602..a879dfd0b0d9211ce40018b05ade964ea5d65b10 100644
--- a/core/src/main/java/hudson/model/ProxyView.java
+++ b/core/src/main/java/hudson/model/ProxyView.java
@@ -91,6 +91,11 @@ public class ProxyView extends View implements StaplerFallback {
return getProxiedView().contains(item);
}
+ @Override
+ public TopLevelItem getItem(String name) {
+ return getProxiedView().getItem(name);
+ }
+
@Override
protected void submit(StaplerRequest req) throws IOException, ServletException, FormException {
String proxiedViewName = req.getSubmittedForm().getString("proxiedViewName");
diff --git a/core/src/main/java/hudson/model/Queue.java b/core/src/main/java/hudson/model/Queue.java
index 6ad10d5f818e227d2df1ef623b75963344c71672..1eaeb089310d8be5faf4325af606a43eec149951 100644
--- a/core/src/main/java/hudson/model/Queue.java
+++ b/core/src/main/java/hudson/model/Queue.java
@@ -24,10 +24,12 @@
*/
package hudson.model;
+import com.google.common.annotations.VisibleForTesting;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.infradna.tool.bridge_method_injector.WithBridgeMethods;
import hudson.BulkChange;
+import hudson.Extension;
import hudson.ExtensionList;
import hudson.ExtensionPoint;
import hudson.Util;
@@ -64,7 +66,10 @@ import hudson.model.queue.WorkUnitContext;
import hudson.security.ACL;
import hudson.security.AccessControlled;
import java.nio.file.Files;
+
+import hudson.util.Futures;
import jenkins.security.QueueItemAuthenticatorProvider;
+import jenkins.util.SystemProperties;
import jenkins.util.Timer;
import hudson.triggers.SafeTimerTask;
import java.util.concurrent.TimeUnit;
@@ -93,7 +98,6 @@ import java.util.NoSuchElementException;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.Callable;
-import java.util.concurrent.TimeUnit;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.locks.Condition;
@@ -102,6 +106,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nonnull;
+import javax.annotation.concurrent.GuardedBy;
import javax.servlet.ServletException;
import jenkins.model.Jenkins;
@@ -454,6 +459,9 @@ public class Queue extends ResourceController implements Saveable {
*/
public void save() {
if(BulkChange.contains(this)) return;
+ if (Jenkins.getInstanceOrNull() == null) {
+ return;
+ }
XmlFile queueFile = new XmlFile(XSTREAM, getXMLQueueFile());
lock.lock();
@@ -499,11 +507,11 @@ public class Queue extends ResourceController implements Saveable {
}
private File getQueueFile() {
- return new File(Jenkins.getInstance().getRootDir(), "queue.txt");
+ return new File(Jenkins.get().getRootDir(), "queue.txt");
}
/*package*/ File getXMLQueueFile() {
- return new File(Jenkins.getInstance().getRootDir(), "queue.xml");
+ return new File(Jenkins.get().getRootDir(), "queue.xml");
}
/**
@@ -752,7 +760,9 @@ public class Queue extends ResourceController implements Saveable {
public HttpResponse doCancelItem(@QueryParameter long id) throws IOException, ServletException {
Item item = getItem(id);
if (item != null) {
- cancel(item);
+ if(item.hasCancelPermission()){
+ cancel(item);
+ }
} // else too late, ignore (JENKINS-14813)
return HttpResponses.forwardToPreviousPage();
}
@@ -1102,7 +1112,7 @@ public class Queue extends ResourceController implements Saveable {
/**
* Gets the information about the queue item for the given project.
*
- * @return null if the project is not in the queue.
+ * @return empty if the project is not in the queue.
*/
public List<Item> getItems(Task t) {
Snapshot snapshot = this.snapshot;
@@ -1445,6 +1455,10 @@ public class Queue extends ResourceController implements Saveable {
* and it also gets invoked periodically (see {@link Queue.MaintainTask}.)
*/
public void maintain() {
+ Jenkins jenkins = Jenkins.getInstanceOrNull();
+ if (jenkins == null) {
+ return;
+ }
lock.lock();
try { try {
@@ -1455,8 +1469,8 @@ public class Queue extends ResourceController implements Saveable {
{// update parked (and identify any pending items whose executor has disappeared)
List<BuildableItem> lostPendings = new ArrayList<BuildableItem>(pendings);
- for (Computer c : Jenkins.getInstance().getComputers()) {
- for (Executor e : c.getExecutors()) {
+ for (Computer c : jenkins.getComputers()) {
+ for (Executor e : c.getAllExecutors()) {
if (e.isInterrupted()) {
// JENKINS-28840 we will deadlock if we try to touch this executor while interrupt flag set
// we need to clear lost pendings as we cannot know what work unit was on this executor
@@ -1555,8 +1569,15 @@ public class Queue extends ResourceController implements Saveable {
}
}
- if (s != null)
- s.sortBuildableItems(buildables);
+ if (s != null) {
+ try {
+ s.sortBuildableItems(buildables);
+ } catch (Throwable e) {
+ // We don't really care if the sort doesn't sort anything, we still should
+ // continue to do our job. We'll complain about it and continue.
+ LOGGER.log(Level.WARNING, "s.sortBuildableItems() threw Throwable: {0}", e);
+ }
+ }
// Ensure that identification of blocked tasks is using the live state: JENKINS-27708 & JENKINS-27871
updateSnapshot();
@@ -1875,6 +1896,18 @@ public class Queue extends ResourceController implements Saveable {
*/
String getFullDisplayName();
+ /**
+ * Returns task-specific key which is used by the {@link LoadBalancer} to choose one particular executor
+ * amongst all the free executors on all possibly suitable nodes.
+ * NOTE: To be able to re-use the same node during the next run this key should not change from one run to
+ * another. You probably want to compute that key based on the job's name.
+ * <p>
+ * @return by default: {@link #getFullDisplayName()}
+ *
+ * @see hudson.model.LoadBalancer
+ */
+ default String getAffinityKey() { return getFullDisplayName(); }
+
/**
* Checks the permission to see if the current user can abort this executable.
* Returns normally from this method if it's OK.
@@ -1983,7 +2016,7 @@ public class Queue extends ResourceController implements Saveable {
*
* <h2>Views</h2>
* <p>
- * Implementation must have <tt>executorCell.jelly</tt>, which is
+ * Implementation must have {@code executorCell.jelly}, which is
* used to render the HTML that indicates this executable is executing.
*/
public interface Executable extends Runnable {
@@ -2184,8 +2217,10 @@ public class Queue extends ResourceController implements Saveable {
for (Action action: actions) addAction(action);
}
+ @SuppressWarnings("deprecation") // JENKINS-51584
protected Item(Item item) {
- this(item.task, new ArrayList<Action>(item.getAllActions()), item.id, item.future, item.inQueueSince);
+ // do not use item.getAllActions() here as this will persist actions from a TransientActionFactory
+ this(item.task, new ArrayList<Action>(item.getActions()), item.id, item.future, item.inQueueSince);
}
/**
@@ -2251,7 +2286,9 @@ public class Queue extends ResourceController implements Saveable {
@Deprecated
@RequirePOST
public HttpResponse doCancelQueue() throws IOException, ServletException {
- Jenkins.getInstance().getQueue().cancel(this);
+ if(hasCancelPermission()){
+ Jenkins.getInstance().getQueue().cancel(this);
+ }
return HttpResponses.forwardToPreviousPage();
}
@@ -3009,4 +3046,75 @@ public class Queue extends ResourceController implements Saveable {
public static void init(Jenkins h) {
h.getQueue().load();
}
+
+ /**
+ * Schedule {@code Queue.save()} call for near future once items change. Ignore all changes until the time the save
+ * takes place.
+ *
+ * Once queue is restored after a crash, items stages might not be accurate until the next #maintain() - this is not
+ * a problem as the items will be reshuffled first and then scheduled during the next maintainance cycle.
+ *
+ * Implementation note: Queue.load() calls QueueListener hooks for every item deserialized that can hammer the persistance
+ * on load. The problem is avoided by delaying the actual save for the time long enough for queue to load so the save
+ * operations will collapse into one. Also, items are persisted as buildable or blocked in vast majority of cases and
+ * those stages does not trigger the save here.
+ */
+ @Extension
+ @Restricted(NoExternalUse.class)
+ public static final class Saver extends QueueListener implements Runnable {
+
+ /**
+ * All negative values will disable periodic saving.
+ */
+ @VisibleForTesting
+ /*package*/ static /*final*/ int DELAY_SECONDS = SystemProperties.getInteger("hudson.model.Queue.Saver.DELAY_SECONDS", 60);
+
+ private final Object lock = new Object();
+ @GuardedBy("lock")
+ private Future<?> nextSave;
+
+ @Override
+ public void onEnterWaiting(WaitingItem wi) {
+ push();
+ }
+
+ @Override
+ public void onLeft(Queue.LeftItem li) {
+ push();
+ }
+
+ private void push() {
+ if (DELAY_SECONDS < 0) return;
+
+ synchronized (lock) {
+ // Can be done or canceled in case of a bug or external intervention - do not allow it to hang there forever
+ if (nextSave != null && !(nextSave.isDone() || nextSave.isCancelled())) return;
+ nextSave = Timer.get().schedule(this, DELAY_SECONDS, TimeUnit.SECONDS);
+ }
+ }
+
+ @Override
+ public void run() {
+ try {
+ Jenkins j = Jenkins.getInstanceOrNull();
+ if (j != null) {
+ j.getQueue().save();
+ }
+ } finally {
+ synchronized (lock) {
+ nextSave = null;
+ }
+ }
+ }
+
+ @VisibleForTesting @Restricted(NoExternalUse.class)
+ /*package*/ @Nonnull Future<?> getNextSave() {
+ synchronized (lock) {
+ return nextSave == null
+ ? Futures.precomputed(null)
+ : nextSave
+ ;
+ }
+ }
+ }
}
diff --git a/core/src/main/java/hudson/model/Run.java b/core/src/main/java/hudson/model/Run.java
index f7e11b1c657f13b6ddfe6d4a5a8a18b561333c5e..6b9c3fbbd97d1e9a8dd1d8b91565fe6e17a73bbe 100644
--- a/core/src/main/java/hudson/model/Run.java
+++ b/core/src/main/java/hudson/model/Run.java
@@ -59,6 +59,7 @@ import hudson.security.Permission;
import hudson.security.PermissionGroup;
import hudson.security.PermissionScope;
import hudson.tasks.BuildWrapper;
+import hudson.tasks.Fingerprinter.FingerprintAction;
import hudson.util.FormApply;
import hudson.util.LogTaskListener;
import hudson.util.ProcessTree;
@@ -73,12 +74,14 @@ import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.RandomAccessFile;
import java.io.Reader;
+import java.io.Serializable;
import java.nio.charset.Charset;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
+import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
@@ -92,6 +95,8 @@ import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import static java.util.logging.Level.*;
+import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
+
import java.util.logging.Logger;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
@@ -108,6 +113,7 @@ import jenkins.model.RunAction2;
import jenkins.model.StandardArtifactManager;
import jenkins.model.lazy.BuildReference;
import jenkins.model.lazy.LazyBuildMixIn;
+import jenkins.security.MasterToSlaveCallable;
import jenkins.util.VirtualFile;
import jenkins.util.io.OnMaster;
import net.sf.json.JSONObject;
@@ -119,8 +125,10 @@ import org.apache.commons.lang.ArrayUtils;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.HttpResponse;
+import org.kohsuke.stapler.HttpResponses;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.Stapler;
+import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
@@ -140,7 +148,7 @@ import org.kohsuke.stapler.interceptor.RequirePOST;
*/
@ExportedBean
public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,RunT>>
- extends Actionable implements ExtensionPoint, Comparable<RunT>, AccessControlled, PersistenceRoot, DescriptorByNameOwner, OnMaster {
+ extends Actionable implements ExtensionPoint, Comparable<RunT>, AccessControlled, PersistenceRoot, DescriptorByNameOwner, OnMaster, StaplerProxy {
/**
* The original {@link Queue.Item#getId()} has not yet been mapped onto the {@link Run} instance.
@@ -1090,12 +1098,16 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
* @return The list can be empty but never null
*/
public @Nonnull List<Artifact> getArtifactsUpTo(int artifactsNumber) {
- ArtifactList r = new ArtifactList();
+ SerializableArtifactList sal;
+ VirtualFile root = getArtifactManager().root();
try {
- addArtifacts(getArtifactManager().root(), "", "", r, null, artifactsNumber);
+ sal = root.run(new AddArtifacts(root, artifactsNumber));
} catch (IOException x) {
LOGGER.log(Level.WARNING, null, x);
+ sal = new SerializableArtifactList();
}
+ ArtifactList r = new ArtifactList();
+ r.updateFrom(sal);
r.computeDisplayName();
return r;
}
@@ -1109,9 +1121,25 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
return !getArtifactsUpTo(1).isEmpty();
}
- private int addArtifacts(@Nonnull VirtualFile dir,
+ private static final class AddArtifacts extends MasterToSlaveCallable<SerializableArtifactList, IOException> {
+ private static final long serialVersionUID = 1L;
+ private final VirtualFile root;
+ private final int artifactsNumber;
+ AddArtifacts(VirtualFile root, int artifactsNumber) {
+ this.root = root;
+ this.artifactsNumber = artifactsNumber;
+ }
+ @Override
+ public SerializableArtifactList call() throws IOException {
+ SerializableArtifactList sal = new SerializableArtifactList();
+ addArtifacts(root, "", "", sal, null, artifactsNumber);
+ return sal;
+ }
+ }
+
+ private static int addArtifacts(@Nonnull VirtualFile dir,
@Nonnull String path, @Nonnull String pathHref,
- @Nonnull ArtifactList r, @Nonnull Artifact parent, int upTo) throws IOException {
+ @Nonnull SerializableArtifactList r, @CheckForNull SerializableArtifact parent, int upTo) throws IOException {
VirtualFile[] kids = dir.list();
Arrays.sort(kids);
@@ -1122,26 +1150,26 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
String childHref = pathHref + Util.rawEncode(child);
String length = sub.isFile() ? String.valueOf(sub.length()) : "";
boolean collapsed = (kids.length==1 && parent!=null);
- Artifact a;
+ SerializableArtifact a;
if (collapsed) {
// Collapse single items into parent node where possible:
- a = new Artifact(parent.getFileName() + '/' + child, childPath,
+ a = new SerializableArtifact(parent.name + '/' + child, childPath,
sub.isDirectory() ? null : childHref, length,
- parent.getTreeNodeId());
+ parent.treeNodeId);
r.tree.put(a, r.tree.remove(parent));
} else {
// Use null href for a directory:
- a = new Artifact(child, childPath,
+ a = new SerializableArtifact(child, childPath,
sub.isDirectory() ? null : childHref, length,
"n" + ++r.idSeq);
- r.tree.put(a, parent!=null ? parent.getTreeNodeId() : null);
+ r.tree.put(a, parent!=null ? parent.treeNodeId : null);
}
if (sub.isDirectory()) {
n += addArtifacts(sub, childPath + '/', childHref + '/', r, a, upTo-n);
if (n>=upTo) break;
} else {
// Don't store collapsed path in ArrayList (for correct data in external API)
- r.add(collapsed ? new Artifact(child, a.relativePath, a.href, length, a.treeNodeId) : a);
+ r.add(collapsed ? new SerializableArtifact(child, a.relativePath, a.href, length, a.treeNodeId) : a);
if (++n>=upTo) break;
}
}
@@ -1159,6 +1187,30 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
public static final int TREE_CUTOFF = Integer.parseInt(SystemProperties.getString("hudson.model.Run.ArtifactList.treeCutoff", "40"));
// ..and then "too many"
+
+ /** {@link Run.Artifact} without the implicit link to {@link Run} */
+ private static final class SerializableArtifact implements Serializable {
+ private static final long serialVersionUID = 1L;
+ final String name;
+ final String relativePath;
+ final String href;
+ final String length;
+ final String treeNodeId;
+ SerializableArtifact(String name, String relativePath, String href, String length, String treeNodeId) {
+ this.name = name;
+ this.relativePath = relativePath;
+ this.href = href;
+ this.length = length;
+ this.treeNodeId = treeNodeId;
+ }
+ }
+
+ /** {@link Run.ArtifactList} without the implicit link to {@link Run} */
+ private static final class SerializableArtifactList extends ArrayList<SerializableArtifact> {
+ private static final long serialVersionUID = 1L;
+ private LinkedHashMap<SerializableArtifact, String> tree = new LinkedHashMap<>();
+ private int idSeq = 0;
+ }
public final class ArtifactList extends ArrayList<Artifact> {
private static final long serialVersionUID = 1L;
@@ -1167,7 +1219,24 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
* Contains Artifact objects for directories and files (the ArrayList contains only files).
*/
private LinkedHashMap<Artifact,String> tree = new LinkedHashMap<Artifact,String>();
- private int idSeq = 0;
+
+ void updateFrom(SerializableArtifactList clone) {
+ Map<String, Artifact> artifacts = new HashMap<>(); // need to share objects between tree and list, since computeDisplayName mutates displayPath
+ for (SerializableArtifact sa : clone) {
+ Artifact a = new Artifact(sa);
+ artifacts.put(a.relativePath, a);
+ add(a);
+ }
+ tree = new LinkedHashMap<>();
+ for (Map.Entry<SerializableArtifact, String> entry : clone.tree.entrySet()) {
+ SerializableArtifact sa = entry.getKey();
+ Artifact a = artifacts.get(sa.relativePath);
+ if (a == null) {
+ a = new Artifact(sa);
+ }
+ tree.put(a, entry.getValue());
+ }
+ }
public Map<Artifact,String> getTree() {
return tree;
@@ -1282,6 +1351,10 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
*/
private String length;
+ Artifact(SerializableArtifact clone) {
+ this(clone.name, clone.relativePath, clone.href, clone.length, clone.treeNodeId);
+ }
+
/*package for test*/ Artifact(String name, String relativePath, String href, String len, String treeNodeId) {
this.name = name;
this.relativePath = relativePath;
@@ -1334,6 +1407,21 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
}
}
+ /**
+ * get the fingerprints associated with this build
+ *
+ * @return The fingerprints
+ */
+ @Nonnull
+ @Exported(name = "fingerprint", inline = true, visibility = -1)
+ public Collection<Fingerprint> getBuildFingerprints() {
+ FingerprintAction fingerprintAction = getAction(FingerprintAction.class);
+ if (fingerprintAction != null) {
+ return fingerprintAction.getFingerprints().values();
+ }
+ return Collections.<Fingerprint>emptyList();
+ }
+
/**
* Returns the log file.
* @return The file may reference both uncompressed or compressed logs
@@ -1387,21 +1475,12 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
}
/**
- * Used from <tt>console.jelly</tt> to write annotated log to the given output.
+ * Used from {@code console.jelly} to write annotated log to the given output.
*
* @since 1.349
*/
public void writeLogTo(long offset, @Nonnull XMLOutput out) throws IOException {
- try {
- getLogText().writeHtmlTo(offset,out.asWriter());
- } catch (IOException e) {
- // try to fall back to the old getLogInputStream()
- // mainly to support .gz compressed files
- // In this case, console annotation handling will be turned off.
- try (InputStream input = getLogInputStream()) {
- IOUtils.copy(input, out.asWriter());
- }
- }
+ getLogText().writeHtmlTo(offset, out.asWriter());
}
/**
@@ -1487,6 +1566,10 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
RunListener.fireDeleted(this);
+ if (artifactManager != null) {
+ deleteArtifacts();
+ } // for StandardArtifactManager, deleting the whole build dir suffices
+
synchronized (this) { // avoid holding a lock while calling plugin impls of onDeleted
File tmp = new File(rootDir.getParentFile(),'.'+rootDir.getName());
@@ -2491,6 +2574,26 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
return returnedResult;
}
+ @Override
+ @Restricted(NoExternalUse.class)
+ public Object getTarget() {
+ if (!SKIP_PERMISSION_CHECK) {
+ // This is a bit weird, but while the Run's PermissionScope does not have READ, delegate to the parent
+ if (!getParent().hasPermission(Item.DISCOVER)) {
+ return null;
+ }
+ getParent().checkPermission(Item.READ);
+ }
+ return this;
+ }
+
+ /**
+ * Escape hatch for StaplerProxy-based access control
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean SKIP_PERMISSION_CHECK = Boolean.getBoolean(Run.class.getName() + ".skipPermissionCheck");
+
+
public static class RedirectUp {
public void doDynamic(StaplerResponse rsp) throws IOException {
// Compromise to handle both browsers (auto-redirect) and programmatic access
diff --git a/core/src/main/java/hudson/model/RunParameterDefinition.java b/core/src/main/java/hudson/model/RunParameterDefinition.java
index da1e7865e62734ae184fad71e5c0b2b01a53d2df..8f725193f22439c545695924a2445d00664763fd 100644
--- a/core/src/main/java/hudson/model/RunParameterDefinition.java
+++ b/core/src/main/java/hudson/model/RunParameterDefinition.java
@@ -92,7 +92,7 @@ public class RunParameterDefinition extends SimpleParameterDefinition {
public ParameterDefinition copyWithDefaultValue(ParameterValue defaultValue) {
if (defaultValue instanceof RunParameterValue) {
RunParameterValue value = (RunParameterValue) defaultValue;
- return new RunParameterDefinition(getName(), value.getRunId(), getDescription(), getFilter());
+ return new RunParameterDefinition(getName(), getProjectName(), value.getRunId(), getDescription(), getFilter());
} else {
return this;
}
diff --git a/core/src/main/java/hudson/model/Slave.java b/core/src/main/java/hudson/model/Slave.java
index cde11411fe8a4df976bea76232081b318232e233..f4395847929c2df9356113c0238708f70b9f4951 100644
--- a/core/src/main/java/hudson/model/Slave.java
+++ b/core/src/main/java/hudson/model/Slave.java
@@ -84,7 +84,7 @@ import org.kohsuke.stapler.StaplerResponse;
* Information about a Hudson agent node.
*
* <p>
- * Ideally this would have been in the <tt>hudson.slaves</tt> package,
+ * Ideally this would have been in the {@code hudson.slaves} package,
* but for compatibility reasons, it can't.
*
* <p>
@@ -146,8 +146,8 @@ public abstract class Slave extends Node implements Serializable {
*/
private String label="";
- private /*almost final*/ DescribableList<NodeProperty<?>,NodePropertyDescriptor> nodeProperties =
- new DescribableList<NodeProperty<?>,NodePropertyDescriptor>(Jenkins.getInstance().getNodesObject());
+ private /*almost final*/ DescribableList<NodeProperty<?>,NodePropertyDescriptor> nodeProperties =
+ new DescribableList<>(this);
/**
* Lazily computed set of labels from {@link #label}.
@@ -493,19 +493,19 @@ public abstract class Slave extends Node implements Serializable {
// RemoteLauncher requires an active Channel instance to operate correctly
final Channel channel = c.getChannel();
if (channel == null) {
- reportLauncerCreateError("The agent has not been fully initialized yet",
+ reportLauncherCreateError("The agent has not been fully initialized yet",
"No remoting channel to the agent OR it has not been fully initialized yet", listener);
return new Launcher.DummyLauncher(listener);
}
if (channel.isClosingOrClosed()) {
- reportLauncerCreateError("The agent is being disconnected",
+ reportLauncherCreateError("The agent is being disconnected",
"Remoting channel is either in the process of closing down or has closed down", listener);
return new Launcher.DummyLauncher(listener);
}
final Boolean isUnix = c.isUnix();
if (isUnix == null) {
// isUnix is always set when the channel is not null, so it should never happen
- reportLauncerCreateError("The agent has not been fully initialized yet",
+ reportLauncherCreateError("The agent has not been fully initialized yet",
"Cannot determing if the agent is a Unix one, the System status request has not completed yet. " +
"It is an invalid channel state, please report a bug to Jenkins if you see it.",
listener);
@@ -516,7 +516,7 @@ public abstract class Slave extends Node implements Serializable {
}
}
- private void reportLauncerCreateError(@Nonnull String humanReadableMsg, @CheckForNull String exceptionDetails, @Nonnull TaskListener listener) {
+ private void reportLauncherCreateError(@Nonnull String humanReadableMsg, @CheckForNull String exceptionDetails, @Nonnull TaskListener listener) {
String message = "Issue with creating launcher for agent " + name + ". " + humanReadableMsg;
listener.error(message);
if (LOGGER.isLoggable(Level.WARNING)) {
@@ -529,7 +529,12 @@ public abstract class Slave extends Node implements Serializable {
/**
* Gets the corresponding computer object.
+ *
+ * @return
+ * this method can return null if there's no {@link Computer} object for this node,
+ * such as when this node has no executors at all.
*/
+ @CheckForNull
public SlaveComputer getComputer() {
return (SlaveComputer)toComputer();
}
@@ -554,7 +559,7 @@ public abstract class Slave extends Node implements Serializable {
*/
protected Object readResolve() {
if(nodeProperties==null)
- nodeProperties = new DescribableList<NodeProperty<?>,NodePropertyDescriptor>(Jenkins.getInstance().getNodesObject());
+ nodeProperties = new DescribableList<>(this);
return this;
}
diff --git a/core/src/main/java/hudson/model/TaskListener.java b/core/src/main/java/hudson/model/TaskListener.java
index aeaae6643902a7a67337233d5702dd6dd00e95ab..e5e27f56c5c8cb92189f6161a1aafed79dd2bc83 100644
--- a/core/src/main/java/hudson/model/TaskListener.java
+++ b/core/src/main/java/hudson/model/TaskListener.java
@@ -25,6 +25,7 @@ package hudson.model;
import hudson.console.ConsoleNote;
import hudson.console.HyperlinkNote;
+import hudson.remoting.Channel;
import hudson.util.NullStream;
import hudson.util.StreamTaskListener;
@@ -59,7 +60,9 @@ import org.kohsuke.accmod.restrictions.ProtectedExternally;
*
* <p>
* {@link StreamTaskListener} is the most typical implementation of this interface.
- * All the {@link TaskListener} implementations passed to plugins from Hudson core are remotable.
+ *
+ * <p>
+ * Implementations are generally expected to be remotable via {@link Channel}.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/model/TopLevelItemDescriptor.java b/core/src/main/java/hudson/model/TopLevelItemDescriptor.java
index 32aee86d1c638d9424bb78ab73fb48a4a046f8e8..91488a22cc72f833f45322dd68704dfb0f4e473f 100644
--- a/core/src/main/java/hudson/model/TopLevelItemDescriptor.java
+++ b/core/src/main/java/hudson/model/TopLevelItemDescriptor.java
@@ -125,7 +125,7 @@ public abstract class TopLevelItemDescriptor extends Descriptor<TopLevelItem> im
*
* <p>
* Used as the caption when the user chooses what item type to create.
- * The descriptor implementation also needs to have <tt>newInstanceDetail.jelly</tt>
+ * The descriptor implementation also needs to have {@code newInstanceDetail.jelly}
* script, which will be used to render the text below the caption
* that explains the item type.
*/
@@ -135,10 +135,11 @@ public abstract class TopLevelItemDescriptor extends Descriptor<TopLevelItem> im
}
/**
- * A description of this kind of item type. This description can contain HTML code but it is recommend to use text plain
- * in order to avoid how it should be represented.
+ * A description of this kind of item type. This description can contain HTML code but it is recommended that
+ * you use plain text in order to be consistent with the rest of Jenkins.
*
- * This method should be called in a thread where Stapler is associated, but it will return an empty string.
+ * This method should be called from a thread where Stapler is handling an HTTP request, otherwise it will
+ * return an empty string.
*
* @return A string, by default the value from newInstanceDetail view is taken.
*
diff --git a/core/src/main/java/hudson/model/UpdateCenter.java b/core/src/main/java/hudson/model/UpdateCenter.java
index e2686cee56acfd6b335b909113730dbfd59dadb9..68aa1d292f470739476bf317b33490b857fd4233 100644
--- a/core/src/main/java/hudson/model/UpdateCenter.java
+++ b/core/src/main/java/hudson/model/UpdateCenter.java
@@ -23,6 +23,7 @@
*/
package hudson.model;
+import com.google.common.annotations.VisibleForTesting;
import hudson.BulkChange;
import hudson.Extension;
import hudson.ExtensionPoint;
@@ -38,6 +39,7 @@ import jenkins.util.SystemProperties;
import hudson.Util;
import hudson.XmlFile;
import static hudson.init.InitMilestone.PLUGINS_STARTED;
+import static java.util.logging.Level.INFO;
import static java.util.logging.Level.WARNING;
import hudson.init.Initializer;
@@ -52,7 +54,6 @@ import hudson.util.DaemonThreadFactory;
import hudson.util.FormValidation;
import hudson.util.HttpResponses;
import hudson.util.NamingThreadFactory;
-import hudson.util.IOException2;
import hudson.util.PersistedList;
import hudson.util.XStream2;
import jenkins.MissingDependencyException;
@@ -71,6 +72,7 @@ import org.jenkinsci.Symbol;
import org.jvnet.localizer.Localizable;
import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.stapler.HttpResponse;
+import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
@@ -147,7 +149,7 @@ import org.kohsuke.stapler.interceptor.RequirePOST;
* @since 1.220
*/
@ExportedBean
-public class UpdateCenter extends AbstractModelObject implements Saveable, OnMaster {
+public class UpdateCenter extends AbstractModelObject implements Saveable, OnMaster, StaplerProxy {
private static final String UPDATE_CENTER_URL = SystemProperties.getString(UpdateCenter.class.getName()+".updateCenterUrl","https://updates.jenkins.io/");
@@ -293,7 +295,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
}
public Api getApi() {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
return new Api(this);
}
@@ -365,7 +366,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@Restricted(DoNotUse.class)
public HttpResponse doConnectionStatus(StaplerRequest request) {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
try {
String siteId = request.getParameter("siteId");
if (siteId == null) {
@@ -418,7 +418,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@Restricted(DoNotUse.class) // WebOnly
public HttpResponse doIncompleteInstallStatus() {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
try {
Map<String,String> jobs = InstallUtil.getPersistedInstallStatus();
if(jobs == null) {
@@ -468,7 +467,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@Restricted(DoNotUse.class)
public HttpResponse doInstallStatus(StaplerRequest request) {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
try {
String correlationId = request.getParameter("correlationId");
Map<String,Object> response = new HashMap<>();
@@ -577,7 +575,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
}
/**
- * Gets the {@link UpdateSite} from which we receive updates for <tt>jenkins.war</tt>.
+ * Gets the {@link UpdateSite} from which we receive updates for {@code jenkins.war}.
*
* @return
* {@code null} if no such update center is provided.
@@ -634,7 +632,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@RequirePOST
public void doUpgrade(StaplerResponse rsp) throws IOException, ServletException {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
HudsonUpgradeJob job = new HudsonUpgradeJob(getCoreSource(), Jenkins.getAuthentication());
if(!Lifecycle.get().canRewriteHudsonWar()) {
sendError("Jenkins upgrade not supported in this running mode");
@@ -653,7 +650,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@RequirePOST
public HttpResponse doInvalidateData() {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
for (UpdateSite site : sites) {
site.doInvalidateData();
}
@@ -669,7 +665,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
public void doSafeRestart(StaplerRequest request, StaplerResponse response) throws IOException, ServletException {
synchronized (jobs) {
if (!isRestartScheduled()) {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
addJob(new RestartJenkinsJob(getCoreSource()));
LOGGER.info("Scheduling Jenkins reboot");
}
@@ -740,7 +735,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@RequirePOST
public void doDowngrade(StaplerResponse rsp) throws IOException, ServletException {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
if(!isDowngradable()) {
sendError("Jenkins downgrade is not possible, probably backup does not exist");
return;
@@ -757,7 +751,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@RequirePOST
public void doRestart(StaplerResponse rsp) throws IOException, ServletException {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
HudsonDowngradeJob job = new HudsonDowngradeJob(getCoreSource(), Jenkins.getAuthentication());
LOGGER.info("Scheduling the core downgrade");
@@ -996,7 +989,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
return results;
}
-
/**
* {@link AdministrativeMonitor} that checks if there's Jenkins update.
*/
@@ -1121,12 +1113,15 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
public File download(DownloadJob job, URL src) throws IOException {
MessageDigest sha1 = null;
+ MessageDigest sha256 = null;
+ MessageDigest sha512 = null;
try {
+ // Java spec says SHA-1 and SHA-256 exist, and SHA-512 might not, so one try/catch block should be fine
sha1 = MessageDigest.getInstance("SHA-1");
- } catch (NoSuchAlgorithmException ignored) {
- // Irrelevant as the Java spec says SHA-1 must exist. Still, if this fails
- // the DownloadJob will just have computedSha1 = null and that is expected
- // to be handled by caller
+ sha256 = MessageDigest.getInstance("SHA-256");
+ sha512 = MessageDigest.getInstance("SHA-512");
+ } catch (NoSuchAlgorithmException nsa) {
+ LOGGER.log(Level.WARNING, "Failed to instantiate message digest algorithm, may only have weak or no verification of downloaded file", nsa);
}
URLConnection con = null;
@@ -1149,7 +1144,10 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
String oldName = t.getName();
t.setName(oldName + ": " + src);
try (OutputStream _out = Files.newOutputStream(tmp.toPath());
- OutputStream out = sha1 != null ? new DigestOutputStream(_out, sha1) : _out;
+ OutputStream out =
+ sha1 != null ? new DigestOutputStream(
+ sha256 != null ? new DigestOutputStream(
+ sha512 != null ? new DigestOutputStream(_out, sha512) : _out, sha256) : _out, sha1) : _out;
InputStream in = con.getInputStream();
CountingInputStream cin = new CountingInputStream(in)) {
while ((len = cin.read(buf)) >= 0) {
@@ -1173,6 +1171,14 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
byte[] digest = sha1.digest();
job.computedSHA1 = Base64.encodeBase64String(digest);
}
+ if (sha256 != null) {
+ byte[] digest = sha256.digest();
+ job.computedSHA256 = Base64.encodeBase64String(digest);
+ }
+ if (sha512 != null) {
+ byte[] digest = sha512.digest();
+ job.computedSHA512 = Base64.encodeBase64String(digest);
+ }
return tmp;
} catch (IOException e) {
// assist troubleshooting in case of e.g. "too many redirects" by printing actual URL
@@ -1183,7 +1189,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
// Also, since it involved name resolution, it'd be an expensive operation.
extraMessage = " (redirected to: " + con.getURL() + ")";
}
- throw new IOException2("Failed to download from "+src+extraMessage,e);
+ throw new IOException("Failed to download from "+src+extraMessage,e);
}
}
@@ -1226,8 +1232,8 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*
* @deprecated as of 1.333
* With the introduction of multiple update center capability, this information
- * is now a part of the <tt>update-center.json</tt> file. See
- * <tt>http://jenkins-ci.org/update-center.json</tt> as an example.
+ * is now a part of the {@code update-center.json} file. See
+ * {@code http://jenkins-ci.org/update-center.json} as an example.
*/
@Deprecated
public String getConnectionCheckUrl() {
@@ -1253,7 +1259,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
* Returns the URL of the server that hosts plugins and core updates.
*
* @deprecated as of 1.333
- * <tt>update-center.json</tt> is now signed, so we don't have to further make sure that
+ * {@code update-center.json} is now signed, so we don't have to further make sure that
* we aren't downloading from anywhere unsecure.
*/
@Deprecated
@@ -1287,7 +1293,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
/**
* Things that {@link UpdateCenter#installerService} executes.
*
- * This object will have the <tt>row.jelly</tt> which renders the job on UI.
+ * This object will have the {@code row.jelly} which renders the job on UI.
*/
@ExportedBean
public abstract class UpdateCenterJob implements Runnable {
@@ -1409,7 +1415,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
status = new Running();
try {
// safeRestart records the current authentication for the log, so set it to the managing user
- try (ACLContext _ = ACL.as(User.get(authentication, false, Collections.emptyMap()))) {
+ try (ACLContext acl = ACL.as(User.get(authentication, false, Collections.emptyMap()))) {
Jenkins.getInstance().safeRestart();
}
} catch (RestartNotSupportedException exception) {
@@ -1603,11 +1609,18 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
status = new Success();
}
}
+
+ @Restricted(NoExternalUse.class)
+ /*package*/ interface WithComputedChecksums {
+ String getComputedSHA1();
+ String getComputedSHA256();
+ String getComputedSHA512();
+ }
/**
* Base class for a job that downloads a file from the Jenkins project.
*/
- public abstract class DownloadJob extends UpdateCenterJob {
+ public abstract class DownloadJob extends UpdateCenterJob implements WithComputedChecksums {
/**
* Immutable object representing the current state of this job.
*/
@@ -1634,16 +1647,41 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
/**
* During download, an attempt is made to compute the SHA-1 checksum of the file.
+ * This is the base64 encoded SHA-1 checksum.
*
* @since 1.641
*/
@CheckForNull
- protected String getComputedSHA1() {
+ public String getComputedSHA1() {
return computedSHA1;
}
private String computedSHA1;
+ /**
+ * Base64 encoded SHA-256 checksum of the downloaded file, if it could be computed.
+ *
+ * @since 2.130
+ */
+ @CheckForNull
+ public String getComputedSHA256() {
+ return computedSHA256;
+ }
+
+ private String computedSHA256;
+
+ /**
+ * Base64 encoded SHA-512 checksum of the downloaded file, if it could be computed.
+ *
+ * @since 2.130
+ */
+ @CheckForNull
+ public String getComputedSHA512() {
+ return computedSHA512;
+ }
+
+ private String computedSHA512;
+
private Authentication authentication;
/**
@@ -1808,22 +1846,88 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
}
/**
- * If expectedSHA1 is non-null, ensure that actualSha1 is the same value, otherwise throw.
- *
- * Utility method for InstallationJob and HudsonUpgradeJob.
+ * Compare the provided values and return the appropriate {@link VerificationResult}.
*
- * @throws IOException when checksums don't match, or actual checksum was null.
*/
- private void verifyChecksums(String expectedSHA1, String actualSha1, File downloadedFile) throws IOException {
- if (expectedSHA1 != null) {
- if (actualSha1 == null) {
- // refuse to install if SHA-1 could not be computed
+ private static VerificationResult verifyChecksums(String expectedDigest, String actualDigest, boolean caseSensitive) {
+ if (expectedDigest == null) {
+ return VerificationResult.NOT_PROVIDED;
+ }
+
+ if (actualDigest == null) {
+ return VerificationResult.NOT_COMPUTED;
+ }
+
+ if (caseSensitive ? expectedDigest.equals(actualDigest) : expectedDigest.equalsIgnoreCase(actualDigest)) {
+ return VerificationResult.PASS;
+ }
+
+ return VerificationResult.FAIL;
+ }
+
+ private static enum VerificationResult {
+ PASS,
+ NOT_PROVIDED,
+ NOT_COMPUTED,
+ FAIL
+ }
+
+ /**
+ * Throws an {@code IOException} with a message about {@code actual} not matching {@code expected} for {@code file} when using {@code algorithm}.
+ */
+ private static void throwVerificationFailure(String expected, String actual, File file, String algorithm) throws IOException {
+ throw new IOException("Downloaded file " + file.getAbsolutePath() + " does not match expected " + algorithm + ", expected '" + expected + "', actual '" + actual + "'");
+ }
+
+ /**
+ * Implements the checksum verification logic with fallback to weaker algorithm for {@link DownloadJob}.
+ * @param job The job downloading the file to check
+ * @param entry The metadata entry for the file to check
+ * @param file The downloaded file
+ * @throws IOException thrown when one of the checks failed, or no checksum could be computed.
+ */
+ @VisibleForTesting
+ @Restricted(NoExternalUse.class)
+ /* package */ static void verifyChecksums(WithComputedChecksums job, UpdateSite.Entry entry, File file) throws IOException {
+ VerificationResult result512 = verifyChecksums(entry.getSha512(), job.getComputedSHA512(), false);
+ switch (result512) {
+ case PASS:
+ // this has passed so no reason to check the weaker checksums
+ return;
+ case FAIL:
+ throwVerificationFailure(entry.getSha512(), job.getComputedSHA512(), file, "SHA-512");
+ case NOT_COMPUTED:
+ LOGGER.log(WARNING, "Attempt to verify a downloaded file (" + file.getName() + ") using SHA-512 failed since it could not be computed. Falling back to weaker algorithms. Update your JRE.");
+ break;
+ case NOT_PROVIDED:
+ break;
+ }
+
+ VerificationResult result256 = verifyChecksums(entry.getSha256(), job.getComputedSHA256(), false);
+ switch (result256) {
+ case PASS:
+ return;
+ case FAIL:
+ throwVerificationFailure(entry.getSha256(), job.getComputedSHA256(), file, "SHA-256");
+ case NOT_COMPUTED:
+ case NOT_PROVIDED:
+ break;
+ }
+
+ if (result512 == VerificationResult.NOT_PROVIDED && result256 == VerificationResult.NOT_PROVIDED) {
+ LOGGER.log(INFO, "Attempt to verify a downloaded file (" + file.getName() + ") using SHA-512 or SHA-256 failed since your configured update site does not provide either of those checksums. Falling back to SHA-1.");
+ }
+
+ VerificationResult result1 = verifyChecksums(entry.getSha1(), job.getComputedSHA1(), true);
+ switch (result1) {
+ case PASS:
+ return;
+ case FAIL:
+ throwVerificationFailure(entry.getSha1(), job.getComputedSHA1(), file, "SHA-1");
+ case NOT_COMPUTED:
throw new IOException("Failed to compute SHA-1 of downloaded file, refusing installation");
- }
- if (!expectedSHA1.equals(actualSha1)) {
- throw new IOException("Downloaded file " + downloadedFile.getAbsolutePath() + " does not match expected SHA-1, expected '" + expectedSHA1 + "', actual '" + actualSha1 + "'");
- // keep 'downloadedFile' around for investigating what's going on
- }
+ case NOT_PROVIDED:
+ throw new IOException("Unable to confirm integrity of downloaded file, refusing installation");
}
}
@@ -1973,8 +2077,9 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
*/
@Override
protected void replace(File dst, File src) throws IOException {
-
- verifyChecksums(plugin.getSha1(), getComputedSHA1(), src);
+ if (!site.getId().equals(ID_UPLOAD)) {
+ verifyChecksums(this, plugin, src);
+ }
File bak = Util.changeExtension(dst, ".bak");
bak.delete();
@@ -2108,8 +2213,7 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
@Override
protected void replace(File dst, File src) throws IOException {
- String expectedSHA1 = site.getData().core.getSha1();
- verifyChecksums(expectedSHA1, getComputedSHA1(), src);
+ verifyChecksums(this, site.getData().core, src);
Lifecycle.get().rewriteHudsonWar(src);
}
}
@@ -2241,6 +2345,22 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
}
}
+ @Override
+ @Restricted(NoExternalUse.class)
+ public Object getTarget() {
+ if (!SKIP_PERMISSION_CHECK) {
+ Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
+ }
+ return this;
+ }
+
+ /**
+ * Escape hatch for StaplerProxy-based access control
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean SKIP_PERMISSION_CHECK = Boolean.getBoolean(UpdateCenter.class.getName() + ".skipPermissionCheck");
+
+
/**
* Sequence number generator.
*/
diff --git a/core/src/main/java/hudson/model/UpdateSite.java b/core/src/main/java/hudson/model/UpdateSite.java
index c7f7899431651d3cbc7e6f7a8f93b0e23feee1ea..86c2233f2a1248c6a7675e6a5d457858b46a2cac 100644
--- a/core/src/main/java/hudson/model/UpdateSite.java
+++ b/core/src/main/java/hudson/model/UpdateSite.java
@@ -35,6 +35,7 @@ import hudson.model.UpdateCenter.UpdateCenterJob;
import hudson.util.FormValidation;
import hudson.util.FormValidation.Kind;
import hudson.util.HttpResponses;
+import static jenkins.util.MemoryReductionUtil.*;
import hudson.util.TextFile;
import static java.util.concurrent.TimeUnit.*;
import hudson.util.VersionNumber;
@@ -46,7 +47,6 @@ import java.net.URLEncoder;
import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.Collections;
-import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
@@ -56,6 +56,7 @@ import java.util.TreeMap;
import java.util.UUID;
import java.util.concurrent.Callable;
import java.util.concurrent.Future;
+import java.util.function.Predicate;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
@@ -120,11 +121,6 @@ public class UpdateSite {
*/
private transient volatile long retryWindow;
- /**
- * lastModified time of the data file when it was last read.
- */
- private transient long dataLastReadFromFile;
-
/**
* Latest data as read from the data file.
*/
@@ -136,7 +132,7 @@ public class UpdateSite {
private final String id;
/**
- * Path to <tt>update-center.json</tt>, like <tt>http://jenkins-ci.org/update-center.json</tt>.
+ * Path to {@code update-center.json}, like {@code http://jenkins-ci.org/update-center.json}.
*/
private final String url;
@@ -226,6 +222,7 @@ public class UpdateSite {
LOGGER.info("Obtained the latest update center data file for UpdateSource " + id);
retryWindow = 0;
getDataFile().write(json);
+ data = new Data(o);
return FormValidation.ok();
}
@@ -309,23 +306,20 @@ public class UpdateSite {
public HttpResponse doInvalidateData() {
Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
dataTimestamp = 0;
+ data = null;
return HttpResponses.ok();
}
/**
- * Loads the update center data, if any and if modified since last read.
+ * Loads the update center data, if any.
*
* @return null if no data is available.
*/
public Data getData() {
- TextFile df = getDataFile();
- if (df.exists() && dataLastReadFromFile != df.file.lastModified()) {
+ if (data == null) {
JSONObject o = getJSONObject();
- if (o!=null) {
+ if (o != null) {
data = new Data(o);
- dataLastReadFromFile = df.file.lastModified();
- } else {
- data = null;
}
}
return data;
@@ -492,7 +486,15 @@ public class UpdateSite {
* Is this the legacy default update center site?
*/
public boolean isLegacyDefault() {
- return id.equals(UpdateCenter.PREDEFINED_UPDATE_SITE_ID) && url.startsWith("http://hudson-ci.org/") || url.startsWith("http://updates.hudson-labs.org/");
+ return isHudsonCI() || isUpdatesFromHudsonLabs();
+ }
+
+ private boolean isHudsonCI() {
+ return url != null && UpdateCenter.PREDEFINED_UPDATE_SITE_ID.equals(id) && url.startsWith("http://hudson-ci.org/");
+ }
+
+ private boolean isUpdatesFromHudsonLabs() {
+ return url != null && url.startsWith("http://updates.hudson-labs.org/");
}
/**
@@ -526,7 +528,7 @@ public class UpdateSite {
public final String connectionCheckUrl;
Data(JSONObject o) {
- this.sourceId = (String)o.get("id");
+ this.sourceId = Util.intern((String)o.get("id"));
JSONObject c = o.optJSONObject("core");
if (c!=null) {
core = new Entry(sourceId, c, url);
@@ -556,7 +558,7 @@ public class UpdateSite {
}
}
}
- plugins.put(e.getKey(), p);
+ plugins.put(Util.intern(e.getKey()), p);
}
connectionCheckUrl = (String)o.get("connectionCheckUrl");
@@ -616,18 +618,26 @@ public class UpdateSite {
@Restricted(NoExternalUse.class)
/* final */ String sha1;
+ @Restricted(NoExternalUse.class)
+ /* final */ String sha256;
+
+ @Restricted(NoExternalUse.class)
+ /* final */ String sha512;
+
public Entry(String sourceId, JSONObject o) {
this(sourceId, o, null);
}
Entry(String sourceId, JSONObject o, String baseURL) {
this.sourceId = sourceId;
- this.name = o.getString("name");
- this.version = o.getString("version");
+ this.name = Util.intern(o.getString("name"));
+ this.version = Util.intern(o.getString("version"));
// Trim this to prevent issues when the other end used Base64.encodeBase64String that added newlines
// to the end in old commons-codec. Not the case on updates.jenkins-ci.org, but let's be safe.
this.sha1 = Util.fixEmptyAndTrim(o.optString("sha1"));
+ this.sha256 = Util.fixEmptyAndTrim(o.optString("sha256"));
+ this.sha512 = Util.fixEmptyAndTrim(o.optString("sha512"));
String url = o.getString("url");
if (!URI.create(url).isAbsolute()) {
@@ -649,6 +659,24 @@ public class UpdateSite {
return sha1;
}
+ /**
+ * The base64 encoded SHA-256 checksum of the file.
+ * Can be null if not provided by the update site.
+ * @since 2.130
+ */
+ public String getSha256() {
+ return sha256;
+ }
+
+ /**
+ * The base64 encoded SHA-512 checksum of the file.
+ * Can be null if not provided by the update site.
+ * @since 2.130
+ */
+ public String getSha512() {
+ return sha512;
+ }
+
/**
* Checks if the specified "current version" is older than the version of this entry.
*
@@ -711,8 +739,8 @@ public class UpdateSite {
public WarningVersionRange(JSONObject o) {
this.name = Util.fixEmpty(o.optString("name"));
- this.firstVersion = Util.fixEmpty(o.optString("firstVersion"));
- this.lastVersion = Util.fixEmpty(o.optString("lastVersion"));
+ this.firstVersion = Util.intern(Util.fixEmpty(o.optString("firstVersion")));
+ this.lastVersion = Util.intern(Util.fixEmpty(o.optString("lastVersion")));
Pattern p;
try {
p = Pattern.compile(o.getString("pattern"));
@@ -809,13 +837,13 @@ public class UpdateSite {
this.type = Type.UNKNOWN;
}
this.id = o.getString("id");
- this.component = o.getString("name");
+ this.component = Util.intern(o.getString("name"));
this.message = o.getString("message");
this.url = o.getString("url");
if (o.has("versions")) {
- List<WarningVersionRange> ranges = new ArrayList<>();
JSONArray versions = o.getJSONArray("versions");
+ List<WarningVersionRange> ranges = new ArrayList<>(versions.size());
for (int i = 0; i < versions.size(); i++) {
WarningVersionRange range = new WarningVersionRange(versions.getJSONObject(i));
ranges.add(range);
@@ -899,6 +927,16 @@ public class UpdateSite {
}
}
+ private static String get(JSONObject o, String prop) {
+ if(o.has(prop))
+ return o.getString(prop);
+ else
+ return null;
+ }
+
+ static final Predicate<Object> IS_DEP_PREDICATE = x -> x instanceof JSONObject && get(((JSONObject)x), "name") != null;
+ static final Predicate<Object> IS_NOT_OPTIONAL = x-> "false".equals(get(((JSONObject)x), "optional"));
+
public final class Plugin extends Entry {
/**
* Optional URL to the Wiki page that discusses this plugin.
@@ -940,13 +978,13 @@ public class UpdateSite {
* Dependencies of this plugin, a name -> version mapping.
*/
@Exported
- public final Map<String,String> dependencies = new HashMap<String,String>();
+ public final Map<String,String> dependencies;
/**
* Optional dependencies of this plugin.
*/
@Exported
- public final Map<String,String> optionalDependencies = new HashMap<String,String>();
+ public final Map<String,String> optionalDependencies;
@DataBoundConstructor
public Plugin(String sourceId, JSONObject o) {
@@ -954,30 +992,31 @@ public class UpdateSite {
this.wiki = get(o,"wiki");
this.title = get(o,"title");
this.excerpt = get(o,"excerpt");
- this.compatibleSinceVersion = get(o,"compatibleSinceVersion");
- this.requiredCore = get(o,"requiredCore");
- this.categories = o.has("labels") ? (String[])o.getJSONArray("labels").toArray(new String[0]) : null;
+ this.compatibleSinceVersion = Util.intern(get(o,"compatibleSinceVersion"));
+ this.requiredCore = Util.intern(get(o,"requiredCore"));
+ this.categories = o.has("labels") ? internInPlace((String[])o.getJSONArray("labels").toArray(EMPTY_STRING_ARRAY)) : null;
+ JSONArray ja = o.getJSONArray("dependencies");
+ int depCount = (int)(ja.stream().filter(IS_DEP_PREDICATE.and(IS_NOT_OPTIONAL)).count());
+ int optionalDepCount = (int)(ja.stream().filter(IS_DEP_PREDICATE.and(IS_NOT_OPTIONAL.negate())).count());
+ dependencies = getPresizedMutableMap(depCount);
+ optionalDependencies = getPresizedMutableMap(optionalDepCount);
+
for(Object jo : o.getJSONArray("dependencies")) {
JSONObject depObj = (JSONObject) jo;
// Make sure there's a name attribute and that the optional value isn't true.
- if (get(depObj,"name")!=null) {
+ String depName = Util.intern(get(depObj,"name"));
+ if (depName!=null) {
if (get(depObj, "optional").equals("false")) {
- dependencies.put(get(depObj, "name"), get(depObj, "version"));
+ dependencies.put(depName, Util.intern(get(depObj, "version")));
} else {
- optionalDependencies.put(get(depObj, "name"), get(depObj, "version"));
+ optionalDependencies.put(depName, Util.intern(get(depObj, "version")));
}
}
-
}
}
- private String get(JSONObject o, String prop) {
- if(o.has(prop))
- return o.getString(prop);
- else
- return null;
- }
+
public String getDisplayName() {
String displayName;
@@ -1094,10 +1133,19 @@ public class UpdateSite {
}
public boolean isNeededDependenciesForNewerJenkins() {
- for (Plugin p: getNeededDependencies()) {
- if (p.isForNewerHudson() || p.isNeededDependenciesForNewerJenkins()) return true;
- }
- return false;
+ return isNeededDependenciesForNewerJenkins(new PluginManager.MetadataCache());
+ }
+
+ @Restricted(NoExternalUse.class) // table.jelly
+ public boolean isNeededDependenciesForNewerJenkins(PluginManager.MetadataCache cache) {
+ return cache.of("isNeededDependenciesForNewerJenkins:" + name, Boolean.class, () -> {
+ for (Plugin p : getNeededDependencies()) {
+ if (p.isForNewerHudson() || p.isNeededDependenciesForNewerJenkins()) {
+ return true;
+ }
+ }
+ return false;
+ });
}
/**
@@ -1109,11 +1157,19 @@ public class UpdateSite {
* specified, it'll return true.
*/
public boolean isNeededDependenciesCompatibleWithInstalledVersion() {
- for (Plugin p: getNeededDependencies()) {
- if (!p.isCompatibleWithInstalledVersion() || !p.isNeededDependenciesCompatibleWithInstalledVersion())
- return false;
- }
- return true;
+ return isNeededDependenciesCompatibleWithInstalledVersion(new PluginManager.MetadataCache());
+ }
+
+ @Restricted(NoExternalUse.class) // table.jelly
+ public boolean isNeededDependenciesCompatibleWithInstalledVersion(PluginManager.MetadataCache cache) {
+ return cache.of("isNeededDependenciesCompatibleWithInstalledVersion:" + name, Boolean.class, () -> {
+ for (Plugin p : getNeededDependencies()) {
+ if (!p.isCompatibleWithInstalledVersion() || !p.isNeededDependenciesCompatibleWithInstalledVersion()) {
+ return false;
+ }
+ }
+ return true;
+ });
}
/**
diff --git a/core/src/main/java/hudson/model/UsageStatistics.java b/core/src/main/java/hudson/model/UsageStatistics.java
index 2f78840b63154e07e8824f561db0a4d997d77602..bb791d38e15d82c220d80ca22eba02f8fc5f5c52 100644
--- a/core/src/main/java/hudson/model/UsageStatistics.java
+++ b/core/src/main/java/hudson/model/UsageStatistics.java
@@ -66,7 +66,7 @@ import jenkins.util.SystemProperties;
* @author Kohsuke Kawaguchi
*/
@Extension
-public class UsageStatistics extends PageDecorator {
+public class UsageStatistics extends PageDecorator implements PersistentDescriptor {
private final String keyImage;
/**
@@ -88,7 +88,6 @@ public class UsageStatistics extends PageDecorator {
*/
public UsageStatistics(String keyImage) {
this.keyImage = keyImage;
- load();
}
/**
diff --git a/core/src/main/java/hudson/model/User.java b/core/src/main/java/hudson/model/User.java
index 7f132023b7f2506b2d2c5e0a9b8517f1ce8a5ea0..654d41432fca3777a21521df3b166fdfe6160b61 100644
--- a/core/src/main/java/hudson/model/User.java
+++ b/core/src/main/java/hudson/model/User.java
@@ -97,6 +97,9 @@ import org.apache.commons.lang.StringUtils;
import org.jenkinsci.Symbol;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.HttpResponses;
+import org.kohsuke.stapler.Stapler;
+import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.Exported;
@@ -104,6 +107,8 @@ import org.kohsuke.stapler.export.ExportedBean;
import org.kohsuke.stapler.interceptor.RequirePOST;
import org.springframework.dao.DataAccessException;
+import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
+
/**
* Represents a user.
*
@@ -129,7 +134,7 @@ import org.springframework.dao.DataAccessException;
* @author Kohsuke Kawaguchi
*/
@ExportedBean
-public class User extends AbstractModelObject implements AccessControlled, DescriptorByNameOwner, Saveable, Comparable<User>, ModelObjectWithContextMenu {
+public class User extends AbstractModelObject implements AccessControlled, DescriptorByNameOwner, Saveable, Comparable<User>, ModelObjectWithContextMenu, StaplerProxy {
/**
* The username of the 'unknown' user used to avoid null user references.
@@ -490,7 +495,8 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
byNameLock.readLock().unlock();
}
final File configFile = getConfigFileFor(id);
- if (unsanitizedLegacyConfigFile.exists() && !unsanitizedLegacyConfigFile.equals(configFile)) {
+ boolean mustMigrateLegacyConfig = isMigrationRequiredForLegacyConfigFile(unsanitizedLegacyConfigFile, configFile);
+ if (mustMigrateLegacyConfig) {
File ancestor = unsanitizedLegacyConfigFile.getParentFile();
if (!configFile.exists()) {
try {
@@ -552,6 +558,37 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
}
return u;
}
+
+ private static boolean isMigrationRequiredForLegacyConfigFile(@Nonnull File legacyConfigFile, @Nonnull File newConfigFile){
+ boolean mustMigrateLegacyConfig = legacyConfigFile.exists() && !legacyConfigFile.equals(newConfigFile);
+ if(mustMigrateLegacyConfig){
+ try{
+ // TODO Could be replace by Util.isDescendant(getRootDir(), legacyConfigFile) in 2.80+
+ String canonicalLegacy = legacyConfigFile.getCanonicalPath();
+ String canonicalUserDir = getRootDir().getCanonicalPath();
+ if(!canonicalLegacy.startsWith(canonicalUserDir + File.separator)){
+ // without that check, the application config.xml could be moved (i.e. erased from application PoV)
+ mustMigrateLegacyConfig = false;
+ LOGGER.log(Level.WARNING, String.format(
+ "Attempt to escape from users directory with %s, migration aborted, see SECURITY-897 for more information",
+ legacyConfigFile.getAbsolutePath()
+ ));
+ }
+ }
+ catch (IOException e){
+ mustMigrateLegacyConfig = false;
+ LOGGER.log(
+ Level.WARNING,
+ String.format(
+ "Failed to determine the canonical path of %s, migration aborted, see SECURITY-897 for more information",
+ legacyConfigFile.getAbsolutePath()
+ ),
+ e
+ );
+ }
+ }
+ return mustMigrateLegacyConfig;
+ }
/**
* Gets the {@link User} object by its id or full name.
@@ -764,6 +801,16 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
public @Override String toString() {
return fullName;
}
+
+ /**
+ * Returns the folder that store all the user information
+ * Useful for plugins to save a user-specific file aside the config.xml
+ *
+ * @since 2.129
+ */
+ public File getUserFolder(){
+ return getUserFolderFor(this.id);
+ }
/**
* The file we save our configuration.
@@ -773,7 +820,11 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
}
private static final File getConfigFileFor(String id) {
- return new File(getRootDir(), idStrategy().filenameOf(id) +"/config.xml");
+ return new File(getUserFolderFor(id), "config.xml");
+ }
+
+ private static File getUserFolderFor(String id){
+ return new File(getRootDir(), idStrategy().filenameOf(id));
}
private static File getUnsanitizedLegacyConfigFileFor(String id) {
@@ -977,14 +1028,10 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
}
public ACL getACL() {
- final ACL base = Jenkins.getInstance().getAuthorizationStrategy().getACL(this);
+ ACL base = Jenkins.getInstance().getAuthorizationStrategy().getACL(this);
// always allow a non-anonymous user full control of himself.
- return new ACL() {
- public boolean hasPermission(Authentication a, Permission permission) {
- return (idStrategy().equals(a.getName(), id) && !(a instanceof AnonymousAuthenticationToken))
- || base.hasPermission(a, permission);
- }
- };
+ return ACL.lambda((a, permission) -> (idStrategy().equals(a.getName(), id) && !(a instanceof AnonymousAuthenticationToken))
+ || base.hasPermission(a, permission));
}
/**
@@ -1071,6 +1118,24 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
public ContextMenu doContextMenu(StaplerRequest request, StaplerResponse response) throws Exception {
return new ContextMenu().from(this,request,response);
}
+
+ @Override
+ @Restricted(NoExternalUse.class)
+ public Object getTarget() {
+ if (!SKIP_PERMISSION_CHECK) {
+ if (!Jenkins.get().hasPermission(Jenkins.READ)) {
+ return null;
+ }
+ }
+ return this;
+ }
+
+ /**
+ * Escape hatch for StaplerProxy-based access control
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean SKIP_PERMISSION_CHECK = Boolean.getBoolean(User.class.getName() + ".skipPermissionCheck");
+
/**
* Gets list of Illegal usernames, for which users should not be created.
@@ -1096,6 +1161,9 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
File[] subdirs = getRootDir().listFiles((FileFilter) DirectoryFileFilter.INSTANCE);
if (subdirs != null) {
for (File subdir : subdirs) {
+ if (subdir.equals(getRootDir())) {
+ continue; // ignore the parent directory in case of stray config.xml
+ }
File configFile = new File(subdir, "config.xml");
if (configFile.exists()) {
String name = strategy.idFromFilename(subdir.getName());
diff --git a/core/src/main/java/hudson/model/UserProperty.java b/core/src/main/java/hudson/model/UserProperty.java
index 48198a28ebbe9400139f48735b15067cf33bbfcc..ec02b1211b99d78fa15d5024b8ce69f6311fb006 100644
--- a/core/src/main/java/hudson/model/UserProperty.java
+++ b/core/src/main/java/hudson/model/UserProperty.java
@@ -41,10 +41,10 @@ import org.kohsuke.stapler.export.ExportedBean;
* configuration screen, and they are persisted with the user object.
*
* <p>
- * Configuration screen should be defined in <tt>config.jelly</tt>.
+ * Configuration screen should be defined in {@code config.jelly}.
* Within this page, the {@link UserProperty} instance is available
- * as <tt>instance</tt> variable (while <tt>it</tt> refers to {@link User}.
- * See {@link hudson.search.UserSearchProperty}'s <tt>config.jelly</tt> for an example.
+ * as {@code instance} variable (while {@code it} refers to {@link User}.
+ * See {@link hudson.search.UserSearchProperty}'s {@code config.jelly} for an example.
* <p>A property may also define a {@code summary.jelly} view to show in the main user screen.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/model/View.java b/core/src/main/java/hudson/model/View.java
index 83a368250316fcf82c63a9c0145093bde78c46e9..fcab16b90b2043c855c23b0c4accc7ad3f7c071f 100644
--- a/core/src/main/java/hudson/model/View.java
+++ b/core/src/main/java/hudson/model/View.java
@@ -26,7 +26,6 @@ package hudson.model;
import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.io.StreamException;
-import com.thoughtworks.xstream.io.xml.Xpp3Driver;
import hudson.DescriptorExtensionList;
import hudson.Extension;
import hudson.ExtensionPoint;
@@ -117,7 +116,6 @@ import java.util.logging.Logger;
import java.util.stream.Collectors;
import static javax.servlet.http.HttpServletResponse.SC_BAD_REQUEST;
-import static jenkins.scm.RunWithSCM.*;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
@@ -135,7 +133,7 @@ import org.xml.sax.SAXException;
* <h2>Note for implementers</h2>
* <ul>
* <li>
- * {@link View} subtypes need the <tt>newViewDetail.jelly</tt> page,
+ * {@link View} subtypes need the {@code newViewDetail.jelly} page,
* which is included in the "new view" page. This page should have some
* description of what the view is about.
* </ul>
@@ -173,8 +171,6 @@ public abstract class View extends AbstractModelObject implements AccessControll
*/
protected boolean filterQueue;
- protected transient List<Action> transientActions;
-
/**
* List of {@link ViewProperty}s configured for this view.
* @since 1.406
@@ -193,6 +189,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
/**
* Gets all the items in this collection in a read-only view.
*/
+ @Nonnull
@Exported(name="jobs")
public abstract Collection<TopLevelItem> getItems();
@@ -550,21 +547,20 @@ public abstract class View extends AbstractModelObject implements AccessControll
* @see Jenkins#getActions()
*/
public List<Action> getActions() {
- List<Action> result = new ArrayList<Action>();
- result.addAll(getOwner().getViewActions());
- synchronized (this) {
- if (transientActions == null) {
- updateTransientActions();
- }
- result.addAll(transientActions);
- }
- return result;
- }
-
- public synchronized void updateTransientActions() {
- transientActions = TransientViewActionFactory.createAllFor(this);
+ List<Action> result = new ArrayList<>();
+ result.addAll(getOwner().getViewActions());
+ result.addAll(TransientViewActionFactory.createAllFor(this));
+ return result;
}
-
+
+ /**
+ * No-op. Included to maintain backwards compatibility.
+ * @deprecated This method does nothing and should not be used
+ */
+ @Restricted(DoNotUse.class)
+ @Deprecated
+ public void updateTransientActions() {}
+
public Object getDynamic(String token) {
for (Action a : getActions()) {
String url = a.getUrlName();
@@ -994,7 +990,6 @@ public abstract class View extends AbstractModelObject implements AccessControll
rename(req.getParameter("name"));
getProperties().rebuild(req, req.getSubmittedForm(), getApplicablePropertyDescriptors());
- updateTransientActions();
save();
@@ -1070,11 +1065,11 @@ public abstract class View extends AbstractModelObject implements AccessControll
*/
@Restricted(DoNotUse.class)
public Categories doItemCategories(StaplerRequest req, StaplerResponse rsp, @QueryParameter String iconStyle) throws IOException, ServletException {
+ getOwner().checkPermission(Item.CREATE);
rsp.addHeader("Cache-Control", "no-cache, no-store, must-revalidate");
rsp.addHeader("Pragma", "no-cache");
rsp.addHeader("Expires", "0");
- getOwner().checkPermission(Item.CREATE);
Categories categories = new Categories();
int order = 0;
JellyContext ctx;
@@ -1155,7 +1150,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
}
/**
- * Accepts <tt>config.xml</tt> submission, as well as serve it.
+ * Accepts {@code config.xml} submission, as well as serve it.
*/
@WebMethod(name = "config.xml")
public HttpResponse doConfigDotXml(StaplerRequest req) throws IOException {
@@ -1214,7 +1209,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
// view in same ViewGroup and might not satisfy Jenkins.checkGoodName.
String oldname = name;
ViewGroup oldOwner = owner; // oddly, this field is not transient
- Object o = Jenkins.XSTREAM2.unmarshal(new Xpp3Driver().createReader(in), this, null, true);
+ Object o = Jenkins.XSTREAM2.unmarshal(XStream2.getDefaultDriver().createReader(in), this, null, true);
if (!o.getClass().equals(getClass())) {
// ensure that we've got the same view type. extending this code to support updating
// to different view type requires destroying & creating a new view type
@@ -1368,7 +1363,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
/**
* Instantiate View subtype from XML stream.
*
- * @param name Alternative name to use or <tt>null</tt> to keep the one in xml.
+ * @param name Alternative name to use or {@code null} to keep the one in xml.
*/
public static View createViewFromXML(String name, InputStream xml) throws IOException {
diff --git a/core/src/main/java/hudson/model/ViewDescriptor.java b/core/src/main/java/hudson/model/ViewDescriptor.java
index a63484d69e1250aeb4ae2518e47b8e1a2e25b8b7..933ad74dcb68aeccb30cf329781e89ff185ba99e 100644
--- a/core/src/main/java/hudson/model/ViewDescriptor.java
+++ b/core/src/main/java/hudson/model/ViewDescriptor.java
@@ -88,7 +88,6 @@ public abstract class ViewDescriptor extends Descriptor<View> {
*/
@Restricted(DoNotUse.class)
public AutoCompletionCandidates doAutoCompleteCopyNewItemFrom(@QueryParameter final String value, @AncestorInPath ItemGroup<?> container) {
- // TODO do we need a permissions check here?
AutoCompletionCandidates candidates = AutoCompletionCandidates.ofJobNames(TopLevelItem.class, value, container);
if (container instanceof DirectlyModifiableTopLevelItemGroup) {
DirectlyModifiableTopLevelItemGroup modifiableContainer = (DirectlyModifiableTopLevelItemGroup) container;
diff --git a/core/src/main/java/hudson/model/WorkspaceCleanupThread.java b/core/src/main/java/hudson/model/WorkspaceCleanupThread.java
index 0a01a5f28fe5ca9cd329df55e244f87f76e2436e..8c55c2bc4d8b77b347d8ac3e012784b41f33bb34 100644
--- a/core/src/main/java/hudson/model/WorkspaceCleanupThread.java
+++ b/core/src/main/java/hudson/model/WorkspaceCleanupThread.java
@@ -139,6 +139,15 @@ public class WorkspaceCleanupThread extends AsyncPeriodicWork {
}
}
+ // TODO this may only check the last build in fact:
+ if (item instanceof Job<?,?>) {
+ Job<?,?> j = (Job<?,?>) item;
+ if (j.isBuilding()) {
+ LOGGER.log(Level.FINE, "Job {0} is building, so not deleting", item.getFullDisplayName());
+ return false;
+ }
+ }
+
LOGGER.log(Level.FINER, "Going to delete directory {0}", dir);
return true;
}
diff --git a/core/src/main/java/hudson/model/package.html b/core/src/main/java/hudson/model/package.html
index 640b328a391dfaf338c5b4e9ffd7dae8d679b5bb..73e34b62da6534d444ef2ca712f87b093383550b 100644
--- a/core/src/main/java/hudson/model/package.html
+++ b/core/src/main/java/hudson/model/package.html
@@ -23,5 +23,5 @@ THE SOFTWARE.
-->
<html><head/><body>
-Core object model that are bound to URLs via stapler, rooted at <a href="Hudson.html"><tt>Hudson</tt></a>.
+Core object model that are bound to URLs via stapler, rooted at <a href="Hudson.html"><code>Hudson</code></a>.
</body></html>
\ No newline at end of file
diff --git a/core/src/main/java/hudson/model/queue/CauseOfBlockage.java b/core/src/main/java/hudson/model/queue/CauseOfBlockage.java
index e5ba86359771f88092d1ed5982197bc48dad24d7..beb76b824a34b11729ea57fa3d71ab012d480b76 100644
--- a/core/src/main/java/hudson/model/queue/CauseOfBlockage.java
+++ b/core/src/main/java/hudson/model/queue/CauseOfBlockage.java
@@ -19,7 +19,7 @@ import org.jvnet.localizer.Localizable;
* has expanded beyond queues.
*
* <h2>View</h2>
- * <tt>summary.jelly</tt> should do one-line HTML rendering to be used showing the cause
+ * {@code summary.jelly} should do one-line HTML rendering to be used showing the cause
* to the user. By default it simply renders {@link #getShortDescription()} text.
*
* <p>
diff --git a/core/src/main/java/hudson/model/queue/Executables.java b/core/src/main/java/hudson/model/queue/Executables.java
index 2dbcca3f21bb04616dd79efc06229fabd6ad0590..426c12df96e5d3f2af55d15621b7a7c9b50eec9e 100644
--- a/core/src/main/java/hudson/model/queue/Executables.java
+++ b/core/src/main/java/hudson/model/queue/Executables.java
@@ -46,7 +46,7 @@ public class Executables {
throws Error, RuntimeException {
try {
return e.getParent();
- } catch (AbstractMethodError _) {
+ } catch (AbstractMethodError ignored) { // will fallback to a private implementation
try {
Method m = e.getClass().getMethod("getParent");
m.setAccessible(true);
diff --git a/core/src/main/java/hudson/model/queue/MappingWorksheet.java b/core/src/main/java/hudson/model/queue/MappingWorksheet.java
index a8cdad8ef9e01847b5fc25db291877e84bdcc3bc..561c950e4aa3e17dcbe13aa65c928887b8238ca6 100644
--- a/core/src/main/java/hudson/model/queue/MappingWorksheet.java
+++ b/core/src/main/java/hudson/model/queue/MappingWorksheet.java
@@ -134,7 +134,7 @@ public class MappingWorksheet {
if (c.assignedLabel!=null && !c.assignedLabel.contains(node))
return false; // label mismatch
- if (!nodeAcl.hasPermission(item.authenticate(), Computer.BUILD))
+ if (!(Node.SKIP_BUILD_CHECK_ON_FLYWEIGHTS && item.task instanceof Queue.FlyweightTask) && !nodeAcl.hasPermission(item.authenticate(), Computer.BUILD))
return false; // tasks don't have a permission to run on this node
return true;
diff --git a/core/src/main/java/hudson/model/queue/WorkUnitContext.java b/core/src/main/java/hudson/model/queue/WorkUnitContext.java
index 80a402242d5112a6c0962647f70a76c3bffe7d4b..8afce5cbfd0f757816ef82966ad31354a612b68f 100644
--- a/core/src/main/java/hudson/model/queue/WorkUnitContext.java
+++ b/core/src/main/java/hudson/model/queue/WorkUnitContext.java
@@ -67,8 +67,8 @@ public final class WorkUnitContext {
this.item = item;
this.task = item.task;
this.future = (FutureImpl)item.getFuture();
- this.actions = new ArrayList<Action>(item.getAllActions());
-
+ // JENKINS-51584 do not use item.getAllActions() here.
+ this.actions = new ArrayList<Action>(item.getActions());
// +1 for the main task
int workUnitSize = task.getSubTasks().size();
startLatch = new Latch(workUnitSize) {
diff --git a/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java b/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java
index 8621f37cebe47cd29ba7bceb3aa8b313224aafe9..e35ae80a7e133c7ff6ca20b3d1344b979ced0735 100644
--- a/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java
+++ b/core/src/main/java/hudson/node_monitors/AbstractAsyncNodeMonitorDescriptor.java
@@ -6,10 +6,16 @@ import hudson.remoting.VirtualChannel;
import jenkins.model.Jenkins;
import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
+import java.util.Set;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeoutException;
@@ -60,10 +66,22 @@ public abstract class AbstractAsyncNodeMonitorDescriptor<T> extends AbstractNode
/**
* Performs all monitoring concurrently.
+ *
+ * @return Mapping from computer to monitored value. The map values can be null for several reasons, see {@link Result}
+ * for more details.
*/
@Override
protected Map<Computer, T> monitor() throws InterruptedException {
+ // Bridge method to offer original constrained interface.
+ return monitorDetailed().getMonitoringData();
+ }
+
+ /**
+ * Perform monitoring with detailed reporting.
+ */
+ protected final @Nonnull Result<T> monitorDetailed() throws InterruptedException {
Map<Computer,Future<T>> futures = new HashMap<Computer,Future<T>>();
+ Set<Computer> skipped = new HashSet<>();
for (Computer c : Jenkins.getInstance().getComputers()) {
try {
@@ -101,11 +119,53 @@ public abstract class AbstractAsyncNodeMonitorDescriptor<T> extends AbstractNode
} catch (TimeoutException x) {
LOGGER.log(WARNING, "Failed to monitor " + c.getDisplayName() + " for " + getDisplayName(), x);
}
+ } else {
+ skipped.add(c);
}
}
- return data;
+ return new Result<>(data, skipped);
}
private static final Logger LOGGER = Logger.getLogger(AbstractAsyncNodeMonitorDescriptor.class.getName());
+
+ /**
+ * Result object for {@link AbstractAsyncNodeMonitorDescriptor#monitorDetailed()} to facilitate extending information
+ * returned in the future.
+ *
+ * The {@link #getMonitoringData()} provides the results of the monitoring as {@link #monitor()} does. Note the value
+ * in the map can be {@code null} for several reasons:
+ * <ul>
+ * <li>The monitoring {@link Callable} returned {@code null} as a provisioning result.</li>
+ * <li>Creating or evaluating that callable has thrown an exception.</li>
+ * <li>The computer was not monitored as it was offline.</li>
+ * <li>The {@link AbstractAsyncNodeMonitorDescriptor#createCallable} has returned null.</li>
+ * </ul>
+ *
+ * Clients can distinguishing among these states based on the additional data attached to this object. {@link #getSkipped()}
+ * returns computers that was not monitored as they ware either offline or monitor produced {@code null} {@link Callable}.
+ */
+ protected static final class Result<T> {
+ private static final long serialVersionUID = -7671448355804481216L;
+
+ private final @Nonnull Map<Computer, T> data;
+ private final @Nonnull ArrayList<Computer> skipped;
+
+ private Result(@Nonnull Map<Computer, T> data, @Nonnull Collection<Computer> skipped) {
+ this.data = new HashMap<>(data);
+ this.skipped = new ArrayList<>(skipped);
+ }
+
+ protected @Nonnull Map<Computer, T> getMonitoringData() {
+ return data;
+ }
+
+ /**
+ * Computers that ware skipped during monitoring as they either do not have a a channel (offline) or the monitor
+ * have not produced the Callable. Computers that caused monitor to throw exception are not returned here.
+ */
+ protected @Nonnull List<Computer> getSkipped() {
+ return skipped;
+ }
+ }
}
diff --git a/core/src/main/java/hudson/node_monitors/NodeMonitor.java b/core/src/main/java/hudson/node_monitors/NodeMonitor.java
index 17ddf7343ef29036b32c6eef2ebf26dcb07f59af..665b9cafe6dcec2219880eedc7c15954963472ec 100644
--- a/core/src/main/java/hudson/node_monitors/NodeMonitor.java
+++ b/core/src/main/java/hudson/node_monitors/NodeMonitor.java
@@ -48,7 +48,7 @@ import org.kohsuke.stapler.export.ExportedBean;
* <dl>
* <dt>column.jelly</dt>
* <dd>
- * Invoked from {@link ComputerSet} <tt>index.jelly</tt> to render a column.
+ * Invoked from {@link ComputerSet} {@code index.jelly} to render a column.
* The {@link NodeMonitor} instance is accessible through the "from" variable.
* Also see {@link #getColumnCaption()}.
*
diff --git a/core/src/main/java/hudson/node_monitors/ResponseTimeMonitor.java b/core/src/main/java/hudson/node_monitors/ResponseTimeMonitor.java
index d7241e9eff619d13af4c0746e8830854f5b83b4c..9f77f9bb779e3ed08e0ddc750364fa4a2d5bc817 100644
--- a/core/src/main/java/hudson/node_monitors/ResponseTimeMonitor.java
+++ b/core/src/main/java/hudson/node_monitors/ResponseTimeMonitor.java
@@ -46,20 +46,24 @@ import org.kohsuke.stapler.export.ExportedBean;
public class ResponseTimeMonitor extends NodeMonitor {
@Extension
public static final AbstractNodeMonitorDescriptor<Data> DESCRIPTOR = new AbstractAsyncNodeMonitorDescriptor<Data>() {
+
@Override
protected Callable<Data,IOException> createCallable(Computer c) {
- if (c.getChannel() == null) {
- return null;
- }
return new Step1(get(c));
}
@Override
protected Map<Computer, Data> monitor() throws InterruptedException {
- Map<Computer, Data> base = super.monitor();
- for (Entry<Computer, Data> e : base.entrySet()) {
+ Result<Data> base = monitorDetailed();
+ Map<Computer, Data> monitoringData = base.getMonitoringData();
+ for (Entry<Computer, Data> e : monitoringData.entrySet()) {
Computer c = e.getKey();
Data d = e.getValue();
+ if (base.getSkipped().contains(c)) {
+ assert d == null;
+ continue;
+ }
+
if (d ==null) {
// if we failed to monitor, put in the special value that indicates a failure
e.setValue(d=new Data(get(c),-1L));
@@ -74,7 +78,7 @@ public class ResponseTimeMonitor extends NodeMonitor {
LOGGER.warning(Messages.ResponseTimeMonitor_MarkedOffline(c.getName()));
}
}
- return base;
+ return monitoringData;
}
public String getDisplayName() {
diff --git a/core/src/main/java/hudson/os/solaris/ZFSInstaller.java b/core/src/main/java/hudson/os/solaris/ZFSInstaller.java
index a5709e8976ad1b39b17cec622aaee0798f89190b..f22a0b7879d1f6441cf6afef0bc944a75d9b8308 100644
--- a/core/src/main/java/hudson/os/solaris/ZFSInstaller.java
+++ b/core/src/main/java/hudson/os/solaris/ZFSInstaller.java
@@ -169,9 +169,23 @@ public class ZFSInstaller extends AdministrativeMonitor implements Serializable
// this is the actual creation of the file system.
// return true indicating a success
- return SU.execute(listener, rootUsername, rootPassword, new MasterToSlaveCallable<String,IOException>() {
+ return SU.execute(listener, rootUsername, rootPassword, new Create(listener, home, uid, gid, userName));
+ }
+ private static class Create extends MasterToSlaveCallable<String, IOException> {
+ private final TaskListener listener;
+ private final File home;
+ private final int uid;
+ private final int gid;
+ private final String userName;
+ Create(TaskListener listener, File home, int uid, int gid, String userName) {
+ this.listener = listener;
+ this.home = home;
+ this.uid = uid;
+ this.gid = gid;
+ this.userName = userName;
+ }
private static final long serialVersionUID = 7731167233498214301L;
-
+ @Override
public String call() throws IOException {
PrintStream out = listener.getLogger();
@@ -205,14 +219,13 @@ public class ZFSInstaller extends AdministrativeMonitor implements Serializable
// revert the file system creation
try {
hudson.destory();
- } catch (Exception _) {
+ } catch (Exception ignored) {
// but ignore the error and let the original error thrown
}
throw e;
}
return hudson.getName();
}
- });
}
/**
diff --git a/core/src/main/java/hudson/os/solaris/ZFSProvisioner.java b/core/src/main/java/hudson/os/solaris/ZFSProvisioner.java
index 229b5affb54e7cb9404a0f0c246381e349a0c78d..aeb46745118cd5155753cb218e27ac9bf5d8e09d 100644
--- a/core/src/main/java/hudson/os/solaris/ZFSProvisioner.java
+++ b/core/src/main/java/hudson/os/solaris/ZFSProvisioner.java
@@ -53,9 +53,11 @@ public class ZFSProvisioner extends FileSystemProvisioner implements Serializabl
private final String rootDataset;
public ZFSProvisioner(Node node) throws IOException, InterruptedException {
- rootDataset = node.getRootPath().act(new MasterToSlaveFileCallable<String>() {
+ rootDataset = node.getRootPath().act(new GetName());
+ }
+ private static class GetName extends MasterToSlaveFileCallable<String> {
private static final long serialVersionUID = -2142349338699797436L;
-
+ @Override
public String invoke(File f, VirtualChannel channel) throws IOException {
ZFSFileSystem fs = libzfs.getFileSystemByMountPoint(f);
if(fs!=null) return fs.getName();
@@ -63,15 +65,22 @@ public class ZFSProvisioner extends FileSystemProvisioner implements Serializabl
// TODO: for now, only support agents that are already on ZFS.
throw new IOException("Not on ZFS");
}
- });
}
public void prepareWorkspace(AbstractBuild<?,?> build, FilePath ws, final TaskListener listener) throws IOException, InterruptedException {
final String name = build.getProject().getFullName();
- ws.act(new MasterToSlaveFileCallable<Void>() {
+ ws.act(new PrepareWorkspace(name, listener));
+ }
+ private class PrepareWorkspace extends MasterToSlaveFileCallable<Void> {
+ private final String name;
+ private final TaskListener listener;
+ PrepareWorkspace(String name, TaskListener listener) {
+ this.name = name;
+ this.listener = listener;
+ }
private static final long serialVersionUID = 2129531727963121198L;
-
+ @Override
public Void invoke(File f, VirtualChannel channel) throws IOException {
ZFSFileSystem fs = libzfs.getFileSystemByMountPoint(f);
if(fs!=null) return null; // already on ZFS
@@ -84,20 +93,20 @@ public class ZFSProvisioner extends FileSystemProvisioner implements Serializabl
fs.mount();
return null;
}
- });
}
public void discardWorkspace(AbstractProject<?, ?> project, FilePath ws) throws IOException, InterruptedException {
- ws.act(new MasterToSlaveFileCallable<Void>() {
+ ws.act(new DiscardWorkspace());
+ }
+ private static class DiscardWorkspace extends MasterToSlaveFileCallable<Void> {
private static final long serialVersionUID = 1916618107019257530L;
-
+ @Override
public Void invoke(File f, VirtualChannel channel) throws IOException {
ZFSFileSystem fs = libzfs.getFileSystemByMountPoint(f);
if(fs!=null)
fs.destory(true);
return null;
}
- });
}
/**
diff --git a/core/src/main/java/hudson/scheduler/CronTab.java b/core/src/main/java/hudson/scheduler/CronTab.java
index 14c67b90343201741e8ccbfb726191123119f618..120b8bc2a16bda6ef51a40fa0fec9ab96678d98e 100644
--- a/core/src/main/java/hudson/scheduler/CronTab.java
+++ b/core/src/main/java/hudson/scheduler/CronTab.java
@@ -204,7 +204,7 @@ public final class CronTab {
}
void setTo(Calendar c, int i) {
- c.set(field,i-offset);
+ c.set(field,Math.min(i-offset, c.getActualMaximum(field)));
}
void clear(Calendar c) {
diff --git a/core/src/main/java/hudson/scheduler/RareOrImpossibleDateException.java b/core/src/main/java/hudson/scheduler/RareOrImpossibleDateException.java
index 7f2cf4e2cfec564549778cd80596da37f7d9df57..bd4d4831b7202a9b3be5da057adb250a6fa911e2 100644
--- a/core/src/main/java/hudson/scheduler/RareOrImpossibleDateException.java
+++ b/core/src/main/java/hudson/scheduler/RareOrImpossibleDateException.java
@@ -35,7 +35,7 @@ import java.util.Calendar;
* <p>This can typically have a few different reasons:</p>
*
* <ul>
- * <li>The date is impossible. For example, June 31 does never happen, so <tt>0 0 31 6 *</tt> will never happen</li>
+ * <li>The date is impossible. For example, June 31 does never happen, so {@code 0 0 31 6 *} will never happen</li>
* <li>The date happens only rarely
* <ul>
* <li>February 29 being the obvious one</li>
diff --git a/core/src/main/java/hudson/scm/AbstractScmTagAction.java b/core/src/main/java/hudson/scm/AbstractScmTagAction.java
index c098427ac6de87bf52cdef32b23ab18010a6e8fe..a86ba18382ec498bab920ff0b1256dd13346fed3 100644
--- a/core/src/main/java/hudson/scm/AbstractScmTagAction.java
+++ b/core/src/main/java/hudson/scm/AbstractScmTagAction.java
@@ -37,11 +37,11 @@ import java.io.IOException;
import jenkins.model.RunAction2;
/**
- * Common part of <tt>CVSSCM.TagAction</tt> and <tt>SubversionTagAction</tt>.
+ * Common part of {@code CVSSCM.TagAction} and {@code SubversionTagAction}.
*
* <p>
* This class implements the action that tags the modules. Derived classes
- * need to provide <tt>tagForm.jelly</tt> view that displays a form for
+ * need to provide {@code tagForm.jelly} view that displays a form for
* letting user start tagging.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/scm/NullChangeLogParser.java b/core/src/main/java/hudson/scm/NullChangeLogParser.java
index 19f6aeceb781190449f46915c95147fdb1330672..d78a03cce3e66ea80fd3c79b0b7c320d5bbb4779 100644
--- a/core/src/main/java/hudson/scm/NullChangeLogParser.java
+++ b/core/src/main/java/hudson/scm/NullChangeLogParser.java
@@ -41,7 +41,7 @@ public class NullChangeLogParser extends ChangeLogParser {
return ChangeLogSet.createEmpty(build);
}
- public Object readResolve() {
+ protected Object readResolve() {
return INSTANCE;
}
}
diff --git a/core/src/main/java/hudson/scm/SCM.java b/core/src/main/java/hudson/scm/SCM.java
index c33810a7f8f41964110983f4cfcbcc4b2f230e90..b49f3f10fbcd6a11aa35d1d2bee223a6a914e1e8 100644
--- a/core/src/main/java/hudson/scm/SCM.java
+++ b/core/src/main/java/hudson/scm/SCM.java
@@ -54,6 +54,8 @@ import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
+import java.util.logging.Level;
+import java.util.logging.Logger;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
@@ -86,6 +88,8 @@ import org.kohsuke.stapler.export.ExportedBean;
@ExportedBean
public abstract class SCM implements Describable<SCM>, ExtensionPoint {
+ private static final Logger LOGGER = Logger.getLogger(SCM.class.getName());
+
/** JENKINS-35098: discouraged */
@SuppressWarnings("FieldMayBeFinal")
private static boolean useAutoBrowserHolder = SystemProperties.getBoolean(SCM.class.getName() + ".useAutoBrowserHolder");
@@ -143,7 +147,12 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint {
}
return autoBrowserHolder.get();
} else {
- return guessBrowser();
+ try {
+ return guessBrowser();
+ } catch (RuntimeException x) {
+ LOGGER.log(Level.WARNING, null, x);
+ return null;
+ }
}
}
@@ -563,7 +572,7 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint {
* <p>
* Many builders, like Ant or Maven, works off the specific user file
* at the top of the checked out module (in the above case, that would
- * be <tt>xyz/build.xml</tt>), yet the builder doesn't know the "xyz"
+ * be {@code xyz/build.xml}), yet the builder doesn't know the "xyz"
* part; that comes from SCM.
*
* <p>
@@ -669,7 +678,7 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint {
}
/**
- * The returned object will be used to parse <tt>changelog.xml</tt>.
+ * The returned object will be used to parse {@code changelog.xml}.
*/
public abstract ChangeLogParser createChangeLogParser();
diff --git a/core/src/main/java/hudson/scm/package.html b/core/src/main/java/hudson/scm/package.html
index 610f57991d9931e3ee1ea5e658fafa90b5d076ca..d2a0046c665ff9e2217f5ec12e5023989df06616 100644
--- a/core/src/main/java/hudson/scm/package.html
+++ b/core/src/main/java/hudson/scm/package.html
@@ -23,5 +23,5 @@ THE SOFTWARE.
-->
<html><head/><body>
-Hudson's interface with source code management systems. Start with <a href="SCM.html"><tt>SCM</tt></a>
+Hudson's interface with source code management systems. Start with <a href="SCM.html"><code>SCM</code></a>
</body></html>
\ No newline at end of file
diff --git a/core/src/main/java/hudson/search/FixedSet.java b/core/src/main/java/hudson/search/FixedSet.java
index f9ab1ade2990e273beac460e43ca4a8088b1d37d..eca310184329baf7a1925f447596501f7d89d2e2 100644
--- a/core/src/main/java/hudson/search/FixedSet.java
+++ b/core/src/main/java/hudson/search/FixedSet.java
@@ -50,7 +50,7 @@ public class FixedSet implements SearchIndex {
boolean caseInsensitive = UserSearchProperty.isCaseInsensitive();
for (SearchItem i : items) {
String name = i.getSearchName();
- if (name.equals(token) || (caseInsensitive && name.equalsIgnoreCase(token))) {
+ if (name != null && (name.equals(token) || (caseInsensitive && name.equalsIgnoreCase(token)))) {
result.add(i);
}
}
@@ -60,7 +60,7 @@ public class FixedSet implements SearchIndex {
boolean caseInsensitive = UserSearchProperty.isCaseInsensitive();
for (SearchItem i : items) {
String name = i.getSearchName();
- if (name.contains(token) || (caseInsensitive && StringUtils.containsIgnoreCase(name, token))) {
+ if (name != null && (name.contains(token) || (caseInsensitive && StringUtils.containsIgnoreCase(name, token)))) {
result.add(i);
}
}
diff --git a/core/src/main/java/hudson/search/Search.java b/core/src/main/java/hudson/search/Search.java
index 627d77fafba4c570c86c12bac722b895764a3822..6b07b99a5d615933f7a3a3a9c44010463c1edd8f 100644
--- a/core/src/main/java/hudson/search/Search.java
+++ b/core/src/main/java/hudson/search/Search.java
@@ -42,10 +42,13 @@ import java.util.logging.Logger;
import javax.servlet.ServletException;
+import jenkins.util.MemoryReductionUtil;
+import jenkins.model.Jenkins;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.Ancestor;
import org.kohsuke.stapler.QueryParameter;
+import org.kohsuke.stapler.StaplerProxy;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.export.DataWriter;
@@ -63,7 +66,7 @@ import org.kohsuke.stapler.export.Flavor;
* @author Kohsuke Kawaguchi
* @see SearchableModelObject
*/
-public class Search {
+public class Search implements StaplerProxy {
@Restricted(NoExternalUse.class) // used from stapler views only
public static String encodeQuery(String query) throws UnsupportedEncodingException {
return URLEncoder.encode(query, "UTF-8");
@@ -140,7 +143,7 @@ public class Search {
public SearchResult getSuggestions(StaplerRequest req, String query) {
Set<String> paths = new HashSet<String>(); // paths already added, to control duplicates
SearchResultImpl r = new SearchResultImpl();
- int max = req.hasParameter("max") ? Integer.parseInt(req.getParameter("max")) : 20;
+ int max = req.hasParameter("max") ? Integer.parseInt(req.getParameter("max")) : 100;
SearchableModelObject smo = findClosestSearchableModelObject(req);
for (SuggestedItem i : suggest(makeSuggestIndex(req), query, smo)) {
if(r.size()>=max) {
@@ -323,16 +326,14 @@ public class Search {
static final class TokenList {
private final String[] tokens;
- private final static String[] EMPTY = new String[0];
-
public TokenList(String tokenList) {
- tokens = tokenList!=null ? tokenList.split("(?<=\\s)(?=\\S)") : EMPTY;
+ tokens = tokenList!=null ? tokenList.split("(?<=\\s)(?=\\S)") : MemoryReductionUtil.EMPTY_STRING_ARRAY;
}
public int length() { return tokens.length; }
/**
- * Returns {@link List} such that its <tt>get(end)</tt>
+ * Returns {@link List} such that its {@code get(end)}
* returns the concatenation of [token_start,...,token_end]
* (both end inclusive.)
*/
@@ -406,6 +407,21 @@ public class Search {
return paths[tokens.length()];
}
-
+
+ @Override
+ @Restricted(NoExternalUse.class)
+ public Object getTarget() {
+ if (!SKIP_PERMISSION_CHECK) {
+ Jenkins.getInstance().checkPermission(Jenkins.READ);
+ }
+ return this;
+ }
+
+ /**
+ * Escape hatch for StaplerProxy-based access control
+ */
+ @Restricted(NoExternalUse.class)
+ public static /* Script Console modifiable */ boolean SKIP_PERMISSION_CHECK = Boolean.getBoolean(Search.class.getName() + ".skipPermissionCheck");
+
private final static Logger LOGGER = Logger.getLogger(Search.class.getName());
}
diff --git a/core/src/main/java/hudson/security/ACL.java b/core/src/main/java/hudson/security/ACL.java
index 41f8b5a9bc82430162647394e55b6d21b9ba2539..1f39620c66ebcc353f4f32772cba9cbfa5063744 100644
--- a/core/src/main/java/hudson/security/ACL.java
+++ b/core/src/main/java/hudson/security/ACL.java
@@ -34,6 +34,7 @@ import hudson.model.Item;
import hudson.remoting.Callable;
import hudson.model.ItemGroup;
import hudson.model.TopLevelItemDescriptor;
+import java.util.function.BiFunction;
import jenkins.security.NonSerializableSecurityContext;
import jenkins.model.Jenkins;
import jenkins.security.NotReallyRoleSensitiveCallable;
@@ -95,6 +96,21 @@ public abstract class ACL {
*/
public abstract boolean hasPermission(@Nonnull Authentication a, @Nonnull Permission permission);
+ /**
+ * Creates a simple {@link ACL} implementation based on a “single-abstract-method” easily implemented via lambda syntax.
+ * @param impl the implementation of {@link ACL#hasPermission(Authentication, Permission)}
+ * @return an adapter to that lambda
+ * @since 2.105
+ */
+ public static ACL lambda(final BiFunction<Authentication, Permission, Boolean> impl) {
+ return new ACL() {
+ @Override
+ public boolean hasPermission(Authentication a, Permission permission) {
+ return impl.apply(a, permission);
+ }
+ };
+ }
+
/**
* Checks if the current security principal has the permission to create top level items within the specified
* item group.
diff --git a/core/src/main/resources/jenkins/security/ApiTokenProperty/config.groovy b/core/src/main/java/hudson/security/AccountCreationFailedException.java
similarity index 69%
rename from core/src/main/resources/jenkins/security/ApiTokenProperty/config.groovy
rename to core/src/main/java/hudson/security/AccountCreationFailedException.java
index 76ab6b5eb5d029557190897fcaca604c62a11cbd..bab5345db1647133d7604a1b48ca0863d74437a0 100644
--- a/core/src/main/resources/jenkins/security/ApiTokenProperty/config.groovy
+++ b/core/src/main/java/hudson/security/AccountCreationFailedException.java
@@ -1,7 +1,7 @@
/*
* The MIT License
*
- * Copyright (c) 2011, CloudBees, Inc.
+ * Copyright (c) 2017 Jenkins contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@@ -21,16 +21,20 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
-package jenkins.security.ApiTokenProperty;
-f=namespace(lib.FormTagLib)
+package hudson.security;
-f.advanced(title:_("Show API Token"), align:"left") {
- f.entry(title: _('User ID')) {
- f.readOnlyTextbox(value: my.id)
- }
- f.entry(title:_("API Token"), field:"apiToken") {
- f.readOnlyTextbox(id:"apiToken") // TODO: need to figure out the way to do this without using ID.
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+
+/**
+ * Thrown if an account creation was attempted but failed due to invalid data being entered into a form.
+ *
+ * @author Philipp Nowak
+ */
+@Restricted(NoExternalUse.class)
+public class AccountCreationFailedException extends Exception {
+ public AccountCreationFailedException(String message) {
+ super(message);
}
- f.validateButton(title:_("Change API Token"),method:"changeToken")
}
diff --git a/core/src/main/java/hudson/security/AuthenticationProcessingFilter2.java b/core/src/main/java/hudson/security/AuthenticationProcessingFilter2.java
index bda002cf106fd51e1c09345ae1b3f160759e3466..1199e303ef9d54d41f9a98413880d855187e0d09 100644
--- a/core/src/main/java/hudson/security/AuthenticationProcessingFilter2.java
+++ b/core/src/main/java/hudson/security/AuthenticationProcessingFilter2.java
@@ -39,7 +39,7 @@ import org.acegisecurity.ui.webapp.AuthenticationProcessingFilter;
/**
* {@link AuthenticationProcessingFilter} with a change for Jenkins so that
- * we can pick up the hidden "from" form field defined in <tt>login.jelly</tt>
+ * we can pick up the hidden "from" form field defined in {@code login.jelly}
* to send the user back to where he came from, after a successful authentication.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/security/AuthorizationStrategy.java b/core/src/main/java/hudson/security/AuthorizationStrategy.java
index a875908f212d7ec472f589dad9a27f93090e9260..a273e984b201c96d3c33c86666bb04ac297354e1 100644
--- a/core/src/main/java/hudson/security/AuthorizationStrategy.java
+++ b/core/src/main/java/hudson/security/AuthorizationStrategy.java
@@ -95,9 +95,7 @@ public abstract class AuthorizationStrategy extends AbstractDescribableImpl<Auth
* @since 1.220
*/
public @Nonnull ACL getACL(final @Nonnull View item) {
- return new ACL() {
- @Override
- public boolean hasPermission(Authentication a, Permission permission) {
+ return ACL.lambda((a, permission) -> {
ACL base = item.getOwner().getACL();
boolean hasPermission = base.hasPermission(a, permission);
@@ -106,8 +104,7 @@ public abstract class AuthorizationStrategy extends AbstractDescribableImpl<Auth
}
return hasPermission;
- }
- };
+ });
}
/**
@@ -225,12 +222,7 @@ public abstract class AuthorizationStrategy extends AbstractDescribableImpl<Auth
return Collections.emptySet();
}
- private static final ACL UNSECURED_ACL = new ACL() {
- @Override
- public boolean hasPermission(Authentication a, Permission permission) {
- return true;
- }
- };
+ private static final ACL UNSECURED_ACL = ACL.lambda((a, p) -> true);
@Extension @Symbol("unsecured")
public static final class DescriptorImpl extends Descriptor<AuthorizationStrategy> {
diff --git a/core/src/main/java/hudson/security/BasicAuthenticationFilter.java b/core/src/main/java/hudson/security/BasicAuthenticationFilter.java
index 1ec0be214f8532bbb2865d0c90e315ec9c84c2c9..737108560bf007e6140edf977e430c431bd1ddfe 100644
--- a/core/src/main/java/hudson/security/BasicAuthenticationFilter.java
+++ b/core/src/main/java/hudson/security/BasicAuthenticationFilter.java
@@ -29,6 +29,7 @@ import hudson.util.Scrambler;
import jenkins.security.ApiTokenProperty;
import jenkins.security.SecurityListener;
import org.acegisecurity.Authentication;
+import jenkins.security.BasicApiTokenHelper;
import org.acegisecurity.context.SecurityContextHolder;
import org.acegisecurity.userdetails.UserDetails;
@@ -57,14 +58,14 @@ import java.net.URLEncoder;
*
* <p>
* When an HTTP request arrives with an HTTP basic auth header, this filter detects
- * that and emulate an invocation of <tt>/j_security_check</tt>
+ * that and emulate an invocation of {@code /j_security_check}
* (see <a href="http://mail-archives.apache.org/mod_mbox/tomcat-users/200105.mbox/%3C9005C0C9C85BD31181B20060085DAC8B10C8EF@tuvi.andmevara.ee%3E">this page</a> for the original technique.)
*
* <p>
* This causes the container to perform authentication, but there's no way
* to find out whether the user has been successfully authenticated or not.
* So to find this out, we then redirect the user to
- * {@link jenkins.model.Jenkins#doSecured(StaplerRequest, StaplerResponse) <tt>/secured/...</tt> page}.
+ * {@link jenkins.model.Jenkins#doSecured(StaplerRequest, StaplerResponse) {@code /secured/...} page}.
*
* <p>
* The handler of the above URL checks if the user is authenticated,
@@ -78,7 +79,7 @@ import java.net.URLEncoder;
* <h2>Notes</h2>
* <ul>
* <li>
- * The technique of getting a request dispatcher for <tt>/j_security_check</tt> may not
+ * The technique of getting a request dispatcher for {@code /j_security_check} may not
* work for all containers, but so far that seems like the only way to make this work.
* <li>
* This A → B → A redirect is a cyclic redirection, so we need to watch out for clients
@@ -135,12 +136,9 @@ public class BasicAuthenticationFilter implements Filter {
return;
}
- {// attempt to authenticate as API token
- // create is true as the user may not have been saved and the default api token may be in use.
- // validation of the user will be performed against the underlying realm in impersonate.
- User u = User.getById(username, true);
- ApiTokenProperty t = u.getProperty(ApiTokenProperty.class);
- if (t!=null && t.matchesPassword(password)) {
+ {
+ User u = BasicApiTokenHelper.isConnectingUsingApiToken(username, password);
+ if(u != null){
UserDetails userDetails = u.getUserDetailsForImpersonation();
Authentication auth = u.impersonate(userDetails);
diff --git a/core/src/main/java/hudson/security/HudsonPrivateSecurityRealm.java b/core/src/main/java/hudson/security/HudsonPrivateSecurityRealm.java
index 95ff998a2a4ffcc65d5089a0fa26d92c972905e3..83d31bd1e1c3fab546773cea9507eb7cfc96ceea 100644
--- a/core/src/main/java/hudson/security/HudsonPrivateSecurityRealm.java
+++ b/core/src/main/java/hudson/security/HudsonPrivateSecurityRealm.java
@@ -65,6 +65,7 @@ import org.kohsuke.stapler.interceptor.RequirePOST;
import org.mindrot.jbcrypt.BCrypt;
import org.springframework.dao.DataAccessException;
+import javax.annotation.Nonnull;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
@@ -73,15 +74,13 @@ import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpSession;
+
import static javax.servlet.http.HttpServletResponse.SC_UNAUTHORIZED;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.security.SecureRandom;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.MissingResourceException;
-import java.util.ResourceBundle;
+import java.util.*;
import java.util.logging.Logger;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
@@ -96,6 +95,15 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* @author Kohsuke Kawaguchi
*/
public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRealm implements ModelObject, AccessControlled {
+ private static /* not final */ String ID_REGEX = System.getProperty(HudsonPrivateSecurityRealm.class.getName() + ".ID_REGEX");
+
+ /**
+ * Default REGEX for the user ID check in case the ID_REGEX is not set
+ * It allows A-Za-z0-9 + "_-"
+ * in Java {@code \w} is equivalent to {@code [A-Za-z0-9_]} (take care of "_")
+ */
+ private static final String DEFAULT_ID_REGEX = "^[\\w-]+$";
+
/**
* If true, sign up is not allowed.
* <p>
@@ -254,6 +262,13 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
*/
@SuppressWarnings("ACL.impersonate")
private void loginAndTakeBack(StaplerRequest req, StaplerResponse rsp, User u) throws ServletException, IOException {
+ HttpSession session = req.getSession(false);
+ if (session != null) {
+ // avoid session fixation
+ session.invalidate();
+ }
+ req.getSession(true);
+
// ... and let him login
Authentication a = new UsernamePasswordAuthenticationToken(u.getId(),req.getParameter("password1"));
a = this.getSecurityComponents().manager.authenticate(a);
@@ -289,6 +304,35 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
return u;
}
+ /**
+ * Creates a user account. Intended to be called from the setup wizard.
+ * Note that this method does not check whether it is actually called from
+ * the setup wizard. This requires the {@link Jenkins#ADMINISTER} permission.
+ *
+ * @param req the request to retrieve input data from
+ * @return the created user account, never null
+ * @throws AccountCreationFailedException if account creation failed due to invalid form input
+ */
+ @Restricted(NoExternalUse.class)
+ public User createAccountFromSetupWizard(StaplerRequest req) throws IOException, AccountCreationFailedException {
+ checkPermission(Jenkins.ADMINISTER);
+ SignupInfo si = validateAccountCreationForm(req, false);
+ if (!si.errors.isEmpty()) {
+ String messages = getErrorMessages(si);
+ throw new AccountCreationFailedException(messages);
+ } else {
+ return createAccount(si);
+ }
+ }
+
+ private String getErrorMessages(SignupInfo si) {
+ StringBuilder messages = new StringBuilder();
+ for (String message : si.errors.values()) {
+ messages.append(message).append(" | ");
+ }
+ return messages.toString();
+ }
+
/**
* Creates a first admin user account.
*
@@ -321,65 +365,109 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
}
/**
+ * @param req the request to get the form data from (is also used for redirection)
+ * @param rsp the response to use for forwarding if the creation fails
+ * @param validateCaptcha whether to attempt to validate a captcha in the request
+ * @param formView the view to redirect to if creation fails
+ *
* @return
* null if failed. The browser is already redirected to retry by the time this method returns.
* a valid {@link User} object if the user creation was successful.
*/
- private User createAccount(StaplerRequest req, StaplerResponse rsp, boolean selfRegistration, String formView) throws ServletException, IOException {
+ private User createAccount(StaplerRequest req, StaplerResponse rsp, boolean validateCaptcha, String formView) throws ServletException, IOException {
+ SignupInfo si = validateAccountCreationForm(req, validateCaptcha);
+
+ if (!si.errors.isEmpty()) {
+ // failed. ask the user to try again.
+ req.getView(this, formView).forward(req, rsp);
+ return null;
+ }
+
+ return createAccount(si);
+ }
+
+ /**
+ * @param req the request to process
+ * @param validateCaptcha whether to attempt to validate a captcha in the request
+ *
+ * @return a {@link SignupInfo#SignupInfo(StaplerRequest) SignupInfo from given request}, with {@link
+ * SignupInfo#errors} set to a non-null value if any of the supported fields are invalid
+ */
+ private SignupInfo validateAccountCreationForm(StaplerRequest req, boolean validateCaptcha) {
// form field validation
// this pattern needs to be generalized and moved to stapler
SignupInfo si = new SignupInfo(req);
- if(selfRegistration && !validateCaptcha(si.captcha))
- si.errorMessage = Messages.HudsonPrivateSecurityRealm_CreateAccount_TextNotMatchWordInImage();
-
- if(si.password1 != null && !si.password1.equals(si.password2))
- si.errorMessage = Messages.HudsonPrivateSecurityRealm_CreateAccount_PasswordNotMatch();
-
- if(!(si.password1 != null && si.password1.length() != 0))
- si.errorMessage = Messages.HudsonPrivateSecurityRealm_CreateAccount_PasswordRequired();
+ if (validateCaptcha && !validateCaptcha(si.captcha)) {
+ si.errors.put("captcha", Messages.HudsonPrivateSecurityRealm_CreateAccount_TextNotMatchWordInImage());
+ }
- if(si.username==null || si.username.length()==0)
- si.errorMessage = Messages.HudsonPrivateSecurityRealm_CreateAccount_UserNameRequired();
- else {
+ if (si.username == null || si.username.length() == 0) {
+ si.errors.put("username", Messages.HudsonPrivateSecurityRealm_CreateAccount_UserNameRequired());
+ } else if(!containsOnlyAcceptableCharacters(si.username)) {
+ if (ID_REGEX == null) {
+ si.errors.put("username", Messages.HudsonPrivateSecurityRealm_CreateAccount_UserNameInvalidCharacters());
+ } else {
+ si.errors.put("username", Messages.HudsonPrivateSecurityRealm_CreateAccount_UserNameInvalidCharactersCustom(ID_REGEX));
+ }
+ } else {
// do not create the user - we just want to check if the user already exists but is not a "login" user.
- User user = User.getById(si.username, false);
+ User user = User.getById(si.username, false);
if (null != user)
// Allow sign up. SCM people has no such property.
if (user.getProperty(Details.class) != null)
- si.errorMessage = Messages.HudsonPrivateSecurityRealm_CreateAccount_UserNameAlreadyTaken();
+ si.errors.put("username", Messages.HudsonPrivateSecurityRealm_CreateAccount_UserNameAlreadyTaken());
}
- if(si.fullname==null || si.fullname.length()==0)
- si.fullname = si.username;
+ if (si.password1 != null && !si.password1.equals(si.password2)) {
+ si.errors.put("password1", Messages.HudsonPrivateSecurityRealm_CreateAccount_PasswordNotMatch());
+ }
- if(isMailerPluginPresent() && (si.email==null || !si.email.contains("@")))
- si.errorMessage = Messages.HudsonPrivateSecurityRealm_CreateAccount_InvalidEmailAddress();
+ if (!(si.password1 != null && si.password1.length() != 0)) {
+ si.errors.put("password1", Messages.HudsonPrivateSecurityRealm_CreateAccount_PasswordRequired());
+ }
- if (! User.isIdOrFullnameAllowed(si.username)) {
- si.errorMessage = hudson.model.Messages.User_IllegalUsername(si.username);
+ if (si.fullname == null || si.fullname.length() == 0) {
+ si.fullname = si.username;
}
- if (! User.isIdOrFullnameAllowed(si.fullname)) {
- si.errorMessage = hudson.model.Messages.User_IllegalFullname(si.fullname);
+ if (isMailerPluginPresent() && (si.email == null || !si.email.contains("@"))) {
+ si.errors.put("email", Messages.HudsonPrivateSecurityRealm_CreateAccount_InvalidEmailAddress());
}
- if(si.errorMessage!=null) {
- // failed. ask the user to try again.
- req.setAttribute("data",si);
- req.getView(this, formView).forward(req,rsp);
- return null;
+ if (!User.isIdOrFullnameAllowed(si.username)) {
+ si.errors.put("username", hudson.model.Messages.User_IllegalUsername(si.username));
+ }
+
+ if (!User.isIdOrFullnameAllowed(si.fullname)) {
+ si.errors.put("fullname", hudson.model.Messages.User_IllegalFullname(si.fullname));
}
+ req.setAttribute("data", si); // for error messages in the view
+ return si;
+ }
+ /**
+ * Creates a new account from a valid signup info. A signup info is valid if its {@link SignupInfo#errors}
+ * field is empty.
+ *
+ * @param si the valid signup info to create an account from
+ * @return a valid {@link User} object created from given signup info
+ * @throws IllegalArgumentException if an invalid signup info is passed
+ */
+ private User createAccount(SignupInfo si) throws IOException {
+ if (!si.errors.isEmpty()) {
+ String messages = getErrorMessages(si);
+ throw new IllegalArgumentException("invalid signup info passed to createAccount(si): " + messages);
+ }
// register the user
- User user = createAccount(si.username,si.password1);
+ User user = createAccount(si.username, si.password1);
user.setFullName(si.fullname);
- if(isMailerPluginPresent()) {
+ if (isMailerPluginPresent()) {
try {
// legacy hack. mail support has moved out to a separate plugin
Class<?> up = Jenkins.getInstance().pluginManager.uberClassLoader.loadClass("hudson.tasks.Mailer$UserProperty");
Constructor<?> c = up.getDeclaredConstructor(String.class);
- user.addProperty((UserProperty)c.newInstance(si.email));
+ user.addProperty((UserProperty) c.newInstance(si.email));
} catch (ReflectiveOperationException e) {
throw new RuntimeException(e);
}
@@ -387,7 +475,15 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
user.save();
return user;
}
-
+
+ private boolean containsOnlyAcceptableCharacters(@Nonnull String value){
+ if(ID_REGEX == null){
+ return value.matches(DEFAULT_ID_REGEX);
+ }else{
+ return value.matches(ID_REGEX);
+ }
+ }
+
@Restricted(NoExternalUse.class)
public boolean isMailerPluginPresent() {
try {
@@ -445,8 +541,9 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
* This is to map users under the security realm URL.
* This in turn helps us set up the right navigation breadcrumb.
*/
+ @Restricted(NoExternalUse.class)
public User getUser(String id) {
- return User.getById(id, true);
+ return User.getById(id, User.ALLOW_USER_CREATION_VIA_URL && hasPermission(Jenkins.ADMINISTER));
}
// TODO
@@ -460,6 +557,8 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
*/
public String errorMessage;
+ public HashMap<String, String> errors = new HashMap<String, String>();
+
public SignupInfo() {
}
@@ -641,7 +740,7 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
*
* <p>
* The salt is prepended to the hashed password and returned. So the encoded password is of the form
- * <tt>SALT ':' hash(PASSWORD,SALT)</tt>.
+ * {@code SALT ':' hash(PASSWORD,SALT)}.
*
* <p>
* This abbreviates the need to store the salt separately, which in turn allows us to hide the salt handling
@@ -650,11 +749,11 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
/*package*/ static final PasswordEncoder CLASSIC = new PasswordEncoder() {
private final PasswordEncoder passwordEncoder = new ShaPasswordEncoder(256);
- public String encodePassword(String rawPass, Object _) throws DataAccessException {
+ public String encodePassword(String rawPass, Object obj) throws DataAccessException {
return hash(rawPass);
}
- public boolean isPasswordValid(String encPass, String rawPass, Object _) throws DataAccessException {
+ public boolean isPasswordValid(String encPass, String rawPass, Object obj) throws DataAccessException {
// pull out the sale from the encoded password
int i = encPass.indexOf(':');
if(i<0) return false;
@@ -690,11 +789,11 @@ public class HudsonPrivateSecurityRealm extends AbstractPasswordBasedSecurityRea
* {@link PasswordEncoder} that uses jBCrypt.
*/
private static final PasswordEncoder JBCRYPT_ENCODER = new PasswordEncoder() {
- public String encodePassword(String rawPass, Object _) throws DataAccessException {
+ public String encodePassword(String rawPass, Object obj) throws DataAccessException {
return BCrypt.hashpw(rawPass,BCrypt.gensalt());
}
- public boolean isPasswordValid(String encPass, String rawPass, Object _) throws DataAccessException {
+ public boolean isPasswordValid(String encPass, String rawPass, Object obj) throws DataAccessException {
return BCrypt.checkpw(rawPass,encPass);
}
};
diff --git a/core/src/main/java/hudson/security/LegacySecurityRealm.java b/core/src/main/java/hudson/security/LegacySecurityRealm.java
index 116e50b2c9e237aaa3bc409ba060f978f01c14c8..8f4cc84e7a72e4bfee3ae06b79a08af1a84437a7 100644
--- a/core/src/main/java/hudson/security/LegacySecurityRealm.java
+++ b/core/src/main/java/hudson/security/LegacySecurityRealm.java
@@ -29,13 +29,12 @@ import org.acegisecurity.AuthenticationException;
import org.jenkinsci.Symbol;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.DataBoundConstructor;
import org.springframework.web.context.WebApplicationContext;
-import org.kohsuke.stapler.StaplerRequest;
import groovy.lang.Binding;
import hudson.model.Descriptor;
import hudson.util.spring.BeanBuilder;
import hudson.Extension;
-import net.sf.json.JSONObject;
import javax.servlet.Filter;
import javax.servlet.FilterConfig;
@@ -48,6 +47,10 @@ import javax.servlet.FilterConfig;
* @author Kohsuke Kawaguchi
*/
public final class LegacySecurityRealm extends SecurityRealm implements AuthenticationManager {
+ @DataBoundConstructor
+ public LegacySecurityRealm() {
+ }
+
public SecurityComponents createSecurityComponents() {
return new SecurityComponents(this);
}
@@ -104,10 +107,6 @@ public final class LegacySecurityRealm extends SecurityRealm implements Authenti
DESCRIPTOR = this;
}
- public SecurityRealm newInstance(StaplerRequest req, JSONObject formData) throws FormException {
- return new LegacySecurityRealm();
- }
-
public String getDisplayName() {
return Messages.LegacySecurityRealm_Displayname();
}
diff --git a/core/src/main/java/hudson/security/PermissionGroup.java b/core/src/main/java/hudson/security/PermissionGroup.java
index 13542cf4a884342883700f8e6d945c83fe95dac7..ef39787662f72a53e45c05882bece5ea4f42d032 100644
--- a/core/src/main/java/hudson/security/PermissionGroup.java
+++ b/core/src/main/java/hudson/security/PermissionGroup.java
@@ -27,6 +27,7 @@ import hudson.model.Hudson;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
+import java.util.Locale;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.annotation.CheckForNull;
@@ -51,6 +52,8 @@ public final class PermissionGroup implements Iterable<Permission>, Comparable<P
*/
public final Localizable title;
+ private final String id;
+
/**
* Both creates a registers a new permission group.
* @param owner sets {@link #owner}
@@ -58,12 +61,32 @@ public final class PermissionGroup implements Iterable<Permission>, Comparable<P
* @throws IllegalStateException if this group was already registered
*/
public PermissionGroup(@Nonnull Class owner, Localizable title) throws IllegalStateException {
+ this(title.toString(Locale.ENGLISH), owner, title);
+ }
+
+ /**
+ * Both creates a registers a new permission group.
+ * @param owner sets {@link #owner}
+ * @param title sets {@link #title}
+ * @throws IllegalStateException if this group was already registered
+ * @since 2.127
+ */
+ public PermissionGroup(String id, @Nonnull Class owner, Localizable title) throws IllegalStateException {
this.owner = owner;
this.title = title;
+ this.id = id;
register(this);
}
- private String id() {
+ /**
+ * Gets ID of the permission group.
+ * @return Non-localizable ID of the permission group.
+ */
+ public String getId() {
+ return id;
+ }
+
+ public String getOwnerClassName() {
return owner.getName();
}
@@ -110,7 +133,7 @@ public final class PermissionGroup implements Iterable<Permission>, Comparable<P
// among the permissions of the same group, just sort by their names
// so that the sort order is consistent regardless of classloading order.
- return id().compareTo(that.id());
+ return getOwnerClassName().compareTo(that.getOwnerClassName());
}
private int compareOrder() {
@@ -119,11 +142,11 @@ public final class PermissionGroup implements Iterable<Permission>, Comparable<P
}
@Override public boolean equals(Object o) {
- return o instanceof PermissionGroup && id().equals(((PermissionGroup) o).id());
+ return o instanceof PermissionGroup && getOwnerClassName().equals(((PermissionGroup) o).getOwnerClassName());
}
@Override public int hashCode() {
- return id().hashCode();
+ return getOwnerClassName().hashCode();
}
public synchronized int size() {
@@ -131,12 +154,12 @@ public final class PermissionGroup implements Iterable<Permission>, Comparable<P
}
@Override public String toString() {
- return "PermissionGroup[" + id() + "]";
+ return "PermissionGroup[" + getOwnerClassName() + "]";
}
private static synchronized void register(PermissionGroup g) {
if (!PERMISSIONS.add(g)) {
- throw new IllegalStateException("attempt to register a second PermissionGroup for " + g.id());
+ throw new IllegalStateException("attempt to register a second PermissionGroup for " + g.getOwnerClassName());
}
}
diff --git a/core/src/main/java/hudson/security/SecurityRealm.java b/core/src/main/java/hudson/security/SecurityRealm.java
index d2d637911a99aa0e63cc0beffbe655e3caba6616..90d60b7deb83ab1daacacfff9243bdc02be89654 100644
--- a/core/src/main/java/hudson/security/SecurityRealm.java
+++ b/core/src/main/java/hudson/security/SecurityRealm.java
@@ -75,7 +75,7 @@ import java.util.logging.Logger;
*
* <p>
* If additional views/URLs need to be exposed,
- * an active {@link SecurityRealm} is bound to <tt>CONTEXT_ROOT/securityRealm/</tt>
+ * an active {@link SecurityRealm} is bound to {@code CONTEXT_ROOT/securityRealm/}
* through {@link jenkins.model.Jenkins#getSecurityRealm()}, so you can define additional pages and
* operations on your {@link SecurityRealm}.
*
@@ -143,7 +143,7 @@ public abstract class SecurityRealm extends AbstractDescribableImpl<SecurityReal
* {@link AuthenticationManager} instantiation often depends on the user-specified parameters
* (for example, if the authentication is based on LDAP, the user needs to specify
* the host name of the LDAP server.) Such configuration is expected to be
- * presented to the user via <tt>config.jelly</tt> and then
+ * presented to the user via {@code config.jelly} and then
* captured as instance variables inside the {@link SecurityRealm} implementation.
*
* <p>
@@ -205,8 +205,8 @@ public abstract class SecurityRealm extends AbstractDescribableImpl<SecurityReal
*
* <p>
* {@link SecurityRealm} is a singleton resource in Hudson, and therefore
- * it's always configured through <tt>config.jelly</tt> and never with
- * <tt>global.jelly</tt>.
+ * it's always configured through {@code config.jelly} and never with
+ * {@code global.jelly}.
*/
@Override
public Descriptor<SecurityRealm> getDescriptor() {
@@ -225,7 +225,7 @@ public abstract class SecurityRealm extends AbstractDescribableImpl<SecurityReal
* Gets the target URL of the "login" link.
* There's no need to override this, except for {@link LegacySecurityRealm}.
* On legacy implementation this should point to {@code loginEntry}, which
- * is protected by <tt>web.xml</tt>, so that the user can be eventually authenticated
+ * is protected by {@code web.xml}, so that the user can be eventually authenticated
* by the container.
*
* <p>
@@ -304,6 +304,9 @@ public abstract class SecurityRealm extends AbstractDescribableImpl<SecurityReal
// reset remember-me cookie
Cookie cookie = new Cookie(ACEGI_SECURITY_HASHED_REMEMBER_ME_COOKIE_KEY,"");
+ cookie.setMaxAge(0);
+ cookie.setSecure(req.isSecure());
+ cookie.setHttpOnly(true);
cookie.setPath(req.getContextPath().length()>0 ? req.getContextPath() : "/");
rsp.addCookie(cookie);
@@ -312,12 +315,12 @@ public abstract class SecurityRealm extends AbstractDescribableImpl<SecurityReal
/**
* Returns true if this {@link SecurityRealm} allows online sign-up.
- * This creates a hyperlink that redirects users to <tt>CONTEXT_ROOT/signUp</tt>,
- * which will be served by the <tt>signup.jelly</tt> view of this class.
+ * This creates a hyperlink that redirects users to {@code CONTEXT_ROOT/signUp},
+ * which will be served by the {@code signup.jelly} view of this class.
*
* <p>
* If the implementation needs to redirect the user to a different URL
- * for signing up, use the following jelly script as <tt>signup.jelly</tt>
+ * for signing up, use the following jelly script as {@code signup.jelly}
*
* <pre>{@code <xmp>
* <st:redirect url="http://www.sun.com/" xmlns:st="jelly:stapler"/>
diff --git a/core/src/main/java/hudson/security/TokenBasedRememberMeServices2.java b/core/src/main/java/hudson/security/TokenBasedRememberMeServices2.java
index 9b81ae5b19126ef2c7c31641a880c06ecaf6d4bb..ff0f374ca4c897796f00853f3b0b1be49baffd58 100644
--- a/core/src/main/java/hudson/security/TokenBasedRememberMeServices2.java
+++ b/core/src/main/java/hudson/security/TokenBasedRememberMeServices2.java
@@ -123,19 +123,39 @@ public class TokenBasedRememberMeServices2 extends TokenBasedRememberMeServices
@Override
public Authentication autoLogin(HttpServletRequest request, HttpServletResponse response) {
- try {
- return super.autoLogin(request, response);
- } catch (Exception e) {
- cancelCookie(request, response, "Failed to handle remember-me cookie: "+Functions.printThrowable(e));
+ if(Jenkins.getInstance().isDisableRememberMe()){
+ cancelCookie(request, response, null);
return null;
+ }else {
+ try {
+ return super.autoLogin(request, response);
+ } catch (Exception e) {
+ cancelCookie(request, response, "Failed to handle remember-me cookie: " + Functions.printThrowable(e));
+ return null;
+ }
}
}
- @Override
- protected Cookie makeValidCookie(String tokenValueBase64, HttpServletRequest request, long maxAge) {
- Cookie cookie = super.makeValidCookie(tokenValueBase64, request, maxAge);
+ @Override
+ protected Cookie makeValidCookie(String tokenValueBase64, HttpServletRequest request, long maxAge) {
+ Cookie cookie = super.makeValidCookie(tokenValueBase64, request, maxAge);
+ secureCookie(cookie, request);
+ return cookie;
+ }
+
+ @Override
+ protected Cookie makeCancelCookie(HttpServletRequest request) {
+ Cookie cookie = super.makeCancelCookie(request);
+ secureCookie(cookie, request);
+ return cookie;
+ }
+
+ /**
+ * Force always the http-only flag and depending on the request, put also the secure flag.
+ */
+ private void secureCookie(Cookie cookie, HttpServletRequest request){
// if we can mark the cookie HTTP only, do so to protect this cookie even in case of XSS vulnerability.
- if (SET_HTTP_ONLY!=null) {
+ if (SET_HTTP_ONLY!=null) {
try {
SET_HTTP_ONLY.invoke(cookie,true);
} catch (IllegalAccessException e) {
@@ -148,12 +168,10 @@ public class TokenBasedRememberMeServices2 extends TokenBasedRememberMeServices
// if the user is running Jenkins over HTTPS, we also want to prevent the cookie from leaking in HTTP.
// whether the login is done over HTTPS or not would be a good enough approximation of whether Jenkins runs in
// HTTPS or not, so use that.
- if (request.isSecure())
- cookie.setSecure(true);
- return cookie;
- }
+ cookie.setSecure(request.isSecure());
+ }
- /**
+ /**
* Used to compute the token signature securely.
*/
private static final HMACConfidentialKey MAC = new HMACConfidentialKey(TokenBasedRememberMeServices.class,"mac");
diff --git a/core/src/main/java/hudson/security/WhoAmI.java b/core/src/main/java/hudson/security/WhoAmI.java
index 76faab1948af8148f6b48b3dad262a750b5cbdb3..66e837acd37ffe2fa5ab1f84de0837b15bbae2b4 100644
--- a/core/src/main/java/hudson/security/WhoAmI.java
+++ b/core/src/main/java/hudson/security/WhoAmI.java
@@ -8,6 +8,7 @@ import hudson.model.UnprotectedRootAction;
import java.util.ArrayList;
import java.util.List;
+import jenkins.util.MemoryReductionUtil;
import jenkins.model.Jenkins;
import org.acegisecurity.Authentication;
@@ -62,7 +63,7 @@ public class WhoAmI implements UnprotectedRootAction {
@Exported
public String[] getAuthorities() {
if (auth().getAuthorities() == null) {
- return new String[0];
+ return MemoryReductionUtil.EMPTY_STRING_ARRAY;
}
List <String> authorities = new ArrayList<String>();
for (GrantedAuthority a : auth().getAuthorities()) {
diff --git a/core/src/main/java/hudson/security/captcha/CaptchaSupport.java b/core/src/main/java/hudson/security/captcha/CaptchaSupport.java
index d5edf956637e3778998a3ec0e9c538c080ba6037..fb39e26e59b5754630036a29423f2cdf69a89fa7 100644
--- a/core/src/main/java/hudson/security/captcha/CaptchaSupport.java
+++ b/core/src/main/java/hudson/security/captcha/CaptchaSupport.java
@@ -38,7 +38,7 @@ import jenkins.model.Jenkins;
* Extension point for adding Captcha Support to User Registration Page {@link CaptchaSupport}.
*
* <p>
- * This object can have an optional <tt>config.jelly</tt> to configure the Captcha Support
+ * This object can have an optional {@code config.jelly} to configure the Captcha Support
* <p>
* A default constructor is needed to create CaptchaSupport in
* the default configuration.
diff --git a/core/src/main/java/hudson/security/csrf/DefaultCrumbIssuer.java b/core/src/main/java/hudson/security/csrf/DefaultCrumbIssuer.java
index 7f833c17f3263f7afa4e6ba255702cf049509f30..ae4a4edfab7272adabcf704ed252267e2ac08845 100644
--- a/core/src/main/java/hudson/security/csrf/DefaultCrumbIssuer.java
+++ b/core/src/main/java/hudson/security/csrf/DefaultCrumbIssuer.java
@@ -12,6 +12,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
import hudson.Extension;
+import hudson.model.PersistentDescriptor;
import jenkins.util.SystemProperties;
import hudson.Util;
import jenkins.model.Jenkins;
@@ -121,13 +122,12 @@ public class DefaultCrumbIssuer extends CrumbIssuer {
}
@Extension @Symbol("standard")
- public static final class DescriptorImpl extends CrumbIssuerDescriptor<DefaultCrumbIssuer> implements ModelObject {
+ public static final class DescriptorImpl extends CrumbIssuerDescriptor<DefaultCrumbIssuer> implements ModelObject, PersistentDescriptor {
private final static HexStringConfidentialKey CRUMB_SALT = new HexStringConfidentialKey(Jenkins.class,"crumbSalt",16);
public DescriptorImpl() {
super(CRUMB_SALT.get(), SystemProperties.getString("hudson.security.csrf.requestfield", CrumbIssuer.DEFAULT_CRUMB_NAME));
- load();
}
@Override
diff --git a/core/src/main/java/hudson/security/csrf/GlobalCrumbIssuerConfiguration.java b/core/src/main/java/hudson/security/csrf/GlobalCrumbIssuerConfiguration.java
index a93c70cc23630bfb4e219ff4b11c6005bab13614..914fba876d4187485068202f2add0a2d8321cfff 100644
--- a/core/src/main/java/hudson/security/csrf/GlobalCrumbIssuerConfiguration.java
+++ b/core/src/main/java/hudson/security/csrf/GlobalCrumbIssuerConfiguration.java
@@ -31,6 +31,8 @@ import net.sf.json.JSONObject;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.StaplerRequest;
+import javax.annotation.Nonnull;
+
/**
* Show the crumb configuration to the system config page.
*
@@ -39,14 +41,14 @@ import org.kohsuke.stapler.StaplerRequest;
@Extension(ordinal=195) @Symbol("crumb") // immediately after the security setting
public class GlobalCrumbIssuerConfiguration extends GlobalConfiguration {
@Override
- public GlobalConfigurationCategory getCategory() {
+ public @Nonnull GlobalConfigurationCategory getCategory() {
return GlobalConfigurationCategory.get(GlobalConfigurationCategory.Security.class);
}
@Override
public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
// for compatibility reasons, the actual value is stored in Jenkins
- Jenkins j = Jenkins.getInstance();
+ Jenkins j = Jenkins.get();
if (json.has("csrf")) {
JSONObject csrf = json.getJSONObject("csrf");
j.setCrumbIssuer(CrumbIssuer.all().newInstanceFromRadioList(csrf, "issuer"));
diff --git a/core/src/main/java/hudson/slaves/ChannelPinger.java b/core/src/main/java/hudson/slaves/ChannelPinger.java
index 85d6d78675354676898f921a541061012cdb2e33..eac834a76fa437933d8090fa1b460800f51df9e2 100644
--- a/core/src/main/java/hudson/slaves/ChannelPinger.java
+++ b/core/src/main/java/hudson/slaves/ChannelPinger.java
@@ -34,6 +34,8 @@ import hudson.remoting.Channel;
import hudson.remoting.PingThread;
import jenkins.security.MasterToSlaveCallable;
import jenkins.slaves.PingFailureAnalyzer;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
import javax.annotation.CheckForNull;
import java.io.IOException;
@@ -119,14 +121,15 @@ public class ChannelPinger extends ComputerListener {
}
@VisibleForTesting
- /*package*/ static class SetUpRemotePing extends MasterToSlaveCallable<Void, IOException> {
+ @Restricted(NoExternalUse.class)
+ public static class SetUpRemotePing extends MasterToSlaveCallable<Void, IOException> {
private static final long serialVersionUID = -2702219700841759872L;
@Deprecated
private transient int pingInterval;
private final int pingTimeoutSeconds;
private final int pingIntervalSeconds;
- SetUpRemotePing(int pingTimeoutSeconds, int pingIntervalSeconds) {
+ public SetUpRemotePing(int pingTimeoutSeconds, int pingIntervalSeconds) {
this.pingTimeoutSeconds = pingTimeoutSeconds;
this.pingIntervalSeconds = pingIntervalSeconds;
}
@@ -177,7 +180,8 @@ public class ChannelPinger extends ComputerListener {
}
@VisibleForTesting
- /*package*/ static void setUpPingForChannel(final Channel channel, final SlaveComputer computer, int timeoutSeconds, int intervalSeconds, final boolean analysis) {
+ @Restricted(NoExternalUse.class)
+ public static void setUpPingForChannel(final Channel channel, final SlaveComputer computer, int timeoutSeconds, int intervalSeconds, final boolean analysis) {
LOGGER.log(Level.FINE, "setting up ping on {0} with a {1} seconds interval and {2} seconds timeout", new Object[] {channel.getName(), intervalSeconds, timeoutSeconds});
final AtomicBoolean isInClosed = new AtomicBoolean(false);
final PingThread t = new PingThread(channel, timeoutSeconds * 1000L, intervalSeconds * 1000L) {
diff --git a/core/src/main/java/hudson/slaves/Cloud.java b/core/src/main/java/hudson/slaves/Cloud.java
index e436441abece190c59ec24a4e4f6ed6d2f51ad8d..d9cc5f2039ea4c8f690f04e5f0d06972516da231 100644
--- a/core/src/main/java/hudson/slaves/Cloud.java
+++ b/core/src/main/java/hudson/slaves/Cloud.java
@@ -67,7 +67,7 @@ import java.util.concurrent.Future;
* <p>
* To do this, have your {@link Slave} subtype remember the necessary handle (such as EC2 instance ID)
* as a field. Such fields need to survive the user-initiated re-configuration of {@link Slave}, so you'll need to
- * expose it in your {@link Slave} <tt>configure-entries.jelly</tt> and read it back in through {@link DataBoundConstructor}.
+ * expose it in your {@link Slave} {@code configure-entries.jelly} and read it back in through {@link DataBoundConstructor}.
*
* <p>
* You then implement your own {@link Computer} subtype, override {@link Slave#createComputer()}, and instantiate
@@ -80,9 +80,9 @@ import java.util.concurrent.Future;
*
* <h3>Views</h3>
*
- * Since version 2.64, Jenkins clouds are visualized in UI. Implementations can provide <tt>top</tt> or <tt>main</tt> view
- * to be presented at the top of the page or at the bottom respectively. In the middle, actions have their <tt>summary</tt>
- * views displayed. Actions further contribute to <tt>sidepanel</tt> with <tt>box</tt> views. All mentioned views are
+ * Since version 2.64, Jenkins clouds are visualized in UI. Implementations can provide {@code top} or {@code main} view
+ * to be presented at the top of the page or at the bottom respectively. In the middle, actions have their {@code summary}
+ * views displayed. Actions further contribute to {@code sidepanel} with {@code box} views. All mentioned views are
* optional to preserve backward compatibility.
*
* @author Kohsuke Kawaguchi
diff --git a/core/src/main/java/hudson/slaves/DumbSlave.java b/core/src/main/java/hudson/slaves/DumbSlave.java
index 835cf004ad23d02fb8fc8de08468f2122084a295..8142eb358facee47f8368640b03587fb1e710725 100644
--- a/core/src/main/java/hudson/slaves/DumbSlave.java
+++ b/core/src/main/java/hudson/slaves/DumbSlave.java
@@ -65,8 +65,8 @@ public final class DumbSlave extends Slave {
super(name, remoteFS, launcher);
}
- @Extension @Symbol({"dumb",
- "slave"/*because this is in effect the canonical slave type*/})
+ @Extension @Symbol({"permanent" /*because this is in effect the canonical slave type*/,
+ "dumb", "slave"})
public static final class DescriptorImpl extends SlaveDescriptor {
public String getDisplayName() {
return Messages.DumbSlave_displayName();
diff --git a/core/src/main/java/hudson/slaves/EnvironmentVariablesNodeProperty.java b/core/src/main/java/hudson/slaves/EnvironmentVariablesNodeProperty.java
index d41b8c49a12326d819a993dd3e923221004f88d5..90f95efb4e17fa0d773c7c274e905f7e079319fd 100644
--- a/core/src/main/java/hudson/slaves/EnvironmentVariablesNodeProperty.java
+++ b/core/src/main/java/hudson/slaves/EnvironmentVariablesNodeProperty.java
@@ -39,6 +39,9 @@ import org.kohsuke.stapler.Stapler;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
/**
* {@link NodeProperty} that sets additional environment variables.
@@ -65,6 +68,14 @@ public class EnvironmentVariablesNodeProperty extends NodeProperty<Node> {
return envVars;
}
+ /**
+ * @return environment variables using same data type as constructor parameter.
+ * @since 2.136
+ */
+ public List<Entry> getEnv() {
+ return envVars.entrySet().stream().map(Entry::new).collect(Collectors.toList());
+ }
+
@Override
public Environment setUp(AbstractBuild build, Launcher launcher,
BuildListener listener) throws IOException, InterruptedException {
@@ -100,6 +111,10 @@ public class EnvironmentVariablesNodeProperty extends NodeProperty<Node> {
public static class Entry {
public String key, value;
+ private Entry(Map.Entry<String,String> e) {
+ this(e.getKey(), e.getValue());
+ }
+
@DataBoundConstructor
public Entry(String key, String value) {
this.key = key;
diff --git a/core/src/main/java/hudson/slaves/JNLPLauncher.java b/core/src/main/java/hudson/slaves/JNLPLauncher.java
index eeafc2bb7f211e2c2e8631b971327acb59053860..bed08613d8146fa87a5300833e05810a41c52c3a 100644
--- a/core/src/main/java/hudson/slaves/JNLPLauncher.java
+++ b/core/src/main/java/hudson/slaves/JNLPLauncher.java
@@ -31,12 +31,14 @@ import hudson.model.DescriptorVisibilityFilter;
import hudson.model.TaskListener;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
+
import jenkins.model.Jenkins;
import jenkins.slaves.RemotingWorkDirSettings;
import org.jenkinsci.Symbol;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
/**
* {@link ComputerLauncher} via JNLP.
@@ -67,21 +69,29 @@ public class JNLPLauncher extends ComputerLauncher {
public final String vmargs;
@Nonnull
- private RemotingWorkDirSettings workDirSettings;
+ private RemotingWorkDirSettings workDirSettings = RemotingWorkDirSettings.getEnabledDefaults();
+
+ /**
+ * Constructor.
+ * @param tunnel Tunnel settings
+ * @param vmargs JVM arguments
+ * @param workDirSettings Settings for Work Directory management in Remoting.
+ * If {@code null}, {@link RemotingWorkDirSettings#getEnabledDefaults()}
+ * will be used to enable work directories by default in new agents.
+ * @since 2.68
+ */
+ @Deprecated
+ public JNLPLauncher(@CheckForNull String tunnel, @CheckForNull String vmargs, @CheckForNull RemotingWorkDirSettings workDirSettings) {
+ this(tunnel, vmargs);
+ if (workDirSettings != null) {
+ setWorkDirSettings(workDirSettings);
+ }
+ }
@DataBoundConstructor
- public JNLPLauncher(@CheckForNull String tunnel, @CheckForNull String vmargs, @Nonnull RemotingWorkDirSettings workDirSettings) {
+ public JNLPLauncher(@CheckForNull String tunnel, @CheckForNull String vmargs) {
this.tunnel = Util.fixEmptyAndTrim(tunnel);
this.vmargs = Util.fixEmptyAndTrim(vmargs);
- this.workDirSettings = workDirSettings;
- }
-
- @Deprecated
- public JNLPLauncher(String tunnel, String vmargs) {
- // TODO: Enable workDir by default in API? Otherwise classes inheriting from JNLPLauncher
- // will need to enable the feature by default as well.
- // https://github.com/search?q=org%3Ajenkinsci+%22extends+JNLPLauncher%22&type=Code
- this(tunnel, vmargs, RemotingWorkDirSettings.getDisabledDefaults());
}
/**
@@ -121,6 +131,11 @@ public class JNLPLauncher extends ComputerLauncher {
public RemotingWorkDirSettings getWorkDirSettings() {
return workDirSettings;
}
+
+ @DataBoundSetter
+ public final void setWorkDirSettings(@Nonnull RemotingWorkDirSettings workDirSettings) {
+ this.workDirSettings = workDirSettings;
+ }
@Override
public boolean isLaunchSupported() {
diff --git a/core/src/main/java/hudson/slaves/NodeDescriptor.java b/core/src/main/java/hudson/slaves/NodeDescriptor.java
index 6f06289c38d35390d9a9a099b66dabb63965eca2..5262ece687087f14269d7a3a6ccea5602dc6cf37 100644
--- a/core/src/main/java/hudson/slaves/NodeDescriptor.java
+++ b/core/src/main/java/hudson/slaves/NodeDescriptor.java
@@ -50,8 +50,8 @@ import javax.servlet.ServletException;
*
* <h2>Views</h2>
* <p>
- * This object needs to have <tt>newInstanceDetail.jelly</tt> view, which shows up in
- * <tt>http://server/hudson/computers/new</tt> page as an explanation of this job type.
+ * This object needs to have {@code newInstanceDetail.jelly} view, which shows up in
+ * {@code http://server/hudson/computers/new} page as an explanation of this job type.
*
* <h2>Other Implementation Notes</h2>
*
diff --git a/core/src/main/java/hudson/slaves/OfflineCause.java b/core/src/main/java/hudson/slaves/OfflineCause.java
index 3d711dd5f0ccd710fd267d94172871879b88aa36..a158ce2b8c15da689b612fc22634561eae5bd181 100644
--- a/core/src/main/java/hudson/slaves/OfflineCause.java
+++ b/core/src/main/java/hudson/slaves/OfflineCause.java
@@ -44,7 +44,7 @@ import java.util.Date;
*
* <h2>Views</h2>
* <p>
- * {@link OfflineCause} must have <tt>cause.jelly</tt> that renders a cause
+ * {@link OfflineCause} must have {@code cause.jelly} that renders a cause
* into HTML. This is used to tell users why the node is put offline.
* This view should render a block element like DIV.
*
@@ -103,7 +103,6 @@ public abstract class OfflineCause {
* Caused by unexpected channel termination.
*/
public static class ChannelTermination extends OfflineCause {
- @Exported
public final Exception cause;
public ChannelTermination(Exception cause) {
diff --git a/core/src/main/java/hudson/slaves/RetentionStrategy.java b/core/src/main/java/hudson/slaves/RetentionStrategy.java
index 0e33a9dc6c4ed93ac349c1278fb993baf85623cd..9eb95290c7e9d7175fb4ab1efff0909745a45dae 100644
--- a/core/src/main/java/hudson/slaves/RetentionStrategy.java
+++ b/core/src/main/java/hudson/slaves/RetentionStrategy.java
@@ -97,12 +97,7 @@ public abstract class RetentionStrategy<T extends Computer> extends AbstractDesc
* @since 1.275
*/
public void start(final @Nonnull T c) {
- Queue.withLock(new Runnable() {
- @Override
- public void run() {
- check(c);
- }
- });
+ Queue.withLock((Runnable) () -> check(c));
}
/**
@@ -123,26 +118,27 @@ public abstract class RetentionStrategy<T extends Computer> extends AbstractDesc
/**
* Dummy instance that doesn't do any attempt to retention.
*/
- public static final RetentionStrategy<Computer> NOOP = new RetentionStrategy<Computer>() {
+ public static final RetentionStrategy<Computer> NOOP = new NoOp();
+ private static final class NoOp extends RetentionStrategy<Computer> {
@GuardedBy("hudson.model.Queue.lock")
+ @Override
public long check(Computer c) {
return 60;
}
-
@Override
public void start(Computer c) {
c.connect(false);
}
-
@Override
public Descriptor<RetentionStrategy<?>> getDescriptor() {
return DESCRIPTOR;
}
-
- private final DescriptorImpl DESCRIPTOR = new DescriptorImpl();
-
- class DescriptorImpl extends Descriptor<RetentionStrategy<?>> {}
- };
+ private Object readResolve() {
+ return NOOP;
+ }
+ private static final DescriptorImpl DESCRIPTOR = new DescriptorImpl();
+ private static final class DescriptorImpl extends Descriptor<RetentionStrategy<?>> {}
+ }
/**
* Convenient singleton instance, since this {@link RetentionStrategy} is stateless.
diff --git a/core/src/main/java/hudson/slaves/SlaveComputer.java b/core/src/main/java/hudson/slaves/SlaveComputer.java
index 9b87bf5dec3f2c1110067e0863ba162ace222d23..31650d18aa7e3ab0636d228c257fd9e9cc38e293 100644
--- a/core/src/main/java/hudson/slaves/SlaveComputer.java
+++ b/core/src/main/java/hudson/slaves/SlaveComputer.java
@@ -39,6 +39,7 @@ import hudson.model.User;
import hudson.remoting.Channel;
import hudson.remoting.ChannelBuilder;
import hudson.remoting.ChannelClosedException;
+import hudson.remoting.CommandTransport;
import hudson.remoting.Launcher;
import hudson.remoting.VirtualChannel;
import hudson.security.ACL;
@@ -47,6 +48,7 @@ import hudson.util.Futures;
import hudson.util.NullStream;
import hudson.util.RingBufferLogHandler;
import hudson.util.StreamTaskListener;
+import hudson.util.VersionNumber;
import hudson.util.io.RewindableFileOutputStream;
import hudson.util.io.RewindableRotatingFileOutputStream;
import jenkins.model.Jenkins;
@@ -54,19 +56,25 @@ import jenkins.security.ChannelConfigurator;
import jenkins.security.MasterToSlaveCallable;
import jenkins.slaves.EncryptedSlaveAgentJnlpFile;
import jenkins.slaves.JnlpSlaveAgentProtocol;
+import jenkins.slaves.RemotingVersionInfo;
import jenkins.slaves.systemInfo.SlaveSystemInfo;
import jenkins.util.SystemProperties;
import org.acegisecurity.context.SecurityContext;
import org.acegisecurity.context.SecurityContextHolder;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.Beta;
+import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.WebMethod;
+import org.kohsuke.stapler.export.Exported;
import org.kohsuke.stapler.interceptor.RequirePOST;
import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
import javax.annotation.OverridingMethodsMustInvokeSuper;
import javax.servlet.ServletException;
import java.io.File;
@@ -86,6 +94,7 @@ import java.util.logging.LogRecord;
import java.util.logging.Logger;
import static hudson.slaves.SlaveComputer.LogHolder.SLAVE_LOG_HANDLER;
+import org.jenkinsci.remoting.util.LoggingChannelListener;
/**
@@ -377,7 +386,15 @@ public class SlaveComputer extends Computer {
private final Object channelLock = new Object();
- public void setChannel(InputStream in, OutputStream out, TaskListener taskListener, Channel.Listener listener) throws IOException, InterruptedException {
+ /**
+ * Creates a {@link Channel} from the given stream and sets that to this agent.
+ *
+ * Same as {@link #setChannel(InputStream, OutputStream, OutputStream, Channel.Listener)}, but for
+ * {@link TaskListener}.
+ */
+ public void setChannel(@Nonnull InputStream in, @Nonnull OutputStream out,
+ @Nonnull TaskListener taskListener,
+ @CheckForNull Channel.Listener listener) throws IOException, InterruptedException {
setChannel(in,out,taskListener.getLogger(),listener);
}
@@ -391,7 +408,7 @@ public class SlaveComputer extends Computer {
* Stream connected to the remote peer. It's the caller's responsibility to do
* buffering on this stream, if that's necessary.
* @param launchLog
- * If non-null, receive the portion of data in <tt>is</tt> before
+ * If non-null, receive the portion of data in {@code is} before
* the data goes into the "binary mode". This is useful
* when the established communication channel might include some data that might
* be useful for debugging/trouble-shooting.
@@ -400,7 +417,9 @@ public class SlaveComputer extends Computer {
* By the time this method is called, the cause of the termination is reported to the user,
* so the implementation of the listener doesn't need to do that again.
*/
- public void setChannel(InputStream in, OutputStream out, OutputStream launchLog, Channel.Listener listener) throws IOException, InterruptedException {
+ public void setChannel(@Nonnull InputStream in, @Nonnull OutputStream out,
+ @CheckForNull OutputStream launchLog,
+ @CheckForNull Channel.Listener listener) throws IOException, InterruptedException {
ChannelBuilder cb = new ChannelBuilder(nodeName,threadPoolForRemoting)
.withMode(Channel.Mode.NEGOTIATE)
.withHeaderStream(launchLog);
@@ -413,6 +432,39 @@ public class SlaveComputer extends Computer {
setChannel(channel,launchLog,listener);
}
+ /**
+ * Creates a {@link Channel} from the given Channel Builder and Command Transport.
+ * This method can be used to allow {@link ComputerLauncher}s to create channels not based on I/O streams.
+ *
+ * @param cb
+ * Channel Builder.
+ * To print launch logs this channel builder should have a Header Stream defined
+ * (see {@link ChannelBuilder#getHeaderStream()}) in this argument or by one of {@link ChannelConfigurator}s.
+ * @param commandTransport
+ * Command Transport
+ * @param listener
+ * Gets a notification when the channel closes, to perform clean up. Can be {@code null}.
+ * By the time this method is called, the cause of the termination is reported to the user,
+ * so the implementation of the listener doesn't need to do that again.
+ * @since 2.127
+ */
+ @Restricted(Beta.class)
+ public void setChannel(@Nonnull ChannelBuilder cb,
+ @Nonnull CommandTransport commandTransport,
+ @CheckForNull Channel.Listener listener) throws IOException, InterruptedException {
+ for (ChannelConfigurator cc : ChannelConfigurator.all()) {
+ cc.onChannelBuilding(cb,this);
+ }
+
+ OutputStream headerStream = cb.getHeaderStream();
+ if (headerStream == null) {
+ LOGGER.log(Level.WARNING, "No header stream defined when setting channel for computer {0}. " +
+ "Launch log won't be printed", this);
+ }
+ Channel channel = cb.build(commandTransport);
+ setChannel(channel, headerStream, listener);
+ }
+
/**
* Shows {@link Channel#classLoadingCount}.
* @since 1.495
@@ -470,6 +522,26 @@ public class SlaveComputer extends Computer {
return channel == null ? null : absoluteRemoteFs;
}
+ /**
+ * Just for restFul api.
+ * Returns the remote FS root absolute path or {@code null} if the agent is off-line. The absolute path may change
+ * between connections if the connection method does not provide a consistent working directory and the node's
+ * remote FS is specified as a relative path.
+ * @see #getAbsoluteRemoteFs()
+ * @return the remote FS root absolute path or {@code null} if the agent is off-line or don't have connect permission.
+ * @since 2.125
+ */
+ @Exported
+ @Restricted(DoNotUse.class)
+ @CheckForNull
+ public String getAbsoluteRemotePath() {
+ if(hasPermission(CONNECT)) {
+ return getAbsoluteRemoteFs();
+ } else {
+ return null;
+ }
+ }
+
static class LoadingCount extends MasterToSlaveCallable<Integer,RuntimeException> {
private final boolean resource;
LoadingCount(boolean resource) {
@@ -506,19 +578,23 @@ public class SlaveComputer extends Computer {
/**
* Sets up the connection through an existing channel.
- * @param channel the channel to use; <strong>warning:</strong> callers are expected to have called {@link ChannelConfigurator} already
+ * @param channel the channel to use; <strong>warning:</strong> callers are expected to have called {@link ChannelConfigurator} already.
+ * @param launchLog Launch log. If not {@code null}, will receive launch log messages
+ * @param listener Channel event listener to be attached (if not {@code null})
* @since 1.444
*/
- public void setChannel(Channel channel, OutputStream launchLog, Channel.Listener listener) throws IOException, InterruptedException {
+ public void setChannel(@Nonnull Channel channel,
+ @CheckForNull OutputStream launchLog,
+ @CheckForNull Channel.Listener listener) throws IOException, InterruptedException {
if(this.channel!=null)
throw new IllegalStateException("Already connected");
- final TaskListener taskListener = new StreamTaskListener(launchLog);
+ final TaskListener taskListener = launchLog != null ? new StreamTaskListener(launchLog) : TaskListener.NULL;
PrintStream log = taskListener.getLogger();
channel.setProperty(SlaveComputer.class, this);
- channel.addListener(new Channel.Listener() {
+ channel.addListener(new LoggingChannelListener(logger, Level.FINEST) {
@Override
public void onClosed(Channel c, IOException cause) {
// Orderly shutdown will have null exception
@@ -545,6 +621,12 @@ public class SlaveComputer extends Computer {
String slaveVersion = channel.call(new SlaveVersion());
log.println("Remoting version: " + slaveVersion);
+ VersionNumber agentVersion = new VersionNumber(slaveVersion);
+ if (agentVersion.isOlderThan(RemotingVersionInfo.getMinimumSupportedVersion())) {
+ log.println(String.format("WARNING: Remoting version is older than a minimum required one (%s). " +
+ "Connection will not be rejected, but the compatibility is NOT guaranteed",
+ RemotingVersionInfo.getMinimumSupportedVersion()));
+ }
boolean _isUnix = channel.call(new DetectOS());
log.println(_isUnix? hudson.model.Messages.Slave_UnixSlave():hudson.model.Messages.Slave_WindowsSlave());
@@ -660,6 +742,8 @@ public class SlaveComputer extends Computer {
@RequirePOST
public void doLaunchSlaveAgent(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
+ checkPermission(CONNECT);
+
if(channel!=null) {
req.getView(this,"already-launched.jelly").forward(req, rsp);
return;
@@ -717,7 +801,7 @@ public class SlaveComputer extends Computer {
public RetentionStrategy getRetentionStrategy() {
Slave n = getNode();
- return n==null ? RetentionStrategy.INSTANCE : n.getRetentionStrategy();
+ return n==null ? RetentionStrategy.NOOP : n.getRetentionStrategy();
}
/**
diff --git a/core/src/main/java/hudson/tasks/ArtifactArchiver.java b/core/src/main/java/hudson/tasks/ArtifactArchiver.java
index d42a4a3298f58640ef28914433c3df2d626e7b58..b90fe33a3ab6d5f9a7ece2980c645b5e9dea181d 100644
--- a/core/src/main/java/hudson/tasks/ArtifactArchiver.java
+++ b/core/src/main/java/hudson/tasks/ArtifactArchiver.java
@@ -141,9 +141,9 @@ public class ArtifactArchiver extends Recorder implements SimpleBuildStep {
}
// Backwards compatibility for older builds
- @SuppressFBWarnings(value = "RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE",
+ @SuppressFBWarnings(value = "RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE",
justification = "Null checks in readResolve are valid since we deserialize and upgrade objects")
- public Object readResolve() {
+ protected Object readResolve() {
if (allowEmptyArchive == null) {
this.allowEmptyArchive = SystemProperties.getBoolean(ArtifactArchiver.class.getName()+".warnOnEmpty");
}
@@ -214,20 +214,10 @@ public class ArtifactArchiver extends Recorder implements SimpleBuildStep {
this.caseSensitive = caseSensitive;
}
- private void listenerWarnOrError(TaskListener listener, String message) {
- if (allowEmptyArchive) {
- listener.getLogger().println(String.format("WARN: %s", message));
- } else {
- listener.error(message);
- }
- }
-
@Override
- public void perform(Run<?,?> build, FilePath ws, Launcher launcher, TaskListener listener) throws InterruptedException, AbortException {
+ public void perform(Run<?,?> build, FilePath ws, Launcher launcher, TaskListener listener) throws IOException, InterruptedException {
if(artifacts.length()==0) {
- listener.error(Messages.ArtifactArchiver_NoIncludes());
- build.setResult(Result.FAILURE);
- return;
+ throw new AbortException(Messages.ArtifactArchiver_NoIncludes());
}
Result result = build.getResult();
@@ -249,29 +239,29 @@ public class ArtifactArchiver extends Recorder implements SimpleBuildStep {
} else {
result = build.getResult();
if (result == null || result.isBetterOrEqualTo(Result.UNSTABLE)) {
- // If the build failed, don't complain that there was no matching artifact.
- // The build probably didn't even get to the point where it produces artifacts.
- listenerWarnOrError(listener, Messages.ArtifactArchiver_NoMatchFound(artifacts));
- String msg = null;
try {
- msg = ws.validateAntFileMask(artifacts, FilePath.VALIDATE_ANT_FILE_MASK_BOUND, caseSensitive);
+ String msg = ws.validateAntFileMask(artifacts, FilePath.VALIDATE_ANT_FILE_MASK_BOUND, caseSensitive);
+ if (msg != null) {
+ listener.getLogger().println(msg);
+ }
} catch (Exception e) {
- listenerWarnOrError(listener, e.getMessage());
+ Functions.printStackTrace(e, listener.getLogger());
}
- if(msg!=null)
- listenerWarnOrError(listener, msg);
- }
- if (!allowEmptyArchive) {
- build.setResult(Result.FAILURE);
+ if (allowEmptyArchive) {
+ listener.getLogger().println(Messages.ArtifactArchiver_NoMatchFound(artifacts));
+ } else {
+ throw new AbortException(Messages.ArtifactArchiver_NoMatchFound(artifacts));
+ }
+ } else {
+ // If a freestyle build failed, do not complain that there was no matching artifact:
+ // the build probably did not even get to the point where it produces artifacts.
+ // For Pipeline, the program ought not be *trying* to archive anything after a failure,
+ // but anyway most likely result == null above so we would not be here.
}
}
} catch (java.nio.file.AccessDeniedException e) {
LOG.log(Level.FINE, "Diagnosing anticipated Exception", e);
throw new AbortException(e.toString()); // Message is not enough as that is the filename only
- } catch (IOException e) {
- Util.displayIOException(e,listener);
- Functions.printStackTrace(e, listener.error(Messages.ArtifactArchiver_FailedToArchive(artifacts)));
- build.setResult(Result.FAILURE);
}
}
diff --git a/core/src/main/java/hudson/tasks/BuildStep.java b/core/src/main/java/hudson/tasks/BuildStep.java
index 16f0c0268cc7223ba33c748a416a6d6070473adb..ad81455335c1db7049e11347484230207b4988ac 100644
--- a/core/src/main/java/hudson/tasks/BuildStep.java
+++ b/core/src/main/java/hudson/tasks/BuildStep.java
@@ -65,7 +65,7 @@ import jenkins.model.Jenkins;
* So generally speaking, derived classes should use instance variables
* only for keeping configuration. You can still store objects you use
* for processing, like a parser of some sort, but they need to be marked
- * as <tt>transient</tt>, and the code needs to be aware that they might
+ * as {@code transient}, and the code needs to be aware that they might
* be null (which is the case when you access the field for the first time
* the object is restored.)
*
@@ -145,7 +145,7 @@ public interface BuildStep {
* it owns when the rendering is requested.
*
* <p>
- * This action can have optional <tt>jobMain.jelly</tt> view, which will be
+ * This action can have optional {@code jobMain.jelly} view, which will be
* aggregated into the main panel of the job top page. The jelly file
* should have an {@code <h2>} tag that shows the section title, followed by some
* block elements to render the details of the section.
diff --git a/core/src/main/java/hudson/tasks/BuildTrigger.java b/core/src/main/java/hudson/tasks/BuildTrigger.java
index 00615dbc79a7e9649d39d0a2b3c977c715494fed..78f8ef13f8a10df1597782725e84af532db3e4df 100644
--- a/core/src/main/java/hudson/tasks/BuildTrigger.java
+++ b/core/src/main/java/hudson/tasks/BuildTrigger.java
@@ -431,7 +431,7 @@ public class BuildTrigger extends Recorder implements DependencyDeclarer {
public static class ItemListenerImpl extends ItemListener {
@Override
public void onLocationChanged(final Item item, final String oldFullName, final String newFullName) {
- try (ACLContext _ = ACL.as(ACL.SYSTEM)) {
+ try (ACLContext acl = ACL.as(ACL.SYSTEM)) {
locationChanged(item, oldFullName, newFullName);
}
}
diff --git a/core/src/main/java/hudson/tasks/Fingerprinter.java b/core/src/main/java/hudson/tasks/Fingerprinter.java
index fb45ef9cc2cba11f4147b863d92b9c29b1081909..c563180e0130d1c4060d335942979db68779ff25 100644
--- a/core/src/main/java/hudson/tasks/Fingerprinter.java
+++ b/core/src/main/java/hudson/tasks/Fingerprinter.java
@@ -188,59 +188,69 @@ public class Fingerprinter extends Recorder implements Serializable, DependencyD
}
}
- private void record(Run<?,?> build, FilePath ws, TaskListener listener, Map<String,String> record, final String targets) throws IOException, InterruptedException {
- final class Record implements Serializable {
- final boolean produced;
- final String relativePath;
- final String fileName;
- final String md5sum;
-
- public Record(boolean produced, String relativePath, String fileName, String md5sum) {
- this.produced = produced;
- this.relativePath = relativePath;
- this.fileName = fileName;
- this.md5sum = md5sum;
- }
-
- Fingerprint addRecord(Run build) throws IOException {
- FingerprintMap map = Jenkins.getInstance().getFingerprintMap();
- return map.getOrCreate(produced?build:null, fileName, md5sum);
- }
+ private static final class Record implements Serializable {
+
+ final boolean produced;
+ final String relativePath;
+ final String fileName;
+ final String md5sum;
+
+ public Record(boolean produced, String relativePath, String fileName, String md5sum) {
+ this.produced = produced;
+ this.relativePath = relativePath;
+ this.fileName = fileName;
+ this.md5sum = md5sum;
+ }
- private static final long serialVersionUID = 1L;
+ Fingerprint addRecord(Run build) throws IOException {
+ FingerprintMap map = Jenkins.getInstance().getFingerprintMap();
+ return map.getOrCreate(produced?build:null, fileName, md5sum);
}
- final long buildTimestamp = build.getTimeInMillis();
+ private static final long serialVersionUID = 1L;
+ }
- List<Record> records = ws.act(new MasterToSlaveFileCallable<List<Record>>() {
- public List<Record> invoke(File baseDir, VirtualChannel channel) throws IOException {
- List<Record> results = new ArrayList<Record>();
+ private static final class FindRecords extends MasterToSlaveFileCallable<List<Record>> {
- FileSet src = Util.createFileSet(baseDir,targets);
+ private final String targets;
+ private final long buildTimestamp;
- DirectoryScanner ds = src.getDirectoryScanner();
- for( String f : ds.getIncludedFiles() ) {
- File file = new File(baseDir,f);
+ FindRecords(String targets, long buildTimestamp) {
+ this.targets = targets;
+ this.buildTimestamp = buildTimestamp;
+ }
- // consider the file to be produced by this build only if the timestamp
- // is newer than when the build has started.
- // 2000ms is an error margin since since VFAT only retains timestamp at 2sec precision
- boolean produced = buildTimestamp <= file.lastModified()+2000;
+ @Override
+ public List<Record> invoke(File baseDir, VirtualChannel channel) throws IOException {
+ List<Record> results = new ArrayList<Record>();
- try {
- results.add(new Record(produced,f,file.getName(),new FilePath(file).digest()));
- } catch (IOException e) {
- throw new IOException(Messages.Fingerprinter_DigestFailed(file),e);
- } catch (InterruptedException e) {
- throw new IOException(Messages.Fingerprinter_Aborted(),e);
- }
- }
+ FileSet src = Util.createFileSet(baseDir,targets);
- return results;
+ DirectoryScanner ds = src.getDirectoryScanner();
+ for( String f : ds.getIncludedFiles() ) {
+ File file = new File(baseDir,f);
+
+ // consider the file to be produced by this build only if the timestamp
+ // is newer than when the build has started.
+ // 2000ms is an error margin since since VFAT only retains timestamp at 2sec precision
+ boolean produced = buildTimestamp <= file.lastModified()+2000;
+
+ try {
+ results.add(new Record(produced,f,file.getName(),new FilePath(file).digest()));
+ } catch (IOException e) {
+ throw new IOException(Messages.Fingerprinter_DigestFailed(file),e);
+ } catch (InterruptedException e) {
+ throw new IOException(Messages.Fingerprinter_Aborted(),e);
+ }
}
- });
- for (Record r : records) {
+ return results;
+ }
+
+ }
+
+ private void record(Run<?,?> build, FilePath ws, TaskListener listener, Map<String,String> record, final String targets) throws IOException, InterruptedException {
+ for (Record r : ws.act(new FindRecords(targets, build.getTimeInMillis()))) {
Fingerprint fp = r.addRecord(build);
if(fp==null) {
listener.error(Messages.Fingerprinter_FailedFor(r.relativePath));
diff --git a/core/src/main/java/hudson/tasks/Maven.java b/core/src/main/java/hudson/tasks/Maven.java
index c1e4a610fe18d5fa8e070a9ecaded3458995c9a7..5bccbfe78548651ed390c081f0e986bf3c53249a 100644
--- a/core/src/main/java/hudson/tasks/Maven.java
+++ b/core/src/main/java/hudson/tasks/Maven.java
@@ -24,6 +24,7 @@
package hudson.tasks;
import hudson.Extension;
+import hudson.model.PersistentDescriptor;
import jenkins.MasterToSlaveFileCallable;
import hudson.Launcher;
import hudson.Functions;
@@ -245,7 +246,7 @@ public class Maven extends Builder {
}
/**
- * Looks for <tt>pom.xlm</tt> or <tt>project.xml</tt> to determine the maven executable
+ * Looks for {@code pom.xlm} or {@code project.xml} to determine the maven executable
* name.
*/
private static final class DecideDefaultMavenCommand extends MasterToSlaveFileCallable<String> {
@@ -424,13 +425,12 @@ public class Maven extends Builder {
public static DescriptorImpl DESCRIPTOR;
@Extension @Symbol("maven")
- public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {
+ public static final class DescriptorImpl extends BuildStepDescriptor<Builder> implements PersistentDescriptor {
@CopyOnWrite
private volatile MavenInstallation[] installations = new MavenInstallation[0];
public DescriptorImpl() {
DESCRIPTOR = this;
- load();
}
public boolean isApplicable(Class<? extends AbstractProject> jobType) {
@@ -553,29 +553,7 @@ public class Maven extends Builder {
public boolean meetsMavenReqVersion(Launcher launcher, int mavenReqVersion) throws IOException, InterruptedException {
// FIXME using similar stuff as in the maven plugin could be better
// olamy : but will add a dependency on maven in core -> so not so good
- String mavenVersion = launcher.getChannel().call(new MasterToSlaveCallable<String,IOException>() {
- private static final long serialVersionUID = -4143159957567745621L;
-
- public String call() throws IOException {
- File[] jars = new File(getHomeDir(),"lib").listFiles();
- if(jars!=null) { // be defensive
- for (File jar : jars) {
- if (jar.getName().startsWith("maven-")) {
- JarFile jf = null;
- try {
- jf = new JarFile(jar);
- Manifest manifest = jf.getManifest();
- String version = manifest.getMainAttributes().getValue(Attributes.Name.IMPLEMENTATION_VERSION);
- if(version != null) return version;
- } finally {
- if(jf != null) jf.close();
- }
- }
- }
- }
- return "";
- }
- });
+ String mavenVersion = launcher.getChannel().call(new GetMavenVersion());
if (!mavenVersion.equals("")) {
if (mavenReqVersion == MAVEN_20) {
@@ -594,6 +572,33 @@ public class Maven extends Builder {
return false;
}
+ private class GetMavenVersion extends MasterToSlaveCallable<String, IOException> {
+ private static final long serialVersionUID = -4143159957567745621L;
+ @Override
+ public String call() throws IOException {
+ File[] jars = new File(getHomeDir(), "lib").listFiles();
+ if (jars != null) { // be defensive
+ for (File jar : jars) {
+ if (jar.getName().startsWith("maven-")) {
+ JarFile jf = null;
+ try {
+ jf = new JarFile(jar);
+ Manifest manifest = jf.getManifest();
+ String version = manifest.getMainAttributes().getValue(Attributes.Name.IMPLEMENTATION_VERSION);
+ if (version != null) {
+ return version;
+ }
+ } finally {
+ if (jf != null) {
+ jf.close();
+ }
+ }
+ }
+ }
+ }
+ return "";
+ }
+ }
/**
* Is this Maven 2.1.x or 2.2.x - but not Maven 3.x?
@@ -609,9 +614,11 @@ public class Maven extends Builder {
* Gets the executable path of this maven on the given target system.
*/
public String getExecutable(Launcher launcher) throws IOException, InterruptedException {
- return launcher.getChannel().call(new MasterToSlaveCallable<String,IOException>() {
+ return launcher.getChannel().call(new GetExecutable());
+ }
+ private class GetExecutable extends MasterToSlaveCallable<String, IOException> {
private static final long serialVersionUID = 2373163112639943768L;
-
+ @Override
public String call() throws IOException {
File exe = getExeFile("mvn");
if(exe.exists())
@@ -621,7 +628,6 @@ public class Maven extends Builder {
return exe.getPath();
return null;
}
- });
}
private File getExeFile(String execName) {
@@ -773,7 +779,7 @@ public class Maven extends Builder {
* If the Maven installation can not be uniquely determined,
* it's often better to return just one of them, rather than returning
* null, since this method is currently ultimately only used to
- * decide where to parse <tt>conf/settings.xml</tt> from.
+ * decide where to parse {@code conf/settings.xml} from.
*/
MavenInstallation inferMavenInstallation();
}
diff --git a/core/src/main/java/hudson/tasks/Shell.java b/core/src/main/java/hudson/tasks/Shell.java
index 4360f4ce94c9bf74e8c83ecd164765a4c23d8148..3455076d5bfcc9550dd910fdc8e4ba9962113f33 100644
--- a/core/src/main/java/hudson/tasks/Shell.java
+++ b/core/src/main/java/hudson/tasks/Shell.java
@@ -27,6 +27,7 @@ import hudson.FilePath;
import hudson.Util;
import hudson.Extension;
import hudson.model.AbstractProject;
+import hudson.model.PersistentDescriptor;
import hudson.remoting.VirtualChannel;
import hudson.util.FormValidation;
import java.io.IOException;
@@ -131,16 +132,12 @@ public class Shell extends CommandInterpreter {
}
@Extension @Symbol("shell")
- public static class DescriptorImpl extends BuildStepDescriptor<Builder> {
+ public static class DescriptorImpl extends BuildStepDescriptor<Builder> implements PersistentDescriptor {
/**
* Shell executable, or null to default.
*/
private String shell;
- public DescriptorImpl() {
- load();
- }
-
public boolean isApplicable(Class<? extends AbstractProject> jobType) {
return true;
}
diff --git a/core/src/main/java/hudson/tasks/package.html b/core/src/main/java/hudson/tasks/package.html
index 9a85792fab9ecd3e347cf3c850ac37bb8e42ccc2..3ecc377e257b81333f1027a871b92d26d27adca9 100644
--- a/core/src/main/java/hudson/tasks/package.html
+++ b/core/src/main/java/hudson/tasks/package.html
@@ -23,6 +23,6 @@ THE SOFTWARE.
-->
<html><head/><body>
-Built-in <a href="Builder.html"><tt>Builder</tt></a>s and <a href="Publisher.html"><tt>Publisher</tt></a>s
+Built-in <a href="Builder.html"><code>Builder</code></a>s and <a href="Publisher.html"><code>Publisher</code></a>s
that perform the actual heavy-lifting of a build.
-</body></html>
\ No newline at end of file
+</body></html>
diff --git a/core/src/main/java/hudson/tools/DownloadFromUrlInstaller.java b/core/src/main/java/hudson/tools/DownloadFromUrlInstaller.java
index e60facbf6851c3365b20be2dcb963615cd35bbcb..c421b041a9f5288657ffd28a04158706ed4a5652 100644
--- a/core/src/main/java/hudson/tools/DownloadFromUrlInstaller.java
+++ b/core/src/main/java/hudson/tools/DownloadFromUrlInstaller.java
@@ -108,7 +108,7 @@ public abstract class DownloadFromUrlInstaller extends ToolInstaller {
*
* @return
* Return the real top directory inside {@code root} that contains the meat. In the above example,
- * <tt>root.child("jakarta-ant")</tt> should be returned. If there's no directory to pull up,
+ * {@code root.child("jakarta-ant")} should be returned. If there's no directory to pull up,
* return null.
*/
protected FilePath findPullUpDirectory(FilePath root) throws IOException, InterruptedException {
diff --git a/core/src/main/java/hudson/tools/JDKInstaller.java b/core/src/main/java/hudson/tools/JDKInstaller.java
deleted file mode 100644
index ce4f9f2eebc69de02a47f3a8f6344b4ca8947304..0000000000000000000000000000000000000000
--- a/core/src/main/java/hudson/tools/JDKInstaller.java
+++ /dev/null
@@ -1,967 +0,0 @@
-/*
- * The MIT License
- *
- * Copyright (c) 2009-2010, Sun Microsystems, Inc., CloudBees, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
-package hudson.tools;
-
-import hudson.AbortException;
-import hudson.Extension;
-import hudson.FilePath;
-import hudson.Launcher;
-import hudson.Launcher.ProcStarter;
-import hudson.ProxyConfiguration;
-import hudson.Util;
-import hudson.model.DownloadService.Downloadable;
-import hudson.model.JDK;
-import hudson.model.Node;
-import hudson.model.TaskListener;
-import hudson.util.ArgumentListBuilder;
-import hudson.util.FormValidation;
-import hudson.util.HttpResponses;
-import hudson.util.Secret;
-import java.io.OutputStream;
-import java.nio.file.Files;
-import java.nio.file.InvalidPathException;
-import jenkins.model.Jenkins;
-import jenkins.security.MasterToSlaveCallable;
-import net.sf.json.JSONObject;
-import net.sf.json.JsonConfig;
-import org.apache.commons.httpclient.Cookie;
-import org.apache.commons.httpclient.HttpClient;
-import org.apache.commons.httpclient.HttpMethodBase;
-import org.apache.commons.httpclient.URI;
-import org.apache.commons.httpclient.UsernamePasswordCredentials;
-import org.apache.commons.httpclient.auth.AuthScope;
-import org.apache.commons.httpclient.methods.GetMethod;
-import org.apache.commons.httpclient.methods.PostMethod;
-import org.apache.commons.httpclient.protocol.Protocol;
-import org.apache.commons.io.IOUtils;
-import org.jenkinsci.Symbol;
-import org.kohsuke.stapler.DataBoundConstructor;
-import org.kohsuke.stapler.HttpResponse;
-import org.kohsuke.stapler.QueryParameter;
-import org.kohsuke.stapler.Stapler;
-
-import javax.servlet.ServletException;
-import java.io.ByteArrayInputStream;
-import java.io.DataInputStream;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStreamWriter;
-import java.io.PrintStream;
-import java.net.URL;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Iterator;
-import java.util.LinkedList;
-import java.util.List;
-import java.util.Locale;
-import java.util.logging.Logger;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
-import static hudson.tools.JDKInstaller.Preference.*;
-import org.kohsuke.stapler.interceptor.RequirePOST;
-
-/**
- * Install JDKs from java.sun.com.
- *
- * @author Kohsuke Kawaguchi
- * @since 1.305
- */
-public class JDKInstaller extends ToolInstaller {
-
- static {
- // this socket factory will not attempt to bind to the client interface
- Protocol.registerProtocol("http", new Protocol("http", new hudson.util.NoClientBindProtocolSocketFactory(), 80));
- Protocol.registerProtocol("https", new Protocol("https", new hudson.util.NoClientBindSSLProtocolSocketFactory(), 443));
- }
-
- /**
- * The release ID that Sun assigns to each JDK, such as "jdk-6u13-oth-JPR@CDS-CDS_Developer"
- *
- * <p>
- * This ID can be seen in the "ProductRef" query parameter of the download page, like
- * https://cds.sun.com/is-bin/INTERSHOP.enfinity/WFS/CDS-CDS_Developer-Site/en_US/-/USD/ViewProductDetail-Start?ProductRef=jdk-6u13-oth-JPR@CDS-CDS_Developer
- */
- public final String id;
-
- /**
- * We require that the user accepts the license by clicking a checkbox, to make up for the part
- * that we auto-accept cds.sun.com license click through.
- */
- public final boolean acceptLicense;
-
- @DataBoundConstructor
- public JDKInstaller(String id, boolean acceptLicense) {
- super(null);
- this.id = id;
- this.acceptLicense = acceptLicense;
- }
-
- public FilePath performInstallation(ToolInstallation tool, Node node, TaskListener log) throws IOException, InterruptedException {
- FilePath expectedLocation = preferredLocation(tool, node);
- PrintStream out = log.getLogger();
- try {
- if(!acceptLicense) {
- out.println(Messages.JDKInstaller_UnableToInstallUntilLicenseAccepted());
- return expectedLocation;
- }
- // already installed?
- FilePath marker = expectedLocation.child(".installedByHudson");
- if (marker.exists() && marker.readToString().equals(id)) {
- return expectedLocation;
- }
- expectedLocation.deleteRecursive();
- expectedLocation.mkdirs();
-
- Platform p = Platform.of(node);
- URL url = locate(log, p, CPU.of(node));
-
-// out.println("Downloading "+url);
- FilePath file = expectedLocation.child(p.bundleFileName);
- file.copyFrom(url);
-
- // JDK6u13 on Windows doesn't like path representation like "/tmp/foo", so make it a strict platform native format by doing 'absolutize'
- install(node.createLauncher(log), p, new FilePathFileSystem(node), log, expectedLocation.absolutize().getRemote(), file.getRemote());
-
- // successfully installed
- file.delete();
- marker.write(id, null);
-
- } catch (DetectionFailedException e) {
- out.println("JDK installation skipped: "+e.getMessage());
- }
-
- return expectedLocation;
- }
-
- /**
- * Performs the JDK installation to a system, provided that the bundle was already downloaded.
- *
- * @param launcher
- * Used to launch processes on the system.
- * @param p
- * Platform of the system. This determines how the bundle is installed.
- * @param fs
- * Abstraction of the file system manipulation on this system.
- * @param log
- * Where the output from the installation will be written.
- * @param expectedLocation
- * Path to install JDK to. Must be absolute and in the native file system notation.
- * @param jdkBundle
- * Path to the installed JDK bundle. (The bundle to download can be determined by {@link #locate(TaskListener, Platform, CPU)} call.)
- */
- public void install(Launcher launcher, Platform p, FileSystem fs, TaskListener log, String expectedLocation, String jdkBundle) throws IOException, InterruptedException {
- PrintStream out = log.getLogger();
-
- out.println("Installing "+ jdkBundle);
- FilePath parent = new FilePath(launcher.getChannel(), expectedLocation).getParent();
- switch (p) {
- case LINUX:
- case SOLARIS:
- // JDK on Unix up to 6 was distributed as shell script installer, but in JDK7 it switched to a plain tgz.
- // so check if the file is gzipped, and if so, treat it accordingly
- byte[] header = new byte[2];
- {
- try (InputStream is = fs.read(jdkBundle);
- DataInputStream in = new DataInputStream(is)) {
- in.readFully(header);
- }
- }
-
- ProcStarter starter;
- if (header[0]==0x1F && header[1]==(byte)0x8B) {// gzip
- starter = launcher.launch().cmds("tar", "xvzf", jdkBundle);
- } else {
- fs.chmod(jdkBundle,0755);
- starter = launcher.launch().cmds(jdkBundle, "-noregister");
- }
-
- int exit = starter
- .stdin(new ByteArrayInputStream("yes".getBytes())).stdout(out)
- .pwd(new FilePath(launcher.getChannel(), expectedLocation)).join();
- if (exit != 0)
- throw new AbortException(Messages.JDKInstaller_FailedToInstallJDK(exit));
-
- // JDK creates its own sub-directory, so pull them up
- List<String> paths = fs.listSubDirectories(expectedLocation);
- for (Iterator<String> itr = paths.iterator(); itr.hasNext();) {
- String s = itr.next();
- if (!s.matches("j(2s)?dk.*"))
- itr.remove();
- }
- if(paths.size()!=1)
- throw new AbortException("Failed to find the extracted JDKs: "+paths);
-
- // remove the intermediate directory
- fs.pullUp(expectedLocation+'/'+paths.get(0),expectedLocation);
- break;
- case WINDOWS:
- /*
- Windows silent installation is full of bad know-how.
-
- On Windows, command line argument to a process at the OS level is a single string,
- not a string array like POSIX. When we pass arguments as string array, JRE eventually
- turn it into a single string with adding quotes to "the right place". Unfortunately,
- with the strange argument layout of InstallShield (like /v/qn" INSTALLDIR=foobar"),
- it appears that the escaping done by JRE gets in the way, and prevents the installation.
- Presumably because of this, my attempt to use /q/vn" INSTALLDIR=foo" didn't work with JDK5.
-
- I tried to locate exactly how InstallShield parses the arguments (and why it uses
- awkward option like /qn, but couldn't find any. Instead, experiments revealed that
- "/q/vn ARG ARG ARG" works just as well. This is presumably due to the Visual C++ runtime library
- (which does single string -> string array conversion to invoke the main method in most Win32 process),
- and this consistently worked on JDK5 and JDK4.
-
- Some of the official documentations are available at
- - http://java.sun.com/j2se/1.5.0/sdksilent.html
- - http://java.sun.com/j2se/1.4.2/docs/guide/plugin/developer_guide/silent.html
- */
-
- expectedLocation = expectedLocation.trim();
- if (expectedLocation.endsWith("\\")) {
- // Prevent a trailing slash from escaping quotes
- expectedLocation = expectedLocation.substring(0, expectedLocation.length() - 1);
- }
- String logFile = parent.createTempFile("install", "log").getRemote();
-
-
- ArgumentListBuilder args = new ArgumentListBuilder();
- assert (new File(expectedLocation).exists()) : expectedLocation
- + " must exist, otherwise /L will cause the installer to fail with error 1622";
- if (isJava15() || isJava14()) {
- // Installer uses InstallShield.
- args.add("CMD.EXE", "/C");
-
- // see http://docs.oracle.com/javase/1.5.0/docs/guide/deployment/deployment-guide/silent.html
- // CMD.EXE /C must be followed by a single parameter (do not split it!)
- args.add(jdkBundle + " /s /v\"/qn REBOOT=ReallySuppress INSTALLDIR=\\\""
- + expectedLocation + "\\\" /L \\\"" + logFile + "\\\"\"");
- } else {
- // Installed uses Windows Installer (MSI)
- args.add(jdkBundle, "/s");
-
- // Create a private JRE by omitting "PublicjreFeature"
- // @see http://docs.oracle.com/javase/7/docs/webnotes/install/windows/jdk-installation-windows.html#jdk-silent-installation
- args.add("ADDLOCAL=\"ToolsFeature\"",
- "REBOOT=ReallySuppress", "INSTALLDIR=" + expectedLocation,
- "/L", logFile);
- }
- int r = launcher.launch().cmds(args).stdout(out)
- .pwd(new FilePath(launcher.getChannel(), expectedLocation)).join();
- if (r != 0) {
- out.println(Messages.JDKInstaller_FailedToInstallJDK(r));
- // log file is in UTF-16
- try (InputStreamReader in = new InputStreamReader(fs.read(logFile), "UTF-16")) {
- IOUtils.copy(in, new OutputStreamWriter(out));
- }
- throw new AbortException();
- }
-
- fs.delete(logFile);
-
- break;
-
- case OSX:
- // Mount the DMG distribution bundle
- FilePath dmg = parent.createTempDir("jdk", "dmg");
- exit = launcher.launch()
- .cmds("hdiutil", "attach", "-puppetstrings", "-mountpoint", dmg.getRemote(), jdkBundle)
- .stdout(log)
- .join();
- if (exit != 0)
- throw new AbortException(Messages.JDKInstaller_FailedToInstallJDK(exit));
-
- // expand the installation PKG
- FilePath[] list = dmg.list("*.pkg");
- if (list.length != 1) {
- log.getLogger().println("JDK dmg bundle does not contain expected pkg installer");
- throw new AbortException(Messages.JDKInstaller_FailedToInstallJDK(exit));
- }
- String installer = list[0].getRemote();
-
- FilePath pkg = parent.createTempDir("jdk", "pkg");
- pkg.deleteRecursive(); // pkgutil fails if target directory exists
- exit = launcher.launch()
- .cmds("pkgutil", "--expand", installer, pkg.getRemote())
- .stdout(log)
- .join();
- if (exit != 0)
- throw new AbortException(Messages.JDKInstaller_FailedToInstallJDK(exit));
-
- exit = launcher.launch()
- .cmds("umount", dmg.getRemote())
- .stdout(log)
- .join();
- if (exit != 0)
- throw new AbortException(Messages.JDKInstaller_FailedToInstallJDK(exit));
-
- // We only want the actual JDK sub-package, which "Payload" is actually a tar.gz archive
- list = pkg.list("jdk*.pkg/Payload");
- if (list.length != 1) {
- log.getLogger().println("JDK pkg installer does not contain expected JDK Payload archive");
- throw new AbortException(Messages.JDKInstaller_FailedToInstallJDK(exit));
- }
- String payload = list[0].getRemote();
- exit = launcher.launch()
- .pwd(parent).cmds("tar", "xzf", payload)
- .stdout(log)
- .join();
- if (exit != 0)
- throw new AbortException(Messages.JDKInstaller_FailedToInstallJDK(exit));
-
- parent.child("Contents/Home").moveAllChildrenTo(new FilePath(launcher.getChannel(), expectedLocation));
- parent.child("Contents").deleteRecursive();
-
- pkg.deleteRecursive();
- dmg.deleteRecursive();
- break;
- }
- }
-
- private boolean isJava15() {
- return id.contains("-1.5");
- }
-
- private boolean isJava14() {
- return id.contains("-1.4");
- }
-
- /**
- * Abstraction of the file system to perform JDK installation.
- * Consider {@link JDKInstaller.FilePathFileSystem} as the canonical documentation of the contract.
- */
- public interface FileSystem {
- void delete(String file) throws IOException, InterruptedException;
- void chmod(String file,int mode) throws IOException, InterruptedException;
- InputStream read(String file) throws IOException, InterruptedException;
- /**
- * List sub-directories of the given directory and just return the file name portion.
- */
- List<String> listSubDirectories(String dir) throws IOException, InterruptedException;
- void pullUp(String from, String to) throws IOException, InterruptedException;
- }
-
- /*package*/ static final class FilePathFileSystem implements FileSystem {
- private final Node node;
-
- FilePathFileSystem(Node node) {
- this.node = node;
- }
-
- public void delete(String file) throws IOException, InterruptedException {
- $(file).delete();
- }
-
- public void chmod(String file, int mode) throws IOException, InterruptedException {
- $(file).chmod(mode);
- }
-
- public InputStream read(String file) throws IOException, InterruptedException {
- return $(file).read();
- }
-
- public List<String> listSubDirectories(String dir) throws IOException, InterruptedException {
- List<String> r = new ArrayList<String>();
- for( FilePath f : $(dir).listDirectories())
- r.add(f.getName());
- return r;
- }
-
- public void pullUp(String from, String to) throws IOException, InterruptedException {
- $(from).moveAllChildrenTo($(to));
- }
-
- private FilePath $(String file) {
- return node.createPath(file);
- }
- }
-
- /**
- * This is where we locally cache this JDK.
- */
- private File getLocalCacheFile(Platform platform, CPU cpu) {
- return new File(Jenkins.getInstance().getRootDir(),"cache/jdks/"+platform+"/"+cpu+"/"+id);
- }
-
- /**
- * Performs a license click through and obtains the one-time URL for downloading bits.
- */
- public URL locate(TaskListener log, Platform platform, CPU cpu) throws IOException {
- File cache = getLocalCacheFile(platform, cpu);
- if (cache.exists() && cache.length()>1*1024*1024) return cache.toURL(); // if the file is too small, don't trust it. In the past, the download site served error message in 200 status code
-
- log.getLogger().println("Installing JDK "+id);
- JDKFamilyList families = JDKList.all().get(JDKList.class).toList();
- if (families.isEmpty())
- throw new IOException("JDK data is empty.");
-
- JDKRelease release = families.getRelease(id);
- if (release==null)
- throw new IOException("Unable to find JDK with ID="+id);
-
- JDKFile primary=null,secondary=null;
- for (JDKFile f : release.files) {
- String vcap = f.name.toUpperCase(Locale.ENGLISH);
-
- // JDK files have either 'windows', 'linux', or 'solaris' in its name, so that allows us to throw
- // away unapplicable stuff right away
- if(!platform.is(vcap))
- continue;
-
- switch (cpu.accept(vcap)) {
- case PRIMARY: primary = f;break;
- case SECONDARY: secondary=f;break;
- case UNACCEPTABLE: break;
- }
- }
-
- if(primary==null) primary=secondary;
- if(primary==null)
- throw new AbortException("Couldn't find the right download for "+platform+" and "+ cpu +" combination");
- LOGGER.fine("Platform choice:"+primary);
-
- log.getLogger().println("Downloading JDK from "+primary.filepath);
-
- HttpClient hc = new HttpClient();
- hc.getParams().setParameter("http.useragent","Mozilla/5.0 (Windows; U; MSIE 9.0; Windows NT 9.0; en-US)");
- ProxyConfiguration jpc = Jenkins.getInstance().proxy;
- if(jpc != null) {
- hc.getHostConfiguration().setProxy(jpc.name, jpc.port);
- if(jpc.getUserName() != null)
- hc.getState().setProxyCredentials(AuthScope.ANY,new UsernamePasswordCredentials(jpc.getUserName(),jpc.getPassword()));
- }
-
- int authCount=0, totalPageCount=0; // counters for avoiding infinite loop
-
- HttpMethodBase m = new GetMethod(primary.filepath);
- hc.getState().addCookie(new Cookie(".oracle.com","gpw_e24",".", "/", -1, false));
- hc.getState().addCookie(new Cookie(".oracle.com","oraclelicense","accept-securebackup-cookie", "/", -1, false));
- try {
- while (true) {
- if (totalPageCount++>16) // looping too much
- throw new IOException("Unable to find the login form");
-
- LOGGER.fine("Requesting " + m.getURI());
- int r = hc.executeMethod(m);
- if (r/100==3) {
- // redirect?
- String loc = m.getResponseHeader("Location").getValue();
- m.releaseConnection();
- m = new GetMethod(loc);
- continue;
- }
- if (r!=200)
- throw new IOException("Failed to request " + m.getURI() +" exit code="+r);
-
- if (m.getURI().getHost().equals("login.oracle.com")) {
- /* Oracle switched from old to new, and then back to old. This code should work for either.
- * Old Login flow:
- * 1. /mysso/signon.jsp: Form for username + password: Submit actions is:
- * 2. /oam/server/sso/auth_cred_submit: Returns a 302 to:
- * 3. https://edelivery.oracle.com/osso_login_success: Returns a 302 to the download.
- * New Login flow:
- * 1. /oaam_server/oamLoginPage.jsp: Form for username + password. Submit action is:
- * 2. /oaam_server/login.do: Returns a 302 to:
- * 3. /oaam_server/loginAuth.do: After 2 seconds, JS sets window.location to:
- * 4. /oaam_server/authJump.do: Contains a single form with hidden inputs and JS that submits the form to:
- * 5. /oam/server/dap/cred_submit: Returns a 302 to:
- * 6. https://edelivery.oracle.com/osso_login_success: Returns a 302 to the download.
- */
- if (m.getURI().getPath().contains("/loginAuth.do")) {
- try {
- Thread.sleep(2000);
- m.releaseConnection();
- m = new GetMethod(new URI(m.getURI(), "/oaam_server/authJump.do?jump=false", true).toString());
- continue;
- } catch (InterruptedException x) {
- throw new IOException("Interrupted while logging in", x);
- }
- }
-
- LOGGER.fine("Appears to be a login page");
- String resp = IOUtils.toString(m.getResponseBodyAsStream(), m.getResponseCharSet());
- m.releaseConnection();
- Matcher pm = Pattern.compile("<form .*?action=\"([^\"]*)\".*?</form>", Pattern.DOTALL).matcher(resp);
- if (!pm.find())
- throw new IllegalStateException("Unable to find a form in the response:\n"+resp);
-
- String form = pm.group();
- PostMethod post = new PostMethod(
- new URL(new URL(m.getURI().getURI()),pm.group(1)).toExternalForm());
-
- if (m.getURI().getPath().contains("/authJump.do")) {
- m = post;
- continue;
- }
-
- String u = getDescriptor().getUsername();
- Secret p = getDescriptor().getPassword();
- if (u==null || p==null) {
- log.hyperlink(getCredentialPageUrl(),"Oracle now requires Oracle account to download previous versions of JDK. Please specify your Oracle account username/password.\n");
- throw new AbortException("Unable to install JDK unless a valid Oracle account username/password is provided in the system configuration.");
- }
-
- for (String fragment : form.split("<input")) {
- String n = extractAttribute(fragment,"name");
- String v = extractAttribute(fragment,"value");
- if (n==null || v==null) continue;
- if (n.equals("userid") || n.equals("ssousername"))
- v = u;
- if (n.equals("pass") || n.equals("password")) {
- v = p.getPlainText();
- if (authCount++ > 3) {
- log.hyperlink(getCredentialPageUrl(),"Your Oracle account doesn't appear valid. Please specify a valid username/password\n");
- throw new AbortException("Unable to install JDK unless a valid username/password is provided.");
- }
- }
- post.addParameter(n, v);
- }
-
- m = post;
- } else {
- log.getLogger().println("Downloading " + m.getResponseContentLength() + " bytes");
-
- // download to a temporary file and rename it in to handle concurrency and failure correctly,
- File tmp = new File(cache.getPath()+".tmp");
- try {
- tmp.getParentFile().mkdirs();
- try (OutputStream out = Files.newOutputStream(tmp.toPath())) {
- IOUtils.copy(m.getResponseBodyAsStream(), out);
- } catch (InvalidPathException e) {
- throw new IOException(e);
- }
-
- tmp.renameTo(cache);
- return cache.toURL();
- } finally {
- tmp.delete();
- }
- }
- }
- } finally {
- m.releaseConnection();
- }
- }
-
- private static String extractAttribute(String s, String name) {
- String h = name + "=\"";
- int si = s.indexOf(h);
- if (si<0) return null;
- int ei = s.indexOf('\"',si+h.length());
- return s.substring(si+h.length(),ei);
- }
-
- private String getCredentialPageUrl() {
- return "/"+getDescriptor().getDescriptorUrl()+"/enterCredential";
- }
-
- public enum Preference {
- PRIMARY, SECONDARY, UNACCEPTABLE
- }
-
- /**
- * Supported platform.
- */
- public enum Platform {
- LINUX("jdk.sh"), SOLARIS("jdk.sh"), WINDOWS("jdk.exe"), OSX("jdk.dmg");
-
- /**
- * Choose the file name suitable for the downloaded JDK bundle.
- */
- public final String bundleFileName;
-
- Platform(String bundleFileName) {
- this.bundleFileName = bundleFileName;
- }
-
- public boolean is(String line) {
- return line.contains(name());
- }
-
- /**
- * Determines the platform of the given node.
- */
- public static Platform of(Node n) throws IOException,InterruptedException,DetectionFailedException {
- return n.getChannel().call(new GetCurrentPlatform());
- }
-
- public static Platform current() throws DetectionFailedException {
- String arch = System.getProperty("os.name").toLowerCase(Locale.ENGLISH);
- if(arch.contains("linux")) return LINUX;
- if(arch.contains("windows")) return WINDOWS;
- if(arch.contains("sun") || arch.contains("solaris")) return SOLARIS;
- if(arch.contains("mac")) return OSX;
- throw new DetectionFailedException("Unknown CPU name: "+arch);
- }
-
- static class GetCurrentPlatform extends MasterToSlaveCallable<Platform,DetectionFailedException> {
- private static final long serialVersionUID = 1L;
- public Platform call() throws DetectionFailedException {
- return current();
- }
- }
-
- }
-
- /**
- * CPU type.
- */
- public enum CPU {
- i386, amd64, Sparc, Itanium;
-
- /**
- * In JDK5u3, I see platform like "Linux AMD64", while JDK6u3 refers to "Linux x64", so
- * just use "64" for locating bits.
- */
- public Preference accept(String line) {
- switch (this) {
- // these two guys are totally incompatible with everything else, so no fallback
- case Sparc: return must(line.contains("SPARC"));
- case Itanium: return must(line.contains("IA64"));
-
- // 64bit Solaris, Linux, and Windows can all run 32bit executable, so fall back to 32bit if 64bit bundle is not found
- case amd64:
- if(line.contains("SPARC") || line.contains("IA64")) return UNACCEPTABLE;
- if(line.contains("64")) return PRIMARY;
- return SECONDARY;
- case i386:
- if(line.contains("64") || line.contains("SPARC") || line.contains("IA64")) return UNACCEPTABLE;
- return PRIMARY;
- }
- return UNACCEPTABLE;
- }
-
- private static Preference must(boolean b) {
- return b ? PRIMARY : UNACCEPTABLE;
- }
-
- /**
- * Determines the CPU of the given node.
- */
- public static CPU of(Node n) throws IOException,InterruptedException, DetectionFailedException {
- return n.getChannel().call(new GetCurrentCPU());
- }
-
- /**
- * Determines the CPU of the current JVM.
- *
- * http://lopica.sourceforge.net/os.html was useful in writing this code.
- */
- public static CPU current() throws DetectionFailedException {
- String arch = System.getProperty("os.arch").toLowerCase(Locale.ENGLISH);
- if(arch.contains("sparc")) return Sparc;
- if(arch.contains("ia64")) return Itanium;
- if(arch.contains("amd64") || arch.contains("86_64")) return amd64;
- if(arch.contains("86")) return i386;
- throw new DetectionFailedException("Unknown CPU architecture: "+arch);
- }
-
- static class GetCurrentCPU extends MasterToSlaveCallable<CPU,DetectionFailedException> {
- private static final long serialVersionUID = 1L;
- public CPU call() throws DetectionFailedException {
- return current();
- }
- }
-
- }
-
- /**
- * Indicates the failure to detect the OS or CPU.
- */
- private static final class DetectionFailedException extends Exception {
- private DetectionFailedException(String message) {
- super(message);
- }
- }
-
- public static final class JDKFamilyList {
- public JDKFamily[] data = new JDKFamily[0];
- public int version;
-
- public boolean isEmpty() {
- for (JDKFamily f : data) {
- if (f.releases.length>0)
- return false;
- }
- return true;
- }
-
- public JDKRelease getRelease(String productCode) {
- for (JDKFamily f : data) {
- for (JDKRelease r : f.releases) {
- if (r.matchesId(productCode))
- return r;
- }
- }
- return null;
- }
- }
-
- public static final class JDKFamily {
- public String name;
- public JDKRelease[] releases;
- }
-
- public static final class JDKRelease {
- /**
- * the list of {@link JDKFile}s
- */
- public JDKFile[] files;
- /**
- * the license path
- */
- public String licpath;
- /**
- * the license title
- */
- public String lictitle;
- /**
- * This maps to the former product code, like "jdk-6u13-oth-JPR"
- */
- public String name;
- /**
- * This is human readable.
- */
- public String title;
-
- /**
- * We used to use IDs like "jdk-6u13-oth-JPR@CDS-CDS_Developer", but Oracle switched to just "jdk-6u13-oth-JPR".
- * This method matches if the specified string matches the name, and it accepts both the old and the new format.
- */
- public boolean matchesId(String rhs) {
- return rhs!=null && (rhs.equals(name) || rhs.startsWith(name+"@"));
- }
- }
-
- public static final class JDKFile {
- public String filepath;
- public String name;
- public String title;
- }
-
- @Override
- public DescriptorImpl getDescriptor() {
- return (DescriptorImpl)super.getDescriptor();
- }
-
- @Extension @Symbol("jdkInstaller")
- public static final class DescriptorImpl extends ToolInstallerDescriptor<JDKInstaller> {
- private String username;
- private Secret password;
-
- public DescriptorImpl() {
- load();
- }
-
- public String getDisplayName() {
- return Messages.JDKInstaller_DescriptorImpl_displayName();
- }
-
- @Override
- public boolean isApplicable(Class<? extends ToolInstallation> toolType) {
- return toolType==JDK.class;
- }
-
- public String getUsername() {
- return username;
- }
-
- public Secret getPassword() {
- return password;
- }
-
- public FormValidation doCheckId(@QueryParameter String value) {
- if (Util.fixEmpty(value) == null)
- return FormValidation.error(Messages.JDKInstaller_DescriptorImpl_doCheckId()); // improve message
- return FormValidation.ok();
- }
-
- /**
- * List of installable JDKs.
- * @return never null.
- */
- public List<JDKFamily> getInstallableJDKs() throws IOException {
- return Arrays.asList(JDKList.all().get(JDKList.class).toList().data);
- }
-
- public FormValidation doCheckAcceptLicense(@QueryParameter boolean value) {
- if (username==null || password==null)
- return FormValidation.errorWithMarkup(Messages.JDKInstaller_RequireOracleAccount(Stapler.getCurrentRequest().getContextPath()+'/'+getDescriptorUrl()+"/enterCredential"));
- if (value) {
- return FormValidation.ok();
- } else {
- return FormValidation.error(Messages.JDKInstaller_DescriptorImpl_doCheckAcceptLicense());
- }
- }
-
- /**
- * Submits the Oracle account username/password.
- */
- @RequirePOST
- public HttpResponse doPostCredential(@QueryParameter String username, @QueryParameter String password) throws IOException, ServletException {
- Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
- this.username = username;
- this.password = Secret.fromString(password);
- save();
- return HttpResponses.redirectTo("credentialOK");
- }
- }
-
- /**
- * JDK list.
- */
- @Extension @Symbol("jdk")
- public static final class JDKList extends Downloadable {
- public JDKList() {
- super(JDKInstaller.class);
- }
-
- public JDKFamilyList toList() throws IOException {
- JSONObject d = getData();
- if(d==null) return new JDKFamilyList();
- return (JDKFamilyList)JSONObject.toBean(d,JDKFamilyList.class);
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public JSONObject reduce (List<JSONObject> jsonObjectList) {
- List<JDKFamily> reducedFamilies = new LinkedList<>();
- int version = 0;
- JsonConfig jsonConfig = new JsonConfig();
- jsonConfig.registerPropertyExclusion(JDKFamilyList.class, "empty");
- jsonConfig.setRootClass(JDKFamilyList.class);
- //collect all JDKFamily objects from the multiple json objects
- for (JSONObject jsonJdkFamilyList : jsonObjectList) {
- JDKFamilyList jdkFamilyList = (JDKFamilyList)JSONObject.toBean(jsonJdkFamilyList, jsonConfig);
- if (version == 0) {
- //we set as version the version of the first update center
- version = jdkFamilyList.version;
- }
- JDKFamily[] jdkFamilies = jdkFamilyList.data;
- reducedFamilies.addAll(Arrays.asList(jdkFamilies));
- }
- //we iterate on the list and reduce it until there are no more duplicates
- //this could be made recursive
- while (hasDuplicates(reducedFamilies, "name")) {
- //create a temporary list to store the tmp result
- List<JDKFamily> tmpReducedFamilies = new LinkedList<>();
- //we need to skip the processed families
- boolean processed [] = new boolean[reducedFamilies.size()];
- for (int i = 0; i < reducedFamilies.size(); i ++ ) {
- if (processed [i] == true) {
- continue;
- }
- JDKFamily data1 = reducedFamilies.get(i);
- boolean hasDuplicate = false;
- for (int j = i + 1; j < reducedFamilies.size(); j ++ ) {
- JDKFamily data2 = reducedFamilies.get(j);
- //if we found a duplicate we need to merge the families
- if (data1.name.equals(data2.name)) {
- hasDuplicate = true;
- processed [j] = true;
- JDKFamily reducedData = reduceData(data1.name, new LinkedList<JDKRelease>(Arrays.asList(data1.releases)), new LinkedList<JDKRelease>(Arrays.asList(data2.releases)));
- tmpReducedFamilies.add(reducedData);
- //after the first duplicate has been found we break the loop since the duplicates are
- //processed two by two
- break;
- }
- }
- //if no duplicate has been found we just insert the whole family in the tmp list
- if (!hasDuplicate) {
- tmpReducedFamilies.add(data1);
- }
- }
- reducedFamilies = tmpReducedFamilies;
- }
- JDKFamilyList jdkFamilyList = new JDKFamilyList();
- jdkFamilyList.version = version;
- jdkFamilyList.data = new JDKFamily[reducedFamilies.size()];
- reducedFamilies.toArray(jdkFamilyList.data);
- JSONObject reducedJdkFamilyList = JSONObject.fromObject(jdkFamilyList, jsonConfig);
- //return the list with no duplicates
- return reducedJdkFamilyList;
- }
-
- private JDKFamily reduceData(String name, List<JDKRelease> releases1, List<JDKRelease> releases2) {
- LinkedList<JDKRelease> reducedReleases = new LinkedList<>();
- for (Iterator<JDKRelease> iterator = releases1.iterator(); iterator.hasNext(); ) {
- JDKRelease release1 = iterator.next();
- boolean hasDuplicate = false;
- for (Iterator<JDKRelease> iterator2 = releases2.iterator(); iterator2.hasNext(); ) {
- JDKRelease release2 = iterator2.next();
- if (release1.name.equals(release2.name)) {
- hasDuplicate = true;
- JDKRelease reducedRelease = reduceReleases(release1, new LinkedList<JDKFile>(Arrays.asList(release1.files)), new LinkedList<JDKFile>(Arrays.asList(release2.files)));
- iterator2.remove();
- reducedReleases.add(reducedRelease);
- //we assume that in one release list there are no duplicates so we stop at the first one
- break;
- }
- }
- if (!hasDuplicate) {
- reducedReleases.add(release1);
- }
- }
- reducedReleases.addAll(releases2);
- JDKFamily reducedFamily = new JDKFamily();
- reducedFamily.name = name;
- reducedFamily.releases = new JDKRelease[reducedReleases.size()];
- reducedReleases.toArray(reducedFamily.releases);
- return reducedFamily;
- }
-
- private JDKRelease reduceReleases(JDKRelease release, List<JDKFile> files1, List<JDKFile> files2) {
- LinkedList<JDKFile> reducedFiles = new LinkedList<>();
- for (Iterator<JDKFile> iterator1 = files1.iterator(); iterator1.hasNext(); ) {
- JDKFile file1 = iterator1.next();
- for (Iterator<JDKFile> iterator2 = files2.iterator(); iterator2.hasNext(); ) {
- JDKFile file2 = iterator2.next();
- if (file1.name.equals(file2.name)) {
- iterator2.remove();
- //we assume the in one file list there are no duplicates so we break after we find the
- //first match
- break;
- }
- }
- }
- reducedFiles.addAll(files1);
- reducedFiles.addAll(files2);
-
- JDKRelease jdkRelease = new JDKRelease();
- jdkRelease.files = new JDKFile[reducedFiles.size()];
- reducedFiles.toArray(jdkRelease.files);
- jdkRelease.name = release.name;
- jdkRelease.licpath = release.licpath;
- jdkRelease.lictitle = release.lictitle;
- jdkRelease.title = release.title;
- return jdkRelease;
- }
- }
-
- private static final Logger LOGGER = Logger.getLogger(JDKInstaller.class.getName());
-}
diff --git a/core/src/main/java/hudson/tools/ToolDescriptor.java b/core/src/main/java/hudson/tools/ToolDescriptor.java
index ad4ac1734a8635b136a470085cd2ea714ade3e33..c39149ceebe3dd675ea7c9572a1b3106a30ae141 100644
--- a/core/src/main/java/hudson/tools/ToolDescriptor.java
+++ b/core/src/main/java/hudson/tools/ToolDescriptor.java
@@ -44,6 +44,8 @@ import org.jvnet.tiger_types.Types;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
+import javax.annotation.Nonnull;
+
/**
* {@link Descriptor} for {@link ToolInstallation}.
*
@@ -57,7 +59,7 @@ public abstract class ToolDescriptor<T extends ToolInstallation> extends Descrip
protected ToolDescriptor() { }
/**
- * @since FIXME
+ * @since 2.102
*/
protected ToolDescriptor(Class<T> clazz) {
super(clazz);
@@ -109,12 +111,12 @@ public abstract class ToolDescriptor<T extends ToolInstallation> extends Descrip
* Lists up {@link ToolPropertyDescriptor}s that are applicable to this {@link ToolInstallation}.
*/
public List<ToolPropertyDescriptor> getPropertyDescriptors() {
- return PropertyDescriptor.<ToolPropertyDescriptor, ToolInstallation>for_(ToolProperty.all(), clazz);
+ return PropertyDescriptor.for_(ToolProperty.all(), clazz);
}
@Override
- public GlobalConfigurationCategory getCategory() {
+ public @Nonnull GlobalConfigurationCategory getCategory() {
return GlobalConfigurationCategory.get(ToolConfigurationCategory.class);
}
diff --git a/core/src/main/java/hudson/tools/ToolInstaller.java b/core/src/main/java/hudson/tools/ToolInstaller.java
index 2aaec73d1d3787244e1e9b776479a2fdf2634698..0a6ef5d07c74d5e5436fc56652556fdb8c71c66b 100644
--- a/core/src/main/java/hudson/tools/ToolInstaller.java
+++ b/core/src/main/java/hudson/tools/ToolInstaller.java
@@ -42,12 +42,14 @@ import org.kohsuke.stapler.DataBoundConstructor;
/**
* An object which can ensure that a generic {@link ToolInstallation} in fact exists on a node.
+ * The properties can be added to {@link ToolInstallation} using the {@link InstallSourceProperty}.
*
* The subclass should have a {@link ToolInstallerDescriptor}.
* A {@code config.jelly} should be provided to customize specific fields;
* {@code <t:label xmlns:t="/hudson/tools"/>} to customize {@code label}.
* @see <a href="http://wiki.jenkins-ci.org/display/JENKINS/Tool+Auto-Installation">Tool Auto-Installation</a>
* @since 1.305
+ * @see InstallSourceProperty
*/
public abstract class ToolInstaller implements Describable<ToolInstaller>, ExtensionPoint {
diff --git a/core/src/main/java/hudson/tools/ZipExtractionInstaller.java b/core/src/main/java/hudson/tools/ZipExtractionInstaller.java
index ba91cfe45763c984eb0e6de05ee817ed51546031..af9bffda1126090623f361f0919fe74e94769d27 100644
--- a/core/src/main/java/hudson/tools/ZipExtractionInstaller.java
+++ b/core/src/main/java/hudson/tools/ZipExtractionInstaller.java
@@ -42,9 +42,11 @@ import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
+import jenkins.model.Jenkins;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;
+import org.kohsuke.stapler.interceptor.RequirePOST;
/**
* Installs a tool into the Hudson working area by downloading and unpacking a ZIP file.
@@ -95,7 +97,10 @@ public class ZipExtractionInstaller extends ToolInstaller {
return Messages.ZipExtractionInstaller_DescriptorImpl_displayName();
}
+ @RequirePOST
public FormValidation doCheckUrl(@QueryParameter String value) {
+ Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);
+
try {
URLConnection conn = ProxyConfiguration.open(new URL(value));
conn.connect();
diff --git a/core/src/main/java/hudson/triggers/SCMTrigger.java b/core/src/main/java/hudson/triggers/SCMTrigger.java
index 682ce987fb813699794044b9e540474d420f351e..e45aa979c13a97a4c5a9ff0be192c2fcb80ec56c 100644
--- a/core/src/main/java/hudson/triggers/SCMTrigger.java
+++ b/core/src/main/java/hudson/triggers/SCMTrigger.java
@@ -37,6 +37,7 @@ import hudson.model.AdministrativeMonitor;
import hudson.model.Cause;
import hudson.model.CauseAction;
import hudson.model.Item;
+import hudson.model.PersistentDescriptor;
import hudson.model.Run;
import hudson.scm.SCM;
import hudson.scm.SCMDescriptor;
@@ -84,6 +85,8 @@ import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
+import javax.annotation.PostConstruct;
+
import static java.util.logging.Level.WARNING;
@@ -211,7 +214,7 @@ public class SCMTrigger extends Trigger<Item> {
}
@Extension @Symbol("pollSCM")
- public static class DescriptorImpl extends TriggerDescriptor {
+ public static class DescriptorImpl extends TriggerDescriptor implements PersistentDescriptor {
private static ThreadFactory threadFactory() {
return new NamingThreadFactory(Executors.defaultThreadFactory(), "SCMTrigger");
@@ -235,13 +238,18 @@ public class SCMTrigger extends Trigger<Item> {
/**
* Max number of threads for SCM polling.
- * 0 for unbounded.
*/
- private int maximumThreads;
+ private int maximumThreads = 10;
- public DescriptorImpl() {
- load();
- resizeThreadPool();
+ private static final int THREADS_LOWER_BOUND = 5;
+ private static final int THREADS_UPPER_BOUND = 100;
+ private static final int THREADS_DEFAULT= 10;
+
+ private Object readResolve() {
+ if (maximumThreads == 0) {
+ maximumThreads = THREADS_DEFAULT;
+ }
+ return this;
}
public boolean isApplicable(Item item) {
@@ -290,8 +298,6 @@ public class SCMTrigger extends Trigger<Item> {
/**
* Gets the number of concurrent threads used for polling.
*
- * @return
- * 0 if unlimited.
*/
public int getPollingThreadCount() {
return maximumThreads;
@@ -299,12 +305,16 @@ public class SCMTrigger extends Trigger<Item> {
/**
* Sets the number of concurrent threads used for SCM polling and resizes the thread pool accordingly
- * @param n number of concurrent threads, zero or less means unlimited, maximum is 100
+ * @param n number of concurrent threads in the range 5..100, outside values will set the to the nearest bound
*/
public void setPollingThreadCount(int n) {
// fool proof
- if(n<0) n=0;
- if(n>100) n=100;
+ if (n < THREADS_LOWER_BOUND) {
+ n = THREADS_LOWER_BOUND;
+ }
+ if (n > THREADS_UPPER_BOUND) {
+ n = THREADS_UPPER_BOUND;
+ }
maximumThreads = n;
@@ -313,7 +323,7 @@ public class SCMTrigger extends Trigger<Item> {
@Restricted(NoExternalUse.class)
public boolean isPollingThreadCountOptionVisible() {
- if (getPollingThreadCount() != 0) {
+ if (getPollingThreadCount() != THREADS_DEFAULT) {
// this is a user who already configured the option
return true;
}
@@ -336,18 +346,19 @@ public class SCMTrigger extends Trigger<Item> {
/**
* Update the {@link ExecutorService} instance.
*/
+ @PostConstruct
/*package*/ synchronized void resizeThreadPool() {
- queue.setExecutors(
- (maximumThreads==0 ? Executors.newCachedThreadPool(threadFactory()) : Executors.newFixedThreadPool(maximumThreads, threadFactory())));
+ queue.setExecutors(Executors.newFixedThreadPool(maximumThreads, threadFactory()));
}
@Override
public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
String t = json.optString("pollingThreadCount",null);
- if(t==null || t.length()==0)
- setPollingThreadCount(0);
- else
+ if (doCheckPollingThreadCount(t).kind != FormValidation.Kind.OK) {
+ setPollingThreadCount(THREADS_DEFAULT);
+ } else {
setPollingThreadCount(Integer.parseInt(t));
+ }
// Save configuration
save();
@@ -356,9 +367,7 @@ public class SCMTrigger extends Trigger<Item> {
}
public FormValidation doCheckPollingThreadCount(@QueryParameter String value) {
- if (value != null && "".equals(value.trim()))
- return FormValidation.ok();
- return FormValidation.validateNonNegativeInteger(value);
+ return FormValidation.validateIntegerInRange(value, THREADS_LOWER_BOUND, THREADS_UPPER_BOUND);
}
/**
@@ -462,7 +471,7 @@ public class SCMTrigger extends Trigger<Item> {
}
/**
- * Used from <tt>polling.jelly</tt> to write annotated polling log to the given output.
+ * Used from {@code polling.jelly} to write annotated polling log to the given output.
*/
public void writePollingLogTo(long offset, XMLOutput out) throws IOException {
// TODO: resurrect compressed log file support
diff --git a/core/src/main/java/hudson/triggers/SafeTimerTask.java b/core/src/main/java/hudson/triggers/SafeTimerTask.java
index e47dfc61e62b52872beaede1f3a03317cf5f5bfe..7e6f89236c74319e6d6475d01c318caf23fc72fb 100644
--- a/core/src/main/java/hudson/triggers/SafeTimerTask.java
+++ b/core/src/main/java/hudson/triggers/SafeTimerTask.java
@@ -24,11 +24,18 @@
package hudson.triggers;
import hudson.model.AperiodicWork;
+import hudson.model.AsyncAperiodicWork;
+import hudson.model.AsyncPeriodicWork;
import hudson.model.PeriodicWork;
import hudson.security.ACL;
+
+import java.io.File;
import java.util.TimerTask;
import java.util.logging.Level;
import java.util.logging.Logger;
+
+import jenkins.model.Jenkins;
+import jenkins.util.SystemProperties;
import jenkins.util.Timer;
import org.acegisecurity.context.SecurityContext;
import org.acegisecurity.context.SecurityContextHolder;
@@ -43,6 +50,20 @@ import org.acegisecurity.context.SecurityContextHolder;
* @since 1.124
*/
public abstract class SafeTimerTask extends TimerTask {
+
+ /**
+ * System property to change the location where (tasks) logging should be sent.
+ * <p><strong>Beware: changing it while Jenkins is running gives no guarantee logs will be sent to the new location
+ * until it is restarted.</strong></p>
+ */
+ static final String LOGS_ROOT_PATH_PROPERTY = SafeTimerTask.class.getName()+".logsTargetDir";
+
+ /**
+ * Local marker to know if the information about using non default root directory for logs has already been logged at least once.
+ * @see #LOGS_ROOT_PATH_PROPERTY
+ */
+ private static boolean ALREADY_LOGGED = false;
+
public final void run() {
// background activity gets system credential,
// just like executors get it.
@@ -58,5 +79,31 @@ public abstract class SafeTimerTask extends TimerTask {
protected abstract void doRun() throws Exception;
+
+ /**
+ * The root path that should be used to put logs related to the tasks running in Jenkins.
+ *
+ * @see AsyncAperiodicWork#getLogFile()
+ * @see AsyncPeriodicWork#getLogFile()
+ * @return the path where the logs should be put.
+ * @since 2.114
+ */
+ public static File getLogsRoot() {
+ String tagsLogsPath = SystemProperties.getString(LOGS_ROOT_PATH_PROPERTY);
+ if (tagsLogsPath == null) {
+ return new File(Jenkins.get().getRootDir(), "logs");
+ } else {
+ Level logLevel = Level.INFO;
+ if (ALREADY_LOGGED) {
+ logLevel = Level.FINE;
+ }
+ LOGGER.log(logLevel,
+ "Using non default root path for tasks logging: {0}. (Beware: no automated migration if you change or remove it again)",
+ LOGS_ROOT_PATH_PROPERTY);
+ ALREADY_LOGGED = true;
+ return new File(tagsLogsPath);
+ }
+ }
+
private static final Logger LOGGER = Logger.getLogger(SafeTimerTask.class.getName());
}
diff --git a/core/src/main/java/hudson/triggers/package.html b/core/src/main/java/hudson/triggers/package.html
index 61cb24e2f8c9e33741387c93eec0dc8471891c38..dd0f97ed8b139052e9766ec36ef5102be207faa3 100644
--- a/core/src/main/java/hudson/triggers/package.html
+++ b/core/src/main/java/hudson/triggers/package.html
@@ -23,5 +23,5 @@ THE SOFTWARE.
-->
<html><head/><body>
-Built-in <a href="Trigger.html"><tt>Trigger</tt></a>s that run periodically to kick a new build.
+Built-in <a href="Trigger.html"><code>Trigger</code></a>s that run periodically to kick a new build.
</body></html>
\ No newline at end of file
diff --git a/core/src/main/java/hudson/util/AbstractTaskListener.java b/core/src/main/java/hudson/util/AbstractTaskListener.java
index b40cfde838793854586317cbc45030795589294f..bb02e99cd000b8c4577e3eedd4502405cc720989 100644
--- a/core/src/main/java/hudson/util/AbstractTaskListener.java
+++ b/core/src/main/java/hudson/util/AbstractTaskListener.java
@@ -13,4 +13,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
@Restricted(NoExternalUse.class)
@RestrictedSince("2.91")
public abstract class AbstractTaskListener implements TaskListener {
+
+ private static final long serialVersionUID = 7217626701881006422L;
+
}
diff --git a/core/src/main/java/hudson/util/ArgumentListBuilder.java b/core/src/main/java/hudson/util/ArgumentListBuilder.java
index 4388a7abb4a54c3a7d9162c08a40603f3567d72e..acc86c16d3804ac92d33a391cabb9d7d7a87028a 100644
--- a/core/src/main/java/hudson/util/ArgumentListBuilder.java
+++ b/core/src/main/java/hudson/util/ArgumentListBuilder.java
@@ -165,7 +165,7 @@ public class ArgumentListBuilder implements Serializable, Cloneable {
/**
* Adds key value pairs as "-Dkey=value -Dkey=value ..."
*
- * <tt>-D</tt> portion is configurable as the 'prefix' parameter.
+ * {@code -D} portion is configurable as the 'prefix' parameter.
* @since 1.114
*/
public ArgumentListBuilder addKeyValuePairs(String prefix, Map<String,String> props) {
diff --git a/core/src/main/java/hudson/util/ClassLoaderSanityThreadFactory.java b/core/src/main/java/hudson/util/ClassLoaderSanityThreadFactory.java
new file mode 100644
index 0000000000000000000000000000000000000000..2977e9bfbd45f5588f180b3cc3d62f18312cfad9
--- /dev/null
+++ b/core/src/main/java/hudson/util/ClassLoaderSanityThreadFactory.java
@@ -0,0 +1,27 @@
+package hudson.util;
+
+import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Explicitly sets the {@link Thread#contextClassLoader} for threads it creates to its own classloader.
+ * This avoids issues where threads are lazily created (ex by invoking {@link java.util.concurrent.ScheduledExecutorService#schedule(Runnable, long, TimeUnit)})
+ * in a context where they would receive a customized {@link Thread#contextClassLoader} that was never meant to be used.
+ *
+ * Commonly this is a problem for Groovy use, where this may result in memory leaks.
+ * @see <a href="https://issues.jenkins-ci.org/browse/JENKINS-49206">JENKINS-49206</a>
+ * @since 2.105
+ */
+public class ClassLoaderSanityThreadFactory implements ThreadFactory {
+ private final ThreadFactory delegate;
+
+ public ClassLoaderSanityThreadFactory(ThreadFactory delegate) {
+ this.delegate = delegate;
+ }
+
+ @Override public Thread newThread(Runnable r) {
+ Thread t = delegate.newThread(r);
+ t.setContextClassLoader(ClassLoaderSanityThreadFactory.class.getClassLoader());
+ return t;
+ }
+}
diff --git a/core/src/main/java/hudson/util/DirScanner.java b/core/src/main/java/hudson/util/DirScanner.java
index a694c7c21b820db408775953416c3b3b6535e133..2551aa0b081a0d6512be0e44d745de9063e60e35 100644
--- a/core/src/main/java/hudson/util/DirScanner.java
+++ b/core/src/main/java/hudson/util/DirScanner.java
@@ -7,7 +7,6 @@ import org.apache.tools.ant.types.FileSet;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
-import java.io.InterruptedIOException;
import java.io.Serializable;
import static hudson.Util.fixEmpty;
@@ -31,19 +30,15 @@ public abstract class DirScanner implements Serializable {
*/
protected final void scanSingle(File f, String relative, FileVisitor visitor) throws IOException {
if (visitor.understandsSymlink()) {
+ String target;
try {
- String target;
- try {
- target = Util.resolveSymlink(f);
- } catch (IOException x) { // JENKINS-13202
- target = null;
- }
- if (target != null) {
- visitor.visitSymlink(f, target, relative);
- return;
- }
- } catch (InterruptedException e) {
- throw (IOException) new InterruptedIOException().initCause(e);
+ target = Util.resolveSymlink(f);
+ } catch (IOException x) { // JENKINS-13202
+ target = null;
+ }
+ if (target != null) {
+ visitor.visitSymlink(f, target, relative);
+ return;
}
}
visitor.visit(f, relative);
diff --git a/core/src/main/java/hudson/util/DoubleLaunchChecker.java b/core/src/main/java/hudson/util/DoubleLaunchChecker.java
index 8bbcdcab08e32bea00469c84195a7772c2d54ae2..6fff568d048914c3657d4b329d22edb8965a927d 100644
--- a/core/src/main/java/hudson/util/DoubleLaunchChecker.java
+++ b/core/src/main/java/hudson/util/DoubleLaunchChecker.java
@@ -47,7 +47,7 @@ import java.lang.management.ManagementFactory;
import java.lang.reflect.Method;
/**
- * Makes sure that no other Hudson uses our <tt>JENKINS_HOME</tt> directory,
+ * Makes sure that no other Hudson uses our {@code JENKINS_HOME} directory,
* to forestall the problem of running multiple instances of Hudson that point to the same data directory.
*
* <p>
diff --git a/core/src/main/java/hudson/util/ErrorObject.java b/core/src/main/java/hudson/util/ErrorObject.java
index def3df9adb9b8b2357ad25ebc69448ef28f9e622..5d4a8593570c0b549b5a364a5bac25e0b5011e48 100644
--- a/core/src/main/java/hudson/util/ErrorObject.java
+++ b/core/src/main/java/hudson/util/ErrorObject.java
@@ -35,7 +35,7 @@ import java.io.IOException;
* Basis for error model objects.
*
* This implementation serves error pages for any requests under its domain. Subclasses are responsible for providing
- * <tt>index</tt> view.
+ * {@code index} view.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/FormFieldValidator.java b/core/src/main/java/hudson/util/FormFieldValidator.java
index 47ba955121b9daf1f2b29e0d0e42103e040fec74..0595afa4a68a80f12ec60235467f3923f7109430 100644
--- a/core/src/main/java/hudson/util/FormFieldValidator.java
+++ b/core/src/main/java/hudson/util/FormFieldValidator.java
@@ -170,8 +170,8 @@ public abstract class FormFieldValidator {
* Sends out a string error message that indicates an error.
*
* @param message
- * Human readable message to be sent. <tt>error(null)</tt>
- * can be used as <tt>ok()</tt>.
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public void error(String message) throws IOException, ServletException {
errorWithMarkup(message==null?null:Util.escape(message));
@@ -209,8 +209,8 @@ public abstract class FormFieldValidator {
* attack.
*
* @param message
- * Human readable message to be sent. <tt>error(null)</tt>
- * can be used as <tt>ok()</tt>.
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public void errorWithMarkup(String message) throws IOException, ServletException {
_errorWithMarkup(message,"error");
diff --git a/core/src/main/java/hudson/util/FormFillFailure.java b/core/src/main/java/hudson/util/FormFillFailure.java
index 8fcf650b7ff9cdd183169a8d7bf04052faade015..16b8e6435a2fc918fe48a731d327694c49d16f68 100644
--- a/core/src/main/java/hudson/util/FormFillFailure.java
+++ b/core/src/main/java/hudson/util/FormFillFailure.java
@@ -40,7 +40,7 @@ import org.kohsuke.stapler.StaplerResponse;
* Represents a failure in a form field doFillXYZ method.
*
* <p>
- * Use one of the factory methods to create an instance, then throw it from your <tt>doFillXyz</tt>
+ * Use one of the factory methods to create an instance, then throw it from your {@code doFillXyz}
* method.
*
* @since 2.50
@@ -117,8 +117,8 @@ public abstract class FormFillFailure extends IOException implements HttpRespons
* This method must be used with care to avoid cross-site scripting
* attack.
*
- * @param message Human readable message to be sent. <tt>error(null)</tt>
- * can be used as <tt>ok()</tt>.
+ * @param message Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public static FormFillFailure errorWithMarkup(String message) {
return _errorWithMarkup(message, FormValidation.Kind.ERROR);
diff --git a/core/src/main/java/hudson/util/FormValidation.java b/core/src/main/java/hudson/util/FormValidation.java
index c95e5d1da81cd3a17c6b5d69f28626429c4b4eeb..90748cf224df2774fcf99d9a8a553f109072a529 100644
--- a/core/src/main/java/hudson/util/FormValidation.java
+++ b/core/src/main/java/hudson/util/FormValidation.java
@@ -66,7 +66,7 @@ import static hudson.Util.*;
* Represents the result of the form field validation.
*
* <p>
- * Use one of the factory methods to create an instance, then return it from your <tt>doCheckXyz</tt>
+ * Use one of the factory methods to create an instance, then return it from your {@code doCheckXyz}
* method. (Via {@link HttpResponse}, the returned object will render the result into {@link StaplerResponse}.)
* This way of designing form field validation allows you to reuse {@code doCheckXyz()} methods
* programmatically as well (by using {@link #kind}.
@@ -77,7 +77,7 @@ import static hudson.Util.*;
* that you may be able to reuse.
*
* <p>
- * Also see <tt>doCheckCvsRoot</tt> in <tt>CVSSCM</tt> as an example.
+ * Also see {@code doCheckCvsRoot} in {@code CVSSCM} as an example.
*
* <p>
* This class extends {@link IOException} so that it can be thrown from a method. This allows one to reuse
@@ -136,8 +136,8 @@ public abstract class FormValidation extends IOException implements HttpResponse
* Sends out a string error message that indicates an error.
*
* @param message
- * Human readable message to be sent. <tt>error(null)</tt>
- * can be used as <tt>ok()</tt>.
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public static FormValidation error(String message) {
return errorWithMarkup(message==null?null: Util.escape(message));
@@ -245,8 +245,8 @@ public abstract class FormValidation extends IOException implements HttpResponse
* attack.
*
* @param message
- * Human readable message to be sent. <tt>error(null)</tt>
- * can be used as <tt>ok()</tt>.
+ * Human readable message to be sent. {@code error(null)}
+ * can be used as {@code ok()}.
*/
public static FormValidation errorWithMarkup(String message) {
return _errorWithMarkup(message,Kind.ERROR);
@@ -393,6 +393,30 @@ public abstract class FormValidation extends IOException implements HttpResponse
}
}
+ /**
+ * Make sure that the given string is an integer in the range specified by the lower and upper bounds (both inclusive)
+ *
+ * @param value the value to check
+ * @param lower the lower bound (inclusive)
+ * @param upper the upper bound (inclusive)
+ *
+ * @since 2.104
+ */
+ public static FormValidation validateIntegerInRange(String value, int lower, int upper) {
+ try {
+ int intValue = Integer.parseInt(value);
+ if (intValue < lower) {
+ return error(hudson.model.Messages.Hudson_MustBeAtLeast(lower));
+ }
+ if (intValue > upper) {
+ return error(hudson.model.Messages.Hudson_MustBeAtMost(upper));
+ }
+ return ok();
+ } catch (NumberFormatException e) {
+ return error(hudson.model.Messages.Hudson_NotANumber());
+ }
+ }
+
/**
* Makes sure that the given string is a positive integer.
*/
diff --git a/core/src/main/java/hudson/util/Function1.java b/core/src/main/java/hudson/util/Function1.java
index c200c28c3a2c7fcee3a829fe7d225eb028c32900..aa7535d5903f75a572c99f39139e526567b7fc17 100644
--- a/core/src/main/java/hudson/util/Function1.java
+++ b/core/src/main/java/hudson/util/Function1.java
@@ -24,7 +24,7 @@
package hudson.util;
/**
- * Unary function <tt>y=f(x)</tt>.
+ * Unary function {@code y=f(x)}.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/HttpResponses.java b/core/src/main/java/hudson/util/HttpResponses.java
index d6b8fb225700ee5860b869d8a5cca84e13b95643..ef731f3ff8252407ef48beeebe6109c2214ae32d 100644
--- a/core/src/main/java/hudson/util/HttpResponses.java
+++ b/core/src/main/java/hudson/util/HttpResponses.java
@@ -89,16 +89,52 @@ public class HttpResponses extends org.kohsuke.stapler.HttpResponses {
return new JSONObjectResponse(data);
}
- /**
- * Set the response as an error response.
- * @param message The error "message" set on the response.
- * @return {@code this} object.
- *
- * @since 2.0
- */
+ /**
+ * Set the response as an error response.
+ * @param message The error "message" set on the response.
+ * @return {@code this} object.
+ *
+ * @since 2.0
+ */
public static HttpResponse errorJSON(@Nonnull String message) {
return new JSONObjectResponse().error(message);
}
+
+ /**
+ * Set the response as an error response plus some data.
+ * @param message The error "message" set on the response.
+ * @param data The data.
+ * @return {@code this} object.
+ *
+ * @since 2.119
+ */
+ public static HttpResponse errorJSON(@Nonnull String message, @Nonnull Map<?,?> data) {
+ return new JSONObjectResponse(data).error(message);
+ }
+
+ /**
+ * Set the response as an error response plus some data.
+ * @param message The error "message" set on the response.
+ * @param data The data.
+ * @return {@code this} object.
+ *
+ * @since 2.115
+ */
+ public static HttpResponse errorJSON(@Nonnull String message, @Nonnull JSONObject data) {
+ return new JSONObjectResponse(data).error(message);
+ }
+
+ /**
+ * Set the response as an error response plus some data.
+ * @param message The error "message" set on the response.
+ * @param data The data.
+ * @return {@code this} object.
+ *
+ * @since 2.115
+ */
+ public static HttpResponse errorJSON(@Nonnull String message, @Nonnull JSONArray data) {
+ return new JSONObjectResponse(data).error(message);
+ }
/**
* {@link net.sf.json.JSONObject} response.
diff --git a/core/src/main/java/hudson/util/HudsonFailedToLoad.java b/core/src/main/java/hudson/util/HudsonFailedToLoad.java
index 72ad0a4f9c629508703a772b9e56885600958496..8347c7a1cf3f5a3e83d795236a634876c72755f9 100644
--- a/core/src/main/java/hudson/util/HudsonFailedToLoad.java
+++ b/core/src/main/java/hudson/util/HudsonFailedToLoad.java
@@ -30,7 +30,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* Model object used to display the generic error when Jenkins start up fails fatally during initialization.
*
* <p>
- * <tt>index.jelly</tt> would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/IOUtils.java b/core/src/main/java/hudson/util/IOUtils.java
index 5022dc021f7ffb0a48e19e6118290d21b61b3000..2bcdf90acbdcea173c3b8f82db7ea0a1cf71f07d 100644
--- a/core/src/main/java/hudson/util/IOUtils.java
+++ b/core/src/main/java/hudson/util/IOUtils.java
@@ -117,7 +117,7 @@ public class IOUtils {
* execute permissions for the owner, group, and others, i.e. the max return value
* is 0777. Consider using {@link Files#getPosixFilePermissions} instead if you only
* care about access permissions.
- *
+ * <p>If the file is symlink, the mode is that of the link target, not the link itself.
* @return a file mode, or -1 if not on Unix
* @throws PosixException if the file could not be statted, e.g. broken symlink
*/
diff --git a/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java b/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
index 1a89b82e6f2f877759f9a8135667ffbf16ea7ddb..c3d34afd4edfbea54d0a2bfe71a5f20b4c297152 100644
--- a/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleAntVersionDetected.java
@@ -33,7 +33,7 @@ import java.net.URL;
* we find out that the container is picking up its own Ant and that's not 1.7.
*
* <p>
- * <tt>index.jelly</tt> would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java b/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
index 92d17d185df650cfbdccf593b35b58bd4c67a6f8..f2e4931d6ab9265a0f3dae05a056953a03dfa3f4 100644
--- a/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleServletVersionDetected.java
@@ -33,7 +33,7 @@ import java.net.URL;
* we find out that the container doesn't support servlet 2.4.
*
* <p>
- * <tt>index.jelly</tt> would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/IncompatibleVMDetected.java b/core/src/main/java/hudson/util/IncompatibleVMDetected.java
index ae690c162bb77dc14ca31b2deeaad13e6bcd71b9..651e5b124950c33efb76cc85e8f057c646df5008 100644
--- a/core/src/main/java/hudson/util/IncompatibleVMDetected.java
+++ b/core/src/main/java/hudson/util/IncompatibleVMDetected.java
@@ -30,7 +30,7 @@ import java.util.Map;
* we find out that XStream is running in pure-java mode.
*
* <p>
- * <tt>index.jelly</tt> would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/InsufficientPermissionDetected.java b/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
index 739e930bb9fed64598d22773c8e496f40e848406..57aea00f22e6479abe2cf45f23b1d0c91695eb15 100644
--- a/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
+++ b/core/src/main/java/hudson/util/InsufficientPermissionDetected.java
@@ -31,7 +31,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* we find that we don't have enough permissions to run.
*
* <p>
- * <tt>index.jelly</tt> would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/Iterators.java b/core/src/main/java/hudson/util/Iterators.java
index 74d82950dc298e8d79b0ccc471dd95d340e12163..8d93d7226212ef01aba818caf5beb60050914ffb 100644
--- a/core/src/main/java/hudson/util/Iterators.java
+++ b/core/src/main/java/hudson/util/Iterators.java
@@ -23,6 +23,7 @@
*/
package hudson.util;
+import com.google.common.annotations.Beta;
import com.google.common.base.Predicates;
import com.google.common.collect.ImmutableList;
@@ -35,6 +36,9 @@ import java.util.AbstractList;
import java.util.Arrays;
import java.util.Set;
import java.util.HashSet;
+import javax.annotation.Nonnull;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
/**
* Varios {@link Iterator} implementations.
@@ -403,4 +407,20 @@ public class Iterators {
public interface CountingPredicate<T> {
boolean apply(int index, T input);
}
+
+ /**
+ * Similar to {@link com.google.common.collect.Iterators#skip} except not {@link Beta}.
+ * @param iterator some iterator
+ * @param count a nonnegative count
+ */
+ @Restricted(NoExternalUse.class)
+ public static void skip(@Nonnull Iterator<?> iterator, int count) {
+ if (count < 0) {
+ throw new IllegalArgumentException();
+ }
+ while (iterator.hasNext() && count-- > 0) {
+ iterator.next();
+ }
+ }
+
}
diff --git a/core/src/main/java/hudson/util/KeyedDataStorage.java b/core/src/main/java/hudson/util/KeyedDataStorage.java
index 49a220b1b245db200a356c90f7bb0c41ea7ed986..18344394551520136eeffd6bc165ac9b9aed3079 100644
--- a/core/src/main/java/hudson/util/KeyedDataStorage.java
+++ b/core/src/main/java/hudson/util/KeyedDataStorage.java
@@ -254,7 +254,7 @@ public abstract class KeyedDataStorage<T,P> {
* Among cache misses, number of times when we had {@link SoftReference}
* but lost its value due to GC.
*
- * <tt>totalQuery-cacheHit-weakRefLost</tt> means cache miss.
+ * {@code totalQuery-cacheHit-weakRefLost} means cache miss.
*/
public final AtomicInteger weakRefLost = new AtomicInteger();
/**
diff --git a/core/src/main/java/hudson/util/LineEndNormalizingWriter.java b/core/src/main/java/hudson/util/LineEndNormalizingWriter.java
index 2a0edee1d031c5124e8cb7f6d3b416f59b45137a..480f71d45973dd8519c6d27536ef47a90fe1a88e 100644
--- a/core/src/main/java/hudson/util/LineEndNormalizingWriter.java
+++ b/core/src/main/java/hudson/util/LineEndNormalizingWriter.java
@@ -31,7 +31,7 @@ import java.io.IOException;
* Finds the lone LF and converts that to CR+LF.
*
* <p>
- * Internet Explorer's <tt>XmlHttpRequest.responseText</tt> seems to
+ * Internet Explorer's {@code XmlHttpRequest.responseText} seems to
* normalize the line end, and if we only send LF without CR, it will
* not recognize that as a new line. To work around this problem,
* we use this filter to always convert LF to CR+LF.
diff --git a/core/src/main/java/hudson/util/ListBoxModel.java b/core/src/main/java/hudson/util/ListBoxModel.java
index 63d7ee7795be2c8e80c99c816b6a2c638d413ef2..fc717cc7ef606d98b6dae9cfacbf7ababd5e0af4 100644
--- a/core/src/main/java/hudson/util/ListBoxModel.java
+++ b/core/src/main/java/hudson/util/ListBoxModel.java
@@ -62,7 +62,7 @@ import java.util.Collection;
*
* <p>
* Other parts of the HTML can initiate the SELECT element update by using the "updateListBox"
- * function, defined in <tt>hudson-behavior.js</tt>. The following example does it
+ * function, defined in {@code hudson-behavior.js}. The following example does it
* when the value of the textbox changes:
*
* <pre>{@code <xmp>
@@ -70,11 +70,11 @@ import java.util.Collection;
* ]]>}
*
*
- * The first argument is the SELECT element or the ID of it (see Prototype.js $(...) function.)
+ * The first argument is the SELECT element or the ID of it (see Prototype.js {@code $(...)} function.)
* The second argument is the URL that returns the options list.
*
*
- * The URL usually maps to the doXXX method on the server, which uses {@link ListBoxModel}
+ * The URL usually maps to the {@code doXXX} method on the server, which uses {@link ListBoxModel}
* for producing option values. See the following example:
*
*
diff --git a/core/src/main/java/hudson/util/NoHomeDir.java b/core/src/main/java/hudson/util/NoHomeDir.java
index cae6089554a16dd95e2af0d1399862daf15422e3..c3d15ea367762b52a65592fa721f5bb176a5cf38 100644
--- a/core/src/main/java/hudson/util/NoHomeDir.java
+++ b/core/src/main/java/hudson/util/NoHomeDir.java
@@ -30,7 +30,7 @@ import java.io.File;
* we couldn't create the home directory.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/NoTempDir.java b/core/src/main/java/hudson/util/NoTempDir.java
index 10cfceb5ac04e446d2bb0c45c1836a8b2130a341..2e6209463dc814ed173c25e477e2665aab46e5b8 100644
--- a/core/src/main/java/hudson/util/NoTempDir.java
+++ b/core/src/main/java/hudson/util/NoTempDir.java
@@ -33,7 +33,7 @@ import java.io.IOException;
* there appears to be no temporary directory.
*
*
- * index.jelly would display a nice friendly error page.
+ * {@code index.jelly} would display a nice friendly error page.
*
* @author Kohsuke Kawaguchi
*/
diff --git a/core/src/main/java/hudson/util/PluginServletFilter.java b/core/src/main/java/hudson/util/PluginServletFilter.java
index 7f7172240acfa70fd74b0bc80b4415f175d402a9..08ab06151193d420d91da07871fb951671301e41 100644
--- a/core/src/main/java/hudson/util/PluginServletFilter.java
+++ b/core/src/main/java/hudson/util/PluginServletFilter.java
@@ -166,7 +166,11 @@ public class PluginServletFilter implements Filter, ExtensionPoint {
@Restricted(NoExternalUse.class)
public static void cleanUp() {
- PluginServletFilter instance = getInstance(Jenkins.getInstance().servletContext);
+ Jenkins jenkins = Jenkins.getInstanceOrNull();
+ if (jenkins == null) {
+ return;
+ }
+ PluginServletFilter instance = getInstance(jenkins.servletContext);
if (instance != null) {
// While we could rely on the current implementation of list being a CopyOnWriteArrayList
// safer to just take an explicit copy of the list and operate on the copy
diff --git a/core/src/main/java/hudson/util/ProcessTree.java b/core/src/main/java/hudson/util/ProcessTree.java
index 95fe237fc32253811d9d308dab3da0aab181218a..e8a24b51b0b3927a40a9914a67df623d89f1aff1 100644
--- a/core/src/main/java/hudson/util/ProcessTree.java
+++ b/core/src/main/java/hudson/util/ProcessTree.java
@@ -43,7 +43,16 @@ import jenkins.security.SlaveToMasterCallable;
import org.jvnet.winp.WinProcess;
import org.jvnet.winp.WinpException;
-import java.io.*;
+import java.io.BufferedReader;
+import java.io.ByteArrayOutputStream;
+import java.io.DataInputStream;
+import java.io.File;
+import java.io.FileFilter;
+import java.io.FileReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.RandomAccessFile;
+import java.io.Serializable;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
@@ -56,6 +65,7 @@ import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
+import java.util.Optional;
import java.util.SortedMap;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -64,7 +74,6 @@ import javax.annotation.CheckForNull;
import static com.sun.jna.Pointer.NULL;
import jenkins.util.SystemProperties;
import static hudson.util.jna.GNUCLibrary.LIBC;
-import static java.util.logging.Level.FINE;
import static java.util.logging.Level.FINER;
import static java.util.logging.Level.FINEST;
import javax.annotation.Nonnull;
@@ -94,9 +103,20 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
* Lazily obtained {@link ProcessKiller}s to be applied on this process tree.
*/
private transient volatile List killers;
+
+ /**
+ * Flag to skip the veto check since there aren't any.
+ */
+ private boolean skipVetoes;
// instantiation only allowed for subtypes in this class
- private ProcessTree() {}
+ private ProcessTree() {
+ skipVetoes = false;
+ }
+
+ private ProcessTree(boolean vetoesExist) {
+ skipVetoes = !vetoesExist;
+ }
/**
* Gets the process given a specific ID, or null if no such process exists.
@@ -133,6 +153,8 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
*/
public abstract void killAll(Map modelEnvVars) throws InterruptedException;
+ private final long softKillWaitSeconds = Integer.getInteger("SoftKillWaitSeconds", 2 * 60); // by default processes get at most 2 minutes to respond to SIGTERM (JENKINS-17116)
+
/**
* Convenience method that does {@link #killAll(Map)} and {@link OSProcess#killRecursively()}.
* This is necessary to reliably kill the process and its descendants, as some OS
@@ -156,22 +178,24 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
try {
VirtualChannel channelToMaster = SlaveComputer.getChannelToMaster();
if (channelToMaster!=null) {
- killers = channelToMaster.call(new SlaveToMasterCallable, IOException>() {
- public List call() throws IOException {
- return new ArrayList(ProcessKiller.all());
- }
- });
+ killers = channelToMaster.call(new ListAll());
} else {
// used in an environment that doesn't support talk-back to the master.
// let's do with what we have.
killers = Collections.emptyList();
}
- } catch (IOException e) {
- LOGGER.log(Level.WARNING, "Failed to obtain killers",e);
+ } catch (IOException | Error e) {
+ LOGGER.log(Level.WARNING, "Failed to obtain killers", e);
killers = Collections.emptyList();
}
return killers;
}
+ private static class ListAll extends SlaveToMasterCallable, IOException> {
+ @Override
+ public List call() throws IOException {
+ return new ArrayList<>(ProcessKiller.all());
+ }
+ }
/**
* Represents a process.
@@ -217,10 +241,11 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
void killByKiller() throws InterruptedException {
for (ProcessKiller killer : getKillers())
try {
- if (killer.kill(this))
+ if (killer.kill(this)) {
break;
- } catch (IOException e) {
- LOGGER.log(Level.WARNING, "Failed to kill pid="+getPid(),e);
+ }
+ } catch (IOException | Error e) {
+ LOGGER.log(Level.WARNING, "Failed to kill pid=" + getPid(), e);
}
}
@@ -239,14 +264,26 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
* null if no one objects killing the process.
*/
protected @CheckForNull VetoCause getVeto() {
- for (ProcessKillingVeto vetoExtension : ProcessKillingVeto.all()) {
- VetoCause cause = vetoExtension.vetoProcessKilling(this);
- if (cause != null) {
- if (LOGGER.isLoggable(FINEST))
- LOGGER.finest("Killing of pid " + getPid() + " vetoed by " + vetoExtension.getClass().getName() + ": " + cause.getMessage());
- return cause;
+ String causeMessage = null;
+
+ // Quick check, does anything exist to check against
+ if (!skipVetoes) {
+ try {
+ VirtualChannel channelToMaster = SlaveComputer.getChannelToMaster();
+ if (channelToMaster!=null) {
+ CheckVetoes vetoCheck = new CheckVetoes(this);
+ causeMessage = channelToMaster.call(vetoCheck);
+ }
+ } catch (IOException e) {
+ LOGGER.log(Level.WARNING, "I/O Exception while checking for vetoes", e);
+ } catch (InterruptedException e) {
+ LOGGER.log(Level.WARNING, "Interrupted Exception while checking for vetoes", e);
}
}
+
+ if (causeMessage != null) {
+ return new VetoCause(causeMessage);
+ }
return null;
}
@@ -298,6 +335,27 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
Object writeReplace() {
return new SerializedProcess(pid);
}
+
+ private class CheckVetoes extends SlaveToMasterCallable {
+ private IOSProcess process;
+
+ public CheckVetoes(IOSProcess processToCheck) {
+ process = processToCheck;
+ }
+
+ @Override
+ public String call() throws IOException {
+ for (ProcessKillingVeto vetoExtension : ProcessKillingVeto.all()) {
+ VetoCause cause = vetoExtension.vetoProcessKilling(process);
+ if (cause != null) {
+ if (LOGGER.isLoggable(FINEST))
+ LOGGER.info("Killing of pid " + getPid() + " vetoed by " + vetoExtension.getClass().getName() + ": " + cause.getMessage());
+ return cause.getMessage();
+ }
+ }
+ return null;
+ }
+ }
}
/**
@@ -336,6 +394,8 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
}
+ /* package */ static Boolean vetoersExist;
+
/**
* Gets the {@link ProcessTree} of the current system
* that JVM runs in, or in the worst case return the default one
@@ -345,17 +405,33 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
if(!enabled)
return DEFAULT;
+ // Check for the existance of vetoers if I don't know already
+ if (vetoersExist == null) {
+ try {
+ VirtualChannel channelToMaster = SlaveComputer.getChannelToMaster();
+ if (channelToMaster != null) {
+ vetoersExist = channelToMaster.call(new DoVetoersExist());
+ }
+ }
+ catch (Exception e) {
+ LOGGER.log(Level.WARNING, "Error while determining if vetoers exist", e);
+ }
+ }
+
+ // Null-check in case the previous call worked
+ boolean vetoes = (vetoersExist == null ? true : vetoersExist);
+
try {
if(File.pathSeparatorChar==';')
- return new Windows();
+ return new Windows(vetoes);
String os = Util.fixNull(System.getProperty("os.name"));
if(os.equals("Linux"))
- return new Linux();
+ return new Linux(vetoes);
if(os.equals("SunOS"))
- return new Solaris();
+ return new Solaris(vetoes);
if(os.equals("Mac OS X"))
- return new Darwin();
+ return new Darwin(vetoes);
} catch (LinkageError e) {
LOGGER.log(Level.WARNING,"Failed to load winp. Reverting to the default",e);
enabled = false;
@@ -363,6 +439,13 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
return DEFAULT;
}
+
+ private static class DoVetoersExist extends SlaveToMasterCallable {
+ @Override
+ public Boolean call() throws IOException {
+ return ProcessKillingVeto.all().size() > 0;
+ }
+ }
//
//
@@ -430,6 +513,8 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
return;
LOGGER.log(FINER, "Killing recursively {0}", getPid());
+ // Firstly try to kill the root process gracefully, then do a forcekill if it does not help (algorithm is described in JENKINS-17116)
+ killSoftly();
p.killRecursively();
killByKiller();
}
@@ -441,10 +526,39 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
}
LOGGER.log(FINER, "Killing {0}", getPid());
+ // Firstly try to kill it gracefully, then do a forcekill if it does not help (algorithm is described in JENKINS-17116)
+ killSoftly();
p.kill();
killByKiller();
}
+ private void killSoftly() throws InterruptedException {
+ // send Ctrl+C to the process
+ try {
+ if (!p.sendCtrlC()) {
+ return;
+ }
+ }
+ catch (WinpException e) {
+ if (LOGGER.isLoggable(Level.FINE)) {
+ LOGGER.log(Level.FINE, "Failed to send CTRL+C to pid=" + getPid(), e);
+ }
+ return;
+ }
+
+ // after that wait for it to cease to exist
+ long deadline = System.nanoTime() + softKillWaitSeconds * 1000000000;
+ int sleepTime = 10; // initially we sleep briefly, then sleep up to 1sec
+ do {
+ if (!p.isRunning()) {
+ break;
+ }
+
+ Thread.sleep(sleepTime);
+ sleepTime = Math.min(sleepTime * 2, 1000);
+ } while (System.nanoTime() < deadline);
+ }
+
@Override
public synchronized List getArguments() {
if(args==null) {
@@ -510,7 +624,9 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
}
private static final class Windows extends Local {
- Windows() {
+ Windows(boolean vetoesExist) {
+ super(vetoesExist);
+
for (final WinProcess p : WinProcess.all()) {
int pid = p.getPid();
if(pid == 0 || pid == 4) continue; // skip the System Idle and System processes
@@ -572,15 +688,13 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
}
static abstract class Unix extends Local {
+ public Unix(boolean vetoersExist) {
+ super(vetoersExist);
+ }
+
@Override
public OSProcess get(Process proc) {
- try {
- return get((Integer) UnixReflection.PID_FIELD.get(proc));
- } catch (IllegalAccessException e) { // impossible
- IllegalAccessError x = new IllegalAccessError();
- x.initCause(e);
- throw x;
- }
+ return get(UnixReflection.pid(proc));
}
public void killAll(Map modelEnvVars) throws InterruptedException {
@@ -593,7 +707,9 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
* {@link ProcessTree} based on /proc.
*/
static abstract class ProcfsUnix extends Unix {
- ProcfsUnix() {
+ ProcfsUnix(boolean vetoersExist) {
+ super(vetoersExist);
+
File[] processes = new File("/proc").listFiles(new FileFilter() {
public boolean accept(File f) {
return f.isDirectory();
@@ -639,12 +755,29 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
* Tries to kill this process.
*/
public void kill() throws InterruptedException {
+ // after sending SIGTERM, wait for the process to cease to exist
+ long deadline = System.nanoTime() + softKillWaitSeconds * 1000000000;
+ kill(deadline);
+ }
+
+ private void kill(long deadline) throws InterruptedException {
if (getVeto() != null)
return;
try {
int pid = getPid();
LOGGER.fine("Killing pid="+pid);
UnixReflection.destroy(pid);
+ // after sending SIGTERM, wait for the process to cease to exist
+ int sleepTime = 10; // initially we sleep briefly, then sleep up to 1sec
+ File status = getFile("status");
+ do {
+ if (!status.exists()) {
+ break; // status is gone, process therefore as well
+ }
+
+ Thread.sleep(sleepTime);
+ sleepTime = Math.min(sleepTime * 2, 1000);
+ } while (System.nanoTime() < deadline);
} catch (IllegalAccessException e) {
// this is impossible
IllegalAccessError x = new IllegalAccessError();
@@ -661,11 +794,22 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
}
public void killRecursively() throws InterruptedException {
+ // after sending SIGTERM, wait for the processes to cease to exist until the deadline
+ long deadline = System.nanoTime() + softKillWaitSeconds * 1000000000;
+ killRecursively(deadline);
+ }
+
+ private void killRecursively(long deadline) throws InterruptedException {
// We kill individual processes of a tree, so handling vetoes inside #kill() is enough for UnixProcess es
LOGGER.fine("Recursively killing pid="+getPid());
- for (OSProcess p : getChildren())
- p.killRecursively();
- kill();
+ for (OSProcess p : getChildren()) {
+ if (p instanceof UnixProcess) {
+ ((UnixProcess)p).killRecursively(deadline);
+ } else {
+ p.killRecursively(); // should not happen, fallback to non-deadline version
+ }
+ }
+ kill(deadline);
}
/**
@@ -678,65 +822,103 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
public abstract List getArguments();
}
+ //TODO: can be replaced by multi-release JAR
/**
* Reflection used in the Unix support.
*/
private static final class UnixReflection {
/**
* Field to access the PID of the process.
+ * Required for Java 8 and older JVMs.
*/
- private static final Field PID_FIELD;
+ private static final Field JAVA8_PID_FIELD;
+
+ /**
+ * Field to access the PID of the process.
+ * Required for Java 9 and above until this is replaced by multi-release JAR.
+ */
+ private static final Method JAVA9_PID_METHOD;
/**
* Method to destroy a process, given pid.
*
* Looking at the JavaSE source code, this is using SIGTERM (15)
*/
- private static final Method DESTROY_PROCESS;
+ private static final Method JAVA8_DESTROY_PROCESS;
+ private static final Method JAVA_9_PROCESSHANDLE_OF;
+ private static final Method JAVA_9_PROCESSHANDLE_DESTROY;
static {
try {
- Class clazz = Class.forName("java.lang.UNIXProcess");
- PID_FIELD = clazz.getDeclaredField("pid");
- PID_FIELD.setAccessible(true);
-
- if (isPreJava8()) {
- DESTROY_PROCESS = clazz.getDeclaredMethod("destroyProcess",int.class);
+ if (isPostJava8()) { // Java 9+
+ Class clazz = Process.class;
+ JAVA9_PID_METHOD = clazz.getMethod("pid");
+ JAVA8_PID_FIELD = null;
+ Class processHandleClazz = Class.forName("java.lang.ProcessHandle");
+ JAVA_9_PROCESSHANDLE_OF = processHandleClazz.getMethod("of", long.class);
+ JAVA_9_PROCESSHANDLE_DESTROY = processHandleClazz.getMethod("destroy");
+ JAVA8_DESTROY_PROCESS = null;
} else {
- DESTROY_PROCESS = clazz.getDeclaredMethod("destroyProcess",int.class, boolean.class);
+ Class clazz = Class.forName("java.lang.UNIXProcess");
+ JAVA8_PID_FIELD = clazz.getDeclaredField("pid");
+ JAVA8_PID_FIELD.setAccessible(true);
+ JAVA9_PID_METHOD = null;
+
+ JAVA8_DESTROY_PROCESS = clazz.getDeclaredMethod("destroyProcess", int.class, boolean.class);
+ JAVA8_DESTROY_PROCESS.setAccessible(true);
+ JAVA_9_PROCESSHANDLE_OF = null;
+ JAVA_9_PROCESSHANDLE_DESTROY = null;
}
- DESTROY_PROCESS.setAccessible(true);
- } catch (ClassNotFoundException e) {
- LinkageError x = new LinkageError();
- x.initCause(e);
- throw x;
- } catch (NoSuchFieldException e) {
- LinkageError x = new LinkageError();
- x.initCause(e);
- throw x;
- } catch (NoSuchMethodException e) {
- LinkageError x = new LinkageError();
- x.initCause(e);
+ } catch (ClassNotFoundException | NoSuchFieldException | NoSuchMethodException e) {
+ LinkageError x = new LinkageError("Cannot initialize reflection for Unix Processes", e);
throw x;
}
}
- public static void destroy(int pid) throws IllegalAccessException, InvocationTargetException {
- if (isPreJava8()) {
- DESTROY_PROCESS.invoke(null, pid);
+ public static void destroy(int pid) throws IllegalAccessException,
+ InvocationTargetException {
+ if (JAVA8_DESTROY_PROCESS != null) {
+ JAVA8_DESTROY_PROCESS.invoke(null, pid, false);
} else {
- DESTROY_PROCESS.invoke(null, pid, false);
+ final Optional handle = (Optional)JAVA_9_PROCESSHANDLE_OF.invoke(null, pid);
+ if (handle.isPresent()) {
+ JAVA_9_PROCESSHANDLE_DESTROY.invoke(handle.get());
+ }
+ }
+ }
+
+ //TODO: We ideally need to update ProcessTree APIs to Support Long (JENKINS-53799).
+ public static int pid(@Nonnull Process proc) {
+ try {
+ if (JAVA8_PID_FIELD != null) {
+ return JAVA8_PID_FIELD.getInt(proc);
+ } else {
+ long pid = (long)JAVA9_PID_METHOD.invoke(proc);
+ if (pid > Integer.MAX_VALUE) {
+ throw new IllegalAccessError("Java 9+ support error (JENKINS-53799). PID is out of Jenkins API bounds: " + pid);
+ }
+ return (int)pid;
+ }
+ } catch (IllegalAccessException | InvocationTargetException e) { // impossible
+ IllegalAccessError x = new IllegalAccessError();
+ x.initCause(e);
+ throw x;
}
}
- private static boolean isPreJava8() {
- int javaVersionAsAnInteger = Integer.parseInt(System.getProperty("java.version").replaceAll("\\.", "").replaceAll("_", "").substring(0, 2));
- return javaVersionAsAnInteger < 18;
+ // Java 9 uses new version format
+ private static boolean isPostJava8() {
+ String javaVersion = System.getProperty("java.version");
+ return !javaVersion.startsWith("1.");
}
}
static class Linux extends ProcfsUnix {
+ public Linux(boolean vetoersExist) {
+ super(vetoersExist);
+ }
+
protected LinuxProcess createProcess(int pid) throws IOException {
return new LinuxProcess(pid);
}
@@ -825,7 +1007,7 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
}
/**
- * Implementation for Solaris that uses /proc.
+ * Implementation for Solaris that uses {@code /proc}.
*
* /proc/PID/psinfo contains a psinfo_t struct. We use it to determine where the
* process arguments and environment are located in PID's address space.
@@ -851,6 +1033,10 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
* when accessing this file.
*/
static class Solaris extends ProcfsUnix {
+ public Solaris(boolean vetoersExist) {
+ super(vetoersExist);
+ }
+
protected OSProcess createProcess(final int pid) throws IOException {
return new SolarisProcess(pid);
}
@@ -1091,7 +1277,9 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
* Implementation for Mac OS X based on sysctl(3).
*/
private static class Darwin extends Unix {
- Darwin() {
+ Darwin(boolean vetoersExist) {
+ super(vetoersExist);
+
String arch = System.getProperty("sun.arch.data.model");
if ("64".equals(arch)) {
sizeOf_kinfo_proc = sizeOf_kinfo_proc_64;
@@ -1103,18 +1291,18 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
kinfo_proc_ppid_offset = kinfo_proc_ppid_offset_32;
}
try {
- IntByReference _ = new IntByReference(sizeOfInt);
+ IntByReference ref = new IntByReference(sizeOfInt);
IntByReference size = new IntByReference(sizeOfInt);
Memory m;
int nRetry = 0;
while(true) {
// find out how much memory we need to do this
- if(LIBC.sysctl(MIB_PROC_ALL,3, NULL, size, NULL, _)!=0)
+ if(LIBC.sysctl(MIB_PROC_ALL,3, NULL, size, NULL, ref)!=0)
throw new IOException("Failed to obtain memory requirement: "+LIBC.strerror(Native.getLastError()));
// now try the real call
m = new Memory(size.getValue());
- if(LIBC.sysctl(MIB_PROC_ALL,3, m, size, NULL, _)!=0) {
+ if(LIBC.sysctl(MIB_PROC_ALL,3, m, size, NULL, ref)!=0) {
if(Native.getLastError()==ENOMEM && nRetry++<16)
continue; // retry
throw new IOException("Failed to call kern.proc.all: "+LIBC.strerror(Native.getLastError()));
@@ -1174,14 +1362,14 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
arguments = new ArrayList();
envVars = new EnvVars();
- IntByReference _ = new IntByReference();
+ IntByReference intByRef = new IntByReference();
IntByReference argmaxRef = new IntByReference(0);
IntByReference size = new IntByReference(sizeOfInt);
// for some reason, I was never able to get sysctlbyname work.
// if(LIBC.sysctlbyname("kern.argmax", argmaxRef.getPointer(), size, NULL, _)!=0)
- if(LIBC.sysctl(new int[]{CTL_KERN,KERN_ARGMAX},2, argmaxRef.getPointer(), size, NULL, _)!=0)
+ if(LIBC.sysctl(new int[]{CTL_KERN,KERN_ARGMAX},2, argmaxRef.getPointer(), size, NULL, intByRef)!=0)
throw new IOException("Failed to get kern.argmax: "+LIBC.strerror(Native.getLastError()));
int argmax = argmaxRef.getValue();
@@ -1219,7 +1407,7 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
}
StringArrayMemory m = new StringArrayMemory(argmax);
size.setValue(argmax);
- if(LIBC.sysctl(new int[]{CTL_KERN,KERN_PROCARGS2,pid},3, m, size, NULL, _)!=0)
+ if(LIBC.sysctl(new int[]{CTL_KERN,KERN_PROCARGS2,pid},3, m, size, NULL, intByRef)!=0)
throw new IOException("Failed to obtain ken.procargs2: "+LIBC.strerror(Native.getLastError()));
@@ -1310,8 +1498,13 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
* (The opposite of {@link Remote}.)
*/
public static abstract class Local extends ProcessTree {
+ @Deprecated
Local() {
}
+
+ Local(boolean vetoesExist) {
+ super(vetoesExist);
+ }
}
/**
@@ -1320,11 +1513,20 @@ public abstract class ProcessTree implements Iterable, IProcessTree,
public static class Remote extends ProcessTree implements Serializable {
private final IProcessTree proxy;
+ @Deprecated
public Remote(ProcessTree proxy, Channel ch) {
this.proxy = ch.export(IProcessTree.class,proxy);
for (Entry e : proxy.processes.entrySet())
processes.put(e.getKey(),new RemoteProcess(e.getValue(),ch));
}
+
+ public Remote(ProcessTree proxy, Channel ch, boolean vetoersExist) {
+ super(vetoersExist);
+
+ this.proxy = ch.export(IProcessTree.class,proxy);
+ for (Entry e : proxy.processes.entrySet())
+ processes.put(e.getKey(),new RemoteProcess(e.getValue(),ch));
+ }
@Override
public OSProcess get(Process proc) {
diff --git a/core/src/main/java/hudson/util/RemotingDiagnostics.java b/core/src/main/java/hudson/util/RemotingDiagnostics.java
index d38fa7170e9b6629263850f0722b6afcedcf9420..447b19a5c99e486617b8305099498ed531e63e48 100644
--- a/core/src/main/java/hudson/util/RemotingDiagnostics.java
+++ b/core/src/main/java/hudson/util/RemotingDiagnostics.java
@@ -153,7 +153,10 @@ public final class RemotingDiagnostics {
* Obtains the heap dump in an HPROF file.
*/
public static FilePath getHeapDump(VirtualChannel channel) throws IOException, InterruptedException {
- return channel.call(new MasterToSlaveCallable() {
+ return channel.call(new GetHeapDump());
+ }
+ private static class GetHeapDump extends MasterToSlaveCallable {
+ @Override
public FilePath call() throws IOException {
final File hprof = File.createTempFile("hudson-heapdump", "hprof");
hprof.delete();
@@ -169,7 +172,6 @@ public final class RemotingDiagnostics {
}
private static final long serialVersionUID = 1L;
- });
}
/**
diff --git a/core/src/main/java/hudson/util/RunList.java b/core/src/main/java/hudson/util/RunList.java
index d9b8adb7dc54fbb56e446337c8e75d97dc5729ea..bdc9cb61f4d6f092178150a51f2f6d0067510705 100644
--- a/core/src/main/java/hudson/util/RunList.java
+++ b/core/src/main/java/hudson/util/RunList.java
@@ -150,7 +150,7 @@ public class RunList extends AbstractList {
public List subList(int fromIndex, int toIndex) {
List r = new ArrayList();
Iterator itr = iterator();
- Iterators.skip(itr,fromIndex);
+ hudson.util.Iterators.skip(itr, fromIndex);
for (int i=toIndex-fromIndex; i>0; i--) {
r.add(itr.next());
}
diff --git a/core/src/main/java/hudson/util/Secret.java b/core/src/main/java/hudson/util/Secret.java
index 599467414e1e6ecbd45cfa8944ba086bb9e7ccba..09c7c683e94ff0c70221d227e2ea75b14160f47c 100644
--- a/core/src/main/java/hudson/util/Secret.java
+++ b/core/src/main/java/hudson/util/Secret.java
@@ -42,6 +42,7 @@ import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.io.IOException;
import java.security.GeneralSecurityException;
+import java.util.logging.Logger;
import java.util.regex.Pattern;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
@@ -64,6 +65,8 @@ import static java.nio.charset.StandardCharsets.UTF_8;
* @author Kohsuke Kawaguchi
*/
public final class Secret implements Serializable {
+ private static final Logger LOGGER = Logger.getLogger(Secret.class.getName());
+
private static final byte PAYLOAD_V1 = 1;
/**
* Unencrypted secret text.
@@ -92,6 +95,8 @@ public final class Secret implements Serializable {
@Override
@Deprecated
public String toString() {
+ final String from = new Throwable().getStackTrace()[1].toString();
+ LOGGER.warning("Use of toString() on hudson.util.Secret from "+from+". Prefer getPlainText() or getEncryptedValue() depending your needs. see https://jenkins.io/redirect/hudson.util.Secret/");
return value;
}
diff --git a/core/src/main/java/hudson/util/Service.java b/core/src/main/java/hudson/util/Service.java
index a979324f33036cfb43a035bed8295e1ff753f077..9d33249909e370cea5405ca77245e00be9e3e5c2 100644
--- a/core/src/main/java/hudson/util/Service.java
+++ b/core/src/main/java/hudson/util/Service.java
@@ -37,7 +37,7 @@ import java.util.logging.Logger;
import static java.util.logging.Level.WARNING;
/**
- * Load classes by looking up META-INF/services.
+ * Load classes by looking up {@code META-INF/services}.
*
* @author Kohsuke Kawaguchi
* @deprecated use {@link ServiceLoader} instead.
@@ -76,7 +76,7 @@ public class Service {
}
/**
- * Look up META-INF/service/SPICLASSNAME from the classloader
+ * Look up {@code META-INF/service/SPICLASSNAME} from the classloader
* and all the discovered classes into the given collection.
*/
public static void load(Class spi, ClassLoader cl, Collection> result) {
diff --git a/core/src/main/java/hudson/util/StreamTaskListener.java b/core/src/main/java/hudson/util/StreamTaskListener.java
index bd2b6dc87e81e689dace83165463abc4b11c176d..b2b2e4fd62e39e11d2764b4cc8350ea54c7566cf 100644
--- a/core/src/main/java/hudson/util/StreamTaskListener.java
+++ b/core/src/main/java/hudson/util/StreamTaskListener.java
@@ -44,6 +44,9 @@ import java.util.logging.Level;
import java.util.logging.Logger;
import org.kohsuke.stapler.framework.io.WriterOutputStream;
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
+
// TODO: AbstractTaskListener is empty now, but there are dependencies on that e.g. Ruby Runtime - JENKINS-48116)
// The change needs API deprecation policy or external usages cleanup.
@@ -56,7 +59,9 @@ import org.kohsuke.stapler.framework.io.WriterOutputStream;
* @author Kohsuke Kawaguchi
*/
public class StreamTaskListener extends AbstractTaskListener implements TaskListener, Closeable {
+ @Nonnull
private PrintStream out;
+ @CheckForNull
private Charset charset;
/**
@@ -66,15 +71,15 @@ public class StreamTaskListener extends AbstractTaskListener implements TaskList
* or use {@link #fromStdout()} or {@link #fromStderr()}.
*/
@Deprecated
- public StreamTaskListener(PrintStream out) {
+ public StreamTaskListener(@Nonnull PrintStream out) {
this(out,null);
}
- public StreamTaskListener(OutputStream out) {
+ public StreamTaskListener(@Nonnull OutputStream out) {
this(out,null);
}
- public StreamTaskListener(OutputStream out, Charset charset) {
+ public StreamTaskListener(@Nonnull OutputStream out, @CheckForNull Charset charset) {
try {
if (charset == null)
this.out = (out instanceof PrintStream) ? (PrintStream)out : new PrintStream(out, false);
@@ -87,18 +92,18 @@ public class StreamTaskListener extends AbstractTaskListener implements TaskList
}
}
- public StreamTaskListener(File out) throws IOException {
+ public StreamTaskListener(@Nonnull File out) throws IOException {
this(out,null);
}
- public StreamTaskListener(File out, Charset charset) throws IOException {
+ public StreamTaskListener(@Nonnull File out, @CheckForNull Charset charset) throws IOException {
// don't do buffering so that what's written to the listener
// gets reflected to the file immediately, which can then be
// served to the browser immediately
this(Files.newOutputStream(asPath(out)), charset);
}
- private static Path asPath(File out) throws IOException {
+ private static Path asPath(@Nonnull File out) throws IOException {
try {
return out.toPath();
} catch (InvalidPathException e) {
@@ -115,7 +120,7 @@ public class StreamTaskListener extends AbstractTaskListener implements TaskList
* @throws IOException if the file could not be opened.
* @since 1.651
*/
- public StreamTaskListener(File out, boolean append, Charset charset) throws IOException {
+ public StreamTaskListener(@Nonnull File out, boolean append, @CheckForNull Charset charset) throws IOException {
// don't do buffering so that what's written to the listener
// gets reflected to the file immediately, which can then be
// served to the browser immediately
@@ -127,7 +132,7 @@ public class StreamTaskListener extends AbstractTaskListener implements TaskList
);
}
- public StreamTaskListener(Writer w) throws IOException {
+ public StreamTaskListener(@Nonnull Writer w) throws IOException {
this(new WriterOutputStream(w));
}
@@ -155,7 +160,7 @@ public class StreamTaskListener extends AbstractTaskListener implements TaskList
@Override
public Charset getCharset() {
- return charset;
+ return charset != null ? charset : Charset.defaultCharset();
}
private void writeObject(ObjectOutputStream out) throws IOException {
diff --git a/core/src/main/java/hudson/util/TextFile.java b/core/src/main/java/hudson/util/TextFile.java
index 0ac1326ce7e754699ff0806b0bc204561046060b..bd6904add0960800b060048ddba96fc2d58d162d 100644
--- a/core/src/main/java/hudson/util/TextFile.java
+++ b/core/src/main/java/hudson/util/TextFile.java
@@ -23,25 +23,23 @@
*/
package hudson.util;
-import com.google.common.collect.*;
+import edu.umd.cs.findbugs.annotations.CreatesObligation;
import hudson.Util;
+import jenkins.util.io.LinesStream;
import java.nio.file.Files;
-import java.nio.file.InvalidPathException;
import javax.annotation.Nonnull;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
-import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.RandomAccessFile;
import java.io.Reader;
import java.io.StringWriter;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
-import java.util.Iterator;
/**
* Represents a text file.
@@ -51,9 +49,10 @@ import java.util.Iterator;
* @author Kohsuke Kawaguchi
*/
public class TextFile {
- public final File file;
- public TextFile(File file) {
+ public final @Nonnull File file;
+
+ public TextFile(@Nonnull File file) {
this.file = file;
}
@@ -75,41 +74,38 @@ public class TextFile {
String line;
while ((line = in.readLine()) != null)
w.println(line);
+ } catch (Exception e) {
+ throw new IOException("Failed to fully read " + file, e);
}
return out.toString();
}
/**
- * Parse text file line by line.
+ * @throws RuntimeException in the case of {@link IOException} in {@link #linesStream()}
+ * @deprecated This method does not properly propagate errors and may lead to file descriptor leaks
+ * if the collection is not fully iterated. Use {@link #linesStream()} instead.
*/
- public Iterable lines() {
- return new Iterable() {
- @Override
- public Iterator iterator() {
- try {
- final BufferedReader in = new BufferedReader(new InputStreamReader(
- Files.newInputStream(file.toPath()),"UTF-8"));
-
- return new AbstractIterator() {
- @Override
- protected String computeNext() {
- try {
- String r = in.readLine();
- if (r==null) {
- in.close();
- return endOfData();
- }
- return r;
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
- }
- };
- } catch (IOException | InvalidPathException e) {
- throw new RuntimeException(e);
- }
- }
- };
+ @Deprecated
+ public @Nonnull Iterable lines() {
+ try {
+ return linesStream();
+ } catch (IOException ex) {
+ throw new RuntimeException(ex);
+ }
+ }
+
+ /**
+ * Creates a new {@link jenkins.util.io.LinesStream} of the file.
+ *
+ * Note: The caller is responsible for closing the returned
+ * LinesStream.
+ * @throws IOException if the file cannot be converted to a
+ * {@link java.nio.file.Path} or if the file cannot be opened for reading
+ * @since 2.111
+ */
+ @CreatesObligation
+ public @Nonnull LinesStream linesStream() throws IOException {
+ return new LinesStream(Util.fileToPath(file));
}
/**
diff --git a/core/src/main/java/hudson/util/TimeUnit2.java b/core/src/main/java/hudson/util/TimeUnit2.java
index 36b465764de3cd869544f7aaec26843c46173a11..d2aa5eb3fd27f36e20600582f55dfc6504266945 100644
--- a/core/src/main/java/hudson/util/TimeUnit2.java
+++ b/core/src/main/java/hudson/util/TimeUnit2.java
@@ -36,10 +36,10 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
import java.util.concurrent.TimeUnit;
/**
- * A TimeUnit represents time durations at a given unit of
+ * A {@code TimeUnit} represents time durations at a given unit of
* granularity and provides utility methods to convert across units,
* and to perform timing and delay operations in these units. A
- * TimeUnit does not maintain time information, but only
+ * {@code TimeUnit} does not maintain time information, but only
* helps organize and use time representations that may be maintained
* separately across various contexts. A nanosecond is defined as one
* thousandth of a microsecond, a microsecond as one thousandth of a
@@ -47,7 +47,7 @@ import java.util.concurrent.TimeUnit;
* as sixty seconds, an hour as sixty minutes, and a day as twenty four
* hours.
*
- *
A TimeUnit is mainly used to inform time-based methods
+ *
A {@code TimeUnit} is mainly used to inform time-based methods
* how a given timing parameter should be interpreted. For example,
* the following code will timeout in 50 milliseconds if the {@link
* java.util.concurrent.locks.Lock lock} is not available:
@@ -63,7 +63,7 @@ import java.util.concurrent.TimeUnit;
*
* Note however, that there is no guarantee that a particular timeout
* implementation will be able to notice the passage of time at the
- * same granularity as the given TimeUnit.
+ * same granularity as the given {@code TimeUnit}.
*
* @author Doug Lea
* @deprecated use {@link TimeUnit}. (Java 5 did not have all the units required, so {@link TimeUnit2} was introduced
@@ -188,20 +188,20 @@ public enum TimeUnit2 {
* Convert the given time duration in the given unit to this
* unit. Conversions from finer to coarser granularities
* truncate, so lose precision. For example converting
- * 999 milliseconds to seconds results in
- * 0. Conversions from coarser to finer granularities
+ * {@code 999} milliseconds to seconds results in
+ * {@code 0}. Conversions from coarser to finer granularities
* with arguments that would numerically overflow saturate to
- * Long.MIN_VALUE if negative or Long.MAX_VALUE
+ * {@code Long.MIN_VALUE} if negative or {@code Long.MAX_VALUE}
* if positive.
*
*
For example, to convert 10 minutes to milliseconds, use:
- * TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
+ * {@code TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)}
*
- * @param sourceDuration the time duration in the given sourceUnit
- * @param sourceUnit the unit of the sourceDuration argument
+ * @param sourceDuration the time duration in the given {@code sourceUnit}
+ * @param sourceUnit the unit of the {@code sourceDuration} argument
* @return the converted duration in this unit,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
*/
public long convert(long sourceDuration, TimeUnit2 sourceUnit) {
throw new AbstractMethodError();
@@ -211,31 +211,31 @@ public enum TimeUnit2 {
* Convert the given time duration in the given unit to this
* unit. Conversions from finer to coarser granularities
* truncate, so lose precision. For example converting
- * 999 milliseconds to seconds results in
- * 0. Conversions from coarser to finer granularities
+ * {@code 999} milliseconds to seconds results in
+ * {@code 0}. Conversions from coarser to finer granularities
* with arguments that would numerically overflow saturate to
- * Long.MIN_VALUE if negative or Long.MAX_VALUE
+ * {@code Long.MIN_VALUE} if negative or {@code Long.MAX_VALUE}
* if positive.
*
*
For example, to convert 10 minutes to milliseconds, use:
- * TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)
+ * {@code TimeUnit.MILLISECONDS.convert(10L, TimeUnit.MINUTES)}
*
- * @param sourceDuration the time duration in the given sourceUnit
- * @param sourceUnit the unit of the sourceDuration argument
+ * @param sourceDuration the time duration in the given {@code sourceUnit}
+ * @param sourceUnit the unit of the {@code sourceDuration} argument
* @return the converted duration in this unit,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
*/
public long convert(long sourceDuration, TimeUnit sourceUnit) {
throw new AbstractMethodError();
}
/**
- * Equivalent to NANOSECONDS.convert(duration, this).
+ * Equivalent to {@code NANOSECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toNanos(long duration) {
@@ -243,11 +243,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to MICROSECONDS.convert(duration, this).
+ * Equivalent to {@code MICROSECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toMicros(long duration) {
@@ -255,11 +255,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to MILLISECONDS.convert(duration, this).
+ * Equivalent to {@code MILLISECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toMillis(long duration) {
@@ -267,11 +267,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to SECONDS.convert(duration, this).
+ * Equivalent to {@code SECONDS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toSeconds(long duration) {
@@ -279,11 +279,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to MINUTES.convert(duration, this).
+ * Equivalent to {@code MINUTES.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toMinutes(long duration) {
@@ -291,11 +291,11 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to HOURS.convert(duration, this).
+ * Equivalent to {@code HOURS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration,
- * or Long.MIN_VALUE if conversion would negatively
- * overflow, or Long.MAX_VALUE if it would positively overflow.
+ * or {@code Long.MIN_VALUE} if conversion would negatively
+ * overflow, or {@code Long.MAX_VALUE} if it would positively overflow.
* @see #convert
*/
public long toHours(long duration) {
@@ -303,7 +303,7 @@ public enum TimeUnit2 {
}
/**
- * Equivalent to DAYS.convert(duration, this).
+ * Equivalent to {@code DAYS.convert(duration, this)}.
* @param duration the duration
* @return the converted duration
* @see #convert
@@ -322,11 +322,11 @@ public enum TimeUnit2 {
abstract int excessNanos(long d, long m);
/**
- * Performs a timed Object.wait using this time unit.
+ * Performs a timed {@code Object.wait} using this time unit.
* This is a convenience method that converts timeout arguments
- * into the form required by the Object.wait method.
+ * into the form required by the {@code Object.wait} method.
*
- *
For example, you could implement a blocking poll
+ *
For example, you could implement a blocking {@code poll}
* method (see {@link java.util.concurrent.BlockingQueue#poll BlockingQueue.poll})
* using:
*
@@ -353,9 +353,9 @@ public enum TimeUnit2 {
}
/**
- * Performs a timed Thread.join using this time unit.
+ * Performs a timed {@code Thread.join} using this time unit.
* This is a convenience method that converts time arguments into the
- * form required by the Thread.join method.
+ * form required by the {@code Thread.join} method.
* @param thread the thread to wait for
* @param timeout the maximum time to wait. If less than
* or equal to zero, do not wait at all.
@@ -372,9 +372,9 @@ public enum TimeUnit2 {
}
/**
- * Performs a Thread.sleep using this unit.
+ * Performs a {@code Thread.sleep} using this unit.
* This is a convenience method that converts time arguments into the
- * form required by the Thread.sleep method.
+ * form required by the {@code Thread.sleep} method.
* @param timeout the minimum time to sleep. If less than
* or equal to zero, do not sleep at all.
* @throws InterruptedException if interrupted while sleeping.
diff --git a/core/src/main/java/hudson/util/XStream2.java b/core/src/main/java/hudson/util/XStream2.java
index 41b462df29c5b6d1b65a8737b3a2909af59309f7..d4124ae147442b38fe1160bd2d90bae954c6d04c 100644
--- a/core/src/main/java/hudson/util/XStream2.java
+++ b/core/src/main/java/hudson/util/XStream2.java
@@ -26,6 +26,7 @@ package hudson.util;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.thoughtworks.xstream.XStream;
+import com.thoughtworks.xstream.io.xml.KXml2Driver;
import com.thoughtworks.xstream.mapper.AnnotationMapper;
import com.thoughtworks.xstream.mapper.Mapper;
import com.thoughtworks.xstream.mapper.MapperWrapper;
@@ -53,6 +54,7 @@ import hudson.diagnosis.OldDataMonitor;
import hudson.remoting.ClassFilter;
import hudson.util.xstream.ImmutableSetConverter;
import hudson.util.xstream.ImmutableSortedSetConverter;
+import jenkins.util.xstream.SafeURLConverter;
import jenkins.model.Jenkins;
import hudson.model.Label;
import hudson.model.Result;
@@ -97,7 +99,18 @@ public class XStream2 extends XStream {
*/
private MapperInjectionPoint mapperInjectionPoint;
+ /**
+ * Convenience method so we only have to change the driver in one place
+ * if we switch to something new in the future
+ *
+ * @return a new instance of the HierarchicalStreamDriver we want to use
+ */
+ public static HierarchicalStreamDriver getDefaultDriver() {
+ return new KXml2Driver();
+ }
+
public XStream2() {
+ super(getDefaultDriver());
init();
classOwnership = null;
}
@@ -109,6 +122,7 @@ public class XStream2 extends XStream {
}
XStream2(ClassOwnership classOwnership) {
+ super(getDefaultDriver());
init();
this.classOwnership = classOwnership;
}
@@ -235,6 +249,8 @@ public class XStream2 extends XStream {
registerConverter(new CopyOnWriteMap.Tree.ConverterImpl(getMapper()),10); // needs to override MapConverter
registerConverter(new DescribableList.ConverterImpl(getMapper()),10); // explicitly added to handle subtypes
registerConverter(new Label.ConverterImpl(),10);
+ // SECURITY-637 against URL deserialization
+ registerConverter(new SafeURLConverter(),10);
// this should come after all the XStream's default simpler converters,
// but before reflection-based one kicks in.
@@ -293,7 +309,7 @@ public class XStream2 extends XStream {
*/
public void toXMLUTF8(Object obj, OutputStream out) throws IOException {
Writer w = new OutputStreamWriter(out, Charset.forName("UTF-8"));
- w.write("\n");
+ w.write("\n");
toXML(obj, w);
}
diff --git a/core/src/main/java/hudson/util/io/ParserConfigurator.java b/core/src/main/java/hudson/util/io/ParserConfigurator.java
index 878fba535b030361fdc9be6e527b1c691c621aa9..149e82ba1d799c64aed358b1467ef09b587b1f7b 100644
--- a/core/src/main/java/hudson/util/io/ParserConfigurator.java
+++ b/core/src/main/java/hudson/util/io/ParserConfigurator.java
@@ -78,17 +78,17 @@ public abstract class ParserConfigurator implements ExtensionPoint, Serializable
if (Jenkins.getInstanceOrNull()==null) {
Channel ch = Channel.current();
if (ch!=null)
- all = ch.call(new SlaveToMasterCallable, IOException>() {
-
- private static final long serialVersionUID = -2178106894481500733L;
-
- public Collection call() throws IOException {
- return new ArrayList(all());
- }
- });
+ all = ch.call(new GetParserConfigurators());
} else
all = all();
for (ParserConfigurator pc : all)
pc.configure(reader,context);
}
+ private static class GetParserConfigurators extends SlaveToMasterCallable, IOException> {
+ private static final long serialVersionUID = -2178106894481500733L;
+ @Override
+ public Collection call() throws IOException {
+ return new ArrayList<>(all());
+ }
+ }
}
diff --git a/core/src/main/java/hudson/util/io/ZipArchiver.java b/core/src/main/java/hudson/util/io/ZipArchiver.java
index 9bd58808b28315d5c7468d8ce401fda92d5ede8b..20da13cbc3a842c64586eea98333ff434cf6b134 100644
--- a/core/src/main/java/hudson/util/io/ZipArchiver.java
+++ b/core/src/main/java/hudson/util/io/ZipArchiver.java
@@ -30,6 +30,7 @@ import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import org.apache.tools.zip.ZipEntry;
+import org.apache.tools.zip.Zip64Mode;
import org.apache.tools.zip.ZipOutputStream;
import java.io.File;
@@ -49,6 +50,7 @@ final class ZipArchiver extends Archiver {
ZipArchiver(OutputStream out) {
zip = new ZipOutputStream(out);
zip.setEncoding(System.getProperty("file.encoding"));
+ zip.setUseZip64(Zip64Mode.AsNeeded);
}
public void visit(final File f, final String _relativePath) throws IOException {
diff --git a/core/src/main/java/hudson/util/spring/package.html b/core/src/main/java/hudson/util/spring/package.html
index ef210c114e8f4808a4d41910dc1bad25939b9a6b..fec56708535de67dfa7df2c39f76d320252ff68c 100644
--- a/core/src/main/java/hudson/util/spring/package.html
+++ b/core/src/main/java/hudson/util/spring/package.html
@@ -32,10 +32,10 @@ but modifications are made since then to make the syntax more consistent.
Changes to the original code
Our version has support for getting rid of surrounding "bb.beans { ... }" if the script
- is parsed via the BeanBuilder.parse() method.
+ is parsed via the BeanBuilder.parse() method.
- Anonymous bean definition syntax is changed to bean(CLASS) {...} from
- {CLASS _ -> ...} to increase consistency with named bean definition.
+ Anonymous bean definition syntax is changed to bean(CLASS) {...} from
+ {CLASS _ -> ...} to increase consistency with named bean definition.