|
| 1 | +/* |
| 2 | + * The MIT License |
| 3 | + * |
| 4 | + * Copyright 2023 CloudBees, Inc. |
| 5 | + * |
| 6 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | + * of this software and associated documentation files (the "Software"), to deal |
| 8 | + * in the Software without restriction, including without limitation the rights |
| 9 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | + * copies of the Software, and to permit persons to whom the Software is |
| 11 | + * furnished to do so, subject to the following conditions: |
| 12 | + * |
| 13 | + * The above copyright notice and this permission notice shall be included in |
| 14 | + * all copies or substantial portions of the Software. |
| 15 | + * |
| 16 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 22 | + * THE SOFTWARE. |
| 23 | + */ |
| 24 | + |
| 25 | +package org.jenkinsci.plugins.workflow.libs; |
| 26 | + |
| 27 | +import edu.umd.cs.findbugs.annotations.CheckForNull; |
| 28 | +import edu.umd.cs.findbugs.annotations.NonNull; |
| 29 | +import hudson.AbortException; |
| 30 | +import hudson.Extension; |
| 31 | +import hudson.FilePath; |
| 32 | +import hudson.Functions; |
| 33 | +import hudson.Util; |
| 34 | +import hudson.model.Computer; |
| 35 | +import hudson.model.Item; |
| 36 | +import hudson.model.Job; |
| 37 | +import hudson.model.Node; |
| 38 | +import hudson.model.Run; |
| 39 | +import hudson.model.TaskListener; |
| 40 | +import hudson.model.TopLevelItem; |
| 41 | +import hudson.model.listeners.ItemListener; |
| 42 | +import hudson.scm.SCM; |
| 43 | +import hudson.slaves.WorkspaceList; |
| 44 | +import hudson.util.FormValidation; |
| 45 | +import java.io.File; |
| 46 | +import java.io.IOException; |
| 47 | +import java.io.InterruptedIOException; |
| 48 | +import java.util.Collections; |
| 49 | +import java.util.HashMap; |
| 50 | +import java.util.Map; |
| 51 | +import java.util.concurrent.Callable; |
| 52 | +import java.util.logging.Level; |
| 53 | +import java.util.logging.Logger; |
| 54 | +import java.util.regex.Pattern; |
| 55 | +import jenkins.model.Jenkins; |
| 56 | +import org.jenkinsci.plugins.workflow.steps.scm.GenericSCMStep; |
| 57 | +import org.jenkinsci.plugins.workflow.steps.scm.SCMStep; |
| 58 | +import org.kohsuke.accmod.Restricted; |
| 59 | +import org.kohsuke.accmod.restrictions.DoNotUse; |
| 60 | +import org.kohsuke.stapler.DataBoundSetter; |
| 61 | +import org.kohsuke.stapler.QueryParameter; |
| 62 | +import org.kohsuke.stapler.verb.POST; |
| 63 | + |
| 64 | +/** |
| 65 | + * Functionality common to {@link SCMSourceRetriever} and {@link SCMRetriever}. |
| 66 | + */ |
| 67 | +public abstract class SCMBasedRetriever extends LibraryRetriever { |
| 68 | + |
| 69 | + private static final Logger LOGGER = Logger.getLogger(SCMBasedRetriever.class.getName()); |
| 70 | + |
| 71 | + /** |
| 72 | + * Matches ".." in positions where it would be treated as the parent directory. |
| 73 | + * |
| 74 | + * <p>Used to prevent {@link #libraryPath} from being used for directory traversal. |
| 75 | + */ |
| 76 | + static final Pattern PROHIBITED_DOUBLE_DOT = Pattern.compile("(^|.*[\\\\/])\\.\\.($|[\\\\/].*)"); |
| 77 | + |
| 78 | + private boolean clone; |
| 79 | + |
| 80 | + /** |
| 81 | + * The path to the library inside of the SCM. |
| 82 | + * |
| 83 | + * {@code null} is the default and means that the library is in the root of the repository. Otherwise, the value is |
| 84 | + * considered to be a relative path inside of the repository and always ends in a forward slash |
| 85 | + * |
| 86 | + * @see #setLibraryPath |
| 87 | + */ |
| 88 | + private @CheckForNull String libraryPath; |
| 89 | + |
| 90 | + public boolean isClone() { |
| 91 | + return clone; |
| 92 | + } |
| 93 | + |
| 94 | + @DataBoundSetter public void setClone(boolean clone) { |
| 95 | + this.clone = clone; |
| 96 | + } |
| 97 | + |
| 98 | + public String getLibraryPath() { |
| 99 | + return libraryPath; |
| 100 | + } |
| 101 | + |
| 102 | + @DataBoundSetter public void setLibraryPath(String libraryPath) { |
| 103 | + libraryPath = Util.fixEmptyAndTrim(libraryPath); |
| 104 | + if (libraryPath != null && !libraryPath.endsWith("/")) { |
| 105 | + libraryPath += '/'; |
| 106 | + } |
| 107 | + this.libraryPath = libraryPath; |
| 108 | + } |
| 109 | + |
| 110 | + protected final void doRetrieve(String name, boolean changelog, @NonNull SCM scm, FilePath target, Run<?, ?> run, TaskListener listener) throws Exception { |
| 111 | + if (libraryPath != null && PROHIBITED_DOUBLE_DOT.matcher(libraryPath).matches()) { |
| 112 | + throw new AbortException("Library path may not contain '..'"); |
| 113 | + } |
| 114 | + if (clone && changelog) { |
| 115 | + listener.getLogger().println("WARNING: ignoring request to compute changelog in clone mode"); |
| 116 | + changelog = false; |
| 117 | + } |
| 118 | + // Adapted from CpsScmFlowDefinition: |
| 119 | + SCMStep delegate = new GenericSCMStep(scm); |
| 120 | + delegate.setPoll(false); // TODO we have no API for determining if a given SCMHead is branch-like or tag-like; would we want to turn on polling if the former? |
| 121 | + delegate.setChangelog(changelog); |
| 122 | + Node node = Jenkins.get(); |
| 123 | + if (clone) { |
| 124 | + FilePath tmp = target.sibling(target.getBaseName() + "-checkout"); |
| 125 | + if (tmp == null) { |
| 126 | + throw new IOException(); |
| 127 | + } |
| 128 | + try { |
| 129 | + retrySCMOperation(listener, () -> { |
| 130 | + delegate.checkout(run, tmp, listener, node.createLauncher(listener)); |
| 131 | + return null; |
| 132 | + }); |
| 133 | + LibraryRetriever.dir2Jar(name, libraryPath != null ? tmp.child(libraryPath) : tmp, target, listener); |
| 134 | + } finally { |
| 135 | + tmp.deleteRecursive(); |
| 136 | + FilePath tmp2 = WorkspaceList.tempDir(tmp); |
| 137 | + if (tmp2 != null) { |
| 138 | + tmp2.deleteRecursive(); |
| 139 | + } |
| 140 | + } |
| 141 | + } else { |
| 142 | + FilePath dir; |
| 143 | + if (run.getParent() instanceof TopLevelItem) { |
| 144 | + FilePath baseWorkspace = node.getWorkspaceFor((TopLevelItem) run.getParent()); |
| 145 | + if (baseWorkspace == null) { |
| 146 | + throw new IOException(node.getDisplayName() + " may be offline"); |
| 147 | + } |
| 148 | + String checkoutDirName = LibraryRecord.directoryNameFor(scm.getKey()); |
| 149 | + dir = baseWorkspace.withSuffix(getFilePathSuffix() + "libs").child(checkoutDirName); |
| 150 | + } else { // should not happen, but just in case: |
| 151 | + throw new AbortException("Cannot check out in non-top-level build"); |
| 152 | + } |
| 153 | + Computer computer = node.toComputer(); |
| 154 | + if (computer == null) { |
| 155 | + throw new IOException(node.getDisplayName() + " may be offline"); |
| 156 | + } |
| 157 | + try (WorkspaceList.Lease lease = computer.getWorkspaceList().allocate(dir)) { |
| 158 | + // Write the SCM key to a file as a debugging aid. |
| 159 | + lease.path.withSuffix("-scm-key.txt").write(scm.getKey(), "UTF-8"); |
| 160 | + retrySCMOperation(listener, () -> { |
| 161 | + delegate.checkout(run, lease.path, listener, node.createLauncher(listener)); |
| 162 | + return null; |
| 163 | + }); |
| 164 | + // Cannot add WorkspaceActionImpl to private CpsFlowExecution.flowStartNodeActions; do we care? |
| 165 | + // Copy sources with relevant files from the checkout: |
| 166 | + LibraryRetriever.dir2Jar(name, libraryPath != null ? lease.path.child(libraryPath) : lease.path, target, listener); |
| 167 | + } |
| 168 | + } |
| 169 | + } |
| 170 | + |
| 171 | + protected static <T> T retrySCMOperation(TaskListener listener, Callable<T> task) throws Exception{ |
| 172 | + T ret = null; |
| 173 | + for (int retryCount = Jenkins.get().getScmCheckoutRetryCount(); retryCount >= 0; retryCount--) { |
| 174 | + try { |
| 175 | + ret = task.call(); |
| 176 | + break; |
| 177 | + } |
| 178 | + catch (AbortException e) { |
| 179 | + // abort exception might have a null message. |
| 180 | + // If so, just skip echoing it. |
| 181 | + if (e.getMessage() != null) { |
| 182 | + listener.error(e.getMessage()); |
| 183 | + } |
| 184 | + } |
| 185 | + catch (InterruptedIOException e) { |
| 186 | + throw e; |
| 187 | + } |
| 188 | + catch (Exception e) { |
| 189 | + // checkout error not yet reported |
| 190 | + Functions.printStackTrace(e, listener.error("Checkout failed")); |
| 191 | + } |
| 192 | + |
| 193 | + if (retryCount == 0) // all attempts failed |
| 194 | + throw new AbortException("Maximum checkout retry attempts reached, aborting"); |
| 195 | + |
| 196 | + listener.getLogger().println("Retrying after 10 seconds"); |
| 197 | + Thread.sleep(10000); |
| 198 | + } |
| 199 | + return ret; |
| 200 | + } |
| 201 | + |
| 202 | + // TODO there is WorkspaceList.tempDir but no API to make other variants |
| 203 | + protected static String getFilePathSuffix() { |
| 204 | + return System.getProperty(WorkspaceList.class.getName(), "@"); |
| 205 | + } |
| 206 | + |
| 207 | + protected abstract static class SCMBasedRetrieverDescriptor extends LibraryRetrieverDescriptor { |
| 208 | + |
| 209 | + @POST |
| 210 | + public FormValidation doCheckLibraryPath(@QueryParameter String libraryPath) { |
| 211 | + libraryPath = Util.fixEmptyAndTrim(libraryPath); |
| 212 | + if (libraryPath == null) { |
| 213 | + return FormValidation.ok(); |
| 214 | + } else if (PROHIBITED_DOUBLE_DOT.matcher(libraryPath).matches()) { |
| 215 | + return FormValidation.error(Messages.SCMSourceRetriever_library_path_no_double_dot()); |
| 216 | + } |
| 217 | + return FormValidation.ok(); |
| 218 | + } |
| 219 | + |
| 220 | + } |
| 221 | + |
| 222 | + @Restricted(DoNotUse.class) |
| 223 | + @Extension |
| 224 | + public static class WorkspaceListener extends ItemListener { |
| 225 | + |
| 226 | + @Override |
| 227 | + public void onDeleted(Item item) { |
| 228 | + deleteLibsDir(item, item.getFullName()); |
| 229 | + } |
| 230 | + |
| 231 | + @Override |
| 232 | + public void onLocationChanged(Item item, String oldFullName, String newFullName) { |
| 233 | + deleteLibsDir(item, oldFullName); |
| 234 | + } |
| 235 | + |
| 236 | + private static void deleteLibsDir(Item item, String itemFullName) { |
| 237 | + if (item instanceof Job |
| 238 | + && item.getClass() |
| 239 | + .getName() |
| 240 | + .equals("org.jenkinsci.plugins.workflow.job.WorkflowJob")) { |
| 241 | + synchronized (item) { |
| 242 | + String base = |
| 243 | + expandVariablesForDirectory( |
| 244 | + Jenkins.get().getRawWorkspaceDir(), |
| 245 | + itemFullName, |
| 246 | + item.getRootDir().getPath()); |
| 247 | + FilePath dir = |
| 248 | + new FilePath(new File(base)).withSuffix(getFilePathSuffix() + "libs"); |
| 249 | + try { |
| 250 | + if (dir.isDirectory()) { |
| 251 | + LOGGER.log( |
| 252 | + Level.INFO, |
| 253 | + () -> "Deleting obsolete library workspace " + dir); |
| 254 | + dir.deleteRecursive(); |
| 255 | + } |
| 256 | + } catch (IOException | InterruptedException e) { |
| 257 | + LOGGER.log( |
| 258 | + Level.WARNING, |
| 259 | + e, |
| 260 | + () -> "Could not delete obsolete library workspace " + dir); |
| 261 | + } |
| 262 | + } |
| 263 | + } |
| 264 | + } |
| 265 | + |
| 266 | + private static String expandVariablesForDirectory( |
| 267 | + String base, String itemFullName, String itemRootDir) { |
| 268 | + // If the item is moved, it is too late to look up its original workspace location by |
| 269 | + // the time we get the notification. See: |
| 270 | + // https://github.com/jenkinsci/jenkins/blob/f03183ab09ce5fb8f9f4cc9ccee42a3c3e6b2d3e/core/src/main/java/jenkins/model/Jenkins.java#L2567-L2576 |
| 271 | + Map<String, String> properties = new HashMap<>(); |
| 272 | + properties.put("JENKINS_HOME", Jenkins.get().getRootDir().getPath()); |
| 273 | + properties.put("ITEM_ROOTDIR", itemRootDir); |
| 274 | + properties.put("ITEM_FULLNAME", itemFullName); // legacy, deprecated |
| 275 | + properties.put( |
| 276 | + "ITEM_FULL_NAME", itemFullName.replace(':', '$')); // safe, see JENKINS-12251 |
| 277 | + return Util.replaceMacro(base, Collections.unmodifiableMap(properties)); |
| 278 | + } |
| 279 | + } |
| 280 | + |
| 281 | +} |
0 commit comments