MediaWiki:Gadget-wikibugs-core.js

/**
 * @author: [[:pl:User:Dodek]] (idea and text)
 * @author: [[:pl:User:Adziura]] (idea and text)
 * @author: [[:pl:User:Nux]] (implementation)
 * @author: [[:pl:User:Saper]] (implementation)
 * @author: [[:pl:User:Beau]] (implementation)
 * @author: [[:pt:User:Helder.wiki]] (implementation)
 * @author: [[:pl:User:Peter Bowman]] (rework)
 */

var config = mw.config.get( [
		'wgNamespaceIds',
		'wgNamespaceNumber',
		'wgPageName',
		'wgRestrictionEdit',
		'wgUserGroups',
		'wgUserLanguage'
	] ),
	/**
	 * A name of a page where reports are saved.
	 */
	reportPage = 'Wikipedia:Zgłoś błąd w artykule',
	/**
	 * Black list of pages which reports should not refer to.
	 */
	badPages = [
			reportPage,
			'Wikipedia:Sprzątanie Wikipedii',
			'Wikipedia:Zgłoszone grafiki',
			'Wikipedia:Kontakt z wikipedystami',
			'Dyskusja Wikipedii:Kontakt z wikipedystami',
			'Wikipedia:Prośby o przejrzenie edycji'
		],
	windowManager = null,
	api = null;

function configureMessages() {
	mw.messages.set( {
		'wikibugs-dialog-title': 'Zgłoś błąd',
		'wikibugs-open-form-button': 'Przejdź do formularza',
		'wikibugs-edit-page-button': 'Popraw samodzielnie',
		'wikibugs-submit-report-button': 'Wyślij',
		'wikibugs-ip-address-notice': '<p><strong>Uwaga:</strong> Twój adres IP zostanie zapisany w historii zgłoszeń.</p>',
		'wikibugs-page-name-label': 'Nazwa strony:',
		'wikibugs-report-content-label': 'Treść zgłoszenia:',
		'wikibugs-report-content-placeholder': 'Opisz błąd możliwie jak najdokładniej. Jeżeli masz taką możliwość, podaj źródło informacji.',
		'wikibugs-signature-label': 'Podpis:',
		'wikibugs-incomplete-information': 'Opisz dokładnie zgłaszany błąd. Wprowadzony opis jest za krótki.',
		'wikibugs-invalid-page': 'Podaj nazwę strony.',
		'wikibugs-file-section-line': '<!-- Zgłoszenia błędów w plikach wstawiaj poniżej tej linii. Nowe na górze. -->',
		'wikibugs-page-section-line': '<!-- Zgłoszenia błędów w artykułach wstawiaj poniżej tej linii. Nowe na górze. -->',
		'wikibugs-bad-reports-text': '<div id="wb-bad-reports"><p>Formularz <strong>nie służy</strong> do zgłaszania próśb o rozwinięcie ' +
			'bądź stworzenie nowych artykułów. Zobacz stronę:</p><ul>' +
			'<li><a href="' + mw.util.getUrl( 'Wikipedia:Propozycje tematów' ) + '">' +
			'Propozycje tematów</a></li></ul><p>Wikipedia nie udziela jakichkolwiek porad na ' +
			'życzenie. Jeżeli masz jakąś prośbę o poradę, <b>nie zgłaszaj jej tutaj</b>.</p>' +
			'<p>Informacje, jak skontaktować się z Wikipedią, można znaleźć na stronie:</p>' +
			'<ul><li><a href="' + mw.util.getUrl( 'Wikipedia:Kontakt' ) + '">Kontakt</a></li></ul></div>',
		'wikibugs-article-intro': '<p>Możesz zgłaszać znalezione błędy w ' +
			'artykułach w Wikipedii, jednak pamiętaj, że Wikipedia to ' +
			'<a href="' + mw.util.getUrl( 'Wiki' ) + '">wiki</a> i można, ' +
			'a nawet należy <a href="' + mw.util.getUrl( 'Wikipedia:Śmiało modyfikuj strony' ) + '">' +
			'śmiało poprawiać znalezione błędy samemu</a>. ' +
			'Zdajemy sobie jednak sprawę z faktu, że niektórzy czytelnicy Wikipedii mogą z różnych ' +
			'przyczyn nie chcieć samodzielnie poprawiać artykułów. ' +
			'Jeśli to możliwe, dodaj do zgłoszenia informację o źródle, na podstawie którego ' +
			'stwierdzasz istnienie błędu.</p><p><strong>Jeżeli potrafisz poprawić ' +
			'błąd – nie zgłaszaj go tutaj.</strong></p>' +
			'<p><strong>Preferowany format zgłoszenia prostych błędów:</strong></p><ul>' +
			'<li>Jest: [podaj fragment zawierający błąd]</li>' +
			'<li>Powinno być: [podaj poprawną wersję (o ile jest znana)]</li>' +
			'<li>Uzasadnienie: [uzasadnij konieczność poprawy, nawet jeśli wydaje Ci się to oczywiste; <a href="' +
			mw.util.getUrl( 'Wikipedia:Weryfikowalność' ) + '">podaj źródła</a>]</li></ul></p>',
		'wikibugs-image-intro': '<p>Tu możesz zgłaszać grafiki, które łamią licencję, ' +
			'mają swoje lepsze odpowiedniki w Commons, są błędnie opisane itp.</p>' +
			'<p><strong>Jeżeli potrafisz poprawić błąd – nie zgłaszaj go tutaj.</strong></p>',
		'wikibugs-copyright': '<p>Wysyłając zgłoszenie, wyrażasz nieodwołalną zgodę na udostępnianie Twojego wkładu ' +
			'na licencjach CC-BY-SA 3.0 i GFDL oraz na wykorzystanie go w dowolnej formie ' +
			'pod warunkiem podania przynajmniej hiperłącza lub adresu URL do strony, ' +
			'na której powstała treść. Treść ta musi być dostępna na tych zasadach, ' +
			'jeśli nie jest wynikiem Twojej samodzielnej pracy.</p>',
		'wikibugs-already-reported-notice': '<p><strong>Uwaga:</strong> Jeśli zamieściłeś/-aś raport o błędzie, ' +
			'a teraz go już nie ma, to najprawdopodobniej został on naprawiony. <ul>' +
			'<li><a href="' + mw.util.getUrl( reportPage ) + '">' +
			'Zobacz listę aktualnie zgłoszonych błędów</a> oraz</li>' +
			'<li><a href="' + mw.util.getUrl( reportPage, { action: 'history' } ) + '">' +
			'historię zmian wprowadzanych na tej stronie.</a></li></ul>' + 
			'<br>' +
			'<p><strong>Zgłoszenie będzie publicznie dostępne – prosimy nie podawać swoich danych teleadresowych!</strong></p>',
		'wikibugs-new-report': 'Nowe zgłoszenie: /* $1 */'
	} );
}

function buildWindowManager() {
	var wikibugsDialog, windowManager,
		canEdit = true,
		currentTitle = mw.Title.newFromText( config.wgPageName ),
		isBadPage = badPages.indexOf( currentTitle.toText() ) !== -1;
	
	if ( ( config.wgRestrictionEdit || [] ).length ) {
		canEdit = config.wgRestrictionEdit.some( function ( group ) {
			return config.wgUserGroups.indexOf( group ) !== -1;
		} );
	}
	
	function WikibugsDialog( config ) {
		WikibugsDialog.super.call( this, config );
	}
	
	OO.inheritClass( WikibugsDialog, OO.ui.ProcessDialog );
	
	WikibugsDialog.static.name = 'wikibugs';
	WikibugsDialog.static.title = mw.msg( 'wikibugs-dialog-title' );
	
	WikibugsDialog.static.actions = [
		{
			action: 'continue',
			modes: 'info',
			label: mw.msg( 'wikibugs-open-form-button' ),
			flags: [ 'primary', 'progressive' ]
		},
		{
			modes: 'info',
			flags: [ 'safe', 'close' ]
		},
		{
			action: 'submit',
			modes: 'report',
			label: mw.msg( 'wikibugs-submit-report-button' ),
			flags: [ 'primary', 'progressive' ]
		},
		{
			action: 'submit-captcha',
			modes: 'captcha',
			label: mw.msg( 'wikibugs-submit-report-button' ),
			flags: [ 'primary', 'progressive' ]
		},
		{
			action: 'back-to-info',
			modes: 'report',
			flags: [ 'safe', 'back' ]
		},
		{
			action: 'back-to-report',
			modes: 'captcha',
			flags: [ 'safe', 'back' ]
		}
	];
	
	if ( canEdit ) {
		WikibugsDialog.static.actions.push( {
			action: 'edit',
			modes: 'info',
			label: mw.msg( 'wikibugs-edit-page-button' ),
			icon: 'edit'
		} );
	}
	
	WikibugsDialog.prototype.initialize = function () {
		WikibugsDialog.super.prototype.initialize.apply( this, arguments );
		
		this.infoPanel = new OO.ui.PanelLayout( {
			padded: true,
			expanded: false,
			content: [
				new OO.ui.HtmlSnippet( mw.msg( 'wikibugs-bad-reports-text' ) ),
				new OO.ui.HtmlSnippet( mw.msg( config.wgNamespaceNumber !== config.wgNamespaceIds.file
						? 'wikibugs-article-intro'
						: 'wikibugs-image-intro'
					) ),
				new OO.ui.HtmlSnippet( mw.msg( 'wikibugs-already-reported-notice' ) )
			]
		} );
		
		this.titleInput = new mw.widgets.TitleInputWidget( {
			required: true,
			showMissing: false,
			data: { actions: this.getActions() },
			value: !isBadPage ? currentTitle.toText() : '',
			disabled: !isBadPage
		} );
		
		this.titleInput.setValidation( function () {
			var title = mw.Title.newFromText( this.getValue().replace( /[\[\]]/g, '' ) );
			
			if ( title && title.toString() !== '' && badPages.indexOf( title.toString() ) === -1 ) {
				this.getData().actions.get( { actions: 'submit' } )[ 0 ].setDisabled( false );
				return true;
			}
			
			return false;
		} );
		
		this.titleField = new OO.ui.FieldLayout( this.titleInput, {
			label: mw.msg( 'wikibugs-page-name-label' ),
			align: 'top'
		} );
		
		this.summaryInput = new OO.ui.MultilineTextInputWidget( {
			autocomplete: false,
			autofocus: true,
			data: { actions: this.getActions() },
			placeholder: mw.msg( 'wikibugs-report-content-placeholder' ),
			required: true,
			rows: 6
		} );
		
		this.summaryInput.setValidation( function () {
			if ( this.getValue().trim().length >= 20 ) {
				this.getData().actions.get( { actions: 'submit' } )[ 0 ].setDisabled( false );
				return true;
			}
			
			return false;
		} );
		
		this.summaryField = new OO.ui.FieldLayout( this.summaryInput, {
			label: mw.msg( 'wikibugs-report-content-label' ),
			align: 'top'
		} );
		
		this.reportFieldset = new OO.ui.FieldsetLayout( {
			items: [ this.titleField, this.summaryField ]
		} );
		
		this.reportPanel = new OO.ui.PanelLayout( {
			padded: true,
			expanded: false,
			content: [ this.reportFieldset ]
		} );
		
		if ( mw.user.isAnon() ) {
			this.reportAnonNotice = new OO.ui.HtmlSnippet( mw.msg( 'wikibugs-ip-address-notice' ) );
			this.reportPanel.$element.append( this.reportAnonNotice.toString() );
		}
		
		this.copyrightNotice = new OO.ui.HtmlSnippet( mw.msg( 'wikibugs-copyright' ) );
		this.reportPanel.$element.append( this.copyrightNotice.toString() );
		
		this.captchaPanel = new OO.ui.PanelLayout( {
			padded: true,
			expanded: false
		} );
		
		this.stackLayout = new OO.ui.StackLayout( {
			items: [ this.infoPanel, this.reportPanel, this.captchaPanel ]
		} );
		
		this.$body.append( this.stackLayout.$element );
	};
	
	WikibugsDialog.prototype.getSetupProcess = function ( data ) {
		return WikibugsDialog.super.prototype.getSetupProcess.call( this, data ).next( function () {
			this.stackLayout.setItem( this.infoPanel );
			this.getActions().setMode( 'info' );
		}, this );
	};
	
	WikibugsDialog.prototype.getActionProcess = function ( action ) {
		if ( action === 'continue' ) {
			this.stackLayout.setItem( this.reportPanel );
			this.getActions().setMode( 'report' );
			this.titleInput.getValue().trim() === '' ? this.titleInput.focus() : this.summaryInput.focus();
		} else if ( action === 'back-to-info' ) {
			this.stackLayout.setItem( this.infoPanel );
			this.getActions().setMode( 'info' );
		} else if ( action === 'back-to-report' ) {
			delete this.editParams;
			this.stackLayout.setItem( this.reportPanel );
			this.getActions().setMode( 'report' );
		} else if ( action === 'edit' ) {
			return new OO.ui.Process( function () {
				this.close();
				window.location = mw.util.getUrl( null, { action: 'edit' } );
			}, this );
		} else if ( action === 'submit' ) {
			return new OO.ui.Process( function () {
				return this.titleInput.getValidity().catch( function () {
					return $.Deferred().reject( new OO.ui.Error( mw.msg( 'wikibugs-invalid-page' ), {
						recoverable: false
					} ) ).promise();
				} );
			}, this ).next( function () {
				return this.summaryInput.getValidity().catch( function () {
					return $.Deferred().reject( new OO.ui.Error( mw.msg( 'wikibugs-incomplete-information' ), {
						recoverable: false
					} ) ).promise();
				} );
			}, this ).next( function () {
				var dialog = this,
					reportedPage = this.titleInput.getValue().trim(),
					reportContent = this.summaryInput.getValue().trim() + ' ~~' + '~~',
					reportSection = mw.format( '=== [[:$1' + ']] ===\n{{Status zgłoszenia|nowe}' + '}\n\n$2', reportedPage, reportContent ),
					isFile = mw.Title.newFromText( reportedPage ).getNamespaceId() === config.wgNamespaceIds.file,
					sectionMarker = mw.msg( !isFile ? 'wikibugs-page-section-line' : 'wikibugs-file-section-line' );
				
				this.editParams = this.editParams || {
					summary: mw.msg( 'wikibugs-new-report', reportedPage )
				};
				
				return api.edit( reportPage, function ( revision ) {
					return $.extend( {
						text: revision.content.indexOf( sectionMarker ) !== -1
							? revision.content.replace( sectionMarker, sectionMarker + '\n\n' + reportSection )
							: revision.content + '\n\n' + reportSection // simply append
					}, dialog.editParams );
				} ).then( function ( res ) {
					var deferred = $.Deferred();
					
					if ( res.result === 'Failure' && 'captcha' in res ) {
						dialog.captchaWidget = new mw.libs.confirmEdit.CaptchaInputWidget( res.captcha );
						dialog.captchaPanel.$element.html( dialog.captchaWidget.$element );
						
						dialog.captchaWidget.on( 'load', function () {
							dialog.stackLayout.setItem( dialog.captchaPanel );
							dialog.getActions().setMode( 'captcha' );
							deferred.resolve();
						} );
					} else {
						location.href = mw.util.getUrl( reportPage ) + '#' + mw.util.escapeIdForLink( reportedPage );

						if ( currentTitle.toText() === reportPage ) {
							location.reload();
						} else {
							deferred.resolve();
						}
					}
					
					return deferred.promise();
				}, function ( code, data ) {
					var error = new OO.ui.Error( api.getErrorMessage( data ) );
					return $.Deferred().reject( error ).promise();
				} );
			}, this );
		} else if ( action === 'submit-captcha' ) {
			$.extend( this.editParams, {
				captchaid: this.captchaWidget.getCaptchaId(),
				captchaword: this.captchaWidget.getCaptchaWord()
			} );
			
			return new OO.ui.Process( function () {
				return this.executeAction( 'submit' );
			}, this );
		}
		
		return WikibugsDialog.super.prototype.getActionProcess.call( this, action );
	};
	
	wikibugsDialog = new WikibugsDialog( {
		size: 'large'
	} );
	
	windowManager = new OO.ui.WindowManager();
	windowManager.addWindows( { wikibugs: wikibugsDialog } );
	
	$( document.body ).append( windowManager.$element );
	return windowManager;
}

function lazyOpen() {
	mw.loader.using( [
		'oojs-ui-core',
		'oojs-ui-widgets',
		'oojs-ui-windows',
		'oojs-ui.styles.icons-editing-core',
		'mediawiki.api',
		'mediawiki.Title',
		'mediawiki.user',
		'mediawiki.util',
		'mediawiki.widgets',
		'ext.confirmEdit.CaptchaInputWidget'
	] ).done( function () {
		if ( windowManager === null ) {
			mw.util.addCSS( '#wb-bad-reports { float: right; width: 200px; padding: 4px 10px 18px; margin: 2px 0px 0px 10px; font-size: 95%; border: 2px solid #900; }' );
			
			configureMessages();
			
			api = new mw.Api( { parameters: {
				errorformat: 'html',
				errorlang: config.wgUserLanguage,
				errorsuselocal: true
			} } );
			
			windowManager = buildWindowManager();
		}
		
		windowManager.openWindow( 'wikibugs' );
	} );
}

$( function () {
	$( '#n-bug_in_article, #n-bad-image' ).find( 'a' )
		.attr( 'href', '#' )
		.on( 'click', function ( evt ) {
			lazyOpen();
			evt.preventDefault();
		} );

	// Link on the report-an-error page itself
	$( '#report-bug-link a' ).on( 'click', function ( evt ) {
		lazyOpen();
		evt.preventDefault();
	} );
} );