imagebackup 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19afaa9b557d9f7f975671cbac434cc122ba66c45530b151ca1e3f2927fa721e
-  data.tar.gz: 99c50850195ec05e5689736a0e382596ab5513e5246e8e63abf8b15f03137527
+  metadata.gz: fc81529419a0623c0598dabfbba9e4b5806b62a9dfa8ccd3eb9310912157b11b
+  data.tar.gz: 650bfa77a3adfadc530c9466261f077b901f9b00e693180dd00d93978586ddfa
 SHA512:
-  metadata.gz: 67bb185227e95535d45675263420321bdc42ae3c3616d446d4ef3592c301087f9a82f89216d9249f280f06762b492efdb234c0154892d668a3faeca2791d15d3
-  data.tar.gz: bfe84709a6a03bbcf7135683dd352cd6a0a70e2430a91b4276d53ff6980d12c15a3e70036b640f3e2a672eb327cf8b2493a6d09bbdc9dfe7fefe386012aad9b3
+  metadata.gz: ad5fe5bf394bb6282b772683aac8c66a18ff9b4fb58ea67bfaed17f0a19ff844ff6f77afa72cd1c0e5bfa8c463ca0d9de317f1c43e8b88089c918a1f9ac148ef
+  data.tar.gz: b1fb8c3bf729427c2de5f34a79bb924ec465679f1b85b68d0acecf0b8fb9282468777bcaa0ca93f2e988cf479f5c8dc649bf66006a7becc973de24ffb619ca55

data/README.md

@@ -2,34 +2,83 @@
 
 ## Keep your photos and videos organized by date.
 
-### A simple terminal app to crawl a folder (usually a camera card's DCIM folder) for pictures and videos, and pop them in dated folders to your destination folder of choice. Uses exif data when available, creation_time, or the file's own creation date if nothing better is present.
+### A simple terminal app to crawl a folder (usually a camera card's DCIM folder) for pictures and videos, and pop them in dated folders to your destination folder of choice. Uses exif data when available, creation_time, or the file's own creation date if nothing better is present.  
+### Will also copy over any xmp sidecar files found, not overwriting.
 
 
-## Dependencies:
-
-**Ruby** v2.3.0 or greater, plus gems:
-  - exiv2
-  - ffprober  
+## Options:
+-n, --dry-run  
+Run without actually doing anything. Good for making sure things are working properly. This will also give you console output which helps identify unreadable files.
 
-Ruby modules:
-  - fileutils.rb
-  - json  
+-a, --add-filetype *extension* *type*  
+This will add a custom file type to the list of files it's looking for. If you have an arcane digital camera (we currently support canon, sony, pentax but new stuff comes out all the time), this will allow you to add your raw files.  
+You can also access *filetypes.csv* and add them manually, but ensure there's a blank line at the end or this program may behave badly.
 
-Bundler should handle all these dependencies. If for some reason it doesn't you can run this in terminal:  
-```bash
-$ gem install exiv2 ffprober
-```
+-m will move (deleting the original), which is probably not a good idea in most cases but still useful at times.
 
 ## Usage:
 
+### To backup a camera card:
+
 ```bash
 $ cd /media/username/EOS_DIGITAL/DCIM
-$ imagebackup ~/Photos/raw
+$ imagebackup.rb ~/Photos/raw
 ```
+
 This will search all files within the DCIM folder, check them with either exiv2 (for stills) or ffprobe (for videos) and retrieve their creation dates.  
 It will then copy them to a folder of the form ```~/Photos/raw/<yyyy>-<mm>-<dd>```  
 If it's unable to find metadata in a file it will look at the file's creation time attribute, which is less reliable but usually ok.
 
+### To register a new file type:
 
-## Options:
--m will move (deleting the original), which is probably not a good idea in most cases but still useful at times.
+```bash
+$ imagebackup.rb --add-filetype orf pic
+```
+or
+```bash
+$ imagebackup.rb -a orf pic
+```
+This will work with ```*.ORF```, ```orf```, ```".orf"``` as it will strip off any unnecessary characters. It is case-insensitive.
+
+### To do a dry run, checking each file and destination but not actually copying:
+
+```bash
+$ imagebackup.rb -n ~/Photos/raw
+```
+or
+```bash
+$ imagebackup.rb ~/Photos/raw --dry-run
+```
+
+### To move files instead of copying them (careful!):
+```bash
+$ imagebackup.rb -m ~/Photos/raw
+```
+or
+```bash
+$ imagebackup.rb --move ~/Photos/raw
+```
+
+### To make symbolic links instead of copying files:
+```bash
+$ imagebackup.rb -l ~/Photos/raw
+```
+or
+```bash
+$ imagebackup.rb --link ~/Photos/raw
+```
+This mode can be useful if you want to operate on the files in one place but keep them on their media. Particularly useful for large movie files.
+
+## Dependencies:
+
+**Ruby** v2.3.0 or greater, plus gems:
+  - exiv2
+  - ffprober  
+
+Ruby modules:
+  - fileutils.rb
+
+Bundler should handle all these dependencies. If for some reason it doesn't you can run this in terminal:  
+```bash
+$ gem install exiv2 ffprober
+```

data/lib/classes/filetypes.csv

@@ -3,9 +3,13 @@ mp4,movie
 avi,movie
 mpg,movie
 vob,movie
+m2ts,movie
 3gp,movie
 mxf,movie
 mlv,movie
+webm,movie
+mkv,movie
+ogm,movie
 dng,pic
 tif,pic
 jpg,pic
@@ -15,5 +19,3 @@ cr2,pic
 arw,pic
 raw,pic
 gif,pic
-gif,pic
-gif,pic

data/lib/imagebackup.rb

@@ -5,14 +5,13 @@ require_relative 'classes/filetypes'
 require_relative 'methods/build_paths'
 require_relative 'methods/get_dates'
 require_relative 'methods/copy_pic'
+require_relative 'methods/display_help'
 
 require 'exiv2'
 require 'fileutils'
 require 'ffprober'
-require 'json'
-require 'getoptlong'
 
-def main_loop(dest,dryrun=true)
+def main_loop(dest,dryrun=true,file_op="copy")#,move=nil,link=nil)
   file_types = FileTypes.list
   Dir.glob(file_types).reverse_each do |f|
 
@@ -22,28 +21,31 @@ def main_loop(dest,dryrun=true)
     outfile = parms[0]
     destpath = parms[1]
 
-    if File.exist?(outfile)
-      puts "\"#{outfile}\" already exists."
-    else
-      copy_pic(file,outfile,destpath,dryrun)
-    end
+    copy_pic(file,outfile,destpath,dryrun,file_op)#,move,link)
+    
   end
 end
 
 # main_loop(ARGV[0])
 
 dryrun = true
+# link = false
+# move = false
+file_op = "cp" # or "mv" or "ln_s"
 
-if (ARGV & ['-n','--dry-run']).any?
-  dryrun = true
-  ARGV.delete('-n')
-  ARGV.delete('--dry-run')
-else
-  # FIXME: THIS IS REVERSED TO ALWAYS BE TRUE WHILE I'M TESTING. CHANGE BELOW TO false BEFORE DEPLOYMENT
-  dryrun = true
-  puts "dry run is disabled! i'm really going to mess with your files!"
+if (ARGV & ['-m','--move']).any?
+  # move = true
+  file_op = "mv"
+  ARGV.delete('-m')
+  ARGV.delete('--move')
+end
+if (ARGV & ['-l','--link']).any?
+  # link = true
+  file_op = "ln_s"
+  ARGV.delete('-l')
+  ARGV.delete('--link')
 end
-if ARGV.include?('-a')#,'--add-filetype']).any?
+if ARGV.include?('-a')
   ext=ARGV[ARGV.index('-a')+1]
   type=ARGV[ARGV.index('-a')+2]
   ARGV.slice!(ARGV.index('-a')..ARGV.index('-a')+2)
@@ -56,7 +58,26 @@ end
 if ext
   FileTypes.add(ext,type)
 end
+if (ARGV & ['-n','--dry-run']).any?
+  dryrun = true
+  puts "Doing a dry run - no operations will happen."
+  sleep 1
+  ARGV.delete('-n')
+  ARGV.delete('--dry-run')
+else
+  dryrun = false
+end
 
-if ARGV
-  main_loop(ARGV[0])
+if (ARGV & ['-h','--help','-?']).any?
+  display_help()
+end
+
+if ARGV[0].to_s == ''
+  display_help()
+else
+  if File.exist?(ARGV[0])
+    main_loop(ARGV[0],dryrun,file_op)
+  else
+    puts "Specified destination does not exist. Please create this folder first."
+  end
 end

data/lib/imagebackup/version.rb

@@ -1,3 +1,3 @@
 module Imagebackup
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/methods/copy_pic.rb

@@ -1,11 +1,29 @@
-def copy_pic(file,outfile,destpath,dryrun)
+def process_file(file,outfile,dryrun=nil,file_op="cp")
   if dryrun
-    puts "pretending to copy \"#{file}\" to \"#{outfile}\""
-    puts "FileUtils.mkdir_p(#{destpath})"
-    puts "FileUtils.cp(#{file},#{outfile})"
+    puts "pretending to #{file_op} \"#{file} to #{outfile}\""
   else
-    puts "copying \"#{file}\" to \"#{outfile}\""
-    FileUtils.mkdir_p(destpath)
-    FileUtils.cp(file,outfile)
+    puts "#{file_op}-ing \"#{file} to #{outfile}\"..."
+    FileUtils.public_send(file_op,file,outfile)
+    FileUtils.public_send(file_op,"#{file}.xmp",outfile,:force => true)
+    if file_op == "cp"
+      FileUtils.public_send(file_op,"#{file}.xmp",outfile)
+    else
+      FileUtils.public_send(file_op,"#{file}.xmp",outfile,:force => true)
+    end
+  end
+end
+
+def copy_pic(file,outfile,destpath,dryrun=nil,file_op="cp") #,move=nil,link=nil)
+  unless File.exist?(outfile)
+    unless dryrun
+      unless File.exist?(destpath)
+        puts "creating folder \"#{destpath}\""
+        FileUtils.mkdir_p(destpath)
+      else
+      end
+    end
+    process_file(file,outfile,dryrun,file_op)
+  else
+    puts "\"#{outfile}\" already exists. Skipping..."
   end
 end

data/lib/methods/display_help.rb

@@ -0,0 +1,82 @@
+def display_help
+  print <<EOF
+===== ImageBackup =====
+
+Keep your photos and videos organized by date.
+
+A simple terminal app to crawl a folder (usually a camera card's DCIM folder) for pictures and videos, and pop them in dated folders to your destination folder of choice. Uses exif data when available, creation_time, or the file's own creation date if nothing better is present.  
+
+Will also copy over any xmp sidecar files found, not overwriting.
+
+Options:
+
+-n, --dry-run                            Run without actually doing anything. Good for making sure
+                                         things are working properly. This will also give you console
+                                         output which helps identify unreadable files.
+
+-a, --add-filetype <extension> <type>    This will add a custom file type to the list of files it's
+                                         looking for. If you have an arcane digital camera (we
+                                         currently support canon, sony, pentax but new stuff comes out
+                                         all the time), this will allow you to add your raw files.
+                                         You can also access *filetypes.csv* and add them manually,
+                                         but ensure there's a blank line at the end or this program
+                                         may behave badly.
+
+-m                                       will move (deleting the original), which is probably not a
+                                         good idea in most cases but still useful at times.
+
+Usage:
+
+- To backup a camera card:
+
+$ cd /media/username/EOS_DIGITAL/DCIM
+$ imagebackup.rb ~/Photos/raw
+
+This will search all files within the DCIM folder, check them with either exiv2 (for stills) or ffprobe (for videos) and retrieve their creation dates.  
+It will then copy them to a folder of the form ~/Photos/raw/<yyyy>-<mm>-<dd>
+If it's unable to find metadata in a file it will look at the file's creation time attribute, which is less reliable but usually ok.
+
+- To register a new file type:
+
+$ imagebackup.rb --add-filetype orf pic
+or
+$ imagebackup.rb -a orf pic
+
+This will work with *.ORF, orf, ".orf" as it will strip off any unnecessary characters. It is case-insensitive.
+
+- To do a dry run, checking each file and destination but not actually copying:
+
+$ imagebackup.rb -n ~/Photos/raw
+or
+$ imagebackup.rb ~/Photos/raw --dry-run
+
+- To move files instead of copying them (careful!):
+
+$ imagebackup.rb -m ~/Photos/raw
+or
+$ imagebackup.rb --move ~/Photos/raw
+
+- To make symbolic links instead of copying files:
+
+$ imagebackup.rb -l ~/Photos/raw
+or
+$ imagebackup.rb --link ~/Photos/raw
+
+This mode can be useful if you want to operate on the files in one place but keep them on their media. Particularly useful for large movie files.
+
+Dependencies:
+
+Ruby v2.3.0 or greater, plus gems:
+ - exiv2
+ - ffprober  
+
+Ruby modules:
+ - fileutils
+
+Bundler should handle all these dependencies. If for some reason it doesn't you can run this in terminal:  
+$ gem install exiv2 ffprober
+
+EOF
+
+exit(0)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imagebackup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - adrian-sal-kennedy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: exiv2
@@ -61,6 +61,7 @@ files:
 - lib/imagebackup/version.rb
 - lib/methods/build_paths.rb
 - lib/methods/copy_pic.rb
+- lib/methods/display_help.rb
 - lib/methods/get_dates.rb
 homepage: https://github.com/adrian-sal-kennedy/imagebackup
 licenses: