cdb240f3d4
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to 01cf05bc75
109 lines
3.2 KiB
Python
109 lines
3.2 KiB
Python
# SPDX-FileCopyrightText: 2019 yuzu Emulator Project
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
import pefile
|
|
import sys
|
|
import re
|
|
import os
|
|
import queue
|
|
import shutil
|
|
|
|
# constant definitions
|
|
KNOWN_SYS_DLLS = ['WINMM.DLL', 'MSVCRT.DLL', 'VERSION.DLL', 'MPR.DLL',
|
|
'DWMAPI.DLL', 'UXTHEME.DLL', 'DNSAPI.DLL', 'IPHLPAPI.DLL']
|
|
# below is for Ubuntu 18.04 with specified PPA enabled, if you are using
|
|
# other distro or different repositories, change the following accordingly
|
|
DLL_PATH = [
|
|
'/usr/x86_64-w64-mingw32/bin/',
|
|
'/usr/x86_64-w64-mingw32/lib/',
|
|
'/usr/lib/gcc/x86_64-w64-mingw32/7.3-posix/'
|
|
]
|
|
|
|
missing = []
|
|
|
|
|
|
def parse_imports(file_name):
|
|
results = []
|
|
pe = pefile.PE(file_name, fast_load=True)
|
|
pe.parse_data_directories()
|
|
|
|
for entry in pe.DIRECTORY_ENTRY_IMPORT:
|
|
current = entry.dll.decode()
|
|
current_u = current.upper() # b/c Windows is often case insensitive
|
|
# here we filter out system dlls
|
|
# dll w/ names like *32.dll are likely to be system dlls
|
|
if current_u.upper() not in KNOWN_SYS_DLLS and not re.match(string=current_u, pattern=r'.*32\.DLL'):
|
|
results.append(current)
|
|
|
|
return results
|
|
|
|
|
|
def parse_imports_recursive(file_name, path_list=[]):
|
|
q = queue.Queue() # create a FIFO queue
|
|
# file_name can be a string or a list for the convience
|
|
if isinstance(file_name, str):
|
|
q.put(file_name)
|
|
elif isinstance(file_name, list):
|
|
for i in file_name:
|
|
q.put(i)
|
|
full_list = []
|
|
while q.qsize():
|
|
current = q.get_nowait()
|
|
print('> %s' % current)
|
|
deps = parse_imports(current)
|
|
# if this dll does not have any import, ignore it
|
|
if not deps:
|
|
continue
|
|
for dep in deps:
|
|
# the dependency already included in the list, skip
|
|
if dep in full_list:
|
|
continue
|
|
# find the requested dll in the provided paths
|
|
full_path = find_dll(dep)
|
|
if not full_path:
|
|
missing.append(dep)
|
|
continue
|
|
full_list.append(dep)
|
|
q.put(full_path)
|
|
path_list.append(full_path)
|
|
return full_list
|
|
|
|
|
|
def find_dll(name):
|
|
for path in DLL_PATH:
|
|
for root, _, files in os.walk(path):
|
|
for f in files:
|
|
if name.lower() == f.lower():
|
|
return os.path.join(root, f)
|
|
|
|
|
|
def deploy(name, dst, dry_run=False):
|
|
dlls_path = []
|
|
parse_imports_recursive(name, dlls_path)
|
|
for dll_entry in dlls_path:
|
|
if not dry_run:
|
|
shutil.copy(dll_entry, dst)
|
|
else:
|
|
print('[Dry-Run] Copy %s to %s' % (dll_entry, dst))
|
|
print('Deploy completed.')
|
|
return dlls_path
|
|
|
|
|
|
def main():
|
|
if len(sys.argv) < 3:
|
|
print('Usage: %s [files to examine ...] [target deploy directory]')
|
|
return 1
|
|
to_deploy = sys.argv[1:-1]
|
|
tgt_dir = sys.argv[-1]
|
|
if not os.path.isdir(tgt_dir):
|
|
print('%s is not a directory.' % tgt_dir)
|
|
return 1
|
|
print('Scanning dependencies...')
|
|
deploy(to_deploy, tgt_dir)
|
|
if missing:
|
|
print('Following DLLs are not found: %s' % ('\n'.join(missing)))
|
|
return 0
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|