version 1.2, 2002/05/16 03:07:02
|
version 1.61, 2007/06/26 20:26:13
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
|
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation, The Open Group. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <cctype> |
|
#include <cstring> | #include <cstring> |
|
#include <iostream> |
#include "HashTable.h" | #include "HashTable.h" |
#include "CIMObjectPath.h" | #include "CIMObjectPath.h" |
#include "Indentor.h" | #include "Indentor.h" |
#include "CIMName.h" | #include "CIMName.h" |
#include "Destroyer.h" |
|
#include "XmlWriter.h" | #include "XmlWriter.h" |
#include "XmlReader.h" | #include "XmlReader.h" |
#include "Array.h" |
#include "ArrayInternal.h" |
#include "CIMOMPort.h" |
#include "HostLocator.h" |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
#define PEGASUS_ARRAY_T KeyBinding |
#define PEGASUS_ARRAY_T CIMKeyBinding |
# include "ArrayImpl.h" | # include "ArrayImpl.h" |
#undef PEGASUS_ARRAY_T | #undef PEGASUS_ARRAY_T |
| |
|
|
{ | { |
switch (str[i]) | switch (str[i]) |
{ | { |
case '\n': |
case '\\': |
result += "\\n"; |
result.append("\\\\"); |
break; |
|
|
|
case '\r': |
|
result += "\\r"; |
|
break; |
|
|
|
case '\t': |
|
result += "\\t"; |
|
break; | break; |
| |
case '"': | case '"': |
result += "\\\""; |
result.append("\\\""); |
break; | break; |
| |
default: | default: |
result += str[i]; |
result.append(str[i]); |
} | } |
} | } |
| |
return result; | return result; |
} | } |
| |
static void _BubbleSort(Array<KeyBinding>& x) |
static void _BubbleSort(Array<CIMKeyBinding>& x) |
{ | { |
Uint32 n = x.size(); | 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) | if (n < 2) |
return; | return; |
| |
|
|
{ | { |
for (Uint32 j = 0; j < n - 1; j++) | 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) |
{ | { |
KeyBinding t = x[j]; |
CIMKeyBinding t = x[j]; |
x[j] = x[j+1]; | x[j] = x[j+1]; |
x[j+1] = t; | x[j+1] = t; |
} | } |
|
|
| |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
// | // |
// KeyBinding |
// CIMKeyBinding |
// | // |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
| |
class KeyBindingRep |
class CIMKeyBindingRep |
{ | { |
public: | public: |
KeyBindingRep() |
CIMKeyBindingRep() |
{ | { |
} | } |
| |
KeyBindingRep(const KeyBindingRep& x) |
CIMKeyBindingRep(const CIMKeyBindingRep& x) |
: _name(x._name), _value(x._value), _type(x._type) | : _name(x._name), _value(x._value), _type(x._type) |
{ | { |
} | } |
| |
KeyBindingRep( |
CIMKeyBindingRep( |
const String& name, |
const CIMName& name, |
const String& value, | const String& value, |
KeyBinding::Type type) |
CIMKeyBinding::Type type) |
: _name(name), _value(value), _type(type) | : _name(name), _value(value), _type(type) |
{ | { |
} | } |
| |
~KeyBindingRep() |
~CIMKeyBindingRep() |
{ | { |
} | } |
| |
KeyBindingRep& operator=(const KeyBindingRep& x) |
CIMKeyBindingRep& operator=(const CIMKeyBindingRep& x) |
{ | { |
if (&x != this) | if (&x != this) |
{ | { |
|
|
return *this; | return *this; |
} | } |
| |
String _name; |
CIMName _name; |
String _value; | String _value; |
KeyBinding::Type _type; |
CIMKeyBinding::Type _type; |
}; | }; |
| |
| |
KeyBinding::KeyBinding() |
CIMKeyBinding::CIMKeyBinding() |
{ | { |
_rep = new KeyBindingRep(); |
_rep = new CIMKeyBindingRep(); |
} | } |
| |
KeyBinding::KeyBinding(const KeyBinding& x) |
CIMKeyBinding::CIMKeyBinding(const CIMKeyBinding& x) |
{ | { |
_rep = new KeyBindingRep(*x._rep); |
_rep = new CIMKeyBindingRep(*x._rep); |
} | } |
| |
KeyBinding::KeyBinding(const String& name, const String& value, Type type) |
CIMKeyBinding::CIMKeyBinding( |
|
const CIMName& name, |
|
const String& value, |
|
Type type) |
{ | { |
_rep = new KeyBindingRep(name, value, 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); |
} | } |
| |
KeyBinding::~KeyBinding() |
CIMKeyBinding::~CIMKeyBinding() |
{ | { |
delete _rep; | delete _rep; |
} | } |
| |
KeyBinding& KeyBinding::operator=(const KeyBinding& x) |
CIMKeyBinding& CIMKeyBinding::operator=(const CIMKeyBinding& x) |
{ | { |
*_rep = *x._rep; | *_rep = *x._rep; |
return *this; | return *this; |
} | } |
| |
const String& KeyBinding::getName() const |
const CIMName& CIMKeyBinding::getName() const |
{ | { |
return _rep->_name; | return _rep->_name; |
} | } |
| |
void KeyBinding::setName(const String& name) |
void CIMKeyBinding::setName(const CIMName& name) |
{ | { |
_rep->_name = name; | _rep->_name = name; |
} | } |
| |
const String& KeyBinding::getValue() const |
const String& CIMKeyBinding::getValue() const |
{ | { |
return _rep->_value; | return _rep->_value; |
} | } |
| |
void KeyBinding::setValue(const String& value) |
void CIMKeyBinding::setValue(const String& value) |
{ | { |
_rep->_value = value; | _rep->_value = value; |
} | } |
| |
KeyBinding::Type KeyBinding::getType() const |
CIMKeyBinding::Type CIMKeyBinding::getType() const |
{ | { |
return _rep->_type; | return _rep->_type; |
} | } |
| |
void KeyBinding::setType(KeyBinding::Type type) |
void CIMKeyBinding::setType(CIMKeyBinding::Type type) |
{ | { |
_rep->_type = type; | _rep->_type = type; |
} | } |
| |
const char* KeyBinding::typeToString(KeyBinding::Type type) |
Boolean CIMKeyBinding::equal(CIMValue value) |
{ | { |
switch (type) |
if (value.isArray()) |
{ | { |
case KeyBinding::BOOLEAN: |
return false; |
return "boolean"; |
} |
| |
case KeyBinding::STRING: |
CIMValue kbValue; |
return "string"; |
|
| |
case KeyBinding::NUMERIC: |
try |
return "numeric"; |
{ |
|
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; |
|
} |
| |
case KeyBinding::REFERENCE: |
return value.equal(kbValue); |
default: |
|
PEGASUS_ASSERT(false); |
|
} | } |
| |
return "unknown"; |
Boolean operator==(const CIMKeyBinding& x, const CIMKeyBinding& y) |
|
{ |
|
// Check that the names and types match |
|
if (!(x.getName().equal(y.getName())) || |
|
!(x.getType() == y.getType())) |
|
{ |
|
return false; |
} | } |
| |
Boolean operator==(const KeyBinding& x, const KeyBinding& y) |
switch (x.getType()) |
{ | { |
return |
case CIMKeyBinding::REFERENCE: |
CIMName::equal(x.getName(), y.getName()) && |
try |
String::equal(x.getValue(), y.getValue()) && |
{ |
x.getType() == y.getType(); |
// 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;) |
} | } |
| |
| |
|
|
| |
CIMObjectPathRep( | CIMObjectPathRep( |
const String& host, | const String& host, |
const String& nameSpace, |
const CIMNamespaceName& nameSpace, |
const String& className, |
const CIMName& className, |
const Array<KeyBinding>& keyBindings) |
const Array<CIMKeyBinding>& keyBindings) |
: _host(host), _nameSpace(nameSpace), | : _host(host), _nameSpace(nameSpace), |
_className(className), _keyBindings(keyBindings) | _className(className), _keyBindings(keyBindings) |
{ | { |
|
|
return *this; | return *this; |
} | } |
| |
|
static Boolean isValidHostname(const String& hostname) |
|
{ |
|
HostLocator addr(hostname); |
|
|
|
return addr.isValid(); |
|
} |
|
|
// | // |
// Contains port as well (e.g., myhost:1234). | // Contains port as well (e.g., myhost:1234). |
// | // |
String _host; | String _host; |
| |
String _nameSpace; |
CIMNamespaceName _nameSpace; |
String _className; |
CIMName _className; |
Array<KeyBinding> _keyBindings; |
Array<CIMKeyBinding> _keyBindings; |
}; | }; |
| |
| |
|
|
_rep = new CIMObjectPathRep(*tmpRef._rep); | _rep = new CIMObjectPathRep(*tmpRef._rep); |
} | } |
| |
CIMObjectPath::CIMObjectPath(const char* objectName) |
|
{ |
|
// Test the objectName out to see if we get an exception |
|
CIMObjectPath tmpRef; |
|
tmpRef.set(objectName); |
|
|
|
_rep = new CIMObjectPathRep(*tmpRef._rep); |
|
} |
|
|
|
CIMObjectPath::CIMObjectPath( | CIMObjectPath::CIMObjectPath( |
const String& host, | const String& host, |
const String& nameSpace, |
const CIMNamespaceName& nameSpace, |
const String& className, |
const CIMName& className, |
const Array<KeyBinding>& keyBindings) |
const Array<CIMKeyBinding>& keyBindings) |
{ | { |
// Test the objectName out to see if we get an exception | // Test the objectName out to see if we get an exception |
CIMObjectPath tmpRef; | CIMObjectPath tmpRef; |
|
|
| |
void CIMObjectPath::set( | void CIMObjectPath::set( |
const String& host, | const String& host, |
const String& nameSpace, |
const CIMNamespaceName& nameSpace, |
const String& className, |
const CIMName& className, |
const Array<KeyBinding>& keyBindings) throw(IllformedObjectName, IllegalName) |
const Array<CIMKeyBinding>& keyBindings) |
{ | { |
setHost(host); | setHost(host); |
setNameSpace(nameSpace); | setNameSpace(nameSpace); |
|
|
setKeyBindings(keyBindings); | setKeyBindings(keyBindings); |
} | } |
| |
Boolean CIMObjectPath::_parseHostElement( |
Boolean _parseHostElement( |
const String& objectName, | const String& objectName, |
char*& p, | char*& p, |
String& host) throw(IllformedObjectName) |
String& host) |
{ | { |
// See if there is a host name (true if it begins with "//"): | // 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 "/": | // and ends with "/": |
| |
if (p[0] != '/' || p[1] != '/') | if (p[0] != '/' || p[1] != '/') |
|
|
| |
p += 2; | 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 IllformedObjectName(objectName); |
|
|
|
q++; |
|
|
|
while (isalnum(*q) || *q == '-') |
|
q++; |
|
|
|
// We now expect a port (or default the port). |
|
|
|
if (*q == ':') |
|
{ | { |
q++; |
throw MalformedObjectNameException(objectName); |
// Check for a port number: |
|
|
|
if (!isdigit(*q)) |
|
throw IllformedObjectName(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); |
throw IllformedObjectName(objectName); |
|
} | } |
|
host = hostname; |
| |
p = ++q; |
// Do not step past the '/'; it will be consumed by the namespace parser |
|
p = slash; |
| |
return true; | return true; |
} | } |
| |
Boolean CIMObjectPath::_parseNamespaceElement( |
Boolean _parseNamespaceElement( |
const String& objectName, | const String& objectName, |
char*& p, | char*& p, |
String& nameSpace) |
CIMNamespaceName& nameSpace) |
{ | { |
// If we don't find a valid namespace name followed by a ':', we | // If we don't find a valid namespace name followed by a ':', we |
// assume we're not looking at a namespace name. | // assume we're not looking at a namespace name. |
| |
//---------------------------------------------------------------------- |
char* colon = strchr(p, ':'); |
// Validate the namespace path. Namespaces must match the following |
if (!colon) |
// regular expression: "[A-Za-z_]+(/[A-Za-z_]+)*" |
|
//---------------------------------------------------------------------- |
|
|
|
char* q = p; |
|
|
|
for (;;) |
|
{ | { |
// Pass the next token: |
|
|
|
if (!*q || (!isalpha(*q) && *q != '_')) |
|
return false; | return false; |
|
} |
| |
q++; |
// A ':' as part of a keybinding value should not be interpreted as |
|
// a namespace delimiter. Since keybinding pairs follow the first '.' |
while (isalnum(*q) || *q == '_') |
// in the object path string, the ':' delimiter only counts if it |
q++; |
// appears before the '.'. |
| |
if (!*q) |
char* dot = strchr(p, '.'); |
|
if (dot && (dot < colon)) |
|
{ |
return false; | return false; |
|
} |
| |
if (*q == ':') |
//---------------------------------------------------------------------- |
break; |
// Validate the namespace path. Namespaces must match the following |
|
// regular expression: "[A-Za-z_]+(/[A-Za-z_]+)*" |
|
//---------------------------------------------------------------------- |
| |
if (*q == '/') |
String namespaceName = String(p, (Uint32)(colon - p)); |
|
if (!CIMNamespaceName::legal(namespaceName)) |
{ | { |
q++; |
throw MalformedObjectNameException(objectName); |
continue; |
|
} | } |
|
nameSpace = namespaceName; |
| |
return false; |
p = colon+1; |
} |
|
|
|
nameSpace.assign(p, q - p); |
|
p = ++q; |
|
return true; | return true; |
} | } |
| |
/** | /** |
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 KeyBinding type (REFERENCE) has been defined to denote |
|
keys in a CIMObjectPath that are of reference type. This |
|
KeyBinding 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, | const String& objectName, |
char*& p, | char*& p, |
Array<KeyBinding>& keyBindings) throw(IllformedObjectName) |
Array<CIMKeyBinding>& keyBindings) |
{ | { |
// Get the key-value pairs: | // Get the key-value pairs: |
| |
|
|
{ | { |
// Get key part: | // Get key part: |
| |
char* key = strtok(p, "="); |
char* equalsign = strchr(p, '='); |
|
if (!equalsign) |
if (!key) |
|
{ | { |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
} | } |
| |
String keyString(key); |
*equalsign = 0; |
| |
if (!CIMName::legal(keyString)) |
if (!CIMName::legal(p)) |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
|
|
|
CIMName keyName (p); |
| |
// Get the value part: | // Get the value part: |
| |
String valueString; | String valueString; |
p = p + strlen(key) + 1; |
p = equalsign + 1; |
KeyBinding::Type type; |
CIMKeyBinding::Type type; |
| |
if (*p == 'R') |
if (*p == '"') |
{ | { |
p++; |
// Could be CIMKeyBinding::STRING or CIMKeyBinding::REFERENCE |
| |
type = KeyBinding::REFERENCE; |
p++; |
|
|
if (*p++ != '"') |
|
throw IllformedObjectName(objectName); |
|
| |
while (*p && *p != '"') | while (*p && *p != '"') |
{ | { |
// ATTN: need to handle special characters here: |
|
|
|
if (*p == '\\') | if (*p == '\\') |
|
{ |
*p++; | *p++; |
| |
|
if ((*p != '\\') && (*p != '"')) |
|
{ |
|
throw MalformedObjectNameException(objectName); |
|
} |
|
} |
|
|
valueString.append(*p++); | valueString.append(*p++); |
} | } |
| |
if (*p++ != '"') | if (*p++ != '"') |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
} |
|
else if (*p == '"') |
|
{ |
|
p++; |
|
| |
type = KeyBinding::STRING; |
/* |
|
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 != '"') |
try |
{ | { |
// ATTN: need to handle special characters here: |
CIMObjectPath testForPath(valueString); |
|
if (testForPath.getKeyBindings().size() > 0) |
if (*p == '\\') |
{ |
*p++; |
// We've found a reference value! |
|
type = CIMKeyBinding::REFERENCE; |
valueString.append(*p++); |
} |
|
} |
|
catch (const Exception &) |
|
{ |
|
// Not a reference value; leave type as STRING |
} | } |
|
|
if (*p++ != '"') |
|
throw IllformedObjectName(objectName); |
|
} | } |
else if (toupper(*p) == 'T' || toupper(*p) == 'F') | else if (toupper(*p) == 'T' || toupper(*p) == 'F') |
{ | { |
type = KeyBinding::BOOLEAN; |
type = CIMKeyBinding::BOOLEAN; |
| |
char* r = p; | char* r = p; |
Uint32 n = 0; | Uint32 n = 0; |
|
|
| |
if (!(((strncmp(p, "TRUE", n) == 0) && n == 4) || | if (!(((strncmp(p, "TRUE", n) == 0) && n == 4) || |
((strncmp(p, "FALSE", n) == 0) && n == 5))) | ((strncmp(p, "FALSE", n) == 0) && n == 5))) |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
| |
valueString.assign(p, n); | valueString.assign(p, n); |
| |
|
|
} | } |
else | else |
{ | { |
type = KeyBinding::NUMERIC; |
type = CIMKeyBinding::NUMERIC; |
| |
char* r = p; | char* r = p; |
Uint32 n = 0; | Uint32 n = 0; |
|
|
isComma = true; | isComma = true; |
} | } |
| |
|
if (*p == '-') |
|
{ |
Sint64 x; | Sint64 x; |
|
|
if (!XmlReader::stringToSignedInteger(p, x)) | if (!XmlReader::stringToSignedInteger(p, x)) |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
|
} |
|
else |
|
{ |
|
Uint64 x; |
|
if (!XmlReader::stringToUnsignedInteger(p, x)) |
|
throw MalformedObjectNameException(objectName); |
|
} |
| |
valueString.assign(p, n); | valueString.assign(p, n); |
| |
|
|
p = p + n; | p = p + n; |
} | } |
| |
keyBindings.append(KeyBinding(keyString, valueString, type)); |
keyBindings.append(CIMKeyBinding(keyName.getString (), valueString, |
|
type)); |
| |
if (*p) | if (*p) |
{ | { |
if (*p++ != ',') | if (*p++ != ',') |
{ | { |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
} | } |
} | } |
} | } |
|
|
_BubbleSort(keyBindings); | _BubbleSort(keyBindings); |
} | } |
| |
void CIMObjectPath::set(const String& objectName) throw(IllformedObjectName) |
void CIMObjectPath::set(const String& objectName) |
{ | { |
clear(); | clear(); |
| |
|
|
| |
// Convert to a C String first: | // Convert to a C String first: |
| |
char* p = objectName.allocateCString(1); |
CString pCString = objectName.getCString(); |
ArrayDestroyer<char> destroyer(p); |
char* p = const_cast<char*>((const char*) pCString); |
Boolean gotHost; | Boolean gotHost; |
Boolean gotNamespace; | Boolean gotNamespace; |
| |
// null terminate the C String |
|
// ATTN-RK-P3-20020301: Is the +1 correct? |
|
p[objectName.size() + 1]= '\0'; |
|
|
|
gotHost = _parseHostElement(objectName, p, _rep->_host); | gotHost = _parseHostElement(objectName, p, _rep->_host); |
gotNamespace = _parseNamespaceElement(objectName, p, _rep->_nameSpace); | gotNamespace = _parseNamespaceElement(objectName, p, _rep->_nameSpace); |
| |
if (gotHost && !gotNamespace) | if (gotHost && !gotNamespace) |
{ | { |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
} | } |
| |
// Extract the class name: | // Extract the class name: |
|
|
{ | { |
if (!CIMName::legal(p)) | if (!CIMName::legal(p)) |
{ | { |
throw IllformedObjectName(objectName); |
throw MalformedObjectNameException(objectName); |
} | } |
| |
// ATTN: remove this later: a reference should only be able to hold | // ATTN: remove this later: a reference should only be able to hold |
// an instance name. | // an instance name. |
| |
_rep->_className.assign(p); |
_rep->_className = CIMName (p); |
return; | return; |
} | } |
| |
_rep->_className.assign(p, dot - p); |
String className = String(p, (Uint32)(dot - p)); |
|
if (!CIMName::legal(className)) |
|
{ |
|
throw MalformedObjectNameException(objectName); |
|
} |
|
_rep->_className = className; |
| |
// Advance past dot: | // Advance past dot: |
| |
|
|
return *this; | return *this; |
} | } |
| |
CIMObjectPath& CIMObjectPath::operator=(const char* objectName) |
|
{ |
|
set(objectName); |
|
return *this; |
|
} |
|
|
|
const String& CIMObjectPath::getHost() const | const String& CIMObjectPath::getHost() const |
{ | { |
return _rep->_host; | return _rep->_host; |
|
|
| |
void CIMObjectPath::setHost(const String& host) | void CIMObjectPath::setHost(const String& host) |
{ | { |
|
if ((host != String::EMPTY) && !CIMObjectPathRep::isValidHostname(host)) |
|
{ |
|
throw MalformedObjectNameException(host); |
|
} |
|
|
_rep->_host = host; | _rep->_host = host; |
} | } |
| |
const String& CIMObjectPath::getNameSpace() const |
const CIMNamespaceName& CIMObjectPath::getNameSpace() const |
{ | { |
return _rep->_nameSpace; | return _rep->_nameSpace; |
} | } |
| |
void CIMObjectPath::setNameSpace(const String& nameSpace) throw(IllegalName) |
void CIMObjectPath::setNameSpace(const CIMNamespaceName& nameSpace) |
{ |
|
String temp; |
|
|
|
// check each namespace segment (delimted by '/') for correctness |
|
|
|
for(Uint32 i = 0; i < nameSpace.size(); i += temp.size() + 1) |
|
{ | { |
// isolate the segment beginning at i and ending at the first |
|
// ocurrance of '/' after i or eos |
|
|
|
temp = nameSpace.subString(i, nameSpace.subString(i).find('/')); |
|
|
|
// check segment for correctness |
|
|
|
if(!CIMName::legal(temp)) |
|
{ |
|
throw IllegalName() ; |
|
} |
|
} |
|
|
|
_rep->_nameSpace = nameSpace; | _rep->_nameSpace = nameSpace; |
} | } |
| |
const String& CIMObjectPath::getClassName() const |
const CIMName& CIMObjectPath::getClassName() const |
{ | { |
return _rep->_className; | return _rep->_className; |
} | } |
| |
const Boolean CIMObjectPath::equalClassName(const String& classname) const |
void CIMObjectPath::setClassName(const CIMName& className) |
{ | { |
return (String::equalNoCase(classname, CIMObjectPath::getClassName())); |
|
} |
|
|
|
void CIMObjectPath::setClassName(const String& className) throw(IllegalName) |
|
{ |
|
if (!CIMName::legal(className)) |
|
throw IllegalName(); |
|
|
|
_rep->_className = className; | _rep->_className = className; |
} | } |
| |
const Array<KeyBinding>& CIMObjectPath::getKeyBindings() const |
const Array<CIMKeyBinding>& CIMObjectPath::getKeyBindings() const |
{ | { |
return _rep->_keyBindings; | return _rep->_keyBindings; |
} | } |
| |
void CIMObjectPath::setKeyBindings(const Array<KeyBinding>& keyBindings) |
void CIMObjectPath::setKeyBindings(const Array<CIMKeyBinding>& keyBindings) |
{ | { |
_rep->_keyBindings = keyBindings; | _rep->_keyBindings = keyBindings; |
_BubbleSort(_rep->_keyBindings); | _BubbleSort(_rep->_keyBindings); |
} | } |
| |
String CIMObjectPath::toString(Boolean includeHost) const |
String CIMObjectPath::toString() const |
{ | { |
String objectName; | String objectName; |
| |
// Get the host: | // Get the host: |
| |
if (_rep->_host.size() && includeHost) |
if (_rep->_host.size()) |
{ | { |
objectName = "//"; | objectName = "//"; |
objectName += _rep->_host; |
objectName.append(_rep->_host); |
objectName += "/"; |
objectName.append("/"); |
} | } |
| |
// Get the namespace (if we have a host name, we must write namespace): | // Get the namespace (if we have a host name, we must write namespace): |
| |
if (_rep->_nameSpace.size() || _rep->_host.size()) |
if (!_rep->_nameSpace.isNull() || _rep->_host.size()) |
{ | { |
objectName += _rep->_nameSpace; |
objectName.append(_rep->_nameSpace.getString ()); |
objectName += ":"; |
objectName.append(":"); |
} | } |
| |
// Get the class name: | // Get the class name: |
| |
objectName.append(getClassName()); |
objectName.append(getClassName().getString ()); |
| |
if (isInstanceName()) |
// |
|
// ATTN-CAKG-P2-20020726: The following condition does not correctly |
|
// distinguish instanceNames from classNames in every case |
|
// The instanceName of a singleton instance of a keyless class has no |
|
// key bindings |
|
// |
|
if (_rep->_keyBindings.size () != 0) |
{ | { |
objectName.append('.'); | objectName.append('.'); |
| |
// Append each key-value pair: | // Append each key-value pair: |
| |
const Array<KeyBinding>& keyBindings = getKeyBindings(); |
const Array<CIMKeyBinding>& keyBindings = getKeyBindings(); |
| |
for (Uint32 i = 0, n = keyBindings.size(); i < n; i++) | for (Uint32 i = 0, n = keyBindings.size(); i < n; i++) |
{ | { |
objectName.append(keyBindings[i].getName()); |
objectName.append(keyBindings[i].getName().getString ()); |
objectName.append('='); | objectName.append('='); |
| |
const String& value = _escapeSpecialCharacters( | const String& value = _escapeSpecialCharacters( |
keyBindings[i].getValue()); | keyBindings[i].getValue()); |
| |
KeyBinding::Type type = keyBindings[i].getType(); |
CIMKeyBinding::Type type = keyBindings[i].getType(); |
|
|
if (type == KeyBinding::REFERENCE) |
|
objectName.append('R'); |
|
| |
if (type == KeyBinding::STRING || type == KeyBinding::REFERENCE) |
if (type == CIMKeyBinding::STRING || |
|
type == CIMKeyBinding::REFERENCE) |
objectName.append('"'); | objectName.append('"'); |
| |
objectName.append(value); | objectName.append(value); |
| |
if (type == KeyBinding::STRING || type == KeyBinding::REFERENCE) |
if (type == CIMKeyBinding::STRING || |
|
type == CIMKeyBinding::REFERENCE) |
objectName.append('"'); | objectName.append('"'); |
| |
if (i + 1 != n) | if (i + 1 != n) |
|
|
return objectName; | return objectName; |
} | } |
| |
String CIMObjectPath::toStringCanonical(Boolean includeHost) const |
String CIMObjectPath::_toStringCanonical() const |
{ | { |
CIMObjectPath ref = *this; | 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: |
| |
ref._rep->_className.toLower(); |
// Normalize namespace by changing to lower case |
|
if (!ref._rep->_nameSpace.isNull()) |
for (Uint32 i = 0, n = ref._rep->_keyBindings.size(); i < n; i++) |
|
{ | { |
ref._rep->_keyBindings[i]._rep->_name.toLower(); |
String nameSpaceLower = ref._rep->_nameSpace.getString(); |
|
nameSpaceLower.toLower(); // ICU_TODO: |
|
ref._rep->_nameSpace = nameSpaceLower; |
} | } |
| |
return ref.toString(includeHost); |
// 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; |
} | } |
| |
CIMObjectPath CIMObjectPath::clone() const |
for (Uint32 i = 0, n = ref._rep->_keyBindings.size(); i < n; i++) |
|
{ |
|
// Normalize key binding name by changing to lower case |
|
if (!ref._rep->_keyBindings[i]._rep->_name.isNull()) |
{ | { |
return CIMObjectPath(*this); |
String keyBindingNameLower = |
|
ref._rep->_keyBindings[i]._rep->_name.getString(); |
|
keyBindingNameLower.toLower(); // ICU_TODO: |
|
ref._rep->_keyBindings[i]._rep->_name = keyBindingNameLower; |
} | } |
| |
Boolean CIMObjectPath::identical(const CIMObjectPath& x) const |
// Normalize the key value |
|
switch (ref._rep->_keyBindings[i]._rep->_type) |
{ | { |
return |
case CIMKeyBinding::REFERENCE: |
String::equal(_rep->_host, x._rep->_host) && |
try |
CIMName::equal(_rep->_nameSpace, x._rep->_nameSpace) && |
{ |
CIMName::equal(_rep->_className, x._rep->_className) && |
// Convert reference to CIMObjectPath and recurse |
_rep->_keyBindings == x._rep->_keyBindings; |
ref._rep->_keyBindings[i]._rep->_value = |
|
CIMObjectPath(ref._rep->_keyBindings[i]._rep->_value). |
|
_toStringCanonical(); |
} | } |
|
catch (Exception&) |
Uint32 CIMObjectPath::makeHashCode() const |
|
{ | { |
return HashFunc<String>::hash(toStringCanonical()); |
// 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; |
|
} |
} | } |
| |
Boolean CIMObjectPath::isInstanceName() const |
// Note: key bindings are sorted when set in the CIMObjectPath |
{ |
|
return _rep->_keyBindings.size() != 0; |
return ref.toString(); |
} | } |
| |
KeyBindingArray CIMObjectPath::getKeyBindingArray() |
Boolean CIMObjectPath::identical(const CIMObjectPath& x) const |
{ | { |
return KeyBindingArray(); |
return |
|
String::equalNoCase(_rep->_host, x._rep->_host) && |
|
_rep->_nameSpace.equal(x._rep->_nameSpace) && |
|
_rep->_className.equal(x._rep->_className) && |
|
_rep->_keyBindings == x._rep->_keyBindings; |
} | } |
| |
|
Uint32 CIMObjectPath::makeHashCode() const |
|
{ |
|
return HashFunc<String>::hash(_toStringCanonical()); |
|
} |
| |
Boolean operator==(const CIMObjectPath& x, const CIMObjectPath& y) | Boolean operator==(const CIMObjectPath& x, const CIMObjectPath& y) |
{ | { |
|
|
return !operator==(x, y); | return !operator==(x, y); |
} | } |
| |
PEGASUS_STD(ostream)& operator<<( |
|
PEGASUS_STD(ostream)& os, |
|
const CIMObjectPath& x) |
|
{ |
|
return os << x.toString(); |
|
} |
|
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |