MaxSem has submitted this change and it was merged. Change subject: Initial commit ......................................................................
Initial commit See the RFC for details: https://www.mediawiki.org/wiki/Requests_for_comment/Hierator WIP puppetization for Vagrant: Idf7549c3c788a66e93466a7b04f633e3d4f5a35d Change-Id: I94c007ee876049083d875d2eb2ae44e8b53ce9c8 --- A .gitignore A COPYING A WebContent/META-INF/MANIFEST.MF A WebContent/WEB-INF/web.xml A build-jsesh.sh A pom.xml A readme.txt A src/hierator/HieroglyphLister.java A src/hierator/HttpException.java A src/hierator/HttpNotFoundException.java A src/hierator/PathHandler.java A src/hierator/PngRenderer.java A src/hierator/Renderer.java A src/hierator/RenderingServlet.java A src/hierator/SvgMinifier.java A src/hierator/SvgRenderer.java A src/hierator/Utils.java 17 files changed, 841 insertions(+), 0 deletions(-) Approvals: Manybubbles: Looks good to me, approved MaxSem: Verified diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e55a27e --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +*.jar +*.class +target +build +jsesh +.classpath +.project +.settings +/target/ diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/WebContent/META-INF/MANIFEST.MF b/WebContent/META-INF/MANIFEST.MF new file mode 100644 index 0000000..5e94951 --- /dev/null +++ b/WebContent/META-INF/MANIFEST.MF @@ -0,0 +1,3 @@ +Manifest-Version: 1.0 +Class-Path: + diff --git a/WebContent/WEB-INF/web.xml b/WebContent/WEB-INF/web.xml new file mode 100644 index 0000000..af4db60 --- /dev/null +++ b/WebContent/WEB-INF/web.xml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xmlns="http://java.sun.com/xml/ns/javaee"; xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"; id="WebApp_ID" version="3.0"> + <display-name>Hierator</display-name> +</web-app> diff --git a/build-jsesh.sh b/build-jsesh.sh new file mode 100755 index 0000000..8c388c3 --- /dev/null +++ b/build-jsesh.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +set -e +if [ ! -d jsesh ] +then + hg clone http://hg.code.sf.net/p/jsesh/mercurial jsesh +fi + +cd jsesh + +# Checkout the particular version we want +if [ $1 ] +then + hg checkout $1 +fi + +mvn clean install diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..30ed3cb --- /dev/null +++ b/pom.xml @@ -0,0 +1,70 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <modelVersion>4.0.0</modelVersion> + <groupId>hierator</groupId> + <artifactId>hierator</artifactId> + <version>0.9</version> + <packaging>war</packaging> + + <dependencies> + <dependency> + <groupId>org.qenherkhopeshef</groupId> + <artifactId>jsesh</artifactId> + <version>6.4.2</version> + </dependency> + <dependency> + <groupId>org.qenherkhopeshef</groupId> + <artifactId>jseshGlyphs</artifactId> + <version>6.4.2</version> + </dependency> + <dependency> + <groupId>javax.servlet</groupId> + <artifactId>javax.servlet-api</artifactId> + <version>3.0.1</version> + <scope>provided</scope> + </dependency> + </dependencies> + <build> + <finalName>${project.artifactId}</finalName> + <sourceDirectory>src</sourceDirectory> + <plugins> + <plugin> + <artifactId>maven-compiler-plugin</artifactId> + <version>3.1</version> + <configuration> + <source>1.6</source> + <target>1.6</target> + </configuration> + </plugin> + <plugin> + <artifactId>maven-war-plugin</artifactId> + <version>2.4</version> + <configuration> + <warSourceDirectory>WebContent</warSourceDirectory> + <failOnMissingWebXml>false</failOnMissingWebXml> + </configuration> + </plugin> + <plugin> + <artifactId>exec-maven-plugin</artifactId> + <groupId>org.codehaus.mojo</groupId> + <version>1.1.1</version> + <executions> + <execution> + <id>build-jsesh</id> + <phase>generate-sources</phase> + <goals> + <goal>exec</goal> + </goals> + <configuration> + <executable>${basedir}/build-jsesh.sh</executable> + <arguments> + <!-- This is the JSesh revision we want --> + <argument>0e5d9c175886</argument> + </arguments> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> +</project> diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..f47ee72 --- /dev/null +++ b/readme.txt @@ -0,0 +1,65 @@ +Hierator is a Java servlet that renders Ancient Egyptian texts into images. + +== Usage == +Hierator supports 3 actions. If installed into webserver root, the URL schemas +are: + +=== Generate an SVG from text === +/svg[/<image base size>px]/<text> +or +/svg[/<image base size>px]?text=<text> + +Example: /svg/100px/?text=A1\-B2-ra:N1 + +If image size is omitted, a default of 38 pixels (double the JSesh default) +will be used. + +Note: the SVG minification routine is tuned to work at sizes of approximately +the same order of magnitude as default. If the base size will be too small, +image quality will suffer. + +=== Generate a PNG from text === +Same as SVG but replace "svg" with "png": + +/png[/<image base size>px]/<text> +or +/png[/<image base size>px]?text=<text> + +Not recommended for production use because it's limited to 1000x1000 pixels and +is rather slow. Just download the SVG and rasterize it locally. + +=== List all supported hieroglyphs === +/list + +Returns a text/plain newline-delimited list of glyphs. + +== Error reporting == +* Successful requests have a HTTP status code 200 (OK). +* If a problem has been encountered, status code 500 (Internal Server Error) + will be returned, with a plaintext exception information in response body. +* If the text supplied was invalid, status code will be 400 (Bad Request), + and exception information in body once again. + +== Building == +Requires JDK, Maven and Mercurial. + + $ cd /path/to/checkout + $ mvn clean install + +== Running == +Should work with any servlet 3.0 compatible webserver, tested with Tomcat and +Jetty (via jetty-runner). All Hierator dependencies are included in its WAR +file, so all is needed is to drop hierator.war where the webserver expects it. + +== Links == +* JSesh, an open source Egyptian hieroglyphics editor used by Hierator: + http://jsesh.qenherkhopeshef.org/ + +* WikiHiero, a MediaWiki extension Hierator was written for: + https://www.mediawiki.org/wiki/Extension:WikiHiero + +* Manuel de Codage, standard for encoding Ancient Egyptian texts: + http://www.catchpenny.org/codage/ + +* Information about Gardiner's sign list: + https://en.wikipedia.org/wiki/Gardiner%27s_sign_list diff --git a/src/hierator/HieroglyphLister.java b/src/hierator/HieroglyphLister.java new file mode 100644 index 0000000..c18fa12 --- /dev/null +++ b/src/hierator/HieroglyphLister.java @@ -0,0 +1,29 @@ +package hierator; + +import javax.servlet.http.HttpServletRequest; + +import jsesh.hieroglyphs.ResourcesHieroglyphicFontManager; + +/** + * Handler for path /list + * Returns a list of all available hieroglyph codes + */ +public class HieroglyphLister implements PathHandler { + + @Override + public byte[] handle(HttpServletRequest request, String[] path) throws Exception { + ResourcesHieroglyphicFontManager rm = new ResourcesHieroglyphicFontManager("/jseshGlyphs"); + StringBuilder sb = new StringBuilder(); + for (Object glyph : rm.getCodes()) { + sb.append((String)glyph) + .append("\n"); + } + return sb.toString().getBytes(); + } + + @Override + public String getContentType() { + return "text/plain"; + } + +} diff --git a/src/hierator/HttpException.java b/src/hierator/HttpException.java new file mode 100644 index 0000000..2e3e247 --- /dev/null +++ b/src/hierator/HttpException.java @@ -0,0 +1,12 @@ +package hierator; + +public abstract class HttpException extends Exception { + + private static final long serialVersionUID = 1L; + + public HttpException(String message) { + super(message); + } + + public abstract int getCode(); +} diff --git a/src/hierator/HttpNotFoundException.java b/src/hierator/HttpNotFoundException.java new file mode 100644 index 0000000..d2b410a --- /dev/null +++ b/src/hierator/HttpNotFoundException.java @@ -0,0 +1,19 @@ +package hierator; + +public class HttpNotFoundException extends HttpException { + + private static final long serialVersionUID = 1L; + + public HttpNotFoundException() { + super("Not found"); + } + + public HttpNotFoundException(String message) { + super(message); + } + + @Override + public int getCode() { + return 404; + } +} diff --git a/src/hierator/PathHandler.java b/src/hierator/PathHandler.java new file mode 100644 index 0000000..f6ccaa4 --- /dev/null +++ b/src/hierator/PathHandler.java @@ -0,0 +1,25 @@ +package hierator; + +import javax.servlet.http.HttpServletRequest; + +/** + * Interface representing a handler for a root path + */ +public interface PathHandler { + /** + * Handles a request to a given path + * + * @param HttpServletRequest request: Request to process + * @param String[] path: subpath elements + * @return byte[]: Response body + * @throws Exception + */ + byte[] handle(HttpServletRequest request, String[] path) throws Exception; + + /** + * Returns content type for this path + * + * @return String + */ + String getContentType(); +} diff --git a/src/hierator/PngRenderer.java b/src/hierator/PngRenderer.java new file mode 100644 index 0000000..52f4903 --- /dev/null +++ b/src/hierator/PngRenderer.java @@ -0,0 +1,29 @@ +package hierator; + +import javax.imageio.ImageIO; + +import java.io.*; +import java.awt.image.* ; + +import jsesh.mdcDisplayer.draw.*; + +/** + * PNG rendering path handler + */ +public class PngRenderer extends Renderer { + + @Override + public String getContentType() { + return "image/png"; + } + + @Override + public byte[] render(String text, int size) throws Exception { + MDCDrawingFacade drawing = new MDCDrawingFacade(); + drawing.setCadratHeight(size); + BufferedImage img = drawing.createImage(text); + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + ImageIO.write(img, "png", stream); + return stream.toByteArray(); + } +} diff --git a/src/hierator/Renderer.java b/src/hierator/Renderer.java new file mode 100644 index 0000000..bc10f8f --- /dev/null +++ b/src/hierator/Renderer.java @@ -0,0 +1,43 @@ +package hierator; + +import javax.servlet.http.HttpServletRequest; + +/** + * Base class for Manuel de Codage texts renderering path handlers + */ +public abstract class Renderer implements PathHandler { + /** + * When implemented in a descendant class, performs rendering + * + * @param String text + * @param int size + * @return byte[] + * @throws Exception + */ + abstract byte[] render(String text, int size) throws Exception; + + @Override + public byte[] handle(HttpServletRequest request, String[] path) throws Exception { + String text = ""; + int size = 38; + + if (path.length > 0 && path[0].matches("^\\d+px$")) { + size = Integer.parseInt(path[0].replace("px", "")); + path = Utils.shift(path); + } + String delim = ""; + for (String s : path) { + text = text + delim + s; + delim = "/"; + } + if (text.trim().length() == 0) { + text = request.getParameter("text"); + } + if (text == null || text.trim().equals("")) { + throw new HttpNotFoundException("No text to render specified"); + } + text = java.net.URLDecoder.decode(text, "UTF-8"); + + return render(text, size); + } +} diff --git a/src/hierator/RenderingServlet.java b/src/hierator/RenderingServlet.java new file mode 100644 index 0000000..f40cd74 --- /dev/null +++ b/src/hierator/RenderingServlet.java @@ -0,0 +1,101 @@ +package hierator; + +import java.io.IOException; +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.HashMap; + +import javax.servlet.ServletException; +import javax.servlet.annotation.WebServlet; +import javax.servlet.http.HttpServlet; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; + +/** + * Servlet implementation main class + */ +@WebServlet("/") +public class RenderingServlet extends HttpServlet { + private static final long serialVersionUID = 1L; + private HashMap<String, PathHandler> routing = new HashMap<String, PathHandler>(); + + /** + * @see HttpServlet#HttpServlet() + */ + public RenderingServlet() { + super(); + routing.put("png", new PngRenderer()); + routing.put("svg", new SvgRenderer()); + routing.put("list", new HieroglyphLister()); + } + + /** + * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response) + */ + protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { + processRequest(request, response); + } + + /** + * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response) + */ + protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { + processRequest(request, response); + } + + protected PathHandler getHandler(String path) { + if (routing.containsKey(path)) { + return routing.get(path); + } + return null; + } + + protected void performRequest(HttpServletRequest request, HttpServletResponse response) throws Exception { + // Remove leading slash + String[] parts = request.getServletPath().substring(1).split("/"); + if (parts.length == 0) { + throw new HttpNotFoundException(); + } + + String rootPath = parts[0]; + parts = Utils.shift(parts); + PathHandler handler = getHandler(rootPath); + if (handler == null) { + throw new HttpNotFoundException(); + } + + long time = System.currentTimeMillis(); + byte[] bytes = handler.handle(request, parts); + time = System.currentTimeMillis() - time; + response.getOutputStream().write(bytes); + response.setContentType(handler.getContentType()); + response.setHeader("X-Processing-Time", Long.toString(time)); + } + + protected String exceptionToString(Exception ex) { + StringWriter sw = new StringWriter(); + ex.printStackTrace(new PrintWriter(sw)); + return sw.toString(); + } + + protected void processRequest(HttpServletRequest request, HttpServletResponse response) throws IOException { + String message = "[Error handling error]"; + int code = 500; + + try { + performRequest(request, response); + return; // Success + } catch(HttpException ex) { + message = ex.getMessage(); + code = ex.getCode(); + } catch(jsesh.mdc.MDCSyntaxError ex) { + message = exceptionToString(ex); + code = 400; + } catch (Exception ex) { + message = exceptionToString(ex); + } + response.setContentType("text/plain"); + response.getOutputStream().println(message); + response.setStatus(code); + } +} diff --git a/src/hierator/SvgMinifier.java b/src/hierator/SvgMinifier.java new file mode 100644 index 0000000..58a2baa --- /dev/null +++ b/src/hierator/SvgMinifier.java @@ -0,0 +1,15 @@ +package hierator; + +import java.util.regex.*; + +/** + * Scary SVG minifier. Works fine for our use case, but don't expect much more. + */ +public class SvgMinifier { + private final static Pattern pattern = Pattern.compile("(\\d+\\.\\d{3})\\d+"); + + public static String minify(String svg) { + Matcher match = pattern.matcher(svg); + return match.replaceAll("$1"); + } +} diff --git a/src/hierator/SvgRenderer.java b/src/hierator/SvgRenderer.java new file mode 100644 index 0000000..fdcedf3 --- /dev/null +++ b/src/hierator/SvgRenderer.java @@ -0,0 +1,40 @@ +package hierator; + +import java.awt.geom.Rectangle2D; +import java.io.ByteArrayOutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; + +import org.qenherkhopeshef.graphics.svg.SVGGraphics2D; + +import jsesh.mdcDisplayer.draw.MDCDrawingFacade; +import jsesh.utils.DoubleDimensions; + +/** + * PNG rendering path handler + */ +public class SvgRenderer extends Renderer { + + @Override + public String getContentType() { + return "image/svg+xml"; + } + + @Override + public byte[] render(String text, int size) throws Exception { + MDCDrawingFacade facade = new MDCDrawingFacade(); + facade.setCadratHeight(size); + Rectangle2D dims = facade.getBounds(text, 0, 0); + + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + Writer writer = new OutputStreamWriter(stream); + SVGGraphics2D g = new SVGGraphics2D(writer, new DoubleDimensions(dims.getWidth(), dims.getHeight())); + facade.draw(text, g, 0, 0); + g.dispose(); + + String svg = stream.toString(); + svg = SvgMinifier.minify(svg); + + return svg.getBytes(); + } +} diff --git a/src/hierator/Utils.java b/src/hierator/Utils.java new file mode 100644 index 0000000..9a86861 --- /dev/null +++ b/src/hierator/Utils.java @@ -0,0 +1,21 @@ +package hierator; + +/** + * Utils + */ +public class Utils { + /** + * Removes first element of an array. Silly Java. + * + * @param String[] array + * @return String[] + */ + public static String[] shift(String[] array) { + if (array.length == 0) { + throw new IllegalArgumentException("Attempted to shift an empty array"); + } + String[] result = new String[array.length - 1]; + System.arraycopy(array, 1, result, 0, result.length); + return result; + } +} -- To view, visit https://gerrit.wikimedia.org/r/178970 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I94c007ee876049083d875d2eb2ae44e8b53ce9c8 Gerrit-PatchSet: 13 Gerrit-Project: mediawiki/services/hierator Gerrit-Branch: master Gerrit-Owner: MaxSem <[email protected]> Gerrit-Reviewer: Manybubbles <[email protected]> Gerrit-Reviewer: MaxSem <[email protected]> Gerrit-Reviewer: Yuvipanda <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
