BOINC / boinc

html/inc/boinc_db.inc

Doc Comments +124 added lines

@@ -40,6 +40,10 @@ 
     // 2: only use replica_db_user, only try replica_db_host
     // can be set projectwide using <replica_fallback_mode>
     //
+
+    /**
+     * @param boolean $readonly
+     */
     static function get_aux($readonly, $fallback_mode = 0) {
         $config = get_config();
         $user = parse_config($config, '<db_user>');
@@ -196,6 +200,10 @@ 
         $db = BoincDb::get();
         return $db->count('user', $clause);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('user', $field);
@@ -208,6 +216,10 @@ 
         $db = BoincDb::get();
         return $db->enum('user', 'BoincUser', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -225,10 +237,19 @@ 
         $db->delete_aux('profile', "userid=$this->id");
         return $db->delete($this, 'user');
     }
+
+    /**
+     * @param string $field
+     */
     static function sum($field) {
         $db = BoincDb::get();
         return $db->sum('user', $field);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('user', $field, $clause, $pct);
@@ -237,6 +258,10 @@ 
 
 class BoincTeam {
     static $cache;
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         $ret = $db->insert('team', $clause);
@@ -274,14 +299,27 @@ 
         $db = BoincDb::get();
         return $db->delete($this, 'team');
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function percentile($field, $clause, $pct) {
         $db = BoincDb::get();
         return $db->percentile('team', $field, $clause, $pct);
     }
+
+    /**
+     * @param string $field
+     */
     static function max($field) {
         $db = BoincDb::get();
         return $db->max('team', $field);
     }
+
+    /**
+     * @param string $fields
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -318,6 +356,12 @@ 
         $db = BoincDb::get();
         return $db->enum('host', 'BoincHost', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields(
@@ -350,6 +394,11 @@ 
         $db = BoincDb::get();
         return $db->enum('result', 'BoincResult', $where_clause);
     }
+
+	/**
+	 * @param string $fields
+	 * @param string $where_clause
+	 */
 	static function enum_fields($fields, $where_clause, $order_clause) {
         $db = BoincDb::get();
 		return $db->enum_fields('result', 'BoincResult', $fields, $where_clause, $order_clause);
@@ -404,6 +453,10 @@ 
         $db = BoincDb::get();
         return $db->update_aux('workunit', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function count($clause) {
         $db = BoincDb::get();
         return $db->count('workunit', $clause);
@@ -419,6 +472,10 @@ 
         $db = BoincDb::get();
         return $db->lookup('app', 'BoincApp', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('app', 'BoincApp', $where_clause);
@@ -433,6 +490,11 @@ 
         $db = BoincDb::get();
         return $db->update($this, 'app', $clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause=null) {
         $db = BoincDb::get();
         return $db->sum('app', $field, $clause);
@@ -465,6 +527,10 @@ 
 }
 
 class BoincProfile {
+
+    /**
+     * @param string $fields
+     */
     static function lookup_fields($fields, $clause) {
         $db = BoincDb::get();
         return $db->lookup_fields('profile', 'BoincProfile', $fields, $clause);
@@ -481,18 +547,37 @@ 
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause.' where userid='.$this->userid);
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('profile', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         return $db->insert('profile', $clause);
     }
+
+    /**
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum($where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum('profile', 'BoincProfile', $where_clause, $order_clause);
     }
+
+    /**
+     * @param string $fields
+     * @param string $where_clause
+     * @param string $order_clause
+     */
     static function enum_fields($fields, $where_clause=null, $order_clause=null) {
         $db = BoincDb::get();
         return $db->enum_fields('profile', 'BoincProfile', $fields, $where_clause, $order_clause);
@@ -560,6 +645,10 @@ 
 }
 
 class BoincPlatform {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('platform', 'BoincPlatform', $where_clause);
@@ -640,6 +729,10 @@ 
 }
 
 class BoincBadge {
+
+    /**
+     * @param string $where_clause
+     */
     static function enum($where_clause) {
         $db = BoincDb::get();
         return $db->enum('badge', 'BoincBadge', $where_clause);
@@ -735,6 +828,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_user', 'BoincCreditUser', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_user', $field, $clause);
@@ -747,6 +845,11 @@ 
         $db = BoincDb::get();
         $db->delete_aux('credit_user', "userid=$user->id");
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('user', 'credit_user', 'id', 'userid', 'BoincCreditUser', '*', $where_clause, $order_clause, $limit);
@@ -762,6 +865,11 @@ 
         $db = BoincDb::get();
         return $db->enum('credit_team', 'BoincCreditTeam', $where_clause);
     }
+
+    /**
+     * @param string $field
+     * @param string $clause
+     */
     static function sum($field, $clause) {
         $db = BoincDb::get();
         return $db->sum('credit_team', $field, $clause);
@@ -770,6 +878,11 @@ 
         $db = BoincDb::get();
         return $db->update_aux('credit_team', $clause);
     }
+
+    /**
+     * @param string $order_clause
+     * @param string $limit
+     */
     static function get_list($where_clause, $order_clause, $limit) {
         $db = BoincDB::get();
         return $db->get_list('team', 'credit_team', 'id', 'teamid', 'BoincCreditTeam', '*', $where_clause, $order_clause, $limit);
@@ -783,6 +896,9 @@ 
         return $db->lookup('token', 'BoincToken', $clause);
     }
     
+    /**
+     * @param string $type
+     */
     static function lookup_valid_token($userid, $token, $type) {
         $db = BoincDb::get();
         $token = BoincDb::escape_string($token);
@@ -795,6 +911,9 @@ 
         return $db->enum('token', 'BoincToken', $where_clause);
     }
 
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         return $db->insert('token', $clause);
@@ -818,6 +937,11 @@ 
 // 
 // apply this to any user-supplied strings used in queries
 // 
+/**
+ * @param string $x
+ *
+ * @return string
+ */
 function boinc_real_escape_string($x) {
     if (version_compare(phpversion(),"4.3.0")>=0) {
         return BoincDb::escape_string($x);

html/ops/test_token.php

Indentation +2 added lines, -2 removed lines

@@ -28,13 +28,13 @@
 echo "---------------\n";
 $boincToken = BoincToken::lookup_valid_token(0, $token, 'T');
 if ( $boincToken != null ) {
-   echo "Found valid token\n";
+    echo "Found valid token\n";
 }
 
 echo "---------------\n";
 $boincToken = BoincToken::lookup_valid_token(0, 'notrealtoken', 'T');
 if ( $boincToken == null ) {
-   echo "Successfully didn't find invalid token\n";
+    echo "Successfully didn't find invalid token\n";
 }
 
 

Spacing +15 added lines, -15 removed lines

@@ -11,40 +11,40 @@
 BoincToken::insert("(token,userid,type,create_time, expire_time) values ('$token', 0, 'T', $now, $now+3600)");
 
 $boincTokens = BoincToken::enum("userid=0");
-foreach($boincTokens as $boincToken) {
-    echo $boincToken->token . "\n";
-    echo $boincToken->userid . "\n";
-    echo $boincToken->type . "\n";
-    echo $boincToken->create_time . "\n";
-    echo $boincToken->expire_time . "\n";
+foreach ($boincTokens as $boincToken) {
+    echo $boincToken->token."\n";
+    echo $boincToken->userid."\n";
+    echo $boincToken->type."\n";
+    echo $boincToken->create_time."\n";
+    echo $boincToken->expire_time."\n";
 }
 
 echo "---------------\n";
 $boincToken = BoincToken::lookup("userid=0");
-echo $boincToken->token . "\n";
-echo $boincToken->userid . "\n";
-echo $boincToken->type . "\n";
-echo $boincToken->create_time . "\n";
-echo $boincToken->expire_time . "\n";
+echo $boincToken->token."\n";
+echo $boincToken->userid."\n";
+echo $boincToken->type."\n";
+echo $boincToken->create_time."\n";
+echo $boincToken->expire_time."\n";
 
 echo "---------------\n";
 $boincToken = BoincToken::lookup_valid_token(0, $token, 'T');
-if ( $boincToken != null ) {
+if ($boincToken != null) {
    echo "Found valid token\n";
 }
 
 echo "---------------\n";
 $boincToken = BoincToken::lookup_valid_token(0, 'notrealtoken', 'T');
-if ( $boincToken == null ) {
+if ($boincToken == null) {
    echo "Successfully didn't find invalid token\n";
 }
 
 
 echo "---------------\n";
 $user = new BoincUser();
-$user->id=0;
+$user->id = 0;
 $token = create_confirm_delete_account_token($user);
-if ( is_valid_delete_account_token($user->id, $token) ) {
+if (is_valid_delete_account_token($user->id, $token)) {
     echo "Successfully created and validated delete account token";
 }
 

html/inc/token.inc

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
     $token = random_string();
     $now = time();
     $ret = BoincToken::insert("(token,userid,type,create_time,expire_time) values ('$token', $user->id, '".TOKEN_TYPE_DELETE_ACCOUNT."', $now, $now+".TOKEN_DURATION_ONE_DAY.")");
-    if ( !$ret ) {
+    if (!$ret) {
         return null;
     }
     return $token;
@@ -37,7 +37,7 @@ 
 
 function is_valid_delete_account_token($userid, $token) {
     $boincToken = BoincToken::lookup_valid_token($userid, $token, TOKEN_TYPE_DELETE_ACCOUNT);
-    if ( $boincToken == null ) {
+    if ($boincToken == null) {
         return false;
     }
     return true;