views.py 50.6 KB
Newer Older
BERJON Matthieu's avatar
BERJON Matthieu committed
1
2
3
4
5
6
7
8
9
10
11
# -*- coding: utf-8 -*-
"""Main view module

This module handles most of the front-end for the Allgo system. You'll find
all the logic (controller) in an MVC pattern.

Attributes:
    log: module level variable to save information as a log data.

"""
# Python standard libraries
12
import glob
BERJON Matthieu's avatar
BERJON Matthieu committed
13
import io
14
15
import json
import logging
16
import re
17
import os
18
import re
19
import shutil
20
import tempfile
21
import zipfile
22

BERJON Matthieu's avatar
BERJON Matthieu committed
23
# Third party imports
24
25
26
import iso8601
import natsort
import requests
27
from django.conf import settings
28
from django.contrib import messages
29
from django.contrib.auth.forms import PasswordChangeForm
30
from django.contrib.auth.mixins import LoginRequiredMixin
BERJON Matthieu's avatar
BERJON Matthieu committed
31
from django.contrib.auth.models import User
32
from django.contrib.messages.views import SuccessMessageMixin
33
from django.core.exceptions import ObjectDoesNotExist
CAMPION Sebastien's avatar
CAMPION Sebastien committed
34
from django.core.urlresolvers import reverse
35
from django.db import transaction
BERJON Matthieu's avatar
BERJON Matthieu committed
36
from django.db.models import Count
37
from django.http import HttpResponse, JsonResponse, HttpResponseRedirect, FileResponse, Http404
BERJON Matthieu's avatar
BERJON Matthieu committed
38
from django.shortcuts import render, get_object_or_404, redirect
39
from django.urls import reverse, reverse_lazy
40
from django.utils.crypto import get_random_string
41
from django.utils.text import slugify
42
from django.views.decorators.csrf import csrf_exempt
BERJON Matthieu's avatar
BERJON Matthieu committed
43
from django.views.generic import (
CAMPION Sebastien's avatar
pep8    
CAMPION Sebastien committed
44
45
46
    CreateView,
    DeleteView,
    DetailView,
47
    FormView,
CAMPION Sebastien's avatar
pep8    
CAMPION Sebastien committed
48
49
50
51
52
    ListView,
    RedirectView,
    TemplateView,
    UpdateView,
    View,
BERJON Matthieu's avatar
BERJON Matthieu committed
53
)
54
from django.views.generic.detail import SingleObjectMixin
BERJON Matthieu's avatar
BERJON Matthieu committed
55
from taggit.models import Tag
56
from allauth.account.models import EmailAddress
BERJON Matthieu's avatar
BERJON Matthieu committed
57

BERJON Matthieu's avatar
BERJON Matthieu committed
58
from .forms import (
CAMPION Sebastien's avatar
cosmit    
CAMPION Sebastien committed
59
60
61
62
63
64
    UserForm,
    HomeSignupForm,
    UserWebappForm,
    JobForm,
    SSHForm,
    RunnerForm,
65
66
    WebappForm,
    WebappSandboxForm,
67
    WebappImportForm,
CAMPION Sebastien's avatar
cosmit    
CAMPION Sebastien committed
68
)
CAMPION Sebastien's avatar
pep8    
CAMPION Sebastien committed
69
# Local imports
BAIRE Anthony's avatar
BAIRE Anthony committed
70
import config
71
from .helpers import get_base_url, get_ssh_data, upload_data, notify_controller, lookup_job_file, get_request_user
72
from .mixins import IsProviderMixin, JobAuthMixin
CAMPION Sebastien's avatar
pep8    
CAMPION Sebastien committed
73
74
from .models import (
    AllgoUser,
75
    DockerOs,
CAMPION Sebastien's avatar
pep8    
CAMPION Sebastien committed
76
    Job,
77
    JobQueue,
CAMPION Sebastien's avatar
pep8    
CAMPION Sebastien committed
78
79
80
    Quota,
    Runner,
    Webapp,
81
    WebappParameter,
CAMPION Sebastien's avatar
pep8    
CAMPION Sebastien committed
82
83
    WebappVersion,
)
BAIRE Anthony's avatar
BAIRE Anthony committed
84
from .signals import job_post_save
85
from .templatetags.converters import status_icon
BERJON Matthieu's avatar
BERJON Matthieu committed
86

BERJON Matthieu's avatar
BERJON Matthieu committed
87
# Start logger
88
log = logging.getLogger('allgo')
CAMPION Sebastien's avatar
CAMPION Sebastien committed
89

90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
def error_handler(status, reason, default, request, exception=None):
    """Generic error handler

    Since django is unable to handle per-app error handlers, we have to define
    global ones.

    The behaviour of this view is to generate a json-formatted message
    {"error": "something"} when the url starts with /api/, otherwise it just
    uses django's default error handler.
    """
    if request.path_info.startswith("/api/"):
        return JsonResponse({"error": "%d %s" % (status, reason)}, status=status)
    else:
        return default(request, exception)

CAMPION Sebastien's avatar
CAMPION Sebastien committed
105

BERJON Matthieu's avatar
BERJON Matthieu committed
106
107
108
109
110
111
112
113
114
115
class IndexDetail(TemplateView):
    """Home view

    Generate the home as a standard `TemplateView` by calling a specific
    template. Most of the data are handled in the template itself, only few
    contexte data are provided for specific use.

    Attributes:
        template_name:  filename of the template used.

116
    """
BERJON Matthieu's avatar
BERJON Matthieu committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
    template_name = 'home.html'

    def get_context_data(self, **kwargs):
        """ Generate specific data to pass on in the context of the template.

        Returns:
            user_nb (int): number of users recorded in the database.
            webapp_nb (int): number of webapps recorded in the database.
            job_nb (int): number of jobs recorded in the database.
            signup_form: form specific for signin-up directly on the home page.
        """
        context = super(IndexDetail, self).get_context_data(**kwargs)
        users = User.objects.all().count()
        webapps = Webapp.objects.all().count()
        jobs = Job.objects.all().count()

        context['user_nb'] = users
        context['webapp_nb'] = webapps
        context['job_nb'] = jobs
        context['signup_form'] = HomeSignupForm()

        return context
BERJON Matthieu's avatar
BERJON Matthieu committed
139
140


BAIRE Anthony's avatar
BAIRE Anthony committed
141
142
143
144
145
146
147
148
149
# Legacy views
class LegacyWebappDetail(SingleObjectMixin, RedirectView):
    model = Webapp
    permanent = True
    slug_field = "docker_name"
    def get_redirect_url(self, **kwargs):
        return reverse("main:webapp_detail",
                args=(self.get_object().docker_name,))

150
151
# WEBAPPS
# -----------------------------------------------------------------------------
152
class WebappList(ListView):
BERJON Matthieu's avatar
BERJON Matthieu committed
153
    """ Display a paginated list of available webapps.
154

BERJON Matthieu's avatar
BERJON Matthieu committed
155
156
    The webapps are filtered from the most recent to the oldest and no private
    apps are displayed.
157

BERJON Matthieu's avatar
BERJON Matthieu committed
158
159
160
161
162
163
164
    Attributes:
        model:  Webapp model is used.
        context_object_name:    the name used in the template to display each
                                variable.
        paginate_by: the number of occurences per page
        template_name: name of the template loaded with this view.
        queryset: a specific queryset designed to filter the data.
165

BERJON Matthieu's avatar
BERJON Matthieu committed
166
167
168
    Todo:
        - the number of occurences per page could be loaded from the config
        file.
169
170

    """
BERJON Matthieu's avatar
BERJON Matthieu committed
171
    model = Webapp
BERJON Matthieu's avatar
BERJON Matthieu committed
172
    context_object_name = 'webapps'
BERJON Matthieu's avatar
BERJON Matthieu committed
173
174
    paginate_by = 10
    template_name = 'webapp_list.html'
175
    queryset = Webapp.objects.filter(private=0).order_by('-created_at')
176

BERJON Matthieu's avatar
BERJON Matthieu committed
177

BERJON Matthieu's avatar
BERJON Matthieu committed
178
class UserWebappList(ListView):
BERJON Matthieu's avatar
BERJON Matthieu committed
179
180
181
182
183
184
185
186
187
188
189
190
191
    """List of user's webapp

    Returns all the webapps owned by a specific user. Only the user can its
    apps.

    Attributes:
        model: database model
        context_object_name: variable name used in the template to display the
                            data.
        paginate_by: number of occurences by page.
        template_name: template filename.
                            
    """
BERJON Matthieu's avatar
BERJON Matthieu committed
192
193
194
195
196
197
198
199
200
201
202
203
204
    model = Webapp
    context_object_name = 'webapps'
    paginate_by = 10
    template_name = 'webapp_list.html'

    def get_queryset(self):
        """Filter apps for a given user"""
        user = User.objects.get(username=self.kwargs['username'])
        queryset = Webapp.objects.filter(user=user)
        return queryset


class WebappUpdate(SuccessMessageMixin, LoginRequiredMixin, UpdateView):
BERJON Matthieu's avatar
BERJON Matthieu committed
205
206
207
208
209
210
211
212
    """Form to update the webapp data

    Attributes:
        form_class: form object.
        template_name: template filename.
        success_message: message when the form is properly submitted.

    """
BERJON Matthieu's avatar
BERJON Matthieu committed
213
    form_class = UserWebappForm
214
    template_name = 'webapp_update.html'
BERJON Matthieu's avatar
BERJON Matthieu committed
215
    success_message = 'Your app has been successfully updated.'
216
    error_message = 'The email doesn\'t belong to any registered user. Please enter a valid owner email address.'
BERJON Matthieu's avatar
BERJON Matthieu committed
217
218

    def get_success_url(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
219
        """If successful redirect to the same page"""
BERJON Matthieu's avatar
BERJON Matthieu committed
220
221
222
        return reverse('main:webapp_update', args=(self.object.docker_name,))

    def get_object(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
223
        """Returns the object according to its docker name or a 404 error"""
BERJON Matthieu's avatar
BERJON Matthieu committed
224
225
226
227
        data = self.kwargs.get('docker_name', None)
        queryset = get_object_or_404(Webapp, docker_name=data, user_id=self.request.user.id)
        return queryset

228
229
230
231
232
233
    def get_form(self):
        form = super().get_form()
        if not self.request.user.is_superuser:
            form.fields['memory_limit_mb'].widget.attrs['readonly'] = True
        return form

BERJON Matthieu's avatar
BERJON Matthieu committed
234
    def form_valid(self, form):
BERJON Matthieu's avatar
BERJON Matthieu committed
235
        """Save data coming from the form in the database """
BERJON Matthieu's avatar
BERJON Matthieu committed
236
237
238
239
        obj = form.save(commit=False)
        try:
            user = User.objects.get(username=form.cleaned_data['owner'])
            obj.user_id = user.id
240
            obj.memory_limit = form.get_memory_limit(self.request)
BERJON Matthieu's avatar
BERJON Matthieu committed
241
            form.save()
BERJON Matthieu's avatar
BERJON Matthieu committed
242
243
            # Add the tag to the database (specific because it's a many to 
            # many relationship)
244
            form.save_m2m()
BERJON Matthieu's avatar
BERJON Matthieu committed
245
            if user != self.request.user:
246
                messages.success(self.request, self.success_message)
BERJON Matthieu's avatar
BERJON Matthieu committed
247
248
249
250
                return redirect('main:user_webapp_list', self.request.user.username)
            else:
                return super(WebappUpdate, self).form_valid(form)
        except User.DoesNotExist:
251
            messages.error(self.request, self.error_message)
BERJON Matthieu's avatar
BERJON Matthieu committed
252
253
254
            return super(WebappUpdate, self).form_invalid(form)


255
class WebappCreate(SuccessMessageMixin, LoginRequiredMixin, IsProviderMixin, CreateView):
BERJON Matthieu's avatar
BERJON Matthieu committed
256
257
258
259
260
261
262
263
264
265
    """Create a new webapp

    Attributes:
        model: model to use in this class.
        form_class: form object passed to the template.
        success_message: successfull message sent to the template
        template_name: template filename.
        group_required: groups that user must belong to.

    """
266
267
268
    model = Webapp
    form_class = WebappForm
    success_message = 'Webapp created successfully.'
269
    template_name = 'webapp_add.html'
270
    #  group_required = ['inria', ]
271
272

    def get_success_url(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
273
        """If successful redirect to the webapp list page"""
274
        return reverse('main:webapp_sandbox_panel', args=(self.webapp.docker_name,))
275

276
277
278
279
280
281
    def get_form(self):
        form = super().get_form()
        if not self.request.user.is_superuser:
            form.fields['memory_limit_mb'].widget.attrs['readonly'] = True
        return form

282
    def form_valid(self, form):
BERJON Matthieu's avatar
BERJON Matthieu committed
283
        """Save data coming from the form in the database """
284
285
286
287
        obj = form.save(commit=False)
        obj.user_id = self.request.user.id
        if not form.cleaned_data['contact']:
            obj.contact = self.request.user.email
288
        obj.sandbox_state = Webapp.IDLE
289
290
291
        # Ensure that all specials characters are removed, spaces are replaced
        # by hyphens and everything is lower-cased
        obj.docker_name = slugify(form.cleaned_data['name'])
292
        obj.memory_limit = form.get_memory_limit(self.request)
293
294
295
296
297
298
299
300
301
302

        # validate the Webapp record before saving
        # (this is a safety measure, do not remove)
        # FIXME: currently this raises an exception if the slugify-generated
        #        docker_name does not comply with the model constraints
        #        (for example: 'root' and 'sshd' are reserved names)
        #        To solve this, i think we should let the user choose the
        #        docker_name
        obj.full_clean()

303
304
305
306
        obj.save()

        # set up the docker container for the app
        Quota.objects.create(user=self.request.user, webapp=obj)
307
308
309
310
        # pass on the webapp data to get_successful_url to redirect with the
        # correct arguments (for instance the docker_name)
        self.webapp = obj
        return super().form_valid(form)
BERJON Matthieu's avatar
BERJON Matthieu committed
311

312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
def get_rails_webapp_metadata(*, webapp_id=None, docker_name=None):
    """Download the metadata of a webapp from the legacy rails server
    
    Must provide either `webapp_id` or `docker_name`, but not both
    """
    assert bool(webapp_id) != bool(docker_name)

    if docker_name:
        url = "%s/app/%s/export" % (config.env.ALLGO_IMPORT_URL, docker_name)
    else:
        url = "%s/webapp/%d/export" % (config.env.ALLGO_IMPORT_URL, webapp_id)
    try:
        # use a 1s timeout to avoid blocking the django thread if the rails
        # server is not responding
        rep = requests.get(url, timeout=1)
        if rep.status_code == 404:
            raise Http404()
        rep.raise_for_status()
        js = rep.json()
        if (webapp_id not in (None, js["id"])
                or docker_name not in ("", js["docker_name"])):
            raise Exception("rails returned a webapp with inconsistent id or docker_name")
        return js
    except Exception as e:
        log.error("webapp import error: failed to get %s (%s)", url, e)
        raise

class WebappImport(SuccessMessageMixin, LoginRequiredMixin, IsProviderMixin, FormView):
    """Import a new webapp

    This only creates the Webapp entry (along with the tags and webapp
    parameters), versions are imported separately.

    Once the webapp is imported, the Webapp entry is created with
    imported=True which enables the WebappVersionImport view (for import the
    actual versions, including the docker images).

    A webapp can be imported only if the e-mail of the current user strictly
    matches the owner e-mail of the imported app. If not, then the app has to
    be imported by a superuser, who can then transfer its ownership to the
    requesting user.

    An imported webapp will keep the same id and docker_name (to preserve the
    published urls). The import fails the id or docker_name is already used by
    another webapp.

    """
    model = Webapp
    form_class = WebappImportForm
    success_message = 'Webapp imported successfully.'
    template_name = 'webapp_import.html'

    def get_success_url(self):
        return reverse('main:webapp_version_import', args=(self.object.docker_name,))

    def get_context_data(self, **kwargs):
        ctx=super().get_context_data()
        ctx["import_url"] = config.env.ALLGO_IMPORT_URL+"/apps"
        return ctx

    def form_valid(self, form):
        def error(msg = "500 Internal Server Error"):
            messages.error(self.request, "Import failed : " + msg)
            return self.form_invalid(form)

        # parse the form parameters an prepare the import url
        webapp_id = form.cleaned_data["webapp_id"]
        docker_name = form.cleaned_data["docker_name"]
        if bool(webapp_id) == bool(docker_name):
            return error("You must provide either a name or an id")
            
        # get the metadata from the rails server an store them in var 'js'
        try:
            js = get_rails_webapp_metadata(webapp_id=webapp_id,
                    docker_name=docker_name)
        except Http404:
            return error("application not found")
        except Exception as e:
            return error()

        webapp_id   = js["id"]
        docker_name = js["docker_name"]

        # ensure this app does not already exist locally
        if Webapp.objects.filter(docker_name=docker_name).exists():
            return error("webapp named %r already exists" % docker_name)
        if Webapp.objects.filter(id=webapp_id).exists():
            return error("webapp id %r already exists" % webapp_id)
        
        current_user = self.request.user
        if not current_user.is_superuser:
403
404
405
406
            # get the user EmailAddress that matches the owner of the imported app
            email_addr = EmailAddress.objects.filter(
                    user=current_user, email=js["user"]).first()

407
            # ensure this app has the same owner
408
            if email_addr is None:
409
410
411
412
413
                return error("""this webapp belongs to another user (if you think
                it really belongs to you, then you should contact the
                administrators)""")

            # ensure the user email is verified
414
415
416
            if not email_addr.verified:
                email_addr.send_confirmation(request)
                return redirect("account_email_verification_sent")
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539

        # We can import the webapp !

        webapp = Webapp(user=current_user, imported=True,
                docker_os=DockerOs.objects.first())
        # TODO: import logo+readme (but they are not yet implemented in django)
        for field_name in ("id", "docker_name", "name", "description",
                "contact", "default_quota", "entrypoint", "private",
                "memory_limit"):
            setattr(webapp, field_name, js[field_name])

        # try to use job queue with same name or fallback to the default queue
        webapp.job_queue = JobQueue.objects.filter(name=js["default_job_queue"]
                ).first() or JobQueue.objects.filter(is_default=True).first()

        webapp.save()

        # import the tags and parameters
        webapp.tags.add(*js["tags"])
        for param in js["parameters"]:
            if (param["value"], param["name"], param["detail"]) != (
                    None, None, None):
                WebappParameter.objects.create(webapp=webapp,
                        name=param["name"], value=param["value"],
                        detail=param["detail"])

        self.object = webapp
        return super().form_valid(form)

class WebappVersionImport(LoginRequiredMixin, DetailView):
    """Import version

    This view is enabled only for webapps created with imported=True

    The GET view lists the current status of remote version along with the
    local version (if any). If the remote version can be imported, it displays
    a checkbox to allow requesting its import.

    The POST view creates the WebappVersion entries with state=IMPORT and
    notifies the controller (which performs the actual import). The import is
    considered done as soon as the entry reaches the COMMITTED state.
    """
    template_name = 'webapp_version_import.html'

    def get_object(self):
        """Returns the object according to its docker name or a 404 error"""
        data = self.kwargs.get('docker_name', None)
        queryset = get_object_or_404(Webapp, docker_name=data, user_id=self.request.user.id)
        return queryset

    def get_context_data(self, **kwargs):
        ctx = super().get_context_data(**kwargs)
        webapp = self.object

        if not webapp.imported:
            raise Http404()

        # url of this webapp on the legacy server
        ctx["import_url"] = "%s/app/%s" % (
                config.env.ALLGO_IMPORT_URL, webapp.docker_name)

        # get the webapp metadata from the legacy server
        remote_versions = get_rails_webapp_metadata(
                docker_name=webapp.docker_name)["versions"]

        # dict of local webapp versions (indexed by the number) 
        # (if multiple entries exist with the same number (this happens if a
        # commit/push/import is in progress), we keep the one with the highest
        # id)
        local_versions = {}
        for v in WebappVersion.objects.filter(webapp=webapp).exclude(
                state__in=(WebappVersion.ERROR,
                    WebappVersion.REPLACED)).order_by("id"):
            local_versions[v.number] = v

        # list of versions to be displayed on the page
        versions = {}
        for remote in remote_versions:
            number = remote["number"]
            assert number not in versions, "rails must not export duplicated versions"
            local_version = local_versions.get(number)
            in_progress = getattr(local_version, "state", None) == WebappVersion.IMPORT
            versions[number] = {
                    "number":    number,
                    "remote_ts": iso8601.parse_date(remote["updated_at"]),
                    "local_ts":         "-" if in_progress else getattr(local_version, "updated_at", ""),
                    "local_imported":   None if in_progress else getattr(local_version, "imported", None),
                    "in_progress":      in_progress,
                    }
        ctx["versions"] = natsort.versorted(versions.values(),
                key=lambda v: v["number"], reverse=True)

        return ctx

    def post(self, request, *, docker_name):
        webapp = self.get_object()
        if not webapp.imported:
            raise Http404()

        remote_versions = get_rails_webapp_metadata(
                docker_name=webapp.docker_name)["versions"]

        for remote in remote_versions:
            number = remote["number"]
            if request.POST.get("version_"+number):
                log.info("import version %s", number)
                version = WebappVersion.objects.update_or_create({
                    "imported": True,
                    "published":         remote["published"],
                    "description":       remote["changelog"],
                    "docker_image_size": remote["docker_image_size"],
                    },
                    webapp=webapp,
                    number=number,
                    state=WebappVersion.IMPORT)[0]
                version.created_at = remote["created_at"]
                version.updated_at = remote["updated_at"]
                version.save()

        transaction.on_commit(lambda: notify_controller(webapp))

        return HttpResponseRedirect(request.path_info)

BERJON Matthieu's avatar
BERJON Matthieu committed
540

541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
class WebappJson(LoginRequiredMixin, DetailView):
    """json variant of the application details
    
    (used by the /aio/apps/<DOCKER_NAME>/events endpoint)
    """

    def get_object(self):
        """Returns the object according to its docker name or a 404 error"""
        data = self.kwargs.get('docker_name', None)
        queryset = get_object_or_404(Webapp, docker_name=data)
        return queryset

    def render_to_response(self, context, **kwargs):
        webapp = context["webapp"]
        return JsonResponse({
            "id":               webapp.id,
            "sandbox_state":    webapp.get_sandbox_state_display(),
            })

560
class WebappSandboxPanel(LoginRequiredMixin, TemplateView):
BERJON Matthieu's avatar
BERJON Matthieu committed
561
562
563
564
565
566
567
568
    """Create a new sandbox for a given application

    Attributes:
        form_class: form object to pass on the template.
        model: model to use in this class
        template_name: template filename

    """
569
    template_name = 'webapp_sandbox_panel.html'
570
571

    def get_object(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
572
        """Returns the object according to its docker name or a 404 error"""
573
        data = self.kwargs.get('docker_name', None)
574
        queryset = get_object_or_404(Webapp, docker_name=data, user_id=self.request.user.id)
575
576
577
        return queryset

    def get_context_data(self, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
578
579
580
581
582
583
584
        """Recover data to pass on to the template context
        
        In order to give the user a feedback regarding the way to push its image
        to the registry, we need to pass both the webapp `docker_name` and the
        `registry` URL.

        """
585
        context = super().get_context_data(**kwargs)
586
        context['webapp'] = self.get_object()
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601

        context["ssh_command"] = "ssh%s %s@%s" % (
                (" -p %s" % config.env.ALLGO_SSH_PORT
                    if config.env.ALLGO_SSH_PORT != "22" else ""),
                (kwargs["docker_name"]),
                (config.env.ALLGO_SSH_HOST))

        # candidate docker os (start from scratch)
        context['docker_os_list'] = DockerOs.objects.all()

        # candidate versions (start from an existing version)
        versions = {}
        for state in (WebappVersion.READY, WebappVersion.COMMITTED):
            versions.update((v.number, v) for v in WebappVersion.objects.filter(
                webapp=context["webapp"], state=state))
602
603
        context['versions'] = natsort.versorted(versions.values(), key=lambda v: v.number)
        context['versions'].reverse()
604
605
        return context

606
607
608
    def post(self, request, *, docker_name):
        log.info("POST %r", request.POST)

609
        webapp = self.get_object()
610
611
        action = request.POST["action"]

BAIRE Anthony's avatar
BAIRE Anthony committed
612
613
614
615
616
        def stop_sandbox():
            webapp.sandbox_state = Webapp.STOPPING
            webapp.sandbox_version_id = None
            webapp.save()

617
618
        log.info("action %r", request.POST["action"])
        if action == "start":
BAIRE Anthony's avatar
BAIRE Anthony committed
619
620
621
622
623
            if webapp.sandbox_state != Webapp.IDLE:
                messages.error(request,
                        "unable to start sandbox %r because it not idle"
                        % webapp.name)
            else:
624
625
626
627
628
629
630
631
632
                if "webapp_version_id" in request.POST:
                    # start from an existing version
                    webapp.sandbox_version_id = int(request.POST["webapp_version_id"])
                else:
                    # start from scratch
                    webapp.docker_os_id = request.POST["docker_os_id"]
                    webapp.sandbox_version = None
                webapp.sandbox_state = Webapp.STARTING
                webapp.save()
BAIRE Anthony's avatar
BAIRE Anthony committed
633
                messages.success(request, "starting sandbox %r" % webapp.name)
634
635

        elif action == "commit":
BAIRE Anthony's avatar
BAIRE Anthony committed
636
637
638
639
640
            if webapp.sandbox_state != Webapp.RUNNING:
                messages.error(request,
                        "unable to commit sandbox %r because it is not running"
                        % webapp.name)
            else:
641
642
643
644
645
                # query previous active versions of this webapp
                previous = WebappVersion.objects.filter(webapp=webapp,
                            state__in = (WebappVersion.READY, WebappVersion.COMMITTED))
                extra = {}

646
647
                if request.POST["version-action"] == "replace-version":
                    number = request.POST["version-select"]
648
649
                    # keep the previous 'created_at' timestamp when replacing an image
                    extra["created_at"] = getattr(previous.filter(number=number).first(), "created_at")
650
651
                else:
                    number = request.POST["version-new"]
652
653
654

                    # ensure that this version number does not already exist
                    if previous.filter(number=number).exists():
655
656
657
                        messages.error(request, "unable to commit because version %r already exists"
                                " (if you want to overwrite this version, then use"
                                "  'replace version' instead)" % number)
BAIRE Anthony's avatar
BAIRE Anthony committed
658
                        return HttpResponseRedirect(request.path_info)
659

660
661
                WebappVersion.objects.create(
                        webapp=webapp,
662
                        number=number,
663
664
                        state=WebappVersion.SANDBOX,
                        published=True,
665
                        description=request.POST["description"],
666
                        **extra)
BAIRE Anthony's avatar
BAIRE Anthony committed
667
                stop_sandbox()
668

BAIRE Anthony's avatar
BAIRE Anthony committed
669
670
                messages.success(request, "committing sandbox %r version %r"
                        % (webapp.name, number))
671

672
673
        elif action == "rollback":
            if webapp.sandbox_state == Webapp.RUNNING:
BAIRE Anthony's avatar
BAIRE Anthony committed
674
                stop_sandbox()
BAIRE Anthony's avatar
BAIRE Anthony committed
675
676
677
678
                messages.success(request, "rolling back sandbox %r" % webapp.name)
            else:
                messages.error(request, "unable to roll back, sandbox %r is not running"
                        % webapp.name)
679
680
681

        elif action == "abort":
            if webapp.sandbox_state == Webapp.START_ERROR:
BAIRE Anthony's avatar
BAIRE Anthony committed
682
                stop_sandbox()
BAIRE Anthony's avatar
BAIRE Anthony committed
683
                messages.success(request, "reset sandbox %r" % webapp.name)
684
685
686
687
688

        elif action == "retry":
            if webapp.sandbox_state == Webapp.START_ERROR:
                webapp.sandbox_state = Webapp.STARTING
                webapp.save()
BAIRE Anthony's avatar
BAIRE Anthony committed
689
                messages.success(request, "starting sandbox %r" % webapp.name)
690
            elif webapp.sandbox_state == Webapp.STOP_ERROR:
BAIRE Anthony's avatar
BAIRE Anthony committed
691
                stop_sandbox()
BAIRE Anthony's avatar
BAIRE Anthony committed
692
                messages.success(request, "stopping sandbox %r" % webapp.name)
693

BAIRE Anthony's avatar
BAIRE Anthony committed
694
695
        log.debug("new sandbox state: %r -> %r",
                webapp.docker_name, webapp.sandbox_state)
696

BAIRE Anthony's avatar
BAIRE Anthony committed
697
698
699
700
701
        # NOTE: we return a 302 redirect to the same page (instead of rendering
        # it directly) to force the browser to make a separate GET request.
        # This prevent reexecuting the POST request if the user refreshes the
        # page.
        return HttpResponseRedirect(request.path_info)
702

703
704
705
706
707
708
709
710
711
712
713
714
# TAGS
# -----------------------------------------------------------------------------

class TagList(ListView):
    """List all available tag along with their number of occurences

    Attributes:
        model: database model
        context_object_name: variable name used in the template to display the
                            data.
        template_name: template filename.
    """
BERJON Matthieu's avatar
BERJON Matthieu committed
715
    model = Tag
716
717
718
719
720
    context_object_name = 'tags'
    template_name = 'tag_list.html'

    def get_queryset(self):
        """Return all available tags
BERJON Matthieu's avatar
BERJON Matthieu committed
721

722
723
        Each tag return as well the number of webapps attached to it
        """
BERJON Matthieu's avatar
BERJON Matthieu committed
724
        tags = Tag.objects.annotate(num_tag=Count('taggit_taggeditem_items'))
725
726
727
728
729
730
731
732
733
734
735
736
737
        return tags


class TagWebappList(ListView):
    """List all available webapps for a given tag

    Attributes:
        model: database model
        context_object_name: variable name used in the template to display the
                            data.
        paginated_by: number of occurences per page.
        template_name: template filename.
    """
BERJON Matthieu's avatar
BERJON Matthieu committed
738
    model = Webapp
739
740
741
742
743
    context_object_name = 'webapps'
    paginated_by = 10
    template_name = 'tag_webapp_list.html'

    def get_queryset(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
744
        return Webapp.objects.filter(tags__slug=self.kwargs['slug'])
745

746
747
748
    def get_context_data(self, **kwargs):
        return super().get_context_data(tag=self.kwargs["slug"], **kwargs)

749

750
751
752
# PROFILE
# -----------------------------------------------------------------------------
class UserUpdate(SuccessMessageMixin, LoginRequiredMixin, UpdateView):
BERJON Matthieu's avatar
BERJON Matthieu committed
753
754
755
756
757
758
759
    """Update the user profile

    Attributes:
        form_class: form object to pass on the template.
        template_name: template filename
        success_message: successfull message sent to the template
    """
760
    form_class = UserForm
761
    template_name = "user_update.html"
762
763
764
    success_message = 'Profile updated successfully.'

    def get_success_url(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
765
        """If successful redirect to the user page"""
766
767
768
        return reverse('main:user_detail')

    def get_object(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
769
        """Only get the User record for the user making the request"""
770
771
772
        return User.objects.get(username=self.request.user.username)

    def get_context_data(self, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
773
774
775
776
777
778
779
        """Recover data to pass on to the template

        In order to display specific data, I process the SSH key to get its
        fingerprint and comment. Both the SSH key, fingerprint, comment and
        token to context template.

        """
780
781
782
783
784
        queryset = AllgoUser.objects.get(user_id=self.request.user.id)
        key = queryset.sshkey
        token = queryset.token
        if key:
            fingerprint, comment = get_ssh_data(key)
BERJON Matthieu's avatar
BERJON Matthieu committed
785
            kwargs['sshkey'] = True
786
787
788
789
790
791
792
793
            kwargs['ssh_comment'] = comment
            kwargs['ssh_fingerprint'] = fingerprint
        if token:
            kwargs['token'] = token
        return super(UserUpdate, self).get_context_data(**kwargs)


class UserToken(LoginRequiredMixin, RedirectView):
BERJON Matthieu's avatar
BERJON Matthieu committed
794
    """Regenerate the user token"""
795

796
797
    success_message = 'Token generated successfully.'

798
    def dispatch(self, request, *args, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
799
        """Generate the token and save it into the database"""
800
801
802
803
804
805
        queryset = AllgoUser.objects.get(user_id=self.request.user.id)
        queryset.token = get_random_string(length=32)
        queryset.save()
        return super(UserToken, self).dispatch(request, *args, **kwargs)

    def get_redirect_url(self, *args, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
806
        """Redirect the user to the user page and display a successful message"""
807
        messages.success(self.request, self.success_message)
808
809
        return reverse('main:user_detail')

BERJON Matthieu's avatar
BERJON Matthieu committed
810
811

class UserSSHAdd(SuccessMessageMixin, LoginRequiredMixin, UpdateView):
BERJON Matthieu's avatar
BERJON Matthieu committed
812
813
814
815
816
817
818
    """Save a SSH key to the database.
    
    Attributes:
        form_class: form object to pass on the template.
        template_name: template filename
        success_message: successfull message sent to the template
    """
BERJON Matthieu's avatar
BERJON Matthieu committed
819
    form_class = SSHForm
820
    template_name = 'user_ssh_add.html'
BERJON Matthieu's avatar
BERJON Matthieu committed
821
822
823
    success_message = 'SSH key added successfully.'

    def get_success_url(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
824
        """If successful redirect to the user page"""
BERJON Matthieu's avatar
BERJON Matthieu committed
825
826
827
        return reverse('main:user_detail')

    def get_object(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
828
        """Only get the User record for the user making the request"""
BERJON Matthieu's avatar
BERJON Matthieu committed
829
        return AllgoUser.objects.get(user_id=self.request.user.id)
830
831
832


class UserSSHDelete(LoginRequiredMixin, RedirectView):
BERJON Matthieu's avatar
BERJON Matthieu committed
833
    """Delete the user SSH key"""
834

835
836
    success_message = 'The SSH key has been successfully deleted.'

837
    def dispatch(self, request, *args, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
838
        """Generate an empty SSH key and save it into the database"""
839
840
841
842
843
844
        queryset = AllgoUser.objects.get(user_id=request.user.id)
        queryset.sshkey = ''
        queryset.save()
        return super(UserSSHDelete, self).dispatch(request, *args, **kwargs)

    def get_redirect_url(self, *args, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
845
        """If successful redirect to the user page"""
846
        messages.success(self.request, self.success_message)
847
848
849
        return reverse('main:user_detail')


850
class UserPasswordUpdate(SuccessMessageMixin, LoginRequiredMixin, UpdateView):
BERJON Matthieu's avatar
BERJON Matthieu committed
851
    """Update the user's password.
852
853
854

    We reuse the Django password form system in order to keep something robust
    even if it dedicates a specific view for it.
BERJON Matthieu's avatar
BERJON Matthieu committed
855
856
857
858
859
860

    Attributes:
        success_url: URL or handle where the user will be redirected.
        form_class: form object to pass on the template.
        template_name: template filename
        success_message: successfull message sent to the template
861
862
863
    """
    success_url = reverse_lazy('main:user_detail')
    form_class = PasswordChangeForm
864
    template_name = "user_password_update.html"
865
866
867
    success_message = 'Password updated successfully.'

    def get_object(self, queryset=None):
BERJON Matthieu's avatar
BERJON Matthieu committed
868
869
870
871
872
        """Return the user data
        
        Todo:
            - Not sure the relevance of getting this information to the template
        """
873
874
875
        return self.request.user

    def get_form_kwargs(self):
BERJON Matthieu's avatar
BERJON Matthieu committed
876
        """Return the arguments related to the user"""
877
878
879
880
881
        kwargs = super(UserPasswordUpdate, self).get_form_kwargs()
        kwargs['user'] = kwargs.pop('instance')
        return kwargs

    def dispatch(self, request, *args, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
882
883
884
885
886
887
        """
        Todo:
            - I'm not sure why I wrote that and why it is useful in the present
              case. It needs to be investigated.

        """
888
889
        return super(UserPasswordUpdate, self) \
            .dispatch(request, *args, **kwargs)
BERJON Matthieu's avatar
BERJON Matthieu committed
890

BERJON Matthieu's avatar
BERJON Matthieu committed
891
892
893
894
# JOBS
# -----------------------------------------------------------------------------

class JobList(LoginRequiredMixin, ListView):
BERJON Matthieu's avatar
BERJON Matthieu committed
895
896
897
898
899
900
901
902
903
904
905
906
    """Display the list of jobs for a given identified user

    Attributes:
        model:  model used in the view.
        context_object_name:    the name used in the template to display each
                                variable.
        paginate_by: the number of occurences per page
        template_name: name of the template loaded with this view.
        redirect_field_name: None

    Todo:
        - Check the relevance of `redirect_field_name` and delete it if necessary
BERJON Matthieu's avatar
BERJON Matthieu committed
907
908
909
910
911
912
913
914
915
    """
    model = Job
    context_object_name = 'job_list'
    template_name = 'job_list.html'
    paginate_by = 10
    redirect_field_name = 'redirect_to'

    def get_queryset(self):
        """Filter jobs for a given user"""
916
917
        queryset = Job.objects.filter(user_id=self.request.user.id
                ).exclude(state__in=(Job.DELETED, Job.ARCHIVED)).order_by('-id')
BERJON Matthieu's avatar
BERJON Matthieu committed
918
        return queryset
BERJON Matthieu's avatar
BERJON Matthieu committed
919

920

921
class JobDetail(JobAuthMixin, DetailView):
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
    """Get a job detail for a specific user

    Attributes:
        model:  model used in the view.
        context_object_name:    the name used in the template to display each
                                variable.
        template_name: name of the template loaded with this view.

    """
    model = Job
    template_name = 'job_detail.html'
    context_object_name = 'job'

    def get_context_data(self, **kwargs):
        """Recover the logs and files related to this job"""
BERJON Matthieu's avatar
BERJON Matthieu committed
937
938
        job = Job.objects.get(pk=self.object.pk)

939
940
941
        if job.state == Job.DONE:
            # job is done
            # -> read the `allgo.log` file
942
            log_file = os.path.join(job.data_dir, 'allgo.log')
943
            try:
944
                with open(log_file, 'r', errors="replace") as log_data:
BERJON Matthieu's avatar
BERJON Matthieu committed
945
                    logs = log_data.read()
946
947
948
949
950
951
952
            except OSError as e:
                logs = '(logs not available)'
                log.error("Log file not available for job #%d (%s)", job.id, e)
        else:
            # job is pending
            # -> logs will be streamed (ajax request)
            logs = ""
BERJON Matthieu's avatar
BERJON Matthieu committed
953
954
        kwargs['logs'] = logs

955
956
957
        # Hide the logs panel if the job is not yet started
        kwargs["logs_hidden"] = "hidden" if job.state in (Job.NEW, Job.WAITING) else ""

BERJON Matthieu's avatar
BERJON Matthieu committed
958
959
        # Get the files and some metadata such as the webapp version
        webapp = Webapp.objects.get(docker_name=self.object.webapp.docker_name)
960
961
962
963
964
965

        # List all job files
        # NOTE: calling lookup_job_file is a security feature
        kwargs['files'] = [x for x in os.listdir(job.data_dir)
                if lookup_job_file(job.id, x)]

BERJON Matthieu's avatar
BERJON Matthieu committed
966
        return super().get_context_data(**kwargs)
967

968
969
    def render_to_response(self, context, **kwargs):
        if self.request.META.get("HTTP_ACCEPT") == "application/json":
970
971
            # json variant of the job details
            # (used by the /aio/jobs/<ID>/events endpoint)
972
973
974
975
            job = context["job"]
            return JsonResponse({
                "id":           job.id,
                "state":        job.get_state_display(),
976
                "result":       job.get_result_display(),
977
978
979
980
981
                "rendered_status": status_icon(job),
                "exec_time":    job.exec_time,
                })
        else:
            return super().render_to_response(context, **kwargs)
982

983

BERJON Matthieu's avatar
BERJON Matthieu committed
984
985
986
class JobCreate(SuccessMessageMixin, CreateView):
    """ Display the data related a specific web and create a job instance
        into the database
BERJON Matthieu's avatar
BERJON Matthieu committed
987
988
989
990
991
992
993
994
995

    Attributes:
        model:  model used in the view.
        form_class: form object to pass on the template.
        success_url: URL or handle where the user will be redirected.
        success_message: successfull message sent to the template
        template_name: name of the template loaded with this view.

    """
996
997
998
    model = Job
    form_class = JobForm
    success_message = 'Job created successfully.'
BERJON Matthieu's avatar
BERJON Matthieu committed
999
    template_name = 'webapp_detail.html'
1000

1001
1002
1003
    def get_success_url(self):
        return reverse('main:job_detail', args=(self.job_id,))

1004
    def form_valid(self, form):
BERJON Matthieu's avatar
BERJON Matthieu committed
1005
        """Save data coming from the form in the database """
1006
1007
        webapp = Webapp.objects.get(docker_name=self.kwargs['docker_name'])

BERJON Matthieu's avatar
BERJON Matthieu committed
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
        # If the user isn't identified, we send back an error message and
        # and redirect the user.
        if self.request.user.is_anonymous():
            messages.add_message(self.request, messages.ERROR, 'You must be identified to create a job.')
            log.warning("Someone tried to run a job without being identified.")
            return redirect('main:webapp_detail', webapp.docker_name)
        else:
            obj = form.save(commit=False)
            obj.queue_id = form.cleaned_data.get('queue_id').id
            obj.state = Job.NEW
            obj.result = 0
            obj.user_id = self.request.user.id
            obj.webapp_id = webapp.id
            obj.version = form.cleaned_data.get('version')
            obj.save()
1023

BERJON Matthieu's avatar
BERJON Matthieu committed
1024
            # Upload files if there are any
1025
            upload_data(self.request.FILES.getlist('files'), obj)
BERJON Matthieu's avatar
BERJON Matthieu committed
1026

BERJON Matthieu's avatar
BERJON Matthieu committed
1027
1028
1029
            # start the job
            obj.state = Job.WAITING
            obj.save()
1030
            self.job_id = obj.id
1031

BERJON Matthieu's avatar
BERJON Matthieu committed
1032
            return super().form_valid(form)
1033
1034

    def get_context_data(self, **kwargs):
BERJON Matthieu's avatar
BERJON Matthieu committed
1035
        """Pass on the docker name to the template"""
1036
        webapp = Webapp.objects.get(docker_name=self.kwargs['docker_name'])
BERJON Matthieu's avatar
BERJON Matthieu committed
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
        kwargs['webapp'] = webapp

        # Check if a readme is declared in the database
        if webapp.readme:
            readme_file = os.path.join(
                settings.MEDIA_ROOT,
                self.object.docker_name,
                'Readme')
            if os.path.exists(readme_file):
                with open(readme_file, 'r') as md_data:
                    kwargs['readme'] = md_data.read()
            else:
                log.warning("No README available for app %s", self.model.name)
        else:
            readme_file = None
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068

        # select the list of versions to be displayed
        versions = natsort.versorted(set(v for v, in WebappVersion.objects
                .filter(webapp=webapp, state__in=(  WebappVersion.SANDBOX,
                                                    WebappVersion.COMMITTED,
                                                    WebappVersion.READY))
                .values_list("number")))

        # also list 'sandbox' if the sandbox is running and if the current user
        # is allowed to use the sandbox
        if webapp.sandbox_state == Webapp.RUNNING and (
            webapp.is_pushable_by(self.request.user)):
            versions.append("sandbox")
        
        versions.reverse()
        kwargs['versions'] = versions

1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
        # build the sample command lines for using the REST API
        base_url = get_base_url(self.request)
        user = self.request.user
        auth = "Authorization: Token token=" + (
                user.allgouser.token if user.is_authenticated else "<your private_token>")

        kwargs["job_create_cmd"] = ["curl", "-H", auth,
                "-X", "POST", base_url + reverse("api:jobs"),
                None, "-F", "job[webapp_id]=" + str(webapp.id),
                None, "-F", "job[param]=",
1079
                None, "-F", "job[queue]=" + webapp.job_queue.name,
1080
1081
1082
1083
1084
1085
1086
                None, "-F", "files[0]=@test.txt",
                None, "-F", "files[1]=@test2.csv",
                None, "-F", "job[file_url]=<my_file_url>",
                None, "-F", "job[dataset]=<my_dataset_name>",
                ]

        kwargs["job_result_cmd"] = ["curl", "-H", auth,
1087
                base_url + reverse("api:job", args=(42,)).replace("42", "<job_id>")]
1088

BERJON Matthieu's avatar
BERJON Matthieu committed
1089
        return super().get_context_data(**kwargs)
1090

1091
1092
    def get_form_kwargs(self):
        """Return webapp data"""
BERJON Matthieu's avatar
BERJON Matthieu committed
1093
        kwargs = super().get_form_kwargs()
1094
1095
1096
1097
        queryset = Webapp.objects.get(docker_name=self.kwargs['docker_name'])
        kwargs['webapp'] = queryset
        return kwargs

1098
class JobAbort(JobAuthMixin, View):
BAIRE Anthony's avatar
BAIRE Anthony committed
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
    def post(self, request, *, pk):
        job_id = int(pk)
        # switch state to ABORTING if the job is running (this is done
        # atomically to avoid messing up with the controller)
        if Job.objects.filter(id=job_id, state=Job.RUNNING
                ).update(state=Job.ABORTING):
            job_post_save(Job.objects.get(id=job_id))
            messages.success(request, "aborting job %s" % job_id)
        else:
            messages.error(request, "unable to abort job %s because is not running" % job_id)
        return redirect('main:job_detail', job_id)

        

1113

1114
class JobDelete(JobAuthMixin,  DeleteView):
BERJON Matthieu's avatar
BERJON Matthieu committed
1115
1116
1117
1118
1119
1120
1121
1122
    """Delete a job from the database

    Attributes:
        model:  model used in the view.
        success_url: URL or handle where the user will be redirected.
        success_message: successfull message sent to the template
        template_name: name of the template loaded with this view.

1123
1124
1125
1126
1127
1128
1129
1130
    Note:
        The `success_message` can't be used alone with the
        `SuccessMessageMixin` because it's hooked to `form_valid` method and 
        can't work with a `DeleteView`.

    See also:
        https://code.djangoproject.com/ticket/21926

BERJON Matthieu's avatar
BERJON Matthieu committed
1131
1132
1133
1134
1135
1136
    """
    model = Job
    success_message = 'Job successfully deleted.'
    success_url = reverse_lazy('main:job_list')
    template_name = 'job_delete.html'

1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
    @classmethod
    def as_view(cls, **kw):
        # manage db transactions manually
        return transaction.non_atomic_requests(super().as_view(**kw))

    def delete(self, request, *args, pk, **kwargs):
        # NOTE: if job is in WAITING state, then any state update must be done
        # atomically so as not to mess up with che controller
        if not (Job.objects.filter(id=pk, state=Job.DONE
                    ).update(state=Job.ARCHIVED)
            or  Job.objects.filter(id=pk, state__in=(Job.NEW, Job.WAITING)
                    ).update(state=Job.DELETED)
            or  Job.objects.filter(id=pk, state__in=(Job.DELETED, Job.ARCHIVED)).exists()
            ):

1152
            messages.error(self.request, "cannot delete a running job")
1153
            return redirect('main:job_detail', pk)
1154

1155
        transaction.commit()
1156

1157
        self.object = job = self.get_object()
1158
        notify_controller(job) # so that the DELETED/ARCHIVED state is propagated into the redis db
1159
1160
1161

        # delete the data dir if present
        # FIXME: if this fail then we have dangling files staying in the way
1162
        job_dir = job.data_dir
1163
1164
1165
        if os.path.exists(job_dir):
            shutil.rmtree(job_dir)

1166
1167
1168
1169
1170
        if job.state == Job.DELETED:
            job.delete()

        messages.success(self.request, self.success_message)
        return redirect(self.get_success_url())
1171

1172

BERJON Matthieu's avatar
BERJON Matthieu committed
1173

1174
class JobFileDownload(JobAuthMixin, View):
BERJON Matthieu's avatar
BERJON Matthieu committed
1175
1176
1177
1178
1179
1180
1181
1182
    """Download a given file"""

    def get(self, request, *args, **kwargs):
        """Return a file for a given job and filename
        """
        # get file
        job_id = self.kwargs['pk']
        filename = self.kwargs['filename']
1183
        return redirect("/datastore/%s/%s" % (job_id, filename))
BERJON Matthieu's avatar
BERJON Matthieu committed
1184
1185


1186
class JobFileDownloadAll(JobAuthMixin, View):
BERJON Matthieu's avatar
BERJON Matthieu committed
1187
1188
    """Archive and download all files of a given job
    """
1189
    model = Job
BERJON Matthieu's avatar
BERJON Matthieu committed
1190
1191
1192
1193
1194
1195
1196

    def get(self, request, *args, **kwargs):
        """get all the file for a given job

        The method gets the job ID, recover each file related to this job,
        archive into a ZIP file and return it.

1197
1198
1199
        The ZIP file is stored as an anonymous file in /tmp/ then streamed with
        FileResponse. This is better that keepingthe whole file in memory
        because it may be large (and linux has a quite efficient page cache).
BERJON Matthieu's avatar
BERJON Matthieu committed
1200
        """
1201
        job = self.get_object()
1202
        tmp_file = tempfile.TemporaryFile()
BERJON Matthieu's avatar
BERJON Matthieu committed
1203

1204
1205
        zip_subdir = str(job.id)
        zip_filename = 'job_%s.zip' % zip_subdir
BERJON Matthieu's avatar
BERJON Matthieu committed
1206

1207
        zip_file = zipfile.ZipFile(tmp_file, 'w')
BERJON Matthieu's avatar
BERJON Matthieu committed
1208

1209
1210
1211
1212
1213
1214
        for filename in os.listdir(job.data_dir):
            # NOTE: calling lookup_job_file is a security feature
            real_path = lookup_job_file(job.id, filename)
            if real_path:
                zip_path = os.path.join(zip_subdir, filename)
                zip_file.write(real_path, zip_path)
BERJON Matthieu's avatar
BERJON Matthieu committed
1215

1216
        zip_file.close()
BERJON Matthieu's avatar
BERJON Matthieu committed
1217

1218
1219
        tmp_file.seek(0)
        response = FileResponse(tmp_file, content_type='application/x-zip-compressed')
1220
1221
        response["Content-Disposition"] = "attachment; filename={0}".format(zip_filename)
        return response
1222
1223


BERJON Matthieu's avatar
BERJON Matthieu committed
1224
1225
1226
# RUNNERS
# -----------------------------------------------------------------------------
class RunnerList(LoginRequiredMixin, ListView):
BERJON Matthieu's avatar
BERJON Matthieu committed
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
    """List all runners of a given user

    Attributes:
        model:  model used in the view.
        context_object_name:    the name used in the template to display each
                                variable.
        paginate_by: the number of occurences per page
        template_name: name of the template loaded with this view.

    """
BERJON Matthieu's avatar
BERJON Matthieu committed
1237
1238
1239
1240
1241
    model = Runner
    context_object_name = 'runner_list'
    paginate_by = 10
    template_name = 'runner_list.html'

BERJON Matthieu's avatar
BERJON Matthieu committed
1242
1243
1244
1245
1246
1247
1248
    def get_queryset(self):
        """Returns all runners of a given user
        
        Returns all runners for a given user from the most recent to the
        oldest one.
        """
        queryset = Runner.objects.filter(user=self.request.user).order_by('-created_at')
BERJON Matthieu's avatar
BERJON Matthieu committed
1249
        return queryset
BERJON Matthieu's avatar
BERJON Matthieu committed
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
    
    def get_context_data(self, **kwargs):
        """Return the number of webapps of a given user