CORBA_IORUtil.cpp

Go to the documentation of this file.

// -*- C++ -*-
#include <iostream>
#include <sstream>
#include <rtm/CORBA_IORUtil.h>

#define POA_NAME_SEP            '\xff'
#define TRANSIENT_SUFFIX_SEP    '\xfe'
#define TRANSIENT_SUFFIX_SIZE   8

namespace CORBA_IORUtil
{

#ifdef ORB_IS_OMNIORB
  typedef _CORBA_Unbounded_Sequence_Octet OctetUSequence;
  typedef _CORBA_Unbounded_Sequence_String StringUSequence;
#endif

#ifndef ORB_IS_RTORB
  // prototype of static functions 
  static void print_key(std::stringstream& s, OctetUSequence& key);
  
  static void print_omni_key(std::stringstream& sstr, OctetUSequence& key);

  static int get_poa_info(OctetUSequence& key, StringUSequence& poas_out,
                          int& transient_out, OctetUSequence& id_out);

  static void print_tagged_components(std::stringstream& sstr,
                                      IOP::MultipleComponentProfile& comps);
#endif // ORB_IS_RTORB


  bool toIOR(const char* iorstr, IOP::IOR& ior)
  {
#ifndef ORB_IS_RTORB
    if (iorstr == 0) { return false; }
    size_t size = strlen(iorstr);

    if (size < 4)
      {
        return false;
        throw CORBA::MARSHAL(0,CORBA::COMPLETED_NO);
      }

    const char* p = iorstr;

    if (p[0] != 'I' || p[1] != 'O' || p[2] != 'R' || p[3] != ':')
      {
        return false;
        throw CORBA::MARSHAL(0,CORBA::COMPLETED_NO);
      }

    // IOR:xxyyzz......
    // "IOR:" occupies 4 digits.
    // two digits express one byte, and all byte sequence express IOR profile
    size = (size - 4) / 2;  // how many octets are there in the string
    p += 4;

    cdrMemoryStream buf((CORBA::ULong)size, 0);
    for (int i(0); i < (int)size; ++i)
      {
        CORBA::Octet v;
        // upper digit
        int j(i * 2);
        if      (p[j] >= '0' && p[j] <= '9') { v = ((p[j] - '0') << 4);      }
        else if (p[j] >= 'a' && p[j] <= 'f') { v = ((p[j] - 'a' + 10) << 4); }
        else if (p[j] >= 'A' && p[j] <= 'F') { v = ((p[j] - 'A' + 10) << 4); }
        else                                 { return false;                 }
        // lower digit
        int k(j + 1);
        if      (p[k] >= '0' && p[k] <= '9') { v += (p[k] - '0');            }
        else if (p[k] >= 'a' && p[k] <= 'f') { v += (p[k] - 'a' + 10);       }
        else if (p[k] >= 'A' && p[k] <= 'F') { v += (p[k] - 'A' + 10);       }
        else                                 { return false;                 }
        // push_back to buffer
        buf.marshalOctet(v);
      }

    buf.rewindInputPtr();
    CORBA::Boolean b = buf.unmarshalBoolean();
    buf.setByteSwapFlag(b);

    ior.type_id = IOP::IOR::unmarshaltype_id(buf);
    ior.profiles <<= buf;
    return true;
#else // ORB_IS_RTORB
    // RtORB does not supports this function
    return false;
#endif // ORB_IS_RTORB
  }

  bool toString(IOP::IOR& ior, std::string& iorstr)
  {
#ifndef ORB_IS_RTORB
    cdrMemoryStream buf(CORBA::ULong(0),CORBA::Boolean(1));
    buf.marshalBoolean(omni::myByteOrder);
    buf.marshalRawString(ior.type_id);
    ior.profiles >>= buf;

    // turn the encapsulation into a hex string with "IOR:" prepended
    buf.rewindInputPtr();
    size_t s = buf.bufSize();
    CORBA::Char* data = (CORBA::Char *)buf.bufPtr();
    
    char *result = new char[4 + s * 2 + 1];
    result[4 + s * 2] = '\0';
    result[0] = 'I';
    result[1] = 'O';
    result[2] = 'R';
    result[3] = ':';

    for (int i(0); i < (int)s; ++i)
      {
        int j = 4 + i * 2;
        int v = (data[i] & 0xf0);

        v = v >> 4;
        if (v < 10)
          {
            result[j] = '0' + v;
          }
        else
          {
            result[j] = 'a' + (v - 10);
          }
        v = ((data[i] & 0xf));
        if (v < 10)
          {
            result[j+1] = '0' + v;
          }
        else
          {
            result[j+1] = 'a' + (v - 10);
          }
      }
    iorstr = result;
    delete result;
    return true;
#else // ORB_IS_RTORB
    // RtORB does not this function.
    return false;
#endif // ORB_IS_RTORB
  }

  bool replaceEndpoint(std::string& iorstr, const std::string& endpoint)
  {
#ifndef ORB_IS_RTORB
    try
      {
        IOP::IOR ior;
        toIOR(iorstr.c_str(), ior);

        for (unsigned long count(0); count < ior.profiles.length(); ++count)
          {

            if (ior.profiles[count].tag == IOP::TAG_INTERNET_IOP)
              {
                IIOP::ProfileBody pBody;
                IIOP::unmarshalProfile(ior.profiles[count], pBody);
                pBody.address.host = endpoint.c_str();

                IOP::TaggedProfile profile;
                // profile_data is cctet sequence
                IIOP::encodeProfile(pBody, profile);
                CORBA::ULong max = profile.profile_data.maximum();
                CORBA::ULong len = profile.profile_data.length();
                CORBA::Octet* buf = profile.profile_data.get_buffer(1);
                // replace is not standard function
                ior.profiles[count].profile_data.replace(max, len, buf, 1);
              }
          }
        return toString(ior, iorstr);

      }
    catch(...)
      {
        return false;
      }
#endif // ORB_IS_RTORB
    return false;
  }

  std::string formatIORinfo(const char* iorstr)
  {
    std::stringstream retstr;
#ifndef ORB_IS_RTORB
    IOP::IOR ior;
    toIOR(iorstr, ior);

    if (ior.profiles.length() == 0 && strlen(ior.type_id) == 0)
      {
        retstr << "IOR is a nil object reference." << std::endl;
        if (iorstr) { retstr << iorstr << std::endl; }
        return retstr.str();
      }

    retstr << "IOR information" << std::endl; 
    retstr << "  Type ID: \"" << (const char*) ior.type_id
           << "\"" << std::endl;;
    retstr << "  Profiles:" << std::endl;;
    for (unsigned long count=0; count < ior.profiles.length(); ++count)
      {
        retstr << "    " << count + 1 << ". ";
        if (ior.profiles[count].tag == IOP::TAG_INTERNET_IOP)
          {
            IIOP::ProfileBody pBody;
            IIOP::unmarshalProfile(ior.profiles[count], pBody);
            
            retstr << "IIOP " << (int) pBody.version.major << "."
                   << (int) pBody.version.minor << " ";
            retstr << (const char*) pBody.address.host 
                   << " " << pBody.address.port << std::endl;
            
            print_omni_key(retstr, pBody.object_key);
            print_key(retstr, pBody.object_key);
            print_tagged_components(retstr, pBody.components);
            
            retstr << std::endl;
          }
        else if (ior.profiles[count].tag == IOP::TAG_MULTIPLE_COMPONENTS)
          {
            
            retstr << "Multiple Component Profile ";
            IIOP::ProfileBody pBody;
            IIOP::unmarshalMultiComponentProfile(ior.profiles[count],
                                                 pBody.components);
            print_tagged_components(retstr, pBody.components);
            
            retstr << std::endl;
            
          }
        else
          {
            retstr << "Unrecognised profile tag: 0x"
                   << std::hex
                   << (unsigned)(ior.profiles[count].tag)
                   << std::dec
                   << std::endl;
          }
      }
#else // ORB_IS_RTORB
    retstr << "RtORB does't support formatIORinfo() function." << std::endl;
#endif // ORB_IS_RTORB
    return retstr.str();
  }


#ifndef ORB_IS_RTORB
  //------------------------------------------------------------
  // static functions

  static void print_key(std::stringstream& sstr, OctetUSequence& key)
  {
    // Output key as text
    sstr << "       Object Key: \"";
    for(unsigned int j = 0; j < key.length(); ++j)
      {
        if( (char) key[j] >= ' ' && (char) key[j] <= '~')
          {
            sstr << (char) key[j];
          }
        else
          {
            sstr << ".";
          }
      }
    sstr << "\"";

    // Output key in hexadecimal form.
    sstr << " = 0x";
    for(unsigned int j(0); j < key.length(); ++j)
      {
        int v = (key[j] & 0xf0) >> 4;
        if (v < 10) { sstr << (char)('0' + v); }
        else        { sstr << (char)('a' + (v - 10)); }
        v = key[j] & 0xf;
        if (v < 10) { sstr << (char)('0' + v); }
        else        { sstr << (char)('a' + (v - 10)); }
      }
    sstr << "  (" << key.length() << " bytes)" << std::endl;
  }

  static void print_omni_key(std::stringstream& sstr, OctetUSequence& key)
  {
    StringUSequence poas;
    int is_transient;
    OctetUSequence id;
    
    if(get_poa_info(key, poas, is_transient, id))
      {
        sstr << "       POA(" << (char*)poas[0];
        for(unsigned i(1); i < poas.length(); ++i)
          {
            sstr << '/' << (char*)poas[i];
          }
        sstr << ") ";
      }
    else
      {
        if(key.length() != sizeof(omniOrbBoaKey))
          {
            return;
          }
        sstr << "BOA ";
      }
    print_key(sstr, id);
  }
  
  static int get_poa_info(OctetUSequence& key, StringUSequence& poas_out,
                          int& transient_out, OctetUSequence& id_out)
  {
    const char* k = (const char*) key.NP_data();
    int len = key.length();
    const char* kend = k + len;
    
    poas_out.length(1);
    poas_out[0] = CORBA::string_dup("root");
    
    if(*k != TRANSIENT_SUFFIX_SEP && *k != POA_NAME_SEP) { return 0; }
    
    while(k < kend && *k == POA_NAME_SEP)
      {
        ++k;
        const char* name = k;
        
        while(k < kend && *k && *k != POA_NAME_SEP 
              && *k != TRANSIENT_SUFFIX_SEP)
          {
            ++k;
          }
        if(k == kend)  { return 0; }
    
        char* nm = new char[k - name + 1];
        memcpy(nm, name, k - name);
        nm[k - name] = '\0';
        poas_out.length(poas_out.length() + 1);
        poas_out[poas_out.length() - 1] = nm;
      }
    if(k == kend)  { return 0; }
    
    transient_out = 0;
    if(*k == TRANSIENT_SUFFIX_SEP)
      {
        transient_out = 1;
        k += TRANSIENT_SUFFIX_SIZE + 1;
      }
    if(k >= kend || *k)  { return 0; }
    k++;

    id_out.length(kend - k);
    memcpy(id_out.NP_data(), k, kend - k);

    return 1;
  }

  static void print_tagged_components(std::stringstream& sstr,
                                      IOP::MultipleComponentProfile& components)
  {
#if defined(RTM_OMNIORB_40) || defined(RTM_OMNIORB_41)
    CORBA::ULong total(components.length());
    
    for (CORBA::ULong index(0); index < total; ++index)
      {
        try
          {
            CORBA::String_var content;
            content = IOP::dumpComponent(components[index]);
            char* p = content;
            char* q;
            do
              {
                q = strchr(p,'\n');
                if (q)
                  {
                    *q++ = '\0';
                  }
                sstr << "       " << (const char*) p << std::endl;
                p = q;
              } while (q);
          }
        catch (CORBA::MARSHAL& ex)
          {
            sstr << "       Broken component" << std::endl;
          }
      }
#endif // defined(RTM_OMNIORB_40) || defined(RTM_OMNIORB_41)
  }
#endif // ORB_IS_RTORB
};