| author | Da Risk <da_risk@geekorum.com> | 
| Mon, 05 May 2025 02:56:41 -0400 | |
| changeset 79 | 79794afbbf95 | 
| parent 34 | ce299aacc068 | 
| permissions | -rw-r--r-- | 
| 
25
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
1  | 
/*  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
2  | 
* AboutOss is an utility library to retrieve and display  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
3  | 
* opensource licenses in Android applications.  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
4  | 
*  | 
| 
34
 
ce299aacc068
build: update license headers
 
Da Risk <da_risk@geekorum.com> 
parents: 
25 
diff
changeset
 | 
5  | 
* Copyright (C) 2023-2025 by Frederic-Charles Barthelery.  | 
| 
25
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
6  | 
*  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
7  | 
* This file is part of AboutOss.  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
8  | 
*  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
9  | 
* AboutOss is free software: you can redistribute it and/or modify  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
10  | 
* it under the terms of the GNU General Public License as published by  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
11  | 
* the Free Software Foundation, either version 3 of the License, or  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
12  | 
* (at your option) any later version.  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
13  | 
*  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
14  | 
* AboutOss is distributed in the hope that it will be useful,  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
15  | 
* but WITHOUT ANY WARRANTY; without even the implied warranty of  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
16  | 
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
17  | 
* GNU General Public License for more details.  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
18  | 
*  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
19  | 
* You should have received a copy of the GNU General Public License  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
20  | 
* along with AboutOss. If not, see <http://www.gnu.org/licenses/>.  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
21  | 
*/  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
22  | 
package com.geekorum.aboutoss.core.licenseplist  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
23  | 
|
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
24  | 
import kotlinx.cinterop.BetaInteropApi  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
25  | 
import kotlinx.cinterop.ExperimentalForeignApi  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
26  | 
import kotlinx.cinterop.ObjCObjectVar  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
27  | 
import kotlinx.cinterop.alloc  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
28  | 
import kotlinx.cinterop.memScoped  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
29  | 
import kotlinx.cinterop.ptr  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
30  | 
import kotlinx.cinterop.value  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
31  | 
import platform.Foundation.NSBundle  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
32  | 
import platform.Foundation.NSData  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
33  | 
import platform.Foundation.NSError  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
34  | 
import platform.Foundation.NSPropertyListMutableContainers  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
35  | 
import platform.Foundation.NSPropertyListSerialization  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
36  | 
import platform.Foundation.NSURL  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
37  | 
import platform.Foundation.dataWithContentsOfURL  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
38  | 
import kotlin.coroutines.resume  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
39  | 
import kotlin.coroutines.resumeWithException  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
40  | 
import kotlin.coroutines.suspendCoroutine  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
41  | 
|
| 79 | 42  | 
/**  | 
43  | 
* Parse LicensePlist files  | 
|
44  | 
*/  | 
|
| 
25
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
45  | 
class LicensePlistParser {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
46  | 
|
| 79 | 47  | 
/**  | 
48  | 
* Parse LicensePlist files  | 
|
49  | 
*  | 
|
50  | 
* @param licensePlistInput url of com.mono0926.LicensePlist.plist file  | 
|
51  | 
* @return a map of dependency name to license  | 
|
52  | 
*/  | 
|
| 
25
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
53  | 
    @Suppress("UNCHECKED_CAST")
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
54  | 
suspend fun parseLicenses(  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
55  | 
licensePlistInput: NSURL  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
56  | 
    ): Map<String, String> {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
57  | 
val fileContent = getContent(licensePlistInput)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
58  | 
val plist = fileContent.toPropertyList() as Map<String, List<Map<String, String>>>  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
59  | 
val paneLists = plist["PreferenceSpecifiers"]!!  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
60  | 
            .filter {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
61  | 
it["Type"] == "PSChildPaneSpecifier"  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
62  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
63  | 
val directoryUrl = licensePlistInput.URLByDeletingLastPathComponent()!!  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
64  | 
        return paneLists.associate { pane ->
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
65  | 
val paneFile = pane["File"]!!  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
66  | 
val libraryName = pane["Title"]!!  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
67  | 
val paneUrl = buildPaneUrl(directoryUrl, paneFile)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
68  | 
val paneFileContent = getContent(paneUrl)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
69  | 
val paneFilePlist = paneFileContent.toPropertyList() as Map<String, List<Map<String, String>>>  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
70  | 
val license = getLicenseFromPaneFilePlist(paneFilePlist)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
71  | 
libraryName to license  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
72  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
73  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
74  | 
|
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
75  | 
    private fun buildPaneUrl(directoryUrl: NSURL, paneName: String) = directoryUrl.URLByAppendingPathComponent(paneName)!!.URLByAppendingPathExtension("plist")!!
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
76  | 
|
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
77  | 
    private fun getLicenseFromPaneFilePlist(paneFilePList: Map<String, List<Map<String, String>>>): String {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
78  | 
val specifiers = paneFilePList["PreferenceSpecifiers"]!!  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
79  | 
        val licenses = specifiers.map {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
80  | 
it["FooterText"]!!  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
81  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
82  | 
        return licenses.joinToString("\n\n")
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
83  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
84  | 
|
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
85  | 
    private fun getContent(url: NSURL): NSData {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
86  | 
return checkNotNull(NSData.dataWithContentsOfURL(url))  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
87  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
88  | 
|
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
89  | 
@OptIn(ExperimentalForeignApi::class, BetaInteropApi::class)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
90  | 
    private suspend fun NSData.toPropertyList(): Any? = suspendCoroutine { cont ->
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
91  | 
        val parsed = memScoped {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
92  | 
val error: ObjCObjectVar<NSError?> = alloc()  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
93  | 
val result = NSPropertyListSerialization.propertyListWithData(this@toPropertyList,  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
94  | 
options = NSPropertyListMutableContainers,  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
95  | 
format = null,  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
96  | 
error.ptr  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
97  | 
)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
98  | 
            if (error.value != null) {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
99  | 
cont.resumeWithException(Exception(error.value!!.description))  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
100  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
101  | 
result  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
102  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
103  | 
cont.resume(parsed!!)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
104  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
105  | 
|
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
106  | 
    companion object {
 | 
| 79 | 107  | 
/**  | 
108  | 
* Get url of the default LicensePlist file  | 
|
109  | 
*/  | 
|
| 
25
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
110  | 
        fun getDefaultLicensePlistUrl(): NSURL {
 | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
111  | 
val path = NSBundle.mainBundle.pathForResource(  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
112  | 
"com.mono0926.LicensePlist",  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
113  | 
ofType = "plist",  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
114  | 
inDirectory = "licenseplist"  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
115  | 
)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
116  | 
return NSURL.fileURLWithPath(path!!)  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
117  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
118  | 
}  | 
| 
 
a645b4ebb054
core: add ios LicensePlistParser
 
Da Risk <da_risk@geekorum.com> 
parents:  
diff
changeset
 | 
119  | 
}  |