/*
 * The MIT License
 *
 * Copyright (c) 20020, Autodesk, Inc., Raihaan Shouhell
 *
 * 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.views;

import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.Extension;
import hudson.model.Descriptor;
import hudson.model.TopLevelItem;
import hudson.model.View;
import java.util.ArrayList;
import java.util.List;
import jenkins.model.ParameterizedJobMixIn;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;

/**
 * Job Filter that will filter jobs based on its disabled status
 */
@Restricted(NoExternalUse.class)
public final class StatusFilter extends ViewJobFilter {

    private final boolean statusFilter;

    /**
     * Creates a new status filter based on supplied boolean
     * @param statusFilter true for enabled jobs only and false for disabled jobs only
     */
    @DataBoundConstructor
    public StatusFilter(boolean statusFilter) {
        this.statusFilter = statusFilter;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List<TopLevelItem> filter(List<TopLevelItem> added, List<TopLevelItem> all, View filteringView) {
        List<TopLevelItem> filtered = new ArrayList<>();
        for (TopLevelItem item : added) {
            if (!(item instanceof ParameterizedJobMixIn.ParameterizedJob) // TODO or better to call the more generic Job.isBuildable?
                    || ((ParameterizedJobMixIn.ParameterizedJob<?, ?>) item).isDisabled() ^ statusFilter)
                filtered.add(item);
        }
        return filtered;
    }

    /**
     * The setting of the job status filter
     * @return true if only enabled jobs are shown and false if only disabled jobs are shown
     */
    public boolean getStatusFilter() {
        return statusFilter;
    }

    @Extension
    public static class StatusFilterDescriptor extends Descriptor<ViewJobFilter> {
        public StatusFilterDescriptor() {
            super(StatusFilter.class);
        }

        /**
         * {@inheritDoc}
         */
        @NonNull
        @Override
        public String getDisplayName() {
            return Messages.StatusFilter_DisplayName();
        }
    }
}
