summaryrefslogtreecommitdiff
path: root/resources/src/mediawiki.api/mediawiki.api.edit.js
blob: e88ae5e2039beadbf694853acfbbb2eb1e00b63f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/**
 * @class mw.Api.plugin.edit
 */
( function ( mw, $ ) {

	var msg = 'Use of mediawiki.api callback params is deprecated. Use the Promise instead.';
	$.extend( mw.Api.prototype, {

		/**
		 * Post to API with edit token. If we have no token, get one and try to post.
		 * If we have a cached token try using that, and if it fails, blank out the
		 * cached token and start over.
		 *
		 * @param {Object} params API parameters
		 * @param {Function} [ok] Success callback (deprecated)
		 * @param {Function} [err] Error callback (deprecated)
		 * @return {jQuery.Promise} See #post
		 */
		postWithEditToken: function ( params, ok, err ) {
			if ( ok || err ) {
				mw.track( 'mw.deprecate', 'api.cbParam' );
				mw.log.warn( msg );
			}

			return this.postWithToken( 'edit', params ).done( ok ).fail( err );
		},

		/**
		 * API helper to grab an edit token.
		 *
		 * @param {Function} [ok] Success callback (deprecated)
		 * @param {Function} [err] Error callback (deprecated)
		 * @return {jQuery.Promise}
		 * @return {Function} return.done
		 * @return {string} return.done.token Received token.
		 */
		getEditToken: function ( ok, err ) {
			if ( ok || err ) {
				mw.track( 'mw.deprecate', 'api.cbParam' );
				mw.log.warn( msg );
			}

			return this.getToken( 'edit' ).done( ok ).fail( err );
		},

		/**
		 * Post a new section to the page.
		 * @see #postWithEditToken
		 * @param {mw.Title|String} title Target page
		 * @param {string} header
		 * @param {string} message wikitext message
		 * @param {Object} [additionalParams] Additional API parameters, e.g. `{ redirect: true }`
		 * @param {Function} [ok] Success handler (deprecated)
		 * @param {Function} [err] Error handler (deprecated)
		 * @return {jQuery.Promise}
		 */
		newSection: function ( title, header, message, additionalParams, ok, err ) {
			// Until we remove 'ok' and 'err' parameters, we have to support code that passes them,
			// but not additionalParams...
			if ( $.isFunction( additionalParams ) ) {
				err = ok;
				ok = additionalParams;
				additionalParams = undefined;
			}

			if ( ok || err ) {
				mw.track( 'mw.deprecate', 'api.cbParam' );
				mw.log.warn( msg );
			}

			return this.postWithEditToken( $.extend( {
				action: 'edit',
				section: 'new',
				format: 'json',
				title: String( title ),
				summary: header,
				text: message
			}, additionalParams ) ).done( ok ).fail( err );
		}
	} );

	/**
	 * @class mw.Api
	 * @mixins mw.Api.plugin.edit
	 */

}( mediaWiki, jQuery ) );