migrate to mwxml. This completes the migration away from python-mediawiki-utilities...

[mediawiki_dump_tools.git] / wikiq

diff --git a/wikiq b/wikiq
index ad4d549c4cefa7a4220fe2ab3f399b7d3668a7b2..8a12d90980f6379d096b6fac0fb70d8f274bdb3f 100755 (executable)
--- a/wikiq
+++ b/wikiq
@@ -3,7 +3,6 @@
 # original wikiq headers are: title articleid revid date_time anon
 # editor editor_id minor text_size text_entropy text_md5 reversion
 # additions_size deletions_size
 # original wikiq headers are: title articleid revid date_time anon
 # editor editor_id minor text_size text_entropy text_md5 reversion
 # additions_size deletions_size

-

 import argparse
 import sys
 import os, os.path
 import argparse
 import sys
 import os, os.path


@@ -13,22 +12,26 @@ from subprocess import Popen, PIPE
 from collections import deque
 from hashlib import sha1
 
 from collections import deque
 from hashlib import sha1
 

-from mw.xml_dump import Iterator
-from mw.lib import persistence
+from mwxml import Dump
+
+from deltas.tokenizers import wikitext_split
+import mwpersistence

 import mwreverts
 from urllib.parse import quote
 TO_ENCODE = ('title', 'editor')
 PERSISTENCE_RADIUS=7
 import mwreverts
 from urllib.parse import quote
 TO_ENCODE = ('title', 'editor')
 PERSISTENCE_RADIUS=7

+from deltas import SequenceMatcher

 
 def calculate_persistence(tokens_added):
     return(sum([(len(x.revisions)-1) for x in tokens_added]),
            len(tokens_added))
 
 
 def calculate_persistence(tokens_added):
     return(sum([(len(x.revisions)-1) for x in tokens_added]),
            len(tokens_added))
 

+

 class WikiqIterator():
     def __init__(self, fh, collapse_user=False):
         self.fh = fh
         self.collapse_user = collapse_user
 class WikiqIterator():
     def __init__(self, fh, collapse_user=False):
         self.fh = fh
         self.collapse_user = collapse_user

-        self.mwiterator = Iterator.from_file(self.fh)
+        self.mwiterator = Dump.from_file(self.fh)

         self.__pages = self.load_pages()
 
     def load_pages(self):
         self.__pages = self.load_pages()
 
     def load_pages(self):


@@ -76,7 +79,14 @@ class WikiqPage():
             else:
                 if self.collapse_user:
                     # yield if this is the last edit in a seq by a user and reset
             else:
                 if self.collapse_user:
                     # yield if this is the last edit in a seq by a user and reset

-                    if not rev.contributor.user_text == prev_rev.contributor.user_text:
+                    # also yield if we do know who the user is
+
+                    if rev.deleted.user or prev_rev.deleted.user:
+                        yield prev_rev
+                        collapsed_revs = 1
+                        rev.collapsed_revs = collapsed_revs
+
+                    elif not rev.user.text == prev_rev.user.text:

                         yield prev_rev
                         collapsed_revs = 1
                         rev.collapsed_revs = collapsed_revs
                         yield prev_rev
                         collapsed_revs = 1
                         rev.collapsed_revs = collapsed_revs


@@ -89,6 +99,7 @@ class WikiqPage():
                     yield prev_rev
 
             prev_rev = rev
                     yield prev_rev
 
             prev_rev = rev

+

         # also yield the final time
         yield prev_rev
 
         # also yield the final time
         yield prev_rev
 


@@ -101,12 +112,13 @@ class WikiqPage():
 class WikiqParser():
 
 
 class WikiqParser():
 
 

-    def __init__(self, input_file, output_file, collapse_user=False, persist=False, urlencode=False):
+    def __init__(self, input_file, output_file, collapse_user=False, persist=False, urlencode=False, persist_legacy=False):

         
         self.input_file = input_file
         self.output_file = output_file
         self.collapse_user = collapse_user
         self.persist = persist
         
         self.input_file = input_file
         self.output_file = output_file
         self.collapse_user = collapse_user
         self.persist = persist

+        self.persist_legacy = persist_legacy

         self.printed_header = False
         self.namespaces = []
         self.urlencode = urlencode
         self.printed_header = False
         self.namespaces = []
         self.urlencode = urlencode


@@ -137,17 +149,26 @@ class WikiqParser():
         dump = WikiqIterator(self.input_file, collapse_user=self.collapse_user)
 
         # extract list of namspaces
         dump = WikiqIterator(self.input_file, collapse_user=self.collapse_user)
 
         # extract list of namspaces

-        self.namespaces = {ns.name : ns.id for ns in dump.mwiterator.namespaces}
+        self.namespaces = {ns.name : ns.id for ns in dump.mwiterator.site_info.namespaces}

 
         page_count = 0
         rev_count = 0
 
         page_count = 0
         rev_count = 0

+
+

         # Iterate through pages
         for page in dump:
         # Iterate through pages
         for page in dump:

-            if self.persist:
-                state = persistence.State()
+            rev_detector = mwreverts.Detector()
+
+            if self.persist or self.persist_legacy:

                 window = deque(maxlen=PERSISTENCE_RADIUS)
 
                 window = deque(maxlen=PERSISTENCE_RADIUS)
 

-            rev_detector = mwreverts.Detector()
+                if not self.persist_legacy:
+                    state = mwpersistence.DiffState(SequenceMatcher(tokenizer = wikitext_split),
+                                                    revert_radius=PERSISTENCE_RADIUS)
+
+                else:
+                    from mw.lib import persistence
+                    state = persistence.State()

 
             # Iterate through a page's revisions
             for rev in page:
 
             # Iterate through a page's revisions
             for rev in page:


@@ -155,23 +176,28 @@ class WikiqParser():
                 rev_data = {'revid' : rev.id,
                             'date_time' : rev.timestamp.strftime('%Y-%m-%d %H:%M:%S'),
                             'articleid' : page.id,
                 rev_data = {'revid' : rev.id,
                             'date_time' : rev.timestamp.strftime('%Y-%m-%d %H:%M:%S'),
                             'articleid' : page.id,

-                            'editor_id' : "" if rev.contributor.id == None else rev.contributor.id,
+                            'editor_id' : "" if rev.deleted.user == True or rev.user.id is None else rev.user.id,

                             'title' : '"' + page.title + '"',
                             'title' : '"' + page.title + '"',

-                            'namespace' : page.namespace if page.namespace else self.__get_namespace_from_title(page.title),
-                            'deleted' : "TRUE" if rev.text.deleted else "FALSE" } 
+                            'namespace' : page.namespace if page.namespace is not None else self.__get_namespace_from_title(page.title),
+                            'deleted' : "TRUE" if rev.deleted.text else "FALSE" } 

 
                 # if revisions are deleted, /many/ things will be missing
 
                 # if revisions are deleted, /many/ things will be missing

-                if rev.text.deleted:
+                if rev.deleted.text:

                     rev_data['text_chars'] = ""
                     rev_data['sha1'] = ""
                     rev_data['revert'] = ""
                     rev_data['reverteds'] = ""
 
                 else:
                     rev_data['text_chars'] = ""
                     rev_data['sha1'] = ""
                     rev_data['revert'] = ""
                     rev_data['reverteds'] = ""
 
                 else:

+                    # rev.text can be None if the page has no text
+                    if not rev.text:
+                        rev.text = ""

                     # if text exists, we'll check for a sha1 and generate one otherwise
                     # if text exists, we'll check for a sha1 and generate one otherwise

+

                     if rev.sha1:
                         text_sha1 = rev.sha1
                     else:
                     if rev.sha1:
                         text_sha1 = rev.sha1
                     else:

+

                         text_sha1 = sha1(bytes(rev.text, "utf8")).hexdigest()
                     
                     rev_data['sha1'] = text_sha1
                         text_sha1 = sha1(bytes(rev.text, "utf8")).hexdigest()
                     
                     rev_data['sha1'] = text_sha1


@@ -181,6 +207,7 @@ class WikiqParser():
                
                     # generate revert data
                     revert = rev_detector.process(text_sha1, rev.id)
                
                     # generate revert data
                     revert = rev_detector.process(text_sha1, rev.id)

+                    

                     if revert:
                         rev_data['revert'] = "TRUE"
                         rev_data['reverteds'] = '"' + ",".join([str(x) for x in revert.reverteds]) + '"'
                     if revert:
                         rev_data['revert'] = "TRUE"
                         rev_data['reverteds'] = '"' + ",".join([str(x) for x in revert.reverteds]) + '"'


@@ -191,10 +218,10 @@ class WikiqParser():
                 # if the fact that the edit was minor can be hidden, this might be an issue
                 rev_data['minor'] = "TRUE" if rev.minor else "FALSE"
 
                 # if the fact that the edit was minor can be hidden, this might be an issue
                 rev_data['minor'] = "TRUE" if rev.minor else "FALSE"
 

-                if rev.contributor.user_text:
+                if not rev.deleted.user:

                     # wrap user-defined editors in quotes for fread
                     # wrap user-defined editors in quotes for fread

-                    rev_data['editor'] = '"' + rev.contributor.user_text + '"'
-                    rev_data['anon'] = "TRUE" if rev.contributor.id == None else "FALSE"
+                    rev_data['editor'] = '"' + rev.user.text + '"'
+                    rev_data['anon'] = "TRUE" if rev.user.id == None else "FALSE"

                     
                 else:
                     rev_data['anon'] = ""
                     
                 else:
                     rev_data['anon'] = ""


@@ -211,12 +238,19 @@ class WikiqParser():
                 if self.collapse_user:
                     rev_data['collapsed_revs'] = rev.collapsed_revs
 
                 if self.collapse_user:
                     rev_data['collapsed_revs'] = rev.collapsed_revs
 

-                if self.persist:
-                    if rev.text.deleted:
+                if self.persist or self.persist_legacy:
+                    if rev.deleted.text:
+

                         for k in ["token_revs", "tokens_added", "tokens_removed", "tokens_window"]:
                             old_rev_data[k] = None
                     else:
                         for k in ["token_revs", "tokens_added", "tokens_removed", "tokens_window"]:
                             old_rev_data[k] = None
                     else:

-                        _, tokens_added, tokens_removed = state.process(rev.text, rev.id, text_sha1)
+
+                        if not self.persist_legacy:
+                            _, tokens_added, tokens_removed = state.update(rev.text, rev.id)
+
+                        else:
+                            _, tokens_added, tokens_removed = state.process(rev.text, rev.id, text_sha1)
+                            

                         window.append((rev.id, rev_data, tokens_added, tokens_removed))
                         
                         if len(window) == PERSISTENCE_RADIUS:
                         window.append((rev.id, rev_data, tokens_added, tokens_removed))
                         
                         if len(window) == PERSISTENCE_RADIUS:


@@ -236,7 +270,7 @@ class WikiqParser():
 
                 rev_count += 1
 
 
                 rev_count += 1
 

-            if self.persist:
+            if self.persist or self.persist_legacy:

                 # print out metadata for the last RADIUS revisions
                 for i, item in enumerate(window):
                     # if the window was full, we've already printed item 0
                 # print out metadata for the last RADIUS revisions
                 for i, item in enumerate(window):
                     # if the window was full, we've already printed item 0


@@ -263,7 +297,7 @@ class WikiqParser():
         if self.urlencode:
             for field in TO_ENCODE:
                 rev_data[field] = quote(str(rev_data[field]))
         if self.urlencode:
             for field in TO_ENCODE:
                 rev_data[field] = quote(str(rev_data[field]))

-            
+

         if not self.printed_header:
             print("\t".join([str(k) for k in sorted(rev_data.keys())]), file=self.output_file)
             self.printed_header = True
         if not self.printed_header:
             print("\t".join([str(k) for k in sorted(rev_data.keys())]), file=self.output_file)
             self.printed_header = True


@@ -316,6 +350,9 @@ parser.add_argument('-p', '--persistence', dest="persist", action="store_true",
 parser.add_argument('-u', '--url-encode', dest="urlencode", action="store_true",
                     help="Output url encoded text strings. This works around some data issues like newlines in editor names. In the future it may be used to output other text data.")
 
 parser.add_argument('-u', '--url-encode', dest="urlencode", action="store_true",
                     help="Output url encoded text strings. This works around some data issues like newlines in editor names. In the future it may be used to output other text data.")
 

+parser.add_argument('--persistence-legacy', dest="persist_legacy", action="store_true",
+                    help="Legacy behavior for persistence calculation. Output url encoded text strings. This works around some data issues like newlines in editor names. In the future it may be used to output other text data.")
+

 args = parser.parse_args()
 
 if len(args.dumpfiles) > 0:
 args = parser.parse_args()
 
 if len(args.dumpfiles) > 0:


@@ -339,6 +376,7 @@ if len(args.dumpfiles) > 0:
         wikiq = WikiqParser(input_file, output_file, 
                             collapse_user=args.collapse_user,
                             persist=args.persist,
         wikiq = WikiqParser(input_file, output_file, 
                             collapse_user=args.collapse_user,
                             persist=args.persist,

+                            persist_legacy=args.persist_legacy,

                             urlencode=args.urlencode)
 
 
                             urlencode=args.urlencode)
 
 


@@ -351,6 +389,7 @@ else:
     wikiq = WikiqParser(sys.stdin, sys.stdout,
                         collapse_user=args.collapse_user,
                         persist=args.persist,
     wikiq = WikiqParser(sys.stdin, sys.stdout,
                         collapse_user=args.collapse_user,
                         persist=args.persist,

+                        persist_legacy=args.persist_legacy,

                         urlencode=args.urlencode)
     wikiq.process()
 
                         urlencode=args.urlencode)
     wikiq.process()