14e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A helper function for using JsTemplate. See jstemplate_builder.h for more 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// info. 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 84e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles)#include "ui/base/webui/jstemplate_builder.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/json/json_file_value_serializer.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/json/json_string_value_serializer.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 135e3f23d412006dc4db4e659864679f29341e113fTorne (Richard Coles)#include "base/strings/string_util.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/layout.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/resource/resource_bundle.h" 161320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "ui/resources/grit/webui_resources.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Non-zero when building version 2 templates. See UseVersion2 class. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int g_version2 = 0; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace webui { 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)UseVersion2::UseVersion2() { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) g_version2++; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)UseVersion2::~UseVersion2() { 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) g_version2--; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)std::string GetTemplateHtml(const base::StringPiece& html_template, 36eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const base::DictionaryValue* json, 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& template_id) { 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string output(html_template.data(), html_template.size()); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendJsonHtml(json, &output); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendJsTemplateSourceHtml(&output); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendJsTemplateProcessHtml(template_id, &output); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return output; 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)std::string GetI18nTemplateHtml(const base::StringPiece& html_template, 46eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const base::DictionaryValue* json) { 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string output(html_template.data(), html_template.size()); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendJsonHtml(json, &output); 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendI18nTemplateSourceHtml(&output); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendI18nTemplateProcessHtml(&output); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return output; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)std::string GetTemplatesHtml(const base::StringPiece& html_template, 55eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const base::DictionaryValue* json, 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece& template_id) { 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string output(html_template.data(), html_template.size()); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendI18nTemplateSourceHtml(&output); 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendJsTemplateSourceHtml(&output); 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendJsonHtml(json, &output); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendI18nTemplateProcessHtml(&output); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AppendJsTemplateProcessHtml(template_id, &output); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return output; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 66eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochvoid AppendJsonHtml(const base::DictionaryValue* json, std::string* output) { 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string javascript_string; 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) AppendJsonJS(json, &javascript_string); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // </ confuses the HTML parser because it could be a </script> tag. So we 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // replace </ with <\/. The extra \ will be ignored by the JS engine. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ReplaceSubstringsAfterOffset(&javascript_string, 0, "</", "<\\/"); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("<script>"); 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(javascript_string); 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("</script>"); 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 79eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochvoid AppendJsonJS(const base::DictionaryValue* json, std::string* output) { 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Convert the template data to a json string. 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(json) << "must include json data structure"; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string jstext; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) JSONStringValueSerializer serializer(&jstext); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) serializer.Serialize(*json); 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(g_version2 ? "loadTimeData.data = " : "var templateData = "); 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(jstext); 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(";"); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void AppendJsTemplateSourceHtml(std::string* output) { 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // fetch and cache the pointer of the jstemplate resource source text. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const base::StringPiece jstemplate_src( 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceBundle::GetSharedInstance().GetRawDataResource( 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) IDR_WEBUI_JSTEMPLATE_JS)); 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (jstemplate_src.empty()) { 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NOTREACHED() << "Unable to get jstemplate src"; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("<script>"); 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(jstemplate_src.data(), jstemplate_src.size()); 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("</script>"); 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void AppendJsTemplateProcessHtml(const base::StringPiece& template_id, 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* output) { 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("<script>"); 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("var tp = document.getElementById('"); 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(template_id.data(), template_id.size()); 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("');"); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("jstProcess(new JsEvalContext(templateData), tp);"); 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("</script>"); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void AppendI18nTemplateSourceHtml(std::string* output) { 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // fetch and cache the pointer of the jstemplate resource source text. 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const base::StringPiece i18n_template_src( 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceBundle::GetSharedInstance().GetRawDataResource( 1212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) IDR_WEBUI_I18N_TEMPLATE_JS)); 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const base::StringPiece i18n_template2_src( 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceBundle::GetSharedInstance().GetRawDataResource( 1242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) IDR_WEBUI_I18N_TEMPLATE2_JS)); 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::StringPiece* template_src = g_version2 ? 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) &i18n_template2_src : &i18n_template_src; 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (template_src->empty()) { 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NOTREACHED() << "Unable to get i18n template src"; 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("<script>"); 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(template_src->data(), template_src->size()); 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("</script>"); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void AppendI18nTemplateProcessHtml(std::string* output) { 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (g_version2) 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const base::StringPiece i18n_process_src( 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceBundle::GetSharedInstance().GetRawDataResource( 1442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) IDR_WEBUI_I18N_PROCESS_JS)); 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (i18n_process_src.empty()) { 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NOTREACHED() << "Unable to get i18n process src"; 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("<script>"); 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append(i18n_process_src.data(), i18n_process_src.size()); 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) output->append("</script>"); 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace webui 157