Skip to content

Commit 95973bd

Browse files
ckrauseckrause
committed
refactor submitter
1 parent 04f4045 commit 95973bd

File tree

8 files changed

+51
-52
lines changed

8 files changed

+51
-52
lines changed

‎src/cmd/boinc.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ void Boinc::run() {
5555
Setup::setLodaHome(project_dir);
5656
Setup::getMiningMode();
5757
Setup::setMiningMode(MINING_MODE_CLIENT);
58-
Setup::setSubmittedBy(user_name);
58+
Setup::setSubmitter(user_name);
5959
Setup::forceCPUHours();
6060

6161
// check environment

‎src/lang/comments.cpp‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ std::string Comments::getSequenceIdFromProgram(const Program &p) {
6464
return id_str;
6565
}
6666

67+
std::string Comments::getSubmitter(const Program &p) {
68+
return getCommentField(p, PREFIX_SUBMITTED_BY);
69+
}
70+
6771
// prefixes without colon
6872
const std::string Comments::PREFIX_SUBMITTED_BY = "Submitted by";
6973
const std::string Comments::PREFIX_CODED_MANUALLY = "Coded manually";

‎src/lang/comments.hpp‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ class Comments {
1717

1818
static std::string getSequenceIdFromProgram(const Program &p);
1919

20+
static std::string getSubmitter(const Program &p);
21+
2022
static const std::string PREFIX_SUBMITTED_BY;
2123
static const std::string PREFIX_CODED_MANUALLY;
2224
static const std::string PREFIX_FORMULA;

‎src/mine/mine_manager.cpp‎

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -439,8 +439,7 @@ void MineManager::migrate() {
439439
Program p;
440440
p = parser.parse(f);
441441
f.close();
442-
const auto submitted_by =
443-
Comments::getCommentField(p, Comments::PREFIX_SUBMITTED_BY);
442+
const auto submitter = Comments::getSubmitter(p);
444443
ProgramUtil::removeOps(p, Operation::Type::NOP);
445444
for (size_t i = 0; i < 3 && i < p.ops.size(); i++) {
446445
auto &op = p.ops[i];
@@ -453,7 +452,7 @@ void MineManager::migrate() {
453452
auto result = evaluator.check(p, terms, -1, s.id);
454453
if (result.first != status_t::ERROR) {
455454
Log::get().info("Migrating " + s.id.string());
456-
dumpProgram(s.id, p, path, submitted_by);
455+
dumpProgram(s.id, p, path, submitter);
457456
}
458457
break;
459458
}
@@ -549,8 +548,7 @@ void MineManager::updateDependentOffset(UID id, UID used_id, int64_t delta) {
549548
} catch (const std::exception &) {
550549
return; // ignore this dependent program
551550
}
552-
auto submitted_by =
553-
Comments::getCommentField(p, Comments::PREFIX_SUBMITTED_BY);
551+
auto submitter = Comments::getSubmitter(p);
554552
bool updated = false;
555553
for (size_t i = 0; i < p.ops.size(); i++) {
556554
const auto &op = p.ops[i];
@@ -566,7 +564,7 @@ void MineManager::updateDependentOffset(UID id, UID used_id, int64_t delta) {
566564
}
567565
if (updated) {
568566
optimizer.optimize(p);
569-
dumpProgram(id, p, path, submitted_by);
567+
dumpProgram(id, p, path, submitter);
570568
}
571569
}
572570

@@ -583,7 +581,7 @@ void MineManager::updateAllDependentOffset(UID id, int64_t delta) {
583581
}
584582

585583
void MineManager::dumpProgram(UID id, Program &p, const std::string &file,
586-
const std::string &submitted_by) const {
584+
const std::string &submitter) const {
587585
ProgramUtil::removeOps(p, Operation::Type::NOP);
588586
Comments::removeComments(p);
589587
addSeqComments(p);
@@ -593,8 +591,8 @@ void MineManager::dumpProgram(UID id, Program &p, const std::string &file,
593591
Operation nop(Operation::Type::NOP);
594592
nop.comment = seq.string();
595593
tmp.ops.push_back(nop);
596-
if (!submitted_by.empty()) {
597-
nop.comment = Comments::PREFIX_SUBMITTED_BY + " " + submitted_by;
594+
if (!submitter.empty()) {
595+
nop.comment = Comments::PREFIX_SUBMITTED_BY + " " + submitter;
598596
tmp.ops.push_back(nop);
599597
}
600598
static constexpr size_t MAX_PRINT_TERMS = 80; // magic number
@@ -624,7 +622,7 @@ void MineManager::dumpProgram(UID id, Program &p, const std::string &file,
624622

625623
void MineManager::alert(Program p, UID id, const std::string &prefix,
626624
const std::string &color,
627-
const std::string &submitted_by) const {
625+
const std::string &submitter) const {
628626
const auto &seq = sequences.get(id);
629627
std::string msg, full;
630628
msg = prefix + " program for " + seq.string();
@@ -637,8 +635,8 @@ void MineManager::alert(Program p, UID id, const std::string &prefix,
637635
if (generator.generate(p, id.number(), formula, false)) {
638636
full += ". " + Comments::PREFIX_FORMULA + " " + formula.toString();
639637
}
640-
if (!submitted_by.empty()) {
641-
std::string sub = Comments::PREFIX_SUBMITTED_BY + " " + submitted_by;
638+
if (!submitter.empty()) {
639+
std::string sub = Comments::PREFIX_SUBMITTED_BY + " " + submitter;
642640
msg += " " + sub;
643641
full += ". " + sub;
644642
}
@@ -689,8 +687,7 @@ update_program_result_t MineManager::updateProgram(
689687
}
690688

691689
// get metadata from comments
692-
const std::string submitted_by =
693-
Comments::getCommentField(p, Comments::PREFIX_SUBMITTED_BY);
690+
const std::string submitter = Comments::getSubmitter(p);
694691
const std::string change_type =
695692
Comments::getCommentField(p, Comments::PREFIX_CHANGE_TYPE);
696693
const std::string previous_hash_str =
@@ -749,7 +746,7 @@ update_program_result_t MineManager::updateProgram(
749746
const std::string target_file = ProgramUtil::getProgramPath(id, !is_server);
750747
auto delta = updateProgramOffset(id, result.program);
751748
optimizer.optimize(result.program);
752-
dumpProgram(id, result.program, target_file, submitted_by);
749+
dumpProgram(id, result.program, target_file, submitter);
753750
if (is_server) {
754751
updateAllDependentOffset(id, delta);
755752
}
@@ -766,7 +763,7 @@ update_program_result_t MineManager::updateProgram(
766763

767764
// send alert
768765
std::string color = is_new ? "good" : "warning";
769-
alert(result.program, id, checked.status, color, submitted_by);
766+
alert(result.program, id, checked.status, color, submitter);
770767

771768
return result;
772769
}
@@ -791,13 +788,12 @@ bool MineManager::maintainProgram(UID id, bool eval) {
791788

792789
// try to load the program
793790
Program program;
794-
std::string submitted_by;
791+
std::string submitter;
795792
if (is_okay) {
796793
Log::get().info("Checking program for " + s.string());
797794
try {
798795
program = parser.parse(program_file);
799-
submitted_by =
800-
Comments::getCommentField(program, Comments::PREFIX_SUBMITTED_BY);
796+
submitter = Comments::getSubmitter(program);
801797
} catch (const std::exception &) {
802798
is_okay = false;
803799
}
@@ -847,7 +843,7 @@ bool MineManager::maintainProgram(UID id, bool eval) {
847843
} else {
848844
optimizer.optimize(updated);
849845
}
850-
dumpProgram(s.id, updated, file_name, submitted_by);
846+
dumpProgram(s.id, updated, file_name, submitter);
851847
updateAllDependentOffset(s.id, delta);
852848
} catch (const std::exception &e) {
853849
is_okay = false;

‎src/mine/miner.cpp‎

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ void Miner::runMineLoop() {
175175
Log::get().info(msg);
176176
}
177177

178-
std::string submitted_by;
178+
std::string submitter;
179179
std::string submitted_profile;
180180
current_fetch = (mining_mode == MINING_MODE_SERVER) ? PROGRAMS_TO_FETCH : 0;
181181
num_processed = 0;
@@ -201,7 +201,7 @@ void Miner::runMineLoop() {
201201
}
202202
current_fetch--;
203203
// check metadata stored in program's comments
204-
ensureSubmittedBy(program);
204+
ensureSubmitter(program);
205205
progs.push(program);
206206
break;
207207
}
@@ -260,20 +260,19 @@ void Miner::runMineLoop() {
260260
break;
261261
}
262262
program = s.second;
263-
updateSubmittedBy(program);
263+
updateSubmitter(program);
264264
update_result =
265265
manager->updateProgram(s.first, program, validation_mode);
266266
if (update_result.updated) {
267267
// update metrics
268-
submitted_by =
269-
Comments::getCommentField(program, Comments::PREFIX_SUBMITTED_BY);
270-
if (submitted_by.empty()) {
271-
submitted_by = "unknown";
268+
submitter = Comments::getSubmitter(program);
269+
if (submitter.empty()) {
270+
submitter = "unknown";
272271
}
273272
if (update_result.is_new) {
274-
num_new_per_user[submitted_by]++;
273+
num_new_per_user[submitter]++;
275274
} else {
276-
num_updated_per_user[submitted_by]++;
275+
num_updated_per_user[submitter]++;
277276
}
278277
// in client mode: submit the program to the API server
279278
if (mining_mode == MINING_MODE_CLIENT) {
@@ -468,7 +467,7 @@ void Miner::submit(const std::string &path, std::string id_str) {
468467
continue;
469468
}
470469
program = s.second;
471-
updateSubmittedBy(program);
470+
updateSubmitter(program);
472471
auto r = manager->updateProgram(s.first, program, ValidationMode::EXTENDED);
473472
if (r.updated) {
474473
// in client mode: submit the program to the API server
@@ -507,25 +506,23 @@ void Miner::submit(const std::string &path, std::string id_str) {
507506
}
508507
}
509508

510-
void Miner::ensureSubmittedBy(Program &program) {
511-
auto submitted_by =
512-
Comments::getCommentField(program, Comments::PREFIX_SUBMITTED_BY);
513-
if (submitted_by.empty()) {
509+
void Miner::ensureSubmitter(Program &program) {
510+
auto submitter = Comments::getSubmitter(program);
511+
if (submitter.empty()) {
514512
Comments::addComment(program,
515513
Comments::PREFIX_SUBMITTED_BY + " " + ANONYMOUS);
516514
}
517515
}
518516

519-
void Miner::updateSubmittedBy(Program &program) {
520-
auto submitted_by =
521-
Comments::getCommentField(program, Comments::PREFIX_SUBMITTED_BY);
522-
if (submitted_by.empty()) {
523-
submitted_by = Setup::getSubmittedBy();
524-
if (!submitted_by.empty()) {
517+
void Miner::updateSubmitter(Program &program) {
518+
auto submitter = Comments::getSubmitter(program);
519+
if (submitter.empty()) {
520+
submitter = Setup::getSubmitter();
521+
if (!submitter.empty()) {
525522
Comments::addComment(program,
526-
Comments::PREFIX_SUBMITTED_BY + " " + submitted_by);
523+
Comments::PREFIX_SUBMITTED_BY + " " + submitter);
527524
}
528-
} else if (submitted_by == ANONYMOUS) {
525+
} else if (submitter == ANONYMOUS) {
529526
Comments::removeCommentField(program, Comments::PREFIX_SUBMITTED_BY);
530527
}
531528
}

‎src/mine/miner.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ class Miner {
4747

4848
void reload();
4949

50-
void ensureSubmittedBy(Program &program);
50+
void ensureSubmitter(Program &program);
5151

52-
void updateSubmittedBy(Program &program);
52+
void updateSubmitter(Program &program);
5353

5454
void logProgress(bool report_slow);
5555

‎src/sys/setup.cpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,13 @@ std::string Setup::getMinersConfig() {
114114
return default_config;
115115
}
116116

117-
const std::string Setup::getSubmittedBy() {
117+
const std::string Setup::getSubmitter() {
118118
return getSetupValue("LODA_SUBMITTED_BY");
119119
}
120120

121-
void Setup::setSubmittedBy(const std::string& submited_by) {
122-
getSubmittedBy();
123-
SETUP["LODA_SUBMITTED_BY"] = submited_by;
121+
void Setup::setSubmitter(const std::string& submitter) {
122+
getSubmitter();
123+
SETUP["LODA_SUBMITTED_BY"] = submitter;
124124
}
125125

126126
void Setup::setMinersConfig(const std::string& loda_config) {
@@ -647,7 +647,7 @@ bool Setup::updateFile(const std::string& local_file, const std::string& url,
647647
}
648648

649649
bool Setup::checkSubmittedBy() {
650-
std::string submitted_by = getSubmittedBy();
650+
std::string submitted_by = getSubmitter();
651651
if (submitted_by.empty()) {
652652
submitted_by = "none";
653653
}

‎src/sys/setup.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ class Setup {
2828

2929
static std::string getMinersConfig();
3030

31-
static const std::string getSubmittedBy();
31+
static const std::string getSubmitter();
3232

33-
static void setSubmittedBy(const std::string& submited_by);
33+
static void setSubmitter(const std::string& submitter);
3434

3535
static void setMinersConfig(const std::string& loda_config);
3636

0 commit comments

Comments
 (0)