template_srv.ts 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. import kbn from 'app/core/utils/kbn';
  2. import _ from 'lodash';
  3. import { variableRegex } from 'app/features/templating/variable';
  4. function luceneEscape(value) {
  5. return value.replace(/([\!\*\+\-\=<>\s\&\|\(\)\[\]\{\}\^\~\?\:\\/"])/g, '\\$1');
  6. }
  7. export class TemplateSrv {
  8. variables: any[];
  9. private regex = variableRegex;
  10. private index = {};
  11. private grafanaVariables = {};
  12. private builtIns = {};
  13. constructor() {
  14. this.builtIns['__interval'] = { text: '1s', value: '1s' };
  15. this.builtIns['__interval_ms'] = { text: '100', value: '100' };
  16. this.variables = [];
  17. }
  18. init(variables) {
  19. this.variables = variables;
  20. this.updateTemplateData();
  21. }
  22. updateTemplateData() {
  23. const existsOrEmpty = value => value || value === '';
  24. this.index = this.variables.reduce((acc, currentValue) => {
  25. if (currentValue.current && (currentValue.current.isNone || existsOrEmpty(currentValue.current.value))) {
  26. acc[currentValue.name] = currentValue;
  27. }
  28. return acc;
  29. }, {});
  30. }
  31. variableInitialized(variable) {
  32. this.index[variable.name] = variable;
  33. }
  34. getAdhocFilters(datasourceName) {
  35. let filters = [];
  36. if (this.variables) {
  37. for (let i = 0; i < this.variables.length; i++) {
  38. const variable = this.variables[i];
  39. if (variable.type !== 'adhoc') {
  40. continue;
  41. }
  42. // null is the "default" datasource
  43. if (variable.datasource === null || variable.datasource === datasourceName) {
  44. filters = filters.concat(variable.filters);
  45. } else if (variable.datasource.indexOf('$') === 0) {
  46. if (this.replace(variable.datasource) === datasourceName) {
  47. filters = filters.concat(variable.filters);
  48. }
  49. }
  50. }
  51. }
  52. return filters;
  53. }
  54. luceneFormat(value) {
  55. if (typeof value === 'string') {
  56. return luceneEscape(value);
  57. }
  58. if (value instanceof Array && value.length === 0) {
  59. return '__empty__';
  60. }
  61. const quotedValues = _.map(value, val => {
  62. return '"' + luceneEscape(val) + '"';
  63. });
  64. return '(' + quotedValues.join(' OR ') + ')';
  65. }
  66. formatValue(value, format, variable) {
  67. // for some scopedVars there is no variable
  68. variable = variable || {};
  69. if (typeof format === 'function') {
  70. return format(value, variable, this.formatValue);
  71. }
  72. switch (format) {
  73. case 'regex': {
  74. if (typeof value === 'string') {
  75. return kbn.regexEscape(value);
  76. }
  77. const escapedValues = _.map(value, kbn.regexEscape);
  78. if (escapedValues.length === 1) {
  79. return escapedValues[0];
  80. }
  81. return '(' + escapedValues.join('|') + ')';
  82. }
  83. case 'lucene': {
  84. return this.luceneFormat(value);
  85. }
  86. case 'pipe': {
  87. if (typeof value === 'string') {
  88. return value;
  89. }
  90. return value.join('|');
  91. }
  92. case 'distributed': {
  93. if (typeof value === 'string') {
  94. return value;
  95. }
  96. return this.distributeVariable(value, variable.name);
  97. }
  98. case 'csv': {
  99. if (_.isArray(value)) {
  100. return value.join(',');
  101. }
  102. return value;
  103. }
  104. default: {
  105. if (_.isArray(value)) {
  106. return '{' + value.join(',') + '}';
  107. }
  108. return value;
  109. }
  110. }
  111. }
  112. setGrafanaVariable(name, value) {
  113. this.grafanaVariables[name] = value;
  114. }
  115. getVariableName(expression) {
  116. this.regex.lastIndex = 0;
  117. const match = this.regex.exec(expression);
  118. if (!match) {
  119. return null;
  120. }
  121. const variableName = match.slice(1).find(match => match !== undefined);
  122. return variableName;
  123. }
  124. variableExists(expression) {
  125. const name = this.getVariableName(expression);
  126. return name && this.index[name] !== void 0;
  127. }
  128. highlightVariablesAsHtml(str) {
  129. if (!str || !_.isString(str)) {
  130. return str;
  131. }
  132. str = _.escape(str);
  133. this.regex.lastIndex = 0;
  134. return str.replace(this.regex, (match, var1, var2, fmt2, var3) => {
  135. if (this.index[var1 || var2 || var3] || this.builtIns[var1 || var2 || var3]) {
  136. return '<span class="template-variable">' + match + '</span>';
  137. }
  138. return match;
  139. });
  140. }
  141. getAllValue(variable) {
  142. if (variable.allValue) {
  143. return variable.allValue;
  144. }
  145. const values = [];
  146. for (let i = 1; i < variable.options.length; i++) {
  147. values.push(variable.options[i].value);
  148. }
  149. return values;
  150. }
  151. replace(target, scopedVars?, format?) {
  152. if (!target) {
  153. return target;
  154. }
  155. let variable, systemValue, value, fmt;
  156. this.regex.lastIndex = 0;
  157. return target.replace(this.regex, (match, var1, var2, fmt2, var3, fmt3) => {
  158. variable = this.index[var1 || var2 || var3];
  159. fmt = fmt2 || fmt3 || format;
  160. if (scopedVars) {
  161. value = scopedVars[var1 || var2 || var3];
  162. if (value) {
  163. return this.formatValue(value.value, fmt, variable);
  164. }
  165. }
  166. if (!variable) {
  167. return match;
  168. }
  169. systemValue = this.grafanaVariables[variable.current.value];
  170. if (systemValue) {
  171. return this.formatValue(systemValue, fmt, variable);
  172. }
  173. value = variable.current.value;
  174. if (this.isAllValue(value)) {
  175. value = this.getAllValue(variable);
  176. // skip formatting of custom all values
  177. if (variable.allValue) {
  178. return this.replace(value);
  179. }
  180. }
  181. const res = this.formatValue(value, fmt, variable);
  182. return res;
  183. });
  184. }
  185. isAllValue(value) {
  186. return value === '$__all' || (Array.isArray(value) && value[0] === '$__all');
  187. }
  188. replaceWithText(target, scopedVars) {
  189. if (!target) {
  190. return target;
  191. }
  192. let variable;
  193. this.regex.lastIndex = 0;
  194. return target.replace(this.regex, (match, var1, var2, fmt2, var3) => {
  195. if (scopedVars) {
  196. const option = scopedVars[var1 || var2 || var3];
  197. if (option) {
  198. return option.text;
  199. }
  200. }
  201. variable = this.index[var1 || var2 || var3];
  202. if (!variable) {
  203. return match;
  204. }
  205. return this.grafanaVariables[variable.current.value] || variable.current.text;
  206. });
  207. }
  208. fillVariableValuesForUrl(params, scopedVars) {
  209. _.each(this.variables, variable => {
  210. if (scopedVars && scopedVars[variable.name] !== void 0) {
  211. if (scopedVars[variable.name].skipUrlSync) {
  212. return;
  213. }
  214. params['var-' + variable.name] = scopedVars[variable.name].value;
  215. } else {
  216. if (variable.skipUrlSync) {
  217. return;
  218. }
  219. params['var-' + variable.name] = variable.getValueForUrl();
  220. }
  221. });
  222. }
  223. distributeVariable(value, variable) {
  224. value = _.map(value, (val, index) => {
  225. if (index !== 0) {
  226. return variable + '=' + val;
  227. } else {
  228. return val;
  229. }
  230. });
  231. return value.join(',');
  232. }
  233. }
  234. export default new TemplateSrv();