BOINC / boinc

html/inc/web_rpc_api.inc

Doc Comments +14 added lines

@@ -21,6 +21,9 @@ 
 // my PHP currently doesn't support file_get_contents(https://...)
 // so do it with Curl
 //
+/**
+ * @param string $url
+ */
 function fetch_url($url) {
     if (0) {
         return file_get_contents($url);
@@ -35,6 +38,11 @@ 
     }
 }
 
+/**
+ * @param string $project_url
+ * @param string $email_addr
+ * @param string $passwd_hash
+ */
 function lookup_account(
     $project_url,
     $email_addr,
@@ -57,6 +65,12 @@ 
 
 // return (authenticator, errmsg)
 //
+/**
+ * @param string $project_url
+ * @param string $email_addr
+ * @param string $passwd_hash
+ * @param string $user_name
+ */
 function create_account(
     $project_url,
     $email_addr,

html/inc/xml.inc

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
 
 $xml_outer_tag = "";
 
+/**
+ * @param string $tag
+ */
 function xml_start_tag($tag) {
     global $xml_outer_tag;
     echo "<$tag>\n";

html/ops/badge_assign_custom.php

Doc Comments +6 added lines

@@ -72,6 +72,9 @@ 
 // badge_name_prefix should be user or team
 // sub_project is an array with name and short_name as in $sub_projects
 //
+/**
+ * @param string $badge_name_prefix
+ */
 function get_badges(
     $badge_name_prefix, $badge_level_names, $badge_images, $sub_project
 ) {
@@ -105,6 +108,9 @@ 
 // decide which subproject badge to assign, if any.
 // Unassign other badges.
 //
+/**
+ * @param string $where_clause
+ */
 function assign_sub_badge($is_user, $item, $levels, $badges, $where_clause) {
     if ($is_user) {
         $sub_total = BoincCreditUser::sum('total', "where userid=".$item->id." and ($where_clause)");

Spacing +6 added lines, -6 removed lines

@@ -77,7 +77,7 @@ 
 ) {
     $badges = array();
     $limit = count($badge_level_names);
-    for ($i=0; $i < $limit; $i++) {
+    for ($i = 0; $i < $limit; $i++) {
         $badges[$i] = get_badge($badge_name_prefix."_".$sub_project["short_name"]."_".$i, "$badge_level_names[$i] in ".$sub_project["name"]." credit", $sub_project["short_name"].$badge_images[$i]);
     }
     return $badges;
@@ -90,7 +90,7 @@ 
     // count from highest to lowest level, so the user get's assigned the
     // highest possible level and the lower levels get removed
     //
-    for ($i=count($levels)-1; $i>=0; $i--) {
+    for ($i = count($levels) - 1; $i >= 0; $i--) {
         if ($item->total_credit >= $levels[$i]) {
             assign_badge($is_user, $item, $badges[$i]);
             unassign_badges($is_user, $item, $badges, $i);
@@ -114,7 +114,7 @@ 
     // count from highest to lowest level, so the user get's assigned the
     // highest possible level and the lower levels get removed
     //
-    for ($i=count($levels)-1; $i>=0; $i--) {
+    for ($i = count($levels) - 1; $i >= 0; $i--) {
         if ($sub_total >= $levels[$i]) {
             assign_badge($is_user, $item, $badges[$i]);
             unassign_badges($is_user, $item, $badges, $i);
@@ -134,7 +134,7 @@ 
     $is_user, $badge_levels, $badge_level_names, $badge_images,
     $subprojects_list
 ) {
-    $kind = $is_user?"user":"team";
+    $kind = $is_user ? "user" : "team";
 
     // get badges for all subprojects including total
     //
@@ -143,7 +143,7 @@ 
     }
 
     $n = 0;
-    $maxid = $is_user?BoincUser::max("id"):BoincTeam::max("id");
+    $maxid = $is_user ?BoincUser::max("id") : BoincTeam::max("id");
     while ($n <= $maxid) {
         $m = $n + 1000;
         if ($is_user) {
@@ -161,7 +161,7 @@ 
                     assign_tot_badge($is_user, $item, $badge_levels, $badges["total"]);
                 } else {
                     // appids come from project/project.inc
-                    $where_clause = "appid in (". implode(',', $sp["appids"]) .")";
+                    $where_clause = "appid in (".implode(',', $sp["appids"]).")";
                     assign_sub_badge(
                         $is_user, $item, $badge_levels, $badges[$sp["short_name"]],
                         $where_clause

html/ops/bolt_map.php

Doc Comments +16 added lines

@@ -173,6 +173,9 @@ 
     return $x;
 }
 
+/**
+ * @param integer $mode
+ */
 function get_nquestions($unit, $mode) {
     global $snap;
 
@@ -187,6 +190,9 @@ 
     return 0;
 }
 
+/**
+ * @param integer $mode
+ */
 function get_views($unit, $mode) {
     global $snap;
 
@@ -231,6 +237,10 @@ 
 
 $rownum = 0;
 
+/**
+ * @param string $class
+ * @param boolean $is_answer
+ */
 function show_unit_row($unit, $class, $level, $is_answer) {
     global $breakdown, $breakdown_cat;
     global $rownum, $course_id;
@@ -319,6 +329,9 @@ 
     echo "</tr>\n";
 }
 
+/**
+ * @param string $class
+ */
 function breakdown_class($class) {
     switch ($class) {
     case "BoltLesson":
@@ -356,6 +369,9 @@ 
     }
 }
 
+/**
+ * @param integer $level
+ */
 function show_unit_recurse($unit, $level) {
     show_unit($unit, $level);
     if ($unit->is_item) return;

Braces +1 added lines, -1 removed lines

@@ -243,7 +243,7 @@
             <td><br></td>
             <td><br></td>
         ";
-    } else  {
+    } else {
         $c = class_name($class);
         echo "
             <td><b>".spaces($level)."$unit->name</b></td>

Spacing +9 added lines, -9 removed lines

@@ -103,7 +103,7 @@ 
 
 function spaces($level) {
     $x = "";
-    for ($i=0; $i<$level; $i++) {
+    for ($i = 0; $i < $level; $i++) {
         $x .= "&nbsp;&nbsp;&nbsp;&nbsp;";
     }
     return $x;
@@ -136,7 +136,7 @@ 
 function avg_score($array) {
     $sum = 0;
     $n = count($array);
-    if ($n ==0) return 0;
+    if ($n == 0) return 0;
     foreach ($array as $a) {
         $sum += $a->score;
     }
@@ -152,7 +152,7 @@ 
             $n++;
         }
     }
-    if ($n ==0) return 0;
+    if ($n == 0) return 0;
     return $sum/$n;
 }
 
@@ -235,7 +235,7 @@ 
     global $breakdown, $breakdown_cat;
     global $rownum, $course_id;
 
-    $a = $is_answer?" (answer)":"";
+    $a = $is_answer ? " (answer)" : "";
     $j = ($rownum++)%2;
     echo "<tr class=row$j>";
     if ($breakdown && $breakdown_cat) {
@@ -243,7 +243,7 @@ 
             <td><br></td>
             <td><br></td>
         ";
-    } else  {
+    } else {
         $c = class_name($class);
         echo "
             <td><b>".spaces($level)."$unit->name</b></td>
@@ -277,7 +277,7 @@ 
         echo time_graph($t, 200);
         break;
     case "BoltExercise":
-        $mode = $is_answer?BOLT_MODE_ANSWER:BOLT_MODE_SHOW;
+        $mode = $is_answer ?BOLT_MODE_ANSWER:BOLT_MODE_SHOW;
         $views = get_views($unit, $mode);
         $n = count($views);
         $out = outcomes($views);
@@ -360,7 +360,7 @@ 
     show_unit($unit, $level);
     if ($unit->is_item) return;
     foreach ($unit->units as $u) {
-        show_unit_recurse($u, $level+1);
+        show_unit_recurse($u, $level + 1);
     }
 }
 
@@ -402,9 +402,9 @@ 
         <input type=hidden name=course_id value=$course_id>
         <table width=600><tr><td valign=top>
     ";
-    filter_form($filter?$filter->name():"", $filter_cat);
+    filter_form($filter ? $filter->name() : "", $filter_cat);
     echo "</td><td valign=top>";
-    breakdown_form($breakdown?$breakdown->name():"");
+    breakdown_form($breakdown ? $breakdown->name() : "");
     echo "
         </td></tr></table>
         <p>

html/ops/bossa_admin.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
     require_once($file);
 }
 
+/**
+ * @param integer $i
+ */
 function show_bossa_app($app, $i) {
     $j = $i%2;
     echo "<tr class=row$j>

Spacing +5 added lines, -5 removed lines

@@ -101,9 +101,9 @@ 
     ";
     start_table();
     row1("User settings");
-    $x = ($flags&BOLT_FLAGS_SHOW_ALL)?"checked":"";
+    $x = ($flags&BOLT_FLAGS_SHOW_ALL) ? "checked" : "";
     row2("Show hidden apps?", "<input type=checkbox name=show_all $x>");
-    $x = ($flags&BOLT_FLAGS_DEBUG)?"checked":"";
+    $x = ($flags&BOLT_FLAGS_DEBUG) ? "checked" : "";
     row2("Show debugging output?", "<input type=checkbox name=debug $x>");
     row2("", "<input class=\"btn btn-default\" type=submit value=\"Update user\">");
     end_table();
@@ -171,7 +171,7 @@ 
     foreach ($jobs as $job) {
         $t = time_str($job->create_time);
         $s = job_state_string($job->state);
-        $j = $i++ % 2;
+        $j = $i++%2;
         echo "<tr class=row$j>
             <td>
                 $job->id <a href=bossa_admin.php?action=job_show_insts&job_id=$job->id>(details)</a><br>
@@ -203,7 +203,7 @@ 
         table_row(
             "$batch->id | <a href=bossa_admin.php?action=show_batch&batch_id=$batch->id>show jobs</a> | <a href=bossa_admin.php?action=clear_batch_confirm&batch_id=$batch->id>delete instances</a>",
             "$batch->name",
-            $batch->calibration?"yes":"no",
+            $batch->calibration ? "yes" : "no",
             time_str($batch->create_time),
             BossaJob::count("batch_id=$batch->id"),
             BossaJob::count("batch_id=$batch->id and state=2")
@@ -333,7 +333,7 @@ 
     if (!$time_estimate) $time_estimate = 60;
     $time_limit = get_str('time_limit');
     if (!$time_limit) $time_limit = 3600;
-    $calibration_frac = get_str('calibration_frac' , true);
+    $calibration_frac = get_str('calibration_frac', true);
     if (!$calibration_frac) $calibration_frac = 0;
     $now = time();
     $app_id = BossaApp::insert("(create_time, name, short_name, description, bolt_course_id, time_estimate, time_limit, calibration_frac) values ($now, '$name', '$short_name', '$description', $courseid, $time_estimate, $time_limit, $calibration_frac)");

html/ops/bossa_example_make_files.php

Doc Comments +9 added lines

@@ -28,6 +28,9 @@ 
 require_once("../inc/util_basic.inc");
 require_once("../inc/util_ops.inc");
 
+/**
+ * @param integer $range
+ */
 function rand_color($im, $range) {
     $mid = 200;
     $lo = $mid - $range;
@@ -35,12 +38,18 @@ 
     return imagecolorallocate($im, rand($lo,$hi), rand($lo,$hi), rand($lo,$hi));
 }
 
+/**
+ * @param resource $im
+ */
 function add_ellipse($im, $case) {
     imagefilledellipse(
         $im, $case->cx, $case->cy, $case->w, $case->h, rand_color($im, 50)
     );
 }
 
+/**
+ * @param resource $im
+ */
 function add_rect($im) {
     $cx = rand(-100, 600);
     $cy = rand(-100, 400);

Spacing +5 added lines, -5 removed lines

@@ -32,7 +32,7 @@ 
     $mid = 200;
     $lo = $mid - $range;
     $hi = $mid + $range;
-    return imagecolorallocate($im, rand($lo,$hi), rand($lo,$hi), rand($lo,$hi));
+    return imagecolorallocate($im, rand($lo, $hi), rand($lo, $hi), rand($lo, $hi));
 }
 
 function add_ellipse($im, $case) {
@@ -46,14 +46,14 @@ 
     $cy = rand(-100, 400);
     $w = rand(50, 100);
     $h = rand(50, 100);
-    imagefilledrectangle($im, $cx, $cy, $cx+$w, $cy+$h, rand_color($im, 50));
+    imagefilledrectangle($im, $cx, $cy, $cx + $w, $cy + $h, rand_color($im, 50));
 }
 
 
 function make_image($case) {
     $im = imagecreatetruecolor(600, 400);
     imagefill($im, 0, 0, imagecolorallocate($im, 255, 255, 255));
-    for ($i=0; $i<400; $i++) {
+    for ($i = 0; $i < 400; $i++) {
         add_rect($im);
     }
     $im2 = imagecreatetruecolor(600, 400);
@@ -85,7 +85,7 @@ 
 $nfiles = 0;
 $dir = null;
 $ellipse_frac = 0.5;
-for ($i=1; $i<$argc; $i++) {
+for ($i = 1; $i < $argc; $i++) {
     if ($argv[$i] == '--nfiles') $nfiles = $argv[++$i];
     elseif ($argv[$i] == '--dir') $dir = $argv[++$i];
     elseif ($argv[$i] == '--ellipse_frac') $ellipse_frac = $argv[++$i];
@@ -99,7 +99,7 @@ 
     exit("$dir is not a directory\n");
 }
 
-for ($i=0; $i<$nfiles; $i++) {
+for ($i = 0; $i < $nfiles; $i++) {
     $path = "$dir/$i.png";
     $anspath = "$dir/$i.ans";
     $case = make_test_case($ellipse_frac);

html/ops/credit_study.php

Doc Comments +3 added lines

@@ -66,6 +66,9 @@
 // $x is an array of result/host objects;
 // return the variance among claimed credits given an FP weight
 //
+/**
+ * @param double $fpw
+ */
 function fpw_var($results, $fpw) {
     $cc = array();
     foreach ($results as $r) {

Spacing +9 added lines, -9 removed lines

@@ -32,7 +32,7 @@ 
 function mean($x) {
     $sum = 0;
     $n = count($x);
-    for ($i=0; $i<$n; $i++) {
+    for ($i = 0; $i < $n; $i++) {
         $sum += $x[$i];
     }
     return $sum/$n;
@@ -42,7 +42,7 @@ 
     $sum = 0;
     $n = count($x);
     $m = mean($x);
-    for ($i=0; $i<$n; $i++) {
+    for ($i = 0; $i < $n; $i++) {
         $d = $x[$i] - $m;
         $sum += $d*$d;
         //echo "$x[$i] ";
@@ -56,10 +56,10 @@ 
 // returns the claimed credit for a given result/host and FP weight
 //
 function cc($x, $fpw) {
-    $cps = $x->p_fpops*$fpw + $x->p_iops*(1-$fpw);
+    $cps = $x->p_fpops*$fpw + $x->p_iops*(1 - $fpw);
     $cps /= 1e9;
     $cps /= 864;
-    $cc = $x->cpu_time * $cps;
+    $cc = $x->cpu_time*$cps;
     return $cc;
 }
 
@@ -84,7 +84,7 @@ 
     $nwus = 4000;
 
     $sum = array();
-    for ($i=0; $i<=10; $i++) {
+    for ($i = 0; $i <= 10; $i++) {
         $sum[] = 0;
     }
     $r1 = _mysql_query(
@@ -96,7 +96,7 @@ 
         $r2 = _mysql_query("select * from result where workunitid=$wu->id");
         $found_zero = false;
         while ($result = _mysql_fetch_object($r2)) {
-            if ($result->granted_credit==0) continue;   // skip invalid
+            if ($result->granted_credit == 0) continue; // skip invalid
             $host = BoincHost::lookup_id($result->hostid);
             $r = new StdClass;
             $r->cpu_time = $result->cpu_time;
@@ -105,8 +105,8 @@ 
             $results[] = $r;
         }
         //echo "Wu $wu->id -------------\n";
-        if (count($results)<2) continue;
-        for ($i=0; $i<=10; $i++) {
+        if (count($results) < 2) continue;
+        for ($i = 0; $i <= 10; $i++) {
             $fpw = $i/10.;
             $sum[$i] += fpw_var($results, $fpw);
         }
@@ -120,7 +120,7 @@ 
 Number of workunits analyzed: $n
 
 ";
-    for ($i=0; $i<=10; $i++) {
+    for ($i = 0; $i <= 10; $i++) {
         $fpw = $i/10.;
         $r = $sum[$i]/$n;
         echo "FP weight $fpw: variance is $r\n";

html/ops/eah_server_status.php

Doc Comments +3 added lines

@@ -65,6 +65,9 @@
     return $running;
 }
 
+/**
+ * @param boolean $running
+ */
 function show_status($host, $function, $running) {
     echo "<tr><td>$function</td><td>$host</td>";
     if ($running) {

Indentation +3 added lines, -3 removed lines

@@ -41,9 +41,9 @@
 }
 
 function find_oldest() {
-   $result=_mysql_query("select name,create_time from result where server_state=2 order by create_time limit 1");
-   $x = _mysql_fetch_object($result);
-   return $x->create_time;
+    $result=_mysql_query("select name,create_time from result where server_state=2 order by create_time limit 1");
+    $x = _mysql_fetch_object($result);
+    return $x->create_time;
 }
 
 function daemon_status($host, $pidname) {

Spacing +22 added lines, -22 removed lines

@@ -41,7 +41,7 @@ 
 }
 
 function find_oldest() {
-   $result=_mysql_query("select name,create_time from result where server_state=2 order by create_time limit 1");
+   $result = _mysql_query("select name,create_time from result where server_state=2 order by create_time limit 1");
    $x = _mysql_fetch_object($result);
    return $x->create_time;
 }
@@ -88,25 +88,25 @@ 
 
 
 
-$dbrc = db_init(1);    // 1=soft, remember that DB might be down
+$dbrc = db_init(1); // 1=soft, remember that DB might be down
 
-page_head(PROJECT . " - Server Status");
+page_head(PROJECT." - Server Status");
 
 
 // Date stamp
 
 
-echo "<br ALIGN=RIGHT> ".PROJECT. " server status as of ".
-    date("g:i A T"). " on ". date("l, j F Y ") .
+echo "<br ALIGN=RIGHT> ".PROJECT." server status as of ".
+    date("g:i A T")." on ".date("l, j F Y ").
     " (updated every $Nmin minutes).\n";
 
-$proc_uptime=exec("cat /proc/uptime | cut -d\" \" -f-1");
+$proc_uptime = exec("cat /proc/uptime | cut -d\" \" -f-1");
 $days = (int)($proc_uptime/86400);
-$hours=(int)($proc_uptime/3600);
-$hours=$hours % 24;
-$minutes=(int)($proc_uptime/60);
-$minutes=$minutes % 60;
-echo "<br ALIGN=RIGHT>The ".PROJECT. " main server has been continuously up for ". "$days"." days "."$hours"." hours "."$minutes"." minutes.\n<P>";
+$hours = (int)($proc_uptime/3600);
+$hours = $hours%24;
+$minutes = (int)($proc_uptime/60);
+$minutes = $minutes%60;
+echo "<br ALIGN=RIGHT>The ".PROJECT." main server has been continuously up for "."$days"." days "."$hours"." hours "."$minutes"." minutes.\n<P>";
 
 // tables side by side
 echo "<TABLE><TR><TD align=center> \n";
@@ -152,11 +152,11 @@ 
 if ($dbrc) {
     echo "The database server is not accessable";
 } else {
-    $now=time(0);
-    $s_day=24*3600;
-    $d_ago=$now-$s_day;
-    $s_week=7*$s_day;
-    $w_ago=$now-$s_week;
+    $now = time(0);
+    $s_day = 24*3600;
+    $d_ago = $now - $s_day;
+    $s_week = 7*$s_day;
+    $w_ago = $now - $s_week;
 
     echo "
         <table border=2 cellpadding=6>
@@ -276,12 +276,12 @@ 
         <tr><td>invalid</td><td>".number_format($n)."</td></tr>
     ";
 
-    $n = time(0)-find_oldest();
+    $n = time(0) - find_oldest();
     $days = (int)($n/86400);
-    $hours=(int)($n/3600);
-    $hours=$hours % 24;
-    $minutes=(int)($n/60);
-    $minutes=$minutes % 60;
+    $hours = (int)($n/3600);
+    $hours = $hours%24;
+    $minutes = (int)($n/60);
+    $minutes = $minutes%60;
     echo "
         <tr><td>Oldest Unsent Result</td><td>".$days." d ".$hours." h ".$minutes." m</td></tr>
     ";
@@ -297,7 +297,7 @@ 
 
 // Display cgi-bin restriction status
 
-if (  file_exists("../../cgi-bin/.htaccess") ) {
+if (file_exists("../../cgi-bin/.htaccess")) {
     echo "<P><font color=RED>
         <b>The ".PROJECT." scheduler is currently restricted 
 	  to uwm.edu and a few other domains.

html/ops/fix_prefs.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
 // insert "\n</venue>\n" before "</global_preferences>"
 // This fixes an XML error introduced at some point in the past
 //
+/**
+ * @return string
+ */
 function repair_prefs($prefs) {
     if (strstr($prefs, '\"')) {
         return str_replace('\"', '"', $prefs);