firefly-iii/app/Import/Converter/Amount.php

<?php
/**
 * Amount.php
 * Copyright (c) 2017 thegrumpydictator@gmail.com
 *
 * This file is part of Firefly III.
 *
 * Firefly III is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Firefly III is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace FireflyIII\Import\Converter;

use Log;

/**
 * Class Amount.
 */
class Amount implements ConverterInterface
{
    /**
     * Some people, when confronted with a problem, think "I know, I'll use regular expressions." Now they have two problems.
     * - Jamie Zawinski.
     *
     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
     * @SuppressWarnings(PHPMD.NPathComplexity)
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     * @param $value
     *
     * @return string
     */
    public function convert($value): string
    {
        if (null === $value) {
            return '0';
        }
        Log::debug(sprintf('Start with amount "%s"', $value));
        $original = $value;
        $value    = $this->stripAmount((string)$value);
        $decimal  = null;

        if ($this->decimalIsDot($value)) {
            $decimal = '.';
            Log::debug(sprintf('Decimal character in "%s" seems to be a dot.', $value));
        }

        if ($this->decimalIsComma($value)) {
            $decimal = ',';
            Log::debug(sprintf('Decimal character in "%s" seems to be a comma.', $value));
        }

        // decimal character is null? find out if "0.1" or ".1" or "0,1" or ",1"
        if ($this->alternativeDecimalSign($value)) {
            $decimal = $this->getAlternativeDecimalSign($value);
        }

        // decimal character still null? Search from the left for '.',',' or ' '.
        if (null === $decimal) {
            $decimal = $this->findFromLeft($value);
        }

        // if decimal is dot, replace all comma's and spaces with nothing
        if (null !== $decimal) {
            $value = $this->replaceDecimal($decimal, $value);
            Log::debug(sprintf('Converted amount from "%s" to "%s".', $original, $value));
        }

        if (null === $decimal) {
            // replace all:
            $search = ['.', ' ', ','];
            $value  = str_replace($search, '', $value);
            Log::debug(sprintf('No decimal character found. Converted amount from "%s" to "%s".', $original, $value));
        }
        if ('.' === $value{0}) {
            $value = '0' . $value;
        }

        if (is_numeric($value)) {
            Log::debug(sprintf('Final NUMERIC value is: "%s"', $value));

            return $value;
        }
        // @codeCoverageIgnoreStart
        Log::debug(sprintf('Final value is: "%s"', $value));
        $formatted = sprintf('%01.12f', $value);
        Log::debug(sprintf('Is formatted to : "%s"', $formatted));

        return $formatted;
        // @codeCoverageIgnoreEnd
    }

    /**
     * Check if the value has a dot or comma on an alternative place,
     * catching strings like ",1" or ".5".
     *
     * @param string $value
     *
     * @return bool
     */
    private function alternativeDecimalSign(string $value): bool
    {
        $length      = \strlen($value);
        $altPosition = $length - 2;

        return $length > 1 && ('.' === $value[$altPosition] || ',' === $value[$altPosition]);
    }

    /**
     * Helper function to see if the decimal separator is a comma.
     *
     * @param string $value
     *
     * @return bool
     */
    private function decimalIsComma(string $value): bool
    {
        $length          = \strlen($value);
        $decimalPosition = $length - 3;

        return $length > 2 && ',' === $value[$decimalPosition];
    }

    /**
     * Helper function to see if the decimal separator is a dot.
     *
     * @param string $value
     *
     * @return bool
     */
    private function decimalIsDot(string $value): bool
    {
        $length          = \strlen($value);
        $decimalPosition = $length - 3;

        return ($length > 2 && '.' === $value[$decimalPosition]) || ($length > 2 && strpos($value, '.') > $decimalPosition);
    }

    /**
     * Search from the left for decimal sign.
     *
     * @param string $value
     *
     * @return string
     */
    private function findFromLeft(string $value): ?string
    {
        $decimal = null;
        Log::debug('Decimal is still NULL, probably number with >2 decimals. Search for a dot.');
        $res = strrpos($value, '.');
        if (!(false === $res)) {
            // blandly assume this is the one.
            Log::debug(sprintf('Searched from the left for "." in amount "%s", assume this is the decimal sign.', $value));
            $decimal = '.';
        }

        return $decimal;
    }

    /**
     * Returns the alternative decimal point used, such as a dot or a comma,
     * from strings like ",1" or "0.5".
     *
     * @param string $value
     *
     * @return string
     */
    private function getAlternativeDecimalSign(string $value): string
    {
        $length      = \strlen($value);
        $altPosition = $length - 2;

        return $value[$altPosition];

    }

    /**
     * Replaces other characters like thousand separators with nothing to make the decimal separator the only special
     * character in the string.
     *
     * @param string $decimal
     * @param string $value
     *
     * @return string
     */
    private function replaceDecimal(string $decimal, string $value): string
    {
        $search = [',', ' ']; // default when decimal sign is a dot.
        if (',' === $decimal) {
            $search = ['.', ' '];
        }
        $value = str_replace($search, '', $value);

        /** @noinspection CascadeStringReplacementInspection */
        $value = str_replace(',', '.', $value);

        return $value;
    }

    /**
     * Strip amount from weird characters.
     *
     * @param string $value
     *
     * @return string
     */
    private function stripAmount(string $value): string
    {
        if (0 === strpos($value, '--')) {
            $value = substr($value, 2);
        }


        $str = preg_replace('/[^\-\(\)\.\,0-9 ]/', '', $value);
        $len = \strlen($str);
        if ('(' === $str[0] && ')' === $str[$len - 1]) {
            $str = '-' . substr($str, 1, $len - 2);
        }

        Log::debug(sprintf('Stripped "%s" away to "%s"', $value, $str));

        return $str;
    }
}