shibsp/handler/impl/LocalLogoutInitiator.cpp

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * LocalLogoutInitiator.cpp
  19  *
  20  * Logs out a session locally.
  21  */
  22
  23 #include "internal.h"
  24 #include "Application.h"
  25 #include "ServiceProvider.h"
  26 #include "SessionCache.h"
  27 #include "SPRequest.h"
  28 #include "handler/AbstractHandler.h"
  29 #include "handler/LogoutInitiator.h"
  30
  31 using namespace shibsp;
  32 using namespace xmltooling;
  33 using namespace std;
  34
  35 namespace shibsp {
  36
  37 #if defined (_MSC_VER)
  38     #pragma warning( push )
  39     #pragma warning( disable : 4250 )
  40 #endif
  41
  42     class SHIBSP_DLLLOCAL LocalLogoutInitiator : public AbstractHandler, public LogoutInitiator
  43     {
  44     public:
  45         LocalLogoutInitiator(const DOMElement* e, const char* appId);
  46         virtual ~LocalLogoutInitiator() {}
  47
  48         void setParent(const PropertySet* parent);
  49         pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
  50
  51     private:
  52         string m_appId;
  53     };
  54
  55 #if defined (_MSC_VER)
  56     #pragma warning( pop )
  57 #endif
  58
  59     Handler* SHIBSP_DLLLOCAL LocalLogoutInitiatorFactory(const pair<const DOMElement*,const char*>& p)
  60     {
  61         return new LocalLogoutInitiator(p.first, p.second);
  62     }
  63 };
  64
  65 LocalLogoutInitiator::LocalLogoutInitiator(const DOMElement* e, const char* appId)
  66     : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".LogoutInitiator.Local")), m_appId(appId)
  67 {
  68     pair<bool,const char*> loc = getString("Location");
  69     if (loc.first) {
  70         string address = string(appId) + loc.second + "::run::LocalLI";
  71         setAddress(address.c_str());
  72     }
  73 }
  74
  75 void LocalLogoutInitiator::setParent(const PropertySet* parent)
  76 {
  77     DOMPropertySet::setParent(parent);
  78     pair<bool,const char*> loc = getString("Location");
  79     if (loc.first) {
  80         string address = m_appId + loc.second + "::run::LocalLI";
  81         setAddress(address.c_str());
  82     }
  83     else {
  84         m_log.warn("no Location property in Local LogoutInitiator (or parent), can't register as remoted handler");
  85     }
  86 }
  87
  88 pair<bool,long> LocalLogoutInitiator::run(SPRequest& request, bool isHandler) const
  89 {
  90     // Defer to base class first.
  91     pair<bool,long> ret = LogoutHandler::run(request, isHandler);
  92     if (ret.first)
  93         return ret;
  94
  95     const Application& app = request.getApplication();
  96     string session_id = app.getServiceProvider().getSessionCache()->active(app, request);
  97     if (!session_id.empty()) {
  98         // Do back channel notification.
  99         vector<string> sessions(1, session_id);
 100         bool result = notifyBackChannel(app, request.getRequestURL(), sessions, true);
 101         app.getServiceProvider().getSessionCache()->remove(app, request, &request);
 102         if (!result)
 103             return sendLogoutPage(app, request, request, "partial");
 104     }
 105
 106     // Route back to return location specified, or use the local template.
 107     const char* dest = request.getParameter("return");
 108     if (dest)
 109         return make_pair(true, request.sendRedirect(dest));
 110     return sendLogoutPage(app, request, request, "local");
 111 }