views.py 39.4 KB
Newer Older
1
2
3

import os
import secrets
Ossi Laine's avatar
Ossi Laine committed
4
from datetime import date
5

Ossi Laine's avatar
Ossi Laine committed
6
7
8
9
from flask_socketio import emit
from sqlalchemy import and_
from flask_login import login_required
from werkzeug import secure_filename
10
from flask import (
Ossi Laine's avatar
Ossi Laine committed
11
12
13
14
15
    render_template,
    request,
    flash,
    redirect,
    url_for,
Ossi Laine's avatar
Ossi Laine committed
16
    Blueprint
17
18
)

Ossi Laine's avatar
Ossi Laine committed
19
from app import app, db, socketio
20
21
22
23
24
25
from app.routes import APP_ROOT
from app.models import background_question, experiment
from app.models import background_question_answer
from app.models import page, question
from app.models import background_question_option
from app.models import answer_set, answer, forced_id
Ossi Laine's avatar
Ossi Laine committed
26
from app.models import trial_randomization
Ossi Laine's avatar
Ossi Laine committed
27
from app.models import embody_answer, embody_question
28
from app.forms import (
Ossi Laine's avatar
Ossi Laine committed
29
30
31
32
    CreateBackgroundQuestionForm,
    CreateQuestionForm, UploadStimuliForm, EditBackgroundQuestionForm,
    EditQuestionForm, EditExperimentForm, UploadResearchBulletinForm,
    EditPageForm, RemoveExperimentForm, GenerateIdForm, CreateEmbodyForm
33
)
34
from app.utils import get_mean_from_slider_answers, map_answers_to_questions, \
Ossi Laine's avatar
Ossi Laine committed
35
36
37
    generate_csv

import embody_plot
38

Ossi Laine's avatar
Ossi Laine committed
39
# Stimuli upload folder setting
40
41
#APP_ROOT = os.path.dirname(os.path.abspath(__file__))

Ossi Laine's avatar
Ossi Laine committed
42
43
44
45
experiment_blueprint = Blueprint("experiment", __name__,
                                 template_folder='templates',
                                 # static_folder='static',
                                 url_prefix='/experiment')
46

Ossi Laine's avatar
Ossi Laine committed
47
48
49
# Set sliders/embody:
DEFAULT_EMBODY_PICTURE = '/static/img/dummy_600.png'
DEFAULT_EMBODY_QUESTION = 'Color the regions whose activity you feel increasing or getting stronger'
50

Ossi Laine's avatar
Ossi Laine committed
51

52
53
54
@experiment_blueprint.route('/view')
@login_required
def view():
Ossi Laine's avatar
Ossi Laine committed
55
56

    # crap:3lines
57
58
59
    exp_id = request.args.get('exp_id', None)
    media = page.query.filter_by(experiment_idexperiment=exp_id).all()

Ossi Laine's avatar
Ossi Laine committed
60
    # stimulus type
61
    mtype = page.query.filter_by(experiment_idexperiment=exp_id).first()
Ossi Laine's avatar
Ossi Laine committed
62

Ossi Laine's avatar
Ossi Laine committed
63
64
65
66
    # experiment info
    experiment_info = experiment.query.filter_by(idexperiment=exp_id).all()

    # background questions
67
    questions_and_options = {}
Ossi Laine's avatar
Ossi Laine committed
68
69
70
71
72
73
74
75
76
77
78
    questions = background_question.query.filter_by(
        experiment_idexperiment=exp_id).all()

    for q in questions:

        options = background_question_option.query.filter_by(
            background_question_idbackground_question=q.idbackground_question).all()
        options_list = [(o.option, o.idbackground_question_option)
                        for o in options]
        questions_and_options[q.idbackground_question,
                              q.background_question] = options_list
79
80

    questions1 = questions_and_options
Ossi Laine's avatar
Ossi Laine committed
81

Ossi Laine's avatar
Ossi Laine committed
82
    # sliderset
83
84
85
    categories_and_scales = {}
    categories = question.query.filter_by(experiment_idexperiment=exp_id).all()

Ossi Laine's avatar
Ossi Laine committed
86
87
    for cat in categories:

88
        scale_list = [(cat.left, cat.right)]
Ossi Laine's avatar
Ossi Laine committed
89
90
        categories_and_scales[cat.idquestion, cat.question] = scale_list

91
92
    categories1 = categories_and_scales

Ossi Laine's avatar
Ossi Laine committed
93
94
95
96
97
    # embody pictures
    embody_pictures = embody_question.query.filter_by(
        experiment_idexperiment=exp_id).all()

    return render_template('view_experiment.html', exp_id=exp_id, media=media, mtype=mtype, experiment_info=experiment_info, categories1=categories1, questions1=questions1, embody_pictures=embody_pictures)
98
99
100
101
102
103
104
105
106
107
108
109


# Experiment info:

@experiment_blueprint.route('/remove', methods=['GET', 'POST'])
@login_required
def remove():

    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_status.status != 'Hidden':
Ossi Laine's avatar
Ossi Laine committed
110

111
112
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
113

114
    else:
Ossi Laine's avatar
Ossi Laine committed
115

116
        form = RemoveExperimentForm(request.form)
Ossi Laine's avatar
Ossi Laine committed
117

118
        if request.method == 'POST' and form.validate():
Ossi Laine's avatar
Ossi Laine committed
119

120
            if form.remove.data == 'DELETE':
Ossi Laine's avatar
Ossi Laine committed
121
122
123
124
125
126
127

                # This removes all experiment data from the database!

                # Remove research bulletin if it exists
                empty_filevariable = experiment.query.filter_by(
                    idexperiment=exp_id).first()

128
                if empty_filevariable.research_notification_filename is not None:
Ossi Laine's avatar
Ossi Laine committed
129
130
131
132
                    target = os.path.join(
                        APP_ROOT, empty_filevariable.research_notification_filename)

                    if os.path.exists(target):
133
                        os.remove(target)
Ossi Laine's avatar
Ossi Laine committed
134
135
136
137

                # Tables
                remove_forced_id = forced_id.query.filter_by(
                    experiment_idexperiment=exp_id).all()
Ossi Laine's avatar
Ossi Laine committed
138
                remove_rows(remove_forced_id)
139

Ossi Laine's avatar
Ossi Laine committed
140
141
142
143
144
                # background_question_option & background_question & background question answers:
                remove_background_question = background_question.query.filter_by(
                    experiment_idexperiment=exp_id).all()

                # Remove all background questions and all answers given to each bg question
145
                for a in range(len(remove_background_question)):
Ossi Laine's avatar
Ossi Laine committed
146
147
                    remove_background_question_option = background_question_option.query.filter_by(
                        background_question_idbackground_question=remove_background_question[a].idbackground_question).all()
Ossi Laine's avatar
Ossi Laine committed
148
149
                    remove_rows(remove_background_question_option)

Ossi Laine's avatar
Ossi Laine committed
150
151
                    remove_background_question_answers = background_question_answer.query.filter_by(
                        background_question_idbackground_question=remove_background_question[a].idbackground_question).all()
Ossi Laine's avatar
Ossi Laine committed
152
153
                    remove_rows(remove_background_question_answers)

154
155
                    db.session.delete(remove_background_question[a])
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
156
157
158
159

                # Remove all questions and answers
                remove_question = question.query.filter_by(
                    experiment_idexperiment=exp_id).all()
160
                for a in range(len(remove_question)):
Ossi Laine's avatar
Ossi Laine committed
161
162
                    remove_question_answers = answer.query.filter_by(
                        question_idquestion=remove_question[a].idquestion).all()
Ossi Laine's avatar
Ossi Laine committed
163
                    remove_rows(remove_question_answers)
164
165
                    db.session.delete(remove_question[a])
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
166
167
168
169
170

                # Remove experiment embody pictures, questions and answers
                remove_embody_answers = embody_answer.query.filter(embody_answer.page_idpage.in_(list(map(
                    lambda x: x[0], page.query.with_entities(page.idpage).filter_by(experiment_idexperiment=exp_id).all())))).all()
                remove_rows(remove_embody_answers)
Ossi Laine's avatar
Ossi Laine committed
171
172
                remove_embody_questions = embody_question.query.filter_by(
                    experiment_idexperiment=exp_id).all()
Ossi Laine's avatar
Ossi Laine committed
173
174
175

                for a in range(len(remove_embody_questions)):
                    target = APP_ROOT + remove_embody_questions[a].picture
Ossi Laine's avatar
Ossi Laine committed
176
                    if os.path.exists(target) and DEFAULT_EMBODY_PICTURE != remove_embody_questions[a].picture:
Ossi Laine's avatar
Ossi Laine committed
177
178
                        os.remove(target)

Ossi Laine's avatar
Ossi Laine committed
179
180
                remove_rows(remove_embody_questions)

Ossi Laine's avatar
Ossi Laine committed
181
182
183
184
                # Remove all pages and datafiles
                remove_pages = page.query.filter_by(
                    experiment_idexperiment=exp_id).all()

185
                for a in range(len(remove_pages)):
Ossi Laine's avatar
Ossi Laine committed
186
                    if remove_pages[a].type != 'text':
187
                        target = os.path.join(APP_ROOT, remove_pages[a].media)
Ossi Laine's avatar
Ossi Laine committed
188
                        if os.path.exists(target):
189
                            os.remove(target)
Ossi Laine's avatar
Ossi Laine committed
190
191

                    # Now that the files are removed we can delete the page
192
193
                    db.session.delete(remove_pages[a])
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
194

Ossi Laine's avatar
Ossi Laine committed
195
196
197
198
                # Remove all answer_sets and trial_randomization orders
                remove_answer_set = answer_set.query.filter_by(
                    experiment_idexperiment=exp_id).all()

199
                for a in range(len(remove_answer_set)):
Ossi Laine's avatar
Ossi Laine committed
200
201
                    remove_trial_randomizations = trial_randomization.query.filter_by(
                        answer_set_idanswer_set=remove_answer_set[a].idanswer_set).all()
Ossi Laine's avatar
Ossi Laine committed
202
                    remove_rows(remove_trial_randomizations)
203
204
                    db.session.delete(remove_answer_set[a])
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
205
206
207
208

                # Remove experiment table
                remove_experiment = experiment.query.filter_by(
                    idexperiment=exp_id).first()
209
210
                db.session.delete(remove_experiment)
                db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
211
212
213
214

                # Remove empty directories
                os.rmdir(APP_ROOT + '/static/embody_images/' + str(exp_id))
                os.rmdir(APP_ROOT + '/static/experiment_stimuli/' + str(exp_id))
Ossi Laine's avatar
Ossi Laine committed
215

216
217
                flash("Experiment was removed from database!")
                return redirect(url_for('index'))
Ossi Laine's avatar
Ossi Laine committed
218

219
220
221
            else:
                flash("Experiment was not removed!")
                return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
222

223
224
225
226
227
228
229
        return render_template('remove_experiment.html', form=form, exp_id=exp_id)


@experiment_blueprint.route('/publish')
@login_required
def publish():
    exp_id = request.args.get('exp_id', None)
Ossi Laine's avatar
Ossi Laine committed
230
231
    publish_experiment = experiment.query.filter_by(
        idexperiment=exp_id).first()
232
233
234
235
236
237
238
239
240
241
    publish_experiment.status = 'Public'
    flash("Changed status to Public")
    db.session.commit()
    return redirect(url_for('experiment.view', exp_id=exp_id))


@experiment_blueprint.route('/hide')
@login_required
def hide():
    exp_id = request.args.get('exp_id', None)
Ossi Laine's avatar
Ossi Laine committed
242
    hide_experiment = experiment.query.filter_by(idexperiment=exp_id).first()
243
244
245
246
247
248
249
250
251
252
    hide_experiment.status = 'Hidden'
    flash("Changed status to Hidden")
    db.session.commit()
    return redirect(url_for('experiment.view', exp_id=exp_id))


@experiment_blueprint.route('/private')
@login_required
def private():
    exp_id = request.args.get('exp_id', None)
Ossi Laine's avatar
Ossi Laine committed
253
254
    private_experiment = experiment.query.filter_by(
        idexperiment=exp_id).first()
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
    private_experiment.status = 'Private'
    flash("Changed status to Private")
    db.session.commit()
    return redirect(url_for('experiment.view', exp_id=exp_id))


@experiment_blueprint.route('/randomization')
@login_required
def randomization():
    exp_id = request.args.get('exp_id', None)
    status = request.args.get('set')

    if status == 'On':
        flash("Enabled trial randomization")
    elif status == 'Off':
        flash("Disabled trial randomization")

Ossi Laine's avatar
Ossi Laine committed
272
273
    experiment.query.filter_by(
        idexperiment=exp_id).first().randomization = status
274
    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
275

276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
    return redirect(url_for('experiment.view', exp_id=exp_id))


@experiment_blueprint.route('/set_forced_id')
@login_required
def set_forced_id():
    '''By using forced ID login subjects can only participate to a rating task
    by logging in with a pregenerated ID.'''

    exp_id = request.args.get('exp_id', None)
    status = request.args.get('set')

    if status == 'On':
        flash("Enabled forced ID login")
    elif status == 'Off':
        flash("Disabled forced ID login")

Ossi Laine's avatar
Ossi Laine committed
293
294
    experiment.query.filter_by(
        idexperiment=exp_id).first().use_forced_id = status
295
    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
296

297
298
299
300
301
302
303
304
305
306
307
    return redirect(url_for('experiment.view', exp_id=exp_id))


@experiment_blueprint.route('/view_forced_id_list', methods=['GET', 'POST'])
@login_required
def view_forced_id_list():
    '''Forced ID login for participants'''

    exp_id = request.args.get('exp_id', None)
    id_list = forced_id.query.filter_by(experiment_idexperiment=exp_id).all()
    form = GenerateIdForm(request.form)
Ossi Laine's avatar
Ossi Laine committed
308

309
310
    if request.method == 'POST' and form.validate():

Ossi Laine's avatar
Ossi Laine committed
311
        for i in range(int(request.form['number'])):
312
            random_id = str(request.form['string']) + str(secrets.token_hex(3))
Ossi Laine's avatar
Ossi Laine committed
313
314
315
316
317
318
319
            check_answer_set = answer_set.query.filter_by(
                session=random_id).first()
            check_forced_id = forced_id.query.filter_by(
                pregenerated_id=random_id).first()

            # here we check if the generated id is found from given answers from the whole database in answer_set table
            # or from forced_id table. If so another id is generated instead to avoid a duplicate
320
            if check_answer_set is not None or check_forced_id is not None:
Ossi Laine's avatar
Ossi Laine committed
321

322
323
                #flash("ID already existed; generated a new one")
                random_id = secrets.token_hex(3)
Ossi Laine's avatar
Ossi Laine committed
324
325
326
327
328
329
330
                check_answer_set = answer_set.query.filter_by(
                    session=random_id).first()
                check_forced_id = forced_id.query.filter_by(
                    pregenerated_id=random_id).first()

            input_id = forced_id(
                experiment_idexperiment=exp_id, pregenerated_id=random_id)
331
332
            db.session.add(input_id)
            db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
333

334
        return redirect(url_for('experiment.view_forced_id_list', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
335

336
337
338
339
340
341
342
343
344
345
    return render_template('view_forced_id_list.html', exp_id=exp_id, id_list=id_list)


@experiment_blueprint.route('/upload_research_notification', methods=['GET', 'POST'])
@login_required
def upload_research_notification():
    '''Upload research bulletin'''

    exp_id = request.args.get('exp_id', None)
    form = UploadResearchBulletinForm(request.form)
Ossi Laine's avatar
Ossi Laine committed
346

347
348
349
    if request.method == 'POST':
        path = 'static/experiment_stimuli/' + str(exp_id)
        target = os.path.join(APP_ROOT, path)
Ossi Laine's avatar
Ossi Laine committed
350

351
352
        if not os.path.isdir(target):
            os.mkdir(target)
Ossi Laine's avatar
Ossi Laine committed
353
354

        # This returns a list of filenames: request.files.getlist("file")
355
        for file in request.files.getlist("file"):
Ossi Laine's avatar
Ossi Laine committed
356
            # save files in the correct folder
357
358
359
            filename = file.filename
            destination = "/".join([target, filename])
            file.save(destination)
Ossi Laine's avatar
Ossi Laine committed
360
361
362

            # add pages to the db
            db_path = path + str('/') + str(filename)
363
364
365
            bulletin = experiment.query.filter_by(idexperiment=exp_id).first()
            bulletin.research_notification_filename = db_path
            db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
366

367
368
369
370
371
372
373
374
375
        return redirect(url_for('experiment.view', exp_id=exp_id))

    return render_template('upload_research_notification.html', exp_id=exp_id, form=form)


@experiment_blueprint.route('/remove_research_notification')
@login_required
def remove_research_notification():
    '''Remove research bulletin'''
Ossi Laine's avatar
Ossi Laine committed
376

377
    exp_id = request.args.get('exp_id', None)
Ossi Laine's avatar
Ossi Laine committed
378
379
380
381
382
383
    empty_filevariable = experiment.query.filter_by(
        idexperiment=exp_id).first()
    target = os.path.join(
        APP_ROOT, empty_filevariable.research_notification_filename)

    if os.path.exists(target):
384
        os.remove(target)
Ossi Laine's avatar
Ossi Laine committed
385

386
387
    empty_filevariable.research_notification_filename = None
    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
388

389
390
391
392
393
394
395
396
397
    return redirect(url_for('experiment.view', exp_id=exp_id))


@experiment_blueprint.route('/edit', methods=['GET', 'POST'])
@login_required
def edit():
    '''Edit experiment details'''

    exp_id = request.args.get('exp_id', None)
Ossi Laine's avatar
Ossi Laine committed
398
399
400
    current_experiment = experiment.query.filter_by(
        idexperiment=exp_id).first()

401
402
    form = EditExperimentForm(request.form, obj=current_experiment)
    form.language.default = current_experiment.language
Ossi Laine's avatar
Ossi Laine committed
403

404
    if request.method == 'POST' and form.validate():
Ossi Laine's avatar
Ossi Laine committed
405

406
407
408
        form.populate_obj(current_experiment)
        db.session.commit()

Ossi Laine's avatar
Ossi Laine committed
409
        return redirect(url_for('experiment.view', exp_id=exp_id))
410

Ossi Laine's avatar
Ossi Laine committed
411
    return render_template('edit_experiment.html', form=form, exp_id=exp_id)
412
413
414
415
416
417
418


# Background questions:

@experiment_blueprint.route('/add_bg_question', methods=['GET', 'POST'])
@login_required
def add_bg_question():
Ossi Laine's avatar
Ossi Laine committed
419

420
421
422
423
424
425
    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_status.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
426

427
428
    else:
        form = CreateBackgroundQuestionForm(request.form)
Ossi Laine's avatar
Ossi Laine committed
429

430
        if request.method == 'POST' and form.validate():
Ossi Laine's avatar
Ossi Laine committed
431
432

            # Split the form data into a list that separates questions followed by the corresponding options
433
            str = form.bg_questions_and_options.data
434
            str_list = str.split('/n')
Ossi Laine's avatar
Ossi Laine committed
435
436

            # Iterate through the questions and options list
437
            for a in range(len(str_list)):
Ossi Laine's avatar
Ossi Laine committed
438
                # Split the list cells further into questions and options
439
                list = str_list[a].split(';')
Ossi Laine's avatar
Ossi Laine committed
440
441

                # Input the first item of the list as a question in db and the items followed by that as options for that question
442
443
                for x in range(len(list)):
                    if x == 0:
Ossi Laine's avatar
Ossi Laine committed
444
445
                        add_bgquestion = background_question(
                            background_question=list[x], experiment_idexperiment=exp_id)
446
447
448
                        db.session.add(add_bgquestion)
                        db.session.commit()
                    else:
Ossi Laine's avatar
Ossi Laine committed
449
450
                        add_bgq_option = background_question_option(
                            background_question_idbackground_question=add_bgquestion.idbackground_question, option=list[x])
451
452
                        db.session.add(add_bgq_option)
                        db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
453
454
455

            return redirect(url_for('experiment.view', exp_id=exp_id))

456
457
458
459
460
461
        return render_template('add_bg_question.html', form=form)


@experiment_blueprint.route('/edit_bg_question', methods=['GET', 'POST'])
@login_required
def edit_bg_question():
Ossi Laine's avatar
Ossi Laine committed
462

463
464
    bg_question_id = request.args.get('idbackground_question', None)

Ossi Laine's avatar
Ossi Laine committed
465
466
467
468
469
    # Search for the right question and for the right options. Form a string of those separated with ";" and insert the
    # formed string into the edit form
    current_bg_question = background_question.query.filter_by(
        idbackground_question=bg_question_id).first()
    exp_id = current_bg_question.experiment_idexperiment
470
    question_string = current_bg_question.background_question
Ossi Laine's avatar
Ossi Laine committed
471
472
473
474
475
476
477
    options = background_question_option.query.filter_by(
        background_question_idbackground_question=bg_question_id).all()

    for o in range(len(options)):
        question_string = str(question_string) + \
            str("; ") + str(options[o].option)

478
479
480
    form = EditBackgroundQuestionForm(request.form)
    form.bg_questions_and_options.data = question_string

Ossi Laine's avatar
Ossi Laine committed
481
    # After user chooses to update the question and options lets replace the old question and options with the ones from the form
482
    if request.method == 'POST' and form.validate():
Ossi Laine's avatar
Ossi Laine committed
483
        # Explode the string with new values from the form
484
485
        form_values = form.new_values.data
        form_values_list = form_values.split(';')
Ossi Laine's avatar
Ossi Laine committed
486
487

        # Check and remove possible whitespaces from string beginnings with lstrip
488
489
        for x in range(len(form_values_list)):
            form_values_list[x] = form_values_list[x].lstrip()
Ossi Laine's avatar
Ossi Laine committed
490
491

        # Cycle through strings and update db
492
        for x in range(len(form_values_list)):
Ossi Laine's avatar
Ossi Laine committed
493
494

            # Replace question and update the object to database
495
            if x == 0:
Ossi Laine's avatar
Ossi Laine committed
496
                current_bg_question.background_question = form_values_list[x]
497
                db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
498
499

                # Delete old options from db
500
501
502
                for o in options:
                    db.session.delete(o)
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
503
504

            # Insert new options to db
505
            else:
Ossi Laine's avatar
Ossi Laine committed
506
507
                new_option = background_question_option(
                    background_question_idbackground_question=current_bg_question.idbackground_question, option=form_values_list[x])
508
509
                db.session.add(new_option)
                db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
510

511
        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
512

513
514
515
516
517
518
519
520
521
522
523
524
525
    return render_template('edit_bg_question.html', form=form, exp_id=exp_id)


@experiment_blueprint.route('/remove_bg_question')
@login_required
def remove_bg_question():

    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_status.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
526

527
    else:
528

529
        remove_id = request.args.get('idbackground_question', None)
Ossi Laine's avatar
Ossi Laine committed
530
531
532
533
        remove_options = background_question_option.query.filter_by(
            background_question_idbackground_question=remove_id).all()

        for a in range(len(remove_options)):
534
535
            db.session.delete(remove_options[a])
            db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
536
537
538
539

        remove_question = background_question.query.filter_by(
            idbackground_question=remove_id).first()

540
541
542
        db.session.delete(remove_question)
        db.session.commit()

Ossi Laine's avatar
Ossi Laine committed
543
    return redirect(url_for('experiment.view', exp_id=exp_id))
544
545


546
547
548
549
550
@experiment_blueprint.route('/set_embody')
@login_required
def set_embody():
    '''Enable/disable embody tool'''
    exp_id = request.args.get('exp_id', None)
Ossi Laine's avatar
Ossi Laine committed
551
    exp = experiment.query.filter_by(idexperiment=exp_id).first()
552
553
554
555
    exp.embody_enabled = (True if exp.embody_enabled == False else False)
    return redirect(url_for('experiment.view', exp_id=exp_id))


Ossi Laine's avatar
Ossi Laine committed
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
@experiment_blueprint.route('/add_embody', methods=['GET', 'POST'])
@login_required
def add_embody():

    exp_id = request.args.get('exp_id', None)
    default = request.args.get('default', None)
    exp_info = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_info.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
    elif default:

        # TODO: check if default image already added

Ossi Laine's avatar
Ossi Laine committed
571
572
573
        default_embody = embody_question(
            experiment_idexperiment=exp_id, picture=DEFAULT_EMBODY_PICTURE, question=DEFAULT_EMBODY_QUESTION)
        db.session.add(default_embody)
Ossi Laine's avatar
Ossi Laine committed
574
        exp_info.embody_enabled = 1
Ossi Laine's avatar
Ossi Laine committed
575
        db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
576
577
578
579
580
581
582
583
584
        return redirect(url_for('experiment.view', exp_id=exp_id))

    else:
        form = CreateEmbodyForm(request.form)

        if request.method == 'POST' and form.validate():
            picture = request.files.get("picture")
            question = request.form.get("question")

Ossi Laine's avatar
Ossi Laine committed
585
            # get filename
Ossi Laine's avatar
Ossi Laine committed
586
587
            filename = secure_filename(picture.filename)
            path = 'static/embody_images/' + str(exp_id)
Ossi Laine's avatar
Ossi Laine committed
588
            db_path = '/' + path + str('/') + str(filename)
Ossi Laine's avatar
Ossi Laine committed
589
590
591
592
593
594
595
596
597
598
            target = os.path.join(APP_ROOT, path)

            # create folder with experiment id (if it does not exist)
            if not os.path.isdir(target):
                os.mkdir(target)

            # save file to server
            destination = "/".join([target, filename])
            picture.save(destination)

Ossi Laine's avatar
Ossi Laine committed
599
600
601
            # add pages to the db
            new_embody = embody_question(
                experiment_idexperiment=exp_id, question=question, picture=db_path)
Ossi Laine's avatar
Ossi Laine committed
602
603
604
            db.session.add(new_embody)
            exp_info.embody_enabled = 1
            db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
605
            return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
606
607
608
609

        return render_template('add_embody.html', form=form)


610
611
612
@experiment_blueprint.route('/add_questions', methods=['GET', 'POST'])
@login_required
def add_questions():
Ossi Laine's avatar
Ossi Laine committed
613

614
615
616
617
618
619
620
621
    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_status.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
    else:
        form = CreateQuestionForm(request.form)
Ossi Laine's avatar
Ossi Laine committed
622

623
        if request.method == 'POST' and form.validate():
Ossi Laine's avatar
Ossi Laine committed
624

625
626
            str = form.questions_and_options.data
            str_list = str.split('/n')
Ossi Laine's avatar
Ossi Laine committed
627
628

            for a in range(len(str_list)):
629
                list = str_list[a].split(';')
Ossi Laine's avatar
Ossi Laine committed
630
631

                # If there are the right amount of values for the slider input values
632
                if len(list) == 3:
Ossi Laine's avatar
Ossi Laine committed
633
634
                    add_question = question(
                        experiment_idexperiment=exp_id, question=list[0], left=list[1], right=list[2])
635
636
                    db.session.add(add_question)
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
637
638

                # If slider has too many or too litlle parameters give an error and redirect back to input form
639
                else:
Ossi Laine's avatar
Ossi Laine committed
640
641
                    flash(
                        "Error Each slider must have 3 parameters separated by ; Some slider has:")
642
643
                    flash(len(list))
                    return redirect(url_for('create.experiment_questions', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
644
645
646

            return redirect(url_for('experiment.view', exp_id=exp_id))

647
648
649
650
651
652
        return render_template('add_questions.html', form=form)


@experiment_blueprint.route('/edit_question', methods=['GET', 'POST'])
@login_required
def edit_question():
Ossi Laine's avatar
Ossi Laine committed
653

654
655
656
    question_id = request.args.get('idquestion', None)
    current_question = question.query.filter_by(idquestion=question_id).first()
    form = EditQuestionForm(request.form, obj=current_question)
Ossi Laine's avatar
Ossi Laine committed
657

658
    if request.method == 'POST' and form.validate():
Ossi Laine's avatar
Ossi Laine committed
659

660
661
        form.populate_obj(current_question)
        db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
662

663
        return redirect(url_for('experiment.view', exp_id=current_question.experiment_idexperiment))
Ossi Laine's avatar
Ossi Laine committed
664

665
666
667
668
669
670
671
672
673
674
675
676
677
    return render_template('edit_question.html', form=form)


@experiment_blueprint.route('/remove_question')
@login_required
def remove_question():

    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_status.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
678

679
680
681
    else:

        remove_id = request.args.get('idquestion', None)
Ossi Laine's avatar
Ossi Laine committed
682
683
        remove_question = question.query.filter_by(
            idquestion=remove_id).first()
Ossi Laine's avatar
Ossi Laine committed
684
685

        # remove answers before removing questions
Ossi Laine's avatar
Ossi Laine committed
686
687
        remove_answers = answer.query.filter_by(
            question_idquestion=remove_question.idquestion).all()
Ossi Laine's avatar
Ossi Laine committed
688
689
690
        for a in range(len(remove_answers)):
            db.session.delete(remove_answers[a])
            db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
691

Ossi Laine's avatar
Ossi Laine committed
692
693
        db.session.delete(remove_question)
        db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
694

Ossi Laine's avatar
Ossi Laine committed
695
696
697
698
699
700
701
702
703
704
705
706
707
    return redirect(url_for('experiment.view', exp_id=exp_id))


@experiment_blueprint.route('/remove_embody')
@login_required
def remove_embody():

    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_status.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
708

Ossi Laine's avatar
Ossi Laine committed
709
710
    else:
        remove_id = request.args.get('idembody', None)
Ossi Laine's avatar
Ossi Laine committed
711
712
        remove_question = embody_question.query.filter_by(
            idembody=remove_id).first()
Ossi Laine's avatar
Ossi Laine committed
713
714
715
716
717

        # remove embody image from server
        if DEFAULT_EMBODY_PICTURE != remove_question.picture:
            os.remove(APP_ROOT + remove_question.picture)

Ossi Laine's avatar
Ossi Laine committed
718
719
        remove_answers = embody_answer.query.filter_by(
            embody_question_idembody=remove_question.idembody).all()
Ossi Laine's avatar
Ossi Laine committed
720
        remove_rows(remove_answers)
721
722
        db.session.delete(remove_question)
        db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
723

Ossi Laine's avatar
Ossi Laine committed
724
725
    question_count = embody_question.query.filter_by(
        experiment_idexperiment=exp_id).count()
Ossi Laine's avatar
Ossi Laine committed
726
727
728
729

    if question_count == 0:
        exp_status.embody_enabled = 0
        db.session.commit()
730

Ossi Laine's avatar
Ossi Laine committed
731
    return redirect(url_for('experiment.view', exp_id=exp_id))
732
733
734
735
736
737
738
739
740
741


# Stimuli:

@experiment_blueprint.route('/add_stimuli', methods=['GET', 'POST'])
@login_required
def add_stimuli():

    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()
Ossi Laine's avatar
Ossi Laine committed
742

743
744
745
746
    if exp_status.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
    else:
Ossi Laine's avatar
Ossi Laine committed
747
748
749
750
        # If there are no pages set for the experiment lets reroute user to create experiment stimuli upload instead
        is_there_any_stimuli = page.query.filter_by(
            experiment_idexperiment=exp_id).first()

751
752
        if is_there_any_stimuli is None:
            return redirect(url_for('create.experiment_upload_stimuli', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
753

754
755
        stimulus_type = request.args.get('stimulus_type', None)
        form = UploadStimuliForm(request.form)
Ossi Laine's avatar
Ossi Laine committed
756

757
758
759
760
        if request.method == 'POST':
            if stimulus_type == 'text':
                string = form.text.data
                str_list = string.split('/n')
Ossi Laine's avatar
Ossi Laine committed
761

762
                for a in range(len(str_list)):
Ossi Laine's avatar
Ossi Laine committed
763
764
                    add_text_stimulus = page(
                        experiment_idexperiment=exp_id, type='text', text=str_list[a], media='none')
765
766
                    db.session.add(add_text_stimulus)
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
767
768
769

                return redirect(url_for('experiment.view', exp_id=exp_id))

770
            else:
Ossi Laine's avatar
Ossi Laine committed
771
772
                # Upload stimuli into /static/experiment_stimuli/exp_id folder
                # Create the pages for the stimuli by inserting experiment_id, stimulus type, text and names of the stimulus files (as a path to the folder)
773
774
                path = 'static/experiment_stimuli/' + str(exp_id)
                target = os.path.join(APP_ROOT, path)
Ossi Laine's avatar
Ossi Laine committed
775

776
777
                if not os.path.isdir(target):
                    os.mkdir(target)
Ossi Laine's avatar
Ossi Laine committed
778
779

                # This returns a list of filenames: request.files.getlist("file")
780
                for file in request.files.getlist("file"):
Ossi Laine's avatar
Ossi Laine committed
781
                    # save files in the correct folder
782
783
784
                    filename = file.filename
                    destination = "/".join([target, filename])
                    file.save(destination)
Ossi Laine's avatar
Ossi Laine committed
785

Ossi Laine's avatar
Ossi Laine committed
786
787
788
789
                    # add pages to the db
                    db_path = path + str('/') + str(filename)
                    new_page = page(experiment_idexperiment=exp_id,
                                    type=form.type.data, media=db_path)
790
791
                    db.session.add(new_page)
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
792

793
                return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
794

795
796
797
798
799
800
801
802
803
804
805
806
            return redirect(url_for('experiment.view', exp_id=exp_id))

        return render_template('add_stimuli.html', form=form, stimulus_type=stimulus_type)


@experiment_blueprint.route('/edit_stimuli', methods=['GET', 'POST'])
@login_required
def edit_stimuli():

    exp_id = request.args.get('exp_id', None)
    page_id = request.args.get('idpage', None)
    edit_page = page.query.filter_by(idpage=page_id).first()
807
808
809
    form = EditPageForm(request.form)
    #form = EditPageForm(request.form, obj=edit_page)

Ossi Laine's avatar
Ossi Laine committed
810
    # TODO: replacing image not working -> form not getting validated for some reaseon !!
811

812
    if request.method == 'POST' and form.validate():
813
        print("POST IMAGE")
Ossi Laine's avatar
Ossi Laine committed
814
        # If the stimulus type is not text, then the old stimulus file is deleted from os and replaced
815
        if edit_page.type != 'text':
Ossi Laine's avatar
Ossi Laine committed
816
            # remove old file
817
818
819
            target = os.path.join(APP_ROOT, edit_page.media)
            os.remove(target)

Ossi Laine's avatar
Ossi Laine committed
820
            # upload new file
821
822
            path = 'static/experiment_stimuli/' + str(exp_id)
            target = os.path.join(APP_ROOT, path)
Ossi Laine's avatar
Ossi Laine committed
823

824
825
            if not os.path.isdir(target):
                os.mkdir(target)
Ossi Laine's avatar
Ossi Laine committed
826
827

            # This returns a list of filenames: request.files.getlist("file")
828
            for file in request.files.getlist("file"):
Ossi Laine's avatar
Ossi Laine committed
829
                # save files in the correct folder
830
831
832
                filename = file.filename
                destination = "/".join([target, filename])
                file.save(destination)
Ossi Laine's avatar
Ossi Laine committed
833
834
835
836

                # update db object
                db_path = path + str('/') + str(filename)
                edit_page.media = db_path
837
838
                db.session.commit()

Ossi Laine's avatar
Ossi Laine committed
839
        # If editing text stimulus no need for filehandling
840
        else:
Ossi Laine's avatar
Ossi Laine committed
841
842
843
            form.populate_obj(edit_page)
            db.session.commit()

844
        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
845

846
847
848
849
850
851
852
853
854
855
856
    return render_template('edit_stimuli.html', form=form, edit_page=edit_page)


@experiment_blueprint.route('/remove_stimuli')
@login_required
def remove_stimuli():

    exp_id = request.args.get('exp_id', None)
    exp_status = experiment.query.filter_by(idexperiment=exp_id).first()

    if exp_status.status != 'Hidden':
Ossi Laine's avatar
Ossi Laine committed
857

858
859
860
        flash("Experiment is public. Cannot modify structure.")

        return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
861

862
    else:
Ossi Laine's avatar
Ossi Laine committed
863

864
865
        remove_id = request.args.get('idpage', None)
        remove_page = page.query.filter_by(idpage=remove_id).first()
Ossi Laine's avatar
Ossi Laine committed
866
867
868
869
870
        experiment_pages = page.query.filter_by(
            experiment_idexperiment=exp_id).all()

        # if stimulustype is text, the stimulus itself is text on the database, other stimulus types are real files
        # on the server and need to be deleted
871
        if remove_page.type != 'text':
Ossi Laine's avatar
Ossi Laine committed
872
873

            # helper variable
874
            do_not_delete_file = 'False'
Ossi Laine's avatar
Ossi Laine committed
875
876

            # if the file to be deleted is in duplicate use of another page then we won't delete the file
877
878
879
            for a in range(len(experiment_pages)):
                if experiment_pages[a].media == remove_page.media and experiment_pages[a].idpage != remove_page.idpage:
                    do_not_delete_file = 'True'
Ossi Laine's avatar
Ossi Laine committed
880
881

            # If no other page is using the file then lets remove it
882
883
884
            if do_not_delete_file == 'False':
                target = os.path.join(APP_ROOT, remove_page.media)
                os.remove(target)
Ossi Laine's avatar
Ossi Laine committed
885

Ossi Laine's avatar
Ossi Laine committed
886
            # remove slider answer from this page
Ossi Laine's avatar
Ossi Laine committed
887
888
            remove_question_answers = answer.query.filter_by(
                page_idpage=remove_page.idpage).all()
Ossi Laine's avatar
Ossi Laine committed
889
890
891
            remove_rows(remove_question_answers)

            # remove embody answer from this page
Ossi Laine's avatar
Ossi Laine committed
892
893
            remove_embody_answers = embody_answer.query.filter_by(
                page_idpage=remove_page.idpage).all()
Ossi Laine's avatar
Ossi Laine committed
894
895
            remove_rows(remove_embody_answers)

896
897
            db.session.delete(remove_page)
            db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
898

899
            return redirect(url_for('experiment.view', exp_id=exp_id))
Ossi Laine's avatar
Ossi Laine committed
900

901
        if remove_page.type == 'text':
Ossi Laine's avatar
Ossi Laine committed
902

Ossi Laine's avatar
Ossi Laine committed
903
            # remove slider answer from this page
Ossi Laine's avatar
Ossi Laine committed
904
905
            remove_question_answers = answer.query.filter_by(
                page_idpage=remove_page.idpage).all()
Ossi Laine's avatar
Ossi Laine committed
906
907
908
            remove_rows(remove_question_answers)

            # remove embody answer from this page
Ossi Laine's avatar
Ossi Laine committed
909
910
            remove_embody_answers = embody_answer.query.filter_by(
                page_idpage=remove_page.idpage).all()
Ossi Laine's avatar
Ossi Laine committed
911
912
            remove_rows(remove_embody_answers)

913
914
            db.session.delete(remove_page)
            db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
915

916
917
            return redirect(url_for('experiment.view', exp_id=exp_id))

Ossi Laine's avatar
Ossi Laine committed
918
        return redirect(url_for('experiment.view', exp_id=exp_id))
919
920
921
922
923
924
925


# Misc:

@experiment_blueprint.route('/statistics')
@login_required
def statistics():
926
927

    # TODO: Answers are in normal order although questions might be in randomized order
Ossi Laine's avatar
Ossi Laine committed
928

929
    exp_id = request.args.get('exp_id', None)
Ossi Laine's avatar
Ossi Laine committed
930
931
932
933
934
935

    experiment_info = experiment.query.filter_by(idexperiment=exp_id).all()
    participants = answer_set.query.filter_by(
        experiment_idexperiment=exp_id).all()

    # started and finished ratings counters
936
937
938
939
940
941
942
    started_ratings = answer_set.query.filter_by(
        experiment_idexperiment=exp_id).count()
    experiment_page_count = page.query.filter_by(
        experiment_idexperiment=exp_id).count()
    finished_ratings = answer_set.query.filter(and_(
        answer_set.answer_counter == experiment_page_count, answer_set.experiment_idexperiment == exp_id)).count()

Ossi Laine's avatar
Ossi Laine committed
943
944
945
946
947
948
    # Rating task headers
    question_headers = question.query.filter_by(
        experiment_idexperiment=exp_id).all()
    stimulus_headers = page.query.filter_by(
        experiment_idexperiment=exp_id).all()

949
950
951
952
    pages = page.query.filter_by(experiment_idexperiment=exp_id).all()
    questions = question.query.filter_by(experiment_idexperiment=exp_id).all()
    pages_and_questions = {}

953
954
    '''

955
956
    for p in pages:
        questions_list = [(p.idpage, a.idquestion) for a in questions]
Ossi Laine's avatar
Ossi Laine committed
957
958
959
960
        pages_and_questions[p.idpage] = questions_list

    # List of answers per participant in format question Stimulus ID/Question ID
    # those are in answer table as page_idpage and question_idquestion respectively
961
    slider_answers = {}
962
    for participant in participants:
Ossi Laine's avatar
Ossi Laine committed
963

964
965
        if int(participant.answer_counter) == 0:
            continue
Ossi Laine's avatar
Ossi Laine committed
966

967
968
969
970
        answers = answer.query.filter_by(
            answer_set_idanswer_set=participant.idanswer_set)\
            .order_by(answer.page_idpage)\
            .all()
971

972
973
974
975
976
977
978
        # flatten pages and questions to list of tuples (page_id, question_id)
        _questions = [
            item for sublist in pages_and_questions.values() for item in sublist]


        slider_answers[participant.session] = map_answers_to_questions(
            answers, _questions)
979
980
981
982
983

    mean = get_mean_from_slider_answers(slider_answers)
    # slider_answers['mean'] = get_mean_from_slider_answers(slider_answers)

    slider_answers = {
984
        'mean': mean
985
    }
986

987
988
989
990
    '''

    slider_answers = {}

Ossi Laine's avatar
Ossi Laine committed
991
    # Background question answers
Ossi Laine's avatar
Ossi Laine committed
992
993
    bg_questions = background_question.query.filter_by(
        experiment_idexperiment=exp_id).all()
994
995
996
    bg_answers_for_participants = {}

    for participant in participants:
997
        if participant.answer_counter > 0:
998
999
1000
1001
            bg_answers = background_question_answer.query.filter_by(
                answer_set_idanswer_set=participant.idanswer_set).all()
            bg_answers_list = [(a.answer) for a in bg_answers]
            bg_answers_for_participants[participant.session] = bg_answers_list
Ossi Laine's avatar
Ossi Laine committed
1002
1003
1004
1005
1006

    # embody questions
    embody_questions = embody_question.query.filter_by(
        experiment_idexperiment=exp_id).all()

Ossi Laine's avatar
Ossi Laine committed
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
    return render_template('experiment_statistics.html',
                           experiment_info=experiment_info,
                           participants_and_answers=slider_answers,
                           pages_and_questions=pages_and_questions,
                           bg_questions=bg_questions,
                           bg_answers_for_participants=bg_answers_for_participants,
                           started_ratings=started_ratings,
                           finished_ratings=finished_ratings,
                           question_headers=question_headers,
                           stimulus_headers=stimulus_headers,
Ossi Laine's avatar
Ossi Laine committed
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
                           embody_questions=embody_questions)


@experiment_blueprint.route('/download_csv')
def download_csv():
    exp_id = request.args.get('exp_id', None)
    path = request.args.get('path', None)

    filename = "experiment_{}_{}.csv".format(
        exp_id, date.today().strftime("%Y-%m-%d"))

    path = '/tmp/' + path

    try:
        return send_file(path,
                         mimetype='text/csv',
                         as_attachment=True,
                         attachment_filename=filename)

    finally:
        os.remove(path)