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
|
/*
Copyright (©) 2003-2025 Teus Benschop.
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 3 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.
*/
#include <flate/flate.h>
#include <filter/url.h>
#include <filter/string.h>
#include <database/logs.h>
#include <locale/translate.h>
// Sets a variable (key and value) for the html template.
void Flate::set_variable (std::string key, std::string value)
{
variables [key] = value;
}
// Enable a zone in the html template.
void Flate::enable_zone (std::string zone)
{
zones [zone] = true;
}
// Add $value-s for one iteration to iterator $key.
void Flate::add_iteration (std::string key, std::map <std::string, std::string> value)
{
// The $key is the name for the iteration,
// where to add $value, which is a map of keys and values.
iterations[key].push_back (value);
}
// Renders the html template.
std::string Flate::render (std::string html)
{
std::string rendering;
try {
if (file_or_dir_exists (html)) {
rendering = filter_url_file_get_contents (html);
process_iterations (rendering);
process_zones (rendering);
process_variables (rendering);
process_translate (rendering);
}
} catch (...) {
Database_Logs::log ("Failure to process template " + html);
}
// Remove empty lines.
std::vector <std::string> lines = filter::strings::explode (rendering, '\n');
rendering.clear ();
for (auto & line : lines) {
line = filter::strings::trim (line);
if (line.empty ()) continue;
rendering.append (line);
rendering.append ("\n");
}
// Done.
return rendering;
}
void Flate::process_iterations (std::string & rendering)
{
// Limit iteration count.
int iteration_count = 0;
// Start processing iterations by locating the first one.
std::string beginiteration ("<!-- #BEGINITERATION");
size_t position = rendering.find (beginiteration);
// Iterate through the rendering till all have been dealt with.
while ((position != std::string::npos) && (iteration_count < 100)) {
iteration_count++;
// Position where the opening tag ends.
size_t pos = rendering.find ("-->", position);
std::string iteration_start_line = rendering.substr (position, pos - position + 3);
// Remove the opening tag for the current iteration.
rendering.erase (position, iteration_start_line.length ());
// Name for the current iteration.
std::string name = iteration_start_line.substr (21, iteration_start_line.length () - 21 - 4);
// Assemble the ending line for the current iteration.
std::string iterationendline = "<!-- #ENDITERATION " + name + " -->";
// Locate the ending position.
size_t iterationendposition = rendering.find (iterationendline);
// Process if it exists.
if (iterationendposition != std::string::npos) {
// Take the ending line out.
rendering.erase (iterationendposition, iterationendline.length ());
// Get and remove the inner contents of this iteration.
std::string iterating_fragment = rendering.substr (position, iterationendposition - position);
rendering.erase (position, iterationendposition - position);
// The fragment to insert after ready iterating.
std::string iterated_fragment;
// Go through the container for the name of the current iteration.
std::vector < std::map <std::string, std::string> > named_iterations = iterations [name];
for (auto & named_iteration : named_iterations) {
// Process one iteration.
std::string fragment (iterating_fragment);
for (auto & element : named_iteration) {
fragment = filter::strings::replace ("##" + element.first + "##", element.second, fragment);
}
// Add the processed fragment.
iterated_fragment.append ("\n");
iterated_fragment.append (fragment);
iterated_fragment.append ("\n");
}
// Insert it into the rendering.
rendering.insert (position, iterated_fragment);
}
// Next iteration.
position = rendering.find (beginiteration);
}
}
void Flate::process_zones (std::string& rendering)
{
// Limit zone iterations.
int zone_iteration_count = 0;
// Start processing zones by locating the first one.
std::string beginzone ("<!-- #BEGINZONE");
size_t position = rendering.find (beginzone);
// Iterate through the file contents till all zones have been dealt with.
while ((position != std::string::npos) && (zone_iteration_count < 1000)) {
zone_iteration_count++;
// Position where the starting zone ends.
size_t pos = rendering.find ("-->", position);
std::string zonestartline = rendering.substr (position, pos - position + 3);
// Remove the opening tag for the current zone.
rendering.erase (position, zonestartline.length ());
// Name for the current zone.
std::string name = zonestartline.substr (16, zonestartline.length () - 16 - 4);
// Assemble the ending line for the current zone.
std::string zoneendline = "<!-- #ENDZONE " + name + " -->";
// Locate the ending position.
size_t zoneendposition = rendering.find (zoneendline);
// Process if it exists.
if (zoneendposition != std::string::npos) {
// Take the ending line out.
rendering.erase (zoneendposition, zoneendline.length ());
// If the zone has not been enabled, remove all its contents within.
if (zones.count (name) == 0) {
rendering.erase (position, zoneendposition - position);
}
}
// Next zone.
position = rendering.find (beginzone);
}
}
void Flate::process_variables (std::string& rendering)
{
// Limit variable iterations.
int variable_iteration_count = 0;
// Start processing variables by locating the first one.
size_t position = rendering.find ("##");
// Iterate through the contents till all variables have been dealt with.
while ((position != std::string::npos) && (variable_iteration_count < 1000)) {
variable_iteration_count++;
bool correct = true;
// Check that this is a correct position: It should not have hashes nearby.
if (correct) if (position > 0) if (rendering.substr (position - 1, 1) == "#") {
correct = false;
}
if (correct) if (position < rendering.size ()) if (rendering.substr (position + 2, 1) == "#") {
correct = false;
}
// Position where the variable ends.
size_t pos = rendering.find ("##", position + 1);
if (pos == std::string::npos) pos = position + 4;
// Name for the variable zone.
std::string name = rendering.substr (position + 2, pos - position - 2);
// No new line in the variable name.
if (correct) if (name.find ("\n") != std::string::npos) correct = false;
if (correct) {
// Take the variable out.
rendering.erase (position, name.length () + 4);
// Insert the replacement.
rendering.insert (position, variables [name]);
}
// Next zone.
position = rendering.find ("##", position + 1);
}
}
void Flate::process_translate (std::string& rendering)
{
// Clean up the "translate" (gettext) calls.
rendering = filter::strings::replace ("translate (", "translate(", rendering);
// Gettext markup.
std::string gettextopen = R"(translate(")";
std::string gettextclose = R"("))";
// Limit gettext iterations.
int iteration_counter { 0 };
// Start processing variables by locating the first one.
size_t position = rendering.find (gettextopen);
// Iterate through the contents till all gettext calls have been dealt with.
while ((position != std::string::npos) && (iteration_counter < 1000)) {
iteration_counter++;
// Remove the gettext opener.
rendering.erase (position, gettextopen.length());
// Position where the gettext call ends.
size_t pos = rendering.find (gettextclose, position);
if (pos != std::string::npos) {
// Take the gettext closer out.
rendering.erase (pos, gettextclose.length());
// The English string.
std::string english = rendering.substr (position, pos - position);
// Take the English out.
rendering.erase (position, pos - position);
// Insert the localization.
rendering.insert (position, translate (english));
}
// Next gettext call.
position = rendering.find (gettextopen);
}
}
|