introduced base_message class as a base for basic_openid_message

Signed-off-by: Michael Krelin <hacker@klever.net>

3 files changed, 73 insertions, 65 deletions

diff --git a/include/opkele/types.h b/include/opkele/types.h
index ffb9afb..64f165c 100644
--- a/include/opkele/types.h
+++ b/include/opkele/types.h
@@ -1,234 +1,248 @@
 #ifndef __OPKELE_TYPES_H
 #define __OPKELE_TYPES_H
 
 /**
  * @file
  * @brief various types declarations
  */
 
 #include <cstring>
 #include <ostream>
 #include <vector>
 #include <string>
 #include <map>
 #include <set>
 #include <list>
 #include <opkele/iterator.h>
 #include <opkele/tr1-mem.h>
 
 namespace opkele {
     using std::vector;
     using std::string;
     using std::map;
     using std::ostream;
     using std::multimap;
     using std::set;
     using std::list;
     using std::iterator;
     using std::forward_iterator_tag;
 
     /**
      * the OpenID operation mode
      */
     typedef enum _mode_t {
         mode_unknown = 0,
         mode_associate,
         mode_checkid_immediate,
         mode_checkid_setup,
         mode_check_association
     } mode_t;
 
     /**
      * the association secret container
      */
     class secret_t : public vector<unsigned char> {
         public:
 
             /**
              * xor the secret and hmac together and encode, using base64
              * @param key_d pointer to the message digest
              * @param rv reference to the return value
              */
             void enxor_to_base64(const unsigned char *key_d,string& rv) const;
             /**
              * decode base64-encoded secret and xor it with the message digest
              * @param key_d pointer to the message digest
              * @param b64 base64-encoded secret value
              */
             void enxor_from_base64(const unsigned char *key_d,const string& b64);
             /**
              * plainly encode to base64 representation
              * @param rv reference to the return value
              */
             void to_base64(string& rv) const;
             /**
              * decode cleartext secret from base64
              * @param b64 base64-encoded representation of the secret value
              */
             void from_base64(const string& b64);
     };
 
     /**
      * Interface to the association.
      */
     class association_t {
         public:
 
             virtual ~association_t() { }
 
             /**
              * retrieve the server with which association was established.
              * @return server name
              */
             virtual string server() const = 0;
             /**
              * retrieve the association handle.
              * @return handle
              */
             virtual string handle() const = 0;
             /**
              * retrieve the association type.
              * @return association type
              */
             virtual string assoc_type() const = 0;
             /**
              * retrieve the association secret.
              * @return association secret
              */
             virtual secret_t secret() const = 0; 
             /**
              * retrieve the number of seconds the association expires in.
              * @return seconds till expiration
              */
             virtual int expires_in() const = 0;
             /**
              * check whether the association is stateless.
              * @return true if stateless
              */
             virtual bool stateless() const = 0;
             /**
              * check whether the association is expired.
              * @return true if expired
              */
             virtual bool is_expired() const = 0;
     };
 
     /**
      * the shared_ptr<> for association_t object type
      */
     typedef tr1mem::shared_ptr<association_t> assoc_t;
 
-    class basic_openid_message {
+    class basic_message {
         public:
             typedef list<string> fields_t;
             typedef util::forward_iterator_proxy<
                 string,const string&,const string*
                 > fields_iterator;
 
-            basic_openid_message() { }
-            virtual ~basic_openid_message() { }
-            basic_openid_message(const basic_openid_message& x);
-            void copy_to(basic_openid_message& x) const;
-            void append_to(basic_openid_message& x) const;
+            basic_message() { }
+            virtual ~basic_message() { }
+            basic_message(const basic_message& x);
+            void copy_to(basic_message& x) const;
+            void append_to(basic_message& x) const;
 
             virtual bool has_field(const string& n) const = 0;
             virtual const string& get_field(const string& n) const = 0;
 
-            virtual bool has_ns(const string& uri) const;
-            virtual string get_ns(const string& uri) const;
-
             virtual fields_iterator fields_begin() const = 0;
             virtual fields_iterator fields_end() const = 0;
 
-            virtual string append_query(const string& url,const char *pfx="openid.") const;
-            virtual string query_string(const char *pfx="openid.") const;
-
+            virtual string append_query(const string& url,const char *pfx=0) const;
+            virtual string query_string(const char *pfx=0) const;
 
             virtual void reset_fields();
             virtual void set_field(const string& n,const string& v);
             virtual void reset_field(const string& n);
 
+    };
+
+    class basic_openid_message : public basic_message {
+        public:
+            typedef list<string> fields_t;
+            typedef util::forward_iterator_proxy<
+                string,const string&,const string*
+                > fields_iterator;
+
+            basic_openid_message() { }
+            basic_openid_message(const basic_openid_message& x);
+
+            virtual bool has_ns(const string& uri) const;
+            virtual string get_ns(const string& uri) const;
+
+            virtual string append_query(const string& url,const char *pfx="openid.") const {
+                return basic_message::append_query(url,pfx); }
+            virtual string query_string(const char *pfx="openid.") const {
+                return basic_message::query_string(pfx); }
+
             virtual void from_keyvalues(const string& kv);
             virtual void to_keyvalues(ostream& o) const;
 
             virtual void to_htmlhiddens(ostream& o,const char* pfx=0) const;
 
             void add_to_signed(const string& fields);
             string find_ns(const string& uri,const char *pfx) const;
             string allocate_ns(const string& uri,const char *pfx);
     };
 
     class openid_message_t : public basic_openid_message, public map<string,string> {
         public:
             openid_message_t() { }
             openid_message_t(const basic_openid_message& x)
                 : basic_openid_message(x) { }
 
-            void copy_to(basic_openid_message& x) const;
-
             bool has_field(const string& n) const;
             const string& get_field(const string& n) const;
             virtual fields_iterator fields_begin() const;
             virtual fields_iterator fields_end() const;
 
             void reset_fields();
             void set_field(const string& n,const string& v);
             void reset_field(const string& n);
     };
 
     /**
      * request/response parameters map
      */
     class params_t : public openid_message_t {
         public:
 
             /**
              * check whether the parameter is present.
              * @param n the parameter name
              * @return true if yes
              */
             bool has_param(const string& n) const {
                 return has_field(n); }
             /**
              * retrieve the parameter (const version)
              * @param n the parameter name
              * @return the parameter value
              * @throw failed_lookup if there is no such parameter
              */
             const string& get_param(const string& n) const {
                 return get_field(n); }
 
             /**
              * parse the OpenID key/value data.
              * @param kv the OpenID key/value data
              */
             void parse_keyvalues(const string& kv) {
                 from_keyvalues(kv); }
 
             string append_query(const string& url,const char *prefix="openid.") const;
 
     };
 
     struct openid_endpoint_t {
         string uri;
         string claimed_id;
         string local_id;
 
         openid_endpoint_t() { }
         openid_endpoint_t(const string& u,const string& cid,const string& lid)
             : uri(u), claimed_id(cid), local_id(lid) { }
 
         bool operator==(const openid_endpoint_t& x) const {
             return uri==x.uri && local_id==x.local_id; }
         bool operator<(const openid_endpoint_t& x) const {
             int c;
             return (c=strcmp(uri.c_str(),x.uri.c_str()))
                 ? (c<0) : (strcmp(local_id.c_str(),x.local_id.c_str())<0); }
     };
 
     typedef util::output_iterator_proxy<openid_endpoint_t>
         openid_endpoint_output_iterator;
 
 }
 
 #endif /* __OPKELE_TYPES_H */
diff --git a/lib/Makefile.am b/lib/Makefile.am
index e8bfbf5..9b25b42 100644
--- a/lib/Makefile.am
+++ b/lib/Makefile.am
@@ -1,34 +1,34 @@
 lib_LTLIBRARIES = libopkele.la
 
 AM_CPPFLAGS = ${CPPFLAGS_DEBUG}
 DEFAULT_INCLUDES = -I${top_builddir}
 INCLUDES = \
            -I${top_builddir}/include/ -I${top_srcdir}/include/ \
            ${KONFORKA_CFLAGS} \
            ${OPENSSL_CFLAGS} \
            ${LIBCURL_CPPFLAGS} \
            ${PCRE_CFLAGS} ${EXPAT_CFLAGS} ${TIDY_CFLAGS}
 libopkele_la_LIBADD = \
         ${LIBCURL} \
         ${PCRE_LIBS} ${EXPAT_LIBS} \
         ${OPENSSL_LIBS} \
         ${KONFORKA_LIBS} ${TIDY_LIBS}
 
 libopkele_la_SOURCES = \
                        params.cc \
                        util.cc \
                        server.cc \
                        secret.cc \
                        data.cc \
                        consumer.cc \
                        exception.cc \
                        extension.cc \
                        sreg.cc \
                        extension_chain.cc \
                        curl.cc expat.cc \
                        discovery.cc \
                        basic_rp.cc prequeue_rp.cc \
-                       openid_message.cc \
+                       message.cc \
                        basic_op.cc verify_op.cc
 libopkele_la_LDFLAGS = \
         -version-info 2:0:0
diff --git a/lib/openid_message.cc b/lib/message.cc
index e244f43..78f20f4 100644
--- a/lib/openid_message.cc
+++ b/lib/message.cc
@@ -1,276 +1,270 @@
 #include <cassert>
 #include <opkele/types.h>
 #include <opkele/exception.h>
 #include <opkele/util.h>
 #include <opkele/debug.h>
 
 #include "config.h"
 
 namespace opkele {
     using std::input_iterator_tag;
     using std::unary_function;
 
     struct __om_copier : public unary_function<const string&,void> {
         public:
-            const basic_openid_message& from;
-            basic_openid_message& to;
+            const basic_message& from;
+            basic_message& to;
 
-            __om_copier(basic_openid_message& t,const basic_openid_message& f)
+            __om_copier(basic_message& t,const basic_message& f)
                 : from(f), to(t) { }
 
             result_type operator()(argument_type f) {
                 to.set_field(f,from.get_field(f)); }
     };
 
-    basic_openid_message::basic_openid_message(const basic_openid_message& x) {
+    basic_message::basic_message(const basic_message& x) {
         x.copy_to(*this);
     }
-    void basic_openid_message::copy_to(basic_openid_message& x) const {
+    void basic_message::copy_to(basic_message& x) const {
         x.reset_fields();
         for_each(fields_begin(),fields_end(),
                 __om_copier(x,*this) );
     }
-    void basic_openid_message::append_to(basic_openid_message& x) const {
+    void basic_message::append_to(basic_message& x) const {
         for_each(fields_begin(),fields_end(),
                 __om_copier(x,*this) );
     }
 
-    struct __om_ns_finder : public unary_function<const string&,bool> {
-        public:
-            const basic_openid_message& om;
-            const string& uri;
-
-            __om_ns_finder(const basic_openid_message& m,
-                    const string& u) : om(m), uri(u) { }
-
-            result_type operator()(argument_type f) {
-                return
-                    (!strncmp(f.c_str(),"ns.",sizeof("ns.")-1))
-                        && om.get_field(f)==uri ;
-            }
-    };
-
-    bool basic_openid_message::has_ns(const string& uri) const {
-        fields_iterator ei = fields_end();
-        fields_iterator i = find_if(fields_begin(),fields_end(),
-                __om_ns_finder(*this,uri));
-        return !(i==ei);
-    }
-    string basic_openid_message::get_ns(const string& uri) const {
-        fields_iterator ei = fields_end();
-        fields_iterator i = find_if(fields_begin(),fields_end(),
-                __om_ns_finder(*this,uri));
-        if(i==ei)
-            throw failed_lookup(OPKELE_CP_ string("failed to find namespace ")+uri);
-        return i->substr(3);
-    }
-
     struct __om_query_builder : public unary_function<const string&,void> {
         public:
-            const basic_openid_message& om;
+            const basic_message& om;
             bool first;
             string& rv;
             const char *pfx;
 
-            __om_query_builder(const char *p,string& r,const basic_openid_message& m)
+            __om_query_builder(const char *p,string& r,const basic_message& m)
                 : om(m), first(true), rv(r), pfx(p) {
                     for_each(om.fields_begin(),om.fields_end(),*this);
                 }
-            __om_query_builder(const char *p,string& r,const basic_openid_message& m,const string& u)
+            __om_query_builder(const char *p,string& r,const basic_message& m,const string& u)
                 : om(m), first(true), rv(r), pfx(p) {
                     rv = u;
                     if(rv.find('?')==string::npos)
                         rv += '?';
                     else
                         first = false;
                     for_each(om.fields_begin(),om.fields_end(),*this);
                 }
 
             result_type operator()(argument_type f) {
                 if(first)
                     first = false;
                 else
                     rv += '&';
                 if(pfx) rv += pfx;
                 rv+= f;
                 rv += '=';
                 rv += util::url_encode(om.get_field(f));
             }
     };
 
-    string basic_openid_message::append_query(const string& url,const char *pfx) const {
+    string basic_message::append_query(const string& url,const char *pfx) const {
         string rv;
         return __om_query_builder(pfx,rv,*this,url).rv;
     }
-    string basic_openid_message::query_string(const char *pfx) const {
+    string basic_message::query_string(const char *pfx) const {
         string rv;
         return __om_query_builder(pfx,rv,*this).rv;
     }
 
-    void basic_openid_message::reset_fields() {
+    void basic_message::reset_fields() {
         throw not_implemented(OPKELE_CP_ "reset_fields() not implemented");
     }
-    void basic_openid_message::set_field(const string&,const string&) {
+    void basic_message::set_field(const string&,const string&) {
         throw not_implemented(OPKELE_CP_ "set_field() not implemented");
     }
-    void basic_openid_message::reset_field(const string&) {
+    void basic_message::reset_field(const string&) {
         throw not_implemented(OPKELE_CP_ "reset_field() not implemented");
     }
 
+    struct __om_ns_finder : public unary_function<const string&,bool> {
+        public:
+            const basic_openid_message& om;
+            const string& uri;
+
+            __om_ns_finder(const basic_openid_message& m,
+                    const string& u) : om(m), uri(u) { }
+
+            result_type operator()(argument_type f) {
+                return
+                    (!strncmp(f.c_str(),"ns.",sizeof("ns.")-1))
+                        && om.get_field(f)==uri ;
+            }
+    };
+
+    bool basic_openid_message::has_ns(const string& uri) const {
+        fields_iterator ei = fields_end();
+        fields_iterator i = find_if(fields_begin(),fields_end(),
+                __om_ns_finder(*this,uri));
+        return !(i==ei);
+    }
+    string basic_openid_message::get_ns(const string& uri) const {
+        fields_iterator ei = fields_end();
+        fields_iterator i = find_if(fields_begin(),fields_end(),
+                __om_ns_finder(*this,uri));
+        if(i==ei)
+            throw failed_lookup(OPKELE_CP_ string("failed to find namespace ")+uri);
+        return i->substr(3);
+    }
+
     void basic_openid_message::from_keyvalues(const string& kv) {
         reset_fields();
         string::size_type p = 0;
         while(true) {
             string::size_type co = kv.find(':',p);
             if(co==string::npos)
                 break;
 #ifndef POSTELS_LAW
             string::size_type nl = kv.find('\n',co+1);
             if(nl==string::npos)
                 throw bad_input(OPKELE_CP_ "malformed input");
             if(nl>co)
                 insert(value_type(kv.substr(p,co-p),kv.substr(co+1,nl-co-1)));
             p = nl+1;
 #else /* POSTELS_LAW */
             string::size_type lb = kv.find_first_of("\r\n",co+1);
             if(lb==string::npos) {
                 set_field(kv.substr(p,co-p),kv.substr(co+1));
                 break;
             }
             if(lb>co)
                 set_field(kv.substr(p,co-p),kv.substr(co+1,lb-co-1));
             string::size_type nolb = kv.find_first_not_of("\r\n",lb);
             if(nolb==string::npos)
                 break;
             p = nolb;
 #endif /* POSTELS_LAW */
         }
     }
 
     struct __om_kv_outputter : public unary_function<const string&,void> {
         public:
             const basic_openid_message& om;
             ostream& os;
 
             __om_kv_outputter(const basic_openid_message& m,ostream& s)
                 : om(m), os(s) { }
 
             result_type operator()(argument_type f) {
                 os << f << ':' << om.get_field(f) << '\n';
             }
     };
 
     void basic_openid_message::to_keyvalues(ostream& o) const {
         for_each(fields_begin(),fields_end(),__om_kv_outputter(*this,o));
     }
 
     struct __om_html_outputter : public unary_function<const string&,void> {
         public:
             const basic_openid_message& om;
             ostream& os;
             const char *pfx;
 
             __om_html_outputter(const basic_openid_message& m,ostream& s,const char *p=0)
                 : om(m), os(s), pfx(p) { }
 
             result_type operator()(argument_type f) {
                 os <<
                     "<input type=\"hidden\""
                     " name=\"";
                 if(pfx)
                     os << util::attr_escape(pfx);
                 os << util::attr_escape(f) << "\""
                     " value=\"" << util::attr_escape(om.get_field(f)) << "\" />";
             }
     };
 
     void basic_openid_message::to_htmlhiddens(ostream& o,const char* pfx) const {
         for_each(fields_begin(),fields_end(),__om_html_outputter(*this,o,pfx));
     }
 
     void basic_openid_message::add_to_signed(const string& fields) {
         string::size_type fnc = fields.find_first_not_of(",");
         if(fnc==string::npos)
             throw bad_input(OPKELE_CP_ "Trying to add nothing in particular to the list of signed fields");
         string signeds;
         try {
             signeds = get_field("signed");
             string::size_type lnc = signeds.find_last_not_of(",");
             if(lnc==string::npos)
                 signeds.assign(fields,fnc,fields.size()-fnc);
             else{
                 string::size_type ss = signeds.size();
                 if(lnc==(ss-1)) {
                     signeds+= ',';
                     signeds.append(fields,fnc,fields.size()-fnc);
                 }else{
                     if(lnc<(ss-2))
                         signeds.replace(lnc+2,ss-lnc-2,
                                 fields,fnc,fields.size()-fnc);
                     else
                         signeds.append(fields,fnc,fields.size()-fnc);
                 }
             }
         }catch(failed_lookup&) {
             signeds.assign(fields,fnc,fields.size()-fnc);
         }
         set_field("signed",signeds);
     }
 
     string basic_openid_message::find_ns(const string& uri,const char *pfx) const {
         try {
             return get_ns(uri);
         }catch(failed_lookup&) {
             return pfx;
         }
     }
     string basic_openid_message::allocate_ns(const string& uri,const char *pfx) {
         if(!has_field("ns"))
             return pfx;
         if(has_ns(uri))
             throw bad_input(OPKELE_CP_ "OpenID message already contains namespace");
         string rv = pfx;
         if(has_field("ns."+rv)) {
             string::reference c=rv[rv.length()];
             for(c='a';c<='z' && has_field("ns."+rv);++c);
             if(c=='z')
                 throw exception(OPKELE_CP_ "Failed to allocate namespace");
         }
         set_field("ns."+rv,uri);
         return rv;
     }
 
-    void openid_message_t::copy_to(basic_openid_message& x) const {
-        x.reset_fields();
-        for(const_iterator i=begin();i!=end();++i)
-            x.set_field(i->first,i->second);
-    }
-
     bool openid_message_t::has_field(const string& n) const {
         return find(n)!=end();
     }
     const string& openid_message_t::get_field(const string& n) const {
         const_iterator i=find(n);
         if(i==end())
             throw failed_lookup(OPKELE_CP_ n+": no such field");
         return i->second;
     }
 
     openid_message_t::fields_iterator openid_message_t::fields_begin() const {
         return util::map_keys_iterator<const_iterator,string,const string&,const string*>(begin(),end());
     }
     openid_message_t::fields_iterator openid_message_t::fields_end() const {
         return util::map_keys_iterator<const_iterator,string,const string&,const string*>(end(),end());
     }
 
     void openid_message_t::reset_fields() {
         clear();
     }
     void openid_message_t::set_field(const string& n,const string& v) {
         (*this)[n]=v;
     }
     void openid_message_t::reset_field(const string& n) {
         erase(n);
     }
 
 }