FileWrapper.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 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.
 */
/*
 * Note: this is a direct copy of the FileWrapper from:
 * https://github.com/jenkinsci/pipeline-utility-steps-plugin/raw/master/src/main/java/org/jenkinsci/plugins/pipeline/utility/steps/fs/FileWrapper.java
 * from the "pipeline-utility-steps-plugin".
 */

package de.taimos.pipeline.aws;

/*-
 * #%L
 * Pipeline: AWS Steps
 * %%
 * Copyright (C) 2016 - 2017 Taimos GmbH
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.io.IOException;
import java.io.Serial;
import java.io.Serializable;

import jakarta.annotation.Nonnull;

import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted;

import hudson.FilePath;

/**
 * Contains serializable information about a file name.
 *
 * @author Robert Sandell <rsandell@cloudbees.com>.
 */
public class FileWrapper implements Serializable {
	@Serial
	private static final long serialVersionUID = 1L;
	private static final String PATH_SUFFIX = "/";

	@Nonnull
	private final String name;
	@Nonnull
	private final String path;
	private final boolean directory;
	private final long length;
	private final long lastModified;

	public FileWrapper(@Nonnull String name, @Nonnull String path, boolean directory, long length, long lastModified) {
		this.name = name;
		this.directory = directory;
		this.length = length;
		this.lastModified = lastModified;
		if (directory && !path.endsWith(PATH_SUFFIX)) {
			this.path = path + PATH_SUFFIX;
		} else {
			this.path = path;
		}
	}

	protected FileWrapper(@Nonnull FilePath base, @Nonnull FilePath file) throws IOException, InterruptedException {
		this(file.getName(),
			file.getRemote().substring(base.getRemote().length() + 1),
			file.isDirectory(),
			file.length(),
			file.lastModified()
		);
	}

	protected FileWrapper(@Nonnull FilePath file) throws IOException, InterruptedException {
		this(file.getName(), file.getRemote(), file.isDirectory(), file.length(), file.lastModified());
	}

	@Whitelisted
	@Nonnull
	public String getName() {
		return this.name;
	}

	@Whitelisted
	@Nonnull
	public String getPath() {
		return this.path;
	}

	@Whitelisted
	public boolean isDirectory() {
		return this.directory;
	}

	@Whitelisted
	public long getLength() {
		return this.length;
	}

	@Whitelisted
	public long getLastModified() {
		return this.lastModified;
	}

	@Override
	@Whitelisted
	@Nonnull
	public String toString() {
		return this.getPath();
	}

	@Override
	@Whitelisted
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (!(o instanceof FileWrapper that)) {
			return false;
		}

		return this.getPath().equals(that.getPath());

	}

	@Override
	@Whitelisted
	public int hashCode() {
		return this.getPath().hashCode();
	}
}