views.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903
  1. from django.contrib import messages
  2. from django.contrib.contenttypes.models import ContentType
  3. from django.db.models import Count, Q
  4. from django.http import Http404, HttpResponseBadRequest, HttpResponseForbidden, HttpResponse
  5. from django.shortcuts import get_object_or_404, redirect, render
  6. from django.urls import reverse
  7. from django.views.generic import View
  8. from django_rq.queues import get_connection
  9. from rq import Worker
  10. from netbox.views import generic
  11. from utilities.htmx import is_htmx
  12. from utilities.templatetags.builtins.filters import render_markdown
  13. from utilities.utils import copy_safe_request, count_related, get_viewname, normalize_querydict, shallow_compare_dict
  14. from utilities.views import ContentTypePermissionRequiredMixin, register_model_view
  15. from . import filtersets, forms, tables
  16. from .choices import JobResultStatusChoices
  17. from .forms.reports import ReportForm
  18. from .models import *
  19. from .reports import get_report, get_reports, run_report
  20. from .scripts import get_scripts, run_script
  21. #
  22. # Custom fields
  23. #
  24. class CustomFieldListView(generic.ObjectListView):
  25. queryset = CustomField.objects.all()
  26. filterset = filtersets.CustomFieldFilterSet
  27. filterset_form = forms.CustomFieldFilterForm
  28. table = tables.CustomFieldTable
  29. @register_model_view(CustomField)
  30. class CustomFieldView(generic.ObjectView):
  31. queryset = CustomField.objects.all()
  32. @register_model_view(CustomField, 'edit')
  33. class CustomFieldEditView(generic.ObjectEditView):
  34. queryset = CustomField.objects.all()
  35. form = forms.CustomFieldForm
  36. @register_model_view(CustomField, 'delete')
  37. class CustomFieldDeleteView(generic.ObjectDeleteView):
  38. queryset = CustomField.objects.all()
  39. class CustomFieldBulkImportView(generic.BulkImportView):
  40. queryset = CustomField.objects.all()
  41. model_form = forms.CustomFieldImportForm
  42. table = tables.CustomFieldTable
  43. class CustomFieldBulkEditView(generic.BulkEditView):
  44. queryset = CustomField.objects.all()
  45. filterset = filtersets.CustomFieldFilterSet
  46. table = tables.CustomFieldTable
  47. form = forms.CustomFieldBulkEditForm
  48. class CustomFieldBulkDeleteView(generic.BulkDeleteView):
  49. queryset = CustomField.objects.all()
  50. filterset = filtersets.CustomFieldFilterSet
  51. table = tables.CustomFieldTable
  52. #
  53. # Custom links
  54. #
  55. class CustomLinkListView(generic.ObjectListView):
  56. queryset = CustomLink.objects.all()
  57. filterset = filtersets.CustomLinkFilterSet
  58. filterset_form = forms.CustomLinkFilterForm
  59. table = tables.CustomLinkTable
  60. @register_model_view(CustomLink)
  61. class CustomLinkView(generic.ObjectView):
  62. queryset = CustomLink.objects.all()
  63. @register_model_view(CustomLink, 'edit')
  64. class CustomLinkEditView(generic.ObjectEditView):
  65. queryset = CustomLink.objects.all()
  66. form = forms.CustomLinkForm
  67. @register_model_view(CustomLink, 'delete')
  68. class CustomLinkDeleteView(generic.ObjectDeleteView):
  69. queryset = CustomLink.objects.all()
  70. class CustomLinkBulkImportView(generic.BulkImportView):
  71. queryset = CustomLink.objects.all()
  72. model_form = forms.CustomLinkImportForm
  73. table = tables.CustomLinkTable
  74. class CustomLinkBulkEditView(generic.BulkEditView):
  75. queryset = CustomLink.objects.all()
  76. filterset = filtersets.CustomLinkFilterSet
  77. table = tables.CustomLinkTable
  78. form = forms.CustomLinkBulkEditForm
  79. class CustomLinkBulkDeleteView(generic.BulkDeleteView):
  80. queryset = CustomLink.objects.all()
  81. filterset = filtersets.CustomLinkFilterSet
  82. table = tables.CustomLinkTable
  83. #
  84. # Export templates
  85. #
  86. class ExportTemplateListView(generic.ObjectListView):
  87. queryset = ExportTemplate.objects.all()
  88. filterset = filtersets.ExportTemplateFilterSet
  89. filterset_form = forms.ExportTemplateFilterForm
  90. table = tables.ExportTemplateTable
  91. @register_model_view(ExportTemplate)
  92. class ExportTemplateView(generic.ObjectView):
  93. queryset = ExportTemplate.objects.all()
  94. @register_model_view(ExportTemplate, 'edit')
  95. class ExportTemplateEditView(generic.ObjectEditView):
  96. queryset = ExportTemplate.objects.all()
  97. form = forms.ExportTemplateForm
  98. @register_model_view(ExportTemplate, 'delete')
  99. class ExportTemplateDeleteView(generic.ObjectDeleteView):
  100. queryset = ExportTemplate.objects.all()
  101. class ExportTemplateBulkImportView(generic.BulkImportView):
  102. queryset = ExportTemplate.objects.all()
  103. model_form = forms.ExportTemplateImportForm
  104. table = tables.ExportTemplateTable
  105. class ExportTemplateBulkEditView(generic.BulkEditView):
  106. queryset = ExportTemplate.objects.all()
  107. filterset = filtersets.ExportTemplateFilterSet
  108. table = tables.ExportTemplateTable
  109. form = forms.ExportTemplateBulkEditForm
  110. class ExportTemplateBulkDeleteView(generic.BulkDeleteView):
  111. queryset = ExportTemplate.objects.all()
  112. filterset = filtersets.ExportTemplateFilterSet
  113. table = tables.ExportTemplateTable
  114. #
  115. # Saved filters
  116. #
  117. class SavedFilterMixin:
  118. def get_queryset(self, request):
  119. """
  120. Return only shared SavedFilters, or those owned by the current user, unless
  121. this is a superuser.
  122. """
  123. queryset = SavedFilter.objects.all()
  124. user = request.user
  125. if user.is_superuser:
  126. return queryset
  127. if user.is_anonymous:
  128. return queryset.filter(shared=True)
  129. return queryset.filter(
  130. Q(shared=True) | Q(user=user)
  131. )
  132. class SavedFilterListView(SavedFilterMixin, generic.ObjectListView):
  133. filterset = filtersets.SavedFilterFilterSet
  134. filterset_form = forms.SavedFilterFilterForm
  135. table = tables.SavedFilterTable
  136. @register_model_view(SavedFilter)
  137. class SavedFilterView(SavedFilterMixin, generic.ObjectView):
  138. queryset = SavedFilter.objects.all()
  139. @register_model_view(SavedFilter, 'edit')
  140. class SavedFilterEditView(SavedFilterMixin, generic.ObjectEditView):
  141. queryset = SavedFilter.objects.all()
  142. form = forms.SavedFilterForm
  143. def alter_object(self, obj, request, url_args, url_kwargs):
  144. if not obj.pk:
  145. obj.user = request.user
  146. return obj
  147. @register_model_view(SavedFilter, 'delete')
  148. class SavedFilterDeleteView(SavedFilterMixin, generic.ObjectDeleteView):
  149. queryset = SavedFilter.objects.all()
  150. class SavedFilterBulkImportView(SavedFilterMixin, generic.BulkImportView):
  151. queryset = SavedFilter.objects.all()
  152. model_form = forms.SavedFilterImportForm
  153. table = tables.SavedFilterTable
  154. class SavedFilterBulkEditView(SavedFilterMixin, generic.BulkEditView):
  155. queryset = SavedFilter.objects.all()
  156. filterset = filtersets.SavedFilterFilterSet
  157. table = tables.SavedFilterTable
  158. form = forms.SavedFilterBulkEditForm
  159. class SavedFilterBulkDeleteView(SavedFilterMixin, generic.BulkDeleteView):
  160. queryset = SavedFilter.objects.all()
  161. filterset = filtersets.SavedFilterFilterSet
  162. table = tables.SavedFilterTable
  163. #
  164. # Webhooks
  165. #
  166. class WebhookListView(generic.ObjectListView):
  167. queryset = Webhook.objects.all()
  168. filterset = filtersets.WebhookFilterSet
  169. filterset_form = forms.WebhookFilterForm
  170. table = tables.WebhookTable
  171. @register_model_view(Webhook)
  172. class WebhookView(generic.ObjectView):
  173. queryset = Webhook.objects.all()
  174. @register_model_view(Webhook, 'edit')
  175. class WebhookEditView(generic.ObjectEditView):
  176. queryset = Webhook.objects.all()
  177. form = forms.WebhookForm
  178. @register_model_view(Webhook, 'delete')
  179. class WebhookDeleteView(generic.ObjectDeleteView):
  180. queryset = Webhook.objects.all()
  181. class WebhookBulkImportView(generic.BulkImportView):
  182. queryset = Webhook.objects.all()
  183. model_form = forms.WebhookImportForm
  184. table = tables.WebhookTable
  185. class WebhookBulkEditView(generic.BulkEditView):
  186. queryset = Webhook.objects.all()
  187. filterset = filtersets.WebhookFilterSet
  188. table = tables.WebhookTable
  189. form = forms.WebhookBulkEditForm
  190. class WebhookBulkDeleteView(generic.BulkDeleteView):
  191. queryset = Webhook.objects.all()
  192. filterset = filtersets.WebhookFilterSet
  193. table = tables.WebhookTable
  194. #
  195. # Tags
  196. #
  197. class TagListView(generic.ObjectListView):
  198. queryset = Tag.objects.annotate(
  199. items=count_related(TaggedItem, 'tag')
  200. )
  201. filterset = filtersets.TagFilterSet
  202. filterset_form = forms.TagFilterForm
  203. table = tables.TagTable
  204. @register_model_view(Tag)
  205. class TagView(generic.ObjectView):
  206. queryset = Tag.objects.all()
  207. def get_extra_context(self, request, instance):
  208. tagged_items = TaggedItem.objects.filter(tag=instance)
  209. taggeditem_table = tables.TaggedItemTable(
  210. data=tagged_items,
  211. orderable=False
  212. )
  213. taggeditem_table.configure(request)
  214. object_types = [
  215. {
  216. 'content_type': ContentType.objects.get(pk=ti['content_type']),
  217. 'item_count': ti['item_count']
  218. } for ti in tagged_items.values('content_type').annotate(item_count=Count('pk'))
  219. ]
  220. return {
  221. 'taggeditem_table': taggeditem_table,
  222. 'tagged_item_count': tagged_items.count(),
  223. 'object_types': object_types,
  224. }
  225. @register_model_view(Tag, 'edit')
  226. class TagEditView(generic.ObjectEditView):
  227. queryset = Tag.objects.all()
  228. form = forms.TagForm
  229. @register_model_view(Tag, 'delete')
  230. class TagDeleteView(generic.ObjectDeleteView):
  231. queryset = Tag.objects.all()
  232. class TagBulkImportView(generic.BulkImportView):
  233. queryset = Tag.objects.all()
  234. model_form = forms.TagImportForm
  235. table = tables.TagTable
  236. class TagBulkEditView(generic.BulkEditView):
  237. queryset = Tag.objects.annotate(
  238. items=count_related(TaggedItem, 'tag')
  239. )
  240. table = tables.TagTable
  241. form = forms.TagBulkEditForm
  242. class TagBulkDeleteView(generic.BulkDeleteView):
  243. queryset = Tag.objects.annotate(
  244. items=count_related(TaggedItem, 'tag')
  245. )
  246. table = tables.TagTable
  247. #
  248. # Config contexts
  249. #
  250. class ConfigContextListView(generic.ObjectListView):
  251. queryset = ConfigContext.objects.all()
  252. filterset = filtersets.ConfigContextFilterSet
  253. filterset_form = forms.ConfigContextFilterForm
  254. table = tables.ConfigContextTable
  255. actions = ('add', 'bulk_edit', 'bulk_delete')
  256. @register_model_view(ConfigContext)
  257. class ConfigContextView(generic.ObjectView):
  258. queryset = ConfigContext.objects.all()
  259. def get_extra_context(self, request, instance):
  260. # Gather assigned objects for parsing in the template
  261. assigned_objects = (
  262. ('Regions', instance.regions.all),
  263. ('Site Groups', instance.site_groups.all),
  264. ('Sites', instance.sites.all),
  265. ('Locations', instance.locations.all),
  266. ('Device Types', instance.device_types.all),
  267. ('Roles', instance.roles.all),
  268. ('Platforms', instance.platforms.all),
  269. ('Cluster Types', instance.cluster_types.all),
  270. ('Cluster Groups', instance.cluster_groups.all),
  271. ('Clusters', instance.clusters.all),
  272. ('Tenant Groups', instance.tenant_groups.all),
  273. ('Tenants', instance.tenants.all),
  274. ('Tags', instance.tags.all),
  275. )
  276. # Determine user's preferred output format
  277. if request.GET.get('format') in ['json', 'yaml']:
  278. format = request.GET.get('format')
  279. if request.user.is_authenticated:
  280. request.user.config.set('data_format', format, commit=True)
  281. elif request.user.is_authenticated:
  282. format = request.user.config.get('data_format', 'json')
  283. else:
  284. format = 'json'
  285. return {
  286. 'assigned_objects': assigned_objects,
  287. 'format': format,
  288. }
  289. @register_model_view(ConfigContext, 'edit')
  290. class ConfigContextEditView(generic.ObjectEditView):
  291. queryset = ConfigContext.objects.all()
  292. form = forms.ConfigContextForm
  293. class ConfigContextBulkEditView(generic.BulkEditView):
  294. queryset = ConfigContext.objects.all()
  295. filterset = filtersets.ConfigContextFilterSet
  296. table = tables.ConfigContextTable
  297. form = forms.ConfigContextBulkEditForm
  298. @register_model_view(ConfigContext, 'delete')
  299. class ConfigContextDeleteView(generic.ObjectDeleteView):
  300. queryset = ConfigContext.objects.all()
  301. class ConfigContextBulkDeleteView(generic.BulkDeleteView):
  302. queryset = ConfigContext.objects.all()
  303. table = tables.ConfigContextTable
  304. class ObjectConfigContextView(generic.ObjectView):
  305. base_template = None
  306. template_name = 'extras/object_configcontext.html'
  307. def get_extra_context(self, request, instance):
  308. source_contexts = ConfigContext.objects.restrict(request.user, 'view').get_for_object(instance)
  309. # Determine user's preferred output format
  310. if request.GET.get('format') in ['json', 'yaml']:
  311. format = request.GET.get('format')
  312. if request.user.is_authenticated:
  313. request.user.config.set('data_format', format, commit=True)
  314. elif request.user.is_authenticated:
  315. format = request.user.config.get('data_format', 'json')
  316. else:
  317. format = 'json'
  318. return {
  319. 'rendered_context': instance.get_config_context(),
  320. 'source_contexts': source_contexts,
  321. 'format': format,
  322. 'base_template': self.base_template,
  323. }
  324. #
  325. # Change logging
  326. #
  327. class ObjectChangeListView(generic.ObjectListView):
  328. queryset = ObjectChange.objects.all()
  329. filterset = filtersets.ObjectChangeFilterSet
  330. filterset_form = forms.ObjectChangeFilterForm
  331. table = tables.ObjectChangeTable
  332. template_name = 'extras/objectchange_list.html'
  333. actions = ('export',)
  334. @register_model_view(ObjectChange)
  335. class ObjectChangeView(generic.ObjectView):
  336. queryset = ObjectChange.objects.all()
  337. def get_extra_context(self, request, instance):
  338. related_changes = ObjectChange.objects.restrict(request.user, 'view').filter(
  339. request_id=instance.request_id
  340. ).exclude(
  341. pk=instance.pk
  342. )
  343. related_changes_table = tables.ObjectChangeTable(
  344. data=related_changes[:50],
  345. orderable=False
  346. )
  347. objectchanges = ObjectChange.objects.restrict(request.user, 'view').filter(
  348. changed_object_type=instance.changed_object_type,
  349. changed_object_id=instance.changed_object_id,
  350. )
  351. next_change = objectchanges.filter(time__gt=instance.time).order_by('time').first()
  352. prev_change = objectchanges.filter(time__lt=instance.time).order_by('-time').first()
  353. if not instance.prechange_data and instance.action in ['update', 'delete'] and prev_change:
  354. non_atomic_change = True
  355. prechange_data = prev_change.postchange_data
  356. else:
  357. non_atomic_change = False
  358. prechange_data = instance.prechange_data
  359. if prechange_data and instance.postchange_data:
  360. diff_added = shallow_compare_dict(
  361. prechange_data or dict(),
  362. instance.postchange_data or dict(),
  363. exclude=['last_updated'],
  364. )
  365. diff_removed = {
  366. x: prechange_data.get(x) for x in diff_added
  367. } if prechange_data else {}
  368. else:
  369. diff_added = None
  370. diff_removed = None
  371. return {
  372. 'diff_added': diff_added,
  373. 'diff_removed': diff_removed,
  374. 'next_change': next_change,
  375. 'prev_change': prev_change,
  376. 'related_changes_table': related_changes_table,
  377. 'related_changes_count': related_changes.count(),
  378. 'non_atomic_change': non_atomic_change
  379. }
  380. #
  381. # Image attachments
  382. #
  383. @register_model_view(ImageAttachment, 'edit')
  384. class ImageAttachmentEditView(generic.ObjectEditView):
  385. queryset = ImageAttachment.objects.all()
  386. form = forms.ImageAttachmentForm
  387. template_name = 'extras/imageattachment_edit.html'
  388. def alter_object(self, instance, request, args, kwargs):
  389. if not instance.pk:
  390. # Assign the parent object based on URL kwargs
  391. content_type = get_object_or_404(ContentType, pk=request.GET.get('content_type'))
  392. instance.parent = get_object_or_404(content_type.model_class(), pk=request.GET.get('object_id'))
  393. return instance
  394. def get_return_url(self, request, obj=None):
  395. return obj.parent.get_absolute_url() if obj else super().get_return_url(request)
  396. def get_extra_addanother_params(self, request):
  397. return {
  398. 'content_type': request.GET.get('content_type'),
  399. 'object_id': request.GET.get('object_id'),
  400. }
  401. @register_model_view(ImageAttachment, 'delete')
  402. class ImageAttachmentDeleteView(generic.ObjectDeleteView):
  403. queryset = ImageAttachment.objects.all()
  404. def get_return_url(self, request, obj=None):
  405. return obj.parent.get_absolute_url() if obj else super().get_return_url(request)
  406. #
  407. # Journal entries
  408. #
  409. class JournalEntryListView(generic.ObjectListView):
  410. queryset = JournalEntry.objects.all()
  411. filterset = filtersets.JournalEntryFilterSet
  412. filterset_form = forms.JournalEntryFilterForm
  413. table = tables.JournalEntryTable
  414. actions = ('export', 'bulk_edit', 'bulk_delete')
  415. @register_model_view(JournalEntry)
  416. class JournalEntryView(generic.ObjectView):
  417. queryset = JournalEntry.objects.all()
  418. @register_model_view(JournalEntry, 'edit')
  419. class JournalEntryEditView(generic.ObjectEditView):
  420. queryset = JournalEntry.objects.all()
  421. form = forms.JournalEntryForm
  422. def alter_object(self, obj, request, args, kwargs):
  423. if not obj.pk:
  424. obj.created_by = request.user
  425. return obj
  426. def get_return_url(self, request, instance):
  427. if not instance.assigned_object:
  428. return reverse('extras:journalentry_list')
  429. obj = instance.assigned_object
  430. viewname = get_viewname(obj, 'journal')
  431. return reverse(viewname, kwargs={'pk': obj.pk})
  432. @register_model_view(JournalEntry, 'delete')
  433. class JournalEntryDeleteView(generic.ObjectDeleteView):
  434. queryset = JournalEntry.objects.all()
  435. def get_return_url(self, request, instance):
  436. obj = instance.assigned_object
  437. viewname = get_viewname(obj, 'journal')
  438. return reverse(viewname, kwargs={'pk': obj.pk})
  439. class JournalEntryBulkEditView(generic.BulkEditView):
  440. queryset = JournalEntry.objects.all()
  441. filterset = filtersets.JournalEntryFilterSet
  442. table = tables.JournalEntryTable
  443. form = forms.JournalEntryBulkEditForm
  444. class JournalEntryBulkDeleteView(generic.BulkDeleteView):
  445. queryset = JournalEntry.objects.all()
  446. filterset = filtersets.JournalEntryFilterSet
  447. table = tables.JournalEntryTable
  448. #
  449. # Reports
  450. #
  451. class ReportListView(ContentTypePermissionRequiredMixin, View):
  452. """
  453. Retrieve all of the available reports from disk and the recorded JobResult (if any) for each.
  454. """
  455. def get_required_permission(self):
  456. return 'extras.view_report'
  457. def get(self, request):
  458. reports = get_reports()
  459. report_content_type = ContentType.objects.get(app_label='extras', model='report')
  460. results = {
  461. r.name: r
  462. for r in JobResult.objects.filter(
  463. obj_type=report_content_type,
  464. status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES
  465. ).order_by('name', '-created').distinct('name').defer('data')
  466. }
  467. ret = []
  468. for module, report_list in reports.items():
  469. module_reports = []
  470. for report in report_list.values():
  471. report.result = results.get(report.full_name, None)
  472. module_reports.append(report)
  473. ret.append((module, module_reports))
  474. return render(request, 'extras/report_list.html', {
  475. 'reports': ret,
  476. })
  477. class ReportView(ContentTypePermissionRequiredMixin, View):
  478. """
  479. Display a single Report and its associated JobResult (if any).
  480. """
  481. def get_required_permission(self):
  482. return 'extras.view_report'
  483. def get(self, request, module, name):
  484. report = get_report(module, name)
  485. if report is None:
  486. raise Http404
  487. report_content_type = ContentType.objects.get(app_label='extras', model='report')
  488. report.result = JobResult.objects.filter(
  489. obj_type=report_content_type,
  490. name=report.full_name,
  491. status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES
  492. ).first()
  493. return render(request, 'extras/report.html', {
  494. 'report': report,
  495. 'form': ReportForm(),
  496. })
  497. def post(self, request, module, name):
  498. # Permissions check
  499. if not request.user.has_perm('extras.run_report'):
  500. return HttpResponseForbidden()
  501. report = get_report(module, name)
  502. if report is None:
  503. raise Http404
  504. form = ReportForm(request.POST)
  505. if form.is_valid():
  506. # Allow execution only if RQ worker process is running
  507. if not Worker.count(get_connection('default')):
  508. messages.error(request, "Unable to run report: RQ worker process not running.")
  509. return render(request, 'extras/report.html', {
  510. 'report': report,
  511. })
  512. # Run the Report. A new JobResult is created.
  513. job_result = JobResult.enqueue_job(
  514. run_report,
  515. name=report.full_name,
  516. obj_type=ContentType.objects.get_for_model(Report),
  517. user=request.user,
  518. schedule_at=form.cleaned_data.get('schedule_at'),
  519. interval=form.cleaned_data.get('interval'),
  520. job_timeout=report.job_timeout
  521. )
  522. return redirect('extras:report_result', job_result_pk=job_result.pk)
  523. return render(request, 'extras/report.html', {
  524. 'report': report,
  525. 'form': form,
  526. })
  527. class ReportResultView(ContentTypePermissionRequiredMixin, View):
  528. """
  529. Display a JobResult pertaining to the execution of a Report.
  530. """
  531. def get_required_permission(self):
  532. return 'extras.view_report'
  533. def get(self, request, job_result_pk):
  534. report_content_type = ContentType.objects.get(app_label='extras', model='report')
  535. result = get_object_or_404(JobResult.objects.all(), pk=job_result_pk, obj_type=report_content_type)
  536. # Retrieve the Report and attach the JobResult to it
  537. module, report_name = result.name.split('.', maxsplit=1)
  538. report = get_report(module, report_name)
  539. report.result = result
  540. # If this is an HTMX request, return only the result HTML
  541. if is_htmx(request):
  542. response = render(request, 'extras/htmx/report_result.html', {
  543. 'report': report,
  544. 'result': result,
  545. })
  546. if result.completed or not result.started:
  547. response.status_code = 286
  548. return response
  549. return render(request, 'extras/report_result.html', {
  550. 'report': report,
  551. 'result': result,
  552. })
  553. #
  554. # Scripts
  555. #
  556. class GetScriptMixin:
  557. def _get_script(self, name, module=None):
  558. if module is None:
  559. module, name = name.split('.', 1)
  560. scripts = get_scripts()
  561. try:
  562. return scripts[module][name]()
  563. except KeyError:
  564. raise Http404
  565. class ScriptListView(ContentTypePermissionRequiredMixin, View):
  566. def get_required_permission(self):
  567. return 'extras.view_script'
  568. def get(self, request):
  569. scripts = get_scripts(use_names=True)
  570. script_content_type = ContentType.objects.get(app_label='extras', model='script')
  571. results = {
  572. r.name: r
  573. for r in JobResult.objects.filter(
  574. obj_type=script_content_type,
  575. status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES
  576. ).order_by('name', '-created').distinct('name').defer('data')
  577. }
  578. for _scripts in scripts.values():
  579. for script in _scripts.values():
  580. script.result = results.get(script.full_name)
  581. return render(request, 'extras/script_list.html', {
  582. 'scripts': scripts,
  583. })
  584. class ScriptView(ContentTypePermissionRequiredMixin, GetScriptMixin, View):
  585. def get_required_permission(self):
  586. return 'extras.view_script'
  587. def get(self, request, module, name):
  588. script = self._get_script(name, module)
  589. form = script.as_form(initial=normalize_querydict(request.GET))
  590. # Look for a pending JobResult (use the latest one by creation timestamp)
  591. script.result = JobResult.objects.filter(
  592. obj_type=ContentType.objects.get_for_model(Script),
  593. name=script.full_name,
  594. ).exclude(
  595. status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES
  596. ).first()
  597. return render(request, 'extras/script.html', {
  598. 'module': module,
  599. 'script': script,
  600. 'form': form,
  601. })
  602. def post(self, request, module, name):
  603. # Permissions check
  604. if not request.user.has_perm('extras.run_script'):
  605. return HttpResponseForbidden()
  606. script = self._get_script(name, module)
  607. form = script.as_form(request.POST, request.FILES)
  608. # Allow execution only if RQ worker process is running
  609. if not Worker.count(get_connection('default')):
  610. messages.error(request, "Unable to run script: RQ worker process not running.")
  611. elif form.is_valid():
  612. job_result = JobResult.enqueue_job(
  613. run_script,
  614. name=script.full_name,
  615. obj_type=ContentType.objects.get_for_model(Script),
  616. user=request.user,
  617. schedule_at=form.cleaned_data.pop('_schedule_at'),
  618. interval=form.cleaned_data.pop('_interval'),
  619. data=form.cleaned_data,
  620. request=copy_safe_request(request),
  621. job_timeout=script.job_timeout,
  622. commit=form.cleaned_data.pop('_commit')
  623. )
  624. return redirect('extras:script_result', job_result_pk=job_result.pk)
  625. return render(request, 'extras/script.html', {
  626. 'module': module,
  627. 'script': script,
  628. 'form': form,
  629. })
  630. class ScriptResultView(ContentTypePermissionRequiredMixin, GetScriptMixin, View):
  631. def get_required_permission(self):
  632. return 'extras.view_script'
  633. def get(self, request, job_result_pk):
  634. result = get_object_or_404(JobResult.objects.all(), pk=job_result_pk)
  635. script_content_type = ContentType.objects.get(app_label='extras', model='script')
  636. if result.obj_type != script_content_type:
  637. raise Http404
  638. script = self._get_script(result.name)
  639. # If this is an HTMX request, return only the result HTML
  640. if is_htmx(request):
  641. response = render(request, 'extras/htmx/script_result.html', {
  642. 'script': script,
  643. 'result': result,
  644. })
  645. if result.completed or not result.started:
  646. response.status_code = 286
  647. return response
  648. return render(request, 'extras/script_result.html', {
  649. 'script': script,
  650. 'result': result,
  651. 'class_name': script.__class__.__name__
  652. })
  653. #
  654. # Job results
  655. #
  656. class JobResultListView(generic.ObjectListView):
  657. queryset = JobResult.objects.all()
  658. filterset = filtersets.JobResultFilterSet
  659. filterset_form = forms.JobResultFilterForm
  660. table = tables.JobResultTable
  661. actions = ('export', 'delete', 'bulk_delete', )
  662. class JobResultDeleteView(generic.ObjectDeleteView):
  663. queryset = JobResult.objects.all()
  664. class JobResultBulkDeleteView(generic.BulkDeleteView):
  665. queryset = JobResult.objects.all()
  666. filterset = filtersets.JobResultFilterSet
  667. table = tables.JobResultTable
  668. #
  669. # Markdown
  670. #
  671. class RenderMarkdownView(View):
  672. def post(self, request):
  673. form = forms.RenderMarkdownForm(request.POST)
  674. if not form.is_valid():
  675. HttpResponseBadRequest()
  676. rendered = render_markdown(form.cleaned_data['text'])
  677. return HttpResponse(rendered)