forum_modules/exporter/exporter.py

   1 from __future__ import with_statement
   2
   3 import os, tarfile, datetime, logging, re, ConfigParser, shutil, zipfile
   4
   5 from django.core.cache import cache
   6 from django.utils.translation import ugettext as _
   7 from forum.models import *
   8 from forum.settings import APP_URL
   9 from forum.templatetags.extra_tags import diff_date
  10 import xml.etree.ElementTree
  11 from xml.etree import ElementTree as ET
  12 from xml.etree.ElementTree import Comment, _encode, ProcessingInstruction, QName, fixtag, _escape_attrib, _escape_cdata
  13 from forum import settings
  14 from django.conf import settings as djsettings
  15 import settings as selfsettings
  16
  17 CACHE_KEY = "%s_exporter_state" % APP_URL
  18 EXPORT_STEPS = []
  19
  20 TMP_FOLDER = os.path.join(os.path.dirname(__file__), 'tmp')
  21
  22 DATE_AND_AUTHOR_INF_SECTION = 'DateAndAuthor'
  23 OPTIONS_INF_SECTION = 'Options'
  24 META_INF_SECTION = 'Meta'
  25
  26 DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
  27 DATE_FORMAT = "%Y-%m-%d"
  28
  29 def Etree_pretty__write(self, file, node, encoding, namespaces,
  30                         level=0, identator="    "):
  31     tag = node.tag
  32     if tag is Comment:
  33         file.write(level * identator + "<!-- %s -->" % _escape_cdata(node.text, encoding))
  34     elif tag is ProcessingInstruction:
  35         file.write("<?%s?>" % _escape_cdata(node.text, encoding))
  36     else:
  37         items = node.items()
  38         xmlns_items = [] # new namespaces in this scope
  39         try:
  40             if isinstance(tag, QName) or tag[:1] == "{":
  41                 tag, xmlns = fixtag(tag, namespaces)
  42                 if xmlns: xmlns_items.append(xmlns)
  43         except TypeError:
  44             raise #_raise_serialization_error(tag)
  45         file.write("\n" + level * identator + "<" + _encode(tag, encoding))
  46         if items or xmlns_items:
  47             items.sort() # lexical order
  48             for k, v in items:
  49                 try:
  50                     if isinstance(k, QName) or k[:1] == "{":
  51                         k, xmlns = fixtag(k, namespaces)
  52                         if xmlns: xmlns_items.append(xmlns)
  53                 except TypeError:
  54                     raise #_raise_serialization_error(k)
  55                 try:
  56                     if isinstance(v, QName):
  57                         v, xmlns = fixtag(v, namespaces)
  58                         if xmlns: xmlns_items.append(xmlns)
  59                 except TypeError:
  60                     raise #_raise_serialization_error(v)
  61                 file.write(u" %s=\"%s\"" % (_encode(k, encoding),
  62                                             _escape_attrib(v, encoding)))
  63             for k, v in xmlns_items:
  64                 file.write(u" %s=\"%s\"" % (_encode(k, encoding),
  65                                             _escape_attrib(v, encoding)))
  66         if node.text or len(node):
  67             file.write(">")
  68             if node.text:
  69                 file.write(_escape_cdata(node.text, encoding))
  70             for n in node:
  71                 self._write(file, n, encoding, namespaces, level + 1, identator)
  72             if node.text and len(node.text) < 125:
  73                 file.write("</" + _encode(tag, encoding) + ">")
  74             else:
  75                 file.write("\n" + level * identator + "</" + _encode(tag, encoding) + ">")
  76         else:
  77             file.write(" />")
  78         for k, v in xmlns_items:
  79             del namespaces[v]
  80     if node.tail:
  81         file.write(_escape_cdata(node.tail.replace("\n", (level * identator )+ "\n"), encoding))
  82
  83 def make_date(date, with_time=True):
  84     try:
  85         return date.strftime(with_time and DATETIME_FORMAT or DATE_FORMAT)
  86     except ValueError, e:
  87         return date.replace(year=1900).strftime(with_time and DATETIME_FORMAT or DATE_FORMAT)
  88
  89
  90 def ET_Element_add_tag(el, tag_name, content = None, **attrs):
  91     tag = ET.SubElement(el, tag_name)
  92
  93     if content:
  94         try:
  95             tag.text = unicode(content)
  96         except Exception, e:
  97             #logging.error('error converting unicode characters')
  98             #import traceback
  99             #logging.error(traceback.print_exc())
 100
 101             import string
 102             tag.text = unicode("".join([c for c in content if c in string.printable]))
 103
 104     for k, v in attrs.items():
 105         tag.set(k, unicode(v))
 106
 107     return tag
 108
 109 GOOD_TAG_NAME = re.compile("^\w+$")
 110
 111 def make_extra(el, v):
 112     if v is None:
 113         return
 114
 115
 116     if isinstance(v, (int, long, str, unicode, float, bool, dict, list, tuple)):
 117         if isinstance(v, tuple):
 118             t = 'list'
 119         else:
 120             t = v.__class__.__name__
 121     else:
 122         t = 'unknown'
 123
 124     value = el.add('value', type=t)
 125
 126     if isinstance(v, (list, tuple)):
 127         for i in v:
 128             item = value.add('item')
 129             make_extra(item, i)
 130
 131     elif isinstance(v, dict):
 132         for k, i in v.items():
 133             item = value.add('item', key=k)
 134             make_extra(item, i)
 135     else:
 136         value.text = unicode(v)
 137
 138 def write_to_file(root, tmp, filename):
 139     tree = ET.ElementTree(root)
 140     tree.write(os.path.join(tmp, filename), encoding='UTF-8')
 141
 142 def create_targz(tmp, files, start_time, options, user, state, set_state, file_format):
 143     now = datetime.datetime.now()
 144     domain = re.match('[\w-]+\.[\w-]+(\.[\w-]+)*', djsettings.APP_URL)
 145     if domain:
 146         domain = '_'.join(domain.get(0).split('.'))
 147     else:
 148         domain = 'localhost'
 149
 150     fname = "%s-%s" % (domain, now.strftime('%Y%m%d%H%M'))
 151     if file_format == 'zip':
 152         full_fname = "%s.zip" % fname
 153     else:
 154         full_fname = "%s.tar.gz" % fname
 155
 156     if file_format == 'zip':
 157         t = zipfile.ZipFile(os.path.join(selfsettings.EXPORTER_BACKUP_STORAGE, full_fname), 'w')
 158
 159         def add_to_file(f, a):
 160             t.write(f, a)
 161     else:
 162         t = tarfile.open(os.path.join(selfsettings.EXPORTER_BACKUP_STORAGE, full_fname), mode = 'w:gz')
 163
 164         def add_to_file(f, a):
 165             t.add(f, a)
 166
 167     state['overall']['status'] = _('Compressing xml files')
 168     set_state()
 169
 170     for f in files:
 171         add_to_file(os.path.join(tmp, f), "/%s" % f)
 172
 173     if options.get('uplodaded_files', False):
 174         state['overall']['status'] = _('Importing uploaded files')
 175         set_state()
 176         export_upfiles(t)
 177
 178     if options.get('import_skins_folder', False):
 179         state['overall']['status'] = _('Importing skins folder')
 180         set_state()
 181         export_skinsfolder(t)
 182
 183     state['overall']['status'] = _('Writing inf file.')
 184     set_state()
 185
 186     inf = ConfigParser.SafeConfigParser()
 187
 188     inf.add_section(DATE_AND_AUTHOR_INF_SECTION)
 189
 190     inf.set(DATE_AND_AUTHOR_INF_SECTION, 'file-name', full_fname)
 191     inf.set(DATE_AND_AUTHOR_INF_SECTION, 'author', unicode(user.id))
 192     inf.set(DATE_AND_AUTHOR_INF_SECTION, 'site', djsettings.APP_URL)
 193     inf.set(DATE_AND_AUTHOR_INF_SECTION, 'started', start_time.strftime(DATETIME_FORMAT))
 194     inf.set(DATE_AND_AUTHOR_INF_SECTION, 'finished', now.strftime(DATETIME_FORMAT))
 195
 196     inf.add_section(OPTIONS_INF_SECTION)
 197     inf.set(OPTIONS_INF_SECTION, 'anon-data', str(options.get('anon_data', False)))
 198     inf.set(OPTIONS_INF_SECTION, 'with-upfiles', str(options.get('uplodaded_files', False)))
 199     inf.set(OPTIONS_INF_SECTION, 'with-skins', str(options.get('import_skins_folder', False)))
 200
 201     inf.add_section(META_INF_SECTION)
 202
 203     for id, s in state.items():
 204         inf.set(META_INF_SECTION, id, str(s['count']))
 205
 206     with open(os.path.join(tmp, '%s.backup.inf' % fname), 'wb') as inffile:
 207         inf.write(inffile)
 208
 209     add_to_file(os.path.join(tmp, '%s.backup.inf' % fname), '/backup.inf')
 210     state['overall']['status'] = _('Saving backup file')
 211     set_state()
 212     t.close()
 213     return full_fname
 214
 215
 216 def export_upfiles(tf):
 217     folder = str(settings.UPFILES_FOLDER)
 218
 219     if os.path.exists(folder):
 220         tf.add(folder, arcname='/upfiles')
 221
 222
 223 def export_skinsfolder(tf):
 224     folder = djsettings.TEMPLATE_DIRS[0]
 225
 226     if os.path.exists(folder):
 227         tf.add(folder, arcname='/skins')
 228
 229
 230 def export(options, user):
 231     original__write = xml.etree.ElementTree.ElementTree._write
 232     xml.etree.ElementTree.ElementTree._write = Etree_pretty__write
 233     xml.etree.ElementTree._ElementInterface.add = ET_Element_add_tag
 234
 235     start_time = datetime.datetime.now()
 236     tmp = TMP_FOLDER
 237     anon_data = options.get('anon_data', False)
 238
 239     steps = [s for s in EXPORT_STEPS if not (anon_data and s['fn'].is_user_data())]
 240
 241     state = dict([(s['id'], {
 242         'status': _('Queued'), 'count': s['fn'].count(start_time), 'parsed': 0
 243     }) for s in steps] + [
 244         ('overall', {
 245             'status': _('Starting'), 'count': sum([s['fn'].count(start_time) for s in steps]), 'parsed': 0
 246         })
 247     ])
 248
 249     full_state = dict(running=True, state=state, time_started="")
 250
 251     def set_state():
 252         full_state['time_started'] = diff_date(start_time)
 253         cache.set(CACHE_KEY, full_state)
 254
 255     set_state()
 256
 257     def ping_state(name):
 258         state[name]['parsed'] += 1
 259         state['overall']['parsed'] += 1
 260         set_state()
 261
 262     def run(fn, name):
 263         def ping():
 264             ping_state(name)
 265
 266         state['overall']['status'] = _('Exporting %s') % s['name']
 267         state[name]['status'] = _('Exporting')
 268
 269         root, fname = fn(ping, start_time, anon_data)
 270
 271         state[name]['status'] = _('Writing temp file')
 272         state['overall']['status'] = _('Writing %s temp file') % s['name']
 273
 274         set_state()
 275
 276         write_to_file(root, tmp, fname)
 277         state[name]['status'] = _('Done')
 278
 279         set_state()
 280
 281         return fname
 282
 283     try:
 284         dump_files = []
 285
 286         for s in steps:
 287             dump_files.append(run(s['fn'], s['id']))
 288
 289         state['overall']['status'] = _('Compressing files')
 290         set_state()
 291
 292         fname = create_targz(tmp, dump_files, start_time, options, user, state, set_state, options['file_format'])
 293         full_state['running'] = False
 294         full_state['errors'] = False
 295         state['overall']['status'] = _('Done')
 296         state['overall']['fname'] = fname
 297
 298         set_state()
 299     except Exception, e:
 300         full_state['running'] = False
 301         full_state['errors'] = "%s: %s" % (e.__class__.__name__, unicode(e))
 302         set_state()
 303
 304         import traceback
 305         logging.error("Error executing xml backup: \n %s" % (traceback.format_exc()))
 306     finally:
 307         xml.etree.ElementTree.ElementTree._write = original__write
 308         del xml.etree.ElementTree._ElementInterface.add
 309
 310
 311 def exporter_step(queryset, root_tag_name, el_tag_name, name, date_lock=None, user_data=False):
 312
 313     def decorator(fn):
 314         def qs(lock):
 315             if date_lock:
 316                 return queryset.filter(**{"%s__lte" % date_lock: lock})
 317             return queryset
 318
 319         def decorated(ping, lock, anon_data):
 320             root = ET.Element(root_tag_name)
 321
 322             for item in qs(lock).order_by('id').select_related():
 323                 el = root.add(el_tag_name)
 324                 fn(item, el, anon_data)
 325                 ping()
 326
 327             return root, "%s.xml" % root_tag_name
 328
 329         def count(lock):
 330             return qs(lock).count()
 331
 332         def is_user_data():
 333             return user_data
 334
 335         decorated.count = count
 336         decorated.is_user_data = is_user_data
 337
 338         EXPORT_STEPS.append(dict(id=root_tag_name, name=name, fn=decorated))
 339
 340         return decorated
 341
 342     return decorator
 343
 344 @exporter_step(Tag.objects.all(), 'tags', 'tag', _('Tags'))
 345 def export_tags(t, el, anon_data):
 346     el.add('name', t.name)
 347     if not anon_data:
 348         el.add('author', t.created_by.id)
 349     el.add('used', t.used_count)
 350
 351
 352 @exporter_step(User.objects.all(), 'users', 'user', _('Users'), 'date_joined', True)
 353 def export_users(u, el, anon_data):
 354     el.add('id', u.id)
 355     el.add('username', u.username)
 356     el.add('password', u.password)
 357     el.add('email', u.email, validated=u.email_isvalid and 'true' or 'false')
 358     el.add('reputation', u.reputation)
 359     el.add('badges', bronze=u.bronze, silver=u.silver, gold=u.gold)
 360     el.add('joindate', make_date(u.date_joined))
 361     el.add('active', u.is_active and 'true' or 'false')
 362
 363     el.add('realname', u.real_name)
 364     el.add('bio', u.about)
 365     el.add('location', u.location)
 366     el.add('website', u.website)
 367     el.add('birthdate', u.date_of_birth and make_date(u.date_of_birth, with_time=False) or "")
 368
 369     roles = el.add('roles')
 370
 371     if u.is_superuser:
 372         roles.add('role', 'superuser')
 373
 374     if u.is_staff:
 375         roles.add('role', 'moderator')
 376
 377     auth = el.add('authKeys')
 378     for a in u.auth_keys.all():
 379         key = auth.add('key')
 380         key.add('provider', a.provider)
 381         key.add('key', a.key)
 382
 383
 384     ss = u.subscription_settings
 385
 386     notify = el.add('notifications', enabled=ss.enable_notifications and 'true' or 'false')
 387
 388     notify.add('notify', **dict([(t, ss.__dict__.get(t, 'n') == 'i' and 'true' or 'false') for t in ['member_joins', 'new_question', 'new_question_watched_tags', 'subscribed_questions']]))
 389
 390     notify.add('autoSubscribe', **dict([(t, ss.__dict__.get(t, False) and 'true' or 'false') for t in [
 391             'all_questions', 'all_questions_watched_tags', 'questions_asked', 'questions_answered', 'questions_commented', 'questions_viewed']]))
 392
 393     notify.add('notifyOnSubscribed', **dict([(t, ss.__dict__.get("notify_%s" % t, False) and 'true' or 'false') for t in [
 394             'answers', 'reply_to_comments', 'comments_own_post', 'comments', 'accepted']]))
 395
 396     notify.add('digest', ss.send_digest and 'on' or 'off')
 397
 398     watched = el.add('watchedTags')
 399     rejected = el.add('rejectedTags')
 400
 401     for m in u.tag_selections.all():
 402         if m.reason == 'good':
 403             watched.add('tag', m.tag.name)
 404         else:
 405             rejected.add('tag', m.tag.name)
 406
 407
 408
 409 @exporter_step(Node.objects.all(), 'nodes', 'node', _('Nodes'), 'added_at')
 410 def export_nodes(n, el, anon_data):
 411     el.add('id', n.id)
 412     el.add('type', n.node_type)
 413
 414     if not anon_data:
 415         el.add('author', n.author.id)
 416     el.add('date', make_date(n.added_at))
 417     el.add('parent', n.parent and n.parent.id or "")
 418     el.add('absparent', n.abs_parent and n.abs_parent.id or "")
 419
 420     act = el.add('lastactivity')
 421     act.add('by', n.last_activity_by and n.last_activity_by.id or "")
 422     act.add('at', n.last_activity_at and make_date(n.last_activity_at) or "")
 423
 424     el.add('title', n.title)
 425     el.add('body', n.body)
 426
 427     el.add('score', n.score)
 428
 429     tags = el.add('tags')
 430
 431     for t in n.tagname_list():
 432         tags.add('tag', t)
 433
 434     try:
 435         active = n.active_revision and n.active_revision.revision or n.revisions.order_by('revision')[0].revision
 436     except IndexError:
 437         active = 0
 438
 439     revs = el.add('revisions', active=active)
 440
 441     for r in n.revisions.order_by('revision'):
 442         rev = revs.add('revision')
 443         rev.add('number', r.revision)
 444         rev.add('summary', r.summary)
 445         if not anon_data:
 446             rev.add('author', r.author.id)
 447         rev.add('date', make_date(r.revised_at))
 448
 449         rev.add('title', r.title)
 450         rev.add('body', r.body)
 451         rev.add('tags', ", ".join(r.tagname_list()))
 452
 453     el.add('marked', n.marked and 'true' or 'false')
 454     el.add('wiki', n.nis.wiki and 'true' or 'false')
 455     el.add('extraRef', n.extra_ref and n.extra_ref.id or "")
 456     make_extra(el.add('extraData'), n.extra)
 457     el.add('extraCount', n.extra_count and n.extra_count or "")
 458
 459
 460 @exporter_step(Action.objects.all(), 'actions', 'action', _('Actions'), 'action_date')
 461 def export_actions(a, el, anon_data):
 462     el.add('id', a.id)
 463     el.add('type', a.action_type)
 464     el.add('date', make_date(a.action_date))
 465
 466     if not anon_data:
 467         el.add('user', a.user.id)
 468         el.add('realUser', a.real_user and a.real_user.id or "")
 469         el.add('ip', a.ip)
 470     el.add('node', a.node and a.node.id or "")
 471
 472     make_extra(el.add('extraData'), a.extra)
 473
 474     canceled = el.add('canceled', state=a.canceled and 'true' or 'false')
 475
 476     if a.canceled:
 477         if not anon_data:
 478             canceled.add('user', a.canceled_by.id)
 479             canceled.add('ip', a.canceled_ip)
 480
 481         canceled.add('date', make_date(a.canceled_at))
 482
 483     if not anon_data:
 484         reputes = el.add('reputes')
 485
 486         for r in a.reputes.all():
 487             repute = reputes.add('repute', byCanceled=r.by_canceled and 'true' or 'false')
 488             repute.add('user', r.user.id)
 489             repute.add('value', r.value)
 490
 491
 492 #@exporter_step(NodeState.objects.all(), 'states', 'state', _('Node states'), 'action__action_date')
 493 #def export_states(s, el, anon_data):
 494 #    el.add('type', s.state_type)
 495 #    el.add('node', s.node.id)
 496 #    el.add('trigger', s.action.id)
 497
 498
 499 #@exporter_step(Badge.objects.all(), 'badges', 'badge', _('Badges'), user_data=True)
 500 #def export_badges(b, el, anon_data):
 501 #    el.add('type', ["", 'gold', 'silver', 'bronze'][b.type])
 502 #    el.add('name', b.cls)
 503 #    el.add('count', b.awarded_count)
 504
 505
 506 @exporter_step(Award.objects.all(), 'awards', 'award', _('Awards'), 'awarded_at', True)
 507 def export_awards(a, el, anon_data):
 508     el.add('badge', a.badge.cls)
 509     el.add('user', a.user.id)
 510     el.add('node', a.node and a.node.id or "")
 511     el.add('trigger', a.trigger and a.trigger.id or "")
 512     el.add('action', a.action.id)
 513
 514 @exporter_step(KeyValue.objects.all(), 'settings', 'setting', _('Settings'))
 515 def export_settings(s, el, anon_data):
 516     el.add('key', s.key)
 517     make_extra(el.add('value'), s.value)