From ac199038a93bdb0c0d010fa8862bf1c677bec0c2 Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Sun, 29 Dec 2013 23:41:35 +0530 Subject: Added src/gns_wiki.py. This has functions that pushes a wiki page to a wiki using XML-RPC. Functions in gns_wiki.py: update, generate_wiki_page. --- src/gns_wiki.py | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 src/gns_wiki.py (limited to 'src/gns_wiki.py') diff --git a/src/gns_wiki.py b/src/gns_wiki.py new file mode 100644 index 0000000..aee41ac --- /dev/null +++ b/src/gns_wiki.py @@ -0,0 +1,57 @@ +# Copyright 2013 rsiddharth +# +# This work is free. You can redistribute it and/or modify it under +# the terms of the Do What The Fuck You Want To Public License, +# Version 2, as published by Sam Hocevar. See the COPYING file or +# for more details. + +import xmlrpclib as xmlrpc +from xmlrpclib import Fault + +def update(table): + """ + Generates wiki page using table and pushes it to the wiki using XML-RPC. + """ + + # Code below adapted from + # http://moinmo.in/MoinAPI/Examples#xmlrpc.putPage.28.29 + + name = raw_input("username> ") + password = raw_input("pass> ") + wikiurl = "http://localhost/m" + homewiki = xmlrpc.ServerProxy(wikiurl + "?action=xmlrpc2", + allow_none=True) + auth_token = homewiki.getAuthToken(name, password) + mc = xmlrpc.MultiCall(homewiki) + mc.applyAuthToken(auth_token) + pagename = "Documentation/3/DifferencesWithDebian" + page_content = generate_wiki_page(table) + mc.putPage(pagename, page_content) + result = mc() + + try: + sucess, raw = tuple(result) + + if sucess: + print "Updated %s" % pagename + else: + print "Something went wrong. Please report this issue." + + except Fault: + print "Nothing new. %s/%s was not updated" % (wikiurl, + pagename) + +def generate_wiki_page(table): + """ + Generates the wiki page using the table. + + `differences-with-debian.txt' file, used by this function, + contains text that precedes the table. + """ + + page_content = open("src/differences-with-debian.txt", "r").read() + "\n" + + for row in table: + page_content += row + "\n" + + return page_content -- cgit v1.2.3 From b818ebce9d25d7ce4376d1e261ff10c4906f0878 Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Thu, 2 Jan 2014 15:00:07 +0530 Subject: The script updates the wiki page has changed. --- src/gns_wiki.py | 113 +++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 92 insertions(+), 21 deletions(-) (limited to 'src/gns_wiki.py') diff --git a/src/gns_wiki.py b/src/gns_wiki.py index aee41ac..dba0102 100644 --- a/src/gns_wiki.py +++ b/src/gns_wiki.py @@ -7,8 +7,28 @@ import xmlrpclib as xmlrpc from xmlrpclib import Fault +import filecmp +import os.path as path -def update(table): +def get_topsecret(src_dir): + """ + Returns the username, password & wikiurl + + They are stored in src/config/ directory in the topsecret.txt + file. + """ + + secrets = open(path.join(src_dir, + "config", + "topsecret.txt"), "r").readlines() + + username = secrets[0].strip() + password = secrets[1].strip() + wikiurl = secrets[2].strip() + + return username, password, wikiurl + +def update(table, src_dir): """ Generates wiki page using table and pushes it to the wiki using XML-RPC. """ @@ -16,42 +36,93 @@ def update(table): # Code below adapted from # http://moinmo.in/MoinAPI/Examples#xmlrpc.putPage.28.29 - name = raw_input("username> ") - password = raw_input("pass> ") - wikiurl = "http://localhost/m" + name, password, wikiurl = get_topsecret(src_dir) homewiki = xmlrpc.ServerProxy(wikiurl + "?action=xmlrpc2", allow_none=True) auth_token = homewiki.getAuthToken(name, password) mc = xmlrpc.MultiCall(homewiki) mc.applyAuthToken(auth_token) pagename = "Documentation/3/DifferencesWithDebian" - page_content = generate_wiki_page(table) - mc.putPage(pagename, page_content) - result = mc() + wiki_page_content, update = generate_wiki_page(table, src_dir) + + if(update): + # Send the updated wiki page to moin wiki: + mc.putPage(pagename, wiki_page_content) + result = mc() - try: - sucess, raw = tuple(result) + try: + success, raw = tuple(result) - if sucess: - print "Updated %s" % pagename - else: - print "Something went wrong. Please report this issue." + if success: + print "Updated %s" % pagename + else: + print "Something went wrong. Please report this issue." - except Fault: - print "Nothing new. %s/%s was not updated" % (wikiurl, - pagename) + except Fault, e: + print e + else: + print "Nothing new! %s/%s was not updated" % (wikiurl, + pagename) -def generate_wiki_page(table): +def generate_wiki_page(table, src_dir): """ Generates the wiki page using the table. - `differences-with-debian.txt' file, used by this function, + `differences-with-debian-head.txt' file, used by this function, contains text that precedes the table. """ - page_content = open("src/differences-with-debian.txt", "r").read() + "\n" + # generate wikipage + diff_with_deb_head = path.join(src_dir, + "wiki-files", + "differences-with-debian-head.txt") + wiki_page_content = open(diff_with_deb_head, "r").read() + "\n" for row in table: - page_content += row + "\n" + wiki_page_content += row + "\n" + + update = wiki_page_updated(wiki_page_content, src_dir) + + return wiki_page_content, update + + +def wiki_page_updated(wiki_page_content, src_dir): + """ + Returns True if the wiki page is updated + """ + + # write wikipage to temp file + temp_file = open("/tmp/diff-with-deb-tmp.txt", "w") + temp_file.write(wiki_page_content) + temp_file.close() + + # this file contains the wiki page last generated by the script. + diff_with_deb = path.join(src_dir, + "wiki-files", + "differences-with-debian.txt") + + # first check if the file exists + if(path.isfile(diff_with_deb)): + # filecmp.cmp returns True if both the file are same. + update = (filecmp.cmp(temp_file.name, + diff_with_deb, 1) == False) + else: + # This is the first time the page is generated, + # so update the wiki. + update = True + + if(update): + update_wiki_page_locally(wiki_page_content, diff_with_deb) + + return update + + +def update_wiki_page_locally(wiki_page_content, filename): + """ + Writes the wiki page locally to `filename' + """ + + wiki_file = open(filename, "w") + wiki_file.write(wiki_page_content) + wiki_file.close() - return page_content -- cgit v1.2.3 From 5e44da9ab175ba17079c6703f2034ea51e791489 Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Thu, 2 Jan 2014 16:18:15 +0530 Subject: IOError caused when opening non-existent topsecret.txt file is handled now. --- src/gns_wiki.py | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) (limited to 'src/gns_wiki.py') diff --git a/src/gns_wiki.py b/src/gns_wiki.py index dba0102..6b40936 100644 --- a/src/gns_wiki.py +++ b/src/gns_wiki.py @@ -18,13 +18,18 @@ def get_topsecret(src_dir): file. """ - secrets = open(path.join(src_dir, - "config", - "topsecret.txt"), "r").readlines() - - username = secrets[0].strip() - password = secrets[1].strip() - wikiurl = secrets[2].strip() + try: + secrets = open(path.join(src_dir, + "config", + "topsecret.txt"), "r").readlines() + + username = secrets[0].strip() + password = secrets[1].strip() + wikiurl = secrets[2].strip() + except IOError: + print "ERROR: Specify your wikiusername, password & wikiurl at \ +`src/config/topsecret.txt`. Look at the README for the proper format." + exit(1) return username, password, wikiurl -- cgit v1.2.3 From b6e406da07b5ac327c28deb7f1bfc7e5a7399adb Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Thu, 2 Jan 2014 16:40:03 +0530 Subject: bugfix: local copy of the wiki page is made only when the remote update is successful. --- src/gns_wiki.py | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) (limited to 'src/gns_wiki.py') diff --git a/src/gns_wiki.py b/src/gns_wiki.py index 6b40936..749a89f 100644 --- a/src/gns_wiki.py +++ b/src/gns_wiki.py @@ -54,17 +54,21 @@ def update(table, src_dir): # Send the updated wiki page to moin wiki: mc.putPage(pagename, wiki_page_content) result = mc() + success = None try: - success, raw = tuple(result) - - if success: - print "Updated %s" % pagename - else: - print "Something went wrong. Please report this issue." - + success = result[1] except Fault, e: print e + + if success: + print "Updated %s" % (pagename) + update_wiki_page_locally( + wiki_page_content, + path.join(src_dir, "wiki-files", + "differences-with-debian.txt")) + else: + print ">> Script did not update wiki <<" else: print "Nothing new! %s/%s was not updated" % (wikiurl, pagename) @@ -112,13 +116,10 @@ def wiki_page_updated(wiki_page_content, src_dir): update = (filecmp.cmp(temp_file.name, diff_with_deb, 1) == False) else: - # This is the first time the page is generated, - # so update the wiki. + # we don't have a local copy of the wiki page. So, let's + # update the wiki. update = True - if(update): - update_wiki_page_locally(wiki_page_content, diff_with_deb) - return update -- cgit v1.2.3