Merge branch 'feat/soft-licenses' into chore/all-my-stuffs

# Conflicts:
#	package.json
#	pnpm-lock.yaml
#	src/tools/index.ts
This commit is contained in:
ShareVB committed 2024-11-03 23:08:38 +01:00
commit 7b487a60b9
5 files changed
+394 -4

No files matched your search

+3
View File
@@ -105,6 +105,7 @@
"@types/js-beautify": "^1.14.3",
"@types/libmime": "^5.0.3",
"@types/emscripten": "^1.39.10",
"@types/spdx-satisfies": "^0.1.2",
"@vicons/material": "^0.12.0",
"@vicons/tabler": "^0.12.0",
"@vueuse/core": "^10.11.1",
@@ -277,6 +278,8 @@
"qrcode": "^1.5.1",
"rtf-stream-parser": "^3.8.0",
"slashes": "^3.0.12",
"safe-license-list": "^0.1.2",
"spdx-satisfies": "^5.0.1",
"sql-formatter": "^13.0.0",
"sshpk": "^1.18.0",
"turndown": "^7.1.2",
+43 -4
View File
@@ -134,6 +134,9 @@ dependencies:
'@types/punycode':
specifier: ^2.1.4
version: 2.1.4
'@types/spdx-satisfies':
specifier: ^0.1.2
version: 0.1.2
'@types/sshpk':
specifier: ^1.17.4
version: 1.17.4
@@ -569,6 +572,9 @@ dependencies:
rtf-stream-parser:
specifier: ^3.8.0
version: 3.8.0
safe-license-list:
specifier: ^0.1.2
version: 0.1.2
shiki:
specifier: ^1.22.0
version: 1.22.2
@@ -578,6 +584,9 @@ dependencies:
slashes:
specifier: ^3.0.12
version: 3.0.12
spdx-satisfies:
specifier: ^5.0.1
version: 5.0.1
sql-formatter:
specifier: ^13.0.0
version: 13.0.0
@@ -1045,7 +1054,7 @@ packages:
dependencies:
'@babel/types': 7.23.0
'@jridgewell/gen-mapping': 0.3.3
'@jridgewell/trace-mapping': 0.3.20
'@jridgewell/trace-mapping': 0.3.18
jsesc: 2.5.2
dev: true
@@ -5851,6 +5860,10 @@ packages:
resolution: {integrity: sha512-G8hZ6XJiHnuhQKR7ZmysCeJWE08o8T0AXtk5darsCaTVsYZhhgUrq53jizaR2FvsoeCwJhlmwTjkXBY5Pn/ZHw==}
dev: true
/@types/spdx-satisfies@0.1.2:
resolution: {integrity: sha512-v8OtFJhx4gHvOktcvP1cdeAXYhUq1O5XP+NTxyZoxDSaKYGf3BFWb0P4Ik/JfRxsscKn8fDe4w9Obv92bNQ26Q==}
dev: false
/@types/sshpk@1.17.4:
resolution: {integrity: sha512-5gI/7eJn6wmkuIuFY8JZJ1g5b30H9K5U5vKrvOuYu+hoZLb2xcVEgxhYZ2Vhbs0w/ACyzyfkJq0hQtBfSCugjw==}
dependencies:
@@ -7066,6 +7079,11 @@ packages:
engines: {node: '>=0.10.0'}
dev: false
/array-find-index@1.0.2:
resolution: {integrity: sha512-M1HQyIXcBGtVywBt8WVdim+lrNaK7VHp99Qt5pSNziXznKHViIBbXWtfRTpEFpF/c4FdfxNAsCCwPp5phBYJtw==}
engines: {node: '>=0.10.0'}
dev: false
/array-slice@1.1.0:
resolution: {integrity: sha512-B1qMD3RBP7O8o0H2KbrXDyB0IccejMF15+87Lvlor12ONPRHP6gTjXMNkt/d3ZuOGbAe66hFmaCfECI24Ufp6w==}
engines: {node: '>=0.10.0'}
@@ -13962,6 +13980,10 @@ packages:
/safe-buffer@5.2.1:
resolution: {integrity: sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==}
/safe-license-list@0.1.2:
resolution: {integrity: sha512-iY3tWEU++GUFO5iyNQgKdyYaV5/7g0g9IR3e2RXIm8f9/uzrlSt2EHje19Q185636EYpsR7NoZOfzfARzIc0bQ==}
dev: false
/safe-regex-test@1.0.0:
resolution: {integrity: sha512-JBUUzyOgEwXQY1NuPtvcj/qcBDbDmEvWufhlnXZIm75DEHp+afM1r1ujJpJsV/gSM4t59tpDyPi1sd6ZaPFfsA==}
dependencies:
@@ -14342,6 +14364,14 @@ packages:
engines: {node: '>= 10.13.0'}
dev: false
/spdx-compare@1.0.0:
resolution: {integrity: sha512-C1mDZOX0hnu0ep9dfmuoi03+eOdDoz2yvK79RxbcrVEG1NO1Ph35yW102DHWKN4pk80nwCgeMmSY5L25VE4D9A==}
dependencies:
array-find-index: 1.0.2
spdx-expression-parse: 3.0.1
spdx-ranges: 2.1.1
dev: false
/spdx-correct@3.2.0:
resolution: {integrity: sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==}
dependencies:
@@ -14351,18 +14381,27 @@ packages:
/spdx-exceptions@2.3.0:
resolution: {integrity: sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==}
dev: true
/spdx-expression-parse@3.0.1:
resolution: {integrity: sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==}
dependencies:
spdx-exceptions: 2.3.0
spdx-license-ids: 3.0.13
dev: true
/spdx-license-ids@3.0.13:
resolution: {integrity: sha512-XkD+zwiqXHikFZm4AX/7JSCXA98U5Db4AFd5XUg/+9UNtnH75+Z9KxtpYiJZx36mUDVOwH83pl7yvCer6ewM3w==}
dev: true
/spdx-ranges@2.1.1:
resolution: {integrity: sha512-mcdpQFV7UDAgLpXEE/jOMqvK4LBoO0uTQg0uvXUewmEFhpiZx5yJSZITHB8w1ZahKdhfZqP5GPEOKLyEq5p8XA==}
dev: false
/spdx-satisfies@5.0.1:
resolution: {integrity: sha512-Nwor6W6gzFp8XX4neaKQ7ChV4wmpSh2sSDemMFSzHxpTw460jxFYeOn+jq4ybnSSw/5sc3pjka9MQPouksQNpw==}
dependencies:
spdx-compare: 1.0.0
spdx-expression-parse: 3.0.1
spdx-ranges: 2.1.1
dev: false
/split@0.3.3:
resolution: {integrity: sha512-wD2AeVmxXRBoX44wAycgjVpMhvbwdI2aZjCkvfNcH1YqHQvJVa1duWc73OyVGJUc05fhFaTZeQ/PYsrmyH0JVA==}
+2
View File
@@ -75,6 +75,7 @@ import { tool as ansibleVaultCryptDecrypt } from './ansible-vault-crypt-decrypt'
import { tool as gzipConverter } from './gzip-converter';
import { tool as htpasswdGenerator } from './htpasswd-generator';
import { tool as mimeConverter } from './mime-converter';
import { tool as softwareLicenceCompatibility } from './software-licence-compatibility';
import { tool as safelinkDecoder } from './safelink-decoder';
import { tool as mongoObjectidConverter } from './mongo-objectid-converter';
import { tool as removeExif } from './remove-exif';
@@ -348,6 +349,7 @@ export const toolsByCategory: ToolCategory[] = [
userAgentParser,
httpStatusCodes,
jsonDiff,
softwareLicenceCompatibility,
safelinkDecoder,
apiTester,
bounceParser,
@@ -0,0 +1,12 @@
import { License } from '@vicons/tabler';
import { defineTool } from '../tool';
export const tool = defineTool({
name: 'Software licence compatibility',
path: '/software-licence-compatibility',
description: 'Software Licence compatibility checker and information',
keywords: ['software', 'licence', 'compatibility'],
component: () => import('./software-licence-compatibility.vue'),
icon: License,
createdAt: new Date('2024-03-17'),
});
@@ -0,0 +1,334 @@
<script setup lang="ts">
import satisfies from 'spdx-satisfies';
import { type ConditionTag, type LimitationTag, type PermissionTag, getLicenseFromId, licenses } from 'safe-license-list';
import type { VNode } from 'vue';
import { h, ref } from 'vue';
import type { SelectOption } from 'naive-ui';
import { NTooltip } from 'naive-ui';
import { Check as CheckIcon, LetterX as CrossIcon } from '@vicons/tabler';
import TextareaCopyable from '@/components/TextareaCopyable.vue';
const firstLicence = ref('GPL-3.0');
const secondLicence = ref('MIT');
const compatibility = computed(() => {
try {
return satisfies(firstLicence.value.split(':')[0], secondLicence.value.split(':')[0]) ? 'ok' : 'nok';
}
catch (e: any) {
return e.toString();
}
});
const permissions = [
{ key: 'commercial-use', desc: 'This software and derivatives may be used for commercial purposes.' },
{ key: 'modifications', desc: 'This software may be modified.' },
{ key: 'distribution', desc: 'This software may be distributed.' },
{ key: 'private-use', desc: 'This software may be used and modified in private.' },
{ key: 'patent-use', desc: 'This license provides an express grant of patent rights from contributors.' },
];
const permissionsInfos = permissions.map((l) => {
return { value: l.key, label: l.key, desc: l.desc };
});
const conditions = [
{ key: 'include-copyright', desc: 'A copy of the license and copyright notice must be included with the software.' },
{ key: 'include-copyright--source', desc: 'A copy of the license and copyright notice must be included with the software in source form, but is not required for binaries.' },
{ key: 'document-changes', desc: 'Changes made to the code must be documented.' },
{ key: 'disclose-source', desc: 'Source code must be made available when the software is distributed.' },
{ key: 'network-use-disclose', desc: 'Users who interact with the software via network are given the right to receive a copy of the source code.' },
{ key: 'same-license', desc: 'Modifications must be released under the same license when distributing the software. In some cases a similar or related license may be used.' },
{ key: 'same-license--file', desc: 'Modifications of existing files must be released under the same license when distributing the software. In some cases a similar or related license may be used.' },
{ key: 'same-license--library', desc: 'Modifications must be released under the same license when distributing the software. In some cases a similar or related license may be used, or this condition may not apply to works that use the software as a library.' },
];
const conditionsInfos = conditions.map((l) => {
return { value: l.key, label: l.key, desc: l.desc };
});
const limitations = [
{ key: 'trademark-use', desc: 'This license explicitly states that it does NOT grant trademark rights, even though licenses without such a statement probably do not grant any implicit trademark rights.' },
{ key: 'liability', desc: 'This license includes a limitation of liability.' },
{ key: 'patent-use', desc: 'This license explicitly states that it does NOT grant any rights in the patents of contributors.' },
{ key: 'warranty', desc: 'The license explicitly states that it does NOT provide any warranty.' },
];
const limitationsInfos = limitations.map((l) => {
return { value: l.key, label: l.key, desc: l.desc };
});
function renderTooltips({ node, option }: { node: VNode; option: SelectOption }) {
return h(NTooltip, null, {
trigger: () => node,
default: () => option.desc,
});
}
const currentLicence = ref('MIT');
const currentLicenceInfo = computed(() => {
return getLicenseFromId(currentLicence.value, true);
});
const licenceInfos = computed(() => licenses.map((l) => {
return { value: l.id, label: `${l.id}: ${l.title}` };
}));
const filterAllowedPermissions = ref([]);
const filterDisallowedPermissions = ref([]);
const filterAllowedConditions = ref([]);
const filterDisallowedConditions = ref([]);
const filterAllowedLimitations = ref([]);
const filterDisallowedLimitations = ref([]);
function includesAll(filters: string | string[], elements: string[]) {
return filters === '' || (filters as string[])?.every(e => elements.includes(e));
}
function includesNone(filters: string | string[], elements: string[]) {
return filters === '' || (filters as string[])?.every(e => !elements.includes(e));
}
const filteredLicencesInfos = computed(() => licenses.filter(
(licence) => {
return includesAll(filterAllowedPermissions.value, licence.permissions)
&& includesNone(filterDisallowedPermissions.value, licence.permissions)
&& includesAll(filterAllowedConditions.value, licence.conditions)
&& includesNone(filterDisallowedConditions.value, licence.conditions)
&& includesAll(filterAllowedLimitations.value, licence.limitations)
&& includesNone(filterDisallowedLimitations.value, licence.limitations);
}).map((l) => {
return { value: l.id, label: `${l.id}: ${l.title}` };
}));
function handleLicenceFallback() {
const fallback = filteredLicencesInfos.value && filteredLicencesInfos.value.length > 0 ? filteredLicencesInfos.value[0] : { value: '', label: '' };
currentLicence.value = fallback.value;
return fallback;
}
</script>
<template>
<div style="max-width: 600px;">
<n-card title="Software licences compatibility" mb-5>
<n-form-item label="First License (SPDX):" label-placement="left" label-width="120">
<n-auto-complete
v-model:value="firstLicence"
:options="licenceInfos"
placeholder="Put your first licence SPDX licence..."
raw-text
mb-5
/>
</n-form-item>
<n-form-item label="Second License (SPDX):" label-placement="left" label-width="120">
<n-auto-complete
v-model:value="secondLicence"
:options="licenceInfos"
placeholder="Put your second licence SPDX licence..."
raw-text
mb-5
/>
</n-form-item>
<div v-if="firstLicence !== '' && secondLicence !== ''" flex justify-center>
<span v-if="compatibility === 'ok'">
<n-icon color="green">
<CheckIcon />
</n-icon>
Compatible
</span>
<span v-if="compatibility === 'nok'">
<n-icon color="red">
<CrossIcon />
</n-icon>
Not compatible
</span>
<n-alert v-if="compatibility !== 'nok' && compatibility !== 'ok'" type="error">
{{ compatibility }}
</n-alert>
</div>
</n-card>
<n-card label="Licence infos">
<n-grid x-gap="12" :cols="2">
<n-gi>
<n-form-item
label="Allowed permission(s):"
label-placement="top"
>
<n-select
v-model:value="filterAllowedPermissions"
filterable multiple
:options="permissionsInfos"
:render-option="renderTooltips"
/>
</n-form-item>
</n-gi>
<n-gi>
<n-form-item
label="Disallowed permission(s):"
label-placement="top"
>
<n-select
v-model:value="filterDisallowedPermissions"
multiple filterable
:options="permissionsInfos"
:render-option="renderTooltips"
/>
</n-form-item>
</n-gi>
</n-grid>
<n-grid x-gap="12" :cols="2">
<n-gi>
<n-form-item
label="Allowed condition(s):"
label-placement="top"
>
<n-select
v-model:value="filterAllowedConditions"
multiple filterable
:options="conditionsInfos"
:render-option="renderTooltips"
/>
</n-form-item>
</n-gi>
<n-gi>
<n-form-item
label="Disallowed condition(s):"
label-placement="top"
>
<n-select
v-model:value="filterDisallowedConditions"
multiple filterable
:options="conditionsInfos"
:render-option="renderTooltips"
/>
</n-form-item>
</n-gi>
</n-grid>
<n-grid x-gap="12" :cols="2">
<n-gi>
<n-form-item
label="Allowed limitation(s):"
label-placement="top"
>
<n-select
v-model:value="filterAllowedLimitations"
multiple filterable
:options="limitationsInfos"
:render-option="renderTooltips"
/>
</n-form-item>
</n-gi>
<n-gi>
<n-form-item
label="Disallowed limitation(s):"
label-placement="top"
>
<n-select
v-model:value="filterDisallowedLimitations"
multiple filterable
:options="limitationsInfos"
:render-option="renderTooltips"
/>
</n-form-item>
</n-gi>
</n-grid>
<n-divider />
<n-select
v-model:value="currentLicence"
filterable
label-position="left"
label="Select a licence:"
:options="filteredLicencesInfos"
placeholder="Select a licence"
:fallback-option="handleLicenceFallback"
/>
<n-p text-center>
Applicable licences: {{ filteredLicencesInfos.length }}
</n-p>
<n-divider />
<div v-if="filteredLicencesInfos.length > 0">
<n-form-item label="Id:" label-placement="left">
<n-input
:value="currentLicenceInfo?.id"
readonly mb-5
/>
</n-form-item>
<n-form-item label="Title:" label-placement="left">
<n-input
:value="currentLicenceInfo?.title"
readonly mb-5
/>
</n-form-item>
<n-form-item label="Description:">
<TextareaCopyable
:value="currentLicenceInfo?.description ?? ''"
readonly
word-wrap
mb-5
/>
</n-form-item>
<n-form-item label="How:">
<TextareaCopyable
:value="currentLicenceInfo?.how ?? ''"
word-wrap
readonly
mb-5
/>
</n-form-item>
<n-form-item label="Used by:">
<TextareaCopyable
:value="Object.keys(currentLicenceInfo?.using || []).join(', ')"
mb-5
/>
</n-form-item>
<n-card title="Permissions" mb-5>
<n-p v-for="{ key, desc } in permissions" :key="key" :title="desc">
<n-icon v-if="(currentLicenceInfo?.permissions || []).includes(key as PermissionTag)" color="green">
<CheckIcon />
</n-icon>
<n-icon v-else color="red">
<CrossIcon />
</n-icon>
{{ key }}
</n-p>
</n-card>
<n-card title="Conditions" mb-5>
<n-p v-for="{ key, desc } in conditions" :key="key" :title="desc">
<n-icon v-if="(currentLicenceInfo?.conditions || []).includes(key as ConditionTag)" color="green">
<CheckIcon />
</n-icon>
<n-icon v-else color="red">
<CrossIcon />
</n-icon>
{{ key }}
</n-p>
</n-card>
<n-card title="Limitations" mb-5>
<n-p v-for="{ key, desc } in limitations" :key="key" :title="desc">
<n-icon v-if="(currentLicenceInfo?.limitations || []).includes(key as LimitationTag)" color="green">
<CheckIcon />
</n-icon>
<n-icon v-else color="red">
<CrossIcon />
</n-icon>
{{ key }}
</n-p>
</n-card>
<n-form-item label="Content:">
<TextareaCopyable
:value="currentLicenceInfo?.body ?? ''"
word-wrap
readonly
mb-5
/>
</n-form-item>
</div>
</n-card>
</div>
</template>