{% extends "varnish-bans-manager/core/bans/layout.html" %}
{% load i18n %}
{% load url from future %}
{% load vbm_widget_helpers %}
{% load vbm_form_helpers %}

{% block title %}{% trans 'Bans' %} > {% trans 'Expert' %}{% endblock %}

{% block sidebar_section %}expert{% endblock %}

{% block sidebar_content %}
  <div class="page-header">
    <h1>
      {% trans 'Submit ban' %}
      <small>{% trans 'Invalidate contents currently in the cache' %}</small>
    </h1>
  </div>

  <div id="breadcrumb">
    <i class="font-awesome font-awesome-home"></i>
    <span class="item">{% trans 'Bans' %}</span>
    <a href="{% url 'bans-expert' %}" class="navigation current">{% trans 'Expert' %}</a>
  </div>

  <div class="row-fluid">
    <div class="widget-box">
      <div class="widget-title">
        <span class="icon"><i class="icon-cog"></i></span>
        <h3>{% trans 'Set and submit your ban' %}</h3>
      </div>
      <div class="widget-content">
        <form class="ajax nomargin" data-url="{% url 'bans-expert' %}">
          {% form_cgroup form.ban_expression 'span12' %}
            {{ form.ban_expression.label_tag }}
            <div class="controls">
              {{ form.ban_expression|add_class:"span12" }}
            </div>
            {% form_ferrors form.ban_expression 'block' %}
          {% endform_cgroup %}

          <div class="row-fluid">
            {% form_cgroup form.target 'span6' %}
              {{ form.target.label_tag }}
              <div class="controls">
                {{ form.target|add_class:"span12" }}
              </div>
              {% form_ferrors form.target 'block' %}
            {% endform_cgroup %}
          </div>

          <div class="pull-right">
            <button class="btn btn-primary" type="submit"><i class="icon-ok icon-white"></i> {% trans 'Submit' %}</button>
          </div>
        </form>
      </div>
    </div>
  </div>

  <h1 class="section">{% trans 'Ban expressions' %}</h1>
  <div class="row-fluid">
    <div class="span8">
      <p>
        {% blocktrans with 'https://www.varnish-cache.org/docs/trunk/reference/varnish-cli.html#ban-expressions' as exprs %}
          A <a href="{{ exprs }}">ban expression</a> may be composed of several
          conditions combined using a logical AND operator (<code>&&</code>).
          Each condition should consist of a field, an operator and an argument.
        {% endblocktrans %}
      </p>
      <ul>
        <li>
          {% blocktrans with 'https://www.varnish-cache.org/docs/trunk/reference/vcl.html#variables' as vars %}
            A field can be any of the <a href={{ vars }}"">variables from VCL</a>, for instance
            <code>req.url</code> (requested URL), <code>req.http.host</code>
            (requested host) or <code>obj.http.set-cookie</code> (returned value
            for the HTTP Set-Cookie header).
          {% endblocktrans %}
        </li>
        <li>
          {% blocktrans %}
            Operators are <code>==</code> for direct comparision, <code>~</code> for
            a regular expression match, and <code>&gt;</code> or <code>&lt;</code>
            for size comparisons. Prepending an operator with <code>!</code> negates
            the expression.
          {% endblocktrans %}
        </li>
        <li>
          {% blocktrans %}
            The argument could be a quoted string, a regular expression or an
            integer. Integers can have <code>KB</code>, <code>MB</code>,
            <code>GB</code> or <code>TB</code> appended for size related fields.
          {% endblocktrans %}
        </li>
      </ul>
    </div>
    <div class="span4">
      <div class="widget-box nomargin">
        <div class="widget-title">
          <span class="icon"><i class="icon-bookmark"></i></span>
          <h3>{% trans 'References' %}</h3>
        </div>
        <div class="widget-content nopadding">
          <ul class="simple-list">
            <li><a href="https://www.varnish-cache.org/docs/trunk/users-guide/purging.html#bans"><i class="icon-book"></i> <strong>{% trans 'Bans overview' %}</strong></a></li>
            <li><a href="https://www.varnish-cache.org/docs/trunk/reference/varnish-cli.html#ban-expressions"><i class="icon-book"></i> <strong>{% trans 'Ban expressions' %}</strong></a></li>
            <li><a href="https://www.varnish-cache.org/docs/trunk/reference/vcl.html#variables"><i class="icon-book"></i> <strong>{% trans 'Ban variables' %}</strong></a></li>
            <li><a href="https://www.varnish-cache.org/docs/trunk/users-guide/"><i class="icon-book"></i> <strong>{% trans 'Varnish users guide' %}</strong></a></li>
            <li><a href="https://www.varnish-cache.org/docs/trunk/reference/"><i class="icon-book"></i> <strong>{% trans 'Varnish reference' %}</strong></a></li>
          </ul>
        </div>
      </div>
    </div>
  </div>

  <h1 class="section">{% trans 'Examples' %}</h1>
  <ol>
    <li>
      {% trans 'To ban a particular content (requested URL):' %}
      <p><pre>req.url == /path/to/content</pre></p>
    </li>
    <li>
      {% trans 'To ban all PDF files in the virtual host <code>example.com</code>:' %}
      <p><pre>req.url ~ "\.pdf$" && req.http.host == example.com</pre></p>
    </li>
    <li>
      {% blocktrans with 'https://www.varnish-software.com/blog/ban-lurker' as lurker %}
        Same as before but using a <a href="{{ lurker }}">lurker friendly ban</a> (recommended approach that requires some tunning of the VCL):
      {% endblocktrans %}
      <p><pre>obj.http.x-url ~ "\.pdf$" && obj.http.x-host == example.com</pre></p>
    </li>
  </ol>
{% endblock %}