Asset location refactor to allow for more caching

- Added new htaccess options for Expires and Cache-Control headers
- Removed Etag headers
- Moved all production assets to be prefixed with the version as a path

Author: bgrawi

.htaccess

@@ -1,24 +1,57 @@
-RewriteEngine On
-
-#Legacy Rewrites
-RewriteCond %{QUERY_STRING} ^id=(.*)$ [NC]
-RewriteRule ^schedule.php$ /schedule/%1? [NC,L,R=302]
-
-
-# Let old ScheduleMaker handle Resig's schedules for now
-#RewriteCond %{QUERY_STRING} ^mode=old&id=(.*)$ [NC]
-RewriteRule ^schedule.php$ http://schedule-old.csh.rit.edu/schedule.php [NC,L,R=302]
-
-RewriteCond %{HTTP:Accept} application/json [NC]
-RewriteRule ^(schedule|generate|entity|search|status|rmp)(?:/([^/]*))*$ api/$1.php [L]
-RewriteRule ^schedule/[^/]*/ical$ api/schedule.php [L]
-
-
-# Don't rewrite files or directories
-RewriteCond %{REQUEST_FILENAME} -f [OR]
-RewriteCond %{REQUEST_FILENAME} -d
-RewriteRule ^ - [L]
-
-
-# Rewrite everything else to index.html to allow html5 state links
-RewriteRule ^ index.php [L]
+# COMPRESSION
+<IfModule mod_deflate.c>
+    AddOutputFilterByType DEFLATE text/text text/html text/plain text/xml text/css application/x-javascript application/javascript application/json
+</IfModule>
+
+# REWRITES
+<IfModule mod_rewrite.c>
+    RewriteEngine On
+
+    # Let the old ScheduleMaker handle Resig's schedules for now
+    #RewriteCond %{QUERY_STRING} ^mode=old&id=(.*)$ [NC]
+    RewriteRule ^schedule.php$ http://schedule-old.csh.rit.edu/schedule.php [NC,L,R=302]
+
+    # Legacy Rewrites from previous version
+    RewriteCond %{QUERY_STRING} ^id=(.*)$ [NC]
+    RewriteRule ^schedule.php$ /schedule/%1? [NC,L,R=302]
+    RewriteRule ^(generate|roulette|search|status).php$ /$1 [R=302,L]
+
+    # Rewrite any request that wants json to the api directory
+    RewriteCond %{HTTP:Accept} application/json [NC]
+    RewriteRule ^(schedule|generate|entity|search|status|rmp)(?:/([^/]*))*$ api/$1.php [L]
+    RewriteRule ^schedule/[^/]*/ical$ api/schedule.php [L]
+
+    # Don't rewrite files or directories
+    RewriteCond %{REQUEST_FILENAME} -f [OR]
+    RewriteCond %{REQUEST_FILENAME} -d
+    RewriteRule ^ - [L]
+
+    # Rewrite everything else to index.html to allow html5 state links
+    RewriteRule ^ index.php [L]
+</IfModule>
+
+# CACHING
+
+# Set max-age one year in the future for all static assets
+<IfModule mod_headers.c>
+    # Allow caching for all assets
+    <FilesMatch "(.*)\.(js|css|png|jpg|html)$">
+        Header set Cache-Control "max-age=29030400, public"
+        Header unset ETag
+        FileETag None
+    </FilesMatch>
+</IfModule>
+
+# Cache Everything, set their expiration date one year in the future
+<IfModule mod_expires.c>
+    ExpiresActive On
+    ExpiresDefault A300
+    ExpiresByType image/x-icon A29030400
+    ExpiresByType application/javascript A29030400
+    ExpiresByType text/css A29030400
+    ExpiresByType image/gif A29030400
+    ExpiresByType image/png A29030400
+    ExpiresByType image/jpeg A29030400
+    ExpiresByType text/plain A29030400
+    ExpiresByType text/html A29030400
+</IfModule>

assets/src/modules/sm/App/directives/courseCartDirective.js

@@ -1,6 +1,6 @@
 angular.module('sm').directive("courseCart", function() {
 	return {
 		restrict: 'A',
-		templateUrl: '/assets/prod/modules/sm/App/templates/cart.min.html'
+		templateUrl: '<%=modulePath%>App/templates/cart.min.html'
 	};
 });

assets/src/modules/sm/Generate/directives/scheduleCourseDirective.js

@@ -1,6 +1,6 @@
 angular.module('sm').directive("scheduleCourse", function(){
 	  return {
 	    restrict: "C",
-	    templateUrl: '/assets/prod/modules/sm/Generate/templates/courseselect.min.html',
+	    templateUrl: '<%=modulePath%>Generate/templates/courseselect.min.html',
 	  };
 });

assets/src/modules/sm/Schedule/controllers/SchedulePrintController.js

@@ -44,7 +44,7 @@ angular.module('sm').controller("SchedulePrintController", function($scope, $loc
 
 	localStorage.setItem("reloadSchedule", null);
 
-	$scope.print = window.print.bind(window);
+	$scope.printFn = window.print.bind(window);
 
 	$scope.globalUI.layoutClass = "print";
 });

assets/src/modules/sm/Schedule/directives/scheduleDirective.js

@@ -182,7 +182,7 @@ angular.module('sm').directive('schedule', function($timeout, $filter) {
 
 	return {
 		restrict: 'A',
-		templateUrl: '/assets/prod/modules/sm/Schedule/templates/scheduleitem.min.html',
+		templateUrl: '<%=modulePath%>Schedule/templates/scheduleitem.min.html',
 		link: {
 			pre: function(scope, elm, attrs) {
 				scope.scheduleController = new Schedule(scope);

assets/src/modules/sm/Schedule/templates/schedule.print.html

@@ -25,7 +25,7 @@ <h3 class="panel-title">
 					</div>
 				</div>
 				<div class="col-sm-2">
-					<button ng-click="print()" type="button" class="btn btn-info btn-block">
+					<button ng-click="printFn()" type="button" class="btn btn-info btn-block">
 						<i class="fa fa-print"></i> Print
 					</button>
 				</div>

assets/src/modules/sm/app.js

@@ -13,7 +13,7 @@ angular.module('sm', ['ngAnimate', 'ngSanitize', 'ui.router'])
 
 	$urlRouterProvider.otherwise("/404");
 
-	var tplBase = '/assets/prod/modules/sm/';
+	var tplBase = '<%=modulePath%>';
 
 	var tplPath = function(submodule, name) {
 		return tplBase + submodule + '/templates/' + name + '.min.html';

gulpfile.js

@@ -1,7 +1,19 @@
+// Get the version info
+var pkg = require('./package.json');
+if(!pkg.version) {
+	console.error("No version information in package.json.");
+	proccess.exit();
+}
+
+var assetsRoot = {
+	src: 'assets/src/',
+	dest: 'assets/prod/'
+}
+
 // Set up core routes
 var modulesRoot = {
-	src: 'assets/src/modules/',
-	dest: 'assets/prod/modules/'
+	src: assetsRoot.src + 'modules/',
+	dest: assetsRoot.dest + pkg.version + '/modules/'
 };
 
 var assetModuleList = {
@@ -83,6 +95,7 @@ var sourcemaps = require('gulp-sourcemaps');
 var replace = require('gulp-replace');
 var es = require('event-stream');
 var minifyCSS = require('gulp-minify-css');
+var template = require('gulp-template');
 
 // Define Tasks
 gulp.task('templates', function() {
@@ -105,6 +118,7 @@ gulp.task('templates', function() {
 gulp.task('scripts', function() {
 	var mapped = doFor('scripts', function(scriptPaths) {
 		return gulp.src(scriptPaths.src)
+		.pipe(template({modulePath: scriptPaths.dest}))
 		.pipe(ngmin())
 		.pipe(concat('dist.js'))
 		.pipe(gulp.dest(scriptPaths.dest))
@@ -152,6 +166,11 @@ gulp.task('clean', function() {
     .pipe(clean());
 });
 
+gulp.task('cleanAll', function() {
+  return gulp.src(assetsRoot.dest, {read: false})
+    .pipe(clean());
+});
+
 gulp.task('build', ['clean'], function() {
 	return gulp.start('scripts', 'templates', 'styles');
 });

index.php

@@ -50,7 +50,7 @@
 		<!-- STYLE SHEETS -->
 		<link rel="stylesheet" href="//brick.a.ssl.fastly.net/Roboto:300,700">
 		<link rel="stylesheet" href="//netdna.bootstrapcdn.com/font-awesome/4.0.1/css/font-awesome.css">
-		<link rel="stylesheet" href="<?=$HTTPROOTADDRESS?>assets/prod/modules/sm/dist.css?v=<?=$APP_VERSION?>">
+		<link rel="stylesheet" href="<?=$HTTPROOTADDRESS?>assets/prod/<?=$APP_VERSION?>/modules/sm/dist.min.css">
 
 		<!-- OPEN GRAPH TAGS -->
 		<meta name="twitter:card" content="photo"> 
@@ -121,7 +121,7 @@
 		<script src="//cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.15/angular-animate.min.js"></script>
 		<script src="//cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.15/angular-sanitize.min.js"></script>
 		<script src="//cdnjs.cloudflare.com/ajax/libs/angular-ui-router/0.2.8/angular-ui-router.min.js"></script>
-		<script src="<?=$HTTPROOTADDRESS?>assets/prod/modules/sm/dist.min.js?v=<?=$APP_VERSION?>"></script>
+		<script src="<?=$HTTPROOTADDRESS?>assets/prod/<?=$APP_VERSION?>/modules/sm/dist.min.js"></script>
 	</body>
 </html>
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "schedulemaker",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "private": true,
   "description": "A course database lookup tool and schedule building web application for use at Rochester Institute of Technology.",
   "main": "index.php",
@@ -39,7 +39,7 @@
     "url": "https://github.com/ComputerScienceHouse/schedulemaker/issues"
   },
   "config": {
-	"stateVersion": 1
+    "stateVersion": 1
   },
   "homepage": "http://schedule.csh.rit.edu",
   "devDependencies": {
@@ -55,6 +55,7 @@
     "gulp-sourcemaps": "^0.2.1",
     "gulp-replace": "^0.2.0",
     "gulp-minify-css": "^0.3.1",
-    "gulp-htmlmin": "^0.1.2"
+    "gulp-htmlmin": "^0.1.2",
+    "gulp-template": "^0.1.1"
   }
 }