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, request, 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                         '#firstHeading',
  45                         '#wikiPreview',
  46                         '#wikiDiff',
  47                         '#catlinks',
  48                         '#p-lang',
  49                         // Editing-related
  50                         '.templatesUsed',
  51                         '.limitreport',
  52                         '.mw-summary-preview'
  53                 ];
  54                 $copyElements = $( copySelectors.join( ',' ) );
  55
  56                 // Not shown during normal preview, to be removed if present
  57                 $( '.mw-newarticletext' ).remove();
  58
  59                 if ( $spinner.length === 0 ) {
  60                         $spinner = $.createSpinner( {
  61                                 size: 'large',
  62                                 type: 'block'
  63                         } )
  64                                 .addClass( 'mw-spinner-preview' )
  65                                 .css( 'margin-top', '1em' );
  66                         $wikiPreview.before( $spinner );
  67                 } else {
  68                         $spinner.show();
  69                 }
  70
  71                 // Can't use fadeTo because it calls show(), and we might want to keep some elements hidden
  72                 // (e.g. empty #catlinks)
  73                 $copyElements.animate( { opacity: 0.4 }, 'fast' );
  74
  75                 api = new mw.Api();
  76                 postData = {
  77                         action: 'parse',
  78                         uselang: mw.config.get( 'wgUserLanguage' ),
  79                         title: mw.config.get( 'wgPageName' ),
  80                         text: $textbox.textSelection( 'getContents' ),
  81                         summary: $summary.textSelection( 'getContents' ),
  82                         sectionpreview: section !== ''
  83                 };
  84
  85                 if ( section === 'new' ) {
  86                         postData.section = 'new';
  87                         postData.sectiontitle = postData.summary;
  88                 }
  89
  90                 if ( isDiff ) {
  91                         $wikiPreview.hide();
  92
  93                         // First PST the input, then diff it
  94                         postData.onlypst = true;
  95                         request = api.post( postData );
  96                         request.done( function ( response ) {
  97                                 return api.post( {
  98                                         action: 'query',
  99                                         indexpageids: true,
 100                                         prop: 'revisions',
 101                                         titles: mw.config.get( 'wgPageName' ),
 102                                         rvdifftotext: response.parse.text[ '*' ],
 103                                         rvprop: [],
 104                                         rvsection: section === '' ? undefined : section
 105                                 } ).done( function ( response ) {
 106                                         try {
 107                                                 var diffHtml = response.query.pages[ response.query.pageids[ 0 ] ]
 108                                                         .revisions[ 0 ].diff[ '*' ];
 109                                                 $wikiDiff.find( 'table.diff tbody' ).html( diffHtml );
 110                                         } catch ( e ) {
 111                                                 // "result.blah is undefined" error, ignore
 112                                                 mw.log.warn( e );
 113                                         }
 114                                         $wikiDiff.show();
 115                                 } );
 116                         } );
 117                 } else {
 118                         $wikiDiff.hide();
 119                         $.extend( postData, {
 120                                 pst: true,
 121                                 preview: true,
 122                                 prop: 'text|displaytitle|modules|jsconfigvars|categorieshtml|templates|langlinks|limitreporthtml',
 123                                 disableeditsection: true
 124                         } );
 125                         request = api.post( postData );
 126                         request.done( function ( response ) {
 127                                 var li, newList, $displaytitle, $content, $parent, $list;
 128                                 if ( response.parse.jsconfigvars ) {
 129                                         mw.config.set( response.parse.jsconfigvars );
 130                                 }
 131                                 if ( response.parse.modules ) {
 132                                         mw.loader.load( response.parse.modules.concat(
 133                                                 response.parse.modulescripts,
 134                                                 response.parse.modulestyles
 135                                         ) );
 136                                 }
 137                                 if ( response.parse.displaytitle ) {
 138                                         $displaytitle = $( $.parseHTML( response.parse.displaytitle ) );
 139                                         $( '#firstHeading' ).msg(
 140                                                 mw.config.get( 'wgEditMessage', 'editing' ),
 141                                                 $displaytitle
 142                                         );
 143                                         document.title = mw.msg(
 144                                                 'pagetitle',
 145                                                 mw.msg(
 146                                                         mw.config.get( 'wgEditMessage', 'editing' ),
 147                                                         $displaytitle.text()
 148                                                 )
 149                                         );
 150                                 }
 151                                 if ( response.parse.categorieshtml ) {
 152                                         $( '#catlinks' ).replaceWith( response.parse.categorieshtml[ '*' ] );
 153                                 }
 154                                 if ( response.parse.templates ) {
 155                                         newList = [];
 156                                         $.each( response.parse.templates, function ( i, template ) {
 157                                                 li = $( '<li>' )
 158                                                         .append( $( '<a>' )
 159                                                                 .attr( {
 160                                                                         href: mw.util.getUrl( template[ '*' ] ),
 161                                                                         'class': ( template.exists !== undefined ? '' : 'new' )
 162                                                                 } )
 163                                                                 .text( template[ '*' ] )
 164                                                         );
 165                                                 newList.push( li );
 166                                         } );
 167
 168                                         $editform.find( '.templatesUsed .mw-editfooter-list' ).detach().empty().append( newList ).appendTo( '.templatesUsed' );
 169                                 }
 170                                 if ( response.parse.limitreporthtml ) {
 171                                         $( '.limitreport' ).html( response.parse.limitreporthtml[ '*' ] );
 172                                 }
 173                                 if ( response.parse.langlinks && mw.config.get( 'skin' ) === 'vector' ) {
 174                                         newList = [];
 175                                         $.each( response.parse.langlinks, function ( i, langlink ) {
 176                                                 li = $( '<li>' )
 177                                                         .addClass( 'interlanguage-link interwiki-' + langlink.lang )
 178                                                         .append( $( '<a>' )
 179                                                                 .attr( {
 180                                                                         href: langlink.url,
 181                                                                         title: langlink[ '*' ] + ' - ' + langlink.langname,
 182                                                                         lang: langlink.lang,
 183                                                                         hreflang: langlink.lang
 184                                                                 } )
 185                                                                 .text( langlink.autonym )
 186                                                         );
 187                                                 newList.push( li );
 188                                         } );
 189                                         $list = $( '#p-lang ul' );
 190                                         $parent = $list.parent();
 191                                         $list.detach().empty().append( newList ).prependTo( $parent );
 192                                 }
 193
 194                                 if ( response.parse.text[ '*' ] ) {
 195                                         $content = $wikiPreview.children( '.mw-content-ltr,.mw-content-rtl' );
 196                                         $content
 197                                                 .detach()
 198                                                 .html( response.parse.text[ '*' ] );
 199
 200                                         mw.hook( 'wikipage.content' ).fire( $content );
 201
 202                                         // Reattach
 203                                         $wikiPreview.append( $content );
 204
 205                                         $wikiPreview.show();
 206
 207                                 }
 208                         } );
 209                 }
 210                 request.done( function ( response ) {
 211                         var isSubject = ( section === 'new' ),
 212                                 summaryMsg = isSubject ? 'subject-preview' : 'summary-preview',
 213                                 $summaryPreview = $editform.find( '.mw-summary-preview' ).empty();
 214                         if ( response.parse.parsedsummary && response.parse.parsedsummary[ '*' ] !== '' ) {
 215                                 $summaryPreview.append(
 216                                         mw.message( summaryMsg ).parse(),
 217                                         ' ',
 218                                         $( '<span>' ).addClass( 'comment' ).html(
 219                                                 // There is no equivalent to rawParams
 220                                                 mw.message( 'parentheses' ).escaped()
 221                                                         .replace( '$1', response.parse.parsedsummary[ '*' ] )
 222                                         )
 223                                 );
 224                         }
 225                         mw.hook( 'wikipage.editform' ).fire( $editform );
 226                 } );
 227                 request.always( function () {
 228                         $spinner.hide();
 229                         $copyElements.animate( {
 230                                 opacity: 1
 231                         }, 'fast' );
 232                 } );
 233                 request.fail( function ( code, result ) {
 234                         var errorMsg = 'API error: ' +  code;
 235                         if ( code === 'http' ) {
 236                                 errorMsg = 'HTTP error: ';
 237                                 if ( result.exception ) {
 238                                         errorMsg += result.exception;
 239                                 } else {
 240                                         errorMsg += result.textStatus;
 241                                 }
 242                         }
 243                         $errorBox = $( '<div>' )
 244                                 .addClass( 'errorbox' )
 245                                 .html( '<strong>' + mw.message( 'previewerrortext' ).escaped() + '</strong><br>' )
 246                                 .append( document.createTextNode( errorMsg ) );
 247                         $wikiDiff.hide();
 248                         $wikiPreview.hide().before( $errorBox );
 249                 } );
 250         }
 251
 252         $( function () {
 253                 // Do not enable on user .js/.css pages, as there's no sane way of "previewing"
 254                 // the scripts or styles without reloading the page.
 255                 if ( $( '#mw-userjsyoucanpreview' ).length || $( '#mw-usercssyoucanpreview' ).length ) {
 256                         return;
 257                 }
 258
 259                 // The following elements can change in a preview but are not output
 260                 // by the server when they're empty until the preview response.
 261                 // TODO: Make the server output these always (in a hidden state), so we don't
 262                 // have to fish and (hopefully) put them in the right place (since skins
 263                 // can change where they are output).
 264
 265                 if ( !document.getElementById( 'p-lang' ) && document.getElementById( 'p-tb' ) && mw.config.get( 'skin' ) === 'vector' ) {
 266                         $( '.portal:last' ).after(
 267                                 $( '<div>' ).attr( {
 268                                         'class': 'portal',
 269                                         id: 'p-lang',
 270                                         role: 'navigation',
 271                                         title: mw.msg( 'tooltip-p-lang' ),
 272                                         'aria-labelledby': 'p-lang-label'
 273                                 } )
 274                                 .append( $( '<h3>' ).attr( 'id', 'p-lang-label' ).text( mw.msg( 'otherlanguages' ) ) )
 275                                 .append( $( '<div>' ).addClass( 'body' ).append( '<ul>' ) )
 276                         );
 277                 }
 278
 279                 if ( !$( '.mw-summary-preview' ).length ) {
 280                         $( '#wpSummary' ).after(
 281                                 $( '<div>' ).addClass( 'mw-summary-preview' )
 282                         );
 283                 }
 284
 285                 if ( !document.getElementById( 'wikiDiff' ) && document.getElementById( 'wikiPreview' ) ) {
 286                         $( '#wikiPreview' ).after(
 287                                 $( '<div>' )
 288                                         .hide()
 289                                         .attr( 'id', 'wikiDiff' )
 290                                         .html( '<table class="diff"><col class="diff-marker"/><col class="diff-content"/>' +
 291                                                 '<col class="diff-marker"/><col class="diff-content"/><tbody/></table>' )
 292                         );
 293                 }
 294
 295                 // This should be moved down to '#editform', but is kept on the body for now
 296                 // because the LiquidThreads extension is re-using this module with only half
 297                 // the EditPage (doesn't include #editform presumably, bug 55463).
 298                 $( document.body ).on( 'click', '#wpPreview, #wpDiff', doLivePreview );
 299         } );
 300
 301 }( mediaWiki, jQuery ) );