Pass over a site object to functions not its fields individually

[GM_direct_download_links.git] / direct_download_links.user.js

diff --git a/direct_download_links.user.js b/direct_download_links.user.js
index 452e2a4..a91fb00 100644 (file)
--- a/direct_download_links.user.js
+++ b/direct_download_links.user.js
@@ -1,4 +1,4 @@
-// direct_download_links - Add direct download links for (video) files
+// direct_download_links - Add direct download links
 // version 0.2
 // 2011-11-14
 // Copyright (C) 2011  Antonio Ospite <ospite@studenti.unina.it>
@@ -22,7 +22,7 @@
 // ==UserScript==
 // @name           Direct Download Links
 // @namespace      http://git.ao2.it/GM_direct_download_links.git
-// @description    Add direct download links for (video) files
+// @description    Add direct download links
 // @include        http://video.repubblica.it/*
 // @include        http://tv.repubblica.it/*
 // @include        http://trovacinema.repubblica.it/*
@@ -37,29 +37,43 @@
  *  - use jquery, like shown in http://a32.me/2009/11/greasemonkey/
  */
 
+/* Fields supported by the "site" object.
+ *
+ * Manadatory fields:
+ *   pageURL: the URL of the page we are modifying
+ *   urlContainer: the element containing the URL to link
+ *   urlRegexp: the regular expression for finding the URL, the first
+ *              sub-pattern is taken as the URL
+ *   linkDest: the element where to place the Direct Download link
+ *
+ *
+ * Optional fields:
+ *   TODO
+ *
+ */
 var supported_sites = [
   {
     locationRegexp: /^http:\/\/video\.repubblica\.it\/.*$/,
-    fileElem: 'contA',
-    fileRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
+    urlContainer: 'contA',
+    urlRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
     linkDest: 'contA',
   },
   {
     locationRegexp: /^http:\/\/tv\.repubblica\.it\/.*$/,
-    fileElem: 'boxPlayer',
-    fileRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
+    urlContainer: 'boxPlayer',
+    urlRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
     linkDest: 'box_embed',
   },
   {
     locationRegexp: /^http:\/\/trovacinema\.repubblica\.it\/.*$/,
-    fileElem: 'col-center',
-    fileRegexp: /'flvUrl', '((http|mms):\/\/[^']*)'/,
+    urlContainer: 'col-center',
+    urlRegexp: /'flvUrl', '((http|mms):\/\/[^']*)'/,
     linkDest: 'col-center',
   },
   {
     locationRegexp: /^http:\/\/www\.kataweb\.it\/tvzap\/.*$/,
-    fileElem: 'tvzap_video',
-    fileRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
+    urlContainer: 'tvzap_video',
+    urlRegexp: /'pcUrl', '((http|mms):\/\/[^']*)'/,
     linkDest: 'playerCont',
   },
 ];
@@ -70,7 +84,7 @@ for (i = 0; i < supported_sites.length; i++) {
 
   var result = window.location.href.match(site.locationRegexp);
   if (result) {
-    var ret = direct_download_link_add(window.location.href, site.fileElem, site.fileRegexp, site.linkDest);
+    var ret = direct_download_link_add(window.location.href, site);
     if (!ret) {
       alert('Cannot add the link');
     }
@@ -78,45 +92,41 @@ for (i = 0; i < supported_sites.length; i++) {
 }
 
 /**
- * Add a Direct Download link on the page for the specified file
+ * Add a Direct Download link on the page for the specified URL
  *
- * @param pageURL: the URL of the page we are modifying
- * @param fileElem: the element containing the file URL
- * @param fileRegexp: the regular expression for finding the file, the first
- *                    sub-pattern is taken as the file URL
- * @param linkDest: the element where to place the Direct Download link
+ * @param: a 'site' object described above.
  *
  * @return: null on error, true on success
  */
-function direct_download_link_add(pageURL, fileElem, fileRegexp, linkDest) {
-  var element = document.getElementById(fileElem);
+function direct_download_link_add(pageURL, site) {
+  var element = document.getElementById(site.urlContainer);
   if (!element) {
-    alert('DirectDL (' + pageURL  + '): Cannot find the element ' + fileElem + ' containing the file URL.');
+    alert('DirectDL (' + site.pageURL  + '): Cannot find the element ' + site.urlContainer + ' containing the URL.');
     return null;
   }
 
   var content = element.innerHTML;
   if (!content) {
-    alert('DirectDL (' + pageURL + '): content is null, cannot find file URL.');
+    alert('DirectDL (' + site.pageURL + '): content is null, cannot find URL.');
     return null;
   }
 
-  var matches = content.match(fileRegexp);
+  var matches = content.match(site.urlRegexp);
   if (!matches || matches.length < 2 || !matches[1]) {
-      alert('DirectDL (' + pageURL + '): file URL not found, check the fileRegexp');
+      alert('DirectDL (' + site.pageURL + '): URL not found, check the urlRegexp');
       return null;
   }
-  var fileURL = matches[1];
+  var URL = matches[1];
 
-  var links = document.getElementById(linkDest);
+  var links = document.getElementById(site.linkDest);
   if (!links) {
-    alert('DirectDl (' + pageURL + '): Cannot add the direct download link.');
+    alert('DirectDl (' + site.pageURL + '): Cannot add the direct download link.');
     return null;
   }
 
   var download_link = document.createElement('a');
   download_link.textContent = 'Direct Link';
-  download_link.setAttribute('href', fileURL);
+  download_link.setAttribute('href', URL);
   var style = 'background-color: white; color: blue;';
   style += ' border: 2px solid red;'
   style += ' float: right; font-size: large;';