wexus2.src/wexus/Context.h

/*
 * Copyright (c) 2011 Aleksander B. Demko
 * This source code is distributed under the MIT license.
 * See the accompanying file LICENSE.MIT.txt for details.
 */

#ifndef __INCLUDED_WEXUS_CONTEXT_H__
#define __INCLUDED_WEXUS_CONTEXT_H__

#include <QTextStream>

#include <wexus/TR1.h>

#include <wexus/HTTPRequest.h>
#include <wexus/HTTPReply.h>
#include <wexus/ParamsParser.h>
#include <wexus/Cookies.h>
#include <wexus/SessionManager.h>

#include <QStringList>

namespace wexus
{
  class Context;

  class Application;  // forward
}

/**
 * The context object sets up and maintains (during its lifetime)
 * various thread-local storage variables necesary for the other
 * global functions defined in this file.
 *
 * Does header/footer sending too, over the HTTPReply
 *
 * @author Aleksander Demko
 */ 
class wexus::Context
{
  public:
    /// constructor
    Context(wexus::Application *application, wexus::HTTPRequest &req, wexus::HTTPReply &reply);
    /// destructor
    ~Context();

    /**
     * Returns the "static-like" instance for this thread.
     *
     * @author Aleksander Demko
     */ 
    static Context *threadInstance(void);

    /**
     * The application instance that spawned this context.
     *
     * @author Aleksander Demko
     */ 
    static wexus::Application * application(void) { return threadInstance()->dm_application; }
    /**
     * The wexus::HTTPRequest object that started this request.
     *
     * @author Aleksander Demko
     */ 
    static wexus::HTTPRequest & request(void) { return threadInstance()->dm_req; }
    /**
     * The wexus::HTTPReply object that will be used to reply
     * to the user.
     *
     * @author Aleksander Demko
     */ 
    static wexus::HTTPReply & reply(void) { return threadInstance()->dm_reply; }

    /**
     * Returns the raw output stream.
     *
     * @author Aleksander Demko
     */ 
    static QTextStream & output(void);

    /**
     * Returns a stream that HTML escapes all output
     * (except HTMLString).
     *
     * @author Aleksander Demko
     */ 
    static QTextStream & htmlOutput(void);

  private:
    wexus::Application *dm_application;
    wexus::HTTPRequest & dm_req;
    wexus::HTTPReply & dm_reply;

    std::shared_ptr<QIODevice> dm_htmldevice;
    std::shared_ptr<QTextStream> dm_htmloutput;

    bool dm_sentHeader;   // was the common header sent already

  public:
    // public things
    // cant make these nice-static because they arent methods
    // (and I dont really want to convert them to getter-like methods... yet)
    // placed her to maintain a proper initialization order

    /**
     * The form parameters.
     * Object directly accessible so operator[] works.
     *
     * @author Aleksander Demko
     */ 
    QVariantMap params;

    /**
     * The cookies.
     *
     * @author Aleksander Demko
     */ 
    Cookies cookies;

  private:
    // this has to be constructed AFTER cookies but before session
    SessionManager::Locker dm_sessionlocker;

  public:

    /**
     * The session, if any
     *
     * @author Aleksander Demko
     */ 
    QVariantMap &session;

    /**
     * The incoming flash sent by the previous calls.
     *
     * @author Aleksander Demko
     */ 
    const QVariantMap flash;

    /**
     * The flash that will be preseved for the next calls.
     * In the next call, this will be the contents of inFlash.
     *
     * @author Aleksander Demko
     */ 
    QVariantMap setFlash;

    typedef QMap<QString, QStringList> Errors;

    /**
     * Errors.
     *
     * @author Aleksander Demko
     */ 
    Errors errors;

  private:
    void sendHeader(void);
    void sendFooter(void);
};

#endif