abp.jquery.js 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  1. (function (define) {
  2. define(['jquery', 'abp-web-resources'], function ($, abp) {
  3. return (function () {
  4. if (!$) {
  5. return;
  6. }
  7. if (!abp) {
  8. return;
  9. }
  10. /* JQUERY ENHANCEMENTS ***************************************************/
  11. // abp.ajax -> uses $.ajax ------------------------------------------------
  12. abp.ajax = function (userOptions) {
  13. userOptions = userOptions || {};
  14. var options = $.extend(true, {}, abp.ajax.defaultOpts, userOptions);
  15. var oldBeforeSendOption = options.beforeSend;
  16. options.beforeSend = function (xhr) {
  17. if (oldBeforeSendOption) {
  18. oldBeforeSendOption(xhr);
  19. }
  20. xhr.setRequestHeader("Pragma", "no-cache");
  21. xhr.setRequestHeader("Cache-Control", "no-cache");
  22. xhr.setRequestHeader("Expires", "Sat, 01 Jan 2000 00:00:00 GMT");
  23. };
  24. options.success = undefined;
  25. options.error = undefined;
  26. return $.Deferred(function ($dfd) {
  27. $.ajax(options)
  28. .done(function (data, textStatus, jqXHR) {
  29. if (data.__abp) {
  30. abp.ajax.handleResponse(data, userOptions, $dfd, jqXHR);
  31. } else {
  32. $dfd.resolve(data);
  33. userOptions.success && userOptions.success(data);
  34. }
  35. }).fail(function (jqXHR) {
  36. if (jqXHR.responseJSON && jqXHR.responseJSON.__abp) {
  37. abp.ajax.handleResponse(jqXHR.responseJSON, userOptions, $dfd, jqXHR);
  38. } else {
  39. abp.ajax.handleNonAbpErrorResponse(jqXHR, userOptions, $dfd);
  40. }
  41. });
  42. });
  43. };
  44. $.extend(abp.ajax, {
  45. defaultOpts: {
  46. dataType: 'json',
  47. type: 'POST',
  48. contentType: 'application/json',
  49. headers: {
  50. 'X-Requested-With': 'XMLHttpRequest'
  51. }
  52. },
  53. defaultError: {
  54. message: 'An error has occurred!',
  55. details: 'Error detail not sent by server.'
  56. },
  57. defaultError401: {
  58. message: 'You are not authenticated!',
  59. details: 'You should be authenticated (sign in) in order to perform this operation.'
  60. },
  61. defaultError403: {
  62. message: 'You are not authorized!',
  63. details: 'You are not allowed to perform this operation.'
  64. },
  65. defaultError404: {
  66. message: 'Resource not found!',
  67. details: 'The resource requested could not found on the server.'
  68. },
  69. logError: function (error) {
  70. abp.log.error(error);
  71. },
  72. showError: function (error) {
  73. if (error.details) {
  74. return abp.message.error(error.details, error.message);
  75. } else {
  76. return abp.message.error(error.message || abp.ajax.defaultError.message);
  77. }
  78. },
  79. handleTargetUrl: function (targetUrl) {
  80. if (!targetUrl) {
  81. location.href = abp.appPath;
  82. } else {
  83. location.href = targetUrl;
  84. }
  85. },
  86. handleNonAbpErrorResponse: function (jqXHR, userOptions, $dfd) {
  87. if (userOptions.abpHandleError !== false) {
  88. switch (jqXHR.status) {
  89. case 401:
  90. abp.ajax.handleUnAuthorizedRequest(
  91. abp.ajax.showError(abp.ajax.defaultError401),
  92. abp.appPath
  93. );
  94. break;
  95. case 403:
  96. abp.ajax.showError(abp.ajax.defaultError403);
  97. break;
  98. case 404:
  99. abp.ajax.showError(abp.ajax.defaultError404);
  100. break;
  101. default:
  102. abp.ajax.showError(abp.ajax.defaultError);
  103. break;
  104. }
  105. }
  106. $dfd.reject.apply(this, arguments);
  107. userOptions.error && userOptions.error.apply(this, arguments);
  108. },
  109. handleUnAuthorizedRequest: function (messagePromise, targetUrl) {
  110. if (messagePromise) {
  111. messagePromise.done(function () {
  112. abp.ajax.handleTargetUrl(targetUrl);
  113. });
  114. } else {
  115. abp.ajax.handleTargetUrl(targetUrl);
  116. }
  117. },
  118. handleResponse: function (data, userOptions, $dfd, jqXHR) {
  119. if (data) {
  120. if (data.success === true) {
  121. $dfd && $dfd.resolve(data.result, data, jqXHR);
  122. userOptions.success && userOptions.success(data.result, data, jqXHR);
  123. if (data.targetUrl) {
  124. abp.ajax.handleTargetUrl(data.targetUrl);
  125. }
  126. } else if (data.success === false) {
  127. var messagePromise = null;
  128. if (data.error) {
  129. if (userOptions.abpHandleError !== false) {
  130. messagePromise = abp.ajax.showError(data.error);
  131. }
  132. } else {
  133. data.error = abp.ajax.defaultError;
  134. }
  135. abp.ajax.logError(data.error);
  136. $dfd && $dfd.reject(data.error, jqXHR);
  137. userOptions.error && userOptions.error(data.error, jqXHR);
  138. if (jqXHR.status === 401 && userOptions.abpHandleError !== false) {
  139. abp.ajax.handleUnAuthorizedRequest(messagePromise, data.targetUrl);
  140. }
  141. } else { //not wrapped result
  142. $dfd && $dfd.resolve(data, null, jqXHR);
  143. userOptions.success && userOptions.success(data, null, jqXHR);
  144. }
  145. } else { //no data sent to back
  146. $dfd && $dfd.resolve(jqXHR);
  147. userOptions.success && userOptions.success(jqXHR);
  148. }
  149. },
  150. blockUI: function (options) {
  151. if (options.blockUI) {
  152. if (options.blockUI === true) { //block whole page
  153. abp.ui.setBusy();
  154. } else { //block an element
  155. abp.ui.setBusy(options.blockUI);
  156. }
  157. }
  158. },
  159. unblockUI: function (options) {
  160. if (options.blockUI) {
  161. if (options.blockUI === true) { //unblock whole page
  162. abp.ui.clearBusy();
  163. } else { //unblock an element
  164. abp.ui.clearBusy(options.blockUI);
  165. }
  166. }
  167. },
  168. ajaxSendHandler: function (event, request, settings) {
  169. var token = abp.security.antiForgery.getToken();
  170. if (!token) {
  171. return;
  172. }
  173. if (!abp.security.antiForgery.shouldSendToken(settings)) {
  174. return;
  175. }
  176. if (!settings.headers || settings.headers[abp.security.antiForgery.tokenHeaderName] === undefined) {
  177. request.setRequestHeader(abp.security.antiForgery.tokenHeaderName, token);
  178. }
  179. }
  180. });
  181. $(document).ajaxSend(function (event, request, settings) {
  182. return abp.ajax.ajaxSendHandler(event, request, settings);
  183. });
  184. /* JQUERY PLUGIN ENHANCEMENTS ********************************************/
  185. /* jQuery Form Plugin
  186. * http://www.malsup.com/jquery/form/
  187. */
  188. // abpAjaxForm -> uses ajaxForm ------------------------------------------
  189. if ($.fn.ajaxForm) {
  190. $.fn.abpAjaxForm = function (userOptions) {
  191. userOptions = userOptions || {};
  192. var options = $.extend({}, $.fn.abpAjaxForm.defaults, userOptions);
  193. options.beforeSubmit = function () {
  194. abp.ajax.blockUI(options);
  195. userOptions.beforeSubmit && userOptions.beforeSubmit.apply(this, arguments);
  196. };
  197. options.success = function (data) {
  198. abp.ajax.handleResponse(data, userOptions);
  199. };
  200. //TODO: Error?
  201. options.complete = function () {
  202. abp.ajax.unblockUI(options);
  203. userOptions.complete && userOptions.complete.apply(this, arguments);
  204. };
  205. return this.ajaxForm(options);
  206. };
  207. $.fn.abpAjaxForm.defaults = {
  208. method: 'POST'
  209. };
  210. }
  211. abp.event.on('abp.dynamicScriptsInitialized', function () {
  212. abp.ajax.defaultError.message = abp.localization.abpWeb('DefaultError');
  213. abp.ajax.defaultError.details = abp.localization.abpWeb('DefaultErrorDetail');
  214. abp.ajax.defaultError401.message = abp.localization.abpWeb('DefaultError401');
  215. abp.ajax.defaultError401.details = abp.localization.abpWeb('DefaultErrorDetail401');
  216. abp.ajax.defaultError403.message = abp.localization.abpWeb('DefaultError403');
  217. abp.ajax.defaultError403.details = abp.localization.abpWeb('DefaultErrorDetail403');
  218. abp.ajax.defaultError404.message = abp.localization.abpWeb('DefaultError404');
  219. abp.ajax.defaultError404.details = abp.localization.abpWeb('DefaultErrorDetail404');
  220. });
  221. return abp;
  222. })();
  223. });
  224. }(typeof define === 'function' && define.amd
  225. ? define
  226. : function (deps, factory) {
  227. if (typeof module !== 'undefined' && module.exports) {
  228. module.exports = factory(require('jquery'), require('abp-web-resources'));
  229. } else {
  230. window.abp = factory(window.jQuery, window.abp);
  231. }
  232. }));