Merge pull request #409 from deeky666/DBAL-81

[DBAL-81] Add possibility to set the auto-commit mode for a connection

lib/Doctrine/DBAL/Configuration.php

@@ -117,4 +117,36 @@ class Configuration
 
         return null;
     }
+
+    /**
+     * Sets the default auto-commit mode for connections.
+     *
+     * If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual
+     * transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either
+     * the method commit or the method rollback. By default, new connections are in auto-commit mode.
+     *
+     * @param boolean $autoCommit True to enable auto-commit mode; false to disable it.
+     *
+     * @see   getAutoCommit
+     */
+    public function setAutoCommit($autoCommit)
+    {
+        $this->_attributes['autoCommit'] = (boolean) $autoCommit;
+    }
+
+    /**
+     * Returns the default auto-commit mode for connections.
+     *
+     * @return boolean True if auto-commit mode is enabled by default for connections, false otherwise.
+     *
+     * @see    setAutoCommit
+     */
+    public function getAutoCommit()
+    {
+        if (isset($this->_attributes['autoCommit'])) {
+            return $this->_attributes['autoCommit'];
+        }
+
+        return true;
+    }
 }

lib/Doctrine/DBAL/Connection.php

@@ -117,6 +117,13 @@ class Connection implements DriverConnection
      */
     private $_isConnected = false;
 
+    /**
+     * The current auto-commit mode of this connection.
+     *
+     * @var boolean
+     */
+    private $autoCommit = true;
+
     /**
      * The transaction nesting level.
      *
@@ -225,6 +232,7 @@ class Connection implements DriverConnection
         $this->_platform->setEventManager($eventManager);
 
         $this->_transactionIsolationLevel = $this->_platform->getDefaultTransactionIsolationLevel();
+        $this->autoCommit = $config->getAutoCommit();
     }
 
     /**
@@ -356,6 +364,10 @@ class Connection implements DriverConnection
         $this->_conn = $this->_driver->connect($this->_params, $user, $password, $driverOptions);
         $this->_isConnected = true;
 
+        if (false === $this->autoCommit) {
+            $this->beginTransaction();
+        }
+
         if ($this->_eventManager->hasListeners(Events::postConnect)) {
             $eventArgs = new Event\ConnectionEventArgs($this);
             $this->_eventManager->dispatchEvent(Events::postConnect, $eventArgs);
@@ -364,6 +376,49 @@ class Connection implements DriverConnection
         return true;
     }
 
+    /**
+     * Returns the current auto-commit mode for this connection.
+     *
+     * @return boolean True if auto-commit mode is currently enabled for this connection, false otherwise.
+     *
+     * @see    setAutoCommit
+     */
+    public function isAutoCommit()
+    {
+        return true === $this->autoCommit;
+    }
+
+    /**
+     * Sets auto-commit mode for this connection.
+     *
+     * If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual
+     * transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either
+     * the method commit or the method rollback. By default, new connections are in auto-commit mode.
+     *
+     * NOTE: If this method is called during a transaction and the auto-commit mode is changed, the transaction is
+     * committed. If this method is called and the auto-commit mode is not changed, the call is a no-op.
+     *
+     * @param boolean $autoCommit True to enable auto-commit mode; false to disable it.
+     *
+     * @see   isAutoCommit
+     */
+    public function setAutoCommit($autoCommit)
+    {
+        $autoCommit = (boolean) $autoCommit;
+
+        // Mode not changed, no-op.
+        if ($autoCommit === $this->autoCommit) {
+            return;
+        }
+
+        $this->autoCommit = $autoCommit;
+
+        // Commit all currently active transactions if any when switching auto-commit mode.
+        if (true === $this->_isConnected && 0 !== $this->_transactionNestingLevel) {
+            $this->commitAll();
+        }
+    }
+
     /**
      * Sets the fetch mode.
      *
@@ -1095,6 +1150,28 @@ class Connection implements DriverConnection
         }
 
         --$this->_transactionNestingLevel;
+
+        if (false === $this->autoCommit && 0 === $this->_transactionNestingLevel) {
+            $this->beginTransaction();
+        }
+    }
+
+    /**
+     * Commits all current nesting transactions.
+     */
+    private function commitAll()
+    {
+        while (0 !== $this->_transactionNestingLevel) {
+            if (false === $this->autoCommit && 1 === $this->_transactionNestingLevel) {
+                // When in no auto-commit mode, the last nesting commit immediately starts a new transaction.
+                // Therefore we need to do the final commit here and then leave to avoid an infinite loop.
+                $this->commit();
+
+                return;
+            }
+
+            $this->commit();
+        }
     }
 
     /**
@@ -1125,6 +1202,10 @@ class Connection implements DriverConnection
             if ($logger) {
                 $logger->stopQuery();
             }
+
+            if (false === $this->autoCommit) {
+                $this->beginTransaction();
+            }
         } else if ($this->_nestTransactionsWithSavepoints) {
             if ($logger) {
                 $logger->startQuery('"ROLLBACK TO SAVEPOINT"');

tests/Doctrine/Tests/DBAL/ConfigurationTest.php

+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\Tests\DBAL;
+
+use Doctrine\DBAL\Configuration;
+use Doctrine\Tests\DbalTestCase;
+
+require_once __DIR__ . '/../TestInit.php';
+
+/**
+ * Unit tests for the configuration container.
+ *
+ * @author Steve Müller <st.mueller@dzh-online.de>
+ */
+class ConfigurationTest extends DbalTestCase
+{
+    /**
+     * The configuration container instance under test.
+     *
+     * @var \Doctrine\DBAL\Configuration
+     */
+    protected $config;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setUp()
+    {
+        $this->config = new Configuration();
+    }
+
+    /**
+     * Tests that the default auto-commit mode for connections can be retrieved from the configuration container.
+     *
+     * @group DBAL-81
+     */
+    public function testReturnsDefaultConnectionAutoCommitMode()
+    {
+        $this->assertTrue($this->config->getAutoCommit());
+    }
+
+    /**
+     * Tests that the default auto-commit mode for connections can be set in the configuration container.
+     *
+     * @group DBAL-81
+     */
+    public function testSetsDefaultConnectionAutoCommitMode()
+    {
+        $this->config->setAutoCommit(false);
+
+        $this->assertFalse($this->config->getAutoCommit());
+
+        $this->config->setAutoCommit(0);
+
+        $this->assertFalse($this->config->getAutoCommit());
+    }
+}

tests/Doctrine/Tests/DBAL/ConnectionTest.php

@@ -8,6 +8,7 @@ use Doctrine\DBAL\Connection;
 use Doctrine\Common\EventManager;
 use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Events;
+use Doctrine\Tests\Mocks\DriverConnectionMock;
 
 class ConnectionTest extends \Doctrine\Tests\DbalTestCase
 {
@@ -174,4 +175,104 @@ SQLSTATE[HY000]: General error: 1 near \"MUUHAAAAHAAAA\"");
         $this->_conn->getConfiguration()->setSQLLogger($logger);
         $this->assertSame($logger, $this->_conn->getConfiguration()->getSQLLogger());
     }
+
+    /**
+     * @group DBAL-81
+     */
+    public function testIsAutoCommit()
+    {
+        $this->assertTrue($this->_conn->isAutoCommit());
+    }
+
+    /**
+     * @group DBAL-81
+     */
+    public function testSetAutoCommit()
+    {
+        $this->_conn->setAutoCommit(false);
+        $this->assertFalse($this->_conn->isAutoCommit());
+        $this->_conn->setAutoCommit(0);
+        $this->assertFalse($this->_conn->isAutoCommit());
+    }
+
+    /**
+     * @group DBAL-81
+     */
+    public function testConnectStartsTransactionInNoAutoCommitMode()
+    {
+        $driverMock = $this->getMock('Doctrine\DBAL\Driver');
+        $driverMock->expects($this->any())
+            ->method('connect')
+            ->will($this->returnValue(new DriverConnectionMock()));
+        $conn = new Connection(array('platform' => new Mocks\MockPlatform()), $driverMock);
+
+        $conn->setAutoCommit(false);
+
+        $this->assertFalse($conn->isTransactionActive());
+
+        $conn->connect();
+
+        $this->assertTrue($conn->isTransactionActive());
+    }
+
+    /**
+     * @group DBAL-81
+     */
+    public function testCommitStartsTransactionInNoAutoCommitMode()
+    {
+        $driverMock = $this->getMock('Doctrine\DBAL\Driver');
+        $driverMock->expects($this->any())
+            ->method('connect')
+            ->will($this->returnValue(new DriverConnectionMock()));
+        $conn = new Connection(array('platform' => new Mocks\MockPlatform()), $driverMock);
+
+        $conn->setAutoCommit(false);
+        $conn->connect();
+        $conn->commit();
+
+        $this->assertTrue($conn->isTransactionActive());
+    }
+
+    /**
+     * @group DBAL-81
+     */
+    public function testRollBackStartsTransactionInNoAutoCommitMode()
+    {
+        $driverMock = $this->getMock('Doctrine\DBAL\Driver');
+        $driverMock->expects($this->any())
+            ->method('connect')
+            ->will($this->returnValue(new DriverConnectionMock()));
+        $conn = new Connection(array('platform' => new Mocks\MockPlatform()), $driverMock);
+
+        $conn->setAutoCommit(false);
+        $conn->connect();
+        $conn->rollBack();
+
+        $this->assertTrue($conn->isTransactionActive());
+    }
+
+    /**
+     * @group DBAL-81
+     */
+    public function testSwitchingAutoCommitModeCommitsAllCurrentTransactions()
+    {
+        $driverMock = $this->getMock('Doctrine\DBAL\Driver');
+        $driverMock->expects($this->any())
+            ->method('connect')
+            ->will($this->returnValue(new DriverConnectionMock()));
+        $conn = new Connection(array('platform' => new Mocks\MockPlatform()), $driverMock);
+
+        $conn->connect();
+        $conn->beginTransaction();
+        $conn->beginTransaction();
+        $conn->setAutoCommit(false);
+
+        $this->assertSame(1, $conn->getTransactionNestingLevel());
+
+        $conn->beginTransaction();
+        $conn->beginTransaction();
+        $conn->setAutoCommit(true);
+
+        $this->assertFalse($conn->isTransactionActive());
+    }
 }
\ No newline at end of file