/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.ViewReferersAction__static_init
          */
     1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.web.action;
    33  
    34  import net.sourceforge.pebble.Constants;
    35  import net.sourceforge.pebble.comparator.CountedUrlByCountComparator;
    36  import net.sourceforge.pebble.domain.Blog;
    37  import net.sourceforge.pebble.logging.CountedUrl;
    38  import net.sourceforge.pebble.logging.Log;
    39  import net.sourceforge.pebble.web.view.View;
    40  import net.sourceforge.pebble.web.view.impl.ReferersView;
    41  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.ViewReferersAction()
          */
    42  import javax.servlet.ServletException;
    43  import javax.servlet.http.HttpServletRequest;
    44  import javax.servlet.http.HttpServletResponse;
    45  import java.util.ArrayList;
    46  import java.util.Collections;
    47  import java.util.Iterator;
    48  import java.util.List;
    49  
    50  /**
    51   * Gets the referers for the specified time period. This differs from the
    52   * unsecure version in that it allows referers to be seen month by month
    53   * and referer filtering can be toggled on/off.
    54   *
    55   * @author    Simon Brown
    56   */
    57  public class ViewReferersAction extends AbstractLogAction {
    58  
    59    /**
    60     * Peforms the processing associated with this action.
    61     *
    62     * @param request  the HttpServletRequest instance
    63     * @param response the HttpServletResponse instance
    64     * @return the name of the next view
    65     */
    66    public View process(HttpServletRequest request, HttpServletResponse response) throws ServletException {
             /* 
    P/P       *  Method: View process(HttpServletRequest, HttpServletResponse)
              * 
              *  Preconditions:
              *    request != null
              *    this.model != null
              *    this.model.data != null
              * 
              *  Presumptions:
              *    java.util.HashMap:get(...)@63 != null
              *    java.util.Iterator:next(...)@82 != null
              *    log.logEntries@68 != null
              *    net.sourceforge.pebble.domain.Blog:getRefererFilterManager(...)@73 != null
              *    net.sourceforge.pebble.domain.RefererFilterManager:filter(...)@73 != null
              *    ...
              * 
              *  Postconditions:
              *    return_value == &new ReferersView(process#4)
              *    new ReferersView(process#4) num objects == 1
              * 
              *  Test Vectors:
              *    java.lang.String:equalsIgnoreCase(...)@72: {0}, {1}
              *    java.util.Iterator:hasNext(...)@81: {1}, {0}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@70: Addr_Set{null}, Inverse{null}
              */
    67      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    68      Log log = getLog(request, response);
    69  
    70      String filter = request.getParameter("filter");
    71      List referers = new ArrayList(log.getReferers());
    72      if (filter == null || filter.equalsIgnoreCase("true")) {
    73        referers = blog.getRefererFilterManager().filter(referers);
    74      }
    75      Collections.sort(referers, new CountedUrlByCountComparator());
    76  
    77      // now calculate the total number of referers, after filtering spam
    78      int totalReferers = 0;
    79      Iterator it = referers.iterator();
    80      CountedUrl url;
    81      while (it.hasNext()) {
    82        url = (CountedUrl)it.next();
    83        totalReferers += url.getCount();
    84      }
    85  
    86      getModel().put("logAction", "viewReferers");
    87      getModel().put("referers", referers);
    88      getModel().put("totalReferers", new Integer(totalReferers));
    89  
    90      return new ReferersView();
    91    }
    92  
    93  }