gallerist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff2b65d33304727eae500b7fc80f7de3b925c9e9
+  data.tar.gz: 4725ef924d8903081662a61279c01fec06343499
+SHA512:
+  metadata.gz: 16b0d2f8928d41365189e1159e59eae1a37b2256bfbfbd4c3aa28a0d87bc2a7405ba49d5d3c2c0d26876e7d5c7567b8de21d1349e16d043d9d0d350d6a2880f7
+  data.tar.gz: 8f3a100f666ffe5c626c9ca231b1b36cdbaaa402a52c83e0a105af6c3f676227bc07c159810923524b5e6ea84be02f2d0cd91c1dbbe4d9e68900511eed671352

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+Gemfile.lock

data/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+Contribution Guidelines
+=======================
+
+First of all, each single contribution is appreciated, whether a typo fix,
+improved documentation, a fixed bug or a whole new feature.
+
+## Making your changes
+
+ 1. Fork the repository on GitHub
+ 2. Create a topic branch with a descriptive name, e.g. `fix-issue-123` or
+    `feature-x`
+ 3. Make your modifications, complying with the
+    [code conventions](#code-conventions)
+ 4. Commit small logical changes, each with a descriptive commit message.
+    Please don˚t mix unrelated changes in a single commit.
+ 5. Don˚t commit things that are unrelated to the whole change.
+
+## Commit messages
+
+Please format your commit messages as follows:
+
+    Short summary of the change (up to 50 characters)
+
+    Optionally add a more extensive description of your change after a
+    blank line. Wrap the lines in this and the following paragraphs after
+    72 characters.
+
+## Submitting your changes
+
+ 1. Push your changes to a topic branch in your fork of the repository.
+ 2. [Submit a pull request][pr] to the original repository.
+    Describe your changes as short as possible, but as detailed as needed for
+    others to get an overview of your modifications.
+
+## Code conventions
+
+ * White spaces:
+   * Indent using 2 spaces
+   * Line endings must be line feeds (\n)
+   * Add a newline at the end of a file
+ * Name conventions:
+   * `UpperCamelCase` for classes and modules
+   * `lower_case` for variables and methods
+   * `UPPER_CASE` for constants
+
+## Further information
+
+ * [General GitHub documentation][gh-help]
+ * [GitHub pull request documentation][gh-pr]
+
+ [gh-help]: https://help.github.com
+ [gh-pr]:   https://help.github.com/send-pull-requests
+ [pr]:      https://github.com/koraktor/gallerist/pull/new

data/Gemfile

@@ -0,0 +1,8 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2015, Sebastian Staudt
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2015, Sebastian Staudt
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of the author nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,57 @@
+Gallerist
+=========
+
+Gallerist is a web application to browse libraries of Apple Photos and iPhoto.
+It is built on top of [Sinatra][sinatra].
+
+## Requirements
+
+ * One or more Photos or iPhoto libraries (`.photoslibrary` or `.photolibrary`
+   directories)
+ * Ruby 2.x with Bundler
+
+OS X 10.9 and above ship with Ruby 2.0. You will only have to install Bundler
+(`gem install bundler`) to get started.
+
+## Installation
+
+Gallerist can be simply installed as a Ruby gem.
+
+```shell
+$ gem install gallerist
+```
+
+*Note*: You might need to use `sudo` if you’re installing into your system
+Ruby, e.g. when not using rbenv or RVM.
+
+If you want to run the current development code please use Git to clone the
+repository.
+
+## Usage
+
+```shell
+$ bin/gallerist ~/Pictures/Photos\ Library.photoslibrary
+```
+
+After that the application is served on port 9292 by default. You can open it
+by simply browsing to `http://localhost:9292`.
+
+Further command-line arguments are available, see `gallerist --help` for more
+information.
+
+## Caveats
+
+ * iPhoto libraries work to a certain degree as iPhoto’s events are not
+   listed, only albums.
+ * Gallerist works on a copy of the library databases, i.e. changes to the
+   original library will not be reflected instantly. You will have to restart
+   the web app first.
+
+## Future plans
+
+ * Support for internal categories like photo stream and videos
+ * Support for moments and places
+ * Performance improvements
+
+ [brew]: http://brew.sh
+ [sinatra]: http://www.sinatrarb.com

data/Rakefile

@@ -0,0 +1,16 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2015, Sebastian Staudt
+
+require 'rubygems/package_task'
+
+spec = Gem::Specification.load 'gallerist.gemspec'
+Gem::PackageTask.new spec do |pkg|
+end
+
+# Task to clean the package directory
+desc 'Clean package directory'
+task :clean do
+  FileUtils.rm_rf 'pkg'
+end

data/assets/stylesheets/main.scss

@@ -0,0 +1,17 @@
+/**
+ * This code is free software; you can redistribute it and/or modify it under
+ * the terms of the new BSD License.
+ *
+ * Copyright (c) 2015, Sebastian Staudt
+ */
+
+@import 'bootstrap';
+
+.navbar-inverse .navbar-brand:hover {
+  color: $navbar-inverse-brand-color;
+}
+
+.tag {
+  display: inline-block;
+  margin-right: 1pt;
+}

data/bin/gallerist

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+#
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2015, Sebastian Staudt
+
+require 'optparse'
+require 'rack'
+
+ENV['RACK_ENV'] ||= 'production'
+
+server_options = { port: 9292 }
+opts = OptionParser.new do |opts|
+  opts.banner = 'Usage: gallerist [options] <library>'
+
+  opts.separator ''
+  opts.separator 'Options:'
+  opts.on('-p', '--port PORT', 'Specify on which port to listen') do |port|
+    server_options[:port] = port
+  end
+  opts.on('-d', '--debug', 'Enable debug mode') do
+    ENV['RACK_ENV'] = 'development'
+  end
+
+  opts.separator ''
+  opts.separator 'Arguments:'
+  opts.separator opts.summary_indent + '<library> The path to the photo library to open.'
+
+  opts.separator ''
+  opts.separator 'Advanced options:'
+  opts.on('-n', '--no-copy', 'Disable temporary copies of the library databases') do
+    ENV['GALLERIST_NOCOPY'] = 'true'
+  end
+end
+opts.parse!
+
+$LOAD_PATH << File.join(__dir__, '..', 'lib')
+
+require 'gallerist'
+
+config_path = File.expand_path File.join(__dir__, '..', 'config.ru')
+
+ENV['GALLERIST_LIBRARY'] = ARGV[0]
+
+if ENV['GALLERIST_LIBRARY'].nil?
+  puts opts.help
+  exit 1
+end
+
+begin
+  Rack::Server.start config: config_path,
+                     server: :unicorn,
+                     Port: server_options[:port],
+                     worker_processes: 4
+rescue Gallerist::LibraryInUseError
+  $stderr.puts 'The library is currently in use.' <<
+               ' Is it currently opened in Photos?'
+end

data/config.ru

@@ -0,0 +1,21 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2015, Sebastian Staudt
+
+unless defined? Gallerist
+  $LOAD_PATH << File.join(__dir__, 'lib')
+  require 'gallerist'
+end
+
+warmup do |app|
+  Rack::MockRequest.new(app).get '/',
+    'rack.errors' => $stderr,
+    'rack.warmup' => true
+end
+
+map '/assets' do
+  run Gallerist::App.sprockets
+end
+
+run Gallerist::App

data/gallerist.gemspec

@@ -0,0 +1,32 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2015, Sebastian Staudt
+
+$LOAD_PATH << File.join(__dir__, 'lib')
+
+require 'gallerist'
+
+Gem::Specification.new do |s|
+  s.name        = 'gallerist'
+  s.version     = Gallerist::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ 'Sebastian Staudt' ]
+  s.email       = [ 'koraktor@gmail.com' ]
+  s.homepage    = 'https://github.com/koraktor/gallerist'
+  s.license     = 'BSD'
+  s.summary     = 'A web application to browse Apple Photos and iPhoto libraries'
+  s.description = 'View Photos and iPhoto libraries in your browser'
+
+  s.add_dependency 'activerecord', '~> 4.2'
+  s.add_dependency 'bootstrap-sass', '~> 3.3'
+  s.add_dependency 'rack', '~> 1.6'
+  s.add_dependency 'sinatra', '~> 1.4'
+  s.add_dependency 'sprockets-helpers', '~> 1.1'
+  s.add_dependency 'sqlite3', '~> 1.3'
+  s.add_dependency 'unicorn', '~> 4.8'
+
+  s.executables   = [ 'gallerist' ]
+  s.files         = `git ls-files`.split
+  s.require_paths = 'lib'
+end

data/lib/gallerist.rb

@@ -0,0 +1,46 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2015, Sebastian Staudt
+
+module Gallerist
+
+  VERSION = '0.1.0'
+
+  autoload :App, 'gallerist/app'
+  autoload :Helpers, 'gallerist/helpers'
+  autoload :Library, 'gallerist/library'
+  autoload :LibraryInUseError, 'gallerist/errors'
+  autoload :RaiseWarmupExceptions, 'gallerist/middleware/raise_warmup_exceptions'
+  autoload :ShowExceptions, 'gallerist/middleware/show_exceptions'
+
+  # Models
+
+  MODELS = {}
+
+  def self.model(name, file)
+    autoload name, file
+
+    MODELS[name] = file
+  end
+
+  def self.load_models
+    MODELS.values.each { |file| require file }
+  end
+
+  model :AdminData, 'gallerist/models/admin_data'
+  model :Album, 'gallerist/models/album'
+  model :AlbumPhoto, 'gallerist/models/album_photo'
+  model :BaseModel, 'gallerist/models/base_model'
+  model :ImageProxiesModel, 'gallerist/models/image_proxies_model'
+  model :ImageProxyState, 'gallerist/models/image_proxy_state'
+  model :Master, 'gallerist/models/master'
+  model :ModelResource, 'gallerist/models/model_resource'
+  model :Person, 'gallerist/models/person'
+  model :PersonModel, 'gallerist/models/person_model'
+  model :PersonPhoto, 'gallerist/models/person_photo'
+  model :Photo, 'gallerist/models/photo'
+  model :Tag, 'gallerist/models/tag'
+  model :TagPhoto, 'gallerist/models/tag_photo'
+
+end

data/lib/gallerist/app.rb

@@ -0,0 +1,230 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2015, Sebastian Staudt
+
+require 'active_record'
+require 'bootstrap-sass'
+require 'logger'
+require 'sinatra/sprockets-helpers'
+
+class Gallerist::App < Sinatra::Base
+
+  register Sinatra::Sprockets::Helpers
+
+  configure do
+    enable :logging
+
+    set :root, File.join(root, '..', '..')
+
+    set :library_path, ENV['GALLERIST_LIBRARY']
+    set :copy_dbs, !ENV['GALLERIST_NOCOPY']
+    set :views, File.join(root, 'views')
+
+    set :sprockets, Sprockets::Environment.new(root)
+
+    sprockets.append_path File.join(root, 'assets', 'stylesheets')
+    sprockets.cache = Sprockets::Cache::FileStore.new Dir.tmpdir
+    sprockets.css_compressor = :scss
+
+    configure_sprockets_helpers do |helpers|
+      helpers.debug = development?
+    end
+
+    Bootstrap.load!
+  end
+
+  configure :development do
+    set :logging, ::Logger::DEBUG
+
+    debug_logger = ::Logger.new($stdout, ::Logger::DEBUG)
+
+    sprockets.logger = debug_logger
+    ActiveRecord::Base.logger = debug_logger
+  end
+
+  error 500 do |error|
+    @title = 'Error'
+
+    raise error if env['rack.errors'].is_a? StringIO
+
+    erb :'500'
+  end
+
+  helpers Gallerist::Helpers
+
+  def send_library_file(file, options = {})
+    logger.debug "Serving file '%s' from library..." % [ file ]
+
+    file_path = File.join(library.path, file)
+    response = catch(:halt) { send_file file_path, options }
+    if response == 404
+      logger.error "File '%s' could not be served, because it does not exist." % file
+    end
+
+    halt response
+  end
+
+  def library
+    unless settings.respond_to? :library
+      settings.set :library, Gallerist::Library.new(settings.library_path)
+
+      logger.info "Loading library from \"#{library.path}\""
+
+      if settings.copy_dbs
+        logger.debug 'Creating temporary copy of the main library database...'
+        library.copy_base_db
+        logger.debug '  Completed.'
+      end
+
+      ActiveRecord::Base.establish_connection({
+        adapter: 'sqlite3',
+        database: library.library_db
+      })
+      ActiveRecord::Base.connection.exec_query 'PRAGMA journal_mode="MEMORY";'
+
+      if settings.copy_dbs
+        logger.debug 'Creating temporary copies of additional library databases...'
+        library.copy_extra_dbs
+        logger.debug '  Completed.'
+      end
+
+      logger.info "  Found library with type '%s'." % [ library.app_id ]
+
+      Gallerist.load_models
+      Gallerist::BaseModel.descendants.each do |model|
+        logger.debug "Setting up %s for library type '%s'" % [ model, library.type ]
+
+        model.setup_for library.type
+      end
+
+      Gallerist::ImageProxiesModel.establish_connection({
+        adapter: 'sqlite3',
+        database: library.image_proxies_db
+      })
+      Gallerist::ImageProxiesModel.connection.exec_query 'PRAGMA journal_mode="MEMORY";'
+
+      Gallerist::PersonModel.establish_connection({
+        adapter: 'sqlite3',
+        database: library.person_db
+      })
+      Gallerist::PersonModel.connection.exec_query 'PRAGMA journal_mode="MEMORY";'
+    end
+    settings.library
+  end
+
+  def navbar_for(obj)
+    @navbar = [[ '/', library.name ]]
+
+    case obj
+    when :all_photos
+      @navbar << [ '/photos', 'All photos' ]
+    when :favorites
+      @navbar << [ '/favorites', 'Favorites' ]
+    when Gallerist::Album
+      @navbar << [ '/albums', 'Albums' ]
+      @navbar << [ '/albums/%s' % [ obj.id ], obj.name ]
+    when Gallerist::Person
+      @navbar << [ '/persons', 'Persons' ]
+      @navbar << [ '/persons/%s' % [ obj.id ], obj.name ]
+    when Gallerist::Tag
+      @navbar << [ '/tags', 'Tags' ]
+      @navbar << [ '/tags/%s' % [ obj.simple_name ], obj.name ]
+    end
+  end
+
+  def photo(id)
+    Gallerist::Photo.find id
+  rescue ActiveRecord::RecordNotFound
+    logger.error 'Could not find the photo with ID #%s.' % [ id ]
+    not_found
+  end
+
+  def self.setup_default_middleware(builder)
+    builder.use Sinatra::ExtendedRack
+    builder.use Gallerist::ShowExceptions if show_exceptions?
+    builder.use Gallerist::RaiseWarmupExceptions
+
+    setup_logging builder
+  end
+
+  get '/' do
+    @title = library.name
+
+    @albums = library.albums.visible.nonempty.order :date
+    @persons = library.persons
+    @tags = library.tags.nonempty.order 'photos_count desc'
+
+    navbar_for :root
+
+    erb :index
+  end
+
+  get '/albums/:id' do
+    @album = library.albums.find params[:id]
+    @title = @album.name
+
+    navbar_for @album
+
+    erb :album
+  end
+
+  get '/favorites' do
+    @photos = library.photos.favorites
+    @title = 'Favorites'
+
+    navbar_for :favorites
+
+    erb :photos
+  end
+
+  get '/persons/:id' do
+      @person = library.persons.find params[:id]
+      @title = @person.name
+
+      navbar_for @person
+
+      erb :person
+    end
+
+  get '/photos' do
+    @photos = library.photos
+    @title = 'All photos'
+
+    navbar_for :all_photos
+
+    erb :photos
+  end
+
+  get '/photos/:id' do
+    photo = photo params[:id]
+
+    send_library_file photo.image_path,
+      disposition: :inline,
+      filename: photo.file_name
+  end
+
+  get '/tags/:name' do
+    @tag = library.tags.find_by_simple_name params[:name]
+    @title = @tag.name
+
+    navbar_for @tag
+
+    erb :tag
+  end
+
+  get '/thumbs/:id' do
+    photo = photo params[:id]
+
+    if photo.thumbnail_available?
+      thumbnail_path = photo.small_thumbnail_path
+    else
+      thumbnail_path = photo.preview_path
+    end
+
+    send_library_file thumbnail_path,
+      disposition: :inline,
+      filename: 'thumb_%s' % [ photo.file_name ]
+  end
+
+end