server config item, docs

[oss/ljdump.git] / ljdump.py

diff --git a/ljdump.py b/ljdump.py
index 65903fda98df8427d0bafee6941339407edf4e7e..67e185155139820523b3beeaa952d3a10b5a4560 100755 (executable)
--- a/ljdump.py
+++ b/ljdump.py
@@ -1,3 +1,50 @@
+#
+# ljdump.py - livejournal archiver
+# Greg Hewgill <greg@hewgill.com> http://hewgill.com
+# Version 1.0
+#
+# $Id$
+#
+# This program reads the journal entries from a livejournal (or compatible)
+# blog site and archives them in a subdirectory named after the journal name.
+#
+# The configuration is read from "ljdump.config". A sample configuration is
+# provided in "ljdump.config.sample", which should be copied and then edited.
+# The configuration settings are:
+#
+#   server - The XMLRPC server URL. This should only need to be changed
+#            if you are dumping a journal that is livejournal-compatible
+#            but is not livejournal itself.
+#
+#   username - The livejournal user name. A subdirectory will be created
+#              with this same name to store the journal entries.
+#
+#   password - The account password. This password is never sent in the
+#              clear; the livejournal "challenge" password mechanism is used.
+#
+# This program may be run as often as needed to bring the backup copy up
+# to date. Only new items are downloaded.
+#
+# LICENSE
+#
+# This software is provided 'as-is', without any express or implied
+# warranty.  In no event will the author be held liable for any damages
+# arising from the use of this software.
+#
+# Permission is granted to anyone to use this software for any purpose,
+# including commercial applications, and to alter it and redistribute it
+# freely, subject to the following restrictions:
+#
+# 1. The origin of this software must not be misrepresented; you must not
+#    claim that you wrote the original software. If you use this software
+#    in a product, an acknowledgment in the product documentation would be
+#    appreciated but is not required.
+# 2. Altered source versions must be plainly marked as such, and must not be
+#    misrepresented as being the original software.
+# 3. This notice may not be removed or altered from any source distribution.
+#
+# Copyright (c) 2005 Greg Hewgill
+
 import codecs, md5, os, pprint, sys, xml.dom.minidom, xmlrpclib
 from xml.sax import saxutils
 
@@ -20,17 +67,30 @@ def dumpelement(f, name, e):
             f.write("<%s>%s</%s>\n" % (k, saxutils.escape(s), k))
     f.write("</%s>\n" % name)
 
-def writedump(itemid, event):
-    f = codecs.open("archive/"+itemid, "w", "UTF-8")
+def writedump(fn, event):
+    f = codecs.open(fn, "w", "UTF-8")
     f.write("""<?xml version="1.0"?>\n""")
     dumpelement(f, "event", event)
     f.close()
 
 config = xml.dom.minidom.parse("ljdump.config")
+Server = config.documentElement.getElementsByTagName("server")[0].childNodes[0].data
 Username = config.documentElement.getElementsByTagName("username")[0].childNodes[0].data
 Password = config.documentElement.getElementsByTagName("password")[0].childNodes[0].data
 
-server = xmlrpclib.ServerProxy("http://livejournal.com/interface/xmlrpc")
+print "Fetching journal entries for: %s" % Username
+try:
+    os.mkdir(Username)
+    print "Created subdirectory: %s" % Username
+except:
+    pass
+
+server = xmlrpclib.ServerProxy(Server)
+
+total = 0
+fetched = 0
+errors = 0
+
 last = ""
 while True:
     r = server.LJ.XMLRPC.syncitems(dochallenge({
@@ -42,9 +102,10 @@ while True:
     if len(r['syncitems']) == 0:
         break
     for item in r['syncitems']:
-        #print item['item']
         if item['item'][0] == 'L':
-            if not os.access("archive/"+item['item'], os.F_OK):
+            fn = "%s/%s" % (Username, item['item'])
+            if not os.access(fn, os.F_OK):
+                print "Fetching journal entry %s" % item['item']
                 try:
                     e = server.LJ.XMLRPC.getevents(dochallenge({
                         'username': Username,
@@ -52,8 +113,15 @@ while True:
                         'selecttype': "one",
                         'itemid': item['item'][2:],
                     }, Password))
-                    writedump(item['item'], e['events'][0])
+                    writedump(fn, e['events'][0])
+                    fetched += 1
                 except xmlrpclib.Fault, x:
                     print "Error getting item: %s" % item['item']
                     pprint.pprint(x)
+                    errors += 1
         last = item['time']
+        total += 1
+print "%d total entries" % total
+print "%d fetched entries" % fetched
+if errors > 0:
+    print "%d errors" % errors