1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
|
/**
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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.
*/
#include <sstream>
#include <iostream>
#include <string_view>
#include "tscpp/api/PluginInit.h"
#include "tscpp/api/GlobalPlugin.h"
#include "tscpp/api/TransformationPlugin.h"
#include "tscpp/api/Logger.h"
#include "tscpp/api/Stat.h"
#if defined(__GNUC__)
#pragma GCC diagnostic push
#if !defined(__clang__)
#pragma GCC diagnostic ignored "-Wsuggest-override"
#endif
#pragma GCC diagnostic ignored "-Wtype-limits"
#endif
#include <Magick++.h>
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
using namespace Magick;
using namespace atscppapi;
#define TAG "webp_transform"
namespace
{
GlobalPlugin *plugin;
enum class ImageEncoding { webp, jpeg, png, unknown };
bool config_convert_to_webp = false;
bool config_convert_to_jpeg = false;
Stat stat_convert_to_webp;
Stat stat_convert_to_jpeg;
} // namespace
class ImageTransform : public TransformationPlugin
{
public:
ImageTransform(Transaction &transaction, ImageEncoding input_image_type, ImageEncoding transform_image_type)
: TransformationPlugin(transaction, TransformationPlugin::RESPONSE_TRANSFORMATION),
_input_image_type(input_image_type),
_transform_image_type(transform_image_type)
{
TransformationPlugin::registerHook(HOOK_READ_RESPONSE_HEADERS);
}
void
handleReadResponseHeaders(Transaction &transaction) override
{
switch (_transform_image_type) {
case ImageEncoding::webp:
transaction.getServerResponse().getHeaders()["Content-Type"] = "image/webp";
break;
case ImageEncoding::jpeg:
transaction.getServerResponse().getHeaders()["Content-Type"] = "image/jpeg";
break;
case ImageEncoding::png:
transaction.getServerResponse().getHeaders()["Content-Type"] = "image/png";
break;
case ImageEncoding::unknown:
// do nothing
break;
}
transaction.getServerResponse().getHeaders()["Vary"] = "Accept"; // to have a separate cache entry
TS_DEBUG(TAG, "url %s", transaction.getServerRequest().getUrl().getUrlString().c_str());
transaction.resume();
}
void
consume(std::string_view data) override
{
_img.write(data.data(), data.length());
}
void
handleInputComplete() override
{
std::string input_data = _img.str();
Blob input_blob(input_data.data(), input_data.length());
Image image;
try {
image.read(input_blob);
Blob output_blob;
if (_transform_image_type == ImageEncoding::webp) {
stat_convert_to_webp.increment(1);
TSDebug(TAG, "Transforming jpeg or png to webp");
image.magick("WEBP");
} else {
stat_convert_to_jpeg.increment(1);
TSDebug(TAG, "Transforming webp to jpeg");
image.magick("JPEG");
}
image.write(&output_blob);
produce(std::string_view(reinterpret_cast<const char *>(output_blob.data()), output_blob.length()));
} catch (Magick::Warning &warning) {
TSError("ImageMagick++ warning: %s", warning.what());
produce(std::string_view(reinterpret_cast<const char *>(input_blob.data()), input_blob.length()));
_transform_image_type = _input_image_type; // Revert to original encoding on error
} catch (Magick::Error &error) {
TSError("ImageMagick++ error: %s _image_type: %d input_data.length(): %zd", error.what(), (int)_transform_image_type,
input_data.length());
produce(std::string_view(reinterpret_cast<const char *>(input_blob.data()), input_blob.length()));
_transform_image_type = _input_image_type; // Revert to original encoding on error
}
setOutputComplete();
}
~ImageTransform() override = default;
private:
std::stringstream _img;
ImageEncoding _input_image_type;
ImageEncoding _transform_image_type;
};
class GlobalHookPlugin : public GlobalPlugin
{
public:
GlobalHookPlugin() { registerHook(HOOK_READ_RESPONSE_HEADERS); }
void
handleReadResponseHeaders(Transaction &transaction) override
{
// This variable stores the incoming image type
ImageEncoding input_image_type = ImageEncoding::unknown;
// This method tries to optimize the amount of string searching at the expense of double checking some of the booleans
std::string ctype = transaction.getServerResponse().getHeaders().values("Content-Type");
// Test to if in this transaction we might want to convert jpeg or png to webp
bool transaction_convert_to_webp = false;
if (config_convert_to_webp == true) {
if (ctype.find("image/jpeg") != std::string::npos) {
input_image_type = ImageEncoding::jpeg;
transaction_convert_to_webp = true;
}
if (ctype.find("image/png") != std::string::npos) {
input_image_type = ImageEncoding::png;
transaction_convert_to_webp = true;
}
}
// Test to if in this transaction we might want to convert webp to jpeg
bool transaction_convert_to_jpeg = false;
if (config_convert_to_jpeg == true && transaction_convert_to_webp == false) {
transaction_convert_to_jpeg = ctype.find("image/webp") != std::string::npos;
if (transaction_convert_to_jpeg) {
input_image_type = ImageEncoding::webp;
}
}
TSDebug(TAG, "User-Agent: %s transaction_convert_to_webp: %d transaction_convert_to_jpeg: %d", ctype.c_str(),
transaction_convert_to_webp, transaction_convert_to_jpeg);
// If we might need to convert check to see if what the browser supports
if (transaction_convert_to_webp == true || transaction_convert_to_jpeg == true) {
std::string accept = transaction.getServerRequest().getHeaders().values("Accept");
bool webp_supported = accept.find("image/webp") != std::string::npos;
TSDebug(TAG, "Accept: %s webp_suppported: %d", accept.c_str(), webp_supported);
if (webp_supported == true && transaction_convert_to_webp == true) {
TSDebug(TAG, "Content type is either jpeg or png. Converting to webp");
transaction.addPlugin(new ImageTransform(transaction, input_image_type, ImageEncoding::webp));
} else if (webp_supported == false && transaction_convert_to_jpeg == true) {
TSDebug(TAG, "Content type is webp. Converting to jpeg");
transaction.addPlugin(new ImageTransform(transaction, input_image_type, ImageEncoding::jpeg));
} else {
TSDebug(TAG, "Nothing to convert");
}
}
transaction.resume();
}
};
void
TSPluginInit(int argc, const char *argv[])
{
if (!RegisterGlobalPlugin("CPP_Webp_Transform", "apache", "dev@trafficserver.apache.org")) {
return;
}
if (argc >= 2) {
std::string option(argv[1]);
if (option.find("convert_to_webp") != std::string::npos) {
TSDebug(TAG, "Configured to convert to webp");
config_convert_to_webp = true;
}
if (option.find("convert_to_jpeg") != std::string::npos) {
TSDebug(TAG, "Configured to convert to jpeg");
config_convert_to_jpeg = true;
}
if (config_convert_to_webp == false && config_convert_to_jpeg == false) {
TSDebug(TAG, "Unknown option: %s", option.c_str());
TSError("Unknown option: %s", option.c_str());
}
} else {
TSDebug(TAG, "Default configuration is to convert both webp and jpeg");
config_convert_to_webp = true;
config_convert_to_jpeg = true;
}
stat_convert_to_webp.init("plugin." TAG ".convert_to_webp", Stat::SYNC_SUM, false);
stat_convert_to_jpeg.init("plugin." TAG ".convert_to_jpeg", Stat::SYNC_SUM, false);
InitializeMagick("");
plugin = new GlobalHookPlugin();
}
|