Merge lp:~gesha/linaro-license-protection/per-file-EULA into lp:~linaro-automation/linaro-license-protection/trunk

[Georgy Redkozubov]

This branch adds per file EULA support for downloads click-through license protection.

[lp:~gesha/linaro-license-protection/per-file-EULA]

61. By Georgy Redkozubov on 2012-04-24

Fixed indentation

[Данило Шеган (danilo)]

Looks good, it'd be nice to have a test for dirs only containing other dirs.

review: Approve

[lp:~gesha/linaro-license-protection/per-file-EULA]

62. By Georgy Redkozubov on 2012-04-24

Added test for directory containing only directories

=== modified file '.htaccess'
--- .htaccess	2012-03-27 13:50:19 +0000
+++ .htaccess	2012-04-24 10:59:21 +0000
@@ -31,6 +31,7 @@
 RewriteCond %{REQUEST_URI} /licenses/ste.html$ [OR]
 RewriteCond %{REQUEST_URI} /licenses/samsung.html$ [OR]
 RewriteCond %{REQUEST_URI} /licenses/linaro.html$ [OR]
+RewriteCond %{REQUEST_URI} /licenses/nolicense.html$ [OR]
 RewriteCond %{REQUEST_URI} /licenses/license.php$
 RewriteCond %{HTTP_COOKIE} downloadrequested
 RewriteCond %{HTTP_COOKIE} !licenseaccepted=true
@@ -45,13 +46,11 @@
 RewriteCond %{HTTP_COOKIE} !downloadrequested=(.*)
 RewriteRule .* / [R,L]
 
-## Exception for <iframe>
-RewriteCond %{REQUEST_URI} ^.*/EULA.txt$
-RewriteRule .* - [L]
-
 ## If there is a cookie indicating license has been accepted, pass through.
+## Unset it to be able to process several protected files in the same dir
 RewriteCond %{HTTP_COOKIE} licenseaccepted=true
-RewriteRule .* - [L]
+RewriteCond %{HTTP_COOKIE} downloadrequested=([^\;]*\/)([^/\;]*)
+RewriteRule .* - [CO=licenseaccepted:INVALID:;:-1:%1,L]
 
 ## When license is accepted, set the cookie.
 RewriteCond %{REQUEST_URI} licenses/.*-accepted.html$
@@ -72,36 +71,13 @@
 RewriteCond %{ENV:LP_DOWNLOAD_DIR}/OPEN-EULA.txt -f 
 RewriteRule .* - [L]
 
+## Unset cookie indicating redirect from license.php
+RewriteCond %{HTTP_COOKIE} redirectlicensephp=yes
+RewriteRule .* - [CO=redirectlicensephp:INVALID:;:-1,L]
+
 ## Redirect to the Samsung license file protected builds.
-RewriteCond %{REQUEST_FILENAME} -d
-RewriteCond %{REQUEST_FILENAME} .*origen.*
-RewriteCond %{REQUEST_FILENAME}/EULA.txt -f
-RewriteRule .* /licenses/license.php?samsung [CO=downloadrequested:%{REQUEST_URI}:.%{ENV:CO_DOMAIN},R,L]
-
-RewriteCond %{REQUEST_FILENAME} -f
-RewriteCond %{REQUEST_FILENAME} .*origen.* 
-RewriteCond %{ENV:LP_DOWNLOAD_DIR}/EULA.txt -f
-RewriteRule .* /licenses/license.php?samsung [CO=downloadrequested:%{REQUEST_URI}:.%{ENV:CO_DOMAIN},R,L]
-
-## Redirect to the ST-E license file protected builds.
-RewriteCond %{REQUEST_FILENAME} -d
-RewriteCond %{REQUEST_FILENAME} .*snowball.* 
-RewriteCond %{REQUEST_FILENAME}/EULA.txt -f
-RewriteRule .* /licenses/license.php?ste [CO=downloadrequested:%{REQUEST_URI}:.%{ENV:CO_DOMAIN},R,L]
-
-RewriteCond %{REQUEST_FILENAME} -f
-RewriteCond %{REQUEST_FILENAME} .*snowball.* 
-RewriteCond %{ENV:LP_DOWNLOAD_DIR}/EULA.txt -f
-RewriteRule .* /licenses/license.php?ste [CO=downloadrequested:%{REQUEST_URI}:.%{ENV:CO_DOMAIN},R,L]
-
-## Redirect to the Linaro license file protected builds.
-RewriteCond %{REQUEST_FILENAME} -d
-RewriteCond %{REQUEST_FILENAME}/EULA.txt -f
-RewriteRule .* /licenses/license.php?linaro [CO=downloadrequested:%{REQUEST_URI}:.%{ENV:CO_DOMAIN},R,L]
-
-RewriteCond %{REQUEST_FILENAME} -f
-RewriteCond %{ENV:LP_DOWNLOAD_DIR}/EULA.txt -f
-RewriteRule .* /licenses/license.php?linaro [CO=downloadrequested:%{REQUEST_URI}:.%{ENV:CO_DOMAIN},R,L]
+RewriteCond %{REQUEST_URI} !^/$ 
+RewriteRule .* /licenses/license.php [CO=downloadrequested:%{REQUEST_URI}:.%{ENV:CO_DOMAIN},L,R]
 
 ## Return "Permission denied" if no EULA/OPEN-EULA exists
 RewriteCond %{REQUEST_URI} !^/$
 
=== added directory 'android/images'
=== added file 'android/images/MANIFEST'
--- android/images/MANIFEST	1970-01-01 00:00:00 +0000
+++ android/images/MANIFEST	2012-04-24 10:59:21 +0000
@@ -0,0 +1,1 @@
+MANIFEST
 \ No newline at end of file
 
=== added file 'android/images/origen-blob.EULA.txt.samsung'
=== added file 'android/images/origen-blob.txt'
--- android/images/origen-blob.txt	1970-01-01 00:00:00 +0000
+++ android/images/origen-blob.txt	2012-04-24 10:59:21 +0000
@@ -0,0 +1,1 @@
+This is protected with click-through Samsung license.
 \ No newline at end of file
 
=== added file 'android/images/snowball-blob.EULA.txt.ste'
=== added file 'android/images/snowball-blob.txt'
--- android/images/snowball-blob.txt	1970-01-01 00:00:00 +0000
+++ android/images/snowball-blob.txt	2012-04-24 10:59:21 +0000
@@ -0,0 +1,1 @@
+This is protected with click-through ST-E license.
 \ No newline at end of file
 
=== modified file 'android/~linaro-android/staging-origen/test.txt'
--- android/~linaro-android/staging-origen/test.txt	2011-12-09 16:08:16 +0000
+++ android/~linaro-android/staging-origen/test.txt	2012-04-24 10:59:21 +0000
@@ -1,1 +1,1 @@
-This is a protected with click-through Samsung license.
+This is protected with click-through Samsung license.
 
=== modified file 'android/~linaro-android/staging-panda/test.txt'
--- android/~linaro-android/staging-panda/test.txt	2012-03-27 09:53:11 +0000
+++ android/~linaro-android/staging-panda/test.txt	2012-04-24 10:59:21 +0000
@@ -1,1 +1,1 @@
-This is a protected with click-through Linaro license.
+This is protected with click-through Linaro license.
 
=== added file 'android/~linaro-android/staging-snowball/173/OPEN-EULA.txt'
=== modified file 'android/~linaro-android/staging-snowball/173/target/product/snowball/test.txt'
--- android/~linaro-android/staging-snowball/173/target/product/snowball/test.txt	2012-03-27 13:57:57 +0000
+++ android/~linaro-android/staging-snowball/173/target/product/snowball/test.txt	2012-04-24 10:59:21 +0000
@@ -1,1 +1,1 @@
-This is a protected with click-through ST-E license.
+This is protected with click-through ST-E license.
 
=== added file 'android/~linaro-android/staging-snowball/173/test.txt'
--- android/~linaro-android/staging-snowball/173/test.txt	1970-01-01 00:00:00 +0000
+++ android/~linaro-android/staging-snowball/173/test.txt	2012-04-24 10:59:21 +0000
@@ -0,0 +1,1 @@
+This is always available.
 
=== modified file 'licenses/license.php'
--- licenses/license.php	2012-04-20 16:00:26 +0000
+++ licenses/license.php	2012-04-24 10:59:21 +0000
@@ -1,18 +1,119 @@
 <?php
- $down = $_COOKIE["downloadrequested"];
- $lic = $_SERVER["QUERY_STRING"];
- $host = $_SERVER["HTTP_HOST"];
- $doc = $_SERVER["DOCUMENT_ROOT"];
- $fn = $doc.$down;
- if (file_exists($fn) and is_file($fn)) {
-    $repl = dirname($down);
- } else {
-    $repl = $down;
- }
-
- $template_content = file_get_contents($doc."/licenses/".$lic.".html");
- $eula_content = file_get_contents($doc."/licenses/".$lic.".txt");
-
- $out = str_replace("EULA.txt", $eula_content, $template_content);
- echo $out;
+// Get list of files into array to process them later.
+// Used to find special licenses and dirs with only subdirs.
+function getFilesList($dirname)
+{
+	$files = array(); 
+	if ($handle = opendir($dirname)) {
+		while ($handle && false !== ($entry = readdir($handle))) {
+			if ($entry != "." && $entry != ".." && !is_dir($dirname.$entry) && !is_link($dirname.$entry)) {
+				$files[] = $entry;
+			}
+		}
+	}
+	closedir($handle);
+	return $files;
+}
+
+// Get array of file name and extension from full filename.
+function splitFilename($filename)
+{
+	$pos = strpos($filename, '.');
+	if ($pos === false) { // dot is not found in the filename
+		return array($filename, ''); // no extension
+	} else {
+		$basename = substr($filename, 0, $pos);
+		$extension = substr($filename, $pos+1);
+		return array($basename, $extension);
+	}
+}
+
+// Find special EULA based on filename template.
+function findSpecialEULA($fl, $pattern)
+{
+	if (!empty($fl)) {
+		foreach ($fl as $f) {
+			if (preg_match($pattern, $f, $matches)) {
+				return $f;
+			}
+		}
+	}
+       	return false;
+}
+
+// Get license theme name from EULA filename.
+function getTheme($eula, $down)
+{
+	if ($eula != 'EULA.txt') { // Special EULA file was found
+		$theme = array_pop(explode(".", $eula));
+	} else { // No special EULA file was found
+		$eula = "EULA.txt";
+		if (preg_match("/.*snowball.*/", $down)) {
+			$theme = "ste";
+		} elseif (preg_match("/.*origen.*/", $down)) {
+			$theme = "samsung";
+		} else {
+			$theme = "linaro";
+		}
+	} 
+	return $theme;
+}
+
+$down = $_COOKIE["downloadrequested"];
+$host = $_SERVER["HTTP_HOST"];
+$doc = $_SERVER["DOCUMENT_ROOT"];
+$fn = $doc.$down; // Filename on server
+$flist = array();
+$eula = '';
+
+if (file_exists($fn) and is_file($fn)) { // Requested download is file
+	$search_dir = dirname($fn);
+	$repl = dirname($down);
+	$name_only = splitFilename(basename($down));
+} elseif (is_dir($fn)) { // Requested download is directory
+	$search_dir = $fn;
+	$repl = $down;
+	$name_only = array();
+} else { // Requested download not found on server
+	header("HTTP/1.0 404 Not Found");
+	header("Status: 404");
+	echo "<h1>404 Not Found</h1>";
+	echo "The requested URL was not found on this server.";
+	exit;
+}
+
+$flist = getFilesList($search_dir);
+
+if (!empty($name_only)) {
+	$pattern = "/^".$name_only[0]."\.EULA\.txt.*/";
+	$eula = findSpecialEULA($flist, $pattern);
+}
+
+if (is_file($doc."/".$repl."/".$eula)) { // Special EULA found
+	$theme = getTheme($eula, $down);
+} elseif (is_file($doc."/".$repl."/EULA.txt")) { // No special EULA found
+	$theme = getTheme("EULA.txt", $down);
+} elseif (file_exists($fn) and findSpecialEULA($flist, "/.*EULA.txt.*/")) {
+	// If file is requested but no special EULA for it and no EULA.txt is present,
+	// look for any EULA and if found decide that current file is not protected.
+	setcookie("redirectlicensephp", "yes", 0, "/");
+	header("Location: ".$down);
+	exit;
+} elseif (empty($flist)) { // Directory contains only subdirs
+	setcookie("redirectlicensephp", "yes", 0, "/");
+	header("Location: ".$down);
+	exit;
+} else { // No special EULA, no EULA.txt, no OPEN-EULA.txt found
+	header("HTTP/1.1 403 Forbidden");
+	header("Status: 403");
+	echo "<h1>Forbidden</h1>";
+	echo "You don't have permission to access ".$down." on this server.";
+	exit;
+}
+
+$template_content = file_get_contents($doc."/licenses/".$theme.".html");
+$eula_content = file_get_contents($doc."/licenses/".$theme.".txt");
+
+$out = str_replace("EULA.txt", $eula_content, $template_content);
+echo $out;
 ?>
 
=== modified file 'licenses/linaro.html'
--- licenses/linaro.html	2012-03-27 13:57:57 +0000
+++ licenses/linaro.html	2012-04-24 10:59:21 +0000
@@ -82,11 +82,6 @@
   #actions .button-accept:hover {
     background: #9c5;
   }
-  iframe#eula {
-    width: 100%;
-    height: 100%;
-    scrolling: auto;
-  }
 </style>
 </head>
 <body>
@@ -101,7 +96,7 @@
 <div id="content">
 
 <div id="license-text">
-<iframe id="eula" frameborder=0 src="EULA.txt"></iframe>
+EULA.txt
 </div><!-- license-text -->
 
 <div id="actions">
 
=== added file 'licenses/linaro.txt'
--- licenses/linaro.txt	1970-01-01 00:00:00 +0000
+++ licenses/linaro.txt	2012-04-24 10:59:21 +0000
@@ -0,0 +1,1 @@
+Linaro license.
 \ No newline at end of file
 
=== modified file 'licenses/samsung.html'
--- licenses/samsung.html	2012-04-20 16:00:26 +0000
+++ licenses/samsung.html	2012-04-24 10:59:21 +0000
@@ -45,6 +45,7 @@
     color: black;
     margin: 2em;
     padding: 2em;
+    overflow: scroll;
     text-align: left;
     -moz-border-radius: 10px;
     -webkit-border-radius: 10px;
@@ -82,11 +83,6 @@
   #actions .button-accept:hover {
     background: #9c5;
   }
-  iframe#eula {
-    width: 100%;
-    height: 100%;
-    scrolling: auto;
-  }
 </style>
 </head>
 <body>
 
=== modified file 'licenses/ste.html'
--- licenses/ste.html	2012-04-20 16:00:26 +0000
+++ licenses/ste.html	2012-04-24 10:59:21 +0000
@@ -88,11 +88,6 @@
   #actions .button-accept:hover {
     background: #9c5;
   }
-  iframe#eula {
-    width: 100%;
-    height: 100%;
-    scrolling: auto;
-  }
 </style>
 </head>
 <body>
 
=== modified file 'testing/test_click_through_license.py'
--- testing/test_click_through_license.py	2012-03-27 09:53:11 +0000
+++ testing/test_click_through_license.py	2012-04-24 10:59:21 +0000
@@ -24,9 +24,14 @@
 linaro_license_path = '/licenses/linaro.html'
 samsung_test_file = '/android/~linaro-android/staging-origen/test.txt'
 ste_test_file = '/android/~linaro-android/staging-snowball/173/target/product/snowball/test.txt'
+ste_open_test_file = '/android/~linaro-android/staging-snowball/173/test.txt'
 never_available = '/android/~linaro-android/staging-imx53/test.txt'
 linaro_test_file = '/android/~linaro-android/staging-panda/test.txt'
 not_protected_test_file = '/android/~linaro-android/staging-vexpress-a9/test.txt'
+per_file_samsung_test_file = '/android/images/origen-blob.txt'
+per_file_ste_test_file = '/android/images/snowball-blob.txt'
+per_file_not_protected_test_file = '/android/images/MANIFEST'
+dirs_only_dir = '/android/~linaro-android/'
 
 
 class Contains(object):
@@ -180,7 +185,7 @@
         self.assertThat(testfile, Contains(search))
 
     def test_accept_license_samsung_file(self):
-        search = "This is a protected with click-through Samsung license."
+        search = "This is protected with click-through Samsung license."
         testfile = fetcher.get(host + samsung_test_file)
         fetcher.close()
         if os.path.exists("%s/cookies.txt" % docroot):
@@ -194,7 +199,7 @@
         self.assertThat(testfile, Contains(search))
 
     def test_accept_license_ste_file(self):
-        search = "This is a protected with click-through ST-E license."
+        search = "This is protected with click-through ST-E license."
         testfile = fetcher.get(host + ste_test_file)
         fetcher.close()
         if os.path.exists("%s/cookies.txt" % docroot):
@@ -207,19 +212,19 @@
         self.assertThat(testfile, Contains(search))
 
     def test_license_accepted_samsung(self):
-        search = "This is a protected with click-through Samsung license."
+        search = "This is protected with click-through Samsung license."
         os.rename("%s/cookies.samsung" % docroot, "%s/cookies.txt" % docroot)
         testfile = fetcher.get(host + samsung_test_file, ignore_license=True)
         self.assertThat(testfile, Contains(search))
 
     def test_license_accepted_ste(self):
-        search = "This is a protected with click-through ST-E license."
+        search = "This is protected with click-through ST-E license."
         os.rename("%s/cookies.ste" % docroot, "%s/cookies.txt" % docroot)
         testfile = fetcher.get(host + ste_test_file, ignore_license=True)
         self.assertThat(testfile, Contains(search))
 
     def test_internal_host_samsung(self):
-        search = "This is a protected with click-through Samsung license."
+        search = "This is protected with click-through Samsung license."
         subprocess.Popen(['sed', '-i', '/## Let internal hosts through '
             'always./ a %s' % local_rewrite, '%s/.htaccess' % docroot],
             stdout=open('/dev/null', 'w'), stderr=subprocess.STDOUT).wait()
@@ -228,10 +233,54 @@
         self.assertThat(testfile, Contains(search))
 
     def test_internal_host_ste(self):
-        search = "This is a protected with click-through ST-E license."
+        search = "This is protected with click-through ST-E license."
         subprocess.Popen(['sed', '-i', '/## Let internal hosts through '
             'always./ a %s' % local_rewrite, '%s/.htaccess' % docroot],
             stdout=open('/dev/null', 'w'), stderr=subprocess.STDOUT).wait()
         testfile = fetcher.get(host + ste_test_file, ignore_license=True)
         shutil.copy("%s/dothtaccess" % docroot, "%s/.htaccess" % docroot)
         self.assertThat(testfile, Contains(search))
+
+    def test_ste_open_file(self):
+        search = "This is always available."
+        testfile = fetcher.get(host + ste_open_test_file)
+        self.assertThat(testfile, Contains(search))
+
+    def test_per_file_accept_license_samsung_file(self):
+        search = "This is protected with click-through Samsung license."
+        testfile = fetcher.get(host + per_file_samsung_test_file)
+        fetcher.close()
+        if os.path.exists("%s/cookies.txt" % docroot):
+            os.rename("%s/cookies.txt" % docroot,
+                    "%s/cookies.samsung" % docroot)
+        self.assertThat(testfile, Contains(search))
+
+    def test_per_file_accept_license_ste_file(self):
+        search = "This is protected with click-through ST-E license."
+        testfile = fetcher.get(host + per_file_ste_test_file)
+        fetcher.close()
+        if os.path.exists("%s/cookies.txt" % docroot):
+            os.rename("%s/cookies.txt" % docroot, "%s/cookies.ste" % docroot)
+        self.assertThat(testfile, Contains(search))
+
+    def test_per_file_license_accepted_samsung(self):
+        search = "This is protected with click-through Samsung license."
+        os.rename("%s/cookies.samsung" % docroot, "%s/cookies.txt" % docroot)
+        testfile = fetcher.get(host + per_file_samsung_test_file, ignore_license=True)
+        self.assertThat(testfile, Contains(search))
+
+    def test_per_file_license_accepted_ste(self):
+        search = "This is protected with click-through ST-E license."
+        os.rename("%s/cookies.ste" % docroot, "%s/cookies.txt" % docroot)
+        testfile = fetcher.get(host + per_file_ste_test_file, ignore_license=True)
+        self.assertThat(testfile, Contains(search))
+
+    def test_per_file_non_protected_dirs(self):
+        search = "MANIFEST"
+        testfile = fetcher.get(host + per_file_not_protected_test_file)
+        self.assertThat(testfile, Contains(search))
+
+    def test_dir_containing_only_dirs(self):
+        search = "Index of /android/~linaro-android"
+        testfile = fetcher.get(host + dirs_only_dir)
+        self.assertThat(testfile, Contains(search))