8a34ffcf3277d09001c3b19908b845eddb503eef
[GM_direct_download_links.git] / direct_download_links.user.js
1 // direct_download_links - Add direct download links
2 // version 0.4
3 // 2012-02-12
4 // Copyright (C) 2011,2012  Antonio Ospite <ospite@studenti.unina.it>
5 // Released under the GPL license
6 // http://www.gnu.org/copyleft/gpl.html
7 //
8 // --------------------------------------------------------------------
9 //
10 // This is a Greasemonkey user script.
11 //
12 // To install, you need Greasemonkey: https://addons.mozilla.org/en-US/firefox/addon/748
13 // Then restart Firefox and revisit this script.
14 // Under Tools, there will be a new menu item to "Install User Script".
15 // Accept the default configuration and install.
16 //
17 // To uninstall, go to Tools/Manage User Scripts,
18 // select "Direct Download Links", and click Uninstall.
19 //
20 // --------------------------------------------------------------------
21 //
22 // ==UserScript==
23 // @name           Direct Download Links
24 // @namespace      http://git.ao2.it/GM_direct_download_links.git
25 // @description    Add direct download links
26 // @include        http://video.repubblica.it/*
27 // @include        http://tv.repubblica.it/*
28 // @include        http://trovacinema.repubblica.it/*
29 // @include        http://www.kataweb.it/tvzap/*
30 // @include        http://www.rai.tv/*
31 // @include        http://soundcloud.com/*
32 // ==/UserScript==
33 //
34
35 /*
36  * TODO:
37  *  - find a way to use the same string as in the @include lines to match the
38  *    current window.location. Look for something like GM_testUrl() which builds
39  *    the regexp starting from a glob line.
40  *  - use jquery, like shown in http://a32.me/2009/11/greasemonkey/
41  *  - Support the "download" attribute for anchors:
42  *    http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#downloading-resources
43  */
44
45 /* Fields supported by the "site" object.
46  *
47  * Manadatory fields:
48  *   locationRegExp: the regexp describing the URL of the page we are modifying
49  *   urlContainerXPath: the XPath of the element containing the URL to link
50  *   urlRegexp: the regular expression for finding the URL, the first
51  *              sub-pattern is taken as the URL
52  *   linkDestXPath: the XPath of the element where to place the Direct Download link
53  *
54  *
55  * Optional fields:
56  *
57  *   initCommand: a function called before the regExp is matched, this can
58  *                be useful in cases when some action needs to be done in
59  *                order to make the element containing the regExp be actually
60  *                rendered. It must accept  a 'site' parameter.
61  *
62  *   onEvent: used to delay the urlRegexp matching to a certain event like
63  *            'DOMNodeInserted' useful when the URL is added by some javascript
64  *            library. It has two fields:
65  *
66  *              evt: the event we want to wait for (e.g. 'DOMNodeInserted')
67  *
68  *              targetElement: the element in the event handler we want the
69  *                urlRegexp is performed on.
70  *
71  *  processURL: a function to process the URL before adding the Direct
72  *              Downdload Link to the page, it must accept  a 'site' and a
73  *              'URL' parameters and dispatch the UrlFetched to pass the
74  *              modified URL to _add_link().
75  *
76  */
77 var supported_sites = [
78   {
79     locationRegexp: /^http:\/\/video\.repubblica\.it\/.*$/,
80     urlContainerXPath: '//div[@id="contA"]',
81     urlRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
82     linkDestXPath: '//div[@id="contA"]',
83   },
84   {
85     locationRegexp: /^http:\/\/tv\.repubblica\.it\/.*$/,
86     urlContainerXPath: '//div[@id="boxPlayer"]',
87     urlRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
88     linkDest: 'box_embed',
89     linkDestXPath: '//div[@id="box_embed"]',
90   },
91   {
92     locationRegexp: /^http:\/\/trovacinema\.repubblica\.it\/.*$/,
93     urlContainerXPath: '//div[@id="col-center"]',
94     urlRegexp: /'flvUrl', '((http|mms):\/\/[^']*)'/,
95     linkDestXPath: '//div[@id="col-center"]',
96   },
97   {
98     locationRegexp: /^http:\/\/www\.kataweb\.it\/tvzap\/.*$/,
99     urlContainerXPath: '//div[@id="tvzap_video"]',
100     urlRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
101     linkDestXPath: '//div[@id="tvzap_video"]',
102   },
103   {
104     locationRegexp: /^http:\/\/www\.rai\.tv\/.*$/,
105       initCommand: function(site) {
106         unsafeWindow.Silverlight.isInstalled = function(version) {
107           return true;
108         };
109     },
110     urlContainerXPath: '//div[@id="silverlightControlHost" or @id="SilverlightPlayer"]',
111     urlRegexp: /mediaUri=(http:\/\/[^,]*)/,
112     onEvent: { evt: 'DOMNodeInserted', targetElement: 'object' },
113     processURL: _rai_get_actual_url,
114     linkDestXPath: '//div[@id="silverlightControlHost" or @id="SilverlightPlayer"]',
115   },
116   {
117     locationRegexp: /^http:\/\/soundcloud.com\/.*$/,
118     urlContainerXPath: '//div[@id="main-content-inner"]',
119     urlRegexp: /"streamUrl":"([^"]*)"/,
120     linkDestXPath: '//div[@id="main-content-inner"]',
121   },
122 ];
123
124 /* Apply different rules to different sites */
125 for (i = 0; i < supported_sites.length; i++) {
126   var site = supported_sites[i];
127
128   var result = window.location.href.match(site.locationRegexp);
129   if (result) {
130     if (site.initCommand) {
131       site.initCommand(site);
132     }
133     direct_download_link_add(window.location.href, site);
134   }
135 }
136
137 function getElementByXPath(query, root) {
138   return document.evaluate(query, root || document, null, XPathResult.ANY_UNORDERED_NODE_TYPE, null).singleNodeValue;
139 }
140
141 /**
142  * Add a Direct Download link on the page for the specified URL
143  *
144  * @param: a 'site' object described above.
145  *
146  * @return: null on error, true on success
147  */
148 function direct_download_link_add(pageURL, site) {
149   site.pageURL = pageURL;
150   var element = getElementByXPath(site.urlContainerXPath);
151   if (!element) {
152     DDL_log('DirectDL (' + site.pageURL  + '): Cannot find the element ' + site.urlContainerXPath + ' containing the URL.');
153     return null;
154   }
155
156   document.addEventListener('UrlFetched', _add_link, true);
157
158   // This is used for sites adding the URL to the DOM after DOMContentLoaded,
159   // for example by some javascript library (like Silverlight.js on rai.tv).
160   if (site.onEvent) {
161     element.addEventListener(site.onEvent.evt, function(e) {
162       if (site.onEvent.targetElement &&
163           e.target.tagName.toLowerCase() != site.onEvent.targetElement) {
164         DDL_log('DirectDL (' + site.pageURL  + '): skipping element ' + e.target.tagName);
165         return;
166       }
167      _get_URL(site, element);
168     }, false);
169     return;
170   }
171
172   _get_URL(site, element);
173 }
174
175 function _get_URL(site, element) {
176   var content = element.innerHTML;
177   if (!content) {
178     DDL_log('DirectDL (' + site.pageURL + '): content is null, cannot find URL.');
179     return;
180   }
181
182   var matches = content.match(site.urlRegexp);
183   if (!matches || matches.length < 2 || !matches[1]) {
184       DDL_log('DirectDL (' + site.pageURL + '): URL not found, check the urlRegexp');
185       return;
186   }
187   var URL = matches[1];
188   if (!URL) {
189     DDL_log('DirectDL (' + site.pageURL + '): cannot get the URL.');
190     return;
191   }
192
193   if (site.processURL) {
194     site.processURL(site, URL);
195     return;
196   }
197
198   var evt = document.createEvent('Event');
199   evt.initEvent('UrlFetched', true, true);
200   evt.site = site;
201   evt.URL = URL;
202   document.dispatchEvent(evt);
203 }
204
205 function _add_link(e) {
206   var site = e.site;
207   var URL = e.URL;;
208
209   var destination = getElementByXPath(site.linkDestXPath);
210   if (!destination) {
211     DDL_log('DirectDl (' + site.pageURL + '): Cannot add the direct download link.');
212     return;
213   }
214
215   // Check if we added the link already, if so just update the href attribute.
216   // This is useful when _get_URL() is called on async events.
217   var download_link = document.getElementById('GM_direct_downaload_link');
218   if (download_link) {
219     download_link.setAttribute('href', URL);
220   } else {
221     download_link = document.createElement('a');
222     download_link.textContent = 'Direct Link';
223     download_link.setAttribute('id', 'GM_direct_downaload_link');
224     download_link.setAttribute('href', URL);
225     var style = 'background-color: white; color: blue;';
226     style += ' border: 2px solid red;'
227     style += ' float: right; font-size: large;';
228     style += ' padding: .5em; margin: 1em;'
229     style += ' position: relative; z-index: 1000;'
230     download_link.setAttribute('style', style);
231
232     destination.insertBefore(download_link, destination.firstChild);
233   }
234 }
235
236 function DDL_log(message) {
237   var debug = false;
238   if (debug) {
239     alert(message)
240   } else {
241     GM_log(message);
242   }
243 }
244
245 function _rai_get_actual_url(site, URL) {
246
247   // SmoothStreaming manifest files get added without processing, for now:
248   if (URL.match(/.*\.csm$/)) {
249     var evt = document.createEvent('Event');
250     evt.initEvent('UrlFetched', true, true);
251     evt.site = site;
252     evt.URL = URL;
253     document.dispatchEvent(evt);
254     return;
255   }
256
257   // http://www.neaveru.com/wordpress/index.php/2008/05/09/greasemonkey-bug-domnodeinserted-event-doesnt-allow-gm_xmlhttprequest/
258   setTimeout( function() {
259     GM_xmlhttpRequest({
260       method: "GET",
261       // XXX A custom header. This is the "clever" trick Rai uses to ensure
262       // the content is accessed by www.rai.tv only...
263       headers: {'viaurl': 'www.rai.tv'},
264       url: URL,
265       onload: function(response) {
266         text = response.responseText;
267         text = text.replace(/&/g, '&amp;')
268         parser = new DOMParser();
269         xmlDoc = parser.parseFromString(text, "text/xml");
270
271         // MMS streams
272         elems = xmlDoc.getElementsByTagName('REF');
273         if (elems.length > 0) {
274           href = elems[0].getAttribute('HREF');;
275
276           var evt = document.createEvent('Event');
277           evt.initEvent('UrlFetched', true, true);
278           evt.site = site;
279           evt.URL = href;
280           document.dispatchEvent(evt);
281         }
282         // SmoothStreaming streams
283         elems = xmlDoc.getElementsByTagName('playListItem');
284         if (elems.length > 0) {
285           href = elems[0].getAttribute('mediaSource');;
286
287           var evt = document.createEvent('Event');
288           evt.initEvent('UrlFetched', true, true);
289           evt.site = site;
290           evt.URL = href;
291           document.dispatchEvent(evt);
292         }
293       }
294     });
295   }, 0);
296 }