]> git.r.bdr.sh - rbdr/git-sync-all/commitdiff
Initial commit: sync with origin main
authorRuben Beltran del Rio <redacted>
Sun, 24 Dec 2023 11:53:58 +0000 (12:53 +0100)
committerRuben Beltran del Rio <redacted>
Sun, 24 Dec 2023 11:53:58 +0000 (12:53 +0100)
.gitignore [new file with mode: 0644]
Cargo.lock [new file with mode: 0644]
Cargo.toml [new file with mode: 0644]
LICENSE [new file with mode: 0644]
Makefile [new file with mode: 0644]
README.md [new file with mode: 0644]
src/git_tools.rs [new file with mode: 0644]
src/main.rs [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..eb5a316
--- /dev/null
@@ -0,0 +1 @@
+target
diff --git a/Cargo.lock b/Cargo.lock
new file mode 100644 (file)
index 0000000..1ae366d
--- /dev/null
@@ -0,0 +1,7 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "git-sync-all"
+version = "1.0.0"
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644 (file)
index 0000000..a86d8c7
--- /dev/null
@@ -0,0 +1,6 @@
+[package]
+name = "git-sync-all"
+version = "1.0.0"
+edition = "2021"
+
+[dependencies]
diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..497db7d
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Rubén Beltran del Río
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..b64b6e2
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,8 @@
+profile = dev
+
+default: build
+
+build:
+       cargo build --profile $(profile)
+
+.PHONY: build
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3879878
--- /dev/null
+++ b/README.md
@@ -0,0 +1,72 @@
+# page
+
+A static website generator for exactly 1 use case.
+
+"I have a bunch of gemini files that I want to serve as-is, but I also
+want to generate some HTML"
+
+## How to use
+
+1. Stand on the directory you want to turn into a page
+2. run page
+3. your html output is in ../<directory_name>_html
+4. your gemini without frontmatter output is in ../<directory_name>_gemini
+
+So for example:
+
+```
+$ pwd
+/home/rbdr/web/website
+$ page
+$ ls ..
+website/
+website_html/
+website_gemini/
+```
+
+## Front Matter
+
+You can add some optional front matter. We'll look at the two first lines that
+start with `---`
+
+The format is:
+
+```
+--- title: the title of the page
+--- description: a description
+```
+
+This only works if they are the first lines of the page.
+
+## Local Path Translation
+
+Links that end with `.gmi` will be replaced with `.html` unless they specifically start with `gemini:`
+
+## Layouts
+
+page expects a file called _layout.html in the root. It expects three placeholders:
+
+* {{ content }} the generated HTML from parsing the gemini text files.
+* {{ title }} the frontmatter title or an empty string.
+* {{ description }} the frontmatter description or an empty string.
+
+
+## Hidden folders
+
+Hidden folders are copied as well, we only make an exception for `.git/`, and
+`.gitignore` which are explicitly ignored. This is handy for folders like
+`.well-known`, but could cause unwanted behavior if there's other hidden files
+in the directory.
+
+## What happens to files that aren't gemini?
+
+They're copied as-is.
+
+# Building
+
+This project is built using cargo. A makefile is provided to run common tasks.
+
+Build dev version with `make` or `make build`.
+
+Build release with `make -e profile=release` or `make -e profile=release build`.
+
diff --git a/src/git_tools.rs b/src/git_tools.rs
new file mode 100644 (file)
index 0000000..1c361ca
--- /dev/null
@@ -0,0 +1,106 @@
+use std::io::{Result, Error, ErrorKind};
+use std::process::Command;
+use std::path::Path;
+
+pub fn git_save_previous_branch(path: &Path) -> Result<String> {
+    let output = Command::new("git")
+        .arg("rev-parse")
+        .arg("--abbrev-ref")
+        .arg("HEAD")
+        .current_dir(path)
+        .output()?;
+    if !output.status.success() {
+        Err(Error::new(ErrorKind::Other, "Failed to get current branch"))
+    } else {
+        Ok(String::from_utf8(output.stdout).unwrap().trim().to_string())
+    }
+}
+
+pub fn git_checkout(path: &Path, branch: &str) -> Result<()> {
+    let output = Command::new("git")
+        .arg("checkout")
+        .arg(branch)
+        .current_dir(path)
+        .output()?;
+    if !output.status.success() {
+        Err(Error::new(ErrorKind::Other, format!("Failed to checkout {}", branch)))
+    } else {
+        Ok(())
+    }
+}
+
+pub fn git_fetch(path: &Path) -> Result<()> {
+    let output = Command::new("git")
+        .arg("fetch")
+        .current_dir(path)
+        .output()?;
+    if !output.status.success() {
+        return Err(Error::new(ErrorKind::Other, "Failed to fetch"));
+    }
+    Ok(())
+}
+
+pub fn git_check_for_conflicts(path: &Path) -> Result<bool> {
+    let merge_output = Command::new("git")
+        .arg("merge")
+        .arg("--no-commit")
+        .arg("--no-ff")
+        .arg("origin/main")
+        .current_dir(path)
+        .output()?;
+    if !merge_output.status.success() {
+        return Err(Error::new(ErrorKind::Other, "Failed to merge"));
+    }
+    let conflicts_output = Command::new("git")
+        .arg("ls-files")
+        .arg("--unmerged")
+        .current_dir(path)
+        .output()?;
+    Command::new("git")
+        .arg("merge")
+        .arg("--abort")
+        .current_dir(path)
+        .output()?;
+    Ok(!conflicts_output.stdout.is_empty())
+}
+
+pub fn git_merge(path: &Path) -> Result<()> {
+    let output = Command::new("git")
+        .arg("merge")
+        .arg("origin/main")
+        .current_dir(path)
+        .output()?;
+    if !output.status.success() {
+        Err(Error::new(ErrorKind::Other, "Failed to merge"))
+    } else {
+        Ok(())
+    }
+}
+
+pub fn git_push(path: &Path) -> Result<()> {
+    let output = Command::new("git")
+        .arg("push")
+        .arg("origin")
+        .arg("main")
+        .current_dir(path)
+        .output()?;
+    if !output.status.success() {
+        Err(Error::new(ErrorKind::Other, "Failed to push to origin"))
+    } else {
+        Ok(())
+    }
+}
+
+pub fn get_commit(path: &Path, revision: &str) -> Result<String> {
+    let output = Command::new("git")
+        .arg("rev-parse")
+        .arg("--short")
+        .arg(revision)
+        .current_dir(path)
+        .output()?;
+    if !output.status.success() {
+        Err(Error::new(ErrorKind::Other, "Failed to get current commit"))
+    } else {
+        Ok(String::from_utf8(output.stdout).unwrap().trim().to_string())
+    }
+}
diff --git a/src/main.rs b/src/main.rs
new file mode 100644 (file)
index 0000000..3b9caea
--- /dev/null
@@ -0,0 +1,91 @@
+mod git_tools;
+
+use std::env;
+use std::fs;
+use std::io::{Result, Error, ErrorKind};
+use std::path::Path;
+use std::process::exit;
+
+use git_tools::*;
+
+fn main() -> Result<()> {
+    if let Ok(cwd) = env::current_dir() {
+        if let Err(e) = scan_directories_to_synchronize(&cwd) {
+            eprintln!("Could not check directory for git repositories: {}", e);
+            exit(1);
+        }
+    } else {
+        eprintln!("Could not find current directory.");
+        exit(1);
+    }
+    Ok(())
+}
+
+fn scan_directories_to_synchronize(path: &Path) -> Result<()> {
+    let sync_ignore_file = path.join(".syncignore");
+    if sync_ignore_file.exists() {
+        return Ok(())
+    }
+    let git_directory = path.join(".git");
+    if git_directory.exists() {
+        if let Err(e) = synchronize_directory(&path) {
+            let relative_path = get_relative_path(path).unwrap();
+            eprintln!("Sync failed for {:?}. {}", relative_path, e);
+        }
+    } else {
+        for entry in fs::read_dir(path)? {
+            let path = entry?.path();
+            if path.is_dir() {
+                scan_directories_to_synchronize(&path)?;
+            }
+        }
+    }
+    Ok(())
+}
+
+fn synchronize_directory(path: &Path) -> Result<()> {
+    let previous_branch = git_save_previous_branch(path)?;
+    git_checkout(path, "main")?;
+    let result = attempt_synchronization(path);
+    git_checkout(path, &previous_branch)?;
+    result
+}
+
+fn attempt_synchronization(path: &Path) -> Result<()> {
+    let relative_path = get_relative_path(path).unwrap();
+    eprint!("{:?}. ", relative_path);
+    let previous_commit = get_commit(path, "HEAD")?;
+    git_fetch(path)?;
+    let remote_commit = get_commit(path, "origin/main")?;
+    if previous_commit == remote_commit {
+        eprintln!("Already up to date.");
+        return Ok(());
+    }
+    match git_check_for_conflicts(path) {
+        Ok(conflicts) => {
+            if !conflicts {
+                git_merge(path)?;
+                let new_commit = get_commit(path, "HEAD")?;
+                eprint!("Merged origin {:?}->{:?}. ", previous_commit, new_commit);
+                git_push(path)?;
+                eprintln!("Pushed.");
+            } else {
+                return Err(Error::new(ErrorKind::Other, "Conflicts detected"));
+            }
+        },
+        Err(e) => {
+            return Err(e);
+        }
+    }
+    Ok(())
+}
+
+// Path Helpers
+
+fn get_relative_path(path: &Path) -> Option<String> {
+    let cwd = env::current_dir().unwrap();
+    path.strip_prefix(cwd)
+        .ok()
+        .and_then(|p| p.to_str())
+        .map(|s| s.to_string())
+}