[EGD-3147] SMS incoming ASCII characters (#939)

Author: jimmorrisson

changelog.md

@@ -22,6 +22,7 @@
 * `[GUI][messages]` Fixed not showing number on deleting temporary contact
 * `[GUI]` Fixed filling Label with color
 * `[calculator]` Fix phone hanging when pressing '='.
+* `[messages][cellular]` Fixed special SMS handling -> ASCII instead of number.
 
 ## [0.44.1 2020-10-30]
 

module-services/service-cellular/ServiceCellular.cpp

@@ -1344,7 +1344,7 @@ bool ServiceCellular::receiveSMS(std::string messageNumber)
 
                     SMSRecord record;
                     record.body   = decodedMessage;
-                    record.number = utils::PhoneNumber(receivedNumber, utils::country::Id::UNKNOWN).getView();
+                    record.number = utils::PhoneNumber::getReceivedNumberView(receivedNumber);
                     record.type   = SMSType::INBOX;
                     record.date   = messageDate;
 

module-utils/PhoneNumber.cpp

@@ -328,3 +328,10 @@ const PhoneNumber::View &PhoneNumber::getView() const
 {
     return viewSelf;
 }
+
+const PhoneNumber::View PhoneNumber::getReceivedNumberView(const UTF8 &receivedNumber)
+{
+    return (receivedNumber.isASCIICombination())
+               ? utils::PhoneNumber(receivedNumber.toASCII().value(), utils::country::Id::UNKNOWN).getView()
+               : utils::PhoneNumber(receivedNumber, utils::country::Id::UNKNOWN).getView();
+}

module-utils/PhoneNumber.hpp

@@ -8,7 +8,7 @@
 #include <phonenumbers/phonenumberutil.h>
 
 #include <exception>
-#include <string>
+#include <module-utils/utf8/UTF8.hpp>
 
 namespace utils
 {
@@ -347,6 +347,15 @@ namespace utils
          */
         static View parse(const std::string &inputNumber);
 
+        /**
+         * @brief Get lightweight representation of a PhoneNumber (see View class).
+         *
+         * @param received number - utf8 representation of received number
+         * @return View - instance of View object which represents state of
+         * PhoneNumber instance.
+         */
+        static const View getReceivedNumberView(const UTF8 &receivedNumber);
+
       private:
         View makeView(const std::string &input) const;
 

module-utils/test/unittest_ucs2.cpp

@@ -14,6 +14,21 @@ TEST_CASE("UCS2 to UTF8 conversion")
     REQUIRE((uint32_t)('e') == decodedMessage[1]);
     REQUIRE((uint32_t)('s') == decodedMessage[2]);
     REQUIRE((uint32_t)('t') == decodedMessage[3]);
+
+    SECTION("UTF8 IS ASCII combination")
+    {
+        auto utf8 = UCS2(std::string("00380034003800370037003300380034003800340036003900380032")).toUTF8();
+        REQUIRE(utf8.isASCIICombination());
+        auto ascii = utf8.toASCII();
+        REQUIRE(ascii == std::string("TWITTER"));
+    }
+
+    SECTION("UTF8 IS NOT ASCII combination")
+    {
+        auto utf8 = UCS2(std::string("003200390031")).toUTF8();
+        REQUIRE_FALSE(utf8.isASCIICombination());
+        REQUIRE_FALSE(utf8.toASCII().has_value());
+    }
 }
 
 TEST_CASE("UCS2 from UTF8 emoji 😁")

module-utils/test/unittest_utf8.cpp

@@ -339,3 +339,41 @@ TEST_CASE("UTF8: insert whole string which doesn't work")
     REQUIRE(lol == fin);
     REQUIRE(lol.length() == len);
 }
+
+TEST_CASE("UTF8: Convert to ascii if is ascii combination")
+{
+    UTF8 combination = "778568738465";
+    REQUIRE(combination.isASCIICombination());
+    REQUIRE(combination.toASCII() == std::string("MUDITA"));
+}
+
+TEST_CASE("UTF8: Not ASCII combination")
+{
+    SECTION("Pl number - 9 digits")
+    {
+        UTF8 combination = "600123456";
+        REQUIRE_FALSE(combination.isASCIICombination());
+        REQUIRE_FALSE(combination.toASCII().has_value());
+    }
+
+    SECTION("Pl e164 number")
+    {
+        UTF8 combination = "+48600123456";
+        REQUIRE_FALSE(combination.isASCIICombination());
+        REQUIRE_FALSE(combination.toASCII().has_value());
+    }
+
+    SECTION("Pl formatted number")
+    {
+        UTF8 combination = "600 123 456";
+        REQUIRE_FALSE(combination.isASCIICombination());
+        REQUIRE_FALSE(combination.toASCII().has_value());
+    }
+
+    SECTION("Pl formatted int number")
+    {
+        UTF8 combination = "+48 600 123 456";
+        REQUIRE_FALSE(combination.isASCIICombination());
+        REQUIRE_FALSE(combination.toASCII().has_value());
+    }
+}

module-utils/utf8/UTF8.cpp

@@ -791,3 +791,58 @@ std::ostream &operator<<(std::ostream &os, const UTF8 &el)
     os << el.c_str();
     return os;
 }
+
+bool UTF8::isASCIICombination() const noexcept
+{
+    const auto len                          = strlen(data.get());
+    std::size_t i                           = 0;
+    constexpr char asciiZero                = '0';
+    constexpr uint8_t firstCharacterFactor  = 100;
+    constexpr uint8_t secondCharacterFactor = 10;
+    for (; i < len; i += 2) {
+        int firstCharacter = 0;
+        if (data[i] == '1') {
+            firstCharacter = static_cast<int>(data[i] - asciiZero) * firstCharacterFactor;
+            ++i;
+        }
+        if (i + 1 >= len) {
+            return false;
+        }
+        const auto combinedCharacters = static_cast<char>(
+            firstCharacter + ((data[i] - asciiZero) * secondCharacterFactor) + (data[i + 1] - asciiZero));
+        if (!std::isprint(combinedCharacters)) {
+            return false;
+        }
+    }
+    return i == len;
+}
+
+std::optional<std::string> UTF8::toASCII() const noexcept
+{
+    std::string ret{};
+    const auto len                          = strlen(data.get());
+    constexpr char asciiZero                = '0';
+    constexpr uint8_t firstCharacterFactor  = 100;
+    constexpr uint8_t secondCharacterFactor = 10;
+    std::size_t i                           = 0;
+    for (; i < len; i += 2) {
+        int firstCharacter = 0;
+        if (data[i] == '1') {
+            firstCharacter = static_cast<int>(data[i] - asciiZero) * firstCharacterFactor;
+            ++i;
+        }
+        if (i + 1 >= len) {
+            return std::nullopt;
+        }
+        const auto combinedCharacters = static_cast<char>(
+            firstCharacter + ((data[i] - asciiZero) * secondCharacterFactor) + (data[i + 1] - asciiZero));
+        if (!std::isprint(combinedCharacters)) {
+            return std::nullopt;
+        }
+        ret.push_back(combinedCharacters);
+    }
+
+    if (i != len)
+        return std::nullopt;
+    return ret;
+}

module-utils/utf8/UTF8.hpp

@@ -7,6 +7,7 @@
 #include <cstdint>
 #include <iosfwd> // for forward declaration for ostream
 #include <memory>
+#include <optional>
 
 /// single utf8 character representation struct
 struct U8char
@@ -233,4 +234,16 @@ class UTF8
      * @return true if there was no error, false otherwise.
      */
     static bool getStreamLength(const char *stream, uint32_t &size, uint32_t &count);
+    /**
+     * @brief Checks if numbers contained in the UTF8 creates ASCII character combination
+     * eg. 778568738465 returns true
+     * @return true if is acii combination, false otherwise
+     */
+    [[nodiscard]] bool isASCIICombination() const noexcept;
+    /**
+     * @brief Converts UTF8 to ASCII character combination
+     * eg. 778568738465 returns "MUDITA"
+     * @return ASCII converted string
+     */
+    [[nodiscard]] std::optional<std::string> toASCII() const noexcept;
 };