mirror of
https://github.com/dkmstr/openuds.git
synced 2025-10-18 03:33:44 +03:00
215 lines
8.3 KiB
Python
215 lines
8.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
#
|
|
# Copyright (c) 2014-2023 Virtual Cable S.L.U.
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without modification,
|
|
# are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright notice,
|
|
# this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
# * Neither the name of Virtual Cable S.L.U. nor the names of its contributors
|
|
# may be used to endorse or promote products derived from this software
|
|
# without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
"""
|
|
Author: Adolfo Gómez, dkmaster at dkmon dot com
|
|
"""
|
|
import collections.abc
|
|
import dataclasses
|
|
import logging
|
|
import typing
|
|
|
|
from django.utils.translation import gettext, gettext_lazy as _
|
|
from django.db.models import Model
|
|
|
|
import uds.core.types.permissions
|
|
from uds.core import exceptions, services, types
|
|
from uds.core.environment import Environment
|
|
from uds.core.util import ensure, permissions, ui as ui_utils
|
|
from uds.core.types.states import State
|
|
from uds.models import Provider, Service, UserService
|
|
from uds.REST.model import ModelHandler
|
|
|
|
from .services import Services as DetailServices
|
|
from .services_usage import ServicesUsage
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
# Helper class for Provider offers
|
|
@dataclasses.dataclass
|
|
class OfferItem(types.rest.BaseRestItem):
|
|
name: str
|
|
type: str
|
|
description: str
|
|
icon: str
|
|
|
|
|
|
@dataclasses.dataclass
|
|
class ProviderItem(types.rest.ManagedObjectItem[Provider]):
|
|
id: str
|
|
name: str
|
|
tags: list[str]
|
|
services_count: int
|
|
user_services_count: int
|
|
maintenance_mode: bool
|
|
offers: list[OfferItem]
|
|
comments: str
|
|
permission: types.permissions.PermissionType
|
|
|
|
|
|
class Providers(ModelHandler[ProviderItem]):
|
|
|
|
MODEL = Provider
|
|
DETAIL = {'services': DetailServices, 'usage': ServicesUsage}
|
|
|
|
CUSTOM_METHODS = [
|
|
types.rest.ModelCustomMethod('allservices', False),
|
|
types.rest.ModelCustomMethod('service', False),
|
|
types.rest.ModelCustomMethod('maintenance', True),
|
|
]
|
|
|
|
FIELDS_TO_SAVE = ['name', 'comments', 'tags']
|
|
|
|
TABLE = (
|
|
ui_utils.TableBuilder(_('Service providers'))
|
|
.icon(name='name', title=_('Name'))
|
|
.text_column(name='type_name', title=_('Type'))
|
|
.text_column(name='comments', title=_('Comments'))
|
|
.numeric_column(name='services_count', title=_('Services'))
|
|
.numeric_column(name='user_services_count', title=_('User Services'))
|
|
.text_column(name='tags', title=_('Tags'), visible=False)
|
|
.row_style(prefix='row-maintenance-', field='maintenance_mode')
|
|
).build()
|
|
|
|
# Rest api related information to complete the auto-generated API
|
|
REST_API_INFO = types.rest.api.RestApiInfo(
|
|
typed=types.rest.api.RestApiInfoGuiType.MULTIPLE_TYPES,
|
|
)
|
|
|
|
def get_item(self, item: 'Model') -> ProviderItem:
|
|
item = ensure.is_instance(item, Provider)
|
|
type_ = item.get_type()
|
|
|
|
# Icon can have a lot of data (1-2 Kbytes), but it's not expected to have a lot of services providers, and even so, this will work fine
|
|
offers: list[OfferItem] = [
|
|
OfferItem(
|
|
name=gettext(t.mod_name()),
|
|
type=t.mod_type(),
|
|
description=gettext(t.description()),
|
|
icon=t.icon64().replace('\n', ''),
|
|
)
|
|
for t in type_.get_provided_services()
|
|
]
|
|
|
|
return ProviderItem(
|
|
id=item.uuid,
|
|
name=item.name,
|
|
tags=[tag.vtag for tag in item.tags.all()],
|
|
services_count=item.services.count(),
|
|
user_services_count=UserService.objects.filter(deployed_service__service__provider=item)
|
|
.exclude(state__in=(State.REMOVED, State.ERROR))
|
|
.count(),
|
|
maintenance_mode=item.maintenance_mode,
|
|
offers=offers,
|
|
comments=item.comments,
|
|
permission=permissions.effective_permissions(self._user, item),
|
|
item=item,
|
|
)
|
|
|
|
def validate_delete(self, item: 'Model') -> None:
|
|
item = ensure.is_instance(item, Provider)
|
|
if item.services.count() > 0:
|
|
raise exceptions.rest.RequestError(gettext('Can\'t delete providers with services'))
|
|
|
|
# Types related
|
|
@classmethod
|
|
def possible_types(cls: type[typing.Self]) -> collections.abc.Iterable[type[services.ServiceProvider]]:
|
|
return services.factory().providers().values()
|
|
|
|
# Gui related
|
|
def get_gui(self, for_type: str) -> list[types.ui.GuiElement]:
|
|
provider_type = services.factory().lookup(for_type)
|
|
if provider_type:
|
|
with Environment.temporary_environment() as env:
|
|
provider = provider_type(env, None)
|
|
return (
|
|
ui_utils.GuiBuilder()
|
|
.add_stock_field(types.rest.stock.StockField.NAME)
|
|
.add_stock_field(types.rest.stock.StockField.TAGS)
|
|
.add_stock_field(types.rest.stock.StockField.COMMENTS)
|
|
.add_fields(provider.gui_description(), parent='instance')
|
|
).build()
|
|
|
|
raise exceptions.rest.NotFound('Type not found!')
|
|
|
|
def allservices(self) -> typing.Generator[types.rest.BaseRestItem, None, None]:
|
|
"""
|
|
Custom method that returns "all existing services", no mater who's his daddy :)
|
|
"""
|
|
for s in Service.objects.all():
|
|
try:
|
|
perm = permissions.effective_permissions(self._user, s)
|
|
if perm >= uds.core.types.permissions.PermissionType.READ:
|
|
yield DetailServices.service_item(s, perm, True)
|
|
except Exception:
|
|
logger.exception('Passed service cause type is unknown')
|
|
|
|
def service(self) -> types.rest.BaseRestItem:
|
|
"""
|
|
Custom method that returns a service by its uuid, no matter who's his daddy
|
|
"""
|
|
try:
|
|
service = Service.objects.get(uuid=self._args[1])
|
|
self.check_access(service.provider, uds.core.types.permissions.PermissionType.READ)
|
|
perm = self.get_permissions(service.provider)
|
|
return DetailServices.service_item(service, perm, True)
|
|
except Exception:
|
|
# logger.exception('Exception')
|
|
return types.rest.BaseRestItem()
|
|
|
|
def maintenance(self, item: 'Model') -> types.rest.BaseRestItem:
|
|
"""
|
|
Custom method that swaps maintenance mode state for a provider
|
|
:param item:
|
|
"""
|
|
item = ensure.is_instance(item, Provider)
|
|
self.check_access(item, uds.core.types.permissions.PermissionType.MANAGEMENT)
|
|
item.maintenance_mode = not item.maintenance_mode
|
|
item.save()
|
|
return self.get_item(item)
|
|
|
|
def test(self, type_: str) -> str:
|
|
from uds.core.environment import Environment
|
|
|
|
logger.debug('Type: %s', type_)
|
|
provider_type = services.factory().lookup(type_)
|
|
|
|
if not provider_type:
|
|
raise exceptions.rest.NotFound('Type not found!')
|
|
|
|
with Environment.temporary_environment() as temp_environment:
|
|
logger.debug('spType: %s', provider_type)
|
|
|
|
# On 5.0 onwards, instance comes inside "instance" key
|
|
dct = self._params.copy()['instance']
|
|
dct['_request'] = self._request
|
|
test_result = provider_type.test(temp_environment, dct)
|
|
return 'ok' if test_result.success else test_result.error
|