BOINC / boinc

html/inc/user.inc

Doc Comments +3 added lines

@@ -113,6 +113,9 @@
     return ($a->expavg_credit < $b->expavg_credit)? 1 : -1;
 }
 
+/**
+ * @param boolean $personal
+ */
 function show_other_projects($user, $personal) {
     if (!isset($user->projects)) return;
     if (count($user->projects) < 2) return;

Spacing +18 added lines, -18 removed lines

@@ -33,13 +33,13 @@ 
 // they've participated in
 //
 function get_other_projects($user) {
-    $cpid = md5($user->cross_project_id . $user->email_addr);
+    $cpid = md5($user->cross_project_id.$user->email_addr);
     $url = "http://boinc.netsoft-online.com/get_user.php?cpid=".$cpid;
 
     // Check the cache for that URL
     //
     $cacheddata = get_cached_data(REMOTE_PROJECTS_TTL, $url);
-    if ($cacheddata){
+    if ($cacheddata) {
         $remote = unserialize($cacheddata);
     } else {
         // Fetch the XML, use curl if fopen() is disallowed
@@ -110,7 +110,7 @@ 
 
 function cmp($a, $b) {
     if ($a->expavg_credit == $b->expavg_credit) return 0;
-    return ($a->expavg_credit < $b->expavg_credit)? 1 : -1;
+    return ($a->expavg_credit < $b->expavg_credit) ? 1 : -1;
 }
 
 function show_other_projects($user, $personal) {
@@ -133,7 +133,7 @@ 
         ),
         array("", ALIGN_RIGHT, ALIGN_RIGHT, ALIGN_RIGHT)
     );
-    foreach($user->projects as $project) {
+    foreach ($user->projects as $project) {
         show_project($project);
     }
     end_table();
@@ -161,7 +161,7 @@ 
     $config = get_config();
     row2(tra("Computers on this account"), "<a href=\"hosts_user.php\">".tra("View")."</a>");
     row2(tra("Tasks"), "<a href=\"results.php?userid=$user->id\">".tra("View")."</a>");
-    $cpid = md5($user->cross_project_id . $user->email_addr);
+    $cpid = md5($user->cross_project_id.$user->email_addr);
     $x = "";
     shuffle($cpid_stats_sites);
     foreach ($cpid_stats_sites as $site) {
@@ -308,7 +308,7 @@ 
 // show user name, with links to profile if present.
 // if $badge_height is > 0, show badges
 //
-function user_links($user, $badge_height=0) {
+function user_links($user, $badge_height = 0) {
     BoincForumPrefs::lookup($user);
     if (is_banished($user)) {
         return "(banished: ID $user->id)";
@@ -330,7 +330,7 @@ 
     if ($badge_height) {
         $x .= badges_string(true, $user, $badge_height);
     }
-    if (function_exists("project_user_links")){
+    if (function_exists("project_user_links")) {
         $x .= project_user_links($user);
     }
     return $x;
@@ -383,7 +383,7 @@ 
 
             // if there's a foundership request, notify the founder
             //
-            if ($user->id==$team->userid && $team->ping_user >0) {
+            if ($user->id == $team->userid && $team->ping_user > 0) {
                 $x .= "<p class=\"text-danger\">".tra("(foundership change request pending)")."</p>";
             }
             row2(tra("Member of team"), $x);
@@ -408,7 +408,7 @@ 
     $x = "<a href=\"user_search.php\">".tra("Find friends")."</a><br/>\n";
     $n = count($friends);
     if ($n) {
-        foreach($friends as $friend) {
+        foreach ($friends as $friend) {
             $fuser = BoincUser::lookup_id($friend->user_dest);
             if (!$fuser) continue;
             $x .= friend_links($fuser);
@@ -461,7 +461,7 @@ 
 // Returns a cacheable community links data object
 // @param user The user to produce a community links object for
 
-function get_community_links_object($user){
+function get_community_links_object($user) {
     $cache_object = new StdClass;
     $cache_object->post_count = total_posts($user);
     $cache_object->user = $user;
@@ -469,7 +469,7 @@ 
     $cache_object->friends = array();
 
     $friends = BoincFriend::enum("user_src=$user->id and reciprocated=1");
-    foreach($friends as $friend) {
+    foreach ($friends as $friend) {
         $fuser = BoincUser::lookup_id($friend->user_dest);
         if (!$fuser) continue;
         $cache_object->friends[] = $fuser;
@@ -477,7 +477,7 @@ 
     return $cache_object;
 }
 
-function community_links($clo, $logged_in_user){
+function community_links($clo, $logged_in_user) {
     $user = $clo->user;
     $team = $clo->team;
     $friends = $clo->friends;
@@ -503,15 +503,15 @@ 
                 "<a href=\"friend.php?action=cancel_confirm&userid=$user->id\">".tra("Cancel friendship")."</a>"
             );
         } else if ($friend) {
-            row2(tra("Friends"),  "<a href=\"friend.php?action=add&userid=$user->id\">".tra("Request pending")."</a>");
+            row2(tra("Friends"), "<a href=\"friend.php?action=add&userid=$user->id\">".tra("Request pending")."</a>");
         } else {
-            row2(tra("Friends"),  "<a href=\"friend.php?action=add&userid=$user->id\">".tra("Add as friend")."</a>");
+            row2(tra("Friends"), "<a href=\"friend.php?action=add&userid=$user->id\">".tra("Add as friend")."</a>");
         }
     }
     
     if ($friends) {
         $x = "";
-        foreach($friends as $friend) {
+        foreach ($friends as $friend) {
             $x .= friend_links($friend);
         }
         row2(tra("Friends")." (".sizeof($friends).")", $x);
@@ -554,7 +554,7 @@ 
 function is_banned_email_addr($email_addr) {
     global $banned_email_domains;
     if (isset($banned_email_domains)) {
-        foreach($banned_email_domains as $d) {
+        foreach ($banned_email_domains as $d) {
             $x = strstr($email_addr, $d);
             if ($x == $d) return true;
         }
@@ -582,7 +582,7 @@ 
 //
 function make_user(
     $email_addr, $name, $passwd_hash,
-    $country=null, $postal_code=null, $project_prefs=null, $teamid=0
+    $country = null, $postal_code = null, $project_prefs = null, $teamid = 0
 ) {
     if (!is_valid_email_addr($email_addr)) return null;
     if (is_banned_email_addr($email_addr)) return null;
@@ -654,6 +654,6 @@ 
     $user->delete();
 }
 
-$cvs_version_tracker[]="\$Id$";  //Generated automatically - do not edit
+$cvs_version_tracker[] = "\$Id$"; //Generated automatically - do not edit
 
 ?>

Braces +27 added lines, -9 removed lines

@@ -109,13 +109,19 @@ 
 }
 
 function cmp($a, $b) {
-    if ($a->expavg_credit == $b->expavg_credit) return 0;
+    if ($a->expavg_credit == $b->expavg_credit) {
+        return 0;
+    }
     return ($a->expavg_credit < $b->expavg_credit)? 1 : -1;
 }
 
 function show_other_projects($user, $personal) {
-    if (!isset($user->projects)) return;
-    if (count($user->projects) < 2) return;
+    if (!isset($user->projects)) {
+        return;
+    }
+    if (count($user->projects) < 2) {
+        return;
+    }
 
     usort($user->projects, "cmp");
     if ($personal) {
@@ -410,7 +416,9 @@ 
     if ($n) {
         foreach($friends as $friend) {
             $fuser = BoincUser::lookup_id($friend->user_dest);
-            if (!$fuser) continue;
+            if (!$fuser) {
+                continue;
+            }
             $x .= friend_links($fuser);
         }
         row2(tra("Friends")." ($n)", $x);
@@ -471,7 +479,9 @@ 
     $friends = BoincFriend::enum("user_src=$user->id and reciprocated=1");
     foreach($friends as $friend) {
         $fuser = BoincUser::lookup_id($friend->user_dest);
-        if (!$fuser) continue;
+        if (!$fuser) {
+            continue;
+        }
         $cache_object->friends[] = $fuser;
     }
     return $cache_object;
@@ -556,7 +566,9 @@ 
     if (isset($banned_email_domains)) {
         foreach($banned_email_domains as $d) {
             $x = strstr($email_addr, $d);
-            if ($x == $d) return true;
+            if ($x == $d) {
+                return true;
+            }
         }
     }
     return false;
@@ -584,13 +596,19 @@ 
     $email_addr, $name, $passwd_hash,
     $country=null, $postal_code=null, $project_prefs=null, $teamid=0
 ) {
-    if (!is_valid_email_addr($email_addr)) return null;
-    if (is_banned_email_addr($email_addr)) return null;
+    if (!is_valid_email_addr($email_addr)) {
+        return null;
+    }
+    if (is_banned_email_addr($email_addr)) {
+        return null;
+    }
 
     $authenticator = random_string();
     $cross_project_id = random_string();
     $now = time();
-    if (!is_valid_country($country)) return null;
+    if (!is_valid_country($country)) {
+        return null;
+    }
 
     $email_addr = BoincDb::escape_string($email_addr);
     $name = sanitize_tags($name);

html/inc/util.inc

Doc Comments +52 added lines

@@ -106,6 +106,9 @@ 
     return secure_url_base();
 }
 
+/**
+ * @param string $name
+ */
 function send_cookie($name, $value, $permanent, $ops=false) {
     global $master_url;
 
@@ -455,6 +458,9 @@ 
     ";
 }
 
+/**
+ * @param string $x
+ */
 function row2_init($x, $y, $lwidth='40%') {
     echo '<tr>
         <td class="text-right " width="'.$lwidth.'"  style="padding-right: 20px;">'.$x.'</td>
@@ -466,6 +472,9 @@ 
     echo "<tr><td>$x</td><td>$y</td></tr>\n";
 }
 
+/**
+ * @param string $string
+ */
 function rowify($string) {
     echo "<tr><td>$string</td></tr>";
 }
@@ -491,6 +500,9 @@ 
     echo "</tr>\n";
 }
 
+/**
+ * @param string $x
+ */
 function row_heading($x) {
     echo '<tr><th class="bg-primary" colspan=99>'.$x.'</th></tr>
     ';
@@ -555,6 +567,11 @@ 
 // If $ellipsis is true, then an ellipsis is added to any sentence which
 // is cut short.
 
+/**
+ * @param string $sentence
+ * @param string $delimiter
+ * @param integer $max_chars
+ */
 function sub_sentence($sentence, $delimiter, $max_chars, $ellipsis=false) {
     $words = explode($delimiter, $sentence);
     $total_chars = 0;
@@ -605,6 +622,9 @@ 
     ob_implicit_flush(0);
 }
 
+/**
+ * @param string $filename
+ */
 function close_output_buffer($filename) {
     $fh = fopen($filename, "w");
     $page = ob_get_contents();
@@ -673,6 +693,9 @@ 
 
 // returns null if the arg is optional and missing
 //
+/**
+ * @param string $name
+ */
 function post_int($name, $optional=false) {
     $x = post_num($name, $optional);
     if (is_null($x)) return null;
@@ -772,6 +795,9 @@ 
 
 // Generate a "select" element from an array of values
 //
+/**
+ * @param string $name
+ */
 function select_from_array($name, $array, $selection=null, $width=240) {
     $out = '<select style="color:#000;"class="form-control input-sm" style="width:'.$width.'px" name="'.$name.'">"';
 
@@ -833,6 +859,9 @@ 
     ";
 }
 
+/**
+ * @param string $text
+ */
 function button_text($url, $text, $desc=null, $class="btn btn-default") {
     if (!$desc) $desc = $text;
     return "<a href=\"".$url."\" title=\"$desc\" class=\"".$class."\">".$text."</a>
@@ -854,6 +883,12 @@ 
 
 // used for showing icons
 //
+/**
+ * @param string $src
+ * @param string $title
+ * @param string $alt
+ * @param string $height
+ */
 function show_image($src, $title, $alt, $height=null) {
     $h = "";
     if ($height) {
@@ -969,6 +1004,9 @@ 
     }
 }
 
+/**
+ * @param integer $f
+ */
 function flops_to_credit($f) {
     return $f*(200/86400e9);
 }
@@ -1004,6 +1042,9 @@ 
     }
 }
 
+/**
+ * @param integer $height
+ */
 function badges_string($is_user, $item, $height) {
     if (DISABLE_BADGES) return null;
     if ($is_user) {
@@ -1020,6 +1061,9 @@ 
     return $x;
 }
 
+/**
+ * @param boolean $is_user
+ */
 function show_badges_row($is_user, $item) {
     if (BADGE_HEIGHT_LARGE == 0) return;
     $x = badges_string($is_user, $item, BADGE_HEIGHT_LARGE);
@@ -1064,6 +1108,11 @@ 
 // return HTML for a textarea with chars-remaining counter.
 // Call text_counter_script() before using this.
 //
+/**
+ * @param string $name
+ * @param integer $maxlen
+ * @param string $text
+ */
 function textarea_with_counter($name, $maxlen, $text) {
     $rem_name = $name."_remaining";
     return "<textarea name=\"$name\" class=\"form-control\" rows=3 id=\"$name\" onkeydown=\"text_counter(this.form.$name, this.form.$rem_name, $maxlen);\"
@@ -1082,6 +1131,9 @@ 
     return sprintf("%d.%d.%d", $maj, $min, $v);
 }
 
+/**
+ * @param string $url
+ */
 function google_search_form($url) {
     echo "
         <nobr>

Indentation +6 added lines, -6 removed lines

@@ -868,13 +868,13 @@
         if ($generating_xml) {
             xml_error(-183);
         } else {
-			if (!$did_page_head) {
-				page_head(tra("Project down for maintenance"));
-			}
+            if (!$did_page_head) {
+                page_head(tra("Project down for maintenance"));
+            }
             echo tra(
-				"%1 is temporarily shut down for maintenance.  Please try again later.",
-				PROJECT
-			);
+                "%1 is temporarily shut down for maintenance.  Please try again later.",
+                PROJECT
+            );
             page_tail();
             exit();
         }

Spacing +71 added lines, -71 removed lines

@@ -34,8 +34,8 @@ 
 // parse some stuff from config (do it here for efficiency)
 //
 $config = get_config();
-$master_url = parse_config($config , "<master_url>");
-$no_computing =  parse_bool($config, "no_computing");
+$master_url = parse_config($config, "<master_url>");
+$no_computing = parse_bool($config, "no_computing");
 $recaptcha_public_key = parse_config($config, "<recaptcha_public_key>");
 $recaptcha_private_key = parse_config($config, "<recaptcha_private_key>");
 
@@ -106,7 +106,7 @@ 
     return secure_url_base();
 }
 
-function send_cookie($name, $value, $permanent, $ops=false) {
+function send_cookie($name, $value, $permanent, $ops = false) {
     global $master_url;
 
     // the following allows independent login for projects on the same server
@@ -117,11 +117,11 @@ 
         $path = substr($path, 0, -1);
         $path .= "_ops/";
     }
-    $expire = $permanent?time()+3600*24*365:0;
+    $expire = $permanent ? time() + 3600*24*365 : 0;
     setcookie($name, $value, $expire, $path);
 }
 
-function clear_cookie($name, $ops=false) {
+function clear_cookie($name, $ops = false) {
     global $master_url;
     $url = parse_url($master_url);
     $path = $url['path'];
@@ -129,13 +129,13 @@ 
         $path = substr($path, 0, -1);
         $path .= "_ops/";
     }
-    setcookie($name, '', time()-3600, $path);
+    setcookie($name, '', time() - 3600, $path);
 }
 
 $g_logged_in_user = null;
 $got_logged_in_user = false;
 
-function get_logged_in_user($must_be_logged_in=true) {
+function get_logged_in_user($must_be_logged_in = true) {
     global $g_logged_in_user, $got_logged_in_user;
     if ($got_logged_in_user) return $g_logged_in_user;
 
@@ -154,7 +154,7 @@ 
             $next_url = $_SERVER['REQUEST_URI'];
             $n = strrpos($next_url, "/");
             if ($n) {
-                $next_url = substr($next_url, $n+1);
+                $next_url = substr($next_url, $n + 1);
             }
         }
         $next_url = urlencode($next_url);
@@ -165,7 +165,7 @@ 
     return $g_logged_in_user;
 }
 
-function show_login_info($prefix="") {
+function show_login_info($prefix = "") {
     $user = get_logged_in_user(false);
     if ($user) {
         $url_tokens = url_tokens($user->authenticator);
@@ -175,7 +175,7 @@ 
     }
 }
 
-$cache_control_extra="";
+$cache_control_extra = "";
 $is_login_page = false;
 
 // Call this to start pages.
@@ -187,11 +187,11 @@ 
 // with an existing web framework can more easily do so.
 // To do so, define page_head() in the project include file.
 //
-if (!function_exists("page_head")){
+if (!function_exists("page_head")) {
 function page_head(
     $title,
         // page title. Put in <title>, used as title for browser tab.
-    $body_attrs=null,
+    $body_attrs = null,
         // <body XXXX>
         // e.g. Javascript to put focus in an input field
         // (onload="document.form.foo.focus()")
@@ -200,10 +200,10 @@ 
         // if set, include schedulers.txt.
         // also pass to project_banner() in case you want a different
         // header for your main page.
-    $url_prefix="",
+    $url_prefix = "",
         // prepend this to links.
         // Use for web pages not in the top directory
-    $head_extra=null
+    $head_extra = null
         // extra stuff to put in <head>. E.g.:
         // reCAPTCHA code (create_profile.php)
         // bbcode javascript (forums)
@@ -214,15 +214,15 @@ 
     $did_page_head = true;
     $url_base = url_base();
 
-    $rssname = PROJECT . " RSS 2.0";
+    $rssname = PROJECT." RSS 2.0";
     $rsslink = $url_base."rss_main.php";
 
     if (!$caching) {
         header("Content-type: text/html; charset=utf-8");
-        header ("Expires: Mon, 26 Jul 1997 05:00:00 UTC");    // Date in the past
-        header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " UTC"); // always modified
-        header ("Cache-Control: $cache_control_extra no-cache, must-revalidate, post-check=0, pre-check=0");  // HTTP/1.1
-        header ("Pragma: no-cache");                          // HTTP/1.0
+        header("Expires: Mon, 26 Jul 1997 05:00:00 UTC"); // Date in the past
+        header("Last-Modified: ".gmdate("D, d M Y H:i:s")." UTC"); // always modified
+        header("Cache-Control: $cache_control_extra no-cache, must-revalidate, post-check=0, pre-check=0"); // HTTP/1.1
+        header("Pragma: no-cache"); // HTTP/1.0
     }
 
     echo '<!DOCTYPE html>
@@ -233,11 +233,11 @@ 
     if ($head_extra) {
         echo "\n$head_extra\n";
     }
-    if ($is_main && (!defined('NO_COMPUTING')||!NO_COMPUTING)) {
+    if ($is_main && (!defined('NO_COMPUTING') || !NO_COMPUTING)) {
         readfile("schedulers.txt");
     }
 
-    $t = $title?$title:PROJECT;
+    $t = $title ? $title : PROJECT;
     echo "<title>$t</title>\n";
     echo '
         <meta charset="utf-8">
@@ -273,7 +273,7 @@ 
     echo '<div class="container-fluid">
     ';
 
-    switch($title) {    //kludge
+    switch ($title) {    //kludge
     case tra("Log in"):
     case tra("Create an account"):
     case tra("Server status page"):
@@ -289,13 +289,13 @@ 
 
 // See the comments for page_head()
 //
-if (!function_exists("page_tail")){
+if (!function_exists("page_tail")) {
 function page_tail(
-    $show_date=false,
+    $show_date = false,
         // true for pages that are generated periodically rather than on the fly
-    $url_prefix="",
+    $url_prefix = "",
         // use for pages not at top level
-    $is_main=false
+    $is_main = false
         // passed to project_footer;
 ) {
     project_footer($is_main, $show_date, $url_prefix);
@@ -309,10 +309,10 @@ 
 }
 }
 
-function display_cvs_versions(){
+function display_cvs_versions() {
     global $cvs_version_tracker;
     echo "\n<!-- SVN VERSIONS -->\n";
-    for ($i=0;$i<sizeof($cvs_version_tracker);$i++) {
+    for ($i = 0; $i < sizeof($cvs_version_tracker); $i++) {
         echo "<!-- ".$cvs_version_tracker[$i]." -->\n";
     }
 }
@@ -339,9 +339,9 @@ 
 
 function time_diff($x) {
     $days    = (int)($x/86400);
-    $hours   = (int)(($x-$days*86400)/3600);
-    $minutes = (int)(($x-$days*86400-$hours*3600)/60);
-    $seconds = (int)($x % 60);
+    $hours   = (int)(($x - $days*86400)/3600);
+    $minutes = (int)(($x - $days*86400 - $hours*3600)/60);
+    $seconds = (int)($x%60);
 
     $datestring = "";
     if ($days) {
@@ -368,7 +368,7 @@ 
 
 function time_str($x) {
     if ($x == 0) return "---";
-    return gmdate('j M Y, G:i:s', $x) . " UTC";
+    return gmdate('j M Y, G:i:s', $x)." UTC";
 }
 
 function local_time_str($x) {
@@ -380,14 +380,14 @@ 
     return time_str($x);
 }
 
-function start_table_str($class="", $style="") {
-    $s = $style?'style="'.$style.'"':'';
+function start_table_str($class = "", $style = "") {
+    $s = $style ? 'style="'.$style.'"' : '';
     return '<div class="table">
       <table '.$s.' width="100%" class="table table-condensed '.$class.'" >
     ';
 }
 
-function start_table($class="", $style="") {
+function start_table($class = "", $style = "") {
     echo start_table_str($class, $style);
 }
 
@@ -432,7 +432,7 @@ 
     echo "</tr>\n";
 }
 
-function row1($x, $ncols=2, $class="heading") {
+function row1($x, $ncols = 2, $class = "heading") {
     if ($class == "heading") {
         echo "<tr><th class=\"bg-primary\" colspan=\"$ncols\">$x</th></tr>\n";
     } else {
@@ -444,10 +444,10 @@ 
 define('VALUE_ATTRS', 'style="padding-left:12px"');
 define('VALUE_ATTRS_ERR', 'class="danger" style="padding-left:12px"');
 
-function row2($x, $y, $show_error=false, $lwidth='40%') {
-    if ($x==="") $x="<br>";
-    if ($y==="") $y="<br>";
-    $attrs = $show_error?VALUE_ATTRS_ERR:VALUE_ATTRS;
+function row2($x, $y, $show_error = false, $lwidth = '40%') {
+    if ($x === "") $x = "<br>";
+    if ($y === "") $y = "<br>";
+    $attrs = $show_error ? VALUE_ATTRS_ERR : VALUE_ATTRS;
     echo "<tr>
         <td width=\"$lwidth\" ".NAME_ATTRS.">$x</td>
         <td $attrs >$y</td>
@@ -455,7 +455,7 @@ 
     ";
 }
 
-function row2_init($x, $y, $lwidth='40%') {
+function row2_init($x, $y, $lwidth = '40%') {
     echo '<tr>
         <td class="text-right " width="'.$lwidth.'"  style="padding-right: 20px;">'.$x.'</td>
         <td '.VALUE_ATTRS.'>'.$y.'
@@ -478,13 +478,13 @@ 
     echo "</tr>\n";
 }
 
-define ('ALIGN_RIGHT', 'style="text-align:right;"');
+define('ALIGN_RIGHT', 'style="text-align:right;"');
 
-function row_heading_array($x, $attrs=null, $class='bg-primary') {
+function row_heading_array($x, $attrs = null, $class = 'bg-primary') {
     echo "<tr>";
     $i = 0;
     foreach ($x as $h) {
-        $a = $attrs?$attrs[$i]:"";
+        $a = $attrs ? $attrs[$i] : "";
         echo "<th $a class=\"$class\">$h</th>";
         $i++;
     }
@@ -555,7 +555,7 @@ 
 // If $ellipsis is true, then an ellipsis is added to any sentence which
 // is cut short.
 
-function sub_sentence($sentence, $delimiter, $max_chars, $ellipsis=false) {
+function sub_sentence($sentence, $delimiter, $max_chars, $ellipsis = false) {
     $words = explode($delimiter, $sentence);
     $total_chars = 0;
     $trunc = false;
@@ -638,8 +638,8 @@ 
 
 // returns null if the arg is optional and missing
 //
-function get_int($name, $optional=false) {
-    $x=null;
+function get_int($name, $optional = false) {
+    $x = null;
     if (isset($_GET[$name])) $x = $_GET[$name];
     if (!is_numeric($x)) {
         if ($optional) {
@@ -658,7 +658,7 @@ 
 
 // returns null if the arg is optional and missing
 //
-function post_num($name, $optional=false) {
+function post_num($name, $optional = false) {
     $x = null;
     if (isset($_POST[$name])) $x = $_POST[$name];
     if (!is_numeric($x)) {
@@ -673,7 +673,7 @@ 
 
 // returns null if the arg is optional and missing
 //
-function post_int($name, $optional=false) {
+function post_int($name, $optional = false) {
     $x = post_num($name, $optional);
     if (is_null($x)) return null;
     $y = (int)$x;
@@ -691,7 +691,7 @@ 
     }
 }
 
-function get_str($name, $optional=false) {
+function get_str($name, $optional = false) {
     if (isset($_GET[$name])) {
         $x = $_GET[$name];
     } else {
@@ -703,7 +703,7 @@ 
     return undo_magic_quotes($x);
 }
 
-function post_str($name, $optional=false) {
+function post_str($name, $optional = false) {
     if (isset($_POST[$name])) {
         $x = $_POST[$name];
     } else {
@@ -715,7 +715,7 @@ 
     return undo_magic_quotes($x);
 }
 
-function post_arr($name, $optional=false) {
+function post_arr($name, $optional = false) {
     if (isset($_POST[$name]) && is_array($_POST[$name])) {
         $x = $_POST[$name];
     } else {
@@ -731,7 +731,7 @@ 
     // the mb_* functions are not included by default
     // return (mb_detect_encoding($passwd) -= 'ASCII');
 
-    for ($i=0; $i<strlen($str); $i++) {
+    for ($i = 0; $i < strlen($str); $i++) {
         $c = ord(substr($str, $i));
         if ($c < 32 || $c > 127) return false;
     }
@@ -755,7 +755,7 @@ 
     $number = str_replace(',', '.', $number); // replace the german decimal separator
     // if no value was entered and this is ok
     //
-    if ($number=='' && !$low) return true;
+    if ($number == '' && !$low) return true;
 
     // the supplied value contains alphabetic characters
     //
@@ -772,7 +772,7 @@ 
 
 // Generate a "select" element from an array of values
 //
-function select_from_array($name, $array, $selection=null, $width=240) {
+function select_from_array($name, $array, $selection = null, $width = 240) {
     $out = '<select style="color:#000;"class="form-control input-sm" style="width:'.$width.'px" name="'.$name.'">"';
 
     foreach ($array as $key => $value) {
@@ -797,8 +797,8 @@ 
     return $str;
 }
 
-function strip_bbcode($string){
-    return preg_replace("/((\[.+\])+?)(.+?)((\[\/.+\])+?)/","",$string);
+function strip_bbcode($string) {
+    return preg_replace("/((\[.+\])+?)(.+?)((\[\/.+\])+?)/", "", $string);
 }
 
 function current_url() {
@@ -825,7 +825,7 @@ 
 // @param desc The title of the destination - typically used as a popup
 // @param class The optional CSS class of the button. Defaults to a standard button
 //
-function show_button($url, $text, $desc=null, $class="btn btn-default btn-xs") {
+function show_button($url, $text, $desc = null, $class = "btn btn-default btn-xs") {
     if (!$desc) {
         $desc = $text;
     }
@@ -833,7 +833,7 @@ 
     ";
 }
 
-function button_text($url, $text, $desc=null, $class="btn btn-default") {
+function button_text($url, $text, $desc = null, $class = "btn btn-default") {
     if (!$desc) $desc = $text;
     return "<a href=\"".$url."\" title=\"$desc\" class=\"".$class."\">".$text."</a>
     ";
@@ -846,7 +846,7 @@ 
 // @param desc The title of the destination - typically used as a popup
 // @param class The optional CSS class of the button. Defaults to a standard button
 //
-function show_actionlist_button($url, $text, $desc, $class="btn btn-default"){
+function show_actionlist_button($url, $text, $desc, $class = "btn btn-default") {
     echo "<li>";
     echo show_button($url, $text, $desc, $class);
     echo "</li>";
@@ -854,7 +854,7 @@ 
 
 // used for showing icons
 //
-function show_image($src, $title, $alt, $height=null) {
+function show_image($src, $title, $alt, $height = null) {
     $h = "";
     if ($height) {
         $h = "height=\"$height\"";
@@ -886,7 +886,7 @@ 
 // tries instead to connect to <replica_db_host> if tag exists.
 // DEPRECATED - use boinc_db.inc
 //
-function db_init($try_replica=false) {
+function db_init($try_replica = false) {
     check_web_stopped();
     $retval = db_init_aux($try_replica);
     if ($retval == 1) {
@@ -954,7 +954,7 @@ 
 function sanitize_numeric($x) {
     if (is_numeric($x)) {
         return $x;
-    } else if (trim($x) == '' ) {
+    } else if (trim($x) == '') {
         return '';
     } else {
         return "not numeric";
@@ -977,9 +977,9 @@ 
     return $c/(200/24);
 }
 
-function do_download($path,$name="") {
-    if (strcmp($name,"") == 0) {
-        $name=basename($path);
+function do_download($path, $name = "") {
+    if (strcmp($name, "") == 0) {
+        $name = basename($path);
     }
     header('Content-Description: File Transfer');
     header('Content-Type: application/octet-stream');
@@ -988,7 +988,7 @@ 
     header('Expires: 0');
     header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
     header('Pragma: public');
-    header('Content-Length: ' . filesize($path));
+    header('Content-Length: '.filesize($path));
     flush();
     readfile($path);
 }
@@ -1036,10 +1036,10 @@ 
 // Otherwise return 0.
 // Format of user agent string is "BOINC client (windows_x86_64 7.3.17)"
 //
-function boinc_client_version(){
+function boinc_client_version() {
     if (!array_key_exists('HTTP_USER_AGENT', $_SERVER)) return 0;
     $x = $_SERVER['HTTP_USER_AGENT'];
-    $e =  "/BOINC client [^ ]* (\d+).(\d+).(\d+)\)/";
+    $e = "/BOINC client [^ ]* (\d+).(\d+).(\d+)\)/";
     if (preg_match($e, $x, $matches)) {
         return $matches[1]*10000 + $matches[2]*100 + $matches[3];
     }
@@ -1068,7 +1068,7 @@ 
     $rem_name = $name."_remaining";
     return "<textarea name=\"$name\" class=\"form-control\" rows=3 id=\"$name\" onkeydown=\"text_counter(this.form.$name, this.form.$rem_name, $maxlen);\"
         onkeyup=\"text_counter(this.form.$name, this.form.$rem_name, $maxlen);\">".$text."</textarea>
-        <br><input name=\"$rem_name\" type=\"text\" id=\"$rem_name\" value=\"".($maxlen-strlen($text))."\" size=\"3\" maxlength=\"3\" readonly> ".tra("characters remaining")
+        <br><input name=\"$rem_name\" type=\"text\" id=\"$rem_name\" value=\"".($maxlen - strlen($text))."\" size=\"3\" maxlength=\"3\" readonly> ".tra("characters remaining")
     ;
 }
 
@@ -1095,6 +1095,6 @@ 
     ";
 }
 
-$cvs_version_tracker[]="\$Id$";  //Generated automatically - do not edit
+$cvs_version_tracker[] = "\$Id$"; //Generated automatically - do not edit
 
 ?>

Braces +90 added lines, -30 removed lines

@@ -98,7 +98,9 @@ 
 }
 
 function secure_url_base() {
-    if (defined('SECURE_URL_BASE')) return SECURE_URL_BASE;
+    if (defined('SECURE_URL_BASE')) {
+        return SECURE_URL_BASE;
+    }
     return URL_BASE;
 }
 
@@ -137,12 +139,18 @@ 
 
 function get_logged_in_user($must_be_logged_in=true) {
     global $g_logged_in_user, $got_logged_in_user;
-    if ($got_logged_in_user) return $g_logged_in_user;
+    if ($got_logged_in_user) {
+        return $g_logged_in_user;
+    }
 
-    if (web_stopped()) return null;
+    if (web_stopped()) {
+        return null;
+    }
 
     $authenticator = null;
-    if (isset($_COOKIE['auth'])) $authenticator = $_COOKIE['auth'];
+    if (isset($_COOKIE['auth'])) {
+        $authenticator = $_COOKIE['auth'];
+    }
 
     $authenticator = BoincDb::escape_string($authenticator);
     if ($authenticator) {
@@ -362,17 +370,23 @@ 
 
 
 function date_str($x) {
-    if ($x == 0) return "---";
+    if ($x == 0) {
+        return "---";
+    }
     return gmdate('j M Y', $x);
 }
 
 function time_str($x) {
-    if ($x == 0) return "---";
+    if ($x == 0) {
+        return "---";
+    }
     return gmdate('j M Y, G:i:s', $x) . " UTC";
 }
 
 function local_time_str($x) {
-    if ($x == 0) return "---";
+    if ($x == 0) {
+        return "---";
+    }
     return date('j M Y, H:i T', $x);
 }
 
@@ -445,8 +459,12 @@ 
 define('VALUE_ATTRS_ERR', 'class="danger" style="padding-left:12px"');
 
 function row2($x, $y, $show_error=false, $lwidth='40%') {
-    if ($x==="") $x="<br>";
-    if ($y==="") $y="<br>";
+    if ($x==="") {
+        $x="<br>";
+    }
+    if ($y==="") {
+        $y="<br>";
+    }
     $attrs = $show_error?VALUE_ATTRS_ERR:VALUE_ATTRS;
     echo "<tr>
         <td width=\"$lwidth\" ".NAME_ATTRS.">$x</td>
@@ -523,16 +541,26 @@ 
     if (!$ttok) {
         $ttok = $_POST['ttok'];
     }
-    if (!$tnow) return false;
-    if (!$ttok) return false;
+    if (!$tnow) {
+        return false;
+    }
+    if (!$ttok) {
+        return false;
+    }
     $t = md5((string)$tnow.$auth);
-    if ($t != $ttok) return false;
-    if (time() > $tnow + 86400) return false;
+    if ($t != $ttok) {
+        return false;
+    }
+    if (time() > $tnow + 86400) {
+        return false;
+    }
     return true;
 }
 
 function check_tokens($auth) {
-    if (valid_tokens($auth)) return;
+    if (valid_tokens($auth)) {
+        return;
+    }
     error_page(
         tra("Link has timed out. Please click Back, refresh the page, and try again.")
     );
@@ -640,7 +668,9 @@ 
 //
 function get_int($name, $optional=false) {
     $x=null;
-    if (isset($_GET[$name])) $x = $_GET[$name];
+    if (isset($_GET[$name])) {
+        $x = $_GET[$name];
+    }
     if (!is_numeric($x)) {
         if ($optional) {
             if ($x) {
@@ -660,7 +690,9 @@ 
 //
 function post_num($name, $optional=false) {
     $x = null;
-    if (isset($_POST[$name])) $x = $_POST[$name];
+    if (isset($_POST[$name])) {
+        $x = $_POST[$name];
+    }
     if (!is_numeric($x)) {
         if ($optional) {
             return null;
@@ -675,7 +707,9 @@ 
 //
 function post_int($name, $optional=false) {
     $x = post_num($name, $optional);
-    if (is_null($x)) return null;
+    if (is_null($x)) {
+        return null;
+    }
     $y = (int)$x;
     if ($x != $y) {
         error_page("param $name must be an integer");
@@ -733,7 +767,9 @@ 
 
     for ($i=0; $i<strlen($str); $i++) {
         $c = ord(substr($str, $i));
-        if ($c < 32 || $c > 127) return false;
+        if ($c < 32 || $c > 127) {
+            return false;
+        }
     }
     return true;
 }
@@ -755,16 +791,24 @@ 
     $number = str_replace(',', '.', $number); // replace the german decimal separator
     // if no value was entered and this is ok
     //
-    if ($number=='' && !$low) return true;
+    if ($number=='' && !$low) {
+        return true;
+    }
 
     // the supplied value contains alphabetic characters
     //
-    if (!is_numeric($number)) return false;
+    if (!is_numeric($number)) {
+        return false;
+    }
 
-    if ($number < $low) return false;
+    if ($number < $low) {
+        return false;
+    }
 
     if ($high) {
-        if ($number > $high) return false;
+        if ($number > $high) {
+            return false;
+        }
     }
     $value = (double)$number;
     return true;
@@ -834,7 +878,9 @@ 
 }
 
 function button_text($url, $text, $desc=null, $class="btn btn-default") {
-    if (!$desc) $desc = $text;
+    if (!$desc) {
+        $desc = $text;
+    }
     return "<a href=\"".$url."\" title=\"$desc\" class=\"".$class."\">".$text."</a>
     ";
 }
@@ -939,9 +985,15 @@ 
 //
 function sanitize_local_url($x) {
     $x = trim($x, "/");
-    if (strstr($x, "/")) return "";
-    if (strstr($x, "<")) return "";
-    if (strstr($x, "\"")) return "";
+    if (strstr($x, "/")) {
+        return "";
+    }
+    if (strstr($x, "<")) {
+        return "";
+    }
+    if (strstr($x, "\"")) {
+        return "";
+    }
     return $x;
 }
 
@@ -1005,13 +1057,17 @@ 
 }
 
 function badges_string($is_user, $item, $height) {
-    if (DISABLE_BADGES) return null;
+    if (DISABLE_BADGES) {
+        return null;
+    }
     if ($is_user) {
         $bus = BoincBadgeUser::enum("user_id=$item->id");
     } else {
         $bus = BoincBadgeTeam::enum("team_id=$item->id");
     }
-    if (!$bus) return null;
+    if (!$bus) {
+        return null;
+    }
     $x = "";
     foreach ($bus as $bu) {
         $badge = BoincBadge::lookup_id($bu->badge_id);
@@ -1021,7 +1077,9 @@ 
 }
 
 function show_badges_row($is_user, $item) {
-    if (BADGE_HEIGHT_LARGE == 0) return;
+    if (BADGE_HEIGHT_LARGE == 0) {
+        return;
+    }
     $x = badges_string($is_user, $item, BADGE_HEIGHT_LARGE);
     if ($x) {
         row2("Badges", $x);
@@ -1037,7 +1095,9 @@ 
 // Format of user agent string is "BOINC client (windows_x86_64 7.3.17)"
 //
 function boinc_client_version(){
-    if (!array_key_exists('HTTP_USER_AGENT', $_SERVER)) return 0;
+    if (!array_key_exists('HTTP_USER_AGENT', $_SERVER)) {
+        return 0;
+    }
     $x = $_SERVER['HTTP_USER_AGENT'];
     $e =  "/BOINC client [^ ]* (\d+).(\d+).(\d+)\)/";
     if (preg_match($e, $x, $matches)) {

html/inc/util_basic.inc

Doc Comments +13 added lines

@@ -36,6 +36,10 @@ 
     return file_exists("$d/stop_sched");
 }
 
+/**
+ * @param string $x
+ * @param string $y
+ */
 function show_page($x, $y) {
     echo "
         <title>$x</title>
@@ -44,6 +48,9 @@ 
     ";
 }
 
+/**
+ * @param integer $num
+ */
 function xml_error($num, $msg=null, $file=null, $line=null) {
     global $xml_outer_tag;
     if (!$msg) {
@@ -107,6 +114,9 @@ 
     return trim($element);
 }
 
+/**
+ * @param string $tag
+ */
 function parse_next_element($xml, $tag, &$cursor) {
     $element = null;
     $closetag = "</" . substr($tag,1);
@@ -137,6 +147,9 @@ 
 
 // look for a particular element in the config file
 //
+/**
+ * @param string $tag
+ */
 function parse_config($config, $tag) {
     $element = parse_element($config, $tag);
     return $element;

Spacing +5 added lines, -5 removed lines

@@ -44,10 +44,10 @@ 
     ";
 }
 
-function xml_error($num, $msg=null, $file=null, $line=null) {
+function xml_error($num, $msg = null, $file = null, $line = null) {
     global $xml_outer_tag;
     if (!$msg) {
-        switch($num) {
+        switch ($num) {
         case -112: $msg = "Invalid XML"; break;
         case -136: $msg = "Not found"; break;
         case -137: $msg = "Name or email address is not unique"; break;
@@ -94,7 +94,7 @@ 
 //
 function parse_element($xml, $tag) {
     $element = null;
-    $closetag = "</" . substr($tag,1);
+    $closetag = "</".substr($tag, 1);
     $x = strstr($xml, $tag);
     if ($x) {
         if (strstr($tag, "/>")) return $tag;
@@ -109,8 +109,8 @@ 
 
 function parse_next_element($xml, $tag, &$cursor) {
     $element = null;
-    $closetag = "</" . substr($tag,1);
-    $pos = substr($xml,$cursor);
+    $closetag = "</".substr($tag, 1);
+    $pos = substr($xml, $cursor);
     $x = strstr($pos, $tag);
     if ($x) {
         if (strstr($tag, "/>")) return $tag;

Braces +24 added lines, -8 removed lines

@@ -97,7 +97,9 @@ 
     $closetag = "</" . substr($tag,1);
     $x = strstr($xml, $tag);
     if ($x) {
-        if (strstr($tag, "/>")) return $tag;
+        if (strstr($tag, "/>")) {
+            return $tag;
+        }
         $y = substr($x, strlen($tag));
         $n = strpos($y, $closetag);
         if ($n) {
@@ -113,7 +115,9 @@ 
     $pos = substr($xml,$cursor);
     $x = strstr($pos, $tag);
     if ($x) {
-        if (strstr($tag, "/>")) return $tag;
+        if (strstr($tag, "/>")) {
+            return $tag;
+        }
         $y = substr($x, strlen($tag));
         $n = strpos($y, $closetag);
         if ($n) {
@@ -128,10 +132,14 @@ 
 //
 function parse_bool($xml, $tag) {
     $x = "<$tag/>";
-    if (strstr($xml, $x)) return true;
+    if (strstr($xml, $x)) {
+        return true;
+    }
     $x = "<$tag>";
     $y = (int)parse_element($xml, $x);
-    if ($y != 0) return true;
+    if ($y != 0) {
+        return true;
+    }
     return false;
 }
 
@@ -149,10 +157,18 @@ 
 // kludge
 //
 function is_gpu($plan_class) {
-    if (strstr($plan_class, "ati")) return true;
-    if (strstr($plan_class, "cuda")) return true;
-    if (strstr($plan_class, "nvidia")) return true;
-    if (strstr($plan_class, "intel_gpu")) return true;
+    if (strstr($plan_class, "ati")) {
+        return true;
+    }
+    if (strstr($plan_class, "cuda")) {
+        return true;
+    }
+    if (strstr($plan_class, "nvidia")) {
+        return true;
+    }
+    if (strstr($plan_class, "intel_gpu")) {
+        return true;
+    }
     return false;
 }
 

html/inc/util_ops.inc

Doc Comments +17 added lines

@@ -65,10 +65,17 @@ 
          . "<p>\n";
 }
 
+/**
+ * @param string $x
+ */
 function row($x, $y) {
     echo "<tr><td valign=\"top\" align=\"right\">$x</td>\n<td>$y</td>\n</tr>\n";
 }
 
+/**
+ * @param string $color
+ * @param string $x
+ */
 function c_row2($color, $x, $y) {
     echo "<tr bgcolor=\"$color\"><td align=\"right\">$x</td><td>$y</td></tr>\n";
 }
@@ -134,6 +141,9 @@ 
 
 // allow access only if logged in as user in a given set
 //
+/**
+ * @param integer[] $admin_user_ids
+ */
 function auth_ops_userid($admin_user_ids) {
     $user = get_logged_in_user_ops();
     if (!$user) {
@@ -288,6 +298,10 @@ 
 
 ////// badge-related stuff
 
+/**
+ * @param string $name
+ * @param string $title
+ */
 function get_badge($name, $title, $image_url) {
     $b = BoincBadge::lookup("name='$name'");
     if ($b) return $b;
@@ -319,6 +333,9 @@ 
 
 // unassign all badges except the given one
 //
+/**
+ * @param integer $k
+ */
 function unassign_badges($is_user, $item, $badges, $k) {
     $list = null;
     for ($i=0; $i<count($badges); $i++) {

Indentation +2 added lines, -2 removed lines

@@ -62,7 +62,7 @@ 
 
 function print_text_field($text,$name,$value) {
     echo "$text <input type=\"text\" size=\"10\" name=\"$name\" value=\"$value\">\n"
-         . "<p>\n";
+            . "<p>\n";
 }
 
 function row($x, $y) {
@@ -378,7 +378,7 @@ 
         $db->do_query($q4);
         return 2;
     } else if (!$db->do_query($q3)) {
-      echo "MySQL command '$q3' failed:<br/>unable to cancel workunits and trigger transitioner.<br>\n";
+        echo "MySQL command '$q3' failed:<br/>unable to cancel workunits and trigger transitioner.<br>\n";
         $db->do_query($q4);
         return 3;
     }

Spacing +10 added lines, -10 removed lines

@@ -46,21 +46,21 @@ 
 
 // TODO: get rid of all the following
 
-function print_checkbox($text,$name,$checked) {
+function print_checkbox($text, $name, $checked) {
     echo "<input type=\"checkbox\" name=\"$name\""
-        . (strlen($checked) ? " checked=\"checked\"" : "") . ">"
+        . (strlen($checked) ? " checked=\"checked\"" : "").">"
         . "$text\n"
         . "<p>\n";
 }
 
-function print_radio_button($text,$name,$value,$checked) {
+function print_radio_button($text, $name, $value, $checked) {
     echo "<input type=\"radio\" name=\"$name\" value=\"$value\""
-        . (strlen($checked) ? " checked=\"checked\"" : "") . ">"
+        . (strlen($checked) ? " checked=\"checked\"" : "").">"
         . "$text\n"
         . "<br>\n";
 }
 
-function print_text_field($text,$name,$value) {
+function print_text_field($text, $name, $value) {
     echo "$text <input type=\"text\" size=\"10\" name=\"$name\" value=\"$value\">\n"
          . "<p>\n";
 }
@@ -91,7 +91,7 @@ 
     if ($host == null) {
         $host = "localhost";
     }
-    $in = fopen("php://stdin","r");
+    $in = fopen("php://stdin", "r");
     print "Database username (default: owner of mysqld process): ";
     $user = rtrim(fgets($in, 80));
     print "Database password (if any): ";
@@ -103,7 +103,7 @@ 
     }
 }
 
-function print_login_form_ops($next_url='') {
+function print_login_form_ops($next_url = '') {
     if ($next_url == '') $next_url = $_SERVER['REQUEST_URI'];
     start_table();
     echo "
@@ -200,7 +200,7 @@ 
 // return a list of the current, non-deprecated ones
 //
 function current_versions($avs) {
-    foreach($avs as $av) {
+    foreach ($avs as $av) {
         foreach ($avs as $av2) {
             if ($av->id == $av2->id) continue;
             if ($av->platformid == $av2->platformid && $av->plan_class == $av2->plan_class && $av->version_num > $av2->version_num) {
@@ -209,7 +209,7 @@ 
         }
     }
     $x = array();
-    foreach($avs as $av) {
+    foreach ($avs as $av) {
         if (!$av->deprecated) $x[] = $av;
     }
     return $x;
@@ -321,7 +321,7 @@ 
 //
 function unassign_badges($is_user, $item, $badges, $k) {
     $list = null;
-    for ($i=0; $i<count($badges); $i++) {
+    for ($i = 0; $i < count($badges); $i++) {
         if ($i == $k) continue;
         $badge = $badges[$i];
         if ($list) {

Braces +27 added lines, -9 removed lines

@@ -104,7 +104,9 @@ 
 }
 
 function print_login_form_ops($next_url='') {
-    if ($next_url == '') $next_url = $_SERVER['REQUEST_URI'];
+    if ($next_url == '') {
+        $next_url = $_SERVER['REQUEST_URI'];
+    }
     start_table();
     echo "
         <form method=post action=login_action.php>
@@ -119,9 +121,13 @@ 
 
 function get_logged_in_user_ops() {
     global $g_logged_in_user;
-    if ($g_logged_in_user) return $g_logged_in_user;
+    if ($g_logged_in_user) {
+        return $g_logged_in_user;
+    }
     $authenticator = null;
-    if (isset($_COOKIE['auth'])) $authenticator = $_COOKIE['auth'];
+    if (isset($_COOKIE['auth'])) {
+        $authenticator = $_COOKIE['auth'];
+    }
 
     $authenticator = BoincDb::escape_string($authenticator);
     if ($authenticator) {
@@ -202,7 +208,9 @@ 
 function current_versions($avs) {
     foreach($avs as $av) {
         foreach ($avs as $av2) {
-            if ($av->id == $av2->id) continue;
+            if ($av->id == $av2->id) {
+                continue;
+            }
             if ($av->platformid == $av2->platformid && $av->plan_class == $av2->plan_class && $av->version_num > $av2->version_num) {
                 $av2->deprecated = 1;
             }
@@ -210,7 +218,9 @@ 
     }
     $x = array();
     foreach($avs as $av) {
-        if (!$av->deprecated) $x[] = $av;
+        if (!$av->deprecated) {
+            $x[] = $av;
+        }
     }
     return $x;
 }
@@ -245,7 +255,9 @@ 
     $wus = BoincWorkunit::enum("id >= $id1 and id <= $id2");
     foreach ($wus as $wu) {
         $results = BoincResult::enum("workunitid=$wu->id and server_state > 2");
-        if (count($results)) continue;
+        if (count($results)) {
+            continue;
+        }
         $retval = BoincResult::update_aux("server_state=5, outcome=5 where workunitid=$wu->id");
         if (!$retval) {
             error_page("result update failed");
@@ -290,11 +302,15 @@ 
 
 function get_badge($name, $title, $image_url) {
     $b = BoincBadge::lookup("name='$name'");
-    if ($b) return $b;
+    if ($b) {
+        return $b;
+    }
     $now = time();
     $id = BoincBadge::insert("(create_time, name, title, image_url) values ($now, '$name', '$title', 'img/$image_url')");
     $b = BoincBadge::lookup_id($id);
-    if ($b) return $b;
+    if ($b) {
+        return $b;
+    }
     die("can't create badge $name\n");
 }
 
@@ -322,7 +338,9 @@ 
 function unassign_badges($is_user, $item, $badges, $k) {
     $list = null;
     for ($i=0; $i<count($badges); $i++) {
-        if ($i == $k) continue;
+        if ($i == $k) {
+            continue;
+        }
         $badge = $badges[$i];
         if ($list) {
             $list .= ",$badge->id";

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,

Braces +6 added lines, -2 removed lines

@@ -42,7 +42,9 @@ 
 ) {
     $url = $project_url."/lookup_account.php?email_addr=".urlencode($email_addr)."&passwd_hash=$passwd_hash";
     $reply = fetch_url($url);
-    if (!$reply) return array(null, -1, "HTTP error");
+    if (!$reply) {
+        return array(null, -1, "HTTP error");
+    }
     $r = @simplexml_load_string($reply);
     if (!$r) {
         return array(null, -1, "Can't parse reply XML:\n$reply");
@@ -67,7 +69,9 @@ 
 
     //echo "url: $url\n";
     $reply = fetch_url($url);
-    if (!$reply) return array(null, -1, "HTTP error");
+    if (!$reply) {
+        return array(null, -1, "HTTP error");
+    }
     //echo "reply: $reply\n";
     $r = @simplexml_load_string($reply);
     if (!$r) {

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";

Braces +9 added lines, -3 removed lines

@@ -26,15 +26,21 @@
         return ERR_PROJECT_DOWN;
     }
     $db = BoincDb::get();
-    if (!$db) return ERR_DB_CANT_CONNECT;
+    if (!$db) {
+        return ERR_DB_CANT_CONNECT;
+    }
     return 0;
 }
 
 // write PHP warnings as XML, so that the reply can be parsed by client
 //
 function error_handler($errno, $errstr, $errfile, $errline) {
-    if ($errno == E_WARNING) $errno = "Warning";
-    if ($errno == E_NOTICE) $errno = "Notice";
+    if ($errno == E_WARNING) {
+        $errno = "Warning";
+    }
+    if ($errno == E_NOTICE) {
+        $errno = "Notice";
+    }
     echo "<error>
     <error_msg><![CDATA[$errstr]]></error_msg>
     <type>$errno</type>

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;

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>

Braces +27 added lines, -9 removed lines

@@ -115,10 +115,14 @@ 
 function filter_array($array) {
     global $snap, $filter, $filter_cat, $breakdown, $breakdown_cat;
 
-    if (!$filter && !$breakdown) return $array;
+    if (!$filter && !$breakdown) {
+        return $array;
+    }
     $x = array();
     foreach ($array as $y) {
-        if (!array_key_exists($y->user_id, $snap->users)) continue;
+        if (!array_key_exists($y->user_id, $snap->users)) {
+            continue;
+        }
         $u = $snap->users[$y->user_id];
         if ($filter && $filter->categorize($u) != $filter_cat) {
             continue;
@@ -136,7 +140,9 @@ 
 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 +158,9 @@ 
             $n++;
         }
     }
-    if ($n ==0) return 0;
+    if ($n ==0) {
+        return 0;
+    }
     return $sum/$n;
 }
 
@@ -180,7 +188,9 @@ 
         $a = filter_array($snap->questions[$unit->name]);
         $n = 0;
         foreach ($a as $q) {
-            if ($q->mode == $mode) $n++;
+            if ($q->mode == $mode) {
+                $n++;
+            }
         }
         return $n;
     }
@@ -194,7 +204,9 @@ 
     if (array_key_exists($unit->name, $snap->views)) {
         $a = filter_array($snap->views[$unit->name]);
         foreach ($a as $x) {
-            if ($x->mode == $mode) $y[] = $x;
+            if ($x->mode == $mode) {
+                $y[] = $x;
+            }
         }
     }
     return $y;
@@ -358,7 +370,9 @@ 
 
 function show_unit_recurse($unit, $level) {
     show_unit($unit, $level);
-    if ($unit->is_item) return;
+    if ($unit->is_item) {
+        return;
+    }
     foreach ($unit->units as $u) {
         show_unit_recurse($u, $level+1);
     }
@@ -431,7 +445,9 @@ 
         </tr>
     ";
     foreach ($qs as $q) {
-        if ($q->mode != $mode) continue;
+        if ($q->mode != $mode) {
+            continue;
+        }
         $user = $snap->users[$q->user_id];
         echo "<tr>
             <td>".time_str($q->create_time)."</td>
@@ -446,7 +462,9 @@ 
 
 $course_id = get_int('course_id');
 $course = BoltCourse::lookup_id($course_id);
-if (!$course) error_page("no course");
+if (!$course) {
+    error_page("no course");
+}
 $top_unit = require_once($course->doc_file());
 
 $action = get_str('action', true);

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)");

Braces +27 added lines, -9 removed lines

@@ -161,7 +161,9 @@ 
 
 function show_batch($batch_id) {
     $batch = BossaBatch::lookup_id($batch_id);
-    if (!$batch) error_page("No such batch");
+    if (!$batch) {
+        error_page("No such batch");
+    }
     include_app_file($batch->app_id);
     admin_page_head("Jobs for batch $batch->name");
     $jobs = BossaJob::enum("batch_id=$batch_id");
@@ -293,7 +295,9 @@ 
 $user = get_logged_in_user();
 
 $db = BossaDb::get();
-if (!$db) error_page("Can't connect to database server");
+if (!$db) {
+    error_page("Can't connect to database server");
+}
 
 if (!$db->table_exists('bossa_app')) {
     admin_page_head("Create Bossa database");
@@ -330,11 +334,17 @@ 
         $courseid = 0;
     }
     $time_estimate = get_str('time_estimate');
-    if (!$time_estimate) $time_estimate = 60;
+    if (!$time_estimate) {
+        $time_estimate = 60;
+    }
     $time_limit = get_str('time_limit');
-    if (!$time_limit) $time_limit = 3600;
+    if (!$time_limit) {
+        $time_limit = 3600;
+    }
     $calibration_frac = get_str('calibration_frac' , true);
-    if (!$calibration_frac) $calibration_frac = 0;
+    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)");
     if ($courseid) {
@@ -344,8 +354,12 @@ 
     exit;
 case 'update_user':
     $flags = 0;
-    if (get_str('show_all', true)) $flags |= BOLT_FLAGS_SHOW_ALL;
-    if (get_str('debug', true)) $flags |= BOLT_FLAGS_DEBUG;
+    if (get_str('show_all', true)) {
+        $flags |= BOLT_FLAGS_SHOW_ALL;
+    }
+    if (get_str('debug', true)) {
+        $flags |= BOLT_FLAGS_DEBUG;
+    }
     $user->bossa->update("flags=$flags");
     $user->bossa->flags = $flags;
     Header('Location: bossa_admin.php');
@@ -368,13 +382,17 @@ 
 case 'hide':
     $app_id = get_int('app_id');
     $app = BossaApp::lookup_id($app_id);
-    if (!$app) error_page("no such app");
+    if (!$app) {
+        error_page("no such app");
+    }
     $app->update("hidden=1");
     break;
 case 'unhide':
     $app_id = get_int('app_id');
     $app = BossaApp::lookup_id($app_id);
-    if (!$app) error_page("no such app");
+    if (!$app) {
+        error_page("no such app");
+    }
     $app->update("hidden=0");
     break;
 case 'clear_batch_confirm':