aboutsummaryrefslogtreecommitdiff
path: root/uploader/population/rqtl2.py
blob: 9968bd67974594983746c84942791238ce89379e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
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
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
610
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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
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
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
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
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
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
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
"""Module to handle uploading of R/qtl2 bundles."""#pylint: disable=[too-many-lines]
import sys
import json
import traceback
from pathlib import Path
from uuid import UUID, uuid4
from functools import partial
from zipfile import ZipFile, is_zipfile
from typing import Union, Callable, Optional

import MySQLdb as mdb
from redis import Redis
from MySQLdb.cursors import DictCursor
from werkzeug.utils import secure_filename
from flask import (
    flash,
    escape,
    request,
    jsonify,
    url_for,
    redirect,
    Response,
    Blueprint,
    render_template,
    current_app as app)

from r_qtl import r_qtl2

from uploader import jobs
from uploader.files import save_file, fullpath
from uploader.species.models import all_species
from uploader.db_utils import with_db_connection, database_connection

from uploader.authorisation import require_login
from uploader.platforms.models import platform_by_id, platforms_by_species
from uploader.db.averaging import averaging_methods, averaging_method_by_id
from uploader.db.tissues import all_tissues, tissue_by_id, create_new_tissue
from uploader.population.models import (populations_by_species,
                                        population_by_species_and_id)
from uploader.species.models import species_by_id
from uploader.db.datasets import (
    geno_dataset_by_id,
    geno_datasets_by_species_and_population,

    probeset_study_by_id,
    probeset_create_study,
    probeset_dataset_by_id,
    probeset_create_dataset,
    probeset_datasets_by_study,
    probeset_studies_by_species_and_population)

rqtl2 = Blueprint("rqtl2", __name__)


@rqtl2.route("/", methods=["GET", "POST"])
@rqtl2.route("/select-species", methods=["GET", "POST"])
@require_login
def select_species():
    """Select the species."""
    if request.method == "GET":
        return render_template("expression-data/rqtl2/index.html",
                               species=with_db_connection(all_species))

    species_id = request.form.get("species_id")
    species = with_db_connection(
        lambda conn: species_by_id(conn, species_id))
    if bool(species):
        return redirect(url_for(
            "species.populations.expression-data.rqtl2.select_population",
            species_id=species_id))
    flash("Invalid species or no species selected!", "alert-error error-rqtl2")
    return redirect(url_for("expression-data.rqtl2.select_species"))


@rqtl2.route("<int:species_id>/expression-data/rqtl2/select-population",
             methods=["GET", "POST"])
@require_login
def select_population(species_id: int):
    """Select/Create the population to organise data under."""
    with database_connection(app.config["SQL_URI"]) as conn:
        species = species_by_id(conn, species_id)
        if not bool(species):
            flash("Invalid species selected!", "alert-error error-rqtl2")
            return redirect(url_for("expression-data.rqtl2.select_species"))

        if request.method == "GET":
            return render_template(
                "expression-data/rqtl2/select-population.html",
                species=species,
                populations=populations_by_species(conn, species_id))

        population = population_by_species_and_id(
            conn, species["SpeciesId"], request.form.get("inbredset_id"))
        if not bool(population):
            flash("Invalid Population!", "alert-error error-rqtl2")
            return redirect(
                url_for("expression-data.rqtl2.select_population", pgsrc="error"),
                code=307)

        return redirect(url_for("expression-data.rqtl2.upload_rqtl2_bundle",
                                species_id=species["SpeciesId"],
                                population_id=population["InbredSetId"]))


class __RequestError__(Exception): #pylint: disable=[invalid-name]
    """Internal class to avoid pylint's `too-many-return-statements` error."""


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle"),
    methods=["GET", "POST"])
@require_login
def upload_rqtl2_bundle(species_id: int, population_id: int):
    """Allow upload of R/qtl2 bundle."""
    with database_connection(app.config["SQL_URI"]) as conn:
        species = species_by_id(conn, species_id)
        population = population_by_species_and_id(
            conn, species["SpeciesId"], population_id)
        if not bool(species):
            flash("Invalid species!", "alert-error error-rqtl2")
            return redirect(url_for("expression-data.rqtl2.select_species"))
        if not bool(population):
            flash("Invalid Population!", "alert-error error-rqtl2")
            return redirect(
                url_for("expression-data.rqtl2.select_population", pgsrc="error"),
                code=307)
        if request.method == "GET" or (
                request.method == "POST"
                and bool(request.args.get("pgsrc"))):
            return render_template(
                "expression-data/rqtl2/upload-rqtl2-bundle-step-01.html",
                species=species,
                population=population)

        try:
            app.logger.debug("Files in the form: %s", request.files)
            the_file = save_file(request.files["rqtl2_bundle_file"],
                                 Path(app.config["UPLOAD_FOLDER"]))
        except AssertionError:
            app.logger.debug(traceback.format_exc())
            flash("Please provide a valid R/qtl2 zip bundle.",
                  "alert-error error-rqtl2")
            return redirect(url_for("expression-data.rqtl2.upload_rqtl2_bundle",
                                    species_id=species_id,
                                    population_id=population_id))

        if not is_zipfile(str(the_file)):
            app.logger.debug("The file is not a zip file.")
            raise __RequestError__("Invalid file! Expected a zip file.")

        jobid = trigger_rqtl2_bundle_qc(
            species_id,
            population_id,
            the_file,
            request.files["rqtl2_bundle_file"].filename)#type: ignore[arg-type]
        return redirect(url_for(
            "expression-data.rqtl2.rqtl2_bundle_qc_status", jobid=jobid))


def trigger_rqtl2_bundle_qc(
        species_id: int,
        population_id: int,
        rqtl2bundle: Path,
        originalfilename: str
) -> UUID:
    """Trigger QC on the R/qtl2 bundle."""
    redisuri = app.config["REDIS_URL"]
    with Redis.from_url(redisuri, decode_responses=True) as rconn:
        jobid = uuid4()
        redis_ttl_seconds = app.config["JOBS_TTL_SECONDS"]
        jobs.launch_job(
            jobs.initialise_job(
                rconn,
                jobs.jobsnamespace(),
                str(jobid),
                [sys.executable, "-m", "scripts.qc_on_rqtl2_bundle",
                 app.config["SQL_URI"], app.config["REDIS_URL"],
                 jobs.jobsnamespace(), str(jobid), str(species_id),
                 str(population_id), "--redisexpiry",
                 str(redis_ttl_seconds)],
                "rqtl2-bundle-qc-job",
                redis_ttl_seconds,
                {"job-metadata": json.dumps({
                    "speciesid": species_id,
                    "populationid": population_id,
                    "rqtl2-bundle-file": str(rqtl2bundle.absolute()),
                    "original-filename": originalfilename})}),
            redisuri,
            f"{app.config['UPLOAD_FOLDER']}/job_errors")
        return jobid


def chunk_name(uploadfilename: str, chunkno: int) -> str:
    """Generate chunk name from original filename and chunk number"""
    if uploadfilename == "":
        raise ValueError("Name cannot be empty!")
    if chunkno < 1:
        raise ValueError("Chunk number must be greater than zero")
    return f"{secure_filename(uploadfilename)}_part_{chunkno:05d}"


def chunks_directory(uniqueidentifier: str) -> Path:
    """Compute the directory where chunks are temporarily stored."""
    if uniqueidentifier == "":
        raise ValueError("Unique identifier cannot be empty!")
    return Path(app.config["UPLOAD_FOLDER"], f"tempdir_{uniqueidentifier}")


@rqtl2.route(("<int:species_id>/populations/<int:population_id>/rqtl2/"
              "/rqtl2-bundle-chunked"),
             methods=["GET"])
@require_login
def upload_rqtl2_bundle_chunked_get(# pylint: disable=["unused-argument"]
        species_id: int,
        population_id: int
):
    """
    Extension to the `upload_rqtl2_bundle` endpoint above that provides a way
    for testing whether all the chunks have been uploaded and to assist with
    resuming a failed expression-data.
    """
    fileid = request.args.get("resumableIdentifier", type=str) or ""
    filename = request.args.get("resumableFilename", type=str) or ""
    chunk = request.args.get("resumableChunkNumber", type=int) or 0
    if not(fileid or filename or chunk):
        return jsonify({
            "message": "At least one required query parameter is missing.",
            "error": "BadRequest",
            "statuscode": 400
        }), 400

    if Path(chunks_directory(fileid),
            chunk_name(filename, chunk)).exists():
        return "OK"

    return jsonify({
            "message": f"Chunk {chunk} was not found.",
            "error": "NotFound",
            "statuscode": 404
        }), 404


def __merge_chunks__(targetfile: Path, chunkpaths: tuple[Path, ...]) -> Path:
    """Merge the chunks into a single file."""
    with open(targetfile, "ab") as _target:
        for chunkfile in chunkpaths:
            with open(chunkfile, "rb") as _chunkdata:
                _target.write(_chunkdata.read())

            chunkfile.unlink()
    return targetfile


@rqtl2.route(("<int:species_id>/population/<int:population_id>/rqtl2/upload/"
              "/rqtl2-bundle-chunked"),
             methods=["POST"])
@require_login
def upload_rqtl2_bundle_chunked_post(species_id: int, population_id: int):
    """
    Extension to the `upload_rqtl2_bundle` endpoint above that allows large
    files to be uploaded in chunks.

    This should hopefully speed up uploads, and if done right, even enable
    resumable uploads
    """
    _totalchunks = request.form.get("resumableTotalChunks", type=int) or 0
    _chunk = request.form.get("resumableChunkNumber", default=1, type=int)
    _uploadfilename = request.form.get(
        "resumableFilename", default="", type=str) or ""
    _fileid = request.form.get(
        "resumableIdentifier", default="", type=str) or ""
    _targetfile = Path(app.config["UPLOAD_FOLDER"], _fileid)

    if _targetfile.exists():
        return jsonify({
            "message": (
                "A file with a similar unique identifier has previously been "
                "uploaded and possibly is/has being/been processed."),
            "error": "BadRequest",
            "statuscode": 400
        }), 400

    try:
        # save chunk data
        chunks_directory(_fileid).mkdir(exist_ok=True, parents=True)
        request.files["file"].save(Path(chunks_directory(_fileid),
                                        chunk_name(_uploadfilename, _chunk)))

        # Check whether upload is complete
        chunkpaths = tuple(
            Path(chunks_directory(_fileid), chunk_name(_uploadfilename, _achunk))
            for _achunk in range(1, _totalchunks+1))
        if all(_file.exists() for _file in chunkpaths):
            # merge_files and clean up chunks
            __merge_chunks__(_targetfile, chunkpaths)
            chunks_directory(_fileid).rmdir()
            jobid = trigger_rqtl2_bundle_qc(
                species_id, population_id, _targetfile, _uploadfilename)
            return url_for(
                "expression-data.rqtl2.rqtl2_bundle_qc_status", jobid=jobid)
    except Exception as exc:# pylint: disable=[broad-except]
        msg = "Error processing uploaded file chunks."
        app.logger.error(msg, exc_info=True, stack_info=True)
        return jsonify({
            "message": msg,
            "error": type(exc).__name__,
            "error-description": " ".join(str(arg) for arg in exc.args),
            "error-trace": traceback.format_exception(exc)
        }), 500

    return "OK"


@rqtl2.route("/upload/species/rqtl2-bundle/qc-status/<uuid:jobid>",
             methods=["GET", "POST"])
@require_login
def rqtl2_bundle_qc_status(jobid: UUID):
    """Check the status of the QC jobs."""
    with (Redis.from_url(app.config["REDIS_URL"], decode_responses=True) as rconn,
          database_connection(app.config["SQL_URI"]) as dbconn):
        try:
            thejob = jobs.job(rconn, jobs.jobsnamespace(), jobid)
            messagelistname = thejob.get("log-messagelist")
            logmessages = (rconn.lrange(messagelistname, 0, -1)
                           if bool(messagelistname) else [])
            jobstatus = thejob["status"]
            if jobstatus == "error":
                return render_template(
                    "expression-data/rqtl2/rqtl2-qc-job-error.html",
                    job=thejob,
                    errorsgeneric=json.loads(
                        thejob.get("errors-generic", "[]")),
                    errorsgeno=json.loads(
                        thejob.get("errors-geno", "[]")),
                    errorspheno=json.loads(
                        thejob.get("errors-pheno", "[]")),
                    errorsphenose=json.loads(
                        thejob.get("errors-phenose", "[]")),
                    errorsphenocovar=json.loads(
                        thejob.get("errors-phenocovar", "[]")),
                    messages=logmessages)
            if jobstatus == "success":
                jobmeta = json.loads(thejob["job-metadata"])
                species = species_by_id(dbconn, jobmeta["speciesid"])
                return render_template(
                    "expression-data/rqtl2/rqtl2-qc-job-results.html",
                    species=species,
                    population=population_by_species_and_id(
                        dbconn, species["SpeciesId"], jobmeta["populationid"]),
                    rqtl2bundle=Path(jobmeta["rqtl2-bundle-file"]).name,
                    rqtl2bundleorig=jobmeta["original-filename"])

            def compute_percentage(thejob, filetype) -> Union[str, None]:
                if f"{filetype}-linecount" in thejob:
                    return "100"
                if f"{filetype}-filesize" in thejob:
                    percent = ((int(thejob.get(f"{filetype}-checked", 0))
                                /
                                int(thejob.get(f"{filetype}-filesize", 1)))
                               * 100)
                    return f"{percent:.2f}"
                return None

            return render_template(
                "expression-data/rqtl2/rqtl2-qc-job-status.html",
                job=thejob,
                geno_percent=compute_percentage(thejob, "geno"),
                pheno_percent=compute_percentage(thejob, "pheno"),
                phenose_percent=compute_percentage(thejob, "phenose"),
                messages=logmessages)
        except jobs.JobNotFound:
            return render_template("expression-data/rqtl2/no-such-job.html", jobid=jobid)


def redirect_on_error(flaskroute, **kwargs):
    """Utility to redirect on error"""
    return redirect(url_for(flaskroute, **kwargs, pgsrc="error"),
                    code=(307 if request.method == "POST" else 302))


def check_species(conn: mdb.Connection, formargs: dict) -> Optional[
        tuple[str, Response]]:
    """
    Check whether the 'species_id' value is provided, and whether a
    corresponding species exists in the database.

    Maybe give the function a better name..."""
    speciespage = redirect_on_error("expression-data.rqtl2.select_species")
    if "species_id" not in formargs:
        return "You MUST provide the Species identifier.", speciespage

    if not bool(species_by_id(conn, formargs["species_id"])):
        return "No species with the provided identifier exists.", speciespage

    return None


def check_population(conn: mdb.Connection,
                     formargs: dict,
                     species_id) -> Optional[tuple[str, Response]]:
    """
    Check whether the 'population_id' value is provided, and whether a
    corresponding population exists in the database.

    Maybe give the function a better name..."""
    poppage = redirect_on_error(
        "expression-data.rqtl2.select_species", species_id=species_id)
    if "population_id" not in formargs:
        return "You MUST provide the Population identifier.", poppage

    if not bool(population_by_species_and_id(
            conn, species_id, formargs["population_id"])):
        return "No population with the provided identifier exists.", poppage

    return None


def check_r_qtl2_bundle(formargs: dict,
                        species_id,
                        population_id) -> Optional[tuple[str, Response]]:
    """Check for the existence of the R/qtl2 bundle."""
    fileuploadpage = redirect_on_error("expression-data.rqtl2.upload_rqtl2_bundle",
                                       species_id=species_id,
                                       population_id=population_id)
    if not "rqtl2_bundle_file" in formargs:
        return (
            "You MUST provide a R/qtl2 zip bundle for expression-data.", fileuploadpage)

    if not Path(fullpath(formargs["rqtl2_bundle_file"])).exists():
        return "No R/qtl2 bundle with the given name exists.", fileuploadpage

    return None


def check_geno_dataset(conn: mdb.Connection,
                       formargs: dict,
                       species_id,
                       population_id) -> Optional[tuple[str, Response]]:
    """Check for the Genotype dataset."""
    genodsetpg = redirect_on_error("expression-data.rqtl2.select_dataset_info",
                                   species_id=species_id,
                                   population_id=population_id)
    if not bool(formargs.get("geno-dataset-id")):
        return (
            "You MUST provide a valid Genotype dataset identifier", genodsetpg)

    with conn.cursor(cursorclass=DictCursor) as cursor:
        cursor.execute("SELECT * FROM GenoFreeze WHERE Id=%s",
                       (formargs["geno-dataset-id"],))
        results = cursor.fetchall()
        if not bool(results):
            return ("No genotype dataset with the provided identifier exists.",
                    genodsetpg)
        if len(results) > 1:
            return (
                "Data corruption: More than one genotype dataset with the same "
                "identifier.",
                genodsetpg)

    return None

def check_tissue(
        conn: mdb.Connection,formargs: dict) -> Optional[tuple[str, Response]]:
    """Check for tissue/organ/biological material."""
    selectdsetpg = redirect_on_error("expression-data.rqtl2.select_dataset_info",
                                     species_id=formargs["species_id"],
                                     population_id=formargs["population_id"])
    if not bool(formargs.get("tissueid", "").strip()):
        return ("No tissue/organ/biological material provided.", selectdsetpg)

    with conn.cursor(cursorclass=DictCursor) as cursor:
        cursor.execute("SELECT * FROM Tissue WHERE Id=%s",
                       (formargs["tissueid"],))
        results = cursor.fetchall()
        if not bool(results):
            return ("No tissue/organ with the provided identifier exists.",
                    selectdsetpg)

        if len(results) > 1:
            return (
                "Data corruption: More than one tissue/organ with the same "
                "identifier.",
                selectdsetpg)

    return None


def check_probe_study(conn: mdb.Connection,
                      formargs: dict,
                      species_id,
                      population_id) -> Optional[tuple[str, Response]]:
    """Check for the ProbeSet study."""
    dsetinfopg = redirect_on_error("expression-data.rqtl2.select_dataset_info",
                                   species_id=species_id,
                                   population_id=population_id)
    if not bool(formargs.get("probe-study-id")):
        return "No probeset study was selected!", dsetinfopg

    if not bool(probeset_study_by_id(conn, formargs["probe-study-id"])):
        return ("No probeset study with the provided identifier exists",
                dsetinfopg)

    return None


def check_probe_dataset(conn: mdb.Connection,
                        formargs: dict,
                        species_id,
                        population_id) -> Optional[tuple[str, Response]]:
    """Check for the ProbeSet dataset."""
    dsetinfopg = redirect_on_error("expression-data.rqtl2.select_dataset_info",
                                   species_id=species_id,
                                   population_id=population_id)
    if not bool(formargs.get("probe-dataset-id")):
        return "No probeset dataset was selected!", dsetinfopg

    if not bool(probeset_dataset_by_id(conn, formargs["probe-dataset-id"])):
        return ("No probeset dataset with the provided identifier exists",
                dsetinfopg)

    return None


def with_errors(endpointthunk: Callable, *checkfns):
    """Run 'endpointthunk' with error checking."""
    formargs = {**dict(request.args), **dict(request.form)}
    errors = tuple(item for item in (_fn(formargs=formargs) for _fn in checkfns)
                   if item is not None)
    if len(errors) > 0:
        flash(errors[0][0], "alert-error error-rqtl2")
        return errors[0][1]

    return endpointthunk()


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/select-geno-dataset"),
             methods=["POST"])
@require_login
def select_geno_dataset(species_id: int, population_id: int):
    """Select from existing geno datasets."""
    with database_connection(app.config["SQL_URI"]) as conn:
        def __thunk__():
            geno_dset = geno_datasets_by_species_and_population(
                conn, species_id, population_id)
            if not bool(geno_dset):
                flash("No genotype dataset was provided!",
                      "alert-error error-rqtl2")
                return redirect(url_for("expression-data.rqtl2.select_geno_dataset",
                                        species_id=species_id,
                                        population_id=population_id,
                                        pgsrc="error"),
                                code=307)

            flash("Genotype accepted", "alert-success error-rqtl2")
            return redirect(url_for("expression-data.rqtl2.select_dataset_info",
                                    species_id=species_id,
                                    population_id=population_id,
                                    pgsrc="expression-data.rqtl2.select_geno_dataset"),
                            code=307)

        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population, conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_geno_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id))


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/select-tissue"),
             methods=["POST"])
@require_login
def select_tissue(species_id: int, population_id: int):
    """Select from existing tissues."""
    with database_connection(app.config["SQL_URI"]) as conn:
        def __thunk__():
            if not bool(request.form.get("tissueid", "").strip()):
                flash("Invalid tissue selection!",
                      "alert-error error-select-tissue error-rqtl2")

            return redirect(url_for("expression-data.rqtl2.select_dataset_info",
                                    species_id=species_id,
                                    population_id=population_id,
                                    pgsrc="expression-data.rqtl2.select_geno_dataset"),
                            code=307)

        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population,
                                   conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_geno_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id))

@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/create-tissue"),
             methods=["POST"])
@require_login
def create_tissue(species_id: int, population_id: int):
    """Add new tissue, organ or biological material to the system."""
    form = request.form
    datasetinfopage = redirect(
        url_for("expression-data.rqtl2.select_dataset_info",
                species_id=species_id,
                population_id=population_id,
                pgsrc="expression-data.rqtl2.select_geno_dataset"),
    code=307)
    with database_connection(app.config["SQL_URI"]) as conn:
        tissuename = form.get("tissuename", "").strip()
        tissueshortname = form.get("tissueshortname", "").strip()
        if not bool(tissuename):
            flash("Organ/Tissue name MUST be provided.",
                  "alert-error error-create-tissue error-rqtl2")
            return datasetinfopage

        if not bool(tissueshortname):
            flash("Organ/Tissue short name MUST be provided.",
                  "alert-error error-create-tissue error-rqtl2")
            return datasetinfopage

        try:
            tissue = create_new_tissue(conn, tissuename, tissueshortname)
            flash("Tissue created successfully!", "alert-success")
            return render_template(
                "expression-data/rqtl2/create-tissue-success.html",
                species=species_by_id(conn, species_id),
                population=population_by_species_and_id(
                    conn, species_id, population_id),
                rqtl2_bundle_file=request.form["rqtl2_bundle_file"],
                geno_dataset=geno_dataset_by_id(
                    conn,
                    int(request.form["geno-dataset-id"])),
                tissue=tissue)
        except mdb.IntegrityError as _ierr:
            flash("Tissue/Organ with that short name already exists!",
                  "alert-error error-create-tissue error-rqtl2")
            return datasetinfopage


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/select-probeset-study"),
             methods=["POST"])
@require_login
def select_probeset_study(species_id: int, population_id: int):
    """Select or create a probeset study."""
    with database_connection(app.config["SQL_URI"]) as conn:
        def __thunk__():
            summary_page = redirect(url_for("expression-data.rqtl2.select_dataset_info",
                                            species_id=species_id,
                                            population_id=population_id),
                                    code=307)
            if not bool(probeset_study_by_id(conn, int(request.form["probe-study-id"]))):
                flash("Invalid study selected!", "alert-error error-rqtl2")
                return summary_page

            return summary_page
        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population,
                                   conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_geno_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_tissue, conn=conn),
                           partial(check_probe_study,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id))


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/select-probeset-dataset"),
             methods=["POST"])
@require_login
def select_probeset_dataset(species_id: int, population_id: int):
    """Select or create a probeset dataset."""
    with database_connection(app.config["SQL_URI"]) as conn:
        def __thunk__():
            summary_page = redirect(url_for("expression-data.rqtl2.select_dataset_info",
                                            species_id=species_id,
                                            population_id=population_id),
                                    code=307)
            if not bool(probeset_study_by_id(conn, int(request.form["probe-study-id"]))):
                flash("Invalid study selected!", "alert-error error-rqtl2")
                return summary_page

            return summary_page

        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population,
                                   conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_geno_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_tissue, conn=conn),
                           partial(check_probe_study,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_probe_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id))


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/create-probeset-study"),
             methods=["POST"])
@require_login
def create_probeset_study(species_id: int, population_id: int):
    """Create a new probeset study."""
    errorclasses = "alert-error error-rqtl2 error-rqtl2-create-probeset-study"
    with database_connection(app.config["SQL_URI"]) as conn:
        def __thunk__():
            form = request.form
            dataset_info_page = redirect(
                url_for("expression-data.rqtl2.select_dataset_info",
                        species_id=species_id,
                        population_id=population_id),
                code=307)

            if not (bool(form.get("platformid")) and
                    bool(platform_by_id(conn, int(form["platformid"])))):
                flash("Invalid platform selected.", errorclasses)
                return dataset_info_page

            if not (bool(form.get("tissueid")) and
                    bool(tissue_by_id(conn, int(form["tissueid"])))):
                flash("Invalid tissue selected.", errorclasses)
                return dataset_info_page

            studyname = form["studyname"]
            try:
                study = probeset_create_study(
                    conn, population_id, int(form["platformid"]), int(form["tissueid"]),
                    studyname, form.get("studyfullname") or "",
                    form.get("studyshortname") or "")
            except mdb.IntegrityError as _ierr:
                flash(f"ProbeSet study with name '{escape(studyname)}' already "
                      "exists.",
                      errorclasses)
                return dataset_info_page
            return render_template(
                "expression-data/rqtl2/create-probe-study-success.html",
                species=species_by_id(conn, species_id),
                population=population_by_species_and_id(
                    conn, species_id, population_id),
                rqtl2_bundle_file=request.form["rqtl2_bundle_file"],
                geno_dataset=geno_dataset_by_id(
                    conn,
                    int(request.form["geno-dataset-id"])),
                study=study)

        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population,
                                   conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_geno_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_tissue, conn=conn))


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/create-probeset-dataset"),
             methods=["POST"])
@require_login
def create_probeset_dataset(species_id: int, population_id: int):#pylint: disable=[too-many-return-statements]
    """Create a new probeset dataset."""
    errorclasses = "alert-error error-rqtl2 error-rqtl2-create-probeset-dataset"
    with database_connection(app.config["SQL_URI"]) as conn:
        def __thunk__():#pylint: disable=[too-many-return-statements]
            form = request.form
            summary_page = redirect(url_for("expression-data.rqtl2.select_dataset_info",
                                            species_id=species_id,
                                            population_id=population_id),
                                    code=307)
            if not bool(form.get("averageid")):
                flash("Averaging method not selected!", errorclasses)
                return summary_page
            if not bool(form.get("datasetname")):
                flash("Dataset name not provided!", errorclasses)
                return summary_page
            if not bool(form.get("datasetfullname")):
                flash("Dataset full name not provided!", errorclasses)
                return summary_page

            tissue = tissue_by_id(conn, form.get("tissueid", "").strip())

            study = probeset_study_by_id(conn, int(form["probe-study-id"]))
            if not bool(study):
                flash("Invalid ProbeSet study provided!", errorclasses)
                return summary_page

            avgmethod = averaging_method_by_id(conn, int(form["averageid"]))
            if not bool(avgmethod):
                flash("Invalid averaging method provided!", errorclasses)
                return summary_page

            try:
                dset = probeset_create_dataset(conn,
                                               int(form["probe-study-id"]),
                                               int(form["averageid"]),
                                               form["datasetname"],
                                               form["datasetfullname"],
                                               form["datasetshortname"],
                                               form["datasetpublic"] == "on",
                                               form.get(
                                                   "datasetdatascale", "log2"))
            except mdb.IntegrityError as _ierr:
                app.logger.debug("Possible integrity error: %s", traceback.format_exc())
                flash(("IntegrityError: The data you provided has some errors: "
                       f"{_ierr.args}"),
                      errorclasses)
                return summary_page
            except Exception as _exc:# pylint: disable=[broad-except]
                app.logger.debug("Error creating ProbeSet dataset: %s",
                                 traceback.format_exc())
                flash(("There was a problem creating your dataset. Please try "
                       "again."),
                      errorclasses)
                return summary_page
            return render_template(
                "expression-data/rqtl2/create-probe-dataset-success.html",
                species=species_by_id(conn, species_id),
                population=population_by_species_and_id(
                    conn, species_id, population_id),
                rqtl2_bundle_file=request.form["rqtl2_bundle_file"],
                geno_dataset=geno_dataset_by_id(
                    conn,
                    int(request.form["geno-dataset-id"])),
                tissue=tissue,
                study=study,
                avgmethod=avgmethod,
                dataset=dset)

        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population,
                                   conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_geno_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_tissue, conn=conn),
                           partial(check_probe_study,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id))


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/dataset-info"),
             methods=["POST"])
@require_login
def select_dataset_info(species_id: int, population_id: int):
    """
    If `geno` files exist in the R/qtl2 bundle, prompt user to provide the
    dataset the genotypes belong to.
    """
    form = request.form
    with database_connection(app.config["SQL_URI"]) as conn:
        def __thunk__():
            species = species_by_id(conn, species_id)
            population = population_by_species_and_id(
                conn, species_id, population_id)
            thefile = fullpath(form["rqtl2_bundle_file"])
            with ZipFile(str(thefile), "r") as zfile:
                cdata = r_qtl2.control_data(zfile)

                geno_dataset = geno_dataset_by_id(
                    conn,form.get("geno-dataset-id", "").strip())
                if "geno" in cdata and not bool(form.get("geno-dataset-id")):
                    return render_template(
                        "expression-data/rqtl2/select-geno-dataset.html",
                        species=species,
                        population=population,
                        rqtl2_bundle_file=thefile.name,
                        datasets=geno_datasets_by_species_and_population(
                            conn, species_id, population_id))

                tissue = tissue_by_id(conn, form.get("tissueid", "").strip())
                if "pheno" in cdata and not bool(tissue):
                    return render_template(
                        "expression-data/rqtl2/select-tissue.html",
                        species=species,
                        population=population,
                        rqtl2_bundle_file=thefile.name,
                        geno_dataset=geno_dataset,
                        studies=probeset_studies_by_species_and_population(
                            conn, species_id, population_id),
                        platforms=platforms_by_species(conn, species_id),
                        tissues=all_tissues(conn))

                probeset_study = probeset_study_by_id(
                    conn, form.get("probe-study-id", "").strip())
                if "pheno" in cdata and not bool(probeset_study):
                    return render_template(
                        "expression-data/rqtl2/select-probeset-study-id.html",
                        species=species,
                        population=population,
                        rqtl2_bundle_file=thefile.name,
                        geno_dataset=geno_dataset,
                        studies=probeset_studies_by_species_and_population(
                                conn, species_id, population_id),
                        platforms=platforms_by_species(conn, species_id),
                        tissue=tissue)
                probeset_study = probeset_study_by_id(
                    conn, int(form["probe-study-id"]))

                probeset_dataset = probeset_dataset_by_id(
                    conn, form.get("probe-dataset-id", "").strip())
                if "pheno" in cdata and not bool(probeset_dataset):
                    return render_template(
                        "expression-data/rqtl2/select-probeset-dataset.html",
                        species=species,
                        population=population,
                        rqtl2_bundle_file=thefile.name,
                        geno_dataset=geno_dataset,
                        probe_study=probeset_study,
                        tissue=tissue,
                        datasets=probeset_datasets_by_study(
                            conn, int(form["probe-study-id"])),
                        avgmethods=averaging_methods(conn))

            return render_template("expression-data/rqtl2/summary-info.html",
                                   species=species,
                                   population=population,
                                   rqtl2_bundle_file=thefile.name,
                                   geno_dataset=geno_dataset,
                                   tissue=tissue,
                                   probe_study=probeset_study,
                                   probe_dataset=probeset_dataset)

        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population,
                                   conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id))


@rqtl2.route(("/upload/species/<int:species_id>/population/<int:population_id>"
              "/rqtl2-bundle/confirm-bundle-details"),
             methods=["POST"])
@require_login
def confirm_bundle_details(species_id: int, population_id: int):
    """Confirm the details and trigger R/qtl2 bundle processing..."""
    redisuri = app.config["REDIS_URL"]
    with (database_connection(app.config["SQL_URI"]) as conn,
          Redis.from_url(redisuri, decode_responses=True) as rconn):
        def __thunk__():
            redis_ttl_seconds = app.config["JOBS_TTL_SECONDS"]
            jobid = str(uuid4())
            _job = jobs.launch_job(
                jobs.initialise_job(
                    rconn,
                    jobs.jobsnamespace(),
                    jobid,
                    [
                        sys.executable, "-m", "scripts.process_rqtl2_bundle",
                        app.config["SQL_URI"], app.config["REDIS_URL"],
                        jobs.jobsnamespace(), jobid, "--redisexpiry",
                        str(redis_ttl_seconds)],
                    "R/qtl2 Bundle Upload",
                    redis_ttl_seconds,
                    {
                        "bundle-metadata": json.dumps({
                            "speciesid": species_id,
                            "populationid": population_id,
                            "rqtl2-bundle-file": str(fullpath(
                                request.form["rqtl2_bundle_file"])),
                            "geno-dataset-id": request.form.get(
                                "geno-dataset-id", ""),
                            "probe-study-id": request.form.get(
                                "probe-study-id", ""),
                            "probe-dataset-id": request.form.get(
                                "probe-dataset-id", ""),
                            **({
                                "platformid": probeset_study_by_id(
                                    conn,
                                    int(request.form["probe-study-id"]))["ChipId"]
                            } if bool(request.form.get("probe-study-id")) else {})
                        })
                    }),
                redisuri,
                f"{app.config['UPLOAD_FOLDER']}/job_errors")

            return redirect(url_for("expression-data.rqtl2.rqtl2_processing_status",
                                    jobid=jobid))

        return with_errors(__thunk__,
                           partial(check_species, conn=conn),
                           partial(check_population,
                                   conn=conn,
                                   species_id=species_id),
                           partial(check_r_qtl2_bundle,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_geno_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_probe_study,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id),
                           partial(check_probe_dataset,
                                   conn=conn,
                                   species_id=species_id,
                                   population_id=population_id))


@rqtl2.route("/status/<uuid:jobid>")
def rqtl2_processing_status(jobid: UUID):
    """Retrieve the status of the job processing the uploaded R/qtl2 bundle."""
    with Redis.from_url(app.config["REDIS_URL"], decode_responses=True) as rconn:
        try:
            thejob = jobs.job(rconn, jobs.jobsnamespace(), jobid)

            messagelistname = thejob.get("log-messagelist")
            logmessages = (rconn.lrange(messagelistname, 0, -1)
                           if bool(messagelistname) else [])

            if thejob["status"] == "error":
                return render_template(
                    "expression-data/rqtl2/rqtl2-job-error.html",
                    job=thejob,
                    messages=logmessages)
            if thejob["status"] == "success":
                return render_template(
                    "expression-data/rqtl2/rqtl2-job-results.html",
                    job=thejob,
                    messages=logmessages)

            return render_template(
                "expression-data/rqtl2/rqtl2-job-status.html",
                job=thejob,
                messages=logmessages)
        except jobs.JobNotFound as _exc:
            return render_template("expression-data/rqtl2/no-such-job.html",
                                   jobid=jobid)