summaryrefslogtreecommitdiff
path: root/meta-phosphor/classes/license_static.bbclass
blob: dd7301758608695f336afa5016d31d8be235d021 (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
####
# Copyright 2021 Intel Corporation
#
# Add a class to support serving license info through bmcweb.
#
# bmcweb serves static content from the /usr/share/www folder, so this class
# copies the license info from /usr/share/common-licenses to
# /usr/share/www/common-licenses so it will be statically served by bmcweb.
#
# Requires 'COPY_LIC_DIRS' to be enabled to create /usr/share/common-licenses.
#
# Class can be inherited in a project bbclass to copy the license info.
#
# Example:
# inherit license_static
####

STATIC_LICENSE_DIR = "${IMAGE_ROOTFS}/usr/share/www/common-licenses"


def add_index_html_header(f):
    f.write("<!DOCTYPE html>")
    f.write("<html>")
    f.write("<body>")
    f.write("<p>")


def add_index_html_footer(f):
    f.write("</p>")
    f.write("</body>")
    f.write("</html>")


def create_index_files(d):
    import os

    static_license_dir = d.getVar('STATIC_LICENSE_DIR')
    for dirpath, dirnames, filenames in os.walk(static_license_dir):
        with open(os.path.join(dirpath, "index.html"), "w") as f:
            add_index_html_header(f)
            full_list = filenames+dirnames
            full_list.sort()
            f.write("<br>".join(full_list))
            add_index_html_footer(f)


def copy_license_files(d):
    import shutil

    rootfs_license_dir = d.getVar('ROOTFS_LICENSE_DIR')
    static_license_dir = d.getVar('STATIC_LICENSE_DIR')
    shutil.copytree(rootfs_license_dir, static_license_dir)


python do_populate_static_lic() {
    copy_lic_dirs = d.getVar('COPY_LIC_DIRS')
    if copy_lic_dirs == "1":
        copy_license_files(d)
        create_index_files(d)
    else:
        bb.warn("Static licenses not copied because 'COPY_LIC_DIRS' is disabled.")
}

ROOTFS_POSTPROCESS_COMMAND:append = "do_populate_static_lic; "