Examples with MagicBranch com.google.gerrit.server.util.MagicBranch used on opensource projects

Example 1 with MagicBranch

use of com.google.gerrit.server.util.MagicBranch in project gerrit by GerritCodeReview.

the class ReceiveCommits method requestReplaceAndValidateComments.

/**
 * Update an existing change. If draft comments are to be published, these are validated and may
 * be withheld.
 *
 * @return True if the command succeeded, false if it was rejected.
 */
private boolean requestReplaceAndValidateComments(ReceiveCommand cmd, boolean checkMergedInto, Change change, RevCommit newCommit) throws IOException {
    try (TraceTimer traceTimer = newTimer("requestReplaceAndValidateComments")) {
        if (change.isClosed()) {
            reject(cmd, changeFormatter.changeClosed(ChangeReportFormatter.Input.builder().setChange(change).build()));
            return false;
        }
        ReplaceRequest req = new ReplaceRequest(change.getId(), newCommit, cmd, checkMergedInto);
        if (replaceByChange.containsKey(req.ontoChange)) {
            reject(cmd, "duplicate request");
            return false;
        }
        if (magicBranch != null && magicBranch.shouldPublishComments()) {
            List<HumanComment> drafts = commentsUtil.draftByChangeAuthor(notesFactory.createChecked(change), user.getAccountId());
            ImmutableList<CommentForValidation> draftsForValidation = drafts.stream().map(comment -> CommentForValidation.create(CommentSource.HUMAN, comment.lineNbr > 0 ? CommentType.INLINE_COMMENT : CommentType.FILE_COMMENT, comment.message, comment.message.length())).collect(toImmutableList());
            CommentValidationContext ctx = CommentValidationContext.create(change.getChangeId(), change.getProject().get(), change.getDest().branch());
            ImmutableList<CommentValidationFailure> commentValidationFailures = PublishCommentUtil.findInvalidComments(ctx, commentValidators, draftsForValidation);
            magicBranch.setWithholdComments(!commentValidationFailures.isEmpty());
            commentValidationFailures.forEach(failure -> addMessage("Comment validation failure: " + failure.getMessage(), ValidationMessage.Type.WARNING));
        }
        replaceByChange.put(req.ontoChange, req);
        return true;
    }
}

Example 2 with MagicBranch

use of com.google.gerrit.server.util.MagicBranch in project gerrit by GerritCodeReview.

the class ReceiveCommits method processCommands.

void processCommands(Collection<ReceiveCommand> commands, MultiProgressMonitor progress) {
    newProgress = progress.beginSubTask("new", UNKNOWN);
    replaceProgress = progress.beginSubTask("updated", UNKNOWN);
    closeProgress = progress.beginSubTask("closed", UNKNOWN);
    commandProgress = progress.beginSubTask("refs", UNKNOWN);
    try {
        parseCommands(commands);
    } catch (PermissionBackendException err) {
        for (ReceiveCommand cmd : actualCommands) {
            if (cmd.getResult() == NOT_ATTEMPTED) {
                cmd.setResult(REJECTED_OTHER_REASON, "internal server error");
            }
        }
        logError(String.format("Failed to process refs in %s", project.getName()), err);
    }
    if (magicBranch != null && magicBranch.cmd.getResult() == NOT_ATTEMPTED) {
        selectNewAndReplacedChangesFromMagicBranch();
    }
    preparePatchSetsForReplace();
    insertChangesAndPatchSets();
    newProgress.end();
    replaceProgress.end();
    if (!errors.isEmpty()) {
        logDebug("Handling error conditions: {}", errors.keySet());
        for (Error error : errors.keySet()) {
            rp.sendMessage(buildError(error, errors.get(error)));
        }
        rp.sendMessage(String.format("User: %s", displayName(user)));
        rp.sendMessage(COMMAND_REJECTION_MESSAGE_FOOTER);
    }
    Set<Branch.NameKey> branches = new HashSet<>();
    for (ReceiveCommand c : actualCommands) {
        // involve kicking off an additional BatchUpdate.
        if (c.getResult() != OK) {
            continue;
        }
        if (isHead(c) || isConfig(c)) {
            switch(c.getType()) {
                case CREATE:
                case UPDATE:
                case UPDATE_NONFASTFORWARD:
                    autoCloseChanges(c);
                    branches.add(new Branch.NameKey(project.getNameKey(), c.getRefName()));
                    break;
                case DELETE:
                    break;
            }
        }
    }
    // Update superproject gitlinks if required.
    if (!branches.isEmpty()) {
        try (MergeOpRepoManager orm = ormProvider.get()) {
            orm.setContext(db, TimeUtil.nowTs(), user, receiveId);
            SubmoduleOp op = subOpFactory.create(branches, orm);
            op.updateSuperProjects(batchUpdateFactory);
        } catch (SubmoduleException e) {
            logError("Can't update the superprojects", e);
        }
    }
    closeProgress.end();
    commandProgress.end();
    progress.end();
    reportMessages();
}

Example 3 with MagicBranch

use of com.google.gerrit.server.util.MagicBranch in project gerrit by GerritCodeReview.

the class ReceiveCommits method parseMagicBranch.

private void parseMagicBranch(ReceiveCommand cmd) {
    // Permit exactly one new change request per push.
    if (magicBranch != null) {
        reject(cmd, "duplicate request");
        return;
    }
    logDebug("Found magic branch {}", cmd.getRefName());
    magicBranch = new MagicBranchInput(user, cmd, labelTypes, notesMigration);
    magicBranch.reviewer.addAll(reviewersFromCommandLine);
    magicBranch.cc.addAll(ccFromCommandLine);
    String ref;
    CmdLineParser clp = optionParserFactory.create(magicBranch);
    magicBranch.clp = clp;
    try {
        ref = magicBranch.parse(clp, repo, rp.getAdvertisedRefs().keySet(), pushOptions);
    } catch (CmdLineException e) {
        if (!clp.wasHelpRequestedByOption()) {
            logDebug("Invalid branch syntax");
            reject(cmd, e.getMessage());
            return;
        }
        // never happen
        ref = null;
    }
    if (clp.wasHelpRequestedByOption()) {
        StringWriter w = new StringWriter();
        w.write("\nHelp for refs/for/branch:\n\n");
        clp.printUsage(w, null);
        addMessage(w.toString());
        reject(cmd, "see help");
        return;
    }
    if (projectControl.getProjectState().isAllUsers() && RefNames.REFS_USERS_SELF.equals(ref)) {
        logDebug("Handling {}", RefNames.REFS_USERS_SELF);
        ref = RefNames.refsUsers(user.getAccountId());
    }
    if (!rp.getAdvertisedRefs().containsKey(ref) && !ref.equals(readHEAD(repo))) {
        logDebug("Ref {} not found", ref);
        if (ref.startsWith(Constants.R_HEADS)) {
            String n = ref.substring(Constants.R_HEADS.length());
            reject(cmd, "branch " + n + " not found");
        } else {
            reject(cmd, ref + " not found");
        }
        return;
    }
    magicBranch.dest = new Branch.NameKey(project.getNameKey(), ref);
    magicBranch.ctl = projectControl.controlForRef(ref);
    if (projectControl.getProject().getState() != com.google.gerrit.extensions.client.ProjectState.ACTIVE) {
        reject(cmd, "project is read only");
        return;
    }
    if (magicBranch.draft) {
        if (!receiveConfig.allowDrafts) {
            errors.put(Error.CODE_REVIEW, ref);
            reject(cmd, "draft workflow is disabled");
            return;
        } else if (projectControl.controlForRef(MagicBranch.NEW_DRAFT_CHANGE + ref).isBlocked(Permission.PUSH)) {
            errors.put(Error.CODE_REVIEW, ref);
            reject(cmd, "cannot upload drafts");
            return;
        }
    }
    if (!magicBranch.ctl.canUpload()) {
        errors.put(Error.CODE_REVIEW, ref);
        reject(cmd, "cannot upload review");
        return;
    }
    if (magicBranch.isPrivate && magicBranch.removePrivate) {
        reject(cmd, "the options 'private' and 'remove-private' are mutually exclusive");
        return;
    }
    if (magicBranch.workInProgress && magicBranch.ready) {
        reject(cmd, "the options 'wip' and 'ready' are mutually exclusive");
        return;
    }
    if (magicBranch.publishComments && magicBranch.noPublishComments) {
        reject(cmd, "the options 'publish-comments' and 'no-publish-comments' are mutually exclusive");
        return;
    }
    if (magicBranch.draft && magicBranch.submit) {
        reject(cmd, "cannot submit draft");
        return;
    }
    if (magicBranch.submit && !projectControl.controlForRef(MagicBranch.NEW_CHANGE + ref).canSubmit(true)) {
        reject(cmd, "submit not allowed");
        return;
    }
    RevWalk walk = rp.getRevWalk();
    RevCommit tip;
    try {
        tip = walk.parseCommit(magicBranch.cmd.getNewId());
        logDebug("Tip of push: {}", tip.name());
    } catch (IOException ex) {
        magicBranch.cmd.setResult(REJECTED_MISSING_OBJECT);
        logError("Invalid pack upload; one or more objects weren't sent", ex);
        return;
    }
    String destBranch = magicBranch.dest.get();
    try {
        if (magicBranch.merged) {
            if (magicBranch.draft) {
                reject(cmd, "cannot be draft & merged");
                return;
            }
            if (magicBranch.base != null) {
                reject(cmd, "cannot use merged with base");
                return;
            }
            RevCommit branchTip = readBranchTip(cmd, magicBranch.dest);
            if (branchTip == null) {
                // readBranchTip already rejected cmd.
                return;
            }
            if (!walk.isMergedInto(tip, branchTip)) {
                reject(cmd, "not merged into branch");
                return;
            }
        }
        // if %base or %merged was specified, ignore newChangeForAllNotInTarget.
        if (tip.getParentCount() > 1 || magicBranch.base != null || magicBranch.merged || tip.getParentCount() == 0) {
            logDebug("Forcing newChangeForAllNotInTarget = false");
            newChangeForAllNotInTarget = false;
        }
        if (magicBranch.base != null) {
            logDebug("Handling %base: {}", magicBranch.base);
            magicBranch.baseCommit = Lists.newArrayListWithCapacity(magicBranch.base.size());
            for (ObjectId id : magicBranch.base) {
                try {
                    magicBranch.baseCommit.add(walk.parseCommit(id));
                } catch (IncorrectObjectTypeException notCommit) {
                    reject(cmd, "base must be a commit");
                    return;
                } catch (MissingObjectException e) {
                    reject(cmd, "base not found");
                    return;
                } catch (IOException e) {
                    logWarn(String.format("Project %s cannot read %s", project.getName(), id.name()), e);
                    reject(cmd, "internal server error");
                    return;
                }
            }
        } else if (newChangeForAllNotInTarget) {
            RevCommit branchTip = readBranchTip(cmd, magicBranch.dest);
            if (branchTip == null) {
                // readBranchTip already rejected cmd.
                return;
            }
            magicBranch.baseCommit = Collections.singletonList(branchTip);
            logDebug("Set baseCommit = {}", magicBranch.baseCommit.get(0).name());
        }
    } catch (IOException ex) {
        logWarn(String.format("Error walking to %s in project %s", destBranch, project.getName()), ex);
        reject(cmd, "internal server error");
        return;
    }
    //
    try {
        Ref targetRef = rp.getAdvertisedRefs().get(magicBranch.ctl.getRefName());
        if (targetRef == null || targetRef.getObjectId() == null) {
            // The destination branch does not yet exist. Assume the
            // history being sent for review will start it and thus
            // is "connected" to the branch.
            logDebug("Branch is unborn");
            return;
        }
        RevCommit h = walk.parseCommit(targetRef.getObjectId());
        logDebug("Current branch tip: {}", h.name());
        RevFilter oldRevFilter = walk.getRevFilter();
        try {
            walk.reset();
            walk.setRevFilter(RevFilter.MERGE_BASE);
            walk.markStart(tip);
            walk.markStart(h);
            if (walk.next() == null) {
                reject(magicBranch.cmd, "no common ancestry");
            }
        } finally {
            walk.reset();
            walk.setRevFilter(oldRevFilter);
        }
    } catch (IOException e) {
        magicBranch.cmd.setResult(REJECTED_MISSING_OBJECT);
        logError("Invalid pack upload; one or more objects weren't sent", e);
    }
}

Example 4 with MagicBranch

use of com.google.gerrit.server.util.MagicBranch in project gerrit by GerritCodeReview.

the class ReceiveCommits method parseMagicBranch.

/**
 * Parse the magic branch data (refs/for/BRANCH/OPTIONALTOPIC%OPTIONS) into the magicBranch
 * member.
 *
 * <p>Assumes we are handling a magic branch here.
 */
private void parseMagicBranch(ReceiveCommand cmd) throws PermissionBackendException, IOException {
    try (TraceTimer traceTimer = newTimer("parseMagicBranch")) {
        logger.atFine().log("Found magic branch %s", cmd.getRefName());
        MagicBranchInput magicBranch = new MagicBranchInput(user, projectState, cmd, labelTypes);
        String ref;
        magicBranch.cmdLineParser = optionParserFactory.create(magicBranch);
        // Filter out plugin push options, as the parser would reject them as unknown.
        ImmutableListMultimap<String, String> pushOptionsToParse = pushOptions.entries().stream().filter(e -> !isPluginPushOption(e.getKey())).collect(toImmutableListMultimap(e -> e.getKey(), e -> e.getValue()));
        try {
            ref = magicBranch.parse(pushOptionsToParse);
        } catch (CmdLineException e) {
            if (!magicBranch.cmdLineParser.wasHelpRequestedByOption()) {
                logger.atFine().log("Invalid branch syntax");
                reject(cmd, e.getMessage());
                return;
            }
            // never happens
            ref = null;
        }
        if (magicBranch.skipValidation) {
            reject(cmd, String.format("\"--%s\" option is only supported for direct push", PUSH_OPTION_SKIP_VALIDATION));
            return;
        }
        if (magicBranch.topic != null && magicBranch.topic.length() > ChangeUtil.TOPIC_MAX_LENGTH) {
            reject(cmd, String.format("topic length exceeds the limit (%d)", ChangeUtil.TOPIC_MAX_LENGTH));
        }
        if (magicBranch.cmdLineParser.wasHelpRequestedByOption()) {
            StringWriter w = new StringWriter();
            w.write("\nHelp for refs/for/branch:\n\n");
            magicBranch.cmdLineParser.printUsage(w, null);
            String pluginPushOptionsHelp = StreamSupport.stream(pluginPushOptions.entries().spliterator(), /* parallel= */
            false).map(e -> String.format("-o %s~%s: %s", e.getPluginName(), e.get().getName(), e.get().getDescription())).sorted().collect(joining("\n"));
            if (!pluginPushOptionsHelp.isEmpty()) {
                w.write("\nPlugin push options:\n" + pluginPushOptionsHelp);
            }
            addMessage(w.toString());
            reject(cmd, "see help");
            return;
        }
        if (projectState.isAllUsers() && RefNames.REFS_USERS_SELF.equals(ref)) {
            logger.atFine().log("Handling %s", RefNames.REFS_USERS_SELF);
            ref = RefNames.refsUsers(user.getAccountId());
        }
        // configuration.
        if (receivePackRefCache.exactRef(ref) == null && !ref.equals(readHEAD(repo)) && !ref.equals(RefNames.REFS_CONFIG)) {
            logger.atFine().log("Ref %s not found", ref);
            if (ref.startsWith(Constants.R_HEADS)) {
                String n = ref.substring(Constants.R_HEADS.length());
                reject(cmd, "branch " + n + " not found");
            } else {
                reject(cmd, ref + " not found");
            }
            return;
        }
        magicBranch.dest = BranchNameKey.create(project.getNameKey(), ref);
        magicBranch.perm = permissions.ref(ref);
        Optional<AuthException> err = checkRefPermission(magicBranch.perm, RefPermission.READ).map(Optional::of).orElse(checkRefPermission(magicBranch.perm, RefPermission.CREATE_CHANGE));
        if (err.isPresent()) {
            rejectProhibited(cmd, err.get());
            return;
        }
        if (magicBranch.isPrivate && magicBranch.removePrivate) {
            reject(cmd, "the options 'private' and 'remove-private' are mutually exclusive");
            return;
        }
        boolean privateByDefault = projectCache.get(project.getNameKey()).orElseThrow(illegalState(project.getNameKey())).is(BooleanProjectConfig.PRIVATE_BY_DEFAULT);
        setChangeAsPrivate = magicBranch.isPrivate || (privateByDefault && !magicBranch.removePrivate);
        if (receiveConfig.disablePrivateChanges && setChangeAsPrivate) {
            reject(cmd, "private changes are disabled");
            return;
        }
        if (magicBranch.workInProgress && magicBranch.ready) {
            reject(cmd, "the options 'wip' and 'ready' are mutually exclusive");
            return;
        }
        if (magicBranch.publishComments && magicBranch.noPublishComments) {
            reject(cmd, "the options 'publish-comments' and 'no-publish-comments' are mutually exclusive");
            return;
        }
        if (magicBranch.submit) {
            err = checkRefPermission(magicBranch.perm, RefPermission.UPDATE_BY_SUBMIT);
            if (err.isPresent()) {
                rejectProhibited(cmd, err.get());
                return;
            }
        }
        RevWalk walk = receivePack.getRevWalk();
        RevCommit tip;
        try {
            tip = walk.parseCommit(magicBranch.cmd.getNewId());
            logger.atFine().log("Tip of push: %s", tip.name());
        } catch (IOException ex) {
            magicBranch.cmd.setResult(REJECTED_MISSING_OBJECT);
            logger.atSevere().withCause(ex).log("Invalid pack upload; one or more objects weren't sent");
            return;
        }
        String destBranch = magicBranch.dest.branch();
        try {
            if (magicBranch.merged) {
                if (magicBranch.base != null) {
                    reject(cmd, "cannot use merged with base");
                    return;
                }
                Ref refTip = receivePackRefCache.exactRef(magicBranch.dest.branch());
                if (refTip == null) {
                    reject(cmd, magicBranch.dest.branch() + " not found");
                    return;
                }
                RevCommit branchTip = receivePack.getRevWalk().parseCommit(refTip.getObjectId());
                if (!walk.isMergedInto(tip, branchTip)) {
                    reject(cmd, "not merged into branch");
                    return;
                }
            }
            // if %base or %merged was specified, ignore newChangeForAllNotInTarget.
            if (tip.getParentCount() > 1 || magicBranch.base != null || magicBranch.merged || tip.getParentCount() == 0) {
                logger.atFine().log("Forcing newChangeForAllNotInTarget = false");
                newChangeForAllNotInTarget = false;
            }
            if (magicBranch.base != null) {
                logger.atFine().log("Handling %%base: %s", magicBranch.base);
                magicBranch.baseCommit = Lists.newArrayListWithCapacity(magicBranch.base.size());
                for (ObjectId id : magicBranch.base) {
                    try {
                        magicBranch.baseCommit.add(walk.parseCommit(id));
                    } catch (IncorrectObjectTypeException notCommit) {
                        reject(cmd, "base must be a commit");
                        return;
                    } catch (MissingObjectException e) {
                        reject(cmd, "base not found");
                        return;
                    } catch (IOException e) {
                        throw new StorageException(String.format("Project %s cannot read %s", project.getName(), id.name()), e);
                    }
                }
            } else if (newChangeForAllNotInTarget) {
                Ref refTip = receivePackRefCache.exactRef(magicBranch.dest.branch());
                if (refTip != null) {
                    RevCommit branchTip = receivePack.getRevWalk().parseCommit(refTip.getObjectId());
                    magicBranch.baseCommit = Collections.singletonList(branchTip);
                    logger.atFine().log("Set baseCommit = %s", magicBranch.baseCommit.get(0).name());
                } else {
                    // repository and to review an initial project configuration.
                    if (!ref.equals(readHEAD(repo)) && !ref.equals(RefNames.REFS_CONFIG)) {
                        reject(cmd, magicBranch.dest.branch() + " not found");
                        return;
                    }
                }
            }
        } catch (IOException e) {
            throw new StorageException(String.format("Error walking to %s in project %s", destBranch, project.getName()), e);
        }
        if (validateConnected(magicBranch.cmd, magicBranch.dest, tip)) {
            this.magicBranch = magicBranch;
            this.result.magicPush(true);
        }
    }
}