WebFund 2014W Midterm Review - Revision history

Leah at 18:21, 13 March 2014

2014-03-13T18:21:53Z

← Older revision		Revision as of 18:21, 13 March 2014
Line 16:		Line 16:

	Asynchronous vs Synchronous:		Asynchronous vs Synchronous:
	* The analogy that Anil ~~give~~ was that synchronous is like a 5 year old child waiting for cookies to be baked. He asks "is it ready yet?" every 5 minutes. He's not doing anything else. Asynchronous is like a 8 year old child, who does something else (e.g. read a book) while he waits for the cookies to be baked		* The analogy that Anil gave was that synchronous is like a 5 year old child waiting for cookies to be baked. He asks "is it ready yet?" every 5 minutes. He's not doing anything else. Asynchronous is like a 8 year old child, who does something else (e.g. read a book) while he waits for the cookies to be baked

	==Source for small-adventure==		==Source for small-adventure==

Leah at 18:21, 13 March 2014

2014-03-13T18:21:06Z

← Older revision		Revision as of 18:21, 13 March 2014
Line 13:		Line 13:
	What is the state of the system after app,js runs?		What is the state of the system after app,js runs?
	* We don't know what it is because you only know when the call back is run.		* We don't know what it is because you only know when the call back is run.
	* app.get/app.post are only run ONCE! It tells the web server what to do when http GET and POST requests are received at specific urls~~. Note that these are only run ONCE, before the web server starts listening for incoming connections~~.		* app.get/app.post are only run ONCE, before the web server starts listening for incoming connections. It tells the web server what to do when http GET and POST requests are received at specific urls.

	Asynchronous vs Synchronous:		Asynchronous vs Synchronous:

Leah at 18:20, 13 March 2014

2014-03-13T18:20:18Z

← Older revision		Revision as of 18:20, 13 March 2014
Line 9:		Line 9:

	==Midterm Review Notes==		==Midterm Review Notes==
	~~Note that most~~ of the notes are written inline in the source code to make the line it refers to more clear:		* Most of the notes are written inline in the source code to make the line it refers to more clear:

	What is the state of the system after app,js runs?		What is the state of the system after app,js runs?

Leah at 18:19, 13 March 2014

2014-03-13T18:19:48Z

← Older revision		Revision as of 18:19, 13 March 2014
Line 244:		Line 244:
	===views/index.jade===		===views/index.jade===
	<source line lang="html4strict">		<source line lang="html4strict">
	extends layout		extends layout //inherits formatting from layout.jade

	block header		block header
	script(src='/javascripts/home.js')		script(src='/javascripts/home.js') //applies javascript. Affects the register button

	block content		block content
Line 277:		Line 277:
	p Go to:		p Go to:
	ul		ul
	each theExit in roomExits		each theExit in roomExits //exits are listed for every room
	li		li
	a(href= theExit) #{theExit}		a(href= theExit) #{theExit}
	form(action="/quit", method="post")		form(action="/quit", method="post")
	button(type="submit") Quit		button(type="submit") Quit //creates a quit button on every room
	</source>		</source>

Leah at 18:14, 13 March 2014

2014-03-13T18:14:35Z

← Older revision		Revision as of 18:14, 13 March 2014
Line 7:		Line 7:

	No new tutorial this week; however, two TAs/instructors will be in the lab on Thursday 4-5:30 and Friday 8:30-10 to answer last minute questions.		No new tutorial this week; however, two TAs/instructors will be in the lab on Thursday 4-5:30 and Friday 8:30-10 to answer last minute questions.

			==Midterm Review Notes==
			Note that most of the notes are written inline in the source code to make the line it refers to more clear:

			What is the state of the system after app,js runs?
			* We don't know what it is because you only know when the call back is run.
			* app.get/app.post are only run ONCE! It tells the web server what to do when http GET and POST requests are received at specific urls. Note that these are only run ONCE, before the web server starts listening for incoming connections.

			Asynchronous vs Synchronous:
			* The analogy that Anil give was that synchronous is like a 5 year old child waiting for cookies to be baked. He asks "is it ready yet?" every 5 minutes. He's not doing anything else. Asynchronous is like a 8 year old child, who does something else (e.g. read a book) while he waits for the cookies to be baked

	==Source for small-adventure==		==Source for small-adventure==
Line 35:		Line 45:

	app.use(app.router);		app.use(app.router);
	app.use(express.static(path.join(__dirname, 'public')));		app.use(express.static(path.join(__dirname, 'public'))); //serves static files from the root path. The CSS files and fonts are all stored in the public directory, which is made publicly accessible by this line.

	if ('development' == app.get('env')) {		if ('development' == app.get('env')) {
Line 41:		Line 51:
	}		}

	app.get('/', routes.redirectLoggedIn, routes.index);		//The purpose of these lines is to setup routes. It tells the web server what to do when http GET and POST requests are received at specific urls. Note that these are only run ONCE, before the web server starts listening for incoming connections.
			app.get('/', routes.redirectLoggedIn, routes.index); //requests the home page (https://localhost:3000)
	app.post("/register", routes.register);		app.post("/register", routes.register);
	app.post("/start", routes.start);		app.post("/start", routes.start);
Line 49:		Line 60:
	var i, theRoom;		var i, theRoom;

	routes.getRooms().toArray(		routes.getRooms().toArray( //a call to getRooms and a call toArray, which is a method of the collections object. This runs the query and puts the results into an array
	function(err, docs) {		function(err, docs) {
	if (err) {		if (err) {
Line 57:		Line 68:
	var activeRooms = docs[0].activeRooms;		var activeRooms = docs[0].activeRooms;

	activeRooms.forEach(function(roomName) {		activeRooms.forEach(function(roomName) { //roomName is our index variable, we get the room element. ActiveRooms is an array of roomName.
	console.log('Creating room: ' + roomName);		console.log('Creating room: ' + roomName);
	app.get('/' + roomName,		app.get('/' + roomName,
Line 90:		Line 101:
	roomsCollection = db.collection('rooms');		roomsCollection = db.collection('rooms');

	callback();		callback(); //is createRooms. We do the callback after the database is established because we need to setup the database first.
	});		});
	}		}

			//assigned to the properties of the exports object
	exports.index = function(req, res){		exports.index = function(req, res){
	res.render('index', { title: 'COMP 2406 Small Adventure Demo',		res.render('index', { title: 'COMP 2406 Small Adventure Demo',
Line 112:		Line 125:
	}		}
	exports.register = function(req, res) {		exports.register = function(req, res) {
	var playername = req.body.playername;		var playername = req.body.playername; //req.body retrieves the value for the playername attribute
	var password = req.body.password;		var password = req.body.password;

Line 170:		Line 183:
	}		}
	exports.makeRoomHandler = function(roomName) {		exports.makeRoomHandler = function(roomName) {
	var handler = function(req, res) {		var handler = function(req, res) { //without 'var' handler becomes a global variable
	if (req.session.player) {		if (req.session.player) {
	var player = req.session.player;		var player = req.session.player;
Line 187:		Line 200:
	throw "Couldn't find room " + roomName;		throw "Couldn't find room " + roomName;
	}		}
	res.render("room.jade", room);		res.render("room.jade", room); //renders an html page with room.jade template
	}		}
	);		);
Line 197:		Line 210:
	}		}
	exports.getRooms = function() {		exports.getRooms = function() {
	return roomsCollection.find({name: "roomList"});		return roomsCollection.find({name: "roomList"}); //finds all the rooms with the name in the roomlist
	}		}
	</source>		</source>

Leah at 17:45, 13 March 2014

2014-03-13T17:45:23Z

← Older revision		Revision as of 17:45, 13 March 2014
Line 12:		Line 12:
	===app.js===		===app.js===
	<source line lang="javascript">		<source line lang="javascript">
	var express = require('express');		var express = require('express'); //requires the express module
	var routes = require('./routes'); //same as ('/routes/index.js'). The require() method returns the exports object		var routes = require('./routes'); //same as ('/routes/index.js'). The require() method returns the exports object
	var path = require('path'); //imports the path module, or path.join will not be defined		var path = require('path'); //imports the path module, or path.join will not be defined
	var http = require('http');		var http = require('http'); //requires the http module
	var MongoStore = require('connect-mongo')(express);		var MongoStore = require('connect-mongo')(express);

Line 21:		Line 21:

	app.set('port', process.env.PORT \|\| 3000); //listens on PORT environment variable OR port 3000 if not defined		app.set('port', process.env.PORT \|\| 3000); //listens on PORT environment variable OR port 3000 if not defined
	app.set('views', path.join(__dirname, 'views'));		app.set('views', path.join(__dirname, 'views')); //sets the location for application views
	app.set('view engine', 'jade');		app.set('view engine', 'jade'); //sets the view engine, Jade
	app.use(express.favicon());		app.use(express.favicon()); //can specify where you want favicon to be found in the parameters. e.g (_dirname + 'public/favicon.ico')
	app.use(express.logger('dev'));		app.use(express.logger('dev')); //logging requests using predefined log format 'dev'. This will generate a detail log.
	app.use(express.urlencoded());		app.use(express.urlencoded()); //The body of HTTP post requests. Parses the incoming request body, converting it into request object properties

	app.use(express.cookieParser());		app.use(express.cookieParser());
	app.use(express.session({		app.use(express.session({
	cookie: {maxAge: 60000 * 20} // 20 minutes		cookie: {maxAge: 60000 * 20} // 20 minutes
	, secret: "Shh... I'm a secret"		, secret: "Shh... I'm a secret" //This is the secret that prevents attackers from creating their own fake session identifiers
	, store: new MongoStore({db: "adventure-demo"})		, store: new MongoStore({db: "adventure-demo"})
	}));		}));
Line 71:		Line 71:
	' in ' + app.get('env') + ' mode.');		' in ' + app.get('env') + ' mode.');
	});		});
			//1) createServer(): a method of http that creates and returns a server object
			//2) listen(): a method at the returned server object that starts the web server listening on a given port
			//3) app.get(): returns the port to listen on
	</source>		</source>

Leah at 17:32, 13 March 2014

2014-03-13T17:32:17Z

← Older revision		Revision as of 17:32, 13 March 2014
Line 13:		Line 13:
	<source line lang="javascript">		<source line lang="javascript">
	var express = require('express');		var express = require('express');
	var routes = require('./routes'); //the ~~require~~		var routes = require('./routes'); //same as ('/routes/index.js'). The require() method returns the exports object
	var path = require('path');		var path = require('path'); //imports the path module, or path.join will not be defined
	var http = require('http');		var http = require('http');
	var MongoStore = require('connect-mongo')(express);		var MongoStore = require('connect-mongo')(express);

	var app = express();		var app = express(); //creates an express object instance and assigns the app variable to it.

	app.set('port', process.env.PORT \|\| 3000);		app.set('port', process.env.PORT \|\| 3000); //listens on PORT environment variable OR port 3000 if not defined
	app.set('views', path.join(__dirname, 'views'));		app.set('views', path.join(__dirname, 'views'));
	app.set('view engine', 'jade');		app.set('view engine', 'jade');

Leah at 17:26, 13 March 2014

2014-03-13T17:26:08Z

← Older revision		Revision as of 17:26, 13 March 2014
Line 13:		Line 13:
	<source line lang="javascript">		<source line lang="javascript">
	var express = require('express');		var express = require('express');
	var routes = require('./routes');		var routes = require('./routes'); //the require
	var path = require('path');		var path = require('path');
	var http = require('http');		var http = require('http');

Soma at 17:56, 13 February 2014

2014-02-13T17:56:18Z

← Older revision		Revision as of 17:56, 13 February 2014
Line 1:		Line 1:
			The video from the lecture given on Feb. 12, 2014 is available:
			* [http://www.screencast.com/t/9bmB5dTEoC small at Screencast.com]
			* [http://www.screencast.com/t/nC3DlJrkoqt large at Screencast.com]
			* [http://dl.cuol.ca/capture/Anil.Somayaji/COMP_2406_2014W_Midterm_Review_-_20140212_150208_27.mp4 Original at CUOL]

	The midterm will be based on [http://homeostasis.scs.carleton.ca/~soma/webfund-2014w/midterm/small-adventure.zip small-adventure], a version of <tt>adventure-demo</tt> that has been simplified by removing the use of cryptography (https and bcrypt) along with a few other minor tweaks to reduce the size of the source code.		The midterm will be based on [http://homeostasis.scs.carleton.ca/~soma/webfund-2014w/midterm/small-adventure.zip small-adventure], a version of <tt>adventure-demo</tt> that has been simplified by removing the use of cryptography (https and bcrypt) along with a few other minor tweaks to reduce the size of the source code.

Soma: /* routes/index.js */

2014-02-12T21:39:52Z

routes/index.js

← Older revision		Revision as of 21:39, 12 February 2014
Line 162:		Line 162:
	}		}
	exports.makeRoomHandler = function(roomName) {		exports.makeRoomHandler = function(roomName) {
	handler = function(req, res) {		var handler = function(req, res) {
	if (req.session.player) {		if (req.session.player) {
	var player = req.session.player;		var player = req.session.player;
Line 192:		Line 192:
	}		}
	</source>		</source>


	===public/javascripts/home.js===		===public/javascripts/home.js===