mirror of https://github.com/moparisthebest/xeps
Merge branches 'feature/editor-tooling', 'feature/xep-0045', 'feature/xep-0060', 'feature/xep-0234', 'feature/xep-0321', 'feature/xep-0369', 'feature/xep-0388', 'feature/xep-0390', 'feature/protoxep-jet' and 'feature/protoxep-pubsub-cap'
Jonas Wielicki
6 years ago
parent
a4f01fabf3
d0bbbb2d5c
c92813d007
b17bad8b0a
84b4da8c76
1b15a44243
ec8edf0818
718ec6240b
062611e227
3eecf3a1ef
f68cd2e146
commit
607dc078c5
@ -1,56 +0,0 @@
|
||||
#!/bin/sh
|
||||
# for all XEPs, generates HTML files and IETF-style reference, then copies XML file
|
||||
# usage: ./all.sh
|
||||
|
||||
## LICENSE ##
|
||||
#
|
||||
# Copyright (c) 1999 - 2013 XMPP Standards Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
## END LICENSE ##
|
||||
|
||||
xeppath=/var/www/vhosts/xmpp.org/extensions
|
||||
|
||||
ls xep-0*.xml > tmp1.txt
|
||||
sed s/^xep-// tmp1.txt > tmp2.txt
|
||||
sed s/.xml$// tmp2.txt > nums.txt
|
||||
rm tmp*.txt
|
||||
|
||||
while read f
|
||||
do
|
||||
xsltproc xep.xsl xep-$f.xml > $xeppath/xep-$f.html
|
||||
xsltproc ref.xsl xep-$f.xml > $xeppath/refs/reference.XSF.XEP-$f.xml
|
||||
xsltproc examples.xsl xep-$f.xml > $xeppath/examples/$f.xml
|
||||
./gen.py $f
|
||||
cp xep-$f.xml $xeppath/
|
||||
./gen.py $f
|
||||
done < nums.txt
|
||||
|
||||
rm nums.txt
|
||||
|
||||
xsltproc xep.xsl xep-README.xml > $xeppath/README.html
|
||||
xsltproc xep.xsl xep-template.xml > $xeppath/template.html
|
||||
|
||||
cp *.dtd $xeppath/
|
||||
cp *.ent $xeppath/
|
||||
cp *.shtml $xeppath/
|
||||
cp *.xsd $xeppath/
|
||||
|
||||
# END
|
||||
@ -1,196 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
# File: announce.py
|
||||
# Version: 0.9
|
||||
# Description: a script for announcing XEPs
|
||||
# Last Modified: 2016-10-03
|
||||
# Author: Peter Saint-Andre (stpeter@jabber.org)
|
||||
# License: public domain
|
||||
# HowTo: ./announce.py xepnum
|
||||
|
||||
## LICENSE ##
|
||||
#
|
||||
# Copyright (c) 1999 - 2010 XMPP Standards Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
## END LICENSE ##
|
||||
|
||||
# IMPORTS:
|
||||
#
|
||||
import glob
|
||||
import os
|
||||
from select import select
|
||||
import smtplib
|
||||
import socket
|
||||
from string import split,strip,join,find
|
||||
import sys
|
||||
import time
|
||||
from xml.dom.minidom import parse,parseString,Document
|
||||
|
||||
def getText(nodelist):
|
||||
thisText = ""
|
||||
for node in nodelist:
|
||||
if node.nodeType == node.TEXT_NODE:
|
||||
thisText = thisText + node.data
|
||||
return thisText
|
||||
|
||||
# get the seconds in the Unix era
|
||||
now = int(time.time())
|
||||
|
||||
# READ IN ARGS:
|
||||
#
|
||||
# 1. XEP number
|
||||
|
||||
xepnum = sys.argv[1];
|
||||
|
||||
xepfile = 'xep-' + xepnum + '.xml'
|
||||
|
||||
# PARSE XEP HEADERS:
|
||||
#
|
||||
# - title
|
||||
# - abstract
|
||||
# - version
|
||||
# - date
|
||||
# - initials
|
||||
# - remark
|
||||
|
||||
thexep = parse(xepfile)
|
||||
xepNode = (thexep.getElementsByTagName("xep")[0])
|
||||
headerNode = (xepNode.getElementsByTagName("header")[0])
|
||||
titleNode = (headerNode.getElementsByTagName("title")[0])
|
||||
title = getText(titleNode.childNodes)
|
||||
abstractNode = (headerNode.getElementsByTagName("abstract")[0])
|
||||
abstract = getText(abstractNode.childNodes)
|
||||
statusNode = (headerNode.getElementsByTagName("status")[0])
|
||||
xepstatus = getText(statusNode.childNodes)
|
||||
typeNode = (headerNode.getElementsByTagName("type")[0])
|
||||
xeptype = getText(typeNode.childNodes)
|
||||
revNodes = headerNode.getElementsByTagName("revision")
|
||||
revNode = revNodes[0]
|
||||
versionNode = (revNode.getElementsByTagName("version")[0])
|
||||
version = getText(versionNode.childNodes)
|
||||
dateNode = (revNode.getElementsByTagName("date")[0])
|
||||
date = getText(dateNode.childNodes)
|
||||
initialsNode = (revNode.getElementsByTagName("initials")[0])
|
||||
initials = getText(initialsNode.childNodes)
|
||||
remNode = (revNode.getElementsByTagName("remark")[0])
|
||||
# could be <p> or <ul>
|
||||
testRemarkNode = remNode.firstChild.nodeName
|
||||
# print testRemarkNode
|
||||
if (testRemarkNode == "p"):
|
||||
remarkNode = (remNode.getElementsByTagName("p")[0])
|
||||
remark = getText(remarkNode.childNodes)
|
||||
else:
|
||||
remark = "[See revision history]"
|
||||
|
||||
# what kind of action are we taking?
|
||||
xepflag = ""
|
||||
if (version == "0.1" or version == "0.1.0"):
|
||||
xepflag = "new"
|
||||
elif ((version == "1.0" or version == "1.0.0") and xeptype == "Standards Track"):
|
||||
xepflag = "draft"
|
||||
elif ((version == "1.0" or version == "1.0.0") and xeptype != "Standards Track"):
|
||||
xepflag = "active"
|
||||
elif (version == "2.0" or version == "2.0.0"):
|
||||
xepflag = "final"
|
||||
elif (xepstatus == "Retracted"):
|
||||
xepflag = "retract"
|
||||
elif (xepstatus == "Deprecated"):
|
||||
xepflag = "deprecate"
|
||||
elif (xepstatus == "Obsolete"):
|
||||
xepflag = "obsolete"
|
||||
elif (xepstatus == "Deferred"):
|
||||
xepflag = "defer"
|
||||
|
||||
# generate the diffs URL
|
||||
if len(revNodes) > 1:
|
||||
prevRevNode = revNodes[1]
|
||||
prevVersionNode = (prevRevNode.getElementsByTagName("version")[0])
|
||||
prevVersion = getText(prevVersionNode.childNodes)
|
||||
diffs = 'https://xmpp.org/extensions/diff/api/xep/' + xepnum + '/diff/' + prevVersion + '/vs/' + version
|
||||
else:
|
||||
diffs = 'N/A'
|
||||
|
||||
## SEND MAIL:
|
||||
#
|
||||
# From: editor@xmpp.org
|
||||
# To: standards@xmpp.org
|
||||
# Subject: UPDATED: XEP-$xepnum ($title)
|
||||
# [or "NEW..." if version 0.1]
|
||||
# Body:
|
||||
# Version $version of XEP-$xepnum ($title) is now available.
|
||||
# Abstract: $abstract
|
||||
# Changelog: $remark ($initials)
|
||||
# Diff: $diffs ### no longer in use
|
||||
# URL: https://xmpp.org/extensions/xep-$xepnum.html
|
||||
|
||||
fromaddr = "editor@xmpp.org"
|
||||
# for testing...
|
||||
# toaddrs = "stpeter@jabber.org"
|
||||
# for real...
|
||||
toaddrs = "standards@xmpp.org"
|
||||
|
||||
if xepflag == "new":
|
||||
thesubject = 'NEW: XEP-'
|
||||
elif xepflag == "draft":
|
||||
thesubject = 'DRAFT: XEP-'
|
||||
elif xepflag == "final":
|
||||
thesubject = 'FINAL: XEP-'
|
||||
elif xepflag == "active":
|
||||
thesubject = 'ACTIVE: XEP-'
|
||||
elif xepflag == "retract":
|
||||
thesubject = 'RETRACTED: XEP-'
|
||||
elif xepflag == "deprecate":
|
||||
thesubject = 'DEPRECATED: XEP-'
|
||||
elif xepflag == "obsolete":
|
||||
thesubject = 'OBSOLETE: XEP-'
|
||||
elif xepflag == "defer":
|
||||
thesubject = 'DEFERRED: XEP-'
|
||||
else:
|
||||
thesubject = 'UPDATED: XEP-'
|
||||
thesubject = thesubject + xepnum + ' (' + title + ')'
|
||||
|
||||
versionline = 'Version ' + version + ' of XEP-' + xepnum + ' (' + title + ') has been released.'
|
||||
abstractline = 'Abstract: ' + abstract
|
||||
changelogline = 'Changelog: ' + remark + ' (' + initials + ')'
|
||||
diffsline = 'Diff: ' + diffs
|
||||
urlline = 'URL: https://xmpp.org/extensions/xep-' + xepnum + '.html'
|
||||
|
||||
msg = "From: XMPP Extensions Editor <%s>\r\n" % fromaddr
|
||||
msg = msg + "To: %s\r\n" % toaddrs
|
||||
msg = msg + "Subject: %s\r\n" % thesubject
|
||||
msg = msg + versionline
|
||||
msg = msg + "\r\n\n"
|
||||
msg = msg + abstractline
|
||||
msg = msg + "\r\n\n"
|
||||
msg = msg + changelogline
|
||||
msg = msg + "\r\n\n"
|
||||
msg = msg + diffsline
|
||||
msg = msg + "\r\n\n"
|
||||
msg = msg + urlline
|
||||
msg = msg + "\r\n\n"
|
||||
|
||||
server = smtplib.SMTP('localhost')
|
||||
server.set_debuglevel(1)
|
||||
server.sendmail(fromaddr, toaddrs, msg)
|
||||
server.quit()
|
||||
|
||||
# END
|
||||
|
||||
@ -1,432 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
# File: gen.py
|
||||
# Version: 0.2
|
||||
# Description: a renewed XEP compilation tool
|
||||
# Last Modified: 2009
|
||||
# Author: Tobias Markmann (tm@ayena.de)
|
||||
# HowTo: ./gen.py xep-####.xml
|
||||
|
||||
## LICENSE ##
|
||||
#
|
||||
# Copyright (c) 1999 - 2010 XMPP Standards Foundation
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in
|
||||
# all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
# THE SOFTWARE.
|
||||
#
|
||||
## END LICENSE ##
|
||||
|
||||
import pickle
|
||||
import commands
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
import getopt
|
||||
import glob
|
||||
import tempfile
|
||||
|
||||
from xepinfo import XEPInfo
|
||||
from xeputil import getLatestXEPFilename
|
||||
|
||||
from xml.dom.minidom import parse,parseString,Document,getDOMImplementation
|
||||
|
||||
# for serializing inline images
|
||||
import base64
|
||||
import urlparse
|
||||
import urllib
|
||||
|
||||
XEPPATH = "/var/www/vhosts/xmpp.org/extensions"
|
||||
CONFIGPATH = "/var/local/xsf"
|
||||
|
||||
verbose = False
|
||||
fast = False
|
||||
last_build = {}
|
||||
|
||||
files_to_delete = [];
|
||||
|
||||
def serializeInlineImage(output_dir, xep_nr, no, attrValue):
|
||||
up = urlparse.urlparse(attrValue)
|
||||
if up.scheme == 'data':
|
||||
head, data = up.path.split(',')
|
||||
bits = head.split(';')
|
||||
mime_type = bits[0] if bits[0] else 'text/plain'
|
||||
charset, b64 = 'ASCII', False
|
||||
for bit in bits[1]:
|
||||
if bit.startswith('charset='):
|
||||
charset = bit[8:]
|
||||
elif bit == 'base64':
|
||||
b64 = True
|
||||
|
||||
# Do something smart with charset and b64 instead of assuming
|
||||
plaindata = base64.b64decode(data)
|
||||
|
||||
# Do something smart with mime_type
|
||||
if mime_type in ('image/png', 'image/jpeg'):
|
||||
file_ext = mime_type.split('/')[1]
|
||||
f = open(output_dir + '/' + 'inlineimage-' + xep_nr + '-' + str(no) + '.' + file_ext, 'wb')
|
||||
f.write(plaindata)
|
||||
elif up.scheme == 'http':
|
||||
file_name, file_ext = os.path.splitext(up.path)
|
||||
urllib.urlretrieve(attrValue, output_dir + '/' + 'inlineimage-' + xep_nr + '-' + str(no) + file_ext)
|
||||
|
||||
def serializeXEPInlineImages(output_dir, xep_nr, filename):
|
||||
dom = parse(filename)
|
||||
imgs = dom.getElementsByTagName('img')
|
||||
for (no, img) in enumerate(imgs):
|
||||
serializeInlineImage(output_dir, xep_nr, no, img.attributes["src"].value)
|
||||
|
||||
def getText(nodelist):
|
||||
thisText = ""
|
||||
for node in nodelist:
|
||||
if node.nodeType == node.TEXT_NODE:
|
||||
thisText = thisText + node.data
|
||||
return thisText
|
||||
|
||||
def executeCommand( cmd ):
|
||||
error, desc = commands.getstatusoutput( cmd )
|
||||
return error, desc + "\n" + "executed cmd: " + cmd
|
||||
|
||||
## creates a HTML table (for the human reader) and XML table (for bots)
|
||||
class XEPTable:
|
||||
def __init__(self, filename, shortXMLfilename):
|
||||
self.filename = filename
|
||||
self.shortXMLfilename = shortXMLfilename
|
||||
|
||||
try:
|
||||
self.tableFile = parse(filename)
|
||||
except:
|
||||
impl = getDOMImplementation()
|
||||
self.tableFile = impl.createDocument(None, "table", None)
|
||||
self.tableFile.getElementsByTagName("table")[0].setAttribute("class", "sortable")
|
||||
self.tableFile.getElementsByTagName("table")[0].setAttribute("id", "xeplist")
|
||||
self.tableFile.getElementsByTagName("table")[0].setAttribute("cellspacing", "0")
|
||||
self.tableFile.getElementsByTagName("table")[0].setAttribute("cellpadding", "3")
|
||||
self.tableFile.getElementsByTagName("table")[0].setAttribute("border", "1")
|
||||
|
||||
header = parseString(
|
||||
'''<tr class='xepheader'>
|
||||
<th align='left'>Number</th>
|
||||
<th align='left'>Name</th>
|
||||
<th align='left'>Type</th>
|
||||
<th align='left'>Status</th>
|
||||
<th align='left'>Date</th>
|
||||
</tr>''')
|
||||
self.tableFile.getElementsByTagName("table")[0].appendChild(header.getElementsByTagName("tr")[0])
|
||||
|
||||
try:
|
||||
self.botsFile = parse(shortXMLfilename)
|
||||
except:
|
||||
impl = getDOMImplementation()
|
||||
self.botsFile = impl.createDocument(None, "xeps", None)
|
||||
|
||||
def save(self):
|
||||
f = open(self.filename, "wb")
|
||||
self.tableFile.getElementsByTagName("table")[0].normalize()
|
||||
f.write(self.tableFile.toxml())
|
||||
f.close()
|
||||
|
||||
f = open(self.shortXMLfilename, "wb")
|
||||
self.botsFile.getElementsByTagName("xeps")[0].normalize()
|
||||
f.write(self.botsFile.toxml())
|
||||
f.close()
|
||||
|
||||
def setXEP(self, info):
|
||||
## set for HTML table
|
||||
rows = self.tableFile.getElementsByTagName("tr")
|
||||
xeprow = 0
|
||||
for row in rows:
|
||||
if row.getAttribute("id") == "xep" + info.getNr():
|
||||
xeprow = row
|
||||
break
|
||||
|
||||
if xeprow == 0:
|
||||
xeprow = self.tableFile.createElement("tr")
|
||||
self.tableFile.getElementsByTagName("table")[0].appendChild(xeprow)
|
||||
self.tableFile.getElementsByTagName("table")[0].appendChild(self.tableFile.createTextNode('''
|
||||
'''))
|
||||
xeprow.setAttribute("id", "xep" + info.getNr())
|
||||
xeprow.setAttribute("class", "tablebody XEP-" + info.getStatus())
|
||||
else:
|
||||
xeprow.setAttribute("class", "tablebody XEP-" + info.getStatus())
|
||||
while(xeprow.hasChildNodes()):
|
||||
xeprow.removeChild(xeprow.firstChild)
|
||||
|
||||
col = parseString('''<td valign='top'><a href='/extensions/xep-''' + info.getNr() + ".html'>XEP-" + info.getNr() + '''</a> <a href='/extensions/xep-''' + info.getNr() + '''.pdf'>(PDF)</a></td>''')
|
||||
xeprow.appendChild(col.getElementsByTagName("td")[0])
|
||||
|
||||
col = parseString("<td valign='top'>" + info.getTitle() + "</td>")
|
||||
xeprow.appendChild(col.getElementsByTagName("td")[0])
|
||||
|
||||
col = parseString("<td valign='top'>" + info.getType() + "</td>")
|
||||
xeprow.appendChild(col.getElementsByTagName("td")[0])
|
||||
|
||||
col = parseString("<td valign='top'>" + info.getStatus() + "</td>")
|
||||
xeprow.appendChild(col.getElementsByTagName("td")[0])
|
||||
|
||||
col = parseString("<td valign='top'>" + info.getDate() + "</td>")
|
||||
xeprow.appendChild(col.getElementsByTagName("td")[0])
|
||||
|
||||
## set for bots file
|
||||
xeps = self.botsFile.getElementsByTagName("xep")
|
||||
xep = 0
|
||||
for xeps_xep in xeps:
|
||||
if xeps_xep.getElementsByTagName("number")[0].firstChild.data == info.getNr():
|
||||
xep = xeps_xep
|
||||
break
|
||||
|
||||
if xep == 0:
|
||||
xep = self.botsFile.createElement("xep")
|
||||
self.botsFile.getElementsByTagName("xeps")[0].appendChild(xep)
|
||||
self.botsFile.getElementsByTagName("xeps")[0].appendChild(self.botsFile.createTextNode('''
|
||||
'''))
|
||||
else:
|
||||
while(xep.hasChildNodes()):
|
||||
xep.removeChild(xep.firstChild)
|
||||
|
||||
child = parseString("<number>" + info.getNr() + "</number>")
|
||||
xep.appendChild(child.getElementsByTagName("number")[0])
|
||||
|
||||
child = parseString("<name>" + info.getTitle() + "</name>")
|
||||
xep.appendChild(child.getElementsByTagName("name")[0])
|
||||
|
||||
child = parseString("<type>" + info.getType() + "</type>")
|
||||
xep.appendChild(child.getElementsByTagName("type")[0])
|
||||
|
||||
child = parseString("<status>" + info.getStatus() + "</status>")
|
||||
xep.appendChild(child.getElementsByTagName("status")[0])
|
||||
|
||||
child = parseString("<updated>" + info.getDate() + "</updated>")
|
||||
xep.appendChild(child.getElementsByTagName("updated")[0])
|
||||
|
||||
child = parseString("<shortname>" + info.getShortname() + "</shortname>")
|
||||
xep.appendChild(child.getElementsByTagName("shortname")[0])
|
||||
|
||||
child = parseString("<abstract>" + info.getAbstract() + "</abstract>")
|
||||
xep.appendChild(child.getElementsByTagName("abstract")[0])
|
||||
|
||||
def filebase( filename ):
|
||||
return os.path.splitext(os.path.basename(filename))[0]
|
||||
|
||||
|
||||
def checkError( error, desc):
|
||||
global verbose
|
||||
|
||||
if error != 0:
|
||||
if verbose:
|
||||
print "Error: ", desc
|
||||
return False
|
||||
return True
|
||||
|
||||
def fileHash( filename ):
|
||||
f = open(filename, "rb")
|
||||
import hashlib
|
||||
h = hashlib.sha1()
|
||||
h.update(f.read())
|
||||
hash = h.hexdigest()
|
||||
f.close()
|
||||
return hash
|
||||
|
||||
def loadDict( filename ):
|
||||
try:
|
||||
f = open(filename, "rb")
|
||||
di = pickle.load(f)
|
||||
f.close()
|
||||
return di
|
||||
except:
|
||||
print "failed loading dict."
|
||||
return {}
|
||||
|
||||
def saveDict( filename, di ):
|
||||
f = open(filename, "w")
|
||||
pickle.dump(di, f)
|
||||
f.close()
|
||||
|
||||
def buildXHTML( file, nr ):
|
||||
error, desc = executeCommand("xsltproc xep.xsl " + file + " > " + XEPPATH + "/xep-" + nr + ".html")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
error, desc = executeCommand("xsltproc ref.xsl xep-" + nr + ".xml > " + XEPPATH + "/refs/reference.XSF.XEP-" + nr + ".xml")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
error, desc = executeCommand("xsltproc examples.xsl xep-" + nr + ".xml > " + XEPPATH + "/examples/" + nr + ".xml")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
error, desc = executeCommand(" cp xep-" + nr + ".xml " + XEPPATH + "/")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
return True
|
||||
|
||||
def buildPDF( file, nr ):
|
||||
serializeXEPInlineImages("/tmp/xepbuilder", nr, file)
|
||||
|
||||
error, desc = executeCommand("xsltproc -o /tmp/xepbuilder/xep-" + nr + ".tex.xml xep2texml.xsl " + file)
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
error, desc = executeCommand("texml -e utf8 /tmp/xepbuilder/xep-" + nr + ".tex.xml /tmp/xepbuilder/xep-" + nr + ".tex")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
#detect http urls and escape them to make them breakable
|
||||
# this should match all urls in free text; not the urls in xml:ns or so..so no " or ' in front.
|
||||
error, desc = executeCommand('''sed -i 's|\([\s"]\)\([^"]http://[^ "]*\)|\1\\path{\2}|g' /tmp/xepbuilder/xep-''' + nr + ".tex")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
#adjust references
|
||||
error, desc = executeCommand('''sed -i 's|\\hyperref\[#\([^}]*\)\]|\\hyperref\[\1\]|g' /tmp/xepbuilder/xep-''' + nr + ".tex")
|
||||
if error != 0:
|
||||
if verbose == 1:
|
||||
print "Error: ", desc
|
||||
return False
|
||||
|
||||
error, desc = executeCommand('''sed -i 's|\\pageref{#\([^}]*\)}|\\pageref{\1}|g' /tmp/xepbuilder/xep-''' + nr + ".tex")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
olddir = os.getcwd()
|
||||
os.chdir("/tmp/xepbuilder")
|
||||
|
||||
error, desc = executeCommand("xelatex -interaction=batchmode xep-" + nr + ".tex")
|
||||
#if not checkError(error, desc):
|
||||
# os.chdir(olddir)
|
||||
# return False
|
||||
|
||||
#error, desc = executeCommand("xelatex -interaction=batchmode xep-" + nr + ".tex")
|
||||
#if not checkError(error, desc):
|
||||
# os.chdir(olddir)
|
||||
# return False
|
||||
|
||||
os.chdir(olddir)
|
||||
|
||||
error, desc = executeCommand("cp /tmp/xepbuilder/xep-" + nr + ".pdf " + XEPPATH + "/")
|
||||
if not checkError(error, desc):
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
def buildXEP( filename ):
|
||||
nr = re.match("xep-(\d\d\d\d).xml", filename).group(1)
|
||||
xepfilepath = getLatestXEPFilename("./", nr);
|
||||
if not xepfilepath:
|
||||
print "getLatestXEPContent (ERROR)"
|
||||
return
|
||||
|
||||
files_to_delete.append(xepfilepath)
|
||||
if not fast:
|
||||
print "Building " + filename + ": ",
|
||||
if buildXHTML( xepfilepath, nr ):
|
||||
print "XHTML(OK) / ",
|
||||
else:
|
||||
print "XHTML(ERROR) / ",
|
||||
|
||||
if buildPDF( xepfilepath, nr ):
|
||||
print "PDF(OK)"
|
||||
else:
|
||||
print "PDF(ERROR)"
|
||||
else:
|
||||
print "Building " + filename + " (FAST MODE)"
|
||||
|
||||
x = XEPTable(CONFIGPATH + "/extensions.xml", XEPPATH + "/xeps.xml")
|
||||
xinfo = XEPInfo(xepfilepath, False)
|
||||
x.setXEP( xinfo )
|
||||
x.save()
|
||||
|
||||
def buildAll():
|
||||
files = glob.glob('xep-????.xml')
|
||||
files.sort(key=lambda x: x.lower())
|
||||
for file in files:
|
||||
buildXEP( file )
|
||||
|
||||
def makeBundle():
|
||||
print "Creating the bundle...",
|
||||
executeCommand("mkdir /tmp/xepbundle")
|
||||
executeCommand("cp " + XEPPATH + "/*.pdf " + "/tmp/xepbundle")
|
||||
executeCommand("tar -cf /tmp/xepbundle.tar -C /tmp xepbundle")
|
||||
executeCommand("pbzip2 -f -9 /tmp/xepbundle.tar")
|
||||
executeCommand("mv -f /tmp/xepbundle.tar.bz2 " + XEPPATH + "/xepbundle.tar.bz2")
|
||||
executeCommand("rm -rfd /tmp/xepbundle")
|
||||
print "DONE"
|
||||
|
||||
def usage():
|
||||
print "gen.py: generate nice XHTML and beautiful PDF out of the XEP XML files"
|
||||
print ""
|
||||
print "Usage:"
|
||||
print "gen.py xep-####.xml"
|
||||
print ""
|
||||
print "Options:"
|
||||
print "-v Enable verbose output for debugging."
|
||||
print "-a Build all available XEPs."
|
||||
print "-f Fast; means no actual compiling is done."
|
||||
|
||||
def main(argv):
|
||||
global verbose
|
||||
global CONFIGPATH
|
||||
global fast
|
||||
buildall = False
|
||||
|
||||
try:
|
||||
options, remainder = getopt.gnu_getopt(argv, "vaf")
|
||||
except getopt.GetoptError:
|
||||
usage()
|
||||
sys.exit(2)
|
||||
|
||||
for opt, arg in options:
|
||||
if opt in ('-v'):
|
||||
verbose = True
|
||||
elif opt in ('-a'):
|
||||
buildall = True
|
||||
elif opt in ('-f'):
|
||||
fast = True
|
||||
|
||||
if len(remainder) > 0:
|
||||
try:
|
||||
xep = int(remainder[0])
|
||||
xep = "xep-%04d.xml" % xep
|
||||
except:
|
||||
xep = remainder[0]
|
||||
|
||||
executeCommand("mkdir /tmp/xepbuilder")
|
||||
executeCommand("cp ../images/xmpp.pdf /tmp/xepbuilder/xmpp.pdf")
|
||||
executeCommand("cp ../images/xmpp-text.pdf /tmp/xepbuilder/xmpp-text.pdf")
|
||||
executeCommand("cp -r deps/* /tmp/xepbuilder/")
|
||||
|
||||
executeCommand("cp xep.ent /tmp/xep.ent")
|
||||
files_to_delete.append("/tmp/xep.ent")
|
||||
|
||||
if buildall:
|
||||
buildAll()
|
||||
else:
|
||||
buildXEP( xep )
|
||||
|
||||
# remove xep temporary files
|
||||
for filename in files_to_delete:
|
||||
executeCommand("rm " + filename)
|
||||
|
||||
executeCommand("sed -e '1s/<?[^?]*?>//' " + CONFIGPATH + "/extensions.xml > " + XEPPATH + "/../includes/xeplist.txt")
|
||||
|
||||
executeCommand("rm -rfd /tmp/xepbuilder")
|
||||
|
||||
makeBundle()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main(sys.argv[1:])
|
||||
@ -0,0 +1,169 @@
|
||||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<!DOCTYPE xep SYSTEM 'xep.dtd' [
|
||||
<!ENTITY % ents SYSTEM 'xep.ent'>
|
||||
%ents;
|
||||
]>
|
||||
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
|
||||
<xep>
|
||||
<header>
|
||||
<title>Atomically Compare-And-Publish PubSub Items</title>
|
||||
<abstract>This specification provides a mechanism to atomically Compare-And-Publish items to a PubSub node.</abstract>
|
||||
&LEGALNOTICE;
|
||||
<number>xxxx</number>
|
||||
<status>ProtoXEP</status>
|
||||
<type>Standards Track</type>
|
||||
<sig>Standards</sig>
|
||||
<approver>Council</approver>
|
||||
<dependencies>
|
||||
<spec>XEP-0030</spec>
|
||||
<spec>XEP-0060</spec>
|
||||
</dependencies>
|
||||
<supersedes/>
|
||||
<supersededby/>
|
||||
<shortname>cap</shortname>
|
||||
&flow;
|
||||
<revision>
|
||||
<version>0.0.1</version>
|
||||
<date>2017-04-20</date>
|
||||
<initials>fs</initials>
|
||||
<remark><p>First draft.</p></remark>
|
||||
</revision>
|
||||
</header>
|
||||
|
||||
<section1 topic='Introduction' anchor='intro'>
|
||||
|
||||
<p>This specification provides a mechanism to atomically publish
|
||||
items to a PubSub node depending on the item ID of the node's latest
|
||||
item. This allows to prevent race conditions and avoids data
|
||||
loss in certain situations.</p>
|
||||
|
||||
</section1>
|
||||
|
||||
<section1 topic='Discoverying Support' anchor='disco'>
|
||||
|
||||
<p>If an entity supports the Compared-And-Publish feature it MUST
|
||||
advertise the fact by returning a <feature/> with the 'var'
|
||||
attribute set to 'urn:xmpp:pubsub:cap:0' in response to a &xep0030;
|
||||
query for information.</p>
|
||||
|
||||
</section1>
|
||||
|
||||
<section1 topic='Compare-And-Publish PubSub Items' anchor='cap'>
|
||||
|
||||
<p>In order to atomically compare-and-publish an item, a client
|
||||
sends an &IQ; with a 'pubsub' element qualified by the
|
||||
'urn:xmpp:pubsub:cap:0' namespace. The element MUST contain the same
|
||||
attributes and elements as the <publish/> element defined in
|
||||
&xep0060; <em>and</em> it MUST contain a previd attribute containing
|
||||
an item ID.</p>
|
||||
|
||||
<p>The PubSub service MUST only publish the item if the node's
|
||||
latest item ID is equal to the ID found in the 'previd'
|
||||
attribute.</p>
|
||||
|
||||
<example caption='Publisher publishes an item using Compare-And-Publish'><![CDATA[
|
||||
<iq type='set'
|
||||
from='hamlet@denmark.lit/blogbot'
|
||||
to='pubsub.shakespeare.lit'
|
||||
id='compare-and-publish1'>
|
||||
<pubsub xmlns='urn:xmpp:pubsub:cap:0'>
|
||||
<compare-and-publish
|
||||
node='princely_musings'
|
||||
previd='1'>
|
||||
<item>
|
||||
<entry xmlns='http://www.w3.org/2005/Atom'>
|
||||
<title>Soliloquy</title>
|
||||
<summary>
|
||||
To be, or not to be: that is the question:
|
||||
Whether 'tis nobler in the mind to suffer
|
||||
The slings and arrows of outrageous fortune,
|
||||
Or to take arms against a sea of troubles,
|
||||
And by opposing end them?
|
||||
</summary>
|
||||
<link rel='alternate' type='text/html'
|
||||
href='http://denmark.lit/2003/12/13/atom03'/>
|
||||
<id>tag:denmark.lit,2003:entry-32397</id>
|
||||
<published>2003-12-13T18:30:02Z</published>
|
||||
<updated>2003-12-13T18:30:02Z</updated>
|
||||
</entry>
|
||||
</item>
|
||||
</publish>
|
||||
</pubsub>
|
||||
</iq>
|
||||
]]></example>
|
||||
|
||||
<section2 topic='Successfully published an item using Compare-And-Publish'>
|
||||
|
||||
<p>If the 'previd' matched the latest item's ID and if the service
|
||||
was able to successfully process the request then the protocol
|
||||
continues as defined in <cite>XEP-0060 7.1.2</cite>.</p>
|
||||
|
||||
</section2>
|
||||
|
||||
<section2 topic='Could not publish because newest item ID did not match'>
|
||||
|
||||
<p>In case the Compare-And-Publish operation failed because the
|
||||
latest node id is not the same as given in the 'previd' attribute
|
||||
in the request, the server returns an &IQ; result with 'pubsub'
|
||||
element qualified by the 'urn:xmpp:pubsub:cap:0' namespace which
|
||||
contains a <compare-and-publish-failed/> element. The
|
||||
element MUST have a 'id' attribute with the ID of the lastest
|
||||
item.</p>
|
||||
|
||||
<example caption='Service returns IQ response notifying of failed Compare-And-Publish operation'><![CDATA[
|
||||
<iq type='result'
|
||||
from='pubsub.shakespeare.lit'
|
||||
to='hamlet@denmark.lit/blogbot'
|
||||
id='compare-and-ublish1'>
|
||||
<pubsub xmlns='urn:xmpp:pubsub:cap:0'>
|
||||
<compare-and-publish-failed id='2'/>
|
||||
</pubsub>
|
||||
</iq>
|
||||
]]></example>
|
||||
|
||||
</section2>
|
||||
|
||||
<section2 topic='Error cases'>
|
||||
|
||||
<p>All other error cases are handled as specified in
|
||||
<cite>XEP-0060 § 7.1.3</cite></p>
|
||||
|
||||
</section2>
|
||||
|
||||
</section1>
|
||||
|
||||
<section1 topic='Security Considerations' anchor='security'>
|
||||
|
||||
<p>This extension protocol does not add any further security
|
||||
considerations to the ones mentioned in <cite>XEP-0060 §
|
||||
14.</cite>.</p>
|
||||
|
||||
</section1>
|
||||
|
||||
<section1 topic='IANA Considerations' anchor='iana'>
|
||||
|
||||
<p>This document requires no interaction with the Internet Assigned
|
||||
Numbers Authority (IANA).</p>
|
||||
|
||||
</section1>
|
||||
|
||||
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
|
||||
|
||||
<p>This specification defines the following XML namespaces:</p>
|
||||
<ul>
|
||||
<li>urn:xmpp:pubsub:cap:0</li>
|
||||
</ul>
|
||||
<code caption='Registry Submission'><![CDATA[
|
||||
<var>
|
||||
<name>urn:xmpp:pubsub:cap:0</name>
|
||||
<desc>Indicates support for Compare-And-Publish</desc>
|
||||
<doc>XEP-XXXX</doc>
|
||||
</var>]]></code>
|
||||
|
||||
</section1>
|
||||
<section1 topic='XML Schema' anchor='schema'>
|
||||
|
||||
<p>TODO: Add after the XEP leaves the 'experimental' state.</p>
|
||||
|
||||
</section1>
|
||||
</xep>
|
||||