]> Creatis software - gdcm.git/blobdiff - src/gdcmUtil.cxx
* No comments...
[gdcm.git] / src / gdcmUtil.cxx
index 39d0ba7bdd4fe3f58db869a123ceb3458537dee7..552b5840af767f19e0a9d055283d24b18728a0d3 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmUtil.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/21 11:40:56 $
-  Version:   $Revision: 1.113 $
+  Date:      $Date: 2005/02/01 10:29:56 $
+  Version:   $Revision: 1.128 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include <sys/types.h>
 #include <sys/stat.h>
 
+#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
+#include <sys/timeb.h>
+#else
+#include <sys/time.h>
+#endif
+
 #include <stdarg.h>  //only included in implementation file
 #include <stdio.h>   //only included in implementation file
 
    #include <net/if_dl.h>
 #endif
 #if defined(CMAKE_HAVE_NET_IF_ARP_H) && defined(__sun)
-   // This is absolutely necesseray on SunOS
+   // This is absolutely necessary on SunOS
    #include <net/if_arp.h>
 #endif
 
+// For GetCurrentThreadID()
+#ifdef __linux__
+   #include <sys/types.h>
+   #include <linux/unistd.h>
+#endif
+#ifdef __sun
+   #include <thread.h>
+#endif
+
 namespace gdcm 
 {
+//-------------------------------------------------------------------------
+const std::string Util::GDCM_UID = "1.2.826.0.1.3680043.2.1143";
+std::string Util::RootUID        = GDCM_UID;
+
+//-------------------------------------------------------------------------
 /**
  * \brief Provide a better 'c++' approach for sprintf
  * For example c code is:
@@ -89,7 +109,6 @@ namespace gdcm
  * gdcm style code is
  * Format("%04x|%04x", group , elem);
  */
-
 std::string Util::Format(const char *format, ...)
 {
    char buffer[2048];
@@ -261,6 +280,41 @@ std::string Util::GetCurrentTime()
     return tmp;  
 }
 
+/**
+ * \brief  Get both the date and time at the same time to avoid problem 
+ * around midnight where two call could be before and after midnight
+ */
+std::string Util::GetCurrentDateTime()
+{
+   char tmp[40];
+   long milliseconds;
+   time_t timep;
+  
+   // We need implementation specific functions to obtain millisecond precision
+#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
+   struct timeb tb;
+   ::ftime(&tb);
+   timep = tb.time;
+   milliseconds = tb.millitm;
+#else
+   struct timeval tv;
+   gettimeofday (&tv, NULL);
+   timep = tv.tv_sec;
+   // Compute milliseconds from microseconds.
+   milliseconds = tv.tv_usec / 1000;
+#endif
+   // Obtain the time of day, and convert it to a tm struct.
+   struct tm *ptm = localtime (&timep);
+   // Format the date and time, down to a single second.
+   strftime (tmp, sizeof (tmp), "%Y%m%d%H%M%S", ptm);
+
+   // Add milliseconds
+   std::string r = tmp;
+   r += Format("%03ld", milliseconds);
+
+   return r;
+}
+
 /**
  * \brief Create a /DICOM/ string:
  * It should a of even length (no odd length ever)
@@ -278,13 +332,13 @@ std::string Util::DicomString(const char *s, size_t l)
 
 /**
  * \brief Create a /DICOM/ string:
- * It should a of even lenght (no odd length ever)
+ * It should a of even length (no odd length ever)
  * It can contain as many (if you are reading this from your
  * editor the following character is is backslash followed by zero
  * that needed to be escaped with an extra backslash for doxygen) \\0
  * as you want.
  * This function is similar to DicomString(const char*), 
- * except it doesn't take a lenght
+ * except it doesn't take a length
  * It only pad with a null character if length is odd
  */
 std::string Util::DicomString(const char *s)
@@ -301,8 +355,8 @@ std::string Util::DicomString(const char *s)
 
 /**
  * \brief Safely compare two Dicom String:
- *        - Both string should be of even lenght
- *        - We allow padding of even lenght string by either a null 
+ *        - Both string should be of even length
+ *        - We allow padding of even length string by either a null 
  *          character of a space
  */
 bool Util::DicomStringEqual(const std::string &s1, const char *s2)
@@ -317,8 +371,6 @@ bool Util::DicomStringEqual(const std::string &s1, const char *s2)
   return s1_even == s2_even;
 }
 
-
-
 /**
  * \brief   tells us if the processor we are working with is BigEndian or not
  */
@@ -331,29 +383,27 @@ bool Util::IsCurrentProcessorBigEndian()
 #endif
 }
 
-
-
 #ifdef _WIN32
-typedef BOOL(WINAPI * pSnmpExtensionInit) (
-        IN DWORD dwTimeZeroReference,
-        OUT HANDLE * hPollForTrapEvent,
-        OUT AsnObjectIdentifier * supportedView);
-
-typedef BOOL(WINAPI * pSnmpExtensionTrap) (
-        OUT AsnObjectIdentifier * enterprise,
-        OUT AsnInteger * genericTrap,
-        OUT AsnInteger * specificTrap,
-        OUT AsnTimeticks * timeStamp,
-        OUT RFC1157VarBindList * variableBindings);
-
-typedef BOOL(WINAPI * pSnmpExtensionQuery) (
-        IN BYTE requestType,
-        IN OUT RFC1157VarBindList * variableBindings,
-        OUT AsnInteger * errorStatus,
-        OUT AsnInteger * errorIndex);
-
-typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
-        OUT AsnObjectIdentifier * supportedView);
+   typedef BOOL(WINAPI * pSnmpExtensionInit) (
+           IN DWORD dwTimeZeroReference,
+           OUT HANDLE * hPollForTrapEvent,
+           OUT AsnObjectIdentifier * supportedView);
+
+   typedef BOOL(WINAPI * pSnmpExtensionTrap) (
+           OUT AsnObjectIdentifier * enterprise,
+           OUT AsnInteger * genericTrap,
+           OUT AsnInteger * specificTrap,
+           OUT AsnTimeticks * timeStamp,
+           OUT RFC1157VarBindList * variableBindings);
+
+   typedef BOOL(WINAPI * pSnmpExtensionQuery) (
+           IN BYTE requestType,
+           IN OUT RFC1157VarBindList * variableBindings,
+           OUT AsnInteger * errorStatus,
+           OUT AsnInteger * errorIndex);
+
+   typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
+           OUT AsnObjectIdentifier * supportedView);
 #endif //_WIN32
 
 
@@ -385,24 +435,18 @@ int GetMacAddrSys ( unsigned char *addr )
    AsnObjectIdentifier MIB_NULL = { 0, 0 };
    int ret;
    int dtmp;
-   int i = 0, j = 0;
-   BOOL found = FALSE;
+   int j = 0;
 
    // Load the SNMP dll and get the addresses of the functions necessary
    HINSTANCE m_hInst = LoadLibrary("inetmib1.dll");
    if (m_hInst < (HINSTANCE) HINSTANCE_ERROR)
    {
-      m_hInst = NULL;
       return -1;
    }
    pSnmpExtensionInit m_Init =
        (pSnmpExtensionInit) GetProcAddress(m_hInst, "SnmpExtensionInit");
-   pSnmpExtensionInitEx m_InitEx =
-       (pSnmpExtensionInitEx) GetProcAddress(m_hInst, "SnmpExtensionInitEx");
    pSnmpExtensionQuery m_Query =
        (pSnmpExtensionQuery) GetProcAddress(m_hInst, "SnmpExtensionQuery");
-   pSnmpExtensionTrap m_Trap =
-       (pSnmpExtensionTrap) GetProcAddress(m_hInst, "SnmpExtensionTrap");
    m_Init(GetTickCount(), &PollForTrapEvent, &SupportedView);
 
    /* Initialize the variable list to be retrieved by m_Query */
@@ -414,7 +458,7 @@ int GetMacAddrSys ( unsigned char *addr )
    // Inteface table
    varBindList.len = 1;        // Only retrieving one item
    SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryNum);
-   ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
+   m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
                  &errorIndex);
 //   printf("# of adapters in this system : %i\n",
 //          varBind[0].value.asnValue.number);
@@ -447,7 +491,6 @@ int GetMacAddrSys ( unsigned char *addr )
       {
          j++;
          dtmp = varBind[0].value.asnValue.number;
-         std::cerr << "Interface #" << j << " type : " << dtmp << std::endl;
 
          // Type 6 describes ethernet interfaces
          if (dtmp == 6)
@@ -553,13 +596,13 @@ int GetMacAddrSys ( unsigned char *addr )
 // We should investiage the use of SIZEOF_ADDR_IFREQ
 //
 #ifdef HAVE_SA_LEN
-#ifndef max
-#define max(a,b) ((a) > (b) ? (a) : (b))
-#endif
-#define ifreq_size(i) max(sizeof(struct ifreq),\
-     sizeof((i).ifr_name)+(i).ifr_addr.sa_len)
+   #ifndef max
+      #define max(a,b) ((a) > (b) ? (a) : (b))
+   #endif
+   #define ifreq_size(i) max(sizeof(struct ifreq),\
+        sizeof((i).ifr_name)+(i).ifr_addr.sa_len)
 #else
-#define ifreq_size(i) sizeof(struct ifreq)
+   #define ifreq_size(i) sizeof(struct ifreq)
 #endif // HAVE_SA_LEN
 
    if( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
@@ -617,7 +660,7 @@ int GetMacAddrSys ( unsigned char *addr )
    }
    close(sd);
 #endif
-   /* Not implemented platforms */
+   // Not implemented platforms
    perror("There was a configuration problem on your plateform");
    memset(addr,0,6);
    return -1;
@@ -625,7 +668,25 @@ int GetMacAddrSys ( unsigned char *addr )
 }
 
 /**
- * \brief Gets the M.A.C. adress of the machine writting the DICOM image
+ * Mini function to return the last digit from a number express in base 256
+ * pre condition data contain an array of 6 unsigned char
+ * post condition carry contain the last digit
+ */
+inline int getlastdigit(unsigned char *data)
+{
+  int extended, carry = 0;
+  for(int i=0;i<6;i++)
+    {
+    extended = (carry << 8) + data[i];
+    data[i] = extended / 10;
+    carry = extended % 10;
+    }
+  return carry;
+}
+
+/**
+ * \brief Encode the mac address on a fixed lenght string of 15 characters.
+ * we save space this way.
  */
 std::string Util::GetMACAddress()
 {
@@ -635,18 +696,24 @@ std::string Util::GetMACAddress()
    // http://groups-beta.google.com/group/comp.unix.solaris/msg/ad36929d783d63be
    // http://bdn.borland.com/article/0,1410,26040,00.html
    unsigned char addr[6];
-   std::string macaddr;
+
    int stat = GetMacAddrSys(addr);
-   if (0 == stat)
+   if (stat == 0)
    {
-      for (int i=0; i<6; ++i) 
+      // We need to convert a 6 digit number from base 256 to base 10, using integer
+      // would requires a 48bits one. To avoid this we have to reimplement the div + modulo 
+      // with string only
+      bool zero = false;
+      int res;
+      std::string sres;
+      while(!zero)
       {
-         macaddr += Format("%2.2x", addr[i]);
-         //if(i) macaddr += ".";
-         //macaddr += Format("%i", (int)addr[i]);
+         res = getlastdigit(addr);
+         sres.insert(sres.begin(), '0' + res);
+         zero = (addr[0] == 0) && (addr[1] == 0) && (addr[2] == 0) && (addr[3] == 0) && (addr[4] == 0) && (addr[5] == 0);
       }
-      return macaddr;
+
+      return sres;
    }
    else
    {
@@ -666,7 +733,7 @@ std::string Util::GetIPAddress()
    // SUSv2 guarantees that `Host names are limited to 255 bytes'.
    // POSIX 1003.1-2001 guarantees that `Host names (not including the
    // terminating NUL) are limited to HOST_NAME_MAX bytes'.
-#  define HOST_NAME_MAX 255
+#define HOST_NAME_MAX 255
    // In this case we should maybe check the string was not truncated.
    // But I don't known how to check that...
 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
@@ -716,32 +783,92 @@ std::string Util::GetIPAddress()
    return str;
 }
 
+unsigned int Util::GetCurrentThreadID()
+{
+// FIXME the implementation is far from complete
+#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
+  return (unsigned int)GetCurrentThreadId();
+#endif
+#ifdef __linux__
+   return 0;
+   // Doesn't work on fedora, but is in the man page...
+   //return (unsigned int)gettid();
+#endif
+#ifdef __sun
+   return (unsigned int)thr_self();
+#else
+   //default implementation
+   return 0;
+#endif
+}
+
+unsigned int Util::GetCurrentProcessID()
+{
+#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
+  // NOTE: There is also a _getpid()...
+  return (unsigned int)GetCurrentProcessId();
+#else
+  // get process identification, POSIX
+  return (unsigned int)getpid();
+#endif
+}
+
 /**
  * \brief Creates a new UID. As stipulate in the DICOM ref
  *        each time a DICOM image is create it should have 
  *        a unique identifier (URI)
+ * @param root is the DICOM prefix assigned by IOS group
  */
 std::string Util::CreateUniqueUID(const std::string &root)
 {
-   std::string radical = root;
-   if( !root.size() )
+   std::string prefix;
+   std::string append;
+   if( root.empty() )
+   {
+      // gdcm UID prefix, as supplied by http://www.medicalconnections.co.uk
+      prefix = RootUID; 
+   }
+   else
    {
-      // No root was specified use "GDCM" then
-      // echo "gdcm" | od -b
-      // 0000000 147 144 143 155 012
-      radical = "147.144.143.155"; // special easter egg 
+      prefix = root;
    }
-   // else
+
    // A root was specified use it to forge our new UID:
-   radical += Util::GetMACAddress();
-   radical += ".";
-   radical += Util::GetCurrentDate();
-   radical += ".";
-   radical += Util::GetCurrentTime();
+   append += ".";
+   append += Util::GetMACAddress();
+   append += ".";
+   append += Util::GetCurrentDateTime();
+
+   //Also add a mini random number just in case:
+   int r = (int) (100.0*rand()/RAND_MAX);
+   append += Format("%02d", r);
 
-   return radical;
+   // If append is too long we need to rehash it
+   if( (prefix + append).size() > 64 )
+   {
+      gdcmErrorMacro( "Size of UID is too long." );
+      // we need a hash function to truncate this number
+      // if only md5 was cross plateform
+      // MD5(append);
+   }
+
+   return prefix + append;
+}
+
+void Util::SetRootUID(const std::string &root)
+{
+   if( root.empty() )
+      RootUID = GDCM_UID;
+   else
+      RootUID = root;
+}
+
+const std::string &Util::GetRootUID()
+{
+   return RootUID;
 }
 
+//-------------------------------------------------------------------------
 /**
  * \brief
  * @param os ostream to write to
@@ -806,5 +933,6 @@ std::ostream &binary_write(std::ostream &os, std::string const &val)
    return os.write(val.c_str(), val.size());
 }
 
+//-------------------------------------------------------------------------
 } // end namespace gdcm