photein 0.0.4 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 852660eba8fefe43e1b18967162a149c13f35f85e811f08089403da3f2dd0652
-  data.tar.gz: 8a6af0e7ce270985f6a427dfc509be093d884baedccd33ac778611285fedf71a
+  metadata.gz: 8005c4c7e035db2675a5f6cdcc0a0567b53aec6117b279d1242c4dae8d671758
+  data.tar.gz: 9d3ddc4eaf083903e45eaa55de9c93bd97c2201777bc676ee815436b427c0641
 SHA512:
-  metadata.gz: f7fc315331d2de5da4df3fb5aacfd7a58220f3581e3753a2c01802e428432e57ab89ac7d66c44bbecfbd8aae7f2e8966e6a18c1857ed26b68b0e2dc046bbf780
-  data.tar.gz: 27f432d3dae62069f2197051e523da3db8e3743467ce2dd17be4e7788720ef74090beb345ee98072d1df2cffe86fb7be22bde32d8d4460048eb7603f92537dbe
+  metadata.gz: 683fd6aa36b788f9e985210e7ae2fc97474b3d155afa04db1d8e1a87c1892b68d9a262e93798b0b3449b83285809e6035c3a82bb4955f1dd3f02f01768173a4f
+  data.tar.gz: 74cfbc6831fb2fbdb88a09dd0d3412ceac70ddc62379bf37e3bc800e442433b9b13d112bdff358cf04276b5ed6d59dc8804ef0fef757d223dcb466ebc726a627

data/README.md

@@ -1,29 +1,11 @@
-Ph📸tein / 🔀ferase
-===================
+Ph📸tein
+========
 
-All your photos under one roof.
+A no-nonsense way to organize your personal photo library.
 
-What do they do?
+What does it do?
 ----------------
 
-`photein` is a CLI utility for batch-importing
-your personal photos & videos into a central library.
-
-`xferase` is an always-on background service that uses `photein`
-to continuously import new photos & videos as they come in.
-
-When combined with other software,
-they can be used as a kind of self-hosted / DIY alternative
-to cloud photo services like Google Photos or iCloud.
-
-> ⚠️ **Note**
->
-> Unlike true cloud photo services,
-> this approach works by keeping a full copy of your photo library
-> in local storage on each device you sync to.
-
-### Photein
-
 Photein manages your photos **at the filesystem level**.
 It won’t let you browse or edit your photos,
 but it will give them a uniform folder structure and filenames,
@@ -32,21 +14,22 @@ no matter where they come from:
 ```sh
 # Before                                # After
 
-~/Pictures                              ~/Pictures
-└── _inbox                              ├── _inbox
-    ├── 1619593208911.jpeg              ├── 2020
-    ├── DCIM                            │   ├── 2020-08-01_113129.heic
-    │   └── 2021_03_26                  │   └── 2020-05-20_160209.png
-    │       ├── R0014285.MOV            └── 2021
-    │       ├── R0014286.DNG                ├── 2021-02-12_081933a.jpg
-    │       ├── R0014286.JPG                ├── 2021-02-12_081933b.jpg
-    │       ├── R0014287.DNG                ├── 2021-02-12_081939.mp4
-    │       └── R0014287.JPG                ├── 2021-03-26_161245.mp4
-    ├── IMG_20210212_081933_001.jpg         ├── 2021-03-26_161518.dng
-    ├── IMG_20210212_081933_002.jpg         ├── 2021-03-26_161518.jpg
-    ├── IMG_8953.HEIC                       ├── 2021-03-26_170304.dng
-    ├── Screenshot_20200520_160209.png      ├── 2021-03-26_170304.jpg
-    └── VID_20210212_081939.mp4             └── 2021-04-28_000008.jpg
+~                                       ~
+├── Downloads                           ├── Downloads
+│   ├── 1619593208911.jpeg              └── Pictures
+│   ├── DCIM                                ├── 2020
+│   │   └── 2021_03_26                      │   ├── 2020-08-01_113129.heic
+│   │       ├── R0014285.MOV                │   └── 2020-05-20_160209.png
+│   │       ├── R0014286.DNG                └── 2021
+│   │       ├── R0014286.JPG                    ├── 2021-02-12_081933a.jpg
+│   │       ├── R0014287.DNG                    ├── 2021-02-12_081933b.jpg
+│   │       └── R0014287.JPG                    ├── 2021-02-12_081939.mp4
+│   ├── IMG_20210212_081933_001.jpg             ├── 2021-03-26_161245.mp4
+│   ├── IMG_20210212_081933_002.jpg             ├── 2021-03-26_161518.dng
+│   ├── IMG_8953.HEIC                           ├── 2021-03-26_161518.jpg
+│   ├── Screenshot_20200520_160209.png          ├── 2021-03-26_170304.dng
+│   └── VID_20210212_081939.mp4                 ├── 2021-03-26_170304.jpg
+└── Pictures                                    └── 2021-04-28_000008.jpg
 ```
 
 Photein generates these folders & filenames
@@ -55,51 +38,29 @@ based on metadata timestamps, filename timestamps, or file creation times.
 > ⚠️ **Note**
 >
 > If you use a photo management app that decides
-> where and how your photos should be stored on your system (like Apple Photos), 
-> Photein is not for you.
-
-### Xferase
-
-Xferase watches a directory of your choosing (its “inbox”),
-and whenever any files are placed there,
-it automatically imports them into your photo library.
-
-It creates and manages two parallel copies of your library
-(one original/hi-res, one optimized for web)
-and ensures that when you delete a photo from one,
-it is automatically removed from the other.
+> where and how your photos should be stored on disk
+> (looking at you, Apple Photos 👀), Photein is not for you.
 
-With the help of [Syncthing][] and systemd,
-you can automatically pull new photos from your camera or Android phone
-into Xferase’s inbox.
-Syncthing can also push your complete, web-optimized photo library
-back to your phone (or, say, push your hi-res library out to another machine).
+It can also optimize photos and videos for reduced file size.
 
-[Syncthing]: https://syncthing.net/
+What _doesn’t_ it do?
+---------------------
 
-Why?
-----
+On its own, Photein is **not** an alternative
+to cloud photo services like Google Photos or iCloud—but
+in combination with other software, it can be.
 
-I could not find any existing software product that:
+If you want to:
 
-1. imports photos from many sources\* with **no mouse or keyboard interaction**
+* import photos from your phone as soon as you take them
+* import photos from a digital camera / SD card as soon as you plug it in
+* mirror a low-res copy of your entire photo library to your Android phone
 
-   \*_e.g.,_ 📱 cell phone / 📷 digital camera / 💬 chat app download
+check out Photein’s sister utility [Xferase][],
+or try the [automation guides][] below.
 
-2. enforces a clean, consistent, **user-visible directory & filename scheme**
-
-   (I want to be able to access my photos from the file manager,
-   find them in an “Open...” dialog,
-   or sync them to other devices with generic tools
-   like rsync, Dropbox, or Syncthing.)
-
-3. comes with **no recurring subscription fee**—or better yet, is FOSS
-
-   (My digital photo/video library belongs to me,
-   but if I don’t control the pipeline for viewing/managing it,
-   then does it really?)
-
-4. works with Linux
+[Xferase]: https://github.com/rlue/xferase
+[automation guides]: #automation-guides
 
 Installation
 ------------
@@ -110,7 +71,7 @@ $ gem install photein
 
 ### Dependencies
 
-* Ruby 2.7+
+* Ruby 2.6+
 * [ExifTool][]
 * [MediaInfo][]
 * ImageMagick (for `--optimize-for=web` option)
@@ -123,8 +84,6 @@ $ gem install photein
 Usage
 -----
 
-### Simple import
-
 ```sh
 $ photein \
     --source /media/ricoh_gr/DCIM \ # batch-import photos from here
@@ -145,9 +104,17 @@ Use `photein --help` for a summary of all options.
 
 ### Automation guides
 
-* [📷➡️🖥️ Set up auto-import from a digital camera](doc/auto-import-digital-camera.md)
-* [📱➡️🖥️ Set up auto-import from an Android phone](doc/auto-import-android-phone.md)
-* [📱🔄🖥️ Mirror your library across multiple devices](doc/mirroring-a-library-on-multiple-devices.md)
+Using Photein + systemd, you can:
+
+* [📷➡️🖥️ Set up auto-import from a digital camera](guides/auto-import-digital-camera.md)
+
+But for more complex tasks, like:
+
+* 📱➡️🖥️ Setting up auto-import from an Android phone
+* 📱🔄🖥️ Mirroring your library across multiple devices
+
+check out the documentation for [Xferase][],
+an always-on background service based on Photein.
 
 Development
 -----------

data/bin/photein

@@ -33,25 +33,4 @@ at_exit do
 end
 
 # Core Logic -------------------------------------------------------------------
-image_formats = Photein::Image::SUPPORTED_FORMATS
-  .zip(Photein::Image::SUPPORTED_FORMATS.map(&:upcase))
-  .flatten
-
-SRC_DIR
-  .join(Photein::Config.recursive ? '**' : '')
-  .join("*{#{image_formats.join(',')}}")
-  .then { |glob| Dir[glob].sort }
-  .map(&Photein::Image.method(:new))
-  .each(&:import)
-
-# Video compression is time-consuming, so save it for last
-video_formats = Photein::Video::SUPPORTED_FORMATS
-  .zip(Photein::Video::SUPPORTED_FORMATS.map(&:upcase))
-  .flatten
-
-SRC_DIR
-  .join(Photein::Config.recursive ? '**' : '')
-  .join("*{#{video_formats.join(',')}}")
-  .then { |glob| Dir[glob].sort }
-  .map(&Photein::Video.method(:new))
-  .each(&:import)
+Photein.run

data/lib/photein/config.rb

@@ -25,10 +25,14 @@ module Photein
       .map { |option| option[/\w[a-z\-]+/] }
       .map(&:to_sym)
 
+    @params = {}
+
     class << self
-      def parse_opts!
-        @params = {}
+      def set(**params)
+        @params.replace(params)
+      end
 
+      def parse_opts!
         parser = OptionParser.new do |opts|
           opts.version = Photein::VERSION
           opts.banner  = <<~BANNER

data/lib/photein/image.rb

@@ -43,7 +43,12 @@ module Photein
       when '.png'
         FileUtils.cp(path, tempfile, noop: Photein::Config.dry_run)
         Photein::Logger.info "optimizing #{path}"
-        Optipng.optimize(tempfile, level: 4) unless Photein::Config.dry_run
+        begin
+          Optipng.optimize(tempfile, level: 4) unless Photein::Config.dry_run
+        rescue Errno::ENOENT
+          Photein::Logger.error('optipng is required to compress PNG images')
+          raise
+        end
       end
     end
 
@@ -51,10 +56,20 @@ module Photein
 
     def image
       @image ||= MiniMagick::Image.open(path)
+    rescue MiniMagick::Invalid => e
+      Photein::Logger.error(<<~MSG) if e.message.match?(/You must have ImageMagick/)
+        ImageMagick is required to manipulate image files
+      MSG
+      raise
     end
 
     def metadata_stamp
       MiniExiftool.new(path.to_s).date_time_original
+    rescue MiniExiftool::Error => e
+      Photein::Logger.error(<<~MSG) if e.message.match?(/exiftool: not found/)
+        exiftool is required to read timestamp metadata
+      MSG
+      raise
     end
 
     # NOTE: This may be largely unnecessary:

data/lib/photein/media_file.rb

@@ -20,6 +20,7 @@ module Photein
     end
 
     def import
+      return if corrupted?
       return if Photein::Config.interactive && denied_by_user?
       return if Photein::Config.safe && in_use?
       return if Photein::Config.optimize_for && non_optimizable_format?
@@ -44,6 +45,12 @@ module Photein
 
     private
 
+    def corrupted?(result = false)
+      return result.tap do |r|
+        Photein::Logger.error("#{path.basename}: cannot import corrupted file") if r
+      end
+    end
+
     def denied_by_user?
       $stdout.printf "Import #{path}? [y/N]"
       (STDIN.getch.downcase != 'y').tap { $stdout.puts }
@@ -113,7 +120,7 @@ module Photein
       when 1 # if one file found, WITH OR WITHOUT COUNTER, reset counter to a
         if Dir[collision_glob].first != collision_glob.sub('*', 'a') # don't try if it's already a lone, correctly-countered file
           Photein::Logger.info('conflicting timestamp found; adding counter to existing file')
-          FileUtils.mv(Dir[collision_glob].first, collision_glob.sub('*', 'a'))
+          FileUtils.mv(Dir[collision_glob].first, collision_glob.sub('*', 'a'), noop: Photein::Config.dry_run)
         end
       else # TODO: if multiple files found, rectify them?
       end

data/lib/photein/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Photein
-  VERSION = '0.0.4'
+  VERSION = '0.0.8'
 end

data/lib/photein/video.rb

@@ -53,13 +53,23 @@ module Photein
 
     private
 
+    def corrupted?
+      super(video.bitrate.nil?)
+    end
+
     def video
       @video ||= FFMPEG::Movie.new(path.to_s)
+    rescue Errno::ENOENT
+      Photein::Logger.error('ffmpeg is required to manipulate video files')
+      raise
     end
 
     def metadata_stamp
       # video timestamps are typically UTC
       MediaInfo.from(path.to_s).general.encoded_date&.getlocal
+    rescue MediaInfo::EnvironmentError
+      Photein::Logger.error('mediainfo is required to read timestamp metadata')
+      raise
     end
 
     # NOTE: This may be largely unnecessary:

data/lib/photein.rb

@@ -8,4 +8,16 @@ require 'photein/image'
 require 'photein/video'
 
 module Photein
+  class << self
+    def run
+      [Photein::Image, Photein::Video].each do |media_type|
+        Pathname(Photein::Config.source)
+          .join(Photein::Config.recursive ? '**' : '')
+          .join("*{#{media_type::SUPPORTED_FORMATS.join(',')}}")
+          .then { |glob| Dir.glob(glob, File::FNM_CASEFOLD).sort }
+          .map(&media_type.method(:new))
+          .each(&:import)
+      end
+    end
+  end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: photein
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.8
 platform: ruby
 authors:
 - Ryan Lue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: debouncer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: mediainfo
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rb-inotify
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: streamio-ffmpeg
   requirement: !ruby/object:Gem::Requirement
@@ -123,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -154,13 +126,11 @@ description: ''
 email: hello@ryanlue.com
 executables:
 - photein
-- xferase
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/photein
-- bin/xferase
 - lib/photein.rb
 - lib/photein/config.rb
 - lib/photein/image.rb

data/bin/xferase

@@ -1,170 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# TODO: Explain yourself
-
-# Parse opts -------------------------------------------------------------------
-require 'photein'
-require 'optparse'
-
-parser = OptionParser.new do |opts|
-  opts.version = Photein::VERSION
-  opts.banner  = <<~BANNER
-    Usage: xferase [--version] [-h | --help] [<args>]
-  BANNER
-
-  opts.on(
-    '-i INBOX', '--inbox=INBOX',
-    'path to the inbox'
-  )
-
-  opts.on(
-    '-s STAGING', '--staging=STAGING',
-    'path to the staging directory'
-  )
-
-  opts.on(
-    '-o LIB_ORIG', '--lib-orig=LIB_ORIG',
-    'path to the original/hi-res library'
-  )
-
-  opts.on(
-    '-w LIB_WEB', '--lib-web=LIB_WEB',
-    'path to the web-optimized library'
-  )
-
-  opts.on(
-    '-d INTERVAL', '--debounce=INTERVAL',
-    'wait n seconds for additional files before import'
-  )
-end
-
-begin
-  params = {}
-  parser.parse!(into: params)
-  params.freeze
-
-  %i[inbox staging lib-orig lib-web].each do |type|
-    raise "no #{type} directory given" if !params.key?(type)
-  end
-rescue => e
-  warn(e.message)
-  warn(parser.help) if e.is_a?(OptionParser::ParseError)
-  exit 1
-end
-
-# Config -----------------------------------------------------------------------
-require 'logger'
-
-DEBOUNCE_WAIT = params.fetch(:'debounce') { 60 }.to_i # seconds
-SRC_DEST_MAP = {
-  "#{params.fetch(:staging)}/desktop" => params.fetch(:'lib-orig'),
-  "#{params.fetch(:staging)}/web" => params.fetch(:'lib-web'),
-}
-
-IMPORT_CMD = %(
-  photein \
-    --verbose \
-    --source %s \
-    --dest %s \
-    --optimize-for %s
-)
-
-FORMAT_GROUPS = [%w(.jpg .dng .heic), %w(.mov .mp4), %w(.png)]
-
-LOGGER = Logger.new($stdout).tap(&:info!)
-
-# Setup ------------------------------------------------------------------------
-require 'debouncer'
-require 'fileutils'
-require 'pathname'
-require 'rb-inotify'
-require 'tmpdir'
-
-Thread.abort_on_exception = true
-SRC_DEST_MAP.keys.each(&FileUtils.method(:mkdir_p))
-
-mutex = Mutex.new
-debouncer = Debouncer.new(DEBOUNCE_WAIT) do |*files|
-  SRC_DEST_MAP.keys.each { |dir| FileUtils.ln(files, dir) }
-  FileUtils.rm(files + Dir["#{params.fetch(:staging)}/web/*.DNG"]) # FIXME (ugly hack)
-
-  break if debouncer.inspect_params[:threads] > 2 # don't let threads pile up
-
-  mutex.synchronize do
-    SRC_DEST_MAP.each do |src, dest|
-      system(IMPORT_CMD % [src, dest, src.split('/').last])
-    end
-  rescue => e
-    warn e.message
-  end
-end.reducer(:+)
-
-# Resume from interruption/failure ---------------------------------------------
-debouncer.call unless SRC_DEST_MAP.keys.all?(&Dir.method(:empty?))
-
-Dir["#{params.fetch(:inbox)}/**/*"]
-  .select(&File.method(:file?))
-  .each { |path| debouncer.call(path) }
-
-# Start ------------------------------------------------------------------------
-Thread.new do
-  call_debouncer = ->(event) do
-    debouncer.call(event.absolute_name)
-  rescue => e
-    warn e.message
-  end
-
-  import_notifier = INotify::Notifier.new
-  import_notifier.watch(params.fetch(:inbox), :close_write, &call_debouncer)
-
-  # NOTE: inotify is not recursive,
-  # so subdirectories must be watched separately!
-  # (Why do Syncthing folders get special treatment?
-  # Because ST works by creating hidden tempfiles and moving them upon completion)
-  stfolders, simple_subdirs = Dir["#{params.fetch(:inbox)}/**/*"]
-    .select(&File.method(:directory?))
-    .partition { |dir| Dir.children(dir).include?('.stfolder') }
-
-  simple_subdirs.each { |dir| import_notifier.watch(dir, :close_write, &call_debouncer) }
-  stfolders.each { |dir| import_notifier.watch(dir, :moved_to, &call_debouncer) }
-
-  import_notifier.run
-end
-
-Thread.new do
-  sync_deletions = ->(event) do
-    LOGGER.info("#{event.name} has disappeared!")
-
-    deleted_file   = Pathname(event.absolute_name).expand_path
-
-    sister_file    = if deleted_file.to_s.start_with?(File.expand_path(params['LIB_ORIG']))
-                      deleted_file.sub(*params.values_at('LIB_ORIG', 'LIB_WEB'))
-                    else
-                      deleted_file.sub(*params.values_at('LIB_WEB', 'LIB_ORIG'))
-                    end
-
-    sister_formats = FORMAT_GROUPS.find { |group| group.include?(deleted_file.extname) }
-
-    related_files  = [deleted_file, sister_file]
-      .product(sister_formats)
-      .map { |file, ext| file.sub_ext(ext) }
-      .select(&:file?)
-
-    # (Why mv to tmpdir first? Why not rm straight away?
-    # Because rm would recursively trigger this inotify callback.)
-    related_files.each { |f| LOGGER.info("deleting #{f.realpath}") }
-    FileUtils.mv(related_files, Dir.tmpdir)
-    FileUtils.rm(related_files.map { |f| File.join(Dir.tmpdir, f.basename) })
-  end
-
-  deletion_notifier = INotify::Notifier.new
-
-  # NOTE: inotify is not recursive,
-  # so subdirectories must be watched separately!
-  (Dir["#{params.fetch(:'lib-orig')}/**/*"] + Dir["#{params.fetch(:'lib-web')}/**/*"])
-    .select(&File.method(:directory?))
-    .each { |dir| deletion_notifier.watch(dir, :delete, &sync_deletions) }
-
-  deletion_notifier.run
-end.join