Merge pull request #2 from supechicken/main

Add Ruby support for `crew-mvdir`

Author: satmandu

README.md

@@ -20,6 +20,6 @@ cc ./crew-mvdir.c -O2 -o crew-mvdir
 ```
 
 ## License
-Copyright (C) 2013-2023 Chromebrew Authors
+Copyright (C) 2013-2024 Chromebrew Authors
 
-This project including all of its source files is released under the terms of [GNU General Public License (version 3 or later)](http://www.gnu.org/licenses/gpl.txt).
+This project including all of its source files is released under the terms of [GNU General Public License (version 3 or later)](http://www.gnu.org/licenses/gpl.txt).

build.sh

@@ -0,0 +1,16 @@
+#!/bin/bash -ex
+
+mkdir -p builddir
+cd builddir
+
+# build shared library
+cc -shared -fPIC ${CFLAGS} ../src/mvdir.c -o crew-mvdir.so.1
+
+# build CLI for use in install.sh
+cc ${CFLAGS} -L . -l:crew-mvdir.so.1 ../src/main.c -o crew-mvdir
+
+# build ruby binding for use in crew
+ruby ../src/ruby_binding/extconf.rb
+make -j"$(nproc)"
+
+echo 'Build completed.'

src/main.c

@@ -0,0 +1,72 @@
+/*
+  Copyright (C) 2013-2024 Chromebrew Authors
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program. If not, see https://www.gnu.org/licenses/gpl-3.0.html.
+*/
+
+/*
+  crew-mvdir: Move all files under one directory to another,
+              override conflict files in the destination directory (merge two directories)
+
+  Equivalent of `rsync -ahHAXW --remove-source-files dir1/ dir2/`
+
+  crew-mvdir use rename() syscall to move files (instead of copying-deleting), that's why it is faster than `rsync`
+
+  Usage: ./crew-mvdir [-v] [-n] [src] [dst]
+
+  cc ./crew-mvdir.c -O2 -o crew-mvdir
+*/
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdbool.h>
+#include <string.h>
+#include <unistd.h>
+#include "./mvdir.h"
+
+int main(int argc, char** argv) {
+  struct mvdir_opts *opts = calloc(1, sizeof opts);
+  int opt;
+
+  // initialize mvdir_opts struct
+  opts->src = calloc(sizeof(char), PATH_MAX);
+  opts->dst = calloc(sizeof(char), PATH_MAX);
+
+  while ((opt = getopt(argc, argv, "vn")) != -1) {
+    switch (opt) {
+      case 'v':
+        // verbose mode
+        opts->verbose = true;
+        break;
+      case 'n':
+        // do not overwrite an existing file
+        opts->no_clobber = true;
+        break;
+      default:
+        fprintf(stderr, "Usage: %s [-v] [-n] [src] [dst]\n", argv[0]);
+        exit(EXIT_FAILURE);
+        break;
+    }
+  }
+
+  if (argc - optind != 2) {
+    fprintf(stderr, "Usage: %s [-v] [-n] [src] [dst]\n", argv[0]);
+    exit(EXIT_FAILURE);
+  }
+
+  strcpy(opts->src, argv[optind]);
+  strcpy(opts->dst, argv[optind + 1]);
+
+  return move_directory(opts);
+}

crew-mvdir.c src/mvdir.ccrew-mvdir.c renamed to src/mvdir.c

@@ -1,5 +1,5 @@
 /*
-  Copyright (C) 2013-2023 Chromebrew Authors
+  Copyright (C) 2013-2024 Chromebrew Authors
 
   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -15,34 +15,20 @@
   along with this program. If not, see https://www.gnu.org/licenses/gpl-3.0.html.
 */
 
-/*
-  crew-mvdir: Move all files under one directory to another,
-              override conflict files in the destination directory (merge two directories)
-
-  Equivalent of `rsync -ahHAXW --remove-source-files dir1/ dir2/`
-
-  crew-mvdir use rename() syscall to move files (instead of copying-deleting), that's why it is faster than `rsync`
-
-  Usage: ./crew-mvdir [-v] [-n] [src] [dst]
-
-  cc ./crew-mvdir.c -O2 -o crew-mvdir
-*/
-
 #define _XOPEN_SOURCE 700 // for nftw()
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdbool.h>
 #include <fcntl.h>
 #include <unistd.h>
 #include <errno.h>
-#include <limits.h>
 #include <string.h>
 #include <ftw.h>
 #include <sys/sendfile.h>
 #include <sys/stat.h>
+#include "./mvdir.h"
 
-bool same_fs = true, verbose = false, no_clobber = false;
-char src[PATH_MAX], dst[PATH_MAX];
+struct mvdir_opts *opts;
 
 void copy_and_delete_file(const struct stat *src_info, const char *src_path, const char *dst_path) {
   // copy_and_delete_file(): copy a file and delete it after copying, used as a fallback when rename() does not work
@@ -77,34 +63,34 @@ void copy_and_delete_file(const struct stat *src_info, const char *src_path, con
 int move_file(const char *src_path, const struct stat *src_info, int flag, struct FTW *ftwbuf) {
   char dst_path[PATH_MAX];
 
-  strcpy(dst_path, dst);
-  strcat(dst_path, src_path + strlen(src));
+  strcpy(dst_path, opts->dst);
+  strcat(dst_path, src_path + strlen(opts->src));
 
   if (strcmp(src_path, ".") == 0) return 0;
-  if (verbose) fprintf(stderr, "%s -> %s\n", src_path, dst_path);
+  if (opts->verbose) fprintf(stderr, "%s -> %s\n", src_path, dst_path);
 
   switch (flag) {
     case FTW_F:
     case FTW_SL:
     case FTW_SLN:
       if (access(dst_path, F_OK) == 0) {
         // do not touch existing files if -n specified
-        if (!(no_clobber || remove(dst_path) == 0)) {
+        if (!(opts->no_clobber || remove(dst_path) == 0)) {
           // remove file with same name in dest (if exist)
           fprintf(stderr, "%s: failed to remove file: %s\n", dst_path, strerror(errno));
           exit(errno);
         }
       }
 
       // move (rename) file to dest
-      if (same_fs) {
+      if (opts->same_fs) {
         // (when source and destination are in the same filesystem)
         // file/symlink: move file to dest, override files with same filename in dest (mode/owner remain unchanged)
         if (rename(src_path, dst_path) == -1) {
           if (errno == EXDEV) {
             // fallback to copying-deleting if source and destination are not in the same filesystem
-            same_fs = false;
-            if (verbose) fprintf(stderr, "Warning: destination is not in the same filesystem, will fallback to sendfile() instead.\n");
+            opts->same_fs = false;
+            if (opts->verbose) fprintf(stderr, "Warning: destination is not in the same filesystem, will fallback to sendfile() instead.\n");
             return move_file(src_path, src_info, flag, ftwbuf);
           }
 
@@ -142,7 +128,7 @@ int move_file(const char *src_path, const struct stat *src_info, int flag, struc
       if (access(dst_path, F_OK) == -1) {
         mode_t dir_mode = src_info->st_mode;
 
-        if (verbose) fprintf(stderr, "Creating directory %s\n", dst_path);
+        if (opts->verbose) fprintf(stderr, "Creating directory %s\n", dst_path);
         if (mkdir(dst_path, dir_mode) == -1) {
           fprintf(stderr, "%s: mkdir() failed: %s\n", src_path, strerror(errno));
           exit(errno);
@@ -158,50 +144,23 @@ int move_file(const char *src_path, const struct stat *src_info, int flag, struc
   return 0;
 }
 
-int main(int argc, char** argv) {
-  int opt;
-
-  while ((opt = getopt(argc, argv, "vn")) != -1) {
-    switch (opt) {
-      case 'v':
-        // verbose mode
-        verbose = true;
-        break;
-      case 'n':
-        // do not overwrite an existing file
-        no_clobber = true;
-        break;
-      default:
-        fprintf(stderr, "Usage: %s [-v] [-n] [src] [dst]\n", argv[0]);
-        exit(EXIT_FAILURE);
-        break;
-    }
-  }
-
-  if (argc - optind != 2) {
-    fprintf(stderr, "Usage: %s [-v] [-n] [src] [dst]\n", argv[0]);
-    exit(EXIT_FAILURE);
-  }
-
-  strcpy(src, argv[optind]);
-  strcpy(dst, argv[optind + 1]);
-
-  struct stat src_info, dst_info;
-  stat(src, &src_info);
-  stat(dst, &dst_info);
+int move_directory(struct mvdir_opts *optPtr) {
+  opts = optPtr;
 
   // trailing slashes in path are required in order to make move_file() works
-  int src_len = strlen(src),
-      dst_len = strlen(dst);
+  int src_len = strlen(opts->src),
+      dst_len = strlen(opts->dst);
 
-  if (src[src_len - 1] != '/') src[src_len] = '/';
-  if (dst[dst_len - 1] != '/') dst[dst_len] = '/';
+  if (opts->src[src_len - 1] != '/') opts->src[src_len] = '/';
+  if (opts->dst[dst_len - 1] != '/') opts->dst[dst_len] = '/';
 
   // call move_file() with files in src recursively
-  if (nftw(src, move_file, 100, FTW_PHYS | FTW_MOUNT) == -1) {
-    fprintf(stderr, "%s: nftw() failed: %s\n", src, strerror(errno));
+  int ret = nftw(opts->src, move_file, 100, FTW_PHYS | FTW_MOUNT);
+
+  if (ret == -1) {
+    fprintf(stderr, "%s: nftw() failed: %s\n", opts->src, strerror(errno));
     exit(errno);
   }
 
-  return 0;
-}
+  return ret;
+}

src/mvdir.h

@@ -0,0 +1,26 @@
+/*
+  Copyright (C) 2013-2024 Chromebrew Authors
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program. If not, see https://www.gnu.org/licenses/gpl-3.0.html.
+*/
+
+#include <limits.h>
+#include <stdbool.h>
+
+struct mvdir_opts {
+  char *src, *dst;
+  bool same_fs, verbose, no_clobber;
+};
+
+int move_directory(struct mvdir_opts *optPtr);

src/ruby_binding/crew_mvdir.c

@@ -0,0 +1,56 @@
+/*
+  Copyright (C) 2013-2024 Chromebrew Authors
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program. If not, see https://www.gnu.org/licenses/gpl-3.0.html.
+*/
+
+/*
+  ruby_binding/crew_mvdir.c: Ruby binding for use in `crew`
+
+  Usage: crew_mvdir(src, dst, verbose: false)
+*/
+
+#include <string.h>
+#include <ruby.h>
+#include "../mvdir.h"
+
+VALUE crew_mvdir(int argc, VALUE *argv, VALUE self) {
+  struct mvdir_opts *opts = calloc(1, sizeof(opts));
+  VALUE src, dst, rb_opts, verbose;
+
+  // initialize mvdir_opts struct
+  opts->src = calloc(sizeof(char), PATH_MAX);
+  opts->dst = calloc(sizeof(char), PATH_MAX);
+
+  // parse argument passed in
+  rb_scan_args(argc, argv, "2:", &src, &dst, &rb_opts);
+
+  if (NIL_P(rb_opts)) rb_opts = rb_hash_new();
+
+  // read extra options
+  verbose = rb_hash_aref(rb_opts, rb_intern("verbose"));
+  if (NIL_P(verbose)) verbose = Qfalse;
+
+  // convert Ruby values to C style data types
+  strcpy(opts->src, StringValueCStr(src));
+  strcpy(opts->dst, StringValueCStr(dst));
+  opts->verbose = RTEST(verbose);
+
+  move_directory(opts);
+  return Qnil;
+}
+
+void Init_crew_mvdir() {
+  rb_define_global_function("crew_mvdir", crew_mvdir, -1);
+}

src/ruby_binding/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+$LDFLAGS += " -L#{Dir.pwd} -l:crew-mvdir.so.1"
+
+create_makefile 'crew_mvdir'