forum_modules/exporter/exporter.py

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