Produits Entr'ouvert » Hobo

# hobo - portal to configure and deploy applications

# Copyright (C) 2019  Entr'ouvert

#

# This program is free software: you can redistribute it and/or modify it

# under the terms of the GNU Affero General Public License as published

# by the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from django import forms

from django.utils.translation import ugettext_lazy as _

class SettingsForm(forms.Form):

    content = forms.CharField(

        label=_('content of /robots.txt file'),

        required=False,

        widget=forms.Textarea)

class EnableForm(forms.Form):

    pass

{% extends "hobo/seo_home.html" %}

{% load i18n %}

{% block appbar %}

  <h2>{% trans 'Robots Exclusion Protocol' %}</h2>

{% endblock %}

{% block content %}

<form method="post">

  {% csrf_token %}

  {{ form.as_p }}

<p>

<div class="buttons">

<button class="submit-button">{% trans "Enable" %}</button>

<a class="cancel" href="{% url 'seo-home' %}">{% trans "Cancel" %}</a>

</div>

</form>

{% endblock %}

{% extends "hobo/base.html" %}

{% load i18n %}

{% block breadcrumb %}

{{ block.super }}

<a href="{% url 'seo-home' %}">Se</a>

{% endblock %}

{% block appbar %}

<h2>{% trans 'Search Engine Optimization' %}</h2>

<span class="actions">

  <a

    {% if mode == 'customize' %}class="disabled"{% endif %}

    rel="popup" href="{% url 'robots-customize' %}">

    {% trans 'Customize' %}

  </a>

  <a

    {% if mode == 'disallow' %}class="disabled"{% endif %}

    href="{% url 'robots-disallow' %}">

    {% trans 'Do not allow indexation' %}

  </a>

  <a

    {% if mode == 'allow' %}class="disabled"{% endif %}

    href="{% url 'robots-allow' %}">

    {% trans 'Allow indexation' %}

  </a>

</span>

{% endblock %}

{% block content %}

{% if mode == 'allow' %}

<div class="infonotice">

  <p>

    {% blocktrans %}

    Web Robots (also called "Wanderers" or "Spiders") are Web client programs that automatically traverse the Web's hypertext structure by retrieving a document, and recursively retrieving all documents that are referenced.

    Web site owners use the /robots.txt file to give instructions about their site to web robots; this is called The Robots Exclusion Protocol.

    {% endblocktrans %}

  </p>

</div>

{% endif %}

{% if mode == 'allow' %}

<div class="warningnotice">

  {% trans "Web Robots are currently allowed." %}

</div>

{% endif %}

{% if mode == 'disallow' %}

<div class="successnotice">

  {% trans "Web Robots are currently not allowed." %}

</div>

{% endif %}

{% if mode == 'customize' or mode == 'disallow' %}

<form method="post">

  {% csrf_token %}

  {{ form.as_p }}

  {% if mode == 'customize' %}

  <div class="buttons">

    <button class="submit-button">{% trans "Save" %}</button>

  </div>

  {% endif %}

</form>

{% endif %}

{% endblock %}

# hobo - portal to configure and deploy applications

# Copyright (C) 2019  Entr'ouvert

#

# This program is free software: you can redistribute it and/or modify it

# under the terms of the GNU Affero General Public License as published

# by the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from django.conf.urls import url

from . import views

urlpatterns = [

    url(r'^$', views.home, name='seo-home'),

    url(r'^allow$', views.allow, name='robots-allow'),

    url(r'^disallow$', views.disallow, name='robots-disallow'),

    url(r'^customize$', views.customize, name='robots-customize'),

]

# hobo - portal to configure and deploy applications

# Copyright (C) 2020  Entr'ouvert

#

# This program is free software: you can redistribute it and/or modify it

# under the terms of the GNU Affero General Public License as published

# by the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from django.core.urlresolvers import reverse_lazy

from django.views.generic import FormView, RedirectView

from hobo.environment.utils import get_variable

from .forms import SettingsForm

ALLOW = ""

DISALLOW = """User-agent: *

Disallow: /"""

def put_robots_txt(content):

    variable = get_variable('robots_txt')

    variable.value = content

    variable.save()

def get_mode(content):

    content = content.strip().replace('\r', '')

    if content == ALLOW:

        return 'allow'

    elif content == DISALLOW:

        return 'disallow'

    else:

        return 'customize'

class HomeView(FormView):

    template_name = 'hobo/seo_home.html'

    form_class = SettingsForm

    success_url = reverse_lazy('seo-home')

    def get_initial(self):

        initial = super(HomeView, self).get_initial()

        initial['content'] = get_variable('robots_txt').value

        initial['mode'] = get_mode(initial['content'])

        return initial

    def form_valid(self, form):

        content = form.cleaned_data['content']

        put_robots_txt(content)

        return super(HomeView, self).form_valid(form)

    def get_context_data(self, **kwargs):

        context = super(HomeView, self).get_context_data(**kwargs)

        mode = get_mode(get_variable('robots_txt').value)

        context['form'].fields['content'].disabled = mode != 'customize'

        context['mode'] = mode

        return context

home = HomeView.as_view()

class AllowView(RedirectView):

    def get_redirect_url(self):

        put_robots_txt(ALLOW)

        return reverse_lazy('seo-home')

allow = AllowView.as_view()

class DisallowView(RedirectView):

    def get_redirect_url(self):

        put_robots_txt(DISALLOW)

        return reverse_lazy('seo-home')

disallow = DisallowView.as_view()

class CustomizeView(FormView):

    template_name = 'hobo/robots_customize.html'

    form_class = SettingsForm

    success_url = reverse_lazy('seo-home')

    def get_initial(self):

        initial = super(CustomizeView, self).get_initial()

        initial['content'] = get_variable('robots_txt').value

        return initial

    def form_valid(self, form):

        content = form.cleaned_data['content']

        put_robots_txt(content)

        return super(CustomizeView, self).form_valid(form)

customize = CustomizeView.as_view()

    'hobo.seo',

    <li><a href="{% url 'seo-home' %}">{% trans 'Search Engine Optimization' %}</a></li>

from .seo.urls import urlpatterns as seo_urls

    url(r'^seo/', decorated_includes(admin_required, include(seo_urls))),

from test_manager import login

def test_unlogged_access(app):

    # connect while not being logged in

    resp = app.get('/seo/', status=302)

    assert resp.location.endswith('/login/?next=/seo/')

def test_home(app, admin_user):

    login(app)

    resp = app.get('/seo/', status=200)

    assert [

        x['href'] for x in resp.html.find('span', {'class': 'actions'}).find_all('a')

    ] == ['/seo/customize', '/seo/disallow', '/seo/allow']

    variable = get_variable('robots_txt')

    variable.value = ALLOW

    variable.save()

    resp = app.get('/seo/', status=200)

    assert 'disabled' in resp.html.find('a', {'href': '/seo/allow'})['class']

    assert not resp.html.textarea

    variable = get_variable('robots_txt')

    variable.value = DISALLOW

    variable.save()

    resp = app.get('/seo/', status=200)

    assert 'disabled' in resp.html.find('a', {'href': '/seo/disallow'})['class']

    assert resp.html.textarea.text.strip() == DISALLOW

    assert resp.html.textarea.has_attr('disabled')

    assert not resp.html.button

    variable = get_variable('robots_txt')

    variable.value = "some content"

    variable.save()

    resp = app.get('/seo/', status=200)

    assert 'disabled' in resp.html.find('a', {'href': '/seo/customize'})['class']

    assert resp.html.textarea.text.strip() == 'some content'

    assert not resp.html.textarea.has_attr('disabled')

    resp.form['content'] = 'some new content'

    resp = resp.form.submit()

    assert get_variable('robots_txt').value == 'some new content'

def test_allow(app, admin_user):

    login(app)

    variable = get_variable('robots_txt')

    variable.value = "some content"

    variable.save()

    resp = app.get('/seo/allow', status=302)

    assert resp.location.endswith('/seo/')

    assert get_variable('robots_txt').value == ALLOW

def test_disallow(app, admin_user):

    login(app)

    variable = get_variable('robots_txt')

    variable.value = "some content"

    variable.save()

    resp = app.get('/seo/disallow', status=302)

    assert resp.location.endswith('/seo/')

    assert get_variable('robots_txt').value == DISALLOW

def test_custom(app, admin_user):

    login(app)

    variable = get_variable('robots_txt')

    variable.value = "some content"

    variable.save()

    resp = app.get('/seo/customize', status=200)

    assert resp.html.textarea['name'] == 'content'

    assert resp.html.textarea.text.strip() == 'some content'

    resp.form['content'] = 'some new content'

    resp = resp.form.submit()

    assert get_variable('robots_txt').value == 'some new content'