aboutsummaryrefslogtreecommitdiffstats
path: root/classes/fossology-rest-phased.bbclass
blob: dace1ed401026d89875636a5fe1b02d0981527af (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
# This class integrates real-time license scanning, generation of SPDX standard
# output and verifiying license info during the building process.
# It is a combination of efforts from the OE-Core, SPDX and DoSOCSv2 projects.
#
# For more information on DoSOCSv2:
#   https://github.com/DoSOCSv2
#
# For more information on SPDX:
#   http://www.spdx.org
#
# Note:
# 1) Make sure fossdriver has beed installed in your host
# 2) By default,spdx files will be output to the path which is defined as[SPDX_DEPLOY_DIR] 
#    in ./meta/conf/spdx-dosocs.conf.
inherit spdx-common
FOSSOLOGY_SERVER ?= "http://127.0.0.1:8081/repo"
FOSSOLOGY_REUPLOAD ??= "0"

#upload OSS into No.1 folder of fossology
FOSSOLOGY_FOLDER_ID ??= "1"
FOSSOLOGY_FOLDER_NAME ??= "${DISTRO_CODENAME}-${DISTRO_VERSION}"

FOSSOLOGY_EXCLUDE_PACKAGES ??= "glibc-locale libtool-cross libgcc-initial shadow-sysroot"
FOSSOLOGY_EXCLUDE_NATIVE ??= "1"
FOSSOLOGY_EXCLUDE_SDK ??= "1"
# translate to common variables
SPDX_EXCLUDE_PACKAGES := "${FOSSOLOGY_EXCLUDE_PACKAGES}"
SPDX_EXCLUDE_NATIVE := "${FOSSOLOGY_EXCLUDE_NATIVE}"
SPDX_EXCLUDE_SDK := "${FOSSOLOGY_EXCLUDE_SDK}"


HOSTTOOLS_NONFATAL += "curl quilt unzip"

CREATOR_TOOL = "fossology-rest-phased.bbclass in meta-spdxscanner"

# If ${S} isn't actually the top-level source directory, set SPDX_S to point at
# the real top-level directory.
SPDX_S ?= "${S}"

def populate_info(d, info):
    info['workdir'] = (d.getVar('WORKDIR', True) or "")
    info['pn'] = (d.getVar( 'PN', True ) or "")
    info['pv'] = (d.getVar( 'PV', True ) or "")
    info['package_download_location'] = (d.getVar( 'SRC_URI', True ) or "")
    if info['package_download_location'] != "":
        info['package_download_location'] = info['package_download_location'].split()[0]
    info['spdx_version'] = (d.getVar('SPDX_VERSION', True) or '')
    info['data_license'] = (d.getVar('DATA_LICENSE', True) or '')
    info['creator'] = {}
    info['creator']['Tool'] = (d.getVar('CREATOR_TOOL', True) or '')
    info['license_list_version'] = (d.getVar('LICENSELISTVERSION', True) or '')
    info['package_homepage'] = (d.getVar('HOMEPAGE', True) or "")
    info['package_summary'] = (d.getVar('SUMMARY', True) or "")
    info['package_summary'] = info['package_summary'].replace("\n","")
    info['package_summary'] = info['package_summary'].replace("'"," ")
    info['package_contains'] = (d.getVar('CONTAINED', True) or "")
    info['package_static_link'] = (d.getVar('STATIC_LINK', True) or "")
    info['modified'] = "false"
    info['token'] = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    info['manifest_dir'] = (d.getVar('SPDX_DEPLOY_DIR', True) or "")
    info['srcuri'] = d.getVar("SRC_URI", False).split()
    length = len("file://")
    for item in info['srcuri']:
        if item.startswith("file://"):
            item = item[length:]
            if item.endswith(".patch") or item.endswith(".diff"):
                info['modified'] = "true"
    info['spdx_outdir'] = d.getVar('SPDX_OUTDIR')
    info['spdx_workdir'] = d.getVar('SPDX_WORKDIR')
    info['spdx_temp_dir'] = os.path.join(info['spdx_workdir'], "temp")
    info['temp_dir'] = os.path.join(d.getVar('WORKDIR'), "temp")
    info['outfile'] = os.path.join(info['manifest_dir'], info['pn'] + "-" + info['pv'] + ".spdx" )
    info['sstatefile'] = os.path.join(info['spdx_outdir'], info['pn'] + "-" + info['pv'] + ".spdx" )

def prepare_folders(info):
    if not os.path.exists( info['manifest_dir'] ):
        bb.utils.mkdirhier( info['manifest_dir'] )
    if not os.path.exists(info['spdx_outdir']):
        bb.utils.mkdirhier(info['spdx_outdir'])


def use_cached_files(info):
    # if spdx sstate or report already exist
    if os.path.exists(info['outfile']):
        bb.warn(info['pn'] + "The spdx report file already exists, do nothing.")
        return
    if os.path.exists( info['sstatefile'] ):
        bb.warn(info['pn'] + "The spdx sstate file already exists, do nothing.")
        create_manifest(info, info['sstatefile'])
        return

def fossologyupload(d, bb, info):
    import os, sys, shutil

    pn = d.getVar('PN', True)
    # exclude packages not necessary (-native, nativesdk-)  or on blacklist
    if excluded_package(d, pn):
        bb.note("spdx: fossologyanalyze: excluding "+ pn)
        return

    # retrieve the folder id
    info['folder_id'] = get_folder_id(d)

    # prepare folders
    prepare_folders(info)

    # get source
    spdx_get_src(d)

    bb.note('spdx: Archiving the patched source...')
    if os.path.isdir(info['spdx_temp_dir']):
        for f_dir, f in list_files(info['spdx_temp_dir']):
            temp_file = os.path.join(info['spdx_temp_dir'],f_dir,f)
            shutil.copy(temp_file, info['temp_dir'])
        shutil.rmtree(info['spdx_temp_dir'])
    d.setVar('WORKDIR', info['spdx_workdir'])
    info['sourcedir'] = info['spdx_workdir']
    git_path = "%s/git/.git" % info['sourcedir']
    if os.path.exists(git_path):
        remove_dir_tree(git_path)

    tar_name = spdx_create_tarball(d, d.getVar('WORKDIR'), 'patched', info['spdx_outdir'])

    ## get everything from cache.  use it to decide if
    ## something needs to be rerun
    cur_ver_code = get_ver_code(info['spdx_workdir']).split()[0] 
    # upload archive
    if invoke_rest_api_upload(d, tar_name, info['outfile'], info['folder_id']) == False:
        bb.error(info['pn'] + ": Upload failed, please check fossology server.")
    return


def fossologyanalyse(d, bb, info):
    import os, sys, shutil

    pn = d.getVar('PN', True)
    # exclude packages not necessary (-native, nativesdk-)  or on blacklist
    if excluded_package(d, pn):
        bb.note("spdx: fossologyanalyze: excluding "+ pn)
        return


    # retrieve the folder id
    info['folder_id'] = get_folder_id(d)

    # prepare folders
    prepare_folders(info)

    # TODO: put into common func or info[]
    filename = '%s-%s.tar.gz' % (d.getVar('PF'), 'patched')
    tar_name = os.path.join(info['spdx_outdir'], filename)

    # invoce the analysis
    if invoke_rest_api_analysis(d, tar_name, info['sstatefile'], info['folder_id']) == False:
        bb.error("spdx: " + info['pn'] + ": Analysis trigger failed, please check fossology server.")
    return


def fossologytrigger(d, bb, info):
    import os, sys, shutil

    pn = d.getVar('PN', True)
    # exclude packages not necessary (-native, nativesdk-)  or on blacklist
    if excluded_package(d, pn):
        bb.note("spdx: fossologyanalyze: excluding "+ pn)
        return

    # setup variables
    info = {}
    populate_info(d, info)

    # retrieve the folder id
    info['folder_id'] = get_folder_id(d)

    # TODO: put into common func or info[]
    filename = '%s-%s.tar.gz' % (d.getVar('PF'), 'patched')
    tar_name = os.path.join(info['spdx_outdir'], filename)

    report_id = invoke_rest_api_triggerreport(d, tar_name, info['outfile'], info['folder_id'])
    if report_id == False:
        bb.error("spdx:" + info['pn'] + ": trigger_spdx failed.")
        return False
    else:
        info['report_id'] = report_id
        d.setVar('spdx_report_id', info['report_id'])
        return True


def fossologyreport(d, bb, info):
    import os, sys, shutil

    pn = d.getVar('PN', True)
    # exclude packages not necessary (-native, nativesdk-)  or on blacklist
    if excluded_package(d, pn):
        bb.note("spdx: fossologyanalyze: excluding "+ pn)
        return

    if not 'folder_id' in info:
        # retrieve the folder id
        info['folder_id'] = get_folder_id(d)
    if not 'report_id' in info:
        x = d.getVar("spdx_report_id")
        if not x:
            bb.error("spdx: no report_id")
            return False
        info['report_id'] = x

    # TODO: put into common func or info[]
    filename = '%s-%s.tar.gz' % (d.getVar('PF'), 'patched')
    tar_name = os.path.join(info['spdx_outdir'], filename)

    bb.warn("outfile: " + str(info['outfile']))

    if invoke_rest_api_getresult(d, tar_name, info['outfile'], info['folder_id'], info['report_id']) == False:
        bb.error("spdx: " + info['pn'] + ": get_spdx failed.")
    return


def fossologywaitextracted(d, bb, info):
    import time
    import subprocess
    import os
    delaytime = 120
    i = 0

    pn = d.getVar('PN', True)
    # exclude packages not necessary (-native, nativesdk-)  or on blacklist
    if excluded_package(d, pn):
        bb.note("spdx: fossologyanalyze: excluding "+ pn)
        return

    # setup variables
    info = {}
    populate_info(d, info)

    # retrieve the folder id
    info['folder_id'] = get_folder_id(d)

    # TODO: put into common func or info[]
    filename = '%s-%s.tar.gz' % (d.getVar('PF'), 'patched')
    tar_name = os.path.join(info['spdx_outdir'], filename)

    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of FOSSOLOGY_TOKEN comes from fossology server.")

    upload_id = has_upload(d, tar_name, info['folder_id'], True)
    bb.warn("spdx: upload_id :" + str(upload_id))
    if upload_id:
        info['upload_id'] = upload_id

        while i < 360:
            #api/v1/jobs?upload=id
            rest_api_cmd = "curl -k -s -S -X GET " + server_url + "/api/v1/jobs?upload=" \
                           + str(upload_id) \
                           + " -H \"Authorization: Bearer " + token + "\"" \
                           + " --noproxy 127.0.0.1"
            bb.note("Invoke rest_api_cmd = " + rest_api_cmd)
            try:
                jobstatus = subprocess.check_output(rest_api_cmd, stderr=subprocess.STDOUT, shell=True)
            except subprocess.CalledProcessError as e:
                bb.error(d.getVar('PN', True) + ": Could not get job status: \n%s" % e.output.decode("utf-8"))
                return
            jobstatus = str(jobstatus, encoding = "utf-8")
            jobstatus = eval(jobstatus)
            bb.note(str(jobstatus))
            if len(jobstatus) == 0:
                bb.warn("The jobstatus is 0." + str(jobstatus))
                return False
            ret=0
            for i in range(0, len(jobstatus)):
                bb.warn(str(jobstatus[i]))
                # wait for any job to be complete before proceeding
                if jobstatus[i]["status"] == "Completed":
                    bb.note("Job part complete.")
                else:
                    ret += 1
            if ret == 0:
                bb.warn("Job complete.")
                return
            i += 1
            time.sleep(delaytime)
    else:
        bb.error("No upload_id")
        return

addtask spdxupload
do_spdxupload[depends] = "${SPDXEPENDENCY}"
do_spdxupload[deptask] += "do_fetch do_unpack do_patch"
python do_spdxupload() {
    # setup variables
    info = {}
    populate_info(d, info)

    fossologyupload(d, bb, info)
}


addtask spdxwaitextracted
python do_spdxwaitextracted() {
    # setup variables
    info = {}
    populate_info(d, info)
    fossologywaitextracted(d, bb, info)
}

addtask spdxanalyse
python do_spdxanalyse() {
    # setup variables
    info = {}
    populate_info(d, info)
    #fossologywaitextracted(d, bb, info)
    fossologyanalyse(d, bb, info)
}

addtask spdxreport
python do_spdxreport(){
    import time
    # setup variables
    info = {}
    populate_info(d, info)

    if fossologytrigger(d, bb, info):
        fossologyreport(d, bb, info)
}

python do_spdx() {

    pn = d.getVar('PN')
    info = {}
    populate_info(d, info)

    fossologyupload(d, bb, info)

    fossologywaitextracted(d, bb, info, True)

    fossologyanalyse(d, bb, info)

    if fossologytrigger(d, bb, info):
        fossologyreport(d, bb, info)

}


def get_folder_id_by_name(d, folder_name):
    import os
    import subprocess
    import json

    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of FOSSOLOGY_TOKEN comes from fossology server.")

    rest_api_cmd = "curl -k -s -S -X GET " + server_url + "/api/v1/folders" \
                   + " -H \"Authorization: Bearer " + token + "\"" \
                   + " --noproxy 127.0.0.1"
    bb.note("Invoke rest_api_cmd = " + rest_api_cmd )
    try:
        all_folder = subprocess.check_output(rest_api_cmd, stderr=subprocess.STDOUT, shell=True)
    except subprocess.CalledProcessError as e:
        bb.error(d.getVar('PN', True) + ": Get folder list failed: \n%s" % e.output.decode("utf-8"))
        return False
    all_folder = str(all_folder, encoding = "utf-8")
    all_folder = json.loads(all_folder)
    if len(all_folder) == 0:
        bb.note("Can not get folder list.")
        return False
    bb.note("all_folder[0][name] = " + all_folder[0]["name"])
    for i in range(0, len(all_folder)):
        if all_folder[i]["name"] == folder_name:
                bb.note("Found " + folder_name + "on fossology server.")
                return all_folder[i]["id"]
    return False

def create_folder(d, folder_name):
    import os
    import subprocess

    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of FOSSOLOGY_TOKEN comes from fossology server.")

    rest_api_cmd = "curl -k -s -S -X POST " + server_url + "/api/v1/folders" \
                   + " -H \'parentFolder: 1\'" \
                   + " -H \'folderName: " + folder_name + "\'" \
                   + " -H \"Authorization: Bearer " + token + "\"" \
                   + " --noproxy 127.0.0.1"
    bb.note("Invoke rest_api_cmd = " + rest_api_cmd)
    try:
        add_folder = subprocess.check_output(rest_api_cmd, stderr=subprocess.STDOUT, shell=True)
    except subprocess.CalledProcessError as e:
        bb.error(d.getVar('PN', True) + ": Added folder failed: \n%s" % e.output.decode("utf-8"))
        return False

    add_folder = str(add_folder, encoding = "utf-8")
    add_folder = eval(add_folder)
    if str(add_folder["code"]) == "201":
        bb.note("add_folder = " + folder_name)
        return add_folder["message"]
    elif str(add_folder["code"]) == "200":
        bb.note("Folder : " + folder_name + "has been created.")
        return get_folder_id_by_name(d, folder_name)
    else:
        bb.error(d.getVar('PN', True) + ": Added folder failed, please check your fossology server.")
        return False

def get_folder_id(d):
    if d.getVar('FOSSOLOGY_FOLDER_NAME', False):
        folder_name = d.getVar('FOSSOLOGY_FOLDER_NAME')
        folder_id = create_folder(d, folder_name)
    else:
        folder_id = (d.getVar('FOSSOLOGY_FOLDER_ID', True) or "1")
    bb.note("Folder Id =  " + str(folder_id))
    return str(folder_id)

def has_upload(d, tar_file, folder_id, skipupload=False):
    import os
    import subprocess

    (work_dir, file_name) = os.path.split(tar_file) 

    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of TOKEN comes from fossology server.")

    rest_api_cmd = "curl -k -s -S -X GET " + server_url + "/api/v1/uploads" \
                   + " -H \"Authorization: Bearer " + token + "\"" \
                   + " --noproxy 127.0.0.1"
    bb.note("Invoke rest_api_cmd = " + rest_api_cmd )
    try:
        upload_output = subprocess.check_output(rest_api_cmd, stderr=subprocess.STDOUT, shell=True)
    except subprocess.CalledProcessError as e:
        bb.error("curl failed: \n%s" % e.output.decode("utf-8"))
        return False

    upload_output = str(upload_output, encoding = "utf-8")
    upload_output = eval(upload_output)
    if len(upload_output) == 0:
        bb.warn("The upload of fossology is 0.")
        return False
    for i in range(0, len(upload_output)):
        if upload_output[i]["uploadname"] == file_name and str(upload_output[i]["folderid"]) == str(folder_id):
            if d.getVar('FOSSOLOGY_REUPLOAD') == "1" and not skipupload:
                bb.warn("#### Reupload triggered ####")
                return False
            #bb.warn("########### upload_output[i][uploadname] = " + upload_output[i]["uploadname"])
            #bb.warn("########### Found " + file_name + " on fossology server \"Software Repository\" folder. Will skip upload.")
            return upload_output[i]["id"]
    return False

def upload(d, tar_file, folder):
    import os
    import subprocess
    import time
    delaytime = 50
    i = 0
    j = 0
 
    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of TOKEN comes from fossology server.")
    
    rest_api_cmd = "curl -k -s -S -X POST " + server_url + "/api/v1/uploads" \ 
                    + " -H \"folderId: " + folder + "\"" \
                    + " -H \"Authorization: Bearer " + token + "\"" \
                    + " -H \'uploadDescription: created by REST\'" \
                    + " -H \'public: public\'"  \
                    + " -H \'Content-Type: multipart/form-data\'"  \
                    + " -F \'fileInput=@\"" + tar_file + "\";type=application/octet-stream\'" \
                    + " --noproxy 127.0.0.1"
    bb.note("Upload : Invoke rest_api_cmd = " + rest_api_cmd )
    while i < 10:
        try:
            upload = subprocess.check_output(rest_api_cmd, stderr=subprocess.STDOUT, shell=True)
        except subprocess.CalledProcessError as e:
            bb.error(d.getVar('PN', True) + ": Upload failed: \n%s" % e.output.decode("utf-8"))
            return False
        upload = str(upload, encoding = "utf-8")
        if not upload:
            bb.error("No upload response")
            time.sleep(delaytime)
            continue
        if "ERROR" in str(upload):
            bb.warn("ERROR in upload")
            time.sleep(delaytime)
            continue
        if "Error" in str(upload):
            bb.warn("Error in upload")
            time.sleep(delaytime)
            continue
        if "error" in str(upload):
            bb.warn("error in upload")
            time.sleep(delaytime)
            continue
        if "504 Gateway Time-out" in str(upload):
            bb.warn("504 Gateway Timeout in upload")
            time.sleep(delaytime)
            continue
        upload = eval(upload)
        if str(upload["code"]) == "201":
            return upload["message"]
        i += 1
        time.sleep(delaytime)
    bb.error("spdx: " + d.getVar('PN', True) + ": Upload failed, please check your fossology server connection.")
    bb.error(str(upload))
    return False

def analysis(d, folder_id, upload_id):
    import os
    import subprocess
    delaytime = 50
    i = 0

    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of FOSSOLOGY_TOKEN comes from fossology server.")

    rest_api_cmd = "curl -k -s -S -X POST " + server_url + "/api/v1/jobs" \
                    + " -H \"folderId: " + str(folder_id) + "\"" \
                    + " -H \"uploadId: " + str(upload_id) + "\"" \
                    + " -H \"Authorization: Bearer " + token + "\"" \
                    + " -H \'Content-Type: application/json\'" \
                    + " --data \'{\"analysis\": {\"bucket\": true,\"copyright_email_author\": true,\"ecc\": true, \"keyword\": true,\"mime\": true,\"monk\": true,\"nomos\": true,\"ojo\": true,\"package\": true},\"decider\": {\"nomos_monk\": true,\"new_scanner\": true}}\'" \
                    + " --noproxy 127.0.0.1"
    bb.warn("Analysis : Invoke rest_api_cmd = " + rest_api_cmd )
    try:
        analysis = subprocess.check_output(rest_api_cmd, stderr=subprocess.STDOUT, shell=True)
    except subprocess.CalledProcessError as e:
        bb.error("Analysis failed: \n%s" % e.output.decode("utf-8"))
        return False
    analysis = str(analysis, encoding = "utf-8")
    analysis = eval(analysis)
    if str(analysis["code"]) == "201":
        return analysis["message"]
    elif str(analysis["code"]) == "404":
        bb.error("spdx: " + d.getVar('PN', True) + ": cannot trigger analysis as extraction failed.")
        bb.error(str(analysis))
        return False
    else:
        bb.error("spdx: analysis trigger failed: " + str(analysis))
        return False

def trigger(d, folder_id, upload_id):
    import os
    import subprocess
    delaytime = 50
    i = 0

    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of FOSSOLOGY_TOKEN comes from fossology server.")

    rest_api_cmd = "curl -k -s -S -X GET " + server_url + "/api/v1/report" \
                    + " -H \"Authorization: Bearer " + token + "\"" \
                    + " -H \"uploadId: " + str(upload_id) + "\"" \
                    + " -H \'reportFormat: spdx2tv\'" \
                    + " --noproxy 127.0.0.1"
    bb.note("trigger : Invoke rest_api_cmd = " + rest_api_cmd )
    while i < 10:
        time.sleep(10)
        try:
            trigger = subprocess.check_output(rest_api_cmd, stderr=subprocess.STDOUT, shell=True)
        except subprocess.CalledProcessError as e:
            bb.error(d.getVar('PN', True) + ": Trigger failed: \n%s" % e.output.decode("utf-8"))
            return False
        trigger = str(trigger, encoding = "utf-8")
        trigger = eval(trigger)
        if str(trigger["code"]) == "201":
            return trigger["message"].split("/")[-1]
        i += 1
        time.sleep(delaytime * 2)
        bb.note("spdx: " + d.getVar('PN', True) + ": Trigger failed, will try again.")
    bb.note("spdx: " + d.getVar('PN', True) + ": Trigger failed, please check your fossology server.")
    return False

def get_spdx(d, report_id, spdx_file):
    import os
    import subprocess
    import time
    delaytime = 10
    complete = False
    i = 0

    # Wait 20 seconds for the report to be generated on the server
    time.sleep(20)

    server_url = (d.getVar('FOSSOLOGY_SERVER', True) or "")
    if server_url == "":
        bb.note("Please set fossology server URL by setting FOSSOLOGY_SERVER!\n")
        raise OSError(errno.ENOENT, "No setting of  FOSSOLOGY_SERVER")

    token = (d.getVar('FOSSOLOGY_TOKEN', True) or "")
    if token == "":
        bb.note("Please set token of fossology server by setting FOSSOLOGY_TOKEN!\n")
        raise OSError(errno.ENOENT, "No setting of FOSSOLOGY_TOKEN comes from fossology server.")
    rest_api_cmd = "curl -k -s -S -X GET " + server_url + "/api/v1/report/" + report_id \
                    + " -H \'accept: text/plain\'" \
                    + " -H \"Authorization: Bearer " + token + "\"" \
                    + " --noproxy 127.0.0.1"
    bb.note("get_spdx : Invoke rest_api_cmd = " + rest_api_cmd )
    while i < 24:
        file = open(spdx_file,'wt')
        try:
            p = subprocess.Popen(rest_api_cmd, shell=True, universal_newlines=True, stdout=file).wait()
        except subprocess.CalledProcessError as e:
            bb.error("Get spdx failed: \n%s. Please check fossology server." % e.output.decode("utf-8"))
            file.close()
            os.remove(spdx_file)
            return False
        file.flush()
        file.close()
        time.sleep(2)
        file = open(spdx_file,'r+')
        first_line = file.readline()
        bb.note("SPDX_FILE first line: " + str(first_line))
        if "SPDXVersion" in first_line:
            complete = True
        file.close()

        if complete == True:
            return True
        else:
            bb.note("spdx: " + d.getVar('PN', True) + ": Get the first line is " + first_line + ". Will try again.")
        i += 1
        time.sleep(delaytime)
        delaytime = delaytime + 10
    file.close()
    bb.error("spdx: " + d.getVar('PN', True) + ": SPDX report could not be downloaded.")

def invoke_rest_api_upload(d, tar_file, spdx_file, folder_id):
    import os
    import time
    i = 0
    bb.note("invoke fossology REST API : tar_file = %s " % tar_file)
    upload_id = has_upload(d, tar_file, folder_id, False)
    if upload_id == False:
        bb.warn("This OSS has not been scanned. So upload it to fossology server.")
        upload_id = upload(d, tar_file, folder_id)
        if upload_id == False:
            return False
    return True

def invoke_rest_api_analysis(d, tar_file, spdx_file, folder_id):
    upload_id = has_upload(d, tar_file, folder_id, True)
    if upload_id == False:
        if d.getVar('FOSSOLOGY_REUPLOAD') == "1":
            bb.note("Reupload.")
            upload_id = upload(d, tar_file, folder_id)
            if upload_id == False:
                return False
        else:
            bb.note("This OSS has not been uploaded. Skip it.")
            return False
    if analysis(d, folder_id, upload_id) == False:
        bb.note("Analysis failed.")
        return False
    bb.note("Analysis success.")
    return True

def invoke_rest_api_triggerreport(d, tar_file, spdx_file, folder_id):
    import time
    i = 0

    upload_id = has_upload(d, tar_file, folder_id, True)
    if upload_id == False:
        bb.error("Could not find the file on the fossology server!")
        return False

    while i < 3:
        i += 1
        report_id = trigger(d, folder_id, upload_id)
        bb.note("Report_id: " + str(report_id))
        if report_id:
            return report_id
        time.sleep(30)

    bb.error("Could not trigger the report generation for " + d.getVar('PN', True))
    return False

def invoke_rest_api_getresult(d, tar_file, spdx_file, folder_id, report_id):
    i = 0

    upload_id = has_upload(d, tar_file, folder_id, True)
    if upload_id == False:
        bb.error("No upload of this software found on the fossology server!")
        return False

    while i < 3:
        i += 1
        spdx2tv = get_spdx(d, report_id, spdx_file)
        if spdx2tv == False:
            bb.note("spdx : " + d.getVar('PN', True) + ": get_spdx failed. Will try again!")
        else:
            return True

    bb.error("spdx: get_spdx of " + d.getVar('PN', True) + "failed. Please confirm!")
    return False