module.cpp

Go to the documentation of this file.

// This code based on an example retrieved from http://wiki.forum.nokia.com/index.php/Writing_an_HTTP_filter_plugin

// References:
// http://wiki.forum.nokia.com/index.php/Writing_an_HTTP_filter_plugin
// http://wiki.forum.nokia.com/index.php/TSS001070_-_Modifying_web_content_using_an_HTTP_filter
// http://discussion.forum.nokia.com/forum/showthread.php?128548-How-to-monitor-S60-browser-to-get-the-details-of-URLs-visited-by-the-user
// http://wiki.forum.nokia.com/index.php/CS000835_-_ECom:_Implementing_interface

#include "cl2webfilter.h"

#include "common/epoc-session.hpp"
#include "common/logging.h"

#include <e32base.h>
#include <e32property.h>
#include <ecom/ecom.h>
#include <ecom/implementationproxy.h>
#include <http/cecomfilter.h>
#include <http/mhttpfilter.h>
#include <http/rhttptransaction.h>

_LIT8(KCl2WebFilterName, "cl2webfilter");

class CCl2WebFilter : 
  public CEComFilter, 
  public MHTTPFilter
{
public:
  static CEComFilter* CreateFilterL(TAny* aHttpSession);
  
  // virtuals from MHTTPFilter
  void MHFUnload(RHTTPSession aSession, THTTPFilterHandle aHandle);
  void MHFLoad(RHTTPSession aSession, THTTPFilterHandle aHandle);
  void MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
  void MHFSessionRunL(const THTTPSessionEvent& aEvent);
  TInt MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
  TInt MHFSessionRunError(TInt aError, const THTTPSessionEvent& aEvent);
  
  ~CCl2WebFilter();
private:
  void ConstructL(RHTTPSession& aHttpSession);
  
private:
  RStringF iFilterName;
  DEF_SESSION(RProperty, iProperty);
};
  
CEComFilter* CCl2WebFilter::CreateFilterL(TAny* aHttpSession)
{
  // The CEcomFilter class passes us a pointer to the RHTTPSession so we can install ourselves
  RHTTPSession* session = reinterpret_cast<RHTTPSession*>(aHttpSession);
  CCl2WebFilter* self = new (ELeave) CCl2WebFilter;
  CleanupStack::PushL(self);
  self->ConstructL(*session);
  CleanupStack::Pop(self);
  return self;
}
  
CCl2WebFilter::~CCl2WebFilter()
{
  iFilterName.Close();
  SESSION_CLOSE_IF_OPEN(iProperty);
}
  
void CCl2WebFilter::ConstructL(RHTTPSession& aSession)
{
  TInt errCode = RProperty::Define(TUid::Uid(KCl2WebFilterCat), 
           KCl2WebFilterKey, 
           RProperty::EByteArray,
           256);
  if (errCode != KErrNone && errCode != KErrAlreadyExists) 
    User::Leave(errCode);

  LEAVE_IF_ERROR_OR_SET_SESSION_OPEN(iProperty, iProperty.Attach(TUid::Uid(KCl2WebFilterCat), KCl2WebFilterKey, EOwnerThread));

  // install this filter in to the current session
  iFilterName = aSession.StringPool().OpenFStringL(KCl2WebFilterName);
  aSession.FilterCollection().AddFilterL(*this, THTTPEvent::EAnyTransactionEvent,
           RStringF(), KAnyStatusCode, 
           EClientFilters, iFilterName);
}

void CCl2WebFilter::MHFUnload(RHTTPSession aSession, THTTPFilterHandle aHandle)
{
  //logt("Demo Filter: HTTP filter unloaded.");

  // self loading filters manage their own life cycle...
  delete this;
}

void CCl2WebFilter::MHFLoad(RHTTPSession aSession, THTTPFilterHandle aHandle)
{
  //logt("Demo Filter: HTTP filter loaded.");
}

void CCl2WebFilter::MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent)
{
  // Called when a RHTTPTransaction event happens.
  if (aEvent == THTTPEvent::ESubmit)
    {
      const TDesC8& uri = aTransaction.Request().URI().UriDes();
      //logg("Demo Filter: New transaction submitted to '%S'", &uri);
      if (uri.Length() <= RProperty::KMaxPropertySize)
        // We ignore errors here.
  iProperty.Set(uri);
    }
}

void CCl2WebFilter::MHFSessionRunL(const THTTPSessionEvent& aEvent)
{
  // Called when an RHTTPSession event happens.
}

TInt CCl2WebFilter::MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent)
{
  // Called when MHFRunL leaves. Our implementation never does.
  return KErrNone;
}

TInt CCl2WebFilter::MHFSessionRunError(TInt aError, const THTTPSessionEvent& aEvent)
{
  // Called when MHFSessionRunL leaves. Our implementation does nothing.
  return KErrNone;
}
  
// standard ECOM initialisation
  
static const TImplementationProxy KImplementationTable[] = 
  {
    IMPLEMENTATION_PROXY_ENTRY(0xe846000f, CCl2WebFilter::CreateFilterL)
  };

EXPORT_C const TImplementationProxy* ImplementationGroupProxy(TInt& aTableCount)
{
  aTableCount = sizeof(KImplementationTable) / sizeof(TImplementationProxy);
  return KImplementationTable;
}