1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2005/01/17 17:26:55 $
7 Version: $Revision: 1.106 $
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 #include <stdarg.h> //only included in implementation file
29 #include <stdio.h> //only included in implementation file
32 #include <winsock.h> // for gethostname & gethostbyname
36 #include <unistd.h> // for gethostname
37 #include <netdb.h> // for gethostbyname
49 #include <sys/types.h>
52 // How do I do that in CMake ?
57 #ifdef CMAKE_HAVE_SYS_IOCTL_H
58 #include <sys/ioctl.h> // For SIOCGIFCONF on Linux
60 #ifdef CMAKE_HAVE_SYS_SOCKET_H
61 #include <sys/socket.h>
63 #ifdef CMAKE_HAVE_SYS_SOCKIO_H
64 #include <sys/sockio.h> // For SIOCGIFCONF on SunOS
66 #ifdef CMAKE_HAVE_NET_IF_H
69 #ifdef CMAKE_HAVE_NETINET_IN_H
70 #include <netinet/in.h> //For IPPROTO_IP
72 #ifdef CMAKE_HAVE_NET_IF_DL_H
73 #include <net/if_dl.h>
75 #if defined(CMAKE_HAVE_NET_IF_ARP_H) && defined(__sun)
76 // This is absolutely necesseray on SunOS
77 #include <net/if_arp.h>
84 * \brief Provide a better 'c++' approach for sprintf
85 * For example c code is:
86 * sprintf(trash, "%04x|%04x", group , elem);
89 * std::ostringstream buf;
90 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
91 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
92 * << std::hex << elem;
96 * Format("%04x|%04x", group , elem);
99 std::string Util::Format(const char *format, ...)
103 va_start(args, format);
104 vsprintf(buffer, format, args); //might be a security flaw
105 va_end(args); // Each invocation of va_start should be matched
106 // by a corresponding invocation of va_end
107 // args is then 'undefined'
114 * \brief Because not available in C++ (?)
116 void Util::Tokenize (const std::string &str,
117 std::vector<std::string> &tokens,
118 const std::string& delimiters)
120 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
121 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
122 while (std::string::npos != pos || std::string::npos != lastPos)
124 tokens.push_back(str.substr(lastPos, pos - lastPos));
125 lastPos = str.find_first_not_of(delimiters, pos);
126 pos = str.find_first_of (delimiters, lastPos);
132 * \brief Because not available in C++ (?)
133 * Counts the number of occurences of a substring within a string
136 int Util::CountSubstring (const std::string &str,
137 const std::string &subStr)
139 int count = 0; // counts how many times it appears
140 std::string::size_type x = 0; // The index position in the string
144 x = str.find(subStr,x); // Find the substring
145 if (x != std::string::npos) // If present
147 count++; // increase the count
148 x += subStr.length(); // Skip this word
151 while (x != std::string::npos); // Carry on until not present
158 * \brief Weed out a string from the non-printable characters (in order
159 * to avoid corrupting the terminal of invocation when printing)
160 * @param s string to remove non printable characters from
162 std::string Util::CreateCleanString(std::string const &s)
166 for(unsigned int i=0; i<str.size(); i++)
168 if(!isprint((unsigned char)str[i]))
176 if(!isprint((unsigned char)s[str.size()-1]))
178 if(s[str.size()-1] == 0)
180 str[str.size()-1] = ' ';
190 * \brief Add a SEPARATOR to the end of the name is necessary
191 * @param pathname file/directory name to normalize
193 std::string Util::NormalizePath(std::string const &pathname)
195 const char SEPARATOR_X = '/';
196 const char SEPARATOR_WIN = '\\';
197 const std::string SEPARATOR = "/";
198 std::string name = pathname;
199 int size = name.size();
201 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
210 * \brief Get the (directory) path from a full path file name
211 * @param fullName file/directory name to extract Path from
213 std::string Util::GetPath(std::string const &fullName)
215 std::string res = fullName;
216 int pos1 = res.rfind("/");
217 int pos2 = res.rfind("\\");
232 * \brief Get the (last) name of a full path file name
233 * @param fullName file/directory name to extract end name from
235 std::string Util::GetName(std::string const &fullName)
237 std::string filename = fullName;
239 std::string::size_type slash_pos = filename.rfind("/");
240 std::string::size_type backslash_pos = filename.rfind("\\");
241 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
242 if(slash_pos != std::string::npos)
244 return filename.substr(slash_pos + 1);
254 * \brief Get the current date of the system in a dicom string
256 std::string Util::GetCurrentDate()
261 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
267 * \brief Get the current time of the system in a dicom string
269 std::string Util::GetCurrentTime()
274 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
279 * \brief Create a /DICOM/ string:
280 * It should a of even length (no odd length ever)
281 * It can contain as many (if you are reading this from your
282 * editor the following character is is backslash followed by zero
283 * that needed to be escaped with an extra backslash for doxygen) \\0
286 std::string Util::DicomString(const char *s, size_t l)
288 std::string r(s, s+l);
289 gdcmAssertMacro( !(r.size() % 2) ); // == basically 'l' is even
295 * \brief Create a /DICOM/ string:
296 * It should a of even lenght (no odd length ever)
297 * It can contain as many (if you are reading this from your
298 * editor the following character is is backslash followed by zero
299 * that needed to be escaped with an extra backslash for doxygen) \\0
301 * This function is similar to DicomString(const char*),
302 * except it doesn't take a lenght.
303 * It only pad with a null character if length is odd
305 std::string Util::DicomString(const char *s)
307 size_t l = strlen(s);
312 std::string r(s, s+l);
313 gdcmAssertMacro( !(r.size() % 2) );
319 * \brief Safely compare two Dicom String:
320 * - Both string should be of even lenght
321 * - We allow padding of even lenght string by either a null
322 * character of a space
324 bool Util::DicomStringEqual(const std::string &s1, const char *s2)
326 // s2 is the string from the DICOM reference: 'MONOCHROME1'
327 std::string s1_even = s1; //Never change input parameter
328 std::string s2_even = DicomString( s2 );
329 if( s1_even[s1_even.size()-1] == ' ')
331 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
333 return s1_even == s2_even;
340 * \brief tells us if the processor we are working with is BigEndian or not
342 bool Util::IsCurrentProcessorBigEndian()
344 #ifdef GDCM_WORDS_BIGENDIAN
354 typedef BOOL(WINAPI * pSnmpExtensionInit) (
355 IN DWORD dwTimeZeroReference,
356 OUT HANDLE * hPollForTrapEvent,
357 OUT AsnObjectIdentifier * supportedView);
359 typedef BOOL(WINAPI * pSnmpExtensionTrap) (
360 OUT AsnObjectIdentifier * enterprise,
361 OUT AsnInteger * genericTrap,
362 OUT AsnInteger * specificTrap,
363 OUT AsnTimeticks * timeStamp,
364 OUT RFC1157VarBindList * variableBindings);
366 typedef BOOL(WINAPI * pSnmpExtensionQuery) (
368 IN OUT RFC1157VarBindList * variableBindings,
369 OUT AsnInteger * errorStatus,
370 OUT AsnInteger * errorIndex);
372 typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
373 OUT AsnObjectIdentifier * supportedView);
377 int GetMacAddrSys ( unsigned char *addr )
381 if (WSAStartup(MAKEWORD(2, 0), &WinsockData) != 0)
383 std::cerr << "This program requires Winsock 2.x!" << std::endl;
387 HANDLE PollForTrapEvent;
388 AsnObjectIdentifier SupportedView;
389 UINT OID_ifEntryType[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 3 };
390 UINT OID_ifEntryNum[] = { 1, 3, 6, 1, 2, 1, 2, 1 };
391 UINT OID_ipMACEntAddr[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 6 };
392 AsnObjectIdentifier MIB_ifMACEntAddr = {
393 sizeof(OID_ipMACEntAddr) / sizeof(UINT), OID_ipMACEntAddr };
394 AsnObjectIdentifier MIB_ifEntryType = {
395 sizeof(OID_ifEntryType) / sizeof(UINT), OID_ifEntryType };
396 AsnObjectIdentifier MIB_ifEntryNum = {
397 sizeof(OID_ifEntryNum) / sizeof(UINT), OID_ifEntryNum };
398 RFC1157VarBindList varBindList;
399 RFC1157VarBind varBind[2];
400 AsnInteger errorStatus;
401 AsnInteger errorIndex;
402 AsnObjectIdentifier MIB_NULL = { 0, 0 };
408 // Load the SNMP dll and get the addresses of the functions necessary
409 HINSTANCE m_hInst = LoadLibrary("inetmib1.dll");
410 if (m_hInst < (HINSTANCE) HINSTANCE_ERROR)
415 pSnmpExtensionInit m_Init =
416 (pSnmpExtensionInit) GetProcAddress(m_hInst, "SnmpExtensionInit");
417 pSnmpExtensionInitEx m_InitEx =
418 (pSnmpExtensionInitEx) GetProcAddress(m_hInst, "SnmpExtensionInitEx");
419 pSnmpExtensionQuery m_Query =
420 (pSnmpExtensionQuery) GetProcAddress(m_hInst, "SnmpExtensionQuery");
421 pSnmpExtensionTrap m_Trap =
422 (pSnmpExtensionTrap) GetProcAddress(m_hInst, "SnmpExtensionTrap");
423 m_Init(GetTickCount(), &PollForTrapEvent, &SupportedView);
425 /* Initialize the variable list to be retrieved by m_Query */
426 varBindList.list = varBind;
427 varBind[0].name = MIB_NULL;
428 varBind[1].name = MIB_NULL;
430 // Copy in the OID to find the number of entries in the
432 varBindList.len = 1; // Only retrieving one item
433 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryNum);
434 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
436 // printf("# of adapters in this system : %i\n",
437 // varBind[0].value.asnValue.number);
440 // Copy in the OID of ifType, the type of interface
441 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryType);
443 // Copy in the OID of ifPhysAddress, the address
444 SNMP_oidcpy(&varBind[1].name, &MIB_ifMACEntAddr);
448 // Submit the query. Responses will be loaded into varBindList.
449 // We can expect this call to succeed a # of times corresponding
450 // to the # of adapters reported to be in the system
451 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
459 // Confirm that the proper type has been returned
460 ret = SNMP_oidncmp(&varBind[0].name, &MIB_ifEntryType,
461 MIB_ifEntryType.idLength);
466 dtmp = varBind[0].value.asnValue.number;
467 std::cerr << "Interface #" << j << " type : " << dtmp << std::endl;
469 // Type 6 describes ethernet interfaces
472 // Confirm that we have an address here
473 ret = SNMP_oidncmp(&varBind[1].name, &MIB_ifMACEntAddr,
474 MIB_ifMACEntAddr.idLength);
475 if ( !ret && varBind[1].value.asnValue.address.stream != NULL )
477 if ( (varBind[1].value.asnValue.address.stream[0] == 0x44)
478 && (varBind[1].value.asnValue.address.stream[1] == 0x45)
479 && (varBind[1].value.asnValue.address.stream[2] == 0x53)
480 && (varBind[1].value.asnValue.address.stream[3] == 0x54)
481 && (varBind[1].value.asnValue.address.stream[4] == 0x00) )
483 // Ignore all dial-up networking adapters
484 std::cerr << "Interface #" << j << " is a DUN adapter\n";
487 if ( (varBind[1].value.asnValue.address.stream[0] == 0x00)
488 && (varBind[1].value.asnValue.address.stream[1] == 0x00)
489 && (varBind[1].value.asnValue.address.stream[2] == 0x00)
490 && (varBind[1].value.asnValue.address.stream[3] == 0x00)
491 && (varBind[1].value.asnValue.address.stream[4] == 0x00)
492 && (varBind[1].value.asnValue.address.stream[5] == 0x00) )
494 // Ignore NULL addresses returned by other network
496 std::cerr << "Interface #" << j << " is a NULL address\n";
499 memcpy( addr, varBind[1].value.asnValue.address.stream, 6);
506 SNMP_FreeVarBind(&varBind[0]);
507 SNMP_FreeVarBind(&varBind[1]);
509 #endif //Win32 version
512 // implementation for POSIX system
514 //The POSIX version is broken anyway on Solaris, plus would require full
517 struct arpreq parpreq;
518 struct sockaddr_in sa, *psa;
519 struct in_addr inaddr;
520 struct hostent *phost;
521 char hostname[MAXHOSTNAMELEN];
526 if(gethostname(hostname, MAXHOSTNAMELEN) != 0)
528 perror("gethostname");
531 phost = gethostbyname(hostname);
532 paddrs = phost->h_addr_list;
534 sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
540 memset(&parpreq, 0, sizeof(struct arpreq));
541 psa = (struct sockaddr_in *) &parpreq.arp_pa;
543 memset(psa, 0, sizeof(struct sockaddr_in));
544 psa->sin_family = AF_INET;
545 memcpy(&psa->sin_addr, *paddrs, sizeof(struct in_addr));
547 status = ioctl(sock, SIOCGARP, &parpreq);
553 memcpy(addr, parpreq.arp_ha.sa_data, 6);
557 #ifdef CMAKE_HAVE_NET_IF_H
559 struct ifreq ifr, *ifrp;
565 struct sockaddr_dl *sdlp;
569 // BSD 4.4 defines the size of an ifreq to be
570 // max(sizeof(ifreq), sizeof(ifreq.ifr_name)+ifreq.ifr_addr.sa_len
571 // However, under earlier systems, sa_len isn't present, so the size is
572 // just sizeof(struct ifreq)
573 // We should investiage the use of SIZEOF_ADDR_IFREQ
577 #define max(a,b) ((a) > (b) ? (a) : (b))
579 #define ifreq_size(i) max(sizeof(struct ifreq),\
580 sizeof((i).ifr_name)+(i).ifr_addr.sa_len)
582 #define ifreq_size(i) sizeof(struct ifreq)
583 #endif // HAVE_SA_LEN
585 if( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
589 memset(buf, 0, sizeof(buf));
590 ifc.ifc_len = sizeof(buf);
592 if (ioctl (sd, SIOCGIFCONF, (char *)&ifc) < 0)
598 for (i = 0; i < n; i+= ifreq_size(*ifrp) )
600 ifrp = (struct ifreq *)((char *) ifc.ifc_buf+i);
601 strncpy(ifr.ifr_name, ifrp->ifr_name, IFNAMSIZ);
603 if (ioctl(sd, SIOCGIFHWADDR, &ifr) < 0)
605 a = (unsigned char *) &ifr.ifr_hwaddr.sa_data;
608 // In theory this call should also work on Sun Solaris, but apparently
609 // SIOCGENADDR is not implemented properly thus the call
610 // ioctl(sd, SIOCGENADDR, &ifr) always returns errno=2
611 // (No such file or directory)
612 // Furthermore the DLAPI seems to require full root access
613 if (ioctl(sd, SIOCGENADDR, &ifr) < 0)
615 a = (unsigned char *) ifr.ifr_enaddr;
618 sdlp = (struct sockaddr_dl *) &ifrp->ifr_addr;
619 if ((sdlp->sdl_family != AF_LINK) || (sdlp->sdl_alen != 6))
621 a = (unsigned char *) &sdlp->sdl_data[sdlp->sdl_nlen];
623 perror("No way to access hardware");
627 #endif // SIOCGENADDR
628 #endif // SIOCGIFHWADDR
629 if (!a[0] && !a[1] && !a[2] && !a[3] && !a[4] && !a[5]) continue;
640 /* Not implemented platforms */
641 perror("There was a configuration problem on your plateform");
647 std::string Util::GetMACAddress()
649 // This code is the result of a long internet search to find something
650 // as compact as possible (not OS independant). We only have to separate
651 // 3 OS: Win32, SunOS and 'real' POSIX
652 // http://groups-beta.google.com/group/comp.unix.solaris/msg/ad36929d783d63be
653 // http://bdn.borland.com/article/0,1410,26040,00.html
654 unsigned char addr[6];
657 int stat = GetMacAddrSys(addr);
660 for (int i=0; i<6; ++i)
662 macaddr += Format("%2.2x", addr[i]);
663 //if(i) macaddr += ".";
664 //macaddr += Format("%i", (int)addr[i]);
670 gdcmVerboseMacro("Problem in finding the MAC Address");
677 * \brief Return the IP adress of the machine writting the DICOM image
679 std::string Util::GetIPAddress()
681 // This is a rip from
682 // http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
683 #ifndef HOST_NAME_MAX
684 // SUSv2 guarantees that `Host names are limited to 255 bytes'.
685 // POSIX 1003.1-2001 guarantees that `Host names (not including the
686 // terminating NUL) are limited to HOST_NAME_MAX bytes'.
687 # define HOST_NAME_MAX 255
688 // In this case we should maybe check the string was not truncated.
689 // But I don't known how to check that...
690 #if defined(_MSC_VER) || defined(__BORLANDC__)
691 // with WinSock DLL we need to initialise the WinSock before using gethostname
692 WORD wVersionRequested = MAKEWORD(1,0);
694 int err = WSAStartup(wVersionRequested,&WSAData);
697 // Tell the user that we could not find a usable
704 #endif //HOST_NAME_MAX
707 char szHostName[HOST_NAME_MAX+1];
708 int r = gethostname(szHostName, HOST_NAME_MAX);
713 struct hostent *pHost = gethostbyname(szHostName);
715 for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
717 for( int j = 0; j<pHost->h_length; j++ )
719 if( j > 0 ) str += ".";
721 str += Util::Format("%u",
722 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
724 // str now contains one local IP address
726 #if defined(_MSC_VER) || defined(__BORLANDC__)
732 // If an error occur r == -1
733 // Most of the time it will return 127.0.0.1...
739 * \brief Creates a new UID. As stipulate in the DICOM ref
740 * each time a DICOM image is create it should have
741 * a unique identifier (URI)
743 std::string Util::CreateUniqueUID(const std::string &root)
745 std::string radical = root;
748 // No root was specified use "GDCM" then
749 // echo "gdcm" | od -b
750 // 0000000 147 144 143 155 012
751 radical = "147.144.143.155"; // special easter egg
754 // A root was specified use it to forge our new UID:
755 radical += Util::GetMACAddress();
757 radical += Util::GetCurrentDate();
759 radical += Util::GetCurrentTime();
765 std::ostream &binary_write(std::ostream &os, const T &val)
767 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
770 std::ostream &binary_write(std::ostream &os, const uint16_t &val)
772 #ifdef GDCM_WORDS_BIGENDIAN
774 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
775 return os.write(reinterpret_cast<const char*>(&swap), 2);
777 return os.write(reinterpret_cast<const char*>(&val), 2);
778 #endif //GDCM_WORDS_BIGENDIAN
781 std::ostream &binary_write(std::ostream &os, const uint32_t &val)
783 #ifdef GDCM_WORDS_BIGENDIAN
785 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
786 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
787 return os.write(reinterpret_cast<const char*>(&swap), 4);
789 return os.write(reinterpret_cast<const char*>(&val), 4);
790 #endif //GDCM_WORDS_BIGENDIAN
793 std::ostream &binary_write(std::ostream &os, const char *val)
795 return os.write(val, strlen(val));
798 std::ostream &binary_write(std::ostream &os, std::string const &val)
800 return os.write(val.c_str(), val.size());
803 } // end namespace gdcm