gnome-wallpaper-changer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gnome-wallpaper-changer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Valeri Sokolov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Gnome::Wallpaper::Changer
+
+A utility to periodically rotate the wallpaper in Gnome.
+
+## Installation
+
+    $ gem install gnome-wallpaper-changer
+
+### Prerequisites
+
+* Ruby 1.9.3, properly setup to build native gems
+* libgd2
+
+## Usage
+
+GWChanger runs as a daemon. It has a built-in web server providing the configuration interface.
+
+After installation, run:
+
+	gnome-wallpaper-changer
+
+Then go to http://localhost:12345.
+You can override the port using the `--port` option; this setting will be preserved for future runs.
+
+The wallpaper rotation will be initially disabled; set the interval to a non-zero value to enable. Double-click an image to use it immediately.
+
+GWChanger looks for wallpaper images in several directories; the default ones are `/usr/share/backgrounds` and `~/Pictures`.
+You can add or remove them or selectively exclude specific files.
+
+You can set GWChanger to run automatically at login; this is disabled by default.
+
+If something goes wrong, you can reset your configuration and start from scratch by running:
+
+	gnome-wallpaper-changer --reset
+
+To stop the daemon, run:
+
+	gnome-wallpaper-changer --kill
+
+## Known issues and limitations
+
+* Chrome sometimes mixes up the image previews, apparently due to its caching strategy.
+* Directories are not scanned recursively.
+
+### Ruby managers and autostart
+
+Multiple Ruby managers, such as RVM, heavily modify the environment in order to work. This may prevent the autostarted script from locating the correct Ruby and installed gems. GWChanger will detect RVM and try to generate a wrapper with a fixed environment, but alternative managers are not supported at this point.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/gnome-wallpaper-changer

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'gnome-wallpaper-changer'
+Gnome::Wallpaper::Changer::Runner.new(ARGV).run!

data/gnome-wallpaper-changer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gnome-wallpaper-changer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Valeri Sokolov"]
+  gem.email         = ["ulfurinn@ulfurinn.net"]
+  gem.description   = %q{A wallpaper rotation daemon with a browser-based interface.}
+  gem.summary       = %q{A wallpaper rotation daemon with a browser-based interface.}
+  gem.homepage      = "https://github.com/ulfurinn/gnome-wallpaper-changer"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gnome-wallpaper-changer"
+  gem.require_paths = ["lib"]
+  gem.version       = Gnome::Wallpaper::Changer::VERSION
+
+  gem.add_dependency "thin"
+  gem.add_dependency "sinatra"
+  gem.add_dependency "haml"
+  gem.add_dependency "json"
+  gem.add_dependency "fastimage_resize"
+end

data/gnome-wallpaper-changer.sublime-project

@@ -0,0 +1,8 @@
+{
+	"folders":
+	[
+		{
+			"path": "/home/valeri/Projects/gnome-wallpaper-changer"
+		}
+	]
+}

data/lib/gnome-wallpaper-changer.rb

@@ -0,0 +1,27 @@
+require "fileutils"
+
+module Gnome
+  module Wallpaper
+    module Changer
+      
+      CONFIG_DIR = "#{ENV['HOME']}/.config/gnome-wallpaper-changer"
+
+      CONFIG_FILE = "#{CONFIG_DIR}/config.yml"
+      THUMB_DIR = "#{CONFIG_DIR}/thumbs"
+
+      PID_FILE = "#{CONFIG_DIR}/updater.pid"
+      LOG_FILE = "#{CONFIG_DIR}/updater.log"
+
+      AUTOSTART = "#{ENV['HOME']}/.config/autostart/gnome-wallpaper-changer.desktop"
+
+    end
+  end
+end
+
+require "gnome-wallpaper-changer/version"
+require "gnome-wallpaper-changer/reloader"
+require "gnome-wallpaper-changer/configuration"
+require "gnome-wallpaper-changer/controller"
+require "gnome-wallpaper-changer/updater"
+require "gnome-wallpaper-changer/resizer"
+require "gnome-wallpaper-changer/runner"

data/lib/gnome-wallpaper-changer/configuration.rb

@@ -0,0 +1,200 @@
+require "yaml"
+
+module Gnome::Wallpaper::Changer
+  class Configuration
+
+    module ClassMethods
+
+      private
+
+      def self.autosaving *attrs
+        attrs.each do |attribute|
+
+          define_method "autosaving_#{attribute}_set".to_sym do |value|
+            self.send "real_#{attribute}_set".to_sym, value
+            self.save!
+          end
+
+          alias_method "real_#{attribute}_set".to_sym, "#{attribute}=".to_sym
+          alias_method "#{attribute}=".to_sym, "autosaving_#{attribute}_set".to_sym
+
+        end
+      end
+
+      public
+
+      attr_accessor :interval, :port, :active, :folders, :files
+
+      def interval= value
+        @interval = if value < 60
+          60
+        else
+          value
+        end
+      end
+
+      autosaving :interval, :port, :active, :folders, :files
+      alias_method :active?, :active
+
+      def default_config
+        {
+          interval: 60 * 10,
+          port: 12345,
+          active: false,
+          folders: [ {
+              path: ENV['HOME'] + '/Pictures',
+              excluded: []
+            }, {
+              path: '/usr/share/backgrounds',
+              excluded: []
+            }
+          ],
+          files: [ ]
+        }
+      end
+
+      def current_config
+        {
+          version: VERSION,
+          port: self.port,
+          interval: self.interval,
+          active: self.active?,
+          folders: self.folders,
+          files: self.files
+        }
+      end
+
+      def reset!
+        if File.exists?( CONFIG_FILE )
+          FileUtils.rm CONFIG_FILE
+        end
+        uninstall_autostart!
+      end
+
+      def load
+        
+        unless Dir.exists?( CONFIG_DIR )
+          FileUtils.mkdir_p CONFIG_DIR
+        end
+
+        config = if File.exists?( CONFIG_FILE )
+          YAML.load File.read( CONFIG_FILE )
+        else
+          default_config
+        end
+
+        default_config.keys.each do |key|
+          self.send "#{key}=".to_sym, config[key]
+        end
+
+        save unless File.exists?( CONFIG_FILE )
+
+      end
+
+      def save!
+        File.open CONFIG_FILE, "w" do |io|
+          io.write current_config.to_yaml
+        end
+      end
+
+      def include_file folder, file
+        # => basic sanity check...
+        if File.dirname(file) == folder
+          folder = folders.find { |f| f[:path] == folder }
+          return false unless folder
+          folder[:excluded].delete file
+          save!
+          true
+        else
+          false
+        end
+      end
+
+      def include_all folder
+        folder = folders.find { |f| f[:path] == folder }
+        if folder
+          folder[:excluded] = []
+          save!
+          true
+        else
+          false
+        end
+      end
+
+      def exclude_file folder, file
+        # => basic sanity check...
+        if File.dirname(file) == folder
+          folder = folders.find { |f| f[:path] == folder }
+          return false unless folder
+          folder[:excluded] << file unless folder[:excluded].include?( file )
+          save!
+          true
+        else
+          false
+        end
+      end
+
+      def exclude_all folder
+        folder = folders.find { |f| f[:path] == folder }
+        if folder
+          folder[:excluded] = Updater.get_files_in_folder folder[:path]
+          save!
+          true
+        else
+          false
+        end
+      end
+
+      def add_folder folder
+        if folders.find{ |f| f[:path] == folder }
+          false
+        else
+          folders << { path: folder, excluded: [] }
+          save!
+          true
+        end
+      end
+
+      def remove_folder folder
+        folders.reject! { |f| f[:path] == folder }
+        save!
+      end
+
+      def install_autostart!
+        bin = begin
+          require "rvm"
+          wrapper = RVM.path + "/bin/" + RVM.current.environment_name + "_gnome-wallpaper-changer"
+          if !File.exists? wrapper
+            RVM.current.wrapper RVM.current.environment_name, RVM.current.environment_name, "gnome-wallpaper-changer"
+          end
+          wrapper
+        rescue
+          Gem.bindir( Gem.dir ) + '/gnome-wallpaper-changer'
+        end
+        puts "Detected bin: #{bin}"
+        File.open AUTOSTART, "w" do |io|
+          io.puts "[Desktop Entry]"
+          io.puts "Type=Application"
+          io.puts "Terminal=false"
+          io.puts "Name=Wallpaper Changer"
+          io.puts "Comment=Periodically changes the Gnome wallpaper"
+          io.puts "Exec=#{bin} --autostart"
+        end
+      rescue Gem::GemNotFoundException => e
+        puts "Cannot activate autostart with a development version"
+      end
+
+      def uninstall_autostart!
+        FileUtils.rm AUTOSTART if autostart_installed?
+      end
+
+      def autostart_installed?
+        File.exists? AUTOSTART
+      end
+
+    end
+
+    extend ClassMethods
+
+  end
+end

data/lib/gnome-wallpaper-changer/controller.rb

@@ -0,0 +1,147 @@
+require "sinatra/base"
+require "json"
+
+module Gnome::Wallpaper::Changer
+
+	class Controller < Sinatra::Base
+
+    def self.main_file
+      __FILE__
+    end
+
+    def sanitize_path folder
+      if folder.empty?
+        return nil
+      end
+
+      folder_pn = Pathname.new folder
+
+      if folder_pn.relative?
+        return nil
+      end
+
+      folder_pn = folder_pn.expand_path
+
+      if !folder_pn.exist?
+        return nil
+      end
+
+      folder_pn.to_s
+    end
+
+    set :root, File.join(File.dirname(main_file), "..", "..")
+    set :haml, :format => :html5
+
+    get '/' do
+      haml :index
+    end
+
+    get '/autostart' do
+      content_type :json
+      { enabled: Configuration.autostart_installed? }.to_json
+    end
+
+    post '/autostart' do
+      if params[:enable] == "true"
+        Configuration.install_autostart!
+      else
+        Configuration.uninstall_autostart!
+      end
+      content_type :json
+      { enabled: Configuration.autostart_installed? }.to_json
+    end
+
+    get '/interval' do
+      content_type :json
+      { interval: Configuration.active? ? Configuration.interval / 60 : 0 }.to_json
+    end
+
+    post '/interval' do
+      interval = params[:interval].to_i
+      if interval > 0
+        Configuration.active = true
+        Configuration.interval = interval * 60 rescue nil
+      else
+        Configuration.active = false
+      end
+      Updater.reschedule!
+      
+      content_type :json
+      { interval: Configuration.active? ? Configuration.interval / 60 : 0 }.to_json
+    end
+
+    post '/include' do
+      result = if params[:file]
+        Configuration.include_file params[:folder], params[:file]
+      else
+        Configuration.include_all params[:folder]
+      end
+      content_type :json
+      { result: result }.to_json
+    end
+
+    post '/exclude' do
+      result = if params[:file]
+        Configuration.exclude_file params[:folder], params[:file]
+      else
+        Configuration.exclude_all params[:folder]
+      end
+      content_type :json
+      { result: result }.to_json
+    end
+
+    post '/add' do
+
+      folder = sanitize_path params[:folder]
+      return nil.to_json if folder.nil?
+
+      result = Configuration.add_folder folder
+      content_type :json
+      if result
+        Updater.get_expanded_configuration(params[:folder])
+      else
+        nil
+      end.to_json
+    end
+
+    post '/remove' do
+      Configuration.remove_folder params[:folder]
+      ''
+    end
+
+    post '/change' do
+      path = params[:file]
+      if Updater.known_file? path
+        Updater.force_update path
+      end
+      ""
+    end
+
+    get '/wallpapers' do
+      content_type :json
+      Updater.get_expanded_configuration(params[:folder]).to_json
+    end
+
+    get '/file' do
+      path = params[:path]
+      if Updater.known_file? path
+        if thumb = Resizer.resize(path)
+          send_file thumb
+        else
+          500
+        end
+      else
+        403
+      end
+    end
+
+    get '/folder-suggest' do
+      term = params[:term]
+      lookup_dir = term.gsub /[^\/]+$/, ""
+      partial = term[ ( term.rindex('/') + 1 )..-1 ]
+      Pathname.new(lookup_dir).children.select { |child| child.directory? && child.basename.to_s.index( partial ) == 0 && child.basename.to_s[0] != '.' }.map(&:to_s).sort_by(&:downcase).to_json
+    end
+
+	end
+
+end