CRM-20868, set invoice_number at Contribution::create not when invoice is generated

CRM/Contribute/BAO/Contribution.php

@@ -139,6 +139,11 @@ public static function add(&$params, $ids = array()) {
     //set defaults in create mode
     if (!$contributionID) {
       CRM_Core_DAO::setCreateDefaults($params, self::getDefaults());
+
+      if (empty($params['invoice_number'])) {
+        $nextContributionID = CRM_Core_DAO::singleValueQuery("SELECT COALESCE(MAX(id) + 1, 1) FROM civicrm_contribution");
+        $params['invoice_number'] = self::getInvoiceNumber($nextContributionID);
+      }
     }
 
     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
@@ -5105,12 +5110,17 @@ protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
    *
    *
    * @param string $name
+   * @param bool $checkInvoicing
    * @return string
    *
    */
-  public static function checkContributeSettings($name = NULL) {
+  public static function checkContributeSettings($name = NULL, $checkInvoicing = FALSE) {
     $contributeSettings = Civi::settings()->get('contribution_invoice_settings');
 
+    if ($checkInvoicing && !CRM_Utils_Array::value('invoicing', $contributeSettings)) {
+      return NULL;
+    }
+
     if ($name) {
       return CRM_Utils_Array::value($name, $contributeSettings);
     }
@@ -5756,4 +5766,19 @@ public static function replaceContributionTokens(
     return $contributionDetails;
   }
 
+  /**
+   * Get invoice_number for contribution.
+   *
+   * @param int $contributionID
+   *
+   * @return string
+   */
+  public static function getInvoiceNumber($contributionID) {
+    if ($invoicePrefix = self::checkContributeSettings('invoice_prefix', TRUE)) {
+      return $invoicePrefix . $contributionID;
+    }
+
+    return NULL;
+  }
+
 }

CRM/Contribute/BAO/Query.php

@@ -821,6 +821,7 @@ public static function defaultReturnProperties($mode, $includeCustomFields = TRU
         'trxn_id' => 1,
         // join
         'invoice_id' => 1,
+        'invoice_number' => 1,
         // added
         'currency' => 1,
         // to

CRM/Contribute/Form/Task/Invoice.php

@@ -312,7 +312,9 @@ public static function printPDF($contribIDs, &$params, $contactIds) {
           $creditNoteId = $contribution->creditnote_id;
         }
       }
-      $invoiceNumber = CRM_Utils_Array::value('invoice_prefix', $prefixValue) . "" . $contribution->id;
+      if (!$contribution->invoice_number) {
+        $contribution->invoice_number = CRM_Contribute_BAO_Contribution::getInvoiceNumber($contribution->id);
+      }
 
       //to obtain due date for PDF invoice
       $contributionReceiveDate = date('F j,Y', strtotime(date($input['receive_date'])));
@@ -425,7 +427,7 @@ public static function printPDF($contribIDs, &$params, $contactIds) {
         'component' => $input['component'],
         'id' => $contribution->id,
         'source' => $source,
-        'invoice_number' => $invoiceNumber,
+        'invoice_number' => $contribution->invoice_number,
         'invoice_id' => $contribution->invoice_id,
         'resourceBase' => $config->userFrameworkResourceURL,
         'defaultCurrency' => $config->defaultCurrency,
@@ -469,7 +471,7 @@ public static function printPDF($contribIDs, &$params, $contactIds) {
         $tplParams['creditnote_id'] = $creditNoteId;
       }
 
-      $pdfFileName = "{$invoiceNumber}.pdf";
+      $pdfFileName = $contribution->invoice_number . ".pdf";
       $sendTemplateParams = array(
         'groupName' => 'msg_tpl_workflow_contribution',
         'valueName' => 'contribution_invoice_receipt',
@@ -556,8 +558,6 @@ public static function printPDF($contribIDs, &$params, $contactIds) {
         $fileName = self::putFile($html, $pdfFileName);
         self::addActivities($subject, $contribution->contact_id, $fileName, $params);
       }
-
-      CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $contribution->id, 'invoice_number', $invoiceNumber);
       $invoiceTemplate->clearTemplateVars();
     }
 

CRM/Upgrade/Incremental/php/FourSeven.php

@@ -466,6 +466,20 @@ public function upgrade_4_7_27($rev) {
   public function upgrade_4_7_28($rev) {
     $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
     $this->addTask('CRM-20572: Fix date fields in save search criteria of Contrib Sybunt custom search ', 'fixDateFieldsInSmartGroups');
+    // CRM-20868 : Update invoice_numbers (in batch) with value in [invoice prefix][contribution id] format
+    if ($invoicePrefix = CRM_Contribute_BAO_Contribution::checkContributeSettings('invoice_prefix', TRUE)) {
+      list($minId, $maxId) = CRM_Core_DAO::executeQuery("SELECT coalesce(min(id),0), coalesce(max(id),0)
+        FROM civicrm_contribution ")->getDatabaseResult()->fetchRow();
+      for ($startId = $minId; $startId <= $maxId; $startId += self::BATCH_SIZE) {
+        $endId = $startId + self::BATCH_SIZE - 1;
+        $title = ts("Upgrade DB to %1: Update Contribution Invoice number (%2 => %3)", array(
+          1 => $rev,
+          2 => $startId,
+          3 => $endId,
+        ));
+        $this->addTask($title, 'updateContributionInvoiceNumber', $startId, $endId, $invoicePrefix);
+      }
+    }
   }
 
   /*
@@ -601,6 +615,27 @@ public static function convertBackendToSettings($domainId, $config_backend) {
     return $settings;
   }
 
+  /**
+   * Update Invoice number for all completed contribution.
+   *
+   * @param \CRM_Queue_TaskContext $ctx
+   *
+   * @return bool
+   */
+  public static function updateContributionInvoiceNumber(CRM_Queue_TaskContext $ctx, $startID, $endID, $invoicePrefix) {
+    CRM_Core_DAO::executeQuery("
+      UPDATE `civicrm_contribution` SET `invoice_number` = CONCAT(%1, `id`)
+       WHERE `id` BETWEEN (%2 AND %3) AND `invoice_number` IS NOT NULL ",
+      array(
+        1 => array($invoicePrefix, 'string'),
+        2 => array($startID, 'Integer'),
+        3 => array($endID, 'Integer'),
+      )
+    );
+
+    return TRUE;
+  }
+
   /**
    * Add Getting Started dashlet to dashboard
    *

tests/phpunit/api/v3/ContributionTest.php

@@ -128,6 +128,8 @@ public function tearDown() {
    * Test Get.
    */
   public function testGetContribution() {
+    $contributionSettings = $this->enableTaxAndInvoicing();
+    $invoice_prefix = CRM_Contribute_BAO_Contribution::checkContributeSettings('invoice_prefix', TRUE);
     $p = array(
       'contact_id' => $this->_individualId,
       'receive_date' => '2010-01-20',
@@ -165,6 +167,7 @@ public function testGetContribution() {
     $this->assertEquals($contribution['net_amount'], 95.00);
     $this->assertEquals($contribution['trxn_id'], 23456);
     $this->assertEquals($contribution['invoice_id'], 78910);
+    $this->assertEquals($contribution['invoice_number'], $invoice_prefix . $contributions['id']);
     $this->assertEquals($contribution['contribution_source'], 'SSF');
     $this->assertEquals($contribution['contribution_status'], 'Completed');
     // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).