pegasus/src/Pegasus/Common/CIMObjectPath.cpp - diff

Return to CIMObjectPath.cpp CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMObjectPath.cpp between version 1.16 and 1.58.4.4

version 1.16, 2002/09/12 17:27:01

version 1.58.4.4, 2008/02/19 22:09:39

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%2006////////////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to

Line 21

Line 29

//==============================================================================

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)

// Carol Ann Krug Graves, Hewlett-Packard Company

// (carolann_graves@hp.com)

//%/////////////////////////////////////////////////////////////////////////////

#include <Pegasus/Common/Config.h>

#include <cctype>

#include <cstring>

#include <iostream>

#include "HashTable.h"

#include "CIMObjectPath.h"

#include "Indentor.h"

#include "CIMName.h"

#include "Destroyer.h"

#include "XmlWriter.h"

#include "XmlReader.h"

#include "ArrayInternal.h"

#include "CIMOMPort.h"

#include "HostLocator.h"

PEGASUS_NAMESPACE_BEGIN

Line 76

Line 77

{

switch (str[i])

{

case '\n':

case '\\':

result.append("\\n");

result.append("\\\\");

break;

case '\r':

result.append("\\r");

break;

case '\t':

result.append("\\t");

break;

case '"':

Line 104

Line 97

{

Uint32 n = x.size();

// If the key is a reference, the keys in the reference must also be

// sorted

for (Uint32 k = 0; k < n ; k++)

if (x[k].getType () == CIMKeyBinding::REFERENCE)

{

CIMObjectPath tmp (x[k].getValue ());

Array <CIMKeyBinding> keyBindings = tmp.getKeyBindings ();

_BubbleSort (keyBindings);

tmp.setKeyBindings (keyBindings);

x[k].setValue (tmp.toString ());

}

if (n < 2)

return;

Line 111

Line 118

{

for (Uint32 j = 0; j < n - 1; j++)

{

if (String::compareNoCase(x[j].getName(), x[j+1].getName()) > 0)

if (String::compareNoCase(x[j].getName().getString(),

x[j+1].getName().getString()) > 0)

{

CIMKeyBinding t = x[j];

x[j] = x[j+1];

Line 178

Line 186

_rep = new CIMKeyBindingRep(*x._rep);

}

CIMKeyBinding::CIMKeyBinding(const CIMName& name, const String& value, Type type)

CIMKeyBinding::CIMKeyBinding(

const CIMName& name,

const String& value,

Type type)

{

_rep = new CIMKeyBindingRep(name, value, type);

}

CIMKeyBinding::CIMKeyBinding(const CIMName& name, const CIMValue& value)

{

if (value.isArray())

{

throw TypeMismatchException();

}

String kbValue = value.toString();

Type kbType;

switch (value.getType())

{

case CIMTYPE_BOOLEAN:

kbType = BOOLEAN;

break;

case CIMTYPE_CHAR16:

case CIMTYPE_STRING:

case CIMTYPE_DATETIME:

kbType = STRING;

break;

case CIMTYPE_REFERENCE:

kbType = REFERENCE;

break;

// case CIMTYPE_REAL32:

// case CIMTYPE_REAL64:

case CIMTYPE_OBJECT:

#ifdef PEGASUS_EMBEDDED_INSTANCE_SUPPORT

case CIMTYPE_INSTANCE:

#endif // PEGASUS_EMBEDDED_INSTANCE_SUPPORT

// From PEP 194: EmbeddedObjects cannot be keys.

throw TypeMismatchException();

break;

default:

kbType = NUMERIC;

break;

}

_rep = new CIMKeyBindingRep(name, kbValue, kbType);

}

CIMKeyBinding::~CIMKeyBinding()

{

delete _rep;

Line 224

Line 275

_rep->_type = type;

}

Boolean CIMKeyBinding::equal(CIMValue value)

{

if (value.isArray())

{

return false;

}

CIMValue kbValue;

try

{

switch (value.getType())

{

case CIMTYPE_CHAR16:

if (getType() != STRING) return false;

kbValue.set(getValue()[0]);

break;

case CIMTYPE_DATETIME:

if (getType() != STRING) return false;

kbValue.set(CIMDateTime(getValue()));

break;

case CIMTYPE_STRING:

if (getType() != STRING) return false;

kbValue.set(getValue());

break;

case CIMTYPE_REFERENCE:

if (getType() != REFERENCE) return false;

kbValue.set(CIMObjectPath(getValue()));

break;

case CIMTYPE_BOOLEAN:

if (getType() != BOOLEAN) return false;

kbValue = XmlReader::stringToValue(0, getValue().getCString(),

value.getType());

break;

// case CIMTYPE_REAL32:

// case CIMTYPE_REAL64:

case CIMTYPE_OBJECT:

#ifdef PEGASUS_EMBEDDED_INSTANCE_SUPPORT

case CIMTYPE_INSTANCE:

#endif // PEGASUS_EMBEDDED_INSTANCE_SUPPORT

// From PEP 194: EmbeddedObjects cannot be keys.

return false;

break;

default: // Numerics

if (getType() != NUMERIC) return false;

kbValue = XmlReader::stringToValue(0, getValue().getCString(),

value.getType());

break;

}

catch (Exception&)

{

return false;

}

return value.equal(kbValue);

}

Boolean operator==(const CIMKeyBinding& x, const CIMKeyBinding& y)

{

return

// Check that the names and types match

x.getName().equal(y.getName()) &&

if (!(x.getName().equal(y.getName())) ||

String::equal(x.getValue(), y.getValue()) &&

!(x.getType() == y.getType()))

x.getType() == y.getType();

{

return false;

}

switch (x.getType())

{

case CIMKeyBinding::REFERENCE:

try

{

// References should be compared as CIMObjectPaths

return (CIMObjectPath(x.getValue()) == CIMObjectPath(y.getValue()));

}

catch (Exception&)

{

// If CIMObjectPath parsing fails, just compare strings

return String::equal(x.getValue(), y.getValue());

}

break;

case CIMKeyBinding::BOOLEAN:

// Case-insensitive comparison is sufficient for booleans

return String::equalNoCase(x.getValue(), y.getValue());

break;

case CIMKeyBinding::NUMERIC:

// Note: This comparison assumes XML syntax for integers

// First try comparing as unsigned integers

{

Uint64 xValue;

Uint64 yValue;

if (XmlReader::stringToUnsignedInteger(

x.getValue().getCString(), xValue) &&

XmlReader::stringToUnsignedInteger(

y.getValue().getCString(), yValue))

{

return (xValue == yValue);

}

// Next try comparing as signed integers

{

Sint64 xValue;

Sint64 yValue;

if (XmlReader::stringToSignedInteger(

x.getValue().getCString(), xValue) &&

XmlReader::stringToSignedInteger(

y.getValue().getCString(), yValue))

{

return (xValue == yValue);

}

// Note: Keys may not be real values, so don't try comparing as reals

// We couldn't parse the numbers, so just compare the strings

return String::equal(x.getValue(), y.getValue());

break;

default: // CIMKeyBinding::STRING

return String::equal(x.getValue(), y.getValue());

break;

}

PEGASUS_UNREACHABLE(return false;)

}

Line 278

Line 444

return *this;

}

static Boolean isValidHostname(const String& hostname)

{

HostLocator addr(hostname);

return addr.isValid();

}

// Contains port as well (e.g., myhost:1234).

Line 352

Line 525

setKeyBindings(keyBindings);

}

Boolean CIMObjectPath::_parseHostElement(

Boolean _parseHostElement(

const String& objectName,

char*& p,

String& host)

{

// See if there is a host name (true if it begins with "//"):

// Host is of the from <hostname>-<port> and begins with "//"

// Host is of the form <hostname>:<port> and begins with "//"

// and ends with "/":

if (p[0] != '/' || p[1] != '/')

Line 368

Line 541

p += 2;

//----------------------------------------------------------------------

char* slash = strchr(p, '/');

// Validate the hostname. Hostnames must match the following

if (!slash)

// regular expression: "[A-Za-z][A-Za-z0-9-]*"

//----------------------------------------------------------------------

char* q = p;

if (!isalpha(*q))

throw MalformedObjectNameException(objectName);

q++;

while (isalnum(*q) || *q == '-')

q++;

// We now expect a port (or default the port).

if (*q == ':')

{

q++;

// Check for a port number:

if (!isdigit(*q))

throw MalformedObjectNameException(objectName);

while (isdigit(*q))

q++;

// Finally, assign the host name:

host.assign(p, q - p);

}

else

{

host.assign(p, q - p);

// Assign the default port number:

host.append(":");

host.append(PEGASUS_CIMOM_DEFAULT_PORT_STRING);

}

// Check for slash terminating the entire sequence:

String hostname = String(p, (Uint32)(slash - p));

if (!CIMObjectPathRep::isValidHostname(hostname))

if (*q != '/')

{

host.clear();

throw MalformedObjectNameException(objectName);

}

host = hostname;

p = ++q;

// Do not step past the '/'; it will be consumed by the namespace parser

p = slash;

return true;

}

Boolean CIMObjectPath::_parseNamespaceElement(

Boolean _parseNamespaceElement(

const String& objectName,

char*& p,

CIMNamespaceName& nameSpace)

Line 437

Line 574

return false;

}

// A ':' as part of a keybinding value should not be interpreted as

// a namespace delimiter. Since keybinding pairs follow the first '.'

// in the object path string, the ':' delimiter only counts if it

// appears before the '.'.

char* dot = strchr(p, '.');

if (dot && (dot < colon))

{

return false;

}

//----------------------------------------------------------------------

// Validate the namespace path. Namespaces must match the following

// regular expression: "[A-Za-z_]+(/[A-Za-z_]+)*"

//----------------------------------------------------------------------

String namespaceName = String(p, colon - p);

String namespaceName = String(p, (Uint32)(colon - p));

if (!CIMNamespaceName::legal(namespaceName))

{

throw MalformedObjectNameException(objectName);

Line 454

Line 602

}

/**

ATTN: RK - Association classes have keys whose types are

ATTN-RK: The DMTF specification for the string form of an

references. These reference values must be treated specially

object path makes it impossible for a parser to distinguish

in the XML encoding, using the VALUE.REFERENCE tag structure.

between a key values of String type and Reference type.

Pegasus had been passing reference values simply as String

Given the ambiguity, this implementation takes a guess at the

values. For example, EnumerateInstanceNames returned

type of a quoted key value. If the value can be parsed into

KEYVALUEs of string type rather than VALUE.REFERENCEs.

a CIMObjectPath with at least one key binding, the type is

set to REFERENCE. Otherwise, the type is set to STRING.

I've modified the XmlReader::getKeyBindingElement() and

Note: This algorithm appears to be in line with what the Sun

XmlWriter::appendInstanceNameElement() methods to read and write

WBEM Services implementation does.

the XML in the proper format. However, making that change

required that a CIMObjectPath object be able to distinguish

To be totally correct, it would be necessary to retrieve the

between a key of String type and a key of reference type.

class definition and look up the types of the key properties

to determine how to interpret the key values. This is clearly

I've modified the String format of CIMObjectPaths slightly to

too inefficient for internal transformations between

allow efficient processing of references whose keys are also

CIMObjectPaths and String values.

of reference type. The "official" form uses the same

encoding for key values of String type and of reference type,

and so it would be necessary to retrieve the class definition

and look up the types of the key properties to determine how

to treat the key values. This is clearly too inefficient for

internal transformations between CIMObjectPaths and String

values.

The workaround is to encode a 'R' at the beginning of the

value for a key of reference type (before the opening '"').

This allows the parser to know a priori whether the key is of

String or reference type.

In this example:

MyClass.Key1="StringValue",Key2=R"RefClass.KeyA="StringA",KeyB=10"

Property Key1 of class MyClass is of String type, and so it

gets the usual encoding. Key2 is a reference property, so

the extra 'R' is inserted before its encoded value. Note

that this algorithm is recursive, such that RefClass could

include KeyC of reference type, which would also get encoded

with the 'R' notation.

The toString() method inserts the 'R' to provide symmetry. A

new CIMKeyBinding type (REFERENCE) has been defined to denote

keys in a CIMObjectPath that are of reference type. This

CIMKeyBinding type must be used appropriately for

CIMObjectPath::toString() to behave correctly.

A result of this change is that instances names in the

instance repository will include this extra 'R' character.

Note that for user-facing uses of the String encoding of

instance names (such as might appear in MOF for static

association instances or in the CGI client), this solution

is non-standard and therefore unacceptable. It is likely

that these points will need to process the more expensive

operation of retrieving the class definition to determine

the key property types.

void CIMObjectPath::_parseKeyBindingPairs(

void _parseKeyBindingPairs(

const String& objectName,

char*& p,

Array<CIMKeyBinding>& keyBindings)

Line 528

Line 637

}

*equalsign = 0;

CIMName keyString(p);

if (!CIMName::legal(keyString))

if (!CIMName::legal(p))

throw MalformedObjectNameException(objectName);

CIMName keyName (p);

// Get the value part:

String valueString;

p = equalsign + 1;

CIMKeyBinding::Type type;

if (*p == 'R')

if (*p == '"')

{

p++;

// Could be CIMKeyBinding::STRING or CIMKeyBinding::REFERENCE

type = CIMKeyBinding::REFERENCE;

p++;

if (*p++ != '"')

Array<Uint8> keyValueUTF8;

throw MalformedObjectNameException(objectName);

keyValueUTF8.reserveCapacity(128);

while (*p && *p != '"')

{

// ATTN: need to handle special characters here:

if (*p == '\\')

*p++;

{

p++;

if ((*p != '\\') && (*p != '"'))

{

throw MalformedObjectNameException(objectName);

}

valueString.append(*p++);

keyValueUTF8.append(*p++);

}

if (*p++ != '"')

throw MalformedObjectNameException(objectName);

}

else if (*p == '"')

{

p++;

// Convert the UTF-8 value to a UTF-16 String

valueString.assign(

(const char*)keyValueUTF8.getData(),

keyValueUTF8.size());

Guess at the type of this quoted key value. If the value

can be parsed into a CIMObjectPath with at least one key

binding, the type is assumed to be a REFERENCE. Otherwise,

the type is set to STRING. (See method header for details.)

type = CIMKeyBinding::STRING;

while (*p && *p != '"')

/* Performance shortcut will check for

equal sign instead of doing the full

CIMObjectPath creation and exception handling

keyValueUTF8.append('\0');

if (strchr((const char*)keyValueUTF8.getData(), '='))

{

// ATTN: need to handle special characters here:

// found an equal sign, high probability for a reference

try

if (*p == '\\')

{

*p++;

CIMObjectPath testForPath(valueString);

if (testForPath.getKeyBindings().size() > 0)

valueString.append(*p++);

{

// We've found a reference value!

type = CIMKeyBinding::REFERENCE;

}

catch (const Exception &)

{

// Not a reference value; leave type as STRING

}

if (*p++ != '"')

throw MalformedObjectNameException(objectName);

}

else if (toupper(*p) == 'T' || toupper(*p) == 'F')

{

Line 622

Line 755

isComma = true;

}

if (*p == '-')

{

Sint64 x;

if (!XmlReader::stringToSignedInteger(p, x))

throw MalformedObjectNameException(objectName);

}

else

{

Uint64 x;

if (!XmlReader::stringToUnsignedInteger(p, x))

throw MalformedObjectNameException(objectName);

}

valueString.assign(p, n);

Line 637

Line 778

p = p + n;

}

keyBindings.append(CIMKeyBinding(keyString, valueString, type));

keyBindings.append(CIMKeyBinding(keyName.getString (), valueString,

type));

if (*p)

{

Line 664

Line 806

// Convert to a C String first:

char* p = strdup(objectName.getCString());

CString pCString = objectName.getCString();

Destroyer<char> destroyer(p);

char* p = const_cast<char*>((const char*) pCString);

Boolean gotHost;

Boolean gotNamespace;

Line 691

Line 833

// ATTN: remove this later: a reference should only be able to hold

// an instance name.

_rep->_className = p;

_rep->_className = CIMName (p);

return;

}

String className = String(p, dot - p);

String className = String(p, (Uint32)(dot - p));

if (!CIMName::legal(className))

{

throw MalformedObjectNameException(objectName);

Line 722

Line 864

void CIMObjectPath::setHost(const String& host)

{

if ((host != String::EMPTY) && !CIMObjectPathRep::isValidHostname(host))

{

throw MalformedObjectNameException(host);

}

_rep->_host = host;

}

Line 773

Line 920

if (!_rep->_nameSpace.isNull() || _rep->_host.size())

{

objectName.append(_rep->_nameSpace);

objectName.append(_rep->_nameSpace.getString ());

objectName.append(":");

}

// Get the class name:

objectName.append(getClassName());

objectName.append(getClassName().getString ());

// ATTN-CAKG-P2-20020726: The following condition does not correctly

Line 797

Line 944

for (Uint32 i = 0, n = keyBindings.size(); i < n; i++)

{

objectName.append(keyBindings[i].getName());

objectName.append(keyBindings[i].getName().getString ());

objectName.append('=');

const String& value = _escapeSpecialCharacters(

Line 805

Line 952

CIMKeyBinding::Type type = keyBindings[i].getType();

if (type == CIMKeyBinding::REFERENCE)

if (type == CIMKeyBinding::STRING ||

objectName.append('R');

type == CIMKeyBinding::REFERENCE)

if (type == CIMKeyBinding::STRING || type == CIMKeyBinding::REFERENCE)

objectName.append('"');

objectName.append(value);

if (type == CIMKeyBinding::STRING || type == CIMKeyBinding::REFERENCE)

if (type == CIMKeyBinding::STRING ||

type == CIMKeyBinding::REFERENCE)

objectName.append('"');

if (i + 1 != n)

Line 828

Line 974

{

CIMObjectPath ref = *this;

// ATTN-RK-P2-20020510: Need to make hostname and namespace lower case?

// Normalize hostname by changing to lower case

ref._rep->_host.toLower(); // ICU_TODO:

String classNameLower = ref._rep->_className;

// Normalize namespace by changing to lower case

classNameLower.toLower();

if (!ref._rep->_nameSpace.isNull())

{

String nameSpaceLower = ref._rep->_nameSpace.getString();

nameSpaceLower.toLower(); // ICU_TODO:

ref._rep->_nameSpace = nameSpaceLower;

}

// Normalize class name by changing to lower case

if (!ref._rep->_className.isNull())

{

String classNameLower = ref._rep->_className.getString();

classNameLower.toLower(); // ICU_TODO:

ref._rep->_className = classNameLower;

}

for (Uint32 i = 0, n = ref._rep->_keyBindings.size(); i < n; i++)

{

String keyBindingNameLower = ref._rep->_keyBindings[i]._rep->_name;

// Normalize key binding name by changing to lower case

keyBindingNameLower.toLower();

if (!ref._rep->_keyBindings[i]._rep->_name.isNull())

{

String keyBindingNameLower =

ref._rep->_keyBindings[i]._rep->_name.getString();

keyBindingNameLower.toLower(); // ICU_TODO:

ref._rep->_keyBindings[i]._rep->_name = keyBindingNameLower;

}

// ATTN-RK-20020826: Need to sort keys?

// Normalize the key value

switch (ref._rep->_keyBindings[i]._rep->_type)

{

case CIMKeyBinding::REFERENCE:

try

{

// Convert reference to CIMObjectPath and recurse

ref._rep->_keyBindings[i]._rep->_value =

CIMObjectPath(ref._rep->_keyBindings[i]._rep->_value).

_toStringCanonical();

}

catch (Exception&)

{

// Leave value unchanged if the CIMObjectPath parsing fails

}

break;

case CIMKeyBinding::BOOLEAN:

// Normalize the boolean string by changing to lower case

ref._rep->_keyBindings[i]._rep->_value.toLower(); // ICU_TODO:

break;

case CIMKeyBinding::NUMERIC:

// Normalize the numeric string by converting to integer and back

Uint64 uValue;

Sint64 sValue;

// First try converting to unsigned integer

if (XmlReader::stringToUnsignedInteger(

ref._rep->_keyBindings[i]._rep->_value.getCString(),

uValue))

{

char buffer[32]; // Should need 21 chars max

sprintf(buffer, "%" PEGASUS_64BIT_CONVERSION_WIDTH "u", uValue);

ref._rep->_keyBindings[i]._rep->_value = String(buffer);

}

// Next try converting to signed integer

else if (XmlReader::stringToSignedInteger(

ref._rep->_keyBindings[i]._rep->_value.getCString(),

sValue))

{

char buffer[32]; // Should need 21 chars max

sprintf(buffer, "%" PEGASUS_64BIT_CONVERSION_WIDTH "d", sValue);

ref._rep->_keyBindings[i]._rep->_value = String(buffer);

}

// Leave value unchanged if it cannot be converted to an integer

break;

default: // CIMKeyBinding::STRING

// No normalization required for STRING

break;

}

// Note: key bindings are sorted when set in the CIMObjectPath

return ref.toString();

}

Line 849

Line 1062

Boolean CIMObjectPath::identical(const CIMObjectPath& x) const

{

return

String::equal(_rep->_host, x._rep->_host) &&

String::equalNoCase(_rep->_host, x._rep->_host) &&

_rep->_nameSpace.equal(x._rep->_nameSpace) &&

_rep->_className.equal(x._rep->_className) &&

_rep->_keyBindings == x._rep->_keyBindings;

Line 870

Line 1083

return !operator==(x, y);

}

PEGASUS_STD(ostream)& operator<<(

PEGASUS_STD(ostream)& os,

const CIMObjectPath& x)

{

return os << x.toString();

}

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.16
changed lines
	Added in v.1.58.4.4

No CVS admin address has been configured