net.sourceforge.plantuml.code.TranscoderSmartProtected Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.code;
import java.io.IOException;
public class TranscoderSmartProtected implements Transcoder {
// ::remove file when __CORE__
// Legacy encoder
private final Transcoder oldOne = TranscoderImpl.utf8(new AsciiEncoder(), new ArobaseStringCompressor(),
new CompressionHuffman());
private final Transcoder zlib = TranscoderImpl.utf8(new AsciiEncoder(), new ArobaseStringCompressor(),
new CompressionZlib());
private final Transcoder hexOnly = TranscoderImpl.utf8(new AsciiEncoderHex(), new ArobaseStringCompressor(),
new CompressionNone());
private final Transcoder zip = TranscoderImpl.utf8(new AsciiEncoder(), new ArobaseStringCompressor(),
new CompressionZip());
private final Transcoder gzip = TranscoderImpl.utf8(new AsciiEncoder(), new ArobaseStringCompressor(),
new CompressionGZip());
public String decode(String code) throws NoPlantumlCompressionException {
// Work in progress
// See https://github.com/plantuml/plantuml/issues/117
if (code.startsWith("~0"))
return decodeZlib(code.substring(2));
if (code.startsWith("~1"))
return decodeHuffman(code.substring(2));
if (code.startsWith("~h"))
return hexOnly.decode(code.substring(2));
if (code.startsWith("~g"))
return gzip.decode(code.substring(2));
if (code.startsWith("~zip~"))
return zip.decode(code.substring(5));
return decodeZlib(code);
}
private String decodeZlib(String code) {
try {
return zlib.decode(code);
} catch (Exception ex) {
return textProtectedDeflate2(code);
}
}
private String decodeHuffman(String code) {
try {
return oldOne.decode(code);
} catch (Exception ex) {
return textProtectedHuffman(code);
}
}
private String textProtectedHuffman(String code) {
final StringBuilder result = new StringBuilder();
appendLine(result, "@startuml");
appendLine(result, "legend");
appendLine(result, "The plugin you are using seems to generated a bad URL.");
appendLine(result, "This URL does not look like HUFFMAN data.");
appendLine(result, "");
appendLine(result, "See https://plantuml.com/pte");
appendLine(result, "");
appendLine(result, "You may contact the PlantUML team at [email protected]");
appendLine(result,
"But you should also probably contact the plugin authors you are currently using and send them this image");
appendLine(result, "");
appendLine(result, "For the record, here is your data:");
appendLine(result, "");
appendURL(result, code);
appendLine(result, "endlegend");
appendLine(result, "@enduml");
return result.toString();
}
private String textProtectedDeflate2(String code) {
final StringBuilder result = new StringBuilder();
final String codeshort = code.length() > 30 ? code.substring(0, 30) + "..." : code;
appendLine(result, "@startuml");
appendLine(result, "legend");
appendLine(result, "The plugin you are using seems to generated a bad URL.");
appendLine(result, "This URL does not look like DEFLATE data.");
appendLine(result, "It looks like your plugin is using HUFFMAN encoding.");
appendLine(result, "");
appendLine(result,
"This means you have now to add an header ~1 to your data. For example, you have to change:");
appendLine(result, "http://www.plantuml.com/plantuml/png/" + codeshort);
appendLine(result, "to");
appendLine(result, "http://www.plantuml.com/plantuml/png/~1" + codeshort);
appendLine(result, "");
appendLine(result, "It will work this way");
appendLine(result, "You may contact the PlantUML team at [email protected]");
appendLine(result,
"But you should also probably contact the plugin authors you are currently using and send them this image");
appendLine(result, "");
appendLine(result, "For the record, here is your data:");
appendLine(result, "");
appendURL(result, code);
appendLine(result, "endlegend");
appendLine(result, "@enduml");
return result.toString();
}
private void appendURL(StringBuilder result, String url) {
while (url.length() > 80) {
appendLine(result, url.substring(0, 80));
url = url.substring(80);
}
if (url.length() > 0) {
appendLine(result, url);
}
}
private void appendLine(StringBuilder sb, String s) {
sb.append(s);
sb.append("\n");
}
public String encode(String text) throws IOException {
// Right now, we still use the legacy encoding.
// This will be changed in the incoming months
return zlib.encode(text);
}
}