2277 UUID

common/utils/UuidUtils.php

@@ -0,0 +1,100 @@
+<?php
+/**
+ * Utility class for Uuid creation.
+ *
+ * @package   OpenEMR
+ * @link      http://www.open-emr.org
+ * @author    Gerhard Brink <gjdbrink@gmail.com>
+ * @copyright Copyright (c) 2019 Gerhard Brink <gjdbrink@gmail.com>
+ * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
+ */
+
+namespace OpenEMR\Common\Utils;
+
+use Ramsey\Uuid\Uuid;
+
+class UuidUtils
+{
+
+    const MAX_TRIES = 100;
+
+    /**
+     * @param string $table
+     *
+     * @return string
+     * @throws \Exception
+     */
+    public static function createUuid(string $table): string
+    {
+        $uuid4 = Uuid::uuid4();
+
+        $try = 1;
+        while (self::findCollision($table, $uuid4)) {
+            if ($try > self::MAX_TRIES) {
+                throw new \Exception('Reached maximum amount of tries (max amount: '.self::MAX_TRIES.')');
+            }
+
+            $uuid4 = Uuid::uuid4();
+            $try++;
+        }
+
+        return $uuid4->toString();
+    }
+
+    /**
+     * @param $table
+     * @param $uuid
+     *
+     * @return bool
+     */
+    public static function findCollision(string $table, string $uuid): bool
+    {
+        $query = "SELECT uuid FROM ".$table." WHERE uuid = ?";
+
+        if (sqlQuery($query, $uuid)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $table
+     *
+     * @throws \Exception
+     */
+    public static function createMissingUuids(string $table)
+    {
+        $query = "SELECT id FROM ".$table." WHERE uuid = ''";
+
+        $resultSet = sqlStatement($query);
+
+        while ($row = sqlFetchArray($resultSet)) {
+
+            $uuid = self::createUuid($table);
+
+            $updateQuery = "UPDATE ".$table." SET uuid = ? WHERE id = ?";
+
+            sqlQuery($updateQuery, [$uuid, $row['id']]);
+        }
+
+    }
+
+    /**
+     * @param string $table
+     *
+     * @return bool
+     */
+    public static function tableNeedsUuidCreation(string $table): bool
+    {
+        $query = "SELECT count(id) as total FROM ".$table." WHERE uuid = ''";
+
+        $resultSet = sqlQuery($query);
+
+        if ($resultSet['total'] > 0) {
+           return true;
+        }
+
+        return false;
+    }
+}

composer.json

@@ -42,7 +42,8 @@
         "academe/omnipay-authorizenetapi": "3.1.1",
         "omnipay/stripe": "3.0.1",
         "waryway/php-traits-library": "1.0.4",
-        "paragonie/multi-factor": "0.2.2"
+        "paragonie/multi-factor": "0.2.2",
+        "ramsey/uuid": "^3.8"
     },
     "config": {
         "platform": {

library/patient.inc

@@ -11,6 +11,7 @@
 
 
 use OpenEMR\Services\FacilityService;
+use OpenEMR\Common\Utils\UuidUtils;
 
 $facilityService = new FacilityService();
 
@@ -1149,6 +1150,11 @@ function updatePatientData($pid, $new, $create = false)
             $sql .= ", `$key` = " . pdValueOrNull($key, $value);
         }
 
+        //create uuid for patient
+        $uuid = UuidUtils::createUuid('patient_data');
+
+        $sql .= ", uuid ='".add_escape_custom($uuid)."'";
+
         $db_id = sqlInsert($sql);
     } else {
         $db_id = $new['id'];

library/sql_upgrade_fx.php

@@ -866,6 +866,14 @@ function upgradeFromSqlFile($filename)
             if ($skipping) {
                 echo "<font color='green'>Skipping section $line</font><br />\n";
             }
+        } else if (preg_match('/^#IfUuidUpdatePatientsNeeded/', $line)) {
+
+            if ( \OpenEMR\Common\Utils\UuidUtils::tableNeedsUuidCreation('patient_data')) {
+                \OpenEMR\Common\Utils\UuidUtils::createMissingUuids('patient_data');
+            } else {
+                echo "<font color='green'>Skipping section $line</font><br />\n";
+            }
+
         } else if (preg_match('/^#ConvertLayoutProperties/', $line)) {
             if ($skipping) {
                 echo "<font color='green'>Skipping section $line</font><br />\n";

services/PatientService.php

@@ -15,6 +15,7 @@
 namespace OpenEMR\Services;
 
 use Particle\Validator\Validator;
+use OpenEMR\Common\Utils\UuidUtils;
 
 class PatientService
 {
@@ -114,6 +115,8 @@ public function insert($data)
     {
         $fresh_pid = $this->getFreshPid();
 
+        $uuid = UuidUtils::createUuid('patient_data');
+
         $sql = " INSERT INTO patient_data SET";
         $sql .= "     pid=?,";
         $sql .= "     title=?,";
@@ -130,6 +133,7 @@ public function insert($data)
         $sql .= "     sex=?,";
         $sql .= "     race=?,";
         $sql .= "     ethnicity=?";
+        $sql .= "     uuid=?";
 
         $results = sqlInsert(
             $sql,
@@ -148,7 +152,8 @@ public function insert($data)
                 $data["dob"],
                 $data["sex"],
                 $data["race"],
-                $data["ethnicity"]
+                $data["ethnicity"],
+                $uuid
             )
         );
 

sql/5_0_1-to-5_0_2_upgrade.sql

@@ -85,6 +85,10 @@
 --    arguments: none
 --    behavior: can take a long time.
 
+--  #IfUuidUpdatePatientsNeeded
+--    desc: populate patient table with uuids
+--    arguments: none
+
 UPDATE `background_services` SET `require_once`='/library/MedEx/MedEx_background.php' WHERE `name`='MedEx';
 
 #IfNotRow2Dx2 list_options list_id proc_type option_id fgp title Custom Favorite Group

sql/database.sql

@@ -5881,7 +5881,9 @@ CREATE TABLE `patient_data` (
   `guardianphone` TEXT,
   `guardianworkphone` TEXT,
   `guardianemail` TEXT,
+  `uuid` varchar(64),
   UNIQUE KEY `pid` (`pid`),
+  UNIQUE KEY `uuid` (`uuid`),
   KEY `id` (`id`)
 ) ENGINE=InnoDB AUTO_INCREMENT=1 ;
 -----------------------------------------------------------