CRM-16415 include Font Awesome CSS
[civicrm-core.git] / templates / CRM / Admin / Page / APIExplorer.js
CommitLineData
e4176358 1(function($, _, undefined) {
89ee60d5
CW
2 "use strict";
3 /* jshint validthis: true */
e4176358
CW
4 var
5 entity,
6 action,
a14e9d08 7 actions = {values: ['get']},
e4176358 8 fields = [],
fc6a6a51 9 getFieldData = {},
e4176358 10 params = {},
11a28852 11 smartyPhp,
65f22b4b 12 entityDoc,
8ffa1387 13 fieldTpl = _.template($('#api-param-tpl').html()),
c275764e 14 optionsTpl = _.template($('#api-options-tpl').html()),
b07af612 15 returnTpl = _.template($('#api-return-tpl').html()),
77099ee0 16 chainTpl = _.template($('#api-chain-tpl').html()),
bc4aa590 17 docCodeTpl = _.template($('#doc-code-tpl').html()),
77099ee0 18
f76eb8ae 19 // These types of entityRef don't require any input to open
a39f2446 20 // FIXME: ought to be in getfields metadata
f76eb8ae
CW
21 OPEN_IMMEDIATELY = ['RelationshipType', 'Event', 'Group', 'Tag'],
22
65b8c1db
CW
23 // Actions that don't support fancy operators
24 NO_OPERATORS = ['create', 'update', 'delete', 'setvalue', 'getoptions', 'getactions', 'getfields'],
25
5bd06c36 26 // Actions that don't support multiple values
26a700db 27 NO_MULTI = ['delete', 'getoptions', 'getactions', 'getfields', 'getfield', 'setvalue'],
5bd06c36 28
77099ee0
CW
29 // Operators with special properties
30 BOOL = ['IS NULL', 'IS NOT NULL'],
31 TEXT = ['LIKE', 'NOT LIKE'],
32 MULTI = ['IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'];
0c3a6e64 33
1080dff4
CW
34 /**
35 * Call prettyPrint function and perform additional formatting
36 * @param ele
37 */
38 function prettyPrint(ele) {
39 if (typeof window.prettyPrint === 'function') {
40 $(ele).removeClass('prettyprinted').addClass('prettyprint');
41
42 window.prettyPrint();
43
44 // Highlight errors in api result
45 $('span:contains("error_code"),span:contains("error_message")', '#api-result')
46 .siblings('span.str').css('color', '#B00');
47 }
48 }
49
b07af612
CW
50 /**
51 * Add a "fields" row
52 * @param name
53 */
e4176358 54 function addField(name) {
65b8c1db 55 $('#api-params').append($(fieldTpl({name: name || '', noOps: _.includes(NO_OPERATORS, action)})));
e4176358 56 var $row = $('tr:last-child', '#api-params');
77099ee0 57 $('input.api-param-name', $row).crmSelect2({
5c7169eb 58 data: fields.concat({id: '-', text: ts('Other') + '...', description: ts('Choose a field not in this list')}),
29956c59
CW
59 formatSelection: function(field) {
60 return field.text +
61 (field.required ? ' <span class="crm-marker">*</span>' : '');
62 },
5c7169eb 63 formatResult: function(field) {
29956c59
CW
64 return field.text +
65 (field.required ? ' <span class="crm-marker">*</span>' : '') +
66 '<div class="api-field-desc">' + field.description + '</div>';
5c7169eb 67 }
b07af612 68 }).change();
8ffa1387
CW
69 }
70
c275764e
CW
71 /**
72 * Add a new "options" row
c275764e 73 */
cb6d8859 74 function addOptionField() {
c275764e
CW
75 if ($('.api-options-row', '#api-params').length) {
76 $('.api-options-row:last', '#api-params').after($(optionsTpl({})));
77 } else {
78 $('#api-params').append($(optionsTpl({})));
79 }
80 var $row = $('.api-options-row:last', '#api-params');
81 $('.api-option-name', $row).crmSelect2({data: [
82 {id: 'limit', text: 'limit'},
83 {id: 'offset', text: 'offset'},
84 {id: 'sort', text: 'sort'},
85 {id: 'metadata', text: 'metadata'},
86 {id: '-', text: ts('Other') + '...'}
87 ]});
88 }
89
b07af612
CW
90 /**
91 * Add an "api chain" row
92 */
8ffa1387
CW
93 function addChainField() {
94 $('#api-params').append($(chainTpl({})));
95 var $row = $('tr:last-child', '#api-params');
96 $('.api-chain-entity', $row).crmSelect2({
97 formatSelection: function(item) {
3d9f5b7f
CW
98 return '<span class="icon ui-icon-link"></span> API ' +
99 ($(item.element).hasClass('strikethrough') ? '<span class="strikethrough">' + item.text + '</span>' : item.text);
2b6e1174
CW
100 },
101 placeholder: '<span class="icon ui-icon-link"></span> ' + ts('Entity'),
ff887074 102 escapeMarkup: function(m) {return m;}
8ffa1387 103 });
0c3a6e64
CW
104 }
105
3d9f5b7f
CW
106 /**
107 * Fetch available actions for selected chained entity
108 */
109 function getChainedAction() {
110 var
111 $selector = $(this),
112 entity = $selector.val(),
113 $row = $selector.closest('tr');
114 if (entity) {
115 $selector.prop('disabled', true);
116 CRM.api3(entity, 'getactions')
117 .done(function(actions) {
118 $selector.prop('disabled', false);
ff887074 119 CRM.utils.setOptions($('.api-chain-action', $row), _.transform(actions.values, function(ret, item) {ret.push({value: item, key: item});}));
3d9f5b7f
CW
120 });
121 }
122 }
123
b07af612
CW
124 /**
125 * Fetch fields for entity+action
126 */
a14e9d08 127 function getFields(changedElement) {
e4176358
CW
128 var required = [];
129 fields = [];
932630fd 130 getFieldData = {};
e4176358
CW
131 // Special case for getfields
132 if (action === 'getfields') {
133 fields.push({
134 id: 'api_action',
a39f2446
CW
135 text: 'Action',
136 options: _.reduce(actions.values, function(ret, item) {
137 ret[item] = item;
138 return ret;
139 }, {})
e4176358 140 });
e4176358 141 showFields(['api_action']);
0c3a6e64
CW
142 return;
143 }
b432ddaa 144 CRM.api3(entity, 'getfields', {'api_action': action, options: {get_options: 'all', get_options_context: 'match'}}).done(function(data) {
e4176358
CW
145 _.each(data.values, function(field) {
146 if (field.name) {
932630fd 147 getFieldData[field.name] = field;
e4176358
CW
148 fields.push({
149 id: field.name,
150 text: field.title || field.name,
7b6c5043 151 multi: !!field['api.multiple'],
5c7169eb 152 description: field.description || '',
7b6c5043 153 required: !(!field['api.required'] || field['api.required'] === '0')
e4176358 154 });
7b6c5043 155 if (field['api.required'] && field['api.required'] !== '0') {
e4176358
CW
156 required.push(field.name);
157 }
e4176358
CW
158 }
159 });
a14e9d08
CW
160 if ($(changedElement).is('#api-entity') && data.deprecated) {
161 CRM.alert(data.deprecated, entity + ' Deprecated');
162 }
e4176358 163 showFields(required);
3a721dfc
CW
164 if (action === 'get' || action === 'getsingle' || action == 'getvalue' || action === 'getstat') {
165 showReturn();
b07af612 166 }
0c3a6e64
CW
167 });
168 }
169
b07af612
CW
170 /**
171 * For "get" actions show the "return" options
3a721dfc
CW
172 *
173 * TODO: Too many hard-coded actions here. Need a way to fetch this from metadata
b07af612 174 */
3a721dfc
CW
175 function showReturn() {
176 var title = ts('Fields to return'),
177 params = {
178 data: fields,
179 multiple: true,
180 placeholder: ts('Leave blank for default')
181 };
182 if (action == 'getstat') {
183 title = ts('Group by');
184 }
185 if (action == 'getvalue') {
186 title = ts('Return Value');
187 params.placeholder = ts('Select field');
188 params.multiple = false;
189 }
29956c59 190 $('#api-params').prepend($(returnTpl({title: title, required: action == 'getvalue'})));
3a721dfc 191 $('#api-return-value').crmSelect2(params);
b07af612
CW
192 }
193
194 /**
195 * Fetch actions for entity
196 */
2b6e1174
CW
197 function getActions() {
198 if (entity) {
754927e4 199 $('#api-action').addClass('loading');
2b6e1174 200 CRM.api3(entity, 'getactions').done(function(data) {
a14e9d08 201 actions = data;
2b6e1174
CW
202 populateActions();
203 });
204 } else {
a14e9d08 205 actions = {values: ['get']};
2b6e1174
CW
206 populateActions();
207 }
208 }
209
7231faaf
CW
210 /**
211 * Test whether an action is deprecated
212 * @param action
213 * @returns {boolean}
214 */
15cbe793
CW
215 function isActionDeprecated(action) {
216 return !!(typeof actions.deprecated === 'object' && actions.deprecated[action]);
217 }
218
7231faaf
CW
219 /**
220 * Render action text depending on deprecation status
221 * @param option
222 * @returns {string}
223 */
a14e9d08 224 function renderAction(option) {
15cbe793 225 return isActionDeprecated(option.id) ? '<span class="strikethrough">' + option.text + '</span>' : option.text;
a14e9d08
CW
226 }
227
b07af612
CW
228 /**
229 * Called after getActions to populate action list
b07af612 230 */
cb6d8859 231 function populateActions() {
2f929504 232 var val = $('#api-action').val();
754927e4 233 $('#api-action').removeClass('loading').select2({
ff887074 234 data: _.transform(actions.values, function(ret, item) {ret.push({text: item, id: item});}),
a14e9d08
CW
235 formatSelection: renderAction,
236 formatResult: renderAction
2b6e1174 237 });
2f929504 238 // If previously selected action is not available, set it to 'get' if possible
ed0eaccc
CW
239 if (!_.includes(actions.values, val)) {
240 $('#api-action').select2('val', !_.includes(actions.values, 'get') ? actions.values[0] : 'get', true);
a14e9d08
CW
241 }
242 }
243
7231faaf
CW
244 /**
245 * Check for and display action-specific deprecation notices
246 * @param action
247 */
a14e9d08 248 function onChangeAction(action) {
15cbe793 249 if (isActionDeprecated(action)) {
a14e9d08 250 CRM.alert(actions.deprecated[action], action + ' deprecated');
2f929504 251 }
2b6e1174
CW
252 }
253
b07af612
CW
254 /**
255 * Called after getfields to show buttons and required fields
256 * @param required
257 */
e4176358 258 function showFields(required) {
e4176358 259 $('#api-params').empty();
8ffa1387 260 $('#api-param-buttons').show();
e4176358
CW
261 if (required.length) {
262 _.each(required, addField);
263 } else {
264 addField();
0c3a6e64
CW
265 }
266 }
267
4aed36b2
CW
268 function isYesNo(fieldName) {
269 return getFieldData[fieldName] && getFieldData[fieldName].type === 16;
270 }
271
d5a9020d
CW
272 /**
273 * Should we render a select or textfield?
274 *
275 * @param fieldName
276 * @param operator
277 * @returns boolean
278 */
279 function isSelect(fieldName, operator) {
a39f2446
CW
280 var fieldSpec = getFieldData[fieldName] || {};
281 return (isYesNo(fieldName) || fieldSpec.options || fieldSpec.FKApiName) && !_.includes(TEXT, operator);
d5a9020d
CW
282 }
283
284 /**
285 * Should we render a select as single or multi?
286 *
287 * @param fieldName
288 * @param operator
289 * @returns boolean
290 */
7b6c5043 291 function isMultiSelect(fieldName, operator) {
5bd06c36 292 if (isYesNo(fieldName) || _.includes(NO_MULTI, action)) {
4aed36b2
CW
293 return false;
294 }
ed0eaccc 295 if (_.includes(MULTI, operator)) {
d5a9020d
CW
296 return true;
297 }
298 // The = operator is ambiguous but all others can be safely assumed to be single
299 if (operator !== '=') {
300 return false;
301 }
302 return true;
303 /*
304 * Attempt to resolve the ambiguity of the = operator using metadata
305 * commented out because there is not enough metadata in the api at this time
306 * to accurately figure it out.
307 */
308 // var field = fieldName && _.find(fields, 'id', fieldName);
309 // return field && field.multi;
7b6c5043
CW
310 }
311
c275764e 312 /**
fc6a6a51 313 * Render value input as a textfield, option list, entityRef, or hidden,
77099ee0 314 * Depending on selected param name and operator
c275764e 315 */
77099ee0
CW
316 function renderValueField() {
317 var $row = $(this).closest('tr'),
318 name = $('input.api-param-name', $row).val(),
319 operator = $('.api-param-op', $row).val(),
77099ee0 320 $valField = $('input.api-param-value', $row),
7b6c5043 321 multiSelect = isMultiSelect(name, operator),
6e29772f
CW
322 currentVal = $valField.val(),
323 wasSelect = $valField.data('select2');
324 if (wasSelect) {
325 $valField.crmEntityRef('destroy');
326 }
327 $valField.attr('placeholder', ts('Value'));
77099ee0 328 // Boolean fields only have 1 possible value
ed0eaccc 329 if (_.includes(BOOL, operator)) {
77099ee0
CW
330 $valField.css('visibility', 'hidden').val('1');
331 return;
332 }
333 $valField.css('visibility', '');
fc6a6a51 334 // Option list or entityRef input
d5a9020d 335 if (isSelect(name, operator)) {
6e29772f 336 $valField.attr('placeholder', ts('- select -'));
77099ee0 337 // Reset value before switching to a select from something else
6e29772f 338 if ($(this).is('.api-param-name') || !wasSelect) {
77099ee0
CW
339 $valField.val('');
340 }
341 // When switching from multi-select to single select
ed0eaccc 342 else if (!multiSelect && _.includes(currentVal, ',')) {
77099ee0
CW
343 $valField.val(currentVal.split(',')[0]);
344 }
4aed36b2
CW
345 // Yes-No options
346 if (isYesNo(name)) {
347 $valField.select2({
348 data: [{id: 1, text: ts('Yes')}, {id: 0, text: ts('No')}]
349 });
350 }
fc6a6a51 351 // Select options
a39f2446 352 else if (getFieldData[name].options) {
fc6a6a51 353 $valField.select2({
7b6c5043 354 multiple: multiSelect,
a39f2446 355 data: _.map(getFieldData[name].options, function (value, key) {
fc6a6a51
CW
356 return {id: key, text: value};
357 })
358 });
359 }
360 // EntityRef
361 else {
6e29772f
CW
362 var entity = getFieldData[name].FKApiName;
363 $valField.attr('placeholder', entity == 'Contact' ? '[' + ts('Auto-Select Current User') + ']' : ts('- select -'));
fc6a6a51 364 $valField.crmEntityRef({
6e29772f 365 entity: entity,
f76eb8ae 366 select: {
7b6c5043 367 multiple: multiSelect,
e6de5a11
CW
368 minimumInputLength: _.includes(OPEN_IMMEDIATELY, entity) ? 0 : 1,
369 // If user types a numeric id, allow it as a choice
370 createSearchChoice: function(input) {
371 var match = /[1-9][0-9]*/.exec(input);
372 if (match && match[0] === input) {
373 return {id: input, label: input};
374 }
375 }
f76eb8ae 376 }
fc6a6a51
CW
377 });
378 }
e4176358 379 }
e4176358 380 }
0c3a6e64 381
e4176358
CW
382 /**
383 * Attempt to parse a string into a value of the intended type
babf9678
CW
384 * @param val string
385 * @param makeArray bool
e4176358
CW
386 */
387 function evaluate(val, makeArray) {
388 try {
389 if (!val.length) {
77099ee0 390 return makeArray ? [] : '';
e4176358
CW
391 }
392 var first = val.charAt(0),
393 last = val.slice(-1);
394 // Simple types
51f197bf 395 if (val === 'true' || val === 'false' || val === 'null') {
cb6d8859 396 /* jshint evil: true */
e4176358
CW
397 return eval(val);
398 }
399 // Quoted strings
400 if ((first === '"' || first === "'") && last === first) {
401 return val.slice(1, -1);
0c3a6e64 402 }
7231faaf 403 // Parse json - use eval rather than $.parseJSON because it's less strict about formatting
e4176358
CW
404 if ((first === '[' && last === ']') || (first === '{' && last === '}')) {
405 return eval('(' + val + ')');
406 }
407 // Transform csv to array
77099ee0
CW
408 if (makeArray) {
409 var result = [];
410 $.each(val.split(','), function(k, v) {
411 result.push(evaluate($.trim(v)) || v);
412 });
413 return result;
414 }
7231faaf 415 // Integers - skip any multidigit number that starts with 0 to avoid oddities (it will be treated as a string below)
77099ee0
CW
416 if (!isNaN(val) && val.search(/[^\d]/) < 0 && (val.length === 1 || first !== '0')) {
417 return parseInt(val, 10);
e4176358
CW
418 }
419 // Ok ok it's really a string
420 return val;
421 } catch(e) {
422 // If eval crashed return undefined
423 return undefined;
0c3a6e64 424 }
e4176358 425 }
0c3a6e64 426
e4176358
CW
427 /**
428 * Format value to look like php code
6e29772f 429 * TODO: Use short array syntax when we drop support for php 5.3
e4176358
CW
430 * @param val
431 */
432 function phpFormat(val) {
433 var ret = '';
434 if ($.isPlainObject(val)) {
435 $.each(val, function(k, v) {
c275764e 436 ret += (ret ? ', ' : '') + "'" + k + "' => " + phpFormat(v);
e4176358
CW
437 });
438 return 'array(' + ret + ')';
0c3a6e64 439 }
e4176358
CW
440 if ($.isArray(val)) {
441 $.each(val, function(k, v) {
442 ret += (ret ? ', ' : '') + phpFormat(v);
443 });
444 return 'array(' + ret + ')';
445 }
54c512e0 446 return JSON.stringify(val).replace(/\$/g, '\\$');
e4176358
CW
447 }
448
449 /**
11a28852 450 * @param value string
e4176358 451 * @param js string
d5a9020d 452 * @param key string
e4176358 453 */
11a28852
CW
454 function smartyFormat(value, js, key) {
455 var varName = 'param_' + key.replace(/[. -]/g, '_').toLowerCase();
456 // Can't pass array literals directly into smarty so we add a php snippet
ed0eaccc 457 if (_.includes(js, '[') || _.includes(js, '{')) {
11a28852
CW
458 smartyPhp.push('$this->assign("'+ varName + '", '+ phpFormat(value) +');');
459 return '$' + varName;
e4176358
CW
460 }
461 return js;
462 }
463
c275764e
CW
464 /**
465 * Create the params array from user input
466 * @param e
467 */
e4176358
CW
468 function buildParams(e) {
469 params = {};
470 $('.api-param-checkbox:checked').each(function() {
471 params[this.name] = 1;
472 });
c275764e 473 $('input.api-param-value, input.api-option-value').each(function() {
e4176358 474 var $row = $(this).closest('tr'),
d5a9020d 475 input = $(this).val(),
77099ee0 476 op = $('select.api-param-op', $row).val() || '=',
e4176358 477 name = $('input.api-param-name', $row).val(),
d5a9020d 478 // Workaround for ambiguity of the = operator
ed0eaccc 479 makeArray = (op === '=' && isSelect(name, op)) ? _.includes(input, ',') : op !== '=' && isMultiSelect(name, op),
d5a9020d 480 val = evaluate(input, makeArray);
b07af612
CW
481
482 // Ignore blank values for the return field
483 if ($(this).is('#api-return-value') && !val) {
484 return;
485 }
8ffa1387
CW
486 // Special syntax for api chaining
487 if (!name && $('select.api-chain-entity', $row).val()) {
488 name = 'api.' + $('select.api-chain-entity', $row).val() + '.' + $('select.api-chain-action', $row).val();
489 }
c275764e
CW
490 // Special handling for options
491 if ($(this).is('.api-option-value')) {
492 op = $('input.api-option-name', $row).val();
493 if (op) {
494 name = 'options';
495 }
496 }
6e29772f
CW
497 // Default for contact ref fields
498 if ($(this).is('.crm-contact-ref') && input === '') {
499 val = evaluate('user_contact_id', makeArray);
500 }
e4176358 501 if (name && val !== undefined) {
c275764e 502 params[name] = op === '=' ? val : (params[name] || {});
e4176358
CW
503 if (op !== '=') {
504 params[name][op] = val;
505 }
babf9678
CW
506 if ($(this).hasClass('crm-error')) {
507 clearError(this);
508 }
e4176358
CW
509 }
510 else if (name && (!e || e.type !== 'keyup')) {
511 setError(this);
512 }
513 });
514 if (entity && action) {
515 formatQuery();
0c3a6e64 516 }
e4176358 517 }
0c3a6e64 518
7231faaf
CW
519 /**
520 * Display error message on incorrectly-formatted params
521 * @param el
522 */
e4176358
CW
523 function setError(el) {
524 if (!$(el).hasClass('crm-error')) {
babf9678 525 var msg = ts('Syntax error: input should be valid JSON or a quoted string.');
e4176358
CW
526 $(el)
527 .addClass('crm-error')
2b6e1174 528 .css('width', '82%')
babf9678
CW
529 .attr('title', msg)
530 .before('<div class="icon red-icon ui-icon-alert" title="'+msg+'"/>')
531 .tooltip();
e4176358
CW
532 }
533 }
0c3a6e64 534
7231faaf
CW
535 /**
536 * Remove error message
537 * @param el
538 */
e4176358
CW
539 function clearError(el) {
540 $(el)
541 .removeClass('crm-error')
542 .attr('title', '')
2b6e1174 543 .css('width', '85%')
babf9678 544 .tooltip('destroy')
e4176358
CW
545 .siblings('.ui-icon-alert').remove();
546 }
0c3a6e64 547
7231faaf
CW
548 /**
549 * Render the api request in various formats
550 */
e4176358
CW
551 function formatQuery() {
552 var i = 0, q = {
11a28852 553 smarty: "{crmAPI var='result' entity='" + entity + "' action='" + action + "'" + (params.sequential ? '' : ' sequential=0'),
e4176358
CW
554 php: "$result = civicrm_api3('" + entity + "', '" + action + "'",
555 json: "CRM.api3('" + entity + "', '" + action + "'",
2dad2b26
TO
556 drush: "drush cvapi " + entity + '.' + action + ' ',
557 wpcli: "wp cv api " + entity + '.' + action + ' ',
de69691f 558 rest: CRM.config.resourceBase + "extern/rest.php?entity=" + entity + "&action=" + action + "&api_key=userkey&key=sitekey&json=" + JSON.stringify(params)
e4176358 559 };
11a28852 560 smartyPhp = [];
e4176358 561 $.each(params, function(key, value) {
a2ea6df9
CW
562 var json = JSON.stringify(value),
563 // Encourage 'return' to be an array - at least in php & js
564 js = key === 'return' ? JSON.stringify(evaluate(value, true)) : json,
565 php = key === 'return' ? phpFormat(evaluate(value, true)) : phpFormat(value);
cb6d8859 566 if (!(i++)) {
e4176358
CW
567 q.php += ", array(\n";
568 q.json += ", {\n";
569 } else {
570 q.json += ",\n";
571 }
a2ea6df9 572 q.php += " '" + key + "' => " + php + ",\n";
e4176358 573 q.json += " \"" + key + '": ' + js;
11a28852
CW
574 // smarty already defaults to sequential
575 if (key !== 'sequential') {
a2ea6df9 576 q.smarty += ' ' + key + '=' + smartyFormat(value, json, key);
11a28852 577 }
77099ee0 578 // FIXME: This is not totally correct cli syntax
a2ea6df9
CW
579 q.drush += key + '=' + json + ' ';
580 q.wpcli += key + '=' + json + ' ';
e4176358
CW
581 });
582 if (i) {
583 q.php += ")";
584 q.json += "\n}";
585 }
586 q.php += ");";
587 q.json += ").done(function(result) {\n // do something\n});";
588 q.smarty += "}\n{foreach from=$result.values item=" + entity.toLowerCase() + "}\n {$" + entity.toLowerCase() + ".some_field}\n{/foreach}";
ed0eaccc 589 if (!_.includes(action, 'get')) {
e4176358 590 q.smarty = '{* Smarty API only works with get actions *}';
11a28852
CW
591 } else if (smartyPhp.length) {
592 q.smarty = "{php}\n " + smartyPhp.join("\n ") + "\n{/php}\n" + q.smarty;
e4176358
CW
593 }
594 $.each(q, function(type, val) {
1080dff4 595 $('#api-' + type).text(val);
e4176358 596 });
1080dff4 597 prettyPrint('#api-generated pre');
e4176358 598 }
0c3a6e64 599
7231faaf
CW
600 /**
601 * Submit button handler
602 * @param e
603 */
e4176358
CW
604 function submit(e) {
605 e.preventDefault();
606 if (!entity || !action) {
2b6e1174 607 alert(ts('Select an entity.'));
e4176358
CW
608 return;
609 }
ed0eaccc 610 if (!_.includes(action, 'get') && action != 'check') {
e4176358
CW
611 var msg = action === 'delete' ? ts('This will delete data from CiviCRM. Are you sure?') : ts('This will write to the database. Continue?');
612 CRM.confirm({title: ts('Confirm %1', {1: action}), message: msg}).on('crmConfirm:yes', execute);
0c3a6e64 613 } else {
e4176358 614 execute();
0c3a6e64 615 }
0c3a6e64
CW
616 }
617
77099ee0
CW
618 /**
619 * Execute api call and display the results
620 * Note: We have to manually execute the ajax in order to add the secret extra "prettyprint" param
621 */
e4176358 622 function execute() {
b308e50d 623 var footer;
e4176358
CW
624 $('#api-result').html('<div class="crm-loading-element"></div>');
625 $.ajax({
626 url: CRM.url('civicrm/ajax/rest'),
627 data: {
628 entity: entity,
629 action: action,
630 prettyprint: 1,
631 json: JSON.stringify(params)
632 },
ed0eaccc 633 type: _.includes(action, 'get') ? 'GET' : 'POST',
e4176358
CW
634 dataType: 'text'
635 }).done(function(text) {
b308e50d
CW
636 // There may be debug information appended to the end of the json string
637 var footerPos = text.indexOf("\n}<");
638 if (footerPos) {
639 footer = text.substr(footerPos + 2);
640 text = text.substr(0, footerPos + 2);
641 }
1080dff4
CW
642 $('#api-result').text(text);
643 prettyPrint('#api-result');
b308e50d
CW
644 if (footer) {
645 $('#api-result').append(footer);
646 }
e4176358 647 });
0c3a6e64 648 }
e4176358 649
89ee60d5
CW
650 /**
651 * Fetch list of example files for a given entity
652 */
653 function getExamples() {
654 CRM.utils.setOptions($('#example-action').prop('disabled', true).addClass('loading'), []);
655 $.getJSON(CRM.url('civicrm/ajax/apiexample', {entity: $(this).val()}))
656 .done(function(result) {
657 CRM.utils.setOptions($('#example-action').prop('disabled', false).removeClass('loading'), result);
658 });
659 }
660
661 /**
662 * Fetch and display an example file
663 */
664 function getExample() {
665 var
666 entity = $('#example-entity').val(),
667 action = $('#example-action').val();
668 if (entity && action) {
669 $('#example-result').block();
670 $.get(CRM.url('civicrm/ajax/apiexample', {file: entity + '/' + action}))
671 .done(function(result) {
1080dff4
CW
672 $('#example-result').unblock().text(result);
673 prettyPrint('#example-result');
89ee60d5
CW
674 });
675 } else {
65f22b4b 676 $('#example-result').text($('#example-result').attr('placeholder'));
89ee60d5
CW
677 }
678 }
679
bc4aa590
CW
680 /**
681 * Fetch entity docs & actions
682 */
683 function getDocEntity() {
684 CRM.utils.setOptions($('#doc-action').prop('disabled', true).addClass('loading'), []);
685 $.getJSON(CRM.url('civicrm/ajax/apidoc', {entity: $(this).val()}))
686 .done(function(result) {
65f22b4b 687 entityDoc = result.doc;
bc4aa590
CW
688 CRM.utils.setOptions($('#doc-action').prop('disabled', false).removeClass('loading'), result.actions);
689 $('#doc-result').html(result.doc);
fea52a54 690 prettyPrint('#doc-result pre');
bc4aa590
CW
691 });
692 }
693
694 /**
695 * Fetch entity+action docs & code
696 */
697 function getDocAction() {
698 var
699 entity = $('#doc-entity').val(),
700 action = $('#doc-action').val();
701 if (entity && action) {
702 $('#doc-result').block();
703 $.get(CRM.url('civicrm/ajax/apidoc', {entity: entity, action: action}))
704 .done(function(result) {
705 $('#doc-result').unblock().html(result.doc);
706 if (result.code) {
707 $('#doc-result').append(docCodeTpl(result));
708 }
fea52a54 709 prettyPrint('#doc-result pre');
bc4aa590
CW
710 });
711 } else {
65f22b4b 712 $('#doc-result').html(entityDoc);
fea52a54 713 prettyPrint('#doc-result pre');
bc4aa590 714 }
85470f85
PN
715 checkBookKeepingEntity(entity, action);
716 }
717
718 /**
719 * Check if entity is Financial Trxn and Entity Financial Trxn
720 * and Action is Create, delete, update etc then display warning
721 */
722 function checkBookKeepingEntity(entity, action) {
23989f49 723 if ($.inArray(entity, ['EntityFinancialTrxn', 'FinancialTrxn']) > -1 && $.inArray(action, ['delete', 'setvalue', 'replace', 'create']) > -1) {
85470f85
PN
724 var msg = ts('Given the importance of auditability, extension developers are strongly discouraged from writing code to add, update or delete entries in the civicrm_financial_item, civicrm_entity_financial_trxn, and civicrm_financial_trxn tables. Before publishing an extension on civicrm.org that does any of this, please ask for a special bookkeeping code review for the extension.');
725 CRM.alert(msg, 'warning');
726 }
bc4aa590
CW
727 }
728
e4176358 729 $(document).ready(function() {
89ee60d5
CW
730 // Set up tabs - bind active tab to document hash because... it's cool?
731 document.location.hash = document.location.hash || 'explorer';
732 $('#mainTabContainer')
733 .tabs({
734 active: $(document.location.hash + '-tab').index() - 1
735 })
736 .on('tabsactivate', function(e, ui) {
737 if (ui.newPanel) {
738 document.location.hash = ui.newPanel.attr('id').replace('-tab', '');
739 }
740 });
bc4aa590
CW
741 $(window).on('hashchange', function() {
742 $('#mainTabContainer').tabs('option', 'active', $(document.location.hash + '-tab').index() - 1);
743 });
89ee60d5
CW
744
745 // Initialize widgets
bc4aa590 746 $('#api-entity, #example-entity, #doc-entity').crmSelect2({
a14e9d08
CW
747 // Add strikethough class to selection to indicate deprecated apis
748 formatSelection: function(option) {
749 return $(option.element).hasClass('strikethrough') ? '<span class="strikethrough">' + option.text + '</span>' : option.text;
750 }
751 });
e4176358
CW
752 $('form#api-explorer')
753 .on('change', '#api-entity, #api-action', function() {
754 entity = $('#api-entity').val();
a14e9d08 755 action = $('#api-action').val();
2b6e1174 756 if ($(this).is('#api-entity')) {
2b6e1174 757 getActions();
a14e9d08
CW
758 } else {
759 onChangeAction(action);
2b6e1174 760 }
e4176358
CW
761 if (entity && action) {
762 $('#api-params').html('<tr><td colspan="4" class="crm-loading-element"></td></tr>');
763 $('#api-params-table thead').show();
a14e9d08 764 getFields(this);
bbb279d7 765 buildParams();
85470f85 766 checkBookKeepingEntity(entity, action);
e4176358
CW
767 } else {
768 $('#api-params, #api-generated pre').empty();
8ffa1387 769 $('#api-param-buttons, #api-params-table thead').hide();
e4176358
CW
770 }
771 })
2b6e1174 772 .on('change keyup', 'input.api-input, #api-params select', buildParams)
e4176358
CW
773 .on('submit', submit);
774 $('#api-params')
77099ee0
CW
775 .on('change', 'input.api-param-name, select.api-param-op', renderValueField)
776 .on('change', 'input.api-param-name, .api-option-name', function() {
f76eb8ae 777 if ($(this).val() === '-' && $(this).data('select2')) {
6e29772f
CW
778 $(this)
779 .crmSelect2('destroy')
780 .val('')
781 .focus();
c275764e
CW
782 }
783 })
e4176358
CW
784 .on('click', '.api-param-remove', function(e) {
785 e.preventDefault();
786 $(this).closest('tr').remove();
787 buildParams();
3d9f5b7f
CW
788 })
789 .on('change', 'select.api-chain-entity', getChainedAction);
89ee60d5
CW
790 $('#example-entity').on('change', getExamples);
791 $('#example-action').on('change', getExample);
bc4aa590
CW
792 $('#doc-entity').on('change', getDocEntity);
793 $('#doc-action').on('change', getDocAction);
e4176358 794 $('#api-params-add').on('click', function(e) {
8ffa1387 795 e.preventDefault();
e4176358 796 addField();
8ffa1387 797 });
c275764e
CW
798 $('#api-option-add').on('click', function(e) {
799 e.preventDefault();
800 addOptionField();
801 });
8ffa1387 802 $('#api-chain-add').on('click', function(e) {
e4176358 803 e.preventDefault();
8ffa1387 804 addChainField();
e4176358
CW
805 });
806 $('#api-entity').change();
0c3a6e64 807 });
e4176358 808}(CRM.$, CRM._));