1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2005/01/15 20:24:02 $
7 Version: $Revision: 1.92 $
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
51 #include <sys/types.h>
55 #ifdef CMAKE_HAVE_SYS_IOCTL_H
56 #include <sys/ioctl.h> // For SIOCGIFCONF on Linux
58 #ifdef CMAKE_HAVE_SYS_SOCKET_H
59 #include <sys/socket.h>
61 #ifdef CMAKE_HAVE_SYS_SOCKIO_H
62 #include <sys/sockio.h> // For SIOCGIFCONF on SunOS
64 #ifdef CMAKE_HAVE_NET_IF_H
67 #ifdef CMAKE_HAVE_NETINET_IN_H
68 #include <netinet/in.h> //For IPPROTO_IP
70 #ifdef CMAKE_HAVE_NET_IF_DL_H
71 #include <net/if_dl.h>
74 // How do I do that in CMake ?
85 * \brief Provide a better 'c++' approach for sprintf
86 * For example c code is:
87 * sprintf(trash, "%04x|%04x", group , elem);
90 * std::ostringstream buf;
91 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
92 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
93 * << std::hex << elem;
97 * Format("%04x|%04x", group , elem);
100 std::string Util::Format(const char *format, ...)
104 va_start(args, format);
105 vsprintf(buffer, format, args); //might be a security flaw
106 va_end(args); // Each invocation of va_start should be matched
107 // by a corresponding invocation of va_end
108 // args is then 'undefined'
115 * \brief Because not available in C++ (?)
117 void Util::Tokenize (const std::string &str,
118 std::vector<std::string> &tokens,
119 const std::string& delimiters)
121 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
122 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
123 while (std::string::npos != pos || std::string::npos != lastPos)
125 tokens.push_back(str.substr(lastPos, pos - lastPos));
126 lastPos = str.find_first_not_of(delimiters, pos);
127 pos = str.find_first_of (delimiters, lastPos);
133 * \brief Because not available in C++ (?)
134 * Counts the number of occurences of a substring within a string
137 int Util::CountSubstring (const std::string &str,
138 const std::string &subStr)
140 int count = 0; // counts how many times it appears
141 std::string::size_type x = 0; // The index position in the string
145 x = str.find(subStr,x); // Find the substring
146 if (x != std::string::npos) // If present
148 count++; // increase the count
149 x += subStr.length(); // Skip this word
152 while (x != std::string::npos); // Carry on until not present
159 * \brief Weed out a string from the non-printable characters (in order
160 * to avoid corrupting the terminal of invocation when printing)
161 * @param s string to remove non printable characters from
163 std::string Util::CreateCleanString(std::string const &s)
167 for(unsigned int i=0; i<str.size(); i++)
169 if(!isprint((unsigned char)str[i]))
177 if(!isprint((unsigned char)s[str.size()-1]))
179 if(s[str.size()-1] == 0)
181 str[str.size()-1] = ' ';
191 * \brief Add a SEPARATOR to the end of the name is necessary
192 * @param pathname file/directory name to normalize
194 std::string Util::NormalizePath(std::string const &pathname)
196 const char SEPARATOR_X = '/';
197 const char SEPARATOR_WIN = '\\';
198 const std::string SEPARATOR = "/";
199 std::string name = pathname;
200 int size = name.size();
202 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
211 * \brief Get the (directory) path from a full path file name
212 * @param fullName file/directory name to extract Path from
214 std::string Util::GetPath(std::string const &fullName)
216 std::string res = fullName;
217 int pos1 = res.rfind("/");
218 int pos2 = res.rfind("\\");
233 * \brief Get the (last) name of a full path file name
234 * @param fullName file/directory name to extract end name from
236 std::string Util::GetName(std::string const &fullName)
238 std::string filename = fullName;
240 std::string::size_type slash_pos = filename.rfind("/");
241 std::string::size_type backslash_pos = filename.rfind("\\");
242 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
243 if(slash_pos != std::string::npos)
245 return filename.substr(slash_pos + 1);
255 * \brief Get the current date of the system in a dicom string
257 std::string Util::GetCurrentDate()
262 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
268 * \brief Get the current time of the system in a dicom string
270 std::string Util::GetCurrentTime()
275 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
280 * \brief Create a /DICOM/ string:
281 * It should a of even length (no odd length ever)
282 * It can contain as many (if you are reading this from your
283 * editor the following character is is backslash followed by zero
284 * that needed to be escaped with an extra backslash for doxygen) \\0
287 std::string Util::DicomString(const char *s, size_t l)
289 std::string r(s, s+l);
290 gdcmAssertMacro( !(r.size() % 2) ); // == basically 'l' is even
296 * \brief Create a /DICOM/ string:
297 * It should a of even lenght (no odd length ever)
298 * It can contain as many (if you are reading this from your
299 * editor the following character is is backslash followed by zero
300 * that needed to be escaped with an extra backslash for doxygen) \\0
302 * This function is similar to DicomString(const char*),
303 * except it doesn't take a lenght.
304 * It only pad with a null character if length is odd
306 std::string Util::DicomString(const char *s)
308 size_t l = strlen(s);
313 std::string r(s, s+l);
314 gdcmAssertMacro( !(r.size() % 2) );
320 * \brief Safely compare two Dicom String:
321 * - Both string should be of even lenght
322 * - We allow padding of even lenght string by either a null
323 * character of a space
325 bool Util::DicomStringEqual(const std::string &s1, const char *s2)
327 // s2 is the string from the DICOM reference: 'MONOCHROME1'
328 std::string s1_even = s1; //Never change input parameter
329 std::string s2_even = DicomString( s2 );
330 if( s1_even[s1_even.size()-1] == ' ')
332 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
334 return s1_even == s2_even;
341 * \brief tells us if the processor we are working with is BigEndian or not
343 bool Util::IsCurrentProcessorBigEndian()
345 #ifdef GDCM_WORDS_BIGENDIAN
355 typedef BOOL(WINAPI * pSnmpExtensionInit) (
356 IN DWORD dwTimeZeroReference,
357 OUT HANDLE * hPollForTrapEvent,
358 OUT AsnObjectIdentifier * supportedView);
360 typedef BOOL(WINAPI * pSnmpExtensionTrap) (
361 OUT AsnObjectIdentifier * enterprise,
362 OUT AsnInteger * genericTrap,
363 OUT AsnInteger * specificTrap,
364 OUT AsnTimeticks * timeStamp,
365 OUT RFC1157VarBindList * variableBindings);
367 typedef BOOL(WINAPI * pSnmpExtensionQuery) (
369 IN OUT RFC1157VarBindList * variableBindings,
370 OUT AsnInteger * errorStatus,
371 OUT AsnInteger * errorIndex);
373 typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
374 OUT AsnObjectIdentifier * supportedView);
378 long GetMacAddrSys ( unsigned char *addr)
382 if (WSAStartup(MAKEWORD(2, 0), &WinsockData) != 0)
384 std::cerr << "This program requires Winsock 2.x!" << std::endl;
388 HANDLE PollForTrapEvent;
389 AsnObjectIdentifier SupportedView;
390 UINT OID_ifEntryType[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 3 };
391 UINT OID_ifEntryNum[] = { 1, 3, 6, 1, 2, 1, 2, 1 };
392 UINT OID_ipMACEntAddr[] = { 1, 3, 6, 1, 2, 1, 2, 2, 1, 6 };
393 AsnObjectIdentifier MIB_ifMACEntAddr = {
394 sizeof(OID_ipMACEntAddr) / sizeof(UINT), OID_ipMACEntAddr };
395 AsnObjectIdentifier MIB_ifEntryType = {
396 sizeof(OID_ifEntryType) / sizeof(UINT), OID_ifEntryType };
397 AsnObjectIdentifier MIB_ifEntryNum = {
398 sizeof(OID_ifEntryNum) / sizeof(UINT), OID_ifEntryNum };
399 RFC1157VarBindList varBindList;
400 RFC1157VarBind varBind[2];
401 AsnInteger errorStatus;
402 AsnInteger errorIndex;
403 AsnObjectIdentifier MIB_NULL = { 0, 0 };
409 // Load the SNMP dll and get the addresses of the functions necessary
410 HINSTANCE m_hInst = LoadLibrary("inetmib1.dll");
411 if (m_hInst < (HINSTANCE) HINSTANCE_ERROR)
416 pSnmpExtensionInit m_Init =
417 (pSnmpExtensionInit) GetProcAddress(m_hInst, "SnmpExtensionInit");
418 pSnmpExtensionInitEx m_InitEx =
419 (pSnmpExtensionInitEx) GetProcAddress(m_hInst, "SnmpExtensionInitEx");
420 pSnmpExtensionQuery m_Query =
421 (pSnmpExtensionQuery) GetProcAddress(m_hInst, "SnmpExtensionQuery");
422 pSnmpExtensionTrap m_Trap =
423 (pSnmpExtensionTrap) GetProcAddress(m_hInst, "SnmpExtensionTrap");
424 m_Init(GetTickCount(), &PollForTrapEvent, &SupportedView);
426 /* Initialize the variable list to be retrieved by m_Query */
427 varBindList.list = varBind;
428 varBind[0].name = MIB_NULL;
429 varBind[1].name = MIB_NULL;
431 // Copy in the OID to find the number of entries in the
433 varBindList.len = 1; // Only retrieving one item
434 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryNum);
435 ret = m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
437 // printf("# of adapters in this system : %i\n",
438 // varBind[0].value.asnValue.number); varBindList.len = 2;
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 printf("Interface #%i type : %i\n", j, dtmp);
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 printf("Interface #%i is a DUN adapter\n", j);
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 printf("Interface #%i is a NULL address\n", j);
499 memcpy( addr, varBind[1].value.asnValue.address.stream, 6);
506 SNMP_FreeVarBind(&varBind[0]);
507 SNMP_FreeVarBind(&varBind[1]);
510 // implementation for POSIX system
511 #ifdef CMAKE_HAVE_NET_IF_H
513 struct ifreq ifr, *ifrp;
519 struct sockaddr_dl *sdlp;
523 // BSD 4.4 defines the size of an ifreq to be
524 // max(sizeof(ifreq), sizeof(ifreq.ifr_name)+ifreq.ifr_addr.sa_len
525 // However, under earlier systems, sa_len isn't present, so the size is
526 // just sizeof(struct ifreq)
527 // We should investiage the use of SIZEOF_ADDR_IFREQ
531 #define max(a,b) ((a) > (b) ? (a) : (b))
533 #define ifreq_size(i) max(sizeof(struct ifreq),\
534 sizeof((i).ifr_name)+(i).ifr_addr.sa_len)
536 #define ifreq_size(i) sizeof(struct ifreq)
537 #endif // HAVE_SA_LEN
539 if( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
543 memset(buf, 0, sizeof(buf));
544 ifc.ifc_len = sizeof(buf);
546 if (ioctl (sd, SIOCGIFCONF, (char *)&ifc) < 0)
552 for (i = 0; i < n; i+= ifreq_size(*ifrp) )
554 ifrp = (struct ifreq *)((char *) ifc.ifc_buf+i);
555 strncpy(ifr.ifr_name, ifrp->ifr_name, IFNAMSIZ);
557 if (ioctl(sd, SIOCGIFHWADDR, &ifr) < 0)
559 a = (unsigned char *) &ifr.ifr_hwaddr.sa_data;
562 if (ioctl(sd, SIOCGENADDR, &ifr) < 0)
564 a = (unsigned char *) ifr.ifr_enaddr;
567 sdlp = (struct sockaddr_dl *) &ifrp->ifr_addr;
568 if ((sdlp->sdl_family != AF_LINK) || (sdlp->sdl_alen != 6))
570 a = (unsigned char *) &sdlp->sdl_data[sdlp->sdl_nlen];
573 * XXX we don't have a way of getting the hardware
579 #endif // SIOCGENADDR
580 #endif // SIOCGIFHWADDR
581 if (!a[0] && !a[1] && !a[2] && !a[3] && !a[4] && !a[5]) continue;
597 std::string Util::GetMACAddress()
599 // This is a rip from: http://cplus.kompf.de/macaddr.html for Linux/CYGWIN, HPUX and AIX
600 // and http://tangentsoft.net/wskfaq/examples/src/snmpmac.cpp for windows version
601 // and http://groups-beta.google.com/group/sol.lists.freebsd.hackers/msg/0d0f862e05fce6c0 for the FreeBSD version
602 // and http://developer.apple.com/samplecode/GetPrimaryMACAddress/GetPrimaryMACAddress.html for MacOSX version
606 long stat = GetMacAddrSys(addr);
609 //printf( "MAC address = ");
610 for (int i=0; i<6; ++i)
612 //printf("%2.2x", addr[i]);
613 macaddr += Format("%2.2x", addr[i]);
620 //printf( "No MAC address !\n" );
627 * \brief Return the IP adress of the machine writting the DICOM image
629 std::string Util::GetIPAddress()
631 // This is a rip from
632 // http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
633 #ifndef HOST_NAME_MAX
634 // SUSv2 guarantees that `Host names are limited to 255 bytes'.
635 // POSIX 1003.1-2001 guarantees that `Host names (not including the
636 // terminating NUL) are limited to HOST_NAME_MAX bytes'.
637 # define HOST_NAME_MAX 255
638 // In this case we should maybe check the string was not truncated.
639 // But I don't known how to check that...
640 #if defined(_MSC_VER) || defined(__BORLANDC__)
641 // with WinSock DLL we need to initialise the WinSock before using gethostname
642 WORD wVersionRequested = MAKEWORD(1,0);
644 int err = WSAStartup(wVersionRequested,&WSAData);
647 // Tell the user that we could not find a usable
654 #endif //HOST_NAME_MAX
657 char szHostName[HOST_NAME_MAX+1];
658 int r = gethostname(szHostName, HOST_NAME_MAX);
663 struct hostent *pHost = gethostbyname(szHostName);
665 for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
667 for( int j = 0; j<pHost->h_length; j++ )
669 if( j > 0 ) str += ".";
671 str += Util::Format("%u",
672 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
674 // str now contains one local IP address
676 #if defined(_MSC_VER) || defined(__BORLANDC__)
682 // If an error occur r == -1
683 // Most of the time it will return 127.0.0.1...
689 * \brief Creates a new UID. As stipulate in the DICOM ref
690 * each time a DICOM image is create it should have
691 * a unique identifier (URI)
693 std::string Util::CreateUniqueUID(const std::string &root)
695 // The code works as follow:
696 // echo "gdcm" | od -b
697 // 0000000 147 144 143 155 012
698 // Therefore we return
699 // radical + 147.144.143.155 + IP + time()
700 std::string radical = root;
701 if( !root.size() ) //anything better ?
703 radical = "0.0."; // Is this really usefull ?
706 // A root was specified use it to forge our new UID:
707 radical += "147.144.143.155"; // gdcm
709 radical += Util::GetIPAddress();
711 radical += Util::GetCurrentDate();
713 radical += Util::GetCurrentTime();
719 std::ostream &binary_write(std::ostream &os, const T &val)
721 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
724 std::ostream &binary_write(std::ostream &os, const uint16_t &val)
726 #ifdef GDCM_WORDS_BIGENDIAN
728 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
729 return os.write(reinterpret_cast<const char*>(&swap), 2);
731 return os.write(reinterpret_cast<const char*>(&val), 2);
732 #endif //GDCM_WORDS_BIGENDIAN
735 std::ostream &binary_write(std::ostream &os, const uint32_t &val)
737 #ifdef GDCM_WORDS_BIGENDIAN
739 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
740 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
741 return os.write(reinterpret_cast<const char*>(&swap), 4);
743 return os.write(reinterpret_cast<const char*>(&val), 4);
744 #endif //GDCM_WORDS_BIGENDIAN
747 std::ostream &binary_write(std::ostream &os, const char *val)
749 return os.write(val, strlen(val));
752 std::ostream &binary_write(std::ostream &os, std::string const &val)
754 return os.write(val.c_str(), val.size());
757 } // end namespace gdcm