From: Antonio Ospite <ospite@studenti.unina.it>
Date: Fri, 9 Dec 2011 10:46:42 +0000 (+0100)
Subject: Pass over a site object to functions not its fields individually
X-Git-Tag: 0.3~14
X-Git-Url: https://git.ao2.it/GM_direct_download_links.git/commitdiff_plain/d1f8e38cdc7a277526cfa1465d934ef279a89760?ds=sidebyside;hp=2638b96a6a4a02f75f1569fd52e4a18465a82ebd

Pass over a site object to functions not its fields individually

This is in preparation to support optional fields for site objects.

Signed-off-by: Antonio Ospite <ospite@studenti.unina.it>
---

diff --git a/direct_download_links.user.js b/direct_download_links.user.js
index e3707a1..a91fb00 100644
--- a/direct_download_links.user.js
+++ b/direct_download_links.user.js
@@ -37,6 +37,20 @@
  *  - 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\/.*$/,
@@ -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.urlContainer, site.urlRegexp, site.linkDest);
+    var ret = direct_download_link_add(window.location.href, site);
     if (!ret) {
       alert('Cannot add the link');
     }
@@ -80,37 +94,33 @@ for (i = 0; i < supported_sites.length; i++) {
 /**
  * Add a Direct Download link on the page for the specified URL
  *
- * @param pageURL: the URL of the page we are modifying
- * @param urlContainer: the element containing the URL to link
- * @param urlRegexp: the regular expression for finding the URL, the first
- *                    sub-pattern is taken as the 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, urlContainer, urlRegexp, linkDest) {
-  var element = document.getElementById(urlContainer);
+function direct_download_link_add(pageURL, site) {
+  var element = document.getElementById(site.urlContainer);
   if (!element) {
-    alert('DirectDL (' + pageURL  + '): Cannot find the element ' + urlContainer + ' containing the 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 URL.');
+    alert('DirectDL (' + site.pageURL + '): content is null, cannot find URL.');
     return null;
   }
 
-  var matches = content.match(urlRegexp);
+  var matches = content.match(site.urlRegexp);
   if (!matches || matches.length < 2 || !matches[1]) {
-      alert('DirectDL (' + pageURL + '): URL not found, check the urlRegexp');
+      alert('DirectDL (' + site.pageURL + '): URL not found, check the urlRegexp');
       return null;
   }
   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;
   }