update command (#217)

Author: ckrause

CHANGELOG.md

@@ -2,13 +2,16 @@ To install or update LODA, please follow the [installation instructions](https:/
 
 ## [Unreleased]
 
+## v22.12.1
+
 ### Bugfixes
 
 * Fix update issues
 
 ### Feature
 
 * Install script
+* Update command
 
 ### Enhancements
 

README.md

@@ -34,14 +34,17 @@ Core Commands:
   optimize <program>  Optimize a program and print it
   minimize <program>  Minimize a program and print it (see -t)
   profile  <program>  Measure program evaluation time (see -t)
-  setup               Run interactive setup to configure LODA
 
 OEIS Commands:
   mine                Mine programs for OEIS sequences (see -i,-p,-P,-H)
   check <program>     Check a program for an OEIS sequence (see -b)
   mutate <program>    Mutate a program and mine for OEIS sequences
   submit <file> [id]  Submit a program for an OEIS sequence
 
+Admin Commands:
+  setup               Run interactive setup to configure LODA
+  update              Run non-interactive update of LODA and its data
+
 Targets:
   <file>              Path to a LODA file (file extension: *.asm)
   <id>                ID of an OEIS integer sequence (example: A000045)

src/commands.cpp

@@ -51,8 +51,6 @@ void Commands::help() {
             << std::endl;
   std::cout << "  profile  <program>  Measure program evaluation time (see -t)"
             << std::endl;
-  std::cout << "  setup               Run interactive setup to configure LODA"
-            << std::endl;
 
   std::cout << std::endl << "OEIS Commands:" << std::endl;
   std::cout << "  mine                Mine programs for OEIS sequences (see "
@@ -66,6 +64,14 @@ void Commands::help() {
       << std::endl;
   std::cout << "  submit <file> [id]  Submit a program for an OEIS sequence"
             << std::endl;
+
+  std::cout << std::endl << "Admin Commands:" << std::endl;
+  std::cout << "  setup               Run interactive setup to configure LODA"
+            << std::endl;
+  std::cout
+      << "  update              Run non-interactive update of LODA and its data"
+      << std::endl;
+
   std::cout << std::endl << "Targets:" << std::endl;
   std::cout
       << "  <file>              Path to a LODA file (file extension: *.asm)"
@@ -131,7 +137,18 @@ std::pair<std::string, size_t> getProgramPathAndSeqId(std::string arg) {
 
 // official commands
 
-void Commands::setup() { Setup::runWizard(); }
+void Commands::setup() {
+  initLog(true);
+  Setup::runWizard();
+}
+
+void Commands::update() {
+  initLog(false);
+  OeisManager manager(settings);
+  manager.update(true);
+  manager.getStats();
+  manager.generateLists();
+}
 
 void Commands::evaluate(const std::string& path) {
   initLog(true);

src/include/commands.hpp

@@ -14,6 +14,8 @@ class Commands {
 
   void setup();
 
+  void update();
+
   void evaluate(const std::string& path);
 
   void check(const std::string& path);

src/include/oeis_manager.hpp

@@ -28,6 +28,8 @@ class OeisManager {
 
   void load();
 
+  void update(bool force);
+
   void migrate();
 
   const std::vector<OeisSequence>& getSequences() const;
@@ -56,8 +58,6 @@ class OeisManager {
 
   bool shouldMatch(const OeisSequence& seq) const;
 
-  void update();
-
   void generateStats(int64_t age_in_days);
 
   void addSeqComments(Program& p) const;

src/include/setup.hpp

@@ -63,7 +63,7 @@ class Setup {
 
   static std::string getLatestVersion();
 
-  static void checkLatestedVersion();
+  static std::string checkLatestedVersion(bool silent);
 
   static bool hasMemory();
 
@@ -73,6 +73,8 @@ class Setup {
 
   static void runWizard();
 
+  static void performUpdate(const std::string& new_version, bool silent);
+
  private:
   static constexpr int64_t UNDEFINED_INT = -2;                  // cannot use -1
   static constexpr int64_t DEFAULT_GITHUB_UPDATE_INTERVAL = 1;  // 1 day default
@@ -114,4 +116,6 @@ class Setup {
   static bool updateFile(const std::string& local_file, const std::string& url,
                          const std::string& header, const std::string& marker,
                          bool executable);
+
+  static std::string getExecutable(const std::string& suffix);
 };

src/main.cpp

@@ -134,6 +134,8 @@ int dispatch(Settings settings, const std::vector<std::string>& args) {
   // official commands
   if (cmd == "setup") {
     commands.setup();
+  } else if (cmd == "update") {
+    commands.update();
   } else if (cmd == "evaluate" || cmd == "eval") {
     commands.evaluate(args.at(1));
   } else if (cmd == "check") {

src/oeis_manager.cpp

@@ -76,7 +76,7 @@ void OeisManager::load() {
     FolderLock lock(Setup::getOeisHome());
 
     // update index if needed
-    update();
+    update(false);
 
     // load sequence data, names and deny list
     Log::get().info("Loading sequences from the OEIS index");
@@ -303,10 +303,11 @@ bool OeisManager::shouldMatch(const OeisSequence &seq) const {
   return true;  // unreachable
 }
 
-void OeisManager::update() {
+void OeisManager::update(bool force) {
   std::vector<std::string> files = {"stripped", "names"};
 
   // check whether oeis files need to be updated
+  update_oeis = false;
   auto it = files.begin();
   int64_t oeis_age_in_days = -1;
   while (it != files.end()) {
@@ -321,6 +322,7 @@ void OeisManager::update() {
   }
 
   // check whether programs need to be updated
+  update_programs = false;
   const std::string progs_dir = Setup::getProgramsHome();
   const std::string local_dir = progs_dir + "local";
   const std::string update_progs_file = local_dir + FILE_SEP + ".update";
@@ -330,9 +332,26 @@ void OeisManager::update() {
     update_programs = true;
   }
 
+  // figure out if we should check for loda update
+  bool check_loda_update = (update_oeis && (Random::get().gen() % 5 == 0));
+
+  // force update?
+  if (force) {
+    update_oeis = true;
+    update_programs = true;
+    check_loda_update = true;
+  }
+
+  // check and perform loda update
+  if (check_loda_update) {
+    auto latest_version = Setup::checkLatestedVersion(false);
+    if (force && !latest_version.empty()) {
+      Setup::performUpdate(latest_version, false);
+    }
+  }
+
   // perform oeis update
   if (update_oeis) {
-    Setup::checkLatestedVersion();
     if (oeis_age_in_days == -1) {
       Log::get().info("Creating OEIS index at \"" + Setup::getOeisHome() +
                       "\"");
@@ -683,24 +702,26 @@ void OeisManager::alert(Program p, size_t id, const std::string &prefix,
                         const std::string &color,
                         const std::string &submitted_by, bool tweet) const {
   auto &seq = sequences.at(id);
-  std::stringstream buf;
-  buf << prefix << " program for " << seq
-      << " Terms: " << seq.getTerms(settings.num_terms);
+  std::string msg, full;
+  msg = prefix + " program for " + seq.to_string();
+  full = msg + " Terms: " + seq.getTerms(settings.num_terms).to_string();
   FormulaGenerator gen(false);
   Formula formula;
   if (gen.generate(p, id, formula, false)) {
-    buf << ". Formula: " << formula.toString(false);
+    full += ". Formula: " + formula.toString(false);
   }
   if (!submitted_by.empty()) {
-    buf << ". " << ProgramUtil::PREFIX_SUBMITTED_BY << " " << submitted_by;
+    std::string sub = ProgramUtil::PREFIX_SUBMITTED_BY + " " + submitted_by;
+    msg += " " + sub;
+    full += ". " + sub;
   }
-  auto msg = buf.str();
   Log::AlertDetails details;
   details.title = seq.id_str();
   details.title_link = seq.url_str();
   details.color = color;
   details.tweet = tweet;
-  buf << "\\n\\`\\`\\`\\n";
+  std::stringstream buf;
+  buf << full << "\\n\\`\\`\\`\\n";
   ProgramUtil::removeOps(p, Operation::Type::NOP);
   addSeqComments(p);
   ProgramUtil::print(p, buf, "\\n");

src/setup.cpp

@@ -469,66 +469,84 @@ std::string Setup::getLatestVersion() {
   return json["tag_name"].as_string();
 }
 
-void Setup::checkLatestedVersion() {
-  if (Version::IS_RELEASE && (Random::get().gen() % 5 == 0)) {
-    const auto latest_version = Setup::getLatestVersion();
+std::string Setup::checkLatestedVersion(bool silent) {
+  if (Version::IS_RELEASE) {
+    const auto latest_version = getLatestVersion();
     if (latest_version != Version::BRANCH) {
-      Log::get().info("LODA " + latest_version +
-                      " is available. Run 'loda setup' to update.");
+      if (!silent) {
+        Log::get().info("Update to LODA " + latest_version + " available");
+      }
+      return latest_version;
     }
   }
+  return "";
 }
 
-bool Setup::checkUpdate() {
-  ensureDir(LODA_HOME + "bin" + FILE_SEP);
+std::string Setup::getExecutable(const std::string& suffix) {
+  std::string exe;
+#ifdef _WIN64
+  exe = ".exe";
+#endif
+  return LODA_HOME + "bin" + FILE_SEP + "loda" + suffix + exe;
+}
+
+void Setup::performUpdate(const std::string& new_version, bool silent) {
   std::string exe;
 #ifdef _WIN64
   exe = ".exe";
 #endif
-  const std::string exec_local = LODA_HOME + "bin" + FILE_SEP + "loda" + exe;
-  const std::string exec_tmp =
-      LODA_HOME + "bin" + FILE_SEP + "loda-" + Version::PLATFORM + exe;
+  ensureDir(LODA_HOME + "bin" + FILE_SEP);
+  const std::string exec_local = getExecutable("");
+  const std::string exec_tmp = getExecutable("-" + Version::PLATFORM);
 #ifdef _WIN64
   if (isFile(exec_local) && isFile(exec_tmp)) {
     std::string cmd = "del \"" + exec_tmp + "\" " + getNullRedirect();
     if (system(cmd.c_str()) != 0) {
-      std::cout << "Error deleting temporary file: " + exec_tmp << std::endl;
+      Log::get().error("Cannot delete temporary file: " + exec_tmp, false);
     }
   }
 #endif
-  auto latest_version = getLatestVersion();
-  if (Version::IS_RELEASE &&
-      (latest_version != Version::BRANCH || !isFile(exec_local))) {
-    std::cout << "LODA " << latest_version << " is available!" << std::endl
-              << "Do you want to install the update? (Y/n) ";
-    std::string line;
-    std::getline(std::cin, line);
-    if (line.empty() || line == "y" || line == "Y") {
-      const std::string exec_url =
-          "https://github.com/loda-lang/loda-cpp/releases/download/" +
-          latest_version + "/loda-" + Version::PLATFORM + exe;
-      WebClient::get(exec_url, exec_tmp, true, true);
+  const std::string exec_url =
+      "https://github.com/loda-lang/loda-cpp/releases/download/" + new_version +
+      "/loda-" + Version::PLATFORM + exe;
+  WebClient::get(exec_url, exec_tmp, true, true);
 #ifdef _WIN64
-      const std::string cmd = "\"" + exec_tmp +
-                              "\" update-windows-executable \"" + exec_tmp +
-                              "\" \"" + exec_local + "\"";
-      createWindowsProcess(cmd);
+  const std::string cmd = "\"" + exec_tmp + "\" update-windows-executable \"" +
+                          exec_tmp + "\" \"" + exec_local + "\"";
+  createWindowsProcess(cmd);
 #else
-      makeExecutable(exec_tmp);
-      moveFile(exec_tmp, exec_local);
-      std::cout << "Update installed. Restarting setup... " << std::endl
-                << std::endl;
-      std::string new_setup = exec_local + " setup";
-      if (system(new_setup.c_str()) != 0) {
-        std::cout << "Error running setup of LODA " << latest_version
-                  << std::endl;
-      }
+  makeExecutable(exec_tmp);
+  moveFile(exec_tmp, exec_local);
+  if (!silent) {
+    Log::get().info("Installed update to LODA " + new_version);
+  }
 #endif
-      // in any case, we must stop the current setup here
-      return false;
-    } else {
-      std::cout << std::endl;
+}
+
+bool Setup::checkUpdate() {
+  auto latest_version = checkLatestedVersion(true);
+  if (latest_version.empty()) {
+    return true;
+  }
+  std::cout << "LODA " << latest_version << " is available!" << std::endl
+            << "Do you want to install the update? (Y/n) ";
+  std::string line;
+  std::getline(std::cin, line);
+  if (line.empty() || line == "y" || line == "Y") {
+    performUpdate(latest_version, true);
+#ifndef _WIN64
+    std::cout << "Update installed. Restarting setup... " << std::endl
+              << std::endl;
+    std::string new_setup = getExecutable("") + " setup";
+    if (system(new_setup.c_str()) != 0) {
+      std::cout << "Error running setup of LODA " << latest_version
+                << std::endl;
     }
+#endif
+    // in any case, we must stop the current setup here
+    return false;
+  } else {
+    std::cout << std::endl;
   }
   return true;
 }