views.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885
  1. import json
  2. import platform
  3. from copy import deepcopy
  4. from django import __version__ as django_version
  5. from django.apps import apps as django_apps_registry
  6. from django.conf import settings
  7. from django.contrib import messages
  8. from django.contrib.auth.mixins import UserPassesTestMixin
  9. from django.core.cache import cache
  10. from django.db import DatabaseError, connection
  11. from django.http import Http404, HttpResponse, HttpResponseForbidden
  12. from django.shortcuts import get_object_or_404, redirect, render
  13. from django.urls import reverse
  14. from django.utils.translation import gettext_lazy as _
  15. from django.views.generic import View
  16. from django_rq.queues import get_connection, get_queue_by_index, get_redis_connection
  17. from django_rq.settings import get_queues_list, get_queues_map
  18. from django_rq.utils import get_statistics
  19. from rq.exceptions import NoSuchJobError
  20. from rq.job import Job as RQ_Job
  21. from rq.job import JobStatus as RQJobStatus
  22. from rq.worker import Worker
  23. from rq.worker_registration import clean_worker_registry
  24. from core.utils import (
  25. delete_rq_job,
  26. enqueue_rq_job,
  27. get_db_schema,
  28. get_rq_jobs_from_status,
  29. requeue_rq_job,
  30. stop_rq_job,
  31. )
  32. from extras.ui.panels import CustomFieldsPanel, TagsPanel
  33. from netbox.config import PARAMS, get_config
  34. from netbox.object_actions import AddObject, BulkDelete, BulkExport, DeleteObject
  35. from netbox.plugins import PluginConfig
  36. from netbox.plugins.utils import get_installed_plugins
  37. from netbox.ui import layout
  38. from netbox.ui.panels import (
  39. CommentsPanel,
  40. ContextTablePanel,
  41. JSONPanel,
  42. ObjectsTablePanel,
  43. PluginContentPanel,
  44. RelatedObjectsPanel,
  45. TemplatePanel,
  46. )
  47. from netbox.views import generic
  48. from netbox.views.generic.base import BaseObjectView
  49. from netbox.views.generic.mixins import TableMixin
  50. from utilities.apps import get_installed_apps
  51. from utilities.data import deep_compare_dict
  52. from utilities.forms import ConfirmationForm
  53. from utilities.htmx import htmx_partial
  54. from utilities.json import ConfigJSONEncoder
  55. from utilities.query import count_related
  56. from utilities.views import (
  57. ContentTypePermissionRequiredMixin,
  58. GetRelatedModelsMixin,
  59. GetReturnURLMixin,
  60. ViewTab,
  61. register_model_view,
  62. )
  63. from . import filtersets, forms, tables
  64. from .jobs import SyncDataSourceJob
  65. from .models import *
  66. from .plugins import get_catalog_plugins, get_local_plugins
  67. from .tables import CatalogPluginTable, JobLogEntryTable, PluginVersionTable
  68. from .ui import panels
  69. #
  70. # Data sources
  71. #
  72. @register_model_view(DataSource, 'list', path='', detail=False)
  73. class DataSourceListView(generic.ObjectListView):
  74. queryset = DataSource.objects.annotate(
  75. file_count=count_related(DataFile, 'source')
  76. )
  77. filterset = filtersets.DataSourceFilterSet
  78. filterset_form = forms.DataSourceFilterForm
  79. table = tables.DataSourceTable
  80. @register_model_view(DataSource)
  81. class DataSourceView(GetRelatedModelsMixin, generic.ObjectView):
  82. queryset = DataSource.objects.all()
  83. layout = layout.SimpleLayout(
  84. left_panels=[
  85. panels.DataSourcePanel(),
  86. TagsPanel(),
  87. CommentsPanel(),
  88. ],
  89. right_panels=[
  90. panels.DataSourceBackendPanel(),
  91. RelatedObjectsPanel(),
  92. CustomFieldsPanel(),
  93. ],
  94. bottom_panels=[
  95. ObjectsTablePanel(
  96. model='core.DataFile',
  97. filters={'source_id': lambda ctx: ctx['object'].pk},
  98. exclude_columns=['source'],
  99. ),
  100. ],
  101. )
  102. def get_extra_context(self, request, instance):
  103. return {
  104. 'related_models': self.get_related_models(request, instance),
  105. }
  106. @register_model_view(DataSource, 'sync')
  107. class DataSourceSyncView(GetReturnURLMixin, BaseObjectView):
  108. queryset = DataSource.objects.all()
  109. def get_required_permission(self):
  110. return 'core.sync_datasource'
  111. def get(self, request, pk):
  112. # Redirect GET requests to the object view
  113. datasource = get_object_or_404(self.queryset, pk=pk)
  114. return redirect(datasource.get_absolute_url())
  115. def post(self, request, pk):
  116. datasource = get_object_or_404(self.queryset, pk=pk)
  117. # Enqueue the sync job
  118. job = SyncDataSourceJob.enqueue(instance=datasource, user=request.user)
  119. messages.success(
  120. request,
  121. _("Queued job #{id} to sync {datasource}").format(id=job.pk, datasource=datasource)
  122. )
  123. return redirect(self.get_return_url(request, datasource))
  124. @register_model_view(DataSource, 'add', detail=False)
  125. @register_model_view(DataSource, 'edit')
  126. class DataSourceEditView(generic.ObjectEditView):
  127. queryset = DataSource.objects.all()
  128. form = forms.DataSourceForm
  129. @register_model_view(DataSource, 'delete')
  130. class DataSourceDeleteView(generic.ObjectDeleteView):
  131. queryset = DataSource.objects.all()
  132. @register_model_view(DataSource, 'bulk_import', path='import', detail=False)
  133. class DataSourceBulkImportView(generic.BulkImportView):
  134. queryset = DataSource.objects.all()
  135. model_form = forms.DataSourceImportForm
  136. @register_model_view(DataSource, 'bulk_edit', path='edit', detail=False)
  137. class DataSourceBulkEditView(generic.BulkEditView):
  138. queryset = DataSource.objects.annotate(
  139. count_files=count_related(DataFile, 'source')
  140. )
  141. filterset = filtersets.DataSourceFilterSet
  142. table = tables.DataSourceTable
  143. form = forms.DataSourceBulkEditForm
  144. @register_model_view(DataSource, 'bulk_rename', path='rename', detail=False)
  145. class DataSourceBulkRenameView(generic.BulkRenameView):
  146. queryset = DataSource.objects.all()
  147. filterset = filtersets.DataSourceFilterSet
  148. @register_model_view(DataSource, 'bulk_delete', path='delete', detail=False)
  149. class DataSourceBulkDeleteView(generic.BulkDeleteView):
  150. queryset = DataSource.objects.annotate(
  151. count_files=count_related(DataFile, 'source')
  152. )
  153. filterset = filtersets.DataSourceFilterSet
  154. table = tables.DataSourceTable
  155. #
  156. # Data files
  157. #
  158. @register_model_view(DataFile, 'list', path='', detail=False)
  159. class DataFileListView(generic.ObjectListView):
  160. queryset = DataFile.objects.defer('data')
  161. filterset = filtersets.DataFileFilterSet
  162. filterset_form = forms.DataFileFilterForm
  163. table = tables.DataFileTable
  164. actions = (BulkDelete,)
  165. @register_model_view(DataFile)
  166. class DataFileView(generic.ObjectView):
  167. queryset = DataFile.objects.all()
  168. actions = (DeleteObject,)
  169. layout = layout.Layout(
  170. layout.Row(
  171. layout.Column(
  172. panels.DataFilePanel(),
  173. panels.DataFileContentPanel(),
  174. PluginContentPanel('left_page'),
  175. ),
  176. ),
  177. layout.Row(
  178. layout.Column(
  179. PluginContentPanel('full_width_page'),
  180. ),
  181. ),
  182. )
  183. @register_model_view(DataFile, 'delete')
  184. class DataFileDeleteView(generic.ObjectDeleteView):
  185. queryset = DataFile.objects.all()
  186. @register_model_view(DataFile, 'bulk_delete', path='delete', detail=False)
  187. class DataFileBulkDeleteView(generic.BulkDeleteView):
  188. queryset = DataFile.objects.defer('data')
  189. filterset = filtersets.DataFileFilterSet
  190. table = tables.DataFileTable
  191. #
  192. # Jobs
  193. #
  194. @register_model_view(Job, 'list', path='', detail=False)
  195. class JobListView(generic.ObjectListView):
  196. queryset = Job.objects.defer('data')
  197. filterset = filtersets.JobFilterSet
  198. filterset_form = forms.JobFilterForm
  199. table = tables.JobTable
  200. actions = (BulkExport, BulkDelete)
  201. @register_model_view(Job)
  202. class JobView(generic.ObjectView):
  203. queryset = Job.objects.all()
  204. actions = (DeleteObject,)
  205. layout = layout.SimpleLayout(
  206. left_panels=[
  207. panels.JobPanel(),
  208. ],
  209. right_panels=[
  210. panels.JobSchedulingPanel(),
  211. ],
  212. bottom_panels=[
  213. JSONPanel('data', title=_('Data')),
  214. ],
  215. )
  216. @register_model_view(Job, 'log')
  217. class JobLogView(generic.ObjectView):
  218. queryset = Job.objects.all()
  219. actions = (DeleteObject,)
  220. template_name = 'core/job/log.html'
  221. tab = ViewTab(
  222. label=_('Log'),
  223. badge=lambda obj: len(obj.log_entries),
  224. weight=500,
  225. )
  226. layout = layout.Layout(
  227. layout.Row(
  228. layout.Column(
  229. ContextTablePanel('table', title=_('Log Entries')),
  230. PluginContentPanel('left_page'),
  231. ),
  232. ),
  233. layout.Row(
  234. layout.Column(
  235. PluginContentPanel('full_width_page'),
  236. ),
  237. ),
  238. )
  239. def get_extra_context(self, request, instance):
  240. table = JobLogEntryTable(instance.log_entries)
  241. table.configure(request)
  242. return {
  243. 'table': table,
  244. }
  245. @register_model_view(Job, 'delete')
  246. class JobDeleteView(generic.ObjectDeleteView):
  247. queryset = Job.objects.defer('data')
  248. @register_model_view(Job, 'bulk_delete', path='delete', detail=False)
  249. class JobBulkDeleteView(generic.BulkDeleteView):
  250. queryset = Job.objects.defer('data')
  251. filterset = filtersets.JobFilterSet
  252. table = tables.JobTable
  253. #
  254. # Change logging
  255. #
  256. @register_model_view(ObjectChange, 'list', path='', detail=False)
  257. class ObjectChangeListView(generic.ObjectListView):
  258. queryset = None
  259. filterset = filtersets.ObjectChangeFilterSet
  260. filterset_form = forms.ObjectChangeFilterForm
  261. table = tables.ObjectChangeTable
  262. template_name = 'core/objectchange_list.html'
  263. actions = (BulkExport,)
  264. def get_queryset(self, request):
  265. return ObjectChange.objects.valid_models()
  266. @register_model_view(ObjectChange)
  267. class ObjectChangeView(generic.ObjectView):
  268. queryset = None
  269. layout = layout.Layout(
  270. layout.Row(
  271. layout.Column(panels.ObjectChangePanel()),
  272. layout.Column(TemplatePanel('core/panels/objectchange_difference.html')),
  273. ),
  274. layout.Row(
  275. layout.Column(TemplatePanel('core/panels/objectchange_prechange.html')),
  276. layout.Column(TemplatePanel('core/panels/objectchange_postchange.html')),
  277. ),
  278. layout.Row(
  279. layout.Column(PluginContentPanel('left_page')),
  280. layout.Column(PluginContentPanel('right_page')),
  281. ),
  282. layout.Row(
  283. layout.Column(
  284. TemplatePanel('core/panels/objectchange_related.html'),
  285. PluginContentPanel('full_width_page'),
  286. ),
  287. ),
  288. )
  289. def get_queryset(self, request):
  290. return ObjectChange.objects.valid_models()
  291. def get_extra_context(self, request, instance):
  292. related_changes = ObjectChange.objects.valid_models().restrict(request.user, 'view').filter(
  293. request_id=instance.request_id
  294. ).exclude(
  295. pk=instance.pk
  296. )
  297. related_changes_table = tables.ObjectChangeTable(
  298. data=related_changes[:50],
  299. orderable=False
  300. )
  301. related_changes_table.configure(request)
  302. objectchanges = ObjectChange.objects.valid_models().restrict(request.user, 'view').filter(
  303. changed_object_type=instance.changed_object_type,
  304. changed_object_id=instance.changed_object_id,
  305. )
  306. next_change = objectchanges.filter(time__gt=instance.time).order_by('time').first()
  307. prev_change = objectchanges.filter(time__lt=instance.time).order_by('-time').first()
  308. if not instance.prechange_data and instance.action in ['update', 'delete'] and prev_change:
  309. non_atomic_change = True
  310. prechange_data = prev_change.postchange_data_clean
  311. else:
  312. non_atomic_change = False
  313. prechange_data = instance.prechange_data_clean
  314. if prechange_data and instance.postchange_data:
  315. diff_added, diff_removed = deep_compare_dict(
  316. prechange_data,
  317. instance.postchange_data_clean,
  318. exclude=['last_updated'],
  319. )
  320. else:
  321. diff_added = {}
  322. diff_removed = {}
  323. return {
  324. 'diff_added': diff_added,
  325. 'diff_removed': diff_removed,
  326. 'next_change': next_change,
  327. 'prev_change': prev_change,
  328. 'related_changes_table': related_changes_table,
  329. 'related_changes_count': related_changes.count(),
  330. 'non_atomic_change': non_atomic_change
  331. }
  332. #
  333. # Config Revisions
  334. #
  335. @register_model_view(ConfigRevision, 'list', path='', detail=False)
  336. class ConfigRevisionListView(generic.ObjectListView):
  337. queryset = ConfigRevision.objects.all()
  338. filterset = filtersets.ConfigRevisionFilterSet
  339. filterset_form = forms.ConfigRevisionFilterForm
  340. table = tables.ConfigRevisionTable
  341. actions = (AddObject, BulkExport)
  342. @register_model_view(ConfigRevision)
  343. class ConfigRevisionView(generic.ObjectView):
  344. queryset = ConfigRevision.objects.all()
  345. layout = layout.Layout(
  346. layout.Row(
  347. layout.Column(
  348. TemplatePanel('core/panels/configrevision_data.html'),
  349. TemplatePanel('core/panels/configrevision_comment.html'),
  350. PluginContentPanel('left_page'),
  351. ),
  352. ),
  353. layout.Row(
  354. layout.Column(
  355. PluginContentPanel('full_width_page'),
  356. ),
  357. ),
  358. )
  359. def get_extra_context(self, request, instance):
  360. """
  361. Retrieve additional context for a given request and instance.
  362. """
  363. # Copy the revision data to avoid modifying the original
  364. config = deepcopy(instance.data or {})
  365. # Serialize any JSON-based classes
  366. for attr in ['CUSTOM_VALIDATORS', 'DEFAULT_USER_PREFERENCES', 'PROTECTION_RULES']:
  367. if attr in config:
  368. config[attr] = json.dumps(config[attr], cls=ConfigJSONEncoder, indent=4)
  369. return {
  370. 'config': config,
  371. }
  372. @register_model_view(ConfigRevision, 'add', detail=False)
  373. class ConfigRevisionEditView(generic.ObjectEditView):
  374. queryset = ConfigRevision.objects.all()
  375. form = forms.ConfigRevisionForm
  376. @register_model_view(ConfigRevision, 'delete')
  377. class ConfigRevisionDeleteView(generic.ObjectDeleteView):
  378. queryset = ConfigRevision.objects.all()
  379. @register_model_view(ConfigRevision, 'bulk_delete', path='delete', detail=False)
  380. class ConfigRevisionBulkDeleteView(generic.BulkDeleteView):
  381. queryset = ConfigRevision.objects.all()
  382. filterset = filtersets.ConfigRevisionFilterSet
  383. table = tables.ConfigRevisionTable
  384. @register_model_view(ConfigRevision, 'restore')
  385. class ConfigRevisionRestoreView(ContentTypePermissionRequiredMixin, View):
  386. def get_required_permission(self):
  387. return 'core.configrevision_edit'
  388. def get(self, request, pk):
  389. candidate_config = get_object_or_404(ConfigRevision, pk=pk)
  390. # Get the current ConfigRevision
  391. config_version = get_config().version
  392. current_config = ConfigRevision.objects.filter(pk=config_version).first()
  393. params = []
  394. for param in PARAMS:
  395. params.append((
  396. param.name,
  397. current_config.data.get(param.name, None) if current_config else None,
  398. candidate_config.data.get(param.name, None)
  399. ))
  400. return render(request, 'core/configrevision_restore.html', {
  401. 'object': candidate_config,
  402. 'params': params,
  403. })
  404. def post(self, request, pk):
  405. if not request.user.has_perm('core.configrevision_edit'):
  406. return HttpResponseForbidden()
  407. candidate_config = get_object_or_404(ConfigRevision, pk=pk)
  408. candidate_config.activate()
  409. messages.success(request, _("Restored configuration revision #{id}").format(id=pk))
  410. return redirect(candidate_config.get_absolute_url())
  411. #
  412. # Background Tasks (RQ)
  413. #
  414. class BaseRQView(UserPassesTestMixin, View):
  415. def test_func(self):
  416. return self.request.user.is_superuser
  417. class BackgroundQueueListView(TableMixin, BaseRQView):
  418. table = tables.BackgroundQueueTable
  419. def get(self, request):
  420. data = get_statistics(run_maintenance_tasks=True)["queues"]
  421. table = self.get_table(data, request, bulk_actions=False)
  422. return render(request, 'core/rq_queue_list.html', {
  423. 'table': table,
  424. })
  425. class BackgroundTaskListView(TableMixin, BaseRQView):
  426. table = tables.BackgroundTaskTable
  427. def get_table_data(self, request, queue, status):
  428. # Call get_jobs() to returned queued tasks
  429. if status == RQJobStatus.QUEUED:
  430. return queue.get_jobs()
  431. return get_rq_jobs_from_status(queue, status)
  432. def get(self, request, queue_index, status):
  433. queue = get_queue_by_index(queue_index)
  434. data = self.get_table_data(request, queue, status)
  435. table = self.get_table(data, request, False)
  436. # If this is an HTMX request, return only the rendered table HTML
  437. if htmx_partial(request):
  438. return render(request, 'htmx/table.html', {
  439. 'table': table,
  440. })
  441. return render(request, 'core/rq_task_list.html', {
  442. 'table': table,
  443. 'queue': queue,
  444. 'status': status,
  445. })
  446. class BackgroundTaskView(BaseRQView):
  447. def get(self, request, job_id):
  448. # all the RQ queues should use the same connection
  449. config = get_queues_list()[0]
  450. try:
  451. job = RQ_Job.fetch(job_id, connection=get_redis_connection(config['connection_config']),)
  452. except NoSuchJobError:
  453. raise Http404(_("Job {job_id} not found").format(job_id=job_id))
  454. queue_index = get_queues_map()[job.origin]
  455. queue = get_queue_by_index(queue_index)
  456. try:
  457. exc_info = job._exc_info
  458. except AttributeError:
  459. exc_info = None
  460. return render(request, 'core/rq_task.html', {
  461. 'queue': queue,
  462. 'job': job,
  463. 'queue_index': queue_index,
  464. 'dependency_id': job._dependency_id,
  465. 'exc_info': exc_info,
  466. })
  467. class BackgroundTaskDeleteView(BaseRQView):
  468. def get(self, request, job_id):
  469. if not request.htmx:
  470. return redirect(reverse('core:background_queue_list'))
  471. form = ConfirmationForm(initial=request.GET)
  472. return render(request, 'htmx/delete_form.html', {
  473. 'object_type': 'background task',
  474. 'object': job_id,
  475. 'form': form,
  476. 'form_url': reverse('core:background_task_delete', kwargs={'job_id': job_id})
  477. })
  478. def post(self, request, job_id):
  479. form = ConfirmationForm(request.POST)
  480. if form.is_valid():
  481. delete_rq_job(job_id)
  482. messages.success(request, _('Job {id} has been deleted.').format(id=job_id))
  483. else:
  484. messages.error(request, _('Error deleting job {id}: {error}').format(id=job_id, error=form.errors[0]))
  485. return redirect(reverse('core:background_queue_list'))
  486. class BackgroundTaskRequeueView(BaseRQView):
  487. def get(self, request, job_id):
  488. requeue_rq_job(job_id)
  489. messages.success(request, _('Job {id} has been re-enqueued.').format(id=job_id))
  490. return redirect(reverse('core:background_task', args=[job_id]))
  491. class BackgroundTaskEnqueueView(BaseRQView):
  492. def get(self, request, job_id):
  493. # all the RQ queues should use the same connection
  494. enqueue_rq_job(job_id)
  495. messages.success(request, _('Job {id} has been enqueued.').format(id=job_id))
  496. return redirect(reverse('core:background_task', args=[job_id]))
  497. class BackgroundTaskStopView(BaseRQView):
  498. def get(self, request, job_id):
  499. stopped_jobs = stop_rq_job(job_id)
  500. if len(stopped_jobs) == 1:
  501. messages.success(request, _('Job {id} has been stopped.').format(id=job_id))
  502. else:
  503. messages.error(request, _('Failed to stop job {id}').format(id=job_id))
  504. return redirect(reverse('core:background_task', args=[job_id]))
  505. class WorkerListView(TableMixin, BaseRQView):
  506. table = tables.WorkerTable
  507. def get_table_data(self, request, queue):
  508. clean_worker_registry(queue)
  509. all_workers = Worker.all(queue.connection)
  510. workers = [worker for worker in all_workers if queue.name in worker.queue_names()]
  511. return workers
  512. def get(self, request, queue_index):
  513. queue = get_queue_by_index(queue_index)
  514. data = self.get_table_data(request, queue)
  515. table = self.get_table(data, request, False)
  516. # If this is an HTMX request, return only the rendered table HTML
  517. if htmx_partial(request):
  518. if not request.htmx.target:
  519. table.embedded = True
  520. # Hide selection checkboxes
  521. if 'pk' in table.base_columns:
  522. table.columns.hide('pk')
  523. return render(request, 'htmx/table.html', {
  524. 'table': table,
  525. 'queue': queue,
  526. })
  527. return render(request, 'core/rq_worker_list.html', {
  528. 'table': table,
  529. 'queue': queue,
  530. })
  531. class WorkerView(BaseRQView):
  532. def get(self, request, key):
  533. # all the RQ queues should use the same connection
  534. config = get_queues_list()[0]
  535. worker = Worker.find_by_key('rq:worker:' + key, connection=get_redis_connection(config['connection_config']))
  536. # Convert microseconds to milliseconds
  537. worker.total_working_time = worker.total_working_time / 1000
  538. return render(request, 'core/rq_worker.html', {
  539. 'worker': worker,
  540. 'job': worker.get_current_job(),
  541. 'total_working_time': worker.total_working_time * 1000,
  542. })
  543. #
  544. # System
  545. #
  546. class SystemView(UserPassesTestMixin, View):
  547. def test_func(self):
  548. return self.request.user.is_superuser
  549. def _get_stats(self):
  550. psql_version = db_name = db_size = None
  551. try:
  552. with connection.cursor() as cursor:
  553. cursor.execute("SELECT version()")
  554. psql_version = cursor.fetchone()[0]
  555. psql_version = psql_version.split('(')[0].strip()
  556. cursor.execute("SELECT current_database()")
  557. db_name = cursor.fetchone()[0]
  558. cursor.execute("SELECT pg_size_pretty(pg_database_size(current_database()))")
  559. db_size = cursor.fetchone()[0]
  560. except (DatabaseError, IndexError):
  561. pass
  562. return {
  563. 'netbox_release': settings.RELEASE,
  564. 'django_version': django_version,
  565. 'python_version': platform.python_version(),
  566. 'postgresql_version': psql_version,
  567. 'database_name': db_name,
  568. 'database_size': db_size,
  569. 'rq_worker_count': Worker.count(get_connection('default')),
  570. }
  571. def _get_object_counts(self):
  572. objects = {}
  573. for ot in ObjectType.objects.public().order_by('app_label', 'model'):
  574. if model := ot.model_class():
  575. objects[ot] = model.objects.count()
  576. return objects
  577. def get(self, request):
  578. stats = self._get_stats()
  579. django_apps = get_installed_apps()
  580. config = get_config()
  581. plugins = get_installed_plugins()
  582. objects = self._get_object_counts()
  583. # Raw data export
  584. if 'export' in request.GET:
  585. db_schema = get_db_schema()
  586. stats['netbox_release'] = stats['netbox_release'].asdict()
  587. params = [param.name for param in PARAMS]
  588. data = {
  589. **stats,
  590. 'django_apps': django_apps,
  591. 'plugins': plugins,
  592. 'config': {
  593. k: getattr(config, k) for k in sorted(params)
  594. },
  595. 'objects': {
  596. f'{ot.app_label}.{ot.model}': count for ot, count in objects.items()
  597. },
  598. 'db_schema': {
  599. table['name']: {
  600. 'columns': table['columns'],
  601. 'indexes': table['indexes'],
  602. } for table in db_schema
  603. },
  604. }
  605. response = HttpResponse(json.dumps(data, cls=ConfigJSONEncoder, indent=4), content_type='text/json')
  606. response['Content-Disposition'] = 'attachment; filename="netbox.json"'
  607. return response
  608. # Serialize any JSON-based classes
  609. for attr in ['CUSTOM_VALIDATORS', 'DEFAULT_USER_PREFERENCES', 'PROTECTION_RULES']:
  610. if hasattr(config, attr) and getattr(config, attr, None):
  611. setattr(config, attr, json.dumps(getattr(config, attr), cls=ConfigJSONEncoder, indent=4))
  612. return render(request, 'core/system.html', {
  613. 'stats': stats,
  614. 'django_apps': django_apps,
  615. 'config': config,
  616. 'plugins': plugins,
  617. 'objects': objects,
  618. })
  619. class SystemDBSchemaView(UserPassesTestMixin, View):
  620. def test_func(self):
  621. return self.request.user.is_superuser
  622. @staticmethod
  623. def _get_db_schema_groups(db_schema):
  624. plugin_app_labels = {
  625. app_config.label
  626. for app_config in django_apps_registry.get_app_configs()
  627. if isinstance(app_config, PluginConfig)
  628. }
  629. # Sort longest-first so "netbox_branching" matches before "netbox"
  630. sorted_plugin_labels = sorted(plugin_app_labels, key=len, reverse=True)
  631. groups = {}
  632. for table in db_schema:
  633. matched_plugin = next(
  634. (label for label in sorted_plugin_labels if table['name'].startswith(label + '_')),
  635. None,
  636. )
  637. if matched_plugin:
  638. prefix = matched_plugin
  639. elif '_' in table['name']:
  640. prefix = table['name'].split('_')[0]
  641. else:
  642. prefix = 'other'
  643. groups.setdefault(prefix, []).append(table)
  644. return sorted(
  645. [
  646. {
  647. 'name': name,
  648. 'tables': tables,
  649. 'index_count': sum(len(t['indexes']) for t in tables),
  650. 'is_plugin': name in plugin_app_labels,
  651. }
  652. for name, tables in groups.items()
  653. ],
  654. key=lambda g: (g['is_plugin'], g['name']),
  655. )
  656. def get(self, request):
  657. db_schema = get_db_schema()
  658. db_schema_groups = self._get_db_schema_groups(db_schema)
  659. db_schema_stats = {
  660. 'total_tables': len(db_schema),
  661. 'total_columns': sum(len(t['columns']) for t in db_schema),
  662. 'total_indexes': sum(len(t['indexes']) for t in db_schema),
  663. }
  664. return render(request, 'core/htmx/system_db_schema.html', {
  665. 'db_schema': db_schema,
  666. 'db_schema_groups': db_schema_groups,
  667. 'db_schema_stats': db_schema_stats,
  668. })
  669. #
  670. # Plugins
  671. #
  672. class BasePluginView(UserPassesTestMixin, View):
  673. CACHE_KEY_CATALOG_ERROR = 'plugins-catalog-error'
  674. def test_func(self):
  675. return self.request.user.is_superuser
  676. def get_cached_plugins(self, request):
  677. catalog_plugins = {}
  678. catalog_plugins_error = cache.get(self.CACHE_KEY_CATALOG_ERROR, default=False)
  679. if not catalog_plugins_error:
  680. catalog_plugins = get_catalog_plugins()
  681. if not catalog_plugins and not settings.ISOLATED_DEPLOYMENT:
  682. # Cache for 5 minutes to avoid spamming connection
  683. cache.set(self.CACHE_KEY_CATALOG_ERROR, True, 300)
  684. messages.warning(request, _("Plugins catalog could not be loaded"))
  685. return get_local_plugins(catalog_plugins)
  686. class PluginListView(BasePluginView):
  687. def get(self, request):
  688. q = request.GET.get('q', None)
  689. plugins = self.get_cached_plugins(request).values()
  690. if q:
  691. plugins = [obj for obj in plugins if q.casefold() in obj.title_short.casefold()]
  692. plugins = [plugin for plugin in plugins if not plugin.hidden]
  693. table = CatalogPluginTable(plugins)
  694. table.configure(request)
  695. # If this is an HTMX request, return only the rendered table HTML
  696. if htmx_partial(request):
  697. return render(request, 'htmx/table.html', {
  698. 'table': table,
  699. })
  700. return render(request, 'core/plugin_list.html', {
  701. 'table': table,
  702. })
  703. class PluginView(BasePluginView):
  704. def get(self, request, name):
  705. plugins = self.get_cached_plugins(request)
  706. if name not in plugins:
  707. raise Http404(_("Plugin {name} not found").format(name=name))
  708. plugin = plugins[name]
  709. table = PluginVersionTable(plugin.release_recent_history)
  710. table.configure(request)
  711. return render(request, 'core/plugin.html', {
  712. 'plugin': plugin,
  713. 'table': table,
  714. })