resources/src/mediawiki.action/mediawiki.action.edit.preview.js

   1 /*!
   2  * Live edit preview.
   3  */
   4 ( function ( mw, $ ) {
   5
   6         /**
   7          * @ignore
   8          * @param {jQuery.Event} e
   9          */
  10         function doLivePreview( e ) {
  11                 var isDiff, api, parseRequest, diffRequest, postData, copySelectors, section,
  12                         $wikiPreview, $wikiDiff, $editform, $textbox, $summary, $copyElements, $spinner, $errorBox;
  13
  14                 isDiff = ( e.target.name === 'wpDiff' );
  15                 $wikiPreview = $( '#wikiPreview' );
  16                 $wikiDiff = $( '#wikiDiff' );
  17                 $editform = $( '#editform' );
  18                 $textbox = $editform.find( '#wpTextbox1' );
  19                 $summary = $editform.find( '#wpSummary' );
  20                 $spinner = $( '.mw-spinner-preview' );
  21                 $errorBox = $( '.errorbox' );
  22                 section = $editform.find( '[name="wpSection"]' ).val();
  23
  24                 if ( $textbox.length === 0 ) {
  25                         return;
  26                 }
  27                 // Show changes for a new section is not yet supported
  28                 if ( isDiff && section === 'new' ) {
  29                         return;
  30                 }
  31                 e.preventDefault();
  32
  33                 // Remove any previously displayed errors
  34                 $errorBox.remove();
  35                 // Show #wikiPreview if it's hidden to be able to scroll to it
  36                 // (if it is hidden, it's also empty, so nothing changes in the rendering)
  37                 $wikiPreview.show();
  38
  39                 // Jump to where the preview will appear
  40                 $wikiPreview[ 0 ].scrollIntoView();
  41
  42                 copySelectors = [
  43                         // Main
  44                         '.mw-indicators',
  45                         '#firstHeading',
  46                         '#wikiPreview',
  47                         '#wikiDiff',
  48                         '#catlinks',
  49                         '#p-lang',
  50                         // Editing-related
  51                         '.templatesUsed',
  52                         '.limitreport',
  53                         '.mw-summary-preview'
  54                 ];
  55                 $copyElements = $( copySelectors.join( ',' ) );
  56
  57                 // Not shown during normal preview, to be removed if present
  58                 $( '.mw-newarticletext' ).remove();
  59
  60                 if ( $spinner.length === 0 ) {
  61                         $spinner = $.createSpinner( {
  62                                 size: 'large',
  63                                 type: 'block'
  64                         } )
  65                                 .addClass( 'mw-spinner-preview' )
  66                                 .css( 'margin-top', '1em' );
  67                         $wikiPreview.before( $spinner );
  68                 } else {
  69                         $spinner.show();
  70                 }
  71
  72                 // Can't use fadeTo because it calls show(), and we might want to keep some elements hidden
  73                 // (e.g. empty #catlinks)
  74                 $copyElements.animate( { opacity: 0.4 }, 'fast' );
  75
  76                 api = new mw.Api();
  77                 postData = {
  78                         formatversion: 2,
  79                         action: 'parse',
  80                         title: mw.config.get( 'wgPageName' ),
  81                         summary: $summary.textSelection( 'getContents' ),
  82                         prop: ''
  83                 };
  84
  85                 if ( isDiff ) {
  86                         $wikiPreview.hide();
  87
  88                         if ( postData.summary ) {
  89                                 parseRequest = api.post( postData );
  90                         }
  91
  92                         diffRequest = api.post( {
  93                                 formatversion: 2,
  94                                 action: 'query',
  95                                 prop: 'revisions',
  96                                 titles: mw.config.get( 'wgPageName' ),
  97                                 rvdifftotext: $textbox.textSelection( 'getContents' ),
  98                                 rvdifftotextpst: true,
  99                                 rvprop: '',
 100                                 rvsection: section === '' ? undefined : section
 101                         } );
 102
 103                         // Wait for the summary before showing the diff so the page doesn't jump twice
 104                         $.when( diffRequest, parseRequest ).done( function ( response ) {
 105                                 var diffHtml;
 106                                 try {
 107                                         diffHtml = response[ 0 ].query.pages[ 0 ]
 108                                                 .revisions[ 0 ].diff.body;
 109                                         $wikiDiff.find( 'table.diff tbody' ).html( diffHtml );
 110                                         mw.hook( 'wikipage.diff' ).fire( $wikiDiff.find( 'table.diff' ) );
 111                                 } catch ( err ) {
 112                                         // "result.blah is undefined" error, ignore
 113                                         mw.log.warn( err );
 114                                 }
 115                                 $wikiDiff.show();
 116                         } );
 117                 } else {
 118                         $wikiDiff.hide();
 119
 120                         $.extend( postData, {
 121                                 prop: 'text|indicators|displaytitle|modules|jsconfigvars|categorieshtml|templates|langlinks|limitreporthtml',
 122                                 text: $textbox.textSelection( 'getContents' ),
 123                                 pst: true,
 124                                 preview: true,
 125                                 sectionpreview: section !== '',
 126                                 disableeditsection: true,
 127                                 uselang: mw.config.get( 'wgUserLanguage' )
 128                         } );
 129                         if ( section === 'new' ) {
 130                                 postData.section = 'new';
 131                                 postData.sectiontitle = postData.summary;
 132                         }
 133
 134                         parseRequest = api.post( postData );
 135                         parseRequest.done( function ( response ) {
 136                                 var li, newList, $displaytitle, $content, $parent, $list;
 137                                 if ( response.parse.jsconfigvars ) {
 138                                         mw.config.set( response.parse.jsconfigvars );
 139                                 }
 140                                 if ( response.parse.modules ) {
 141                                         mw.loader.load( response.parse.modules.concat(
 142                                                 response.parse.modulescripts,
 143                                                 response.parse.modulestyles
 144                                         ) );
 145                                 }
 146
 147                                 newList = [];
 148                                 $.each( response.parse.indicators, function ( name, indicator ) {
 149                                         newList.push(
 150                                                 $( '<div>' )
 151                                                         .addClass( 'mw-indicator' )
 152                                                         .attr( 'id', mw.util.escapeId( 'mw-indicator-' + name ) )
 153                                                         .html( indicator )
 154                                                         .get( 0 ),
 155                                                 // Add a whitespace between the <div>s because
 156                                                 // they get displayed with display: inline-block
 157                                                 document.createTextNode( '\n' )
 158                                         );
 159                                 } );
 160                                 $( '.mw-indicators' ).empty().append( newList );
 161
 162                                 if ( response.parse.displaytitle ) {
 163                                         $displaytitle = $( $.parseHTML( response.parse.displaytitle ) );
 164                                         $( '#firstHeading' ).msg(
 165                                                 mw.config.get( 'wgEditMessage', 'editing' ),
 166                                                 $displaytitle
 167                                         );
 168                                         document.title = mw.msg(
 169                                                 'pagetitle',
 170                                                 mw.msg(
 171                                                         mw.config.get( 'wgEditMessage', 'editing' ),
 172                                                         $displaytitle.text()
 173                                                 )
 174                                         );
 175                                 }
 176                                 if ( response.parse.categorieshtml ) {
 177                                         $content = $( $.parseHTML( response.parse.categorieshtml ) );
 178                                         mw.hook( 'wikipage.categories' ).fire( $content );
 179                                         $( '.catlinks[data-mw="interface"]' ).replaceWith( $content );
 180                                 }
 181                                 if ( response.parse.templates ) {
 182                                         newList = [];
 183                                         $.each( response.parse.templates, function ( i, template ) {
 184                                                 li = $( '<li>' )
 185                                                         .append( $( '<a>' )
 186                                                                 .attr( {
 187                                                                         href: mw.util.getUrl( template.title ),
 188                                                                         'class': ( template.exists ? '' : 'new' )
 189                                                                 } )
 190                                                                 .text( template.title )
 191                                                         );
 192                                                 newList.push( li );
 193                                         } );
 194
 195                                         $editform.find( '.templatesUsed .mw-editfooter-list' ).detach().empty().append( newList ).appendTo( '.templatesUsed' );
 196                                 }
 197                                 if ( response.parse.limitreporthtml ) {
 198                                         $( '.limitreport' ).html( response.parse.limitreporthtml );
 199                                 }
 200                                 if ( response.parse.langlinks && mw.config.get( 'skin' ) === 'vector' ) {
 201                                         newList = [];
 202                                         $.each( response.parse.langlinks, function ( i, langlink ) {
 203                                                 li = $( '<li>' )
 204                                                         .addClass( 'interlanguage-link interwiki-' + langlink.lang )
 205                                                         .append( $( '<a>' )
 206                                                                 .attr( {
 207                                                                         href: langlink.url,
 208                                                                         title: langlink.title + ' - ' + langlink.langname,
 209                                                                         lang: langlink.lang,
 210                                                                         hreflang: langlink.lang
 211                                                                 } )
 212                                                                 .text( langlink.autonym )
 213                                                         );
 214                                                 newList.push( li );
 215                                         } );
 216                                         $list = $( '#p-lang ul' );
 217                                         $parent = $list.parent();
 218                                         $list.detach().empty().append( newList ).prependTo( $parent );
 219                                 }
 220
 221                                 if ( response.parse.text ) {
 222                                         $content = $wikiPreview.children( '.mw-content-ltr,.mw-content-rtl' );
 223                                         $content
 224                                                 .detach()
 225                                                 .html( response.parse.text );
 226
 227                                         mw.hook( 'wikipage.content' ).fire( $content );
 228
 229                                         // Reattach
 230                                         $wikiPreview.append( $content );
 231
 232                                         $wikiPreview.show();
 233                                 }
 234                         } );
 235                 }
 236                 $.when( parseRequest, diffRequest ).done( function ( parseResp ) {
 237                         var parse = parseResp && parseResp[ 0 ].parse,
 238                                 isSubject = ( section === 'new' ),
 239                                 summaryMsg = isSubject ? 'subject-preview' : 'summary-preview',
 240                                 $summaryPreview = $editform.find( '.mw-summary-preview' ).empty();
 241                         if ( parse && parse.parsedsummary ) {
 242                                 $summaryPreview.append(
 243                                         mw.message( summaryMsg ).parse(),
 244                                         ' ',
 245                                         $( '<span>' ).addClass( 'comment' ).html(
 246                                                 // There is no equivalent to rawParams
 247                                                 mw.message( 'parentheses' ).escaped()
 248                                                         // .replace() use $ as start of a pattern.
 249                                                         // $$ is the pattern for '$'.
 250                                                         // The inner .replace() duplicates any $ and
 251                                                         // the outer .replace() simplifies the $$.
 252                                                         .replace( '$1', parse.parsedsummary.replace( /\$/g, '$$$$' ) )
 253                                         )
 254                                 );
 255                         }
 256                         mw.hook( 'wikipage.editform' ).fire( $editform );
 257                 } ).always( function () {
 258                         $spinner.hide();
 259                         $copyElements.animate( {
 260                                 opacity: 1
 261                         }, 'fast' );
 262                 } ).fail( function ( code, result ) {
 263                         // This just shows the error for whatever request failed first
 264                         var errorMsg = 'API error: ' + code;
 265                         if ( code === 'http' ) {
 266                                 errorMsg = 'HTTP error: ';
 267                                 if ( result.exception ) {
 268                                         errorMsg += result.exception;
 269                                 } else {
 270                                         errorMsg += result.textStatus;
 271                                 }
 272                         }
 273                         $errorBox = $( '<div>' )
 274                                 .addClass( 'errorbox' )
 275                                 .html( '<strong>' + mw.message( 'previewerrortext' ).escaped() + '</strong><br>' )
 276                                 .append( document.createTextNode( errorMsg ) );
 277                         $wikiDiff.hide();
 278                         $wikiPreview.hide().before( $errorBox );
 279                 } );
 280         }
 281
 282         $( function () {
 283                 // Do not enable on user .js/.css pages, as there's no sane way of "previewing"
 284                 // the scripts or styles without reloading the page.
 285                 if ( $( '#mw-userjsyoucanpreview' ).length || $( '#mw-usercssyoucanpreview' ).length ) {
 286                         return;
 287                 }
 288
 289                 // The following elements can change in a preview but are not output
 290                 // by the server when they're empty until the preview response.
 291                 // TODO: Make the server output these always (in a hidden state), so we don't
 292                 // have to fish and (hopefully) put them in the right place (since skins
 293                 // can change where they are output).
 294
 295                 if ( !document.getElementById( 'p-lang' ) && document.getElementById( 'p-tb' ) && mw.config.get( 'skin' ) === 'vector' ) {
 296                         $( '.portal:last' ).after(
 297                                 $( '<div>' ).attr( {
 298                                         'class': 'portal',
 299                                         id: 'p-lang',
 300                                         role: 'navigation',
 301                                         'aria-labelledby': 'p-lang-label'
 302                                 } )
 303                                 .append( $( '<h3>' ).attr( 'id', 'p-lang-label' ).text( mw.msg( 'otherlanguages' ) ) )
 304                                 .append( $( '<div>' ).addClass( 'body' ).append( '<ul>' ) )
 305                         );
 306                 }
 307
 308                 if ( !$( '.mw-summary-preview' ).length ) {
 309                         $( '#wpSummary' ).after(
 310                                 $( '<div>' ).addClass( 'mw-summary-preview' )
 311                         );
 312                 }
 313
 314                 if ( !document.getElementById( 'wikiDiff' ) && document.getElementById( 'wikiPreview' ) ) {
 315                         $( '#wikiPreview' ).after(
 316                                 $( '<div>' )
 317                                         .hide()
 318                                         .attr( 'id', 'wikiDiff' )
 319                                         .html( '<table class="diff"><col class="diff-marker"/><col class="diff-content"/>' +
 320                                                 '<col class="diff-marker"/><col class="diff-content"/><tbody/></table>' )
 321                         );
 322                 }
 323
 324                 // This should be moved down to '#editform', but is kept on the body for now
 325                 // because the LiquidThreads extension is re-using this module with only half
 326                 // the EditPage (doesn't include #editform presumably, T57463).
 327                 $( document.body ).on( 'click', '#wpPreview, #wpDiff', doLivePreview );
 328         } );
 329
 330 }( mediaWiki, jQuery ) );