/*
* Copyright (c) 2013 Mozilla 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.
*/
package nu.validator.xml.roleattributes;
import nu.validator.xml.AttributesImpl;
import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.ErrorHandler;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
public class RoleAttributeFilteringContentHandlerWrapper implements
ContentHandler {
private final ContentHandler delegate;
private final ErrorHandler errorHandler;
private Locator locator = null;
/**
* @param delegate
*/
public RoleAttributeFilteringContentHandlerWrapper(ContentHandler delegate,
ErrorHandler errorHandler) {
this.delegate = delegate;
this.errorHandler = errorHandler;
}
/**
* @param arg0
* @param arg1
* @param arg2
* @throws SAXException
* @see org.xml.sax.ContentHandler#characters(char[], int, int)
*/
public void characters(char[] arg0, int arg1, int arg2) throws SAXException {
delegate.characters(arg0, arg1, arg2);
}
/**
* @throws SAXException
* @see org.xml.sax.ContentHandler#endDocument()
*/
public void endDocument() throws SAXException {
delegate.endDocument();
}
/**
* @param arg0
* @param arg1
* @param arg2
* @throws SAXException
* @see org.xml.sax.ContentHandler#endElement(java.lang.String,
* java.lang.String, java.lang.String)
*/
public void endElement(String arg0, String arg1, String arg2)
throws SAXException {
delegate.endElement(arg0, arg1, arg2);
}
/**
* @param arg0
* @throws SAXException
* @see org.xml.sax.ContentHandler#endPrefixMapping(java.lang.String)
*/
public void endPrefixMapping(String arg0) throws SAXException {
delegate.endPrefixMapping(arg0);
}
/**
* @param arg0
* @param arg1
* @param arg2
* @throws SAXException
* @see org.xml.sax.ContentHandler#ignorableWhitespace(char[], int, int)
*/
public void ignorableWhitespace(char[] arg0, int arg1, int arg2)
throws SAXException {
delegate.ignorableWhitespace(arg0, arg1, arg2);
}
/**
* @param arg0
* @param arg1
* @throws SAXException
* @see org.xml.sax.ContentHandler#processingInstruction(java.lang.String,
* java.lang.String)
*/
public void processingInstruction(String arg0, String arg1)
throws SAXException {
delegate.processingInstruction(arg0, arg1);
}
/**
* @param arg0
* @see org.xml.sax.ContentHandler#setDocumentLocator(org.xml.sax.Locator)
*/
public void setDocumentLocator(Locator arg0) {
locator = arg0;
delegate.setDocumentLocator(arg0);
}
/**
* @param arg0
* @throws SAXException
* @see org.xml.sax.ContentHandler#skippedEntity(java.lang.String)
*/
public void skippedEntity(String arg0) throws SAXException {
delegate.skippedEntity(arg0);
}
/**
* @throws SAXException
* @see org.xml.sax.ContentHandler#startDocument()
*/
public void startDocument() throws SAXException {
delegate.startDocument();
}
/**
* @param ns
* @param arg1
* @param arg2
* @param attributes
* @throws SAXException
* @see org.xml.sax.ContentHandler#startElement(java.lang.String,
* java.lang.String, java.lang.String, org.xml.sax.Attributes)
*/
public void startElement(String ns, String arg1, String arg2,
Attributes attributes) throws SAXException {
if ("http://www.w3.org/1999/xhtml" == ns) {
delegate.startElement(ns, arg1, arg2, filterAttributes(attributes));
} else {
delegate.startElement(ns, arg1, arg2, attributes);
}
}
private static String[] nonAbstractAriaRoles = { "alert", "alertdialog",
"application", "article", "banner", "button", "checkbox",
"columnheader", "combobox", "complementary", "contentinfo",
"definition", "dialog", "directory", "document", "form", "grid",
"gridcell", "group", "heading", "img", "link", "list", "listbox",
"listitem", "log", "main", "marquee", "math", "menu", "menubar",
"menuitem", "menuitemcheckbox", "menuitemradio", "navigation",
"note", "option", "presentation", "progressbar", "radio",
"radiogroup", "region", "row", "rowgroup", "rowheader",
"scrollbar", "search", "separator", "slider", "spinbutton",
"status", "tab", "tablist", "tabpanel", "textbox", "timer",
"toolbar", "tooltip", "tree", "treegrid", "treeitem" };
private Attributes filterAttributes(Attributes attributes)
throws SAXException {
AttributesImpl attributesImpl = new AttributesImpl();
for (int i = 0; i < attributes.getLength(); i++) {
if ("role".equals(attributes.getLocalName(i))
&& "".equals(attributes.getURI(i))) {
attributesImpl.addAttribute(
attributes.getURI(i),
attributes.getLocalName(i),
attributes.getQName(i),
attributes.getType(i),
getFirstMatchingAriaRoleFromTokenList(attributes.getValue(i)));
} else {
attributesImpl.addAttribute(attributes.getURI(i),
attributes.getLocalName(i), attributes.getQName(i),
attributes.getType(i), attributes.getValue(i));
}
}
return attributesImpl;
}
private String getFirstMatchingAriaRoleFromTokenList(String tokenList)
throws SAXException {
if (tokenList == null || "".equals(tokenList)) {
return "";
}
int len = tokenList.length();
List<String> tokens = new LinkedList<String>();
boolean collectingSpace = true;
int start = 0;
for (int i = 0; i < len; i++) {
char c = tokenList.charAt(i);
if (c == ' ' || c == '\t' || c == '\n' || c == '\r') {
if (!collectingSpace) {
tokens.add(tokenList.substring(start, i));
collectingSpace = true;
}
} else {
if (collectingSpace) {
start = i;
collectingSpace = false;
}
}
}
if (start < len) {
tokens.add(tokenList.substring(start, len));
}
String roleValue = null;
List<String> unrecognizedTokens = new LinkedList<String>();
List<String> superfluousTokens = new LinkedList<String>();
for (String token : tokens) {
if (Arrays.binarySearch(nonAbstractAriaRoles, token) < 0) {
unrecognizedTokens.add(token);
} else if (roleValue == null) {
roleValue = token;
} else {
superfluousTokens.add(token);
}
}
if (errorHandler != null && roleValue != null
&& unrecognizedTokens.size() > 0) {
errorHandler.error(new SAXParseException("Discarding unrecognized"
+ renderTokenList(unrecognizedTokens)
+ " from value of attribute \u201Crole\u201D."
+ " Browsers ignore any token that is not a"
+ " defined ARIA non-abstract role.", locator));
}
if (errorHandler != null && roleValue != null
&& superfluousTokens.size() > 0) {
errorHandler.error(new SAXParseException("Discarding superfluous"
+ renderTokenList(superfluousTokens)
+ " from value of attribute \u201Crole\u201D."
+ " Browsers only process the first token found that is a"
+ " defined ARIA non-abstract role.", locator));
}
return roleValue != null ? roleValue : tokenList;
}
private CharSequence renderTokenList(List<String> tokens) {
boolean first = true;
StringBuilder sb = new StringBuilder();
if (tokens.size() > 1) {
sb.append(" tokens ");
} else {
sb.append(" token ");
}
for (String token : tokens) {
if (first) {
first = false;
} else {
sb.append(", ");
}
sb.append("\u201C");
sb.append(token);
sb.append('\u201D');
}
return sb;
}
/**
* @param arg0
* @param arg1
* @throws SAXException
* @see org.xml.sax.ContentHandler#startPrefixMapping(java.lang.String,
* java.lang.String)
*/
public void startPrefixMapping(String arg0, String arg1)
throws SAXException {
delegate.startPrefixMapping(arg0, arg1);
}
}