/* 
    P/P   *  Method: net.sourceforge.pebble.web.action.ViewLogSummaryAction__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.domain.Blog;
    36  import net.sourceforge.pebble.domain.Month;
    37  import net.sourceforge.pebble.logging.LogSummary;
    38  import net.sourceforge.pebble.web.view.View;
    39  import net.sourceforge.pebble.web.view.impl.LogSummaryByMonthView;
    40  import net.sourceforge.pebble.web.view.impl.LogSummaryByYearView;
    41  
         /* 
    P/P   *  Method: void net.sourceforge.pebble.web.action.ViewLogSummaryAction()
          */
    42  import javax.servlet.ServletException;
    43  import javax.servlet.http.HttpServletRequest;
    44  import javax.servlet.http.HttpServletResponse;
    45  import java.text.SimpleDateFormat;
    46  import java.util.Calendar;
    47  import java.util.Locale;
    48  
    49  /**
    50   * Gets the contents of the specified log file.
    51   *
    52   * @author    Simon Brown
    53   */
    54  public class ViewLogSummaryAction extends SecureAction {
    55  
    56    /**
    57     * Peforms the processing associated with this action.
    58     *
    59     * @param request  the HttpServletRequest instance
    60     * @param response the HttpServletResponse instance
    61     * @return the name of the next view
    62     */
    63    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.lang.Integer:parseInt(...)@76 >= -231+1
              *    java.util.Calendar:get(...)@79 <= 232-2
              *    java.util.Calendar:get(...)@88 <= 232-2
              *    java.util.HashMap:get(...)@63 != null
              *    init'ed(java.util.Locale.ENGLISH)
              *    ...
              * 
              *  Postconditions:
              *    return_value == One-of{&new LogSummaryByMonthView(process#1), &new LogSummaryByYearView(process#2), &new LogSummaryByMonthView(process#3)}
              *    return_value in Addr_Set{&new LogSummaryByMonthView(process#1),&new LogSummaryByYearView(process#2),&new LogSummaryByMonthView(process#3)}
              *    new LogSummaryByMonthView(process#1) num objects <= 1
              *    new LogSummaryByMonthView(process#3) num objects <= 1
              *    new LogSummaryByYearView(process#2) num objects <= 1
              * 
              *  Test Vectors:
              *    java.lang.String:length(...)@73: {0}, {1..232-1}
              *    java.lang.String:length(...)@74: {0}, {1..232-1}
              *    java.lang.String:length(...)@82: {0}, {1..232-1}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@66: Addr_Set{null}, Inverse{null}
              *    javax.servlet.http.HttpServletRequest:getParameter(...)@67: Addr_Set{null}, Inverse{null}
              */
    64      Blog blog = (Blog)getModel().get(Constants.BLOG_KEY);
    65  
    66      String yearAsStriing = request.getParameter("year");
    67      String monthAsString = request.getParameter("month");
    68  
    69      Calendar cal = blog.getCalendar();
    70      LogSummary logSummary;
    71      View view;
    72  
    73      if (yearAsStriing != null && yearAsStriing.length() > 0 &&
    74          monthAsString != null && monthAsString.length() > 0) {
    75        int year = Integer.parseInt(yearAsStriing);
    76        int month = Integer.parseInt(monthAsString)-1;
    77        cal.set(Calendar.YEAR, year);
    78        cal.set(Calendar.MONTH, month);
    79        logSummary = blog.getLogger().getLogSummary(cal.get(Calendar.YEAR), cal.get(Calendar.MONTH)+1);
    80        view = new LogSummaryByMonthView();
    81        registerObjectsForNavigation(blog, blog.getBlogForMonth(year, month+1));
    82      } else if (yearAsStriing != null && yearAsStriing.length() > 0) {
    83        cal.set(Calendar.YEAR, Integer.parseInt(yearAsStriing));
    84        logSummary = blog.getLogger().getLogSummary(cal.get(Calendar.YEAR));
    85        view = new LogSummaryByYearView();
    86      } else {
    87        // get the log for this monthAsString
    88        logSummary = blog.getLogger().getLogSummary(cal.get(Calendar.YEAR), cal.get(Calendar.MONTH)+1);
    89        view = new LogSummaryByMonthView();
    90        registerObjectsForNavigation(blog, blog.getBlogForThisMonth());
    91      }
    92  
    93      SimpleDateFormat yearFormatter = new SimpleDateFormat("yyyy", Locale.ENGLISH);
    94      yearFormatter.setTimeZone(blog.getTimeZone());
    95      SimpleDateFormat monthFormatter = new SimpleDateFormat("MM", Locale.ENGLISH);
    96      monthFormatter.setTimeZone(blog.getTimeZone());
    97      SimpleDateFormat dayFormatter = new SimpleDateFormat("dd", Locale.ENGLISH);
    98      dayFormatter.setTimeZone(blog.getTimeZone());
    99      getModel().put("year", yearFormatter.format(logSummary.getDate()));
   100      getModel().put("month", monthFormatter.format(logSummary.getDate()));
   101  
   102      getModel().put("logAction", "viewLogSummary");
   103      getModel().put("logSummary", logSummary);
   104  
   105      return view;
   106    }
   107  
           /* 
    P/P     *  Method: void registerObjectsForNavigation(Blog, Month)
            * 
            *  Preconditions:
            *    blog != null
            *    month != null
            *    this.model != null
            *    this.model.data != null
            * 
            *  Presumptions:
            *    net.sourceforge.pebble.domain.Blog:getCalendar(...)@117 != null
            *    net.sourceforge.pebble.domain.Month:getDate(...)@117 != null
            *    net.sourceforge.pebble.domain.Month:getNextMonth(...)@111 != null
            *    net.sourceforge.pebble.domain.Month:getPreviousMonth(...)@110 != null
            * 
            *  Test Vectors:
            *    java.util.Date:after(...)@117: {0}, {1}
            *    net.sourceforge.pebble.domain.Month:before(...)@113: {1}, {0}
            *    net.sourceforge.pebble.domain.Month:before(...)@117: {0}, {1}
            */
   108    private void registerObjectsForNavigation(Blog blog, Month month) {
   109      Month firstMonth = blog.getBlogForFirstMonth();
   110      Month previousMonth = month.getPreviousMonth();
   111      Month nextMonth = month.getNextMonth();
   112  
   113      if (!previousMonth.before(firstMonth)) {
   114        getModel().put("previousMonth", previousMonth);
   115      }
   116  
   117      if (!nextMonth.getDate().after(blog.getCalendar().getTime()) || nextMonth.before(firstMonth)) {
   118        getModel().put("nextMonth", nextMonth);
   119      }
   120      getModel().put("displayMode", "logSummaryForMonth");
   121    }
   122  
   123    /**
   124     * Gets a list of all roles that are allowed to access this action.
   125     *
   126     * @return  an array of Strings representing role names
   127     * @param request
   128     */
   129    public String[] getRoles(HttpServletRequest request) {
             /* 
    P/P       *  Method: String[] getRoles(HttpServletRequest)
              * 
              *  Presumptions:
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_ADMIN_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE)
              *    init'ed(net.sourceforge.pebble.Constants.BLOG_PUBLISHER_ROLE)
              * 
              *  Postconditions:
              *    return_value == &new String[](getRoles#1)
              *    new String[](getRoles#1) num objects == 1
              *    return_value.length == 4
              *    return_value[0] == net.sourceforge.pebble.Constants.BLOG_ADMIN_ROLE
              *    (soft) init'ed(return_value[0])
              *    return_value[1] == net.sourceforge.pebble.Constants.BLOG_OWNER_ROLE
              *    (soft) init'ed(return_value[1])
              *    return_value[2] == net.sourceforge.pebble.Constants.BLOG_PUBLISHER_ROLE
              *    (soft) init'ed(return_value[2])
              *    return_value[3] == net.sourceforge.pebble.Constants.BLOG_CONTRIBUTOR_ROLE
              *    ...
              */
   130      return new String[]{Constants.BLOG_ADMIN_ROLE, Constants.BLOG_OWNER_ROLE, Constants.BLOG_PUBLISHER_ROLE, Constants.BLOG_CONTRIBUTOR_ROLE};
   131    }
   132  
   133  }