{"version":3,"file":"str.min.js","sources":["../src/str.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Fetch and render language strings.\n * Hooks into the old M.str global - but can also fetch missing strings on the fly.\n *\n * @module     core/str\n * @class      str\n * @package    core\n * @copyright  2015 Damyon Wiese <damyon@moodle.com>\n * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n * @since      2.9\n */\nimport $ from 'jquery';\nimport Ajax from 'core/ajax';\nimport LocalStorage from 'core/localstorage';\n\n// Module cache for the promises so that we don't make multiple\n// unnecessary requests.\nlet promiseCache = [];\n\n/**\n * Return a promise object that will be resolved into a string eventually (maybe immediately).\n *\n * @method get_string\n * @param {string} key The language string key\n * @param {string} component The language string component\n * @param {string} param The param for variable expansion in the string.\n * @param {string} lang The users language - if not passed it is deduced.\n * @return {Promise}\n */\nexport const get_string = (key, component, param, lang) => {\n    return get_strings([{key, component, param, lang}])\n        .then(results => results[0]);\n};\n\n/**\n * Make a batch request to load a set of strings\n *\n * @method get_strings\n * @param {Object[]} requests Array of { key: key, component: component, param: param, lang: lang };\n *                                      See get_string for more info on these args.\n * @return {Promise}\n */\nexport const get_strings = (requests) => {\n    let requestData = [];\n    const pageLang = $('html').attr('lang').replace(/-/g, '_');\n    // Helper function to construct the cache key.\n    const getCacheKey = ({key, component, lang = pageLang}) => {\n        if (!component) {\n            component = 'core';\n        }\n        return `core_str/${key}/${component}/${lang}`;\n    };\n\n    const stringPromises = requests.map((request) => {\n        const cacheKey = getCacheKey(request);\n        const {component, key, param, lang = pageLang} = request;\n        // Helper function to add the promise to cache.\n        const buildReturn = (promise) => {\n            // Make sure the promise cache contains our promise.\n            promiseCache[cacheKey] = promise;\n            return promise;\n        };\n\n        // Check if we can serve the string straight from M.str.\n        if (component in M.str && key in M.str[component]) {\n            return buildReturn(new Promise((resolve) => {\n                resolve(M.util.get_string(key, component, param, lang));\n            }));\n        }\n\n        // Check if the string is in the browser's local storage.\n        const cached = LocalStorage.get(cacheKey);\n        if (cached) {\n            M.str[component] = {...M.str[component], [key]: cached};\n            return buildReturn(new Promise((resolve) => {\n                resolve(M.util.get_string(key, component, param, lang));\n            }));\n        }\n\n        // Check if we've already loaded this string from the server.\n        if (cacheKey in promiseCache) {\n            return buildReturn(promiseCache[cacheKey]).then(() => {\n                return M.util.get_string(key, component, param, lang);\n            });\n        } else {\n            // We're going to have to ask the server for the string so\n            // add this string to the list of requests to be sent.\n            return buildReturn(new Promise((resolve, reject) => {\n                requestData.push({\n                    methodname: 'core_get_string',\n                    args: {\n                        stringid: key,\n                        stringparams: [],\n                        component,\n                        lang,\n                    },\n                    done: (str) => {\n                        // When we get the response from the server\n                        // we should update M.str and the browser's\n                        // local storage before resolving this promise.\n                        M.str[component] = {...M.str[component], [key]: str};\n                        LocalStorage.set(cacheKey, str);\n                        resolve(M.util.get_string(key, component, param, lang));\n                    },\n                    fail: reject\n                });\n            }));\n        }\n    });\n\n    if (requestData.length) {\n        // If we need to load any strings from the server then send\n        // off the request.\n        Ajax.call(requestData, true, false, false, 0, M.cfg.langrev);\n    }\n\n    // We need to use jQuery here because some calling code uses the\n    // .done handler instead of the .then handler.\n    return $.when.apply($, stringPromises)\n        .then((...strings) => strings);\n};\n\n/**\n * Add a list of strings to the caches.\n *\n * @method cache_strings\n * @param {Object[]} strings Array of { key: key, component: component, lang: lang, value: value }\n */\nexport const cache_strings = (strings) => {\n    const defaultLang = $('html').attr('lang').replace(/-/g, '_');\n\n    strings.forEach(({key, component, value, lang = defaultLang}) => {\n        const cacheKey = ['core_str', key, component, lang].join('/');\n\n        // Check M.str caching.\n        if (!(component in M.str) || !(key in M.str[component])) {\n            if (!(component in M.str)) {\n                M.str[component] = {};\n            }\n\n            M.str[component][key] = value;\n        }\n\n        // Check local storage.\n        if (!LocalStorage.get(cacheKey)) {\n            LocalStorage.set(cacheKey, value);\n        }\n\n        // Check the promises cache.\n        if (!(cacheKey in promiseCache)) {\n            promiseCache[cacheKey] = $.Deferred().resolve(value).promise();\n        }\n    });\n};\n"],"names":["promiseCache","key","component","param","lang","get_strings","then","results","requests","requestData","pageLang","attr","replace","stringPromises","map","request","cacheKey","getCacheKey","buildReturn","promise","M","str","Promise","resolve","util","get_string","cached","LocalStorage","get","reject","push","methodname","args","stringid","stringparams","done","set","fail","length","call","cfg","langrev","$","when","apply","strings","defaultLang","forEach","value","join","Deferred"],"mappings":"o3CAgCIA,aAAe,uBAYO,SAACC,IAAKC,UAAWC,MAAOC,aACvCC,YAAY,CAAC,CAACJ,IAAAA,IAAKC,UAAAA,UAAWC,MAAAA,MAAOC,KAAAA,QACvCE,MAAK,SAAAC,gBAAWA,QAAQ,WAWpBF,YAAc,SAACG,cACpBC,YAAc,GACZC,UAAW,mBAAE,QAAQC,KAAK,QAAQC,QAAQ,KAAM,KAShDC,eAAiBL,SAASM,KAAI,SAACC,aAC3BC,SARU,mBAAEf,SAAAA,IAAKC,eAAAA,yBAAWE,KAAAA,wBAAOM,0BACpCR,YACDA,UAAY,2BAEGD,gBAAOC,sBAAaE,MAItBa,CAAYF,SACtBb,UAA0Ca,QAA1Cb,UAAWD,IAA+Bc,QAA/Bd,IAAKE,MAA0BY,QAA1BZ,oBAA0BY,QAAnBX,KAAAA,4BAAOM,uBAE/BQ,YAAc,SAACC,gBAEjBnB,aAAagB,UAAYG,QAClBA,YAIPjB,aAAakB,EAAEC,KAAOpB,OAAOmB,EAAEC,IAAInB,kBAC5BgB,YAAY,IAAII,SAAQ,SAACC,SAC5BA,QAAQH,EAAEI,KAAKC,WAAWxB,IAAKC,UAAWC,MAAOC,eAKnDsB,OAASC,sBAAaC,IAAIZ,iBAC5BU,QACAN,EAAEC,IAAInB,0CAAiBkB,EAAEC,IAAInB,kCAAaD,IAAMyB,SACzCR,YAAY,IAAII,SAAQ,SAACC,SAC5BA,QAAQH,EAAEI,KAAKC,WAAWxB,IAAKC,UAAWC,MAAOC,YAKrDY,YAAYhB,aACLkB,YAAYlB,aAAagB,WAAWV,MAAK,kBACrCc,EAAEI,KAAKC,WAAWxB,IAAKC,UAAWC,MAAOC,SAK7Cc,YAAY,IAAII,SAAQ,SAACC,QAASM,QACrCpB,YAAYqB,KAAK,CACbC,WAAY,kBACZC,KAAM,CACFC,SAAUhC,IACViC,aAAc,GACdhC,UAAAA,UACAE,KAAAA,MAEJ+B,KAAM,SAACd,KAIHD,EAAEC,IAAInB,0CAAiBkB,EAAEC,IAAInB,kCAAaD,IAAMoB,4BACnCe,IAAIpB,SAAUK,KAC3BE,QAAQH,EAAEI,KAAKC,WAAWxB,IAAKC,UAAWC,MAAOC,QAErDiC,KAAMR,uBAMlBpB,YAAY6B,sBAGPC,KAAK9B,aAAa,GAAM,GAAO,EAAO,EAAGW,EAAEoB,IAAIC,SAKjDC,gBAAEC,KAAKC,MAAMF,gBAAG7B,gBAClBP,MAAK,yCAAIuC,gDAAAA,qCAAYA,oEASD,SAACA,aACpBC,aAAc,mBAAE,QAAQnC,KAAK,QAAQC,QAAQ,KAAM,KAEzDiC,QAAQE,SAAQ,oBAAE9C,UAAAA,IAAKC,gBAAAA,UAAW8C,YAAAA,uBAAO5C,KAC/BY,SAAW,CAAC,WAAYf,IAAKC,8BADS4C,wBACQG,KAAK,KAGnD/C,aAAakB,EAAEC,KAAUpB,OAAOmB,EAAEC,IAAInB,aAClCA,aAAakB,EAAEC,MACjBD,EAAEC,IAAInB,WAAa,IAGvBkB,EAAEC,IAAInB,WAAWD,KAAO+C,OAIvBrB,sBAAaC,IAAIZ,iCACLoB,IAAIpB,SAAUgC,OAIzBhC,YAAYhB,eACdA,aAAagB,UAAY0B,gBAAEQ,WAAW3B,QAAQyB,OAAO7B"}