mirror of
https://github.com/inventree/InvenTree.git
synced 2025-06-18 21:15:41 +00:00
[WIP] Plugin Updates (#6400)
* Add method to extract "install name" from a plugin * Include more information in plugin meta serializer * Implement better API filtering for PluginConfig list * Add an "update" button to the plugin table row actions - Only for "package" plugins * Adds method to update a plugin: - Add plugin.installer.update_plugin method - Add error logging to existing methods - Add API endpoint and serializer - Integrate into PUI table * Implement lazy loading for plugin tables * Extract package information on registry load - Info is already available via entrypoint data - Significantly faster as introspection operation is expensive - Less code is good code * Frontend updates * Add accordion to plugin page * Add setting to control periodic version check updates * Update API version info * Add "package_name" field to PluginConfig - When the plugin is loaded, save this name to the PluginConfig model - Update the admin view * Update API serializer * Refactor plugin installer code - Add common functions * Adds API endpoint for uninstalling an installed plugin * Allow uninstall of plugin via API - Add API endpoints - Add UI elements * Tweak for admin list display * Update plugin * Refactor "update" method - Just use the "install" function - Add optional "version" specifier - UI updates * Allow deletion of PluginConfig when uninstalling plugin * Add placeholder for deleting database tables * Revert code change - get_object() is required * Use registry.get_plugin() - Instead of registry.plugins.get() - get_plugin checks registry hash - performs registry reload if necessary * Add PluginValidationMixin class - Allows the entire model to be validated via plugins - Called on model.full_clean() - Called on model.save() * Update Validation sample plugin * Fix for InvenTreeTree models * Refactor build.models - Expose models to plugin validation * Update stock.models * Update more models - common.models - company.models * Update more models - label.models - order.models - part.models * More model updates * Update docs * Fix for potential plugin edge case - plugin slug is globally unique - do not use get_or_create with two lookup fields - will throw an IntegrityError if you change the name of a plugin * Inherit DiffMixin into PluginValidationMixin - Allows us to pass model diffs through to validation - Plugins can validate based on what has *changed* * Update documentation * Add get_plugin_config helper function * Bug fix * Bug fix * Update plugin hash when calling set_plugin_state * Working on unit testing * More unit testing * Fix typo (installing -> uninstalling) * Reduce default timeout * set default timeout as part of ApiDefaults * revert changes to launch.json * Remove delete_tables field - Will come back in a future PR * Fix display of nonFIeldErrors in ApiForm.tsx * Allow deletion of deleted plugins - PluginConfig which no longer matches a valid (installed) plugin * Cleanup * Move get_plugin_config into registry.py * Move extract_int into InvenTree.helpers * Fix log formatting * Update model definitions - Ensure there are no changes to the migrations * Update PluginErrorTable.tsx Remove unused var * Update PluginManagementPanel.tsx remove unused var * Comment out format line * Comment out format line * Fix access to get_plugin_config * Fix tests for SimpleActionPlugin * More unit test fixes * Update plugin/installer.py - Account for version string - Remove on uninstall * Fix
This commit is contained in:
Oliver
GitHub
@ -1,11 +1,15 @@
|
||||
"""InvenTree API version information."""
|
||||
|
||||
# InvenTree API version
|
||||
INVENTREE_API_VERSION = 165
|
||||
INVENTREE_API_VERSION = 166
|
||||
"""Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
|
||||
|
||||
INVENTREE_API_TEXT = """
|
||||
|
||||
v166 -> 2024-02-04 : https://github.com/inventree/InvenTree/pull/6400
|
||||
- Adds package_name to plugin API
|
||||
- Adds mechanism for uninstalling plugins via the API
|
||||
|
||||
v165 -> 2024-01-28 : https://github.com/inventree/InvenTree/pull/6040
|
||||
- Adds supplier_part.name, part.creation_user, part.required_for_sales_order
|
||||
|
||||
|
||||
@ -1864,6 +1864,12 @@ class InvenTreeSetting(BaseInvenTreeSetting):
|
||||
'validator': bool,
|
||||
'requires_restart': True,
|
||||
},
|
||||
'PLUGIN_UPDATE_CHECK': {
|
||||
'name': _('Check for plugin updates'),
|
||||
'description': _('Enable periodic checks for updates to installed plugins'),
|
||||
'default': True,
|
||||
'validator': bool,
|
||||
},
|
||||
# Settings for plugin mixin features
|
||||
'ENABLE_PLUGINS_URL': {
|
||||
'name': _('Enable URL integration'),
|
||||
|
||||
@ -49,15 +49,15 @@ class PluginSettingInline(admin.TabularInline):
|
||||
class PluginConfigAdmin(admin.ModelAdmin):
|
||||
"""Custom admin with restricted id fields."""
|
||||
|
||||
readonly_fields = ['key', 'name']
|
||||
readonly_fields = ['key', 'name', 'package_name']
|
||||
list_display = [
|
||||
'name',
|
||||
'key',
|
||||
'__str__',
|
||||
'active',
|
||||
'is_builtin',
|
||||
'is_sample',
|
||||
'is_installed',
|
||||
'is_package',
|
||||
]
|
||||
list_filter = ['active']
|
||||
actions = [plugin_activate, plugin_deactivate]
|
||||
|
||||
@ -1,7 +1,10 @@
|
||||
"""API for the plugin app."""
|
||||
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.urls import include, path, re_path
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
|
||||
from django_filters import rest_framework as rest_filters
|
||||
from django_filters.rest_framework import DjangoFilterBackend
|
||||
from drf_spectacular.utils import extend_schema
|
||||
from rest_framework import permissions, status
|
||||
@ -13,7 +16,6 @@ import plugin.serializers as PluginSerializers
|
||||
from common.api import GlobalSettingsPermissions
|
||||
from InvenTree.api import MetadataView
|
||||
from InvenTree.filters import SEARCH_ORDER_FILTER
|
||||
from InvenTree.helpers import str2bool
|
||||
from InvenTree.mixins import (
|
||||
CreateAPI,
|
||||
ListAPI,
|
||||
@ -30,6 +32,87 @@ from plugin.models import PluginConfig, PluginSetting
|
||||
from plugin.plugin import InvenTreePlugin
|
||||
|
||||
|
||||
class PluginFilter(rest_filters.FilterSet):
|
||||
"""Filter for the PluginConfig model.
|
||||
|
||||
Provides custom filtering options for the FilterList API endpoint.
|
||||
"""
|
||||
|
||||
class Meta:
|
||||
"""Meta for the filter."""
|
||||
|
||||
model = PluginConfig
|
||||
fields = ['active']
|
||||
|
||||
mixin = rest_filters.CharFilter(
|
||||
field_name='mixin', method='filter_mixin', label='Mixin'
|
||||
)
|
||||
|
||||
def filter_mixin(self, queryset, name, value):
|
||||
"""Filter by implement mixin.
|
||||
|
||||
- A comma-separated list of mixin names can be provided.
|
||||
- Only plugins which implement all of the provided mixins will be returned.
|
||||
"""
|
||||
matches = []
|
||||
mixins = [x.strip().lower() for x in value.split(',') if x]
|
||||
|
||||
for result in queryset:
|
||||
match = True
|
||||
|
||||
for mixin in mixins:
|
||||
if mixin not in result.mixins().keys():
|
||||
match = False
|
||||
break
|
||||
|
||||
if match:
|
||||
matches.append(result.pk)
|
||||
|
||||
return queryset.filter(pk__in=matches)
|
||||
|
||||
builtin = rest_filters.BooleanFilter(
|
||||
field_name='builtin', label='Builtin', method='filter_builtin'
|
||||
)
|
||||
|
||||
def filter_builtin(self, queryset, name, value):
|
||||
"""Filter by 'builtin' flag."""
|
||||
matches = []
|
||||
|
||||
for result in queryset:
|
||||
if result.is_builtin() == value:
|
||||
matches.append(result.pk)
|
||||
|
||||
return queryset.filter(pk__in=matches)
|
||||
|
||||
sample = rest_filters.BooleanFilter(
|
||||
field_name='sample', label='Sample', method='filter_sample'
|
||||
)
|
||||
|
||||
def filter_sample(self, queryset, name, value):
|
||||
"""Filter by 'sample' flag."""
|
||||
matches = []
|
||||
|
||||
for result in queryset:
|
||||
if result.is_sample() == value:
|
||||
matches.append(result.pk)
|
||||
|
||||
return queryset.filter(pk__in=matches)
|
||||
|
||||
installed = rest_filters.BooleanFilter(
|
||||
field_name='installed', label='Installed', method='filter_installed'
|
||||
)
|
||||
|
||||
def filter_installed(self, queryset, name, value):
|
||||
"""Filter by 'installed' flag."""
|
||||
matches = []
|
||||
|
||||
for result in queryset:
|
||||
if result.is_installed() == value:
|
||||
matches.append(result.pk)
|
||||
|
||||
return queryset.filter(pk__in=matches)
|
||||
|
||||
|
||||
class PluginList(ListAPI):
|
||||
"""API endpoint for list of PluginConfig objects.
|
||||
|
||||
@ -41,70 +124,11 @@ class PluginList(ListAPI):
|
||||
# e.g. determining which label printing plugins are available
|
||||
permission_classes = [permissions.IsAuthenticated]
|
||||
|
||||
filterset_class = PluginFilter
|
||||
|
||||
serializer_class = PluginSerializers.PluginConfigSerializer
|
||||
queryset = PluginConfig.objects.all()
|
||||
|
||||
def filter_queryset(self, queryset):
|
||||
"""Filter for API requests.
|
||||
|
||||
Filter by mixin with the `mixin` flag
|
||||
"""
|
||||
queryset = super().filter_queryset(queryset)
|
||||
|
||||
params = self.request.query_params
|
||||
|
||||
# Filter plugins which support a given mixin
|
||||
mixin = params.get('mixin', None)
|
||||
|
||||
if mixin:
|
||||
matches = []
|
||||
|
||||
for result in queryset:
|
||||
if mixin in result.mixins().keys():
|
||||
matches.append(result.pk)
|
||||
|
||||
queryset = queryset.filter(pk__in=matches)
|
||||
|
||||
# Filter queryset by 'builtin' flag
|
||||
# We cannot do this using normal filters as it is not a database field
|
||||
if 'builtin' in params:
|
||||
builtin = str2bool(params['builtin'])
|
||||
|
||||
matches = []
|
||||
|
||||
for result in queryset:
|
||||
if result.is_builtin() == builtin:
|
||||
matches.append(result.pk)
|
||||
|
||||
queryset = queryset.filter(pk__in=matches)
|
||||
|
||||
# Filter queryset by 'sample' flag
|
||||
# We cannot do this using normal filters as it is not a database field
|
||||
if 'sample' in params:
|
||||
sample = str2bool(params['sample'])
|
||||
|
||||
matches = []
|
||||
|
||||
for result in queryset:
|
||||
if result.is_sample() == sample:
|
||||
matches.append(result.pk)
|
||||
|
||||
queryset = queryset.filter(pk__in=matches)
|
||||
|
||||
# Filter queryset by 'installed' flag
|
||||
if 'installed' in params:
|
||||
installed = str2bool(params['installed'])
|
||||
|
||||
matches = []
|
||||
|
||||
for result in queryset:
|
||||
if result.is_installed() == installed:
|
||||
matches.append(result.pk)
|
||||
|
||||
queryset = queryset.filter(pk__in=matches)
|
||||
|
||||
return queryset
|
||||
|
||||
filter_backends = SEARCH_ORDER_FILTER
|
||||
|
||||
filterset_fields = ['active']
|
||||
@ -132,6 +156,20 @@ class PluginDetail(RetrieveUpdateDestroyAPI):
|
||||
queryset = PluginConfig.objects.all()
|
||||
serializer_class = PluginSerializers.PluginConfigSerializer
|
||||
|
||||
def delete(self, request, *args, **kwargs):
|
||||
"""Handle DELETE request for a PluginConfig instance.
|
||||
|
||||
We only allow plugin deletion if the plugin is not active.
|
||||
"""
|
||||
cfg = self.get_object()
|
||||
|
||||
if cfg.active:
|
||||
raise ValidationError({
|
||||
'detail': _('Plugin cannot be deleted as it is currently active')
|
||||
})
|
||||
|
||||
return super().delete(request, *args, **kwargs)
|
||||
|
||||
|
||||
class PluginInstall(CreateAPI):
|
||||
"""Endpoint for installing a new plugin."""
|
||||
@ -156,6 +194,18 @@ class PluginInstall(CreateAPI):
|
||||
return serializer.save()
|
||||
|
||||
|
||||
class PluginUninstall(UpdateAPI):
|
||||
"""Endpoint for uninstalling a single plugin."""
|
||||
|
||||
queryset = PluginConfig.objects.all()
|
||||
serializer_class = PluginSerializers.PluginUninstallSerializer
|
||||
permission_classes = [IsSuperuser]
|
||||
|
||||
def perform_update(self, serializer):
|
||||
"""Uninstall the plugin."""
|
||||
serializer.save()
|
||||
|
||||
|
||||
class PluginActivate(UpdateAPI):
|
||||
"""Endpoint for activating a plugin.
|
||||
|
||||
@ -398,6 +448,11 @@ plugin_api_urls = [
|
||||
PluginActivate.as_view(),
|
||||
name='api-plugin-detail-activate',
|
||||
),
|
||||
path(
|
||||
'uninstall/',
|
||||
PluginUninstall.as_view(),
|
||||
name='api-plugin-uninstall',
|
||||
),
|
||||
path('', PluginDetail.as_view(), name='api-plugin-detail'),
|
||||
]),
|
||||
),
|
||||
|
||||
@ -9,6 +9,9 @@ from django.conf import settings
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
|
||||
import plugin.models
|
||||
from InvenTree.exceptions import log_error
|
||||
|
||||
logger = logging.getLogger('inventree')
|
||||
|
||||
|
||||
@ -32,6 +35,33 @@ def pip_command(*args):
|
||||
)
|
||||
|
||||
|
||||
def handle_pip_error(error, path: str) -> list:
|
||||
"""Raise a ValidationError when the pip command fails.
|
||||
|
||||
- Log the error to the database
|
||||
- Format the output from a pip command into a list of error messages.
|
||||
- Raise an appropriate error
|
||||
"""
|
||||
log_error(path)
|
||||
|
||||
output = error.output.decode('utf-8')
|
||||
|
||||
logger.error('Pip command failed: %s', output)
|
||||
|
||||
errors = []
|
||||
|
||||
for line in output.split('\n'):
|
||||
line = line.strip()
|
||||
|
||||
if line:
|
||||
errors.append(line)
|
||||
|
||||
if len(errors) > 1:
|
||||
raise ValidationError(errors)
|
||||
else:
|
||||
raise ValidationError(errors[0])
|
||||
|
||||
|
||||
def check_package_path(packagename: str):
|
||||
"""Determine the install path of a particular package.
|
||||
|
||||
@ -57,6 +87,8 @@ def check_package_path(packagename: str):
|
||||
return match.group(1)
|
||||
|
||||
except subprocess.CalledProcessError as error:
|
||||
log_error('check_package_path')
|
||||
|
||||
output = error.output.decode('utf-8')
|
||||
logger.exception('Plugin lookup failed: %s', str(output))
|
||||
return False
|
||||
@ -80,16 +112,18 @@ def install_plugins_file():
|
||||
except subprocess.CalledProcessError as error:
|
||||
output = error.output.decode('utf-8')
|
||||
logger.exception('Plugin file installation failed: %s', str(output))
|
||||
log_error('pip')
|
||||
return False
|
||||
except Exception as exc:
|
||||
logger.exception('Plugin file installation failed: %s', exc)
|
||||
log_error('pip')
|
||||
return False
|
||||
|
||||
# At this point, the plugins file has been installed
|
||||
return True
|
||||
|
||||
|
||||
def add_plugin_to_file(install_name):
|
||||
def update_plugins_file(install_name, remove=False):
|
||||
"""Add a plugin to the plugins file."""
|
||||
logger.info('Adding plugin to plugins file: %s', install_name)
|
||||
|
||||
@ -99,6 +133,10 @@ def add_plugin_to_file(install_name):
|
||||
logger.warning('Plugin file %s does not exist', str(pf))
|
||||
return
|
||||
|
||||
def compare_line(line: str):
|
||||
"""Check if a line in the file matches the installname."""
|
||||
return line.strip().split('==')[0] == install_name.split('==')[0]
|
||||
|
||||
# First, read in existing plugin file
|
||||
try:
|
||||
with pf.open(mode='r') as f:
|
||||
@ -107,19 +145,34 @@ def add_plugin_to_file(install_name):
|
||||
logger.exception('Failed to read plugins file: %s', str(exc))
|
||||
return
|
||||
|
||||
# Reconstruct output file
|
||||
output = []
|
||||
|
||||
found = False
|
||||
|
||||
# Check if plugin is already in file
|
||||
for line in lines:
|
||||
if line.strip() == install_name:
|
||||
logger.debug('Plugin already exists in file')
|
||||
return
|
||||
# Ignore processing for any commented lines
|
||||
if line.strip().startswith('#'):
|
||||
output.append(line)
|
||||
continue
|
||||
|
||||
if compare_line(line):
|
||||
found = True
|
||||
if not remove:
|
||||
# Replace line with new install name
|
||||
output.append(install_name)
|
||||
else:
|
||||
output.append(line)
|
||||
|
||||
# Append plugin to file
|
||||
lines.append(f'{install_name}')
|
||||
if not found and not remove:
|
||||
output.append(install_name)
|
||||
|
||||
# Write file back to disk
|
||||
try:
|
||||
with pf.open(mode='w') as f:
|
||||
for line in lines:
|
||||
for line in output:
|
||||
f.write(line)
|
||||
|
||||
if not line.endswith('\n'):
|
||||
@ -128,19 +181,19 @@ def add_plugin_to_file(install_name):
|
||||
logger.exception('Failed to add plugin to plugins file: %s', str(exc))
|
||||
|
||||
|
||||
def install_plugin(url=None, packagename=None, user=None):
|
||||
def install_plugin(url=None, packagename=None, user=None, version=None):
|
||||
"""Install a plugin into the python virtual environment.
|
||||
|
||||
Rules:
|
||||
- A staff user account is required
|
||||
- We must detect that we are running within a virtual environment
|
||||
Args:
|
||||
packagename: Optional package name to install
|
||||
url: Optional URL to install from
|
||||
user: Optional user performing the installation
|
||||
version: Optional version specifier
|
||||
"""
|
||||
if user and not user.is_staff:
|
||||
raise ValidationError(
|
||||
_('Permission denied: only staff users can install plugins')
|
||||
)
|
||||
raise ValidationError(_('Only staff users can administer plugins'))
|
||||
|
||||
logger.debug('install_plugin: %s, %s', url, packagename)
|
||||
logger.info('install_plugin: %s, %s', url, packagename)
|
||||
|
||||
# Check if we are running in a virtual environment
|
||||
# For now, just log a warning
|
||||
@ -178,6 +231,9 @@ def install_plugin(url=None, packagename=None, user=None):
|
||||
# use pypi
|
||||
full_pkg = packagename
|
||||
|
||||
if version:
|
||||
full_pkg = f'{full_pkg}=={version}'
|
||||
|
||||
install_name.append(full_pkg)
|
||||
|
||||
ret = {}
|
||||
@ -195,26 +251,10 @@ def install_plugin(url=None, packagename=None, user=None):
|
||||
ret['result'] = _(f'Installed plugin into {path}')
|
||||
|
||||
except subprocess.CalledProcessError as error:
|
||||
# If an error was thrown, we need to parse the output
|
||||
|
||||
output = error.output.decode('utf-8')
|
||||
logger.exception('Plugin installation failed: %s', str(output))
|
||||
|
||||
errors = [_('Plugin installation failed')]
|
||||
|
||||
for msg in output.split('\n'):
|
||||
msg = msg.strip()
|
||||
|
||||
if msg:
|
||||
errors.append(msg)
|
||||
|
||||
if len(errors) > 1:
|
||||
raise ValidationError(errors)
|
||||
else:
|
||||
raise ValidationError(errors[0])
|
||||
handle_pip_error(error, 'plugin_install')
|
||||
|
||||
# Save plugin to plugins file
|
||||
add_plugin_to_file(full_pkg)
|
||||
update_plugins_file(full_pkg)
|
||||
|
||||
# Reload the plugin registry, to discover the new plugin
|
||||
from plugin.registry import registry
|
||||
@ -222,3 +262,67 @@ def install_plugin(url=None, packagename=None, user=None):
|
||||
registry.reload_plugins(full_reload=True, force_reload=True, collect=True)
|
||||
|
||||
return ret
|
||||
|
||||
|
||||
def validate_package_plugin(cfg: plugin.models.PluginConfig, user=None):
|
||||
"""Validate a package plugin for update or removal."""
|
||||
if not cfg.plugin:
|
||||
raise ValidationError(_('Plugin was not found in registry'))
|
||||
|
||||
if not cfg.is_package():
|
||||
raise ValidationError(_('Plugin is not a packaged plugin'))
|
||||
|
||||
if not cfg.package_name:
|
||||
raise ValidationError(_('Plugin package name not found'))
|
||||
|
||||
if user and not user.is_staff:
|
||||
raise ValidationError(_('Only staff users can administer plugins'))
|
||||
|
||||
|
||||
def uninstall_plugin(cfg: plugin.models.PluginConfig, user=None, delete_config=True):
|
||||
"""Uninstall a plugin from the python virtual environment.
|
||||
|
||||
- The plugin must not be active
|
||||
- The plugin must be a "package" and have a valid package name
|
||||
|
||||
Args:
|
||||
cfg: PluginConfig object
|
||||
user: User performing the uninstall
|
||||
delete_config: If True, delete the plugin configuration from the database
|
||||
"""
|
||||
from plugin.registry import registry
|
||||
|
||||
if cfg.active:
|
||||
raise ValidationError(
|
||||
_('Plugin cannot be uninstalled as it is currently active')
|
||||
)
|
||||
|
||||
validate_package_plugin(cfg, user)
|
||||
package_name = cfg.package_name
|
||||
logger.info('Uninstalling plugin: %s', package_name)
|
||||
|
||||
cmd = ['uninstall', '-y', package_name]
|
||||
|
||||
try:
|
||||
result = pip_command(*cmd)
|
||||
|
||||
ret = {
|
||||
'result': _('Uninstalled plugin successfully'),
|
||||
'success': True,
|
||||
'output': str(result, 'utf-8'),
|
||||
}
|
||||
|
||||
except subprocess.CalledProcessError as error:
|
||||
handle_pip_error(error, 'plugin_uninstall')
|
||||
|
||||
# Update the plugins file
|
||||
update_plugins_file(package_name, remove=True)
|
||||
|
||||
if delete_config:
|
||||
# Remove the plugin configuration from the database
|
||||
cfg.delete()
|
||||
|
||||
# Reload the plugin registry
|
||||
registry.reload_plugins(full_reload=True, force_reload=True, collect=True)
|
||||
|
||||
return ret
|
||||
|
||||
@ -0,0 +1,18 @@
|
||||
# Generated by Django 3.2.23 on 2024-02-04 11:18
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('plugin', '0007_auto_20230805_1748'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name='pluginconfig',
|
||||
name='package_name',
|
||||
field=models.CharField(blank=True, help_text='Name of the installed package, if the plugin was installed via PIP', max_length=255, null=True, verbose_name='Package Name'),
|
||||
),
|
||||
]
|
||||
@ -42,6 +42,16 @@ class PluginConfig(InvenTree.models.MetadataMixin, models.Model):
|
||||
help_text=_('PluginName of the plugin'),
|
||||
)
|
||||
|
||||
package_name = models.CharField(
|
||||
null=True,
|
||||
blank=True,
|
||||
max_length=255,
|
||||
verbose_name=_('Package Name'),
|
||||
help_text=_(
|
||||
'Name of the installed package, if the plugin was installed via PIP'
|
||||
),
|
||||
)
|
||||
|
||||
active = models.BooleanField(
|
||||
default=False, verbose_name=_('Active'), help_text=_('Is the plugin active')
|
||||
)
|
||||
@ -160,6 +170,14 @@ class PluginConfig(InvenTree.models.MetadataMixin, models.Model):
|
||||
|
||||
return self.plugin.check_is_builtin()
|
||||
|
||||
@admin.display(boolean=True, description=_('Package Plugin'))
|
||||
def is_package(self) -> bool:
|
||||
"""Return True if this is a 'package' plugin."""
|
||||
if not self.plugin:
|
||||
return False
|
||||
|
||||
return getattr(self.plugin, 'is_package', False)
|
||||
|
||||
|
||||
class PluginSetting(common.models.BaseInvenTreeSetting):
|
||||
"""This model represents settings for individual plugins."""
|
||||
|
||||
@ -337,6 +337,30 @@ class InvenTreePlugin(VersionMixin, MixinBase, MetaBase):
|
||||
"""Path to the plugin."""
|
||||
return self.check_package_path()
|
||||
|
||||
@classmethod
|
||||
def check_package_install_name(cls) -> [str, None]:
|
||||
"""Installable package name of the plugin.
|
||||
|
||||
e.g. if this plugin was installed via 'pip install <x>',
|
||||
then this function should return '<x>'
|
||||
|
||||
Returns:
|
||||
str: Install name of the package, else None
|
||||
"""
|
||||
return getattr(cls, 'package_name', None)
|
||||
|
||||
@property
|
||||
def package_install_name(self) -> [str, None]:
|
||||
"""Installable package name of the plugin.
|
||||
|
||||
e.g. if this plugin was installed via 'pip install <x>',
|
||||
then this function should return '<x>'
|
||||
|
||||
Returns:
|
||||
str: Install name of the package, else None
|
||||
"""
|
||||
return self.check_package_install_name()
|
||||
|
||||
@property
|
||||
def settings_url(self):
|
||||
"""URL to the settings panel for this plugin."""
|
||||
|
||||
@ -439,8 +439,8 @@ class PluginsRegistry:
|
||||
raw_module = importlib.import_module(plugin)
|
||||
modules = get_plugins(raw_module, InvenTreePlugin, path=parent_path)
|
||||
|
||||
if modules:
|
||||
[collected_plugins.append(item) for item in modules]
|
||||
for item in modules or []:
|
||||
collected_plugins.append(item)
|
||||
|
||||
# From this point any plugins are considered "external" and only loaded if plugins are explicitly enabled
|
||||
if settings.PLUGINS_ENABLED:
|
||||
@ -453,6 +453,7 @@ class PluginsRegistry:
|
||||
try:
|
||||
plugin = entry.load()
|
||||
plugin.is_package = True
|
||||
plugin.package_name = getattr(entry.dist, 'name', None)
|
||||
plugin._get_package_metadata()
|
||||
collected_plugins.append(plugin)
|
||||
except Exception as error: # pragma: no cover
|
||||
@ -549,11 +550,22 @@ class PluginsRegistry:
|
||||
# Check if this is a 'builtin' plugin
|
||||
builtin = plg.check_is_builtin()
|
||||
|
||||
package_name = None
|
||||
|
||||
# Extract plugin package name
|
||||
if getattr(plg, 'is_package', False):
|
||||
package_name = getattr(plg, 'package_name', None)
|
||||
|
||||
# Auto-enable builtin plugins
|
||||
if builtin and plg_db and not plg_db.active:
|
||||
plg_db.active = True
|
||||
plg_db.save()
|
||||
|
||||
# Save the package_name attribute to the plugin
|
||||
if plg_db.package_name != package_name:
|
||||
plg_db.package_name = package_name
|
||||
plg_db.save()
|
||||
|
||||
# Determine if this plugin should be loaded:
|
||||
# - If PLUGIN_TESTING is enabled
|
||||
# - If this is a 'builtin' plugin
|
||||
@ -580,6 +592,7 @@ class PluginsRegistry:
|
||||
|
||||
# Safe extra attributes
|
||||
plg_i.is_package = getattr(plg_i, 'is_package', False)
|
||||
|
||||
plg_i.pk = plg_db.pk if plg_db else None
|
||||
plg_i.db = plg_db
|
||||
|
||||
|
||||
@ -51,12 +51,14 @@ class PluginConfigSerializer(serializers.ModelSerializer):
|
||||
'pk',
|
||||
'key',
|
||||
'name',
|
||||
'package_name',
|
||||
'active',
|
||||
'meta',
|
||||
'mixins',
|
||||
'is_builtin',
|
||||
'is_sample',
|
||||
'is_installed',
|
||||
'is_package',
|
||||
]
|
||||
|
||||
read_only_fields = ['key', 'is_builtin', 'is_sample', 'is_installed']
|
||||
@ -81,6 +83,7 @@ class PluginConfigInstallSerializer(serializers.Serializer):
|
||||
'Source for the package - this can be a custom registry or a VCS path'
|
||||
),
|
||||
)
|
||||
|
||||
packagename = serializers.CharField(
|
||||
required=False,
|
||||
allow_blank=True,
|
||||
@ -89,6 +92,16 @@ class PluginConfigInstallSerializer(serializers.Serializer):
|
||||
'Name for the Plugin Package - can also contain a version indicator'
|
||||
),
|
||||
)
|
||||
|
||||
version = serializers.CharField(
|
||||
required=False,
|
||||
allow_blank=True,
|
||||
label=_('Version'),
|
||||
help_text=_(
|
||||
'Version specifier for the plugin. Leave blank for latest version.'
|
||||
),
|
||||
)
|
||||
|
||||
confirm = serializers.BooleanField(
|
||||
label=_('Confirm plugin installation'),
|
||||
help_text=_(
|
||||
@ -120,8 +133,12 @@ class PluginConfigInstallSerializer(serializers.Serializer):
|
||||
|
||||
packagename = data.get('packagename', '')
|
||||
url = data.get('url', '')
|
||||
version = data.get('version', None)
|
||||
user = self.context['request'].user
|
||||
|
||||
return install_plugin(url=url, packagename=packagename)
|
||||
return install_plugin(
|
||||
url=url, packagename=packagename, version=version, user=user
|
||||
)
|
||||
|
||||
|
||||
class PluginConfigEmptySerializer(serializers.Serializer):
|
||||
@ -193,6 +210,27 @@ class PluginActivateSerializer(serializers.Serializer):
|
||||
return instance
|
||||
|
||||
|
||||
class PluginUninstallSerializer(serializers.Serializer):
|
||||
"""Serializer for uninstalling a plugin."""
|
||||
|
||||
delete_config = serializers.BooleanField(
|
||||
required=False,
|
||||
default=True,
|
||||
label=_('Delete configuration'),
|
||||
help_text=_('Delete the plugin configuration from the database'),
|
||||
)
|
||||
|
||||
def update(self, instance, validated_data):
|
||||
"""Uninstall the specified plugin."""
|
||||
from plugin.installer import uninstall_plugin
|
||||
|
||||
return uninstall_plugin(
|
||||
instance,
|
||||
user=self.context['request'].user,
|
||||
delete_config=validated_data.get('delete_config', True),
|
||||
)
|
||||
|
||||
|
||||
class PluginSettingSerializer(GenericReferencedSettingSerializer):
|
||||
"""Serializer for the PluginSetting model."""
|
||||
|
||||
|
||||
Reference in New Issue
Block a user