AddMissingDonorIdToDonationComments.php
1 year ago
MoveDonationCommentToDonationMetaTable.php
3 years ago
RecalculateExchangeRate.php
1 year ago
SetAutomaticFormattingOption.php
3 years ago
UnserializeTitlePrefix.php
1 year ago
RecalculateExchangeRate.php
164 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Donations\Migrations; |
| 4 | |
| 5 | use Give\Donations\ValueObjects\DonationMetaKeys; |
| 6 | use Give\Framework\Database\DB; |
| 7 | use Give\Framework\Database\Exceptions\DatabaseQueryException; |
| 8 | use Give\Framework\Migrations\Contracts\BatchMigration; |
| 9 | use Give\Framework\Migrations\Exceptions\DatabaseMigrationException; |
| 10 | use Give\Framework\QueryBuilder\QueryBuilder; |
| 11 | use Give\Framework\Support\ValueObjects\Money; |
| 12 | |
| 13 | /** |
| 14 | * @since 4.2.0 |
| 15 | */ |
| 16 | class RecalculateExchangeRate extends BatchMigration |
| 17 | { |
| 18 | /** |
| 19 | * @inheritDoc |
| 20 | */ |
| 21 | public static function id(): string |
| 22 | { |
| 23 | return 'recalculate_exchange_rate'; |
| 24 | } |
| 25 | |
| 26 | /** |
| 27 | * @inheritDoc |
| 28 | */ |
| 29 | public static function title(): string |
| 30 | { |
| 31 | return 'Recalculate exchange rate'; |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * @inheritdoc |
| 36 | */ |
| 37 | public static function timestamp(): string |
| 38 | { |
| 39 | return strtotime('2025-04-24 00:00:00'); |
| 40 | } |
| 41 | |
| 42 | /** |
| 43 | * Base query to find donations that need exchange rate recalculation |
| 44 | * |
| 45 | * @since 4.2.0 |
| 46 | */ |
| 47 | protected function query(): QueryBuilder |
| 48 | { |
| 49 | return DB::table('posts', 'posts') |
| 50 | ->where('posts.post_type', 'give_payment') |
| 51 | ->orderBy('posts.ID', 'ASC'); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * @inheritDoc |
| 56 | * @throws DatabaseMigrationException |
| 57 | */ |
| 58 | public function runBatch($firstId, $lastId): void |
| 59 | { |
| 60 | try { |
| 61 | // Select donations where base currency is not empty, |
| 62 | // base currency is different from payment currency, |
| 63 | // and either the exchange rate does not exist or is equal to 1 |
| 64 | |
| 65 | $query = $this->query() |
| 66 | ->select('posts.ID') |
| 67 | ->attachMeta( |
| 68 | 'give_donationmeta', |
| 69 | 'ID', |
| 70 | 'donation_id', |
| 71 | [DonationMetaKeys::AMOUNT, 'amount'], |
| 72 | [DonationMetaKeys::CURRENCY, 'currency'], |
| 73 | [DonationMetaKeys::BASE_AMOUNT, 'baseAmount'], |
| 74 | [DonationMetaKeys::EXCHANGE_RATE, 'exchangeRate'], |
| 75 | ['_give_cs_base_currency', 'baseCurrency'] |
| 76 | ) |
| 77 | ->whereIsNotNull('give_donationmeta_attach_meta_baseAmount.meta_value') |
| 78 | ->whereRaw('AND give_donationmeta_attach_meta_baseCurrency.meta_value != give_donationmeta_attach_meta_currency.meta_value') |
| 79 | ->where(function ($query) { |
| 80 | $query->where('give_donationmeta_attach_meta_exchangeRate.meta_value', '1') |
| 81 | ->orWhereIsNull('give_donationmeta_attach_meta_exchangeRate.meta_value'); |
| 82 | }); |
| 83 | |
| 84 | // Migration Runner will pass null for lastId in the last step |
| 85 | if (is_null($lastId)) { |
| 86 | $query->where('posts.ID', $firstId, '>'); |
| 87 | } else { |
| 88 | $query->whereBetween('posts.ID', $firstId, $lastId); |
| 89 | } |
| 90 | |
| 91 | $donations = $query->getAll(); |
| 92 | |
| 93 | foreach ($donations as $donation) { |
| 94 | $amount = Money::fromDecimal($donation->amount, $donation->currency); |
| 95 | $baseAmount = Money::fromDecimal($donation->baseAmount, $donation->baseCurrency); |
| 96 | |
| 97 | if ($baseAmount->formatToDecimal() === '0') { |
| 98 | continue; |
| 99 | } |
| 100 | |
| 101 | /** @var Money $exchangeRate */ |
| 102 | $exchangeRate = $amount->divide($baseAmount->formatToDecimal()); |
| 103 | |
| 104 | give()->payment_meta->update_meta($donation->ID, DonationMetaKeys::EXCHANGE_RATE, $exchangeRate->formatToDecimal()); |
| 105 | } |
| 106 | } catch (DatabaseQueryException $exception) { |
| 107 | throw new DatabaseMigrationException( |
| 108 | 'An error occurred while updating donation exchange rates', |
| 109 | 0, |
| 110 | $exception |
| 111 | ); |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * @inheritDoc |
| 117 | */ |
| 118 | public function getItemsCount(): int |
| 119 | { |
| 120 | return $this->query()->count(); |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * @inheritDoc |
| 125 | */ |
| 126 | public function getBatchItemsAfter($lastId): ?array |
| 127 | { |
| 128 | $subquerySQL = $this->query() |
| 129 | ->where('ID', $lastId, '>') |
| 130 | ->limit($this->getBatchSize()) |
| 131 | ->getSQL(); |
| 132 | |
| 133 | $item = DB::get_row("SELECT MIN(ID) AS first_id, MAX(ID) AS last_id FROM ($subquerySQL) as batch"); |
| 134 | |
| 135 | if (!$item) { |
| 136 | return null; |
| 137 | } |
| 138 | |
| 139 | return [ |
| 140 | $item->first_id, |
| 141 | $item->last_id, |
| 142 | ]; |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * @inheritDoc |
| 147 | */ |
| 148 | public function getBatchSize(): int |
| 149 | { |
| 150 | return 100; |
| 151 | } |
| 152 | |
| 153 | /** |
| 154 | * @inheritDoc |
| 155 | */ |
| 156 | public function hasMoreItemsToBatch($lastProcessedId): ?bool |
| 157 | { |
| 158 | return $this->query() |
| 159 | ->where('posts.ID', $lastProcessedId, '>') |
| 160 | ->limit(1) |
| 161 | ->count(); |
| 162 | } |
| 163 | } |
| 164 |