1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2005/01/06 19:20:23 $
7 Version: $Revision: 1.75 $
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"
22 // For GetCurrentDate, GetCurrentTime
24 #include <sys/types.h>
27 #include <stdarg.h> //only included in implementation file
28 #include <stdio.h> //only included in implementation file
31 #include <winsock.h> // for gethostname & gethostbyname
35 #include <unistd.h> // for gethostname
36 #include <netdb.h> // for gethostbyname
44 * \brief Provide a better 'c++' approach for sprintf
45 * For example c code is:
46 * sprintf(trash, "%04x|%04x", group , element);
49 * std::ostringstream buf;
50 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
51 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
52 * << std::hex << element;
56 std::string Util::Format(const char* format, ...)
60 va_start(args, format);
61 vsprintf(buffer, format, args); //might be a security flaw
62 va_end(args); // Each invocation of va_start should be matched
63 // by a corresponding invocation of va_end
64 // args is then 'undefined'
71 * \brief Because not available in C++ (?)
73 void Util::Tokenize (const std::string& str,
74 std::vector<std::string>& tokens,
75 const std::string& delimiters)
77 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
78 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
79 while (std::string::npos != pos || std::string::npos != lastPos)
81 tokens.push_back(str.substr(lastPos, pos - lastPos));
82 lastPos = str.find_first_not_of(delimiters, pos);
83 pos = str.find_first_of (delimiters, lastPos);
89 * \brief Because not available in C++ (?)
90 * Counts the number of occurences of a substring within a string
93 int Util::CountSubstring (const std::string& str,
94 const std::string& subStr)
96 int count = 0; // counts how many times it appears
97 std::string::size_type x = 0; // The index position in the string
101 x = str.find(subStr,x); // Find the substring
102 if (x != std::string::npos) // If present
104 count++; // increase the count
105 x += subStr.length(); // Skip this word
108 while (x != std::string::npos); // Carry on until not present
115 * \brief Weed out a string from the non-printable characters (in order
116 * to avoid corrupting the terminal of invocation when printing)
117 * @param s string to remove non printable characters from
119 std::string Util::CreateCleanString(std::string const & s)
123 for(unsigned int i=0; i<str.size(); i++)
125 if(!isprint((unsigned char)str[i]))
133 if(!isprint((unsigned char)s[str.size()-1]))
135 if(s[str.size()-1] == 0)
137 str[str.size()-1] = ' ';
147 * \brief Add a SEPARATOR to the end of the name is necessary
148 * @param pathname file/directory name to normalize
150 std::string Util::NormalizePath(std::string const & pathname)
152 const char SEPARATOR_X = '/';
153 const char SEPARATOR_WIN = '\\';
154 const std::string SEPARATOR = "/";
155 std::string name = pathname;
156 int size = name.size();
158 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
167 * \brief Get the (directory) path from a full path file name
168 * @param fullName file/directory name to extract Path from
170 std::string Util::GetPath(std::string const & fullName)
172 std::string res = fullName;
173 int pos1 = res.rfind("/");
174 int pos2 = res.rfind("\\");
189 * \brief Get the (last) name of a full path file name
190 * @param fullName file/directory name to extract end name from
192 std::string Util::GetName(std::string const & fullName)
194 std::string filename = fullName;
196 std::string::size_type slash_pos = filename.rfind("/");
197 std::string::size_type backslash_pos = filename.rfind("\\");
198 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
199 if(slash_pos != std::string::npos)
201 return filename.substr(slash_pos + 1);
211 * \brief Get the current date of the system in a dicom string
213 std::string Util::GetCurrentDate()
218 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
224 * \brief Get the current time of the system in a dicom string
226 std::string Util::GetCurrentTime()
231 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
236 * \brief Create a /DICOM/ string:
237 * It should a of even length (no odd length ever)
238 * It can contain as many (if you are reading this from your
239 * editor the following character is is backslash followed by zero
240 * that needed to be escaped with an extra backslash for doxygen) \\0
243 std::string Util::DicomString(const char* s, size_t l)
245 std::string r(s, s+l);
246 assert( !(r.size() % 2) ); // == basically 'l' is even
252 * \brief Create a /DICOM/ string:
253 * It should a of even lenght (no odd length ever)
254 * It can contain as many (if you are reading this from your
255 * editor the following character is is backslash followed by zero
256 * that needed to be escaped with an extra backslash for doxygen) \\0
258 * This function is similar to DicomString(const char*),
259 * except it doesn't take a lenght.
260 * It only pad with a null character if length is odd
262 std::string Util::DicomString(const char* s)
264 size_t l = strlen(s);
269 std::string r(s, s+l);
270 assert( !(r.size() % 2) );
276 * \brief Safely compare two Dicom String:
277 * - Both string should be of even lenght
278 * - We allow padding of even lenght string by either a null
279 * character of a space
281 bool Util::DicomStringEqual(const std::string& s1, const char *s2)
283 // s2 is the string from the DICOM reference: 'MONOCHROME1'
284 std::string s1_even = s1; //Never change input parameter
285 std::string s2_even = DicomString( s2 );
286 if( s1_even[s1_even.size()-1] == ' ')
288 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
290 return s1_even == s2_even;
297 * \brief tells us if the processor we are working with is BigEndian or not
299 bool Util::IsCurrentProcessorBigEndian()
302 uint8_t bigEndianRepr[4] = { 0x00, 0x00, 0x00, 0x01 };
303 int res = memcmp(reinterpret_cast<const void*>(&intVal),
304 reinterpret_cast<const void*>(bigEndianRepr), 4);
321 typedef BOOL(WINAPI * pSnmpExtensionInit) (
322 IN DWORD dwTimeZeroReference,
323 OUT HANDLE * hPollForTrapEvent,
324 OUT AsnObjectIdentifier * supportedView);
326 typedef BOOL(WINAPI * pSnmpExtensionTrap) (
327 OUT AsnObjectIdentifier * enterprise,
328 OUT AsnInteger * genericTrap,
329 OUT AsnInteger * specificTrap,
330 OUT AsnTimeticks * timeStamp,
331 OUT RFC1157VarBindList * variableBindings);
333 typedef BOOL(WINAPI * pSnmpExtensionQuery) (
335 IN OUT RFC1157VarBindList * variableBindings,
336 OUT AsnInteger * errorStatus,
337 OUT AsnInteger * errorIndex);
339 typedef BOOL(WINAPI * pSnmpExtensionInitEx) (
340 OUT AsnObjectIdentifier * supportedView);
342 #include <strings.h> //for bzero on unix
346 #include <sys/ioctl.h>
347 #include <sys/types.h>
348 #include <sys/socket.h>
349 #include <netinet/in.h>
350 #include <linux/if.h>
358 #include <sys/ndd_var.h>
359 #include <sys/kinfo.h>
362 long GetMacAddrSys ( u_char *addr)
366 if (WSAStartup(MAKEWORD(2, 0), &WinsockData) != 0) {
367 fprintf(stderr, "This program requires Winsock 2.x!\n");
372 pSnmpExtensionInit m_Init;
373 pSnmpExtensionInitEx m_InitEx;
374 pSnmpExtensionQuery m_Query;
375 pSnmpExtensionTrap m_Trap;
376 HANDLE PollForTrapEvent;
377 AsnObjectIdentifier SupportedView;
378 UINT OID_ifEntryType[] = {
379 1, 3, 6, 1, 2, 1, 2, 2, 1, 3
381 UINT OID_ifEntryNum[] = {
382 1, 3, 6, 1, 2, 1, 2, 1
384 UINT OID_ipMACEntAddr[] = {
385 1, 3, 6, 1, 2, 1, 2, 2, 1, 6
387 AsnObjectIdentifier MIB_ifMACEntAddr =
388 { sizeof(OID_ipMACEntAddr) / sizeof(UINT), OID_ipMACEntAddr };
389 AsnObjectIdentifier MIB_ifEntryType = {
390 sizeof(OID_ifEntryType) / sizeof(UINT), OID_ifEntryType
392 AsnObjectIdentifier MIB_ifEntryNum = {
393 sizeof(OID_ifEntryNum) / sizeof(UINT), OID_ifEntryNum
395 RFC1157VarBindList varBindList;
396 RFC1157VarBind varBind[2];
397 AsnInteger errorStatus;
398 AsnInteger errorIndex;
399 AsnObjectIdentifier MIB_NULL = {
406 char TempEthernet[13];
412 /* Load the SNMP dll and get the addresses of the functions
414 m_hInst = LoadLibrary("inetmib1.dll");
415 if (m_hInst < (HINSTANCE) HINSTANCE_ERROR) {
420 (pSnmpExtensionInit) GetProcAddress(m_hInst, "SnmpExtensionInit");
422 (pSnmpExtensionInitEx) GetProcAddress(m_hInst,
423 "SnmpExtensionInitEx");
425 (pSnmpExtensionQuery) GetProcAddress(m_hInst,
426 "SnmpExtensionQuery");
428 (pSnmpExtensionTrap) GetProcAddress(m_hInst, "SnmpExtensionTrap");
429 m_Init(GetTickCount(), &PollForTrapEvent, &SupportedView);
431 /* Initialize the variable list to be retrieved by m_Query */
432 varBindList.list = varBind;
433 varBind[0].name = MIB_NULL;
434 varBind[1].name = MIB_NULL;
436 /* Copy in the OID to find the number of entries in the
438 varBindList.len = 1; /* Only retrieving one item */
439 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryNum);
441 m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
443 // printf("# of adapters in this system : %i\n",
444 // varBind[0].value.asnValue.number); varBindList.len = 2;
446 /* Copy in the OID of ifType, the type of interface */
447 SNMP_oidcpy(&varBind[0].name, &MIB_ifEntryType);
449 /* Copy in the OID of ifPhysAddress, the address */
450 SNMP_oidcpy(&varBind[1].name, &MIB_ifMACEntAddr);
454 /* Submit the query. Responses will be loaded into varBindList.
455 We can expect this call to succeed a # of times corresponding
456 to the # of adapters reported to be in the system */
458 m_Query(ASN_RFC1157_GETNEXTREQUEST, &varBindList, &errorStatus,
459 &errorIndex); if (!ret) ret = 1;
462 /* Confirm that the proper type has been returned */
464 SNMP_oidncmp(&varBind[0].name, &MIB_ifEntryType,
465 MIB_ifEntryType.idLength); if (!ret) {
467 dtmp = varBind[0].value.asnValue.number;
468 //printf("Interface #%i type : %i\n", j, dtmp);
470 /* Type 6 describes ethernet interfaces */
473 /* Confirm that we have an address here */
475 SNMP_oidncmp(&varBind[1].name, &MIB_ifMACEntAddr,
476 MIB_ifMACEntAddr.idLength);
478 && (varBind[1].value.asnValue.address.stream != NULL)) {
480 (varBind[1].value.asnValue.address.stream[0] ==
482 && (varBind[1].value.asnValue.address.stream[1] ==
484 && (varBind[1].value.asnValue.address.stream[2] ==
486 && (varBind[1].value.asnValue.address.stream[3] ==
488 && (varBind[1].value.asnValue.address.stream[4] ==
491 /* Ignore all dial-up networking adapters */
492 //printf("Interface #%i is a DUN adapter\n", j);
496 (varBind[1].value.asnValue.address.stream[0] ==
498 && (varBind[1].value.asnValue.address.stream[1] ==
500 && (varBind[1].value.asnValue.address.stream[2] ==
502 && (varBind[1].value.asnValue.address.stream[3] ==
504 && (varBind[1].value.asnValue.address.stream[4] ==
506 && (varBind[1].value.asnValue.address.stream[5] ==
509 /* Ignore NULL addresses returned by other network
511 //printf("Interface #%i is a NULL address\n", j);
514 sprintf(addr, "%02x%02x%02x%02x%02x%02x",
515 varBind[1].value.asnValue.address.stream[0],
516 varBind[1].value.asnValue.address.stream[1],
517 varBind[1].value.asnValue.address.stream[2],
518 varBind[1].value.asnValue.address.stream[3],
519 varBind[1].value.asnValue.address.stream[4],
520 varBind[1].value.asnValue.address.stream[5]);
521 //printf("MAC Address of interface #%i: %s\n", j, TempEthernet);
525 } while (!ret); /* Stop only on an error. An error will occur
526 when we go exhaust the list of interfaces to
530 /* Free the bindings */
531 SNMP_FreeVarBind(&varBind[0]);
532 SNMP_FreeVarBind(&varBind[1]);
536 /* implementation for Linux */
545 s = socket(AF_INET, SOCK_DGRAM, 0);
550 ifc.ifc_len = sizeof(buf);
552 ioctl(s, SIOCGIFCONF, &ifc);
555 for (i = ifc.ifc_len / sizeof(struct ifreq); --i >= 0; IFR++) {
557 strcpy(ifr.ifr_name, IFR->ifr_name);
558 if (ioctl(s, SIOCGIFFLAGS, &ifr) == 0) {
559 if (! (ifr.ifr_flags & IFF_LOOPBACK)) {
560 if (ioctl(s, SIOCGIFHWADDR, &ifr) == 0) {
570 bcopy( ifr.ifr_hwaddr.sa_data, addr, 6);
578 /* implementation for HP-UX */
581 #define LAN_DEV0 "/dev/lan0"
584 struct fis iocnt_block;
586 char net_buf[sizeof(LAN_DEV0)+1];
589 (void)sprintf(net_buf, "%s", LAN_DEV0);
590 p = net_buf + strlen(net_buf) - 1;
593 * Get 802.3 address from card by opening the driver and interrogating it.
595 for (i = 0; i < 10; i++, (*p)++) {
596 if ((fd = open (net_buf, O_RDONLY)) != -1) {
597 iocnt_block.reqtype = LOCAL_ADDRESS;
598 ioctl (fd, NETSTAT, &iocnt_block);
601 if (iocnt_block.vtype == 6)
606 if (fd == -1 || iocnt_block.vtype != 6) {
610 bcopy( &iocnt_block.value.s[0], addr, 6);
615 /* implementation for AIX */
619 struct kinfo_ndd *nddp;
621 size = getkerninfo(KINFO_NDD, 0, 0, 0);
625 nddp = (struct kinfo_ndd *)malloc(size);
630 if (getkerninfo(KINFO_NDD, nddp, &size, 0) < 0) {
634 bcopy(nddp->ndd_addr, addr, 6);
639 /* Not implemented platforms */
643 std::string Util::GetMACAddress()
645 // This is a rip from: http://cplus.kompf.de/macaddr.html for Linux, HPUX and AIX
646 // and http://tangentsoft.net/wskfaq/examples/src/snmpmac.cpp for windows version
651 stat = GetMacAddrSys( addr);
654 //printf( "MAC address = ");
655 for (int i=0; i<6; ++i)
657 //printf("%2.2x", addr[i]);
658 macaddr += Format("%2.2x", addr[i]);
665 //printf( "No MAC address !\n" );
672 * \brief Return the IP adress of the machine writting the DICOM image
674 std::string Util::GetIPAddress()
676 // This is a rip from http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
677 #ifndef HOST_NAME_MAX
678 // SUSv2 guarantees that `Host names are limited to 255 bytes'.
679 // POSIX 1003.1-2001 guarantees that `Host names (not including the
680 // terminating NUL) are limited to HOST_NAME_MAX bytes'.
681 # define HOST_NAME_MAX 255
682 // In this case we should maybe check the string was not truncated.
683 // But I don't known how to check that...
684 #if defined(_MSC_VER) || defined(__BORLANDC__)
685 // with WinSock DLL we need to initialise the WinSock before using gethostname
686 WORD wVersionRequested = MAKEWORD(1,0);
688 int err = WSAStartup(wVersionRequested,&WSAData);
690 /* Tell the user that we could not find a usable */
697 #endif //HOST_NAME_MAX
700 char szHostName[HOST_NAME_MAX+1];
701 int r = gethostname(szHostName, HOST_NAME_MAX);
706 struct hostent * pHost = gethostbyname(szHostName);
708 for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
710 for( int j = 0; j<pHost->h_length; j++ )
712 if( j > 0 ) str += ".";
714 str += Util::Format("%u",
715 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
717 // str now contains one local IP address
719 #if defined(_MSC_VER) || defined(__BORLANDC__)
725 // If an error occur r == -1
726 // Most of the time it will return 127.0.0.1...
732 * \brief Creates a new UID. As stipulate in the DICOM ref
733 * each time a DICOM image is create it should have
734 * a unique identifier (URI)
736 std::string Util::CreateUniqueUID(const std::string& root)
738 // The code works as follow:
739 // echo "gdcm" | od -b
740 // 0000000 147 144 143 155 012
741 // Therefore we return
742 // radical + 147.144.143.155 + IP + time()
743 std::string radical = root;
744 if( !root.size() ) //anything better ?
746 radical = "0.0."; // Is this really usefull ?
749 // A root was specified use it to forge our new UID:
750 radical += "147.144.143.155"; // gdcm
752 radical += Util::GetIPAddress();
754 radical += Util::GetCurrentDate();
756 radical += Util::GetCurrentTime();
762 std::ostream& binary_write(std::ostream& os, const T& val)
764 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
767 std::ostream& binary_write(std::ostream& os, const uint16_t& val)
769 #ifdef GDCM_WORDS_BIGENDIAN
771 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
772 return os.write(reinterpret_cast<const char*>(&swap), 2);
774 return os.write(reinterpret_cast<const char*>(&val), 2);
775 #endif //GDCM_WORDS_BIGENDIAN
778 std::ostream& binary_write(std::ostream& os, const uint32_t& val)
780 #ifdef GDCM_WORDS_BIGENDIAN
782 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
783 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
784 return os.write(reinterpret_cast<const char*>(&swap), 4);
786 return os.write(reinterpret_cast<const char*>(&val), 4);
787 #endif //GDCM_WORDS_BIGENDIAN
790 std::ostream& binary_write(std::ostream& os, const char* val)
792 return os.write(val, strlen(val));
795 std::ostream& binary_write(std::ostream& os, std::string const & val)
797 return os.write(val.c_str(), val.size());
800 } // end namespace gdcm