views.py 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573
  1. from django.contrib import messages
  2. from django.contrib.auth.mixins import LoginRequiredMixin
  3. from django.contrib.contenttypes.models import ContentType
  4. from django.core.paginator import EmptyPage
  5. from django.db.models import Count, Q
  6. from django.http import HttpResponseBadRequest, HttpResponseForbidden, HttpResponse
  7. from django.shortcuts import get_object_or_404, redirect, render
  8. from django.urls import reverse
  9. from django.utils import timezone
  10. from django.utils.module_loading import import_string
  11. from django.utils.translation import gettext as _
  12. from django.views.generic import View
  13. from jinja2.exceptions import TemplateError
  14. from core.choices import ManagedFileRootPathChoices
  15. from core.models import Job
  16. from core.object_actions import BulkSync
  17. from dcim.models import Device, DeviceRole, Platform
  18. from extras.choices import LogLevelChoices
  19. from extras.dashboard.forms import DashboardWidgetAddForm, DashboardWidgetForm
  20. from extras.dashboard.utils import get_widget_class
  21. from extras.utils import SharedObjectViewMixin
  22. from netbox.object_actions import *
  23. from netbox.views import generic
  24. from netbox.views.generic.mixins import TableMixin
  25. from utilities.forms import ConfirmationForm, get_field_value
  26. from utilities.htmx import htmx_partial
  27. from utilities.paginator import EnhancedPaginator, get_paginate_count
  28. from utilities.query import count_related
  29. from utilities.querydict import normalize_querydict
  30. from utilities.request import copy_safe_request
  31. from utilities.rqworker import get_workers_for_queue
  32. from utilities.templatetags.builtins.filters import render_markdown
  33. from utilities.views import ContentTypePermissionRequiredMixin, get_action_url, register_model_view
  34. from virtualization.models import VirtualMachine
  35. from . import filtersets, forms, tables
  36. from .constants import LOG_LEVEL_RANK
  37. from .models import *
  38. from .tables import ReportResultsTable, ScriptResultsTable, ScriptJobTable
  39. #
  40. # Custom fields
  41. #
  42. @register_model_view(CustomField, 'list', path='', detail=False)
  43. class CustomFieldListView(generic.ObjectListView):
  44. queryset = CustomField.objects.select_related('choice_set')
  45. filterset = filtersets.CustomFieldFilterSet
  46. filterset_form = forms.CustomFieldFilterForm
  47. table = tables.CustomFieldTable
  48. @register_model_view(CustomField)
  49. class CustomFieldView(generic.ObjectView):
  50. queryset = CustomField.objects.select_related('choice_set')
  51. def get_extra_context(self, request, instance):
  52. related_models = ()
  53. for object_type in instance.object_types.all():
  54. related_models += (
  55. object_type.model_class().objects.restrict(request.user, 'view').exclude(
  56. Q(**{f'custom_field_data__{instance.name}': ''}) |
  57. Q(**{f'custom_field_data__{instance.name}': None})
  58. ),
  59. )
  60. return {
  61. 'related_models': related_models
  62. }
  63. @register_model_view(CustomField, 'add', detail=False)
  64. @register_model_view(CustomField, 'edit')
  65. class CustomFieldEditView(generic.ObjectEditView):
  66. queryset = CustomField.objects.select_related('choice_set')
  67. form = forms.CustomFieldForm
  68. @register_model_view(CustomField, 'delete')
  69. class CustomFieldDeleteView(generic.ObjectDeleteView):
  70. queryset = CustomField.objects.select_related('choice_set')
  71. @register_model_view(CustomField, 'bulk_import', path='import', detail=False)
  72. class CustomFieldBulkImportView(generic.BulkImportView):
  73. queryset = CustomField.objects.select_related('choice_set')
  74. model_form = forms.CustomFieldImportForm
  75. @register_model_view(CustomField, 'bulk_edit', path='edit', detail=False)
  76. class CustomFieldBulkEditView(generic.BulkEditView):
  77. queryset = CustomField.objects.select_related('choice_set')
  78. filterset = filtersets.CustomFieldFilterSet
  79. table = tables.CustomFieldTable
  80. form = forms.CustomFieldBulkEditForm
  81. @register_model_view(CustomField, 'bulk_rename', path='rename', detail=False)
  82. class CustomFieldBulkRenameView(generic.BulkRenameView):
  83. queryset = CustomField.objects.all()
  84. @register_model_view(CustomField, 'bulk_delete', path='delete', detail=False)
  85. class CustomFieldBulkDeleteView(generic.BulkDeleteView):
  86. queryset = CustomField.objects.select_related('choice_set')
  87. filterset = filtersets.CustomFieldFilterSet
  88. table = tables.CustomFieldTable
  89. #
  90. # Custom field choices
  91. #
  92. @register_model_view(CustomFieldChoiceSet, 'list', path='', detail=False)
  93. class CustomFieldChoiceSetListView(generic.ObjectListView):
  94. queryset = CustomFieldChoiceSet.objects.all()
  95. filterset = filtersets.CustomFieldChoiceSetFilterSet
  96. filterset_form = forms.CustomFieldChoiceSetFilterForm
  97. table = tables.CustomFieldChoiceSetTable
  98. @register_model_view(CustomFieldChoiceSet)
  99. class CustomFieldChoiceSetView(generic.ObjectView):
  100. queryset = CustomFieldChoiceSet.objects.all()
  101. def get_extra_context(self, request, instance):
  102. # Paginate choices list
  103. per_page = get_paginate_count(request)
  104. try:
  105. page_number = request.GET.get('page', 1)
  106. except ValueError:
  107. page_number = 1
  108. paginator = EnhancedPaginator(instance.choices, per_page)
  109. try:
  110. choices = paginator.page(page_number)
  111. except EmptyPage:
  112. choices = paginator.page(paginator.num_pages)
  113. return {
  114. 'paginator': paginator,
  115. 'choices': choices,
  116. }
  117. @register_model_view(CustomFieldChoiceSet, 'add', detail=False)
  118. @register_model_view(CustomFieldChoiceSet, 'edit')
  119. class CustomFieldChoiceSetEditView(generic.ObjectEditView):
  120. queryset = CustomFieldChoiceSet.objects.all()
  121. form = forms.CustomFieldChoiceSetForm
  122. @register_model_view(CustomFieldChoiceSet, 'delete')
  123. class CustomFieldChoiceSetDeleteView(generic.ObjectDeleteView):
  124. queryset = CustomFieldChoiceSet.objects.all()
  125. @register_model_view(CustomFieldChoiceSet, 'bulk_import', path='import', detail=False)
  126. class CustomFieldChoiceSetBulkImportView(generic.BulkImportView):
  127. queryset = CustomFieldChoiceSet.objects.all()
  128. model_form = forms.CustomFieldChoiceSetImportForm
  129. @register_model_view(CustomFieldChoiceSet, 'bulk_edit', path='edit', detail=False)
  130. class CustomFieldChoiceSetBulkEditView(generic.BulkEditView):
  131. queryset = CustomFieldChoiceSet.objects.all()
  132. filterset = filtersets.CustomFieldChoiceSetFilterSet
  133. table = tables.CustomFieldChoiceSetTable
  134. form = forms.CustomFieldChoiceSetBulkEditForm
  135. @register_model_view(CustomFieldChoiceSet, 'bulk_rename', path='rename', detail=False)
  136. class CustomFieldChoiceSetBulkRenameView(generic.BulkRenameView):
  137. queryset = CustomFieldChoiceSet.objects.all()
  138. @register_model_view(CustomFieldChoiceSet, 'bulk_delete', path='delete', detail=False)
  139. class CustomFieldChoiceSetBulkDeleteView(generic.BulkDeleteView):
  140. queryset = CustomFieldChoiceSet.objects.all()
  141. filterset = filtersets.CustomFieldChoiceSetFilterSet
  142. table = tables.CustomFieldChoiceSetTable
  143. #
  144. # Custom links
  145. #
  146. @register_model_view(CustomLink, 'list', path='', detail=False)
  147. class CustomLinkListView(generic.ObjectListView):
  148. queryset = CustomLink.objects.all()
  149. filterset = filtersets.CustomLinkFilterSet
  150. filterset_form = forms.CustomLinkFilterForm
  151. table = tables.CustomLinkTable
  152. @register_model_view(CustomLink)
  153. class CustomLinkView(generic.ObjectView):
  154. queryset = CustomLink.objects.all()
  155. @register_model_view(CustomLink, 'add', detail=False)
  156. @register_model_view(CustomLink, 'edit')
  157. class CustomLinkEditView(generic.ObjectEditView):
  158. queryset = CustomLink.objects.all()
  159. form = forms.CustomLinkForm
  160. @register_model_view(CustomLink, 'delete')
  161. class CustomLinkDeleteView(generic.ObjectDeleteView):
  162. queryset = CustomLink.objects.all()
  163. @register_model_view(CustomLink, 'bulk_import', path='import', detail=False)
  164. class CustomLinkBulkImportView(generic.BulkImportView):
  165. queryset = CustomLink.objects.all()
  166. model_form = forms.CustomLinkImportForm
  167. @register_model_view(CustomLink, 'bulk_edit', path='edit', detail=False)
  168. class CustomLinkBulkEditView(generic.BulkEditView):
  169. queryset = CustomLink.objects.all()
  170. filterset = filtersets.CustomLinkFilterSet
  171. table = tables.CustomLinkTable
  172. form = forms.CustomLinkBulkEditForm
  173. @register_model_view(CustomLink, 'bulk_rename', path='rename', detail=False)
  174. class CustomLinkBulkRenameView(generic.BulkRenameView):
  175. queryset = CustomLink.objects.all()
  176. @register_model_view(CustomLink, 'bulk_delete', path='delete', detail=False)
  177. class CustomLinkBulkDeleteView(generic.BulkDeleteView):
  178. queryset = CustomLink.objects.all()
  179. filterset = filtersets.CustomLinkFilterSet
  180. table = tables.CustomLinkTable
  181. #
  182. # Export templates
  183. #
  184. @register_model_view(ExportTemplate, 'list', path='', detail=False)
  185. class ExportTemplateListView(generic.ObjectListView):
  186. queryset = ExportTemplate.objects.all()
  187. filterset = filtersets.ExportTemplateFilterSet
  188. filterset_form = forms.ExportTemplateFilterForm
  189. table = tables.ExportTemplateTable
  190. actions = (AddObject, BulkImport, BulkSync, BulkExport, BulkEdit, BulkRename, BulkDelete)
  191. @register_model_view(ExportTemplate)
  192. class ExportTemplateView(generic.ObjectView):
  193. queryset = ExportTemplate.objects.all()
  194. @register_model_view(ExportTemplate, 'add', detail=False)
  195. @register_model_view(ExportTemplate, 'edit')
  196. class ExportTemplateEditView(generic.ObjectEditView):
  197. queryset = ExportTemplate.objects.all()
  198. form = forms.ExportTemplateForm
  199. @register_model_view(ExportTemplate, 'delete')
  200. class ExportTemplateDeleteView(generic.ObjectDeleteView):
  201. queryset = ExportTemplate.objects.all()
  202. @register_model_view(ExportTemplate, 'bulk_import', path='import', detail=False)
  203. class ExportTemplateBulkImportView(generic.BulkImportView):
  204. queryset = ExportTemplate.objects.all()
  205. model_form = forms.ExportTemplateImportForm
  206. @register_model_view(ExportTemplate, 'bulk_edit', path='edit', detail=False)
  207. class ExportTemplateBulkEditView(generic.BulkEditView):
  208. queryset = ExportTemplate.objects.all()
  209. filterset = filtersets.ExportTemplateFilterSet
  210. table = tables.ExportTemplateTable
  211. form = forms.ExportTemplateBulkEditForm
  212. @register_model_view(ExportTemplate, 'bulk_rename', path='rename', detail=False)
  213. class ExportTemplateBulkRenameView(generic.BulkRenameView):
  214. queryset = ExportTemplate.objects.all()
  215. @register_model_view(ExportTemplate, 'bulk_delete', path='delete', detail=False)
  216. class ExportTemplateBulkDeleteView(generic.BulkDeleteView):
  217. queryset = ExportTemplate.objects.all()
  218. filterset = filtersets.ExportTemplateFilterSet
  219. table = tables.ExportTemplateTable
  220. @register_model_view(ExportTemplate, 'bulk_sync', path='sync', detail=False)
  221. class ExportTemplateBulkSyncDataView(generic.BulkSyncDataView):
  222. queryset = ExportTemplate.objects.all()
  223. #
  224. # Saved filters
  225. #
  226. @register_model_view(SavedFilter, 'list', path='', detail=False)
  227. class SavedFilterListView(SharedObjectViewMixin, generic.ObjectListView):
  228. queryset = SavedFilter.objects.all()
  229. filterset = filtersets.SavedFilterFilterSet
  230. filterset_form = forms.SavedFilterFilterForm
  231. table = tables.SavedFilterTable
  232. @register_model_view(SavedFilter)
  233. class SavedFilterView(SharedObjectViewMixin, generic.ObjectView):
  234. queryset = SavedFilter.objects.all()
  235. @register_model_view(SavedFilter, 'add', detail=False)
  236. @register_model_view(SavedFilter, 'edit')
  237. class SavedFilterEditView(SharedObjectViewMixin, generic.ObjectEditView):
  238. queryset = SavedFilter.objects.all()
  239. form = forms.SavedFilterForm
  240. def alter_object(self, obj, request, url_args, url_kwargs):
  241. if not obj.pk:
  242. obj.user = request.user
  243. return obj
  244. @register_model_view(SavedFilter, 'delete')
  245. class SavedFilterDeleteView(SharedObjectViewMixin, generic.ObjectDeleteView):
  246. queryset = SavedFilter.objects.all()
  247. @register_model_view(SavedFilter, 'bulk_import', path='import', detail=False)
  248. class SavedFilterBulkImportView(SharedObjectViewMixin, generic.BulkImportView):
  249. queryset = SavedFilter.objects.all()
  250. model_form = forms.SavedFilterImportForm
  251. @register_model_view(SavedFilter, 'bulk_edit', path='edit', detail=False)
  252. class SavedFilterBulkEditView(SharedObjectViewMixin, generic.BulkEditView):
  253. queryset = SavedFilter.objects.all()
  254. filterset = filtersets.SavedFilterFilterSet
  255. table = tables.SavedFilterTable
  256. form = forms.SavedFilterBulkEditForm
  257. @register_model_view(SavedFilter, 'bulk_rename', path='rename', detail=False)
  258. class SavedFilterBulkRenameView(generic.BulkRenameView):
  259. queryset = SavedFilter.objects.all()
  260. @register_model_view(SavedFilter, 'bulk_delete', path='delete', detail=False)
  261. class SavedFilterBulkDeleteView(SharedObjectViewMixin, generic.BulkDeleteView):
  262. queryset = SavedFilter.objects.all()
  263. filterset = filtersets.SavedFilterFilterSet
  264. table = tables.SavedFilterTable
  265. #
  266. # Table configs
  267. #
  268. @register_model_view(TableConfig, 'list', path='', detail=False)
  269. class TableConfigListView(SharedObjectViewMixin, generic.ObjectListView):
  270. queryset = TableConfig.objects.all()
  271. filterset = filtersets.TableConfigFilterSet
  272. filterset_form = forms.TableConfigFilterForm
  273. table = tables.TableConfigTable
  274. actions = (BulkExport, BulkEdit, BulkRename, BulkDelete)
  275. @register_model_view(TableConfig)
  276. class TableConfigView(SharedObjectViewMixin, generic.ObjectView):
  277. queryset = TableConfig.objects.all()
  278. def get_extra_context(self, request, instance):
  279. table = instance.table_class([])
  280. return {
  281. 'columns': dict(table.columns.items()),
  282. }
  283. @register_model_view(TableConfig, 'add', detail=False)
  284. @register_model_view(TableConfig, 'edit')
  285. class TableConfigEditView(SharedObjectViewMixin, generic.ObjectEditView):
  286. queryset = TableConfig.objects.all()
  287. form = forms.TableConfigForm
  288. template_name = 'extras/tableconfig_edit.html'
  289. def alter_object(self, obj, request, url_args, url_kwargs):
  290. if not obj.pk:
  291. obj.user = request.user
  292. return obj
  293. @register_model_view(TableConfig, 'delete')
  294. class TableConfigDeleteView(SharedObjectViewMixin, generic.ObjectDeleteView):
  295. queryset = TableConfig.objects.all()
  296. @register_model_view(TableConfig, 'bulk_edit', path='edit', detail=False)
  297. class TableConfigBulkEditView(SharedObjectViewMixin, generic.BulkEditView):
  298. queryset = TableConfig.objects.all()
  299. filterset = filtersets.TableConfigFilterSet
  300. table = tables.TableConfigTable
  301. form = forms.TableConfigBulkEditForm
  302. @register_model_view(TableConfig, 'bulk_rename', path='rename', detail=False)
  303. class TableConfigBulkRenameView(generic.BulkRenameView):
  304. queryset = TableConfig.objects.all()
  305. @register_model_view(TableConfig, 'bulk_delete', path='delete', detail=False)
  306. class TableConfigBulkDeleteView(SharedObjectViewMixin, generic.BulkDeleteView):
  307. queryset = TableConfig.objects.all()
  308. filterset = filtersets.TableConfigFilterSet
  309. table = tables.TableConfigTable
  310. #
  311. # Bookmarks
  312. #
  313. @register_model_view(Bookmark, 'add', detail=False)
  314. class BookmarkCreateView(generic.ObjectEditView):
  315. form = forms.BookmarkForm
  316. def get_queryset(self, request):
  317. return Bookmark.objects.filter(user=request.user)
  318. def alter_object(self, obj, request, url_args, url_kwargs):
  319. obj.user = request.user
  320. return obj
  321. @register_model_view(Bookmark, 'delete')
  322. class BookmarkDeleteView(generic.ObjectDeleteView):
  323. def get_queryset(self, request):
  324. return Bookmark.objects.filter(user=request.user)
  325. @register_model_view(Bookmark, 'bulk_delete', path='delete', detail=False)
  326. class BookmarkBulkDeleteView(generic.BulkDeleteView):
  327. table = tables.BookmarkTable
  328. def get_queryset(self, request):
  329. return Bookmark.objects.filter(user=request.user)
  330. #
  331. # Notification groups
  332. #
  333. @register_model_view(NotificationGroup, 'list', path='', detail=False)
  334. class NotificationGroupListView(generic.ObjectListView):
  335. queryset = NotificationGroup.objects.all()
  336. filterset = filtersets.NotificationGroupFilterSet
  337. filterset_form = forms.NotificationGroupFilterForm
  338. table = tables.NotificationGroupTable
  339. @register_model_view(NotificationGroup)
  340. class NotificationGroupView(generic.ObjectView):
  341. queryset = NotificationGroup.objects.all()
  342. @register_model_view(NotificationGroup, 'add', detail=False)
  343. @register_model_view(NotificationGroup, 'edit')
  344. class NotificationGroupEditView(generic.ObjectEditView):
  345. queryset = NotificationGroup.objects.all()
  346. form = forms.NotificationGroupForm
  347. @register_model_view(NotificationGroup, 'delete')
  348. class NotificationGroupDeleteView(generic.ObjectDeleteView):
  349. queryset = NotificationGroup.objects.all()
  350. @register_model_view(NotificationGroup, 'bulk_import', path='import', detail=False)
  351. class NotificationGroupBulkImportView(generic.BulkImportView):
  352. queryset = NotificationGroup.objects.all()
  353. model_form = forms.NotificationGroupImportForm
  354. @register_model_view(NotificationGroup, 'bulk_edit', path='edit', detail=False)
  355. class NotificationGroupBulkEditView(generic.BulkEditView):
  356. queryset = NotificationGroup.objects.all()
  357. filterset = filtersets.NotificationGroupFilterSet
  358. table = tables.NotificationGroupTable
  359. form = forms.NotificationGroupBulkEditForm
  360. @register_model_view(NotificationGroup, 'bulk_rename', path='rename', detail=False)
  361. class NotificationGroupBulkRenameView(generic.BulkRenameView):
  362. queryset = NotificationGroup.objects.all()
  363. @register_model_view(NotificationGroup, 'bulk_delete', path='delete', detail=False)
  364. class NotificationGroupBulkDeleteView(generic.BulkDeleteView):
  365. queryset = NotificationGroup.objects.all()
  366. filterset = filtersets.NotificationGroupFilterSet
  367. table = tables.NotificationGroupTable
  368. #
  369. # Notifications
  370. #
  371. class NotificationsView(LoginRequiredMixin, View):
  372. """
  373. HTMX-only user-specific notifications list.
  374. """
  375. def get(self, request):
  376. return render(request, 'htmx/notifications.html', {
  377. 'notifications': request.user.notifications.unread(),
  378. 'total_count': request.user.notifications.count(),
  379. })
  380. @register_model_view(Notification, 'read')
  381. class NotificationReadView(LoginRequiredMixin, View):
  382. """
  383. Mark the Notification read and redirect the user to its attached object.
  384. """
  385. def get(self, request, pk):
  386. # Mark the Notification as read
  387. notification = get_object_or_404(request.user.notifications, pk=pk)
  388. notification.read = timezone.now()
  389. notification.save()
  390. # Redirect to the object if it has a URL (deleted objects will not)
  391. if hasattr(notification.object, 'get_absolute_url'):
  392. return redirect(notification.object.get_absolute_url())
  393. return redirect('account:notifications')
  394. @register_model_view(Notification, 'dismiss')
  395. class NotificationDismissView(LoginRequiredMixin, View):
  396. """
  397. A convenience view which allows deleting notifications with one click.
  398. """
  399. def get(self, request, pk):
  400. notification = get_object_or_404(request.user.notifications, pk=pk)
  401. notification.delete()
  402. if htmx_partial(request):
  403. return render(request, 'htmx/notifications.html', {
  404. 'notifications': request.user.notifications.unread()[:10],
  405. })
  406. return redirect('account:notifications')
  407. @register_model_view(Notification, 'delete')
  408. class NotificationDeleteView(generic.ObjectDeleteView):
  409. def get_queryset(self, request):
  410. return Notification.objects.filter(user=request.user)
  411. @register_model_view(Notification, 'bulk_delete', path='delete', detail=False)
  412. class NotificationBulkDeleteView(generic.BulkDeleteView):
  413. table = tables.NotificationTable
  414. def get_queryset(self, request):
  415. return Notification.objects.filter(user=request.user)
  416. #
  417. # Subscriptions
  418. #
  419. @register_model_view(Subscription, 'add', detail=False)
  420. class SubscriptionCreateView(generic.ObjectEditView):
  421. form = forms.SubscriptionForm
  422. def get_queryset(self, request):
  423. return Subscription.objects.filter(user=request.user)
  424. def alter_object(self, obj, request, url_args, url_kwargs):
  425. obj.user = request.user
  426. return obj
  427. @register_model_view(Subscription, 'delete')
  428. class SubscriptionDeleteView(generic.ObjectDeleteView):
  429. def get_queryset(self, request):
  430. return Subscription.objects.filter(user=request.user)
  431. @register_model_view(Subscription, 'bulk_delete', path='delete', detail=False)
  432. class SubscriptionBulkDeleteView(generic.BulkDeleteView):
  433. table = tables.SubscriptionTable
  434. def get_queryset(self, request):
  435. return Subscription.objects.filter(user=request.user)
  436. #
  437. # Webhooks
  438. #
  439. @register_model_view(Webhook, 'list', path='', detail=False)
  440. class WebhookListView(generic.ObjectListView):
  441. queryset = Webhook.objects.all()
  442. filterset = filtersets.WebhookFilterSet
  443. filterset_form = forms.WebhookFilterForm
  444. table = tables.WebhookTable
  445. @register_model_view(Webhook)
  446. class WebhookView(generic.ObjectView):
  447. queryset = Webhook.objects.all()
  448. @register_model_view(Webhook, 'add', detail=False)
  449. @register_model_view(Webhook, 'edit')
  450. class WebhookEditView(generic.ObjectEditView):
  451. queryset = Webhook.objects.all()
  452. form = forms.WebhookForm
  453. @register_model_view(Webhook, 'delete')
  454. class WebhookDeleteView(generic.ObjectDeleteView):
  455. queryset = Webhook.objects.all()
  456. @register_model_view(Webhook, 'bulk_import', path='import', detail=False)
  457. class WebhookBulkImportView(generic.BulkImportView):
  458. queryset = Webhook.objects.all()
  459. model_form = forms.WebhookImportForm
  460. @register_model_view(Webhook, 'bulk_edit', path='edit', detail=False)
  461. class WebhookBulkEditView(generic.BulkEditView):
  462. queryset = Webhook.objects.all()
  463. filterset = filtersets.WebhookFilterSet
  464. table = tables.WebhookTable
  465. form = forms.WebhookBulkEditForm
  466. @register_model_view(Webhook, 'bulk_rename', path='rename', detail=False)
  467. class WebhookBulkRenameView(generic.BulkRenameView):
  468. queryset = Webhook.objects.all()
  469. @register_model_view(Webhook, 'bulk_delete', path='delete', detail=False)
  470. class WebhookBulkDeleteView(generic.BulkDeleteView):
  471. queryset = Webhook.objects.all()
  472. filterset = filtersets.WebhookFilterSet
  473. table = tables.WebhookTable
  474. #
  475. # Event Rules
  476. #
  477. @register_model_view(EventRule, 'list', path='', detail=False)
  478. class EventRuleListView(generic.ObjectListView):
  479. queryset = EventRule.objects.all()
  480. filterset = filtersets.EventRuleFilterSet
  481. filterset_form = forms.EventRuleFilterForm
  482. table = tables.EventRuleTable
  483. @register_model_view(EventRule)
  484. class EventRuleView(generic.ObjectView):
  485. queryset = EventRule.objects.all()
  486. @register_model_view(EventRule, 'add', detail=False)
  487. @register_model_view(EventRule, 'edit')
  488. class EventRuleEditView(generic.ObjectEditView):
  489. queryset = EventRule.objects.all()
  490. form = forms.EventRuleForm
  491. @register_model_view(EventRule, 'delete')
  492. class EventRuleDeleteView(generic.ObjectDeleteView):
  493. queryset = EventRule.objects.all()
  494. @register_model_view(EventRule, 'bulk_import', path='import', detail=False)
  495. class EventRuleBulkImportView(generic.BulkImportView):
  496. queryset = EventRule.objects.all()
  497. model_form = forms.EventRuleImportForm
  498. @register_model_view(EventRule, 'bulk_edit', path='edit', detail=False)
  499. class EventRuleBulkEditView(generic.BulkEditView):
  500. queryset = EventRule.objects.all()
  501. filterset = filtersets.EventRuleFilterSet
  502. table = tables.EventRuleTable
  503. form = forms.EventRuleBulkEditForm
  504. @register_model_view(EventRule, 'bulk_rename', path='rename', detail=False)
  505. class EventRuleBulkRenameView(generic.BulkRenameView):
  506. queryset = EventRule.objects.all()
  507. @register_model_view(EventRule, 'bulk_delete', path='delete', detail=False)
  508. class EventRuleBulkDeleteView(generic.BulkDeleteView):
  509. queryset = EventRule.objects.all()
  510. filterset = filtersets.EventRuleFilterSet
  511. table = tables.EventRuleTable
  512. #
  513. # Tags
  514. #
  515. @register_model_view(Tag, 'list', path='', detail=False)
  516. class TagListView(generic.ObjectListView):
  517. queryset = Tag.objects.annotate(
  518. items=count_related(TaggedItem, 'tag')
  519. )
  520. filterset = filtersets.TagFilterSet
  521. filterset_form = forms.TagFilterForm
  522. table = tables.TagTable
  523. @register_model_view(Tag)
  524. class TagView(generic.ObjectView):
  525. queryset = Tag.objects.all()
  526. def get_extra_context(self, request, instance):
  527. tagged_items = TaggedItem.objects.filter(tag=instance)
  528. taggeditem_table = tables.TaggedItemTable(
  529. data=tagged_items,
  530. orderable=False
  531. )
  532. taggeditem_table.configure(request)
  533. object_types = [
  534. {
  535. 'content_type': ContentType.objects.get(pk=ti['content_type']),
  536. 'item_count': ti['item_count']
  537. } for ti in tagged_items.values('content_type').annotate(item_count=Count('pk'))
  538. ]
  539. return {
  540. 'taggeditem_table': taggeditem_table,
  541. 'tagged_item_count': tagged_items.count(),
  542. 'object_types': object_types,
  543. }
  544. @register_model_view(Tag, 'add', detail=False)
  545. @register_model_view(Tag, 'edit')
  546. class TagEditView(generic.ObjectEditView):
  547. queryset = Tag.objects.all()
  548. form = forms.TagForm
  549. @register_model_view(Tag, 'delete')
  550. class TagDeleteView(generic.ObjectDeleteView):
  551. queryset = Tag.objects.all()
  552. @register_model_view(Tag, 'bulk_import', path='import', detail=False)
  553. class TagBulkImportView(generic.BulkImportView):
  554. queryset = Tag.objects.all()
  555. model_form = forms.TagImportForm
  556. @register_model_view(Tag, 'bulk_edit', path='edit', detail=False)
  557. class TagBulkEditView(generic.BulkEditView):
  558. queryset = Tag.objects.annotate(
  559. items=count_related(TaggedItem, 'tag')
  560. )
  561. table = tables.TagTable
  562. form = forms.TagBulkEditForm
  563. @register_model_view(Tag, 'bulk_rename', path='rename', detail=False)
  564. class TagBulkRenameView(generic.BulkRenameView):
  565. queryset = Tag.objects.all()
  566. @register_model_view(Tag, 'bulk_delete', path='delete', detail=False)
  567. class TagBulkDeleteView(generic.BulkDeleteView):
  568. queryset = Tag.objects.annotate(
  569. items=count_related(TaggedItem, 'tag')
  570. )
  571. table = tables.TagTable
  572. #
  573. # Config contexts
  574. #
  575. @register_model_view(ConfigContext, 'list', path='', detail=False)
  576. class ConfigContextListView(generic.ObjectListView):
  577. queryset = ConfigContext.objects.all()
  578. filterset = filtersets.ConfigContextFilterSet
  579. filterset_form = forms.ConfigContextFilterForm
  580. table = tables.ConfigContextTable
  581. actions = (AddObject, BulkSync, BulkEdit, BulkRename, BulkDelete)
  582. @register_model_view(ConfigContext)
  583. class ConfigContextView(generic.ObjectView):
  584. queryset = ConfigContext.objects.all()
  585. def get_extra_context(self, request, instance):
  586. # Gather assigned objects for parsing in the template
  587. assigned_objects = (
  588. ('Regions', instance.regions.all),
  589. ('Site Groups', instance.site_groups.all),
  590. ('Sites', instance.sites.all),
  591. ('Locations', instance.locations.all),
  592. ('Device Types', instance.device_types.all),
  593. ('Roles', instance.roles.all),
  594. ('Platforms', instance.platforms.all),
  595. ('Cluster Types', instance.cluster_types.all),
  596. ('Cluster Groups', instance.cluster_groups.all),
  597. ('Clusters', instance.clusters.all),
  598. ('Tenant Groups', instance.tenant_groups.all),
  599. ('Tenants', instance.tenants.all),
  600. ('Tags', instance.tags.all),
  601. )
  602. # Determine user's preferred output format
  603. if request.GET.get('format') in ['json', 'yaml']:
  604. format = request.GET.get('format')
  605. if request.user.is_authenticated:
  606. request.user.config.set('data_format', format, commit=True)
  607. elif request.user.is_authenticated:
  608. format = request.user.config.get('data_format', 'json')
  609. else:
  610. format = 'json'
  611. return {
  612. 'assigned_objects': assigned_objects,
  613. 'format': format,
  614. }
  615. @register_model_view(ConfigContext, 'add', detail=False)
  616. @register_model_view(ConfigContext, 'edit')
  617. class ConfigContextEditView(generic.ObjectEditView):
  618. queryset = ConfigContext.objects.all()
  619. form = forms.ConfigContextForm
  620. @register_model_view(ConfigContext, 'delete')
  621. class ConfigContextDeleteView(generic.ObjectDeleteView):
  622. queryset = ConfigContext.objects.all()
  623. @register_model_view(ConfigContext, 'bulk_edit', path='edit', detail=False)
  624. class ConfigContextBulkEditView(generic.BulkEditView):
  625. queryset = ConfigContext.objects.all()
  626. filterset = filtersets.ConfigContextFilterSet
  627. table = tables.ConfigContextTable
  628. form = forms.ConfigContextBulkEditForm
  629. @register_model_view(ConfigContext, 'bulk_rename', path='rename', detail=False)
  630. class ConfigContextBulkRenameView(generic.BulkRenameView):
  631. queryset = ConfigContext.objects.all()
  632. @register_model_view(ConfigContext, 'bulk_delete', path='delete', detail=False)
  633. class ConfigContextBulkDeleteView(generic.BulkDeleteView):
  634. queryset = ConfigContext.objects.all()
  635. filterset = filtersets.ConfigContextFilterSet
  636. table = tables.ConfigContextTable
  637. @register_model_view(ConfigContext, 'bulk_sync', path='sync', detail=False)
  638. class ConfigContextBulkSyncDataView(generic.BulkSyncDataView):
  639. queryset = ConfigContext.objects.all()
  640. class ObjectConfigContextView(generic.ObjectView):
  641. base_template = None
  642. template_name = 'extras/object_configcontext.html'
  643. def get_extra_context(self, request, instance):
  644. source_contexts = ConfigContext.objects.restrict(request.user, 'view').get_for_object(instance)
  645. # Determine user's preferred output format
  646. if request.GET.get('format') in ['json', 'yaml']:
  647. format = request.GET.get('format')
  648. if request.user.is_authenticated:
  649. request.user.config.set('data_format', format, commit=True)
  650. elif request.user.is_authenticated:
  651. format = request.user.config.get('data_format', 'json')
  652. else:
  653. format = 'json'
  654. return {
  655. 'rendered_context': instance.get_config_context(),
  656. 'source_contexts': source_contexts,
  657. 'format': format,
  658. 'base_template': self.base_template,
  659. }
  660. #
  661. # Config templates
  662. #
  663. @register_model_view(ConfigTemplate, 'list', path='', detail=False)
  664. class ConfigTemplateListView(generic.ObjectListView):
  665. queryset = ConfigTemplate.objects.annotate(
  666. device_count=count_related(Device, 'config_template'),
  667. vm_count=count_related(VirtualMachine, 'config_template'),
  668. role_count=count_related(DeviceRole, 'config_template'),
  669. platform_count=count_related(Platform, 'config_template'),
  670. )
  671. filterset = filtersets.ConfigTemplateFilterSet
  672. filterset_form = forms.ConfigTemplateFilterForm
  673. table = tables.ConfigTemplateTable
  674. actions = (AddObject, BulkImport, BulkExport, BulkSync, BulkEdit, BulkRename, BulkDelete)
  675. @register_model_view(ConfigTemplate)
  676. class ConfigTemplateView(generic.ObjectView):
  677. queryset = ConfigTemplate.objects.all()
  678. @register_model_view(ConfigTemplate, 'add', detail=False)
  679. @register_model_view(ConfigTemplate, 'edit')
  680. class ConfigTemplateEditView(generic.ObjectEditView):
  681. queryset = ConfigTemplate.objects.all()
  682. form = forms.ConfigTemplateForm
  683. @register_model_view(ConfigTemplate, 'delete')
  684. class ConfigTemplateDeleteView(generic.ObjectDeleteView):
  685. queryset = ConfigTemplate.objects.all()
  686. @register_model_view(ConfigTemplate, 'bulk_import', path='import', detail=False)
  687. class ConfigTemplateBulkImportView(generic.BulkImportView):
  688. queryset = ConfigTemplate.objects.all()
  689. model_form = forms.ConfigTemplateImportForm
  690. @register_model_view(ConfigTemplate, 'bulk_edit', path='edit', detail=False)
  691. class ConfigTemplateBulkEditView(generic.BulkEditView):
  692. queryset = ConfigTemplate.objects.all()
  693. filterset = filtersets.ConfigTemplateFilterSet
  694. table = tables.ConfigTemplateTable
  695. form = forms.ConfigTemplateBulkEditForm
  696. @register_model_view(ConfigTemplate, 'bulk_rename', path='rename', detail=False)
  697. class ConfigTemplateBulkRenameView(generic.BulkRenameView):
  698. queryset = ConfigTemplate.objects.all()
  699. @register_model_view(ConfigTemplate, 'bulk_delete', path='delete', detail=False)
  700. class ConfigTemplateBulkDeleteView(generic.BulkDeleteView):
  701. queryset = ConfigTemplate.objects.all()
  702. filterset = filtersets.ConfigTemplateFilterSet
  703. table = tables.ConfigTemplateTable
  704. @register_model_view(ConfigTemplate, 'bulk_sync', path='sync', detail=False)
  705. class ConfigTemplateBulkSyncDataView(generic.BulkSyncDataView):
  706. queryset = ConfigTemplate.objects.all()
  707. class ObjectRenderConfigView(generic.ObjectView):
  708. base_template = None
  709. template_name = 'extras/object_render_config.html'
  710. def get(self, request, **kwargs):
  711. instance = self.get_object(**kwargs)
  712. context = self.get_extra_context(request, instance)
  713. # If a direct export has been requested, return the rendered template content as a
  714. # downloadable file.
  715. if request.GET.get('export'):
  716. content = context['rendered_config'] or context['error_message']
  717. response = HttpResponse(content, content_type='text')
  718. filename = f"{instance.name or 'config'}.txt"
  719. response['Content-Disposition'] = f'attachment; filename="{filename}"'
  720. return response
  721. return render(
  722. request,
  723. self.get_template_name(),
  724. {
  725. 'object': instance,
  726. 'tab': self.tab,
  727. **context,
  728. },
  729. )
  730. def get_extra_context_data(self, request, instance):
  731. return {
  732. f'{instance._meta.model_name}': instance,
  733. }
  734. def get_extra_context(self, request, instance):
  735. # Compile context data
  736. context_data = instance.get_config_context()
  737. context_data.update(self.get_extra_context_data(request, instance))
  738. # Render the config template
  739. rendered_config = None
  740. error_message = ''
  741. if config_template := instance.get_config_template():
  742. try:
  743. rendered_config = config_template.render(context=context_data)
  744. except TemplateError as e:
  745. error_message = _("An error occurred while rendering the template: {error}").format(error=e)
  746. return {
  747. 'base_template': self.base_template,
  748. 'config_template': config_template,
  749. 'context_data': context_data,
  750. 'rendered_config': rendered_config,
  751. 'error_message': error_message,
  752. }
  753. #
  754. # Image attachments
  755. #
  756. @register_model_view(ImageAttachment, 'list', path='', detail=False)
  757. class ImageAttachmentListView(generic.ObjectListView):
  758. queryset = ImageAttachment.objects.all()
  759. filterset = filtersets.ImageAttachmentFilterSet
  760. filterset_form = forms.ImageAttachmentFilterForm
  761. table = tables.ImageAttachmentTable
  762. actions = (BulkExport,)
  763. @register_model_view(ImageAttachment)
  764. class ImageAttachmentView(generic.ObjectView):
  765. queryset = ImageAttachment.objects.all()
  766. @register_model_view(ImageAttachment, 'add', detail=False)
  767. @register_model_view(ImageAttachment, 'edit')
  768. class ImageAttachmentEditView(generic.ObjectEditView):
  769. queryset = ImageAttachment.objects.all()
  770. form = forms.ImageAttachmentForm
  771. def alter_object(self, instance, request, args, kwargs):
  772. if not instance.pk:
  773. # Assign the parent object based on URL kwargs
  774. object_type = get_object_or_404(ContentType, pk=request.GET.get('object_type'))
  775. instance.parent = get_object_or_404(object_type.model_class(), pk=request.GET.get('object_id'))
  776. return instance
  777. def get_extra_addanother_params(self, request):
  778. return {
  779. 'object_type': request.GET.get('object_type'),
  780. 'object_id': request.GET.get('object_id'),
  781. }
  782. @register_model_view(ImageAttachment, 'delete')
  783. class ImageAttachmentDeleteView(generic.ObjectDeleteView):
  784. queryset = ImageAttachment.objects.all()
  785. #
  786. # Journal entries
  787. #
  788. @register_model_view(JournalEntry, 'list', path='', detail=False)
  789. class JournalEntryListView(generic.ObjectListView):
  790. queryset = JournalEntry.objects.all()
  791. filterset = filtersets.JournalEntryFilterSet
  792. filterset_form = forms.JournalEntryFilterForm
  793. table = tables.JournalEntryTable
  794. actions = (BulkImport, BulkEdit, BulkDelete)
  795. @register_model_view(JournalEntry)
  796. class JournalEntryView(generic.ObjectView):
  797. queryset = JournalEntry.objects.all()
  798. @register_model_view(JournalEntry, 'add', detail=False)
  799. @register_model_view(JournalEntry, 'edit')
  800. class JournalEntryEditView(generic.ObjectEditView):
  801. queryset = JournalEntry.objects.all()
  802. form = forms.JournalEntryForm
  803. def alter_object(self, obj, request, args, kwargs):
  804. if not obj.pk:
  805. obj.created_by = request.user
  806. return obj
  807. def get_return_url(self, request, instance):
  808. if not instance.assigned_object:
  809. return reverse('extras:journalentry_list')
  810. obj = instance.assigned_object
  811. return get_action_url(obj, action='journal', kwargs={'pk': obj.pk})
  812. @register_model_view(JournalEntry, 'delete')
  813. class JournalEntryDeleteView(generic.ObjectDeleteView):
  814. queryset = JournalEntry.objects.all()
  815. def get_return_url(self, request, instance):
  816. obj = instance.assigned_object
  817. return get_action_url(obj, action='journal', kwargs={'pk': obj.pk})
  818. @register_model_view(JournalEntry, 'bulk_import', path='import', detail=False)
  819. class JournalEntryBulkImportView(generic.BulkImportView):
  820. queryset = JournalEntry.objects.all()
  821. model_form = forms.JournalEntryImportForm
  822. @register_model_view(JournalEntry, 'bulk_edit', path='edit', detail=False)
  823. class JournalEntryBulkEditView(generic.BulkEditView):
  824. queryset = JournalEntry.objects.all()
  825. filterset = filtersets.JournalEntryFilterSet
  826. table = tables.JournalEntryTable
  827. form = forms.JournalEntryBulkEditForm
  828. @register_model_view(JournalEntry, 'bulk_delete', path='delete', detail=False)
  829. class JournalEntryBulkDeleteView(generic.BulkDeleteView):
  830. queryset = JournalEntry.objects.all()
  831. filterset = filtersets.JournalEntryFilterSet
  832. table = tables.JournalEntryTable
  833. #
  834. # Dashboard & widgets
  835. #
  836. class DashboardResetView(LoginRequiredMixin, View):
  837. template_name = 'extras/dashboard/reset.html'
  838. def get(self, request):
  839. get_object_or_404(Dashboard.objects.all(), user=request.user)
  840. form = ConfirmationForm()
  841. return render(request, self.template_name, {
  842. 'form': form,
  843. 'return_url': reverse('home'),
  844. })
  845. def post(self, request):
  846. dashboard = get_object_or_404(Dashboard.objects.all(), user=request.user)
  847. form = ConfirmationForm(request.POST)
  848. if form.is_valid():
  849. dashboard.delete()
  850. messages.success(request, _("Your dashboard has been reset."))
  851. return redirect(reverse('home'))
  852. return render(request, self.template_name, {
  853. 'form': form,
  854. 'return_url': reverse('home'),
  855. })
  856. class DashboardWidgetAddView(LoginRequiredMixin, View):
  857. template_name = 'extras/dashboard/widget_add.html'
  858. def get(self, request):
  859. if not request.htmx:
  860. return redirect('home')
  861. initial = {
  862. 'widget_class': request.GET.get('widget_class') or 'extras.NoteWidget',
  863. }
  864. widget_form = DashboardWidgetAddForm(initial=initial)
  865. widget_name = get_field_value(widget_form, 'widget_class')
  866. widget_class = get_widget_class(widget_name)
  867. config_form = widget_class.ConfigForm(initial=widget_class.default_config, prefix='config')
  868. return render(request, self.template_name, {
  869. 'widget_class': widget_class,
  870. 'widget_form': widget_form,
  871. 'config_form': config_form,
  872. })
  873. def post(self, request):
  874. widget_form = DashboardWidgetAddForm(request.POST)
  875. config_form = None
  876. widget_class = None
  877. if widget_form.is_valid():
  878. widget_class = get_widget_class(widget_form.cleaned_data['widget_class'])
  879. config_form = widget_class.ConfigForm(request.POST, prefix='config')
  880. if config_form.is_valid():
  881. data = widget_form.cleaned_data
  882. data.pop('widget_class')
  883. data['config'] = config_form.cleaned_data
  884. widget = widget_class(**data)
  885. request.user.dashboard.add_widget(widget)
  886. request.user.dashboard.save()
  887. messages.success(request, _('Added widget: ') + str(widget.id))
  888. return HttpResponse(headers={
  889. 'HX-Redirect': reverse('home'),
  890. })
  891. return render(request, self.template_name, {
  892. 'widget_class': widget_class,
  893. 'widget_form': widget_form,
  894. 'config_form': config_form,
  895. })
  896. class DashboardWidgetConfigView(LoginRequiredMixin, View):
  897. template_name = 'extras/dashboard/widget_config.html'
  898. def get(self, request, id):
  899. if not request.htmx:
  900. return redirect('home')
  901. widget = request.user.dashboard.get_widget(id)
  902. widget_form = DashboardWidgetForm(initial=widget.form_data)
  903. config_form = widget.ConfigForm(initial=widget.form_data.get('config'), prefix='config')
  904. return render(request, self.template_name, {
  905. 'widget_class': widget.__class__,
  906. 'widget_form': widget_form,
  907. 'config_form': config_form,
  908. 'form_url': reverse('extras:dashboardwidget_config', kwargs={'id': id})
  909. })
  910. def post(self, request, id):
  911. widget = request.user.dashboard.get_widget(id)
  912. widget_form = DashboardWidgetForm(request.POST)
  913. config_form = widget.ConfigForm(request.POST, prefix='config')
  914. if widget_form.is_valid() and config_form.is_valid():
  915. data = widget_form.cleaned_data
  916. data['config'] = config_form.cleaned_data
  917. request.user.dashboard.config[str(id)].update(data)
  918. request.user.dashboard.save()
  919. messages.success(request, _('Updated widget: ') + str(widget.id))
  920. return HttpResponse(headers={
  921. 'HX-Redirect': reverse('home'),
  922. })
  923. return render(request, self.template_name, {
  924. 'widget_form': widget_form,
  925. 'config_form': config_form,
  926. 'form_url': reverse('extras:dashboardwidget_config', kwargs={'id': id})
  927. })
  928. class DashboardWidgetDeleteView(LoginRequiredMixin, View):
  929. template_name = 'generic/object_delete.html'
  930. def get(self, request, id):
  931. if not request.htmx:
  932. return redirect('home')
  933. widget = request.user.dashboard.get_widget(id)
  934. form = ConfirmationForm(initial=request.GET)
  935. return render(request, 'htmx/delete_form.html', {
  936. 'object_type': widget.__class__.__name__,
  937. 'object': widget,
  938. 'form': form,
  939. 'form_url': reverse('extras:dashboardwidget_delete', kwargs={'id': id})
  940. })
  941. def post(self, request, id):
  942. form = ConfirmationForm(request.POST)
  943. if form.is_valid():
  944. request.user.dashboard.delete_widget(id)
  945. request.user.dashboard.save()
  946. messages.success(request, _('Deleted widget: ') + str(id))
  947. else:
  948. messages.error(request, _('Error deleting widget: ') + str(form.errors[0]))
  949. return redirect(reverse('home'))
  950. #
  951. # Scripts
  952. #
  953. @register_model_view(ScriptModule, 'edit')
  954. class ScriptModuleCreateView(generic.ObjectEditView):
  955. queryset = ScriptModule.objects.all()
  956. form = forms.ScriptFileForm
  957. def alter_object(self, obj, *args, **kwargs):
  958. obj.file_root = ManagedFileRootPathChoices.SCRIPTS
  959. return obj
  960. @register_model_view(ScriptModule, 'delete')
  961. class ScriptModuleDeleteView(generic.ObjectDeleteView):
  962. queryset = ScriptModule.objects.all()
  963. default_return_url = 'extras:script_list'
  964. class ScriptListView(ContentTypePermissionRequiredMixin, View):
  965. def get_required_permission(self):
  966. return 'extras.view_script'
  967. def get(self, request):
  968. script_modules = ScriptModule.objects.restrict(request.user).prefetch_related(
  969. 'data_source', 'data_file', 'jobs'
  970. )
  971. return render(request, 'extras/script_list.html', {
  972. 'model': ScriptModule,
  973. 'script_modules': script_modules,
  974. })
  975. class BaseScriptView(generic.ObjectView):
  976. queryset = Script.objects.all()
  977. def get_object(self, **kwargs):
  978. if pk := kwargs.get('pk', False):
  979. return get_object_or_404(self.queryset, pk=pk)
  980. elif (module := kwargs.get('module')) and (name := kwargs.get('name', False)):
  981. return get_object_or_404(self.queryset, module__file_path=f'{module}.py', name=name)
  982. else:
  983. raise Http404
  984. def _get_script_class(self, script):
  985. """
  986. Return an instance of the Script's Python class
  987. """
  988. if script_class := script.python_class:
  989. return script_class()
  990. class ScriptView(BaseScriptView):
  991. def get(self, request, **kwargs):
  992. script = self.get_object(**kwargs)
  993. script_class = self._get_script_class(script)
  994. if not script_class:
  995. return render(request, 'extras/script.html', {
  996. 'object': script,
  997. 'script': script,
  998. })
  999. form = script_class.as_form(initial=normalize_querydict(request.GET))
  1000. return render(request, 'extras/script.html', {
  1001. 'object': script,
  1002. 'script': script,
  1003. 'script_class': script_class,
  1004. 'form': form,
  1005. 'job_count': script.jobs.count(),
  1006. })
  1007. def post(self, request, **kwargs):
  1008. script = self.get_object(**kwargs)
  1009. if not request.user.has_perm('extras.run_script', obj=script):
  1010. return HttpResponseForbidden()
  1011. script_class = self._get_script_class(script)
  1012. if not script_class:
  1013. return render(request, 'extras/script.html', {
  1014. 'object': script,
  1015. 'script': script,
  1016. })
  1017. form = script_class.as_form(request.POST, request.FILES)
  1018. # Allow execution only if RQ worker process is running
  1019. if not get_workers_for_queue('default'):
  1020. messages.error(request, _("Unable to run script: RQ worker process not running."))
  1021. elif form.is_valid():
  1022. ScriptJob = import_string("extras.jobs.ScriptJob")
  1023. job = ScriptJob.enqueue(
  1024. instance=script,
  1025. user=request.user,
  1026. schedule_at=form.cleaned_data.pop('_schedule_at'),
  1027. interval=form.cleaned_data.pop('_interval'),
  1028. data=form.cleaned_data,
  1029. request=copy_safe_request(request),
  1030. job_timeout=script.python_class.job_timeout,
  1031. commit=form.cleaned_data.pop('_commit'),
  1032. )
  1033. return redirect('extras:script_result', job_pk=job.pk)
  1034. return render(request, 'extras/script.html', {
  1035. 'object': script,
  1036. 'script': script,
  1037. 'script_class': script.python_class(),
  1038. 'form': form,
  1039. 'job_count': script.jobs.count(),
  1040. })
  1041. class ScriptSourceView(BaseScriptView):
  1042. queryset = Script.objects.all()
  1043. def get(self, request, **kwargs):
  1044. script = self.get_object(**kwargs)
  1045. script_class = self._get_script_class(script)
  1046. return render(request, 'extras/script/source.html', {
  1047. 'script': script,
  1048. 'script_class': script_class,
  1049. 'job_count': script.jobs.count(),
  1050. 'tab': 'source',
  1051. })
  1052. class ScriptJobsView(BaseScriptView):
  1053. queryset = Script.objects.all()
  1054. def get(self, request, **kwargs):
  1055. script = self.get_object(**kwargs)
  1056. jobs_table = ScriptJobTable(
  1057. data=script.jobs.all(),
  1058. orderable=False,
  1059. user=request.user
  1060. )
  1061. jobs_table.configure(request)
  1062. return render(request, 'extras/script/jobs.html', {
  1063. 'script': script,
  1064. 'table': jobs_table,
  1065. 'job_count': script.jobs.count(),
  1066. 'tab': 'jobs',
  1067. })
  1068. class ScriptResultView(TableMixin, generic.ObjectView):
  1069. queryset = Job.objects.all()
  1070. def get_required_permission(self):
  1071. return 'extras.view_script'
  1072. def get_table(self, job, request, bulk_actions=True):
  1073. data = []
  1074. tests = None
  1075. table = None
  1076. index = 0
  1077. try:
  1078. log_threshold = LOG_LEVEL_RANK[request.GET.get('log_threshold', LogLevelChoices.LOG_INFO)]
  1079. except KeyError:
  1080. log_threshold = LOG_LEVEL_RANK[LogLevelChoices.LOG_INFO]
  1081. if job.data:
  1082. if 'log' in job.data:
  1083. if 'tests' in job.data:
  1084. tests = job.data['tests']
  1085. for log in job.data['log']:
  1086. log_level = LOG_LEVEL_RANK.get(log.get('status'), LogLevelChoices.LOG_INFO)
  1087. if log_level >= log_threshold:
  1088. index += 1
  1089. result = {
  1090. 'index': index,
  1091. 'time': log.get('time'),
  1092. 'status': log.get('status'),
  1093. 'message': log.get('message'),
  1094. 'object': log.get('obj'),
  1095. 'url': log.get('url'),
  1096. }
  1097. data.append(result)
  1098. table = ScriptResultsTable(data, user=request.user)
  1099. table.configure(request)
  1100. else:
  1101. # for legacy reports
  1102. tests = job.data
  1103. if tests:
  1104. for method, test_data in tests.items():
  1105. if 'log' in test_data:
  1106. for time, status, obj, url, message in test_data['log']:
  1107. log_level = LOG_LEVEL_RANK.get(status, LogLevelChoices.LOG_INFO)
  1108. if log_level >= log_threshold:
  1109. index += 1
  1110. result = {
  1111. 'index': index,
  1112. 'method': method,
  1113. 'time': time,
  1114. 'status': status,
  1115. 'object': obj,
  1116. 'url': url,
  1117. 'message': message,
  1118. }
  1119. data.append(result)
  1120. table = ReportResultsTable(data, user=request.user)
  1121. table.configure(request)
  1122. return table
  1123. def get(self, request, **kwargs):
  1124. table = None
  1125. job = get_object_or_404(Job.objects.all(), pk=kwargs.get('job_pk'))
  1126. # If a direct export output has been requested, return the job data content as a
  1127. # downloadable file.
  1128. if job.completed and request.GET.get('export') == 'output':
  1129. content = (job.data.get("output") or "").encode()
  1130. response = HttpResponse(content, content_type='text')
  1131. filename = f"{job.object.name or 'script-output'}_{job.completed.strftime('%Y-%m-%d_%H%M%S')}.txt"
  1132. response['Content-Disposition'] = f'attachment; filename="{filename}"'
  1133. return response
  1134. elif job.completed:
  1135. table = self.get_table(job, request, bulk_actions=False)
  1136. log_threshold = request.GET.get('log_threshold', LogLevelChoices.LOG_INFO)
  1137. if log_threshold not in LOG_LEVEL_RANK:
  1138. log_threshold = LogLevelChoices.LOG_INFO
  1139. context = {
  1140. 'script': job.object,
  1141. 'job': job,
  1142. 'table': table,
  1143. 'log_levels': dict(LogLevelChoices),
  1144. 'log_threshold': log_threshold,
  1145. }
  1146. if job.data and 'log' in job.data:
  1147. # Script
  1148. context['tests'] = job.data.get('tests', {})
  1149. elif job.data:
  1150. # Legacy Report
  1151. context['tests'] = {
  1152. name: data for name, data in job.data.items()
  1153. if name.startswith('test_')
  1154. }
  1155. # If this is an HTMX request, return only the result HTML
  1156. if htmx_partial(request):
  1157. if request.GET.get('log'):
  1158. # If log=True, render only the log table
  1159. return render(request, 'htmx/table.html', context)
  1160. response = render(request, 'extras/htmx/script_result.html', context)
  1161. if job.completed or not job.started:
  1162. response.status_code = 286
  1163. return response
  1164. return render(request, 'extras/script_result.html', context)
  1165. #
  1166. # Markdown
  1167. #
  1168. class RenderMarkdownView(LoginRequiredMixin, View):
  1169. def post(self, request):
  1170. form = forms.RenderMarkdownForm(request.POST)
  1171. if not form.is_valid():
  1172. HttpResponseBadRequest()
  1173. rendered = render_markdown(form.cleaned_data['text'])
  1174. return HttpResponse(rendered)