views.py 38.2 KB
Newer Older
1
2
3
4


import os
import secrets
5
import json
6
7
8
9
10
11
12
13
14

from flask import (
    Flask, 
    render_template, 
    request, 
    session, 
    flash, 
    redirect, 
    url_for, 
15
16
    Blueprint,
    jsonify
17
18
19
20
21
22
23
24
25
26
27
28
29
30
)

from wtforms import Form
from sqlalchemy import and_, update
from flask_login import login_required

from app import app, db 
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
from app.models import user, trial_randomization
Ossi Laine's avatar
Ossi Laine committed
31
from app.models import embody_answer, embody_question
32
33
34
35
from app.forms import (
    CreateBackgroundQuestionForm, 
    CreateQuestionForm, UploadStimuliForm, EditBackgroundQuestionForm, 
    EditQuestionForm, EditExperimentForm, UploadResearchBulletinForm, 
Ossi Laine's avatar
Ossi Laine committed
36
    EditPageForm, RemoveExperimentForm, GenerateIdForm,CreateEmbodyForm
37
)
Ossi Laine's avatar
Ossi Laine committed
38
from werkzeug import secure_filename
39
40
41
42
43
44
45
46
47

#Stimuli upload folder setting
#APP_ROOT = os.path.dirname(os.path.abspath(__file__))

experiment_blueprint = Blueprint("experiment", __name__, 
                template_folder='templates',
                #static_folder='static',
                url_prefix='/experiment')

Ossi Laine's avatar
Ossi Laine committed
48
49
50
# 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'
51
52
53
54
55
56
57
58
59

@experiment_blueprint.route('/view')
@login_required
def view():
    
    #crap:3lines
    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
62
63
64
    mtype = page.query.filter_by(experiment_idexperiment=exp_id).first()
    
    #experiment info    
    experiment_info = experiment.query.filter_by(idexperiment = exp_id).all()
Ossi Laine's avatar
Ossi Laine committed
65

66
67
    #background questions
    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

82
83
84
85
    #sliderset
    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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134


# 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':
    
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
        
    else:
    
        form = RemoveExperimentForm(request.form)
        
        if request.method == 'POST' and form.validate():
    
            if form.remove.data == 'DELETE':
    
                #This removes all experiment data from the database!
                
                #Remove research bulletin if it exists
                empty_filevariable = experiment.query.filter_by(idexperiment=exp_id).first()
    
                if empty_filevariable.research_notification_filename is not None:
                    target = os.path.join(APP_ROOT, empty_filevariable.research_notification_filename)
                    
                    if os.path.exists(target):                   
                        os.remove(target)
                
                #Tables
                remove_forced_id = forced_id.query.filter_by(experiment_idexperiment=exp_id).all()
Ossi Laine's avatar
Ossi Laine committed
135
                remove_rows(remove_forced_id)
136
137
138
139
140
141

                #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
                for a in range(len(remove_background_question)):
Ossi Laine's avatar
Ossi Laine committed
142
143
144
                    remove_background_question_option = background_question_option.query.filter_by(background_question_idbackground_question=remove_background_question[a].idbackground_question).all() 
                    remove_rows(remove_background_question_option)

145
                    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
146
147
                    remove_rows(remove_background_question_answers)

148
149
150
151
152
153
154
                    db.session.delete(remove_background_question[a])
                    db.session.commit()
               
                #Remove all questions and answers 
                remove_question = question.query.filter_by(experiment_idexperiment=exp_id).all()
                for a in range(len(remove_question)):
                    remove_question_answers = answer.query.filter_by(question_idquestion=remove_question[a].idquestion).all()
Ossi Laine's avatar
Ossi Laine committed
155
                    remove_rows(remove_question_answers)
156
157
                    db.session.delete(remove_question[a])
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
158
159
160
161
162
163

                # 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)
                remove_embody_questions = embody_question.query.filter_by(experiment_idexperiment=exp_id).all()
Ossi Laine's avatar
Ossi Laine committed
164
165
166
167
168
169

                for a in range(len(remove_embody_questions)):
                    target = APP_ROOT + remove_embody_questions[a].picture
                    if os.path.exists(target) and DEFAULT_EMBODY_PICTURE != remove_embody_questions[a].picture:                   
                        os.remove(target)

Ossi Laine's avatar
Ossi Laine committed
170
171
                remove_rows(remove_embody_questions)

172
173
174
175
                #Remove all pages and datafiles
                remove_pages = page.query.filter_by(experiment_idexperiment=exp_id).all()
                
                for a in range(len(remove_pages)):
Ossi Laine's avatar
Ossi Laine committed
176
                    if remove_pages[a].type != 'text':
177
178
179
180
181
182
183
                        target = os.path.join(APP_ROOT, remove_pages[a].media)
                        if os.path.exists(target):                   
                            os.remove(target)
        
                    #Now that the files are removed we can delete the page
                    db.session.delete(remove_pages[a])
                    db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
184

185
186
187
188
189
190
                    
                #Remove all answer_sets and trial_randomization orders
                remove_answer_set = answer_set.query.filter_by(experiment_idexperiment=exp_id).all()
                
                for a in range(len(remove_answer_set)):
                    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
191
                    remove_rows(remove_trial_randomizations)
192
193
194
195
196
197
198
                    db.session.delete(remove_answer_set[a])
                    db.session.commit()
                
                #Remove experiment table
                remove_experiment = experiment.query.filter_by(idexperiment=exp_id).first()
                db.session.delete(remove_experiment)
                db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
199
200
201
202

                # Remove empty directories
                os.rmdir(APP_ROOT + '/static/embody_images/' + str(exp_id))
                os.rmdir(APP_ROOT + '/static/experiment_stimuli/' + str(exp_id))
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
                
                flash("Experiment was removed from database!")
                return redirect(url_for('index'))
                
            else:
                flash("Experiment was not removed!")
                return redirect(url_for('experiment.view', exp_id=exp_id))
        
        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)
    publish_experiment = experiment.query.filter_by(idexperiment = exp_id).first()
    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)
    hide_experiment = experiment.query.filter_by(idexperiment = exp_id).first()
    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)
    private_experiment = experiment.query.filter_by(idexperiment = exp_id).first()
    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")

    experiment.query.filter_by(idexperiment = exp_id).first().randomization = status
    db.session.commit()
  
    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")

    experiment.query.filter_by(idexperiment = exp_id).first().use_forced_id = status
    db.session.commit()
  
    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)
        
    if request.method == 'POST' and form.validate():

        for i in range(int(request.form['number'])): 
            random_id = str(request.form['string']) + str(secrets.token_hex(3))
            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
            if check_answer_set is not None or check_forced_id is not None:
            
                #flash("ID already existed; generated a new one")
                random_id = secrets.token_hex(3)
                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)
            db.session.add(input_id)
            db.session.commit()
        
313
        return redirect(url_for('experiment.view_forced_id_list', exp_id=exp_id))
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
403
404
405
406
407
408
409
410
411
    
    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)
    
    if request.method == 'POST':
        path = 'static/experiment_stimuli/' + str(exp_id)
        target = os.path.join(APP_ROOT, path)
                
        if not os.path.isdir(target):
            os.mkdir(target)
            
        #This returns a list of filenames: request.files.getlist("file")
        for file in request.files.getlist("file"):
            #save files in the correct folder
            filename = file.filename
            destination = "/".join([target, filename])
            file.save(destination)
            
            #add pages to the db
            db_path = path +  str('/') + str(filename)
            bulletin = experiment.query.filter_by(idexperiment=exp_id).first()
            bulletin.research_notification_filename = db_path
            db.session.commit()
            
        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'''
    
    exp_id = request.args.get('exp_id', None)
    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):                   
        os.remove(target)
    
    empty_filevariable.research_notification_filename = None
    db.session.commit()
    
    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)
    current_experiment = experiment.query.filter_by(idexperiment=exp_id).first()
    
    form = EditExperimentForm(request.form, obj=current_experiment)
    form.language.default = current_experiment.language
    
    if request.method == 'POST' and form.validate():
        
        form.populate_obj(current_experiment)
        db.session.commit()
        
        return redirect(url_for('experiment.view', exp_id=exp_id))
    
    return render_template('edit_experiment.html', form=form, exp_id=exp_id)





# Background questions:

@experiment_blueprint.route('/add_bg_question', methods=['GET', 'POST'])
@login_required
def add_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))
        
    else:
        form = CreateBackgroundQuestionForm(request.form)
        
        if request.method == 'POST' and form.validate():
            
            #Split the form data into a list that separates questions followed by the corresponding options
412
            str = form.bg_questions_and_options.data
413
414
415
416
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
            str_list = str.split('/n')
    
            #Iterate through the questions and options list
            for a in range(len(str_list)):
                #Split the list cells further into questions and options
                list = str_list[a].split(';')
            
                #Input the first item of the list as a question in db and the items followed by that as options for that question
                for x in range(len(list)):
                    if x == 0:
                        add_bgquestion = background_question(background_question=list[x], experiment_idexperiment=exp_id)
                        db.session.add(add_bgquestion)
                        db.session.commit()
                    else:
                        add_bgq_option = background_question_option(background_question_idbackground_question=add_bgquestion.idbackground_question, option=list[x])
                        db.session.add(add_bgq_option)
                        db.session.commit()
            
            return redirect(url_for('experiment.view', exp_id=exp_id))    
    
        return render_template('add_bg_question.html', form=form)


@experiment_blueprint.route('/edit_bg_question', methods=['GET', 'POST'])
@login_required
def edit_bg_question():
    
    bg_question_id = request.args.get('idbackground_question', None)

    #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
    question_string = current_bg_question.background_question
    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)
    
    form = EditBackgroundQuestionForm(request.form)
    form.bg_questions_and_options.data = question_string

    #After user chooses to update the question and options lets replace the old question and options with the ones from the form
    if request.method == 'POST' and form.validate():
        #Explode the string with new values from the form 
        form_values = form.new_values.data
        form_values_list = form_values.split(';')
        
        #Check and remove possible whitespaces from string beginnings with lstrip
        for x in range(len(form_values_list)):
            form_values_list[x] = form_values_list[x].lstrip()
        
        #Cycle through strings and update db
        for x in range(len(form_values_list)):
        
            #Replace question and update the object to database
            if x == 0:
                current_bg_question.background_question  = form_values_list[x] 
                db.session.commit()
                
                #Delete old options from db
                for o in options:
                    db.session.delete(o)
                    db.session.commit()
            
            #Insert new options to db
            else:
                new_option = background_question_option(background_question_idbackground_question=current_bg_question.idbackground_question, option=form_values_list[x])
                db.session.add(new_option)
                db.session.commit()
        
        return redirect(url_for('experiment.view', exp_id=exp_id))
    
    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))
        
    else:
501

502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
        remove_id = request.args.get('idbackground_question', None)
        remove_options = background_question_option.query.filter_by(background_question_idbackground_question=remove_id).all()
        
        for a in range(len(remove_options)): 
            db.session.delete(remove_options[a])
            db.session.commit()
            
        remove_question = background_question.query.filter_by(idbackground_question=remove_id).first()
        
        db.session.delete(remove_question)
        db.session.commit()
  
    return redirect(url_for('experiment.view', exp_id=exp_id))




519
520
521
522
523
524
525
526
527
528
@experiment_blueprint.route('/set_embody')
@login_required
def set_embody():
    '''Enable/disable embody tool'''
    exp_id = request.args.get('exp_id', None)
    exp = experiment.query.filter_by(idexperiment = exp_id).first()
    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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
@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

        default_embody = embody_question(experiment_idexperiment=exp_id, picture=DEFAULT_EMBODY_PICTURE, question=DEFAULT_EMBODY_QUESTION)
        db.session.add(default_embody) 
        exp_info.embody_enabled = 1
        db.session.commit() 
        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")

            # get filename 
            filename = secure_filename(picture.filename)
            path = 'static/embody_images/' + str(exp_id)
            db_path = '/' + path +  str('/') + str(filename)
            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)

            #add pages to the db
            new_embody = embody_question(experiment_idexperiment=exp_id, question=question, picture=db_path)
            db.session.add(new_embody)
            exp_info.embody_enabled = 1
            db.session.commit()


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

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


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
@experiment_blueprint.route('/add_questions', methods=['GET', 'POST'])
@login_required
def add_questions():
    
    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)
        
        if request.method == 'POST' and form.validate():
    
            str = form.questions_and_options.data
            str_list = str.split('/n')
    
            for a in range(len(str_list)): 
                list = str_list[a].split(';')
                         
                #If there are the right amount of values for the slider input values
                if len(list) == 3:
                    add_question = question(experiment_idexperiment=exp_id, question=list[0], left=list[1], right=list[2])
                    db.session.add(add_question)
                    db.session.commit()
                        
610
                #If slider has too many or too litlle parameters give an error and redirect back to input form
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
                else:
                    flash("Error Each slider must have 3 parameters separated by ; Some slider has:")
                    flash(len(list))
                    return redirect(url_for('create.experiment_questions', exp_id=exp_id))
            
            return redirect(url_for('experiment.view', exp_id=exp_id))    
    
        return render_template('add_questions.html', form=form)


@experiment_blueprint.route('/edit_question', methods=['GET', 'POST'])
@login_required
def edit_question():
    
    question_id = request.args.get('idquestion', None)
    current_question = question.query.filter_by(idquestion=question_id).first()
    form = EditQuestionForm(request.form, obj=current_question)
    
    if request.method == 'POST' and form.validate():
        
        form.populate_obj(current_question)
        db.session.commit()
        
        return redirect(url_for('experiment.view', exp_id=current_question.experiment_idexperiment))
  
    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))
        
    else:

        remove_id = request.args.get('idquestion', None)
        remove_question = question.query.filter_by(idquestion=remove_id).first()
Ossi Laine's avatar
Ossi Laine committed
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676

        # remove answers before removing questions
        remove_answers = answer.query.filter_by(question_idquestion=remove_question.idquestion).all()
        for a in range(len(remove_answers)):
            db.session.delete(remove_answers[a])
            db.session.commit()
                    
        db.session.delete(remove_question)
        db.session.commit()
  
    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))
677
        
Ossi Laine's avatar
Ossi Laine committed
678
679
680
681
682
683
684
685
686
687
    else:
        remove_id = request.args.get('idembody', None)
        remove_question = embody_question.query.filter_by(idembody=remove_id).first()

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

        remove_answers = embody_answer.query.filter_by(embody_question_idembody=remove_question.idembody).all()
        remove_rows(remove_answers)
688
689
        db.session.delete(remove_question)
        db.session.commit()
Ossi Laine's avatar
Ossi Laine committed
690
691
692
693
694
695
696

    
    question_count = embody_question.query.filter_by(experiment_idexperiment=exp_id).count()

    if question_count == 0:
        exp_status.embody_enabled = 0
        db.session.commit()
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
  
    return redirect(url_for('experiment.view', exp_id=exp_id))



# 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()
    
    if exp_status.status != 'Hidden':
        flash("Experiment is public. Cannot modify structure.")
        return redirect(url_for('experiment.view', exp_id=exp_id))
    else:
        #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()
    
        if is_there_any_stimuli is None:
            return redirect(url_for('create.experiment_upload_stimuli', exp_id=exp_id))
        
        stimulus_type = request.args.get('stimulus_type', None)
        form = UploadStimuliForm(request.form)
    
        if request.method == 'POST':
            if stimulus_type == 'text':
                string = form.text.data
                str_list = string.split('/n')
    
                for a in range(len(str_list)):
                    add_text_stimulus = page(experiment_idexperiment=exp_id, type='text', text=str_list[a], media='none')
                    db.session.add(add_text_stimulus)
                    db.session.commit()
                    
                return redirect(url_for('experiment.view', exp_id=exp_id))  
            
            else:
                #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)
                path = 'static/experiment_stimuli/' + str(exp_id)
                target = os.path.join(APP_ROOT, path)
                
                if not os.path.isdir(target):
                    os.mkdir(target)
            
                #This returns a list of filenames: request.files.getlist("file")
                for file in request.files.getlist("file"):
                    #save files in the correct folder
                    filename = file.filename
                    destination = "/".join([target, filename])
                    file.save(destination)
Ossi Laine's avatar
Ossi Laine committed
751

752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
                    #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)
                    db.session.add(new_page)
                    db.session.commit()
                    
                return redirect(url_for('experiment.view', exp_id=exp_id))
                
            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()
772
773
774
    form = EditPageForm(request.form)
    #form = EditPageForm(request.form, obj=edit_page)

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

777
    if request.method == 'POST' and form.validate():
778
        print("POST IMAGE")
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
        #If the stimulus type is not text, then the old stimulus file is deleted from os and replaced
        if edit_page.type != 'text':
            #remove old file            
            target = os.path.join(APP_ROOT, edit_page.media)
            os.remove(target)

            #upload new file
            path = 'static/experiment_stimuli/' + str(exp_id)
            target = os.path.join(APP_ROOT, path)
            
            if not os.path.isdir(target):
                os.mkdir(target)
        
            #This returns a list of filenames: request.files.getlist("file")
            for file in request.files.getlist("file"):
                #save files in the correct folder
                filename = file.filename
                destination = "/".join([target, filename])
                file.save(destination)
                
                #update db object
                db_path = path +  str('/') + str(filename)
                edit_page.media=db_path
                db.session.commit()

        #If editing text stimulus no need for filehandling    
        else:
             form.populate_obj(edit_page)
             db.session.commit()
                           
        return redirect(url_for('experiment.view', exp_id=exp_id))
  
    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':
    
        flash("Experiment is public. Cannot modify structure.")

        return redirect(url_for('experiment.view', exp_id=exp_id))
        
    else:
    
        remove_id = request.args.get('idpage', None)
        remove_page = page.query.filter_by(idpage=remove_id).first()
        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    
        if remove_page.type != 'text':
            
            #helper variable
            do_not_delete_file = 'False'
                
            #if the file to be deleted is in duplicate use of another page then we won't delete the file
            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'
    
            #If no other page is using the file then lets remove it
            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
850
851
852
853
854
855
856
857
            # remove slider answer from this page
            remove_question_answers = answer.query.filter_by(page_idpage=remove_page.idpage).all()
            remove_rows(remove_question_answers)

            # remove embody answer from this page
            remove_embody_answers = embody_answer.query.filter_by(page_idpage=remove_page.idpage).all()
            remove_rows(remove_embody_answers)

858
859
860
861
862
            db.session.delete(remove_page)
            db.session.commit()
      
            return redirect(url_for('experiment.view', exp_id=exp_id))
        
Ossi Laine's avatar
Ossi Laine committed
863
        
864
865
        if remove_page.type == 'text':
            
Ossi Laine's avatar
Ossi Laine committed
866
867
868
869
870
871
872
873
            # remove slider answer from this page
            remove_question_answers = answer.query.filter_by(page_idpage=remove_page.idpage).all()
            remove_rows(remove_question_answers)

            # remove embody answer from this page
            remove_embody_answers = embody_answer.query.filter_by(page_idpage=remove_page.idpage).all()
            remove_rows(remove_embody_answers)

874
875
876
877
878
879
880
881
882
883
884
885
886
887
            db.session.delete(remove_page)
            db.session.commit()
            
            return redirect(url_for('experiment.view', exp_id=exp_id))
        
        return redirect(url_for('experiment.view', exp_id=exp_id))



# Misc:

@experiment_blueprint.route('/statistics')
@login_required
def statistics():
888
889

    # TODO: Answers are in normal order although questions might be in randomized order
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
    
    exp_id = request.args.get('exp_id', None)
    
    experiment_info = experiment.query.filter_by(idexperiment = exp_id).all()
    participants = answer_set.query.filter_by(experiment_idexperiment= exp_id).all()
    
    
    #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()
    
    pages = page.query.filter_by(experiment_idexperiment=exp_id).all()
    questions = question.query.filter_by(experiment_idexperiment=exp_id).all()
    pages_and_questions = {}

    for p in pages:
        
        questions_list = [(p.idpage, a.idquestion) for a in questions]
        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
    
    participants_and_answers = {}
    
    for participant in participants:
 
        answers = answer.query.filter_by(answer_set_idanswer_set=participant.idanswer_set).all()     
        answers_list = [(a.idanswer, a.question_idquestion, a.answer_set_idanswer_set, a.answer, a.page_idpage) for a in answers]    
        participants_and_answers[participant.session] = answers_list 

    #Background question answers
        
Ossi Laine's avatar
Ossi Laine committed
923
924
    bg_questions = background_question.query.filter_by(
        experiment_idexperiment=exp_id).all()
925
926
927
928
    bg_answers_for_participants = {}

    for participant in participants:

Ossi Laine's avatar
Ossi Laine committed
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
        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

    #started and finished ratings counters
    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()

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

    return render_template('experiment_statistics.html', experiment_info=experiment_info, participants_and_answers=participants_and_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, embody_questions=embody_questions)
947
948


949
950
import embody_plot
from flask_cors import CORS,cross_origin
951
952
from flask_socketio import emit
from app import socketio
953
954


955
956
957
958
959
''' 
Old method
#@experiment_blueprint.route('/create_embody', methods=['POST'])
#@cross_origin()
def create_embody():
960
961
962
963
964
965
    #page = request.args.get("page")
    page = request.form["page"]
    img_path = embody_plot.get_coordinates(page)

    #return send_file('static/' + img_path, 'test')
    return json.dumps({'path':img_path})
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
''' 
# (https://flask-socketio.readthedocs.io/en/latest/)
# TODO: Using nginx as a WebSocket Reverse Proxy
# TODO: Gunicorn Web Server

@cross_origin()
@socketio.on('connect', namespace="/create_embody")
def create_embody():
    print("connection succesful")
    emit('success', {'connection': 'on'})

@cross_origin()
@socketio.on('draw', namespace="/create_embody")
def create_embody(page_id):
    page = page_id["page"]
Ossi Laine's avatar
Ossi Laine committed
981
    embody = page_id["embody"]
982

Ossi Laine's avatar
Ossi Laine committed
983
    img_path = embody_plot.get_coordinates(page, embody)
984
985
986
987
988
989
990
991
992
993
    print(img_path)
    emit('end', {'path':img_path})

'''
@socketio.on('end', namespace="/create_embody")
def create_embody():
    print("connection end")
    emit('end', {'connection': 'off'})
'''

Ossi Laine's avatar
Ossi Laine committed
994
995
996
997
998
999
1000

def remove_rows(rows):
    """Remove list of rows from database"""
    for a in range(len(rows)):
        db.session.delete(rows[a])
        db.session.commit()

1001
# EOF