views.py 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859
  1. import sys
  2. from copy import deepcopy
  3. from django.conf import settings
  4. from django.contrib import messages
  5. from django.contrib.contenttypes.models import ContentType
  6. from django.core.exceptions import ValidationError
  7. from django.db import transaction, IntegrityError
  8. from django.db.models import Count, ProtectedError
  9. from django.db.models.query import QuerySet
  10. from django.forms import CharField, Form, ModelMultipleChoiceField, MultipleHiddenInput, Textarea
  11. from django.http import HttpResponse, HttpResponseServerError
  12. from django.shortcuts import get_object_or_404, redirect, render
  13. from django.template import loader
  14. from django.template.exceptions import TemplateDoesNotExist
  15. from django.urls import reverse
  16. from django.utils.html import escape
  17. from django.utils.http import is_safe_url
  18. from django.utils.safestring import mark_safe
  19. from django.views.decorators.csrf import requires_csrf_token
  20. from django.views.defaults import ERROR_500_TEMPLATE_NAME
  21. from django.views.generic import View
  22. from django_tables2 import RequestConfig
  23. from extras.models import CustomField, CustomFieldValue, ExportTemplate
  24. from extras.querysets import CustomFieldQueryset
  25. from utilities.forms import BootstrapMixin, CSVDataField
  26. from utilities.utils import csv_format
  27. from .error_handlers import handle_protectederror
  28. from .forms import ConfirmationForm
  29. from .paginator import EnhancedPaginator
  30. class GetReturnURLMixin(object):
  31. """
  32. Provides logic for determining where a user should be redirected after processing a form.
  33. """
  34. default_return_url = None
  35. def get_return_url(self, request, obj=None):
  36. # First, see if `return_url` was specified as a query parameter or form data. Use this URL only if it's
  37. # considered safe.
  38. query_param = request.GET.get('return_url') or request.POST.get('return_url')
  39. if query_param and is_safe_url(url=query_param, allowed_hosts=request.get_host()):
  40. return query_param
  41. # Next, check if the object being modified (if any) has an absolute URL.
  42. elif obj is not None and obj.pk and hasattr(obj, 'get_absolute_url'):
  43. return obj.get_absolute_url()
  44. # Fall back to the default URL (if specified) for the view.
  45. elif self.default_return_url is not None:
  46. return reverse(self.default_return_url)
  47. # If all else fails, return home. Ideally this should never happen.
  48. return reverse('home')
  49. class ObjectListView(View):
  50. """
  51. List a series of objects.
  52. queryset: The queryset of objects to display
  53. filter: A django-filter FilterSet that is applied to the queryset
  54. filter_form: The form used to render filter options
  55. table: The django-tables2 Table used to render the objects list
  56. template_name: The name of the template
  57. """
  58. queryset = None
  59. filter = None
  60. filter_form = None
  61. table = None
  62. template_name = None
  63. def queryset_to_csv(self):
  64. """
  65. Export the queryset of objects as comma-separated value (CSV), using the model's to_csv() method.
  66. """
  67. csv_data = []
  68. # Start with the column headers
  69. headers = ','.join(self.queryset.model.csv_headers)
  70. csv_data.append(headers)
  71. # Iterate through the queryset appending each object
  72. for obj in self.queryset:
  73. data = csv_format(obj.to_csv())
  74. csv_data.append(data)
  75. return csv_data
  76. def get(self, request):
  77. model = self.queryset.model
  78. content_type = ContentType.objects.get_for_model(model)
  79. if self.filter:
  80. self.queryset = self.filter(request.GET, self.queryset).qs
  81. # If this type of object has one or more custom fields, prefetch any relevant custom field values
  82. custom_fields = CustomField.objects.filter(
  83. obj_type=ContentType.objects.get_for_model(model)
  84. ).prefetch_related('choices')
  85. if custom_fields:
  86. self.queryset = self.queryset.prefetch_related('custom_field_values')
  87. # Check for export template rendering
  88. if request.GET.get('export'):
  89. et = get_object_or_404(ExportTemplate, content_type=content_type, name=request.GET.get('export'))
  90. queryset = CustomFieldQueryset(self.queryset, custom_fields) if custom_fields else self.queryset
  91. try:
  92. return et.render_to_response(queryset)
  93. except Exception as e:
  94. messages.error(
  95. request,
  96. "There was an error rendering the selected export template ({}): {}".format(
  97. et.name, e
  98. )
  99. )
  100. # Fall back to built-in CSV formatting if export requested but no template specified
  101. elif 'export' in request.GET and hasattr(model, 'to_csv'):
  102. data = self.queryset_to_csv()
  103. response = HttpResponse(
  104. '\n'.join(data),
  105. content_type='text/csv'
  106. )
  107. filename = 'netbox_{}.csv'.format(self.queryset.model._meta.verbose_name_plural)
  108. response['Content-Disposition'] = 'attachment; filename="{}"'.format(filename)
  109. return response
  110. # Provide a hook to tweak the queryset based on the request immediately prior to rendering the object list
  111. self.queryset = self.alter_queryset(request)
  112. # Compile user model permissions for access from within the template
  113. perm_base_name = '{}.{{}}_{}'.format(model._meta.app_label, model._meta.model_name)
  114. permissions = {p: request.user.has_perm(perm_base_name.format(p)) for p in ['add', 'change', 'delete']}
  115. # Construct the table based on the user's permissions
  116. table = self.table(self.queryset)
  117. if 'pk' in table.base_columns and (permissions['change'] or permissions['delete']):
  118. table.columns.show('pk')
  119. # Construct queryset for tags list
  120. if hasattr(model, 'tags'):
  121. tags = model.tags.annotate(count=Count('extras_taggeditem_items')).order_by('name')
  122. else:
  123. tags = None
  124. # Apply the request context
  125. paginate = {
  126. 'paginator_class': EnhancedPaginator,
  127. 'per_page': request.GET.get('per_page', settings.PAGINATE_COUNT)
  128. }
  129. RequestConfig(request, paginate).configure(table)
  130. context = {
  131. 'content_type': content_type,
  132. 'table': table,
  133. 'permissions': permissions,
  134. 'filter_form': self.filter_form(request.GET, label_suffix='') if self.filter_form else None,
  135. 'tags': tags,
  136. }
  137. context.update(self.extra_context())
  138. return render(request, self.template_name, context)
  139. def alter_queryset(self, request):
  140. # .all() is necessary to avoid caching queries
  141. return self.queryset.all()
  142. def extra_context(self):
  143. return {}
  144. class ObjectEditView(GetReturnURLMixin, View):
  145. """
  146. Create or edit a single object.
  147. model: The model of the object being edited
  148. model_form: The form used to create or edit the object
  149. template_name: The name of the template
  150. """
  151. model = None
  152. model_form = None
  153. template_name = 'utilities/obj_edit.html'
  154. def get_object(self, kwargs):
  155. # Look up object by slug or PK. Return None if neither was provided.
  156. if 'slug' in kwargs:
  157. return get_object_or_404(self.model, slug=kwargs['slug'])
  158. elif 'pk' in kwargs:
  159. return get_object_or_404(self.model, pk=kwargs['pk'])
  160. return self.model()
  161. def alter_obj(self, obj, request, url_args, url_kwargs):
  162. # Allow views to add extra info to an object before it is processed. For example, a parent object can be defined
  163. # given some parameter from the request URL.
  164. return obj
  165. def get(self, request, *args, **kwargs):
  166. obj = self.get_object(kwargs)
  167. obj = self.alter_obj(obj, request, args, kwargs)
  168. # Parse initial data manually to avoid setting field values as lists
  169. initial_data = {k: request.GET[k] for k in request.GET}
  170. form = self.model_form(instance=obj, initial=initial_data)
  171. return render(request, self.template_name, {
  172. 'obj': obj,
  173. 'obj_type': self.model._meta.verbose_name,
  174. 'form': form,
  175. 'return_url': self.get_return_url(request, obj),
  176. })
  177. def post(self, request, *args, **kwargs):
  178. obj = self.get_object(kwargs)
  179. obj = self.alter_obj(obj, request, args, kwargs)
  180. form = self.model_form(request.POST, request.FILES, instance=obj)
  181. if form.is_valid():
  182. obj_created = not form.instance.pk
  183. obj = form.save()
  184. msg = '{} {}'.format(
  185. 'Created' if obj_created else 'Modified',
  186. self.model._meta.verbose_name
  187. )
  188. if hasattr(obj, 'get_absolute_url'):
  189. msg = '{} <a href="{}">{}</a>'.format(msg, obj.get_absolute_url(), escape(obj))
  190. else:
  191. msg = '{} {}'.format(msg, escape(obj))
  192. messages.success(request, mark_safe(msg))
  193. if '_addanother' in request.POST:
  194. return redirect(request.get_full_path())
  195. return_url = form.cleaned_data.get('return_url')
  196. if return_url is not None and is_safe_url(url=return_url, allowed_hosts=request.get_host()):
  197. return redirect(return_url)
  198. else:
  199. return redirect(self.get_return_url(request, obj))
  200. return render(request, self.template_name, {
  201. 'obj': obj,
  202. 'obj_type': self.model._meta.verbose_name,
  203. 'form': form,
  204. 'return_url': self.get_return_url(request, obj),
  205. })
  206. class ObjectDeleteView(GetReturnURLMixin, View):
  207. """
  208. Delete a single object.
  209. model: The model of the object being deleted
  210. template_name: The name of the template
  211. """
  212. model = None
  213. template_name = 'utilities/obj_delete.html'
  214. def get_object(self, kwargs):
  215. # Look up object by slug if one has been provided. Otherwise, use PK.
  216. if 'slug' in kwargs:
  217. return get_object_or_404(self.model, slug=kwargs['slug'])
  218. else:
  219. return get_object_or_404(self.model, pk=kwargs['pk'])
  220. def get(self, request, **kwargs):
  221. obj = self.get_object(kwargs)
  222. form = ConfirmationForm(initial=request.GET)
  223. return render(request, self.template_name, {
  224. 'obj': obj,
  225. 'form': form,
  226. 'obj_type': self.model._meta.verbose_name,
  227. 'return_url': self.get_return_url(request, obj),
  228. })
  229. def post(self, request, **kwargs):
  230. obj = self.get_object(kwargs)
  231. form = ConfirmationForm(request.POST)
  232. if form.is_valid():
  233. try:
  234. obj.delete()
  235. except ProtectedError as e:
  236. handle_protectederror(obj, request, e)
  237. return redirect(obj.get_absolute_url())
  238. msg = 'Deleted {} {}'.format(self.model._meta.verbose_name, obj)
  239. messages.success(request, msg)
  240. return_url = form.cleaned_data.get('return_url')
  241. if return_url is not None and is_safe_url(url=return_url, allowed_hosts=request.get_host()):
  242. return redirect(return_url)
  243. else:
  244. return redirect(self.get_return_url(request, obj))
  245. return render(request, self.template_name, {
  246. 'obj': obj,
  247. 'form': form,
  248. 'obj_type': self.model._meta.verbose_name,
  249. 'return_url': self.get_return_url(request, obj),
  250. })
  251. class BulkCreateView(GetReturnURLMixin, View):
  252. """
  253. Create new objects in bulk.
  254. form: Form class which provides the `pattern` field
  255. model_form: The ModelForm used to create individual objects
  256. pattern_target: Name of the field to be evaluated as a pattern (if any)
  257. template_name: The name of the template
  258. """
  259. form = None
  260. model_form = None
  261. pattern_target = ''
  262. template_name = None
  263. def get(self, request):
  264. # Set initial values for visible form fields from query args
  265. initial = {}
  266. for field in getattr(self.model_form._meta, 'fields', []):
  267. if request.GET.get(field):
  268. initial[field] = request.GET[field]
  269. form = self.form()
  270. model_form = self.model_form(initial=initial)
  271. return render(request, self.template_name, {
  272. 'obj_type': self.model_form._meta.model._meta.verbose_name,
  273. 'form': form,
  274. 'model_form': model_form,
  275. 'return_url': self.get_return_url(request),
  276. })
  277. def post(self, request):
  278. model = self.model_form._meta.model
  279. form = self.form(request.POST)
  280. model_form = self.model_form(request.POST)
  281. if form.is_valid():
  282. pattern = form.cleaned_data['pattern']
  283. new_objs = []
  284. try:
  285. with transaction.atomic():
  286. # Create objects from the expanded. Abort the transaction on the first validation error.
  287. for value in pattern:
  288. # Reinstantiate the model form each time to avoid overwriting the same instance. Use a mutable
  289. # copy of the POST QueryDict so that we can update the target field value.
  290. model_form = self.model_form(request.POST.copy())
  291. model_form.data[self.pattern_target] = value
  292. # Validate each new object independently.
  293. if model_form.is_valid():
  294. obj = model_form.save()
  295. new_objs.append(obj)
  296. else:
  297. # Copy any errors on the pattern target field to the pattern form.
  298. errors = model_form.errors.as_data()
  299. if errors.get(self.pattern_target):
  300. form.add_error('pattern', errors[self.pattern_target])
  301. # Raise an IntegrityError to break the for loop and abort the transaction.
  302. raise IntegrityError()
  303. # If we make it to this point, validation has succeeded on all new objects.
  304. msg = "Added {} {}".format(len(new_objs), model._meta.verbose_name_plural)
  305. messages.success(request, msg)
  306. if '_addanother' in request.POST:
  307. return redirect(request.path)
  308. return redirect(self.get_return_url(request))
  309. except IntegrityError:
  310. pass
  311. return render(request, self.template_name, {
  312. 'form': form,
  313. 'model_form': model_form,
  314. 'obj_type': model._meta.verbose_name,
  315. 'return_url': self.get_return_url(request),
  316. })
  317. class BulkImportView(GetReturnURLMixin, View):
  318. """
  319. Import objects in bulk (CSV format).
  320. model_form: The form used to create each imported object
  321. table: The django-tables2 Table used to render the list of imported objects
  322. template_name: The name of the template
  323. widget_attrs: A dict of attributes to apply to the import widget (e.g. to require a session key)
  324. """
  325. model_form = None
  326. table = None
  327. template_name = 'utilities/obj_import.html'
  328. widget_attrs = {}
  329. def _import_form(self, *args, **kwargs):
  330. fields = self.model_form().fields.keys()
  331. required_fields = [name for name, field in self.model_form().fields.items() if field.required]
  332. class ImportForm(BootstrapMixin, Form):
  333. csv = CSVDataField(fields=fields, required_fields=required_fields, widget=Textarea(attrs=self.widget_attrs))
  334. return ImportForm(*args, **kwargs)
  335. def _save_obj(self, obj_form):
  336. """
  337. Provide a hook to modify the object immediately before saving it (e.g. to encrypt secret data).
  338. """
  339. return obj_form.save()
  340. def get(self, request):
  341. return render(request, self.template_name, {
  342. 'form': self._import_form(),
  343. 'fields': self.model_form().fields,
  344. 'obj_type': self.model_form._meta.model._meta.verbose_name,
  345. 'return_url': self.get_return_url(request),
  346. })
  347. def post(self, request):
  348. new_objs = []
  349. form = self._import_form(request.POST)
  350. if form.is_valid():
  351. try:
  352. # Iterate through CSV data and bind each row to a new model form instance.
  353. with transaction.atomic():
  354. for row, data in enumerate(form.cleaned_data['csv'], start=1):
  355. obj_form = self.model_form(data)
  356. if obj_form.is_valid():
  357. obj = self._save_obj(obj_form)
  358. new_objs.append(obj)
  359. else:
  360. for field, err in obj_form.errors.items():
  361. form.add_error('csv', "Row {} {}: {}".format(row, field, err[0]))
  362. raise ValidationError("")
  363. # Compile a table containing the imported objects
  364. obj_table = self.table(new_objs)
  365. if new_objs:
  366. msg = 'Imported {} {}'.format(len(new_objs), new_objs[0]._meta.verbose_name_plural)
  367. messages.success(request, msg)
  368. return render(request, "import_success.html", {
  369. 'table': obj_table,
  370. 'return_url': self.get_return_url(request),
  371. })
  372. except ValidationError:
  373. pass
  374. return render(request, self.template_name, {
  375. 'form': form,
  376. 'fields': self.model_form().fields,
  377. 'obj_type': self.model_form._meta.model._meta.verbose_name,
  378. 'return_url': self.get_return_url(request),
  379. })
  380. class BulkEditView(GetReturnURLMixin, View):
  381. """
  382. Edit objects in bulk.
  383. queryset: Custom queryset to use when retrieving objects (e.g. to select related objects)
  384. parent_model: The model of the parent object (if any)
  385. filter: FilterSet to apply when deleting by QuerySet
  386. table: The table used to display devices being edited
  387. form: The form class used to edit objects in bulk
  388. template_name: The name of the template
  389. """
  390. queryset = None
  391. parent_model = None
  392. filter = None
  393. table = None
  394. form = None
  395. template_name = 'utilities/obj_bulk_edit.html'
  396. def get(self, request):
  397. return redirect(self.get_return_url(request))
  398. def post(self, request, **kwargs):
  399. model = self.queryset.model
  400. # Attempt to derive parent object if a parent class has been given
  401. if self.parent_model:
  402. parent_obj = get_object_or_404(self.parent_model, **kwargs)
  403. else:
  404. parent_obj = None
  405. # Are we editing *all* objects in the queryset or just a selected subset?
  406. if request.POST.get('_all') and self.filter is not None:
  407. pk_list = [obj.pk for obj in self.filter(request.GET, model.objects.only('pk')).qs]
  408. else:
  409. pk_list = [int(pk) for pk in request.POST.getlist('pk')]
  410. if '_apply' in request.POST:
  411. form = self.form(model, parent_obj, request.POST)
  412. if form.is_valid():
  413. custom_fields = form.custom_fields if hasattr(form, 'custom_fields') else []
  414. standard_fields = [field for field in form.fields if field not in custom_fields and field != 'pk']
  415. nullified_fields = request.POST.getlist('_nullify')
  416. try:
  417. with transaction.atomic():
  418. updated_count = 0
  419. for obj in model.objects.filter(pk__in=pk_list):
  420. # Update standard fields. If a field is listed in _nullify, delete its value.
  421. for name in standard_fields:
  422. if name in form.nullable_fields and name in nullified_fields and isinstance(form.cleaned_data[name], QuerySet):
  423. getattr(obj, name).set([])
  424. elif name in form.nullable_fields and name in nullified_fields:
  425. setattr(obj, name, '' if isinstance(form.fields[name], CharField) else None)
  426. elif isinstance(form.cleaned_data[name], QuerySet) and form.cleaned_data[name]:
  427. getattr(obj, name).set(form.cleaned_data[name])
  428. elif form.cleaned_data[name] not in (None, '') and not isinstance(form.cleaned_data[name], QuerySet):
  429. setattr(obj, name, form.cleaned_data[name])
  430. obj.full_clean()
  431. obj.save()
  432. # Update custom fields
  433. obj_type = ContentType.objects.get_for_model(model)
  434. for name in custom_fields:
  435. field = form.fields[name].model
  436. if name in form.nullable_fields and name in nullified_fields:
  437. CustomFieldValue.objects.filter(
  438. field=field, obj_type=obj_type, obj_id=obj.pk
  439. ).delete()
  440. elif form.cleaned_data[name] not in [None, '']:
  441. try:
  442. cfv = CustomFieldValue.objects.get(
  443. field=field, obj_type=obj_type, obj_id=obj.pk
  444. )
  445. except CustomFieldValue.DoesNotExist:
  446. cfv = CustomFieldValue(
  447. field=field, obj_type=obj_type, obj_id=obj.pk
  448. )
  449. cfv.value = form.cleaned_data[name]
  450. cfv.save()
  451. # Add/remove tags
  452. if form.cleaned_data.get('add_tags', None):
  453. obj.tags.add(*form.cleaned_data['add_tags'])
  454. if form.cleaned_data.get('remove_tags', None):
  455. obj.tags.remove(*form.cleaned_data['remove_tags'])
  456. updated_count += 1
  457. if updated_count:
  458. msg = 'Updated {} {}'.format(updated_count, model._meta.verbose_name_plural)
  459. messages.success(self.request, msg)
  460. return redirect(self.get_return_url(request))
  461. except ValidationError as e:
  462. messages.error(self.request, "{} failed validation: {}".format(obj, e))
  463. else:
  464. initial_data = request.POST.copy()
  465. initial_data['pk'] = pk_list
  466. form = self.form(model, parent_obj, initial=initial_data)
  467. # Retrieve objects being edited
  468. table = self.table(self.queryset.filter(pk__in=pk_list), orderable=False)
  469. if not table.rows:
  470. messages.warning(request, "No {} were selected.".format(model._meta.verbose_name_plural))
  471. return redirect(self.get_return_url(request))
  472. return render(request, self.template_name, {
  473. 'form': form,
  474. 'table': table,
  475. 'obj_type_plural': model._meta.verbose_name_plural,
  476. 'return_url': self.get_return_url(request),
  477. })
  478. class BulkDeleteView(GetReturnURLMixin, View):
  479. """
  480. Delete objects in bulk.
  481. queryset: Custom queryset to use when retrieving objects (e.g. to select related objects)
  482. parent_model: The model of the parent object (if any)
  483. filter: FilterSet to apply when deleting by QuerySet
  484. table: The table used to display devices being deleted
  485. form: The form class used to delete objects in bulk
  486. template_name: The name of the template
  487. """
  488. queryset = None
  489. parent_model = None
  490. filter = None
  491. table = None
  492. form = None
  493. template_name = 'utilities/obj_bulk_delete.html'
  494. def get(self, request):
  495. return redirect(self.get_return_url(request))
  496. def post(self, request, **kwargs):
  497. model = self.queryset.model
  498. # Attempt to derive parent object if a parent class has been given
  499. if self.parent_model:
  500. parent_obj = get_object_or_404(self.parent_model, **kwargs)
  501. else:
  502. parent_obj = None
  503. # Are we deleting *all* objects in the queryset or just a selected subset?
  504. if request.POST.get('_all'):
  505. if self.filter is not None:
  506. pk_list = [obj.pk for obj in self.filter(request.GET, model.objects.only('pk')).qs]
  507. else:
  508. pk_list = model.objects.values_list('pk', flat=True)
  509. else:
  510. pk_list = [int(pk) for pk in request.POST.getlist('pk')]
  511. form_cls = self.get_form()
  512. if '_confirm' in request.POST:
  513. form = form_cls(request.POST)
  514. if form.is_valid():
  515. # Delete objects
  516. queryset = model.objects.filter(pk__in=pk_list)
  517. try:
  518. deleted_count = queryset.delete()[1][model._meta.label]
  519. except ProtectedError as e:
  520. handle_protectederror(list(queryset), request, e)
  521. return redirect(self.get_return_url(request))
  522. msg = 'Deleted {} {}'.format(deleted_count, model._meta.verbose_name_plural)
  523. messages.success(request, msg)
  524. return redirect(self.get_return_url(request))
  525. else:
  526. form = form_cls(initial={
  527. 'pk': pk_list,
  528. 'return_url': self.get_return_url(request),
  529. })
  530. # Retrieve objects being deleted
  531. table = self.table(self.queryset.filter(pk__in=pk_list), orderable=False)
  532. if not table.rows:
  533. messages.warning(request, "No {} were selected for deletion.".format(model._meta.verbose_name_plural))
  534. return redirect(self.get_return_url(request))
  535. return render(request, self.template_name, {
  536. 'form': form,
  537. 'parent_obj': parent_obj,
  538. 'obj_type_plural': model._meta.verbose_name_plural,
  539. 'table': table,
  540. 'return_url': self.get_return_url(request),
  541. })
  542. def get_form(self):
  543. """
  544. Provide a standard bulk delete form if none has been specified for the view
  545. """
  546. class BulkDeleteForm(ConfirmationForm):
  547. pk = ModelMultipleChoiceField(queryset=self.queryset, widget=MultipleHiddenInput)
  548. if self.form:
  549. return self.form
  550. return BulkDeleteForm
  551. #
  552. # Device/VirtualMachine components
  553. #
  554. class ComponentCreateView(View):
  555. """
  556. Add one or more components (e.g. interfaces, console ports, etc.) to a Device or VirtualMachine.
  557. """
  558. parent_model = None
  559. parent_field = None
  560. model = None
  561. form = None
  562. model_form = None
  563. template_name = None
  564. def get(self, request, pk):
  565. parent = get_object_or_404(self.parent_model, pk=pk)
  566. form = self.form(parent, initial=request.GET)
  567. return render(request, self.template_name, {
  568. 'parent': parent,
  569. 'component_type': self.model._meta.verbose_name,
  570. 'form': form,
  571. 'return_url': parent.get_absolute_url(),
  572. })
  573. def post(self, request, pk):
  574. parent = get_object_or_404(self.parent_model, pk=pk)
  575. form = self.form(parent, request.POST)
  576. if form.is_valid():
  577. new_components = []
  578. data = deepcopy(request.POST)
  579. data[self.parent_field] = parent.pk
  580. for i, name in enumerate(form.cleaned_data['name_pattern']):
  581. # Initialize the individual component form
  582. data['name'] = name
  583. data.update(form.get_iterative_data(i))
  584. component_form = self.model_form(data)
  585. if component_form.is_valid():
  586. new_components.append(component_form)
  587. else:
  588. for field, errors in component_form.errors.as_data().items():
  589. # Assign errors on the child form's name field to name_pattern on the parent form
  590. if field == 'name':
  591. field = 'name_pattern'
  592. for e in errors:
  593. form.add_error(field, '{}: {}'.format(name, ', '.join(e)))
  594. if not form.errors:
  595. # Create the new components
  596. for component_form in new_components:
  597. component_form.save()
  598. messages.success(request, "Added {} {} to {}.".format(
  599. len(new_components), self.model._meta.verbose_name_plural, parent
  600. ))
  601. if '_addanother' in request.POST:
  602. return redirect(request.path)
  603. else:
  604. return redirect(parent.get_absolute_url())
  605. return render(request, self.template_name, {
  606. 'parent': parent,
  607. 'component_type': self.model._meta.verbose_name,
  608. 'form': form,
  609. 'return_url': parent.get_absolute_url(),
  610. })
  611. class BulkComponentCreateView(GetReturnURLMixin, View):
  612. """
  613. Add one or more components (e.g. interfaces, console ports, etc.) to a set of Devices or VirtualMachines.
  614. """
  615. parent_model = None
  616. parent_field = None
  617. form = None
  618. model = None
  619. model_form = None
  620. filter = None
  621. table = None
  622. template_name = 'utilities/obj_bulk_add_component.html'
  623. def post(self, request):
  624. parent_model_name = self.parent_model._meta.verbose_name_plural
  625. model_name = self.model._meta.verbose_name_plural
  626. # Are we editing *all* objects in the queryset or just a selected subset?
  627. if request.POST.get('_all') and self.filter is not None:
  628. pk_list = [obj.pk for obj in self.filter(request.GET, self.parent_model.objects.only('pk')).qs]
  629. else:
  630. pk_list = [int(pk) for pk in request.POST.getlist('pk')]
  631. selected_objects = self.parent_model.objects.filter(pk__in=pk_list)
  632. if not selected_objects:
  633. messages.warning(request, "No {} were selected.".format(self.parent_model._meta.verbose_name_plural))
  634. return redirect(self.get_return_url(request))
  635. table = self.table(selected_objects)
  636. if '_create' in request.POST:
  637. form = self.form(request.POST)
  638. if form.is_valid():
  639. new_components = []
  640. data = deepcopy(form.cleaned_data)
  641. for obj in data['pk']:
  642. names = data['name_pattern']
  643. for name in names:
  644. component_data = {
  645. self.parent_field: obj.pk,
  646. 'name': name,
  647. }
  648. component_data.update(data)
  649. component_form = self.model_form(component_data)
  650. if component_form.is_valid():
  651. new_components.append(component_form.save(commit=False))
  652. else:
  653. for field, errors in component_form.errors.as_data().items():
  654. for e in errors:
  655. form.add_error(field, '{} {}: {}'.format(obj, name, ', '.join(e)))
  656. if not form.errors:
  657. self.model.objects.bulk_create(new_components)
  658. messages.success(request, "Added {} {} to {} {}.".format(
  659. len(new_components),
  660. model_name,
  661. len(form.cleaned_data['pk']),
  662. parent_model_name
  663. ))
  664. return redirect(self.get_return_url(request))
  665. else:
  666. form = self.form(initial={'pk': pk_list})
  667. return render(request, self.template_name, {
  668. 'form': form,
  669. 'parent_model_name': parent_model_name,
  670. 'model_name': model_name,
  671. 'table': table,
  672. 'return_url': self.get_return_url(request),
  673. })
  674. @requires_csrf_token
  675. def server_error(request, template_name=ERROR_500_TEMPLATE_NAME):
  676. """
  677. Custom 500 handler to provide additional context when rendering 500.html.
  678. """
  679. try:
  680. template = loader.get_template(template_name)
  681. except TemplateDoesNotExist:
  682. return HttpResponseServerError('<h1>Server Error (500)</h1>', content_type='text/html')
  683. type_, error, traceback = sys.exc_info()
  684. return HttpResponseServerError(template.render({
  685. 'exception': str(type_),
  686. 'error': error,
  687. }))