pushing some good things

Author: paultag

controller.php

@@ -10,6 +10,10 @@
 
 if ( ! isset ( $_SESSION['id'] ) ) {
 	$_SESSION['id'] = -1;
+	/*
+	 * This sets the id to -1 if the user
+	 * is not logged in
+	 */
 }
 
 $app_root        = dirname(  __FILE__ ) . "/";
@@ -22,47 +26,46 @@
 include( $app_root . "libs/php/easter.php" );
 include( $app_root . "libs/php/core.php" );
 
-if ($handle = opendir( $app_root . "model/" )) {
-	while (false !== ($file = readdir($handle))) {
-		// The "i" after the pattern delimiter indicates a case-insensitive search
-		if ( $file != "." && $file != ".." ) {
-			$ftest = $file;
+if ($handle = opendir( $app_root . "model/" )) { // open up the model directory
+	while (false !== ($file = readdir($handle))) { // for each file
+		if ( $file != "." && $file != ".." ) { // ignore . / ..
+			$ftest = $file;                // "backup" file
 			if (preg_match("/.*\.php$/i", $ftest)) {
-				include( $app_root . "model/" . $file );
+				include( $app_root . "model/" . $file ); // include all .php files
 			}
 		}
 	}
 }
 
-header( "Wisdom-Turd: " . getQuip() );
+header( "Wisdom-Turd: " . getQuip() ); // wisdom turds!
 
 if ( file_exists( $app_root . "install/install.php" ) ) {
-	include( $app_root . "install/install.php" );
-	include( $app_root . "view/view.php" );
-	exit(0);
+	include( $app_root . "install/install.php" ); // Disable access
+	include( $app_root . "view/view.php" );       // if we're not set up.
+	exit(0); // stop executing the controller code
 }
 
 $p = htmlentities( $_GET['p'], ENT_QUOTES);
 $toks = explode( "/", $p );
 
 $argv = $toks;
-$argc = sizeof( $toks );
+$argc = sizeof( $toks ); // these get passed to the view
 
 if (
 	isset ( $toks[0] ) &&
 	$toks[0] != ""
-) {
+) { // if there's a directive, use it.
 	$idz = $app_root . "content/" . basename( $toks[0] ) . ".php";
 	if ( file_exists( $idz ) ) {
-		include( $idz );
+		include( $idz );     // all good :)
 	} else {
-		include( $app_root . "content/default.php" );
+		include( $app_root . "content/default.php" ); // fake the err.
 	}
 } else {
-	header("Location: $SITE_PREFIX");
+	header("Location: $SITE_PREFIX"); // redirect to the app root
 }
 
-include( $app_root . "view/view.php" );
+include( $app_root . "view/view.php" ); // include the head/foot
 
 ?>
 

model/bug.php

@@ -8,45 +8,44 @@
  * @license: AGPLv3
  */
 
-if ( ! class_exists ( "bug" ) ) {
+if ( ! class_exists ( "bug" ) ) { // if we've included twice
 
-if ( ! class_exists( "dbobj" ) ) {
-        // last ditch...
+if ( ! class_exists( "dbobj" ) ) { // ensure we have the superclass
         $model_root = dirname(  __FILE__ ) . "/";
         include( $model_root . "dbobj.php" );
 }
 
-include ( $model_root . "user.php" );
-include ( $model_root . "project.php" );
+include ( $model_root . "user.php" );     // we need the user
+include ( $model_root . "project.php" );  // and project models
 
 class bug extends dbobj {
 	function bug() {
-		dbobj::dbobj("bugs", "bID");
+		dbobj::dbobj("bugs", "bID"); // SQL table `bugs', PK `bID'
 	}
 	// Let's add in some functionallity for user stuff.
 	function getOwner( $bID ) {
 		$this->getAllByPK( $bID );
 		$row = $this->getNext();
 		$u = new user();
 		$u->getAllByPK( $row['owner'] );
-		return $u->getNext();
+		return $u->getNext(); // ( first row :P )
 	}
 	function getReporter( $bID ) {
 		$this->getAllByPK( $bID );
 		$row = $this->getNext();
 		$u = new user();
 		$u->getAllByPK( $row['reporter'] );
-		return $u->getNext();
+		return $u->getNext(); // ( first row :D )
 	}
 	function getProject( $pID ) {
 		$this->getAllByPK( $pID );
 		$row = $this->getNext();
 		$p = new project();
 		$p->getAllByPK( $row['package'] );
-		return $p->getNext();
+		return $p->getNext(); // ( first row :) )
 	}
 
-  function getAllBugs() {
+	function getAllBugs() {
 		global $TABLE_PREFIX;
 		$sql = new sql();
 		$sql->query("SELECT * FROM " . $TABLE_PREFIX . "bugs;" );

model/cacheobj.php

@@ -33,33 +33,29 @@ function cacheobj( $table, $c_field ) {
 	}
 
 	function checkAge( $ID, $minutes = '' ) {
-	  $minute = 60;
-	  $ttl = $minute * $minutes;
-	  $curTime = time();
-    $this->getAllByID( $ID );
-    $cachePull = $this->sql->getNextRow();
-	  $refTime = clean( $cachePull["timestamp"] );
-	  $content = clean( $cachePull["cached_contents"] );
-	  $timeDifference = $curTime - $refTime;
-    
-    $ret = $ttl - $timeDifference;
-    
-    return $ret;
+		$minute = 60;
+		$ttl = $minute * $minutes;
+		$curTime = time();
+		$this->getAllByID( $ID );
+		$cachePull = $this->sql->getNextRow();
+		$refTime = clean( $cachePull["timestamp"] );
+		$content = clean( $cachePull["cached_contents"] );
+		$timeDifference = $curTime - $refTime;
+		$ret = $ttl - $timeDifference;
+		return $ret;
 	}
 
 	function updateStamp( $ID ) {
-    $this->sql->query( "UPDATE " . $this->table . " SET timestamp=" . time() . " WHERE " . $this->c_field . "='" . $ID . "' ;" );
+		$this->sql->query( "UPDATE " . $this->table . " SET timestamp=" . time() . " WHERE " . $this->c_field . "='" . $ID . "' ;" );
 	}
 
-  function updateCached( $ID, $contents ) {
-    $this->sql->query( "UPDATE " . $this->table . " SET cached_contents='" . $contents . "' WHERE " . $this->c_field . "='" . $ID . "' ;" );
-  }
+	function updateCached( $ID, $contents ) {
+		$this->sql->query( "UPDATE " . $this->table . " SET cached_contents='" . $contents . "' WHERE " . $this->c_field . "='" . $ID . "' ;" );
+	}
 
 	function getAllByID( $ID ) {
-    $this->sql->query( "SELECT * FROM " . $this->table . " WHERE " . $this->c_field . " = '" . $ID . "';" );
-	}	
-	
-	
+		$this->sql->query( "SELECT * FROM " . $this->table . " WHERE " . $this->c_field . " = '" . $ID . "';" );
+	}
 }
 
 }

model/events.php

@@ -14,7 +14,7 @@ class events {
 
 	function events() {
 		$model_root = dirname(  __FILE__ ) . "/";
-		$event_root = $model_root . "../events/";
+		$event_root = $model_root . "../events/"; // full of fifo
 		$this->folder_root = $event_root;
 	}
 
@@ -32,6 +32,17 @@ function broadcast( $note ) {
 				}
 			}
 		}
+	/*
+	 * OK what just went on was a bit confusing. Here's what it's doing:
+         *
+         * Find all files that match "*.hook" in ../events/ ( whube/events )
+         * For each file in events ( that maches ) 
+         *   - Write to the file
+         *
+	 * With a UNIX FIFO pipe, this Write will block until something
+	 * ( the plugin ) reads it.
+         *
+         */
 	}
 }
 

model/twitter.php

@@ -10,38 +10,37 @@
  */
 
 if ( ! class_exists( "cacheobj" ) ) {
-  // last ditch...
-  $model_root = dirname(  __FILE__ ) . "/";
-  include( $model_root . "cacheobj.php" );
+	// last ditch...
+	$model_root = dirname(  __FILE__ ) . "/";
+	include( $model_root . "cacheobj.php" );
 }
 
 if ( ! class_exists( "twitter" ) ) {
 class twitter extends cacheobj {
-  var $count;
-  var $friend_count;
-  var $id;
+	var $count;
+	var $friend_count;
+	var $id;
 
-  function twitter( $count = 1, $friend_count = 10 ) {
+	function twitter( $count = 1, $friend_count = 10 ) {
 		cacheobj::cacheobj("cache", "cache_id");
-	  $this->count = $count;
-	  $this->friend_count = $friend_count;
-	  $model_root = basename( __FILE__ ) . "/";
-	  include( $model_root . "../conf/twitter.php" );
-	  $this->id = $id;
-  }
+		$this->count = $count;
+		$this->friend_count = $friend_count;
+		$model_root = basename( __FILE__ ) . "/";
+		include( $model_root . "../conf/twitter.php" );
+		$this->id = $id;
+	}
+
+	function showUpdates() {
+		$age = $this->checkAge( "tweeter", 5 );
+		if( $age <= 0 ) {
+			$this->gatherTweet();
+		}
+		$this->getAllByID( "tweeter" );
+		$cached = $this->sql->getNextRow();
 
-  function showUpdates() {
-    $age = $this->checkAge( "tweeter", 5 );
-    if( $age <= 0 ) {
-      $this->gatherTweet();
-    }
-    
-    $this->getAllByID( "tweeter" );
-    $cached = $this->sql->getNextRow();
-    
-    $ret = $cached["cached_contents"];
-    return $ret;
-  }
+		$ret = $cached["cached_contents"];
+		return $ret;
+	}
 
   	function gatherTweet() {
 		$id     = $this->id;