jenkins.scm.api.SCMSourceOwner Java Examples

public void run() {
    for (SCMSource scmSource : ((SCMSourceOwner) project).getSCMSources()) {
        if (scmSource instanceof GitSCMSource) {
            GitSCMSource gitSCMSource = (GitSCMSource) scmSource;
            try {
                if (new URIish(gitSCMSource.getRemote()).equals(new URIish(gitSCMSource.getRemote()))) {
                    if (!gitSCMSource.isIgnoreOnPushNotifications()) {
                        LOGGER.log(Level.FINE, "Notify scmSourceOwner {0} about changes for {1}",
                                   toArray(project.getName(), gitSCMSource.getRemote()));
                        ((SCMSourceOwner) project).onSCMSourceUpdated(scmSource);
                    } else {
                        LOGGER.log(Level.FINE, "Ignore on push notification for scmSourceOwner {0} about changes for {1}",
                                   toArray(project.getName(), gitSCMSource.getRemote()));
                    }
                }
            } catch (URISyntaxException e) {
                // nothing to do
            }
        }
    }
}
 

@Override
public void parseAssociatedNames(Item item, Collection<GitHubRepositoryName> result) {
    if (item instanceof SCMSourceOwner) {
        SCMSourceOwner mp = (SCMSourceOwner) item;
        for (Object o : mp.getSCMSources()) {
            if (o instanceof GitHubSCMSource) {
                GitHubSCMSource gitHubSCMSource = (GitHubSCMSource) o;
                result.add(new GitHubRepositoryName(
                        RepositoryUriResolver.hostnameFromApiUri(gitHubSCMSource.getApiUri()),
                        gitHubSCMSource.getRepoOwner(),
                        gitHubSCMSource.getRepository()));

            }
        }
    }
}
 

@Restricted(NoExternalUse.class)
public ListBoxModel doFillCheckoutCredentialsIdItems(@AncestorInPath SCMSourceOwner context, @QueryParameter String connectionName, @QueryParameter String checkoutCredentialsId) {
    if (context == null && !Jenkins.getInstance().hasPermission(Jenkins.ADMINISTER) ||
            context != null && !context.hasPermission(Item.EXTENDED_READ)) {
        return new StandardListBoxModel().includeCurrentValue(checkoutCredentialsId);
    }

    StandardListBoxModel result = new StandardListBoxModel();
    result.add("- anonymous -", CHECKOUT_CREDENTIALS_ANONYMOUS);
    return result.includeMatchingAs(
            context instanceof Queue.Task
                    ? Tasks.getDefaultAuthenticationOf((Queue.Task) context)
                    : ACL.SYSTEM,
            context,
            StandardUsernameCredentials.class,
            SettingsUtils.gitLabConnectionRequirements(connectionName),
            GitClient.CREDENTIALS_MATCHER
    );
}
 

@Override
public void onAddedTo(@Nonnull Run run) {
    if (run.getParent().getParent() instanceof SCMSourceOwner) {
        // skip multibranch
        return;
    }

    // move polling log from cause to action
    try {
        GitHubPRPollingLogAction action = new GitHubPRPollingLogAction(run);
        FileUtils.writeStringToFile(action.getPollingLogFile(), getPollingLog());
        run.replaceAction(action);
    } catch (IOException e) {
        LOGGER.warn("Failed to persist the polling log", e);
    }
    setPollingLog(null);
}
 

@SuppressWarnings({"rawtypes", "unchecked"})
private void forceScheduling(GitHubSCMRevision scmRevision) throws IOException {
    SCMSourceOwner owner = source.getOwner();
    if (owner instanceof MultiBranchProject) {
        MultiBranchProject mb = (MultiBranchProject) owner;
        BranchProjectFactory pf = mb.getProjectFactory();

        SCMHead scmHead = scmRevision.getHead();
        Job j = mb.getItemByBranchName(scmHead.getName());
        if (j != null) {
            SCMRevision rev = pf.getRevision(j);
            // set current rev to dummy to force scheduling
            if (rev != null && rev.equals(scmRevision)) {
                pf.setRevisionHash(j, new DummyRevision(scmHead));
            }
        }
    }
}
 

@Override
protected boolean isApplicable(@Nullable Item item) {
    if (item instanceof SCMSourceOwner) {
        SCMSourceOwner scmSourceOwner = (SCMSourceOwner) item;
        for (SCMSource source : scmSourceOwner.getSCMSources()) {
            if (source instanceof GitHubSCMSource) {
                GitHubSCMSource gitHubSCMSource = (GitHubSCMSource) source;
                for (GitHubHandler hubHandler : gitHubSCMSource.getHandlers()) {
                    if (hubHandler instanceof GitHubPRHandler) {
                        return true;
                    }
                }
            }
        }
    }

    return false;
}
 

@Override
protected boolean isApplicable(@Nullable Item item) {
    if (item instanceof SCMSourceOwner) {
        SCMSourceOwner scmSourceOwner = (SCMSourceOwner) item;
        for (SCMSource source : scmSourceOwner.getSCMSources()) {
            if (source instanceof GitHubSCMSource) {
                GitHubSCMSource gitHubSCMSource = (GitHubSCMSource) source;
                for (GitHubHandler hubHandler : gitHubSCMSource.getHandlers()) {
                    if (hubHandler instanceof GitHubBranchHandler) {
                        return true;
                    }
                }
            }
        }
    }

    return false;
}
 

public static <ITEM extends Item> Predicate<ITEM> withBranchHandler() {
    return item -> {
        if (item instanceof SCMSourceOwner) {
            SCMSourceOwner scmSourceOwner = (SCMSourceOwner) item;
            for (SCMSource source : scmSourceOwner.getSCMSources()) {
                if (source instanceof GitHubSCMSource) {
                    GitHubSCMSource gitHubSCMSource = (GitHubSCMSource) source;
                    for (GitHubHandler hubHandler : gitHubSCMSource.getHandlers()) {
                        if (hubHandler instanceof GitHubBranchHandler) {
                            return true;
                        }
                    }
                }
            }
        }
        return false;
    };
}
 

@Override
public void onAddedTo(@Nonnull Run run) {
    if (run.getParent().getParent() instanceof SCMSourceOwner) {
        // skip multibranch
        return;
    }

    // move polling log from cause to action
    try {
        GitHubBranchPollingLogAction action = new GitHubBranchPollingLogAction(run);
        writeStringToFile(action.getPollingLogFile(), getPollingLog());
        run.replaceAction(action);
    } catch (IOException ex) {
        LOG.warn("Failed to persist the polling log", ex);
    }
    setPollingLog(null);
}
 

private Item resolveProject(final String projectName, final Iterator<String> restOfPathParts) {
    return ACLUtil.impersonate(ACL.SYSTEM, new ACLUtil.Function<Item>() {
        public Item invoke() {
            final Jenkins jenkins = Jenkins.getInstance();
            if (jenkins != null) {
                Item item = jenkins.getItemByFullName(projectName);
                while (item instanceof ItemGroup<?> && !(item instanceof Job<?, ?> || item instanceof SCMSourceOwner) && restOfPathParts.hasNext()) {
                    item = jenkins.getItem(restOfPathParts.next(), (ItemGroup<?>) item);
                }
                if (item instanceof Job<?, ?> || item instanceof SCMSourceOwner) {
                    return item;
                }
            }
            LOGGER.log(Level.FINE, "No project found: {0}, {1}", toArray(projectName, Joiner.on('/').join(restOfPathParts)));
            return null;
        }
    });
}
 

public ListBoxModel doFillCredentialsIdItems(@AncestorInPath SCMSourceOwner context,
        @QueryParameter String serverName, @QueryParameter String credentialsId) {
    StandardListBoxModel result = new StandardListBoxModel();
    if (context == null) {
        // must have admin if you want the list without a context
        if (!Jenkins.get().hasPermission(Jenkins.ADMINISTER)) {
            result.includeCurrentValue(credentialsId);
            return result;
        }
    } else {
        if (!context.hasPermission(Item.EXTENDED_READ)
                && !context.hasPermission(CredentialsProvider.USE_ITEM)) {
            // must be able to read the configuration or use the item credentials if you
            // want the list
            result.includeCurrentValue(credentialsId);
            return result;
        }
    }
    result.includeEmptyValue();
    result.includeMatchingAs(
            context instanceof Queue.Task ? ((Queue.Task) context).getDefaultAuthentication() : ACL.SYSTEM,
            context, StandardUsernameCredentials.class, fromUri(getServerUrlFromName(serverName)).build(),
            GitClient.CREDENTIALS_MATCHER);
    return result;
}
 

public void execute() {
    if (pushHook.getRepository() != null && pushHook.getRepository().getUrl() == null) {
        LOGGER.log(Level.WARNING, "No repository url found.");
        return;
    }

    if (project instanceof Job<?, ?>) {
        ACL.impersonate(ACL.SYSTEM, new TriggerNotifier(project, secretToken, Jenkins.getAuthentication()) {
            @Override
            protected void performOnPost(GitLabPushTrigger trigger) {
                trigger.onPost(pushHook);
            }
        });
        throw HttpResponses.ok();
    }
    if (project instanceof SCMSourceOwner) {
        ACL.impersonate(ACL.SYSTEM, new SCMSourceOwnerNotifier());
        throw HttpResponses.ok();
    }
    throw HttpResponses.errorWithoutStack(409, "Push Hook is not supported for this project");
}
 

public PersonalAccessToken credentials(SCMSourceOwner owner) {
    return CredentialsMatchers.firstOrNull(
        lookupCredentials(
            PersonalAccessToken.class,
            owner,
            Jenkins.getAuthentication(),
            fromUri(getServerUrlFromName(serverName)).build()
        ), credentials -> credentials instanceof PersonalAccessToken
    );
}
 

private void onDeleted(SCMSourceOwner owner) {
    for (SCMSource source : owner.getSCMSources()) {
        if (source instanceof GitLabSCMSource) {
            unregister((GitLabSCMSource) source, owner);
        }
    }
}
 

@Override
public void onDeleted(Item item) {
    if (item instanceof SCMNavigatorOwner) {
        onDeleted((SCMNavigatorOwner) item);
    }

    if (item instanceof SCMSourceOwner) {
        onDeleted((SCMSourceOwner) item);
    }
}
 

private void onUpdated(Job<?, ?> job) {
    BranchJobProperty property = job.getProperty(BranchJobProperty.class);
    if (property != null && job.getParent() instanceof SCMSourceOwner) {
        // TODO: HACK ALERT! There must/should be a nicer way to do this!
        updateProperties(job, (SCMSourceOwner) job.getParent(), property.getBranch().getSourceId());
    }
}
 

private boolean updateProperties(Job<?, ?> job, SCMSourceOwner sourceOwner, String sourceId) {
    SCMSource source = sourceOwner.getSCMSource(sourceId);
    if (source instanceof GitLabSCMSource) {
        String connectionName = ((GitLabSCMSource) source).getSourceSettings().getConnectionName();
        GitLabConnectionProperty property = job.getProperty(GitLabConnectionProperty.class);
        if (property == null || !connectionName.equals(property.getGitLabConnection())) {
            updateProperties(job, connectionName);
            return true;
        }
    }

    return false;
}
 

private GitHubSCMSource getSource() {
    ItemGroup parent = run.getParent().getParent();
    if (parent instanceof SCMSourceOwner) {
        SCMSourceOwner owner = (SCMSourceOwner)parent;
        for (SCMSource source : owner.getSCMSources()) {
            if (source instanceof GitHubSCMSource) {
                return ((GitHubSCMSource) source);
            }
        }
        throw new IllegalArgumentException(UNABLE_TO_INFER_DATA);
    } else {
        throw new IllegalArgumentException(UNABLE_TO_INFER_DATA);
    }
}
 

/**
 * {@inheritDoc}
 */
@Override
public void afterSave() {
    SCMSourceOwner owner = getOwner();
    if (owner != null) {
        GitHubWebHook.get().registerHookFor(owner);
    }
}
 

private SCMSourceObserver getObserver(Collection<String> names){
    return new SCMSourceObserver() {
        @NonNull
        @Override
        public SCMSourceOwner getContext() {
            return scmSourceOwner;
        }

        @NonNull
        @Override
        public TaskListener getListener() {
            return new LogTaskListener(Logger.getAnonymousLogger(), Level.INFO);
        }

        @NonNull
        @Override
        public ProjectObserver observe(@NonNull String projectName) throws IllegalArgumentException {
            names.add(projectName);
            return new NoOpProjectObserver();
        }

        @Override
        public void addAttribute(@NonNull String key, @Nullable Object value)
                throws IllegalArgumentException, ClassCastException {

        }
    };
}
 

@Override
public void afterSave() {
    SCMSourceOwner owner = getOwner();
    if (nonNull(owner) && getRepoProvider().isManageHooks(this)) {
        getRepoProvider().registerHookFor(this);
    }
}
 

@Override
public void parseAssociatedNames(Item item, Collection<GitHubRepositoryName> result) {
    if (item instanceof SCMSourceOwner) {
        SCMSourceOwner sourceOwner = (SCMSourceOwner) item;
        for (SCMSource source : sourceOwner.getSCMSources()) {
            if (source instanceof GitHubSCMSource) {
                GitHubSCMSource gitHubSCMSource = (GitHubSCMSource) source;
                result.add(gitHubSCMSource.getRepoFullName());
            }
        }
    }
}
 

public StandardCredentials credentials(SCMSourceOwner owner) {
    return CredentialsMatchers.firstOrNull(
            CredentialsProvider.lookupCredentials(
                    StandardCredentials.class,
                    owner,
                    Jenkins.getAuthentication(),
                    URIRequirementBuilder.fromUri(serverUrl).build()
            ),
            CredentialsMatchers.allOf(
                    AuthenticationTokens.matcher(GiteaAuth.class),
                    CredentialsMatchers.withId(credentialsId)
            )
    );
}
 

public FormValidation doCheckCredentialsId(@AncestorInPath SCMSourceOwner context,
                                           @QueryParameter String serverUrl,
                                           @QueryParameter String value)
        throws IOException, InterruptedException {
    if (context == null) {
        if (!Jenkins.get().hasPermission(Jenkins.ADMINISTER)) {
            return FormValidation.ok();
        }
    } else {
        if (!context.hasPermission(Item.EXTENDED_READ)
                && !context.hasPermission(CredentialsProvider.USE_ITEM)) {
            return FormValidation.ok();
        }
    }
    GiteaServer server = GiteaServers.get().findServer(serverUrl);
    if (server == null) {
        return FormValidation.ok();
    }
    if (StringUtils.isBlank(value)) {
        return FormValidation.ok();
    }
    if (CredentialsProvider.listCredentials(
            StandardCredentials.class,
            context,
            context instanceof Queue.Task
                    ? ((Queue.Task) context).getDefaultAuthentication()
                    : ACL.SYSTEM,
            URIRequirementBuilder.fromUri(serverUrl).build(),
            CredentialsMatchers.allOf(
                    CredentialsMatchers.withId(value),
                    AuthenticationTokens.matcher(GiteaAuth.class)

            )).isEmpty()) {
        return FormValidation.error(Messages.GiteaSCMSource_selectedCredentialsMissing());
    }
    return FormValidation.ok();
}
 

public ListBoxModel doFillCredentialsIdItems(@AncestorInPath SCMSourceOwner context,
                                             @QueryParameter String serverUrl,
                                             @QueryParameter String credentialsId) {
    StandardListBoxModel result = new StandardListBoxModel();
    if (context == null) {
        if (!Jenkins.get().hasPermission(Jenkins.ADMINISTER)) {
            // must have admin if you want the list without a context
            result.includeCurrentValue(credentialsId);
            return result;
        }
    } else {
        if (!context.hasPermission(Item.EXTENDED_READ)
                && !context.hasPermission(CredentialsProvider.USE_ITEM)) {
            // must be able to read the configuration or use the item credentials if you want the list
            result.includeCurrentValue(credentialsId);
            return result;
        }
    }
    result.includeEmptyValue();
    result.includeMatchingAs(
            context instanceof Queue.Task ?
                    ((Queue.Task) context).getDefaultAuthentication()
                    : ACL.SYSTEM,
            context,
            StandardCredentials.class,
            URIRequirementBuilder.fromUri(serverUrl).build(),
            AuthenticationTokens.matcher(GiteaAuth.class)
    );
    return result;
}
 

Gitea gitea() throws AbortException {
    GiteaServer server = GiteaServers.get().findServer(serverUrl);
    if (server == null) {
        throw new AbortException("Unknown server: " + serverUrl);
    }
    StandardCredentials credentials = credentials();
    SCMSourceOwner owner = getOwner();
    if (owner != null) {
        CredentialsProvider.track(owner, credentials);
    }
    return Gitea.server(serverUrl)
            .as(AuthenticationTokens.convert(GiteaAuth.class, credentials));
}
 

public FormValidation doCheckCredentialsId(@AncestorInPath SCMSourceOwner context,
                                           @QueryParameter String serverUrl,
                                           @QueryParameter String value)
        throws IOException, InterruptedException {
    if (context == null) {
        if (!Jenkins.get().hasPermission(Jenkins.ADMINISTER)) {
            return FormValidation.ok();
        }
    } else {
        if (!context.hasPermission(Item.EXTENDED_READ)
                && !context.hasPermission(CredentialsProvider.USE_ITEM)) {
            return FormValidation.ok();
        }
    }
    GiteaServer server = GiteaServers.get().findServer(serverUrl);
    if (server == null) {
        return FormValidation.ok();
    }
    if (StringUtils.isBlank(value)) {
        return FormValidation.ok();
    }
    if (CredentialsProvider.listCredentials(
            StandardCredentials.class,
            context,
            context instanceof Queue.Task ?
                    ((Queue.Task) context).getDefaultAuthentication()
                    : ACL.SYSTEM,
            URIRequirementBuilder.fromUri(serverUrl).build(),
            CredentialsMatchers.allOf(
                    CredentialsMatchers.withId(value),
                    AuthenticationTokens.matcher(GiteaAuth.class)

            )).isEmpty()) {
        return FormValidation.error(Messages.GiteaSCMNavigator_selectedCredentialsMissing());
    }
    return FormValidation.ok();
}
 

public ListBoxModel doFillCredentialsIdItems(@AncestorInPath SCMSourceOwner context,
                                             @QueryParameter String serverUrl,
                                             @QueryParameter String credentialsId) {
    StandardListBoxModel result = new StandardListBoxModel();
    if (context == null) {
        if (!Jenkins.get().hasPermission(Jenkins.ADMINISTER)) {
            // must have admin if you want the list without a context
            result.includeCurrentValue(credentialsId);
            return result;
        }
    } else {
        if (!context.hasPermission(Item.EXTENDED_READ)
                && !context.hasPermission(CredentialsProvider.USE_ITEM)) {
            // must be able to read the configuration or use the item credentials if you want the list
            result.includeCurrentValue(credentialsId);
            return result;
        }
    }
    result.includeEmptyValue();
    result.includeMatchingAs(
            context instanceof Queue.Task ?
                    ((Queue.Task) context).getDefaultAuthentication()
                    : ACL.SYSTEM,
            context,
            StandardCredentials.class,
            URIRequirementBuilder.fromUri(serverUrl).build(),
            AuthenticationTokens.matcher(GiteaAuth.class)
    );
    return result;
}
 

@Override
protected boolean isApplicable(Item item) {
    if (item != null && item instanceof Job<?, ?>) {
        Job<?, ?> project = (Job<?, ?>) item;
        if (project.getParent() instanceof SCMSourceOwner) {
            SCMSourceOwner owner = (SCMSourceOwner) project.getParent();
            for (SCMSource source : owner.getSCMSources()) {
                if (source instanceof GitHubSCMSource) {
                    return true;
                }
            }
        }
    }
    return false;
}
 

@Override
protected boolean isApplicable(Item item) {
    if (item != null && item instanceof Job<?, ?>) {
        Job<?, ?> project = (Job<?, ?>) item;
        if (project.getParent() instanceof SCMSourceOwner) {
            SCMSourceOwner owner = (SCMSourceOwner) project.getParent();
            for (SCMSource source : owner.getSCMSources()) {
                if (source instanceof GitHubSCMSource) {
                    return true;
                }
            }
        }
    }
    return false;
}