MediaWiki:Gadget-wikibugs.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)
 */

/* Translatable strings */
mw.messages.set( {
	'wikibugs-dialog-title': 'Zgłoś feler',
	'wikibugs-open-form-button': 'Przyńdź do formularza',
	'wikibugs-edit-page-button': 'Poprow somymu',
	'wikibugs-cancel-button': 'Anuluj',
	'wikibugs-submit-report-button': 'Wyślij',
	'wikibugs-ip-address-notice': '<b>Pozůr:</b> Twojo adresa IP bydźe naszrajbowano we gyszichće zgłoszyńůw.',
	'wikibugs-page-name-label': 'Mjano zajty:<br/><small>(wroz ze "Plik:", eli zgłoszosz feler we pliku)</small>',
	'wikibugs-report-content-label': 'Treść zgłoszyńo:',
	'wikibugs-report-content-placeholder': 'Uopisz feler możebńy jak nojdokładnij. Jak ino mogesz, podej zdrzůdło informacyjůw.',
	'wikibugs-signature-label': 'Szrajbka:',
	'wikibugs-edit-error': '',
	'wikibugs-token-error': '',
	'wikibugs-unknown-token-error': '',
	'wikibugs-ajax-error': 'Zdorzył śe feler przi wysyłańu zgłoszyńo. Prosza sprowjać jeszcze roz.',
	'wikibugs-incomplete-information': 'Uopisz blank dokłodńe feler kery głośisz - uopis kery żeś doł je za krůtki.',
	'wikibugs-invalid-page': 'Podej titel zajty.',
	'wikibugs-reported-by': ' Zgłoszo: $1',
	'wikibugs-file-section-line': '<!-- Zgłoszyńo felerůw we plikach wstowjej niżyj kej ta lińijo. Nowe na wjyrchu. -->',
	'wikibugs-page-section-line': '<!-- Zgłoszyńo felerůw we artiklach wstowjej niżyj kej ta lińijo. Nowe na wjyrchu. -->',
	'wikibugs-bad-reports-text': '<p>Formularz <b>ńy je</b> do zgłoszańo prośbůw uo rozwińyńće ' +
		'abo utworzyńe nowych artikli. Zobejrzij zajta:</p><ul>' +
		'<li><a href="' + mw.util.getUrl( 'Wikipedyjo:Propozycje tymatůw' ) + '">' +
		'Propozycje tymatůw</a></li></ul><p>Wikipedia ńy dowo żodnych poradůw na ' +
		'życzyńe. Eli mosz jako prośba uo porada, <b>ńy dowej ji sam</b>.</p>' +
		'<p>Informacyje, jak skontaktować śe ze Wikipedyjům, mogesz znejść na zajće:</p>' +
		'<ul><li><a href="' + mw.util.getUrl( 'Wikipedyjo:Kůntakt' ) + '">Kůntakt</a></li></ul>',
	'wikibugs-article-intro': '<p style="margin-top:0px;">Mogesz zgłoszać nejdźůne felery we ' +
		'artiklach we Wikipedyji, nale pamjyntej, aże Wikipedyjo to ' +
		'<a href="' + mw.util.getUrl( 'Wiki' ) + '">wiki</a> a można, ' +
		'a tyż trza<a href="' + mw.util.getUrl( 'Wikipedia:Śmiało modyfikuj strony' ) + '">' +
		'spoprawjać nejdźůne felery somymu</a>. Eli mogesz, dodej do zgłoszyńo ' +
		'informacyjo uo zdrzůdle, podug kerygo mogesz pedźeć co sam je feler. Wjymy nale, ' +
		'co ńykere czytelńiki Wikipedy mogą z różnych przyczyn nije skirz roztomajtych powodůw mogům ńy ' +
		'kćeć some poprowjać artiklůw.</p><p><b>Eli ino umjysz sům poprowić ' +
		'feler – ńy głoś uůnygo sam.</b></p>',
	'wikibugs-image-intro': '<p style="margin-top:0px;">Sam mogesz zgłoszać grafiki, kere sům ńy do zgody ze licyncyjům, ' +
		'majům lepśejsze uodpowjedńiki we Commons, sům felerńe Uopisane a tp.</p>' +
		'<p><b>Eli ino umjysz sům poprowić feler - ńy zgłoszej uůnygo sam.</b></p>',
	'wikibugs-already-reported-notice': '<p><b>Pozůr:</b> Eli żeś wćepoł sam report uo felerze, ' +
		'a terozki uůnygo ńy ma, je nojmożebńejsze co ftoś już go poprowił. <ul>' +
		'<li><a href="' + mw.util.getUrl( 'Wikipedyjo:Dej znać uo feleře we artiklu' ) + '">' +
		'Zobejrzij lista aktualńy zgłoszůnych felerůw</a> oraz</li>' +
		'<li><a href="' + mw.util.getUrl( 'Wikipedyjo:Dej znać uo feleře we artiklu' ) + '?action=history">' +
		'gyszichta půmjyńańůw wkludzůnych na ta zajta.</a></li></ul>',
	'wikibugs-footer': '',
	'wikibugs-new-report': 'Nowe zgłoszyńe: $1'
} );

window.wikiBugsGadget = {
	/**
	 * Version number of this gadget.
	 */
	version: 9,
	/**
	 * A name of a page where reports are saved.
	 */
	reportPage: 'Wikipedyjo:Dej znać uo feleře we artiklu',
	/**
	 * Black list of pages which reports should not refer to.
	 */
	badPages: [
		'Wikipedyjo:Dej znać uo feleře we artiklu'
		],
	/**
	 * Define pages where it's not needed or tends to encourage submission of large
	 * volumes of unrelated errors; instead, these load CSS which hides the "Report A Bug" link
	 */
	excludedPages: [],
	/**
	 * Message shown on pages in the main namespace.
	 */
	articleIntro: '<div id="wbBadReports">' +
		mw.msg( 'wikibugs-bad-reports-text' ) + '</div>' +
		mw.msg( 'wikibugs-article-intro' ) +
		mw.msg( 'wikibugs-already-reported-notice' ) +
		mw.msg( 'wikibugs-footer' ),
	/**
	 * Message shown on pages in the file namespace.
	 */
	imageIntro: '<div id="wbBadReports">' +
		mw.msg( 'wikibugs-bad-reports-text' ) + '</div>' +
		mw.msg( 'wikibugs-image-intro' ) +
		mw.msg( 'wikibugs-already-reported-notice' ) +
		mw.msg( 'wikibugs-footer' ),

	/**
	 * Checks if a title of the page is valid for a report.
	 * @param title A title of the page.
	 */
	isValidPageName: function( title ) {
		// Empty title is not valid
		if ( title === '' ) {
			return false;
		}
		// Special pages are not valid too
		if ( this.getPageNamespaceNumber( title ) === -1 ) {
			return false;
		}
		// Check black list
		title = this.getRefinedPageName( title );
		return jQuery.inArray( title, this.badPages ) === -1;
	},

	/**
	 * Returns a namespace number of a specifed page.
	 * @param title A title of the page.
	 */
	getPageNamespaceNumber: function( title ) {
		var matches = title.match( /^([^:]+)/ );
		if ( matches ) {
			var key = matches[1].toLowerCase();
			var namespaces = mw.config.get( 'wgNamespaceIds' );
			var result = namespaces[key];
			if ( result !== null ) {
				return result;
			}
		}
		return 0;
	},

	/**
	 * Returns a refined page title.
	 * @param title A title of the page.
	 */
	getRefinedPageName: function( title ) {
		return jQuery.trim( title.replace( /_/g, ' ' ) );
	},

	/**
	 * Sets up the gadget.
	 */
	init: function() {
		var that = this;
		var excluded = false;

		// Special pages and MediaWiki pages are excluded
		if ( jQuery.inArray( mw.config.get( 'wgNamespaceNumber' ), [-1, 8] ) > -1 ) {
			excluded = true;
		} else {
			var name = this.getRefinedPageName( mw.config.get( 'wgPageName' ) );
			excluded = jQuery.inArray( name, this.excludedPages ) !== -1;
		}

		// FIXME: This doesn't exists on "standard", "cologneblue" (no ids) and "nostalgia" (no sidebar)
		var $articleBugLink = jQuery( '#n-bug-in-article' );
		var $imageBugLink = jQuery( '#n-bad-image' );

		if ( excluded ) {
			// Hide the links
			$articleBugLink.hide();
			$imageBugLink.hide();
			return;
		}

		$articleBugLink.find( 'a' )
			.attr( 'href', '#' )
			.click( function( event ) {
				that.open( that.articleIntro );
				event.preventDefault();
			} );

		$imageBugLink.find( 'a' )
			.attr( 'href', '#' )
			.click( function( event ) {
				that.open( that.imageIntro );
				event.preventDefault();
			} );

		// Link on the report-an-error page itself
		jQuery( '#report-bug-link a' ).click( function( event ) {
			that.open( that.articleIntro );
			event.preventDefault();
		} );
	},

	/**
	 * Redirects to the edit page.
	 */
	goToEditPage: function() {
		var $editLink = jQuery( '#ca-edit' ).find( 'a' );
		window.location = $editLink.attr( 'href' ) || mw.util.getUrl( this.reportPage );
	},

	/**
	 * Shows the dialog window.
	 * @param infoHtml The message content.
	 */
	open: function( infoHtml ) {
		var that = this;

		var can_edit = document.getElementById( 'ca-edit' ) ? true : false;

		var $dialog = jQuery( '<div id="dialogContent"></div>' ).append( infoHtml );

		if ( mw.user.isAnon() ) {
			$dialog.append( '<p>' + mw.msg( 'wikibugs-ip-address-notice' ) + '</p>' );
		}

		var buttons = {};
		buttons[mw.msg( 'wikibugs-cancel-button' )] = function() {
			jQuery( this ).dialog( 'close' );
		};
		buttons[mw.msg( 'wikibugs-open-form-button' )] = function() {
			that.openForm( this );
		};
		if ( can_edit ) {
			buttons[mw.msg( 'wikibugs-edit-page-button' )] = function() {
				that.goToEditPage();
			};
		}

		$dialog.dialog( {
			width: 700,
			height: 500,
			modal: true,
			resizable: false,
			draggable: true,
			closeOnEscape: true,
			dialogClass: 'reportBugDialog',
			title: mw.msg( 'wikibugs-dialog-title' ),
			close: function() {
				jQuery( this ).dialog( 'destroy' ).remove();
			},
			buttons: buttons
		} );
		jQuery( 'div.reportBugDialog button:last' ).focus();
	},
	/**
	 * Shows the form in the dialog window.
	 */
	openForm: function( dialog ) {
		var that = this;

		jQuery( '#dialogContent' ).empty().append(
			'<form name="WikibugForm" enctype="multipart/form-data">' +
			'<fieldset>' +
			'<label for="wbPageTitle">' + mw.msg( 'wikibugs-page-name-label' ) + '</label>' +
			'<input id="wbPageTitle" type="text" name="wbPageTitle" class="text ui-widget-content ui-corner-all" />' +
			'<label for="wbText">' + mw.msg( 'wikibugs-report-content-label' ) + '</label>' +
			'<textarea id="wbText" name="wbText" rows="6" class="text ui-widget-content ui-corner-all">' +
			mw.msg( 'wikibugs-report-content-placeholder' ) + '</textarea>' +
			'<label for="wbAuthor">' + mw.msg( 'wikibugs-signature-label' ) + '</label>' +
			'<input id="wbAuthor" type="text" class="text ui-widget-content ui-corner-all"/>' +
			'</fieldset>' +
			'<img id="wikibugs-loading-icon" src="//upload.wikimedia.org/wikipedia/commons/4/49/Linux_Ubuntu_Loader.gif" style="display:none;"/>' +
			'</form>'
		);

		var buttons = {};
		buttons[mw.msg( 'wikibugs-cancel-button' )] = function() {
			jQuery( this ).dialog( 'close' );
		};
		buttons[mw.msg( 'wikibugs-submit-report-button' )] = function() {
			that.submitForm();
		};

		jQuery( dialog ).dialog( 'option', 'buttons', buttons );

		jQuery( '#wbText' ).focus( function() {
			if ( this.value === mw.msg( 'wikibugs-report-content-placeholder' ) ) {
				this.value = '';
			}
		} );

		if ( this.isValidPageName( mw.config.get( 'wgPageName' ) ) ) {
			jQuery( '#wbPageTitle' ).val( this.getRefinedPageName( mw.config.get( 'wgPageName' ) ) );
		}

		if ( !mw.user.isAnon() ) {
			var author = document.getElementById( 'wbAuthor' );
			author.value = '~~' + '~~';
			author.disabled = 'disabled';
		}
	},

	/**
	 * Indicates wheter submit should be ignored.
	 */
	suppressSubmit: false,

	/**
	 * Sends the contents of the form.
	 */
	submitForm: function() {
		if ( this.suppressSubmit ) {
		    return;
		}

		var form = document.forms.WikibugForm;
		var content = form.wbText.value;

		if ( content === mw.msg( 'wikibugs-report-content-placeholder' ) ||
		    content.length < 20 ||
		    !content.match( ' ' ) ) {
			// Description too short or unchanged
			alert( mw.msg( 'wikibugs-incomplete-information' ) );

			form.wbText.focus();
			return;
		}
		content = jQuery.trim( content );

		// Append a signature to the report
		if ( !mw.user.isAnon() ) {
			content += mw.msg( 'wikibugs-reported-by', '~~' + '~~' );
		} else {
			content += mw.msg( 'wikibugs-reported-by', form.wbAuthor.value + ' ~~' + '~~' );
		}

		var reportedPage = this.getRefinedPageName( form.wbPageTitle.value.replace( /[\[\]]/g, '' ) );
		var isFile = this.getPageNamespaceNumber( reportedPage ) === 6;

		if ( !this.isValidPageName( reportedPage ) ) {
			alert( mw.msg( 'wikibugs-invalid-page' ) );

			var refinedPageName = this.getRefinedPageName( mw.config.get( 'wgPageName' ) );
			if ( this.isValidPageName( refinedPageName ) ) {
				form.wbPageTitle.value = refinedPageName;
			} else {
				form.wbPageTitle.value = '';
				form.wbPageTitle.focus();
			}
			return;
		}

		this.suppressSubmit = true;
		var $loadingIcon = jQuery( '#wikibugs-loading-icon' );
		$loadingIcon.show();

		var toInsert = '=== [[:' + reportedPage + ']] ===\n' + content;

		//initialise the API
		var api = JsMwApi( mw.util.wikiScript( 'api' ) );
		//get the page object
		var pageHandler = api.page( this.reportPage );

		var reportPage = this.reportPage.replace( / /g, '_' );

		//EDIT THE "REPORT AN ERROR" PAGE
		pageHandler.edit( function( text, save_function, res ) {
			//process the wikitext of the page
			var sectionLine;
			if ( isFile ) {
				sectionLine = mw.msg( 'wikibugs-file-section-line' );
			} else {
				sectionLine = mw.msg( 'wikibugs-page-section-line' );
			}

			var newText = text.replace( sectionLine, sectionLine + '\n\n' + toInsert );
			if ( text === newText ) {
				// Could not find the section line - simply append;
				newText = text + '\n\n' + toInsert;
			}

			//save the new content
			save_function(
				newText, {
					summary: mw.msg( 'wikibugs-new-report', reportedPage ),
					minor: false
				}, function( res ) {
					if ( res && res.edit && res.edit.result && res.edit.result === 'Success' ) {
						//saved successfully - go to the report page
						window.location = mw.util.getUrl(reportPage) + '#' + encodeURIComponent(
							encodeURI( reportedPage ).replace( /%/g, '.' ) )
							.replace( /%/g, '.' )
							.replace( /\.3A/g, ':' )
							.replace( /\.20/g, '_' )
							.replace( /\(/g, '.28' )
							.replace( /\)/g, '.29' );

						if ( mw.config.get( 'wgPageName' ) === reportPage ) {
							//we're already there
							window.location.reload();
						}
					} else {
						//handle the error
						alert( mw.msg( 'wikibugs-ajax-error' ) );
						this.suppressSubmit = false;
						$loadingIcon.hide();
					}
			} );
		} );
	}
};

jQuery( document ).ready( function() {
	wikiBugsGadget.init();
} );