MediaWiki:Gadget-friendlywelcome.js

//

(function($){

/* **************************************** *** friendlywelcome.js: Welcome module **************************************** * Mode of invocation:    Tab ("Wel"), or from links on diff pages * Active on:             Existing user talk pages, diff pages * Config directives in:  FriendlyConfig */

Twinkle.welcome = function friendlywelcome { if( Morebits.queryString.exists( 'friendlywelcome' ) ) { if( Morebits.queryString.get( 'friendlywelcome' ) === 'auto' ) { Twinkle.welcome.auto; } else { Twinkle.welcome.semiauto; }	} else { Twinkle.welcome.normal; } };

Twinkle.welcome.auto = function { if( Morebits.queryString.get( 'action' ) !== 'edit' ) { // userpage not empty, aborting auto-welcome return; }

Twinkle.welcome.welcomeUser; };

Twinkle.welcome.semiauto = function { Twinkle.welcome.callback( mw.config.get( 'wgTitle' ).split( '/' )[0].replace( /\"/, "\\\"") ); };

Twinkle.welcome.normal = function { if( Morebits.queryString.exists( 'diff' ) ) { // check whether the contributors' talk pages exist yet var $oList = $("#mw-diff-otitle2").find("span.mw-usertoollinks a.new:contains(talk)").first; var $nList = $("#mw-diff-ntitle2").find("span.mw-usertoollinks a.new:contains(talk)").first;

if( $oList.length > 0 || $nList.length > 0 ) { var spanTag = function( color, content ) { var span = document.createElement( 'span' ); span.style.color = color; span.appendChild( document.createTextNode( content ) ); return span; };

var welcomeNode = document.createElement('strong'); var welcomeLink = document.createElement('a'); welcomeLink.appendChild( spanTag( 'Black', '[' ) ); welcomeLink.appendChild( spanTag( 'Goldenrod', 'welcome' ) ); welcomeLink.appendChild( spanTag( 'Black', ']' ) ); welcomeNode.appendChild(welcomeLink);

if( $oList.length > 0 ) { var oHref = $oList.attr("href");

var oWelcomeNode = welcomeNode.cloneNode( true ); oWelcomeNode.firstChild.setAttribute( 'href', oHref + '&' + Morebits.queryString.create( { 'friendlywelcome': Twinkle.getFriendlyPref('quickWelcomeMode') === 'auto' ? 'auto': 'norm', 'vanarticle': Morebits.pageNameNorm } ) );				$oList[0].parentNode.parentNode.appendChild( document.createTextNode( ' ' ) ); $oList[0].parentNode.parentNode.appendChild( oWelcomeNode ); }

if( $nList.length > 0 ) { var nHref = $nList.attr("href");

var nWelcomeNode = welcomeNode.cloneNode( true ); nWelcomeNode.firstChild.setAttribute( 'href', nHref + '&' + Morebits.queryString.create( { 'friendlywelcome': Twinkle.getFriendlyPref('quickWelcomeMode') === 'auto' ? 'auto': 'norm', 'vanarticle': Morebits.pageNameNorm } ) );				$nList[0].parentNode.parentNode.appendChild( document.createTextNode( ' ' ) ); $nList[0].parentNode.parentNode.appendChild( nWelcomeNode ); }		}	}	if( mw.config.get( 'wgNamespaceNumber' ) === 3 ) { var username = mw.config.get( 'wgTitle' ).split( '/' )[0].replace( /\"/, "\\\""); // only first part before any slashes Twinkle.addPortletLink( function{ Twinkle.welcome.callback(username); }, "Wel", "friendly-welcome", "Welcome user" ); } };

Twinkle.welcome.welcomeUser = function welcomeUser { Morebits.status.init( document.getElementById('mw-content-text') ); $( '#catlinks' ).remove;

var params = { value: Twinkle.getFriendlyPref('quickWelcomeTemplate'), article: Morebits.queryString.exists( 'vanarticle' ) ? Morebits.queryString.get( 'vanarticle' ) : '', mode: 'auto' };

Morebits.wiki.actionCompleted.redirect = mw.config.get('wgPageName'); Morebits.wiki.actionCompleted.notice = "Welcoming complete, reloading talk page in a few seconds";

var wikipedia_page = new Morebits.wiki.page(mw.config.get('wgPageName'), "User talk page modification"); wikipedia_page.setFollowRedirect(true); wikipedia_page.setCallbackParameters(params); wikipedia_page.load(Twinkle.welcome.callbacks.main); };

Twinkle.welcome.callback = function friendlywelcomeCallback( uid ) { if( uid === mw.config.get('wgUserName') && !confirm( 'Are you really sure you want to welcome yourself?...' ) ){ return; }

var Window = new Morebits.simpleWindow( 600, 420 ); Window.setTitle( "Welcome user" ); Window.setScriptName( "Twinkle" ); Window.addFooterLink( "Welcoming Committee", "EFD:WC" ); Window.addFooterLink( "Twinkle help", "EFD:TW/DOC#welcome" );

var form = new Morebits.quickForm( Twinkle.welcome.callback.evaluate );

form.append({			type: 'select',			name: 'type',			label: 'Type of welcome: ',			event: Twinkle.welcome.populateWelcomeList,			list: [				{ type: 'option', value: 'standard', label: 'Standard welcomes', selected: !Morebits.isIPAddress(mw.config.get('wgTitle')) },				{ type: 'option', value: 'anonymous', label: 'IP user welcomes', selected: Morebits.isIPAddress(mw.config.get('wgTitle')) },				{ type: 'option', value: 'wikiProject', label: 'WikiProject welcomes' },				{ type: 'option', value: 'nonEnglish', label: 'Non-English welcomes' }			]		});

form.append( { type: 'div', id: 'welcomeWorkArea' } );

form.append( {			type: 'input',			name: 'article',			label: '* Linked article (if supported by template):',			value:( Morebits.queryString.exists( 'vanarticle' ) ? Morebits.queryString.get( 'vanarticle' ) : '' ),			tooltip: 'An article might be linked from within the welcome if the template supports it. Leave empty for no article to be linked. Templates that support a linked article are marked with an asterisk.'		} );

var previewlink = document.createElement( 'a' ); $(previewlink).click(function{		Twinkle.welcome.callbacks.preview(result); // |result| is defined below	}); previewlink.style.cursor = "pointer"; previewlink.textContent = 'Preview'; form.append( { type: 'div', name: 'welcomepreview', label: [ previewlink ] } );

form.append( { type: 'submit' } );

var result = form.render; Window.setContent( result ); Window.display;

// initialize the welcome list var evt = document.createEvent( "Event" ); evt.initEvent( 'change', true, true ); result.type.dispatchEvent( evt ); };

Twinkle.welcome.populateWelcomeList = function(e) { var type = e.target.value; var $workarea = $(e.target.form).find("div#welcomeWorkArea");

var div = new Morebits.quickForm.element({		type: "div",		id: "welcomeWorkArea"	});

if ((type === "standard" || type === "anonymous") && Twinkle.getFriendlyPref("customWelcomeList").length) { div.append({ type: 'header', label: 'Custom welcome templates' }); div.append({			type: 'radio',			name: 'template',			list: Twinkle.getFriendlyPref("customWelcomeList"),			event: Twinkle.welcome.selectTemplate		}); }

var appendTemplates = function(list) { div.append({			type: 'radio',			name: 'template',			list: list.map(function(obj) { var properties = Twinkle.welcome.templates[obj]; var result = (properties ? {					value: obj,					label: ": " + properties.description + (properties.linkedArticle ? "\u00A0*" : ""), // U+00A0 NO-BREAK SPACE					tooltip: properties.tooltip  // may be undefined				} : {					value: obj,					label: ""				}); return result; }),			event: Twinkle.welcome.selectTemplate		}); };

switch (type) { case "standard": div.append({ type: 'header', label: 'General welcome templates' }); appendTemplates([				"welcome",				"welcome-short",				"welcome-personal",				"welcome-graphical",				"welcome-menu",				"welcome-screen",				"welcome-belated",				"welcome student",				"welcome teacher",				"welcome non-latin"			]); div.append({ type: 'header', label: 'Problem user welcome templates' }); appendTemplates([				"welcomelaws",				"first article",				"welcomevandal",				"welcomenpov",				"welcomespam",				"welcomeunsourced",				"welcomeauto",				"welcome-COI",				"welcome-image"			]); break; case "anonymous": div.append({ type: 'header', label: 'Anonymous user welcome templates' }); appendTemplates([				"welcome-anon",				"welcome-anon-border",				"welcome-anon-test",				"welcome-anon-vandal",				"welcome-anon-constructive"			]); break; case "wikiProject": div.append({ type: 'header', label: 'WikiProject-specific welcome templates' }); appendTemplates([				"welcome-au",				"welcome-bio",				"welcome-cal",				"welcome-conserv",				"welcome-cycling",				"welcome-dbz",				"welcome-et",				"welcome-in",				"welcome-de",				"welcome-math",				"welcome-med",				"welcome-no",				"welcome-pk",				"welcome-phys",				"welcome-pl",				"welcome-roads",				"welcome-rugbyunion",				"welcome-ru",				"welcome-starwars",				"welcome-ch",				"welcome-uk",				"welcome-videogames"			]); break; case "nonEnglish": div.append({ type: 'header', label: 'Non-English welcome templates' }); appendTemplates([				"welcomeen-sq",				"welcomeen-zh",				"welcomeen-nl",				"welcomeen-fi",				"welcomeen-fr",				"welcomeen-de",				"welcomeen-he",				"welcomeen-ja",				"welcomeen-ko",				"welcomeen-mr",				"welcomeen-ml",				"welcomeen-or",				"welcomeen-pt",				"welcomeen-ru",				"welcomeen-es",				"welcomeen-sv",				"welcomeen-uk"			]); break; default: div.append({ type: 'div', label: 'Twinkle.welcome.populateWelcomeList: something went wrong' }); break; }

var rendered = div.render; rendered.className = "quickform-scrollbox"; $workarea.replaceWith(rendered);

var firstRadio = e.target.form.template[0]; firstRadio.checked = true; Twinkle.welcome.selectTemplate({ target: firstRadio }); };

Twinkle.welcome.selectTemplate = function(e) { var properties = Twinkle.welcome.templates[e.target.values]; e.target.form.article.disabled = (properties ? !properties.linkedArticle : false); };

// A list of welcome templates and their properties and syntax

// The four fields that are available are "description", "linkedArticle", "syntax", and "tooltip". // The three magic words that can be used in the "syntax" field are: //  - $USERNAME$  - replaced by the welcomer's username, depending on user's preferences //  - $ARTICLE$   - replaced by an article name, if "linkedArticle" is true //  - $HEADER$    - adds a level 2 header (most templates already include this)

Twinkle.welcome.templates = { // GENERAL WELCOMES

"welcome": { description: "standard welcome", linkedArticle: true, syntax: "$USERNAME$ ~" },	"welcome-short": { description: "a shorter welcome message", linkedArticle: false, syntax: "$USERNAME$ $EXTRA$ ~" },	"welcome-personal": { description: "more personal welcome, including a plate of cookies", linkedArticle: false, syntax: "$USERNAME$ ~" },	"welcome-graphical": { description: "colorful welcome message with table of about 20 links", linkedArticle: false, syntax: "$HEADER$ $EXTRA$" },	"welcome-menu": { description: "welcome message with large table of about 60 links", linkedArticle: false, syntax: "" },	"welcome-screen": { description: "welcome message with clear, annotated table of 10 links", linkedArticle: false, syntax: "$HEADER$ " },	"welcome-belated": { description: "welcome for users with more substantial contributions", linkedArticle: false, syntax: "$USERNAME$" },	"welcome student": { description: "welcome for students editing as part of an educational class project", linkedArticle: false, syntax: "$HEADER$ $USERNAME$ ~" },	"welcome teacher": { description: "welcome for course instructors involved in an educational class project", linkedArticle: false, syntax: "$HEADER$ $USERNAME$ ~" },	"welcome non-latin": { description: "welcome for users with a username containing non-Latin characters", linkedArticle: false, syntax: "$USERNAME$ ~" },

// PROBLEM USER WELCOMES

"welcomelaws": { description: "welcome with information about copyrights, NPOV, the sandbox, and vandalism", linkedArticle: false, syntax: "$USERNAME$ ~" },	"first article": { description: "for someone whose first article did not meet page creation guidelines", linkedArticle: true, syntax: "$ARTICLE$" },	"welcomevandal": { description: "for someone whose initial efforts appear to be vandalism", linkedArticle: true, syntax: "$ARTICLE$" },	"welcomenpov": { description: "for someone whose initial efforts do not adhere to the neutral point of view policy", linkedArticle: true, syntax: "$ARTICLE$ ~" },	"welcomespam": { description: "welcome with additional discussion of anti-spamming policies", linkedArticle: true, syntax: "$ARTICLE$ ~" },	"welcomeunsourced": { description: "for someone whose initial efforts are unsourced", linkedArticle: true, syntax: "$ARTICLE$ ~" },	"welcomeauto": { description: "for someone who created an autobiographical article", linkedArticle: true, syntax: "$USERNAME$ ~" },	"welcome-COI": { description: "for someone who has edited in areas where they may have a conflict of interest", linkedArticle: true, syntax: "$USERNAME$ ~" },	"welcome-image": { description: "welcome with additional information about images (policy and procedure)", linkedArticle: true, syntax: "" },

// ANONYMOUS USER WELCOMES

"welcome-anon": { description: "for anonymous users; encourages creating an account", linkedArticle: true, syntax: " ~" },	"welcome-anon-border": { description: "similar to, but has a border and uses clearer language", linkedArticle: false, syntax: "" },	"welcome-anon-test": { description: "for anonymous users who have performed test edits", linkedArticle: true, syntax: "$ARTICLE$ ~" },	"welcome-anon-vandal": { description: "for anonymous users who have vandalized a page", linkedArticle: true, syntax: "$ARTICLE$" },	"welcome-anon-constructive": { description: "for anonymous users who fight vandalism and edit constructively", linkedArticle: true, syntax: "" },

// WIKIPROJECT-SPECIFIC WELCOMES

"welcome-au": { description: "welcome for users with an apparent interest in Australia topics", linkedArticle: false, syntax: " ~" },	"welcome-bio": { description: "welcome for users with an apparent interest in biographical topics", linkedArticle: false, syntax: " ~" },	"welcome-cal": { description: "welcome for users with an apparent interest in California topics", linkedArticle: false, syntax: " ~" },	"welcome-conserv": { description: "welcome for users with an apparent interest in conservatism topics", linkedArticle: false, syntax: "" },	"welcome-cycling": { description: "welcome for users with an apparent interest in cycling topics", linkedArticle: false, syntax: " ~" },	"welcome-dbz": { description: "welcome for users with an apparent interest in Dragon Ball topics", linkedArticle: false, syntax: "" },	"welcome-et": { description: "welcome for users with an apparent interest in Estonia topics", linkedArticle: false, syntax: "" },	"welcome-in": { description: "welcome for users with an apparent interest in India topics", linkedArticle: false, syntax: " ~" },	"welcome-de": { description: "welcome for users with an apparent interest in Germany topics", linkedArticle: false, syntax: " ~" },	"welcome-math": { description: "welcome for users with an apparent interest in mathematical topics", linkedArticle: false, syntax: " ~" },	"welcome-med": { description: "welcome for users with an apparent interest in medicine topics", linkedArticle: false, syntax: " ~" },	"welcome-no": { description: "welcome for users with an apparent interest in Norway topics", linkedArticle: false, syntax: " ~" },	"welcome-pk": { description: "welcome for users with an apparent interest in Pakistan topics", linkedArticle: false, syntax: " ~" },	"welcome-phys": { description: "welcome for users with an apparent interest in physics topics", linkedArticle: false, syntax: " ~" },	"welcome-pl": { description: "welcome for users with an apparent interest in Poland topics", linkedArticle: false, syntax: " ~" },	"welcome-rugbyunion": { description: "welcome for users with an apparent interest in rugby union topics", linkedArticle: false, syntax: " ~" },	"welcome-ru": { description: "welcome for users with an apparent interest in Russia topics", linkedArticle: false, syntax: " ~" },	"welcome-starwars": { description: "welcome for users with an apparent interest in Star Wars topics", linkedArticle: false, syntax: " ~" },	"welcome-ch": { description: "welcome for users with an apparent interest in Switzerland topics", linkedArticle: false, syntax: " ~" },	"welcome-uk": { description: "welcome for users with an apparent interest in Ukraine topics", linkedArticle: false, syntax: " ~" },	"welcome-roads": { description: "welcome for users with an apparent interest in roads and highways topics", linkedArticle: false, syntax: "" },	"welcome-videogames": { description: "welcome for users with an apparent interest in video game topics", linkedArticle: false, syntax: "" },

// NON-ENGLISH WELCOMES

"welcomeen-sq": { description: "welcome for users whose first language appears to be Albanian", linkedArticle: false, syntax: "" },	"welcomeen-zh": { description: "welcome for users whose first language appears to be Chinese", linkedArticle: false, syntax: "" },	"welcomeen-nl": { description: "welcome for users whose first language appears to be Dutch", linkedArticle: false, syntax: "" },	"welcomeen-fi": { description: "welcome for users whose first language appears to be Finnish", linkedArticle: false, syntax: "" },	"welcomeen-fr": { description: "welcome for users whose first language appears to be French", linkedArticle: false, syntax: "" },	"welcomeen-de": { description: "welcome for users whose first language appears to be German", linkedArticle: false, syntax: "" },	"welcomeen-he": { description: "welcome for users whose first language appears to be Hebrew", linkedArticle: false, syntax: "" },	"welcomeen-ja": { description: "welcome for users whose first language appears to be Japanese", linkedArticle: false, syntax: "" },	"welcomeen-ko": { description: "welcome for users whose first language appears to be Korean", linkedArticle: false, syntax: "" },	"welcomeen-mr": { description: "welcome for users whose first language appears to be Marathi", linkedArticle: false, syntax: "" },	"welcomeen-ml": { description: "welcome for users whose first language appears to be Malayalam", linkedArticle: false, syntax: "" },	"welcomeen-or": { description: "welcome for users whose first language appears to be Oriya (Odia)", linkedArticle: false, syntax: "" },	"welcomeen-pt": { description: "welcome for users whose first language appears to be Portuguese", linkedArticle: false, syntax: "" },	"welcomeen-ru": { description: "welcome for users whose first language appears to be Russian", linkedArticle: false, syntax: "" },	"welcomeen-es": { description: "welcome for users whose first language appears to be Spanish", linkedArticle: false, syntax: "" },	"welcomeen-sv": { description: "welcome for users whose first language appears to be Swedish", linkedArticle: false, syntax: "" },	"welcomeen-uk": { description: "welcome for users whose first language appears to be Ukrainian", linkedArticle: false, syntax: "" } };

Twinkle.welcome.getTemplateWikitext = function(template, article) { var properties = Twinkle.welcome.templates[template]; if (properties) { return properties.syntax. replace("$USERNAME$", Twinkle.getFriendlyPref("insertUsername") ? mw.config.get("wgUserName") : ""). replace("$ARTICLE$", article ? article : ""). replace(/\$HEADER\$\s*/, "== Welcome ==\n\n"). replace("$EXTRA$", ""); // EXTRA is not implemented yet } else { return "" + (Twinkle.getFriendlyPref("customWelcomeSignature") ? " ~" : ""); } };

Twinkle.welcome.callbacks = { preview: function(form) { var previewDialog = new Morebits.simpleWindow(750, 400); previewDialog.setTitle("Welcome template preview"); previewDialog.setScriptName("Welcome user"); previewDialog.setModality(true);

var previewdiv = document.createElement("div"); previewdiv.style.marginLeft = previewdiv.style.marginRight = "0.5em"; previewdiv.style.fontSize = "small"; previewDialog.setContent(previewdiv);

var previewer = new Morebits.wiki.preview(previewdiv); previewer.beginRender(Twinkle.welcome.getTemplateWikitext(form.getChecked("template"), form.article.value));

var submit = document.createElement("input"); submit.setAttribute("type", "submit"); submit.setAttribute("value", "Close"); previewDialog.addContent(submit);

previewDialog.display;

$(submit).click(function(e) {			previewDialog.close;		}); },	main: function( pageobj ) { var params = pageobj.getCallbackParameters; var text = pageobj.getPageText;

// abort if mode is auto and form is not empty if( pageobj.exists && params.mode === 'auto' ) { Morebits.status.info( 'Warning', 'User talk page not empty; aborting automatic welcome' ); Morebits.wiki.actionCompleted.event; return; }

var welcomeText = Twinkle.welcome.getTemplateWikitext(params.value, params.article);

if( Twinkle.getFriendlyPref('topWelcomes') ) { text = welcomeText + '\n\n' + text; } else { text += "\n" + welcomeText; }

var summaryText = "Welcome to Wikipedia!"; pageobj.setPageText(text); pageobj.setEditSummary(summaryText + Twinkle.getPref('summaryAd')); pageobj.setWatchlist(Twinkle.getFriendlyPref('watchWelcomes')); pageobj.setCreateOption('recreate'); pageobj.save; } };

Twinkle.welcome.callback.evaluate = function friendlywelcomeCallbackEvaluate(e) { var form = e.target;

var params = { value: form.getChecked("template"), article: form.article.value, mode: 'manual' };

Morebits.simpleWindow.setButtonsEnabled( false ); Morebits.status.init( form );

Morebits.wiki.actionCompleted.redirect = mw.config.get('wgPageName'); Morebits.wiki.actionCompleted.notice = "Welcoming complete, reloading talk page in a few seconds";

var wikipedia_page = new Morebits.wiki.page(mw.config.get('wgPageName'), "User talk page modification"); wikipedia_page.setFollowRedirect(true); wikipedia_page.setCallbackParameters(params); wikipedia_page.load(Twinkle.welcome.callbacks.main); }; })(jQuery);

//