//
   //  ========================================================================
   //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
   //  ------------------------------------------------------------------------
   //  All rights reserved. This program and the accompanying materials
   //  are made available under the terms of the Eclipse Public License v1.0
   //  and Apache License v2.0 which accompanies this distribution.
   //
   //      The Eclipse Public License is available at
  //      http://www.eclipse.org/legal/epl-v10.html
  //
  //      The Apache License v2.0 is available at
  //      http://www.opensource.org/licenses/apache2.0.php
  //
  //  You may elect to redistribute this code under either of these licenses.
  //  ========================================================================
  //
  
  package org.eclipse.jetty.server.session;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNotNull;
  import static org.junit.Assert.assertTrue;
  
  import java.io.IOException;
  
  import javax.servlet.ServletException;
  import javax.servlet.http.HttpServlet;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import javax.servlet.http.HttpSession;
  import javax.servlet.http.HttpSessionEvent;
  import javax.servlet.http.HttpSessionListener;
  
  import org.eclipse.jetty.client.HttpClient;
  import org.eclipse.jetty.client.api.ContentResponse;
  import org.eclipse.jetty.server.Request;
  import org.eclipse.jetty.servlet.ServletContextHandler;
  import org.eclipse.jetty.util.statistic.CounterStatistic;
  import org.junit.Test;
  
  /**
   * AbstractLocalSessionScavengingTest
   */
  public abstract class AbstractLocalSessionScavengingTest extends AbstractTestBase
  {
  
      public void pause(int scavengePeriod)
      {
          try
          {
              Thread.sleep(scavengePeriod * 1000L);
          }
          catch (InterruptedException e)
          {
              e.printStackTrace();
          }
      }
      
      
      public static class SessionListener implements HttpSessionListener
      {
          public CounterStatistic count = new CounterStatistic();
          /** 
           * @see javax.servlet.http.HttpSessionListener#sessionCreated(javax.servlet.http.HttpSessionEvent)
           */
          @Override
          public void sessionCreated(HttpSessionEvent se)
          {
              count.increment();
          }
  
          /** 
           * @see javax.servlet.http.HttpSessionListener#sessionDestroyed(javax.servlet.http.HttpSessionEvent)
           */
          @Override
          public void sessionDestroyed(HttpSessionEvent se)
          {
             count.decrement();
          }
      }
      
      @Test
      public void testNoScavenging() throws Exception
      {
          String contextPath = "";
          String servletMapping = "/server";
          int inactivePeriod = 3;
          int scavengePeriod = 0;
          AbstractTestServer server1 = createServer(0, inactivePeriod, scavengePeriod, SessionCache.NEVER_EVICT);
          ServletContextHandler context1 = server1.addContext(contextPath);
          context1.addServlet(TestServlet.class, servletMapping);
          SessionListener listener = new SessionListener();
          context1.getSessionHandler().addEventListener(listener);
             
          
          try
          {
              server1.start();
             int port1 = server1.getPort();
 
             HttpClient client = new HttpClient();
             client.start();
             try
             {
                 String url = "http://localhost:" + port1 + contextPath + servletMapping;
 
 
                 // Create the session
                 ContentResponse response1 = client.GET(url + "?action=init");
                 assertEquals(HttpServletResponse.SC_OK,response1.getStatus());
                 String sessionCookie = response1.getHeaders().get("Set-Cookie");
                 assertTrue(sessionCookie != null);
                 // Mangle the cookie, replacing Path with $Path, etc.
                 sessionCookie = sessionCookie.replaceFirst("(\\W)(P|p)ath=", "$1\\$Path=");
                 SessionHandler m1 = context1.getSessionHandler();
                 assertEquals(1,  m1.getSessionsCreated());
 
 
                 // Wait a while to ensure that the session should have expired, if the
                 //scavenger was running
                 pause(2*inactivePeriod);
 
                 assertEquals(1,  m1.getSessionsCreated());
                
 
                 if (m1 instanceof TestSessionHandler)
                 {
                     ((TestSessionHandler)m1).assertCandidatesForExpiry(0);
                 }
 
                 //check a session removed listener did not get called
                 assertEquals(1, listener.count.getCurrent());
             }
             finally
             {
                 client.stop();
             }
         }
         finally
         {
             server1.stop();
         }
     }
     
 
     @Test
     public void testLocalSessionsScavenging() throws Exception
     {
         String contextPath = "";
         String servletMapping = "/server";
         int inactivePeriod = 4;
         int scavengePeriod = 1;
         AbstractTestServer server1 = createServer(0, inactivePeriod, scavengePeriod, SessionCache.NEVER_EVICT);
         ServletContextHandler context1 = server1.addContext(contextPath);
         context1.addServlet(TestServlet.class, servletMapping);
 
         try
         {
             server1.start();
             int port1 = server1.getPort();
             AbstractTestServer server2 = createServer(0, inactivePeriod, scavengePeriod * 2, SessionCache.NEVER_EVICT);
             ServletContextHandler context2 = server2.addContext(contextPath);
             context2.addServlet(TestServlet.class, servletMapping);
 
             try
             {
                 server2.start();
                 int port2 = server2.getPort();
                 HttpClient client = new HttpClient();
                 client.start();
                 try
                 {
                     String[] urls = new String[2];
                     urls[0] = "http://localhost:" + port1 + contextPath + servletMapping;
                     urls[1] = "http://localhost:" + port2 + contextPath + servletMapping;
 
                     // Create the session on node1
                     ContentResponse response1 = client.GET(urls[0] + "?action=init");
                     assertEquals(HttpServletResponse.SC_OK,response1.getStatus());
                     String sessionCookie = response1.getHeaders().get("Set-Cookie");
                     assertTrue(sessionCookie != null);
                     // Mangle the cookie, replacing Path with $Path, etc.
                     sessionCookie = sessionCookie.replaceFirst("(\\W)(P|p)ath=", "$1\\$Path=");
                     SessionHandler m1 = context1.getSessionHandler();
                     assertEquals(1,  m1.getSessionsCreated());
 
                     // Be sure the session is also present in node2
                     org.eclipse.jetty.client.api.Request request = client.newRequest(urls[1] + "?action=test");
                     request.header("Cookie", sessionCookie);
                     ContentResponse response2 = request.send();
                     assertEquals(HttpServletResponse.SC_OK,response2.getStatus());
                     SessionHandler m2 = context2.getSessionHandler();
 
                     // Wait for the scavenger to run on node1
                     pause(inactivePeriod+(2*scavengePeriod));
 
                     assertEquals(1,  m1.getSessionsCreated());
 
                     // Check that node1 does not have any local session cached
                     request = client.newRequest(urls[0] + "?action=check");
                     request.header("Cookie", sessionCookie);
                     response1 = request.send();
                     assertEquals(HttpServletResponse.SC_OK,response1.getStatus());
                     
                     assertEquals(1,  m1.getSessionsCreated());
 
                     // Wait for the scavenger to run on node2, waiting 3 times the scavenger period
                     // This ensures that the scavenger on node2 runs at least once.
                     pause(inactivePeriod+(2*scavengePeriod));
                     
                     // Check that node2 does not have any local session cached
                     request = client.newRequest(urls[1] + "?action=check");
                     request.header("Cookie", sessionCookie);
                     response2 = request.send();
                     assertEquals(HttpServletResponse.SC_OK,response2.getStatus());
                 }
                 finally
                 {
                     client.stop();
                 }
             }
             finally
             {
                 server2.stop();
             }
         }
         finally
         {
             server1.stop();
         }
     }
 
     public static class TestServlet extends HttpServlet
     {
         @Override
         protected void doGet(HttpServletRequest request, HttpServletResponse httpServletResponse) throws ServletException, IOException
         {
             String action = request.getParameter("action");
             if ("init".equals(action))
             {
                 HttpSession session = request.getSession(true);
                 session.setAttribute("test", "test");
             }
             else if ("test".equals(action))
             {
                 HttpSession session = request.getSession(false);
                 assertNotNull(session);
                 session.setAttribute("test", "test");
             }
             else if ("check".equals(action))
             {
                 HttpSession session = request.getSession(false);
                 assertTrue(session == null);
             }
         }
     }
 }