ulxr_htmlform_handler.h

Go to the documentation of this file.

/***************************************************************************
        ulxr_htmlform_handler.h  -  work with html pages and forms
                             -------------------
    begin                : Fri Dec 05 2003
    copyright            : (C) 2002-2007 by Ewald Arnold
    email                : ulxmlrpcpp@ewald-arnold.de

    $Id: ulxr_htmlform_handler.h 942 2006-12-31 13:10:54Z ewald-arnold $

 ***************************************************************************/

/**************************************************************************
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 ***************************************************************************/

#ifndef ULXR_HtmlFormHandler_H
#define ULXR_HtmlFormHandler_H


#include <ulxmlrpcpp/ulxmlrpcpp.h>  // always first header

#include <ulxmlrpcpp/ulxr_http_server.h>
#include <ulxmlrpcpp/ulxr_except.h>


namespace ulxr {


class ULXR_API_DECL0 HtmlFormData
{
  public:
   typedef std::map<CppString, std::vector<CppString> > Elements;

   void addElement(const CppString &name, const CppString &value);

   std::vector<CppString> getElement(const CppString &name) const;

   std::vector<CppString> getElement(const CppString &name, unsigned index) const;

   bool hasElement(const CppString &name) const;

   bool hasElement(const CppString &name, unsigned index) const;

   unsigned size() const;

  private:

    Elements  elements;
};


namespace hidden
{

class ULXR_API_DECL0 SubResourceBase
{
  public:

    SubResourceBase(const CppString &name, const CppString &descr);

    virtual ~SubResourceBase();

    virtual CppString call(const HtmlFormData &formdata, CppString &mimetype) = 0;

    CppString getName() const;

    CppString getDescription() const;

  private:

    CppString    name;
    CppString    descr;
};


template<class T>
class SubResource : public SubResourceBase
{
  public:

  typedef CppString (T::*PMF)(const HtmlFormData &formdata, CppString &mimetype);

    SubResource(const CppString &in_name, T* in_obj, PMF in_pmf, const CppString &in_descr)
        : SubResourceBase(in_name, in_descr)
        , obj(in_obj)
        , pmf(in_pmf)
    {}

    CppString call(const HtmlFormData &formdata, CppString &mimetype)
    {
      return (obj->*pmf)(formdata, mimetype);
    }

  private:
    T        *obj;
    PMF       pmf;
};


} // namespace hidden


class ULXR_API_DECL0 HtmlFormHandler
{
  public:

    HtmlFormHandler(const CppString &resource);

    virtual ~HtmlFormHandler();

    HtmlFormData extractFormElements(HttpProtocol *prot,
                                     const CppString &method,
                                     const CppString &resource,
                                     const Cpp8BitString &conn_data);

    static bool resourceSplit(const CppString &method,
                              const CppString &resource,
                              const CppString &rsc_start,
                              CppString &target);

    static std::string formDecode(std::string &value);

    virtual std::string encodeForHtml(const CppString &data);

    virtual CppString encodeFromHtml(const std::string &data);

    CppString openForm(const CppString &name, const CppString &method);

    static CppString closeForm();

    CppString makeAnchor(const CppString &url, const CppString &descr);

    static CppString makeIdent(const CppString &name, unsigned index);

    static CppString makeHexNumber(unsigned index);

    static CppString makeNumber(unsigned index);

    static long getLong(const CppString &num);

    static CppString makeText(const CppString &text);

    static CppString makeCheckBox(const CppString &name, const CppString &value,
                                  bool checked = false);

    static CppString makeTextField(const CppString &name, const CppString &value);

    static CppString makeTextArea(const CppString &name, const CppString &value,
                                  int cols = -1, int rows = -1);

    static CppString openSelect(const CppString &name,
                                int size = 1,
                                bool multi = false);

    static CppString makeOption(const CppString &data,
                                const CppString &value = ULXR_PCHAR(""),
                                bool selected = false);

    static CppString closeSelect();

    static CppString makeRadioButton(const CppString &name, const CppString &value,
                                     bool checked = false);

    static CppString makeSubmitButton(const CppString &name,
                                      const CppString &value);

    static CppString makeResetButton(const CppString &name,
                                     const CppString &value);

    static CppString makeLineBreak();

    static CppString applyTags(const CppString &data,
                               const CppString &tag,
                               bool newline = false);

    virtual bool handler(HttpProtocol *prot,
                         const CppString &method,
                         const CppString &resource,
                         const Cpp8BitString &conn_data);

    virtual CppString getHeader(const CppString &title) const;

    virtual CppString getTail() const;

    virtual CppString getCssName() const;

    virtual CppString getEncoding() const;

    virtual CppString handle_css_file(const HtmlFormData &formdata, CppString &mimetype);

    CppString handle_subresource_list(const HtmlFormData &formdata, CppString &mimetype);

    CppString getMasterResource() const;

    template <class T>
    void addSubResource(const CppString &name,
                        T* obj,
                        CppString (T::*pmf)(const HtmlFormData &, CppString &),
                        const CppString &descr = ULXR_PCHAR(""))
    {
      for (unsigned i = 0; i < subResources.size(); ++i)
      {
        if (subResources[i]->getName() == name)
          throw RuntimeException(ApplicationError,
                                 ULXR_PCHAR("Attempt to register two resources under the same name: ")
                                 + name);
      }
      subResources.push_back(new hidden::SubResource<T>(name, obj, pmf, descr));
    }

  private:

    CppString                              masterResource;
    std::vector<hidden::SubResourceBase*>  subResources;

 private:

   // forbid them all due to internal pointers
   HtmlFormHandler(const HtmlFormHandler&);
   HtmlFormHandler& operator=(const HtmlFormHandler&);
};


}  // namespace ulxr


#endif

---