views.py 31 KB

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