]> Creatis software - gdcm.git/blobdiff - src/gdcmUtil.cxx
Cosmetics
[gdcm.git] / src / gdcmUtil.cxx
index 0f121c26635a1f948b7e92ff4a8b3b7c4abc7cee..8fa6d9b14a896741213ae16efff9e18f7f01660e 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmUtil.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/17 17:26:55 $
-  Version:   $Revision: 1.106 $
+  Date:      $Date: 2005/01/28 17:29:59 $
+  Version:   $Revision: 1.127 $
                                                                                 
   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
 
-#if defined(_MSC_VER)
+#if defined(_MSC_VER) || defined(__MINGW32__)
    #include <winsock.h>  // for gethostname & gethostbyname
    #undef GetCurrentTime
 #else
    #include <sys/types.h>
 #endif
 
-// How do I do that in CMake ?
-#ifdef __APPLE__
-   #define HAVE_SA_LEN
-#endif //APPLE
-
 #ifdef CMAKE_HAVE_SYS_IOCTL_H
    #include <sys/ioctl.h>  // For SIOCGIFCONF on Linux
 #endif
    #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;
+
 /**
- * \ingroup Globals
  * \brief Provide a better 'c++' approach for sprintf
  * For example c code is:
  * sprintf(trash, "%04x|%04x", group , elem);
@@ -110,7 +122,6 @@ std::string Util::Format(const char *format, ...)
 
 
 /**
- * \ingroup Globals
  * \brief Because not available in C++ (?)
  */
 void Util::Tokenize (const std::string &str,
@@ -128,7 +139,6 @@ void Util::Tokenize (const std::string &str,
 }
 
 /**
- * \ingroup Globals
  * \brief Because not available in C++ (?)
  *        Counts the number of occurences of a substring within a string
  */
@@ -154,7 +164,6 @@ int Util::CountSubstring (const std::string &str,
 }
 
 /**
- * \ingroup Globals
  * \brief  Weed out a string from the non-printable characters (in order
  *         to avoid corrupting the terminal of invocation when printing)
  * @param s string to remove non printable characters from
@@ -186,7 +195,6 @@ std::string Util::CreateCleanString(std::string const &s)
 }
 
 /**
- * \ingroup Globals
  * \brief   Add a SEPARATOR to the end of the name is necessary
  * @param   pathname file/directory name to normalize 
  */
@@ -206,7 +214,6 @@ std::string Util::NormalizePath(std::string const &pathname)
 }
 
 /**
- * \ingroup Globals
  * \brief   Get the (directory) path from a full path file name
  * @param   fullName file/directory name to extract Path from
  */
@@ -228,7 +235,6 @@ std::string Util::GetPath(std::string const &fullName)
 }
 
 /**
- * \ingroup Util
  * \brief   Get the (last) name of a full path file name
  * @param   fullName file/directory name to extract end name from
  */
@@ -250,7 +256,6 @@ std::string Util::GetName(std::string const &fullName)
 } 
 
 /**
- * \ingroup Util
  * \brief   Get the current date of the system in a dicom string
  */
 std::string Util::GetCurrentDate()
@@ -263,7 +268,6 @@ std::string Util::GetCurrentDate()
 }
 
 /**
- * \ingroup Util
  * \brief   Get the current time of the system in a dicom string
  */
 std::string Util::GetCurrentTime()
@@ -275,6 +279,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)
@@ -291,15 +330,14 @@ std::string Util::DicomString(const char *s, size_t l)
 }
 
 /**
- * \ingroup Util
  * \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)
@@ -315,10 +353,9 @@ std::string Util::DicomString(const char *s)
 }
 
 /**
- * \ingroup Util
  * \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)
@@ -333,10 +370,7 @@ bool Util::DicomStringEqual(const std::string &s1, const char *s2)
   return s1_even == s2_even;
 }
 
-
-
 /**
- * \ingroup Util
  * \brief   tells us if the processor we are working with is BigEndian or not
  */
 bool Util::IsCurrentProcessorBigEndian()
@@ -402,24 +436,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 */
@@ -431,7 +459,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);
@@ -464,7 +492,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)
@@ -513,13 +540,10 @@ int GetMacAddrSys ( unsigned char *addr )
 #ifdef __sun
    //The POSIX version is broken anyway on Solaris, plus would require full
    //root power
-   int                     i;
    struct  arpreq          parpreq;
-   struct  sockaddr_in     sa, *psa;
-   struct  in_addr         inaddr;
+   struct  sockaddr_in     *psa;
    struct  hostent         *phost;
    char                    hostname[MAXHOSTNAMELEN];
-   unsigned char           *ptr;
    char                    **paddrs;
    int                     sock, status=0;
 
@@ -561,7 +585,7 @@ int GetMacAddrSys ( unsigned char *addr )
    char buf[1024];
    int      n, i;
    unsigned char    *a;
-#ifdef AF_LINK
+#if defined(AF_LINK) && (!defined(SIOCGIFHWADDR) && !defined(SIOCGENADDR))
    struct sockaddr_dl *sdlp;
 #endif
 
@@ -637,13 +661,34 @@ 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;
 #endif //__sun
 }
 
+/**
+ * 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()
 {
    // This code is the result of a long internet search to find something
@@ -652,18 +697,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
    {
@@ -673,7 +724,6 @@ std::string Util::GetMACAddress()
 }
 
 /**
- * \ingroup Util
  * \brief   Return the IP adress of the machine writting the DICOM image
  */
 std::string Util::GetIPAddress()
@@ -687,8 +737,8 @@ std::string Util::GetIPAddress()
 #  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__)
-   // with WinSock DLL we need to initialise the WinSock before using gethostname
+#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
+   // with WinSock DLL we need to initialize the WinSock before using gethostname
    WORD wVersionRequested = MAKEWORD(1,0);
    WSADATA WSAData;
    int err = WSAStartup(wVersionRequested,&WSAData);
@@ -723,7 +773,7 @@ std::string Util::GetIPAddress()
          }
          // str now contains one local IP address 
  
-#if defined(_MSC_VER) || defined(__BORLANDC__)
+#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
    WSACleanup();
 #endif
 
@@ -734,39 +784,108 @@ 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
+
+}
+
 /**
- * \ingroup Util
  * \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);
+
+   // 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;
+}
 
-   return radical;
+const std::string &Util::GetRootUID()
+{
+   return RootUID;
 }
 
+/**
+ * \brief
+ * @param os ostream to write to
+ * @param val val
+ */ 
 template <class T>
 std::ostream &binary_write(std::ostream &os, const T &val)
 {
    return os.write(reinterpret_cast<const char*>(&val), sizeof val);
 }
 
+/**
+ * \brief binary_write binary_write
+ * @param os ostream to write to 
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, const uint16_t &val)
 {
 #ifdef GDCM_WORDS_BIGENDIAN
@@ -778,6 +897,11 @@ std::ostream &binary_write(std::ostream &os, const uint16_t &val)
 #endif //GDCM_WORDS_BIGENDIAN
 }
 
+/**
+ * \brief binary_write binary_write
+ * @param os ostream to write to
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, const uint32_t &val)
 {
 #ifdef GDCM_WORDS_BIGENDIAN
@@ -790,11 +914,21 @@ std::ostream &binary_write(std::ostream &os, const uint32_t &val)
 #endif //GDCM_WORDS_BIGENDIAN
 }
 
+/**
+ * \brief  binary_write binary_write
+ * @param os ostream to write to
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, const char *val)
 {
    return os.write(val, strlen(val));
 }
 
+/**
+ * \brief
+ * @param os ostream to write to
+ * @param val val
+ */ 
 std::ostream &binary_write(std::ostream &os, std::string const &val)
 {
    return os.write(val.c_str(), val.size());