views.py 67 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960
  1. from datetime import datetime
  2. from django.contrib import messages
  3. from django.contrib.auth.mixins import LoginRequiredMixin
  4. from django.contrib.contenttypes.models import ContentType
  5. from django.core.exceptions import ValidationError
  6. from django.core.paginator import EmptyPage
  7. from django.db.models import Count, Q
  8. from django.http import Http404, HttpResponse, HttpResponseBadRequest, HttpResponseForbidden
  9. from django.shortcuts import get_object_or_404, redirect, render
  10. from django.urls import reverse
  11. from django.utils import timezone
  12. from django.utils.decorators import method_decorator
  13. from django.utils.http import content_disposition_header
  14. from django.utils.module_loading import import_string
  15. from django.utils.translation import gettext_lazy as _
  16. from django.views.decorators.cache import never_cache
  17. from django.views.generic import View
  18. from core.choices import ManagedFileRootPathChoices
  19. from core.models import Job
  20. from core.object_actions import BulkSync
  21. from dcim.models import Device, DeviceRole, Platform
  22. from extras.choices import LogLevelChoices
  23. from extras.dashboard.forms import DashboardWidgetAddForm, DashboardWidgetForm
  24. from extras.dashboard.utils import get_widget_class
  25. from extras.scripts import prepare_script_form
  26. from extras.utils import SharedObjectViewMixin
  27. from netbox.config import get_config
  28. from netbox.object_actions import *
  29. from netbox.ui import layout
  30. from netbox.ui.panels import (
  31. CommentsPanel,
  32. ContextTablePanel,
  33. JSONPanel,
  34. TemplatePanel,
  35. TextCodePanel,
  36. )
  37. from netbox.views import generic
  38. from netbox.views.generic.mixins import TableMixin
  39. from utilities.forms import ConfirmationForm, get_field_value
  40. from utilities.htmx import htmx_maybe_redirect_current_page, htmx_partial
  41. from utilities.paginator import EnhancedPaginator, get_paginate_count
  42. from utilities.query import count_related
  43. from utilities.querydict import normalize_querydict
  44. from utilities.request import copy_safe_request
  45. from utilities.rqworker import any_workers_for_queue
  46. from utilities.templatetags.builtins.filters import render_markdown
  47. from utilities.views import ContentTypePermissionRequiredMixin, get_action_url, register_model_view
  48. from virtualization.models import VirtualMachine
  49. from . import filtersets, forms, tables
  50. from .constants import LOG_LEVEL_RANK
  51. from .models import *
  52. from .tables import ReportResultsTable, ScriptJobTable, ScriptResultsTable
  53. from .ui import panels
  54. #
  55. # Custom fields
  56. #
  57. @register_model_view(CustomField, 'list', path='', detail=False)
  58. class CustomFieldListView(generic.ObjectListView):
  59. queryset = CustomField.objects.select_related('choice_set')
  60. filterset = filtersets.CustomFieldFilterSet
  61. filterset_form = forms.CustomFieldFilterForm
  62. table = tables.CustomFieldTable
  63. @register_model_view(CustomField)
  64. class CustomFieldView(generic.ObjectView):
  65. queryset = CustomField.objects.select_related('choice_set')
  66. template_name = 'generic/object.html'
  67. layout = layout.SimpleLayout(
  68. left_panels=[
  69. panels.CustomFieldPanel(),
  70. panels.CustomFieldBehaviorPanel(),
  71. CommentsPanel(),
  72. ],
  73. right_panels=[
  74. panels.CustomFieldObjectTypesPanel(),
  75. panels.CustomFieldValidationPanel(),
  76. panels.CustomFieldRelatedObjectsPanel(),
  77. ],
  78. )
  79. def get_extra_context(self, request, instance):
  80. related_models = ()
  81. for object_type in instance.object_types.all():
  82. related_models += (
  83. object_type.model_class().objects.restrict(request.user, 'view').exclude(
  84. Q(**{f'custom_field_data__{instance.name}': ''}) |
  85. Q(**{f'custom_field_data__{instance.name}': None})
  86. ),
  87. )
  88. return {
  89. 'related_models': related_models
  90. }
  91. @register_model_view(CustomField, 'add', detail=False)
  92. @register_model_view(CustomField, 'edit')
  93. class CustomFieldEditView(generic.ObjectEditView):
  94. queryset = CustomField.objects.select_related('choice_set')
  95. form = forms.CustomFieldForm
  96. @register_model_view(CustomField, 'delete')
  97. class CustomFieldDeleteView(generic.ObjectDeleteView):
  98. queryset = CustomField.objects.select_related('choice_set')
  99. @register_model_view(CustomField, 'bulk_import', path='import', detail=False)
  100. class CustomFieldBulkImportView(generic.BulkImportView):
  101. queryset = CustomField.objects.select_related('choice_set')
  102. model_form = forms.CustomFieldImportForm
  103. @register_model_view(CustomField, 'bulk_edit', path='edit', detail=False)
  104. class CustomFieldBulkEditView(generic.BulkEditView):
  105. queryset = CustomField.objects.select_related('choice_set')
  106. filterset = filtersets.CustomFieldFilterSet
  107. table = tables.CustomFieldTable
  108. form = forms.CustomFieldBulkEditForm
  109. @register_model_view(CustomField, 'bulk_rename', path='rename', detail=False)
  110. class CustomFieldBulkRenameView(generic.BulkRenameView):
  111. queryset = CustomField.objects.all()
  112. filterset = filtersets.CustomFieldFilterSet
  113. @register_model_view(CustomField, 'bulk_delete', path='delete', detail=False)
  114. class CustomFieldBulkDeleteView(generic.BulkDeleteView):
  115. queryset = CustomField.objects.select_related('choice_set')
  116. filterset = filtersets.CustomFieldFilterSet
  117. table = tables.CustomFieldTable
  118. #
  119. # Custom field choices
  120. #
  121. @register_model_view(CustomFieldChoiceSet, 'list', path='', detail=False)
  122. class CustomFieldChoiceSetListView(generic.ObjectListView):
  123. queryset = CustomFieldChoiceSet.objects.all()
  124. filterset = filtersets.CustomFieldChoiceSetFilterSet
  125. filterset_form = forms.CustomFieldChoiceSetFilterForm
  126. table = tables.CustomFieldChoiceSetTable
  127. @register_model_view(CustomFieldChoiceSet)
  128. class CustomFieldChoiceSetView(generic.ObjectView):
  129. queryset = CustomFieldChoiceSet.objects.all()
  130. template_name = 'generic/object.html'
  131. layout = layout.SimpleLayout(
  132. left_panels=[
  133. panels.CustomFieldChoiceSetPanel(),
  134. ],
  135. right_panels=[
  136. panels.CustomFieldChoiceSetChoicesPanel(),
  137. ],
  138. )
  139. def get_extra_context(self, request, instance):
  140. # Paginate choices list
  141. per_page = get_paginate_count(request)
  142. try:
  143. page_number = request.GET.get('page', 1)
  144. except ValueError:
  145. page_number = 1
  146. choice_rows = [
  147. {
  148. 'value': value,
  149. 'label': label,
  150. 'color': instance.get_choice_color(value),
  151. }
  152. for value, label in instance.choices
  153. ]
  154. paginator = EnhancedPaginator(choice_rows, per_page)
  155. try:
  156. choices = paginator.page(page_number)
  157. except EmptyPage:
  158. choices = paginator.page(paginator.num_pages)
  159. return {
  160. 'paginator': paginator,
  161. 'choices': choices,
  162. }
  163. @register_model_view(CustomFieldChoiceSet, 'add', detail=False)
  164. @register_model_view(CustomFieldChoiceSet, 'edit')
  165. class CustomFieldChoiceSetEditView(generic.ObjectEditView):
  166. queryset = CustomFieldChoiceSet.objects.all()
  167. form = forms.CustomFieldChoiceSetForm
  168. @register_model_view(CustomFieldChoiceSet, 'delete')
  169. class CustomFieldChoiceSetDeleteView(generic.ObjectDeleteView):
  170. queryset = CustomFieldChoiceSet.objects.all()
  171. @register_model_view(CustomFieldChoiceSet, 'bulk_import', path='import', detail=False)
  172. class CustomFieldChoiceSetBulkImportView(generic.BulkImportView):
  173. queryset = CustomFieldChoiceSet.objects.all()
  174. model_form = forms.CustomFieldChoiceSetImportForm
  175. @register_model_view(CustomFieldChoiceSet, 'bulk_edit', path='edit', detail=False)
  176. class CustomFieldChoiceSetBulkEditView(generic.BulkEditView):
  177. queryset = CustomFieldChoiceSet.objects.all()
  178. filterset = filtersets.CustomFieldChoiceSetFilterSet
  179. table = tables.CustomFieldChoiceSetTable
  180. form = forms.CustomFieldChoiceSetBulkEditForm
  181. @register_model_view(CustomFieldChoiceSet, 'bulk_rename', path='rename', detail=False)
  182. class CustomFieldChoiceSetBulkRenameView(generic.BulkRenameView):
  183. queryset = CustomFieldChoiceSet.objects.all()
  184. filterset = filtersets.CustomFieldChoiceSetFilterSet
  185. @register_model_view(CustomFieldChoiceSet, 'bulk_delete', path='delete', detail=False)
  186. class CustomFieldChoiceSetBulkDeleteView(generic.BulkDeleteView):
  187. queryset = CustomFieldChoiceSet.objects.all()
  188. filterset = filtersets.CustomFieldChoiceSetFilterSet
  189. table = tables.CustomFieldChoiceSetTable
  190. #
  191. # Custom links
  192. #
  193. @register_model_view(CustomLink, 'list', path='', detail=False)
  194. class CustomLinkListView(generic.ObjectListView):
  195. queryset = CustomLink.objects.all()
  196. filterset = filtersets.CustomLinkFilterSet
  197. filterset_form = forms.CustomLinkFilterForm
  198. table = tables.CustomLinkTable
  199. @register_model_view(CustomLink)
  200. class CustomLinkView(generic.ObjectView):
  201. queryset = CustomLink.objects.all()
  202. template_name = 'generic/object.html'
  203. layout = layout.SimpleLayout(
  204. left_panels=[
  205. panels.CustomLinkPanel(),
  206. panels.ObjectTypesPanel(title=_('Assigned Models')),
  207. ],
  208. right_panels=[
  209. TextCodePanel('link_text', title=_('Link Text')),
  210. TextCodePanel('link_url', title=_('Link URL')),
  211. ],
  212. )
  213. @register_model_view(CustomLink, 'add', detail=False)
  214. @register_model_view(CustomLink, 'edit')
  215. class CustomLinkEditView(generic.ObjectEditView):
  216. queryset = CustomLink.objects.all()
  217. form = forms.CustomLinkForm
  218. @register_model_view(CustomLink, 'delete')
  219. class CustomLinkDeleteView(generic.ObjectDeleteView):
  220. queryset = CustomLink.objects.all()
  221. @register_model_view(CustomLink, 'bulk_import', path='import', detail=False)
  222. class CustomLinkBulkImportView(generic.BulkImportView):
  223. queryset = CustomLink.objects.all()
  224. model_form = forms.CustomLinkImportForm
  225. @register_model_view(CustomLink, 'bulk_edit', path='edit', detail=False)
  226. class CustomLinkBulkEditView(generic.BulkEditView):
  227. queryset = CustomLink.objects.all()
  228. filterset = filtersets.CustomLinkFilterSet
  229. table = tables.CustomLinkTable
  230. form = forms.CustomLinkBulkEditForm
  231. @register_model_view(CustomLink, 'bulk_rename', path='rename', detail=False)
  232. class CustomLinkBulkRenameView(generic.BulkRenameView):
  233. queryset = CustomLink.objects.all()
  234. filterset = filtersets.CustomLinkFilterSet
  235. @register_model_view(CustomLink, 'bulk_delete', path='delete', detail=False)
  236. class CustomLinkBulkDeleteView(generic.BulkDeleteView):
  237. queryset = CustomLink.objects.all()
  238. filterset = filtersets.CustomLinkFilterSet
  239. table = tables.CustomLinkTable
  240. #
  241. # Export templates
  242. #
  243. @register_model_view(ExportTemplate, 'list', path='', detail=False)
  244. class ExportTemplateListView(generic.ObjectListView):
  245. queryset = ExportTemplate.objects.all()
  246. filterset = filtersets.ExportTemplateFilterSet
  247. filterset_form = forms.ExportTemplateFilterForm
  248. table = tables.ExportTemplateTable
  249. actions = (AddObject, BulkImport, BulkSync, BulkExport, BulkEdit, BulkRename, BulkDelete)
  250. @register_model_view(ExportTemplate)
  251. @method_decorator(never_cache, name='dispatch')
  252. class ExportTemplateView(generic.ObjectView):
  253. queryset = ExportTemplate.objects.all()
  254. template_name = 'generic/object.html'
  255. layout = layout.SimpleLayout(
  256. left_panels=[
  257. panels.ExportTemplatePanel(),
  258. TemplatePanel('core/inc/datafile_panel.html'),
  259. ],
  260. right_panels=[
  261. panels.ObjectTypesPanel(title=_('Assigned Models')),
  262. JSONPanel('environment_params', title=_('Environment Parameters')),
  263. ],
  264. bottom_panels=[
  265. TextCodePanel('template_code', title=_('Template'), show_sync_warning=True),
  266. ],
  267. )
  268. @register_model_view(ExportTemplate, 'add', detail=False)
  269. @register_model_view(ExportTemplate, 'edit')
  270. class ExportTemplateEditView(generic.ObjectEditView):
  271. queryset = ExportTemplate.objects.all()
  272. form = forms.ExportTemplateForm
  273. @register_model_view(ExportTemplate, 'delete')
  274. class ExportTemplateDeleteView(generic.ObjectDeleteView):
  275. queryset = ExportTemplate.objects.all()
  276. @register_model_view(ExportTemplate, 'bulk_import', path='import', detail=False)
  277. class ExportTemplateBulkImportView(generic.BulkImportView):
  278. queryset = ExportTemplate.objects.all()
  279. model_form = forms.ExportTemplateImportForm
  280. @register_model_view(ExportTemplate, 'bulk_edit', path='edit', detail=False)
  281. class ExportTemplateBulkEditView(generic.BulkEditView):
  282. queryset = ExportTemplate.objects.all()
  283. filterset = filtersets.ExportTemplateFilterSet
  284. table = tables.ExportTemplateTable
  285. form = forms.ExportTemplateBulkEditForm
  286. @register_model_view(ExportTemplate, 'bulk_rename', path='rename', detail=False)
  287. class ExportTemplateBulkRenameView(generic.BulkRenameView):
  288. queryset = ExportTemplate.objects.all()
  289. filterset = filtersets.ExportTemplateFilterSet
  290. @register_model_view(ExportTemplate, 'bulk_delete', path='delete', detail=False)
  291. class ExportTemplateBulkDeleteView(generic.BulkDeleteView):
  292. queryset = ExportTemplate.objects.all()
  293. filterset = filtersets.ExportTemplateFilterSet
  294. table = tables.ExportTemplateTable
  295. @register_model_view(ExportTemplate, 'bulk_sync', path='sync', detail=False)
  296. class ExportTemplateBulkSyncDataView(generic.BulkSyncDataView):
  297. queryset = ExportTemplate.objects.all()
  298. #
  299. # Saved filters
  300. #
  301. @register_model_view(SavedFilter, 'list', path='', detail=False)
  302. class SavedFilterListView(SharedObjectViewMixin, generic.ObjectListView):
  303. queryset = SavedFilter.objects.all()
  304. filterset = filtersets.SavedFilterFilterSet
  305. filterset_form = forms.SavedFilterFilterForm
  306. table = tables.SavedFilterTable
  307. @register_model_view(SavedFilter)
  308. class SavedFilterView(SharedObjectViewMixin, generic.ObjectView):
  309. queryset = SavedFilter.objects.all()
  310. template_name = 'generic/object.html'
  311. layout = layout.SimpleLayout(
  312. left_panels=[
  313. panels.SavedFilterPanel(),
  314. panels.SavedFilterObjectTypesPanel(),
  315. ],
  316. right_panels=[
  317. JSONPanel('parameters', title=_('Parameters')),
  318. ],
  319. )
  320. @register_model_view(SavedFilter, 'add', detail=False)
  321. @register_model_view(SavedFilter, 'edit')
  322. class SavedFilterEditView(SharedObjectViewMixin, generic.ObjectEditView):
  323. queryset = SavedFilter.objects.all()
  324. form = forms.SavedFilterForm
  325. def alter_object(self, obj, request, url_args, url_kwargs):
  326. if not obj.pk:
  327. obj.user = request.user
  328. return obj
  329. @register_model_view(SavedFilter, 'delete')
  330. class SavedFilterDeleteView(SharedObjectViewMixin, generic.ObjectDeleteView):
  331. queryset = SavedFilter.objects.all()
  332. @register_model_view(SavedFilter, 'bulk_import', path='import', detail=False)
  333. class SavedFilterBulkImportView(SharedObjectViewMixin, generic.BulkImportView):
  334. queryset = SavedFilter.objects.all()
  335. model_form = forms.SavedFilterImportForm
  336. @register_model_view(SavedFilter, 'bulk_edit', path='edit', detail=False)
  337. class SavedFilterBulkEditView(SharedObjectViewMixin, generic.BulkEditView):
  338. queryset = SavedFilter.objects.all()
  339. filterset = filtersets.SavedFilterFilterSet
  340. table = tables.SavedFilterTable
  341. form = forms.SavedFilterBulkEditForm
  342. @register_model_view(SavedFilter, 'bulk_rename', path='rename', detail=False)
  343. class SavedFilterBulkRenameView(generic.BulkRenameView):
  344. queryset = SavedFilter.objects.all()
  345. filterset = filtersets.SavedFilterFilterSet
  346. @register_model_view(SavedFilter, 'bulk_delete', path='delete', detail=False)
  347. class SavedFilterBulkDeleteView(SharedObjectViewMixin, generic.BulkDeleteView):
  348. queryset = SavedFilter.objects.all()
  349. filterset = filtersets.SavedFilterFilterSet
  350. table = tables.SavedFilterTable
  351. #
  352. # Table configs
  353. #
  354. @register_model_view(TableConfig, 'list', path='', detail=False)
  355. class TableConfigListView(SharedObjectViewMixin, generic.ObjectListView):
  356. queryset = TableConfig.objects.all()
  357. filterset = filtersets.TableConfigFilterSet
  358. filterset_form = forms.TableConfigFilterForm
  359. table = tables.TableConfigTable
  360. actions = (BulkExport, BulkEdit, BulkRename, BulkDelete)
  361. @register_model_view(TableConfig)
  362. class TableConfigView(SharedObjectViewMixin, generic.ObjectView):
  363. queryset = TableConfig.objects.all()
  364. template_name = 'generic/object.html'
  365. layout = layout.SimpleLayout(
  366. left_panels=[
  367. panels.TableConfigPanel(),
  368. ],
  369. right_panels=[
  370. panels.TableConfigColumnsPanel(),
  371. panels.TableConfigOrderingPanel(),
  372. ],
  373. )
  374. def get_extra_context(self, request, instance):
  375. table = instance.table_class([])
  376. return {
  377. 'columns': dict(table.columns.items()),
  378. }
  379. @register_model_view(TableConfig, 'add', detail=False)
  380. @register_model_view(TableConfig, 'edit')
  381. class TableConfigEditView(SharedObjectViewMixin, generic.ObjectEditView):
  382. queryset = TableConfig.objects.all()
  383. form = forms.TableConfigForm
  384. template_name = 'extras/tableconfig_edit.html'
  385. def get(self, request, *args, **kwargs):
  386. # The add view requires the object_type & table parameters from the source table view
  387. if not kwargs and not (request.GET.get('object_type') and request.GET.get('table')):
  388. messages.warning(request, _('Table configurations must be created from an object list view.'))
  389. return redirect('home')
  390. return super().get(request, *args, **kwargs)
  391. def alter_object(self, obj, request, url_args, url_kwargs):
  392. if not obj.pk:
  393. obj.user = request.user
  394. return obj
  395. @register_model_view(TableConfig, 'delete')
  396. class TableConfigDeleteView(SharedObjectViewMixin, generic.ObjectDeleteView):
  397. queryset = TableConfig.objects.all()
  398. @register_model_view(TableConfig, 'bulk_edit', path='edit', detail=False)
  399. class TableConfigBulkEditView(SharedObjectViewMixin, generic.BulkEditView):
  400. queryset = TableConfig.objects.all()
  401. filterset = filtersets.TableConfigFilterSet
  402. table = tables.TableConfigTable
  403. form = forms.TableConfigBulkEditForm
  404. @register_model_view(TableConfig, 'bulk_rename', path='rename', detail=False)
  405. class TableConfigBulkRenameView(generic.BulkRenameView):
  406. queryset = TableConfig.objects.all()
  407. filterset = filtersets.TableConfigFilterSet
  408. @register_model_view(TableConfig, 'bulk_delete', path='delete', detail=False)
  409. class TableConfigBulkDeleteView(SharedObjectViewMixin, generic.BulkDeleteView):
  410. queryset = TableConfig.objects.all()
  411. filterset = filtersets.TableConfigFilterSet
  412. table = tables.TableConfigTable
  413. #
  414. # Bookmarks
  415. #
  416. @register_model_view(Bookmark, 'add', detail=False)
  417. class BookmarkCreateView(generic.ObjectEditView):
  418. form = forms.BookmarkForm
  419. def get_queryset(self, request):
  420. return Bookmark.objects.filter(user=request.user)
  421. def alter_object(self, obj, request, url_args, url_kwargs):
  422. obj.user = request.user
  423. return obj
  424. @register_model_view(Bookmark, 'delete')
  425. class BookmarkDeleteView(generic.ObjectDeleteView):
  426. def get_queryset(self, request):
  427. return Bookmark.objects.filter(user=request.user)
  428. @register_model_view(Bookmark, 'bulk_delete', path='delete', detail=False)
  429. class BookmarkBulkDeleteView(generic.BulkDeleteView):
  430. table = tables.BookmarkTable
  431. def get_queryset(self, request):
  432. return Bookmark.objects.filter(user=request.user)
  433. #
  434. # Notification groups
  435. #
  436. @register_model_view(NotificationGroup, 'list', path='', detail=False)
  437. class NotificationGroupListView(generic.ObjectListView):
  438. queryset = NotificationGroup.objects.all()
  439. filterset = filtersets.NotificationGroupFilterSet
  440. filterset_form = forms.NotificationGroupFilterForm
  441. table = tables.NotificationGroupTable
  442. @register_model_view(NotificationGroup)
  443. class NotificationGroupView(generic.ObjectView):
  444. queryset = NotificationGroup.objects.all()
  445. template_name = 'generic/object.html'
  446. layout = layout.SimpleLayout(
  447. left_panels=[
  448. panels.NotificationGroupPanel(),
  449. ],
  450. right_panels=[
  451. panels.NotificationGroupGroupsPanel(),
  452. panels.NotificationGroupUsersPanel(),
  453. ],
  454. )
  455. @register_model_view(NotificationGroup, 'add', detail=False)
  456. @register_model_view(NotificationGroup, 'edit')
  457. class NotificationGroupEditView(generic.ObjectEditView):
  458. queryset = NotificationGroup.objects.all()
  459. form = forms.NotificationGroupForm
  460. @register_model_view(NotificationGroup, 'delete')
  461. class NotificationGroupDeleteView(generic.ObjectDeleteView):
  462. queryset = NotificationGroup.objects.all()
  463. @register_model_view(NotificationGroup, 'bulk_import', path='import', detail=False)
  464. class NotificationGroupBulkImportView(generic.BulkImportView):
  465. queryset = NotificationGroup.objects.all()
  466. model_form = forms.NotificationGroupImportForm
  467. @register_model_view(NotificationGroup, 'bulk_edit', path='edit', detail=False)
  468. class NotificationGroupBulkEditView(generic.BulkEditView):
  469. queryset = NotificationGroup.objects.all()
  470. filterset = filtersets.NotificationGroupFilterSet
  471. table = tables.NotificationGroupTable
  472. form = forms.NotificationGroupBulkEditForm
  473. @register_model_view(NotificationGroup, 'bulk_rename', path='rename', detail=False)
  474. class NotificationGroupBulkRenameView(generic.BulkRenameView):
  475. queryset = NotificationGroup.objects.all()
  476. filterset = filtersets.NotificationGroupFilterSet
  477. @register_model_view(NotificationGroup, 'bulk_delete', path='delete', detail=False)
  478. class NotificationGroupBulkDeleteView(generic.BulkDeleteView):
  479. queryset = NotificationGroup.objects.all()
  480. filterset = filtersets.NotificationGroupFilterSet
  481. table = tables.NotificationGroupTable
  482. #
  483. # Notifications
  484. #
  485. class NotificationsView(LoginRequiredMixin, View):
  486. """
  487. HTMX-only user-specific notifications list.
  488. """
  489. def get(self, request):
  490. return render(request, 'htmx/notifications.html', {
  491. 'notifications': request.user.notifications.unread()[:10],
  492. 'total_count': request.user.notifications.count(),
  493. 'unread_count': request.user.notifications.unread().count(),
  494. })
  495. @register_model_view(Notification, 'read')
  496. class NotificationReadView(LoginRequiredMixin, View):
  497. """
  498. Mark the Notification read and redirect the user to its attached object.
  499. """
  500. def get(self, request, pk):
  501. # Mark the Notification as read
  502. notification = get_object_or_404(request.user.notifications, pk=pk)
  503. if not get_config().MAINTENANCE_MODE:
  504. notification.read = timezone.now()
  505. notification.save()
  506. # Redirect to the object if it has a URL (deleted objects will not)
  507. if hasattr(notification.object, 'get_absolute_url'):
  508. return redirect(notification.object.get_absolute_url())
  509. return redirect('account:notifications')
  510. @register_model_view(Notification, name='dismiss_all', path='dismiss-all', detail=False)
  511. class NotificationDismissAllView(LoginRequiredMixin, View):
  512. """
  513. Convenience view to clear all *unread* notifications for the current user.
  514. """
  515. def get(self, request):
  516. request.user.notifications.unread().delete()
  517. if htmx_partial(request):
  518. # If a user is currently on the notification page, redirect there (full repaint)
  519. redirect_resp = htmx_maybe_redirect_current_page(request, 'account:notifications', preserve_query=True)
  520. if redirect_resp:
  521. return redirect_resp
  522. return render(request, 'htmx/notifications.html', {
  523. 'notifications': request.user.notifications.unread()[:10],
  524. 'total_count': request.user.notifications.count(),
  525. 'unread_count': request.user.notifications.unread().count(),
  526. })
  527. return redirect('account:notifications')
  528. @register_model_view(Notification, 'dismiss')
  529. class NotificationDismissView(LoginRequiredMixin, View):
  530. """
  531. A convenience view which allows deleting notifications with one click.
  532. """
  533. def get(self, request, pk):
  534. notification = get_object_or_404(request.user.notifications, pk=pk)
  535. notification.delete()
  536. if htmx_partial(request):
  537. # If a user is currently on the notification page, redirect there (full repaint)
  538. redirect_resp = htmx_maybe_redirect_current_page(request, 'account:notifications', preserve_query=True)
  539. if redirect_resp:
  540. return redirect_resp
  541. return render(request, 'htmx/notifications.html', {
  542. 'notifications': request.user.notifications.unread()[:10],
  543. 'total_count': request.user.notifications.count(),
  544. 'unread_count': request.user.notifications.unread().count(),
  545. })
  546. return redirect('account:notifications')
  547. @register_model_view(Notification, 'delete')
  548. class NotificationDeleteView(generic.ObjectDeleteView):
  549. def get_queryset(self, request):
  550. return Notification.objects.filter(user=request.user)
  551. @register_model_view(Notification, 'bulk_delete', path='delete', detail=False)
  552. class NotificationBulkDeleteView(generic.BulkDeleteView):
  553. table = tables.NotificationTable
  554. def get_queryset(self, request):
  555. return Notification.objects.filter(user=request.user)
  556. #
  557. # Subscriptions
  558. #
  559. @register_model_view(Subscription, 'add', detail=False)
  560. class SubscriptionCreateView(generic.ObjectEditView):
  561. form = forms.SubscriptionForm
  562. def get_queryset(self, request):
  563. return Subscription.objects.filter(user=request.user)
  564. def alter_object(self, obj, request, url_args, url_kwargs):
  565. obj.user = request.user
  566. return obj
  567. @register_model_view(Subscription, 'delete')
  568. class SubscriptionDeleteView(generic.ObjectDeleteView):
  569. def get_queryset(self, request):
  570. return Subscription.objects.filter(user=request.user)
  571. @register_model_view(Subscription, 'bulk_delete', path='delete', detail=False)
  572. class SubscriptionBulkDeleteView(generic.BulkDeleteView):
  573. table = tables.SubscriptionTable
  574. def get_queryset(self, request):
  575. return Subscription.objects.filter(user=request.user)
  576. #
  577. # Webhooks
  578. #
  579. @register_model_view(Webhook, 'list', path='', detail=False)
  580. class WebhookListView(generic.ObjectListView):
  581. queryset = Webhook.objects.all()
  582. filterset = filtersets.WebhookFilterSet
  583. filterset_form = forms.WebhookFilterForm
  584. table = tables.WebhookTable
  585. @register_model_view(Webhook)
  586. class WebhookView(generic.ObjectView):
  587. queryset = Webhook.objects.all()
  588. template_name = 'generic/object.html'
  589. layout = layout.SimpleLayout(
  590. left_panels=[
  591. panels.WebhookPanel(),
  592. panels.WebhookHTTPPanel(),
  593. panels.WebhookSSLPanel(),
  594. ],
  595. right_panels=[
  596. TextCodePanel('additional_headers', title=_('Additional Headers')),
  597. TextCodePanel('body_template', title=_('Body Template')),
  598. panels.CustomFieldsPanel(),
  599. panels.TagsPanel(),
  600. ],
  601. )
  602. @register_model_view(Webhook, 'add', detail=False)
  603. @register_model_view(Webhook, 'edit')
  604. class WebhookEditView(generic.ObjectEditView):
  605. queryset = Webhook.objects.all()
  606. form = forms.WebhookForm
  607. @register_model_view(Webhook, 'delete')
  608. class WebhookDeleteView(generic.ObjectDeleteView):
  609. queryset = Webhook.objects.all()
  610. @register_model_view(Webhook, 'bulk_import', path='import', detail=False)
  611. class WebhookBulkImportView(generic.BulkImportView):
  612. queryset = Webhook.objects.all()
  613. model_form = forms.WebhookImportForm
  614. @register_model_view(Webhook, 'bulk_edit', path='edit', detail=False)
  615. class WebhookBulkEditView(generic.BulkEditView):
  616. queryset = Webhook.objects.all()
  617. filterset = filtersets.WebhookFilterSet
  618. table = tables.WebhookTable
  619. form = forms.WebhookBulkEditForm
  620. @register_model_view(Webhook, 'bulk_rename', path='rename', detail=False)
  621. class WebhookBulkRenameView(generic.BulkRenameView):
  622. queryset = Webhook.objects.all()
  623. filterset = filtersets.WebhookFilterSet
  624. @register_model_view(Webhook, 'bulk_delete', path='delete', detail=False)
  625. class WebhookBulkDeleteView(generic.BulkDeleteView):
  626. queryset = Webhook.objects.all()
  627. filterset = filtersets.WebhookFilterSet
  628. table = tables.WebhookTable
  629. #
  630. # Event Rules
  631. #
  632. @register_model_view(EventRule, 'list', path='', detail=False)
  633. class EventRuleListView(generic.ObjectListView):
  634. queryset = EventRule.objects.all()
  635. filterset = filtersets.EventRuleFilterSet
  636. filterset_form = forms.EventRuleFilterForm
  637. table = tables.EventRuleTable
  638. @register_model_view(EventRule)
  639. class EventRuleView(generic.ObjectView):
  640. queryset = EventRule.objects.all()
  641. template_name = 'generic/object.html'
  642. layout = layout.SimpleLayout(
  643. left_panels=[
  644. panels.EventRulePanel(),
  645. panels.ObjectTypesPanel(),
  646. panels.EventRuleEventTypesPanel(),
  647. ],
  648. right_panels=[
  649. JSONPanel('conditions', title=_('Conditions')),
  650. panels.EventRuleActionPanel(),
  651. panels.CustomFieldsPanel(),
  652. panels.TagsPanel(),
  653. ],
  654. )
  655. @register_model_view(EventRule, 'add', detail=False)
  656. @register_model_view(EventRule, 'edit')
  657. class EventRuleEditView(generic.ObjectEditView):
  658. queryset = EventRule.objects.all()
  659. form = forms.EventRuleForm
  660. @register_model_view(EventRule, 'delete')
  661. class EventRuleDeleteView(generic.ObjectDeleteView):
  662. queryset = EventRule.objects.all()
  663. @register_model_view(EventRule, 'bulk_import', path='import', detail=False)
  664. class EventRuleBulkImportView(generic.BulkImportView):
  665. queryset = EventRule.objects.all()
  666. model_form = forms.EventRuleImportForm
  667. @register_model_view(EventRule, 'bulk_edit', path='edit', detail=False)
  668. class EventRuleBulkEditView(generic.BulkEditView):
  669. queryset = EventRule.objects.all()
  670. filterset = filtersets.EventRuleFilterSet
  671. table = tables.EventRuleTable
  672. form = forms.EventRuleBulkEditForm
  673. @register_model_view(EventRule, 'bulk_rename', path='rename', detail=False)
  674. class EventRuleBulkRenameView(generic.BulkRenameView):
  675. queryset = EventRule.objects.all()
  676. filterset = filtersets.EventRuleFilterSet
  677. @register_model_view(EventRule, 'bulk_delete', path='delete', detail=False)
  678. class EventRuleBulkDeleteView(generic.BulkDeleteView):
  679. queryset = EventRule.objects.all()
  680. filterset = filtersets.EventRuleFilterSet
  681. table = tables.EventRuleTable
  682. #
  683. # Tags
  684. #
  685. @register_model_view(Tag, 'list', path='', detail=False)
  686. class TagListView(generic.ObjectListView):
  687. queryset = Tag.objects.annotate(
  688. items=count_related(TaggedItem, 'tag')
  689. )
  690. filterset = filtersets.TagFilterSet
  691. filterset_form = forms.TagFilterForm
  692. table = tables.TagTable
  693. @register_model_view(Tag)
  694. class TagView(generic.ObjectView):
  695. queryset = Tag.objects.all()
  696. template_name = 'generic/object.html'
  697. layout = layout.SimpleLayout(
  698. left_panels=[
  699. panels.TagPanel(),
  700. ],
  701. right_panels=[
  702. panels.TagObjectTypesPanel(),
  703. panels.TagItemTypesPanel(),
  704. ],
  705. bottom_panels=[
  706. ContextTablePanel('taggeditem_table', title=_('Tagged Objects')),
  707. ],
  708. )
  709. def get_extra_context(self, request, instance):
  710. tagged_items = TaggedItem.objects.filter(tag=instance)
  711. taggeditem_table = tables.TaggedItemTable(
  712. data=tagged_items,
  713. orderable=False
  714. )
  715. taggeditem_table.configure(request)
  716. object_types = [
  717. {
  718. 'content_type': ContentType.objects.get(pk=ti['content_type']),
  719. 'item_count': ti['item_count']
  720. } for ti in tagged_items.values('content_type').annotate(item_count=Count('pk'))
  721. ]
  722. return {
  723. 'taggeditem_table': taggeditem_table,
  724. 'tagged_item_count': tagged_items.count(),
  725. 'object_types': object_types,
  726. }
  727. @register_model_view(Tag, 'add', detail=False)
  728. @register_model_view(Tag, 'edit')
  729. class TagEditView(generic.ObjectEditView):
  730. queryset = Tag.objects.all()
  731. form = forms.TagForm
  732. @register_model_view(Tag, 'delete')
  733. class TagDeleteView(generic.ObjectDeleteView):
  734. queryset = Tag.objects.all()
  735. @register_model_view(Tag, 'bulk_import', path='import', detail=False)
  736. class TagBulkImportView(generic.BulkImportView):
  737. queryset = Tag.objects.all()
  738. model_form = forms.TagImportForm
  739. @register_model_view(Tag, 'bulk_edit', path='edit', detail=False)
  740. class TagBulkEditView(generic.BulkEditView):
  741. queryset = Tag.objects.annotate(
  742. items=count_related(TaggedItem, 'tag')
  743. )
  744. table = tables.TagTable
  745. form = forms.TagBulkEditForm
  746. @register_model_view(Tag, 'bulk_rename', path='rename', detail=False)
  747. class TagBulkRenameView(generic.BulkRenameView):
  748. queryset = Tag.objects.all()
  749. @register_model_view(Tag, 'bulk_delete', path='delete', detail=False)
  750. class TagBulkDeleteView(generic.BulkDeleteView):
  751. queryset = Tag.objects.annotate(
  752. items=count_related(TaggedItem, 'tag')
  753. )
  754. table = tables.TagTable
  755. #
  756. # Config context profiles
  757. #
  758. @register_model_view(ConfigContextProfile, 'list', path='', detail=False)
  759. class ConfigContextProfileListView(generic.ObjectListView):
  760. queryset = ConfigContextProfile.objects.all()
  761. filterset = filtersets.ConfigContextProfileFilterSet
  762. filterset_form = forms.ConfigContextProfileFilterForm
  763. table = tables.ConfigContextProfileTable
  764. actions = (AddObject, BulkSync, BulkEdit, BulkRename, BulkDelete)
  765. @register_model_view(ConfigContextProfile)
  766. @method_decorator(never_cache, name='dispatch')
  767. class ConfigContextProfileView(generic.ObjectView):
  768. queryset = ConfigContextProfile.objects.all()
  769. template_name = 'generic/object.html'
  770. layout = layout.SimpleLayout(
  771. left_panels=[
  772. panels.ConfigContextProfilePanel(),
  773. TemplatePanel('core/inc/datafile_panel.html'),
  774. panels.CustomFieldsPanel(),
  775. panels.TagsPanel(),
  776. CommentsPanel(),
  777. ],
  778. right_panels=[
  779. JSONPanel('schema', title=_('JSON Schema')),
  780. ],
  781. )
  782. @register_model_view(ConfigContextProfile, 'add', detail=False)
  783. @register_model_view(ConfigContextProfile, 'edit')
  784. class ConfigContextProfileEditView(generic.ObjectEditView):
  785. queryset = ConfigContextProfile.objects.all()
  786. form = forms.ConfigContextProfileForm
  787. @register_model_view(ConfigContextProfile, 'delete')
  788. class ConfigContextProfileDeleteView(generic.ObjectDeleteView):
  789. queryset = ConfigContextProfile.objects.all()
  790. @register_model_view(ConfigContextProfile, 'bulk_import', path='import', detail=False)
  791. class ConfigContextProfileBulkImportView(generic.BulkImportView):
  792. queryset = ConfigContextProfile.objects.all()
  793. model_form = forms.ConfigContextProfileImportForm
  794. @register_model_view(ConfigContextProfile, 'bulk_edit', path='edit', detail=False)
  795. class ConfigContextProfileBulkEditView(generic.BulkEditView):
  796. queryset = ConfigContextProfile.objects.all()
  797. filterset = filtersets.ConfigContextProfileFilterSet
  798. table = tables.ConfigContextProfileTable
  799. form = forms.ConfigContextProfileBulkEditForm
  800. @register_model_view(ConfigContextProfile, 'bulk_rename', path='rename', detail=False)
  801. class ConfigContextProfileBulkRenameView(generic.BulkRenameView):
  802. queryset = ConfigContextProfile.objects.all()
  803. filterset = filtersets.ConfigContextProfileFilterSet
  804. @register_model_view(ConfigContextProfile, 'bulk_delete', path='delete', detail=False)
  805. class ConfigContextProfileBulkDeleteView(generic.BulkDeleteView):
  806. queryset = ConfigContextProfile.objects.all()
  807. filterset = filtersets.ConfigContextProfileFilterSet
  808. table = tables.ConfigContextProfileTable
  809. @register_model_view(ConfigContextProfile, 'bulk_sync', path='sync', detail=False)
  810. class ConfigContextProfileBulkSyncDataView(generic.BulkSyncDataView):
  811. queryset = ConfigContextProfile.objects.all()
  812. #
  813. # Config contexts
  814. #
  815. @register_model_view(ConfigContext, 'list', path='', detail=False)
  816. class ConfigContextListView(generic.ObjectListView):
  817. queryset = ConfigContext.objects.all()
  818. filterset = filtersets.ConfigContextFilterSet
  819. filterset_form = forms.ConfigContextFilterForm
  820. table = tables.ConfigContextTable
  821. actions = (AddObject, BulkSync, BulkEdit, BulkRename, BulkDelete)
  822. @register_model_view(ConfigContext)
  823. @method_decorator(never_cache, name='dispatch')
  824. class ConfigContextView(generic.ObjectView):
  825. queryset = ConfigContext.objects.all()
  826. template_name = 'generic/object.html'
  827. layout = layout.SimpleLayout(
  828. left_panels=[
  829. panels.ConfigContextPanel(),
  830. TemplatePanel('core/inc/datafile_panel.html'),
  831. panels.ConfigContextAssignmentPanel(),
  832. ],
  833. right_panels=[
  834. TemplatePanel('extras/panels/configcontext_data.html'),
  835. ],
  836. )
  837. def get_extra_context(self, request, instance):
  838. # Gather assigned objects for parsing in the template
  839. assigned_objects = (
  840. ('Regions', instance.regions.all),
  841. ('Site Groups', instance.site_groups.all),
  842. ('Sites', instance.sites.all),
  843. ('Locations', instance.locations.all),
  844. ('Device Types', instance.device_types.all),
  845. ('Roles', instance.roles.all),
  846. ('Platforms', instance.platforms.all),
  847. ('Cluster Types', instance.cluster_types.all),
  848. ('Cluster Groups', instance.cluster_groups.all),
  849. ('Clusters', instance.clusters.all),
  850. ('Tenant Groups', instance.tenant_groups.all),
  851. ('Tenants', instance.tenants.all),
  852. ('Tags', instance.tags.all),
  853. )
  854. # Determine user's preferred output format
  855. if request.GET.get('format') in ['json', 'yaml']:
  856. format = request.GET.get('format')
  857. if request.user.is_authenticated:
  858. request.user.config.set('data_format', format, commit=True)
  859. elif request.user.is_authenticated:
  860. format = request.user.config.get('data_format', 'json')
  861. else:
  862. format = 'json'
  863. return {
  864. 'assigned_objects': assigned_objects,
  865. 'format': format,
  866. }
  867. @register_model_view(ConfigContext, 'add', detail=False)
  868. @register_model_view(ConfigContext, 'edit')
  869. class ConfigContextEditView(generic.ObjectEditView):
  870. queryset = ConfigContext.objects.all()
  871. form = forms.ConfigContextForm
  872. @register_model_view(ConfigContext, 'delete')
  873. class ConfigContextDeleteView(generic.ObjectDeleteView):
  874. queryset = ConfigContext.objects.all()
  875. @register_model_view(ConfigContext, 'bulk_edit', path='edit', detail=False)
  876. class ConfigContextBulkEditView(generic.BulkEditView):
  877. queryset = ConfigContext.objects.all()
  878. filterset = filtersets.ConfigContextFilterSet
  879. table = tables.ConfigContextTable
  880. form = forms.ConfigContextBulkEditForm
  881. @register_model_view(ConfigContext, 'bulk_rename', path='rename', detail=False)
  882. class ConfigContextBulkRenameView(generic.BulkRenameView):
  883. queryset = ConfigContext.objects.all()
  884. filterset = filtersets.ConfigContextFilterSet
  885. @register_model_view(ConfigContext, 'bulk_delete', path='delete', detail=False)
  886. class ConfigContextBulkDeleteView(generic.BulkDeleteView):
  887. queryset = ConfigContext.objects.all()
  888. filterset = filtersets.ConfigContextFilterSet
  889. table = tables.ConfigContextTable
  890. @register_model_view(ConfigContext, 'bulk_sync', path='sync', detail=False)
  891. class ConfigContextBulkSyncDataView(generic.BulkSyncDataView):
  892. queryset = ConfigContext.objects.all()
  893. @method_decorator(never_cache, name='dispatch')
  894. class ObjectConfigContextView(generic.ObjectView):
  895. base_template = None
  896. template_name = 'extras/object_configcontext.html'
  897. def get_extra_context(self, request, instance):
  898. source_contexts = ConfigContext.objects.restrict(request.user, 'view').get_for_object(instance)
  899. # Determine user's preferred output format
  900. if request.GET.get('format') in ['json', 'yaml']:
  901. format = request.GET.get('format')
  902. if request.user.is_authenticated:
  903. request.user.config.set('data_format', format, commit=True)
  904. elif request.user.is_authenticated:
  905. format = request.user.config.get('data_format', 'json')
  906. else:
  907. format = 'json'
  908. return {
  909. 'rendered_context': instance.get_config_context(),
  910. 'source_contexts': source_contexts,
  911. 'format': format,
  912. 'base_template': self.base_template,
  913. }
  914. #
  915. # Config templates
  916. #
  917. @register_model_view(ConfigTemplate, 'list', path='', detail=False)
  918. class ConfigTemplateListView(generic.ObjectListView):
  919. queryset = ConfigTemplate.objects.annotate(
  920. device_count=count_related(Device, 'config_template'),
  921. vm_count=count_related(VirtualMachine, 'config_template'),
  922. role_count=count_related(DeviceRole, 'config_template'),
  923. platform_count=count_related(Platform, 'config_template'),
  924. )
  925. filterset = filtersets.ConfigTemplateFilterSet
  926. filterset_form = forms.ConfigTemplateFilterForm
  927. table = tables.ConfigTemplateTable
  928. actions = (AddObject, BulkImport, BulkExport, BulkSync, BulkEdit, BulkRename, BulkDelete)
  929. @register_model_view(ConfigTemplate)
  930. @method_decorator(never_cache, name='dispatch')
  931. class ConfigTemplateView(generic.ObjectView):
  932. queryset = ConfigTemplate.objects.all()
  933. template_name = 'generic/object.html'
  934. layout = layout.SimpleLayout(
  935. left_panels=[
  936. panels.ConfigTemplatePanel(),
  937. panels.TagsPanel(),
  938. ],
  939. right_panels=[
  940. JSONPanel('environment_params', title=_('Environment Parameters')),
  941. ],
  942. bottom_panels=[
  943. TextCodePanel('template_code', title=_('Template'), show_sync_warning=True),
  944. ],
  945. )
  946. @register_model_view(ConfigTemplate, 'add', detail=False)
  947. @register_model_view(ConfigTemplate, 'edit')
  948. class ConfigTemplateEditView(generic.ObjectEditView):
  949. queryset = ConfigTemplate.objects.all()
  950. form = forms.ConfigTemplateForm
  951. @register_model_view(ConfigTemplate, 'delete')
  952. class ConfigTemplateDeleteView(generic.ObjectDeleteView):
  953. queryset = ConfigTemplate.objects.all()
  954. @register_model_view(ConfigTemplate, 'bulk_import', path='import', detail=False)
  955. class ConfigTemplateBulkImportView(generic.BulkImportView):
  956. queryset = ConfigTemplate.objects.all()
  957. model_form = forms.ConfigTemplateImportForm
  958. @register_model_view(ConfigTemplate, 'bulk_edit', path='edit', detail=False)
  959. class ConfigTemplateBulkEditView(generic.BulkEditView):
  960. queryset = ConfigTemplate.objects.all()
  961. filterset = filtersets.ConfigTemplateFilterSet
  962. table = tables.ConfigTemplateTable
  963. form = forms.ConfigTemplateBulkEditForm
  964. @register_model_view(ConfigTemplate, 'bulk_rename', path='rename', detail=False)
  965. class ConfigTemplateBulkRenameView(generic.BulkRenameView):
  966. queryset = ConfigTemplate.objects.all()
  967. filterset = filtersets.ConfigTemplateFilterSet
  968. @register_model_view(ConfigTemplate, 'bulk_delete', path='delete', detail=False)
  969. class ConfigTemplateBulkDeleteView(generic.BulkDeleteView):
  970. queryset = ConfigTemplate.objects.all()
  971. filterset = filtersets.ConfigTemplateFilterSet
  972. table = tables.ConfigTemplateTable
  973. @register_model_view(ConfigTemplate, 'bulk_sync', path='sync', detail=False)
  974. class ConfigTemplateBulkSyncDataView(generic.BulkSyncDataView):
  975. queryset = ConfigTemplate.objects.all()
  976. @method_decorator(never_cache, name='dispatch')
  977. class ObjectRenderConfigView(generic.ObjectView):
  978. base_template = None
  979. template_name = 'extras/object_render_config.html'
  980. def get(self, request, **kwargs):
  981. instance = self.get_object(**kwargs)
  982. context = self.get_extra_context(request, instance)
  983. # If a direct export has been requested, return the rendered template content as a
  984. # downloadable file.
  985. if request.GET.get('export'):
  986. content = context['rendered_config'] or context['error_message']
  987. response = HttpResponse(content, content_type='text')
  988. filename = f"{instance.name or 'config'}.txt"
  989. response['Content-Disposition'] = content_disposition_header(as_attachment=True, filename=filename)
  990. return response
  991. return render(
  992. request,
  993. self.get_template_name(),
  994. {
  995. 'object': instance,
  996. 'tab': self.tab,
  997. **context,
  998. },
  999. )
  1000. def get_extra_context_data(self, request, instance):
  1001. return {
  1002. f'{instance._meta.model_name}': instance,
  1003. }
  1004. def get_extra_context(self, request, instance):
  1005. # Compile context data
  1006. context_data = instance.get_config_context()
  1007. context_data.update(self.get_extra_context_data(request, instance))
  1008. # Check for an optional config_template_id override in the query params
  1009. config_template = None
  1010. error_message = ''
  1011. if config_template_id := request.GET.get('config_template_id'):
  1012. try:
  1013. config_template = ConfigTemplate.objects.restrict(request.user, 'view').get(pk=config_template_id)
  1014. except (ConfigTemplate.DoesNotExist, ValueError):
  1015. error_message = _("Config template with ID {id} not found.").format(id=config_template_id)
  1016. else:
  1017. config_template = instance.get_config_template()
  1018. # Render the config template
  1019. rendered_config = None
  1020. if config_template:
  1021. try:
  1022. rendered_config = config_template.render(context=context_data)
  1023. except Exception as e:
  1024. error_message = config_template.format_render_error(e)
  1025. return {
  1026. 'base_template': self.base_template,
  1027. 'config_template': config_template,
  1028. 'context_data': context_data,
  1029. 'rendered_config': rendered_config,
  1030. 'error_message': error_message,
  1031. }
  1032. #
  1033. # Image attachments
  1034. #
  1035. @register_model_view(ImageAttachment, 'list', path='', detail=False)
  1036. class ImageAttachmentListView(generic.ObjectListView):
  1037. queryset = ImageAttachment.objects.all()
  1038. filterset = filtersets.ImageAttachmentFilterSet
  1039. filterset_form = forms.ImageAttachmentFilterForm
  1040. table = tables.ImageAttachmentTable
  1041. actions = (BulkExport, BulkEdit, BulkRename, BulkDelete)
  1042. @register_model_view(ImageAttachment)
  1043. class ImageAttachmentView(generic.ObjectView):
  1044. queryset = ImageAttachment.objects.all()
  1045. template_name = 'generic/object.html'
  1046. layout = layout.SimpleLayout(
  1047. left_panels=[
  1048. panels.ImageAttachmentPanel(),
  1049. ],
  1050. right_panels=[
  1051. panels.ImageAttachmentFilePanel(),
  1052. ],
  1053. bottom_panels=[
  1054. panels.ImageAttachmentImagePanel(),
  1055. ],
  1056. )
  1057. @register_model_view(ImageAttachment, 'add', detail=False)
  1058. @register_model_view(ImageAttachment, 'edit')
  1059. class ImageAttachmentEditView(generic.ObjectEditView):
  1060. queryset = ImageAttachment.objects.all()
  1061. form = forms.ImageAttachmentForm
  1062. def alter_object(self, instance, request, args, kwargs):
  1063. if not instance.pk:
  1064. # Assign the parent object based on URL kwargs
  1065. object_type = get_object_or_404(ContentType, pk=request.GET.get('object_type'))
  1066. instance.parent = get_object_or_404(object_type.model_class(), pk=request.GET.get('object_id'))
  1067. return instance
  1068. def get_extra_addanother_params(self, request):
  1069. return {
  1070. 'object_type': request.GET.get('object_type'),
  1071. 'object_id': request.GET.get('object_id'),
  1072. }
  1073. @register_model_view(ImageAttachment, 'delete')
  1074. class ImageAttachmentDeleteView(generic.ObjectDeleteView):
  1075. queryset = ImageAttachment.objects.all()
  1076. @register_model_view(ImageAttachment, 'bulk_edit', path='edit', detail=False)
  1077. class ImageAttachmentBulkEditView(generic.BulkEditView):
  1078. queryset = ImageAttachment.objects.all()
  1079. filterset = filtersets.ImageAttachmentFilterSet
  1080. table = tables.ImageAttachmentTable
  1081. form = forms.ImageAttachmentBulkEditForm
  1082. @register_model_view(ImageAttachment, 'bulk_rename', path='rename', detail=False)
  1083. class ImageAttachmentBulkRenameView(generic.BulkRenameView):
  1084. queryset = ImageAttachment.objects.all()
  1085. filterset = filtersets.ImageAttachmentFilterSet
  1086. @register_model_view(ImageAttachment, 'bulk_delete', path='delete', detail=False)
  1087. class ImageAttachmentBulkDeleteView(generic.BulkDeleteView):
  1088. queryset = ImageAttachment.objects.all()
  1089. filterset = filtersets.ImageAttachmentFilterSet
  1090. table = tables.ImageAttachmentTable
  1091. #
  1092. # Journal entries
  1093. #
  1094. @register_model_view(JournalEntry, 'list', path='', detail=False)
  1095. class JournalEntryListView(generic.ObjectListView):
  1096. queryset = JournalEntry.objects.all()
  1097. filterset = filtersets.JournalEntryFilterSet
  1098. filterset_form = forms.JournalEntryFilterForm
  1099. table = tables.JournalEntryTable
  1100. actions = (BulkImport, BulkEdit, BulkDelete)
  1101. @register_model_view(JournalEntry)
  1102. class JournalEntryView(generic.ObjectView):
  1103. queryset = JournalEntry.objects.all()
  1104. layout = layout.SimpleLayout(
  1105. left_panels=[
  1106. panels.JournalEntryPanel(),
  1107. panels.CustomFieldsPanel(),
  1108. panels.TagsPanel(),
  1109. ],
  1110. right_panels=[
  1111. CommentsPanel(),
  1112. ],
  1113. )
  1114. @register_model_view(JournalEntry, 'add', detail=False)
  1115. @register_model_view(JournalEntry, 'edit')
  1116. class JournalEntryEditView(generic.ObjectEditView):
  1117. queryset = JournalEntry.objects.all()
  1118. form = forms.JournalEntryForm
  1119. def alter_object(self, obj, request, args, kwargs):
  1120. if not obj.pk:
  1121. obj.created_by = request.user
  1122. return obj
  1123. def get_return_url(self, request, instance):
  1124. if not instance.assigned_object:
  1125. return reverse('extras:journalentry_list')
  1126. obj = instance.assigned_object
  1127. return get_action_url(obj, action='journal', kwargs={'pk': obj.pk})
  1128. @register_model_view(JournalEntry, 'delete')
  1129. class JournalEntryDeleteView(generic.ObjectDeleteView):
  1130. queryset = JournalEntry.objects.all()
  1131. def get_return_url(self, request, instance):
  1132. obj = instance.assigned_object
  1133. return get_action_url(obj, action='journal', kwargs={'pk': obj.pk})
  1134. @register_model_view(JournalEntry, 'bulk_import', path='import', detail=False)
  1135. class JournalEntryBulkImportView(generic.BulkImportView):
  1136. queryset = JournalEntry.objects.all()
  1137. model_form = forms.JournalEntryImportForm
  1138. @register_model_view(JournalEntry, 'bulk_edit', path='edit', detail=False)
  1139. class JournalEntryBulkEditView(generic.BulkEditView):
  1140. queryset = JournalEntry.objects.all()
  1141. filterset = filtersets.JournalEntryFilterSet
  1142. table = tables.JournalEntryTable
  1143. form = forms.JournalEntryBulkEditForm
  1144. @register_model_view(JournalEntry, 'bulk_delete', path='delete', detail=False)
  1145. class JournalEntryBulkDeleteView(generic.BulkDeleteView):
  1146. queryset = JournalEntry.objects.all()
  1147. filterset = filtersets.JournalEntryFilterSet
  1148. table = tables.JournalEntryTable
  1149. #
  1150. # Dashboard & widgets
  1151. #
  1152. class DashboardResetView(LoginRequiredMixin, View):
  1153. template_name = 'extras/dashboard/reset.html'
  1154. def get(self, request):
  1155. get_object_or_404(Dashboard.objects.all(), user=request.user)
  1156. form = ConfirmationForm()
  1157. return render(request, self.template_name, {
  1158. 'form': form,
  1159. 'return_url': reverse('home'),
  1160. })
  1161. def post(self, request):
  1162. dashboard = get_object_or_404(Dashboard.objects.all(), user=request.user)
  1163. form = ConfirmationForm(request.POST)
  1164. if form.is_valid():
  1165. dashboard.delete()
  1166. messages.success(request, _("Your dashboard has been reset."))
  1167. return redirect(reverse('home'))
  1168. return render(request, self.template_name, {
  1169. 'form': form,
  1170. 'return_url': reverse('home'),
  1171. })
  1172. class DashboardWidgetAddView(LoginRequiredMixin, View):
  1173. template_name = 'extras/dashboard/widget_add.html'
  1174. def get(self, request):
  1175. if not request.htmx:
  1176. return redirect('home')
  1177. initial = {
  1178. 'widget_class': request.GET.get('widget_class') or 'extras.NoteWidget',
  1179. }
  1180. widget_form = DashboardWidgetAddForm(initial=initial)
  1181. widget_name = get_field_value(widget_form, 'widget_class')
  1182. widget_class = get_widget_class(widget_name)
  1183. config_form = widget_class.ConfigForm(initial=widget_class.default_config, prefix='config')
  1184. return render(request, self.template_name, {
  1185. 'widget_class': widget_class,
  1186. 'widget_form': widget_form,
  1187. 'config_form': config_form,
  1188. })
  1189. def post(self, request):
  1190. widget_form = DashboardWidgetAddForm(request.POST)
  1191. config_form = None
  1192. widget_class = None
  1193. if widget_form.is_valid():
  1194. widget_class = get_widget_class(widget_form.cleaned_data['widget_class'])
  1195. config_form = widget_class.ConfigForm(request.POST, prefix='config')
  1196. if config_form.is_valid():
  1197. data = widget_form.cleaned_data
  1198. data.pop('widget_class')
  1199. data['config'] = config_form.cleaned_data
  1200. widget = widget_class(**data)
  1201. request.user.dashboard.add_widget(widget)
  1202. request.user.dashboard.save()
  1203. messages.success(request, _('Added widget: ') + str(widget.id))
  1204. return HttpResponse(headers={
  1205. 'HX-Redirect': reverse('home'),
  1206. })
  1207. return render(request, self.template_name, {
  1208. 'widget_class': widget_class,
  1209. 'widget_form': widget_form,
  1210. 'config_form': config_form,
  1211. })
  1212. class DashboardWidgetConfigView(LoginRequiredMixin, View):
  1213. template_name = 'extras/dashboard/widget_config.html'
  1214. def get(self, request, id):
  1215. if not request.htmx:
  1216. return redirect('home')
  1217. widget = request.user.dashboard.get_widget(id)
  1218. widget_form = DashboardWidgetForm(initial=widget.form_data)
  1219. config_form = widget.ConfigForm(initial=widget.form_data.get('config'), prefix='config')
  1220. return render(request, self.template_name, {
  1221. 'widget_class': widget.__class__,
  1222. 'widget_form': widget_form,
  1223. 'config_form': config_form,
  1224. 'form_url': reverse('extras:dashboardwidget_config', kwargs={'id': id})
  1225. })
  1226. def post(self, request, id):
  1227. widget = request.user.dashboard.get_widget(id)
  1228. widget_form = DashboardWidgetForm(request.POST)
  1229. config_form = widget.ConfigForm(request.POST, prefix='config')
  1230. if widget_form.is_valid() and config_form.is_valid():
  1231. data = widget_form.cleaned_data
  1232. data['config'] = config_form.cleaned_data
  1233. request.user.dashboard.config[str(id)].update(data)
  1234. request.user.dashboard.save()
  1235. messages.success(request, _('Updated widget: ') + str(widget.id))
  1236. return HttpResponse(headers={
  1237. 'HX-Redirect': reverse('home'),
  1238. })
  1239. return render(request, self.template_name, {
  1240. 'widget_form': widget_form,
  1241. 'config_form': config_form,
  1242. 'form_url': reverse('extras:dashboardwidget_config', kwargs={'id': id})
  1243. })
  1244. class DashboardWidgetDeleteView(LoginRequiredMixin, View):
  1245. template_name = 'generic/object_delete.html'
  1246. def get(self, request, id):
  1247. if not request.htmx:
  1248. return redirect('home')
  1249. widget = request.user.dashboard.get_widget(id)
  1250. form = ConfirmationForm(initial=request.GET)
  1251. return render(request, 'htmx/delete_form.html', {
  1252. 'object_type': widget.__class__.__name__,
  1253. 'object': widget,
  1254. 'form': form,
  1255. 'form_url': reverse('extras:dashboardwidget_delete', kwargs={'id': id})
  1256. })
  1257. def post(self, request, id):
  1258. form = ConfirmationForm(request.POST)
  1259. if form.is_valid():
  1260. request.user.dashboard.delete_widget(id)
  1261. request.user.dashboard.save()
  1262. messages.success(request, _('Deleted widget: ') + str(id))
  1263. else:
  1264. messages.error(request, _('Error deleting widget: ') + str(form.errors[0]))
  1265. return redirect(reverse('home'))
  1266. #
  1267. # Scripts
  1268. #
  1269. @register_model_view(ScriptModule, 'edit')
  1270. class ScriptModuleCreateView(generic.ObjectEditView):
  1271. queryset = ScriptModule.objects.all()
  1272. form = forms.ScriptFileForm
  1273. default_return_url = 'extras:script_list'
  1274. def alter_object(self, obj, *args, **kwargs):
  1275. obj.file_root = ManagedFileRootPathChoices.SCRIPTS
  1276. return obj
  1277. @register_model_view(ScriptModule, 'delete')
  1278. class ScriptModuleDeleteView(generic.ObjectDeleteView):
  1279. queryset = ScriptModule.objects.all()
  1280. default_return_url = 'extras:script_list'
  1281. class ScriptListView(ContentTypePermissionRequiredMixin, View):
  1282. def get_required_permission(self):
  1283. return 'extras.view_script'
  1284. def get(self, request):
  1285. available_scripts = Script.objects.restrict(request.user)
  1286. module_ids = {s.module_id for s in available_scripts}
  1287. script_modules = ScriptModule.objects.restrict(request.user).filter(pk__in=module_ids).prefetch_related(
  1288. 'data_source', 'data_file',
  1289. )
  1290. # Find the most recent completed Job for each Script which the user is permitted to view
  1291. latest_jobs = {
  1292. script.pk: script.get_latest_jobs().restrict(request.user, 'view').first()
  1293. for script in available_scripts
  1294. }
  1295. context = {
  1296. 'model': ScriptModule,
  1297. 'script_modules': script_modules,
  1298. 'available_scripts': available_scripts,
  1299. 'latest_jobs': latest_jobs,
  1300. }
  1301. # Use partial template for dashboard widgets
  1302. template_name = 'extras/script_list.html'
  1303. if request.GET.get('embedded'):
  1304. template_name = 'extras/inc/script_list_content.html'
  1305. context['embedded'] = True
  1306. return render(request, template_name, context)
  1307. class BaseScriptView(generic.ObjectView):
  1308. queryset = Script.objects.all()
  1309. def get_object(self, **kwargs):
  1310. if pk := kwargs.get('pk', False):
  1311. return get_object_or_404(self.queryset, pk=pk)
  1312. if (module := kwargs.get('module')) and (name := kwargs.get('name', False)):
  1313. return get_object_or_404(self.queryset, module__file_path=f'{module}.py', name=name)
  1314. raise Http404
  1315. def _get_script_class(self, script):
  1316. """
  1317. Return an instance of the Script's Python class
  1318. """
  1319. if script_class := script.python_class:
  1320. return script_class()
  1321. return None
  1322. class ScriptView(BaseScriptView):
  1323. def get(self, request, **kwargs):
  1324. script = self.get_object(**kwargs)
  1325. script_class = self._get_script_class(script)
  1326. if not script_class:
  1327. return render(request, 'extras/script.html', {
  1328. 'object': script,
  1329. 'script': script,
  1330. })
  1331. form = script_class.as_form(initial=normalize_querydict(request.GET))
  1332. return render(request, 'extras/script.html', {
  1333. 'object': script,
  1334. 'script': script,
  1335. 'script_class': script_class,
  1336. 'form': form,
  1337. 'job_count': script.jobs.restrict(request.user, 'view').count(),
  1338. })
  1339. def post(self, request, **kwargs):
  1340. script = self.get_object(**kwargs)
  1341. if not request.user.has_perm('extras.run_script', obj=script):
  1342. return HttpResponseForbidden()
  1343. script_class = self._get_script_class(script)
  1344. if not script_class:
  1345. return render(request, 'extras/script.html', {
  1346. 'object': script,
  1347. 'script': script,
  1348. })
  1349. form = prepare_script_form(script_class, request.POST, request.FILES)
  1350. # Allow execution only if RQ worker process is running
  1351. if not any_workers_for_queue('default'):
  1352. messages.error(request, _("Unable to run script: RQ worker process not running."))
  1353. elif form.is_valid():
  1354. ScriptJob = import_string("extras.jobs.ScriptJob")
  1355. try:
  1356. job = ScriptJob.enqueue(
  1357. instance=script,
  1358. user=request.user,
  1359. schedule_at=form.cleaned_data.pop('_schedule_at'),
  1360. interval=form.cleaned_data.pop('_interval'),
  1361. notifications=form.cleaned_data.pop('_notifications'),
  1362. data=form.cleaned_data,
  1363. request=copy_safe_request(request),
  1364. job_timeout=script.python_class.job_timeout,
  1365. commit=form.cleaned_data.pop('_commit'),
  1366. )
  1367. except ValidationError as e:
  1368. # The script's Meta configuration is invalid (see #22872). Surface it as a form error rather than
  1369. # allowing the exception to bubble up as an HTTP 500.
  1370. for msg in e.messages:
  1371. messages.error(request, _("Unable to run script: {error}").format(error=msg))
  1372. else:
  1373. return redirect('extras:script_result', job_pk=job.pk)
  1374. else:
  1375. fieldset_fields = {field for _, fields in script_class.get_fieldsets() for field in fields}
  1376. hidden_errors = {
  1377. field: errors for field, errors in form.errors.items()
  1378. if field not in fieldset_fields
  1379. }
  1380. if hidden_errors:
  1381. error_msg = '; '.join(f"{field}: {', '.join(errors)}" for field, errors in hidden_errors.items())
  1382. messages.error(request, error_msg)
  1383. return render(request, 'extras/script.html', {
  1384. 'object': script,
  1385. 'script': script,
  1386. 'script_class': script.python_class(),
  1387. 'form': form,
  1388. 'job_count': script.jobs.restrict(request.user, 'view').count(),
  1389. })
  1390. class ScriptSourceView(BaseScriptView):
  1391. queryset = Script.objects.all()
  1392. def get(self, request, **kwargs):
  1393. script = self.get_object(**kwargs)
  1394. script_class = self._get_script_class(script)
  1395. return render(request, 'extras/script/source.html', {
  1396. 'script': script,
  1397. 'script_class': script_class,
  1398. 'job_count': script.jobs.restrict(request.user, 'view').count(),
  1399. 'tab': 'source',
  1400. })
  1401. class ScriptJobsView(BaseScriptView):
  1402. queryset = Script.objects.all()
  1403. def get(self, request, **kwargs):
  1404. script = self.get_object(**kwargs)
  1405. jobs = script.jobs.restrict(request.user, 'view')
  1406. jobs_table = ScriptJobTable(data=jobs, orderable=False)
  1407. jobs_table.configure(request)
  1408. return render(request, 'extras/script/jobs.html', {
  1409. 'script': script,
  1410. 'table': jobs_table,
  1411. 'job_count': jobs.count(),
  1412. 'tab': 'jobs',
  1413. })
  1414. class ScriptResultView(TableMixin, generic.ObjectView):
  1415. queryset = Job.objects.all()
  1416. def get_required_permission(self):
  1417. return 'extras.view_script'
  1418. def get_queryset(self, request):
  1419. return Job.objects.restrict(request.user, 'view')
  1420. def get_table(self, job, request, bulk_actions=True):
  1421. data = []
  1422. tests = None
  1423. table = None
  1424. index = 0
  1425. try:
  1426. log_threshold = LOG_LEVEL_RANK[request.GET.get('log_threshold', LogLevelChoices.LOG_INFO)]
  1427. except KeyError:
  1428. log_threshold = LOG_LEVEL_RANK[LogLevelChoices.LOG_INFO]
  1429. if job.data:
  1430. if 'log' in job.data:
  1431. if 'tests' in job.data:
  1432. tests = job.data['tests']
  1433. for log in job.data['log']:
  1434. log_level = LOG_LEVEL_RANK.get(log.get('status'), LogLevelChoices.LOG_INFO)
  1435. if log_level >= log_threshold:
  1436. index += 1
  1437. result = {
  1438. 'index': index,
  1439. 'time': datetime.fromisoformat(log.get('time')),
  1440. 'status': log.get('status'),
  1441. 'message': log.get('message'),
  1442. 'object': log.get('obj'),
  1443. 'url': log.get('url'),
  1444. }
  1445. data.append(result)
  1446. table = ScriptResultsTable(data)
  1447. table.configure(request)
  1448. else:
  1449. # for legacy reports
  1450. tests = job.data
  1451. if tests:
  1452. for method, test_data in tests.items():
  1453. if 'log' in test_data:
  1454. for time, status, obj, url, message in test_data['log']:
  1455. log_level = LOG_LEVEL_RANK.get(status, LogLevelChoices.LOG_INFO)
  1456. if log_level >= log_threshold:
  1457. index += 1
  1458. result = {
  1459. 'index': index,
  1460. 'method': method,
  1461. 'time': time,
  1462. 'status': status,
  1463. 'object': obj,
  1464. 'url': url,
  1465. 'message': message,
  1466. }
  1467. data.append(result)
  1468. table = ReportResultsTable(data)
  1469. table.configure(request)
  1470. return table
  1471. def get(self, request, **kwargs):
  1472. table = None
  1473. job = get_object_or_404(self.queryset, pk=kwargs.get('job_pk'))
  1474. # If a direct export output has been requested, return the job data content as a
  1475. # downloadable file.
  1476. if job.completed and request.GET.get('export') == 'output':
  1477. content = (job.data.get("output") or "").encode()
  1478. response = HttpResponse(content, content_type='text')
  1479. filename = f"{job.object.name or 'script-output'}_{job.completed.strftime('%Y-%m-%d_%H%M%S')}.txt"
  1480. response['Content-Disposition'] = content_disposition_header(as_attachment=True, filename=filename)
  1481. return response
  1482. if job.completed:
  1483. table = self.get_table(job, request, bulk_actions=False)
  1484. log_threshold = request.GET.get('log_threshold', LogLevelChoices.LOG_INFO)
  1485. if log_threshold not in LOG_LEVEL_RANK:
  1486. log_threshold = LogLevelChoices.LOG_INFO
  1487. context = {
  1488. 'script': job.object,
  1489. 'job': job,
  1490. 'table': table,
  1491. 'log_levels': dict(LogLevelChoices),
  1492. 'log_threshold': log_threshold,
  1493. }
  1494. if job.data and 'log' in job.data:
  1495. # Script
  1496. context['tests'] = job.data.get('tests', {})
  1497. elif job.data:
  1498. # Legacy Report
  1499. context['tests'] = {
  1500. name: data for name, data in job.data.items()
  1501. if name.startswith('test_')
  1502. }
  1503. # If this is an HTMX request, return only the result HTML
  1504. if htmx_partial(request):
  1505. if request.GET.get('log'):
  1506. # If log=True, render only the log table
  1507. return render(request, 'htmx/table.html', context)
  1508. response = render(request, 'extras/htmx/script_result.html', context)
  1509. if job.completed or not job.started:
  1510. response.status_code = 286
  1511. return response
  1512. return render(request, 'extras/script_result.html', context)
  1513. #
  1514. # Markdown
  1515. #
  1516. class RenderMarkdownView(LoginRequiredMixin, View):
  1517. def post(self, request):
  1518. form = forms.RenderMarkdownForm(request.POST)
  1519. if not form.is_valid():
  1520. HttpResponseBadRequest()
  1521. rendered = render_markdown(form.cleaned_data['text'])
  1522. return HttpResponse(rendered)