summaryrefslogtreecommitdiff
path: root/resources/mediawiki.action/mediawiki.action.watch.ajax.js
blob: f5f09f52a105d0313e0d744e892db369e93bafa9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/**
 * Animate watch/unwatch links to use asynchronous API requests to
 * watch pages, rather than navigating to a different URI.
 */
( function ( $, mw, undefined ) {

/**
 * The name of the page to watch or unwatch.
 */
var title = mw.config.get( 'wgRelevantPageName', mw.config.get( 'wgPageName' ) );

/**
 * Update the link text, link href attribute and (if applicable)
 * "loading" class.
 *
 * @param $link {jQuery} Anchor tag of (un)watch link
 * @param action {String} One of 'watch', 'unwatch'.
 * @param state {String} [optional] 'idle' or 'loading'. Default is 'idle'.
 */
function updateWatchLink( $link, action, state ) {
	// message keys 'watch', 'watching', 'unwatch' or 'unwatching'.
	var	msgKey = state === 'loading' ? action + 'ing' : action,
		accesskeyTip = $link.attr( 'title' ).match( mw.util.tooltipAccessKeyRegexp ),
		$li = $link.closest( 'li' );

	$link
		.text( mw.msg( msgKey ) )
		.attr( 'title', mw.msg( 'tooltip-ca-' + action ) +
			( accesskeyTip ? ' ' + accesskeyTip[0] : '' )
		)
		.attr( 'href', mw.util.wikiScript() + '?' + $.param({
				title: title,
				action: action
			})
		);

	// Special case for vector icon
	if ( $li.hasClass( 'icon' ) ) {
		if ( state === 'loading' ) {
			$link.addClass( 'loading' );
		} else {
			$link.removeClass( 'loading' );
		}
	}
}

/**
 * @todo This should be moved somewhere more accessible.
 * @param url {String}
 * @return {String} The extracted action, defaults to 'view'.
 */
function mwUriGetAction( url ) {
	var	actionPaths = mw.config.get( 'wgActionPaths' ),
		key, parts, m, action;

	// @todo: Does MediaWiki give action path or query param
	// precedence ? If the former, move this to the bottom
	action = mw.util.getParamValue( 'action', url );
	if ( action !== null ) {
		return action;
	}

	for ( key in actionPaths ) {
		if ( actionPaths.hasOwnProperty( key ) ) {
			parts = actionPaths[key].split( '$1' );
			for ( i = 0; i < parts.length; i += 1 ) {
				parts[i] = $.escapeRE( parts[i] );
			}
			m = new RegExp( parts.join( '(.+)' ) ).exec( url );
			if ( m && m[1] ) {
				return key;
			}
		
		}
	}

	return 'view';
}

$( document ).ready( function() {
	var $links = $( '.mw-watchlink a, a.mw-watchlink, ' +
		'#ca-watch a, #ca-unwatch a, #mw-unwatch-link1, ' +
		'#mw-unwatch-link2, #mw-watch-link2, #mw-watch-link1' );

	// Allowing people to add inline animated links is a little scary
	$links = $links.filter( ':not( #bodyContent *, #content * )' );

	$links.click( function( e ) {
		var	$link, api,
			action = mwUriGetAction( this.href );

		if ( action !== 'watch' && action !== 'unwatch' ) {
			// Could not extract target action from link url,
			// let native browsing handle it further
			return true;
		}
		e.preventDefault();
		e.stopPropagation();
		
		$link = $( this );

		updateWatchLink( $link, action, 'loading' );

		api = new mw.Api();
		api[action](
			title,
			// Success
			function( watchResponse ) {
				var	otherAction = action === 'watch' ? 'unwatch' : 'watch',
					$li = $link.closest( 'li' );

				mw.util.jsMessage( watchResponse.message, 'ajaxwatch' );

				// Set link to opposite
				updateWatchLink( $link, otherAction );

				// Most common ID style
				if ( $li.prop( 'id' ) === 'ca-' + otherAction || $li.prop( 'id' ) === 'ca-' + action ) {
					$li.prop( 'id', 'ca-' + otherAction );
				}
				
				// Bug 12395 - update the watch checkbox on edit pages when the
				// page is watched or unwatched via the tab.
				if ( watchResponse.watched !== undefined ) {
					$( '#wpWatchthis' ).prop( 'checked', true );
				} else {
					$( '#wpWatchthis' ).removeProp( 'checked' );
				}
			},
			// Error
			function(){		

				// Reset link to non-loading mode
				updateWatchLink( $link, action );
				
				// Format error message
				var cleanTitle = title.replace( /_/g, ' ' );
				var link = mw.html.element(
					'a', {
						'href': mw.util.wikiGetlink( title ),
						'title': cleanTitle
					}, cleanTitle
				);
				var html = mw.msg( 'watcherrortext', link );
				
				// Report to user about the error
				mw.util.jsMessage( html, 'ajaxwatch' );

			}
		);
	});

});

})( jQuery, mediaWiki );