1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2005/01/15 22:19:10 $
7 Version: $Revision: 1.95 $
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 // How do I do that in CMake ?
68 #define CMAKE_HAVE_NET_IF_DL_H
69 #define CMAKE_HAVE_NETINET_IN_H
70 #define CMAKE_HAVE_NET_IF_H
73 #ifdef CMAKE_HAVE_SYS_IOCTL_H
74 #include <sys/ioctl.h> // For SIOCGIFCONF on Linux
76 #ifdef CMAKE_HAVE_SYS_SOCKET_H
77 #include <sys/socket.h>
79 #ifdef CMAKE_HAVE_SYS_SOCKIO_H
80 #include <sys/sockio.h> // For SIOCGIFCONF on SunOS
82 #ifdef CMAKE_HAVE_NET_IF_H
85 #ifdef CMAKE_HAVE_NETINET_IN_H
86 #include <netinet/in.h> //For IPPROTO_IP
88 #ifdef CMAKE_HAVE_NET_IF_DL_H
89 #include <net/if_dl.h>
97 * \brief Provide a better 'c++' approach for sprintf
98 * For example c code is:
99 * sprintf(trash, "%04x|%04x", group , elem);
102 * std::ostringstream buf;
103 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
104 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
105 * << std::hex << elem;
109 * Format("%04x|%04x", group , elem);
112 std::string Util::Format(const char *format, ...)
116 va_start(args, format);
117 vsprintf(buffer, format, args); //might be a security flaw
118 va_end(args); // Each invocation of va_start should be matched
119 // by a corresponding invocation of va_end
120 // args is then 'undefined'
127 * \brief Because not available in C++ (?)
129 void Util::Tokenize (const std::string &str,
130 std::vector<std::string> &tokens,
131 const std::string& delimiters)
133 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
134 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
135 while (std::string::npos != pos || std::string::npos != lastPos)
137 tokens.push_back(str.substr(lastPos, pos - lastPos));
138 lastPos = str.find_first_not_of(delimiters, pos);
139 pos = str.find_first_of (delimiters, lastPos);
145 * \brief Because not available in C++ (?)
146 * Counts the number of occurences of a substring within a string
149 int Util::CountSubstring (const std::string &str,
150 const std::string &subStr)
152 int count = 0; // counts how many times it appears
153 std::string::size_type x = 0; // The index position in the string
157 x = str.find(subStr,x); // Find the substring
158 if (x != std::string::npos) // If present
160 count++; // increase the count
161 x += subStr.length(); // Skip this word
164 while (x != std::string::npos); // Carry on until not present
171 * \brief Weed out a string from the non-printable characters (in order
172 * to avoid corrupting the terminal of invocation when printing)
173 * @param s string to remove non printable characters from
175 std::string Util::CreateCleanString(std::string const &s)
179 for(unsigned int i=0; i<str.size(); i++)
181 if(!isprint((unsigned char)str[i]))
189 if(!isprint((unsigned char)s[str.size()-1]))
191 if(s[str.size()-1] == 0)
193 str[str.size()-1] = ' ';
203 * \brief Add a SEPARATOR to the end of the name is necessary
204 * @param pathname file/directory name to normalize
206 std::string Util::NormalizePath(std::string const &pathname)
208 const char SEPARATOR_X = '/';
209 const char SEPARATOR_WIN = '\\';
210 const std::string SEPARATOR = "/";
211 std::string name = pathname;
212 int size = name.size();
214 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
223 * \brief Get the (directory) path from a full path file name
224 * @param fullName file/directory name to extract Path from
226 std::string Util::GetPath(std::string const &fullName)
228 std::string res = fullName;
229 int pos1 = res.rfind("/");
230 int pos2 = res.rfind("\\");
245 * \brief Get the (last) name of a full path file name
246 * @param fullName file/directory name to extract end name from
248 std::string Util::GetName(std::string const &fullName)
250 std::string filename = fullName;
252 std::string::size_type slash_pos = filename.rfind("/");
253 std::string::size_type backslash_pos = filename.rfind("\\");
254 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
255 if(slash_pos != std::string::npos)
257 return filename.substr(slash_pos + 1);
267 * \brief Get the current date of the system in a dicom string
269 std::string Util::GetCurrentDate()
274 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
280 * \brief Get the current time of the system in a dicom string
282 std::string Util::GetCurrentTime()
287 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
292 * \brief Create a /DICOM/ string:
293 * It should a of even length (no odd length ever)
294 * It can contain as many (if you are reading this from your
295 * editor the following character is is backslash followed by zero
296 * that needed to be escaped with an extra backslash for doxygen) \\0
299 std::string Util::DicomString(const char *s, size_t l)
301 std::string r(s, s+l);
302 gdcmAssertMacro( !(r.size() % 2) ); // == basically 'l' is even
308 * \brief Create a /DICOM/ string:
309 * It should a of even lenght (no odd length ever)
310 * It can contain as many (if you are reading this from your
311 * editor the following character is is backslash followed by zero
312 * that needed to be escaped with an extra backslash for doxygen) \\0
314 * This function is similar to DicomString(const char*),
315 * except it doesn't take a lenght.
316 * It only pad with a null character if length is odd
318 std::string Util::DicomString(const char *s)
320 size_t l = strlen(s);
325 std::string r(s, s+l);
326 gdcmAssertMacro( !(r.size() % 2) );
332 * \brief Safely compare two Dicom String:
333 * - Both string should be of even lenght
334 * - We allow padding of even lenght string by either a null
335 * character of a space
337 bool Util::DicomStringEqual(const std::string &s1, const char *s2)
339 // s2 is the string from the DICOM reference: 'MONOCHROME1'
340 std::string s1_even = s1; //Never change input parameter
341 std::string s2_even = DicomString( s2 );
342 if( s1_even[s1_even.size()-1] == ' ')
344 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
346 return s1_even == s2_even;
353 * \brief tells us if the processor we are working with is BigEndian or not
355 bool Util::IsCurrentProcessorBigEndian()
357 #ifdef GDCM_WORDS_BIGENDIAN
367 typedef BOOL(WINAPI * pSnmpExtensionInit) (
368 IN DWORD dwTimeZeroReference,
369 OUT HANDLE * hPollForTrapEvent,
370 OUT AsnObjectIdentifier * supportedView);
372 typedef BOOL(WINAPI * pSnmpExtensionTrap) (
373 OUT AsnObjectIdentifier * enterprise,
374 OUT AsnInteger * genericTrap,
375 OUT AsnInteger * specificTrap,
376 OUT AsnTimeticks * timeStamp,
377 OUT RFC1157VarBindList * variableBindings);
379 typedef BOOL(WINAPI * pSnmpExtensionQuery) (
381 IN OUT RFC1157VarBindList * variableBindings,
382 OUT AsnInteger * errorStatus,
383 OUT AsnInteger * errorIndex);
385 typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
386 OUT AsnObjectIdentifier * supportedView);
390 long GetMacAddrSys ( unsigned char *addr)
394 if (WSAStartup(MAKEWORD(2, 0), &WinsockData) != 0)
396 std::cerr << "This program requires Winsock 2.x!" << std::endl;
400 HANDLE PollForTrapEvent;
401 AsnObjectIdentifier SupportedView;
402 UINT OID_ifEntryType[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 3 };
403 UINT OID_ifEntryNum[] = { 1, 3, 6, 1, 2, 1, 2, 1 };
404 UINT OID_ipMACEntAddr[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 6 };
405 AsnObjectIdentifier MIB_ifMACEntAddr = {
406 sizeof(OID_ipMACEntAddr) / sizeof(UINT), OID_ipMACEntAddr };
407 AsnObjectIdentifier MIB_ifEntryType = {
408 sizeof(OID_ifEntryType) / sizeof(UINT), OID_ifEntryType };
409 AsnObjectIdentifier MIB_ifEntryNum = {
410 sizeof(OID_ifEntryNum) / sizeof(UINT), OID_ifEntryNum };
411 RFC1157VarBindList varBindList;
412 RFC1157VarBind varBind[2];
413 AsnInteger errorStatus;
414 AsnInteger errorIndex;
415 AsnObjectIdentifier MIB_NULL = { 0, 0 };
421 // Load the SNMP dll and get the addresses of the functions necessary
422 HINSTANCE m_hInst = LoadLibrary("inetmib1.dll");
423 if (m_hInst < (HINSTANCE) HINSTANCE_ERROR)
428 pSnmpExtensionInit m_Init =
429 (pSnmpExtensionInit) GetProcAddress(m_hInst, "SnmpExtensionInit");
430 pSnmpExtensionInitEx m_InitEx =
431 (pSnmpExtensionInitEx) GetProcAddress(m_hInst, "SnmpExtensionInitEx");
432 pSnmpExtensionQuery m_Query =
433 (pSnmpExtensionQuery) GetProcAddress(m_hInst, "SnmpExtensionQuery");
434 pSnmpExtensionTrap m_Trap =
435 (pSnmpExtensionTrap) GetProcAddress(m_hInst, "SnmpExtensionTrap");
436 m_Init(GetTickCount(), &PollForTrapEvent, &SupportedView);
438 /* Initialize the variable list to be retrieved by m_Query */
439 varBindList.list = varBind;
440 varBind[0].name = MIB_NULL;
441 varBind[1].name = MIB_NULL;
443 // Copy in the OID to find the number of entries in the
445 varBindList.len = 1; // Only retrieving one item
446 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryNum);
447 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
449 // printf("# of adapters in this system : %i\n",
450 // varBind[0].value.asnValue.number); varBindList.len = 2;
452 // Copy in the OID of ifType, the type of interface
453 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryType);
455 // Copy in the OID of ifPhysAddress, the address
456 SNMP_oidcpy(&varBind[1].name, &MIB_ifMACEntAddr);
460 // Submit the query. Responses will be loaded into varBindList.
461 // We can expect this call to succeed a # of times corresponding
462 // to the # of adapters reported to be in the system
463 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
471 // Confirm that the proper type has been returned
472 ret = SNMP_oidncmp(&varBind[0].name, &MIB_ifEntryType,
473 MIB_ifEntryType.idLength);
478 dtmp = varBind[0].value.asnValue.number;
479 printf("Interface #%i type : %i\n", j, dtmp);
481 // Type 6 describes ethernet interfaces
484 // Confirm that we have an address here
485 ret = SNMP_oidncmp(&varBind[1].name, &MIB_ifMACEntAddr,
486 MIB_ifMACEntAddr.idLength);
487 if ( !ret && varBind[1].value.asnValue.address.stream != NULL )
489 if ( (varBind[1].value.asnValue.address.stream[0] == 0x44)
490 && (varBind[1].value.asnValue.address.stream[1] == 0x45)
491 && (varBind[1].value.asnValue.address.stream[2] == 0x53)
492 && (varBind[1].value.asnValue.address.stream[3] == 0x54)
493 && (varBind[1].value.asnValue.address.stream[4] == 0x00) )
495 // Ignore all dial-up networking adapters
496 printf("Interface #%i is a DUN adapter\n", j);
499 if ( (varBind[1].value.asnValue.address.stream[0] == 0x00)
500 && (varBind[1].value.asnValue.address.stream[1] == 0x00)
501 && (varBind[1].value.asnValue.address.stream[2] == 0x00)
502 && (varBind[1].value.asnValue.address.stream[3] == 0x00)
503 && (varBind[1].value.asnValue.address.stream[4] == 0x00)
504 && (varBind[1].value.asnValue.address.stream[5] == 0x00) )
506 // Ignore NULL addresses returned by other network
508 printf("Interface #%i is a NULL address\n", j);
511 memcpy( addr, varBind[1].value.asnValue.address.stream, 6);
518 SNMP_FreeVarBind(&varBind[0]);
519 SNMP_FreeVarBind(&varBind[1]);
521 #endif //Win32 version
524 // implementation for POSIX system
526 //The POSIX version is broken anyway on Solaris, plus would require full
529 struct arpreq parpreq;
530 struct sockaddr_in sa, *psa;
531 struct in_addr inaddr;
532 struct hostent *phost;
533 char hostname[MAXHOSTNAMELEN];
538 gethostname(hostname, MAXHOSTNAMELEN);
539 phost = gethostbyname(hostname);
540 paddrs = phost->h_addr_list;
542 //memcpy(&inaddr.s_addr, *paddrs, sizeof(inaddr.s_addr));
543 sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
550 memset(&parpreq, 0, sizeof(struct arpreq));
551 psa = (struct sockaddr_in *) &parpreq.arp_pa;
552 memset(psa, 0, sizeof(struct sockaddr_in));
553 psa->sin_family = AF_INET;
554 memcpy(&psa->sin_addr, *paddrs, sizeof(struct in_addr));
556 status = ioctl(sock, SIOCGARP, &parpreq);
565 memcpy(addr, parpreq.arp_ha.sa_data, 6);
566 // printf("MAC Address: %x:%x:%x:%x:%x:%x\n",
568 // parpreq.arp_ha.sa_data[0],
569 // parpreq.arp_ha.sa_data[1],
570 // parpreq.arp_ha.sa_data[2],
571 // parpreq.arp_ha.sa_data[3],
572 // parpreq.arp_ha.sa_data[4],
574 // parpreq.arp_ha.sa_data[5]);
578 #ifdef CMAKE_HAVE_NET_IF_H
580 struct ifreq ifr, *ifrp;
586 struct sockaddr_dl *sdlp;
590 // BSD 4.4 defines the size of an ifreq to be
591 // max(sizeof(ifreq), sizeof(ifreq.ifr_name)+ifreq.ifr_addr.sa_len
592 // However, under earlier systems, sa_len isn't present, so the size is
593 // just sizeof(struct ifreq)
594 // We should investiage the use of SIZEOF_ADDR_IFREQ
598 #define max(a,b) ((a) > (b) ? (a) : (b))
600 #define ifreq_size(i) max(sizeof(struct ifreq),\
601 sizeof((i).ifr_name)+(i).ifr_addr.sa_len)
603 #define ifreq_size(i) sizeof(struct ifreq)
604 #endif // HAVE_SA_LEN
606 if( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
610 memset(buf, 0, sizeof(buf));
611 ifc.ifc_len = sizeof(buf);
613 if (ioctl (sd, SIOCGIFCONF, (char *)&ifc) < 0)
619 for (i = 0; i < n; i+= ifreq_size(*ifrp) )
621 ifrp = (struct ifreq *)((char *) ifc.ifc_buf+i);
622 strncpy(ifr.ifr_name, ifrp->ifr_name, IFNAMSIZ);
624 if (ioctl(sd, SIOCGIFHWADDR, &ifr) < 0)
626 a = (unsigned char *) &ifr.ifr_hwaddr.sa_data;
629 if (ioctl(sd, SIOCGENADDR, &ifr) < 0)
631 a = (unsigned char *) ifr.ifr_enaddr;
634 sdlp = (struct sockaddr_dl *) &ifrp->ifr_addr;
635 if ((sdlp->sdl_family != AF_LINK) || (sdlp->sdl_alen != 6))
637 a = (unsigned char *) &sdlp->sdl_data[sdlp->sdl_nlen];
640 * XXX we don't have a way of getting the hardware
646 #endif // SIOCGENADDR
647 #endif // SIOCGIFHWADDR
648 if (!a[0] && !a[1] && !a[2] && !a[3] && !a[4] && !a[5]) continue;
664 std::string Util::GetMACAddress()
666 // This is a rip from: http://cplus.kompf.de/macaddr.html for Linux/CYGWIN, HPUX and AIX
667 // and http://tangentsoft.net/wskfaq/examples/src/snmpmac.cpp for windows version
668 // and http://groups-beta.google.com/group/sol.lists.freebsd.hackers/msg/0d0f862e05fce6c0 for the FreeBSD version
669 // and http://developer.apple.com/samplecode/GetPrimaryMACAddress/GetPrimaryMACAddress.html for MacOSX version
673 long stat = GetMacAddrSys(addr);
676 //printf( "MAC address = ");
677 for (int i=0; i<6; ++i)
679 //printf("%2.2x", addr[i]);
680 macaddr += Format("%2.2x", addr[i]);
687 //printf( "No MAC address !\n" );
694 * \brief Return the IP adress of the machine writting the DICOM image
696 std::string Util::GetIPAddress()
698 // This is a rip from
699 // http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
700 #ifndef HOST_NAME_MAX
701 // SUSv2 guarantees that `Host names are limited to 255 bytes'.
702 // POSIX 1003.1-2001 guarantees that `Host names (not including the
703 // terminating NUL) are limited to HOST_NAME_MAX bytes'.
704 # define HOST_NAME_MAX 255
705 // In this case we should maybe check the string was not truncated.
706 // But I don't known how to check that...
707 #if defined(_MSC_VER) || defined(__BORLANDC__)
708 // with WinSock DLL we need to initialise the WinSock before using gethostname
709 WORD wVersionRequested = MAKEWORD(1,0);
711 int err = WSAStartup(wVersionRequested,&WSAData);
714 // Tell the user that we could not find a usable
721 #endif //HOST_NAME_MAX
724 char szHostName[HOST_NAME_MAX+1];
725 int r = gethostname(szHostName, HOST_NAME_MAX);
730 struct hostent *pHost = gethostbyname(szHostName);
732 for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
734 for( int j = 0; j<pHost->h_length; j++ )
736 if( j > 0 ) str += ".";
738 str += Util::Format("%u",
739 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
741 // str now contains one local IP address
743 #if defined(_MSC_VER) || defined(__BORLANDC__)
749 // If an error occur r == -1
750 // Most of the time it will return 127.0.0.1...
756 * \brief Creates a new UID. As stipulate in the DICOM ref
757 * each time a DICOM image is create it should have
758 * a unique identifier (URI)
760 std::string Util::CreateUniqueUID(const std::string &root)
762 // The code works as follow:
763 // echo "gdcm" | od -b
764 // 0000000 147 144 143 155 012
765 // Therefore we return
766 // radical + 147.144.143.155 + IP + time()
767 std::string radical = root;
768 if( !root.size() ) //anything better ?
770 radical = "0.0."; // Is this really usefull ?
773 // A root was specified use it to forge our new UID:
774 radical += "147.144.143.155"; // gdcm
776 radical += Util::GetIPAddress();
778 radical += Util::GetCurrentDate();
780 radical += Util::GetCurrentTime();
786 std::ostream &binary_write(std::ostream &os, const T &val)
788 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
791 std::ostream &binary_write(std::ostream &os, const uint16_t &val)
793 #ifdef GDCM_WORDS_BIGENDIAN
795 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
796 return os.write(reinterpret_cast<const char*>(&swap), 2);
798 return os.write(reinterpret_cast<const char*>(&val), 2);
799 #endif //GDCM_WORDS_BIGENDIAN
802 std::ostream &binary_write(std::ostream &os, const uint32_t &val)
804 #ifdef GDCM_WORDS_BIGENDIAN
806 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
807 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
808 return os.write(reinterpret_cast<const char*>(&swap), 4);
810 return os.write(reinterpret_cast<const char*>(&val), 4);
811 #endif //GDCM_WORDS_BIGENDIAN
814 std::ostream &binary_write(std::ostream &os, const char *val)
816 return os.write(val, strlen(val));
819 std::ostream &binary_write(std::ostream &os, std::string const &val)
821 return os.write(val.c_str(), val.size());
824 } // end namespace gdcm