1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2005/01/15 21:45:48 $
7 Version: $Revision: 1.94 $
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>
55 #include <arpa/inet.h>
56 #include <net/if_arp.h>
60 //#include <sys/time.h>
65 #ifdef CMAKE_HAVE_SYS_IOCTL_H
66 #include <sys/ioctl.h> // For SIOCGIFCONF on Linux
68 #ifdef CMAKE_HAVE_SYS_SOCKET_H
69 #include <sys/socket.h>
71 #ifdef CMAKE_HAVE_SYS_SOCKIO_H
72 #include <sys/sockio.h> // For SIOCGIFCONF on SunOS
74 #ifdef CMAKE_HAVE_NET_IF_H
77 #ifdef CMAKE_HAVE_NETINET_IN_H
78 #include <netinet/in.h> //For IPPROTO_IP
80 #ifdef CMAKE_HAVE_NET_IF_DL_H
81 #include <net/if_dl.h>
84 // How do I do that in CMake ?
93 * \brief Provide a better 'c++' approach for sprintf
94 * For example c code is:
95 * sprintf(trash, "%04x|%04x", group , elem);
98 * std::ostringstream buf;
99 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
100 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
101 * << std::hex << elem;
105 * Format("%04x|%04x", group , elem);
108 std::string Util::Format(const char *format, ...)
112 va_start(args, format);
113 vsprintf(buffer, format, args); //might be a security flaw
114 va_end(args); // Each invocation of va_start should be matched
115 // by a corresponding invocation of va_end
116 // args is then 'undefined'
123 * \brief Because not available in C++ (?)
125 void Util::Tokenize (const std::string &str,
126 std::vector<std::string> &tokens,
127 const std::string& delimiters)
129 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
130 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
131 while (std::string::npos != pos || std::string::npos != lastPos)
133 tokens.push_back(str.substr(lastPos, pos - lastPos));
134 lastPos = str.find_first_not_of(delimiters, pos);
135 pos = str.find_first_of (delimiters, lastPos);
141 * \brief Because not available in C++ (?)
142 * Counts the number of occurences of a substring within a string
145 int Util::CountSubstring (const std::string &str,
146 const std::string &subStr)
148 int count = 0; // counts how many times it appears
149 std::string::size_type x = 0; // The index position in the string
153 x = str.find(subStr,x); // Find the substring
154 if (x != std::string::npos) // If present
156 count++; // increase the count
157 x += subStr.length(); // Skip this word
160 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] = ' ';
199 * \brief Add a SEPARATOR to the end of the name is necessary
200 * @param pathname file/directory name to normalize
202 std::string Util::NormalizePath(std::string const &pathname)
204 const char SEPARATOR_X = '/';
205 const char SEPARATOR_WIN = '\\';
206 const std::string SEPARATOR = "/";
207 std::string name = pathname;
208 int size = name.size();
210 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
219 * \brief Get the (directory) path from a full path file name
220 * @param fullName file/directory name to extract Path from
222 std::string Util::GetPath(std::string const &fullName)
224 std::string res = fullName;
225 int pos1 = res.rfind("/");
226 int pos2 = res.rfind("\\");
241 * \brief Get the (last) name of a full path file name
242 * @param fullName file/directory name to extract end name from
244 std::string Util::GetName(std::string const &fullName)
246 std::string filename = fullName;
248 std::string::size_type slash_pos = filename.rfind("/");
249 std::string::size_type backslash_pos = filename.rfind("\\");
250 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
251 if(slash_pos != std::string::npos)
253 return filename.substr(slash_pos + 1);
263 * \brief Get the current date of the system in a dicom string
265 std::string Util::GetCurrentDate()
270 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
276 * \brief Get the current time of the system in a dicom string
278 std::string Util::GetCurrentTime()
283 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
288 * \brief Create a /DICOM/ string:
289 * It should a of even length (no odd length ever)
290 * It can contain as many (if you are reading this from your
291 * editor the following character is is backslash followed by zero
292 * that needed to be escaped with an extra backslash for doxygen) \\0
295 std::string Util::DicomString(const char *s, size_t l)
297 std::string r(s, s+l);
298 gdcmAssertMacro( !(r.size() % 2) ); // == basically 'l' is even
304 * \brief Create a /DICOM/ string:
305 * It should a of even lenght (no odd length ever)
306 * It can contain as many (if you are reading this from your
307 * editor the following character is is backslash followed by zero
308 * that needed to be escaped with an extra backslash for doxygen) \\0
310 * This function is similar to DicomString(const char*),
311 * except it doesn't take a lenght.
312 * It only pad with a null character if length is odd
314 std::string Util::DicomString(const char *s)
316 size_t l = strlen(s);
321 std::string r(s, s+l);
322 gdcmAssertMacro( !(r.size() % 2) );
328 * \brief Safely compare two Dicom String:
329 * - Both string should be of even lenght
330 * - We allow padding of even lenght string by either a null
331 * character of a space
333 bool Util::DicomStringEqual(const std::string &s1, const char *s2)
335 // s2 is the string from the DICOM reference: 'MONOCHROME1'
336 std::string s1_even = s1; //Never change input parameter
337 std::string s2_even = DicomString( s2 );
338 if( s1_even[s1_even.size()-1] == ' ')
340 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
342 return s1_even == s2_even;
349 * \brief tells us if the processor we are working with is BigEndian or not
351 bool Util::IsCurrentProcessorBigEndian()
353 #ifdef GDCM_WORDS_BIGENDIAN
363 typedef BOOL(WINAPI * pSnmpExtensionInit) (
364 IN DWORD dwTimeZeroReference,
365 OUT HANDLE * hPollForTrapEvent,
366 OUT AsnObjectIdentifier * supportedView);
368 typedef BOOL(WINAPI * pSnmpExtensionTrap) (
369 OUT AsnObjectIdentifier * enterprise,
370 OUT AsnInteger * genericTrap,
371 OUT AsnInteger * specificTrap,
372 OUT AsnTimeticks * timeStamp,
373 OUT RFC1157VarBindList * variableBindings);
375 typedef BOOL(WINAPI * pSnmpExtensionQuery) (
377 IN OUT RFC1157VarBindList * variableBindings,
378 OUT AsnInteger * errorStatus,
379 OUT AsnInteger * errorIndex);
381 typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
382 OUT AsnObjectIdentifier * supportedView);
386 long GetMacAddrSys ( unsigned char *addr)
390 if (WSAStartup(MAKEWORD(2, 0), &WinsockData) != 0)
392 std::cerr << "This program requires Winsock 2.x!" << std::endl;
396 HANDLE PollForTrapEvent;
397 AsnObjectIdentifier SupportedView;
398 UINT OID_ifEntryType[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 3 };
399 UINT OID_ifEntryNum[] = { 1, 3, 6, 1, 2, 1, 2, 1 };
400 UINT OID_ipMACEntAddr[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 6 };
401 AsnObjectIdentifier MIB_ifMACEntAddr = {
402 sizeof(OID_ipMACEntAddr) / sizeof(UINT), OID_ipMACEntAddr };
403 AsnObjectIdentifier MIB_ifEntryType = {
404 sizeof(OID_ifEntryType) / sizeof(UINT), OID_ifEntryType };
405 AsnObjectIdentifier MIB_ifEntryNum = {
406 sizeof(OID_ifEntryNum) / sizeof(UINT), OID_ifEntryNum };
407 RFC1157VarBindList varBindList;
408 RFC1157VarBind varBind[2];
409 AsnInteger errorStatus;
410 AsnInteger errorIndex;
411 AsnObjectIdentifier MIB_NULL = { 0, 0 };
417 // Load the SNMP dll and get the addresses of the functions necessary
418 HINSTANCE m_hInst = LoadLibrary("inetmib1.dll");
419 if (m_hInst < (HINSTANCE) HINSTANCE_ERROR)
424 pSnmpExtensionInit m_Init =
425 (pSnmpExtensionInit) GetProcAddress(m_hInst, "SnmpExtensionInit");
426 pSnmpExtensionInitEx m_InitEx =
427 (pSnmpExtensionInitEx) GetProcAddress(m_hInst, "SnmpExtensionInitEx");
428 pSnmpExtensionQuery m_Query =
429 (pSnmpExtensionQuery) GetProcAddress(m_hInst, "SnmpExtensionQuery");
430 pSnmpExtensionTrap m_Trap =
431 (pSnmpExtensionTrap) GetProcAddress(m_hInst, "SnmpExtensionTrap");
432 m_Init(GetTickCount(), &PollForTrapEvent, &SupportedView);
434 /* Initialize the variable list to be retrieved by m_Query */
435 varBindList.list = varBind;
436 varBind[0].name = MIB_NULL;
437 varBind[1].name = MIB_NULL;
439 // Copy in the OID to find the number of entries in the
441 varBindList.len = 1; // Only retrieving one item
442 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryNum);
443 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
445 // printf("# of adapters in this system : %i\n",
446 // varBind[0].value.asnValue.number); varBindList.len = 2;
448 // Copy in the OID of ifType, the type of interface
449 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryType);
451 // Copy in the OID of ifPhysAddress, the address
452 SNMP_oidcpy(&varBind[1].name, &MIB_ifMACEntAddr);
456 // Submit the query. Responses will be loaded into varBindList.
457 // We can expect this call to succeed a # of times corresponding
458 // to the # of adapters reported to be in the system
459 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
467 // Confirm that the proper type has been returned
468 ret = SNMP_oidncmp(&varBind[0].name, &MIB_ifEntryType,
469 MIB_ifEntryType.idLength);
474 dtmp = varBind[0].value.asnValue.number;
475 printf("Interface #%i type : %i\n", j, dtmp);
477 // Type 6 describes ethernet interfaces
480 // Confirm that we have an address here
481 ret = SNMP_oidncmp(&varBind[1].name, &MIB_ifMACEntAddr,
482 MIB_ifMACEntAddr.idLength);
483 if ( !ret && varBind[1].value.asnValue.address.stream != NULL )
485 if ( (varBind[1].value.asnValue.address.stream[0] == 0x44)
486 && (varBind[1].value.asnValue.address.stream[1] == 0x45)
487 && (varBind[1].value.asnValue.address.stream[2] == 0x53)
488 && (varBind[1].value.asnValue.address.stream[3] == 0x54)
489 && (varBind[1].value.asnValue.address.stream[4] == 0x00) )
491 // Ignore all dial-up networking adapters
492 printf("Interface #%i is a DUN adapter\n", j);
495 if ( (varBind[1].value.asnValue.address.stream[0] == 0x00)
496 && (varBind[1].value.asnValue.address.stream[1] == 0x00)
497 && (varBind[1].value.asnValue.address.stream[2] == 0x00)
498 && (varBind[1].value.asnValue.address.stream[3] == 0x00)
499 && (varBind[1].value.asnValue.address.stream[4] == 0x00)
500 && (varBind[1].value.asnValue.address.stream[5] == 0x00) )
502 // Ignore NULL addresses returned by other network
504 printf("Interface #%i is a NULL address\n", j);
507 memcpy( addr, varBind[1].value.asnValue.address.stream, 6);
514 SNMP_FreeVarBind(&varBind[0]);
515 SNMP_FreeVarBind(&varBind[1]);
517 #endif //Win32 version
520 // implementation for POSIX system
522 //The POSIX version is broken anyway on Solaris, plus would require full
525 struct arpreq parpreq;
526 struct sockaddr_in sa, *psa;
527 struct in_addr inaddr;
528 struct hostent *phost;
529 char hostname[MAXHOSTNAMELEN];
534 gethostname(hostname, MAXHOSTNAMELEN);
535 phost = gethostbyname(hostname);
536 paddrs = phost->h_addr_list;
538 //memcpy(&inaddr.s_addr, *paddrs, sizeof(inaddr.s_addr));
539 sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
546 memset(&parpreq, 0, sizeof(struct arpreq));
547 psa = (struct sockaddr_in *) &parpreq.arp_pa;
548 memset(psa, 0, sizeof(struct sockaddr_in));
549 psa->sin_family = AF_INET;
550 memcpy(&psa->sin_addr, *paddrs, sizeof(struct in_addr));
552 status = ioctl(sock, SIOCGARP, &parpreq);
561 memcpy(addr, parpreq.arp_ha.sa_data, 6);
562 // printf("MAC Address: %x:%x:%x:%x:%x:%x\n",
564 // parpreq.arp_ha.sa_data[0],
565 // parpreq.arp_ha.sa_data[1],
566 // parpreq.arp_ha.sa_data[2],
567 // parpreq.arp_ha.sa_data[3],
568 // parpreq.arp_ha.sa_data[4],
570 // parpreq.arp_ha.sa_data[5]);
574 #ifdef CMAKE_HAVE_NET_IF_H
576 struct ifreq ifr, *ifrp;
582 struct sockaddr_dl *sdlp;
586 // BSD 4.4 defines the size of an ifreq to be
587 // max(sizeof(ifreq), sizeof(ifreq.ifr_name)+ifreq.ifr_addr.sa_len
588 // However, under earlier systems, sa_len isn't present, so the size is
589 // just sizeof(struct ifreq)
590 // We should investiage the use of SIZEOF_ADDR_IFREQ
594 #define max(a,b) ((a) > (b) ? (a) : (b))
596 #define ifreq_size(i) max(sizeof(struct ifreq),\
597 sizeof((i).ifr_name)+(i).ifr_addr.sa_len)
599 #define ifreq_size(i) sizeof(struct ifreq)
600 #endif // HAVE_SA_LEN
602 if( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
606 memset(buf, 0, sizeof(buf));
607 ifc.ifc_len = sizeof(buf);
609 if (ioctl (sd, SIOCGIFCONF, (char *)&ifc) < 0)
615 for (i = 0; i < n; i+= ifreq_size(*ifrp) )
617 ifrp = (struct ifreq *)((char *) ifc.ifc_buf+i);
618 strncpy(ifr.ifr_name, ifrp->ifr_name, IFNAMSIZ);
620 if (ioctl(sd, SIOCGIFHWADDR, &ifr) < 0)
622 a = (unsigned char *) &ifr.ifr_hwaddr.sa_data;
625 if (ioctl(sd, SIOCGENADDR, &ifr) < 0)
627 a = (unsigned char *) ifr.ifr_enaddr;
630 sdlp = (struct sockaddr_dl *) &ifrp->ifr_addr;
631 if ((sdlp->sdl_family != AF_LINK) || (sdlp->sdl_alen != 6))
633 a = (unsigned char *) &sdlp->sdl_data[sdlp->sdl_nlen];
636 * XXX we don't have a way of getting the hardware
642 #endif // SIOCGENADDR
643 #endif // SIOCGIFHWADDR
644 if (!a[0] && !a[1] && !a[2] && !a[3] && !a[4] && !a[5]) continue;
660 std::string Util::GetMACAddress()
662 // This is a rip from: http://cplus.kompf.de/macaddr.html for Linux/CYGWIN, HPUX and AIX
663 // and http://tangentsoft.net/wskfaq/examples/src/snmpmac.cpp for windows version
664 // and http://groups-beta.google.com/group/sol.lists.freebsd.hackers/msg/0d0f862e05fce6c0 for the FreeBSD version
665 // and http://developer.apple.com/samplecode/GetPrimaryMACAddress/GetPrimaryMACAddress.html for MacOSX version
669 long stat = GetMacAddrSys(addr);
672 //printf( "MAC address = ");
673 for (int i=0; i<6; ++i)
675 //printf("%2.2x", addr[i]);
676 macaddr += Format("%2.2x", addr[i]);
683 //printf( "No MAC address !\n" );
690 * \brief Return the IP adress of the machine writting the DICOM image
692 std::string Util::GetIPAddress()
694 // This is a rip from
695 // http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
696 #ifndef HOST_NAME_MAX
697 // SUSv2 guarantees that `Host names are limited to 255 bytes'.
698 // POSIX 1003.1-2001 guarantees that `Host names (not including the
699 // terminating NUL) are limited to HOST_NAME_MAX bytes'.
700 # define HOST_NAME_MAX 255
701 // In this case we should maybe check the string was not truncated.
702 // But I don't known how to check that...
703 #if defined(_MSC_VER) || defined(__BORLANDC__)
704 // with WinSock DLL we need to initialise the WinSock before using gethostname
705 WORD wVersionRequested = MAKEWORD(1,0);
707 int err = WSAStartup(wVersionRequested,&WSAData);
710 // Tell the user that we could not find a usable
717 #endif //HOST_NAME_MAX
720 char szHostName[HOST_NAME_MAX+1];
721 int r = gethostname(szHostName, HOST_NAME_MAX);
726 struct hostent *pHost = gethostbyname(szHostName);
728 for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
730 for( int j = 0; j<pHost->h_length; j++ )
732 if( j > 0 ) str += ".";
734 str += Util::Format("%u",
735 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
737 // str now contains one local IP address
739 #if defined(_MSC_VER) || defined(__BORLANDC__)
745 // If an error occur r == -1
746 // Most of the time it will return 127.0.0.1...
752 * \brief Creates a new UID. As stipulate in the DICOM ref
753 * each time a DICOM image is create it should have
754 * a unique identifier (URI)
756 std::string Util::CreateUniqueUID(const std::string &root)
758 // The code works as follow:
759 // echo "gdcm" | od -b
760 // 0000000 147 144 143 155 012
761 // Therefore we return
762 // radical + 147.144.143.155 + IP + time()
763 std::string radical = root;
764 if( !root.size() ) //anything better ?
766 radical = "0.0."; // Is this really usefull ?
769 // A root was specified use it to forge our new UID:
770 radical += "147.144.143.155"; // gdcm
772 radical += Util::GetIPAddress();
774 radical += Util::GetCurrentDate();
776 radical += Util::GetCurrentTime();
782 std::ostream &binary_write(std::ostream &os, const T &val)
784 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
787 std::ostream &binary_write(std::ostream &os, const uint16_t &val)
789 #ifdef GDCM_WORDS_BIGENDIAN
791 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
792 return os.write(reinterpret_cast<const char*>(&swap), 2);
794 return os.write(reinterpret_cast<const char*>(&val), 2);
795 #endif //GDCM_WORDS_BIGENDIAN
798 std::ostream &binary_write(std::ostream &os, const uint32_t &val)
800 #ifdef GDCM_WORDS_BIGENDIAN
802 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
803 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
804 return os.write(reinterpret_cast<const char*>(&swap), 4);
806 return os.write(reinterpret_cast<const char*>(&val), 4);
807 #endif //GDCM_WORDS_BIGENDIAN
810 std::ostream &binary_write(std::ostream &os, const char *val)
812 return os.write(val, strlen(val));
815 std::ostream &binary_write(std::ostream &os, std::string const &val)
817 return os.write(val.c_str(), val.size());
820 } // end namespace gdcm