BOINC / boinc

html/user/submit_rpc_handler.php

Doc Comments +26 added lines

@@ -30,6 +30,9 @@ 
 ini_set('display_errors', true);
 ini_set('display_startup_errors', true);
 
+/**
+ * @param string $name
+ */
 function get_wu($name) {
     $name = BoincDb::escape_string($name);
     $wu = BoincWorkunit::lookup("name='$name'");
@@ -37,6 +40,9 @@ 
     return $wu;
 }
 
+/**
+ * @param string $name
+ */
 function get_submit_app($name) {
     $name = BoincDb::escape_string($name);
     $app = BoincApp::lookup("name='$name'");
@@ -76,6 +82,9 @@ 
     return $y;
 }
 
+/**
+ * @param SimpleXMLElement|null $template
+ */
 function est_elapsed_time($r, $template) {
     // crude estimate: batch FLOPs / project FLOPS
     //
@@ -131,6 +140,9 @@ 
 // The arg is the batch-level template, if any.
 // Jobs may have their own templates.
 //
+/**
+ * @param SimpleXMLElement $template
+ */
 function validate_batch($jobs, $template) {
     $i = 0;
     $n = count($template->file_info);
@@ -200,6 +212,11 @@ 
 
 // submit a list of jobs with a single create_work command.
 //
+/**
+ * @param SimpleXMLElement|null $template
+ * @param double $priority
+ * @param integer $app_version_num
+ */
 function submit_jobs(
     $jobs, $template, $app, $batch_id, $priority, $app_version_num,
     $input_template_filename,        // batch-level; can also specify per job
@@ -279,6 +296,9 @@ 
 // Check whether the template is already in our map.
 // If not, write it to a temp file.
 //
+/**
+ * @param stdClass $job
+ */
 function make_input_template($job) {
     global $input_templates;
     if (!array_key_exists($job->input_template_xml, $input_templates)) {
@@ -295,6 +315,9 @@ 
 // A little different because these have to exist for life of job.
 // Store them in templates/tmp/, with content-based filenames
 //
+/**
+ * @param stdClass $job
+ */
 function make_output_template($job) {
     global $output_templates;
     if (!array_key_exists($job->output_template_xml, $output_templates)) {
@@ -489,6 +512,9 @@ 
     ";
 }
 
+/**
+ * @param integer $get_cpu_time
+ */
 function print_batch_params($batch, $get_cpu_time) {
     $app = BoincApp::lookup_id($batch->app_id);
     if (!$app) $app->name = "none";

Spacing +23 added lines, -23 removed lines

@@ -54,7 +54,7 @@ 
     if ($template) {
         $t = (double)$template->workunit->rsc_fpops_est;
     }
-    foreach($r->batch->job as $job) {
+    foreach ($r->batch->job as $job) {
         $y = (double)$job->rsc_fpops_est;
         if ($y) {
             $x += $y;
@@ -79,7 +79,7 @@ 
 function est_elapsed_time($r, $template) {
     // crude estimate: batch FLOPs / project FLOPS
     //
-    return batch_flop_count($r, $template) / project_flops();
+    return batch_flop_count($r, $template)/project_flops();
 }
 
 // if batch-level input template filename was given, read it;
@@ -89,9 +89,9 @@ 
 //
 function read_input_template($app, $r) {
     if ((isset($r->batch)) && (isset($r->batch->workunit_template_file)) && ($r->batch->workunit_template_file)) {
-        $path = project_dir() . "/templates/".$r->batch->workunit_template_file;
+        $path = project_dir()."/templates/".$r->batch->workunit_template_file;
     } else {
-        $path = project_dir() . "/templates/$app->name"."_in";
+        $path = project_dir()."/templates/$app->name"."_in";
     }
     if (file_exists($path)) {
         $x = simplexml_load_file($path);
@@ -134,7 +134,7 @@ 
 function validate_batch($jobs, $template) {
     $i = 0;
     $n = count($template->file_info);
-    foreach($jobs as $job) {
+    foreach ($jobs as $job) {
         $m = count($job->input_files);
         if ($n != $m) {
             xml_error(-1, "wrong # of input files for job $i: need $n, got $m");
@@ -189,7 +189,7 @@ 
 // stage all the files
 //
 function stage_files(&$jobs) {
-    foreach($jobs as $job) {
+    foreach ($jobs as $job) {
         foreach ($job->input_files as $file) {
             if ($file->mode != "remote") {
                 $file->name = stage_file($file);
@@ -202,7 +202,7 @@ 
 //
 function submit_jobs(
     $jobs, $template, $app, $batch_id, $priority, $app_version_num,
-    $input_template_filename,        // batch-level; can also specify per job
+    $input_template_filename, // batch-level; can also specify per job
     $output_template_filename
 ) {
     global $input_templates, $output_templates;
@@ -211,7 +211,7 @@ 
     // one line per job
     //
     $x = "";
-    foreach($jobs as $job) {
+    foreach ($jobs as $job) {
         if ($job->name) {
             $x .= " --wu_name $job->name";
         }
@@ -243,8 +243,8 @@ 
         $x .= "\n";
     }
 
-    $errfile = "/tmp/create_work_" . getmypid() . ".err";
-    $cmd = "cd " . project_dir() . "; ./bin/create_work --appname $app->name --batch $batch_id --priority $priority";
+    $errfile = "/tmp/create_work_".getmypid().".err";
+    $cmd = "cd ".project_dir()."; ./bin/create_work --appname $app->name --batch $batch_id --priority $priority";
     if ($input_template_filename) {
         $cmd .= " --wu_template templates/$input_template_filename";
     }
@@ -325,7 +325,7 @@ 
 //
 function xml_get_jobs($r) {
     $jobs = array();
-    foreach($r->batch->job as $j) {
+    foreach ($r->batch->job as $j) {
         $job = new StdClass;
         $job->input_files = array();
         $job->command_line = (string)$j->command_line;
@@ -401,14 +401,14 @@ 
     // - use that for batch logical end time and job priority
     //
     $total_flops = 0;
-    foreach($jobs as $job) {
+    foreach ($jobs as $job) {
         //print_r($job);
         if ($job->rsc_fpops_est) {
             $total_flops += $job->rsc_fpops_est;
         } else if ($job->input_template && $job->input_template->workunit->rsc_fpops_est) {
-            $total_flops += (double) $job->input_template->workunit->rsc_fpops_est;
+            $total_flops += (double)$job->input_template->workunit->rsc_fpops_est;
         } else {
-            $x = (double) $template->workunit->rsc_fpops_est;
+            $x = (double)$template->workunit->rsc_fpops_est;
             if ($x) {
                 $total_flops += $x;
             } else {
@@ -416,7 +416,7 @@ 
             }
         }
     }
-    $cmd = "cd " . project_dir() . "/bin; ./adjust_user_priority --user $user->id --flops $total_flops --app $app->name";
+    $cmd = "cd ".project_dir()."/bin; ./adjust_user_priority --user $user->id --flops $total_flops --app $app->name";
     $x = exec($cmd);
     if (!is_numeric($x) || (double)$x == 0) {
         xml_error(-1, "$cmd returned $x");
@@ -531,7 +531,7 @@ 
 }
 
 function n_outfiles($wu) {
-    $path = project_dir() . "/$wu->output_template_filename";
+    $path = project_dir()."/$wu->output_template_filename";
     $r = simplexml_load_file($path);
     return count($r->file_info);
 }
@@ -726,7 +726,7 @@ 
 ";
         if ($result->server_state == 5) {   // over?
             $paths = get_outfile_paths($result);
-            foreach($paths as $path) {
+            foreach ($paths as $path) {
                 if (is_file($path)) {
                     $size = filesize($path);
                     echo "        <outfile>
@@ -766,7 +766,7 @@ 
     } else {
         $results = BoincResult::enum("workunitid=$job_id");
         foreach ($results as $r) {
-            switch($r->outcome) {
+            switch ($r->outcome) {
             case 1:
             case 3:
             case 6:
@@ -874,8 +874,8 @@ 
     }
 
     list($user, $user_submit) = authenticate_user($r, $app);
-    $in = file_get_contents(project_dir() . "/templates/".$app->name."_in");
-    $out = file_get_contents(project_dir() . "/templates/".$app->name."_out");
+    $in = file_get_contents(project_dir()."/templates/".$app->name."_in");
+    $out = file_get_contents(project_dir()."/templates/".$app->name."_out");
     if ($in === false || $out === false) {
         xml_error(-1, "template file missing");
     }
@@ -886,7 +886,7 @@ 
 
 function ping($r) {
     xml_start_tag("ping");
-    BoincDb::get();     // errors out if DB down or web disabled
+    BoincDb::get(); // errors out if DB down or web disabled
     echo "<success>1</success>
         </ping>
     ";
@@ -952,10 +952,10 @@ 
 if ($request_log) {
     $request_log_dir = parse_config(get_config(), "<log_dir>");
     if ($request_log_dir) {
-        $request_log = $request_log_dir . "/" . $request_log;
+        $request_log = $request_log_dir."/".$request_log;
     }
     if ($file = fopen($request_log, "a+")) {
-        fwrite($file, "\n<submit_rpc_handler date=\"" . date(DATE_ATOM) . "\">\n" . $_POST['request'] . "\n</submit_rpc_handler>\n");
+        fwrite($file, "\n<submit_rpc_handler date=\"".date(DATE_ATOM)."\">\n".$_POST['request']."\n</submit_rpc_handler>\n");
         fclose($file);
     }
 }