# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1278633405 -7200
# Node ID e5ca6e3d5301a0741e75b9414fc5a6cf178b8152
# Parent  9c231d98aedb352b4fde45d27935d5b2895a6da7
Fixed parameter passing to the summary action in the macro.
Added support for criteria/expressions in the action, together with a preview of
the evaluated result of such criteria at the current time.
Added better labelling of calendar downloads/subscriptions in the macro,
providing a preview of any evaluated criteria.
Moved functionality for generating "full" month and year labels into the
library.
Added default date selection support in the ActionSupport.get_month_list and
ActionSupport.get_year_defaults methods, along with the addition of extra blank
fields in month lists where no default will be set.

diff -r 9c231d98aedb -r e5ca6e3d5301 EventAggregatorSupport.py
--- a/EventAggregatorSupport.py	Thu Jul 08 22:18:54 2010 +0200
+++ b/EventAggregatorSupport.py	Fri Jul 09 01:56:45 2010 +0200
@@ -161,7 +161,7 @@
         else:
             return int(value)
 
-    def get_month_lists(self):
+    def get_month_lists(self, default_as_current=0):
 
         """
         Return two lists of HTML element definitions corresponding to the start
@@ -177,11 +177,15 @@
         start_month_list = []
         end_month_list = []
 
-        start_month = self._get_input(form, "start-month", getCurrentMonth().month())
+        start_month = self._get_input(form, "start-month", default_as_current and getCurrentMonth().month() or None)
         end_month = self._get_input(form, "end-month", start_month)
 
         # Prepare month lists, selecting specified months.
 
+        if not default_as_current:
+            start_month_list.append('<option value=""></option>')
+            end_month_list.append('<option value=""></option>')
+
         for month in range(1, 13):
             month_label = _(getMonthLabel(month))
             selected = self._get_selected(month, start_month)
@@ -191,14 +195,14 @@
 
         return start_month_list, end_month_list
 
-    def get_year_defaults(self):
+    def get_year_defaults(self, default_as_current=0):
 
         "Return defaults for the start and end years."
 
         form = self.get_form()
 
-        start_year_default = form.get("start-year", [""])[0] or getCurrentYear()
-        end_year_default = form.get("end-year", [""])[0] or start_year_default
+        start_year_default = form.get("start-year", [default_as_current and getCurrentYear() or ""])[0]
+        end_year_default = form.get("end-year", [default_as_current and start_year_default or ""])[0]
 
         return start_year_default, end_year_default
 
@@ -1457,6 +1461,18 @@
     else:
         return None
 
+def getFullMonthLabel(request, year_month):
+
+    """
+    Return the full month plus year label using the given 'request' and
+    'year_month'.
+    """
+
+    _ = request.getText
+    year, month = year_month.as_tuple()
+    month_label = _(getMonthLabel(month))
+    return "%s %s" % (month_label, year)
+
 # Page-related functions.
 
 def getPrettyPageName(page):
diff -r 9c231d98aedb -r e5ca6e3d5301 actions/EventAggregatorNewEvent.py
--- a/actions/EventAggregatorNewEvent.py	Thu Jul 08 22:18:54 2010 +0200
+++ b/actions/EventAggregatorNewEvent.py	Fri Jul 09 01:56:45 2010 +0200
@@ -82,8 +82,8 @@
 
         # Initialise month lists.
 
-        start_month_list, end_month_list = self.get_month_lists()
-        start_year_default, end_year_default = self.get_year_defaults()
+        start_month_list, end_month_list = self.get_month_lists(default_as_current=1)
+        start_year_default, end_year_default = self.get_year_defaults(default_as_current=1)
 
         # Initialise regime lists.
 
diff -r 9c231d98aedb -r e5ca6e3d5301 actions/EventAggregatorSummary.py
--- a/actions/EventAggregatorSummary.py	Thu Jul 08 22:18:54 2010 +0200
+++ b/actions/EventAggregatorSummary.py	Fri Jul 09 01:56:45 2010 +0200
@@ -48,6 +48,19 @@
         start_month_list, end_month_list = self.get_month_lists()
         start_year_default, end_year_default = self.get_year_defaults()
 
+        # Criteria instead of months and years.
+
+        start_criteria_default = form.get("start", [""])[0]
+        end_criteria_default = form.get("end", [""])[0]
+
+        start_criteria_evaluated = EventAggregatorSupport.getParameterMonth(start_criteria_default)
+        end_criteria_evaluated = EventAggregatorSupport.getParameterMonth(end_criteria_default)
+
+        start_criteria_evaluated = start_criteria_evaluated and \
+            EventAggregatorSupport.getFullMonthLabel(request, start_criteria_evaluated) or ""
+        end_criteria_evaluated = end_criteria_evaluated and \
+            EventAggregatorSupport.getFullMonthLabel(request, end_criteria_evaluated) or ""
+
         # Descriptions.
 
         descriptions = form.get("descriptions", [None])[0]
@@ -71,11 +84,19 @@
             "category_label"        : _("Categories"),
             "category_list"         : "\n".join(category_list),
             "start_month_list"      : "\n".join(start_month_list),
-            "start_label"           : _("Start year and month"),
+            "start_label"           : _("Start month and year"),
             "start_year_default"    : start_year_default,
+            "start_criteria_label"  : _("or special criteria"),
+            "start_criteria_default": start_criteria_default,
+            "start_eval_label"      : _(">>"),
+            "start_criteria_eval"   : start_criteria_evaluated,
             "end_month_list"        : "\n".join(end_month_list),
-            "end_label"             : _("End year and month"),
+            "end_label"             : _("End month and year"),
             "end_year_default"      : end_year_default,
+            "end_criteria_label"    : _("or special criteria"),
+            "end_criteria_default"  : end_criteria_default,
+            "end_eval_label"        : _(">>"),
+            "end_criteria_eval"     : end_criteria_evaluated,
             "descriptions_label"    : _("Use descriptions from..."),
             "descriptions_list"     : "\n".join(descriptions_list),
             "format_label"          : _("Summary format"),
@@ -104,6 +125,14 @@
         </td>
     </tr>
     <tr>
+        <td class="label"><label>%(start_criteria_label)s</label></td>
+        <td>
+            <input name="start" type="text" value="%(start_criteria_default)s" size="12" />
+            <input name="start-eval" type="submit" value="%(start_eval_label)s" />
+            %(start_criteria_eval)s
+        </td>
+    </tr>
+    <tr>
         <td class="label"><label>%(end_label)s</label></td>
         <td>
             <select name="end-month">
@@ -113,6 +142,14 @@
         </td>
     </tr>
     <tr>
+        <td class="label"><label>%(end_criteria_label)s</label></td>
+        <td>
+            <input name="end" type="text" value="%(end_criteria_default)s" size="12" />
+            <input name="end-eval" type="submit" value="%(end_eval_label)s" />
+            %(end_criteria_eval)s
+        </td>
+    </tr>
+    <tr>
         <td class="label"><label>%(descriptions_label)s</label></td>
         <td class="content">
             <select name="descriptions">
diff -r 9c231d98aedb -r e5ca6e3d5301 css/event-aggregator.css
--- a/css/event-aggregator.css	Thu Jul 08 22:18:54 2010 +0200
+++ b/css/event-aggregator.css	Fri Jul 09 01:56:45 2010 +0200
@@ -39,6 +39,15 @@
     border: 1px solid #000;
 }
 
+.event-download-period {
+    display: block;
+}
+
+.event-download-period-raw {
+    display: block;
+    font-size: smaller;
+}
+
 .event-view-controls {
     text-align: right;
 }
diff -r 9c231d98aedb -r e5ca6e3d5301 macros/EventAggregator.py
--- a/macros/EventAggregator.py	Thu Jul 08 22:18:54 2010 +0200
+++ b/macros/EventAggregator.py	Fri Jul 09 01:56:45 2010 +0200
@@ -68,6 +68,18 @@
     def getQualifiedParameterName(self, argname):
         return EventAggregatorSupport.getQualifiedParameterName(self.calendar_name, argname)
 
+    def getMonthYearQueryString(self, argname, year_month, prefix=1):
+        if year_month is not None:
+            year, month = year_month.as_tuple()
+            month_argname = "%s-month" % argname
+            year_argname = "%s-year" % argname
+            if prefix:
+                month_argname = self.getQualifiedParameterName(month_argname)
+                year_argname = self.getQualifiedParameterName(year_argname)
+            return "%s=%s&%s=%s" % (month_argname, month, year_argname, year)
+        else:
+            return ""
+
     def getMonthQueryString(self, argname, month, prefix=1):
         if month is not None:
             if prefix:
@@ -83,6 +95,11 @@
             self.getQualifiedParameterName("mode"), mode or self.mode
             )
 
+    def getFullMonthLabel(self, year_month):
+        page = self.page
+        request = page.request
+        return EventAggregatorSupport.getFullMonthLabel(request, year_month)
+
     def writeDownloadControls(self):
         page = self.page
         request = page.request
@@ -98,8 +115,8 @@
             )
         download_all_link = download_dialogue_link + "&doit=1"
         download_link = download_all_link + ("&%s&%s" % (
-            self.getMonthQueryString("start", self.calendar_start, prefix=0),
-            self.getMonthQueryString("end", self.calendar_end, prefix=0)
+            self.getMonthYearQueryString("start", self.calendar_start, prefix=0),
+            self.getMonthYearQueryString("end", self.calendar_end, prefix=0)
             ))
 
         # Subscription links just explicitly select the RSS format.
@@ -131,11 +148,16 @@
 
         # Pop-up descriptions of the downloadable calendars.
 
-        calendar_period = "%s - %s" % (self.calendar_start, self.calendar_end)
+        calendar_period = "%s - %s" % (
+            self.getFullMonthLabel(self.calendar_start),
+            self.getFullMonthLabel(self.calendar_end)
+            )
         raw_calendar_period = "%s - %s" % (self.raw_calendar_start, self.raw_calendar_end)
 
         # Write the controls.
 
+        # Download controls.
+
         output.append(fmt.div(on=1, css_class="event-download-controls"))
         output.append(fmt.span(on=1, css_class="event-download"))
         output.append(linkToPage(request, page, _("Download this view"), download_link))
@@ -143,30 +165,47 @@
         output.append(fmt.text(calendar_period))
         output.append(fmt.span(on=0))
         output.append(fmt.span(on=0))
+
         output.append(fmt.span(on=1, css_class="event-download"))
         output.append(linkToPage(request, page, _("Download this calendar"), download_all_link))
         output.append(fmt.span(on=1, css_class="event-download-popup"))
+        output.append(fmt.span(on=1, css_class="event-download-period"))
+        output.append(fmt.text(calendar_period))
+        output.append(fmt.span(on=0))
+        output.append(fmt.span(on=1, css_class="event-download-period-raw"))
         output.append(fmt.text(raw_calendar_period))
         output.append(fmt.span(on=0))
         output.append(fmt.span(on=0))
+        output.append(fmt.span(on=0))
+
         output.append(fmt.span(on=1, css_class="event-download"))
         output.append(linkToPage(request, page, _("Download..."), download_dialogue_link))
         output.append(fmt.span(on=1, css_class="event-download-popup"))
         output.append(fmt.text(_("Edit download options")))
         output.append(fmt.span(on=0))
         output.append(fmt.span(on=0))
+
+        # Subscription controls.
+
         output.append(fmt.span(on=1, css_class="event-download"))
         output.append(linkToPage(request, page, _("Subscribe to this view"), subscribe_link))
         output.append(fmt.span(on=1, css_class="event-download-popup"))
         output.append(fmt.text(calendar_period))
         output.append(fmt.span(on=0))
         output.append(fmt.span(on=0))
+
         output.append(fmt.span(on=1, css_class="event-download"))
         output.append(linkToPage(request, page, _("Subscribe to this calendar"), subscribe_all_link))
         output.append(fmt.span(on=1, css_class="event-download-popup"))
+        output.append(fmt.span(on=1, css_class="event-download-period"))
+        output.append(fmt.text(calendar_period))
+        output.append(fmt.span(on=0))
+        output.append(fmt.span(on=1, css_class="event-download-period-raw"))
         output.append(fmt.text(raw_calendar_period))
         output.append(fmt.span(on=0))
         output.append(fmt.span(on=0))
+        output.append(fmt.span(on=0))
+
         output.append(fmt.span(on=1, css_class="event-download"))
         output.append(linkToPage(request, page, _("Subscribe..."), subscribe_dialogue_link))
         output.append(fmt.span(on=1, css_class="event-download-popup"))
@@ -219,9 +258,6 @@
 
         output = []
 
-        year, month = year_month.as_tuple()
-        month_label = _(EventAggregatorSupport.getMonthLabel(month))
-
         # Prepare navigation links.
 
         if self.calendar_name is not None:
@@ -249,7 +285,7 @@
 
             # A link leading to this month being at the top of the calendar.
 
-            full_month_label = "%s %s" % (month_label, year)
+            full_month_label = self.getFullMonthLabel(year_month)
             end_month = year_month.month_update(self.number_of_months - 1)
 
             month_link = self.getNavigationLink(year_month, end_month)
@@ -270,11 +306,7 @@
 
         else:
             output.append(fmt.span(on=1))
-            output.append(fmt.text(month_label))
-            output.append(fmt.span(on=0))
-            output.append(fmt.text(" "))
-            output.append(fmt.span(on=1))
-            output.append(fmt.text(unicode(year)))
+            output.append(fmt.text(full_month_label))
             output.append(fmt.span(on=0))
 
         return "".join(output)