Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix license requirement #311

Merged
merged 2 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion qgis-app/plugins/forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ def clean_package(self):
"""
package = self.cleaned_data.get("package")
try:
self.cleaned_data.update(validator(package))
self.cleaned_data.update(validator(package, plugin_is_new=True))
except ValidationError as e:
msg = _(
"There were errors reading plugin package (please check also your plugin's metadata)."
Expand Down
17 changes: 16 additions & 1 deletion qgis-app/plugins/tests/test_validator.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ def setUp(self) -> None:
def tearDown(self):
self.invalid_plugin.close()

def test_zipfile_without_license(self):
def test_new_plugin_without_license(self):
self.assertRaises(
ValidationError,
validator,
Expand All @@ -217,4 +217,19 @@ def test_zipfile_without_license(self):
size=39889,
charset="utf8",
),
plugin_is_new=True
)

def test_update_plugin_without_license(self):
self.assertTrue(
validator(
InMemoryUploadedFile(
self.invalid_plugin,
field_name="tempfile",
name="testfile.zip",
content_type="application/zip",
size=39889,
charset="utf8",
)
)
)
19 changes: 13 additions & 6 deletions qgis-app/plugins/validator.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ def _check_url_link(url: str, forbidden_url: str, metadata_attr: str) -> None:
raise error_check_if_exist


def validator(package):
def validator(package, plugin_is_new=False):
"""
Analyzes a zipped file, returns metadata if success, False otherwise.
If the new icon metadata is found, an inmemory file object is also returned
Expand All @@ -155,6 +155,7 @@ def validator(package):

* size <= PLUGIN_MAX_UPLOAD_SIZE
* zip contains __init__.py in first level dir
* Check for LICENCE file
* mandatory metadata: ('name', 'description', 'version', 'qgisMinimumVersion', 'author', 'email')
* package_name regexp: [A-Za-z][A-Za-z0-9-_]+
* author regexp: [^/]+
Expand Down Expand Up @@ -237,11 +238,6 @@ def validator(package):
if initname not in namelist:
raise ValidationError(_("Cannot find __init__.py in plugin package."))

# Checks for LICENCE file precense
licensename = package_name + "/LICENSE"
if licensename not in namelist:
raise ValidationError(_("Cannot find LICENSE in plugin package."))

# Checks metadata
metadata = []
# First parse metadata.txt
Expand Down Expand Up @@ -329,6 +325,17 @@ def validator(package):
_check_url_link(dict(metadata).get("repository"), "http://repo", "Repository")
_check_url_link(dict(metadata).get("homepage"), "http://homepage", "Home page")


# Checks for LICENCE file presence
# This should be just a warning for now (for new version upload)
# according to https://github.com/qgis/QGIS-Django/issues/38#issuecomment-1824010198
licensename = package_name + "/LICENSE"
if licensename not in namelist:
if plugin_is_new:
raise ValidationError(_("Cannot find LICENSE in the plugin package. This file is required for a new plugin, please consider adding it to the plugin package."))
else:
metadata.append(("license_recommended", "Yes"))

zip.close()
del zip

Expand Down
22 changes: 22 additions & 0 deletions qgis-app/plugins/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -956,6 +956,17 @@ def version_create(request, package_name):
version_notify(new_object)
if form.cleaned_data.get("icon_file"):
form.cleaned_data["icon"] = form.cleaned_data.get("icon_file")

if form.cleaned_data.get("license_recommended"):
messages.warning(
request,
_(
"Cannot find LICENSE in the plugin package. This file is not required for updating the plugin but is recommended, please consider adding it to the plugin package."
),
fail_silently=True,
)
del form.cleaned_data["license_recommended"]

_main_plugin_update(request, new_object.plugin, form)
_check_optional_metadata(form, request)
return HttpResponseRedirect(new_object.plugin.get_absolute_url())
Expand Down Expand Up @@ -1001,6 +1012,17 @@ def version_update(request, package_name, version):
_main_plugin_update(request, new_object.plugin, form)
msg = _("The Plugin Version has been successfully updated.")
messages.success(request, msg, fail_silently=True)

if form.cleaned_data.get("license_recommended"):
messages.warning(
request,
_(
"Cannot find LICENSE in the plugin package. This file is not required for updating the plugin but is recommended, please consider adding it to the plugin package."
),
fail_silently=True,
)
del form.cleaned_data["license_recommended"]

except (IntegrityError, ValidationError, DjangoUnicodeDecodeError) as e:
messages.error(request, e, fail_silently=True)
connection.close()
Expand Down
Loading