path: root/extensions/BugmailFilter/template/en/default/account/prefs/bugmail_filter.html.tmpl

[%# This Source Code Form is subject to the terms of the Mozilla Public
  # License, v. 2.0. If a copy of the MPL was not distributed with this
  # file, You can obtain one at http://mozilla.org/MPL/2.0/.
  #
  # This Source Code Form is "Incompatible With Secondary Licenses", as
  # defined by the Mozilla Public License, v. 2.0.
  #%]

<link href="[% "extensions/BugmailFilter/web/style/bugmail-filter.css" FILTER version %]"
      rel="stylesheet" type="text/css">
<script
        src="[% "extensions/BugmailFilter/web/js/bugmail-filter.js" FILTER version %]"></script>

[% SET selectable_products = user.get_selectable_products %]
[% SET dont_show_button = 1 %]

<script>
var useclassification = false;
var first_load = true;
var last_sel = [];
var cpts = new Array();
[% n = 1 %]
[% FOREACH prod = selectable_products %]
  cpts['[% n %]'] = [
    [%- FOREACH comp = prod.components %]'[% comp.name FILTER js %]'[% ", " UNLESS loop.last %] [%- END -%] ];
  [% n = n + 1 %]
[% END %]
</script>
<script src="[% 'js/productform.js' FILTER version FILTER html %]">
</script>

<hr>
<b>Bugmail Filtering</b>

<p>
  You can instruct [% terms.Bugzilla %] to filter bugmail based on the field
  that was changed.
</p>

<table id="add_filter_table">
<tr>
  <th>Field:</th>
  <td>
    <select name="field" id="field">
      <option value="">__Any__</option>
      [% FOREACH field = field_list %]
        <option value="[% field.name FILTER html %]">
          [% field.description FILTER html %]
        </option>
      [% END %]
      <option value="~">Contains:</option>
    </select>
  </td>
  <td class="blurb">
    the field that was changed
  </td>
</tr>
<tr id="field_contains_row" class="bz_default_hidden">
  <td>&nbsp;</td>
  <td>
      <input name="field_contains" id="field_contains"
             placeholder="field name" maxlength="63">
  </td>
</tr>
<tr>
  <th>Product:</th>
  <td>
    <select name="product" id="product">
      <option value="">__Any__</option>
      [% FOREACH product IN selectable_products %]
        <option>[% product.name FILTER html %]</option>
      [% END %]
    </select>
  </td>
  <td class="blurb">
    the [% terms.bug %]'s current product
  </td>
</tr>
<tr>
  <th>Component:</th>
  <td>
    <select name="component" id="component">
      <option value="">__Any__</option>
      [% FOREACH product IN selectable_products %]
        [% FOREACH component IN product.components %]
          <option>[% component.name FILTER html %]</option>
        [% END %]
      [% END %]
    </select>
  </td>
  <td class="blurb">
    the [% terms.bug %]'s current component
  </td>
</tr>
<tr>
  <th>Relationship:</th>
  <td>
    <select name="relationship" id="relationship">
      <option value="">__Any__</option>
      [% FOREACH rel IN relationships %]
        <option value="[% rel.value FILTER html %]">
          [% rel.name FILTER html %]
        </option>
      [% END %]
    </select>
  </td>
  <td class="blurb">
    your relationship with the [% terms.bug %]
  </td>
</tr>
<tr>
  <th>Changer:</th>
  <td>
    [% INCLUDE global/userselect.html.tmpl
       id => "changer"
       name => "changer"
       size => 32
       emptyok => 1
    %]
  </td>
  <td class="blurb">
    the person who made the change (leave empty for "anyone")
  </td>
</tr>
<tr>
  <th>Action:</th>
  <td>
    <select name="action" id="action">
      <option></option>
      <option>Exclude</option>
      <option>Include</option>
    </select>
  </td>
  <td class="blurb">
    action to take when all conditions match
  </td>
</tr>
<tr>
  <td></td>
  <td><input type="submit" id="add_filter" name="add_filter" value="Add"></td>
</tr>
</table>

<hr>
<p>
  You are currently filtering on:
</p>

[% IF filters.size %]

  <table id="filters_table">
    <tr>
      <td></td>
      <th>Product</th>
      <th>Component</th>
      <th>Field</th>
      <th>Relationship</th>
      <th>Changer</th>
      <th>Action</th>
    </tr>
    [% FOREACH filter = filters %]
      <tr class="[% "row_odd" UNLESS loop.count % 2 %]">
        <td>
          <input type="checkbox" name="remove" value="[% filter.id FILTER none %]"
                 onChange="onFilterRemoveChange()">
        </td>
        <td>[% filter.product ? filter.product.name : 'Any' FILTER html %]</td>
        <td>[% filter.component ? filter.component.name : 'Any' FILTER html %]</td>
        <td>[% filter.field_description FILTER html %]</td>
        <td>[% filter.relationship ? filter.relationship_name : 'Any' FILTER html %]</td>
        <td>
          [% IF filter.changer %]
            <span title="[% filter.changer.name FILTER html %]">
              [% filter.changer.login FILTER html %]
            </span>
          [% ELSE %]
            Anyone
          [% END %]
        </td>
        <td>[% filter.action ? 'Exclude' : 'Include' %]</td>
      </tr>
    [% END %]
    <tr>
      <td></td>
      <td><input id="remove" name="remove_filter" type="submit" value="Remove Selected"></td>
    </tr>
  </table>

[% ELSE %]

  <p>
    <i>You do not have any filters configured.</i>
  </p>

[% END %]

<hr>
<p>
  This feature provides fine-grained control over what changes to [% terms.bugs
  %] will result in an email notification.  These filters are applied
  <b>after</b> the rules configured on the
  <a href="userprefs.cgi?tab=email">Email Preferences</a> tab.
</p>
<p>
  If multiple filters are applicable to the same [% terms.bug %] change,
  <b>include</b> filters override <b>exclude</b> filters.
</p>

<hr>
<h4>Field Groups</h4>

<p>
  Some fields are grouped into a single entry in the "field" list.
  Following is a list of the groups and all the fields they contain:
</p>

[% FOREACH type = tracking_flags_by_type %]
  [% type.name FILTER html %]:
  <blockquote>
    [% flag_count = type.flags.size %]
    [% FOREACH flag = type.flags %]
      [% IF flag_count > 10 && loop.count == 10 %]
        <span id="show_all">
          &hellip;
          (<a href="#" onclick="showAllFlags(); return false">show all</a>)
        </span>
        <span id="all_flags" class="bz_default_hidden">
      [% END %]
      [% flag.description FILTER html FILTER no_break %]
      [% ", " UNLESS loop.last %]
      [% IF loop.last && flag_count > 10 %]
        </span>
      [% END %]
    [% END %]
  </blockquote>
[% END %]

<hr>
<h4>Examples</h4>
<p>
  To never receive changes made to the "QA Whiteboard" field for [% terms.bugs %]
  where you are not the assignee:<br>
</p>
<table class="example_filter_table">
  <tr>
    <th>Field:</th>
    <td>QA Whiteboard</td>
  </tr>
  <tr>
    <th>Product:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Component:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Relationship:</th>
    <td>Not Assignee</td>
  </tr>
  <tr>
    <th>Changer:</th>
    <td>(empty)</td>
  </tr>
  <tr>
    <th>Action:</th>
    <td>Exclude</td>
  </tr>
</table>

<p>
  To never receive email for any change made by webops-kanban@mozilla.bugs:
</p>
<table class="example_filter_table">
  <tr>
    <th>Field:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Product:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Component:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Relationship:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Changer:</th>
    <td>webops-kanban@mozilla.bugs</td>
  </tr>
  <tr>
    <th>Action:</th>
    <td>Exclude</td>
  </tr>
</table>

<p>
  To receive notifications of new [% terms.bugs %] in Firefox's "New Tab Page"
  component, and no other changes, you require three filters.  First an
  <b>exclude</b> filter to drop all changes made to [% terms.bugs %] in that
  component:<br>
</p>
<table class="example_filter_table">
  <tr>
    <th>Field:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Product:</th>
    <td>Firefox</td>
  </tr>
  <tr>
    <th>Component:</th>
    <td>New Tab Page</td>
  </tr>
  <tr>
    <th>Relationship:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Changer:</th>
    <td>(empty)</td>
  </tr>
  <tr>
    <th>Action:</th>
    <td>Exclude</td>
  </tr>
</table>
<p>
  Then an <b>include</b> filter to indicate that you want to receive
  notifications when a [% terms.bug %] is created:
</p>
<table class="example_filter_table">
  <tr>
    <th>Field:</th>
    <td>[% terms.Bug %] Created</td>
  </tr>
  <tr>
    <th>Product:</th>
    <td>Firefox</td>
  </tr>
  <tr>
    <th>Component:</th>
    <td>New Tab Page</td>
  </tr>
  <tr>
    <th>Relationship:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Changer:</th>
    <td>(empty)</td>
  </tr>
  <tr>
    <th>Action:</th>
    <td>Include</td>
  </tr>
</table>
<p>
  And finally another <b>include</b> filter to catch when a [% terms.bug %] is
  moved into the "New Tab Page" component.
</p>
<table class="example_filter_table">
  <tr>
    <th>Field:</th>
    <td>Component</td>
  </tr>
  <tr>
    <th>Product:</th>
    <td>Firefox</td>
  </tr>
  <tr>
    <th>Component:</th>
    <td>New Tab Page</td>
  </tr>
  <tr>
    <th>Relationship:</th>
    <td>__Any__</td>
  </tr>
  <tr>
    <th>Changer:</th>
    <td>(empty)</td>
  </tr>
  <tr>
    <th>Action:</th>
    <td>Include</td>
  </tr>
</table>