export.py 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. import io
  2. import datetime
  3. import sys
  4. from future.utils import iteritems
  5. from django.http import HttpResponse
  6. from django.template import loader
  7. from django.utils import six
  8. from django.utils.encoding import force_text, smart_text
  9. from django.utils.html import escape
  10. from django.utils.translation import ugettext as _
  11. from django.utils.xmlutils import SimplerXMLGenerator
  12. from django.db.models import BooleanField, NullBooleanField
  13. from xadmin.plugins.utils import get_context_dict
  14. from xadmin.sites import site
  15. from xadmin.views import BaseAdminPlugin, ListAdminView
  16. from xadmin.util import json
  17. from xadmin.views.list import ALL_VAR
  18. try:
  19. import xlwt
  20. has_xlwt = True
  21. except:
  22. has_xlwt = False
  23. try:
  24. import xlsxwriter
  25. has_xlsxwriter = True
  26. except:
  27. has_xlsxwriter = False
  28. class ExportMenuPlugin(BaseAdminPlugin):
  29. list_export = ('xlsx', 'xls', 'csv', 'xml', 'json')
  30. export_names = {'xlsx': 'Excel 2007', 'xls': 'Excel', 'csv': 'CSV',
  31. 'xml': 'XML', 'json': 'JSON'}
  32. def init_request(self, *args, **kwargs):
  33. self.list_export = [
  34. f for f in self.list_export
  35. if (f != 'xlsx' or has_xlsxwriter) and (f != 'xls' or has_xlwt)]
  36. def block_top_toolbar(self, context, nodes):
  37. if self.list_export:
  38. context.update({
  39. 'show_export_all': self.admin_view.paginator.count > self.admin_view.list_per_page and not ALL_VAR in self.admin_view.request.GET,
  40. 'form_params': self.admin_view.get_form_params({'_do_': 'export'}, ('export_type',)),
  41. 'export_types': [{'type': et, 'name': self.export_names[et]} for et in self.list_export],
  42. })
  43. nodes.append(loader.render_to_string('xadmin/blocks/model_list.top_toolbar.exports.html',
  44. context=get_context_dict(context)))
  45. class ExportPlugin(BaseAdminPlugin):
  46. export_mimes = {'xlsx': 'application/vnd.ms-excel',
  47. 'xls': 'application/vnd.ms-excel', 'csv': 'text/csv',
  48. 'xml': 'application/xhtml+xml', 'json': 'application/json'}
  49. def init_request(self, *args, **kwargs):
  50. return self.request.GET.get('_do_') == 'export'
  51. def _format_value(self, o):
  52. if (o.field is None and getattr(o.attr, 'boolean', False)) or \
  53. (o.field and isinstance(o.field, (BooleanField, NullBooleanField))):
  54. value = o.value
  55. elif str(o.text).startswith("<span class='text-muted'>"):
  56. value = escape(str(o.text)[25:-7])
  57. else:
  58. value = escape(str(o.text))
  59. return value
  60. def _get_objects(self, context):
  61. headers = [c for c in context['result_headers'].cells if c.export]
  62. rows = context['results']
  63. return [dict([
  64. (force_text(headers[i].text), self._format_value(o)) for i, o in
  65. enumerate(filter(lambda c:getattr(c, 'export', False), r.cells))]) for r in rows]
  66. def _get_datas(self, context):
  67. rows = context['results']
  68. new_rows = [[self._format_value(o) for o in
  69. filter(lambda c:getattr(c, 'export', False), r.cells)] for r in rows]
  70. new_rows.insert(0, [force_text(c.text) for c in context['result_headers'].cells if c.export])
  71. return new_rows
  72. def get_xlsx_export(self, context):
  73. datas = self._get_datas(context)
  74. output = io.BytesIO()
  75. export_header = (
  76. self.request.GET.get('export_xlsx_header', 'off') == 'on')
  77. model_name = self.opts.verbose_name
  78. book = xlsxwriter.Workbook(output)
  79. sheet = book.add_worksheet(
  80. u"%s %s" % (_(u'Sheet'), force_text(model_name)))
  81. styles = {'datetime': book.add_format({'num_format': 'yyyy-mm-dd hh:mm:ss'}),
  82. 'date': book.add_format({'num_format': 'yyyy-mm-dd'}),
  83. 'time': book.add_format({'num_format': 'hh:mm:ss'}),
  84. 'header': book.add_format({'font': 'name Times New Roman', 'color': 'red', 'bold': 'on', 'num_format': '#,##0.00'}),
  85. 'default': book.add_format()}
  86. if not export_header:
  87. datas = datas[1:]
  88. for rowx, row in enumerate(datas):
  89. for colx, value in enumerate(row):
  90. if export_header and rowx == 0:
  91. cell_style = styles['header']
  92. else:
  93. if isinstance(value, datetime.datetime):
  94. cell_style = styles['datetime']
  95. elif isinstance(value, datetime.date):
  96. cell_style = styles['date']
  97. elif isinstance(value, datetime.time):
  98. cell_style = styles['time']
  99. else:
  100. cell_style = styles['default']
  101. sheet.write(rowx, colx, value, cell_style)
  102. book.close()
  103. output.seek(0)
  104. return output.getvalue()
  105. def get_xls_export(self, context):
  106. datas = self._get_datas(context)
  107. output = io.BytesIO()
  108. export_header = (
  109. self.request.GET.get('export_xls_header', 'off') == 'on')
  110. model_name = self.opts.verbose_name
  111. book = xlwt.Workbook(encoding='utf8')
  112. sheet = book.add_sheet(
  113. u"%s %s" % (_(u'Sheet'), force_text(model_name)))
  114. styles = {'datetime': xlwt.easyxf(num_format_str='yyyy-mm-dd hh:mm:ss'),
  115. 'date': xlwt.easyxf(num_format_str='yyyy-mm-dd'),
  116. 'time': xlwt.easyxf(num_format_str='hh:mm:ss'),
  117. 'header': xlwt.easyxf('font: name Times New Roman, color-index red, bold on', num_format_str='#,##0.00'),
  118. 'default': xlwt.Style.default_style}
  119. if not export_header:
  120. datas = datas[1:]
  121. for rowx, row in enumerate(datas):
  122. for colx, value in enumerate(row):
  123. if export_header and rowx == 0:
  124. cell_style = styles['header']
  125. else:
  126. if isinstance(value, datetime.datetime):
  127. cell_style = styles['datetime']
  128. elif isinstance(value, datetime.date):
  129. cell_style = styles['date']
  130. elif isinstance(value, datetime.time):
  131. cell_style = styles['time']
  132. else:
  133. cell_style = styles['default']
  134. sheet.write(rowx, colx, value, style=cell_style)
  135. book.save(output)
  136. output.seek(0)
  137. return output.getvalue()
  138. def _format_csv_text(self, t):
  139. if isinstance(t, bool):
  140. return _('Yes') if t else _('No')
  141. t = t.replace('"', '""').replace(',', '\,')
  142. cls_str = str if six.PY3 else basestring
  143. if isinstance(t, cls_str):
  144. t = '"%s"' % t
  145. return t
  146. def get_csv_export(self, context):
  147. datas = self._get_datas(context)
  148. stream = []
  149. if self.request.GET.get('export_csv_header', 'off') != 'on':
  150. datas = datas[1:]
  151. for row in datas:
  152. stream.append(','.join(map(self._format_csv_text, row)))
  153. return '\r\n'.join(stream)
  154. def _to_xml(self, xml, data):
  155. if isinstance(data, (list, tuple)):
  156. for item in data:
  157. xml.startElement("row", {})
  158. self._to_xml(xml, item)
  159. xml.endElement("row")
  160. elif isinstance(data, dict):
  161. for key, value in iteritems(data):
  162. key = key.replace(' ', '_')
  163. xml.startElement(key, {})
  164. self._to_xml(xml, value)
  165. xml.endElement(key)
  166. else:
  167. xml.characters(smart_text(data))
  168. def get_xml_export(self, context):
  169. results = self._get_objects(context)
  170. stream = io.StringIO()
  171. xml = SimplerXMLGenerator(stream, "utf-8")
  172. xml.startDocument()
  173. xml.startElement("objects", {})
  174. self._to_xml(xml, results)
  175. xml.endElement("objects")
  176. xml.endDocument()
  177. return stream.getvalue().split('\n')[1]
  178. def get_json_export(self, context):
  179. results = self._get_objects(context)
  180. return json.dumps({'objects': results}, ensure_ascii=False,
  181. indent=(self.request.GET.get('export_json_format', 'off') == 'on') and 4 or None)
  182. def get_response(self, response, context, *args, **kwargs):
  183. file_type = self.request.GET.get('export_type', 'csv')
  184. response = HttpResponse(
  185. content_type="%s; charset=UTF-8" % self.export_mimes[file_type])
  186. file_name = self.opts.verbose_name.replace(' ', '_')
  187. response['Content-Disposition'] = ('attachment; filename=%s.%s' % (
  188. file_name, file_type)).encode('utf-8')
  189. response.write(getattr(self, 'get_%s_export' % file_type)(context))
  190. return response
  191. # View Methods
  192. def get_result_list(self, __):
  193. if self.request.GET.get('all', 'off') == 'on':
  194. self.admin_view.list_per_page = sys.maxsize
  195. return __()
  196. def result_header(self, item, field_name, row):
  197. item.export = not item.attr or field_name == '__str__' or getattr(item.attr, 'allow_export', True)
  198. return item
  199. def result_item(self, item, obj, field_name, row):
  200. item.export = item.field or field_name == '__str__' or getattr(item.attr, 'allow_export', True)
  201. return item
  202. site.register_plugin(ExportMenuPlugin, ListAdminView)
  203. site.register_plugin(ExportPlugin, ListAdminView)