BOINC / boinc

html/inc/util.inc

Doc Comments +58 added lines

@@ -126,6 +126,9 @@ 
     return is_https()?secure_url_base():URL_BASE;
 }
 
+/**
+ * @param string $name
+ */
 function send_cookie($name, $value, $permanent, $ops=false) {
     global $master_url;
 
@@ -208,6 +211,9 @@ 
 // To do so, define page_head() in the project include file.
 //
 if (!function_exists("page_head")){
+/**
+ * @param string $body_attrs
+ */
 function page_head(
     $title,
         // page title. Put in <title>, used as title for browser tab.
@@ -476,6 +482,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>
@@ -487,6 +496,9 @@ 
     echo "<tr><td>$x</td><td>$y</td></tr>\n";
 }
 
+/**
+ * @param string $string
+ */
 function rowify($string) {
     echo "<tr><td>$string</td></tr>";
 }
@@ -512,6 +524,9 @@ 
     echo "</tr>\n";
 }
 
+/**
+ * @param string $x
+ */
 function row_heading($x, $class='bg-primary') {
     echo sprintf('<tr><th class="%s" colspan=99>%s</th></tr>
         ', $class, $x
@@ -574,6 +589,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;
@@ -624,6 +644,9 @@ 
     ob_implicit_flush(0);
 }
 
+/**
+ * @param string $filename
+ */
 function close_output_buffer($filename) {
     $fh = fopen($filename, "w");
     $page = ob_get_contents();
@@ -692,6 +715,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;
@@ -791,6 +817,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.'">"';
 
@@ -854,18 +883,33 @@ 
     );
 }
 
+/**
+ * @param string $text
+ * @param string $desc
+ */
 function show_button($url, $text, $desc=null, $class="btn-success btn-sm") {
     echo button_text($url, $text, $desc=null, $class);
 }
 
 // for places with a bunch of buttons, like forum posts
 //
+/**
+ * @param string $url
+ * @param string $text
+ * @param string $desc
+ */
 function show_button_small($url, $text, $desc=null) {
     echo button_text($url, $text, $desc, "btn-primary btn-xs");
 }
 
 // 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) {
@@ -986,6 +1030,9 @@ 
     }
 }
 
+/**
+ * @param integer $f
+ */
 function flops_to_credit($f) {
     return $f*(200/86400e9);
 }
@@ -1020,6 +1067,9 @@ 
     }
 }
 
+/**
+ * @param integer $height
+ */
 function badges_string($is_user, $item, $height) {
     if (DISABLE_BADGES) return null;
     if ($is_user) {
@@ -1036,6 +1086,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);
@@ -1080,6 +1133,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);\"

Spacing +76 added lines, -76 removed lines

@@ -34,7 +34,7 @@ 
 // parse some stuff from config (do it here for efficiency)
 //
 $config = get_config();
-$master_url = parse_config($config , "<master_url>");
+$master_url = parse_config($config, "<master_url>");
 $recaptcha_public_key = parse_config($config, "<recaptcha_public_key>");
 $recaptcha_private_key = parse_config($config, "<recaptcha_private_key>");
 
@@ -123,10 +123,10 @@ 
 }
 
 function url_base() {
-    return is_https()?secure_url_base():URL_BASE;
+    return is_https() ?secure_url_base() : 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
@@ -137,11 +137,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'];
@@ -149,13 +149,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;
 
@@ -174,7 +174,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);
@@ -185,7 +185,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);
@@ -195,7 +195,7 @@ 
     }
 }
 
-$cache_control_extra="";
+$cache_control_extra = "";
 $is_login_page = false;
 
 // Call this to start pages.
@@ -207,11 +207,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()")
@@ -220,10 +220,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)
@@ -239,10 +239,10 @@ 
 
     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>
@@ -253,11 +253,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">
@@ -293,7 +293,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"):
@@ -309,13 +309,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;
 ) {
     echo "<br>\n";
@@ -330,10 +330,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";
     }
 }
@@ -358,23 +358,23 @@ 
 // takes argument in second and returns a human formatted time string
 // in the form D days + h Hours + m Min + s sec.
 
-function time_diff($x, $res=3) {
+function time_diff($x, $res = 3) {
     $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) {
         $datestring .= "$days ".tra("days")." ";
     }
-    if ($res>0 && ($hours || strlen($datestring))) {
+    if ($res > 0 && ($hours || strlen($datestring))) {
         $datestring .= "$hours ".tra("hours")." ";
     }
-    if ($res>1 && ($minutes || strlen($datestring))) {
+    if ($res > 1 && ($minutes || strlen($datestring))) {
         $datestring .= "$minutes ".tra("min")." ";
     }
-    if ($res>2 && ($seconds)) {
+    if ($res > 2 && ($seconds)) {
         $datestring .= "$seconds ".tra("sec")." ";
     }
 
@@ -389,7 +389,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) {
@@ -401,14 +401,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);
 }
 
@@ -453,7 +453,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 {
@@ -465,10 +465,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>
@@ -476,7 +476,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.'
@@ -499,20 +499,20 @@ 
     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++;
     }
     echo "</tr>\n";
 }
 
-function row_heading($x, $class='bg-primary') {
+function row_heading($x, $class = 'bg-primary') {
     echo sprintf('<tr><th class="%s" colspan=99>%s</th></tr>
         ', $class, $x
     );
@@ -574,7 +574,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;
@@ -657,8 +657,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) {
@@ -677,7 +677,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)) {
@@ -692,7 +692,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;
@@ -710,7 +710,7 @@ 
     }
 }
 
-function get_str($name, $optional=false) {
+function get_str($name, $optional = false) {
     if (isset($_GET[$name])) {
         $x = $_GET[$name];
     } else {
@@ -722,7 +722,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 {
@@ -734,7 +734,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 {
@@ -750,7 +750,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;
     }
@@ -774,7 +774,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
     //
@@ -791,7 +791,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) {
@@ -816,8 +816,8 @@ 
     return $str;
 }
 
-function strip_bbcode($string){
-    return preg_replace("/((\[.+\])+?)(.+?)((\[\/.+\])+?)/","",$string);
+function strip_bbcode($string) {
+    return preg_replace("/((\[.+\])+?)(.+?)((\[\/.+\])+?)/", "", $string);
 }
 
 function current_url() {
@@ -845,7 +845,7 @@ 
 // @param class The optional CSS class of the button. Defaults to a standard button
 //
 
-function button_text($url, $text, $desc=null, $class="btn-success btn-sm") {
+function button_text($url, $text, $desc = null, $class = "btn-success btn-sm") {
     if (!$desc) {
         $desc = $text;
     }
@@ -854,19 +854,19 @@ 
     );
 }
 
-function show_button($url, $text, $desc=null, $class="btn-success btn-sm") {
-    echo button_text($url, $text, $desc=null, $class);
+function show_button($url, $text, $desc = null, $class = "btn-success btn-sm") {
+    echo button_text($url, $text, $desc = null, $class);
 }
 
 // for places with a bunch of buttons, like forum posts
 //
-function show_button_small($url, $text, $desc=null) {
+function show_button_small($url, $text, $desc = null) {
     echo button_text($url, $text, $desc, "btn-primary btn-xs");
 }
 
 // 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\"";
@@ -903,7 +903,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) {
@@ -971,7 +971,7 @@ 
 function sanitize_numeric($x) {
     if (is_numeric($x)) {
         return $x;
-    } else if (trim($x) == '' ) {
+    } else if (trim($x) == '') {
         return '';
     } else {
         return "not numeric";
@@ -994,9 +994,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');
@@ -1005,7 +1005,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);
 }
@@ -1052,10 +1052,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];
     }
@@ -1084,7 +1084,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")
     ;
 }
 
@@ -1111,6 +1111,6 @@ 
     ";
 }
 
-$cvs_version_tracker[]="\$Id$";  //Generated automatically - do not edit
+$cvs_version_tracker[] = "\$Id$"; //Generated automatically - do not edit
 
 ?>