使用Paperclip在Rails 4中为图像添加水印

Question

我一直在尝试给我的图片添加水印，按照使用paperclip添加水印中列出的答案进行操作：

Watermark.rb:

module Paperclip
  class Watermark < Processor
    # Handles watermarking of images that are uploaded.
    attr_accessor :current_geometry, :target_geometry, :format, :whiny, :convert_options, :watermark_path, :watermark_offset, :overlay, :position

    def initialize file, options = {}, attachment = nil
      super
      geometry = options[:geometry]
      @file = file
      @crop = geometry[-1,1] == '#'
      @target_geometry = Geometry.parse geometry
      @current_geometry = Geometry.from_file @file
      @convert_options = options[:convert_options]
      @whiny = options[:whiny].nil? ? true : options[:whiny]
      @format = options[:format]
      @watermark_path = options[:watermark_path]
      @position = options[:position].nil? ? "SouthEast" : options[:position]
      @watermark_offset = options[:watermark_offset]
      @overlay = options[:overlay].nil? ? true : false
      @current_format = File.extname(@file.path)
      @basename = File.basename(@file.path, @current_format)
    end

    # TODO: extend watermark

    # Returns true if the +target_geometry+ is meant to crop.
    def crop?
      @crop
    end

    # Returns true if the image is meant to make use of additional convert options.
    def convert_options?
      not @convert_options.blank?
    end

    # Performs the conversion of the +file+ into a watermark. Returns the Tempfile
    # that contains the new image.
    def make
      dst = Tempfile.new([@basename, @format].compact.join("."))
      dst.binmode

      if watermark_path
        command = "composite"
        params = %W[-gravity #{@position}]
        params += %W[-geometry '#{@watermark_offset}'] if @watermark_offset
        params += %W['#{watermark_path}' '#{fromfile}']
        params += transformation_command
        params << "'#{tofile(dst)}'"
      else
        command = "convert"
        params = ["'#{fromfile}'"]
        params += transformation_command
        params << "'#{tofile(dst)}'"
      end

      begin
        Paperclip.run(command, params.join(' '))
      rescue ArgumentError, Cocaine::CommandLineError
        raise PaperclipError, "There was an error processing the watermark for #{@basename}" if @whiny
      end

      dst
    end

    def fromfile
      File.expand_path(@file.path)
    end

    def tofile(destination)
      File.expand_path(destination.path)
    end

    def transformation_command
      scale, crop = @current_geometry.transformation_to(@target_geometry, crop?)
      trans = %W[-resize '#{scale}']
      trans += %W[-crop '#{crop}' +repage] if crop
      trans << convert_options if convert_options?
      trans
    end
  end
end

以及模型代码：

has_attached_file :image, 
                  :processors => [:watermark], 
                  :styles => { 
                    :large => "640x480", 
                    :thumb => "100x100",
                    :medium => "300x300",
                        :content => {
                            :geometry => '150x153',
                            :watermark_path => Rails.root.join('app/assets/images/watermark.jpg'),
                            :position => 'SouthWest'
                        },
                  },
                  dependent: :allow_destroy

我尝试将这个更新以与Rails 4 兼容（将attr_accessor移动到模型中的params），但是我收到了以下错误：

uninitialized constant Paperclip::Watermark::PaperclipError

有什么技巧可以在Rails 4应用中实现水印？

更新：我能够通过Graeme下面的建议解决未初始化常量错误：

raise PaperclipError, "There was an error processing the watermark for #{@basename}" if @whiny

to:

raise Paperclip::Error.new("There was an error processing the watermark for #{@basename}") if @whiny

为了使上传过程顺利进行，我还需要从模型中删除以下内容：

:url => "/images/:style/:id_:style.:extension", 
:path => ":rails_root/app/assets/images/:style/:id_:style.:extension"

在用户上传图片时，我不理解:url和:path的用途是什么？

问题是，即使现在图像已经被上传，水印也没有显示出来。你有什么想法吗？

更新2： 为了正确显示水印，我不得不更改模型:

has_attached_file :image, 
  :processors => [:watermark], 
  :url => "/system/:class/:attachment/:id_partition/:style/:filename",
  :path => ":rails_root/public/system/:class/:attachment/:id_partition/:style/:filename",
  :styles => { 
    :large => "640x480", 
    :thumb => "100x100",
    :medium => { 
            :processors => [:watermark],
            :geometry => '300x300',
            :watermark_path => Rails.root.join('app/assets/images/icon.gif'),
            :position => 'SouthWest'
        },
  },
  dependent: :allow_destroy

重要的一点是移除: content =>。唯一剩下的问题是水印会放大以适应整个图像的宽度。有没有建议如何停止水印缩放？

- dmt2989

Answer 1

水印被拉伸的问题源于Imagemagick命令将两个图像组合在一起，然后调整结果的大小。

实际上，运行的命令将是（为了清晰起见，我已经缩写了实际的文件名）：

composite -gravity SouthWest icon.gif uploaded_image.gif -resize 300x300 output_image.gif

正如您所看到的，图像被连接然后调整大小。

我相信您需要的命令是：

convert uploaded_image.gif -resize 300x300 icon.gif -gravity SouthWest -composite output_image.gif

即调整上传的图像大小，然后添加水印。

我已经在命令行上使用composite和convert进行了测试，它可以实现我认为你正在寻找的功能。

要在代码中实现它，您需要更改make方法中的if watermark_path语句：

def make

  dst = Tempfile.new([@basename, @format].compact.join("."))
  dst.binmode

  if watermark_path
    # -- original code --
    # command = "composite"
    # params = %W[-gravity #{@position}]
    # params += %W[-geometry '#{@watermark_offset}'] if @watermark_offset
    # params += %W['#{watermark_path}' '#{fromfile}']
    # params += transformation_command
    # params << "'#{tofile(dst)}'"

    # -- new code --
    command = "convert"
    params  = %W['#{fromfile}']
    params += transformation_command
    params += %W['#{watermark_path}' -gravity #{@position} -composite]
    params << "'#{tofile(dst)}'"
  else
    command = "convert"
    params = ["'#{fromfile}'"]
    params += transformation_command
    params << "'#{tofile(dst)}'"
  end

  begin
    Paperclip.run(command, params.join(' '))
  rescue ArgumentError, Cocaine::CommandLineError
    raise PaperclipError, "There was an error processing the watermark for #{@basename}" if @whiny
  end

  dst
end

免责声明：我实际上没有测试过这个，所以请原谅任何错误。

- user740584

---

运作得非常完美。非常感谢详细的解释和快速响应！ - dmt2989

谢谢你的解决方案！请注意，在Rails 4.1.0 beta 1中，这对我来说并不直接有效。实际上，一切都是正确的，但我必须删除：processors => [:watermarks]。有关详细信息，请参见此处：http://stackoverflow.com/questions/24311129/no-implicit-conversion-of-string-into-array-rails-4-1-0-beta1/24317086#24317086，以防您遇到以下异常：“no implicit conversion of string into array”。 - Georg Keferböck

Answer 2

PaperclipError 不存在。

尝试更改：

raise PaperclipError, "There was an error processing the watermark for #{@basename}" if @whiny

to:

raise Paperclip::Error.new("There was an error processing the watermark for #{@basename}") if @whiny

- user740584

---

谢谢！问题已经解决，现在我能够通过图像上传过程了。问题是水印没有显示出来。为了使上传顺利（并且在我的视图中正确显示图像），我不得不从模型中删除：:url => "/images/:style/:id_:style.:extension", :path => ":rails_root/app/assets/images/:style/:id_:style.:extension",这可能会导致问题吗？ - dmt2989

Answer 3

由于您现在提出了一个不同的问题，我会给出一个新的答案。
:path 用于定义 Paperclip 存储上传的图像的位置。默认情况下，这将是 :rails_root/public/system/:class/:attachment/:id_partition/:style/:filename。
:url 用于稍后访问该图像。默认情况下，这将是 /system/:class/:attachment/:id_partition/:style/:filename。
（实际上，为了避免重复 url 部分，:path 默认情况下真正被定义为 :rails_root/public:url。）
通过在模型中指定它们，您正在更改保存位置。我不建议将它们放在资产目录中，因为资产实际上是您的应用程序的一部分，您不希望用户上传的文件进入那里。
至于为什么您没有看到上传的图像上的水印，我猜测 Imagemagick 合成命令未正确调用。尝试在命令行上运行它，或添加参数 -debug 以查看失败原因。

- user740584

---

感谢您的解释，非常感激。问题在于从模型中删除了:content。已更新工作代码如上所示。谢谢！唯一剩下的问题是水印会缩放到上传图像的全宽（300x300）；水印本身是（108x22）。您能否再帮我理解如何防止水印缩放？ - dmt2989