1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2005/01/28 17:29:59 $
7 Version: $Revision: 1.127 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
20 #include "gdcmDebug.h"
23 // For GetCurrentDate, GetCurrentTime
25 #include <sys/types.h>
28 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
29 #include <sys/timeb.h>
34 #include <stdarg.h> //only included in implementation file
35 #include <stdio.h> //only included in implementation file
37 #if defined(_MSC_VER) || defined(__MINGW32__)
38 #include <winsock.h> // for gethostname & gethostbyname
42 #include <unistd.h> // for gethostname
43 #include <netdb.h> // for gethostbyname
55 #include <sys/types.h>
58 #ifdef CMAKE_HAVE_SYS_IOCTL_H
59 #include <sys/ioctl.h> // For SIOCGIFCONF on Linux
61 #ifdef CMAKE_HAVE_SYS_SOCKET_H
62 #include <sys/socket.h>
64 #ifdef CMAKE_HAVE_SYS_SOCKIO_H
65 #include <sys/sockio.h> // For SIOCGIFCONF on SunOS
67 #ifdef CMAKE_HAVE_NET_IF_H
70 #ifdef CMAKE_HAVE_NETINET_IN_H
71 #include <netinet/in.h> //For IPPROTO_IP
73 #ifdef CMAKE_HAVE_NET_IF_DL_H
74 #include <net/if_dl.h>
76 #if defined(CMAKE_HAVE_NET_IF_ARP_H) && defined(__sun)
77 // This is absolutely necessary on SunOS
78 #include <net/if_arp.h>
81 // For GetCurrentThreadID()
83 #include <sys/types.h>
84 #include <linux/unistd.h>
92 const std::string Util::GDCM_UID = "1.2.826.0.1.3680043.2.1143";
93 std::string Util::RootUID = GDCM_UID;
96 * \brief Provide a better 'c++' approach for sprintf
97 * For example c code is:
98 * sprintf(trash, "%04x|%04x", group , elem);
101 * std::ostringstream buf;
102 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
103 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
104 * << std::hex << elem;
108 * Format("%04x|%04x", group , elem);
111 std::string Util::Format(const char *format, ...)
115 va_start(args, format);
116 vsprintf(buffer, format, args); //might be a security flaw
117 va_end(args); // Each invocation of va_start should be matched
118 // by a corresponding invocation of va_end
119 // args is then 'undefined'
125 * \brief Because not available in C++ (?)
127 void Util::Tokenize (const std::string &str,
128 std::vector<std::string> &tokens,
129 const std::string& delimiters)
131 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
132 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
133 while (std::string::npos != pos || std::string::npos != lastPos)
135 tokens.push_back(str.substr(lastPos, pos - lastPos));
136 lastPos = str.find_first_not_of(delimiters, pos);
137 pos = str.find_first_of (delimiters, lastPos);
142 * \brief Because not available in C++ (?)
143 * Counts the number of occurences of a substring within a string
146 int Util::CountSubstring (const std::string &str,
147 const std::string &subStr)
149 int count = 0; // counts how many times it appears
150 std::string::size_type x = 0; // The index position in the string
154 x = str.find(subStr,x); // Find the substring
155 if (x != std::string::npos) // If present
157 count++; // increase the count
158 x += subStr.length(); // Skip this word
161 while (x != std::string::npos); // Carry on until not present
167 * \brief Weed out a string from the non-printable characters (in order
168 * to avoid corrupting the terminal of invocation when printing)
169 * @param s string to remove non printable characters from
171 std::string Util::CreateCleanString(std::string const &s)
175 for(unsigned int i=0; i<str.size(); i++)
177 if(!isprint((unsigned char)str[i]))
185 if(!isprint((unsigned char)s[str.size()-1]))
187 if(s[str.size()-1] == 0)
189 str[str.size()-1] = ' ';
198 * \brief Add a SEPARATOR to the end of the name is necessary
199 * @param pathname file/directory name to normalize
201 std::string Util::NormalizePath(std::string const &pathname)
203 const char SEPARATOR_X = '/';
204 const char SEPARATOR_WIN = '\\';
205 const std::string SEPARATOR = "/";
206 std::string name = pathname;
207 int size = name.size();
209 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
217 * \brief Get the (directory) path from a full path file name
218 * @param fullName file/directory name to extract Path from
220 std::string Util::GetPath(std::string const &fullName)
222 std::string res = fullName;
223 int pos1 = res.rfind("/");
224 int pos2 = res.rfind("\\");
238 * \brief Get the (last) name of a full path file name
239 * @param fullName file/directory name to extract end name from
241 std::string Util::GetName(std::string const &fullName)
243 std::string filename = fullName;
245 std::string::size_type slash_pos = filename.rfind("/");
246 std::string::size_type backslash_pos = filename.rfind("\\");
247 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
248 if(slash_pos != std::string::npos)
250 return filename.substr(slash_pos + 1);
259 * \brief Get the current date of the system in a dicom string
261 std::string Util::GetCurrentDate()
266 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
271 * \brief Get the current time of the system in a dicom string
273 std::string Util::GetCurrentTime()
278 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
283 * \brief Get both the date and time at the same time to avoid problem
284 * around midnight where two call could be before and after midnight
286 std::string Util::GetCurrentDateTime()
292 // We need implementation specific functions to obtain millisecond precision
293 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
297 milliseconds = tb.millitm;
300 gettimeofday (&tv, NULL);
302 // Compute milliseconds from microseconds.
303 milliseconds = tv.tv_usec / 1000;
305 // Obtain the time of day, and convert it to a tm struct.
306 struct tm *ptm = localtime (&timep);
307 // Format the date and time, down to a single second.
308 strftime (tmp, sizeof (tmp), "%Y%m%d%H%M%S", ptm);
312 r += Format("%03ld", milliseconds);
318 * \brief Create a /DICOM/ string:
319 * It should a of even length (no odd length ever)
320 * It can contain as many (if you are reading this from your
321 * editor the following character is is backslash followed by zero
322 * that needed to be escaped with an extra backslash for doxygen) \\0
325 std::string Util::DicomString(const char *s, size_t l)
327 std::string r(s, s+l);
328 gdcmAssertMacro( !(r.size() % 2) ); // == basically 'l' is even
333 * \brief Create a /DICOM/ string:
334 * It should a of even length (no odd length ever)
335 * It can contain as many (if you are reading this from your
336 * editor the following character is is backslash followed by zero
337 * that needed to be escaped with an extra backslash for doxygen) \\0
339 * This function is similar to DicomString(const char*),
340 * except it doesn't take a length.
341 * It only pad with a null character if length is odd
343 std::string Util::DicomString(const char *s)
345 size_t l = strlen(s);
350 std::string r(s, s+l);
351 gdcmAssertMacro( !(r.size() % 2) );
356 * \brief Safely compare two Dicom String:
357 * - Both string should be of even length
358 * - We allow padding of even length string by either a null
359 * character of a space
361 bool Util::DicomStringEqual(const std::string &s1, const char *s2)
363 // s2 is the string from the DICOM reference: 'MONOCHROME1'
364 std::string s1_even = s1; //Never change input parameter
365 std::string s2_even = DicomString( s2 );
366 if( s1_even[s1_even.size()-1] == ' ')
368 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
370 return s1_even == s2_even;
374 * \brief tells us if the processor we are working with is BigEndian or not
376 bool Util::IsCurrentProcessorBigEndian()
378 #ifdef GDCM_WORDS_BIGENDIAN
388 typedef BOOL(WINAPI * pSnmpExtensionInit) (
389 IN DWORD dwTimeZeroReference,
390 OUT HANDLE * hPollForTrapEvent,
391 OUT AsnObjectIdentifier * supportedView);
393 typedef BOOL(WINAPI * pSnmpExtensionTrap) (
394 OUT AsnObjectIdentifier * enterprise,
395 OUT AsnInteger * genericTrap,
396 OUT AsnInteger * specificTrap,
397 OUT AsnTimeticks * timeStamp,
398 OUT RFC1157VarBindList * variableBindings);
400 typedef BOOL(WINAPI * pSnmpExtensionQuery) (
402 IN OUT RFC1157VarBindList * variableBindings,
403 OUT AsnInteger * errorStatus,
404 OUT AsnInteger * errorIndex);
406 typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
407 OUT AsnObjectIdentifier * supportedView);
411 int GetMacAddrSys ( unsigned char *addr )
415 if (WSAStartup(MAKEWORD(2, 0), &WinsockData) != 0)
417 std::cerr << "This program requires Winsock 2.x!" << std::endl;
421 HANDLE PollForTrapEvent;
422 AsnObjectIdentifier SupportedView;
423 UINT OID_ifEntryType[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 3 };
424 UINT OID_ifEntryNum[] = { 1, 3, 6, 1, 2, 1, 2, 1 };
425 UINT OID_ipMACEntAddr[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 6 };
426 AsnObjectIdentifier MIB_ifMACEntAddr = {
427 sizeof(OID_ipMACEntAddr) / sizeof(UINT), OID_ipMACEntAddr };
428 AsnObjectIdentifier MIB_ifEntryType = {
429 sizeof(OID_ifEntryType) / sizeof(UINT), OID_ifEntryType };
430 AsnObjectIdentifier MIB_ifEntryNum = {
431 sizeof(OID_ifEntryNum) / sizeof(UINT), OID_ifEntryNum };
432 RFC1157VarBindList varBindList;
433 RFC1157VarBind varBind[2];
434 AsnInteger errorStatus;
435 AsnInteger errorIndex;
436 AsnObjectIdentifier MIB_NULL = { 0, 0 };
441 // Load the SNMP dll and get the addresses of the functions necessary
442 HINSTANCE m_hInst = LoadLibrary("inetmib1.dll");
443 if (m_hInst < (HINSTANCE) HINSTANCE_ERROR)
447 pSnmpExtensionInit m_Init =
448 (pSnmpExtensionInit) GetProcAddress(m_hInst, "SnmpExtensionInit");
449 pSnmpExtensionQuery m_Query =
450 (pSnmpExtensionQuery) GetProcAddress(m_hInst, "SnmpExtensionQuery");
451 m_Init(GetTickCount(), &PollForTrapEvent, &SupportedView);
453 /* Initialize the variable list to be retrieved by m_Query */
454 varBindList.list = varBind;
455 varBind[0].name = MIB_NULL;
456 varBind[1].name = MIB_NULL;
458 // Copy in the OID to find the number of entries in the
460 varBindList.len = 1; // Only retrieving one item
461 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryNum);
462 m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
464 // printf("# of adapters in this system : %i\n",
465 // varBind[0].value.asnValue.number);
468 // Copy in the OID of ifType, the type of interface
469 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryType);
471 // Copy in the OID of ifPhysAddress, the address
472 SNMP_oidcpy(&varBind[1].name, &MIB_ifMACEntAddr);
476 // Submit the query. Responses will be loaded into varBindList.
477 // We can expect this call to succeed a # of times corresponding
478 // to the # of adapters reported to be in the system
479 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
487 // Confirm that the proper type has been returned
488 ret = SNMP_oidncmp(&varBind[0].name, &MIB_ifEntryType,
489 MIB_ifEntryType.idLength);
494 dtmp = varBind[0].value.asnValue.number;
496 // Type 6 describes ethernet interfaces
499 // Confirm that we have an address here
500 ret = SNMP_oidncmp(&varBind[1].name, &MIB_ifMACEntAddr,
501 MIB_ifMACEntAddr.idLength);
502 if ( !ret && varBind[1].value.asnValue.address.stream != NULL )
504 if ( (varBind[1].value.asnValue.address.stream[0] == 0x44)
505 && (varBind[1].value.asnValue.address.stream[1] == 0x45)
506 && (varBind[1].value.asnValue.address.stream[2] == 0x53)
507 && (varBind[1].value.asnValue.address.stream[3] == 0x54)
508 && (varBind[1].value.asnValue.address.stream[4] == 0x00) )
510 // Ignore all dial-up networking adapters
511 std::cerr << "Interface #" << j << " is a DUN adapter\n";
514 if ( (varBind[1].value.asnValue.address.stream[0] == 0x00)
515 && (varBind[1].value.asnValue.address.stream[1] == 0x00)
516 && (varBind[1].value.asnValue.address.stream[2] == 0x00)
517 && (varBind[1].value.asnValue.address.stream[3] == 0x00)
518 && (varBind[1].value.asnValue.address.stream[4] == 0x00)
519 && (varBind[1].value.asnValue.address.stream[5] == 0x00) )
521 // Ignore NULL addresses returned by other network
523 std::cerr << "Interface #" << j << " is a NULL address\n";
526 memcpy( addr, varBind[1].value.asnValue.address.stream, 6);
533 SNMP_FreeVarBind(&varBind[0]);
534 SNMP_FreeVarBind(&varBind[1]);
536 #endif //Win32 version
539 // implementation for POSIX system
541 //The POSIX version is broken anyway on Solaris, plus would require full
543 struct arpreq parpreq;
544 struct sockaddr_in *psa;
545 struct hostent *phost;
546 char hostname[MAXHOSTNAMELEN];
550 if(gethostname(hostname, MAXHOSTNAMELEN) != 0)
552 perror("gethostname");
555 phost = gethostbyname(hostname);
556 paddrs = phost->h_addr_list;
558 sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
564 memset(&parpreq, 0, sizeof(struct arpreq));
565 psa = (struct sockaddr_in *) &parpreq.arp_pa;
567 memset(psa, 0, sizeof(struct sockaddr_in));
568 psa->sin_family = AF_INET;
569 memcpy(&psa->sin_addr, *paddrs, sizeof(struct in_addr));
571 status = ioctl(sock, SIOCGARP, &parpreq);
577 memcpy(addr, parpreq.arp_ha.sa_data, 6);
581 #ifdef CMAKE_HAVE_NET_IF_H
583 struct ifreq ifr, *ifrp;
588 #if defined(AF_LINK) && (!defined(SIOCGIFHWADDR) && !defined(SIOCGENADDR))
589 struct sockaddr_dl *sdlp;
593 // BSD 4.4 defines the size of an ifreq to be
594 // max(sizeof(ifreq), sizeof(ifreq.ifr_name)+ifreq.ifr_addr.sa_len
595 // However, under earlier systems, sa_len isn't present, so the size is
596 // just sizeof(struct ifreq)
597 // We should investiage the use of SIZEOF_ADDR_IFREQ
601 #define max(a,b) ((a) > (b) ? (a) : (b))
603 #define ifreq_size(i) max(sizeof(struct ifreq),\
604 sizeof((i).ifr_name)+(i).ifr_addr.sa_len)
606 #define ifreq_size(i) sizeof(struct ifreq)
607 #endif // HAVE_SA_LEN
609 if( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
613 memset(buf, 0, sizeof(buf));
614 ifc.ifc_len = sizeof(buf);
616 if (ioctl (sd, SIOCGIFCONF, (char *)&ifc) < 0)
622 for (i = 0; i < n; i+= ifreq_size(*ifrp) )
624 ifrp = (struct ifreq *)((char *) ifc.ifc_buf+i);
625 strncpy(ifr.ifr_name, ifrp->ifr_name, IFNAMSIZ);
627 if (ioctl(sd, SIOCGIFHWADDR, &ifr) < 0)
629 a = (unsigned char *) &ifr.ifr_hwaddr.sa_data;
632 // In theory this call should also work on Sun Solaris, but apparently
633 // SIOCGENADDR is not implemented properly thus the call
634 // ioctl(sd, SIOCGENADDR, &ifr) always returns errno=2
635 // (No such file or directory)
636 // Furthermore the DLAPI seems to require full root access
637 if (ioctl(sd, SIOCGENADDR, &ifr) < 0)
639 a = (unsigned char *) ifr.ifr_enaddr;
642 sdlp = (struct sockaddr_dl *) &ifrp->ifr_addr;
643 if ((sdlp->sdl_family != AF_LINK) || (sdlp->sdl_alen != 6))
645 a = (unsigned char *) &sdlp->sdl_data[sdlp->sdl_nlen];
647 perror("No way to access hardware");
651 #endif // SIOCGENADDR
652 #endif // SIOCGIFHWADDR
653 if (!a[0] && !a[1] && !a[2] && !a[3] && !a[4] && !a[5]) continue;
664 // Not implemented platforms
665 perror("There was a configuration problem on your plateform");
672 * Mini function to return the last digit from a number express in base 256
673 * pre condition data contain an array of 6 unsigned char
674 * post condition carry contain the last digit
676 inline int getlastdigit(unsigned char *data)
678 int extended, carry = 0;
681 extended = (carry << 8) + data[i];
682 data[i] = extended / 10;
683 carry = extended % 10;
689 * \brief Encode the mac address on a fixed lenght string of 15 characters.
690 * we save space this way.
692 std::string Util::GetMACAddress()
694 // This code is the result of a long internet search to find something
695 // as compact as possible (not OS independant). We only have to separate
696 // 3 OS: Win32, SunOS and 'real' POSIX
697 // http://groups-beta.google.com/group/comp.unix.solaris/msg/ad36929d783d63be
698 // http://bdn.borland.com/article/0,1410,26040,00.html
699 unsigned char addr[6];
701 int stat = GetMacAddrSys(addr);
704 // We need to convert a 6 digit number from base 256 to base 10, using integer
705 // would requires a 48bits one. To avoid this we have to reimplement the div + modulo
712 res = getlastdigit(addr);
713 sres.insert(sres.begin(), '0' + res);
714 zero = (addr[0] == 0) && (addr[1] == 0) && (addr[2] == 0) && (addr[3] == 0) && (addr[4] == 0) && (addr[5] == 0);
721 gdcmVerboseMacro("Problem in finding the MAC Address");
727 * \brief Return the IP adress of the machine writting the DICOM image
729 std::string Util::GetIPAddress()
731 // This is a rip from
732 // http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
733 #ifndef HOST_NAME_MAX
734 // SUSv2 guarantees that `Host names are limited to 255 bytes'.
735 // POSIX 1003.1-2001 guarantees that `Host names (not including the
736 // terminating NUL) are limited to HOST_NAME_MAX bytes'.
737 # define HOST_NAME_MAX 255
738 // In this case we should maybe check the string was not truncated.
739 // But I don't known how to check that...
740 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
741 // with WinSock DLL we need to initialize the WinSock before using gethostname
742 WORD wVersionRequested = MAKEWORD(1,0);
744 int err = WSAStartup(wVersionRequested,&WSAData);
747 // Tell the user that we could not find a usable
754 #endif //HOST_NAME_MAX
757 char szHostName[HOST_NAME_MAX+1];
758 int r = gethostname(szHostName, HOST_NAME_MAX);
763 struct hostent *pHost = gethostbyname(szHostName);
765 for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
767 for( int j = 0; j<pHost->h_length; j++ )
769 if( j > 0 ) str += ".";
771 str += Util::Format("%u",
772 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
774 // str now contains one local IP address
776 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
782 // If an error occur r == -1
783 // Most of the time it will return 127.0.0.1...
787 unsigned int Util::GetCurrentThreadID()
789 // FIXME the implementation is far from complete
790 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
791 return (unsigned int)GetCurrentThreadId();
795 // Doesn't work on fedora, but is in the man page...
796 //return (unsigned int)gettid();
799 return (unsigned int)thr_self();
801 //default implementation
806 unsigned int Util::GetCurrentProcessID()
808 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
809 // NOTE: There is also a _getpid()...
810 return (unsigned int)GetCurrentProcessId();
812 // get process identification, POSIX
813 return (unsigned int)getpid();
819 * \brief Creates a new UID. As stipulate in the DICOM ref
820 * each time a DICOM image is create it should have
821 * a unique identifier (URI)
822 * @param root is the DICOM prefix assigned by IOS group
824 std::string Util::CreateUniqueUID(const std::string &root)
830 // gdcm UID prefix, as supplied by http://www.medicalconnections.co.uk
838 // A root was specified use it to forge our new UID:
840 append += Util::GetMACAddress();
842 append += Util::GetCurrentDateTime();
844 //Also add a mini random number just in case:
845 int r = (int) (100.0*rand()/RAND_MAX);
846 append += Format("%02d", r);
848 // If append is too long we need to rehash it
849 if( (prefix + append).size() > 64 )
851 gdcmErrorMacro( "Size of UID is too long." );
852 // we need a hash function to truncate this number
853 // if only md5 was cross plateform
857 return prefix + append;
860 void Util::SetRootUID(const std::string &root)
868 const std::string &Util::GetRootUID()
875 * @param os ostream to write to
879 std::ostream &binary_write(std::ostream &os, const T &val)
881 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
885 * \brief binary_write binary_write
886 * @param os ostream to write to
889 std::ostream &binary_write(std::ostream &os, const uint16_t &val)
891 #ifdef GDCM_WORDS_BIGENDIAN
893 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
894 return os.write(reinterpret_cast<const char*>(&swap), 2);
896 return os.write(reinterpret_cast<const char*>(&val), 2);
897 #endif //GDCM_WORDS_BIGENDIAN
901 * \brief binary_write binary_write
902 * @param os ostream to write to
905 std::ostream &binary_write(std::ostream &os, const uint32_t &val)
907 #ifdef GDCM_WORDS_BIGENDIAN
909 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
910 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
911 return os.write(reinterpret_cast<const char*>(&swap), 4);
913 return os.write(reinterpret_cast<const char*>(&val), 4);
914 #endif //GDCM_WORDS_BIGENDIAN
918 * \brief binary_write binary_write
919 * @param os ostream to write to
922 std::ostream &binary_write(std::ostream &os, const char *val)
924 return os.write(val, strlen(val));
929 * @param os ostream to write to
932 std::ostream &binary_write(std::ostream &os, std::string const &val)
934 return os.write(val.c_str(), val.size());
937 } // end namespace gdcm