THRIFT-5587: Add UUID support for PHP

compiler/cpp/src/thrift/generate/t_php_generator.cc

@@ -671,6 +671,9 @@ string t_php_generator::render_const_value(t_type* type, t_const_value* value) {
         out << value->get_double();
       }
       break;
+    case t_base_type::TYPE_UUID:
+      out << '"' << get_escaped_string(value) << '"';
+      break;
     default:
       throw "compiler error: no const of base type " + t_base_type::t_base_name(tbase);
     }
@@ -2175,6 +2178,15 @@ void t_php_generator::generate_deserialize_field(ostream& out,
             out << indent() << "$arr = unpack('d', strrev(" << itrans << "->readAll(8)));" << '\n'
                 << indent() << "$" << name << " = $arr[1];" << '\n';
             break;
+          case t_base_type::TYPE_UUID:
+            out << indent() << "$_uuid_bin = " << itrans << "->readAll(16);" << '\n'
+                << indent() << "$_uuid_hex = bin2hex($_uuid_bin);" << '\n'
+                << indent() << "$" << name << " = substr($_uuid_hex, 0, 8) . '-' . "
+                << "substr($_uuid_hex, 8, 4) . '-' . "
+                << "substr($_uuid_hex, 12, 4) . '-' . "
+                << "substr($_uuid_hex, 16, 4) . '-' . "
+                << "substr($_uuid_hex, 20, 12);" << '\n';
+            break;
           default:
             throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase)
                 + tfield->get_name();
@@ -2216,6 +2228,9 @@ void t_php_generator::generate_deserialize_field(ostream& out,
           case t_base_type::TYPE_DOUBLE:
             out << "readDouble($" << name << ");";
             break;
+          case t_base_type::TYPE_UUID:
+            out << "readUuid($" << name << ");";
+            break;
           default:
             throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase);
           }
@@ -2417,6 +2432,9 @@ void t_php_generator::generate_serialize_field(ostream& out, t_field* tfield, st
         case t_base_type::TYPE_DOUBLE:
           out << indent() << "$output .= strrev(pack('d', $" << name << "));" << '\n';
           break;
+        case t_base_type::TYPE_UUID:
+          out << indent() << "$output .= hex2bin(str_replace('-', '', $" << name << "));" << '\n';
+          break;
         default:
           throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase);
         }
@@ -2454,6 +2472,9 @@ void t_php_generator::generate_serialize_field(ostream& out, t_field* tfield, st
         case t_base_type::TYPE_DOUBLE:
           out << "writeDouble($" << name << ");";
           break;
+        case t_base_type::TYPE_UUID:
+          out << "writeUuid($" << name << ");";
+          break;
         default:
           throw "compiler error: no PHP name for base type " + t_base_type::t_base_name(tbase);
         }
@@ -2782,6 +2803,8 @@ string t_php_generator::type_to_cast(t_type* type) {
       return "(double)";
     case t_base_type::TYPE_STRING:
       return "(string)";
+    case t_base_type::TYPE_UUID:
+      return "(string)";
     default:
       return "";
     }
@@ -2816,6 +2839,8 @@ string t_php_generator::type_to_enum(t_type* type) {
       return "TType::I64";
     case t_base_type::TYPE_DOUBLE:
       return "TType::DOUBLE";
+    case t_base_type::TYPE_UUID:
+      return "TType::UUID";
     default:
       throw "compiler error: unhandled type";
     }
@@ -2859,6 +2884,8 @@ string t_php_generator::type_to_phpdoc(t_type* type) {
       return "int";
     case t_base_type::TYPE_DOUBLE:
       return "double";
+    case t_base_type::TYPE_UUID:
+      return "string";
     default:
       throw "compiler error: unhandled type";
     }

lib/php/lib/Base/TBase.php

@@ -41,7 +41,8 @@ abstract class TBase
         TType::I32 => 'I32',
         TType::I64 => 'I64',
         TType::DOUBLE => 'Double',
-        TType::STRING => 'String'
+        TType::STRING => 'String',
+        TType::UUID => 'Uuid'
     );
 
     abstract public function read($input);

lib/php/lib/Protocol/TBinaryProtocol.php

@@ -220,6 +220,15 @@ public function writeString($value)
         return $result + $len;
     }
 
+    public function writeUuid($uuid)
+    {
+        self::validateUuid($uuid);
+        $data = hex2bin(str_replace('-', '', $uuid));
+        $this->trans_->write($data, 16);
+
+        return 16;
+    }
+
     public function readMessageBegin(&$name, &$type, &$seqid)
     {
         $result = $this->readI32($sz);
@@ -450,4 +459,17 @@ public function readString(&$value)
 
         return $result + $len;
     }
+
+    public function readUuid(&$value)
+    {
+        $data = $this->trans_->readAll(16);
+        $hex = bin2hex($data);
+        $value = substr($hex, 0, 8) . '-' .
+                 substr($hex, 8, 4) . '-' .
+                 substr($hex, 12, 4) . '-' .
+                 substr($hex, 16, 4) . '-' .
+                 substr($hex, 20, 12);
+
+        return 16;
+    }
 }

lib/php/lib/Protocol/TCompactProtocol.php

@@ -45,6 +45,7 @@ class TCompactProtocol extends TProtocol
     const COMPACT_SET = 0x0A;
     const COMPACT_MAP = 0x0B;
     const COMPACT_STRUCT = 0x0C;
+    const COMPACT_UUID = 0x0D;
 
     const STATE_CLEAR = 0;
     const STATE_FIELD_WRITE = 1;
@@ -76,6 +77,7 @@ class TCompactProtocol extends TProtocol
         TType::LST => TCompactProtocol::COMPACT_LIST,
         TType::SET => TCompactProtocol::COMPACT_SET,
         TType::MAP => TCompactProtocol::COMPACT_MAP,
+        TType::UUID => TCompactProtocol::COMPACT_UUID,
     );
 
     protected static $ttypes = array(
@@ -92,6 +94,7 @@ class TCompactProtocol extends TProtocol
         TCompactProtocol::COMPACT_LIST => TType::LST,
         TCompactProtocol::COMPACT_SET => TType::SET,
         TCompactProtocol::COMPACT_MAP => TType::MAP,
+        TCompactProtocol::COMPACT_UUID => TType::UUID,
     );
 
     protected $state = TCompactProtocol::STATE_CLEAR;
@@ -370,6 +373,15 @@ public function writeString($value)
         return $result + $len;
     }
 
+    public function writeUuid($uuid)
+    {
+        self::validateUuid($uuid);
+        $data = hex2bin(str_replace('-', '', $uuid));
+        $this->trans_->write($data, 16);
+
+        return 16;
+    }
+
     public function readFieldBegin(&$name, &$field_type, &$field_id)
     {
         $result = $this->readUByte($compact_type_and_delta);
@@ -587,6 +599,19 @@ public function readString(&$value)
         return $result + $len;
     }
 
+    public function readUuid(&$value)
+    {
+        $data = $this->trans_->readAll(16);
+        $hex = bin2hex($data);
+        $value = substr($hex, 0, 8) . '-' .
+                 substr($hex, 8, 4) . '-' .
+                 substr($hex, 12, 4) . '-' .
+                 substr($hex, 16, 4) . '-' .
+                 substr($hex, 20, 12);
+
+        return 16;
+    }
+
     public function getTType($byte)
     {
         return self::$ttypes[$byte & 0x0f];

lib/php/lib/Protocol/TJSONProtocol.php

@@ -74,6 +74,7 @@ class TJSONProtocol extends TProtocol
     const NAME_MAP = "map";
     const NAME_LIST = "lst";
     const NAME_SET = "set";
+    const NAME_UUID = "uid";
 
     private function getTypeNameForTypeID($typeID)
     {
@@ -100,6 +101,8 @@ private function getTypeNameForTypeID($typeID)
                 return self::NAME_SET;
             case TType::LST:
                 return self::NAME_LIST;
+            case TType::UUID:
+                return self::NAME_UUID;
             default:
                 throw new TProtocolException("Unrecognized type", TProtocolException::UNKNOWN);
         }
@@ -149,6 +152,9 @@ private function getTypeIDForTypeName($name)
                 case 't':
                     $result = TType::BOOL;
                     break;
+                case 'u':
+                    $result = TType::UUID;
+                    break;
             }
         }
         if ($result == TType::STOP) {
@@ -574,6 +580,12 @@ public function writeString($str)
         $this->writeJSONString($str);
     }
 
+    public function writeUuid($uuid)
+    {
+        self::validateUuid($uuid);
+        $this->writeJSONString($uuid);
+    }
+
     /**
      * Reads the message header
      *
@@ -730,4 +742,12 @@ public function readString(&$str)
 
         return true;
     }
+
+    public function readUuid(&$uuid)
+    {
+        $uuid = $this->readJSONString(false);
+        self::validateUuid($uuid);
+
+        return true;
+    }
 }

lib/php/lib/Protocol/TProtocol.php

@@ -129,6 +129,15 @@ abstract public function writeDouble($dub);
 
     abstract public function writeString($str);
 
+    abstract public function writeUuid($uuid);
+
+    protected static function validateUuid($uuid)
+    {
+        if (!is_string($uuid) || !preg_match('/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/', $uuid)) {
+            throw new TProtocolException('Invalid UUID format', TProtocolException::INVALID_DATA);
+        }
+    }
+
     /**
      * Reads the message header
      *
@@ -177,6 +186,8 @@ abstract public function readDouble(&$dub);
 
     abstract public function readString(&$str);
 
+    abstract public function readUuid(&$uuid);
+
     /**
      * The skip function is a utility to parse over unrecognized date without
      * causing corruption.
@@ -200,6 +211,8 @@ public function skip($type)
                 return $this->readDouble($dub);
             case TType::STRING:
                 return $this->readString($str);
+            case TType::UUID:
+                return $this->readUuid($uuid);
             case TType::STRUCT:
                 $result = $this->readStructBegin($name);
                 while (true) {
@@ -271,6 +284,8 @@ public static function skipBinary($itrans, $type)
                 return $itrans->readAll(8);
             case TType::DOUBLE:
                 return $itrans->readAll(8);
+            case TType::UUID:
+                return $itrans->readAll(16);
             case TType::STRING:
                 $len = unpack('N', $itrans->readAll(4));
                 $len = $len[1];

lib/php/lib/Protocol/TProtocolDecorator.php

@@ -178,6 +178,11 @@ public function writeString($str)
         return $this->concreteProtocol_->writeString($str);
     }
 
+    public function writeUuid($uuid)
+    {
+        return $this->concreteProtocol_->writeUuid($uuid);
+    }
+
     /**
      * Reads the message header
      *
@@ -282,4 +287,9 @@ public function readString(&$str)
     {
         return $this->concreteProtocol_->readString($str);
     }
+
+    public function readUuid(&$uuid)
+    {
+        return $this->concreteProtocol_->readUuid($uuid);
+    }
 }

lib/php/lib/Protocol/TSimpleJSONProtocol.php

@@ -270,6 +270,11 @@ public function writeString($str)
         $this->writeJSONString($str);
     }
 
+    public function writeUuid($uuid)
+    {
+        $this->writeJSONString($uuid);
+    }
+
     /**
      * Reading methods.
      *
@@ -372,4 +377,9 @@ public function readString(&$str)
     {
         throw new TException("Not implemented");
     }
+
+    public function readUuid(&$uuid)
+    {
+        throw new TException("Not implemented");
+    }
 }

lib/php/lib/Type/TType.php

@@ -42,6 +42,7 @@ class TType
     const MAP    = 13;
     const SET    = 14;
     const LST    = 15;    // N.B. cannot use LIST keyword in PHP!
+    const UUID   = 16;
     const UTF8   = 16;
     const UTF16  = 17;
 }

lib/php/test/Resources/ThriftTest.thrift

@@ -19,7 +19,7 @@
 
 namespace php TestValidators
 
-include "../../../../test/v0.16/ThriftTest.thrift"
+include "../../../../test/ThriftTest.thrift"
 
 union UnionOfStrings {
   1: string aa;