MediaWiki:Gadget-tour-loader.js : Différence entre versions

De Wikimedica
Sauter à la navigation Sauter à la recherche
(Activation des tours pour tous les utilisateurs)
(Erreur de nommage de paramètre)
 
Ligne 82 : Ligne 82 :
 
if(tour.postponeDelay !== false)
 
if(tour.postponeDelay !== false)
 
{
 
{
if(this.getTourState(name) == "postponed" && (this.getTourTime(name) + tour.postponepDelay > Date.now())) { return false; } // Tour has been postponed for now.
+
if(this.getTourState(name) == "postponed" && (this.getTourTime(name) + tour.postponeDelay > Date.now())) { return false; } // Tour has been postponed for now.
 
}
 
}
 
 
Ligne 94 : Ligne 94 :
 
// ------------------- canEditPage -----------------------------
 
// ------------------- canEditPage -----------------------------
 
// The tour requires the user to be able to edit the current page.
 
// The tour requires the user to be able to edit the current page.
if(tour.canEditPage && !mw.config.get('wgIsProbablyEditable')) { return false; }
+
if(tour.canEditPage && !mw.config.get('wgIsProbablyEditabled')) { return false; }
 
 
 
// ------------------- excludePages -----------------------------
 
// ------------------- excludePages -----------------------------

Version actuelle datée du 16 septembre 2020 à 22:32

if(typeof MutationObserver == 'undefined') // If the MutationObserver pattern is not supported.
{
	console.log("Skipping tour loading, MutationObserver not supported.");
}
else if(window.self == window.top) // Prevent tours from being launched within an iframe.
{
	mw.guidedTour.loader = { // Hook to the mw.guidedTour to make the launcher globally accessible.
		tours: {
			basic_navigation: {
				requires: [], // List of tours that must have been completed for this tour to launch.
				startDelayFromRegistration: 300 * 1000, // Delay in milliseconds the tour must wait after registration to launch.
				postponeDelay: 60 * 60 * 24 * 1000, // Delay in milliseconds the tour is shown again after being postponed.
				loggedInUsersOnly: true, // If the tour is only for logged in users.
				canEditPage: true, // If the tour can only launch on pages a user can edit.
				excludePages: [/^Accueil$/, /^Wikimedica./, /^Classe./, /^Modèle./], // Exclude pages (regex).
				debug: false // Tour is in debug mode (not lauched when ready)
			},
			visual_edition: {
				requires: ["basic_navigation"], // List of tours that must have been completed for this tour to launch.
				startDelayFromRequiredTours: 24 * 60 * 60 * 1000, // Delay in milliseconds the tour must wait after required tours are completed.
				postponeDelay: 60 * 60 * 24 * 1000, // Delay in milliseconds the tour shown again after being postponed.
				loggedInUsersOnly: true, // If the tour is only for logged in users.
				canEditPage: true, // If the tour can only launch on pages a user can edit.
				excludePages: [/^Accueil$/, /^Wikimedica./, /^Classe./, /^Modèle./], // Exclude pages (regex).
				debug: false // Tour is in debug mode (not lauched when ready)
			}
		},
		
		
		optionPrefix: 'userjs-mw-tour-', // Prefix under which tour launch data is saved in the user options.
		
		// Get the state of a tour from the user options.		
		getTourState: function(name) { return mw.user.options.get(this.optionPrefix + name + "-state"); },
		
		// Get the state of a tour from the user options.		
		getTourTime: function(name) { return mw.user.options.get(this.optionPrefix + name + "-time"); },
		
		// Set a state and time for a tour state in the user options.
		setTourState: function(name, state, time) 
		{
			mw.user.options.set(this.optionPrefix + name + "-state", state);
			mw.user.options.set(this.optionPrefix + name + "-time", time);
			
			api = new mw.Api();
			api.postWithEditToken({
				'action': 'options',
				'change': this.optionPrefix + name + "-state=" + state + "|" + this.optionPrefix + name + "-time=" + time
			}).fail(function(data) { console.log("API options set call failed."); });
		},
		
		// Delete a tour state.
		deleteTourState: function(name, state) { this.setTourState(name, null, null); },
		
		/*
		 * Checks if all conditions for a tour to launch are met.
		 */
		canLaunch: function(name, tour)
		{
			// Normalize configuration.
			if(tour.startDelayFromRegistration === undefined) { tour.startDelayFromRegistration = 0; }
			if(tour.startDelayFromRequiredTours === undefined) { tour.startDelayFromRequiredTours = 0; }
			if(tour.postponeDelay === undefined) { tour.postponeDelay = false; }
			if(tour.launchProbability === undefined) { tour.lauchProbability = 1; }
			if(tour.loggedInUsersOnly === undefined) { tour.loggedInUsersOnly = true; }
			if(tour.canEditPage === undefined) { tour.canEditPage = true; }
			if(tour.excludePages === undefined) { tour.excludePages = []; }
			if(tour.requires === undefined) { tour.requires = []; }
			
			// If the tour has been completed or abandoned.
			if(this.getTourState(name) == "completed" || this.getTourState(name) == "abandoned")
			{
				return false;
			}
			
			// ------------------- startDelayfromRegistration -----------------------------
			d = new Date(mw.user.getRegistration());
			
			// Not past the delay yet.
			if(d.getTime() + tour.startDelayFromRegistration > Date.now()) { return false; }
			
			// ------------------- postponeDelay -----------------------------
			if(tour.postponeDelay !== false)
			{
				if(this.getTourState(name) == "postponed" && (this.getTourTime(name) + tour.postponeDelay > Date.now())) { return false; } // Tour has been postponed for now.
			}
			
			// ------------------- launchProbability -----------------------------
			// if(tour.launchProbability < Math.random()) { return false; }
		
			// ------------------- loggedInUsersOnly -----------------------------
			// The tour required the user to be logged in.
			if(tour.loggedInUsersOnly && mw.user.isAnon()) { return false; } 
			
			// ------------------- canEditPage -----------------------------
			// The tour requires the user to be able to edit the current page.
			if(tour.canEditPage && !mw.config.get('wgIsProbablyEditabled')) { return false; }
			
			// ------------------- excludePages -----------------------------
			page = mw.config.get("wgPageName");
			for(var i = 0; i < tour.excludePages.length; i++)
			{
				if(tour.excludePages[i].test(page)) { return false; } // Page is excluded.
			}
			
			// ------------------- requires -----------------------------
			for(var i = 0; i < tour.requires.length; i++)
			{
				time = null;
				if(this.getTourState(tour.requires[i]) == "completed" || this.getTourState(tour.requires[i]) == "abandoned")
				{
					time = this.getTourTime(tour.requires[i]);
				}
				
				if(time === null)
				{
					return false; // Tour requires a tour that has not been taken (or abandoned) yet.
				}
				
				if(parseInt(time) + tour.startDelayFromRequiredTours > Date.now())
				{ 
					return false; // Not enough time has passed since the completion (or abandonment) of this required tour.
				}
			}
			
			return true; // The tour can run
		},
		
		/*
		 * Reset all tour states.
		 */
		reset: function()
		{
			for(const tour in this.tours)
			{
				this.deleteTourState(tour);
			}
		},
	
		/*
		 * Iterates over tours to launch them.
		 */
		launch: function()
		{
			console.log('Launching tours ... ');
			
			d = $(".guider").css("display");
			if(d !== undefined && d != "none")
			{
				console.log('currently taking a tour.');
				return;
			}
			
			for(const tour in this.tours)
			{
				if(this.canLaunch(tour, this.tours[tour])) 
				{
					if(this.tours[tour].debug) // Tour is in debug mode.
					{
						console.log(tour + ' would have launched (but is in debug mode)');
						continue;
					}
					
					console.log(tour + ' available for launching');
					mw.guidedTour.launcher.launchTour(tour);
					return; // A tour has launched, stop the loop as we don't want multiple tours to launch.
				}
			}
			
			console.log('none ready to lauch.');
		}
	};
	
	/* Create an observer instance to look for the addition of a guider element to the interface 
	Source: https://gabrieleromanato.name/jquery-detecting-new-elements-with-the-mutationobserver-object */
	var observer = new MutationObserver(function( mutations ) 
	{
		mutations.forEach(function( mutation ) 
		{
			var newNodes = mutation.addedNodes; // DOM NodeList
			
			if( newNodes === null ) // If there are no new nodes added.
			{
				return;
			}
			
			$(newNodes).each(function() 
			{
				var $node = $(this);
				
				if(!$node.hasClass("guider")) 
				{
					return; // Not a guider.
				}
				
				// Deduce the tour name from the id.
				// tourName = $node.attr('id').replace('gt-', '').replace('-overlay', '');
				tourName = /(?:^|\s)mw-guidedtour-tour-(.*?)(?:\s|$)/g.exec($node.attr('class'))[1]; // Should use class because in id the step can be appended (e.g. basic_navigation-forum)
				
				mw.guidedTour.loader.deleteTourState(tourName); // Reset the state of the tour.
				
				$(".x_button").click(function() {
					// If there was a complete button on the step.
					if($(".mw-tour-complete, .guidedtour-end-button").length)
					{
						// This counts as a completion.
						console.log(tourName +  ' tour complete');
						mw.guidedTour.loader.setTourState(tourName, "completed", Date.now()); // Tour has been completed.
						
						return;
					}
					
					console.log(tourName +  ' tour abandoned');
					mw.guidedTour.loader.setTourState(tourName, "abandoned", Date.now()); // Tour has been abandoned.
				});
				
				$(".mw-tour-later").click(function() {
					console.log(tourName +  ' tour postponed');
					mw.guidedTour.loader.setTourState(tourName, "postponed", Date.now()); // Tour has been postponed.
					mw.guidedTour.endTour();
				});
				
				$(".mw-tour-complete, .guidedtour-end-button").click(function() {
					console.log(tourName +  ' tour completed');
					mw.guidedTour.loader.setTourState(tourName, "completed", Date.now()); // Tour has been completed.
				});
				
				// Make the guiders draggable so users can move them when they are interfering with an element.
				// Adapted from: https://www.sanwebe.com/2014/10/draggable-element-with-jquery-no-jquery-ui
				$('.guider').
					css('cursor', 'move').
					hover(function() { $(this).css('border-width', '3px'); }, function() { $(this).css('border-width', '1px'); }).
					on('mousedown', function(e) {
						var dr = $(this).addClass("drag");
						height = dr.outerHeight();
						width = dr.outerWidth();
						ypos = dr.offset().top + height - e.pageY,
						xpos = dr.offset().left + width - e.pageX;
						$(document.body).on('mousemove', function(e){
							var itop = e.pageY + ypos - height;
							var ileft = e.pageX + xpos - width;
							if(dr.hasClass("drag")){
								dr.offset({top: itop,left: ileft});
							}
						}).on('mouseup', function(e){
							dr.removeClass("drag");
						});
					});
			});
		});    
	});
	
	observer.observe($('body')[0], { 
		attributes: false, 
		childList: true, 
		characterData: false 
	});
	
	console.log('Loaded tour loader gadget');
	mw.guidedTour.loader.launch(); // Launch next available tour.
}