views.py 34 KB

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