2 * Copyright 2001-2009 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
24 #include "exceptions.h"
25 #include "XMLToolingConfig.h"
26 #include "util/URLEncoder.h"
27 #include "util/XMLConstants.h"
28 #include "util/XMLHelper.h"
33 #include <xercesc/util/XMLUniDefs.hpp>
35 using namespace xmltooling;
36 using namespace xercesc;
38 using xmlconstants::XMLTOOLING_NS;
40 params::params(int count,...)
45 v.push_back(va_arg(args,char*));
49 namedparams::namedparams(int count,...)
55 v.push_back(va_arg(args,char*));
59 XMLToolingException::ExceptionFactoryMap XMLToolingException::m_factoryMap;
61 XMLToolingException* XMLToolingException::getInstance(const char* exceptionClass)
64 ExceptionFactoryMap::const_iterator i=m_factoryMap.find(exceptionClass);
65 if (i!=m_factoryMap.end())
68 return new XMLToolingException();
71 XMLToolingException::XMLToolingException(const char* msg, const params& p)
78 XMLToolingException::XMLToolingException(const char* msg, const namedparams& p)
85 XMLToolingException::XMLToolingException(const std::string& msg, const params& p) : m_msg(msg)
90 XMLToolingException::XMLToolingException(const std::string& msg, const namedparams& p) : m_msg(msg)
95 void XMLToolingException::setMessage(const char* msg)
101 m_processedmsg.erase();
104 inline const char* get_digit_character()
106 static const char s_characters[19] =
128 static const char *s_mid = s_characters + 9;
133 inline const char* unsigned_integer_to_string(char* buf, size_t cchBuf, size_t i)
135 char* psz=buf + cchBuf - 1; // Set psz to last char
136 *psz = 0; // Set terminating null
139 size_t lsd = i % 10; // Get least significant
142 i /= 10; // Prepare for next most
147 *psz = get_digit_character()[lsd]; // Place the digit
149 } while(i!=0 && psz>buf);
154 void XMLToolingException::addProperties(const params& p)
156 m_processedmsg.erase();
157 map<string,string>::size_type i=m_params.size()+1;
159 const vector<const char*>& v=p.get();
160 for (vector<const char*>::const_iterator ci=v.begin(); ci!=v.end(); ci++) {
161 m_params[unsigned_integer_to_string(buf,sizeof(buf),i++)] = *ci;
165 void XMLToolingException::addProperties(const namedparams& p)
167 m_processedmsg.erase();
168 const vector<const char*>& v=p.get();
169 for (vector<const char*>::const_iterator ci=v.begin(); ci!=v.end(); ci++) {
171 m_params[*ci] = *(ci+1);
172 ci++; // advance past name to value, then loop will advance it again
176 const char* XMLToolingException::getProperty(unsigned int index) const
179 map<string,string>::const_iterator i=m_params.find(unsigned_integer_to_string(buf,sizeof(buf),index));
180 return (i==m_params.end()) ? NULL : i->second.c_str();
183 const char* XMLToolingException::getProperty(const char* name) const
185 map<string,string>::const_iterator i=m_params.find(name);
186 return (i==m_params.end()) ? NULL : i->second.c_str();
189 const char* XMLToolingException::getMessage() const
191 if (!m_processedmsg.empty())
192 return m_processedmsg.c_str();
193 else if (m_params.empty())
194 return m_msg.c_str();
196 static const char* legal="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890_";
198 // Replace any parameters in the message.
199 string::size_type i=0,start=0;
200 while (start!=string::npos && start<m_msg.length() && (i=m_msg.find("$",start))!=string::npos) {
202 m_processedmsg += m_msg.substr(start,i-start); // append everything in between
203 start=i+1; // move start to the beginning of the token name
204 i=m_msg.find_first_not_of(legal,start); // find token delimiter
205 if (i==start) { // append a non legal character
206 m_processedmsg+=m_msg[start++];
210 // search for token in map
211 map<string,string>::const_iterator param=m_params.find(m_msg.substr(start,(i==string::npos) ? i : i-start));
212 if (param!=m_params.end()) {
213 m_processedmsg+=param->second;
217 if (start!=string::npos && start<m_msg.length())
218 m_processedmsg += m_msg.substr(start,i); // append rest of string
219 return m_processedmsg.c_str();
222 void xml_encode(string& s, const char* pre, const char* start, const char* post)
226 while (start && *start) {
227 pos = strcspn(start, "\"<>&");
229 s.append(start, pos);
234 case '\'': s += "'"; break;
235 case '<': s += "<"; break;
236 case '>': s += ">"; break;
237 case '&': s += "&"; break;
238 default: s += *start;
246 string XMLToolingException::toString() const
248 string xml=string("<exception xmlns='http://www.opensaml.org/xmltooling' type='") + getClassName() + "'>";
249 const char* msg=getMessage();
251 xml_encode(xml, "<message>", msg, "</message>");
252 const URLEncoder* encoder = XMLToolingConfig::getConfig().getURLEncoder();
253 for (map<string,string>::const_iterator i=m_params.begin(); i!=m_params.end(); i++) {
254 xml_encode(xml, "<param name='", i->first.c_str(), "'");
255 xml_encode(xml, ">", encoder->encode(i->second.c_str()).c_str(), "</param>");
261 string XMLToolingException::toQueryString() const
264 const URLEncoder* enc = XMLToolingConfig::getConfig().getURLEncoder();
265 for (map<string,string>::const_iterator i=m_params.begin(); i!=m_params.end(); i++) {
268 q = q + i->first + '=' + enc->encode(i->second.c_str());
273 XMLToolingException* XMLToolingException::fromStream(std::istream& in)
275 static const XMLCh exception[] = UNICODE_LITERAL_9(e,x,c,e,p,t,i,o,n);
276 static const XMLCh message[] = UNICODE_LITERAL_7(m,e,s,s,a,g,e);
277 static const XMLCh name[] = UNICODE_LITERAL_4(n,a,m,e);
278 static const XMLCh param[] = UNICODE_LITERAL_5(p,a,r,a,m);
279 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
281 DOMDocument* doc=XMLToolingConfig::getConfig().getParser().parse(in);
283 // Check root element.
284 const DOMElement* root=doc->getDocumentElement();
285 if (!XMLHelper::isNodeNamed(root,XMLTOOLING_NS,exception)) {
287 throw XMLToolingException("Invalid root element on serialized exception.");
290 auto_ptr_char classname(root->getAttributeNS(NULL,type));
291 auto_ptr<XMLToolingException> excep(XMLToolingException::getInstance(classname.get()));
293 DOMElement* child=XMLHelper::getFirstChildElement(root,XMLTOOLING_NS,message);
294 if (child && child->hasChildNodes()) {
295 auto_ptr_char m(child->getFirstChild()->getNodeValue());
296 excep->setMessage(m.get());
299 const URLEncoder* encoder = XMLToolingConfig::getConfig().getURLEncoder();
300 child=XMLHelper::getFirstChildElement(root,XMLTOOLING_NS,param);
301 while (child && child->hasChildNodes()) {
302 auto_ptr_char n(child->getAttributeNS(NULL,name));
303 char* encoded = XMLString::transcode(child->getFirstChild()->getNodeValue());
304 if (n.get() && encoded) {
305 encoder->decode(encoded);
306 excep->addProperty(n.get(), encoded);
308 XMLString::release(&encoded);
309 child=XMLHelper::getNextSiblingElement(child,XMLTOOLING_NS,param);
313 return excep.release();
316 XMLToolingException* XMLToolingException::fromString(const char* s)
319 return fromStream(in);