RefTreeBatch.java

  1. /*
  2.  * Copyright (C) 2016, Google Inc.
  3.  * and other copyright owners as documented in the project's IP log.
  4.  *
  5.  * This program and the accompanying materials are made available
  6.  * under the terms of the Eclipse Distribution License v1.0 which
  7.  * accompanies this distribution, is reproduced below, and is
  8.  * available at http://www.eclipse.org/org/documents/edl-v10.php
  9.  *
  10.  * All rights reserved.
  11.  *
  12.  * Redistribution and use in source and binary forms, with or
  13.  * without modification, are permitted provided that the following
  14.  * conditions are met:
  15.  *
  16.  * - Redistributions of source code must retain the above copyright
  17.  *   notice, this list of conditions and the following disclaimer.
  18.  *
  19.  * - Redistributions in binary form must reproduce the above
  20.  *   copyright notice, this list of conditions and the following
  21.  *   disclaimer in the documentation and/or other materials provided
  22.  *   with the distribution.
  23.  *
  24.  * - Neither the name of the Eclipse Foundation, Inc. nor the
  25.  *   names of its contributors may be used to endorse or promote
  26.  *   products derived from this software without specific prior
  27.  *   written permission.
  28.  *
  29.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  30.  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  31.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  34.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  35.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  36.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  38.  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41.  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42.  */

  44. package org.eclipse.jgit.internal.storage.reftree;

  46. import static org.eclipse.jgit.lib.Constants.OBJ_TREE;
  47. import static org.eclipse.jgit.transport.ReceiveCommand.Result.NOT_ATTEMPTED;
  48. import static org.eclipse.jgit.transport.ReceiveCommand.Result.OK;
  49. import static org.eclipse.jgit.transport.ReceiveCommand.Result.REJECTED_NONFASTFORWARD;
  50. import static org.eclipse.jgit.transport.ReceiveCommand.Result.REJECTED_OTHER_REASON;
  51. import static org.eclipse.jgit.transport.ReceiveCommand.Type.UPDATE;
  52. import static org.eclipse.jgit.transport.ReceiveCommand.Type.UPDATE_NONFASTFORWARD;

  54. import java.io.IOException;
  55. import java.text.MessageFormat;
  56. import java.util.ArrayList;
  57. import java.util.List;

  59. import org.eclipse.jgit.annotations.Nullable;
  60. import org.eclipse.jgit.internal.JGitText;
  61. import org.eclipse.jgit.lib.BatchRefUpdate;
  62. import org.eclipse.jgit.lib.CommitBuilder;
  63. import org.eclipse.jgit.lib.NullProgressMonitor;
  64. import org.eclipse.jgit.lib.ObjectId;
  65. import org.eclipse.jgit.lib.ObjectInserter;
  66. import org.eclipse.jgit.lib.ObjectReader;
  67. import org.eclipse.jgit.lib.PersonIdent;
  68. import org.eclipse.jgit.lib.ProgressMonitor;
  69. import org.eclipse.jgit.lib.Ref;
  70. import org.eclipse.jgit.lib.Repository;
  71. import org.eclipse.jgit.revwalk.RevCommit;
  72. import org.eclipse.jgit.revwalk.RevWalk;
  73. import org.eclipse.jgit.transport.ReceiveCommand;

  75. /** Batch update a {@link RefTreeDatabase}. */
  76. class RefTreeBatch extends BatchRefUpdate {
  77.     private final RefTreeDatabase refdb;
  78.     private Ref src;
  79.     private ObjectId parentCommitId;
  80.     private ObjectId parentTreeId;
  81.     private RefTree tree;
  82.     private PersonIdent author;
  83.     private ObjectId newCommitId;

  85.     RefTreeBatch(RefTreeDatabase refdb) {
  86.         super(refdb);
  87.         this.refdb = refdb;
  88.     }

  90.     /** {@inheritDoc} */
  91.     @Override
  92.     public void execute(RevWalk rw, ProgressMonitor monitor)
  93.             throws IOException {
  94.         List<Command> todo = new ArrayList<>(getCommands().size());
  95.         for (ReceiveCommand c : getCommands()) {
  96.             if (!isAllowNonFastForwards()) {
  97.                 if (c.getType() == UPDATE) {
  98.                     c.updateType(rw);
  99.                 }
  100.                 if (c.getType() == UPDATE_NONFASTFORWARD) {
  101.                     c.setResult(REJECTED_NONFASTFORWARD);
  102.                     if (isAtomic()) {
  103.                         ReceiveCommand.abort(getCommands());
  104.                         return;
  105.                     } else {
  106.                         continue;
  107.                     }
  108.                 }
  109.             }
  110.             todo.add(new Command(rw, c));
  111.         }
  112.         init(rw);
  113.         execute(rw, todo);
  114.     }

  116.     void init(RevWalk rw) throws IOException {
  117.         src = refdb.getBootstrap().exactRef(refdb.getTxnCommitted());
  118.         if (src != null && src.getObjectId() != null) {
  119.             RevCommit c = rw.parseCommit(src.getObjectId());
  120.             parentCommitId = c;
  121.             parentTreeId = c.getTree();
  122.             tree = RefTree.read(rw.getObjectReader(), c.getTree());
  123.         } else {
  124.             parentCommitId = ObjectId.zeroId();
  125.             parentTreeId = new ObjectInserter.Formatter()
  126.                     .idFor(OBJ_TREE, new byte[] {});
  127.             tree = RefTree.newEmptyTree();
  128.         }
  129.     }

  131.     @Nullable
  132.     Ref exactRef(ObjectReader reader, String name) throws IOException {
  133.         return tree.exactRef(reader, name);
  134.     }

  136.     /**
  137.      * Execute an update from {@link RefTreeUpdate} or {@link RefTreeRename}.
  138.      *
  139.      * @param rw
  140.      *            current RevWalk handling the update or rename.
  141.      * @param todo
  142.      *            commands to execute. Must never be a bootstrap reference name.
  143.      * @throws IOException
  144.      *             the storage system is unable to read or write data.
  145.      */
  146.     void execute(RevWalk rw, List<Command> todo) throws IOException {
  147.         for (Command c : todo) {
  148.             if (c.getResult() != NOT_ATTEMPTED) {
  149.                 Command.abort(todo, null);
  150.                 return;
  151.             }
  152.             if (refdb.conflictsWithBootstrap(c.getRefName())) {
  153.                 c.setResult(REJECTED_OTHER_REASON, MessageFormat
  154.                         .format(JGitText.get().invalidRefName, c.getRefName()));
  155.                 Command.abort(todo, null);
  156.                 return;
  157.             }
  158.         }

  160.         if (apply(todo) && newCommitId != null) {
  161.             commit(rw, todo);
  162.         }
  163.     }

  165.     private boolean apply(List<Command> todo) throws IOException {
  166.         if (!tree.apply(todo)) {
  167.             // apply set rejection information on commands.
  168.             return false;
  169.         }

  171.         Repository repo = refdb.getRepository();
  172.         try (ObjectInserter ins = repo.newObjectInserter()) {
  173.             CommitBuilder b = new CommitBuilder();
  174.             b.setTreeId(tree.writeTree(ins));
  175.             if (parentTreeId.equals(b.getTreeId())) {
  176.                 for (Command c : todo) {
  177.                     c.setResult(OK);
  178.                 }
  179.                 return true;
  180.             }
  181.             if (!parentCommitId.equals(ObjectId.zeroId())) {
  182.                 b.setParentId(parentCommitId);
  183.             }

  185.             author = getRefLogIdent();
  186.             if (author == null) {
  187.                 author = new PersonIdent(repo);
  188.             }
  189.             b.setAuthor(author);
  190.             b.setCommitter(author);
  191.             b.setMessage(getRefLogMessage());
  192.             newCommitId = ins.insert(b);
  193.             ins.flush();
  194.         }
  195.         return true;
  196.     }

  198.     private void commit(RevWalk rw, List<Command> todo) throws IOException {
  199.         ReceiveCommand commit = new ReceiveCommand(
  200.                 parentCommitId, newCommitId,
  201.                 refdb.getTxnCommitted());
  202.         updateBootstrap(rw, commit);

  204.         if (commit.getResult() == OK) {
  205.             for (Command c : todo) {
  206.                 c.setResult(OK);
  207.             }
  208.         } else {
  209.             Command.abort(todo, commit.getResult().name());
  210.         }
  211.     }

  213.     private void updateBootstrap(RevWalk rw, ReceiveCommand commit)
  214.             throws IOException {
  215.         BatchRefUpdate u = refdb.getBootstrap().newBatchUpdate();
  216.         u.setAllowNonFastForwards(true);
  217.         u.setPushCertificate(getPushCertificate());
  218.         if (isRefLogDisabled()) {
  219.             u.disableRefLog();
  220.         } else {
  221.             u.setRefLogIdent(author);
  222.             u.setRefLogMessage(getRefLogMessage(), false);
  223.         }
  224.         u.addCommand(commit);
  225.         u.execute(rw, NullProgressMonitor.INSTANCE);
  226.     }
  227. }
Created with JaCoCo 0.8.4.201905082037