All files / mobile.editor.overlay EditorGateway.js

92.77% Statements 77/83
84.75% Branches 50/59
93.75% Functions 15/16
92.77% Lines 77/83

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 2911x 1x                               28x 28x 28x 28x   28x 28x 28x     1x                       16x       1x 1x 1x 1x         1x 1x       15x                     19x     18x           19x 3x   16x                 16x       16x 14x   16x     16x 1x     15x   15x     15x 15x 15x       15x 15x   15x                           14x 13x   1x   14x                       1x 1x                                     15x 15x   15x               15x                           15x 14x 1x 1x     15x 12x     15x 13x 6x 6x   7x     2x   15x     15x                   3x                             3x 3x 3x   3x                           3x 3x   3x 3x   3x       1x 1x   1x 1x     3x                           1x  
var util = require( '../mobile.startup/util' ),
	actionParams = require( '../mobile.startup/actionParams' );
 
/**
 * API that helps save and retrieve page content
 *
 * @class EditorGateway
 *
 * @param {Object} options Configuration options
 * @param {mw.Api} options.api an Api to use.
 * @param {string} options.title the title to edit
 * @param {string|null} options.sectionId the id of the section to operate edits on.
 * @param {number} [options.oldId] revision to operate on. If absent defaults to latest.
 * @param {boolean} [options.isNewPage] whether the page being created is new
 * @param {boolean} [options.fromModified] whether the page was loaded in a modified state
 */
function EditorGateway( options ) {
	this.api = options.api;
	this.title = options.title;
	this.sectionId = options.sectionId;
	this.oldId = options.oldId;
	// return an empty section for new pages
	this.content = options.isNewPage ? '' : undefined;
	this.fromModified = options.fromModified;
	this.hasChanged = options.fromModified;
}
 
EditorGateway.prototype = {
 
	/**
	 * Get the block (if there is one) from the result.
	 *
	 * @memberof EditorGateway
	 * @param {Object} pageObj Page object
	 * @return {Object|null}
	 */
	getBlockInfo: function ( pageObj ) {
		var blockedError;
 
		if ( pageObj.actions &&
			pageObj.actions.edit &&
			Array.isArray( pageObj.actions.edit )
		) {
			pageObj.actions.edit.some( function ( error ) {
				Eif ( [ 'blocked', 'autoblocked' ].indexOf( error.code ) !== -1 ) {
					blockedError = error;
					return true;
				}
				return false;
			} );
 
			Eif ( blockedError && blockedError.data && blockedError.data.blockinfo ) {
				return blockedError.data.blockinfo;
			}
		}
 
		return null;
	},
	/**
	 * Get the content of a page.
	 *
	 * @memberof EditorGateway
	 * @instance
	 * @return {jQuery.Promise}
	 */
	getContent: function () {
		var options,
			self = this;
 
		function resolve() {
			return util.Deferred().resolve( {
				text: self.content || '',
				blockinfo: self.blockinfo
			} );
		}
 
		if ( this.content !== undefined ) {
			return resolve();
		} else {
			options = actionParams( {
				prop: [ 'revisions', 'info' ],
				rvprop: [ 'content', 'timestamp' ],
				titles: self.title,
				// get block information for this user
				intestactions: 'edit',
				intestactionsdetail: 'full'
			} );
			// Load text of old revision if desired
			Iif ( this.oldId ) {
				options.rvstartid = this.oldId;
			}
			// See Bug 50136 - passing rvsection will fail with non wikitext
			if ( this.sectionId ) {
				options.rvsection = this.sectionId;
			}
			return this.api.get( options ).then( function ( resp ) {
				var revision, pageObj;
 
				if ( resp.error ) {
					return util.Deferred().reject( resp.error.code );
				}
 
				pageObj = resp.query.pages[0];
				// page might not exist and caller might not have known.
				Iif ( pageObj.missing !== undefined ) {
					self.content = '';
				} else {
					revision = pageObj.revisions[0];
					self.content = revision.content;
					self.timestamp = revision.timestamp;
				}
 
				// save content a second time to be able to check for changes
				self.originalContent = self.content;
				self.blockinfo = self.getBlockInfo( pageObj );
 
				return resolve();
			} );
		}
	},
 
	/**
	 * Mark content as modified and set changes to be submitted when #save
	 * is invoked.
	 *
	 * @memberof EditorGateway
	 * @instance
	 * @param {string} content New section content.
	 */
	setContent: function ( content ) {
		if ( this.originalContent !== content || this.fromModified ) {
			this.hasChanged = true;
		} else {
			this.hasChanged = false;
		}
		this.content = content;
	},
 
	/**
	 * Mark content as modified and set text that should be prepended to given
	 * section when #save is invoked.
	 *
	 * @memberof EditorGateway
	 * @instance
	 * @param {string} text Text to be prepended.
	 */
	setPrependText: function ( text ) {
		this.prependtext = text;
		this.hasChanged = true;
	},
 
	/**
	 * Save the new content of the section, previously set using #setContent.
	 *
	 * @memberof EditorGateway
	 * @instance
	 * @param {Object} options Configuration options
	 * @param {string} [options.summary] Optional summary for the edit.
	 * @param {string} [options.captchaId] If CAPTCHA was requested, ID of the
	 * captcha.
	 * @param {string} [options.captchaWord] If CAPTCHA was requested, term
	 * displayed in the CAPTCHA.
	 * @return {jQuery.Deferred} On failure callback is passed an object with
	 * `type` and `details` properties. `type` is a string describing the type
	 * of error, `details` can be any object (usually error message).
	 */
	save: function ( options ) {
		var self = this,
			result = util.Deferred();
 
		options = options || {};
 
		/**
		 * Save content. Make an API request.
		 *
		 * @return {jQuery.Deferred}
		 */
		function saveContent() {
			var apiOptions = {
				action: 'edit',
				errorformat: 'html',
				errorlang: mw.config.get( 'wgUserLanguage' ),
				errorsuselocal: 1,
				formatversion: 2,
				title: self.title,
				summary: options.summary,
				captchaid: options.captchaId,
				captchaword: options.captchaWord,
				basetimestamp: self.timestamp,
				starttimestamp: self.timestamp
			};
 
			if ( self.content !== undefined ) {
				apiOptions.text = self.content;
			} else Eif ( self.prependtext ) {
				apiOptions.prependtext = self.prependtext;
			}
 
			if ( self.sectionId ) {
				apiOptions.section = self.sectionId;
			}
 
			self.api.postWithToken( 'csrf', apiOptions ).then( function ( data ) {
				if ( data && data.edit && data.edit.result === 'Success' ) {
					self.hasChanged = false;
					result.resolve( data.edit.newrevid );
				} else {
					result.reject( data );
				}
			}, function ( code, data ) {
				result.reject( data );
			} );
			return result;
		}
 
		return saveContent();
	},
 
	/**
	 * Abort any pending previews.
	 *
	 * @memberof EditorGateway
	 * @instance
	 */
	abortPreview: function () {
		Iif ( this._pending ) {
			this._pending.abort();
		}
	},
 
	/**
	 * Get page preview from the API and abort any existing previews.
	 *
	 * @memberof EditorGateway
	 * @instance
	 * @param {Object} options API query parameters
	 * @return {jQuery.Deferred}
	 */
	getPreview: function ( options ) {
		var
			sectionLine = '',
			sectionId = '',
			self = this;
 
		util.extend( options, {
			action: 'parse',
			// Enable section preview mode to avoid errors (bug 49218)
			sectionpreview: true,
			// Hide section edit links
			disableeditsection: true,
			// needed for pre-save transform to work (bug 53692)
			pst: true,
			// Output mobile HTML (bug 54243)
			mobileformat: true,
			title: this.title,
			prop: [ 'text', 'sections' ]
		} );
 
		this.abortPreview();
		this._pending = this.api.post( options );
 
		return this._pending.then( function ( resp ) {
			Eif ( resp && resp.parse && resp.parse.text ) {
				// section 0 haven't a section name so skip
				if ( self.sectionId !== '0' &&
					resp.parse.sections !== undefined &&
					resp.parse.sections[0] !== undefined
				) {
					Eif ( resp.parse.sections[0].anchor !== undefined ) {
						sectionId = resp.parse.sections[0].anchor;
					}
					Eif ( resp.parse.sections[0].line !== undefined ) {
						sectionLine = resp.parse.sections[0].line;
					}
				}
				return {
					text: resp.parse.text['*'],
					id: sectionId,
					line: sectionLine
				};
			} else {
				return util.Deferred().reject();
			}
		} ).promise( {
			abort: function () { self._pending.abort(); }
		} );
	}
};
 
module.exports = EditorGateway;