BOINC / boinc

html/inc/profile.inc

Doc Comments +5 added lines

@@ -114,6 +114,11 @@
     return BoincProfile::delete_aux("userid=$user->id");
 }
 
+/**
+ * @param resource $image
+ * @param integer $targetWidth
+ * @param integer $targetHeight
+ */
 function scale_image(
     $image, $origWidth, $origHeight, $targetWidth, $targetHeight
 ) {

Indentation +1 added lines, -1 removed lines

@@ -191,7 +191,7 @@
     $min_credit = parse_config(get_config(), "<profile_min_credit>");
     if (!$logged_in_user && $min_credit && $user->expavg_credit < $min_credit ) {
         error_page(
-           tra("To prevent spam, profiles of users with an average credit of less than %1 are displayed only to logged-in users. We apologize for this inconvenience.", $min_credit)
+            tra("To prevent spam, profiles of users with an average credit of less than %1 are displayed only to logged-in users. We apologize for this inconvenience.", $min_credit)
         );
     }
     if (is_banished($user)) {

Spacing +10 added lines, -10 removed lines

@@ -71,7 +71,7 @@ 
     if (!$user->has_profile) return null;
     $profile = BoincProfile::lookup("userid=$user->id");
     if (!$profile->has_picture) return null;
-    if (profile_screening() && $profile->verification!=1) return null;
+    if (profile_screening() && $profile->verification != 1) return null;
     return profile_thumb_url($user->id);
 }
 
@@ -125,18 +125,18 @@ 
         return $image;
     }
 
-    ($origWidth > $origHeight)? $scalar = ($origWidth / $targetWidth) : $scalar = ($origHeight / $targetHeight);
+    ($origWidth > $origHeight) ? $scalar = ($origWidth/$targetWidth) : $scalar = ($origHeight/$targetHeight);
 
     if ($scalar != 0) {
-        $destWidth = $origWidth / $scalar;
-        $destHeight = $origHeight / $scalar;
+        $destWidth = $origWidth/$scalar;
+        $destHeight = $origHeight/$scalar;
     } else {
         $destWidth = $origWidth;
         $destHeight = $origHeight;
     }
 
     $gd_info = gd_info();
-    $newGD = (strstr($gd_info["GD Version"], "2.0")!="");
+    $newGD = (strstr($gd_info["GD Version"], "2.0") != "");
     if ($newGD) {
         // If you are using a modern PHP/GD installation that does
         // 'truecolor' images, this is what's needed.
@@ -179,7 +179,7 @@ 
         $options->htmlitems = false;
         $temp = output_transform($profile->response1, $options);
         $temp = sanitize_tags($temp);
-        $description = "(\"" . sub_sentence($temp, ' ', MAX_DESC_LENGTH, true) . "\")";
+        $description = "(\"".sub_sentence($temp, ' ', MAX_DESC_LENGTH, true)."\")";
 
     }
 
@@ -189,7 +189,7 @@ 
 
 function check_whether_to_show_profile($user, $logged_in_user) {
     $min_credit = parse_config(get_config(), "<profile_min_credit>");
-    if (!$logged_in_user && $min_credit && $user->expavg_credit < $min_credit ) {
+    if (!$logged_in_user && $min_credit && $user->expavg_credit < $min_credit) {
         error_page(
            tra("To prevent spam, profiles of users with an average credit of less than %1 are displayed only to logged-in users. We apologize for this inconvenience.", $min_credit)
         );
@@ -227,7 +227,7 @@ 
     //
     $show_picture = $profile->has_picture;
     if (profile_screening()) {
-        if (!$screen_mode && !$can_edit && $profile->verification!=1) {
+        if (!$screen_mode && !$can_edit && $profile->verification != 1) {
             $show_picture = false;
         }
     }
@@ -243,7 +243,7 @@ 
     // yet verified.  This will tell them if other users can't view it yet, or
     // if there is a problem with it and they need to replace it.
     //
-    if (profile_screening() && $profile->has_picture && $can_edit && $profile->verification!=1) {
+    if (profile_screening() && $profile->has_picture && $can_edit && $profile->verification != 1) {
         row1(offensive_profile_warning($profile->verification));
     }
 
@@ -276,6 +276,6 @@ 
     }
 }
 
-$cvs_version_tracker[]="\$Id$";  //Generated automatically - do not edit
+$cvs_version_tracker[] = "\$Id$"; //Generated automatically - do not edit
 
 ?>

html/inc/result.inc

Doc Comments +15 added lines

@@ -53,6 +53,9 @@ 
     return $platforms[$id];
 }
 
+/**
+ * @param string $rsc_name
+ */
 function anon_platform_string($result, $rsc_name=null) {
     $app = get_app($result->appid);
     $n = $app->user_friendly_name."<br>".  tra("Anonymous platform");
@@ -92,6 +95,9 @@ 
     return "$n v$v $c<br>$platform->name";
 }
 
+/**
+ * @param string $string_to_show
+ */
 function result_granted_credit_string($result, $string_to_show) {
     if ($result->server_state == RESULT_SERVER_STATE_IN_PROGRESS && $result->granted_credit > 0) {
         return $string_to_show;
@@ -356,6 +362,10 @@ 
     return "results.php?$c&amp;offset=$o&amp;show_names=$sn&amp;state=$st&amp;appid=$appid";
 }
 
+/**
+ * @param boolean $show_wu_link
+ * @param boolean $show_host_link
+ */
 function result_table_start($show_wu_link, $show_host_link, $info) {
     start_table('table-striped');
     $x = array();
@@ -417,6 +427,11 @@ 
     return false;
 }
 
+/**
+ * @param boolean $show_wu_link
+ * @param boolean $show_host_link
+ * @param boolean $show_name
+ */
 function show_result_row($result, $show_wu_link, $show_host_link, $show_name) {
     $s = time_str($result->sent_time);
     // if result has been reported, show the received time,

Braces +4 added lines, -4 removed lines

@@ -500,9 +500,9 @@ 
 // @return String A human readable error message
 // @param Integer $x An error number
 //
-function windows_error_code_str($x){
+function windows_error_code_str($x) {
     $h=int2hex($x);
-    switch($h){
+    switch($h) {
     case "0xC0000005": return "STATUS_ACCESS_VIOLATION";
     case "0xC000001D": return "STATUS_ILLEGAL_INSTRUCTION";
     case "0xC0000094": return "STATUS_INTEGER_DIVIDE_BY_ZERO";
@@ -523,10 +523,10 @@ 
 // @return String A human readable error message
 // @param Integer $x An error number
 //
-function error_code_str($x){
+function error_code_str($x) {
     // severe Windows error numbers are always large negative integers
     if ($x<-400) return windows_error_code_str($x);
-    switch($x){
+    switch($x) {
     case 0: return "";
     case 192: return "EXIT_STATEFILE_WRITE";
     case 193: return "EXIT_SIGNAL";

Spacing +33 added lines, -33 removed lines

@@ -53,9 +53,9 @@ 
     return $platforms[$id];
 }
 
-function anon_platform_string($result, $rsc_name=null) {
+function anon_platform_string($result, $rsc_name = null) {
     $app = get_app($result->appid);
-    $n = $app->user_friendly_name."<br>".  tra("Anonymous platform");
+    $n = $app->user_friendly_name."<br>".tra("Anonymous platform");
     if ($rsc_name) {
         $n .= " ($rsc_name)";
     }
@@ -97,7 +97,7 @@ 
         return $string_to_show;
     }
     if ($result->server_state <> RESULT_SERVER_STATE_OVER) return "---";
-    switch($result->outcome) {
+    switch ($result->outcome) {
     case RESULT_OUTCOME_SUCCESS:
         switch ($result->validate_state) {
         case VALIDATE_STATE_INIT:
@@ -212,7 +212,7 @@ 
             ) {
                 return tra("Not started by deadline - canceled");
             }
-            switch($result->client_state) {
+            switch ($result->client_state) {
             case RESULT_FILES_DOWNLOADING: return tra("Error while downloading");
             case RESULT_FILES_DOWNLOADED:
             case RESULT_COMPUTE_ERROR: return tra("Error while computing");
@@ -231,7 +231,7 @@ 
 }
 
 function result_server_state_string($result) {
-    switch($result->server_state) {
+    switch ($result->server_state) {
     case RESULT_SERVER_STATE_INACTIVE: return tra("Inactive");
     case RESULT_SERVER_STATE_UNSENT: return tra("Unsent");
     case RESULT_SERVER_STATE_IN_PROGRESS: return tra("In progress");
@@ -241,7 +241,7 @@ 
 }
 
 function result_outcome_string($result) {
-    switch($result->outcome) {
+    switch ($result->outcome) {
     case RESULT_OUTCOME_INIT: return "---";
     case RESULT_OUTCOME_SUCCESS: return tra("Success");
     case RESULT_OUTCOME_COULDNT_SEND: return tra("Couldn't send");
@@ -259,7 +259,7 @@ 
 }
 
 function result_client_state_string($result) {
-    switch($result->client_state) {
+    switch ($result->client_state) {
     case RESULT_NEW: return tra("New");
     case RESULT_FILES_DOWNLOADING: return tra("Downloading");
     case RESULT_FILES_DOWNLOADED: return tra("Processing");
@@ -277,7 +277,7 @@ 
 }
 
 function validate_state_str($result) {
-    switch($result->validate_state) {
+    switch ($result->validate_state) {
     case VALIDATE_STATE_INIT: return tra("Initial");
     case VALIDATE_STATE_VALID: return tra("Valid");
     case VALIDATE_STATE_INVALID:
@@ -293,7 +293,7 @@ 
 }
 
 function assimilate_state_str($s) {
-    switch($s) {
+    switch ($s) {
     case ASSIMILATE_INIT: return "Initial";
     case ASSIMILATE_READY: return "Ready to assimilate";
     case ASSIMILATE_DONE: return "Assimilated";
@@ -302,7 +302,7 @@ 
 }
 
 function file_delete_state_str($s) {
-    switch($s) {
+    switch ($s) {
     case FILE_DELETE_INIT: return "Initial";
     case FILE_DELETE_READY: return "Ready to delete";
     case FILE_DELETE_DONE: return "Deleted";
@@ -312,27 +312,27 @@ 
 }
 function wu_error_mask_str($s) {
     $x = "";
-    if ($s & WU_ERROR_COULDNT_SEND_RESULT) {
+    if ($s&WU_ERROR_COULDNT_SEND_RESULT) {
         $x = $x." ".tra("Couldn't send result");
         $s -= WU_ERROR_COULDNT_SEND_RESULT;
     }
-    if ($s & WU_ERROR_TOO_MANY_ERROR_RESULTS) {
+    if ($s&WU_ERROR_TOO_MANY_ERROR_RESULTS) {
         $x = $x." ".tra("Too many errors (may have bug)");
         $s -= WU_ERROR_TOO_MANY_ERROR_RESULTS;
     }
-    if ($s & WU_ERROR_TOO_MANY_SUCCESS_RESULTS) {
+    if ($s&WU_ERROR_TOO_MANY_SUCCESS_RESULTS) {
         $x = $x." ".tra("Too many results (may be nondeterministic)");
         $s -= WU_ERROR_TOO_MANY_SUCCESS_RESULTS;
     }
-    if ($s & WU_ERROR_TOO_MANY_TOTAL_RESULTS) {
+    if ($s&WU_ERROR_TOO_MANY_TOTAL_RESULTS) {
         $x = $x." ".tra("Too many total results");
         $s -= WU_ERROR_TOO_MANY_TOTAL_RESULTS;
     }
-    if ($s & WU_ERROR_CANCELLED) {
+    if ($s&WU_ERROR_CANCELLED) {
         $x = $x." ".tra("WU cancelled");
         $s -= WU_ERROR_CANCELLED;
     }
-    if ($s & WU_ERROR_NO_CANONICAL_RESULT) {
+    if ($s&WU_ERROR_NO_CANONICAL_RESULT) {
         $x = $x." ".tra("Canonical result is missing");
         $s -= WU_ERROR_NO_CANONICAL_RESULT;
     }
@@ -340,9 +340,9 @@ 
         $x = $x." ".tra("Unrecognized Error: %1", $s);
     }
     if (strlen($x)) {
-        $x="<font color=\"#ff3333\">".$x."</font>";
+        $x = "<font color=\"#ff3333\">".$x."</font>";
     } else {
-        $x="";
+        $x = "";
     }
     return $x;
 }
@@ -426,10 +426,10 @@ 
     if ($result->received_time) {
         $r = time_str($result->received_time);
     } else if ($result->report_deadline) {
-        if ($result->report_deadline>time()) {
-            $r = "<font color='#33cc33'>" . time_str($result->report_deadline) . "</font>";
+        if ($result->report_deadline > time()) {
+            $r = "<font color='#33cc33'>".time_str($result->report_deadline)."</font>";
         } else {
-            $r = "<font color='#ff3333'>" . time_str($result->report_deadline) . "</font>";
+            $r = "<font color='#ff3333'>".time_str($result->report_deadline)."</font>";
         }
     } else {
         $r = "---";
@@ -490,7 +490,7 @@ 
 // @param Integer $dec A signed integer
 //
 function int2hex($dec) {
-    return "0x".strtoupper(substr(sprintf("%08x",$dec), -8));
+    return "0x".strtoupper(substr(sprintf("%08x", $dec), -8));
 }
 
 // Decode a windows error number into semi-human-readable,
@@ -500,9 +500,9 @@ 
 // @return String A human readable error message
 // @param Integer $x An error number
 //
-function windows_error_code_str($x){
-    $h=int2hex($x);
-    switch($h){
+function windows_error_code_str($x) {
+    $h = int2hex($x);
+    switch ($h) {
     case "0xC0000005": return "STATUS_ACCESS_VIOLATION";
     case "0xC000001D": return "STATUS_ILLEGAL_INSTRUCTION";
     case "0xC0000094": return "STATUS_INTEGER_DIVIDE_BY_ZERO";
@@ -523,10 +523,10 @@ 
 // @return String A human readable error message
 // @param Integer $x An error number
 //
-function error_code_str($x){
+function error_code_str($x) {
     // severe Windows error numbers are always large negative integers
-    if ($x<-400) return windows_error_code_str($x);
-    switch($x){
+    if ($x < -400) return windows_error_code_str($x);
+    switch ($x) {
     case 0: return "";
     case 192: return "EXIT_STATEFILE_WRITE";
     case 193: return "EXIT_SIGNAL";
@@ -687,7 +687,7 @@ 
     return $x." (".int2hex($x).") ".error_code_str($x);
 }
 
-function show_result($result, $show_outfile_links=false) {
+function show_result($result, $show_outfile_links = false) {
     start_table();
     row2(tra("Name"), $result->name);
     row2(tra("Workunit"), "<a href=\"workunit.php?wuid=$result->workunitid\">$result->workunitid</a>");
@@ -736,7 +736,7 @@ 
     echo "<h3>".tra("Stderr output")."</h3> <pre>"
         .htmlspecialchars(
             $result->stderr_out,
-            ENT_QUOTES | (defined('ENT_SUBSTITUTE')?ENT_SUBSTITUTE:0),
+            ENT_QUOTES|(defined('ENT_SUBSTITUTE') ?ENT_SUBSTITUTE:0),
             'utf-8'
         )
         ."</pre>"
@@ -751,7 +751,7 @@ 
 
     $apps = BoincApp::enum('deprecated=0 ORDER BY user_friendly_name');
 
-    for ($i=0; $i<NSTATES; $i++) {
+    for ($i = 0; $i < NSTATES; $i++) {
         $state_count[$i] = 0;
     }
     foreach ($apps as $app) {
@@ -793,7 +793,7 @@ 
         $x .= "<a href=$url>".tra("Next")." ".$info->results_per_page."</a>";
     }
     $x .= "<br>".tra("State").": ";
-    for ($i=0; $i<NSTATES; $i++) {
+    for ($i = 0; $i < NSTATES; $i++) {
         if ($i) $x .= " &middot; ";
         if ($info->state == $i) {
             $x .= $state_name[$i];
@@ -838,6 +838,6 @@ 
     return $x;
 }
 
-$cvs_version_tracker[]="\$Id$";  //Generated automatically - do not edit
+$cvs_version_tracker[] = "\$Id$"; //Generated automatically - do not edit
 
 ?>

html/inc/sandbox.inc

Doc Comments +12 added lines

@@ -26,6 +26,9 @@ 
 // Create dir if not present.
 //
 if (!function_exists("sandbox_dir")){
+/**
+ * @return string
+ */
 function sandbox_dir($user) {
     $dir = parse_config(get_config(), "<sandbox_dir>");
     if (!$dir) { $dir = "../../sandbox/"; }
@@ -40,12 +43,18 @@ 
 }
 }
 
+/**
+ * @param string $md5
+ */
 function sandbox_write_link_file($path, $size, $md5) {
     file_put_contents($path, "sb $size $md5");
 }
 
 // check if a newly update files already exists in sandbox via its md5 sum
 //
+/**
+ * @param string $md5
+ */
 function sandbox_lf_exist($user, $md5) {
     $exist = 0;
     $elf = "";
@@ -115,6 +124,9 @@ 
 // return a <select> for files in sandbox
 //
 if (!function_exists('sandbox_file_select')) {
+/**
+ * @param string $select_name
+ */
 function sandbox_file_select($user, $select_name, $regexp = null, $allow_none = false) {
     if ($regexp === null) {
         $regexp = $select_name;

Spacing +12 added lines, -12 removed lines

@@ -25,7 +25,7 @@ 
 // Return path of sandbox directory for the given user.
 // Create dir if not present.
 //
-if (!function_exists("sandbox_dir")){
+if (!function_exists("sandbox_dir")) {
 function sandbox_dir($user) {
     $dir = parse_config(get_config(), "<sandbox_dir>");
     if (!$dir) { $dir = "../../sandbox/"; }
@@ -54,7 +54,7 @@ 
     foreach ($files as $file) {
         $path = $dir."/".$file;
         list($err, $file_size, $file_md5) = sandbox_parse_link_file($path);
-        if (!$err){
+        if (!$err) {
             if (strcmp($md5, $file_md5) == 0) {
                 //echo "this file with $md5 already exisits with another name $file";
                 $exist = 1;
@@ -125,7 +125,7 @@ 
     }
     $files = sandbox_file_names($user);
     foreach ($files as $f) {
-        if(preg_match("/$regexp/",$f)){
+        if (preg_match("/$regexp/", $f)) {
             $x .= "<option value=\"$f\">$f</option>\n";
         }
     }
@@ -136,7 +136,7 @@ 
 
 //check if a file is still being used by a unfinished batch
 //
-function sandbox_file_in_use($user, $file){
+function sandbox_file_in_use($user, $file) {
     $ufiles = array();
 
     // batch status: 2(completed), 3(aborted)
@@ -144,17 +144,17 @@ 
     $pbatches = BoincBatch::enum("user_id = $user->id and state != 2 and state != 3");
     if (!$pbatches) return false;
 
-    foreach ($pbatches as $batch){
-        $wus = BoincWorkUnit::enum("batch = $batch->id limit 1" );
-        if ($wus == null){
+    foreach ($pbatches as $batch) {
+        $wus = BoincWorkUnit::enum("batch = $batch->id limit 1");
+        if ($wus == null) {
             //echo " no workunit for this batch<br/>"; 
             continue;
         }
-        foreach($wus as $wu){
+        foreach ($wus as $wu) {
             $x = "<in>".$wu->xml_doc."</in>";
             $x = simplexml_load_string($x);
             global $fanout;
-            foreach($x->workunit->file_ref as $fr){
+            foreach ($x->workunit->file_ref as $fr) {
                 $pname = (string)$fr->file_name;
                 $ufiles[] = $pname;
             }
@@ -165,10 +165,10 @@ 
     $dir = sandbox_dir($user);
     $path = $dir."/".$file;
     list($err, $size, $md5) = sandbox_parse_link_file($path);
-    if (!$err){
+    if (!$err) {
         $f = sandbox_file_name($user, $md5);
-        foreach($ufiles as $uf) {
-            if (strcmp($f,$uf) == 0){
+        foreach ($ufiles as $uf) {
+            if (strcmp($f, $uf) == 0) {
                 return true;
             }
             

Braces +10 added lines, -10 removed lines

@@ -25,7 +25,7 @@ 
 // Return path of sandbox directory for the given user.
 // Create dir if not present.
 //
-if (!function_exists("sandbox_dir")){
+if (!function_exists("sandbox_dir")) {
 function sandbox_dir($user) {
     $dir = parse_config(get_config(), "<sandbox_dir>");
     if (!$dir) { $dir = "../../sandbox/"; }
@@ -54,7 +54,7 @@ 
     foreach ($files as $file) {
         $path = $dir."/".$file;
         list($err, $file_size, $file_md5) = sandbox_parse_link_file($path);
-        if (!$err){
+        if (!$err) {
             if (strcmp($md5, $file_md5) == 0) {
                 //echo "this file with $md5 already exisits with another name $file";
                 $exist = 1;
@@ -125,7 +125,7 @@ 
     }
     $files = sandbox_file_names($user);
     foreach ($files as $f) {
-        if(preg_match("/$regexp/",$f)){
+        if(preg_match("/$regexp/",$f)) {
             $x .= "<option value=\"$f\">$f</option>\n";
         }
     }
@@ -136,7 +136,7 @@ 
 
 //check if a file is still being used by a unfinished batch
 //
-function sandbox_file_in_use($user, $file){
+function sandbox_file_in_use($user, $file) {
     $ufiles = array();
 
     // batch status: 2(completed), 3(aborted)
@@ -144,17 +144,17 @@ 
     $pbatches = BoincBatch::enum("user_id = $user->id and state != 2 and state != 3");
     if (!$pbatches) return false;
 
-    foreach ($pbatches as $batch){
+    foreach ($pbatches as $batch) {
         $wus = BoincWorkUnit::enum("batch = $batch->id limit 1" );
-        if ($wus == null){
+        if ($wus == null) {
             //echo " no workunit for this batch<br/>"; 
             continue;
         }
-        foreach($wus as $wu){
+        foreach($wus as $wu) {
             $x = "<in>".$wu->xml_doc."</in>";
             $x = simplexml_load_string($x);
             global $fanout;
-            foreach($x->workunit->file_ref as $fr){
+            foreach($x->workunit->file_ref as $fr) {
                 $pname = (string)$fr->file_name;
                 $ufiles[] = $pname;
             }
@@ -165,10 +165,10 @@ 
     $dir = sandbox_dir($user);
     $path = $dir."/".$file;
     list($err, $size, $md5) = sandbox_parse_link_file($path);
-    if (!$err){
+    if (!$err) {
         $f = sandbox_file_name($user, $md5);
         foreach($ufiles as $uf) {
-            if (strcmp($f,$uf) == 0){
+            if (strcmp($f,$uf) == 0) {
                 return true;
             }
             

html/inc/submit.inc

Doc Comments +24 added lines

@@ -145,6 +145,9 @@ 
     }
 }
 
+/**
+ * @param string $op
+ */
 function do_batch_op($req, $op) {
     $retval = validate_request($req);
     if ($retval) return array(null, $retval);
@@ -172,6 +175,9 @@ 
 
 // if RPC had a fatal error, return the message
 //
+/**
+ * @param string $outer_tag
+ */
 function get_error($reply, $outer_tag) {
     $name = $reply->getName();
     if ($name != $outer_tag) {
@@ -187,6 +193,9 @@ 
 
 //// API functions follow
 
+/**
+ * @param stdClass $req
+ */
 function boinc_estimate_batch($req) {
     list($reply, $errmsg) = do_batch_op($req, "estimate_batch");
     if ($errmsg) return array(0, $errmsg);
@@ -205,6 +214,9 @@ 
     return array((int)$reply->batch_id, null);
 }
 
+/**
+ * @param stdClass $req
+ */
 function boinc_query_batches($req) {
     $req_xml = "<query_batches>
     <authenticator>$req->authenticator</authenticator>
@@ -255,6 +267,9 @@ 
     return array($r, null);
 }
 
+/**
+ * @param stdClass $req
+ */
 function boinc_query_job($req) {
     $req_xml = "<query_job>
     <authenticator>$req->authenticator</authenticator>
@@ -285,6 +300,9 @@ 
     return array($r, null);
 }
 
+/**
+ * @return string
+ */
 function boinc_abort_batch($req) {
     $req_xml = "<abort_batch>
     <authenticator>$req->authenticator</authenticator>
@@ -299,6 +317,9 @@ 
     return array(true, null);
 }
 
+/**
+ * @param stdClass $req
+ */
 function boinc_get_output_file($req) {
     $auth_str = md5($req->authenticator.$req->instance_name);
     $name = $req->instance_name;
@@ -312,6 +333,9 @@ 
     return $req->project."/get_output.php?cmd=batch_files&batch_id=$batch_id&auth_str=$auth_str";
 }
 
+/**
+ * @return string
+ */
 function boinc_retire_batch($req) {
     $req_xml = "<retire_batch>
     <authenticator>$req->authenticator</authenticator>

Spacing +2 added lines, -2 removed lines

@@ -170,7 +170,7 @@ 
     $b->create_time = (double)($batch->create_time);
     $b->est_completion_time = (double)($batch->est_completion_time);
     $b->njobs = (int)($batch->njobs);
-    $b->fraction_done = (double) $batch->fraction_done;
+    $b->fraction_done = (double)$batch->fraction_done;
     $b->nerror_jobs = (int)($batch->nerror_jobs);
     $b->state = (int)($batch->state);
     $b->completion_time = (double)($batch->completion_time);
@@ -398,7 +398,7 @@ 
     </result>
 </output_template>
 ";
-    for ($i=0; $i<2; $i++) {
+    for ($i = 0; $i < 2; $i++) {
         $job = new StdClass;
         $job->input_files = array();
         $job->input_files[] = $f;

html/inc/submit_db.inc

Doc Comments +16 added lines

@@ -34,6 +34,10 @@ 
         $db = BoincDb::get();
         return $db->enum('batch', 'BoincBatch', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function insert($clause) {
         $db = BoincDb::get();
         $ret = $db->insert('batch', $clause);
@@ -44,6 +48,10 @@ 
         $db = BoincDb::get();
         return $db->update($this, 'batch', $clause);
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('batch', $clause);
@@ -59,6 +67,10 @@ 
 }
 
 class BoincUserSubmit {
+
+    /**
+     * @param string $clause
+     */
     static function enum($clause) {
         $db = BoincDb::get();
         return $db->enum('user_submit', 'BoincUserSubmit', $clause);
@@ -77,6 +89,10 @@ 
         $db = BoincDb::get();
         return $db->update_aux('user_submit', "$clause where user_id=$this->user_id");
     }
+
+    /**
+     * @param string $clause
+     */
     static function update_aux($clause) {
         $db = BoincDb::get();
         return $db->update_aux('user_submit', $clause);

html/inc/submit_util.inc

Doc Comments +11 added lines

@@ -26,6 +26,9 @@ 
 // we need to give a unique physical name based on its content.
 // Prepend the jf_ to make the origin of the file clear
 //
+/**
+ * @param string $md5
+ */
 function job_file_name($md5) {
     return "jf_$md5";
 }
@@ -179,12 +182,20 @@ 
     return $batch_td_size;
 }
 
+/**
+ * @param integer $i
+ *
+ * @return double
+ */
 function boinc_get_output_file_url($user, $result, $i) {
     $name = $result->name;
     $auth_str = md5($user->authenticator.$name);
     return "get_output.php?cmd=result_file&result_name=$name&file_num=$i&auth_str=$auth_str";
 }
 
+/**
+ * @param null|integer $batch_id
+ */
 function boinc_get_output_files_url($user, $batch_id) {
     $auth_str = md5($user->authenticator.$batch_id);
     return "get_output.php?cmd=batch_files&batch_id=$batch_id&auth_str=$auth_str";

Spacing +6 added lines, -6 removed lines

@@ -73,7 +73,7 @@ 
         }
     }
     if ($fp_total) {
-        $batch->fraction_done = $fp_done / $fp_total;
+        $batch->fraction_done = $fp_done/$fp_total;
     }
     if ($completed && $batch->state == BATCH_STATE_IN_PROGRESS) {
         $batch->state = BATCH_STATE_COMPLETE;
@@ -159,7 +159,7 @@ 
 // get the total size of output files of a batch
 //
 function batch_output_file_size($batchid) {
-    $batch_td_size=0;
+    $batch_td_size = 0;
     $wus = BoincWorkunit::enum("batch=$batchid");
     $fanout = parse_config(get_config(), "<uldl_dir_fanout>");
     $upload_dir = parse_config(get_config(), "<upload_dir>");
@@ -170,9 +170,9 @@ 
         foreach ($names as $name) {
             $path = dir_hier_path($name, $upload_dir, $fanout);
             if (is_file($path)) {
-                $s=stat($path);
-                $size=$s['size'];
-                $batch_td_size+=$size;
+                $s = stat($path);
+                $size = $s['size'];
+                $batch_td_size += $size;
             }
         }
     }
@@ -191,7 +191,7 @@ 
 }
 
 function boinc_get_wu_output_files_url($user, $wu_id) {
-    $auth_str =  md5($user->authenticator.$wu_id);
+    $auth_str = md5($user->authenticator.$wu_id);
     return "get_output.php?cmd=workunit_files&wu_id=$wu_id&auth_str=$auth_str";
 }
 

html/inc/team.inc

Doc Comments +6 added lines

@@ -524,6 +524,9 @@ 
 //   an active request, i.e. after the 60 days elapse X has another
 //   30 days to assume foundership before someone elase can request it
 //
+/**
+ * @param integer $now
+ */
 function new_transfer_request_ok($team, $now) {
     if ($team->ping_user <= 0) {
         if ($team->ping_time < $now - 60 * 86400) {
@@ -544,6 +547,9 @@ 
     return $team->ping_time + 60*86400;
 }
 
+/**
+ * @param integer $now
+ */
 function transfer_ok($team, $now) {
     if ($now > transfer_ok_time($team)) return true;
     return false;

Spacing +17 added lines, -17 removed lines

@@ -40,7 +40,7 @@ 
     row2('<b>'.tra('Search criteria (use one or more)').'</b>', '');
     row2(
         tra('Key words').'<br><small>'.tra('Find teams with these words in their names or descriptions').'</small>',
-        '<input class="form-control" type="text" name="keywords" value="' . htmlspecialchars($params->keywords) . '">');
+        '<input class="form-control" type="text" name="keywords" value="'.htmlspecialchars($params->keywords).'">');
     row2_init(tra('Country'), '');
     echo '<select class="form-control" name="country"><option value="" selected>---</option>';
     $country = $params->country;
@@ -48,7 +48,7 @@ 
     echo country_select_options($country);
     echo "</select></td></tr>\n";
     row2(tra('Type of team'), team_type_select($params->type, true));
-    $checked = $params->active?"checked":"";
+    $checked = $params->active ? "checked" : "";
     row2(tra('Show only active teams'), "<input type=checkbox name=active $checked>");
     row2("", "<input class=\"btn btn-primary\" type=submit name=submit value=\"".tra('Search')."\">");
     end_table();
@@ -96,7 +96,7 @@ 
     row2("Created", date_str($team->create_time));
     if (defined("SHOW_NONVALIDATED_TEAMS")) {
         $founder = $team->founder;
-        row2("Founder email validated", $founder->email_validated?"Yes":"No (team will not be exported)");
+        row2("Founder email validated", $founder->email_validated ? "Yes" : "No (team will not be exported)");
     }
     if (strlen($team->url)) {;
         if (strstr($team->url, "http://")) {
@@ -169,7 +169,7 @@ 
     }
     row1(tra('Members'));
     row2(tra('Founder'),
-        $team->founder?user_links($team->founder, BADGE_HEIGHT_MEDIUM):"---"
+        $team->founder ?user_links($team->founder, BADGE_HEIGHT_MEDIUM) : "---"
     );
     if (count($team->admins)) {
         $first = true;
@@ -353,7 +353,7 @@ 
         foreach ($deltas as $delta) {
             $u = BoincUser::lookup_id($delta->userid);
             if ($u->teamid == $teamid) {
-                $new_members[] = $u;  // they might have later quit
+                $new_members[] = $u; // they might have later quit
             }
         }
     }
@@ -436,7 +436,7 @@ 
     if (!$user->teamid) return;
     $user->update("teamid=0");
     $team = BoincTeam::lookup_id($user->teamid);
-    if ($team && $team->ping_user==$user->id) {
+    if ($team && $team->ping_user == $user->id) {
         $team->update("ping_user=-ping_user");
     }
     BoincTeamAdmin::delete("teamid=$user->teamid and userid=$user->id");
@@ -475,34 +475,34 @@ 
     start_table();
     row2(tra('Team name, text version').'
         <br><p class=\"text-muted\">'.tra('Don\'t use HTML tags.').'</p>',
-        '<input class="form-control" name="name" type="text" size="50" value="'.($team?$team->name:"").'">'
+        '<input class="form-control" name="name" type="text" size="50" value="'.($team ? $team->name : "").'">'
     );
     row2(tra('Team name, HTML version').'
         <br><p class=\"text-muted\">
         '.tra('You may use %1 limited HTML tags %2.', '<a href="html.php" target="_new">', '</a>').'
         '.tra('If you don\'t know HTML, leave this box blank.').'</p>',
-        '<input class="form-control" name="name_html" type="text" size="50" value="'.str_replace('"',"'",($team?$team->name_html:"")).'">'
+        '<input class="form-control" name="name_html" type="text" size="50" value="'.str_replace('"', "'", ($team ? $team->name_html : "")).'">'
     );
     row2(tra('URL of team web page, if any').':<br><font size=-2>('.tra('without "http://"').')
         '.tra('This URL will be linked to from the team\'s page on this site.'),
-        '<input class="form-control" type="text" name="url" size="60" value="'.($team?$team->url:"").'">'
+        '<input class="form-control" type="text" name="url" size="60" value="'.($team ? $team->url : "").'">'
     );
     row2(tra('Description of team').':
         <br><p class=\"text-muted\">
         '.tra('You may use %1 limited HTML tags %2.', '<a href="html.php" target="_new">', '</a>').'
         </p>',
-        '<textarea class="form-control" name="description" rows=10>'.($team?$team->description:"").'</textarea>'
+        '<textarea class="form-control" name="description" rows=10>'.($team ? $team->description : "").'</textarea>'
     );
 
-    row2(tra('Type of team').':', team_type_select($team?$team->type:null));
+    row2(tra('Type of team').':', team_type_select($team ? $team->type : null));
 
     row2_init(tra('Country'),
         '<select class="form-control" name="country">'
     );
-    echo country_select_options($team?$team->country:null);
+    echo country_select_options($team ? $team->country : null);
 
     echo "</select></td></tr>\n";
-    $x = (!$team || $team->joinable)?"checked":"";
+    $x = (!$team || $team->joinable) ? "checked" : "";
     row2(tra("Accept new members?"), "<input type=checkbox name=joinable $x>");
     // Check if we're using reCaptcha to prevent spam accounts
     //
@@ -566,12 +566,12 @@ 
 //
 function new_transfer_request_ok($team, $now) {
     if ($team->ping_user <= 0) {
-        if ($team->ping_time < $now - 60 * 86400) {
+        if ($team->ping_time < $now - 60*86400) {
             return true;
         }
         return false;
     }
-    if ($team->ping_time < $now - 90 * 86400) {
+    if ($team->ping_time < $now - 90*86400) {
         return true;
     }
     return false;
@@ -606,7 +606,7 @@ 
     if (!is_valid_country($country)) {
         $country = tra('None');
     }
-    $country = BoincDb::escape_string($country);  // for Cote d'Ivoire
+    $country = BoincDb::escape_string($country); // for Cote d'Ivoire
 
     $clause = sprintf(
         "(userid, create_time, name, name_lc, url, type, name_html, description, country, nusers, expavg_time) values(%d, %d, '%s', '%s', '%s', %d, '%s', '%s', '%s', %d, unix_timestamp())",
@@ -629,6 +629,6 @@ 
     }
 }
 
-$cvs_version_tracker[]="\$Id$";  //Generated automatically - do not edit
+$cvs_version_tracker[] = "\$Id$"; //Generated automatically - do not edit
 
 ?>

html/inc/text_transform.inc

Doc Comments +8 added lines

@@ -105,6 +105,9 @@ 
 
 // handle [pre] and [code] separately because we need to remove <br />s
 //
+/**
+ * @param boolean $export
+ */
 function replace_pre_code($text, $export) {
     if ($export) {
         $text = preg_replace_callback(
@@ -272,6 +275,11 @@ 
 // for example inside <pre> containers
 // The original \n was retained after the br when it was added
 //
+/**
+ * @param string $text
+ *
+ * @return string
+ */
 function remove_br($text){
     return str_replace("<br />", "", $text);
 }

Spacing +26 added lines, -26 removed lines

@@ -26,13 +26,13 @@ 
 require_once('../inc/sanitize_html.inc');
 
 class output_options {
-    var $bb2html;            // BBCode as HTML? (on)
-    var $images_as_links;    // Images as hyperlinks? (off)
-    var $link_popup;        // Links in new windows? (off)
-    var $nl2br;                // Convert newlines to <br>'s? (on)
-    var $htmlitems;            // Convert special chars to HTML entities? (on)
-    var $htmlscrub;            // Scrub "bad" HTML tags? (off)
-    var $highlight_terms;// Array of terms to be highlighted (off)    
+    var $bb2html; // BBCode as HTML? (on)
+    var $images_as_links; // Images as hyperlinks? (off)
+    var $link_popup; // Links in new windows? (off)
+    var $nl2br; // Convert newlines to <br>'s? (on)
+    var $htmlitems; // Convert special chars to HTML entities? (on)
+    var $htmlscrub; // Scrub "bad" HTML tags? (off)
+    var $highlight_terms; // Array of terms to be highlighted (off)    
 
     // Constructor - set the defaults.
 
@@ -109,7 +109,7 @@ 
     if ($export) {
         $text = preg_replace_callback(
             "@\[pre\](.*?)\[/pre\]@is",
-            function ($matches) {
+            function($matches) {
                 $x = remove_br(substr($matches[0], 5, -6));
                 $x = htmlspecialchars($x, ENT_COMPAT, "UTF-8", false);
                 $x = str_replace("[", "&#91;", $x);
@@ -119,7 +119,7 @@ 
         );
         return preg_replace_callback(
             "@\[code\](.*?)\[/code\]@is",
-            function ($matches) {
+            function($matches) {
                 $x = remove_br(substr($matches[0], 6, -7));
                 $x = htmlspecialchars($x, ENT_COMPAT, "UTF-8", false);
                 $x = str_replace("[", "&#91;", $x);
@@ -130,7 +130,7 @@ 
     } else {
         $text = preg_replace_callback(
             "@\[pre\](.*?)\[/pre\]@is",
-            function ($matches) {
+            function($matches) {
                 $x = remove_br(substr($matches[0], 5, -6));
                 $x = htmlspecialchars($x, ENT_COMPAT, "UTF-8", false);
                 $x = str_replace("[", "&#91;", $x);
@@ -140,7 +140,7 @@ 
         );
         return preg_replace_callback(
             "@\[code\](.*?)\[/code\]@is",
-            function ($matches) {
+            function($matches) {
                 $x = remove_br(substr($matches[0], 6, -7));
                 $x = htmlspecialchars($x, ENT_COMPAT, "UTF-8", false);
                 $x = str_replace("[", "&#91;", $x);
@@ -151,7 +151,7 @@ 
     }
 }
 
-function bb2html($text, $export=false) {
+function bb2html($text, $export = false) {
     $urlregex = "(?:\"?)(?:(http\:\/\/)?)([^\[\"<\ ]+)(?:\"?)";
     // NOTE:
     // This matches https:// too; I don't understand why.
@@ -171,7 +171,7 @@ 
 
     $httpsregex = "(?:\"?)https\:\/\/([^\[\"<\ ]+)(?:\"?)";
     // List of allowable tags
-    $bbtags = array (
+    $bbtags = array(
         "@\[b\](.*?)\[/b\]@is",
         "@\[i\](.*?)\[/i\]@is",
         "@\[u\](.*?)\[/u\]@is",
@@ -200,7 +200,7 @@ 
     
     // What the above tags are turned in to
     if ($export) {
-        $htmltags = array (
+        $htmltags = array(
             "<b>\\1</b>",
             "<i>\\1</i>",
             "<u>\\1</u>",
@@ -227,7 +227,7 @@ 
             "<a href=\"https://github.com/BOINC/boinc-dev-doc/wiki/\\1\">\\1</a>",
         );
     } else {
-        $htmltags = array (
+        $htmltags = array(
             "<b>\\1</b>",
             "<i>\\1</i>",
             "<u>\\1</u>",
@@ -259,7 +259,7 @@ 
     $lasttext = "";
     $i = 0;
     // $i<1000 to prevent DoS
-    while ($text != $lasttext && $i<1000) {
+    while ($text != $lasttext && $i < 1000) {
         $lasttext = $text;
         $text = replace_pre_code($text, $export);
         $text = preg_replace($bbtags, $htmltags, $text);
@@ -272,7 +272,7 @@ 
 // for example inside <pre> containers
 // The original \n was retained after the br when it was added
 //
-function remove_br($text){
+function remove_br($text) {
     return str_replace("<br />", "", $text);
 }
 
@@ -280,19 +280,19 @@ 
 //
 function externalize_links($text) {
     // TODO:  Convert this to PCRE
-    $i=0;
-    $linkpos=true;
+    $i = 0;
+    $linkpos = true;
     $out = "";
-    while (true){
+    while (true) {
         //Find a link
         //
-        $linkpos=strpos($text, "<a ", $i);
-        if ($linkpos===false) break;
+        $linkpos = strpos($text, "<a ", $i);
+        if ($linkpos === false) break;
 
         //Replace with target='_new'
         //
-        $out .= substr($text, $i, $linkpos-$i)."<a target=\"_new\" ";
-        $i = $linkpos+3;
+        $out .= substr($text, $i, $linkpos - $i)."<a target=\"_new\" ";
+        $i = $linkpos + 3;
     }
     $out .= substr($text, $i);
     return $out;
@@ -300,7 +300,7 @@ 
 
 // Converts image tags to links to the images.
 
-function image_as_link($text){
+function image_as_link($text) {
     /* This function depends on sanitized HTML */
     // Build some regex (should be a *lot* faster)
     $pattern = '@<img([\S\s]+?)src=([^>]+?)>@si';
@@ -325,5 +325,5 @@ 
     }
 }
 
-$cvs_version_tracker[]="\$Id$";  //Generated automatically - do not edit
+$cvs_version_tracker[] = "\$Id$"; //Generated automatically - do not edit
 ?>

Braces +5 added lines, -4 removed lines

@@ -272,7 +272,7 @@ 
 // for example inside <pre> containers
 // The original \n was retained after the br when it was added
 //
-function remove_br($text){
+function remove_br($text) {
     return str_replace("<br />", "", $text);
 }
 
@@ -283,7 +283,7 @@ 
     $i=0;
     $linkpos=true;
     $out = "";
-    while (true){
+    while (true) {
         //Find a link
         //
         $linkpos=strpos($text, "<a ", $i);
@@ -300,7 +300,7 @@ 
 
 // Converts image tags to links to the images.
 
-function image_as_link($text){
+function image_as_link($text) {
     /* This function depends on sanitized HTML */
     // Build some regex (should be a *lot* faster)
     $pattern = '@<img([\S\s]+?)src=([^>]+?)>@si';
@@ -318,7 +318,8 @@ 
     foreach ($search as $key => $value) {
         $replace[$key] = "<span class=\"mark\">".$value."</span>";
     }
-    if (substr(phpversion(), 0, 1) > 4) {   // PHP 4.x doesn't support str_ireplace
+    if (substr(phpversion(), 0, 1) > 4) {
+// PHP 4.x doesn't support str_ireplace
         return str_ireplace($search, $replace, $text);
     } else {
         return str_replace($search, $replace, $text);

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 // Do the actual transformation of the text.
 // TODO: Make this part of the above class.
 
-function output_transform($text, $options = NULL) {
+function output_transform($text, $options = null) {
     // Options is a output_options object, defined above
     if (!$options) {
         $options = new output_options; // Defaults in the class definition

html/inc/time.inc

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 // express a time difference in readable form, e.g. "7 days ago".
 // If it's more than 30 days, just show the date
 //
+/**
+ * @param integer $t2
+ */
 function time_diff_str($t1, $t2) {
     if (!$t1 || !$t2) return "---";
     $diff = $t2 - $t1;

Spacing +11 added lines, -11 removed lines

@@ -22,21 +22,21 @@ 
 function time_diff_str($t1, $t2) {
     if (!$t1 || !$t2) return "---";
     $diff = $t2 - $t1;
-    if ($diff<0){
-        $pre="In ";
-        $post="";
-        $diff=-$diff;
+    if ($diff < 0) {
+        $pre = "In ";
+        $post = "";
+        $diff = -$diff;
     } else {
         if ($diff > 86400*30) {
             return date_str($t1);
         }
-        $pre="";
-        $post=" ago";
+        $pre = "";
+        $post = " ago";
     }
     $x = "";
 
     if ($diff >= 3600*24) {
-        $n = (int) ($diff/(3600*24));
+        $n = (int)($diff/(3600*24));
         if ($n == 1) {
             $x .= "1 day ";
         } else {
@@ -45,7 +45,7 @@ 
         return $pre.$x.$post;
         //$diff -= $n*3600*24;
     } elseif ($diff >= 3600) {
-        $n = (int) ($diff/3600);
+        $n = (int)($diff/3600);
         if ($n == 1) {
             $x .= "1 hour ";
         } else {
@@ -54,16 +54,16 @@ 
         return $pre.$x.$post;
         //$diff -= $n*3600;
     } elseif ($diff >= 60) {
-        $n = (int) ($diff/60);
+        $n = (int)($diff/60);
         if ($n == 1) {
             $x .= "1 minute ";
         } else {
             $x .= $n." minutes ";
         }
         return $pre.$x.$post;
-    } elseif($diff > 1 || $diff==0) {
+    } elseif ($diff > 1 || $diff == 0) {
         return $pre."$diff seconds".$post;
-    } elseif($diff == 1){
+    } elseif ($diff == 1) {
         return $pre."$diff seconds".$post;
     }
 }

Braces +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
 function time_diff_str($t1, $t2) {
     if (!$t1 || !$t2) return "---";
     $diff = $t2 - $t1;
-    if ($diff<0){
+    if ($diff<0) {
         $pre="In ";
         $post="";
         $diff=-$diff;
@@ -63,7 +63,7 @@ 
         return $pre.$x.$post;
     } elseif($diff > 1 || $diff==0) {
         return $pre."$diff seconds".$post;
-    } elseif($diff == 1){
+    } elseif($diff == 1) {
         return $pre."$diff seconds".$post;
     }
 }