Merge pull request #6901 from BOINC/dpa_batch_collect

terminology and filename change

Author: AenBleidd

.gitignore

@@ -196,7 +196,7 @@ sched/get_file
 sched/make_work
 sched/message_handler
 sched/put_file
-sched/sample_assimilator
+sched/batch_collect_assimilator
 sched/sample_bitwise_validator
 sched/sample_dummy_assimilator
 sched/sample_substr_validator

gl

@@ -1,6 +1,6 @@
 // This file is part of BOINC.
 // https://boinc.berkeley.edu
-// Copyright (C) 2025 University of California
+// Copyright (C) 2026 University of California
 //
 // BOINC is free software; you can redistribute it and/or modify it
 // under the terms of the GNU Lesser General Public License

html/inc/submit_util.inc

@@ -285,6 +285,11 @@ function get_outfile_phys_names($result) {
     return $names;
 }
 
+// return two corresponding lists:
+// - logical names of output files
+// - whether files are gzipped (they may not have .gz extension)
+// TODO: return a list of pairs
+//
 function get_outfile_log_names($result) {
     $xml = "<a>".$result->xml_doc_in."</a>";
     $r = simplexml_load_string($xml);
@@ -302,7 +307,7 @@ function get_outfile_log_names($result) {
     return [$names, $gzip];
 }
 
-// get output file paths for non-assim-move apps
+// get output file paths for batch-static apps
 //
 function get_outfile_paths($result) {
     $fanout = parse_config(get_config(), "<uldl_dir_fanout>");
@@ -319,15 +324,19 @@ function get_outfile_paths($result) {
     return $paths;
 }
 
-// the path of an output file in the 'assim move' scheme.
+// Return the path of an output file in the 'batch-collect' paradigm.
 // This must agree with the corresponding assimilators:
-// tools/sample_assimilate.py
-// sched/sample_assimilator.cpp
+// tools/batch_collect_assimilate.py
+// sched/batch_collect_assimilator.cpp
 // and with tools/query_job
 //
-function assim_move_outfile_path($wu, $index, $log_names, $gzip) {
-    if (!is_valid_filename($wu->name)) error_page("bad WU name");
-    if (!is_valid_filename($log_names[$index])) error_page("bad logical name");
+function batch_collect_outfile_path($wu, $index, $log_names, $gzip) {
+    if (!is_valid_filename($wu->name)) {
+        error_page("bad WU name");
+    }
+    if (!is_valid_filename($log_names[$index])) {
+        error_page("bad logical name");
+    }
     return sprintf('../../results/%d/%s__file_%s%s',
         $wu->batch, $wu->name, $log_names[$index],
         $gzip[$index]?'.gz':''
@@ -424,10 +433,12 @@ function retire_batch($batch) {
     }
 }
 
+// batches can have 'expiration times' when they automatically get retired
+// if you run html/ops/expire_batches
+//
 function expire_batch($batch) {
     abort_batch($batch);
     retire_batch($batch);
-    $batch->update("state=".BATCH_STATE_EXPIRED);
 }
 
 function batch_state_string($state) {
@@ -440,7 +451,7 @@ function batch_state_string($state) {
     }
     return "unknown state $state";
 }
-// get the total size of output files of a batch for non-assim-move apps
+// get the total size of output files of a batch for batch-static apps
 // (i.e. files are in the upload hier)
 //
 function batch_output_file_size($batchid) {

html/user/get_output2.php

@@ -18,11 +18,10 @@
 // along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
 
 // web API for fetching output files.
-// This is for apps that don't use an assimilator
-// that moves output files into project/results/...
+// This is for apps that don't use the batch-collect paradigm.
 // I.e., the output files are in the upload hierarchy with physical names
 //
-// For assim_move apps, use get_output3.php instead of this.
+// For batch_collect apps, use get_output3.php instead of this.
 
 // This is an updated version of get_output.php;
 // I didn't want to change that on the (unlikely) chance

html/user/get_output3.php

@@ -18,7 +18,9 @@
 // along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
 
 // get output files, individually or zipped groups,
-// for apps that use the 'assim move' scheme
+// for apps that use the 'batch-collect' paradigm
+// implemented by batch_collect_assimilator.cpp and batch_collect_assimilate.py:
+// <project>/results/<batchid>/   (0 if not in a batch)
 //
 // args:
 // action: get_file or get_batch
@@ -28,9 +30,6 @@
 // get_batch:
 //      batch_id
 //      downloads zip of batch's output files
-//      Assumes the layout used by sample_assimilator.cpp
-//      and sample_assimilate.py:
-//      <project>/results/<batchid>/   (0 if not in a batch)
 
 require_once("../inc/util.inc");
 require_once("../inc/submit_util.inc");
@@ -68,7 +67,7 @@ function get_file() {
     if ($index >= count($log_names)) {
         error_page('bad index');
     }
-    $path = assim_move_outfile_path($wu, $index, $log_names, $gzip);
+    $path = batch_collect_outfile_path($wu, $index, $log_names, $gzip);
 
     if (get_str('download', true)) {
         do_download($path);

html/user/show_apps.php

@@ -1,4 +1,26 @@
 <?php
+// This file is part of BOINC.
+// https://boinc.berkeley.edu
+// Copyright (C) 2026 University of California
+//
+// BOINC is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License
+// as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// BOINC is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+// See the GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
+
+// Show a list of applications provided by the project,
+// including BUDA science apps.
+// This assumes that you have created a file html/project/remote_apps.inc
+// describing these applications.
+// Intended for BOINC Central type projects.
 
 require_once('../inc/util.inc');
 require_once('../inc/buda.inc');

html/user/submit.php

@@ -677,7 +677,7 @@ function handle_query_batch($user) {
         $owner = BoincUser::lookup_id($batch->user_id);
     }
 
-    $is_assim_move = is_assim_move($app);
+    $is_batch_collect = is_batch_collect($app);
 
     page_head("Batch $batch_id");
     text_start(800);
@@ -708,15 +708,15 @@ function handle_query_batch($user) {
     }
     row2("GFLOP/hours, estimated", number_format(credit_to_gflop_hours($batch->credit_estimate), 2));
     row2("GFLOP/hours, actual", number_format(credit_to_gflop_hours($batch->credit_canonical), 2));
-    if (!$is_assim_move) {
+    if (!$is_batch_collect) {
         row2("Total size of output files",
             size_string(batch_output_file_size($batch->id))
         );
     }
     end_table();
 
     echo "<p>";
-    if ($is_assim_move) {
+    if ($is_batch_collect) {
         //if (is_batch_gzipped($wus)) {
         if (true) {
             $url = "get_output3.php?action=get_batch_tar&batch_id=$batch->id";
@@ -824,16 +824,15 @@ function handle_query_batch($user) {
     page_tail();
 }
 
-// Does the assimilator for the given app move output files
-// to a results/<batchid>/ directory?
+// Does the app use the batch-collect paradigm?
 // This info is stored in the $remote_apps data structure in project.inc
 //
-function is_assim_move($app) {
+function is_batch_collect($app) {
     global $remote_apps;
     foreach ($remote_apps as $category => $apps) {
         foreach ($apps as $web_app) {
             if ($web_app->app_name == $app->name) {
-                return $web_app->is_assim_move;
+                return $web_app->batch_collect;
             }
         }
     }
@@ -848,7 +847,7 @@ function handle_query_job($user) {
     if (!$wu) error_page("no such job");
 
     $app = BoincApp::lookup_id($wu->appid);
-    $is_assim_move = is_assim_move($app);
+    $is_batch_collect = is_batch_collect($app);
 
     page_head("Job '$wu->name'");
 
@@ -886,13 +885,15 @@ function handle_query_job($user) {
             $result->priority
         ];
         $files = [];
-        if ($is_assim_move) {
+        if ($is_batch_collect) {
             if ($result->id == $wu->canonical_resultid) {
                 [$log_names, $gzip] = get_outfile_log_names($result);
                 $nfiles = count($log_names);
                 for ($i=0; $i<$nfiles; $i++) {
                     $name = $log_names[$i];
-                    $path = assim_move_outfile_path($wu, $i, $log_names, $gzip);
+                    $path = batch_collect_outfile_path(
+                        $wu, $i, $log_names, $gzip
+                    );
                     if (file_exists($path)) {
                         $y = sprintf('%s (%s): ',
                             $name, size_string(filesize($path))

py/Boinc/setup_project.py

@@ -405,7 +405,7 @@ def dest(*dirs):
             'pshelper',
             'put_file',
             'pymw_assimilator.py',
-            'sample_assimilator',
+            'batch_collect_assimilator',
             'sample_bitwise_validator',
             'sample_dummy_assimilator',
             'sample_substr_validator',
@@ -442,7 +442,7 @@ def dest(*dirs):
             'parse_config',
             'query_job',
             'run_in_ops',
-            'sample_assimilate.py',
+            'batch_collect_assimilate.py',
             'sign_executable',
             'stage_file',
             'stage_file_native',

sched/Makefile.am

@@ -103,6 +103,7 @@ schedbin_PROGRAMS = \
 
 schedshare_PROGRAMS = \
     antique_file_deleter \
+    batch_collect_assimilator \
     census \
     credit_test \
     db_dump \
@@ -111,7 +112,6 @@ schedshare_PROGRAMS = \
     feeder_user \
     file_deleter \
     message_handler \
-    sample_assimilator \
     sample_bitwise_validator \
     sample_dummy_assimilator \
     sample_substr_validator \
@@ -188,6 +188,10 @@ cgi_sources = \
 cgi_SOURCES = $(cgi_sources)
 cgi_LDADD = $(SERVERLIBS)
 
+batch_collect_assimilator_SOURCES = $(ASSIMILATOR_SOURCES) \
+	batch_collect_assimilator.cpp
+batch_collect_assimilator_LDADD = $(SERVERLIBS)
+
 census_SOURCES = \
     census.cpp \
     hr.cpp \
@@ -248,10 +252,6 @@ sample_dummy_assimilator_SOURCES = $(ASSIMILATOR_SOURCES) \
 	sample_dummy_assimilator.cpp
 sample_dummy_assimilator_LDADD = $(SERVERLIBS)
 
-sample_assimilator_SOURCES = $(ASSIMILATOR_SOURCES) \
-	sample_assimilator.cpp
-sample_assimilator_LDADD = $(SERVERLIBS)
-
 single_job_assimilator_SOURCES = $(ASSIMILATOR_SOURCES) \
 	single_job_assimilator.cpp
 single_job_assimilator_LDADD = $(SERVERLIBS)

sched/sample_assimilator.cpp sched/batch_collect_assimilator.cppsched/sample_assimilator.cpp renamed to sched/batch_collect_assimilator.cpp

@@ -15,7 +15,7 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
 
-// A sample assimilator that:
+// An assimilator that implements the batch-collect paradigm:
 // 1) if success, copy the output file(s) to a directory
 //      ../results/<batchid>/<wu_name>__file_<log_name>
 //      where <log_name> is the file's logical name